@digitaldefiance/node-express-suite 3.6.21 → 3.6.24

package/src/errors/express-validation.ts

@@ -1,21 +0,0 @@
-import { TranslatableGenericError } from '@digitaldefiance/i18n-lib';
-import {
-  SuiteCoreComponentId,
-  SuiteCoreStringKey,
-} from '@digitaldefiance/suite-core-lib';
-import { Result, ValidationError } from 'express-validator';
-
-export class ExpressValidationError extends TranslatableGenericError<SuiteCoreStringKey> {
-  public readonly errors: Result<ValidationError> | ValidationError[];
-  public readonly statusCode?: number = 422;
-  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,15 +0,0 @@
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteError,
-} from '@digitaldefiance/suite-core-lib';
-
-export class InvalidBackupCodeVersionError extends TranslatableSuiteError {
-  public readonly version: string;
-  constructor(version: string) {
-    super(SuiteCoreStringKey.Error_InvalidBackupCodeVersionTemplate, {
-      version,
-    });
-    this.version = version;
-    this.name = 'InvalidBackupCodeVersionError';
-  }
-}

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

@@ -1,11 +0,0 @@
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteHandleableError,
-} from '@digitaldefiance/suite-core-lib';
-
-export class InvalidJwtTokenError extends TranslatableSuiteHandleableError {
-  constructor() {
-    super(SuiteCoreStringKey.Validation_InvalidToken, { statusCode: 401 });
-    this.name = 'InvalidJwtTokenError';
-  }
-}

package/src/errors/invalid-model.ts

@@ -1,11 +0,0 @@
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteError,
-} from '@digitaldefiance/suite-core-lib';
-
-export class InvalidModelError extends TranslatableSuiteError {
-  constructor(public readonly modelKey: string) {
-    super(SuiteCoreStringKey.Error_InvalidModelKeyTemplate, { modelKey });
-    this.name = 'InvalidModelError';
-  }
-}

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

@@ -1,18 +0,0 @@
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteHandleableError,
-} from '@digitaldefiance/suite-core-lib';
-
-export class InvalidNewPasswordError extends TranslatableSuiteHandleableError {
-  constructor(language?: string, statusCode = 422) {
-    super(
-      SuiteCoreStringKey.Validation_PasswordRegexErrorTemplate,
-      undefined,
-      language,
-      {
-        statusCode,
-      },
-    );
-    this.name = 'InvalidNewPasswordError';
-  }
-}

package/src/errors/invalid-password.ts

@@ -1,13 +0,0 @@
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteHandleableError,
-} from '@digitaldefiance/suite-core-lib';
-
-export class InvalidPasswordError extends TranslatableSuiteHandleableError {
-  constructor(language?: string, statusCode = 403) {
-    super(SuiteCoreStringKey.Validation_InvalidPassword, undefined, language, {
-      statusCode,
-    });
-    this.name = 'InvalidPasswordError';
-  }
-}

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

@@ -1,36 +0,0 @@
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteHandleableError,
-} from '@digitaldefiance/suite-core-lib';
-
-export class MissingValidatedDataError<
-  _TLanguage extends string,
-  _TContext extends string,
-> extends TranslatableSuiteHandleableError {
-  public readonly field?: string;
-  public readonly fields?: string[];
-  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,13 +0,0 @@
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteHandleableError,
-} from '@digitaldefiance/suite-core-lib';
-
-export class MnemonicOrPasswordRequiredError extends TranslatableSuiteHandleableError {
-  constructor() {
-    super(SuiteCoreStringKey.Validation_MnemonicOrPasswordRequired, {
-      statusCode: 422,
-    });
-    this.name = 'MnemonicOrPasswordRequiredError';
-  }
-}

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

@@ -1,11 +0,0 @@
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteError,
-} from '@digitaldefiance/suite-core-lib';
-
-export class ModelNotRegisteredError extends TranslatableSuiteError {
-  constructor(public readonly modelName: string) {
-    super(SuiteCoreStringKey.Error_ModelNotRegisteredTemplate, { modelName });
-    this.name = 'ModelNotRegisteredError';
-  }
-}

package/src/errors/mongoose-validation.ts

@@ -1,38 +0,0 @@
-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';
-
-export class MongooseValidationError extends HandleableError {
-  public readonly errors: {
-    [path: string]: Error.CastError | Error.ValidatorError;
-  };
-  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,37 +0,0 @@
-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';
-
-export class SymmetricError extends PluginTypedError<
-  typeof SymmetricErrorType,
-  SuiteCoreStringKey
-> {
-  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,11 +0,0 @@
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteError,
-} from '@digitaldefiance/suite-core-lib';
-
-export class TokenExpiredError extends TranslatableSuiteError {
-  constructor() {
-    super(SuiteCoreStringKey.Validation_TokenExpired, { statusCode: 401 });
-    this.name = 'TokenExpiredError';
-  }
-}

package/src/get-language.ts

@@ -1,53 +0,0 @@
-import {
-  GlobalActiveContext,
-  IActiveContext,
-  LanguageRegistry,
-} from '@digitaldefiance/i18n-lib';
-import {
-  getSuiteCoreTranslation,
-  SuiteCoreStringKey,
-} from '@digitaldefiance/suite-core-lib';
-import { debugLog } from './utils';
-
-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,61 +0,0 @@
-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;
-
-// Helper to create Timezone from the same module instance as GlobalActiveContext
-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);
-}
-
-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/api-express-validation-error-response.ts

@@ -1,8 +0,0 @@
-import { Result, ValidationError } from 'express-validator';
-import { IApiMessageResponse } from './api-message-response';
-
-export interface IApiExpressValidationErrorResponse
-  extends IApiMessageResponse {
-  errors: ValidationError[] | Result<ValidationError>;
-  errorType?: string;
-}

package/src/interfaces/api-message-response.ts

@@ -1,3 +0,0 @@
-export interface IApiMessageResponse {
-  message: string;
-}

package/src/interfaces/api-responses/user-settings-response.ts

@@ -1,12 +0,0 @@
-import { IApiMessageResponse } from '../api-message-response';
-
-export interface IApiUserSettingsResponse extends IApiMessageResponse {
-  settings: {
-    email: string;
-    timezone: string;
-    currency: string;
-    siteLanguage: string;
-    darkMode: boolean;
-    directChallenge: boolean;
-  };
-}

package/src/interfaces/application.ts

@@ -1,16 +0,0 @@
-import mongoose, { Model } from '@digitaldefiance/mongoose-types';
-import { ServiceContainer } from '../container';
-import { IBaseDocument } from '../documents';
-import { Environment } from '../environment';
-import { IConstants } from './constants';
-
-export interface IApplication {
-  get environment(): Environment;
-  get constants(): IConstants;
-  get db(): typeof mongoose;
-  get ready(): boolean;
-  get services(): ServiceContainer;
-  get plugins(): import('../plugins').PluginManager;
-  start(): Promise<void>;
-  getModel<U extends IBaseDocument<any, any>>(modelName: string): Model<U>;
-}

package/src/interfaces/backend-objects/email-token.ts

@@ -1,9 +0,0 @@
-import { Types } from '@digitaldefiance/mongoose-types';
-import {
-  EmailTokenType,
-  IEmailTokenBase,
-} from '@digitaldefiance/suite-core-lib';
-
-export type IEmailTokenBackendObject<
-  I extends string | Types.ObjectId = Types.ObjectId,
-> = IEmailTokenBase<I, Date, EmailTokenType>;

package/src/interfaces/backend-objects/request-user.ts

@@ -1,8 +0,0 @@
-import { Types } from '@digitaldefiance/mongoose-types';
-import { IRequestUser } from '../request-user';
-import { IRoleBackendObject } from './role';
-
-export type IRequestUserBackendObject<
-  S extends string,
-  I extends Types.ObjectId | string = Types.ObjectId,
-> = IRequestUser<I, Array<IRoleBackendObject<any>>, S, Date>;

package/src/interfaces/backend-objects/role.ts

@@ -1,6 +0,0 @@
-import { Types } from '@digitaldefiance/mongoose-types';
-import { IRoleBase, Role } from '@digitaldefiance/suite-core-lib';
-
-export type IRoleBackendObject<
-  I extends string | Types.ObjectId = Types.ObjectId,
-> = IRoleBase<I, Date, Role>;

package/src/interfaces/backend-objects/user.ts

@@ -1,7 +0,0 @@
-import { Types } from '@digitaldefiance/mongoose-types';
-import { AccountStatus, IUserBase } from '@digitaldefiance/suite-core-lib';
-
-export type IUserBackendObject<
-  S extends string,
-  I = Types.ObjectId,
-> = IUserBase<I, Date, S, AccountStatus>;

package/src/interfaces/checksum-config.ts

@@ -1,4 +0,0 @@
-export interface IChecksumConfig {
-  algorithm: string;
-  encoding: 'hex' | 'base64';
-}

package/src/interfaces/checksum-consts.ts

@@ -1,13 +0,0 @@
-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';
-}

package/src/interfaces/constants.ts

@@ -1,103 +0,0 @@
-import { IECIESConstants, IPBkdf2Consts } from '@digitaldefiance/ecies-lib';
-import {
-  IEncryptionConsts,
-  IKeyringConsts,
-  IWrappedKeyConsts,
-  PbkdfProfiles,
-} 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
- * Ecies, Node Ecies, Suite Core, and Node Express Suite
- */
-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;
-  /**
-   * 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/controller-config.ts

@@ -1,36 +0,0 @@
-import { Types } from '@digitaldefiance/mongoose-types';
-import {
-  ITokenRole,
-  ITokenUser,
-  IUserBase,
-} from '@digitaldefiance/suite-core-lib';
-import { IBaseDocument } from '../documents';
-import { Environment } from '../environment';
-import { IApplication } from './application';
-import { IConstants } from './constants';
-
-export interface IControllerConfig<
-  I extends Types.ObjectId | string = Types.ObjectId,
-  D extends Date = Date,
-  S extends string = string,
-  A extends string = string,
-> {
-  idType: I;
-  dateType: D;
-  stringType: S;
-  accountStatusType: A;
-  userType: IUserBase<I, D, S, A>;
-  tokenRoleType: ITokenRole<I, D>;
-  tokenUserType: ITokenUser;
-  baseDocumentType: IBaseDocument<any, Types.ObjectId>;
-  environmentType: Environment;
-  constantsType: IConstants;
-  applicationType: IApplication;
-}
-
-export type DefaultControllerConfig = IControllerConfig<
-  Types.ObjectId,
-  Date,
-  string,
-  string
->;

package/src/interfaces/create-user-basics.ts

@@ -1,17 +0,0 @@
-/**
- * Partial interface for creating a new user
- */
-export interface ICreateUserBasics {
-  /**
-   * The username of the user
-   */
-  username: string;
-  /**
-   * The email address of the user
-   */
-  email: string;
-  /**
-   * The timezone of the user
-   */
-  timezone?: string;
-}

package/src/interfaces/csp-config.ts

@@ -1,16 +0,0 @@
-import { ISimpleCSPDef, isSimpleCSPDef } from './csp-definition';
-
-export interface ICSPConfig {
-  corsWhitelist: string[];
-  csp: ISimpleCSPDef;
-}
-
-export const isCSPConfig = (obj: any): obj is ICSPConfig => {
-  return (
-    !!obj &&
-    typeof obj === 'object' &&
-    'corsWhitelist' in obj &&
-    'csp' in obj &&
-    isSimpleCSPDef(obj.csp)
-  );
-};