@digitaldefiance/suite-core-lib 3.6.5 → 3.6.7

package/src/i18n-setup.ts

@@ -0,0 +1,141 @@
+import {
+  I18nEngine,
+  I18nBuilder,
+  LanguageCodes,
+  ComponentConfig,
+  ComponentDefinition,
+  createDefaultLanguages,
+  EngineConfig,
+  CoreLanguageCode,
+} from '@digitaldefiance/i18n-lib';
+import { SuiteCoreStringKey } from './enumerations/suite-core-string-key';
+import { Role } from './enumerations/role';
+import { americanEnglishStrings } from './strings/en-US';
+import { britishEnglishStrings } from './strings/en-GB';
+import { frenchStrings } from './strings/fr';
+import { germanStrings } from './strings/de';
+import { spanishStrings } from './strings/es';
+import { mandarinStrings } from './strings/zh-CN';
+import { japaneseStrings } from './strings/ja';
+import { ukrainianStrings } from './strings/uk';
+
+export const SuiteCoreI18nEngineKey = 'default' as const;
+export const SuiteCoreComponentId = 'suite-core' as const;
+export const SuiteCoreComponent: ComponentDefinition<SuiteCoreStringKey> = {
+  id: SuiteCoreComponentId,
+  name: 'Suite Core Library Component',
+  stringKeys: Object.values(SuiteCoreStringKey),
+};
+export const SuiteCoreComponentStrings: Record<
+  string,
+  Record<SuiteCoreStringKey, string>
+> = {
+  [LanguageCodes.EN_US]: americanEnglishStrings,
+  [LanguageCodes.EN_GB]: britishEnglishStrings,
+  [LanguageCodes.FR]: frenchStrings,
+  [LanguageCodes.DE]: germanStrings,
+  [LanguageCodes.ES]: spanishStrings,
+  [LanguageCodes.ZH_CN]: mandarinStrings,
+  [LanguageCodes.JA]: japaneseStrings,
+  [LanguageCodes.UK]: ukrainianStrings,
+};
+
+const roleTranslations: Record<CoreLanguageCode, Record<Role, string>> = {
+  [LanguageCodes.EN_US]: {
+    [Role.Admin]: 'Administrator',
+    [Role.Member]: 'Member',
+    [Role.System]: 'System',
+  },
+  [LanguageCodes.EN_GB]: {
+    [Role.Admin]: 'Administrator',
+    [Role.Member]: 'Member',
+    [Role.System]: 'System',
+  },
+  [LanguageCodes.FR]: {
+    [Role.Admin]: 'Administrateur',
+    [Role.Member]: 'Membre',
+    [Role.System]: 'Système',
+  },
+  [LanguageCodes.ES]: {
+    [Role.Admin]: 'Administrador',
+    [Role.Member]: 'Miembro',
+    [Role.System]: 'Sistema',
+  },
+  [LanguageCodes.DE]: {
+    [Role.Admin]: 'Administrator',
+    [Role.Member]: 'Mitglied',
+    [Role.System]: 'System',
+  },
+  [LanguageCodes.ZH_CN]: {
+    [Role.Admin]: '管理员',
+    [Role.Member]: '成员',
+    [Role.System]: '系统',
+  },
+  [LanguageCodes.JA]: {
+    [Role.Admin]: '管理者',
+    [Role.Member]: 'メンバー',
+    [Role.System]: 'システム',
+  },
+  [LanguageCodes.UK]: {
+    [Role.Admin]: 'Адміністратор',
+    [Role.Member]: 'Учасник',
+    [Role.System]: 'Система',
+  },
+};
+
+// Suite Core component config
+export function createSuiteCoreComponentConfig(): ComponentConfig {
+  const SuiteCoreComponentConfig: ComponentConfig = {
+    id: SuiteCoreComponentId,
+    strings: SuiteCoreComponentStrings,
+    aliases: ['SuiteCoreStringKey'],
+  };
+  return SuiteCoreComponentConfig;
+}
+
+let _engine: I18nEngine | undefined;
+
+export function getSuiteCoreI18nEngine(config?: EngineConfig): I18nEngine {
+  if (!_engine || !I18nEngine.hasInstance(SuiteCoreI18nEngineKey)) {
+    _engine = I18nEngine.registerIfNotExists(
+      SuiteCoreI18nEngineKey,
+      createDefaultLanguages(),
+      { defaultLanguage: LanguageCodes.EN_US, ...config }
+    );
+    
+    _engine.registerIfNotExists(createSuiteCoreComponentConfig());
+    _engine.registerEnum(Role, roleTranslations, 'Role');
+  }
+  return _engine;
+}
+
+export function getSuiteCoreTranslation(
+  key: SuiteCoreStringKey,
+  variables?: Record<string, any>,
+  language?: string,
+  config?: EngineConfig,
+): string {
+  return getSuiteCoreI18nEngine(config).translate(SuiteCoreComponentId, key, variables, language);
+}
+
+export function resetSuiteCoreI18nEngine(): void {
+  I18nEngine.removeInstance(SuiteCoreI18nEngineKey);
+  _engine = undefined;
+}
+
+export function initSuiteCoreI18nEngine(config?: EngineConfig): I18nEngine {
+  return getSuiteCoreI18nEngine(config);
+}
+
+export function safeGetSuiteCoreTranslation(
+  key: SuiteCoreStringKey,
+  variables?: Record<string, any>,
+  language?: string,
+  config?: EngineConfig,
+): string {
+  try {
+    return getSuiteCoreTranslation(key, variables, language, config);
+  } catch (error) {
+    return key;
+  }
+}

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

@@ -9,4 +9,3 @@ export * from './interfaces';
 export * from './lib';
 export * from './local-storage-manager';
 export * from './defaults';
-//# sourceMappingURL=index.d.ts.map

package/src/interfaces/backup-code-consts.ts

@@ -0,0 +1,15 @@
+export interface IBackupCodeConstants {
+  /**
+   * How many backup codes to generate for users
+   */
+  Count: number;
+  /**
+   * Regex for the backup codes
+   * 32 lowercase alphanumeric character string (a-z0-9)
+   */
+  NormalizedHexRegex: RegExp;
+  /**
+   * Regex for the display format of the backup codes
+   */
+  DisplayRegex: RegExp; // xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx
+}

package/src/interfaces/backup-code.ts

@@ -0,0 +1,6 @@
+export interface IBackupCode {
+  version: string;
+  checksumSalt: string;
+  checksum: string;
+  encrypted: string;
+}

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

@@ -0,0 +1,38 @@
+import { EmailTokenType } from '../../enumerations/email-token-type';
+import { IHasId } from '../has-id';
+import { IHasTimestamps } from '../has-timestamps';
+
+/**
+ * Base interface for email token collection documents
+ */
+export interface IEmailTokenBase<
+  I,
+  D extends Date | string,
+  E extends EmailTokenType | string,
+> extends IHasId<I>,
+    IHasTimestamps<D> {
+  /**
+   * The user ID associated with the token
+   */
+  userId: I;
+  /**
+   * The type of token
+   */
+  type: E;
+  /**
+   * The token value
+   */
+  token: string;
+  /**
+   * The email address the token was sent to
+   */
+  email: string;
+  /**
+   * The date the token was last sent
+   */
+  lastSent?: D;
+  /**
+   * The date the token expires
+   */
+  expiresAt: D;
+}

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

@@ -5,4 +5,3 @@ export * from './token-role';
 export * from './used-direct-login-token';
 export * from './user';
 export * from './user-role';
-//# sourceMappingURL=index.d.ts.map

package/src/interfaces/bases/{mnemonic.d.ts → mnemonic.ts}

@@ -1,11 +1,11 @@
 import { IHasId } from '../has-id';
+
 /**
  * Represents a mnemonic hash being stored to check for uniqueness
  */
 export interface IMnemonicBase<I> extends IHasId<I> {
-    /**
-     * A non-reversible HMAC of the mnemonic, used for uniqueness checks.
-     */
-    hmac: string;
+  /**
+   * A non-reversible HMAC of the mnemonic, used for uniqueness checks.
+   */
+  hmac: string;
 }
-//# sourceMappingURL=mnemonic.d.ts.map

package/src/interfaces/bases/role.ts

@@ -0,0 +1,40 @@
+import { Role } from '../../enumerations/role';
+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';
+
+export interface IRoleBase<
+  I,
+  D extends Date | string = Date,
+  R extends Role | string = Role,
+> extends IHasId<I>,
+    IHasTimestamps<D>,
+    IHasTimestampOwners<I>,
+    IHasSoftDelete<D>,
+    IHasSoftDeleter<I> {
+  /**
+   * The name of the role
+   */
+  name: R;
+  /**
+   * Whether the role is an admin
+   */
+  admin: boolean;
+  /**
+   * Whether the role is a site member
+   * Must not specify admin or system
+   */
+  member: boolean;
+  /**
+   * Whether the role is a restricted child account
+   * This prevents the account from certain actions
+   * Must not specify admin, member,
+   */
+  child: boolean;
+  /**
+   * Whether the role is a system account
+   */
+  system: boolean;
+}

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

@@ -0,0 +1,9 @@
+import { IRoleBase } from './role';
+
+export interface ITokenRole<I, D extends Date | string = Date>
+  extends IRoleBase<I, D> {
+  /**
+   * The translated name of the role
+   */
+  translatedName: string;
+}

package/src/interfaces/bases/{used-direct-login-token.d.ts → used-direct-login-token.ts}

@@ -1,6 +1,6 @@
 import { IHasId } from '../has-id';
+
 export interface IUsedDirectLoginTokenBase<I> extends IHasId<I> {
-    userId: I;
-    token: string;
+  userId: I;
+  token: string;
 }
-//# sourceMappingURL=used-direct-login-token.d.ts.map

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

@@ -0,0 +1,21 @@
+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';
+
+export interface IUserRoleBase<I, D extends Date | string>
+  extends IHasId<I>,
+    IHasTimestamps<D>,
+    IHasTimestampOwners<I>,
+    IHasSoftDelete<D>,
+    IHasSoftDeleter<I> {
+  /**
+   * The user ID
+   */
+  userId: I;
+  /**
+   * The role ID
+   */
+  roleId: I;
+}

package/src/interfaces/bases/user.ts

@@ -0,0 +1,88 @@
+import { AccountStatus } from '../../enumerations/account-status';
+import { IBackupCode } from '../backup-code';
+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';
+
+/**
+ * Base interface for user collection documents
+ */
+export interface IUserBase<
+  I,
+  D extends Date | string,
+  S extends string,
+  A extends AccountStatus | string,
+> extends IHasId<I>,
+    IHasTimestamps<D>,
+    IHasTimestampOwners<I>,
+    IHasSoftDelete<D>,
+    IHasSoftDeleter<I> {
+  /**
+   * The username of the user
+   */
+  username: string;
+  /**
+   * The email address of the user
+   */
+  email: string;
+  /**
+   * The public key for the user
+   */
+  publicKey: string;
+  /**
+   * The currency preference of the user
+   */
+  currency: string;
+  /**
+   * The timezone of the user
+   */
+  timezone: string;
+  /**
+   * The language of the site for the user
+   */
+  siteLanguage: S;
+  /**
+   * Whether the user prefers dark mode
+   */
+  darkMode: boolean;
+  /**
+   * The date the user last logged in
+   */
+  lastLogin?: D;
+  /**
+   * Whether the user has verified their email address
+   */
+  emailVerified: boolean;
+  /**
+   * The status of the user's account, eg 'AdminLock'
+   */
+  accountStatus: A;
+  /**
+   * Reference to the mnemonic document
+   */
+  mnemonicId?: I;
+  /**
+   * Whether the user has enabled direct challenge
+   */
+  directChallenge: boolean;
+  /**
+   * Password-wrapped ECIES private key
+   */
+  passwordWrappedPrivateKey?: {
+    salt: string;
+    iv: string;
+    authTag: string;
+    ciphertext: string;
+    iterations: number;
+  };
+  /**
+   * Array of backup codes to recover mnemonic/private key
+   */
+  backupCodes: Array<IBackupCode>;
+  /**
+   * Copy of the mnemonic encrypted with the user's public key
+   */
+  mnemonicRecovery: string;
+}

package/src/interfaces/combined-role-privileges.ts

@@ -0,0 +1,6 @@
+export interface ICombinedRolePrivileges {
+  admin: boolean;
+  member: boolean;
+  child: boolean;
+  system: boolean;
+}

package/src/interfaces/constants.ts

@@ -0,0 +1,56 @@
+import { ICoreConstants } from './core-consts';
+
+export interface IConstants extends ICoreConstants {
+  /**
+   * The email of the administrator user/admin contact
+   */
+  AdministratorEmail: string;
+  /**
+   * The email of the test user.
+   */
+  MemberEmail: string;
+  /**
+   * The email of the system user.
+   */
+  SystemEmail: string;
+  /**
+   * The primary brand color (used for primary theme color)
+   */
+  logo_primary_color: string;
+  /**
+   * The primary text color (used for logo and text)
+   */
+  logo_primary_text: string;
+  /**
+   * The secondary text color (used for logo and accents)
+   */
+  logo_secondary_text: string;
+  /**
+   * The color used to indicate success states.
+   */
+  success_color: string;
+  /**
+   * The color used to indicate warning states.
+   */
+  warning_color: string;
+  /**
+   * The color used to indicate failure states.
+   */
+  failure_color: string;
+  /**
+   * The light variant of the primary text color.
+   */
+  primary_text_light: string;
+  /**
+   * The dark variant of the primary text color.
+   */
+  primary_text_dark: string;
+  /**
+   * The light variant of the secondary text color.
+   */
+  secondary_text_light: string;
+  /**
+   * The dark variant of the secondary text color.
+   */
+  secondary_text_dark: string;
+}

package/src/interfaces/core-consts.ts

@@ -0,0 +1,130 @@
+import { IIdProvider } from '@digitaldefiance/ecies-lib';
+import { IBackupCodeConstants } from './backup-code-consts';
+
+export interface ICoreConstants {
+  /**
+   * The ID provider to use for generating and parsing IDs
+   */
+  idProvider: IIdProvider;
+  /**
+   * 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,3 @@
+export type DeepPartial<T> = {
+  [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};

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

@@ -1,3 +1,3 @@
 import { IEmailTokenBase } from '../bases/email-token';
+
 export type IEmailTokenDTO = IEmailTokenBase<string, string, string>;
-//# sourceMappingURL=email-token.d.ts.map

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

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

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

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

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

@@ -0,0 +1,19 @@
+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.d.ts → role.ts}

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

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

@@ -4,7 +4,13 @@ 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;
+
+export interface ITokenRoleDTO
+  extends IRoleDTO,
+    IHasId<string>,
+    IHasTimestamps<string>,
+    IHasTimestampOwners<string>,
+    IHasSoftDelete<string>,
+    IHasSoftDeleter<string> {
+  translatedName?: string;
 }
-//# sourceMappingURL=token-role.d.ts.map

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

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

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

@@ -5,5 +5,4 @@ export interface IUserSettingsDTO {
     siteLanguage: string;
     darkMode: boolean;
     directChallenge: boolean;
-}
-//# sourceMappingURL=user-settings.d.ts.map
+}