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

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

@@ -0,0 +1,133 @@
+/**
+ *
+ * @param {class} AuthService
+ * @param {*} options
+ * @returns {AuthService}
+ */
+export function configureAuth(AuthService: class, options: any): class;
+/**
+ *
+ *
+ * @returns {AuthService}
+ */
+export function getAuthService(): AuthService;
+/**
+ *
+ */
+export function resetAuthService(): void;
+/**
+ * Gets the authenticated HTTP client for the service.
+ *
+ * @param {Object} [options] Optional options for how to configure the authenticated HTTP client
+ * @param {boolean} [options.useCache] Whether to use front end caching for all requests made with the returned client
+ *
+ * @returns {HttpClient}
+ */
+export function getAuthenticatedHttpClient(options?: {
+    useCache?: boolean | undefined;
+}): HttpClient;
+/**
+ * Gets the unauthenticated HTTP client for the service.
+ *
+ * @param {Object} [options] Optional options for how to configure the authenticated HTTP client
+ * @param {boolean} [options.useCache] Whether to use front end caching for all requests made with the returned client
+ *
+ * @returns {HttpClient}
+ */
+export function getHttpClient(options?: {
+    useCache?: boolean | undefined;
+}): HttpClient;
+/**
+ * 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.
+ */
+export function getLoginRedirectUrl(redirectUrl: string): any;
+/**
+ * Redirects the user to the login page.
+ *
+ * @param {string} redirectUrl The URL the user should be redirected to after logging in.
+ */
+export function redirectToLogin(redirectUrl: string): any;
+/**
+ * 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?redirect_url=http%3A%2F%2Flocalhost%2Fmypage
+ * ```
+ *
+ * @param {string} redirectUrl The URL the user should be redirected to after logging out.
+ */
+export function getLogoutRedirectUrl(redirectUrl: string): any;
+/**
+ * Redirects the user to the logout page.
+ *
+ * @param {string} redirectUrl The URL the user should be redirected to after logging out.
+ */
+export function redirectToLogout(redirectUrl: string): any;
+/**
+ * If it exists, returns the user data representing the currently authenticated user. If the
+ * user is anonymous, returns null.
+ *
+ * @returns {UserData|null}
+ */
+export function getAuthenticatedUser(): UserData | null;
+/**
+ * Sets the authenticated user to the provided value.
+ *
+ * @param {UserData} authUser
+ * @emits AUTHENTICATED_USER_CHANGED
+ */
+export function setAuthenticatedUser(authUser: UserData): void;
+/**
+ * Reads the authenticated user's access token. Resolves to null if the user is
+ * unauthenticated.
+ *
+ * @returns {Promise<UserData>|Promise<null>} Resolves to the user's access token if they are
+ * logged in.
+ */
+export function fetchAuthenticatedUser(options?: {}): Promise<UserData> | Promise<null>;
+/**
+ * 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 {Promise<UserData>}
+ */
+export function ensureAuthenticatedUser(redirectUrl?: string): Promise<UserData>;
+/**
+ * Fetches additional user account information for the authenticated user and merges it into the
+ * existing authenticatedUser object, available via getAuthenticatedUser().
+ *
+ * ```
+ *  console.log(authenticatedUser); // Will be sparse and only contain basic information.
+ *  await hydrateAuthenticatedUser()
+ *  const authenticatedUser = getAuthenticatedUser();
+ *  console.log(authenticatedUser); // Will contain additional user information
+ * ```
+ *
+ * @emits AUTHENTICATED_USER_CHANGED
+ */
+export function hydrateAuthenticatedUser(): Promise<void>;
+/**
+ * @constant
+ * @private
+ */
+export const AUTHENTICATED_USER_TOPIC: "AUTHENTICATED_USER";
+/**
+ * Published when the authenticated user data changes.  This can happen when the authentication
+ * service determines that the user is authenticated or anonymous, as well as when we fetch
+ * additional user account data if the `hydrateAuthenticatedUser` flag has been set in the
+ * `initialize` function.
+ *
+ * @event
+ * @see {@link module:Initialization~initialize}
+ */
+export const AUTHENTICATED_USER_CHANGED: "AUTHENTICATED_USER.CHANGED";

package/{runtime → dist/runtime}/auth/interface.js

@@ -1,3 +1,12 @@
+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 members from **@openedx/frontend-base**
  *
@@ -36,13 +45,11 @@
  */
 import PropTypes from 'prop-types';
 import { publish } from '../subscriptions';
-
 /**
  * @constant
  * @private
  */
 export const AUTHENTICATED_USER_TOPIC = 'AUTHENTICATED_USER';
-
 /**
  * Published when the authenticated user data changes.  This can happen when the authentication
  * service determines that the user is authenticated or anonymous, as well as when we fetch
@@ -53,39 +60,35 @@ export const AUTHENTICATED_USER_TOPIC = 'AUTHENTICATED_USER';
  * @see {@link module:Initialization~initialize}
  */
 export const AUTHENTICATED_USER_CHANGED = `${AUTHENTICATED_USER_TOPIC}.CHANGED`;
-
 const optionsShape = {
-  config: PropTypes.shape({
-    baseUrl: PropTypes.string.isRequired,
-    lmsBaseUrl: PropTypes.string.isRequired,
-    loginUrl: PropTypes.string.isRequired,
-    logoutUrl: PropTypes.string.isRequired,
-    refreshAccessTokenApiPath: PropTypes.string.isRequired,
-    accessTokenCookieName: PropTypes.string.isRequired,
-    csrfTokenApiPath: PropTypes.string.isRequired,
-  }).isRequired,
-  loggingService: PropTypes.shape({
-    logError: PropTypes.func.isRequired,
-    logInfo: PropTypes.func.isRequired,
-  }).isRequired,
+    config: PropTypes.shape({
+        baseUrl: PropTypes.string.isRequired,
+        lmsBaseUrl: PropTypes.string.isRequired,
+        loginUrl: PropTypes.string.isRequired,
+        logoutUrl: PropTypes.string.isRequired,
+        refreshAccessTokenApiPath: PropTypes.string.isRequired,
+        accessTokenCookieName: PropTypes.string.isRequired,
+        csrfTokenApiPath: PropTypes.string.isRequired,
+    }).isRequired,
+    loggingService: PropTypes.shape({
+        logError: PropTypes.func.isRequired,
+        logInfo: PropTypes.func.isRequired,
+    }).isRequired,
 };
-
 const serviceShape = {
-  getAuthenticatedHttpClient: PropTypes.func.isRequired,
-  getHttpClient: PropTypes.func.isRequired,
-  getLoginRedirectUrl: PropTypes.func.isRequired,
-  redirectToLogin: PropTypes.func.isRequired,
-  getLogoutRedirectUrl: PropTypes.func.isRequired,
-  redirectToLogout: PropTypes.func.isRequired,
-  getAuthenticatedUser: PropTypes.func.isRequired,
-  setAuthenticatedUser: PropTypes.func.isRequired,
-  fetchAuthenticatedUser: PropTypes.func.isRequired,
-  ensureAuthenticatedUser: PropTypes.func.isRequired,
-  hydrateAuthenticatedUser: PropTypes.func.isRequired,
+    getAuthenticatedHttpClient: PropTypes.func.isRequired,
+    getHttpClient: PropTypes.func.isRequired,
+    getLoginRedirectUrl: PropTypes.func.isRequired,
+    redirectToLogin: PropTypes.func.isRequired,
+    getLogoutRedirectUrl: PropTypes.func.isRequired,
+    redirectToLogout: PropTypes.func.isRequired,
+    getAuthenticatedUser: PropTypes.func.isRequired,
+    setAuthenticatedUser: PropTypes.func.isRequired,
+    fetchAuthenticatedUser: PropTypes.func.isRequired,
+    ensureAuthenticatedUser: PropTypes.func.isRequired,
+    hydrateAuthenticatedUser: PropTypes.func.isRequired,
 };
-
 let service;
-
 /**
  *
  * @param {class} AuthService
@@ -93,32 +96,28 @@ let service;
  * @returns {AuthService}
  */
 export function configureAuth(AuthService, options) {
-  PropTypes.checkPropTypes(optionsShape, options, 'property', 'Auth');
-  service = new AuthService(options);
-  PropTypes.checkPropTypes(serviceShape, service, 'property', 'AuthService');
-  return service;
+    PropTypes.checkPropTypes(optionsShape, options, 'property', 'Auth');
+    service = new AuthService(options);
+    PropTypes.checkPropTypes(serviceShape, service, 'property', 'AuthService');
+    return service;
 }
-
 /**
  *
  *
  * @returns {AuthService}
  */
 export function getAuthService() {
-  if (!service) {
-    throw Error('You must first configure the auth service.');
-  }
-
-  return service;
+    if (!service) {
+        throw Error('You must first configure the auth service.');
+    }
+    return service;
 }
-
 /**
  *
  */
 export function resetAuthService() {
-  service = null;
+    service = null;
 }
-
 /**
  * Gets the authenticated HTTP client for the service.
  *
@@ -128,9 +127,8 @@ export function resetAuthService() {
  * @returns {HttpClient}
  */
 export function getAuthenticatedHttpClient(options = {}) {
-  return service.getAuthenticatedHttpClient(options);
+    return service.getAuthenticatedHttpClient(options);
 }
-
 /**
  * Gets the unauthenticated HTTP client for the service.
  *
@@ -140,9 +138,8 @@ export function getAuthenticatedHttpClient(options = {}) {
  * @returns {HttpClient}
  */
 export function getHttpClient(options = {}) {
-  return service.getHttpClient(options);
+    return service.getHttpClient(options);
 }
-
 /**
  * Builds a URL to the login page with a post-login redirect URL attached as a query parameter.
  *
@@ -154,18 +151,16 @@ export function getHttpClient(options = {}) {
  * @param {string} redirectUrl The URL the user should be redirected to after logging in.
  */
 export function getLoginRedirectUrl(redirectUrl) {
-  return service.getLoginRedirectUrl(redirectUrl);
+    return service.getLoginRedirectUrl(redirectUrl);
 }
-
 /**
  * Redirects the user to the login page.
  *
  * @param {string} redirectUrl The URL the user should be redirected to after logging in.
  */
 export function redirectToLogin(redirectUrl) {
-  return service.redirectToLogin(redirectUrl);
+    return service.redirectToLogin(redirectUrl);
 }
-
 /**
  * Builds a URL to the logout page with a post-logout redirect URL attached as a query parameter.
  *
@@ -177,18 +172,16 @@ export function redirectToLogin(redirectUrl) {
  * @param {string} redirectUrl The URL the user should be redirected to after logging out.
  */
 export function getLogoutRedirectUrl(redirectUrl) {
-  return service.getLogoutRedirectUrl(redirectUrl);
+    return service.getLogoutRedirectUrl(redirectUrl);
 }
-
 /**
  * Redirects the user to the logout page.
  *
  * @param {string} redirectUrl The URL the user should be redirected to after logging out.
  */
 export function redirectToLogout(redirectUrl) {
-  return service.redirectToLogout(redirectUrl);
+    return service.redirectToLogout(redirectUrl);
 }
-
 /**
  * If it exists, returns the user data representing the currently authenticated user. If the
  * user is anonymous, returns null.
@@ -196,9 +189,8 @@ export function redirectToLogout(redirectUrl) {
  * @returns {UserData|null}
  */
 export function getAuthenticatedUser() {
-  return service.getAuthenticatedUser();
+    return service.getAuthenticatedUser();
 }
-
 /**
  * Sets the authenticated user to the provided value.
  *
@@ -206,10 +198,9 @@ export function getAuthenticatedUser() {
  * @emits AUTHENTICATED_USER_CHANGED
  */
 export function setAuthenticatedUser(authUser) {
-  service.setAuthenticatedUser(authUser);
-  publish(AUTHENTICATED_USER_CHANGED);
+    service.setAuthenticatedUser(authUser);
+    publish(AUTHENTICATED_USER_CHANGED);
 }
-
 /**
  * Reads the authenticated user's access token. Resolves to null if the user is
  * unauthenticated.
@@ -217,10 +208,11 @@ export function setAuthenticatedUser(authUser) {
  * @returns {Promise<UserData>|Promise<null>} Resolves to the user's access token if they are
  * logged in.
  */
-export async function fetchAuthenticatedUser(options = {}) {
-  return service.fetchAuthenticatedUser(options);
+export function fetchAuthenticatedUser() {
+    return __awaiter(this, arguments, void 0, function* (options = {}) {
+        return service.fetchAuthenticatedUser(options);
+    });
 }
-
 /**
  * Ensures a user is authenticated. It will redirect to login when not
  * authenticated.
@@ -229,10 +221,11 @@ export async function fetchAuthenticatedUser(options = {}) {
  * authenticated.
  * @returns {Promise<UserData>}
  */
-export async function ensureAuthenticatedUser(redirectUrl) {
-  return service.ensureAuthenticatedUser(redirectUrl);
+export function ensureAuthenticatedUser(redirectUrl) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return service.ensureAuthenticatedUser(redirectUrl);
+    });
 }
-
 /**
  * Fetches additional user account information for the authenticated user and merges it into the
  * existing authenticatedUser object, available via getAuthenticatedUser().
@@ -246,11 +239,12 @@ export async function ensureAuthenticatedUser(redirectUrl) {
  *
  * @emits AUTHENTICATED_USER_CHANGED
  */
-export async function hydrateAuthenticatedUser() {
-  await service.hydrateAuthenticatedUser();
-  publish(AUTHENTICATED_USER_CHANGED);
+export function hydrateAuthenticatedUser() {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield service.hydrateAuthenticatedUser();
+        publish(AUTHENTICATED_USER_CHANGED);
+    });
 }
-
 /**
  * @name AuthService
  * @interface
@@ -267,7 +261,6 @@ export async function hydrateAuthenticatedUser() {
  * @property {function} ensureAuthenticatedUser
  * @property {function} hydrateAuthenticatedUser
  */
-
 /**
  * A configured axios client. See axios docs for more
  * info https://github.com/axios/axios. All the functions
@@ -297,7 +290,6 @@ export async function hydrateAuthenticatedUser() {
  * @property {function} put (csrf protected)
  * @property {function} patch (csrf protected)
  */
-
 /**
  * @name UserData
  * @interface
@@ -307,3 +299,4 @@ export async function hydrateAuthenticatedUser() {
  * @property {Array} roles
  * @property {boolean} administrator
  */
+//# sourceMappingURL=interface.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"interface.js","sourceRoot":"","sources":["../../../runtime/auth/interface.js"],"names":[],"mappings":";;;;;;;;;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,oBAAoB,CAAC;AAE7D;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,GAAG,wBAAwB,UAAU,CAAC;AAEhF,MAAM,YAAY,GAAG;IACnB,MAAM,EAAE,SAAS,CAAC,KAAK,CAAC;QACtB,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU;QACpC,UAAU,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU;QACvC,QAAQ,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU;QACrC,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU;QACtC,yBAAyB,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU;QACtD,qBAAqB,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU;QAClD,gBAAgB,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU;KAC9C,CAAC,CAAC,UAAU;IACb,cAAc,EAAE,SAAS,CAAC,KAAK,CAAC;QAC9B,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;QACnC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;KACnC,CAAC,CAAC,UAAU;CACd,CAAC;AAEF,MAAM,YAAY,GAAG;IACnB,0BAA0B,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;IACrD,aAAa,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;IACxC,mBAAmB,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;IAC9C,eAAe,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;IAC1C,oBAAoB,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;IAC/C,gBAAgB,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;IAC3C,oBAAoB,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;IAC/C,oBAAoB,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;IAC/C,sBAAsB,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;IACjD,uBAAuB,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;IAClD,wBAAwB,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;CACpD,CAAC;AAEF,IAAI,OAAO,CAAC;AAEZ;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,WAAW,EAAE,OAAO;IAChD,SAAS,CAAC,cAAc,CAAC,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;IACpE,OAAO,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;IACnC,SAAS,CAAC,cAAc,CAAC,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;IAC3E,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc;IAC5B,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB;IAC9B,OAAO,GAAG,IAAI,CAAC;AACjB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,0BAA0B,CAAC,OAAO,GAAG,EAAE;IACrD,OAAO,OAAO,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;AACrD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,OAAO,GAAG,EAAE;IACxC,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;AACxC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,mBAAmB,CAAC,WAAW;IAC7C,OAAO,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;AAClD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,WAAW;IACzC,OAAO,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;AAC9C,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,oBAAoB,CAAC,WAAW;IAC9C,OAAO,OAAO,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;AACnD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,WAAW;IAC1C,OAAO,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;AAC/C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB;IAClC,OAAO,OAAO,CAAC,oBAAoB,EAAE,CAAC;AACxC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,QAAQ;IAC3C,OAAO,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IACvC,OAAO,CAAC,0BAA0B,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAgB,sBAAsB;yDAAC,OAAO,GAAG,EAAE;QACvD,OAAO,OAAO,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;IACjD,CAAC;CAAA;AAED;;;;;;;GAOG;AACH,MAAM,UAAgB,uBAAuB,CAAC,WAAW;;QACvD,OAAO,OAAO,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;IACtD,CAAC;CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAgB,wBAAwB;;QAC5C,MAAM,OAAO,CAAC,wBAAwB,EAAE,CAAC;QACzC,OAAO,CAAC,0BAA0B,CAAC,CAAC;IACtC,CAAC;CAAA;AAED;;;;;;;;;;;;;;;GAeG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH;;;;;;;;GAQG","sourcesContent":["/**\n * #### Import members from **@openedx/frontend-base**\n *\n * Simplifies the process of making authenticated API requests to backend edX services by providing\n * common authN/authZ client code that enables the login/logout flow and handles ensuring the\n * presence of a valid [JWT cookie](https://github.com/openedx/edx-platform/blob/master/openedx/core/djangoapps/oauth_dispatch/docs/decisions/0009-jwt-in-session-cookie.rst).\n *\n * The `initialize` function performs much of the auth configuration for you.  If, however, you're\n * not using the `initialize` function, an authenticated API client can be created via:\n *\n * ```\n * import {\n *   configureAuth,\n *   fetchAuthenticatedUser,\n *   getAuthenticatedHttpClient,\n *   getSiteConfig,\n *   getLoggingService\n * } from '@openedx/frontend-base';\n *\n * configureAuth({\n *   loggingService: getLoggingService(),\n *   config: getSiteConfig(),\n * });\n *\n * const authenticatedUser = await fetchAuthenticatedUser(); // validates and decodes JWT token\n * const authenticatedHttpClient = getAuthenticatedHttpClient();\n * const response = await getAuthenticatedHttpClient().get(`https://example.com/api/user/data/${authenticatedUser.username}`); // fetching from an authenticated API using user data\n * ```\n *\n * As shown in this example, auth depends on the configuration document and logging.\n *\n * NOTE: The documentation for AxiosJwtAuthService is nearly the same as that for the top-level\n * auth interface, except that it contains some Axios-specific details.\n *\n * @module Auth\n */\nimport PropTypes from 'prop-types';\nimport { publish } from '../subscriptions';\n\n/**\n * @constant\n * @private\n */\nexport const AUTHENTICATED_USER_TOPIC = 'AUTHENTICATED_USER';\n\n/**\n * Published when the authenticated user data changes.  This can happen when the authentication\n * service determines that the user is authenticated or anonymous, as well as when we fetch\n * additional user account data if the `hydrateAuthenticatedUser` flag has been set in the\n * `initialize` function.\n *\n * @event\n * @see {@link module:Initialization~initialize}\n */\nexport const AUTHENTICATED_USER_CHANGED = `${AUTHENTICATED_USER_TOPIC}.CHANGED`;\n\nconst optionsShape = {\n  config: PropTypes.shape({\n    baseUrl: PropTypes.string.isRequired,\n    lmsBaseUrl: PropTypes.string.isRequired,\n    loginUrl: PropTypes.string.isRequired,\n    logoutUrl: PropTypes.string.isRequired,\n    refreshAccessTokenApiPath: PropTypes.string.isRequired,\n    accessTokenCookieName: PropTypes.string.isRequired,\n    csrfTokenApiPath: PropTypes.string.isRequired,\n  }).isRequired,\n  loggingService: PropTypes.shape({\n    logError: PropTypes.func.isRequired,\n    logInfo: PropTypes.func.isRequired,\n  }).isRequired,\n};\n\nconst serviceShape = {\n  getAuthenticatedHttpClient: PropTypes.func.isRequired,\n  getHttpClient: PropTypes.func.isRequired,\n  getLoginRedirectUrl: PropTypes.func.isRequired,\n  redirectToLogin: PropTypes.func.isRequired,\n  getLogoutRedirectUrl: PropTypes.func.isRequired,\n  redirectToLogout: PropTypes.func.isRequired,\n  getAuthenticatedUser: PropTypes.func.isRequired,\n  setAuthenticatedUser: PropTypes.func.isRequired,\n  fetchAuthenticatedUser: PropTypes.func.isRequired,\n  ensureAuthenticatedUser: PropTypes.func.isRequired,\n  hydrateAuthenticatedUser: PropTypes.func.isRequired,\n};\n\nlet service;\n\n/**\n *\n * @param {class} AuthService\n * @param {*} options\n * @returns {AuthService}\n */\nexport function configureAuth(AuthService, options) {\n  PropTypes.checkPropTypes(optionsShape, options, 'property', 'Auth');\n  service = new AuthService(options);\n  PropTypes.checkPropTypes(serviceShape, service, 'property', 'AuthService');\n  return service;\n}\n\n/**\n *\n *\n * @returns {AuthService}\n */\nexport function getAuthService() {\n  if (!service) {\n    throw Error('You must first configure the auth service.');\n  }\n\n  return service;\n}\n\n/**\n *\n */\nexport function resetAuthService() {\n  service = null;\n}\n\n/**\n * Gets the authenticated HTTP client for the service.\n *\n * @param {Object} [options] Optional options for how to configure the authenticated HTTP client\n * @param {boolean} [options.useCache] Whether to use front end caching for all requests made with the returned client\n *\n * @returns {HttpClient}\n */\nexport function getAuthenticatedHttpClient(options = {}) {\n  return service.getAuthenticatedHttpClient(options);\n}\n\n/**\n * Gets the unauthenticated HTTP client for the service.\n *\n * @param {Object} [options] Optional options for how to configure the authenticated HTTP client\n * @param {boolean} [options.useCache] Whether to use front end caching for all requests made with the returned client\n *\n * @returns {HttpClient}\n */\nexport function getHttpClient(options = {}) {\n  return service.getHttpClient(options);\n}\n\n/**\n * Builds a URL to the login page with a post-login redirect URL attached as a query parameter.\n *\n * ```\n * const url = getLoginRedirectUrl('http://localhost/mypage');\n * console.log(url); // http://localhost/login?next=http%3A%2F%2Flocalhost%2Fmypage\n * ```\n *\n * @param {string} redirectUrl The URL the user should be redirected to after logging in.\n */\nexport function getLoginRedirectUrl(redirectUrl) {\n  return service.getLoginRedirectUrl(redirectUrl);\n}\n\n/**\n * Redirects the user to the login page.\n *\n * @param {string} redirectUrl The URL the user should be redirected to after logging in.\n */\nexport function redirectToLogin(redirectUrl) {\n  return service.redirectToLogin(redirectUrl);\n}\n\n/**\n * Builds a URL to the logout page with a post-logout redirect URL attached as a query parameter.\n *\n * ```\n * const url = getLogoutRedirectUrl('http://localhost/mypage');\n * console.log(url); // http://localhost/logout?redirect_url=http%3A%2F%2Flocalhost%2Fmypage\n * ```\n *\n * @param {string} redirectUrl The URL the user should be redirected to after logging out.\n */\nexport function getLogoutRedirectUrl(redirectUrl) {\n  return service.getLogoutRedirectUrl(redirectUrl);\n}\n\n/**\n * Redirects the user to the logout page.\n *\n * @param {string} redirectUrl The URL the user should be redirected to after logging out.\n */\nexport function redirectToLogout(redirectUrl) {\n  return service.redirectToLogout(redirectUrl);\n}\n\n/**\n * If it exists, returns the user data representing the currently authenticated user. If the\n * user is anonymous, returns null.\n *\n * @returns {UserData|null}\n */\nexport function getAuthenticatedUser() {\n  return service.getAuthenticatedUser();\n}\n\n/**\n * Sets the authenticated user to the provided value.\n *\n * @param {UserData} authUser\n * @emits AUTHENTICATED_USER_CHANGED\n */\nexport function setAuthenticatedUser(authUser) {\n  service.setAuthenticatedUser(authUser);\n  publish(AUTHENTICATED_USER_CHANGED);\n}\n\n/**\n * Reads the authenticated user's access token. Resolves to null if the user is\n * unauthenticated.\n *\n * @returns {Promise<UserData>|Promise<null>} Resolves to the user's access token if they are\n * logged in.\n */\nexport async function fetchAuthenticatedUser(options = {}) {\n  return service.fetchAuthenticatedUser(options);\n}\n\n/**\n * Ensures a user is authenticated. It will redirect to login when not\n * authenticated.\n *\n * @param {string} [redirectUrl=config.baseUrl] to return user after login when not\n * authenticated.\n * @returns {Promise<UserData>}\n */\nexport async function ensureAuthenticatedUser(redirectUrl) {\n  return service.ensureAuthenticatedUser(redirectUrl);\n}\n\n/**\n * Fetches additional user account information for the authenticated user and merges it into the\n * existing authenticatedUser object, available via getAuthenticatedUser().\n *\n * ```\n *  console.log(authenticatedUser); // Will be sparse and only contain basic information.\n *  await hydrateAuthenticatedUser()\n *  const authenticatedUser = getAuthenticatedUser();\n *  console.log(authenticatedUser); // Will contain additional user information\n * ```\n *\n * @emits AUTHENTICATED_USER_CHANGED\n */\nexport async function hydrateAuthenticatedUser() {\n  await service.hydrateAuthenticatedUser();\n  publish(AUTHENTICATED_USER_CHANGED);\n}\n\n/**\n * @name AuthService\n * @interface\n * @memberof module:Auth\n * @property {function} getAuthenticatedHttpClient\n * @property {function} getHttpClient\n * @property {function} getLoginRedirectUrl\n * @property {function} redirectToLogin\n * @property {function} getLogoutRedirectUrl\n * @property {function} redirectToLogout\n * @property {function} getAuthenticatedUser\n * @property {function} setAuthenticatedUser\n * @property {function} fetchAuthenticatedUser\n * @property {function} ensureAuthenticatedUser\n * @property {function} hydrateAuthenticatedUser\n */\n\n/**\n * A configured axios client. See axios docs for more\n * info https://github.com/axios/axios. All the functions\n * below accept isPublic and isCsrfExempt in the request\n * config options. Setting these to true will prevent this\n * client from attempting to refresh the jwt access token\n * or a csrf token respectively.\n *\n * ```\n *  // A public endpoint (no jwt token refresh)\n *  apiClient.get('/path/to/endpoint', { isPublic: true });\n * ```\n *\n * ```\n *  // A csrf exempt endpoint\n *  apiClient.post('/path/to/endpoint', { data }, { isCsrfExempt: true });\n * ```\n *\n * @name HttpClient\n * @interface\n * @memberof module:Auth\n * @property {function} get\n * @property {function} head\n * @property {function} options\n * @property {function} delete (csrf protected)\n * @property {function} post (csrf protected)\n * @property {function} put (csrf protected)\n * @property {function} patch (csrf protected)\n */\n\n/**\n * @name UserData\n * @interface\n * @memberof module:Auth\n * @property {string} userId\n * @property {string} username\n * @property {Array} roles\n * @property {boolean} administrator\n */\n"]}

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

@@ -0,0 +1,13 @@
+export function getUrlParts(url: any): {
+    fullUrl: any;
+    protocol: any;
+    domain: any;
+    path: any;
+    endFilename: any;
+    endFileExtension: any;
+    query: any;
+    hash: any;
+};
+export function logFrontendAuthError(loggingService: any, error: any): void;
+export function processAxiosError(axiosErrorObject: any): any;
+export function processAxiosErrorAndThrow(axiosErrorObject: any): never;

package/dist/runtime/auth/utils.js

@@ -0,0 +1,66 @@
+// Lifted from here: https://regexr.com/3ok5o
+const urlRegex = /([a-z]{1,2}tps?):\/\/((?:(?!(?:\/|#|\?|&)).)+)(?:(\/(?:(?:(?:(?!(?:#|\?|&)).)+\/))?))?(?:((?:(?!(?:\.|$|\?|#)).)+))?(?:(\.(?:(?!(?:\?|$|#)).)+))?(?:(\?(?:(?!(?:$|#)).)+))?(?:(#.+))?/;
+const getUrlParts = (url) => {
+    const found = url.match(urlRegex);
+    try {
+        const [fullUrl, protocol, domain, path, endFilename, endFileExtension, query, hash,] = found;
+        return {
+            fullUrl,
+            protocol,
+            domain,
+            path,
+            endFilename,
+            endFileExtension,
+            query,
+            hash,
+        };
+    }
+    catch (e) {
+        throw new Error(`Could not find url parts from ${url}.`);
+    }
+};
+const logFrontendAuthError = (loggingService, error) => {
+    const prefixedMessageError = Object.create(error);
+    prefixedMessageError.message = `[frontend-auth] ${error.message}`;
+    loggingService.logError(prefixedMessageError, prefixedMessageError.customAttributes);
+};
+const processAxiosError = (axiosErrorObject) => {
+    const error = Object.create(axiosErrorObject);
+    const { request, response, config } = error;
+    if (!config) {
+        error.customAttributes = Object.assign(Object.assign({}, error.customAttributes), { httpErrorType: 'unknown-api-request-error' });
+        return error;
+    }
+    const { url: httpErrorRequestUrl, method: httpErrorRequestMethod, } = config;
+    /* istanbul ignore else: difficult to enter the request-only error case in a unit test */
+    if (response) {
+        const { status, data } = response;
+        const stringifiedData = JSON.stringify(data) || '(empty response)';
+        const responseIsHTML = stringifiedData.includes('<!DOCTYPE html>');
+        // Don't include data if it is just an HTML document, like a 500 error page.
+        /* istanbul ignore next */
+        const httpErrorResponseData = responseIsHTML ? '<Response is HTML>' : stringifiedData;
+        error.customAttributes = Object.assign(Object.assign({}, error.customAttributes), { httpErrorType: 'api-response-error', httpErrorStatus: status, httpErrorResponseData,
+            httpErrorRequestUrl,
+            httpErrorRequestMethod });
+        error.message = `Axios Error (Response): ${status} - See custom attributes for details.`;
+    }
+    else if (request) {
+        error.customAttributes = Object.assign(Object.assign({}, error.customAttributes), { httpErrorType: 'api-request-error', httpErrorMessage: error.message, httpErrorRequestUrl,
+            httpErrorRequestMethod });
+        // This case occurs most likely because of intermittent internet connection issues
+        // but it also, though less often, catches CORS or server configuration problems.
+        error.message = 'Axios Error (Request): (Possible local connectivity issue.) See custom attributes for details.';
+    }
+    else {
+        error.customAttributes = Object.assign(Object.assign({}, error.customAttributes), { httpErrorType: 'api-request-config-error', httpErrorMessage: error.message, httpErrorRequestUrl,
+            httpErrorRequestMethod });
+        error.message = 'Axios Error (Config): See custom attributes for details.';
+    }
+    return error;
+};
+const processAxiosErrorAndThrow = (axiosErrorObject) => {
+    throw processAxiosError(axiosErrorObject);
+};
+export { getUrlParts, logFrontendAuthError, processAxiosError, processAxiosErrorAndThrow };
+//# sourceMappingURL=utils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../runtime/auth/utils.js"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,MAAM,QAAQ,GAAG,uLAAuL,CAAC;AACzM,MAAM,WAAW,GAAG,CAAC,GAAG,EAAE,EAAE;IAC1B,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAClC,IAAI,CAAC;QACH,MAAM,CACJ,OAAO,EACP,QAAQ,EACR,MAAM,EACN,IAAI,EACJ,WAAW,EACX,gBAAgB,EAChB,KAAK,EACL,IAAI,EACL,GAAG,KAAK,CAAC;QAEV,OAAO;YACL,OAAO;YACP,QAAQ;YACR,MAAM;YACN,IAAI;YACJ,WAAW;YACX,gBAAgB;YAChB,KAAK;YACL,IAAI;SACL,CAAC;IACJ,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,iCAAiC,GAAG,GAAG,CAAC,CAAC;IAC3D,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,cAAc,EAAE,KAAK,EAAE,EAAE;IACrD,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAClD,oBAAoB,CAAC,OAAO,GAAG,mBAAmB,KAAK,CAAC,OAAO,EAAE,CAAC;IAClE,cAAc,CAAC,QAAQ,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;AACvF,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,gBAAgB,EAAE,EAAE;IAC7C,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAC9C,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;IAE5C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,KAAK,CAAC,gBAAgB,mCACjB,KAAK,CAAC,gBAAgB,KACzB,aAAa,EAAE,2BAA2B,GAC3C,CAAC;QACF,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,EACJ,GAAG,EAAE,mBAAmB,EACxB,MAAM,EAAE,sBAAsB,GAC/B,GAAG,MAAM,CAAC;IACX,yFAAyF;IACzF,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC;QAClC,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC;QACnE,MAAM,cAAc,GAAG,eAAe,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;QACnE,4EAA4E;QAC5E,0BAA0B;QAC1B,MAAM,qBAAqB,GAAG,cAAc,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,eAAe,CAAC;QACtF,KAAK,CAAC,gBAAgB,mCACjB,KAAK,CAAC,gBAAgB,KACzB,aAAa,EAAE,oBAAoB,EACnC,eAAe,EAAE,MAAM,EACvB,qBAAqB;YACrB,mBAAmB;YACnB,sBAAsB,GACvB,CAAC;QACF,KAAK,CAAC,OAAO,GAAG,2BAA2B,MAAM,uCAAuC,CAAC;IAC3F,CAAC;SAAM,IAAI,OAAO,EAAE,CAAC;QACnB,KAAK,CAAC,gBAAgB,mCACjB,KAAK,CAAC,gBAAgB,KACzB,aAAa,EAAE,mBAAmB,EAClC,gBAAgB,EAAE,KAAK,CAAC,OAAO,EAC/B,mBAAmB;YACnB,sBAAsB,GACvB,CAAC;QACF,kFAAkF;QAClF,iFAAiF;QACjF,KAAK,CAAC,OAAO,GAAG,gGAAgG,CAAC;IACnH,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,gBAAgB,mCACjB,KAAK,CAAC,gBAAgB,KACzB,aAAa,EAAE,0BAA0B,EACzC,gBAAgB,EAAE,KAAK,CAAC,OAAO,EAC/B,mBAAmB;YACnB,sBAAsB,GACvB,CAAC;QACF,KAAK,CAAC,OAAO,GAAG,0DAA0D,CAAC;IAC7E,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,yBAAyB,GAAG,CAAC,gBAAgB,EAAE,EAAE;IACrD,MAAM,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;AAC5C,CAAC,CAAC;AAEF,OAAO,EACL,WAAW,EACX,oBAAoB,EACpB,iBAAiB,EACjB,yBAAyB,EAC1B,CAAC","sourcesContent":["// Lifted from here: https://regexr.com/3ok5o\nconst urlRegex = /([a-z]{1,2}tps?):\\/\\/((?:(?!(?:\\/|#|\\?|&)).)+)(?:(\\/(?:(?:(?:(?!(?:#|\\?|&)).)+\\/))?))?(?:((?:(?!(?:\\.|$|\\?|#)).)+))?(?:(\\.(?:(?!(?:\\?|$|#)).)+))?(?:(\\?(?:(?!(?:$|#)).)+))?(?:(#.+))?/;\nconst getUrlParts = (url) => {\n  const found = url.match(urlRegex);\n  try {\n    const [\n      fullUrl,\n      protocol,\n      domain,\n      path,\n      endFilename,\n      endFileExtension,\n      query,\n      hash,\n    ] = found;\n\n    return {\n      fullUrl,\n      protocol,\n      domain,\n      path,\n      endFilename,\n      endFileExtension,\n      query,\n      hash,\n    };\n  } catch (e) {\n    throw new Error(`Could not find url parts from ${url}.`);\n  }\n};\n\nconst logFrontendAuthError = (loggingService, error) => {\n  const prefixedMessageError = Object.create(error);\n  prefixedMessageError.message = `[frontend-auth] ${error.message}`;\n  loggingService.logError(prefixedMessageError, prefixedMessageError.customAttributes);\n};\n\nconst processAxiosError = (axiosErrorObject) => {\n  const error = Object.create(axiosErrorObject);\n  const { request, response, config } = error;\n\n  if (!config) {\n    error.customAttributes = {\n      ...error.customAttributes,\n      httpErrorType: 'unknown-api-request-error',\n    };\n    return error;\n  }\n\n  const {\n    url: httpErrorRequestUrl,\n    method: httpErrorRequestMethod,\n  } = config;\n  /* istanbul ignore else: difficult to enter the request-only error case in a unit test */\n  if (response) {\n    const { status, data } = response;\n    const stringifiedData = JSON.stringify(data) || '(empty response)';\n    const responseIsHTML = stringifiedData.includes('<!DOCTYPE html>');\n    // Don't include data if it is just an HTML document, like a 500 error page.\n    /* istanbul ignore next */\n    const httpErrorResponseData = responseIsHTML ? '<Response is HTML>' : stringifiedData;\n    error.customAttributes = {\n      ...error.customAttributes,\n      httpErrorType: 'api-response-error',\n      httpErrorStatus: status,\n      httpErrorResponseData,\n      httpErrorRequestUrl,\n      httpErrorRequestMethod,\n    };\n    error.message = `Axios Error (Response): ${status} - See custom attributes for details.`;\n  } else if (request) {\n    error.customAttributes = {\n      ...error.customAttributes,\n      httpErrorType: 'api-request-error',\n      httpErrorMessage: error.message,\n      httpErrorRequestUrl,\n      httpErrorRequestMethod,\n    };\n    // This case occurs most likely because of intermittent internet connection issues\n    // but it also, though less often, catches CORS or server configuration problems.\n    error.message = 'Axios Error (Request): (Possible local connectivity issue.) See custom attributes for details.';\n  } else {\n    error.customAttributes = {\n      ...error.customAttributes,\n      httpErrorType: 'api-request-config-error',\n      httpErrorMessage: error.message,\n      httpErrorRequestUrl,\n      httpErrorRequestMethod,\n    };\n    error.message = 'Axios Error (Config): See custom attributes for details.';\n  }\n\n  return error;\n};\n\nconst processAxiosErrorAndThrow = (axiosErrorObject) => {\n  throw processAxiosError(axiosErrorObject);\n};\n\nexport {\n  getUrlParts,\n  logFrontendAuthError,\n  processAxiosError,\n  processAxiosErrorAndThrow\n};\n"]}

package/dist/runtime/babel.config.d.ts

@@ -0,0 +1,2 @@
+export = config;
+import config = require("../tools/babel/babel.config");

package/{shell → dist/runtime}/babel.config.js

@@ -1,3 +1,4 @@
+"use strict";
 const config = require('../tools/babel/babel.config');
-
 module.exports = config;
+//# sourceMappingURL=babel.config.js.map

package/dist/runtime/babel.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"babel.config.js","sourceRoot":"","sources":["../../runtime/babel.config.js"],"names":[],"mappings":";AAAA,MAAM,MAAM,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAC;AAEtD,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC","sourcesContent":["const config = require('../tools/babel/babel.config');\n\nmodule.exports = config;\n"]}