api-core-lib 12.6.4 → 12.8.4

package/dist/index.d.mts

@@ -1,41 +1,25 @@
-import { InternalAxiosRequestConfig, AxiosResponse, AxiosRequestConfig, AxiosProgressEvent, AxiosInstance, Method } from 'axios';
-import { Dispatch, SetStateAction } from 'react';
+import { InternalAxiosRequestConfig, AxiosResponse, AxiosRequestConfig, AxiosProgressEvent, AxiosInstance, Method, AxiosError } from 'axios';
+import React$1, { Dispatch, SetStateAction } from 'react';
 
 /**
- * @file src/types.ts
- * @description This file serves as the central source for all data types and interfaces
- * used throughout the library. Defining types here ensures consistency, type safety,
- * and provides a clear API contract for the end-user.
- */
-
-/**
- * Defines the structure for pagination metadata returned by the API.
+ * يمثل معلومات الترقيم (Pagination) التي قد تعود من ה-API.
  */
 interface PaginationMeta {
     itemsPerPage: number;
     totalItems: number;
     currentPage: number;
     totalPages: number;
+    [key: string]: any;
 }
 /**
- * Represents the standard wrapper that an API might use for its responses.
- * @template T The type of the core data payload.
- */
-interface ApiResponse<T = any> {
-    success?: boolean;
-    data: T;
-    message?: string;
-    meta?: PaginationMeta;
-}
-/**
- * Defines the structure for a single field validation error.
+ * يمثل خطأ تحقق واحد لحقل معين.
  */
 interface ValidationError {
     field: string;
     message: string;
 }
 /**
- * Represents the unified error object produced by the library for any failed request.
+ * يمثل كائن الخطأ الموحد الذي تنتجه المكتبة.
  */
 interface ApiError {
     message: string;
@@ -45,12 +29,14 @@ interface ApiError {
     requestId?: string;
 }
 /**
- * The standardized, final response object that every library function returns.
- * This is the primary type developers will interact with.
- * @template T The type of the final, unwrapped data.
+ * الكائن القياسي والموحد الذي تعيده جميع دوال المكتبة.
+ * هذا هو النوع الأساسي الذي سيتعامل معه المطورون.
+ * @template T نوع البيانات الأساسية.
  */
 interface StandardResponse<T> {
     data: T | null;
+    links?: Record<string, string | null>;
+    meta?: PaginationMeta | Record<string, any>;
     rawResponse: any;
     error: ApiError | null;
     loading: boolean;
@@ -58,128 +44,30 @@ interface StandardResponse<T> {
     message?: string;
     validationErrors?: ValidationError[];
 }
-/**
- * Represents the set of authentication tokens managed by the library.
- */
 interface Tokens {
     accessToken: string | null;
     refreshToken: string | null;
     expiresAt?: number;
     tokenType?: string;
 }
-/**
- * An interface for a token manager, allowing the logic for token storage to be decoupled.
- * Consumers of the library can provide their own implementation (e.g., LocalStorage, Cookies).
- */
 interface TokenManager {
     getTokens(): Promise<Tokens>;
     setTokens(tokens: Tokens): Promise<void>;
     clearTokens(): Promise<void>;
-    /**
-     * Determines the operating context.
-     * @returns `true` if tokens are in secure httpOnly cookies (server-side context).
-     * @returns `false` if tokens are accessible from the client (e.g., localStorage).
-     */
     isHttpOnly(): boolean;
 }
-/**
- * The context object passed to each middleware function in the pipeline.
- */
 interface MiddlewareContext {
     req: InternalAxiosRequestConfig;
     res?: AxiosResponse;
     error?: any;
     custom?: Record<string, any>;
 }
-/**
- * Defines the signature for a middleware function.
- */
 type Middleware = (context: MiddlewareContext, next: () => Promise<void>) => Promise<void>;
-/**
- * Extends the default Axios request configuration with custom properties for the library.
- */
-interface RequestConfig extends AxiosRequestConfig {
-    /** If true, the request will bypass the token injection logic. */
-    isPublic?: boolean;
-    /** A key for managing request cancellation. */
-    cancelTokenKey?: string;
-    /** Callback for upload progress events. */
-    onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
-    /** Callback for download progress events. */
-    onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void;
-}
-/**
- * Defines a flexible query options interface for pagination, sorting, filtering, and searching.
- * Supports standard keys as well as any custom top-level query parameters.
- * @example { page: 1, limit: 10, search: 'term', status: 'published' }
- */
-interface QueryOptions {
-    page?: number;
-    limit?: number;
-    search?: string;
-    sortBy?: {
-        key: string;
-        direction: 'asc' | 'desc';
-    }[];
-    filter?: Record<string, any>;
-    [key: string]: any;
-}
-/**
- * Defines additional options for action methods like create, update, or delete.
- */
-interface ActionOptions extends RequestConfig {
-    /**
-     * Overrides the default endpoint for a specific action. Useful for specialized routes.
-     * @example update('123', { status: 'active' }, { endpoint: '/items/123/activate' })
-     */
-    endpoint?: string;
-    /**
-     * Overrides the `refetchAfterChange` setting for a single action.
-     */
-    refetch?: boolean;
-}
-/**
- * The main configuration object for the `useApi` hook.
- * @template T The data type the hook will manage.
- */
-interface UseApiConfig<T> {
-    /** The base API endpoint for the resource (e.g., '/users'). */
-    endpoint: string;
-    /** Initial data to populate the state before the first fetch. */
-    initialData?: T | null;
-    /** Default query options to use for the initial fetch. */
-    initialQuery?: QueryOptions;
-    /** If false, the hook will not fetch data automatically on mount. */
-    enabled?: boolean;
-    /** If true, data will be refetched automatically after a successful create, update, or delete action. */
-    refetchAfterChange?: boolean;
-    /** A default `RequestConfig` to apply to all GET requests made by the hook. */
-    requestConfig?: RequestConfig;
-    /**
-     * [NEW] كائن يحتوي على قيم المتغيرات في قالب المسار.
-     */
-    pathParams?: Record<string, string | number>;
-    encodeQuery?: boolean;
-    /** Callback function executed on a successful action. */
-    onSuccess?: (message: string, data?: T) => void;
-    /** Callback function executed on a failed action. */
-    onError?: (message: string, error?: ApiError) => void;
-}
-/**
- * Defines the configuration for the automatic token refresh mechanism.
- */
+type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'silent';
 interface RefreshTokenConfig {
-    /** The API path for the token refresh endpoint (e.g., '/auth/refresh'). */
     path: string;
-    /** A function to build the request body for the refresh call. */
     buildRequestBody?: (refreshToken: string) => Record<string, any>;
-    /** A function to build any custom headers for the refresh call. */
     buildRequestHeaders?: (currentTokens: Tokens) => Record<string, string>;
-    /**
-     * A function to extract the new tokens from the refresh API's response data.
-     * @param responseData The raw data from the refresh API response.
-     * @returns An object containing the new token details.
-     */
     extractTokens: (responseData: any) => {
         accessToken: string;
         refreshToken?: string;
@@ -187,125 +75,44 @@ interface RefreshTokenConfig {
         tokenType?: string;
     };
 }
-/**
- * Defines the available levels for logging.
- * 'debug': Logs everything.
- * 'info': Logs standard requests and responses.
- * 'warn': Logs warnings and errors.
- * 'error': Logs only critical errors.
- * 'silent': Disables all logging.
- */
-type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'silent';
-/**
- * An interface for a custom logger, compatible with the standard `console` object.
- * It now includes a `debug` method for more granular logging.
- */
-/**
- * The main configuration object for the `createApiClient` factory function.
- */
 interface ApiClientConfig {
-    /** The base URL for all API requests. */
     baseURL?: string;
-    /** The token manager instance responsible for handling token storage. */
     tokenManager: TokenManager;
-    /** The request timeout in milliseconds. */
     timeout?: number;
-    /** Default headers to be sent with every request. */
     headers?: Record<string, string>;
-    /** If true, cookies will be sent with cross-origin requests. */
     withCredentials?: boolean;
-    /** Configuration for the automatic token refresh mechanism. */
     refreshTokenConfig?: RefreshTokenConfig;
-    /** A callback function executed if the token refresh process fails. */
     onRefreshError?: (error: any) => void;
-    /** A custom logger instance. Defaults to the browser `console`. */
-    /** An array of middleware functions to be executed with every request. */
     middleware?: Middleware[];
-    /**
-     * Sets the verbosity of the internal logger.
-     * @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;
     maxTokenRefreshRetries?: number;
     maxQueueSize?: number;
 }
-
-declare function createApiClient(config: ApiClientConfig): AxiosInstance;
-
-/**
- * @file src/hooks/useApi.types.ts
- * @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.
- * @template T The type of the data entity being managed.
- */
-type UseApiState<T> = StandardResponse<T>;
-/**
- * A collection of callable functions for performing CRUD and other operations.
- * These actions automatically handle state updates like loading and refetching.
- * @template T The type of the data entity being managed.
- */
-interface UseApiActions<T, TListItem = T extends (infer U)[] ? U : T> {
-    fetch: (querryOptions?: QueryOptions) => Promise<void>;
-    create: (newItem: Partial<TListItem>, options?: ActionOptions) => Promise<StandardResponse<TListItem>>;
-    put: (id: string | number, item: TListItem, options?: ActionOptions) => Promise<StandardResponse<TListItem>>;
-    update: (id: string | number, updatedItem: Partial<TListItem>, options?: ActionOptions) => Promise<StandardResponse<TListItem>>;
-    remove: (id: string | number, options?: ActionOptions) => Promise<StandardResponse<any>>;
-    bulkRemove: (ids: Array<string | number>, options?: ActionOptions) => Promise<StandardResponse<any>>;
+interface RequestConfig extends AxiosRequestConfig {
+    isPublic?: boolean;
+    cancelTokenKey?: string;
+    onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
+    onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void;
 }
-/**
- * A collection of functions and properties for controlling the query parameters
- * used for fetching data, such as pagination, sorting, and filtering.
- */
-interface UseApiQuery {
-    /** The current query options state. */
-    options: QueryOptions;
-    /** A function to set the entire query options object at once. */
-    setOptions: React.Dispatch<React.SetStateAction<QueryOptions>>;
-    /** 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;
-    /** Sets the search term and resets to the first page. */
-    setSearchTerm: (search: string) => void;
-    /** Sets the sorting configuration. */
-    setSorting: (sortBy: {
+interface QueryOptions {
+    page?: number;
+    limit?: number;
+    search?: string;
+    sortBy?: {
         key: string;
         direction: 'asc' | 'desc';
-    }[]) => void;
-    /** Sets the filter object and resets to the first page. */
-    setFilters: (filter: Record<string, any>) => void;
-    /** Sets a single, custom query parameter. */
-    setQueryParam: (key: string, value: any) => void;
-    /** Resets the query options to their initial state. */
-    reset: () => void;
+    }[];
+    filter?: Record<string, any>;
+    [key: string]: any;
+}
+interface ActionOptions extends RequestConfig {
+    endpoint?: string;
+    refetch?: boolean;
 }
 /**
- * The complete return type of the `useApi` hook.
- * It encapsulates the state, actions, and query controls for a given API resource.
- * @template T The type of the data entity being managed.
+ * يمثل إعدادات إجراء واحد داخل الموديول.
  */
-interface UseApiReturn<T> {
-    state: UseApiState<T>;
-    setState: React.Dispatch<React.SetStateAction<UseApiState<T>>>;
-    actions: UseApiActions<T>;
-    query: UseApiQuery;
-}
-
 interface ActionConfig<TInput = any, TOutput = any> {
     method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
     path: string;
@@ -313,10 +120,9 @@ interface ActionConfig<TInput = any, TOutput = any> {
     isList?: boolean;
     invalidates?: string[];
 }
-interface ApiModuleConfig {
-    baseEndpoint: string;
-    actions: Record<string, ActionConfig<any, any>>;
-}
+/**
+ * خيارات الإعداد لهوك useApiModule.
+ */
 interface UseApiModuleOptions {
     onSuccess?: (actionName: string, message: string, data: any) => void;
     onError?: (actionName: string, message: string, error?: ApiError | null) => void;
@@ -325,39 +131,90 @@ interface UseApiModuleOptions {
     refetchOnWindowFocus?: boolean;
     pathParams?: Record<string, any>;
 }
+/**
+ * [مُحدَّث] يمثل الحالة التفاعلية الكاملة لإجراء واحد.
+ * هذا هو النوع الذي يتم إرجاعه في `states` من الهوك.
+ */
 interface ActionState<TOutput> {
     data: TOutput | null;
+    links?: Record<string, string | null>;
+    meta?: PaginationMeta | Record<string, any>;
     error: ApiError | null;
     loading: boolean;
     success: boolean;
     called: boolean;
-    response: StandardResponse<TOutput> | null;
+    message?: string;
+    validationErrors?: ValidationError[];
+    rawResponse: any | null;
 }
 /**
- * The unified object for a single action, containing its state, executor, and controls.
- * This is the new, more ergonomic return structure.
+ * الكائن الموحد الذي يتم إرجاعه لكل إجراء، ويحتوي على حالته ومنفذه وأدوات التحكم.
  */
 interface ExecutableAction<TInput, TOutput> {
-    /** The reactive state for this specific action. */
     state: ActionState<TOutput>;
-    /** The stable function to execute the API call. */
     execute: (input?: TInput, options?: {
         pathParams?: Record<string, any>;
         config?: AxiosRequestConfig;
         query?: QueryOptions;
     }) => Promise<StandardResponse<TOutput>>;
-    /** A stable function to reset the action's state to its initial value. */
     reset: () => void;
-    /** Query controls (pagination, sorting, etc.) available only if `isList: true`. */
     query?: UseApiQuery;
 }
 /**
- * The final, fully-typed object returned by the useApiModule hook.
- * It's a dictionary of executable actions.
+ * النوع النهائي الذي يعيده هوك useApiModule.
  */
 type ModuleActions<TModule extends ApiModuleConfig> = {
     [K in keyof TModule['actions']]: TModule['actions'][K] extends ActionConfig<infer TInput, infer TOutput> ? ExecutableAction<TInput, TOutput> : never;
 };
+type UseApiState<T> = StandardResponse<T>;
+interface UseApiQuery {
+    /** The current query options state. */
+    options: QueryOptions;
+    /** A function to set the entire query options object at once. */
+    setOptions: React$1.Dispatch<React$1.SetStateAction<QueryOptions>>;
+    /** 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;
+    /** Sets the search term and resets to the first page. */
+    setSearchTerm: (search: string) => void;
+    /** Sets the sorting configuration. */
+    setSorting: (sortBy: {
+        key: string;
+        direction: 'asc' | 'desc';
+    }[]) => void;
+    /** Sets the filter object and resets to the first page. */
+    setFilters: (filter: Record<string, any>) => void;
+    /** Sets a single, custom query parameter. */
+    setQueryParam: (key: string, value: any) => void;
+    /** Resets the query options to their initial state. */
+    reset: () => void;
+}
+interface UseApiConfig<T> {
+    endpoint: string;
+    initialData?: T | null;
+    initialQuery?: QueryOptions;
+    enabled?: boolean;
+    refetchAfterChange?: boolean;
+    requestConfig?: RequestConfig;
+    pathParams?: Record<string, string | number>;
+    encodeQuery?: boolean;
+    onSuccess?: (message: string, data?: T) => void;
+    onError?: (message: string, error?: ApiError) => void;
+}
+interface ActionConfigModule<TInput = any, TOutput = any> {
+    method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+    path: string;
+    description?: string;
+    isList?: boolean;
+    invalidates?: string[];
+}
+interface ApiModuleConfig {
+    baseEndpoint: string;
+    actions: Record<string, ActionConfigModule<any, any>>;
+}
+
+declare function createApiClient(config: ApiClientConfig): AxiosInstance;
 
 /**
  * A factory function to create a reusable set of API services for a specific endpoint.
@@ -376,23 +233,12 @@ declare function createApiServices<T>(axiosInstance: AxiosInstance, baseEndpoint
 };
 
 /**
- * @file src/core/utils.ts
- * @description
- * يحتوي هذا الملف على مجموعة من الدوال المساعدة المستخدمة في جميع أنحاء المكتبة،
- * مثل بناء سلاسل الاستعلام (query strings) وإدارة إلغاء الطلبات،
- * بالإضافة إلى دوال التحقق من الأنواع (type guards).
- */
-
-interface BuildQueryOptions {
-    encode?: boolean;
-}
-/**
- * يبني سلسلة استعلام (query string) من كائن الخيارات.
+ * [نسخة مطورة] يبني سلسلة استعلام (query string) من كائن الخيارات.
+ * يدعم الآن الفلاتر المتداخلة (filter[key]=value) والترتيب المتعدد.
  * @param options - كائن خيارات الاستعلام (فلترة, ترتيب, ...).
- * @param config - إعدادات إضافية مثل التحكم في التشفير.
  * @returns سلسلة استعلام جاهزة للإضافة للرابط.
  */
-declare function buildPaginateQuery(options: QueryOptions, config?: BuildQueryOptions): string;
+declare function buildPaginateQuery(options: QueryOptions): string;
 
 /**
  * Defines a single custom API action.
@@ -439,28 +285,24 @@ declare class CacheManager {
     set<T>(key: string, data: T, duration?: number): void;
     get<T>(key: string): T | null;
     /**
-     * [دالة جديدة] تعيد عنصر الـ Cache بالكامل (البيانات + معلومات إضافية)
-     * دون حذفه عند انتهاء الصلاحية. هذا يسمح لنا بتطبيق منطق stale-while-revalidate.
+     * [FIX] تم تحويلها إلى دالة عامة (generic) لتعيد النوع الصحيح.
+     * الآن بدلًا من إرجاع CacheItem<unknown>، ستُرجع CacheItem<T>.
      */
     getWithMeta<T>(key: string): CacheItem<T> | null;
     delete(key: string): void;
     clear(): void;
-    /**
-     * [دالة جديدة] تقوم بإبطال (حذف) جميع عناصر الـ Cache التي تبدأ ببادئة معينة.
-     * أساسية لعملية invalidation التلقائية.
-     */
     invalidateByPrefix(prefix: string): void;
 }
 declare const cacheManager: CacheManager;
 
-declare const processResponse: <T>(responseOrError: AxiosResponse<any> | ApiError) => StandardResponse<T>;
-
-declare function useApi<T>(axiosInstance: AxiosInstance, config: UseApiConfig<T>): UseApiReturn<T>;
-
 /**
- * هوك متقدم يقوم ببناء مجموعة من الإجراءات القابلة للتنفيذ من إعدادات موديول API،
- * مع فصل تام بين الدوال المستقرة والحالات المتغيرة لمنع الحلقات اللانهائية.
+ * [النسخة النهائية والمضمونة]
+ * تستخدم دوال حماية النوع المخصصة للقضاء على أخطاء 'never' بشكل نهائي.
  */
+declare const processResponse: <T>(responseOrError: AxiosResponse<any> | AxiosError) => StandardResponse<T>;
+
+declare function useApi<T>(axiosInstance: AxiosInstance, config: UseApiConfig<T>): any;
+
 declare function useApiModule<TModule extends ApiModuleConfig>(axiosInstance: AxiosInstance, moduleConfig: TModule, options?: UseApiModuleOptions): any;
 
 /**
@@ -565,6 +407,41 @@ type EffectCallback = () => (void | (() => void));
 type DependencyList = readonly any[];
 declare function useDeepCompareEffect(callback: EffectCallback, dependencies: DependencyList): void;
 
+/**
+ * @file src/hooks/useApi.types.ts
+ * @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.
+ */
+/**
+ * A collection of callable functions for performing CRUD and other operations.
+ * These actions automatically handle state updates like loading and refetching.
+ * @template T The type of the data entity being managed.
+ */
+interface UseApiActions<T, TListItem = T extends (infer U)[] ? U : T> {
+    fetch: (querryOptions?: QueryOptions) => Promise<void>;
+    create: (newItem: Partial<TListItem>, options?: ActionOptions) => Promise<StandardResponse<TListItem>>;
+    put: (id: string | number, item: TListItem, options?: ActionOptions) => Promise<StandardResponse<TListItem>>;
+    update: (id: string | number, updatedItem: Partial<TListItem>, options?: ActionOptions) => Promise<StandardResponse<TListItem>>;
+    remove: (id: string | number, options?: ActionOptions) => Promise<StandardResponse<any>>;
+    bulkRemove: (ids: Array<string | number>, options?: ActionOptions) => Promise<StandardResponse<any>>;
+}
+/**
+ * The complete return type of the `useApi` hook.
+ * It encapsulates the state, actions, and query controls for a given API resource.
+ * @template T The type of the data entity being managed.
+ */
+interface UseApiReturn<T> {
+    state: UseApiState<T>;
+    setState: React.Dispatch<React.SetStateAction<UseApiState<T>>>;
+    actions: UseApiActions<T>;
+    query: UseApiQuery;
+}
+
 type ApiResourceStatus = 'idle' | 'loading' | 'success' | 'error';
 interface UseApiResourceState<T> {
     data: T | T[] | null;
@@ -611,4 +488,4 @@ interface UseApiResourceReturn<T, TCreate, TUpdate, TPathParams> {
     setQuery: React.Dispatch<React.SetStateAction<QueryOptions>>;
 }
 
-export { type ActionConfig, type ActionOptions, type ActionState, type ApiClientConfig, type ApiError, type ApiModuleConfig, type ApiResourceStatus, type ApiResponse, type ExecutableAction, type LogLevel, type Middleware, type MiddlewareContext, type ModuleActions, type PaginationMeta, type QueryOptions, type RefreshTokenConfig, type RequestConfig, type StandardResponse, type TokenManager, type Tokens, type UseApiActions, type UseApiConfig, type UseApiModuleOptions, type UseApiQuery, type UseApiRecordActions, type UseApiRecordConfig, type UseApiRecordReturn, type UseApiRecordState, type UseApiResourceActions, type UseApiResourceConfig, type UseApiResourceReturn, type UseApiResourceState, type UseApiReturn, type UseApiState, type ValidationError, buildPaginateQuery, cacheManager, createApiActions, createApiClient, createApiServices, processResponse, useApi, useApiModule, useApiRecord, useDeepCompareEffect };
+export { type ActionConfig, type ActionConfigModule, type ActionOptions, type ActionState, type ApiClientConfig, type ApiError, type ApiModuleConfig, type ApiResourceStatus, type ExecutableAction, type LogLevel, type Middleware, type MiddlewareContext, type ModuleActions, type PaginationMeta, type QueryOptions, type RefreshTokenConfig, type RequestConfig, type StandardResponse, type TokenManager, type Tokens, type UseApiActions, type UseApiConfig, type UseApiModuleOptions, type UseApiQuery, type UseApiRecordActions, type UseApiRecordConfig, type UseApiRecordReturn, type UseApiRecordState, type UseApiResourceActions, type UseApiResourceConfig, type UseApiResourceReturn, type UseApiResourceState, type UseApiReturn, type UseApiState, type ValidationError, buildPaginateQuery, cacheManager, createApiActions, createApiClient, createApiServices, processResponse, useApi, useApiModule, useApiRecord, useDeepCompareEffect };