@digitaldefiance/node-express-suite 1.0.21 → 1.0.23

package/src/errors/express-validation.ts

@@ -0,0 +1,21 @@
+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/{dist/errors/index.d.ts → src/errors/index.ts}

@@ -10,4 +10,3 @@ export * from './model-not-registered';
 export * from './mongoose-validation';
 export * from './symmetric';
 export * from './token-expired';
-//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,18 @@
+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

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

@@ -0,0 +1,36 @@
+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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,34 @@
+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

@@ -0,0 +1,41 @@
+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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,53 @@
+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

@@ -0,0 +1,45 @@
+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/{dist/index.d.ts → src/index.ts}

@@ -1,3 +1,5 @@
+import 'reflect-metadata';
+
 export * from './application';
 export * from './application-base';
 export * from './backup-code';
@@ -6,8 +8,8 @@ export * from './controllers';
 export * from './decorators';
 export * from './defaults';
 export * from './documents';
-export * from './environment';
 export * from './enumerations';
+export * from './environment';
 export * from './errors';
 export * from './get-language';
 export * from './get-timezone';
@@ -21,4 +23,3 @@ export * from './schemas';
 export * from './services';
 export * from './types';
 export * from './utils';
-//# sourceMappingURL=index.d.ts.map

package/{dist/interfaces/api-error-response.d.ts → src/interfaces/api-error-response.ts}

@@ -1,5 +1,5 @@
 import { IApiMessageResponse } from './api-message-response';
+
 export interface IApiErrorResponse extends IApiMessageResponse {
-    error: unknown;
+  error: unknown;
 }
-//# sourceMappingURL=api-error-response.d.ts.map

package/src/interfaces/api-express-validation-error-response.ts

@@ -0,0 +1,8 @@
+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

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

package/{dist/interfaces/api-mongo-validation-error-response.d.ts → src/interfaces/api-mongo-validation-error-response.ts}

@@ -1,6 +1,6 @@
 import { IApiMessageResponse } from './api-message-response';
 import { IMongoErrors } from './mongo-errors';
+
 export interface IApiMongoValidationErrorResponse extends IApiMessageResponse {
-    errors: IMongoErrors;
+  errors: IMongoErrors;
 }
-//# sourceMappingURL=api-mongo-validation-error-response.d.ts.map

package/{dist/interfaces/api-responses/backup-codes-response.d.ts → src/interfaces/api-responses/backup-codes-response.ts}

@@ -1,5 +1,5 @@
 import { IApiMessageResponse } from '../api-message-response';
+
 export interface IApiBackupCodesResponse extends IApiMessageResponse {
-    backupCodes: Array<string>;
+  backupCodes: Array<string>;
 }
-//# sourceMappingURL=backup-codes-response.d.ts.map

package/{dist/interfaces/api-responses/challenge-response.d.ts → src/interfaces/api-responses/challenge-response.ts}

@@ -1,6 +1,6 @@
 import { IApiMessageResponse } from '../api-message-response';
+
 export interface IApiChallengeResponse extends IApiMessageResponse {
-    challenge: string;
-    serverPublicKey: string;
+  challenge: string;
+  serverPublicKey: string;
 }
-//# sourceMappingURL=challenge-response.d.ts.map

package/{dist/interfaces/api-responses/code-count-response.d.ts → src/interfaces/api-responses/code-count-response.ts}

@@ -1,5 +1,5 @@
 import { IApiMessageResponse } from '../api-message-response';
+
 export interface IApiCodeCountResponse extends IApiMessageResponse {
-    codeCount: number;
+  codeCount: number;
 }
-//# sourceMappingURL=code-count-response.d.ts.map

package/{dist/interfaces/api-responses/index.d.ts → src/interfaces/api-responses/index.ts}

@@ -5,4 +5,3 @@ export * from './login-response';
 export * from './mnemonic-response';
 export * from './registration-response';
 export * from './request-user-response';
-//# sourceMappingURL=index.d.ts.map

package/{dist/interfaces/api-responses/login-response.d.ts → src/interfaces/api-responses/login-response.ts}

@@ -1,8 +1,8 @@
 import { IRequestUserDTO } from '@digitaldefiance/suite-core-lib';
 import { IApiMessageResponse } from '../api-message-response';
+
 export interface IApiLoginResponse extends IApiMessageResponse {
-    user: IRequestUserDTO;
-    token: string;
-    serverPublicKey: string;
+  user: IRequestUserDTO;
+  token: string;
+  serverPublicKey: string;
 }
-//# sourceMappingURL=login-response.d.ts.map

package/{dist/interfaces/api-responses/mnemonic-response.d.ts → src/interfaces/api-responses/mnemonic-response.ts}

@@ -1,5 +1,5 @@
 import { IApiMessageResponse } from '../api-message-response';
+
 export interface IApiMnemonicResponse extends IApiMessageResponse {
-    mnemonic: string;
+  mnemonic: string;
 }
-//# sourceMappingURL=mnemonic-response.d.ts.map

package/{dist/interfaces/api-responses/registration-response.d.ts → src/interfaces/api-responses/registration-response.ts}

@@ -1,6 +1,6 @@
 import { IApiMessageResponse } from '../api-message-response';
+
 export interface IApiRegistrationResponse extends IApiMessageResponse {
-    mnemonic: string;
-    backupCodes: Array<string>;
+  mnemonic: string;
+  backupCodes: Array<string>;
 }
-//# sourceMappingURL=registration-response.d.ts.map

package/{dist/interfaces/api-responses/request-user-response.d.ts → src/interfaces/api-responses/request-user-response.ts}

@@ -1,6 +1,6 @@
 import { IRequestUserDTO } from '@digitaldefiance/suite-core-lib';
 import { IApiMessageResponse } from '../api-message-response';
+
 export interface IApiRequestUserResponse extends IApiMessageResponse {
-    user: IRequestUserDTO;
+  user: IRequestUserDTO;
 }
-//# sourceMappingURL=request-user-response.d.ts.map

package/{dist/interfaces/application.d.ts → src/interfaces/application.ts}

@@ -2,12 +2,12 @@ import mongoose, { Types, Model } from 'mongoose';
 import { Environment } from '../environment';
 import { IConstants } from './constants';
 import { IBaseDocument } from '../documents';
+
 export interface IApplication<T, I extends Types.ObjectId | string, TBaseDocument extends IBaseDocument<T, I> = IBaseDocument<T, I>, TEnvironment extends Environment = Environment, TConstants extends IConstants = IConstants> {
-    get environment(): TEnvironment;
-    get constants(): TConstants;
-    get db(): typeof mongoose;
-    get ready(): boolean;
-    start(): Promise<void>;
-    getModel<U extends TBaseDocument>(modelName: string): Model<U>;
+  get environment(): TEnvironment;
+  get constants(): TConstants;
+  get db(): typeof mongoose;
+  get ready(): boolean;
+  start(): Promise<void>;
+  getModel<U extends TBaseDocument>(modelName: string): Model<U>;
 }
-//# sourceMappingURL=application.d.ts.map

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

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

package/{dist/interfaces/backend-objects/index.d.ts → src/interfaces/backend-objects/index.ts}

@@ -2,4 +2,3 @@ export * from './email-token';
 export * from './request-user';
 export * from './role';
 export * from './user';
-//# sourceMappingURL=index.d.ts.map

package/{dist/interfaces/backend-objects/request-user.d.ts → src/interfaces/backend-objects/request-user.ts}

@@ -1,5 +1,10 @@
 import { Types } from 'mongoose';
 import { IRequestUser } from '../request-user';
 import { IRoleBackendObject } from './role';
-export type IRequestUserBackendObject<S extends string> = IRequestUser<Types.ObjectId, Array<IRoleBackendObject>, S, Date>;
-//# sourceMappingURL=request-user.d.ts.map
+
+export type IRequestUserBackendObject<S extends string> = IRequestUser<
+  Types.ObjectId,
+  Array<IRoleBackendObject>,
+  S,
+  Date
+>;

package/{dist/interfaces/backend-objects/role.d.ts → src/interfaces/backend-objects/role.ts}

@@ -1,4 +1,4 @@
 import { IRoleBase, Role } from '@digitaldefiance/suite-core-lib';
 import { Types } from 'mongoose';
+
 export type IRoleBackendObject = IRoleBase<Types.ObjectId, Date, Role>;
-//# sourceMappingURL=role.d.ts.map

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

@@ -0,0 +1,9 @@
+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

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

package/src/interfaces/checksum-consts.ts

@@ -0,0 +1,13 @@
+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/{dist/interfaces/constants.d.ts → src/interfaces/constants.ts}

@@ -3,10 +3,10 @@ import { IConstants as IBaseConstants } from '@digitaldefiance/suite-core-lib';
 import { IChecksumConsts } from './checksum-consts';
 import { IFECConsts } from './fec-consts';
 import { IJwtConsts } from './jwt-consts';
+
 export interface IConstants extends IBaseConstants {
-    CHECKSUM: IChecksumConsts;
-    JWT: IJwtConsts;
-    FEC: IFECConsts;
-    ECIES: IECIESConstants;
+  CHECKSUM: IChecksumConsts;
+  JWT: IJwtConsts;
+  FEC: IFECConsts;
+  ECIES: IECIESConstants;
 }
-//# sourceMappingURL=constants.d.ts.map

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

@@ -0,0 +1,17 @@
+/**
+ * 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

@@ -0,0 +1,35 @@
+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

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