@modern-js/types 2.69.4 → 3.0.0-alpha.0

package/cli/index.d.ts

@@ -27,11 +27,6 @@ export interface Entrypoint {
   nestedRoutesEntry?: string;
   pageRoutesEntry?: string;
   isAutoMount?: boolean;
-  /**
-   * @deprecated
-   * Using customEntry instead.
-   */
-  customBootstrap?: string | false;
   /**
    * use src/{entryName}/entry.tsx to custom entry
    */
@@ -82,6 +77,9 @@ export type NestedRouteForCli = NestedRoute<string>;
 
 export interface NestedRoute<T = string | (() => JSX.Element)> extends Route {
   type: 'nested';
+  origin: 'file-system' | 'config';
+  // Route type to distinguish between page and layout routes
+  routeType?: 'page' | 'layout';
   parentId?: string;
   data?: string;
   clientData?: string;
@@ -95,6 +93,7 @@ export interface NestedRoute<T = string | (() => JSX.Element)> extends Route {
   isRoot?: boolean;
   config?: string | Record<string, any>;
   inValidSSRRoute?: boolean;
+  params?: string[];
 }
 
 export interface PageRoute extends Route {
@@ -123,27 +122,29 @@ export type SSGRouteOptions =
   | {
       url: string;
       output?: string;
-      params?: Record<string, any>[];
       headers?: Record<string, any>;
     };
 
 export type SSGSingleEntryOptions =
   | boolean
   | {
-      preventDefault?: string[];
       headers?: Record<string, any>;
       routes?: SSGRouteOptions[];
     };
 
-export type SSGMultiEntryOptions = Record<string, SSGSingleEntryOptions>;
+export type SSGSingleEntryOptionsFactory = (
+  entryName: string,
+  ctx: { baseUrl?: string | string[] },
+) => SSGSingleEntryOptions;
+
+export type SSGMultiEntryOptions = Record<
+  string,
+  SSGSingleEntryOptions | SSGSingleEntryOptionsFactory
+>;
 
 export type SSGConfig =
   | boolean
   | SSGSingleEntryOptions
-  | SSGMultiEntryOptions
-  | ((
-      entryName: string,
-      payload: { baseUrl?: string },
-    ) => SSGSingleEntryOptions);
+  | SSGSingleEntryOptionsFactory;
 
 export type { Merge } from 'type-fest';

package/common/index.d.ts

@@ -12,4 +12,4 @@ export type ServerPlugin = {
   options?: Record<string, any>;
 };
 
-export type SSRMode = 'string' | 'stream';
+export type SSRMode = 'string' | 'stream' | false;

package/package.json

@@ -15,7 +15,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.69.4",
+  "version": "3.0.0-alpha.0",
   "types": "./index.d.ts",
   "exports": {
     ".": {
@@ -43,13 +43,9 @@
   },
   "devDependencies": {
     "@types/babel__core": "^7.20.5",
-    "@types/jest": "^29",
-    "@types/node": "^18",
+    "@types/node": "^20",
     "http-proxy-middleware": "^2.0.9",
-    "jest": "^29",
-    "type-fest": "2.15.0",
-    "@scripts/jest-config": "2.66.0",
-    "@scripts/build": "2.66.0"
+    "type-fest": "2.19.0"
   },
   "sideEffects": false,
   "publishConfig": {
@@ -57,7 +53,7 @@
     "access": "public"
   },
   "scripts": {
-    "test": "jest --passWithNoTests"
+    "test": "rstest --passWithNoTests"
   },
   "main": ""
 }

package/rstest.config.ts

@@ -0,0 +1,5 @@
+import { defineConfig } from '@rstest/core';
+
+export default defineConfig({
+  globals: true,
+});

package/server/context.d.ts

@@ -69,6 +69,7 @@ export interface BaseResponseLike {
 }
 
 export type BaseSSRServerContext<T extends 'node' | 'worker' = 'node'> = {
+  baseUrl: string;
   request: {
     params: Record<string, string>;
     pathname: string;
@@ -80,10 +81,8 @@ export type BaseSSRServerContext<T extends 'node' | 'worker' = 'node'> = {
     userAgent?: string;
     cookie?: string;
     cookieMap?: Record<string, string>;
-    [propsName: string]: any;
   };
   response: BaseResponseLike;
-  redirection: { url?: string; status?: number };
   loadableStats: Record<string, any>;
   routeManifest?: Record<string, any>;
   template: string;
@@ -93,46 +92,11 @@ export type BaseSSRServerContext<T extends 'node' | 'worker' = 'node'> = {
   serverTiming: ServerTiming;
   reporter?: Reporter;
   metrics?: Metrics;
-
-  // TODO: remove it
-  /** @deprecated */
-  cacheConfig?: any;
-
-  enableUnsafeCtx?: boolean;
-
   nonce?: string;
-
-  /** @deprecated source req */
-  req?: T extends 'worker' ? Request : ModernServerContext['req'];
-
-  /** @deprecated source res */
-  res?: T extends 'worker' ? BaseResponseLike : ModernServerContext['res'];
-
   /** SSR type  */
   mode?: SSRMode;
-
-  /** Check if it's spider request */
-  isSpider?: boolean;
 };
 
 export interface ServerInitHookContext {
   app?: HttpServer;
 }
-
-/**
- * This type extends the `serverContext` type and is also compatible with `ServerPluginLegacy`.
- * Future implementations should consider it as an extension of the `serverContext` type.
- */
-export interface ISAppContext {
-  appDirectory: string;
-  internalDirectory: string;
-  apiDirectory?: string;
-  lambdaDirectory?: string;
-  distDirectory: string;
-  sharedDirectory: string;
-  plugins: {
-    server?: any;
-    serverPkg?: any;
-  }[];
-  [key: string]: unknown;
-}

package/server/devServer.d.ts

@@ -1,5 +1,5 @@
 import type { NodeRequest, NodeResponse } from '@modern-js/server-core/node';
-import type { BffProxyOptions, NextFunction } from './utils';
+import type { DevProxyOptions, NextFunction } from './utils';
 
 export type DevServerHttpsOptions = boolean | { key: string; cert: string };
 
@@ -15,59 +15,3 @@ export type ExposeServerApis = {
     data?: string | boolean | Record<string, any>,
   ) => void;
 };
-
-export type DevServerOptions = {
-  /** config of hmr client. */
-  client?: {
-    path?: string;
-    port?: string;
-    host?: string;
-    protocol?: 'ws' | 'wss';
-  };
-  /** Whether to enable gzip compression */
-  compress?: boolean;
-  devMiddleware?: {
-    writeToDisk?: boolean | ((filename: string) => boolean);
-    outputFileSystem?: Record<string, any>;
-  };
-  proxy?: BffProxyOptions;
-  headers?: Record<string, string | string[]>;
-  before?: RequestHandler[];
-  after?: RequestHandler[];
-  /** Provides the ability to execute a custom function and apply custom middlewares */
-  setupMiddlewares?: Array<
-    (
-      /** Order: `devServer.before` => `unshift` => internal middlewares => `push` => `devServer.after` */
-      middlewares: {
-        /** Use the `unshift` method if you want to run a middleware before all other middlewares */
-        unshift: (...handlers: RequestHandler[]) => void;
-        /** Use the `push` method if you want to run a middleware after all other middlewares */
-        push: (...handlers: RequestHandler[]) => void;
-      },
-      server: ExposeServerApis,
-    ) => void
-  >;
-  /** Whether to watch files change. */
-  watch?: boolean;
-  /** Whether to enable hot reload. */
-  hot?: boolean;
-  /** Whether to enable page reload. */
-  liveReload?: boolean;
-  /** Whether to enable https. */
-  https?: DevServerHttpsOptions;
-  /** see https://github.com/bripkens/connect-history-api-fallback */
-  historyApiFallback?:
-    | boolean
-    | {
-        index?: string;
-        verbose?: boolean;
-        logger?: typeof console.log;
-        htmlAcceptHeaders?: string[];
-        disableDotRule?: true;
-        rewrites?: Array<{
-          from: RegExp;
-          to: string | RegExp | function;
-        }>;
-      };
-  [propName: string]: any;
-};

package/server/rsc.d.ts

@@ -52,70 +52,3 @@ export type ServerManifest = {
 export type ClientManifest = {
   [id: string]: ImportManifestEntry;
 };
-
-declare module '@modern-js/utils/react-server-dom-webpack/server' {
-  export const registerClientReference: <T>(
-    proxyImplementation: any,
-    id: string,
-    exportName: string,
-  ) => ClientReference[];
-
-  export const registerServerReference: <T>(
-    proxyImplementation: any,
-    id: string,
-    exportName: string,
-  ) => ServerReference[];
-}
-
-declare module '@modern-js/utils/react-server-dom-webpack/server.edge' {
-  type Options = {
-    environmentName?: string;
-    identifierPrefix?: string;
-    signal?: AbortSignal;
-    temporaryReferences?: TemporaryReferenceSet;
-    onError?: ((error: unknown) => void) | undefined;
-    onPostpone?: ((reason: string) => void) | undefined;
-  };
-
-  export function renderToReadableStream(
-    model: ReactClientValue,
-    webpackMap: ClientManifest,
-    options?: Options,
-  ): ReadableStream;
-  export function decodeReply<T>(
-    body: string | FormData,
-    webpackMap?: ServerManifest,
-  ): Promise<T>;
-}
-
-declare module '@modern-js/utils/react-server-dom-webpack/client' {
-  type CallServerCallback = <T, A extends unknown[] = unknown[]>(
-    string,
-    args: A,
-  ) => Promise<T>;
-
-  type Options<T> = {
-    callServer?: CallServerCallback<T>;
-    temporaryReferences?: TemporaryReferenceSet;
-  };
-
-  export function createFromFetch<T>(
-    promiseForResponse: Promise<Response>,
-    options?: Options<T>,
-  ): Promise<T>;
-  export function encodeReply(
-    value: ReactServerValue,
-    options?: { temporaryReferences?: TemporaryReferenceSet },
-  ): Promise<string | URLSearchParams | FormData>;
-}
-
-declare module '@modern-js/utils/react-server-dom-webpack/client.edge' {
-  export type Options = {
-    ssrManifest: SSRManifest;
-    nonce?: string;
-  };
-  export function createFromReadableStream<T>(
-    stream: ReadableStream,
-    options: Options<T>,
-  ): Promise<T>;
-}

package/server/utils.d.ts

@@ -68,12 +68,12 @@ export type ProxyDetail = ProxyOptions & {
   bypass?: (
     req: IncomingMessage,
     res: ServerResponse,
-    proxyOptions: BffProxyOptions,
+    proxyOptions: DevProxyOptions,
   ) => string | undefined | null | false;
   context?: ProxyFilter;
 };
 
-export type BffProxyOptions =
+export type DevProxyOptions =
   | Record<string, string>
   | Record<string, ProxyDetail>
   | ProxyDetail[]

package/server/middleware.d.ts

@@ -1,40 +0,0 @@
-import type { RequestPayload } from './context';
-import type { ServerRoute } from './route';
-
-type Set<V extends Record<string>> = <Key extends keyof V>(
-  key: Key,
-  value: V[Key],
-) => void;
-
-type Get<V extends Record<string, unknown>> = <Key extends keyof V>(
-  key: Key,
-) => V[Key];
-
-type Body = ReadableStream | ArrayBuffer | string | null;
-
-export type UnstableMiddlewareContext<
-  V extends Record<string, unknown> = Record<string, unknown>,
-> = {
-  request: Request;
-  response: Response;
-  route: Required<Pick<ServerRoute, 'entryName'>>;
-  get: Get<V & RequestPayload>;
-  set: Set<V & RequestPayload>;
-  header: (name: string, value: string, options?: { append?: boolean }) => void;
-  status: (code: number) => void;
-  redirect: (location: string, status?: number) => Response;
-  body: (data: Body, init?: ResponseInit) => Response;
-  html: (
-    data: string | Promise<string>,
-    init?: ResponseInit,
-  ) => Response | Promise<Response>;
-};
-
-export type UnstableNext = () => Promise<void>;
-
-export type UnstableMiddleware<
-  V extends Record<string, unknown> = Record<string, unknown>,
-> = (
-  c: UnstableMiddlewareContext<V>,
-  next: UnstableNext,
-) => Promise<void | Response>;