@modern-js/utils 1.3.6 → 1.3.7-alpha.prebundle.0

package/dist/constants.d.ts

@@ -0,0 +1,209 @@
+/**
+ * hmr socket connect path
+ */
+export declare const HMR_SOCK_PATH = "/_modern_js_hmr_ws";
+/**
+ * route specification file
+ */
+export declare const ROUTE_SPEC_FILE = "route.json";
+/**
+ * main entry name
+ */
+export declare const MAIN_ENTRY_NAME = "main";
+/**
+ * open editor request path
+ */
+export declare const LAUNCH_EDITOR_ENDPOINT = "/__open-stack-frame-in-editor";
+/**
+ * server side bundles directory, which relative to dist.
+ */
+export declare const SERVER_BUNDLE_DIRECTORY = "bundles";
+/**
+ * entry name pattern used for ajv pattern properties.
+ */
+export declare const ENTRY_NAME_PATTERN = "^[a-zA-Z0-9_-]+$";
+/**
+ * SSR server render function name
+ */
+export declare const SERVER_RENDER_FUNCTION_NAME = "serverRender";
+/**
+ * loadbale manifest json file
+ */
+export declare const LOADABLE_STATS_FILE = "loadable-stats.json";
+/**
+ * internal specified folder
+ */
+export declare const API_DIR = "api";
+export declare const SERVER_DIR = "server";
+export declare const SHARED_DIR = "shared";
+/**
+ * Internal plugins that work as soon as they are installed.
+ */
+export declare const INTERNAL_PLUGINS: {
+    [name: string]: {
+        cli?: string;
+        server?: string;
+    };
+};
+/**
+ * The schema registered in the plugin.
+ */
+export declare const PLUGIN_SCHEMAS: {
+    '@modern-js/runtime': ({
+        target: string;
+        schema: {
+            type: string;
+            additionalProperties: boolean;
+            patternProperties?: undefined;
+        };
+    } | {
+        target: string;
+        schema: {
+            type: string;
+            patternProperties: {
+                "^[a-zA-Z0-9_-]+$": {
+                    type: string;
+                };
+            };
+            additionalProperties: boolean;
+        };
+    })[];
+    '@modern-js/plugin-bff': {
+        target: string;
+        schema: {
+            type: string;
+            properties: {
+                prefix: {
+                    type: string[];
+                    items: {
+                        type: string;
+                    };
+                };
+                fetcher: {
+                    type: string;
+                };
+                proxy: {
+                    type: string;
+                };
+                requestCreator: {
+                    type: string;
+                };
+            };
+        };
+    }[];
+    '@modern-js/plugin-esbuild': {
+        target: string;
+        schema: {
+            typeof: string[];
+        };
+    }[];
+    '@modern-js/plugin-less': {
+        target: string;
+        schema: {
+            typeof: string[];
+        };
+    }[];
+    '@modern-js/plugin-sass': {
+        target: string;
+        schema: {
+            typeof: string[];
+        };
+    }[];
+    '@modern-js/plugin-tailwindcss': {
+        target: string;
+        schema: {
+            typeof: string[];
+        };
+    }[];
+    '@modern-js/plugin-proxy': {
+        target: string;
+        schema: {
+            typeof: string[];
+        };
+    }[];
+    '@modern-js/plugin-unbundle': ({
+        target: string;
+        schema: {
+            type: string;
+            properties?: undefined;
+        };
+    } | {
+        target: string;
+        schema: {
+            type: string;
+            properties: {
+                ignore: {
+                    type: string[];
+                    items: {
+                        type: string;
+                    };
+                };
+                ignoreModuleCache: {
+                    type: string;
+                };
+                clearPdnCache: {
+                    type: string;
+                };
+                pdnHost: {
+                    type: string;
+                };
+            };
+        };
+    })[];
+    '@modern-js/plugin-ssg': {
+        target: string;
+        schema: {
+            oneOf: ({
+                type: string;
+                instanceof?: undefined;
+            } | {
+                instanceof: string;
+                type?: undefined;
+            })[];
+        };
+    }[];
+    '@modern-js/plugin-ssr': {
+        target: string;
+        schema: {
+            type: string[];
+        };
+    }[];
+    '@modern-js/plugin-state': {
+        target: string;
+        schema: {
+            type: string[];
+        };
+    }[];
+    '@modern-js/plugin-design-token': ({
+        target: string;
+        schema: {
+            typeof: string[];
+            type?: undefined;
+        };
+    } | {
+        target: string;
+        schema: {
+            type: string[];
+            typeof?: undefined;
+        };
+    })[];
+    '@modern-js/plugin-router': {
+        target: string;
+        schema: {
+            type: string[];
+        };
+    }[];
+    '@modern-js/plugin-testing': {
+        target: string;
+        schema: {
+            typeof: string[];
+        };
+    }[];
+    '@modern-js/plugin-garfish': {
+        target: string;
+        schema: {
+            type: string[];
+        };
+    }[];
+    '@modern-js/plugin-nocode': never[];
+};

package/dist/constants.js

@@ -0,0 +1,264 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PLUGIN_SCHEMAS = exports.INTERNAL_PLUGINS = exports.SHARED_DIR = exports.SERVER_DIR = exports.API_DIR = exports.LOADABLE_STATS_FILE = exports.SERVER_RENDER_FUNCTION_NAME = exports.ENTRY_NAME_PATTERN = exports.SERVER_BUNDLE_DIRECTORY = exports.LAUNCH_EDITOR_ENDPOINT = exports.MAIN_ENTRY_NAME = exports.ROUTE_SPEC_FILE = exports.HMR_SOCK_PATH = void 0;
+/**
+ * hmr socket connect path
+ */
+exports.HMR_SOCK_PATH = '/_modern_js_hmr_ws';
+/**
+ * route specification file
+ */
+exports.ROUTE_SPEC_FILE = 'route.json';
+/**
+ * main entry name
+ */
+exports.MAIN_ENTRY_NAME = 'main';
+/**
+ * open editor request path
+ */
+exports.LAUNCH_EDITOR_ENDPOINT = '/__open-stack-frame-in-editor';
+/**
+ * server side bundles directory, which relative to dist.
+ */
+exports.SERVER_BUNDLE_DIRECTORY = 'bundles';
+/**
+ * entry name pattern used for ajv pattern properties.
+ */
+exports.ENTRY_NAME_PATTERN = '^[a-zA-Z0-9_-]+$';
+/**
+ * SSR server render function name
+ */
+exports.SERVER_RENDER_FUNCTION_NAME = 'serverRender';
+/**
+ * loadbale manifest json file
+ */
+exports.LOADABLE_STATS_FILE = 'loadable-stats.json';
+/**
+ * internal specified folder
+ */
+exports.API_DIR = 'api';
+exports.SERVER_DIR = 'server';
+exports.SHARED_DIR = 'shared';
+/**
+ * Internal plugins that work as soon as they are installed.
+ */
+exports.INTERNAL_PLUGINS = {
+    '@modern-js/app-tools': { cli: '@modern-js/app-tools/cli' },
+    '@modern-js/monorepo-tools': { cli: '@modern-js/monorepo-tools/cli' },
+    '@modern-js/module-tools': { cli: '@modern-js/module-tools/cli' },
+    '@modern-js/runtime': { cli: '@modern-js/runtime/cli' },
+    '@modern-js/plugin-less': { cli: '@modern-js/plugin-less/cli' },
+    '@modern-js/plugin-sass': { cli: '@modern-js/plugin-sass/cli' },
+    '@modern-js/plugin-esbuild': { cli: '@modern-js/plugin-esbuild/cli' },
+    '@modern-js/plugin-proxy': { cli: '@modern-js/plugin-proxy/cli' },
+    '@modern-js/plugin-ssg': { cli: '@modern-js/plugin-ssg/cli' },
+    '@modern-js/plugin-bff': {
+        cli: '@modern-js/plugin-bff/cli',
+        server: '@modern-js/plugin-bff/server',
+    },
+    '@modern-js/plugin-electron': { cli: '@modern-js/plugin-electron/cli' },
+    '@modern-js/plugin-testing': { cli: '@modern-js/plugin-testing/cli' },
+    '@modern-js/plugin-storybook': { cli: '@modern-js/plugin-storybook/cli' },
+    '@modern-js/plugin-docsite': { cli: '@modern-js/plugin-docsite/cli' },
+    '@modern-js/plugin-express': {
+        cli: '@modern-js/plugin-express/cli',
+        server: '@modern-js/plugin-express',
+    },
+    '@modern-js/plugin-egg': {
+        cli: '@modern-js/plugin-egg/cli',
+        server: '@modern-js/plugin-egg',
+    },
+    '@modern-js/plugin-koa': {
+        cli: '@modern-js/plugin-koa/cli',
+        server: '@modern-js/plugin-koa',
+    },
+    '@modern-js/plugin-nest': {
+        cli: '@modern-js/plugin-nest/cli',
+        server: '@modern-js/plugin-nest/server',
+    },
+    '@modern-js/plugin-unbundle': { cli: '@modern-js/plugin-unbundle' },
+    '@modern-js/plugin-server-build': { cli: '@modern-js/plugin-server-build' },
+    '@modern-js/plugin-server': {
+        cli: '@modern-js/plugin-server/cli',
+        server: '@modern-js/plugin-server/server',
+    },
+    '@modern-js/plugin-garfish': {
+        cli: '@modern-js/plugin-garfish/cli',
+    },
+    '@modern-js/plugin-jarvis': { cli: '@modern-js/plugin-jarvis/cli' },
+    '@modern-js/plugin-tailwindcss': { cli: '@modern-js/plugin-tailwindcss/cli' },
+    '@modern-js/plugin-lambda-fc': { cli: '@modern-js/plugin-lambda-fc/cli' },
+    '@modern-js/plugin-lambda-scf': { cli: '@modern-js/plugin-lambda-scf/cli' },
+    '@modern-js/plugin-cdn-oss': { cli: '@modern-js/plugin-cdn-oss/cli' },
+    '@modern-js/plugin-cdn-cos': { cli: '@modern-js/plugin-cdn-cos/cli' },
+    '@modern-js/plugin-static-hosting': {
+        cli: '@modern-js/plugin-static-hosting/cli',
+    },
+    '@modern-js/plugin-polyfill': {
+        cli: '@modern-js/plugin-polyfill/cli',
+        server: '@modern-js/plugin-polyfill',
+    },
+    '@modern-js/plugin-multiprocess': {
+        cli: '@modern-js/plugin-multiprocess/cli',
+    },
+    '@modern-js/plugin-nocode': { cli: '@modern-js/plugin-nocode/cli' },
+    '@modern-js/plugin-design-token': {
+        cli: '@modern-js/plugin-design-token/cli',
+    },
+};
+/**
+ * The schema registered in the plugin.
+ */
+exports.PLUGIN_SCHEMAS = {
+    '@modern-js/runtime': [
+        {
+            target: 'runtime',
+            schema: {
+                type: 'object',
+                additionalProperties: false,
+            },
+        },
+        {
+            target: 'runtimeByEntries',
+            schema: {
+                type: 'object',
+                patternProperties: { [exports.ENTRY_NAME_PATTERN]: { type: 'object' } },
+                additionalProperties: false,
+            },
+        },
+    ],
+    '@modern-js/plugin-bff': [
+        {
+            target: 'bff',
+            schema: {
+                type: 'object',
+                properties: {
+                    prefix: {
+                        type: ['string', 'array'],
+                        items: { type: 'string' },
+                    },
+                    fetcher: { type: 'string' },
+                    proxy: { type: 'object' },
+                    requestCreator: { type: 'string' },
+                },
+            },
+        },
+    ],
+    '@modern-js/plugin-esbuild': [
+        {
+            target: 'tools.esbuild',
+            schema: { typeof: ['object'] },
+        },
+    ],
+    '@modern-js/plugin-less': [
+        {
+            target: 'tools.less',
+            schema: { typeof: ['object', 'function'] },
+        },
+    ],
+    '@modern-js/plugin-sass': [
+        {
+            target: 'tools.sass',
+            schema: { typeof: ['object', 'function'] },
+        },
+    ],
+    '@modern-js/plugin-tailwindcss': [
+        {
+            target: 'tools.tailwindcss',
+            schema: { typeof: ['object', 'function'] },
+        },
+    ],
+    '@modern-js/plugin-proxy': [
+        {
+            target: 'dev.proxy',
+            schema: { typeof: ['string', 'object'] },
+        },
+    ],
+    '@modern-js/plugin-unbundle': [
+        {
+            target: 'output.disableAutoImportStyle',
+            schema: { type: 'boolean' },
+        },
+        {
+            target: 'dev.unbundle',
+            schema: {
+                type: 'object',
+                properties: {
+                    ignore: {
+                        type: ['string', 'array'],
+                        items: { type: 'string' },
+                    },
+                    ignoreModuleCache: { type: 'boolean' },
+                    clearPdnCache: { type: 'boolean' },
+                    pdnHost: { type: 'string' },
+                },
+            },
+        },
+    ],
+    '@modern-js/plugin-ssg': [
+        {
+            target: 'output.ssg',
+            schema: {
+                oneOf: [
+                    { type: 'boolean' },
+                    { type: 'object' },
+                    { instanceof: 'Function' },
+                ],
+            },
+        },
+    ],
+    '@modern-js/plugin-ssr': [
+        {
+            target: 'runtime.ssr',
+            schema: { type: ['boolean', 'object'] },
+        },
+    ],
+    '@modern-js/plugin-state': [
+        {
+            target: 'runtime.state',
+            schema: { type: ['boolean', 'object'] },
+        },
+    ],
+    '@modern-js/plugin-design-token': [
+        // Legacy Features
+        {
+            target: 'source.designSystem',
+            schema: { typeof: ['object'] },
+        },
+        {
+            target: 'source.designSystem.supportStyledComponents',
+            schema: { type: ['boolean'] },
+        },
+    ],
+    '@modern-js/plugin-router': [
+        {
+            target: 'runtime.router',
+            schema: { type: ['boolean', 'object'] },
+        },
+    ],
+    '@modern-js/plugin-testing': [
+        {
+            target: 'testing',
+            schema: { typeof: ['object'] },
+        },
+        {
+            target: 'tools.jest',
+            schema: { typeof: ['object', 'function'] },
+        },
+    ],
+    '@modern-js/plugin-garfish': [
+        {
+            target: 'runtime.masterApp',
+            schema: { type: ['boolean', 'object'] },
+        },
+        {
+            target: 'dev.withMasterApp',
+            schema: { type: ['object'] },
+        },
+        {
+            target: 'deploy.microFrontend',
+            schema: { type: ['boolean', 'object'] },
+        },
+    ],
+    '@modern-js/plugin-nocode': [],
+};

package/dist/{js/modern/debug.js → debug.d.ts}

@@ -1,8 +1,6 @@
-import debug from 'debug';
 /**
  * Create debug function with unified namespace prefix.
  * @param scope - Custom module name of your debug function.
  * @returns Debug function which namespace start with modern-js:.
  */
-
-export const createDebugger = scope => debug(`modern-js:${scope}`);
+export declare const createDebugger: (scope: string) => import("../compiled/debug").Debugger;

package/dist/debug.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDebugger = void 0;
+const debug_1 = require("../compiled/debug");
+/**
+ * Create debug function with unified namespace prefix.
+ * @param scope - Custom module name of your debug function.
+ * @returns Debug function which namespace start with modern-js:.
+ */
+const createDebugger = (scope) => (0, debug_1.debug)(`modern-js:${scope}`);
+exports.createDebugger = createDebugger;

package/dist/emptyDir.d.ts

@@ -0,0 +1 @@
+export declare const emptyDir: (dir: string) => Promise<void>;

package/dist/emptyDir.js

@@ -0,0 +1,19 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emptyDir = void 0;
+const compiled_1 = require("./compiled");
+const emptyDir = (dir) => __awaiter(void 0, void 0, void 0, function* () {
+    if (yield compiled_1.fs.pathExists(dir)) {
+        yield compiled_1.fs.emptyDir(dir);
+    }
+});
+exports.emptyDir = emptyDir;

package/dist/{types/ensureAbsolutePath.d.ts → ensureAbsolutePath.d.ts}

@@ -4,4 +4,4 @@
  * @param filePath - Aboluste or relative file path.
  * @returns Resolved absolute file path.
  */
-export declare const ensureAbsolutePath: (base: string, filePath: string) => string;
+export declare const ensureAbsolutePath: (base: string, filePath: string) => string;

package/dist/ensureAbsolutePath.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureAbsolutePath = void 0;
+const path_1 = __importDefault(require("path"));
+/**
+ * ensure absolute file path.
+ * @param base - Base path to resolve relative from.
+ * @param filePath - Aboluste or relative file path.
+ * @returns Resolved absolute file path.
+ */
+const ensureAbsolutePath = (base, filePath) => path_1.default.isAbsolute(filePath) ? filePath : path_1.default.resolve(base, filePath);
+exports.ensureAbsolutePath = ensureAbsolutePath;

package/dist/{types/findExists.d.ts → findExists.d.ts}

@@ -3,4 +3,4 @@
  * @param files - Asbolute file paths with extension.
  * @returns The file path if exists, or false if no file exists.
  */
-export declare const findExists: (files: string[]) => string | false;
+export declare const findExists: (files: string[]) => string | false;

package/dist/findExists.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findExists = void 0;
+const fs_1 = __importDefault(require("fs"));
+/**
+ * Find first already exists file.
+ * @param files - Asbolute file paths with extension.
+ * @returns The file path if exists, or false if no file exists.
+ */
+const findExists = (files) => {
+    for (const file of files) {
+        if (fs_1.default.existsSync(file) && fs_1.default.statSync(file).isFile()) {
+            return file;
+        }
+    }
+    return false;
+};
+exports.findExists = findExists;

package/dist/{types/format.d.ts → format.d.ts}

@@ -6,11 +6,11 @@
  * https://github.com/facebook/create-react-app/blob/master/LICENSE
  */
 import { StatsCompilation } from 'webpack';
-import type { ProxyDetail, ProxyOptions } from '@modern-js/types';
+import type { ProxyDetail, BffProxyOptions } from '@modern-js/types';
 declare function formatWebpackMessages(json: StatsCompilation): {
-  errors: string[];
-  warnings: string[];
+    errors: string[];
+    warnings: string[];
 };
 export { formatWebpackMessages };
-declare function formatProxyOptions(proxyOptions: ProxyOptions): ProxyDetail[];
-export { formatProxyOptions };
+declare function formatProxyOptions(proxyOptions: BffProxyOptions): ProxyDetail[];
+export { formatProxyOptions };