@plyaz/types 1.7.18 → 1.7.20

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

@@ -2,6 +2,7 @@
  * Performance Optimization Types
  * Types for performance configuration and monitoring
  */
+import type { RequestConfig as BaseRequestConfig, FetchResponse as BaseFetchResponse, ResponseError as BaseResponseError } from 'fetchff';
 /**
  * Performance preset names for optimized configurations
  */
@@ -99,27 +100,25 @@ export interface RequestPerformance {
  * Extended Request Config for Performance Monitoring
  * Adds performance tracking fields to the base RequestConfig
  */
-export interface PerformanceRequestConfig {
+export interface PerformanceRequestConfig extends BaseRequestConfig {
     __perfMonitorId?: string;
     fromCache?: boolean;
-    [key: string]: unknown;
 }
 /**
  * Extended Fetch Response for Performance Monitoring
  * Adds performance tracking fields to the base FetchResponse
  */
-export interface PerformanceFetchResponse {
+export interface PerformanceFetchResponse extends Omit<BaseFetchResponse, 'config'> {
     fromCache?: boolean;
     deduplicated?: boolean;
     retried?: boolean;
     retryCount?: number;
     config: PerformanceRequestConfig;
-    [key: string]: unknown;
 }
 /**
  * Extended Response Error for Performance Monitoring
  */
-export interface PerformanceResponseError {
+export interface PerformanceResponseError extends Omit<BaseResponseError, 'config'> {
     config: PerformanceRequestConfig;
     code?: string;
     status: number;
@@ -127,11 +126,19 @@ export interface PerformanceResponseError {
     isCancelled: boolean;
     request: PerformanceRequestConfig;
     response: PerformanceFetchResponse | null;
-    [key: string]: unknown;
 }
 /**
- * Type guards for performance monitoring
+ * Extended types for performance monitoring
+ * We use intersection types to add our monitoring properties
  */
-export declare function isPerformanceRequestConfig(config: unknown): config is PerformanceRequestConfig;
-export declare function isPerformanceFetchResponse(response: unknown): response is PerformanceFetchResponse;
-export declare function isPerformanceResponseError(error: unknown): error is PerformanceResponseError;
+export type MonitorRequestConfig = BaseRequestConfig & {
+    __perfMonitorId?: string;
+    fromCache?: boolean;
+};
+export type MonitorResponse = BaseFetchResponse & {
+    fromCache?: boolean;
+    deduplicated?: boolean;
+    retried?: boolean;
+    retryCount?: number;
+    config?: MonitorRequestConfig;
+};

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

@@ -2,6 +2,7 @@
  * Polling Configuration Types
  * Provides type definitions for polling functionality
  */
+import type { FetchResponse, PollingFunction } from 'fetchff';
 /**
  * Polling configuration for repeated requests
  * Uses generic types to work with any response data
@@ -28,8 +29,9 @@ export interface PollingConfig<T = unknown> {
     /**
      * Function to determine if polling should stop
      * Return true to stop, false to continue
+     * Uses fetchff's PollingFunction type for compatibility
      */
-    shouldStop?: (response: T) => boolean | Promise<boolean>;
+    shouldStop?: PollingFunction<T>;
 }
 /**
  * Result of a polling operation
@@ -62,13 +64,13 @@ export interface ProgressivePollingOptions {
  */
 export interface ConditionalPollingOptions<T = unknown> {
     /** Function to check if polling succeeded */
-    successCondition?: (response: T) => boolean;
+    successCondition?: (response: FetchResponse<T>) => boolean;
     /** Function to check if polling should error */
-    errorCondition?: (response: T) => boolean;
+    errorCondition?: (response: FetchResponse<T>) => boolean;
     /** Maximum time to poll in milliseconds */
     timeoutMs?: number;
 }
 /**
  * Polling strategy names
  */
-export type PollingStrategyName = 'jobStatus' | 'healthCheck' | 'liveData' | 'longProcess' | 'resourceWait';
+export type PollingStrategyName = 'jobStatus' | 'healthCheck' | 'liveData' | 'notifications' | 'longProcess' | 'resourceWait' | 'dataSync';

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

@@ -0,0 +1,12 @@
+/**
+ * Event types for pub/sub system
+ */
+export declare const PUB_SUB_EVENT: {
+    readonly CacheUpdate: "cache:update";
+    readonly CacheDelete: "cache:delete";
+    readonly CacheRevalidate: "cache:revalidate";
+    readonly RequestStart: "request:start";
+    readonly RequestSuccess: "request:success";
+    readonly RequestError: "request:error";
+    readonly RequestAbort: "request:abort";
+};

package/dist/api/pubsub/index.d.ts

@@ -0,0 +1,2 @@
+export type * from './types';
+export * from './enum';

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

@@ -0,0 +1,61 @@
+import type { FetchResponse } from 'fetchff';
+import type { PUB_SUB_EVENT } from '.';
+import type { JsonPrimitive } from 'type-fest';
+export type PubSubEvent = (typeof PUB_SUB_EVENT)[keyof typeof PUB_SUB_EVENT];
+/**
+ * Type for subscription callback using fetchff's FetchResponse
+ * The subscription callback receives a partial FetchResponse with commonly used fields
+ */
+export type SubscriptionCallback<T = DefaultResponse> = (response: FetchResponse<T>) => void;
+/**
+ * Serializable type that accepts common data structures
+ * This is more permissive than JsonValue to work with user-defined types
+ */
+export type Serializable = JsonPrimitive | {
+    [key: string]: Serializable | undefined;
+} | Serializable[] | {
+    [K in string | number | symbol]: Serializable | undefined;
+};
+/**
+ * Default response type when not specified
+ * Uses unknown for type safety with flexibility
+ */
+export type DefaultResponse = unknown;
+/**
+ * Handler types for flexible configuration
+ */
+export type HandlerOrArray<T> = T | T[];
+export type Handler<TArgs extends readonly unknown[] = readonly unknown[], TReturn = unknown> = (...args: TArgs) => TReturn;
+/**
+ * Create an event emitter pattern for custom events
+ *
+ * @example
+ * ```typescript
+ * const emitter = createEventEmitter();
+ *
+ * // Subscribe to custom event
+ * const unsub = emitter.on('user:login', (data) => {
+ *   console.log('User logged in:', data);
+ * });
+ *
+ * // Emit event
+ * emitter.emit('user:login', { userId: '123' });
+ *
+ * // Cleanup
+ * unsub();
+ * ```
+ */
+export interface EventEmitter<T = DefaultResponse> {
+    on: <D = T>(event: string, callback: (data: D) => void) => () => void;
+    emit: <D = T>(event: string, data: D) => void;
+    once: <D = T>(event: string, callback: (data: D) => void) => () => void;
+    off: <D = T>(event: string, callback?: (data: D) => void) => void;
+    listenerCount: (event?: string) => number;
+    listeners: (event: string) => Array<(data: unknown) => void>;
+    removeAllListeners: (event?: string) => void;
+    addHandlers: <D = T>(event: string, handlers: HandlerOrArray<(data: D) => void>) => () => void;
+    mergeHandlers: <H>(existing?: HandlerOrArray<H>, incoming?: HandlerOrArray<H>) => H[];
+    chainHandlers: <H extends Handler>(global?: HandlerOrArray<H>, client?: HandlerOrArray<H>) => H | undefined;
+    createNamespacedKey: (namespace: string, event: string) => string;
+    chainInterceptors: <I>(...interceptors: (I | I[] | undefined)[]) => I | I[] | undefined;
+}

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

@@ -2,6 +2,7 @@
  * Queue System Type Definitions
  */
 import type { PRIORITY_LEVEL } from './enums';
+import type { ConfigUpdateStrategy, DebuggerConfigSource } from '..';
 /**
  * Processing strategy for queue operations
  */
@@ -63,3 +64,71 @@ export type QueueProcessor<T> = (operation: QueueOperation<T>) => void | Promise
  * Batch processor function
  */
 export type BatchQueueProcessor<T> = (operations: QueueOperation<T>[]) => void | Promise<void>;
+/**
+ * Base operation structure
+ */
+export interface BaseOperation {
+    operation: string;
+    event: string;
+    metadata: Record<string, unknown>;
+    timestamp: number;
+    source?: string;
+}
+/**
+ * Operation priority detection function type
+ */
+export type PriorityDetector<T extends BaseOperation> = (operation: T) => typeof PRIORITY_LEVEL;
+/**
+ * Source detection function type
+ */
+export type SourceDetector = () => string;
+export interface BatchProcessorConfig<T> {
+    /** Maximum batch size */
+    batchSize: number;
+    /** Processing interval in ms */
+    interval: number;
+    /** Callback for processing batch */
+    onBatch: (operations: QueueOperation<T>[]) => void | Promise<void>;
+}
+/**
+ * Event-specific queue operation
+ */
+export interface EventQueueOperation<TEventData = unknown> extends QueueOperation {
+    eventType: string;
+    scope?: 'global' | 'client' | 'request' | 'temporary';
+    configSource?: DebuggerConfigSource;
+    updateStrategy?: ConfigUpdateStrategy;
+    data: {
+        eventData: TEventData;
+        metadata?: {
+            correlationId?: string;
+            source: DebuggerConfigSource;
+            timestamp: number;
+            retryAttempt?: number;
+        };
+    };
+}
+/**
+ * Queue health status
+ */
+export interface QueueHealth {
+    name: string;
+    status: 'healthy' | 'degraded' | 'unhealthy';
+    stats: QueueStats;
+    warnings: string[];
+}
+/**
+ * Orchestrator configuration
+ */
+export interface OrchestratorConfig {
+    /** Enable auto-scaling based on load */
+    autoScale?: boolean;
+    /** Enable health monitoring */
+    healthCheck?: boolean;
+    /** Health check interval in ms */
+    healthCheckInterval?: number;
+    /** Queue size warning threshold */
+    warnThreshold?: number;
+    /** Queue size critical threshold */
+    criticalThreshold?: number;
+}

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

@@ -0,0 +1,75 @@
+/**
+ * Regional detection constants
+ */
+export declare const REGION_STORAGE_KEY = "@plyaz/api:userRegion";
+/**
+ * Confidence levels for region detection
+ */
+export declare const REGIONAL_CONFIDENCE_LEVELS: {
+    readonly CDN_HEADER: 0.95;
+    readonly TIMEZONE_DIRECT: 0.9;
+    readonly TIMEZONE_PREFIX: 0.8;
+    readonly HIGH: 0.8;
+    readonly LOCALE_DIRECT: 0.7;
+    readonly MEDIUM: 0.7;
+    readonly GEOLOCATION: 0.6;
+    readonly LOCALE_LANGUAGE: 0.5;
+    readonly LOW: 0.5;
+    readonly GLOBAL_FALLBACK: 0.3;
+    readonly UNKNOWN_FALLBACK: 0.2;
+    readonly FINAL_FALLBACK: 0.1;
+};
+/**
+ * Geographic coordinates for region detection
+ */
+export declare const COORDINATES: {
+    readonly EU: {
+        readonly MIN_LAT: 35;
+        readonly MAX_LAT: 70;
+        readonly MIN_LON: -10;
+        readonly MAX_LON: 40;
+    };
+    readonly US: {
+        readonly MIN_LAT: 25;
+        readonly MAX_LAT: 50;
+        readonly MIN_LON: -125;
+        readonly MAX_LON: -65;
+    };
+    readonly US_WEST: {
+        readonly MIN_LAT: 32;
+        readonly MAX_LAT: 42;
+        readonly MIN_LON: -125;
+        readonly MAX_LON: -114;
+    };
+    readonly US_EAST: {
+        readonly MIN_LAT: 38;
+        readonly MAX_LAT: 45;
+        readonly MIN_LON: -80;
+        readonly MAX_LON: -70;
+    };
+    readonly ASIA: {
+        readonly MIN_LAT: 18;
+        readonly MAX_LAT: 54;
+        readonly MIN_LON: 73;
+        readonly MAX_LON: 135;
+    };
+    readonly JAPAN: {
+        readonly MIN_LAT: 30;
+        readonly MAX_LAT: 46;
+        readonly MIN_LON: 129;
+        readonly MAX_LON: 146;
+    };
+};
+export declare const CACHE_DURATION_MS: number;
+/**
+ * Map regions to presets
+ */
+export declare const REGION_TO_PRESET: {
+    readonly eu: "gdpr";
+    readonly us: "ccpa";
+    readonly 'us-ca': "ccpa";
+    readonly cn: "pipl";
+    readonly jp: "appi";
+    readonly ca: "global";
+    readonly global: "global";
+};

package/dist/api/regional/index.d.ts

@@ -3,3 +3,4 @@
  * Re-exports all regional-related types for the API package
  */
 export type * from './types';
+export * from './enum';

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

@@ -1,6 +1,7 @@
 /**
  * Regional detection and compliance types
  */
+import type { IncomingHttpHeaders } from 'http';
 /**
  * Regional information with compliance data
  */
@@ -43,7 +44,7 @@ export interface RegionDetectionOptions {
     useCDNHeaders?: boolean;
     useIPDetection?: boolean;
     useGeolocation?: boolean;
-    headers?: Record<string, unknown>;
+    headers?: IncomingHttpHeaders | Record<string, unknown>;
     cacheExpiry?: number;
     fallbackRegion?: string;
     cache?: RegionalCacheConfig;

package/dist/api/request/index.d.ts

@@ -0,0 +1 @@
+export type * from './types';

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

@@ -0,0 +1,44 @@
+/**
+ * Context for enriched headers generation
+ */
+export interface EnrichedHeadersContext {
+    request?: {
+        headers?: Record<string, string | string[] | undefined>;
+        url?: string;
+        method?: string;
+        ip?: string;
+        [key: string]: unknown;
+    };
+    client?: {
+        userAgent?: string;
+        platform?: string;
+    };
+    [key: string]: unknown;
+}
+/**
+ * Router type definitions for popular frameworks
+ */
+export interface RequestNextRouter {
+    events?: {
+        on: (event: string, handler: (url: string) => void) => void;
+        off: (event: string, handler: (url: string) => void) => void;
+    };
+}
+interface ReactRouterHistory {
+    listen?: (handler: (location: Location) => void) => () => void;
+}
+export type RequestRouter = RequestNextRouter | ReactRouterHistory;
+/**
+ * Options for route change cleanup
+ */
+export interface RouteChangeOptions {
+    /** Pattern of requests to abort (default: '*') */
+    abortPattern?: string;
+    /** Patterns to preserve across route changes */
+    preservePatterns?: string[];
+    /** Custom handler for route changes */
+    customHandler?: (url: string) => void;
+    /** Delay before aborting requests (ms) */
+    delay?: number;
+}
+export {};

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

@@ -5,6 +5,37 @@
  * @module retry/types
  */
 import type { RetryConfig as FetchffRetryConfig } from 'fetchff';
+/**
+ * Response-like structure for retry conditions
+ * Used to evaluate whether a request should be retried based on response characteristics
+ *
+ * @example
+ * ```typescript
+ * const response: RetryResponse = {
+ *   status: 503,
+ *   headers: { 'Retry-After': '30' },
+ *   error: new Error('Service Unavailable'),
+ *   timeout: false
+ * };
+ *
+ * // Use in retry condition
+ * const shouldRetry = response.status === 503 || response.timeout;
+ * ```
+ */
+export interface RetryResponse {
+    /** HTTP status code */
+    status?: number;
+    /** Response headers */
+    headers?: Record<string, string> | Headers;
+    /** Response data */
+    data?: unknown;
+    /** Error object if request failed */
+    error?: unknown;
+    /** Error code (e.g., 'ECONNREFUSED', 'ETIMEDOUT') */
+    code?: string;
+    /** Whether the request timed out */
+    timeout?: boolean;
+}
 /**
  * Retry configuration options
  * Maps to fetchff's retry mechanism

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

@@ -2,15 +2,19 @@
  * Unified API Strategies Types
  * Type definitions for unified strategies (implementations remain in @plyaz/api)
  */
+import type { CacheStrategyName } from '../cache';
+import type { RetryStrategyName } from '../retry';
+import type { PollingStrategyName } from '../polling';
+import type { PerformancePresetName } from '../performance';
 /**
  * Unified strategy combines strategies from different domains
  * This provides a convenience layer while keeping individual strategies independent
  */
 export interface UnifiedStrategy {
-    cache: string;
-    retry: string;
-    polling?: string;
-    performance?: string;
+    cache: CacheStrategyName;
+    retry: RetryStrategyName;
+    polling?: PollingStrategyName;
+    performance?: PerformancePresetName;
 }
 /**
  * Unified strategy names for common API usage patterns
@@ -20,8 +24,8 @@ export type UnifiedStrategyName = 'realtime' | 'interactive' | 'background' | 's
  * Configuration object with resolved strategy names
  */
 export interface UnifiedStrategyConfig {
-    cache: string;
-    retry: string;
-    polling?: string;
-    performance?: string;
+    cache: CacheStrategyName;
+    retry: RetryStrategyName;
+    polling?: PollingStrategyName;
+    performance?: PerformancePresetName;
 }

package/dist/errors/index.cjs

@@ -1,4 +1,73 @@
 'use strict';
 
+// @plyaz package - Built with tsup
+
+// src/errors/enums.ts
+var ERROR_TYPE = {
+  /** 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. */
+  SchemaValidationError: "validation.schema.error",
+  /** Unhandled or unexpected system error. */
+  InternalError: "system.internal.error",
+  /** System dependency is currently unavailable (e.g., database or external API). */
+  ServiceUnavailable: "system.service.unavailable",
+  /** The request took too long and timed out. */
+  TimeoutError: "system.timeout",
+  /** 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: "low",
+  /** Medium severity - minor disruption or warning. */
+  Medium: "medium",
+  /** High severity - major issue requiring attention. */
+  High: "high",
+  /** Critical severity - blocking or crashing issue. */
+  Critical: "critical"
+};
+var ERROR_CATEGORY = {
+  /** Client-side error (e.g., invalid request). */
+  Client: "client",
+  /** Server-side error (e.g., logic failure or exception). */
+  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). */
+  Authentication: "authentication",
+  /** Authorization-related error (e.g., insufficient permissions). */
+  Authorization: "authorization",
+  /** Resource not found error. */
+  NotFound: "not.found",
+  /** Rate limiting error (too many requests). */
+  RateLimit: "rate.limit",
+  /** External service error (e.g., third-party API failure). */
+  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). */
+  Headers: "headers",
+  /** Retry-related error (e.g., max retries exceeded). */
+  Retry: "retry",
+  /** Strategy-related error (e.g., invalid retry or caching strategy). */
+  Strategy: "strategy",
+  /** Regional-related error (e.g., region detection failure). */
+  Regional: "regional",
+  /** Unknown or unclassified error. */
+  Unknown: "unknown"
+};
+
+exports.ERROR_CATEGORY = ERROR_CATEGORY;
+exports.ERROR_SEVERITY = ERROR_SEVERITY;
+exports.ERROR_TYPE = ERROR_TYPE;
 //# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map

package/dist/errors/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":"","file":"index.cjs"}
+{"version":3,"sources":["../../src/errors/enums.ts"],"names":[],"mappings":";;;;;AAgBO,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,YAAA;AAAA;AAAA,EAGZ,cAAA,EAAgB,gBAAA;AAAA;AAAA,EAGhB,aAAA,EAAe,eAAA;AAAA;AAAA,EAGf,QAAA,EAAU,WAAA;AAAA;AAAA,EAGV,SAAA,EAAW,YAAA;AAAA;AAAA,EAGX,eAAA,EAAiB,kBAAA;AAAA;AAAA,EAGjB,OAAA,EAAS,SAAA;AAAA;AAAA,EAGT,QAAA,EAAU,UAAA;AAAA;AAAA,EAGV,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,OAAA,EAAS,SAAA;AAAA;AAAA,EAGT,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,QAAA,EAAU,UAAA;AAAA;AAAA,EAGV,QAAA,EAAU,UAAA;AAAA;AAAA,EAGV,OAAA,EAAS;AACX","file":"index.cjs","sourcesContent":["/**\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\n  /** Authentication-related error (e.g., invalid credentials, expired token). */\n  Authentication: 'authentication',\n\n  /** Authorization-related error (e.g., insufficient permissions). */\n  Authorization: 'authorization',\n\n  /** Resource not found error. */\n  NotFound: 'not.found',\n\n  /** Rate limiting error (too many requests). */\n  RateLimit: 'rate.limit',\n\n  /** External service error (e.g., third-party API failure). */\n  ExternalService: 'external.service',\n\n  /** Timeout error (request exceeded time limit). */\n  Timeout: 'timeout',\n\n  /** Conflict error (e.g., resource state conflict). */\n  Conflict: 'conflict',\n\n  /** Cache-related error. */\n  Cache: 'cache',\n\n  /** Headers-related error (e.g., missing or invalid headers). */\n  Headers: 'headers',\n\n  /** Retry-related error (e.g., max retries exceeded). */\n  Retry: 'retry',\n\n  /** Strategy-related error (e.g., invalid retry or caching strategy). */\n  Strategy: 'strategy',\n\n  /** Regional-related error (e.g., region detection failure). */\n  Regional: 'regional',\n\n  /** Unknown or unclassified error. */\n  Unknown: 'unknown',\n} as const;\n"]}

package/dist/errors/index.d.ts

@@ -1,2 +1,2 @@
-export type * from './enums';
+export * from './enums';
 export type * from './types';

package/dist/errors/index.js

@@ -1,3 +1,69 @@
+// @plyaz package - Built with tsup
 
+// src/errors/enums.ts
+var ERROR_TYPE = {
+  /** 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. */
+  SchemaValidationError: "validation.schema.error",
+  /** Unhandled or unexpected system error. */
+  InternalError: "system.internal.error",
+  /** System dependency is currently unavailable (e.g., database or external API). */
+  ServiceUnavailable: "system.service.unavailable",
+  /** The request took too long and timed out. */
+  TimeoutError: "system.timeout",
+  /** 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: "low",
+  /** Medium severity - minor disruption or warning. */
+  Medium: "medium",
+  /** High severity - major issue requiring attention. */
+  High: "high",
+  /** Critical severity - blocking or crashing issue. */
+  Critical: "critical"
+};
+var ERROR_CATEGORY = {
+  /** Client-side error (e.g., invalid request). */
+  Client: "client",
+  /** Server-side error (e.g., logic failure or exception). */
+  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). */
+  Authentication: "authentication",
+  /** Authorization-related error (e.g., insufficient permissions). */
+  Authorization: "authorization",
+  /** Resource not found error. */
+  NotFound: "not.found",
+  /** Rate limiting error (too many requests). */
+  RateLimit: "rate.limit",
+  /** External service error (e.g., third-party API failure). */
+  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). */
+  Headers: "headers",
+  /** Retry-related error (e.g., max retries exceeded). */
+  Retry: "retry",
+  /** Strategy-related error (e.g., invalid retry or caching strategy). */
+  Strategy: "strategy",
+  /** Regional-related error (e.g., region detection failure). */
+  Regional: "regional",
+  /** Unknown or unclassified error. */
+  Unknown: "unknown"
+};
+
+export { ERROR_CATEGORY, ERROR_SEVERITY, ERROR_TYPE };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/errors/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}
+{"version":3,"sources":["../../src/errors/enums.ts"],"names":[],"mappings":";;;AAgBO,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,YAAA;AAAA;AAAA,EAGZ,cAAA,EAAgB,gBAAA;AAAA;AAAA,EAGhB,aAAA,EAAe,eAAA;AAAA;AAAA,EAGf,QAAA,EAAU,WAAA;AAAA;AAAA,EAGV,SAAA,EAAW,YAAA;AAAA;AAAA,EAGX,eAAA,EAAiB,kBAAA;AAAA;AAAA,EAGjB,OAAA,EAAS,SAAA;AAAA;AAAA,EAGT,QAAA,EAAU,UAAA;AAAA;AAAA,EAGV,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,OAAA,EAAS,SAAA;AAAA;AAAA,EAGT,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,QAAA,EAAU,UAAA;AAAA;AAAA,EAGV,QAAA,EAAU,UAAA;AAAA;AAAA,EAGV,OAAA,EAAS;AACX","file":"index.js","sourcesContent":["/**\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\n  /** Authentication-related error (e.g., invalid credentials, expired token). */\n  Authentication: 'authentication',\n\n  /** Authorization-related error (e.g., insufficient permissions). */\n  Authorization: 'authorization',\n\n  /** Resource not found error. */\n  NotFound: 'not.found',\n\n  /** Rate limiting error (too many requests). */\n  RateLimit: 'rate.limit',\n\n  /** External service error (e.g., third-party API failure). */\n  ExternalService: 'external.service',\n\n  /** Timeout error (request exceeded time limit). */\n  Timeout: 'timeout',\n\n  /** Conflict error (e.g., resource state conflict). */\n  Conflict: 'conflict',\n\n  /** Cache-related error. */\n  Cache: 'cache',\n\n  /** Headers-related error (e.g., missing or invalid headers). */\n  Headers: 'headers',\n\n  /** Retry-related error (e.g., max retries exceeded). */\n  Retry: 'retry',\n\n  /** Strategy-related error (e.g., invalid retry or caching strategy). */\n  Strategy: 'strategy',\n\n  /** Regional-related error (e.g., region detection failure). */\n  Regional: 'regional',\n\n  /** Unknown or unclassified error. */\n  Unknown: 'unknown',\n} as const;\n"]}