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

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

@@ -29,26 +29,22 @@
  * @module Analytics
  */
 import PropTypes from 'prop-types';
-
 const optionsShape = {
-  config: PropTypes.object.isRequired,
-  httpClient: PropTypes.oneOfType([PropTypes.func, PropTypes.object]).isRequired,
-  loggingService: PropTypes.shape({
-    logError: PropTypes.func.isRequired,
-    logInfo: PropTypes.func.isRequired,
-  }).isRequired,
+    config: PropTypes.object.isRequired,
+    httpClient: PropTypes.oneOfType([PropTypes.func, PropTypes.object]).isRequired,
+    loggingService: PropTypes.shape({
+        logError: PropTypes.func.isRequired,
+        logInfo: PropTypes.func.isRequired,
+    }).isRequired,
 };
-
 const serviceShape = {
-  sendTrackingLogEvent: PropTypes.func.isRequired,
-  identifyAuthenticatedUser: PropTypes.func.isRequired,
-  identifyAnonymousUser: PropTypes.func.isRequired,
-  sendTrackEvent: PropTypes.func.isRequired,
-  sendPageEvent: PropTypes.func.isRequired,
+    sendTrackingLogEvent: PropTypes.func.isRequired,
+    identifyAuthenticatedUser: PropTypes.func.isRequired,
+    identifyAnonymousUser: PropTypes.func.isRequired,
+    sendTrackEvent: PropTypes.func.isRequired,
+    sendPageEvent: PropTypes.func.isRequired,
 };
-
 let service;
-
 /**
  *
  * @param {class} AnalyticsService
@@ -56,12 +52,11 @@ let service;
  * @returns {AnalyticsService}
  */
 export function configureAnalytics(AnalyticsService, options) {
-  PropTypes.checkPropTypes(optionsShape, options, 'property', 'Analytics');
-  service = new AnalyticsService(options);
-  PropTypes.checkPropTypes(serviceShape, service, 'property', 'AnalyticsService');
-  return service;
+    PropTypes.checkPropTypes(optionsShape, options, 'property', 'Analytics');
+    service = new AnalyticsService(options);
+    PropTypes.checkPropTypes(serviceShape, service, 'property', 'AnalyticsService');
+    return service;
 }
-
 /**
  *
  * @param {*} eventName
@@ -69,9 +64,8 @@ export function configureAnalytics(AnalyticsService, options) {
  * @returns {Promise}
  */
 export function sendTrackingLogEvent(eventName, properties) {
-  return service.sendTrackingLogEvent(eventName, properties);
+    return service.sendTrackingLogEvent(eventName, properties);
 }
-
 /**
  *
  *
@@ -79,9 +73,8 @@ export function sendTrackingLogEvent(eventName, properties) {
  * @param {*} traits
  */
 export function identifyAuthenticatedUser(userId, traits) {
-  service.identifyAuthenticatedUser(userId, traits);
+    service.identifyAuthenticatedUser(userId, traits);
 }
-
 /**
  *
  *
@@ -89,9 +82,8 @@ export function identifyAuthenticatedUser(userId, traits) {
  * @returns {Promise}
  */
 export function identifyAnonymousUser(traits) {
-  return service.identifyAnonymousUser(traits);
+    return service.identifyAnonymousUser(traits);
 }
-
 /**
  *
  *
@@ -99,9 +91,8 @@ export function identifyAnonymousUser(traits) {
  * @param {*} properties
  */
 export function sendTrackEvent(eventName, properties) {
-  service.sendTrackEvent(eventName, properties);
+    service.sendTrackEvent(eventName, properties);
 }
-
 /**
  *
  *
@@ -110,29 +101,25 @@ export function sendTrackEvent(eventName, properties) {
  * @param {*} properties
  */
 export function sendPageEvent(category, name, properties) {
-  service.sendPageEvent(category, name, properties);
+    service.sendPageEvent(category, name, properties);
 }
-
 /**
  *
  *
  * @returns {AnalyticsService}
  */
 export function getAnalyticsService() {
-  if (!service) {
-    throw Error('You must first configure the analytics service.');
-  }
-
-  return service;
+    if (!service) {
+        throw Error('You must first configure the analytics service.');
+    }
+    return service;
 }
-
 /**
  *
  */
 export function resetAnalyticsService() {
-  service = null;
+    service = null;
 }
-
 /**
  * @name AnalyticsService
  * @interface
@@ -143,3 +130,4 @@ export function resetAnalyticsService() {
  * @property {function} sendTrackEvent
  * @property {function} sendTrackingLogEvent
  */
+//# sourceMappingURL=interface.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"interface.js","sourceRoot":"","sources":["../../../runtime/analytics/interface.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,OAAO,SAAS,MAAM,YAAY,CAAC;AAEnC,MAAM,YAAY,GAAG;IACnB,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU;IACnC,UAAU,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU;IAC9E,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,oBAAoB,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;IAC/C,yBAAyB,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;IACpD,qBAAqB,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;IAChD,cAAc,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;IACzC,aAAa,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;CACzC,CAAC;AAEF,IAAI,OAAO,CAAC;AAEZ;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,gBAAgB,EAAE,OAAO;IAC1D,SAAS,CAAC,cAAc,CAAC,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IACzE,OAAO,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACxC,SAAS,CAAC,cAAc,CAAC,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,kBAAkB,CAAC,CAAC;IAChF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,SAAS,EAAE,UAAU;IACxD,OAAO,OAAO,CAAC,oBAAoB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CAAC,MAAM,EAAE,MAAM;IACtD,OAAO,CAAC,yBAAyB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACpD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,MAAM;IAC1C,OAAO,OAAO,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;AAC/C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,SAAS,EAAE,UAAU;IAClD,OAAO,CAAC,cAAc,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,QAAQ,EAAE,IAAI,EAAE,UAAU;IACtD,OAAO,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;AACpD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB;IACjC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACjE,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB;IACnC,OAAO,GAAG,IAAI,CAAC;AACjB,CAAC;AAED;;;;;;;;;GASG","sourcesContent":["/**\n * #### Import members from **@openedx/frontend-base** Analytics\n *\n * Contains a shared interface for tracking events.  Has a default implementation of\n * SegmentAnalyticsService, which supports Segment and the Tracking Log API (hosted in LMS).\n *\n * The `initialize` function performs much of the analytics configuration for you.  If, however,\n * you're not using the `initialize` function, analytics can be configured via:\n *\n * ```\n * import {\n *   getSiteConfig,\n *   getAuthenticatedHttpClient,\n *   getLoggingService,\n *   configureAnalytics,\n *   SegmentAnalyticsService\n * } from '@openedx/frontend-base';\n *\n * configureAnalytics(SegmentAnalyticsService, {\n *   config: getSiteConfig(),\n *   loggingService: getLoggingService(),\n *   httpClient: getAuthenticatedHttpClient(),\n * });\n * ```\n *\n * As shown in this example, analytics depends on the configuration document, logging, and having\n * an authenticated HTTP client.\n *\n * @module Analytics\n */\nimport PropTypes from 'prop-types';\n\nconst optionsShape = {\n  config: PropTypes.object.isRequired,\n  httpClient: PropTypes.oneOfType([PropTypes.func, PropTypes.object]).isRequired,\n  loggingService: PropTypes.shape({\n    logError: PropTypes.func.isRequired,\n    logInfo: PropTypes.func.isRequired,\n  }).isRequired,\n};\n\nconst serviceShape = {\n  sendTrackingLogEvent: PropTypes.func.isRequired,\n  identifyAuthenticatedUser: PropTypes.func.isRequired,\n  identifyAnonymousUser: PropTypes.func.isRequired,\n  sendTrackEvent: PropTypes.func.isRequired,\n  sendPageEvent: PropTypes.func.isRequired,\n};\n\nlet service;\n\n/**\n *\n * @param {class} AnalyticsService\n * @param {*} options\n * @returns {AnalyticsService}\n */\nexport function configureAnalytics(AnalyticsService, options) {\n  PropTypes.checkPropTypes(optionsShape, options, 'property', 'Analytics');\n  service = new AnalyticsService(options);\n  PropTypes.checkPropTypes(serviceShape, service, 'property', 'AnalyticsService');\n  return service;\n}\n\n/**\n *\n * @param {*} eventName\n * @param {*} properties\n * @returns {Promise}\n */\nexport function sendTrackingLogEvent(eventName, properties) {\n  return service.sendTrackingLogEvent(eventName, properties);\n}\n\n/**\n *\n *\n * @param {*} userId\n * @param {*} traits\n */\nexport function identifyAuthenticatedUser(userId, traits) {\n  service.identifyAuthenticatedUser(userId, traits);\n}\n\n/**\n *\n *\n * @param {*} traits\n * @returns {Promise}\n */\nexport function identifyAnonymousUser(traits) {\n  return service.identifyAnonymousUser(traits);\n}\n\n/**\n *\n *\n * @param {*} eventName\n * @param {*} properties\n */\nexport function sendTrackEvent(eventName, properties) {\n  service.sendTrackEvent(eventName, properties);\n}\n\n/**\n *\n *\n * @param {*} category\n * @param {*} name\n * @param {*} properties\n */\nexport function sendPageEvent(category, name, properties) {\n  service.sendPageEvent(category, name, properties);\n}\n\n/**\n *\n *\n * @returns {AnalyticsService}\n */\nexport function getAnalyticsService() {\n  if (!service) {\n    throw Error('You must first configure the analytics service.');\n  }\n\n  return service;\n}\n\n/**\n *\n */\nexport function resetAnalyticsService() {\n  service = null;\n}\n\n/**\n * @name AnalyticsService\n * @interface\n * @memberof module:Analytics\n * @property {function} identifyAnonymousUser\n * @property {function} identifyAuthenticatedUser\n * @property {function} sendPageEvent\n * @property {function} sendTrackEvent\n * @property {function} sendTrackingLogEvent\n */\n"]}

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

@@ -0,0 +1,10 @@
+export default class AxiosCsrfTokenService {
+    constructor(csrfTokenApiPath: any);
+    csrfTokenApiPath: any;
+    httpClient: import("axios").AxiosInstance;
+    csrfTokenCache: {};
+    csrfTokenRequestPromises: {};
+    getCsrfToken(url: any): Promise<any>;
+    clearCsrfTokenCache(): void;
+    getHttpClient(): import("axios").AxiosInstance;
+}

package/dist/runtime/auth/AxiosCsrfTokenService.js

@@ -0,0 +1,64 @@
+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 { getUrlParts, processAxiosErrorAndThrow } from './utils';
+export default class AxiosCsrfTokenService {
+    constructor(csrfTokenApiPath) {
+        this.csrfTokenApiPath = csrfTokenApiPath;
+        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;
+        this.httpClient.defaults.headers['USE-JWT-COOKIE'] = true;
+        this.csrfTokenCache = {};
+        this.csrfTokenRequestPromises = {};
+    }
+    getCsrfToken(url) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let urlParts;
+            try {
+                urlParts = getUrlParts(url);
+            }
+            catch (e) {
+                // If the url is not parsable it's likely because a relative
+                // path was supplied as the url. This is acceptable and in
+                // this case we should use the current origin of the page.
+                urlParts = getUrlParts(global.location.origin);
+            }
+            const { protocol, domain } = urlParts;
+            const csrfToken = this.csrfTokenCache[domain];
+            if (csrfToken) {
+                return csrfToken;
+            }
+            if (!this.csrfTokenRequestPromises[domain]) {
+                this.csrfTokenRequestPromises[domain] = this.httpClient
+                    .get(`${protocol}://${domain}${this.csrfTokenApiPath}`)
+                    .then((response) => {
+                    this.csrfTokenCache[domain] = response.data.csrfToken;
+                    return this.csrfTokenCache[domain];
+                })
+                    .catch(processAxiosErrorAndThrow)
+                    .finally(() => {
+                    delete this.csrfTokenRequestPromises[domain];
+                });
+            }
+            return this.csrfTokenRequestPromises[domain];
+        });
+    }
+    clearCsrfTokenCache() {
+        this.csrfTokenCache = {};
+    }
+    getHttpClient() {
+        return this.httpClient;
+    }
+}
+//# sourceMappingURL=AxiosCsrfTokenService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AxiosCsrfTokenService.js","sourceRoot":"","sources":["../../../runtime/auth/AxiosCsrfTokenService.js"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,WAAW,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAC;AAEjE,MAAM,CAAC,OAAO,OAAO,qBAAqB;IACxC,YAAY,gBAAgB;QAC1B,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,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,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;QAE1D,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;QACzB,IAAI,CAAC,wBAAwB,GAAG,EAAE,CAAC;IACrC,CAAC;IAEK,YAAY,CAAC,GAAG;;YACpB,IAAI,QAAQ,CAAC;YACb,IAAI,CAAC;gBACH,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;YAC9B,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,4DAA4D;gBAC5D,0DAA0D;gBAC1D,0DAA0D;gBAC1D,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACjD,CAAC;YAED,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC;YACtC,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;YAE9C,IAAI,SAAS,EAAE,CAAC;gBACd,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3C,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU;qBACpD,GAAG,CAAC,GAAG,QAAQ,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;qBACtD,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;oBACjB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;oBACtD,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;gBACrC,CAAC,CAAC;qBACD,KAAK,CAAC,yBAAyB,CAAC;qBAChC,OAAO,CAAC,GAAG,EAAE;oBACZ,OAAO,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;gBAC/C,CAAC,CAAC,CAAC;YACP,CAAC;YAED,OAAO,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,mBAAmB;QACjB,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;IAC3B,CAAC;IAED,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF","sourcesContent":["import axios from 'axios';\nimport { getUrlParts, processAxiosErrorAndThrow } from './utils';\n\nexport default class AxiosCsrfTokenService {\n  constructor(csrfTokenApiPath) {\n    this.csrfTokenApiPath = csrfTokenApiPath;\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    this.httpClient.defaults.headers['USE-JWT-COOKIE'] = true;\n\n    this.csrfTokenCache = {};\n    this.csrfTokenRequestPromises = {};\n  }\n\n  async getCsrfToken(url) {\n    let urlParts;\n    try {\n      urlParts = getUrlParts(url);\n    } catch (e) {\n      // If the url is not parsable it's likely because a relative\n      // path was supplied as the url. This is acceptable and in\n      // this case we should use the current origin of the page.\n      urlParts = getUrlParts(global.location.origin);\n    }\n\n    const { protocol, domain } = urlParts;\n    const csrfToken = this.csrfTokenCache[domain];\n\n    if (csrfToken) {\n      return csrfToken;\n    }\n\n    if (!this.csrfTokenRequestPromises[domain]) {\n      this.csrfTokenRequestPromises[domain] = this.httpClient\n        .get(`${protocol}://${domain}${this.csrfTokenApiPath}`)\n        .then((response) => {\n          this.csrfTokenCache[domain] = response.data.csrfToken;\n          return this.csrfTokenCache[domain];\n        })\n        .catch(processAxiosErrorAndThrow)\n        .finally(() => {\n          delete this.csrfTokenRequestPromises[domain];\n        });\n    }\n\n    return this.csrfTokenRequestPromises[domain];\n  }\n\n  clearCsrfTokenCache() {\n    this.csrfTokenCache = {};\n  }\n\n  getHttpClient() {\n    return this.httpClient;\n  }\n}\n"]}

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

@@ -0,0 +1,182 @@
+export default AxiosJwtAuthService;
+/**
+ * @implements {AuthService}
+ * @memberof module:Auth
+ */
+declare class AxiosJwtAuthService 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: HttpClient;
+    httpClient: import("axios").AxiosInstance;
+    cachedAuthenticatedHttpClient: any;
+    cachedHttpClient: any;
+    authenticatedUser: any;
+    config: {
+        baseUrl: string;
+        lmsBaseUrl: string;
+        loginUrl: string;
+        logoutUrl: string;
+        refreshAccessTokenApiPath: string;
+        accessTokenCookieName: string;
+        csrfTokenApiPath: string;
+    };
+    loggingService: any;
+    jwtTokenService: AxiosJwtTokenService;
+    csrfTokenService: AxiosCsrfTokenService;
+    middleware: any;
+    /**
+     * Applies middleware to the axios instances in this service.
+     *
+     * @param {Array} middleware Middleware to apply.
+     */
+    applyMiddleware(middleware?: any[]): void;
+    /**
+     * Gets the authenticated HTTP client for the service.  This is an axios instance.
+     *
+     * @param {Object} [options] Optional options for how the HTTP client should be configured.
+     * @param {boolean} [options.useCache] Whether to use front end caching for all requests made
+     * with the returned client.
+     *
+     * @returns {HttpClient} A configured axios http client which can be used for authenticated
+     * requests.
+     */
+    getAuthenticatedHttpClient(options?: {
+        useCache?: boolean | undefined;
+    }): HttpClient;
+    /**
+     * Gets the unauthenticated HTTP client for the service.  This is an axios instance.
+     *
+     * @param {Object} [options] Optional options for how the HTTP client should be configured.
+     * @param {boolean} [options.useCache] Whether to use front end caching for all requests made
+     * with the returned client.
+     * @returns {HttpClient} A configured axios http client.
+     */
+    getHttpClient(options?: {
+        useCache?: boolean | undefined;
+    }): HttpClient;
+    /**
+     * Used primarily for testing.
+     *
+     * @ignore
+     */
+    getJwtTokenService(): AxiosJwtTokenService;
+    /**
+     * Used primarily for testing.
+     *
+     * @ignore
+     */
+    getCsrfTokenService(): AxiosCsrfTokenService;
+    /**
+     * 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(redirectUrl?: string): string;
+    /**
+     * Redirects the user to the login page.
+     *
+     * @param {string} redirectUrl The URL the user should be redirected to after logging in.
+     */
+    redirectToLogin(redirectUrl?: string): void;
+    /**
+     * 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(redirectUrl?: string): string;
+    /**
+     * Redirects the user to the logout page.
+     *
+     * @param {string} redirectUrl The URL the user should be redirected to after logging out.
+     */
+    redirectToLogout(redirectUrl?: string): void;
+    /**
+     * If it exists, returns the user data representing the currently authenticated user. If the
+     * user is anonymous, returns null.
+     *
+     * @returns {UserData|null}
+     */
+    getAuthenticatedUser(): UserData | null;
+    /**
+     * Sets the authenticated user to the provided value.
+     *
+     * @param {UserData} authUser
+     */
+    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.
+     */
+    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>}
+     */
+    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
+     * ```
+     *
+     * @returns {Promise<null>}
+     */
+    hydrateAuthenticatedUser(): Promise<null>;
+    /**
+   * Adds authentication defaults and interceptors to an HTTP client instance.
+   *
+   * @param {HttpClient} newHttpClient
+   * @param {Object} config
+   * @param {string} [config.refreshAccessTokenApiPath]
+   * @param {string} [config.accessTokenCookieName]
+   * @param {string} [config.csrfTokenApiPath]
+   * @returns {HttpClient} A configured Axios HTTP client.
+   */
+    addAuthenticationToHttpClient(newHttpClient: HttpClient): HttpClient;
+}
+import AxiosJwtTokenService from './AxiosJwtTokenService';
+import AxiosCsrfTokenService from './AxiosCsrfTokenService';