@zayne-labs/callapi 1.7.0 → 1.7.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ikedigwe Ebube
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,11 +1,11 @@
 <h1 align="center">CallApi - Advanced Fetch Client</h1>
 
 <p align="center">
-   <img src="../../apps/docs/public/logo.png" alt="CallApi Logo" width="50%">
+   <img src="https://github.com/zayne-labs/call-api/blob/main/packages/callapi/assets/logo.png" alt="CallApi Logo" width="30%">
 </p>
 
 <p align="center">
-   <a href="https://deno.bundlejs.com/badge?q=@zayne-labs/callapi,@zayne-labs/callapi&treeshake=%5B*%5D,%5B%7B+createFetchClient+%7D%5D&config=%7B%22compression%22:%7B%22type%22:%22brotli%22,%22quality%22:11%7D%7D"><img src="https://deno.bundlejs.com/badge?q=@zayne-labs/callapi,@zayne-labs/callapi&treeshake=%5B*%5D,%5B%7B+createFetchClient+%7D%5D&config=%7B%22compression%22:%7B%22type%22:%22brotli%22,%22quality%22:11%7D%7D" alt="bundle size"></a>
+   <!-- <a href="https://deno.bundlejs.com/badge?q=@zayne-labs/callapi,@zayne-labs/callapi&treeshake=%5B*%5D,%5B%7B+createFetchClient+%7D%5D&config=%7B%22compression%22:%7B%22type%22:%22brotli%22,%22quality%22:11%7D%7D"><img src="https://deno.bundlejs.com/badge?q=@zayne-labs/callapi,@zayne-labs/callapi&treeshake=%5B*%5D,%5B%7B+createFetchClient+%7D%5D&config=%7B%22compression%22:%7B%22type%22:%22brotli%22,%22quality%22:11%7D%7D" alt="bundle size"></a> -->
    <a href="https://www.npmjs.com/package/@zayne-labs/callapi"><img src="https://img.shields.io/npm/v/@zayne-labs/callapi?style=flat&color=EFBA5F" alt="npm version"></a>
    <a href="https://github.com/zayne-labs/call-api/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/@zayne-labs/callapi?style=flat&color=EFBA5F" alt="license"></a>
    <a href="https://github.com/zayne-labs/call-api/graphs/commit-activity"><img src="https://img.shields.io/github/commit-activity/m/zayne-labs/call-api?style=flat&color=EFBA5F" alt="commit activity"></a>

package/dist/cjs/{error-C7M77J6L.d.cts → error-By05WYGj.d.cts}

@@ -1,41 +1,3 @@
-import { StandardSchemaV1 } from '@standard-schema/spec';
-
-type StreamProgressEvent = {
-    /**
-     * Current chunk of data being streamed
-     */
-    chunk: Uint8Array;
-    /**
-     * Progress in percentage
-     */
-    progress: number;
-    /**
-     * Total size of data in bytes
-     */
-    totalBytes: number;
-    /**
-     * Amount of data transferred so far
-     */
-    transferredBytes: number;
-};
-type RequestStreamContext = {
-    event: StreamProgressEvent;
-    options: CombinedCallApiExtraOptions;
-    request: CallApiRequestOptionsForHooks;
-    requestInstance: Request;
-};
-type ResponseStreamContext = {
-    event: StreamProgressEvent;
-    options: CombinedCallApiExtraOptions;
-    request: CallApiRequestOptionsForHooks;
-    response: Response;
-};
-declare global {
-    interface ReadableStream<R> {
-        [Symbol.asyncIterator]: () => AsyncIterableIterator<R>;
-    }
-}
-
 type ValueOrFunctionResult<TValue> = TValue | (() => TValue);
 /**
  * Bearer Or Token authentication
@@ -92,6 +54,9 @@ type AnyNumber = number & {
     z_placeholder?: never;
 };
 type AnyFunction<TResult = unknown> = (...args: any) => TResult;
+type Prettify<TObject> = NonNullable<unknown> & {
+    [Key in keyof TObject]: TObject[Key];
+};
 type UnmaskType<TValue> = {
     _: TValue;
 }["_"];
@@ -100,6 +65,105 @@ type CommonRequestHeaders = "Access-Control-Allow-Credentials" | "Access-Control
 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;
 
+/**
+ * The Standard Schema interface.
+ * @see https://github.com/standard-schema/standard-schema
+ */
+interface StandardSchemaV1<Input = unknown, Output = Input> {
+    /**
+     * The Standard Schema properties.
+     */
+    readonly "~standard": StandardSchemaV1.Props<Input, Output>;
+}
+declare namespace StandardSchemaV1 {
+    /**
+     * The Standard Schema properties interface.
+     */
+    interface Props<Input = unknown, Output = Input> {
+        /**
+         * Inferred types associated with the schema.
+         */
+        readonly types?: Types<Input, Output> | undefined;
+        /**
+         * Validates unknown input values.
+         */
+        readonly validate: (value: unknown) => Promise<Result<Output>> | Result<Output>;
+        /**
+         * The vendor name of the schema library.
+         */
+        readonly vendor: string;
+        /**
+         * The version number of the standard.
+         */
+        readonly version: 1;
+    }
+    /**
+     * The result interface of the validate function.
+     */
+    type Result<Output> = FailureResult | SuccessResult<Output>;
+    /**
+     * The result interface if validation succeeds.
+     */
+    interface SuccessResult<Output> {
+        /**
+         * The non-existent issues.
+         */
+        readonly issues?: undefined;
+        /**
+         * The typed output value.
+         */
+        readonly value: Output;
+    }
+    /**
+     * The result interface if validation fails.
+     */
+    interface FailureResult {
+        /**
+         * The issues of failed validation.
+         */
+        readonly issues: readonly Issue[];
+    }
+    /**
+     * The issue interface of the failure output.
+     */
+    interface Issue {
+        /**
+         * The error message of the issue.
+         */
+        readonly message: string;
+        /**
+         * The path of the issue, if any.
+         */
+        readonly path?: ReadonlyArray<PathSegment | PropertyKey> | undefined;
+    }
+    /**
+     * The path segment interface of the issue.
+     */
+    interface PathSegment {
+        /**
+         * The key representing a path segment.
+         */
+        readonly key: PropertyKey;
+    }
+    /**
+     * The Standard Schema types interface.
+     */
+    interface Types<Input = unknown, Output = Input> {
+        /** The input type of the schema. */
+        readonly input: Input;
+        /** The output type of the schema. */
+        readonly output: Output;
+    }
+    /**
+     * Infers the input type of a Standard Schema.
+     */
+    type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema["~standard"]["types"]>["input"];
+    /**
+     * Infers the output type of a Standard Schema.
+     */
+    type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema["~standard"]["types"]>["output"];
+}
+
 interface CallApiSchemas {
     /**
      *  The schema to use for validating the request body.
@@ -233,6 +297,42 @@ type ResponseTypeMap<TResponse> = {
 };
 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 StreamProgressEvent = {
+    /**
+     * Current chunk of data being streamed
+     */
+    chunk: Uint8Array;
+    /**
+     * Progress in percentage
+     */
+    progress: number;
+    /**
+     * Total size of data in bytes
+     */
+    totalBytes: number;
+    /**
+     * Amount of data transferred so far
+     */
+    transferredBytes: number;
+};
+type RequestStreamContext = {
+    event: StreamProgressEvent;
+    options: CombinedCallApiExtraOptions;
+    request: CallApiRequestOptionsForHooks;
+    requestInstance: Request;
+};
+type ResponseStreamContext = {
+    event: StreamProgressEvent;
+    options: CombinedCallApiExtraOptions;
+    request: CallApiRequestOptionsForHooks;
+    response: Response;
+};
+declare global {
+    interface ReadableStream<R> {
+        [Symbol.asyncIterator]: () => AsyncIterableIterator<R>;
+    }
+}
+
 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"]>>>>;
@@ -280,9 +380,9 @@ declare const definePlugin: <TPlugin extends CallApiPlugin | AnyFunction<CallApi
 type Plugins<TPluginArray extends CallApiPlugin[]> = TPluginArray;
 
 type ModifiedRequestInit = RequestInit & {
-    duplex?: "full" | "half" | "none";
+    duplex?: "half";
 };
-declare const fetchSpecificKeys: ("body" | "cache" | "credentials" | "headers" | "integrity" | "keepalive" | "method" | "mode" | "priority" | "redirect" | "referrer" | "referrerPolicy" | "signal" | "window" | "duplex")[];
+declare const fetchSpecificKeys: (keyof RequestInit | "duplex")[];
 declare const getDefaultOptions: () => {
     baseURL: string;
     bodySerializer: {
@@ -374,7 +474,7 @@ type ResultModeOption<TErrorData, TResultMode extends ResultModeUnion> = TErrorD
 };
 
 type FetchSpecificKeysUnion = Exclude<(typeof fetchSpecificKeys)[number], "body" | "headers" | "method">;
-type CallApiRequestOptions<TSchemas extends CallApiSchemas = DefaultMoreOptions> = BodyOption<TSchemas> & HeadersOption<TSchemas> & MethodOption<TSchemas> & Pick<ModifiedRequestInit, FetchSpecificKeysUnion>;
+type CallApiRequestOptions<TSchemas extends CallApiSchemas = DefaultMoreOptions> = Prettify<BodyOption<TSchemas> & HeadersOption<TSchemas> & MethodOption<TSchemas> & Pick<ModifiedRequestInit, FetchSpecificKeysUnion>>;
 type CallApiRequestOptionsForHooks<TSchemas extends CallApiSchemas = DefaultMoreOptions> = Omit<CallApiRequestOptions<TSchemas>, "headers"> & {
     headers?: Record<string, string | undefined>;
 };
@@ -486,7 +586,7 @@ type ExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResult
     mergedHooksExecutionMode?: "parallel" | "sequential";
     /**
      * - Controls what order in which the merged hooks execute
-     * @default "mainHooksLast"
+     * @default "mainHooksAfterPlugins"
      */
     mergedHooksExecutionOrder?: "mainHooksAfterPlugins" | "mainHooksBeforePlugins";
     /**
@@ -535,7 +635,17 @@ type CallApiExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType,
     extend?: Pick<ExtraOptions<TData, TErrorData, TResultMode, TThrowOnError, TResponseType, TPluginArray, TSchemas>, (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, TBasePluginArray extends CallApiPlugin[] = DefaultPluginArray, TBaseSchemas extends CallApiSchemas = DefaultMoreOptions> = Omit<Partial<CallApiExtraOptions<TBaseData, TBaseErrorData, TBaseResultMode, TBaseThrowOnError, TBaseResponseType, TBasePluginArray, TBaseSchemas>>, (typeof optionsEnumToOmitFromBase)[number]>;
+type BaseCallApiExtraOptions<TBaseData = DefaultDataType, TBaseErrorData = DefaultDataType, TBaseResultMode extends ResultModeUnion = ResultModeUnion, TBaseThrowOnError extends boolean = DefaultThrowOnError, TBaseResponseType extends ResponseTypeUnion = ResponseTypeUnion, TBasePluginArray extends CallApiPlugin[] = DefaultPluginArray, TBaseSchemas extends CallApiSchemas = DefaultMoreOptions> = Omit<Partial<CallApiExtraOptions<TBaseData, TBaseErrorData, TBaseResultMode, TBaseThrowOnError, TBaseResponseType, TBasePluginArray, TBaseSchemas>>, (typeof optionsEnumToOmitFromBase)[number]> & {
+    /**
+     * If true, the base options will not be merged with the main options by default.
+     *
+     * It's recommended to set this to true when you want to handle the options merge manually from the createFetchClient config function signature.
+     *
+     * This helps prevent main options from overriding base options by default.
+     * @default false
+     */
+    mergeMainOptionsManuallyFromBase?: boolean;
+};
 type CombinedCallApiExtraOptions = Interceptors & Omit<BaseCallApiExtraOptions & CallApiExtraOptions, keyof Interceptors>;
 type BaseCallApiConfig<TBaseData = DefaultDataType, TBaseErrorData = DefaultDataType, TBaseResultMode extends ResultModeUnion = ResultModeUnion, TBaseThrowOnError extends boolean = DefaultThrowOnError, TBaseResponseType extends ResponseTypeUnion = ResponseTypeUnion, TBasePluginArray extends CallApiPlugin[] = DefaultPluginArray, TBaseSchemas extends CallApiSchemas = DefaultMoreOptions> = (CallApiRequestOptions<TBaseSchemas> & BaseCallApiExtraOptions<TBaseData, TBaseErrorData, TBaseResultMode, TBaseThrowOnError, TBaseResponseType, TBasePluginArray, TBaseSchemas>) | ((context: {
     initURL: string;

package/dist/cjs/index.cjs

@@ -784,7 +784,7 @@ var createFetchClient = (baseConfig = {}) => {
     const mergedExtraOptions = {
       ...defaultExtraOptions,
       ...baseExtraOptions,
-      ...extraOptions
+      ...!baseExtraOptions.mergeMainOptionsManuallyFromBase && extraOptions
     };
     const mergedRequestOptions = {
       ...defaultRequestOptions,