@digitaldefiance/node-express-suite 1.0.22 → 1.0.24

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

@@ -0,0 +1,105 @@
+import { EmailString, MemberType, SecureString } from '@digitaldefiance/ecies-lib';
+import { CoreLanguageCode } from '@digitaldefiance/i18n-lib';
+import { Member as BackendMember, ECIESService } from '@digitaldefiance/node-ecies-lib';
+import { IFailableResult } from '@digitaldefiance/suite-core-lib';
+import { Connection, Types } from 'mongoose';
+import { BackupCode } from '../backup-code';
+import { IBaseDocument } from '../documents/base';
+import { Environment } from '../environment';
+import { IConstants } 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';
+export declare abstract class DatabaseInitializationService {
+    protected static initializationPromises: Map<string, Promise<IFailableResult<IServerInitResult>>>;
+    protected static initializationLock: Map<string, boolean>;
+    protected static defaultI18nTFunc: (str: string, language?: CoreLanguageCode, ...otherVars: Record<string, string | number>[]) => 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
+     */
+    static mnemonicOrNew(mnemonic: SecureString | undefined, eciesService: ECIESService): 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
+     */
+    static cacheKey(username: string, email: EmailString, mnemonic: SecureString, id: Types.ObjectId): 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
+     * @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
+     */
+    static cacheOrNew(username: string, email: EmailString, mnemonic: SecureString | undefined, memberType: MemberType, eciesService: ECIESService, memberId?: Types.ObjectId, createdBy?: Types.ObjectId): {
+        member: BackendMember;
+        mnemonic: SecureString;
+    };
+    /**
+     * Generate a random password
+     * @param length The length of the password
+     * @returns The generated password
+     */
+    static generatePassword(length: number): string;
+    /**
+     * Drops the database
+     * @param connection The database connection
+     * @returns True if the database was dropped, false if not connected
+     */
+    static dropDatabase(connection: Connection): Promise<boolean>;
+    static getInitOptions(application: IApplication<any, Types.ObjectId, IBaseDocument<any, Types.ObjectId>, Environment, IConstants>): {
+        adminId?: Types.ObjectId;
+        adminMnemonic?: SecureString;
+        adminPassword?: SecureString;
+        adminRoleId?: Types.ObjectId;
+        adminUserRoleId?: Types.ObjectId;
+        adminBackupCodes?: BackupCode[];
+        memberId?: Types.ObjectId;
+        memberMnemonic?: SecureString;
+        memberPassword?: SecureString;
+        memberRoleId?: Types.ObjectId;
+        memberUserRoleId?: Types.ObjectId;
+        memberBackupCodes?: BackupCode[];
+        systemId?: Types.ObjectId;
+        systemMnemonic?: SecureString;
+        systemPassword?: SecureString;
+        systemRoleId?: Types.ObjectId;
+        systemUserRoleId?: Types.ObjectId;
+        systemBackupCodes?: BackupCode[];
+    };
+    static serverInitResultHash(serverInitResult: IServerInitResult): 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
+     */
+    static initUserDbWithServices(application: IApplication<any, Types.ObjectId, IBaseDocument<any, Types.ObjectId>, Environment, IConstants>, keyWrappingService: KeyWrappingService, mnemonicService: MnemonicService, eciesService: ECIESService, roleService: RoleService, backupCodeService: BackupCodeService): Promise<IFailableResult<IServerInitResult>>;
+    static printServerInitResults(result: IServerInitResult): void;
+    static setEnvFromInitResults(result: IServerInitResult): 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
+     */
+    static initUserDb(application: IApplication<any, Types.ObjectId, IBaseDocument<any, Types.ObjectId>, Environment, IConstants>): Promise<IFailableResult<IServerInitResult>>;
+}
+//# 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,OAAO,EAEL,WAAW,EAEX,UAAU,EAEV,YAAY,EACb,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EACL,MAAM,IAAI,aAAa,EACvB,YAAY,EACb,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAIL,eAAe,EAKhB,MAAM,iCAAiC,CAAC;AAIzC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAKlD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,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,2DAGnC;IACJ,SAAS,CAAC,MAAM,CAAC,kBAAkB,uBAA8B;IACjE,SAAS,CAAC,MAAM,CAAC,gBAAgB,EAAE,CACjC,GAAG,EAAE,MAAM,EACX,QAAQ,CAAC,EAAE,gBAAgB,EAC3B,GAAG,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EAAE,KAC5C,MAAM,CAA8B;IAEzC;;;;;OAKG;WACW,aAAa,CACzB,QAAQ,EAAE,YAAY,GAAG,SAAS,EAClC,YAAY,EAAE,YAAY,GACzB,YAAY;IAKf;;;;;;;OAOG;WACW,QAAQ,CACpB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,YAAY,EACtB,EAAE,EAAE,KAAK,CAAC,QAAQ,GACjB,MAAM;IAQT;;;;;;;;;;OAUG;WACW,UAAU,CACtB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,YAAY,GAAG,SAAS,EAClC,UAAU,EAAE,UAAU,EACtB,YAAY,EAAE,YAAY,EAC1B,QAAQ,CAAC,EAAE,KAAK,CAAC,QAAQ,EACzB,SAAS,CAAC,EAAE,KAAK,CAAC,QAAQ,GACzB;QACD,MAAM,EAAE,aAAa,CAAC;QACtB,QAAQ,EAAE,YAAY,CAAC;KACxB;IAkDD;;;;OAIG;WACW,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAmCtD;;;;OAIG;WACiB,YAAY,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC;WAU5D,cAAc,CAC1B,WAAW,EAAE,YAAY,CACvB,GAAG,EACH,KAAK,CAAC,QAAQ,EACd,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAC,EAClC,WAAW,EACX,UAAU,CACX,GACA;QACD,OAAO,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC;QACzB,aAAa,CAAC,EAAE,YAAY,CAAC;QAC7B,aAAa,CAAC,EAAE,YAAY,CAAC;QAC7B,WAAW,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC;QAC7B,eAAe,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC;QACjC,gBAAgB,CAAC,EAAE,UAAU,EAAE,CAAC;QAChC,QAAQ,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC;QAC1B,cAAc,CAAC,EAAE,YAAY,CAAC;QAC9B,cAAc,CAAC,EAAE,YAAY,CAAC;QAC9B,YAAY,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC;QAC9B,gBAAgB,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC;QAClC,iBAAiB,CAAC,EAAE,UAAU,EAAE,CAAC;QACjC,QAAQ,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC;QAC1B,cAAc,CAAC,EAAE,YAAY,CAAC;QAC9B,cAAc,CAAC,EAAE,YAAY,CAAC;QAC9B,YAAY,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC;QAC9B,gBAAgB,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC;QAClC,iBAAiB,CAAC,EAAE,UAAU,EAAE,CAAC;KAClC;WA2Da,oBAAoB,CAChC,gBAAgB,EAAE,iBAAiB,GAClC,MAAM;IAgCT;;;;;;;;;OASG;WACiB,sBAAsB,CACxC,WAAW,EAAE,YAAY,CACvB,GAAG,EACH,KAAK,CAAC,QAAQ,EACd,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAC,EAClC,WAAW,EACX,UAAU,CACX,EACD,kBAAkB,EAAE,kBAAkB,EACtC,eAAe,EAAE,eAAe,EAChC,YAAY,EAAE,YAAY,EAC1B,WAAW,EAAE,WAAW,EACxB,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;WAisBhC,sBAAsB,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;WA+UvD,qBAAqB,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IAyBpE;;;;;OAKG;WACiB,UAAU,CAC5B,WAAW,EAAE,YAAY,CACvB,GAAG,EACH,KAAK,CAAC,QAAQ,EACd,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAC,EAClC,WAAW,EACX,UAAU,CACX,GACA,OAAO,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;CAoC/C"}