@adaptivestone/framework 5.0.0-beta.17 → 5.0.0-beta.19

package/CHANGELOG.md

@@ -1,3 +1,53 @@
+### 5.0.0-next
+
+This is a big release that contains a lot of new features and breaking changes.
+Main feature of that release is full TypeScript support insluding mongoose models.
+
+#### New Features
+
+[NEW] Full TypeScript support, including Mongoose models.
+[NEW] New model type: BaseModel, simplifying work with TypeScript and based on statics.
+[NEW] AppInstance helper to access the app instance from anywhere without passing it.
+[NEW] GenerateTypes command added.
+[NEW] Lock model for working with locks via MongoDB.
+[NEW] FrameworkFolder folder added to the app for module usage.
+[NEW] Ability to skip Mongo model initialization in CLI environments.
+[NEW] Mongo connections in CLI now have unique names, including the command name.
+[NEW] On shutdown event, force shutdown after a timeout.
+[NEW] GenerateRandomBytes command added.
+[NEW] IpDetector middleware for detecting proxies and X-Forwarded-For headers.
+
+#### Breaking changes (please read carefully)
+
+[BREAKING] all models now should be extended from BaseModel. This is a potencial breaking change specially for User model.
+[BREAKING] Remove jest support for testing
+[BREAKING] move email module to separate package @adaptivestone/framework-module-email. Please use it if you want to send emails
+[BREAKING] remove VIEWS folders at all. Should not afffect any user as this was not used internally
+[BREAKING] removed noidemailer-sendmail-transport. Not needed anymore and not recommended to use as well
+[BREAKING] remove minimist CLI parsing and replace it by commandArguments parser
+[BREAKING] vitest v3 https://vitest.dev/guide/migration.html
+[BREAKING] i18next v24 https://www.i18next.com/misc/migration-guide#v23.x.x-to-v24.0.0
+[BREAKING] possible breaking. Framework start using express 5 instead of express 4. Please follow express migration guide too https://expressjs.com/en/guide/migrating-5.html.
+[BREAKING] AS part of express 5 migration _ in rotes (middlewares) should have perameter. please replace _ to \*splat
+[BREAKING] default auth responce changed to be unified. {token, user} = > {data:{token, user}}
+[BREAKING] RateLimiter now need to have IpDetector middleware before
+[BREAKING] removing staticFiles middleware as it not used in projects anymore. Docs with nginx config will be provided
+[BREAKING] remove default AUTH_SALT. It should be provided on a app level now
+[BREAKING] Minimum node version is 20.12 as for now (process.loadEnvFile)
+[BREAKING] ESM only. No more commonJS. That help to fix a lot of bugs with tests and provides better development expirience
+[BREAKING] Mongoose v8. https://mongoosejs.com/docs/migrating_to_8.html
+
+### 5.0.0-beta.19
+
+[NEW] intruducing new model type. BaseModel. Features - simplifie works with typescript. And based on statics
+[BREAKING] all models now should be extended from BaseModel. This is a potencial breaking change specially for User model.
+
+### 5.0.0-beta.18
+
+[UPDATE] move away connection from mongooseModels to server itself (preparation for different model types)
+[BREAKING] potencial. We are removed callback from mongooseModels contrctuctor. It was not used in code.
+[NEW] add appInstance helper to access app instance from anywhere without passing it
+
 ### 5.0.0-beta.17
 
 [NEW] add GenerateTypes command

package/dist/commands/GenerateTypes.d.ts

@@ -1,4 +1,4 @@
-import AbstractCommand from '@adaptivestone/framework/modules/AbstractCommand.js';
+import AbstractCommand from '../modules/AbstractCommand.ts';
 declare class GenerateTypes extends AbstractCommand {
     static get description(): string;
     getTypesContent(): Promise<string>;
@@ -7,6 +7,6 @@ declare class GenerateTypes extends AbstractCommand {
     static getTemplate(configs: Map<string, any>, modelPaths: {
         file: string;
         path: string;
-    }[]): string;
+    }[]): Promise<string>;
 }
 export default GenerateTypes;

package/dist/commands/GenerateTypes.js

@@ -1,4 +1,13 @@
-import AbstractCommand from '@adaptivestone/framework/modules/AbstractCommand.js';
+var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExtension) || function (path, preserveJsx) {
+    if (typeof path === "string" && /^\.\.?\//.test(path)) {
+        return path.replace(/\.(tsx)$|((?:\.d)?)((?:\.[^./]+?)?)\.([cm]?)ts$/i, function (m, tsx, d, ext, cm) {
+            return tsx ? preserveJsx ? ".jsx" : ".js" : d && (!ext || !cm) ? m : (d + ext + "." + cm.toLowerCase() + "js");
+        });
+    }
+    return path;
+};
+import AbstractCommand from "../modules/AbstractCommand.js";
+import { BaseModel } from "../modules/BaseModel.js";
 import * as url from 'url';
 import fs from 'node:fs/promises';
 class GenerateTypes extends AbstractCommand {
@@ -12,26 +21,31 @@ class GenerateTypes extends AbstractCommand {
     }
     static isShouldInitModels = false;
     async run() {
-        const template = GenerateTypes.getTemplate(this.app.internalFilesCache.configs, this.app.internalFilesCache.modelPaths);
+        const template = await GenerateTypes.getTemplate(this.app.internalFilesCache.configs, this.app.internalFilesCache.modelPaths);
         await fs.writeFile(`${process.cwd()}/genTypes.d.ts`, template);
         console.log('TypeScript types generated successfully at genTypes.d.ts');
         return Promise.resolve(true);
     }
-    static getTemplate(configs, modelPaths) {
+    static async getTemplate(configs, modelPaths) {
         const dir = process.cwd();
         const configTypes = Array.from(configs)
             .map((config) => {
             return `    getConfig(configName: '${config[0]}'): ${JSON.stringify(config[1], null, 6)};`;
         })
             .join('\n');
-        const modelTypes = modelPaths
-            .map((modelPath) => {
+        const modelTypes = (await Promise.all(modelPaths.map(async (modelPath) => {
+            const modelModule = await import(__rewriteRelativeImportExtension(modelPath.path));
             const path = modelPath.path.replace(dir, '.');
-            return `    getModel(modelName: '${modelPath.file}'): import('${path}').default['mongooseModel']`;
-        })
-            .join('\n');
+            if (modelModule.default.prototype instanceof BaseModel) {
+                return `    getModel(modelName: '${modelPath.file}'): GetModelTypeFromClass<typeof import('${path}').default>`;
+            }
+            else {
+                return `    getModel(modelName: '${modelPath.file}'): import('${path}').default['mongooseModel']`;
+            }
+        }))).join('\n');
         return `
 import type {} from '@adaptivestone/framework/server.js';
+import type { GetModelTypeFromClass } from '@adaptivestone/framework/modules/BaseModel.js';
 
 declare module '@adaptivestone/framework/server.js' {
   export interface IApp {

package/dist/commands/GenerateTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"GenerateTypes.js","sourceRoot":"","sources":["../../src/commands/GenerateTypes.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,MAAM,qDAAqD,CAAC;AAClF,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAC3B,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAElC,MAAM,aAAc,SAAQ,eAAe;IACzC,MAAM,KAAK,WAAW;QACpB,OAAO,4BAA4B,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,eAAe;QACnB,MAAM,SAAS,GAAG,GAAG,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACnE,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAC/B,GAAG,SAAS,8BAA8B,EAC1C,MAAM,CACP,CAAC;QACF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,MAAM,CAAC,kBAAkB,GAAG,KAAK,CAAC;IAElC,KAAK,CAAC,GAAG;QACP,MAAM,QAAQ,GAAG,aAAa,CAAC,WAAW,CACxC,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,OAAO,EACnC,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,UAAU,CACvC,CAAC;QACF,MAAM,EAAE,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,GAAG,EAAE,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAE/D,OAAO,CAAC,GAAG,CAAC,0DAA0D,CAAC,CAAC;QAExE,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,CAAC,WAAW,CAChB,OAAyB,EACzB,UAA4C;QAE5C,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;QAC1B,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;aACpC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACd,OAAO,8BAA8B,MAAM,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC;QAC7F,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,CAAC;QAEd,MAAM,UAAU,GAAG,UAAU;aAC1B,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;YACjB,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YAC9C,OAAO,4BAA4B,SAAS,CAAC,IAAI,eAAe,IAAI,6BAA6B,CAAC;QACpG,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,OAAO;;;;;QAKH,WAAW;QACX,UAAU;;;CAGjB,CAAC;IACA,CAAC;;AAGH,eAAe,aAAa,CAAC"}
+{"version":3,"file":"GenerateTypes.js","sourceRoot":"","sources":["../../src/commands/GenerateTypes.ts"],"names":[],"mappings":";;;;;;;;AAAA,OAAO,eAAe,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAC3B,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAElC,MAAM,aAAc,SAAQ,eAAe;IACzC,MAAM,KAAK,WAAW;QACpB,OAAO,4BAA4B,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,eAAe;QACnB,MAAM,SAAS,GAAG,GAAG,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACnE,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAC/B,GAAG,SAAS,8BAA8B,EAC1C,MAAM,CACP,CAAC;QACF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,MAAM,CAAC,kBAAkB,GAAG,KAAK,CAAC;IAElC,KAAK,CAAC,GAAG;QACP,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,WAAW,CAC9C,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,OAAO,EACnC,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,UAAU,CACvC,CAAC;QACF,MAAM,EAAE,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,GAAG,EAAE,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAE/D,OAAO,CAAC,GAAG,CAAC,0DAA0D,CAAC,CAAC;QAExE,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,WAAW,CACtB,OAAyB,EACzB,UAA4C;QAE5C,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;QAC1B,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;aACpC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACd,OAAO,8BAA8B,MAAM,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC;QAC7F,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,CAAC;QAEd,MAAM,UAAU,GAAG,CACjB,MAAM,OAAO,CAAC,GAAG,CACf,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;YACjC,MAAM,WAAW,GAAG,MAAM,MAAM,kCAAC,SAAS,CAAC,IAAI,EAAC,CAAC;YACjD,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YAC9C,IAAI,WAAW,CAAC,OAAO,CAAC,SAAS,YAAY,SAAS,EAAE,CAAC;gBACvD,OAAO,4BAA4B,SAAS,CAAC,IAAI,4CAA4C,IAAI,aAAa,CAAC;YACjH,CAAC;iBAAM,CAAC;gBACN,OAAO,4BAA4B,SAAS,CAAC,IAAI,eAAe,IAAI,6BAA6B,CAAC;YACpG,CAAC;QACH,CAAC,CAAC,CACH,CACF,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEb,OAAO;;;;;;QAMH,WAAW;QACX,UAAU;;;CAGjB,CAAC;IACA,CAAC;;AAGH,eAAe,aAAa,CAAC"}

package/dist/helpers/appInstance.d.ts

@@ -0,0 +1,3 @@
+import type { IApp } from '../server.ts';
+export declare let appInstance: IApp;
+export declare const setAppInstance: (app: IApp) => void;

package/dist/helpers/appInstance.js

@@ -0,0 +1,8 @@
+export let appInstance;
+export const setAppInstance = (app) => {
+    if (appInstance) {
+        throw new Error('App instance is already set');
+    }
+    appInstance = app;
+};
+//# sourceMappingURL=appInstance.js.map

package/dist/helpers/appInstance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"appInstance.js","sourceRoot":"","sources":["../../src/helpers/appInstance.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,IAAI,WAAiB,CAAC;AAE7B,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAAS,EAAE,EAAE;IAC1C,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;IACD,WAAW,GAAG,GAAG,CAAC;AACpB,CAAC,CAAC"}

package/dist/helpers/crypto.d.ts

@@ -0,0 +1,3 @@
+export declare const scryptAsync: (arg1: string | Buffer<ArrayBufferLike> | NodeJS.TypedArray<ArrayBufferLike> | DataView<ArrayBufferLike>, arg2: string | Buffer<ArrayBufferLike> | NodeJS.TypedArray<ArrayBufferLike> | DataView<ArrayBufferLike>, arg3: number) => Promise<Buffer<ArrayBufferLike>>;
+export declare const scryptAsyncWithSalt: (stringToHash: string) => Promise<Buffer<ArrayBufferLike>>;
+export declare const scryptAsyncWithSaltAsString: (stringToHash: string) => Promise<string>;

package/dist/helpers/crypto.js

@@ -0,0 +1,14 @@
+import { scrypt } from 'node:crypto';
+import { promisify } from 'node:util';
+import { appInstance } from "./appInstance.js";
+export const scryptAsync = promisify(scrypt);
+export const scryptAsyncWithSalt = async (stringToHash) => {
+    const { saltSecret, hashRounds } = appInstance.getConfig('auth');
+    const res = await scryptAsync(stringToHash, saltSecret, hashRounds);
+    return res;
+};
+export const scryptAsyncWithSaltAsString = async (stringToHash) => {
+    const res = await scryptAsyncWithSalt(stringToHash);
+    return res.toString('base64url');
+};
+//# sourceMappingURL=crypto.js.map

package/dist/helpers/crypto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crypto.js","sourceRoot":"","sources":["../../src/helpers/crypto.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,CAAC,MAAM,WAAW,GAAG,SAAS,CAKlC,MAAM,CAAC,CAAC;AAEV,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EAAE,YAAoB,EAAE,EAAE;IAChE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACjE,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,YAAY,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;IAEpE,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG,KAAK,EAAE,YAAoB,EAAE,EAAE;IACxE,MAAM,GAAG,GAAG,MAAM,mBAAmB,CAAC,YAAY,CAAC,CAAC;IACpD,OAAO,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AACnC,CAAC,CAAC"}

package/dist/helpers/redis/clearNamespace.d.ts

@@ -1,3 +1,2 @@
 import type { RedisClientType } from '@redis/client';
-declare function clearNamespace(redisClient: RedisClientType, namespace: string): Promise<void>;
-export default clearNamespace;
+export declare const clearNamespace: (redisClient: RedisClientType, namespace: string) => Promise<void>;

package/dist/helpers/redis/clearNamespace.js

@@ -1,4 +1,4 @@
-async function clearNamespace(redisClient, namespace) {
+export const clearNamespace = async (redisClient, namespace) => {
     const deletedKeys = [];
     const keys = await redisClient.sendCommand([
         'keys',
@@ -10,6 +10,5 @@ async function clearNamespace(redisClient, namespace) {
         }
         await Promise.all(deletedKeys);
     }
-}
-export default clearNamespace;
+};
 //# sourceMappingURL=clearNamespace.js.map

package/dist/helpers/redis/clearNamespace.js.map

@@ -1 +1 @@
-{"version":3,"file":"clearNamespace.js","sourceRoot":"","sources":["../../../src/helpers/redis/clearNamespace.ts"],"names":[],"mappings":"AAEA,KAAK,UAAU,cAAc,CAAC,WAA4B,EAAE,SAAiB;IAC3E,MAAM,WAAW,GAAG,EAAE,CAAC;IAEvB,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,WAAW,CAAW;QACnD,MAAM;QACN,IAAI,SAAS,GAAG;KACjB,CAAC,CAAC;IAEH,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1D,CAAC;QACD,MAAM,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACjC,CAAC;AACH,CAAC;AAED,eAAe,cAAc,CAAC"}
+{"version":3,"file":"clearNamespace.js","sourceRoot":"","sources":["../../../src/helpers/redis/clearNamespace.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EACjC,WAA4B,EAC5B,SAAiB,EACjB,EAAE;IACF,MAAM,WAAW,GAAG,EAAE,CAAC;IAEvB,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,WAAW,CAAW;QACnD,MAAM;QACN,IAAI,SAAS,GAAG;KACjB,CAAC,CAAC;IAEH,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1D,CAAC;QACD,MAAM,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACjC,CAAC;AACH,CAAC,CAAC"}

package/dist/models/Lock.d.ts

@@ -1,62 +1,89 @@
-import AbstractModel from '../modules/AbstractModel.ts';
-import type { IAbstractModel, IAbstractModelMethods } from '../modules/AbstractModel.ts';
-interface ILock {
-    _id: string;
-    expiredAt: Date;
-}
-interface IStatic extends IAbstractModel<ILock, IAbstractModelMethods<ILock>> {
-    acquireLock(name: string, ttlSeconds?: number): Promise<boolean>;
-    releaseLock(name: string): Promise<boolean>;
-    waitForUnlock(name: string): Promise<void>;
-    getLockData(name: string): Promise<{
-        ttl: number;
-    }>;
-    getLocksData(names: string[]): Promise<{
-        name: string;
-        ttl: number;
-    }[]>;
-}
-declare class Lock extends AbstractModel<ILock, IAbstractModelMethods<ILock>, IStatic> {
-    initHooks(): void;
-    get modelSchema(): {
-        _id: {
-            type: StringConstructor;
-            required: boolean;
+import { BaseModel } from '../modules/BaseModel.ts';
+import type { GetModelTypeLiteFromSchema } from '../modules/BaseModel.ts';
+import type { Schema } from 'mongoose';
+declare class Lock extends BaseModel {
+    static get modelSchema(): {
+        readonly _id: {
+            readonly type: StringConstructor;
+            readonly required: true;
         };
-        expiredAt: {
-            type: DateConstructor;
+        readonly expiredAt: {
+            readonly type: DateConstructor;
         };
     };
-    /**
-     * acquire lock based on lock name
-     * @param {string} name
-     * @param {number} [ttlSeconds=30]
-     */
-    static acquireLock(this: Lock['mongooseModel'], name: string, ttlSeconds?: number): Promise<boolean>;
-    /**
-     * release lock based on lock name
-     * @param {string} name
-     */
-    static releaseLock(this: Lock['mongooseModel'], name: string): Promise<boolean>;
-    /**
-     * wait lock based on lock name
-     * @param {string} name
-     */
-    static waitForUnlock(this: Lock['mongooseModel'], name: string): Promise<unknown>;
-    /**
-     * get lock remaining time based on lock name
-     * @param {string} name
-     */
-    static getLockData(this: Lock['mongooseModel'], name: string): Promise<{
-        ttl: number;
-    }>;
-    /**
-     * get lock remaining time based on lock name
-     * @param {string[]} names
-     */
-    static getLocksData(this: Lock['mongooseModel'], names: string[]): Promise<{
-        name: string;
-        ttl: number;
-    }[]>;
+    static get modelStatics(): {
+        /**
+         * acquire lock based on lock name
+         * @param {string} name
+         * @param {number} [ttlSeconds=30]
+         */
+        readonly acquireLock: (this: GetModelTypeLiteFromSchema<{
+            readonly _id: {
+                readonly type: StringConstructor;
+                readonly required: true;
+            };
+            readonly expiredAt: {
+                readonly type: DateConstructor;
+            };
+        }, {}>, name: string, ttlSeconds?: number) => Promise<boolean>;
+        /**
+         * release lock based on lock name
+         * @param {string} name
+         */
+        readonly releaseLock: (this: GetModelTypeLiteFromSchema<{
+            readonly _id: {
+                readonly type: StringConstructor;
+                readonly required: true;
+            };
+            readonly expiredAt: {
+                readonly type: DateConstructor;
+            };
+        }, {}>, name: string) => Promise<boolean>;
+        /**
+         * wait lock based on lock name
+         * @param {string} name
+         */
+        readonly waitForUnlock: (this: GetModelTypeLiteFromSchema<{
+            readonly _id: {
+                readonly type: StringConstructor;
+                readonly required: true;
+            };
+            readonly expiredAt: {
+                readonly type: DateConstructor;
+            };
+        }, {}>, name: string) => Promise<unknown>;
+        /**
+         * get lock remaining time based on lock name
+         * @param {string} name
+         */
+        readonly getLockData: (this: GetModelTypeLiteFromSchema<{
+            readonly _id: {
+                readonly type: StringConstructor;
+                readonly required: true;
+            };
+            readonly expiredAt: {
+                readonly type: DateConstructor;
+            };
+        }, {}>, name: string) => Promise<{
+            ttl: number;
+        }>;
+        /**
+         * get lock remaining time based on lock name
+         * @param {string[]} names
+         */
+        readonly getLocksData: (this: GetModelTypeLiteFromSchema<{
+            readonly _id: {
+                readonly type: StringConstructor;
+                readonly required: true;
+            };
+            readonly expiredAt: {
+                readonly type: DateConstructor;
+            };
+        }, {}>, names: string[]) => Promise<{
+            name: string;
+            ttl: number;
+        }[]>;
+    };
+    initHooks(schema: Schema): void;
 }
 export default Lock;

package/dist/models/Lock.js

@@ -1,10 +1,6 @@
-import AbstractModel from "../modules/AbstractModel.js";
-class Lock extends AbstractModel {
-    initHooks() {
-        this.mongooseSchema.index({ expiredAt: 1 }, { expireAfterSeconds: 0 });
-    }
-    // eslint-disable-next-line class-methods-use-this
-    get modelSchema() {
+import { BaseModel } from "../modules/BaseModel.js";
+class Lock extends BaseModel {
+    static get modelSchema() {
         return {
             _id: { type: String, required: true },
             expiredAt: {
@@ -12,82 +8,91 @@ class Lock extends AbstractModel {
             },
         };
     }
-    /**
-     * acquire lock based on lock name
-     * @param {string} name
-     * @param {number} [ttlSeconds=30]
-     */
-    static async acquireLock(name, ttlSeconds = 30) {
-        try {
-            await this.create({
-                _id: name,
-                expiredAt: new Date(Date.now() + ttlSeconds * 1000),
-            });
-        }
-        catch (error) {
-            if (error.code !== 11000) {
-                // not a duplicate leys
-                throw error;
-            }
-            return false;
-        }
-        return true;
-    }
-    /**
-     * release lock based on lock name
-     * @param {string} name
-     */
-    static async releaseLock(name) {
-        const res = await this.deleteOne({ _id: name });
-        if (res.acknowledged && res.deletedCount) {
-            return true;
-        }
-        return false;
-    }
-    /**
-     * wait lock based on lock name
-     * @param {string} name
-     */
-    static async waitForUnlock(name) {
-        const res = await this.findOne({ _id: name });
-        if (!res) {
-            return Promise.resolve();
-        }
-        return new Promise((resolve) => {
-            const stream = this.watch([
-                { $match: { operationType: 'delete', 'documentKey._id': name } },
-            ]);
-            stream.on('change', () => {
-                stream.close();
-                resolve(true);
-            });
-        });
-    }
-    /**
-     * get lock remaining time based on lock name
-     * @param {string} name
-     */
-    static async getLockData(name) {
-        const res = await this.findOne({ _id: name });
-        if (!res) {
-            return { ttl: 0 };
-        }
-        return { ttl: res.expiredAt.getTime() - Date.now() };
+    static get modelStatics() {
+        return {
+            /**
+             * acquire lock based on lock name
+             * @param {string} name
+             * @param {number} [ttlSeconds=30]
+             */
+            acquireLock: async function (name, ttlSeconds = 30) {
+                try {
+                    await this.create({
+                        _id: name,
+                        expiredAt: new Date(Date.now() + ttlSeconds * 1000),
+                    });
+                }
+                catch (error) {
+                    if (error.code !== 11000) {
+                        // not a duplicate keys
+                        throw error;
+                    }
+                    return false;
+                }
+                return true;
+            },
+            /**
+             * release lock based on lock name
+             * @param {string} name
+             */
+            releaseLock: async function (name) {
+                const res = await this.deleteOne({ _id: name });
+                if (res.acknowledged && res.deletedCount) {
+                    return true;
+                }
+                return false;
+            },
+            /**
+             * wait lock based on lock name
+             * @param {string} name
+             */
+            waitForUnlock: async function (name) {
+                const res = await this.findOne({ _id: name });
+                if (!res) {
+                    return Promise.resolve();
+                }
+                return new Promise((resolve) => {
+                    const stream = this.watch([
+                        { $match: { operationType: 'delete', 'documentKey._id': name } },
+                    ]);
+                    stream.on('change', () => {
+                        stream.close();
+                        resolve(true);
+                    });
+                });
+            },
+            /**
+             * get lock remaining time based on lock name
+             * @param {string} name
+             */
+            getLockData: async function (name) {
+                const res = await this.findOne({ _id: name });
+                if (!res || !res.expiredAt) {
+                    return { ttl: 0 };
+                }
+                return { ttl: res.expiredAt.getTime() - Date.now() };
+            },
+            /**
+             * get lock remaining time based on lock name
+             * @param {string[]} names
+             */
+            getLocksData: async function (names) {
+                const res = await this.find({ _id: { $in: names } });
+                const lockMap = new Map(res.map((lock) => [lock._id, lock]));
+                return names.map((name) => {
+                    const lock = lockMap.get(name);
+                    return {
+                        name,
+                        ttl: lock && lock.expiredAt
+                            ? lock.expiredAt.getTime() - Date.now()
+                            : 0,
+                    };
+                });
+            },
+        };
     }
-    /**
-     * get lock remaining time based on lock name
-     * @param {string[]} names
-     */
-    static async getLocksData(names) {
-        const res = await this.find({ _id: { $in: names } });
-        const lockMap = new Map(res.map((lock) => [lock._id, lock]));
-        return names.map((name) => {
-            const lock = lockMap.get(name);
-            return {
-                name,
-                ttl: lock ? lock.expiredAt.getTime() - Date.now() : 0,
-            };
-        });
+    initHooks(schema) {
+        schema.index({ expiredAt: 1 }, { expireAfterSeconds: 0 });
     }
 }
 export default Lock;

package/dist/models/Lock.js.map

@@ -1 +1 @@
-{"version":3,"file":"Lock.js","sourceRoot":"","sources":["../../src/models/Lock.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,6BAA6B,CAAC;AAqBxD,MAAM,IAAK,SAAQ,aAA2D;IAC5E,SAAS;QACP,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE,EAAE,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,kDAAkD;IAClD,IAAI,WAAW;QACb,OAAO;YACL,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;YACrC,SAAS,EAAE;gBACT,IAAI,EAAE,IAAI;aACX;SACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,WAAW,CAEtB,IAAY,EACZ,UAAU,GAAG,EAAE;QAEf,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC;gBAChB,GAAG,EAAE,IAAI;gBACT,SAAS,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,GAAG,IAAI,CAAC;aACpD,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,IAAK,KAAoB,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;gBACzC,uBAAuB;gBACvB,MAAM,KAAK,CAAC;YACd,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,WAAW,CAA8B,IAAY;QAChE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QAChD,IAAI,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;YACzC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,aAAa,CAA8B,IAAY;QAClE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC;QAED,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC;gBACxB,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,QAAQ,EAAE,iBAAiB,EAAE,IAAI,EAAE,EAAE;aACjE,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;gBACvB,MAAM,CAAC,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,WAAW,CAA8B,IAAY;QAChE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;QACpB,CAAC;QACD,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;IACvD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,YAAY,CAA8B,KAAe;QACpE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QACrD,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QAE7D,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACxB,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC/B,OAAO;gBACL,IAAI;gBACJ,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;aACtD,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED,eAAe,IAAI,CAAC"}
+{"version":3,"file":"Lock.js","sourceRoot":"","sources":["../../src/models/Lock.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AASpD,MAAM,IAAK,SAAQ,SAAS;IAC1B,MAAM,KAAK,WAAW;QACpB,OAAO;YACL,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;YACrC,SAAS,EAAE;gBACT,IAAI,EAAE,IAAI;aACX;SACO,CAAC;IACb,CAAC;IAED,MAAM,KAAK,YAAY;QAMrB,OAAO;YACL;;;;eAIG;YACH,WAAW,EAAE,KAAK,WAEhB,IAAY,EACZ,UAAU,GAAG,EAAE;gBAEf,IAAI,CAAC;oBACH,MAAM,IAAI,CAAC,MAAM,CAAC;wBAChB,GAAG,EAAE,IAAI;wBACT,SAAS,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,GAAG,IAAI,CAAC;qBACpD,CAAC,CAAC;gBACL,CAAC;gBAAC,OAAO,KAAc,EAAE,CAAC;oBACxB,IAAK,KAAoB,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;wBACzC,uBAAuB;wBACvB,MAAM,KAAK,CAAC;oBACd,CAAC;oBACD,OAAO,KAAK,CAAC;gBACf,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;YAED;;;eAGG;YACH,WAAW,EAAE,KAAK,WAAgC,IAAY;gBAC5D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;gBAChD,IAAI,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;oBACzC,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YAED;;;eAGG;YACH,aAAa,EAAE,KAAK,WAAgC,IAAY;gBAC9D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC9C,IAAI,CAAC,GAAG,EAAE,CAAC;oBACT,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;gBAC3B,CAAC;gBAED,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;oBAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC;wBACxB,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,QAAQ,EAAE,iBAAiB,EAAE,IAAI,EAAE,EAAE;qBACjE,CAAC,CAAC;oBACH,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;wBACvB,MAAM,CAAC,KAAK,EAAE,CAAC;wBACf,OAAO,CAAC,IAAI,CAAC,CAAC;oBAChB,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;YACL,CAAC;YAED;;;eAGG;YACH,WAAW,EAAE,KAAK,WAAgC,IAAY;gBAC5D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC9C,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;oBAC3B,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;gBACpB,CAAC;gBACD,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;YACvD,CAAC;YAED;;;eAGG;YACH,YAAY,EAAE,KAAK,WAAgC,KAAe;gBAChE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;gBACrD,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;gBAE7D,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;oBACxB,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;oBAC/B,OAAO;wBACL,IAAI;wBACJ,GAAG,EACD,IAAI,IAAI,IAAI,CAAC,SAAS;4BACpB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE;4BACvC,CAAC,CAAC,CAAC;qBACR,CAAC;gBACJ,CAAC,CAAC,CAAC;YACL,CAAC;SACO,CAAC;IACb,CAAC;IAED,SAAS,CAAC,MAAc;QACtB,MAAM,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE,EAAE,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF;AAED,eAAe,IAAI,CAAC"}

package/dist/models/Migration.d.ts

@@ -1,12 +1,9 @@
-import AbstractModel from '../modules/AbstractModel.ts';
-interface IMigration {
-    migrationFile: string;
-}
-declare class Migration extends AbstractModel<IMigration> {
-    get modelSchema(): {
-        migrationFile: {
-            type: StringConstructor;
-            unique: boolean;
+import { BaseModel } from '../modules/BaseModel.ts';
+declare class Migration extends BaseModel {
+    static get modelSchema(): {
+        readonly migrationFile: {
+            readonly type: StringConstructor;
+            readonly unique: true;
         };
     };
 }

package/dist/models/Migration.js

@@ -1,7 +1,6 @@
-import AbstractModel from "../modules/AbstractModel.js";
-class Migration extends AbstractModel {
-    // eslint-disable-next-line class-methods-use-this
-    get modelSchema() {
+import { BaseModel } from "../modules/BaseModel.js";
+class Migration extends BaseModel {
+    static get modelSchema() {
         return {
             migrationFile: {
                 type: String,

package/dist/models/Migration.js.map

@@ -1 +1 @@
-{"version":3,"file":"Migration.js","sourceRoot":"","sources":["../../src/models/Migration.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,6BAA6B,CAAC;AAMxD,MAAM,SAAU,SAAQ,aAAyB;IAC/C,kDAAkD;IAClD,IAAI,WAAW;QACb,OAAO;YACL,aAAa,EAAE;gBACb,IAAI,EAAE,MAAM;gBACZ,MAAM,EAAE,IAAI;aACb;SACF,CAAC;IACJ,CAAC;CACF;AAED,eAAe,SAAS,CAAC"}
+{"version":3,"file":"Migration.js","sourceRoot":"","sources":["../../src/models/Migration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEpD,MAAM,SAAU,SAAQ,SAAS;IAC/B,MAAM,KAAK,WAAW;QACpB,OAAO;YACL,aAAa,EAAE;gBACb,IAAI,EAAE,MAAM;gBACZ,MAAM,EAAE,IAAI;aACb;SACO,CAAC;IACb,CAAC;CACF;AAED,eAAe,SAAS,CAAC"}

package/dist/models/Sequence.d.ts

@@ -1,23 +1,27 @@
-import AbstractModel from '../modules/AbstractModel.ts';
-import type { IAbstractModel, IAbstractModelMethods } from '../modules/AbstractModel.ts';
-interface ISequence {
-    _id: string;
-    seq: Number;
-}
-interface IStatic extends IAbstractModel<ISequence, IAbstractModelMethods<ISequence>> {
-    getSequence(forType: string): Promise<number>;
-}
-declare class Sequence extends AbstractModel<ISequence, IAbstractModelMethods<ISequence>, IStatic> {
-    get modelSchema(): {
-        _id: {
-            type: StringConstructor;
-            required: boolean;
+import { BaseModel } from '../modules/BaseModel.ts';
+import type { GetModelTypeLiteFromSchema } from '../modules/BaseModel.ts';
+declare class Sequence extends BaseModel {
+    static get modelSchema(): {
+        readonly _id: {
+            readonly type: StringConstructor;
+            readonly required: true;
         };
-        seq: {
-            type: NumberConstructor;
-            default: number;
+        readonly seq: {
+            readonly type: NumberConstructor;
+            readonly default: 1;
         };
     };
-    static getSequence(this: Sequence['mongooseModel'], forType: string): Promise<Number>;
+    static get modelStatics(): {
+        readonly getSequence: (this: GetModelTypeLiteFromSchema<{
+            readonly _id: {
+                readonly type: StringConstructor;
+                readonly required: true;
+            };
+            readonly seq: {
+                readonly type: NumberConstructor;
+                readonly default: 1;
+            };
+        }, {}>, forType: string) => Promise<number>;
+    };
 }
 export default Sequence;