@digitaldefiance/node-express-suite 3.7.5 → 3.8.0

package/src/responses/response-builder.d.ts

@@ -0,0 +1,103 @@
+/**
+ * @fileoverview Response builder for API responses.
+ * Provides fluent API for building HTTP responses with status codes.
+ * @module responses/response-builder
+ */
+import { SuiteCoreStringKey } from '@digitaldefiance/suite-core-lib';
+import { IStatusCodeResponse } from '../interfaces';
+import { ApiResponse } from '../types';
+/**
+ * Builder for constructing API responses with fluent interface.
+ * @template T - Response type extending ApiResponse
+ */
+export declare class ResponseBuilder<T extends ApiResponse = ApiResponse> {
+    private statusCode;
+    private responseData;
+    private responseHeaders?;
+    /**
+     * Creates a 200 OK response builder.
+     * @template T - Response type
+     * @returns {ResponseBuilder<T>} Response builder instance
+     */
+    static ok<T extends ApiResponse = ApiResponse>(): ResponseBuilder<T>;
+    /**
+     * Creates a 201 Created response builder.
+     * @template T - Response type
+     * @returns {ResponseBuilder<T>} Response builder instance
+     */
+    static created<T extends ApiResponse = ApiResponse>(): ResponseBuilder<T>;
+    /**
+     * Creates a 202 Accepted response builder.
+     * @template T - Response type
+     * @returns {ResponseBuilder<T>} Response builder instance
+     */
+    static accepted<T extends ApiResponse = ApiResponse>(): ResponseBuilder<T>;
+    /**
+     * Creates a 204 No Content response builder.
+     * @returns {ResponseBuilder<ApiResponse>} Response builder instance
+     */
+    static noContent(): ResponseBuilder<ApiResponse>;
+    /**
+     * Creates a 400 Bad Request response builder.
+     * @template T - Response type
+     * @returns {ResponseBuilder<T>} Response builder instance
+     */
+    static badRequest<T extends ApiResponse = ApiResponse>(): ResponseBuilder<T>;
+    /**
+     * Creates a 401 Unauthorized response builder.
+     * @template T - Response type
+     * @returns {ResponseBuilder<T>} Response builder instance
+     */
+    static unauthorized<T extends ApiResponse = ApiResponse>(): ResponseBuilder<T>;
+    /**
+     * Creates a 403 Forbidden response builder.
+     * @template T - Response type
+     * @returns {ResponseBuilder<T>} Response builder instance
+     */
+    static forbidden<T extends ApiResponse = ApiResponse>(): ResponseBuilder<T>;
+    /**
+     * Creates a 404 Not Found response builder.
+     * @template T - Response type
+     * @returns {ResponseBuilder<T>} Response builder instance
+     */
+    static notFound<T extends ApiResponse = ApiResponse>(): ResponseBuilder<T>;
+    /**
+     * Creates a 500 Internal Server Error response builder.
+     * @template T - Response type
+     * @returns {ResponseBuilder<T>} Response builder instance
+     */
+    static error<T extends ApiResponse = ApiResponse>(): ResponseBuilder<T>;
+    /**
+     * Sets the HTTP status code.
+     * @param {number} code - HTTP status code
+     * @returns {this} This builder instance for chaining
+     */
+    status(code: number): this;
+    /**
+     * Sets a translatable message on the response.
+     * @param {SuiteCoreStringKey} key - Translation key
+     * @param {Record<string, string>} [params] - Translation parameters
+     * @param {string} [language] - Target language
+     * @returns {this} This builder instance for chaining
+     */
+    message(key: SuiteCoreStringKey, params?: Record<string, string>, language?: string): this;
+    /**
+     * Sets response data.
+     * @param {Partial<T>} data - Response data to merge
+     * @returns {this} This builder instance for chaining
+     */
+    data(data: Partial<T>): this;
+    /**
+     * Sets response headers.
+     * @param {Record<string, string>} headers - HTTP headers
+     * @returns {this} This builder instance for chaining
+     */
+    headers(headers: Record<string, string>): this;
+    /**
+     * Builds the final response object.
+     * @returns {IStatusCodeResponse<T>} Complete response with status code and headers
+     */
+    build(): IStatusCodeResponse<T>;
+}
+export declare const Response: typeof ResponseBuilder;
+//# sourceMappingURL=response-builder.d.ts.map

package/src/responses/response-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-builder.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-node-express-suite/src/responses/response-builder.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAEL,kBAAkB,EACnB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC;;;GAGG;AACH,qBAAa,eAAe,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW;IAC9D,OAAO,CAAC,UAAU,CAAe;IACjC,OAAO,CAAC,YAAY,CAAkB;IACtC,OAAO,CAAC,eAAe,CAAC,CAAyB;IAEjD;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,KAAK,eAAe,CAAC,CAAC,CAAC;IAIpE;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,KAAK,eAAe,CAAC,CAAC,CAAC;IAIzE;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,KAAK,eAAe,CAAC,CAAC,CAAC;IAI1E;;;OAGG;IACH,MAAM,CAAC,SAAS,IAAI,eAAe,CAAC,WAAW,CAAC;IAIhD;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,KAAK,eAAe,CAAC,CAAC,CAAC;IAI5E;;;;OAIG;IACH,MAAM,CAAC,YAAY,CACjB,CAAC,SAAS,WAAW,GAAG,WAAW,KAChC,eAAe,CAAC,CAAC,CAAC;IAIvB;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,KAAK,eAAe,CAAC,CAAC,CAAC;IAI3E;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,KAAK,eAAe,CAAC,CAAC,CAAC;IAI1E;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,KAAK,eAAe,CAAC,CAAC,CAAC;IAIvE;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAK1B;;;;;;OAMG;IACH,OAAO,CACL,GAAG,EAAE,kBAAkB,EACvB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC/B,QAAQ,CAAC,EAAE,MAAM,GAChB,IAAI;IAMP;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI;IAK5B;;;;OAIG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI;IAK9C;;;OAGG;IACH,KAAK,IAAI,mBAAmB,CAAC,CAAC,CAAC;CAOhC;AAED,eAAO,MAAM,QAAQ,wBAAkB,CAAC"}

package/src/responses/response-builder.js

@@ -0,0 +1,142 @@
+"use strict";
+/**
+ * @fileoverview Response builder for API responses.
+ * Provides fluent API for building HTTP responses with status codes.
+ * @module responses/response-builder
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Response = exports.ResponseBuilder = void 0;
+const suite_core_lib_1 = require("@digitaldefiance/suite-core-lib");
+/**
+ * Builder for constructing API responses with fluent interface.
+ * @template T - Response type extending ApiResponse
+ */
+class ResponseBuilder {
+    statusCode = 200;
+    responseData = {};
+    responseHeaders;
+    /**
+     * Creates a 200 OK response builder.
+     * @template T - Response type
+     * @returns {ResponseBuilder<T>} Response builder instance
+     */
+    static ok() {
+        return new ResponseBuilder().status(200);
+    }
+    /**
+     * Creates a 201 Created response builder.
+     * @template T - Response type
+     * @returns {ResponseBuilder<T>} Response builder instance
+     */
+    static created() {
+        return new ResponseBuilder().status(201);
+    }
+    /**
+     * Creates a 202 Accepted response builder.
+     * @template T - Response type
+     * @returns {ResponseBuilder<T>} Response builder instance
+     */
+    static accepted() {
+        return new ResponseBuilder().status(202);
+    }
+    /**
+     * Creates a 204 No Content response builder.
+     * @returns {ResponseBuilder<ApiResponse>} Response builder instance
+     */
+    static noContent() {
+        return new ResponseBuilder().status(204);
+    }
+    /**
+     * Creates a 400 Bad Request response builder.
+     * @template T - Response type
+     * @returns {ResponseBuilder<T>} Response builder instance
+     */
+    static badRequest() {
+        return new ResponseBuilder().status(400);
+    }
+    /**
+     * Creates a 401 Unauthorized response builder.
+     * @template T - Response type
+     * @returns {ResponseBuilder<T>} Response builder instance
+     */
+    static unauthorized() {
+        return new ResponseBuilder().status(401);
+    }
+    /**
+     * Creates a 403 Forbidden response builder.
+     * @template T - Response type
+     * @returns {ResponseBuilder<T>} Response builder instance
+     */
+    static forbidden() {
+        return new ResponseBuilder().status(403);
+    }
+    /**
+     * Creates a 404 Not Found response builder.
+     * @template T - Response type
+     * @returns {ResponseBuilder<T>} Response builder instance
+     */
+    static notFound() {
+        return new ResponseBuilder().status(404);
+    }
+    /**
+     * Creates a 500 Internal Server Error response builder.
+     * @template T - Response type
+     * @returns {ResponseBuilder<T>} Response builder instance
+     */
+    static error() {
+        return new ResponseBuilder().status(500);
+    }
+    /**
+     * Sets the HTTP status code.
+     * @param {number} code - HTTP status code
+     * @returns {this} This builder instance for chaining
+     */
+    status(code) {
+        this.statusCode = code;
+        return this;
+    }
+    /**
+     * Sets a translatable message on the response.
+     * @param {SuiteCoreStringKey} key - Translation key
+     * @param {Record<string, string>} [params] - Translation parameters
+     * @param {string} [language] - Target language
+     * @returns {this} This builder instance for chaining
+     */
+    message(key, params, language) {
+        this.responseData.message =
+            (0, suite_core_lib_1.getSuiteCoreTranslation)(key, params, language);
+        return this;
+    }
+    /**
+     * Sets response data.
+     * @param {Partial<T>} data - Response data to merge
+     * @returns {this} This builder instance for chaining
+     */
+    data(data) {
+        this.responseData = { ...this.responseData, ...data };
+        return this;
+    }
+    /**
+     * Sets response headers.
+     * @param {Record<string, string>} headers - HTTP headers
+     * @returns {this} This builder instance for chaining
+     */
+    headers(headers) {
+        this.responseHeaders = headers;
+        return this;
+    }
+    /**
+     * Builds the final response object.
+     * @returns {IStatusCodeResponse<T>} Complete response with status code and headers
+     */
+    build() {
+        return {
+            statusCode: this.statusCode,
+            response: this.responseData,
+            ...(this.responseHeaders ? { headers: this.responseHeaders } : {}),
+        };
+    }
+}
+exports.ResponseBuilder = ResponseBuilder;
+exports.Response = ResponseBuilder;
+//# sourceMappingURL=response-builder.js.map

package/src/responses/response-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-builder.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-node-express-suite/src/responses/response-builder.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAGH,oEAGyC;AAIzC;;;GAGG;AACH,MAAa,eAAe;IAClB,UAAU,GAAW,GAAG,CAAC;IACzB,YAAY,GAAe,EAAE,CAAC;IAC9B,eAAe,CAA0B;IAEjD;;;;OAIG;IACH,MAAM,CAAC,EAAE;QACP,OAAO,IAAI,eAAe,EAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,OAAO;QACZ,OAAO,IAAI,eAAe,EAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ;QACb,OAAO,IAAI,eAAe,EAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,SAAS;QACd,OAAO,IAAI,eAAe,EAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,UAAU;QACf,OAAO,IAAI,eAAe,EAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,YAAY;QAGjB,OAAO,IAAI,eAAe,EAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAS;QACd,OAAO,IAAI,eAAe,EAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ;QACb,OAAO,IAAI,eAAe,EAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK;QACV,OAAO,IAAI,eAAe,EAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,IAAY;QACjB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CACL,GAAuB,EACvB,MAA+B,EAC/B,QAAiB;QAEhB,IAAI,CAAC,YAAyC,CAAC,OAAO;YACrD,IAAA,wCAAuB,EAAC,GAAG,EAAE,MAAM,EAAE,QAA4B,CAAC,CAAC;QACrE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,IAAgB;QACnB,IAAI,CAAC,YAAY,GAAG,EAAE,GAAG,IAAI,CAAC,YAAY,EAAE,GAAG,IAAI,EAAE,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,OAA+B;QACrC,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,OAAO;YACL,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,QAAQ,EAAE,IAAI,CAAC,YAAiB;YAChC,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACnE,CAAC;IACJ,CAAC;CACF;AAjJD,0CAiJC;AAEY,QAAA,QAAQ,GAAG,eAAe,CAAC"}

package/src/routers/api.d.ts

@@ -0,0 +1,59 @@
+/**
+ * @fileoverview API router configuration with dependency injection and service registration.
+ * Manages user controller and all required services for API endpoints.
+ * @module routers/api
+ */
+import { PlatformID } from '@digitaldefiance/node-ecies-lib';
+import { ITokenRole, ITokenUser, IUserBase } from '@digitaldefiance/suite-core-lib';
+import { IBaseDocument } from '../documents';
+import { Environment } from '../environment';
+import { IConstants } from '../interfaces';
+import { IApplication } from '../interfaces/application';
+import { BaseRouter } from './base';
+import { CoreLanguageCode } from '@digitaldefiance/i18n-lib';
+/**
+ * Router for the API endpoints.
+ * Manages user controller and registers all required services via dependency injection.
+ * @template TID Platform-specific ID type
+ * @template TDate Date type
+ * @template TLanguage Site language string literal type
+ * @template TAccountStatus Account status string literal type
+ * @template TUser User base type
+ * @template TTokenRole Token role type
+ * @template TBaseDocument Base document type
+ * @template TTokenUser Token user type
+ * @template TConstants Constants type
+ * @template TEnvironment Environment type
+ * @template TApplication Application type
+ */
+export declare class ApiRouter<TID extends PlatformID, TDate extends Date, TLanguage extends CoreLanguageCode, TAccountStatus extends string, TUser extends IUserBase<TID, TDate, TLanguage, TAccountStatus> = IUserBase<TID, TDate, TLanguage, TAccountStatus>, TTokenRole extends ITokenRole<TID, TDate> = ITokenRole<TID, TDate>, TBaseDocument extends IBaseDocument<any, TID> = IBaseDocument<any, TID>, TTokenUser extends ITokenUser = ITokenUser, TConstants extends IConstants = IConstants, TEnvironment extends Environment<TID> = Environment<TID>, TApplication extends IApplication<TID> = IApplication<TID>> extends BaseRouter<TID, TApplication> {
+    /** User controller for handling user-related API endpoints */
+    private readonly userController;
+    /** JWT service for token generation and validation */
+    private readonly jwtService;
+    /** Email service for sending emails */
+    private readonly emailService;
+    /** User service for user management operations */
+    private readonly userService;
+    /** Role service for role management operations */
+    private readonly roleService;
+    /** Key wrapping service for password-based encryption */
+    private readonly keyWrappingService;
+    /** ECIES service for elliptic curve encryption */
+    private readonly eciesService;
+    /** Backup code service for generating and validating backup codes */
+    private readonly backupCodeService;
+    /**
+     * Creates a new API router instance.
+     * Registers all required services and initializes the user controller.
+     * @param application Application instance with database connection and configuration
+     */
+    constructor(application: TApplication);
+    /**
+     * Registers all required services in the application service container.
+     * Services are registered as singletons and lazily instantiated.
+     * @private
+     */
+    private registerServices;
+}
+//# sourceMappingURL=api.d.ts.map

package/src/routers/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-node-express-suite/src/routers/api.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAgB,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAAO,EACL,UAAU,EACV,UAAU,EACV,SAAS,EACV,MAAM,iCAAiC,CAAC;AAGzC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAQzD,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAE7D;;;;;;;;;;;;;;GAcG;AACH,qBAAa,SAAS,CACpB,GAAG,SAAS,UAAU,EACtB,KAAK,SAAS,IAAI,EAClB,SAAS,SAAS,gBAAgB,EAClC,cAAc,SAAS,MAAM,EAC7B,KAAK,SAAS,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,cAAc,CAAC,GAAG,SAAS,CACxE,GAAG,EACH,KAAK,EACL,SAAS,EACT,cAAc,CACf,EACD,UAAU,SAAS,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,EAClE,aAAa,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,EACvE,UAAU,SAAS,UAAU,GAAG,UAAU,EAC1C,UAAU,SAAS,UAAU,GAAG,UAAU,EAC1C,YAAY,SAAS,WAAW,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,EACxD,YAAY,SAAS,YAAY,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,CAC1D,SAAQ,UAAU,CAAC,GAAG,EAAE,YAAY,CAAC;IACrC,8DAA8D;IAC9D,OAAO,CAAC,QAAQ,CAAC,cAAc,CAS7B;IACF,sDAAsD;IACtD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAMzB;IACF,uCAAuC;IACvC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgB;IAC7C,kDAAkD;IAClD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAY1B;IACF,kDAAkD;IAClD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsC;IAClE,yDAAyD;IACzD,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAqB;IACxD,kDAAkD;IAClD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAoB;IACjD,qEAAqE;IACrE,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAKhC;IACF;;;;OAIG;gBACS,WAAW,EAAE,YAAY;IAgCrC;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;CAgFzB"}

package/src/routers/api.js

@@ -0,0 +1,110 @@
+"use strict";
+/**
+ * @fileoverview API router configuration with dependency injection and service registration.
+ * Manages user controller and all required services for API endpoints.
+ * @module routers/api
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiRouter = void 0;
+const node_ecies_lib_1 = require("@digitaldefiance/node-ecies-lib");
+const container_1 = require("../container");
+const user_1 = require("../controllers/user");
+const registry_1 = require("../registry");
+const backup_code_1 = require("../services/backup-code");
+const jwt_1 = require("../services/jwt");
+const key_wrapping_1 = require("../services/key-wrapping");
+const role_1 = require("../services/role");
+const user_2 = require("../services/user");
+const base_1 = require("./base");
+/**
+ * Router for the API endpoints.
+ * Manages user controller and registers all required services via dependency injection.
+ * @template TID Platform-specific ID type
+ * @template TDate Date type
+ * @template TLanguage Site language string literal type
+ * @template TAccountStatus Account status string literal type
+ * @template TUser User base type
+ * @template TTokenRole Token role type
+ * @template TBaseDocument Base document type
+ * @template TTokenUser Token user type
+ * @template TConstants Constants type
+ * @template TEnvironment Environment type
+ * @template TApplication Application type
+ */
+class ApiRouter extends base_1.BaseRouter {
+    /** User controller for handling user-related API endpoints */
+    userController;
+    /** JWT service for token generation and validation */
+    jwtService;
+    /** Email service for sending emails */
+    emailService;
+    /** User service for user management operations */
+    userService;
+    /** Role service for role management operations */
+    roleService;
+    /** Key wrapping service for password-based encryption */
+    keyWrappingService;
+    /** ECIES service for elliptic curve encryption */
+    eciesService;
+    /** Backup code service for generating and validating backup codes */
+    backupCodeService;
+    /**
+     * Creates a new API router instance.
+     * Registers all required services and initializes the user controller.
+     * @param application Application instance with database connection and configuration
+     */
+    constructor(application) {
+        super(application);
+        this.registerServices();
+        this.jwtService = application.services.get(container_1.ServiceKeys.JWT);
+        this.roleService = application.services.get(container_1.ServiceKeys.ROLE);
+        this.emailService = application.services.get(container_1.ServiceKeys.EMAIL);
+        this.keyWrappingService = application.services.get(container_1.ServiceKeys.KEY_WRAPPING);
+        this.eciesService = application.services.get(container_1.ServiceKeys.ECIES);
+        this.backupCodeService = application.services.get(container_1.ServiceKeys.BACKUP_CODE);
+        this.userService = application.services.get(container_1.ServiceKeys.USER);
+        this.userController = new user_1.UserController(application, this.jwtService, this.userService, this.backupCodeService, this.roleService, this.eciesService);
+        this.router.use('/user', this.userController.router);
+    }
+    /**
+     * Registers all required services in the application service container.
+     * Services are registered as singletons and lazily instantiated.
+     * @private
+     */
+    registerServices() {
+        const app = this.application;
+        if (!app.services.has(container_1.ServiceKeys.JWT)) {
+            app.services.register(container_1.ServiceKeys.JWT, () => new jwt_1.JwtService(app));
+        }
+        if (!app.services.has(container_1.ServiceKeys.ROLE)) {
+            app.services.register(container_1.ServiceKeys.ROLE, () => new role_1.RoleService(app));
+        }
+        if (!app.services.has(container_1.ServiceKeys.EMAIL)) {
+            app.services.register(container_1.ServiceKeys.EMAIL, () => registry_1.emailServiceRegistry.getService());
+        }
+        if (!app.services.has(container_1.ServiceKeys.KEY_WRAPPING)) {
+            app.services.register(container_1.ServiceKeys.KEY_WRAPPING, () => new key_wrapping_1.KeyWrappingService());
+        }
+        if (!app.services.has(container_1.ServiceKeys.ECIES)) {
+            app.services.register(container_1.ServiceKeys.ECIES, () => {
+                const config = {
+                    curveName: app.constants.ECIES.CURVE_NAME,
+                    primaryKeyDerivationPath: app.constants.ECIES.PRIMARY_KEY_DERIVATION_PATH,
+                    mnemonicStrength: app.constants.ECIES.MNEMONIC_STRENGTH,
+                    symmetricAlgorithm: app.constants.ECIES.SYMMETRIC_ALGORITHM_CONFIGURATION,
+                    symmetricKeyBits: app.constants.ECIES.SYMMETRIC.KEY_BITS,
+                    symmetricKeyMode: app.constants.ECIES.SYMMETRIC.MODE,
+                };
+                return new node_ecies_lib_1.ECIESService(config);
+            });
+        }
+        if (!app.services.has(container_1.ServiceKeys.BACKUP_CODE)) {
+            app.services.register(container_1.ServiceKeys.BACKUP_CODE, () => new backup_code_1.BackupCodeService(app, app.services.get(container_1.ServiceKeys.ECIES), app.services.get(container_1.ServiceKeys.KEY_WRAPPING), app.services.get(container_1.ServiceKeys.ROLE)));
+        }
+        if (!app.services.has(container_1.ServiceKeys.USER)) {
+            app.services.register(container_1.ServiceKeys.USER, () => new user_2.UserService(app, app.services.get(container_1.ServiceKeys.ROLE), app.services.get(container_1.ServiceKeys.EMAIL), app.services.get(container_1.ServiceKeys.KEY_WRAPPING), app.services.get(container_1.ServiceKeys.BACKUP_CODE)));
+        }
+    }
+}
+exports.ApiRouter = ApiRouter;
+//# sourceMappingURL=api.js.map

package/src/routers/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-node-express-suite/src/routers/api.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAGH,oEAA2E;AAM3E,4CAA2C;AAC3C,8CAAqD;AAMrD,0CAAmD;AACnD,yDAA4D;AAC5D,yCAA6C;AAC7C,2DAA8D;AAC9D,2CAA+C;AAC/C,2CAA+C;AAC/C,iCAAoC;AAGpC;;;;;;;;;;;;;;GAcG;AACH,MAAa,SAiBX,SAAQ,iBAA6B;IACrC,8DAA8D;IAC7C,cAAc,CAS7B;IACF,sDAAsD;IACrC,UAAU,CAMzB;IACF,uCAAuC;IACtB,YAAY,CAAgB;IAC7C,kDAAkD;IACjC,WAAW,CAY1B;IACF,kDAAkD;IACjC,WAAW,CAAsC;IAClE,yDAAyD;IACxC,kBAAkB,CAAqB;IACxD,kDAAkD;IACjC,YAAY,CAAoB;IACjD,qEAAqE;IACpD,iBAAiB,CAKhC;IACF;;;;OAIG;IACH,YAAY,WAAyB;QACnC,KAAK,CAAC,WAAW,CAAC,CAAC;QACnB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,GAAG,CAAC,CAAC;QAC5D,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,IAAI,CAAC,CAAC;QAC9D,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,KAAK,CAAC,CAAC;QAChE,IAAI,CAAC,kBAAkB,GAAG,WAAW,CAAC,QAAQ,CAAC,GAAG,CAChD,uBAAW,CAAC,YAAY,CACzB,CAAC;QACF,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,KAAK,CAAC,CAAC;QAChE,IAAI,CAAC,iBAAiB,GAAG,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,WAAW,CAAC,CAAC;QAC3E,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,IAAI,CAAC,CAAC;QAC9D,IAAI,CAAC,cAAc,GAAG,IAAI,qBAAc,CAUtC,WAAW,EACX,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,YAAY,CAClB,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACK,gBAAgB;QACtB,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC;QAE7B,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,GAAG,CAAC,EAAE,CAAC;YACvC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CACnB,uBAAW,CAAC,GAAG,EACf,GAAG,EAAE,CACH,IAAI,gBAAU,CAAmD,GAAG,CAAC,CACxE,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YACxC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CACnB,uBAAW,CAAC,IAAI,EAChB,GAAG,EAAE,CAAC,IAAI,kBAAW,CAAyB,GAAG,CAAC,CACnD,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,KAAK,CAAC,EAAE,CAAC;YACzC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,uBAAW,CAAC,KAAK,EAAE,GAAG,EAAE,CAC5C,+BAAoB,CAAC,UAAU,EAAE,CAClC,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,YAAY,CAAC,EAAE,CAAC;YAChD,GAAG,CAAC,QAAQ,CAAC,QAAQ,CACnB,uBAAW,CAAC,YAAY,EACxB,GAAG,EAAE,CAAC,IAAI,iCAAkB,EAAE,CAC/B,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,KAAK,CAAC,EAAE,CAAC;YACzC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,uBAAW,CAAC,KAAK,EAAE,GAAG,EAAE;gBAC5C,MAAM,MAAM,GAAiB;oBAC3B,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU;oBACzC,wBAAwB,EACtB,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,2BAA2B;oBACjD,gBAAgB,EAAE,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,iBAAiB;oBACvD,kBAAkB,EAChB,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,iCAAiC;oBACvD,gBAAgB,EAAE,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ;oBACxD,gBAAgB,EAAE,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI;iBACrD,CAAC;gBACF,OAAO,IAAI,6BAAY,CAAC,MAAM,CAAC,CAAC;YAClC,CAAC,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,WAAW,CAAC,EAAE,CAAC;YAC/C,GAAG,CAAC,QAAQ,CAAC,QAAQ,CACnB,uBAAW,CAAC,WAAW,EACvB,GAAG,EAAE,CACH,IAAI,+BAAiB,CACnB,GAAG,EACH,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,KAAK,CAAC,EACnC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,YAAY,CAAC,EAC1C,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,IAAI,CAAC,CACnC,CACJ,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YACxC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CACnB,uBAAW,CAAC,IAAI,EAChB,GAAG,EAAE,CACH,IAAI,kBAAW,CAab,GAAG,EACH,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,IAAI,CAAC,EAClC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,KAAK,CAAC,EACnC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,YAAY,CAAC,EAC1C,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAW,CAAC,WAAW,CAAC,CAC1C,CACJ,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AA5LD,8BA4LC"}

package/src/routers/app.d.ts

@@ -0,0 +1,87 @@
+/**
+ * @fileoverview Application router for serving React frontend and API routes.
+ * Handles static file serving, EJS template rendering, and catch-all routing.
+ * @module routers/app
+ */
+import { Application, NextFunction, Request, Response } from 'express';
+import { IApplication } from '../interfaces/application';
+import { BaseRouter } from './base';
+import type { PlatformID } from '@digitaldefiance/node-ecies-lib';
+/**
+ * Application router for serving React frontend and API routes.
+ * Sets up static file serving, EJS template rendering, and catch-all routing for SPA.
+ * @template TID Platform-specific ID type
+ * @template TApplication Application instance type
+ */
+export declare class AppRouter<TID extends PlatformID = Buffer, TApplication extends IApplication<TID> = IApplication<TID>> {
+    /** Path to EJS views directory */
+    protected readonly viewsPath: string;
+    /** Path to index.html file */
+    protected readonly indexPath: string;
+    /** Path to assets directory */
+    protected readonly assetsDir: string;
+    /** Path to React distribution directory */
+    protected readonly reactDistDir: string;
+    /** API router instance */
+    protected readonly apiRouter: BaseRouter<TID, TApplication>;
+    /** Application instance */
+    protected readonly application: TApplication;
+    /**
+     * Creates a new application router instance.
+     * Validates and resolves all paths to prevent directory traversal attacks.
+     * @param apiRouter API router instance to mount under /api
+     * @throws {TranslatableSuiteError} If paths contain invalid traversal sequences
+     */
+    constructor(apiRouter: BaseRouter<TID, TApplication>);
+    /**
+     * Gets the filename of an asset matching a pattern.
+     * @param assetDir Directory to search in
+     * @param pattern Regular expression pattern to match
+     * @returns Filename if found, undefined otherwise
+     */
+    getAssetFilename(assetDir: string, pattern: RegExp): string | undefined;
+    /**
+     * Gets base view locals for EJS template rendering.
+     * Subclasses can override to add additional locals.
+     * @param req Express request
+     * @param res Express response
+     * @returns Object containing base template variables
+     */
+    protected getBaseViewLocals(req: Request, res: Response): Record<string, unknown>;
+    /**
+     * Renders an EJS template with the provided locals.
+     * @param req Express request
+     * @param res Express response
+     * @param next Express next function
+     * @param template Template name to render
+     * @param locals Template variables
+     */
+    protected renderTemplate(req: Request, res: Response, next: NextFunction, template: string, locals: Record<string, unknown>): void;
+    /**
+     * Creates a view renderer function for a specific template.
+     * @param template Template name to render
+     * @param localsFactory Optional function to generate additional locals
+     * @returns Express middleware function
+     */
+    protected createViewRenderer(template: string, localsFactory?: (req: Request, res: Response) => Record<string, unknown>): (req: Request, res: Response, next: NextFunction) => void;
+    /**
+     * Override to register additional routes (e.g. other EJS pages) before the index catch-all.
+     * @param app Express application
+     */
+    protected registerAdditionalRenderHooks(app: Application): void;
+    /**
+     * Renders the index.html page with injected asset paths.
+     * @param req Express request
+     * @param res Express response
+     * @param next Express next function
+     */
+    renderIndex(req: Request, res: Response, next: NextFunction): void;
+    /**
+     * Initializes the application router with all routes and middleware.
+     * Sets up API routes, static file serving, and catch-all routing.
+     * @param app Express application
+     * @throws {TranslatableGenericError} If index file not found or invalid paths
+     */
+    init(app: Application): void;
+}
+//# sourceMappingURL=app.d.ts.map

package/src/routers/app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-node-express-suite/src/routers/app.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAYH,OAAO,EACL,WAAW,EAEX,YAAY,EACZ,OAAO,EACP,QAAQ,EACT,MAAM,SAAS,CAAC;AAGjB,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAWlE;;;;;GAKG;AACH,qBAAa,SAAS,CACpB,GAAG,SAAS,UAAU,GAAG,MAAM,EAC/B,YAAY,SAAS,YAAY,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC;IAE1D,kCAAkC;IAClC,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IACrC,8BAA8B;IAC9B,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IACrC,+BAA+B;IAC/B,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IACrC,2CAA2C;IAC3C,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAExC,0BAA0B;IAC1B,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;IAC5D,2BAA2B;IAC3B,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;IAE7C;;;;;OAKG;gBACS,SAAS,EAAE,UAAU,CAAC,GAAG,EAAE,YAAY,CAAC;IAwDpD;;;;;OAKG;IACI,gBAAgB,CACrB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,GACd,MAAM,GAAG,SAAS;IAkBrB;;;;;;OAMG;IACH,SAAS,CAAC,iBAAiB,CACzB,GAAG,EAAE,OAAO,EACZ,GAAG,EAAE,QAAQ,GACZ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAwB1B;;;;;;;OAOG;IACH,SAAS,CAAC,cAAc,CACtB,GAAG,EAAE,OAAO,EACZ,GAAG,EAAE,QAAQ,EACb,IAAI,EAAE,YAAY,EAClB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC9B,IAAI;IA2CP;;;;;OAKG;IACH,SAAS,CAAC,kBAAkB,CAC1B,QAAQ,EAAE,MAAM,EAChB,aAAa,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvE,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,KAAK,IAAI;IAW5D;;;OAGG;IACH,SAAS,CAAC,6BAA6B,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI;IAI/D;;;;;OAKG;IACI,WAAW,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,GAAG,IAAI;IAgBzE;;;;;OAKG;IACI,IAAI,CAAC,GAAG,EAAE,WAAW;CA+F7B"}