fix: change non-exports type to interface (#206)

Author: whxaxes

index.d.ts

@@ -53,7 +53,7 @@ export interface PluginInfo {
 
 export interface Plugins extends PlainObject<PluginInfo> { }
 
-export class EggCore<Config = PlainObject> extends KoaApplication {
+export interface EggCoreBase<Config> extends KoaApplication {
   /**
    * Whether `application` or `agent`
    * @member {String}
@@ -77,16 +77,6 @@ export class EggCore<Config = PlainObject> extends KoaApplication {
    */
   name: EggAppInfo['name'];
 
-  /**
-   * @constructor
-   * @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?: EggCoreOptions);
-
   /**
    * Convert a generator function to a promisable one.
    *
@@ -207,11 +197,25 @@ export class EggCore<Config = PlainObject> extends KoaApplication {
    * @since 1.0.0
    */
   deprecate: depd.Deprecate;
+}
 
+export interface EggCore<Config = PlainObject> extends EggCoreBase<Config> {
   Controller: typeof BaseContextClass;
   Service: typeof BaseContextClass;
 }
 
+export class EggCore {
+   /**
+   * @constructor
+   * @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?: EggCoreOptions);
+}
+
 /**
  * egg app info
  * @example
@@ -301,13 +305,7 @@ export interface ContextLoaderOption extends Partial<FileLoaderOption> {
   fieldClass?: string;
 }
 
-declare class FileLoader {
-  /**
-   * Load files from directory to target object.
-   * @since 1.0.0
-   */
-  constructor(options: FileLoaderOption);
-
+declare interface FileLoaderBase {
   /**
    * attach items to target object. Mapping the directory to properties.
    * `app/controller/group/repository.js` => `target.group.repository`
@@ -345,13 +343,23 @@ declare class FileLoader {
   parse(): Array<{ fullpath: string; properties: string[]; exports: any; }>;
 }
 
-declare class ContextLoader extends FileLoader {
+declare interface ContextLoaderBase extends FileLoaderBase {}
+
+export interface FileLoader {
+  /**
+   * Load files from directory to target object.
+   * @since 1.0.0
+   */
+  new (options: FileLoaderOption): FileLoaderBase;
+}
+
+export interface ContextLoader {
   /**
    * Same as {@link FileLoader}, but it will attach file to `inject[fieldClass]`. The exports will be lazy loaded, such as `ctx.group.repository`.
    * @extends FileLoader
    * @since 1.0.0
    */
-  constructor(options: ContextLoaderOption);
+  new (options: ContextLoaderOption): ContextLoaderBase;
 }
 
 export class EggLoader<T = EggCore, Config = any> {
@@ -442,8 +450,8 @@ export class EggLoader<T = EggCore, Config = any> {
   getTypeFiles(filename: string): string[];
   resolveModule(filepath: string): string | undefined;
 
-  FileLoader: typeof FileLoader;
-  ContextLoader: typeof ContextLoader;
+  FileLoader: FileLoader;
+  ContextLoader: ContextLoader;
 
   // load methods
   protected loadConfig(): void;

test/egg-ts.test.js

@@ -148,7 +148,7 @@ describe('test/egg-ts.test.js', () => {
           TS_NODE_PROJECT: path.resolve(__dirname, './fixtures/app-ts/tsconfig.json'),
         }),
       })
-      .debug()
+      // .debug()
       .expect('code', 0)
       .end();
   });
@@ -160,7 +160,7 @@ describe('test/egg-ts.test.js', () => {
           TS_NODE_PROJECT: path.resolve(__dirname, './fixtures/app-ts/tsconfig.json'),
         }),
       })
-      .debug()
+      // .debug()
       .expect('stderr', /Property 'abb' does not exist on type 'EggCore<{ env: string; }>'/)
       .expect('stderr', /Property 'abc' does not exist on type 'typeof BaseContextClass'/)
       .expect('stderr', /'loadPlugin' is protected/)
@@ -174,6 +174,7 @@ describe('test/egg-ts.test.js', () => {
       .expect('stderr', /'loadCustomAgent' is protected/)
       .expect('stderr', /'loadService' is protected/)
       .expect('stderr', /'loadController' is protected/)
+      .expect('stderr', /Property 'checkEnvType' does not exist on type 'string'/)
       .expect('stderr', /'ctx' is protected/)
       .expect('code', 1)
       .end();

test/fixtures/app-ts/app-error.ts

@@ -5,6 +5,9 @@ const app = new EggCore<{ env: string }>();
 console.info(app.abb);
 console.info(app.Controller.abc);
 console.info(app.Service.bbc);
+console.info(app.config.env);
+console.info(app.config.env.substring(0));
+console.info(app.config.env.checkEnvType());
 app.loader.loadPlugin();
 app.loader.loadConfig();
 app.loader.loadApplicationExtend();

test/fixtures/app-ts/app.ts

@@ -2,7 +2,7 @@ import * as assert from 'assert';
 import * as path from 'path';
 const EGG_LOADER = Symbol.for('egg#loader');
 const EGG_PATH = Symbol.for('egg#eggPath');
-import { BaseContextClass, EggCore, EggLoader, EggLoaderOptions } from '../../..';
+import { BaseContextClass, EggCore, EggCoreOptions, EggLoader, EggLoaderOptions } from '../../..';
 
 // normal
 const app = new EggCore<{ env: string }>();
@@ -15,6 +15,27 @@ assert(app.loader.app === app);
 assert(app.loader.eggPaths.length === 0);
 assert(app.type);
 
+// custom egg core
+class CustomEggCore extends EggCore {
+  constructor(options: EggCoreOptions) {
+    super(options);
+  }
+
+  get [EGG_PATH]() {
+    return __dirname;
+  }
+
+  customFn() {
+    console.info(this.config);
+  }
+}
+const customApp = new CustomEggCore({ baseDir: undefined });
+customApp.customFn();
+assert(customApp.Controller);
+assert(customApp.Service);
+assert(customApp.loader.ContextLoader);
+assert(customApp.loader.FileLoader);
+
 // base class
 new BaseContextClass({ app: {} });
 
@@ -121,6 +142,27 @@ new FileLoader({
 assert(app6.Dao.TestClass);
 assert(app6.Dao.TestFunction);
 
+// custom file loader
+const app9 = {} as any;
+class CustomFileLoader extends FileLoader {
+  test() {
+    assert(this.load);
+    assert(this.parse);
+  }
+}
+new CustomFileLoader({
+  directory: path.join(__dirname, '../load_dirs'),
+  target: app9,
+  match: [ 'dao/*' ],
+  caseStyle: 'upper',
+  filter(obj) { return !!obj; },
+  initializer(obj, options) {
+    assert(options.path);
+    assert(options.pathName);
+    return obj;
+  },
+}).test();
+
 // context loader
 const ContextLoader = loader.ContextLoader;
 const app7 = { context: {} } as any;
@@ -142,3 +184,27 @@ assert(app7.ass.Dao.TestClass);
 assert(app7.ass.Dao.TestFunction);
 assert(app7.context.kick.Dao.TestClass);
 assert(app7.context.kick.Dao.TestFunction);
+
+
+// custom context loader
+const app8 = { context: {} } as any;
+class CustomContextLoader extends ContextLoader {
+  test() {
+    this.load();
+    assert(this.parse);
+  }
+}
+new CustomContextLoader({
+  directory: path.join(__dirname, '../load_dirs'),
+  property: 'kick',
+  fieldClass: 'ass',
+  inject: app8,
+  match: [ 'dao/*' ],
+  caseStyle: 'upper',
+  filter(obj) { return !!obj; },
+  initializer(obj, options) {
+    assert(options.path);
+    assert(options.pathName);
+    return obj;
+  },
+}).test();