api-core-lib 6.6.5 → 7.6.6

package/dist/index.d.mts

@@ -155,6 +155,8 @@ interface UseApiConfig<T> {
     refetchAfterChange?: boolean;
     /** A default `RequestConfig` to apply to all GET requests made by the hook. */
     requestConfig?: RequestConfig;
+    encodeQuery: boolean;
+    pathParams: Record<string, string | number>;
     /** Callback function executed on a successful action. */
     onSuccess?: (message: string, data?: T) => void;
     /** Callback function executed on a failed action. */
@@ -236,6 +238,12 @@ interface ApiClientConfig {
      * @default 'info'
      */
     logLevel?: LogLevel;
+    /**
+     * If true, all requests will be treated as public by default.
+     * A request can override this by explicitly setting `isPublic: false`.
+     * @default false
+     */
+    defaultIsPublic?: boolean;
 }
 
 /**
@@ -340,10 +348,14 @@ declare const processResponse: <T>(responseOrError: AxiosResponse<any> | ApiErro
 
 /**
  * @file src/hooks/useApi.types.ts
- * @description This file defines the professional, publicly-facing types
- * returned by the `useApi` hook, providing a clean and stable contract for consumers.
+ * @description This file defines the professional, publicly-facing types for the `useApi` hook,
+ * providing a clean and stable contract for consumers.
  */
 
+/**
+ * Configuration object for the `useApi` hook.
+ * @template T The type of the data entity.
+ */
 /**
  * The primary state object managed by the `useApi` hook.
  * It contains the fetched data, loading status, and any potential errors.
@@ -356,7 +368,18 @@ type UseApiState<T> = StandardResponse<T | T[]>;
  * @template T The type of the data entity being managed.
  */
 interface UseApiActions<T> {
-    /** Fetches or refetches the list of data. */
+    /**
+     * Manually triggers a refetch of the hook's primary data using the current query options.
+     * This is useful for manual refresh buttons.
+     */
+    /**
+     * Fetches data from an arbitrary path, independent of the hook's main state.
+     * This is useful for one-off requests that shouldn't affect the primary data.
+     * @param path The relative or absolute path to fetch from.
+     * @param pathParams Optional parameters to fill dynamic parts of the path.
+     * @param options Optional Axios request configuration.
+     * @returns A promise that resolves with the standard API response.
+     */
     fetch: (options?: QueryOptions) => Promise<void>;
     /** Creates a new item. */
     create: (newItem: Partial<T>, options?: ActionOptions) => Promise<StandardResponse<T>>;
@@ -380,7 +403,7 @@ interface UseApiQuery {
     options: QueryOptions;
     /** A function to set the entire query options object at once. */
     setOptions: React.Dispatch<React.SetStateAction<QueryOptions>>;
-    /** Sets the current page number and resets to the first page. */
+    /** Sets the current page number. */
     setPage: (page: number) => void;
     /** Sets the number of items per page and resets to the first page. */
     setLimit: (limit: number) => void;
@@ -393,7 +416,7 @@ interface UseApiQuery {
     }[]) => void;
     /** Sets the filter object and resets to the first page. */
     setFilters: (filter: Record<string, any>) => void;
-    /** Sets a single, custom query parameter and resets to the first page. */
+    /** Sets a single, custom query parameter. */
     setQueryParam: (key: string, value: any) => void;
     /** Resets the query options to their initial state. */
     reset: () => void;

package/dist/index.d.ts

@@ -155,6 +155,8 @@ interface UseApiConfig<T> {
     refetchAfterChange?: boolean;
     /** A default `RequestConfig` to apply to all GET requests made by the hook. */
     requestConfig?: RequestConfig;
+    encodeQuery: boolean;
+    pathParams: Record<string, string | number>;
     /** Callback function executed on a successful action. */
     onSuccess?: (message: string, data?: T) => void;
     /** Callback function executed on a failed action. */
@@ -236,6 +238,12 @@ interface ApiClientConfig {
      * @default 'info'
      */
     logLevel?: LogLevel;
+    /**
+     * If true, all requests will be treated as public by default.
+     * A request can override this by explicitly setting `isPublic: false`.
+     * @default false
+     */
+    defaultIsPublic?: boolean;
 }
 
 /**
@@ -340,10 +348,14 @@ declare const processResponse: <T>(responseOrError: AxiosResponse<any> | ApiErro
 
 /**
  * @file src/hooks/useApi.types.ts
- * @description This file defines the professional, publicly-facing types
- * returned by the `useApi` hook, providing a clean and stable contract for consumers.
+ * @description This file defines the professional, publicly-facing types for the `useApi` hook,
+ * providing a clean and stable contract for consumers.
  */
 
+/**
+ * Configuration object for the `useApi` hook.
+ * @template T The type of the data entity.
+ */
 /**
  * The primary state object managed by the `useApi` hook.
  * It contains the fetched data, loading status, and any potential errors.
@@ -356,7 +368,18 @@ type UseApiState<T> = StandardResponse<T | T[]>;
  * @template T The type of the data entity being managed.
  */
 interface UseApiActions<T> {
-    /** Fetches or refetches the list of data. */
+    /**
+     * Manually triggers a refetch of the hook's primary data using the current query options.
+     * This is useful for manual refresh buttons.
+     */
+    /**
+     * Fetches data from an arbitrary path, independent of the hook's main state.
+     * This is useful for one-off requests that shouldn't affect the primary data.
+     * @param path The relative or absolute path to fetch from.
+     * @param pathParams Optional parameters to fill dynamic parts of the path.
+     * @param options Optional Axios request configuration.
+     * @returns A promise that resolves with the standard API response.
+     */
     fetch: (options?: QueryOptions) => Promise<void>;
     /** Creates a new item. */
     create: (newItem: Partial<T>, options?: ActionOptions) => Promise<StandardResponse<T>>;
@@ -380,7 +403,7 @@ interface UseApiQuery {
     options: QueryOptions;
     /** A function to set the entire query options object at once. */
     setOptions: React.Dispatch<React.SetStateAction<QueryOptions>>;
-    /** Sets the current page number and resets to the first page. */
+    /** Sets the current page number. */
     setPage: (page: number) => void;
     /** Sets the number of items per page and resets to the first page. */
     setLimit: (limit: number) => void;
@@ -393,7 +416,7 @@ interface UseApiQuery {
     }[]) => void;
     /** Sets the filter object and resets to the first page. */
     setFilters: (filter: Record<string, any>) => void;
-    /** Sets a single, custom query parameter and resets to the first page. */
+    /** Sets a single, custom query parameter. */
     setQueryParam: (key: string, value: any) => void;
     /** Resets the query options to their initial state. */
     reset: () => void;