@digitaldefiance/node-express-suite 3.7.5 → 3.7.6

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

@@ -0,0 +1,138 @@
+/**
+ * @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';
+import { IFailableResult } from '@digitaldefiance/suite-core-lib';
+import { BackupCode } from '../backup-code';
+import { IDBInitResult } from '../interfaces';
+import { IApplication } from '../interfaces/application';
+import { IServerInitResult } from '../interfaces/server-init-result';
+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;
+    /**
+     * 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<TID extends PlatformID = Buffer>(mnemonic: SecureString | undefined, eciesService: ECIESService<TID>): SecureString;
+    /**
+     * 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<TID extends PlatformID = Buffer>(username: string, email: EmailString, mnemonic: SecureString, id: TID): string;
+    /**
+     * 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 Cached or newly created BackendMember and the mnemonic used
+     */
+    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;
+    };
+    /**
+     * 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 Database connection
+     * @returns True if the database was dropped, false if not connected
+     */
+    static dropDatabase(connection: Connection): Promise<boolean>;
+    static getInitOptions<TID extends PlatformID = Buffer>(application: IApplication<TID>): {
+        adminId?: TID;
+        adminMnemonic?: SecureString;
+        adminPassword?: SecureString;
+        adminRoleId?: TID;
+        adminUserRoleId?: TID;
+        adminBackupCodes?: BackupCode[];
+        memberId?: TID;
+        memberMnemonic?: SecureString;
+        memberPassword?: SecureString;
+        memberRoleId?: TID;
+        memberUserRoleId?: TID;
+        memberBackupCodes?: BackupCode[];
+        systemId?: TID;
+        systemMnemonic?: SecureString;
+        systemPassword?: SecureString;
+        systemRoleId?: TID;
+        systemUserRoleId?: TID;
+        systemBackupCodes?: BackupCode[];
+    };
+    static serverInitResultHash<TID extends PlatformID = Buffer>(serverInitResult: IServerInitResult<TID>): string;
+    /**
+     * 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<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
+     * @param envFilePath Path to the .env file to update
+     * @param result The initialization results containing credentials
+     * @param idToString Function to convert IDs to strings
+     */
+    static writeEnvFile<TID extends PlatformID = Buffer>(envFilePath: string, result: IServerInitResult<TID>): void;
+    /**
+     * 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<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

@@ -0,0 +1 @@
+{"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"}