ismx-nexo-node-app 0.4.31 → 0.4.33

package/dist/js/api/ServiceRestFormalTemplate.js

@@ -71,6 +71,12 @@ class ServiceRestFormalTemplate {
         let pageNumber = Number.parseInt(pageNumberStr);
         return { maxResults, pageNumber };
     }
+    /**
+     * Handles GET requests by retrieving a single record from the database based on the provided request.
+     *
+     * @param {HttpRequest} request - The HTTP request object containing the necessary parameters to process the request.
+     * @return {Promise<HttpResponse<Model>>} A promise that resolves to an HTTP response containing the retrieved model data.
+     */
     serveGet(request) {
         return __awaiter(this, void 0, void 0, function* () {
             let id = this.getFormalId(request);
@@ -78,11 +84,24 @@ class ServiceRestFormalTemplate {
             return Service_1.HttpResponse.ok(result);
         });
     }
+    /**
+     * Handles GET requests to retrieve a list of models from the database.
+     *
+     * @param {HttpRequest} request - The request object containing query parameters for filtering the results.
+     * @return {Promise<HttpResponse<Model[]>>} A promise that resolves to an HTTP response containing an array of models.
+     */
     serveGetList(request) {
         return __awaiter(this, void 0, void 0, function* () {
             return Service_1.HttpResponse.ok(yield this.database.find(this.tableName, Object.assign({}, request.query)));
         });
     }
+    /**
+     * Handles a GET request to retrieve a key-value mapping from the database table.
+     * Groups data based on provided key and value parameters, and returns a flattened keymap object.
+     *
+     * @param {HttpRequest} request - The HTTP request containing parameters for the keymap query.
+     * @return {Promise<HttpResponse<{ [key:string]:any }>>} A promise resolving to an HTTP response containing the key-value mapping.
+     */
     serveGetKeymap(request) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
@@ -124,11 +143,21 @@ class ServiceRestFormalTemplate {
             throw new Error();
         });
     }
+    /**
+     * @deprecated override 'serveGet' for retrieving full entity of database.
+     * @param request
+     * @protected
+     */
     serveFull(request) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.serveGet(request);
         });
     }
+    /**
+     * @deprecated override 'serveGetList' for retrieving full entitiy list of database.
+     * @param request
+     * @protected
+     */
     serveFullList(request) {
         return __awaiter(this, void 0, void 0, function* () {
             let list = yield this.unwrap(this.getList.serve(request));

package/dist/js/business/BusinessThread.js

@@ -1,4 +1,13 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -7,17 +16,24 @@ const Business_1 = __importDefault(require("./Business"));
 class BusinessThread extends Business_1.default {
     constructor() {
         super();
-        setTimeout(() => {
-            setInterval(() => {
+    }
+    init() {
+        var _a, _b;
+        this.timeoutId = setTimeout(() => {
+            this.intervalId = setInterval(() => __awaiter(this, void 0, void 0, function* () {
                 try {
-                    this.run();
+                    yield this.run();
                 }
                 catch (err) {
-                    this.onError();
+                    this.onError(err);
                 }
-            }, this.interval());
-        }, this.delay());
+            }), this.interval());
+        }, (_b = (_a = this.delay) === null || _a === void 0 ? void 0 : _a.call(this)) !== null && _b !== void 0 ? _b : 0);
+    }
+    terminate() {
+        clearInterval(this.intervalId);
+        clearTimeout(this.timeoutId);
     }
-    onError() { }
+    onError(err) { }
 }
 exports.default = BusinessThread;

package/dist/types/api/ServiceRestFormalTemplate.d.ts

@@ -36,8 +36,27 @@ export default class ServiceRestFormalTemplate<Model = any> {
         maxResults: number;
         pageNumber: number;
     };
+    /**
+     * Handles GET requests by retrieving a single record from the database based on the provided request.
+     *
+     * @param {HttpRequest} request - The HTTP request object containing the necessary parameters to process the request.
+     * @return {Promise<HttpResponse<Model>>} A promise that resolves to an HTTP response containing the retrieved model data.
+     */
     protected serveGet(request: HttpRequest): Promise<HttpResponse<Model>>;
+    /**
+     * Handles GET requests to retrieve a list of models from the database.
+     *
+     * @param {HttpRequest} request - The request object containing query parameters for filtering the results.
+     * @return {Promise<HttpResponse<Model[]>>} A promise that resolves to an HTTP response containing an array of models.
+     */
     protected serveGetList(request: HttpRequest): Promise<HttpResponse<Model[]>>;
+    /**
+     * Handles a GET request to retrieve a key-value mapping from the database table.
+     * Groups data based on provided key and value parameters, and returns a flattened keymap object.
+     *
+     * @param {HttpRequest} request - The HTTP request containing parameters for the keymap query.
+     * @return {Promise<HttpResponse<{ [key:string]:any }>>} A promise resolving to an HTTP response containing the key-value mapping.
+     */
     protected serveGetKeymap(request: HttpRequest): Promise<HttpResponse<{
         [key: string]: any;
     }>>;
@@ -49,7 +68,17 @@ export default class ServiceRestFormalTemplate<Model = any> {
     }>): Promise<HttpResponse<{
         [key: string]: any;
     }>>;
+    /**
+     * @deprecated override 'serveGet' for retrieving full entity of database.
+     * @param request
+     * @protected
+     */
     protected serveFull(request: HttpRequest): Promise<HttpResponse<Model>>;
+    /**
+     * @deprecated override 'serveGetList' for retrieving full entitiy list of database.
+     * @param request
+     * @protected
+     */
     protected serveFullList(request: HttpRequest): Promise<HttpResponse<Model[]>>;
     protected servePage(request: HttpRequest): Promise<HttpResponse<Pagination<Model>>>;
     protected serveMap(request: HttpRequest): Promise<HttpResponse<{

package/dist/types/business/BusinessThread.d.ts

@@ -1,8 +1,12 @@
 import Business from "./Business";
 export default abstract class BusinessThread extends Business {
+    private intervalId?;
+    private timeoutId?;
     constructor();
-    abstract run(): void;
+    init(): void;
+    terminate(): void;
+    abstract run(): Promise<void>;
     abstract interval(): number;
-    abstract delay(): number;
-    onError(): void;
+    abstract delay?(): number;
+    onError(err: Error): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ismx-nexo-node-app",
-  "version": "0.4.31",
+  "version": "0.4.33",
   "description": "",
   "scripts": {
     "build": "rm -rf ./dist && npx tsc",

package/src/main/node/api/ServiceRestFormalTemplate.ts

@@ -84,16 +84,35 @@ export default class ServiceRestFormalTemplate<Model=any>
 		return { maxResults, pageNumber }
 	}
 
+	/**
+	 * Handles GET requests by retrieving a single record from the database based on the provided request.
+	 *
+	 * @param {HttpRequest} request - The HTTP request object containing the necessary parameters to process the request.
+	 * @return {Promise<HttpResponse<Model>>} A promise that resolves to an HTTP response containing the retrieved model data.
+	 */
 	protected async serveGet(request: HttpRequest): Promise<HttpResponse<Model>> {
 		let id = this.getFormalId(request);
 		let result = await this.database.one<Model>(this.tableName, id);
 		return HttpResponse.ok(result);
 	}
 
+	/**
+	 * Handles GET requests to retrieve a list of models from the database.
+	 *
+	 * @param {HttpRequest} request - The request object containing query parameters for filtering the results.
+	 * @return {Promise<HttpResponse<Model[]>>} A promise that resolves to an HTTP response containing an array of models.
+	 */
 	protected async serveGetList(request: HttpRequest): Promise<HttpResponse<Model[]>> {
 		return HttpResponse.ok(await this.database.find<Model>(this.tableName, { ...request.query }));
 	}
 
+	/**
+	 * Handles a GET request to retrieve a key-value mapping from the database table.
+	 * Groups data based on provided key and value parameters, and returns a flattened keymap object.
+	 *
+	 * @param {HttpRequest} request - The HTTP request containing parameters for the keymap query.
+	 * @return {Promise<HttpResponse<{ [key:string]:any }>>} A promise resolving to an HTTP response containing the key-value mapping.
+	 */
 	protected async serveGetKeymap(request: HttpRequest): Promise<HttpResponse<{ [key:string]:any }>> {
 		let key = request.query?.["_key"] ?? this.indexer;
 		let value = request.query?.["_value"] ?? "value";
@@ -126,10 +145,20 @@ export default class ServiceRestFormalTemplate<Model=any>
 		throw new Error();
 	}
 
+	/**
+	 * @deprecated override 'serveGet' for retrieving full entity of database.
+	 * @param request
+	 * @protected
+	 */
 	protected async serveFull(request: HttpRequest): Promise<HttpResponse<Model>> {
 		return this.serveGet(request);
 	}
 
+	/**
+	 * @deprecated override 'serveGetList' for retrieving full entitiy list of database.
+	 * @param request
+	 * @protected
+	 */
 	protected async serveFullList(request: HttpRequest): Promise<HttpResponse<Model[]>>
 	{
 		let list = await this.unwrap(this.getList.serve(request));

package/src/main/node/business/BusinessThread.ts

@@ -2,18 +2,29 @@ import Business from "./Business";
 
 export default abstract class BusinessThread extends Business
 {
+	private intervalId?: NodeJS.Timeout;
+	private timeoutId?: NodeJS.Timeout;
+
 	constructor() {
 		super();
-		setTimeout(() => {
-			setInterval(() => {
-				try { this.run() }
-				catch (err) { this.onError() }
+	}
+
+	init() {
+		this.timeoutId = setTimeout(() => {
+			this.intervalId = setInterval(async () => {
+				try { await this.run() }
+				catch (err) { this.onError(err as Error) }
 			}, this.interval());
-		}, this.delay())
+		}, this.delay?.() ?? 0);
+	}
+
+	terminate() {
+		clearInterval(this.intervalId);
+		clearTimeout(this.timeoutId);
 	}
 
-	abstract run(): void
+	abstract run(): Promise<void>
 	abstract interval(): number
-	abstract delay(): number
-	onError() {}
+	abstract delay?(): number
+	onError(err: Error) {}
 }