badmfck-api-server 3.0.8 → 3.1.0

package/dist/apiServer/APIService.js

@@ -96,7 +96,7 @@ async function Initializer(services) {
 exports.Initializer = Initializer;
 class APIService extends BaseService_1.BaseService {
     static nextLogID = 0;
-    version = "3.0.7";
+    version = "3.1.0";
     options;
     monitor = null;
     monitorIndexFile;

package/dist/apiServer/DocumentService.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocumentGenerator = exports.REQ_DOC = void 0;
 const badmfck_signal_1 = require("badmfck-signal");
+const Validator_1 = require("./helper/Validator");
 exports.REQ_DOC = new badmfck_signal_1.Req(undefined, "REQ_DOC");
 class DocumentGenerator {
     endpoints = [];
@@ -20,19 +21,18 @@ class DocumentGenerator {
                 description: i.description,
                 endpoints: []
             };
-            this.documentation.push(branch);
             for (let j of i.endpoints || []) {
                 if (j.ignoreInDocumentation || j.ignoreHttpLogging)
                     continue;
                 const endpoint = {};
-                endpoint.name = i.endpoint + "/" + j.endpoint;
+                endpoint.name = j.endpoint;
                 endpoint.methods = {};
                 if (typeof j.handler === "function") {
                     const method = j.validationModel ? "POST" : "GET";
                     endpoint.methods[method] = {
                         title: j.title || "",
                         description: j.description,
-                        parameters: j.validationModel ?? {},
+                        parameters: Validator_1.Validator.documentStructure(j.validationModel),
                         authorized: !j.ignoreInterceptor
                     };
                 }
@@ -44,13 +44,14 @@ class DocumentGenerator {
                         endpoint.methods[method] = {
                             title: handler.title || j.title || "",
                             description: handler.description || j.description,
-                            parameters: handler.validationModel || {},
+                            parameters: Validator_1.Validator.documentStructure(handler.validationModel),
                             authorized: !handler.ignoreInterceptor
                         };
                     }
                 }
                 branch.endpoints.push(endpoint);
             }
+            this.documentation.push(branch);
         }
     };
 }

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

@@ -21,6 +21,7 @@ export declare enum ValidationReport {
 }
 export declare class Validator {
     static validateObject(fields: string[], object: any): boolean;
+    static documentStructure(structure: any): Record<string, any> | undefined;
     static validateStructure(structure: any, object: any, level?: number): Promise<string[] | undefined>;
     static filterStructure(structure: any, object: any): void;
     static convertToType<T>(value: any, type: "string" | "number" | "boolean" | "date"): T | null;

package/dist/apiServer/helper/Validator.js

@@ -24,6 +24,34 @@ class Validator {
         }
         return true;
     }
+    static documentStructure(structure) {
+        const params = {};
+        if (!structure || typeof structure !== "object")
+            return;
+        for (let i in structure) {
+            if (i.startsWith("$__"))
+                continue;
+            let type = typeof structure[i];
+            let description = structure['$__' + i] || "";
+            let childs = undefined;
+            let optional = structure['$__optional_' + i] || "";
+            if (optional === undefined)
+                optional = structure[i] === null || structure[i] === undefined;
+            if (type === "object" && Array.isArray(structure[i]))
+                type = "array";
+            if (typeof structure[i] === "object")
+                childs = this.documentStructure(structure[i]);
+            if (structure[i] === "@")
+                type = "email";
+            params[i] = {
+                type: type,
+                description: description,
+                optional: optional,
+                childs: childs
+            };
+        }
+        return params;
+    }
     static async validateStructure(structure, object, level = 0) {
         if (!structure)
             return;
@@ -47,12 +75,23 @@ class Validator {
         let errors = [];
         let foundKeys = [];
         for (let i in structure) {
+            if (i.startsWith("$__")) {
+                foundKeys.push(i);
+                continue;
+            }
             if (structure[i] === null) {
                 foundKeys.push(i);
                 continue;
             }
-            if (!(i in object))
-                errors.push("no field '" + i + "'");
+            let optional = structure['$__optional_' + i] || false;
+            if (!(i in object)) {
+                if (!optional)
+                    errors.push("no field '" + i + "'");
+                else {
+                    foundKeys.push(i);
+                    continue;
+                }
+            }
             if (typeof structure[i] === "number" && typeof object[i] === "string") {
                 let num = parseInt(object[i]);
                 if (object[i].includes(","))

package/dist/apiServer/routes/Liveness.js

@@ -7,6 +7,7 @@ class Liveness extends BaseEndpoint_1.BaseEndpoint {
     started;
     constructor(stated) {
         super("liveness");
+        this.ignoreInDocumentation = true;
         this.started = stated;
         this.registerEndpoints([{ endpoint: "", handler: this.checkLiveness, ignoreInterceptor: true }]);
     }

package/package.json

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