egg 3.26.1 → 4.0.0-beta.0

package/dist/commonjs/lib/core/utils.js

@@ -0,0 +1,77 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertObject = convertObject;
+exports.safeParseURL = safeParseURL;
+const node_util_1 = __importDefault(require("node:util"));
+const is_type_of_1 = require("is-type-of");
+function convertObject(obj, ignore) {
+    if (!Array.isArray(ignore)) {
+        ignore = [ignore];
+    }
+    for (const key of Object.keys(obj)) {
+        obj[key] = convertValue(key, obj[key], ignore);
+    }
+    return obj;
+}
+function convertValue(key, value, ignore) {
+    if (value === null || value === undefined) {
+        return value;
+    }
+    let hit = false;
+    for (const matchKey of ignore) {
+        if (typeof matchKey === 'string' && matchKey === key) {
+            hit = true;
+            break;
+        }
+        else if ((0, is_type_of_1.isRegExp)(matchKey) && matchKey.test(key)) {
+            hit = true;
+            break;
+        }
+    }
+    if (!hit) {
+        if ((0, is_type_of_1.isSymbol)(value) || (0, is_type_of_1.isRegExp)(value)) {
+            return value.toString();
+        }
+        if ((0, is_type_of_1.isPrimitive)(value) || Array.isArray(value)) {
+            return value;
+        }
+    }
+    // only convert recursively when it's a plain object,
+    // o = {}
+    if (Object.getPrototypeOf(value) === Object.prototype) {
+        return convertObject(value, ignore);
+    }
+    // support class
+    const name = value.name || 'anonymous';
+    if ((0, is_type_of_1.isClass)(value)) {
+        return `<Class ${name}>`;
+    }
+    // support generator function
+    if ((0, is_type_of_1.isFunction)(value)) {
+        if ((0, is_type_of_1.isGeneratorFunction)(value))
+            return `<GeneratorFunction ${name}>`;
+        if ((0, is_type_of_1.isAsyncFunction)(value))
+            return `<AsyncFunction ${name}>`;
+        return `<Function ${name}>`;
+    }
+    const typeName = value.constructor.name;
+    if (typeName) {
+        if (Buffer.isBuffer(value) || typeof value === 'string') {
+            return `<${typeName} len: ${value.length}>`;
+        }
+        return `<${typeName}>`;
+    }
+    return node_util_1.default.format(value);
+}
+function safeParseURL(url) {
+    try {
+        return new URL(url);
+    }
+    catch {
+        return null;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvbGliL2NvcmUvdXRpbHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFNQSxzQ0FRQztBQXdERCxvQ0FNQztBQTVFRCwwREFBNkI7QUFDN0IsMkNBR29CO0FBRXBCLFNBQWdCLGFBQWEsQ0FBQyxHQUFRLEVBQUUsTUFBNkM7SUFDbkYsSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQztRQUMzQixNQUFNLEdBQUcsQ0FBRSxNQUFNLENBQUUsQ0FBQztJQUN0QixDQUFDO0lBQ0QsS0FBSyxNQUFNLEdBQUcsSUFBSSxNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUM7UUFDbkMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxHQUFHLFlBQVksQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDLEdBQUcsQ0FBQyxFQUFFLE1BQU0sQ0FBQyxDQUFDO0lBQ2pELENBQUM7SUFDRCxPQUFPLEdBQUcsQ0FBQztBQUNiLENBQUM7QUFFRCxTQUFTLFlBQVksQ0FBQyxHQUFXLEVBQUUsS0FBVSxFQUFFLE1BQTJCO0lBQ3hFLElBQUksS0FBSyxLQUFLLElBQUksSUFBSSxLQUFLLEtBQUssU0FBUyxFQUFFLENBQUM7UUFDMUMsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRUQsSUFBSSxHQUFHLEdBQUcsS0FBSyxDQUFDO0lBQ2hCLEtBQUssTUFBTSxRQUFRLElBQUksTUFBTSxFQUFFLENBQUM7UUFDOUIsSUFBSSxPQUFPLFFBQVEsS0FBSyxRQUFRLElBQUksUUFBUSxLQUFLLEdBQUcsRUFBRSxDQUFDO1lBQ3JELEdBQUcsR0FBRyxJQUFJLENBQUM7WUFDWCxNQUFNO1FBQ1IsQ0FBQzthQUFNLElBQUksSUFBQSxxQkFBUSxFQUFDLFFBQVEsQ0FBQyxJQUFJLFFBQVEsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQztZQUNwRCxHQUFHLEdBQUcsSUFBSSxDQUFDO1lBQ1gsTUFBTTtRQUNSLENBQUM7SUFDSCxDQUFDO0lBQ0QsSUFBSSxDQUFDLEdBQUcsRUFBRSxDQUFDO1FBQ1QsSUFBSSxJQUFBLHFCQUFRLEVBQUMsS0FBSyxDQUFDLElBQUksSUFBQSxxQkFBUSxFQUFDLEtBQUssQ0FBQyxFQUFFLENBQUM7WUFDdkMsT0FBTyxLQUFLLENBQUMsUUFBUSxFQUFFLENBQUM7UUFDMUIsQ0FBQztRQUNELElBQUksSUFBQSx3QkFBVyxFQUFDLEtBQUssQ0FBQyxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztZQUMvQyxPQUFPLEtBQUssQ0FBQztRQUNmLENBQUM7SUFDSCxDQUFDO0lBRUQscURBQXFEO0lBQ3JELFNBQVM7SUFDVCxJQUFJLE1BQU0sQ0FBQyxjQUFjLENBQUMsS0FBSyxDQUFDLEtBQUssTUFBTSxDQUFDLFNBQVMsRUFBRSxDQUFDO1FBQ3RELE9BQU8sYUFBYSxDQUFDLEtBQUssRUFBRSxNQUFNLENBQUMsQ0FBQztJQUN0QyxDQUFDO0lBRUQsZ0JBQWdCO0lBQ2hCLE1BQU0sSUFBSSxHQUFHLEtBQUssQ0FBQyxJQUFJLElBQUksV0FBVyxDQUFDO0lBQ3ZDLElBQUksSUFBQSxvQkFBTyxFQUFDLEtBQUssQ0FBQyxFQUFFLENBQUM7UUFDbkIsT0FBTyxVQUFVLElBQUksR0FBRyxDQUFDO0lBQzNCLENBQUM7SUFFRCw2QkFBNkI7SUFDN0IsSUFBSSxJQUFBLHVCQUFVLEVBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztRQUN0QixJQUFJLElBQUEsZ0NBQW1CLEVBQUMsS0FBSyxDQUFDO1lBQUUsT0FBTyxzQkFBc0IsSUFBSSxHQUFHLENBQUM7UUFDckUsSUFBSSxJQUFBLDRCQUFlLEVBQUMsS0FBSyxDQUFDO1lBQUUsT0FBTyxrQkFBa0IsSUFBSSxHQUFHLENBQUM7UUFDN0QsT0FBTyxhQUFhLElBQUksR0FBRyxDQUFDO0lBQzlCLENBQUM7SUFFRCxNQUFNLFFBQVEsR0FBRyxLQUFLLENBQUMsV0FBVyxDQUFDLElBQUksQ0FBQztJQUN4QyxJQUFJLFFBQVEsRUFBRSxDQUFDO1FBQ2IsSUFBSSxNQUFNLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxJQUFJLE9BQU8sS0FBSyxLQUFLLFFBQVEsRUFBRSxDQUFDO1lBQ3hELE9BQU8sSUFBSSxRQUFRLFNBQVMsS0FBSyxDQUFDLE1BQU0sR0FBRyxDQUFDO1FBQzlDLENBQUM7UUFDRCxPQUFPLElBQUksUUFBUSxHQUFHLENBQUM7SUFDekIsQ0FBQztJQUVELE9BQU8sbUJBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLENBQUM7QUFDNUIsQ0FBQztBQUVELFNBQWdCLFlBQVksQ0FBQyxHQUFXO0lBQ3RDLElBQUksQ0FBQztRQUNILE9BQU8sSUFBSSxHQUFHLENBQUMsR0FBRyxDQUFDLENBQUM7SUFDdEIsQ0FBQztJQUFDLE1BQU0sQ0FBQztRQUNQLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztBQUNILENBQUMifQ==

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

@@ -0,0 +1,267 @@
+import { type IncomingMessage, type ServerResponse } from 'node:http';
+import { EggCore, type EggCoreContext, type EggCoreOptions } from '@eggjs/core';
+import { EggContextLogger as ContextLogger, EggLoggers, EggLogger } from 'egg-logger';
+import { Cookies as ContextCookies } from '@eggjs/cookies';
+import type { Agent } from './agent.js';
+import type { Application } from './application.js';
+import type { EggAppConfig } from './type.js';
+import { IMessenger } from './core/messenger/index.js';
+import { ContextHttpClient } from './core/context_httpclient.js';
+import { HttpClient, type HttpClientRequestOptions, type HttpClientRequestURL, type HttpClientResponse } from './core/httpclient.js';
+import { type SingletonCreateMethod } from './core/singleton.js';
+import { BaseContextClass } from './core/base_context_class.js';
+import { BaseHookClass } from './core/base_hook_class.js';
+import type { EggApplicationLoader } from './loader/index.js';
+declare const EGG_PATH: unique symbol;
+export interface EggApplicationCoreOptions extends Omit<EggCoreOptions, 'baseDir'> {
+    mode?: 'cluster' | 'single';
+    clusterPort?: number;
+    baseDir?: string;
+}
+export interface EggContext extends EggCoreContext {
+    app: EggApplicationCore;
+    /**
+     * Request start time
+     * @member {Number} Context#starttime
+     */
+    starttime: number;
+    /**
+     * Request start timer using `performance.now()`
+     * @member {Number} Context#performanceStarttime
+     */
+    performanceStarttime: number;
+}
+/**
+ * Based on koa's Application
+ * @see https://github.com/eggjs/egg-core
+ * @see https://github.com/eggjs/koa/blob/master/src/application.ts
+ * @augments EggCore
+ */
+export declare class EggApplicationCore extends EggCore {
+    #private;
+    ContextCookies: typeof ContextCookies;
+    ContextLogger: typeof ContextLogger;
+    ContextHttpClient: typeof ContextHttpClient;
+    HttpClient: typeof HttpClient;
+    /**
+     * Retrieve base context class
+     * @member {BaseContextClass} BaseContextClass
+     * @since 1.0.0
+     */
+    BaseContextClass: typeof BaseContextClass;
+    /**
+     * Retrieve base controller
+     * @member {Controller} Controller
+     * @since 1.0.0
+     */
+    Controller: typeof BaseContextClass;
+    /**
+     * Retrieve base service
+     * @member {Service} Service
+     * @since 1.0.0
+     */
+    Service: typeof BaseContextClass;
+    /**
+     * Retrieve base subscription
+     * @member {Subscription} Subscription
+     * @since 2.12.0
+     */
+    Subscription: typeof BaseContextClass;
+    /**
+     * Retrieve base context class
+     * @member {BaseHookClass} BaseHookClass
+     */
+    BaseHookClass: typeof BaseHookClass;
+    /**
+     * Retrieve base boot
+     * @member {Boot}
+     */
+    Boot: typeof BaseHookClass;
+    options: Required<EggApplicationCoreOptions>;
+    readonly messenger: IMessenger;
+    agent?: Agent;
+    application?: Application;
+    loader: EggApplicationLoader;
+    /**
+     * @class
+     * @param {Object} options
+     *  - {Object} [type] - type of instance, Agent and Application both extend koa, type can determine what it is.
+     *  - {String} [baseDir] - app root dir, default is `process.cwd()`
+     *  - {Object} [plugins] - custom plugin config, use it in unittest
+     *  - {String} [mode] - process mode, can be cluster / single, default is `cluster`
+     */
+    constructor(options?: EggApplicationCoreOptions);
+    protected loadConfig(): Promise<void>;
+    protected load(): Promise<void>;
+    /**
+     * Wrap the Client with Leader/Follower Pattern
+     *
+     * @description almost the same as Agent.cluster API, the only different is that this method create Follower.
+     *
+     * @see https://github.com/node-modules/cluster-client
+     * @param {Function} clientClass - client class function
+     * @param {Object} [options]
+     *   - {Boolean} [autoGenerate] - whether generate delegate rule automatically, default is true
+     *   - {Function} [formatKey] - a method to transform the subscription info into a string，default is JSON.stringify
+     *   - {Object} [transcode|JSON.stringify/parse]
+     *     - {Function} encode - custom serialize method
+     *     - {Function} decode - custom deserialize method
+     *   - {Boolean} [isBroadcast] - whether broadcast subscription result to all followers or just one, default is true
+     *   - {Number} [responseTimeout] - response timeout, default is 3 seconds
+     *   - {Number} [maxWaitTime|30000] - leader startup max time, default is 30 seconds
+     * @return {ClientWrapper} wrapper
+     */
+    cluster(clientClass: unknown, options: object): any;
+    /**
+     * print the information when console.log(app)
+     * @return {Object} inspected app.
+     * @since 1.0.0
+     * @example
+     * ```js
+     * console.log(app);
+     * =>
+     * {
+     *   name: 'mock-app',
+     *   env: 'test',
+     *   subdomainOffset: 2,
+     *   config: '<egg config>',
+     *   controller: '<egg controller>',
+     *   service: '<egg service>',
+     *   middlewares: '<egg middlewares>',
+     *   urllib: '<egg urllib>',
+     *   loggers: '<egg loggers>'
+     * }
+     * ```
+     */
+    inspect(): any;
+    toJSON(): any;
+    /**
+     * http request helper base on {@link httpclient}, it will auto save httpclient log.
+     * Keep the same api with `httpclient.request(url, args)`.
+     *
+     * See https://github.com/node-modules/urllib#api-doc for more details.
+     *
+     * @param {String} url request url address.
+     * @param {Object} options
+     * - method {String} - Request method, defaults to GET. Could be GET, POST, DELETE or PUT. Alias 'type'.
+     * - data {Object} - Data to be sent. Will be stringify automatically.
+     * - dataType {String} - String - Type of response data. Could be `text` or `json`.
+     *   If it's `text`, the callback data would be a String.
+     *   If it's `json`, the data of callback would be a parsed JSON Object.
+     *   Default callback data would be a Buffer.
+     * - headers {Object} - Request headers.
+     * - timeout {Number} - Request timeout in milliseconds. Defaults to exports.TIMEOUT.
+     *   Include remote server connecting timeout and response timeout.
+     *   When timeout happen, will return ConnectionTimeout or ResponseTimeout.
+     * - auth {String} - `username:password` used in HTTP Basic Authorization.
+     * - followRedirect {Boolean} - follow HTTP 3xx responses as redirects. defaults to false.
+     * - gzip {Boolean} - let you get the res object when request connected, default false. alias customResponse
+     * - nestedQuerystring {Boolean} - urllib default use querystring to stringify form data which don't
+     *   support nested object, will use qs instead of querystring to support nested object by set this option to true.
+     * - more options see https://github.com/node-modules/urllib
+     * @return {Object}
+     * - status {Number} - HTTP response status
+     * - headers {Object} - HTTP response headers
+     * - res {Object} - HTTP response meta
+     * - data {Object} - HTTP response body
+     *
+     * @example
+     * ```js
+     * const result = await app.curl('http://example.com/foo.json', {
+     *   method: 'GET',
+     *   dataType: 'json',
+     * });
+     * console.log(result.status, result.headers, result.data);
+     * ```
+     */
+    curl<T = any>(url: HttpClientRequestURL, options?: HttpClientRequestOptions): Promise<HttpClientResponse<T>>;
+    /**
+     * HttpClient instance
+     * @see https://github.com/node-modules/urllib
+     * @member {HttpClient}
+     */
+    get httpClient(): HttpClient;
+    /**
+     * @deprecated please use httpClient instead
+     * @alias httpClient
+     * @member {HttpClient}
+     */
+    get httpclient(): HttpClient;
+    /**
+     * All loggers contain logger, coreLogger and customLogger
+     * @member {Object}
+     * @since 1.0.0
+     */
+    get loggers(): EggLoggers;
+    /**
+     * Get logger by name, it's equal to app.loggers['name'],
+     * but you can extend it with your own logical.
+     * @param {String} name - logger name
+     * @return {Logger} logger
+     */
+    getLogger(name: string): EggLogger;
+    /**
+     * application logger, log file is `$HOME/logs/{appname}/{appname}-web`
+     * @member {Logger}
+     * @since 1.0.0
+     */
+    get logger(): EggLogger;
+    /**
+     * core logger for framework and plugins, log file is `$HOME/logs/{appname}/egg-web`
+     * @member {Logger}
+     * @since 1.0.0
+     */
+    get coreLogger(): EggLogger;
+    _unhandledRejectionHandler(err: any): void;
+    /**
+     * dump out the config and meta object
+     * @private
+     */
+    dumpConfigToObject(): {
+        config: Record<string, any>;
+        meta: Record<string, any>;
+    };
+    /**
+     * save app.config to `run/${type}_config.json`
+     * @private
+     */
+    dumpConfig(): void;
+    dumpTiming(): void;
+    get [EGG_PATH](): string;
+    get config(): EggAppConfig;
+    /**
+     * app.env delegate app.config.env
+     * @deprecated
+     */
+    get env(): string;
+    set env(_: string);
+    /**
+     * app.proxy delegate app.config.proxy
+     * @deprecated
+     */
+    get proxy(): boolean;
+    set proxy(_: boolean);
+    /**
+     * create a singleton instance
+     * @param {String} name - unique name for singleton
+     * @param {Function|AsyncFunction} create - method will be invoked when singleton instance create
+     */
+    addSingleton(name: string, create: SingletonCreateMethod): void;
+    /**
+     * Create an anonymous context, the context isn't request level, so the request is mocked.
+     * then you can use context level API like `ctx.service`
+     * @member {String} EggApplication#createAnonymousContext
+     * @param {Request} [req] - if you want to mock request like querystring, you can pass an object to this function.
+     * @return {Context} context
+     */
+    createAnonymousContext(req?: any): EggCoreContext;
+    /**
+     * Create egg context
+     * @function EggApplication#createContext
+     * @param  {Req} req - node native Request object
+     * @param  {Res} res - node native Response object
+     * @return {Context} context object
+     */
+    createContext(req: IncomingMessage, res: ServerResponse): EggContext;
+}
+export {};