@eggjs/core 6.4.1 → 6.6.0-beta.2

package/dist/utils/timing.d.ts

@@ -0,0 +1,24 @@
+//#region src/utils/timing.d.ts
+interface TimingItem {
+  name: string;
+  start: number;
+  end?: number;
+  duration?: number;
+  pid: number;
+  index: number;
+}
+declare class Timing {
+  #private;
+  constructor();
+  init(): void;
+  start(name?: string, start?: number): TimingItem | undefined;
+  end(name?: string): TimingItem | undefined;
+  enable(): void;
+  disable(): void;
+  clear(): void;
+  toJSON(): TimingItem[];
+  itemToString(timelineEnd: number, item: TimingItem, times: number): string;
+  toString(prefix?: string, width?: number): string;
+}
+//#endregion
+export { Timing, TimingItem };

package/dist/utils/timing.js

@@ -0,0 +1,85 @@
+import { debuglog } from "node:util";
+import assert from "node:assert";
+import { EOL } from "node:os";
+
+//#region src/utils/timing.ts
+const debug = debuglog("egg/core/utils/timing");
+var Timing = class {
+	#enable;
+	#startTime;
+	#map;
+	#list;
+	constructor() {
+		this.#enable = true;
+		this.#map = /* @__PURE__ */ new Map();
+		this.#list = [];
+		this.init();
+	}
+	init() {
+		this.start("Process Start", Date.now() - Math.floor(process.uptime() * 1e3));
+		this.end("Process Start");
+		if ("scriptStartTime" in process && typeof process.scriptStartTime === "number") {
+			this.start("Script Start", process.scriptStartTime);
+			this.end("Script Start");
+		}
+	}
+	start(name, start) {
+		if (!name || !this.#enable) return;
+		if (this.#map.has(name)) this.end(name);
+		start = start || Date.now();
+		if (!this.#startTime) this.#startTime = start;
+		const item = {
+			name,
+			start,
+			pid: process.pid,
+			index: this.#list.length
+		};
+		this.#map.set(name, item);
+		this.#list.push(item);
+		debug("start %j", item);
+		return item;
+	}
+	end(name) {
+		if (!name || !this.#enable) return;
+		const item = this.#map.get(name);
+		assert(item, `should run timing.start('${name}') first`);
+		item.end = Date.now();
+		item.duration = item.end - item.start;
+		debug("end %j", item);
+		return item;
+	}
+	enable() {
+		this.#enable = true;
+	}
+	disable() {
+		this.#enable = false;
+	}
+	clear() {
+		this.#map.clear();
+		this.#list = [];
+	}
+	toJSON() {
+		return this.#list;
+	}
+	itemToString(timelineEnd, item, times) {
+		const isEnd = typeof item.duration === "number";
+		const duration = isEnd ? item.duration : timelineEnd - item.start;
+		const offset = item.start - this.#startTime;
+		const status = `${duration}ms${isEnd ? "" : " NOT_END"}`;
+		const timespan = Math.floor(Number((offset * times).toFixed(6)));
+		let timeline = Math.floor(Number((duration * times).toFixed(6)));
+		timeline = timeline > 0 ? timeline : 1;
+		const message = `#${item.index} ${item.name}`;
+		return " ".repeat(timespan) + "▇".repeat(timeline) + ` [${status}] - ${message}`;
+	}
+	toString(prefix = "egg start timeline:", width = 50) {
+		const timelineEnd = Date.now();
+		const timelineDuration = timelineEnd - this.#startTime;
+		let times = 1;
+		if (timelineDuration > width) times = width / timelineDuration;
+		return prefix + EOL + this.#list.map((item) => this.itemToString(timelineEnd, item, times)).join(EOL);
+	}
+};
+
+//#endregion
+export { Timing };

package/package.json

@@ -1,28 +1,28 @@
 {
   "name": "@eggjs/core",
-  "version": "6.4.1",
+  "version": "6.6.0-beta.2",
   "publishConfig": {
     "access": "public"
   },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "engines": {
-    "node": ">= 18.19.0"
+    "node": ">= 20.19.0"
   },
   "description": "A core plugin framework based on @eggjs/koa",
-  "scripts": {
-    "clean": "rimraf dist",
-    "lint": "eslint src test --ext ts",
-    "pretest": "npm run clean && npm run lint -- --fix && npm run prepublishOnly",
-    "test": "egg-bin test",
-    "posttest": "npm run clean",
-    "test-local": "egg-bin test",
-    "preci": "npm run clean && npm run lint && npm run prepublishOnly",
-    "ci": "egg-bin cov",
-    "postci": "npm run clean",
-    "prepublishOnly": "tshy && tshy-after && attw --pack"
-  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/eggjs/core.git"
+    "url": "git://github.com/eggjs/egg.git",
+    "directory": "packages/core"
   },
   "keywords": [
     "egg",
@@ -33,71 +33,43 @@
   "bugs": {
     "url": "https://github.com/eggjs/egg/issues"
   },
-  "homepage": "https://github.com/eggjs/core#readme",
   "dependencies": {
-    "@eggjs/koa": "^2.20.6",
     "@eggjs/router": "^3.0.5",
-    "@eggjs/utils": "^4.3.0",
     "egg-logger": "^3.5.0",
     "egg-path-matching": "^2.0.0",
-    "extend2": "^4.0.0",
     "get-ready": "^3.1.0",
     "globby": "^11.0.2",
-    "is-type-of": "^2.1.0",
+    "is-type-of": "^2.2.0",
     "node-homedir": "^2.0.0",
     "performance-ms": "^1.1.0",
     "ready-callback": "^4.0.0",
     "tsconfig-paths": "^4.2.0",
-    "utility": "^2.1.0"
+    "utility": "^2.5.0",
+    "@eggjs/koa": "3.1.0-beta.2",
+    "@eggjs/utils": "4.5.0-beta.2",
+    "@eggjs/extend2": "4.1.0-beta.2"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.17.1",
-    "@eggjs/bin": "7",
-    "@eggjs/supertest": "^8.1.1",
-    "@eggjs/tsconfig": "1",
     "@types/js-yaml": "4",
-    "@types/mocha": "10",
-    "@types/node": "22",
+    "@types/node": "24",
     "await-event": "2",
     "coffee": "5",
-    "eslint": "8",
-    "eslint-config-egg": "14",
+    "husky": "9",
+    "prettier": "^3.4.2",
     "gals": "1",
     "js-yaml": "3",
     "mm": "^4.0.2",
-    "pedding": "2",
-    "rimraf": "6",
-    "ts-node": "10",
-    "tshy": "3",
-    "tshy-after": "1",
+    "pedding": "^2.0.1",
+    "tsdown": "^0.14.2",
     "typescript": "5",
-    "urllib": "4"
+    "urllib": "^4.6.11",
+    "@eggjs/mock": "6.1.0-beta.2",
+    "@eggjs/supertest": "8.3.0-beta.2",
+    "@eggjs/tsconfig": "3.1.0-beta.2"
   },
-  "files": [
-    "dist",
-    "src"
-  ],
-  "type": "module",
-  "tshy": {
-    "exports": {
-      "./package.json": "./package.json",
-      ".": "./src/index.ts"
-    }
-  },
-  "exports": {
-    "./package.json": "./package.json",
-    ".": {
-      "import": {
-        "types": "./dist/esm/index.d.ts",
-        "default": "./dist/esm/index.js"
-      },
-      "require": {
-        "types": "./dist/commonjs/index.d.ts",
-        "default": "./dist/commonjs/index.js"
-      }
-    }
-  },
-  "main": "./dist/commonjs/index.js",
-  "types": "./dist/commonjs/index.d.ts",
-  "module": "./dist/esm/index.js"
-}
+  "scripts": {
+    "build": "tsdown",
+    "lint": "oxlint",
+    "test": "vitest run"
+  }
+}

package/dist/commonjs/base_context_class.d.ts

@@ -1,16 +0,0 @@
-import type { EggCore, Context } from './egg.js';
-/**
- * BaseContextClass is a base class that can be extended,
- * it's instantiated in context level,
- * {@link Helper}, {@link Service} is extending it.
- */
-export declare class BaseContextClass {
-    ctx: Context;
-    app: EggCore;
-    config: Record<string, any>;
-    service: BaseContextClass;
-    /**
-     * @since 1.0.0
-     */
-    constructor(ctx: Context);
-}

package/dist/commonjs/base_context_class.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseContextClass = void 0;
-/**
- * BaseContextClass is a base class that can be extended,
- * it's instantiated in context level,
- * {@link Helper}, {@link Service} is extending it.
- */
-class BaseContextClass {
-    ctx;
-    app;
-    config;
-    service;
-    /**
-     * @since 1.0.0
-     */
-    constructor(ctx) {
-        /**
-         * @member {Context} BaseContextClass#ctx
-         * @since 1.0.0
-         */
-        this.ctx = ctx;
-        /**
-         * @member {Application} BaseContextClass#app
-         * @since 1.0.0
-         */
-        this.app = ctx.app;
-        /**
-         * @member {Config} BaseContextClass#config
-         * @since 1.0.0
-         */
-        this.config = ctx.app.config;
-        /**
-         * @member {Service} BaseContextClass#service
-         * @since 1.0.0
-         */
-        this.service = ctx.service;
-    }
-}
-exports.BaseContextClass = BaseContextClass;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFzZV9jb250ZXh0X2NsYXNzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2Jhc2VfY29udGV4dF9jbGFzcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFFQTs7OztHQUlHO0FBQ0gsTUFBYSxnQkFBZ0I7SUFDM0IsR0FBRyxDQUFVO0lBQ2IsR0FBRyxDQUFVO0lBQ2IsTUFBTSxDQUFzQjtJQUM1QixPQUFPLENBQW1CO0lBRTFCOztPQUVHO0lBQ0gsWUFBWSxHQUFZO1FBQ3RCOzs7V0FHRztRQUNILElBQUksQ0FBQyxHQUFHLEdBQUcsR0FBRyxDQUFDO1FBQ2Y7OztXQUdHO1FBQ0gsSUFBSSxDQUFDLEdBQUcsR0FBRyxHQUFHLENBQUMsR0FBRyxDQUFDO1FBQ25COzs7V0FHRztRQUNILElBQUksQ0FBQyxNQUFNLEdBQUcsR0FBRyxDQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUM7UUFDN0I7OztXQUdHO1FBQ0gsSUFBSSxDQUFDLE9BQU8sR0FBRyxHQUFHLENBQUMsT0FBTyxDQUFDO0lBQzdCLENBQUM7Q0FDRjtBQS9CRCw0Q0ErQkMifQ==

package/dist/commonjs/egg.d.ts

@@ -1,247 +0,0 @@
-import { Application as KoaApplication, Context as KoaContext, Request as KoaRequest, Response as KoaResponse } from '@eggjs/koa';
-import type { MiddlewareFunc as KoaMiddlewareFunc, Next } from '@eggjs/koa';
-import { EggConsoleLogger, Logger } from 'egg-logger';
-import { RegisterOptions, ResourcesController, EggRouter as Router } from '@eggjs/router';
-import type { ReadyFunctionArg } from 'get-ready';
-import { BaseContextClass } from './base_context_class.js';
-import { Timing } from './utils/timing.js';
-import type { Fun } from './utils/index.js';
-import { Lifecycle } from './lifecycle.js';
-import { EggLoader } from './loader/egg_loader.js';
-import { EggAppConfig } from './types.js';
-import { type SingletonCreateMethod } from './singleton.js';
-export declare const EGG_LOADER: unique symbol;
-export interface EggCoreOptions {
-    baseDir: string;
-    type: 'application' | 'agent';
-    plugins?: any;
-    serverScope?: string;
-    env?: string;
-}
-export type EggCoreInitOptions = Partial<EggCoreOptions>;
-export { KoaRequest, KoaResponse, KoaContext, KoaApplication, Router, };
-export type { Next, KoaMiddlewareFunc, };
-export declare class Request extends KoaRequest {
-    app: EggCore;
-    response: Response;
-}
-export declare class Response extends KoaResponse {
-    app: EggCore;
-    request: Request;
-}
-export declare class Context extends KoaContext {
-    app: EggCore;
-    request: Request;
-    response: Response;
-    service: BaseContextClass;
-    /**
-     * Returns map of URL parameters for given `path` and `paramNames`.
-     * @example
-     * ##### ctx.params.id {string}
-     *
-     * `GET /api/users/1` => `'1'`
-     *
-     * ##### ctx.params.per_page {string}
-     *
-     * The number of every page, `GET /api/users?per_page=20` => `20`
-     */
-    params?: Record<string, string>;
-    /**
-     * Returns array of router regexp url path captures.
-     */
-    captures?: string[];
-    /**
-     * Returns the name of the matched router.
-     */
-    routerName?: string;
-    /**
-     * Returns the path of the matched router.
-     */
-    routerPath?: string | RegExp;
-}
-export type MiddlewareFunc<T = Context> = KoaMiddlewareFunc<T>;
-export declare class EggCore extends KoaApplication {
-    #private;
-    options: EggCoreOptions;
-    timing: Timing;
-    console: EggConsoleLogger;
-    BaseContextClass: typeof BaseContextClass;
-    Controller: typeof BaseContextClass;
-    Service: typeof BaseContextClass;
-    Helper?: typeof BaseContextClass;
-    lifecycle: Lifecycle;
-    loader: EggLoader;
-    /** auto inject on loadService() */
-    readonly serviceClasses: Record<string, any>;
-    /** auto inject on loadController() */
-    readonly controller: Record<string, any>;
-    /** auto inject on loadMiddleware() */
-    readonly middlewares: Record<string, (opt: any, app: EggCore) => MiddlewareFunc>;
-    /**
-     * @class
-     * @param {Object} options - options
-     * @param {String} [options.baseDir=process.cwd()] - the directory of application
-     * @param {String} [options.type=application|agent] - whether it's running in app worker or agent worker
-     * @param {Object} [options.plugins] - custom plugins
-     * @since 1.0.0
-     */
-    constructor(options?: EggCoreInitOptions);
-    get logger(): Logger;
-    get coreLogger(): Logger;
-    /**
-     * 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;
-    /**
-     * override koa's app.use, support generator function
-     * @since 1.0.0
-     */
-    use(fn: MiddlewareFunc): this;
-    /**
-     * Whether `application` or `agent`
-     * @member {String}
-     * @since 1.0.0
-     */
-    get type(): "application" | "agent";
-    /**
-     * The current directory of application
-     * @member {String}
-     * @see {@link AppInfo#baseDir}
-     * @since 1.0.0
-     */
-    get baseDir(): string;
-    /**
-     * Alias to {@link https://npmjs.com/package/depd}
-     * @member {Function}
-     * @since 1.0.0
-     */
-    get deprecate(): (message: string) => void;
-    /**
-     * The name of application
-     * @member {String}
-     * @see {@link AppInfo#name}
-     * @since 1.0.0
-     */
-    get name(): any;
-    /**
-     * Retrieve enabled plugins
-     * @member {Object}
-     * @since 1.0.0
-     */
-    get plugins(): Record<string, import("./types.js").EggPluginInfo>;
-    /**
-     * The configuration of application
-     * @member {Config}
-     * @since 1.0.0
-     */
-    get config(): EggAppConfig;
-    /**
-     * Execute scope after loaded and before app start.
-     *
-     * Notice:
-     * This method is now NOT recommended and regarded as a deprecated one,
-     * For plugin development, we should use `didLoad` instead.
-     * For application development, we should use `willReady` instead.
-     *
-     * @see https://eggjs.org/en/advanced/loader.html#beforestart
-     *
-     * @param  {Function} scope function will execute before app start
-     * @param {string} [name] scope name, default is empty string
-     */
-    beforeStart(scope: Fun, name?: string): void;
-    /**
-     * register an callback function that will be invoked when application is ready.
-     * @see https://github.com/node-modules/get-ready
-     * @since 1.0.0
-     * @example
-     * const app = new Application(...);
-     * app.ready(err => {
-     *   if (err) throw err;
-     *   console.log('done');
-     * });
-     */
-    ready(): Promise<void>;
-    ready(flagOrFunction: ReadyFunctionArg): void;
-    /**
-     * If a client starts asynchronously, you can register `readyCallback`,
-     * then the application will wait for the callback to ready
-     *
-     * It will log when the callback is not invoked after 10s
-     *
-     * Recommend to use {@link EggCore#beforeStart}
-     * @since 1.0.0
-     *
-     * @param {String} name - readyCallback task name
-     * @param {object} opts -
-     *   - {Number} [timeout=10000] - emit `ready_timeout` when it doesn't finish but reach the timeout
-     *   - {Boolean} [isWeakDep=false] - whether it's a weak dependency
-     * @return {Function} - a callback
-     * @example
-     * const done = app.readyCallback('mysql');
-     * mysql.ready(done);
-     */
-    readyCallback(name: string, opts: object): (...args: any[]) => void;
-    /**
-     * Register a function that will be called when app close.
-     *
-     * Notice:
-     * This method is now NOT recommended directly used,
-     * Developers SHOULDN'T use app.beforeClose directly now,
-     * but in the form of class to implement beforeClose instead.
-     *
-     * @see https://eggjs.org/en/advanced/loader.html#beforeclose
-     *
-     * @param {Function} fn - the function that can be generator function or async function.
-     */
-    beforeClose(fn: Fun, name?: string): void;
-    /**
-     * Close all, it will close
-     * - callbacks registered by beforeClose
-     * - emit `close` event
-     * - remove add listeners
-     *
-     * If error is thrown when it's closing, the promise will reject.
-     * It will also reject after following call.
-     * @return {Promise} promise
-     * @since 1.0.0
-     */
-    close(): Promise<void>;
-    /**
-     * get router
-     * @member {Router} EggCore#router
-     * @since 1.0.0
-     */
-    get router(): Router;
-    /**
-     * Alias to {@link Router#url}
-     * @param {String} name - Router name
-     * @param {Object} params - more parameters
-     * @return {String} url
-     */
-    url(name: string, params?: any): string;
-    head(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
-    head(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
-    get(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
-    get(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
-    put(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
-    put(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
-    patch(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
-    patch(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
-    post(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
-    post(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
-    delete(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
-    delete(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
-    del(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
-    del(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
-    all(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
-    all(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
-    resources(prefix: string, controller: string | ResourcesController): EggCore;
-    resources(prefix: string, middleware: MiddlewareFunc, controller: string | ResourcesController): EggCore;
-    resources(name: string, prefix: string, controller: string | ResourcesController): EggCore;
-    resources(name: string, prefix: string, middleware: MiddlewareFunc, controller: string | ResourcesController): EggCore;
-    redirect(source: string, destination: string, status?: number): this;
-    register(path: string | RegExp | (string | RegExp)[], methods: string[], middleware: MiddlewareFunc | MiddlewareFunc[], opts?: RegisterOptions): this;
-    get [EGG_LOADER](): typeof EggLoader;
-}