commerce-sdk-isomorphic 1.5.1 → 1.5.2

package/README.md

@@ -108,7 +108,7 @@ _throwOnBadResponse:_ Default value is false. When set to true, the SDK throws a
 
 A collection of helper functions are available in this SDK to simplify [Public
 Client Shopper Login OAuth
-flows](https://developer.salesforce.com/docs/commerce/commerce-api/references#shopper-login-and-api-access:Summary). See sample code above for guest login.
+flows](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary). See sample code above for guest login.
 
 ## License Information
 

package/lib/index.cjs.d.ts

@@ -5,6 +5,36 @@
 * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
 */
 import { RequestInit as NodeRequestInit } from "node-fetch";
+/*
+* Copyright (c) 2021, 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
+*/
+type CompositeParameters<MethodParameters extends Record<string, unknown>, ConfigParameters extends Record<string, unknown>> = Omit<MethodParameters, keyof ConfigParameters> & Partial<MethodParameters>;
+type RequireParametersUnlessAllAreOptional<T extends {
+    parameters?: Record<string, unknown>;
+}> = Record<string, never> extends NonNullable<T["parameters"]> ? T : T & Required<Pick<T, "parameters">>;
+/**
+ * Template parameters used in the base URI of all API endpoints. `version` will default to `"v1"`
+ * if not specified.
+ */
+interface BaseUriParameters {
+    shortCode: string;
+    version?: string; // Optional, will default to "v1" if not provided.
+}
+/**
+ * Generic interface for path parameters.
+ */
+interface PathParameters {
+    [key: string]: string | number | boolean;
+}
+/**
+ * Generic interface for query parameters.
+ */
+interface QueryParameters {
+    [key: string]: string | number | boolean | string[] | number[];
+}
 type LoginRequest = {
     client_id?: string;
     response_type?: string;
@@ -870,36 +900,6 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
         };
     }>, rawResponse?: T): Promise<T extends true ? Response : Object>;
 }
-/*
-* Copyright (c) 2021, 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
-*/
-type CompositeParameters<MethodParameters extends Record<string, unknown>, ConfigParameters extends Record<string, unknown>> = Omit<MethodParameters, keyof ConfigParameters> & Partial<MethodParameters>;
-type RequireParametersUnlessAllAreOptional<T extends {
-    parameters?: Record<string, unknown>;
-}> = Record<string, never> extends NonNullable<T["parameters"]> ? T : T & Required<Pick<T, "parameters">>;
-/**
- * Template parameters used in the base URI of all API endpoints. `version` will default to `"v1"`
- * if not specified.
- */
-interface BaseUriParameters {
-    shortCode: string;
-    version?: string; // Optional, will default to "v1" if not provided.
-}
-/**
- * Generic interface for path parameters.
- */
-interface PathParameters {
-    [key: string]: string | number | boolean;
-}
-/**
- * Generic interface for query parameters.
- */
-interface QueryParameters {
-    [key: string]: string | number | boolean | string[] | number[];
-}
 /**
  * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
  * it from the `RequestInit` provided by node-fetch.
@@ -8938,6 +8938,14 @@ declare class TemplateURL extends URL {
     static renderTemplateUri(template: string, parameters?: PathParameters): string;
 }
 declare namespace helpers {
+    /*
+    * 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;
     /*
     * Copyright (c) 2021, salesforce.com, inc.
     * All rights reserved.
@@ -10047,10 +10055,6 @@ declare namespace helpers {
             };
         }>, rawResponse?: T): Promise<T extends true ? Response : Object>;
     }
-    /**
-     * Determine if execution is client or server side
-     */
-    const onClient: boolean;
     const stringToBase64: typeof btoa;
     /**
      * Parse out the code and usid from a redirect url
@@ -10096,7 +10100,7 @@ declare namespace helpers {
         usid: string;
     }>;
     /**
-     * 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-and-api-access:Summary).
+     * 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.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.
@@ -10112,7 +10116,7 @@ declare namespace helpers {
         usid?: string;
     }): 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-and-api-access:Summary).
+     * 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).
      * @param slasClient a configured instance of the ShopperLogin SDK client.
      * @param credentials - the id and password to login with.
      * @param credentials.username - the id of the user to login with.