@modern-js/runtime 2.52.0 → 2.54.0

package/dist/esm-node/router/cli/code/getClientRoutes/getRoutes.js

@@ -0,0 +1,163 @@
+import path from "path";
+import { fs } from "@modern-js/utils";
+import { makeLegalIdentifier } from "../makeLegalIdentifier";
+import { FILE_SYSTEM_ROUTES_COMPONENTS_DIR, FILE_SYSTEM_ROUTES_DYNAMIC_REGEXP, FILE_SYSTEM_ROUTES_INDEX, FILE_SYSTEM_ROUTES_LAYOUT } from "../../constants";
+import { replaceWithAlias } from "../utils";
+import { debug, findLayout, shouldSkip, getRouteWeight } from "./utils";
+const compName = (srcDirectory, filePath) => {
+  const legalCompName = makeLegalIdentifier(path.relative(srcDirectory, filePath));
+  return `Comp_${legalCompName}`;
+};
+const layoutNameAbbr = (filePath) => {
+  const prefix = "L_";
+  const dirName = path.dirname(filePath).split("/").pop() || "";
+  return `${prefix}${makeLegalIdentifier(dirName)}`;
+};
+const parents = [];
+const recursiveReadDir = ({ dir, routes, basePath = "/", srcDirectory, srcAlias }) => {
+  let hasDynamicRoute = false;
+  let resetParent = false;
+  let parent = parents[parents.length - 1];
+  const layout = findLayout(dir);
+  if (layout) {
+    if (basePath === "/") {
+      throw new Error(`should use _app instead of _layout in ${dir}`);
+    } else {
+      const alias = replaceWithAlias(srcDirectory, layout, srcAlias);
+      const componentName = compName(srcDirectory, layout);
+      const route = {
+        path: `${basePath.substring(0, basePath.length - 1)}`,
+        children: [],
+        _component: alias,
+        component: componentName,
+        parent,
+        type: "page"
+      };
+      parent = route;
+      resetParent = true;
+      routes.push(route);
+      parents.push(route);
+      routes = route.children;
+    }
+  }
+  for (const relative of fs.readdirSync(dir)) {
+    const filePath = path.join(dir, relative);
+    if (!shouldSkip(filePath)) {
+      const filename = path.basename(filePath, path.extname(filePath));
+      const alias = replaceWithAlias(srcDirectory, filePath, srcAlias);
+      const componentName = compName(srcDirectory, filePath);
+      const dynamicRouteMatched = FILE_SYSTEM_ROUTES_DYNAMIC_REGEXP.exec(filename);
+      if (dynamicRouteMatched) {
+        if (hasDynamicRoute) {
+          throw new Error(`Can't set two dynamic route in one directory: ${dir}`);
+        } else {
+          hasDynamicRoute = true;
+        }
+      }
+      const route = {
+        path: `${basePath}${dynamicRouteMatched ? `:${dynamicRouteMatched[1].replace(/\$$/, "?")}${dynamicRouteMatched[2]}` : filename}`,
+        _component: alias,
+        component: componentName,
+        parent,
+        type: "page"
+      };
+      if (fs.statSync(filePath).isDirectory()) {
+        recursiveReadDir({
+          dir: filePath,
+          routes,
+          basePath: `${route.path}/`,
+          srcDirectory,
+          srcAlias
+        });
+        continue;
+      }
+      if (filename === FILE_SYSTEM_ROUTES_LAYOUT) {
+        continue;
+      }
+      if (filename === FILE_SYSTEM_ROUTES_INDEX) {
+        route.path = basePath === "/" ? basePath : `${basePath.substring(0, basePath.length - 1)}`;
+      }
+      if (filename === "404" && basePath === "/") {
+        route.path = "*";
+      }
+      routes.push(route);
+    }
+  }
+  if (resetParent) {
+    parents.pop();
+  }
+};
+const normalizeNestedRoutes = (nested, internalComponentsDir, internalDirectory, internalDirAlias) => {
+  const flat = (routes) => routes.reduce((memo, route) => memo.concat(Array.isArray(route.children) ? flat(route.children) : [
+    route
+  ]), []);
+  const generate = (route) => {
+    const codes = [];
+    let lastComponent = route.component;
+    const imports = [
+      `import React from 'react';`,
+      `import ${lastComponent} from '${route._component}'`
+    ];
+    while (route = route.parent) {
+      const layoutComponent = route.component;
+      const layoutComponentAbbr = layoutNameAbbr(route._component);
+      imports.push(`import ${layoutComponent} from '${route._component}';`);
+      const currentComponent = `${layoutComponentAbbr}_${lastComponent}`;
+      codes.push(`const ${currentComponent} = props => <${layoutComponent} Component={${lastComponent}} {...props} />;`);
+      lastComponent = currentComponent;
+    }
+    const file = path.resolve(internalComponentsDir, `${lastComponent}.jsx`);
+    fs.outputFileSync(file, `${imports.join("\n")}
+${codes.join("\n")}
+export default ${lastComponent}`);
+    return {
+      component: lastComponent,
+      _component: replaceWithAlias(internalDirectory, file, internalDirAlias)
+    };
+  };
+  const normalized = flat(nested).map((route) => route.parent ? {
+    ...route,
+    ...generate(route),
+    parent: void 0
+  } : {
+    ...route,
+    parent: void 0
+  });
+  return normalized;
+};
+const getClientRoutes = ({ entrypoint, srcDirectory, srcAlias, internalDirectory, internalDirAlias }) => {
+  const { entryName, pageRoutesEntry } = entrypoint;
+  if (!pageRoutesEntry) {
+    return [];
+  }
+  if (!fs.existsSync(pageRoutesEntry)) {
+    throw new Error(`generate file system routes error, ${pageRoutesEntry} directory not found.`);
+  }
+  if (!(fs.existsSync(pageRoutesEntry) && fs.statSync(pageRoutesEntry).isDirectory())) {
+    throw new Error(`generate file system routes error, ${pageRoutesEntry} should be directory.`);
+  }
+  let routes = [];
+  recursiveReadDir({
+    dir: pageRoutesEntry,
+    routes,
+    basePath: "/",
+    srcDirectory,
+    srcAlias
+  });
+  const internalComponentsDir = path.resolve(internalDirectory, `${entryName}/${FILE_SYSTEM_ROUTES_COMPONENTS_DIR}`);
+  fs.emptyDirSync(internalComponentsDir);
+  routes = normalizeNestedRoutes(routes, internalComponentsDir, internalDirectory, internalDirAlias);
+  parents.length = 0;
+  routes.sort((a, b) => {
+    const delta = getRouteWeight(a.path) - getRouteWeight(b.path);
+    if (delta === 0) {
+      return a.path.length - b.path.length;
+    }
+    return delta;
+  });
+  debug(`fileSystem routes: %o`, routes);
+  return routes;
+};
+export {
+  getClientRoutes
+};

package/dist/esm-node/router/cli/code/getClientRoutes/getRoutesLegacy.js

@@ -0,0 +1,161 @@
+import path from "path";
+import { fs } from "@modern-js/utils";
+import { FILE_SYSTEM_ROUTES_COMPONENTS_DIR, FILE_SYSTEM_ROUTES_DYNAMIC_REGEXP, FILE_SYSTEM_ROUTES_INDEX, FILE_SYSTEM_ROUTES_LAYOUT } from "../../constants";
+import { replaceWithAlias } from "../utils";
+import { makeLegalIdentifier } from "../makeLegalIdentifier";
+import { debug, findLayout, shouldSkip, getRouteWeight } from "./utils";
+const compName = (srcDirectory, filePath) => {
+  const legalCompName = makeLegalIdentifier(path.relative(srcDirectory, filePath));
+  return `Comp_${legalCompName}`;
+};
+const layoutNameAbbr = (filePath) => {
+  const prefix = "L_";
+  const dirName = path.dirname(filePath).split("/").pop() || "";
+  return `${prefix}${makeLegalIdentifier(dirName)}`;
+};
+const parents = [];
+const recursiveReadDirLegacy = ({ dir, routes, basePath = "/", srcDirectory, srcAlias }) => {
+  let hasDynamicRoute = false;
+  let resetParent = false;
+  let parent = parents[parents.length - 1];
+  const layout = findLayout(dir);
+  if (layout) {
+    if (basePath === "/") {
+      throw new Error(`should use _app instead of _layout in ${dir}`);
+    } else {
+      const alias = replaceWithAlias(srcDirectory, layout, srcAlias);
+      const componentName = compName(srcDirectory, layout);
+      const route = {
+        path: `${basePath.substring(0, basePath.length - 1)}`,
+        exact: false,
+        routes: [],
+        _component: alias,
+        component: componentName,
+        parent
+      };
+      parent = route;
+      resetParent = true;
+      routes.push(route);
+      parents.push(route);
+      routes = route.routes;
+    }
+  }
+  for (const relative of fs.readdirSync(dir)) {
+    const filePath = path.join(dir, relative);
+    if (!shouldSkip(filePath)) {
+      const filename = path.basename(filePath, path.extname(filePath));
+      const alias = replaceWithAlias(srcDirectory, filePath, srcAlias);
+      const componentName = compName(srcDirectory, filePath);
+      const dynamicRouteMatched = FILE_SYSTEM_ROUTES_DYNAMIC_REGEXP.exec(filename);
+      if (dynamicRouteMatched) {
+        if (hasDynamicRoute) {
+          throw new Error(`Can't set two dynamic route in one directory: ${dir}`);
+        } else {
+          hasDynamicRoute = true;
+        }
+      }
+      const route = {
+        path: `${basePath}${dynamicRouteMatched ? `:${dynamicRouteMatched[1].replace(/\$$/, "?")}${dynamicRouteMatched[2]}` : filename}`,
+        _component: alias,
+        component: componentName,
+        exact: true,
+        parent
+      };
+      if (fs.statSync(filePath).isDirectory()) {
+        recursiveReadDirLegacy({
+          dir: filePath,
+          routes,
+          basePath: `${route.path}/`,
+          srcDirectory,
+          srcAlias
+        });
+        continue;
+      }
+      if (filename === FILE_SYSTEM_ROUTES_LAYOUT) {
+        continue;
+      }
+      if (filename === FILE_SYSTEM_ROUTES_INDEX) {
+        route.path = basePath === "/" ? basePath : `${basePath.substring(0, basePath.length - 1)}`;
+      }
+      if (filename === "404" && basePath === "/") {
+        route.path = "*";
+        route.exact = false;
+      }
+      routes.push(route);
+    }
+  }
+  if (resetParent) {
+    parents.pop();
+  }
+};
+const normalizeNestedRoutes = (nested, internalComponentsDir, internalDirectory, internalDirAlias) => {
+  const flat = (routes) => routes.reduce((memo, route) => memo.concat(Array.isArray(route.routes) ? flat(route.routes) : [
+    route
+  ]), []);
+  const generate = (route) => {
+    const codes = [];
+    let lastComponent = route.component;
+    const imports = [
+      `import React from 'react';`,
+      `import ${lastComponent} from '${route._component}'`
+    ];
+    while (route = route.parent) {
+      const layoutComponent = route.component;
+      const layoutComponentAbbr = layoutNameAbbr(route._component);
+      imports.push(`import ${layoutComponent} from '${route._component}';`);
+      const currentComponent = `${layoutComponentAbbr}_${lastComponent}`;
+      codes.push(`const ${currentComponent} = props => <${layoutComponent} Component={${lastComponent}} {...props} />;`);
+      lastComponent = currentComponent;
+    }
+    const file = path.resolve(internalComponentsDir, `${lastComponent}.jsx`);
+    fs.outputFileSync(file, `${imports.join("\n")}
+${codes.join("\n")}
+export default ${lastComponent}`);
+    return {
+      component: lastComponent,
+      _component: replaceWithAlias(internalDirectory, file, internalDirAlias)
+    };
+  };
+  const normalized = flat(nested).map((route) => route.parent ? {
+    ...route,
+    ...generate(route),
+    parent: void 0
+  } : {
+    ...route,
+    parent: void 0
+  });
+  return normalized;
+};
+const getClientRoutes = ({ entrypoint, srcDirectory, srcAlias, internalDirectory, internalDirAlias }) => {
+  const { entry, entryName } = entrypoint;
+  if (!fs.existsSync(entry)) {
+    throw new Error(`generate file system routes error, ${entry} directory not found.`);
+  }
+  if (!(fs.existsSync(entry) && fs.statSync(entry).isDirectory())) {
+    throw new Error(`generate file system routes error, ${entry} should be directory.`);
+  }
+  let routes = [];
+  recursiveReadDirLegacy({
+    dir: entry,
+    routes,
+    basePath: "/",
+    srcDirectory,
+    srcAlias
+  });
+  const internalComponentsDir = path.resolve(internalDirectory, `${entryName}/${FILE_SYSTEM_ROUTES_COMPONENTS_DIR}`);
+  fs.emptyDirSync(internalComponentsDir);
+  routes = normalizeNestedRoutes(routes, internalComponentsDir, internalDirectory, internalDirAlias);
+  parents.length = 0;
+  routes.sort((a, b) => {
+    const delta = getRouteWeight(a.path) - getRouteWeight(b.path);
+    if (delta === 0) {
+      return a.path.length - b.path.length;
+    }
+    return delta;
+  });
+  debug(`fileSystem routes: %o`, routes);
+  return routes;
+};
+export {
+  getClientRoutes
+};

package/dist/esm-node/router/cli/code/getClientRoutes/index.js

@@ -0,0 +1,6 @@
+import { getClientRoutes } from "./getRoutes";
+import { getClientRoutes as getClientRoutes2 } from "./getRoutesLegacy";
+export {
+  getClientRoutes,
+  getClientRoutes2 as getClientRoutesLegacy
+};

package/dist/esm-node/router/cli/code/getClientRoutes/utils.js

@@ -0,0 +1,22 @@
+import path from "path";
+import { JS_EXTENSIONS, createDebugger, findExists, fs } from "@modern-js/utils";
+import { FILE_SYSTEM_ROUTES_LAYOUT, FILE_SYSTEM_ROUTES_GLOBAL_LAYOUT, FILE_SYSTEM_ROUTES_IGNORED_REGEX } from "../../constants";
+const debug = createDebugger("get-client-routes");
+const findLayout = (dir) => findExists(JS_EXTENSIONS.map((ext) => path.resolve(dir, `${FILE_SYSTEM_ROUTES_LAYOUT}${ext}`)));
+const getRouteWeight = (route) => route === "*" ? 999 : route.split(":").length - 1;
+const shouldSkip = (file) => {
+  if (fs.statSync(file).isDirectory()) {
+    return false;
+  }
+  const ext = path.extname(file);
+  if (FILE_SYSTEM_ROUTES_IGNORED_REGEX.test(file) || !JS_EXTENSIONS.includes(ext) || FILE_SYSTEM_ROUTES_GLOBAL_LAYOUT === path.basename(file, ext)) {
+    return true;
+  }
+  return false;
+};
+export {
+  debug,
+  findLayout,
+  getRouteWeight,
+  shouldSkip
+};

package/dist/esm-node/router/cli/code/index.js

@@ -0,0 +1,100 @@
+import path from "path";
+import { fs, getEntryOptions, isRouterV5, isSSGEntry, isUseSSRBundle, logger } from "@modern-js/utils";
+import { FILE_SYSTEM_ROUTES_FILE_NAME } from "../constants";
+import * as templates from "./templates";
+import { getClientRoutes, getClientRoutesLegacy } from "./getClientRoutes";
+import { getServerLoadersFile, getServerCombinedModueFile } from "./utils";
+import { walk } from "./nestedRoutes";
+const generateCode = async (appContext, config, entrypoints, api) => {
+  const { internalDirectory, srcDirectory, internalDirAlias, internalSrcAlias, packageName } = appContext;
+  const hookRunners = api.useHookRunners();
+  const isV5 = isRouterV5(config);
+  const getRoutes = isV5 ? getClientRoutesLegacy : getClientRoutes;
+  const importsStatemets = /* @__PURE__ */ new Map();
+  const oldVersion = typeof (config === null || config === void 0 ? void 0 : config.runtime.router) === "object" ? Boolean((config === null || config === void 0 ? void 0 : config.runtime.router).oldVersion) : false;
+  await Promise.all(entrypoints.map(generateEntryCode));
+  return {
+    importsStatemets
+  };
+  async function generateEntryCode(entrypoint) {
+    const { entryName, isMainEntry, isAutoMount, fileSystemRoutes } = entrypoint;
+    if (isAutoMount) {
+      if (fileSystemRoutes) {
+        var _config_output;
+        let initialRoutes = [];
+        let nestedRoutes = null;
+        if (entrypoint.entry) {
+          initialRoutes = getRoutes({
+            entrypoint,
+            srcDirectory,
+            srcAlias: internalSrcAlias,
+            internalDirectory,
+            internalDirAlias
+          });
+        }
+        if (!isV5 && entrypoint.nestedRoutesEntry) {
+          nestedRoutes = await walk(entrypoint.nestedRoutesEntry, entrypoint.nestedRoutesEntry, {
+            name: internalSrcAlias,
+            basename: srcDirectory
+          }, entrypoint.entryName, entrypoint.isMainEntry, oldVersion);
+          if (nestedRoutes) {
+            if (!Array.isArray(nestedRoutes)) {
+              nestedRoutes = [
+                nestedRoutes
+              ];
+            }
+            for (const route of nestedRoutes) {
+              initialRoutes.unshift(route);
+            }
+          }
+        }
+        const { routes } = await hookRunners.modifyFileSystemRoutes({
+          entrypoint,
+          routes: initialRoutes
+        });
+        const config2 = api.useResolvedConfigContext();
+        const ssr = getEntryOptions(entryName, isMainEntry, config2.server.ssr, config2.server.ssrByEntries, packageName);
+        const useSSG = isSSGEntry(config2, entryName, entrypoints);
+        let mode;
+        if (ssr) {
+          mode = typeof ssr === "object" ? ssr.mode || "string" : "string";
+        }
+        if (mode === "stream") {
+          const hasPageRoute = routes.some((route) => "type" in route && route.type === "page");
+          if (hasPageRoute) {
+            logger.error("Streaming ssr is not supported when pages dir exists");
+            process.exit(1);
+          }
+        }
+        const { code } = await hookRunners.beforeGenerateRoutes({
+          entrypoint,
+          code: await templates.fileSystemRoutes({
+            routes,
+            ssrMode: useSSG ? "string" : mode,
+            nestedRoutesEntry: entrypoint.nestedRoutesEntry,
+            entryName: entrypoint.entryName,
+            internalDirectory,
+            splitRouteChunks: config2 === null || config2 === void 0 ? void 0 : (_config_output = config2.output) === null || _config_output === void 0 ? void 0 : _config_output.splitRouteChunks
+          })
+        });
+        if (entrypoint.nestedRoutesEntry && isUseSSRBundle(config2)) {
+          const routesServerFile = getServerLoadersFile(internalDirectory, entryName);
+          const code2 = templates.routesForServer({
+            routes
+          });
+          await fs.ensureFile(routesServerFile);
+          await fs.writeFile(routesServerFile, code2);
+        }
+        const serverLoaderCombined = templates.ssrLoaderCombinedModule(entrypoints, entrypoint, config2, appContext);
+        if (serverLoaderCombined) {
+          const serverLoaderFile = getServerCombinedModueFile(internalDirectory, entryName);
+          await fs.outputFile(serverLoaderFile, serverLoaderCombined);
+        }
+        fs.outputFileSync(path.resolve(internalDirectory, `./${entryName}/${FILE_SYSTEM_ROUTES_FILE_NAME}`), code, "utf8");
+      }
+    }
+  }
+};
+export {
+  generateCode
+};

package/dist/esm-node/router/cli/code/makeLegalIdentifier.js

@@ -0,0 +1,13 @@
+const reservedWords = "break case class catch const continue debugger default delete do else export extends finally for function if import in instanceof let new return super switch this throw try typeof var void while with yield enum await implements package protected static interface private public";
+const builtins = "arguments Infinity NaN undefined null true false eval uneval isFinite isNaN parseFloat parseInt decodeURI decodeURIComponent encodeURI encodeURIComponent escape unescape Object Function Boolean Symbol Error EvalError InternalError RangeError ReferenceError SyntaxError TypeError URIError Number Math Date String RegExp Array Int8Array Uint8Array Uint8ClampedArray Int16Array Uint16Array Int32Array Uint32Array Float32Array Float64Array Map Set WeakMap WeakSet SIMD ArrayBuffer DataView JSON Promise Generator GeneratorFunction Reflect Proxy Intl";
+const forbidList = new Set(`${reservedWords} ${builtins}`.split(" "));
+function makeLegalIdentifier(str) {
+  const identifier = str.replace(/-(\w)/g, (_, letter) => letter.toUpperCase()).replace(/[^$_a-zA-Z0-9]/g, "_");
+  if (/\d/.test(identifier[0]) || forbidList.has(identifier)) {
+    return `_${identifier}`;
+  }
+  return identifier || "_";
+}
+export {
+  makeLegalIdentifier
+};