@modern-js/utils 2.6.0 → 2.7.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @modern-js/utils
 
+## 2.7.0
+
+### Minor Changes
+
+- dcad887024: feat: support deferred data for streaming ssr
+  feat: 流式渲染支持 deferred data
+- 84bfb439b8: feat: support custom apiDir, lambdaDir and style of writing for bff
+  feat: 支持定制 api 目录，lambda 目录，bff 的写法
+
+### Patch Changes
+
+- 0f15fc597c: fix: remove nestedRoutes export
+  fix: 移除 nestedRoutes 导出
+- a4672f7c16: fix: lock @modern-js/utils/ssr by webpack alias
+  fix: 通过 webpack 别名将 @modern-js/utils/ssr 锁到同一版本
+- 7fff9020e1: chore: make file naming consistent
+
+  chore: 统一文件命名为小驼峰格式
+
 ## 2.6.0
 
 ### Patch Changes

package/dist/getTargetDir.d.ts

@@ -0,0 +1 @@
+export declare const getTargetDir: (from: string, baseDir: string, targetBaseDir: string) => string;

package/dist/getTargetDir.js

@@ -0,0 +1,41 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var getTargetDir_exports = {};
+__export(getTargetDir_exports, {
+  getTargetDir: () => getTargetDir
+});
+module.exports = __toCommonJS(getTargetDir_exports);
+var path = __toESM(require("path"));
+const getTargetDir = (from, baseDir, targetBaseDir) => {
+  const relativePath = path.relative(baseDir, from);
+  return path.resolve(targetBaseDir, relativePath);
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getTargetDir
+});

package/dist/index.d.ts

@@ -32,13 +32,13 @@ export * from './nodeEnv';
 export * from './wait';
 export * from './emptyDir';
 export * from './getServerConfig';
-export * from './ssr';
 export * from './tryResolve';
 export * from './analyzeProject';
 export * from './chainId';
 export * from './version';
 export * from './plugin';
 export * from './routes';
-export * from './test-utils';
+export * from './testUtils';
 export * from './getCoreJsVersion';
-export * from './react';
+export * from './react';
+export * from './getTargetDir';

package/dist/index.js

@@ -48,13 +48,13 @@ __reExport(src_exports, require("./nodeEnv"), module.exports);
 __reExport(src_exports, require("./wait"), module.exports);
 __reExport(src_exports, require("./emptyDir"), module.exports);
 __reExport(src_exports, require("./getServerConfig"), module.exports);
-__reExport(src_exports, require("./ssr"), module.exports);
 __reExport(src_exports, require("./tryResolve"), module.exports);
 __reExport(src_exports, require("./analyzeProject"), module.exports);
 __reExport(src_exports, require("./chainId"), module.exports);
 __reExport(src_exports, require("./version"), module.exports);
 __reExport(src_exports, require("./plugin"), module.exports);
 __reExport(src_exports, require("./routes"), module.exports);
-__reExport(src_exports, require("./test-utils"), module.exports);
+__reExport(src_exports, require("./testUtils"), module.exports);
 __reExport(src_exports, require("./getCoreJsVersion"), module.exports);
 __reExport(src_exports, require("./react"), module.exports);
+__reExport(src_exports, require("./getTargetDir"), module.exports);

package/dist/is/index.d.ts

@@ -47,6 +47,6 @@ export declare const isRouterV5: (config: {
     } | boolean;
   };
 }) => boolean;
-export * from './node-env';
+export * from './nodeEnv';
 export * from './platform';
 export * from './type';

package/dist/is/index.js

@@ -41,8 +41,8 @@ module.exports = __toCommonJS(is_exports);
 var import_fs = __toESM(require("fs"));
 var import_path = __toESM(require("path"));
 var import_debug = require("../debug");
-var import_node_env = require("./node-env");
-__reExport(is_exports, require("./node-env"), module.exports);
+var import_nodeEnv = require("./nodeEnv");
+__reExport(is_exports, require("./nodeEnv"), module.exports);
 __reExport(is_exports, require("./platform"), module.exports);
 __reExport(is_exports, require("./type"), module.exports);
 const debug = (0, import_debug.createDebugger)("judge-depExists");
@@ -86,7 +86,7 @@ const isServiceWorker = (config) => {
   }
   return false;
 };
-const isFastRefresh = () => (0, import_node_env.isDev)() && process.env.FAST_REFRESH !== "false";
+const isFastRefresh = () => (0, import_nodeEnv.isDev)() && process.env.FAST_REFRESH !== "false";
 const isRouterV5 = (config) => {
   var _a, _b, _c;
   return typeof ((_a = config.runtime) == null ? void 0 : _a.router) !== "boolean" && ((_c = (_b = config == null ? void 0 : config.runtime) == null ? void 0 : _b.router) == null ? void 0 : _c.mode) === "react-router-5";

package/dist/is/{node-env.js → nodeEnv.js}

@@ -15,15 +15,15 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var node_env_exports = {};
-__export(node_env_exports, {
+var nodeEnv_exports = {};
+__export(nodeEnv_exports, {
   getNodeEnv: () => getNodeEnv,
   isDev: () => isDev,
   isProd: () => isProd,
   isProdProfile: () => isProdProfile,
   isTest: () => isTest
 });
-module.exports = __toCommonJS(node_env_exports);
+module.exports = __toCommonJS(nodeEnv_exports);
 const getNodeEnv = () => process.env.NODE_ENV || "development";
 const isDev = () => getNodeEnv() === "development";
 const isProd = () => getNodeEnv() === "production";

package/dist/nestedRoutes.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+
+/**
+ * runtime utils for nested routes generating
+ */
+import type { NestedRoute } from '@modern-js/types';
+export declare const transformNestedRoutes: (routes: NestedRoute[]) => import("react-router-dom").RouteObject[];
+export declare const renderNestedRoute: (nestedRoute: NestedRoute, options?: {
+  parent?: NestedRoute;
+  DeferredDataComponent?: () => JSX.Element | null;
+}) => JSX.Element;

package/dist/nestedRoutes.js

@@ -0,0 +1,129 @@
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var nestedRoutes_exports = {};
+__export(nestedRoutes_exports, {
+  renderNestedRoute: () => renderNestedRoute,
+  transformNestedRoutes: () => transformNestedRoutes
+});
+module.exports = __toCommonJS(nestedRoutes_exports);
+var import_jsx_runtime = require("react/jsx-runtime");
+var import_react = require("react");
+var import_react_router_dom = require("react-router-dom");
+const transformNestedRoutes = (routes) => {
+  const routeElements = [];
+  for (const route of routes) {
+    const routeElement = renderNestedRoute(route);
+    routeElements.push(routeElement);
+  }
+  return (0, import_react_router_dom.createRoutesFromElements)(routeElements);
+};
+const renderNestedRoute = (nestedRoute, options = {}) => {
+  const { children, index, id, component, isRoot } = nestedRoute;
+  const Component = component;
+  const { parent, DeferredDataComponent } = options;
+  const routeProps = {
+    caseSensitive: nestedRoute.caseSensitive,
+    path: nestedRoute.path,
+    id: nestedRoute.id,
+    loader: createLoader(nestedRoute),
+    action: nestedRoute.action,
+    hasErrorBoundary: nestedRoute.hasErrorBoundary,
+    shouldRevalidate: nestedRoute.shouldRevalidate,
+    handle: nestedRoute.handle,
+    index: nestedRoute.index,
+    element: nestedRoute.element,
+    errorElement: nestedRoute.errorElement
+  };
+  if (nestedRoute.error) {
+    const errorElement = /* @__PURE__ */ (0, import_jsx_runtime.jsx)(nestedRoute.error, {});
+    routeProps.errorElement = errorElement;
+  }
+  let element;
+  if (Component) {
+    if (parent == null ? void 0 : parent.loading) {
+      const Loading = parent.loading;
+      if (isLoadableComponent(Component)) {
+        element = /* @__PURE__ */ (0, import_jsx_runtime.jsx)(Component, { fallback: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(Loading, {}) });
+      } else {
+        element = /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_react.Suspense, { fallback: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(Loading, {}), children: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(Component, {}) });
+      }
+    } else if (isLoadableComponent(Component)) {
+      element = /* @__PURE__ */ (0, import_jsx_runtime.jsx)(Component, {});
+    } else if (isRoot) {
+      element = /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_jsx_runtime.Fragment, { children: [
+        /* @__PURE__ */ (0, import_jsx_runtime.jsx)(Component, {}),
+        typeof document === "undefined" && DeferredDataComponent && /* @__PURE__ */ (0, import_jsx_runtime.jsx)(DeferredDataComponent, {})
+      ] });
+    } else {
+      element = /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_react.Suspense, { fallback: null, children: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(Component, {}) });
+    }
+  } else {
+    nestedRoute.loading = parent == null ? void 0 : parent.loading;
+  }
+  if (element) {
+    routeProps.element = element;
+  }
+  const childElements = children == null ? void 0 : children.map((childRoute) => {
+    return renderNestedRoute(childRoute, { parent: nestedRoute });
+  });
+  const routeElement = index ? /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_react_router_dom.Route, __spreadProps(__spreadValues({}, routeProps), { index: true }), id) : /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_react_router_dom.Route, __spreadProps(__spreadValues({}, routeProps), { index: false, children: childElements }), id);
+  return routeElement;
+};
+function createLoader(route) {
+  const { loader } = route;
+  if (loader) {
+    return (args) => {
+      if (typeof route.lazyImport === "function") {
+        route.lazyImport();
+      }
+      return loader(args);
+    };
+  } else {
+    return () => {
+      if (typeof route.lazyImport === "function") {
+        route.lazyImport();
+      }
+      return null;
+    };
+  }
+}
+function isLoadableComponent(component) {
+  return component && component.displayName === "Loadable" && component.preload && typeof component.preload === "function";
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  renderNestedRoute,
+  transformNestedRoutes
+});

package/dist/remix-router.d.ts

@@ -0,0 +1 @@
+export * from '@remix-run/router';

package/dist/remix-router.js

@@ -0,0 +1,17 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var remix_router_exports = {};
+module.exports = __toCommonJS(remix_router_exports);
+__reExport(remix_router_exports, require("@remix-run/router"), module.exports);

package/dist/serialize.d.ts

@@ -0,0 +1 @@
+export declare const serializeJson: (data: any) => string;

package/dist/serialize.js

@@ -0,0 +1,40 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var serialize_exports = {};
+__export(serialize_exports, {
+  serializeJson: () => serializeJson
+});
+module.exports = __toCommonJS(serialize_exports);
+var import_serialize_javascript = __toESM(require("serialize-javascript"));
+const serializeJson = (data) => {
+  return (0, import_serialize_javascript.default)(data, { isJSON: true });
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  serializeJson
+});

package/dist/{test-utils.js → testUtils.js}

@@ -15,11 +15,11 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var test_utils_exports = {};
-__export(test_utils_exports, {
+var testUtils_exports = {};
+__export(testUtils_exports, {
   initSnapshotSerializer: () => initSnapshotSerializer
 });
-module.exports = __toCommonJS(test_utils_exports);
+module.exports = __toCommonJS(testUtils_exports);
 const initSnapshotSerializer = (root) => {
   expect.addSnapshotSerializer({
     test: (val) => typeof val === "string" && (val.includes("modern.js") || val.includes("node_modules") || val.includes(root)),

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.6.0",
+  "version": "2.7.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
@@ -23,6 +23,9 @@
     "./format": "./dist/format.js",
     "./logger": "./dist/logger.js",
     "./constants": "./dist/constants.js",
+    "./serialize": "./dist/serialize.js",
+    "./nestedRoutes": "./dist/nestedRoutes.js",
+    "./remix-router": "./dist/remix-router.js",
     "./ajv": "./compiled/ajv/index.js",
     "./glob": "./compiled/glob/index.js",
     "./chalk": "./compiled/chalk/index.js",
@@ -61,6 +64,12 @@
       "constants": [
         "./dist/constants.d.ts"
       ],
+      "serialize": [
+        "./dist/serialize.d.ts"
+      ],
+      "nestedRoutes": [
+        "./dist/nestedRoutes.d.ts"
+      ],
       "ajv": [
         "./compiled/ajv/types/ajv.d.ts"
       ],
@@ -120,22 +129,47 @@
       ],
       "chain-id": [
         "./dist/chainId.d.ts"
+      ],
+      "remix-router": [
+        "./dist/remix-router.d.ts"
       ]
     }
   },
   "dependencies": {
     "caniuse-lite": "^1.0.30001451",
-    "lodash": "^4.17.21"
+    "lodash": "^4.17.21",
+    "serialize-javascript": "^6.0.0",
+    "@remix-run/router": "^1.3.2"
+  },
+  "peerDependencies": {
+    "react": ">=17.0.0",
+    "react-dom": ">=17.0.0",
+    "react-router-dom": "^6.8.1"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    },
+    "react-router-dom": {
+      "optional": true
+    }
   },
   "devDependencies": {
+    "react": ">=17.0.0",
+    "react-dom": ">=17.0.0",
+    "react-router-dom": "^6.8.1",
     "@types/jest": "^27",
     "@types/node": "^14",
     "jest": "^27",
     "typescript": "^4",
     "webpack": "^5.75.0",
-    "@modern-js/types": "2.6.0",
-    "@scripts/jest-config": "2.6.0",
-    "@scripts/build": "2.6.0"
+    "@types/serialize-javascript": "^5.0.1",
+    "@modern-js/types": "2.7.0",
+    "@scripts/jest-config": "2.7.0",
+    "@scripts/build": "2.7.0"
   },
   "sideEffects": false,
   "scripts": {