@saasquatch/squatch-js 2.5.0 → 2.5.1-0

package/LICENSE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2023 ReferralSaaSquatch.com, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+The MIT License (MIT)
+
+Copyright (c) 2023 ReferralSaaSquatch.com, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.

package/README.md

@@ -1,145 +1,145 @@
-# Referral SaaSquatch Javascript SDK
-
-## Install the library
-
-To integrate any SaaSquatch program to your website or web app, copy/paste this snippet of JavaScript above the `</head>` tag of your page:
-
-```html
-<script type="text/javascript">
-!function(a,b){a("squatch","https://fast.ssqt.io/squatch-js@2",b)}(function(a,b,c){var d,e,f;c["_"+a]={},c[a]={},c[a].ready=function(b){c["_" + a].ready =  c["_" + a].ready || [];c["_" + a].ready.push(b);},e=document.createElement("script"),e.async=1,e.src=b,f=document.getElementsByTagName("script")[0],f.parentNode.insertBefore(e,f)},this);
-</script>
-```
-
-Or load the library synchronously from our CDN:
-
-```html
-<script src="https://fast.ssqt.io/squatch-js@2" type="text/javascript"></script>
-```
-
-
-## Getting Started
-The `init` function lets you configure your global squatch instance.
-
-Note: `engagementMedium` is required in the `squatch.widgets()` functions if you want to load the widget. Otherwise, Squatch.js will look for your portal settings and render the widget that's mapped to the URL where this snippet is included.
-
-```html
-<script type="text/javascript">
-  squatch.ready(function() {
-
-    // Always call init
-    squatch.init({
-      tenantAlias: "YOUR_TENANT_ALIAS",     // String (required)
-    });
-  
-    squatch.widgets().upsertUser({
-      user: {                               // Object (required)
-        id: 'USER_ID',                      // String (required)
-        accountId: 'USER_ACCOUNT_ID',       // String (required)
-        email: 'USER_EMAIL',                // String (optional)
-        firstName: 'USER_FIRST_NAME',       // String (optional)
-        lastName: 'USER_LAST_NAME',         // String (optional)
-  
-        ...
-      },
-      engagementMedium: 'EMBED',                    // String (optional: POPUP, EMBED)
-      widgetType: 'p/PROGRAM-ID/w/referrerWidget',  // Update PROGRAM-ID
-      jwt: 'TOKEN'                                  // String (required by default, or disable Security in the portal)
-
-    });
-  });
-</script>
-```
-
-## Data Only Operations
-You can create/upsert users without loading a widget.
-
-```html
-<script type="text/javascript">
-  squatch.ready(function() {
-
-    // Always call init
-    squatch.init({
-      tenantAlias: "YOUR_TENANT_ALIAS"      // String (required)
-    });
-
-    var user;
-
-    squatch.api().upsertUser({
-      user: {                               // Object (required)
-        id: 'USER_ID',                      // String (required)
-        accountId: 'USER_ACCOUNT_ID',       // String (required)
-        email: 'USER_EMAIL',                // String (optional)
-        firstName: 'USER_FIRST_NAME',       // String (optional)
-        lastName: 'USER_LAST_NAME',         // String (optional)
-        ...
-      },
-      engagementMedium: 'EMBED',                    // String (optional: POPUP, EMBED)
-      widgetType: 'p/PROGRAM-ID/w/referrerWidget',  // Update PROGRAM-ID
-      jwt: 'TOKEN'                                  // String (required)
-    }).then(function(response) {
-      user = response.user;
-    }).catch(function(err){
-      console.log(err);
-    });
-
-    // autofill
-    var element = document.getElementById('my_coupon');
-    element.value = user.referredBy.code;
-
-  });
-</script>
-```
-
-## Get Referral Cookie Code
-You can also use the `api()` function to call the WidgetApi methods directly.
-
-```html
-<script type="text/javascript">
-  squatch.ready(function(){
-
-    // Always call init
-    squatch.init({tenantAlias: 'YOUR_TENANT_ALIAS'});
-
-
-    var element = document.getElementById('my_coupon');
-
-    squatch.api().squatchReferralCookie().then(function(response) {
-      /* `response.codes` looks like `{"program_id":"NEWCO", "friend_program":"BOB"}` */
-      
-      element.value = response.codes["program-id"];
-    });
-
-  });
-</script>
-```
-
-Want more control? Visit our [guide](https://github.com/saasquatch/squatch-js/blob/master/docs/docs.md).
-
-
-## Install via NPM and Webpack (advanced)
-
-Squatch.js can also be installed via NPM and bundled into your application with Webpack.
-
-```ssh
-# via npm
-$ npm install @saasquatch/squatch-js
-```
-
-```js
-import * as squatch from "@saasquatch/squatch-js";
-
-// Always call init
-squatch.init({
-  tenantAlias: "YOUR_TENANT_ALIAS"      // String (required)
-});
-
-// Don't need to wait for .ready when importing via NPM/Webpack
-squatch.api().upsertUser({...});
-
-```
-
-## Contributing
-This is an open source project! If you are interested in contributing please look at [contributing guidelines](CONTRIBUTING.md) first.
-
-## Support
-Shoot us an email at [support@saasqt.ch](mailto:support@saasqt.ch) if you need help!
+# Referral SaaSquatch Javascript SDK
+
+## Install the library
+
+To integrate any SaaSquatch program to your website or web app, copy/paste this snippet of JavaScript above the `</head>` tag of your page:
+
+```html
+<script type="text/javascript">
+!function(a,b){a("squatch","https://fast.ssqt.io/squatch-js@2",b)}(function(a,b,c){var d,e,f;c["_"+a]={},c[a]={},c[a].ready=function(b){c["_" + a].ready =  c["_" + a].ready || [];c["_" + a].ready.push(b);},e=document.createElement("script"),e.async=1,e.src=b,f=document.getElementsByTagName("script")[0],f.parentNode.insertBefore(e,f)},this);
+</script>
+```
+
+Or load the library synchronously from our CDN:
+
+```html
+<script src="https://fast.ssqt.io/squatch-js@2" type="text/javascript"></script>
+```
+
+
+## Getting Started
+The `init` function lets you configure your global squatch instance.
+
+Note: `engagementMedium` is required in the `squatch.widgets()` functions if you want to load the widget. Otherwise, Squatch.js will look for your portal settings and render the widget that's mapped to the URL where this snippet is included.
+
+```html
+<script type="text/javascript">
+  squatch.ready(function() {
+
+    // Always call init
+    squatch.init({
+      tenantAlias: "YOUR_TENANT_ALIAS",     // String (required)
+    });
+  
+    squatch.widgets().upsertUser({
+      user: {                               // Object (required)
+        id: 'USER_ID',                      // String (required)
+        accountId: 'USER_ACCOUNT_ID',       // String (required)
+        email: 'USER_EMAIL',                // String (optional)
+        firstName: 'USER_FIRST_NAME',       // String (optional)
+        lastName: 'USER_LAST_NAME',         // String (optional)
+  
+        ...
+      },
+      engagementMedium: 'EMBED',                    // String (optional: POPUP, EMBED)
+      widgetType: 'p/PROGRAM-ID/w/referrerWidget',  // Update PROGRAM-ID
+      jwt: 'TOKEN'                                  // String (required by default, or disable Security in the portal)
+
+    });
+  });
+</script>
+```
+
+## Data Only Operations
+You can create/upsert users without loading a widget.
+
+```html
+<script type="text/javascript">
+  squatch.ready(function() {
+
+    // Always call init
+    squatch.init({
+      tenantAlias: "YOUR_TENANT_ALIAS"      // String (required)
+    });
+
+    var user;
+
+    squatch.api().upsertUser({
+      user: {                               // Object (required)
+        id: 'USER_ID',                      // String (required)
+        accountId: 'USER_ACCOUNT_ID',       // String (required)
+        email: 'USER_EMAIL',                // String (optional)
+        firstName: 'USER_FIRST_NAME',       // String (optional)
+        lastName: 'USER_LAST_NAME',         // String (optional)
+        ...
+      },
+      engagementMedium: 'EMBED',                    // String (optional: POPUP, EMBED)
+      widgetType: 'p/PROGRAM-ID/w/referrerWidget',  // Update PROGRAM-ID
+      jwt: 'TOKEN'                                  // String (required)
+    }).then(function(response) {
+      user = response.user;
+    }).catch(function(err){
+      console.log(err);
+    });
+
+    // autofill
+    var element = document.getElementById('my_coupon');
+    element.value = user.referredBy.code;
+
+  });
+</script>
+```
+
+## Get Referral Cookie Code
+You can also use the `api()` function to call the WidgetApi methods directly.
+
+```html
+<script type="text/javascript">
+  squatch.ready(function(){
+
+    // Always call init
+    squatch.init({tenantAlias: 'YOUR_TENANT_ALIAS'});
+
+
+    var element = document.getElementById('my_coupon');
+
+    squatch.api().squatchReferralCookie().then(function(response) {
+      /* `response.codes` looks like `{"program_id":"NEWCO", "friend_program":"BOB"}` */
+      
+      element.value = response.codes["program-id"];
+    });
+
+  });
+</script>
+```
+
+Want more control? Visit our [guide](https://github.com/saasquatch/squatch-js/blob/master/docs/docs.md).
+
+
+## Install via NPM and Webpack (advanced)
+
+Squatch.js can also be installed via NPM and bundled into your application with Webpack.
+
+```ssh
+# via npm
+$ npm install @saasquatch/squatch-js
+```
+
+```js
+import * as squatch from "@saasquatch/squatch-js";
+
+// Always call init
+squatch.init({
+  tenantAlias: "YOUR_TENANT_ALIAS"      // String (required)
+});
+
+// Don't need to wait for .ready when importing via NPM/Webpack
+squatch.api().upsertUser({...});
+
+```
+
+## Contributing
+This is an open source project! If you are interested in contributing please look at [contributing guidelines](CONTRIBUTING.md) first.
+
+## Support
+Shoot us an email at [support@saasqt.ch](mailto:support@saasqt.ch) if you need help!

package/demo/sandbox.ts

@@ -1,124 +1,124 @@
-import { getQueryStringParams } from "./util";
-
-export const tenantAlias = "test_aojsrf4r06zi0";
-export const domain = "https://staging.referralsaasquatch.com";
-export const script = "https://fast.ssqt.io/squatch-js@2";
-
-export const user = {
-  id: "5b980d34e4b0cabee07f2cb0",
-  accountId: "AZJZSVG0LS1LB19R",
-  email: "chesterscott.uexwltgh@mailosaur.io",
-};
-export const badJwtUser = {
-  ...user,
-  firstName: "Bad JWT",
-};
-export const noIds = {
-  firstName: "No IDs",
-};
-export const noUserId = {
-  accountId: "abc_123",
-  firstName: "No UserID",
-};
-export const noAccountId = {
-  id: "abc_123",
-  firstName: "No AccountID",
-};
-
-export const users = [user, badJwtUser, noIds, noUserId, noAccountId, {}];
-
-export const popup: Sandbox = {
-  script,
-  domain,
-  tenantAlias,
-  debug: true,
-  initObj: {
-    widgetType: "REFERRER_WIDGET",
-    engagementMedium: "POPUP",
-    user: user,
-    jwt: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoiNWI5ODBkMzRlNGIwY2FiZWUwN2YyY2IwIiwiYWNjb3VudElkIjoiQVpKWlNWRzBMUzFMQjE5UiIsImVtYWlsIjoiY2hlc3RlcnNjb3R0LnVleHdsdGdoQG1haWxvc2F1ci5pbyJ9fQ.MkrO7-980M7NRJcOUcdqCO1JftqmynLMK8bTEB3WObo",
-  },
-};
-
-export const embed: Sandbox = {
-  script,
-  domain,
-  tenantAlias,
-  initObj: {
-    widgetType: "REFERRER_WIDGET",
-    engagementMedium: "EMBED",
-    user: {
-      id: "5b980d34e4b0cabee07f2cb0",
-      accountId: "AZJZSVG0LS1LB19R",
-      email: "chesterscott.uexwltgh@mailosaur.io",
-    },
-    jwt: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoiNWI5ODBkMzRlNGIwY2FiZWUwN2YyY2IwIiwiYWNjb3VudElkIjoiQVpKWlNWRzBMUzFMQjE5UiIsImVtYWlsIjoiY2hlc3RlcnNjb3R0LnVleHdsdGdoQG1haWxvc2F1ci5pbyJ9fQ.MkrO7-980M7NRJcOUcdqCO1JftqmynLMK8bTEB3WObo",
-  },
-};
-
-export const embedNew: Sandbox = {
-  ...embed,
-  initObj: {
-    ...embed.initObj,
-    widgetType: "p/tuesday-text/w/referrerWidget",
-  },
-};
-
-export const embedReferred: Sandbox = {
-  ...embed,
-  initObj: {
-    ...embed.initObj,
-    widgetType: "CONVERSION_WIDGET",
-  },
-};
-
-export const popupReferred: Sandbox = {
-  ...popup,
-  initObj: {
-    ...popup.initObj,
-    widgetType: "CONVERSION_WIDGET",
-  },
-};
-
-export const popupNew: Sandbox = {
-  ...popup,
-  initObj: {
-    ...popup.initObj,
-    widgetType: "p/tuesday-test/w/referrerWidget",
-  },
-};
-
-export function fromURL() {
-  let urlSandbox;
-  try {
-    urlSandbox = JSON.parse(
-      window.atob(getQueryStringParams(window.location.search).sandbox)
-    );
-  } catch (e) {
-    urlSandbox = {};
-  }
-
-  const sandbox = {
-    ...popup,
-    ...urlSandbox,
-  };
-  return sandbox;
-}
-
-export function toURL(sandbox: Sandbox) {
-  window.location.href = href(sandbox);
-}
-
-export function href(sandbox: Sandbox) {
-  const urlParams = new URLSearchParams(window.location.search);
-  const param = window.btoa(JSON.stringify(sandbox));
-  var url = window.location.href;
-  if (url.indexOf("?") > 0) {
-    url = url.substring(0, url.indexOf("?"));
-  }
-
-  urlParams.delete("sandbox");
-
-  url += `?sandbox=${encodeURIComponent(param)}&${urlParams.toString()}`;
-  return url;
-}
+import { getQueryStringParams } from "./util";
+
+export const tenantAlias = "test_aojsrf4r06zi0";
+export const domain = "https://staging.referralsaasquatch.com";
+export const script = "https://fast.ssqt.io/squatch-js@2";
+
+export const user = {
+  id: "5b980d34e4b0cabee07f2cb0",
+  accountId: "AZJZSVG0LS1LB19R",
+  email: "chesterscott.uexwltgh@mailosaur.io",
+};
+export const badJwtUser = {
+  ...user,
+  firstName: "Bad JWT",
+};
+export const noIds = {
+  firstName: "No IDs",
+};
+export const noUserId = {
+  accountId: "abc_123",
+  firstName: "No UserID",
+};
+export const noAccountId = {
+  id: "abc_123",
+  firstName: "No AccountID",
+};
+
+export const users = [user, badJwtUser, noIds, noUserId, noAccountId, {}];
+
+export const popup: Sandbox = {
+  script,
+  domain,
+  tenantAlias,
+  debug: true,
+  initObj: {
+    widgetType: "REFERRER_WIDGET",
+    engagementMedium: "POPUP",
+    user: user,
+    jwt: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoiNWI5ODBkMzRlNGIwY2FiZWUwN2YyY2IwIiwiYWNjb3VudElkIjoiQVpKWlNWRzBMUzFMQjE5UiIsImVtYWlsIjoiY2hlc3RlcnNjb3R0LnVleHdsdGdoQG1haWxvc2F1ci5pbyJ9fQ.MkrO7-980M7NRJcOUcdqCO1JftqmynLMK8bTEB3WObo",
+  },
+};
+
+export const embed: Sandbox = {
+  script,
+  domain,
+  tenantAlias,
+  initObj: {
+    widgetType: "REFERRER_WIDGET",
+    engagementMedium: "EMBED",
+    user: {
+      id: "5b980d34e4b0cabee07f2cb0",
+      accountId: "AZJZSVG0LS1LB19R",
+      email: "chesterscott.uexwltgh@mailosaur.io",
+    },
+    jwt: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoiNWI5ODBkMzRlNGIwY2FiZWUwN2YyY2IwIiwiYWNjb3VudElkIjoiQVpKWlNWRzBMUzFMQjE5UiIsImVtYWlsIjoiY2hlc3RlcnNjb3R0LnVleHdsdGdoQG1haWxvc2F1ci5pbyJ9fQ.MkrO7-980M7NRJcOUcdqCO1JftqmynLMK8bTEB3WObo",
+  },
+};
+
+export const embedNew: Sandbox = {
+  ...embed,
+  initObj: {
+    ...embed.initObj,
+    widgetType: "p/tuesday-text/w/referrerWidget",
+  },
+};
+
+export const embedReferred: Sandbox = {
+  ...embed,
+  initObj: {
+    ...embed.initObj,
+    widgetType: "CONVERSION_WIDGET",
+  },
+};
+
+export const popupReferred: Sandbox = {
+  ...popup,
+  initObj: {
+    ...popup.initObj,
+    widgetType: "CONVERSION_WIDGET",
+  },
+};
+
+export const popupNew: Sandbox = {
+  ...popup,
+  initObj: {
+    ...popup.initObj,
+    widgetType: "p/tuesday-test/w/referrerWidget",
+  },
+};
+
+export function fromURL() {
+  let urlSandbox;
+  try {
+    urlSandbox = JSON.parse(
+      window.atob(getQueryStringParams(window.location.search).sandbox)
+    );
+  } catch (e) {
+    urlSandbox = {};
+  }
+
+  const sandbox = {
+    ...popup,
+    ...urlSandbox,
+  };
+  return sandbox;
+}
+
+export function toURL(sandbox: Sandbox) {
+  window.location.href = href(sandbox);
+}
+
+export function href(sandbox: Sandbox) {
+  const urlParams = new URLSearchParams(window.location.search);
+  const param = window.btoa(JSON.stringify(sandbox));
+  var url = window.location.href;
+  if (url.indexOf("?") > 0) {
+    url = url.substring(0, url.indexOf("?"));
+  }
+
+  urlParams.delete("sandbox");
+
+  url += `?sandbox=${encodeURIComponent(param)}&${urlParams.toString()}`;
+  return url;
+}