@plyaz/types 1.7.28 → 1.7.29

package/dist/api/errors/enum.d.ts

@@ -180,3 +180,35 @@ export declare const PACKAGE_STATUS_CODES: {
  * Maps error codes to their HTTP status and metadata
  */
 export declare const ERROR_DEFINITIONS: ErrorDefinitions;
+/**
+ * Mapping of error category values to camelCase emitter keys
+ * Used by the event system to route errors to appropriate handlers
+ *
+ * @example
+ * ```typescript
+ * import { ERROR_CATEGORY, ERROR_CATEGORY_TO_EMITTER_KEY } from '@plyaz/types/api';
+ *
+ * const category = ERROR_CATEGORY.RateLimit; // 'rate.limit'
+ * const emitterKey = ERROR_CATEGORY_TO_EMITTER_KEY[category]; // 'rateLimit'
+ * ```
+ */
+export declare const ERROR_CATEGORY_TO_EMITTER_KEY: {
+    readonly network: "network";
+    readonly validation: "validation";
+    readonly authentication: "authentication";
+    readonly "rate.limit": "rateLimit";
+    readonly server: "server";
+    readonly timeout: "timeout";
+    readonly authorization: "authorization";
+    readonly "not.found": "notFound";
+    readonly conflict: "conflict";
+    readonly client: "client";
+    readonly "external.service": "externalService";
+    readonly cache: "cache";
+    readonly headers: "headers";
+    readonly retry: "retry";
+    readonly blockchain: "blockchain";
+    readonly strategy: "strategy";
+    readonly regional: "regional";
+    readonly unknown: "unknown";
+};

package/dist/api/errors/types.d.ts

@@ -8,6 +8,8 @@
 import type { ResponseError, RequestConfig } from 'fetchff';
 import type { ERROR_CATEGORY, ErrorDetail, ErrorResponse } from '../../errors';
 import type { API_ERROR_CODES, OPERATIONS, ERROR_FIELDS, STORAGE_TYPES, ApiClientInstance } from '..';
+import type { PACKAGE_STATUS_CODES } from './enum';
+import type { HTTP_STATUS } from '@plyaz/config';
 /**
  * Typed constants as types for convenience
  */
@@ -18,6 +20,58 @@ export type StorageType = (typeof STORAGE_TYPES)[keyof typeof STORAGE_TYPES];
  * Type for API error codes
  */
 export type ApiErrorCode = (typeof API_ERROR_CODES)[keyof typeof API_ERROR_CODES];
+/**
+ * Type alias for error category values
+ * Represents a single category value from ERROR_CATEGORY
+ *
+ * @example
+ * ```typescript
+ * const category: ErrorCategoryValue = ERROR_CATEGORY.Network; // 'network'
+ * const isValid: ErrorCategoryValue = 'authentication'; // valid
+ * ```
+ */
+export type ErrorCategoryValue = (typeof ERROR_CATEGORY)[keyof typeof ERROR_CATEGORY];
+/**
+ * Type alias for API error code values
+ * Use this instead of repeating the verbose (typeof API_ERROR_CODES)[keyof typeof API_ERROR_CODES]
+ *
+ * @example
+ * ```typescript
+ * const code: ApiErrorCodeValue = API_ERROR_CODES.NETWORK_ERROR;
+ * ```
+ */
+export type ApiErrorCodeValue = (typeof API_ERROR_CODES)[keyof typeof API_ERROR_CODES];
+/**
+ * Type alias for package-specific status code values
+ * Custom status codes specific to @plyaz/api package (1xxx range)
+ *
+ * @example
+ * ```typescript
+ * const statusCode: PackageStatusCodeValue = PACKAGE_STATUS_CODES.CLIENT_CANCELLED; // 1001
+ * ```
+ */
+export type PackageStatusCodeValue = (typeof PACKAGE_STATUS_CODES)[keyof typeof PACKAGE_STATUS_CODES];
+/**
+ * Type alias for HTTP status code values
+ * Standard HTTP status codes from @plyaz/config
+ *
+ * @example
+ * ```typescript
+ * const statusCode: HttpStatusCodeValue = HTTP_STATUS.NOT_FOUND; // 404
+ * ```
+ */
+export type HttpStatusCodeValue = (typeof HTTP_STATUS)[keyof typeof HTTP_STATUS];
+/**
+ * Union type for all valid status codes
+ * Combines both HTTP status codes and package-specific status codes
+ *
+ * @example
+ * ```typescript
+ * const httpCode: StatusCodeValue = HTTP_STATUS.BAD_REQUEST; // 400
+ * const customCode: StatusCodeValue = PACKAGE_STATUS_CODES.CLIENT_CANCELLED; // 1001
+ * ```
+ */
+export type StatusCodeValue = PackageStatusCodeValue | HttpStatusCodeValue;
 /**
  * Translation interpolation variables
  */
@@ -157,14 +211,14 @@ export interface ApiPackageErrorOptionsErrorDetail<ValueGiven, AllowedValues, Co
  * ```
  */
 export interface ApiPackageErrorLike extends Error {
-    readonly statusCode: number;
-    readonly errorCode: string;
+    readonly statusCode: StatusCodeValue;
+    readonly errorCode: ApiErrorCodeValue;
     readonly message: string;
     readonly errors?: ErrorDetail<unknown, unknown, unknown>[];
     readonly correlationId?: string;
     readonly timestamp: string;
     readonly responseError?: ResponseError;
-    readonly category: typeof ERROR_CATEGORY;
+    readonly category: ErrorCategoryValue;
     readonly cause?: Error;
     readonly context?: ErrorContext;
     readonly requestConfig?: RequestConfig;

package/dist/api/events/factories/errors/types.d.ts

@@ -20,7 +20,7 @@ export interface GenericErrorEvent extends BaseEvent {
     type: typeof ERROR_EVENTS.GENERIC_ERROR;
     data: {
         error: ApiPackageErrorLike;
-        category: typeof ERROR_CATEGORY | string;
+        category: (typeof ERROR_CATEGORY)[keyof typeof ERROR_CATEGORY] | string;
         code: string;
         message: string;
         context?: Record<string, unknown>;

package/dist/api/index.cjs

@@ -177,6 +177,8 @@ var ERROR_CATEGORY = {
   Server: "server",
   /** Network-related error (e.g., unreachable endpoint). */
   Network: "network",
+  /** Blockchain-related error (e.g., transaction failure, gas limit). */
+  Blockchain: "blockchain",
   /** Validation-specific error (e.g., failed constraints or field errors). */
   Validation: "validation",
   /** Authentication-related error (e.g., invalid credentials, expired token). */
@@ -191,6 +193,8 @@ var ERROR_CATEGORY = {
   ExternalService: "external.service",
   /** Timeout error (request exceeded time limit). */
   Timeout: "timeout",
+  /** Conflict error (e.g., resource state conflict). */
+  Conflict: "conflict",
   /** Cache-related error. */
   Cache: "cache",
   /** Headers-related error (e.g., missing or invalid headers). */
@@ -673,6 +677,26 @@ var ERROR_DEFINITIONS = {
     category: ERROR_CATEGORY.Unknown
   }
 };
+var ERROR_CATEGORY_TO_EMITTER_KEY = {
+  [ERROR_CATEGORY.Network]: "network",
+  [ERROR_CATEGORY.Validation]: "validation",
+  [ERROR_CATEGORY.Authentication]: "authentication",
+  [ERROR_CATEGORY.RateLimit]: "rateLimit",
+  [ERROR_CATEGORY.Server]: "server",
+  [ERROR_CATEGORY.Timeout]: "timeout",
+  [ERROR_CATEGORY.Authorization]: "authorization",
+  [ERROR_CATEGORY.NotFound]: "notFound",
+  [ERROR_CATEGORY.Conflict]: "conflict",
+  [ERROR_CATEGORY.Client]: "client",
+  [ERROR_CATEGORY.ExternalService]: "externalService",
+  [ERROR_CATEGORY.Cache]: "cache",
+  [ERROR_CATEGORY.Headers]: "headers",
+  [ERROR_CATEGORY.Retry]: "retry",
+  [ERROR_CATEGORY.Blockchain]: "blockchain",
+  [ERROR_CATEGORY.Strategy]: "strategy",
+  [ERROR_CATEGORY.Regional]: "regional",
+  [ERROR_CATEGORY.Unknown]: "unknown"
+};
 
 // src/api/queue/enums.ts
 var PRIORITY_LEVEL = {
@@ -995,6 +1019,7 @@ exports.DATA_SAVER_PRESETS = DATA_SAVER_PRESETS;
 exports.DEBUGGER_CONFIG_SOURCES = DEBUGGER_CONFIG_SOURCES;
 exports.DEBUG_EVENTS = DEBUG_EVENTS;
 exports.DEFAULT_THRESHOLDS = DEFAULT_THRESHOLDS;
+exports.ERROR_CATEGORY_TO_EMITTER_KEY = ERROR_CATEGORY_TO_EMITTER_KEY;
 exports.ERROR_DEFINITIONS = ERROR_DEFINITIONS;
 exports.ERROR_EVENTS = ERROR_EVENTS;
 exports.ERROR_FIELDS = ERROR_FIELDS;