@plyaz/types 1.3.4 → 1.3.6

package/dist/auth/enums.d.ts

@@ -1,32 +1,70 @@
 /**
  * Enum representing the different roles a user can have within the system.
  * @description Roles are used to determine access levels, permissions, and user-specific experiences.
+ *
+ * @example
+ * ```typescript
+ * import { USER_ROLE } from '@plyaz/types';
+ *
+ * const userRole = USER_ROLE.Athlete; // 'athlete'
+ * const isAdmin = userRole === USER_ROLE.Admin || userRole === USER_ROLE.SuperAdmin;
+ * ```
  */
 export declare const USER_ROLE: {
+    /** A user who is an athlete and participates in sports activities. */
     readonly Athlete: "athlete";
+    /** A user who scouts and discovers talent. */
     readonly Scout: "scout";
+    /** A user who acts as an agent representing athletes or clubs. */
     readonly Agent: "agent";
+    /** A user representing a sports club or organization. */
     readonly Club: "club";
+    /** A fan or supporter of athletes or clubs. */
     readonly Fan: "fan";
+    /** A system administrator with access to management tools. */
     readonly Admin: "admin";
+    /** A super admin with the highest level of access and control. */
     readonly SuperAdmin: "super.admin";
 };
 /**
  * Enum representing the current status of a user account.
  * @description Statuses are used to determine login availability, visibility, and user flow.
+ *
+ * @example
+ * ```typescript
+ * import { USER_STATUS } from '@plyaz/types';
+ *
+ * const isAccessible = status === USER_STATUS.Active;
+ * const needsReview = status === USER_STATUS.Pending;
+ * ```
  */
 export declare const USER_STATUS: {
+    /** Active user with full access. */
     readonly Active: "active";
+    /** Inactive user, typically not currently using the platform. */
     readonly Inactive: "inactive";
+    /** User account is awaiting approval or completion of setup. */
     readonly Pending: "pending";
+    /** User has been temporarily suspended due to policy violations or manual review. */
     readonly Suspended: "suspended";
+    /** User has been permanently banned from the platform. */
     readonly Banned: "banned";
 };
 /**
  * Enum representing the supported authentication providers for user login.
  * @description Auth Providers allowed such as Email, Wallet, etc.
+ *
+ * @example
+ * ```typescript
+ * import { AUTH_PROVIDER } from '@plyaz/types';
+ *
+ * const provider = AUTH_PROVIDER.Wallet; // 'wallet'
+ * const isWeb3Auth = provider === AUTH_PROVIDER.Wallet;
+ * ```
  */
 export declare const AUTH_PROVIDER: {
+    /** Authentication via email and password. */
     readonly Email: "email";
+    /** Authentication via connected blockchain wallet. */
     readonly Wallet: "wallet";
 };

package/dist/errors/enums.d.ts

@@ -1,33 +1,75 @@
 /**
  * Enum representing standardized error types used across the application.
  * @description These error types help classify different categories of errors such as validation issues and system-level failures.
+ *
+ * @example
+ * ```typescript
+ * import { ERROR_TYPE } from '@plyaz/types';
+ *
+ * const errorType = ERROR_TYPE.ValidationError; // 'validation.error'
+ *
+ * // Error handling example
+ * if (error.type === ERROR_TYPE.RateLimitExceeded) {
+ *   // Handle rate limiting
+ * }
+ * ```
  */
 export declare const ERROR_TYPE: {
+    /** A general validation error (e.g., form or input errors). */
     readonly ValidationError: "validation.error";
+    /** Error related to schema validation, such as JSON schema or API payload checks. */
     readonly SchemaValidationError: "validation.schema.error";
+    /** Unhandled or unexpected system error. */
     readonly InternalError: "system.internal.error";
+    /** System dependency is currently unavailable (e.g., database or external API). */
     readonly ServiceUnavailable: "system.service.unavailable";
+    /** The request took too long and timed out. */
     readonly TimeoutError: "system.timeout";
+    /** Too many requests made in a short period of time. */
     readonly RateLimitExceeded: "system.rate.limit.exceeded";
 };
 /**
  * Enum representing the severity level of an error.
  * @description This allows categorization of errors by their potential impact on the system or user.
+ *
+ * @example
+ * ```typescript
+ * import { ERROR_SEVERITY } from '@plyaz/types';
+ *
+ * const severity = ERROR_SEVERITY.Critical; // 'critical'
+ * const shouldAlert = severity === ERROR_SEVERITY.High || severity === ERROR_SEVERITY.Critical;
+ * ```
  */
 export declare const ERROR_SEVERITY: {
+    /** Low severity - does not impact functionality significantly. */
     readonly Low: "low";
+    /** Medium severity - minor disruption or warning. */
     readonly Medium: "medium";
+    /** High severity - major issue requiring attention. */
     readonly High: "high";
+    /** Critical severity - blocking or crashing issue. */
     readonly Critical: "critical";
 };
 /**
  * Enum representing the category or origin of an error.
  * @description Useful for filtering or logging errors based on their source or nature.
+ *
+ * @example
+ * ```typescript
+ * import { ERROR_CATEGORY } from '@plyaz/types';
+ *
+ * const category = ERROR_CATEGORY.Blockchain; // 'blockchain'
+ * const isClientError = category === ERROR_CATEGORY.Client;
+ * ```
  */
 export declare const ERROR_CATEGORY: {
+    /** Client-side error (e.g., invalid request). */
     readonly Client: "client";
+    /** Server-side error (e.g., logic failure or exception). */
     readonly Server: "server";
+    /** Network-related error (e.g., unreachable endpoint). */
     readonly Network: "network";
+    /** Blockchain-related error (e.g., transaction failure, gas limit). */
     readonly Blockchain: "blockchain";
     readonly Validation: "validation";
 };

package/dist/events/enums.d.ts

@@ -1,25 +1,64 @@
 /**
  * Enum representing the types of events in the application.
+ * Uses dot notation for event naming convention.
+ *
+ * @example
+ * ```typescript
+ * import { EVENT_TYPE } from '@plyaz/types';
+ *
+ * const eventType = EVENT_TYPE.AppInit; // 'app.init'
+ * ```
  */
 export declare const EVENT_TYPE: {
+    /** Application initialization event. */
     readonly AppInit: "app.init";
 };
 /**
  * Const representing the priority levels for events.
+ * Used to determine processing order and resource allocation.
+ *
+ * @example
+ * ```typescript
+ * import { EVENT_PRIORITY } from '@plyaz/types';
+ *
+ * const priority = EVENT_PRIORITY.High; // 'high'
+ * ```
  */
 export declare const EVENT_PRIORITY: {
+    /** Low priority event. */
     readonly Low: "low";
+    /** Normal priority event. */
     readonly Normal: "normal";
+    /** High priority event. */
     readonly High: "high";
+    /** Critical priority event. */
     readonly Critical: "critical";
 };
 /**
  * Const representing the status of an event.
+ * Tracks the lifecycle of event processing from creation to completion.
+ *
+ * @example
+ * ```typescript
+ * import { EVENT_STATUS } from '@plyaz/types';
+ *
+ * const status = EVENT_STATUS.Processing; // 'processing'
+ *
+ * // Typical event lifecycle:
+ * // Pending -> Processing -> Completed
+ * // or
+ * // Pending -> Processing -> Failed -> Retrying -> Processing -> Completed
+ * ```
  */
 export declare const EVENT_STATUS: {
+    /** Event is pending and has not started processing. */
     readonly Pending: "pending";
+    /** Event is currently being processed. */
     readonly Processing: "processing";
+    /** Event has been completed successfully. */
     readonly Completed: "completed";
+    /** Event processing failed. */
     readonly Failed: "failed";
+    /** Event is being retried after a failure. */
     readonly Retrying: "retrying";
 };

package/dist/events/payload.d.ts

@@ -1,6 +1,18 @@
 /**
  * User Payloads.
  */
+/**
+ * Payload for user update events.
+ * Contains the unique identifier of the user that was updated.
+ *
+ * @example
+ * ```typescript
+ * const payload: UserUpdatePayload = {
+ *   uuid: '123e4567-e89b-12d3-a456-426614174000'
+ * };
+ * ```
+ */
 export interface UserUpdatePayload {
+    /** The unique identifier of the updated user */
     readonly uuid: string;
 }

package/dist/features/feature-flag/types.d.ts

@@ -41,6 +41,10 @@ export interface FeatureFlag<FeatureFlagKey extends string> {
     createdBy: string;
     /** Email or ID of the user who last updated this flag */
     updatedBy: string;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+    /** Tags for categorization */
+    tags?: string[];
 }
 /**
  * Feature flag rule for advanced targeting and conditional logic.
@@ -62,6 +66,8 @@ export interface FeatureFlagRule<FeatureFlagKey extends string> {
     priority: number;
     /** Whether this rule is currently active */
     isEnabled: boolean;
+    /** Rule metadata */
+    metadata?: Record<string, unknown>;
 }
 /**
  * Individual condition for feature flag rule evaluation.
@@ -110,7 +116,7 @@ export interface FeatureFlagEvaluation<FeatureFlagKey extends string> {
     /** Source of the evaluation result */
     source?: 'default' | 'override' | 'rule' | 'rollout';
     /** ID of the rule that matched (if reason is 'rule_match') */
-    ruleId?: string;
+    matchedRuleId?: string;
     /** Timestamp when this evaluation occurred */
     evaluatedAt: Date;
 }
@@ -138,20 +144,25 @@ export interface FeatureFlagConfig<FeatureFlagKey extends string> {
     databaseConfig?: {
         connectionString: string;
         tableName: string;
+        options?: Record<string, unknown>;
     };
     /** Redis configuration (required if provider is 'redis') */
     redisConfig?: {
         url: string;
         keyPrefix: string;
+        options?: Record<string, unknown>;
     };
     /** File configuration (required if provider is 'file') */
     fileConfig?: {
         filePath: string;
         format: 'json' | 'yaml';
         shouldWatchForChanges: boolean;
+        fileCheckInterval?: number;
     };
     /** Memory provider rules (optional for memory provider) */
     memoryRules?: FeatureFlagRule<FeatureFlagKey>[];
+    /** Optional override values for testing */
+    overrides?: Record<FeatureFlagKey, FeatureFlagValue>;
 }
 /**
  * React Hook Options for Feature Flags
@@ -264,6 +275,29 @@ export interface FeatureFlagProvider<FeatureFlagKey extends string> {
     clearOverrides(): void;
     /** Disposes of the provider, cleaning up resources */
     dispose(): void;
+    /** Optional: Update a flag (not all providers support this) */
+    updateFlag?(flag: FeatureFlag<FeatureFlagKey>): Promise<void>;
+    /** Optional: Update a rule (not all providers support this) */
+    updateRule?(rule: FeatureFlagRule<FeatureFlagKey>): Promise<void>;
+    /** Optional: Sync features at runtime (for providers that support dynamic updates) */
+    syncFeatures?(newFeatures: Record<FeatureFlagKey, FeatureFlagValue>): Promise<void>;
+}
+/**
+ * Provider statistics
+ */
+export interface ProviderStats {
+    /** Total number of evaluations */
+    evaluations: number;
+    /** Cache hits */
+    cacheHits: number;
+    /** Cache misses */
+    cacheMisses: number;
+    /** Average evaluation time in ms */
+    avgEvaluationTime: number;
+    /** Last refresh timestamp */
+    lastRefresh?: Date;
+    /** Provider uptime in ms */
+    uptime: number;
 }
 /**
  * Partial mapping for flag overrides.

package/dist/index.d.ts

@@ -10,4 +10,4 @@ export * from './web3';
 export type * from './translations';
 export type * from './features';
 export type * from './testing';
-export type * from 'type-fest';
+export type * from './lib';

package/dist/index.js

@@ -2,73 +2,73 @@
 
 // src/auth/enums.ts
 var USER_ROLE = {
-  // A user who is an athlete and participates in sports activities.
+  /** A user who is an athlete and participates in sports activities. */
   Athlete: "athlete",
-  // A user who scouts and discovers talent.
+  /** A user who scouts and discovers talent. */
   Scout: "scout",
-  // A user who acts as an agent representing athletes or clubs.
+  /** A user who acts as an agent representing athletes or clubs. */
   Agent: "agent",
-  // A user representing a sports club or organization.
+  /** A user representing a sports club or organization. */
   Club: "club",
-  // A fan or supporter of athletes or clubs.
+  /** A fan or supporter of athletes or clubs. */
   Fan: "fan",
-  // A system administrator with access to management tools.
+  /** A system administrator with access to management tools. */
   Admin: "admin",
-  // A super admin with the highest level of access and control.
+  /** A super admin with the highest level of access and control. */
   SuperAdmin: "super.admin"
 };
 var USER_STATUS = {
-  // Active user with full access.
+  /** Active user with full access. */
   Active: "active",
-  // Inactive user, typically not currently using the platform.
+  /** Inactive user, typically not currently using the platform. */
   Inactive: "inactive",
-  // User account is awaiting approval or completion of setup.
+  /** User account is awaiting approval or completion of setup. */
   Pending: "pending",
-  // User has been temporarily suspended due to policy violations or manual review.
+  /** User has been temporarily suspended due to policy violations or manual review. */
   Suspended: "suspended",
-  // User has been permanently banned from the platform.
+  /** User has been permanently banned from the platform. */
   Banned: "banned"
 };
 var AUTH_PROVIDER = {
-  // Authentication via email and password.
+  /** Authentication via email and password. */
   Email: "email",
-  // Authentication via connected blockchain wallet.
+  /** Authentication via connected blockchain wallet. */
   Wallet: "wallet"
 };
 
 // src/errors/enums.ts
 var ERROR_TYPE = {
-  // A general validation error (e.g., form or input errors).
+  /** A general validation error (e.g., form or input errors). */
   ValidationError: "validation.error",
-  // Error related to schema validation, such as JSON schema or API payload checks.
+  /** Error related to schema validation, such as JSON schema or API payload checks. */
   SchemaValidationError: "validation.schema.error",
-  // Unhandled or unexpected system error.
+  /** Unhandled or unexpected system error. */
   InternalError: "system.internal.error",
-  // System dependency is currently unavailable (e.g., database or external API).
+  /** System dependency is currently unavailable (e.g., database or external API). */
   ServiceUnavailable: "system.service.unavailable",
-  // The request took too long and timed out.
+  /** The request took too long and timed out. */
   TimeoutError: "system.timeout",
-  // Too many requests made in a short period of time.
+  /** Too many requests made in a short period of time. */
   RateLimitExceeded: "system.rate.limit.exceeded"
 };
 var ERROR_SEVERITY = {
-  // Low severity - does not impact functionality significantly.
+  /** Low severity - does not impact functionality significantly. */
   Low: "low",
-  // Medium severity - minor disruption or warning.
+  /** Medium severity - minor disruption or warning. */
   Medium: "medium",
-  // High severity - major issue requiring attention.
+  /** High severity - major issue requiring attention. */
   High: "high",
-  // Critical severity - blocking or crashing issue.
+  /** Critical severity - blocking or crashing issue. */
   Critical: "critical"
 };
 var ERROR_CATEGORY = {
-  // Client-side error (e.g., invalid request).
+  /** Client-side error (e.g., invalid request). */
   Client: "client",
-  // Server-side error (e.g., logic failure or exception).
+  /** Server-side error (e.g., logic failure or exception). */
   Server: "server",
-  // Network-related error (e.g., unreachable endpoint).
+  /** Network-related error (e.g., unreachable endpoint). */
   Network: "network",
-  // Blockchain-related error (e.g., transaction failure, gas limit).
+  /** Blockchain-related error (e.g., transaction failure, gas limit). */
   Blockchain: "blockchain",
   // Validation-specific error (e.g., failed constraints or field errors).
   Validation: "validation"
@@ -76,53 +76,53 @@ var ERROR_CATEGORY = {
 
 // src/events/enums.ts
 var EVENT_TYPE = {
-  // Application initialization event.
+  /** Application initialization event. */
   AppInit: "app.init"
 };
 var EVENT_PRIORITY = {
-  // Low priority event.
+  /** Low priority event. */
   Low: "low",
-  // Normal priority event.
+  /** Normal priority event. */
   Normal: "normal",
-  // High priority event.
+  /** High priority event. */
   High: "high",
-  // Critical priority event.
+  /** Critical priority event. */
   Critical: "critical"
 };
 var EVENT_STATUS = {
-  // Event is pending and has not started processing.
+  /** Event is pending and has not started processing. */
   Pending: "pending",
-  // Event is currently being processed.
+  /** Event is currently being processed. */
   Processing: "processing",
-  // Event has been completed successfully.
+  /** Event has been completed successfully. */
   Completed: "completed",
-  // Event processing failed.
+  /** Event processing failed. */
   Failed: "failed",
-  // Event is being retried after a failure.
+  /** Event is being retried after a failure. */
   Retrying: "retrying"
 };
 
 // src/web3/enums.ts
 var CHAIN_ID = {
-  // Ethereum Mainnet (Chain ID: 1).
+  /** Ethereum Mainnet (Chain ID: 1). */
   EthereumMainnet: 1,
-  // Ethereum Sepolia Testnet (Chain ID: 11155111).
+  /** Ethereum Sepolia Testnet (Chain ID: 11155111). */
   EthereumSepolia: 11155111,
-  // Optimism Mainnet (Chain ID: 10).
+  /** Optimism Mainnet (Chain ID: 10). */
   Optimism: 10,
-  // Optimism Sepolia Testnet (Chain ID: 11155420).
+  /** Optimism Sepolia Testnet (Chain ID: 11155420). */
   OptimismSepolia: 11155420,
-  // Arbitrum One Mainnet (Chain ID: 42161).
+  /** Arbitrum One Mainnet (Chain ID: 42161). */
   Arbitrum: 42161,
-  // Arbitrum Sepolia Testnet (Chain ID: 421614).
+  /** Arbitrum Sepolia Testnet (Chain ID: 421614). */
   ArbitrumSepolia: 421614,
-  // Polygon Mainnet (Chain ID: 137).
+  /** Polygon Mainnet (Chain ID: 137). */
   Polygon: 137,
-  // Polygon Amoy Testnet (Chain ID: 80002).
+  /** Polygon Amoy Testnet (Chain ID: 80002). */
   PolygonAmoy: 80002,
-  // Base Mainnet (Chain ID: 8453).
+  /** Base Mainnet (Chain ID: 8453). */
   Base: 8453,
-  // Base Sepolia Testnet (Chain ID: 84532).
+  /** Base Sepolia Testnet (Chain ID: 84532). */
   BaseSepolia: 84532
 };
 

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/auth/enums.ts","../src/errors/enums.ts","../src/events/enums.ts","../src/web3/enums.ts"],"names":[],"mappings":";;;AAIO,IAAM,SAAA,GAAY;AAAA;AAAA,EAEvB,OAAA,EAAS,SAAA;AAAA;AAAA,EAGT,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,IAAA,EAAM,MAAA;AAAA;AAAA,EAGN,GAAA,EAAK,KAAA;AAAA;AAAA,EAGL,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,UAAA,EAAY;AACd;AAMO,IAAM,WAAA,GAAc;AAAA;AAAA,EAEzB,MAAA,EAAQ,QAAA;AAAA;AAAA,EAGR,QAAA,EAAU,UAAA;AAAA;AAAA,EAGV,OAAA,EAAS,SAAA;AAAA;AAAA,EAGT,SAAA,EAAW,WAAA;AAAA;AAAA,EAGX,MAAA,EAAQ;AACV;AAMO,IAAM,aAAA,GAAgB;AAAA;AAAA,EAE3B,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,MAAA,EAAQ;AACV;;;ACtDO,IAAM,UAAA,GAAa;AAAA;AAAA,EAExB,eAAA,EAAiB,kBAAA;AAAA;AAAA,EAGjB,qBAAA,EAAuB,yBAAA;AAAA;AAAA,EAGvB,aAAA,EAAe,uBAAA;AAAA;AAAA,EAGf,kBAAA,EAAoB,4BAAA;AAAA;AAAA,EAGpB,YAAA,EAAc,gBAAA;AAAA;AAAA,EAGd,iBAAA,EAAmB;AACrB;AAMO,IAAM,cAAA,GAAiB;AAAA;AAAA,EAE5B,GAAA,EAAK,KAAA;AAAA;AAAA,EAGL,MAAA,EAAQ,QAAA;AAAA;AAAA,EAGR,IAAA,EAAM,MAAA;AAAA;AAAA,EAGN,QAAA,EAAU;AACZ;AAMO,IAAM,cAAA,GAAiB;AAAA;AAAA,EAE5B,MAAA,EAAQ,QAAA;AAAA;AAAA,EAGR,MAAA,EAAQ,QAAA;AAAA;AAAA,EAGR,OAAA,EAAS,SAAA;AAAA;AAAA,EAGT,UAAA,EAAY,YAAA;AAAA;AAAA,EAGZ,UAAA,EAAY;AACd;;;AC1DO,IAAM,UAAA,GAAa;AAAA;AAAA,EAExB,OAAA,EAAS;AACX;AAKO,IAAM,cAAA,GAAiB;AAAA;AAAA,EAE5B,GAAA,EAAK,KAAA;AAAA;AAAA,EAEL,MAAA,EAAQ,QAAA;AAAA;AAAA,EAER,IAAA,EAAM,MAAA;AAAA;AAAA,EAEN,QAAA,EAAU;AACZ;AAKO,IAAM,YAAA,GAAe;AAAA;AAAA,EAE1B,OAAA,EAAS,SAAA;AAAA;AAAA,EAET,UAAA,EAAY,YAAA;AAAA;AAAA,EAEZ,SAAA,EAAW,WAAA;AAAA;AAAA,EAEX,MAAA,EAAQ,QAAA;AAAA;AAAA,EAER,QAAA,EAAU;AACZ;;;AC/BO,IAAM,QAAA,GAAW;AAAA;AAAA,EAEtB,eAAA,EAAiB,CAAA;AAAA;AAAA,EAGjB,eAAA,EAAiB,QAAA;AAAA;AAAA,EAGjB,QAAA,EAAU,EAAA;AAAA;AAAA,EAGV,eAAA,EAAiB,QAAA;AAAA;AAAA,EAGjB,QAAA,EAAU,KAAA;AAAA;AAAA,EAGV,eAAA,EAAiB,MAAA;AAAA;AAAA,EAGjB,OAAA,EAAS,GAAA;AAAA;AAAA,EAGT,WAAA,EAAa,KAAA;AAAA;AAAA,EAGb,IAAA,EAAM,IAAA;AAAA;AAAA,EAGN,WAAA,EAAa;AACf","file":"index.js","sourcesContent":["/**\n * Enum representing the different roles a user can have within the system.\n * @description Roles are used to determine access levels, permissions, and user-specific experiences.\n */\nexport const USER_ROLE = {\n  // A user who is an athlete and participates in sports activities.\n  Athlete: 'athlete',\n\n  // A user who scouts and discovers talent.\n  Scout: 'scout',\n\n  // A user who acts as an agent representing athletes or clubs.\n  Agent: 'agent',\n\n  // A user representing a sports club or organization.\n  Club: 'club',\n\n  // A fan or supporter of athletes or clubs.\n  Fan: 'fan',\n\n  // A system administrator with access to management tools.\n  Admin: 'admin',\n\n  // A super admin with the highest level of access and control.\n  SuperAdmin: 'super.admin',\n} as const;\n\n/**\n * Enum representing the current status of a user account.\n * @description Statuses are used to determine login availability, visibility, and user flow.\n */\nexport const USER_STATUS = {\n  // Active user with full access.\n  Active: 'active',\n\n  // Inactive user, typically not currently using the platform.\n  Inactive: 'inactive',\n\n  // User account is awaiting approval or completion of setup.\n  Pending: 'pending',\n\n  // User has been temporarily suspended due to policy violations or manual review.\n  Suspended: 'suspended',\n\n  // User has been permanently banned from the platform.\n  Banned: 'banned',\n} as const;\n\n/**\n * Enum representing the supported authentication providers for user login.\n * @description Auth Providers allowed such as Email, Wallet, etc.\n */\nexport const AUTH_PROVIDER = {\n  // Authentication via email and password.\n  Email: 'email',\n\n  // Authentication via connected blockchain wallet.\n  Wallet: 'wallet',\n} as const;\n","/**\n * Enum representing standardized error types used across the application.\n * @description These error types help classify different categories of errors such as validation issues and system-level failures.\n */\nexport const ERROR_TYPE = {\n  // A general validation error (e.g., form or input errors).\n  ValidationError: 'validation.error',\n\n  // Error related to schema validation, such as JSON schema or API payload checks.\n  SchemaValidationError: 'validation.schema.error',\n\n  // Unhandled or unexpected system error.\n  InternalError: 'system.internal.error',\n\n  // System dependency is currently unavailable (e.g., database or external API).\n  ServiceUnavailable: 'system.service.unavailable',\n\n  // The request took too long and timed out.\n  TimeoutError: 'system.timeout',\n\n  // Too many requests made in a short period of time.\n  RateLimitExceeded: 'system.rate.limit.exceeded',\n} as const;\n\n/**\n * Enum representing the severity level of an error.\n * @description This allows categorization of errors by their potential impact on the system or user.\n */\nexport const ERROR_SEVERITY = {\n  // Low severity - does not impact functionality significantly.\n  Low: 'low',\n\n  // Medium severity - minor disruption or warning.\n  Medium: 'medium',\n\n  // High severity - major issue requiring attention.\n  High: 'high',\n\n  // Critical severity - blocking or crashing issue.\n  Critical: 'critical',\n} as const;\n\n/**\n * Enum representing the category or origin of an error.\n * @description Useful for filtering or logging errors based on their source or nature.\n */\nexport const ERROR_CATEGORY = {\n  // Client-side error (e.g., invalid request).\n  Client: 'client',\n\n  // Server-side error (e.g., logic failure or exception).\n  Server: 'server',\n\n  // Network-related error (e.g., unreachable endpoint).\n  Network: 'network',\n\n  // Blockchain-related error (e.g., transaction failure, gas limit).\n  Blockchain: 'blockchain',\n\n  // Validation-specific error (e.g., failed constraints or field errors).\n  Validation: 'validation',\n} as const;\n","/**\n * Enum representing the types of events in the application.\n */\nexport const EVENT_TYPE = {\n  // Application initialization event.\n  AppInit: 'app.init',\n} as const;\n\n/**\n * Const representing the priority levels for events.\n */\nexport const EVENT_PRIORITY = {\n  // Low priority event.\n  Low: 'low',\n  // Normal priority event.\n  Normal: 'normal',\n  // High priority event.\n  High: 'high',\n  // Critical priority event.\n  Critical: 'critical',\n} as const;\n\n/**\n * Const representing the status of an event.\n */\nexport const EVENT_STATUS = {\n  // Event is pending and has not started processing.\n  Pending: 'pending',\n  // Event is currently being processed.\n  Processing: 'processing',\n  // Event has been completed successfully.\n  Completed: 'completed',\n  // Event processing failed.\n  Failed: 'failed',\n  // Event is being retried after a failure.\n  Retrying: 'retrying',\n} as const;\n","/**\n * Enum representing supported EVM-compatible blockchain networks by their numeric chain IDs.\n * @description These IDs are used to identify the specific network when interacting with wallets or smart contracts.\n * @see https://chainlist.org for reference chain IDs\n */\nexport const CHAIN_ID = {\n  // Ethereum Mainnet (Chain ID: 1).\n  EthereumMainnet: 1,\n\n  // Ethereum Sepolia Testnet (Chain ID: 11155111).\n  EthereumSepolia: 11_155_111,\n\n  // Optimism Mainnet (Chain ID: 10).\n  Optimism: 10,\n\n  // Optimism Sepolia Testnet (Chain ID: 11155420).\n  OptimismSepolia: 11_155_420,\n\n  // Arbitrum One Mainnet (Chain ID: 42161).\n  Arbitrum: 42_161,\n\n  // Arbitrum Sepolia Testnet (Chain ID: 421614).\n  ArbitrumSepolia: 421_614,\n\n  // Polygon Mainnet (Chain ID: 137).\n  Polygon: 137,\n\n  // Polygon Amoy Testnet (Chain ID: 80002).\n  PolygonAmoy: 80_002,\n\n  // Base Mainnet (Chain ID: 8453).\n  Base: 8_453,\n\n  // Base Sepolia Testnet (Chain ID: 84532).\n  BaseSepolia: 84_532,\n} as const;\n"]}
+{"version":3,"sources":["../src/auth/enums.ts","../src/errors/enums.ts","../src/events/enums.ts","../src/web3/enums.ts"],"names":[],"mappings":";;;AAYO,IAAM,SAAA,GAAY;AAAA;AAAA,EAEvB,OAAA,EAAS,SAAA;AAAA;AAAA,EAGT,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,IAAA,EAAM,MAAA;AAAA;AAAA,EAGN,GAAA,EAAK,KAAA;AAAA;AAAA,EAGL,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,UAAA,EAAY;AACd;AAcO,IAAM,WAAA,GAAc;AAAA;AAAA,EAEzB,MAAA,EAAQ,QAAA;AAAA;AAAA,EAGR,QAAA,EAAU,UAAA;AAAA;AAAA,EAGV,OAAA,EAAS,SAAA;AAAA;AAAA,EAGT,SAAA,EAAW,WAAA;AAAA;AAAA,EAGX,MAAA,EAAQ;AACV;AAcO,IAAM,aAAA,GAAgB;AAAA;AAAA,EAE3B,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,MAAA,EAAQ;AACV;;;AClEO,IAAM,UAAA,GAAa;AAAA;AAAA,EAExB,eAAA,EAAiB,kBAAA;AAAA;AAAA,EAGjB,qBAAA,EAAuB,yBAAA;AAAA;AAAA,EAGvB,aAAA,EAAe,uBAAA;AAAA;AAAA,EAGf,kBAAA,EAAoB,4BAAA;AAAA;AAAA,EAGpB,YAAA,EAAc,gBAAA;AAAA;AAAA,EAGd,iBAAA,EAAmB;AACrB;AAcO,IAAM,cAAA,GAAiB;AAAA;AAAA,EAE5B,GAAA,EAAK,KAAA;AAAA;AAAA,EAGL,MAAA,EAAQ,QAAA;AAAA;AAAA,EAGR,IAAA,EAAM,MAAA;AAAA;AAAA,EAGN,QAAA,EAAU;AACZ;AAcO,IAAM,cAAA,GAAiB;AAAA;AAAA,EAE5B,MAAA,EAAQ,QAAA;AAAA;AAAA,EAGR,MAAA,EAAQ,QAAA;AAAA;AAAA,EAGR,OAAA,EAAS,SAAA;AAAA;AAAA,EAGT,UAAA,EAAY,YAAA;AAAA;AAAA,EAGZ,UAAA,EAAY;AACd;;;AC9EO,IAAM,UAAA,GAAa;AAAA;AAAA,EAExB,OAAA,EAAS;AACX;AAaO,IAAM,cAAA,GAAiB;AAAA;AAAA,EAE5B,GAAA,EAAK,KAAA;AAAA;AAAA,EAEL,MAAA,EAAQ,QAAA;AAAA;AAAA,EAER,IAAA,EAAM,MAAA;AAAA;AAAA,EAEN,QAAA,EAAU;AACZ;AAkBO,IAAM,YAAA,GAAe;AAAA;AAAA,EAE1B,OAAA,EAAS,SAAA;AAAA;AAAA,EAET,UAAA,EAAY,YAAA;AAAA;AAAA,EAEZ,SAAA,EAAW,WAAA;AAAA;AAAA,EAEX,MAAA,EAAQ,QAAA;AAAA;AAAA,EAER,QAAA,EAAU;AACZ;;;ACpDO,IAAM,QAAA,GAAW;AAAA;AAAA,EAEtB,eAAA,EAAiB,CAAA;AAAA;AAAA,EAGjB,eAAA,EAAiB,QAAA;AAAA;AAAA,EAGjB,QAAA,EAAU,EAAA;AAAA;AAAA,EAGV,eAAA,EAAiB,QAAA;AAAA;AAAA,EAGjB,QAAA,EAAU,KAAA;AAAA;AAAA,EAGV,eAAA,EAAiB,MAAA;AAAA;AAAA,EAGjB,OAAA,EAAS,GAAA;AAAA;AAAA,EAGT,WAAA,EAAa,KAAA;AAAA;AAAA,EAGb,IAAA,EAAM,IAAA;AAAA;AAAA,EAGN,WAAA,EAAa;AACf","file":"index.js","sourcesContent":["/**\n * Enum representing the different roles a user can have within the system.\n * @description Roles are used to determine access levels, permissions, and user-specific experiences.\n *\n * @example\n * ```typescript\n * import { USER_ROLE } from '@plyaz/types';\n *\n * const userRole = USER_ROLE.Athlete; // 'athlete'\n * const isAdmin = userRole === USER_ROLE.Admin || userRole === USER_ROLE.SuperAdmin;\n * ```\n */\nexport const USER_ROLE = {\n  /** A user who is an athlete and participates in sports activities. */\n  Athlete: 'athlete',\n\n  /** A user who scouts and discovers talent. */\n  Scout: 'scout',\n\n  /** A user who acts as an agent representing athletes or clubs. */\n  Agent: 'agent',\n\n  /** A user representing a sports club or organization. */\n  Club: 'club',\n\n  /** A fan or supporter of athletes or clubs. */\n  Fan: 'fan',\n\n  /** A system administrator with access to management tools. */\n  Admin: 'admin',\n\n  /** A super admin with the highest level of access and control. */\n  SuperAdmin: 'super.admin',\n} as const;\n\n/**\n * Enum representing the current status of a user account.\n * @description Statuses are used to determine login availability, visibility, and user flow.\n *\n * @example\n * ```typescript\n * import { USER_STATUS } from '@plyaz/types';\n *\n * const isAccessible = status === USER_STATUS.Active;\n * const needsReview = status === USER_STATUS.Pending;\n * ```\n */\nexport const USER_STATUS = {\n  /** Active user with full access. */\n  Active: 'active',\n\n  /** Inactive user, typically not currently using the platform. */\n  Inactive: 'inactive',\n\n  /** User account is awaiting approval or completion of setup. */\n  Pending: 'pending',\n\n  /** User has been temporarily suspended due to policy violations or manual review. */\n  Suspended: 'suspended',\n\n  /** User has been permanently banned from the platform. */\n  Banned: 'banned',\n} as const;\n\n/**\n * Enum representing the supported authentication providers for user login.\n * @description Auth Providers allowed such as Email, Wallet, etc.\n *\n * @example\n * ```typescript\n * import { AUTH_PROVIDER } from '@plyaz/types';\n *\n * const provider = AUTH_PROVIDER.Wallet; // 'wallet'\n * const isWeb3Auth = provider === AUTH_PROVIDER.Wallet;\n * ```\n */\nexport const AUTH_PROVIDER = {\n  /** Authentication via email and password. */\n  Email: 'email',\n\n  /** Authentication via connected blockchain wallet. */\n  Wallet: 'wallet',\n} as const;\n","/**\n * Enum representing standardized error types used across the application.\n * @description These error types help classify different categories of errors such as validation issues and system-level failures.\n *\n * @example\n * ```typescript\n * import { ERROR_TYPE } from '@plyaz/types';\n *\n * const errorType = ERROR_TYPE.ValidationError; // 'validation.error'\n *\n * // Error handling example\n * if (error.type === ERROR_TYPE.RateLimitExceeded) {\n *   // Handle rate limiting\n * }\n * ```\n */\nexport const ERROR_TYPE = {\n  /** A general validation error (e.g., form or input errors). */\n  ValidationError: 'validation.error',\n\n  /** Error related to schema validation, such as JSON schema or API payload checks. */\n  SchemaValidationError: 'validation.schema.error',\n\n  /** Unhandled or unexpected system error. */\n  InternalError: 'system.internal.error',\n\n  /** System dependency is currently unavailable (e.g., database or external API). */\n  ServiceUnavailable: 'system.service.unavailable',\n\n  /** The request took too long and timed out. */\n  TimeoutError: 'system.timeout',\n\n  /** Too many requests made in a short period of time. */\n  RateLimitExceeded: 'system.rate.limit.exceeded',\n} as const;\n\n/**\n * Enum representing the severity level of an error.\n * @description This allows categorization of errors by their potential impact on the system or user.\n *\n * @example\n * ```typescript\n * import { ERROR_SEVERITY } from '@plyaz/types';\n *\n * const severity = ERROR_SEVERITY.Critical; // 'critical'\n * const shouldAlert = severity === ERROR_SEVERITY.High || severity === ERROR_SEVERITY.Critical;\n * ```\n */\nexport const ERROR_SEVERITY = {\n  /** Low severity - does not impact functionality significantly. */\n  Low: 'low',\n\n  /** Medium severity - minor disruption or warning. */\n  Medium: 'medium',\n\n  /** High severity - major issue requiring attention. */\n  High: 'high',\n\n  /** Critical severity - blocking or crashing issue. */\n  Critical: 'critical',\n} as const;\n\n/**\n * Enum representing the category or origin of an error.\n * @description Useful for filtering or logging errors based on their source or nature.\n *\n * @example\n * ```typescript\n * import { ERROR_CATEGORY } from '@plyaz/types';\n *\n * const category = ERROR_CATEGORY.Blockchain; // 'blockchain'\n * const isClientError = category === ERROR_CATEGORY.Client;\n * ```\n */\nexport const ERROR_CATEGORY = {\n  /** Client-side error (e.g., invalid request). */\n  Client: 'client',\n\n  /** Server-side error (e.g., logic failure or exception). */\n  Server: 'server',\n\n  /** Network-related error (e.g., unreachable endpoint). */\n  Network: 'network',\n\n  /** Blockchain-related error (e.g., transaction failure, gas limit). */\n  Blockchain: 'blockchain',\n\n  // Validation-specific error (e.g., failed constraints or field errors).\n  Validation: 'validation',\n} as const;\n","/**\n * Enum representing the types of events in the application.\n * Uses dot notation for event naming convention.\n *\n * @example\n * ```typescript\n * import { EVENT_TYPE } from '@plyaz/types';\n *\n * const eventType = EVENT_TYPE.AppInit; // 'app.init'\n * ```\n */\nexport const EVENT_TYPE = {\n  /** Application initialization event. */\n  AppInit: 'app.init',\n} as const;\n\n/**\n * Const representing the priority levels for events.\n * Used to determine processing order and resource allocation.\n *\n * @example\n * ```typescript\n * import { EVENT_PRIORITY } from '@plyaz/types';\n *\n * const priority = EVENT_PRIORITY.High; // 'high'\n * ```\n */\nexport const EVENT_PRIORITY = {\n  /** Low priority event. */\n  Low: 'low',\n  /** Normal priority event. */\n  Normal: 'normal',\n  /** High priority event. */\n  High: 'high',\n  /** Critical priority event. */\n  Critical: 'critical',\n} as const;\n\n/**\n * Const representing the status of an event.\n * Tracks the lifecycle of event processing from creation to completion.\n *\n * @example\n * ```typescript\n * import { EVENT_STATUS } from '@plyaz/types';\n *\n * const status = EVENT_STATUS.Processing; // 'processing'\n *\n * // Typical event lifecycle:\n * // Pending -> Processing -> Completed\n * // or\n * // Pending -> Processing -> Failed -> Retrying -> Processing -> Completed\n * ```\n */\nexport const EVENT_STATUS = {\n  /** Event is pending and has not started processing. */\n  Pending: 'pending',\n  /** Event is currently being processed. */\n  Processing: 'processing',\n  /** Event has been completed successfully. */\n  Completed: 'completed',\n  /** Event processing failed. */\n  Failed: 'failed',\n  /** Event is being retried after a failure. */\n  Retrying: 'retrying',\n} as const;\n","/**\n * Enum representing supported EVM-compatible blockchain networks by their numeric chain IDs.\n * @description These IDs are used to identify the specific network when interacting with wallets or smart contracts.\n * @see https://chainlist.org for reference chain IDs\n *\n * @example\n * ```typescript\n * import { CHAIN_ID } from '@plyaz/types';\n *\n * const chainId = CHAIN_ID.EthereumMainnet; // 1\n * const isTestnet = chainId === CHAIN_ID.EthereumSepolia || chainId === CHAIN_ID.PolygonAmoy;\n * ```\n */\nexport const CHAIN_ID = {\n  /** Ethereum Mainnet (Chain ID: 1). */\n  EthereumMainnet: 1,\n\n  /** Ethereum Sepolia Testnet (Chain ID: 11155111). */\n  EthereumSepolia: 11_155_111,\n\n  /** Optimism Mainnet (Chain ID: 10). */\n  Optimism: 10,\n\n  /** Optimism Sepolia Testnet (Chain ID: 11155420). */\n  OptimismSepolia: 11_155_420,\n\n  /** Arbitrum One Mainnet (Chain ID: 42161). */\n  Arbitrum: 42_161,\n\n  /** Arbitrum Sepolia Testnet (Chain ID: 421614). */\n  ArbitrumSepolia: 421_614,\n\n  /** Polygon Mainnet (Chain ID: 137). */\n  Polygon: 137,\n\n  /** Polygon Amoy Testnet (Chain ID: 80002). */\n  PolygonAmoy: 80_002,\n\n  /** Base Mainnet (Chain ID: 8453). */\n  Base: 8_453,\n\n  /** Base Sepolia Testnet (Chain ID: 84532). */\n  BaseSepolia: 84_532,\n} as const;\n"]}

package/dist/lib/index.d.ts

@@ -0,0 +1 @@
+export type { Primitive, Class, Constructor, AbstractClass, AbstractConstructor, TypedArray, ObservableLike, Simplify, SimplifyDeep, Jsonify, Jsonifiable, JsonObject, JsonArray, JsonValue, JsonPrimitive, Merge, MergeDeep, MergeExclusive, RequireAtLeastOne, RequireExactlyOne, RequireAllOrNone, PickIndexSignature, PartialDeep, RequiredDeep, ReadonlyDeep, CamelCase, CamelCasedProperties, CamelCasedPropertiesDeep, KebabCase, KebabCasedProperties, KebabCasedPropertiesDeep, PascalCase, PascalCasedProperties, PascalCasedPropertiesDeep, SnakeCase, SnakeCasedProperties, SnakeCasedPropertiesDeep, DelimiterCase, DelimiterCasedProperties, DelimiterCasedPropertiesDeep, Opaque, UnwrapOpaque, Tagged, UnwrapTagged, Includes, Join, Split, Trim, Replace, AsyncReturnType, Asyncify, IsEqual, IsAny, IsNever, IsUnknown, UnknownRecord, EmptyObject, IsEmptyObject, SetOptional, SetReadonly, SetRequired, SetNonNullable, ConditionalExcept, ConditionalKeys, ConditionalPick, Except, Writable, WritableDeep, Paths, IterableElement, Entries, SetReturnType, SetParameterType, Promisable, PackageJson, TsConfigJson, } from 'type-fest';

package/dist/testing/common/assertions/types.d.ts

@@ -3,135 +3,354 @@
  *
  * Type definitions for assertion utilities.
  */
+/**
+ * Pattern for matching HTTP errors with status code and message.
+ * Used in testing to assert specific error responses.
+ *
+ * @example
+ * ```typescript
+ * const pattern: ErrorPattern = {
+ *   status: 404,
+ *   message: /resource not found/i
+ * };
+ * ```
+ */
 export interface ErrorPattern {
+    /** HTTP status code to match */
     status: number;
+    /** Regular expression to match against error message */
     message: RegExp;
 }
+/**
+ * Pattern for matching validation errors with status and field errors.
+ * Used to assert specific validation failures in API responses.
+ *
+ * @example
+ * ```typescript
+ * const pattern: ValidationErrorPattern = {
+ *   status: 400,
+ *   validation: ['email', 'password']
+ * };
+ * ```
+ */
 export interface ValidationErrorPattern {
+    /** HTTP status code (typically 400 for validation errors) */
     status: number;
+    /** Array of field names that failed validation */
     validation: string[];
 }
+/**
+ * Simple pattern for matching error messages.
+ * Used when only the message content needs to be validated.
+ */
 export interface ErrorMessagePattern {
+    /** Regular expression to match against error message */
     message: RegExp;
 }
+/**
+ * Statistics tracking error occurrences.
+ * Useful for monitoring error rates in tests.
+ */
 export interface ErrorStats {
+    /** Total number of failed operations */
     failures: number;
+    /** Total number of successful operations */
     successes: number;
+    /** The most recent error that occurred */
     lastFailure?: Error;
 }
+/**
+ * Entry in an error timeline tracking when errors occurred.
+ * Used for debugging error patterns over time.
+ */
 export interface ErrorTimelineEntry {
+    /** Unix timestamp when the error occurred */
     timestamp: number;
+    /** The error that occurred */
     error: Error;
+    /** Additional context data at the time of error */
     context?: Record<string, unknown>;
 }
+/**
+ * Expected error pattern for validation.
+ * Used to define what errors should be thrown in test scenarios.
+ *
+ * @example
+ * ```typescript
+ * const expected: ExpectedError = {
+ *   message: /unauthorized/i,
+ *   type: UnauthorizedError
+ * };
+ * ```
+ */
 export interface ExpectedError {
+    /** Expected error message (string or pattern) */
     message?: string | RegExp;
+    /** Expected error constructor/type */
     type?: new (...args: unknown[]) => unknown;
 }
+/**
+ * Validation response containing an array of error messages.
+ * Common pattern for form validation results.
+ */
 export interface ValidationResponse {
+    /** Array of validation error messages */
     message?: unknown[];
 }
+/**
+ * Result type for hooks that return a value.
+ * Wraps the value in a current ref pattern.
+ *
+ * @template T - The type of the value
+ */
 export interface HookResultValue<T> {
+    /** Current ref containing the value */
     current: {
         value: T;
     };
 }
+/**
+ * Result type for hooks that track loading state.
+ * Used to assert loading states in async operations.
+ */
 export interface HookResultLoading {
+    /** Current ref containing loading state */
     current: {
         isLoading: boolean;
     };
 }
+/**
+ * Result type for hooks that track error state.
+ * Used to assert error handling in hooks.
+ */
 export interface HookResultError {
+    /** Current ref containing error state */
     current: {
         error: Error | null;
     };
 }
+/**
+ * Result of an error recovery operation.
+ * Tracks both the original error and recovery outcome.
+ */
 export interface ErrorRecoveryResult {
+    /** The original error that triggered recovery */
     error: Error;
+    /** Result of the recovery attempt */
     recoveryResult: unknown;
 }
+/**
+ * Entry for correlating errors with additional context.
+ * Used in error tracking and debugging systems.
+ */
 export interface ErrorCorrelationEntry {
+    /** The error being tracked */
     error: Error;
+    /** Additional metadata for correlation */
     metadata?: Record<string, unknown>;
 }
+/**
+ * Definition of an error test scenario.
+ * Used to parameterize error testing across multiple cases.
+ */
 export interface ErrorTestScenario {
+    /** Descriptive name for the test scenario */
     name: string;
+    /** Function that should trigger the error */
     fn: () => unknown | Promise<unknown>;
+    /** Expected error or error pattern */
     expectedError: unknown;
+    /** Whether to skip this scenario */
     skip?: boolean;
 }
+/**
+ * Configuration options for circuit breaker pattern.
+ * Used to prevent cascading failures in test scenarios.
+ *
+ * @example
+ * ```typescript
+ * const options: CircuitBreakerOptions = {
+ *   failureThreshold: 5,
+ *   resetTimeout: 30000,
+ *   onOpen: () => console.log('Circuit opened'),
+ *   onClose: () => console.log('Circuit closed')
+ * };
+ * ```
+ */
 export interface CircuitBreakerOptions {
+    /** Number of failures before opening circuit */
     failureThreshold: number;
+    /** Time in ms before attempting to close circuit */
     resetTimeout: number;
+    /** Callback when circuit opens */
     onOpen?: () => void;
+    /** Callback when circuit closes */
     onClose?: () => void;
+    /** Callback when circuit enters half-open state */
     onHalfOpen?: () => void;
 }
+/**
+ * Result of testing error propagation through system.
+ * Tracks how errors flow through multiple layers.
+ *
+ * @template T - Type of intermediate results
+ */
 export interface ErrorPropagationTestResult<T> {
+    /** Number of layers the error propagated through */
     propagatedTo: number;
+    /** The final error after all transformations */
     finalError: Error;
+    /** Results from each layer (success or error) */
     intermediateResults: Array<T | Error>;
 }
+/**
+ * Circuit breaker implementation for error handling.
+ * Prevents repeated failures by temporarily blocking operations.
+ *
+ * @template T - Return type of protected operations
+ */
 export interface ErrorCircuitBreaker<T> {
+    /** Execute function with circuit breaker protection */
     execute: (fn: () => T | Promise<T>) => Promise<T>;
+    /** Get current circuit state */
     getState: () => 'closed' | 'open' | 'half-open';
+    /** Get error statistics */
     getStats: () => ErrorStats;
+    /** Reset circuit to closed state */
     reset: () => void;
 }
+/**
+ * Interface for correlating related errors.
+ * Helps track error chains and related failures.
+ */
 export interface ErrorCorrelator {
+    /** Create correlation ID for an error */
     correlate: (error: Error, metadata?: Record<string, unknown>) => string;
+    /** Get all errors with same correlation ID */
     getRelated: (correlationId: string) => Array<ErrorCorrelationEntry>;
+    /** Get chain of errors leading to this one */
     getChain: (error: Error) => Array<ErrorCorrelationEntry>;
 }
+/**
+ * Interface for collecting error metrics.
+ * Provides insights into error patterns and rates.
+ */
 export interface ErrorMetrics {
+    /** Record an error occurrence */
     record: (error: Error, context?: Record<string, unknown>) => void;
+    /** Get aggregated error metrics */
     getMetrics: () => {
+        /** Total error count */
         total: number;
+        /** Errors grouped by type/constructor */
         byType: Record<string, number>;
+        /** Errors grouped by message */
         byMessage: Record<string, number>;
+        /** Chronological error timeline */
         timeline: Array<ErrorTimelineEntry>;
+        /** Calculate error rate for time window */
         errorRate: (windowMs: number) => number;
     };
+    /** Reset all metrics */
     reset: () => void;
 }
+/**
+ * Interface for deduplicating similar errors.
+ * Prevents noise from repeated identical errors.
+ */
 export interface ErrorDeduplicator {
+    /** Check if error is duplicate of previously seen */
     isDuplicate: (error: Error) => boolean;
+    /** Record error for deduplication tracking */
     record: (error: Error) => void;
+    /** Get list of unique errors seen */
     getUniqueErrors: () => Error[];
+    /** Reset deduplication tracking */
     reset: () => void;
 }
+/**
+ * Simple error interface with message property.
+ * Used for type guards and error handling.
+ */
 export interface ErrorWithMessage {
+    /** Error message */
     message: string;
 }
+/**
+ * Error interface that includes HTTP response data.
+ * Common in API error handling scenarios.
+ */
 export interface ErrorWithResponse {
+    /** Method to retrieve response data */
     getResponse?: () => unknown;
+    /** Direct response data property */
     response?: unknown;
 }
+/**
+ * Validation message structure for field-level errors.
+ * Commonly used in form validation responses.
+ */
 export interface ValidationMessage {
+    /** Property/field that failed validation */
     property?: string;
+    /** Map of constraint names to error messages */
     constraints?: Record<string, string>;
 }
+/**
+ * Expected HTTP exception pattern for testing.
+ * Used to assert specific HTTP error responses.
+ */
 export interface ExpectedHttpException {
+    /** Expected HTTP status code */
     status?: number;
+    /** Expected error message or pattern */
     message?: string | RegExp;
+    /** Expected response body */
     response?: unknown;
 }
+/**
+ * Expected service-level error pattern.
+ * Used for testing business logic errors.
+ */
 export interface ExpectedServiceError {
+    /** Expected error message or pattern */
     message?: string | RegExp;
+    /** Expected error constructor/type */
     type?: new (...args: unknown[]) => unknown;
 }
+/**
+ * Configuration for injecting errors during propagation tests.
+ * Allows testing error handling at specific points.
+ */
 export interface ErrorPropagationInjection {
+    /** Step number where error should be injected */
     atStep: number;
+    /** Error to inject at specified step */
     error: Error;
 }
+/**
+ * Context data for enriching errors with additional information.
+ * Helps with debugging and error tracking.
+ */
 export interface ErrorEnrichmentContext {
+    /** Operation being performed when error occurred */
     operation?: string;
+    /** User identifier associated with error */
     user?: string;
+    /** Timestamp of error occurrence */
     timestamp?: number;
+    /** Request ID for tracing */
     requestId?: string;
+    /** Additional metadata */
     metadata?: Record<string, unknown>;
 }
+/**
+ * Configuration options for error deduplication.
+ * Controls how errors are identified as duplicates.
+ */
 export interface ErrorDeduplicatorOptions {
+    /** Function to generate deduplication key from error */
     keyFn?: (error: Error) => string;
+    /** Time window in ms for considering errors as duplicates */
     windowMs?: number;
 }

package/dist/testing/features/feature-flags/types.d.ts

@@ -1033,101 +1033,247 @@ export interface FeatureFlagPerformanceMetrics {
     /** Total operations measured */
     total: number;
 }
+/**
+ * Result of feature flag load testing.
+ * Contains performance metrics and any errors encountered.
+ */
 export interface FeatureFlagLoadTestResult {
+    /** Total test duration in milliseconds */
     duration: number;
+    /** Array of errors encountered during load test */
     errors: Error[];
 }
+/**
+ * Controllable feature flag provider for testing.
+ * Allows manual control over provider method resolution.
+ *
+ * @template FeatureFlagKey - Type of feature flag keys
+ */
 export interface ControllableProvider<FeatureFlagKey extends string> {
+    /** The wrapped provider instance */
     provider: IFeatureFlagProvider<FeatureFlagKey>;
+    /** Control methods for test manipulation */
     control: {
+        /** Resolve a specific method call */
         resolveMethod: (method: string) => void;
+        /** Reject a specific method call with error */
         rejectMethod: (method: string, error: Error) => void;
+        /** Resolve all pending method calls */
         resolveAll: () => void;
+        /** Reject all pending method calls */
         rejectAll: (error: Error) => void;
+        /** Reset control state */
         reset: () => void;
     };
 }
+/**
+ * Tracker for feature flag subscription testing.
+ * Monitors subscription lifecycle and callback invocations.
+ *
+ * @template FeatureFlagKey - Type of feature flag keys
+ */
 export interface SubscriptionFeatureFlagTracker<FeatureFlagKey extends string> {
+    /** Track a new subscription */
     track: (provider: IFeatureFlagProvider<FeatureFlagKey>, id?: string) => {
         id: string;
         callback: Vitest.Mock;
         unsubscribe: () => void;
     };
+    /** Unsubscribe by ID */
     unsubscribe: (id: string) => void;
+    /** Unsubscribe all tracked subscriptions */
     unsubscribeAll: () => void;
+    /** Get call count for subscription */
     getCallCount: (id: string) => number;
+    /** Get last call arguments for subscription */
     getLastCall: (id: string) => unknown;
+    /** Reset all tracking data */
     reset: () => void;
 }
+/**
+ * Assertions for feature flag evaluation results.
+ * Provides chainable assertions for testing evaluations.
+ */
 export interface EvaluationAssertions {
+    /** Assert evaluation has expected value */
     hasValue: (expected: unknown) => void;
+    /** Assert evaluation has expected reason */
     hasReason: (expected: string) => void;
+    /** Assert evaluation has expected source */
     hasSource: (expected: string) => void;
+    /** Assert evaluation has expected rule ID */
     hasRuleId: (expected: string) => void;
+    /** Assert evaluation occurred within time window */
     wasEvaluatedRecently: (maxAgeMs?: number) => void;
 }
+/**
+ * Props for test feature flag provider component.
+ * Configures provider behavior for testing scenarios.
+ *
+ * @template FeatureFlagKey - Type of feature flag keys
+ */
 export interface TestFeatureFlagProviderProps<FeatureFlagKey extends string> {
+    /** Feature flag provider instance */
     provider: IFeatureFlagProvider<FeatureFlagKey>;
+    /** Child components to render */
     children: React.ReactNode;
+    /** Optional custom context */
     context?: React.Context<FeatureFlagContextValue<FeatureFlagKey> | null>;
 }
+/**
+ * Options for creating a test feature flag provider.
+ * Allows customization of provider setup for tests.
+ *
+ * @template FeatureFlagKey - Type of feature flag keys
+ */
 export interface CreateProviderForTestOptions<FeatureFlagKey extends string> {
+    /** Existing provider to use */
     provider?: IFeatureFlagProvider<FeatureFlagKey>;
+    /** Configuration overrides */
     config?: Partial<FeatureFlagConfig<FeatureFlagKey>>;
+    /** Flag values by string key */
     flags?: Record<string, FeatureFlagValue>;
+    /** Flag values by typed key */
     features?: Record<FeatureFlagKey, FeatureFlagValue>;
+    /** Custom provider class constructor */
     ProviderClass?: new (config: FeatureFlagConfig<FeatureFlagKey>, features: Record<FeatureFlagKey, FeatureFlagValue>) => IFeatureFlagProvider<FeatureFlagKey>;
 }
+/**
+ * Options for setting up feature flag testing environment.
+ * Configures test suite with feature flag capabilities.
+ *
+ * @template FeatureFlagKey - Type of feature flag keys
+ */
 export interface SetupFeatureFlagTestOptions<FeatureFlagKey extends string> {
+    /** Provider instance to use */
     provider?: IFeatureFlagProvider<FeatureFlagKey>;
+    /** Configuration overrides */
     config?: Partial<FeatureFlagConfig<FeatureFlagKey>>;
+    /** Flag values by string key */
     flags?: Record<string, FeatureFlagValue>;
+    /** Setup before each test */
     setupBeforeEach?: boolean;
+    /** Auto-initialize provider */
     autoInit: boolean;
+    /** Custom React context */
     context?: React.Context<FeatureFlagContextValue<FeatureFlagKey> | null>;
+    /** Custom provider class */
     ProviderClass?: new (config: FeatureFlagConfig<FeatureFlagKey>, features: Record<FeatureFlagKey, FeatureFlagValue>) => IFeatureFlagProvider<FeatureFlagKey>;
+    /** Flag values by typed key */
     features?: Record<FeatureFlagKey, FeatureFlagValue>;
 }
+/**
+ * Scenario for testing percentage-based rollouts.
+ * Validates rollout distribution across users.
+ *
+ * @template FeatureFlagKey - Type of feature flag keys
+ */
 export interface PercentageRolloutScenario<FeatureFlagKey extends string> {
+    /** Rollout rule configuration */
     rule: FeatureFlagRule<FeatureFlagKey>;
+    /** Test user IDs */
     users: string[];
+    /** Expected number of enabled users */
     expectedEnabled: number;
+    /** Evaluate if user should be enabled */
     evaluate: (userId: string) => boolean;
 }
+/**
+ * Scenario for testing time-based feature rollouts.
+ * Validates feature activation based on time windows.
+ *
+ * @template FeatureFlagKey - Type of feature flag keys
+ */
 export interface TimeBasedRolloutScenario<FeatureFlagKey extends string> {
+    /** Time-based rule configuration */
     rule: FeatureFlagRule<FeatureFlagKey>;
+    /** Check if feature is active at given time */
     isActive: (date?: Date) => boolean;
 }
+/**
+ * Scenario for testing user-targeted features.
+ * Validates feature targeting specific users.
+ *
+ * @template FeatureFlagKey - Type of feature flag keys
+ */
 export interface TargetedUsersScenario<FeatureFlagKey extends string> {
+    /** Targeting rule configuration */
     rule: FeatureFlagRule<FeatureFlagKey>;
+    /** Check if user is targeted */
     isTargeted: (userId: string) => boolean;
 }
+/**
+ * Scenario for testing A/B test configurations.
+ * Validates variant distribution and assignment.
+ *
+ * @template FeatureFlagKey - Type of feature flag keys
+ */
 export interface ABTestScenario<FeatureFlagKey extends string> {
+    /** A/B test rules */
     rules: FeatureFlagRule<FeatureFlagKey>[];
+    /** Available variants */
     variants: Record<string, FeatureFlagValue>;
+    /** Expected distribution percentages */
     distribution: Record<string, number>;
+    /** Assign variant to user */
     assignVariant: (userId: string) => string;
 }
+/**
+ * Scenario for testing complex rule combinations.
+ * Validates feature behavior with multiple rules.
+ *
+ * @template FeatureFlagKey - Type of feature flag keys
+ */
 export interface ComplexRulesScenario<FeatureFlagKey extends string> {
+    /** Complex rule set */
     rules: FeatureFlagRule<FeatureFlagKey>[];
+    /** Evaluate rules with context */
     evaluate: (context: FeatureFlagContext) => FeatureFlagEvaluation<FeatureFlagKey>;
 }
+/**
+ * Mock provider with exposed internal state.
+ * Allows direct state manipulation in tests.
+ *
+ * @template FeatureFlagKey - Type of feature flag keys
+ */
 export interface MockFeatureFlagProviderWithState<FeatureFlagKey extends string> extends IFeatureFlagProvider<FeatureFlagKey> {
+    /** Exposed mock state for testing */
     _mockState: {
+        /** Flag definitions */
         flags: Map<FeatureFlagKey, FeatureFlag<FeatureFlagKey>>;
+        /** Value overrides */
         overrides: Map<FeatureFlagKey, FeatureFlagValue>;
+        /** Active subscribers */
         subscribers: Set<(flags: FeatureFlag<FeatureFlagKey>[]) => void>;
     };
 }
+/**
+ * Test-specific feature flag context value.
+ * Enhanced context for testing scenarios.
+ *
+ * @template FeatureFlagKey - Type of feature flag keys
+ */
 export interface TestFeatureFlagContextValue<FeatureFlagKey extends string> {
+    /** Provider instance */
     provider: IFeatureFlagProvider<FeatureFlagKey>;
+    /** Initialization status */
     isInitialized: boolean;
+    /** Loading state */
     isLoading: boolean;
+    /** Current error if any */
     error: Error | null;
+    /** Last update timestamp */
     lastUpdated: Date;
+    /** Force refresh flags */
     refresh: () => Promise<void>;
 }
+/**
+ * Options for waiting for flag value changes.
+ * Used in async flag testing scenarios.
+ */
 export interface WaitForFlagValueOptions {
+    /** Evaluation context */
     context?: FeatureFlagContext;
+    /** Maximum wait time in ms */
     timeout?: number;
 }

package/dist/web3/enums.d.ts

@@ -2,16 +2,34 @@
  * Enum representing supported EVM-compatible blockchain networks by their numeric chain IDs.
  * @description These IDs are used to identify the specific network when interacting with wallets or smart contracts.
  * @see https://chainlist.org for reference chain IDs
+ *
+ * @example
+ * ```typescript
+ * import { CHAIN_ID } from '@plyaz/types';
+ *
+ * const chainId = CHAIN_ID.EthereumMainnet; // 1
+ * const isTestnet = chainId === CHAIN_ID.EthereumSepolia || chainId === CHAIN_ID.PolygonAmoy;
+ * ```
  */
 export declare const CHAIN_ID: {
+    /** Ethereum Mainnet (Chain ID: 1). */
     readonly EthereumMainnet: 1;
+    /** Ethereum Sepolia Testnet (Chain ID: 11155111). */
     readonly EthereumSepolia: 11155111;
+    /** Optimism Mainnet (Chain ID: 10). */
     readonly Optimism: 10;
+    /** Optimism Sepolia Testnet (Chain ID: 11155420). */
     readonly OptimismSepolia: 11155420;
+    /** Arbitrum One Mainnet (Chain ID: 42161). */
     readonly Arbitrum: 42161;
+    /** Arbitrum Sepolia Testnet (Chain ID: 421614). */
     readonly ArbitrumSepolia: 421614;
+    /** Polygon Mainnet (Chain ID: 137). */
     readonly Polygon: 137;
+    /** Polygon Amoy Testnet (Chain ID: 80002). */
     readonly PolygonAmoy: 80002;
+    /** Base Mainnet (Chain ID: 8453). */
     readonly Base: 8453;
+    /** Base Sepolia Testnet (Chain ID: 84532). */
     readonly BaseSepolia: 84532;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plyaz/types",
-  "version": "1.3.4",
+  "version": "1.3.6",
   "author": "Redeemer Pace",
   "license": "ISC",
   "description": "Provides shared TypeScript types and schema utilities for validation and parsing in the @playz ecosystem.",