@zayne-labs/callapi 1.3.2 → 1.3.3

package/dist/cjs/{index-ERam9OPy.d.cts → index-BpNetCiS.d.cts}

@@ -60,40 +60,48 @@ type UnmaskType<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";
-type CommonAuthorizationHeaders = "Basic" | "Bearer" | "Token";
+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";
 
-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 ErrorObjectUnion<TErrorData = unknown> = PossibleHTTPError<TErrorData> | PossibleJavaScriptError;
-declare const isHTTPError: <TErrorData>(error: ErrorObjectUnion<TErrorData> | null) => error is PossibleHTTPError<TErrorData>;
-type ErrorDetails<TErrorResponse> = {
-    defaultErrorMessage: string;
-    errorData: TErrorResponse;
-    response: Response;
+type PluginInitContext<TMoreOptions extends AnyObject = DefaultMoreOptions> = {
+    initURL: string;
+    options: CombinedCallApiExtraOptions<DefaultDataType, DefaultDataType, ResultModeUnion, TMoreOptions>;
+    request: CallApiRequestOptionsForHooks;
 };
-type ErrorOptions = {
-    cause?: unknown;
+type CreateExtraOptions<TMoreOptions> = (...params: never[]) => TMoreOptions;
+type CallApiPlugin<TMoreOptions extends AnyObject = DefaultMoreOptions> = {
+    /**
+     * @description Defines additional options that can be passed to callApi
+     */
+    createExtraOptions?: CreateExtraOptions<TMoreOptions>;
+    /**
+     *  @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<Partial<PluginInitContext>> | Awaitable<void>;
+    /**
+     * @description A name for the plugin
+     */
+    name: string;
+    /**
+     * @description A version for the plugin
+     */
+    version?: string;
 };
-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);
-}
-declare const isHTTPErrorInstance: <TErrorResponse>(error: unknown) => error is HTTPError<TErrorResponse>;
+declare const definePlugin: <TMoreOptions extends AnyObject = {}, TPlugin extends AnyFunction<CallApiPlugin<TMoreOptions>> | CallApiPlugin<TMoreOptions> = CallApiPlugin<TMoreOptions>>(plugin: TPlugin) => TPlugin;
 
 type RetryCondition<TErrorData> = (context: ErrorContext<TErrorData>) => boolean | Promise<boolean>;
 interface RetryOptions<TErrorData> {
@@ -137,45 +145,37 @@ interface RetryOptions<TErrorData> {
     retryStrategy?: "exponential" | "linear";
 }
 
-type PluginInitContext<TMoreOptions extends AnyObject = DefaultMoreOptions> = {
-    initURL: string;
-    options: CombinedCallApiExtraOptions & Partial<TMoreOptions>;
-    request: CallApiRequestOptionsForHooks;
+type ToQueryStringFn = {
+    (params: CallApiConfig["query"]): string | null;
+    (params: Required<CallApiConfig>["query"]): string;
 };
-type CreateExtraOptions<TMoreOptions> = (...params: never[]) => TMoreOptions;
-type CallApiPlugin<TMoreOptions extends AnyObject = DefaultMoreOptions> = {
-    /**
-     * @description Defines additional options that can be passed to callApi
-     */
-    createExtraOptions?: CreateExtraOptions<TMoreOptions>;
-    /**
-     *  @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<Partial<PluginInitContext>> | Awaitable<void>;
-    /**
-     * @description A name for the plugin
-     */
-    name: string;
-    /**
-     * @description A version for the plugin
-     */
-    version?: 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>;
 };
-declare const definePlugin: <TMoreOptions extends AnyObject = {}, TPlugin extends AnyFunction<CallApiPlugin<TMoreOptions>> | CallApiPlugin<TMoreOptions> = CallApiPlugin<TMoreOptions>>(plugin: TPlugin) => TPlugin;
+type ErrorObjectUnion<TErrorData = unknown> = PossibleHTTPError<TErrorData> | PossibleJavaScriptError;
+declare const isHTTPError: <TErrorData>(error: ErrorObjectUnion<TErrorData> | null) => error is PossibleHTTPError<TErrorData>;
+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);
+}
+declare const isHTTPErrorInstance: <TErrorResponse>(error: unknown) => error is HTTPError<TErrorResponse>;
 
 declare const fetchSpecificKeys: ("body" | "cache" | "credentials" | "headers" | "integrity" | "keepalive" | "method" | "mode" | "priority" | "redirect" | "referrer" | "referrerPolicy" | "signal" | "window")[];
 
@@ -196,7 +196,7 @@ interface CallApiRequestOptions extends Pick<RequestInit, FetchSpecificKeysUnion
     method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT" | AnyString;
 }
 interface CallApiRequestOptionsForHooks extends CallApiRequestOptions {
-    headers?: Record<CommonRequestHeaders | AnyString, string>;
+    headers?: Record<CommonRequestHeaders | AnyString, string> | Record<string, string>;
 }
 interface Register {
 }
@@ -241,7 +241,7 @@ type DefaultMoreOptions = NonNullable<unknown>;
 type Meta = Register extends {
     meta?: infer TMeta extends Record<string, unknown>;
 } ? TMeta : never;
-type ExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends CallApiResultModeUnion = CallApiResultModeUnion, TMoreOptions extends AnyObject = DefaultMoreOptions> = InterceptorsOrInterceptorArray<TData, TErrorData> & Partial<TMoreOptions> & RetryOptions<TErrorData> & {
+type ExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TMoreOptions extends AnyObject = DefaultMoreOptions> = InterceptorsOrInterceptorArray<TData, TErrorData> & Partial<TMoreOptions> & RetryOptions<TErrorData> & {
     /**
      * @description Authorization header value.
      */
@@ -374,18 +374,18 @@ type ExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResult
     timeout?: number;
 };
 declare const optionsEnumToExtendFromBase: "plugins"[];
-type CallApiExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends CallApiResultModeUnion = CallApiResultModeUnion, TMoreOptions extends AnyObject = DefaultMoreOptions> = ExtraOptions<TData, TErrorData, TResultMode, TMoreOptions> & {
+type CallApiExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TMoreOptions extends AnyObject = DefaultMoreOptions> = ExtraOptions<TData, TErrorData, TResultMode, TMoreOptions> & {
     /**
      * @description Options that should extend the base options.
      */
     extend?: Pick<ExtraOptions<TData, TErrorData, TResultMode, TMoreOptions>, (typeof optionsEnumToExtendFromBase)[number]>;
 };
 declare const optionsEnumToOmitFromBase: ("dedupeKey" | "extend")[];
-type BaseCallApiExtraOptions<TBaseData = DefaultDataType, TBaseErrorData = DefaultDataType, TBaseResultMode extends CallApiResultModeUnion = CallApiResultModeUnion, TMoreOptions extends AnyObject = DefaultMoreOptions> = Omit<CallApiExtraOptions<TBaseData, TBaseErrorData, TBaseResultMode, TMoreOptions>, (typeof optionsEnumToOmitFromBase)[number]>;
-type CombinedCallApiExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends CallApiResultModeUnion = CallApiResultModeUnion, TMoreOptions extends AnyObject = DefaultMoreOptions> = BaseCallApiExtraOptions<TData, TErrorData, TResultMode, TMoreOptions> & CallApiExtraOptions<TData, TErrorData, TResultMode, TMoreOptions>;
-type CallApiConfig<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends CallApiResultModeUnion = CallApiResultModeUnion, TMoreOptions extends AnyObject = DefaultMoreOptions> = CallApiExtraOptions<TData, TErrorData, TResultMode, TMoreOptions> & CallApiRequestOptions;
-type BaseCallApiConfig<TBaseData = DefaultDataType, TBaseErrorData = DefaultDataType, TBaseResultMode extends CallApiResultModeUnion = CallApiResultModeUnion, TBaseMoreOptions extends AnyObject = DefaultMoreOptions> = BaseCallApiExtraOptions<TBaseData, TBaseErrorData, TBaseResultMode, TBaseMoreOptions> & CallApiRequestOptions;
-type CallApiParameters<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends CallApiResultModeUnion = CallApiResultModeUnion, TMoreOptions extends AnyObject = DefaultMoreOptions> = [initURL: string, config?: CallApiConfig<TData, TErrorData, TResultMode, TMoreOptions>];
+type BaseCallApiExtraOptions<TBaseData = DefaultDataType, TBaseErrorData = DefaultDataType, TBaseResultMode extends ResultModeUnion = ResultModeUnion, TMoreOptions extends AnyObject = DefaultMoreOptions> = Omit<CallApiExtraOptions<TBaseData, TBaseErrorData, TBaseResultMode, TMoreOptions>, (typeof optionsEnumToOmitFromBase)[number]>;
+type CombinedCallApiExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TMoreOptions extends AnyObject = DefaultMoreOptions> = BaseCallApiExtraOptions<TData, TErrorData, TResultMode, TMoreOptions> & CallApiExtraOptions<TData, TErrorData, TResultMode, TMoreOptions>;
+type CallApiConfig<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TMoreOptions extends AnyObject = DefaultMoreOptions> = CallApiExtraOptions<TData, TErrorData, TResultMode, TMoreOptions> & CallApiRequestOptions;
+type BaseCallApiConfig<TBaseData = DefaultDataType, TBaseErrorData = DefaultDataType, TBaseResultMode extends ResultModeUnion = ResultModeUnion, TBaseMoreOptions extends AnyObject = DefaultMoreOptions> = BaseCallApiExtraOptions<TBaseData, TBaseErrorData, TBaseResultMode, TBaseMoreOptions> & CallApiRequestOptions;
+type CallApiParameters<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TMoreOptions extends AnyObject = DefaultMoreOptions> = [initURL: string, config?: CallApiConfig<TData, TErrorData, TResultMode, TMoreOptions>];
 type RequestContext = UnmaskType<{
     options: CombinedCallApiExtraOptions;
     request: CallApiRequestOptionsForHooks;
@@ -463,9 +463,9 @@ type ResultModeMap<TData = DefaultDataType, TErrorData = DefaultDataType> = {
     onlySuccess: CallApiResultErrorVariant<TErrorData>["data"] | CallApiResultSuccessVariant<TData>["data"];
     onlySuccessWithException: CallApiResultSuccessVariant<TData>["data"];
 };
-type CallApiResultModeUnion = {
+type ResultModeUnion = {
     [Key in keyof ResultModeMap]: Key;
 }[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<CallApiResultModeUnion> ? ResultModeMap<TData, TErrorData>[TResultMode] : never;
+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;
 
-export { type AnyObject as A, type BaseCallApiConfig as B, type CallApiResultModeUnion as C, type DefaultDataType as D, type ErrorContext as E, type GetCallApiResult as G, HTTPError as H, type Interceptors as I, type PluginInitContext as P, type Register as R, type SuccessContext as S, type CallApiConfig as a, type CallApiPlugin as b, type BaseCallApiExtraOptions as c, definePlugin as d, type CallApiExtraOptions as e, type PossibleJavaScriptError as f, type PossibleHTTPError as g, type CallApiParameters as h, type CallApiRequestOptions as i, type CallApiRequestOptionsForHooks as j, type CallApiResultErrorVariant as k, type CallApiResultSuccessVariant as l, type CombinedCallApiExtraOptions as m, type InterceptorsOrInterceptorArray as n, type PossibleJavascriptErrorNames as o, type RequestContext as p, type RequestErrorContext as q, type ResponseContext as r, type ResponseErrorContext as s, type DefaultMoreOptions as t, isHTTPError as u, isHTTPErrorInstance as v, toQueryString as w };
+export { type AnyObject as A, type BaseCallApiConfig as B, type CallApiConfig as C, type DefaultDataType as D, type ErrorContext as E, type GetCallApiResult as G, HTTPError as H, type Interceptors as I, type PluginInitContext as P, type ResultModeUnion as R, type SuccessContext as S, type CallApiPlugin 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, type DefaultMoreOptions as t, isHTTPError as u, isHTTPErrorInstance as v, toQueryString as w };