@digitaldefiance/node-express-suite 3.7.4 → 3.7.6

package/src/services/checksum.js

@@ -1,12 +1,28 @@
 "use strict";
+/**
+ * @fileoverview Service for calculating and validating SHA3-512 checksums.
+ * Provides checksum operations for buffers, strings, files, and streams.
+ * @module services/checksum
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChecksumService = void 0;
 const crypto_1 = require("crypto");
 const fs_1 = require("fs");
 const constants_1 = require("../constants");
+/**
+ * Service for calculating and validating SHA3-512 checksums.
+ * Supports multiple input types including buffers, strings, files, and streams.
+ */
 class ChecksumService {
+    /** Checksum configuration (algorithm and encoding) */
     config;
+    /** Checksum constants (buffer lengths and defaults) */
     constants;
+    /**
+     * Creates a new checksum service instance.
+     * @param config Optional configuration overrides
+     * @param constants Checksum constants (defaults to CHECKSUM)
+     */
     constructor(config, constants = constants_1.CHECKSUM) {
         this.config = {
             algorithm: constants.ALGORITHM,
@@ -16,9 +32,9 @@ class ChecksumService {
         this.constants = constants;
     }
     /**
-     * Calculate a checksum for a buffer
-     * @param data - The data to calculate the checksum for
-     * @returns The checksum as a Buffer
+     * Calculates a checksum for a buffer.
+     * @param data Buffer to calculate checksum for
+     * @returns Checksum as a Buffer
      */
     calculateChecksum(data) {
         const hash = (0, crypto_1.createHash)(this.config.algorithm);
@@ -27,9 +43,9 @@ class ChecksumService {
         return Buffer.from(digest);
     }
     /**
-     * Calculate a checksum for multiple buffers
-     * @param buffers - The buffers to calculate the checksum for
-     * @returns The checksum as a Buffer
+     * Calculates a checksum for multiple buffers.
+     * @param buffers Array of buffers to calculate checksum for
+     * @returns Checksum as a Buffer
      */
     calculateChecksumForBuffers(buffers) {
         const hash = (0, crypto_1.createHash)(this.config.algorithm);
@@ -40,18 +56,18 @@ class ChecksumService {
         return Buffer.from(digest);
     }
     /**
-     * Calculate a checksum for a string
-     * @param str - The string to calculate the checksum for
-     * @returns The checksum as a Buffer
+     * Calculates a checksum for a UTF-8 string.
+     * @param str String to calculate checksum for
+     * @returns Checksum as a Buffer
      */
     calculateChecksumForString(str) {
         return this.calculateChecksum(Buffer.from(str, 'utf8'));
     }
     /**
-     * Compare two checksums for equality
-     * @param checksum1 - The first checksum
-     * @param checksum2 - The second checksum
-     * @returns True if the checksums are equal, false otherwise
+     * Compares two checksums for equality.
+     * @param checksum1 First checksum
+     * @param checksum2 Second checksum
+     * @returns True if checksums are equal, false otherwise
      */
     compareChecksums(checksum1, checksum2) {
         if (checksum1.length !== this.constants.SHA3_BUFFER_LENGTH ||
@@ -61,17 +77,18 @@ class ChecksumService {
         return checksum1.equals(new Uint8Array(checksum2));
     }
     /**
-     * Convert a checksum to a hex string
-     * @param checksum - The checksum to convert
-     * @returns The checksum as a hex string
+     * Converts a checksum buffer to a hex string.
+     * @param checksum Checksum buffer
+     * @returns Checksum as a hex string
      */
     checksumToHexString(checksum) {
         return checksum.toString(this.constants.ENCODING);
     }
     /**
-     * Convert a hex string to a checksum
-     * @param hexString - The hex string to convert
-     * @returns The checksum as a Buffer
+     * Converts a hex string to a checksum buffer.
+     * @param hexString Hex string to convert
+     * @returns Checksum as a Buffer
+     * @throws {Error} If hex string length is invalid
      */
     hexStringToChecksum(hexString) {
         if (hexString.length !== this.constants.SHA3_BUFFER_LENGTH * 2) {
@@ -80,17 +97,18 @@ class ChecksumService {
         return Buffer.from(hexString, this.constants.ENCODING);
     }
     /**
-     * Validate a checksum buffer
-     * @param checksum - The checksum to validate
-     * @returns True if the checksum is valid, false otherwise
+     * Validates a checksum buffer length.
+     * @param checksum Checksum buffer to validate
+     * @returns True if checksum length is valid, false otherwise
      */
     validateChecksum(checksum) {
         return checksum.length === this.constants.SHA3_BUFFER_LENGTH;
     }
     /**
-     * Calculate a checksum for a file
-     * @param filePath - The path to the file
-     * @returns The checksum as a Buffer
+     * Calculates a checksum for a file.
+     * @param filePath Path to the file
+     * @returns Promise resolving to checksum as a Buffer
+     * @throws {Error} If file cannot be read
      */
     async calculateChecksumForFile(filePath) {
         // Removed dynamic import by using the data service to read file data
@@ -100,7 +118,10 @@ class ChecksumService {
         return this.calculateChecksum(buffer);
     }
     /**
-     * Internal file reading method
+     * Internal file reading method using fs.promises.
+     * @param filePath Path to the file
+     * @returns Promise resolving to file contents as Buffer
+     * @throws {Error} If file cannot be read
      * @private
      */
     async readFile(filePath) {
@@ -114,9 +135,9 @@ class ChecksumService {
         }
     }
     /**
-     * Calculate a checksum for a stream
-     * @param stream - The readable stream
-     * @returns The checksum as a Buffer
+     * Calculates a checksum for a readable stream.
+     * @param stream Readable stream to calculate checksum for
+     * @returns Promise resolving to checksum as a Buffer
      */
     calculateChecksumForStream(stream) {
         return new Promise((resolve, reject) => {

package/src/services/checksum.js.map

@@ -1 +1 @@
-{"version":3,"file":"checksum.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-node-express-suite/src/services/checksum.ts"],"names":[],"mappings":";;;AAIA,mCAAoC;AACpC,2BAAoC;AACpC,4CAAwC;AAIxC,MAAa,eAAe;IACT,MAAM,CAAkB;IACtB,SAAS,CAAkB;IAE9C,YACE,MAAiC,EACjC,YAA6B,oBAAQ;QAErC,IAAI,CAAC,MAAM,GAAG;YACZ,SAAS,EAAE,SAAS,CAAC,SAAS;YAC9B,QAAQ,EAAE,SAAS,CAAC,QAAQ;YAC5B,GAAG,MAAM;SACV,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,IAAY;QACnC,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC7B,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAmB,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACI,2BAA2B,CAAC,OAAiB;QAClD,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC/C,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QACtC,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC7B,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAmB,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACI,0BAA0B,CAAC,GAAW;QAC3C,OAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CACrB,SAAyB,EACzB,SAAyB;QAEzB,IACE,SAAS,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,kBAAkB;YACtD,SAAS,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,kBAAkB,EACtD,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CAAC,QAAwB;QACjD,OAAO,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAmB,CAAC;IACtE,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CAAC,SAAiB;QAC1C,IAAI,SAAS,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,kBAAkB,GAAG,CAAC,EAAE,CAAC;YAC/D,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAmB,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,QAAwB;QAC9C,OAAO,QAAQ,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,wBAAwB,CACnC,QAAgB;QAEhB,qEAAqE;QACrE,+EAA+E;QAC/E,8DAA8D;QAC9D,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,QAAQ,CAAC,QAAgB;QACrC,uEAAuE;QACvE,gDAAgD;QAChD,IAAI,CAAC;YACH,OAAO,MAAM,aAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACrC,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,KAAK,CAAC,gCAAgC,QAAQ,EAAE,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,0BAA0B,CAC/B,MAA6B;QAE7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAC/C,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC1B,gDAAgD;gBAChD,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC3B,IAAI,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,CAAC;qBAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;oBACrC,IAAI,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBACpD,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAClD,CAAC;YACH,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBACpB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC7B,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAmB,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA5JD,0CA4JC"}
+{"version":3,"file":"checksum.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-node-express-suite/src/services/checksum.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAMH,mCAAoC;AACpC,2BAAoC;AACpC,4CAAwC;AAIxC;;;GAGG;AACH,MAAa,eAAe;IAC1B,sDAAsD;IACrC,MAAM,CAAkB;IACzC,uDAAuD;IACpC,SAAS,CAAkB;IAE9C;;;;OAIG;IACH,YACE,MAAiC,EACjC,YAA6B,oBAAQ;QAErC,IAAI,CAAC,MAAM,GAAG;YACZ,SAAS,EAAE,SAAS,CAAC,SAAS;YAC9B,QAAQ,EAAE,SAAS,CAAC,QAAQ;YAC5B,GAAG,MAAM;SACV,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,IAAY;QACnC,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC7B,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAmB,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACI,2BAA2B,CAAC,OAAiB;QAClD,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC/C,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QACtC,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC7B,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAmB,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACI,0BAA0B,CAAC,GAAW;QAC3C,OAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CACrB,SAAyB,EACzB,SAAyB;QAEzB,IACE,SAAS,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,kBAAkB;YACtD,SAAS,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,kBAAkB,EACtD,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CAAC,QAAwB;QACjD,OAAO,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAmB,CAAC;IACtE,CAAC;IAED;;;;;OAKG;IACI,mBAAmB,CAAC,SAAiB;QAC1C,IAAI,SAAS,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,kBAAkB,GAAG,CAAC,EAAE,CAAC;YAC/D,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAmB,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,QAAwB;QAC9C,OAAO,QAAQ,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,wBAAwB,CACnC,QAAgB;QAEhB,qEAAqE;QACrE,+EAA+E;QAC/E,8DAA8D;QAC9D,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,QAAQ,CAAC,QAAgB;QACrC,uEAAuE;QACvE,gDAAgD;QAChD,IAAI,CAAC;YACH,OAAO,MAAM,aAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACrC,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,KAAK,CAAC,gCAAgC,QAAQ,EAAE,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,0BAA0B,CAC/B,MAA6B;QAE7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAC/C,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC1B,gDAAgD;gBAChD,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC3B,IAAI,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,CAAC;qBAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;oBACrC,IAAI,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBACpD,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAClD,CAAC;YACH,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBACpB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC7B,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAmB,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAxKD,0CAwKC"}

package/src/services/database-initialization.d.ts

@@ -1,3 +1,8 @@
+/**
+ * @fileoverview Service for initializing the database with default users, roles, and relationships.
+ * Handles creation of system, admin, and member users with encrypted credentials and backup codes.
+ * @module services/database-initialization
+ */
 import { EmailString, MemberType, SecureString } from '@digitaldefiance/ecies-lib';
 import { Connection } from '@digitaldefiance/mongoose-types';
 import { Member as BackendMember, ECIESService, PlatformID } from '@digitaldefiance/node-ecies-lib';
@@ -10,88 +15,109 @@ import { KeyWrappingService } from '../services/key-wrapping';
 import { BackupCodeService } from './backup-code';
 import { MnemonicService } from './mnemonic';
 import { RoleService } from './role';
+/**
+ * Service for initializing the database with default users, roles, and relationships.
+ * Manages creation of system, admin, and member accounts with encrypted credentials.
+ */
 export declare abstract class DatabaseInitializationService {
+    /**
+     * Static initialization state management to prevent concurrent initialization.
+     * @private
+     */
     protected static initializationPromises: Map<string, Promise<IFailableResult<IServerInitResult<Buffer<ArrayBufferLike>>>>>;
+    /** Initialization lock to prevent race conditions */
     protected static initializationLock: Map<string, boolean>;
+    /**
+     * Default i18n translation function for database initialization messages.
+     * @param str String key to translate
+     * @param variables Template variables
+     * @param language Target language
+     * @param application Application instance
+     * @returns Translated string
+     */
     protected static defaultI18nTFunc(str: string, variables?: Record<string, unknown>, language?: string, application?: IApplication): string;
     /**
-     * Get the mnemonic or generate a new one if not present
-     * @param mnemonic The existing mnemonic or undefined
-     * @param eciesService The ECIES service to generate a new mnemonic
-     * @returns The existing or new mnemonic
+     * Gets the mnemonic or generates a new one if not present.
+     * @template TID Platform-specific ID type
+     * @param mnemonic Existing mnemonic or undefined
+     * @param eciesService ECIES service to generate a new mnemonic
+     * @returns Existing or new mnemonic
      */
-    static mnemonicOrNew<I extends PlatformID = Buffer>(mnemonic: SecureString | undefined, eciesService: ECIESService<I>): SecureString;
+    static mnemonicOrNew<TID extends PlatformID = Buffer>(mnemonic: SecureString | undefined, eciesService: ECIESService<TID>): SecureString;
     /**
-     * Generate a cache key for a user based on their details
-     * @param username The username
-     * @param email The email address
-     * @param mnemonic The mnemonic
-     * @param id The user ID
-     * @returns The generated cache key
+     * Generates a cache key for a user based on their details.
+     * @template TID Platform-specific ID type
+     * @param username Username
+     * @param email Email address
+     * @param mnemonic Mnemonic
+     * @param id User ID
+     * @returns Generated cache key as hex string
      */
-    static cacheKey<I extends PlatformID = Buffer>(username: string, email: EmailString, mnemonic: SecureString, id: I): string;
+    static cacheKey<TID extends PlatformID = Buffer>(username: string, email: EmailString, mnemonic: SecureString, id: TID): string;
     /**
-     * Get a cached BackendMember or create a new one if not cached
-     * @param username The username
-     * @param email The email address
-     * @param mnemonic The mnemonic or undefined to generate a new one
-     * @param memberType The type of member (Admin, Member, System)
-     * @param eciesService The ECIES service to handle key generation
+     * Gets a cached BackendMember or creates a new one if not cached.
+     * @template TID Platform-specific ID type
+     * @param username Username
+     * @param email Email address
+     * @param mnemonic Mnemonic or undefined to generate a new one
+     * @param memberType Type of member (Admin, Member, System)
+     * @param eciesService ECIES service to handle key generation
      * @param memberId Optional specific member ID to use
      * @param createdBy Optional ID of the user who created this member
-     * @returns The cached or newly created BackendMember and the mnemonic used
+     * @returns Cached or newly created BackendMember and the mnemonic used
      */
-    static cacheOrNew<I extends PlatformID = Buffer>(username: string, email: EmailString, mnemonic: SecureString | undefined, memberType: MemberType, eciesService: ECIESService<I>, memberId?: I, createdBy?: I): {
-        member: BackendMember<I>;
+    static cacheOrNew<TID extends PlatformID = Buffer>(username: string, email: EmailString, mnemonic: SecureString | undefined, memberType: MemberType, eciesService: ECIESService<TID>, memberId?: TID, createdBy?: TID): {
+        member: BackendMember<TID>;
         mnemonic: SecureString;
     };
     /**
-     * Generate a random password
-     * @param length The length of the password
-     * @returns The generated password
+     * Generates a random password meeting security requirements.
+     * @param length Length of the password
+     * @returns Generated password string
      */
     static generatePassword(length: number): string;
     /**
-     * Drops the database
-     * @param connection The database connection
+     * Drops the database.
+     * @param connection Database connection
      * @returns True if the database was dropped, false if not connected
      */
     static dropDatabase(connection: Connection): Promise<boolean>;
-    static getInitOptions<I extends PlatformID = Buffer>(application: IApplication<I>): {
-        adminId?: I;
+    static getInitOptions<TID extends PlatformID = Buffer>(application: IApplication<TID>): {
+        adminId?: TID;
         adminMnemonic?: SecureString;
         adminPassword?: SecureString;
-        adminRoleId?: I;
-        adminUserRoleId?: I;
+        adminRoleId?: TID;
+        adminUserRoleId?: TID;
         adminBackupCodes?: BackupCode[];
-        memberId?: I;
+        memberId?: TID;
         memberMnemonic?: SecureString;
         memberPassword?: SecureString;
-        memberRoleId?: I;
-        memberUserRoleId?: I;
+        memberRoleId?: TID;
+        memberUserRoleId?: TID;
         memberBackupCodes?: BackupCode[];
-        systemId?: I;
+        systemId?: TID;
         systemMnemonic?: SecureString;
         systemPassword?: SecureString;
-        systemRoleId?: I;
-        systemUserRoleId?: I;
+        systemRoleId?: TID;
+        systemUserRoleId?: TID;
         systemBackupCodes?: BackupCode[];
     };
-    static serverInitResultHash<I extends PlatformID = Buffer>(serverInitResult: IServerInitResult<I>): string;
+    static serverInitResultHash<TID extends PlatformID = Buffer>(serverInitResult: IServerInitResult<TID>): string;
     /**
-     * Initialize the user database with default users and roles (with dependency injection)
-     * @param application The application
-     * @param keyWrappingService The key wrapping service
-     * @param mnemonicService The mnemonic service
-     * @param eciesService The ECIES service
-     * @param roleService The role service
-     * @param backupCodeService The backup code service
-     * @returns The result of the initialization
+     * Initializes the user database with default users and roles using dependency injection.
+     * @template TID Platform-specific ID type
+     * @param application Application instance
+     * @param keyWrappingService Key wrapping service
+     * @param mnemonicService Mnemonic service
+     * @param eciesService ECIES service
+     * @param roleService Role service
+     * @param backupCodeService Backup code service
+     * @returns Result of the initialization
      */
-    static initUserDbWithServices<I extends PlatformID = Buffer>(application: IApplication<I>, keyWrappingService: KeyWrappingService, mnemonicService: MnemonicService<I>, eciesService: ECIESService<I>, roleService: RoleService<I>, backupCodeService: BackupCodeService<I>): Promise<IDBInitResult<IServerInitResult<I>>>;
-    static serverInitResultsToDotEnv<I extends PlatformID = Buffer>(serverInitResult: IServerInitResult<I>): string;
-    static printServerInitResults<I extends PlatformID = Buffer>(result: IServerInitResult<I>, printDotEnv?: boolean): void;
-    static setEnvFromInitResults<I extends PlatformID = Buffer>(result: IServerInitResult<I>): void;
+    static initUserDbWithServices<TID extends PlatformID = Buffer>(application: IApplication<TID>, keyWrappingService: KeyWrappingService, mnemonicService: MnemonicService<TID>, eciesService: ECIESService<TID>, roleService: RoleService<TID>, backupCodeService: BackupCodeService<TID>): Promise<IDBInitResult<IServerInitResult<TID>>>;
+    static serverInitResultsToDotEnv<TID extends PlatformID = Buffer>(serverInitResult: IServerInitResult<TID>): string;
+    static printServerInitResults<TID extends PlatformID = Buffer>(result: IServerInitResult<TID>, printDotEnv?: boolean): void;
+    static setEnvFromInitResults<TID extends PlatformID = Buffer>(result: IServerInitResult<TID>): void;
     /**
      * Write initialization results to a .env file
      * Updates or adds the credential variables in the specified .env file
@@ -99,13 +125,14 @@ export declare abstract class DatabaseInitializationService {
      * @param result The initialization results containing credentials
      * @param idToString Function to convert IDs to strings
      */
-    static writeEnvFile<I extends PlatformID = Buffer>(envFilePath: string, result: IServerInitResult<I>): void;
+    static writeEnvFile<TID extends PlatformID = Buffer>(envFilePath: string, result: IServerInitResult<TID>): void;
     /**
-     * Initialize the user database with default users and roles (convenience method)
-     * This method creates the necessary services and calls initUserDbWithServices
-     * @param application The application
-     * @returns The result of the initialization
+     * Initializes the user database with default users and roles (convenience method).
+     * Creates necessary services and calls initUserDbWithServices.
+     * @template TID Platform-specific ID type
+     * @param application Application instance
+     * @returns Result of the initialization
      */
-    static initUserDb<I extends PlatformID = Buffer>(application: IApplication<I>): Promise<IFailableResult<IServerInitResult<I>>>;
+    static initUserDb<TID extends PlatformID = Buffer>(application: IApplication<TID>): Promise<IFailableResult<IServerInitResult<TID>>>;
 }
 //# sourceMappingURL=database-initialization.d.ts.map

package/src/services/database-initialization.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"database-initialization.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-node-express-suite/src/services/database-initialization.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,WAAW,EAEX,UAAU,EAEV,YAAY,EAEb,MAAM,4BAA4B,CAAC;AAKpC,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EACL,MAAM,IAAI,aAAa,EACvB,YAAY,EAEZ,UAAU,EACX,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAGL,eAAe,EAKhB,MAAM,iCAAiC,CAAC;AAKzC,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAO5C,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAErE,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAE9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAGrC,8BAAsB,6BAA6B;IAEjD,SAAS,CAAC,MAAM,CAAC,sBAAsB,oFAGnC;IACJ,SAAS,CAAC,MAAM,CAAC,kBAAkB,uBAA8B;IACjE,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAC/B,GAAG,EAAE,MAAM,EACX,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,QAAQ,CAAC,EAAE,MAAM,EACjB,WAAW,CAAC,EAAE,YAAY,GACzB,MAAM;IAOT;;;;;OAKG;WACW,aAAa,CAAC,CAAC,SAAS,UAAU,GAAG,MAAM,EACvD,QAAQ,EAAE,YAAY,GAAG,SAAS,EAClC,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC,GAC5B,YAAY;IAKf;;;;;;;OAOG;WACW,QAAQ,CAAC,CAAC,SAAS,UAAU,GAAG,MAAM,EAClD,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,YAAY,EACtB,EAAE,EAAE,CAAC,GACJ,MAAM;IAST;;;;;;;;;;OAUG;WACW,UAAU,CAAC,CAAC,SAAS,UAAU,GAAG,MAAM,EACpD,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,YAAY,GAAG,SAAS,EAClC,UAAU,EAAE,UAAU,EACtB,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC,EAC7B,QAAQ,CAAC,EAAE,CAAC,EACZ,SAAS,CAAC,EAAE,CAAC,GACZ;QACD,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;QACzB,QAAQ,EAAE,YAAY,CAAC;KACxB;IAwDD;;;;OAIG;WACW,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAmCtD;;;;OAIG;WACiB,YAAY,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC;WAU5D,cAAc,CAAC,CAAC,SAAS,UAAU,GAAG,MAAM,EACxD,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC,GAC3B;QACD,OAAO,CAAC,EAAE,CAAC,CAAC;QACZ,aAAa,CAAC,EAAE,YAAY,CAAC;QAC7B,aAAa,CAAC,EAAE,YAAY,CAAC;QAC7B,WAAW,CAAC,EAAE,CAAC,CAAC;QAChB,eAAe,CAAC,EAAE,CAAC,CAAC;QACpB,gBAAgB,CAAC,EAAE,UAAU,EAAE,CAAC;QAChC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACb,cAAc,CAAC,EAAE,YAAY,CAAC;QAC9B,cAAc,CAAC,EAAE,YAAY,CAAC;QAC9B,YAAY,CAAC,EAAE,CAAC,CAAC;QACjB,gBAAgB,CAAC,EAAE,CAAC,CAAC;QACrB,iBAAiB,CAAC,EAAE,UAAU,EAAE,CAAC;QACjC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACb,cAAc,CAAC,EAAE,YAAY,CAAC;QAC9B,cAAc,CAAC,EAAE,YAAY,CAAC;QAC9B,YAAY,CAAC,EAAE,CAAC,CAAC;QACjB,gBAAgB,CAAC,EAAE,CAAC,CAAC;QACrB,iBAAiB,CAAC,EAAE,UAAU,EAAE,CAAC;KAClC;WAoCa,oBAAoB,CAAC,CAAC,SAAS,UAAU,GAAG,MAAM,EAC9D,gBAAgB,EAAE,iBAAiB,CAAC,CAAC,CAAC,GACrC,MAAM;IAiCT;;;;;;;;;OASG;WACiB,sBAAsB,CAAC,CAAC,SAAS,UAAU,GAAG,MAAM,EACtE,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC,EAC5B,kBAAkB,EAAE,kBAAkB,EACtC,eAAe,EAAE,eAAe,CAAC,CAAC,CAAC,EACnC,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC,EAC7B,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,EAC3B,iBAAiB,EAAE,iBAAiB,CAAC,CAAC,CAAC,GACtC,OAAO,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;WAgvBjC,yBAAyB,CAAC,CAAC,SAAS,UAAU,GAAG,MAAM,EACnE,gBAAgB,EAAE,iBAAiB,CAAC,CAAC,CAAC,GACrC,MAAM;WAqBK,sBAAsB,CAAC,CAAC,SAAS,UAAU,GAAG,MAAM,EAChE,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAC5B,WAAW,GAAE,OAAc,GAC1B,IAAI;WAyUO,qBAAqB,CAAC,CAAC,SAAS,UAAU,GAAG,MAAM,EAC/D,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC3B,IAAI;IAwCP;;;;;;OAMG;WACW,YAAY,CAAC,CAAC,SAAS,UAAU,GAAG,MAAM,EACtD,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC3B,IAAI;IAqEP;;;;;OAKG;WACiB,UAAU,CAAC,CAAC,SAAS,UAAU,GAAG,MAAM,EAC1D,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC,GAC3B,OAAO,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;CAoClD"}
+{"version":3,"file":"database-initialization.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-node-express-suite/src/services/database-initialization.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAEL,WAAW,EAEX,UAAU,EAEV,YAAY,EAEb,MAAM,4BAA4B,CAAC;AAKpC,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EACL,MAAM,IAAI,aAAa,EACvB,YAAY,EAEZ,UAAU,EACX,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAGL,eAAe,EAKhB,MAAM,iCAAiC,CAAC;AAKzC,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAO5C,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAErE,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAE9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAGrC;;;GAGG;AACH,8BAAsB,6BAA6B;IACjD;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,sBAAsB,oFAGnC;IACJ,qDAAqD;IACrD,SAAS,CAAC,MAAM,CAAC,kBAAkB,uBAA8B;IAEjE;;;;;;;OAOG;IACH,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAC/B,GAAG,EAAE,MAAM,EACX,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,QAAQ,CAAC,EAAE,MAAM,EACjB,WAAW,CAAC,EAAE,YAAY,GACzB,MAAM;IAOT;;;;;;OAMG;WACW,aAAa,CAAC,GAAG,SAAS,UAAU,GAAG,MAAM,EACzD,QAAQ,EAAE,YAAY,GAAG,SAAS,EAClC,YAAY,EAAE,YAAY,CAAC,GAAG,CAAC,GAC9B,YAAY;IAKf;;;;;;;;OAQG;WACW,QAAQ,CAAC,GAAG,SAAS,UAAU,GAAG,MAAM,EACpD,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,YAAY,EACtB,EAAE,EAAE,GAAG,GACN,MAAM;IAST;;;;;;;;;;;OAWG;WACW,UAAU,CAAC,GAAG,SAAS,UAAU,GAAG,MAAM,EACtD,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,YAAY,GAAG,SAAS,EAClC,UAAU,EAAE,UAAU,EACtB,YAAY,EAAE,YAAY,CAAC,GAAG,CAAC,EAC/B,QAAQ,CAAC,EAAE,GAAG,EACd,SAAS,CAAC,EAAE,GAAG,GACd;QACD,MAAM,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;QAC3B,QAAQ,EAAE,YAAY,CAAC;KACxB;IAwDD;;;;OAIG;WACW,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAmCtD;;;;OAIG;WACiB,YAAY,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC;WAU5D,cAAc,CAAC,GAAG,SAAS,UAAU,GAAG,MAAM,EAC1D,WAAW,EAAE,YAAY,CAAC,GAAG,CAAC,GAC7B;QACD,OAAO,CAAC,EAAE,GAAG,CAAC;QACd,aAAa,CAAC,EAAE,YAAY,CAAC;QAC7B,aAAa,CAAC,EAAE,YAAY,CAAC;QAC7B,WAAW,CAAC,EAAE,GAAG,CAAC;QAClB,eAAe,CAAC,EAAE,GAAG,CAAC;QACtB,gBAAgB,CAAC,EAAE,UAAU,EAAE,CAAC;QAChC,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,cAAc,CAAC,EAAE,YAAY,CAAC;QAC9B,cAAc,CAAC,EAAE,YAAY,CAAC;QAC9B,YAAY,CAAC,EAAE,GAAG,CAAC;QACnB,gBAAgB,CAAC,EAAE,GAAG,CAAC;QACvB,iBAAiB,CAAC,EAAE,UAAU,EAAE,CAAC;QACjC,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,cAAc,CAAC,EAAE,YAAY,CAAC;QAC9B,cAAc,CAAC,EAAE,YAAY,CAAC;QAC9B,YAAY,CAAC,EAAE,GAAG,CAAC;QACnB,gBAAgB,CAAC,EAAE,GAAG,CAAC;QACvB,iBAAiB,CAAC,EAAE,UAAU,EAAE,CAAC;KAClC;WAoCa,oBAAoB,CAAC,GAAG,SAAS,UAAU,GAAG,MAAM,EAChE,gBAAgB,EAAE,iBAAiB,CAAC,GAAG,CAAC,GACvC,MAAM;IAiCT;;;;;;;;;;OAUG;WACiB,sBAAsB,CAAC,GAAG,SAAS,UAAU,GAAG,MAAM,EACxE,WAAW,EAAE,YAAY,CAAC,GAAG,CAAC,EAC9B,kBAAkB,EAAE,kBAAkB,EACtC,eAAe,EAAE,eAAe,CAAC,GAAG,CAAC,EACrC,YAAY,EAAE,YAAY,CAAC,GAAG,CAAC,EAC/B,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC,EAC7B,iBAAiB,EAAE,iBAAiB,CAAC,GAAG,CAAC,GACxC,OAAO,CAAC,aAAa,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC;WAgvBnC,yBAAyB,CAAC,GAAG,SAAS,UAAU,GAAG,MAAM,EACrE,gBAAgB,EAAE,iBAAiB,CAAC,GAAG,CAAC,GACvC,MAAM;WAqBK,sBAAsB,CAAC,GAAG,SAAS,UAAU,GAAG,MAAM,EAClE,MAAM,EAAE,iBAAiB,CAAC,GAAG,CAAC,EAC9B,WAAW,GAAE,OAAc,GAC1B,IAAI;WAyUO,qBAAqB,CAAC,GAAG,SAAS,UAAU,GAAG,MAAM,EACjE,MAAM,EAAE,iBAAiB,CAAC,GAAG,CAAC,GAC7B,IAAI;IA0CP;;;;;;OAMG;WACW,YAAY,CAAC,GAAG,SAAS,UAAU,GAAG,MAAM,EACxD,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,iBAAiB,CAAC,GAAG,CAAC,GAC7B,IAAI;IAuEP;;;;;;OAMG;WACiB,UAAU,CAAC,GAAG,SAAS,UAAU,GAAG,MAAM,EAC5D,WAAW,EAAE,YAAY,CAAC,GAAG,CAAC,GAC7B,OAAO,CAAC,eAAe,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC;CAoCpD"}

package/src/services/database-initialization.js

@@ -1,4 +1,9 @@
 "use strict";
+/**
+ * @fileoverview Service for initializing the database with default users, roles, and relationships.
+ * Handles creation of system, admin, and member users with encrypted credentials and backup codes.
+ * @module services/database-initialization
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DatabaseInitializationService = void 0;
 const tslib_1 = require("tslib");
@@ -19,19 +24,36 @@ const backup_code_2 = require("./backup-code");
 const mnemonic_1 = require("./mnemonic");
 const role_1 = require("./role");
 const system_user_1 = require("./system-user");
+/**
+ * Service for initializing the database with default users, roles, and relationships.
+ * Manages creation of system, admin, and member accounts with encrypted credentials.
+ */
 class DatabaseInitializationService {
-    // Static initialization state management
+    /**
+     * Static initialization state management to prevent concurrent initialization.
+     * @private
+     */
     static initializationPromises = new Map();
+    /** Initialization lock to prevent race conditions */
     static initializationLock = new Map();
+    /**
+     * Default i18n translation function for database initialization messages.
+     * @param str String key to translate
+     * @param variables Template variables
+     * @param language Target language
+     * @param application Application instance
+     * @returns Translated string
+     */
     static defaultI18nTFunc(str, variables, language, application) {
         // Handles template strings with {{component.key}} syntax
         return (0, suite_core_lib_1.getSuiteCoreI18nEngine)(application ? { constants: application.constants } : undefined).t(str, variables, language);
     }
     /**
-     * Get the mnemonic or generate a new one if not present
-     * @param mnemonic The existing mnemonic or undefined
-     * @param eciesService The ECIES service to generate a new mnemonic
-     * @returns The existing or new mnemonic
+     * Gets the mnemonic or generates a new one if not present.
+     * @template TID Platform-specific ID type
+     * @param mnemonic Existing mnemonic or undefined
+     * @param eciesService ECIES service to generate a new mnemonic
+     * @returns Existing or new mnemonic
      */
     static mnemonicOrNew(mnemonic, eciesService) {
         return mnemonic && mnemonic.hasValue
@@ -39,12 +61,13 @@ class DatabaseInitializationService {
             : eciesService.generateNewMnemonic();
     }
     /**
-     * Generate a cache key for a user based on their details
-     * @param username The username
-     * @param email The email address
-     * @param mnemonic The mnemonic
-     * @param id The user ID
-     * @returns The generated cache key
+     * Generates a cache key for a user based on their details.
+     * @template TID Platform-specific ID type
+     * @param username Username
+     * @param email Email address
+     * @param mnemonic Mnemonic
+     * @param id User ID
+     * @returns Generated cache key as hex string
      */
     static cacheKey(username, email, mnemonic, id) {
         const idProvider = (0, node_ecies_lib_1.getEnhancedNodeIdProvider)();
@@ -54,15 +77,16 @@ class DatabaseInitializationService {
         return crcHash.toString(16).padStart(8, '0');
     }
     /**
-     * Get a cached BackendMember or create a new one if not cached
-     * @param username The username
-     * @param email The email address
-     * @param mnemonic The mnemonic or undefined to generate a new one
-     * @param memberType The type of member (Admin, Member, System)
-     * @param eciesService The ECIES service to handle key generation
+     * Gets a cached BackendMember or creates a new one if not cached.
+     * @template TID Platform-specific ID type
+     * @param username Username
+     * @param email Email address
+     * @param mnemonic Mnemonic or undefined to generate a new one
+     * @param memberType Type of member (Admin, Member, System)
+     * @param eciesService ECIES service to handle key generation
      * @param memberId Optional specific member ID to use
      * @param createdBy Optional ID of the user who created this member
-     * @returns The cached or newly created BackendMember and the mnemonic used
+     * @returns Cached or newly created BackendMember and the mnemonic used
      */
     static cacheOrNew(username, email, mnemonic, memberType, eciesService, memberId, createdBy) {
         const idProvider = (0, node_ecies_lib_1.getEnhancedNodeIdProvider)();
@@ -90,9 +114,9 @@ class DatabaseInitializationService {
         }
     }
     /**
-     * Generate a random password
-     * @param length The length of the password
-     * @returns The generated password
+     * Generates a random password meeting security requirements.
+     * @param length Length of the password
+     * @returns Generated password string
      */
     static generatePassword(length) {
         const specialCharacters = "!@#$%^&*()_+-=[]{};':|,.<>/?";
@@ -125,8 +149,8 @@ class DatabaseInitializationService {
         return chars.join('');
     }
     /**
-     * Drops the database
-     * @param connection The database connection
+     * Drops the database.
+     * @param connection Database connection
      * @returns True if the database was dropped, false if not connected
      */
     static async dropDatabase(connection) {
@@ -203,14 +227,15 @@ class DatabaseInitializationService {
         return h.digest('hex');
     }
     /**
-     * Initialize the user database with default users and roles (with dependency injection)
-     * @param application The application
-     * @param keyWrappingService The key wrapping service
-     * @param mnemonicService The mnemonic service
-     * @param eciesService The ECIES service
-     * @param roleService The role service
-     * @param backupCodeService The backup code service
-     * @returns The result of the initialization
+     * Initializes the user database with default users and roles using dependency injection.
+     * @template TID Platform-specific ID type
+     * @param application Application instance
+     * @param keyWrappingService Key wrapping service
+     * @param mnemonicService Mnemonic service
+     * @param eciesService ECIES service
+     * @param roleService Role service
+     * @param backupCodeService Backup code service
+     * @returns Result of the initialization
      */
     static async initUserDbWithServices(application, keyWrappingService, mnemonicService, eciesService, roleService, backupCodeService) {
         const engine = (0, suite_core_lib_1.getSuiteCoreI18nEngine)({ constants: application.constants });
@@ -851,10 +876,11 @@ SYSTEM_PASSWORD="${serverInitResult.systemPassword}"
         }));
     }
     /**
-     * Initialize the user database with default users and roles (convenience method)
-     * This method creates the necessary services and calls initUserDbWithServices
-     * @param application The application
-     * @returns The result of the initialization
+     * Initializes the user database with default users and roles (convenience method).
+     * Creates necessary services and calls initUserDbWithServices.
+     * @template TID Platform-specific ID type
+     * @param application Application instance
+     * @returns Result of the initialization
      */
     static async initUserDb(application) {
         const mnemonicModel = model_registry_1.ModelRegistry.instance.getTypedModel(base_model_name_1.BaseModelName.Mnemonic);