api-core-lib 12.11.4 → 12.12.100

package/dist/index.d.ts

@@ -1,260 +1,11 @@
-import { InternalAxiosRequestConfig, AxiosResponse, AxiosRequestConfig, AxiosProgressEvent, AxiosInstance, Method, AxiosError } from 'axios';
-import * as React$1 from 'react';
-import React__default, { Dispatch, SetStateAction } from 'react';
-
-/**
- * يمثل معلومات الترقيم (Pagination) التي قد تعود من ה-API.
- */
-interface PaginationMeta {
-    itemsPerPage: number;
-    totalItems: number;
-    currentPage: number;
-    totalPages: number;
-    [key: string]: any;
-}
-/**
- * يمثل خطأ تحقق واحد لحقل معين.
- */
-interface ValidationError {
-    field: string;
-    message: string;
-}
-/**
- * يمثل كائن الخطأ الموحد الذي تنتجه المكتبة.
- */
-interface ApiError {
-    message: string;
-    status: number;
-    code?: string;
-    errors?: ValidationError[];
-    requestId?: string;
-}
-/**
- * الكائن القياسي والموحد الذي تعيده جميع دوال المكتبة.
- * هذا هو النوع الأساسي الذي سيتعامل معه المطورون.
- * @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;
-    success: boolean;
-    message?: string;
-    validationErrors?: ValidationError[];
-}
-interface Tokens {
-    accessToken: string | null;
-    refreshToken: string | null;
-    expiresAt?: number;
-    tokenType?: string;
-}
-interface TokenManager {
-    getTokens(): Promise<Tokens>;
-    setTokens(tokens: Tokens): Promise<void>;
-    clearTokens(): Promise<void>;
-    isHttpOnly(): boolean;
-}
-interface MiddlewareContext {
-    req: InternalAxiosRequestConfig;
-    res?: AxiosResponse;
-    error?: any;
-    custom?: Record<string, any>;
-}
-type Middleware = (context: MiddlewareContext, next: () => Promise<void>) => Promise<void>;
-type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'silent';
-interface RefreshTokenConfig {
-    path: string;
-    buildRequestBody?: (refreshToken: string) => Record<string, any>;
-    buildRequestHeaders?: (currentTokens: Tokens) => Record<string, string>;
-    extractTokens: (responseData: any) => {
-        accessToken: string;
-        refreshToken?: string;
-        expiresIn: number;
-        tokenType?: string;
-    };
-}
-interface ApiClientConfig {
-    baseURL?: string;
-    tokenManager: TokenManager;
-    timeout?: number;
-    headers?: Record<string, string>;
-    withCredentials?: boolean;
-    refreshTokenConfig?: RefreshTokenConfig;
-    onRefreshError?: (error: any) => void;
-    middleware?: Middleware[];
-    logLevel?: LogLevel;
-    defaultIsPublic?: boolean;
-    maxTokenRefreshRetries?: number;
-    maxQueueSize?: number;
-}
-interface RequestConfig extends AxiosRequestConfig {
-    isPublic?: boolean;
-    cancelTokenKey?: string;
-    onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
-    onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void;
-}
-interface QueryOptions {
-    page?: number;
-    limit?: number;
-    search?: string;
-    sortBy?: {
-        key: string;
-        direction: 'asc' | 'desc';
-    }[];
-    filter?: Record<string, any>;
-    [key: string]: any;
-}
-interface ActionOptions extends RequestConfig {
-    endpoint?: string;
-    refetch?: boolean;
-}
-/**
- * يمثل إعدادات إجراء واحد داخل الموديول.
- */
-interface ActionConfig<TInput = any, TOutput = any> {
-    method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
-    path: string;
-    description?: string;
-    isList?: boolean;
-    invalidates?: string[];
-}
-/**
- * [مُحدَّث] يمثل الحالة التفاعلية الكاملة لإجراء واحد.
- * هذا هو النوع الذي يتم إرجاعه في `states` من الهوك.
- */
-interface ActionStateModule<TOutput> {
-    data: TOutput | null;
-    links?: Record<string, string | null>;
-    meta?: PaginationMeta | Record<string, any>;
-    error: ApiError | null;
-    loading: boolean;
-    success: boolean;
-    called: boolean;
-    message?: string;
-    validationErrors?: ValidationError[];
-    rawResponse: any | null;
-    isStale?: boolean;
-    lastSuccessAt?: number;
-}
-/**
- * الكائن الموحد الذي يتم إرجاعه لكل إجراء، ويحتوي على حالته ومنفذه وأدوات التحكم.
- */
-interface ExecutableAction<TInput, TOutput> {
-    state: ActionStateModule<TOutput>;
-    execute: (input?: TInput, options?: {
-        pathParams?: Record<string, any>;
-        config?: AxiosRequestConfig;
-        query?: QueryOptions;
-    }) => Promise<StandardResponse<TOutput>>;
-    reset: () => void;
-    query?: UseApiQuery;
-}
-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__default.Dispatch<React__default.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;
-}
+import { AxiosInstance, AxiosRequestConfig, Method, AxiosResponse, AxiosError } from 'axios';
+import { f as ApiClientConfig, A as ActionConfigModule, S as StandardResponse, g as ActionOptions, R as RequestConfig, h as ActionStateModule, Q as QueryOptions, i as UseApiQuery, j as ApiError, L as LogLevel } from './apiModule.types-dbmnauAt.js';
+export { o as ActionConfig, u as ActionMethods, q as ActionState, s as ActionsWithQuery, a as ApiModuleConfig, E as ExecutableAction, r as ExecuteOptions, I as InputOf, m as Middleware, l as MiddlewareContext, d as ModuleActions, e as ModuleQueries, M as ModuleStates, O as OutputOf, P as PaginationMeta, n as RefreshTokenConfig, k as TokenManager, T as Tokens, U as UseApiConfig, b as UseApiModuleOptions, c as UseApiModuleReturn, p as UseApiState, V as ValidationError, t } from './apiModule.types-dbmnauAt.js';
+export { c as UseApiRecordActions, U as UseApiRecordConfig, a as UseApiRecordReturn, b as UseApiRecordState } from './useApiRecord.types-C06B5p4U.js';
+import 'react';
 
 declare function createApiClient(config: ApiClientConfig): AxiosInstance;
 
-/** @description Extends the base ActionState with an `isStale` flag for automatic refetching. */
-interface ActionState<TOutput> extends ActionStateModule<TOutput> {
-    isStale?: boolean;
-}
-/** @description Defines the configuration for a single API action within a module. */
-interface ActionConfigModule<TInput = unknown, TOutput = unknown> {
-    method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
-    path: string;
-    description?: string;
-    hasQuery?: boolean;
-    autoFetch?: boolean;
-    invalidates?: string[];
-    _input?: TInput;
-    _output?: TOutput;
-}
-/** @description Defines the complete structure of an API module. */
-interface ApiModuleConfig<TActions extends Record<string, ActionConfigModule<any, any>>> {
-    baseEndpoint: string;
-    actions: TActions;
-}
-/** @description Configuration options passed directly to the `useApiModule` hook. */
-interface UseApiModuleOptions {
-    onSuccess?: (actionName: string, message: string, data: unknown) => void;
-    onError?: (actionName: string, message: string, error?: ApiError | null) => void;
-    refetchOnWindowFocus?: boolean;
-    pathParams?: Record<string, any>;
-    enabled?: boolean;
-}
-/** A utility type to infer the Input type (`TInput`) from an ActionConfigModule. */
-type InputOf<TActionConfig> = TActionConfig extends ActionConfigModule<infer TInput, any> ? TInput : never;
-/** A utility type to infer the Output type (`TOutput`) from an ActionConfigModule. */
-type OutputOf<TActionConfig> = TActionConfig extends ActionConfigModule<any, infer TOutput> ? TOutput : never;
-/** @description Defines the options for the `execute` function, enabling optimistic updates. */
-interface ExecuteOptions<TInput, TOutput, TContext = unknown> {
-    pathParams?: Record<string, any>;
-    config?: AxiosRequestConfig;
-    onMutate?: (variables: TInput) => TContext | Promise<TContext>;
-    onSuccess?: (data: TOutput, context?: TContext) => void;
-    onError?: (error: ApiError, context?: TContext) => void;
-}
-/** @description A fully-typed object representing the callable actions for a module. */
-type ModuleActions<TActions extends Record<string, ActionConfigModule<any, any>>> = {
-    [K in keyof TActions]: {
-        execute: <TContext = unknown>(input?: InputOf<TActions[K]>, options?: ExecuteOptions<InputOf<TActions[K]>, OutputOf<TActions[K]>, TContext>) => Promise<StandardResponse<OutputOf<TActions[K]>>>;
-        reset: (input?: InputOf<TActions[K]>, options?: {
-            pathParams?: Record<string, any>;
-        }) => void;
-    };
-};
-/** @description A fully-typed object representing the reactive states for each action in a module. */
-type ModuleStates<TActions extends Record<string, ActionConfigModule<any, any>>> = {
-    [K in keyof TActions]: ActionState<OutputOf<TActions[K]>>;
-};
-/** @description The complete, fully-typed return object of the `useApiModule` hook. */
-interface UseApiModuleReturn<TActions extends Record<string, ActionConfigModule<any, any>>> {
-    states: ModuleStates<TActions>;
-    actions: ModuleActions<TActions>;
-    queries: {
-        [K in keyof TActions]?: TActions[K] extends {
-            hasQuery: true;
-        } ? UseApiQuery : never;
-    };
-}
-
 /**
  * A factory function to create a reusable set of API services for a specific endpoint.
  * It provides full CRUD operations plus advanced features like bulk deletion and file uploads,
@@ -287,14 +38,6 @@ declare function callDynamicApi(axiosInstance: AxiosInstance, baseEndpoint: stri
     config?: AxiosRequestConfig;
 }): Promise<StandardResponse<any>>;
 
-/**
- * [نسخة مطورة] يبني سلسلة استعلام (query string) من كائن الخيارات.
- * يدعم الآن الفلاتر المتداخلة (filter[key]=value) والترتيب المتعدد.
- * @param options - كائن خيارات الاستعلام (فلترة, ترتيب, ...).
- * @returns سلسلة استعلام جاهزة للإضافة للرابط.
- */
-declare function buildPaginateQuery(options: QueryOptions): string;
-
 /**
  * Defines a single custom API action.
  * @template TRequest - The type of the data sent in the request body/params.
@@ -329,146 +72,8 @@ declare function createApiActions<TActions extends Record<string, {
     [K in keyof TActions]: ApiAction<TActions[K]['requestType'], TActions[K]['responseType']>;
 };
 
-interface CacheItem<T> {
-    data: T;
-    timestamp: number;
-    duration: number;
-}
-declare class CacheManager {
-    private cache;
-    private defaultDuration;
-    set<T>(key: string, data: T, duration?: number): void;
-    get<T>(key: string): T | null;
-    /**
-     * [FIX] تم تحويلها إلى دالة عامة (generic) لتعيد النوع الصحيح.
-     * الآن بدلًا من إرجاع CacheItem<unknown>، ستُرجع CacheItem<T>.
-     */
-    getWithMeta<T>(key: string): CacheItem<T> | null;
-    delete(key: string): void;
-    clear(): void;
-    invalidateByPrefix(prefix: string): void;
-}
-declare const cacheManager: CacheManager;
-
-/**
- * [النسخة النهائية والمضمونة]
- * تستخدم دوال حماية النوع المخصصة للقضاء على أخطاء 'never' بشكل نهائي.
- */
-declare const processResponse: <T>(responseOrError: AxiosResponse<any> | AxiosError) => StandardResponse<T>;
-
-declare function useApi<T>(axiosInstance: AxiosInstance, config: UseApiConfig<T>): any;
-
-/**
- * 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>>>;
-}
-
-/**
- * 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$1.Provider<UseApiModuleReturn<any> | null>;
-declare function useModuleContext<TActions extends Record<string, ActionConfigModule<any, any>>>(): UseApiModuleReturn<TActions>;
-declare function useApiModule<TActions extends Record<string, ActionConfigModule<any, any>>>(axiosInstance: AxiosInstance, moduleConfig: ApiModuleConfig<TActions>, options?: UseApiModuleOptions): UseApiModuleReturn<TActions>;
-
 declare class GlobalStateManager {
     private store;
-    /**
-     * يحصل على لقطة (snapshot) للحالة الحالية لمفتاح معين.
-     */
     getSnapshot<T>(key: string): ActionStateModule<T>;
     /**
      * يسجل دالة callback للاستماع إلى التغييرات على مفتاح معين.
@@ -489,9 +94,69 @@ declare class GlobalStateManager {
    * @example invalidateByPrefix('myModule/list::') سيبطل كل صفحات القائمة.
    */
     invalidateByPrefix(prefix: string): void;
+    /**
+   * Serializes the current state of the query store into a JSON string.
+   * This is used on the server to pass the initial state to the client.
+   * @returns A JSON string representing the dehydrated state.
+   */
+    dehydrate(): string;
+    /**
+     * Merges a dehydrated state object into the current store.
+     * This is used on the client to hydrate the state received from the server.
+     * @param hydratedState - A JSON string from the `dehydrate` method.
+     */
+    rehydrate(hydratedState: string): void;
 }
 declare const globalStateManager: GlobalStateManager;
 
+/**
+ * [نسخة مطورة] يبني سلسلة استعلام (query string) من كائن الخيارات.
+ * يدعم الآن الفلاتر المتداخلة (filter[key]=value) والترتيب المتعدد.
+ * @param options - كائن خيارات الاستعلام (فلترة, ترتيب, ...).
+ * @returns سلسلة استعلام جاهزة للإضافة للرابط.
+ */
+declare function buildPaginateQuery(options: QueryOptions): string;
+
+/**
+ * [النسخة النهائية والمضمونة]
+ * تستخدم دوال حماية النوع المخصصة للقضاء على أخطاء 'never' بشكل نهائي.
+ */
+declare const processResponse: <T>(responseOrError: AxiosResponse<any> | AxiosError) => StandardResponse<T>;
+
+interface CacheItem<T> {
+    data: T;
+    timestamp: number;
+    duration: number;
+}
+declare class CacheManager {
+    private cache;
+    private defaultDuration;
+    set<T>(key: string, data: T, duration?: number): void;
+    get<T>(key: string): T | null;
+    /**
+     * [FIX] تم تحويلها إلى دالة عامة (generic) لتعيد النوع الصحيح.
+     * الآن بدلًا من إرجاع CacheItem<unknown>، ستُرجع CacheItem<T>.
+     */
+    getWithMeta<T>(key: string): CacheItem<T> | null;
+    delete(key: string): void;
+    clear(): void;
+    invalidateByPrefix(prefix: string): void;
+}
+declare const cacheManager: CacheManager;
+
+/**
+ * يقوم بإنشاء مفتاح تخزين مؤقت فريد وثابت لإجراء معين ومدخلاته.
+ * هذا يضمن أن نفس الطلب ينتج دائمًا نفس المفتاح.
+ * @param moduleName - عادةً ما يكون `baseEndpoint` للموديول.
+ * @param actionName - اسم الإجراء (مثل 'list', 'create').
+ * @param input - بيانات الطلب (body/query params).
+ * @param callOptions - خيارات إضافية مثل `pathParams`.
+ * @returns سلسلة نصية فريدة تمثل مفتاح التخزين المؤقت.
+ */
+declare const generateCacheKey: (moduleName: string, actionName: string, input?: unknown, callOptions?: {
+    pathParams?: Record<string, any>;
+}) => string;
+
 /**
  * @file src/hooks/useApi.types.ts
  * @description This file defines the professional, publicly-facing types for the `useApi` hook,
@@ -573,4 +238,4 @@ interface UseApiResourceReturn<T, TCreate, TUpdate, TPathParams> {
     setQuery: React.Dispatch<React.SetStateAction<QueryOptions>>;
 }
 
-export { type ActionConfig, type ActionConfigModule, type ActionOptions, type ActionState, type ActionStateModule, type ApiClientConfig, type ApiError, type ApiModuleConfig, ApiModuleProvider, type ApiResourceStatus, type ExecutableAction, type ExecuteOptions, type InputOf, type LogLevel, type Middleware, type MiddlewareContext, type ModuleActions, type ModuleStates, type OutputOf, type PaginationMeta, type QueryOptions, type RefreshTokenConfig, type RequestConfig, type StandardResponse, type TokenManager, type Tokens, type UseApiActions, type UseApiConfig, type UseApiModuleOptions, type UseApiModuleReturn, 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, callDynamicApi, createApiActions, createApiClient, createApiServices, globalStateManager, processResponse, useApi, useApiModule, useApiRecord, useDeepCompareEffect, useModuleContext };
+export { ActionConfigModule, ActionOptions, ActionStateModule, ApiClientConfig, ApiError, type ApiResourceStatus, LogLevel, QueryOptions, RequestConfig, StandardResponse, type UseApiActions, UseApiQuery, type UseApiResourceActions, type UseApiResourceConfig, type UseApiResourceReturn, type UseApiResourceState, type UseApiReturn, buildPaginateQuery, cacheManager, callDynamicApi, createApiActions, createApiClient, createApiServices, generateCacheKey, globalStateManager, processResponse };