@modern-js/server-core 2.48.1 → 2.48.3-alpha.0

package/dist/types/base/utils/request.d.ts

@@ -0,0 +1,12 @@
+export declare function parseQuery(request: Request): Record<string, string>;
+export declare function parseHeaders(request: Request): Record<string, string | undefined>;
+/**
+ * The function is modified based on
+ * https://github.com/honojs/hono/blob/main/src/utils/url.ts
+ *
+ * MIT Licensed
+ * https://github.com/honojs/hono/blob/main/LICENSE
+ *
+ */
+export declare function getPathname(request: Request): string;
+export declare function getHost(request: Request): string;

package/dist/types/base/utils/serverConfig.d.ts

@@ -0,0 +1,14 @@
+import { ServerConfig } from '../../core/plugin';
+import { ServerOptions } from '../../types/config';
+export declare const getServerConfigPath: (distDirectory: string, serverConfigFile?: string) => Promise<string>;
+export declare const requireConfig: (serverConfigPath: string) => any;
+/**
+ * 对配置进行合并，开发环境下，cliConfig 与 serverConfig 进行深合并
+ * 生产环境下，resolvedConfig 与 serverConfig 进行深合并
+ * resolvedConfigPath: 构建序列化后的 modern.config.js 文件路径
+ */
+export declare const loadConfig: ({ cliConfig, serverConfig, resolvedConfigPath, }: {
+    cliConfig: ServerOptions;
+    serverConfig: ServerConfig;
+    resolvedConfigPath: string;
+}) => any;

package/dist/types/base/utils/transformStream.d.ts

@@ -0,0 +1,5 @@
+import { MaybeAsync } from '@modern-js/plugin';
+type TransformCb = (tempalte: string) => MaybeAsync<string>;
+export declare function createTransformStream(fn: TransformCb): TransformStream<any, any>;
+export declare function transformResponse(response: Response, transformCb: Array<TransformCb> | TransformCb): Response;
+export {};

package/dist/types/base/utils/warmup.d.ts

@@ -0,0 +1 @@
+export declare function warmup(bundles: Array<string | undefined>): void;

package/dist/types/core/hono.d.ts

@@ -0,0 +1 @@
+export type { Context as HonoContext, Env as HonoEnv, HonoRequest, Next, MiddlewareHandler as HonoMiddleware, } from 'hono';

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

@@ -0,0 +1 @@
+export * from './plugin';

package/dist/types/core/loadPlugins.d.ts

@@ -0,0 +1,3 @@
+import { InternalPlugins } from '@modern-js/types';
+import { createPlugin } from '../core/plugin';
+export declare const loadPlugins: (appDirectory: string, internalPlugins: InternalPlugins) => ReturnType<typeof createPlugin>[];

package/dist/types/{plugin.d.ts → core/plugin.d.ts}

@@ -1,13 +1,15 @@
 /// <reference types="node" />
-/// <reference types="node" />
-import { IncomingMessage, ServerResponse } from 'http';
-import { Readable } from 'stream';
+import type { IncomingMessage, ServerResponse } from 'node:http';
 import type { Component } from 'react';
-import { CommonAPI, ToThreads, AsyncSetup, PluginOptions } from '@modern-js/plugin';
+import { CommonAPI, ToThreads, AsyncSetup, PluginOptions, ToRunners } from '@modern-js/plugin';
 import type { ModernServerContext, BaseSSRServerContext, AfterMatchContext, AfterRenderContext, MiddlewareContext, ISAppContext, ServerRoute, HttpMethodDecider, ServerInitHookContext, AfterStreamingRenderContext } from '@modern-js/types';
-import type { BffUserConfig, ServerOptions, UserConfig } from './types/config';
+import type { BffUserConfig, ServerOptions, UserConfig } from '../types/config';
+import { HonoMiddleware } from './hono';
+import { Render } from './render';
 export type WebAdapter = (ctx: MiddlewareContext) => void | Promise<void>;
-export type Adapter = (req: IncomingMessage, res: ServerResponse) => void | Promise<void>;
+export type NodeRequest = IncomingMessage;
+export type NodeResponse = ServerResponse;
+export type Adapter = (req: NodeRequest, res: NodeResponse) => void | Promise<void>;
 export type WebServerStartInput = {
     pwd: string;
     config: Record<string, any>;
@@ -20,7 +22,7 @@ export type APIServerStartInput = {
     config?: {
         middleware?: Array<any>;
     };
-    render?: (req: IncomingMessage, res: ServerResponse, url?: string) => Promise<string | Readable | null>;
+    render?: Render | null;
 };
 type Change = {
     filename: string;
@@ -59,12 +61,11 @@ declare const serverHooks: {
         serverRoutes: ServerRoute[];
         distDir: string;
     }, LoaderHandler>;
-    prepareWebServer: import("@modern-js/plugin").AsyncPipeline<WebServerStartInput, WebAdapter>;
-    prepareApiServer: import("@modern-js/plugin").AsyncPipeline<APIServerStartInput, Adapter>;
+    prepareWebServer: import("@modern-js/plugin").AsyncPipeline<WebServerStartInput, WebAdapter | null>;
+    prepareApiServer: import("@modern-js/plugin").AsyncPipeline<APIServerStartInput, HonoMiddleware>;
     repack: import("@modern-js/plugin").Waterfall<void>;
-    onApiChange: import("@modern-js/plugin").Waterfall<Change[]>;
+    onApiChange: import("@modern-js/plugin").AsyncWaterfall<Change[]>;
     beforeServerInit: import("@modern-js/plugin").AsyncWaterfall<ServerInitHookContext>;
-    afterServerInit: import("@modern-js/plugin").AsyncWaterfall<ServerInitHookContext>;
     setupCompiler: import("@modern-js/plugin").ParallelWorkflow<Record<string, unknown>, any[]>;
     beforeRouteSet: import("@modern-js/plugin").AsyncPipeline<Route[], Route[]>;
     afterRouteSet: import("@modern-js/plugin").AsyncPipeline<unknown, unknown>;
@@ -111,6 +112,8 @@ declare const serverHooks: {
 export type ServerHooks = typeof serverHooks;
 /** All hook callbacks of server plugin. */
 export type ServerHookCallbacks = ToThreads<ServerHooks>;
+/** The ServerHook Runner type */
+export type ServerHookRunner = ToRunners<ServerHooks>;
 /** All apis for server plugin. */
 export type PluginAPI = typeof pluginAPI & CommonAPI<ServerHooks>;
 export declare const createServerManager: () => import("@modern-js/plugin").AsyncManager<{
@@ -124,12 +127,11 @@ export declare const createServerManager: () => import("@modern-js/plugin").Asyn
         serverRoutes: ServerRoute[];
         distDir: string;
     }, LoaderHandler>;
-    prepareWebServer: import("@modern-js/plugin").AsyncPipeline<WebServerStartInput, WebAdapter>;
-    prepareApiServer: import("@modern-js/plugin").AsyncPipeline<APIServerStartInput, Adapter>;
+    prepareWebServer: import("@modern-js/plugin").AsyncPipeline<WebServerStartInput, WebAdapter | null>;
+    prepareApiServer: import("@modern-js/plugin").AsyncPipeline<APIServerStartInput, HonoMiddleware>;
     repack: import("@modern-js/plugin").Waterfall<void>;
-    onApiChange: import("@modern-js/plugin").Waterfall<Change[]>;
+    onApiChange: import("@modern-js/plugin").AsyncWaterfall<Change[]>;
     beforeServerInit: import("@modern-js/plugin").AsyncWaterfall<ServerInitHookContext>;
-    afterServerInit: import("@modern-js/plugin").AsyncWaterfall<ServerInitHookContext>;
     setupCompiler: import("@modern-js/plugin").ParallelWorkflow<Record<string, unknown>, any[]>;
     beforeRouteSet: import("@modern-js/plugin").AsyncPipeline<Route[], Route[]>;
     afterRouteSet: import("@modern-js/plugin").AsyncPipeline<unknown, unknown>;
@@ -187,12 +189,11 @@ export declare const serverManager: import("@modern-js/plugin").AsyncManager<{
         serverRoutes: ServerRoute[];
         distDir: string;
     }, LoaderHandler>;
-    prepareWebServer: import("@modern-js/plugin").AsyncPipeline<WebServerStartInput, WebAdapter>;
-    prepareApiServer: import("@modern-js/plugin").AsyncPipeline<APIServerStartInput, Adapter>;
+    prepareWebServer: import("@modern-js/plugin").AsyncPipeline<WebServerStartInput, WebAdapter | null>;
+    prepareApiServer: import("@modern-js/plugin").AsyncPipeline<APIServerStartInput, HonoMiddleware>;
     repack: import("@modern-js/plugin").Waterfall<void>;
-    onApiChange: import("@modern-js/plugin").Waterfall<Change[]>;
+    onApiChange: import("@modern-js/plugin").AsyncWaterfall<Change[]>;
     beforeServerInit: import("@modern-js/plugin").AsyncWaterfall<ServerInitHookContext>;
-    afterServerInit: import("@modern-js/plugin").AsyncWaterfall<ServerInitHookContext>;
     setupCompiler: import("@modern-js/plugin").ParallelWorkflow<Record<string, unknown>, any[]>;
     beforeRouteSet: import("@modern-js/plugin").AsyncPipeline<Route[], Route[]>;
     afterRouteSet: import("@modern-js/plugin").AsyncPipeline<unknown, unknown>;
@@ -256,12 +257,11 @@ export declare const createPlugin: (setup?: AsyncSetup<{
         serverRoutes: ServerRoute[];
         distDir: string;
     }, LoaderHandler>;
-    prepareWebServer: import("@modern-js/plugin").AsyncPipeline<WebServerStartInput, WebAdapter>;
-    prepareApiServer: import("@modern-js/plugin").AsyncPipeline<APIServerStartInput, Adapter>;
+    prepareWebServer: import("@modern-js/plugin").AsyncPipeline<WebServerStartInput, WebAdapter | null>;
+    prepareApiServer: import("@modern-js/plugin").AsyncPipeline<APIServerStartInput, HonoMiddleware>;
     repack: import("@modern-js/plugin").Waterfall<void>;
-    onApiChange: import("@modern-js/plugin").Waterfall<Change[]>;
+    onApiChange: import("@modern-js/plugin").AsyncWaterfall<Change[]>;
     beforeServerInit: import("@modern-js/plugin").AsyncWaterfall<ServerInitHookContext>;
-    afterServerInit: import("@modern-js/plugin").AsyncWaterfall<ServerInitHookContext>;
     setupCompiler: import("@modern-js/plugin").ParallelWorkflow<Record<string, unknown>, any[]>;
     beforeRouteSet: import("@modern-js/plugin").AsyncPipeline<Route[], Route[]>;
     afterRouteSet: import("@modern-js/plugin").AsyncPipeline<unknown, unknown>;
@@ -318,12 +318,11 @@ export declare const createPlugin: (setup?: AsyncSetup<{
         serverRoutes: ServerRoute[];
         distDir: string;
     }, LoaderHandler>;
-    prepareWebServer: import("@modern-js/plugin").AsyncPipeline<WebServerStartInput, WebAdapter>;
-    prepareApiServer: import("@modern-js/plugin").AsyncPipeline<APIServerStartInput, Adapter>;
+    prepareWebServer: import("@modern-js/plugin").AsyncPipeline<WebServerStartInput, WebAdapter | null>;
+    prepareApiServer: import("@modern-js/plugin").AsyncPipeline<APIServerStartInput, HonoMiddleware>;
     repack: import("@modern-js/plugin").Waterfall<void>;
-    onApiChange: import("@modern-js/plugin").Waterfall<Change[]>;
+    onApiChange: import("@modern-js/plugin").AsyncWaterfall<Change[]>;
     beforeServerInit: import("@modern-js/plugin").AsyncWaterfall<ServerInitHookContext>;
-    afterServerInit: import("@modern-js/plugin").AsyncWaterfall<ServerInitHookContext>;
     setupCompiler: import("@modern-js/plugin").ParallelWorkflow<Record<string, unknown>, any[]>;
     beforeRouteSet: import("@modern-js/plugin").AsyncPipeline<Route[], Route[]>;
     afterRouteSet: import("@modern-js/plugin").AsyncPipeline<unknown, unknown>;
@@ -376,12 +375,11 @@ export declare const createPlugin: (setup?: AsyncSetup<{
         serverRoutes: ServerRoute[];
         distDir: string;
     }, LoaderHandler>;
-    prepareWebServer: import("@modern-js/plugin").AsyncPipeline<WebServerStartInput, WebAdapter>;
-    prepareApiServer: import("@modern-js/plugin").AsyncPipeline<APIServerStartInput, Adapter>;
+    prepareWebServer: import("@modern-js/plugin").AsyncPipeline<WebServerStartInput, WebAdapter | null>;
+    prepareApiServer: import("@modern-js/plugin").AsyncPipeline<APIServerStartInput, HonoMiddleware>;
     repack: import("@modern-js/plugin").Waterfall<void>;
-    onApiChange: import("@modern-js/plugin").Waterfall<Change[]>;
+    onApiChange: import("@modern-js/plugin").AsyncWaterfall<Change[]>;
     beforeServerInit: import("@modern-js/plugin").AsyncWaterfall<ServerInitHookContext>;
-    afterServerInit: import("@modern-js/plugin").AsyncWaterfall<ServerInitHookContext>;
     setupCompiler: import("@modern-js/plugin").ParallelWorkflow<Record<string, unknown>, any[]>;
     beforeRouteSet: import("@modern-js/plugin").AsyncPipeline<Route[], Route[]>;
     afterRouteSet: import("@modern-js/plugin").AsyncPipeline<unknown, unknown>;
@@ -438,12 +436,11 @@ export declare const createPlugin: (setup?: AsyncSetup<{
         serverRoutes: ServerRoute[];
         distDir: string;
     }, LoaderHandler>;
-    prepareWebServer: import("@modern-js/plugin").AsyncPipeline<WebServerStartInput, WebAdapter>;
-    prepareApiServer: import("@modern-js/plugin").AsyncPipeline<APIServerStartInput, Adapter>;
+    prepareWebServer: import("@modern-js/plugin").AsyncPipeline<WebServerStartInput, WebAdapter | null>;
+    prepareApiServer: import("@modern-js/plugin").AsyncPipeline<APIServerStartInput, HonoMiddleware>;
     repack: import("@modern-js/plugin").Waterfall<void>;
-    onApiChange: import("@modern-js/plugin").Waterfall<Change[]>;
+    onApiChange: import("@modern-js/plugin").AsyncWaterfall<Change[]>;
     beforeServerInit: import("@modern-js/plugin").AsyncWaterfall<ServerInitHookContext>;
-    afterServerInit: import("@modern-js/plugin").AsyncWaterfall<ServerInitHookContext>;
     setupCompiler: import("@modern-js/plugin").ParallelWorkflow<Record<string, unknown>, any[]>;
     beforeRouteSet: import("@modern-js/plugin").AsyncPipeline<Route[], Route[]>;
     afterRouteSet: import("@modern-js/plugin").AsyncPipeline<unknown, unknown>;

package/dist/types/core/render.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="node" />
+import type { IncomingMessage } from 'node:http';
+import type { Logger, Reporter } from '@modern-js/types';
+import type { ServerManifest } from './server';
+export interface RenderOptions {
+    logger: Logger;
+    /** ssr render html templates */
+    templates: Record<string, string>;
+    serverManifest: ServerManifest;
+    reporter?: Reporter;
+    nodeReq?: IncomingMessage;
+}
+export type Render = (request: Request, options: RenderOptions) => Promise<Response>;

package/dist/types/core/server.d.ts

@@ -0,0 +1,99 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import type { IncomingMessage, Server, ServerResponse } from 'node:http';
+import type { Readable } from 'node:stream';
+import type { Metrics, Logger, NextFunction, ModernServerContext, InternalPlugins, Reporter, BaseSSRServerContext, ServerRoute, NestedRoute } from '@modern-js/types';
+import { MiddlewareHandler } from 'hono';
+import { ServerOptions } from '../types/config/index';
+import { ServerHookRunner, ServerPlugin } from './plugin';
+import { HonoEnv } from './hono';
+declare module 'http' {
+    interface IncomingMessage {
+        logger: Logger;
+        metrics: Metrics;
+        reporter?: Reporter;
+        body?: any;
+    }
+    interface OutgoingMessage {
+        set: (key: string, value: any) => this;
+        modernFlushedHeaders?: boolean;
+    }
+}
+export type ServerBaseOptions = {
+    /** server working directory, and then also dist directory */
+    pwd: string;
+    config: ServerOptions;
+    serverConfigFile?: string;
+    routes?: ServerRoute[];
+    plugins?: ServerPlugin[];
+    internalPlugins?: InternalPlugins;
+    appContext: {
+        appDirectory?: string;
+        sharedDirectory?: string;
+        apiDirectory?: string;
+        lambdaDirectory?: string;
+    };
+    runMode?: 'apiOnly' | 'ssrOnly' | 'webOnly';
+};
+export type SSRServerContext = BaseSSRServerContext & {
+    staticGenerate?: boolean;
+};
+export type ServerRender = (ssrContext: SSRServerContext) => Promise<string | Readable | ReadableStream>;
+export type RenderResult = {
+    content: string | Buffer;
+    contentType: string;
+    contentStream?: Readable;
+    statusCode?: number;
+    redirect?: boolean;
+};
+export type ConfWithBFF = {
+    bff?: {
+        prefix: string;
+    } & ServerOptions['bff'];
+};
+export type Then<T> = T extends PromiseLike<infer U> ? U : T;
+export type { Metrics, Logger, NextFunction };
+export type HookNames = 'afterMatch' | 'afterRender';
+export interface ModernServerInterface {
+    pwd: string;
+    distDir: string;
+    onInit: (runner: ServerHookRunner, app: Server) => Promise<void>;
+    getRequestHandler: () => (req: IncomingMessage, res: ServerResponse, next?: () => void) => void;
+    createHTTPServer: (handler: (req: IncomingMessage, res: ServerResponse, next?: () => void) => void) => Promise<Server>;
+    render: (req: IncomingMessage, res: ServerResponse, url?: string) => Promise<string | Readable | null>;
+    close?: () => Promise<void>;
+}
+export type ServerConstructor = (options: ServerBaseOptions) => ModernServerInterface;
+export type ModernServerHandler = (context: ModernServerContext, next: NextFunction) => Promise<void> | void;
+export type Middleware<Env extends HonoEnv = any> = MiddlewareHandler<Env>;
+export type RequestHandler = (request: Request, ...args: any[]) => Response | Promise<Response>;
+type ServerLoaderBundle = {
+    routes: NestedRoute[];
+    handleRequest: (options: {
+        request: Request;
+        serverRoutes: ServerRoute[];
+        context: any;
+        routes: NestedRoute[];
+    }) => Promise<any>;
+};
+type ServerRenderBundle = {
+    serverRender: () => any;
+};
+export type ServerManifest = {
+    loaderBundles?: Record<string, ServerLoaderBundle>;
+    renderBundles?: Record<string, ServerRenderBundle>;
+    loadableStats?: Record<string, any>;
+    routeManifest?: Record<string, any>;
+};
+type ServerVariables = {
+    logger: Logger;
+    reporter?: Reporter;
+    serverManifest?: ServerManifest;
+    metrics?: Metrics;
+    templates?: Record<string, string>;
+};
+export type ServerEnv = {
+    Variables: ServerVariables;
+};
+export type { HonoContext, HonoEnv, HonoRequest, Next, HonoMiddleware, } from './hono';

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
-export * from './plugin';
+export * from './core/plugin';
+export * from './core/render';
 export * from '@modern-js/plugin';
-export * from './loadPlugins';
+export * from './core/loadPlugins';
 export * from './types/config';

package/package.json

@@ -15,7 +15,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.48.1",
+  "version": "2.48.3-alpha.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/cjs/index.js",
@@ -29,23 +29,58 @@
         "require": "./dist/cjs/index.js"
       },
       "default": "./dist/cjs/index.js"
+    },
+    "./base": {
+      "types": "./dist/types/base/index.d.ts",
+      "jsnext:source": "./src/base/index.ts",
+      "node": {
+        "require": "./dist/cjs/base/index.js",
+        "import": "./dist/esm/base/index.js"
+      },
+      "default": "./dist/esm-node/base/index.js"
+    },
+    "./base/node": {
+      "types": "./dist/types/base/adapters/node/index.d.ts",
+      "import": "./dist/esm/base/adapters/node/index.js",
+      "default": "./dist/cjs/base/adapters/node/index.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/types/index.d.ts"
+      ],
+      "base": [
+        "./dist/types/base/index.d.ts"
+      ],
+      "base/node": [
+        "./dist/types/base/adapters/node/index.d.ts"
+      ]
     }
   },
   "dependencies": {
     "@swc/helpers": "0.5.3",
-    "@modern-js/plugin": "2.48.1",
-    "@modern-js/utils": "2.48.1"
+    "@web-std/fetch": "^4.2.1",
+    "@web-std/stream": "^1.0.3",
+    "@web-std/file": "^3.0.3",
+    "hono": "^3.12.2",
+    "isbot": "3.8.0",
+    "merge-deep": "^3.0.3",
+    "@modern-js/plugin": "2.48.2",
+    "@modern-js/runtime-utils": "2.48.2",
+    "@modern-js/utils": "2.48.2"
   },
   "devDependencies": {
     "@types/jest": "^29",
+    "@types/merge-deep": "^3.0.0",
     "@types/node": "^14",
     "http-proxy-middleware": "^2.0.4",
     "jest": "^29",
     "ts-jest": "^29.1.0",
     "typescript": "^5",
-    "@modern-js/types": "2.48.1",
-    "@scripts/build": "2.48.1",
-    "@scripts/jest-config": "2.48.1"
+    "@modern-js/types": "2.48.2",
+    "@scripts/build": "2.48.2",
+    "@scripts/jest-config": "2.48.2"
   },
   "sideEffects": false,
   "publishConfig": {

package/dist/types/loadPlugins.d.ts

@@ -1,5 +0,0 @@
-import { InternalPlugins } from '@modern-js/types';
-import { createPlugin, ServerPlugin } from './plugin';
-export declare const loadPlugins: (appDirectory: string, configPlugins: ServerPlugin[], options: {
-    internalPlugins?: InternalPlugins;
-}) => ReturnType<typeof createPlugin>[];