ismx-nexo-node-app 0.4.59 → 0.4.60

package/dist/js/api/ServiceRestFormalTemplate.js

@@ -71,6 +71,9 @@ class ServiceRestFormalTemplate {
         let pageNumber = Number.parseInt(pageNumberStr);
         return { maxResults, pageNumber };
     }
+    extendEntity(entity) {
+        return entity;
+    }
     /**
      * Handles GET requests by retrieving a single record from the database based on the provided request.
      *
@@ -80,7 +83,8 @@ class ServiceRestFormalTemplate {
     serveGet(request) {
         return __awaiter(this, void 0, void 0, function* () {
             let id = this.getFormalId(request);
-            let result = yield this.database.one(this.tableName, id);
+            let entity = yield this.database.one(this.tableName, id);
+            let result = this.extendEntity(entity);
             return Service_1.HttpResponse.ok(result);
         });
     }
@@ -92,7 +96,43 @@ class ServiceRestFormalTemplate {
      */
     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)));
+            let entities = yield this.database.find(this.tableName, Object.assign({}, request.query));
+            let result = entities.map(this.extendEntity);
+            return Service_1.HttpResponse.ok(result);
+        });
+    }
+    /**
+     * Serves a paginated response for the requested page entities.
+     *
+     * @param {HttpRequest} request The HTTP request containing details needed for pagination processing, such as query parameters.
+     * @return {Promise<HttpResponse<Pagination<Model>>>} A promise resolving to an HTTP response containing the paginated list of entities.
+     */
+    servePage(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { maxResults, pageNumber } = this.getFormalPage(request);
+            let result = yield this.database.page(this.tableName, "timestamp", maxResults, pageNumber);
+            result.elements = result.elements.map(this.extendEntity);
+            return Service_1.HttpResponse.ok(result);
+        });
+    }
+    /**
+     * Serves a map of models retrieved from the database based on the request query parameters.
+     *
+     * @param {HttpRequest} request - The HTTP request containing query parameters for retrieving models.
+     * @return {Promise<HttpResponse<{[key: string]: Model}>>} A promise that resolves to an HTTP response containing a map of models, where the key is derived from the indexed property of each model.
+     */
+    serveMap(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let results = yield this.database.find(this.tableName, Object.assign({}, request.query));
+            let response = {};
+            for (let result of results) {
+                let key = result[this.indexer];
+                if (!key)
+                    return Service_1.HttpResponse.ok({});
+                else
+                    response[key] = this.extendEntity(result);
+            }
+            return Service_1.HttpResponse.ok(response);
         });
     }
     /**
@@ -114,6 +154,12 @@ class ServiceRestFormalTemplate {
             return Service_1.HttpResponse.ok(result);
         });
     }
+    /**
+     * Handles PUT requests by updating an existing record in the database based on the provided request.
+     *
+     * @param {HttpRequest<Model>} request - The HTTP request containing the model data to be updated.
+     * @return {Promise<HttpResponse<Model>>} A promise that resolves to an HTTP response containing the updated model data.
+     */
     servePut(request) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
@@ -123,6 +169,13 @@ class ServiceRestFormalTemplate {
             return Service_1.HttpResponse.ok((yield this.serveGet({ query: { [this.indexer]: id } })).content);
         });
     }
+    /**
+     * Handles POST requests by adding a new record to the database based on the provided request.
+     *
+     * @param {HttpRequest<Transient<Model>>} request - The HTTP request containing the model data to be added.
+     * @return {Promise<HttpResponse<Model>>} A promise that resolves to an HTTP response containing the added model data.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     servePost(request) {
         return __awaiter(this, void 0, void 0, function* () {
             let result = yield this.database.add(this.tableName, request.body);
@@ -169,27 +222,6 @@ class ServiceRestFormalTemplate {
             return Service_1.HttpResponse.ok(yield Promise.all(promises !== null && promises !== void 0 ? promises : []));
         });
     }
-    servePage(request) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let { maxResults, pageNumber } = this.getFormalPage(request);
-            let results = yield this.database.page(this.tableName, "timestamp", maxResults, pageNumber);
-            return Service_1.HttpResponse.ok(results);
-        });
-    }
-    serveMap(request) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let results = yield this.database.find(this.tableName, Object.assign({}, request.query));
-            let response = {};
-            for (let result of results) {
-                let key = result[this.indexer];
-                if (!key)
-                    return Service_1.HttpResponse.ok({});
-                else
-                    response[key] = result;
-            }
-            return Service_1.HttpResponse.ok(response);
-        });
-    }
     serveSelect(request) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;

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

@@ -36,6 +36,7 @@ export default class ServiceRestFormalTemplate<Model = any> {
         maxResults: number;
         pageNumber: number;
     };
+    extendEntity<T extends Model>(entity: Model): T;
     /**
      * Handles GET requests by retrieving a single record from the database based on the provided request.
      *
@@ -50,6 +51,22 @@ export default class ServiceRestFormalTemplate<Model = any> {
      * @return {Promise<HttpResponse<Model[]>>} A promise that resolves to an HTTP response containing an array of models.
      */
     protected serveGetList(request: HttpRequest): Promise<HttpResponse<Model[]>>;
+    /**
+     * Serves a paginated response for the requested page entities.
+     *
+     * @param {HttpRequest} request The HTTP request containing details needed for pagination processing, such as query parameters.
+     * @return {Promise<HttpResponse<Pagination<Model>>>} A promise resolving to an HTTP response containing the paginated list of entities.
+     */
+    protected servePage(request: HttpRequest): Promise<HttpResponse<Pagination<Model>>>;
+    /**
+     * Serves a map of models retrieved from the database based on the request query parameters.
+     *
+     * @param {HttpRequest} request - The HTTP request containing query parameters for retrieving models.
+     * @return {Promise<HttpResponse<{[key: string]: Model}>>} A promise that resolves to an HTTP response containing a map of models, where the key is derived from the indexed property of each model.
+     */
+    protected serveMap(request: HttpRequest): Promise<HttpResponse<{
+        [key: string]: 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.
@@ -60,7 +77,19 @@ export default class ServiceRestFormalTemplate<Model = any> {
     protected serveGetKeymap(request: HttpRequest): Promise<HttpResponse<{
         [key: string]: any;
     }>>;
+    /**
+     * Handles PUT requests by updating an existing record in the database based on the provided request.
+     *
+     * @param {HttpRequest<Model>} request - The HTTP request containing the model data to be updated.
+     * @return {Promise<HttpResponse<Model>>} A promise that resolves to an HTTP response containing the updated model data.
+     */
     protected servePut(request: HttpRequest<Model>): Promise<HttpResponse<Model>>;
+    /**
+     * Handles POST requests by adding a new record to the database based on the provided request.
+     *
+     * @param {HttpRequest<Transient<Model>>} request - The HTTP request containing the model data to be added.
+     * @return {Promise<HttpResponse<Model>>} A promise that resolves to an HTTP response containing the added model data.
+     */
     protected servePost(request: HttpRequest<Transient<Model>>): Promise<HttpResponse<Model>>;
     protected servePostList(request: HttpRequest<Model[]>): Promise<HttpResponse<Model[]>>;
     protected servePostKeymap(request: HttpRequest<{
@@ -80,10 +109,6 @@ export default class ServiceRestFormalTemplate<Model = any> {
      * @protected
      */
     protected serveFullList(request: HttpRequest): Promise<HttpResponse<Model[]>>;
-    protected servePage(request: HttpRequest): Promise<HttpResponse<Pagination<Model>>>;
-    protected serveMap(request: HttpRequest): Promise<HttpResponse<{
-        [key: string]: Model;
-    }>>;
     protected serveSelect(request: HttpRequest): Promise<HttpResponse<string[]>>;
     protected serveExist(request: HttpRequest): Promise<HttpResponse<Boolean>>;
     protected serveCount(request: HttpRequest): Promise<HttpResponse<Number>>;

package/package.json

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

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

@@ -84,6 +84,10 @@ export default class ServiceRestFormalTemplate<Model=any>
 		return { maxResults, pageNumber }
 	}
 
+	extendEntity<T extends Model>(entity : Model) : T {
+		return entity as T;
+	}
+
 	/**
 	 * Handles GET requests by retrieving a single record from the database based on the provided request.
 	 *
@@ -92,7 +96,8 @@ export default class ServiceRestFormalTemplate<Model=any>
 	 */
 	protected async serveGet(request: HttpRequest): Promise<HttpResponse<Model>> {
 		let id = this.getFormalId(request);
-		let result = await this.database.one<Model>(this.tableName, id);
+		let entity = await this.database.one<Model>(this.tableName, id);
+		let result = this.extendEntity(entity);
 		return HttpResponse.ok(result);
 	}
 
@@ -103,7 +108,38 @@ export default class ServiceRestFormalTemplate<Model=any>
 	 * @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 }));
+		let entities = await this.database.find<Model>(this.tableName, { ...request.query });
+		let result = entities.map(this.extendEntity);
+		return HttpResponse.ok(result);
+	}
+
+	/**
+	 * Serves a paginated response for the requested page entities.
+	 *
+	 * @param {HttpRequest} request The HTTP request containing details needed for pagination processing, such as query parameters.
+	 * @return {Promise<HttpResponse<Pagination<Model>>>} A promise resolving to an HTTP response containing the paginated list of entities.
+	 */
+	protected async servePage(request: HttpRequest): Promise<HttpResponse<Pagination<Model>>> {
+		let { maxResults, pageNumber } = this.getFormalPage(request);
+		let result = await this.database.page<Model>(this.tableName, "timestamp", maxResults, pageNumber);
+		result.elements = result.elements.map(this.extendEntity);
+		return HttpResponse.ok(result);
+	}
+
+	/**
+	 * Serves a map of models retrieved from the database based on the request query parameters.
+	 *
+	 * @param {HttpRequest} request - The HTTP request containing query parameters for retrieving models.
+	 * @return {Promise<HttpResponse<{[key: string]: Model}>>} A promise that resolves to an HTTP response containing a map of models, where the key is derived from the indexed property of each model.
+	 */
+	protected async serveMap(request: HttpRequest): Promise<HttpResponse<{[key: string]: Model}>> {
+		let results = await this.database.find<Model>(this.tableName, { ...request.query });
+		let response: {[key: string]: Model} = {}; for (let result of results) {
+			let key = (result as any)[this.indexer];
+			if (!key) return HttpResponse.ok({});
+			else response[key] = this.extendEntity(result);
+		}
+		return HttpResponse.ok(response);
 	}
 
 	/**
@@ -122,6 +158,12 @@ export default class ServiceRestFormalTemplate<Model=any>
 		return HttpResponse.ok(result);
 	}
 
+	/**
+	 * Handles PUT requests by updating an existing record in the database based on the provided request.
+	 *
+	 * @param {HttpRequest<Model>} request - The HTTP request containing the model data to be updated.
+	 * @return {Promise<HttpResponse<Model>>} A promise that resolves to an HTTP response containing the updated model data.
+	 */
 	protected async servePut(request: HttpRequest<Model>): Promise<HttpResponse<Model>> {
 		let id = this.getFormalId(request);
 		delete request.body?.[this.indexer as keyof Model];
@@ -129,6 +171,13 @@ export default class ServiceRestFormalTemplate<Model=any>
 		return HttpResponse.ok((await this.serveGet({ query: { [this.indexer]: id } })).content);
 	}
 
+	/**
+	 * Handles POST requests by adding a new record to the database based on the provided request.
+	 *
+	 * @param {HttpRequest<Transient<Model>>} request - The HTTP request containing the model data to be added.
+	 * @return {Promise<HttpResponse<Model>>} A promise that resolves to an HTTP response containing the added model data.
+	 */
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
 	protected async servePost(request: HttpRequest<Transient<Model>>): Promise<HttpResponse<Model>> {
 		let result = await this.database.add<Model>(this.tableName, request.body);
 		let id = result[this.indexer as keyof Model] as unknown as string;
@@ -169,22 +218,6 @@ export default class ServiceRestFormalTemplate<Model=any>
 		return HttpResponse.ok(await Promise.all(promises ?? []));
 	}
 
-	protected async servePage(request: HttpRequest): Promise<HttpResponse<Pagination<Model>>> {
-		let { maxResults, pageNumber } = this.getFormalPage(request);
-		let results = await this.database.page<Model>(this.tableName, "timestamp", maxResults, pageNumber);
-		return HttpResponse.ok(results);
-	}
-
-	protected async serveMap(request: HttpRequest): Promise<HttpResponse<{[key: string]: Model}>> {
-		let results = await this.database.find<Model>(this.tableName, { ...request.query });
-		let response: {[key: string]: Model} = {}; for (let result of results) {
-			let key = (result as any)[this.indexer];
-			if (!key) return HttpResponse.ok({});
-			else response[key] = result;
-		}
-		return HttpResponse.ok(response);
-	}
-
 	protected async serveSelect(request: HttpRequest): Promise<HttpResponse<string[]>> {
 		let selection = request.query?.["selection"] ?? this.indexer;
 		delete request.query?.["selection"];