@digitaldefiance/node-express-suite 3.7.5 → 3.7.6

package/src/enumerations/{length-encoding-type.ts → length-encoding-type.d.ts}

@@ -3,14 +3,14 @@
  * Defines encoding types for different integer sizes (8, 16, 32, 64 bit).
  * @module enumerations/length-encoding-type
  */
-
 /**
  * Enumeration for length encoding types used in data serialization.
  * Determines how length values are encoded based on data size.
  */
-export enum LengthEncodingType {
-  UInt8 = 0,
-  UInt16 = 1,
-  UInt32 = 2,
-  UInt64 = 3,
+export declare enum LengthEncodingType {
+    UInt8 = 0,
+    UInt16 = 1,
+    UInt32 = 2,
+    UInt64 = 3
 }
+//# sourceMappingURL=length-encoding-type.d.ts.map

package/src/enumerations/length-encoding-type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"length-encoding-type.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-node-express-suite/src/enumerations/length-encoding-type.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,KAAK,IAAI;IACT,MAAM,IAAI;IACV,MAAM,IAAI;IACV,MAAM,IAAI;CACX"}

package/src/enumerations/length-encoding-type.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * @fileoverview Length encoding type enumeration for variable-length data encoding.
+ * Defines encoding types for different integer sizes (8, 16, 32, 64 bit).
+ * @module enumerations/length-encoding-type
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LengthEncodingType = void 0;
+/**
+ * Enumeration for length encoding types used in data serialization.
+ * Determines how length values are encoded based on data size.
+ */
+var LengthEncodingType;
+(function (LengthEncodingType) {
+    LengthEncodingType[LengthEncodingType["UInt8"] = 0] = "UInt8";
+    LengthEncodingType[LengthEncodingType["UInt16"] = 1] = "UInt16";
+    LengthEncodingType[LengthEncodingType["UInt32"] = 2] = "UInt32";
+    LengthEncodingType[LengthEncodingType["UInt64"] = 3] = "UInt64";
+})(LengthEncodingType || (exports.LengthEncodingType = LengthEncodingType = {}));
+//# sourceMappingURL=length-encoding-type.js.map

package/src/enumerations/length-encoding-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"length-encoding-type.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-node-express-suite/src/enumerations/length-encoding-type.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH;;;GAGG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,6DAAS,CAAA;IACT,+DAAU,CAAA;IACV,+DAAU,CAAA;IACV,+DAAU,CAAA;AACZ,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B"}

package/src/enumerations/schema-collection.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @fileoverview Schema collection name enumeration for MongoDB collections.
+ * Defines standardized collection names used throughout the application.
+ * @module enumerations/schema-collection
+ */
+/**
+ * Enumerations for the schema collections.
+ */
+export declare enum SchemaCollection {
+    /**
+     * Collection for email tokens sent to users
+     */
+    EmailToken = "email-tokens",
+    /**
+     * Collection for roles in the application
+     */
+    Role = "roles",
+    /**
+     * Collection for user tokens
+     */
+    UserToken = "user-tokens",
+    /**
+     * Collection for users in the application
+     */
+    User = "users",
+    /**
+     * Collection for mnemonics used in the application
+     */
+    Mnemonic = "mnemonics",
+    /**
+     * Collection for user-role relationships
+     */
+    UserRole = "user-roles",
+    /**
+     * Collection for used direct login tokens
+     */
+    UsedDirectLoginToken = "used-direct-login-tokens"
+}
+//# sourceMappingURL=schema-collection.d.ts.map

package/src/enumerations/schema-collection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-collection.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-node-express-suite/src/enumerations/schema-collection.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,oBAAY,gBAAgB;IAC1B;;OAEG;IACH,UAAU,iBAAiB;IAC3B;;OAEG;IACH,IAAI,UAAU;IACd;;OAEG;IACH,SAAS,gBAAgB;IACzB;;OAEG;IACH,IAAI,UAAU;IACd;;OAEG;IACH,QAAQ,cAAc;IACtB;;OAEG;IACH,QAAQ,eAAe;IACvB;;OAEG;IACH,oBAAoB,6BAA6B;CAClD"}

package/src/enumerations/schema-collection.js

@@ -0,0 +1,43 @@
+"use strict";
+/**
+ * @fileoverview Schema collection name enumeration for MongoDB collections.
+ * Defines standardized collection names used throughout the application.
+ * @module enumerations/schema-collection
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaCollection = void 0;
+/**
+ * Enumerations for the schema collections.
+ */
+var SchemaCollection;
+(function (SchemaCollection) {
+    /**
+     * Collection for email tokens sent to users
+     */
+    SchemaCollection["EmailToken"] = "email-tokens";
+    /**
+     * Collection for roles in the application
+     */
+    SchemaCollection["Role"] = "roles";
+    /**
+     * Collection for user tokens
+     */
+    SchemaCollection["UserToken"] = "user-tokens";
+    /**
+     * Collection for users in the application
+     */
+    SchemaCollection["User"] = "users";
+    /**
+     * Collection for mnemonics used in the application
+     */
+    SchemaCollection["Mnemonic"] = "mnemonics";
+    /**
+     * Collection for user-role relationships
+     */
+    SchemaCollection["UserRole"] = "user-roles";
+    /**
+     * Collection for used direct login tokens
+     */
+    SchemaCollection["UsedDirectLoginToken"] = "used-direct-login-tokens";
+})(SchemaCollection || (exports.SchemaCollection = SchemaCollection = {}));
+//# sourceMappingURL=schema-collection.js.map

package/src/enumerations/schema-collection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-collection.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-node-express-suite/src/enumerations/schema-collection.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH;;GAEG;AACH,IAAY,gBA6BX;AA7BD,WAAY,gBAAgB;IAC1B;;OAEG;IACH,+CAA2B,CAAA;IAC3B;;OAEG;IACH,kCAAc,CAAA;IACd;;OAEG;IACH,6CAAyB,CAAA;IACzB;;OAEG;IACH,kCAAc,CAAA;IACd;;OAEG;IACH,0CAAsB,CAAA;IACtB;;OAEG;IACH,2CAAuB,CAAA;IACvB;;OAEG;IACH,qEAAiD,CAAA;AACnD,CAAC,EA7BW,gBAAgB,gCAAhB,gBAAgB,QA6B3B"}

package/src/enumerations/{symmetric-error-type.ts → symmetric-error-type.d.ts}

@@ -3,11 +3,11 @@
  * Defines error types for symmetric encryption operations.
  * @module enumerations/symmetric-error-type
  */
-
 /**
  * Error types for symmetric encryption operations.
  */
-export enum SymmetricErrorType {
-  DataNullOrUndefined = 'DataNullOrUndefined',
-  InvalidKeyLength = 'InvalidKeyLength',
+export declare enum SymmetricErrorType {
+    DataNullOrUndefined = "DataNullOrUndefined",
+    InvalidKeyLength = "InvalidKeyLength"
 }
+//# sourceMappingURL=symmetric-error-type.d.ts.map

package/src/enumerations/symmetric-error-type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"symmetric-error-type.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-node-express-suite/src/enumerations/symmetric-error-type.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,oBAAY,kBAAkB;IAC5B,mBAAmB,wBAAwB;IAC3C,gBAAgB,qBAAqB;CACtC"}

package/src/enumerations/symmetric-error-type.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * @fileoverview Symmetric encryption error type enumeration.
+ * Defines error types for symmetric encryption operations.
+ * @module enumerations/symmetric-error-type
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SymmetricErrorType = void 0;
+/**
+ * Error types for symmetric encryption operations.
+ */
+var SymmetricErrorType;
+(function (SymmetricErrorType) {
+    SymmetricErrorType["DataNullOrUndefined"] = "DataNullOrUndefined";
+    SymmetricErrorType["InvalidKeyLength"] = "InvalidKeyLength";
+})(SymmetricErrorType || (exports.SymmetricErrorType = SymmetricErrorType = {}));
+//# sourceMappingURL=symmetric-error-type.js.map

package/src/enumerations/symmetric-error-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"symmetric-error-type.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-node-express-suite/src/enumerations/symmetric-error-type.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH;;GAEG;AACH,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,iEAA2C,CAAA;IAC3C,2DAAqC,CAAA;AACvC,CAAC,EAHW,kBAAkB,kCAAlB,kBAAkB,QAG7B"}

package/src/environment.d.ts

@@ -0,0 +1,194 @@
+/**
+ * @fileoverview Environment configuration class.
+ * Loads and validates environment variables for application configuration.
+ * @module environment
+ */
+import { SecureBuffer, SecureString } from '@digitaldefiance/ecies-lib';
+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';
+import type { PlatformID } from '@digitaldefiance/node-ecies-lib';
+export declare class Environment<TID extends PlatformID = Buffer> implements IEnvironment<TID> {
+    private readonly _environment;
+    private readonly _envObject;
+    static requireEnv<T>(key: string, obj: EnvironmentVariables): T;
+    constructor(path?: string, initialization?: boolean, override?: boolean, constants?: IConstants);
+    has(key: string): boolean;
+    get(key: string): string | undefined;
+    setEnvironment(key: string, value: any): void;
+    getObject(): EnvironmentVariables;
+    /**
+     * 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(): TID | undefined;
+    /**
+     * The password of the admin user
+     */
+    get adminPassword(): SecureString | undefined;
+    /**
+     * The role ID of the admin user
+     */
+    get adminRoleId(): TID | undefined;
+    /**
+     * The user role ID of the admin user
+     */
+    get adminUserRoleId(): TID | 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(): TID | undefined;
+    /**
+     * The password of the member user
+     */
+    get memberPassword(): SecureString | undefined;
+    /**
+     * The role ID of the member user
+     */
+    get memberRoleId(): TID | undefined;
+    /**
+     * The user role ID of the member user
+     */
+    get memberUserRoleId(): TID | 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(): TID | 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(): TID | undefined;
+    /**
+     * The user role ID of the system user
+     */
+    get systemUserRoleId(): TID | 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;;;;GAIG;AAEH,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAQxE,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;AACjB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAElE,qBAAa,WAAW,CACtB,GAAG,SAAS,UAAU,GAAG,MAAM,CAC/B,YAAW,YAAY,CAAC,GAAG,CAAC;IAC5B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAoB;IACjD,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;IAqZrC,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,oBAAoB;IAIxC;;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,GAAG,GAAG,SAAS,CAEpC;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,YAAY,GAAG,SAAS,CAEnD;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,GAAG,GAAG,SAAS,CAExC;IAED;;OAEG;IACH,IAAW,eAAe,IAAI,GAAG,GAAG,SAAS,CAE5C;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,GAAG,GAAG,SAAS,CAErC;IAED;;OAEG;IACH,IAAW,cAAc,IAAI,YAAY,GAAG,SAAS,CAEpD;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,GAAG,GAAG,SAAS,CAEzC;IAED;;OAEG;IACH,IAAW,gBAAgB,IAAI,GAAG,GAAG,SAAS,CAE7C;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,GAAG,GAAG,SAAS,CAErC;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,GAAG,GAAG,SAAS,CAEzC;IAED;;OAEG;IACH,IAAW,gBAAgB,IAAI,GAAG,GAAG,SAAS,CAE7C;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"}