@eggjs/core 6.2.0 → 6.2.2

package/src/egg.ts

@@ -1,8 +1,15 @@
 /* eslint-disable prefer-spread */
 import assert from 'node:assert';
 import { debuglog } from 'node:util';
-import { Application as KoaApplication } from '@eggjs/koa';
-import type { ContextDelegation, MiddlewareFunc } from '@eggjs/koa';
+import {
+  Application as KoaApplication, Context as KoaContext,
+  Request as KoaRequest, Response as KoaResponse,
+} from '@eggjs/koa';
+import type {
+  ContextDelegation as KoaContextDelegation,
+  MiddlewareFunc as KoaMiddlewareFunc,
+  Next,
+} from '@eggjs/koa';
 import { EggConsoleLogger } from 'egg-logger';
 import { RegisterOptions, ResourcesController, EggRouter as Router } from '@eggjs/router';
 import type { ReadyFunctionArg } from 'get-ready';
@@ -15,7 +22,7 @@ import utils from './utils/index.js';
 
 const debug = debuglog('@eggjs/core:egg');
 
-const EGG_LOADER = Symbol.for('egg#loader');
+export const EGG_LOADER = Symbol.for('egg#loader');
 
 export interface EggCoreOptions {
   baseDir: string;
@@ -27,12 +34,40 @@ export interface EggCoreOptions {
 
 export type EggCoreInitOptions = Partial<EggCoreOptions>;
 
-export type { ContextDelegation, MiddlewareFunc, Next } from '@eggjs/koa';
+// export @eggjs/koa classes
+export {
+  KoaRequest, KoaResponse, KoaContext, KoaApplication,
+};
+
+// export @eggjs/koa types
+export type {
+  Next, KoaMiddlewareFunc, KoaContextDelegation,
+};
+
+// export @eggjs/core classes
+export class Request extends KoaRequest {
+  declare app: EggCore;
+  declare response: Response;
+  declare ctx: ContextDelegation;
+}
+
+export class Response extends KoaResponse {
+  declare app: EggCore;
+  declare request: Request;
+  declare ctx: ContextDelegation;
+}
 
-export interface EggCoreContext extends ContextDelegation {
-  app: EggCore;
+export class Context extends KoaContext {
+  declare app: EggCore;
+  declare request: Request;
+  declare response: Response;
+  declare service: BaseContextClass;
 }
 
+// export @eggjs/core types
+export type ContextDelegation = KoaContextDelegation & Context;
+export type MiddlewareFunc<T extends ContextDelegation = ContextDelegation> = KoaMiddlewareFunc<T>;
+
 export class EggCore extends KoaApplication {
   options: EggCoreOptions;
   timing: Timing;
@@ -159,7 +194,7 @@ export class EggCore extends KoaApplication {
   use(fn: MiddlewareFunc) {
     assert(typeof fn === 'function', 'app.use() requires a function');
     debug('[use] add middleware: %o', fn._name || fn.name || '-');
-    this.middleware.push(fn);
+    this.middleware.push(fn as unknown as KoaMiddlewareFunc);
     return this;
   }
 
@@ -229,11 +264,11 @@ export class EggCore extends KoaApplication {
    *
    * @see https://eggjs.org/en/advanced/loader.html#beforestart
    *
-   * @param  {Function|AsyncFunction} scope function will execute before app start
+   * @param  {Function} scope function will execute before app start
    * @param {string} [name] scope name, default is empty string
    */
   beforeStart(scope: Fun, name?: string) {
-    this.deprecate('Please use "Life Cycles" instead, see https://www.eggjs.org/advanced/loader#life-cycles');
+    this.deprecate('`beforeStart` was deprecated, please use "Life Cycles" instead, see https://www.eggjs.org/advanced/loader#life-cycles');
     this.lifecycle.registerBeforeStart(scope, name ?? '');
   }
 
@@ -276,7 +311,7 @@ export class EggCore extends KoaApplication {
    * mysql.ready(done);
    */
   readyCallback(name: string, opts: object) {
-    this.deprecate('Please use "Life Cycles" instead, see https://www.eggjs.org/advanced/loader#life-cycles');
+    this.deprecate('`readyCallback` was deprecated, please use "Life Cycles" instead, see https://www.eggjs.org/advanced/loader#life-cycles');
     return this.lifecycle.legacyReadyCallback(name, opts);
   }
 
@@ -293,7 +328,7 @@ export class EggCore extends KoaApplication {
    * @param {Function} fn - the function that can be generator function or async function.
    */
   beforeClose(fn: Fun) {
-    this.deprecate('Please use "Life Cycles" instead, see https://www.eggjs.org/advanced/loader#life-cycles');
+    this.deprecate('`beforeClose` was deprecated, please use "Life Cycles" instead, see https://www.eggjs.org/advanced/loader#life-cycles');
     this.lifecycle.registerBeforeClose(fn);
   }
 

package/src/loader/context_loader.ts

@@ -1,7 +1,7 @@
 import assert from 'node:assert';
-import { type ContextDelegation } from '@eggjs/koa';
 import { isClass, isPrimitive } from 'is-type-of';
 import { FileLoader, EXPORTS, type FileLoaderOptions } from './file_loader.js';
+import type { ContextDelegation } from '../egg.js';
 
 const CLASS_LOADER = Symbol('classLoader');
 

package/src/loader/egg_loader.ts

@@ -15,10 +15,10 @@ import { ContextLoader, ContextLoaderOptions } from './context_loader.js';
 import utils, { Fun } from '../utils/index.js';
 import sequencify from '../utils/sequencify.js';
 import { Timing } from '../utils/timing.js';
-import type { EggCoreContext, EggCore, MiddlewareFunc } from '../egg.js';
+import type { ContextDelegation, EggCore, MiddlewareFunc } from '../egg.js';
 import { BaseContextClass } from '../base_context_class.js';
 
-const debug = debuglog('@eggjs/core:egg_loader');
+const debug = debuglog('@eggjs/core/loader/egg_loader');
 
 const originalPrototypes: Record<string, any> = {
   request: Request.prototype,
@@ -1064,7 +1064,7 @@ export class EggLoader {
     for (const rawFilepath of filepaths) {
       const filepath = this.resolveModule(rawFilepath)!;
       if (!filepath) {
-        debug('loadExtend %o not found', rawFilepath);
+        // debug('loadExtend %o not found', rawFilepath);
         continue;
       }
       if (filepath.endsWith('/index.js')) {
@@ -1073,9 +1073,14 @@ export class EggLoader {
         this.app.deprecate(`app/extend/${name}/index.ts is deprecated, use app/extend/${name}.ts instead`);
       }
 
-      const ext = await this.requireFile(filepath);
+      let ext = await this.requireFile(filepath);
+      // if extend object is Class, should use Class.prototype instead
+      if (isClass(ext)) {
+        ext = ext.prototype;
+      }
       const properties = Object.getOwnPropertyNames(ext)
-        .concat(Object.getOwnPropertySymbols(ext) as any[]);
+        .concat(Object.getOwnPropertySymbols(ext) as any[])
+        .filter(name => name !== 'constructor'); // ignore class constructor for extend
 
       for (const property of properties) {
         if (mergeRecord.has(property)) {
@@ -1108,7 +1113,7 @@ export class EggLoader {
         Object.defineProperty(proto, property, descriptor!);
         mergeRecord.set(property, filepath);
       }
-      debug('merge %j to %s from %s', Object.keys(ext), name, filepath);
+      debug('merge %j to %s from %s', properties, name, filepath);
     }
     this.timing.end(`Load extend/${name}.js`);
   }
@@ -1682,7 +1687,7 @@ function wrapControllerClass(Controller: typeof BaseContextClass, fullPath: stri
 }
 
 function controllerMethodToMiddleware(Controller: typeof BaseContextClass, key: string) {
-  return function classControllerMiddleware(this: EggCoreContext, ...args: any[]) {
+  return function classControllerMiddleware(this: ContextDelegation, ...args: any[]) {
     const controller: any = new Controller(this);
     if (!this.app.config.controller?.supportParams) {
       args = [ this ];
@@ -1718,7 +1723,7 @@ function wrapObject(obj: Record<string, any>, fullPath: string, prefix?: string)
 }
 
 function objectFunctionToMiddleware(func: Fun) {
-  async function objectControllerMiddleware(this: EggCoreContext, ...args: any[]) {
+  async function objectControllerMiddleware(this: ContextDelegation, ...args: any[]) {
     if (!this.app.config.controller?.supportParams) {
       args = [ this ];
     }