@digitaldefiance/node-express-suite 3.6.6 → 3.6.8

package/src/utils.d.ts

@@ -1,210 +0,0 @@
-import { NextFunction, Request, Response } from 'express';
-import { ValidationError } from 'express-validator';
-import { ClientSession, Connection } from '@digitaldefiance/mongoose-types';
-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';
-export type DEBUG_TYPE = 'error' | 'warn' | 'log';
-/**
- * Optionally prints certain debug messages
- * @param debug Whether to print debug messages
- * @param type What type of message to print
- * @param args Any args to print
- */
-export declare function debugLog(debug: boolean, type?: DEBUG_TYPE, ...args: any[]): void;
-/**
- * Optionally prints certain debug messages
- * @param debug Whether to print debug messages
- * @param type What type of message to print
- * @param args Any args to print
- */
-export declare function directLog(debug: boolean, type?: DEBUG_TYPE, ...args: any[]): void;
-export declare function getValueAtPath(obj: unknown, path: (string | number)[]): unknown;
-export declare function mapZodIssuesToValidationErrors(issues: z.ZodError<unknown>['issues'], source: unknown, location?: 'body' | 'cookies' | 'headers' | 'params' | 'query'): ValidationError[];
-/**
- * Verifies the required fields were validated by express-validator and sends an error response if not or calls the callback if they are
- * @param req The request object
- * @param fields The fields to check
- * @param callback The callback to call if the fields are valid
- * @returns The result of the callback
- */
-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>;
-/**
- * Verifies at least one of the required fields were validated by express-validator and sends an error response if not or calls the callback if they are
- * @param req The request object
- * @param fields The fields to check
- * @param callback The callback to call if the fields are valid
- * @returns The result of the callback
- */
-export declare function requireOneOfValidatedFieldsAsync<T = void>(req: Request, fields: string[], callback: () => Promise<T>): Promise<T>;
-/**
- * Verifies the required fields were validated by express-validator and throws an error if not or calls the callback if they are
- * @param req The request object
- * @param fields The fields to check
- * @param callback The callback to call if the fields are valid
- * @returns The result of the callback
- */
-export declare function requireValidatedFieldsOrThrow<T = void>(req: Request, fields: string[], callback: () => T): T;
-/**
- * Checks if the given id is a valid string id
- * @param id The id to check
- * @returns True if the id is a valid string id
- */
-export declare function isValidStringId(id: unknown): boolean;
-/**
- * The default number of retry attempts for transactions
- * Use fewer retries in test environment for faster feedback
- */
-export declare const DEFAULT_RETRY_ATTEMPTS: number;
-/**
- * The default transaction timeout in milliseconds
- * Use shorter timeout in test environment for faster failure detection
- */
-export declare const DEFAULT_TRANSACTION_TIMEOUT: number;
-/**
- * The default transaction lock request timeout in milliseconds
- */
-export declare const DEFAULT_TRANSACTION_LOCK_REQUEST_TIMEOUT: number;
-export interface TransactionOptions {
-    application?: IApplication;
-    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>(connection: Connection, useTransaction: boolean, session: ClientSession | undefined, callback: TransactionCallback<T>, options?: TransactionOptions, ...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';
-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

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../packages/digitaldefiance-node-express-suite/src/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC1D,OAAO,EAAU,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE5D,OAAO,EAAE,aAAa,EAAE,UAAU,EAAS,MAAM,iCAAiC,CAAC;AAEnF,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,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,GAAG,EAAE,GACb,IAAI,CAQN;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CACvB,KAAK,EAAE,OAAO,EACd,IAAI,GAAE,UAAkB,EACxB,GAAG,IAAI,EAAE,GAAG,EAAE,GACb,IAAI,CAqBN;AAGD,wBAAgB,cAAc,CAC5B,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GACxB,OAAO,CAgBT;AAGD,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;;;;;;GAMG;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;;;;;;GAMG;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;;;;;;GAMG;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,eAAe,CAAC,EAAE,EAAE,OAAO,GAAG,OAAO,CAEpD;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,MAAM,WAAW,kBAAkB;IACjC,WAAW,CAAC,EAAE,YAAY,CAAC;IAC3B,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,EACrC,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,OAAO,EACvB,OAAO,EAAE,aAAa,GAAG,SAAS,EAClC,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC,EAChC,OAAO,GAAE,kBAAuB,EAChC,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,IAAI,EAAE,YAAY,GACjB,IAAI,CAsCN;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;AAGzE,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"}