@zayne-labs/callapi 1.3.6 → 1.4.0

package/dist/esm/{plugins-DXl13OeA.d.ts → types-CNYLI9wS.d.ts}

@@ -1,17 +1,4 @@
-type AnyString = string & {
-    z_placeholder?: never;
-};
-type AnyNumber = number & {
-    z_placeholder?: never;
-};
-type AnyFunction<TResult = any> = (...args: any[]) => TResult;
-type UnmaskType<TValue> = {
-    _: TValue;
-}["_"];
-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}`;
-type CommonContentTypes = "application/epub+zip" | "application/gzip" | "application/json" | "application/ld+json" | "application/octet-stream" | "application/ogg" | "application/pdf" | "application/rtf" | "application/vnd.ms-fontobject" | "application/wasm" | "application/xhtml+xml" | "application/xml" | "application/zip" | "audio/aac" | "audio/mpeg" | "audio/ogg" | "audio/opus" | "audio/webm" | "audio/x-midi" | "font/otf" | "font/ttf" | "font/woff" | "font/woff2" | "image/avif" | "image/bmp" | "image/gif" | "image/jpeg" | "image/png" | "image/svg+xml" | "image/tiff" | "image/webp" | "image/x-icon" | "model/gltf-binary" | "model/gltf+json" | "text/calendar" | "text/css" | "text/csv" | "text/html" | "text/javascript" | "text/plain" | "video/3gpp" | "video/3gpp2" | "video/av1" | "video/mp2t" | "video/mp4" | "video/mpeg" | "video/ogg" | "video/webm" | "video/x-msvideo" | AnyString;
+import { StandardSchemaV1 } from '@standard-schema/spec';
 
 type ValueOrFunctionResult<TValue> = TValue | (() => TValue);
 /**
@@ -62,29 +49,44 @@ type CustomAuth = {
 };
 type Auth = BearerOrTokenAuth | BasicAuth | CustomAuth;
 
+type AnyString = string & {
+    z_placeholder?: never;
+};
+type AnyNumber = number & {
+    z_placeholder?: never;
+};
+type AnyFunction<TResult = any> = (...args: any[]) => TResult;
+type UnmaskType<TValue> = {
+    _: TValue;
+}["_"];
+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}`;
+type CommonContentTypes = "application/epub+zip" | "application/gzip" | "application/json" | "application/ld+json" | "application/octet-stream" | "application/ogg" | "application/pdf" | "application/rtf" | "application/vnd.ms-fontobject" | "application/wasm" | "application/xhtml+xml" | "application/xml" | "application/zip" | "audio/aac" | "audio/mpeg" | "audio/ogg" | "audio/opus" | "audio/webm" | "audio/x-midi" | "font/otf" | "font/ttf" | "font/woff" | "font/woff2" | "image/avif" | "image/bmp" | "image/gif" | "image/jpeg" | "image/png" | "image/svg+xml" | "image/tiff" | "image/webp" | "image/x-icon" | "model/gltf-binary" | "model/gltf+json" | "text/calendar" | "text/css" | "text/csv" | "text/html" | "text/javascript" | "text/plain" | "video/3gpp" | "video/3gpp2" | "video/av1" | "video/mp2t" | "video/mp4" | "video/mpeg" | "video/ogg" | "video/webm" | "video/x-msvideo" | AnyString;
+
 type RetryCondition<TErrorData> = (context: ErrorContext<TErrorData>) => boolean | Promise<boolean>;
 interface RetryOptions<TErrorData> {
     /**
-     * @description Keeps track of the number of times the request has already been retried
+     * Keeps track of the number of times the request has already been retried
      * @deprecated This property is used internally to track retries. Please abstain from modifying it.
      */
     readonly "~retryCount"?: number;
     /**
-     * @description Number of allowed retry attempts on HTTP errors
+     * Number of allowed retry attempts on HTTP errors
      * @default 0
      */
     retryAttempts?: number;
     /**
-     * @description Callback whose return value determines if a request should be retried or not
+     * Callback whose return value determines if a request should be retried or not
      */
     retryCondition?: RetryCondition<TErrorData>;
     /**
-     * @description Delay between retries in milliseconds
+     * Delay between retries in milliseconds
      * @default 1000
      */
     retryDelay?: number;
     /**
-     * @description Maximum delay in milliseconds. Only applies to exponential strategy
+     * Maximum delay in milliseconds. Only applies to exponential strategy
      * @default 10000
      */
     retryMaxDelay?: number;
@@ -94,17 +96,96 @@ interface RetryOptions<TErrorData> {
      */
     retryMethods?: Array<"GET" | "POST" | AnyString>;
     /**
-     * @description HTTP status codes that trigger a retry
+     * 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>;
     /**
-     * @description Strategy to use when retrying
+     * Strategy to use when retrying
      * @default "linear"
      */
     retryStrategy?: "exponential" | "linear";
 }
 
+interface Schemas {
+    /**
+     *  The schema to use for validating the response data.
+     */
+    data?: StandardSchemaV1;
+    /**
+     *  The schema to use for validating the response error data.
+     */
+    errorData?: StandardSchemaV1;
+}
+interface Validators<TData = unknown, TErrorData = unknown> {
+    /**
+     * Custom function to validate the response data.
+     */
+    data?: (data: unknown) => TData;
+    /**
+     * Custom function to validate the response error data, stemming from the api.
+     * This only runs if the api actually sends back error status codes, else it will be ignored, in which case you should only use the `responseValidator` option.
+     */
+    errorData?: (data: unknown) => TErrorData;
+}
+type InferSchemaResult<TSchema extends StandardSchemaV1 | undefined, TData> = TSchema extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<TSchema> : TData;
+
+type ToQueryStringFn = {
+    (params: CallApiConfig["query"]): string | null;
+    (params: Required<CallApiConfig>["query"]): string;
+};
+declare const toQueryString: ToQueryStringFn;
+declare const getResponseType: <TResponse>(response: Response, parser?: Required<CallApiExtraOptions>["responseParser"]) => {
+    arrayBuffer: () => Promise<TResponse>;
+    blob: () => Promise<TResponse>;
+    formData: () => Promise<TResponse>;
+    json: () => Promise<Record<string, unknown> | TResponse>;
+    stream: () => ReadableStream<Uint8Array<ArrayBufferLike>> | null;
+    text: () => Promise<TResponse>;
+};
+
+type UnionToIntersection<TUnion> = (TUnion extends unknown ? (param: TUnion) => void : never) extends (param: infer TParam) => void ? TParam : never;
+type InferPluginOptions<TPluginArray extends CallApiPlugin[]> = TPluginArray extends Array<infer TPlugin extends CallApiPlugin> ? TPlugin["createExtraOptions"] extends (...params: never[]) => infer TResult ? UnionToIntersection<TResult> : NonNullable<unknown> : NonNullable<unknown>;
+type PluginInitContext<TMoreOptions = DefaultMoreOptions> = WithMoreOptions<TMoreOptions> & {
+    initURL: string;
+    options: CombinedCallApiExtraOptions;
+    request: CallApiRequestOptionsForHooks;
+};
+type PluginInitResult = Partial<Omit<PluginInitContext, "request"> & {
+    request: CallApiRequestOptions;
+}>;
+type CallApiPlugin = {
+    /**
+     * Defines additional options that can be passed to callApi
+     */
+    createExtraOptions?: (...params: never[]) => unknown;
+    /**
+     * A description for the plugin
+     */
+    description?: string;
+    /**
+     * Hooks / Interceptors for the plugin
+     */
+    hooks?: InterceptorsOrInterceptorArray;
+    /**
+     *  A unique id for the plugin
+     */
+    id: string;
+    /**
+     * A function that will be called when the plugin is initialized. This will be called before the any of the other internal functions.
+     */
+    init?: (context: PluginInitContext) => Awaitable<PluginInitResult> | Awaitable<void>;
+    /**
+     * A name for the plugin
+     */
+    name: string;
+    /**
+     *  A version for the plugin
+     */
+    version?: string;
+};
+declare const definePlugin: <TPlugin extends CallApiPlugin | AnyFunction<CallApiPlugin> = CallApiPlugin>(plugin: TPlugin) => TPlugin;
+
 declare const fetchSpecificKeys: ("headers" | "body" | "cache" | "credentials" | "integrity" | "keepalive" | "method" | "mode" | "priority" | "redirect" | "referrer" | "referrerPolicy" | "signal" | "window")[];
 declare const defaultRetryMethods: ("GET" | "POST")[];
 declare const defaultRetryStatusCodes: Required<BaseCallApiConfig>["retryStatusCodes"];
@@ -112,18 +193,18 @@ declare const defaultRetryStatusCodes: Required<BaseCallApiConfig>["retryStatusC
 type FetchSpecificKeysUnion = Exclude<(typeof fetchSpecificKeys)[number], "body" | "headers" | "method">;
 interface CallApiRequestOptions extends Pick<RequestInit, FetchSpecificKeysUnion> {
     /**
-     * @description Optional body of the request, can be a object or any other supported body type.
+     * Optional body of the request, can be a object or any other supported body type.
      */
     body?: Record<string, unknown> | RequestInit["body"];
     /**
-     * @description Headers to be used in the request.
+     * Headers to be used in the request.
      */
     headers?: Record<"Authorization", CommonAuthorizationHeaders> | Record<"Content-Type", CommonContentTypes> | Record<CommonRequestHeaders, string | undefined> | Record<string, string | undefined> | RequestInit["headers"];
     /**
-     * @description HTTP method for the request.
+     * HTTP method for the request.
      * @default "GET"
      */
-    method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT" | AnyString;
+    method?: "CONNECT" | "DELETE" | "GET" | "HEAD" | "OPTIONS" | "PATCH" | "POST" | "PUT" | "TRACE" | AnyString;
 }
 interface CallApiRequestOptionsForHooks extends Omit<CallApiRequestOptions, "headers"> {
     headers?: Record<string, string | undefined>;
@@ -137,32 +218,32 @@ type WithMoreOptions<TMoreOptions = DefaultMoreOptions> = {
 };
 interface Interceptors<TData = DefaultDataType, TErrorData = DefaultDataType, TMoreOptions = DefaultMoreOptions> {
     /**
-     * @description Interceptor that will be called when any error occurs within the request/response lifecycle, regardless of whether the error is from the api or not.
+     * Interceptor that will be called when any error occurs within the request/response lifecycle, regardless of whether the error is from the api or not.
      * It is basically a combination of `onRequestError` and `onResponseError` interceptors
      */
     onError?: (context: ErrorContext<TErrorData> & WithMoreOptions<TMoreOptions>) => Awaitable<unknown>;
     /**
-     * @description Interceptor that will be called just before the request is made, allowing for modifications or additional operations.
+     * Interceptor that will be called just before the request is made, allowing for modifications or additional operations.
      */
     onRequest?: (context: RequestContext & WithMoreOptions<TMoreOptions>) => Awaitable<unknown>;
     /**
-     *  @description Interceptor that will be called when an error occurs during the fetch request.
+     *  Interceptor that will be called when an error occurs during the fetch request.
      */
     onRequestError?: (context: RequestErrorContext & WithMoreOptions<TMoreOptions>) => Awaitable<unknown>;
     /**
-     * @description Interceptor that will be called when any response is received from the api, whether successful or not
+     * Interceptor that will be called when any response is received from the api, whether successful or not
      */
     onResponse?: (context: ResponseContext<TData, TErrorData> & WithMoreOptions<TMoreOptions>) => Awaitable<unknown>;
     /**
-     *  @description Interceptor that will be called when an error response is received from the api.
+     *  Interceptor that will be called when an error response is received from the api.
      */
     onResponseError?: (context: ResponseErrorContext<TErrorData> & WithMoreOptions<TMoreOptions>) => Awaitable<unknown>;
     /**
-     * @description Interceptor that will be called when a request is retried.
+     * Interceptor that will be called when a request is retried.
      */
     onRetry?: (response: ErrorContext<TErrorData> & WithMoreOptions<TMoreOptions>) => Awaitable<unknown>;
     /**
-     * @description Interceptor that will be called when a successful response is received from the api.
+     * Interceptor that will be called when a successful response is received from the api.
      */
     onSuccess?: (context: SuccessContext<TData> & WithMoreOptions<TMoreOptions>) => Awaitable<unknown>;
 }
@@ -173,36 +254,36 @@ type FetchImpl = UnmaskType<(input: string | Request | URL, init?: RequestInit)
 type Meta = Register extends {
     meta?: infer TMeta extends Record<string, unknown>;
 } ? TMeta : never;
-type ExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TPluginArray extends CallApiPlugin[] = CallApiPlugin[]> = InterceptorsOrInterceptorArray<TData, TErrorData> & Partial<InferPluginOptions<TPluginArray>> & RetryOptions<TErrorData> & {
+type ExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TPluginArray extends CallApiPlugin[] = never[], TSchemas extends Schemas = DefaultMoreOptions> = {
     /**
-     * @description Authorization header value.
+     * Authorization header value.
      */
     auth?: string | Auth | null;
     /**
-     * @description Base URL to be prepended to all request URLs
+     * Base URL to be prepended to all request URLs
      */
     baseURL?: string;
     /**
-     * @description Custom function to serialize the body object into a string.
+     * Custom function to serialize the body object into a string.
      */
     bodySerializer?: (bodyData: Record<string, unknown>) => string;
     /**
-     * @description Whether or not to clone the response, so response.json() and the like, can be read again else where.
+     * Whether or not to clone the response, so response.json() and the like, can be read again else where.
      * @see https://developer.mozilla.org/en-US/docs/Web/API/Response/clone
      * @default false
      */
     cloneResponse?: boolean;
     /**
-     * @description Custom fetch implementation
+     * Custom fetch implementation
      */
     customFetchImpl?: FetchImpl;
     /**
-     * @description Custom request key to be used to identify a request in the fetch deduplication strategy.
+     * Custom request key to be used to identify a request in the fetch deduplication strategy.
      * @default the full request url + string formed from the request options
      */
     dedupeKey?: string;
     /**
-     * @description Defines the deduplication strategy for the request, can be set to "none" | "defer" | "cancel".
+     * Defines the deduplication strategy for the request, can be set to "none" | "defer" | "cancel".
      * - If set to "cancel", the previous pending request with the same request key will be cancelled and lets the new request through.
      * - If set to "defer", all new request with the same request key will be share the same response, until the previous one is completed.
      * - If set to "none", deduplication is disabled.
@@ -210,32 +291,32 @@ type ExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResult
      */
     dedupeStrategy?: "cancel" | "defer" | "none";
     /**
-     * @description Default error message to use if none is provided from a response.
+     * Default error message to use if none is provided from a response.
      * @default "Failed to fetch data from server!"
      */
     defaultErrorMessage?: string;
     /**
-     * @description Resolved request URL
+     * Resolved request URL
      */
     readonly fullURL?: string;
     /**
-     * @description URL to be used in the request.
+     * URL to be used in the request.
      */
     readonly initURL?: string;
     /**
-     * @description Defines the mode in which the merged hooks are executed, can be set to "parallel" | "sequential".
+     * Defines the mode in which the merged hooks are executed, can be set to "parallel" | "sequential".
      * - If set to "parallel", main and plugin hooks will be executed in parallel.
      * - If set to "sequential", the plugin hooks will be executed first, followed by the main hook.
      * @default "parallel"
      */
     mergedHooksExecutionMode?: "parallel" | "sequential";
     /**
-     * @description - Controls what order in which the merged hooks execute
+     * - Controls what order in which the merged hooks execute
      * @default "mainHooksLast"
      */
     mergedHooksExecutionOrder?: "mainHooksAfterPlugins" | "mainHooksBeforePlugins";
     /**
-     * @description - An optional field you can fill with additional information,
+     * - An optional field you can fill with additional information,
      * to associate with the request, typically used for logging or tracing.
      *
      * - A good use case for this, would be to use the info to handle specific cases in any of the shared interceptors.
@@ -259,41 +340,33 @@ type ExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResult
      */
     meta?: Meta;
     /**
-     * @description Params to be appended to the URL (i.e: /:id)
+     * Params to be appended to the URL (i.e: /:id)
      */
     params?: Record<string, boolean | number | string> | Array<boolean | number | string>;
     /**
-     * @description An array of CallApi plugins. It allows you to extend the behavior of the library.
+     * An array of CallApi plugins. It allows you to extend the behavior of the library.
      */
     plugins?: TPluginArray | ((context: PluginInitContext) => TPluginArray);
     /**
-     * @description Query parameters to append to the URL.
+     * Query parameters to append to the URL.
      */
     query?: Record<string, boolean | number | string>;
     /**
-     * @description Custom function to validate the response error data, stemming from the api.
-     * This only runs if the api actually sends back error status codes, else it will be ignored, in which case you should only use the `responseValidator` option.
-     */
-    responseErrorValidator?: (data: unknown) => TErrorData;
-    /**
-     * @description Custom function to parse the response string into a object.
+     * Custom function to parse the response string into a object.
      */
     responseParser?: (responseString: string) => Awaitable<Record<string, unknown>>;
     /**
-     * @description Expected response type, affects how response is parsed
+     * Expected response type, affects how response is parsed
      * @default "json"
      */
     responseType?: keyof ReturnType<typeof getResponseType>;
     /**
-     * @description Custom function to validate the response data.
-     */
-    responseValidator?: (data: unknown) => TData;
-    /**
-     * @description Mode of the result, can influence how results are handled or returned.
+     * Mode of the result, can influence how results are handled or returned.
      * Can be set to "all" | "onlySuccess" | "onlyError" | "onlyResponse".
      * @default "all"
      */
     resultMode?: TErrorData extends false ? "onlySuccessWithException" : TResultMode | undefined;
+    schemas?: TSchemas;
     /**
      * If true or the function returns true, throws errors instead of returning them
      * The function is passed the error object and can be used to conditionally throw the error
@@ -301,23 +374,24 @@ type ExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResult
      */
     throwOnError?: boolean | ((context: ErrorContext<TErrorData>) => boolean);
     /**
-     * @description Request timeout in milliseconds
+     * Request timeout in milliseconds
      */
     timeout?: number;
-};
-declare const optionsEnumToExtendFromBase: "plugins"[];
-type CallApiExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TPluginArray extends CallApiPlugin[] = CallApiPlugin[]> = ExtraOptions<TData, TErrorData, TResultMode, TPluginArray> & {
+    validators?: Validators<TData, TErrorData>;
+} & InterceptorsOrInterceptorArray<TData, TErrorData> & Partial<InferPluginOptions<TPluginArray>> & RetryOptions<TErrorData>;
+declare const optionsEnumToExtendFromBase: ("plugins" | "schemas" | "validators")[];
+type CallApiExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TPluginArray extends CallApiPlugin[] = never[], TSchemas extends Schemas = DefaultMoreOptions> = ExtraOptions<TData, TErrorData, TResultMode, TPluginArray, TSchemas> & {
     /**
-     * @description Options that should extend the base options.
+     * Options that should extend the base options.
      */
-    extend?: Pick<ExtraOptions<TData, TErrorData, TResultMode, TPluginArray>, (typeof optionsEnumToExtendFromBase)[number]>;
+    extend?: Pick<ExtraOptions<TData, TErrorData, TResultMode, TPluginArray, TSchemas>, (typeof optionsEnumToExtendFromBase)[number]>;
 };
 declare const optionsEnumToOmitFromBase: ("dedupeKey" | "extend")[];
-type BaseCallApiExtraOptions<TBaseData = DefaultDataType, TBaseErrorData = DefaultDataType, TBaseResultMode extends ResultModeUnion = ResultModeUnion, TBasePluginArray extends CallApiPlugin[] = CallApiPlugin[]> = Omit<CallApiExtraOptions<TBaseData, TBaseErrorData, TBaseResultMode, TBasePluginArray>, (typeof optionsEnumToOmitFromBase)[number]>;
-type CombinedCallApiExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TPluginArray extends CallApiPlugin[] = CallApiPlugin[]> = BaseCallApiExtraOptions<TData, TErrorData, TResultMode, TPluginArray> & CallApiExtraOptions<TData, TErrorData, TResultMode, TPluginArray>;
-type CallApiConfig<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TPluginArray extends CallApiPlugin[] = CallApiPlugin[]> = CallApiExtraOptions<TData, TErrorData, TResultMode, TPluginArray> & CallApiRequestOptions;
-type BaseCallApiConfig<TBaseData = DefaultDataType, TBaseErrorData = DefaultDataType, TBaseResultMode extends ResultModeUnion = ResultModeUnion, TBasePluginArray extends CallApiPlugin[] = CallApiPlugin[]> = BaseCallApiExtraOptions<TBaseData, TBaseErrorData, TBaseResultMode, TBasePluginArray> & CallApiRequestOptions;
-type CallApiParameters<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TPluginArray extends CallApiPlugin[] = CallApiPlugin[]> = [initURL: string, config?: CallApiConfig<TData, TErrorData, TResultMode, TPluginArray>];
+type BaseCallApiExtraOptions<TBaseData = DefaultDataType, TBaseErrorData = DefaultDataType, TBaseResultMode extends ResultModeUnion = ResultModeUnion, TBasePluginArray extends CallApiPlugin[] = never[], TBaseSchemas extends Schemas = DefaultMoreOptions> = Omit<CallApiExtraOptions<TBaseData, TBaseErrorData, TBaseResultMode, TBasePluginArray, TBaseSchemas>, (typeof optionsEnumToOmitFromBase)[number]>;
+type CombinedCallApiExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TPluginArray extends CallApiPlugin[] = never[], TSchemas extends Schemas = DefaultMoreOptions> = BaseCallApiExtraOptions<TData, TErrorData, TResultMode, TPluginArray, TSchemas> & CallApiExtraOptions<TData, TErrorData, TResultMode, TPluginArray, TSchemas>;
+type CallApiConfig<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TPluginArray extends CallApiPlugin[] = never[], TSchemas extends Schemas = DefaultMoreOptions> = CallApiRequestOptions & CallApiExtraOptions<TData, TErrorData, TResultMode, TPluginArray, TSchemas>;
+type BaseCallApiConfig<TBaseData = DefaultDataType, TBaseErrorData = DefaultDataType, TBaseResultMode extends ResultModeUnion = ResultModeUnion, TBasePluginArray extends CallApiPlugin[] = never[], TBaseSchemas extends Schemas = DefaultMoreOptions> = CallApiRequestOptions & BaseCallApiExtraOptions<TBaseData, TBaseErrorData, TBaseResultMode, TBasePluginArray, TBaseSchemas>;
+type CallApiParameters<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TPluginArray extends CallApiPlugin[] = never[], TSchemas extends Schemas = DefaultMoreOptions> = [initURL: string, config?: CallApiConfig<TData, TErrorData, TResultMode, TPluginArray, TSchemas>];
 type RequestContext = UnmaskType<{
     options: CombinedCallApiExtraOptions;
     request: CallApiRequestOptionsForHooks;
@@ -341,7 +415,7 @@ type SuccessContext<TData> = UnmaskType<{
     request: CallApiRequestOptionsForHooks;
     response: Response;
 }>;
-type PossibleJavascriptErrorNames = "AbortError" | "Error" | "SyntaxError" | "TimeoutError" | "TypeError" | (`${string}Error` & {});
+type PossibleJavascriptErrorNames = "AbortError" | "Error" | "SyntaxError" | "TimeoutError" | "TypeError" | (`${string}Error` & DefaultMoreOptions);
 type PossibleJavaScriptError = UnmaskType<{
     errorData: DOMException | Error | SyntaxError | TypeError;
     message: string;
@@ -400,62 +474,4 @@ type ResultModeUnion = {
 }[keyof ResultModeMap] | undefined;
 type GetCallApiResult<TData, TErrorData, TResultMode> = TErrorData extends false ? ResultModeMap<TData, TErrorData>["onlySuccessWithException"] : undefined extends TResultMode ? ResultModeMap<TData, TErrorData>["all"] : TResultMode extends NonNullable<ResultModeUnion> ? ResultModeMap<TData, TErrorData>[TResultMode] : never;
 
-type ToQueryStringFn = {
-    (params: CallApiConfig["query"]): string | null;
-    (params: Required<CallApiConfig>["query"]): string;
-};
-declare const toQueryString: ToQueryStringFn;
-declare const getResponseType: <TResponse>(response: Response, parser?: Required<CallApiExtraOptions>["responseParser"]) => {
-    arrayBuffer: () => Promise<TResponse>;
-    blob: () => Promise<TResponse>;
-    formData: () => Promise<TResponse>;
-    json: () => Promise<Record<string, unknown> | TResponse>;
-    stream: () => ReadableStream<Uint8Array<ArrayBufferLike>> | null;
-    text: () => Promise<TResponse>;
-};
-
-type UnionToIntersection<TUnion> = (TUnion extends unknown ? (param: TUnion) => void : never) extends (param: infer TParam) => void ? TParam : never;
-type InferPluginOptions<TPluginArray extends CallApiPlugin[]> = TPluginArray extends Array<infer TPlugin extends CallApiPlugin> ? TPlugin["createExtraOptions"] extends (...params: never[]) => infer TResult ? UnionToIntersection<TResult> : NonNullable<unknown> : NonNullable<unknown>;
-type PluginInitContext<TMoreOptions = DefaultMoreOptions> = WithMoreOptions<TMoreOptions> & {
-    initURL: string;
-    options: CombinedCallApiExtraOptions;
-    request: CallApiRequestOptionsForHooks;
-};
-type PluginInitResult = Partial<Omit<PluginInitContext, "request"> & {
-    request: CallApiRequestOptions;
-}>;
-type CallApiPlugin = {
-    /**
-     * @description Defines additional options that can be passed to callApi
-     */
-    createExtraOptions?: (...params: never[]) => unknown;
-    /**
-     *  @description A description for the plugin
-     */
-    description?: string;
-    /**
-     * Hooks / Interceptors for the plugin
-     */
-    hooks?: InterceptorsOrInterceptorArray;
-    /**
-     * @description A unique id for the plugin
-     */
-    id: string;
-    /**
-     * @description A function that will be called when the plugin is
-     * initialized. This will be called before the any
-     * of the other internal functions.
-     */
-    init?: (context: PluginInitContext) => Awaitable<PluginInitResult> | Awaitable<void>;
-    /**
-     * @description A name for the plugin
-     */
-    name: string;
-    /**
-     * @description A version for the plugin
-     */
-    version?: string;
-};
-declare const definePlugin: <TPlugin extends CallApiPlugin | AnyFunction<CallApiPlugin> = CallApiPlugin>(plugin: TPlugin) => TPlugin;
-
-export { type BaseCallApiConfig as B, type CallApiPlugin as C, type DefaultDataType as D, type ErrorContext as E, type GetCallApiResult as G, type Interceptors as I, type PluginInitContext as P, type ResultModeUnion as R, type SuccessContext as S, type CallApiConfig as a, type BaseCallApiExtraOptions as b, type CallApiExtraOptions as c, definePlugin as d, type PossibleJavaScriptError as e, type PossibleHTTPError as f, type CallApiParameters as g, type CallApiRequestOptions as h, type CallApiRequestOptionsForHooks as i, type CallApiResultErrorVariant as j, type CallApiResultSuccessVariant as k, type CombinedCallApiExtraOptions as l, type InterceptorsOrInterceptorArray as m, type PossibleJavascriptErrorNames as n, type Register as o, type RequestContext as p, type RequestErrorContext as q, type ResponseContext as r, type ResponseErrorContext as s, toQueryString as t, defaultRetryMethods as u, defaultRetryStatusCodes as v };
+export { type BaseCallApiConfig as B, type CallApiPlugin as C, type DefaultDataType as D, type ErrorContext as E, type GetCallApiResult as G, type InferSchemaResult as I, type PluginInitContext as P, type ResultModeUnion as R, type Schemas as S, type CallApiConfig as a, type BaseCallApiExtraOptions as b, type CallApiExtraOptions as c, definePlugin as d, type PossibleJavaScriptError as e, type PossibleHTTPError as f, type CallApiParameters as g, type CallApiRequestOptions as h, type CallApiRequestOptionsForHooks as i, type CallApiResultErrorVariant as j, type CallApiResultSuccessVariant as k, type CombinedCallApiExtraOptions as l, type Interceptors as m, type InterceptorsOrInterceptorArray as n, type PossibleJavascriptErrorNames as o, type Register as p, type RequestContext as q, type RequestErrorContext as r, type ResponseContext as s, type ResponseErrorContext as t, type SuccessContext as u, toQueryString as v, defaultRetryMethods as w, defaultRetryStatusCodes as x };

package/dist/esm/utils/index.d.ts

@@ -1,6 +1,7 @@
-import { f as PossibleHTTPError, e as PossibleJavaScriptError } from '../plugins-DXl13OeA.js';
-export { u as defaultRetryMethods, v as defaultRetryStatusCodes, t as toQueryString } from '../plugins-DXl13OeA.js';
+import { f as PossibleHTTPError, e as PossibleJavaScriptError } from '../types-CNYLI9wS.js';
+export { w as defaultRetryMethods, x as defaultRetryStatusCodes, v as toQueryString } from '../types-CNYLI9wS.js';
 import { H as HTTPError } from '../error-lBRMiMeF.js';
+import '@standard-schema/spec';
 
 type ErrorObjectUnion<TErrorData = unknown> = PossibleHTTPError<TErrorData> | PossibleJavaScriptError;
 declare const isHTTPError: <TErrorData>(error: ErrorObjectUnion<TErrorData> | null) => error is PossibleHTTPError<TErrorData>;

package/dist/esm/utils/index.js

@@ -1 +1 @@
-export{defaultRetryMethods,defaultRetryStatusCodes,isHTTPError,isHTTPErrorInstance,toQueryString}from"../chunk-5YQFYNEZ.js";//# sourceMappingURL=index.js.map
+export{defaultRetryMethods,defaultRetryStatusCodes,isHTTPError,isHTTPErrorInstance,toQueryString}from"../chunk-KABMV5OF.js";//# sourceMappingURL=index.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zayne-labs/callapi",
   "type": "module",
-  "version": "1.3.6",
+  "version": "1.4.0",
   "description": "A lightweight wrapper over fetch with quality of life improvements like built-in request cancellation, retries, interceptors and more",
   "author": "Ryan Zayne",
   "license": "MIT",
@@ -44,6 +44,7 @@
     "@arethetypeswrong/cli": "0.17.3",
     "@size-limit/esbuild-why": "11.1.6",
     "@size-limit/preset-small-lib": "11.1.6",
+    "@standard-schema/spec": "^1.0.0",
     "@total-typescript/ts-reset": "0.6.1",
     "@zayne-labs/tsconfig": "0.2.1",
     "concurrently": "^9.0.1",

package/dist/esm/chunk-5YQFYNEZ.js

@@ -1 +0,0 @@
-var e=e=>{const{cloneResponse:r,defaultErrorMessage:t,error:n,message:a,resultMode:i}=e;let l={data:null,error:{errorData:n,message:a??n.message,name:n.name},response:null};if(o(n)){const{errorData:e,message:o=t,name:s,response:a}=n;l={data:null,error:{errorData:e,message:o,name:s},response:r?a.clone():a}}const c={all:l,onlyError:l.error,onlyResponse:l.response,onlySuccess:l.data,onlySuccessWithException:l.data};return{errorVariantDetails:l,getErrorResult:e=>{const r=c[i??"all"];return s(e)?{...r,...e}:r}}},r=class extends Error{errorData;isHTTPError=!0;name="HTTPError";response;constructor(e,r){const{defaultErrorMessage:t,errorData:o,response:n}=e;super(o?.message??t,r),this.errorData=o,this.response=n,Error.captureStackTrace(this,this.constructor)}},t=e=>a(e)&&"HTTPError"===e.name,o=e=>e instanceof r||a(e)&&"HTTPError"===e.name&&!0===e.isHTTPError,n=e=>Array.isArray(e),s=e=>"object"==typeof e&&null!==e,a=e=>{if(!s(e))return!1;const r=Object.getPrototypeOf(e);return(null==r||r===Object.prototype||null===Object.getPrototypeOf(r))&&!(Symbol.toStringTag in e)},i=e=>"function"==typeof e,l=e=>"string"==typeof e,c=e=>i(e)?e():e,u=e=>{if(void 0!==e){if(l(e)||null===e)return{Authorization:`Bearer ${e}`};switch(e.type){case"Basic":{const r=c(e.username),t=c(e.password);if(void 0===r||void 0===t)return;return{Authorization:`Basic ${globalThis.btoa(`${r}:${t}`)}`}}case"Custom":{const r=c(e.value);if(void 0===r)return;return{Authorization:`${c(e.prefix)} ${r}`}}default:{const r=c(e.bearer),t=c(e.token);return"token"in e&&void 0!==t?{Authorization:`Token ${t}`}:void 0!==r&&{Authorization:`Bearer ${r}`}}}}},p=["extend","dedupeKey"],f=["body","integrity","method","headers","signal","cache","redirect","window","credentials","keepalive","referrer","priority","mode","referrerPolicy"],d={408:"Request Timeout",409:"Conflict",425:"Too Early",429:"Too Many Requests",500:"Internal Server Error",502:"Bad Gateway",503:"Service Unavailable",504:"Gateway Timeout"},y=["GET","POST"],m=Object.keys(d).map(Number),h=(e,r)=>{const t={},o=new Set(r);for(const[r,n]of Object.entries(e))o.has(r)||(t[r]=n);return t},b=(e,r)=>{const t={},o=new Set(r);for(const[r,n]of Object.entries(e))o.has(r)&&(t[r]=n);return t},T=e=>[b(e,f),h(e,[...f,...p])],g=e=>[b(e,f),h(e,f)],w=e=>!e||a(e)?e:Object.fromEntries(e),E=e=>e?new URLSearchParams(e).toString():(console.error("toQueryString:","No query params provided!"),null),v=e=>{const{auth:r,baseHeaders:t,body:o,headers:n}=e;if(!Boolean(t||n||o||r))return;const s={...u(r),...w(t),...w(n)};return l(i=o)&&i.includes("=")?(s["Content-Type"]="application/x-www-form-urlencoded",s):((a(o)||l(o)&&o.startsWith("{"))&&(s["Content-Type"]="application/json",s.Accept="application/json"),s);var i},S=(e,r)=>n(e)?[e,r].flat():r??e,j=e=>{if(e)return e;if("undefined"!=typeof globalThis&&i(globalThis.fetch))return globalThis.fetch;throw new Error("No fetch implementation found")},O=(...e)=>Promise.all(e),P=async(e,r,t,o)=>{const n=((e,r)=>({arrayBuffer:()=>e.arrayBuffer(),blob:()=>e.blob(),formData:()=>e.formData(),json:async()=>{if(r){const t=await e.text();return r(t)}return e.json()},stream:()=>e.body,text:()=>e.text()}))(e,t);if(!Object.hasOwn(n,r))throw new Error(`Invalid response type: ${r}`);const s=await n[r]();return o?o(s):s},x=e=>{const{data:r,response:t,resultMode:o}=e,n={data:r,error:null,response:t};if(!o)return n;return{all:n,onlyError:n.error,onlyResponse:n.response,onlySuccess:n.data,onlySuccessWithException:n.data}[o]},D=e=>{if(0===e)return;const{promise:r,resolve:t}=(()=>{let e,r;return{promise:new Promise(((t,o)=>{r=t,e=o})),reject:e,resolve:r}})();return setTimeout(t,e),r};export{r as HTTPError,S as combineHooks,y as defaultRetryMethods,m as defaultRetryStatusCodes,O as executeHooks,j as getFetchImpl,P as getResponseData,n as isArray,i as isFunction,t as isHTTPError,o as isHTTPErrorInstance,a as isPlainObject,l as isString,v as mergeAndResolveHeaders,e as resolveErrorResult,x as resolveSuccessResult,T as splitBaseConfig,g as splitConfig,E as toQueryString,D as waitUntil};//# sourceMappingURL=chunk-5YQFYNEZ.js.map