api-core-lib 12.10.4 → 12.11.4

package/dist/index.d.mts

@@ -270,6 +270,22 @@ declare function createApiServices<T>(axiosInstance: AxiosInstance, baseEndpoint
     bulkDelete: (ids: Array<string | number>, config?: ActionOptions) => Promise<StandardResponse<any>>;
     upload: (file: File, additionalData?: Record<string, any>, config?: ActionOptions) => Promise<StandardResponse<any>>;
 };
+/**
+ * [نسخة محدثة ومحسّنة]
+ * دالة عامة وصريحة لتنفيذ أي طلب API.
+ * تستقبل وسائط منظمة بدلاً من محاولة تخمينها.
+ *
+ * @param axiosInstance - نسخة Axios.
+ * @param baseEndpoint - نقطة النهاية الأساسية للموديول.
+ * @param actionConfig - إعدادات الإجراء المحدد.
+ * @param params - كائن يحتوي على جميع البارامترات اللازمة للطلب.
+ * @returns Promise<StandardResponse<any>>
+ */
+declare function callDynamicApi(axiosInstance: AxiosInstance, baseEndpoint: string, actionConfig: ActionConfigModule<any, any>, params: {
+    pathParams?: Record<string, string | number>;
+    body?: any;
+    config?: AxiosRequestConfig;
+}): Promise<StandardResponse<any>>;
 
 /**
  * [نسخة مطورة] يبني سلسلة استعلام (query string) من كائن الخيارات.
@@ -448,6 +464,34 @@ 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 للاستماع إلى التغييرات على مفتاح معين.
+     * @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;
+}
+declare const globalStateManager: GlobalStateManager;
+
 /**
  * @file src/hooks/useApi.types.ts
  * @description This file defines the professional, publicly-facing types for the `useApi` hook,
@@ -529,4 +573,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, createApiActions, createApiClient, createApiServices, processResponse, useApi, useApiModule, useApiRecord, useDeepCompareEffect, useModuleContext };
+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 };

package/dist/index.d.ts

@@ -270,6 +270,22 @@ declare function createApiServices<T>(axiosInstance: AxiosInstance, baseEndpoint
     bulkDelete: (ids: Array<string | number>, config?: ActionOptions) => Promise<StandardResponse<any>>;
     upload: (file: File, additionalData?: Record<string, any>, config?: ActionOptions) => Promise<StandardResponse<any>>;
 };
+/**
+ * [نسخة محدثة ومحسّنة]
+ * دالة عامة وصريحة لتنفيذ أي طلب API.
+ * تستقبل وسائط منظمة بدلاً من محاولة تخمينها.
+ *
+ * @param axiosInstance - نسخة Axios.
+ * @param baseEndpoint - نقطة النهاية الأساسية للموديول.
+ * @param actionConfig - إعدادات الإجراء المحدد.
+ * @param params - كائن يحتوي على جميع البارامترات اللازمة للطلب.
+ * @returns Promise<StandardResponse<any>>
+ */
+declare function callDynamicApi(axiosInstance: AxiosInstance, baseEndpoint: string, actionConfig: ActionConfigModule<any, any>, params: {
+    pathParams?: Record<string, string | number>;
+    body?: any;
+    config?: AxiosRequestConfig;
+}): Promise<StandardResponse<any>>;
 
 /**
  * [نسخة مطورة] يبني سلسلة استعلام (query string) من كائن الخيارات.
@@ -448,6 +464,34 @@ 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 للاستماع إلى التغييرات على مفتاح معين.
+     * @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;
+}
+declare const globalStateManager: GlobalStateManager;
+
 /**
  * @file src/hooks/useApi.types.ts
  * @description This file defines the professional, publicly-facing types for the `useApi` hook,
@@ -529,4 +573,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, createApiActions, createApiClient, createApiServices, processResponse, useApi, useApiModule, useApiRecord, useDeepCompareEffect, useModuleContext };
+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 };