@openedx/frontend-base 1.0.0-alpha.12 → 1.0.0-alpha.13

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

@@ -1,32 +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 = getResolvedSiteConfigPath;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-function getResolvedSiteConfigPath(defaultFilename) {
-    const siteConfigPath = process.env.SITE_CONFIG_PATH;
-    if (siteConfigPath !== undefined) {
-        // We assume siteConfigPath is a relative path.
-        const absolutePath = path_1.default.resolve(process.cwd(), siteConfigPath);
-        if (fs_1.default.existsSync(absolutePath)) {
-            // If it's a valid absolute path when joined with the current working directory, return that.
-            return absolutePath;
-        }
-    }
-    // Otherwise, return our default site config file path.
-    const defaultPath = path_1.default.resolve(process.cwd(), defaultFilename);
-    if (fs_1.default.existsSync(defaultPath)) {
-        return defaultPath;
-    }
-    // They supplied something but we can't figure out what it is.  Exit with an error.
-    if (siteConfigPath !== undefined) {
-        console.error(`Invalid site config path (${siteConfigPath} specified as an environment variable. Aborting.`);
-    }
-    else {
-        console.error(`Default site config file (${defaultPath}) does not exist. Aborting.`);
-    }
-    process.exit(1);
-}

package/tools/dist/webpack/webpack.config.build.js

@@ -1,70 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-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 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 getLocalAliases_1 = __importDefault(require("./utils/getLocalAliases"));
-const getPublicPath_1 = __importDefault(require("./utils/getPublicPath"));
-const getResolvedSiteConfigPath_1 = __importDefault(require("./utils/getResolvedSiteConfigPath"));
-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'),
-    },
-    output: {
-        filename: '[name].[chunkhash].js',
-        path: path_1.default.resolve(process.cwd(), 'dist'),
-        publicPath: (0, getPublicPath_1.default)(),
-        clean: true, // Clean the output directory before emit.
-    },
-    resolve: {
-        alias: {
-            ...aliases,
-            'site.config': resolvedSiteConfigPath,
-            '@src': path_1.default.resolve(process.cwd(), 'src'),
-        },
-        extensions: ['.js', '.jsx', '.ts', '.tsx'],
-    },
-    module: {
-        rules: [
-            ...(0, common_config_1.getCodeRules)('production', resolvedSiteConfigPath),
-            (0, common_config_1.getStylesheetRule)('production'),
-            ...(0, common_config_1.getFileLoaderRules)(),
-        ],
-    },
-    // Extract common modules among all chunks to one common chunk and extract the Webpack runtime to a single runtime chunk.
-    optimization: {
-        runtimeChunk: 'single',
-        splitChunks: {
-            chunks: 'all',
-        },
-        minimizer: (0, common_config_1.getImageMinimizer)(),
-    },
-    // Specify additional processing or side-effects done on the Webpack output bundles as a whole.
-    plugins: [
-        // RemoveEmptyScriptsPlugin get rid of empty scripts generated by webpack when using mini-css-extract-plugin
-        // 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(),
-        // Writes the extracted CSS from each entry to a file in the output directory.
-        new mini_css_extract_plugin_1.default({
-            filename: '[name].[chunkhash].css',
-        }),
-        (0, common_config_1.getHtmlWebpackPlugin)(),
-        new fork_ts_checker_webpack_plugin_1.default(),
-        new webpack_bundle_analyzer_1.BundleAnalyzerPlugin({
-            analyzerMode: 'static',
-            openAnalyzer: false,
-        }),
-    ],
-};
-exports.default = config;

package/types.ts

@@ -1,119 +0,0 @@
-import { FC, ReactElement, ReactNode } from 'react';
-import { MessageDescriptor } from 'react-intl';
-import { RouteObject } from 'react-router';
-import { SlotOperation } from './runtime/slots/types';
-
-// Apps
-
-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,
-}
-
-// Site Config
-
-export interface RequiredSiteConfig {
-  siteId: string,
-  siteName: string,
-  baseUrl: string,
-
-  // Backends
-  lmsBaseUrl: string,
-
-  // Frontends
-  loginUrl: string,
-  logoutUrl: string,
-}
-
-export type LocalizedMessages = Record<string, Record<string, string>>;
-
-export interface OptionalSiteConfig {
-  // Site environment
-  environment: EnvironmentTypes,
-
-  // Apps, routes, and URLs
-  apps: App[],
-  basename: string,
-  externalRoutes: ExternalRoute[],
-  externalLinkUrlOverrides: string[],
-  mfeConfigApiUrl: string | null,
-
-  // Theme
-  theme: Theme,
-
-  // Cookies
-  accessTokenCookieName: string,
-  languagePreferenceCookieName: string,
-  userInfoCookieName: string,
-
-  // Paths
-  csrfTokenApiPath: string,
-  refreshAccessTokenApiPath: string,
-
-  // Logging
-  ignoredErrorRegex: RegExp | null,
-
-  // Analytics
-  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 enum EnvironmentTypes {
-  PRODUCTION = 'production',
-  DEVELOPMENT = 'development',
-  TEST = 'test',
-}
-
-// Menu Items
-
-export type MenuItemName = string | MessageDescriptor | ReactElement;