@adaptivestone/framework 5.0.0-alpha.12 → 5.0.0-alpha.14

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+### 5.0.0-alpha.14
+
+[NEW] add types for Abstract model (wip)
+
+### 5.0.0-alpha.13
+
+[UPDATE] update deps
+[UPDATE] update i18n internal implementation
+[CHANGE] disable https server view
+
 ### 5.0.0-alpha.12
 
 [UPDATE] update deps

package/helpers/files.js

@@ -8,7 +8,7 @@ const getFilesPathWithInheritance = async ({
   loggerFileType = '',
   filter: { startWithCapital = true, notTests = true, notHidden = true } = {},
 }) => {
-  let [internalFiles, externalFiles] = await Promise.all([
+  const [internalFiles, externalFiles] = await Promise.all([
     fs.readdir(internalFolder, { recursive: true, withFileTypes: true }),
     fs.readdir(externalFolder, { recursive: true, withFileTypes: true }),
   ]);
@@ -33,24 +33,24 @@ const getFilesPathWithInheritance = async ({
     return true;
   };
 
-  internalFiles = internalFiles
+  const internalFilesString = internalFiles
     .filter(filterIndexFile)
     .map((fileDirent) =>
-      join(fileDirent.path, fileDirent.name)
+      join(fileDirent.parentPath, fileDirent.name)
         .replace(`${internalFolder}/`, '')
         .replace(`${internalFolder}`, ''),
     );
-  externalFiles = externalFiles
+  const externalFilesString = externalFiles
     .filter(filterIndexFile)
     .map((fileDirent) =>
-      join(fileDirent.path, fileDirent.name)
+      join(fileDirent.parentPath, fileDirent.name)
         .replace(`${externalFolder}/`, '')
         .replace(`${externalFolder}`, ''),
     );
 
   const filesToLoad = [];
-  for (const file of internalFiles) {
-    if (externalFiles.includes(file)) {
+  for (const file of internalFilesString) {
+    if (externalFilesString.includes(file)) {
       logger(
         `Skipping register INTERNAL file '${file}' ${
           loggerFileType ? `of type ${loggerFileType}` : ''
@@ -64,7 +64,7 @@ const getFilesPathWithInheritance = async ({
     }
   }
 
-  for (const file of externalFiles) {
+  for (const file of externalFilesString) {
     filesToLoad.push({
       path: join(externalFolder, file),
       file,

package/modules/AbstractController.js

@@ -373,7 +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]>>}
+   * @returns {Map<string, Array<typeof import('../services/http/middleware/AbstractMiddleware.js').default | [Function, ...any]>>}
    * @example
    * return new Map([
    *    ['/*', [GetUserByToken]] // for any method for this controller

package/modules/AbstractModel.d.ts

@@ -0,0 +1,48 @@
+import Base from './Base.js';
+import { Model, Schema } from 'mongoose';
+import Server from '../server.js';
+
+interface AbstractModel<T extends Document> extends Model, Base {
+  constructor(app: Server['app'], callback?: () => void);
+
+  /**
+   *  Return itself for internal methods.
+   */
+  getSuper(): this;
+
+  /**
+   *  Model schema in Js object (not a mongoose schema).
+   */
+  get modelSchema(): Object;
+
+  /**
+   * Mongoose schema.
+   */
+  mongooseSchema: Schema<T>;
+
+  /**
+   * Acces to mongoose model too
+   */
+  mongooseModel: Model<T>;
+
+  /**
+   * Init custom hooks before model
+   */
+  initHooks(): void;
+}
+
+abstract class AbstractModel<T extends Document>
+  extends Model
+  implements AbstractModel
+{
+  abstract get modelSchema(): Object;
+
+  /**
+   * Return itself for internal methods.
+   */
+  static abstract getSuper(): this;
+
+  mongooseSchema: Schema<T> = new Schema<T>(this.modelSchema);
+}
+
+export default AbstractModel;

package/modules/AbstractModel.js

@@ -2,6 +2,10 @@ import mongoose from 'mongoose';
 import Base from './Base.js';
 
 class AbstractModel extends Base {
+  mongooseSchema = null;
+
+  mongooseModel = null;
+
   /**
    * @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

package/modules/Base.d.ts

@@ -27,7 +27,7 @@ declare class Base {
   getFilesPathWithInheritance(
     internalFolder: string,
     externalFolder: string,
-  ): Promise<Dirent[]>;
+  ): Promise<{ path: string; file: string }[]>;
 
   /**
    * Return logger group. Just to have all logs groupped logically

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "5.0.0-alpha.12",
+  "version": "5.0.0-alpha.14",
   "description": "Adaptive stone node js framework",
   "main": "index.js",
   "type": "module",
@@ -35,10 +35,8 @@
     "formidable": "^3.5.1",
     "html-to-text": "^9.0.3",
     "i18next": "^23.2.8",
-    "i18next-chained-backend": "^4.0.0",
     "i18next-fs-backend": "^2.0.0",
     "juice": "^11.0.0",
-    "mime": "^4.0.0",
     "minimist": "^1.2.5",
     "mongoose": "^8.0.0",
     "nodemailer": "^6.6.3",

package/server.js

@@ -66,7 +66,7 @@ class Server {
 
   /**
    * Start server (http  + init all http ralated functions)
-   * @param <Promise>callbackBefore404 code that should be executed before adding page 404
+   * @param {Function} callbackBefore404 code that should be executed before adding page 404
    * @returns {Promise}
    */
   async startServer(callbackBefore404 = async () => Promise.resolve()) {

package/services/cache/Cache.js

@@ -43,8 +43,10 @@ class Cache extends Base {
     }
     const key = this.getKeyWithNameSpace(keyValue);
     // 5 mins default
-    let resolve = null;
-    let reject = null;
+    // eslint-disable-next-line no-unused-vars
+    let resolve = (value) => {};
+    // eslint-disable-next-line no-unused-vars
+    let reject = (value) => {};
     if (this.promiseMapping.has(key)) {
       return this.promiseMapping.get(key);
     }
@@ -71,7 +73,7 @@ class Cache extends Base {
 
       this.redisClient.set(
         key,
-        JSON.stringify(result, (jsonkey, value) =>
+        JSON.stringify(result, (_jsonkey, value) =>
           typeof value === 'bigint' ? `${value}n` : value,
         ),
         {
@@ -86,7 +88,7 @@ class Cache extends Base {
         )}`,
       );
       try {
-        result = JSON.parse(result, (jsonkey, value) => {
+        result = JSON.parse(result, (_jsonkey, value) => {
           if (typeof value === 'string' && /^\d+n$/.test(value)) {
             return BigInt(value.slice(0, value.length - 1));
           }

package/services/http/HttpServer.js

@@ -1,6 +1,6 @@
 import http from 'node:http';
-import path from 'node:path';
-import * as url from 'node:url';
+// import path from 'node:path';
+// import * as url from 'node:url';
 import express from 'express';
 import RequestLoggerMiddleware from './middleware/RequestLogger.js';
 import I18nMiddleware from './middleware/I18n.js';
@@ -18,12 +18,12 @@ class HttpServer extends Base {
     super(app);
     this.express = express();
     this.express.disable('x-powered-by');
-    const dirname = url.fileURLToPath(new URL('.', import.meta.url));
-    this.express.set('views', [
-      this.app.foldersConfig.views,
-      path.join(dirname, '../../views'),
-    ]);
-    this.express.set('view engine', 'pug');
+    // const dirname = url.fileURLToPath(new URL('.', import.meta.url));
+    // this.express.set('views', [
+    //   this.app.foldersConfig.views,
+    //   path.join(dirname, '../../views'),
+    // ]);
+    // this.express.set('view engine', 'pug');
 
     this.express.use(new PrepareAppInfoMiddleware(this.app).getMiddleware());
     this.express.use(new IpDetector(this.app).getMiddleware());

package/services/http/middleware/GetUserByToken.js

@@ -5,13 +5,14 @@ class GetUserByToken extends AbstractMiddleware {
     return 'Grab a token and try to parse the user from it. It user exist will add req.appInfo.user variable';
   }
 
+  // eslint-disable-next-line class-methods-use-this
   get usedAuthParameters() {
     return [
       {
         name: 'Authorization',
         type: 'apiKey',
         in: 'header',
-        description: this.constructor.description,
+        description: GetUserByToken.description,
       },
     ];
   }

package/services/http/middleware/I18n.js

@@ -1,37 +1,36 @@
 import i18next from 'i18next';
 import BackendFS from 'i18next-fs-backend';
-import Backend from 'i18next-chained-backend';
 import AbstractMiddleware from './AbstractMiddleware.js';
 
 class I18n extends AbstractMiddleware {
+  cache = {};
+
+  enabled = true;
+
+  lookupQuerystring = '';
+
+  supportedLngs = [];
+
+  fallbackLng = 'en';
+
+  /** @type {i18next} */
+  i18n = {
+    // @ts-ignore
+    t: (text) => text,
+    language: 'en',
+  };
+
   constructor(app, params) {
     super(app, params);
     const I18NConfig = this.app.getConfig('i18n');
-    this.i18n = {
-      t: (text) => text,
-      language: I18NConfig.fallbackLng,
-    };
-    this.cache = {};
 
     if (I18NConfig.enabled) {
       this.logger.info('Enabling i18n support');
       this.i18n = i18next;
-      i18next.use(Backend).init({
+      i18next.use(BackendFS).init({
         backend: {
-          backends: [
-            BackendFS,
-            //  BackendFS,
-          ],
-          backendOptions: [
-            // {
-            //  loadPath: __dirname + '/../../locales/{{lng}}/{{ns}}.json',
-            //   addPath: __dirname + '/../../locales/{{lng}}/{{ns}}.missing.json'
-            // },
-            {
-              loadPath: `${this.app.foldersConfig.locales}/{{lng}}/{{ns}}.json`,
-              addPath: `${this.app.foldersConfig.locales}/{{lng}}/{{ns}}.missing.json`,
-            },
-          ],
+          loadPath: `${this.app.foldersConfig.locales}/{{lng}}/{{ns}}.json`,
+          addPath: `${this.app.foldersConfig.locales}/{{lng}}/{{ns}}.missing.json`,
         },
         fallbackLng: I18NConfig.fallbackLng,
         preload: I18NConfig.preload,

package/services/http/middleware/Pagination.js

@@ -19,8 +19,8 @@ class Pagination extends AbstractMiddleware {
   async middleware(req, res, next) {
     let { limit, maxLimit } = this.params;
 
-    limit = typeof limit === 'number' ? parseInt(limit, 10) : 10;
-    maxLimit = typeof maxLimit === 'number' ? parseInt(maxLimit, 10) : 100;
+    limit = typeof limit !== 'number' ? parseInt(limit, 10) : 10;
+    maxLimit = typeof maxLimit !== 'number' ? parseInt(maxLimit, 10) : 100;
 
     req.appInfo.pagination = {};
     req.appInfo.pagination.page =