@digitaldefiance/suite-core-lib 3.6.47 → 3.6.49

package/src/defaults.ts

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

@@ -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,27 @@
+/**
+ * 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

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

@@ -1,7 +1,9 @@
+/**
+ * Enumeration exports for the suite-core library.
+ */
 export * from './account-status';
 export * from './email-token-type';
 export * from './fec-error-type';
 export * from './pbkdf2-error-type';
 export * from './role';
 export * from './suite-core-string-key';
-//# sourceMappingURL=index.d.ts.map

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

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

package/src/enumerations/role.ts

@@ -0,0 +1,8 @@
+/**
+ * User roles within the system.
+ */
+export enum Role {
+  Admin = 'Admin',
+  Member = 'Member',
+  System = 'System',
+}