api-core-lib 12.0.23 → 12.0.24

package/dist/{apiModule.types-D0LSWRW8.d.cts → apiModule.types-B_MxXat3.d.cts}

@@ -218,13 +218,14 @@ interface ApiModuleConfig<TActions extends Record<string, ActionConfigModule<any
     actions: TActions;
 }
 /** @description Configuration options passed directly to the `useApiModule` hook. */
-interface UseApiModuleOptions {
+interface UseApiModuleOptions<TExtra = {}> {
     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;
+    extraContextData?: TExtra;
 }
 /** A utility type to infer the Input type (`TInput`) from an ActionConfigModule. */
 type InputOf<TActionConfig> = TActionConfig extends ActionConfigModule<infer TInput, any> ? TInput : never;
@@ -253,7 +254,7 @@ 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>>> {
+type UseApiModuleReturn<TActions extends Record<string, any>, TExtra = {}> = {
     states: ModuleStates<TActions>;
     actions: ModuleActions<TActions>;
     queries: {
@@ -262,7 +263,7 @@ interface UseApiModuleReturn<TActions extends Record<string, ActionConfigModule<
         } ? UseApiQuery : never;
     };
     dehydrate: () => string;
-}
+} & TExtra;
 /**
  * يصف دوال `execute` و `reset` لإجراء واحد.
  * هذا النوع عام (generic) ليتناسب مع أنواع الإدخال والإخراج المختلفة لكل إجراء.
@@ -281,4 +282,4 @@ type ActionMethods<TAction extends ActionConfigModule<any, any>> = {
     }) => void;
 };
 
-export type { ActionConfigModule as A, ExecutableAction as E, InputOf as I, LogLevel as L, MiddlewareContext as M, OutputOf as O, PaginationMeta as P, QueryOptions as Q, RequestConfig as R, StandardResponse as S, Tokens as T, UseApiConfig as U, ValidationError as V, ApiModuleConfig as a, UseApiModuleOptions as b, UseApiModuleReturn as c, ApiClientConfig as d, ActionOptions as e, ActionStateModule as f, UseApiQuery as g, ApiError as h, TokenManager as i, Middleware as j, RefreshTokenConfig as k, ActionConfig as l, UseApiState as m, ActionState as n, ExecuteOptions as o, ModuleActions as p, ModuleStates as q, ActionMethods as r, t };
+export type { ActionConfigModule as A, ExecutableAction as E, InputOf as I, LogLevel as L, ModuleStates as M, OutputOf as O, PaginationMeta as P, QueryOptions as Q, RequestConfig as R, StandardResponse as S, Tokens as T, UseApiConfig as U, ValidationError as V, ApiModuleConfig as a, UseApiModuleOptions as b, UseApiModuleReturn as c, ModuleActions as d, UseApiQuery as e, ApiClientConfig as f, ActionOptions as g, ActionStateModule as h, ApiError as i, TokenManager as j, MiddlewareContext as k, Middleware as l, RefreshTokenConfig as m, ActionConfig as n, UseApiState as o, ActionState as p, ExecuteOptions as q, ActionMethods as r, t };

package/dist/{apiModule.types-D0LSWRW8.d.ts → apiModule.types-B_MxXat3.d.ts}

@@ -218,13 +218,14 @@ interface ApiModuleConfig<TActions extends Record<string, ActionConfigModule<any
     actions: TActions;
 }
 /** @description Configuration options passed directly to the `useApiModule` hook. */
-interface UseApiModuleOptions {
+interface UseApiModuleOptions<TExtra = {}> {
     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;
+    extraContextData?: TExtra;
 }
 /** A utility type to infer the Input type (`TInput`) from an ActionConfigModule. */
 type InputOf<TActionConfig> = TActionConfig extends ActionConfigModule<infer TInput, any> ? TInput : never;
@@ -253,7 +254,7 @@ 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>>> {
+type UseApiModuleReturn<TActions extends Record<string, any>, TExtra = {}> = {
     states: ModuleStates<TActions>;
     actions: ModuleActions<TActions>;
     queries: {
@@ -262,7 +263,7 @@ interface UseApiModuleReturn<TActions extends Record<string, ActionConfigModule<
         } ? UseApiQuery : never;
     };
     dehydrate: () => string;
-}
+} & TExtra;
 /**
  * يصف دوال `execute` و `reset` لإجراء واحد.
  * هذا النوع عام (generic) ليتناسب مع أنواع الإدخال والإخراج المختلفة لكل إجراء.
@@ -281,4 +282,4 @@ type ActionMethods<TAction extends ActionConfigModule<any, any>> = {
     }) => void;
 };
 
-export type { ActionConfigModule as A, ExecutableAction as E, InputOf as I, LogLevel as L, MiddlewareContext as M, OutputOf as O, PaginationMeta as P, QueryOptions as Q, RequestConfig as R, StandardResponse as S, Tokens as T, UseApiConfig as U, ValidationError as V, ApiModuleConfig as a, UseApiModuleOptions as b, UseApiModuleReturn as c, ApiClientConfig as d, ActionOptions as e, ActionStateModule as f, UseApiQuery as g, ApiError as h, TokenManager as i, Middleware as j, RefreshTokenConfig as k, ActionConfig as l, UseApiState as m, ActionState as n, ExecuteOptions as o, ModuleActions as p, ModuleStates as q, ActionMethods as r, t };
+export type { ActionConfigModule as A, ExecutableAction as E, InputOf as I, LogLevel as L, ModuleStates as M, OutputOf as O, PaginationMeta as P, QueryOptions as Q, RequestConfig as R, StandardResponse as S, Tokens as T, UseApiConfig as U, ValidationError as V, ApiModuleConfig as a, UseApiModuleOptions as b, UseApiModuleReturn as c, ModuleActions as d, UseApiQuery as e, ApiClientConfig as f, ActionOptions as g, ActionStateModule as h, ApiError as i, TokenManager as j, MiddlewareContext as k, Middleware as l, RefreshTokenConfig as m, ActionConfig as n, UseApiState as o, ActionState as p, ExecuteOptions as q, ActionMethods as r, t };

package/dist/client.cjs

@@ -741,7 +741,15 @@ function useModuleContext() {
   return context;
 }
 function useApiModule(axiosInstance, moduleConfig, options = {}) {
-  const { refetchOnWindowFocus = true, onSuccess, onError, pathParams: modulePathParams, enabled = true, hydratedState } = options;
+  const {
+    refetchOnWindowFocus = true,
+    onSuccess,
+    onError,
+    pathParams: modulePathParams,
+    enabled = true,
+    hydratedState,
+    extraContextData
+  } = options;
   const pathParamsString = (0, import_react4.useMemo)(() => JSON.stringify(modulePathParams || {}), [modulePathParams]);
   const [queryOptions, setQueryOptions] = (0, import_react4.useState)({});
   const savedCallbacks = (0, import_react4.useRef)({ onSuccess, onError });
@@ -913,7 +921,12 @@ function useApiModule(axiosInstance, moduleConfig, options = {}) {
   const dehydrate = (0, import_react4.useMemo)(() => {
     return () => globalStateManager.dehydrate();
   }, []);
-  return { actions, states, queries, dehydrate };
+  const baseApiReturn = { actions, states, queries, dehydrate };
+  const finalApiReturn = (0, import_react4.useMemo)(() => ({
+    ...baseApiReturn,
+    ...extraContextData || {}
+  }), [baseApiReturn, extraContextData]);
+  return finalApiReturn;
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

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-D0LSWRW8.cjs';
-import { U as UseApiRecordConfig, a as UseApiRecordReturn } from './useApiRecord.types-DXv1-ly6.cjs';
+import { U as UseApiConfig, A as ActionConfigModule, a as ApiModuleConfig, b as UseApiModuleOptions, c as UseApiModuleReturn, M as ModuleStates, d as ModuleActions, e as UseApiQuery } from './apiModule.types-B_MxXat3.cjs';
+import { U as UseApiRecordConfig, a as UseApiRecordReturn } from './useApiRecord.types-A-m0WKKh.cjs';
 import * as React from 'react';
 
 declare function useApi<T>(axiosInstance: AxiosInstance, config: UseApiConfig<T>): any;
@@ -21,8 +21,15 @@ type EffectCallback = () => (void | (() => void));
 type DependencyList = readonly any[];
 declare function useDeepCompareEffect(callback: EffectCallback, dependencies: DependencyList): void;
 
-declare const ApiModuleProvider: React.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 const ApiModuleProvider: React.Provider<{
+    states: ModuleStates<any>;
+    actions: ModuleActions<any>;
+    queries: {
+        [x: string]: UseApiQuery | undefined;
+    };
+    dehydrate: () => string;
+} | null>;
+declare function useModuleContext<TModule extends ApiModuleConfig<any>, TExtra = {}>(): UseApiModuleReturn<TModule['actions'], TExtra>;
+declare function useApiModule<TActions extends Record<string, ActionConfigModule<any, any>>, TExtra extends object = {}>(axiosInstance: AxiosInstance, moduleConfig: ApiModuleConfig<TActions>, options?: UseApiModuleOptions<TExtra>): UseApiModuleReturn<TActions, TExtra>;
 
 export { ApiModuleProvider, useApi, useApiModule, useApiRecord, useDeepCompareEffect, useModuleContext };

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-D0LSWRW8.js';
-import { U as UseApiRecordConfig, a as UseApiRecordReturn } from './useApiRecord.types-C7T0gsX_.js';
+import { U as UseApiConfig, A as ActionConfigModule, a as ApiModuleConfig, b as UseApiModuleOptions, c as UseApiModuleReturn, M as ModuleStates, d as ModuleActions, e as UseApiQuery } from './apiModule.types-B_MxXat3.js';
+import { U as UseApiRecordConfig, a as UseApiRecordReturn } from './useApiRecord.types-BgjdqOHw.js';
 import * as React from 'react';
 
 declare function useApi<T>(axiosInstance: AxiosInstance, config: UseApiConfig<T>): any;
@@ -21,8 +21,15 @@ type EffectCallback = () => (void | (() => void));
 type DependencyList = readonly any[];
 declare function useDeepCompareEffect(callback: EffectCallback, dependencies: DependencyList): void;
 
-declare const ApiModuleProvider: React.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 const ApiModuleProvider: React.Provider<{
+    states: ModuleStates<any>;
+    actions: ModuleActions<any>;
+    queries: {
+        [x: string]: UseApiQuery | undefined;
+    };
+    dehydrate: () => string;
+} | null>;
+declare function useModuleContext<TModule extends ApiModuleConfig<any>, TExtra = {}>(): UseApiModuleReturn<TModule['actions'], TExtra>;
+declare function useApiModule<TActions extends Record<string, ActionConfigModule<any, any>>, TExtra extends object = {}>(axiosInstance: AxiosInstance, moduleConfig: ApiModuleConfig<TActions>, options?: UseApiModuleOptions<TExtra>): UseApiModuleReturn<TActions, TExtra>;
 
 export { ApiModuleProvider, useApi, useApiModule, useApiRecord, useDeepCompareEffect, useModuleContext };

package/dist/client.js

@@ -702,7 +702,15 @@ function useModuleContext() {
   return context;
 }
 function useApiModule(axiosInstance, moduleConfig, options = {}) {
-  const { refetchOnWindowFocus = true, onSuccess, onError, pathParams: modulePathParams, enabled = true, hydratedState } = options;
+  const {
+    refetchOnWindowFocus = true,
+    onSuccess,
+    onError,
+    pathParams: modulePathParams,
+    enabled = true,
+    hydratedState,
+    extraContextData
+  } = options;
   const pathParamsString = useMemo3(() => JSON.stringify(modulePathParams || {}), [modulePathParams]);
   const [queryOptions, setQueryOptions] = useState3({});
   const savedCallbacks = useRef4({ onSuccess, onError });
@@ -874,7 +882,12 @@ function useApiModule(axiosInstance, moduleConfig, options = {}) {
   const dehydrate = useMemo3(() => {
     return () => globalStateManager.dehydrate();
   }, []);
-  return { actions, states, queries, dehydrate };
+  const baseApiReturn = { actions, states, queries, dehydrate };
+  const finalApiReturn = useMemo3(() => ({
+    ...baseApiReturn,
+    ...extraContextData || {}
+  }), [baseApiReturn, extraContextData]);
+  return finalApiReturn;
 }
 export {
   ApiModuleProvider,

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-D0LSWRW8.cjs';
-export { l as ActionConfig, r as ActionMethods, 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, t } from './apiModule.types-D0LSWRW8.cjs';
-export { c as UseApiRecordActions, U as UseApiRecordConfig, a as UseApiRecordReturn, b as UseApiRecordState } from './useApiRecord.types-DXv1-ly6.cjs';
+import { f as ApiClientConfig, A as ActionConfigModule, S as StandardResponse, g as ActionOptions, R as RequestConfig, h as ActionStateModule, Q as QueryOptions, e as UseApiQuery, i as ApiError, L as LogLevel } from './apiModule.types-B_MxXat3.cjs';
+export { n as ActionConfig, r as ActionMethods, p as ActionState, a as ApiModuleConfig, E as ExecutableAction, q as ExecuteOptions, I as InputOf, l as Middleware, k as MiddlewareContext, d as ModuleActions, M as ModuleStates, O as OutputOf, P as PaginationMeta, m as RefreshTokenConfig, j as TokenManager, T as Tokens, U as UseApiConfig, b as UseApiModuleOptions, c as UseApiModuleReturn, o as UseApiState, V as ValidationError, t } from './apiModule.types-B_MxXat3.cjs';
+export { c as UseApiRecordActions, U as UseApiRecordConfig, a as UseApiRecordReturn, b as UseApiRecordState } from './useApiRecord.types-A-m0WKKh.cjs';
 import 'react';
 
 declare function createApiClient(config: ApiClientConfig): AxiosInstance;

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-D0LSWRW8.js';
-export { l as ActionConfig, r as ActionMethods, 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, t } from './apiModule.types-D0LSWRW8.js';
-export { c as UseApiRecordActions, U as UseApiRecordConfig, a as UseApiRecordReturn, b as UseApiRecordState } from './useApiRecord.types-C7T0gsX_.js';
+import { f as ApiClientConfig, A as ActionConfigModule, S as StandardResponse, g as ActionOptions, R as RequestConfig, h as ActionStateModule, Q as QueryOptions, e as UseApiQuery, i as ApiError, L as LogLevel } from './apiModule.types-B_MxXat3.js';
+export { n as ActionConfig, r as ActionMethods, p as ActionState, a as ApiModuleConfig, E as ExecutableAction, q as ExecuteOptions, I as InputOf, l as Middleware, k as MiddlewareContext, d as ModuleActions, M as ModuleStates, O as OutputOf, P as PaginationMeta, m as RefreshTokenConfig, j as TokenManager, T as Tokens, U as UseApiConfig, b as UseApiModuleOptions, c as UseApiModuleReturn, o as UseApiState, V as ValidationError, t } from './apiModule.types-B_MxXat3.js';
+export { c as UseApiRecordActions, U as UseApiRecordConfig, a as UseApiRecordReturn, b as UseApiRecordState } from './useApiRecord.types-BgjdqOHw.js';
 import 'react';
 
 declare function createApiClient(config: ApiClientConfig): AxiosInstance;

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-D0LSWRW8.cjs';
+import { A as ActionConfigModule, a as ApiModuleConfig, I as InputOf } from './apiModule.types-B_MxXat3.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-D0LSWRW8.js';
+import { A as ActionConfigModule, a as ApiModuleConfig, I as InputOf } from './apiModule.types-B_MxXat3.js';
 import 'react';
 
 /**

package/dist/{useApiRecord.types-DXv1-ly6.d.cts → useApiRecord.types-A-m0WKKh.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-D0LSWRW8.cjs';
+import { R as RequestConfig, i as ApiError, S as StandardResponse, g as ActionOptions } from './apiModule.types-B_MxXat3.cjs';
 
 /**
  * Represents the internal state of the `useApiRecord` hook.

package/dist/{useApiRecord.types-C7T0gsX_.d.ts → useApiRecord.types-BgjdqOHw.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-D0LSWRW8.js';
+import { R as RequestConfig, i as ApiError, S as StandardResponse, g as ActionOptions } from './apiModule.types-B_MxXat3.js';
 
 /**
  * Represents the internal state of the `useApiRecord` hook.

package/package.json

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