@digitaldefiance/node-express-suite 3.7.5 → 3.8.0

package/src/errors/express-validation.ts

@@ -1,38 +0,0 @@
-/**
- * @fileoverview Express validation error for handling express-validator validation failures.
- * Wraps validation errors with translatable error messages.
- * @module errors/express-validation
- */
-
-import { TranslatableGenericError } from '@digitaldefiance/i18n-lib';
-import {
-  SuiteCoreComponentId,
-  SuiteCoreStringKey,
-} from '@digitaldefiance/suite-core-lib';
-import { Result, ValidationError } from 'express-validator';
-
-/**
- * Error thrown when express-validator validation fails.
- * Contains the validation errors and sets HTTP status code to 422 (Unprocessable Entity).
- */
-export class ExpressValidationError extends TranslatableGenericError<SuiteCoreStringKey> {
-  /** Validation errors from express-validator */
-  public readonly errors: Result<ValidationError> | ValidationError[];
-  /** HTTP status code (422 for validation errors) */
-  public readonly statusCode?: number = 422;
-
-  /**
-   * Creates a new express validation error.
-   * @param errors Validation errors from express-validator
-   */
-  constructor(errors: Result<ValidationError> | ValidationError[]) {
-    const errorsArray = Array.isArray(errors) ? errors : errors.array();
-    const _errorCount = errorsArray.length;
-    super(
-      SuiteCoreComponentId,
-      SuiteCoreStringKey.Validation_ExpressValidationFailed,
-    );
-    this.errors = errors;
-    this.name = 'ExpressValidationError';
-  }
-}

package/src/errors/invalid-backup-code-version.ts

@@ -1,30 +0,0 @@
-/**
- * @fileoverview Error for invalid backup code version.
- * Thrown when attempting to use a backup code with an unsupported version.
- * @module errors/invalid-backup-code-version
- */
-
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteError,
-} from '@digitaldefiance/suite-core-lib';
-
-/**
- * Error thrown when a backup code has an invalid or unsupported version.
- */
-export class InvalidBackupCodeVersionError extends TranslatableSuiteError {
-  /** The invalid version string */
-  public readonly version: string;
-
-  /**
-   * Creates a new invalid backup code version error.
-   * @param version The invalid version string
-   */
-  constructor(version: string) {
-    super(SuiteCoreStringKey.Error_InvalidBackupCodeVersionTemplate, {
-      version,
-    });
-    this.version = version;
-    this.name = 'InvalidBackupCodeVersionError';
-  }
-}

package/src/errors/invalid-jwt-token.ts

@@ -1,24 +0,0 @@
-/**
- * @fileoverview Error for invalid JWT tokens.
- * Thrown when JWT token validation fails, sets HTTP status code to 401.
- * @module errors/invalid-jwt-token
- */
-
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteHandleableError,
-} from '@digitaldefiance/suite-core-lib';
-
-/**
- * Error thrown when a JWT token is invalid or malformed.
- * Sets HTTP status code to 401 (Unauthorized).
- */
-export class InvalidJwtTokenError extends TranslatableSuiteHandleableError {
-  /**
-   * Creates a new invalid JWT token error.
-   */
-  constructor() {
-    super(SuiteCoreStringKey.Validation_InvalidToken, { statusCode: 401 });
-    this.name = 'InvalidJwtTokenError';
-  }
-}

package/src/errors/invalid-model.ts

@@ -1,24 +0,0 @@
-/**
- * @fileoverview Error for invalid model keys in the model registry.
- * Thrown when attempting to access a model with an invalid key.
- * @module errors/invalid-model
- */
-
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteError,
-} from '@digitaldefiance/suite-core-lib';
-
-/**
- * Error thrown when a model key is invalid or not recognized.
- */
-export class InvalidModelError extends TranslatableSuiteError {
-  /**
-   * Creates a new invalid model error.
-   * @param modelKey The invalid model key
-   */
-  constructor(public readonly modelKey: string) {
-    super(SuiteCoreStringKey.Error_InvalidModelKeyTemplate, { modelKey });
-    this.name = 'InvalidModelError';
-  }
-}

package/src/errors/invalid-new-password.ts

@@ -1,33 +0,0 @@
-/**
- * @fileoverview Error for invalid new passwords that don't meet requirements.
- * Thrown during password changes or registration when password validation fails.
- * @module errors/invalid-new-password
- */
-
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteHandleableError,
-} from '@digitaldefiance/suite-core-lib';
-
-/**
- * Error thrown when a new password doesn't meet security requirements.
- * Sets HTTP status code to 422 (Unprocessable Entity).
- */
-export class InvalidNewPasswordError extends TranslatableSuiteHandleableError {
-  /**
-   * Creates a new invalid new password error.
-   * @param language Optional language code for error message
-   * @param statusCode HTTP status code (defaults to 422)
-   */
-  constructor(language?: string, statusCode = 422) {
-    super(
-      SuiteCoreStringKey.Validation_PasswordRegexErrorTemplate,
-      undefined,
-      language,
-      {
-        statusCode,
-      },
-    );
-    this.name = 'InvalidNewPasswordError';
-  }
-}

package/src/errors/invalid-password.ts

@@ -1,28 +0,0 @@
-/**
- * @fileoverview Error for invalid passwords during authentication.
- * Thrown when password verification fails, sets HTTP status code to 403.
- * @module errors/invalid-password
- */
-
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteHandleableError,
-} from '@digitaldefiance/suite-core-lib';
-
-/**
- * Error thrown when a password is incorrect during authentication.
- * Sets HTTP status code to 403 (Forbidden).
- */
-export class InvalidPasswordError extends TranslatableSuiteHandleableError {
-  /**
-   * Creates a new invalid password error.
-   * @param language Optional language code for error message
-   * @param statusCode HTTP status code (defaults to 403)
-   */
-  constructor(language?: string, statusCode = 403) {
-    super(SuiteCoreStringKey.Validation_InvalidPassword, undefined, language, {
-      statusCode,
-    });
-    this.name = 'InvalidPasswordError';
-  }
-}

package/src/errors/missing-validated-data.ts

@@ -1,55 +0,0 @@
-/**
- * @fileoverview Error for missing validated data in request processing.
- * Thrown when expected validated data is not present after validation middleware.
- * @module errors/missing-validated-data
- */
-
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteHandleableError,
-} from '@digitaldefiance/suite-core-lib';
-
-/**
- * Error thrown when validated data is missing from the request.
- * Sets HTTP status code to 422 (Unprocessable Entity).
- * @template _TLanguage Language string literal type
- * @template _TContext Context string literal type
- */
-export class MissingValidatedDataError<
-  _TLanguage extends string,
-  _TContext extends string,
-> extends TranslatableSuiteHandleableError {
-  /** The missing field name (if single field) */
-  public readonly field?: string;
-  /** The missing field names (if multiple fields) */
-  public readonly fields?: string[];
-
-  /**
-   * Creates a new missing validated data error.
-   * @param data Field name(s) that are missing
-   */
-  constructor(data?: string | string[]) {
-    let message: SuiteCoreStringKey;
-    let fields: string[] | undefined;
-    let field: string;
-    if (data && Array.isArray(data)) {
-      message =
-        SuiteCoreStringKey.Validation_MissingValidatedDataForFieldTemplate;
-      field = data.join(', ');
-      fields = data;
-    } else if (data) {
-      message =
-        SuiteCoreStringKey.Validation_MissingValidatedDataForFieldTemplate;
-      field = String(data);
-    } else {
-      message = SuiteCoreStringKey.Validation_MissingValidatedData;
-      field = '';
-    }
-    super(message, { field }, undefined, {
-      statusCode: 422,
-    });
-    this.field = field;
-    this.fields = fields;
-    this.name = 'MissingValidatedDataError';
-  }
-}

package/src/errors/mnemonic-or-password-required.ts

@@ -1,26 +0,0 @@
-/**
- * @fileoverview Error for missing mnemonic or password during authentication.
- * Thrown when neither mnemonic nor password is provided for login.
- * @module errors/mnemonic-or-password-required
- */
-
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteHandleableError,
-} from '@digitaldefiance/suite-core-lib';
-
-/**
- * Error thrown when neither mnemonic nor password is provided for authentication.
- * Sets HTTP status code to 422 (Unprocessable Entity).
- */
-export class MnemonicOrPasswordRequiredError extends TranslatableSuiteHandleableError {
-  /**
-   * Creates a new mnemonic or password required error.
-   */
-  constructor() {
-    super(SuiteCoreStringKey.Validation_MnemonicOrPasswordRequired, {
-      statusCode: 422,
-    });
-    this.name = 'MnemonicOrPasswordRequiredError';
-  }
-}

package/src/errors/model-not-registered.ts

@@ -1,24 +0,0 @@
-/**
- * @fileoverview Error for models not registered in the model registry.
- * Thrown when attempting to access a model that hasn't been registered.
- * @module errors/model-not-registered
- */
-
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteError,
-} from '@digitaldefiance/suite-core-lib';
-
-/**
- * Error thrown when attempting to access a model that is not registered.
- */
-export class ModelNotRegisteredError extends TranslatableSuiteError {
-  /**
-   * Creates a new model not registered error.
-   * @param modelName The name of the unregistered model
-   */
-  constructor(public readonly modelName: string) {
-    super(SuiteCoreStringKey.Error_ModelNotRegisteredTemplate, { modelName });
-    this.name = 'ModelNotRegisteredError';
-  }
-}

package/src/errors/mongoose-validation.ts

@@ -1,56 +0,0 @@
-/**
- * @fileoverview Mongoose validation error wrapper with translatable messages.
- * Wraps Mongoose validation errors with HTTP status code 422.
- * @module errors/mongoose-validation
- */
-
-import { CoreLanguageCode, HandleableError } from '@digitaldefiance/i18n-lib';
-import { Error } from '@digitaldefiance/mongoose-types';
-import {
-  getSuiteCoreI18nEngine,
-  SuiteCoreComponentId,
-  SuiteCoreStringKey,
-} from '@digitaldefiance/suite-core-lib';
-import { IApplication } from '../interfaces';
-
-/**
- * Error thrown when Mongoose validation fails.
- * Contains the validation errors and sets HTTP status code to 422 (Unprocessable Entity).
- */
-export class MongooseValidationError extends HandleableError {
-  /** Mongoose validation errors by field path */
-  public readonly errors: {
-    [path: string]: Error.CastError | Error.ValidatorError;
-  };
-
-  /**
-   * Creates a new Mongoose validation error.
-   * @param validationErrors Mongoose validation errors by field path
-   * @param language Optional language code for error message
-   * @param application Optional application instance for i18n
-   */
-  constructor(
-    validationErrors: {
-      [path: string]: Error.CastError | Error.ValidatorError;
-    },
-    language?: CoreLanguageCode,
-    application?: IApplication,
-  ) {
-    const coreEngine = getSuiteCoreI18nEngine(
-      application ? { constants: application.constants } : undefined,
-    );
-    super(
-      new Error(
-        `${coreEngine.translate(
-          SuiteCoreComponentId,
-          SuiteCoreStringKey.Validation_MongooseValidationError,
-          undefined,
-          language,
-        )}: ${JSON.stringify(validationErrors)}`,
-      ),
-      { statusCode: 422 },
-    );
-    this.name = 'MongooseValidationError';
-    this.errors = validationErrors;
-  }
-}

package/src/errors/symmetric.ts

@@ -1,53 +0,0 @@
-/**
- * @fileoverview Symmetric encryption error with typed error codes.
- * Provides specific error types for symmetric encryption failures.
- * @module errors/symmetric
- */
-
-import { CoreLanguageCode, PluginTypedError } from '@digitaldefiance/i18n-lib';
-import {
-  SuiteCoreComponentId,
-  SuiteCoreStringKey,
-} from '@digitaldefiance/suite-core-lib';
-import { LocalhostConstants } from '../constants';
-import { SymmetricErrorType } from '../enumerations/symmetric-error-type';
-import { IConstants } from '../interfaces/constants';
-import { SymmetricService } from '../services/symmetric';
-
-/**
- * Error thrown when symmetric encryption operations fail.
- * Provides typed error codes for different failure scenarios.
- */
-export class SymmetricError extends PluginTypedError<
-  typeof SymmetricErrorType,
-  SuiteCoreStringKey
-> {
-  /**
-   * Creates a new symmetric encryption error.
-   * @param type Type of symmetric error
-   * @param language Optional language code for error message
-   * @param constants Constants for key size information (defaults to LocalhostConstants)
-   */
-  constructor(
-    type: SymmetricErrorType,
-    language?: CoreLanguageCode,
-    constants: IConstants = LocalhostConstants,
-  ) {
-    super(
-      SuiteCoreComponentId,
-      type,
-      {
-        [SymmetricErrorType.DataNullOrUndefined]:
-          SuiteCoreStringKey.Error_SymmetricDataNullOrUndefined,
-        [SymmetricErrorType.InvalidKeyLength]:
-          SuiteCoreStringKey.Error_SymmetricInvalidKeyLengthTemplate,
-      },
-      language,
-      {
-        KEY_BITS: SymmetricService.symmetricKeyBits(constants.ECIES),
-        KEY_BYTES: SymmetricService.symmetricKeyBytes(constants.ECIES),
-      },
-    );
-    this.name = 'SymmetricError';
-  }
-}

package/src/errors/token-expired.ts

@@ -1,24 +0,0 @@
-/**
- * @fileoverview Error for expired tokens.
- * Thrown when a JWT or other token has expired, sets HTTP status code to 401.
- * @module errors/token-expired
- */
-
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteError,
-} from '@digitaldefiance/suite-core-lib';
-
-/**
- * Error thrown when a token has expired.
- * Sets HTTP status code to 401 (Unauthorized).
- */
-export class TokenExpiredError extends TranslatableSuiteError {
-  /**
-   * Creates a new token expired error.
-   */
-  constructor() {
-    super(SuiteCoreStringKey.Validation_TokenExpired, { statusCode: 401 });
-    this.name = 'TokenExpiredError';
-  }
-}

package/src/get-language.ts

@@ -1,64 +0,0 @@
-/**
- * @fileoverview Language detection and configuration utilities.
- * Sets global admin language from environment or command-line arguments.
- * @module get-language
- */
-
-import {
-  GlobalActiveContext,
-  IActiveContext,
-  LanguageRegistry,
-} from '@digitaldefiance/i18n-lib';
-import {
-  getSuiteCoreTranslation,
-  SuiteCoreStringKey,
-} from '@digitaldefiance/suite-core-lib';
-import { debugLog } from './utils';
-
-/**
- * Sets global admin language from process arguments or environment variables.
- * Prioritizes command-line --language argument, then LANGUAGE env var, then existing context.
- * @returns {string} The configured language code
- */
-export function setGlobalActiveContextAdminLanguageFromProcessArgvOrEnv(): string {
-  const consoleLanguageEnv = process.env['LANGUAGE'];
-  const consoleLanguageArgv = process.argv.find((arg) =>
-    arg.startsWith('--language='),
-  );
-
-  const context = GlobalActiveContext.getInstance<
-    string,
-    IActiveContext<string>
-  >();
-
-  // Prioritize command-line argument, then environment variable, then existing context
-  const rawLanguage =
-    (consoleLanguageArgv
-      ? consoleLanguageArgv.split('=')[1]
-      : consoleLanguageEnv) ?? context.adminLanguage;
-
-  if (!rawLanguage) {
-    return context.adminLanguage;
-  }
-
-  const consoleLanguage = rawLanguage.replace(/^['"]|['"]$/g, '');
-
-  if (LanguageRegistry.hasLanguage(consoleLanguage)) {
-    context.setAdminLanguage(consoleLanguage as string);
-    return context.adminLanguage;
-  }
-
-  // If the language is invalid, log a warning and return the unchanged (default) language
-  debugLog(
-    true,
-    'error',
-    getSuiteCoreTranslation(
-      SuiteCoreStringKey.Error_InvalidLanguageCodeTemplate,
-      {
-        LANGUAGE: consoleLanguage,
-        DEFAULT_LANGUAGE: context.adminLanguage,
-      },
-    ),
-  );
-  return context.adminLanguage;
-}

package/src/get-timezone.ts

@@ -1,76 +0,0 @@
-/**
- * @fileoverview Timezone detection and configuration utilities.
- * Sets global admin timezone from environment or command-line arguments.
- * @module get-timezone
- */
-
-import type { Timezone as TimezoneType } from '@digitaldefiance/i18n-lib';
-import {
-  GlobalActiveContext,
-  IActiveContext,
-  isValidTimezone,
-} from '@digitaldefiance/i18n-lib';
-import { existsSync, readFileSync } from 'fs';
-
-// Type for Timezone constructor
-type TimezoneConstructor = new (tz: string) => TimezoneType;
-
-/**
- * Creates a Timezone instance from the same module as GlobalActiveContext.
- * @param {string} tz - Timezone string
- * @returns {TimezoneType} Timezone instance
- */
-function createTimezone(tz: string): TimezoneType {
-  const context = GlobalActiveContext.getInstance<
-    string,
-    IActiveContext<string>
-  >();
-  // Get the Timezone constructor from the existing timezone object
-  const TimezoneConstructor = context.adminTimezone
-    .constructor as TimezoneConstructor;
-  return new TimezoneConstructor(tz);
-}
-
-/**
- * Sets global admin timezone from process arguments, environment, or system configuration.
- * Prioritizes: --timezone argument > TZ env var > /etc/timezone > existing context.
- * @returns {string} The configured timezone string
- */
-export function setGlobalActiveContextAdminTimezoneFromProcessArgvOrEnv(): string {
-  const systemTz = existsSync('/etc/timezone')
-    ? readFileSync('/etc/timezone', 'utf8').trim()
-    : undefined;
-  const consoleTimezoneEnv = process.env['TZ'];
-  const consoleTimezoneArgv = process.argv.find((arg) =>
-    arg.startsWith('--timezone='),
-  );
-
-  // Prioritize command-line argument, then environment variable, then /etc/timezone
-  // if command-line argument is set, and is valid (isValidTimezone), use that
-  // if TZ env is set, and is valid (isValidTimezone), use that
-  // if /etc/timezone has a timezone, and is valid (isValidTimezone) use that
-  const validSystemTz =
-    systemTz && isValidTimezone(systemTz) ? systemTz : undefined;
-  const validConsoleTimezoneEnv =
-    consoleTimezoneEnv && isValidTimezone(consoleTimezoneEnv)
-      ? consoleTimezoneEnv
-      : undefined;
-  const argValue = consoleTimezoneArgv?.split('=')[1];
-  const validConsoleTimezoneArgv =
-    argValue && isValidTimezone(argValue) ? argValue : undefined;
-
-  const context = GlobalActiveContext.getInstance<
-    string,
-    IActiveContext<string>
-  >();
-
-  const timezoneStr =
-    validConsoleTimezoneArgv ??
-    validConsoleTimezoneEnv ??
-    validSystemTz ??
-    context.adminTimezone.value;
-
-  const finalTimezone = timezoneStr ?? 'UTC';
-  context.adminTimezone = createTimezone(finalTimezone);
-  return finalTimezone;
-}

package/src/interfaces/application.ts

@@ -1,40 +0,0 @@
-/**
- * @fileoverview Application interface defining core application structure and services.
- * Provides access to environment, constants, database, and service container.
- * @module interfaces/application
- */
-
-import mongoose, { Model } from '@digitaldefiance/mongoose-types';
-import { ServiceContainer } from '../container';
-import { IBaseDocument } from '../documents';
-import { Environment } from '../environment';
-import { IConstants } from './constants';
-import type { PlatformID } from '@digitaldefiance/node-ecies-lib';
-
-/**
- * Core application interface providing access to all application services and configuration.
- * @template TID Platform-specific ID type (Buffer, ObjectId, etc.)
- */
-export interface IApplication<TID extends PlatformID = Buffer> {
-  /** Application environment configuration */
-  get environment(): Environment<TID>;
-  /** Application constants and configuration values */
-  get constants(): IConstants;
-  /** Mongoose database connection */
-  get db(): typeof mongoose;
-  /** Whether the application is ready to handle requests */
-  get ready(): boolean;
-  /** Service container for dependency injection */
-  get services(): ServiceContainer;
-  /** Plugin manager for extensibility */
-  get plugins(): import('../plugins').PluginManager<TID>;
-  /** Starts the application and initializes all services */
-  start(): Promise<void>;
-  /**
-   * Gets a Mongoose model by name.
-   * @template U Document type extending IBaseDocument
-   * @param modelName Name of the model to retrieve
-   * @returns Mongoose model instance
-   */
-  getModel<U extends IBaseDocument<any, TID>>(modelName: string): Model<U>;
-}

package/src/interfaces/checksum-consts.ts

@@ -1,23 +0,0 @@
-/**
- * @fileoverview Checksum constants interface.
- * Defines configuration constants for SHA3 checksum operations.
- * @module interfaces/checksum-consts
- */
-
-/**
- * Constants for checksum generation and validation.
- * Defines SHA3 algorithm parameters and encoding settings.
- */
-export interface IChecksumConsts {
-  /** Default hash bits for SHA3 */
-  SHA3_DEFAULT_HASH_BITS: number;
-
-  /** Length of a SHA3 checksum buffer in bytes */
-  SHA3_BUFFER_LENGTH: number;
-
-  /** Algorithm name for checksums */
-  ALGORITHM: string;
-
-  /** Encoding for checksums */
-  ENCODING: 'hex' | 'base64';
-}