commerce-sdk-isomorphic 4.0.1-preview-shopper-test.0 → 4.1.0

package/lib/index.esm.d.ts

@@ -77,6 +77,7 @@ type BrowserRequestInit = RequestInit;
  * Using the right properties in the right context is left to the user.
  */
 type FetchOptions = NodeRequestInit & BrowserRequestInit;
+type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
 /**
  * Base options that can be passed to the `ClientConfig` class.
  */
@@ -88,12 +89,12 @@ interface ClientConfigInit<Params extends BaseUriParameters> {
     };
     parameters: Params;
     fetchOptions?: FetchOptions;
+    fetch?: FetchFunction;
     transformRequest?: (data: unknown, headers: {
         [key: string]: string;
     }) => Required<FetchOptions>["body"];
     throwOnBadResponse?: boolean;
 }
-type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
 /**
  * Configuration parameters common to Commerce SDK clients
  */
@@ -105,6 +106,7 @@ declare class ClientConfig<Params extends BaseUriParameters> implements ClientCo
     };
     parameters: Params;
     fetchOptions: FetchOptions;
+    fetch?: FetchFunction;
     transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
     throwOnBadResponse: boolean;
     constructor(config: ClientConfigInit<Params>);
@@ -4569,6 +4571,7 @@ declare namespace ShopperBasketsApiTypes {
      * Using the right properties in the right context is left to the user.
      */
     type FetchOptions = NodeRequestInit & BrowserRequestInit;
+    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Base options that can be passed to the `ClientConfig` class.
      */
@@ -4580,12 +4583,12 @@ declare namespace ShopperBasketsApiTypes {
         };
         parameters: Params;
         fetchOptions?: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest?: (data: unknown, headers: {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
     }
-    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Configuration parameters common to Commerce SDK clients
      */
@@ -4597,6 +4600,7 @@ declare namespace ShopperBasketsApiTypes {
         };
         parameters: Params;
         fetchOptions: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
         constructor(config: ClientConfigInit<Params>);
@@ -14787,6 +14791,7 @@ declare namespace ShopperBasketsV2ApiTypes {
      * Using the right properties in the right context is left to the user.
      */
     type FetchOptions = NodeRequestInit & BrowserRequestInit;
+    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Base options that can be passed to the `ClientConfig` class.
      */
@@ -14798,12 +14803,12 @@ declare namespace ShopperBasketsV2ApiTypes {
         };
         parameters: Params;
         fetchOptions?: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest?: (data: unknown, headers: {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
     }
-    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Configuration parameters common to Commerce SDK clients
      */
@@ -14815,6 +14820,7 @@ declare namespace ShopperBasketsV2ApiTypes {
         };
         parameters: Params;
         fetchOptions: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
         constructor(config: ClientConfigInit<Params>);
@@ -21018,6 +21024,7 @@ declare namespace ShopperConsentsApiTypes {
      * Using the right properties in the right context is left to the user.
      */
     type FetchOptions = NodeRequestInit & BrowserRequestInit;
+    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Base options that can be passed to the `ClientConfig` class.
      */
@@ -21029,12 +21036,12 @@ declare namespace ShopperConsentsApiTypes {
         };
         parameters: Params;
         fetchOptions?: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest?: (data: unknown, headers: {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
     }
-    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Configuration parameters common to Commerce SDK clients
      */
@@ -21046,6 +21053,7 @@ declare namespace ShopperConsentsApiTypes {
         };
         parameters: Params;
         fetchOptions: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
         constructor(config: ClientConfigInit<Params>);
@@ -22178,6 +22186,7 @@ declare namespace ShopperContextsApiTypes {
      * Using the right properties in the right context is left to the user.
      */
     type FetchOptions = NodeRequestInit & BrowserRequestInit;
+    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Base options that can be passed to the `ClientConfig` class.
      */
@@ -22189,12 +22198,12 @@ declare namespace ShopperContextsApiTypes {
         };
         parameters: Params;
         fetchOptions?: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest?: (data: unknown, headers: {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
     }
-    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Configuration parameters common to Commerce SDK clients
      */
@@ -22206,6 +22215,7 @@ declare namespace ShopperContextsApiTypes {
         };
         parameters: Params;
         fetchOptions: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
         constructor(config: ClientConfigInit<Params>);
@@ -27560,6 +27570,7 @@ declare namespace ShopperCustomersApiTypes {
      * Using the right properties in the right context is left to the user.
      */
     type FetchOptions = NodeRequestInit & BrowserRequestInit;
+    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Base options that can be passed to the `ClientConfig` class.
      */
@@ -27571,12 +27582,12 @@ declare namespace ShopperCustomersApiTypes {
         };
         parameters: Params;
         fetchOptions?: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest?: (data: unknown, headers: {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
     }
-    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Configuration parameters common to Commerce SDK clients
      */
@@ -27588,6 +27599,7 @@ declare namespace ShopperCustomersApiTypes {
         };
         parameters: Params;
         fetchOptions: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
         constructor(config: ClientConfigInit<Params>);
@@ -35349,6 +35361,7 @@ declare namespace ShopperExperienceApiTypes {
      * Using the right properties in the right context is left to the user.
      */
     type FetchOptions = NodeRequestInit & BrowserRequestInit;
+    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Base options that can be passed to the `ClientConfig` class.
      */
@@ -35360,12 +35373,12 @@ declare namespace ShopperExperienceApiTypes {
         };
         parameters: Params;
         fetchOptions?: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest?: (data: unknown, headers: {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
     }
-    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Configuration parameters common to Commerce SDK clients
      */
@@ -35377,6 +35390,7 @@ declare namespace ShopperExperienceApiTypes {
         };
         parameters: Params;
         fetchOptions: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
         constructor(config: ClientConfigInit<Params>);
@@ -36207,6 +36221,7 @@ declare namespace ShopperGiftCertificatesApiTypes {
      * Using the right properties in the right context is left to the user.
      */
     type FetchOptions = NodeRequestInit & BrowserRequestInit;
+    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Base options that can be passed to the `ClientConfig` class.
      */
@@ -36218,12 +36233,12 @@ declare namespace ShopperGiftCertificatesApiTypes {
         };
         parameters: Params;
         fetchOptions?: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest?: (data: unknown, headers: {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
     }
-    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Configuration parameters common to Commerce SDK clients
      */
@@ -36235,6 +36250,7 @@ declare namespace ShopperGiftCertificatesApiTypes {
         };
         parameters: Params;
         fetchOptions: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
         constructor(config: ClientConfigInit<Params>);
@@ -38329,6 +38345,7 @@ declare namespace ShopperLoginApiTypes {
      * Using the right properties in the right context is left to the user.
      */
     type FetchOptions = NodeRequestInit & BrowserRequestInit;
+    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Base options that can be passed to the `ClientConfig` class.
      */
@@ -38340,12 +38357,12 @@ declare namespace ShopperLoginApiTypes {
         };
         parameters: Params;
         fetchOptions?: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest?: (data: unknown, headers: {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
     }
-    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Configuration parameters common to Commerce SDK clients
      */
@@ -38357,6 +38374,7 @@ declare namespace ShopperLoginApiTypes {
         };
         parameters: Params;
         fetchOptions: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
         constructor(config: ClientConfigInit<Params>);
@@ -42242,6 +42260,7 @@ declare namespace ShopperOrdersApiTypes {
      * Using the right properties in the right context is left to the user.
      */
     type FetchOptions = NodeRequestInit & BrowserRequestInit;
+    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Base options that can be passed to the `ClientConfig` class.
      */
@@ -42253,12 +42272,12 @@ declare namespace ShopperOrdersApiTypes {
         };
         parameters: Params;
         fetchOptions?: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest?: (data: unknown, headers: {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
     }
-    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Configuration parameters common to Commerce SDK clients
      */
@@ -42270,6 +42289,7 @@ declare namespace ShopperOrdersApiTypes {
         };
         parameters: Params;
         fetchOptions: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
         constructor(config: ClientConfigInit<Params>);
@@ -46810,6 +46830,7 @@ declare namespace ShopperProductsApiTypes {
      * Using the right properties in the right context is left to the user.
      */
     type FetchOptions = NodeRequestInit & BrowserRequestInit;
+    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Base options that can be passed to the `ClientConfig` class.
      */
@@ -46821,12 +46842,12 @@ declare namespace ShopperProductsApiTypes {
         };
         parameters: Params;
         fetchOptions?: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest?: (data: unknown, headers: {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
     }
-    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Configuration parameters common to Commerce SDK clients
      */
@@ -46838,6 +46859,7 @@ declare namespace ShopperProductsApiTypes {
         };
         parameters: Params;
         fetchOptions: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
         constructor(config: ClientConfigInit<Params>);
@@ -49246,6 +49268,7 @@ declare namespace ShopperPromotionsApiTypes {
      * Using the right properties in the right context is left to the user.
      */
     type FetchOptions = NodeRequestInit & BrowserRequestInit;
+    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Base options that can be passed to the `ClientConfig` class.
      */
@@ -49257,12 +49280,12 @@ declare namespace ShopperPromotionsApiTypes {
         };
         parameters: Params;
         fetchOptions?: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest?: (data: unknown, headers: {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
     }
-    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Configuration parameters common to Commerce SDK clients
      */
@@ -49274,6 +49297,7 @@ declare namespace ShopperPromotionsApiTypes {
         };
         parameters: Params;
         fetchOptions: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
         constructor(config: ClientConfigInit<Params>);
@@ -50937,6 +50961,7 @@ declare namespace ShopperSearchApiTypes {
      * Using the right properties in the right context is left to the user.
      */
     type FetchOptions = NodeRequestInit & BrowserRequestInit;
+    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Base options that can be passed to the `ClientConfig` class.
      */
@@ -50948,12 +50973,12 @@ declare namespace ShopperSearchApiTypes {
         };
         parameters: Params;
         fetchOptions?: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest?: (data: unknown, headers: {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
     }
-    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Configuration parameters common to Commerce SDK clients
      */
@@ -50965,6 +50990,7 @@ declare namespace ShopperSearchApiTypes {
         };
         parameters: Params;
         fetchOptions: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
         constructor(config: ClientConfigInit<Params>);
@@ -53227,6 +53253,7 @@ declare namespace ShopperSEOApiTypes {
      * Using the right properties in the right context is left to the user.
      */
     type FetchOptions = NodeRequestInit & BrowserRequestInit;
+    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Base options that can be passed to the `ClientConfig` class.
      */
@@ -53238,12 +53265,12 @@ declare namespace ShopperSEOApiTypes {
         };
         parameters: Params;
         fetchOptions?: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest?: (data: unknown, headers: {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
     }
-    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Configuration parameters common to Commerce SDK clients
      */
@@ -53255,6 +53282,7 @@ declare namespace ShopperSEOApiTypes {
         };
         parameters: Params;
         fetchOptions: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
         constructor(config: ClientConfigInit<Params>);
@@ -54054,6 +54082,7 @@ declare namespace ShopperStoresApiTypes {
      * Using the right properties in the right context is left to the user.
      */
     type FetchOptions = NodeRequestInit & BrowserRequestInit;
+    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Base options that can be passed to the `ClientConfig` class.
      */
@@ -54065,12 +54094,12 @@ declare namespace ShopperStoresApiTypes {
         };
         parameters: Params;
         fetchOptions?: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest?: (data: unknown, headers: {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
     }
-    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Configuration parameters common to Commerce SDK clients
      */
@@ -54082,6 +54111,7 @@ declare namespace ShopperStoresApiTypes {
         };
         parameters: Params;
         fetchOptions: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
         constructor(config: ClientConfigInit<Params>);
@@ -54843,6 +54873,7 @@ declare namespace helpers {
      * Using the right properties in the right context is left to the user.
      */
     type FetchOptions = NodeRequestInit & BrowserRequestInit;
+    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Base options that can be passed to the `ClientConfig` class.
      */
@@ -54854,12 +54885,12 @@ declare namespace helpers {
         };
         parameters: Params;
         fetchOptions?: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest?: (data: unknown, headers: {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
     }
-    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
     /**
      * Configuration parameters common to Commerce SDK clients
      */
@@ -54871,23 +54902,22 @@ declare namespace helpers {
         };
         parameters: Params;
         fetchOptions: FetchOptions;
+        fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
         constructor(config: ClientConfigInit<Params>);
         static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
     }
-    /*
-    * Copyright (c) 2022, Salesforce, Inc.
-    * All rights reserved.
-    * SPDX-License-Identifier: BSD-3-Clause
-    * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
-    */
     const isBrowser: boolean;
     const isNode: boolean;
     const globalObject: typeof globalThis;
     const hasFetchAvailable: boolean;
-    // TODO: Remove this function in the next major version
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    // TODO: Adopt native fetch in the next major version.
+    // Using the built-in fetch (Node 18+) caused downstream unit tests that rely on
+    // `nock` to fail because `nock` hooks into the core HTTP/HTTPS modules, while
+    // the native fetch implementation leverages undici instead. Until we can roll
+    // out a coordinated breaking change, we continue to use the node-fetch
+    // polyfill so existing tests keep passing.
     const fetch: FetchFunction;
     /**
      * Grant Type
@@ -57027,6 +57057,9 @@ declare const pkg: {
     ShopperSearch: typeof ShopperSearch;
     ShopperSEO: typeof ShopperSEO;
     ShopperStores: typeof ShopperStores;
+    helpers: typeof helpers;
+    ClientConfig: typeof ClientConfig;
+    TemplateURL: typeof TemplateURL;
 };
 export { pkg as default, ShopperBaskets, ShopperBasketsV2, ShopperConsents, ShopperContexts, ShopperCustomers, ShopperExperience, ShopperGiftCertificates, ShopperLogin, ShopperOrders, ShopperProducts, ShopperPromotions, ShopperSearch, ShopperSEO, ShopperStores, ClientConfig, TemplateURL, helpers };
 export type { ShopperBasketsTypes, ShopperBasketsV2Types, ShopperConsentsTypes, ShopperContextsTypes, ShopperCustomersTypes, ShopperExperienceTypes, ShopperGiftCertificatesTypes, ShopperLoginTypes, ShopperOrdersTypes, ShopperProductsTypes, ShopperPromotionsTypes, ShopperSearchTypes, ShopperSEOTypes, ShopperStoresTypes, ClientConfigInit, FetchFunction, FetchOptions };