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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (74) hide show
  1. package/README.md +57 -0
  2. package/lib/clientConfig.cjs.d.ts +4 -2
  3. package/lib/clientConfig.cjs.js +1 -1
  4. package/lib/clientConfig.d.ts +4 -2
  5. package/lib/clientConfig.js +1 -1
  6. package/lib/helpers.cjs.d.ts +9 -9
  7. package/lib/helpers.cjs.js +1 -1
  8. package/lib/helpers.d.ts +9 -9
  9. package/lib/helpers.js +1 -1
  10. package/lib/index.cjs.d.ts +57 -24
  11. package/lib/index.cjs.js +1 -1
  12. package/lib/index.esm.d.ts +57 -24
  13. package/lib/index.esm.js +1 -1
  14. package/lib/shopperBaskets.cjs.d.ts +6 -1
  15. package/lib/shopperBaskets.cjs.js +1 -1
  16. package/lib/shopperBaskets.d.ts +6 -1
  17. package/lib/shopperBaskets.js +1 -1
  18. package/lib/shopperBasketsv2.cjs.d.ts +6 -1
  19. package/lib/shopperBasketsv2.cjs.js +1 -1
  20. package/lib/shopperBasketsv2.d.ts +6 -1
  21. package/lib/shopperBasketsv2.js +1 -1
  22. package/lib/shopperConsents.cjs.d.ts +6 -1
  23. package/lib/shopperConsents.cjs.js +1 -1
  24. package/lib/shopperConsents.d.ts +6 -1
  25. package/lib/shopperConsents.js +1 -1
  26. package/lib/shopperContext.cjs.d.ts +6 -1
  27. package/lib/shopperContext.cjs.js +1 -1
  28. package/lib/shopperContext.d.ts +6 -1
  29. package/lib/shopperContext.js +1 -1
  30. package/lib/shopperCustomers.cjs.d.ts +6 -1
  31. package/lib/shopperCustomers.cjs.js +1 -1
  32. package/lib/shopperCustomers.d.ts +6 -1
  33. package/lib/shopperCustomers.js +1 -1
  34. package/lib/shopperExperience.cjs.d.ts +6 -1
  35. package/lib/shopperExperience.cjs.js +1 -1
  36. package/lib/shopperExperience.d.ts +6 -1
  37. package/lib/shopperExperience.js +1 -1
  38. package/lib/shopperGiftCertificates.cjs.d.ts +6 -1
  39. package/lib/shopperGiftCertificates.cjs.js +1 -1
  40. package/lib/shopperGiftCertificates.d.ts +6 -1
  41. package/lib/shopperGiftCertificates.js +1 -1
  42. package/lib/shopperLogin.cjs.d.ts +6 -1
  43. package/lib/shopperLogin.cjs.js +1 -1
  44. package/lib/shopperLogin.d.ts +6 -1
  45. package/lib/shopperLogin.js +1 -1
  46. package/lib/shopperOrders.cjs.d.ts +6 -1
  47. package/lib/shopperOrders.cjs.js +1 -1
  48. package/lib/shopperOrders.d.ts +6 -1
  49. package/lib/shopperOrders.js +1 -1
  50. package/lib/shopperProducts.cjs.d.ts +6 -1
  51. package/lib/shopperProducts.cjs.js +1 -1
  52. package/lib/shopperProducts.d.ts +6 -1
  53. package/lib/shopperProducts.js +1 -1
  54. package/lib/shopperPromotions.cjs.d.ts +6 -1
  55. package/lib/shopperPromotions.cjs.js +1 -1
  56. package/lib/shopperPromotions.d.ts +6 -1
  57. package/lib/shopperPromotions.js +1 -1
  58. package/lib/shopperSearch.cjs.d.ts +6 -1
  59. package/lib/shopperSearch.cjs.js +1 -1
  60. package/lib/shopperSearch.d.ts +6 -1
  61. package/lib/shopperSearch.js +1 -1
  62. package/lib/shopperSeo.cjs.d.ts +6 -1
  63. package/lib/shopperSeo.cjs.js +1 -1
  64. package/lib/shopperSeo.d.ts +6 -1
  65. package/lib/shopperSeo.js +1 -1
  66. package/lib/shopperStores.cjs.d.ts +6 -1
  67. package/lib/shopperStores.cjs.js +1 -1
  68. package/lib/shopperStores.d.ts +6 -1
  69. package/lib/shopperStores.js +1 -1
  70. package/lib/version.cjs.d.ts +1 -1
  71. package/lib/version.cjs.js +1 -1
  72. package/lib/version.d.ts +1 -1
  73. package/lib/version.js +1 -1
  74. package/package.json +4 -4
package/lib/helpers.d.ts CHANGED
@@ -81,6 +81,7 @@ type BrowserRequestInit = RequestInit;
81
81
  * Using the right properties in the right context is left to the user.
82
82
  */
83
83
  type FetchOptions = NodeRequestInit & BrowserRequestInit;
84
+ type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
84
85
  /**
85
86
  * Base options that can be passed to the `ClientConfig` class.
86
87
  */
@@ -92,12 +93,12 @@ interface ClientConfigInit<Params extends BaseUriParameters> {
92
93
  };
93
94
  parameters: Params;
94
95
  fetchOptions?: FetchOptions;
96
+ fetch?: FetchFunction;
95
97
  transformRequest?: (data: unknown, headers: {
96
98
  [key: string]: string;
97
99
  }) => Required<FetchOptions>["body"];
98
100
  throwOnBadResponse?: boolean;
99
101
  }
100
- type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
101
102
  /**
102
103
  * Configuration parameters common to Commerce SDK clients
103
104
  */
@@ -109,23 +110,22 @@ declare class ClientConfig<Params extends BaseUriParameters> implements ClientCo
109
110
  };
110
111
  parameters: Params;
111
112
  fetchOptions: FetchOptions;
113
+ fetch?: FetchFunction;
112
114
  transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
113
115
  throwOnBadResponse: boolean;
114
116
  constructor(config: ClientConfigInit<Params>);
115
117
  static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
116
118
  }
117
- /*
118
- * Copyright (c) 2022, Salesforce, Inc.
119
- * All rights reserved.
120
- * SPDX-License-Identifier: BSD-3-Clause
121
- * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
122
- */
123
119
  declare const isBrowser: boolean;
124
120
  declare const isNode: boolean;
125
121
  declare const globalObject: typeof globalThis;
126
122
  declare const hasFetchAvailable: boolean;
127
- // TODO: Remove this function in the next major version
128
- // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
123
+ // TODO: Adopt native fetch in the next major version.
124
+ // Using the built-in fetch (Node 18+) caused downstream unit tests that rely on
125
+ // `nock` to fail because `nock` hooks into the core HTTP/HTTPS modules, while
126
+ // the native fetch implementation leverages undici instead. Until we can roll
127
+ // out a coordinated breaking change, we continue to use the node-fetch
128
+ // polyfill so existing tests keep passing.
129
129
  declare const fetch: FetchFunction;
130
130
  /**
131
131
  * Grant Type