@openedx/frontend-base 1.0.0-alpha.12 → 1.0.0-alpha.13

package/dist/runtime/auth/AxiosJwtTokenService.d.ts

@@ -0,0 +1,16 @@
+export default class AxiosJwtTokenService {
+    static isTokenExpired(token: any): boolean;
+    constructor(loggingService: any, tokenCookieName: any, tokenRefreshBaseUrl: any, tokenRefreshPath: any);
+    loggingService: any;
+    tokenCookieName: any;
+    tokenRefreshBaseUrl: any;
+    tokenRefreshPath: any;
+    httpClient: import("axios").AxiosInstance;
+    cookies: Cookies;
+    refreshRequestPromises: {};
+    getHttpClient(): import("axios").AxiosInstance;
+    decodeJwtCookie(): unknown;
+    refresh(): any;
+    getJwtToken(forceRefresh?: boolean): Promise<any>;
+}
+import Cookies from 'universal-cookie';

package/dist/runtime/auth/AxiosJwtTokenService.js

@@ -0,0 +1,130 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import axios from 'axios';
+import jwtDecode from 'jwt-decode';
+import Cookies from 'universal-cookie';
+import createRetryInterceptor from './interceptors/createRetryInterceptor';
+import { logFrontendAuthError, processAxiosErrorAndThrow } from './utils';
+export default class AxiosJwtTokenService {
+    static isTokenExpired(token) {
+        return !token || token.exp < Date.now() / 1000;
+    }
+    constructor(loggingService, tokenCookieName, tokenRefreshBaseUrl, tokenRefreshPath) {
+        this.loggingService = loggingService;
+        this.tokenCookieName = tokenCookieName;
+        this.tokenRefreshBaseUrl = tokenRefreshBaseUrl;
+        this.tokenRefreshPath = tokenRefreshPath;
+        this.httpClient = axios.create();
+        // Set withCredentials to true. Enables cross-site Access-Control requests
+        // to be made using cookies, authorization headers or TLS client
+        // certificates. More on MDN:
+        // https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials
+        this.httpClient.defaults.withCredentials = true;
+        // Add retries to this axios instance
+        this.httpClient.interceptors.response.use(response => response, createRetryInterceptor({ httpClient: this.httpClient }));
+        this.cookies = new Cookies();
+        this.refreshRequestPromises = {};
+    }
+    getHttpClient() {
+        return this.httpClient;
+    }
+    decodeJwtCookie() {
+        const cookieValue = this.cookies.get(this.tokenCookieName);
+        if (cookieValue) {
+            try {
+                return jwtDecode(cookieValue);
+            }
+            catch (e) {
+                const error = Object.create(e);
+                error.message = 'Error decoding JWT token';
+                error.customAttributes = { cookieValue };
+                throw error;
+            }
+        }
+        return null;
+    }
+    refresh() {
+        let responseServerEpochSeconds = 0;
+        if (this.refreshRequestPromises[this.tokenCookieName] === undefined) {
+            const makeRefreshRequest = () => __awaiter(this, void 0, void 0, function* () {
+                var _a;
+                let axiosResponse;
+                try {
+                    try {
+                        axiosResponse = yield this.httpClient.post(`${this.tokenRefreshBaseUrl}${this.tokenRefreshPath}`);
+                        if ((_a = axiosResponse.data) === null || _a === void 0 ? void 0 : _a.response_epoch_seconds) {
+                            responseServerEpochSeconds = axiosResponse.data.response_epoch_seconds;
+                        }
+                    }
+                    catch (error) {
+                        processAxiosErrorAndThrow(error);
+                    }
+                }
+                catch (error) {
+                    const userIsUnauthenticated = error.response && error.response.status === 401;
+                    if (userIsUnauthenticated) {
+                        // Clean up the cookie if it exists to eliminate any situation
+                        // where the cookie is not expired but the jwt is expired.
+                        this.cookies.remove(this.tokenCookieName);
+                        const decodedJwtToken = null;
+                        return decodedJwtToken;
+                    }
+                    // TODO: Network timeouts and other problems will end up in
+                    // this block of code. We could add logic for retrying token
+                    // refreshes if we wanted to.
+                    throw error;
+                }
+                const browserEpochSeconds = Date.now() / 1000;
+                const browserDriftSeconds = responseServerEpochSeconds > 0
+                    ? Math.abs(browserEpochSeconds - responseServerEpochSeconds)
+                    : null;
+                const decodedJwtToken = this.decodeJwtCookie();
+                if (!decodedJwtToken) {
+                    // This is an unexpected case. The refresh endpoint should set the
+                    //   cookie that is needed.
+                    // For more details, see:
+                    //   docs/decisions/0005-token-null-after-successful-refresh.rst
+                    const error = new Error('Access token is still null after successful refresh.');
+                    error.customAttributes = { axiosResponse, browserDriftSeconds, browserEpochSeconds };
+                    throw error;
+                }
+                return decodedJwtToken;
+            });
+            this.refreshRequestPromises[this.tokenCookieName] = makeRefreshRequest().finally(() => {
+                delete this.refreshRequestPromises[this.tokenCookieName];
+            });
+        }
+        return this.refreshRequestPromises[this.tokenCookieName];
+    }
+    getJwtToken() {
+        return __awaiter(this, arguments, void 0, function* (forceRefresh = false) {
+            try {
+                const decodedJwtToken = this.decodeJwtCookie(this.tokenCookieName);
+                if (!AxiosJwtTokenService.isTokenExpired(decodedJwtToken) && !forceRefresh) {
+                    return decodedJwtToken;
+                }
+            }
+            catch (e) {
+                // Log unexpected error and continue with attempt to refresh it.
+                // TODO: Fix these.  They're still using loggingService as a singleton.
+                logFrontendAuthError(this.loggingService, e);
+            }
+            try {
+                return yield this.refresh();
+            }
+            catch (e) {
+                // TODO: Fix these.  They're still using loggingService as a singleton.
+                logFrontendAuthError(this.loggingService, e);
+                throw e;
+            }
+        });
+    }
+}
+//# sourceMappingURL=AxiosJwtTokenService.js.map

package/dist/runtime/auth/AxiosJwtTokenService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AxiosJwtTokenService.js","sourceRoot":"","sources":["../../../runtime/auth/AxiosJwtTokenService.js"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,OAAO,MAAM,kBAAkB,CAAC;AACvC,OAAO,sBAAsB,MAAM,uCAAuC,CAAC;AAC3E,OAAO,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAC;AAE1E,MAAM,CAAC,OAAO,OAAO,oBAAoB;IACvC,MAAM,CAAC,cAAc,CAAC,KAAK;QACzB,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;IACjD,CAAC;IAED,YAAY,cAAc,EAAE,eAAe,EAAE,mBAAmB,EAAE,gBAAgB;QAChF,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;QAC/C,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QAEzC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QACjC,0EAA0E;QAC1E,gEAAgE;QAChE,6BAA6B;QAC7B,kFAAkF;QAClF,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,eAAe,GAAG,IAAI,CAAC;QAChD,qCAAqC;QACrC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CACvC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EACpB,sBAAsB,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CACxD,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,CAAC,sBAAsB,GAAG,EAAE,CAAC;IACnC,CAAC;IAED,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,eAAe;QACb,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAE3D,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC;gBACH,OAAO,SAAS,CAAC,WAAW,CAAC,CAAC;YAChC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAC/B,KAAK,CAAC,OAAO,GAAG,0BAA0B,CAAC;gBAC3C,KAAK,CAAC,gBAAgB,GAAG,EAAE,WAAW,EAAE,CAAC;gBACzC,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO;QACL,IAAI,0BAA0B,GAAG,CAAC,CAAC;QAEnC,IAAI,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,SAAS,EAAE,CAAC;YACpE,MAAM,kBAAkB,GAAG,GAAS,EAAE;;gBACpC,IAAI,aAAa,CAAC;gBAClB,IAAI,CAAC;oBACH,IAAI,CAAC;wBACH,aAAa,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;wBAClG,IAAI,MAAA,aAAa,CAAC,IAAI,0CAAE,sBAAsB,EAAE,CAAC;4BAC/C,0BAA0B,GAAG,aAAa,CAAC,IAAI,CAAC,sBAAsB,CAAC;wBACzE,CAAC;oBACH,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,yBAAyB,CAAC,KAAK,CAAC,CAAC;oBACnC,CAAC;gBACH,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,qBAAqB,GAAG,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC;oBAC9E,IAAI,qBAAqB,EAAE,CAAC;wBAC1B,8DAA8D;wBAC9D,0DAA0D;wBAC1D,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;wBAC1C,MAAM,eAAe,GAAG,IAAI,CAAC;wBAC7B,OAAO,eAAe,CAAC;oBACzB,CAAC;oBAED,2DAA2D;oBAC3D,4DAA4D;oBAC5D,6BAA6B;oBAC7B,MAAM,KAAK,CAAC;gBACd,CAAC;gBAED,MAAM,mBAAmB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;gBAC9C,MAAM,mBAAmB,GAAG,0BAA0B,GAAG,CAAC;oBACxD,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,mBAAmB,GAAG,0BAA0B,CAAC;oBAC5D,CAAC,CAAC,IAAI,CAAC;gBAET,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;gBAE/C,IAAI,CAAC,eAAe,EAAE,CAAC;oBACrB,kEAAkE;oBAClE,2BAA2B;oBAC3B,yBAAyB;oBACzB,gEAAgE;oBAChE,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;oBAChF,KAAK,CAAC,gBAAgB,GAAG,EAAE,aAAa,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,CAAC;oBACrF,MAAM,KAAK,CAAC;gBACd,CAAC;gBAED,OAAO,eAAe,CAAC;YACzB,CAAC,CAAA,CAAC;YAEF,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,kBAAkB,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;gBACpF,OAAO,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YAC3D,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC3D,CAAC;IAEK,WAAW;6DAAC,YAAY,GAAG,KAAK;YACpC,IAAI,CAAC;gBACH,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;gBACnE,IAAI,CAAC,oBAAoB,CAAC,cAAc,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;oBAC3E,OAAO,eAAe,CAAC;gBACzB,CAAC;YACH,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,gEAAgE;gBAChE,uEAAuE;gBACvE,oBAAoB,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;YAC/C,CAAC;YAED,IAAI,CAAC;gBACH,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YAC9B,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,uEAAuE;gBACvE,oBAAoB,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;gBAC7C,MAAM,CAAC,CAAC;YACV,CAAC;QACH,CAAC;KAAA;CACF","sourcesContent":["import axios from 'axios';\nimport jwtDecode from 'jwt-decode';\nimport Cookies from 'universal-cookie';\nimport createRetryInterceptor from './interceptors/createRetryInterceptor';\nimport { logFrontendAuthError, processAxiosErrorAndThrow } from './utils';\n\nexport default class AxiosJwtTokenService {\n  static isTokenExpired(token) {\n    return !token || token.exp < Date.now() / 1000;\n  }\n\n  constructor(loggingService, tokenCookieName, tokenRefreshBaseUrl, tokenRefreshPath) {\n    this.loggingService = loggingService;\n    this.tokenCookieName = tokenCookieName;\n    this.tokenRefreshBaseUrl = tokenRefreshBaseUrl;\n    this.tokenRefreshPath = tokenRefreshPath;\n\n    this.httpClient = axios.create();\n    // Set withCredentials to true. Enables cross-site Access-Control requests\n    // to be made using cookies, authorization headers or TLS client\n    // certificates. More on MDN:\n    // https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials\n    this.httpClient.defaults.withCredentials = true;\n    // Add retries to this axios instance\n    this.httpClient.interceptors.response.use(\n      response => response,\n      createRetryInterceptor({ httpClient: this.httpClient }),\n    );\n\n    this.cookies = new Cookies();\n    this.refreshRequestPromises = {};\n  }\n\n  getHttpClient() {\n    return this.httpClient;\n  }\n\n  decodeJwtCookie() {\n    const cookieValue = this.cookies.get(this.tokenCookieName);\n\n    if (cookieValue) {\n      try {\n        return jwtDecode(cookieValue);\n      } catch (e) {\n        const error = Object.create(e);\n        error.message = 'Error decoding JWT token';\n        error.customAttributes = { cookieValue };\n        throw error;\n      }\n    }\n\n    return null;\n  }\n\n  refresh() {\n    let responseServerEpochSeconds = 0;\n\n    if (this.refreshRequestPromises[this.tokenCookieName] === undefined) {\n      const makeRefreshRequest = async () => {\n        let axiosResponse;\n        try {\n          try {\n            axiosResponse = await this.httpClient.post(`${this.tokenRefreshBaseUrl}${this.tokenRefreshPath}`);\n            if (axiosResponse.data?.response_epoch_seconds) {\n              responseServerEpochSeconds = axiosResponse.data.response_epoch_seconds;\n            }\n          } catch (error) {\n            processAxiosErrorAndThrow(error);\n          }\n        } catch (error) {\n          const userIsUnauthenticated = error.response && error.response.status === 401;\n          if (userIsUnauthenticated) {\n            // Clean up the cookie if it exists to eliminate any situation\n            // where the cookie is not expired but the jwt is expired.\n            this.cookies.remove(this.tokenCookieName);\n            const decodedJwtToken = null;\n            return decodedJwtToken;\n          }\n\n          // TODO: Network timeouts and other problems will end up in\n          // this block of code. We could add logic for retrying token\n          // refreshes if we wanted to.\n          throw error;\n        }\n\n        const browserEpochSeconds = Date.now() / 1000;\n        const browserDriftSeconds = responseServerEpochSeconds > 0\n          ? Math.abs(browserEpochSeconds - responseServerEpochSeconds)\n          : null;\n\n        const decodedJwtToken = this.decodeJwtCookie();\n\n        if (!decodedJwtToken) {\n          // This is an unexpected case. The refresh endpoint should set the\n          //   cookie that is needed.\n          // For more details, see:\n          //   docs/decisions/0005-token-null-after-successful-refresh.rst\n          const error = new Error('Access token is still null after successful refresh.');\n          error.customAttributes = { axiosResponse, browserDriftSeconds, browserEpochSeconds };\n          throw error;\n        }\n\n        return decodedJwtToken;\n      };\n\n      this.refreshRequestPromises[this.tokenCookieName] = makeRefreshRequest().finally(() => {\n        delete this.refreshRequestPromises[this.tokenCookieName];\n      });\n    }\n\n    return this.refreshRequestPromises[this.tokenCookieName];\n  }\n\n  async getJwtToken(forceRefresh = false) {\n    try {\n      const decodedJwtToken = this.decodeJwtCookie(this.tokenCookieName);\n      if (!AxiosJwtTokenService.isTokenExpired(decodedJwtToken) && !forceRefresh) {\n        return decodedJwtToken;\n      }\n    } catch (e) {\n      // Log unexpected error and continue with attempt to refresh it.\n      // TODO: Fix these.  They're still using loggingService as a singleton.\n      logFrontendAuthError(this.loggingService, e);\n    }\n\n    try {\n      return await this.refresh();\n    } catch (e) {\n      // TODO: Fix these.  They're still using loggingService as a singleton.\n      logFrontendAuthError(this.loggingService, e);\n      throw e;\n    }\n  }\n}\n"]}

package/dist/runtime/auth/LocalForageCache.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Async function to configure localforage and setup the cache
+ *
+ * @returns {Promise} A promise that, when resolved, returns an axios instance configured to
+ * use localforage as a cache.
+ */
+export default function configureCache(): Promise<any>;

package/dist/runtime/auth/LocalForageCache.js

@@ -0,0 +1,78 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import axios from 'axios';
+import { buildStorage, defaultHeaderInterpreter, defaultKeyGenerator, setupCache, } from 'axios-cache-interceptor';
+import localforage from 'localforage';
+import memoryDriver from 'localforage-memoryStorageDriver';
+/**
+ * Async function to configure localforage and setup the cache
+ *
+ * @returns {Promise} A promise that, when resolved, returns an axios instance configured to
+ * use localforage as a cache.
+ */
+export default function configureCache() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // Register the imported `memoryDriver` to `localforage`
+        yield localforage.defineDriver(memoryDriver);
+        // Create `localforage` instance
+        const forageStore = localforage.createInstance({
+            // List of drivers used
+            driver: [
+                localforage.INDEXEDDB,
+                localforage.LOCALSTORAGE,
+                memoryDriver._driver,
+            ],
+            name: 'edx-cache',
+        });
+        const forageStoreAdapter = buildStorage({
+            find(key) {
+                return __awaiter(this, void 0, void 0, function* () {
+                    const result = yield forageStore.getItem(`axios-cache:${key}`);
+                    return JSON.parse(result);
+                });
+            },
+            set(key, value) {
+                return __awaiter(this, void 0, void 0, function* () {
+                    yield forageStore.setItem(`axios-cache:${key}`, JSON.stringify(value));
+                });
+            },
+            remove(key) {
+                return __awaiter(this, void 0, void 0, function* () {
+                    yield forageStore.removeItem(`axios-cache:${key}`);
+                });
+            },
+        });
+        // only GET methods are cached by default
+        return setupCache(
+        // axios instance
+        axios.create(), {
+            ttl: 5 * 60 * 1000, // default maxAge of 5 minutes
+            // The storage to save the cache data. There are more available by default.
+            //
+            // https://axios-cache-interceptor.js.org/#/pages/storages
+            storage: forageStoreAdapter,
+            // The mechanism to generate a unique key for each request.
+            //
+            // https://axios-cache-interceptor.js.org/#/pages/request-id
+            generateKey: defaultKeyGenerator,
+            // The mechanism to interpret headers (when cache.interpretHeader is true).
+            //
+            // https://axios-cache-interceptor.js.org/#/pages/global-configuration?id=headerinterpreter
+            headerInterpreter: defaultHeaderInterpreter,
+            // The function that will receive debug information.
+            // NOTE: For this to work, you need to enable development mode.
+            //
+            // https://axios-cache-interceptor.js.org/#/pages/development-mode
+            // https://axios-cache-interceptor.js.org/#/pages/global-configuration?id=debug
+            debug: console.log,
+        });
+    });
+}
+//# sourceMappingURL=LocalForageCache.js.map

package/dist/runtime/auth/LocalForageCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalForageCache.js","sourceRoot":"","sources":["../../../runtime/auth/LocalForageCache.js"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EACL,YAAY,EACZ,wBAAwB,EACxB,mBAAmB,EACnB,UAAU,GACX,MAAM,yBAAyB,CAAC;AACjC,OAAO,WAAW,MAAM,aAAa,CAAC;AACtC,OAAO,YAAY,MAAM,iCAAiC,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAgB,cAAc;;QAC1C,wDAAwD;QACxD,MAAM,WAAW,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAE7C,gCAAgC;QAChC,MAAM,WAAW,GAAG,WAAW,CAAC,cAAc,CAAC;YAC7C,uBAAuB;YACvB,MAAM,EAAE;gBACN,WAAW,CAAC,SAAS;gBACrB,WAAW,CAAC,YAAY;gBACxB,YAAY,CAAC,OAAO;aACrB;YACD,IAAI,EAAE,WAAW;SAClB,CAAC,CAAC;QAEH,MAAM,kBAAkB,GAAG,YAAY,CAAC;YAChC,IAAI,CAAC,GAAG;;oBACZ,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,eAAe,GAAG,EAAE,CAAC,CAAC;oBAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBAC5B,CAAC;aAAA;YAEK,GAAG,CAAC,GAAG,EAAE,KAAK;;oBAClB,MAAM,WAAW,CAAC,OAAO,CAAC,eAAe,GAAG,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;gBACzE,CAAC;aAAA;YAEK,MAAM,CAAC,GAAG;;oBACd,MAAM,WAAW,CAAC,UAAU,CAAC,eAAe,GAAG,EAAE,CAAC,CAAC;gBACrD,CAAC;aAAA;SACF,CAAC,CAAC;QAEH,yCAAyC;QACzC,OAAO,UAAU;QACf,iBAAiB;QACjB,KAAK,CAAC,MAAM,EAAE,EACd;YACE,GAAG,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,8BAA8B;YAClD,2EAA2E;YAC3E,EAAE;YACF,0DAA0D;YAC1D,OAAO,EAAE,kBAAkB;YAE3B,2DAA2D;YAC3D,EAAE;YACF,4DAA4D;YAC5D,WAAW,EAAE,mBAAmB;YAEhC,2EAA2E;YAC3E,EAAE;YACF,2FAA2F;YAC3F,iBAAiB,EAAE,wBAAwB;YAE3C,oDAAoD;YACpD,+DAA+D;YAC/D,EAAE;YACF,kEAAkE;YAClE,+EAA+E;YAC/E,KAAK,EAAE,OAAO,CAAC,GAAG;SACnB,CACF,CAAC;IACJ,CAAC;CAAA","sourcesContent":["import axios from 'axios';\nimport {\n  buildStorage,\n  defaultHeaderInterpreter,\n  defaultKeyGenerator,\n  setupCache,\n} from 'axios-cache-interceptor';\nimport localforage from 'localforage';\nimport memoryDriver from 'localforage-memoryStorageDriver';\n\n/**\n * Async function to configure localforage and setup the cache\n *\n * @returns {Promise} A promise that, when resolved, returns an axios instance configured to\n * use localforage as a cache.\n */\nexport default async function configureCache() {\n  // Register the imported `memoryDriver` to `localforage`\n  await localforage.defineDriver(memoryDriver);\n\n  // Create `localforage` instance\n  const forageStore = localforage.createInstance({\n    // List of drivers used\n    driver: [\n      localforage.INDEXEDDB,\n      localforage.LOCALSTORAGE,\n      memoryDriver._driver,\n    ],\n    name: 'edx-cache',\n  });\n\n  const forageStoreAdapter = buildStorage({\n    async find(key) {\n      const result = await forageStore.getItem(`axios-cache:${key}`);\n      return JSON.parse(result);\n    },\n\n    async set(key, value) {\n      await forageStore.setItem(`axios-cache:${key}`, JSON.stringify(value));\n    },\n\n    async remove(key) {\n      await forageStore.removeItem(`axios-cache:${key}`);\n    },\n  });\n\n  // only GET methods are cached by default\n  return setupCache(\n    // axios instance\n    axios.create(),\n    {\n      ttl: 5 * 60 * 1000, // default maxAge of 5 minutes\n      // The storage to save the cache data. There are more available by default.\n      //\n      // https://axios-cache-interceptor.js.org/#/pages/storages\n      storage: forageStoreAdapter,\n\n      // The mechanism to generate a unique key for each request.\n      //\n      // https://axios-cache-interceptor.js.org/#/pages/request-id\n      generateKey: defaultKeyGenerator,\n\n      // The mechanism to interpret headers (when cache.interpretHeader is true).\n      //\n      // https://axios-cache-interceptor.js.org/#/pages/global-configuration?id=headerinterpreter\n      headerInterpreter: defaultHeaderInterpreter,\n\n      // The function that will receive debug information.\n      // NOTE: For this to work, you need to enable development mode.\n      //\n      // https://axios-cache-interceptor.js.org/#/pages/development-mode\n      // https://axios-cache-interceptor.js.org/#/pages/global-configuration?id=debug\n      debug: console.log,\n    },\n  );\n}\n"]}

package/dist/runtime/auth/MockAuthService.d.ts

@@ -0,0 +1,209 @@
+export default MockAuthService;
+/**
+ * The MockAuthService class mocks authenticated user-fetching logic and allows for manually
+ * setting user data.  It is compatible with axios-mock-adapter to wrap its HttpClients so that
+ * they can be mocked for testing.
+ *
+ * It wraps all methods of the service with Jest mock functions (jest.fn()).  This allows test code
+ * to assert expectations on all functions of the service while preserving sensible behaviors.  For
+ * instance, the login/logout methods related to redirecting maintain their real behavior.
+ *
+ * This service is NOT suitable for use in an application itself - only tests.  It depends on Jest,
+ * which should only be a dev dependency of your project.  You don't want to pull the entire suite
+ * of test dependencies into your application at runtime, probably even in your dev server.
+ *
+ * In a test where you would like to mock out API requests - perhaps from a redux-thunk function -
+ * you could do the following to set up a MockAuthService for your test:
+ *
+ * ```
+ * import { getSiteConfig, mergeSiteConfig, configureAuth, MockAuthService } from '@openedx/frontend-base';
+ * import MockAdapter from 'axios-mock-adapter';
+ *
+ * const mockLoggingService = {
+ *   logInfo: jest.fn(),
+ *   logError: jest.fn(),
+ * };
+ * mergeSiteConfig({
+ *   authenticatedUser: {
+ *     userId: 'abc123',
+ *     username: 'Mock User',
+ *     roles: [],
+ *     administrator: false,
+ *   },
+ * });
+ * configureAuth(MockAuthService, { config: getSiteConfig(), loggingService: mockLoggingService });
+ * const mockAdapter = new MockAdapter(getAuthenticatedHttpClient());
+ * // Mock calls for your tests.  This configuration can be done in any sort of test setup.
+ * mockAdapter.onGet(...);
+ * ```
+ *
+ * Also see the `initializeMockApp` function which also automatically uses mock services for
+ * Logging and Analytics.
+ *
+ * @implements {AuthService}
+ * @memberof module:Auth
+ */
+declare class MockAuthService implements AuthService {
+    /**
+     * @param {Object} options
+     * @param {Object} options.config
+     * @param {string} options.config.baseUrl
+     * @param {string} options.config.lmsBaseUrl
+     * @param {string} options.config.loginUrl
+     * @param {string} options.config.logoutUrl
+     * @param {string} options.config.refreshAccessTokenApiPath
+     * @param {string} options.config.accessTokenCookieName
+     * @param {string} options.config.csrfTokenApiPath
+     * @param {Object} options.loggingService requires logError and logInfo methods
+     */
+    constructor(options: {
+        config: {
+            baseUrl: string;
+            lmsBaseUrl: string;
+            loginUrl: string;
+            logoutUrl: string;
+            refreshAccessTokenApiPath: string;
+            accessTokenCookieName: string;
+            csrfTokenApiPath: string;
+        };
+        loggingService: any;
+    });
+    authenticatedHttpClient: import("axios").AxiosInstance;
+    httpClient: import("axios").AxiosInstance;
+    config: {
+        baseUrl: string;
+        lmsBaseUrl: string;
+        loginUrl: string;
+        logoutUrl: string;
+        refreshAccessTokenApiPath: string;
+        accessTokenCookieName: string;
+        csrfTokenApiPath: string;
+    };
+    loggingService: any;
+    authenticatedUser: any;
+    hydratedAuthenticatedUser: {};
+    /**
+     * A Jest mock function (jest.fn())
+     *
+     * Applies middleware to the axios instances in this service.
+     *
+     * @param {Array} middleware Middleware to apply.
+     */
+    applyMiddleware(middleware?: any[]): void;
+    /**
+     * A Jest mock function (jest.fn())
+     *
+     * Gets the authenticated HTTP client instance, which is an axios client wrapped in
+     * MockAdapter from axios-mock-adapter.
+     *
+     * @returns {HttpClient} An HttpClient wrapped in MockAdapter.
+     */
+    getAuthenticatedHttpClient: jest.Mock<import("axios").AxiosInstance, [], any>;
+    /**
+     * A Jest mock function (jest.fn())
+     *
+     * Gets the unauthenticated HTTP client instance, which is an axios client wrapped in
+     * MockAdapter from axios-mock-adapter.
+     *
+     * @returns {HttpClient} An HttpClient wrapped in MockAdapter.
+     */
+    getHttpClient: jest.Mock<import("axios").AxiosInstance, [], any>;
+    /**
+     * A Jest mock function (jest.fn())
+     *
+     * Builds a URL to the login page with a post-login redirect URL attached as a query parameter.
+     *
+     * ```
+     * const url = getLoginRedirectUrl('http://localhost/mypage');
+     * console.log(url); // http://localhost/login?next=http%3A%2F%2Flocalhost%2Fmypage
+     * ```
+     *
+     * @param {string} redirectUrl The URL the user should be redirected to after logging in.
+     */
+    getLoginRedirectUrl: jest.Mock<string, [redirectUrl?: any], any>;
+    /**
+     * A Jest mock function (jest.fn())
+     *
+     * Redirects the user to the logout page in the real implementation.  Is a no-op here.
+     *
+     * @param {string} redirectUrl The URL the user should be redirected to after logging in.
+     */
+    redirectToLogin: jest.Mock<void, [redirectUrl?: any], any>;
+    /**
+     * A Jest mock function (jest.fn())
+     *
+     * Builds a URL to the logout page with a post-logout redirect URL attached as a query parameter.
+     *
+     * ```
+     * const url = getLogoutRedirectUrl('http://localhost/mypage');
+     * console.log(url); // http://localhost/logout?next=http%3A%2F%2Flocalhost%2Fmypage
+     * ```
+     *
+     * @param {string} redirectUrl The URL the user should be redirected to after logging out.
+     */
+    getLogoutRedirectUrl: jest.Mock<string, [redirectUrl?: any], any>;
+    /**
+     * A Jest mock function (jest.fn())
+     *
+     * Redirects the user to the logout page in the real implementation.  Is a no-op here.
+     *
+     * @param {string} redirectUrl The URL the user should be redirected to after logging out.
+     */
+    redirectToLogout: jest.Mock<void, [redirectUrl?: any], any>;
+    /**
+     * A Jest mock function (jest.fn())
+     *
+     * If it exists, returns the user data representing the currently authenticated user. If the
+     * user is anonymous, returns null.
+     *
+     * @returns {UserData|null}
+     */
+    getAuthenticatedUser: jest.Mock<any, [], any>;
+    /**
+     * A Jest mock function (jest.fn())
+     *
+     * Sets the authenticated user to the provided value.
+     *
+     * @param {UserData} authUser
+     */
+    setAuthenticatedUser: jest.Mock<void, [authUser: any], any>;
+    /**
+     * A Jest mock function (jest.fn())
+     *
+     * Returns the current authenticated user details, as supplied in the `authenticatedUser` field
+     * of the config options.  Resolves to null if the user is unauthenticated / the config option
+     * has not been set.
+     *
+     * @returns {UserData|null} Resolves to the user's access token if they are
+     * logged in.
+     */
+    fetchAuthenticatedUser: jest.Mock<any, [], any>;
+    /**
+     * A Jest mock function (jest.fn())
+     *
+     * Ensures a user is authenticated. It will redirect to login when not authenticated.
+     *
+     * @param {string} [redirectUrl=config.baseUrl] to return user after login when not
+     * authenticated.
+     * @returns {UserData|null} Resolves to the user's access token if they are
+     * logged in.
+     */
+    ensureAuthenticatedUser: jest.Mock<any, [redirectUrl?: any], any>;
+    /**
+     * A Jest mock function (jest.fn())
+     *
+     * Adds the user data supplied in the `hydratedAuthenticatedUser` config option into the object
+     * returned by `getAuthenticatedUser`.  This emulates the behavior of a real auth service which
+     * would make a request to fetch this data prior to merging it in.
+     *
+     * ```
+     * console.log(authenticatedUser); // Will be sparse and only contain basic information.
+     * await hydrateAuthenticatedUser()
+     * const authenticatedUser = getAuthenticatedUser();
+     * console.log(authenticatedUser); // Will contain additional user information
+     * ```
+     *
+     * @returns {Promise<null>}
+     */
+    hydrateAuthenticatedUser: jest.Mock<void, [], any>;
+}