@modern-js/app-tools 3.0.0-beta.0 → 3.0.0

package/dist/esm-node/commands/info.mjs

@@ -0,0 +1,77 @@
+import "node:module";
+import { getEntryOptions, isApiOnly } from "@modern-js/utils";
+import { isMainEntry } from "../utils/routes.mjs";
+const info = async (api, options = {})=>{
+    const normalizedConfig = api.getNormalizedConfig();
+    const appContext = api.getAppContext();
+    const hooks = api.getHooks();
+    const apiOnly = await isApiOnly(appContext.appDirectory, normalizedConfig.source?.entriesDir, appContext.apiDirectory);
+    if (apiOnly) {
+        const projectInfo = {
+            entries: [],
+            apiOnly: true
+        };
+        printProjectInfo(projectInfo, options.json);
+        return;
+    }
+    const [{ getBundleEntry }] = await Promise.all([
+        import("../plugins/analyze/getBundleEntry.mjs")
+    ]);
+    const { entrypoints } = await hooks.modifyEntrypoints.call({
+        entrypoints: await getBundleEntry(hooks, appContext, normalizedConfig)
+    });
+    const { source: { mainEntryName }, server: { ssr, ssrByEntries }, output: { ssg, ssgByEntries } } = normalizedConfig;
+    const { packageName } = appContext;
+    const entries = entrypoints.map((entrypoint)=>{
+        const { entryName, entry, isAutoMount, isCustomSourceEntry, customEntry } = entrypoint;
+        const isMain = isMainEntry(entryName, mainEntryName);
+        const ssrOptions = getEntryOptions(entryName, isMain, ssr, ssrByEntries, packageName);
+        const ssgOptions = getEntryOptions(entryName, isMain, ssg, ssgByEntries, packageName);
+        let ssrMode = false;
+        if (ssrOptions) {
+            if ('boolean' == typeof ssrOptions) ssrMode = 'stream';
+            else if ('object' == typeof ssrOptions) ssrMode = 'string' === ssrOptions.mode ? 'string' : 'stream';
+        }
+        return {
+            entryName,
+            isMainEntry: isMain,
+            entry,
+            isAutoMount: isAutoMount ?? true,
+            isCustomSourceEntry: isCustomSourceEntry ?? false,
+            customEntry: customEntry ?? false,
+            ssr: ssrMode,
+            ssg: Boolean(ssgOptions)
+        };
+    });
+    const projectInfo = {
+        entries,
+        apiOnly: false
+    };
+    printProjectInfo(projectInfo, options.json);
+};
+function printProjectInfo(projectInfo, jsonOnly) {
+    if (jsonOnly) return void console.log(JSON.stringify(projectInfo, null, 2));
+    console.log('');
+    console.log('===== Modern.js Project Info =====');
+    console.log('');
+    console.log(JSON.stringify(projectInfo, null, 2));
+    console.log('');
+    console.log('===== Entry Details =====');
+    console.log('');
+    if (projectInfo.apiOnly) return void console.log('This is an API-only project (no page entries).');
+    if (0 === projectInfo.entries.length) return void console.log('No entries found.');
+    for (const entry of projectInfo.entries){
+        console.log(`Entry: ${entry.entryName}`);
+        console.log(`  - Path: ${entry.entry}`);
+        console.log(`  - Main Entry: ${entry.isMainEntry}`);
+        console.log(`  - Auto Mount: ${entry.isAutoMount}`);
+        console.log(`  - Custom Entry: ${entry.customEntry}`);
+        console.log(`  - Custom Source Entry: ${entry.isCustomSourceEntry}`);
+        console.log("  - Rendering Mode:");
+        if (entry.ssg) console.log("    - SSG: enabled");
+        else if (entry.ssr) console.log(`    - SSR: ${entry.ssr} mode`);
+        else console.log("    - CSR: enabled (default)");
+        console.log('');
+    }
+}
+export { info };

package/dist/esm-node/commands/inspect.mjs

@@ -0,0 +1,16 @@
+import "node:module";
+const inspect = async (api, options)=>{
+    const appContext = api.getAppContext();
+    if (!appContext.builder) throw new Error('Expect the Builder to have been initialized, But the appContext.builder received `undefined`');
+    const metaName = 'modern-js' === appContext.metaName ? 'modern.js' : appContext.metaName;
+    return appContext.builder.inspectConfig({
+        mode: options.env,
+        verbose: options.verbose,
+        outputPath: options.output,
+        writeToDisk: true,
+        extraConfigs: {
+            [metaName]: api.getNormalizedConfig()
+        }
+    });
+};
+export { inspect };

package/dist/esm-node/commands/serve.mjs

@@ -0,0 +1,49 @@
+import "node:module";
+import path from "path";
+import { SERVER_DIR, getMeta, getTargetDir, isApiOnly, logger } from "@modern-js/utils";
+import { loadServerPlugins } from "../utils/loadPlugins.mjs";
+import { printInstructions } from "../utils/printInstructions.mjs";
+import * as __rspack_external__modern_js_prod_server_057184e2 from "@modern-js/prod-server";
+const serve = async (api, serverOptions)=>{
+    const appContext = api.getAppContext();
+    const userConfig = api.getNormalizedConfig();
+    const hooks = api.getHooks();
+    const { distDirectory, appDirectory, internalDirectory, port, metaName, serverRoutes } = appContext;
+    const { isCrossProjectServer } = userConfig?.bff || {};
+    logger.info("Starting production server...");
+    const apiOnly = await isApiOnly(appContext.appDirectory, userConfig?.source?.entriesDir, appContext.apiDirectory);
+    let runMode;
+    if (apiOnly) runMode = 'apiOnly';
+    const meta = getMeta(metaName);
+    const serverConfigPath = path.resolve(distDirectory, SERVER_DIR, `${meta}.server`);
+    const pluginInstances = await loadServerPlugins(api, appDirectory, metaName);
+    const app = await (serverOptions?.launcher || __rspack_external__modern_js_prod_server_057184e2.createProdServer)({
+        metaName,
+        pwd: distDirectory,
+        config: {
+            ...userConfig,
+            dev: userConfig.dev,
+            tools: userConfig.tools,
+            output: {
+                path: userConfig.output.distPath?.root,
+                ...userConfig.output || {}
+            }
+        },
+        routes: serverRoutes,
+        plugins: pluginInstances,
+        serverConfigPath,
+        appContext: {
+            appDirectory,
+            internalDirectory,
+            sharedDirectory: getTargetDir(appContext.sharedDirectory, appContext.appDirectory, appContext.distDirectory),
+            apiDirectory: isCrossProjectServer ? appContext.apiDirectory : getTargetDir(appContext.apiDirectory, appContext.appDirectory, appContext.distDirectory),
+            lambdaDirectory: isCrossProjectServer ? appContext.lambdaDirectory : getTargetDir(appContext.lambdaDirectory, appContext.appDirectory, appContext.distDirectory),
+            bffRuntimeFramework: appContext.bffRuntimeFramework
+        },
+        runMode
+    });
+    app.listen(port, async ()=>{
+        await printInstructions(hooks, appContext, userConfig);
+    });
+};
+export { serve };

package/dist/esm-node/compat/hooks.mjs

@@ -0,0 +1,68 @@
+import "node:module";
+import { getModifyHtmlPartials } from "../plugins/analyze/getHtmlTemplate.mjs";
+import { transformHookParams, transformHookResult, transformHookRunner } from "./utils.mjs";
+function getHookRunners(context) {
+    const { hooks } = context;
+    return {
+        afterPrepare: async ()=>hooks.onAfterPrepare.call(),
+        deploy: async ()=>hooks.deploy.call(),
+        _internalRuntimePlugins: async (params)=>hooks._internalRuntimePlugins.call(params),
+        _internalServerPlugins: async (params)=>hooks._internalServerPlugins.call(params),
+        checkEntryPoint: async (params)=>hooks.checkEntryPoint.call(params),
+        modifyEntrypoints: async (params)=>hooks.modifyEntrypoints.call(params),
+        modifyFileSystemRoutes: async (params)=>hooks.modifyFileSystemRoutes.call(params),
+        modifyServerRoutes: async (params)=>hooks.modifyServerRoutes.call(params),
+        generateEntryCode: async (params)=>hooks.generateEntryCode.call(params),
+        beforeGenerateRoutes: async (params)=>hooks.onBeforeGenerateRoutes.call(params),
+        beforePrintInstructions: async (params)=>hooks.onBeforePrintInstructions.call(params),
+        appendEntryCode: async (params)=>{
+            const result = await hooks?.appendEntryCode.call(params);
+            return result;
+        },
+        jestConfig: async (utils)=>{
+            const result = await hooks?.jestConfig.call(utils, (utils)=>utils);
+            return result;
+        },
+        afterTest: async ()=>hooks.afterTest.call(),
+        config: async ()=>hooks.config.call(),
+        resolvedConfig: (params)=>hooks.modifyResolvedConfig.call(params),
+        htmlPartials: async (params)=>{
+            await hooks.modifyHtmlPartials.call({
+                entrypoint: params.entrypoint,
+                partials: getModifyHtmlPartials(params.partials)
+            });
+            return {
+                partials: params.partials
+            };
+        },
+        commands: async (params)=>hooks.addCommand.call(params),
+        watchFiles: async ()=>hooks.addWatchFiles.call(),
+        prepare: async ()=>hooks.onPrepare.call(),
+        fileChange: async (params)=>hooks.onFileChanged.call(params),
+        beforeCreateCompiler: async (params)=>hooks.onBeforeCreateCompiler.call(params),
+        afterCreateCompiler: async (params)=>hooks.onAfterCreateCompiler.call(params),
+        beforeBuild: async (params)=>hooks.onBeforeBuild.call(params),
+        afterBuild: async (params)=>hooks.onAfterBuild.call(params),
+        beforeDev: async ()=>hooks.onBeforeDev.call(),
+        afterDev: async (params)=>hooks.onDevCompileDone.call(params),
+        beforeDeploy: async (options)=>hooks.onBeforeDeploy.call(options),
+        afterDeploy: async (options)=>hooks.onAfterDeploy.call(options),
+        beforeExit: async ()=>hooks.onBeforeExit.call(),
+        beforeRestart: async ()=>hooks.onBeforeRestart.call()
+    };
+}
+function handleSetupResult(setupResult, api) {
+    if (!setupResult) return;
+    Object.keys(setupResult).forEach((key)=>{
+        const fn = setupResult[key];
+        if ('function' == typeof fn) {
+            const newAPI = transformHookRunner(key);
+            if (newAPI && api[newAPI]) api[newAPI](async (...params)=>{
+                const { isMultiple, params: transformParams } = transformHookParams(key, params);
+                if (isMultiple) return transformHookResult(key, await fn(...transformParams));
+                return transformHookResult(key, await fn(transformParams));
+            });
+        }
+    });
+}
+export { getHookRunners, handleSetupResult };

package/dist/esm-node/compat/index.mjs

@@ -0,0 +1,29 @@
+import "node:module";
+import { createAsyncHook } from "@modern-js/plugin";
+import { getHookRunners } from "./hooks.mjs";
+const compatPlugin = ()=>({
+        name: '@modern-js/app-tools-compat',
+        _registryApi: (getAppContext, updateAppContext)=>{
+            const getInternalContext = ()=>getAppContext()._internalContext;
+            return {
+                useAppContext: ()=>{
+                    const { _internalContext, ...appContext } = getAppContext();
+                    return appContext;
+                },
+                setAppContext: (context)=>updateAppContext(context),
+                useConfigContext: ()=>getInternalContext().config,
+                useResolvedConfigContext: ()=>getInternalContext().normalizedConfig,
+                useHookRunners: ()=>getHookRunners(getInternalContext())
+            };
+        },
+        registryHooks: {
+            jestConfig: createAsyncHook(),
+            afterTest: createAsyncHook()
+        },
+        setup: (api)=>{
+            api.updateAppContext({
+                toolsType: 'app-tools'
+            });
+        }
+    });
+export { compatPlugin };

package/dist/esm-node/compat/utils.mjs

@@ -0,0 +1,96 @@
+import "node:module";
+import { getModifyHtmlPartials } from "../plugins/analyze/getHtmlTemplate.mjs";
+function transformHookRunner(hookRunnerName) {
+    switch(hookRunnerName){
+        case 'beforeConfig':
+            console.error('The `beforeConfig` hook has been deprecated. Please define your code directly in the setup function instead.');
+            return;
+        case 'prepare':
+            return 'onPrepare';
+        case 'afterPrepare':
+            return 'onAfterPrepare';
+        case 'beforeGenerateRoutes':
+            return 'onBeforeGenerateRoutes';
+        case 'beforePrintInstructions':
+            return 'onBeforePrintInstructions';
+        case 'resolvedConfig':
+            return 'modifyResolvedConfig';
+        case 'commands':
+            return 'addCommand';
+        case 'watchFiles':
+            return 'addWatchFiles';
+        case 'fileChange':
+            return 'onFileChanged';
+        case 'beforeCreateCompiler':
+            return 'onBeforeCreateCompiler';
+        case 'afterCreateCompiler':
+            return 'onAfterCreateCompiler';
+        case 'beforeBuild':
+            return 'onBeforeBuild';
+        case 'afterBuild':
+            return 'onAfterBuild';
+        case 'beforeDev':
+            return 'onBeforeDev';
+        case 'afterDev':
+            return 'onDevCompileDone';
+        case 'beforeDeploy':
+            return 'onBeforeDeploy';
+        case 'afterDeploy':
+            return 'onAfterDeploy';
+        case 'beforeExit':
+            return 'onBeforeExit';
+        case 'beforeRestart':
+            return 'onBeforeRestart';
+        case 'htmlPartials':
+            return 'modifyHtmlPartials';
+        default:
+            return hookRunnerName;
+    }
+}
+function transformHookParams(hookRunnerName, params) {
+    switch(hookRunnerName){
+        case 'resolvedConfig':
+            return {
+                isMultiple: false,
+                params: {
+                    resolved: params[0]
+                }
+            };
+        case 'htmlPartials':
+            return {
+                isMultiple: false,
+                params: {
+                    partials: {
+                        top: params[0].partials.top.current,
+                        head: params[0].partials.head.current,
+                        body: params[0].partials.body.current
+                    },
+                    entrypoint: params[0].entrypoint
+                }
+            };
+        case 'jestConfig':
+            return {
+                isMultiple: true,
+                params: params
+            };
+        default:
+            return {
+                isMultiple: false,
+                params: params[0]
+            };
+    }
+}
+function transformHookResult(hookRunnerName, result) {
+    switch(hookRunnerName){
+        case 'resolvedConfig':
+            return result.resolved;
+        case 'htmlPartials':
+            return {
+                partials: getModifyHtmlPartials(result.partials),
+                entrypoint: result.entrypoint
+            };
+        default:
+            return result;
+    }
+}
+export { transformHookParams, transformHookResult, transformHookRunner };

package/dist/esm-node/config/default.mjs

@@ -0,0 +1,91 @@
+import "node:module";
+import { DEFAULT_ENTRY_NAME } from "@modern-js/utils";
+import { getAutoInjectEnv } from "../utils/env.mjs";
+function createDefaultConfig(appContext) {
+    const dev = {
+        cliShortcuts: {
+            help: false,
+            custom: (shortcuts = [])=>shortcuts.filter(({ key })=>'r' !== key && 'u' !== key)
+        }
+    };
+    const output = {
+        distPath: {
+            root: 'dist',
+            html: 'html',
+            js: 'static/js',
+            css: 'static/css',
+            server: 'bundles',
+            worker: 'worker'
+        },
+        cleanDistPath: true,
+        enableInlineRouteManifests: true,
+        disableInlineRouteManifests: false
+    };
+    const source = {
+        entries: void 0,
+        mainEntryName: DEFAULT_ENTRY_NAME,
+        enableAsyncEntry: false,
+        disableDefaultEntries: false,
+        entriesDir: './src',
+        configDir: './config',
+        globalVars: getAutoInjectEnv(appContext),
+        alias: {}
+    };
+    const resolve = {
+        alias: {
+            [appContext.internalDirAlias]: appContext.internalDirectory,
+            [appContext.internalSrcAlias]: appContext.srcDirectory,
+            '@': appContext.srcDirectory,
+            '@shared': appContext.sharedDirectory
+        }
+    };
+    const html = {
+        title: '',
+        mountId: 'root',
+        meta: {
+            charset: {
+                charset: 'utf-8'
+            },
+            viewport: 'width=device-width, initial-scale=1.0, shrink-to-fit=no, viewport-fit=cover, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no',
+            'http-equiv': {
+                'http-equiv': 'x-ua-compatible',
+                content: 'ie=edge'
+            },
+            renderer: 'webkit',
+            layoutmode: 'standard',
+            imagemode: 'force',
+            'wap-font-scale': 'no',
+            'format-detection': 'telephone=no'
+        }
+    };
+    const server = {
+        routes: void 0,
+        publicRoutes: void 0,
+        ssr: void 0,
+        ssrByEntries: void 0,
+        baseUrl: '/',
+        port: 8080
+    };
+    return {
+        source,
+        resolve,
+        output,
+        server,
+        dev,
+        html,
+        tools: {
+            tsChecker: {
+                issue: {
+                    exclude: [
+                        {
+                            file: '**/api/lambda/**/*'
+                        }
+                    ]
+                }
+            }
+        },
+        plugins: [],
+        builderPlugins: []
+    };
+}
+export { createDefaultConfig };

package/dist/esm-node/config/index.mjs

@@ -0,0 +1,3 @@
+import "node:module";
+export * from "./initialize/index.mjs";
+export * from "./default.mjs";

package/dist/esm-node/config/initialize/index.mjs

@@ -0,0 +1,8 @@
+import "node:module";
+import { initHtmlConfig, initSourceConfig } from "./inits.mjs";
+function initialNormalizedConfig(config, appContext) {
+    initHtmlConfig(config, appContext);
+    initSourceConfig(config, appContext);
+    return config;
+}
+export { initialNormalizedConfig };

package/dist/esm-node/config/initialize/inits.mjs

@@ -0,0 +1,55 @@
+import "node:module";
+import path, { isAbsolute } from "path";
+import { findExists } from "@modern-js/utils";
+function initHtmlConfig(config, appContext) {
+    const ICON_EXTENSIONS = [
+        'png',
+        'jpg',
+        'jpeg',
+        'svg',
+        'ico'
+    ];
+    config.html.appIcon = createBuilderAppIcon(config, appContext);
+    config.html.favicon = createBuilderFavicon(config, appContext);
+    return config.html;
+    function createBuilderAppIcon(config, appContext) {
+        const { appIcon } = config.html;
+        const { configDir } = config.source;
+        const getDefaultAppIcon = ()=>{
+            const appIconPath = findExists(ICON_EXTENSIONS.map((ext)=>path.resolve(appContext.appDirectory, configDir || './config', `icon.${ext}`)));
+            return appIconPath ? {
+                icons: [
+                    {
+                        src: appIconPath,
+                        size: 180
+                    }
+                ]
+            } : void 0;
+        };
+        return appIcon || getDefaultAppIcon() || void 0;
+    }
+    function createBuilderFavicon(config, appContext) {
+        const { configDir } = config.source;
+        const { favicon } = config.html;
+        const getDefaultFavicon = ()=>findExists(ICON_EXTENSIONS.map((ext)=>path.resolve(appContext.appDirectory, configDir || './config', `favicon.${ext}`)));
+        return favicon || getDefaultFavicon() || void 0;
+    }
+}
+function initSourceConfig(config, appContext) {
+    config.source.include = createBuilderInclude(config, appContext);
+}
+function createBuilderInclude(config, appContext) {
+    const { include } = config.source;
+    const defaultInclude = [
+        appContext.internalDirectory
+    ];
+    const transformInclude = (include || []).map((include)=>{
+        if ('string' == typeof include) {
+            if (isAbsolute(include)) return include;
+            return new RegExp(include);
+        }
+        return include;
+    }).concat(defaultInclude);
+    return transformInclude;
+}
+export { initHtmlConfig, initSourceConfig };

package/dist/esm-node/constants.mjs

@@ -0,0 +1,4 @@
+import "node:module";
+const DEFAULT_CONFIG_FILE = 'modern.config';
+const DEFAULT_RUNTIME_CONFIG_FILE = 'modern.runtime';
+export { DEFAULT_CONFIG_FILE, DEFAULT_RUNTIME_CONFIG_FILE };

package/dist/esm-node/defineConfig.mjs

@@ -0,0 +1,3 @@
+import "node:module";
+const defineConfig = (config)=>config;
+export { defineConfig };

package/dist/esm-node/esm/register-esm.mjs

@@ -0,0 +1,33 @@
+import "node:module";
+import { fs } from "@modern-js/utils";
+import * as __rspack_external_node_path_c5b9b54f from "node:path";
+const checkDepExist = async (dep)=>{
+    try {
+        await import(dep);
+        return true;
+    } catch  {
+        return false;
+    }
+};
+const registerModuleHooks = async ({ appDir, distDir, alias })=>{
+    const TS_CONFIG_FILENAME = "tsconfig.json";
+    const tsconfigPath = __rspack_external_node_path_c5b9b54f["default"].resolve(appDir, TS_CONFIG_FILENAME);
+    const hasTsconfig = await fs.pathExists(tsconfigPath);
+    const hasTsNode = await checkDepExist('ts-node');
+    if (!hasTsconfig || !hasTsNode) return;
+    const { register } = await import("node:module");
+    process.env.TS_NODE_TRANSPILE_ONLY = true;
+    process.env.TS_NODE_PROJECT = tsconfigPath;
+    process.env.TS_NODE_SCOPE = true;
+    process.env.TS_NODE_FILES = true;
+    process.env.TS_NODE_IGNORE = `(?:^|/)node_modules/,(?:^|/)${__rspack_external_node_path_c5b9b54f["default"].relative(appDir, distDir)}/`;
+    register('./ts-node-loader.mjs', import.meta.url, {
+        data: {
+            appDir,
+            distDir,
+            alias,
+            tsconfigPath
+        }
+    });
+};
+export { registerModuleHooks };

package/dist/esm-node/esm/ts-node-loader.mjs

@@ -0,0 +1,23 @@
+import "node:module";
+import { pathToFileURL } from "url";
+import { load, resolve } from "ts-node/esm";
+import { createMatchPath } from "./utils.mjs";
+let matchPath;
+async function initialize({ appDir, alias, tsconfigPath }) {
+    matchPath = createMatchPath({
+        alias,
+        appDir,
+        tsconfigPath
+    });
+}
+function ts_node_loader_resolve(specifier, context, defaultResolve) {
+    const match = matchPath(specifier);
+    return match ? resolve(pathToFileURL(match).href, context, defaultResolve) : resolve(specifier, context, defaultResolve);
+}
+function ts_node_loader_load(url, context, defaultLoad) {
+    const filePath = new URL(url).pathname;
+    if (url.startsWith('node:')) return defaultLoad(url, context);
+    if (filePath.includes('node_modules')) return defaultLoad(url, context);
+    return load(url, context, defaultLoad);
+}
+export { initialize, ts_node_loader_load as load, ts_node_loader_resolve as resolve };

package/dist/esm-node/esm/utils.mjs

@@ -0,0 +1,33 @@
+import "node:module";
+import { createRequire } from "module";
+import path from "path";
+import { getAliasConfig } from "@modern-js/utils";
+import { createMatchPath } from "@modern-js/utils/tsconfig-paths";
+const utils_require = createRequire(import.meta.url);
+function utils_createMatchPath({ alias, appDir, tsconfigPath }) {
+    const aliasConfig = getAliasConfig(alias, {
+        appDirectory: appDir,
+        tsconfigPath
+    });
+    const { paths = {}, absoluteBaseUrl = './' } = aliasConfig;
+    const tsPaths = Object.keys(paths).reduce((o, key)=>{
+        let tsPath = paths[key];
+        if ('string' == typeof tsPath && key.startsWith('@') && tsPath.startsWith('@')) try {
+            tsPath = utils_require.resolve(tsPath, {
+                paths: [
+                    appDir
+                ]
+            });
+        } catch  {}
+        if ('string' == typeof tsPath && path.isAbsolute(tsPath)) tsPath = path.relative(absoluteBaseUrl, tsPath);
+        if ('string' == typeof tsPath) tsPath = [
+            tsPath
+        ];
+        return {
+            ...o,
+            [`${key}`]: tsPath
+        };
+    }, {});
+    return createMatchPath(absoluteBaseUrl, tsPaths);
+}
+export { utils_createMatchPath as createMatchPath };

package/dist/esm-node/exports/server.mjs

@@ -0,0 +1 @@
+import "node:module";