@adaptivestone/framework 5.0.0-alpha.5 → 5.0.0-alpha.6

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 5.0.0-alpha.6
+
+[UPDATE] Update internal documentation (jsdoc, d.ts)
+
 ### 5.0.0-alpha.5
 
 [UPDATE] More verbose errors for rapsing body request.

package/commands/CreateUser.js

@@ -60,7 +60,9 @@ class CreateUser extends AbstractCommand {
 
     await user.generateToken();
 
-    this.logger.info(`User was created/updated ${JSON.stringify(user, 0, 4)}`);
+    this.logger.info(
+      `User was created/updated ${JSON.stringify(user, null, 4)}`,
+    );
 
     return user;
   }

package/jsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "module": "node16",
+    "target": "ES2022",
+    "moduleResolution": "node16",
+    "checkJs": true
+  },
+  "exclude": ["node_modules"]
+}

package/modules/AbstractCommand.js

@@ -13,10 +13,11 @@ class AbstractCommand extends Base {
 
   /**
    * Entry point to every command. This method should be overridden
-   * @override
+   * @return {Promise<boolean>} resut
    */
   async run() {
     this.logger.error('You should implement run method');
+    return false;
   }
 
   static get loggerGroup() {

package/modules/AbstractController.js

@@ -25,10 +25,12 @@ class AbstractController extends Base {
     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();
     }
 
@@ -58,6 +60,7 @@ class AbstractController extends Base {
       httpPath,
     );
     const middlewaresInfo = this.parseMiddlewares(
+      // @ts-ignore
       this.constructor.middleware,
       httpPath,
     );
@@ -370,6 +373,7 @@ class AbstractController extends Base {
    * 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
+   * @returns {Map<string, Array<AbstractMiddleware | [Function, ...any]>>}
    * @example
    * return new Map([
    *    ['/*', [GetUserByToken]] // for any method for this controller

package/modules/AbstractModel.js

@@ -3,12 +3,12 @@ import Base from './Base.js';
 
 class AbstractModel extends Base {
   /**
-   * @param {import('../server')} app  //TODO change to *.d.ts as this is a Server, not app
+   * @param {import('../server.js').default['app']} app  //TODO change to *.d.ts as this is a Server, not app
    * @param function callback optional callback when connection ready
    */
   constructor(app, callback = () => {}) {
     super(app);
-    this.mongooseSchema = mongoose.Schema(this.modelSchema);
+    this.mongooseSchema = new mongoose.Schema(this.modelSchema);
     mongoose.set('strictQuery', true);
     this.mongooseSchema.set('timestamps', true);
     this.mongooseSchema.set('minimize', false);

package/modules/Base.d.ts

@@ -1,5 +1,6 @@
 import winston from 'winston';
-import Server from '../server';
+import Server from '../server.js';
+import type { Dirent } from 'fs';
 
 declare class Base {
   app: Server['app'];
@@ -26,11 +27,11 @@ declare class Base {
   getFilesPathWithInheritance(
     internalFolder: string,
     externalFolder: string,
-  ): Promise<string[]>;
+  ): Promise<Dirent[]>;
 
   /**
    * Return logger group. Just to have all logs groupped logically
    */
   static get loggerGroup(): string;
 }
-export = Base;
+export default Base;

package/package.json

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

package/server.d.ts

@@ -9,6 +9,8 @@ import BaseCli from './modules/BaseCli';
 import Cache from './services/cache/Cache';
 import winston from 'winston';
 
+import HttpServer from './services/http/HttpServer.js';
+
 type ServerConfig = {
   folders: ExpandDeep<TFolderConfig>;
 };
@@ -24,7 +26,7 @@ declare class Server {
     events: EventEmitter;
     get cache(): Server['cacheService'];
     get logger(): winston.Logger;
-    httpServer: null;
+    httpServer: HttpServer | null;
     controllerManager: null;
   };
   cacheService: Cache;
@@ -33,7 +35,7 @@ declare class Server {
     configs: Map<string, {}>;
     models: Map<string, MongooseModel<any>>;
   };
-  cli: boolean;
+  cli: null | BaseCli;
 
   /**
    *  Construct new server
@@ -68,7 +70,7 @@ declare class Server {
    * @see updateConfig
    * @TODO generate that based on real data
    */
-  getConfig(configName: string): {};
+  getConfig(configName: string): { [key: string]: any };
 
   /**
    * Return or create new logger instance. This is a main logger instance
@@ -79,7 +81,7 @@ declare class Server {
    * Primary designed for tests when we need to update some configs before start testing
    * Should be called before any initialization was done
    */
-  updateConfig(configName: string, config: {}): {};
+  updateConfig(configName: string, config: {}): { [key: string]: any };
 
   /**
    * Return model from {modelName} (file name) on model folder.
@@ -93,4 +95,4 @@ declare class Server {
   runCliCommand(commandName: string, args: {}): Promise<BaseCli['run']>;
 }
 
-export = Server;
+export default Server;

package/server.js

@@ -19,6 +19,8 @@ class Server {
 
   #isInited = false;
 
+  cli = null;
+
   /**
    *  Construct new server
    * @param {Object} config main config object
@@ -56,8 +58,6 @@ class Server {
       models: new Map(),
       modelConstructors: new Map(),
     };
-
-    this.cli = false;
   }
 
   /**
@@ -350,7 +350,7 @@ class Server {
    * Return model from {modelName} (file name) on model folder.
    * Support cache
    * @param {String} modelName name on config file to load
-   * @returns {import('mongoose').Model}
+   * @returns {import('mongoose').Model | false| {}}
    */
   getModel(modelName) {
     if (modelName.endsWith('s')) {

package/services/cache/Cache.d.ts

@@ -1,5 +1,5 @@
 import Base from '../../modules/Base';
-import Server from '../../server';
+import Server from '../../server.js';
 
 declare class Cache extends Base {
   app: Server['app'];
@@ -32,4 +32,4 @@ declare class Cache extends Base {
   removeKey(key: string): Promise<number>;
 }
 
-export = Cache;
+export default Cache;

package/services/http/HttpServer.js

@@ -57,7 +57,7 @@ class HttpServer extends Base {
       res.status(500).json({ message: 'Something broke!' });
     });
 
-    this.httpServer = http.Server(this.express);
+    this.httpServer = http.createServer(this.express);
 
     const listener = this.httpServer.listen(
       httpConfig.port,

package/services/http/middleware/GetUserByToken.js

@@ -11,7 +11,7 @@ class GetUserByToken extends AbstractMiddleware {
         name: 'Authorization',
         type: 'apiKey',
         in: 'header',
-        description: this?.description,
+        description: this.constructor.description,
       },
     ];
   }

package/services/http/middleware/RequestParser.test.js

@@ -79,12 +79,21 @@ d\r
       const server = createServer(async (req, res) => {
         req.appInfo = {};
         const middleware = new RequestParser(global.server.app);
-        middleware.middleware(req, {}, (err) => {
-          expect(err).toBeDefined();
+        let status;
 
-          res.writeHead(200);
-          res.end('ok');
-        });
+        const resp = {
+          status: (code) => {
+            status = code;
+            return resp;
+          },
+          json: () => resp,
+        };
+        await middleware.middleware(req, resp, () => {});
+        expect(status).toBe(400);
+        // expect(err).toBeDefined();
+
+        res.writeHead(200);
+        res.end('ok');
       });
       server.listen(null, async () => {
         const chosenPort = server.address().port;

package/services/messaging/email/index.js

@@ -66,7 +66,8 @@ class Mail extends Base {
    * @param {object} templateData
    * @returns string
    */
-  static async #renderTemplateFile({ type, fullPath } = {}, templateData = {}) {
+  // eslint-disable-next-line class-methods-use-this
+  async #renderTemplateFile({ type, fullPath } = {}, templateData = {}) {
     if (!type) {
       return null;
     }
@@ -116,19 +117,10 @@ class Mail extends Base {
 
     const [htmlRendered, subjectRendered, textRendered, extraCss] =
       await Promise.all([
-        this.constructor.#renderTemplateFile(
-          templates.html,
-          templateDataToRender,
-        ),
-        this.constructor.#renderTemplateFile(
-          templates.subject,
-          templateDataToRender,
-        ),
-        this.constructor.#renderTemplateFile(
-          templates.text,
-          templateDataToRender,
-        ),
-        this.constructor.#renderTemplateFile(templates.style),
+        this.#renderTemplateFile(templates.html, templateDataToRender),
+        this.#renderTemplateFile(templates.subject, templateDataToRender),
+        this.#renderTemplateFile(templates.text, templateDataToRender),
+        this.#renderTemplateFile(templates.style),
       ]);
 
     juice.tableElements = ['TABLE'];
@@ -171,7 +163,7 @@ class Mail extends Base {
 
   /**
    * Send provided text (html) to email. Low level function. All data should be prepared before sending (like inline styles)
-   * @param {objetc} app application
+   * @param {import('../../../server.js').default['app']} app application
    * @param {string} to send to
    * @param {string} subject email topic
    * @param {string} html hmlt body of emain