@digitaldefiance/suite-core-lib 1.1.41 → 1.1.42

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

@@ -6,4 +6,3 @@ export * from './i18n-setup';
 export * from './interfaces';
 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/{dist/interfaces/bases/index.d.ts → src/interfaces/bases/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/{dist/interfaces/bases/mnemonic.d.ts → src/interfaces/bases/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/{dist/interfaces/bases/used-direct-login-token.d.ts → src/interfaces/bases/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,80 @@
+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 timezone of the user
+   */
+  timezone: string;
+  /**
+   * The language of the site for the user
+   */
+  siteLanguage: S;
+  /**
+   * 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/constants.ts

@@ -0,0 +1,17 @@
+import { IBackupCodeConstants } from './backup-code-consts';
+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;
+}

package/src/interfaces/core-consts.ts

@@ -0,0 +1,109 @@
+import { IBackupCodeConstants } from './backup-code-consts';
+
+export interface ICoreConstants {
+  /**
+   * 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 mnemonic phrases.
+   * BIP39
+   */
+  MnemonicRegex: RegExp;
+  /**
+   * The regular expression for valid HMAC keys.
+   */
+  HmacRegex: 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;
+}

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/{dist/interfaces/dto/email-token.d.ts → src/interfaces/dto/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/{dist/interfaces/dto/index.d.ts → src/interfaces/dto/index.ts}

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

package/{dist/interfaces/dto/mnemonic.d.ts → src/interfaces/dto/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,12 @@
+import { IRoleDTO } from '../dto/role';
+
+export interface IRequestUserDTO {
+  id: string;
+  roles: Array<IRoleDTO>;
+  username: string;
+  email: string;
+  timezone: string;
+  siteLanguage: string;
+  lastLogin?: string;
+  emailVerified: boolean;
+}

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

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

package/{dist/interfaces/dto/token-role.d.ts → src/interfaces/dto/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/{dist/interfaces/dto/user-role.d.ts → src/interfaces/dto/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/{dist/interfaces/dto/user.d.ts → src/interfaces/dto/user.ts}

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

package/src/interfaces/failable-result.ts

@@ -0,0 +1,6 @@
+export interface IFailableResult<T> {
+  success: boolean;
+  data?: T;
+  message?: string;
+  error?: string | Error;
+}

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

@@ -0,0 +1,8 @@
+import { EmailTokenType } from '../../enumerations/email-token-type';
+import { IEmailTokenBase } from '../bases/email-token';
+
+export type IEmailTokenFrontendObject = IEmailTokenBase<
+  string,
+  Date,
+  EmailTokenType
+>;

package/{dist/interfaces/frontend-objects/index.d.ts → src/interfaces/frontend-objects/index.ts}

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

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

@@ -0,0 +1,12 @@
+import { IRoleFrontendObject } from './role';
+
+export interface IRequestUserFrontendObject {
+  id: string;
+  roles: Array<IRoleFrontendObject>;
+  username: string;
+  email: string;
+  timezone: string;
+  siteLanguage: string;
+  lastLogin?: Date;
+  emailVerified: boolean;
+}

package/{dist/interfaces/frontend-objects/role.d.ts → src/interfaces/frontend-objects/role.ts}

@@ -1,4 +1,4 @@
 import { Role } from '../../enumerations/role';
 import { IRoleBase } from '../bases/role';
+
 export type IRoleFrontendObject = IRoleBase<string, Date, Role>;
-//# sourceMappingURL=role.d.ts.map

package/{dist/interfaces/frontend-objects/user-role.d.ts → src/interfaces/frontend-objects/user-role.ts}

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

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

@@ -0,0 +1,9 @@
+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,6 @@
+export interface IHasCreation<D extends Date | string> {
+  /**
+   * The date the object was created.
+   */
+  createdAt: D;
+}

package/src/interfaces/has-creator.ts

@@ -0,0 +1,6 @@
+export interface IHasCreator<I> {
+  /**
+   * The unique identifier for the user who created the object.
+   */
+  createdBy: I;
+}

package/src/interfaces/has-id.ts

@@ -0,0 +1,3 @@
+export interface IHasId<I> {
+  _id: I;
+}

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

@@ -0,0 +1,6 @@
+export interface IHasSoftDelete<D extends Date | string> {
+  /**
+   * The date the object was deleted.
+   */
+  deletedAt?: D;
+}

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

@@ -0,0 +1,6 @@
+export interface IHasSoftDeleter<I> {
+  /**
+   * The unique identifier for the user who deleted the object.
+   */
+  deletedBy?: I;
+}

package/src/interfaces/has-timestamp-owners.ts

@@ -0,0 +1,6 @@
+import { IHasCreator } from './has-creator';
+import { IHasUpdater } from './has-updater';
+
+export interface IHasTimestampOwners<I>
+  extends IHasCreator<I>,
+    IHasUpdater<I> {}

package/src/interfaces/has-timestamps.ts

@@ -0,0 +1,7 @@
+import { IHasCreation } from './has-creation';
+
+export interface IHasTimestamps<D extends Date | string>
+  extends IHasCreation<D> {
+  createdAt: D;
+  updatedAt: D;
+}

package/src/interfaces/has-updater.ts

@@ -0,0 +1,6 @@
+export interface IHasUpdater<I> {
+  /**
+   * The unique identifier for the user who updated the object.
+   */
+  updatedBy: I;
+}

package/src/interfaces/has-updates.ts

@@ -0,0 +1,3 @@
+export interface IHasUpdates<D extends Date | string> {
+  updatedAt: D;
+}

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

@@ -17,5 +17,4 @@ export * from './has-timestamps';
 export * from './has-updater';
 export * from './has-updates';
 export * from './models';
-export * from './token-user';
-//# sourceMappingURL=index.d.ts.map
+export * from './token-user';

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

@@ -1,6 +1,6 @@
 import { IEmailTokenBase } from '../bases/email-token';
+
 /**
  * Front-End Base interface for email token collection documents
  */
 export type IFrontendEmailToken = IEmailTokenBase<string, Date, string>;
-//# sourceMappingURL=email-token.d.ts.map

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

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

package/{dist/interfaces/models/mnemonic.d.ts → src/interfaces/models/mnemonic.ts}

@@ -1,6 +1,6 @@
 import { IMnemonicBase } from '../bases/mnemonic';
+
 /**
  * Represents a front-end mnemonic hash being stored to check for uniqueness
  */
 export type IFrontendMnemonic = IMnemonicBase<string>;
-//# sourceMappingURL=mnemonic.d.ts.map

package/{dist/interfaces/models/role.d.ts → src/interfaces/models/role.ts}

@@ -1,6 +1,6 @@
 import { IRoleBase } from '../bases/role';
+
 /**
  * Front-end Base interface for role collection documents
  */
 export type IFrontendRole = IRoleBase<string, Date>;
-//# sourceMappingURL=role.d.ts.map

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

@@ -1,5 +1,6 @@
 import { Types } from 'mongoose';
 import { ITokenRole } from '../bases';
+
 /**
  * Front-end Base interface for token role collection documents
  */
@@ -8,4 +9,3 @@ export type IFrontendTokenRole = ITokenRole<string, Date>;
  * Back-end Base interface for token role collection documents
  */
 export type IBackendTokenRole = ITokenRole<Types.ObjectId, Date>;
-//# sourceMappingURL=token-role.d.ts.map

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

@@ -1,5 +1,6 @@
 import { Types } from 'mongoose';
 import { IUsedDirectLoginTokenBase } from '../bases/used-direct-login-token';
+
 /**
  * Base interface for front-end used direct login token collection documents
  */
@@ -7,5 +8,5 @@ export type IFrontendUsedDirectLoginToken = IUsedDirectLoginTokenBase<string>;
 /**
  * Base interface for back-end used direct login token collection documents
  */
-export type IBackendUsedDirectLoginToken = IUsedDirectLoginTokenBase<Types.ObjectId>;
-//# sourceMappingURL=used-direct-login-token.d.ts.map
+export type IBackendUsedDirectLoginToken =
+  IUsedDirectLoginTokenBase<Types.ObjectId>;