@digitaldefiance/suite-core-lib 1.1.40 → 1.1.42

package/README.md

@@ -326,6 +326,14 @@ MIT © [Digital Defiance](https://github.com/digitaldefiance)
 
 ## ChangeLog
 
+## V1.1.42: Upgrade to es2022/nx monorepo
+
+  - Upgrade to es2022/nx monorepo
+
+## V1.1.41: Upgrade libs
+
+  - Upgrade libs
+
 ## v1.1.40: Add strings
 
   - Add strings

package/package.json

@@ -1,47 +1,28 @@
 {
   "name": "@digitaldefiance/suite-core-lib",
-  "version": "1.1.40",
+  "version": "1.1.42",
   "description": "Generic user system and document system common core for applications",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "scripts": {
-    "build": "yarn tsc",
-    "test": "yarn jest --detectOpenHandles",
-    "lint": "eslint src/**/*.ts",
-    "lint:fix": "eslint src/**/*.ts --fix",
+    "build": "npx nx build digitaldefiance-suite-core-lib",
+    "test": "npx nx test digitaldefiance-suite-core-lib",
+    "lint": "npx nx lint digitaldefiance-suite-core-lib",
+    "lint:fix": "npx nx lint digitaldefiance-suite-core-lib --fix",
     "prettier:check": "prettier --check 'src/**/*.{ts,tsx}'",
     "prettier:fix": "prettier --write 'src/**/*.{ts,tsx}'",
-    "format": "yarn prettier:fix && yarn lint:fix",
-    "prepublishOnly": "yarn build",
+    "format": "npx nx format:write --projects=digitaldefiance-suite-core-lib",
+    "format:check": "npx nx format:check --projects=digitaldefiance-suite-core-lib",
+    "prepublishOnly": "npx nx build digitaldefiance-suite-core-lib",
     "publish:public": "npm publish --access public"
   },
   "dependencies": {
-    "@digitaldefiance/ecies-lib": "1.1.22",
-    "@digitaldefiance/i18n-lib": "1.3.11",
-    "@digitaldefiance/node-ecies-lib": "1.1.20"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.28.4",
-    "@babel/preset-env": "^7.28.3",
-    "@types/babel__core": "^7",
-    "@types/babel__preset-env": "^7",
-    "@types/jest": "^29.0.0",
-    "@typescript-eslint/eslint-plugin": "^8.31.1",
-    "@typescript-eslint/parser": "^8.31.1",
-    "babel-jest": "^30.1.2",
-    "eslint": "^9.8.0",
-    "eslint-config-prettier": "^10.1.2",
-    "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-prettier": "^5.3.1",
-    "jest": "^29.0.0",
-    "jest-util": "^30.0.5",
-    "prettier": "^2.6.2",
-    "prettier-plugin-organize-imports": "^4.1.0",
-    "ts-jest": "^29.0.0",
-    "typescript": "^5.9.2"
+    "@digitaldefiance/ecies-lib": "1.1.24",
+    "@digitaldefiance/i18n-lib": "1.3.13",
+    "@digitaldefiance/node-ecies-lib": "1.1.22"
   },
   "files": [
-    "dist",
+    "src",
     "README.md"
   ],
   "keywords": [

package/src/backup-code-string.ts

@@ -0,0 +1,84 @@
+import { SecureString } from '@digitaldefiance/ecies-lib';
+import { Constants } from './constants';
+import { InvalidBackupCodeError } from './errors/invalid-backup-code';
+
+export class BackupCodeString extends SecureString {
+  private readonly _normalizedCode: string;
+
+  constructor(code: string) {
+    const normalizedCode = BackupCodeString.normalizeCode(code);
+    if (!Constants.BACKUP_CODES.NormalizedHexRegex.test(normalizedCode)) {
+      throw new InvalidBackupCodeError();
+    }
+    super(normalizedCode);
+    this._normalizedCode = normalizedCode;
+  }
+
+  public override get value(): string {
+    return this.notNullValue;
+  }
+
+  public override get notNullValue(): string {
+    return BackupCodeString.formatBackupCode(this._normalizedCode);
+  }
+
+  public override 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 override get valueAsBase64String(): string {
+    const formattedValue = BackupCodeString.formatBackupCode(
+      this._normalizedCode,
+    );
+    return btoa(formattedValue);
+  }
+
+  public override get valueAsUint8Array(): Uint8Array {
+    const formattedValue = BackupCodeString.formatBackupCode(
+      this._normalizedCode,
+    );
+    return new TextEncoder().encode(formattedValue);
+  }
+
+  /**
+   * 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(): 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/constants.ts

@@ -0,0 +1,150 @@
+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({
+  /**
+   * 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 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).
+   */
+  HmacRegex: /^[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,
+} as const);
+
+export const createConstants: (
+  siteDomain: string,
+  overrides?: Partial<IConstants>,
+) => IConstants = (siteDomain: 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,
+    ...(overrides ?? {}),
+  } as const);
+};
+
+export const Constants = createConstants('localhost');

package/src/defaults.ts

@@ -0,0 +1,73 @@
+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();
+
+function deepClone<T>(input: T): T {
+  if (input === null || typeof input !== 'object') return input;
+  if (Array.isArray(input)) return input.map(deepClone) as unknown as T;
+  if (input instanceof RegExp)
+    return new RegExp(input.source, input.flags) as unknown as T;
+  if (input instanceof Date) return new Date(input.getTime()) as unknown as T;
+  const result: Record<string, unknown> = {};
+  for (const [key, value] of Object.entries(input)) {
+    result[key] = deepClone(value);
+  }
+  return result as T;
+}
+
+function deepFreeze<T>(obj: T): T {
+  Object.freeze(obj);
+  Object.getOwnPropertyNames(obj).forEach((prop) => {
+    const value = (obj as any)[prop];
+    if (value && typeof value === 'object' && !Object.isFrozen(value)) {
+      deepFreeze(value);
+    }
+  });
+  return obj;
+}
+
+function applyOverrides<T>(target: T, overrides?: DeepPartial<T>): T {
+  if (!overrides) return target;
+  const result = deepClone(target);
+  for (const [key, value] of Object.entries(overrides)) {
+    if (value !== undefined) {
+      (result as any)[key] = value;
+    }
+  }
+  return result;
+}
+
+export function createSuiteCoreRuntimeConfiguration(
+  siteDomain: string = 'localhost',
+  overrides?: DeepPartial<IConstants>,
+): IConstants {
+  const config = applyOverrides(createConstants(siteDomain), overrides);
+  return deepFreeze(config);
+}
+
+export function registerSuiteCoreRuntimeConfiguration(
+  key: ConfigurationKey = DEFAULT_CONFIGURATION_KEY,
+  siteDomain: string = 'localhost',
+  overrides?: DeepPartial<IConstants>,
+): IConstants {
+  const config = createSuiteCoreRuntimeConfiguration(siteDomain, 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

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

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

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

@@ -3,5 +3,4 @@ export * from './email-token-type';
 export * from './fec-error-type';
 export * from './role';
 export * from './suite-core-string-key';
-export * from './pbkdf2-error-type';
-//# sourceMappingURL=index.d.ts.map
+export * from './pbkdf2-error-type';

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

@@ -0,0 +1,4 @@
+export enum Pbkdf2ErrorType {
+  InvalidSaltLength = 'InvalidSaltLength',
+  InvalidHashLength = 'InvalidHashLength',
+}

package/src/enumerations/role.ts

@@ -0,0 +1,5 @@
+export enum Role {
+  Admin = 'Admin',
+  Member = 'Member',
+  System = 'System',
+}