SPR-20295 add require to web apis

Author: derzierau

src/ps-web-apis.ts

@@ -1,123 +1,127 @@
 import { provide } from "./apiprovide";
 
-function requireApi<T>(name: string): Promise<T> {
-    // -- START -- static loader
-    const unresolvedPackages = {} as any;
-    const providedPackages = {} as any;
-    const loaderName = "pssmasloader";
-    // set or reuse existing loader implementation
-    const loader = ((window as any)[loaderName] = (window as any)[loaderName] || {
-        // Requires packageName and returns it via callback
-        require(packageName: string, cb: any) {
-            const pack = providedPackages[packageName];
-            if (pack !== undefined) {
-                // -- will callback directly if required functionality was already provided
-                cb(pack, null);
-            } else {
-                // -- will queue callbacks if required functionality is not yet available
-                unresolvedPackages[packageName] = unresolvedPackages[packageName] || [];
-                unresolvedPackages[packageName].push(cb);
-            }
-        },
+function requirePackage<T>(name: string): Promise<T> {
+  // -- START -- static loader
+  const unresolvedPackages = {} as any;
+  const providedPackages = {} as any;
+  const loaderName = "pssmasloader";
+  // set or reuse existing loader implementation
+  const loader = ((window as any)[loaderName] = (window as any)[loaderName] || {
+    // Requires packageName and returns it via callback
+    require(packageName: string, cb: any) {
+      const pack = providedPackages[packageName];
+      if (pack !== undefined) {
+        // -- will callback directly if required functionality was already provided
+        cb(pack, null);
+      } else {
+        // -- will queue callbacks if required functionality is not yet available
+        unresolvedPackages[packageName] = unresolvedPackages[packageName] || [];
+        unresolvedPackages[packageName].push(cb);
+      }
+    },
 
-        // private state
-        _: {
-            u: unresolvedPackages,
-            p: providedPackages
-        }
-    });
-    // -- END -- static loader
+    // private state
+    _: {
+      u: unresolvedPackages,
+      p: providedPackages,
+    },
+  });
+  // -- END -- static loader
 
-    return new Promise((resolve, reject) => {
-        loader.require(name, (res: T, error: any) => {
-            if (error) {
-                reject(error);
-            } else {
-                resolve(res);
-            }
-        });
+  return new Promise((resolve, reject) => {
+    loader.require(name, (res: T, error: any) => {
+      if (error) {
+        reject(error);
+      } else {
+        resolve(res);
+      }
     });
+  });
 }
 
 export interface WhoamiUserInfo {
-    user_id: string;
-    first_name?: string;
-    last_name?: string;
+  user_id: string;
+  first_name?: string;
+  last_name?: string;
 }
 
 export interface PurchaseData {
-    entitlements: [string];
+  entitlements: [string];
 }
 export type FetchOptions = RequestInit & { timeout?: number };
 
 /**
  * Custom fetch interface which includes the possibility to customize timeouts for fetch requests
  */
-export type Fetch = (input: RequestInfo, init?: FetchOptions) => Promise<Response>;
+export type Fetch = (
+  input: RequestInfo,
+  init?: FetchOptions
+) => Promise<Response>;
 
 export interface WhoamiV1 {
-    /**
-     * will assert valid not outdated session before fetch will be done. backend credentials will be added automatically
-     * an error is resolved if session is invalid and not refeshable (= user logged out)
-     * Important: as of version 1.9.9 all requests are timeout after 5s by default.
-     * Can be changed by adding the field timeout to the FetchOptions Interface
-     */
-    authorizedFetch: Fetch;
-    /**
-     * gives information if user is currently loggedin from ui perspective
-     */
-    isLoggedIn(): boolean;
-    /**
-     * will assert valid not outdated session before promise is resolved
-     * an error is resolved if session is invalid and not refeshable (= user logged out)
-     */
-    ensureUserHasAuthorization(): Promise<void>;
-    /**
-     * will start login-process (e.g. go to sso-login)
-     */
-    doLogin(additionalParameter?: Map<string, string[]>): void;
-    /**
-     * will start registration-process (e.g. go to sso-register)
-     */
-    doRegister(additionalParameter?: Map<string, string[]>): void;
-    /**
-     * will start logout-process (e.g. go to sso-logout)
-     */
-    doLogout(additionalParameter?: Map<string, string[]>): void;
-    /**
-     * will start logout-process and redirect user to portal homepage afterwards (e.g. go to sso-logout)
-     */
-    doLogoutToHome(additionalParameter?: Map<string, string[]>): void;
-    /**
-     * will update access token and therefore content entitlements to current state
-     */
-    forceAccessTokenRefresh(): Promise<void>;
-    /**
-     * will request userinfo from whoami backend
-     * @return {WhoamiUserInfo} some relevant userdata
-     */
-    getUserInfo(): Promise<WhoamiUserInfo>;
-    /**
-     * will request customer pseudo id for currently logged user from consent backend
-     * @param clientId The string identifier of the client for which the customer id is requested.
-     */
-    getCustomerId(clientId: string): Promise<string>;
-    /**
-     * will provide unsafe purchase data
-     */
-    getUnsafePurchaseData(): Promise<PurchaseData>;
+  /**
+   * will assert valid not outdated session before fetch will be done. backend credentials will be added automatically
+   * an error is resolved if session is invalid and not refeshable (= user logged out)
+   * Important: as of version 1.9.9 all requests are timeout after 5s by default.
+   * Can be changed by adding the field timeout to the FetchOptions Interface
+   */
+  authorizedFetch: Fetch;
+  /**
+   * gives information if user is currently loggedin from ui perspective
+   */
+  isLoggedIn(): boolean;
+  /**
+   * will assert valid not outdated session before promise is resolved
+   * an error is resolved if session is invalid and not refeshable (= user logged out)
+   */
+  ensureUserHasAuthorization(): Promise<void>;
+  /**
+   * will start login-process (e.g. go to sso-login)
+   */
+  doLogin(additionalParameter?: Map<string, string[]>): void;
+  /**
+   * will start registration-process (e.g. go to sso-register)
+   */
+  doRegister(additionalParameter?: Map<string, string[]>): void;
+  /**
+   * will start logout-process (e.g. go to sso-logout)
+   */
+  doLogout(additionalParameter?: Map<string, string[]>): void;
+  /**
+   * will start logout-process and redirect user to portal homepage afterwards (e.g. go to sso-logout)
+   */
+  doLogoutToHome(additionalParameter?: Map<string, string[]>): void;
+  /**
+   * will update access token and therefore content entitlements to current state
+   */
+  forceAccessTokenRefresh(): Promise<void>;
+  /**
+   * will request userinfo from whoami backend
+   * @return {WhoamiUserInfo} some relevant userdata
+   */
+  getUserInfo(): Promise<WhoamiUserInfo>;
+  /**
+   * will request customer pseudo id for currently logged user from consent backend
+   * @param clientId The string identifier of the client for which the customer id is requested.
+   */
+  getCustomerId(clientId: string): Promise<string>;
+  /**
+   * will provide unsafe purchase data
+   */
+  getUnsafePurchaseData(): Promise<PurchaseData>;
 }
 
 export interface UtilsV1 {
-    fetchWithTimeout: Fetch;
+  fetchWithTimeout: Fetch;
 }
 
 export function whoamiV1(): Promise<WhoamiV1> {
-    return requireApi("whoami:v1");
+  return requirePackage("whoami:v1");
 }
 
 export function utilsV1(): Promise<UtilsV1> {
-    return requireApi("utils:v1");
+  return requirePackage("utils:v1");
 }
 
 export const provideApi = provide;
+export const requireApi = requirePackage;