@digitaldefiance/node-express-suite 1.0.23 → 1.0.24

package/src/errors/express-validation.ts

@@ -1,21 +0,0 @@
-import { PluginTranslatableGenericError } from '@digitaldefiance/i18n-lib';
-import {
-  SuiteCoreComponentId,
-  SuiteCoreStringKey,
-} from '@digitaldefiance/suite-core-lib';
-import { Result, ValidationError } from 'express-validator';
-
-export class ExpressValidationError extends PluginTranslatableGenericError<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,14 +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;
-  }
-}

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

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

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 = 'ModelNotRegisteredError';
-  }
-}

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,12 +0,0 @@
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteHandleableError,
-} from '@digitaldefiance/suite-core-lib';
-
-export class MnemonicOrPasswordRequiredError extends TranslatableSuiteHandleableError {
-  constructor() {
-    super(SuiteCoreStringKey.Validation_MnemonicOrPasswordRequired, {
-      statusCode: 422,
-    });
-  }
-}

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(modelName: string) {
-    super(SuiteCoreStringKey.Error_ModelNotRegisteredTemplate, { modelName });
-    this.name = 'ModelNotRegisteredError';
-  }
-}

package/src/errors/mongoose-validation.ts

@@ -1,34 +0,0 @@
-import { CoreLanguageCode, HandleableError } from '@digitaldefiance/i18n-lib';
-import {
-  getSuiteCoreI18nEngine,
-  SuiteCoreComponentId,
-  SuiteCoreStringKey,
-} from '@digitaldefiance/suite-core-lib';
-import { Error } from 'mongoose';
-
-export class MongooseValidationError extends HandleableError {
-  public readonly errors: {
-    [path: string]: Error.CastError | Error.ValidatorError;
-  };
-  constructor(
-    validationErrors: {
-      [path: string]: Error.CastError | Error.ValidatorError;
-    },
-    language?: CoreLanguageCode,
-  ) {
-    const coreEngine = getSuiteCoreI18nEngine();
-    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,41 +0,0 @@
-import { CoreLanguageCode, PluginTypedError } from '@digitaldefiance/i18n-lib';
-import {
-  getSuiteCoreI18nEngine,
-  SuiteCoreComponentId,
-  SuiteCoreStringKey,
-} from '@digitaldefiance/suite-core-lib';
-import { Constants } 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,
-  CoreLanguageCode
-> {
-  constructor(
-    type: SymmetricErrorType,
-    language?: CoreLanguageCode,
-    constants: IConstants = Constants,
-  ) {
-    const engine = getSuiteCoreI18nEngine();
-    super(
-      engine,
-      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,10 +0,0 @@
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteError,
-} from '@digitaldefiance/suite-core-lib';
-
-export class TokenExpiredError extends TranslatableSuiteError {
-  constructor() {
-    super(SuiteCoreStringKey.Validation_TokenExpired, { statusCode: 401 });
-  }
-}

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,45 +0,0 @@
-import {
-  GlobalActiveContext,
-  IActiveContext,
-  isValidTimezone,
-  Timezone,
-} from '@digitaldefiance/i18n-lib';
-import { existsSync, readFileSync } from 'fs';
-
-export function setGlobalActiveContextAdminTimezoneFromProcessArgvOrEnv(): Timezone {
-  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 /etc/timezone, environment variable, then command-line argument
-  // if /etc/timezone has a timezone, and is valid (isValidTimezone) start with that
-  // if TZ env is set, and is valid (isValidTimezone), override with that
-  // if command-line argument is set, and is valid (isValidTimezone), override with that
-  const validSystemTz =
-    systemTz && isValidTimezone(systemTz) ? new Timezone(systemTz) : undefined;
-  const validConsoleTimezoneEnv =
-    consoleTimezoneEnv && isValidTimezone(consoleTimezoneEnv)
-      ? new Timezone(consoleTimezoneEnv)
-      : undefined;
-  const validConsoleTimezoneArgv = consoleTimezoneArgv
-    ? new Timezone(consoleTimezoneArgv.split('=')[1])
-    : undefined;
-
-  const context = GlobalActiveContext.getInstance<
-    string,
-    IActiveContext<string>
-  >();
-
-  const timezone =
-    validSystemTz ??
-    validConsoleTimezoneEnv ??
-    validConsoleTimezoneArgv ??
-    context.adminTimezone;
-
-  context.adminTimezone = timezone;
-  return timezone;
-}

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/backend-objects/email-token.ts

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

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

@@ -1,9 +0,0 @@
-import { AccountStatus, IUserBase } from '@digitaldefiance/suite-core-lib';
-import { Types } from 'mongoose';
-
-export type IUserBackendObject<S extends string> = IUserBase<
-  Types.ObjectId,
-  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/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,35 +0,0 @@
-import { IncomingMessage, ServerResponse } from 'http';
-
-export interface ICSPConfig {
-  corsWhitelist: string[];
-  csp: {
-    defaultSrc: (
-      | string
-      | ((req: IncomingMessage, res: ServerResponse) => string)
-    )[];
-    imgSrc: (
-      | string
-      | ((req: IncomingMessage, res: ServerResponse) => string)
-    )[];
-    connectSrc: (
-      | string
-      | ((req: IncomingMessage, res: ServerResponse) => string)
-    )[];
-    scriptSrc: (
-      | string
-      | ((req: IncomingMessage, res: ServerResponse) => string)
-    )[];
-    styleSrc: (
-      | string
-      | ((req: IncomingMessage, res: ServerResponse) => string)
-    )[];
-    fontSrc: (
-      | string
-      | ((req: IncomingMessage, res: ServerResponse) => string)
-    )[];
-    frameSrc: (
-      | string
-      | ((req: IncomingMessage, res: ServerResponse) => string)
-    )[];
-  };
-}

package/src/interfaces/deep-partial.ts

@@ -1,3 +0,0 @@
-export type DeepPartial<T> = {
-  [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
-};

package/src/interfaces/email-service.ts

@@ -1,8 +0,0 @@
-export interface IEmailService {
-  sendEmail(
-    to: string,
-    subject: string,
-    text: string,
-    html: string,
-  ): Promise<void>;
-}

package/src/interfaces/environment-mongo.ts

@@ -1,76 +0,0 @@
-import { ReadConcernLike, WriteConcern } from 'mongodb';
-
-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;
-}