commerce-sdk-isomorphic 5.2.0 → 5.2.1

package/lib/index.esm.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node-fetch" />
 /*
 * Copyright (c) 2021, salesforce.com, inc.
 * All rights reserved.
@@ -97,6 +98,7 @@ interface ClientConfigInit<Params extends BaseUriParameters> {
         [key: string]: string;
     }) => Required<FetchOptions>["body"];
     throwOnBadResponse?: boolean;
+    throwOnMaintenanceHeader?: boolean;
 }
 /**
  * Configuration parameters common to Commerce SDK clients
@@ -112,6 +114,7 @@ declare class ClientConfig<Params extends BaseUriParameters> implements ClientCo
     fetch?: FetchFunction;
     transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
     throwOnBadResponse: boolean;
+    throwOnMaintenanceHeader: boolean;
     constructor(config: ClientConfigInit<Params>);
     static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
 }
@@ -2943,6 +2946,7 @@ declare namespace ShopperLoginApiTypes {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
+        throwOnMaintenanceHeader?: boolean;
     }
     /**
      * Configuration parameters common to Commerce SDK clients
@@ -2958,6 +2962,7 @@ declare namespace ShopperLoginApiTypes {
         fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
+        throwOnMaintenanceHeader: boolean;
         constructor(config: ClientConfigInit<Params>);
         static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
     }
@@ -10795,6 +10800,7 @@ declare namespace ShopperBasketsApiTypes {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
+        throwOnMaintenanceHeader?: boolean;
     }
     /**
      * Configuration parameters common to Commerce SDK clients
@@ -10810,6 +10816,7 @@ declare namespace ShopperBasketsApiTypes {
         fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
+        throwOnMaintenanceHeader: boolean;
         constructor(config: ClientConfigInit<Params>);
         static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
     }
@@ -21402,6 +21409,7 @@ declare namespace ShopperBasketsV2ApiTypes {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
+        throwOnMaintenanceHeader?: boolean;
     }
     /**
      * Configuration parameters common to Commerce SDK clients
@@ -21417,6 +21425,7 @@ declare namespace ShopperBasketsV2ApiTypes {
         fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
+        throwOnMaintenanceHeader: boolean;
         constructor(config: ClientConfigInit<Params>);
         static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
     }
@@ -28044,6 +28053,7 @@ declare namespace ShopperConfigurationsApiTypes {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
+        throwOnMaintenanceHeader?: boolean;
     }
     /**
      * Configuration parameters common to Commerce SDK clients
@@ -28059,6 +28069,7 @@ declare namespace ShopperConfigurationsApiTypes {
         fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
+        throwOnMaintenanceHeader: boolean;
         constructor(config: ClientConfigInit<Params>);
         static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
     }
@@ -29039,6 +29050,7 @@ declare namespace ShopperConsentsApiTypes {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
+        throwOnMaintenanceHeader?: boolean;
     }
     /**
      * Configuration parameters common to Commerce SDK clients
@@ -29054,6 +29066,7 @@ declare namespace ShopperConsentsApiTypes {
         fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
+        throwOnMaintenanceHeader: boolean;
         constructor(config: ClientConfigInit<Params>);
         static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
     }
@@ -30549,6 +30562,7 @@ declare namespace ShopperContextsApiTypes {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
+        throwOnMaintenanceHeader?: boolean;
     }
     /**
      * Configuration parameters common to Commerce SDK clients
@@ -30564,6 +30578,7 @@ declare namespace ShopperContextsApiTypes {
         fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
+        throwOnMaintenanceHeader: boolean;
         constructor(config: ClientConfigInit<Params>);
         static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
     }
@@ -36732,6 +36747,7 @@ declare namespace ShopperCustomersApiTypes {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
+        throwOnMaintenanceHeader?: boolean;
     }
     /**
      * Configuration parameters common to Commerce SDK clients
@@ -36747,6 +36763,7 @@ declare namespace ShopperCustomersApiTypes {
         fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
+        throwOnMaintenanceHeader: boolean;
         constructor(config: ClientConfigInit<Params>);
         static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
     }
@@ -46653,6 +46670,7 @@ declare namespace ShopperExperienceApiTypes {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
+        throwOnMaintenanceHeader?: boolean;
     }
     /**
      * Configuration parameters common to Commerce SDK clients
@@ -46668,6 +46686,7 @@ declare namespace ShopperExperienceApiTypes {
         fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
+        throwOnMaintenanceHeader: boolean;
         constructor(config: ClientConfigInit<Params>);
         static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
     }
@@ -48747,6 +48766,7 @@ declare namespace ShopperGiftCertificatesApiTypes {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
+        throwOnMaintenanceHeader?: boolean;
     }
     /**
      * Configuration parameters common to Commerce SDK clients
@@ -48762,6 +48782,7 @@ declare namespace ShopperGiftCertificatesApiTypes {
         fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
+        throwOnMaintenanceHeader: boolean;
         constructor(config: ClientConfigInit<Params>);
         static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
     }
@@ -51602,6 +51623,7 @@ declare namespace ShopperOrdersApiTypes {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
+        throwOnMaintenanceHeader?: boolean;
     }
     /**
      * Configuration parameters common to Commerce SDK clients
@@ -51617,6 +51639,7 @@ declare namespace ShopperOrdersApiTypes {
         fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
+        throwOnMaintenanceHeader: boolean;
         constructor(config: ClientConfigInit<Params>);
         static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
     }
@@ -56178,6 +56201,7 @@ declare namespace ShopperPaymentsApiTypes {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
+        throwOnMaintenanceHeader?: boolean;
     }
     /**
      * Configuration parameters common to Commerce SDK clients
@@ -56193,6 +56217,7 @@ declare namespace ShopperPaymentsApiTypes {
         fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
+        throwOnMaintenanceHeader: boolean;
         constructor(config: ClientConfigInit<Params>);
         static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
     }
@@ -57944,6 +57969,7 @@ declare namespace ShopperProductsApiTypes {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
+        throwOnMaintenanceHeader?: boolean;
     }
     /**
      * Configuration parameters common to Commerce SDK clients
@@ -57959,6 +57985,7 @@ declare namespace ShopperProductsApiTypes {
         fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
+        throwOnMaintenanceHeader: boolean;
         constructor(config: ClientConfigInit<Params>);
         static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
     }
@@ -60434,6 +60461,7 @@ declare namespace ShopperPromotionsApiTypes {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
+        throwOnMaintenanceHeader?: boolean;
     }
     /**
      * Configuration parameters common to Commerce SDK clients
@@ -60449,6 +60477,7 @@ declare namespace ShopperPromotionsApiTypes {
         fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
+        throwOnMaintenanceHeader: boolean;
         constructor(config: ClientConfigInit<Params>);
         static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
     }
@@ -62156,6 +62185,7 @@ declare namespace ShopperSearchApiTypes {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
+        throwOnMaintenanceHeader?: boolean;
     }
     /**
      * Configuration parameters common to Commerce SDK clients
@@ -62171,6 +62201,7 @@ declare namespace ShopperSearchApiTypes {
         fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
+        throwOnMaintenanceHeader: boolean;
         constructor(config: ClientConfigInit<Params>);
         static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
     }
@@ -64511,6 +64542,7 @@ declare namespace ShopperSEOApiTypes {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
+        throwOnMaintenanceHeader?: boolean;
     }
     /**
      * Configuration parameters common to Commerce SDK clients
@@ -64526,6 +64558,7 @@ declare namespace ShopperSEOApiTypes {
         fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
+        throwOnMaintenanceHeader: boolean;
         constructor(config: ClientConfigInit<Params>);
         static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
     }
@@ -65355,6 +65388,7 @@ declare namespace ShopperStoresApiTypes {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
+        throwOnMaintenanceHeader?: boolean;
     }
     /**
      * Configuration parameters common to Commerce SDK clients
@@ -65370,6 +65404,7 @@ declare namespace ShopperStoresApiTypes {
         fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
+        throwOnMaintenanceHeader: boolean;
         constructor(config: ClientConfigInit<Params>);
         static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
     }
@@ -66065,6 +66100,33 @@ declare class TemplateURL extends URL {
      */
     static renderTemplateUri(template: string, parameters?: PathParameters): string;
 }
+/**
+ * Extends the Error class with the the error being a combination of status code
+ * and text retrieved from the response.
+ *
+ * @class ResponseError
+ * @extends Error
+ */
+declare class ResponseError extends Error {
+    response: Response;
+    constructor(response: Response);
+}
+/**
+ * Error thrown when the sfdc_maintenance header is detected in a response
+ * and throwOnMaintenanceHeader is enabled in client configuration.
+ *
+ * @class MaintenanceError
+ * @extends Error
+ */
+declare class MaintenanceError extends Error {
+    readonly response: Response | import("node-fetch").Response;
+    readonly maintenanceType: "system" | "site";
+    readonly status = 503;
+    constructor(response: Response | import("node-fetch").Response, maintenanceType: "system" | "site");
+}
+declare module MaintenanceErrorWrapper {
+    export { MaintenanceError };
+}
 declare namespace helpers {
     /*
     * Copyright (c) 2023, Salesforce, Inc.
@@ -66161,6 +66223,7 @@ declare namespace helpers {
             [key: string]: string;
         }) => Required<FetchOptions>["body"];
         throwOnBadResponse?: boolean;
+        throwOnMaintenanceHeader?: boolean;
     }
     /**
      * Configuration parameters common to Commerce SDK clients
@@ -66176,6 +66239,7 @@ declare namespace helpers {
         fetch?: FetchFunction;
         transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
         throwOnBadResponse: boolean;
+        throwOnMaintenanceHeader: boolean;
         constructor(config: ClientConfigInit<Params>);
         static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
     }
@@ -69330,6 +69394,26 @@ declare namespace helpers {
         clientConfig: ClientConfigInit<CustomParams>;
         rawResponse?: boolean | undefined;
     }) => Promise<Response | unknown>;
+    /*
+    * Copyright (c) 2025, salesforce.com, 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
+    */
+    /**
+     * Error thrown when the sfdc_maintenance header is detected in a response
+     * and throwOnMaintenanceHeader is enabled in client configuration.
+     *
+     * @class MaintenanceError
+     * @extends Error
+     */
+    class MaintenanceError extends Error {
+        readonly response: Response | import("node-fetch").Response;
+        readonly maintenanceType: "system" | "site";
+        readonly status = 503;
+        constructor(response: Response | import("node-fetch").Response, maintenanceType: "system" | "site");
+    }
+    import __default = MaintenanceErrorWrapper.MaintenanceError;
     /**
      * A wrapper function around fetch designed for making requests using the SDK
      * @param url - The url of the resource that you wish to fetch
@@ -69361,5 +69445,5 @@ declare namespace helpers {
      */
     const encodeSCAPISpecialCharacters: (str: string) => string;
 }
-export { ShopperLogin, ShopperBaskets, ShopperBasketsV2, ShopperConfigurations, ShopperConsents, ShopperContexts, ShopperCustomers, ShopperExperience, ShopperGiftCertificates, ShopperOrders, ShopperPayments, ShopperProducts, ShopperPromotions, ShopperSearch, ShopperSEO, ShopperStores, ClientConfig, TemplateURL, helpers };
+export { ShopperLogin, ShopperBaskets, ShopperBasketsV2, ShopperConfigurations, ShopperConsents, ShopperContexts, ShopperCustomers, ShopperExperience, ShopperGiftCertificates, ShopperOrders, ShopperPayments, ShopperProducts, ShopperPromotions, ShopperSearch, ShopperSEO, ShopperStores, ClientConfig, TemplateURL, ResponseError, MaintenanceError, helpers };
 export type { ShopperLoginTypes, ShopperBasketsTypes, ShopperBasketsV2Types, ShopperConfigurationsTypes, ShopperConsentsTypes, ShopperContextsTypes, ShopperCustomersTypes, ShopperExperienceTypes, ShopperGiftCertificatesTypes, ShopperOrdersTypes, ShopperPaymentsTypes, ShopperProductsTypes, ShopperPromotionsTypes, ShopperSearchTypes, ShopperSEOTypes, ShopperStoresTypes, ClientConfigInit, FetchFunction, FetchOptions };