@bentonow/bento-node-sdk 0.1.9 → 0.1.12

package/README.md

@@ -1,6 +1,6 @@
 # Bento SDK for Node.JS
 
-[![Publish NPM Package](https://github.com/bentonow/bento-node-sdk/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/bentonow/bento-node-sdk/actions/workflows/release.yml) [![CI](https://github.com/bentonow/bento-node-sdk/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/bentonow/bento-node-sdk/actions/workflows/main.yml)
+[![Tests](https://github.com/bentonow/bento-node-sdk/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/bentonow/bento-node-sdk/actions/workflows/main.yml)
 
 🍱 Simple, powerful analytics for Node.JS projects!
 
@@ -10,6 +10,8 @@ Track events, update data, record LTV and more in Node.JS. Data is stored in you
 
 🐶 Battle-tested by [NativShark](https://nativshark.com) Bento Production (a Bento customer)!
 
+❤️ Thank you @HelloKashif from [IPInfo](https://ipinfo.io) for your contribution.
+
 - [Installation](#Installation)
 - [Get Started](#Get-Started)
 - [Modules](#Modules)
@@ -25,6 +27,7 @@ Track events, update data, record LTV and more in Node.JS. Data is stored in you
   - [Commands](#Commands)
     - [.addTag(parameters: AddTagParameters): Promise\<Subscriber\<S\> | null\>](#commandsaddtagparameters-addtagparameters-promisesubscribers--null)
     - [.removeTag(parameters: RemoveTagParameters): Promise\<Subscriber\<S\> | null\>](#commandsremovetagparameters-removetagparameters-promisesubscribers--null)
+    - [.addField(parameters: AddFieldParameters\<S\>): Promise\<Subscriber\<S\> | null\>](#commandsaddfieldparameters-addfieldparameterss-promisesubscribers--null)
     - [.removeField(parameters: RemoveFieldParameters\<S\>): Promise\<Subscriber\<S\> | null\>](#commandsremovefieldparameters-removefieldparameterss-promisesubscribers--null)
     - [.subscribe(parameters: SubscribeParameters): Promise\<Subscriber\<S\> | null\>](#commandssubscribeparameters-subscribeparameters-promisesubscribers--null)
     - [.unsubscribe(parameters: UnsubscribeParameters): Promise\<Subscriber\<S\> | null\>](#commandsunsubscribeparameters-unsubscribeparameters-promisesubscribers--null)
@@ -45,53 +48,6 @@ Track events, update data, record LTV and more in Node.JS. Data is stored in you
     - [.getTags(): Promise\<Tag[] | null\>](#tagsgettags-promisetag--null)
     - [.createTag(parameters: CreateTagParameters): Promise\<Tag[] | null\>](#tagscreatetagparameters-createtagparameters-promisetag--null)
 - [Types Reference](#Types-Reference)
-  - [AddFieldParameters\<S\>](#addfieldparameterss)
-  - [AddSubscriberParameters\<S\>](#addsubscriberparameterss)
-  - [AddTagParameters](#AddTagParameters)
-  - [BatchImportEventsParameter\<S, E\>](#batchimporteventsparameterse)
-  - [BatchImportSubscribersParameter\<S\>](#batchimportsubscribersparameters)
-  - [BentoEvent\<S, E\>](#bentoevents-e)
-    - [BaseEvent\<E\>](#baseevente)
-    - [PurchaseEvent](#PurchaseEvent)
-    - [SubscribeEvent](#SubscribeEvent)
-    - [TagEvent](#TagEvent)
-    - [UnsubscribeEvent](#UnsubscribeEvent)
-    - [UpdateFieldsEvent\<S\>](#updatefieldsevents)
-  - [BlacklistParameters](#BlacklistParameters)
-  - [BlacklistResponse](#BlacklistResponse)
-  - [BrowserData](#BrowserData)
-  - [CreateFieldParameters](#CreateFieldParameters)
-  - [CreateSubscriberParameters](#CreateSubscriberParameters)
-  - [CreateTagParameters](#CreateTagParameters)
-  - [EntityType](#EntityType)
-  - [Field](#Field)
-  - [FieldAttributes](#FieldAttributes)
-  - [FormResponse](#FormResponse)
-  - [FormResponseAttributes](#FormResponseAttributes)
-  - [FormResponseData](#FormResponseData)
-  - [GetSubscribersParameters](#GetSubscribersParameters)
-  - [GeolocateParameters](#GeolocateParameters)
-  - [GuessGenderParameters](#GuessGenderParameters)
-  - [GuessGenderResponse](#GuessGenderResponse)
-  - [IdentityData](#IdentityData)
-  - [LocationData](#LocationData)
-  - [PageData](#PageData)
-  - [PurchaseDetails](#PurchaseDetails)
-  - [PurchaseItem](#PurchaseItem)
-  - [RemoveFieldParameters\<S\>](#removefieldparameterss)
-  - [RemoveSubscriberParameters](#RemoveSubscriberParameters)
-  - [RemoveTagParameters](#RemoveTagParameters)
-  - [SubscribeParameters](#SubscribeParameters)
-  - [Subscriber\<S\>](#subscribers)
-  - [SubscriberAttributes\<S\>](#subscriberattributess)
-  - [Tag](#Tag)
-  - [TagAttributes](#TagAttributes)
-  - [TagSubscriberParameters](#TagSubscriberParameters)
-  - [TrackParameters\<S, E\>](#trackparametersse)
-  - [TrackPurchaseParameters](#TrackPurchaseParameters)
-  - [UnsubscribeParameters](#UnsubscribeParameters)
-  - [UpdateFieldsParameters\<S\>](#updatefieldsparameterss)
-  - [ValidateEmailParameters](#ValidateEmailParameters)
 - [TypeScript](#TypeScript)
   - [Generics](#Generics)
     - [S](#s)
@@ -123,23 +79,32 @@ const bento = new Analytics({
   siteUuid: 'siteUuid',
 });
 
-bento
-  .addSubscriber({
-    email: 'test@bentonow.com',
-  })
+bento.V1.addSubscriber({
+  email: 'test@bentonow.com',
+})
   .then(result => console.log(result))
   .catch(error => console.error(error));
 
-bento
-  .updateFields({
-    email: 'test@bentonow.com',
-    fields: {
-      firstName: 'Test',
-      lastName: 'User',
-    },
-  })
+bento.V1.updateFields({
+  email: 'test@bentonow.com',
+  fields: {
+    firstName: 'Test',
+    lastName: 'User',
+  },
+})
   .then(result => console.log(result))
   .catch(error => console.error(error));
+
+bento.V1.trackPurchase({
+  email: 'test@bentonow.com',
+  purchaseDetails: {
+    unique: { key: 1234 },
+    value: { amount: 100, currency: 'USD' },
+  },
+  cart: {
+    abandoned_checkout_url: '',
+  },
+});
 ```
 
 Read on to see what all you can do with the SDK.
@@ -165,11 +130,10 @@ Returns `true` if the event was successfully dispatched. Returns `false` otherwi
 Reference Types: [TagSubscriberParameters](#TagSubscriberParameters)
 
 ```ts
-bento
-  .tagSubscriber({
-    email: 'test@bentonow.com',
-    tagName: 'Test Tag',
-  })
+bento.V1.tagSubscriber({
+  email: 'test@bentonow.com',
+  tagName: 'Test Tag',
+})
   .then(result => console.log(result))
   .catch(error => console.error(error));
 ```
@@ -191,22 +155,20 @@ Returns `true` if the event was successfully dispatched. Returns `false` otherwi
 Reference Types: [AddSubscriberParameters\<S\>](#addsubscriberparameterss)
 
 ```ts
-bento
-  .addSubscriber({
-    email: 'test@bentonow.com',
-  })
+bento.V1.addSubscriber({
+  email: 'test@bentonow.com',
+})
   .then(result => console.log(result))
   .catch(error => console.error(error));
 
-bento
-  .addSubscriber({
-    date: new Date('2021-08-20T01:32:57.530Z'),
-    email: 'test@bentonow.com',
-    fields: {
-      firstName: 'Test',
-      lastName: 'Subscriber',
-    },
-  })
+bento.V1.addSubscriber({
+  date: new Date('2021-08-20T01:32:57.530Z'),
+  email: 'test@bentonow.com',
+  fields: {
+    firstName: 'Test',
+    lastName: 'Subscriber',
+  },
+})
   .then(result => console.log(result))
   .catch(error => console.error(error));
 ```
@@ -226,10 +188,9 @@ Returns `true` if the event was successfully dispatched. Returns `false` otherwi
 Reference Types: [RemoveSubscriberParameters](#RemoveSubscriberParameters)
 
 ```ts
-bento
-  .removeSubscriber({
-    email: 'test@bentonow.com',
-  })
+bento.V1.removeSubscriber({
+  email: 'test@bentonow.com',
+})
   .then(result => console.log(result))
   .catch(error => console.error(error));
 ```
@@ -249,13 +210,12 @@ Returns `true` if the event was successfully dispatched. Returns `false` otherwi
 Reference Types: [UpdateFieldsParameters\<S\>](#updatefieldsparameterss)
 
 ```ts
-bento
-  .updateFields({
-    email: 'test@bentonow.com',
-    fields: {
-      firstName: 'Test',
-    },
-  })
+bento.V1.updateFields({
+  email: 'test@bentonow.com',
+  fields: {
+    firstName: 'Test',
+  },
+})
   .then(result => console.log(result))
   .catch(error => console.error(error));
 ```
@@ -275,19 +235,18 @@ Returns `true` if the event was successfully dispatched. Returns `false` otherwi
 Reference Types: [TrackPurchaseParameters](#TrackPurchaseParameters)
 
 ```ts
-bento
-  .trackPurchase({
-    email: 'test@bentonow.com',
-    purchaseDetails: {
-      unique: {
-        key: 1234,
-      },
-      value: {
-        amount: 100,
-        currency: 'USD',
-      },
+bento.V1.trackPurchase({
+  email: 'test@bentonow.com',
+  purchaseDetails: {
+    unique: {
+      key: 1234,
     },
-  })
+    value: {
+      amount: 100,
+      currency: 'USD',
+    },
+  },
+})
   .then(result => console.log(result))
   .catch(error => console.error(error));
 ```
@@ -307,14 +266,13 @@ Returns `true` if the event was successfully dispatched. Returns `false` otherwi
 Reference Types: [TrackParameters<S, E>](#trackparametersse)
 
 ```ts
-bento
-  .track({
-    email: 'test@bentonow.com',
-    type: '$custom.event',
-    details: {
-      fromCustomEvent: true,
-    },
-  })
+bento.V1.track({
+  email: 'test@bentonow.com',
+  type: '$custom.event',
+  details: {
+    fromCustomEvent: true,
+  },
+})
   .then(result => console.log(result))
   .catch(error => console.error(error));
 ```
@@ -374,6 +332,20 @@ bento.V1.Batch.importEvents({
       email: 'test@bentonow.com',
       type: BentoEvents.UNSUBSCRIBE,
     },
+    {
+      email: 'test@bentonow.com',
+      type: BentoEvents.REMOVE_TAG,
+      details: {
+        tag: 'tag_to_remove',
+      },
+    },
+    {
+      email: 'test@bentonow.com',
+      type: BentoEvents.TAG,
+      details: {
+        tag: 'tag_to_add',
+      },
+    },
     {
       email: 'test@bentonow.com',
       details: {
@@ -504,6 +476,23 @@ bento.V1.Commands.unsubscribe({
   .catch(error => console.error(error));
 ```
 
+---
+
+### `Commands.changeEmail(parameters: ChangeEmailParameters): Promise<Subscriber<S> | null>`
+
+Updates the email of a user in Bento.
+
+Reference Types: [ChangeEmailParameters](#changeemailparameters), [Subscriber\<S\>](#subscribers)
+
+```ts
+bento.V1.Commands.changeEmail({
+  oldEmail: 'test@bentonow.com',
+  newEmail: 'new@bentonow.com',
+})
+  .then(result => console.log(result))
+  .catch(error => console.error(error));
+```
+
 ## Experimental
 
 ### `Experimental.validateEmail(parameters: ValidateEmailParameters): Promise<boolean>`
@@ -701,7 +690,7 @@ bento.V1.Tags.createTag({
   .catch(error => console.error(error));
 ```
 
-## Types References
+## Types Reference
 
 ### `AddFieldParameters<S>`
 
@@ -856,6 +845,15 @@ The results is an object where the key is the name of the blacklist that was che
 
 ---
 
+### `ChangeEmailParameters`
+
+| Property | Type     | Default | Required |
+| -------- | -------- | ------- | -------- |
+| oldEmail | `string` | _none_  | ✔️       |
+| newEmail | `string` | _none_  | ✔️       |
+
+---
+
 ### `CreateFieldParameters`
 
 | Property | Type     | Default | Required |
@@ -1029,13 +1027,22 @@ Note that this takes either `email` _or_ `uuid`, but never both.
 
 ---
 
+### `PurchaseCart`
+
+| Property               | Type                              | Default | Required |
+| ---------------------- | --------------------------------- | ------- | -------- |
+| abandoned_checkout_url | `string`                          | _none_  | ❌       |
+| items                  | [`PurchaseItem[]`](#PurchaseItem) | _none_  | ❌       |
+
+---
+
 ### `PurchaseDetails`
 
 | Property | Type                                    | Default | Required |
 | -------- | --------------------------------------- | ------- | -------- |
 | unique   | `{ key: string \| number; }`            | _none_  | ✔️       |
 | value    | `{ currency: string; amount: number; }` | _none_  | ✔️       |
-| cart     | [`PurchaseItem[]`](#PurchaseItem)       | _none_  | ❌       |
+| cart     | [`PurchaseCart`](#PurchaseCart)         | _none_  | ❌       |
 
 ---
 
@@ -1154,6 +1161,7 @@ The `E` from above represents the prefix that is used to define your custom even
 | email    | `string`                 | _none_  | ✔️       |
 | type     | `string`                 | _none_  | ✔️       |
 | details  | `{ [key: string]: any }` | _none_  | ❌       |
+| fields   | `Partial<S>`             | _none_  | ❌       |
 
 ---
 

package/dist/bento-node-sdk.cjs.development.js

@@ -1113,15 +1113,6 @@ var NotAuthorizedError = /*#__PURE__*/function (_Error) {
 
   return NotAuthorizedError;
 }( /*#__PURE__*/_wrapNativeSuper(Error));
-var InternalServerError = /*#__PURE__*/function (_Error2) {
-  _inheritsLoose(InternalServerError, _Error2);
-
-  function InternalServerError() {
-    return _Error2.apply(this, arguments) || this;
-  }
-
-  return InternalServerError;
-}( /*#__PURE__*/_wrapNativeSuper(Error));
 
 var BentoClient = /*#__PURE__*/function () {
   function BentoClient(options) {
@@ -1159,13 +1150,38 @@ var BentoClient = /*#__PURE__*/function () {
       fetch("" + _this._baseUrl + endpoint + "?" + queryParameters, {
         method: 'GET',
         headers: _this._headers
-      }).then(function (result) {
-        if (_this._isSuccessfulStatus(result.status)) {
-          return result.json();
-        }
+      }).then( /*#__PURE__*/function () {
+        var _ref = _asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee(result) {
+          return runtime_1.wrap(function _callee$(_context) {
+            while (1) {
+              switch (_context.prev = _context.next) {
+                case 0:
+                  if (!_this._isSuccessfulStatus(result.status)) {
+                    _context.next = 2;
+                    break;
+                  }
+
+                  return _context.abrupt("return", result.json());
+
+                case 2:
+                  _context.next = 4;
+                  return _this._getErrorForResponse(result);
+
+                case 4:
+                  throw _context.sent;
+
+                case 5:
+                case "end":
+                  return _context.stop();
+              }
+            }
+          }, _callee);
+        }));
 
-        throw _this._getErrorForResponse(result);
-      }).then(function (data) {
+        return function (_x) {
+          return _ref.apply(this, arguments);
+        };
+      }()).then(function (data) {
         return resolve(data);
       })["catch"](function (error) {
         return reject(error);
@@ -1198,13 +1214,38 @@ var BentoClient = /*#__PURE__*/function () {
           'Content-Type': 'application/json'
         }),
         body: body
-      }).then(function (result) {
-        if (_this2._isSuccessfulStatus(result.status)) {
-          return result.json();
-        }
+      }).then( /*#__PURE__*/function () {
+        var _ref2 = _asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee2(result) {
+          return runtime_1.wrap(function _callee2$(_context2) {
+            while (1) {
+              switch (_context2.prev = _context2.next) {
+                case 0:
+                  if (!_this2._isSuccessfulStatus(result.status)) {
+                    _context2.next = 2;
+                    break;
+                  }
+
+                  return _context2.abrupt("return", result.json());
+
+                case 2:
+                  _context2.next = 4;
+                  return _this2._getErrorForResponse(result);
+
+                case 4:
+                  throw _context2.sent;
+
+                case 5:
+                case "end":
+                  return _context2.stop();
+              }
+            }
+          }, _callee2);
+        }));
 
-        throw _this2._getErrorForResponse(result);
-      }).then(function (data) {
+        return function (_x2) {
+          return _ref2.apply(this, arguments);
+        };
+      }()).then(function (data) {
         return resolve(data);
       })["catch"](function (error) {
         return reject(error);
@@ -1285,10 +1326,68 @@ var BentoClient = /*#__PURE__*/function () {
    */
   ;
 
-  _proto._getErrorForResponse = function _getErrorForResponse(response) {
-    if (response.status === 401) return new NotAuthorizedError();
-    return new InternalServerError();
-  };
+  _proto._getErrorForResponse =
+  /*#__PURE__*/
+  function () {
+    var _getErrorForResponse2 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee3(response) {
+      var contentType, responseMessage;
+      return runtime_1.wrap(function _callee3$(_context3) {
+        while (1) {
+          switch (_context3.prev = _context3.next) {
+            case 0:
+              if (!(response.status === 401)) {
+                _context3.next = 2;
+                break;
+              }
+
+              return _context3.abrupt("return", new NotAuthorizedError());
+
+            case 2:
+              contentType = response.headers.get('Content-Type');
+              responseMessage = '';
+              _context3.t0 = contentType == null ? void 0 : contentType.toLocaleLowerCase();
+              _context3.next = _context3.t0 === 'text/plain' ? 7 : _context3.t0 === 'application/json' ? 11 : 17;
+              break;
+
+            case 7:
+              _context3.next = 9;
+              return response.text();
+
+            case 9:
+              responseMessage = _context3.sent;
+              return _context3.abrupt("break", 19);
+
+            case 11:
+              _context3.t1 = JSON;
+              _context3.next = 14;
+              return response.json();
+
+            case 14:
+              _context3.t2 = _context3.sent;
+              responseMessage = _context3.t1.stringify.call(_context3.t1, _context3.t2);
+              return _context3.abrupt("break", 19);
+
+            case 17:
+              responseMessage = 'Unknown response from the Bento API.';
+              return _context3.abrupt("break", 19);
+
+            case 19:
+              return _context3.abrupt("return", new Error("[" + response.status + "] - " + responseMessage));
+
+            case 20:
+            case "end":
+              return _context3.stop();
+          }
+        }
+      }, _callee3);
+    }));
+
+    function _getErrorForResponse(_x3) {
+      return _getErrorForResponse2.apply(this, arguments);
+    }
+
+    return _getErrorForResponse;
+  }();
 
   return BentoClient;
 }();
@@ -1301,6 +1400,7 @@ var CommandTypes;
 (function (CommandTypes) {
   CommandTypes["ADD_FIELD"] = "add_field";
   CommandTypes["ADD_TAG"] = "add_tag";
+  CommandTypes["CHANGE_EMAIL"] = "change_email";
   CommandTypes["REMOVE_FIELD"] = "remove_field";
   CommandTypes["REMOVE_TAG"] = "remove_tag";
   CommandTypes["SUBSCRIBE"] = "subscribe";
@@ -1688,6 +1788,65 @@ var BentoCommands = /*#__PURE__*/function () {
     }
 
     return unsubscribe;
+  }()
+  /**
+   * Updates the email of a user in Bento.
+   *
+   * @param parameters \{ oldEmail: string, newEmail: string \}
+   * @returns Promise\<Subscriber | null\>
+   */
+  ;
+
+  _proto.changeEmail =
+  /*#__PURE__*/
+  function () {
+    var _changeEmail = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee7(parameters) {
+      var result;
+      return runtime_1.wrap(function _callee7$(_context7) {
+        while (1) {
+          switch (_context7.prev = _context7.next) {
+            case 0:
+              _context7.prev = 0;
+              _context7.next = 3;
+              return this._client.post(this._url, {
+                command: {
+                  command: CommandTypes.CHANGE_EMAIL,
+                  email: parameters.oldEmail,
+                  query: parameters.newEmail
+                }
+              });
+
+            case 3:
+              result = _context7.sent;
+
+              if (!(Object.keys(result).length === 0 || !result.data)) {
+                _context7.next = 6;
+                break;
+              }
+
+              return _context7.abrupt("return", null);
+
+            case 6:
+              return _context7.abrupt("return", result.data);
+
+            case 9:
+              _context7.prev = 9;
+              _context7.t0 = _context7["catch"](0);
+              throw _context7.t0;
+
+            case 12:
+            case "end":
+              return _context7.stop();
+          }
+        }
+      }, _callee7, this, [[0, 9]]);
+    }));
+
+    function changeEmail(_x7) {
+      return _changeEmail.apply(this, arguments);
+    }
+
+    return changeEmail;
   }();
 
   return BentoCommands;
@@ -2355,6 +2514,7 @@ var BentoEvents;
   BentoEvents["PURCHASE"] = "$purchase";
   BentoEvents["SUBSCRIBE"] = "$subscribe";
   BentoEvents["TAG"] = "$tag";
+  BentoEvents["REMOVE_TAG"] = "$remove_tag";
   BentoEvents["UNSUBSCRIBE"] = "$unsubscribe";
   BentoEvents["UPDATE_FIELDS"] = "$update_fields";
 })(BentoEvents || (BentoEvents = {}));
@@ -2766,6 +2926,5 @@ var Analytics = function Analytics(options) {
 };
 
 exports.Analytics = Analytics;
-exports.InternalServerError = InternalServerError;
 exports.NotAuthorizedError = NotAuthorizedError;
 //# sourceMappingURL=bento-node-sdk.cjs.development.js.map