@modern-js/types 1.21.3 → 2.0.0-beta.0

package/CHANGELOG.md

@@ -1,6 +1,27 @@
 # @modern-js/types
 
-## 1.21.3
+## 2.0.0-beta.0
+
+### Major Changes
+
+- dda38c9: chore: v2
+
+### Patch Changes
+
+- cc971eabf: refactor: move server plugin load logic in `@modern-js/core`
+  refactor：移除在 `@modern-js/core` 中的 server 插件加载逻辑
+- 6bda14ed7: feat: refactor router with react-router@6.4
+
+  feat: 使用 react-router@6.4 重构路由模块
+
+- 102d32e4b: feat(server): add `req` and `res` to SSR context
+
+  feat(server): 添加 `req` 和 `res` 到 SSR context 中
+
+- 8b8e1bb57: feat: support nested routes
+  feat: 支持嵌套路由
+- 3bbea92b2: feat: support Hook、Middleware new API
+  feat: 支持 Hook、Middleware 的新 API
 
 ## 1.21.2
 

package/cli/index.d.ts

@@ -1,3 +1,5 @@
+import type { Merge } from 'type-fest';
+import { InternalPlugins } from '../common';
 import { ServerRoute } from '../server';
 
 /**
@@ -6,6 +8,7 @@ import { ServerRoute } from '../server';
 export interface Entrypoint {
   entryName: string;
   entry: string;
+  nestedRoutesEntry?: string;
   isAutoMount?: boolean;
   customBootstrap?: string | false;
   fileSystemRoutes?: {
@@ -17,14 +20,57 @@ export interface Entrypoint {
 /**
  * file system routes.
  */
-export interface Route {
+export type RouteLegacy = {
   path: string;
   exact: boolean;
   component: string;
   _component: string;
-  routes?: Route[];
-  parent?: Route;
-}
+  routes?: RouteLegacy[];
+  parent?: RouteLegacy;
+};
+
+export type Route = Partial<{
+  caseSensitive: boolean;
+  path: string;
+  id: string;
+  loader: any;
+  action: any;
+  hasErrorBoundary: boolean;
+  shouldRevalidate: any;
+  handle: any;
+  index: boolean;
+  children: Route[] | undefined;
+  element: React.ReactNode | null;
+  errorElement: React.ReactNode | null;
+}> & {
+  type: string;
+};
+
+export type NestedRoute = Merge<
+  Route,
+  {
+    type: 'nested';
+    parentId?: string;
+    children?: NestedRoute[];
+    childIds?: string[];
+    filename?: string;
+    _component?: string;
+    component?: string;
+    loading?: string;
+    error?: string;
+  }
+>;
+
+export type PageRoute = Merge<
+  Route,
+  {
+    type: 'page';
+    parent?: PageRoute;
+    _component: string;
+    component: string;
+    children?: PageRoute[];
+  }
+>;
 
 /**
  * custom html partials.
@@ -44,6 +90,7 @@ export interface IAppContext {
   appDirectory: string;
   configFile: string | false;
   serverConfigFile: string;
+  serverInternalPlugins: InternalPlugins;
   ip?: string;
   port?: number;
   distDirectory: string;
@@ -52,11 +99,7 @@ export interface IAppContext {
   sharedDirectory: string;
   nodeModulesDirectory: string;
   internalDirectory: string;
-  plugins: {
-    cli?: any;
-    server?: any;
-    serverPkg?: any;
-  }[];
+  plugins: any[];
   entrypoints: Entrypoint[];
   checkedEntries: string[];
   serverRoutes: ServerRoute[];
@@ -65,3 +108,5 @@ export interface IAppContext {
   internalDirAlias: string;
   internalSrcAlias: string;
 }
+
+export type { Merge } from 'type-fest';

package/common/index.d.ts

@@ -0,0 +1,4 @@
+export type InternalPlugins = Record<
+  string,
+  string | { path: string; forced?: boolean }
+>;

package/index.d.ts

@@ -1,2 +1,3 @@
 export * from './server';
 export * from './cli';
+export * from './common';

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.21.3",
+  "version": "2.0.0-beta.0",
   "types": "./index.d.ts",
   "exports": {
     ".": "./index.d.ts",
@@ -20,33 +20,32 @@
       "default": "./server/index.d.ts"
     }
   },
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./index.d.ts"
+      ],
+      "hoist-non-react-statics": [
+        "./packages/hoist-non-react-statics.d.ts"
+      ]
+    }
+  },
   "devDependencies": {
-    "@scripts/build": "1.21.3",
-    "@scripts/jest-config": "1.21.3",
+    "@scripts/build": "2.0.0-beta.0",
+    "@scripts/jest-config": "2.0.0-beta.0",
     "@types/jest": "^27",
     "@types/node": "^14",
     "http-proxy-middleware": "^2.0.4",
-    "jest": "^27"
+    "jest": "^27",
+    "type-fest": "2.15.0"
   },
   "sideEffects": false,
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
-  "wireit": {
-    "test": {
-      "command": "jest --passWithNoTests",
-      "files": [
-        "src/**/*",
-        "tsconfig.json",
-        "package.json",
-        "tests/**/*"
-      ],
-      "output": []
-    }
-  },
   "scripts": {
-    "test": "wireit"
+    "test": "jest --passWithNoTests"
   },
   "main": ""
 }

package/packages/hoist-non-react-statics.d.ts

@@ -0,0 +1,77 @@
+// eslint-disable-next-line @typescript-eslint/naming-convention
+interface REACT_STATICS {
+  childContextTypes: true;
+  contextType: true;
+  contextTypes: true;
+  defaultProps: true;
+  displayName: true;
+  getDefaultProps: true;
+  getDerivedStateFromError: true;
+  getDerivedStateFromProps: true;
+  mixins: true;
+  propTypes: true;
+  type: true;
+}
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+interface KNOWN_STATICS {
+  name: true;
+  length: true;
+  prototype: true;
+  caller: true;
+  callee: true;
+  arguments: true;
+  arity: true;
+}
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+interface MEMO_STATICS {
+  $$typeof: true;
+  compare: true;
+  defaultProps: true;
+  displayName: true;
+  propTypes: true;
+  type: true;
+}
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+interface FORWARD_REF_STATICS {
+  $$typeof: true;
+  render: true;
+  defaultProps: true;
+  displayName: true;
+  propTypes: true;
+}
+declare namespace hoistNonReactStatics {
+  type NonReactStatics<
+    S extends React.ComponentType<any>,
+    C extends {
+      [key: string]: true;
+      // eslint-disable-next-line @typescript-eslint/ban-types
+    } = {},
+  > = {
+    [key in Exclude<
+      keyof S,
+      S extends React.MemoExoticComponent<any>
+        ? keyof MEMO_STATICS | keyof C
+        : S extends React.ForwardRefExoticComponent<any>
+        ? keyof FORWARD_REF_STATICS | keyof C
+        : keyof REACT_STATICS | keyof KNOWN_STATICS | keyof C
+    >]: S[key];
+  };
+}
+declare module 'hoist-non-react-statics' {
+  declare function hoistNonReactStatics<
+    T extends React.ComponentType<any>,
+    S extends React.ComponentType<any>,
+    C extends {
+      [key: string]: true;
+      // eslint-disable-next-line @typescript-eslint/ban-types
+    } = {},
+  >(
+    TargetComponent: T,
+    SourceComponent: S,
+    customStatic?: C,
+  ): T & hoistNonReactStatics.NonReactStatics<S, C>;
+  export default hoistNonReactStatics;
+}

package/server/context.d.ts

@@ -6,7 +6,7 @@ import { Metrics, Logger } from './utils';
 export interface ModernServerContext {
   req: IncomingMessage;
 
-  res: ServerResponse;
+  res: ServerResponse & { locals?: Record<string, any> };
 
   params: Record<string, string>;
 
@@ -64,6 +64,7 @@ export type BaseSSRServerContext = {
   response: {
     setHeader: (key: string, value: string) => void;
     status: (code: number) => void;
+    locals: Record<string, any>;
   };
   redirection: { url?: string; status?: number };
   loadableStats: Record<string, any>;
@@ -87,8 +88,11 @@ export type BaseSSRServerContext = {
     ) => void;
   };
   cacheConfig?: any;
-};
 
+  req: ModernServerContext['req'];
+
+  res: ModernServerContext['res'];
+};
 export interface ISAppContext {
   appDirectory: string;
   distDirectory: string;

package/server/hook.d.ts

@@ -1,35 +1,66 @@
 import { IncomingMessage, ServerResponse } from 'http';
-import { ServerRoute as Route } from './route';
-import { NextFunction } from './utils';
-import { ModernServerContext } from './context';
 
-type Middleware = (
-  req: IncomingMessage,
-  res: ServerResponse,
-  next: NextFunction,
-) => Promise<void>;
+export type CookieAPI = {
+  get: (key: string) => string;
+  set: (key: string, value: string) => void;
+  delete: (key: string) => void;
+  clear: () => void;
+  apply: () => void;
+};
+
+export interface ModernResponse {
+  get: (key: string) => string | number | string[] | undefined;
+  set: (key: string, value: string) => void;
+  status: (code: number) => void;
+  cookies: CookieAPI;
+  raw: (
+    body: string,
+    { status, headers }: { status: number; headers: Record<string, any> },
+  ) => void;
+}
+
+export interface ModernRequest {
+  host: string;
+  pathname: string;
+  query: Record<string, any>;
+  cookie: string;
+  cookies: Pick<CookieAPI, 'get'>;
+  headers: IncomingHttpHeaders;
+}
+
+export type HookContext = {
+  response: ModernResponse;
+  request: ModernRequest;
+  logger: Logger;
+  metrics?: Metrics;
+};
 
-export type TemplateAPI = {
-  get: () => Promise<string>;
-  set: (html: string) => void;
-  prependBody: (frag: string) => TemplateAPI;
-  prependHead: (frag: string) => TemplateAPI;
-  appendBody: (frag: string) => TemplateAPI;
-  appendHead: (frag: string) => TemplateAPI;
-  replace: (tag: string, frag: string) => TemplateAPI;
+export type AfterMatchContext = HookContext & {
+  router: {
+    readonly current: string;
+    readonly url: string;
+    readonly status: number;
+    redirect: (url: string, status: number) => void;
+    rewrite: (entry: string) => void;
+    use: (entry: string) => void;
+  };
 };
 
-export type RouteAPI = {
-  cur: () => Route;
-  get: (entryName: string) => Route | undefined;
-  use: (entryName: string) => boolean;
+export type AfterRenderContext = HookContext & {
+  template: {
+    set: (content: string) => void;
+    get: () => string;
+    prependHead: (fragment: string) => void;
+    appendHead: (fragment: string) => void;
+    prependBody: (fragment: string) => void;
+    appendBody: (fragment: string) => void;
+  };
 };
 
-type HookHandler<Context> = (ctx: Context, next: NextFunction) => Promise<void>;
-type Hook<Context> = (fn: HookHandler<Context>) => void;
-export type ModernServerHook = {
-  beforeMatch: Hook<ModernServerContext>;
-  afterMatch: Hook<ModernServerContext & { router: RouteAPI }>;
-  beforeRender: Hook<ModernServerContext>;
-  afterRender: Hook<ModernServerContext & { template: TemplateAPI }>;
+export type MiddlewareContext = HookContext & {
+  response: ModernResponse & { locals: Record<string, any> };
+  source: {
+    req: IncomingMessage;
+    res: ServerResponse;
+  };
 };