commerce-sdk-isomorphic 3.2.0 → 3.3.0

package/lib/index.esm.d.ts

@@ -49,6 +49,22 @@ interface PathParameters {
 interface QueryParameters {
     [key: string]: string | number | boolean | string[] | number[];
 }
+/**
+ * Custom query parameter type with any string prefixed with `c_` as the key and the allowed
+ * types for query parameters for the value.
+ */
+type CustomQueryParameters = {
+    [key in `c_${string}`]: string | number | boolean | string[] | number[];
+};
+/**
+ * Custom body request type with any string prefixed with `c_` as the key and the allowed
+ * types for the value.
+ */
+type CustomRequestBody = {
+    [key in `c_${string}`]: string | number | boolean | string[] | number[] | {
+        [key: string]: unknown;
+    };
+};
 /**
  * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
  * it from the `RequestInit` provided by node-fetch.
@@ -4194,6 +4210,22 @@ declare namespace ShopperBasketsTypes {
      * Generic interface for all parameter types.
      */
     type UrlParameters = PathParameters | QueryParameters;
+    /**
+     * Custom query parameter type with any string prefixed with `c_` as the key and the allowed
+     * types for query parameters for the value.
+     */
+    type CustomQueryParameters = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[];
+    };
+    /**
+     * Custom body request type with any string prefixed with `c_` as the key and the allowed
+     * types for the value.
+     */
+    type CustomRequestBody = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[] | {
+            [key: string]: unknown;
+        };
+    };
     /**
      * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
      * it from the `RequestInit` provided by node-fetch.
@@ -9069,6 +9101,22 @@ declare namespace ShopperContextsTypes {
      * Generic interface for all parameter types.
      */
     type UrlParameters = PathParameters | QueryParameters;
+    /**
+     * Custom query parameter type with any string prefixed with `c_` as the key and the allowed
+     * types for query parameters for the value.
+     */
+    type CustomQueryParameters = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[];
+    };
+    /**
+     * Custom body request type with any string prefixed with `c_` as the key and the allowed
+     * types for the value.
+     */
+    type CustomRequestBody = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[] | {
+            [key: string]: unknown;
+        };
+    };
     /**
      * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
      * it from the `RequestInit` provided by node-fetch.
@@ -12981,6 +13029,22 @@ declare namespace ShopperCustomersTypes {
      * Generic interface for all parameter types.
      */
     type UrlParameters = PathParameters | QueryParameters;
+    /**
+     * Custom query parameter type with any string prefixed with `c_` as the key and the allowed
+     * types for query parameters for the value.
+     */
+    type CustomQueryParameters = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[];
+    };
+    /**
+     * Custom body request type with any string prefixed with `c_` as the key and the allowed
+     * types for the value.
+     */
+    type CustomRequestBody = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[] | {
+            [key: string]: unknown;
+        };
+    };
     /**
      * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
      * it from the `RequestInit` provided by node-fetch.
@@ -16787,6 +16851,22 @@ declare namespace ShopperDiscoverySearchTypes {
      * Generic interface for all parameter types.
      */
     type UrlParameters = PathParameters | QueryParameters;
+    /**
+     * Custom query parameter type with any string prefixed with `c_` as the key and the allowed
+     * types for query parameters for the value.
+     */
+    type CustomQueryParameters = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[];
+    };
+    /**
+     * Custom body request type with any string prefixed with `c_` as the key and the allowed
+     * types for the value.
+     */
+    type CustomRequestBody = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[] | {
+            [key: string]: unknown;
+        };
+    };
     /**
      * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
      * it from the `RequestInit` provided by node-fetch.
@@ -17915,6 +17995,22 @@ declare namespace ShopperExperienceTypes {
      * Generic interface for all parameter types.
      */
     type UrlParameters = PathParameters | QueryParameters;
+    /**
+     * Custom query parameter type with any string prefixed with `c_` as the key and the allowed
+     * types for query parameters for the value.
+     */
+    type CustomQueryParameters = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[];
+    };
+    /**
+     * Custom body request type with any string prefixed with `c_` as the key and the allowed
+     * types for the value.
+     */
+    type CustomRequestBody = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[] | {
+            [key: string]: unknown;
+        };
+    };
     /**
      * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
      * it from the `RequestInit` provided by node-fetch.
@@ -18823,6 +18919,22 @@ declare namespace ShopperGiftCertificatesTypes {
      * Generic interface for all parameter types.
      */
     type UrlParameters = PathParameters | QueryParameters;
+    /**
+     * Custom query parameter type with any string prefixed with `c_` as the key and the allowed
+     * types for query parameters for the value.
+     */
+    type CustomQueryParameters = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[];
+    };
+    /**
+     * Custom body request type with any string prefixed with `c_` as the key and the allowed
+     * types for the value.
+     */
+    type CustomRequestBody = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[] | {
+            [key: string]: unknown;
+        };
+    };
     /**
      * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
      * it from the `RequestInit` provided by node-fetch.
@@ -20582,6 +20694,22 @@ declare namespace ShopperOrdersTypes {
      * Generic interface for all parameter types.
      */
     type UrlParameters = PathParameters | QueryParameters;
+    /**
+     * Custom query parameter type with any string prefixed with `c_` as the key and the allowed
+     * types for query parameters for the value.
+     */
+    type CustomQueryParameters = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[];
+    };
+    /**
+     * Custom body request type with any string prefixed with `c_` as the key and the allowed
+     * types for the value.
+     */
+    type CustomRequestBody = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[] | {
+            [key: string]: unknown;
+        };
+    };
     /**
      * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
      * it from the `RequestInit` provided by node-fetch.
@@ -22917,6 +23045,22 @@ declare namespace ShopperProductsTypes {
      * Generic interface for all parameter types.
      */
     type UrlParameters = PathParameters | QueryParameters;
+    /**
+     * Custom query parameter type with any string prefixed with `c_` as the key and the allowed
+     * types for query parameters for the value.
+     */
+    type CustomQueryParameters = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[];
+    };
+    /**
+     * Custom body request type with any string prefixed with `c_` as the key and the allowed
+     * types for the value.
+     */
+    type CustomRequestBody = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[] | {
+            [key: string]: unknown;
+        };
+    };
     /**
      * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
      * it from the `RequestInit` provided by node-fetch.
@@ -24280,6 +24424,22 @@ declare namespace ShopperPromotionsTypes {
      * Generic interface for all parameter types.
      */
     type UrlParameters = PathParameters | QueryParameters;
+    /**
+     * Custom query parameter type with any string prefixed with `c_` as the key and the allowed
+     * types for query parameters for the value.
+     */
+    type CustomQueryParameters = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[];
+    };
+    /**
+     * Custom body request type with any string prefixed with `c_` as the key and the allowed
+     * types for the value.
+     */
+    type CustomRequestBody = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[] | {
+            [key: string]: unknown;
+        };
+    };
     /**
      * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
      * it from the `RequestInit` provided by node-fetch.
@@ -25503,6 +25663,22 @@ declare namespace ShopperSearchTypes {
      * Generic interface for all parameter types.
      */
     type UrlParameters = PathParameters | QueryParameters;
+    /**
+     * Custom query parameter type with any string prefixed with `c_` as the key and the allowed
+     * types for query parameters for the value.
+     */
+    type CustomQueryParameters = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[];
+    };
+    /**
+     * Custom body request type with any string prefixed with `c_` as the key and the allowed
+     * types for the value.
+     */
+    type CustomRequestBody = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[] | {
+            [key: string]: unknown;
+        };
+    };
     /**
      * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
      * it from the `RequestInit` provided by node-fetch.
@@ -26650,6 +26826,22 @@ declare namespace ShopperSeoTypes {
      * Generic interface for all parameter types.
      */
     type UrlParameters = PathParameters | QueryParameters;
+    /**
+     * Custom query parameter type with any string prefixed with `c_` as the key and the allowed
+     * types for query parameters for the value.
+     */
+    type CustomQueryParameters = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[];
+    };
+    /**
+     * Custom body request type with any string prefixed with `c_` as the key and the allowed
+     * types for the value.
+     */
+    type CustomRequestBody = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[] | {
+            [key: string]: unknown;
+        };
+    };
     /**
      * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
      * it from the `RequestInit` provided by node-fetch.
@@ -27591,6 +27783,22 @@ declare namespace ShopperStoresTypes {
      * Generic interface for all parameter types.
      */
     type UrlParameters = PathParameters | QueryParameters;
+    /**
+     * Custom query parameter type with any string prefixed with `c_` as the key and the allowed
+     * types for query parameters for the value.
+     */
+    type CustomQueryParameters = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[];
+    };
+    /**
+     * Custom body request type with any string prefixed with `c_` as the key and the allowed
+     * types for the value.
+     */
+    type CustomRequestBody = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[] | {
+            [key: string]: unknown;
+        };
+    };
     /**
      * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
      * it from the `RequestInit` provided by node-fetch.
@@ -29821,6 +30029,22 @@ declare namespace ShopperLoginTypes {
      * Generic interface for all parameter types.
      */
     type UrlParameters = PathParameters | QueryParameters;
+    /**
+     * Custom query parameter type with any string prefixed with `c_` as the key and the allowed
+     * types for query parameters for the value.
+     */
+    type CustomQueryParameters = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[];
+    };
+    /**
+     * Custom body request type with any string prefixed with `c_` as the key and the allowed
+     * types for the value.
+     */
+    type CustomRequestBody = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[] | {
+            [key: string]: unknown;
+        };
+    };
     /**
      * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
      * it from the `RequestInit` provided by node-fetch.
@@ -31680,6 +31904,22 @@ declare namespace helpers {
      * Generic interface for all parameter types.
      */
     type UrlParameters = PathParameters | QueryParameters;
+    /**
+     * Custom query parameter type with any string prefixed with `c_` as the key and the allowed
+     * types for query parameters for the value.
+     */
+    type CustomQueryParameters = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[];
+    };
+    /**
+     * Custom body request type with any string prefixed with `c_` as the key and the allowed
+     * types for the value.
+     */
+    type CustomRequestBody = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[] | {
+            [key: string]: unknown;
+        };
+    };
     /**
      * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
      * it from the `RequestInit` provided by node-fetch.
@@ -33492,10 +33732,11 @@ declare namespace helpers {
      * Wrapper for the authorization endpoint. For federated login (3rd party IDP non-guest), the caller should redirect the user to the url in the url field of the returned object. The url will be the login page for the 3rd party IDP and the user will be sent to the redirectURI on success. Guest sessions return the code and usid directly with no need to redirect.
      * @param slasClient a configured instance of the ShopperLogin SDK client
      * @param codeVerifier - random string created by client app to use as a secret in the request
-     * @param parameters - Request parameters used by the `authorizeCustomer` endpoint.
+     * @param parameters - Request parameters used by the `authorizeCustomer` endpoint. Custom parameters can be passed on by adding a property on the `parameters` object starting with `c_`
      * @param parameters.redirectURI - the location the client will be returned to after successful login with 3rd party IDP. Must be registered in SLAS.
      * @param parameters.hint? - optional string to hint at a particular IDP. Guest sessions are created by setting this to 'guest'
      * @param parameters.usid? - optional saved SLAS user id to link the new session to a previous session
+     * @param privateClient? - flag to indicate if the client is private or not. Defaults to false.
      * @returns login url, user id and authorization code if available
      */
     function authorize(slasClient: ShopperLogin<{
@@ -33507,7 +33748,7 @@ declare namespace helpers {
         redirectURI: string;
         hint?: string;
         usid?: string;
-    }, privateClient?: boolean): Promise<{
+    } & CustomQueryParameters, privateClient?: boolean): Promise<{
         code: string;
         url: string;
         usid: string;
@@ -33515,7 +33756,7 @@ declare namespace helpers {
     /**
      * Function to return the URL of the authorization endpoint. The url will redirect to the login page for the 3rd party IDP and the user will be sent to the redirectURI on success. Guest sessions return the code and usid directly with no need to redirect.
      * @param slasClient a configured instance of the ShopperLogin SDK client
-     * @param parameters - Request parameters used by the `authorizeCustomer` endpoint.
+     * @param parameters - Request parameters used by the `authorizeCustomer` endpoint. Custom parameters can be passed on by adding a property on the `parameters` object starting with `c_`
      * @param parameters.redirectURI - the location the client will be returned to after successful login with 3rd party IDP. Must be registered in SLAS.
      * @param parameters.hint - string to hint at a particular IDP. Required for 3rd party IDP login.
      * @param parameters.usid? - optional saved SLAS user id to link the new session to a previous session
@@ -33532,7 +33773,7 @@ declare namespace helpers {
         redirectURI: string;
         hint: string;
         usid?: string;
-    }, privateClient?: boolean): Promise<{
+    } & CustomQueryParameters, privateClient?: boolean): Promise<{
         url: string;
         codeVerifier: string;
     }>;
@@ -33588,7 +33829,7 @@ declare namespace helpers {
     /**
      * A single function to execute the ShopperLogin Public Client Guest Login with proof key for code exchange flow as described in the [API documentation](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary).
      * @param slasClient a configured instance of the ShopperLogin SDK client.
-     * @param parameters - parameters to pass in the API calls.
+     * @param parameters - parameters to pass in the API calls. Custom parameters can be passed on by adding a property on the `parameters` object starting with `c_`, and they will be passed on the `authorizeCustomer` call.
      * @param parameters.redirectURI - Per OAuth standard, a valid app route. Must be listed in your SLAS configuration. On server, this will not be actually called. On browser, this will be called, but ignored.
      * @param parameters.usid? - Unique Shopper Identifier to enable personalization.
      * @param parameters.dnt? - Optional parameter to enable Do Not Track (DNT) for the user.
@@ -33603,7 +33844,7 @@ declare namespace helpers {
         redirectURI: string;
         usid?: string;
         dnt?: boolean;
-    }): Promise<TokenResponse>;
+    } & CustomQueryParameters): Promise<TokenResponse>;
     /**
      * A single function to execute the ShopperLogin Public Client Registered User B2C Login with proof key for code exchange flow as described in the [API documentation](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary).
      * **Note**: this func can run on client side. Only use private slas when the slas client secret is secured.
@@ -33616,6 +33857,8 @@ declare namespace helpers {
      * @param parameters.redirectURI - Per OAuth standard, a valid app route. Must be listed in your SLAS configuration. On server, this will not be actually called. On browser, this will be called, but ignored.
      * @param parameters.usid? - Unique Shopper Identifier to enable personalization.
      * @param parameters.dnt? - Optional parameter to enable Do Not Track (DNT) for the user.
+     * @para options? - options to pass in the ShopperLogin 'authenticateCustomer' method
+     * @param options.body - optional body parameters to pass in the ShopperLogin 'authenticateCustomer' method.
      * @returns TokenResponse
      */
     function loginRegisteredUserB2C(slasClient: ShopperLogin<{
@@ -33631,6 +33874,8 @@ declare namespace helpers {
         redirectURI: string;
         usid?: string;
         dnt?: boolean;
+    }, options?: {
+        body?: CustomRequestBody;
     }): Promise<TokenResponse>;
     /* Function to send passwordless login token
     * **Note** At the moment, passwordless is only supported on private client
@@ -33795,6 +34040,13 @@ declare namespace helpers {
         }) | undefined;
         body?: BodyInit | globalThis.BodyInit | unknown;
     } | undefined, clientConfig?: ClientConfigInit<Params> | undefined, rawResponse?: boolean | undefined) => Promise<Response | unknown>;
+    /**
+     * Single encodes SCAPI specific special characters (percentage sign `%` and comma `,`) in the given string in UTF-8
+     * Does not encode any other special characters in the string
+     * @param str - The string to encode
+     * @returns The encoded string
+     */
+    const encodeSCAPISpecialCharacters: (str: string) => string;
 }
 export { ShopperBaskets, ShopperContexts, ShopperCustomers, ShopperDiscoverySearch, ShopperExperience, ShopperGiftCertificates, ShopperOrders, ShopperProducts, ShopperPromotions, ShopperSearch, ShopperSeo, ShopperStores, ShopperLogin, ClientConfig, TemplateURL, helpers };
 export type { ShopperBasketsTypes, ShopperContextsTypes, ShopperCustomersTypes, ShopperDiscoverySearchTypes, ShopperExperienceTypes, ShopperGiftCertificatesTypes, ShopperOrdersTypes, ShopperProductsTypes, ShopperPromotionsTypes, ShopperSearchTypes, ShopperSeoTypes, ShopperStoresTypes, ShopperLoginTypes, ClientConfigInit };