@digitaldefiance/node-express-suite 3.6.13 → 3.6.15

package/src/environment.d.ts

@@ -0,0 +1,190 @@
+import { SecureBuffer, SecureString } from '@digitaldefiance/ecies-lib';
+import { Types } from '@digitaldefiance/mongoose-types';
+import { BackupCode } from './backup-code';
+import { IConstants } from './interfaces/constants';
+import { IEnvironment } from './interfaces/environment';
+import { IMongoEnvironment } from './interfaces/environment-mongo';
+import type { EnvironmentVariables } from './types/environment-variables';
+import { DEBUG_TYPE } from './utils';
+export declare class Environment<I = Types.ObjectId> implements IEnvironment<I> {
+    private readonly _environment;
+    private readonly _envObject;
+    static requireEnv<T>(key: string, obj: EnvironmentVariables): T;
+    constructor(path?: string, initialization?: boolean, override?: boolean, constants?: IConstants, idAdapter?: (bytes: Uint8Array) => I);
+    has(key: string): boolean;
+    get(key: string): string | undefined;
+    setEnvironment(key: string, value: any): void;
+    getObject(): object;
+    get idAdapter(): (bytes: Uint8Array) => I;
+    /**
+     * Whether to print certain console debug messages and enable certain debug features
+     */
+    get debug(): boolean;
+    /**
+     * Whether to use a development database (eg with less durability and security for ease of local dev)
+     */
+    get devDatabase(): string | undefined;
+    get detailedDebug(): boolean;
+    /**
+     * The hostname of this server
+     */
+    get host(): string;
+    /**
+     * The primary port of this server
+     */
+    get port(): number;
+    /**
+     * The JWT secret of this server
+     */
+    get jwtSecret(): string;
+    /**
+     * The email sernder for this site
+     */
+    get emailSender(): string;
+    /**
+     * The base path of the express http server (eg /)
+     */
+    get basePath(): string;
+    /**
+     * The full URL to the server
+     */
+    get serverUrl(): string;
+    /**
+     * The path to the API dist directory
+     */
+    get apiDistDir(): string;
+    /**
+     * The path to the react dist directory
+     */
+    get reactDistDir(): string;
+    /**
+     * The directory + cert root name (eg /workspaces/myapp/locahost+2) to store HTTPS development certificates
+     */
+    get httpsDevCertRoot(): string | undefined;
+    /**
+     * The port to use for development HTTPS
+     */
+    get httpsDevPort(): number;
+    /**
+     * Whether to disable email sending
+     */
+    get disableEmailSend(): boolean;
+    /**
+     * The MongoDB configuration (primarily for transactions)
+     */
+    get mongo(): IMongoEnvironment;
+    /**
+     * The admin user's mnemonic used to encrypt all files
+     */
+    get adminMnemonic(): SecureString | undefined;
+    /**
+     * The date the admin user was created
+     */
+    get adminCreatedAt(): Date | undefined;
+    /**
+     * The ID of the admin user
+     */
+    get adminId(): I | undefined;
+    /**
+     * The password of the admin user
+     */
+    get adminPassword(): SecureString | undefined;
+    /**
+     * The role ID of the admin user
+     */
+    get adminRoleId(): I | undefined;
+    /**
+     * The user role ID of the admin user
+     */
+    get adminUserRoleId(): I | undefined;
+    /**
+     * Backup codes for the admin user
+     */
+    get adminBackupCodes(): BackupCode[] | undefined;
+    /**
+     * The test member user's mnemonic used to encrypt all files
+     */
+    get memberMnemonic(): SecureString | undefined;
+    /**
+     * The date the member user was created
+     */
+    get memberCreatedAt(): Date | undefined;
+    /**
+     * The date the member user was created
+     */
+    get memberId(): I | undefined;
+    /**
+     * The password of the member user
+     */
+    get memberPassword(): SecureString | undefined;
+    /**
+     * The role ID of the member user
+     */
+    get memberRoleId(): I | undefined;
+    /**
+     * The user role ID of the member user
+     */
+    get memberUserRoleId(): I | undefined;
+    /**
+     * Backup codes for the member user
+     */
+    get memberBackupCodes(): BackupCode[] | undefined;
+    /**
+     * The system user's mnemonic used to encrypt all files
+     */
+    get systemMnemonic(): SecureString | undefined;
+    /**
+     * The date the system user was created
+     */
+    get systemCreatedAt(): Date | undefined;
+    /**
+     * The ID of the system user
+     */
+    get systemId(): I | undefined;
+    /**
+     * The public key of the system user
+     */
+    get systemPublicKeyHex(): string | undefined;
+    /**
+     * The password of the system user
+     */
+    get systemPassword(): SecureString | undefined;
+    /**
+     * The role ID of the system user
+     */
+    get systemRoleId(): I | undefined;
+    /**
+     * The user role ID of the system user
+     */
+    get systemUserRoleId(): I | undefined;
+    /**
+     * Backup codes for the system user
+     */
+    get systemBackupCodes(): BackupCode[] | undefined;
+    /**
+     * The system's HMAC secret for the mnemonic tracking collection
+     */
+    get mnemonicHmacSecret(): SecureBuffer;
+    /**
+     * The system's HMAC encryption key for the mnemonic tracking collection
+     */
+    get mnemonicEncryptionKey(): SecureBuffer;
+    /**
+     * The timezone for the server
+     */
+    get timezone(): string;
+    get adminLanguage(): string;
+    /**
+     * The number of pbkdf2 iterations for key wrapping
+     */
+    get pbkdf2Iterations(): number;
+    /**
+     * Whether this is a production environment
+     */
+    get production(): boolean;
+    /**
+     * Console dump the environment variables for debugging purposes
+     */
+    dumpEnvironment(logLevel?: DEBUG_TYPE): void;
+}
+//# sourceMappingURL=environment.d.ts.map

package/src/environment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../../../packages/digitaldefiance-node-express-suite/src/environment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAQxE,OAAO,EAAE,KAAK,EAAE,MAAM,iCAAiC,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAI3C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EACL,UAAU,EAMX,MAAM,SAAS,CAAC;AAEjB,qBAAa,WAAW,CAAC,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAE,YAAW,YAAY,CAAC,CAAC,CAAC;IACrE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAkB;IAC/C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAuB;WACpC,UAAU,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,oBAAoB,GAAG,CAAC;gBAiBpE,IAAI,CAAC,EAAE,MAAM,EACb,cAAc,UAAQ,EACtB,QAAQ,UAAO,EACf,SAAS,GAAE,UAA+B,EAC1C,SAAS,GAAE,CAAC,KAAK,EAAE,UAAU,KAAK,CACW;IAgYxC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIzB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAIpC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IAU7C,SAAS,IAAI,MAAM;IAI1B,IAAW,SAAS,IAAI,CAAC,KAAK,EAAE,UAAU,KAAK,CAAC,CAE/C;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,OAAO,CAE1B;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,MAAM,GAAG,SAAS,CAE3C;IAED,IAAW,aAAa,IAAI,OAAO,CAElC;IAED;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,MAAM,CAE/B;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED;;OAEG;IACH,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED;;OAEG;IACH,IAAW,UAAU,IAAI,MAAM,CAE9B;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED;;OAEG;IACH,IAAW,gBAAgB,IAAI,MAAM,GAAG,SAAS,CAEhD;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED;;OAEG;IACH,IAAW,gBAAgB,IAAI,OAAO,CAErC;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,iBAAiB,CAEpC;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,YAAY,GAAG,SAAS,CAEnD;IAED;;OAEG;IACH,IAAW,cAAc,IAAI,IAAI,GAAG,SAAS,CAE5C;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,CAAC,GAAG,SAAS,CAElC;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,YAAY,GAAG,SAAS,CAEnD;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,CAAC,GAAG,SAAS,CAEtC;IAED;;OAEG;IACH,IAAW,eAAe,IAAI,CAAC,GAAG,SAAS,CAE1C;IAED;;OAEG;IACH,IAAW,gBAAgB,IAAI,UAAU,EAAE,GAAG,SAAS,CAEtD;IAED;;OAEG;IACH,IAAW,cAAc,IAAI,YAAY,GAAG,SAAS,CAEpD;IAED;;OAEG;IACH,IAAW,eAAe,IAAI,IAAI,GAAG,SAAS,CAE7C;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,CAAC,GAAG,SAAS,CAEnC;IAED;;OAEG;IACH,IAAW,cAAc,IAAI,YAAY,GAAG,SAAS,CAEpD;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,CAAC,GAAG,SAAS,CAEvC;IAED;;OAEG;IACH,IAAW,gBAAgB,IAAI,CAAC,GAAG,SAAS,CAE3C;IAED;;OAEG;IACH,IAAW,iBAAiB,IAAI,UAAU,EAAE,GAAG,SAAS,CAEvD;IAED;;OAEG;IACH,IAAW,cAAc,IAAI,YAAY,GAAG,SAAS,CAEpD;IAED;;OAEG;IACH,IAAW,eAAe,IAAI,IAAI,GAAG,SAAS,CAE7C;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,CAAC,GAAG,SAAS,CAEnC;IAED;;OAEG;IACH,IAAW,kBAAkB,IAAI,MAAM,GAAG,SAAS,CAElD;IAED;;OAEG;IACH,IAAW,cAAc,IAAI,YAAY,GAAG,SAAS,CAEpD;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,CAAC,GAAG,SAAS,CAEvC;IAED;;OAEG;IACH,IAAW,gBAAgB,IAAI,CAAC,GAAG,SAAS,CAE3C;IAED;;OAEG;IACH,IAAW,iBAAiB,IAAI,UAAU,EAAE,GAAG,SAAS,CAEvD;IAED;;OAEG;IACH,IAAW,kBAAkB,IAAI,YAAY,CAE5C;IAED;;OAEG;IACH,IAAW,qBAAqB,IAAI,YAAY,CAE/C;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED,IAAW,aAAa,IAAI,MAAM,CAEjC;IAED;;OAEG;IACH,IAAW,gBAAgB,IAAI,MAAM,CAEpC;IAED;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;OAEG;IACI,eAAe,CAAC,QAAQ,GAAE,UAAkB,GAAG,IAAI;CA4E3D"}