@openedx/frontend-base 1.0.0-alpha.2 → 1.0.0-alpha.21

package/dist/tools/config-helpers/createLintConfig.d.ts

@@ -0,0 +1,2 @@
+import { ConfigWithExtends } from 'typescript-eslint';
+export default function createLintConfig(...configs: ConfigWithExtends[]): import("typescript-eslint").FlatConfig.ConfigArray;

package/dist/tools/config-helpers/getBaseConfig.d.ts

@@ -0,0 +1,2 @@
+import { ConfigTypes } from '../types';
+export default function getBaseConfig(configType: ConfigTypes): any;

package/dist/tools/defaultConfigPaths.d.ts

@@ -0,0 +1,8 @@
+export declare const defaultConfigPaths: {
+    babel: string[];
+    "webpack-build": string[];
+    "webpack-dev": string[];
+    "webpack-dev-shell": string[];
+    lint: string[];
+    test: string[];
+};

package/dist/tools/eslint/base.eslint.config.d.ts

@@ -0,0 +1,3 @@
+declare const _exports: tseslint.FlatConfig.Config[];
+export = _exports;
+import tseslint = require("typescript-eslint");

package/{config → dist/tools}/eslint/base.eslint.config.js

@@ -31,7 +31,6 @@ module.exports = tseslint.config(eslint.configs.recommended, ...tseslint.configs
             ...globals.browser,
             ...globals.node,
             ...globals.jest,
-            PARAGON_THEME: 'readonly',
             newrelic: 'readonly',
         },
     },
@@ -79,6 +78,8 @@ module.exports = tseslint.config(eslint.configs.recommended, ...tseslint.configs
                 caughtErrors: 'none',
             }],
         '@typescript-eslint/no-empty-function': 'off',
+        '@typescript-eslint/prefer-nullish-coalescing': 'off',
+        '@typescript-eslint/prefer-optional-chain': 'off',
         '@stylistic/semi': ['error', 'always', { omitLastInOneLineBlock: true, omitLastInOneLineClassBody: true }],
         '@stylistic/quotes': ['error', 'single', {
                 avoidEscape: true,
@@ -103,9 +104,9 @@ module.exports = tseslint.config(eslint.configs.recommended, ...tseslint.configs
     },
 }, {
     files: [
-        'babel.config.js',
-        'jest.config.js',
-        'eslint.config.js'
+        '**/babel.config.js',
+        '**/jest.config.js',
+        '**/eslint.config.js'
     ],
     rules: {
         '@typescript-eslint/no-require-imports': 'off'

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

@@ -0,0 +1,3 @@
+declare const _exports: tseslint.FlatConfig.Config[];
+export = _exports;
+import tseslint = require("typescript-eslint");

package/dist/tools/index.d.ts

@@ -0,0 +1,3 @@
+export { default as createConfig } from './config-helpers/createConfig';
+export { default as createLintConfig } from './config-helpers/createLintConfig';
+export { default as getBaseConfig } from './config-helpers/getBaseConfig';

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

@@ -0,0 +1,14 @@
+export let testEnvironment: string;
+export namespace testEnvironmentOptions {
+    let url: string;
+}
+export let rootDir: string;
+export let moduleNameMapper: {
+    '\\.(css|scss)$': string;
+    'site.config': string;
+};
+export let collectCoverageFrom: string[];
+export let coveragePathIgnorePatterns: string[];
+export let transformIgnorePatterns: string[];
+export let modulePathIgnorePatterns: string[];
+export let testPathIgnorePatterns: string[];

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

@@ -0,0 +1,8 @@
+export let testEnvironment: string;
+export namespace testEnvironmentOptions {
+    let url: string;
+}
+export let collectCoverageFrom: string[];
+export let transformIgnorePatterns: string[];
+export let modulePathIgnorePatterns: string[];
+export let testPathIgnorePatterns: string[];

package/dist/tools/types.d.ts

@@ -0,0 +1,18 @@
+export declare enum ConfigTypes {
+    BABEL = "babel",
+    WEBPACK_BUILD = "webpack-build",
+    WEBPACK_DEV = "webpack-dev",
+    WEBPACK_DEV_SHELL = "webpack-dev-shell",
+    LINT = "lint",
+    TEST = "test"
+}
+export declare enum CommandTypes {
+    LINT = "lint",
+    TEST = "test",
+    BUILD = "build",
+    DEV_SHELL = "dev:shell",
+    DEV = "dev",
+    FORMAT_JS = "formatjs",
+    SERVE = "serve",
+    HELP = "help"
+}

package/{tools/dist → dist/tools}/typescript/tsconfig.json

@@ -16,7 +16,7 @@
         ],
         "isolatedModules": true,
         "module": "ESNext",
-        "moduleResolution": "node",
+        "moduleResolution": "bundler",
         "noEmit": true,
         "noFallthroughCasesInSwitch": true,
         "noImplicitAny": false,
@@ -24,6 +24,7 @@
         "noUnusedParameters": true,
         "resolveJsonModule": true,
         "skipLibCheck": true,
+        "inlineSources": true,
         "sourceMap": true,
         "strict": true,
         "strictFunctionTypes": false,

package/dist/tools/webpack/common-config/all/getCodeRules.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetRule } from 'webpack';
+export default function getCodeRules(mode: 'dev' | 'production', resolvedSiteConfigPath: string): RuleSetRule[];

package/dist/tools/webpack/common-config/all/getFileLoaderRules.d.ts

@@ -0,0 +1,11 @@
+export default function getFileLoaderRules(): ({
+    test: RegExp;
+    loader: string;
+    options?: undefined;
+} | {
+    test: RegExp;
+    loader: string;
+    options: {
+        name: string;
+    };
+})[];

package/dist/tools/webpack/common-config/all/getImageMinimizer.d.ts

@@ -0,0 +1,5 @@
+import { Compiler } from 'image-minimizer-webpack-plugin';
+import { WebpackPluginInstance } from 'webpack';
+type ImageMinimizerReturnType = (false | '' | 0 | '...' | ((this: Compiler, compiler: Compiler) => void) | WebpackPluginInstance | null | undefined)[] | undefined;
+export default function getImageMinimizer(): ImageMinimizerReturnType;
+export {};

package/dist/tools/webpack/common-config/all/getStylesheetRule.d.ts

@@ -0,0 +1,8 @@
+import { RuleSetRule } from 'webpack';
+/**
+ * There are a few things we need to do here.
+ *
+ * - We only want to use MiniCssExtractPlugin on dependencies in dev, but not on our source code.
+ * - We only want CssNano in production.
+ */
+export default function getStylesheetRule(mode: 'dev' | 'production'): RuleSetRule;

package/{config → dist/tools}/webpack/common-config/all/getStylesheetRule.js

@@ -87,7 +87,7 @@ function getStyleUseConfig(mode) {
                     ],
                     // Silences compiler deprecation warnings.  They mostly come from bootstrap and/or paragon.
                     quietDeps: true,
-                    silenceDeprecations: ['abs-percent', 'color-functions', 'import', 'mixed-decls', 'global-builtin', 'legacy-js-api'],
+                    silenceDeprecations: ['abs-percent', 'color-functions', 'import', 'global-builtin', 'legacy-js-api'],
                 },
             },
         },

package/dist/tools/webpack/common-config/dev/getDevServer.d.ts

@@ -0,0 +1,2 @@
+import { Configuration } from 'webpack-dev-server';
+export default function getDevServer(): Configuration;

package/{tools/dist → dist/tools}/webpack/common-config/dev/getDevServer.js

@@ -12,18 +12,16 @@ function getDevServer() {
         headers: {
             'Access-Control-Allow-Origin': '*',
         },
-        // For obvious reasons, 'auto' won't work for publicPath here, so we
-        // force '/' unless PUBLIC_PATH is set.
         historyApiFallback: {
-            index: path_1.default.join((0, getPublicPath_1.default)('/'), 'index.html'),
+            index: path_1.default.join((0, getPublicPath_1.default)(), 'index.html'),
             disableDotRule: true,
         },
-        host: 'apps.local.openedx.io',
+        host: '0.0.0.0',
         hot: true,
         port: process.env.PORT ?? 8080,
         proxy: [
             {
-                context: ['/api/mfe_config/v1'],
+                context: ['/api/frontend_site_config/v1'],
                 target: 'http://local.openedx.io:8000',
                 changeOrigin: true,
             }

package/dist/tools/webpack/common-config/index.d.ts

@@ -0,0 +1,6 @@
+export { default as getCodeRules } from './all/getCodeRules';
+export { default as getFileLoaderRules } from './all/getFileLoaderRules';
+export { default as getImageMinimizer } from './all/getImageMinimizer';
+export { default as getStylesheetRule } from './all/getStylesheetRule';
+export { default as getDevServer } from './dev/getDevServer';
+export { default as getHtmlWebpackPlugin } from './site/getHtmlWebpackPlugin';

package/dist/tools/webpack/common-config/site/getHtmlWebpackPlugin.d.ts

@@ -0,0 +1,2 @@
+import HtmlWebpackPlugin from 'html-webpack-plugin';
+export default function getHtmlWebpackPlugin(): HtmlWebpackPlugin;

package/dist/tools/webpack/plugins/html-webpack-new-relic-plugin/HtmlWebpackNewRelicPlugin.d.ts

@@ -0,0 +1,16 @@
+import { Compiler } from 'webpack';
+declare enum OptionTypes {
+    ACCOUNT_ID = "accountID",
+    AGENT_ID = "agentID",
+    APPLICATION_ID = "applicationID",
+    LICENSE_KEY = "licenseKey",
+    TRUST_KEY = "trustKey"
+}
+type HtmlWebpackNewRelicPluginOptions = Record<OptionTypes, string | undefined>;
+export default class HtmlWebpackNewRelicPlugin {
+    options: HtmlWebpackNewRelicPluginOptions;
+    newRelicString: string;
+    constructor(options: Partial<HtmlWebpackNewRelicPluginOptions>);
+    apply(compiler: Compiler): void;
+}
+export {};

package/dist/tools/webpack/plugins/html-webpack-new-relic-plugin/index.d.ts

@@ -0,0 +1,2 @@
+export default HtmlWebpackNewRelicPlugin;
+import HtmlWebpackNewRelicPlugin from './HtmlWebpackNewRelicPlugin';

package/dist/tools/webpack/plugins/html-webpack-new-relic-plugin/test/HtmlWebpackNewRelicPlugin.test.d.ts

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

package/dist/tools/webpack/plugins/html-webpack-new-relic-plugin/test/fixtures/entry.d.ts

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

package/dist/tools/webpack/utils/getPublicPath.d.ts

@@ -0,0 +1 @@
+export default function getPublicPath(defaultPath?: string): string;

package/{tools/dist → dist/tools}/webpack/utils/getPublicPath.js

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

package/dist/tools/webpack/utils/getResolvedSiteConfigPath.d.ts

@@ -0,0 +1 @@
+export default function getResolvedSiteConfigPath(defaultFilename: string): string;

package/dist/tools/webpack/webpack.config.build.d.ts

@@ -0,0 +1,3 @@
+import { Configuration } from 'webpack';
+declare const config: Configuration;
+export default config;

package/{config → dist/tools}/webpack/webpack.config.build.js

@@ -6,25 +6,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fork_ts_checker_webpack_plugin_1 = __importDefault(require("fork-ts-checker-webpack-plugin"));
 const mini_css_extract_plugin_1 = __importDefault(require("mini-css-extract-plugin"));
 const path_1 = __importDefault(require("path"));
+const tsconfig_paths_webpack_plugin_1 = __importDefault(require("tsconfig-paths-webpack-plugin"));
 const webpack_bundle_analyzer_1 = require("webpack-bundle-analyzer");
 const webpack_remove_empty_scripts_1 = __importDefault(require("webpack-remove-empty-scripts"));
 const common_config_1 = require("./common-config");
-const ParagonWebpackPlugin_1 = __importDefault(require("./plugins/paragon-webpack-plugin/ParagonWebpackPlugin"));
-const getLocalAliases_1 = __importDefault(require("./utils/getLocalAliases"));
 const getPublicPath_1 = __importDefault(require("./utils/getPublicPath"));
 const getResolvedSiteConfigPath_1 = __importDefault(require("./utils/getResolvedSiteConfigPath"));
-const paragonUtils_1 = require("./utils/paragonUtils");
-const paragonThemeCss = (0, paragonUtils_1.getParagonThemeCss)(process.cwd());
-const brandThemeCss = (0, paragonUtils_1.getParagonThemeCss)(process.cwd(), { isBrandOverride: true });
-const aliases = (0, getLocalAliases_1.default)();
 const resolvedSiteConfigPath = (0, getResolvedSiteConfigPath_1.default)('site.config.build.tsx');
 const config = {
     mode: 'production',
     devtool: 'source-map',
     entry: {
-        app: path_1.default.resolve(process.cwd(), 'node_modules/@openedx/frontend-base/shell/site'),
-        ...(0, paragonUtils_1.getParagonEntryPoints)(paragonThemeCss),
-        ...(0, paragonUtils_1.getParagonEntryPoints)(brandThemeCss),
+        app: '@openedx/frontend-base/shell/site',
     },
     output: {
         filename: '[name].[chunkhash].js',
@@ -34,9 +27,14 @@ const config = {
     },
     resolve: {
         alias: {
-            ...aliases,
             'site.config': resolvedSiteConfigPath,
         },
+        plugins: [
+            new tsconfig_paths_webpack_plugin_1.default({
+                configFile: path_1.default.resolve(process.cwd(), 'tsconfig.json'),
+                extensions: ['.ts', '.tsx', '.js', '.jsx'],
+            }),
+        ],
         extensions: ['.js', '.jsx', '.ts', '.tsx'],
     },
     module: {
@@ -51,10 +49,6 @@ const config = {
         runtimeChunk: 'single',
         splitChunks: {
             chunks: 'all',
-            cacheGroups: {
-                ...(0, paragonUtils_1.getParagonCacheGroups)(paragonThemeCss),
-                ...(0, paragonUtils_1.getParagonCacheGroups)(brandThemeCss),
-            },
         },
         minimizer: (0, common_config_1.getImageMinimizer)(),
     },
@@ -65,7 +59,6 @@ const config = {
         // See: https://www.npmjs.com/package/webpack-remove-empty-scripts#usage-with-mini-css-extract-plugin
         new webpack_remove_empty_scripts_1.default(),
         // Writes the extracted CSS from each entry to a file in the output directory.
-        new ParagonWebpackPlugin_1.default(),
         new mini_css_extract_plugin_1.default({
             filename: '[name].[chunkhash].css',
         }),

package/dist/tools/webpack/webpack.config.dev.d.ts

@@ -0,0 +1,3 @@
+import { Configuration } from 'webpack';
+declare const config: Configuration;
+export default config;

package/{tools/dist → dist/tools}/webpack/webpack.config.dev.js

@@ -7,22 +7,15 @@ const react_refresh_webpack_plugin_1 = __importDefault(require("@pmmmwh/react-re
 const fork_ts_checker_webpack_plugin_1 = __importDefault(require("fork-ts-checker-webpack-plugin"));
 const mini_css_extract_plugin_1 = __importDefault(require("mini-css-extract-plugin"));
 const path_1 = __importDefault(require("path"));
+const tsconfig_paths_webpack_plugin_1 = __importDefault(require("tsconfig-paths-webpack-plugin"));
 const webpack_remove_empty_scripts_1 = __importDefault(require("webpack-remove-empty-scripts"));
 const common_config_1 = require("./common-config");
-const ParagonWebpackPlugin_1 = __importDefault(require("./plugins/paragon-webpack-plugin/ParagonWebpackPlugin"));
-const getLocalAliases_1 = __importDefault(require("./utils/getLocalAliases"));
 const getPublicPath_1 = __importDefault(require("./utils/getPublicPath"));
 const getResolvedSiteConfigPath_1 = __importDefault(require("./utils/getResolvedSiteConfigPath"));
-const paragonUtils_1 = require("./utils/paragonUtils");
-const paragonThemeCss = (0, paragonUtils_1.getParagonThemeCss)(process.cwd());
-const brandThemeCss = (0, paragonUtils_1.getParagonThemeCss)(process.cwd(), { isBrandOverride: true });
-const aliases = (0, getLocalAliases_1.default)();
 const resolvedSiteConfigPath = (0, getResolvedSiteConfigPath_1.default)('site.config.dev.tsx');
 const config = {
     entry: {
-        app: path_1.default.resolve(process.cwd(), 'node_modules/@openedx/frontend-base/shell/site'),
-        ...(0, paragonUtils_1.getParagonEntryPoints)(paragonThemeCss),
-        ...(0, paragonUtils_1.getParagonEntryPoints)(brandThemeCss),
+        app: '@openedx/frontend-base/shell/site',
     },
     output: {
         path: path_1.default.resolve(process.cwd(), './dist'),
@@ -30,9 +23,14 @@ const config = {
     },
     resolve: {
         alias: {
-            ...aliases,
             'site.config': resolvedSiteConfigPath,
         },
+        plugins: [
+            new tsconfig_paths_webpack_plugin_1.default({
+                configFile: path_1.default.resolve(process.cwd(), 'tsconfig.json'),
+                extensions: ['.ts', '.tsx', '.js', '.jsx'],
+            }),
+        ],
         extensions: ['.js', '.jsx', '.ts', '.tsx'],
     },
     mode: 'development',
@@ -47,10 +45,6 @@ const config = {
     optimization: {
         splitChunks: {
             chunks: 'all',
-            cacheGroups: {
-                ...(0, paragonUtils_1.getParagonCacheGroups)(paragonThemeCss),
-                ...(0, paragonUtils_1.getParagonCacheGroups)(brandThemeCss),
-            },
         },
         minimizer: (0, common_config_1.getImageMinimizer)(),
     },
@@ -60,7 +54,6 @@ const config = {
         // This helps to clean up the final bundle application
         // See: https://www.npmjs.com/package/webpack-remove-empty-scripts#usage-with-mini-css-extract-plugin
         new webpack_remove_empty_scripts_1.default(),
-        new ParagonWebpackPlugin_1.default(),
         // Writes the extracted CSS from each entry to a file in the output directory.
         new mini_css_extract_plugin_1.default({
             filename: '[name].css',
@@ -72,5 +65,9 @@ const config = {
     // This configures webpack-dev-server which serves bundles from memory and provides live
     // reloading.
     devServer: (0, common_config_1.getDevServer)(),
+    // Limit the number of watched files to avoid `inotify` resource starvation.
+    watchOptions: {
+        ignored: /node_modules/
+    }
 };
 exports.default = config;

package/dist/tools/webpack/webpack.config.dev.shell.d.ts

@@ -0,0 +1,3 @@
+import { Configuration } from 'webpack';
+declare const config: Configuration;
+export default config;

package/{config → dist/tools}/webpack/webpack.config.dev.shell.js

@@ -11,21 +11,13 @@ const path_1 = __importDefault(require("path"));
 const react_refresh_typescript_1 = __importDefault(require("react-refresh-typescript"));
 const webpack_remove_empty_scripts_1 = __importDefault(require("webpack-remove-empty-scripts"));
 const common_config_1 = require("./common-config");
-const ParagonWebpackPlugin_1 = __importDefault(require("./plugins/paragon-webpack-plugin/ParagonWebpackPlugin"));
 const html_webpack_plugin_1 = __importDefault(require("html-webpack-plugin"));
-const getLocalAliases_1 = __importDefault(require("./utils/getLocalAliases"));
 const getPublicPath_1 = __importDefault(require("./utils/getPublicPath"));
 const getResolvedSiteConfigPath_1 = __importDefault(require("./utils/getResolvedSiteConfigPath"));
-const paragonUtils_1 = require("./utils/paragonUtils");
-const paragonThemeCss = (0, paragonUtils_1.getParagonThemeCss)(process.cwd());
-const brandThemeCss = (0, paragonUtils_1.getParagonThemeCss)(process.cwd(), { isBrandOverride: true });
-const aliases = (0, getLocalAliases_1.default)();
 const resolvedSiteConfigPath = (0, getResolvedSiteConfigPath_1.default)('shell/site.config.dev.tsx');
 const config = {
     entry: {
         app: path_1.default.resolve(process.cwd(), 'shell/site'),
-        ...(0, paragonUtils_1.getParagonEntryPoints)(paragonThemeCss),
-        ...(0, paragonUtils_1.getParagonEntryPoints)(brandThemeCss),
     },
     output: {
         path: path_1.default.resolve(process.cwd(), './dist'),
@@ -33,7 +25,6 @@ const config = {
     },
     resolve: {
         alias: {
-            ...aliases,
             'site.config': resolvedSiteConfigPath,
         },
         extensions: ['.js', '.jsx', '.ts', '.tsx'],
@@ -77,10 +68,6 @@ const config = {
     optimization: {
         splitChunks: {
             chunks: 'all',
-            cacheGroups: {
-                ...(0, paragonUtils_1.getParagonCacheGroups)(paragonThemeCss),
-                ...(0, paragonUtils_1.getParagonCacheGroups)(brandThemeCss),
-            },
         },
         minimizer: (0, common_config_1.getImageMinimizer)(),
     },
@@ -90,7 +77,6 @@ const config = {
         // This helps to clean up the final bundle application
         // See: https://www.npmjs.com/package/webpack-remove-empty-scripts#usage-with-mini-css-extract-plugin
         new webpack_remove_empty_scripts_1.default(),
-        new ParagonWebpackPlugin_1.default(),
         // Writes the extracted CSS from each entry to a file in the output directory.
         new mini_css_extract_plugin_1.default({
             filename: '[name].css',
@@ -106,5 +92,9 @@ const config = {
     // This configures webpack-dev-server which serves bundles from memory and provides live
     // reloading.
     devServer: (0, common_config_1.getDevServer)(),
+    // Limit the number of watched files to avoid `inotify` resource starvation.
+    watchOptions: {
+        ignored: /node_modules/
+    }
 };
 exports.default = config;

package/dist/types.d.ts

@@ -0,0 +1,84 @@
+import { FC, ReactElement, ReactNode } from 'react';
+import { MessageDescriptor } from 'react-intl';
+import { RouteObject } from 'react-router';
+import { SlotOperation } from './runtime/slots/types';
+export interface ExternalRoute {
+    role: string;
+    url: string;
+}
+export type RoleRouteObject = RouteObject & {
+    handle?: {
+        /**
+         * A route role is used to identify a route that fulfills a particular role in the site.
+         */
+        role?: string;
+    };
+};
+export type AppConfig = Record<string, unknown>;
+export type AppProvider = FC<{
+    children?: ReactNode;
+}>;
+export interface App {
+    appId: string;
+    messages?: LocalizedMessages;
+    routes?: RoleRouteObject[];
+    providers?: AppProvider[];
+    slots?: SlotOperation[];
+    config?: AppConfig;
+}
+export interface RequiredSiteConfig {
+    siteId: string;
+    siteName: string;
+    baseUrl: string;
+    lmsBaseUrl: string;
+    loginUrl: string;
+    logoutUrl: string;
+}
+export type LocalizedMessages = Record<string, Record<string, string>>;
+export interface OptionalSiteConfig {
+    environment: EnvironmentTypes;
+    apps: App[];
+    basename: string;
+    externalRoutes: ExternalRoute[];
+    externalLinkUrlOverrides: string[];
+    runtimeConfigJsonUrl: string | null;
+    commonAppConfig: AppConfig;
+    headerLogoImageUrl: string;
+    theme: Theme;
+    accessTokenCookieName: string;
+    languagePreferenceCookieName: string;
+    userInfoCookieName: string;
+    csrfTokenApiPath: string;
+    refreshAccessTokenApiPath: string;
+    ignoredErrorRegex: RegExp | null;
+    segmentKey: string | null;
+}
+export type SiteConfig = RequiredSiteConfig & Partial<OptionalSiteConfig>;
+export interface ThemeVariant {
+    url: string;
+}
+export interface ThemeDefaults {
+    light?: string;
+    dark?: string;
+}
+export type ThemeVariants = Record<string, ThemeVariant>;
+export interface Theme {
+    core?: ThemeVariant;
+    defaults?: ThemeDefaults;
+    variants?: ThemeVariants;
+}
+export interface User {
+    administrator: boolean;
+    email: string;
+    name: string;
+    roles: string[];
+    userId: number;
+    username: string;
+    avatar: string;
+}
+export declare enum EnvironmentTypes {
+    PRODUCTION = "production",
+    DEVELOPMENT = "development",
+    TEST = "test"
+}
+export type MenuItemName = string | MessageDescriptor | ReactElement;

package/dist/types.js

@@ -0,0 +1,7 @@
+export var EnvironmentTypes;
+(function (EnvironmentTypes) {
+    EnvironmentTypes["PRODUCTION"] = "production";
+    EnvironmentTypes["DEVELOPMENT"] = "development";
+    EnvironmentTypes["TEST"] = "test";
+})(EnvironmentTypes || (EnvironmentTypes = {}));
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../types.ts"],"names":[],"mappings":"AAgHA,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,6CAAyB,CAAA;IACzB,+CAA2B,CAAA;IAC3B,iCAAa,CAAA;AACf,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B","sourcesContent":["import { FC, ReactElement, ReactNode } from 'react';\nimport { MessageDescriptor } from 'react-intl';\nimport { RouteObject } from 'react-router';\nimport { SlotOperation } from './runtime/slots/types';\n\n// Apps\n\nexport interface ExternalRoute {\n  role: string,\n  url: string,\n}\n\nexport type RoleRouteObject = RouteObject & {\n  handle?: {\n    /**\n     * A route role is used to identify a route that fulfills a particular role in the site.\n     */\n    role?: string,\n  },\n};\n\nexport type AppConfig = Record<string, unknown>;\n\nexport type AppProvider = FC<{ children?: ReactNode }>;\n\nexport interface App {\n  appId: string,\n  messages?: LocalizedMessages,\n  routes?: RoleRouteObject[],\n  providers?: AppProvider[],\n  slots?: SlotOperation[],\n  config?: AppConfig,\n}\n\n// Site Config\n\nexport interface RequiredSiteConfig {\n  siteId: string,\n  siteName: string,\n  baseUrl: string,\n\n  // Backends\n  lmsBaseUrl: string,\n\n  // Frontends\n  loginUrl: string,\n  logoutUrl: string,\n}\n\nexport type LocalizedMessages = Record<string, Record<string, string>>;\n\nexport interface OptionalSiteConfig {\n  // Site environment\n  environment: EnvironmentTypes,\n\n  // Apps, routes, and URLs\n  apps: App[],\n  basename: string,\n  externalRoutes: ExternalRoute[],\n  externalLinkUrlOverrides: string[],\n  runtimeConfigJsonUrl: string | null,\n  commonAppConfig: AppConfig,\n  headerLogoImageUrl: string,\n\n  // Theme\n  theme: Theme,\n\n  // Cookies\n  accessTokenCookieName: string,\n  languagePreferenceCookieName: string,\n  userInfoCookieName: string,\n\n  // Paths\n  csrfTokenApiPath: string,\n  refreshAccessTokenApiPath: string,\n\n  // Logging\n  ignoredErrorRegex: RegExp | null,\n\n  // Analytics\n  segmentKey: string | null,\n}\n\nexport type SiteConfig = RequiredSiteConfig & Partial<OptionalSiteConfig>;\n\nexport interface ThemeVariant {\n  url: string,\n}\n\nexport interface ThemeDefaults {\n  light?: string,\n  dark?: string,\n}\n\nexport type ThemeVariants = Record<string, ThemeVariant>;\n\nexport interface Theme {\n  core?: ThemeVariant,\n  defaults?: ThemeDefaults,\n  variants?: ThemeVariants,\n}\n\nexport interface User {\n  administrator: boolean,\n  email: string,\n  name: string,\n  roles: string[],\n  userId: number,\n  username: string,\n  avatar: string,\n}\n\nexport enum EnvironmentTypes {\n  PRODUCTION = 'production',\n  DEVELOPMENT = 'development',\n  TEST = 'test',\n}\n\n// Menu Items\n\nexport type MenuItemName = string | MessageDescriptor | ReactElement;\n"]}