api-core-lib 12.0.13 → 12.0.15

package/dist/{apiModule.types-CpwGDEpG.d.cts → apiModule.types-BTtRM9wO.d.cts}

@@ -228,6 +228,7 @@ interface ExecuteOptions<TInput, TOutput, TContext = unknown> {
     onMutate?: (variables: TInput) => TContext | Promise<TContext>;
     onSuccess?: (data: TOutput, context?: TContext) => void;
     onError?: (error: ApiError, context?: TContext) => void;
+    onSettled?: (data?: TOutput, 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>>> = {

package/dist/{apiModule.types-CpwGDEpG.d.ts → apiModule.types-BTtRM9wO.d.ts}

@@ -228,6 +228,7 @@ interface ExecuteOptions<TInput, TOutput, TContext = unknown> {
     onMutate?: (variables: TInput) => TContext | Promise<TContext>;
     onSuccess?: (data: TOutput, context?: TContext) => void;
     onError?: (error: ApiError, context?: TContext) => void;
+    onSettled?: (data?: TOutput, 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>>> = {

package/dist/client.cjs

@@ -677,6 +677,17 @@ var GlobalStateManager = class {
 };
 var globalStateManager = new GlobalStateManager();
 
+// src/core/cacheKey.ts
+var generateCacheKey = (moduleName, actionName, input, callOptions = {}) => {
+  const params = { path: callOptions.pathParams, body: input };
+  try {
+    return `${moduleName}/${actionName}::${JSON.stringify(params)}`;
+  } catch (error) {
+    console.warn("Could not stringify cache key params, falling back to timestamp.", { moduleName, actionName, error });
+    return `${moduleName}/${actionName}::${Date.now()}`;
+  }
+};
+
 // src/hooks/useApiModule/useApiModule.ts
 var ApiModuleContext = (0, import_react4.createContext)(null);
 var ApiModuleProvider = ApiModuleContext.Provider;
@@ -697,7 +708,7 @@ function useApiActionState(actionConfig, cacheKey, actionExecutor, enabled) {
     } else if (enabled && state.isStale && !state.loading) {
       actionExecutor(input);
     }
-  }, [enabled, state.isStale, state.loading, state.called, actionConfig.autoFetch, actionExecutor, input]);
+  }, [enabled, state.isStale, state.loading, state.called, actionConfig.autoFetch, actionExecutor, JSON.stringify(input)]);
   return state;
 }
 function useModuleContext() {
@@ -707,14 +718,6 @@ function useModuleContext() {
   }
   return context;
 }
-var generateCacheKey = (moduleName, actionName, input, callOptions = {}) => {
-  const params = { path: callOptions.pathParams, body: input };
-  try {
-    return `${moduleName}/${actionName}::${JSON.stringify(params)}`;
-  } catch (error) {
-    return `${moduleName}/${actionName}::${Date.now()}`;
-  }
-};
 function useApiModule(axiosInstance, moduleConfig, options = {}) {
   const { refetchOnWindowFocus = true, onSuccess, onError, pathParams: modulePathParams, enabled = true, hydratedState } = options;
   const pathParamsString = (0, import_react4.useMemo)(() => JSON.stringify(modulePathParams || {}), [modulePathParams]);
@@ -765,6 +768,10 @@ function useApiModule(axiosInstance, moduleConfig, options = {}) {
           savedCallbacks.current.onError?.(actionName, apiError.message, apiError);
           options2.onError?.(apiError, mutationContext);
           return errorResult;
+        } finally {
+          if (options2.onSettled) {
+            options2.onSettled();
+          }
         }
       };
       const reset = (input, options2 = {}) => {

package/dist/client.d.cts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from 'axios';
-import { U as UseApiConfig, A as ActionConfigModule, a as ApiModuleConfig, b as UseApiModuleOptions, c as UseApiModuleReturn } from './apiModule.types-CpwGDEpG.cjs';
-import { U as UseApiRecordConfig, a as UseApiRecordReturn } from './useApiRecord.types-B45E0qux.cjs';
+import { U as UseApiConfig, A as ActionConfigModule, a as ApiModuleConfig, b as UseApiModuleOptions, c as UseApiModuleReturn } from './apiModule.types-BTtRM9wO.cjs';
+import { U as UseApiRecordConfig, a as UseApiRecordReturn } from './useApiRecord.types-CBP3Ufvu.cjs';
 import * as React from 'react';
 
 declare function useApi<T>(axiosInstance: AxiosInstance, config: UseApiConfig<T>): any;

package/dist/client.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from 'axios';
-import { U as UseApiConfig, A as ActionConfigModule, a as ApiModuleConfig, b as UseApiModuleOptions, c as UseApiModuleReturn } from './apiModule.types-CpwGDEpG.js';
-import { U as UseApiRecordConfig, a as UseApiRecordReturn } from './useApiRecord.types-DlrlXL1t.js';
+import { U as UseApiConfig, A as ActionConfigModule, a as ApiModuleConfig, b as UseApiModuleOptions, c as UseApiModuleReturn } from './apiModule.types-BTtRM9wO.js';
+import { U as UseApiRecordConfig, a as UseApiRecordReturn } from './useApiRecord.types-BsOSJZ5l.js';
 import * as React from 'react';
 
 declare function useApi<T>(axiosInstance: AxiosInstance, config: UseApiConfig<T>): any;

package/dist/client.js

@@ -638,6 +638,17 @@ var GlobalStateManager = class {
 };
 var globalStateManager = new GlobalStateManager();
 
+// src/core/cacheKey.ts
+var generateCacheKey = (moduleName, actionName, input, callOptions = {}) => {
+  const params = { path: callOptions.pathParams, body: input };
+  try {
+    return `${moduleName}/${actionName}::${JSON.stringify(params)}`;
+  } catch (error) {
+    console.warn("Could not stringify cache key params, falling back to timestamp.", { moduleName, actionName, error });
+    return `${moduleName}/${actionName}::${Date.now()}`;
+  }
+};
+
 // src/hooks/useApiModule/useApiModule.ts
 var ApiModuleContext = createContext(null);
 var ApiModuleProvider = ApiModuleContext.Provider;
@@ -658,7 +669,7 @@ function useApiActionState(actionConfig, cacheKey, actionExecutor, enabled) {
     } else if (enabled && state.isStale && !state.loading) {
       actionExecutor(input);
     }
-  }, [enabled, state.isStale, state.loading, state.called, actionConfig.autoFetch, actionExecutor, input]);
+  }, [enabled, state.isStale, state.loading, state.called, actionConfig.autoFetch, actionExecutor, JSON.stringify(input)]);
   return state;
 }
 function useModuleContext() {
@@ -668,14 +679,6 @@ function useModuleContext() {
   }
   return context;
 }
-var generateCacheKey = (moduleName, actionName, input, callOptions = {}) => {
-  const params = { path: callOptions.pathParams, body: input };
-  try {
-    return `${moduleName}/${actionName}::${JSON.stringify(params)}`;
-  } catch (error) {
-    return `${moduleName}/${actionName}::${Date.now()}`;
-  }
-};
 function useApiModule(axiosInstance, moduleConfig, options = {}) {
   const { refetchOnWindowFocus = true, onSuccess, onError, pathParams: modulePathParams, enabled = true, hydratedState } = options;
   const pathParamsString = useMemo3(() => JSON.stringify(modulePathParams || {}), [modulePathParams]);
@@ -726,6 +729,10 @@ function useApiModule(axiosInstance, moduleConfig, options = {}) {
           savedCallbacks.current.onError?.(actionName, apiError.message, apiError);
           options2.onError?.(apiError, mutationContext);
           return errorResult;
+        } finally {
+          if (options2.onSettled) {
+            options2.onSettled();
+          }
         }
       };
       const reset = (input, options2 = {}) => {

package/dist/index.cjs

@@ -38,6 +38,7 @@ __export(index_exports, {
   createApiActions: () => createApiActions,
   createApiClient: () => createApiClient,
   createApiServices: () => createApiServices,
+  generateCacheKey: () => generateCacheKey,
   globalStateManager: () => globalStateManager,
   processResponse: () => processResponse
 });
@@ -690,6 +691,17 @@ var CacheManager = class {
   }
 };
 var cacheManager = new CacheManager();
+
+// src/core/cacheKey.ts
+var generateCacheKey = (moduleName, actionName, input, callOptions = {}) => {
+  const params = { path: callOptions.pathParams, body: input };
+  try {
+    return `${moduleName}/${actionName}::${JSON.stringify(params)}`;
+  } catch (error) {
+    console.warn("Could not stringify cache key params, falling back to timestamp.", { moduleName, actionName, error });
+    return `${moduleName}/${actionName}::${Date.now()}`;
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   buildPaginateQuery,
@@ -698,6 +710,7 @@ var cacheManager = new CacheManager();
   createApiActions,
   createApiClient,
   createApiServices,
+  generateCacheKey,
   globalStateManager,
   processResponse
 });

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 import { AxiosInstance, AxiosRequestConfig, Method, AxiosResponse, AxiosError } from 'axios';
-import { d as ApiClientConfig, A as ActionConfigModule, S as StandardResponse, e as ActionOptions, R as RequestConfig, f as ActionStateModule, Q as QueryOptions, g as UseApiQuery, h as ApiError, L as LogLevel } from './apiModule.types-CpwGDEpG.cjs';
-export { l as ActionConfig, n as ActionState, a as ApiModuleConfig, 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, U as UseApiConfig, b as UseApiModuleOptions, c as UseApiModuleReturn, m as UseApiState, V as ValidationError } from './apiModule.types-CpwGDEpG.cjs';
-export { c as UseApiRecordActions, U as UseApiRecordConfig, a as UseApiRecordReturn, b as UseApiRecordState } from './useApiRecord.types-B45E0qux.cjs';
+import { d as ApiClientConfig, A as ActionConfigModule, S as StandardResponse, e as ActionOptions, R as RequestConfig, f as ActionStateModule, Q as QueryOptions, g as UseApiQuery, h as ApiError, L as LogLevel } from './apiModule.types-BTtRM9wO.cjs';
+export { l as ActionConfig, n as ActionState, a as ApiModuleConfig, 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, U as UseApiConfig, b as UseApiModuleOptions, c as UseApiModuleReturn, m as UseApiState, V as ValidationError } from './apiModule.types-BTtRM9wO.cjs';
+export { c as UseApiRecordActions, U as UseApiRecordConfig, a as UseApiRecordReturn, b as UseApiRecordState } from './useApiRecord.types-CBP3Ufvu.cjs';
 import 'react';
 
 declare function createApiClient(config: ApiClientConfig): AxiosInstance;
@@ -144,6 +144,19 @@ declare class CacheManager {
 }
 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,
@@ -225,4 +238,4 @@ interface UseApiResourceReturn<T, TCreate, TUpdate, TPathParams> {
     setQuery: React.Dispatch<React.SetStateAction<QueryOptions>>;
 }
 
-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, globalStateManager, processResponse };
+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 };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { AxiosInstance, AxiosRequestConfig, Method, AxiosResponse, AxiosError } from 'axios';
-import { d as ApiClientConfig, A as ActionConfigModule, S as StandardResponse, e as ActionOptions, R as RequestConfig, f as ActionStateModule, Q as QueryOptions, g as UseApiQuery, h as ApiError, L as LogLevel } from './apiModule.types-CpwGDEpG.js';
-export { l as ActionConfig, n as ActionState, a as ApiModuleConfig, 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, U as UseApiConfig, b as UseApiModuleOptions, c as UseApiModuleReturn, m as UseApiState, V as ValidationError } from './apiModule.types-CpwGDEpG.js';
-export { c as UseApiRecordActions, U as UseApiRecordConfig, a as UseApiRecordReturn, b as UseApiRecordState } from './useApiRecord.types-DlrlXL1t.js';
+import { d as ApiClientConfig, A as ActionConfigModule, S as StandardResponse, e as ActionOptions, R as RequestConfig, f as ActionStateModule, Q as QueryOptions, g as UseApiQuery, h as ApiError, L as LogLevel } from './apiModule.types-BTtRM9wO.js';
+export { l as ActionConfig, n as ActionState, a as ApiModuleConfig, 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, U as UseApiConfig, b as UseApiModuleOptions, c as UseApiModuleReturn, m as UseApiState, V as ValidationError } from './apiModule.types-BTtRM9wO.js';
+export { c as UseApiRecordActions, U as UseApiRecordConfig, a as UseApiRecordReturn, b as UseApiRecordState } from './useApiRecord.types-BsOSJZ5l.js';
 import 'react';
 
 declare function createApiClient(config: ApiClientConfig): AxiosInstance;
@@ -144,6 +144,19 @@ declare class CacheManager {
 }
 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,
@@ -225,4 +238,4 @@ interface UseApiResourceReturn<T, TCreate, TUpdate, TPathParams> {
     setQuery: React.Dispatch<React.SetStateAction<QueryOptions>>;
 }
 
-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, globalStateManager, processResponse };
+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 };

package/dist/index.js

@@ -649,6 +649,17 @@ var CacheManager = class {
   }
 };
 var cacheManager = new CacheManager();
+
+// src/core/cacheKey.ts
+var generateCacheKey = (moduleName, actionName, input, callOptions = {}) => {
+  const params = { path: callOptions.pathParams, body: input };
+  try {
+    return `${moduleName}/${actionName}::${JSON.stringify(params)}`;
+  } catch (error) {
+    console.warn("Could not stringify cache key params, falling back to timestamp.", { moduleName, actionName, error });
+    return `${moduleName}/${actionName}::${Date.now()}`;
+  }
+};
 export {
   buildPaginateQuery,
   cacheManager,
@@ -656,6 +667,7 @@ export {
   createApiActions,
   createApiClient,
   createApiServices,
+  generateCacheKey,
   globalStateManager,
   processResponse
 };

package/dist/server.cjs

@@ -286,15 +286,18 @@ var GlobalStateManager = class {
 };
 var globalStateManager = new GlobalStateManager();
 
-// src/server.ts
+// src/core/cacheKey.ts
 var generateCacheKey = (moduleName, actionName, input, callOptions = {}) => {
   const params = { path: callOptions.pathParams, body: input };
   try {
     return `${moduleName}/${actionName}::${JSON.stringify(params)}`;
   } catch (error) {
+    console.warn("Could not stringify cache key params, falling back to timestamp.", { moduleName, actionName, error });
     return `${moduleName}/${actionName}::${Date.now()}`;
   }
 };
+
+// src/server.ts
 function createServerApi(apiClient, moduleConfig) {
   return {
     /**

package/dist/server.d.cts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from 'axios';
-import { A as ActionConfigModule, a as ApiModuleConfig, I as InputOf } from './apiModule.types-CpwGDEpG.cjs';
+import { A as ActionConfigModule, a as ApiModuleConfig, I as InputOf } from './apiModule.types-BTtRM9wO.cjs';
 import 'react';
 
 /**

package/dist/server.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from 'axios';
-import { A as ActionConfigModule, a as ApiModuleConfig, I as InputOf } from './apiModule.types-CpwGDEpG.js';
+import { A as ActionConfigModule, a as ApiModuleConfig, I as InputOf } from './apiModule.types-BTtRM9wO.js';
 import 'react';
 
 /**

package/dist/server.js

@@ -252,15 +252,18 @@ var GlobalStateManager = class {
 };
 var globalStateManager = new GlobalStateManager();
 
-// src/server.ts
+// src/core/cacheKey.ts
 var generateCacheKey = (moduleName, actionName, input, callOptions = {}) => {
   const params = { path: callOptions.pathParams, body: input };
   try {
     return `${moduleName}/${actionName}::${JSON.stringify(params)}`;
   } catch (error) {
+    console.warn("Could not stringify cache key params, falling back to timestamp.", { moduleName, actionName, error });
     return `${moduleName}/${actionName}::${Date.now()}`;
   }
 };
+
+// src/server.ts
 function createServerApi(apiClient, moduleConfig) {
   return {
     /**

package/dist/{useApiRecord.types-DlrlXL1t.d.ts → useApiRecord.types-BsOSJZ5l.d.ts}

@@ -1,5 +1,5 @@
 import { Dispatch, SetStateAction } from 'react';
-import { R as RequestConfig, h as ApiError, S as StandardResponse, e as ActionOptions } from './apiModule.types-CpwGDEpG.js';
+import { R as RequestConfig, h as ApiError, S as StandardResponse, e as ActionOptions } from './apiModule.types-BTtRM9wO.js';
 
 /**
  * Represents the internal state of the `useApiRecord` hook.

package/dist/{useApiRecord.types-B45E0qux.d.cts → useApiRecord.types-CBP3Ufvu.d.cts}

@@ -1,5 +1,5 @@
 import { Dispatch, SetStateAction } from 'react';
-import { R as RequestConfig, h as ApiError, S as StandardResponse, e as ActionOptions } from './apiModule.types-CpwGDEpG.cjs';
+import { R as RequestConfig, h as ApiError, S as StandardResponse, e as ActionOptions } from './apiModule.types-BTtRM9wO.cjs';
 
 /**
  * Represents the internal state of the `useApiRecord` hook.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-core-lib",
-  "version": "12.0.13",
+  "version": "12.0.15",
   "description": "A flexible and powerful API client library for modern web applications.",
   "type": "module",