@umijs/server 4.0.86 → 4.0.88

package/dist/ssr.d.ts

@@ -1,9 +1,16 @@
 import React from 'react';
+import type { UmiRequest } from './types';
 interface RouteLoaders {
     [key: string]: () => Promise<any>;
 }
 export declare type ServerInsertedHTMLHook = (callbacks: () => React.ReactNode) => void;
-interface CreateRequestHandlerOptions {
+interface CreateRequestServerlessOptions {
+    /**
+     * folder path for `build-manifest.json`
+     */
+    sourceDir?: string;
+}
+interface CreateRequestHandlerOptions extends CreateRequestServerlessOptions {
     routesWithServerLoader: RouteLoaders;
     PluginManager: any;
     manifest: ((sourceDir?: string) => {
@@ -18,11 +25,9 @@ interface CreateRequestHandlerOptions {
     createHistory: (opts: any) => any;
     helmetContext?: any;
     ServerInsertedHTMLContext: React.Context<ServerInsertedHTMLHook | null>;
-    withoutHTML?: boolean;
-    sourceDir?: string;
 }
 export declare function createMarkupGenerator(opts: CreateRequestHandlerOptions): (url: string) => Promise<unknown>;
 export default function createRequestHandler(opts: CreateRequestHandlerOptions): (req: any, res: any, next: any) => Promise<any>;
-export declare function createUmiHandler(opts: CreateRequestHandlerOptions): (req: Request, params?: CreateRequestHandlerOptions) => Promise<NodeJS.ReadableStream>;
-export declare function createUmiServerLoader(opts: CreateRequestHandlerOptions): (req: Request) => Promise<any>;
+export declare function createUmiHandler(opts: CreateRequestHandlerOptions): (req: UmiRequest, params?: CreateRequestHandlerOptions) => Promise<NodeJS.ReadableStream>;
+export declare function createUmiServerLoader(opts: CreateRequestHandlerOptions): (req: UmiRequest) => Promise<any>;
 export {};

package/dist/ssr.js

@@ -55,7 +55,7 @@ var createJSXProvider = (Provider, serverInsertedHTMLCallbacks) => {
   return JSXProvider;
 };
 function createJSXGenerator(opts) {
-  return async (url) => {
+  return async (url, serverLoaderArgs) => {
     const {
       routesWithServerLoader,
       PluginManager,
@@ -84,10 +84,26 @@ function createJSXGenerator(opts) {
       return;
     }
     const loaderData = {};
+    const metadata = {};
     await Promise.all(
       matches.filter((id) => routes[id].hasServerLoader).map(
         (id) => new Promise(async (resolve) => {
-          loaderData[id] = await executeLoader(id, routesWithServerLoader);
+          loaderData[id] = await executeLoader({
+            routeKey: id,
+            routesWithServerLoader,
+            serverLoaderArgs
+          });
+          if (routes[id].hasMetadataLoader) {
+            Object.assign(
+              metadata,
+              await executeMetadataLoader({
+                routesWithServerLoader,
+                routeKey: id,
+                serverLoaderArgs,
+                serverLoaderData: loaderData[id]
+              })
+            );
+          }
           resolve();
         })
       )
@@ -100,7 +116,7 @@ function createJSXGenerator(opts) {
       location: url,
       manifest,
       loaderData,
-      withoutHTML: opts.withoutHTML
+      metadata
     };
     const element = await opts.getClientRootComponent(
       context
@@ -173,14 +189,22 @@ function createRequestHandler(opts) {
   const jsxGeneratorDeferrer = createJSXGenerator(opts);
   return async function(req, res, next) {
     if (req.url.startsWith("/__serverLoader") && req.query.route) {
-      const data = await executeLoader(
-        req.query.route,
-        opts.routesWithServerLoader
-      );
+      const serverLoaderRequest = new Request(req.query.url, {
+        headers: req.headers
+      });
+      const data = await executeLoader({
+        routeKey: req.query.route,
+        routesWithServerLoader: opts.routesWithServerLoader,
+        serverLoaderArgs: { request: serverLoaderRequest }
+      });
       res.status(200).json(data);
       return;
     }
-    const jsx = await jsxGeneratorDeferrer(req.url);
+    const fullUrl = `${req.protocol}://${req.get("host")}${req.originalUrl}`;
+    const request = new Request(fullUrl, {
+      headers: req.headers
+    });
+    const jsx = await jsxGeneratorDeferrer(req.url, { request });
     if (!jsx)
       return next();
     const writable = new import_stream.Writable();
@@ -209,7 +233,13 @@ function createUmiHandler(opts) {
       ...opts,
       ...params
     });
-    const jsx = await jsxGeneratorDeferrer(new URL(req.url).pathname);
+    const loaderArgs = {
+      request: req
+    };
+    const jsx = await jsxGeneratorDeferrer(
+      new URL(req.url).pathname,
+      loaderArgs
+    );
     if (!jsx) {
       throw new Error("no page resource");
     }
@@ -219,7 +249,14 @@ function createUmiHandler(opts) {
 function createUmiServerLoader(opts) {
   return async function(req) {
     const query = Object.fromEntries(new URL(req.url).searchParams);
-    return await executeLoader(query.route, opts.routesWithServerLoader);
+    const serverLoaderRequest = new Request(query.url, {
+      headers: req.headers
+    });
+    return await executeLoader({
+      routeKey: query.route,
+      routesWithServerLoader: opts.routesWithServerLoader,
+      serverLoaderArgs: { request: serverLoaderRequest }
+    });
   };
 }
 function matchRoutesForSSR(reqUrl, routesById) {
@@ -250,12 +287,29 @@ function createClientRoute(route) {
     index
   };
 }
-async function executeLoader(routeKey, routesWithServerLoader) {
+async function executeLoader(params) {
+  const { routeKey, routesWithServerLoader, serverLoaderArgs } = params;
+  const mod = await routesWithServerLoader[routeKey]();
+  if (!mod.serverLoader || typeof mod.serverLoader !== "function") {
+    return;
+  }
+  return mod.serverLoader(serverLoaderArgs);
+}
+async function executeMetadataLoader(params) {
+  const {
+    routesWithServerLoader,
+    routeKey,
+    serverLoaderArgs,
+    serverLoaderData
+  } = params;
   const mod = await routesWithServerLoader[routeKey]();
   if (!mod.serverLoader || typeof mod.serverLoader !== "function") {
     return;
   }
-  return await mod.serverLoader();
+  return mod.metadataLoader(
+    serverLoaderData,
+    serverLoaderArgs
+  );
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/types.d.ts

@@ -10,3 +10,25 @@ export interface IRoutesById {
 export interface IRouteCustom extends IRoute {
     [key: string]: any;
 }
+declare type LoaderReturn<T> = T | Promise<T>;
+export declare type UmiRequest = Partial<Request> & Pick<Request, 'url' | 'headers'>;
+export interface IServerLoaderArgs {
+    request: UmiRequest;
+}
+export declare type ServerLoader<T = any> = (req?: IServerLoaderArgs) => LoaderReturn<T>;
+export interface IMetaTag {
+    name: string;
+    content: string;
+}
+export interface IMetadata {
+    title?: string;
+    description?: string;
+    keywords?: string[];
+    /**
+     * @default 'en'
+     */
+    lang?: string;
+    metas?: IMetaTag[];
+}
+export declare type MetadataLoader<T = any> = (serverLoaderData: T, req?: IServerLoaderArgs) => LoaderReturn<IMetadata>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@umijs/server",
-  "version": "4.0.86",
+  "version": "4.0.88",
   "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.86"
+    "@umijs/bundler-utils": "4.0.88"
   },
   "publishConfig": {
     "access": "public"