@technomoron/api-server-base 1.0.23 → 1.0.24

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

@@ -49,13 +49,15 @@ export type ApiRoute = {
         req: ApiAuthClass;
     };
 };
-export interface IApiServer {
-    addRoutes(routes: ApiRoute[]): void;
-}
-export declare class ApiModule<T extends IApiServer = ApiServer> {
-    protected server: T;
-    init(server: T): this;
-    protected define_routes(): ApiRoute[];
+export declare class ApiModule<T extends ApiServer> {
+    server: T;
+    namespace: string;
+    mountpath: string;
+    static defaultNamespace: string;
+    constructor(opts?: {
+        namespace?: string;
+    });
+    defineRoutes(): ApiRoute[];
 }
 export interface ApiErrorParams {
     code?: number;
@@ -79,11 +81,11 @@ export interface ApiServerConf {
     debug?: boolean;
     accessExpire?: number;
     refreshExpire?: number;
+    apiBasePath?: string;
 }
 export declare class ApiServer {
     app: Application;
     currReq: ApiRequest | null;
-    private routerV1;
     readonly config: ApiServerConf;
     jwtSign(payload: any, secret: string, expiresInSeconds: number, options?: SignOptions): JwtSignResult;
     jwtVerify<T>(token: string, secret: string, options?: VerifyOptions): JwtVerifyResult<T>;
@@ -111,6 +113,8 @@ export declare class ApiServer {
         accessToken?: string;
         userId?: unknown;
     }): Promise<number>;
+    verifyPassword(password: string, hash: string): Promise<boolean>;
+    filterUser<T = any, U = any>(fullUser: T): U;
     constructor(config: ApiServerConf);
     guessExceptionText(error: any, defMsg?: string): string;
     protected authorize(apiReq: ApiRequest, requiredClass: ApiAuthClass): Promise<void>;
@@ -119,8 +123,7 @@ export declare class ApiServer {
     private verifyJWT;
     private authenticate;
     private handle_request;
-    addRoutes(routes: ApiRoute[]): void;
-    api<T extends ApiModule<IApiServer>>(ApiModuleClass: new () => T): this;
+    api<T extends ApiModule<any>>(module: T): this;
     dumpRequest(apiReq: ApiRequest): void;
 }
 export default ApiServer;

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

@@ -16,16 +16,16 @@ const express_1 = __importDefault(require("express"));
 const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
 const multer_1 = __importDefault(require("multer"));
 class ApiModule {
-    init(server) {
-        this.server = server;
-        server.addRoutes(this.define_routes());
-        return this;
+    constructor(opts = {}) {
+        this.mountpath = '';
+        this.namespace = opts.namespace ?? this.constructor.defaultNamespace ?? '';
     }
-    define_routes() {
+    defineRoutes() {
         return [];
     }
 }
 exports.ApiModule = ApiModule;
+ApiModule.defaultNamespace = '';
 function guess_exception_text(error, defMsg = 'Unknown Error') {
     const msg = [];
     if (typeof error === 'string' && error.trim() !== '') {
@@ -141,6 +141,12 @@ class ApiServer {
     async deleteToken(params) {
         throw new Error('deleteToken() not implemented');
     }
+    async verifyPassword(password, hash) {
+        throw new Error('verifyPassword() not implemented');
+    }
+    filterUser(fullUser) {
+        return fullUser;
+    }
     constructor(config) {
         this.currReq = null;
         config.jwtSecret || (config.jwtSecret = '');
@@ -152,15 +158,14 @@ class ApiServer {
         config.apiPort || (config.apiPort = 3101);
         config.accessExpire || (config.accessExpire = 60 * 15); // 15 minutes default
         config.refreshExpire || (config.refreshExpire = 30 * 24 * 60 * 60); // 30 days
+        config.apiBasePath ?? (config.apiBasePath = '/api');
         this.config = config;
-        this.routerV1 = express_1.default.Router();
         this.app = (0, express_1.default)();
         if (config.uploadPath) {
             const upload = (0, multer_1.default)({ dest: config.uploadPath });
             this.app.use(upload.any());
         }
         this.middlewares();
-        this.app.use('/api/v1', this.routerV1);
         // addSwaggerUi(this.app);
     }
     guessExceptionText(error, defMsg = 'Unkown Error') {
@@ -319,30 +324,21 @@ class ApiServer {
             }
         };
     }
-    addRoutes(routes) {
-        routes.forEach((route) => {
-            const handler = this.handle_request(route.handler, route.auth);
-            switch (route.method) {
-                case 'get':
-                    this.routerV1.get(route.path, handler);
-                    break;
-                case 'post':
-                    this.routerV1.post(route.path, handler);
-                    break;
-                case 'put':
-                    this.routerV1.put(route.path, handler);
-                    break;
-                case 'delete':
-                    this.routerV1.delete(route.path, handler);
-                    break;
-                default:
-                    throw new Error(`Unsupported method: ${route.method}`);
+    api(module) {
+        const router = express_1.default.Router();
+        module.server = this;
+        const base = this.config.apiBasePath ?? '/api';
+        const ns = module.namespace;
+        const mountPath = `${base}${ns}`;
+        module.mountpath = mountPath;
+        module.defineRoutes().forEach((r) => {
+            const handler = this.handle_request(r.handler, r.auth);
+            router[r.method](r.path, handler);
+            if (this.config.debug) {
+                console.log(`Adding ${mountPath}${r.path} (${r.method.toUpperCase()})`);
             }
         });
-    }
-    api(ApiModuleClass) {
-        const moduleInstance = new ApiModuleClass();
-        moduleInstance.init(this); // docServer should be a valid IApiServer.
+        this.app.use(mountPath, router);
         return this;
     }
     dumpRequest(apiReq) {

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

@@ -49,13 +49,15 @@ export type ApiRoute = {
         req: ApiAuthClass;
     };
 };
-export interface IApiServer {
-    addRoutes(routes: ApiRoute[]): void;
-}
-export declare class ApiModule<T extends IApiServer = ApiServer> {
-    protected server: T;
-    init(server: T): this;
-    protected define_routes(): ApiRoute[];
+export declare class ApiModule<T extends ApiServer> {
+    server: T;
+    namespace: string;
+    mountpath: string;
+    static defaultNamespace: string;
+    constructor(opts?: {
+        namespace?: string;
+    });
+    defineRoutes(): ApiRoute[];
 }
 export interface ApiErrorParams {
     code?: number;
@@ -79,11 +81,11 @@ export interface ApiServerConf {
     debug?: boolean;
     accessExpire?: number;
     refreshExpire?: number;
+    apiBasePath?: string;
 }
 export declare class ApiServer {
     app: Application;
     currReq: ApiRequest | null;
-    private routerV1;
     readonly config: ApiServerConf;
     jwtSign(payload: any, secret: string, expiresInSeconds: number, options?: SignOptions): JwtSignResult;
     jwtVerify<T>(token: string, secret: string, options?: VerifyOptions): JwtVerifyResult<T>;
@@ -111,6 +113,8 @@ export declare class ApiServer {
         accessToken?: string;
         userId?: unknown;
     }): Promise<number>;
+    verifyPassword(password: string, hash: string): Promise<boolean>;
+    filterUser<T = any, U = any>(fullUser: T): U;
     constructor(config: ApiServerConf);
     guessExceptionText(error: any, defMsg?: string): string;
     protected authorize(apiReq: ApiRequest, requiredClass: ApiAuthClass): Promise<void>;
@@ -119,8 +123,7 @@ export declare class ApiServer {
     private verifyJWT;
     private authenticate;
     private handle_request;
-    addRoutes(routes: ApiRoute[]): void;
-    api<T extends ApiModule<IApiServer>>(ApiModuleClass: new () => T): this;
+    api<T extends ApiModule<any>>(module: T): this;
     dumpRequest(apiReq: ApiRequest): void;
 }
 export default ApiServer;

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

@@ -10,15 +10,15 @@ import express from 'express';
 import jwt from 'jsonwebtoken';
 import multer from 'multer';
 export class ApiModule {
-    init(server) {
-        this.server = server;
-        server.addRoutes(this.define_routes());
-        return this;
+    constructor(opts = {}) {
+        this.mountpath = '';
+        this.namespace = opts.namespace ?? this.constructor.defaultNamespace ?? '';
     }
-    define_routes() {
+    defineRoutes() {
         return [];
     }
 }
+ApiModule.defaultNamespace = '';
 function guess_exception_text(error, defMsg = 'Unknown Error') {
     const msg = [];
     if (typeof error === 'string' && error.trim() !== '') {
@@ -133,6 +133,12 @@ export class ApiServer {
     async deleteToken(params) {
         throw new Error('deleteToken() not implemented');
     }
+    async verifyPassword(password, hash) {
+        throw new Error('verifyPassword() not implemented');
+    }
+    filterUser(fullUser) {
+        return fullUser;
+    }
     constructor(config) {
         this.currReq = null;
         config.jwtSecret || (config.jwtSecret = '');
@@ -144,15 +150,14 @@ export class ApiServer {
         config.apiPort || (config.apiPort = 3101);
         config.accessExpire || (config.accessExpire = 60 * 15); // 15 minutes default
         config.refreshExpire || (config.refreshExpire = 30 * 24 * 60 * 60); // 30 days
+        config.apiBasePath ?? (config.apiBasePath = '/api');
         this.config = config;
-        this.routerV1 = express.Router();
         this.app = express();
         if (config.uploadPath) {
             const upload = multer({ dest: config.uploadPath });
             this.app.use(upload.any());
         }
         this.middlewares();
-        this.app.use('/api/v1', this.routerV1);
         // addSwaggerUi(this.app);
     }
     guessExceptionText(error, defMsg = 'Unkown Error') {
@@ -311,30 +316,21 @@ export class ApiServer {
             }
         };
     }
-    addRoutes(routes) {
-        routes.forEach((route) => {
-            const handler = this.handle_request(route.handler, route.auth);
-            switch (route.method) {
-                case 'get':
-                    this.routerV1.get(route.path, handler);
-                    break;
-                case 'post':
-                    this.routerV1.post(route.path, handler);
-                    break;
-                case 'put':
-                    this.routerV1.put(route.path, handler);
-                    break;
-                case 'delete':
-                    this.routerV1.delete(route.path, handler);
-                    break;
-                default:
-                    throw new Error(`Unsupported method: ${route.method}`);
+    api(module) {
+        const router = express.Router();
+        module.server = this;
+        const base = this.config.apiBasePath ?? '/api';
+        const ns = module.namespace;
+        const mountPath = `${base}${ns}`;
+        module.mountpath = mountPath;
+        module.defineRoutes().forEach((r) => {
+            const handler = this.handle_request(r.handler, r.auth);
+            router[r.method](r.path, handler);
+            if (this.config.debug) {
+                console.log(`Adding ${mountPath}${r.path} (${r.method.toUpperCase()})`);
             }
         });
-    }
-    api(ApiModuleClass) {
-        const moduleInstance = new ApiModuleClass();
-        moduleInstance.init(this); // docServer should be a valid IApiServer.
+        this.app.use(mountPath, router);
         return this;
     }
     dumpRequest(apiReq) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@technomoron/api-server-base",
-	"version": "1.0.23",
+	"version": "1.0.24",
 	"description": "Api Server Skeleton / Base Class",
 	"main": "dist/cjs/api-server-base.js",
 	"module": "dist/esm/api-server-base.js",