namirasoft-node 1.4.19 → 1.4.21

package/src/BaseTable.ts

@@ -1,108 +1,108 @@
-import { ArraySchema, BaseTypeSchema, BaseVariableSchema, ObjectSchema } from "namirasoft-schema";
-import { BaseDatabase } from "./BaseDatabase";
-import { ErrorOperation, BaseUUID } from "namirasoft-core";
-
-export abstract class BaseTable<D extends BaseDatabase, ModelColumnOption>
-{
-    database: D;
-    uuid: BaseUUID;
-    constructor(database: D)
-    {
-        this.database = database;
-        this.uuid = new BaseUUID(this.getShortName());
-    }
-    public abstract getName(): string;
-    public abstract getShortName(): string;
-    protected addSecureColumns(columns: string[]): string[]
-    {
-        return columns;
-    }
-    protected addReadOnlyColumns(columns: string[]): string[]
-    {
-        return columns;
-    }
-    public getSecureColumns(): string[]
-    {
-        let columns: string[] = [];
-        return this.addSecureColumns(columns);
-    }
-    public getReadOnlyColumns(): string[]
-    {
-        let columns: string[] = [];
-        return this.addReadOnlyColumns(columns);
-    }
-    public secure(obj: any)
-    {
-        if (obj.dataValues)
-            obj = obj.dataValues;
-        let secureColumns: string[] = this.getSecureColumns();
-        secureColumns.forEach(col => delete obj[col]);
-        return obj;
-    }
-    public getArraySchema(require: boolean, name?: string): ArraySchema
-    {
-        let ans = this.getSchema(require, name);
-        return new ArraySchema(require, [ans]);
-    }
-    public getSchema(require: boolean, name?: string): ObjectSchema
-    {
-        let secureColumns: string[] = this.getSecureColumns();
-        let readOnlyColumns: string[] = this.getReadOnlyColumns();
-        let ans = new ObjectSchema(name ?? this.getName(), require, null);
-        this.forEachColumn((name, element) =>
-        {
-            if (!secureColumns.includes(name))
-                ans.addField(this.getVariableSchema(name, element, readOnlyColumns.includes(name)));
-        });
-        return ans;
-    }
-    public checkColumn(column: string)
-    {
-        let columns: string[] = [];
-        this.forEachColumn(name => columns.push(name));
-        if (!columns.includes(column))
-            ErrorOperation.throwHTTP(404, `Column '${column}' not found`);
-    }
-    public abstract forEachColumn(handler: (name: string, column: ModelColumnOption) => void): void;
-    private getVariableSchema(name: string, element: ModelColumnOption, read_only: boolean): BaseVariableSchema
-    {
-        let schema = this.getTypeSchema(element);
-        schema.read_only = read_only;
-        let es = this.getExamples();
-        schema.example = es[name] ?? "";
-        return new BaseVariableSchema(name, schema);
-    }
-    protected abstract getTypeSchema(element: ModelColumnOption): BaseTypeSchema;
-    protected getExamples(): { [name: string]: string }
-    {
-        return {};
-    }
-    public getSchemaNames(): string[]
-    {
-        return [];
-    }
-    public getSchemaByName(require: boolean, name?: string): ObjectSchema
-    {
-        let ans = this.getSchema(require, name);
-        if (name)
-        {
-            let names = this.getSchemaNames();
-            if (!names.includes(name))
-                throw new Error("Wrong schema name was provided: " + name);
-            this.setSchemaByName(ans);
-        }
-        return ans;
-    }
-    public getArraySchemaByName(require: boolean, name?: string): ArraySchema
-    {
-        let ans = this.getSchemaByName(require, name);
-        return new ArraySchema(require, [ans]);
-    }
-    protected setSchemaByName(_: ObjectSchema): void
-    {
-    }
-    public getNotFoundError(conditions: any | null)
-    {
-        return ErrorOperation.getHTTP(404, "Could not find " + this.getName() + " for " + JSON.stringify(conditions));
-    }
+import { ArraySchema, BaseTypeSchema, BaseVariableSchema, ObjectSchema } from "namirasoft-schema";
+import { BaseDatabase } from "./BaseDatabase";
+import { ErrorOperation, BaseUUID } from "namirasoft-core";
+
+export abstract class BaseTable<D extends BaseDatabase, ModelColumnOption>
+{
+    database: D;
+    uuid: BaseUUID;
+    constructor(database: D)
+    {
+        this.database = database;
+        this.uuid = new BaseUUID(this.getShortName());
+    }
+    public abstract getName(): string;
+    public abstract getShortName(): string;
+    protected addSecureColumns(columns: string[]): string[]
+    {
+        return columns;
+    }
+    protected addReadOnlyColumns(columns: string[]): string[]
+    {
+        return columns;
+    }
+    public getSecureColumns(): string[]
+    {
+        let columns: string[] = [];
+        return this.addSecureColumns(columns);
+    }
+    public getReadOnlyColumns(): string[]
+    {
+        let columns: string[] = [];
+        return this.addReadOnlyColumns(columns);
+    }
+    public secure(obj: any)
+    {
+        if (obj.dataValues)
+            obj = obj.dataValues;
+        let secureColumns: string[] = this.getSecureColumns();
+        secureColumns.forEach(col => delete obj[col]);
+        return obj;
+    }
+    public getArraySchema(require: boolean, name?: string): ArraySchema
+    {
+        let ans = this.getSchema(require, name);
+        return new ArraySchema(require, [ans]);
+    }
+    public getSchema(require: boolean, name?: string): ObjectSchema
+    {
+        let secureColumns: string[] = this.getSecureColumns();
+        let readOnlyColumns: string[] = this.getReadOnlyColumns();
+        let ans = new ObjectSchema(name ?? this.getName(), require, null);
+        this.forEachColumn((name, element) =>
+        {
+            if (!secureColumns.includes(name))
+                ans.addField(this.getVariableSchema(name, element, readOnlyColumns.includes(name)));
+        });
+        return ans;
+    }
+    public checkColumn(column: string)
+    {
+        let columns: string[] = [];
+        this.forEachColumn(name => columns.push(name));
+        if (!columns.includes(column))
+            ErrorOperation.throwHTTP(404, `Column '${column}' not found`);
+    }
+    public abstract forEachColumn(handler: (name: string, column: ModelColumnOption) => void): void;
+    private getVariableSchema(name: string, element: ModelColumnOption, read_only: boolean): BaseVariableSchema
+    {
+        let schema = this.getTypeSchema(element);
+        schema.read_only = read_only;
+        let es = this.getExamples();
+        schema.example = es[name] ?? "";
+        return new BaseVariableSchema(name, schema);
+    }
+    protected abstract getTypeSchema(element: ModelColumnOption): BaseTypeSchema;
+    protected getExamples(): { [name: string]: string }
+    {
+        return {};
+    }
+    public getSchemaNames(): string[]
+    {
+        return [];
+    }
+    public getSchemaByName(require: boolean, name?: string): ObjectSchema
+    {
+        let ans = this.getSchema(require, name);
+        if (name)
+        {
+            let names = this.getSchemaNames();
+            if (!names.includes(name))
+                throw new Error("Wrong schema name was provided: " + name);
+            this.setSchemaByName(ans);
+        }
+        return ans;
+    }
+    public getArraySchemaByName(require: boolean, name?: string): ArraySchema
+    {
+        let ans = this.getSchemaByName(require, name);
+        return new ArraySchema(require, [ans]);
+    }
+    protected setSchemaByName(_: ObjectSchema): void
+    {
+    }
+    public getNotFoundError(conditions: any | null)
+    {
+        return ErrorOperation.getHTTP(404, "Could not find " + this.getName() + " for " + JSON.stringify(conditions));
+    }
 }

package/src/CommandOperation.ts

@@ -1,33 +1,33 @@
-import { ExecException, exec, execSync } from 'child_process';
-import { ConsoleOperation } from 'namirasoft-core';
-export class CommandOperation 
-{
-    static exec(command: string, cwd: string | undefined)
-    {
-        exec(command, { cwd }, (error: ExecException | null, stdout: string, stderr: string) =>
-        {
-            if (error)
-            {
-                ConsoleOperation.error(`error: ${error.message}`);
-                return;
-            }
-            if (stderr)
-            {
-                ConsoleOperation.error(`stderr: ${stderr}`);
-                return;
-            }
-            ConsoleOperation.log(`stdout:\n${stdout}`);
-        });
-    }
-    static execSync(command: string, cwd: string | undefined)
-    {
-        try
-        {
-            return execSync(command, { cwd, encoding: 'utf-8' });
-        } catch (error: any)
-        {
-            ConsoleOperation.error(error.stdout);
-            throw error;
-        }
-    }
+import { ExecException, exec, execSync } from 'child_process';
+import { ConsoleOperation } from 'namirasoft-core';
+export class CommandOperation 
+{
+    static exec(command: string, cwd: string | undefined)
+    {
+        exec(command, { cwd }, (error: ExecException | null, stdout: string, stderr: string) =>
+        {
+            if (error)
+            {
+                ConsoleOperation.error(`error: ${error.message}`);
+                return;
+            }
+            if (stderr)
+            {
+                ConsoleOperation.error(`stderr: ${stderr}`);
+                return;
+            }
+            ConsoleOperation.log(`stdout:\n${stdout}`);
+        });
+    }
+    static execSync(command: string, cwd: string | undefined)
+    {
+        try
+        {
+            return execSync(command, { cwd, encoding: 'utf-8' });
+        } catch (error: any)
+        {
+            ConsoleOperation.error(error.stdout);
+            throw error;
+        }
+    }
 }

package/src/EmptyDatabase.ts

@@ -1,12 +1,12 @@
-import { BaseDatabase } from "./BaseDatabase";
-
-export class EmptyDatabase extends BaseDatabase
-{
-    override async init() { }
-    override connect() { }
-    override async sync(_: boolean) { }
-    public override getSortOptions(): string[]
-    {
-        return [];
-    }
+import { BaseDatabase } from "./BaseDatabase";
+
+export class EmptyDatabase extends BaseDatabase
+{
+    override async init() { }
+    override connect() { }
+    override async sync(_: boolean) { }
+    public override getSortOptions(): string[]
+    {
+        return [];
+    }
 }

package/src/GmailService.ts

@@ -1,23 +1,23 @@
-import smtpTransport from 'nodemailer-smtp-transport';
-import { BaseEmailService } from './BaseEmailService';
-
-export class GmailService extends BaseEmailService
-{
-    password: string;
-    constructor(username: string, password: string)
-    {
-        super(username);
-        this.password = password;
-    }
-    protected override getTransform(): any
-    {
-        return smtpTransport({
-            service: 'gmail',
-            host: 'smtp.gmail.com',
-            auth: {
-                user: this.username,
-                pass: this.password
-            }
-        });
-    }
+import smtpTransport from 'nodemailer-smtp-transport';
+import { BaseEmailService } from './BaseEmailService';
+
+export class GmailService extends BaseEmailService
+{
+    password: string;
+    constructor(username: string, password: string)
+    {
+        super(username);
+        this.password = password;
+    }
+    protected override getTransform(): any
+    {
+        return smtpTransport({
+            service: 'gmail',
+            host: 'smtp.gmail.com',
+            auth: {
+                user: this.username,
+                pass: this.password
+            }
+        });
+    }
 }

package/src/IPOperation.ts

@@ -1,39 +1,39 @@
-import * as express from 'express';
-import { getClientIp } from '@supercharge/request-ip';
-import { RequestHeaderService } from './RequestHeaderService';
-import { ErrorOperation } from 'namirasoft-core';
-
-export class IPOperation
-{
-    static ERROR_MESSAGE_IP_IS_NOT_WHITELIST = `Ip does not match the whitelisted IP address: {0}`;
-    static getIP(req: express.Request): string
-    {
-        let ip = new RequestHeaderService(req, 'cf-connecting-ip').getString();
-        if (!ip)
-            ip = new RequestHeaderService(req, 'x-forwarded-for').getString();
-        if (!ip)
-            ip = getClientIp(req) ?? "";
-        ip = ip.split(',')[0];
-        return ip;
-    }
-    static isWhitelist(req: express.Request, whitelist: string[])
-    {
-        let ip = this.getIP(req);
-        if (!whitelist)
-            return true;
-        if (whitelist.length === 0)
-            return true;
-        if (whitelist.includes(ip))
-            return true;
-        for (let item of whitelist)
-            if (ip.substring(0, item.length) === item)
-                return true;
-        return false;
-    }
-    static checkWhitelist(req: express.Request, whitelist: string[])
-    {
-        let valid = this.isWhitelist(req, whitelist);
-        if (!valid)
-            ErrorOperation.throwHTTP(403, this.ERROR_MESSAGE_IP_IS_NOT_WHITELIST, this.getIP(req));
-    }
+import * as express from 'express';
+import { getClientIp } from '@supercharge/request-ip';
+import { RequestHeaderService } from './RequestHeaderService';
+import { ErrorOperation } from 'namirasoft-core';
+
+export class IPOperation
+{
+    static ERROR_MESSAGE_IP_IS_NOT_WHITELIST = `Ip does not match the whitelisted IP address: {0}`;
+    static getIP(req: express.Request): string
+    {
+        let ip = new RequestHeaderService(req, 'cf-connecting-ip').getString();
+        if (!ip)
+            ip = new RequestHeaderService(req, 'x-forwarded-for').getString();
+        if (!ip)
+            ip = getClientIp(req) ?? "";
+        ip = ip.split(',')[0];
+        return ip;
+    }
+    static isWhitelist(req: express.Request, whitelist: string[])
+    {
+        let ip = this.getIP(req);
+        if (!whitelist)
+            return true;
+        if (whitelist.length === 0)
+            return true;
+        if (whitelist.includes(ip))
+            return true;
+        for (let item of whitelist)
+            if (ip.substring(0, item.length) === item)
+                return true;
+        return false;
+    }
+    static checkWhitelist(req: express.Request, whitelist: string[])
+    {
+        let valid = this.isWhitelist(req, whitelist);
+        if (!valid)
+            ErrorOperation.throwHTTP(403, this.ERROR_MESSAGE_IP_IS_NOT_WHITELIST, this.getIP(req));
+    }
 }

package/src/Meta.ts

@@ -1,41 +1,41 @@
-import * as express from 'express';
-import { IncomingHttpHeaders } from "http";
-import { IPOperation } from './IPOperation';
-import { HTTPMethod } from 'namirasoft-core';
-
-export class Meta
-{
-    info: { name: string, tag: string, method: HTTPMethod, path: string, summary: string };
-    ip: string;
-    method: string;
-    url: string;
-    headers?: IncomingHttpHeaders;
-    body?: any;
-    start_time: Date | null = null;
-    end_time: Date | null = null;
-    duration: number | null = null;
-    code: number = 200;
-    message: string = "Success";
-    error: Error | null = null;
-    constructor(info: { name: string, tag: string, method: HTTPMethod, path: string, summary: string }, req: express.Request, sensitive: boolean)
-    {
-        this.info = info;
-        this.ip = IPOperation.getIP(req);
-        this.method = req.method;
-        this.url = req.originalUrl;
-        if (!sensitive)
-        {
-            this.headers = req.headers;
-            this.body = req.body;
-        }
-    }
-    onStart()
-    {
-        this.start_time = new Date();
-    }
-    onFinish()
-    {
-        this.end_time = new Date();
-        this.duration = (this.end_time?.getTime() ?? 0) - (this.start_time?.getTime() ?? 0);
-    }
+import * as express from 'express';
+import { IncomingHttpHeaders } from "http";
+import { IPOperation } from './IPOperation';
+import { HTTPMethod } from 'namirasoft-core';
+
+export class Meta
+{
+    info: { name: string, tag: string, method: HTTPMethod, path: string, summary: string };
+    ip: string;
+    method: string;
+    url: string;
+    headers?: IncomingHttpHeaders;
+    body?: any;
+    start_time: Date | null = null;
+    end_time: Date | null = null;
+    duration: number | null = null;
+    code: number = 200;
+    message: string = "Success";
+    error: Error | null = null;
+    constructor(info: { name: string, tag: string, method: HTTPMethod, path: string, summary: string }, req: express.Request, sensitive: boolean)
+    {
+        this.info = info;
+        this.ip = IPOperation.getIP(req);
+        this.method = req.method;
+        this.url = req.originalUrl;
+        if (!sensitive)
+        {
+            this.headers = req.headers;
+            this.body = req.body;
+        }
+    }
+    onStart()
+    {
+        this.start_time = new Date();
+    }
+    onFinish()
+    {
+        this.end_time = new Date();
+        this.duration = (this.end_time?.getTime() ?? 0) - (this.start_time?.getTime() ?? 0);
+    }
 }

package/src/OTPOperation.ts

@@ -1,65 +1,72 @@
-import { ErrorOperation, TimeOperation } from "namirasoft-core";
-
-export class OTPOperation 
-{
-    static generate(length: number = 6, digit: number = 3)
-    {
-        if (!length)
-            length = 6;
-        if (!digit)
-            digit = 3;
-        let dig = [];
-        for (let i = 0; i < digit; i++)
-            dig[i] = parseInt((Math.random() * 9 + 1) + "");
-        let ans = '';
-        for (let i = 0; i < length; i++)
-            ans = ans + '' + dig[parseInt((Math.random() * dig.length) + "")];
-        return ans;
-    }
-    static getWaitTime(min_wait_time: number, max_wait_time: number, min_attempt: number, user_attemptted: number, increase_power_base: number = 2): number
-    {
-        let wait_time = min_wait_time;
-        let extra_attempt = user_attemptted - min_attempt;
-        if (extra_attempt > 0)
-            wait_time = Math.min(Math.pow(increase_power_base, extra_attempt) * 60, max_wait_time);
-        return parseInt(wait_time + "");
-    }
-    static async onSafeRequest(handler: () => Promise<void>, min_wait_time: number, max_wait_time: number, min_try_count: number, user_tried_time: Date, user_tried_count: number, increase_power_base: number = 2)
-    {
-        // check wait time        
-        let wait_time = this.getWaitTime(min_wait_time, max_wait_time, min_try_count, user_tried_count, increase_power_base);
-        let wait_date = TimeOperation.minutesAgo(wait_time, new Date());
-        let next_time = TimeOperation.diffInSecond(user_tried_time, wait_date, false);
-        if (next_time > 0)
-        {
-            return {
-                error: 'Too many request, please try again in ' + next_time + ' seconds.',
-                next_time
-            };
-        }
-        await handler();
-        wait_time = this.getWaitTime(min_wait_time, max_wait_time, min_try_count, user_tried_count + 1, increase_power_base);
-        next_time = wait_time * 60;
-        return { next_time };
-    }
-    static async onSafeVerify(handler: () => Promise<void>, errorHandler: () => Promise<void>,
-        valid_otp: string, valid_otp_time: Date, otp_expire_time: number, max_try_count: number,
-        entered_otp: string, user_tried_count: number)
-    {
-        if (!entered_otp)
-            ErrorOperation.throwHTTP(403, "The OTP not generated yet.");
-
-        if (valid_otp_time < TimeOperation.minutesAgo(otp_expire_time, new Date()))
-            ErrorOperation.throwHTTP(403, "The OTP code expired. Please request again.");
-
-        if (user_tried_count > max_try_count)
-            ErrorOperation.throwHTTP(403, "The try limit attempt exceeded. Please request again.");
-
-        if (valid_otp !== entered_otp)
-        {
-            await errorHandler();
-            ErrorOperation.throwHTTP(403, "Wrong code.");
-        }
-        await handler();
-    }
+import { ErrorOperation, TimeOperation } from "namirasoft-core";
+
+export class OTPOperation 
+{
+    public static OTP_MIN_WAIT_TIME: number = 1; // minutes
+    public static OTP_MAX_WAIT_TIME: number = 1440; // minutes
+    public static OTP_EXPIRE_TIME: number = 5; // minutes
+    public static INCREASE_POWER_BASE: number = 2;
+
+    public static OTP_REQ_MAX_TRY_COUNT: number = 3;
+    public static OTP_VER_MAX_TRY_COUNT: number = 3;
+
+    static generate(length: number = 6, digit: number = 3)
+    {
+        if (!length)
+            length = 6;
+        if (!digit)
+            digit = 3;
+        let dig = [];
+        for (let i = 0; i < digit; i++)
+            dig[i] = parseInt((Math.random() * 9 + 1) + "");
+        let ans = '';
+        for (let i = 0; i < length; i++)
+            ans = ans + '' + dig[parseInt((Math.random() * dig.length) + "")];
+        return ans;
+    }
+    static getWaitTime(x_otp_req_tried_count: number): number
+    {
+        let wait_time = OTPOperation.OTP_MIN_WAIT_TIME;
+        let extra_attempt = x_otp_req_tried_count - OTPOperation.OTP_REQ_MAX_TRY_COUNT;
+        if (extra_attempt >= 0)
+            wait_time = Math.min(Math.pow(OTPOperation.INCREASE_POWER_BASE, extra_attempt) * 60, OTPOperation.OTP_MAX_WAIT_TIME);
+        return parseInt(wait_time + "");
+    }
+    static async onSafeRequest(x_otp_time: Date | null, x_otp_req_tried_count: number, handler: () => Promise<void>)
+    {
+        // check wait time        
+        let wait_time = this.getWaitTime(x_otp_req_tried_count);
+        let wait_date = TimeOperation.minutesAgo(wait_time, new Date());
+        let next_time = TimeOperation.diffInSecond(x_otp_time ?? new Date("0001-01-01"), wait_date, false);
+        if (next_time > 0)
+        {
+            return {
+                error: 'Too many request, please try again in ' + next_time + ' seconds.',
+                next_time
+            };
+        }
+        await handler();
+        wait_time = this.getWaitTime(x_otp_req_tried_count + 1);
+        next_time = wait_time * 60;
+        return { next_time };
+    }
+    static async onSafeVerify(x_otp: string | null, x_otp_time: Date | null, x_otp_ver_tried_count: number, code: string,
+        handler: () => Promise<void>, errorHandler: () => Promise<void>)
+    {
+        if (!x_otp || !x_otp_time)
+            throw ErrorOperation.getHTTP(403, "The OTP not generated yet. Please request first.");
+
+        if (x_otp_time < TimeOperation.minutesAgo(OTPOperation.OTP_EXPIRE_TIME, new Date()))
+            ErrorOperation.throwHTTP(403, "The OTP code expired. Please request again.");
+
+        if (x_otp_ver_tried_count > OTPOperation.OTP_VER_MAX_TRY_COUNT)
+            ErrorOperation.throwHTTP(403, "The try limit attempt exceeded. Please request again.");
+
+        if (x_otp !== code)
+        {
+            await errorHandler();
+            ErrorOperation.throwHTTP(403, "Wrong code.");
+        }
+        await handler();
+    }
 }