badmfck-api-server 3.9.3 → 3.9.5

package/dist/apiServer/APIService.js

@@ -93,7 +93,7 @@ async function Initializer(services) {
 }
 exports.Initializer = Initializer;
 class APIService extends BaseService_1.BaseService {
-    version = "3.9.3";
+    version = "3.9.5";
     options;
     monitor = null;
     started = new Date();

package/dist/apiServer/helper/JSONStableStringify.d.ts

@@ -0,0 +1 @@
+export declare function JSONStableStringify(obj: any): string;

package/dist/apiServer/helper/JSONStableStringify.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JSONStableStringify = void 0;
+function JSONStableStringify(obj) {
+    if (obj === null || typeof obj !== "object") {
+        return JSON.stringify(obj);
+    }
+    if (Array.isArray(obj)) {
+        return "[" + obj.map(JSONStableStringify).join(",") + "]";
+    }
+    const keys = Object.keys(obj).sort();
+    return ("{" +
+        keys.map(k => JSON.stringify(k) + ":" + JSONStableStringify(obj[k])).join(",") +
+        "}");
+}
+exports.JSONStableStringify = JSONStableStringify;

package/dist/apiServer/helper/Validator.d.ts

@@ -1,3 +1,9 @@
+type SyncOptions = {
+    fillOnlyWhenNull?: boolean;
+    resetOnTypeMismatch?: boolean;
+    repairArrayItems?: "coerce";
+    coerceArrayFromObject?: "values" | "numericKeys" | "wrap" | "off";
+};
 export type TValidatorType = "string" | "number" | "boolean" | "date" | "array" | "object" | "email" | "phone";
 export interface IStructureOptions {
     optional?: boolean;
@@ -31,24 +37,32 @@ export declare enum ValidationReport {
 }
 type WidenLiteral<T> = T extends string ? string : T extends number ? number : T extends boolean ? boolean : T;
 type WidenLiterals<T> = {
-    [K in keyof T]: T[K] extends (infer R)[] ? WidenLiteral<R>[] : T[K] extends object ? WidenLiterals<T[K]> : WidenLiteral<T[K]>;
+    [K in keyof T]: T[K] extends readonly (infer R)[] ? readonly WidenLiteral<R>[] : T[K] extends (infer R)[] ? WidenLiteral<R>[] : T[K] extends object ? WidenLiterals<T[K]> : WidenLiteral<T[K]>;
 };
 type DeepMutable<T> = {
     -readonly [K in keyof T]: T[K] extends object ? T[K] extends (...args: any[]) => any ? T[K] : DeepMutable<T[K]> : T[K];
 };
+type IsNever<T> = [T] extends [never] ? true : false;
+type Or<A, B> = A extends true ? true : (B extends true ? true : false);
+type CleanFields<T> = WidenLiterals<{
+    [K in keyof T as K extends `$__${string}` ? never : K]: T[K];
+}>;
+type HasOptional<T, K extends string> = Or<`$__${K}_optional` extends keyof T ? T[`$__${K}_optional`] extends true ? true : false : false, `$__${K}` extends keyof T ? T[`$__${K}`] extends {
+    optional: true;
+} ? true : false : false>;
 type ExtractOptionalFieldNames<T> = {
-    [K in keyof T as K extends `$__${infer Base}_optional` ? Base extends keyof T ? T[K] extends true ? Base : never : never : never]: true;
+    [K in (keyof T & string) as HasOptional<T, K> extends true ? K : never]: true;
 };
 type OptionalFields<T> = keyof ExtractOptionalFieldNames<T> & string;
+type ValuesArr<T, K extends string> = `$__${K}_values` extends keyof T ? T[`$__${K}_values`] extends readonly (infer V)[] ? readonly V[] : never : `$__${K}` extends keyof T ? T[`$__${K}`] extends {
+    values: readonly (infer V)[];
+} ? readonly V[] : never : never;
 type ExtractEnumValues<T> = {
-    [K in keyof T as K extends `$__${infer Base}_values` ? Base extends keyof T ? T[K] extends readonly (infer V)[] ? Base : never : never : never]: T[K] extends readonly (infer V)[] ? V : never;
+    [K in (keyof T & string) as IsNever<ValuesArr<T, K>> extends true ? never : K]: ValuesArr<T, K> extends ReadonlyArray<infer V> ? V : never;
 };
 type EnumFieldNames<T> = keyof ExtractEnumValues<T> & string;
 type EnumFieldValues<T> = ExtractEnumValues<T>;
-type CleanFields<T> = WidenLiterals<{
-    [K in keyof T as K extends `$__${string}` ? never : K]: T[K];
-}>;
-type ProcessField<F, Meta> = F extends readonly (infer Item)[] ? Item extends object ? ValidationModel<Item>[] : F : F extends object ? ValidationModel<F> : F;
+type ProcessField<F, Meta> = F extends readonly (infer Item)[] ? Item extends object ? ValidationModel<Item>[] : F : F extends (infer Item)[] ? Item extends object ? ValidationModel<Item>[] : F : F extends object ? ValidationModel<F> : F;
 export type ValidationModel<T> = DeepMutable<{
     [K in keyof CleanFields<T> as K extends OptionalFields<T> ? K : never]?: K extends EnumFieldNames<T> ? EnumFieldValues<T>[K] : ProcessField<CleanFields<T>[K], T>;
 } & {
@@ -60,7 +74,9 @@ export declare class Validator {
     static parseStructureOptions(key: string, structure: Record<string, any>): IStructureOptions;
     static validateStructure(structure: any, object: any, level?: number, parentPath?: string): Promise<string[] | undefined>;
     static filterStructure(structure: any, object: any): void;
-    static syncStructure(structure: any, object: any): any;
+    static isPlainObject(v: any): boolean;
+    static clone<T>(v: T): T;
+    static syncStructure(structure: any, object: any, opts?: SyncOptions): any;
     static convertToType<T>(value: any, type: "string" | "number" | "boolean" | "date"): T | null;
     static validateValue(value: string | number | boolean, opt?: IValidatorOptions): ValidationReport;
 }

package/dist/apiServer/helper/Validator.js

@@ -293,48 +293,120 @@ class Validator {
                 this.filterStructure(structure[key], object[key]);
         }
     }
-    static syncStructure(structure, object) {
-        if (typeof structure !== "object")
-            return;
+    static isPlainObject(v) {
+        return v !== null && typeof v === "object" && !Array.isArray(v);
+    }
+    static clone(v) {
+        if (typeof structuredClone === "function")
+            return structuredClone(v);
+        return JSON.parse(JSON.stringify(v));
+    }
+    static syncStructure(structure, object, opts = {
+        fillOnlyWhenNull: true,
+        resetOnTypeMismatch: true,
+        repairArrayItems: "coerce",
+        coerceArrayFromObject: "values"
+    }) {
+        if (structure === null || typeof structure !== "object")
+            return object;
+        if (Array.isArray(structure)) {
+            const tmpl = structure[0];
+            if (!Array.isArray(object) && this.isPlainObject(object)) {
+                const mode = opts.coerceArrayFromObject ?? "values";
+                if (mode === "numericKeys") {
+                    const numeric = Object.keys(object).filter(k => String(+k) === k).map(k => +k).sort((a, b) => a - b);
+                    object = numeric.map(i => object[String(i)]);
+                }
+                else if (mode === "wrap" && this.isPlainObject(tmpl)) {
+                    object = [object];
+                }
+                else if (mode === "values") {
+                    object = Object.values(object);
+                }
+                else {
+                    return object;
+                }
+            }
+            if (!Array.isArray(object))
+                return object;
+            if (tmpl !== undefined) {
+                for (let i = 0; i < object.length; i++) {
+                    let item = object[i];
+                    if (item === null || item === undefined) {
+                        object[i] = this.clone(tmpl);
+                        this.syncStructure(tmpl, object[i], opts);
+                        continue;
+                    }
+                    if (this.isPlainObject(tmpl) && this.isPlainObject(item)) {
+                        this.syncStructure(tmpl, item, opts);
+                        continue;
+                    }
+                    if (Array.isArray(tmpl) && Array.isArray(item)) {
+                        this.syncStructure(tmpl, item, opts);
+                        continue;
+                    }
+                    if (opts.repairArrayItems === "coerce") {
+                        object[i] = this.clone(tmpl);
+                        this.syncStructure(tmpl, object[i], opts);
+                    }
+                }
+            }
+            return object;
+        }
+        if (!this.isPlainObject(object))
+            return object;
         for (const key in object) {
-            if (!(key in structure)) {
+            if (!(key in structure))
                 delete object[key];
-            }
         }
         for (const key in structure) {
             const structureValue = structure[key];
+            const hasKey = Object.prototype.hasOwnProperty.call(object, key);
+            const { optional = false, skip_validation = false } = (Validator.parseStructureOptions(key, structure) || {});
             const objectValue = object[key];
-            if (!(key in object)) {
-                object[key] = structureValue;
+            if (!hasKey) {
+                object[key] = this.clone(structureValue);
                 continue;
             }
-            const options = Validator.parseStructureOptions(key, structure);
-            if (objectValue === null && structureValue !== null) {
-                if (!options.optional) {
-                    object[key] = structureValue;
-                    continue;
-                }
-                if (options.skip_validation) {
-                    object[key] = structureValue;
-                    continue;
-                }
-            }
             if (key.startsWith("$__")) {
-                object[key] = structure[key];
+                object[key] = this.clone(structureValue);
                 continue;
             }
-            if (objectValue && typeof objectValue === "object") {
-                if (Array.isArray(objectValue) && Array.isArray(structureValue) && structureValue.length > 0) {
-                    for (let i of objectValue) {
-                        if (typeof i === "object")
-                            this.syncStructure(structureValue[0], i);
+            if ((objectValue === null || objectValue === undefined) && structureValue !== null) {
+                if (!optional || skip_validation) {
+                    object[key] = this.clone(structureValue);
+                }
+                continue;
+            }
+            const svIsObj = this.isPlainObject(structureValue);
+            const ovIsObj = this.isPlainObject(objectValue);
+            const svIsArr = Array.isArray(structureValue);
+            const ovIsArr = Array.isArray(objectValue);
+            if (svIsObj || svIsArr) {
+                if ((svIsObj && !ovIsObj) || (svIsArr && !ovIsArr)) {
+                    if (opts.resetOnTypeMismatch && svIsObj) {
+                        const base = this.clone(structureValue);
+                        if (this.isPlainObject(objectValue)) {
+                            for (const k in objectValue)
+                                base[k] = objectValue[k];
+                            this.syncStructure(structureValue, base, opts);
+                            object[key] = base;
+                        }
+                        else {
+                            object[key] = base;
+                        }
                     }
                 }
                 else {
-                    this.syncStructure(structureValue, objectValue);
+                    this.syncStructure(structureValue, objectValue, opts);
                 }
                 continue;
             }
+            if (typeof objectValue !== typeof structureValue) {
+                if (opts.resetOnTypeMismatch) {
+                    object[key] = this.clone(structureValue);
+                }
+            }
         }
         return object;
     }

package/dist/apiServer/structures/DefaultErrors.d.ts

@@ -15,6 +15,9 @@ declare class DefaultErrors {
     static FORBIDDEN: IError;
     static NOT_FOUND: IError;
     static INTERNAL_SERVER_ERROR: IError;
+    static EXTERNAL_SERVICE_ERROR: IError;
+    static MAINTENANCE_MODE: IError;
+    static CONFLICT: IError;
     static INVALID_TOKEN: IError;
     static INVALID_CREDENTIALS: IError;
     static INVALID_DATA: IError;

package/dist/apiServer/structures/DefaultErrors.js

@@ -18,6 +18,9 @@ class DefaultErrors {
     static FORBIDDEN = { code: 12, message: "Forbidden", httpStatus: 403 };
     static NOT_FOUND = { code: 13, message: "Not found", httpStatus: 404 };
     static INTERNAL_SERVER_ERROR = { code: 14, message: "Internal server error.", httpStatus: 500 };
+    static EXTERNAL_SERVICE_ERROR = { code: 19, message: "External service error", httpStatus: 502 };
+    static MAINTENANCE_MODE = { code: 21, message: "Service in maintenance mode", httpStatus: 503 };
+    static CONFLICT = { code: 22, message: "Conflict", httpStatus: 409 };
     static INVALID_TOKEN = { code: 15, message: "Invalid token", httpStatus: 401 };
     static INVALID_CREDENTIALS = { code: 16, message: "Invalid credentials", httpStatus: 401 };
     static INVALID_DATA = { code: 17, message: "Invalid data", httpStatus: 422 };

package/dist/index.d.ts

@@ -11,4 +11,5 @@ import { ExternalService } from "./apiServer/external/ExternalService";
 import { DBService } from "./apiServer/DBService";
 import { YYYYMMDDHH } from "./apiServer/helper/YYYYMMDDHH";
 import { TimeframeService } from "./apiServer/TimeframeService";
-export { UID, YYYYMMDDHH, APIService, Initializer, LocalRequest, ValidationModel, MysqlService, TimeframeService, Validator, LogService, DataProvider, ErrorUtils, ExternalService, DBService, S_MONITOR_REGISTRATE_ACTION };
+import { JSONStableStringify } from "./apiServer/helper/JSONStableStringify";
+export { UID, YYYYMMDDHH, JSONStableStringify, APIService, Initializer, LocalRequest, ValidationModel, MysqlService, TimeframeService, Validator, LogService, DataProvider, ErrorUtils, ExternalService, DBService, S_MONITOR_REGISTRATE_ACTION };

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.S_MONITOR_REGISTRATE_ACTION = exports.DBService = exports.ExternalService = exports.ErrorUtils = exports.DataProvider = exports.LogService = exports.Validator = exports.TimeframeService = exports.MysqlService = exports.LocalRequest = exports.Initializer = exports.APIService = exports.YYYYMMDDHH = exports.UID = void 0;
+exports.S_MONITOR_REGISTRATE_ACTION = exports.DBService = exports.ExternalService = exports.ErrorUtils = exports.DataProvider = exports.LogService = exports.Validator = exports.TimeframeService = exports.MysqlService = exports.LocalRequest = exports.Initializer = exports.APIService = exports.JSONStableStringify = exports.YYYYMMDDHH = exports.UID = void 0;
 const APIService_1 = require("./apiServer/APIService");
 Object.defineProperty(exports, "APIService", { enumerable: true, get: function () { return APIService_1.APIService; } });
 Object.defineProperty(exports, "Initializer", { enumerable: true, get: function () { return APIService_1.Initializer; } });
@@ -28,3 +28,5 @@ const YYYYMMDDHH_1 = require("./apiServer/helper/YYYYMMDDHH");
 Object.defineProperty(exports, "YYYYMMDDHH", { enumerable: true, get: function () { return YYYYMMDDHH_1.YYYYMMDDHH; } });
 const TimeframeService_1 = require("./apiServer/TimeframeService");
 Object.defineProperty(exports, "TimeframeService", { enumerable: true, get: function () { return TimeframeService_1.TimeframeService; } });
+const JSONStableStringify_1 = require("./apiServer/helper/JSONStableStringify");
+Object.defineProperty(exports, "JSONStableStringify", { enumerable: true, get: function () { return JSONStableStringify_1.JSONStableStringify; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "badmfck-api-server",
-  "version": "3.9.3",
+  "version": "3.9.5",
   "description": "Simple API http server based on express",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",