badmfck-api-server 3.0.9 → 3.1.1

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.9";
+    version = "3.1.1";
     options;
     monitor = null;
     monitorIndexFile;
@@ -119,7 +119,7 @@ class APIService extends BaseService_1.BaseService {
             this.monitor.init();
             this.options.endpoints.push(new Monitor_1.Monitor());
         }
-        this.options.endpoints.push(new Documentation_1.Documentation());
+        this.options.endpoints.push(new Documentation_1.Documentation(this.options));
         this.options.endpoints.push(new ExternalServiceEndpoint_1.ExternalServiceEndpoint());
         this.options.endpoints.push(new Liveness_1.Liveness(this.started), new Readiness_1.Readiness(this.started));
         exports.REQ_HTTP_REQUESTS_COUNT.listener = async () => this.requestsCount;

package/dist/apiServer/BaseEndpoint.d.ts

@@ -13,6 +13,7 @@ export type IHandler = Record<HTTPMethod, ((req: HTTPRequestVO) => Promise<Trans
     ignoreInterceptor?: boolean;
     allowInterceptorError?: boolean;
     validationModel?: any;
+    resultModel?: any;
     asStream?: boolean;
     ignoreInDocumentation?: boolean;
     ignoreHttpLogging?: boolean;
@@ -31,6 +32,7 @@ export interface IEndpointHandler {
     description?: string;
     title?: string;
     validationModel?: any;
+    resultModel?: any;
 }
 export declare class BaseEndpoint implements IBaseEndpoint {
     private inializedEndpointNames;

package/dist/apiServer/DocumentService.js

@@ -33,7 +33,8 @@ class DocumentGenerator {
                         title: j.title || "",
                         description: j.description,
                         parameters: Validator_1.Validator.documentStructure(j.validationModel),
-                        authorized: !j.ignoreInterceptor
+                        authorized: !j.ignoreInterceptor,
+                        returns: j.resultModel ? Validator_1.Validator.documentStructure(j.resultModel) : undefined
                     };
                 }
                 else if (typeof j.handler === "object") {
@@ -45,7 +46,8 @@ class DocumentGenerator {
                             title: handler.title || j.title || "",
                             description: handler.description || j.description,
                             parameters: Validator_1.Validator.documentStructure(handler.validationModel),
-                            authorized: !handler.ignoreInterceptor
+                            authorized: !handler.ignoreInterceptor,
+                            returns: j.resultModel ? Validator_1.Validator.documentStructure(j.resultModel) : undefined
                         };
                     }
                 }

package/dist/apiServer/documentation/Documentation.d.ts

@@ -1,10 +1,10 @@
-/// <reference types="node" />
-/// <reference types="node" />
+import { APIServiceOptions } from "../APIService";
 import { BaseEndpoint } from "../BaseEndpoint";
 import { HTTPRequestVO, TransferPacketVO } from "../structures/Interfaces";
 export declare class Documentation extends BaseEndpoint {
-    indexHtmlFile: Buffer | null;
-    constructor();
+    indexHtmlFile: string | null;
+    apiServiceOptions: APIServiceOptions;
+    constructor(options: APIServiceOptions);
     json(req: HTTPRequestVO): Promise<{
         data: Record<string, any>[];
     }>;

package/dist/apiServer/documentation/Documentation.js

@@ -13,8 +13,11 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 class Documentation extends BaseEndpoint_1.BaseEndpoint {
     indexHtmlFile = null;
-    constructor() {
+    apiServiceOptions;
+    constructor(options) {
         super("doc");
+        this.apiServiceOptions = options;
+        this.ignoreInDocumentation = true;
         this.registerEndpoints([{
                 ignoreInDocumentation: true,
                 endpoint: "json",
@@ -34,14 +37,17 @@ class Documentation extends BaseEndpoint_1.BaseEndpoint {
         return { data: doc };
     }
     async html(req) {
-        if (!this.indexHtmlFile)
-            this.indexHtmlFile = fs_1.default.readFileSync(path_1.default.resolve(__dirname, "index.html"));
+        if (!this.indexHtmlFile) {
+            this.indexHtmlFile = fs_1.default.readFileSync(path_1.default.resolve(__dirname, "index.html")).toString("utf-8");
+            const endpoint = "./" + this.apiServiceOptions.baseEndPoint + this.endpoint + "/" + "json";
+            this.indexHtmlFile = this.indexHtmlFile.replace(/{{HOST}}/g, endpoint);
+        }
         return {
             rawResponse: true,
             data: this.indexHtmlFile,
             headers: {
                 "Content-Type": "text/html",
-                "Content-Length": this.indexHtmlFile.byteLength.toString()
+                "Content-Length": this.indexHtmlFile.length.toString()
             }
         };
     }

package/dist/apiServer/helper/Validator.js

@@ -32,11 +32,13 @@ class Validator {
             if (i.startsWith("$__"))
                 continue;
             let type = typeof structure[i];
-            let description = structure[i]['$__' + i] || "";
+            let description = structure['$__' + i] || "";
             let childs = undefined;
-            let optional = structure[i]['$__optional_' + i] || "";
+            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] === "@")
@@ -81,7 +83,7 @@ class Validator {
                 foundKeys.push(i);
                 continue;
             }
-            let optional = structure[i]['$__optional_' + i] || false;
+            let optional = structure['$__optional_' + i] || false;
             if (!(i in object)) {
                 if (!optional)
                     errors.push("no field '" + i + "'");

package/package.json

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