@digitaldefiance/suite-core-lib 3.6.46 → 3.6.48

package/src/interfaces/core-consts.ts

@@ -0,0 +1,133 @@
+/**
+ * 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/deep-partial.ts

@@ -0,0 +1,6 @@
+/**
+ * Utility type for making all properties of an object optional recursively.
+ */
+export type DeepPartial<T> = {
+  [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};

package/src/interfaces/dto/email-token.ts

@@ -0,0 +1,7 @@
+/**
+ * Email token Data Transfer Object (DTO) type.
+ * Plain string-based representation of email token data for serialization and API transfer.
+ */
+import { IEmailTokenBase } from '../bases/email-token';
+
+export type IEmailTokenDTO = IEmailTokenBase<string, string, string>;

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

@@ -1,3 +1,6 @@
+/**
+ * Data Transfer Object (DTO) interface exports.
+ */
 export * from './email-token';
 export * from './mnemonic';
 export * from './request-user';
@@ -6,4 +9,3 @@ export * from './token-role';
 export * from './user';
 export * from './user-role';
 export * from './user-settings';
-//# sourceMappingURL=index.d.ts.map

package/src/interfaces/dto/mnemonic.ts

@@ -0,0 +1,7 @@
+/**
+ * Mnemonic Data Transfer Object (DTO) type.
+ * Plain string-based representation of mnemonic data for serialization and API transfer.
+ */
+import { IMnemonicBase } from '../bases';
+
+export type IMnemonicDTO = IMnemonicBase<string>;

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

@@ -0,0 +1,23 @@
+/**
+ * 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/role.ts

@@ -0,0 +1,7 @@
+/**
+ * Role Data Transfer Object (DTO) type.
+ * Plain string-based representation of role data for serialization and API transfer.
+ */
+import { IRoleBase } from '../bases/role';
+
+export type IRoleDTO = IRoleBase<string, string, string>;

package/src/interfaces/dto/token-role.ts

@@ -0,0 +1,21 @@
+/**
+ * Token role Data Transfer Object (DTO) interface.
+ * Extended role DTO with optional translated name for JWT token payloads.
+ */
+import { IHasId } from '../has-id';
+import { IHasSoftDelete } from '../has-soft-delete';
+import { IHasSoftDeleter } from '../has-soft-deleter';
+import { IHasTimestampOwners } from '../has-timestamp-owners';
+import { IHasTimestamps } from '../has-timestamps';
+import { IRoleDTO } from './role';
+
+export interface ITokenRoleDTO
+  extends
+    IRoleDTO,
+    IHasId<string>,
+    IHasTimestamps<string>,
+    IHasTimestampOwners<string>,
+    IHasSoftDelete<string>,
+    IHasSoftDeleter<string> {
+  translatedName?: string;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * User-role relationship Data Transfer Object (DTO) type.
+ * Plain string-based representation of user-role associations for serialization and API transfer.
+ */
+import { IUserRoleBase } from '../bases/user-role';
+
+export type IUserRoleDTO = IUserRoleBase<string, string>;

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

@@ -0,0 +1,12 @@
+/**
+ * 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/dto/user.ts

@@ -0,0 +1,7 @@
+/**
+ * User Data Transfer Object (DTO) type.
+ * Plain string-based representation of user data for serialization and API transfer.
+ */
+import { IUserBase } from '../bases/user';
+
+export type IUserDTO = IUserBase<string, string, string, string>;

package/src/interfaces/failable-result.ts

@@ -0,0 +1,9 @@
+/**
+ * Result type for operations that can succeed or fail with optional data and error information.
+ */
+export interface IFailableResult<T> {
+  success: boolean;
+  data?: T;
+  message?: string;
+  error?: string | Error;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * Email token frontend object type.
+ * Client-side representation of email token data with Date objects and typed enums.
+ */
+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}

@@ -1,6 +1,8 @@
+/**
+ * Frontend object interface exports for client-side use.
+ */
 export * from './email-token';
 export * from './request-user';
 export * from './role';
 export * from './user';
 export * from './user-role';
-//# sourceMappingURL=index.d.ts.map

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

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

@@ -1,4 +1,8 @@
+/**
+ * Role frontend object type.
+ * Client-side representation of role data with Date objects and typed enums.
+ */
 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.ts

@@ -0,0 +1,7 @@
+/**
+ * User-role relationship frontend object type.
+ * Client-side representation of user-role associations with Date objects.
+ */
+import { IUserRoleBase } from '../bases/user-role';
+
+export type IUserRoleFrontendObject = IUserRoleBase<string, Date>;

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

@@ -0,0 +1,13 @@
+/**
+ * User frontend object type.
+ * Client-side representation of user data with Date objects and typed enums.
+ */
+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,9 @@
+/**
+ * Interface for objects with a creation timestamp.
+ */
+export interface IHasCreation<TDate extends Date | string> {
+  /**
+   * The date the object was created.
+   */
+  createdAt: TDate;
+}

package/src/interfaces/has-creator.ts

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

@@ -0,0 +1,8 @@
+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-delete.ts

@@ -0,0 +1,9 @@
+/**
+ * Interface for objects with soft delete capability (deletion timestamp).
+ */
+export interface IHasSoftDelete<TDate extends Date | string> {
+  /**
+   * The date the object was deleted.
+   */
+  deletedAt?: TDate;
+}

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

@@ -0,0 +1,11 @@
+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-timestamp-owners.ts

@@ -0,0 +1,9 @@
+/**
+ * Interface combining creator and updater tracking.
+ */
+import type { PlatformID } from '@digitaldefiance/ecies-lib';
+import { IHasCreator } from './has-creator';
+import { IHasUpdater } from './has-updater';
+
+export interface IHasTimestampOwners<TID extends PlatformID>
+  extends IHasCreator<TID>, IHasUpdater<TID> {}

package/src/interfaces/has-timestamps.ts

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

@@ -0,0 +1,11 @@
+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/interfaces/has-updates.ts

@@ -0,0 +1,6 @@
+/**
+ * Interface for objects with an update timestamp.
+ */
+export interface IHasUpdates<TDate extends Date | string> {
+  updatedAt: TDate;
+}

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

@@ -1,3 +1,6 @@
+/**
+ * Interface exports for the suite-core library.
+ */
 export * from './backup-code';
 export * from './backup-code-consts';
 export * from './bases';
@@ -20,4 +23,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,7 @@
+/**
+ * Simple success message interface with boolean flag and message text.
+ */
+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.ts

@@ -0,0 +1,14 @@
+/**
+ * User settings interface with typed email, timezone, and currency.
+ */
+import { EmailString } from '@digitaldefiance/ecies-lib';
+import { CurrencyCode, Timezone } from '@digitaldefiance/i18n-lib';
+
+export interface IUserSettings {
+  email: EmailString;
+  timezone: Timezone;
+  currency: CurrencyCode;
+  siteLanguage: string;
+  darkMode: boolean;
+  directChallenge: boolean;
+}