@umijs/server 4.0.0-canary.20240402.1 → 4.0.0-canary.20240423.1

package/dist/ssr.d.ts

@@ -1,7 +1,7 @@
 /// <reference lib="webworker" />
 import type { RequestHandler } from '@umijs/bundler-utils/compiled/express';
 import React from 'react';
-import type { ITplOpts, UmiRequest } from './types';
+import type { IhtmlPageOpts, UmiRequest } from './types';
 interface RouteLoaders {
     [key: string]: () => Promise<any>;
 }
@@ -14,20 +14,18 @@ interface CreateRequestServerlessOptions {
 }
 interface CreateRequestHandlerOptions extends CreateRequestServerlessOptions {
     routesWithServerLoader: RouteLoaders;
-    PluginManager: any;
+    pluginManager: any;
     manifest: ((sourceDir?: string) => {
         assets: Record<string, string>;
     }) | {
         assets: Record<string, string>;
     };
-    getPlugins: () => any;
-    getValidKeys: () => any;
     getRoutes: (PluginManager: any) => any;
     getClientRootComponent: (PluginManager: any) => any;
     createHistory: (opts: any) => any;
     helmetContext?: any;
     ServerInsertedHTMLContext: React.Context<ServerInsertedHTMLHook | null>;
-    tplOpts: ITplOpts;
+    htmlPageOpts: IhtmlPageOpts;
     renderFromRoot: boolean;
     mountElementId: string;
 }
@@ -42,4 +40,5 @@ declare type IWorkerRequestHandlerArgs = [
 export default function createRequestHandler(opts: CreateRequestHandlerOptions): (...args: IExpressRequestHandlerArgs | IWorkerRequestHandlerArgs) => Promise<void>;
 export declare function createUmiHandler(opts: CreateRequestHandlerOptions): (req: UmiRequest, params?: CreateRequestHandlerOptions) => Promise<NodeJS.ReadableStream>;
 export declare function createUmiServerLoader(opts: CreateRequestHandlerOptions): (req: UmiRequest) => Promise<any>;
+export declare function createAppRootElement(opts: CreateRequestHandlerOptions): (...args: IExpressRequestHandlerArgs | IWorkerRequestHandlerArgs) => Promise<() => React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined>;
 export {};

package/dist/ssr.js

@@ -29,6 +29,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/ssr.ts
 var ssr_exports = {};
 __export(ssr_exports, {
+  createAppRootElement: () => createAppRootElement,
   createMarkupGenerator: () => createMarkupGenerator,
   createUmiHandler: () => createUmiHandler,
   createUmiServerLoader: () => createUmiServerLoader,
@@ -39,6 +40,14 @@ var import_react = __toESM(require("react"));
 var ReactDomServer = __toESM(require("react-dom/server"));
 var import_react_router_dom = require("react-router-dom");
 var import_stream = require("stream");
+var MetaLoaderResultKeys = /* @__PURE__ */ ((MetaLoaderResultKeys2) => {
+  MetaLoaderResultKeys2["Title"] = "title";
+  MetaLoaderResultKeys2["Description"] = "description";
+  MetaLoaderResultKeys2["Keywords"] = "keywords";
+  MetaLoaderResultKeys2["Lang"] = "lang";
+  MetaLoaderResultKeys2["Metas"] = "metas";
+  return MetaLoaderResultKeys2;
+})(MetaLoaderResultKeys || {});
 var createJSXProvider = (Provider) => {
   const serverInsertedHTMLCallbacks = /* @__PURE__ */ new Set();
   const JSXProvider = (props) => {
@@ -59,20 +68,14 @@ function createJSXGenerator(opts) {
   return async (url, serverLoaderArgs) => {
     const {
       routesWithServerLoader,
-      PluginManager,
-      getPlugins,
-      getValidKeys,
+      pluginManager,
       getRoutes,
       createHistory,
       sourceDir
     } = opts;
     createHistory({ type: "memory", initialEntries: [url], initialIndex: 1 });
-    const pluginManager = PluginManager.create({
-      plugins: getPlugins(),
-      validKeys: getValidKeys()
-    });
     const { routes, routeComponents } = await getRoutes(pluginManager);
-    await pluginManager.applyPlugins({
+    pluginManager.applyPlugins({
       key: "patchRoutes",
       type: "event",
       args: {
@@ -100,11 +103,11 @@ function createJSXGenerator(opts) {
               serverLoaderArgs,
               serverLoaderData: loaderData[id]
             });
-            Object.entries(metadataLoaderData).forEach(([k, v]) => {
+            metadataLoaderData && Object.entries(metadataLoaderData).forEach(([k, v]) => {
               if (Array.isArray(v)) {
-                opts.tplOpts[k] = (opts.tplOpts[k] || []).concat(v);
+                opts.htmlPageOpts[k] = (opts.htmlPageOpts[k] || []).concat(v);
               } else {
-                opts.tplOpts[k] = v;
+                opts.htmlPageOpts[k] = v;
               }
             });
           }
@@ -120,7 +123,7 @@ function createJSXGenerator(opts) {
       location: url,
       manifest,
       loaderData,
-      tplOpts: opts.tplOpts,
+      htmlPageOpts: opts.htmlPageOpts,
       renderFromRoot: opts.renderFromRoot,
       mountElementId: opts.mountElementId
     };
@@ -190,6 +193,7 @@ function createMarkupGenerator(opts) {
             onShellReady() {
               stream.pipe(writable);
             },
+            bootstrapScripts: [jsx.manifest.assets["umi.js"] || "/umi.js"],
             onError: reject
           }
         );
@@ -198,25 +202,60 @@ function createMarkupGenerator(opts) {
     return "";
   };
 }
+var normalizeRequest = (...args) => {
+  var _a, _b;
+  let request;
+  let serverLoaderRequest;
+  let serverLoaderArgs;
+  if (process.env.SSR_BUILD_TARGET === "worker") {
+    const [ev] = args;
+    const { pathname, searchParams } = new URL(ev.request.url);
+    request = {
+      url: ev.request.url,
+      pathname,
+      headers: ev.request.headers,
+      query: {
+        route: searchParams.get("route"),
+        url: searchParams.get("url")
+      }
+    };
+  } else {
+    const [req] = args;
+    request = {
+      url: `${req.protocol}://${req.get("host")}${req.originalUrl}`,
+      pathname: req.url,
+      headers: req.headers,
+      query: {
+        route: (_a = req.query.route) == null ? void 0 : _a.toString(),
+        url: (_b = req.query.url) == null ? void 0 : _b.toString()
+      }
+    };
+  }
+  if (request.pathname.startsWith("/__serverLoader") && request.query.route && request.query.url) {
+    serverLoaderRequest = new Request(request.query.url, {
+      headers: request.headers
+    });
+    serverLoaderArgs = {
+      request: serverLoaderRequest
+    };
+  }
+  return {
+    request,
+    serverLoaderArgs
+  };
+};
 function createRequestHandler(opts) {
   const jsxGeneratorDeferrer = createJSXGenerator(opts);
   const normalizeHandlerArgs = (...args) => {
-    var _a, _b;
     let ret;
+    const { request } = normalizeRequest(...args);
     const replaceServerHTMLScript = `<script>!function(){var e=document.getElementById("${SERVER_INSERTED_HTML}");e&&(Array.from(e.children).forEach(e=>{document.head.appendChild(e)}),e.remove())}();</script>`;
-    if (typeof FetchEvent !== "undefined" && args[0] instanceof FetchEvent) {
+    if (process.env.SSR_BUILD_TARGET === "worker") {
       const [ev, workerOpts] = args;
-      const { pathname, searchParams } = new URL(ev.request.url);
+      let asyncRespondWith;
+      ev.respondWith(new Promise((r) => asyncRespondWith = r));
       ret = {
-        req: {
-          url: ev.request.url,
-          pathname,
-          headers: ev.request.headers,
-          query: {
-            route: searchParams.get("route"),
-            url: searchParams.get("url")
-          }
-        },
+        req: request,
         async sendServerLoader(data) {
           let res = new Response(JSON.stringify(data), {
             headers: {
@@ -227,7 +266,7 @@ function createRequestHandler(opts) {
           if (workerOpts == null ? void 0 : workerOpts.modifyResponse) {
             res = await workerOpts.modifyResponse(res);
           }
-          ev.respondWith(res);
+          asyncRespondWith(res);
         },
         async sendPage(jsx) {
           const [JSXProvider, serverInsertedHTMLCallbacks] = createJSXProvider(
@@ -254,8 +293,7 @@ function createRequestHandler(opts) {
               }
             }
           });
-          stream.pipeThrough(transformStream);
-          let res = new Response(stream, {
+          let res = new Response(stream.pipeThrough(transformStream), {
             headers: {
               "content-type": "text/html; charset=utf-8"
             },
@@ -264,24 +302,16 @@ function createRequestHandler(opts) {
           if (workerOpts == null ? void 0 : workerOpts.modifyResponse) {
             res = await workerOpts.modifyResponse(res);
           }
-          ev.respondWith(res);
+          asyncRespondWith(res);
         },
         otherwise() {
           throw new Error("no page resource");
         }
       };
     } else {
-      const [req, res, next] = args;
+      const [_, res, next] = args;
       ret = {
-        req: {
-          url: `${req.protocol}://${req.get("host")}${req.originalUrl}`,
-          pathname: req.url,
-          headers: req.headers,
-          query: {
-            route: (_a = req.query.route) == null ? void 0 : _a.toString(),
-            url: (_b = req.query.url) == null ? void 0 : _b.toString()
-          }
-        },
+        req: request,
         sendServerLoader(data) {
           res.status(200).json(data);
         },
@@ -325,28 +355,33 @@ function createRequestHandler(opts) {
     return ret;
   };
   return async function unifiedRequestHandler(...args) {
-    let jsx;
     const { req, sendServerLoader, sendPage, otherwise } = normalizeHandlerArgs(
       ...args
     );
     if (req.pathname.startsWith("/__serverLoader") && req.query.route && req.query.url) {
-      const serverLoaderRequest = new Request(req.query.url, {
-        headers: req.headers
-      });
+      const { serverLoaderArgs } = normalizeRequest(...args);
       const data = await executeLoader({
         routeKey: req.query.route,
         routesWithServerLoader: opts.routesWithServerLoader,
-        serverLoaderArgs: { request: serverLoaderRequest }
+        serverLoaderArgs
       });
       await sendServerLoader(data);
-    } else if (jsx = await jsxGeneratorDeferrer(req.pathname, {
-      request: new Request(req.url, {
-        headers: req.headers
-      })
-    })) {
-      await sendPage(jsx);
     } else {
-      await otherwise();
+      const render = opts.pluginManager.applyPlugins({
+        key: "render",
+        type: "compose",
+        initialValue: () => jsxGeneratorDeferrer(req.pathname, {
+          request: new Request(req.url, {
+            headers: req.headers
+          })
+        })
+      });
+      const jsx = await render();
+      if (jsx) {
+        await sendPage(jsx);
+      } else {
+        await otherwise();
+      }
     }
   };
 }
@@ -396,6 +431,14 @@ function createUmiServerLoader(opts) {
     });
   };
 }
+function createAppRootElement(opts) {
+  return async (...args) => {
+    const jsxGeneratorDeferrer = createJSXGenerator(opts);
+    const { request, serverLoaderArgs } = normalizeRequest(...args);
+    const jsx = await jsxGeneratorDeferrer(request.pathname, serverLoaderArgs);
+    return () => jsx == null ? void 0 : jsx.element;
+  };
+}
 function matchRoutesForSSR(reqUrl, routesById) {
   var _a;
   return ((_a = (0, import_react_router_dom.matchRoutes)(createClientRoutes({ routesById }), reqUrl)) == null ? void 0 : _a.map(
@@ -438,20 +481,19 @@ async function executeMetadataLoader(params) {
   if (!mod.serverLoader || typeof mod.serverLoader !== "function") {
     return;
   }
-  const result = mod.metadataLoader(
+  const loaderDatas = mod.metadataLoader(
     serverLoaderData
   );
-  return ["title", "description", "keywords", "lang", "metas"].reduce(
-    (acc, key) => {
-      if (Object.prototype.hasOwnProperty.call(result, key))
-        acc[key] = result[key];
-      return acc;
-    },
-    {}
-  );
+  const result = {};
+  Object.values(MetaLoaderResultKeys).forEach((key) => {
+    if (loaderDatas == null ? void 0 : loaderDatas[key])
+      result[key] = loaderDatas[key];
+  });
+  return result;
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  createAppRootElement,
   createMarkupGenerator,
   createUmiHandler,
   createUmiServerLoader

package/dist/types.d.ts

@@ -55,18 +55,8 @@ export interface IMetadata {
      */
     lang?: string;
     metas?: IMetaTag[];
-    headScripts?: (Record<string, string> | string)[];
-    links?: Record<string, string>[];
-    styles?: string[];
-    favicons?: string[];
-    scripts?: (Record<string, string> | string)[];
-    [key: string]: any;
 }
-export interface ITplOpts {
-    title?: string;
-    description?: string;
-    keywords?: string[];
-    metas?: IMetaTag[];
+export interface IhtmlPageOpts extends IMetadata {
     headScripts?: (Record<string, string> | string)[];
     links?: Record<string, string>[];
     styles?: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@umijs/server",
-  "version": "4.0.0-canary.20240402.1",
+  "version": "4.0.0-canary.20240423.1",
   "description": "@umijs/server",
   "homepage": "https://github.com/umijs/umi/tree/master/packages/server#readme",
   "bugs": "https://github.com/umijs/umi/issues",
@@ -19,7 +19,7 @@
     "react": "18.1.0",
     "react-dom": "18.1.0",
     "react-router-dom": "6.3.0",
-    "@umijs/bundler-utils": "4.0.0-canary.20240402.1"
+    "@umijs/bundler-utils": "4.0.0-canary.20240423.1"
   },
   "publishConfig": {
     "access": "public"