@digitaldefiance/suite-core-lib 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Digital Defiance
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,296 @@
+# @digitaldefiance/suite-core-lib
+
+[![npm version](https://badge.fury.io/js/%40digitaldefiance%2Fsuite-core-lib.svg)](https://badge.fury.io/js/%40digitaldefiance%2Fsuite-core-lib)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
+
+A library that provides higher-level primitives for the cornerstone of a comprehensive, cryptographically-secure user management system and node express server with service framework built with **@digitaldefiance/ecies-lib** and **@digitaldefiance/node-ecies-lib** encryption. This library serves as the foundational building blocks for the **node-ecies** project and **node-express-suite** packages, which together form a complete full-stack framework ecosystem.
+
+## 🚀 Framework Ecosystem
+
+`@digitaldefiance/suiite-core-lib` provides the **core primitives and abstractions** that power:
+
+- user accounts and authentication
+- user to user and user to server encryption
+- zero-knowledge proof authentication
+- role-based access control (RBAC)
+- multi-language internationalization (i18n)
+
+## 📦 Installation
+
+```bash
+npm install @digitaldefiance/suiite-core-lib
+# or
+yarn add @digitaldefiance/suiite-core-lib
+```
+
+## 🌍 Internationalization
+
+Built-in support for **5 languages** with the new plugin-based i18n architecture:
+
+- **English** (US/UK)
+- **French**
+- **Spanish**
+- **Mandarin Chinese**
+- **Ukrainian**
+
+All error messages, validation text, and user-facing strings are fully localized and extensible.
+
+## 🏗️ Architecture Overview
+
+### Type-Safe Interfaces
+
+```typescript
+import { 
+  IFrontendUser, 
+  IBackendUser, 
+  AccountStatus, 
+  Role,
+  CoreLanguage 
+} from '@digitaldefiance/suiite-core-lib';
+
+// Frontend-optimized user interface (string IDs)
+interface AppUser extends IFrontendUser<'en'> {
+  _id: string;
+  siteLanguage: 'en';
+  accountStatus: AccountStatus;
+}
+
+// Backend database interface (ObjectId support)  
+interface DatabaseUser extends IBackendUser<'en'> {
+  _id: Types.ObjectId;
+  createdBy: Types.ObjectId;
+  updatedBy: Types.ObjectId;
+}
+```
+
+### Secure Backup Code System
+
+```typescript
+import { BackupCodeString, Constants } from '@digitaldefiance/suiite-core-lib';
+
+// Generate cryptographically secure backup codes
+const backupCodes = BackupCodeString.generateBackupCodes();
+console.log(backupCodes.length); // 10 (configurable via Constants.BACKUP_CODES.Count)
+
+// Each code is formatted for user display
+const code = new BackupCodeString('deadbeefcafebabefeedface01234567');
+console.log(code.value); // "dead-beef-cafe-babe-feed-face-0123-4567"
+
+// Multiple secure encoding formats
+console.log(code.valueAsHexString);    // Hex-encoded UTF-8 bytes
+console.log(code.valueAsBase64String); // Base64-encoded 
+console.log(code.valueAsUint8Array);   // Raw byte array
+```
+
+### Localized Error Handling
+
+```typescript
+import { 
+  UserNotFoundError, 
+  UsernameInUseError, 
+  AccountLockedError,
+  CoreLanguage 
+} from '@digitaldefiance/suiite-core-lib';
+
+// Errors with automatic localization
+throw new UserNotFoundError(CoreLanguage.French);
+// "Compte utilisateur introuvable"
+
+throw new UsernameInUseError(CoreLanguage.Spanish); 
+// "El nombre de usuario ya está en uso"
+
+throw new AccountLockedError(CoreLanguage.German);
+// "Konto ist von einem Administrator gesperrt"
+```
+
+## 🎯 How Frameworks Use These Primitives
+
+The **@digitaldefiance/node-express-suite** package builds upon these primitives to create full framework components:
+
+### Express.js Framework Usage
+
+```typescript
+// node-express-suite uses these primitives internally
+import { 
+  IFrontendUser, 
+  AccountStatus, 
+  BackupCodeString,
+  UserNotFoundError,
+  CoreLanguage 
+} from '@digitaldefiance/suiite-core-lib';
+
+// Framework middleware validates using our primitives
+function validateBackupCode(userInput: string, storedCodes: IBackupCode[]) {
+  try {
+    const inputCode = new BackupCodeString(userInput);
+    return storedCodes.some(stored => 
+      BackupCodeString.normalizeCode(inputCode.value) === stored.encrypted
+    );
+  } catch (error) {
+    if (error instanceof InvalidBackupCodeError) {
+      // Framework handles localized error response
+      return false;
+    }
+    throw error;
+  }
+}
+```
+
+### Frontend Framework Integration
+
+```typescript
+// Frontend frameworks consume our type-safe interfaces
+import { IFrontendUser, AccountStatus } from '@digitaldefiance/suiite-core-lib';
+
+// React/Vue/Angular components use our interfaces
+interface UserProfileProps {
+  user: IFrontendUser<'en' | 'fr' | 'es'>;
+  onStatusChange: (status: AccountStatus) => void;
+}
+
+// Type safety ensures consistent data flow
+function updateUserStatus(user: IFrontendUser<string>, status: AccountStatus) {
+  return {
+    ...user,
+    accountStatus: status,
+    updatedAt: new Date().toISOString()
+  };
+}
+```
+
+### Database Layer Integration
+
+```typescript
+// node-express-suite database layers use our models
+import { IBackendUser, IUserRoleBase } from '@digitaldefiance/suiite-core-lib';
+import { Types } from 'mongoose';
+
+// Framework database schemas implement our interfaces
+const userSchema = new mongoose.Schema<IBackendUser<'en'>>({
+  _id: { type: Types.ObjectId, required: true },
+  username: { type: String, required: true, unique: true },
+  email: { type: String, required: true, unique: true },
+  accountStatus: { 
+    type: String, 
+    enum: Object.values(AccountStatus),
+    default: AccountStatus.PendingEmailVerification 
+  },
+  // ... rest of the schema matches our interface
+});
+```
+
+## 🔧 Advanced Configuration
+
+### Custom Model Extensions
+
+```typescript
+import { BaseModelName, ExtendedModelName } from '@digitaldefiance/suite-core-lib';
+
+// Extend the base models for your application
+enum CustomModels {
+  Organization = 'Organization',
+  Subscription = 'Subscription',
+  AuditLog = 'AuditLog'
+}
+
+type AppModelName = ExtendedModelName<typeof CustomModels>;
+// Includes: User, Role, EmailToken, Mnemonic, UserRole, Organization, Subscription, AuditLog
+```
+
+### Email Token Types
+
+```typescript
+import { EmailTokenType } from '@digitaldefiance/suiite-core-lib';
+
+// Built-in token types for common workflows
+const tokenTypes = [
+  EmailTokenType.AccountVerification,    // Email confirmation
+  EmailTokenType.PasswordReset,          // Password reset flow  
+  EmailTokenType.LoginRequest,           // Passwordless login
+  EmailTokenType.PrivateKeyRequest,      // Key recovery
+  EmailTokenType.MnemonicRecoveryRequest // Mnemonic recovery
+];
+```
+
+### Account Status Management
+
+```typescript
+import { AccountStatus } from '@digitaldefiance/suiite-core-lib';
+
+// Granular account state control
+switch (user.accountStatus) {
+  case AccountStatus.PendingEmailVerification:
+    // Send verification email
+    break;
+  case AccountStatus.Active:
+    // Full access granted
+    break;
+  case AccountStatus.AdminLock:
+    // Requires admin intervention
+    break;
+}
+```
+
+### Framework Integration (Built by Other Projects)
+
+The **@digitaldefiance/node-ecies** and **@digitaldefiance/node-express-suite** packages use these primitives to build:
+
+- **Complete Express.js framework** with middleware, routes, and database integration
+- **Frontend framework adapters** for React, Vue, Angular, and Svelte
+- **Mobile and desktop SDKs** for React Native, Flutter, Electron, and Tauri
+- **DevOps and deployment tools** with Docker, Kubernetes, and CI/CD integration
+
+## 🧪 Testing & Quality
+
+```bash
+# Run the comprehensive test suite
+yarn test
+
+# 104 tests covering:
+# ✅ Type safety and interface validation
+# ✅ Cryptographic security functions  
+# ✅ Multi-language localization
+# ✅ Error handling and edge cases
+# ✅ Integration scenarios
+# ✅ Performance benchmarks
+```
+
+## 🤝 Contributing
+
+We welcome contributions to help build the future of secure user management! Areas where we need help:
+
+- **Frontend component libraries** for popular frameworks
+- **Additional language translations** and localization
+- **Performance optimizations** and benchmarking
+- **Documentation** and example applications
+- **Security auditing** and penetration testing
+
+## 📄 License
+
+MIT © [Digital Defiance](https://github.com/digitaldefiance)
+
+## 🔗 Ecosystem Projects
+
+### Foundation Libraries (This Package Uses)
+
+- [`@digitaldefiance/ecies-lib`](https://www.npmjs.com/package/@digitaldefiance/ecies-lib) - ECIES encryption foundation
+- [`@digitaldefiance/i18n-lib`](https://www.npmjs.com/package/@digitaldefiance/i18n-lib) - Plugin-based internationalization
+- [`@digitaldefiance/node-ecies-lib`](https://www.npmjs.com/package/@digitaldefiance/node-ecies-lib) - Node.js crypto utilities
+
+### Framework Projects (That Use This Package)
+
+- **i18n-lib** - Internationalization framework with plugin support
+- **node-ecies** - Cryptographic framework and security protocols
+- **node-express-suite** - Complete Express.js framework with authentication, database integration, and API generation
+
+---
+
+**Building user management primitives?** Start with `@digitaldefiance/suite-core-lib` for type-safe, secure, and internationalized user system foundations. For complete frameworks, check out the **node-ecies** and **node-express-suite** projects! 🚀
+
+## ChangeLog
+
+## v1.0.0: Initial release of user system package
+
+- Sun Oct 12 2025 13:26:37 GMT-0700 (Pacific Daylight Time)
+  - Initial release of `@digitaldefiance/suite-core-lib` with core user management primitives, type-safe interfaces, secure backup code system, localized error handling, and multi-language support.

package/dist/backup-code-string.d.ts

@@ -0,0 +1,26 @@
+import { SecureString } from '@digitaldefiance/ecies-lib';
+export declare class BackupCodeString extends SecureString {
+    private readonly _normalizedCode;
+    constructor(code: string);
+    get value(): string;
+    get notNullValue(): string;
+    get valueAsHexString(): string;
+    get valueAsBase64String(): string;
+    get valueAsUint8Array(): Uint8Array;
+    /**
+     * Format a 32-char normalized code into display form (8 groups of 4).
+     * Does not restrict characters beyond grouping.
+     */
+    static formatBackupCode(code: string): string;
+    /**
+     * Normalize user-entered code: remove spaces and hyphens, lowercase, and trim.
+     */
+    static normalizeCode(input: string): string;
+    static generateBackupCode(): string;
+    /**
+     * Generate the configured number of backup codes.
+     * Note: If generation alphabet/length is controlled elsewhere, prefer that path.
+     */
+    static generateBackupCodes(): Array<BackupCodeString>;
+}
+//# sourceMappingURL=backup-code-string.d.ts.map

package/dist/backup-code-string.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"backup-code-string.d.ts","sourceRoot":"","sources":["../src/backup-code-string.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAI1D,qBAAa,gBAAiB,SAAQ,YAAY;IAChD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;gBAE7B,IAAI,EAAE,MAAM;IASxB,IAAoB,KAAK,IAAI,MAAM,CAElC;IAED,IAAoB,YAAY,IAAI,MAAM,CAEzC;IAED,IAAoB,gBAAgB,IAAI,MAAM,CAO7C;IAED,IAAoB,mBAAmB,IAAI,MAAM,CAKhD;IAED,IAAoB,iBAAiB,IAAI,UAAU,CAKlD;IAED;;;OAGG;WACW,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAIpD;;OAEG;WACW,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;WAIpC,kBAAkB,IAAI,MAAM;IAU1C;;;OAGG;WACW,mBAAmB,IAAI,KAAK,CAAC,gBAAgB,CAAC;CAO7D"}

package/dist/backup-code-string.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BackupCodeString = void 0;
+const ecies_lib_1 = require("@digitaldefiance/ecies-lib");
+const constants_1 = require("./constants");
+const invalid_backup_code_1 = require("./errors/invalid-backup-code");
+class BackupCodeString extends ecies_lib_1.SecureString {
+    constructor(code) {
+        const normalizedCode = BackupCodeString.normalizeCode(code);
+        if (!constants_1.Constants.BACKUP_CODES.NormalizedHexRegex.test(normalizedCode)) {
+            throw new invalid_backup_code_1.InvalidBackupCodeError();
+        }
+        super(normalizedCode);
+        this._normalizedCode = normalizedCode;
+    }
+    get value() {
+        return this.notNullValue;
+    }
+    get notNullValue() {
+        return BackupCodeString.formatBackupCode(this._normalizedCode);
+    }
+    get valueAsHexString() {
+        const formattedValue = BackupCodeString.formatBackupCode(this._normalizedCode);
+        return new TextEncoder().encode(formattedValue).reduce((str, byte) => {
+            return str + byte.toString(16).padStart(2, '0');
+        }, '');
+    }
+    get valueAsBase64String() {
+        const formattedValue = BackupCodeString.formatBackupCode(this._normalizedCode);
+        return btoa(formattedValue);
+    }
+    get valueAsUint8Array() {
+        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.
+     */
+    static formatBackupCode(code) {
+        const groups = code.match(/.{1,4}/g) ?? [code];
+        return groups.join('-');
+    }
+    /**
+     * Normalize user-entered code: remove spaces and hyphens, lowercase, and trim.
+     */
+    static normalizeCode(input) {
+        return input.replace(/[\s-]/g, '').toLowerCase().trim();
+    }
+    static generateBackupCode() {
+        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.
+     */
+    static generateBackupCodes() {
+        const codes = [];
+        for (let i = 0; i < constants_1.Constants.BACKUP_CODES.Count; i++) {
+            codes.push(new BackupCodeString(BackupCodeString.generateBackupCode()));
+        }
+        return codes;
+    }
+}
+exports.BackupCodeString = BackupCodeString;
+//# sourceMappingURL=backup-code-string.js.map

package/dist/backup-code-string.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"backup-code-string.js","sourceRoot":"","sources":["../src/backup-code-string.ts"],"names":[],"mappings":";;;AAAA,0DAA0D;AAC1D,2CAAwC;AACxC,sEAAsE;AAEtE,MAAa,gBAAiB,SAAQ,wBAAY;IAGhD,YAAY,IAAY;QACtB,MAAM,cAAc,GAAG,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC5D,IAAI,CAAC,qBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;YACpE,MAAM,IAAI,4CAAsB,EAAE,CAAC;QACrC,CAAC;QACD,KAAK,CAAC,cAAc,CAAC,CAAC;QACtB,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;IACxC,CAAC;IAED,IAAoB,KAAK;QACvB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAoB,YAAY;QAC9B,OAAO,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACjE,CAAC;IAED,IAAoB,gBAAgB;QAClC,MAAM,cAAc,GAAG,gBAAgB,CAAC,gBAAgB,CACtD,IAAI,CAAC,eAAe,CACrB,CAAC;QACF,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACnE,OAAO,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QAClD,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;IAED,IAAoB,mBAAmB;QACrC,MAAM,cAAc,GAAG,gBAAgB,CAAC,gBAAgB,CACtD,IAAI,CAAC,eAAe,CACrB,CAAC;QACF,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC;IAC9B,CAAC;IAED,IAAoB,iBAAiB;QACnC,MAAM,cAAc,GAAG,gBAAgB,CAAC,gBAAgB,CACtD,IAAI,CAAC,eAAe,CACrB,CAAC;QACF,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,gBAAgB,CAAC,IAAY;QACzC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IACD;;OAEG;IACI,MAAM,CAAC,aAAa,CAAC,KAAa;QACvC,OAAO,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;IAC1D,CAAC;IAEM,MAAM,CAAC,kBAAkB;QAC9B,MAAM,QAAQ,GAAG,sCAAsC,CAAC;QACxD,MAAM,GAAG,GAAG,MAAM,CAAC,eAAe,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QACvD,IAAI,GAAG,GAAG,EAAE,CAAC;QACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5B,GAAG,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,mBAAmB;QAC/B,MAAM,KAAK,GAA4B,EAAE,CAAC;QAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,qBAAS,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;YACtD,KAAK,CAAC,IAAI,CAAC,IAAI,gBAAgB,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC;QAC1E,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA/ED,4CA+EC"}

package/dist/constants.d.ts

@@ -0,0 +1,5 @@
+import { IBackupCodeConstants } from './interfaces';
+import { IConstants } from './interfaces/constants';
+export declare const BACKUP_CODES: IBackupCodeConstants;
+export declare const Constants: IConstants;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEpD,eAAO,MAAM,YAAY,EAAE,oBAOjB,CAAC;AAEX,eAAO,MAAM,SAAS,EAAE,UAEvB,CAAC"}

package/dist/constants.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Constants = exports.BACKUP_CODES = void 0;
+exports.BACKUP_CODES = {
+    /**
+     * How many backup codes to generate for users
+     */
+    Count: 10,
+    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
+};
+exports.Constants = {
+    BACKUP_CODES: exports.BACKUP_CODES,
+};
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAGa,QAAA,YAAY,GAAyB;IAChD;;OAEG;IACH,KAAK,EAAE,EAAW;IAClB,kBAAkB,EAAE,gBAAgB,EAAE,0CAA0C;IAChF,YAAY,EAAE,gCAAgC,EAAE,0CAA0C;CAClF,CAAC;AAEE,QAAA,SAAS,GAAe;IACnC,YAAY,EAAZ,oBAAY;CACb,CAAC"}

package/dist/enumerations/account-status.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Values for the status of an account.
+ */
+export declare 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"
+}
+//# sourceMappingURL=account-status.d.ts.map

package/dist/enumerations/account-status.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-status.d.ts","sourceRoot":"","sources":["../../src/enumerations/account-status.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,aAAa;IACvB;;OAEG;IACH,wBAAwB,6BAA6B;IACrD;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,SAAS,cAAc;CACxB"}

package/dist/enumerations/account-status.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountStatus = void 0;
+/**
+ * Values for the status of an account.
+ */
+var AccountStatus;
+(function (AccountStatus) {
+    /**
+     * The user has not verified their email address
+     */
+    AccountStatus["PendingEmailVerification"] = "PendingEmailVerification";
+    /**
+     * The user has verified their email address
+     */
+    AccountStatus["Active"] = "Active";
+    /**
+     * The user has been locked by an admin
+     */
+    AccountStatus["AdminLock"] = "AdminLock";
+})(AccountStatus || (exports.AccountStatus = AccountStatus = {}));
+//# sourceMappingURL=account-status.js.map

package/dist/enumerations/account-status.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-status.js","sourceRoot":"","sources":["../../src/enumerations/account-status.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,aAaX;AAbD,WAAY,aAAa;IACvB;;OAEG;IACH,sEAAqD,CAAA;IACrD;;OAEG;IACH,kCAAiB,CAAA;IACjB;;OAEG;IACH,wCAAuB,CAAA;AACzB,CAAC,EAbW,aAAa,6BAAb,aAAa,QAaxB"}

package/dist/enumerations/email-token-type.d.ts

@@ -0,0 +1,25 @@
+export declare 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"
+}
+//# sourceMappingURL=email-token-type.d.ts.map

package/dist/enumerations/email-token-type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-token-type.d.ts","sourceRoot":"","sources":["../../src/enumerations/email-token-type.ts"],"names":[],"mappings":"AAAA,oBAAY,cAAc;IACxB;;OAEG;IACH,mBAAmB,wBAAwB;IAC3C;;OAEG;IACH,aAAa,kBAAkB;IAC/B;;OAEG;IACH,YAAY,iBAAiB;IAC7B;;;OAGG;IACH,iBAAiB,sBAAsB;IACvC;;;OAGG;IACH,uBAAuB,4BAA4B;CACpD"}

package/dist/enumerations/email-token-type.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailTokenType = void 0;
+var EmailTokenType;
+(function (EmailTokenType) {
+    /**
+     * A token for verifying an account
+     */
+    EmailTokenType["AccountVerification"] = "AccountVerification";
+    /**
+     * A token for resetting a password
+     */
+    EmailTokenType["PasswordReset"] = "PasswordReset";
+    /**
+     * Requests a login link
+     */
+    EmailTokenType["LoginRequest"] = "LoginRequest";
+    /**
+     * Request encrypted private key blob for a user
+     * (requires username/email)
+     */
+    EmailTokenType["PrivateKeyRequest"] = "PrivateKeyRequest";
+    /**
+     * Request encrypted mnemonic blob for a user
+     * (requires private key)
+     */
+    EmailTokenType["MnemonicRecoveryRequest"] = "MnemonicRecoveryRequest";
+})(EmailTokenType || (exports.EmailTokenType = EmailTokenType = {}));
+//# sourceMappingURL=email-token-type.js.map

package/dist/enumerations/email-token-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-token-type.js","sourceRoot":"","sources":["../../src/enumerations/email-token-type.ts"],"names":[],"mappings":";;;AAAA,IAAY,cAuBX;AAvBD,WAAY,cAAc;IACxB;;OAEG;IACH,6DAA2C,CAAA;IAC3C;;OAEG;IACH,iDAA+B,CAAA;IAC/B;;OAEG;IACH,+CAA6B,CAAA;IAC7B;;;OAGG;IACH,yDAAuC,CAAA;IACvC;;;OAGG;IACH,qEAAmD,CAAA;AACrD,CAAC,EAvBW,cAAc,8BAAd,cAAc,QAuBzB"}

package/dist/enumerations/index.d.ts

@@ -0,0 +1,5 @@
+export * from './account-status';
+export * from './email-token-type';
+export * from './role';
+export * from './suite-core-string-key';
+//# sourceMappingURL=index.d.ts.map

package/dist/enumerations/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/enumerations/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,QAAQ,CAAC;AACvB,cAAc,yBAAyB,CAAC"}

package/dist/enumerations/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./account-status"), exports);
+__exportStar(require("./email-token-type"), exports);
+__exportStar(require("./role"), exports);
+__exportStar(require("./suite-core-string-key"), exports);
+//# sourceMappingURL=index.js.map

package/dist/enumerations/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/enumerations/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,qDAAmC;AACnC,yCAAuB;AACvB,0DAAwC"}

package/dist/enumerations/role.d.ts

@@ -0,0 +1,6 @@
+export declare enum Role {
+    Admin = "Admin",
+    Member = "Member",
+    System = "System"
+}
+//# sourceMappingURL=role.d.ts.map

package/dist/enumerations/role.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"role.d.ts","sourceRoot":"","sources":["../../src/enumerations/role.ts"],"names":[],"mappings":"AAAA,oBAAY,IAAI;IACd,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB"}

package/dist/enumerations/role.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Role = void 0;
+var Role;
+(function (Role) {
+    Role["Admin"] = "Admin";
+    Role["Member"] = "Member";
+    Role["System"] = "System";
+})(Role || (exports.Role = Role = {}));
+//# sourceMappingURL=role.js.map

package/dist/enumerations/role.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"role.js","sourceRoot":"","sources":["../../src/enumerations/role.ts"],"names":[],"mappings":";;;AAAA,IAAY,IAIX;AAJD,WAAY,IAAI;IACd,uBAAe,CAAA;IACf,yBAAiB,CAAA;IACjB,yBAAiB,CAAA;AACnB,CAAC,EAJW,IAAI,oBAAJ,IAAI,QAIf"}

package/dist/enumerations/suite-core-string-key.d.ts

@@ -0,0 +1,23 @@
+export declare enum SuiteCoreStringKey {
+    Validation_UsernameInUse = "Validation_UsernameInUse",
+    Validation_EmailInUse = "Validation_EmailInUse",
+    Validation_InvalidUsername = "Validation_InvalidUsername",
+    Validation_InvalidEmail = "Validation_InvalidEmail",
+    Validation_PasswordTooWeak = "Validation_PasswordTooWeak",
+    Validation_InvalidCredentials = "Validation_InvalidCredentials",
+    Validation_UsernameOrEmailRequired = "Validation_UsernameOrEmailRequired",
+    Auth_UserNotFound = "Auth_UserNotFound",
+    Auth_AccountLocked = "Auth_AccountLocked",
+    Auth_TokenExpired = "Auth_TokenExpired",
+    Auth_InvalidToken = "Auth_InvalidToken",
+    Auth_InsufficientPermissions = "Auth_InsufficientPermissions",
+    User_CreationFailed = "User_CreationFailed",
+    User_UpdateFailed = "User_UpdateFailed",
+    User_DeletionFailed = "User_DeletionFailed",
+    User_NotFound = "User_NotFound",
+    User_AlreadyExists = "User_AlreadyExists",
+    Error_AccountStatus_Active = "Error_AccountStatus_Active",
+    Error_AccountStatus_AdminLock = "Error_AccountStatus_AdminLock",
+    Error_AccountStatus_PendingEmailVerification = "Error_AccountStatus_PendingEmailVerification"
+}
+//# sourceMappingURL=suite-core-string-key.d.ts.map

package/dist/enumerations/suite-core-string-key.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suite-core-string-key.d.ts","sourceRoot":"","sources":["../../src/enumerations/suite-core-string-key.ts"],"names":[],"mappings":"AAAA,oBAAY,kBAAkB;IAE5B,wBAAwB,6BAA6B;IACrD,qBAAqB,0BAA0B;IAC/C,0BAA0B,+BAA+B;IACzD,uBAAuB,4BAA4B;IACnD,0BAA0B,+BAA+B;IACzD,6BAA6B,kCAAkC;IAC/D,kCAAkC,uCAAuC;IAGzE,iBAAiB,sBAAsB;IACvC,kBAAkB,uBAAuB;IACzC,iBAAiB,sBAAsB;IACvC,iBAAiB,sBAAsB;IACvC,4BAA4B,iCAAiC;IAG7D,mBAAmB,wBAAwB;IAC3C,iBAAiB,sBAAsB;IACvC,mBAAmB,wBAAwB;IAC3C,aAAa,kBAAkB;IAC/B,kBAAkB,uBAAuB;IAGzC,0BAA0B,+BAA+B;IACzD,6BAA6B,kCAAkC;IAC/D,4CAA4C,iDAAiD;CAC9F"}