@digitaldefiance/node-express-suite 3.7.3 → 3.7.5

package/src/documents/used-direct-login-token.ts

@@ -0,0 +1,18 @@
+/**
+ * @fileoverview Used direct login token document interface for MongoDB collections.
+ * Tracks consumed direct login tokens to prevent reuse attacks.
+ * @module documents/used-direct-login-token
+ */
+
+import { IUsedDirectLoginTokenBase } from '@digitaldefiance/suite-core-lib';
+import { IBaseDocument } from './base';
+import type { PlatformID } from '@digitaldefiance/node-ecies-lib';
+
+/**
+ * Composite interface for used direct login token collection documents.
+ * Extends base document with used token tracking properties to ensure one-time token usage.
+ * Prevents replay attacks by recording consumed tokens with user ID and timestamp.
+ * @template TID Platform-specific ID type (Buffer, ObjectId, etc.)
+ */
+export type IUsedDirectLoginTokenDocument<TID extends PlatformID = Buffer> =
+  IBaseDocument<IUsedDirectLoginTokenBase<TID>, TID>;

package/src/documents/user-role.ts

@@ -0,0 +1,20 @@
+/**
+ * @fileoverview User-role relationship document interface for MongoDB collections.
+ * Combines base document properties with user-role association fields.
+ * @module documents/user-role
+ */
+
+import { IUserRoleBase } from '@digitaldefiance/suite-core-lib';
+import { IBaseDocument } from './base';
+import type { PlatformID } from '@digitaldefiance/node-ecies-lib';
+
+/**
+ * Composite interface for user-role collection documents.
+ * Extends base document with user-role relationship properties linking users to their assigned roles.
+ * Supports many-to-many relationships between users and roles with timestamps.
+ * @template TID Platform-specific ID type (Buffer, ObjectId, etc.)
+ */
+export type IUserRoleDocument<TID extends PlatformID = Buffer> = IBaseDocument<
+  IUserRoleBase<TID, Date>,
+  TID
+>;

package/src/documents/user.ts

@@ -0,0 +1,20 @@
+/**
+ * @fileoverview User document interface for Mongoose user model.
+ * Combines base document with user-specific fields and account status.
+ * @module documents/user
+ */
+
+import { AccountStatus, IUserBase } from '@digitaldefiance/suite-core-lib';
+import { IBaseDocument } from './base';
+import type { PlatformID } from '@digitaldefiance/node-ecies-lib';
+
+/**
+ * User document interface for MongoDB user collection.
+ * @template TLanguage - String type for site language (defaults to string)
+ * @template TID - Platform ID type (defaults to Buffer)
+ * @typedef {IBaseDocument<IUserBase<TID, Date, S, AccountStatus>, TID>} IUserDocument
+ */
+export type IUserDocument<
+  TLanguage extends string = string,
+  TID extends PlatformID = Buffer,
+> = IBaseDocument<IUserBase<TID, Date, TLanguage, AccountStatus>, TID>;

package/src/enumerations/base-model-name.ts

@@ -0,0 +1,47 @@
+/**
+ * @fileoverview Base model name enumeration for MongoDB collections.
+ * Defines standard model names used throughout the application.
+ * @module enumerations/base-model-name
+ */
+
+/**
+ * Base enumeration of required model names for the node-express-suite.
+ */
+export enum BaseModelName {
+  /**
+   * Model name for email tokens sent to users
+   */
+  EmailToken = 'EmailToken',
+  /**
+   * Model name for roles in the application
+   */
+  Role = 'Role',
+  /**
+   * Model name for users in the application
+   */
+  User = 'User',
+  /**
+   * Model name for mnemonics used in the application
+   */
+  Mnemonic = 'Mnemonic',
+  /**
+   * Model name for user-role relationships
+   */
+  UserRole = 'UserRole',
+  /**
+   * Model name for used direct login tokens
+   */
+  UsedDirectLoginToken = 'UsedDirectLoginToken',
+}
+
+/**
+ * Type for extending BaseModelName with additional models
+ */
+export type ExtendedModelName<T extends Record<string, string>> =
+  | BaseModelName
+  | T[keyof T];
+
+/**
+ * Default model name type for backward compatibility
+ */
+export type ModelName = BaseModelName;

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

@@ -2,4 +2,3 @@ export * from './base-model-name';
 export * from './length-encoding-type';
 export * from './schema-collection';
 export * from './symmetric-error-type';
-//# sourceMappingURL=index.d.ts.map

package/src/enumerations/length-encoding-type.ts

@@ -0,0 +1,16 @@
+/**
+ * @fileoverview Length encoding type enumeration for variable-length data encoding.
+ * Defines encoding types for different integer sizes (8, 16, 32, 64 bit).
+ * @module enumerations/length-encoding-type
+ */
+
+/**
+ * Enumeration for length encoding types used in data serialization.
+ * Determines how length values are encoded based on data size.
+ */
+export enum LengthEncodingType {
+  UInt8 = 0,
+  UInt16 = 1,
+  UInt32 = 2,
+  UInt64 = 3,
+}

package/src/enumerations/schema-collection.ts

@@ -0,0 +1,39 @@
+/**
+ * @fileoverview Schema collection name enumeration for MongoDB collections.
+ * Defines standardized collection names used throughout the application.
+ * @module enumerations/schema-collection
+ */
+
+/**
+ * Enumerations for the schema collections.
+ */
+export enum SchemaCollection {
+  /**
+   * Collection for email tokens sent to users
+   */
+  EmailToken = 'email-tokens',
+  /**
+   * Collection for roles in the application
+   */
+  Role = 'roles',
+  /**
+   * Collection for user tokens
+   */
+  UserToken = 'user-tokens',
+  /**
+   * Collection for users in the application
+   */
+  User = 'users',
+  /**
+   * Collection for mnemonics used in the application
+   */
+  Mnemonic = 'mnemonics',
+  /**
+   * Collection for user-role relationships
+   */
+  UserRole = 'user-roles',
+  /**
+   * Collection for used direct login tokens
+   */
+  UsedDirectLoginToken = 'used-direct-login-tokens',
+}

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

@@ -0,0 +1,13 @@
+/**
+ * @fileoverview Symmetric encryption error type enumeration.
+ * Defines error types for symmetric encryption operations.
+ * @module enumerations/symmetric-error-type
+ */
+
+/**
+ * Error types for symmetric encryption operations.
+ */
+export enum SymmetricErrorType {
+  DataNullOrUndefined = 'DataNullOrUndefined',
+  InvalidKeyLength = 'InvalidKeyLength',
+}