@digitaldefiance/node-express-suite 3.7.5 → 3.8.0

package/src/interfaces/constants.ts

@@ -1,114 +0,0 @@
-/**
- * @fileoverview Constants interface combining all library constants.
- * Aggregates constants from ECIES, Node ECIES, Suite Core, and Node Express Suite.
- * @module interfaces/constants
- */
-
-import { IECIESConstants, IPBkdf2Consts } from '@digitaldefiance/ecies-lib';
-import {
-  IEncryptionConsts,
-  IKeyringConsts,
-  IWrappedKeyConsts,
-  PbkdfProfiles,
-  type IVotingConsts,
-} from '@digitaldefiance/node-ecies-lib';
-import { IConstants as IBaseConstants } from '@digitaldefiance/suite-core-lib';
-import { CipherGCMTypes } from 'crypto';
-import { IChecksumConsts } from './checksum-consts';
-import { IFECConsts } from './fec-consts';
-import { IJwtConsts } from './jwt-consts';
-
-/**
- * Combination of all constants from all libraries.
- * Extends base constants with ECIES, Node ECIES, Suite Core, and Node Express Suite constants.
- */
-export interface IConstants extends IBaseConstants {
-  UINT8_SIZE: number;
-  UINT16_SIZE: number;
-  UINT16_MAX: number;
-  UINT32_SIZE: number;
-  UINT32_MAX: number;
-  UINT64_SIZE: number;
-  UINT64_MAX: bigint;
-  HEX_RADIX: number;
-  /**
-   * Number of rounds for bcrypt hashing. Higher values increase security but also consume more CPU resources.
-   */
-  BcryptRounds: number;
-  /**
-   * Minimum password length
-   */
-  PasswordMinLength: number;
-  /**
-   * The regular expression for valid passwords.
-   */
-  PasswordRegex: RegExp;
-  /**
-   * The regular expression for valid JWT tokens.
-   */
-  JwtSecretRegex: RegExp;
-  /**
-   * The regular expression for valid mnemonic phrases.
-   * BIP39
-   */
-  MnemonicRegex: RegExp;
-  /**
-   * The regular expression for valid HMAC keys.
-   */
-  MnemonicHmacRegex: RegExp;
-  /**
-   * The regular expression for valid encryption keys.
-   */
-  MnemonicEncryptionKeyRegex: RegExp;
-  /**
-   * JWT constants
-   */
-  JWT: IJwtConsts;
-  /**
-   * Forward Error Correction constants
-   */
-  FEC: IFECConsts;
-  /**
-   * ECIES encryption constants
-   */
-  ECIES: IECIESConstants;
-  /**
-   * The length of a raw object ID (not the hex string representation)
-   */
-  OBJECT_ID_LENGTH: number;
-  /**
-   * PBKDF2 key derivation function constants
-   */
-  PBKDF2: IPBkdf2Consts;
-  /**
-   * Predefined PBKDF2 configuration profiles for different use cases
-   */
-  PBKDF2_PROFILES: PbkdfProfiles;
-  /**
-   * Checksum constants used for data integrity
-   */
-  CHECKSUM: IChecksumConsts;
-  /**
-   * Wrapped Key constants used for the key wrapping service
-   */
-  WRAPPED_KEY: IWrappedKeyConsts;
-  /**
-   * Keyring constants used for key management
-   */
-  KEYRING: IKeyringConsts;
-  /**
-   * Encryption constants used for encrypted data
-   */
-  ENCRYPTION: IEncryptionConsts;
-  /**
-   * Voting constants used for homomorphic encryption voting
-   */
-  VOTING: IVotingConsts;
-  /**
-   * Algorithm configuration string for keyring operations
-   */
-  KEYRING_ALGORITHM_CONFIGURATION: CipherGCMTypes;
-  ECIES_VERSION_SIZE: number;
-  ECIES_CIPHER_SUITE_SIZE: number;
-  MEMBER_ID_LENGTH: number;
-}

package/src/interfaces/email-service.ts

@@ -1,26 +0,0 @@
-/**
- * @fileoverview Email service interface for sending emails.
- * Defines contract for email delivery implementations.
- * @module interfaces/email-service
- */
-
-/**
- * Email service interface for sending emails.
- * Implementations handle email delivery with text and HTML content.
- */
-export interface IEmailService {
-  /**
-   * Sends an email with text and HTML content.
-   * @param {string} to - Recipient email address
-   * @param {string} subject - Email subject line
-   * @param {string} text - Plain text email body
-   * @param {string} html - HTML email body
-   * @returns {Promise<void>} Resolves when email is sent
-   */
-  sendEmail(
-    to: string,
-    subject: string,
-    text: string,
-    html: string,
-  ): Promise<void>;
-}

package/src/interfaces/environment-mongo.ts

@@ -1,86 +0,0 @@
-/**
- * @fileoverview MongoDB environment configuration interface.
- * Defines comprehensive MongoDB connection and behavior settings.
- * @module interfaces/environment-mongo
- */
-
-import { ReadConcernLike, WriteConcern } from 'mongodb';
-
-/**
- * MongoDB environment configuration.
- * Defines connection pool, timeout, transaction, and consistency settings.
- */
-export interface IMongoEnvironment {
-  /**
-   * The URI of the MongoDB database
-   */
-  uri: string;
-  /**
-   * The name of the MongoDB database
-   */
-  dbName: string;
-  /**
-   * The maximum number of connections in the connection pool (default: 10)
-   */
-  maxPoolSize: number;
-  /**
-   * The minimum number of connections in the connection pool (default: 2)
-   */
-  minPoolSize: number;
-  /**
-   * The maximum number of milliseconds that a connection can remain idle in the connection pool (default: 30000)
-   */
-  maxIdleTimeMS: number;
-  /**
-   * The maximum time in milliseconds to wait for a connection to be established (default: 5000)
-   */
-  serverSelectionTimeoutMS: number;
-  /**
-   * The maximum time in milliseconds to wait for a socket to be established (default: 30000)
-   */
-  socketTimeoutMS: number;
-  /**
-   * Whether to retry writes (default: true)
-   */
-  retryWrites: boolean;
-  /**
-   * Whether to retry reads (default: true)
-   */
-  retryReads: boolean;
-  /**
-   * The read concern for the MongoDB database
-   */
-  readConcern: ReadConcernLike;
-  /**
-   * The write concern for the MongoDB database (default: { w: 'majority', j: true })
-   */
-  writeConcern: WriteConcern;
-  /**
-   * Whether the MongoDB server supports the setParameter command (MongoDB 4.4+)
-   */
-  setParameterSupported: boolean;
-  /**
-   * Whether the MongoDB server supports setting transactionLifetimeLimitSeconds (MongoDB 4.2+)
-   */
-  transactionLifetimeLimitSecondsSupported: boolean;
-  /**
-   * Whether the MongoDB server supports setting maxTransactionLockRequestTimeoutMillis (MongoDB 4.4+)
-   */
-  maxTransactionLockRequestTimeoutMillisSupported: boolean;
-  /**
-   * How long for transactions to timeout
-   */
-  transactionTimeout: number;
-  /**
-   * The maximum time to wait for a lock when using transactions (MongoDB 4.4+)
-   */
-  transactionLockRequestTimeout: number;
-  /**
-   * Use transactions
-   */
-  useTransactions: boolean;
-  /**
-   * Base delay in milliseconds for transaction retry backoff
-   */
-  transactionRetryBaseDelay: number;
-}

package/src/interfaces/environment.ts

@@ -1,191 +0,0 @@
-/**
- * @fileoverview Environment interface defining application configuration and credentials.
- * Contains all environment variables, database configuration, and user credentials.
- * @module interfaces/environment
- */
-
-import { SecureBuffer, SecureString } from '@digitaldefiance/ecies-lib';
-import { BackupCode } from '../backup-code';
-import { IMongoEnvironment } from './environment-mongo';
-import type { PlatformID } from '@digitaldefiance/node-ecies-lib';
-
-/**
- * Environment configuration interface for the application.
- * Contains all configuration values, credentials, and environment-specific settings.
- * @template TID Platform-specific ID type (Buffer, ObjectId, etc.)
- */
-export interface IEnvironment<TID extends PlatformID = Buffer> {
-  /**
-   * Whether to use a memory database for local development (eg with MongoMemoryServer)
-   * If set, this will create a new in-memory database instance on application start with the given database name
-   */
-  devDatabase?: string;
-  /**
-   * Whether to print certain console debug messages
-   */
-  debug: boolean;
-  /**
-   * Whether to enable super verbose debug messags
-   */
-  detailedDebug: boolean;
-  /**
-   * The host name of the server
-   */
-  host: string;
-  /**
-   * The port the server is running on
-   */
-  port: number;
-  /**
-   * The base path of the server
-   */
-  basePath: string;
-  /**
-   * The URL of the server
-   */
-  serverUrl: string;
-  /**
-   * The secret used to sign JWTs
-   */
-  jwtSecret: string;
-  /**
-   * The email address to send notifications from
-   */
-  emailSender: string;
-  /**
-   * API distribution directory
-   */
-  apiDistDir: string;
-  /**
-   * react dist dir
-   */
-  reactDistDir: string;
-  /**
-   * The directory and root filename to store HTTPS development certificates
-   */
-  httpsDevCertRoot?: string;
-  /**
-   * The port to use for HTTPS development certificates
-   */
-  httpsDevPort: number;
-  /**
-   * Disable email sending
-   */
-  disableEmailSend: boolean;
-  /**
-   * MongoDB configuration
-   */
-  mongo: IMongoEnvironment;
-  /**
-   * Mnemonic for the admin user
-   */
-  adminMnemonic?: SecureString;
-  /**
-   * The ID of the admin user
-   */
-  adminId?: TID;
-  /**
-   * The creation date of the admin user
-   */
-  adminCreatedAt?: Date;
-  /**
-   * The password of the admin user
-   */
-  adminPassword?: SecureString;
-  /**
-   * The ID of the admin user role object
-   */
-  adminRoleId?: TID;
-  /**
-   * The ID of the admin user's user role object
-   */
-  adminUserRoleId?: TID;
-  /**
-   * Backup codes for the admin user
-   */
-  adminBackupCodes?: BackupCode[];
-  /**
-   * Mnemonic for the member user
-   */
-  memberMnemonic?: SecureString;
-  /**
-   * The ID of the member user
-   */
-  memberId?: TID;
-  /**
-   * The creation date of the member user
-   */
-  memberCreatedAt?: Date;
-  /**
-   * The password of the member user
-   */
-  memberPassword?: SecureString;
-  /**
-   * The ID of the member user role object
-   */
-  memberRoleId?: TID;
-  /**
-   * The ID of the member user's user role object
-   */
-  memberUserRoleId?: TID;
-  /**
-   * Backup codes for the member user
-   */
-  memberBackupCodes?: BackupCode[];
-  /**
-   * Mnemonic for the system user
-   */
-  systemMnemonic?: SecureString;
-  /**
-   * The ID of the system user
-   */
-  systemId?: TID;
-  /**
-   * The creation date of the system user
-   */
-  systemCreatedAt?: Date;
-  /**
-   * The public key of the system user
-   */
-  systemPublicKeyHex?: string;
-  /**
-   * The password of the system user
-   */
-  systemPassword?: SecureString;
-  /**
-   * The ID of the system user role object
-   */
-  systemRoleId?: TID;
-  /**
-   * The ID of the system user's user role object
-   */
-  systemUserRoleId?: TID;
-  /**
-   * Backup codes for the system user
-   */
-  systemBackupCodes?: BackupCode[];
-  /**
-   * HMAC secret for mnemonic encryption
-   */
-  mnemonicHmacSecret: SecureBuffer;
-  /**
-   * Encryption key for mnemonics
-   */
-  mnemonicEncryptionKey: SecureBuffer;
-  /**
-   * The timezone for the server
-   */
-  timezone: string;
-  /**
-   * The default language for the admin interface/CLI
-   */
-  adminLanguage: string;
-  /**
-   * The number of PBKDF2 iterations for key wrapping
-   */
-  pbkdf2Iterations: number;
-  /**
-   * Whether this is a production environment
-   */
-  production: boolean;
-}

package/src/interfaces/jwt-consts.ts

@@ -1,33 +0,0 @@
-/**
- * @fileoverview JWT constants interface.
- * Defines configuration constants for JWT token generation and validation.
- * @module interfaces/jwt-consts
- */
-
-/**
- * Constants for JWT token configuration.
- * Defines algorithm and expiration settings.
- */
-export interface IJwtConsts {
-  /**
-   * Algorithm to use for JWT
-   */
-  ALGORITHM:
-    | 'HS256'
-    | 'HS384'
-    | 'HS512'
-    | 'RS256'
-    | 'RS384'
-    | 'RS512'
-    | 'ES256'
-    | 'ES384'
-    | 'ES512'
-    | 'PS256'
-    | 'PS384'
-    | 'PS512';
-
-  /**
-   * The expiration time for a JWT token in seconds
-   */
-  EXPIRATION_SEC: number;
-}

package/src/interfaces/request-user.ts

@@ -1,80 +0,0 @@
-/**
- * @fileoverview Request user interface for Express request object.
- * Defines user data structure attached to authenticated requests.
- * @module interfaces/request-user
- */
-
-import {
-  ICombinedRolePrivileges,
-  IRoleDTO,
-  IRoleFrontendObject,
-} from '@digitaldefiance/suite-core-lib';
-import { IRoleBackendObject } from './backend-objects/role';
-import type { PlatformID } from '@digitaldefiance/node-ecies-lib';
-
-/**
- * Interface for the user object stored in the request object.
- * Used for request handling, not for Mongoose documents.
- * @template TID - Platform ID type (defaults to Buffer)
- * @template TRole - Role array type (defaults to IRoleDTO[])
- * @template TLanguage - String type for language (defaults to string)
- * @template TDate - Date type (defaults to string)
- */
-export interface IRequestUser<
-  TID extends PlatformID = Buffer,
-  TRole extends
-    | Array<IRoleDTO>
-    | Array<IRoleFrontendObject>
-    | Array<IRoleBackendObject> = Array<IRoleDTO>,
-  TLanguage extends string = string,
-  TDate extends Date | string = string,
-> {
-  /**
-   * The ID of the user
-   */
-  id: TID;
-  /**
-   * The roles associated with the user
-   */
-  roles: TRole;
-  /**
-   * Combined role privileges across all user roles
-   */
-  rolePrivileges: ICombinedRolePrivileges;
-  /**
-   * The username of the user
-   */
-  username: string;
-  /**
-   * The email address of the user
-   */
-  email: string;
-  /**
-   * The timezone of the user
-   */
-  timezone: string;
-  /**
-   * The currency preference of the user
-   */
-  currency: string;
-  /**
-   * Whether the user has direct challenge login enabled
-   */
-  directChallenge: boolean;
-  /**
-   * The language of the user
-   */
-  siteLanguage: TLanguage;
-  /**
-   * The date the user last logged in
-   */
-  lastLogin?: TDate;
-  /**
-   * Whether the user has verified their email address
-   */
-  emailVerified: boolean;
-  /**
-   * Whether the user prefers dark mode
-   */
-  darkMode: boolean;
-}

package/src/interfaces/required-string-keys.ts

@@ -1,33 +0,0 @@
-/**
- * @fileoverview Required string keys interface for i18n.
- * Defines minimum required translation keys for the library.
- * @module interfaces/required-string-keys
- */
-
-/**
- * Base interface defining the minimum required string keys.
- * Must be implemented by any application using this library.
- */
-export interface RequiredStringKeys {
-  Common_UnexpectedError: string;
-  Error_EngineAlreadySet: string;
-  Error_EngineNotSet: string;
-  Error_LengthExceedsMaximum: string;
-  Error_LengthIsInvalidType: string;
-  // Validation errors
-  ValidationError: string;
-  Validation_MissingValidatedData: string;
-  Validation_MissingValidatedDataForField: string;
-
-  // Admin/system messages
-  Admin_NoMongoDbClientFoundFallingBack: string;
-  Admin_TransactionFailedTransientTemplate: string;
-  Admin_TransactionTimeoutTemplate: string;
-}
-
-/**
- * Type constraint to ensure user's string key enum extends the required keys.
- * @template T - String key type
- */
-export type ExtendedStringKeys<T extends string> =
-  T extends keyof RequiredStringKeys ? T : T | keyof RequiredStringKeys;

package/src/interfaces/server-init-result.ts

@@ -1,48 +0,0 @@
-/**
- * @fileoverview Server initialization result interface.
- * Defines structure for test server initialization with admin, member, and system users.
- * @module interfaces/server-init-result
- */
-
-import { Member, PlatformID } from '@digitaldefiance/node-ecies-lib';
-import { IRoleDocument } from '../documents/role';
-import { IUserDocument } from '../documents/user';
-import { IUserRoleDocument } from '../documents/user-role';
-
-// Re-export essential document types
-export type { IRoleDocument, IUserDocument, IUserRoleDocument };
-
-/**
- * Result of server initialization for testing.
- * Contains admin, member, and system user accounts with credentials and roles.
- * @template TID - Platform ID type (defaults to Buffer)
- */
-export interface IServerInitResult<TID extends PlatformID = Buffer> {
-  adminRole: IRoleDocument<TID>;
-  adminUser: IUserDocument<string, TID>;
-  adminUsername: string;
-  adminEmail: string;
-  adminMnemonic: string;
-  adminPassword: string;
-  adminBackupCodes: Array<string>;
-  adminMember: Member<TID>;
-  adminUserRole: IUserRoleDocument<TID>;
-  memberRole: IRoleDocument<TID>;
-  memberUser: IUserDocument<string, TID>;
-  memberUsername: string;
-  memberEmail: string;
-  memberMnemonic: string;
-  memberPassword: string;
-  memberBackupCodes: Array<string>;
-  memberMember: Member<TID>;
-  memberUserRole: IUserRoleDocument<TID>;
-  systemRole: IRoleDocument<TID>;
-  systemUser: IUserDocument<string, TID>;
-  systemUsername: string;
-  systemEmail: string;
-  systemMnemonic: string;
-  systemPassword: string;
-  systemBackupCodes: Array<string>;
-  systemMember: Member<TID>;
-  systemUserRole: IUserRoleDocument<TID>;
-}