@openedx/frontend-base 1.0.0-alpha.1 → 1.0.0-alpha.10

package/tools/dist/webpack/plugins/paragon-webpack-plugin/utils/tagUtils.js

@@ -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/tools/dist/webpack/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/tools/dist/webpack/utils/paragonUtils.js

@@ -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;
-}