@digitaldefiance/node-express-suite 3.7.5 → 3.8.0

package/src/types.d.ts

@@ -0,0 +1,118 @@
+/**
+ * @fileoverview Type definitions and Express module augmentation.
+ * Defines core types for routing, validation, and API responses.
+ * @module types
+ */
+import { ClientSession } from '@digitaldefiance/mongoose-types';
+import { Member, PlatformID } from '@digitaldefiance/node-ecies-lib';
+import { IRequestUserDTO } from '@digitaldefiance/suite-core-lib';
+import { NextFunction, RequestHandler, Response } from 'express';
+import { ValidationChain } from 'express-validator';
+import { IBaseDocument } from './documents';
+import { IApiErrorResponse, IApiExpressValidationErrorResponse, IApiMessageResponse, IApiMongoValidationErrorResponse, IStatusCodeResponse } from './interfaces';
+import { ISchema } from './interfaces/schema';
+/**
+ * Transaction callback type for withTransaction
+ */
+export type TransactionCallback<T> = (session: ClientSession | undefined, ...args: Array<unknown>) => Promise<T>;
+/**
+ * Validated body for express-validator
+ */
+export type ValidatedBody<T extends string> = {
+    [K in T]: unknown;
+};
+declare module 'express-serve-static-core' {
+    interface Request {
+        user?: IRequestUserDTO;
+        eciesUser?: Member<PlatformID>;
+        validatedBody?: ValidatedBody<string>;
+        validate?: {
+            body: (field: string) => ValidationChain;
+            param: (field: string) => ValidationChain;
+            query: (field: string) => ValidationChain;
+            header: (field: string) => ValidationChain;
+            cookie: (field: string) => ValidationChain;
+        };
+    }
+}
+declare global {
+    namespace Express {
+        interface Request {
+            user?: IRequestUserDTO;
+            eciesUser?: Member<PlatformID>;
+            validatedBody?: ValidatedBody<string>;
+            validate?: {
+                body: (field: string) => ValidationChain;
+                param: (field: string) => ValidationChain;
+                query: (field: string) => ValidationChain;
+                header: (field: string) => ValidationChain;
+                cookie: (field: string) => ValidationChain;
+            };
+        }
+    }
+}
+/**
+ * Schema map interface
+ */
+type ModelDocMap<TID extends PlatformID, TModelDocs extends Record<string, IBaseDocument<any, TID>>> = {
+    [K in keyof TModelDocs]: TModelDocs[K];
+};
+export type SchemaMap<TID extends PlatformID, TModelDocs extends Record<string, IBaseDocument<any, TID>>> = {
+    [K in keyof ModelDocMap<TID, TModelDocs>]: ISchema<TID, ModelDocMap<TID, TModelDocs>[K]>;
+};
+export type ApiRequestHandler<T extends ApiResponse> = (req: Request, res: Response, next: NextFunction) => Promise<IStatusCodeResponse<T>>;
+export type TypedHandlers = {
+    [key: string]: ApiRequestHandler<ApiResponse>;
+};
+export interface IRouteDefinition<T extends TypedHandlers, TLanguage extends string> {
+    method: 'get' | 'post' | 'put' | 'delete' | 'patch';
+    path: string;
+    options: {
+        handlerKey: keyof T;
+        validation?: (validationLanguage: TLanguage) => ValidationChain[];
+        useAuthentication: boolean;
+        useCryptoAuthentication: boolean;
+    };
+}
+export type RouteHandlers = Record<string, ApiRequestHandler<ApiResponse>>;
+export type HttpMethod = 'get' | 'post' | 'put' | 'delete' | 'patch';
+export interface RouteConfig<H extends object, TLanguage extends string> {
+    method: HttpMethod;
+    path: string;
+    handlerKey: keyof H;
+    handlerArgs?: Array<unknown>;
+    useAuthentication: boolean;
+    useCryptoAuthentication: boolean;
+    middleware?: RequestHandler[];
+    validation?: FlexibleValidationChain<TLanguage>;
+    rawJsonHandler?: boolean;
+    authFailureStatusCode?: number;
+    useTransaction?: boolean;
+    transactionTimeout?: number;
+}
+/**
+ * Creates a route configuration object.
+ * @template T - Handler object type
+ * @template TLanguage - Language code type
+ * @param {HttpMethod} method - HTTP method
+ * @param {string} path - Route path
+ * @param {object} options - Route options
+ * @returns {RouteConfig<T, TLanguage>} Route configuration
+ */
+export declare function routeConfig<T extends object, TLanguage extends string>(method: 'get' | 'post' | 'put' | 'delete' | 'patch', path: string, options: {
+    handlerKey: keyof T;
+    validation?: (validationLanguage: TLanguage) => ValidationChain[];
+    useAuthentication: boolean;
+    useCryptoAuthentication: boolean;
+}): RouteConfig<T, TLanguage>;
+export type THandlerArgs<T extends Array<unknown>> = T;
+export type FlexibleValidationChain<TLanguage extends string> = ValidationChain[] | ((lang: TLanguage) => ValidationChain[]);
+export type JsonPrimitive = string | number | boolean | null | undefined;
+export type JsonResponse = JsonPrimitive | {
+    [key: string]: JsonResponse;
+} | JsonResponse[];
+export type ApiErrorResponse = IApiErrorResponse | IApiExpressValidationErrorResponse | IApiMongoValidationErrorResponse;
+export type ApiResponse = IApiMessageResponse | ApiErrorResponse | JsonResponse;
+export type SendFunction<T extends ApiResponse> = (statusCode: number, data: T, res: Response<T>) => void;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../packages/digitaldefiance-node-express-suite/src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAChE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EACL,iBAAiB,EACjB,kCAAkC,EAClC,mBAAmB,EACnB,gCAAgC,EAChC,mBAAmB,EACpB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CACnC,OAAO,EAAE,aAAa,GAAG,SAAS,EAClC,GAAG,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,KACpB,OAAO,CAAC,CAAC,CAAC,CAAC;AAEhB;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,IAAI;KAC3C,CAAC,IAAI,CAAC,GAAG,OAAO;CAClB,CAAC;AAEF,OAAO,QAAQ,2BAA2B,CAAC;IACzC,UAAU,OAAO;QACf,IAAI,CAAC,EAAE,eAAe,CAAC;QACvB,SAAS,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;QAC/B,aAAa,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;QACtC,QAAQ,CAAC,EAAE;YACT,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,eAAe,CAAC;YACzC,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,eAAe,CAAC;YAC1C,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,eAAe,CAAC;YAC1C,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,eAAe,CAAC;YAC3C,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,eAAe,CAAC;SAC5C,CAAC;KACH;CACF;AAED,OAAO,CAAC,MAAM,CAAC;IAEb,UAAU,OAAO,CAAC;QAChB,UAAU,OAAO;YACf,IAAI,CAAC,EAAE,eAAe,CAAC;YACvB,SAAS,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;YAC/B,aAAa,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;YACtC,QAAQ,CAAC,EAAE;gBACT,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,eAAe,CAAC;gBACzC,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,eAAe,CAAC;gBAC1C,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,eAAe,CAAC;gBAC1C,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,eAAe,CAAC;gBAC3C,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,eAAe,CAAC;aAC5C,CAAC;SACH;KACF;CACF;AAED;;GAEG;AACH,KAAK,WAAW,CACd,GAAG,SAAS,UAAU,EACtB,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,IACxD;KACD,CAAC,IAAI,MAAM,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,SAAS,CACnB,GAAG,SAAS,UAAU,EACtB,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,IACxD;KAID,CAAC,IAAI,MAAM,WAAW,CAAC,GAAG,EAAE,UAAU,CAAC,GAAG,OAAO,CAChD,GAAG,EACH,WAAW,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAChC;CACF,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,WAAW,IAAI,CACrD,GAAG,EAAE,OAAO,EACZ,GAAG,EAAE,QAAQ,EACb,IAAI,EAAE,YAAY,KACf,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;AAErC,MAAM,MAAM,aAAa,GAAG;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC;CAC/C,CAAC;AAEF,MAAM,WAAW,gBAAgB,CAC/B,CAAC,SAAS,aAAa,EACvB,SAAS,SAAS,MAAM;IAExB,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;IACpD,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE;QACP,UAAU,EAAE,MAAM,CAAC,CAAC;QACpB,UAAU,CAAC,EAAE,CAAC,kBAAkB,EAAE,SAAS,KAAK,eAAe,EAAE,CAAC;QAClE,iBAAiB,EAAE,OAAO,CAAC;QAC3B,uBAAuB,EAAE,OAAO,CAAC;KAClC,CAAC;CACH;AAED,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC;AAE3E,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;AAErE,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM;IACrE,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC,CAAC;IACpB,WAAW,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,uBAAuB,EAAE,OAAO,CAAC;IACjC,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;IAC9B,UAAU,CAAC,EAAE,uBAAuB,CAAC,SAAS,CAAC,CAAC;IAChD,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM,EACpE,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,EACnD,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE;IACP,UAAU,EAAE,MAAM,CAAC,CAAC;IACpB,UAAU,CAAC,EAAE,CAAC,kBAAkB,EAAE,SAAS,KAAK,eAAe,EAAE,CAAC;IAClE,iBAAiB,EAAE,OAAO,CAAC;IAC3B,uBAAuB,EAAE,OAAO,CAAC;CAClC,GACA,WAAW,CAAC,CAAC,EAAE,SAAS,CAAC,CAS3B;AAED,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAEvD,MAAM,MAAM,uBAAuB,CAAC,SAAS,SAAS,MAAM,IACxD,eAAe,EAAE,GACjB,CAAC,CAAC,IAAI,EAAE,SAAS,KAAK,eAAe,EAAE,CAAC,CAAC;AAE7C,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;AAEzE,MAAM,MAAM,YAAY,GACpB,aAAa,GACb;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAA;CAAE,GAC/B,YAAY,EAAE,CAAC;AAEnB,MAAM,MAAM,gBAAgB,GACxB,iBAAiB,GACjB,kCAAkC,GAClC,gCAAgC,CAAC;AAErC,MAAM,MAAM,WAAW,GAAG,mBAAmB,GAAG,gBAAgB,GAAG,YAAY,CAAC;AAEhF,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,WAAW,IAAI,CAChD,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,CAAC,EACP,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,KACb,IAAI,CAAC"}

package/src/types.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * @fileoverview Type definitions and Express module augmentation.
+ * Defines core types for routing, validation, and API responses.
+ * @module types
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.routeConfig = routeConfig;
+/**
+ * Creates a route configuration object.
+ * @template T - Handler object type
+ * @template TLanguage - Language code type
+ * @param {HttpMethod} method - HTTP method
+ * @param {string} path - Route path
+ * @param {object} options - Route options
+ * @returns {RouteConfig<T, TLanguage>} Route configuration
+ */
+function routeConfig(method, path, options) {
+    return {
+        method,
+        path,
+        handlerKey: options.handlerKey,
+        validation: options.validation,
+        useAuthentication: options.useAuthentication,
+        useCryptoAuthentication: options.useCryptoAuthentication,
+    };
+}
+//# sourceMappingURL=types.js.map

package/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../packages/digitaldefiance-node-express-suite/src/types.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;AA4IH,kCAkBC;AA3BD;;;;;;;;GAQG;AACH,SAAgB,WAAW,CACzB,MAAmD,EACnD,IAAY,EACZ,OAKC;IAED,OAAO;QACL,MAAM;QACN,IAAI;QACJ,UAAU,EAAE,OAAO,CAAC,UAAU;QAC9B,UAAU,EAAE,OAAO,CAAC,UAAU;QAC9B,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;QAC5C,uBAAuB,EAAE,OAAO,CAAC,uBAAuB;KACzD,CAAC;AACJ,CAAC"}

package/src/utils.d.ts

@@ -0,0 +1,240 @@
+/**
+ * @fileoverview Utility functions for Express application including validation, transactions, error handling, and data encoding.
+ * Provides comprehensive helpers for API responses, MongoDB transactions, validation, and cryptographic operations.
+ * @module utils
+ */
+import { ClientSession, Connection } from '@digitaldefiance/mongoose-types';
+import { NextFunction, Request, Response } from 'express';
+import { ValidationError } from 'express-validator';
+import { z, ZodType } from 'zod';
+import { IApiErrorResponse, IApplication } from './interfaces';
+import { IApiExpressValidationErrorResponse } from './interfaces/api-express-validation-error-response';
+import { IApiMongoValidationErrorResponse } from './interfaces/api-mongo-validation-error-response';
+import { IMongoErrors } from './interfaces/mongo-errors';
+import { ApiResponse, SendFunction, TransactionCallback } from './types';
+/** Debug message type for console output */
+export type DEBUG_TYPE = 'error' | 'warn' | 'log';
+/**
+ * Conditionally prints debug messages to console.
+ * @param debug Whether to print debug messages
+ * @param type Type of message (error, warn, or log)
+ * @param args Arguments to print
+ */
+export declare function debugLog(debug: boolean, type?: DEBUG_TYPE, ...args: unknown[]): void;
+/**
+ * Prints debug messages directly to stdout/stderr bypassing Node streams.
+ * Uses fs.writeSync to avoid Nx interception.
+ * @param debug Whether to print debug messages
+ * @param type Type of message (error, warn, or log)
+ * @param args Arguments to print
+ */
+export declare function directLog(debug: boolean, type?: DEBUG_TYPE, ...args: any[]): void;
+/**
+ * Gets value at a dotted path from an object.
+ * @param obj Object to traverse
+ * @param path Array of keys representing the path
+ * @returns Value at path or undefined
+ */
+export declare function getValueAtPath(obj: unknown, path: (string | number)[]): unknown;
+/**
+ * Maps Zod validation issues to express-validator ValidationError format.
+ * @param issues Zod validation issues
+ * @param source Source object being validated
+ * @param location Location of validation (body, query, params, etc.)
+ * @returns Array of express-validator ValidationErrors
+ */
+export declare function mapZodIssuesToValidationErrors(issues: z.ZodError<unknown>['issues'], source: unknown, location?: 'body' | 'cookies' | 'headers' | 'params' | 'query'): ValidationError[];
+/**
+ * Validates request body against Zod schema and executes callback with validated data.
+ * @template T Zod schema type
+ * @template TResult Callback return type
+ * @param req Express request
+ * @param schema Zod schema for validation
+ * @param callback Callback to execute with validated data
+ * @returns Promise resolving to callback result
+ * @throws {MissingValidatedDataError} If validated body is missing
+ * @throws {ExpressValidationError} If validation fails
+ */
+export declare function requireValidatedFieldsAsync<T extends ZodType<any, any, any>, TResult = void>(req: Request, schema: T, callback: (data: z.output<T>) => Promise<TResult>): Promise<TResult>;
+/**
+ * Checks if at least one of the required fields is present in validated body.
+ * @template T Callback return type
+ * @param req Express request
+ * @param fields Array of field names to check
+ * @param callback Callback to execute if validation passes
+ * @returns Promise resolving to callback result
+ * @throws {MissingValidatedDataError} If none of the fields are present
+ */
+export declare function requireOneOfValidatedFieldsAsync<T = void>(req: Request, fields: string[], callback: () => Promise<T>): Promise<T>;
+/**
+ * Validates required fields are present in validated body (synchronous).
+ * @template T Callback return type
+ * @param req Express request
+ * @param fields Array of required field names
+ * @param callback Callback to execute if validation passes
+ * @returns Callback result
+ * @throws {MissingValidatedDataError} If any required field is missing
+ */
+export declare function requireValidatedFieldsOrThrow<T = void>(req: Request, fields: string[], callback: () => T): T;
+/**
+ * Checks if a value is a valid MongoDB ObjectId string.
+ * @param id Value to check
+ * @returns True if valid ObjectId string
+ */
+export declare function isValidStringObjectId(id: unknown): boolean;
+/**
+ * Default number of retry attempts for transactions.
+ * Uses fewer retries in test environment for faster feedback.
+ */
+export declare const DEFAULT_RETRY_ATTEMPTS: number;
+/**
+ * Default transaction timeout in milliseconds.
+ * Uses shorter timeout in test environment for faster failure detection.
+ */
+export declare const DEFAULT_TRANSACTION_TIMEOUT: number;
+/**
+ * Default transaction lock request timeout in milliseconds.
+ */
+export declare const DEFAULT_TRANSACTION_LOCK_REQUEST_TIMEOUT: number;
+/** Transaction configuration options */
+export interface TransactionOptions<TID extends PlatformID = Buffer> {
+    application?: IApplication<TID>;
+    timeoutMs?: number;
+    retryAttempts?: number;
+    baseDelay?: number;
+    debugLogEnabled?: boolean;
+}
+/**
+ * Gets the default base delay for transaction retries from environment variables
+ * @returns The base delay in milliseconds
+ */
+export declare function getDefaultBaseDelay(): number;
+/**
+ * Wraps a callback in a transaction if necessary
+ * @param connection The mongoose connection
+ * @param useTransaction Whether to use a transaction
+ * @param session The session to use
+ * @param callback The callback to wrap
+ * @param options Transaction options including timeout and retry attempts
+ * @param args The arguments to pass to the callback
+ * @returns The result of the callback
+ */
+export declare function withTransaction<T, TID extends PlatformID = Buffer>(connection: Connection, useTransaction: boolean, session: ClientSession | undefined, callback: TransactionCallback<T>, options?: TransactionOptions<TID>, ...args: any): Promise<T>;
+/**
+ * Sends an API response with the given status and response object.
+ * @param status
+ * @param response
+ * @param res
+ */
+export declare function sendApiMessageResponse<T extends ApiResponse>(status: number, response: T, res: Response<T>): void;
+/**
+ * Sends an API response with the given status, message, and error.
+ * @param status
+ * @param message
+ * @param error
+ * @param res
+ */
+export declare function sendApiErrorResponse(status: number, message: string, error: unknown, res: Response): void;
+/**
+ * Sends an API response with the given status and validation errors.
+ * @param status
+ * @param errors
+ * @param res
+ */
+export declare function sendApiExpressValidationErrorResponse(status: number, errors: ValidationError[], res: Response, application?: IApplication): void;
+/**
+ * Sends an API response with the given status, message, and MongoDB validation errors.
+ * @param status
+ * @param message
+ * @param errors
+ * @param res
+ */
+export declare function sendApiMongoValidationErrorResponse(status: number, message: string, errors: IMongoErrors, res: Response): void;
+/**
+ * Sends a raw JSON response with the given status and response object.
+ * @param status The status code
+ * @param response The response data
+ * @param res The response object
+ */
+export declare function sendRawJsonResponse<T>(status: number, response: T, res: Response<T>): void;
+export declare function handleError(error: unknown, res: Response, send: SendFunction<IApiErrorResponse | IApiExpressValidationErrorResponse | IApiMongoValidationErrorResponse>, _next: NextFunction): void;
+export declare function locatePEMRoot(devRootDir: string): string | undefined;
+/**
+ * Encodes the length of the data in the buffer
+ * @param buffer The buffer to encode
+ * @returns The encoded buffer
+ */
+export declare function lengthEncodeData(buffer: Buffer): Buffer;
+export declare function decodeLengthEncodedData(buffer: Buffer): {
+    data: Buffer;
+    totalLength: number;
+};
+import { BackupCode } from './backup-code';
+import { LengthEncodingType } from './enumerations/length-encoding-type';
+import type { PlatformID } from '@digitaldefiance/node-ecies-lib';
+export declare function isValidTimezone(timezone: string): boolean;
+/**
+ * Omits keys from an object
+ */
+export declare function omit<T extends object, K extends keyof T>(obj: T, keys: K[]): Omit<T, K>;
+/**
+ * Validates that a collection contains exactly the keys from an enum
+ * @param collection The collection to validate
+ * @param enumObject The enum object to validate against
+ * @param collectionName Optional name for the collection (for better error messages)
+ * @param enumName Optional name for the enum (for better error messages)
+ * @throws Error if collection has missing, extra, or invalid keys
+ */
+export declare function validateEnumCollection<T extends Record<string, any>>(collection: Record<string, unknown>, enumObject: T, collectionName?: string, enumName?: string): void;
+export declare function uint8ArrayToBase64(uint8Array: Uint8Array): string;
+export declare function base64ToUint8Array(base64String: string): Uint8Array;
+export declare function uint8ArrayToHex(uint8Array: Uint8Array): string;
+export declare function hexToUint8Array(hexString: string): Uint8Array;
+/**
+ * Utility functions for browser ECIES implementation
+ */
+/**
+ * CRC16-CCITT implementation for data integrity checking
+ * Uses the same algorithm as the server-side implementation (CRC16-CCITT-FALSE)
+ */
+export declare function crc16(data: Uint8Array): Uint8Array;
+/**
+ * Convert string to Uint8Array (UTF-8 encoding)
+ */
+export declare function stringToUint8Array(str: string): Uint8Array;
+/**
+ * Convert Uint8Array to string (UTF-8 decoding)
+ */
+export declare function uint8ArrayToString(array: Uint8Array): string;
+/**
+ * Secure random bytes generation
+ */
+export declare function randomBytes(length: number): Uint8Array;
+/**
+ * Compare two Uint8Arrays for equality
+ */
+export declare function arraysEqual(a: Uint8Array, b: Uint8Array): boolean;
+/**
+ * Concatenate multiple Uint8Arrays
+ */
+export declare function concatUint8Arrays(...arrays: Uint8Array[]): Uint8Array;
+/**
+ * Get the length encoding type for a given length
+ * @param length The length to evaluate
+ * @returns The corresponding LengthEncodingType
+ */
+export declare function getLengthEncodingTypeForLength(length: number | bigint): LengthEncodingType;
+/**
+ * Get the length encoding type for a given value
+ * @param value The value to evaluate
+ * @returns The corresponding LengthEncodingType
+ */
+export declare function getLengthEncodingTypeFromValue(value: number): LengthEncodingType;
+/**
+ * Get the length in bytes for a given LengthEncodingType
+ * @param type The LengthEncodingType to evaluate
+ * @returns The length in bytes
+ */
+export declare function getLengthForLengthType(type: LengthEncodingType): number;
+export declare function parseBackupCodes(user: 'admin' | 'member' | 'system', environment: Record<string, string | undefined>): BackupCode[];
+//# sourceMappingURL=utils.d.ts.map

package/src/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../packages/digitaldefiance-node-express-suite/src/utils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EACL,aAAa,EACb,UAAU,EAEX,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC1D,OAAO,EAAU,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAG5D,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AAGjC,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,kCAAkC,EAAE,MAAM,oDAAoD,CAAC;AACxG,OAAO,EAAE,gCAAgC,EAAE,MAAM,kDAAkD,CAAC;AACpG,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAEzE,4CAA4C;AAC5C,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC;AAElD;;;;;GAKG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,OAAO,EACd,IAAI,GAAE,UAAkB,EACxB,GAAG,IAAI,EAAE,OAAO,EAAE,GACjB,IAAI,CAQN;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CACvB,KAAK,EAAE,OAAO,EACd,IAAI,GAAE,UAAkB,EACxB,GAAG,IAAI,EAAE,GAAG,EAAE,GACb,IAAI,CAqBN;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GACxB,OAAO,CAgBT;AAED;;;;;;GAMG;AACH,wBAAgB,8BAA8B,CAC5C,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,EACrC,MAAM,EAAE,OAAO,EACf,QAAQ,GAAE,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAgB,GACrE,eAAe,EAAE,CAUnB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,2BAA2B,CAC/C,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAChC,OAAO,GAAG,IAAI,EAEd,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,CAAC,EACT,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,GAChD,OAAO,CAAC,OAAO,CAAC,CAoBlB;AAED;;;;;;;;GAQG;AACH,wBAAsB,gCAAgC,CAAC,CAAC,GAAG,IAAI,EAC7D,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,MAAM,EAAE,EAChB,QAAQ,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GACzB,OAAO,CAAC,CAAC,CAAC,CASZ;AAED;;;;;;;;GAQG;AACH,wBAAgB,6BAA6B,CAAC,CAAC,GAAG,IAAI,EACpD,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,MAAM,EAAE,EAChB,QAAQ,EAAE,MAAM,CAAC,GAChB,CAAC,CAWH;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,EAAE,EAAE,OAAO,GAAG,OAAO,CAE1D;AAED;;;GAGG;AACH,eAAO,MAAM,sBAAsB,QACS,CAAC;AAC7C;;;GAGG;AACH,eAAO,MAAM,2BAA2B,QACY,CAAC;AAErD;;GAEG;AACH,eAAO,MAAM,wCAAwC,QACD,CAAC;AAErD,wCAAwC;AACxC,MAAM,WAAW,kBAAkB,CAAC,GAAG,SAAS,UAAU,GAAG,MAAM;IACjE,WAAW,CAAC,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,CAU5C;AAED;;;;;;;;;GASG;AACH,wBAAsB,eAAe,CAAC,CAAC,EAAE,GAAG,SAAS,UAAU,GAAG,MAAM,EACtE,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,OAAO,EACvB,OAAO,EAAE,aAAa,GAAG,SAAS,EAClC,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC,EAChC,OAAO,GAAE,kBAAkB,CAAC,GAAG,CAAM,EACrC,GAAG,IAAI,EAAE,GAAG,GACX,OAAO,CAAC,CAAC,CAAC,CAuIZ;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,WAAW,EAC1D,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,CAAC,EACX,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,GACf,IAAI,CAEN;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,QAAQ,GACZ,IAAI,CAEN;AAED;;;;;GAKG;AACH,wBAAgB,qCAAqC,CACnD,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,eAAe,EAAE,EACzB,GAAG,EAAE,QAAQ,EACb,WAAW,CAAC,EAAE,YAAY,GACzB,IAAI,CAeN;AAED;;;;;;GAMG;AACH,wBAAgB,mCAAmC,CACjD,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,YAAY,EACpB,GAAG,EAAE,QAAQ,GACZ,IAAI,CAMN;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EACnC,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,CAAC,EACX,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,QAGjB;AAiID,wBAAgB,WAAW,CACzB,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,QAAQ,EACb,IAAI,EAAE,YAAY,CACd,iBAAiB,GACjB,kCAAkC,GAClC,gCAAgC,CACnC,EACD,KAAK,EAAE,YAAY,GAClB,IAAI,CAyCN;AAED,wBAAgB,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAwCpE;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAuBvD;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG;IACvD,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB,CA4CA;AAUD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAElE,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEzD;AAED;;GAEG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EACtD,GAAG,EAAE,CAAC,EACN,IAAI,EAAE,CAAC,EAAE,GACR,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAQZ;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAClE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,UAAU,EAAE,CAAC,EACb,cAAc,CAAC,EAAE,MAAM,EACvB,QAAQ,CAAC,EAAE,MAAM,GAChB,IAAI,CAsCN;AAED,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAMjE;AAED,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,UAAU,CAQnE;AAED,wBAAgB,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAI9D;AAED,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,UAAU,CAO7D;AAED;;GAEG;AAEH;;;GAGG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,UAAU,GAAG,UAAU,CAoBlD;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAE1D;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAE5D;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,CAEtD;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,GAAG,OAAO,CAMjE;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,UAAU,CASrE;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAC5C,MAAM,EAAE,MAAM,GAAG,MAAM,GACtB,kBAAkB,CAkCpB;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAC5C,KAAK,EAAE,MAAM,GACZ,kBAAkB,CASpB;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,kBAAkB,GAAG,MAAM,CAevE;AAED,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,EACnC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAC9C,UAAU,EAAE,CAYd"}