@plyaz/types 1.7.16 → 1.7.18

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

@@ -0,0 +1,129 @@
+/**
+ * Error handling types for @plyaz/api package
+ * Following the Confluence architecture specifications
+ */
+import type { OPERATIONS, ERROR_FIELDS, STORAGE_TYPES } from '@plyaz/config';
+import type { ERROR_CATEGORY, BaseErrorResponse, ErrorDetail } from '../../errors';
+/**
+ * Typed constants as types for convenience
+ */
+export type ErrorOperation = (typeof OPERATIONS)[keyof typeof OPERATIONS];
+export type ErrorField = (typeof ERROR_FIELDS)[keyof typeof ERROR_FIELDS];
+export type StorageType = (typeof STORAGE_TYPES)[keyof typeof STORAGE_TYPES];
+/**
+ * Translation interpolation variables
+ */
+export interface I18nContext {
+    [key: string]: string | number | boolean | null | undefined;
+}
+/**
+ * Cache error context
+ */
+export interface CacheErrorContext extends BaseErrorResponse {
+    operation: ErrorOperation;
+    cacheKey?: string;
+    keyPrefix?: string;
+    exactKey?: string;
+    storageType?: StorageType | string;
+    fallbackAvailable?: boolean;
+}
+/**
+ * Headers error context
+ */
+export interface HeadersErrorContext extends BaseErrorResponse {
+    operation: ErrorOperation;
+    warningCount?: number;
+    warnings?: string;
+}
+/**
+ * Regional error context
+ */
+export interface RegionalErrorContext extends BaseErrorResponse {
+    operation: ErrorOperation;
+    requestedPreset?: string;
+    availablePresets?: string;
+    fallbackUsed?: string;
+}
+/**
+ * Network error context
+ */
+export interface NetworkErrorContext extends BaseErrorResponse {
+    operation: ErrorOperation;
+    requestedPreset?: string;
+    availablePresets?: string;
+}
+/**
+ * Error definition structure
+ */
+export interface ErrorDefinition {
+    code: string;
+    status: number;
+    category: typeof ERROR_CATEGORY;
+    fieldsLeft?: string[];
+}
+/**
+ * Map of error codes to their definitions
+ */
+export type ErrorDefinitions = {
+    [key: string]: ErrorDefinition;
+};
+/**
+ * Union type for all error contexts
+ */
+export type ErrorContext = BaseErrorResponse | CacheErrorContext | HeadersErrorContext | RegionalErrorContext | NetworkErrorContext;
+/**
+ * Options for creating an ApiPackageError
+ * Note: ApiPackageError class itself is not migrated as it contains implementation
+ */
+export interface ApiPackageErrorOptionsErrorDetail<ValueGiven, AllowedValues, Constraints> {
+    responseError?: unknown;
+    statusCode?: number;
+    errors?: ErrorDetail<ValueGiven, AllowedValues, Constraints>[];
+    correlationId?: string;
+    cause?: Error;
+    context?: ErrorContext;
+    clientContext?: unknown;
+}
+/**
+ * Event handler types for API package errors
+ * Note: ApiPackageError is not imported here to avoid implementation dependencies
+ */
+export interface ErrorEventHandlers<ApiPackageError> {
+    onValidationError?: ((error: ApiPackageError) => void) | Array<(error: ApiPackageError) => void>;
+    onNetworkError?: ((error: ApiPackageError) => void) | Array<(error: ApiPackageError) => void>;
+    onAuthenticationError?: ((error: ApiPackageError) => void) | Array<(error: ApiPackageError) => void>;
+    onAuthorizationError?: ((error: ApiPackageError) => void) | Array<(error: ApiPackageError) => void>;
+    onRateLimitError?: ((error: ApiPackageError) => void) | Array<(error: ApiPackageError) => void>;
+    onTimeoutError?: ((error: ApiPackageError) => void) | Array<(error: ApiPackageError) => void>;
+    onConflictError?: ((error: ApiPackageError) => void) | Array<(error: ApiPackageError) => void>;
+    onNotFoundError?: ((error: ApiPackageError) => void) | Array<(error: ApiPackageError) => void>;
+    onServerError?: ((error: ApiPackageError) => void) | Array<(error: ApiPackageError) => void>;
+    onClientError?: ((error: ApiPackageError) => void) | Array<(error: ApiPackageError) => void>;
+    onExternalServiceError?: ((error: ApiPackageError) => void) | Array<(error: ApiPackageError) => void>;
+    onCacheError?: ((error: ApiPackageError) => void) | Array<(error: ApiPackageError) => void>;
+    onHeadersError?: ((error: ApiPackageError) => void) | Array<(error: ApiPackageError) => void>;
+    onRetryError?: ((error: ApiPackageError) => void) | Array<(error: ApiPackageError) => void>;
+    onStrategyError?: ((error: ApiPackageError) => void) | Array<(error: ApiPackageError) => void>;
+    onRegionalError?: ((error: ApiPackageError) => void) | Array<(error: ApiPackageError) => void>;
+    onUnknownError?: ((error: ApiPackageError) => void) | Array<(error: ApiPackageError) => void>;
+    onAnyError?: ((error: ApiPackageError) => void) | Array<(error: ApiPackageError) => void>;
+}
+/**
+ * Options for error handler registration
+ */
+export interface ErrorHandlerOptions {
+    /**
+     * The scope level for the handler
+     * @default 'GLOBAL'
+     */
+    scope?: 'GLOBAL' | 'CONFIG' | 'CLIENT' | 'REQUEST' | 'TEMPORARY';
+    /**
+     * Strategy for handling multiple handlers
+     * - 'merge': Add to existing handlers (default)
+     * - 'replace': Replace existing handlers for this event type
+     * - 'prepend': Add new handlers before existing ones
+     * - 'append': Add new handlers after existing ones
+     * @default 'merge'
+     */
+    strategy?: 'merge' | 'replace' | 'prepend' | 'append';
+}

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

@@ -0,0 +1,5 @@
+/**
+ * API Events Types
+ * Re-exports all event-related types for the API package
+ */
+export type * from './types';