egg 4.0.0-beta.9 → 4.0.1

package/src/lib/error/CookieLimitExceedError.ts

@@ -0,0 +1,12 @@
+export class CookieLimitExceedError extends Error {
+  key: string;
+  cookie: string;
+
+  constructor(key: string, cookie: string) {
+    super(`cookie ${key}'s length(${cookie.length}) exceed the limit(4093)`);
+    this.name = this.constructor.name;
+    this.key = key;
+    this.cookie = cookie;
+    Error.captureStackTrace(this, this.constructor);
+  }
+}

package/src/lib/error/MessageUnhandledRejectionError.ts

@@ -0,0 +1,12 @@
+export class MessageUnhandledRejectionError extends Error {
+  event: string | symbol;
+  args: any[];
+
+  constructor(err: Error, event: string | symbol, ...args: any[]) {
+    super(`event: ${String(event)}, error: ${err.message}`, { cause: err });
+    this.name = this.constructor.name;
+    this.event = event;
+    this.args = args;
+    Error.captureStackTrace(this, this.constructor);
+  }
+}

package/src/lib/error/index.ts

@@ -0,0 +1,2 @@
+export * from './CookieLimitExceedError.js';
+export * from './MessageUnhandledRejectionError.js';

package/src/lib/start.ts

@@ -3,6 +3,7 @@ import { readJSON } from 'utility';
 import { importModule } from '@eggjs/utils';
 import { Agent } from './agent.js';
 import { Application } from './application.js';
+import { EggPlugin } from './types.js';
 
 export interface StartEggOptions {
   /** specify framework that can be absolute path or npm package */
@@ -13,6 +14,15 @@ export interface StartEggOptions {
   ignoreWarning?: boolean;
   mode?: 'single';
   env?: string;
+  plugins?: EggPlugin;
+}
+
+export interface SingleModeApplication extends Application {
+  agent: SingleModeAgent;
+}
+
+export interface SingleModeAgent extends Agent {
+  app: SingleModeApplication;
 }
 
 /**
@@ -41,11 +51,11 @@ export async function startEgg(options: StartEggOptions = {}) {
 
   const agent = new AgentClass({
     ...options,
-  });
+  }) as SingleModeAgent;
   await agent.ready();
   const application = new ApplicationClass({
     ...options,
-  });
+  }) as SingleModeApplication;
   application.agent = agent;
   agent.application = application;
   await application.ready();

package/src/lib/{type.ts → types.ts}

@@ -7,18 +7,28 @@ import type {
 } from 'egg-logger';
 import type {
   FileLoaderOptions,
+  EggAppConfig as EggCoreAppConfig,
 } from '@eggjs/core';
 import type {
-  EggApplicationCore, ContextDelegation,
+  EggApplicationCore, Context,
 } from './egg.js';
 import type { MetaMiddlewareOptions } from '../app/middleware/meta.js';
 import type { NotFoundMiddlewareOptions } from '../app/middleware/notfound.js';
 import type { SiteFileMiddlewareOptions } from '../app/middleware/site_file.js';
 
-// import @eggjs/watcher types
-// import '@eggjs/watcher';
+// import plugins types
+import '@eggjs/watcher';
+import '@eggjs/development';
+import '@eggjs/jsonp';
+import '@eggjs/i18n';
+import '@eggjs/static';
 
-type IgnoreItem = string | RegExp | ((ctx: ContextDelegation) => boolean);
+export type {
+  EggAppInfo,
+} from '@eggjs/core';
+
+
+type IgnoreItem = string | RegExp | ((ctx: Context) => boolean);
 type IgnoreOrMatch = IgnoreItem | IgnoreItem[];
 
 export interface ClientErrorResponse {
@@ -56,7 +66,18 @@ export interface CustomLoaderConfig extends Omit<FileLoaderOptions, 'inject' | '
   loadunit?: boolean;
 }
 
-export interface EggAppConfig {
+export interface HttpClientConfig {
+  /** Request timeout */
+  timeout?: number;
+  /** Default request args for httpclient */
+  request?: HttpClientRequestOptions;
+  /**
+   * @deprecated keep compatible with egg 3.x, no more used
+   */
+  useHttpClientNext?: boolean;
+}
+
+export interface EggAppConfig extends EggCoreAppConfig {
   workerStartTimeout: number;
   baseDir: string;
   middleware: string[];
@@ -103,7 +124,7 @@ export interface EggAppConfig {
     };
     /** Default is `'error'`, it will return `400` response when `Prototype-Poisoning` happen. */
     onProtoPoisoning: 'error' | 'remove' | 'ignore';
-    onerror(err: any, ctx: ContextDelegation): void;
+    onerror(err: any, ctx: Context): void;
   };
 
   /**
@@ -131,50 +152,14 @@ export interface EggAppConfig {
   };
 
   /** Configuration of httpclient in egg. */
-  httpclient: {
-    /** Request timeout */
-    timeout?: number;
-    /** Default request args for httpclient */
-    request?: HttpClientRequestOptions;
-  };
-
-  development: {
-    /**
-     * dirs needed watch, when files under these change, application will reload, use relative path
-     */
-    watchDirs: string[];
-    /**
-     * dirs don't need watch, including subdirectories, use relative path
-     */
-    ignoreDirs: string[];
-    /**
-     * don't wait all plugins ready, default is true.
-     */
-    fastReady: boolean;
-    /**
-     * whether reload on debug, default is true.
-     */
-    reloadOnDebug: boolean;
-    /**
-     * whether override default watchDirs, default is false.
-     */
-    overrideDefault: boolean;
-    /**
-     * whether override default ignoreDirs, default is false.
-     */
-    overrideIgnore: boolean;
-    /**
-     * whether to reload, use https://github.com/sindresorhus/multimatch
-     */
-    reloadPattern: string[] | string;
-  };
+  httpclient: HttpClientConfig;
 
   /**
    * customLoader config
    */
-  customLoader: {
-    [key: string]: CustomLoaderConfig;
-  };
+  // customLoader: {
+  //   [key: string]: CustomLoaderConfig;
+  // };
 
   /**
    * It will ignore special keys when dumpConfig
@@ -198,32 +183,6 @@ export interface EggAppConfig {
 
   hostHeaders: string;
 
-  /**
-   * I18n options
-   */
-  i18n: {
-    /**
-     * default value EN_US
-     */
-    defaultLocale: string;
-    /**
-     * i18n resource file dir, not recommend to change default value
-     */
-    dirs: string[];
-    /**
-     * custom the locale value field, default `query.locale`, you can modify this config, such as `query.lang`
-     */
-    queryField: string;
-    /**
-     * The locale value key in the cookie, default is locale.
-     */
-    cookieField: string;
-    /**
-     * Locale cookie expire time, default `1y`, If pass number value, the unit will be ms
-     */
-    cookieMaxAge: string | number;
-  };
-
   /**
    * Detect request' ip from specified headers, not case-sensitive. Only worked when config.proxy set to true.
    */
@@ -238,21 +197,6 @@ export interface EggAppConfig {
     httpOnly?: boolean;
   };
 
-  /**
-   * jsonp options
-   * @member Config#jsonp
-   * @property {String} callback - jsonp callback method key, default to `_callback`
-   * @property {Number} limit - callback method name's max length, default to `50`
-   * @property {Boolean} csrf - enable csrf check or not. default to false
-   * @property {String|RegExp|Array} whiteList - referrer white list
-   */
-  jsonp: {
-    limit: number;
-    callback: string;
-    csrf: boolean;
-    whiteList: string | RegExp | Array<string | RegExp>;
-  };
-
   /**
    * The key that signing cookies. It can contain multiple keys separated by .
    */
@@ -299,8 +243,6 @@ export interface EggAppConfig {
     allowedMethods: string[];
   };
 
-  watcher: Record<string, any>;
-
   onClientError?(err: Error, socket: Socket, app: EggApplicationCore): ClientErrorResponse | Promise<ClientErrorResponse>;
 
   /**
@@ -327,3 +269,37 @@ export interface EggAppConfig {
 
   [prop: string]: any;
 }
+
+export type RequestObjectBody = Record<string, any>;
+
+/**
+ * plugin config item interface
+ */
+export interface IEggPluginItem {
+  env?: EggEnvType[];
+  path?: string;
+  package?: string;
+  enable?: boolean;
+}
+
+export type EggPluginItem = IEggPluginItem | boolean;
+
+/**
+ * build-in plugin list
+ */
+export interface EggPlugin {
+  [key: string]: EggPluginItem | undefined;
+  onerror?: EggPluginItem;
+  session?: EggPluginItem;
+  i18n?: EggPluginItem;
+  watcher?: EggPluginItem;
+  multipart?: EggPluginItem;
+  security?: EggPluginItem;
+  development?: EggPluginItem;
+  logrotator?: EggPluginItem;
+  schedule?: EggPluginItem;
+  static?: EggPluginItem;
+  jsonp?: EggPluginItem;
+  view?: EggPluginItem;
+}
+

package/src/lib/utils.ts

@@ -1,4 +1,3 @@
-
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 

package/src/urllib.ts

@@ -0,0 +1 @@
+export * from 'urllib';

package/dist/commonjs/app/extend/context.types.d.ts

@@ -1,16 +0,0 @@
-import type { Router } from '@eggjs/core';
-import type { HttpClientRequestURL, HttpClientRequestOptions, HttpClient } from '../../lib/core/httpclient.js';
-import type { ContextHttpClient } from '../../lib/core/context_httpclient.js';
-import type Helper from './helper.js';
-import type { EggLogger } from 'egg-logger';
-declare module '@eggjs/core' {
-    interface Context {
-        curl(url: HttpClientRequestURL, options?: HttpClientRequestOptions): ReturnType<HttpClient['request']>;
-        get router(): Router;
-        set router(val: Router);
-        get helper(): Helper;
-        get httpclient(): ContextHttpClient;
-        get httpClient(): ContextHttpClient;
-        getLogger(name: string): EggLogger;
-    }
-}

package/dist/commonjs/app/extend/context.types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udGV4dC50eXBlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9hcHAvZXh0ZW5kL2NvbnRleHQudHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist/commonjs/lib/egg.types.d.ts

@@ -1,6 +0,0 @@
-declare module '@eggjs/core' {
-    interface EggCore {
-        inspect(): any;
-    }
-}
-export {};

package/dist/commonjs/lib/egg.types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZWdnLnR5cGVzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9lZ2cudHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist/commonjs/lib/type.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvdHlwZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=

package/dist/esm/app/extend/context.types.d.ts

@@ -1,16 +0,0 @@
-import type { Router } from '@eggjs/core';
-import type { HttpClientRequestURL, HttpClientRequestOptions, HttpClient } from '../../lib/core/httpclient.js';
-import type { ContextHttpClient } from '../../lib/core/context_httpclient.js';
-import type Helper from './helper.js';
-import type { EggLogger } from 'egg-logger';
-declare module '@eggjs/core' {
-    interface Context {
-        curl(url: HttpClientRequestURL, options?: HttpClientRequestOptions): ReturnType<HttpClient['request']>;
-        get router(): Router;
-        set router(val: Router);
-        get helper(): Helper;
-        get httpclient(): ContextHttpClient;
-        get httpClient(): ContextHttpClient;
-        getLogger(name: string): EggLogger;
-    }
-}

package/dist/esm/app/extend/context.types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udGV4dC50eXBlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9hcHAvZXh0ZW5kL2NvbnRleHQudHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist/esm/lib/egg.types.d.ts

@@ -1,6 +0,0 @@
-declare module '@eggjs/core' {
-    interface EggCore {
-        inspect(): any;
-    }
-}
-export {};

package/dist/esm/lib/egg.types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZWdnLnR5cGVzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9lZ2cudHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist/esm/lib/type.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvdHlwZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=

package/src/app/extend/context.types.ts

@@ -1,24 +0,0 @@
-import type {
-  Router,
-} from '@eggjs/core';
-import type {
-  HttpClientRequestURL, HttpClientRequestOptions, HttpClient,
-} from '../../lib/core/httpclient.js';
-import type {
-  ContextHttpClient,
-} from '../../lib/core/context_httpclient.js';
-import type Helper from './helper.js';
-import type { EggLogger } from 'egg-logger';
-
-declare module '@eggjs/core' {
-  // add Context overrides types
-  interface Context {
-    curl(url: HttpClientRequestURL, options?: HttpClientRequestOptions): ReturnType<HttpClient['request']>;
-    get router(): Router;
-    set router(val: Router);
-    get helper(): Helper;
-    get httpclient(): ContextHttpClient;
-    get httpClient(): ContextHttpClient;
-    getLogger(name: string): EggLogger;
-  }
-}

package/src/lib/egg.types.ts

@@ -1,6 +0,0 @@
-declare module '@eggjs/core' {
-  // add EggApplicationCore overrides types
-  interface EggCore {
-    inspect(): any;
-  }
-}