@plyaz/types 1.7.22 → 1.7.23

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

@@ -2,11 +2,14 @@
  * API Client Types
  * Defines the client interface and options
  */
-import type { ApiHandlerMethods } from 'fetchff';
+import type { ApiHandlerMethods, FetchResponse, RequestConfig, ResponseError } from 'fetchff';
 import type { ApiConfig } from '../config';
-import type { ConfigUpdateStrategy, HandlerStrategy } from '../events';
+import type { ConfigUpdateStrategy, EventScopeWithTemporary, HandlerStrategy } from '../events';
 import type { EndpointTypes } from '../endpoints';
 import type { UnknownRecord } from 'type-fest';
+import type { NETWORK_QUALITY, NetworkInfo } from '../network';
+import type { ConfigConflict, DebugInfo } from '../debugger';
+import type { ApiPackageErrorLike } from '../errors';
 /**
  * Options for creating an API client
  * Endpoints are automatically included from src/api/endpoints
@@ -146,3 +149,76 @@ export interface TrackConfigUpdateParams {
     /** Timestamp when the update started */
     startTime: number;
 }
+/**
+ * ClientEventManager Interface
+ * Defines the contract for client event management
+ *
+ * @template TEventManager - The event manager type (should have a getEmitter() method)
+ */
+export interface ClientEventManagerLike<TEventManager> {
+    readonly emitter: TEventManager extends {
+        getEmitter(): infer E;
+    } ? E : never;
+    addHandler(event: string, handler: Function | Function[], options?: HandlerOptions): () => void;
+    updateConfig(updates: Partial<ApiConfig>, options?: UpdateConfigOptions): void;
+    clearTemporaryOverrides(): void;
+    checkConflicts(): ConfigConflict[];
+    getDebugInfo(): DebugInfo;
+    startMonitoring(): void;
+    stopMonitoring(): void;
+    isMonitoring(): boolean;
+    getEventStats(): {
+        totalEvents: number;
+        totalListeners: number;
+        listenerCount: number;
+        recentEvents: Array<{
+            type: string;
+            timestamp: number;
+            data?: unknown;
+        }>;
+        overrideCount: number;
+        eventCountsByType: Record<string, number>;
+    };
+    getActiveScopes(): EventScopeWithTemporary[];
+    emitError(error: ApiPackageErrorLike): void;
+    emitRequestStart(config: RequestConfig): void;
+    emitResponseReceived<TData = unknown>(response: FetchResponse<TData>): void;
+    emitRetryAttempt<TResponse = unknown>(error: ResponseError<TResponse>, attemptNumber: number, config?: RequestConfig): void;
+    dispose(): void;
+}
+/**
+ * Extended API client with event methods
+ */
+/**
+ * API configuration with additional metadata for debugging and inspection
+ */
+export interface ApiConfigWithMetadata extends ApiConfig {
+    clientId?: string;
+    createdAt?: string;
+    lastUpdatedAt?: string;
+    updateCount?: number;
+    networkInfo?: NetworkInfo;
+    networkQuality?: NETWORK_QUALITY;
+    activeOverrides?: string[];
+    conflictDetection?: boolean;
+    configHierarchy?: {
+        hasGlobalConfig: boolean;
+        hasClientConfig: boolean;
+        hasTemporaryOverrides: boolean;
+        configOverrideStrategy?: ConfigUpdateStrategy;
+    };
+}
+export type ApiClientWithEvents<TEventManager, EndpointsList = UnknownRecord> = ApiClientInstance<EndpointsList> & {
+    eventManager: ClientEventManagerLike<TEventManager>;
+    on(event: string, handler: Function): () => void;
+    off(event: string, handler: Function): void;
+    checkConflicts(): ConfigConflict[];
+    getDebugInfo(): DebugInfo;
+    startMonitoring(): void;
+    stopMonitoring(): void;
+    isMonitoring(): boolean;
+    dispose(): void;
+    updateConfig(updates: Partial<ApiClientOptions>, options?: UpdateConfigOptions): void;
+    clearTemporaryOverrides(): void;
+    getConfig(): ApiConfigWithMetadata;
+};

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

@@ -7,7 +7,7 @@
  */
 import type { ResponseError, RequestConfig } from 'fetchff';
 import type { ERROR_CATEGORY, ErrorDetail, ErrorResponse } from '../../errors';
-import type { API_ERROR_CODES, OPERATIONS, ERROR_FIELDS, STORAGE_TYPES } from '..';
+import type { API_ERROR_CODES, OPERATIONS, ERROR_FIELDS, STORAGE_TYPES, ApiClientInstance } from '..';
 /**
  * Typed constants as types for convenience
  */
@@ -226,3 +226,15 @@ export interface ErrorHandlerOptions {
      */
     strategy?: 'merge' | 'replace' | 'prepend' | 'append';
 }
+/**
+ * Options for creating an ApiPackageError
+ */
+export interface ApiPackageErrorOptions<EndpointsList> {
+    responseError?: ResponseError;
+    statusCode?: number;
+    errors?: ErrorDetail<unknown, unknown, unknown>[];
+    correlationId?: string;
+    cause?: Error;
+    context?: ErrorContext;
+    clientContext?: ApiClientInstance<EndpointsList>;
+}