@zayne-labs/callapi 1.6.17 → 1.6.18

package/dist/cjs/{error-D4EzEII0.d.cts → error-DH3yCjyX.d.cts}

@@ -102,7 +102,7 @@ interface CallApiSchemas {
      */
     query?: StandardSchemaV1<Query>;
 }
-interface CallApiValidators<TData = never, TErrorData = never> {
+interface CallApiValidators<TData = unknown, TErrorData = unknown> {
     /**
      * Custom function to validate the response data.
      */
@@ -133,7 +133,7 @@ interface UrlOptions<TSchemas extends CallApiSchemas> {
     query?: InferSchemaResult<TSchemas["query"], Query>;
 }
 
-type RetryCondition<TErrorData> = (context: ErrorContext<TErrorData>) => boolean | Promise<boolean>;
+type RetryCondition<TErrorData> = (context: ErrorContext<TErrorData>) => Awaitable<boolean>;
 interface RetryOptions<TErrorData> {
     /**
      * Keeps track of the number of times the request has already been retried
@@ -163,12 +163,12 @@ interface RetryOptions<TErrorData> {
      * HTTP methods that are allowed to retry
      * @default ["GET", "POST"]
      */
-    retryMethods?: Method[];
+    retryMethods?: Method[] | ((context: ErrorContext<TErrorData>) => Method[]);
     /**
      * HTTP status codes that trigger a retry
      * @default [409, 425, 429, 500, 502, 503, 504]
      */
-    retryStatusCodes?: Array<409 | 425 | 429 | 500 | 502 | 503 | 504 | AnyNumber>;
+    retryStatusCodes?: Array<409 | 425 | 429 | 500 | 502 | 503 | 504 | AnyNumber> | ((context: ErrorContext<TErrorData>) => Array<409 | 425 | 429 | 500 | 502 | 503 | 504 | AnyNumber>);
     /**
      * Strategy to use when retrying
      * @default "linear"
@@ -203,6 +203,7 @@ type InferPluginOptions<TPluginArray extends CallApiPlugin[]> = UnionToIntersect
 type PluginInitContext<TMoreOptions = DefaultMoreOptions> = WithMoreOptions<TMoreOptions> & {
     baseConfig: BaseCallApiExtraOptions & CallApiRequestOptions;
     config: CallApiExtraOptions & CallApiRequestOptions;
+    defaultOptions: CallApiExtraOptions;
     initURL: InitURL | undefined;
     options: CombinedCallApiExtraOptions;
     request: CallApiRequestOptionsForHooks;
@@ -244,8 +245,6 @@ declare const definePlugin: <TPlugin extends CallApiPlugin | AnyFunction<CallApi
 type Plugins<TPluginArray extends CallApiPlugin[]> = TPluginArray;
 
 declare const fetchSpecificKeys: ("body" | "cache" | "credentials" | "headers" | "integrity" | "keepalive" | "method" | "mode" | "priority" | "redirect" | "referrer" | "referrerPolicy" | "signal" | "window")[];
-declare const defaultRetryMethods: ("GET" | "POST")[];
-declare const defaultRetryStatusCodes: Required<BaseCallApiExtraOptions>["retryStatusCodes"];
 
 /**
  * @description Makes a type required if TSchema type is undefined or if the output type of TSchema contains undefined, otherwise keeps it as is
@@ -466,6 +465,7 @@ declare const optionsEnumToOmitFromBase: ("dedupeKey" | "extend")[];
 type BaseCallApiExtraOptions<TBaseData = DefaultDataType, TBaseErrorData = DefaultDataType, TBaseResultMode extends ResultModeUnion = ResultModeUnion, TBaseThrowOnError extends boolean = DefaultThrowOnError, TBaseResponseType extends ResponseTypeUnion = ResponseTypeUnion, TBasePluginArray extends CallApiPlugin[] = DefaultPluginArray, TBaseSchemas extends CallApiSchemas = DefaultMoreOptions> = Omit<Partial<CallApiExtraOptions<TBaseData, TBaseErrorData, TBaseResultMode, TBaseThrowOnError, TBaseResponseType, TBasePluginArray, TBaseSchemas>>, (typeof optionsEnumToOmitFromBase)[number]>;
 type CombinedCallApiExtraOptions = BaseCallApiExtraOptions & CallApiExtraOptions;
 type BaseCallApiConfig<TBaseData = DefaultDataType, TBaseErrorData = DefaultDataType, TBaseResultMode extends ResultModeUnion = ResultModeUnion, TBaseThrowOnError extends boolean = DefaultThrowOnError, TBaseResponseType extends ResponseTypeUnion = ResponseTypeUnion, TBasePluginArray extends CallApiPlugin[] = DefaultPluginArray, TBaseSchemas extends CallApiSchemas = DefaultMoreOptions> = (CallApiRequestOptions<TBaseSchemas> & BaseCallApiExtraOptions<TBaseData, TBaseErrorData, TBaseResultMode, TBaseThrowOnError, TBaseResponseType, TBasePluginArray, TBaseSchemas>) | ((context: {
+    defaultOptions: CallApiExtraOptions;
     initURL: string;
     options: CallApiExtraOptions;
     request: CallApiRequestOptions;
@@ -576,4 +576,4 @@ declare class HTTPError<TErrorResponse = Record<string, unknown>> extends Error
     constructor(errorDetails: ErrorDetails<TErrorResponse>, errorOptions?: ErrorOptions);
 }
 
-export { defaultRetryMethods as A, type BaseCallApiConfig as B, type CallApiPlugin as C, type DefaultPluginArray as D, type ErrorContext as E, defaultRetryStatusCodes as F, HTTPError as H, type InferSchemaResult as I, type PluginInitContext as P, type ResultModeUnion as R, type SuccessContext as S, type ResponseTypeUnion as a, type CallApiSchemas as b, type CallApiConfig as c, type CallApiResult as d, type DefaultDataType as e, type DefaultThrowOnError as f, type DefaultMoreOptions as g, type CallApiParameters as h, definePlugin as i, type BaseCallApiExtraOptions as j, type CallApiExtraOptions as k, type PossibleJavaScriptError as l, type PossibleHTTPError as m, type CallApiRequestOptions as n, type CallApiRequestOptionsForHooks as o, type CallApiResultErrorVariant as p, type CallApiResultSuccessVariant as q, type CombinedCallApiExtraOptions as r, type Interceptors as s, type InterceptorsOrInterceptorArray as t, type PossibleJavascriptErrorNames as u, type Register as v, type RequestContext as w, type RequestErrorContext as x, type ResponseContext as y, type ResponseErrorContext as z };
+export { type ResponseErrorContext as A, type BaseCallApiConfig as B, type CallApiPlugin as C, type DefaultPluginArray as D, type ErrorContext as E, HTTPError as H, type InferSchemaResult as I, type PluginInitContext as P, type ResultModeUnion as R, type SuccessContext as S, type ResponseTypeUnion as a, type CallApiSchemas as b, type CallApiConfig as c, type CallApiResult as d, type DefaultDataType as e, type DefaultThrowOnError as f, type DefaultMoreOptions as g, type CallApiParameters as h, definePlugin as i, type RetryOptions as j, type BaseCallApiExtraOptions as k, type CallApiExtraOptions as l, type PossibleJavaScriptError as m, type PossibleHTTPError as n, type CallApiRequestOptions as o, type CallApiRequestOptionsForHooks as p, type CallApiResultErrorVariant as q, type CallApiResultSuccessVariant as r, type CombinedCallApiExtraOptions as s, type Interceptors as t, type InterceptorsOrInterceptorArray as u, type PossibleJavascriptErrorNames as v, type Register as w, type RequestContext as x, type RequestErrorContext as y, type ResponseContext as z };

package/dist/cjs/index.cjs

@@ -205,6 +205,22 @@ var retryStatusCodesLookup = defineEnum({
 });
 var defaultRetryMethods = ["GET", "POST"];
 var defaultRetryStatusCodes = Object.keys(retryStatusCodesLookup).map(Number);
+var defaultExtraOptions = {
+  baseURL: "",
+  bodySerializer: JSON.stringify,
+  dedupeStrategy: "cancel",
+  defaultErrorMessage: "Failed to fetch data from server!",
+  mergedHooksExecutionMode: "parallel",
+  mergedHooksExecutionOrder: "mainHooksAfterPlugins",
+  responseType: "json",
+  resultMode: "all",
+  retryAttempts: 0,
+  retryDelay: 1e3,
+  retryMaxDelay: 1e4,
+  retryMethods: defaultRetryMethods,
+  retryStatusCodes: defaultRetryStatusCodes,
+  retryStrategy: "linear"
+};
 
 // src/utils/common.ts
 var omitKeys = (initialObject, keysToOmit) => {
@@ -375,7 +391,7 @@ var getPluginArray = (plugins) => {
   return plugins;
 };
 var initializePlugins = async (context) => {
-  const { baseConfig, config, initURL, options, request } = context;
+  const { baseConfig, config, defaultOptions, initURL, options, request } = context;
   const hookRegistries = structuredClone(hooksEnum);
   const addMainHooks = () => {
     for (const key of Object.keys(hooksEnum)) {
@@ -404,6 +420,7 @@ var initializePlugins = async (context) => {
     const initResult = await pluginInit({
       baseConfig,
       config,
+      defaultOptions,
       initURL,
       options,
       request
@@ -490,28 +507,30 @@ var getExponentialDelay = (currentAttemptCount, options) => {
   const exponentialDelay = (options.retryDelay ?? 1e3) * 2 ** currentAttemptCount;
   return Math.min(exponentialDelay, maxDelay);
 };
-var createRetryStrategy = (options, ctx) => {
-  const currentRetryCount = options["~retryCount"] ?? 0;
+var createRetryStrategy = (ctx) => {
+  const currentRetryCount = ctx.options["~retryCount"] ?? 0;
   const getDelay = () => {
-    if (options.retryStrategy === "exponential") {
-      return getExponentialDelay(currentRetryCount, options);
+    if (ctx.options.retryStrategy === "exponential") {
+      return getExponentialDelay(currentRetryCount, ctx.options);
     }
-    return getLinearDelay(options);
+    return getLinearDelay(ctx.options);
   };
   const shouldAttemptRetry = async () => {
-    const customRetryCondition = await options.retryCondition?.(ctx) ?? true;
-    const maxRetryAttempts = options.retryAttempts ?? 0;
+    const customRetryCondition = await ctx.options.retryCondition?.(ctx) ?? true;
+    const maxRetryAttempts = ctx.options.retryAttempts ?? 0;
     const baseRetryCondition = maxRetryAttempts > currentRetryCount && customRetryCondition;
     if (ctx.error.name !== "HTTPError") {
       return baseRetryCondition;
     }
+    const resolvedRetryMethods = isFunction(ctx.options.retryMethods) ? ctx.options.retryMethods(ctx) : ctx.options.retryMethods;
+    const resolvedRetryStatusCodes = isFunction(ctx.options.retryStatusCodes) ? ctx.options.retryStatusCodes(ctx) : ctx.options.retryStatusCodes;
     const includesMethod = (
       // eslint-disable-next-line no-implicit-coercion -- Boolean doesn't narrow
-      !!ctx.request.method && options.retryMethods?.includes(ctx.request.method)
+      !!ctx.request.method && resolvedRetryMethods?.includes(ctx.request.method)
     );
     const includesCodes = (
       // eslint-disable-next-line no-implicit-coercion -- Boolean doesn't narrow
-      !!ctx.response?.status && options.retryStatusCodes?.includes(ctx.response.status)
+      !!ctx.response?.status && resolvedRetryStatusCodes?.includes(ctx.response.status)
     );
     return includesCodes && includesMethod && baseRetryCondition;
   };
@@ -595,7 +614,12 @@ var createFetchClient = (baseConfig = {}) => {
   const callApi2 = async (...parameters) => {
     const [initURL, config = {}] = parameters;
     const [fetchOptions, extraOptions] = splitConfig(config);
-    const resolvedBaseConfig = isFunction(baseConfig) ? baseConfig({ initURL: initURL.toString(), options: extraOptions, request: fetchOptions }) : baseConfig;
+    const resolvedBaseConfig = isFunction(baseConfig) ? baseConfig({
+      defaultOptions: defaultExtraOptions,
+      initURL: initURL.toString(),
+      options: extraOptions,
+      request: fetchOptions
+    }) : baseConfig;
     const [baseFetchOptions, baseExtraOptions] = splitBaseConfig(resolvedBaseConfig);
     const initCombinedHooks = {};
     for (const key of Object.keys(hooksEnum)) {
@@ -605,35 +629,22 @@ var createFetchClient = (baseConfig = {}) => {
       );
       initCombinedHooks[key] = combinedHook;
     }
-    const defaultExtraOptions = {
-      baseURL: "",
-      bodySerializer: JSON.stringify,
-      dedupeStrategy: "cancel",
-      defaultErrorMessage: "Failed to fetch data from server!",
-      mergedHooksExecutionMode: "parallel",
-      mergedHooksExecutionOrder: "mainHooksAfterPlugins",
-      responseType: "json",
-      resultMode: "all",
-      retryAttempts: 0,
-      retryDelay: 1e3,
-      retryMaxDelay: 1e4,
-      retryMethods: defaultRetryMethods,
-      retryStatusCodes: defaultRetryStatusCodes,
-      retryStrategy: "linear",
+    const mergedExtraOptions = {
+      ...defaultExtraOptions,
       ...baseExtraOptions,
-      ...extraOptions,
-      ...initCombinedHooks
+      ...extraOptions
     };
-    const defaultRequestOptions = {
+    const mergedRequestOptions = {
       ...baseFetchOptions,
       ...fetchOptions
     };
     const { resolvedHooks, resolvedOptions, resolvedRequestOptions, url } = await initializePlugins({
       baseConfig: resolvedBaseConfig,
       config,
+      defaultOptions: defaultExtraOptions,
       initURL,
-      options: defaultExtraOptions,
-      request: defaultRequestOptions
+      options: mergedExtraOptions,
+      request: mergedRequestOptions
     });
     const fullURL = `${resolvedOptions.baseURL}${mergeUrlWithParamsAndQuery(url, resolvedOptions.params, resolvedOptions.query)}`;
     const options = {
@@ -694,11 +705,7 @@ var createFetchClient = (baseConfig = {}) => {
         options.responseType,
         options.responseParser
       );
-      const validSuccessData = await handleValidation(
-        successData,
-        schemas?.data,
-        validators?.data
-      );
+      const validSuccessData = await handleValidation(successData, schemas?.data, validators?.data);
       const successContext = {
         data: validSuccessData,
         options,
@@ -727,9 +734,11 @@ var createFetchClient = (baseConfig = {}) => {
         request,
         response: apiDetails.response
       };
-      const { getDelay, shouldAttemptRetry } = createRetryStrategy(options, errorContext);
-      const shouldRetry = !combinedSignal.aborted && await shouldAttemptRetry();
-      if (shouldRetry) {
+      const shouldThrowOnError = isFunction(options.throwOnError) ? options.throwOnError(errorContext) : options.throwOnError;
+      const handleRetry = async () => {
+        const { getDelay, shouldAttemptRetry } = createRetryStrategy(errorContext);
+        const shouldRetry = !combinedSignal.aborted && await shouldAttemptRetry();
+        if (!shouldRetry) return;
         await executeHooks(options.onRetry(errorContext));
         const delay = getDelay();
         await waitUntil(delay);
@@ -737,9 +746,8 @@ var createFetchClient = (baseConfig = {}) => {
           ...config,
           "~retryCount": (options["~retryCount"] ?? 0) + 1
         };
-        return await callApi2(initURL, updatedOptions);
-      }
-      const shouldThrowOnError = isFunction(options.throwOnError) ? options.throwOnError(errorContext) : options.throwOnError;
+        return callApi2(initURL, updatedOptions);
+      };
       const handleThrowOnError = () => {
         if (!shouldThrowOnError) return;
         throw apiDetails.error;
@@ -750,18 +758,21 @@ var createFetchClient = (baseConfig = {}) => {
           options.onError(errorContext),
           options.onResponse({ ...errorContext, data: null })
         );
+        await handleRetry();
         handleThrowOnError();
         return getErrorResult();
       }
       if (error instanceof DOMException && error.name === "AbortError") {
         const { message, name } = error;
         console.error(`${name}:`, message);
+        await handleRetry();
         handleThrowOnError();
         return getErrorResult();
       }
       if (error instanceof DOMException && error.name === "TimeoutError") {
         const message = `Request timed out after ${options.timeout}ms`;
         console.error(`${error.name}:`, message);
+        await handleRetry();
         handleThrowOnError();
         return getErrorResult({ message });
       }
@@ -771,6 +782,7 @@ var createFetchClient = (baseConfig = {}) => {
         // == Also call the onError interceptor
         options.onError(errorContext)
       );
+      await handleRetry();
       handleThrowOnError();
       return getErrorResult();
     } finally {