@salesforce/commerce-sdk-react 1.0.0-preview.0 → 1.0.0-preview.1

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 (53) hide show
  1. package/CHANGELOG.md +1 -0
  2. package/README.md +4 -0
  3. package/auth/index.d.ts +16 -1
  4. package/auth/index.js +49 -1
  5. package/hooks/ShopperBaskets/mutation.d.ts +61 -280
  6. package/hooks/ShopperBaskets/mutation.js +60 -254
  7. package/hooks/ShopperBaskets/query.d.ts +10 -0
  8. package/hooks/ShopperBaskets/query.js +10 -0
  9. package/hooks/ShopperContexts/mutation.d.ts +16 -11
  10. package/hooks/ShopperContexts/mutation.js +16 -11
  11. package/hooks/ShopperContexts/query.d.ts +3 -1
  12. package/hooks/ShopperContexts/query.js +3 -1
  13. package/hooks/ShopperCustomers/mutation.d.ts +20 -80
  14. package/hooks/ShopperCustomers/mutation.js +20 -81
  15. package/hooks/ShopperCustomers/query.d.ts +27 -2
  16. package/hooks/ShopperCustomers/query.js +28 -2
  17. package/hooks/ShopperExperience/query.d.ts +12 -8
  18. package/hooks/ShopperExperience/query.js +12 -8
  19. package/hooks/ShopperGiftCertificates/query.d.ts +2 -0
  20. package/hooks/ShopperGiftCertificates/query.js +2 -0
  21. package/hooks/ShopperLogin/mutation.d.ts +19 -47
  22. package/hooks/ShopperLogin/mutation.js +19 -41
  23. package/hooks/ShopperLogin/query.d.ts +8 -0
  24. package/hooks/ShopperLogin/query.js +8 -0
  25. package/hooks/ShopperOrders/mutation.d.ts +19 -23
  26. package/hooks/ShopperOrders/mutation.js +19 -21
  27. package/hooks/ShopperOrders/query.d.ts +6 -0
  28. package/hooks/ShopperOrders/query.js +7 -1
  29. package/hooks/ShopperProducts/query.d.ts +8 -0
  30. package/hooks/ShopperProducts/query.js +8 -0
  31. package/hooks/ShopperPromotions/query.d.ts +4 -0
  32. package/hooks/ShopperPromotions/query.js +4 -0
  33. package/hooks/ShopperSearch/query.d.ts +11 -3
  34. package/hooks/ShopperSearch/query.js +11 -3
  35. package/hooks/types.d.ts +3 -0
  36. package/hooks/useAccessToken.d.ts +6 -0
  37. package/hooks/useAccessToken.js +8 -0
  38. package/hooks/useAuthHelper.d.ts +14 -0
  39. package/hooks/useAuthHelper.js +19 -0
  40. package/hooks/useCommerceApi.d.ts +2 -0
  41. package/hooks/useCommerceApi.js +2 -0
  42. package/hooks/useCustomerId.d.ts +2 -0
  43. package/hooks/useCustomerId.js +2 -0
  44. package/hooks/useCustomerType.d.ts +3 -0
  45. package/hooks/useCustomerType.js +12 -1
  46. package/hooks/useEncUserId.d.ts +3 -0
  47. package/hooks/useEncUserId.js +3 -0
  48. package/hooks/useUsid.d.ts +2 -0
  49. package/hooks/useUsid.js +2 -0
  50. package/package.json +8 -6
  51. package/provider.d.ts +27 -1
  52. package/provider.js +27 -1
  53. package/scripts/build-and-release-docs.js +1 -0
package/provider.js CHANGED
@@ -37,7 +37,33 @@ const AuthContext = /*#__PURE__*/_react.default.createContext({});
37
37
  /**
38
38
  * Initialize a set of Commerce API clients and make it available to all of descendant components
39
39
  *
40
- * @param props
40
+ * @group Components
41
+ *
42
+ * @example
43
+ * ```js
44
+ import {CommerceApiProvider} from '@salesforce/commerce-sdk-react'
45
+
46
+
47
+ const App = ({children}) => {
48
+ return (
49
+ <CommerceApiProvider
50
+ clientId="12345678-1234-1234-1234-123412341234"
51
+ organizationId="f_ecom_aaaa_001"
52
+ proxy="localhost:3000/mobify/proxy/api"
53
+ redirectURI="localhost:3000/callback"
54
+ siteId="RefArch"
55
+ shortCode="12345678"
56
+ locale="en-US"
57
+ currency="USD"
58
+ >
59
+ {children}
60
+ </CommerceApiProvider>
61
+ )
62
+ }
63
+
64
+ export default App
65
+ * ```
66
+ *
41
67
  * @returns Provider to wrap your app with
42
68
  */
43
69
  exports.AuthContext = AuthContext;
@@ -16,6 +16,7 @@ const main = () => {
16
16
  const isPrerelease = semver.prerelease(currentVersion.trim())
17
17
  // if it is a pre-release version, do nothing
18
18
  if (isPrerelease) {
19
+ console.log('This is a preview release, exiting.')
19
20
  return
20
21
  }
21
22