@openedx/frontend-base 1.0.0-alpha.9 → 1.0.0

package/README.md

@@ -67,6 +67,33 @@ npm run dev
 
 The development site will be available at `http://apps.local.openedx.io:8080`.
 
+### Developing an app and `frontend-base` concurrently
+
+Concurrent development with `frontend-base` uses a tarball-based workflow rather than traditional local linking approaches. See the [`@openedx/frontend-dev-utils` autoinstall README](https://github.com/openedx/frontend-dev-utils/blob/main/tools/autoinstall/README.md) for details.
+
+#### In `frontend-base`
+
+This watches for changes in `frontend-base` and rebuilds the packaged tarball on each change.
+
+```sh
+nvm use
+npm ci
+npm run watch:pack
+```
+
+#### In the consuming application
+
+> [!NOTE]
+> This assumes the consuming application is using `devutils-dev-with-autoinstall` from `@openedx/frontend-dev-utils`.
+
+This watches for changes to the generated .tgz, installs the updated package, and restarts the dev server.
+
+```sh
+nvm use
+npm ci
+npm run dev:autoinstall
+```
+
 ## Migrating an MFE to `frontend-base`
 
 See the [Frontend App Migration How To](./docs/how_tos/migrate-frontend-app.md).

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './runtime';
+export type * from './types';
+export * from './types';
+export * from './shell';

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from './runtime';
+export * from './types';
+export * from './shell';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAI1B,cAAc,SAAS,CAAC;AAExB,cAAc,SAAS,CAAC","sourcesContent":["export * from './runtime';\n\nexport type * from './types';\n\nexport * from './types';\n\nexport * from './shell';\n"]}

package/dist/runtime/analytics/MockAnalyticsService.d.ts

@@ -0,0 +1,50 @@
+export default MockAnalyticsService;
+/**
+ * The MockAnalyticsService implements all functions of AnalyticsService as Jest mocks (jest.fn())).
+ * It emulates the behavior of a real analytics service but witohut making any requests. It has no
+ * other functionality.
+ *
+ * @implements {AnalyticsService}
+ * @memberof module:Analytics
+ */
+declare class MockAnalyticsService implements AnalyticsService {
+    static hasIdentifyBeenCalled: boolean;
+    constructor({ httpClient, loggingService }: {
+        httpClient: any;
+        loggingService: any;
+    });
+    loggingService: any;
+    httpClient: any;
+    checkIdentifyCalled: jest.Mock<void, [], any>;
+    /**
+     * Returns a resolved promise.
+     *
+     * @returns {Promise} The promise returned by HttpClient.post.
+     */
+    sendTrackingLogEvent: jest.Mock<Promise<void>, [], any>;
+    /**
+     * No-op, but records that identify has been called.
+     *
+     * @param {string} userId
+     * @throws {Error} If userId argument is not supplied.
+     */
+    identifyAuthenticatedUser: jest.Mock<void, [userId: any], any>;
+    hasIdentifyBeenCalled: boolean | undefined;
+    /**
+     * No-op, but records that it has been called to prevent double-identification.
+     * @returns {Promise} A resolved promise.
+     */
+    identifyAnonymousUser: jest.Mock<Promise<void>, [], any>;
+    /**
+     * Logs the event to the console.
+     *
+     * Checks whether identify has been called, logging an error to the logging service if not.
+     */
+    sendTrackEvent: jest.Mock<void, [], any>;
+    /**
+     * Logs the event to the console.
+     *
+     * Checks whether identify has been called, logging an error to the logging service if not.
+     */
+    sendPageEvent: jest.Mock<void, [], any>;
+}

package/dist/runtime/analytics/MockAnalyticsService.js

@@ -0,0 +1,64 @@
+/**
+ * The MockAnalyticsService implements all functions of AnalyticsService as Jest mocks (jest.fn())).
+ * It emulates the behavior of a real analytics service but witohut making any requests. It has no
+ * other functionality.
+ *
+ * @implements {AnalyticsService}
+ * @memberof module:Analytics
+ */
+class MockAnalyticsService {
+    constructor({ httpClient, loggingService }) {
+        this.checkIdentifyCalled = jest.fn(() => {
+            if (!this.hasIdentifyBeenCalled) {
+                this.loggingService.logError('Identify must be called before other tracking events.');
+            }
+        });
+        /**
+         * Returns a resolved promise.
+         *
+         * @returns {Promise} The promise returned by HttpClient.post.
+         */
+        this.sendTrackingLogEvent = jest.fn(() => Promise.resolve());
+        /**
+         * No-op, but records that identify has been called.
+         *
+         * @param {string} userId
+         * @throws {Error} If userId argument is not supplied.
+         */
+        this.identifyAuthenticatedUser = jest.fn((userId) => {
+            if (!userId) {
+                throw new Error('UserId is required for identifyAuthenticatedUser.');
+            }
+            this.hasIdentifyBeenCalled = true;
+        });
+        /**
+         * No-op, but records that it has been called to prevent double-identification.
+         * @returns {Promise} A resolved promise.
+         */
+        this.identifyAnonymousUser = jest.fn(() => {
+            this.hasIdentifyBeenCalled = true;
+            return Promise.resolve();
+        });
+        /**
+         * Logs the event to the console.
+         *
+         * Checks whether identify has been called, logging an error to the logging service if not.
+         */
+        this.sendTrackEvent = jest.fn(() => {
+            this.checkIdentifyCalled();
+        });
+        /**
+         * Logs the event to the console.
+         *
+         * Checks whether identify has been called, logging an error to the logging service if not.
+         */
+        this.sendPageEvent = jest.fn(() => {
+            this.checkIdentifyCalled();
+        });
+        this.loggingService = loggingService;
+        this.httpClient = httpClient;
+    }
+}
+MockAnalyticsService.hasIdentifyBeenCalled = false;
+export default MockAnalyticsService;
+//# sourceMappingURL=MockAnalyticsService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"MockAnalyticsService.js","sourceRoot":"","sources":["../../../runtime/analytics/MockAnalyticsService.js"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,oBAAoB;IAGxB,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE;QAK1C,wBAAmB,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE;YACjC,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAChC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,uDAAuD,CAAC,CAAC;YACxF,CAAC;QACH,CAAC,CAAC,CAAC;QAEH;;;;WAIG;QACH,yBAAoB,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;QAExD;;;;;WAKG;QACH,8BAAyB,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE;YAC7C,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;YACvE,CAAC;YACD,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH;;;WAGG;QACH,0BAAqB,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE;YACnC,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;YAClC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH;;;;WAIG;QACH,mBAAc,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE;YAC5B,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH;;;;WAIG;QACH,kBAAa,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE;YAC3B,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC7B,CAAC,CAAC,CAAC;QAvDD,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;;AALM,0CAAqB,GAAG,KAAK,AAAR,CAAS;AA6DvC,eAAe,oBAAoB,CAAC","sourcesContent":["/**\n * The MockAnalyticsService implements all functions of AnalyticsService as Jest mocks (jest.fn())).\n * It emulates the behavior of a real analytics service but witohut making any requests. It has no\n * other functionality.\n *\n * @implements {AnalyticsService}\n * @memberof module:Analytics\n */\nclass MockAnalyticsService {\n  static hasIdentifyBeenCalled = false;\n\n  constructor({ httpClient, loggingService }) {\n    this.loggingService = loggingService;\n    this.httpClient = httpClient;\n  }\n\n  checkIdentifyCalled = jest.fn(() => {\n    if (!this.hasIdentifyBeenCalled) {\n      this.loggingService.logError('Identify must be called before other tracking events.');\n    }\n  });\n\n  /**\n   * Returns a resolved promise.\n   *\n   * @returns {Promise} The promise returned by HttpClient.post.\n   */\n  sendTrackingLogEvent = jest.fn(() => Promise.resolve());\n\n  /**\n   * No-op, but records that identify has been called.\n   *\n   * @param {string} userId\n   * @throws {Error} If userId argument is not supplied.\n   */\n  identifyAuthenticatedUser = jest.fn((userId) => {\n    if (!userId) {\n      throw new Error('UserId is required for identifyAuthenticatedUser.');\n    }\n    this.hasIdentifyBeenCalled = true;\n  });\n\n  /**\n   * No-op, but records that it has been called to prevent double-identification.\n   * @returns {Promise} A resolved promise.\n   */\n  identifyAnonymousUser = jest.fn(() => {\n    this.hasIdentifyBeenCalled = true;\n    return Promise.resolve();\n  });\n\n  /**\n   * Logs the event to the console.\n   *\n   * Checks whether identify has been called, logging an error to the logging service if not.\n   */\n  sendTrackEvent = jest.fn(() => {\n    this.checkIdentifyCalled();\n  });\n\n  /**\n   * Logs the event to the console.\n   *\n   * Checks whether identify has been called, logging an error to the logging service if not.\n   */\n  sendPageEvent = jest.fn(() => {\n    this.checkIdentifyCalled();\n  });\n}\n\nexport default MockAnalyticsService;\n"]}

package/dist/runtime/analytics/SegmentAnalyticsService.d.ts

@@ -0,0 +1,64 @@
+export default SegmentAnalyticsService;
+/**
+ * @implements {AnalyticsService}
+ * @memberof module:Analytics
+ */
+declare class SegmentAnalyticsService implements AnalyticsService {
+    constructor({ httpClient, loggingService, config }: {
+        httpClient: any;
+        loggingService: any;
+        config: any;
+    });
+    loggingService: any;
+    httpClient: any;
+    trackingLogApiUrl: string;
+    segmentKey: any;
+    hasIdentifyBeenCalled: boolean;
+    segmentInitialized: boolean;
+    initializeSegment(): void;
+    /**
+     * Checks that identify was first called.  Otherwise, logs error.
+     *
+     */
+    checkIdentifyCalled(): void;
+    /**
+     * Logs events to tracking log and downstream.
+     * For tracking log event documentation, see
+     * https://openedx.atlassian.net/wiki/spaces/AN/pages/13205895/Event+Design+and+Review+Process
+     *
+     * @param {string} eventName (event_type on backend, but named to match Segment api)
+     * @param {Object} properties (event on backend, but named properties to match Segment api)
+     * @returns {Promise} The promise returned by HttpClient.post.
+     */
+    sendTrackingLogEvent(eventName: string, properties: any): Promise<any>;
+    /**
+     * * Send identify call to Segment.
+     *
+     * @param {string} userId
+     * @param {*} [traits]
+     */
+    identifyAuthenticatedUser(userId: string, traits?: any): void;
+    /**
+     * Send anonymous identify call to Segment's identify.
+     *
+     * @param {*} [traits]
+     * @returns {Promise} Promise that will resolve once the document readyState is complete
+     */
+    identifyAnonymousUser(traits?: any): Promise<any>;
+    /**
+     * Sends a track event to Segment and downstream.
+     * Note: For links and forms, you should use trackLink and trackForm instead.
+     *
+     * @param {*} eventName
+     * @param {*} [properties]
+     */
+    sendTrackEvent(eventName: any, properties?: any): void;
+    /**
+     * Sends a page event to Segment and downstream.
+     *
+     * @param {*} [name] If only one string arg provided, assumed to be name.
+     * @param {*} [category] Name is required to pass a category.
+     * @param {*} [properties]
+     */
+    sendPageEvent(category?: any, name?: any, properties?: any): void;
+}

package/dist/runtime/analytics/SegmentAnalyticsService.js

@@ -0,0 +1,218 @@
+import formurlencoded from 'form-urlencoded';
+import { snakeCaseObject } from '../utils';
+/**
+ * @implements {AnalyticsService}
+ * @memberof module:Analytics
+ */
+class SegmentAnalyticsService {
+    constructor({ httpClient, loggingService, config }) {
+        this.loggingService = loggingService;
+        this.httpClient = httpClient;
+        this.trackingLogApiUrl = `${config.lmsBaseUrl}/event`;
+        this.segmentKey = config.segmentKey;
+        this.hasIdentifyBeenCalled = false;
+        this.segmentInitialized = false;
+        if (this.segmentKey) {
+            this.initializeSegment();
+        }
+    }
+    // The code in this function is from Segment's website, with a few updates:
+    // - It uses the segmentKey from the SegmentAnalyticsService instance.
+    // - It also saves a "segmentInitialized" variable on the SegmentAnalyticsService instance so
+    //   that the service can keep track of its own initialization state.
+    // Reference:
+    // https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/quickstart/
+    initializeSegment() {
+        // Create a queue, but don't obliterate an existing one!
+        global.analytics = global.analytics || [];
+        const { analytics } = global;
+        // If the real analytics.js is already on the page return.
+        if (analytics.initialize) {
+            this.segmentInitialized = true;
+            return;
+        }
+        // If the snippet was invoked do nothing.
+        if (analytics.invoked) {
+            this.segmentInitialized = true;
+            return;
+        }
+        // Invoked flag, to make sure the snippet
+        // is never invoked twice.
+        analytics.invoked = true;
+        // A list of the methods in Analytics.js to stub.
+        analytics.methods = [
+            'trackSubmit',
+            'trackClick',
+            'trackLink',
+            'trackForm',
+            'pageview',
+            'identify',
+            'reset',
+            'group',
+            'track',
+            'ready',
+            'alias',
+            'debug',
+            'page',
+            'once',
+            'off',
+            'on',
+        ];
+        // Define a factory to create stubs. These are placeholders
+        // for methods in Analytics.js so that you never have to wait
+        // for it to load to actually record data. The `method` is
+        // stored as the first argument, so we can replay the data.
+        analytics.factory = method => (...args) => {
+            args.unshift(method);
+            analytics.push(args);
+            return analytics;
+        };
+        // For each of our methods, generate a queueing stub.
+        analytics.methods.forEach((key) => {
+            analytics[key] = analytics.factory(key);
+        });
+        // Define a method to load Analytics.js from our CDN,
+        // and that will be sure to only ever load it once.
+        analytics.load = (key, options) => {
+            // Create an async script element based on your key.
+            const script = document.createElement('script');
+            script.type = 'text/javascript';
+            script.onerror = () => {
+                this.segmentInitialized = false;
+                const event = new Event('segmentFailed');
+                document.dispatchEvent(event);
+            };
+            script.async = true;
+            script.src = `https://cdn.segment.com/analytics.js/v1/${key}/analytics.min.js`;
+            // Insert our script next to the first script element.
+            const first = document.getElementsByTagName('script')[0];
+            first.parentNode.insertBefore(script, first);
+            analytics._loadOptions = options;
+            this.segmentInitialized = true;
+        };
+        // Add a version to keep track of what's in the wild.
+        analytics.SNIPPET_VERSION = '4.1.0';
+        // Load Analytics.js with your key, which will automatically
+        // load the tools you've enabled for your account. Boosh!
+        analytics.load(this.segmentKey);
+    }
+    /**
+     * Checks that identify was first called.  Otherwise, logs error.
+     *
+     */
+    checkIdentifyCalled() {
+        if (!this.hasIdentifyBeenCalled) {
+            this.loggingService.logError('Identify must be called before other tracking events.');
+        }
+    }
+    /**
+     * Logs events to tracking log and downstream.
+     * For tracking log event documentation, see
+     * https://openedx.atlassian.net/wiki/spaces/AN/pages/13205895/Event+Design+and+Review+Process
+     *
+     * @param {string} eventName (event_type on backend, but named to match Segment api)
+     * @param {Object} properties (event on backend, but named properties to match Segment api)
+     * @returns {Promise} The promise returned by HttpClient.post.
+     */
+    sendTrackingLogEvent(eventName, properties) {
+        const snakeEventData = snakeCaseObject(properties, { deep: true });
+        const serverData = {
+            event_type: eventName,
+            event: JSON.stringify(snakeEventData),
+            page: global.location.href,
+        };
+        return this.httpClient.post(this.trackingLogApiUrl, formurlencoded(serverData), {
+            headers: {
+                'Content-Type': 'application/x-www-form-urlencoded',
+            },
+        }).catch((error) => {
+            this.loggingService.logError(error);
+        });
+    }
+    /**
+     * * Send identify call to Segment.
+     *
+     * @param {string} userId
+     * @param {*} [traits]
+     */
+    identifyAuthenticatedUser(userId, traits) {
+        if (!userId) {
+            throw new Error('UserId is required for identifyAuthenticatedUser.');
+        }
+        if (!this.segmentInitialized) {
+            return;
+        }
+        global.analytics.identify(userId, traits);
+        this.hasIdentifyBeenCalled = true;
+    }
+    /**
+     * Send anonymous identify call to Segment's identify.
+     *
+     * @param {*} [traits]
+     * @returns {Promise} Promise that will resolve once the document readyState is complete
+     */
+    identifyAnonymousUser(traits) {
+        if (!this.segmentInitialized) {
+            return Promise.resolve();
+        }
+        // if we do not have an authenticated user (indicated by being in this method),
+        // but we still have a user id associated in segment, reset the local segment state
+        // This has to be wrapped in the analytics.ready() callback because the analytics.user()
+        // function isn't available until the analytics.js package has finished initializing.
+        return new Promise((resolve, reject) => {
+            global.analytics.ready(() => {
+                if (global.analytics.user().id()) {
+                    global.analytics.reset();
+                }
+                // We don’t need to call `identify` for anonymous users and can just make the value of
+                // hasIdentifyBeenCalled true. Segment automatically assigns them an anonymousId, so
+                // just calling `page` and `track` works fine without identify.
+                this.hasIdentifyBeenCalled = true;
+                resolve();
+            });
+            // this is added to handle a specific use-case where if a user has blocked the analytics
+            // tools in their browser, this promise does not get resolved and user sees a blank
+            // page. Dispatching this event in script.onerror callback in analytics.load.
+            document.addEventListener('segmentFailed', resolve);
+            // This is added to handle the google analytics blocked case which is injected into
+            // the DOM by segment.min.js.
+            setTimeout(() => {
+                var _a;
+                if (!((_a = global.ga) === null || _a === void 0 ? void 0 : _a.create) || !global.google_tag_manager) {
+                    this.segmentInitialized = false;
+                    resolve();
+                }
+            }, 2000);
+        });
+    }
+    /**
+     * Sends a track event to Segment and downstream.
+     * Note: For links and forms, you should use trackLink and trackForm instead.
+     *
+     * @param {*} eventName
+     * @param {*} [properties]
+     */
+    sendTrackEvent(eventName, properties) {
+        if (!this.segmentInitialized) {
+            return;
+        }
+        this.checkIdentifyCalled();
+        global.analytics.track(eventName, properties);
+    }
+    /**
+     * Sends a page event to Segment and downstream.
+     *
+     * @param {*} [name] If only one string arg provided, assumed to be name.
+     * @param {*} [category] Name is required to pass a category.
+     * @param {*} [properties]
+     */
+    sendPageEvent(category, name, properties) {
+        if (!this.segmentInitialized) {
+            return;
+        }
+        this.checkIdentifyCalled();
+        global.analytics.page(category, name, properties);
+    }
+}
+export default SegmentAnalyticsService;
+//# sourceMappingURL=SegmentAnalyticsService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SegmentAnalyticsService.js","sourceRoot":"","sources":["../../../runtime/analytics/SegmentAnalyticsService.js"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C;;;GAGG;AACH,MAAM,uBAAuB;IAC3B,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE;QAChD,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,iBAAiB,GAAG,GAAG,MAAM,CAAC,UAAU,QAAQ,CAAC;QACtD,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QACpC,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC;QACnC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;QAEhC,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,2EAA2E;IAC3E,sEAAsE;IACtE,6FAA6F;IAC7F,qEAAqE;IACrE,aAAa;IACb,gGAAgG;IAChG,iBAAiB;QACf,wDAAwD;QACxD,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,EAAE,CAAC;QAC1C,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAE7B,0DAA0D;QAC1D,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;YACzB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;YAC/B,OAAO;QACT,CAAC;QAED,yCAAyC;QACzC,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;YACtB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;YAC/B,OAAO;QACT,CAAC;QAED,yCAAyC;QACzC,0BAA0B;QAC1B,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC;QAEzB,iDAAiD;QACjD,SAAS,CAAC,OAAO,GAAG;YAClB,aAAa;YACb,YAAY;YACZ,WAAW;YACX,WAAW;YACX,UAAU;YACV,UAAU;YACV,OAAO;YACP,OAAO;YACP,OAAO;YACP,OAAO;YACP,OAAO;YACP,OAAO;YACP,MAAM;YACN,MAAM;YACN,KAAK;YACL,IAAI;SACL,CAAC;QAEF,2DAA2D;QAC3D,6DAA6D;QAC7D,0DAA0D;QAC1D,2DAA2D;QAC3D,SAAS,CAAC,OAAO,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,EAAE,EAAE;YACxC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACrB,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrB,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC;QAEF,qDAAqD;QACrD,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YAChC,SAAS,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,qDAAqD;QACrD,mDAAmD;QACnD,SAAS,CAAC,IAAI,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;YAChC,oDAAoD;YACpD,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAChD,MAAM,CAAC,IAAI,GAAG,iBAAiB,CAAC;YAChC,MAAM,CAAC,OAAO,GAAG,GAAG,EAAE;gBACpB,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;gBAChC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;gBACzC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAChC,CAAC,CAAC;YACF,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC;YACpB,MAAM,CAAC,GAAG,GAAG,2CAA2C,GAAG,mBAAmB,CAAC;YAE/E,sDAAsD;YACtD,MAAM,KAAK,GAAG,QAAQ,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;YACzD,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YAC7C,SAAS,CAAC,YAAY,GAAG,OAAO,CAAC;YAEjC,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;QACjC,CAAC,CAAC;QAEF,qDAAqD;QACrD,SAAS,CAAC,eAAe,GAAG,OAAO,CAAC;QAEpC,4DAA4D;QAC5D,yDAAyD;QACzD,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,mBAAmB;QACjB,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAChC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,uDAAuD,CAAC,CAAC;QACxF,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,oBAAoB,CAAC,SAAS,EAAE,UAAU;QACxC,MAAM,cAAc,GAAG,eAAe,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG;YACjB,UAAU,EAAE,SAAS;YACrB,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC;YACrC,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI;SAC3B,CAAC;QACF,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CACzB,IAAI,CAAC,iBAAiB,EACtB,cAAc,CAAC,UAAU,CAAC,EAC1B;YACE,OAAO,EAAE;gBACP,cAAc,EAAE,mCAAmC;aACpD;SACF,CACF,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YAChB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,yBAAyB,CAAC,MAAM,EAAE,MAAM;QACtC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QACD,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC1C,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACH,qBAAqB,CAAC,MAAM;QAC1B,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC;QACD,+EAA+E;QAC/E,mFAAmF;QACnF,wFAAwF;QACxF,qFAAqF;QACrF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE;gBAC1B,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;oBACjC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;gBAC3B,CAAC;gBACD,sFAAsF;gBACtF,oFAAoF;gBACpF,+DAA+D;gBAC/D,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;gBAClC,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;YAEH,wFAAwF;YACxF,mFAAmF;YACnF,6EAA6E;YAC7E,QAAQ,CAAC,gBAAgB,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YACpD,mFAAmF;YACnF,6BAA6B;YAC7B,UAAU,CAAC,GAAG,EAAE;;gBACd,IAAI,CAAC,CAAA,MAAA,MAAM,CAAC,EAAE,0CAAE,MAAM,CAAA,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC;oBACrD,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;oBAChC,OAAO,EAAE,CAAC;gBACZ,CAAC;YACH,CAAC,EAAE,IAAI,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,cAAc,CAAC,SAAS,EAAE,UAAU;QAClC,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QACD,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,QAAQ,EAAE,IAAI,EAAE,UAAU;QACtC,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QACD,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;CACF;AAED,eAAe,uBAAuB,CAAC","sourcesContent":["import formurlencoded from 'form-urlencoded';\nimport { snakeCaseObject } from '../utils';\n\n/**\n * @implements {AnalyticsService}\n * @memberof module:Analytics\n */\nclass SegmentAnalyticsService {\n  constructor({ httpClient, loggingService, config }) {\n    this.loggingService = loggingService;\n    this.httpClient = httpClient;\n    this.trackingLogApiUrl = `${config.lmsBaseUrl}/event`;\n    this.segmentKey = config.segmentKey;\n    this.hasIdentifyBeenCalled = false;\n    this.segmentInitialized = false;\n\n    if (this.segmentKey) {\n      this.initializeSegment();\n    }\n  }\n\n  // The code in this function is from Segment's website, with a few updates:\n  // - It uses the segmentKey from the SegmentAnalyticsService instance.\n  // - It also saves a \"segmentInitialized\" variable on the SegmentAnalyticsService instance so\n  //   that the service can keep track of its own initialization state.\n  // Reference:\n  // https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/quickstart/\n  initializeSegment() {\n    // Create a queue, but don't obliterate an existing one!\n    global.analytics = global.analytics || [];\n    const { analytics } = global;\n\n    // If the real analytics.js is already on the page return.\n    if (analytics.initialize) {\n      this.segmentInitialized = true;\n      return;\n    }\n\n    // If the snippet was invoked do nothing.\n    if (analytics.invoked) {\n      this.segmentInitialized = true;\n      return;\n    }\n\n    // Invoked flag, to make sure the snippet\n    // is never invoked twice.\n    analytics.invoked = true;\n\n    // A list of the methods in Analytics.js to stub.\n    analytics.methods = [\n      'trackSubmit',\n      'trackClick',\n      'trackLink',\n      'trackForm',\n      'pageview',\n      'identify',\n      'reset',\n      'group',\n      'track',\n      'ready',\n      'alias',\n      'debug',\n      'page',\n      'once',\n      'off',\n      'on',\n    ];\n\n    // Define a factory to create stubs. These are placeholders\n    // for methods in Analytics.js so that you never have to wait\n    // for it to load to actually record data. The `method` is\n    // stored as the first argument, so we can replay the data.\n    analytics.factory = method => (...args) => {\n      args.unshift(method);\n      analytics.push(args);\n      return analytics;\n    };\n\n    // For each of our methods, generate a queueing stub.\n    analytics.methods.forEach((key) => {\n      analytics[key] = analytics.factory(key);\n    });\n\n    // Define a method to load Analytics.js from our CDN,\n    // and that will be sure to only ever load it once.\n    analytics.load = (key, options) => {\n      // Create an async script element based on your key.\n      const script = document.createElement('script');\n      script.type = 'text/javascript';\n      script.onerror = () => {\n        this.segmentInitialized = false;\n        const event = new Event('segmentFailed');\n        document.dispatchEvent(event);\n      };\n      script.async = true;\n      script.src = `https://cdn.segment.com/analytics.js/v1/${key}/analytics.min.js`;\n\n      // Insert our script next to the first script element.\n      const first = document.getElementsByTagName('script')[0];\n      first.parentNode.insertBefore(script, first);\n      analytics._loadOptions = options;\n\n      this.segmentInitialized = true;\n    };\n\n    // Add a version to keep track of what's in the wild.\n    analytics.SNIPPET_VERSION = '4.1.0';\n\n    // Load Analytics.js with your key, which will automatically\n    // load the tools you've enabled for your account. Boosh!\n    analytics.load(this.segmentKey);\n  }\n\n  /**\n   * Checks that identify was first called.  Otherwise, logs error.\n   *\n   */\n  checkIdentifyCalled() {\n    if (!this.hasIdentifyBeenCalled) {\n      this.loggingService.logError('Identify must be called before other tracking events.');\n    }\n  }\n\n  /**\n   * Logs events to tracking log and downstream.\n   * For tracking log event documentation, see\n   * https://openedx.atlassian.net/wiki/spaces/AN/pages/13205895/Event+Design+and+Review+Process\n   *\n   * @param {string} eventName (event_type on backend, but named to match Segment api)\n   * @param {Object} properties (event on backend, but named properties to match Segment api)\n   * @returns {Promise} The promise returned by HttpClient.post.\n   */\n  sendTrackingLogEvent(eventName, properties) {\n    const snakeEventData = snakeCaseObject(properties, { deep: true });\n    const serverData = {\n      event_type: eventName,\n      event: JSON.stringify(snakeEventData),\n      page: global.location.href,\n    };\n    return this.httpClient.post(\n      this.trackingLogApiUrl,\n      formurlencoded(serverData),\n      {\n        headers: {\n          'Content-Type': 'application/x-www-form-urlencoded',\n        },\n      },\n    ).catch((error) => {\n      this.loggingService.logError(error);\n    });\n  }\n\n  /**\n   * * Send identify call to Segment.\n   *\n   * @param {string} userId\n   * @param {*} [traits]\n   */\n  identifyAuthenticatedUser(userId, traits) {\n    if (!userId) {\n      throw new Error('UserId is required for identifyAuthenticatedUser.');\n    }\n\n    if (!this.segmentInitialized) {\n      return;\n    }\n    global.analytics.identify(userId, traits);\n    this.hasIdentifyBeenCalled = true;\n  }\n\n  /**\n   * Send anonymous identify call to Segment's identify.\n   *\n   * @param {*} [traits]\n   * @returns {Promise} Promise that will resolve once the document readyState is complete\n   */\n  identifyAnonymousUser(traits) { // eslint-disable-line @typescript-eslint/no-unused-vars\n    if (!this.segmentInitialized) {\n      return Promise.resolve();\n    }\n    // if we do not have an authenticated user (indicated by being in this method),\n    // but we still have a user id associated in segment, reset the local segment state\n    // This has to be wrapped in the analytics.ready() callback because the analytics.user()\n    // function isn't available until the analytics.js package has finished initializing.\n    return new Promise((resolve, reject) => { // eslint-disable-line @typescript-eslint/no-unused-vars\n      global.analytics.ready(() => {\n        if (global.analytics.user().id()) {\n          global.analytics.reset();\n        }\n        // We don’t need to call `identify` for anonymous users and can just make the value of\n        // hasIdentifyBeenCalled true. Segment automatically assigns them an anonymousId, so\n        // just calling `page` and `track` works fine without identify.\n        this.hasIdentifyBeenCalled = true;\n        resolve();\n      });\n\n      // this is added to handle a specific use-case where if a user has blocked the analytics\n      // tools in their browser, this promise does not get resolved and user sees a blank\n      // page. Dispatching this event in script.onerror callback in analytics.load.\n      document.addEventListener('segmentFailed', resolve);\n      // This is added to handle the google analytics blocked case which is injected into\n      // the DOM by segment.min.js.\n      setTimeout(() => {\n        if (!global.ga?.create || !global.google_tag_manager) {\n          this.segmentInitialized = false;\n          resolve();\n        }\n      }, 2000);\n    });\n  }\n\n  /**\n   * Sends a track event to Segment and downstream.\n   * Note: For links and forms, you should use trackLink and trackForm instead.\n   *\n   * @param {*} eventName\n   * @param {*} [properties]\n   */\n  sendTrackEvent(eventName, properties) {\n    if (!this.segmentInitialized) {\n      return;\n    }\n    this.checkIdentifyCalled();\n    global.analytics.track(eventName, properties);\n  }\n\n  /**\n   * Sends a page event to Segment and downstream.\n   *\n   * @param {*} [name] If only one string arg provided, assumed to be name.\n   * @param {*} [category] Name is required to pass a category.\n   * @param {*} [properties]\n   */\n  sendPageEvent(category, name, properties) {\n    if (!this.segmentInitialized) {\n      return;\n    }\n    this.checkIdentifyCalled();\n    global.analytics.page(category, name, properties);\n  }\n}\n\nexport default SegmentAnalyticsService;\n"]}

package/dist/runtime/analytics/index.d.ts

@@ -0,0 +1,3 @@
+export { configureAnalytics, getAnalyticsService, identifyAnonymousUser, identifyAuthenticatedUser, resetAnalyticsService, sendPageEvent, sendTrackEvent, sendTrackingLogEvent } from './interface';
+export { default as MockAnalyticsService } from './MockAnalyticsService';
+export { default as SegmentAnalyticsService } from './SegmentAnalyticsService';

package/dist/runtime/analytics/index.js

@@ -0,0 +1,4 @@
+export { configureAnalytics, getAnalyticsService, identifyAnonymousUser, identifyAuthenticatedUser, resetAnalyticsService, sendPageEvent, sendTrackEvent, sendTrackingLogEvent } from './interface';
+export { default as MockAnalyticsService } from './MockAnalyticsService';
+export { default as SegmentAnalyticsService } from './SegmentAnalyticsService';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../runtime/analytics/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EACzB,qBAAqB,EACrB,aAAa,EACb,cAAc,EACd,oBAAoB,EACrB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACzE,OAAO,EAAE,OAAO,IAAI,uBAAuB,EAAE,MAAM,2BAA2B,CAAC","sourcesContent":["export {\n  configureAnalytics,\n  getAnalyticsService,\n  identifyAnonymousUser,\n  identifyAuthenticatedUser,\n  resetAnalyticsService,\n  sendPageEvent,\n  sendTrackEvent,\n  sendTrackingLogEvent\n} from './interface';\nexport { default as MockAnalyticsService } from './MockAnalyticsService';\nexport { default as SegmentAnalyticsService } from './SegmentAnalyticsService';\n"]}

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

@@ -0,0 +1,53 @@
+/**
+ *
+ * @param {class} AnalyticsService
+ * @param {*} options
+ * @returns {AnalyticsService}
+ */
+export function configureAnalytics(AnalyticsService: class, options: any): class;
+/**
+ *
+ * @param {*} eventName
+ * @param {*} properties
+ * @returns {Promise}
+ */
+export function sendTrackingLogEvent(eventName: any, properties: any): Promise<any>;
+/**
+ *
+ *
+ * @param {*} userId
+ * @param {*} traits
+ */
+export function identifyAuthenticatedUser(userId: any, traits: any): void;
+/**
+ *
+ *
+ * @param {*} traits
+ * @returns {Promise}
+ */
+export function identifyAnonymousUser(traits: any): Promise<any>;
+/**
+ *
+ *
+ * @param {*} eventName
+ * @param {*} properties
+ */
+export function sendTrackEvent(eventName: any, properties: any): void;
+/**
+ *
+ *
+ * @param {*} category
+ * @param {*} name
+ * @param {*} properties
+ */
+export function sendPageEvent(category: any, name: any, properties: any): void;
+/**
+ *
+ *
+ * @returns {AnalyticsService}
+ */
+export function getAnalyticsService(): AnalyticsService;
+/**
+ *
+ */
+export function resetAnalyticsService(): void;