egg 4.1.0-beta.3 → 4.1.0-beta.31

package/dist/lib/core/messenger/local.js

@@ -1,126 +1,133 @@
+import { debuglog } from 'node:util';
 import { BaseMessenger } from "./base.js";
-import { debuglog } from "node:util";
-
-//#region src/lib/core/messenger/local.ts
-const debug = debuglog("egg/lib/core/messenger/local");
+const debug = debuglog('egg/lib/core/messenger/local');
 /**
-* Communication between app worker and agent worker with EventEmitter
-*/
-var Messenger = class extends BaseMessenger {
-	pid;
-	constructor(egg) {
-		super(egg);
-		this.pid = String(process.pid);
-	}
-	/**
-	* Send message to all agent and app
-	* @param {String} action - message key
-	* @param {Object} data - message value
-	* @return {Messenger} this
-	*/
-	broadcast(action, data) {
-		debug("[%s:%s] broadcast %s with %j", this.egg.type, this.pid, action, data);
-		this.send(action, data, "both");
-		return this;
-	}
-	/**
-	* send message to the specified process
-	* Notice: in single process mode, it only can send to self process,
-	* and it will send to both agent and app's messengers.
-	* @param {String} workerId - the workerId of the receiver
-	* @param {String} action - message key
-	* @param {Object} data - message value
-	* @return {Messenger} this
-	*/
-	sendTo(workerId, action, data) {
-		debug("[%s:%s] send %s with %j to %s", this.egg.type, this.pid, action, data, workerId);
-		if (String(workerId) !== this.pid) return this;
-		this.send(action, data, "both");
-		return this;
-	}
-	/**
-	* send message to one worker by random
-	* Notice: in single process mode, we only start one agent worker and one app worker
-	* - if it's running in agent, it will send to one of app workers
-	* - if it's running in app, it will send to agent
-	* @param {String} action - message key
-	* @param {Object} data - message value
-	* @return {Messenger} this
-	*/
-	sendRandom(action, data) {
-		debug("[%s:%s] send %s with %j to opposite", this.egg.type, this.pid, action, data);
-		this.send(action, data, "opposite");
-		return this;
-	}
-	/**
-	* send message to app
-	* @param {String} action - message key
-	* @param {Object} data - message value
-	* @return {Messenger} this
-	*/
-	sendToApp(action, data) {
-		debug("[%s:%s] send %s with %j to all app", this.egg.type, this.pid, action, data);
-		this.send(action, data, "application");
-		return this;
-	}
-	/**
-	* send message to agent
-	* @param {String} action - message key
-	* @param {Object} data - message value
-	* @return {Messenger} this
-	*/
-	sendToAgent(action, data) {
-		debug("[%s:%s] send %s with %j to all agent", this.egg.type, this.pid, action, data);
-		this.send(action, data, "agent");
-		return this;
-	}
-	/**
-	* @param {String} action - message key
-	* @param {Object} data - message value
-	* @param {String} to - let master know how to send message
-	* @return {Messenger} this
-	*/
-	send(action, data, to) {
-		process.nextTick(() => {
-			const { egg } = this;
-			let application;
-			let agent;
-			let opposite;
-			if (egg.type === "application") {
-				application = egg;
-				agent = egg.agent;
-				opposite = agent;
-			} else {
-				agent = egg;
-				application = egg.application;
-				opposite = application;
-			}
-			if (!to) to = egg.type === "application" ? "agent" : "application";
-			if (application && application.messenger && (to === "application" || to === "both")) application.messenger.onMessage({
-				action,
-				data
-			});
-			if (agent && agent.messenger && (to === "agent" || to === "both")) agent.messenger.onMessage({
-				action,
-				data
-			});
-			if (opposite && opposite.messenger && to === "opposite") opposite.messenger.onMessage({
-				action,
-				data
-			});
-		});
-		return this;
-	}
-	onMessage(message) {
-		if (typeof message?.action === "string") {
-			debug("[%s:%s] got message %s with %j", this.egg.type, this.pid, message.action, message.data);
-			this.emit(message.action, message.data);
-		} else debug("[%s:%s] got an invalid message %j", this.egg.type, this.pid, message);
-	}
-	close() {
-		this.removeAllListeners();
-	}
-};
-
-//#endregion
-export { Messenger };
+ * Communication between app worker and agent worker with EventEmitter
+ */
+export class Messenger extends BaseMessenger {
+    pid;
+    constructor(egg) {
+        super(egg);
+        this.pid = String(process.pid);
+    }
+    /**
+     * Send message to all agent and app
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    broadcast(action, data) {
+        debug('[%s:%s] broadcast %s with %j', this.egg.type, this.pid, action, data);
+        this.send(action, data, 'both');
+        return this;
+    }
+    /**
+     * send message to the specified process
+     * Notice: in single process mode, it only can send to self process,
+     * and it will send to both agent and app's messengers.
+     * @param {String} workerId - the workerId of the receiver
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendTo(workerId, action, data) {
+        debug('[%s:%s] send %s with %j to %s', this.egg.type, this.pid, action, data, workerId);
+        if (String(workerId) !== this.pid) {
+            return this;
+        }
+        this.send(action, data, 'both');
+        return this;
+    }
+    /**
+     * send message to one worker by random
+     * Notice: in single process mode, we only start one agent worker and one app worker
+     * - if it's running in agent, it will send to one of app workers
+     * - if it's running in app, it will send to agent
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendRandom(action, data) {
+        debug('[%s:%s] send %s with %o to opposite', this.egg.type, this.pid, action, data);
+        this.send(action, data, 'opposite');
+        return this;
+    }
+    /**
+     * send message to app
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendToApp(action, data) {
+        debug('[%s:%s] send %s with %o to all app', this.egg.type, this.pid, action, data);
+        this.send(action, data, 'application');
+        return this;
+    }
+    /**
+     * send message to agent
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendToAgent(action, data) {
+        debug('[%s:%s] send %s with %o to all agent', this.egg.type, this.pid, action, data);
+        this.send(action, data, 'agent');
+        return this;
+    }
+    /**
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @param {String} to - let master know how to send message
+     * @return {Messenger} this
+     */
+    send(action, data, to) {
+        if (to === 'app') {
+            // alias app to application
+            to = 'application';
+        }
+        // use nextTick to keep it async as IPC messenger
+        process.nextTick(() => {
+            const { egg } = this;
+            let application;
+            let agent;
+            let opposite;
+            if (egg.type === 'application') {
+                application = egg;
+                agent = egg.agent;
+                opposite = agent;
+            }
+            else {
+                agent = egg;
+                application = egg.application;
+                opposite = application;
+            }
+            if (!to) {
+                to = egg.type === 'application' ? 'agent' : 'application';
+            }
+            debug('[%s:%s] send action:%s with %o to %s', this.egg.type, this.pid, action, data, to);
+            if (application && application.messenger && (to === 'application' || to === 'both')) {
+                application.messenger.onMessage({ action, data });
+            }
+            if (agent && agent.messenger && (to === 'agent' || to === 'both')) {
+                agent.messenger.onMessage({ action, data });
+            }
+            if (opposite && opposite.messenger && to === 'opposite') {
+                opposite.messenger.onMessage({ action, data });
+            }
+        });
+        return this;
+    }
+    onMessage(message) {
+        if (typeof message?.action === 'string') {
+            debug('[%s:%s] got message %s with %j', this.egg.type, this.pid, message.action, message.data);
+            this.emit(message.action, message.data);
+        }
+        else {
+            debug('[%s:%s] got an invalid message %j', this.egg.type, this.pid, message);
+        }
+    }
+    close() {
+        this.removeAllListeners();
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9jYWwuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvbGliL2NvcmUvbWVzc2VuZ2VyL2xvY2FsLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxRQUFRLEVBQUUsTUFBTSxXQUFXLENBQUM7QUFJckMsT0FBTyxFQUFFLGFBQWEsRUFBRSxNQUFNLFdBQVcsQ0FBQztBQUUxQyxNQUFNLEtBQUssR0FBRyxRQUFRLENBQUMsOEJBQThCLENBQUMsQ0FBQztBQUV2RDs7R0FFRztBQUNILE1BQU0sT0FBTyxTQUFVLFNBQVEsYUFBYTtJQUNqQyxHQUFHLENBQVM7SUFFckIsWUFBWSxHQUF1QjtRQUNqQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUM7UUFDWCxJQUFJLENBQUMsR0FBRyxHQUFHLE1BQU0sQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLENBQUM7SUFDakMsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsU0FBUyxDQUFDLE1BQWMsRUFBRSxJQUFjO1FBQ3RDLEtBQUssQ0FBQyw4QkFBOEIsRUFBRSxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsR0FBRyxFQUFFLE1BQU0sRUFBRSxJQUFJLENBQUMsQ0FBQztRQUM3RSxJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxJQUFJLEVBQUUsTUFBTSxDQUFDLENBQUM7UUFDaEMsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7Ozs7O09BUUc7SUFDSCxNQUFNLENBQUMsUUFBZ0IsRUFBRSxNQUFjLEVBQUUsSUFBYztRQUNyRCxLQUFLLENBQUMsK0JBQStCLEVBQUUsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLEdBQUcsRUFBRSxNQUFNLEVBQUUsSUFBSSxFQUFFLFFBQVEsQ0FBQyxDQUFDO1FBQ3hGLElBQUksTUFBTSxDQUFDLFFBQVEsQ0FBQyxLQUFLLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztZQUNsQyxPQUFPLElBQUksQ0FBQztRQUNkLENBQUM7UUFDRCxJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxJQUFJLEVBQUUsTUFBTSxDQUFDLENBQUM7UUFDaEMsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7Ozs7O09BUUc7SUFDSCxVQUFVLENBQUMsTUFBYyxFQUFFLElBQWM7UUFDdkMsS0FBSyxDQUFDLHFDQUFxQyxFQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxHQUFHLEVBQUUsTUFBTSxFQUFFLElBQUksQ0FBQyxDQUFDO1FBQ3BGLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLElBQUksRUFBRSxVQUFVLENBQUMsQ0FBQztRQUNwQyxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNILFNBQVMsQ0FBQyxNQUFjLEVBQUUsSUFBYztRQUN0QyxLQUFLLENBQUMsb0NBQW9DLEVBQUUsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLEdBQUcsRUFBRSxNQUFNLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDbkYsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsSUFBSSxFQUFFLGFBQWEsQ0FBQyxDQUFDO1FBQ3ZDLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsV0FBVyxDQUFDLE1BQWMsRUFBRSxJQUFjO1FBQ3hDLEtBQUssQ0FBQyxzQ0FBc0MsRUFBRSxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsR0FBRyxFQUFFLE1BQU0sRUFBRSxJQUFJLENBQUMsQ0FBQztRQUNyRixJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxJQUFJLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFDakMsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxJQUFJLENBQUMsTUFBYyxFQUFFLElBQWEsRUFBRSxFQUFXO1FBQzdDLElBQUksRUFBRSxLQUFLLEtBQUssRUFBRSxDQUFDO1lBQ2pCLDJCQUEyQjtZQUMzQixFQUFFLEdBQUcsYUFBYSxDQUFDO1FBQ3JCLENBQUM7UUFDRCxpREFBaUQ7UUFDakQsT0FBTyxDQUFDLFFBQVEsQ0FBQyxHQUFHLEVBQUU7WUFDcEIsTUFBTSxFQUFFLEdBQUcsRUFBRSxHQUFHLElBQUksQ0FBQztZQUNyQixJQUFJLFdBQVcsQ0FBQztZQUNoQixJQUFJLEtBQUssQ0FBQztZQUNWLElBQUksUUFBUSxDQUFDO1lBRWIsSUFBSSxHQUFHLENBQUMsSUFBSSxLQUFLLGFBQWEsRUFBRSxDQUFDO2dCQUMvQixXQUFXLEdBQUcsR0FBRyxDQUFDO2dCQUNsQixLQUFLLEdBQUcsR0FBRyxDQUFDLEtBQUssQ0FBQztnQkFDbEIsUUFBUSxHQUFHLEtBQUssQ0FBQztZQUNuQixDQUFDO2lCQUFNLENBQUM7Z0JBQ04sS0FBSyxHQUFHLEdBQUcsQ0FBQztnQkFDWixXQUFXLEdBQUcsR0FBRyxDQUFDLFdBQVcsQ0FBQztnQkFDOUIsUUFBUSxHQUFHLFdBQVcsQ0FBQztZQUN6QixDQUFDO1lBQ0QsSUFBSSxDQUFDLEVBQUUsRUFBRSxDQUFDO2dCQUNSLEVBQUUsR0FBRyxHQUFHLENBQUMsSUFBSSxLQUFLLGFBQWEsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxhQUFhLENBQUM7WUFDNUQsQ0FBQztZQUNELEtBQUssQ0FBQyxzQ0FBc0MsRUFBRSxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsR0FBRyxFQUFFLE1BQU0sRUFBRSxJQUFJLEVBQUUsRUFBRSxDQUFDLENBQUM7WUFFekYsSUFBSSxXQUFXLElBQUksV0FBVyxDQUFDLFNBQVMsSUFBSSxDQUFDLEVBQUUsS0FBSyxhQUFhLElBQUksRUFBRSxLQUFLLE1BQU0sQ0FBQyxFQUFFLENBQUM7Z0JBQ3BGLFdBQVcsQ0FBQyxTQUFTLENBQUMsU0FBUyxDQUFDLEVBQUUsTUFBTSxFQUFFLElBQUksRUFBRSxDQUFDLENBQUM7WUFDcEQsQ0FBQztZQUNELElBQUksS0FBSyxJQUFJLEtBQUssQ0FBQyxTQUFTLElBQUksQ0FBQyxFQUFFLEtBQUssT0FBTyxJQUFJLEVBQUUsS0FBSyxNQUFNLENBQUMsRUFBRSxDQUFDO2dCQUNsRSxLQUFLLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxFQUFFLE1BQU0sRUFBRSxJQUFJLEVBQUUsQ0FBQyxDQUFDO1lBQzlDLENBQUM7WUFDRCxJQUFJLFFBQVEsSUFBSSxRQUFRLENBQUMsU0FBUyxJQUFJLEVBQUUsS0FBSyxVQUFVLEVBQUUsQ0FBQztnQkFDeEQsUUFBUSxDQUFDLFNBQVMsQ0FBQyxTQUFTLENBQUMsRUFBRSxNQUFNLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQztZQUNqRCxDQUFDO1FBQ0gsQ0FBQyxDQUFDLENBQUM7UUFFSCxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRCxTQUFTLENBQUMsT0FBWTtRQUNwQixJQUFJLE9BQU8sT0FBTyxFQUFFLE1BQU0sS0FBSyxRQUFRLEVBQUUsQ0FBQztZQUN4QyxLQUFLLENBQUMsZ0NBQWdDLEVBQUUsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLEdBQUcsRUFBRSxPQUFPLENBQUMsTUFBTSxFQUFFLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQztZQUMvRixJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxNQUFNLEVBQUUsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQzFDLENBQUM7YUFBTSxDQUFDO1lBQ04sS0FBSyxDQUFDLG1DQUFtQyxFQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxHQUFHLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFDL0UsQ0FBQztJQUNILENBQUM7SUFFRCxLQUFLO1FBQ0gsSUFBSSxDQUFDLGtCQUFrQixFQUFFLENBQUM7SUFDNUIsQ0FBQztDQU9GIn0=

package/dist/lib/core/utils.d.ts

@@ -1,5 +1,2 @@
-//#region src/lib/core/utils.d.ts
-declare function convertObject(obj: any, ignore?: string | RegExp | (string | RegExp)[]): any;
-declare function safeParseURL(url: string): URL | null;
-//#endregion
-export { convertObject, safeParseURL };
+export declare function convertObject(obj: any, ignore?: string | RegExp | (string | RegExp)[]): any;
+export declare function safeParseURL(url: string): URL | null;

package/dist/lib/core/utils.js

@@ -1,48 +1,70 @@
-import util from "node:util";
-import { isAsyncFunction, isClass, isFunction, isGeneratorFunction, isPrimitive, isRegExp, isSymbol } from "is-type-of";
-
-//#region src/lib/core/utils.ts
-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;
+import util from 'node:util';
+import { isSymbol, isRegExp, isPrimitive, isClass, isFunction, isGeneratorFunction, isAsyncFunction } from 'is-type-of';
+export 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 === void 0) return value;
-	let hit = false;
-	for (const matchKey of ignore) if (typeof matchKey === "string" && matchKey === key) {
-		hit = true;
-		break;
-	} else if (isRegExp(matchKey) && matchKey.test(key)) {
-		hit = true;
-		break;
-	}
-	if (!hit) {
-		if (isSymbol(value) || isRegExp(value) || value instanceof URL) return value.toString();
-		if (isPrimitive(value) || Array.isArray(value)) return value;
-	}
-	if (Object.getPrototypeOf(value) === Object.prototype) return convertObject(value, ignore);
-	const name = value.name || "anonymous";
-	if (isClass(value)) return `<Class ${name}>`;
-	if (isFunction(value)) {
-		if (isGeneratorFunction(value)) return `<GeneratorFunction ${name}>`;
-		if (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 util.format(value);
+    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 (isRegExp(matchKey) && matchKey.test(key)) {
+            hit = true;
+            break;
+        }
+    }
+    if (!hit) {
+        if (isSymbol(value) || isRegExp(value) || value instanceof URL) {
+            return value.toString();
+        }
+        if (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 (isClass(value)) {
+        return `<Class ${name}>`;
+    }
+    // support generator function
+    if (isFunction(value)) {
+        if (isGeneratorFunction(value))
+            return `<GeneratorFunction ${name}>`;
+        if (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 util.format(value);
 }
-function safeParseURL(url) {
-	try {
-		return new URL(url);
-	} catch {
-		return null;
-	}
+export function safeParseURL(url) {
+    try {
+        return new URL(url);
+    }
+    catch {
+        return null;
+    }
 }
-
-//#endregion
-export { convertObject, safeParseURL };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbGliL2NvcmUvdXRpbHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxJQUFJLE1BQU0sV0FBVyxDQUFDO0FBQzdCLE9BQU8sRUFBRSxRQUFRLEVBQUUsUUFBUSxFQUFFLFdBQVcsRUFBRSxPQUFPLEVBQUUsVUFBVSxFQUFFLG1CQUFtQixFQUFFLGVBQWUsRUFBRSxNQUFNLFlBQVksQ0FBQztBQUV4SCxNQUFNLFVBQVUsYUFBYSxDQUFDLEdBQVEsRUFBRSxTQUFnRCxFQUFFO0lBQ3hGLElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUM7UUFDM0IsTUFBTSxHQUFHLENBQUMsTUFBTSxDQUFDLENBQUM7SUFDcEIsQ0FBQztJQUNELEtBQUssTUFBTSxHQUFHLElBQUksTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDO1FBQ25DLEdBQUcsQ0FBQyxHQUFHLENBQUMsR0FBRyxZQUFZLENBQUMsR0FBRyxFQUFFLEdBQUcsQ0FBQyxHQUFHLENBQUMsRUFBRSxNQUFNLENBQUMsQ0FBQztJQUNqRCxDQUFDO0lBQ0QsT0FBTyxHQUFHLENBQUM7QUFDYixDQUFDO0FBRUQsU0FBUyxZQUFZLENBQUMsR0FBVyxFQUFFLEtBQVUsRUFBRSxNQUEyQjtJQUN4RSxJQUFJLEtBQUssS0FBSyxJQUFJLElBQUksS0FBSyxLQUFLLFNBQVMsRUFBRSxDQUFDO1FBQzFDLE9BQU8sS0FBSyxDQUFDO0lBQ2YsQ0FBQztJQUVELElBQUksR0FBRyxHQUFHLEtBQUssQ0FBQztJQUNoQixLQUFLLE1BQU0sUUFBUSxJQUFJLE1BQU0sRUFBRSxDQUFDO1FBQzlCLElBQUksT0FBTyxRQUFRLEtBQUssUUFBUSxJQUFJLFFBQVEsS0FBSyxHQUFHLEVBQUUsQ0FBQztZQUNyRCxHQUFHLEdBQUcsSUFBSSxDQUFDO1lBQ1gsTUFBTTtRQUNSLENBQUM7YUFBTSxJQUFJLFFBQVEsQ0FBQyxRQUFRLENBQUMsSUFBSSxRQUFRLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUM7WUFDcEQsR0FBRyxHQUFHLElBQUksQ0FBQztZQUNYLE1BQU07UUFDUixDQUFDO0lBQ0gsQ0FBQztJQUNELElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztRQUNULElBQUksUUFBUSxDQUFDLEtBQUssQ0FBQyxJQUFJLFFBQVEsQ0FBQyxLQUFLLENBQUMsSUFBSSxLQUFLLFlBQVksR0FBRyxFQUFFLENBQUM7WUFDL0QsT0FBTyxLQUFLLENBQUMsUUFBUSxFQUFFLENBQUM7UUFDMUIsQ0FBQztRQUNELElBQUksV0FBVyxDQUFDLEtBQUssQ0FBQyxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztZQUMvQyxPQUFPLEtBQUssQ0FBQztRQUNmLENBQUM7SUFDSCxDQUFDO0lBRUQscURBQXFEO0lBQ3JELFNBQVM7SUFDVCxJQUFJLE1BQU0sQ0FBQyxjQUFjLENBQUMsS0FBSyxDQUFDLEtBQUssTUFBTSxDQUFDLFNBQVMsRUFBRSxDQUFDO1FBQ3RELE9BQU8sYUFBYSxDQUFDLEtBQUssRUFBRSxNQUFNLENBQUMsQ0FBQztJQUN0QyxDQUFDO0lBRUQsZ0JBQWdCO0lBQ2hCLE1BQU0sSUFBSSxHQUFHLEtBQUssQ0FBQyxJQUFJLElBQUksV0FBVyxDQUFDO0lBQ3ZDLElBQUksT0FBTyxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUM7UUFDbkIsT0FBTyxVQUFVLElBQUksR0FBRyxDQUFDO0lBQzNCLENBQUM7SUFFRCw2QkFBNkI7SUFDN0IsSUFBSSxVQUFVLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztRQUN0QixJQUFJLG1CQUFtQixDQUFDLEtBQUssQ0FBQztZQUFFLE9BQU8sc0JBQXNCLElBQUksR0FBRyxDQUFDO1FBQ3JFLElBQUksZUFBZSxDQUFDLEtBQUssQ0FBQztZQUFFLE9BQU8sa0JBQWtCLElBQUksR0FBRyxDQUFDO1FBQzdELE9BQU8sYUFBYSxJQUFJLEdBQUcsQ0FBQztJQUM5QixDQUFDO0lBRUQsTUFBTSxRQUFRLEdBQUcsS0FBSyxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUM7SUFDeEMsSUFBSSxRQUFRLEVBQUUsQ0FBQztRQUNiLElBQUksTUFBTSxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQUMsSUFBSSxPQUFPLEtBQUssS0FBSyxRQUFRLEVBQUUsQ0FBQztZQUN4RCxPQUFPLElBQUksUUFBUSxTQUFTLEtBQUssQ0FBQyxNQUFNLEdBQUcsQ0FBQztRQUM5QyxDQUFDO1FBQ0QsT0FBTyxJQUFJLFFBQVEsR0FBRyxDQUFDO0lBQ3pCLENBQUM7SUFFRCxPQUFPLElBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLENBQUM7QUFDNUIsQ0FBQztBQUVELE1BQU0sVUFBVSxZQUFZLENBQUMsR0FBVztJQUN0QyxJQUFJLENBQUM7UUFDSCxPQUFPLElBQUksR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQ3RCLENBQUM7SUFBQyxNQUFNLENBQUM7UUFDUCxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7QUFDSCxDQUFDIn0=

package/dist/lib/define.d.ts

@@ -0,0 +1,76 @@
+import type { PartialDeep } from 'type-fest';
+import type { EggAppConfig, EggAppInfo, EggEnvType } from './types.ts';
+/**
+ * Partial EggAppConfig
+ */
+export type PartialEggConfig = PartialDeep<EggAppConfig>;
+/**
+ * Configuration factory function return type
+ */
+export type EggConfigFactory = (appInfo: EggAppInfo) => PartialEggConfig;
+/**
+ * Define configuration with type safety
+ * @example
+ * ```ts
+ * import { defineConfig } from 'egg';
+ *
+ * export default defineConfig({
+ *   keys: 'my-keys',
+ *   middleware: []
+ * });
+ * ```
+ */
+export declare function defineConfig(config: PartialEggConfig): PartialEggConfig;
+/**
+ * Define configuration factory function with type safety
+ * @example
+ * ```ts
+ * export default defineConfigFactory((appInfo): PartialEggConfig => ({
+ *   keys: appInfo.name + '_keys',
+ *   middleware: []
+ * }));
+ * ```
+ */
+export declare function defineConfigFactory(configFactory: EggConfigFactory): EggConfigFactory;
+/**
+ * Define plugin meta with type safety
+ */
+export interface EggPluginMeta {
+    /** the plugin name, it can be used in `dep` */
+    name: string;
+    /** whether enabled */
+    enable: boolean;
+    /** the directory of the plugin package */
+    path: string;
+    /** the dependent plugins, you can use the plugin name */
+    dependencies?: string[];
+    /** the optional dependent plugins. */
+    optionalDependencies?: string[];
+    /** specify the serverEnv that only enable the plugin in it, default to all envs */
+    env?: EggEnvType[];
+}
+/**
+ * Egg plugin options, user can't provide name, it will be generated by the plugin factory.
+ */
+export type EggPluginOptions = PartialDeep<Omit<EggPluginMeta, 'name'>>;
+/**
+ * Egg plugin factory type, the return value is a record of plugin name and plugin meta.
+ */
+export type EggPluginFactory = (options?: EggPluginOptions) => Record<string, EggPluginMeta>;
+/**
+ * Define plugin factory with type safety
+ * @example
+ * ```ts
+ * import { definePluginFactory } from 'egg';
+ *
+ * export default definePluginFactory({
+ *   name: 'my-plugin',
+ *   enable: true,
+ *   path: 'path/to/my-plugin',
+ *   dependencies: ['watcher'],
+ *   optionalDependencies: ['view'],
+ *   env: ['local', 'unittest'],
+ * });
+ * ```
+ */
+export declare function definePluginFactory(pluginMeta: EggPluginMeta): EggPluginFactory;

package/dist/lib/define.js

@@ -0,0 +1,59 @@
+import assert from 'node:assert/strict';
+/**
+ * Define configuration with type safety
+ * @example
+ * ```ts
+ * import { defineConfig } from 'egg';
+ *
+ * export default defineConfig({
+ *   keys: 'my-keys',
+ *   middleware: []
+ * });
+ * ```
+ */
+export function defineConfig(config) {
+    return config;
+}
+/**
+ * Define configuration factory function with type safety
+ * @example
+ * ```ts
+ * export default defineConfigFactory((appInfo): PartialEggConfig => ({
+ *   keys: appInfo.name + '_keys',
+ *   middleware: []
+ * }));
+ * ```
+ */
+export function defineConfigFactory(configFactory) {
+    return configFactory;
+}
+/**
+ * Define plugin factory with type safety
+ * @example
+ * ```ts
+ * import { definePluginFactory } from 'egg';
+ *
+ * export default definePluginFactory({
+ *   name: 'my-plugin',
+ *   enable: true,
+ *   path: 'path/to/my-plugin',
+ *   dependencies: ['watcher'],
+ *   optionalDependencies: ['view'],
+ *   env: ['local', 'unittest'],
+ * });
+ * ```
+ */
+export function definePluginFactory(pluginMeta) {
+    assert(pluginMeta.name, 'plugin name is required');
+    assert(pluginMeta.path, 'plugin path is required');
+    return (options) => ({
+        [pluginMeta.name]: {
+            ...pluginMeta,
+            ...options,
+            name: pluginMeta.name,
+            // skip merge `eggPlugin` field from package.json
+            skipMerge: true,
+        },
+    });
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVmaW5lLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2xpYi9kZWZpbmUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxNQUFNLE1BQU0sb0JBQW9CLENBQUM7QUFnQnhDOzs7Ozs7Ozs7OztHQVdHO0FBQ0gsTUFBTSxVQUFVLFlBQVksQ0FBQyxNQUF3QjtJQUNuRCxPQUFPLE1BQU0sQ0FBQztBQUNoQixDQUFDO0FBRUQ7Ozs7Ozs7OztHQVNHO0FBQ0gsTUFBTSxVQUFVLG1CQUFtQixDQUFDLGFBQStCO0lBQ2pFLE9BQU8sYUFBYSxDQUFDO0FBQ3ZCLENBQUM7QUE4QkQ7Ozs7Ozs7Ozs7Ozs7OztHQWVHO0FBQ0gsTUFBTSxVQUFVLG1CQUFtQixDQUFDLFVBQXlCO0lBQzNELE1BQU0sQ0FBQyxVQUFVLENBQUMsSUFBSSxFQUFFLHlCQUF5QixDQUFDLENBQUM7SUFDbkQsTUFBTSxDQUFDLFVBQVUsQ0FBQyxJQUFJLEVBQUUseUJBQXlCLENBQUMsQ0FBQztJQUNuRCxPQUFPLENBQUMsT0FBMEIsRUFBRSxFQUFFLENBQUMsQ0FBQztRQUN0QyxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsRUFBRTtZQUNqQixHQUFHLFVBQVU7WUFDYixHQUFHLE9BQU87WUFDVixJQUFJLEVBQUUsVUFBVSxDQUFDLElBQUk7WUFDckIsaURBQWlEO1lBQ2pELFNBQVMsRUFBRSxJQUFJO1NBQ2hCO0tBQ0YsQ0FBQyxDQUFDO0FBQ0wsQ0FBQyJ9