@adaptivestone/framework 5.0.0-beta.10 → 5.0.0-beta.11

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 5.0.0-beta.11
+
+[NEW] commands typing
+[NEW] commands support TS files
+[UPDATE] update deps
+
 ### 5.0.0-beta.9
 
 [BREAKING] move email module to separate package @adaptivestone/framework-module-email. Please use it if you want to send emails

package/controllers/index.js

@@ -22,8 +22,14 @@ class ControllerManager extends Base {
     );
 
     controllersToLoad.sort((a, b) => {
-      if (a.file.toLowerCase().endsWith('index.js')) {
-        if (b.file.toLowerCase().endsWith('index.js')) {
+      if (
+        a.file.toLowerCase().endsWith('index.js') ||
+        a.file.toLowerCase().endsWith('index.ts')
+      ) {
+        if (
+          b.file.toLowerCase().endsWith('index.js') ||
+          b.file.toLowerCase().endsWith('index.ts')
+        ) {
           return 0;
         }
         return -1;

package/helpers/files.js

@@ -23,7 +23,7 @@ const getFilesPathWithInheritance = async ({
       // not start with capital
       return false;
     }
-    if (notTests && file.endsWith('.test.js')) {
+    if (notTests && (file.endsWith('.test.js') || file.endsWith('.test.ts'))) {
       return false;
     }
     if (notHidden && file[0] === '.') {

package/modules/AbstractCommand.d.ts

@@ -0,0 +1,50 @@
+import type Base from './Base.js';
+import type { ICommandArguments } from '../types/ICommandArguments.d.ts';
+
+abstract class AbstractCommand extends Base {
+  constructor(
+    app: Server['app'],
+    commands: { [key: string]: string },
+    args: {
+      [longOption: string]:
+        | undefined
+        | string
+        | boolean
+        | Array<string | boolean>;
+    },
+  );
+
+  static get description(): string;
+  /**
+   * If true, then this command will load models and init mongo connection
+   */
+  static isShouldInitModels = true;
+
+  /**
+   * Get mongo connection name
+   */
+  static getMongoConnectionName(
+    commandName: string,
+    args: {
+      [longOption: string]:
+        | undefined
+        | string
+        | boolean
+        | Array<string | boolean>;
+    },
+  ): string;
+
+  /**
+   * You able to add command arguments for parsing there.
+   * @see https://nodejs.org/api/util.html#utilparseargsconfig in config.options plus extended with description and required
+   * @returns {import("../types/ICommandArguments.d.ts").ICommandArguments}
+   */
+  static get commandArguments(): ICommandArguments;
+
+  /**
+   * Entry point to every command. This method should be overridden
+   */
+  async run(): Promise<boolean | unknown>;
+}
+
+export default AbstractCommand;

package/modules/AbstractCommand.js

@@ -29,7 +29,7 @@ class AbstractCommand extends Base {
   /**
    * You able to add command arguments for parsing there.
    * @see https://nodejs.org/api/util.html#utilparseargsconfig in config.options plus extended with description and required
-   * @returns {import("../types/ICommandArguments.js").ICommandArguments}
+   * @returns {import("../types/ICommandArguments.d.ts").ICommandArguments}
    */
   static get commandArguments() {
     return {};

package/modules/AbstractController.d.ts

@@ -0,0 +1,55 @@
+import type { Router } from 'express';
+import type Base from './Base.js';
+
+type TMiddleware = Array<Function | Array<Function, Array<any>>>;
+
+class AbstractController extends Base {
+  prefix: string;
+  router: Router;
+  constructor(app: Server['app'], prefix: string, isExpressMergeParams = false);
+
+  /**
+   * Parse middlewares to be an object.
+   */
+  parseMiddlewares(
+    middlewareMap: Map<string, TMiddleware>,
+    httpPath: string,
+  ): Array<{
+    name: string;
+    method: string;
+    path: string;
+    fullPath: string;
+    params: Array<any>;
+    relatedQueryParameters?: any;
+    authParams?: any;
+    MiddlewareFunction: Function;
+  }>;
+
+  get routes(): {
+    [method: string]: {
+      [path: string]: {
+        handler: Function;
+        middleware?: TMiddleware;
+        request?: any;
+        query?: any;
+      };
+    };
+  };
+
+  /**
+   * Array of middlewares to append for route
+   * You should provide path relative to controller and then array of middlewares to apply.
+   * Order is matter.
+   * Be default path apply to ANY' method, but you can preattach 'METHOD' into patch to scope patch to this METHOD
+   */
+  static get middleware(): Map<string, TMiddleware>;
+
+  getConstructorName(): string;
+
+  /**
+   * Get http path with inheritance of path
+   */
+  getHttpPath(): string;
+}
+
+export default AbstractController;

package/modules/AbstractController.js

@@ -13,6 +13,9 @@ import DocumentationGenerator from '../services/documentation/DocumentationGener
  * In most cases you will want to have a 'home' route that not include controller name. For this case please check '  getHttpPath'
  */
 class AbstractController extends Base {
+  prefix = '';
+  router = null;
+
   constructor(app, prefix, isExpressMergeParams = false) {
     const time = Date.now();
     super(app);
@@ -21,16 +24,7 @@ class AbstractController extends Base {
       mergeParams: isExpressMergeParams,
     });
     const { routes } = this;
-    let httpPath = this.getHttpPath();
-
-    // @ts-ignore
-    if (this.getExpressPath) {
-      this.logger.warn(
-        `getExpressPath deprecated. Please use getHttpPath instead. Will be removed on v5`,
-      );
-      // @ts-ignore
-      httpPath = this.getExpressPath();
-    }
+    const httpPath = this.getHttpPath();
 
     /**
      * Grab route middleware onlo one Map

package/modules/AbstractModel.d.ts

@@ -2,7 +2,7 @@ import type Base from './Base.js';
 import { Model, Schema } from 'mongoose';
 import type Server from '../server.js';
 
-interface AbstractModel<T extends Document> extends Model, Base {
+interface AbstractModel<T extends Document = Document> extends Model, Base {
   constructor(app: Server['app'], callback?: () => void);
 
   /**
@@ -31,7 +31,7 @@ interface AbstractModel<T extends Document> extends Model, Base {
   initHooks(): void;
 }
 
-abstract class AbstractModel<T extends Document>
+abstract class AbstractModel<T extends Document = Document>
   extends Model
   implements AbstractModel
 {

package/modules/BaseCli.js

@@ -20,9 +20,14 @@ class Cli extends Base {
       this.server.app.foldersConfig.commands,
     );
     for (const com of commandsToLoad) {
-      if (com.file.endsWith('.js')) {
-        const c = com.file.replace('.js', '');
-
+      if (com.file.endsWith('.js') || com.file.endsWith('.ts')) {
+        const c = com.file.replace('.js', '').replace('.ts', '');
+        if (this.commands[c.toLowerCase()]) {
+          this.logger.warn(
+            `Command ${c.toLowerCase()} already exists with full path ${this.commands[c.toLowerCase()]}. Possible problems - you have two commands with "ts" and "js" extensions. Skipping...`,
+          );
+          continue;
+        }
         this.commands[c.toLowerCase()] = com.path;
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "5.0.0-beta.10",
+  "version": "5.0.0-beta.11",
   "description": "Adaptive stone node js framework",
   "main": "index.js",
   "type": "module",