@eggjs/core 7.0.0-beta.20 → 7.0.0-beta.22

package/dist/loader/file_loader.d.ts

@@ -0,0 +1,101 @@
+import { type Fun } from '../utils/index.ts';
+export declare const FULLPATH: unique symbol;
+export declare const EXPORTS: unique symbol;
+export declare const CaseStyle: {
+    readonly camel: "camel";
+    readonly lower: "lower";
+    readonly upper: "upper";
+};
+export type CaseStyle = (typeof CaseStyle)[keyof typeof CaseStyle];
+export type CaseStyleFunction = (filepath: string) => string[];
+export type FileLoaderInitializer = (exports: unknown, options: {
+    path: string;
+    pathName: string;
+}) => unknown;
+export type FileLoaderFilter = (exports: unknown) => boolean;
+export interface FileLoaderOptions {
+    /** directories to be loaded */
+    directory: string | string[];
+    /** attach the target object from loaded files */
+    target: Record<string, any>;
+    /** match the files when load, support glob, default to all js files */
+    match?: string | string[];
+    /** ignore the files when load, support glob */
+    ignore?: string | string[];
+    /** custom file exports, receive two parameters, first is the inject object(if not js file, will be content buffer), second is an `options` object that contain `path` */
+    initializer?: FileLoaderInitializer;
+    /** determine whether invoke when exports is function */
+    call?: boolean;
+    /** determine whether override the property when get the same name */
+    override?: boolean;
+    /** an object that be the argument when invoke the function */
+    inject?: Record<string, any>;
+    /** a function that filter the exports which can be loaded */
+    filter?: FileLoaderFilter;
+    /** set property's case when converting a filepath to property list. */
+    caseStyle?: CaseStyle | CaseStyleFunction;
+    lowercaseFirst?: boolean;
+}
+export interface FileLoaderParseItem {
+    fullpath: string;
+    properties: string[];
+    exports: object | Fun;
+}
+/**
+ * Load files from directory to target object.
+ * @since 1.0.0
+ */
+export declare class FileLoader {
+    static get FULLPATH(): symbol;
+    static get EXPORTS(): symbol;
+    readonly options: FileLoaderOptions & Required<Pick<FileLoaderOptions, 'caseStyle'>>;
+    /**
+     * @class
+     * @param {Object} options - options
+     * @param {String|Array} options.directory - directories to be loaded
+     * @param {Object} options.target - attach the target object from loaded files
+     * @param {String} options.match - match the files when load, support glob, default to all js files
+     * @param {String} options.ignore - ignore the files when load, support glob
+     * @param {Function} options.initializer - custom file exports, receive two parameters, first is the inject object(if not js file, will be content buffer), second is an `options` object that contain `path`
+     * @param {Boolean} options.call - determine whether invoke when exports is function
+     * @param {Boolean} options.override - determine whether override the property when get the same name
+     * @param {Object} options.inject - an object that be the argument when invoke the function
+     * @param {Function} options.filter - a function that filter the exports which can be loaded
+     * @param {String|Function} options.caseStyle - set property's case when converting a filepath to property list.
+     */
+    constructor(options: FileLoaderOptions);
+    /**
+     * attach items to target object. Mapping the directory to properties.
+     * `app/controller/group/repository.js` => `target.group.repository`
+     * @returns {Object} target
+     * @since 1.0.0
+     */
+    load(): Promise<object>;
+    /**
+     * Parse files from given directories, then return an items list, each item contains properties and exports.
+     *
+     * For example, parse `app/controller/group/repository.js`
+     *
+     * ```
+     * module.exports = app => {
+     *   return class RepositoryController extends app.Controller {};
+     * }
+     * ```
+     *
+     * It returns a item
+     *
+     * ```
+     * {
+     *   properties: [ 'group', 'repository' ],
+     *   exports: app => { ... },
+     * }
+     * ```
+     *
+     * `Properties` is an array that contains the directory of a filepath.
+     *
+     * `Exports` depends on type, if exports is a function, it will be called. if initializer is specified, it will be called with exports for customizing.
+     * @returns {Array} items
+     * @since 1.0.0
+     */
+    protected parse(): Promise<FileLoaderParseItem[]>;
+}

package/dist/loader/file_loader.js

@@ -0,0 +1,249 @@
+import assert from 'node:assert';
+import fs from 'node:fs';
+import { debuglog } from 'node:util';
+import path from 'node:path';
+import globby from 'globby';
+import { isClass, isGeneratorFunction, isAsyncFunction, isPrimitive } from 'is-type-of';
+import { isSupportTypeScript } from '@eggjs/utils';
+import utils, {} from "../utils/index.js";
+const debug = debuglog('egg/core/file_loader');
+export const FULLPATH = Symbol('EGG_LOADER_ITEM_FULLPATH');
+export const EXPORTS = Symbol('EGG_LOADER_ITEM_EXPORTS');
+export const CaseStyle = {
+    camel: 'camel',
+    lower: 'lower',
+    upper: 'upper',
+};
+/**
+ * Load files from directory to target object.
+ * @since 1.0.0
+ */
+export class FileLoader {
+    static get FULLPATH() {
+        return FULLPATH;
+    }
+    static get EXPORTS() {
+        return EXPORTS;
+    }
+    options;
+    /**
+     * @class
+     * @param {Object} options - options
+     * @param {String|Array} options.directory - directories to be loaded
+     * @param {Object} options.target - attach the target object from loaded files
+     * @param {String} options.match - match the files when load, support glob, default to all js files
+     * @param {String} options.ignore - ignore the files when load, support glob
+     * @param {Function} options.initializer - custom file exports, receive two parameters, first is the inject object(if not js file, will be content buffer), second is an `options` object that contain `path`
+     * @param {Boolean} options.call - determine whether invoke when exports is function
+     * @param {Boolean} options.override - determine whether override the property when get the same name
+     * @param {Object} options.inject - an object that be the argument when invoke the function
+     * @param {Function} options.filter - a function that filter the exports which can be loaded
+     * @param {String|Function} options.caseStyle - set property's case when converting a filepath to property list.
+     */
+    constructor(options) {
+        assert(options.directory, 'options.directory is required');
+        assert(options.target, 'options.target is required');
+        this.options = {
+            caseStyle: CaseStyle.camel,
+            call: true,
+            override: false,
+            ...options,
+        };
+        // compatible old options _lowercaseFirst_
+        if (this.options.lowercaseFirst === true) {
+            utils.deprecated('lowercaseFirst is deprecated, use caseStyle instead');
+            this.options.caseStyle = CaseStyle.lower;
+        }
+    }
+    /**
+     * attach items to target object. Mapping the directory to properties.
+     * `app/controller/group/repository.js` => `target.group.repository`
+     * @returns {Object} target
+     * @since 1.0.0
+     */
+    async load() {
+        const items = await this.parse();
+        const target = this.options.target;
+        for (const item of items) {
+            debug('[load] loading item: fullpath: %s, properties: %o', item.fullpath, item.properties);
+            // item { properties: [ 'a', 'b', 'c'], exports }
+            // => target.a.b.c = exports
+            item.properties.reduce((target, property, index) => {
+                let obj;
+                const properties = item.properties.slice(0, index + 1).join('.');
+                if (index === item.properties.length - 1) {
+                    if (property in target && !this.options.override) {
+                        throw new Error(`can't overwrite property '${properties}' from ${target[property][FULLPATH]} by ${item.fullpath}`);
+                    }
+                    obj = item.exports;
+                    if (obj && !isPrimitive(obj)) {
+                        Reflect.set(obj, FULLPATH, item.fullpath);
+                        Reflect.set(obj, EXPORTS, true);
+                    }
+                }
+                else {
+                    obj = target[property] || {};
+                }
+                target[property] = obj;
+                if (debug.enabled) {
+                    debug('[load] loaded item properties: %o => keys: %j, index: %d', properties, Object.keys(obj), index);
+                }
+                return obj;
+            }, target);
+        }
+        return target;
+    }
+    /**
+     * Parse files from given directories, then return an items list, each item contains properties and exports.
+     *
+     * For example, parse `app/controller/group/repository.js`
+     *
+     * ```
+     * module.exports = app => {
+     *   return class RepositoryController extends app.Controller {};
+     * }
+     * ```
+     *
+     * It returns a item
+     *
+     * ```
+     * {
+     *   properties: [ 'group', 'repository' ],
+     *   exports: app => { ... },
+     * }
+     * ```
+     *
+     * `Properties` is an array that contains the directory of a filepath.
+     *
+     * `Exports` depends on type, if exports is a function, it will be called. if initializer is specified, it will be called with exports for customizing.
+     * @returns {Array} items
+     * @since 1.0.0
+     */
+    async parse() {
+        let files = this.options.match;
+        if (files) {
+            files = Array.isArray(files) ? files : [files];
+        }
+        else {
+            files = isSupportTypeScript() ? ['**/*.(js|ts)', '!**/*.d.ts'] : ['**/*.js'];
+        }
+        let ignore = this.options.ignore;
+        if (ignore) {
+            ignore = Array.isArray(ignore) ? ignore : [ignore];
+            ignore = ignore.filter(f => !!f).map(f => '!' + f);
+            files = files.concat(ignore);
+        }
+        let directories = this.options.directory;
+        if (!Array.isArray(directories)) {
+            directories = [directories];
+        }
+        const filter = typeof this.options.filter === 'function' ? this.options.filter : null;
+        const items = [];
+        debug('[parse] parsing directories: %j', directories);
+        for (const directory of directories) {
+            const filepaths = globby.sync(files, { cwd: directory });
+            debug('[parse] globby files: %o, cwd: %o => %o', files, directory, filepaths);
+            for (const filepath of filepaths) {
+                const fullpath = path.join(directory, filepath);
+                if (!fs.statSync(fullpath).isFile())
+                    continue;
+                if (filepath.endsWith('.js')) {
+                    const filepathTs = filepath.replace(/\.js$/, '.ts');
+                    if (filepaths.includes(filepathTs)) {
+                        debug('[parse] ignore %s, because %s exists', fullpath, filepathTs);
+                        continue;
+                    }
+                }
+                // get properties
+                // app/service/foo/bar.js => [ 'foo', 'bar' ]
+                const properties = getProperties(filepath, this.options.caseStyle);
+                // app/service/foo/bar.js => service.foo.bar
+                const pathName = directory.split(/[/\\]/).slice(-1) + '.' + properties.join('.');
+                // get exports from the file
+                const exports = await getExports(fullpath, this.options, pathName);
+                // ignore exports when it's null or false returned by filter function
+                if (exports === null || exports === undefined || (filter && filter(exports) === false)) {
+                    continue;
+                }
+                // set properties of class
+                if (isClass(exports)) {
+                    exports.prototype.pathName = pathName;
+                    exports.prototype.fullPath = fullpath;
+                }
+                items.push({ fullpath, properties, exports });
+                debug('[parse] parse %s, properties %j, exports %o', fullpath, properties, exports);
+            }
+        }
+        return items;
+    }
+}
+// convert file path to an array of properties
+// a/b/c.js => ['a', 'b', 'c']
+function getProperties(filepath, caseStyle) {
+    // if caseStyle is function, return the result of function
+    if (typeof caseStyle === 'function') {
+        const result = caseStyle(filepath);
+        assert(Array.isArray(result), `caseStyle expect an array, but got ${JSON.stringify(result)}`);
+        return result;
+    }
+    // use default camelize
+    return defaultCamelize(filepath, caseStyle);
+}
+// Get exports from filepath
+// If exports is null/undefined, it will be ignored
+async function getExports(fullpath, options, pathName) {
+    let exports = await utils.loadFile(fullpath);
+    // process exports as you like
+    if (options.initializer) {
+        exports = options.initializer(exports, { path: fullpath, pathName });
+        debug('[getExports] after initializer => %o', exports);
+    }
+    if (isGeneratorFunction(exports)) {
+        throw new TypeError(`Support for generators was removed, fullpath: ${fullpath}`);
+    }
+    // return exports when it's a class or async function
+    //
+    // module.exports = class Service {};
+    // or
+    // module.exports = async function() {}
+    if (isClass(exports) || isAsyncFunction(exports)) {
+        return exports;
+    }
+    // return exports after call when it's a function
+    //
+    // module.exports = function(app) {
+    //   return {};
+    // }
+    if (options.call && typeof exports === 'function') {
+        exports = exports(options.inject);
+        if (exports !== null && exports !== undefined) {
+            return exports;
+        }
+    }
+    // return exports what is
+    return exports;
+}
+function defaultCamelize(filepath, caseStyle) {
+    const properties = filepath.slice(0, filepath.lastIndexOf('.')).split('/');
+    return properties.map(property => {
+        if (!/^[a-z][a-z0-9_-]*$/i.test(property)) {
+            throw new Error(`${property} is not match 'a-z0-9_-' in ${filepath}`);
+        }
+        // use default camelize, will capitalize the first letter
+        // foo_bar.js > FooBar
+        // fooBar.js  > FooBar
+        // FooBar.js  > FooBar
+        // FooBar.js  > FooBar
+        // FooBar.js  > fooBar (if lowercaseFirst is true)
+        property = property.replaceAll(/[_-][a-z]/gi, s => s.slice(1).toUpperCase());
+        let first = property[0];
+        if (caseStyle === CaseStyle.lower) {
+            first = first.toLowerCase();
+        }
+        else if (caseStyle === CaseStyle.upper) {
+            first = first.toUpperCase();
+        }
+        return first + property.slice(1);
+    });
+}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"file_loader.js","sourceRoot":"","sources":["../../src/loader/file_loader.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACxF,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAEnD,OAAO,KAAK,EAAE,EAAY,MAAM,mBAAmB,CAAC;AAEpD,MAAM,KAAK,GAAG,QAAQ,CAAC,sBAAsB,CAAC,CAAC;AAE/C,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,0BAA0B,CAAC,CAAC;AAC3D,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,yBAAyB,CAAC,CAAC;AAEzD,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;CACN,CAAC;AAuCX;;;GAGG;AACH,MAAM,OAAO,UAAU;IACrB,MAAM,KAAK,QAAQ;QACjB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,MAAM,KAAK,OAAO;QAChB,OAAO,OAAO,CAAC;IACjB,CAAC;IAEQ,OAAO,CAAqE;IAErF;;;;;;;;;;;;;OAaG;IACH,YAAY,OAA0B;QACpC,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,+BAA+B,CAAC,CAAC;QAC3D,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,4BAA4B,CAAC,CAAC;QACrD,IAAI,CAAC,OAAO,GAAG;YACb,SAAS,EAAE,SAAS,CAAC,KAAK;YAC1B,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,KAAK;YACf,GAAG,OAAO;SACX,CAAC;QAEF,0CAA0C;QAC1C,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,KAAK,IAAI,EAAE,CAAC;YACzC,KAAK,CAAC,UAAU,CAAC,qDAAqD,CAAC,CAAC;YACxE,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC;QAC3C,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QACnC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,KAAK,CAAC,mDAAmD,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YAC3F,iDAAiD;YACjD,4BAA4B;YAC5B,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE;gBACjD,IAAI,GAAQ,CAAC;gBACb,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACjE,IAAI,KAAK,KAAK,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACzC,IAAI,QAAQ,IAAI,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;wBACjD,MAAM,IAAI,KAAK,CACb,6BAA6B,UAAU,UAAU,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,OAAO,IAAI,CAAC,QAAQ,EAAE,CAClG,CAAC;oBACJ,CAAC;oBACD,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC;oBACnB,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;wBAC7B,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;wBAC1C,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;oBAClC,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAC/B,CAAC;gBACD,MAAM,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC;gBACvB,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;oBAClB,KAAK,CAAC,0DAA0D,EAAE,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;gBACzG,CAAC;gBACD,OAAO,GAAG,CAAC;YACb,CAAC,EAAE,MAAM,CAAC,CAAC;QACb,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACO,KAAK,CAAC,KAAK;QACnB,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;QAC/B,IAAI,KAAK,EAAE,CAAC;YACV,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACjD,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,mBAAmB,EAAE,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAC/E,CAAC;QAED,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QACjC,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;YACnD,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;YACnD,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;QAED,IAAI,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;QACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YAChC,WAAW,GAAG,CAAC,WAAW,CAAC,CAAC;QAC9B,CAAC;QAED,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;QACtF,MAAM,KAAK,GAA0B,EAAE,CAAC;QACxC,KAAK,CAAC,iCAAiC,EAAE,WAAW,CAAC,CAAC;QACtD,KAAK,MAAM,SAAS,IAAI,WAAW,EAAE,CAAC;YACpC,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC;YACzD,KAAK,CAAC,yCAAyC,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;YAC9E,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;gBAChD,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE;oBAAE,SAAS;gBAC9C,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC7B,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;oBACpD,IAAI,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;wBACnC,KAAK,CAAC,sCAAsC,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;wBACpE,SAAS;oBACX,CAAC;gBACH,CAAC;gBACD,iBAAiB;gBACjB,6CAA6C;gBAC7C,MAAM,UAAU,GAAG,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;gBACnE,4CAA4C;gBAC5C,MAAM,QAAQ,GAAG,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACjF,4BAA4B;gBAC5B,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAEnE,qEAAqE;gBACrE,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC;oBACvF,SAAS;gBACX,CAAC;gBAED,0BAA0B;gBAC1B,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;oBACrB,OAAO,CAAC,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;oBACtC,OAAO,CAAC,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;gBACxC,CAAC;gBAED,KAAK,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,CAAC;gBAC9C,KAAK,CAAC,6CAA6C,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;YACtF,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAED,8CAA8C;AAC9C,8BAA8B;AAC9B,SAAS,aAAa,CAAC,QAAgB,EAAE,SAAwC;IAC/E,0DAA0D;IAC1D,IAAI,OAAO,SAAS,KAAK,UAAU,EAAE,CAAC;QACpC,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;QACnC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,sCAAsC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC9F,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,uBAAuB;IACvB,OAAO,eAAe,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;AAC9C,CAAC;AAED,4BAA4B;AAC5B,mDAAmD;AACnD,KAAK,UAAU,UAAU,CAAC,QAAgB,EAAE,OAA0B,EAAE,QAAgB;IACtF,IAAI,OAAO,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC7C,8BAA8B;IAC9B,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;QACxB,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;QACrE,KAAK,CAAC,sCAAsC,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED,IAAI,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,SAAS,CAAC,iDAAiD,QAAQ,EAAE,CAAC,CAAC;IACnF,CAAC;IAED,qDAAqD;IACrD,EAAE;IACF,qCAAqC;IACrC,KAAK;IACL,uCAAuC;IACvC,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;QACjD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,iDAAiD;IACjD,EAAE;IACF,mCAAmC;IACnC,eAAe;IACf,IAAI;IACJ,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;QAClD,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAClC,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC9C,OAAO,OAAO,CAAC;QACjB,CAAC;IACH,CAAC;IAED,yBAAyB;IACzB,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,eAAe,CAAC,QAAgB,EAAE,SAAoB;IAC7D,MAAM,UAAU,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC3E,OAAO,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;QAC/B,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,+BAA+B,QAAQ,EAAE,CAAC,CAAC;QACxE,CAAC;QAED,yDAAyD;QACzD,sBAAsB;QACtB,sBAAsB;QACtB,sBAAsB;QACtB,sBAAsB;QACtB,kDAAkD;QAClD,QAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAC7E,IAAI,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QACxB,IAAI,SAAS,KAAK,SAAS,CAAC,KAAK,EAAE,CAAC;YAClC,KAAK,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAC9B,CAAC;aAAM,IAAI,SAAS,KAAK,SAAS,CAAC,KAAK,EAAE,CAAC;YACzC,KAAK,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAC9B,CAAC;QACD,OAAO,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/singleton.d.ts

@@ -0,0 +1,29 @@
+import type { EggCore } from './egg.ts';
+export type SingletonCreateMethod = (config: Record<string, any>, app: EggCore, clientName: string) => unknown | Promise<unknown>;
+export interface SingletonOptions {
+    name: string;
+    app: EggCore;
+    create: SingletonCreateMethod;
+}
+export declare class Singleton<T = any> {
+    #private;
+    readonly clients: Map<string, T>;
+    readonly app: EggCore;
+    readonly create: SingletonCreateMethod;
+    readonly name: string;
+    readonly options: Record<string, any>;
+    constructor(options: SingletonOptions);
+    init(): void | Promise<void>;
+    initSync(): void;
+    initAsync(): Promise<void>;
+    /**
+     * @deprecated please use `getSingletonInstance(id)` instead
+     */
+    get(id: string): T;
+    /**
+     * Get singleton instance by id
+     */
+    getSingletonInstance(id: string): T;
+    createInstance(config: Record<string, any>, clientName: string): T;
+    createInstanceAsync(config: Record<string, any>, clientName: string): Promise<T>;
+}

package/dist/singleton.js

@@ -0,0 +1,117 @@
+import assert from 'node:assert';
+import { isAsyncFunction } from 'is-type-of';
+export class Singleton {
+    clients = new Map();
+    app;
+    create;
+    name;
+    options;
+    constructor(options) {
+        assert(options.name, '[egg/core/singleton] Singleton#constructor options.name is required');
+        assert(options.app, '[egg/core/singleton] Singleton#constructor options.app is required');
+        assert(options.create, '[egg/core/singleton] Singleton#constructor options.create is required');
+        assert(!(options.name in options.app), `[egg/core/singleton] ${options.name} is already exists in app`);
+        this.app = options.app;
+        this.name = options.name;
+        this.create = options.create;
+        this.options = options.app.config[this.name] ?? {};
+    }
+    init() {
+        return isAsyncFunction(this.create) ? this.initAsync() : this.initSync();
+    }
+    initSync() {
+        const options = this.options;
+        assert(!(options.client && options.clients), `[egg/core/singleton] ${this.name} can not set options.client and options.clients both`);
+        // alias app[name] as client, but still support createInstance method
+        if (options.client) {
+            const client = this.createInstance(options.client, options.name);
+            this.#setClientToApp(client);
+            this.#extendDynamicMethods(client);
+            return;
+        }
+        // multi client, use app[name].getSingletonInstance(id)
+        if (options.clients) {
+            for (const id of Object.keys(options.clients)) {
+                const client = this.createInstance(options.clients[id], id);
+                this.clients.set(id, client);
+            }
+            this.#setClientToApp(this);
+            return;
+        }
+        // no config.clients and config.client
+        this.#setClientToApp(this);
+    }
+    async initAsync() {
+        const options = this.options;
+        assert(!(options.client && options.clients), `[egg/core/singleton] ${this.name} can not set options.client and options.clients both`);
+        // alias app[name] as client, but still support createInstance method
+        if (options.client) {
+            const client = await this.createInstanceAsync(options.client, options.name);
+            this.#setClientToApp(client);
+            this.#extendDynamicMethods(client);
+            return;
+        }
+        // multi client, use app[name].getInstance(id)
+        if (options.clients) {
+            await Promise.all(Object.keys(options.clients).map((id) => {
+                return this.createInstanceAsync(options.clients[id], id).then(client => this.clients.set(id, client));
+            }));
+            this.#setClientToApp(this);
+            return;
+        }
+        // no config.clients and config.client
+        this.#setClientToApp(this);
+    }
+    #setClientToApp(client) {
+        Reflect.set(this.app, this.name, client);
+    }
+    /**
+     * @deprecated please use `getSingletonInstance(id)` instead
+     */
+    get(id) {
+        return this.clients.get(id);
+    }
+    /**
+     * Get singleton instance by id
+     */
+    getSingletonInstance(id) {
+        return this.clients.get(id);
+    }
+    createInstance(config, clientName) {
+        // async creator only support createInstanceAsync
+        assert(!isAsyncFunction(this.create), `[egg/core/singleton] ${this.name} only support asynchronous creation, please use createInstanceAsync`);
+        // options.default will be merge in to options.clients[id]
+        config = {
+            ...this.options.default,
+            ...config,
+        };
+        return this.create(config, this.app, clientName);
+    }
+    async createInstanceAsync(config, clientName) {
+        // options.default will be merge in to options.clients[id]
+        config = {
+            ...this.options.default,
+            ...config,
+        };
+        return (await this.create(config, this.app, clientName));
+    }
+    #extendDynamicMethods(client) {
+        assert(!client.createInstance, '[egg/core/singleton] singleton instance should not have createInstance method');
+        assert(!client.createInstanceAsync, '[egg/core/singleton] singleton instance should not have createInstanceAsync method');
+        try {
+            let extendable = client;
+            // Object.preventExtensions() or Object.freeze()
+            if (!Object.isExtensible(client) || Object.isFrozen(client)) {
+                // eslint-disable-next-line no-proto
+                extendable = client.__proto__ || client;
+            }
+            extendable.createInstance = this.createInstance.bind(this);
+            extendable.createInstanceAsync = this.createInstanceAsync.bind(this);
+        }
+        catch (err) {
+            this.app.coreLogger.warn('[egg/core/singleton] %s dynamic create is disabled because of client is un-extendable', this.name);
+            this.app.coreLogger.warn(err);
+        }
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2luZ2xldG9uLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL3NpbmdsZXRvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLE1BQU0sTUFBTSxhQUFhLENBQUM7QUFFakMsT0FBTyxFQUFFLGVBQWUsRUFBRSxNQUFNLFlBQVksQ0FBQztBQWdCN0MsTUFBTSxPQUFPLFNBQVM7SUFDWCxPQUFPLEdBQUcsSUFBSSxHQUFHLEVBQWEsQ0FBQztJQUMvQixHQUFHLENBQVU7SUFDYixNQUFNLENBQXdCO0lBQzlCLElBQUksQ0FBUztJQUNiLE9BQU8sQ0FBc0I7SUFFdEMsWUFBWSxPQUF5QjtRQUNuQyxNQUFNLENBQUMsT0FBTyxDQUFDLElBQUksRUFBRSxxRUFBcUUsQ0FBQyxDQUFDO1FBQzVGLE1BQU0sQ0FBQyxPQUFPLENBQUMsR0FBRyxFQUFFLG9FQUFvRSxDQUFDLENBQUM7UUFDMUYsTUFBTSxDQUFDLE9BQU8sQ0FBQyxNQUFNLEVBQUUsdUVBQXVFLENBQUMsQ0FBQztRQUNoRyxNQUFNLENBQUMsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxJQUFJLElBQUksT0FBTyxDQUFDLEdBQUcsQ0FBQyxFQUFFLHdCQUF3QixPQUFPLENBQUMsSUFBSSwyQkFBMkIsQ0FBQyxDQUFDO1FBQ3hHLElBQUksQ0FBQyxHQUFHLEdBQUcsT0FBTyxDQUFDLEdBQUcsQ0FBQztRQUN2QixJQUFJLENBQUMsSUFBSSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUM7UUFDekIsSUFBSSxDQUFDLE1BQU0sR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDO1FBQzdCLElBQUksQ0FBQyxPQUFPLEdBQUcsT0FBTyxDQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLEVBQUUsQ0FBQztJQUNyRCxDQUFDO0lBRUQsSUFBSTtRQUNGLE9BQU8sZUFBZSxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBRSxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsUUFBUSxFQUFFLENBQUM7SUFDM0UsQ0FBQztJQUVELFFBQVE7UUFDTixNQUFNLE9BQU8sR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDO1FBQzdCLE1BQU0sQ0FDSixDQUFDLENBQUMsT0FBTyxDQUFDLE1BQU0sSUFBSSxPQUFPLENBQUMsT0FBTyxDQUFDLEVBQ3BDLHdCQUF3QixJQUFJLENBQUMsSUFBSSxzREFBc0QsQ0FDeEYsQ0FBQztRQUVGLHFFQUFxRTtRQUNyRSxJQUFJLE9BQU8sQ0FBQyxNQUFNLEVBQUUsQ0FBQztZQUNuQixNQUFNLE1BQU0sR0FBRyxJQUFJLENBQUMsY0FBYyxDQUFDLE9BQU8sQ0FBQyxNQUFNLEVBQUUsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQ2pFLElBQUksQ0FBQyxlQUFlLENBQUMsTUFBTSxDQUFDLENBQUM7WUFDN0IsSUFBSSxDQUFDLHFCQUFxQixDQUFDLE1BQU0sQ0FBQyxDQUFDO1lBQ25DLE9BQU87UUFDVCxDQUFDO1FBRUQsdURBQXVEO1FBQ3ZELElBQUksT0FBTyxDQUFDLE9BQU8sRUFBRSxDQUFDO1lBQ3BCLEtBQUssTUFBTSxFQUFFLElBQUksTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQztnQkFDOUMsTUFBTSxNQUFNLEdBQUcsSUFBSSxDQUFDLGNBQWMsQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFDO2dCQUM1RCxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxFQUFFLEVBQUUsTUFBTSxDQUFDLENBQUM7WUFDL0IsQ0FBQztZQUNELElBQUksQ0FBQyxlQUFlLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDM0IsT0FBTztRQUNULENBQUM7UUFFRCxzQ0FBc0M7UUFDdEMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUM3QixDQUFDO0lBRUQsS0FBSyxDQUFDLFNBQVM7UUFDYixNQUFNLE9BQU8sR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDO1FBQzdCLE1BQU0sQ0FDSixDQUFDLENBQUMsT0FBTyxDQUFDLE1BQU0sSUFBSSxPQUFPLENBQUMsT0FBTyxDQUFDLEVBQ3BDLHdCQUF3QixJQUFJLENBQUMsSUFBSSxzREFBc0QsQ0FDeEYsQ0FBQztRQUVGLHFFQUFxRTtRQUNyRSxJQUFJLE9BQU8sQ0FBQyxNQUFNLEVBQUUsQ0FBQztZQUNuQixNQUFNLE1BQU0sR0FBRyxNQUFNLElBQUksQ0FBQyxtQkFBbUIsQ0FBQyxPQUFPLENBQUMsTUFBTSxFQUFFLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQztZQUM1RSxJQUFJLENBQUMsZUFBZSxDQUFDLE1BQU0sQ0FBQyxDQUFDO1lBQzdCLElBQUksQ0FBQyxxQkFBcUIsQ0FBQyxNQUFNLENBQUMsQ0FBQztZQUNuQyxPQUFPO1FBQ1QsQ0FBQztRQUVELDhDQUE4QztRQUM5QyxJQUFJLE9BQU8sQ0FBQyxPQUFPLEVBQUUsQ0FBQztZQUNwQixNQUFNLE9BQU8sQ0FBQyxHQUFHLENBQ2YsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsRUFBVSxFQUFFLEVBQUU7Z0JBQzlDLE9BQU8sSUFBSSxDQUFDLG1CQUFtQixDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLEVBQUUsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsRUFBRSxFQUFFLE1BQU0sQ0FBQyxDQUFDLENBQUM7WUFDeEcsQ0FBQyxDQUFDLENBQ0gsQ0FBQztZQUNGLElBQUksQ0FBQyxlQUFlLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDM0IsT0FBTztRQUNULENBQUM7UUFFRCxzQ0FBc0M7UUFDdEMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUM3QixDQUFDO0lBRUQsZUFBZSxDQUFDLE1BQWU7UUFDN0IsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLElBQUksQ0FBQyxJQUFJLEVBQUUsTUFBTSxDQUFDLENBQUM7SUFDM0MsQ0FBQztJQUVEOztPQUVHO0lBQ0gsR0FBRyxDQUFDLEVBQVU7UUFDWixPQUFPLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBTSxDQUFDO0lBQ25DLENBQUM7SUFFRDs7T0FFRztJQUNILG9CQUFvQixDQUFDLEVBQVU7UUFDN0IsT0FBTyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQU0sQ0FBQztJQUNuQyxDQUFDO0lBRUQsY0FBYyxDQUFDLE1BQTJCLEVBQUUsVUFBa0I7UUFDNUQsaURBQWlEO1FBQ2pELE1BQU0sQ0FDSixDQUFDLGVBQWUsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLEVBQzdCLHdCQUF3QixJQUFJLENBQUMsSUFBSSxxRUFBcUUsQ0FDdkcsQ0FBQztRQUNGLDBEQUEwRDtRQUMxRCxNQUFNLEdBQUc7WUFDUCxHQUFHLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTztZQUN2QixHQUFHLE1BQU07U0FDVixDQUFDO1FBQ0YsT0FBUSxJQUFJLENBQUMsTUFBZ0MsQ0FBQyxNQUFNLEVBQUUsSUFBSSxDQUFDLEdBQUcsRUFBRSxVQUFVLENBQU0sQ0FBQztJQUNuRixDQUFDO0lBRUQsS0FBSyxDQUFDLG1CQUFtQixDQUFDLE1BQTJCLEVBQUUsVUFBa0I7UUFDdkUsMERBQTBEO1FBQzFELE1BQU0sR0FBRztZQUNQLEdBQUcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPO1lBQ3ZCLEdBQUcsTUFBTTtTQUNWLENBQUM7UUFDRixPQUFPLENBQUMsTUFBTSxJQUFJLENBQUMsTUFBTSxDQUFDLE1BQU0sRUFBRSxJQUFJLENBQUMsR0FBRyxFQUFFLFVBQVUsQ0FBQyxDQUFNLENBQUM7SUFDaEUsQ0FBQztJQUVELHFCQUFxQixDQUFDLE1BQVc7UUFDL0IsTUFBTSxDQUFDLENBQUMsTUFBTSxDQUFDLGNBQWMsRUFBRSwrRUFBK0UsQ0FBQyxDQUFDO1FBQ2hILE1BQU0sQ0FDSixDQUFDLE1BQU0sQ0FBQyxtQkFBbUIsRUFDM0Isb0ZBQW9GLENBQ3JGLENBQUM7UUFFRixJQUFJLENBQUM7WUFDSCxJQUFJLFVBQVUsR0FBRyxNQUFNLENBQUM7WUFDeEIsZ0RBQWdEO1lBQ2hELElBQUksQ0FBQyxNQUFNLENBQUMsWUFBWSxDQUFDLE1BQU0sQ0FBQyxJQUFJLE1BQU0sQ0FBQyxRQUFRLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQztnQkFDNUQsb0NBQW9DO2dCQUNwQyxVQUFVLEdBQUcsTUFBTSxDQUFDLFNBQVMsSUFBSSxNQUFNLENBQUM7WUFDMUMsQ0FBQztZQUNELFVBQVUsQ0FBQyxjQUFjLEdBQUcsSUFBSSxDQUFDLGNBQWMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDM0QsVUFBVSxDQUFDLG1CQUFtQixHQUFHLElBQUksQ0FBQyxtQkFBbUIsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDdkUsQ0FBQztRQUFDLE9BQU8sR0FBRyxFQUFFLENBQUM7WUFDYixJQUFJLENBQUMsR0FBRyxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQ3RCLHVGQUF1RixFQUN2RixJQUFJLENBQUMsSUFBSSxDQUNWLENBQUM7WUFDRixJQUFJLENBQUMsR0FBRyxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUM7UUFDaEMsQ0FBQztJQUNILENBQUM7Q0FDRiJ9

package/dist/types.d.ts

@@ -0,0 +1,53 @@
+export interface EggAppInfo {
+    /** package.json */
+    pkg: Record<string, any>;
+    /** the application name from package.json */
+    name: string;
+    /** current directory of application */
+    baseDir: string;
+    /** equals to serverEnv */
+    env: string;
+    /** equals to serverScope */
+    scope: string;
+    /** home directory of the OS */
+    HOME: string;
+    /** baseDir when local and unittest, HOME when other environment */
+    root: string;
+}
+export interface EggPluginInfo {
+    /** the plugin name, it can be used in `dep` */
+    name: string;
+    /** the package name of plugin */
+    package?: string;
+    version?: string;
+    /** whether enabled */
+    enable: boolean;
+    implicitEnable?: 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[];
+    dependents?: string[];
+    /** specify the serverEnv that only enable the plugin in it */
+    env: string[];
+    /** the file plugin config in. */
+    from: string;
+}
+export interface CustomLoaderConfigItem {
+    /** the directory of the custom loader */
+    directory: string;
+    /** the inject object, it can be app or ctx */
+    inject: string;
+    /** whether load unit files */
+    loadunit?: boolean;
+}
+export interface EggAppConfig extends Record<string, any> {
+    coreMiddleware: string[];
+    middleware: string[];
+    customLoader?: Record<string, CustomLoaderConfigItem>;
+    controller?: {
+        supportParams?: boolean;
+    };
+}

package/dist/types.js

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

package/dist/utils/index.d.ts

@@ -0,0 +1,17 @@
+export type Fun = (...args: unknown[]) => unknown;
+declare function getCalleeFromStack(withLine?: boolean, stackIndex?: number): string;
+declare const _default: {
+    deprecated(message: string): void;
+    extensions: any;
+    extensionNames: string[];
+    existsPath(filepath: string): Promise<boolean>;
+    loadFile(filepath: string): Promise<any>;
+    resolvePath(filepath: string, options?: {
+        paths?: string[];
+    }): string;
+    methods: string[];
+    callFn(fn: Fun, args?: unknown[], ctx?: unknown): Promise<unknown>;
+    getCalleeFromStack: typeof getCalleeFromStack;
+    getResolvedFilename(filepath: string, baseDir: string): string;
+};
+export default _default;