@technomoron/api-server-base 1.0.23 → 1.0.25

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> {
+    server: T;
+    namespace: string;
+    mountpath: string;
+    static defaultNamespace: string;
+    constructor(opts?: {
+        namespace?: string;
+    });
+    defineRoutes(): ApiRoute[];
 }
 export interface ApiErrorParams {
     code?: number;
@@ -70,21 +72,28 @@ export declare class ApiError extends Error {
     constructor({ code, message, data, errors }: ApiErrorParams);
 }
 export interface ApiServerConf {
-    jwtSecret?: string;
-    apiPort?: number;
-    apiHost?: string;
-    uploadPath?: string;
-    uploadMax?: number;
-    origins?: string[];
-    debug?: boolean;
-    accessExpire?: number;
-    refreshExpire?: number;
+    apiPort: number;
+    apiHost: string;
+    uploadPath: string;
+    uploadMax: number;
+    origins: string[];
+    debug: boolean;
+    apiBasePath: string;
+    accessSecret: string;
+    refreshSecret: string;
+    cookieDomain: string;
+    accessCookie: string;
+    refreshCookie: string;
+    accessExpiry: number;
+    refreshExpiry: number;
+    authApi: boolean;
+    devMode: boolean;
 }
 export declare class ApiServer {
     app: Application;
     currReq: ApiRequest | null;
-    private routerV1;
     readonly config: ApiServerConf;
+    constructor(config?: Partial<ApiServerConf>);
     jwtSign(payload: any, secret: string, expiresInSeconds: number, options?: SignOptions): JwtSignResult;
     jwtVerify<T>(token: string, secret: string, options?: VerifyOptions): JwtVerifyResult<T>;
     jwtDecode<T>(token: string, options?: jwt.DecodeOptions): JwtDecodeResult<T>;
@@ -95,6 +104,9 @@ export declare class ApiServer {
         access: string;
         refresh: string;
         userId: unknown;
+        domain?: string;
+        fingerprint?: string;
+        label?: string;
     }): Promise<void>;
     getToken(params: {
         accessToken?: string;
@@ -110,8 +122,12 @@ export declare class ApiServer {
         refreshToken?: string;
         accessToken?: string;
         userId?: unknown;
+        domain?: string;
+        fingerprint?: string;
+        label?: string;
     }): Promise<number>;
-    constructor(config: ApiServerConf);
+    verifyPassword(password: string, hash: string): Promise<boolean>;
+    filterUser<T = any, U = any>(fullUser: T): U;
     guessExceptionText(error: any, defMsg?: string): string;
     protected authorize(apiReq: ApiRequest, requiredClass: ApiAuthClass): Promise<void>;
     private middlewares;
@@ -119,8 +135,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() !== '') {
@@ -52,7 +52,38 @@ class ApiError extends Error {
     }
 }
 exports.ApiError = ApiError;
+function fillConfig(config) {
+    return {
+        apiPort: config.apiPort ?? 3101,
+        apiHost: config.apiHost ?? 'localhost',
+        uploadPath: config.uploadPath ?? '',
+        uploadMax: config.uploadMax ?? 30 * 1024 * 1024,
+        origins: config.origins ?? [],
+        debug: config.debug ?? false,
+        apiBasePath: config.apiBasePath ?? '/api',
+        accessSecret: config.accessSecret ?? '',
+        refreshSecret: config.refreshSecret ?? '',
+        cookieDomain: config.cookieDomain ?? '.somewhere-over-the-rainbow.com',
+        accessCookie: config.accessCookie ?? 'dat',
+        refreshCookie: config.refreshCookie ?? 'drt',
+        accessExpiry: config.accessExpiry ?? 60 * 15,
+        refreshExpiry: config.refreshExpiry ?? 30 * 24 * 60 * 60 * 1000,
+        authApi: config.authApi ?? false,
+        devMode: config.devMode ?? false
+    };
+}
 class ApiServer {
+    constructor(config = {}) {
+        this.currReq = null;
+        this.config = fillConfig(config);
+        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();
+        // addSwaggerUi(this.app);
+    }
     jwtSign(payload, secret, expiresInSeconds, options) {
         options || (options = {});
         const opts = { ...options, expiresIn: expiresInSeconds };
@@ -141,27 +172,11 @@ class ApiServer {
     async deleteToken(params) {
         throw new Error('deleteToken() not implemented');
     }
-    constructor(config) {
-        this.currReq = null;
-        config.jwtSecret || (config.jwtSecret = '');
-        config.uploadMax || (config.uploadMax = 30 * 1024 * 1024);
-        config.uploadPath || (config.uploadPath = '');
-        config.origins || (config.origins = []);
-        config.debug || (config.debug = false);
-        config.apiHost || (config.apiHost = 'localhost');
-        config.apiPort || (config.apiPort = 3101);
-        config.accessExpire || (config.accessExpire = 60 * 15); // 15 minutes default
-        config.refreshExpire || (config.refreshExpire = 30 * 24 * 60 * 60); // 30 days
-        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);
+    async verifyPassword(password, hash) {
+        throw new Error('verifyPassword() not implemented');
+    }
+    filterUser(fullUser) {
+        return fullUser;
     }
     guessExceptionText(error, defMsg = 'Unkown Error') {
         return guess_exception_text(error, defMsg);
@@ -214,10 +229,10 @@ class ApiServer {
         return this;
     }
     async verifyJWT(token) {
-        if (!this.config.jwtSecret) {
+        if (!this.config.accessSecret) {
             return { tokenData: undefined, error: 'JWT authentication disabled; no jwtSecret set' };
         }
-        const result = this.jwtVerify(token, this.config.jwtSecret);
+        const result = this.jwtVerify(token, this.config.accessSecret);
         if (!result.success) {
             return { tokenData: undefined, error: result.error };
         }
@@ -319,30 +334,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> {
+    server: T;
+    namespace: string;
+    mountpath: string;
+    static defaultNamespace: string;
+    constructor(opts?: {
+        namespace?: string;
+    });
+    defineRoutes(): ApiRoute[];
 }
 export interface ApiErrorParams {
     code?: number;
@@ -70,21 +72,28 @@ export declare class ApiError extends Error {
     constructor({ code, message, data, errors }: ApiErrorParams);
 }
 export interface ApiServerConf {
-    jwtSecret?: string;
-    apiPort?: number;
-    apiHost?: string;
-    uploadPath?: string;
-    uploadMax?: number;
-    origins?: string[];
-    debug?: boolean;
-    accessExpire?: number;
-    refreshExpire?: number;
+    apiPort: number;
+    apiHost: string;
+    uploadPath: string;
+    uploadMax: number;
+    origins: string[];
+    debug: boolean;
+    apiBasePath: string;
+    accessSecret: string;
+    refreshSecret: string;
+    cookieDomain: string;
+    accessCookie: string;
+    refreshCookie: string;
+    accessExpiry: number;
+    refreshExpiry: number;
+    authApi: boolean;
+    devMode: boolean;
 }
 export declare class ApiServer {
     app: Application;
     currReq: ApiRequest | null;
-    private routerV1;
     readonly config: ApiServerConf;
+    constructor(config?: Partial<ApiServerConf>);
     jwtSign(payload: any, secret: string, expiresInSeconds: number, options?: SignOptions): JwtSignResult;
     jwtVerify<T>(token: string, secret: string, options?: VerifyOptions): JwtVerifyResult<T>;
     jwtDecode<T>(token: string, options?: jwt.DecodeOptions): JwtDecodeResult<T>;
@@ -95,6 +104,9 @@ export declare class ApiServer {
         access: string;
         refresh: string;
         userId: unknown;
+        domain?: string;
+        fingerprint?: string;
+        label?: string;
     }): Promise<void>;
     getToken(params: {
         accessToken?: string;
@@ -110,8 +122,12 @@ export declare class ApiServer {
         refreshToken?: string;
         accessToken?: string;
         userId?: unknown;
+        domain?: string;
+        fingerprint?: string;
+        label?: string;
     }): Promise<number>;
-    constructor(config: ApiServerConf);
+    verifyPassword(password: string, hash: string): Promise<boolean>;
+    filterUser<T = any, U = any>(fullUser: T): U;
     guessExceptionText(error: any, defMsg?: string): string;
     protected authorize(apiReq: ApiRequest, requiredClass: ApiAuthClass): Promise<void>;
     private middlewares;
@@ -119,8 +135,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() !== '') {
@@ -44,7 +44,38 @@ export class ApiError extends Error {
         this.errors = errors !== undefined ? errors : {};
     }
 }
+function fillConfig(config) {
+    return {
+        apiPort: config.apiPort ?? 3101,
+        apiHost: config.apiHost ?? 'localhost',
+        uploadPath: config.uploadPath ?? '',
+        uploadMax: config.uploadMax ?? 30 * 1024 * 1024,
+        origins: config.origins ?? [],
+        debug: config.debug ?? false,
+        apiBasePath: config.apiBasePath ?? '/api',
+        accessSecret: config.accessSecret ?? '',
+        refreshSecret: config.refreshSecret ?? '',
+        cookieDomain: config.cookieDomain ?? '.somewhere-over-the-rainbow.com',
+        accessCookie: config.accessCookie ?? 'dat',
+        refreshCookie: config.refreshCookie ?? 'drt',
+        accessExpiry: config.accessExpiry ?? 60 * 15,
+        refreshExpiry: config.refreshExpiry ?? 30 * 24 * 60 * 60 * 1000,
+        authApi: config.authApi ?? false,
+        devMode: config.devMode ?? false
+    };
+}
 export class ApiServer {
+    constructor(config = {}) {
+        this.currReq = null;
+        this.config = fillConfig(config);
+        this.app = express();
+        if (config.uploadPath) {
+            const upload = multer({ dest: config.uploadPath });
+            this.app.use(upload.any());
+        }
+        this.middlewares();
+        // addSwaggerUi(this.app);
+    }
     jwtSign(payload, secret, expiresInSeconds, options) {
         options || (options = {});
         const opts = { ...options, expiresIn: expiresInSeconds };
@@ -133,27 +164,11 @@ export class ApiServer {
     async deleteToken(params) {
         throw new Error('deleteToken() not implemented');
     }
-    constructor(config) {
-        this.currReq = null;
-        config.jwtSecret || (config.jwtSecret = '');
-        config.uploadMax || (config.uploadMax = 30 * 1024 * 1024);
-        config.uploadPath || (config.uploadPath = '');
-        config.origins || (config.origins = []);
-        config.debug || (config.debug = false);
-        config.apiHost || (config.apiHost = 'localhost');
-        config.apiPort || (config.apiPort = 3101);
-        config.accessExpire || (config.accessExpire = 60 * 15); // 15 minutes default
-        config.refreshExpire || (config.refreshExpire = 30 * 24 * 60 * 60); // 30 days
-        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);
+    async verifyPassword(password, hash) {
+        throw new Error('verifyPassword() not implemented');
+    }
+    filterUser(fullUser) {
+        return fullUser;
     }
     guessExceptionText(error, defMsg = 'Unkown Error') {
         return guess_exception_text(error, defMsg);
@@ -206,10 +221,10 @@ export class ApiServer {
         return this;
     }
     async verifyJWT(token) {
-        if (!this.config.jwtSecret) {
+        if (!this.config.accessSecret) {
             return { tokenData: undefined, error: 'JWT authentication disabled; no jwtSecret set' };
         }
-        const result = this.jwtVerify(token, this.config.jwtSecret);
+        const result = this.jwtVerify(token, this.config.accessSecret);
         if (!result.success) {
             return { tokenData: undefined, error: result.error };
         }
@@ -311,30 +326,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.25",
 	"description": "Api Server Skeleton / Base Class",
 	"main": "dist/cjs/api-server-base.js",
 	"module": "dist/esm/api-server-base.js",