ce-storefront 0.0.5 → 0.2.0

package/RUNTIMES.md

@@ -0,0 +1,22 @@
+# Supported JavaScript runtimes
+
+This SDK is intended to be used in JavaScript runtimes that support the following features:
+
+* [Web Fetch API][web-fetch]
+* [Web Streams API][web-streams] and in particular `ReadableStream`
+* [Async iterables][async-iter] using `Symbol.asyncIterator`
+
+[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
+[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
+[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
+
+Runtime environments that are explicitly supported are:
+
+- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
+- Node.js active and maintenance LTS releases
+  - Currently, this is v18 and v20
+- Bun v1 and above
+- Deno v1.39
+  - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
+
+[deno-file-streaming]: https://github.com/denoland/deno/issues/11018

package/docs/sdks/addresses/README.md

@@ -30,7 +30,7 @@ async function run() {
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -62,7 +62,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -83,10 +83,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## add
 
@@ -104,10 +103,20 @@ const ceStorefront = new CeStorefront({
 async function run() {
   const result = await ceStorefront.customers.addresses.add({
     userId: "<value>",
+    requestBody: {
+      firstName: "Katlynn",
+      phone: "895-711-7545 x3085",
+      email: "Daphney.Balistreri@gmail.com",
+      addressLine1: "1207 Railway Street",
+      pincode: "<value>",
+      city: "Lake Isaacside",
+      state: "Iowa",
+      country: "India",
+    },
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -130,6 +139,16 @@ const ceStorefront = new CeStorefrontCore({
 async function run() {
   const res = await customersAddressesAdd(ceStorefront, {
     userId: "<value>",
+    requestBody: {
+      firstName: "Katlynn",
+      phone: "895-711-7545 x3085",
+      email: "Daphney.Balistreri@gmail.com",
+      addressLine1: "1207 Railway Street",
+      pincode: "<value>",
+      city: "Lake Isaacside",
+      state: "Iowa",
+      country: "India",
+    },
   });
 
   if (!res.ok) {
@@ -139,7 +158,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -160,12 +179,11 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.BadRequest   | 400                 | application/json    |
 | errors.Unauthorized | 401                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
-
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |
 
 ## get
 
@@ -187,7 +205,7 @@ async function run() {
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -220,7 +238,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -241,12 +259,11 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
-
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |
 
 ## update
 
@@ -265,10 +282,20 @@ async function run() {
   const result = await ceStorefront.customers.addresses.update({
     userId: "<value>",
     addressId: "<value>",
+    requestBody: {
+      firstName: "Ruthe",
+      phone: "(496) 590-8432 x1783",
+      email: "Olen75@yahoo.com",
+      addressLine1: "5123 The Square",
+      pincode: "<value>",
+      city: "Port St. Lucie",
+      state: "Montana",
+      country: "India",
+    },
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -292,6 +319,16 @@ async function run() {
   const res = await customersAddressesUpdate(ceStorefront, {
     userId: "<value>",
     addressId: "<value>",
+    requestBody: {
+      firstName: "Ruthe",
+      phone: "(496) 590-8432 x1783",
+      email: "Olen75@yahoo.com",
+      addressLine1: "5123 The Square",
+      pincode: "<value>",
+      city: "Port St. Lucie",
+      state: "Montana",
+      country: "India",
+    },
   });
 
   if (!res.ok) {
@@ -301,7 +338,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -322,13 +359,12 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.BadRequest   | 400                 | application/json    |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
-
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |
 
 ## delete
 
@@ -350,7 +386,7 @@ async function run() {
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -383,7 +419,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -404,8 +440,8 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |

package/docs/sdks/analytics/README.md

@@ -21,10 +21,23 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.analytics.track();
+  const result = await ceStorefront.analytics.track({
+    event: "<value>",
+    type: "track",
+    userId: "<id>",
+    channel: "website",
+    context: {
+      ip: "107.133.97.111",
+      userAgent: "<value>",
+    },
+    properties: {},
+    messageId: "<id>",
+    timestamp: new Date("2024-05-20T11:37:56.914Z"),
+    sentAt: new Date("2023-06-07T16:48:30.895Z"),
+  });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -45,7 +58,20 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await analyticsTrack(ceStorefront);
+  const res = await analyticsTrack(ceStorefront, {
+    event: "<value>",
+    type: "track",
+    userId: "<id>",
+    channel: "website",
+    context: {
+      ip: "107.133.97.111",
+      userAgent: "<value>",
+    },
+    properties: {},
+    messageId: "<id>",
+    timestamp: new Date("2024-05-20T11:37:56.914Z"),
+    sentAt: new Date("2023-06-07T16:48:30.895Z"),
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -54,7 +80,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -75,6 +101,6 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |