@plyaz/api 1.0.2 → 1.1.1

package/dist/api/endpoints/builders.d.ts

@@ -0,0 +1,109 @@
+/**
+ * Endpoint URL Builders
+ * Advanced utilities for building URLs and cache keys from endpoints
+ */
+import { endpoints } from './index';
+export type EndpointName = keyof typeof endpoints;
+/**
+ * Query parameters type - matches fetchff's flexible param handling
+ * Supports objects, URLSearchParams, and arrays of name-value pairs
+ */
+export type QueryParams = Record<string, string | number | boolean | string[] | number[]> | URLSearchParams | Array<[string, string]>;
+/**
+ * Generate cache key from endpoint name
+ *
+ * @param endpoint - The endpoint name
+ * @param params - Optional path and query parameters
+ * @returns Cache key string
+ *
+ * @example
+ * endpointCacheKey('getCampaign', { pathParams: { id: '123' } }) // '/campaigns/123'
+ * endpointCacheKey('listCampaigns', { queryParams: { status: 'active' } }) // '/campaigns:{"status":"active"}'
+ */
+export declare function endpointCacheKey(endpoint: EndpointName, params?: {
+    pathParams?: Record<string, string | number>;
+    queryParams?: QueryParams;
+}): string;
+/**
+ * Generate pattern for cache invalidation
+ *
+ * @param endpoint - The endpoint name
+ * @param wildcardParam - Optional specific parameter to wildcard
+ * @returns Pattern string with wildcards
+ *
+ * @example
+ * endpointCachePattern('getCampaign') // '/campaigns/*'
+ * endpointCachePattern('getCampaignStats', 'id') // '/campaigns/*\/stats'
+ */
+export declare function endpointCachePattern(endpoint: EndpointName, wildcardParam?: string): string;
+/**
+ * Find endpoints by URL pattern
+ *
+ * @param pattern - RegExp pattern to match against URLs
+ * @returns Array of matching endpoints with their configs
+ *
+ * @example
+ * findEndpointsByPattern(/^\/campaigns/) // All campaign endpoints
+ */
+export declare function findEndpointsByPattern(pattern: RegExp): Array<{
+    name: EndpointName;
+    url: string;
+    method?: string;
+}>;
+/**
+ * Get all endpoints by HTTP method
+ *
+ * @param method - HTTP method (GET, POST, etc.)
+ * @returns Array of endpoints using that method
+ *
+ * @example
+ * getEndpointsByMethod('GET') // All GET endpoints
+ * getEndpointsByMethod('POST') // All POST endpoints
+ */
+export declare function getEndpointsByMethod(method: string): Array<{
+    name: EndpointName;
+    url: string;
+    method?: string;
+}>;
+/**
+ * Endpoint-based cache key patterns
+ * Predefined patterns for common cache invalidation scenarios
+ */
+export declare const endpointCachePatterns: {
+    allCampaigns: () => string;
+    campaignById: (id: string) => string;
+    campaignsByPattern: () => string;
+    campaignStats: (id: string) => string;
+    all: () => string;
+    byEndpoint: (endpoint: EndpointName) => string;
+    custom: (pattern: string) => string;
+};
+/**
+ * Build full request URL including base URL and query parameters
+ *
+ * @param endpoint - The endpoint name
+ * @param baseURL - Base URL of the API
+ * @param params - Path and query parameters
+ * @returns Full URL string
+ *
+ * @example
+ * buildFullUrl('getCampaign', 'https://api.example.com', { pathParams: { id: '123' } })
+ * // 'https://api.example.com/campaigns/123'
+ */
+export declare function buildFullUrl(endpoint: EndpointName, baseURL: string, params?: {
+    pathParams?: Record<string, string | number>;
+    queryParams?: QueryParams;
+}): string;
+/**
+ * Validate that all required path parameters are provided
+ *
+ * @param endpoint - The endpoint name
+ * @param pathParams - Provided path parameters
+ * @returns True if all required params are provided
+ *
+ * @example
+ * validatePathParams('getCampaign', { id: '123' }) // true
+ * validatePathParams('getCampaign', {}) // false
+ */
+export declare function validatePathParams(endpoint: EndpointName, pathParams?: Record<string, string | number | undefined>): boolean;
+//# sourceMappingURL=builders.d.ts.map

package/dist/api/endpoints/builders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"builders.d.ts","sourceRoot":"","sources":["../../../src/api/endpoints/builders.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAGpC,MAAM,MAAM,YAAY,GAAG,MAAM,OAAO,SAAS,CAAC;AAElD;;;GAGG;AACH,MAAM,MAAM,WAAW,GACnB,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,GAC/D,eAAe,GACf,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAE5B;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,YAAY,EACtB,MAAM,CAAC,EAAE;IACP,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IAC7C,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B,GACA,MAAM,CAqBR;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,YAAY,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,CAU3F;AAED;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC;IAC7D,IAAI,EAAE,YAAY,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC,CAOD;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAC1D,IAAI,EAAE,YAAY,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC,CAQD;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB;wBAEd,MAAM;uBACL,MAAM,KAAG,MAAM;8BAIV,MAAM;wBACV,MAAM,KAAG,MAAM;eAM1B,MAAM;2BACQ,YAAY,KAAG,MAAM;sBAG1B,MAAM,KAAG,MAAM;CAClC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,YAAY,EACtB,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE;IACP,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IAC7C,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B,GACA,MAAM,CAqCR;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,YAAY,EACtB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,GACvD,OAAO,CAiBT"}

package/dist/api/endpoints/campaigns.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Campaign endpoints configuration
+ * Each endpoint can override ALL global settings
+ */
+export declare const campaignEndpoints: {
+    readonly getCampaign: {
+        readonly url: "/campaigns/:id";
+        readonly method: "GET";
+    };
+    readonly listCampaigns: {
+        readonly url: "/campaigns";
+        readonly method: "GET";
+    };
+    readonly createCampaign: {
+        readonly url: "/campaigns";
+        readonly method: "POST";
+    };
+    readonly updateCampaign: {
+        readonly url: "/campaigns/:id";
+        readonly method: "PUT";
+    };
+    readonly deleteCampaign: {
+        readonly url: "/campaigns/:id";
+        readonly method: "DELETE";
+    };
+    readonly getCampaignStats: {
+        readonly url: "/campaigns/:id/stats";
+        readonly method: "GET";
+    };
+    readonly getCampaignParticipants: {
+        readonly url: "/campaigns/:id/participants";
+        readonly method: "GET";
+    };
+    readonly joinCampaign: {
+        readonly url: "/campaigns/:id/join";
+        readonly method: "POST";
+    };
+    readonly leaveCampaign: {
+        readonly url: "/campaigns/:id/leave";
+        readonly method: "POST";
+    };
+};
+//# sourceMappingURL=campaigns.d.ts.map

package/dist/api/endpoints/campaigns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaigns.d.ts","sourceRoot":"","sources":["../../../src/api/endpoints/campaigns.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4CpB,CAAC"}

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

@@ -0,0 +1,100 @@
+/**
+ * Combined Endpoints Configuration
+ * Aggregates all endpoint configurations with their types
+ */
+import { campaignEndpoints } from './campaigns';
+import { pollingEndpoints } from './polling';
+/**
+ * All API endpoints combined
+ * This is passed to createApiClient to generate endpoint methods
+ */
+export declare const endpoints: {
+    readonly getJobStatus: {
+        readonly url: "/jobs/:jobId";
+        readonly method: "GET";
+    };
+    readonly startJob: {
+        readonly url: "/jobs";
+        readonly method: "POST";
+    };
+    readonly cancelJob: {
+        readonly url: "/jobs/:jobId/cancel";
+        readonly method: "POST";
+    };
+    readonly healthCheck: {
+        readonly url: "/health";
+        readonly method: "GET";
+    };
+    readonly getLiveData: {
+        readonly url: "/live-data";
+        readonly method: "GET";
+    };
+    readonly getDashboardMetrics: {
+        readonly url: "/dashboard/metrics";
+        readonly method: "GET";
+    };
+    readonly startSync: {
+        readonly url: "/sync";
+        readonly method: "POST";
+    };
+    readonly getSyncStatus: {
+        readonly url: "/sync/:syncId";
+        readonly method: "GET";
+    };
+    readonly getResourceStatus: {
+        readonly url: "/resources/:resourceId";
+        readonly method: "GET";
+    };
+    readonly reserveResource: {
+        readonly url: "/resources/:resourceId/reserve";
+        readonly method: "POST";
+    };
+    readonly getCampaign: {
+        readonly url: "/campaigns/:id";
+        readonly method: "GET";
+    };
+    readonly listCampaigns: {
+        readonly url: "/campaigns";
+        readonly method: "GET";
+    };
+    readonly createCampaign: {
+        readonly url: "/campaigns";
+        readonly method: "POST";
+    };
+    readonly updateCampaign: {
+        readonly url: "/campaigns/:id";
+        readonly method: "PUT";
+    };
+    readonly deleteCampaign: {
+        readonly url: "/campaigns/:id";
+        readonly method: "DELETE";
+    };
+    readonly getCampaignStats: {
+        readonly url: "/campaigns/:id/stats";
+        readonly method: "GET";
+    };
+    readonly getCampaignParticipants: {
+        readonly url: "/campaigns/:id/participants";
+        readonly method: "GET";
+    };
+    readonly joinCampaign: {
+        readonly url: "/campaigns/:id/join";
+        readonly method: "POST";
+    };
+    readonly leaveCampaign: {
+        readonly url: "/campaigns/:id/leave";
+        readonly method: "POST";
+    };
+};
+export type EndpointsList = typeof endpoints;
+/**
+ * Export individual endpoint groups for selective imports
+ */
+export { campaignEndpoints };
+export { pollingEndpoints };
+/**
+ * Export endpoint utilities
+ */
+export { getEndpointUrl, getAllEndpointUrls, hasEndpoint, getEndpointConfig, buildEndpointUrl, getEndpointParams, hasPathParams, getEndpointMetadata, buildUrl, extractUrlParams, } from './utils';
+export { endpointCacheKey, endpointCachePattern, findEndpointsByPattern, getEndpointsByMethod, endpointCachePatterns, buildFullUrl, validatePathParams, } from './builders';
+//# sourceMappingURL=index.d.ts.map

package/dist/api/endpoints/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/endpoints/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAE7C;;;GAGG;AACH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAIZ,CAAC;AAEX,MAAM,MAAM,aAAa,GAAG,OAAO,SAAS,CAAC;AAE7C;;GAEG;AACH,OAAO,EAAE,iBAAiB,EAAE,CAAC;AAC7B,OAAO,EAAE,gBAAgB,EAAE,CAAC;AAE5B;;GAEG;AACH,OAAO,EAEL,cAAc,EACd,kBAAkB,EAClB,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,mBAAmB,EACnB,QAAQ,EACR,gBAAgB,GACjB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAEL,gBAAgB,EAChB,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,YAAY,EACZ,kBAAkB,GACnB,MAAM,YAAY,CAAC"}

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

@@ -0,0 +1,83 @@
+/**
+ * Example endpoint configurations that work with polling strategies
+ * These show how to properly configure endpoints for different polling scenarios
+ */
+export declare const pollingEndpoints: {
+    readonly getJobStatus: {
+        readonly url: "/jobs/:jobId";
+        readonly method: "GET";
+    };
+    readonly startJob: {
+        readonly url: "/jobs";
+        readonly method: "POST";
+    };
+    readonly cancelJob: {
+        readonly url: "/jobs/:jobId/cancel";
+        readonly method: "POST";
+    };
+    readonly healthCheck: {
+        readonly url: "/health";
+        readonly method: "GET";
+    };
+    readonly getLiveData: {
+        readonly url: "/live-data";
+        readonly method: "GET";
+    };
+    readonly getDashboardMetrics: {
+        readonly url: "/dashboard/metrics";
+        readonly method: "GET";
+    };
+    readonly startSync: {
+        readonly url: "/sync";
+        readonly method: "POST";
+    };
+    readonly getSyncStatus: {
+        readonly url: "/sync/:syncId";
+        readonly method: "GET";
+    };
+    readonly getResourceStatus: {
+        readonly url: "/resources/:resourceId";
+        readonly method: "GET";
+    };
+    readonly reserveResource: {
+        readonly url: "/resources/:resourceId/reserve";
+        readonly method: "POST";
+    };
+};
+/**
+ * Example usage with fetchff and polling:
+ *
+ * ```typescript
+ * import { createApiFetcher } from 'fetchff';
+ * import type { PollingEndpointTypes } from './polling';
+ *
+ * const api = createApiFetcher<PollingEndpointTypes>({
+ *   baseURL: 'https://api.example.com',
+ *   endpoints: pollingEndpoints,
+ * });
+ *
+ * // Start a job and poll for completion
+ * const { data: job } = await api.startJob({
+ *   body: { type: 'export', parameters: { format: 'csv' } }
+ * });
+ *
+ * // Poll job status using the jobStatus strategy
+ * const { data: result } = await api.getJobStatus({
+ *   urlPathParams: { jobId: job.jobId },
+ *   polling: 'jobStatus', // Uses our preset strategy
+ * });
+ *
+ * // Or with custom polling
+ * const { data: result } = await api.getJobStatus({
+ *   urlPathParams: { jobId: job.jobId },
+ *   polling: {
+ *     interval: 3000,
+ *     shouldStop: (response) => {
+ *       const status = response.data?.status;
+ *       return status === 'completed' || status === 'failed';
+ *     }
+ *   }
+ * });
+ * ```
+ */
+//# sourceMappingURL=polling.d.ts.map

package/dist/api/endpoints/polling.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"polling.d.ts","sourceRoot":"","sources":["../../../src/api/endpoints/polling.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoEnB,CAAC;AAEX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG"}

package/dist/api/endpoints/utils.d.ts

@@ -0,0 +1,128 @@
+/**
+ * Endpoint URL Utilities
+ * Lightweight helpers for working with endpoint definitions
+ */
+import { endpoints } from './index';
+export type EndpointName = keyof typeof endpoints;
+/**
+ * Get endpoint URL by name
+ *
+ * @param name - The endpoint name
+ * @returns The endpoint URL template
+ *
+ * @example
+ * getEndpointUrl('getCampaign') // '/campaigns/:id'
+ */
+export declare function getEndpointUrl(name: EndpointName): string;
+/**
+ * Get all endpoint URLs as a record
+ *
+ * @returns Record of endpoint names to URLs
+ *
+ * @example
+ * getAllEndpointUrls() // { getCampaign: '/campaigns/:id', ... }
+ */
+export declare function getAllEndpointUrls(): Record<EndpointName, string>;
+/**
+ * Check if endpoint exists
+ *
+ * @param name - The endpoint name to check
+ * @returns True if endpoint exists
+ *
+ * @example
+ * hasEndpoint('getCampaign') // true
+ * hasEndpoint('invalid') // false
+ */
+export declare function hasEndpoint(name: string): name is EndpointName;
+/**
+ * Get endpoint config (url, method, etc.)
+ *
+ * @param name - The endpoint name
+ * @returns The full endpoint configuration
+ *
+ * @example
+ * getEndpointConfig('getCampaign') // { url: '/campaigns/:id', method: 'GET' }
+ */
+export declare function getEndpointConfig(name: EndpointName): {
+    url: string;
+    method?: string;
+};
+/**
+ * Build a URL with path parameters replaced
+ *
+ * @param endpoint - The endpoint name
+ * @param pathParams - Path parameters to replace
+ * @returns URL with parameters replaced
+ *
+ * @example
+ * buildEndpointUrl('getCampaign', { id: '123' }) // '/campaigns/123'
+ */
+export declare function buildEndpointUrl(endpoint: EndpointName, pathParams?: Record<string, string | number>): string;
+/**
+ * Extract path parameters from an endpoint
+ *
+ * @param endpoint - The endpoint name
+ * @returns Array of parameter names
+ *
+ * @example
+ * getEndpointParams('getCampaign') // ['id']
+ * getEndpointParams('getCampaignStats') // ['id']
+ */
+export declare function getEndpointParams(endpoint: EndpointName): string[];
+/**
+ * Check if endpoint requires path parameters
+ *
+ * @param endpoint - The endpoint name
+ * @returns True if endpoint has path parameters
+ *
+ * @example
+ * hasPathParams('getCampaign') // true
+ * hasPathParams('listCampaigns') // false
+ */
+export declare function hasPathParams(endpoint: EndpointName): boolean;
+/**
+ * Get endpoint metadata
+ *
+ * @param endpoint - The endpoint name
+ * @returns Metadata about the endpoint
+ *
+ * @example
+ * getEndpointMetadata('getCampaign')
+ * // { name: 'getCampaign', url: '/campaigns/:id', method: 'GET', hasParams: true, params: ['id'], config: {...} }
+ */
+export declare function getEndpointMetadata(endpoint: EndpointName): {
+    name: EndpointName;
+    url: string;
+    method: string;
+    hasParams: boolean;
+    params: string[];
+    config: {
+        url: string;
+        method?: string;
+    };
+};
+/**
+ * Build URL from a URL template with parameters
+ * Generic helper for any URL template
+ *
+ * @param url - URL template with :param placeholders
+ * @param params - Parameters to replace
+ * @returns URL with parameters replaced
+ *
+ * @example
+ * buildUrl('/users/:id', { id: '123' }) // '/users/123'
+ * buildUrl('/posts/:postId/comments/:commentId', { postId: '1', commentId: '2' }) // '/posts/1/comments/2'
+ */
+export declare function buildUrl(url: string, params?: Record<string, string | number>): string;
+/**
+ * Extract parameter names from a URL template
+ *
+ * @param url - URL template with :param placeholders
+ * @returns Array of parameter names
+ *
+ * @example
+ * extractUrlParams('/users/:id') // ['id']
+ * extractUrlParams('/posts/:postId/comments/:commentId') // ['postId', 'commentId']
+ */
+export declare function extractUrlParams(url: string): string[];
+//# sourceMappingURL=utils.d.ts.map

package/dist/api/endpoints/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/api/endpoints/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC,MAAM,MAAM,YAAY,GAAG,MAAM,OAAO,SAAS,CAAC;AAElD;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,CAEzD;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,IAAI,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAQjE;AAED;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,YAAY,CAE9D;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,YAAY,GAAG;IACrD,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAEA;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,YAAY,EACtB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GAC3C,MAAM,CAUR;AAED;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,YAAY,GAAG,MAAM,EAAE,CAIlE;AAED;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAE7D;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,YAAY,GAAG;IAC3D,IAAI,EAAE,YAAY,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,MAAM,EAAE;QACN,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,CAUA;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG,MAAM,CAStF;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAGtD"}

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

@@ -0,0 +1,101 @@
+/**
+ * Main error class for @plyaz/api package
+ */
+import type { ResponseError, RequestConfig } from 'fetchff';
+import type { ApiPackageErrorOptions, ErrorContext, ApiClientInstance, ApiPackageErrorLike, ErrorCategoryValue, ApiErrorCodeValue, StatusCodeValue } from '@plyaz/types/api';
+import type { ErrorResponse, ErrorDetail } from '@plyaz/types';
+import type { EndpointsList } from '../endpoints';
+/**
+ * Enhanced error class that implements ErrorResponse interface
+ * Wraps fetchff's ResponseError for compatibility
+ */
+export declare class ApiPackageError extends Error implements ApiPackageErrorLike {
+    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: ErrorCategoryValue;
+    readonly cause?: Error;
+    readonly context?: ErrorContext;
+    readonly requestConfig?: RequestConfig;
+    readonly responseData?: ResponseError['response'];
+    readonly details?: ErrorDetail<unknown, unknown, unknown>[];
+    readonly originalError?: Error;
+    readonly metadata?: Record<string, string | number | boolean | null>;
+    /**
+     * Getter for code property (alias for errorCode)
+     * Provides compatibility with standard error patterns
+     */
+    get code(): string;
+    constructor(message: string, statusCode?: StatusCodeValue | 0, errorCode?: ApiErrorCodeValue, options?: ApiPackageErrorOptions<EndpointsList>);
+    /**
+     * Resolves the status code from the provided value or error definitions
+     */
+    private resolveStatusCode;
+    /**
+     * Emit error event for this error
+     * Can be called with a specific client context or uses global handlers
+     */
+    private emitEvent;
+    /**
+     * Creates an ApiPackageError from a fetchff ResponseError
+     */
+    static fromResponseError(responseError: ResponseError, config?: RequestConfig, clientContext?: ApiClientInstance<EndpointsList>): ApiPackageError;
+    /**
+     * Creates an ApiPackageError from a standard Error
+     */
+    static fromError(error: Error, statusCode?: StatusCodeValue | 0, errorCode?: ApiErrorCodeValue, context?: ApiClientInstance<EndpointsList>): ApiPackageError;
+    /**
+     * Classifies an error and returns appropriate code and status
+     */
+    private static classifyError;
+    /**
+     * Determines appropriate error code from ResponseError by looking up status in ERROR_DEFINITIONS
+     */
+    private static determineErrorCode;
+    /**
+     * Gets a generic error code based on HTTP status range
+     */
+    private static getGenericErrorCode;
+    /**
+     * Gets the error category from ERROR_DEFINITIONS
+     */
+    private categorizeError;
+    /**
+     * Checks if this is a specific category of error
+     */
+    isAuthError(): boolean;
+    isValidationError(): boolean;
+    isNetworkError(): boolean;
+    isServerError(): boolean;
+    isClientError(): boolean;
+    isRetryable(): boolean;
+    /**
+     * Converts to ErrorResponse format (as per task-020)
+     */
+    toJSON(): ErrorResponse;
+    /**
+     * Creates a string representation
+     */
+    toString(): string;
+    /**
+     * Check if error is an ApiPackageError
+     */
+    static isApiPackageError(error: Error | ApiPackageError): error is ApiPackageError;
+    /**
+     * Get user-friendly message for display
+     */
+    getUserMessage(): string;
+    /**
+     * Gets custom user message from error details if available
+     */
+    private getCustomUserMessage;
+    /**
+     * Gets default user message based on error category
+     */
+    private getDefaultUserMessage;
+}
+//# sourceMappingURL=ApiPackageError.d.ts.map

package/dist/api/errors/ApiPackageError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiPackageError.d.ts","sourceRoot":"","sources":["../../../src/api/errors/ApiPackageError.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE5D,OAAO,KAAK,EACV,sBAAsB,EACtB,YAAY,EACZ,iBAAiB,EACjB,mBAAmB,EAEnB,kBAAkB,EAClB,iBAAiB,EACjB,eAAe,EAChB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAS/D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAElD;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,KAAM,YAAW,mBAAmB;IACvE,SAAgB,UAAU,EAAE,eAAe,CAAC;IAC5C,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,OAAO,EAAE,MAAM,CAAC;IAChC,SAAgB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC;IAClE,SAAgB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvC,SAAgB,SAAS,EAAE,MAAM,CAAC;IAGlC,SAAgB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9C,SAAgB,QAAQ,EAAE,kBAAkB,CAAC;IAC7C,SAAgB,KAAK,CAAC,EAAE,KAAK,CAAC;IAC9B,SAAgB,OAAO,CAAC,EAAE,YAAY,CAAC;IAEvC,SAAgB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9C,SAAgB,YAAY,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACzD,SAAgB,OAAO,CAAC,EAAE,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC;IACnE,SAAgB,aAAa,CAAC,EAAE,KAAK,CAAC;IACtC,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC;IAE5E;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;gBAGC,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,eAAe,GAAG,CAAC,EAChC,SAAS,GAAE,iBAAiD,EAC5D,OAAO,CAAC,EAAE,sBAAsB,CAAC,aAAa,CAAC;IAwCjD;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAgBzB;;;OAGG;IACH,OAAO,CAAC,SAAS;IASjB;;OAEG;IACH,MAAM,CAAC,iBAAiB,CACtB,aAAa,EAAE,aAAa,EAC5B,MAAM,CAAC,EAAE,aAAa,EACtB,aAAa,CAAC,EAAE,iBAAiB,CAAC,aAAa,CAAC,GAC/C,eAAe;IAmBlB;;OAEG;IACH,MAAM,CAAC,SAAS,CACd,KAAK,EAAE,KAAK,EACZ,UAAU,CAAC,EAAE,eAAe,GAAG,CAAC,EAChC,SAAS,GAAE,iBAAiD,EAC5D,OAAO,CAAC,EAAE,iBAAiB,CAAC,aAAa,CAAC,GACzC,eAAe;IAelB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,aAAa;IA2B5B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAkBjC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAgBlC;;OAEG;IACH,OAAO,CAAC,eAAe;IAKvB;;OAEG;IACH,WAAW,IAAI,OAAO;IAOtB,iBAAiB,IAAI,OAAO;IAI5B,cAAc,IAAI,OAAO;IAIzB,aAAa,IAAI,OAAO;IAIxB,aAAa,IAAI,OAAO;IAOxB,WAAW,IAAI,OAAO;IAWtB;;OAEG;IACH,MAAM,IAAI,aAAa;IAWvB;;OAEG;IACH,QAAQ,IAAI,MAAM;IAIlB;;OAEG;IACH,MAAM,CAAC,iBAAiB,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe,GAAG,KAAK,IAAI,eAAe;IAIlF;;OAEG;IACH,cAAc,IAAI,MAAM;IAWxB;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAS5B;;OAEG;IACH,OAAO,CAAC,qBAAqB;CAwB9B"}

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

@@ -0,0 +1,24 @@
+/**
+ * Centralized error definitions mapping for @plyaz/api package
+ * Maps error codes to their HTTP status and metadata
+ */
+import type { ErrorDefinitions, ErrorDefinition } from '@plyaz/types/api';
+import { ERROR_CATEGORY } from '@plyaz/types';
+/**
+ * Centralized error definitions mapping
+ * Maps error codes to their HTTP status and metadata
+ */
+export declare const ERROR_DEFINITIONS: ErrorDefinitions;
+/**
+ * Helper function to get error definition by code
+ */
+export declare function getErrorDefinition(errorCode: string): ErrorDefinition | undefined;
+/**
+ * Helper function to get error code by status
+ */
+export declare function getErrorCodeByStatus(status: number): string | undefined;
+/**
+ * Helper function to get category for error code
+ */
+export declare function getErrorCategory(errorCode: string): (typeof ERROR_CATEGORY)[keyof typeof ERROR_CATEGORY];
+//# sourceMappingURL=definitions.d.ts.map

package/dist/api/errors/definitions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../../../src/api/errors/definitions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAE1E,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAI9C;;;GAGG;AACH,eAAO,MAAM,iBAAiB,EAAE,gBA0RtB,CAAC;AAEX;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS,CAEjF;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAKvE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,MAAM,GAChB,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAEtD"}