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

package/dist/shell/site.config.dev.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"site.config.dev.js","sourceRoot":"","sources":["../../shell/site.config.dev.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAc,MAAM,UAAU,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,OAAO,CAAC;AAChF,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAC;AAEnD,OAAO,SAAS,CAAC;AAEjB,MAAM,UAAU,GAAe;IAC7B,IAAI,EAAE;QACJ,QAAQ;QACR,SAAS;QACT,SAAS;QACT,UAAU;QACV,YAAY;QACZ,YAAY;QACZ,eAAe;KAChB;IAED,cAAc,EAAE;QACd;YACE,IAAI,EAAE,mCAAmC;YACzC,GAAG,EAAE,4CAA4C;SAClD;QACD;YACE,IAAI,EAAE,mCAAmC;YACzC,GAAG,EAAE,4CAA4C;SAClD;QACD;YACE,IAAI,EAAE,kCAAkC;YACxC,GAAG,EAAE,qCAAqC;SAC3C;KACF;IAED,UAAU;IACV,MAAM,EAAE,OAAO;IACf,QAAQ,EAAE,kBAAkB;IAC5B,OAAO,EAAE,mCAAmC;IAC5C,WAAW,EAAE,gBAAgB,CAAC,WAAW;IAEzC,gBAAgB;IAChB,QAAQ,EAAE,oCAAoC;IAC9C,SAAS,EAAE,qCAAqC;IAEhD,WAAW;IACX,UAAU,EAAE,8BAA8B;IAC1C,UAAU,EAAE,qCAAqC;IACjD,oBAAoB,EAAE,+BAA+B;CACtD,CAAC;AAEF,eAAe,UAAU,CAAC","sourcesContent":["import { EnvironmentTypes, SiteConfig } from '../types';\nimport { devFooterApp, devHeaderApp, devHomeApp, slotShowcaseApp } from './dev';\nimport { footerApp, headerApp, shellApp } from '.';\n\nimport './style';\n\nconst siteConfig: SiteConfig = {\n  apps: [\n    shellApp,\n    headerApp,\n    footerApp,\n    devHomeApp,\n    devHeaderApp,\n    devFooterApp,\n    slotShowcaseApp,\n  ],\n\n  externalRoutes: [\n    {\n      role: 'org.openedx.frontend.role.profile',\n      url: 'http://apps.local.openedx.io:1995/profile/'\n    },\n    {\n      role: 'org.openedx.frontend.role.account',\n      url: 'http://apps.local.openedx.io:1997/account/'\n    },\n    {\n      role: 'org.openedx.frontend.role.logout',\n      url: 'http://local.openedx.io:8000/logout'\n    },\n  ],\n\n  // General\n  siteId: 'shell',\n  siteName: 'My Open edX Site',\n  baseUrl: 'http://apps.local.openedx.io:8080',\n  environment: EnvironmentTypes.DEVELOPMENT,\n\n  // Frontend URLs\n  loginUrl: 'http://local.openedx.io:8000/login',\n  logoutUrl: 'http://local.openedx.io:8000/logout',\n\n  // API URLs\n  lmsBaseUrl: 'http://local.openedx.io:8000',\n  cmsBaseUrl: 'http://studio.local.openedx.io:8001',\n  runtimeConfigJsonUrl: '/api/frontend_site_config/v1/',\n};\n\nexport default siteConfig;\n"]}

package/dist/shell/site.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/shell/site.js

@@ -0,0 +1,45 @@
+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 { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { lazy, StrictMode, Suspense } from 'react';
+import { createRoot } from 'react-dom/client';
+import { RouterProvider } from 'react-router-dom';
+import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
+import { SITE_INIT_ERROR, SITE_READY, initialize, loadExternalScripts, subscribe } from '../runtime';
+import { addAppConfigs } from '../runtime/config';
+import messages from 'site.i18n';
+import createRouter from './router/createRouter';
+/*
+ * Use a dynamic import guarded by process.env.NODE_ENV so that webpack
+ * places the devtools in a separate async chunk that is only requested
+ * in development. In production the ternary resolves to null and the
+ * chunk is never loaded.
+ */
+const ReactQueryDevtools = process.env.NODE_ENV === 'development'
+    ? lazy(() => import('@tanstack/react-query-devtools')
+        .then((m) => ({ default: m.ReactQueryDevtools }))
+        .catch(() => ({ default: () => null })))
+    : null;
+subscribe(SITE_READY, () => __awaiter(void 0, void 0, void 0, function* () {
+    const queryClient = new QueryClient();
+    const router = createRouter();
+    addAppConfigs();
+    loadExternalScripts();
+    const root = createRoot(document.getElementById('root'));
+    root.render(_jsx(StrictMode, { children: _jsxs(QueryClientProvider, { client: queryClient, children: [_jsx(RouterProvider, { router: router }), ReactQueryDevtools && (_jsx(Suspense, { fallback: null, children: _jsx(ReactQueryDevtools, { initialIsOpen: false }) }))] }) }));
+}));
+subscribe(SITE_INIT_ERROR, (error) => {
+    const root = createRoot(document.getElementById('root'));
+    root.render(_jsx("div", { children: error.message }));
+});
+initialize({
+    messages,
+});
+//# sourceMappingURL=site.js.map

package/dist/shell/site.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"site.js","sourceRoot":"","sources":["../../shell/site.tsx"],"names":[],"mappings":";;;;;;;;;;AAAA,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEzE,OAAO,EACL,eAAe,EACf,UAAU,EACV,UAAU,EACV,mBAAmB,EACnB,SAAS,EACV,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,QAAQ,MAAM,WAAW,CAAC;AACjC,OAAO,YAAY,MAAM,uBAAuB,CAAC;AAEjD;;;;;GAKG;AACH,MAAM,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa;IAC/D,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,gCAAgC,CAAC;SAChD,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC;SAChD,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC5C,CAAC,CAAC,IAAI,CAAC;AAET,SAAS,CAAC,UAAU,EAAE,GAAS,EAAE;IAC/B,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;IACtC,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;IAE9B,aAAa,EAAE,CAAC;IAChB,mBAAmB,EAAE,CAAC;IAEtB,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAgB,CAAC,CAAC;IACxE,IAAI,CAAC,MAAM,CACT,KAAC,UAAU,cACT,MAAC,mBAAmB,IAAC,MAAM,EAAE,WAAW,aACtC,KAAC,cAAc,IAAC,MAAM,EAAE,MAAM,GAAI,EACjC,kBAAkB,IAAI,CACrB,KAAC,QAAQ,IAAC,QAAQ,EAAE,IAAI,YACtB,KAAC,kBAAkB,IAAC,aAAa,EAAE,KAAK,GAAI,GACnC,CACZ,IACmB,GACX,CACd,CAAC;AACJ,CAAC,CAAA,CAAC,CAAC;AAEH,SAAS,CAAC,eAAe,EAAE,CAAC,KAAK,EAAE,EAAE;IACnC,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAgB,CAAC,CAAC;IACxE,IAAI,CAAC,MAAM,CAAC,wBAAM,KAAK,CAAC,OAAO,GAAO,CAAC,CAAC;AAC1C,CAAC,CAAC,CAAC;AAEH,UAAU,CAAC;IACT,QAAQ;CACT,CAAC,CAAC","sourcesContent":["import { lazy, StrictMode, Suspense } from 'react';\nimport { createRoot } from 'react-dom/client';\nimport { RouterProvider } from 'react-router-dom';\nimport { QueryClient, QueryClientProvider } from '@tanstack/react-query';\n\nimport {\n  SITE_INIT_ERROR,\n  SITE_READY,\n  initialize,\n  loadExternalScripts,\n  subscribe\n} from '../runtime';\nimport { addAppConfigs } from '../runtime/config';\nimport messages from 'site.i18n';\nimport createRouter from './router/createRouter';\n\n/*\n * Use a dynamic import guarded by process.env.NODE_ENV so that webpack\n * places the devtools in a separate async chunk that is only requested\n * in development. In production the ternary resolves to null and the\n * chunk is never loaded.\n */\nconst ReactQueryDevtools = process.env.NODE_ENV === 'development'\n  ? lazy(() => import('@tanstack/react-query-devtools')\n      .then((m) => ({ default: m.ReactQueryDevtools }))\n      .catch(() => ({ default: () => null })))\n  : null;\n\nsubscribe(SITE_READY, async () => {\n  const queryClient = new QueryClient();\n  const router = createRouter();\n\n  addAppConfigs();\n  loadExternalScripts();\n\n  const root = createRoot(document.getElementById('root') as HTMLElement);\n  root.render(\n    <StrictMode>\n      <QueryClientProvider client={queryClient}>\n        <RouterProvider router={router} />\n        {ReactQueryDevtools && (\n          <Suspense fallback={null}>\n            <ReactQueryDevtools initialIsOpen={false} />\n          </Suspense>\n        )}\n      </QueryClientProvider>\n    </StrictMode>\n  );\n});\n\nsubscribe(SITE_INIT_ERROR, (error) => {\n  const root = createRoot(document.getElementById('root') as HTMLElement);\n  root.render(<div>{error.message}</div>);\n});\n\ninitialize({\n  messages,\n});\n"]}

package/dist/shell/style.d.ts

@@ -0,0 +1,3 @@
+import '@openedx/paragon/dist/core.min.css';
+import '@openedx/paragon/dist/light.min.css';
+import './style.scss';

package/dist/shell/style.js

@@ -0,0 +1,10 @@
+/*
+ * Shell style manifest.  Each import is a separate webpack module, which
+ * keeps Paragon's CSS and the shell's own SCSS as independent compilation
+ * units: the build pipeline wraps each in the `shell` cascade layer by
+ * resource path.  See ADR 0008.
+ */
+import '@openedx/paragon/dist/core.min.css';
+import '@openedx/paragon/dist/light.min.css';
+import './style.scss';
+//# sourceMappingURL=style.js.map

package/dist/shell/style.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"style.js","sourceRoot":"","sources":["../../shell/style.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,oCAAoC,CAAC;AAC5C,OAAO,qCAAqC,CAAC;AAC7C,OAAO,cAAc,CAAC","sourcesContent":["/*\n * Shell style manifest.  Each import is a separate webpack module, which\n * keeps Paragon's CSS and the shell's own SCSS as independent compilation\n * units: the build pipeline wraps each in the `shell` cascade layer by\n * resource path.  See ADR 0008.\n */\nimport '@openedx/paragon/dist/core.min.css';\nimport '@openedx/paragon/dist/light.min.css';\nimport './style.scss';\n"]}

package/dist/shell/style.scss

@@ -0,0 +1,147 @@
+.flex-basis-0 {
+  flex-basis: 0 !important;
+}
+
+.gap-0 {
+  gap: 0px;
+}
+
+.gap-1 {
+  gap: 4px;
+}
+
+.gap-1\.5 {
+  gap: 6px;
+}
+
+.gap-2 {
+  gap: 8px;
+}
+
+.gap-2\.5 {
+  gap: 12px;
+}
+
+.gap-3 {
+  gap: 16px;
+}
+
+.gap-3\.5 {
+  gap: 20px;
+}
+
+.gap-4 {
+  gap: 24px;
+}
+
+.gap-4\.5 {
+  gap: 32px;
+}
+
+.gap-5 {
+  gap: 48px;
+}
+
+.gap-5\.5 {
+  gap: 64px;
+}
+
+.gap-6 {
+  gap: 80px;
+}
+
+.row-gap-0 {
+  row-gap: 0px;
+}
+
+.row-gap-1 {
+  row-gap: 4px;
+}
+
+.row-gap-1\.5 {
+  row-gap: 6px;
+}
+
+.row-gap-2 {
+  row-gap: 8px;
+}
+
+.row-gap-2\.5 {
+  row-gap: 12px;
+}
+
+.row-gap-3 {
+  row-gap: 16px;
+}
+
+.row-gap-3\.5 {
+  row-gap: 20px;
+}
+
+.row-gap-4 {
+  row-gap: 24px;
+}
+
+.row-gap-4\.5 {
+  row-gap: 32px;
+}
+
+.row-gap-5 {
+  row-gap: 48px;
+}
+
+.row-gap-5\.5 {
+  row-gap: 64px;
+}
+
+.row-gap-6 {
+  row-gap: 80px;
+}
+
+.column-gap-0 {
+  column-gap: 0px;
+}
+
+.column-gap-1 {
+  column-gap: 4px;
+}
+
+.column-gap-1\.5 {
+  column-gap: 6px;
+}
+
+.column-gap-2 {
+  column-gap: 8px;
+}
+
+.column-gap-2\.5 {
+  column-gap: 12px;
+}
+
+.column-gap-3 {
+  column-gap: 16px;
+}
+
+.column-gap-3\.5 {
+  column-gap: 20px;
+}
+
+.column-gap-4 {
+  column-gap: 24px;
+}
+
+.column-gap-4\.5 {
+  column-gap: 32px;
+}
+
+.column-gap-5 {
+  column-gap: 48px;
+}
+
+.column-gap-5\.5 {
+  column-gap: 64px;
+}
+
+.column-gap-6 {
+  column-gap: 80px;
+}

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

@@ -0,0 +1,12 @@
+export let presets: (string | (string | {
+    targets: {
+        node: string;
+    };
+})[] | (string | {
+    runtime: string;
+})[])[];
+export namespace env {
+    namespace i18n {
+        let plugins: string[][];
+    }
+}

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

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

package/dist/tools/babel.config.js

@@ -0,0 +1,3 @@
+"use strict";
+const config = require('./babel/babel.config');
+module.exports = config;

package/dist/tools/cli/commands/serve.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tools/cli/commands/translations.d.ts

@@ -0,0 +1,2 @@
+export declare function runPrepare(): void;
+export declare function runPull(): void;

package/dist/tools/cli/commands/translations.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runPrepare = runPrepare;
+exports.runPull = runPull;
+const child_process_1 = __importDefault(require("child_process"));
+const translations_1 = require("../utils/translations");
+function runPrepare() {
+    (0, translations_1.prepare)({ siteRoot: process.cwd() });
+}
+function runPull() {
+    (0, translations_1.pull)({
+        siteRoot: process.cwd(),
+        execFileSync: (file, args) => child_process_1.default.execFileSync(file, args, { stdio: 'inherit' }),
+        shouldPrepare: !process.argv.includes('--no-prepare'),
+        atlasOptions: process.argv.find(a => a.startsWith('--atlas-options='))?.slice('--atlas-options='.length),
+    });
+}

package/dist/tools/cli/openedx.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/tools/cli/openedx.js

@@ -0,0 +1,111 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk_1 = __importDefault(require("chalk"));
+const child_process_1 = require("child_process");
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const types_1 = require("../types");
+const ensureConfigFilenameOption_1 = require("./utils/ensureConfigFilenameOption");
+const prettyPrintTitle_1 = __importDefault(require("./utils/prettyPrintTitle"));
+const printUsage_1 = __importDefault(require("./utils/printUsage"));
+// commandName is the third argument after node and 'openedx'
+const commandName = process.argv[2];
+// remove 'openedx' from process.argv to allow subcommands to read options properly
+process.argv.splice(1, 1);
+function getVersion() {
+    // Read the version from package.json.  The compiled CLI lives at
+    // dist/tools/cli/openedx.js, so the package root is always three levels up.
+    const pkgJsonPath = path_1.default.resolve(__dirname, '../../../package.json');
+    if (!(0, fs_1.existsSync)(pkgJsonPath)) {
+        return '(unknown)';
+    }
+    const { version: pkgVersion } = require(pkgJsonPath);
+    if (!pkgVersion) {
+        return '(unknown)';
+    }
+    if (!/^0\.0\.0-.+$/.test(pkgVersion)) {
+        return pkgVersion;
+    }
+    // Placeholder version found — likely a local git checkout.  Append the
+    // git hash so the exact checkout is identifiable.
+    try {
+        const hash = (0, child_process_1.execSync)('git rev-parse --short HEAD', { encoding: 'utf-8' }).trim();
+        return `${pkgVersion} (${hash})`;
+    }
+    catch {
+        return pkgVersion;
+    }
+}
+const version = getVersion();
+(0, prettyPrintTitle_1.default)(`Open edX CLI v${version}`);
+switch (commandName) {
+    case types_1.CommandTypes.LINT:
+        (0, ensureConfigFilenameOption_1.ensureConfigFilenameOption)(types_1.ConfigTypes.LINT, ['-c', '--config']);
+        require('.bin/eslint');
+        break;
+    case types_1.CommandTypes.TEST:
+        (0, ensureConfigFilenameOption_1.ensureConfigFilenameOption)(types_1.ConfigTypes.TEST, ['-c', '--config']);
+        require('jest/bin/jest');
+        break;
+    case types_1.CommandTypes.BUILD:
+        (0, ensureConfigFilenameOption_1.ensureConfigFilenameOption)(types_1.ConfigTypes.WEBPACK_BUILD, ['-c', '--config']);
+        require('webpack/bin/webpack');
+        break;
+    case types_1.CommandTypes.DEV:
+        (0, ensureConfigFilenameOption_1.ensureConfigFilenameOption)(types_1.ConfigTypes.WEBPACK_DEV, ['-c', '--config']);
+        require('webpack-dev-server/bin/webpack-dev-server');
+        break;
+    case types_1.CommandTypes.DEV_SHELL:
+        (0, ensureConfigFilenameOption_1.ensureConfigFilenameOption)(types_1.ConfigTypes.WEBPACK_DEV_SHELL, ['-c', '--config']);
+        require('webpack-dev-server/bin/webpack-dev-server');
+        break;
+    case types_1.CommandTypes.FORMAT_JS: {
+        /* The include option is used to specify which additional source folders to extract messages from.
+         * To extract more messages on other source folders use: --include=plugins --include=plugins2
+         * The intention use case is to allow extraction from the 'plugins' directory on 'frontend-app-authoring'.
+         * That plugins folder were kept outside the src folder to ensure they remain independent and
+         * can function without relying on the MFE environment's special features.
+         * This approach allows them to be packaged separately as NPM packages. */
+        const additionalSrcFolders = [];
+        process.argv.forEach((val, index) => {
+            if (val.startsWith('--include=')) {
+                additionalSrcFolders.push(val.split('=')[1]);
+                process.argv.splice(index, 1);
+            }
+        });
+        const srcFolders = ['src'].concat(additionalSrcFolders);
+        let srcFoldersString = srcFolders.join(',');
+        if (srcFolders.length > 1) {
+            srcFoldersString = `{${srcFoldersString}}`;
+        }
+        process.argv = process.argv.concat([
+            '--format', path_1.default.resolve(__dirname, './utils/formatter.js'),
+            '--ignore', `${srcFoldersString}/**/*.json`,
+            '--ignore', `${srcFoldersString}/**/*.d.ts`,
+            '--out-file', './src/i18n/transifex_input.json',
+            '--', `${srcFoldersString}/**/*.{j,t}s*`,
+        ]);
+        require('@formatjs/cli/bin/formatjs');
+        break;
+    }
+    case types_1.CommandTypes.SERVE:
+        require('./commands/serve');
+        break;
+    case types_1.CommandTypes.TRANSLATIONS_PULL:
+        require('./commands/translations').runPull();
+        break;
+    case types_1.CommandTypes.TRANSLATIONS_PREPARE:
+        require('./commands/translations').runPrepare();
+        break;
+    case types_1.CommandTypes.HELP:
+        (0, printUsage_1.default)();
+        break;
+    default:
+        console.log(`The command ${chalk_1.default.bold(commandName)} doesn't exist.`);
+        console.log('');
+        (0, printUsage_1.default)();
+}

package/dist/tools/cli/utils/ensureConfigFilenameOption.d.ts

@@ -0,0 +1,2 @@
+import { ConfigTypes } from '../../types';
+export declare function ensureConfigFilenameOption(configType: ConfigTypes, keys: string[]): void;

package/dist/tools/cli/utils/formatter.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tools/cli/utils/formatter.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.format = (messages) => Object.fromEntries(Object.entries(messages).map(([id, { defaultMessage }]) => [id, defaultMessage]));

package/dist/tools/cli/utils/getResolvedConfigPath.d.ts

@@ -0,0 +1,2 @@
+import { ConfigTypes } from '../../types';
+export default function getResolvedConfigPath(customConfigPath: string | null, configType: ConfigTypes): string | null;

package/dist/tools/cli/utils/prettyPrintTitle.d.ts

@@ -0,0 +1 @@
+export default function prettyPrintTitle(title: string): void;

package/dist/tools/cli/utils/printUsage.d.ts

@@ -0,0 +1 @@
+export default function printUsage(): void;

package/dist/tools/cli/utils/printUsage.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = printUsage;
+const chalk_1 = __importDefault(require("chalk"));
+function printUsage() {
+    console.log('CLI Usage:\n');
+    console.group();
+    console.log('openedx <command> <options>\n');
+    console.groupEnd();
+    console.log('Commands:\n');
+    console.log(`${chalk_1.default.bold('lint')} <eslint options>\n`);
+    console.group();
+    console.log(`Runs ESLint on the source code. Requires an ${chalk_1.default.bold('eslint.config.js')} file.\n`);
+    console.groupEnd();
+    console.log(`${chalk_1.default.bold('test')} <jest options>\n`);
+    console.group();
+    console.log(`Runs Jest on the source code test suite. Requires a ${chalk_1.default.bold('jest.config.js')} file.\n`);
+    console.groupEnd();
+    console.log(`${chalk_1.default.bold('build')}\n`);
+    console.group();
+    console.log(`Compiles the source code for deployment as a frontend site.  Requires a ${chalk_1.default.bold('site.config.build.tsx')} file.\n`);
+    console.groupEnd();
+    console.log(`${chalk_1.default.bold('dev')}\n`);
+    console.group();
+    console.log(`Compiles the source code and serves it in Webpack dev server as a frontend site. Requires a ${chalk_1.default.bold('site.config.dev.tsx')} file.\n`);
+    console.groupEnd();
+    console.log(`${chalk_1.default.bold('formatjs')}\n`);
+    console.group();
+    console.log(`Runs formatjs on the source code to extract internationalization messages.\n`);
+    console.groupEnd();
+    console.log(`${chalk_1.default.bold('serve')}\n`);
+    console.group();
+    console.log(`Serves the dist folder with an express server.  Used to locally test production assets.\n`);
+    console.groupEnd();
+    console.log(`${chalk_1.default.bold('translations:pull')}\n`);
+    console.group();
+    console.log(`Pulls translations for all installed apps using atlas, then runs translations:prepare. Reads atlasTranslations config from package.json. Pass ${chalk_1.default.bold('--no-prepare')} to skip the prepare step.\n`);
+    console.groupEnd();
+    console.log(`${chalk_1.default.bold('translations:prepare')}\n`);
+    console.group();
+    console.log(`Generates TypeScript modules from pulled translation JSON files in src/i18n/messages/ and src/i18n/site-messages/.\n`);
+    console.groupEnd();
+    console.groupEnd();
+}

package/dist/tools/cli/utils/translations/index.d.ts

@@ -0,0 +1,2 @@
+export { prepare } from './prepare';
+export { pull } from './pull';

package/dist/tools/cli/utils/translations/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pull = exports.prepare = void 0;
+var prepare_1 = require("./prepare");
+Object.defineProperty(exports, "prepare", { enumerable: true, get: function () { return prepare_1.prepare; } });
+var pull_1 = require("./pull");
+Object.defineProperty(exports, "pull", { enumerable: true, get: function () { return pull_1.pull; } });

package/dist/tools/cli/utils/translations/messagesObject.d.ts

@@ -0,0 +1,26 @@
+export interface LocaleImport {
+    localeName: string;
+    filename: string;
+}
+export interface LocaleEntry {
+    key: string;
+    varName: string;
+}
+export interface MessagesObject {
+    imports: LocaleImport[];
+    entries: LocaleEntry[];
+}
+/**
+ * Reads all locale JSON files in a directory and returns the data needed to
+ * render a messages object ({ 'ar': ar, 'es-419': es_419 }).
+ * Returns null if no non-empty JSON files are found.
+ */
+export declare function generateMessagesObject(dirPath: string): MessagesObject | null;
+export declare function renderImportLine({ localeName, filename }: LocaleImport): string;
+export declare function renderImportsBlock(messagesObject: MessagesObject): string;
+export declare function renderExportLine({ key, varName }: LocaleEntry): string;
+export declare function renderExportBlock(messagesObject: MessagesObject): string;
+/**
+ * Renders a MessagesObject and writes it to an index.ts file in the given directory.
+ */
+export declare function writeMessagesObjectToFile(dirPath: string, messagesObject: MessagesObject): void;

package/dist/tools/cli/utils/translations/messagesObject.js

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateMessagesObject = generateMessagesObject;
+exports.renderImportLine = renderImportLine;
+exports.renderImportsBlock = renderImportsBlock;
+exports.renderExportLine = renderExportLine;
+exports.renderExportBlock = renderExportBlock;
+exports.writeMessagesObjectToFile = writeMessagesObjectToFile;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+/**
+ * Reads all locale JSON files in a directory and returns the data needed to
+ * render a messages object ({ 'ar': ar, 'es-419': es_419 }).
+ * Returns null if no non-empty JSON files are found.
+ */
+function generateMessagesObject(dirPath) {
+    const dirEntries = fs_1.default.readdirSync(dirPath, { withFileTypes: true });
+    const jsonFiles = dirEntries
+        .filter(e => e.isFile() && e.name.endsWith('.json'))
+        .map(e => e.name);
+    const imports = [];
+    const entries = [];
+    for (const filename of jsonFiles) {
+        const localeName = filename.replace(/\.json$/, '');
+        const key = localeName.toLowerCase().replace(/_/g, '-');
+        const filePath = path_1.default.join(dirPath, filename);
+        try {
+            const parsed = JSON.parse(fs_1.default.readFileSync(filePath, { encoding: 'utf8' }));
+            if (!Object.keys(parsed).length) {
+                continue; // skip empty files
+            }
+        }
+        catch {
+            continue;
+        }
+        imports.push({ localeName, filename });
+        entries.push({ key, varName: localeName });
+    }
+    if (!imports.length) {
+        return null;
+    }
+    return { imports, entries };
+}
+function renderImportLine({ localeName, filename }) {
+    return `import ${localeName} from './${filename}';`;
+}
+function renderImportsBlock(messagesObject) {
+    return messagesObject.imports.map(renderImportLine).join('\n');
+}
+function renderExportLine({ key, varName }) {
+    return `  '${key}': ${varName},`;
+}
+function renderExportBlock(messagesObject) {
+    const lines = messagesObject.entries.map(renderExportLine).join('\n');
+    return `export default {\n${lines}\n};\n`;
+}
+/**
+ * Renders a MessagesObject and writes it to an index.ts file in the given directory.
+ */
+function writeMessagesObjectToFile(dirPath, messagesObject) {
+    const content = `${renderImportsBlock(messagesObject)}\n\n${renderExportBlock(messagesObject)}`;
+    fs_1.default.writeFileSync(path_1.default.join(dirPath, 'index.ts'), content);
+}

package/dist/tools/cli/utils/translations/prepare.d.ts

@@ -0,0 +1,5 @@
+export declare function prepareAllPackageMessages(messagesDir: string): [string[], string[]];
+export declare function prepareSiteMessages(siteMessagesDir: string): [string[], string[]];
+export declare function prepare({ siteRoot }: {
+    siteRoot: string;
+}): void;