@modern-js/plugin-data-loader 2.8.0 → 2.10.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @modern-js/plugin-data-loader
 
+## 2.10.0
+
+### Patch Changes
+
+- 3e0bd50: feat: when enable bff handle render, support use `useContext` to get framework plugin context in data loader.
+  feat: 当开启 BFF 托管渲染时，支持在 data loader 中使用 `useContext` 获取框架插件提供的上下文。
+- 0da32d0: chore: upgrade jest and puppeteer
+  chore: 升级 jest 和 puppeteer 到 latest
+- 0d9962b: fix: add types field in package.json
+  fix: 添加 package.json 中的 types 字段
+- fbefa7e: chore(deps): bump webpack from 5.75.0 to 5.76.2
+
+  chore(deps): 将 webpack 从 5.75.0 升级至 5.76.2
+
+- d6b6e29: fix: split server and runtime code in plugin-data-loader
+  fix: 分离 plugin-data-loader 中服务端和客户端运行时的代码
+- Updated dependencies [0da32d0]
+- Updated dependencies [fbefa7e]
+- Updated dependencies [4d54233]
+- Updated dependencies [6db4864]
+  - @modern-js/utils@2.10.0
+
+## 2.9.0
+
+### Patch Changes
+
+- @modern-js/utils@2.9.0
+
 ## 2.8.0
 
 ### Patch Changes

package/dist/cjs/common/utils.js

@@ -0,0 +1,44 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var utils_exports = {};
+__export(utils_exports, {
+  matchEntry: () => matchEntry
+});
+module.exports = __toCommonJS(utils_exports);
+function sortByUrlPath(entries) {
+  entries.sort(function(a, b) {
+    const length1 = a.urlPath.length;
+    const length2 = b.urlPath.length;
+    if (length1 < length2) {
+      return 1;
+    }
+    if (length1 > length2) {
+      return -1;
+    }
+    return 0;
+  });
+  return entries;
+}
+const matchEntry = (pathname, entries) => {
+  sortByUrlPath(entries);
+  return entries.find((entry) => pathname.startsWith(entry.urlPath));
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  matchEntry
+});

package/dist/cjs/runtime/index.js

@@ -19,8 +19,7 @@ var runtime_exports = {};
 __export(runtime_exports, {
   handleRequest: () => handleRequest,
   isRedirectResponse: () => isRedirectResponse,
-  isResponse: () => isResponse,
-  matchEntry: () => matchEntry
+  isResponse: () => isResponse
 });
 module.exports = __toCommonJS(runtime_exports);
 var import_node = require("@remix-run/node");
@@ -28,6 +27,7 @@ var import_nestedRoutes = require("@modern-js/utils/nestedRoutes");
 var import_remix_router = require("@modern-js/utils/remix-router");
 var import_lodash = require("@modern-js/utils/lodash");
 var import_constants = require("../common/constants");
+var import_utils = require("../common/utils");
 var import_response = require("./response");
 (0, import_node.installGlobals)();
 const redirectStatusCodes = /* @__PURE__ */ new Set([301, 302, 303, 307, 308]);
@@ -37,20 +37,6 @@ function isRedirectResponse(status) {
 function isResponse(value) {
   return value != null && typeof value.status === "number" && typeof value.statusText === "string" && typeof value.headers === "object" && typeof value.body !== "undefined";
 }
-function sortByUrlPath(entries) {
-  entries.sort(function(a, b) {
-    const length1 = a.urlPath.length;
-    const length2 = b.urlPath.length;
-    if (length1 < length2) {
-      return 1;
-    }
-    if (length1 > length2) {
-      return -1;
-    }
-    return 0;
-  });
-  return entries;
-}
 function convertModernRedirectResponse(headers, basename) {
   const newHeaders = new Headers(headers);
   let redirectUrl = headers.get("Location");
@@ -102,18 +88,14 @@ const sendLoaderResponse = async (res, nodeResponse) => {
     res.end();
   }
 };
-const matchEntry = (pathname, entries) => {
-  sortByUrlPath(entries);
-  return entries.find((entry) => pathname.startsWith(entry.urlPath));
-};
 const handleRequest = async ({
   context,
   serverRoutes,
-  routes
+  routes: routesConfig
 }) => {
   const { method, query } = context;
   const routeId = query[import_constants.LOADER_ID_PARAM];
-  const entry = matchEntry(context.path, serverRoutes);
+  const entry = (0, import_utils.matchEntry)(context.path, serverRoutes);
   if (!routeId || !entry) {
     return;
   }
@@ -121,17 +103,16 @@ const handleRequest = async ({
     throw new Error("CSR data loader request only support http GET method");
   }
   const basename = entry.urlPath;
-  const dataRoutes = (0, import_nestedRoutes.transformNestedRoutes)(routes);
-  const staticHandler = (0, import_remix_router.createStaticHandler)(dataRoutes, {
+  const routes = (0, import_nestedRoutes.transformNestedRoutes)(routesConfig);
+  const { queryRoute } = (0, import_remix_router.createStaticHandler)(routes, {
     basename
   });
   const { res } = context;
   const request = createLoaderRequest(context);
   let response;
   try {
-    response = await staticHandler.queryRoute(request, {
-      routeId,
-      requestContext: context
+    response = await queryRoute(request, {
+      routeId
     });
     if (isResponse(response) && isRedirectResponse(response.status)) {
       response = convertModernRedirectResponse(response.headers, basename);
@@ -169,12 +150,11 @@ const handleRequest = async ({
       }
     });
   }
-  sendLoaderResponse(res, response);
+  await sendLoaderResponse(res, response);
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   handleRequest,
   isRedirectResponse,
-  isResponse,
-  matchEntry
+  isResponse
 });

package/dist/cjs/server/index.js

@@ -33,16 +33,16 @@ module.exports = __toCommonJS(server_exports);
 var import_path = __toESM(require("path"));
 var import_fs = __toESM(require("fs"));
 var import_utils = require("@modern-js/utils");
-var import_runtime2 = require("../runtime");
+var import_utils2 = require("../common/utils");
 var server_default = () => ({
   name: "@modern-js/plugin-data-loader",
   setup: () => ({
-    preparebeforeRouteHandler({
+    prepareLoaderHandler({
       serverRoutes,
       distDir
     }) {
       return async (context) => {
-        const entry = (0, import_runtime2.matchEntry)(context.path, serverRoutes);
+        const entry = (0, import_utils2.matchEntry)(context.path, serverRoutes);
         if (!entry) {
           return;
         }

package/dist/esm/common/utils.js

@@ -0,0 +1,21 @@
+function sortByUrlPath(entries) {
+    entries.sort(function(a, b) {
+        var length1 = a.urlPath.length;
+        var length2 = b.urlPath.length;
+        if (length1 < length2) {
+            return 1;
+        }
+        if (length1 > length2) {
+            return -1;
+        }
+        return 0;
+    });
+    return entries;
+}
+var matchEntry = function(pathname, entries) {
+    sortByUrlPath(entries);
+    return entries.find(function(entry) {
+        return pathname.startsWith(entry.urlPath);
+    });
+};
+export { matchEntry };

package/dist/esm/runtime/index.js

@@ -180,6 +180,7 @@ import { transformNestedRoutes } from "@modern-js/utils/nestedRoutes";
 import { createStaticHandler, ErrorResponse, UNSAFE_DEFERRED_SYMBOL as DEFERRED_SYMBOL } from "@modern-js/utils/remix-router";
 import { isPlainObject } from "@modern-js/utils/lodash";
 import { CONTENT_TYPE_DEFERRED, LOADER_ID_PARAM } from "../common/constants";
+import { matchEntry } from "../common/utils";
 import { createDeferredReadableStream } from "./response";
 installGlobals();
 var redirectStatusCodes = /* @__PURE__ */ new Set([
@@ -195,20 +196,6 @@ function isRedirectResponse(status) {
 function isResponse(value) {
     return value != null && typeof value.status === "number" && typeof value.statusText === "string" && typeof value.headers === "object" && typeof value.body !== "undefined";
 }
-function sortByUrlPath(entries) {
-    entries.sort(function(a, b) {
-        var length1 = a.urlPath.length;
-        var length2 = b.urlPath.length;
-        if (length1 < length2) {
-            return 1;
-        }
-        if (length1 > length2) {
-            return -1;
-        }
-        return 0;
-    });
-    return entries;
-}
 function convertModernRedirectResponse(headers, basename) {
     var newHeaders = new Headers(headers);
     var redirectUrl = headers.get("Location");
@@ -338,19 +325,13 @@ var sendLoaderResponse = function() {
         return _ref.apply(this, arguments);
     };
 }();
-var matchEntry = function(pathname, entries) {
-    sortByUrlPath(entries);
-    return entries.find(function(entry) {
-        return pathname.startsWith(entry.urlPath);
-    });
-};
 var handleRequest = function() {
     var _ref = _asyncToGenerator(function(param) {
-        var context, serverRoutes, routes, method, query, routeId, entry, basename, dataRoutes, staticHandler, res, request, response, deferredData, body, init, headers, error, message;
+        var context, serverRoutes, routesConfig, method, query, routeId, entry, basename, routes, queryRoute, res, request, response, deferredData, body, init, headers, error, message;
         return __generator(this, function(_state) {
             switch(_state.label){
                 case 0:
-                    context = param.context, serverRoutes = param.serverRoutes, routes = param.routes;
+                    context = param.context, serverRoutes = param.serverRoutes, routesConfig = param.routes;
                     method = context.method, query = context.query;
                     routeId = query[LOADER_ID_PARAM];
                     entry = matchEntry(context.path, serverRoutes);
@@ -363,10 +344,10 @@ var handleRequest = function() {
                         throw new Error("CSR data loader request only support http GET method");
                     }
                     basename = entry.urlPath;
-                    dataRoutes = transformNestedRoutes(routes);
-                    staticHandler = createStaticHandler(dataRoutes, {
+                    routes = transformNestedRoutes(routesConfig);
+                    queryRoute = createStaticHandler(routes, {
                         basename: basename
-                    });
+                    }).queryRoute;
                     res = context.res;
                     request = createLoaderRequest(context);
                     _state.label = 1;
@@ -379,9 +360,8 @@ var handleRequest = function() {
                     ]);
                     return [
                         4,
-                        staticHandler.queryRoute(request, {
-                            routeId: routeId,
-                            requestContext: context
+                        queryRoute(request, {
+                            routeId: routeId
                         })
                     ];
                 case 2:
@@ -428,7 +408,12 @@ var handleRequest = function() {
                         4
                     ];
                 case 4:
-                    sendLoaderResponse(res, response);
+                    return [
+                        4,
+                        sendLoaderResponse(res, response)
+                    ];
+                case 5:
+                    _state.sent();
                     return [
                         2
                     ];
@@ -439,4 +424,4 @@ var handleRequest = function() {
         return _ref.apply(this, arguments);
     };
 }();
-export { handleRequest, isRedirectResponse, isResponse, matchEntry };
+export { handleRequest, isRedirectResponse, isResponse };

package/dist/esm/server/index.js

@@ -125,13 +125,13 @@ var __generator = this && this.__generator || function(thisArg, body) {
 import path from "path";
 import fs from "fs";
 import { MAIN_ENTRY_NAME, SERVER_BUNDLE_DIRECTORY } from "@modern-js/utils";
-import { matchEntry } from "../runtime";
+import { matchEntry } from "../common/utils";
 var server_default = function() {
     return {
         name: "@modern-js/plugin-data-loader",
         setup: function() {
             return {
-                preparebeforeRouteHandler: function preparebeforeRouteHandler(param) {
+                prepareLoaderHandler: function prepareLoaderHandler(param) {
                     var serverRoutes = param.serverRoutes, distDir = param.distDir;
                     return function() {
                         var _ref = _asyncToGenerator(function(context) {

package/dist/esm-node/common/utils.js

@@ -0,0 +1,21 @@
+function sortByUrlPath(entries) {
+  entries.sort(function(a, b) {
+    const length1 = a.urlPath.length;
+    const length2 = b.urlPath.length;
+    if (length1 < length2) {
+      return 1;
+    }
+    if (length1 > length2) {
+      return -1;
+    }
+    return 0;
+  });
+  return entries;
+}
+const matchEntry = (pathname, entries) => {
+  sortByUrlPath(entries);
+  return entries.find((entry) => pathname.startsWith(entry.urlPath));
+};
+export {
+  matchEntry
+};

package/dist/esm-node/runtime/index.js

@@ -11,6 +11,7 @@ import {
 } from "@modern-js/utils/remix-router";
 import { isPlainObject } from "@modern-js/utils/lodash";
 import { CONTENT_TYPE_DEFERRED, LOADER_ID_PARAM } from "../common/constants";
+import { matchEntry } from "../common/utils";
 import { createDeferredReadableStream } from "./response";
 installGlobals();
 const redirectStatusCodes = /* @__PURE__ */ new Set([301, 302, 303, 307, 308]);
@@ -20,20 +21,6 @@ function isRedirectResponse(status) {
 function isResponse(value) {
   return value != null && typeof value.status === "number" && typeof value.statusText === "string" && typeof value.headers === "object" && typeof value.body !== "undefined";
 }
-function sortByUrlPath(entries) {
-  entries.sort(function(a, b) {
-    const length1 = a.urlPath.length;
-    const length2 = b.urlPath.length;
-    if (length1 < length2) {
-      return 1;
-    }
-    if (length1 > length2) {
-      return -1;
-    }
-    return 0;
-  });
-  return entries;
-}
 function convertModernRedirectResponse(headers, basename) {
   const newHeaders = new Headers(headers);
   let redirectUrl = headers.get("Location");
@@ -85,14 +72,10 @@ const sendLoaderResponse = async (res, nodeResponse) => {
     res.end();
   }
 };
-const matchEntry = (pathname, entries) => {
-  sortByUrlPath(entries);
-  return entries.find((entry) => pathname.startsWith(entry.urlPath));
-};
 const handleRequest = async ({
   context,
   serverRoutes,
-  routes
+  routes: routesConfig
 }) => {
   const { method, query } = context;
   const routeId = query[LOADER_ID_PARAM];
@@ -104,17 +87,16 @@ const handleRequest = async ({
     throw new Error("CSR data loader request only support http GET method");
   }
   const basename = entry.urlPath;
-  const dataRoutes = transformNestedRoutes(routes);
-  const staticHandler = createStaticHandler(dataRoutes, {
+  const routes = transformNestedRoutes(routesConfig);
+  const { queryRoute } = createStaticHandler(routes, {
     basename
   });
   const { res } = context;
   const request = createLoaderRequest(context);
   let response;
   try {
-    response = await staticHandler.queryRoute(request, {
-      routeId,
-      requestContext: context
+    response = await queryRoute(request, {
+      routeId
     });
     if (isResponse(response) && isRedirectResponse(response.status)) {
       response = convertModernRedirectResponse(response.headers, basename);
@@ -152,11 +134,10 @@ const handleRequest = async ({
       }
     });
   }
-  sendLoaderResponse(res, response);
+  await sendLoaderResponse(res, response);
 };
 export {
   handleRequest,
   isRedirectResponse,
-  isResponse,
-  matchEntry
+  isResponse
 };

package/dist/esm-node/server/index.js

@@ -1,11 +1,11 @@
 import path from "path";
 import fs from "fs";
 import { MAIN_ENTRY_NAME, SERVER_BUNDLE_DIRECTORY } from "@modern-js/utils";
-import { matchEntry } from "../runtime";
+import { matchEntry } from "../common/utils";
 var server_default = () => ({
   name: "@modern-js/plugin-data-loader",
   setup: () => ({
-    preparebeforeRouteHandler({
+    prepareLoaderHandler({
       serverRoutes,
       distDir
     }) {

package/dist/types/cli/data.d.ts

@@ -1,6 +1,11 @@
 /**
- * modified from https://github.com/remix-run/remix/blob/main/packages/remix-react/data.ts
- * license at https://github.com/remix-run/remix/blob/main/LICENSE.md
+ * The following code is modified based on
+ * https://github.com/remix-run/remix/blob/2b5e1a72fc628d0408e27cf4d72e537762f1dc5b/packages/remix-react/data.ts
+ *
+ * MIT Licensed
+ * Author Michael Jackson
+ * Copyright 2021 Remix Software Inc.
+ * https://github.com/remix-run/remix/blob/2b5e1a72fc628d0408e27cf4d72e537762f1dc5b/LICENSE.md
  */
 import { UNSAFE_DeferredData as DeferredData } from '@modern-js/utils/remix-router';
 export declare function parseDeferredReadableStream(stream: ReadableStream<Uint8Array>): Promise<DeferredData>;

package/dist/types/common/utils.d.ts

@@ -0,0 +1,3 @@
+import { ModernServerContext, ServerRoute } from '@modern-js/types';
+export type ServerContext = Pick<ModernServerContext, 'req' | 'res' | 'params' | 'headers' | 'method' | 'url' | 'host' | 'protocol' | 'origin' | 'href' | 'path' | 'query'>;
+export declare const matchEntry: (pathname: string, entries: ServerRoute[]) => ServerRoute | undefined;

package/dist/types/runtime/index.d.ts

@@ -1,13 +1,12 @@
-import type { ModernServerContext, NestedRoute, ServerRoute } from '@modern-js/types';
+import type { NestedRoute, ServerRoute } from '@modern-js/types';
 import { Response as NodeResponse } from '@remix-run/node';
-export type ServerContext = Pick<ModernServerContext, 'req' | 'res' | 'params' | 'headers' | 'method' | 'url' | 'host' | 'protocol' | 'origin' | 'href' | 'path' | 'query'>;
+import { ServerContext } from '../common/utils';
 export declare function isRedirectResponse(status: number): boolean;
 export declare function isResponse(value: any): value is NodeResponse;
-export declare const matchEntry: (pathname: string, entries: ServerRoute[]) => ServerRoute | undefined;
 export declare const handleRequest: ({
   context,
   serverRoutes,
-  routes
+  routes: routesConfig
 }: {
   context: ServerContext;
   serverRoutes: ServerRoute[];

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.8.0",
+  "version": "2.10.0",
   "engines": {
     "node": ">=14.17.6"
   },
@@ -22,14 +22,17 @@
   "exports": {
     "./loader": {
       "jsnext:source": "./src/cli/loader.ts",
+      "types": "./dist/types/cli/loader.d.ts",
       "default": "./dist/cjs/cli/loader.js"
     },
     "./server": {
       "jsnext:source": "./src/server/index.ts",
+      "types": "./dist/types/server/index.d.ts",
       "default": "./dist/cjs/server/index.js"
     },
     "./runtime": {
       "jsnext:source": "./src/runtime/index.ts",
+      "types": "./dist/types/runtime/index.d.ts",
       "default": "./dist/esm/runtime/index.js"
     }
   },
@@ -52,26 +55,26 @@
     "@remix-run/node": "^1.12.0",
     "path-to-regexp": "^6.2.0",
     "react-router-dom": "^6.8.1",
-    "@modern-js/utils": "2.8.0"
+    "@modern-js/utils": "2.10.0"
   },
   "devDependencies": {
     "@types/babel__core": "^7.1.15",
-    "@types/jest": "^27",
+    "@types/jest": "^29",
     "@types/node": "^14",
     "@types/supertest": "^2.0.11",
     "isomorphic-fetch": "^3.0.0",
-    "jest": "^27",
+    "jest": "^29",
     "memfs": "^3.3.0",
     "supertest": "^6.1.6",
-    "ts-jest": "^27.0.5",
+    "ts-jest": "^29.0.5",
     "typescript": "^4",
-    "webpack": "^5.75.0",
+    "webpack": "^5.76.2",
     "webpack-chain": "^6.5.1",
-    "@modern-js/core": "2.8.0",
-    "@modern-js/server-core": "2.8.0",
-    "@modern-js/types": "2.8.0",
-    "@scripts/jest-config": "2.8.0",
-    "@scripts/build": "2.8.0"
+    "@modern-js/core": "2.10.0",
+    "@modern-js/server-core": "2.10.0",
+    "@modern-js/types": "2.10.0",
+    "@scripts/jest-config": "2.10.0",
+    "@scripts/build": "2.10.0"
   },
   "sideEffects": false,
   "publishConfig": {