@plyaz/types 1.19.5 → 1.20.0

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

@@ -10,6 +10,8 @@ import type { UnknownRecord } from 'type-fest';
 import type { NETWORK_QUALITY, NetworkInfo } from '../network';
 import type { ConfigConflict, DebugInfo } from '../debugger';
 import type { PackageErrorLike } from '../../errors';
+import type { ReactNode } from 'react';
+import type { QueryClient } from '@tanstack/react-query';
 /**
  * Options for creating an API client
  * Endpoints are automatically included from src/api/endpoints
@@ -406,3 +408,60 @@ export interface SetupUnifiedHandlersParams {
     clientOptions?: ApiClientOptions;
     clearTemporaryOverrides?: () => void;
 }
+/**
+ * Props for API initialization loading component.
+ * Used by ApiProvider to display loading state during client initialization.
+ */
+export interface ApiInitializationLoadingProps {
+    /** Custom loading component override */
+    loading?: ReactNode;
+}
+/**
+ * Props for API initialization error component.
+ * Used by ApiProvider to display error state when initialization fails.
+ */
+export interface ApiInitializationErrorProps {
+    /** The error that occurred during initialization */
+    error: PackageErrorLike;
+    /** Custom error component override */
+    errorComponent?: (error: PackageErrorLike) => ReactNode;
+}
+/**
+ * Props for ApiProvider component.
+ * Provides React Query context and optionally initializes the default API client.
+ */
+export interface ApiProviderProps {
+    /** Child components that will have access to React Query */
+    children: ReactNode;
+    /** Optional custom QueryClient instance (defaults to shared singleton) */
+    queryClient?: QueryClient;
+    /**
+     * Optional global API configuration.
+     * Applied via setGlobalConfig() before client initialization.
+     * These settings apply to ALL API clients as defaults.
+     */
+    globalConfig?: ApiConfig;
+    /**
+     * Optional API client configuration.
+     * If provided, creates and sets the default API client automatically.
+     */
+    apiConfig?: ApiClientOptions;
+    /**
+     * Custom loading component to show while API client is initializing.
+     * Overrides the default ApiInitializationLoading component.
+     */
+    loading?: ReactNode;
+    /**
+     * Custom error renderer function.
+     * Overrides the default ApiInitializationError component.
+     */
+    error?: (error: PackageErrorLike) => ReactNode;
+    /**
+     * Callback when API client is ready.
+     */
+    onReady?: () => void;
+    /**
+     * Callback when API client initialization fails.
+     */
+    onError?: (error: PackageErrorLike) => void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plyaz/types",
-  "version": "1.19.5",
+  "version": "1.20.0",
   "author": "Redeemer Pace",
   "license": "ISC",
   "description": "Provides shared TypeScript types and schema utilities for validation and parsing in the @playz ecosystem.",