api-core-lib 12.0.4 → 12.0.6

package/dist/index.d.ts

@@ -1,262 +1,11 @@
-import { InternalAxiosRequestConfig, AxiosResponse, AxiosRequestConfig, AxiosProgressEvent, AxiosInstance, Method, AxiosError } from 'axios';
+import { AxiosInstance, AxiosRequestConfig, Method, AxiosResponse, AxiosError } from 'axios';
+import { A as ApiClientConfig, a as ActionConfigModule, S as StandardResponse, b as ActionOptions, R as RequestConfig, c as ActionStateModule, Q as QueryOptions, U as UseApiConfig, d as ApiError, e as ApiModuleConfig, f as UseApiModuleOptions, g as UseApiModuleReturn, h as UseApiQuery, L as LogLevel } from './apiModule.types-2yhaJWN3.js';
+export { l as ActionConfig, n as ActionState, E as ExecutableAction, o as ExecuteOptions, I as InputOf, j as Middleware, M as MiddlewareContext, p as ModuleActions, q as ModuleStates, O as OutputOf, P as PaginationMeta, k as RefreshTokenConfig, i as TokenManager, T as Tokens, m as UseApiState, V as ValidationError } from './apiModule.types-2yhaJWN3.js';
 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 { Dispatch, SetStateAction } from '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;
-    hydratedState?: string;
-}
-/** 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;
-    };
-    dehydrate: () => string;
-}
-
 /**
  * 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,
@@ -289,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.
@@ -331,6 +72,60 @@ declare function createApiActions<TActions extends Record<string, {
     [K in keyof TActions]: ApiAction<TActions[K]['requestType'], TActions[K]['responseType']>;
 };
 
+declare class GlobalStateManager {
+    private store;
+    /**
+     * يحصل على لقطة (snapshot) للحالة الحالية لمفتاح معين.
+     */
+    getSnapshot<T>(key: string): ActionStateModule<T>;
+    /**
+     * يسجل دالة callback للاستماع إلى التغييرات على مفتاح معين.
+     * @returns دالة لإلغاء الاشتراك.
+     */
+    subscribe(key: string, callback: () => void): () => void;
+    /**
+     * يحدّث الحالة لمفتاح معين ويقوم بإعلام جميع المشتركين.
+     */
+    setState<T>(key: string, updater: (prevState: ActionStateModule<T>) => ActionStateModule<T>): void;
+    /**
+     * يجعل البيانات المرتبطة بمفتاح معين "قديمة" (stale).
+     */
+    invalidate(key: string): void;
+    /**
+   * [نسخة محدثة وأكثر قوة]
+   * يجعل كل البيانات التي تبدأ بمفتاح معين "قديمة" (stale).
+   * @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;
@@ -352,12 +147,6 @@ declare class CacheManager {
 }
 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;
 
 /**
@@ -466,46 +255,6 @@ declare const ApiModuleProvider: React$1.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>;
 
-declare class GlobalStateManager {
-    private store;
-    /**
-     * يحصل على لقطة (snapshot) للحالة الحالية لمفتاح معين.
-     */
-    getSnapshot<T>(key: string): ActionStateModule<T>;
-    /**
-     * يسجل دالة callback للاستماع إلى التغييرات على مفتاح معين.
-     * @returns دالة لإلغاء الاشتراك.
-     */
-    subscribe(key: string, callback: () => void): () => void;
-    /**
-     * يحدّث الحالة لمفتاح معين ويقوم بإعلام جميع المشتركين.
-     */
-    setState<T>(key: string, updater: (prevState: ActionStateModule<T>) => ActionStateModule<T>): void;
-    /**
-     * يجعل البيانات المرتبطة بمفتاح معين "قديمة" (stale).
-     */
-    invalidate(key: string): void;
-    /**
-   * [نسخة محدثة وأكثر قوة]
-   * يجعل كل البيانات التي تبدأ بمفتاح معين "قديمة" (stale).
-   * @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;
-
 /**
  * @file src/hooks/useApi.types.ts
  * @description This file defines the professional, publicly-facing types for the `useApi` hook,
@@ -587,4 +336,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, ApiModuleConfig, ApiModuleProvider, type ApiResourceStatus, LogLevel, QueryOptions, RequestConfig, StandardResponse, type UseApiActions, UseApiConfig, UseApiModuleOptions, UseApiModuleReturn, UseApiQuery, type UseApiRecordActions, type UseApiRecordConfig, type UseApiRecordReturn, type UseApiRecordState, type UseApiResourceActions, type UseApiResourceConfig, type UseApiResourceReturn, type UseApiResourceState, type UseApiReturn, buildPaginateQuery, cacheManager, callDynamicApi, createApiActions, createApiClient, createApiServices, globalStateManager, processResponse, useApi, useApiModule, useApiRecord, useDeepCompareEffect, useModuleContext };