@digitaldefiance/suite-core-lib 3.6.48 → 3.6.50

package/src/interfaces/core-consts.ts

@@ -1,133 +0,0 @@
-/**
- * Core constants interface for authentication, validation, and system configuration.
- */
-import { IIdProviderBase } from '@digitaldefiance/ecies-lib';
-import { IBackupCodeConstants } from './backup-code-consts';
-
-export interface ICoreConstants {
-  /**
-   * The ID provider to use for generating and parsing IDs
-   */
-  idProvider: IIdProviderBase;
-  /**
-   * Backup code related constants
-   */
-  BACKUP_CODES: IBackupCodeConstants;
-  /**
-   * Duration in milliseconds for a login challenge
-   */
-  LoginChallengeExpiration: number;
-  /**
-   * Default duration in seconds for which mnemonics are kept in memory
-   */
-  DefaultExpireMemoryMnemonicSeconds: number;
-  /**
-   * Default duration in seconds for which wallets are kept in memory
-   */
-  DefaultExpireMemoryWalletSeconds: number;
-  /**
-   * The expected length of a direct login challenge in bytes
-   */
-  DirectLoginChallengeLength: number;
-  /**
-   * Duration in milliseconds for which an email token is valid.
-   */
-  EmailTokenExpiration: number;
-  /**
-   * Length in bytes of the email token generated (is represented as a hex string of twice as many)
-   */
-  EmailTokenLength: number;
-  /**
-   * Number of rounds for bcrypt hashing. Higher values increase security but also consume more CPU resources.
-   */
-  BcryptRounds: number;
-  /**
-   * The username of the administrator user.
-   */
-  AdministratorUser: string;
-  /**
-   * The name of the administrator role.
-   */
-  AdministratorRole: string;
-  /**
-   * The name of the member role.
-   */
-  MemberRole: string;
-  /**
-   * The username of the test user.
-   */
-  MemberUser: string;
-  /**
-   * The name of the system role.
-   */
-  SystemRole: string;
-  /**
-   * The username of the system user.
-   */
-  SystemUser: string;
-  /**
-   * Minimum username length
-   */
-  UsernameMinLength: number;
-  /**
-   * Maximum username length
-   */
-  UsernameMaxLength: number;
-  /**
-   * The regular expression for valid usernames.
-   */
-  UsernameRegex: RegExp;
-  /**
-   * 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;
-  /**
-   * The amount of time in milliseconds after which an email token can be resent.
-   */
-  EmailTokenResendInterval: number;
-  /**
-   * The interval in minutes after which an email token can be resent.
-   */
-  EmailTokenResendIntervalMinutes: number;
-  /**
-   * The name of the site.
-   */
-  Site: string;
-  /**
-   * The tagline of the site.
-   */
-  SiteTagline: string;
-  /**
-   * The description of the site.
-   */
-  SiteDescription: string;
-  /**
-   * The email domain of usernames on the site.
-   */
-  SiteEmailDomain: string;
-  /**
-   * The hostname of the site.
-   */
-  SiteHostname: string;
-}

package/src/interfaces/dto/request-user.ts

@@ -1,23 +0,0 @@
-/**
- * Request user Data Transfer Object (DTO) interface.
- * Combined user data with roles, privileges, and settings for authenticated requests.
- */
-import { ICombinedRolePrivileges } from '../combined-role-privileges';
-import { IRoleDTO } from '../dto/role';
-
-export interface IRequestUserDTO {
-  // IUserDTO
-  id: string;
-  roles: Array<IRoleDTO>;
-  rolePrivileges: ICombinedRolePrivileges;
-  username: string;
-  email: string;
-  emailVerified: boolean;
-  lastLogin?: string;
-  // IUserSettingsDTO
-  timezone: string;
-  siteLanguage: string;
-  darkMode: boolean;
-  currency: string;
-  directChallenge: boolean;
-}

package/src/interfaces/dto/user-settings.ts

@@ -1,12 +0,0 @@
-/**
- * User settings Data Transfer Object (DTO).
- * Plain string-based representation of user settings for serialization and API transfer.
- */
-export interface IUserSettingsDTO {
-  email: string;
-  timezone: string;
-  currency: string;
-  siteLanguage: string;
-  darkMode: boolean;
-  directChallenge: boolean;
-}

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

@@ -1,21 +0,0 @@
-/**
- * Request user frontend object interface.
- * Client-side representation of authenticated user data with roles, privileges, and settings.
- */
-import { ICombinedRolePrivileges } from '../combined-role-privileges';
-import { IRoleFrontendObject } from './role';
-
-export interface IRequestUserFrontendObject {
-  id: string;
-  roles: Array<IRoleFrontendObject>;
-  rolePrivileges: ICombinedRolePrivileges;
-  username: string;
-  email: string;
-  timezone: string;
-  currency: string;
-  directChallenge: boolean;
-  siteLanguage: string;
-  lastLogin?: Date;
-  emailVerified: boolean;
-  darkMode: boolean;
-}

package/src/interfaces/has-creator.ts

@@ -1,11 +0,0 @@
-import type { PlatformID } from "@digitaldefiance/ecies-lib";
-
-/**
- * Interface for objects that track who created them.
- */
-export interface IHasCreator<TID extends PlatformID> {
-  /**
-   * The unique identifier for the user who created the object.
-   */
-  createdBy: TID;
-}

package/src/interfaces/has-id.ts

@@ -1,8 +0,0 @@
-import type { PlatformID } from "@digitaldefiance/ecies-lib";
-
-/**
- * Interface for objects with a unique identifier.
- */
-export interface IHasId<TID extends PlatformID> {
-  _id: TID;
-}

package/src/interfaces/has-soft-deleter.ts

@@ -1,11 +0,0 @@
-import type { PlatformID } from "@digitaldefiance/ecies-lib";
-
-/**
- * Interface for objects that track who deleted them (soft delete).
- */
-export interface IHasSoftDeleter<TID extends PlatformID> {
-  /**
-   * The unique identifier for the user who deleted the object.
-   */
-  deletedBy?: TID;
-}

package/src/interfaces/has-timestamps.ts

@@ -1,11 +0,0 @@
-/**
- * Interface for objects with creation and update timestamps.
- */
-import { IHasCreation } from './has-creation';
-
-export interface IHasTimestamps<
-  TDate extends Date | string,
-> extends IHasCreation<TDate> {
-  createdAt: TDate;
-  updatedAt: TDate;
-}

package/src/interfaces/has-updater.ts

@@ -1,11 +0,0 @@
-import type { PlatformID } from "@digitaldefiance/ecies-lib";
-
-/**
- * Interface for objects that track who updated them.
- */
-export interface IHasUpdater<TID extends PlatformID> {
-  /**
-   * The unique identifier for the user who updated the object.
-   */
-  updatedBy: TID;
-}

package/src/lib/flags.ts

@@ -1,286 +0,0 @@
-/**
- * Mapping from BCP-47 language codes to FlagCDN flag codes
- * Based on Flagpedia.net flag codes
- */
-
-export const BCP47_TO_FLAG_CDN: Record<string, string> = {
-  // Major languages with country flags
-  'en-US': 'us',
-  'en-GB': 'gb',
-  en: 'gb',
-  fr: 'fr',
-  'fr-FR': 'fr',
-  es: 'es',
-  'es-ES': 'es',
-  de: 'de',
-  'de-DE': 'de',
-  'zh-CN': 'cn',
-  zh: 'cn',
-  ja: 'jp',
-  'ja-JP': 'jp',
-  uk: 'ua',
-  'uk-UA': 'ua',
-
-  // All ISO 3166-1 alpha-2 codes from the HTML
-  af: 'af', // Afghanistan
-  ax: 'ax', // Åland Islands
-  al: 'al', // Albania
-  dz: 'dz', // Algeria
-  as: 'as', // American Samoa
-  ad: 'ad', // Andorra
-  ao: 'ao', // Angola
-  ai: 'ai', // Anguilla
-  aq: 'aq', // Antarctica
-  ag: 'ag', // Antigua and Barbuda
-  ar: 'ar', // Argentina
-  am: 'am', // Armenia
-  aw: 'aw', // Aruba
-  au: 'au', // Australia
-  at: 'at', // Austria
-  az: 'az', // Azerbaijan
-  bs: 'bs', // Bahamas
-  bh: 'bh', // Bahrain
-  bd: 'bd', // Bangladesh
-  bb: 'bb', // Barbados
-  by: 'by', // Belarus
-  be: 'be', // Belgium
-  bz: 'bz', // Belize
-  bj: 'bj', // Benin
-  bm: 'bm', // Bermuda
-  bt: 'bt', // Bhutan
-  bo: 'bo', // Bolivia
-  ba: 'ba', // Bosnia and Herzegovina
-  bw: 'bw', // Botswana
-  bv: 'bv', // Bouvet Island
-  br: 'br', // Brazil
-  io: 'io', // British Indian Ocean Territory
-  bn: 'bn', // Brunei
-  bg: 'bg', // Bulgaria
-  bf: 'bf', // Burkina Faso
-  bi: 'bi', // Burundi
-  kh: 'kh', // Cambodia
-  cm: 'cm', // Cameroon
-  ca: 'ca', // Canada
-  cv: 'cv', // Cape Verde
-  bq: 'bq', // Caribbean Netherlands
-  ky: 'ky', // Cayman Islands
-  cf: 'cf', // Central African Republic
-  td: 'td', // Chad
-  cl: 'cl', // Chile
-  cn: 'cn', // China
-  cx: 'cx', // Christmas Island
-  cc: 'cc', // Cocos Islands
-  co: 'co', // Colombia
-  km: 'km', // Comoros
-  cg: 'cg', // Republic of the Congo
-  cd: 'cd', // DR Congo
-  ck: 'ck', // Cook Islands
-  cr: 'cr', // Costa Rica
-  ci: 'ci', // Côte d'Ivoire
-  hr: 'hr', // Croatia
-  cu: 'cu', // Cuba
-  cw: 'cw', // Curaçao
-  cy: 'cy', // Cyprus
-  cz: 'cz', // Czechia
-  dk: 'dk', // Denmark
-  dj: 'dj', // Djibouti
-  dm: 'dm', // Dominica
-  do: 'do', // Dominican Republic
-  ec: 'ec', // Ecuador
-  eg: 'eg', // Egypt
-  sv: 'sv', // El Salvador
-  gq: 'gq', // Equatorial Guinea
-  er: 'er', // Eritrea
-  ee: 'ee', // Estonia
-  sz: 'sz', // Eswatini
-  et: 'et', // Ethiopia
-  fk: 'fk', // Falkland Islands
-  fo: 'fo', // Faroe Islands
-  fj: 'fj', // Fiji
-  fi: 'fi', // Finland
-  gf: 'gf', // French Guiana
-  pf: 'pf', // French Polynesia
-  tf: 'tf', // French Southern and Antarctic Lands
-  ga: 'ga', // Gabon
-  gm: 'gm', // Gambia
-  ge: 'ge', // Georgia
-  gh: 'gh', // Ghana
-  gi: 'gi', // Gibraltar
-  gr: 'gr', // Greece
-  gl: 'gl', // Greenland
-  gd: 'gd', // Grenada
-  gp: 'gp', // Guadeloupe
-  gu: 'gu', // Guam
-  gt: 'gt', // Guatemala
-  gg: 'gg', // Guernsey
-  gn: 'gn', // Guinea
-  gw: 'gw', // Guinea-Bissau
-  gy: 'gy', // Guyana
-  ht: 'ht', // Haiti
-  hm: 'hm', // Heard Island and McDonald Islands
-  hn: 'hn', // Honduras
-  hk: 'hk', // Hong Kong
-  hu: 'hu', // Hungary
-  is: 'is', // Iceland
-  in: 'in', // India
-  id: 'id', // Indonesia
-  ir: 'ir', // Iran
-  iq: 'iq', // Iraq
-  ie: 'ie', // Ireland
-  im: 'im', // Isle of Man
-  il: 'il', // Israel
-  it: 'it', // Italy
-  jm: 'jm', // Jamaica
-  jp: 'jp', // Japan
-  je: 'je', // Jersey
-  jo: 'jo', // Jordan
-  kz: 'kz', // Kazakhstan
-  ke: 'ke', // Kenya
-  ki: 'ki', // Kiribati
-  kp: 'kp', // North Korea
-  kr: 'kr', // South Korea
-  xk: 'xk', // Kosovo
-  kw: 'kw', // Kuwait
-  kg: 'kg', // Kyrgyzstan
-  la: 'la', // Laos
-  lv: 'lv', // Latvia
-  lb: 'lb', // Lebanon
-  ls: 'ls', // Lesotho
-  lr: 'lr', // Liberia
-  ly: 'ly', // Libya
-  li: 'li', // Liechtenstein
-  lt: 'lt', // Lithuania
-  lu: 'lu', // Luxembourg
-  mo: 'mo', // Macau
-  mg: 'mg', // Madagascar
-  mw: 'mw', // Malawi
-  my: 'my', // Malaysia
-  mv: 'mv', // Maldives
-  ml: 'ml', // Mali
-  mt: 'mt', // Malta
-  mh: 'mh', // Marshall Islands
-  mq: 'mq', // Martinique
-  mr: 'mr', // Mauritania
-  mu: 'mu', // Mauritius
-  yt: 'yt', // Mayotte
-  mx: 'mx', // Mexico
-  fm: 'fm', // Micronesia
-  md: 'md', // Moldova
-  mc: 'mc', // Monaco
-  mn: 'mn', // Mongolia
-  me: 'me', // Montenegro
-  ms: 'ms', // Montserrat
-  ma: 'ma', // Morocco
-  mz: 'mz', // Mozambique
-  mm: 'mm', // Myanmar
-  na: 'na', // Namibia
-  nr: 'nr', // Nauru
-  np: 'np', // Nepal
-  nl: 'nl', // Netherlands
-  nc: 'nc', // New Caledonia
-  nz: 'nz', // New Zealand
-  ni: 'ni', // Nicaragua
-  ne: 'ne', // Niger
-  ng: 'ng', // Nigeria
-  nu: 'nu', // Niue
-  nf: 'nf', // Norfolk Island
-  mk: 'mk', // North Macedonia
-  mp: 'mp', // Northern Mariana Islands
-  no: 'no', // Norway
-  om: 'om', // Oman
-  pk: 'pk', // Pakistan
-  pw: 'pw', // Palau
-  ps: 'ps', // Palestine
-  pa: 'pa', // Panama
-  pg: 'pg', // Papua New Guinea
-  py: 'py', // Paraguay
-  pe: 'pe', // Peru
-  ph: 'ph', // Philippines
-  pn: 'pn', // Pitcairn Islands
-  pl: 'pl', // Poland
-  pt: 'pt', // Portugal
-  pr: 'pr', // Puerto Rico
-  qa: 'qa', // Qatar
-  re: 're', // Réunion
-  ro: 'ro', // Romania
-  ru: 'ru', // Russia
-  rw: 'rw', // Rwanda
-  bl: 'bl', // Saint Barthélemy
-  sh: 'sh', // Saint Helena
-  kn: 'kn', // Saint Kitts and Nevis
-  lc: 'lc', // Saint Lucia
-  mf: 'mf', // Saint Martin
-  pm: 'pm', // Saint Pierre and Miquelon
-  vc: 'vc', // Saint Vincent and the Grenadines
-  ws: 'ws', // Samoa
-  sm: 'sm', // San Marino
-  st: 'st', // São Tomé and Príncipe
-  sa: 'sa', // Saudi Arabia
-  sn: 'sn', // Senegal
-  rs: 'rs', // Serbia
-  sc: 'sc', // Seychelles
-  sl: 'sl', // Sierra Leone
-  sg: 'sg', // Singapore
-  sx: 'sx', // Sint Maarten
-  sk: 'sk', // Slovakia
-  si: 'si', // Slovenia
-  sb: 'sb', // Solomon Islands
-  so: 'so', // Somalia
-  za: 'za', // South Africa
-  gs: 'gs', // South Georgia
-  ss: 'ss', // South Sudan
-  lk: 'lk', // Sri Lanka
-  sd: 'sd', // Sudan
-  sr: 'sr', // Suriname
-  sj: 'sj', // Svalbard and Jan Mayen
-  se: 'se', // Sweden
-  ch: 'ch', // Switzerland
-  sy: 'sy', // Syria
-  tw: 'tw', // Taiwan
-  tj: 'tj', // Tajikistan
-  tz: 'tz', // Tanzania
-  th: 'th', // Thailand
-  tl: 'tl', // Timor-Leste
-  tg: 'tg', // Togo
-  tk: 'tk', // Tokelau
-  to: 'to', // Tonga
-  tt: 'tt', // Trinidad and Tobago
-  tn: 'tn', // Tunisia
-  tr: 'tr', // Turkey
-  tm: 'tm', // Turkmenistan
-  tc: 'tc', // Turks and Caicos Islands
-  tv: 'tv', // Tuvalu
-  ug: 'ug', // Uganda
-  ua: 'ua', // Ukraine
-  ae: 'ae', // United Arab Emirates
-  gb: 'gb', // United Kingdom
-  us: 'us', // United States
-  um: 'um', // United States Minor Outlying Islands
-  uy: 'uy', // Uruguay
-  uz: 'uz', // Uzbekistan
-  vu: 'vu', // Vanuatu
-  va: 'va', // Vatican City
-  ve: 've', // Venezuela
-  vn: 'vn', // Vietnam
-  vg: 'vg', // British Virgin Islands
-  vi: 'vi', // United States Virgin Islands
-  wf: 'wf', // Wallis and Futuna
-  eh: 'eh', // Western Sahara
-  ye: 'ye', // Yemen
-  zm: 'zm', // Zambia
-  zw: 'zw', // Zimbabwe
-
-  // UK constituent countries
-  'en-GB-ENG': 'gb-eng', // England
-  'en-GB-SCT': 'gb-sct', // Scotland
-  'en-GB-WLS': 'gb-wls', // Wales
-  'en-GB-NIR': 'gb-nir', // Northern Ireland
-};
-
-/**
- * Get FlagCDN flag code from BCP-47 language code
- */
-export function getFlagCode(bcp47: string): string | undefined {
-  if (!bcp47) return undefined;
-  return BCP47_TO_FLAG_CDN[bcp47] || BCP47_TO_FLAG_CDN[bcp47.toLowerCase()];
-}

package/src/lib/formatters.ts

@@ -1,26 +0,0 @@
-/**
- * Common formatting helpers
- */
-
-/**
- * Format backup code with dashes (XXXX-XXXX-XXXX-XXXX)
- */
-export function formatBackupCode(code: string): string {
-  const cleaned = code.replace(/[^A-Z0-9]/gi, '').toUpperCase();
-  return cleaned.match(/.{1,4}/g)?.join('-') || cleaned;
-}
-
-/**
- * Validate backup code format
- */
-export function isValidBackupCodeFormat(code: string): boolean {
-  const cleaned = code.replace(/[^A-Z0-9]/gi, '');
-  return cleaned.length === 16;
-}
-
-/**
- * Normalize backup code (remove dashes, uppercase)
- */
-export function normalizeBackupCode(code: string): string {
-  return code.replace(/[^A-Z0-9]/gi, '').toUpperCase();
-}

package/src/lib/hydrate-dehydrate.ts

@@ -1,43 +0,0 @@
-/**
- * Hydration and dehydration utilities for converting between DTOs and domain objects.
- * Provides functions to transform plain data objects into rich domain objects with validation.
- */
-import { EmailString } from '@digitaldefiance/ecies-lib';
-import { CurrencyCode, Timezone } from '@digitaldefiance/i18n-lib';
-import { IUserSettings, IUserSettingsDTO } from '../interfaces';
-
-/**
- * Hydrate user settings DTO into domain object with validated types.
- * Converts plain string values into typed domain objects (EmailString, Timezone, CurrencyCode).
- * @param dto - Plain user settings data transfer object
- * @returns Hydrated user settings with validated domain types
- */
-export function hydrateUserSettings(dto: IUserSettingsDTO): IUserSettings {
-  return {
-    email: new EmailString(dto.email),
-    timezone: new Timezone(dto.timezone),
-    currency: new CurrencyCode(dto.currency),
-    siteLanguage: dto.siteLanguage,
-    darkMode: dto.darkMode,
-    directChallenge: dto.directChallenge,
-  };
-}
-
-/**
- * Dehydrate user settings domain object into plain DTO.
- * Converts typed domain objects back into plain string values for serialization.
- * @param settings - User settings domain object with typed values
- * @returns Plain user settings DTO suitable for JSON serialization
- */
-export function dehydrateUserSettings(
-  settings: IUserSettings,
-): IUserSettingsDTO {
-  return {
-    email: settings.email.email,
-    timezone: settings.timezone.value,
-    currency: settings.currency.value,
-    siteLanguage: settings.siteLanguage,
-    darkMode: settings.darkMode,
-    directChallenge: settings.directChallenge,
-  };
-}

package/src/lib/validators-with-constants.ts

@@ -1,74 +0,0 @@
-/**
- * Validators that accept custom constants
- * Allows consumers to pass their own IConstants implementation
- */
-
-import { CORE } from '../constants';
-import { IConstants } from '../interfaces/constants';
-import { ICoreConstants } from '../interfaces/core-consts';
-
-/**
- * Create validators bound to specific constants
- */
-export function createValidators(
-  constants: ICoreConstants | IConstants = CORE,
-) {
-  return {
-    /**
-     * Validate username format using provided constants
-     */
-    isValidUsername(username: string): boolean {
-      return constants.UsernameRegex.test(username);
-    },
-
-    /**
-     * Validate password format using provided constants
-     */
-    isValidPassword(password: string): boolean {
-      return constants.PasswordRegex.test(password);
-    },
-
-    /**
-     * Validate mnemonic format using provided constants
-     */
-    isValidMnemonic(mnemonic: string): boolean {
-      return constants.MnemonicRegex.test(mnemonic);
-    },
-
-    /**
-     * Validate backup code normalized format using provided constants
-     */
-    isValidBackupCodeNormalized(code: string): boolean {
-      return constants.BACKUP_CODES.NormalizedHexRegex.test(code);
-    },
-
-    /**
-     * Validate backup code display format using provided constants
-     */
-    isValidBackupCodeDisplay(code: string): boolean {
-      return constants.BACKUP_CODES.DisplayRegex.test(code);
-    },
-
-    /**
-     * Validate username length using provided constants
-     */
-    isValidUsernameLength(username: string): boolean {
-      return (
-        username.length >= constants.UsernameMinLength &&
-        username.length <= constants.UsernameMaxLength
-      );
-    },
-
-    /**
-     * Validate password length using provided constants
-     */
-    isValidPasswordLength(password: string): boolean {
-      return password.length >= constants.PasswordMinLength;
-    },
-  };
-}
-
-/**
- * Default validators using CORE constants
- */
-export const defaultValidators = createValidators();