egg 4.0.0 → 4.0.1

package/src/lib/egg.ts

@@ -31,7 +31,9 @@ import type { EggAppConfig } from './types.js';
 import { create as createMessenger, IMessenger } from './core/messenger/index.js';
 import { ContextHttpClient } from './core/context_httpclient.js';
 import {
-  HttpClient, type HttpClientRequestOptions, type HttpClientRequestURL, type HttpClientResponse,
+  HttpClient,
+  type HttpClientRequestOptions, type HttpClientRequestURL, type HttpClientResponse,
+  type HttpClientOptions,
 } from './core/httpclient.js';
 import { createLoggers } from './core/logger.js';
 import {
@@ -43,8 +45,6 @@ import { BaseHookClass } from './core/base_hook_class.js';
 import type { EggApplicationLoader } from './loader/index.js';
 import { getSourceDirname } from './utils.js';
 
-import './egg.types.js';
-
 const EGG_PATH = Symbol.for('egg#eggPath');
 
 export interface EggApplicationCoreOptions extends Omit<EggCoreOptions, 'baseDir'> {
@@ -387,14 +387,22 @@ export class EggApplicationCore extends EggCore {
     return await this.httpClient.request<T>(url, options);
   }
 
+  /**
+   * Create a new HttpClient instance with custom options
+   * @param {Object} [options] HttpClient init options
+   */
+  createHttpClient(options?: HttpClientOptions): HttpClient {
+    return new this.HttpClient(this, options);
+  }
+
   /**
    * HttpClient instance
    * @see https://github.com/node-modules/urllib
    * @member {HttpClient}
    */
-  get httpClient() {
+  get httpClient(): HttpClient {
     if (!this.#httpClient) {
-      this.#httpClient = new this.HttpClient(this);
+      this.#httpClient = this.createHttpClient();
     }
     return this.#httpClient;
   }
@@ -680,3 +688,19 @@ export class EggApplicationCore extends EggCore {
     return context;
   }
 }
+
+declare module '@eggjs/core' {
+  // add EggApplicationCore overrides types
+  interface EggCore {
+    inspect(): any;
+    get currentContext(): EggContext | undefined;
+    ctxStorage: AsyncLocalStorage<EggContext>;
+    get logger(): EggLogger;
+    get coreLogger(): EggLogger;
+    getLogger(name: string): EggLogger;
+    createHttpClient(options?: HttpClientOptions): HttpClient;
+    HttpClient: typeof HttpClient;
+    get httpClient(): HttpClient;
+    curl<T = any>(url: HttpClientRequestURL, options?: HttpClientRequestOptions): Promise<HttpClientResponse<T>>;
+  }
+}

package/src/lib/types.ts

@@ -19,6 +19,9 @@ import type { SiteFileMiddlewareOptions } from '../app/middleware/site_file.js';
 // import plugins types
 import '@eggjs/watcher';
 import '@eggjs/development';
+import '@eggjs/jsonp';
+import '@eggjs/i18n';
+import '@eggjs/static';
 
 export type {
   EggAppInfo,
@@ -63,6 +66,17 @@ export interface CustomLoaderConfig extends Omit<FileLoaderOptions, 'inject' | '
   loadunit?: boolean;
 }
 
+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;
@@ -138,47 +152,7 @@ export interface EggAppConfig extends EggCoreAppConfig {
   };
 
   /** Configuration of httpclient in egg. */
-  httpclient: {
-    /** Request timeout */
-    timeout?: number;
-    /** Default request args for httpclient */
-    request?: HttpClientRequestOptions;
-    /**
-     * @deprecated keep compatible with egg 3.x, no more used
-     */
-    useHttpClientNext?: boolean;
-  };
-
-  // 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
@@ -209,32 +183,6 @@ export interface EggAppConfig extends EggCoreAppConfig {
 
   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.
    */
@@ -249,21 +197,6 @@ export interface EggAppConfig extends EggCoreAppConfig {
     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 .
    */

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

@@ -1,18 +0,0 @@
-import type { Router } from '@eggjs/core';
-import type { EggLogger } from 'egg-logger';
-import type { HttpClientRequestURL, HttpClientRequestOptions, HttpClient } from '../../lib/core/httpclient.js';
-import type Helper from './helper.js';
-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(): HttpClient;
-        get httpClient(): HttpClient;
-        getLogger(name: string): EggLogger;
-        get logger(): EggLogger;
-        get coreLogger(): EggLogger;
-        get locals(): Record<string, any>;
-    }
-}

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/app/extend/request.types.d.ts

@@ -1,10 +0,0 @@
-declare module '@eggjs/core' {
-    interface Request {
-        body: any;
-        get acceptJSON(): boolean;
-        get query(): Record<string, string>;
-        set query(obj: Record<string, string>);
-        get queries(): Record<string, string[]>;
-    }
-}
-export {};

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

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

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

@@ -1,7 +0,0 @@
-declare module '@eggjs/core' {
-    interface Response {
-        get realStatus(): number;
-        set realStatus(status: number);
-    }
-}
-export {};

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

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

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

@@ -1,13 +0,0 @@
-import type { AsyncLocalStorage } from 'node:async_hooks';
-import type EggContext from '../app/extend/context.js';
-import type { EggLogger } from 'egg-logger';
-declare module '@eggjs/core' {
-    interface EggCore {
-        inspect(): any;
-        get currentContext(): EggContext | undefined;
-        ctxStorage: AsyncLocalStorage<EggContext>;
-        get logger(): EggLogger;
-        get coreLogger(): EggLogger;
-        getLogger(name: string): EggLogger;
-    }
-}

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/esm/app/extend/context.types.d.ts

@@ -1,18 +0,0 @@
-import type { Router } from '@eggjs/core';
-import type { EggLogger } from 'egg-logger';
-import type { HttpClientRequestURL, HttpClientRequestOptions, HttpClient } from '../../lib/core/httpclient.js';
-import type Helper from './helper.js';
-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(): HttpClient;
-        get httpClient(): HttpClient;
-        getLogger(name: string): EggLogger;
-        get logger(): EggLogger;
-        get coreLogger(): EggLogger;
-        get locals(): Record<string, any>;
-    }
-}

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

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

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

@@ -1,10 +0,0 @@
-declare module '@eggjs/core' {
-    interface Request {
-        body: any;
-        get acceptJSON(): boolean;
-        get query(): Record<string, string>;
-        set query(obj: Record<string, string>);
-        get queries(): Record<string, string[]>;
-    }
-}
-export {};

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

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

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

@@ -1,7 +0,0 @@
-declare module '@eggjs/core' {
-    interface Response {
-        get realStatus(): number;
-        set realStatus(status: number);
-    }
-}
-export {};

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

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

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

@@ -1,13 +0,0 @@
-import type { AsyncLocalStorage } from 'node:async_hooks';
-import type EggContext from '../app/extend/context.js';
-import type { EggLogger } from 'egg-logger';
-declare module '@eggjs/core' {
-    interface EggCore {
-        inspect(): any;
-        get currentContext(): EggContext | undefined;
-        ctxStorage: AsyncLocalStorage<EggContext>;
-        get logger(): EggLogger;
-        get coreLogger(): EggLogger;
-        getLogger(name: string): EggLogger;
-    }
-}

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

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

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

@@ -1,24 +0,0 @@
-import type {
-  Router,
-} from '@eggjs/core';
-import type { EggLogger } from 'egg-logger';
-import type {
-  HttpClientRequestURL, HttpClientRequestOptions, HttpClient,
-} from '../../lib/core/httpclient.js';
-import type Helper from './helper.js';
-
-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(): HttpClient;
-    get httpClient(): HttpClient;
-    getLogger(name: string): EggLogger;
-    get logger(): EggLogger;
-    get coreLogger(): EggLogger;
-    get locals(): Record<string, any>;
-  }
-}

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

@@ -1,10 +0,0 @@
-declare module '@eggjs/core' {
-  // add Request overrides types
-  interface Request {
-    body: any;
-    get acceptJSON(): boolean;
-    get query(): Record<string, string>;
-    set query(obj: Record<string, string>);
-    get queries(): Record<string, string[]>;
-  }
-}

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

@@ -1,7 +0,0 @@
-declare module '@eggjs/core' {
-  // add Response overrides types
-  interface Response {
-    get realStatus(): number;
-    set realStatus(status: number);
-  }
-}

package/src/lib/egg.types.ts

@@ -1,15 +0,0 @@
-import type { AsyncLocalStorage } from 'node:async_hooks';
-import type EggContext from '../app/extend/context.js';
-import type { EggLogger } from 'egg-logger';
-
-declare module '@eggjs/core' {
-  // add EggApplicationCore overrides types
-  interface EggCore {
-    inspect(): any;
-    get currentContext(): EggContext | undefined;
-    ctxStorage: AsyncLocalStorage<EggContext>;
-    get logger(): EggLogger;
-    get coreLogger(): EggLogger;
-    getLogger(name: string): EggLogger;
-  }
-}