api-core-lib 12.0.9 → 12.0.11

package/dist/client.d.cts

@@ -0,0 +1,28 @@
+import { AxiosInstance } from 'axios';
+import { U as UseApiConfig, A as ActionConfigModule, a as ApiModuleConfig, b as UseApiModuleOptions, c as UseApiModuleReturn } from './apiModule.types-CpwGDEpG.cjs';
+import { U as UseApiRecordConfig, a as UseApiRecordReturn } from './useApiRecord.types-B45E0qux.cjs';
+import * as React from 'react';
+
+declare function useApi<T>(axiosInstance: AxiosInstance, config: UseApiConfig<T>): any;
+
+/**
+ * A React hook for managing the lifecycle of a single API resource (a record).
+ * It handles fetching, updating, replacing, and deleting a record, while managing
+ * loading, error, and data states. It supports dynamic path parameters for flexible API routing.
+ *
+ * @template T The data type of the record being managed.
+ * @param {AxiosInstance} axiosInstance - The configured Axios instance for making API calls.
+ * @param {UseApiRecordConfig<T>} config - Configuration options for the hook.
+ * @returns {UseApiRecordReturn<T>} An object containing the state, actions, and setState function.
+ */
+declare function useApiRecord<T>(axiosInstance: AxiosInstance, config: UseApiRecordConfig<T>): UseApiRecordReturn<T>;
+
+type EffectCallback = () => (void | (() => void));
+type DependencyList = readonly any[];
+declare function useDeepCompareEffect(callback: EffectCallback, dependencies: DependencyList): void;
+
+declare const ApiModuleProvider: React.Provider<UseApiModuleReturn<any> | null>;
+declare function useModuleContext<TModule extends ApiModuleConfig<any>>(): UseApiModuleReturn<TModule['actions']>;
+declare function useApiModule<TActions extends Record<string, ActionConfigModule<any, any>>>(axiosInstance: AxiosInstance, moduleConfig: ApiModuleConfig<TActions>, options?: UseApiModuleOptions): UseApiModuleReturn<TActions>;
+
+export { ApiModuleProvider, useApi, useApiModule, useApiRecord, useDeepCompareEffect, useModuleContext };

package/dist/client.d.ts

@@ -0,0 +1,28 @@
+import { AxiosInstance } from 'axios';
+import { U as UseApiConfig, A as ActionConfigModule, a as ApiModuleConfig, b as UseApiModuleOptions, c as UseApiModuleReturn } from './apiModule.types-CpwGDEpG.js';
+import { U as UseApiRecordConfig, a as UseApiRecordReturn } from './useApiRecord.types-DlrlXL1t.js';
+import * as React from 'react';
+
+declare function useApi<T>(axiosInstance: AxiosInstance, config: UseApiConfig<T>): any;
+
+/**
+ * A React hook for managing the lifecycle of a single API resource (a record).
+ * It handles fetching, updating, replacing, and deleting a record, while managing
+ * loading, error, and data states. It supports dynamic path parameters for flexible API routing.
+ *
+ * @template T The data type of the record being managed.
+ * @param {AxiosInstance} axiosInstance - The configured Axios instance for making API calls.
+ * @param {UseApiRecordConfig<T>} config - Configuration options for the hook.
+ * @returns {UseApiRecordReturn<T>} An object containing the state, actions, and setState function.
+ */
+declare function useApiRecord<T>(axiosInstance: AxiosInstance, config: UseApiRecordConfig<T>): UseApiRecordReturn<T>;
+
+type EffectCallback = () => (void | (() => void));
+type DependencyList = readonly any[];
+declare function useDeepCompareEffect(callback: EffectCallback, dependencies: DependencyList): void;
+
+declare const ApiModuleProvider: React.Provider<UseApiModuleReturn<any> | null>;
+declare function useModuleContext<TModule extends ApiModuleConfig<any>>(): UseApiModuleReturn<TModule['actions']>;
+declare function useApiModule<TActions extends Record<string, ActionConfigModule<any, any>>>(axiosInstance: AxiosInstance, moduleConfig: ApiModuleConfig<TActions>, options?: UseApiModuleOptions): UseApiModuleReturn<TActions>;
+
+export { ApiModuleProvider, useApi, useApiModule, useApiRecord, useDeepCompareEffect, useModuleContext };