@digitaldefiance/suite-core-lib 3.6.48 → 3.6.50

package/src/backup-code-string.ts

@@ -1,102 +0,0 @@
-/**
- * Backup code string class for generating, validating, and formatting backup codes.
- * Provides type-safe handling of backup codes with multiple output formats.
- */
-import { Constants } from './constants';
-import { InvalidBackupCodeError } from './errors/invalid-backup-code';
-import { IConstants } from './interfaces';
-
-export class BackupCodeString {
-  private readonly _normalizedCode: string;
-
-  constructor(code: string) {
-    const normalizedCode = BackupCodeString.normalizeCode(code);
-    if (!Constants.BACKUP_CODES.NormalizedHexRegex.test(normalizedCode)) {
-      throw new InvalidBackupCodeError();
-    }
-    this._normalizedCode = normalizedCode;
-  }
-
-  public get value(): string {
-    return BackupCodeString.formatBackupCode(this._normalizedCode);
-  }
-
-  public get notNullValue(): string {
-    return BackupCodeString.formatBackupCode(this._normalizedCode);
-  }
-
-  public get valueAsHexString(): string {
-    const formattedValue = BackupCodeString.formatBackupCode(
-      this._normalizedCode,
-    );
-    return new TextEncoder().encode(formattedValue).reduce((str, byte) => {
-      return str + byte.toString(16).padStart(2, '0');
-    }, '');
-  }
-
-  public get valueAsBase64String(): string {
-    const formattedValue = BackupCodeString.formatBackupCode(
-      this._normalizedCode,
-    );
-    return btoa(formattedValue);
-  }
-
-  public get valueAsUint8Array(): Uint8Array {
-    const formattedValue = BackupCodeString.formatBackupCode(
-      this._normalizedCode,
-    );
-    return new TextEncoder().encode(formattedValue);
-  }
-
-  public get hasValue(): boolean {
-    return this._normalizedCode.length > 0;
-  }
-
-  public get length(): number {
-    return this._normalizedCode.length;
-  }
-
-  public dispose(): void {
-    // Backup codes are not sensitive enough to require secure disposal
-    // They're already encrypted when stored in the database
-  }
-
-  /**
-   * Format a 32-char normalized code into display form (8 groups of 4).
-   * Does not restrict characters beyond grouping.
-   */
-  public static formatBackupCode(code: string): string {
-    const groups = code.match(/.{1,4}/g) ?? [code];
-    return groups.join('-');
-  }
-  /**
-   * Normalize user-entered code: remove spaces and hyphens, lowercase, and trim.
-   */
-  public static normalizeCode(input: string): string {
-    return input.replace(/[\s-]/g, '').toLowerCase().trim();
-  }
-
-  public static generateBackupCode(): string {
-    const alphabet = 'abcdefghijklmnopqrstuvwxyz0123456789';
-    const rnd = crypto.getRandomValues(new Uint8Array(32));
-    let raw = '';
-    for (let j = 0; j < 32; j++) {
-      raw += alphabet[rnd[j] % alphabet.length];
-    }
-    return raw;
-  }
-
-  /**
-   * Generate the configured number of backup codes.
-   * Note: If generation alphabet/length is controlled elsewhere, prefer that path.
-   */
-  public static generateBackupCodes(
-    constants: IConstants = Constants,
-  ): Array<BackupCodeString> {
-    const codes: Array<BackupCodeString> = [];
-    for (let i = 0; i < constants.BACKUP_CODES.Count; i++) {
-      codes.push(new BackupCodeString(BackupCodeString.generateBackupCode()));
-    }
-    return codes;
-  }
-}

package/src/builders/role-builder.ts

@@ -1,67 +0,0 @@
-/**
- * Fluent builder for creating role objects
- */
-
-import type { PlatformID } from '@digitaldefiance/ecies-lib';
-import { Role } from '../enumerations/role';
-import { IRoleBase } from '../interfaces/bases/role';
-
-/**
- * Builder for creating role objects with fluent API
- */
-export class RoleBuilder<TID extends PlatformID = PlatformID, TDate extends Date | string = Date> {
-  private data: Partial<IRoleBase<TID, TDate, Role>> = {
-    admin: false,
-    member: false,
-    child: false,
-    system: false,
-  };
-
-  static create<TID extends PlatformID = PlatformID, TDate extends Date | string = Date>(): RoleBuilder<
-    TID,
-    TDate
-  > {
-    return new RoleBuilder<TID, TDate>();
-  }
-
-  withName(name: Role): this {
-    this.data.name = name;
-    return this;
-  }
-
-  asAdmin(): this {
-    this.data.admin = true;
-    this.data.member = false;
-    this.data.child = false;
-    this.data.system = false;
-    return this;
-  }
-
-  asMember(): this {
-    this.data.admin = false;
-    this.data.member = true;
-    this.data.child = false;
-    this.data.system = false;
-    return this;
-  }
-
-  asChild(): this {
-    this.data.admin = false;
-    this.data.member = false;
-    this.data.child = true;
-    this.data.system = false;
-    return this;
-  }
-
-  asSystem(): this {
-    this.data.admin = false;
-    this.data.member = false;
-    this.data.child = false;
-    this.data.system = true;
-    return this;
-  }
-
-  build(): Partial<IRoleBase<TID, TDate, Role>> {
-    return { ...this.data };
-  }
-}

package/src/builders/user-builder.ts

@@ -1,81 +0,0 @@
-/**
- * Fluent builder for creating user objects
- */
-
-import type { PlatformID } from '@digitaldefiance/ecies-lib';
-import { AccountStatus } from '../enumerations/account-status';
-import { IUserBase } from '../interfaces/bases/user';
-
-/**
- * Builder for creating user objects with fluent API
- */
-export class UserBuilder<
-  TID extends PlatformID = PlatformID,
-  TDate extends Date | string = Date,
-  TLanguage extends string = string,
-> {
-  private data: Partial<IUserBase<TID, TDate, TLanguage, AccountStatus>> = {
-    emailVerified: false,
-    accountStatus: AccountStatus.Active,
-    directChallenge: false,
-    backupCodes: [],
-    timezone: 'UTC',
-  };
-
-  static create<
-    TID extends PlatformID = PlatformID,
-    TDate extends Date | string = Date,
-    TLanguage extends string = string,
-  >(): UserBuilder<TID, TDate, TLanguage> {
-    return new UserBuilder<TID, TDate, TLanguage>();
-  }
-
-  withUsername(username: string): this {
-    this.data.username = username;
-    return this;
-  }
-
-  withEmail(email: string): this {
-    this.data.email = email;
-    return this;
-  }
-
-  withPublicKey(publicKey: string): this {
-    this.data.publicKey = publicKey;
-    return this;
-  }
-
-  withTimezone(timezone: string): this {
-    this.data.timezone = timezone;
-    return this;
-  }
-
-  withSiteLanguage(siteLanguage: TLanguage): this {
-    this.data.siteLanguage = siteLanguage;
-    return this;
-  }
-
-  withEmailVerified(verified: boolean): this {
-    this.data.emailVerified = verified;
-    return this;
-  }
-
-  withAccountStatus(status: AccountStatus): this {
-    this.data.accountStatus = status;
-    return this;
-  }
-
-  withDirectChallenge(enabled: boolean): this {
-    this.data.directChallenge = enabled;
-    return this;
-  }
-
-  withMnemonicRecovery(recovery: string): this {
-    this.data.mnemonicRecovery = recovery;
-    return this;
-  }
-
-  build(): Partial<IUserBase<TID, TDate, TLanguage, AccountStatus>> {
-    return { ...this.data };
-  }
-}

package/src/constants.ts

@@ -1,229 +0,0 @@
-/**
- * Constants and configuration for the suite-core library.
- * Provides runtime configuration including backup codes, authentication settings,
- * validation rules, and site-specific constants.
- */
-import { ObjectIdProvider } from '@digitaldefiance/ecies-lib';
-import { Role } from './enumerations/role';
-import { IBackupCodeConstants, ICoreConstants } from './interfaces';
-import { IConstants } from './interfaces/constants';
-
-export const BACKUP_CODES: IBackupCodeConstants = Object.freeze({
-  /**
-   * How many backup codes to generate for users
-   */
-  Count: 10 as const,
-  NormalizedHexRegex: /^[a-z0-9]{32}$/, // exactly 32 lowercase alphanumeric chars
-  DisplayRegex: /^([a-z0-9]{4}-){7}[a-z0-9]{4}$/, // xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx
-} as const);
-
-export const CORE: ICoreConstants = Object.freeze({
-  /**
-   * The ID provider to use for generating and parsing IDs
-   */
-  idProvider: new ObjectIdProvider(),
-  /**
-   * Default duration in seconds for which a mnemonic is kept in memory
-   */
-  DefaultExpireMemoryMnemonicSeconds: 300 as const, // 5 minutes
-  /**
-   * Default duration in seconds for which a wallet is kept in memory
-   */
-  DefaultExpireMemoryWalletSeconds: 300 as const, // 5 minutes
-
-  /**
-   * Duration in milliseconds for which a login challenge is valid.
-   */
-  LoginChallengeExpiration: 60000 as const, // 60 seconds
-
-  /**
-   * The expected length of a direct login challenge in bytes
-   */
-  DirectLoginChallengeLength: 104 as const,
-
-  /**
-   * Backup code system configuration
-   */
-  BACKUP_CODES: BACKUP_CODES,
-
-  /**
-   * Duration in milliseconds for which an email token is valid.
-   */
-  EmailTokenExpiration: 86400000 as const, // 24 * 60 * 60 * 1000
-  /**
-   * Length in bytes of the email token generated (is represented as a hex string of twice as many)
-   */
-  EmailTokenLength: 32 as const,
-  /**
-   * Number of rounds for bcrypt hashing. Higher values increase security but also consume more CPU resources.
-   */
-  BcryptRounds: 10 as const,
-  /**
-   * The username of the administrator user.
-   */
-  AdministratorUser: 'admin' as const,
-  /**
-   * The name of the administrator role.
-   */
-  AdministratorRole: Role.Admin as const,
-  /**
-   * The name of the member role.
-   */
-  MemberRole: Role.Member as const,
-  /**
-   * The username of the test user.
-   */
-  MemberUser: 'test' as const,
-  /**
-   * The name of the system role.
-   */
-  SystemRole: Role.System as const,
-  /**
-   * The username of the system user.
-   */
-  SystemUser: 'system' as const,
-  /**
-   * Minimum username length
-   */
-  UsernameMinLength: 3 as const,
-  /**
-   * Maximum username length
-   */
-  UsernameMaxLength: 30 as const,
-  /**
-   * The regular expression for valid usernames.
-   */
-  UsernameRegex: /^[A-Za-z0-9]{3,30}$/,
-  /**
-   * Minimum password length
-   */
-  PasswordMinLength: 8 as const,
-  /**
-   * The regular expression for valid passwords.
-   */
-  PasswordRegex:
-    /^(?=.*[A-Za-z])(?=.*\d)(?=.*[!@#$%^&*()_+\-=[\]{};':"\\|,.<>/?])[A-Za-z\d!@#$%^&*()_+\-=[\]{};':"\\|,.<>/?]{8,}$/,
-  /**
-   * The regular expression for valid JWT tokens.
-   */
-  JwtSecretRegex: /^[0-9a-f]{64}$/i,
-  /**
-   * The regular expression for valid mnemonic phrases.
-   * BIP39 - supports 12, 15, 18, 21, or 24 word mnemonics
-   */
-  MnemonicRegex:
-    /^(?:\w+\s){11}\w+$|^(?:\w+\s){14}\w+$|^(?:\w+\s){17}\w+$|^(?:\w+\s){20}\w+$|^(?:\w+\s){23}\w+$/i,
-  /**
-   * Matches a 64-character hexadecimal string (SHA-256).
-   */
-  MnemonicHmacRegex: /^[a-f0-9]{64}$/,
-  /**
-   * The regular expression for valid encryption keys.
-   */
-  MnemonicEncryptionKeyRegex: /^[a-f0-9]{64}$/,
-  /**
-   * The amount of time in milliseconds after which an email token can be resent.
-   */
-  EmailTokenResendInterval: 300000 as const, // 5 * 60 * 1000 = 5 minutes
-  /**
-   * The interval in minutes after which an email token can be resent.
-   */
-  EmailTokenResendIntervalMinutes: 5 as const,
-  /**
-   * The site name. Overridden by specific site constants.
-   */
-  Site: 'New Site' as const,
-  /**
-   * The site tagline. Overridden by specific site constants.
-   */
-  SiteTagline: 'New Site Tagline' as const,
-  /**
-   * The site description. Overridden by specific site constants.
-   */
-  SiteDescription: 'Description of the new site' as const,
-  /**
-   * Email domain of usernames on the site. Overridden by specific site constants.
-   */
-  SiteEmailDomain: 'localhost' as const,
-  /**
-   * The hostname of the site. Overridden by specific site constants.
-   */
-  SiteHostname: 'localhost' as const,
-} as const);
-
-export const createConstants: (
-  siteDomain: string,
-  siteHostname: string,
-  overrides?: Partial<IConstants>,
-) => IConstants = (
-  siteDomain: string,
-  siteHostname: string,
-  overrides?: Partial<IConstants>,
-) => {
-  return Object.freeze({
-    ...CORE,
-    /**
-     * The email of the administrator user/admin contact
-     */
-    AdministratorEmail: `admin@${siteDomain}` as const,
-    /**
-     * The email of the test user.
-     */
-    MemberEmail: `test@${siteDomain}` as const,
-    /**
-     * The email of the system user.
-     */
-    SystemEmail: `system@${siteDomain}` as const,
-    /**
-     * The email domain of usernames on the site.
-     */
-    SiteEmailDomain: siteDomain,
-    /**
-     * The hostname of the site.
-     */
-    SiteHostname: siteHostname,
-    /**
-     * The color used to indicate success states.
-     */
-    success_color: '#4CAF50',
-    /**
-     * The color used to indicate failure states.
-     */
-    failure_color: '#F44336',
-    /**
-     * The color used to indicate warning states.
-     */
-    warning_color: '#FF9800',
-    /**
-     * The light variant of the primary text color.
-     */
-    primary_text_light: '#ffffff',
-    /**
-     * The dark variant of the primary text color.
-     */
-    primary_text_dark: '#000000',
-    /**
-     * The light variant of the secondary text color.
-     */
-    secondary_text_light: '#ffffff',
-    /**
-     * The dark variant of the secondary text color.
-     */
-    secondary_text_dark: '#000000',
-    /**
-     * The primary brand color (used for primary theme color)
-     */
-    logo_primary_color: '#050505ff',
-    /**
-     * The primary text color (used for logo and text)
-     */
-    logo_primary_text: '#212121',
-    /**
-     * The secondary text color (used for logo and accents)
-     */
-    logo_secondary_text: '#757575',
-    ...(overrides ?? {}),
-  } as const);
-};
-
-export const Constants = createConstants('localhost', 'localhost');

package/src/core/result.ts

@@ -1,40 +0,0 @@
-/**
- * Result type pattern for better error handling
- * Provides type-safe success/failure handling without exceptions
- */
-
-export type Result<T, TError = Error> =
-  | { success: true; data: T }
-  | { success: false; error: TError };
-
-/**
- * Create a successful result
- */
-export function success<T>(data: T): Result<T, never> {
-  return { success: true, data };
-}
-
-/**
- * Create a failed result
- */
-export function failure<E>(error: E): Result<never, E> {
-  return { success: false, error };
-}
-
-/**
- * Check if result is successful
- */
-export function isSuccess<T, E>(
-  result: Result<T, E>,
-): result is { success: true; data: T } {
-  return result.success;
-}
-
-/**
- * Check if result is a failure
- */
-export function isFailure<T, E>(
-  result: Result<T, E>,
-): result is { success: false; error: E } {
-  return !result.success;
-}

package/src/defaults.ts

@@ -1,114 +0,0 @@
-/**
- * Default configuration management for suite-core library.
- * Provides runtime configuration creation, registration, and retrieval with deep cloning and freezing.
- */
-import { createConstants } from './constants';
-import { IConstants } from './interfaces/constants';
-import { DeepPartial } from './interfaces/deep-partial';
-
-export type ConfigurationKey = string | symbol;
-
-const DEFAULT_CONFIGURATION_KEY: ConfigurationKey = Symbol.for(
-  'digitaldefiance.suite-core.defaults.default',
-);
-
-const registry: Map<ConfigurationKey, IConstants> = new Map();
-
-// Define cloneable types to improve type safety
-type Cloneable =
-  | string
-  | number
-  | boolean
-  | null
-  | undefined
-  | Date
-  | RegExp
-  | Cloneable[]
-  | { [key: string]: Cloneable };
-
-function deepClone<T extends Cloneable>(input: T): T {
-  if (input === null || typeof input !== 'object') {
-    return input;
-  }
-
-  if (Array.isArray(input)) {
-    return input.map((item) => deepClone(item)) as T;
-  }
-
-  if (input instanceof RegExp) {
-    return new RegExp(input.source, input.flags) as T;
-  }
-
-  if (input instanceof Date) {
-    return new Date(input.getTime()) as T;
-  }
-
-  const result: Record<string, Cloneable> = {};
-  for (const [key, value] of Object.entries(input)) {
-    result[key] = deepClone(value as Cloneable);
-  }
-  return result as T;
-}
-
-function deepFreeze<T>(obj: T): T {
-  Object.freeze(obj);
-  if (obj && typeof obj === 'object') {
-    Object.getOwnPropertyNames(obj).forEach((prop) => {
-      const value = (obj as Record<string, unknown>)[prop];
-      if (value && typeof value === 'object' && !Object.isFrozen(value)) {
-        deepFreeze(value);
-      }
-    });
-  }
-  return obj;
-}
-
-function applyOverrides<T extends object>(
-  target: T,
-  overrides?: DeepPartial<T>,
-): T {
-  if (!overrides) return target;
-  const result = deepClone(target as Cloneable) as unknown as T;
-  for (const [key, value] of Object.entries(overrides)) {
-    if (value !== undefined && key in result) {
-      (result as Record<string, unknown>)[key] = value;
-    }
-  }
-  return result;
-}
-
-export function createSuiteCoreRuntimeConfiguration(
-  siteDomain: string = 'localhost',
-  siteHostname: string = 'localhost',
-  overrides?: DeepPartial<IConstants>,
-): IConstants {
-  const config = applyOverrides(
-    createConstants(siteDomain, siteHostname),
-    overrides,
-  );
-  return deepFreeze(config);
-}
-
-export function registerSuiteCoreRuntimeConfiguration(
-  key: ConfigurationKey = DEFAULT_CONFIGURATION_KEY,
-  siteDomain: string = 'localhost',
-  siteHostname: string = 'localhost',
-  overrides?: DeepPartial<IConstants>,
-): IConstants {
-  const config = createSuiteCoreRuntimeConfiguration(
-    siteDomain,
-    siteHostname,
-    overrides,
-  );
-  registry.set(key, config);
-  return config;
-}
-
-export function getSuiteCoreRuntimeConfiguration(
-  key: ConfigurationKey = DEFAULT_CONFIGURATION_KEY,
-): IConstants {
-  if (!registry.has(key)) {
-    registry.set(key, createSuiteCoreRuntimeConfiguration());
-  }
-  return registry.get(key)!;
-}

package/src/enumerations/account-status.ts

@@ -1,17 +0,0 @@
-/**
- * Values for the status of an account.
- */
-export enum AccountStatus {
-  /**
-   * The user has not verified their email address
-   */
-  PendingEmailVerification = 'PendingEmailVerification',
-  /**
-   * The user has verified their email address
-   */
-  Active = 'Active',
-  /**
-   * The user has been locked by an admin
-   */
-  AdminLock = 'AdminLock',
-}

package/src/enumerations/email-token-type.ts

@@ -1,27 +0,0 @@
-/**
- * Email token types for various authentication and recovery operations.
- */
-export enum EmailTokenType {
-  /**
-   * A token for verifying an account
-   */
-  AccountVerification = 'AccountVerification',
-  /**
-   * A token for resetting a password
-   */
-  PasswordReset = 'PasswordReset',
-  /**
-   * Requests a login link
-   */
-  LoginRequest = 'LoginRequest',
-  /**
-   * Request encrypted private key blob for a user
-   * (requires username/email)
-   */
-  PrivateKeyRequest = 'PrivateKeyRequest',
-  /**
-   * Request encrypted mnemonic blob for a user
-   * (requires private key)
-   */
-  MnemonicRecoveryRequest = 'MnemonicRecoveryRequest',
-}

package/src/enumerations/fec-error-type.ts

@@ -1,16 +0,0 @@
-/**
- * Forward Error Correction (FEC) error types for data encoding/decoding operations.
- */
-export enum FecErrorType {
-  DataRequired = 'DataRequired',
-  InputDataMustBeUint8Array = 'InputDataMustBeUint8Array',
-  InvalidShardCounts = 'InvalidShardCounts',
-  InvalidShardsAvailableArray = 'InvalidShardsAvailableArray',
-  ParityDataCountMustBePositive = 'ParityDataCountMustBePositive',
-  ParityDataRequired = 'ParityDataRequired',
-  InvalidDataLength = 'InvalidDataLength',
-  ShardSizeExceedsMaximum = 'ShardSizeExceedsMaximum',
-  NotEnoughShardsAvailable = 'NotEnoughShardsAvailable',
-  FecEncodingFailed = 'FecEncodingFailed',
-  FecDecodingFailed = 'FecDecodingFailed',
-}

package/src/enumerations/pbkdf2-error-type.ts

@@ -1,7 +0,0 @@
-/**
- * PBKDF2 error types for password-based key derivation operations.
- */
-export enum Pbkdf2ErrorType {
-  InvalidSaltLength = 'InvalidSaltLength',
-  InvalidHashLength = 'InvalidHashLength',
-}