@zayne-labs/callapi 1.10.6 → 1.11.1

package/dist/esm/{common-0nTMuN7U.d.ts → common-BMWVqV15.d.ts}

@@ -16,6 +16,7 @@ type UnionToIntersection<TUnion> = (TUnion extends unknown ? (param: TUnion) =>
 type UnmaskType<TValue> = {
   _: TValue;
 }["_"];
+type RemovePrefix<TPrefix extends "dedupe" | "retry", TKey extends string> = TKey extends `${TPrefix}${infer TRest}` ? Uncapitalize<TRest> : TKey;
 type Awaitable<TValue> = Promise<TValue> | TValue;
 type CommonRequestHeaders = "Access-Control-Allow-Credentials" | "Access-Control-Allow-Headers" | "Access-Control-Allow-Methods" | "Access-Control-Allow-Origin" | "Access-Control-Expose-Headers" | "Access-Control-Max-Age" | "Age" | "Allow" | "Cache-Control" | "Clear-Site-Data" | "Content-Disposition" | "Content-Encoding" | "Content-Language" | "Content-Length" | "Content-Location" | "Content-Range" | "Content-Security-Policy-Report-Only" | "Content-Security-Policy" | "Cookie" | "Cross-Origin-Embedder-Policy" | "Cross-Origin-Opener-Policy" | "Cross-Origin-Resource-Policy" | "Date" | "ETag" | "Expires" | "Last-Modified" | "Location" | "Permissions-Policy" | "Pragma" | "Retry-After" | "Save-Data" | "Sec-CH-Prefers-Color-Scheme" | "Sec-CH-Prefers-Reduced-Motion" | "Sec-CH-UA-Arch" | "Sec-CH-UA-Bitness" | "Sec-CH-UA-Form-Factor" | "Sec-CH-UA-Full-Version-List" | "Sec-CH-UA-Full-Version" | "Sec-CH-UA-Mobile" | "Sec-CH-UA-Model" | "Sec-CH-UA-Platform-Version" | "Sec-CH-UA-Platform" | "Sec-CH-UA-WoW64" | "Sec-CH-UA" | "Sec-Fetch-Dest" | "Sec-Fetch-Mode" | "Sec-Fetch-Site" | "Sec-Fetch-User" | "Sec-GPC" | "Server-Timing" | "Server" | "Service-Worker-Navigation-Preload" | "Set-Cookie" | "Strict-Transport-Security" | "Timing-Allow-Origin" | "Trailer" | "Transfer-Encoding" | "Upgrade" | "Vary" | "Warning" | "WWW-Authenticate" | "X-Content-Type-Options" | "X-DNS-Prefetch-Control" | "X-Frame-Options" | "X-Permitted-Cross-Domain-Policies" | "X-Powered-By" | "X-Robots-Tag" | "X-XSS-Protection" | AnyString;
 type CommonAuthorizationHeaders = `${"Basic" | "Bearer" | "Token"} ${string}`;
@@ -61,7 +62,7 @@ type CustomAuth = {
 type Auth = PossibleAuthValueOrGetter | BearerOrTokenAuth | BasicAuth | CustomAuth;
 //#endregion
 //#region src/constants/common.d.ts
-declare const fetchSpecificKeys: (keyof RequestInit | "duplex")[];
+declare const fetchSpecificKeys: readonly (keyof RequestInit | "duplex")[];
 //#endregion
 //#region src/types/standard-schema.d.ts
 /**
@@ -356,7 +357,7 @@ interface CallApiSchema {
    */
   query?: StandardSchemaV1<Query | undefined> | ((query: Query) => Awaitable<Query | undefined>);
 }
-declare const routeKeyMethods: ["delete", "get", "patch", "post", "put"];
+declare const routeKeyMethods: readonly ["delete", "get", "patch", "post", "put"];
 type RouteKeyMethods = (typeof routeKeyMethods)[number];
 type RouteKeyMethodsURLUnion = `@${RouteKeyMethods}/`;
 type BaseCallApiSchemaRoutes = Partial<Record<AnyString | RouteKeyMethodsURLUnion, CallApiSchema>>;
@@ -417,6 +418,43 @@ declare class ValidationError extends Error {
   static isError(error: unknown): error is ValidationError;
 }
 //#endregion
+//#region src/middlewares.d.ts
+type FetchImpl = UnmaskType<(input: string | Request | URL, init?: RequestInit) => Promise<Response>>;
+interface Middlewares {
+  /**
+   * Wraps the fetch implementation to intercept requests at the network layer.
+   *
+   * Takes the current fetch function and returns a new one. Use it to cache responses,
+   * add logging, handle offline mode, or short-circuit requests etc. Multiple middleware
+   * compose in order: plugins → base config → per-request.
+   *
+   * Unlike `customFetchImpl`, middleware can call through to the original fetch.
+   *
+   * @example
+   * ```ts
+   * // Cache responses
+   * const cache = new Map();
+   * fetchMiddleware: (fetchImpl) => async (input, init) => {
+   *   const key = input.toString();
+   *   if (cache.has(key)) return cache.get(key).clone();
+   *
+   *   const response = await fetchImpl(input, init);
+   *   cache.set(key, response.clone());
+   *   return response;
+   * }
+   *
+   * // Handle offline
+   * fetchMiddleware: (fetchImpl) => async (input, init) => {
+   *   if (!navigator.onLine) {
+   *     return new Response('{"error": "offline"}', { status: 503 });
+   *   }
+   *   return fetchImpl(input, init);
+   * }
+   * ```
+   */
+  fetchMiddleware?: (fetchImpl: FetchImpl) => FetchImpl;
+}
+//#endregion
 //#region src/plugins.d.ts
 type PluginSetupContext<TPluginExtraOptions = unknown> = RequestContext & PluginExtraOptions<TPluginExtraOptions> & {
   initURL: string;
@@ -437,13 +475,17 @@ interface CallApiPlugin {
    */
   description?: string;
   /**
-   * Hooks / Interceptors for the plugin
+   * Hooks for the plugin
    */
-  hooks?: PluginHooks;
+  hooks?: PluginHooks | ((context: PluginSetupContext) => Awaitable<PluginHooks>);
   /**
    *  A unique id for the plugin
    */
   id: string;
+  /**
+   * Middlewares that for the plugin
+   */
+  middlewares?: Middlewares | ((context: PluginSetupContext) => Awaitable<Middlewares>);
   /**
    * A name for the plugin
    */
@@ -571,7 +613,7 @@ interface Hooks<TData = DefaultDataType, TErrorData = DefaultDataType, TPluginOp
    */
   onError?: (context: ErrorContext<TErrorData> & PluginExtraOptions<TPluginOptions>) => Awaitable<unknown>;
   /**
-   * Hook called before the HTTP request is sent and before any internal processing begins.
+   * Hook called before the HTTP request is sent and before any internal processing of the request object begins.
    *
    * This is the ideal place to modify request headers, add authentication,
    * implement request logging, or perform any setup before the network call.
@@ -692,8 +734,6 @@ interface HookConfigOptions {
    *
    * This affects how ALL hooks execute together, regardless of their source (main or plugin).
    *
-   * Use `hookRegistrationOrder` to control the registration order of main vs plugin hooks.
-   *
    * @default "parallel"
    *
    * @example
@@ -707,7 +747,6 @@ interface HookConfigOptions {
    * // Use case: Hooks have dependencies and must run in order
    * const client = callApi.create({
    *   hooksExecutionMode: "sequential",
-   *   hookRegistrationOrder: "mainFirst",
    *   plugins: [transformPlugin],
    *   onRequest: (ctx) => {
    *     // This runs first, then transform plugin runs
@@ -737,62 +776,6 @@ interface HookConfigOptions {
    * ```
    */
   hooksExecutionMode?: "parallel" | "sequential";
-  /**
-   * Controls the registration order of main hooks relative to plugin hooks.
-   *
-   * - **"pluginsFirst"**: Plugin hooks register first, then main hooks (default)
-   * - **"mainFirst"**: Main hooks register first, then plugin hooks
-   *
-   * This determines the order hooks are added to the registry, which affects
-   * their execution sequence when using sequential execution mode.
-   *
-   * @default "pluginsFirst"
-   *
-   * @example
-   * ```ts
-   * // Plugin hooks register first (default behavior)
-   * hookRegistrationOrder: "pluginsFirst"
-   *
-   * // Main hooks register first
-   * hookRegistrationOrder: "mainFirst"
-   *
-   * // Use case: Main validation before plugin processing
-   * const client = callApi.create({
-   *   hookRegistrationOrder: "mainFirst",
-   *   hooksExecutionMode: "sequential",
-   *   plugins: [transformPlugin],
-   *   onRequest: (ctx) => {
-   *     // This main hook runs first in sequential mode
-   *     if (!ctx.request.headers.authorization) {
-   *       throw new Error("Authorization required");
-   *     }
-   *   }
-   * });
-   *
-   * // Use case: Plugin setup before main logic (default)
-   * const client = callApi.create({
-   *   hookRegistrationOrder: "pluginsFirst", // Default
-   *   hooksExecutionMode: "sequential",
-   *   plugins: [setupPlugin],
-   *   onRequest: (ctx) => {
-   *     // Plugin runs first, then this main hook
-   *     console.log("Request prepared:", ctx.request.url);
-   *   }
-   * });
-   *
-   * // Use case: Parallel mode (registration order less important)
-   * const client = callApi.create({
-   *   hookRegistrationOrder: "pluginsFirst",
-   *   hooksExecutionMode: "parallel", // All run simultaneously
-   *   plugins: [metricsPlugin, cachePlugin],
-   *   onRequest: (ctx) => {
-   *     // All hooks run in parallel regardless of registration order
-   *     addRequestId(ctx.request);
-   *   }
-   * });
-   * ```
-   */
-  hooksRegistrationOrder?: "mainFirst" | "pluginsFirst";
 }
 type RequestContext = {
   /**
@@ -880,7 +863,13 @@ type ResponseStreamContext = UnmaskType<RequestContext & {
 //#endregion
 //#region src/dedupe.d.ts
 type DedupeStrategyUnion = UnmaskType<"cancel" | "defer" | "none">;
+type DedupeOptionKeys = Exclude<keyof DedupeOptions, "dedupe">;
+type InnerDedupeOptions = { [Key in DedupeOptionKeys as RemovePrefix<"dedupe", Key>]?: DedupeOptions[Key] };
 type DedupeOptions = {
+  /**
+   * All dedupe options in a single object instead of separate properties
+   */
+  dedupe?: InnerDedupeOptions;
   /**
    * Controls the scope of request deduplication caching.
    *
@@ -1089,7 +1078,7 @@ type DedupeOptions = {
 };
 //#endregion
 //#region src/retry.d.ts
-declare const defaultRetryStatusCodesLookup: () => {
+declare const defaultRetryStatusCodesLookup: () => Readonly<{
   408: "Request Timeout";
   409: "Conflict";
   425: "Too Early";
@@ -1098,13 +1087,11 @@ declare const defaultRetryStatusCodesLookup: () => {
   502: "Bad Gateway";
   503: "Service Unavailable";
   504: "Gateway Timeout";
-};
+}>;
 type RetryStatusCodes = UnmaskType<AnyNumber | keyof ReturnType<typeof defaultRetryStatusCodesLookup>>;
 type RetryCondition<TErrorData> = (context: ErrorContext<TErrorData>) => Awaitable<boolean>;
-type InnerRetryKeys<TErrorData> = Exclude<keyof RetryOptions<TErrorData>, "~retryAttemptCount" | "retry">;
-type InnerRetryOptions<TErrorData> = { [Key in InnerRetryKeys<TErrorData> as Key extends `retry${infer TRest}` ? Uncapitalize<TRest> extends "attempts" ? never : Uncapitalize<TRest> : Key]?: RetryOptions<TErrorData>[Key] } & {
-  attempts: NonNullable<RetryOptions<TErrorData>["retryAttempts"]>;
-};
+type RetryOptionKeys<TErrorData> = Exclude<keyof RetryOptions<TErrorData>, "~retryAttemptCount" | "retry">;
+type InnerRetryOptions<TErrorData> = { [Key in RetryOptionKeys<TErrorData> as RemovePrefix<"retry", Key>]?: RetryOptions<TErrorData>[Key] };
 interface RetryOptions<TErrorData> {
   /**
    * Keeps track of the number of times the request has already been retried
@@ -1287,8 +1274,7 @@ type CallApiRequestOptions = Prettify<{
 type CallApiRequestOptionsForHooks = Omit<CallApiRequestOptions, "headers"> & {
   headers: Record<string, string | undefined>;
 };
-type FetchImpl = UnmaskType<(input: string | Request | URL, init?: RequestInit) => Promise<Response>>;
-type SharedExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TThrowOnError extends ThrowOnErrorUnion = DefaultThrowOnError, TResponseType extends ResponseTypeUnion = ResponseTypeUnion, TPluginArray extends CallApiPlugin[] = DefaultPluginArray> = DedupeOptions & HookConfigOptions & HooksOrHooksArray<TData, TErrorData, Partial<InferPluginOptions<TPluginArray>>> & Partial<InferPluginOptions<TPluginArray>> & ResultModeOption<TErrorData, TResultMode> & RetryOptions<TErrorData> & ThrowOnErrorOption<TErrorData, TThrowOnError> & URLOptions & {
+type SharedExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TThrowOnError extends ThrowOnErrorUnion = DefaultThrowOnError, TResponseType extends ResponseTypeUnion = ResponseTypeUnion, TPluginArray extends CallApiPlugin[] = DefaultPluginArray> = DedupeOptions & HookConfigOptions & HooksOrHooksArray<TData, TErrorData, Partial<InferPluginOptions<TPluginArray>>> & Middlewares & Partial<InferPluginOptions<TPluginArray>> & ResultModeOption<TErrorData, TResultMode> & RetryOptions<TErrorData> & ThrowOnErrorOption<TErrorData, TThrowOnError> & URLOptions & {
   /**
    * Automatically add an Authorization header value.
    *
@@ -1808,4 +1794,4 @@ type CallApiParameters<TData = DefaultDataType, TErrorData = DefaultDataType, TR
 type CallApiResult<TData, TErrorData, TResultMode extends ResultModeUnion, TThrowOnError extends ThrowOnErrorUnion, TResponseType extends ResponseTypeUnion> = Promise<GetCallApiResult<TData, TErrorData, TResultMode, TThrowOnError, TResponseType>>;
 //#endregion
 export { AnyFunction, AnyString, ApplyStrictConfig, ApplyURLBasedConfig, BaseCallApiConfig, BaseCallApiExtraOptions, BaseCallApiSchemaAndConfig, BaseCallApiSchemaRoutes, CallApiConfig, CallApiExtraOptions, CallApiExtraOptionsForHooks, CallApiParameters, CallApiPlugin, CallApiRequestOptions, CallApiRequestOptionsForHooks, CallApiResult, CallApiResultErrorVariant, CallApiResultSuccessVariant, CallApiSchema, CallApiSchemaConfig, DedupeOptions, DefaultDataType, DefaultPluginArray, DefaultThrowOnError, ErrorContext, GetCurrentRouteSchema, GetCurrentRouteSchemaKey, GetResponseType, HTTPError, Hooks, HooksOrHooksArray, InferInitURL, InferParamsFromRoute, InferSchemaOutputResult, PluginExtraOptions, PluginHooks, PluginHooksWithMoreOptions, PluginSetupContext, PossibleHTTPError, PossibleJavaScriptError, PossibleJavaScriptOrValidationError, PossibleValidationError, Register, RequestContext, RequestStreamContext, ResponseContext, ResponseErrorContext, ResponseStreamContext, ResponseTypeMap, ResponseTypeUnion, ResultModeUnion, RetryOptions, SuccessContext, ThrowOnErrorUnion, URLOptions, ValidationError, Writeable, fallBackRouteSchemaKey };
-//# sourceMappingURL=common-0nTMuN7U.d.ts.map
+//# sourceMappingURL=common-BMWVqV15.d.ts.map

package/dist/esm/index.d.ts

@@ -1,4 +1,4 @@
-import { AnyFunction, AnyString, ApplyStrictConfig, ApplyURLBasedConfig, BaseCallApiConfig, BaseCallApiExtraOptions, BaseCallApiSchemaAndConfig, BaseCallApiSchemaRoutes, CallApiConfig, CallApiExtraOptions, CallApiExtraOptionsForHooks, CallApiParameters, CallApiPlugin, CallApiRequestOptions, CallApiRequestOptionsForHooks, CallApiResult, CallApiResultErrorVariant, CallApiResultSuccessVariant, CallApiSchema, CallApiSchemaConfig, DedupeOptions, DefaultDataType, DefaultPluginArray, DefaultThrowOnError, ErrorContext, GetCurrentRouteSchema, GetCurrentRouteSchemaKey, GetResponseType, HTTPError, Hooks, HooksOrHooksArray, InferInitURL, InferParamsFromRoute, InferSchemaOutputResult, PluginExtraOptions, PluginHooks, PluginHooksWithMoreOptions, PluginSetupContext, PossibleHTTPError, PossibleJavaScriptError, PossibleJavaScriptOrValidationError, PossibleValidationError, Register, RequestContext, RequestStreamContext, ResponseContext, ResponseErrorContext, ResponseStreamContext, ResponseTypeMap, ResponseTypeUnion, ResultModeUnion, RetryOptions, SuccessContext, ThrowOnErrorUnion, URLOptions, ValidationError, Writeable, fallBackRouteSchemaKey } from "./common-0nTMuN7U.js";
+import { AnyFunction, AnyString, ApplyStrictConfig, ApplyURLBasedConfig, BaseCallApiConfig, BaseCallApiExtraOptions, BaseCallApiSchemaAndConfig, BaseCallApiSchemaRoutes, CallApiConfig, CallApiExtraOptions, CallApiExtraOptionsForHooks, CallApiParameters, CallApiPlugin, CallApiRequestOptions, CallApiRequestOptionsForHooks, CallApiResult, CallApiResultErrorVariant, CallApiResultSuccessVariant, CallApiSchema, CallApiSchemaConfig, DedupeOptions, DefaultDataType, DefaultPluginArray, DefaultThrowOnError, ErrorContext, GetCurrentRouteSchema, GetCurrentRouteSchemaKey, GetResponseType, HTTPError, Hooks, HooksOrHooksArray, InferInitURL, InferParamsFromRoute, InferSchemaOutputResult, PluginExtraOptions, PluginHooks, PluginHooksWithMoreOptions, PluginSetupContext, PossibleHTTPError, PossibleJavaScriptError, PossibleJavaScriptOrValidationError, PossibleValidationError, Register, RequestContext, RequestStreamContext, ResponseContext, ResponseErrorContext, ResponseStreamContext, ResponseTypeMap, ResponseTypeUnion, ResultModeUnion, RetryOptions, SuccessContext, ThrowOnErrorUnion, URLOptions, ValidationError, Writeable, fallBackRouteSchemaKey } from "./common-BMWVqV15.js";
 
 //#region src/createFetchClient.d.ts