@digitaldefiance/suite-core-lib 3.6.6 → 3.6.8

package/src/interfaces/dto/{user.d.ts → user.ts}

@@ -1,3 +1,3 @@
 import { IUserBase } from '../bases/user';
+
 export type IUserDTO = IUserBase<string, string, string, string>;
-//# sourceMappingURL=user.d.ts.map

package/src/interfaces/failable-result.ts

@@ -0,0 +1,6 @@
+export interface IFailableResult<T> {
+  success: boolean;
+  data?: T;
+  message?: string;
+  error?: string | Error;
+}

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

@@ -0,0 +1,8 @@
+import { EmailTokenType } from '../../enumerations/email-token-type';
+import { IEmailTokenBase } from '../bases/email-token';
+
+export type IEmailTokenFrontendObject = IEmailTokenBase<
+  string,
+  Date,
+  EmailTokenType
+>;

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

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

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

@@ -0,0 +1,17 @@
+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/frontend-objects/{role.d.ts → role.ts}

@@ -1,4 +1,4 @@
 import { Role } from '../../enumerations/role';
 import { IRoleBase } from '../bases/role';
+
 export type IRoleFrontendObject = IRoleBase<string, Date, Role>;
-//# sourceMappingURL=role.d.ts.map

package/src/interfaces/frontend-objects/{user-role.d.ts → user-role.ts}

@@ -1,3 +1,3 @@
 import { IUserRoleBase } from '../bases/user-role';
+
 export type IUserRoleFrontendObject = IUserRoleBase<string, Date>;
-//# sourceMappingURL=user-role.d.ts.map

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

@@ -0,0 +1,9 @@
+import { AccountStatus } from '../../enumerations/account-status';
+import { IUserBase } from '../bases/user';
+
+export type IUserFrontendObject = IUserBase<
+  string,
+  Date,
+  string,
+  AccountStatus
+>;

package/src/interfaces/has-creation.ts

@@ -0,0 +1,6 @@
+export interface IHasCreation<D extends Date | string> {
+  /**
+   * The date the object was created.
+   */
+  createdAt: D;
+}

package/src/interfaces/has-creator.ts

@@ -0,0 +1,6 @@
+export interface IHasCreator<I> {
+  /**
+   * The unique identifier for the user who created the object.
+   */
+  createdBy: I;
+}

package/src/interfaces/has-id.ts

@@ -0,0 +1,3 @@
+export interface IHasId<I> {
+  _id: I;
+}

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

@@ -0,0 +1,6 @@
+export interface IHasSoftDelete<D extends Date | string> {
+  /**
+   * The date the object was deleted.
+   */
+  deletedAt?: D;
+}

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

@@ -0,0 +1,6 @@
+export interface IHasSoftDeleter<I> {
+  /**
+   * The unique identifier for the user who deleted the object.
+   */
+  deletedBy?: I;
+}

package/src/interfaces/has-timestamp-owners.ts

@@ -0,0 +1,6 @@
+import { IHasCreator } from './has-creator';
+import { IHasUpdater } from './has-updater';
+
+export interface IHasTimestampOwners<I>
+  extends IHasCreator<I>,
+    IHasUpdater<I> {}

package/src/interfaces/has-timestamps.ts

@@ -0,0 +1,7 @@
+import { IHasCreation } from './has-creation';
+
+export interface IHasTimestamps<D extends Date | string>
+  extends IHasCreation<D> {
+  createdAt: D;
+  updatedAt: D;
+}

package/src/interfaces/has-updater.ts

@@ -0,0 +1,6 @@
+export interface IHasUpdater<I> {
+  /**
+   * The unique identifier for the user who updated the object.
+   */
+  updatedBy: I;
+}

package/src/interfaces/has-updates.ts

@@ -0,0 +1,3 @@
+export interface IHasUpdates<D extends Date | string> {
+  updatedAt: D;
+}

package/src/interfaces/{index.d.ts → index.ts}

@@ -20,4 +20,3 @@ export * from './has-updates';
 export * from './success-message';
 export * from './token-user';
 export * from './user-settings';
-//# sourceMappingURL=index.d.ts.map

package/src/interfaces/success-message.ts

@@ -0,0 +1,4 @@
+export interface ISuccessMessage {
+  success: boolean;
+  message: string;
+}

package/src/interfaces/{token-user.d.ts → token-user.ts}

@@ -1,9 +1,9 @@
 import { ITokenRoleDTO } from './dto/token-role';
+
 /**
  * Interface for the user object stored in the JWT token
  */
 export interface ITokenUser {
-    userId: string;
-    roles: ITokenRoleDTO[];
+  userId: string;
+  roles: ITokenRoleDTO[];
 }
-//# sourceMappingURL=token-user.d.ts.map

package/src/interfaces/{user-settings.d.ts → user-settings.ts}

@@ -1,5 +1,6 @@
 import { EmailString } from '@digitaldefiance/ecies-lib';
 import { CurrencyCode, Timezone } from '@digitaldefiance/i18n-lib';
+
 export interface IUserSettings {
     email: EmailString;
     timezone: Timezone;
@@ -7,5 +8,4 @@ export interface IUserSettings {
     siteLanguage: string;
     darkMode: boolean;
     directChallenge: boolean;
-}
-//# sourceMappingURL=user-settings.d.ts.map
+}

package/src/lib/flags.ts

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

@@ -0,0 +1,28 @@
+/**
+ * Common formatting helpers
+ */
+
+import { BackupCodeString } from '../backup-code-string';
+
+/**
+ * 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

@@ -0,0 +1,27 @@
+import { EmailString } from '@digitaldefiance/ecies-lib';
+import { IUserSettings, IUserSettingsDTO } from '../interfaces';
+import { CurrencyCode, Timezone } from '@digitaldefiance/i18n-lib';
+
+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,
+  };
+}
+
+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/{index.d.ts → index.ts}

@@ -1,9 +1,9 @@
 /**
  * Library utilities - validators, formatters, and helpers
  */
+
 export * from './flags';
 export * from './formatters';
 export * from './validators';
 export * from './validators-with-constants';
-export * from './hydrate-dehydrate';
-//# sourceMappingURL=index.d.ts.map
+export * from './hydrate-dehydrate';

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

@@ -0,0 +1,72 @@
+/**
+ * Validators that accept custom constants
+ * Allows consumers to pass their own IConstants implementation
+ */
+
+import { IConstants } from '../interfaces/constants';
+import { ICoreConstants } from '../interfaces/core-consts';
+import { CORE } from '../constants';
+
+/**
+ * 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();