@zayne-labs/callapi 1.6.11 → 1.6.14

package/dist/cjs/common-B_9jiZXC.d.cts

@@ -0,0 +1,551 @@
+import { StandardSchemaV1 } from '@standard-schema/spec';
+
+type ValueOrFunctionResult<TValue> = TValue | (() => TValue);
+/**
+ * Bearer Or Token authentication
+ *
+ * The value of `bearer` will be added to a header as
+ * `auth: Bearer some-auth-token`,
+ *
+ * The value of `token` will be added to a header as
+ * `auth: Token some-auth-token`,
+ */
+type BearerOrTokenAuth = {
+    type?: "Bearer";
+    bearer?: ValueOrFunctionResult<string | null>;
+    token?: never;
+} | {
+    type?: "Token";
+    bearer?: never;
+    token?: ValueOrFunctionResult<string | null>;
+};
+/**
+ * Basic auth
+ */
+type BasicAuth = {
+    type: "Basic";
+    username: ValueOrFunctionResult<string | null | undefined>;
+    password: ValueOrFunctionResult<string | null | undefined>;
+};
+/**
+ * Custom auth
+ *
+ * @param prefix - prefix of the header
+ * @param authValue - value of the header
+ *
+ * @example
+ * ```ts
+ * {
+ *  type: "Custom",
+ *  prefix: "Token",
+ *  authValue: "token"
+ * }
+ * ```
+ */
+type CustomAuth = {
+    type: "Custom";
+    prefix: ValueOrFunctionResult<string | null | undefined>;
+    value: ValueOrFunctionResult<string | null | undefined>;
+};
+type Auth = BearerOrTokenAuth | BasicAuth | CustomAuth;
+
+type AnyString = string & {
+    z_placeholder?: never;
+};
+type AnyNumber = number & {
+    z_placeholder?: never;
+};
+type AnyFunction<TResult = unknown> = (...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;
+
+interface CallApiSchemas {
+    /**
+     *  The schema to use for validating the request body.
+     */
+    body?: StandardSchemaV1<Body>;
+    /**
+     *  The schema to use for validating the response data.
+     */
+    data?: StandardSchemaV1;
+    /**
+     *  The schema to use for validating the response error data.
+     */
+    errorData?: StandardSchemaV1;
+    /**
+     *  The schema to use for validating the request headers.
+     */
+    headers?: StandardSchemaV1<Headers>;
+    /**
+     *  The schema to use for validating the request url.
+     */
+    initURL?: StandardSchemaV1<InitURL>;
+    /**
+     *  The schema to use for validating the meta option.
+     */
+    meta?: StandardSchemaV1<GlobalMeta>;
+    /**
+     *  The schema to use for validating the request method.
+     */
+    method?: StandardSchemaV1<Method>;
+    /**
+     *  The schema to use for validating the request url parameter.
+     */
+    params?: StandardSchemaV1<Params>;
+    /**
+     *  The schema to use for validating the request url querys.
+     */
+    query?: StandardSchemaV1<Query>;
+}
+interface CallApiValidators<TData = unknown, TErrorData = unknown> {
+    /**
+     * Custom function to validate the response data.
+     */
+    data?: (value: 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?: (value: unknown) => TErrorData;
+}
+type InferSchemaResult<TSchema, TData> = TSchema extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<TSchema> : TData;
+
+type Params = UnmaskType<Record<string, boolean | number | string> | Array<boolean | number | string>>;
+type Query = UnmaskType<Record<string, boolean | number | string>>;
+type InitURL = UnmaskType<string | URL>;
+interface UrlOptions<TSchemas extends CallApiSchemas> {
+    /**
+     * URL to be used in the request.
+     */
+    readonly initURL?: string;
+    /**
+     * Parameters to be appended to the URL (i.e: /:id)
+     */
+    params?: InferSchemaResult<TSchemas["params"], Params>;
+    /**
+     * Query parameters to append to the URL.
+     */
+    query?: InferSchemaResult<TSchemas["query"], Query>;
+}
+
+type RetryCondition<TErrorData> = (context: ErrorContext<TErrorData>) => boolean | Promise<boolean>;
+interface RetryOptions<TErrorData> {
+    /**
+     * 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;
+    /**
+     * Number of allowed retry attempts on HTTP errors
+     * @default 0
+     */
+    retryAttempts?: number;
+    /**
+     * Callback whose return value determines if a request should be retried or not
+     */
+    retryCondition?: RetryCondition<TErrorData>;
+    /**
+     * Delay between retries in milliseconds
+     * @default 1000
+     */
+    retryDelay?: number;
+    /**
+     * Maximum delay in milliseconds. Only applies to exponential strategy
+     * @default 10000
+     */
+    retryMaxDelay?: number;
+    /**
+     * HTTP methods that are allowed to retry
+     * @default ["GET", "POST"]
+     */
+    retryMethods?: 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>;
+    /**
+     * Strategy to use when retrying
+     * @default "linear"
+     */
+    retryStrategy?: "exponential" | "linear";
+}
+
+type DefaultDataType = unknown;
+type DefaultMoreOptions = NonNullable<unknown>;
+type DefaultPluginArray = CallApiPlugin[];
+type DefaultThrowOnError = boolean;
+
+type Parser = (responseString: string) => Awaitable<Record<string, unknown>>;
+declare const getResponseType: <TResponse>(response: Response, parser?: Parser) => {
+    arrayBuffer: () => Promise<ArrayBuffer>;
+    blob: () => Promise<Blob>;
+    formData: () => Promise<FormData>;
+    json: () => Promise<TResponse>;
+    stream: () => ReadableStream<Uint8Array<ArrayBufferLike>> | null;
+    text: () => Promise<string>;
+};
+type InitResponseTypeMap<TResponse = unknown> = ReturnType<typeof getResponseType<TResponse>>;
+type ResponseTypeUnion = keyof InitResponseTypeMap | undefined;
+type ResponseTypeMap<TResponse> = {
+    [Key in keyof InitResponseTypeMap<TResponse>]: Awaited<ReturnType<InitResponseTypeMap<TResponse>[Key]>>;
+};
+type GetResponseType<TResponse, TResponseType extends ResponseTypeUnion, TComputedMap extends ResponseTypeMap<TResponse> = ResponseTypeMap<TResponse>> = undefined extends TResponseType ? TComputedMap["json"] : TResponseType extends NonNullable<ResponseTypeUnion> ? TComputedMap[TResponseType] : never;
+
+type UnionToIntersection<TUnion> = (TUnion extends unknown ? (param: TUnion) => void : never) extends (param: infer TParam) => void ? TParam : never;
+type InferSchema<TResult> = TResult extends StandardSchemaV1 ? InferSchemaResult<TResult, NonNullable<unknown>> : TResult;
+type InferPluginOptions<TPluginArray extends CallApiPlugin[]> = UnionToIntersection<InferSchema<ReturnType<NonNullable<TPluginArray[number]["createExtraOptions"]>>>>;
+type PluginInitContext<TMoreOptions = DefaultMoreOptions> = WithMoreOptions<TMoreOptions> & {
+    initURL: InitURL | undefined;
+    options: CombinedCallApiExtraOptions;
+    request: CallApiRequestOptionsForHooks;
+};
+type PluginInitResult = Partial<Omit<PluginInitContext, "request"> & {
+    request: CallApiRequestOptions;
+}>;
+interface CallApiPlugin<TData = never, TErrorData = never> {
+    /**
+     * 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<TData, TErrorData>;
+    /**
+     *  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>>(plugin: TPlugin) => TPlugin;
+type Plugins<TPluginArray extends CallApiPlugin[]> = TPluginArray | ((context: PluginInitContext) => 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
+ */
+type MakeSchemaOptionRequired<TSchema extends StandardSchemaV1 | undefined, TObject> = undefined extends TSchema ? TObject : undefined extends InferSchemaResult<TSchema, NonNullable<unknown>> ? TObject : Required<TObject>;
+type Body = UnmaskType<Record<string, unknown> | RequestInit["body"]>;
+type BodyOption<TSchemas extends CallApiSchemas> = MakeSchemaOptionRequired<TSchemas["body"], {
+    /**
+     * Body of the request, can be a object or any other supported body type.
+     */
+    body?: InferSchemaResult<TSchemas["body"], Body>;
+}>;
+type Method = UnmaskType<"CONNECT" | "DELETE" | "GET" | "HEAD" | "OPTIONS" | "PATCH" | "POST" | "PUT" | "TRACE" | AnyString>;
+type MethodOption<TSchemas extends CallApiSchemas> = MakeSchemaOptionRequired<TSchemas["method"], {
+    /**
+     * HTTP method for the request.
+     * @default "GET"
+     */
+    method?: InferSchemaResult<TSchemas["method"], Method>;
+}>;
+type Headers = UnmaskType<Record<"Authorization", CommonAuthorizationHeaders> | Record<"Content-Type", CommonContentTypes> | Record<CommonRequestHeaders, string | undefined> | Record<string, string | undefined> | RequestInit["headers"]>;
+type HeadersOption<TSchemas extends CallApiSchemas> = MakeSchemaOptionRequired<TSchemas["headers"], {
+    /**
+     * Headers to be used in the request.
+     */
+    headers?: InferSchemaResult<TSchemas["headers"], Headers>;
+}>;
+interface Register {
+}
+type GlobalMeta = Register extends {
+    meta?: infer TMeta extends Record<string, unknown>;
+} ? TMeta : never;
+type MetaOption<TSchemas extends CallApiSchemas> = {
+    /**
+     * - 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.
+     *
+     * @example
+     * ```ts
+     * const callMainApi = callApi.create({
+     * 	baseURL: "https://main-api.com",
+     * 	onResponseError: ({ response, options }) => {
+     * 		if (options.meta?.userId) {
+     * 			console.error(`User ${options.meta.userId} made an error`);
+     * 		}
+     * 	},
+     * });
+     *
+     * const response = await callMainApi({
+     * 	url: "https://example.com/api/data",
+     * 	meta: { userId: "123" },
+     * });
+     * ```
+     */
+    meta?: InferSchemaResult<TSchemas["meta"], GlobalMeta>;
+};
+type ResultModeOption<TErrorData, TResultMode extends ResultModeUnion> = TErrorData extends false ? {
+    resultMode: "onlySuccessWithException";
+} : TErrorData extends false | undefined ? {
+    resultMode?: "onlySuccessWithException";
+} : undefined extends TResultMode ? {
+    resultMode?: TResultMode;
+} : {
+    resultMode: TResultMode;
+};
+
+type FetchSpecificKeysUnion = Exclude<(typeof fetchSpecificKeys)[number], "body" | "headers" | "method">;
+type CallApiRequestOptions<TSchemas extends CallApiSchemas = DefaultMoreOptions> = BodyOption<TSchemas> & HeadersOption<TSchemas> & MethodOption<TSchemas> & Pick<RequestInit, FetchSpecificKeysUnion>;
+type CallApiRequestOptionsForHooks<TSchemas extends CallApiSchemas = DefaultMoreOptions> = Omit<CallApiRequestOptions<TSchemas>, "headers"> & {
+    headers?: Record<string, string | undefined>;
+};
+type WithMoreOptions<TMoreOptions = DefaultMoreOptions> = {
+    options: CombinedCallApiExtraOptions & Partial<TMoreOptions>;
+};
+interface Interceptors<TData = DefaultDataType, TErrorData = DefaultDataType, TMoreOptions = DefaultMoreOptions> {
+    /**
+     * 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>;
+    /**
+     * Interceptor that will be called just before the request is made, allowing for modifications or additional operations.
+     */
+    onRequest?: (context: RequestContext & WithMoreOptions<TMoreOptions>) => Awaitable<unknown>;
+    /**
+     *  Interceptor that will be called when an error occurs during the fetch request.
+     */
+    onRequestError?: (context: RequestErrorContext & WithMoreOptions<TMoreOptions>) => Awaitable<unknown>;
+    /**
+     * 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>;
+    /**
+     *  Interceptor that will be called when an error response is received from the api.
+     */
+    onResponseError?: (context: ResponseErrorContext<TErrorData> & WithMoreOptions<TMoreOptions>) => Awaitable<unknown>;
+    /**
+     * Interceptor that will be called when a request is retried.
+     */
+    onRetry?: (response: ErrorContext<TErrorData> & WithMoreOptions<TMoreOptions>) => Awaitable<unknown>;
+    /**
+     * Interceptor that will be called when a successful response is received from the api.
+     */
+    onSuccess?: (context: SuccessContext<TData> & WithMoreOptions<TMoreOptions>) => Awaitable<unknown>;
+}
+type InterceptorsOrInterceptorArray<TData = DefaultDataType, TErrorData = DefaultDataType, TMoreOptions = DefaultMoreOptions> = {
+    [Key in keyof Interceptors<TData, TErrorData, TMoreOptions>]: Interceptors<TData, TErrorData, TMoreOptions>[Key] | Array<Interceptors<TData, TErrorData, TMoreOptions>[Key]>;
+};
+type FetchImpl = UnmaskType<(input: string | Request | URL, init?: RequestInit) => Promise<Response>>;
+type ExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TThrowOnError extends boolean = DefaultThrowOnError, TResponseType extends ResponseTypeUnion = ResponseTypeUnion, TSchemas extends CallApiSchemas = DefaultMoreOptions, TPluginArray extends CallApiPlugin[] = DefaultPluginArray> = {
+    /**
+     * Authorization header value.
+     */
+    auth?: string | Auth | null;
+    /**
+     * Base URL to be prepended to all request URLs
+     */
+    baseURL?: string;
+    /**
+     * Custom function to serialize the body object into a string.
+     */
+    bodySerializer?: (bodyData: Record<string, unknown>) => string;
+    /**
+     * 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;
+    /**
+     * Custom fetch implementation
+     */
+    customFetchImpl?: FetchImpl;
+    /**
+     * 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;
+    /**
+     * 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.
+     * @default "cancel"
+     */
+    dedupeStrategy?: "cancel" | "defer" | "none";
+    /**
+     * Default error message to use if none is provided from a response.
+     * @default "Failed to fetch data from server!"
+     */
+    defaultErrorMessage?: string;
+    /**
+     * Resolved request URL
+     */
+    readonly fullURL?: string;
+    /**
+     * 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";
+    /**
+     * - Controls what order in which the merged hooks execute
+     * @default "mainHooksLast"
+     */
+    mergedHooksExecutionOrder?: "mainHooksAfterPlugins" | "mainHooksBeforePlugins";
+    /**
+     * An array of CallApi plugins. It allows you to extend the behavior of the library.
+     */
+    plugins?: Plugins<TPluginArray>;
+    /**
+     * Custom function to parse the response string into a object.
+     */
+    responseParser?: (responseString: string) => Awaitable<Record<string, unknown>>;
+    /**
+     * Expected response type, affects how response is parsed
+     * @default "json"
+     */
+    responseType?: TResponseType;
+    /**
+     * Mode of the result, can influence how results are handled or returned.
+     * Can be set to "all" | "onlySuccess" | "onlyError" | "onlyResponse".
+     * @default "all"
+     */
+    resultMode?: TResultMode;
+    /**
+     * Type-safe schemas for the response validation.
+     */
+    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
+     * @default false
+     */
+    throwOnError?: TThrowOnError | ((context: ErrorContext<TErrorData>) => TThrowOnError);
+    /**
+     * Request timeout in milliseconds
+     */
+    timeout?: number;
+    /**
+     * Custom validation functions for response validation
+     */
+    validators?: CallApiValidators<TData, TErrorData>;
+} & InterceptorsOrInterceptorArray<TData, TErrorData> & Partial<InferPluginOptions<TPluginArray>> & MetaOption<TSchemas> & RetryOptions<TErrorData> & ResultModeOption<TErrorData, TResultMode> & UrlOptions<TSchemas>;
+declare const optionsEnumToExtendFromBase: ("plugins" | "schemas" | "validators")[];
+type CallApiExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TThrowOnError extends boolean = DefaultThrowOnError, TResponseType extends ResponseTypeUnion = ResponseTypeUnion, TSchemas extends CallApiSchemas = DefaultMoreOptions, TPluginArray extends CallApiPlugin[] = DefaultPluginArray> = CallApiRequestOptions<TSchemas> & ExtraOptions<TData, TErrorData, TResultMode, TThrowOnError, TResponseType, TSchemas, TPluginArray> & {
+    /**
+     * Options that should extend the base options.
+     */
+    extend?: Pick<ExtraOptions<TData, TErrorData, TResultMode, TThrowOnError, TResponseType, TSchemas, TPluginArray>, (typeof optionsEnumToExtendFromBase)[number]>;
+};
+declare const optionsEnumToOmitFromBase: ("dedupeKey" | "extend")[];
+type BaseCallApiExtraOptions<TBaseData = DefaultDataType, TBaseErrorData = DefaultDataType, TBaseResultMode extends ResultModeUnion = ResultModeUnion, TBaseThrowOnError extends boolean = DefaultThrowOnError, TBaseResponseType extends ResponseTypeUnion = ResponseTypeUnion, TBaseSchemas extends CallApiSchemas = DefaultMoreOptions, TBasePluginArray extends CallApiPlugin[] = DefaultPluginArray> = Omit<Partial<CallApiExtraOptions<TBaseData, TBaseErrorData, TBaseResultMode, TBaseThrowOnError, TBaseResponseType, TBaseSchemas, TBasePluginArray>>, (typeof optionsEnumToOmitFromBase)[number]>;
+type CombinedCallApiExtraOptions = BaseCallApiExtraOptions & CallApiExtraOptions;
+type CallApiParameters<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TThrowOnError extends boolean = DefaultThrowOnError, TResponseType extends ResponseTypeUnion = ResponseTypeUnion, TSchemas extends CallApiSchemas = DefaultMoreOptions, TPluginArray extends CallApiPlugin[] = DefaultPluginArray> = [
+    initURL: InferSchemaResult<TSchemas["initURL"], InitURL>,
+    config?: CallApiExtraOptions<TData, TErrorData, TResultMode, TThrowOnError, TResponseType, TSchemas, TPluginArray>
+];
+type RequestContext = UnmaskType<{
+    options: CombinedCallApiExtraOptions;
+    request: CallApiRequestOptionsForHooks;
+}>;
+type ResponseContext<TData, TErrorData> = UnmaskType<{
+    data: TData;
+    error: null;
+    options: CombinedCallApiExtraOptions;
+    request: CallApiRequestOptionsForHooks;
+    response: Response;
+} | {
+    data: null;
+    error: PossibleHTTPError<TErrorData>;
+    options: CombinedCallApiExtraOptions;
+    request: CallApiRequestOptionsForHooks;
+    response: Response;
+}>;
+type SuccessContext<TData> = UnmaskType<{
+    data: TData;
+    options: CombinedCallApiExtraOptions;
+    request: CallApiRequestOptionsForHooks;
+    response: Response;
+}>;
+type PossibleJavascriptErrorNames = "AbortError" | "Error" | "SyntaxError" | "TimeoutError" | "TypeError" | (`${string}Error` & DefaultMoreOptions);
+type PossibleJavaScriptError = UnmaskType<{
+    errorData: DOMException | Error | SyntaxError | TypeError;
+    message: string;
+    name: PossibleJavascriptErrorNames;
+}>;
+type PossibleHTTPError<TErrorData> = UnmaskType<{
+    errorData: TErrorData;
+    message: string;
+    name: "HTTPError";
+}>;
+type RequestErrorContext = UnmaskType<{
+    error: PossibleJavaScriptError;
+    options: CombinedCallApiExtraOptions;
+    request: CallApiRequestOptionsForHooks;
+    response: null;
+}>;
+type ResponseErrorContext<TErrorData> = UnmaskType<{
+    error: PossibleHTTPError<TErrorData>;
+    options: CombinedCallApiExtraOptions;
+    request: CallApiRequestOptionsForHooks;
+    response: Response;
+}>;
+type ErrorContext<TErrorData> = UnmaskType<{
+    error: PossibleHTTPError<TErrorData>;
+    options: CombinedCallApiExtraOptions;
+    request: CallApiRequestOptionsForHooks;
+    response: Response;
+} | {
+    error: PossibleJavaScriptError;
+    options: CombinedCallApiExtraOptions;
+    request: CallApiRequestOptionsForHooks;
+    response: null;
+}>;
+type CallApiResultSuccessVariant<TData> = {
+    data: TData;
+    error: null;
+    response: Response;
+};
+type CallApiResultErrorVariant<TErrorData> = {
+    data: null;
+    error: PossibleHTTPError<TErrorData>;
+    response: Response;
+} | {
+    data: null;
+    error: PossibleJavaScriptError;
+    response: null;
+};
+type ResultModeMap<TData = DefaultDataType, TErrorData = DefaultDataType, TResponseType extends ResponseTypeUnion = ResponseTypeUnion, TComputedData = GetResponseType<TData, TResponseType>, TComputedErrorData = GetResponseType<TErrorData, TResponseType>> = UnmaskType<{
+    all: CallApiResultSuccessVariant<TComputedData> | CallApiResultErrorVariant<TComputedErrorData>;
+    allWithException: CallApiResultSuccessVariant<TComputedData>;
+    allWithoutResponse: CallApiResultSuccessVariant<TComputedData>["data" | "error"] | CallApiResultErrorVariant<TComputedErrorData>["data" | "error"];
+    onlyError: CallApiResultSuccessVariant<TComputedData>["error"] | CallApiResultErrorVariant<TComputedErrorData>["error"];
+    onlyResponse: CallApiResultErrorVariant<TComputedErrorData>["response"] | CallApiResultSuccessVariant<TComputedData>["response"];
+    onlyResponseWithException: CallApiResultSuccessVariant<TComputedErrorData>["response"];
+    onlySuccess: CallApiResultErrorVariant<TComputedErrorData>["data"] | CallApiResultSuccessVariant<TComputedData>["data"];
+    onlySuccessWithException: CallApiResultSuccessVariant<TComputedData>["data"];
+}>;
+type ResultModeUnion = keyof ResultModeMap | undefined;
+type GetCallApiResult<TData, TErrorData, TResultMode extends ResultModeUnion, TThrowOnError extends boolean, TResponseType extends ResponseTypeUnion> = TErrorData extends false | undefined ? ResultModeMap<TData, TErrorData, TResponseType>["onlySuccessWithException"] : ResultModeUnion | undefined extends TResultMode ? TThrowOnError extends true ? ResultModeMap<TData, TErrorData, TResponseType>["allWithException"] : ResultModeMap<TData, TErrorData, TResponseType>["all"] : TResultMode extends NonNullable<ResultModeUnion> ? ResultModeMap<TData, TErrorData, TResponseType>[TResultMode] : never;
+
+export { type BaseCallApiExtraOptions as B, type CallApiSchemas as C, type DefaultPluginArray as D, type ErrorContext as E, type GetCallApiResult as G, type InferSchemaResult as I, type PluginInitContext as P, type ResultModeUnion as R, type SuccessContext as S, type ResponseTypeUnion as a, type CallApiPlugin as b, type CallApiExtraOptions as c, type DefaultDataType as d, type DefaultThrowOnError as e, type DefaultMoreOptions as f, definePlugin as g, type PossibleJavaScriptError as h, type PossibleHTTPError as i, type CallApiParameters as j, type CallApiRequestOptions as k, type CallApiRequestOptionsForHooks as l, type CallApiResultErrorVariant as m, type CallApiResultSuccessVariant as n, type CombinedCallApiExtraOptions as o, type Interceptors as p, type InterceptorsOrInterceptorArray as q, type PossibleJavascriptErrorNames as r, type Register as s, type RequestContext as t, type RequestErrorContext as u, type ResponseContext as v, type ResponseErrorContext as w, type InitURL as x, defaultRetryMethods as y, defaultRetryStatusCodes as z };

package/dist/cjs/error-lBRMiMeF.d.cts

@@ -0,0 +1,17 @@
+type ErrorDetails<TErrorResponse> = {
+    defaultErrorMessage: string;
+    errorData: TErrorResponse;
+    response: Response;
+};
+type ErrorOptions = {
+    cause?: unknown;
+};
+declare class HTTPError<TErrorResponse = Record<string, unknown>> extends Error {
+    errorData: ErrorDetails<TErrorResponse>["errorData"];
+    isHTTPError: boolean;
+    name: "HTTPError";
+    response: ErrorDetails<TErrorResponse>["response"];
+    constructor(errorDetails: ErrorDetails<TErrorResponse>, errorOptions?: ErrorOptions);
+}
+
+export { HTTPError as H };

package/dist/cjs/index.cjs

@@ -0,0 +1 @@
+"use strict";var e,r=Object.defineProperty,t=Object.getOwnPropertyDescriptor,o=Object.getOwnPropertyNames,s=Object.prototype.hasOwnProperty,n={};((e,t)=>{for(var o in t)r(e,o,{get:t[o],enumerable:!0})})(n,{HTTPError:()=>a,callApi:()=>L,createFetchClient:()=>U,definePlugin:()=>x}),module.exports=(e=n,((e,n,a,i)=>{if(n&&"object"==typeof n||"function"==typeof n)for(let l of o(n))s.call(e,l)||l===a||r(e,l,{get:()=>n[l],enumerable:!(i=t(n,l))||i.enumerable});return e})(r({},"__esModule",{value:!0}),e));var a=class extends Error{errorData;isHTTPError=!0;name="HTTPError";response;constructor(e,r){const{defaultErrorMessage:t,errorData:o,response:s}=e;super(o?.message??t,r),this.errorData=o,this.response=s,Error.captureStackTrace(this,this.constructor)}},i=e=>e instanceof a||d(e)&&"HTTPError"===e.name&&!0===e.isHTTPError,l=e=>Array.isArray(e),u=e=>"object"==typeof e&&null!==e,c=e=>"[object Object]"===Object.prototype.toString.call(e),d=e=>{if(!c(e))return!1;const r=e?.constructor;if(void 0===r)return!0;const t=r.prototype;return!!c(t)&&(!!Object.hasOwn(t,"isPrototypeOf")&&Object.getPrototypeOf(e)===Object.prototype)},p=e=>"function"==typeof e,y=e=>"string"==typeof e,f=e=>p(e)?e():e,h=e=>{if(void 0!==e){if(y(e)||null===e)return{Authorization:`Bearer ${e}`};switch(e.type){case"Basic":{const r=f(e.username),t=f(e.password);if(void 0===r||void 0===t)return;return{Authorization:`Basic ${globalThis.btoa(`${r}:${t}`)}`}}case"Custom":{const r=f(e.value);if(void 0===r)return;return{Authorization:`${f(e.prefix)} ${r}`}}default:{const r=f(e.bearer),t=f(e.token);return"token"in e&&void 0!==t?{Authorization:`Token ${t}`}:void 0!==r&&{Authorization:`Bearer ${r}`}}}}},m=["extend","dedupeKey"],g=["body","integrity","method","headers","signal","cache","redirect","window","credentials","keepalive","referrer","priority","mode","referrerPolicy"],w={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"},b=["GET","POST"],E=Object.keys(w).map(Number),R=(e,r)=>{const t={},o=new Set(r);for(const[r,s]of Object.entries(e))o.has(r)||(t[r]=s);return t},S=(e,r)=>{const t={},o=new Set(r);for(const[r,s]of Object.entries(e))o.has(r)&&(t[r]=s);return t},O=e=>!e||d(e)?e:Object.fromEntries(e),v=e=>{const{auth:r,baseHeaders:t,body:o,headers:s}=e;if(!Boolean(t||s||o||r))return;const n={...h(r),...O(t),...O(s)};return y(a=o)&&a.includes("=")?(n["Content-Type"]="application/x-www-form-urlencoded",n):((d(o)||y(o)&&o.startsWith("{"))&&(n["Content-Type"]="application/json",n.Accept="application/json"),n);var a},q=(...e)=>Promise.all(e),T=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},D=async e=>{const{$RequestInfoCache:r,newFetchController:t,options:o,request:s}=e,n=o.dedupeKey??("cancel"===o.dedupeStrategy||"defer"===o.dedupeStrategy?`${o.fullURL}-${JSON.stringify({options:o,request:s})}`:null),a=null!==n?r:null;null!==n&&await T(.1);const i=a?.get(n);return{handleRequestCancelStrategy:()=>{if(!(i&&"cancel"===o.dedupeStrategy))return;const e=o.dedupeKey?`Duplicate request detected - Aborting previous request with key '${o.dedupeKey}' as a new request was initiated`:`Duplicate request detected - Aborting previous request to '${o.fullURL}' as a new request with identical options was initiated`,r=new DOMException(e,"AbortError");return i.controller.abort(r),Promise.resolve()},handleRequestDeferStrategy:()=>{const e=(e=>{if(e)return e;if("undefined"!=typeof globalThis&&p(globalThis.fetch))return globalThis.fetch;throw new Error("No fetch implementation found")})(o.customFetchImpl),r=i&&"defer"===o.dedupeStrategy?i.responsePromise:e(o.fullURL,s);return a?.set(n,{controller:t,responsePromise:r}),r},removeDedupeKeyFromCache:()=>a?.delete(n)}},x=e=>e,j=(e,r)=>async t=>{if("sequential"!==r){if("parallel"===r){const r=[...e];await Promise.all(r.map((e=>e?.(t))))}}else for(const r of e)await(r?.(t))},M={onError:new Set,onRequest:new Set,onRequestError:new Set,onResponse:new Set,onResponseError:new Set,onRetry:new Set,onSuccess:new Set},P=(e,r)=>e?p(e)?e(r):e:[],$=async(e,r,t)=>{const o=((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(o,r))throw new Error(`Invalid response type: ${r}`);return await o[r]()},k=(e,r)=>{const t=e["~retryCount"]??0;return{getDelay:()=>"exponential"===e.retryStrategy?((e,r)=>{const t=r.retryMaxDelay??1e4,o=(r.retryDelay??1e3)*2**e;return Math.min(o,t)})(t,e):(e=>e.retryDelay??1e3)(e),shouldAttemptRetry:async()=>{const o=await(e.retryCondition?.(r))??!0,s=(e.retryAttempts??0)>t&&o;if("HTTPError"!==r.error.name)return s;const n=!!r.request.method&&e.retryMethods?.includes(r.request.method);return!!r.response?.status&&e.retryStatusCodes?.includes(r.response.status)&&n&&s}}},A=(e,r)=>{if(!r)return e;const t=(o=r)?new URLSearchParams(o).toString():(console.error("toQueryString:","No query params provided!"),null);var o;return 0===t?.length?e:e.endsWith("?")?`${e}${t}`:e.includes("?")?`${e}&${t}`:`${e}?${t}`},C=(e,r,t)=>{if(!e)return;const o=((e,r)=>{if(!r)return e;let t=e;if(l(r)){const e=t.split("/").filter((e=>e.startsWith(":")));for(const[o,s]of e.entries()){const e=r[o];t=t.replace(s,e)}return t}for(const[e,o]of Object.entries(r))t=t.replace(`:${e}`,String(o));return t})(e,r);return A(o,t)},H=async(e,r,t)=>{const o=t?t(e):e,s=r?await(async(e,r)=>{const t=await e["~standard"].validate(r);if(t.issues)throw new Error(JSON.stringify(t.issues,null,2),{cause:t.issues});return t.value})(r,o):o;return s},U=e=>{const[r,t]=(e=>[S(e,g),R(e,[...g,...m])])(e??{}),o=new Map,s=async(...e)=>{const[n,c={}]=e,[f,h]=(e=>[S(e,g),R(e,g)])(c),m={};for(const e of Object.keys(M)){const r=(w=t[e],O=h[e],l(w)?[w,O].flat():O??w);m[e]=r}var w,O;const x={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:b,retryStatusCodes:E,retryStrategy:"linear",...t,...h,...m},A=f.body??r.body,U={...r,...f,body:d(A)?x.bodySerializer(A):A,headers:v({auth:x.auth,baseHeaders:r.headers,body:A,headers:f.headers}),signal:f.signal??r.signal},{resolvedHooks:L,resolvedOptions:W,resolvedRequestOptions:B,url:z}=await(async e=>{const{initURL:r,options:t,request:o}=e,s=structuredClone(M),n=()=>{for(const e of Object.keys(M)){const r=t[e];s[e].add(r)}},a=e=>{for(const r of Object.keys(M)){const t=e[r];s[r].add(t)}};"mainHooksBeforePlugins"===t.mergedHooksExecutionOrder&&n();const i=[...P(t.plugins,e),...P(t.extend?.plugins,e)];let l=r,u=t,c=o;const p=async e=>{if(!e)return;const s=await e({initURL:r,options:t,request:o});d(s)&&(y(s.initURL)&&(l=s.initURL),d(s.request)&&(c=s.request),d(s.options)&&(u=s.options))};for(const e of i)await p(e.init),e.hooks&&a(e.hooks);t.mergedHooksExecutionOrder&&"mainHooksAfterPlugins"!==t.mergedHooksExecutionOrder||n();const f={};for(const[e,r]of Object.entries(s)){const o=[...r].flat(),s=j(o,t.mergedHooksExecutionMode);f[e]=s}return{resolvedHooks:f,resolvedOptions:u,resolvedRequestOptions:c,url:l?.toString()}})({initURL:n,options:x,request:U}),F=`${W.baseURL}${C(z,W.params,W.query)}`,N={...W,...L,fullURL:F,initURL:n.toString()},K=new AbortController,I=null!=N.timeout?(G=N.timeout,AbortSignal.timeout(G)):null;var G;const J=((...e)=>AbortSignal.any(e.filter(Boolean)))(B.signal,I,K.signal),_={...B,signal:J},{handleRequestCancelStrategy:Q,handleRequestDeferStrategy:V,removeDedupeKeyFromCache:X}=await D({$RequestInfoCache:o,newFetchController:K,options:N,request:_});await Q();try{await q(N.onRequest({options:N,request:_})),_.headers=v({auth:N.auth,baseHeaders:r.headers,body:A,headers:_.headers});const e=await V(),t="defer"===N.dedupeStrategy||N.cloneResponse,{schemas:o,validators:s}=(e=>({schemas:e.schemas&&{...e.schemas,...e.extend?.schemas},validators:e.validators&&{...e.validators,...e.extend?.validators}}))(N);if(!e.ok){const r=await $(t?e.clone():e,N.responseType,N.responseParser),n=await H(r,o?.errorData,s?.errorData);throw new a({defaultErrorMessage:N.defaultErrorMessage,errorData:n,response:e})}const n=await $(t?e.clone():e,N.responseType,N.responseParser),i={data:await H(n,o?.data,s?.data),options:N,request:_,response:N.cloneResponse?e.clone():e};return await q(N.onSuccess(i),N.onResponse({...i,error:null})),await(e=>{const{data:r,response:t,resultMode:o}=e,s={data:r,error:null,response:t};return o?{all:s,allWithException:s,allWithoutResponse:R(s,["response"]),onlyError:s.error,onlyResponse:s.response,onlyResponseWithException:s.response,onlySuccess:s.data,onlySuccessWithException:s.data}[o]:s})({data:i.data,response:i.response,resultMode:N.resultMode})}catch(e){const{apiDetails:r,getErrorResult:t}=(e=>{const{cloneResponse:r,defaultErrorMessage:t,error:o,message:s,resultMode:n}=e;let a={data:null,error:{errorData:o,message:s??o.message,name:o.name},response:null};if(i(o)){const{errorData:e,message:s=t,name:n,response:i}=o;a={data:null,error:{errorData:e,message:s,name:n},response:r?i.clone():i}}const l={all:a,allWithException:a,allWithoutResponse:R(a,["response"]),onlyError:a.error,onlyResponse:a.response,onlyResponseWithException:a.response,onlySuccess:a.data,onlySuccessWithException:a.data};return{apiDetails:a,getErrorResult:e=>{const r=l[n??"all"];return u(e)?{...r,...e}:r}}})({cloneResponse:N.cloneResponse,defaultErrorMessage:N.defaultErrorMessage,error:e,resultMode:N.resultMode}),o={error:r.error,options:N,request:_,response:r.response},{getDelay:a,shouldAttemptRetry:l}=k(N,o);if(!J.aborted&&await l()){await q(N.onRetry(o));const e=a();await T(e);const r={...c,"~retryCount":(N["~retryCount"]??0)+1};return await s(n,r)}const d=p(N.throwOnError)?N.throwOnError(o):N.throwOnError,y=()=>{if(d)throw r.error};if(i(e))return await q(N.onResponseError(o),N.onError(o),N.onResponse({...o,data:null})),y(),t();if(e instanceof DOMException&&"AbortError"===e.name){const{message:r,name:o}=e;return console.error(`${o}:`,r),y(),t()}if(e instanceof DOMException&&"TimeoutError"===e.name){const r=`Request timed out after ${N.timeout}ms`;return console.error(`${e.name}:`,r),y(),t({message:r})}return await q(N.onRequestError(o),N.onError(o)),y(),t()}finally{X()}};return s.create=U,s},L=U();//# sourceMappingURL=index.cjs.map