@dismissible/react-client 1.0.0 → 2.0.0-canary.5.88c27fb

package/dist/clients/defaultClient.d.ts

@@ -0,0 +1,25 @@
+import { DismissibleClient } from '../types/dismissible.types';
+/**
+ * Creates the default HTTP client using openapi-fetch
+ *
+ * @param baseUrl - The base URL for the API
+ * @returns A DismissibleClient implementation
+ *
+ * @example
+ * ```typescript
+ * // Use the default client directly
+ * const client = createDefaultClient("https://api.dismissible.io");
+ *
+ * // Or wrap it with custom behavior
+ * const customClient: DismissibleClient = {
+ *   getOrCreate: async (params) => {
+ *     console.log("Fetching item:", params.itemId);
+ *     const defaultClient = createDefaultClient(params.baseUrl);
+ *     return defaultClient.getOrCreate(params);
+ *   },
+ *   dismiss: async (params) => { ... },
+ *   restore: async (params) => { ... },
+ * };
+ * ```
+ */
+export declare const createDefaultClient: (baseUrl: string) => DismissibleClient;

package/dist/config/api.config.d.ts

@@ -1,21 +1,7 @@
-/**
- * API configuration settings
- */
-/**
- * Configuration interface for API settings
- */
 export interface ApiConfig {
     /** Base URL for API requests */
     baseUrl: string;
 }
-/**
- * Returns the API configuration based on the current environment
- * @returns The API configuration object
- */
 export declare const getConfig: () => ApiConfig;
-/**
- * Gets the API base URL
- * @returns The base URL for API requests
- */
 export declare const getBaseUrl: () => string;
 export default getConfig;

package/dist/contexts/DismissibleProvider.d.ts

@@ -27,6 +27,28 @@ import { DismissibleProviderProps } from '../types/dismissible.types';
  * >
  *   <App />
  * </DismissibleProvider>
+ *
+ * // With custom HTTP client
+ * const myClient: DismissibleClient = {
+ *   getOrCreate: async ({ resolvedPath, baseUrl, authHeaders, signal }) => {
+ *     const res = await axios.get(`${baseUrl}${resolvedPath}`, {
+ *       headers: { ...authHeaders, 'X-Correlation-ID': uuid() },
+ *       signal
+ *     });
+ *     return res.data.data;
+ *   },
+ *   dismiss: async (params) => { ... },
+ *   restore: async (params) => { ... },
+ * };
+ *
+ * <DismissibleProvider
+ *   userId="user-123"
+ *   jwt={token}
+ *   baseUrl="https://api.dismissible.io"
+ *   client={myClient}
+ * >
+ *   <App />
+ * </DismissibleProvider>
  * ```
  */
 export declare const DismissibleProvider: React.FC<DismissibleProviderProps>;