@plyaz/types 1.5.3 → 1.5.5

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":";;;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"]}
+{"version":3,"sources":["../src/auth/enums.ts","../src/errors/enums.ts","../src/events/enums.ts","../src/web3/enums.ts"],"names":[],"mappings":";;;AAYO,IAAM,SAAY,GAAA;AAAA;AAAA,EAEvB,OAAS,EAAA,SAAA;AAAA;AAAA,EAGT,KAAO,EAAA,OAAA;AAAA;AAAA,EAGP,KAAO,EAAA,OAAA;AAAA;AAAA,EAGP,IAAM,EAAA,MAAA;AAAA;AAAA,EAGN,GAAK,EAAA,KAAA;AAAA;AAAA,EAGL,KAAO,EAAA,OAAA;AAAA;AAAA,EAGP,UAAY,EAAA;AACd;AAcO,IAAM,WAAc,GAAA;AAAA;AAAA,EAEzB,MAAQ,EAAA,QAAA;AAAA;AAAA,EAGR,QAAU,EAAA,UAAA;AAAA;AAAA,EAGV,OAAS,EAAA,SAAA;AAAA;AAAA,EAGT,SAAW,EAAA,WAAA;AAAA;AAAA,EAGX,MAAQ,EAAA;AACV;AAcO,IAAM,aAAgB,GAAA;AAAA;AAAA,EAE3B,KAAO,EAAA,OAAA;AAAA;AAAA,EAGP,MAAQ,EAAA;AACV;;;AClEO,IAAM,UAAa,GAAA;AAAA;AAAA,EAExB,eAAiB,EAAA,kBAAA;AAAA;AAAA,EAGjB,qBAAuB,EAAA,yBAAA;AAAA;AAAA,EAGvB,aAAe,EAAA,uBAAA;AAAA;AAAA,EAGf,kBAAoB,EAAA,4BAAA;AAAA;AAAA,EAGpB,YAAc,EAAA,gBAAA;AAAA;AAAA,EAGd,iBAAmB,EAAA;AACrB;AAcO,IAAM,cAAiB,GAAA;AAAA;AAAA,EAE5B,GAAK,EAAA,KAAA;AAAA;AAAA,EAGL,MAAQ,EAAA,QAAA;AAAA;AAAA,EAGR,IAAM,EAAA,MAAA;AAAA;AAAA,EAGN,QAAU,EAAA;AACZ;AAcO,IAAM,cAAiB,GAAA;AAAA;AAAA,EAE5B,MAAQ,EAAA,QAAA;AAAA;AAAA,EAGR,MAAQ,EAAA,QAAA;AAAA;AAAA,EAGR,OAAS,EAAA,SAAA;AAAA;AAAA,EAGT,UAAY,EAAA,YAAA;AAAA;AAAA,EAGZ,UAAY,EAAA;AACd;;;AC9EO,IAAM,UAAa,GAAA;AAAA;AAAA,EAExB,OAAS,EAAA;AACX;AAaO,IAAM,cAAiB,GAAA;AAAA;AAAA,EAE5B,GAAK,EAAA,KAAA;AAAA;AAAA,EAEL,MAAQ,EAAA,QAAA;AAAA;AAAA,EAER,IAAM,EAAA,MAAA;AAAA;AAAA,EAEN,QAAU,EAAA;AACZ;AAkBO,IAAM,YAAe,GAAA;AAAA;AAAA,EAE1B,OAAS,EAAA,SAAA;AAAA;AAAA,EAET,UAAY,EAAA,YAAA;AAAA;AAAA,EAEZ,SAAW,EAAA,WAAA;AAAA;AAAA,EAEX,MAAQ,EAAA,QAAA;AAAA;AAAA,EAER,QAAU,EAAA;AACZ;;;ACpDO,IAAM,QAAW,GAAA;AAAA;AAAA,EAEtB,eAAiB,EAAA,CAAA;AAAA;AAAA,EAGjB,eAAiB,EAAA,QAAA;AAAA;AAAA,EAGjB,QAAU,EAAA,EAAA;AAAA;AAAA,EAGV,eAAiB,EAAA,QAAA;AAAA;AAAA,EAGjB,QAAU,EAAA,KAAA;AAAA;AAAA,EAGV,eAAiB,EAAA,MAAA;AAAA;AAAA,EAGjB,OAAS,EAAA,GAAA;AAAA;AAAA,EAGT,WAAa,EAAA,KAAA;AAAA;AAAA,EAGb,IAAM,EAAA,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/testing/common/utils/types.d.ts

@@ -2415,25 +2415,75 @@ export interface NextPageResult {
     };
     notFound?: boolean;
 }
+/**
+ * Result of a mocked function call.
+ * Captures arguments, return value, and any errors.
+ *
+ * @example
+ * ```typescript
+ * const result: MockCallResult = {
+ *   args: ['user123', { name: 'John' }],
+ *   result: { id: 1, success: true },
+ *   error: undefined
+ * };
+ * ```
+ */
 export interface MockCallResult {
     args: unknown[];
     result: unknown;
     error?: unknown;
 }
+/**
+ * File system watcher mock for testing file change events.
+ * Simulates file watching with change, add, and unlink events.
+ *
+ * @example
+ * ```typescript
+ * const watcher: FileWatcher = createFileWatcher();
+ * watcher.simulateChange('/src/app.ts');
+ * watcher.simulateAdd('/src/new-file.ts');
+ * watcher.simulateUnlink('/src/deleted.ts');
+ * watcher.close();
+ * ```
+ */
 export interface FileWatcher extends MockEventEmitter {
     add: Vitest.Mock;
     unwatch: Vitest.Mock;
-    close: Vitest.Mock;
+    close: () => void;
     getWatched: Vitest.Mock;
     simulateChange: (path: string) => void;
     simulateAdd: (path: string) => void;
     simulateUnlink: (path: string) => void;
 }
+/**
+ * NestJS testing module for unit and integration tests.
+ * Provides dependency injection and module management.
+ *
+ * @example
+ * ```typescript
+ * const testBed: NestJSTestBed = await createTestBed();
+ * const service = testBed.get<UserService>(UserService);
+ * expect(service).toBeDefined();
+ * await testBed.close();
+ * ```
+ */
 export interface NestJSTestBed {
     get: <T>(token: unknown) => T;
     close: () => Promise<void>;
     moduleRef: Map<unknown, unknown>;
 }
+/**
+ * Test harness for module testing.
+ * Provides module reference and dependency resolution.
+ *
+ * @example
+ * ```typescript
+ * const harness: ModuleTestHarness = await createModuleHarness();
+ * const controller = harness.get<AppController>(AppController);
+ * const result = await controller.getData();
+ * await harness.close();
+ * ```
+ */
 export interface ModuleTestHarness {
     moduleRef: {
         get: <T>(token: unknown) => T;
@@ -2443,6 +2493,18 @@ export interface ModuleTestHarness {
     get: <T>(token: unknown) => T;
     close: () => Promise<void>;
 }
+/**
+ * Helper utilities for Next.js router testing.
+ * Provides navigation simulation and route change testing.
+ *
+ * @example
+ * ```typescript
+ * const helpers: NextRouterHelpers = createRouterHelpers();
+ * await helpers.navigateTo('/dashboard');
+ * helpers.simulateRouteChange('/home', '/about');
+ * helpers.expectNavigation('/login', 'push');
+ * ```
+ */
 export interface NextRouterHelpers {
     navigateTo: (url: string, options?: NavigationOptions) => Promise<void>;
     simulateRouteChange: (fromUrl: string, toUrl: string) => void;
@@ -2450,11 +2512,38 @@ export interface NextRouterHelpers {
     expectNavigation: (url: string, type?: 'push' | 'replace') => void;
     expectNoNavigation: () => void;
 }
+/**
+ * Complete Next.js router mock with restoration.
+ * Includes router instance and useRouter hook mock.
+ *
+ * @example
+ * ```typescript
+ * const mock: MockNextRouterReturn = mockNextRouter();
+ * mock.router.push('/new-route');
+ * const { pathname } = mock.useRouter();
+ * mock.restore();
+ * ```
+ */
 export interface MockNextRouterReturn {
     router: MockNextRouter;
     useRouter: CreateMockUseRouterReturn;
     restore: () => void;
 }
+/**
+ * Mock Next.js request object for API route testing.
+ * Simulates incoming HTTP requests with headers, body, and metadata.
+ *
+ * @example
+ * ```typescript
+ * const request: MockNextRequest = {
+ *   url: '/api/users',
+ *   method: 'POST',
+ *   headers: new Headers({ 'content-type': 'application/json' }),
+ *   body: { name: 'John' },
+ *   ip: '192.168.1.1'
+ * };
+ * ```
+ */
 export interface MockNextRequest {
     url: string;
     method: string;
@@ -2481,6 +2570,18 @@ export interface MockNextRequest {
         longitude: string;
     };
 }
+/**
+ * Mock Next.js response object for API route testing.
+ * Provides response methods for redirects, rewrites, and JSON responses.
+ *
+ * @example
+ * ```typescript
+ * const response: MockNextResponse = createMockResponse();
+ * response.status = 200;
+ * response.json({ success: true });
+ * response.redirect('/login');
+ * ```
+ */
 export interface MockNextResponse {
     cookies: {
         set: Vitest.Mock;
@@ -2493,6 +2594,18 @@ export interface MockNextResponse {
     next: Vitest.Mock;
     json: Vitest.Mock;
 }
+/**
+ * Mock WebSocket server for testing real-time connections.
+ * Simulates WebSocket server with client management and broadcasting.
+ *
+ * @example
+ * ```typescript
+ * const server: MockWebSocketServer = createMockWebSocketServer();
+ * const client = server.simulateConnection('client-1');
+ * server.simulateBroadcast({ type: 'message', data: 'Hello' });
+ * server.simulateClientDisconnect('client-1');
+ * ```
+ */
 export interface MockWebSocketServer extends MockEventEmitter {
     clients: Set<CreateMockWebSocketReturn>;
     port: number;
@@ -2507,14 +2620,52 @@ export interface MockWebSocketServer extends MockEventEmitter {
     simulateBroadcast: (data: unknown, excludeClient?: string) => void;
     simulateClientDisconnect: (clientId: string) => void;
 }
+/**
+ * Global WebSocket mock with restoration capability.
+ * Replaces global WebSocket constructor for testing.
+ *
+ * @example
+ * ```typescript
+ * const mock: MockWebSocketGlobal = mockGlobalWebSocket();
+ * const ws = new WebSocket('ws://localhost:8080');
+ * // Test WebSocket functionality
+ * mock.restore();
+ * ```
+ */
 export interface MockWebSocketGlobal {
     restore: () => void;
 }
+/**
+ * System date mock for time-based testing.
+ * Controls system time for testing time-dependent code.
+ *
+ * @example
+ * ```typescript
+ * const dateMock: MockSystemDateReturn = mockSystemDate();
+ * dateMock.setDate('2024-01-01');
+ * dateMock.advanceBy(3600000); // Advance 1 hour
+ * ```
+ */
 export interface MockSystemDateReturn {
     setDate: (newDate: Date | string | number) => void;
     advanceBy: (ms: number) => void;
 }
 export type GetStaticPathsResult = NextGetStaticPathsResult;
+/**
+ * Expectations for Next.js getStaticPaths testing.
+ * Validates static path generation behavior.
+ *
+ * @example
+ * ```typescript
+ * const expectations: GetStaticPathsExpectations = {
+ *   pathCount: 10,
+ *   fallback: 'blocking',
+ *   validatePaths: (paths) => {
+ *     expect(paths).toContainEqual({ params: { id: '1' } });
+ *   }
+ * };
+ * ```
+ */
 export interface GetStaticPathsExpectations {
     pathCount?: number;
     fallback: boolean | 'blocking';
@@ -2522,6 +2673,22 @@ export interface GetStaticPathsExpectations {
         params: Record<string, string | string[] | undefined>;
     }>) => void;
 }
+/**
+ * Image optimization test scenario.
+ * Defines expected image optimization behavior in Next.js.
+ *
+ * @example
+ * ```typescript
+ * const scenario: ImageOptimizationScenario = {
+ *   src: '/images/hero.jpg',
+ *   width: 1200,
+ *   quality: 85,
+ *   expectedUrl: '/_next/image?url=%2Fimages%2Fhero.jpg&w=1200&q=85',
+ *   alt: 'Hero image',
+ *   priority: true
+ * };
+ * ```
+ */
 export interface ImageOptimizationScenario {
     src: string;
     width: number;
@@ -2531,20 +2698,75 @@ export interface ImageOptimizationScenario {
     priority?: boolean;
     height?: number;
 }
+/**
+ * Options for drag and drop testing.
+ * Configures drag data and expected drop effects.
+ *
+ * @example
+ * ```typescript
+ * const options: DragAndDropOptions = {
+ *   dragData: { 'text/plain': 'Dragged item' },
+ *   expectedDropEffect: 'move'
+ * };
+ * ```
+ */
 export interface DragAndDropOptions {
     dragData?: Record<string, string>;
     expectedDropEffect?: 'copy' | 'move' | 'link' | 'none';
 }
+/**
+ * Options for realistic typing simulation.
+ * Simulates human-like typing with pauses and typos.
+ *
+ * @example
+ * ```typescript
+ * const options: TypeRealisticOptions = {
+ *   pauseBetweenChars: 50,
+ *   typos: true,
+ *   speed: 'normal'
+ * };
+ * ```
+ */
 export interface TypeRealisticOptions {
     pauseBetweenChars?: number;
     typos?: boolean;
     speed?: 'slow' | 'normal' | 'fast';
 }
+/**
+ * Expectations for loading component testing.
+ * Validates loading state UI elements.
+ *
+ * @example
+ * ```typescript
+ * const expectations: LoadingComponentExpectations = {
+ *   testId: 'loading-spinner',
+ *   text: 'Loading...',
+ *   className: 'spinner-active'
+ * };
+ * ```
+ */
 export interface LoadingComponentExpectations {
     testId?: string;
     text?: string;
     className?: string;
 }
+/**
+ * Test scenario for Next.js middleware.
+ * Defines request and expected middleware behavior.
+ *
+ * @example
+ * ```typescript
+ * const scenario: MiddlewareTestScenarioWithRequest = {
+ *   name: 'Auth redirect',
+ *   request: ['/admin', { headers: {} }],
+ *   expected: {
+ *     type: 'redirect',
+ *     url: '/login',
+ *     status: 302
+ *   }
+ * };
+ * ```
+ */
 export interface MiddlewareTestScenarioWithRequest {
     name: string;
     request: Parameters<CreateMockNextRequestFunction>;
@@ -4822,6 +5044,7 @@ export interface PerformanceMonitor {
         memory?: number[];
         timestamps: number[];
     };
+    reset: () => void;
 }
 /**
  * Options for memory leak testing.
@@ -5126,13 +5349,11 @@ export interface SwipeGestureParams {
  * @interface PinchGestureParams
  */
 export interface PinchGestureParams {
-    center: {
-        x: number;
-        y: number;
-    };
-    scale: number;
-    duration?: number;
-    rotation?: number;
+    element: Element;
+    centerX: number;
+    centerY: number;
+    startDistance: number;
+    endDistance: number;
 }
 /**
  * Animation frame data
@@ -5430,7 +5651,7 @@ export interface FileSnapshot {
  * Environment configuration
  * @interface EnvConfig
  */
-interface EnvConfig {
+export interface EnvConfig {
     baseDir?: string;
     envFile?: string;
     override?: boolean;
@@ -5534,4 +5755,3 @@ export interface AsyncHook {
     after?: (asyncId: number) => void;
     destroy?: (asyncId: number) => void;
 }
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plyaz/types",
-  "version": "1.5.3",
+  "version": "1.5.5",
   "author": "Redeemer Pace",
   "license": "ISC",
   "description": "Provides shared TypeScript types and schema utilities for validation and parsing in the @playz ecosystem.",
@@ -31,7 +31,6 @@
     "pnpm": ">=8.0.0"
   },
   "keywords": [],
-  "packageManager": "pnpm@10.11.0",
   "dependencies": {
     "type-fest": "^4.41.0"
   },
@@ -127,6 +126,8 @@
     "audit:critical": "pnpm audit --audit-level critical",
     "audit:fix": "pnpm audit --fix",
     "audit:enhanced": "npx audit-ci --moderate",
-    "security:check": "pnpm audit:moderate && npx audit-ci --moderate"
+    "security:check": "pnpm audit:moderate && npx audit-ci --moderate",
+    "deploy:local": "bash ../deploy-local.sh",
+    "publish:local": "bash ../publish-local.sh"
   }
 }