@modern-js/types 1.1.3 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @modern-js/types
 
+## 1.2.0
+
+### Minor Changes
+
+- cfe11628: Make Modern.js self bootstraping
+
+### Patch Changes
+
+- e2464fe5: add more server types
+- Updated dependencies [cfe11628]
+  - @modern-js/plugin@1.2.0
+
+## 1.1.5
+
+### Patch Changes
+
+- e51b1db3: feat: support custom sdk, interceptor, headers for bff request
+
+## 1.1.4
+
+### Patch Changes
+
+- e04914ce: add route types, fix metrics types
+- e04914ce: add route types, fix metrics types
+
 ## 1.1.3
 
 ### Patch Changes

package/cli/index.d.ts

@@ -1,5 +1,6 @@
 import { AsyncWaterfall, AsyncWorkflow } from '@modern-js/plugin';
 import { Compiler, MultiCompiler, Configuration } from 'webpack';
+import { ServerRoute } from '../server';
 
 export type { Compiler, MultiCompiler, Configuration };
 
@@ -17,20 +18,6 @@ export interface Entrypoint {
   };
 }
 
-/**
- *  server route
- */
-export interface ServerRoute {
-  urlPath: string;
-  entryName?: string;
-  entryPath: string;
-  isSPA: boolean;
-  isSSR: boolean;
-  isApi?: boolean;
-  bundle?: string;
-  enableModernMode?: boolean;
-}
-
 /**
  * file system routes.
  */

package/jest.config.js

@@ -0,0 +1,8 @@
+const sharedConfig = require('@scripts/jest-config');
+
+/** @type {import('@jest/types').Config.InitialOptions} */
+module.exports = {
+  // eslint-disable-next-line node/no-unsupported-features/es-syntax
+  ...sharedConfig,
+  rootDir: __dirname,
+};

package/package.json

@@ -11,29 +11,38 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.1.3",
-  "main": "",
+  "version": "1.2.0",
   "types": "./index.d.ts",
   "dependencies": {
-    "@modern-js/plugin": "^1.1.2",
+    "@modern-js/plugin": "^1.2.0",
     "webpack": "^5.54.0"
   },
   "exports": {
     ".": "./index.d.ts",
-    "./server": "./server/index.d.ts"
+    "./server": {
+      "jsnext:source": "./server/index.d.ts",
+      "default": "./server/index.d.ts"
+    }
   },
   "devDependencies": {
     "@types/jest": "^26",
     "@types/node": "^14",
     "@types/react": "^17",
     "@types/react-dom": "^17",
-    "@modern-js/plugin-testing": "^1.1.1",
-    "@modern-js/module-tools": "^1.1.1"
+    "@scripts/build": "0.0.0",
+    "jest": "^27",
+    "@scripts/jest-config": "0.0.0"
   },
   "sideEffects": false,
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public"
+    "access": "public",
+    "main": "",
+    "types": "./index.d.ts"
+  },
+  "scripts": {
+    "test": "jest --passWithNoTests"
   },
+  "main": "",
   "readme": "\n<p align=\"center\">\n  <a href=\"https://modernjs.dev\" target=\"blank\"><img src=\"https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png\" width=\"300\" alt=\"Modern.js Logo\" /></a>\n</p>\n<p align=\"center\">\n现代 Web 工程体系\n  <br/>\n  <a href=\"https://modernjs.dev\" target=\"blank\">\n    modernjs.dev\n  </a>\n</p>\n<p align=\"center\">\n  The meta-framework suite designed from scratch for frontend-focused modern web development\n</p>\n\n# Introduction\n\n> The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.\n\n- [Modern.js: Hello, World!](https://zhuanlan.zhihu.com/p/426707646)\n\n## Getting Started\n\n- [Quick Start](https://modernjs.dev/docs/start)\n- [Guides](https://modernjs.dev/docs/guides)\n- [API References](https://modernjs.dev/docs/apis)\n\n## Contributing\n\n- [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md)\n"
 }

package/server/context.d.ts

@@ -1,7 +1,7 @@
 import { IncomingMessage, ServerResponse, IncomingHttpHeaders } from 'http';
 import { URL } from 'url';
 import qs from 'querystring';
-import { Measure, Logger } from './util';
+import { Metrics, Logger } from './utils';
 
 export interface ModernServerContext {
   req: IncomingMessage;
@@ -12,7 +12,7 @@ export interface ModernServerContext {
 
   logger: Logger;
 
-  measure?: Measure;
+  metrics?: Metrics;
 
   setParams: (params: Record<string, string>) => void;
 
@@ -44,3 +44,20 @@ export interface ModernServerContext {
 
   resHasHandled: () => boolean;
 }
+
+export type BaseSSRServerContext = {
+  request: {
+    params: Record<string, string>;
+    pathname: string;
+    query: Record<string, string>;
+    headers: IncomingHttpHeaders;
+    cookie?: string;
+  };
+  redirection: { url?: string; status?: number };
+  distDir: string;
+  template: string;
+  entryName: string;
+  logger: Logger;
+  metrics?: Metrics;
+  loadableManifest?: string;
+};

package/server/hook.d.ts

@@ -0,0 +1,35 @@
+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 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 RouteAPI = {
+  cur: () => Route;
+  get: (entryName: string) => Route | undefined;
+  use: (entryName: string) => boolean;
+};
+
+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 }>;
+};

package/server/index.d.ts

@@ -1,2 +1,4 @@
 export * from './context';
-export * from './util';
+export * from './hook';
+export * from './utils';
+export * from './route';

package/server/route.d.ts

@@ -0,0 +1,19 @@
+export interface ServerRoute {
+  // modern js web entry name
+  entryName?: string;
+  // the url path for request match
+  urlPath: string;
+  // the default resource file to response to route
+  entryPath: string;
+  // if route is spa page
+  isSPA?: boolean;
+  // if route is ssr page
+  isSSR?: boolean;
+  // if route is api service
+  isApi?: boolean;
+  // ssr js bundle for ssr page
+  bundle?: string;
+  // if route has modern product
+  enableModernMode?: boolean;
+  // specialHeader?: SpecialHeader[];
+}

package/server/{util.d.ts → utils.d.ts}

@@ -1,4 +1,4 @@
-export type Measure = {
+export type Metrics = {
   counter: () => void;
   timer: () => void;
   gauges: () => void;

package/tsconfig.json

@@ -4,9 +4,7 @@
     "declaration": false,
     "jsx": "preserve",
     "baseUrl": "./",
-    "paths": {
-      "@/*": ["./src/*"]
-    }
+    "paths": {}
   },
   "include": ["src"]
 }