api-core-lib 12.0.10 → 12.0.11

package/dist/useApiRecord.types-B45E0qux.d.cts

@@ -0,0 +1,90 @@
+import { Dispatch, SetStateAction } from 'react';
+import { R as RequestConfig, h as ApiError, S as StandardResponse, e as ActionOptions } from './apiModule.types-CpwGDEpG.cjs';
+
+/**
+ * Represents the internal state of the `useApiRecord` hook.
+ * It mirrors the `StandardResponse` structure, which is the unified response format
+ * used across the library.
+ * @template T The data type of the record.
+ */
+type UseApiRecordState<T> = StandardResponse<T>;
+/**
+ * Defines the action methods provided by the `useApiRecord` hook to interact with
+ * a single API resource.
+ * @template T The data type of the record.
+ */
+interface UseApiRecordActions<T> {
+    /**
+     * Manually fetches or refetches the record from the API.
+     */
+    fetch: () => Promise<void>;
+    /**
+     * Partially updates the record using an HTTP PATCH request.
+     * @param updatedItem An object containing the fields to update.
+     * @param options Additional request options, allowing overrides for this specific action.
+     * @returns A promise that resolves to the standard response object for the updated record.
+     */
+    update: (updatedItem: Partial<T>, options?: ActionOptions) => Promise<StandardResponse<T>>;
+    /**
+     * Replaces the entire record with a new one using an HTTP PUT request.
+     * @param item The complete new record object.
+     * @param options Additional request options.
+     * @returns A promise that resolves to the standard response object for the replaced record.
+     */
+    put: (item: T, options?: ActionOptions) => Promise<StandardResponse<T>>;
+    /**
+     * Deletes the record using an HTTP DELETE request.
+     * @param options Additional request options.
+     * @returns A promise that resolves to a standard response object with a null data payload.
+     */
+    remove: (options?: ActionOptions) => Promise<StandardResponse<null>>;
+    /**
+     * Resets the hook's state to its initial value.
+     */
+    resetState: () => void;
+}
+/**
+ * Defines the configuration options for the `useApiRecord` hook.
+ * @template T The data type of the record.
+ */
+interface UseApiRecordConfig<T> {
+    /**
+     * The base API endpoint template for the resource.
+     * Can contain placeholders like `{endpointName}`.
+     * @example 'v1/dynamic/{endpointName}'
+     */
+    endpoint: string;
+    /**
+     * An object containing key-value pairs to replace placeholders in the endpoint template.
+     * @example { endpointName: 'products' }
+     */
+    pathParams?: Record<string, string | number>;
+    /** The unique identifier of the record to fetch or modify. */
+    recordId?: string | number | null;
+    /** Optional initial data to populate the state before the first fetch is complete. */
+    initialData?: T | null;
+    /** If `false`, the hook will not automatically fetch data on mount. Defaults to `true`. */
+    enabled?: boolean;
+    /** If `true`, the record will be refetched after a successful `update`, `put`, or `remove` action. Defaults to `true`. */
+    refetchAfterChange?: boolean;
+    /** Default `RequestConfig` to apply to the initial GET request made by the hook. */
+    requestConfig?: RequestConfig;
+    /** A callback function executed on a successful API action. */
+    onSuccess?: (message: string, data?: any) => void;
+    /** A callback function executed on a failed API action. */
+    onError?: (message: string, error?: ApiError) => void;
+}
+/**
+ * The return value of the `useApiRecord` hook.
+ * @template T The data type of the record.
+ */
+interface UseApiRecordReturn<T> {
+    /** The current state of the API request, including data, loading, and error status. */
+    state: UseApiRecordState<T>;
+    /** Action methods to manipulate the record. */
+    actions: UseApiRecordActions<T>;
+    /** A React dispatch function to manually set the hook's state. Use with caution. */
+    setState: Dispatch<SetStateAction<UseApiRecordState<T>>>;
+}
+
+export type { UseApiRecordConfig as U, UseApiRecordReturn as a, UseApiRecordState as b, UseApiRecordActions as c };

package/dist/useApiRecord.types-DlrlXL1t.d.ts

@@ -0,0 +1,90 @@
+import { Dispatch, SetStateAction } from 'react';
+import { R as RequestConfig, h as ApiError, S as StandardResponse, e as ActionOptions } from './apiModule.types-CpwGDEpG.js';
+
+/**
+ * Represents the internal state of the `useApiRecord` hook.
+ * It mirrors the `StandardResponse` structure, which is the unified response format
+ * used across the library.
+ * @template T The data type of the record.
+ */
+type UseApiRecordState<T> = StandardResponse<T>;
+/**
+ * Defines the action methods provided by the `useApiRecord` hook to interact with
+ * a single API resource.
+ * @template T The data type of the record.
+ */
+interface UseApiRecordActions<T> {
+    /**
+     * Manually fetches or refetches the record from the API.
+     */
+    fetch: () => Promise<void>;
+    /**
+     * Partially updates the record using an HTTP PATCH request.
+     * @param updatedItem An object containing the fields to update.
+     * @param options Additional request options, allowing overrides for this specific action.
+     * @returns A promise that resolves to the standard response object for the updated record.
+     */
+    update: (updatedItem: Partial<T>, options?: ActionOptions) => Promise<StandardResponse<T>>;
+    /**
+     * Replaces the entire record with a new one using an HTTP PUT request.
+     * @param item The complete new record object.
+     * @param options Additional request options.
+     * @returns A promise that resolves to the standard response object for the replaced record.
+     */
+    put: (item: T, options?: ActionOptions) => Promise<StandardResponse<T>>;
+    /**
+     * Deletes the record using an HTTP DELETE request.
+     * @param options Additional request options.
+     * @returns A promise that resolves to a standard response object with a null data payload.
+     */
+    remove: (options?: ActionOptions) => Promise<StandardResponse<null>>;
+    /**
+     * Resets the hook's state to its initial value.
+     */
+    resetState: () => void;
+}
+/**
+ * Defines the configuration options for the `useApiRecord` hook.
+ * @template T The data type of the record.
+ */
+interface UseApiRecordConfig<T> {
+    /**
+     * The base API endpoint template for the resource.
+     * Can contain placeholders like `{endpointName}`.
+     * @example 'v1/dynamic/{endpointName}'
+     */
+    endpoint: string;
+    /**
+     * An object containing key-value pairs to replace placeholders in the endpoint template.
+     * @example { endpointName: 'products' }
+     */
+    pathParams?: Record<string, string | number>;
+    /** The unique identifier of the record to fetch or modify. */
+    recordId?: string | number | null;
+    /** Optional initial data to populate the state before the first fetch is complete. */
+    initialData?: T | null;
+    /** If `false`, the hook will not automatically fetch data on mount. Defaults to `true`. */
+    enabled?: boolean;
+    /** If `true`, the record will be refetched after a successful `update`, `put`, or `remove` action. Defaults to `true`. */
+    refetchAfterChange?: boolean;
+    /** Default `RequestConfig` to apply to the initial GET request made by the hook. */
+    requestConfig?: RequestConfig;
+    /** A callback function executed on a successful API action. */
+    onSuccess?: (message: string, data?: any) => void;
+    /** A callback function executed on a failed API action. */
+    onError?: (message: string, error?: ApiError) => void;
+}
+/**
+ * The return value of the `useApiRecord` hook.
+ * @template T The data type of the record.
+ */
+interface UseApiRecordReturn<T> {
+    /** The current state of the API request, including data, loading, and error status. */
+    state: UseApiRecordState<T>;
+    /** Action methods to manipulate the record. */
+    actions: UseApiRecordActions<T>;
+    /** A React dispatch function to manually set the hook's state. Use with caution. */
+    setState: Dispatch<SetStateAction<UseApiRecordState<T>>>;
+}
+
+export type { UseApiRecordConfig as U, UseApiRecordReturn as a, UseApiRecordState as b, UseApiRecordActions as c };

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "api-core-lib",
-  "version": "12.0.10",
+  "version": "12.0.11",
   "description": "A flexible and powerful API client library for modern web applications.",
   "type": "module",
 
   "exports": {
-    ".": {
+    ".": { 
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
@@ -14,6 +14,11 @@
       "types": "./dist/server.d.ts",
       "import": "./dist/server.js",
       "require": "./dist/server.cjs"
+    },
+    "./client": {
+      "types": "./dist/client.d.ts",
+      "import": "./dist/client.js",
+      "require": "./dist/client.cjs"
     }
   },