api-core-lib 12.0.92 → 12.0.93

package/dist/{apiModule.types-CZX-M2Ub.d.cts → apiModule.types-0YqoHN1K.d.cts}

@@ -205,6 +205,8 @@ interface ActionConfigModule<TInput = unknown, TOutput = unknown> {
     autoFetch?: boolean;
     cacheResponse?: boolean;
     invalidates?: string[];
+    requiresAuth?: boolean;
+    pathParams?: string[];
     _input?: TInput;
     _output?: TOutput;
 }
@@ -261,12 +263,15 @@ type ActionsWithQuery<TActions extends Record<string, any>> = {
         hasQuery: true;
     } ? K : never;
 }[keyof TActions];
-type UseApiModuleReturn<TActions extends Record<string, any>, TExtra = {}> = {
+type ModuleQueries<TActions extends Record<string, ActionConfigModule<any, any>>> = Partial<{
+    [K in keyof TActions as TActions[K] extends {
+        hasQuery: true;
+    } ? K : never]: UseApiQuery;
+}>;
+type UseApiModuleReturn<TActions extends Record<string, ActionConfigModule<any, any>>, TExtra extends object = {}> = {
     states: ModuleStates<TActions>;
     actions: ModuleActions<TActions>;
-    queries: {
-        [K in ActionsWithQuery<TActions>]: UseApiQuery;
-    };
+    queries: ModuleQueries<TActions>;
     dehydrate: () => string;
 } & TExtra;
 /**
@@ -287,4 +292,4 @@ type ActionMethods<TAction extends ActionConfigModule<any, any>> = {
     }) => void;
 };
 
-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, ActionsWithQuery as f, ApiClientConfig as g, ActionOptions as h, ActionStateModule as i, ApiError as j, TokenManager as k, MiddlewareContext as l, Middleware as m, RefreshTokenConfig as n, ActionConfig as o, UseApiState as p, ActionState as q, ExecuteOptions as r, ActionMethods as s, 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, ActionsWithQuery as r, ModuleQueries as s, t, ActionMethods as u };

package/dist/{apiModule.types-CZX-M2Ub.d.ts → apiModule.types-0YqoHN1K.d.ts}

@@ -205,6 +205,8 @@ interface ActionConfigModule<TInput = unknown, TOutput = unknown> {
     autoFetch?: boolean;
     cacheResponse?: boolean;
     invalidates?: string[];
+    requiresAuth?: boolean;
+    pathParams?: string[];
     _input?: TInput;
     _output?: TOutput;
 }
@@ -261,12 +263,15 @@ type ActionsWithQuery<TActions extends Record<string, any>> = {
         hasQuery: true;
     } ? K : never;
 }[keyof TActions];
-type UseApiModuleReturn<TActions extends Record<string, any>, TExtra = {}> = {
+type ModuleQueries<TActions extends Record<string, ActionConfigModule<any, any>>> = Partial<{
+    [K in keyof TActions as TActions[K] extends {
+        hasQuery: true;
+    } ? K : never]: UseApiQuery;
+}>;
+type UseApiModuleReturn<TActions extends Record<string, ActionConfigModule<any, any>>, TExtra extends object = {}> = {
     states: ModuleStates<TActions>;
     actions: ModuleActions<TActions>;
-    queries: {
-        [K in ActionsWithQuery<TActions>]: UseApiQuery;
-    };
+    queries: ModuleQueries<TActions>;
     dehydrate: () => string;
 } & TExtra;
 /**
@@ -287,4 +292,4 @@ type ActionMethods<TAction extends ActionConfigModule<any, any>> = {
     }) => void;
 };
 
-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, ActionsWithQuery as f, ApiClientConfig as g, ActionOptions as h, ActionStateModule as i, ApiError as j, TokenManager as k, MiddlewareContext as l, Middleware as m, RefreshTokenConfig as n, ActionConfig as o, UseApiState as p, ActionState as q, ExecuteOptions as r, ActionMethods as s, 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, ActionsWithQuery as r, ModuleQueries as s, t, ActionMethods as u };

package/dist/client.cjs

@@ -317,13 +317,6 @@ function useApiActionState(actionConfig, cacheKey, execute, input, enabled) {
   }, [cacheKey, enabled, state.isStale, state.loading, state.called, actionConfig.autoFetch, refetch]);
   return state;
 }
-function useModuleContext() {
-  const context = _react.useContext.call(void 0, ApiModuleContext);
-  if (!context) {
-    throw new Error("useModuleContext must be used within an ApiModuleProvider");
-  }
-  return context;
-}
 function useApiModule(axiosInstance, moduleConfig, options = {}) {
   const {
     refetchOnWindowFocus = true,
@@ -527,6 +520,7 @@ function useApiModule(axiosInstance, moduleConfig, options = {}) {
 
 function createApiModuleContext() {
   const Context = _react.createContext.call(void 0, null);
+  Context.displayName = "ApiModuleContext";
   const Provider = ({ value, children }) => {
     return _react.createElement.call(void 0, Context.Provider, { value }, children);
   };
@@ -550,5 +544,4 @@ function createApiModuleContext() {
 
 
 
-
-exports.ApiModuleProvider = ApiModuleProvider; exports.createApiModuleContext = createApiModuleContext; exports.useApi = useApi; exports.useApiModule = useApiModule; exports.useApiRecord = useApiRecord; exports.useDeepCompareEffect = useDeepCompareEffect; exports.useModuleContext = useModuleContext;
+exports.ApiModuleProvider = ApiModuleProvider; exports.createApiModuleContext = createApiModuleContext; exports.useApi = useApi; exports.useApiModule = useApiModule; exports.useApiRecord = useApiRecord; exports.useDeepCompareEffect = useDeepCompareEffect;

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, M as ModuleStates, d as ModuleActions, e as UseApiQuery, f as ActionsWithQuery } from './apiModule.types-CZX-M2Ub.cjs';
-import { U as UseApiRecordConfig, a as UseApiRecordReturn } from './useApiRecord.types-Cq9AlZX2.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-0YqoHN1K.cjs';
+import { U as UseApiRecordConfig, a as UseApiRecordReturn } from './useApiRecord.types-CdbyfLNG.cjs';
 import * as react from 'react';
 import { ReactNode } from 'react';
 
@@ -25,12 +25,11 @@ declare function useDeepCompareEffect(callback: EffectCallback, dependencies: De
 declare const ApiModuleProvider: react.Provider<{
     states: ModuleStates<any>;
     actions: ModuleActions<any>;
-    queries: {
+    queries: Partial<{
         [x: string]: UseApiQuery;
-    };
+    }>;
     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>;
 
 /**
@@ -38,25 +37,16 @@ declare function useApiModule<TActions extends Record<string, ActionConfigModule
  * This pattern avoids the need for manual type assertions in consuming components.
  *
  * @template TActions - The shape of the actions in the API module.
+ * @template TExtra - The shape of any extra data passed via `extraContextData`.
  * @returns An object containing the typed Context, Provider, and a `useContext` hook.
  */
-declare function createApiModuleContext<TActions extends Record<string, any>>(): {
-    Context: react.Context<{
-        states: ModuleStates<TActions>;
-        actions: ModuleActions<TActions>;
-        queries: { [K in ActionsWithQuery<TActions>]: UseApiQuery; };
-        dehydrate: () => string;
-    } | null>;
+declare function createApiModuleContext<TActions extends Record<string, any>, TExtra extends object = {}>(): {
+    Context: react.Context<UseApiModuleReturn<TActions, TExtra> | null>;
     Provider: ({ value, children }: {
-        value: UseApiModuleReturn<TActions>;
+        value: UseApiModuleReturn<TActions, TExtra>;
         children: ReactNode;
-    }) => react.FunctionComponentElement<react.ProviderProps<{
-        states: ModuleStates<TActions>;
-        actions: ModuleActions<TActions>;
-        queries: { [K in ActionsWithQuery<TActions>]: UseApiQuery; };
-        dehydrate: () => string;
-    } | null>>;
-    useContext: () => UseApiModuleReturn<TActions>;
+    }) => react.FunctionComponentElement<react.ProviderProps<UseApiModuleReturn<TActions, TExtra> | null>>;
+    useContext: () => UseApiModuleReturn<TActions, TExtra>;
 };
 
-export { ApiModuleProvider, createApiModuleContext, useApi, useApiModule, useApiRecord, useDeepCompareEffect, useModuleContext };
+export { ApiModuleProvider, createApiModuleContext, useApi, useApiModule, useApiRecord, useDeepCompareEffect };

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, M as ModuleStates, d as ModuleActions, e as UseApiQuery, f as ActionsWithQuery } from './apiModule.types-CZX-M2Ub.js';
-import { U as UseApiRecordConfig, a as UseApiRecordReturn } from './useApiRecord.types-Cye9a7zh.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-0YqoHN1K.js';
+import { U as UseApiRecordConfig, a as UseApiRecordReturn } from './useApiRecord.types-Q5Ux9P1x.js';
 import * as react from 'react';
 import { ReactNode } from 'react';
 
@@ -25,12 +25,11 @@ declare function useDeepCompareEffect(callback: EffectCallback, dependencies: De
 declare const ApiModuleProvider: react.Provider<{
     states: ModuleStates<any>;
     actions: ModuleActions<any>;
-    queries: {
+    queries: Partial<{
         [x: string]: UseApiQuery;
-    };
+    }>;
     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>;
 
 /**
@@ -38,25 +37,16 @@ declare function useApiModule<TActions extends Record<string, ActionConfigModule
  * This pattern avoids the need for manual type assertions in consuming components.
  *
  * @template TActions - The shape of the actions in the API module.
+ * @template TExtra - The shape of any extra data passed via `extraContextData`.
  * @returns An object containing the typed Context, Provider, and a `useContext` hook.
  */
-declare function createApiModuleContext<TActions extends Record<string, any>>(): {
-    Context: react.Context<{
-        states: ModuleStates<TActions>;
-        actions: ModuleActions<TActions>;
-        queries: { [K in ActionsWithQuery<TActions>]: UseApiQuery; };
-        dehydrate: () => string;
-    } | null>;
+declare function createApiModuleContext<TActions extends Record<string, any>, TExtra extends object = {}>(): {
+    Context: react.Context<UseApiModuleReturn<TActions, TExtra> | null>;
     Provider: ({ value, children }: {
-        value: UseApiModuleReturn<TActions>;
+        value: UseApiModuleReturn<TActions, TExtra>;
         children: ReactNode;
-    }) => react.FunctionComponentElement<react.ProviderProps<{
-        states: ModuleStates<TActions>;
-        actions: ModuleActions<TActions>;
-        queries: { [K in ActionsWithQuery<TActions>]: UseApiQuery; };
-        dehydrate: () => string;
-    } | null>>;
-    useContext: () => UseApiModuleReturn<TActions>;
+    }) => react.FunctionComponentElement<react.ProviderProps<UseApiModuleReturn<TActions, TExtra> | null>>;
+    useContext: () => UseApiModuleReturn<TActions, TExtra>;
 };
 
-export { ApiModuleProvider, createApiModuleContext, useApi, useApiModule, useApiRecord, useDeepCompareEffect, useModuleContext };
+export { ApiModuleProvider, createApiModuleContext, useApi, useApiModule, useApiRecord, useDeepCompareEffect };

package/dist/client.js

@@ -271,7 +271,7 @@ function useDeepCompareEffect(callback, dependencies) {
 }
 
 // src/hooks/useApiModule/useApiModule.ts
-import { createContext, useCallback as useCallback3, useContext, useEffect as useEffect4, useMemo as useMemo3, useRef as useRef4, useState as useState3, useSyncExternalStore } from "react";
+import { createContext, useCallback as useCallback3, useEffect as useEffect4, useMemo as useMemo3, useRef as useRef4, useState as useState3, useSyncExternalStore } from "react";
 var ApiModuleContext = createContext(null);
 var ApiModuleProvider = ApiModuleContext.Provider;
 var createInitialState = () => ({
@@ -317,13 +317,6 @@ function useApiActionState(actionConfig, cacheKey, execute, input, enabled) {
   }, [cacheKey, enabled, state.isStale, state.loading, state.called, actionConfig.autoFetch, refetch]);
   return state;
 }
-function useModuleContext() {
-  const context = useContext(ApiModuleContext);
-  if (!context) {
-    throw new Error("useModuleContext must be used within an ApiModuleProvider");
-  }
-  return context;
-}
 function useApiModule(axiosInstance, moduleConfig, options = {}) {
   const {
     refetchOnWindowFocus = true,
@@ -527,6 +520,7 @@ function useApiModule(axiosInstance, moduleConfig, options = {}) {
 import { createContext as createContext2, useContext as useContext2, createElement } from "react";
 function createApiModuleContext() {
   const Context = createContext2(null);
+  Context.displayName = "ApiModuleContext";
   const Provider = ({ value, children }) => {
     return createElement(Context.Provider, { value }, children);
   };
@@ -549,6 +543,5 @@ export {
   useApi,
   useApiModule,
   useApiRecord,
-  useDeepCompareEffect,
-  useModuleContext
+  useDeepCompareEffect
 };

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 import { AxiosInstance, AxiosRequestConfig, Method, AxiosResponse, AxiosError } from 'axios';
-import { g as ApiClientConfig, A as ActionConfigModule, S as StandardResponse, h as ActionOptions, R as RequestConfig, i as ActionStateModule, Q as QueryOptions, e as UseApiQuery, j as ApiError, L as LogLevel } from './apiModule.types-CZX-M2Ub.cjs';
-export { o as ActionConfig, s as ActionMethods, q as ActionState, f as ActionsWithQuery, a as ApiModuleConfig, E as ExecutableAction, r as ExecuteOptions, I as InputOf, m as Middleware, l as MiddlewareContext, d as ModuleActions, 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-CZX-M2Ub.cjs';
-export { c as UseApiRecordActions, U as UseApiRecordConfig, a as UseApiRecordReturn, b as UseApiRecordState } from './useApiRecord.types-Cq9AlZX2.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-0YqoHN1K.cjs';
+export { n as ActionConfig, u as ActionMethods, p as ActionState, r as ActionsWithQuery, a as ApiModuleConfig, E as ExecutableAction, q as ExecuteOptions, I as InputOf, l as Middleware, k as MiddlewareContext, d as ModuleActions, s as ModuleQueries, 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-0YqoHN1K.cjs';
+export { c as UseApiRecordActions, U as UseApiRecordConfig, a as UseApiRecordReturn, b as UseApiRecordState } from './useApiRecord.types-CdbyfLNG.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 { g as ApiClientConfig, A as ActionConfigModule, S as StandardResponse, h as ActionOptions, R as RequestConfig, i as ActionStateModule, Q as QueryOptions, e as UseApiQuery, j as ApiError, L as LogLevel } from './apiModule.types-CZX-M2Ub.js';
-export { o as ActionConfig, s as ActionMethods, q as ActionState, f as ActionsWithQuery, a as ApiModuleConfig, E as ExecutableAction, r as ExecuteOptions, I as InputOf, m as Middleware, l as MiddlewareContext, d as ModuleActions, 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-CZX-M2Ub.js';
-export { c as UseApiRecordActions, U as UseApiRecordConfig, a as UseApiRecordReturn, b as UseApiRecordState } from './useApiRecord.types-Cye9a7zh.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-0YqoHN1K.js';
+export { n as ActionConfig, u as ActionMethods, p as ActionState, r as ActionsWithQuery, a as ApiModuleConfig, E as ExecutableAction, q as ExecuteOptions, I as InputOf, l as Middleware, k as MiddlewareContext, d as ModuleActions, s as ModuleQueries, 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-0YqoHN1K.js';
+export { c as UseApiRecordActions, U as UseApiRecordConfig, a as UseApiRecordReturn, b as UseApiRecordState } from './useApiRecord.types-Q5Ux9P1x.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-CZX-M2Ub.cjs';
+import { A as ActionConfigModule, a as ApiModuleConfig, I as InputOf } from './apiModule.types-0YqoHN1K.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-CZX-M2Ub.js';
+import { A as ActionConfigModule, a as ApiModuleConfig, I as InputOf } from './apiModule.types-0YqoHN1K.js';
 import 'react';
 
 /**

package/dist/{useApiRecord.types-Cq9AlZX2.d.cts → useApiRecord.types-CdbyfLNG.d.cts}

@@ -1,5 +1,5 @@
 import { Dispatch, SetStateAction } from 'react';
-import { R as RequestConfig, j as ApiError, S as StandardResponse, h as ActionOptions } from './apiModule.types-CZX-M2Ub.cjs';
+import { R as RequestConfig, i as ApiError, S as StandardResponse, g as ActionOptions } from './apiModule.types-0YqoHN1K.cjs';
 
 /**
  * Represents the internal state of the `useApiRecord` hook.

package/dist/{useApiRecord.types-Cye9a7zh.d.ts → useApiRecord.types-Q5Ux9P1x.d.ts}

@@ -1,5 +1,5 @@
 import { Dispatch, SetStateAction } from 'react';
-import { R as RequestConfig, j as ApiError, S as StandardResponse, h as ActionOptions } from './apiModule.types-CZX-M2Ub.js';
+import { R as RequestConfig, i as ApiError, S as StandardResponse, g as ActionOptions } from './apiModule.types-0YqoHN1K.js';
 
 /**
  * Represents the internal state of the `useApiRecord` hook.

package/package.json

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