@technomoron/api-server-base 1.1.11 → 1.1.13

package/dist/cjs/api-server-base.cjs

@@ -330,7 +330,9 @@ function fillConfig(config) {
         authApi: config.authApi ?? false,
         devMode: config.devMode ?? false,
         hydrateGetBody: config.hydrateGetBody ?? true,
-        validateTokens: config.validateTokens ?? false
+        validateTokens: config.validateTokens ?? false,
+        apiVersion: config.apiVersion ?? '',
+        minClientVersion: config.minClientVersion ?? ''
     };
 }
 class ApiServer {
@@ -339,6 +341,7 @@ class ApiServer {
         this.apiNotFoundHandler = null;
         this.config = fillConfig(config);
         this.apiBasePath = this.normalizeApiBasePath(this.config.apiBasePath);
+        this.startedAt = Date.now();
         this.storageAdapter = auth_storage_js_1.nullAuthStorage;
         this.moduleAdapter = auth_module_js_1.nullAuthModule;
         this.app = (0, express_1.default)();
@@ -347,6 +350,7 @@ class ApiServer {
             this.app.use(upload.any());
         }
         this.middlewares();
+        this.installPingHandler();
         // addSwaggerUi(this.app);
         this.installApiNotFoundHandler();
     }
@@ -497,6 +501,20 @@ class ApiServer {
         };
         this.app.use((0, cors_1.default)(corsOptions));
     }
+    installPingHandler() {
+        const path = `${this.apiBasePath}/v1/ping`;
+        this.app.get(path, (_req, res) => {
+            const payload = {
+                status: 'ok',
+                apiVersion: this.config.apiVersion ?? '',
+                minClientVersion: this.config.minClientVersion ?? '',
+                uptimeSec: process.uptime(),
+                startedAt: this.startedAt,
+                timestamp: new Date().toISOString()
+            };
+            res.status(200).json({ code: 200, message: 'Success', data: payload });
+        });
+    }
     normalizeApiBasePath(path) {
         if (!path || typeof path !== 'string') {
             return '/api';

package/dist/cjs/api-server-base.d.ts

@@ -100,11 +100,14 @@ export interface ApiServerConf {
     devMode: boolean;
     hydrateGetBody: boolean;
     validateTokens: boolean;
+    apiVersion: string;
+    minClientVersion: string;
 }
 export declare class ApiServer {
     app: Application;
     currReq: ApiRequest | null;
     readonly config: ApiServerConf;
+    readonly startedAt: number;
     private readonly apiBasePath;
     private storageAdapter;
     private moduleAdapter;
@@ -140,6 +143,7 @@ export declare class ApiServer {
     guessExceptionText(error: any, defMsg?: string): string;
     protected authorize(apiReq: ApiRequest, requiredClass: ApiAuthClass): Promise<void>;
     private middlewares;
+    private installPingHandler;
     private normalizeApiBasePath;
     private installApiNotFoundHandler;
     private ensureApiNotFoundOrdering;

package/dist/esm/api-server-base.d.ts

@@ -100,11 +100,14 @@ export interface ApiServerConf {
     devMode: boolean;
     hydrateGetBody: boolean;
     validateTokens: boolean;
+    apiVersion: string;
+    minClientVersion: string;
 }
 export declare class ApiServer {
     app: Application;
     currReq: ApiRequest | null;
     readonly config: ApiServerConf;
+    readonly startedAt: number;
     private readonly apiBasePath;
     private storageAdapter;
     private moduleAdapter;
@@ -140,6 +143,7 @@ export declare class ApiServer {
     guessExceptionText(error: any, defMsg?: string): string;
     protected authorize(apiReq: ApiRequest, requiredClass: ApiAuthClass): Promise<void>;
     private middlewares;
+    private installPingHandler;
     private normalizeApiBasePath;
     private installApiNotFoundHandler;
     private ensureApiNotFoundOrdering;

package/dist/esm/api-server-base.js

@@ -322,7 +322,9 @@ function fillConfig(config) {
         authApi: config.authApi ?? false,
         devMode: config.devMode ?? false,
         hydrateGetBody: config.hydrateGetBody ?? true,
-        validateTokens: config.validateTokens ?? false
+        validateTokens: config.validateTokens ?? false,
+        apiVersion: config.apiVersion ?? '',
+        minClientVersion: config.minClientVersion ?? ''
     };
 }
 export class ApiServer {
@@ -331,6 +333,7 @@ export class ApiServer {
         this.apiNotFoundHandler = null;
         this.config = fillConfig(config);
         this.apiBasePath = this.normalizeApiBasePath(this.config.apiBasePath);
+        this.startedAt = Date.now();
         this.storageAdapter = nullAuthStorage;
         this.moduleAdapter = nullAuthModule;
         this.app = express();
@@ -339,6 +342,7 @@ export class ApiServer {
             this.app.use(upload.any());
         }
         this.middlewares();
+        this.installPingHandler();
         // addSwaggerUi(this.app);
         this.installApiNotFoundHandler();
     }
@@ -489,6 +493,20 @@ export class ApiServer {
         };
         this.app.use(cors(corsOptions));
     }
+    installPingHandler() {
+        const path = `${this.apiBasePath}/v1/ping`;
+        this.app.get(path, (_req, res) => {
+            const payload = {
+                status: 'ok',
+                apiVersion: this.config.apiVersion ?? '',
+                minClientVersion: this.config.minClientVersion ?? '',
+                uptimeSec: process.uptime(),
+                startedAt: this.startedAt,
+                timestamp: new Date().toISOString()
+            };
+            res.status(200).json({ code: 200, message: 'Success', data: payload });
+        });
+    }
     normalizeApiBasePath(path) {
         if (!path || typeof path !== 'string') {
             return '/api';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@technomoron/api-server-base",
-	"version": "1.1.11",
+	"version": "1.1.13",
 	"description": "Api Server Skeleton / Base Class",
 	"type": "module",
 	"main": "./dist/cjs/index.cjs",