@eggjs/core 6.4.1 → 6.6.0-beta.10

package/README.md

@@ -1,16 +1,12 @@
 # @eggjs/core
 
 [![NPM version][npm-image]][npm-url]
-[![Node.js CI](https://github.com/eggjs/core/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/core/actions/workflows/nodejs.yml)
-[![Test coverage][codecov-image]][codecov-url]
 [![Known Vulnerabilities][snyk-image]][snyk-url]
 [![npm download][download-image]][download-url]
 [![Node.js Version](https://img.shields.io/node/v/@eggjs/core.svg?style=flat)](https://nodejs.org/en/download/)
 
 [npm-image]: https://img.shields.io/npm/v/@eggjs/core.svg?style=flat-square
 [npm-url]: https://npmjs.org/package/@eggjs/core
-[codecov-image]: https://codecov.io/github/eggjs/core/coverage.svg?branch=master
-[codecov-url]: https://codecov.io/github/eggjs/core?branch=master
 [snyk-image]: https://snyk.io/test/npm/@eggjs/core/badge.svg?style=flat-square
 [snyk-url]: https://snyk.io/test/npm/@eggjs/core
 [download-image]: https://img.shields.io/npm/dm/@eggjs/core.svg?style=flat-square
@@ -62,7 +58,7 @@ Then you can start with code below
 import { EggCore as Application } from '@eggjs/core';
 
 const app = new Application({
-  baseDir: '/path/to/app'
+  baseDir: '/path/to/app',
 });
 app.ready(() => {
   app.listen(3000);
@@ -140,13 +136,13 @@ Load app/service
 Retrieve application environment variable values via `serverEnv`.
 You can access directly by calling `this.serverEnv` after instantiation.
 
-serverEnv | description
----       | ---
-default   | default environment
-test      | system integration testing environment
-prod      | production environment
-local     | local environment on your own computer
-unittest  | unit test environment
+| serverEnv | description                            |
+| --------- | -------------------------------------- |
+| default   | default environment                    |
+| test      | system integration testing environment |
+| prod      | production environment                 |
+| local     | local environment on your own computer |
+| unittest  | unit test environment                  |
 
 #### getEggPaths()
 
@@ -163,7 +159,7 @@ This function will get add loadUnits follow the order:
 2. framework
 3. app
 
-loadUnit has a path and a type. Type must be one of those values: *app*, *framework*, *plugin*.
+loadUnit has a path and a type. Type must be one of those values: _app_, _framework_, _plugin_.
 
 ```js
 {
@@ -174,7 +170,7 @@ loadUnit has a path and a type. Type must be one of those values: *app*, *framew
 
 #### getAppname()
 
-To get application name from *package.json*
+To get application name from _package.json_
 
 #### appInfo
 
@@ -228,18 +224,18 @@ await this.loadExtend('application', app);
 
 ### LoaderOptions
 
-Param          | Type           | Description
--------------- | -------------- | ------------------------
-directory      | `String/Array` | directories to be loaded
-target         | `Object`       | attach the target object from loaded files
-match          | `String/Array` | match the files when load, default to `**/*.js`(if process.env.EGG_TYPESCRIPT was true, default to `[ '**/*.(js|ts)', '!**/*.d.ts' ]`)
-ignore         | `String/Array` | ignore the files when load
-initializer    | `Function`     | 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`
-caseStyle      | `String/Function` | set property's case when converting a filepath to property list.
-override       | `Boolean`      | determine whether override the property when get the same name
-call           | `Boolean`      | determine whether invoke when exports is function
-inject         | `Object`       | an object that be the argument when invoke the function
-filter         | `Function`     | a function that filter the exports which can be loaded
+| Param       | Type              | Description                                                                                                                                                        |
+| ----------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------- |
+| directory   | `String/Array`    | directories to be loaded                                                                                                                                           |
+| target      | `Object`          | attach the target object from loaded files                                                                                                                         |
+| match       | `String/Array`    | match the files when load, default to `**/*.js`(if process.env.EGG\*TYPESCRIPT was true, default to `[ '\*\*/\_.(js                                                | ts)', '!\*_/_.d.ts' ]`) |
+| ignore      | `String/Array`    | ignore the files when load                                                                                                                                         |
+| initializer | `Function`        | 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` |
+| caseStyle   | `String/Function` | set property's case when converting a filepath to property list.                                                                                                   |
+| override    | `Boolean`         | determine whether override the property when get the same name                                                                                                     |
+| call        | `Boolean`         | determine whether invoke when exports is function                                                                                                                  |
+| inject      | `Object`          | an object that be the argument when invoke the function                                                                                                            |
+| filter      | `Function`        | a function that filter the exports which can be loaded                                                                                                             |
 
 ## Timing
 
@@ -285,7 +281,7 @@ Please open an issue [here](https://github.com/eggjs/egg/issues).
 
 ## Contributors
 
-[![Contributors](https://contrib.rocks/image?repo=eggjs/core)](https://github.com/eggjs/core/graphs/contributors)
+[![Contributors](https://contrib.rocks/image?repo=eggjs/egg)](https://github.com/eggjs/egg/graphs/contributors)
 
 Made with [contributors-img](https://contrib.rocks).
 

package/dist/base_context_class.d.ts

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

package/dist/base_context_class.js

@@ -0,0 +1,40 @@
+//#region src/base_context_class.ts
+/**
+* BaseContextClass is a base class that can be extended,
+* it's instantiated in context level,
+* {@link Helper}, {@link Service} is extending it.
+*/
+var BaseContextClass = class {
+	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;
+	}
+};
+
+//#endregion
+export { BaseContextClass };

package/dist/egg.d.ts

@@ -0,0 +1,248 @@
+import { Fun } from "./utils/index.js";
+import { EggAppConfig, EggPluginInfo } from "./types.js";
+import { BaseContextClass } from "./base_context_class.js";
+import { Timing } from "./utils/timing.js";
+import { Lifecycle } from "./lifecycle.js";
+import { EggLoader } from "./loader/egg_loader.js";
+import { SingletonCreateMethod } from "./singleton.js";
+import { Application as KoaApplication, Context as KoaContext, MiddlewareFunc as KoaMiddlewareFunc, Next, Request as KoaRequest, Response as KoaResponse } from "@eggjs/koa";
+import { EggConsoleLogger, Logger } from "egg-logger";
+import { EggRouter as Router, RegisterOptions, ResourcesController } from "@eggjs/router";
+import { ReadyFunctionArg } from "get-ready";
+
+//#region src/egg.d.ts
+declare const EGG_LOADER: unique symbol;
+interface EggCoreOptions {
+  baseDir: string;
+  type: 'application' | 'agent';
+  plugins?: any;
+  serverScope?: string;
+  env?: string;
+}
+type EggCoreInitOptions = Partial<EggCoreOptions>;
+declare class Request$1 extends KoaRequest {
+  app: EggCore;
+  response: Response$1;
+}
+declare class Response$1 extends KoaResponse {
+  app: EggCore;
+  request: Request$1;
+}
+declare class Context$1 extends KoaContext {
+  app: EggCore;
+  request: Request$1;
+  response: Response$1;
+  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;
+}
+type MiddlewareFunc<T extends KoaContext = Context$1> = KoaMiddlewareFunc<T>;
+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: unknown, app: EggCore) => MiddlewareFunc>;
+  /**
+   * @class
+   * @param {Object} options - options
+   * @param {String} [options.baseDir] - the directory of application
+   * @param {String} [options.type] - 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<T extends KoaContext = Context$1>(fn: MiddlewareFunc<T>): 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, 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
+   * @returns {Function} - a callback
+   * @example
+   * const done = app.readyCallback('mysql');
+   * mysql.ready(done);
+   */
+  readyCallback(name: string, opts: object): (...args: unknown[]) => 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.
+   * @returns {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
+   * @returns {String} url
+   */
+  url(name: string, params?: Parameters<Router['url']>[1]): 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;
+}
+//#endregion
+export { Context$1 as Context, EGG_LOADER, EggCore, EggCoreInitOptions, EggCoreOptions, KoaApplication, KoaContext, type KoaMiddlewareFunc, KoaRequest, KoaResponse, MiddlewareFunc, type Next, Request$1 as Request, Response$1 as Response, Router };