@technomoron/api-server-base 1.1.6 → 1.1.7

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

@@ -335,7 +335,9 @@ function fillConfig(config) {
 class ApiServer {
     constructor(config = {}) {
         this.currReq = null;
+        this.apiNotFoundHandler = null;
         this.config = fillConfig(config);
+        this.apiBasePath = this.normalizeApiBasePath(this.config.apiBasePath);
         this.storageAdapter = auth_storage_js_1.nullAuthStorage;
         this.moduleAdapter = auth_module_js_1.nullAuthModule;
         this.app = (0, express_1.default)();
@@ -345,6 +347,7 @@ class ApiServer {
         }
         this.middlewares();
         // addSwaggerUi(this.app);
+        this.installApiNotFoundHandler();
     }
     authStorage(storage) {
         this.storageAdapter = storage;
@@ -493,6 +496,56 @@ class ApiServer {
         };
         this.app.use((0, cors_1.default)(corsOptions));
     }
+    normalizeApiBasePath(path) {
+        if (!path || typeof path !== 'string') {
+            return '/api';
+        }
+        const trimmed = path.trim();
+        if (!trimmed) {
+            return '/api';
+        }
+        const withLeadingSlash = trimmed.startsWith('/') ? trimmed : `/${trimmed}`;
+        if (withLeadingSlash.length === 1) {
+            return withLeadingSlash;
+        }
+        return withLeadingSlash.replace(/\/+$/, '') || '/api';
+    }
+    installApiNotFoundHandler() {
+        if (this.apiNotFoundHandler) {
+            return;
+        }
+        this.apiNotFoundHandler = (req, res) => {
+            const payload = {
+                code: 404,
+                message: this.describeMissingEndpoint(req),
+                data: null,
+                errors: {}
+            };
+            res.status(404).json(payload);
+        };
+        this.app.use(this.apiBasePath, this.apiNotFoundHandler);
+    }
+    ensureApiNotFoundOrdering() {
+        this.installApiNotFoundHandler();
+        if (!this.apiNotFoundHandler) {
+            return;
+        }
+        const stack = this.app?._router?.stack;
+        if (!stack) {
+            return;
+        }
+        const index = stack.findIndex((layer) => layer.handle === this.apiNotFoundHandler);
+        if (index === -1 || index === stack.length - 1) {
+            return;
+        }
+        const [layer] = stack.splice(index, 1);
+        stack.push(layer);
+    }
+    describeMissingEndpoint(req) {
+        const method = typeof req.method === 'string' ? req.method.toUpperCase() : 'GET';
+        const target = req.originalUrl || req.url || this.apiBasePath;
+        return `No such endpoint: ${method} ${target}`;
+    }
     start() {
         this.app
             .listen({
@@ -705,7 +758,7 @@ class ApiServer {
             this.authModule(module);
         }
         module.checkConfig();
-        const base = this.config.apiBasePath ?? '/api';
+        const base = this.apiBasePath;
         const ns = module.namespace;
         const mountPath = `${base}${ns}`;
         module.mountpath = mountPath;
@@ -717,6 +770,7 @@ class ApiServer {
             }
         });
         this.app.use(mountPath, router);
+        this.ensureApiNotFoundOrdering();
         return this;
     }
     dumpRequest(apiReq) {

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

@@ -101,8 +101,10 @@ export declare class ApiServer {
     app: Application;
     currReq: ApiRequest | null;
     readonly config: ApiServerConf;
+    private readonly apiBasePath;
     private storageAdapter;
     private moduleAdapter;
+    private apiNotFoundHandler;
     constructor(config?: Partial<ApiServerConf>);
     authStorage<UserRow, SafeUser>(storage: AuthStorage<UserRow, SafeUser>): this;
     /**
@@ -134,6 +136,10 @@ export declare class ApiServer {
     guessExceptionText(error: any, defMsg?: string): string;
     protected authorize(apiReq: ApiRequest, requiredClass: ApiAuthClass): Promise<void>;
     private middlewares;
+    private normalizeApiBasePath;
+    private installApiNotFoundHandler;
+    private ensureApiNotFoundOrdering;
+    private describeMissingEndpoint;
     start(): this;
     private verifyJWT;
     private authenticate;

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

@@ -101,8 +101,10 @@ export declare class ApiServer {
     app: Application;
     currReq: ApiRequest | null;
     readonly config: ApiServerConf;
+    private readonly apiBasePath;
     private storageAdapter;
     private moduleAdapter;
+    private apiNotFoundHandler;
     constructor(config?: Partial<ApiServerConf>);
     authStorage<UserRow, SafeUser>(storage: AuthStorage<UserRow, SafeUser>): this;
     /**
@@ -134,6 +136,10 @@ export declare class ApiServer {
     guessExceptionText(error: any, defMsg?: string): string;
     protected authorize(apiReq: ApiRequest, requiredClass: ApiAuthClass): Promise<void>;
     private middlewares;
+    private normalizeApiBasePath;
+    private installApiNotFoundHandler;
+    private ensureApiNotFoundOrdering;
+    private describeMissingEndpoint;
     start(): this;
     private verifyJWT;
     private authenticate;

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

@@ -327,7 +327,9 @@ function fillConfig(config) {
 export class ApiServer {
     constructor(config = {}) {
         this.currReq = null;
+        this.apiNotFoundHandler = null;
         this.config = fillConfig(config);
+        this.apiBasePath = this.normalizeApiBasePath(this.config.apiBasePath);
         this.storageAdapter = nullAuthStorage;
         this.moduleAdapter = nullAuthModule;
         this.app = express();
@@ -337,6 +339,7 @@ export class ApiServer {
         }
         this.middlewares();
         // addSwaggerUi(this.app);
+        this.installApiNotFoundHandler();
     }
     authStorage(storage) {
         this.storageAdapter = storage;
@@ -485,6 +488,56 @@ export class ApiServer {
         };
         this.app.use(cors(corsOptions));
     }
+    normalizeApiBasePath(path) {
+        if (!path || typeof path !== 'string') {
+            return '/api';
+        }
+        const trimmed = path.trim();
+        if (!trimmed) {
+            return '/api';
+        }
+        const withLeadingSlash = trimmed.startsWith('/') ? trimmed : `/${trimmed}`;
+        if (withLeadingSlash.length === 1) {
+            return withLeadingSlash;
+        }
+        return withLeadingSlash.replace(/\/+$/, '') || '/api';
+    }
+    installApiNotFoundHandler() {
+        if (this.apiNotFoundHandler) {
+            return;
+        }
+        this.apiNotFoundHandler = (req, res) => {
+            const payload = {
+                code: 404,
+                message: this.describeMissingEndpoint(req),
+                data: null,
+                errors: {}
+            };
+            res.status(404).json(payload);
+        };
+        this.app.use(this.apiBasePath, this.apiNotFoundHandler);
+    }
+    ensureApiNotFoundOrdering() {
+        this.installApiNotFoundHandler();
+        if (!this.apiNotFoundHandler) {
+            return;
+        }
+        const stack = this.app?._router?.stack;
+        if (!stack) {
+            return;
+        }
+        const index = stack.findIndex((layer) => layer.handle === this.apiNotFoundHandler);
+        if (index === -1 || index === stack.length - 1) {
+            return;
+        }
+        const [layer] = stack.splice(index, 1);
+        stack.push(layer);
+    }
+    describeMissingEndpoint(req) {
+        const method = typeof req.method === 'string' ? req.method.toUpperCase() : 'GET';
+        const target = req.originalUrl || req.url || this.apiBasePath;
+        return `No such endpoint: ${method} ${target}`;
+    }
     start() {
         this.app
             .listen({
@@ -697,7 +750,7 @@ export class ApiServer {
             this.authModule(module);
         }
         module.checkConfig();
-        const base = this.config.apiBasePath ?? '/api';
+        const base = this.apiBasePath;
         const ns = module.namespace;
         const mountPath = `${base}${ns}`;
         module.mountpath = mountPath;
@@ -709,6 +762,7 @@ export class ApiServer {
             }
         });
         this.app.use(mountPath, router);
+        this.ensureApiNotFoundOrdering();
         return this;
     }
     dumpRequest(apiReq) {

package/package.json

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