npm - @openedx/frontend-base - Versions diffs - 1.0.0-alpha.4 → 1.0.0-alpha.41 - Mend

@openedx/frontend-base 1.0.0-alpha.4 → 1.0.0-alpha.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (813) hide show

package/config/webpack/plugins/paragon-webpack-plugin/utils/stylesheetUtils.js DELETED Viewed

@@ -1,126 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.findStylesheetInsertionPoint = findStylesheetInsertionPoint;
-exports.insertStylesheetsIntoDocument = insertStylesheetsIntoDocument;
-const parse5 = __importStar(require("parse5"));
-const webpack_1 = require("webpack");
-const tagUtils_1 = require("./tagUtils");
-/**
- * Finds the insertion point for a stylesheet in an HTML document.
- *
- * @param {Object} options - The options object.
- * @param {Object} options.document - The parsed HTML document.
- * @param {string} options.source - The original source code of the HTML document.
- * @throws {Error} If the head element is missing in the HTML document.
- * @return {number} The insertion point for the stylesheet in the HTML document.
- */
-function findStylesheetInsertionPoint({ document, source }) {
-    const headElement = (0, tagUtils_1.getDescendantByTag)(document, 'head');
-    if (!headElement) {
-        throw new Error('Missing head element in index.html.');
-    }
-    // determine script insertion point
-    if (headElement.sourceCodeLocation?.startTag) {
-        return headElement.sourceCodeLocation.startTag.endOffset;
-    }
-    // less accurate fallback
-    const headTagString = '<head>';
-    const headTagIndex = source.indexOf(headTagString);
-    return headTagIndex + headTagString.length;
-}
-/**
- * Inserts stylesheets into an HTML document.
- *
- * @param {object} options - The options for inserting stylesheets.
- * @param {string} options.source - The HTML source code.
- * @param {object} options.urls - The URLs of the stylesheets to be inserted.
- * @param {string} options.urls.default - The URL of the default stylesheet.
- * @param {string} options.urls.brandOverride - The URL of the brand override stylesheet.
- * @return {object|undefined} The new source code with the stylesheets inserted.
- */
-function insertStylesheetsIntoDocument({ source, urls, }) {
-    // parse file as html document
-    const document = parse5.parse(source, {
-        sourceCodeLocationInfo: true,
-    });
-    if (!(0, tagUtils_1.getDescendantByTag)(document, 'head')) {
-        return undefined;
-    }
-    const newSource = new webpack_1.sources.ReplaceSource(new webpack_1.sources.RawSource(source), 'index.html');
-    // insert the brand overrides styles into the HTML document
-    const stylesheetInsertionPoint = findStylesheetInsertionPoint({
-        // @ts-expect-error Typescript complains this document instance is missing properties.  Is parse5.parse not returning a valid Document instance?
-        document,
-        // @ts-expect-error We're passing a ReplaceSource here, when we expect a string in the function.
-        source: newSource,
-    });
-    /**
-     * Creates a new stylesheet link element.
-     *
-     * @param {string} url - The URL of the stylesheet.
-     * @return {string} The HTML code for the stylesheet link element.
-     */
-    function createNewStylesheet(url) {
-        const baseLink = `<link
-      type="text/css"
-      rel="preload"
-      as="style"
-      href="${url}"
-      onload="this.rel='stylesheet';"
-      onerror="this.remove();"
-    />`;
-        return baseLink;
-    }
-    if (urls.default) {
-        // @ts-expect-error getDescendantByTag requires two parameters.
-        const existingDefaultLink = (0, tagUtils_1.getDescendantByTag)(`link[href='${urls.default}']`);
-        if (!existingDefaultLink) {
-            // create link to inject into the HTML document
-            const stylesheetLink = createNewStylesheet(urls.default);
-            newSource.insert(stylesheetInsertionPoint, stylesheetLink);
-        }
-    }
-    if (urls.brandOverride) {
-        // @ts-expect-error getDescendantByTag requires two parameters.
-        const existingBrandLink = (0, tagUtils_1.getDescendantByTag)(`link[href='${urls.brandOverride}']`);
-        if (!existingBrandLink) {
-            // create link to inject into the HTML document
-            const stylesheetLink = createNewStylesheet(urls.brandOverride);
-            newSource.insert(stylesheetInsertionPoint, stylesheetLink);
-        }
-    }
-    return newSource;
-}

package/config/webpack/plugins/paragon-webpack-plugin/utils/tagUtils.js DELETED Viewed

@@ -1,57 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDescendantByTag = getDescendantByTag;
-exports.handleVersionSubstitution = handleVersionSubstitution;
-exports.minifyScript = minifyScript;
-/**
- * Recursively searches for a descendant node with the specified tag name.
- *
- * @param {Object} node - The root node to start the search from.
- * @param {string} tag - The tag name to search for.
- * @return {Object|null} The first descendant node with the specified tag name, or null if not found.
- */
-function getDescendantByTag(node, tag) {
-    for (let i = 0; i < node.childNodes?.length; i++) {
-        if (node.childNodes[i].tagName === tag) {
-            return node.childNodes[i];
-        }
-        const result = getDescendantByTag(node.childNodes[i], tag);
-        if (result) {
-            return result;
-        }
-    }
-    return null;
-}
-/**
- * Replaces a wildcard keyword in a URL with a local version.
- *
- * @param {Object} options - The options object.
- * @param {string} options.url - The URL to substitute the keyword in.
- * @param {string} options.wildcardKeyword - The wildcard keyword to replace.
- * @param {string} options.localVersion - The local version to substitute the keyword with.
- * @return {string} The URL with the wildcard keyword substituted with the local version,
- *                 or the original URL if no substitution is needed.
- */
-function handleVersionSubstitution({ url, wildcardKeyword, localVersion }) {
-    if (!url || !url.includes(wildcardKeyword) || !localVersion) {
-        return url;
-    }
-    return url.replaceAll(wildcardKeyword, localVersion);
-}
-/**
- * Minifies a script by removing unnecessary whitespace and line breaks.
- *
- * @param {string} script - The script to be minified.
- * @return {string} The minified script.
- */
-function minifyScript(script) {
-    return script
-        .replace(/>[\r\n ]+</g, '><')
-        .replace(/(<.*?>)|\s+/g, (m, $1) => {
-        if ($1) {
-            return $1;
-        }
-        return ' ';
-    })
-        .trim();
-}

package/config/webpack/utils/getLocalAliases.js DELETED Viewed

@@ -1,65 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = getLocalAliases;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-/*
-This function reads in a 'module.config.js' file if it exists and uses its contents to define
-a set of webpack resolve.alias aliases for doing local development of application dependencies.
-It reads the package.json file of the dependency to determine if it has any peer dependencies, and
-then forces those peer dependencies to be resolved with the application's version.  Primarily, this
-is useful for making sure there's only one version of those dependencies loaded at once, which is a
-problem with both react and react-intl.
-The module.config.js file should have the form:
-{
-  localModules: [
-    { moduleName: 'nameOfPackage', dir: '../path/to/repo', dist: '/path/to/dist/in/repo' },
-    ... others...
-  ],
-}
-Some working examples, as of the time of this writing:
-{ moduleName: '@openedx/paragon/scss', dir: '../paragon', dist: 'scss' }
-{ moduleName: '@openedx/paragon', dir: '../paragon', dist: 'dist' }
-{ moduleName: '@openedx/frontend-base', dir: '../frontend-base', dist: 'dist' }
-*/
-function getLocalAliases() {
-    const aliases = {};
-    try {
-        const moduleConfigPath = path_1.default.resolve(process.cwd(), 'module.config.js');
-        if (!fs_1.default.existsSync(moduleConfigPath)) {
-            console.log('No local module configuration file found. This is fine.\n');
-            return aliases;
-        }
-        const { localModules } = require(moduleConfigPath);
-        let allPeerDependencies = [];
-        const excludedPeerPackages = [];
-        if (localModules.length > 0) {
-            console.info('Resolving modules from local directories via module.config.js.');
-        }
-        localModules.forEach(({ moduleName, dir, dist = '' }) => {
-            console.info(`Using local version of ${moduleName} from ${dir}/${dist}.`);
-            const { peerDependencies = {}, name } = require(path_1.default.resolve(process.cwd(), dir, 'package.json'));
-            allPeerDependencies = allPeerDependencies.concat(Object.keys(peerDependencies));
-            aliases[moduleName] = path_1.default.resolve(process.cwd(), dir, dist);
-            excludedPeerPackages.push(name);
-        });
-        allPeerDependencies = allPeerDependencies.filter((dep) => !excludedPeerPackages.includes(dep));
-        allPeerDependencies.forEach((dep) => {
-            aliases[dep] = path_1.default.resolve(process.cwd(), 'node_modules', dep);
-        });
-    }
-    catch (e) {
-        console.error(e);
-        console.error('Error in module.config.js parsing. module.config.js will be ignored.');
-        return {};
-    }
-    return aliases;
-}

package/config/webpack/utils/getPublicPath.js DELETED Viewed

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = getPublicPath;
-function getPublicPath(defaultPath = 'auto') {
-    return process.env.PUBLIC_PATH ?? defaultPath;
-}

package/config/webpack/utils/paragonUtils.js DELETED Viewed

@@ -1,138 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getParagonVersion = getParagonVersion;
-exports.getParagonThemeCss = getParagonThemeCss;
-exports.getParagonCacheGroups = getParagonCacheGroups;
-exports.getParagonEntryPoints = getParagonEntryPoints;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-/**
- * Retrieves the name of the brand package from the given directory.
- *
- * @param {string} dir - The directory path containing the package.json file.
- * @return {string} The name of the brand package, or an empty string if not found.
- */
-function getBrandPackageName(dir) {
-    const appDependencies = JSON.parse(fs_1.default.readFileSync(path_1.default.resolve(dir, 'package.json'), 'utf-8')).dependencies;
-    return Object.keys(appDependencies).find((key) => /@(open)?edx\/brand/.exec(key)) ?? '';
-}
-/**
- * Attempts to extract the Paragon version from the `node_modules` of
- * the consuming application.
- *
- * @param {string} dir Path to directory containing `node_modules`.
- * @returns {string} Paragon dependency version of the consuming application
- */
-function getParagonVersion(dir, { isBrandOverride = false } = {}) {
-    const npmPackageName = isBrandOverride ? getBrandPackageName(dir) : '@openedx/paragon';
-    const pathToPackageJson = `${dir}/node_modules/${npmPackageName}/package.json`;
-    if (!fs_1.default.existsSync(pathToPackageJson)) {
-        return undefined;
-    }
-    return JSON.parse(fs_1.default.readFileSync(pathToPackageJson, 'utf-8')).version;
-}
-/**
- * Attempts to extract the Paragon theme CSS from the locally installed `@openedx/paragon` package.
- * @param {string} dir Path to directory containing `node_modules`.
- * @param {boolean} isBrandOverride
- * @returns {ParagonThemeCss}
- */
-function getParagonThemeCss(dir, { isBrandOverride = false } = {}) {
-    const npmPackageName = isBrandOverride ? getBrandPackageName(dir) : '@openedx/paragon';
-    const pathToParagonThemeOutput = path_1.default.resolve(dir, 'node_modules', npmPackageName, 'dist', 'theme-urls.json');
-    if (!fs_1.default.existsSync(pathToParagonThemeOutput)) {
-        return undefined;
-    }
-    const paragonConfig = JSON.parse(fs_1.default.readFileSync(pathToParagonThemeOutput, 'utf-8'));
-    const { core: themeCore, variants: themeVariants, defaults, } = paragonConfig?.themeUrls || {};
-    const pathToCoreCss = path_1.default.resolve(dir, 'node_modules', npmPackageName, 'dist', themeCore.paths.minified);
-    const coreCssExists = fs_1.default.existsSync(pathToCoreCss);
-    const themeVariantResults = Object.entries(themeVariants || {}).reduce((themeVariantAcc, [themeVariant, value]) => {
-        const themeVariantCssDefault = path_1.default.resolve(dir, 'node_modules', npmPackageName, 'dist', value.paths.default);
-        const themeVariantCssMinified = path_1.default.resolve(dir, 'node_modules', npmPackageName, 'dist', value.paths.minified);
-        if (!fs_1.default.existsSync(themeVariantCssDefault) && !fs_1.default.existsSync(themeVariantCssMinified)) {
-            return themeVariantAcc;
-        }
-        return ({
-            ...themeVariantAcc,
-            [themeVariant]: {
-                filePath: themeVariantCssMinified,
-                entryName: isBrandOverride ? `brand.theme.variants.${themeVariant}` : `paragon.theme.variants.${themeVariant}`,
-                outputChunkName: isBrandOverride ? `brand-theme-variants-${themeVariant}` : `paragon-theme-variants-${themeVariant}`,
-            },
-        });
-    }, {});
-    if (!coreCssExists || Object.keys(themeVariantResults).length === 0) {
-        return undefined;
-    }
-    const coreResult = {
-        filePath: path_1.default.resolve(dir, pathToCoreCss),
-        entryName: isBrandOverride ? 'brand.theme.core' : 'paragon.theme.core',
-        outputChunkName: isBrandOverride ? 'brand-theme-core' : 'paragon-theme-core',
-    };
-    return {
-        core: fs_1.default.existsSync(pathToCoreCss) ? coreResult : undefined,
-        variants: themeVariantResults,
-        defaults,
-    };
-}
-/**
- * @typedef CacheGroup
- * @property {string} type The type of cache group.
- * @property {string|function} name The name of the cache group.
- * @property {function} chunks A function that returns true if the chunk should be included in the cache group.
- * @property {boolean} enforce If true, this cache group will be created even if it conflicts with default cache groups.
- */
-/**
- * @param {ParagonThemeCss} paragonThemeCss The Paragon theme CSS metadata.
- * @returns {Object.<string, CacheGroup>} The cache groups for the Paragon theme CSS.
- */
-function getParagonCacheGroups(paragonThemeCss) {
-    if (!paragonThemeCss) {
-        return {};
-    }
-    const cacheGroups = {};
-    if (paragonThemeCss.core !== undefined) {
-        const { core } = paragonThemeCss;
-        cacheGroups[paragonThemeCss.core.outputChunkName] = {
-            type: 'css/mini-extract',
-            name: paragonThemeCss.core.outputChunkName,
-            chunks: (chunk) => chunk.name === core.entryName,
-            enforce: true,
-        };
-    }
-    Object.values(paragonThemeCss.variants).forEach(({ entryName, outputChunkName }) => {
-        cacheGroups[outputChunkName] = {
-            type: 'css/mini-extract',
-            name: outputChunkName,
-            chunks: (chunk) => chunk.name === entryName,
-            enforce: true,
-        };
-    });
-    return cacheGroups;
-}
-/**
- * @param {ParagonThemeCss} paragonThemeCss The Paragon theme CSS metadata.
- * @returns {Object.<string, string>} The entry points for the Paragon theme CSS. Example: ```
- * {
- *   "paragon.theme.core": "/path/to/node_modules/@openedx/paragon/dist/core.min.css",
- *   "paragon.theme.variants.light": "/path/to/node_modules/@openedx/paragon/dist/light.min.css"
- * }
- * ```
- */
-function getParagonEntryPoints(paragonThemeCss) {
-    if (!paragonThemeCss) {
-        return {};
-    }
-    const entryPoints = {};
-    if (paragonThemeCss.core !== undefined) {
-        entryPoints[paragonThemeCss.core.entryName] = path_1.default.resolve(process.cwd(), paragonThemeCss.core.filePath);
-    }
-    Object.values(paragonThemeCss.variants).forEach(({ filePath, entryName }) => {
-        entryPoints[entryName] = path_1.default.resolve(process.cwd(), filePath);
-    });
-    return entryPoints;
-}

package/runtime/__mocks__/file.js DELETED Viewed

	@@ -1 +0,0 @@
1	- export default 'FileMock';

package/runtime/__mocks__/svg.js DELETED Viewed

	@@ -1 +0,0 @@
1	- export default 'SvgURL';

package/runtime/__mocks__/universal-cookie.js DELETED Viewed

@@ -1,6 +0,0 @@
-const mockCookiesImplementation = {
-  get: jest.fn(),
-  remove: jest.fn(),
-};
-module.exports = () => mockCookiesImplementation;

package/runtime/analytics/MockAnalyticsService.js DELETED Viewed

@@ -1,71 +0,0 @@
-/**
- * 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 {
-  static hasIdentifyBeenCalled = false;
-  constructor({ httpClient, loggingService }) {
-    this.loggingService = loggingService;
-    this.httpClient = httpClient;
-  }
-  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.
-   */
-  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.
-   */
-  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.
-   */
-  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.
-   */
-  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.
-   */
-  sendPageEvent = jest.fn(() => {
-    this.checkIdentifyCalled();
-  });
-}
-export default MockAnalyticsService;