@saasquatch/squatch-js 2.4.2 → 2.4.3-1

package/CHANGELOG.md

@@ -1,285 +1,267 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-## [2.4.2] - 2023-04-10
-
-### Added
-
-- Added value to return data `squatchReferralCookie` to retrieve the encoded cookie
-
-- Example:
-
-```js
-squatch
-  .api()
-  .squatchReferralCookie()
-  .then(function (response) {
-    const cookie = response.encodedCookie;
-  });
-```
-
-## [2.4.1] - 2022-09-23
-
-### Added
-
-- Added event idempotencyKey to types
-
-## [2.4.0] - 2022-03-15
-
-### Changed
-
-- EmbedWidget now supports a `container` as either a selector or an HTMLElement as a parameter
-
-  - Widget contents will be loaded in a hidden widget and can be opened and closed with `widget.open()` and `widget.close()`
-
-- Example:
-
-```js
-var initObj = {
-  id: "testUser",
-  accountId: "testUser",
-  widgetType: "<MY_WIDGET>",
-  user: {
-    id: "testUser",
-    accountId: "testUser",
-  },
-  jwt: "<MY_JWT>",
-  engagementMedium: "EMBED",
-  container: ".myContainer",
-};
-
-squatch
-  .widgets()
-  .upsertUser(initObj)
-  .then(function (response) {
-    widget = response.widget;
-    widget.open();
-  })
-  .catch(function (error) {
-    console.log(error);
-  });
-```
-
-- PopupWidget now supports a `trigger` as a selector
-
-  - provides the ability to use a class other than `.squatchpop` for opening the widget
-
-- `sq:refresh` event is sent when `.open()` is called on EmbedWidget and PopupWidget
-
-## [2.3.1] - 2022-01-11
-
-### Changed
-
-- Reduced resize timeout to 500ms from 5000ms
-
-## [2.3.0] - 2021-05-19
-
-### Added
-
-- Typescript definitions
-- CommonJS/ES modules build for smaller bundle sizes when using squatch-js from NPM
-
-### Changed
-
-- `main` is now a CommonJS build instead of a UMD build
-
-## [2.2.1] - 2020-06-17
-
-### Changed
-
-- Remove the need to have JS Options, so that older clients can upgrade to squatch.js v2 easily.
-
-## [2.2.0] - 2020-06-12
-
-### Added
-
-- Reads `_saasquatch` from the URL and stores a 1st-party cookie on the specified landing page's domain.
-- Sets `cookies` on users during an upsert **automatically**
-
-```js
-{
-  user: {
-     id: "abc",
-     accountId: "abc",
-     cookies: "SAASQUATCHCOOKIE",
-     ...
-}
-```
-
-- Reads the 1st-party cookie when using `autofill`
-
-```js
-squatch
-  .api()
-  .squatchReferralCookie()
-  .then(function (response) {
-    element.value = response.codes["program-id"];
-  });
-```
-
-## [2.1.8] - 2020-05-25
-
-No release notes.
-
-## [2.1.7] - 2020-05-21
-
-No release notes.
-
-## [2.1.6] - 2019-04-15
-
-No release notes.
-
-## [2.1.5] - 2019-02-19
-
-No release notes.
-
-## [2.1.4] - 2019-01-03
-
-No release notes.
-
-## [2.1.3] - 2018-12-05
-
-No release notes.
-
-## [2.1.2] - 2018-10-22
-
-No release notes.
-
-## [2.1.1] - 2018-10-19
-
-### Fixed
-
-- POPUP Widget in iOS Safari is not clickable when is hidden anymore
-
-## [2.1.0] - 2018-09-26
-
-No release notes.
-
-## [2.0.17] - 2017-12-21
-
-### Fixed
-
-- Fixed content-type detection bug
-
-## [2.0.16] - 2017-10-24
-
-### Fixed
-
-- Fix scrolling issue to allow scrolling within popup modal
-
-## [2.0.15] - 2017-10-12
-
-### Added
-
-- Support for scrolling popup in mobile
-
-## [2.0.14] - 2017-10-11
-
-### Fixed
-
-- Fix registration form message in popup
-
-## [2.0.13] - 2017-08-03
-
-No release notes.
-
-## [2.0.12] - 2017-07-18
-
-No release notes.
-
-## [2.0.11] - 2017-07-18
-
-No release notes.
-
-## [2.0.10] - 2017-06-30
-
-No release notes.
-
-## [2.0.9] - 2017-06-08
-
-No release notes.
-
-## [2.0.8] - 2017-06-08
-
-No release notes.
-
-## [2.0.7] - 2017-04-24
-
-No release notes.
-
-## [2.0.6] - 2017-02-14
-
-### Fixed
-
-- Fix share tracking
-- Ignore CONVERSION_WIDGET widget rules when there's no referrals
-
-### Changed
-
-- Auto-fill content type check changed to non-case sensitive
-
-## [2.0.5] - 2016-12-07
-
-No release notes.
-
-## [2.0.4] - 2016-12-06
-
-No release notes.
-
-## [2.0.3] - 2016-11-30
-
-No release notes.
-
-## [2.0.2] - 2016-11-29
-
-No release notes.
-
-## [2.0.1] - 2016-11-25
-
-No release notes.
-
-## [2.0.0] - 2016-11-25
-
-No release notes.
-
-[unreleased]: https://github.com/saasquatch/squatch-js/compare/@saasquatch%2Fsquatch-js@2.4.2...HEAD
-[2.4.2]: https://github.com/saasquatch/squatch-js/compare/@saasquatch%2Fsquatch-js@2.4.1...@saasquatch%2Fsquatch-js@2.4.2
-[2.4.1]: https://github.com/saasquatch/squatch-js/compare/@saasquatch%2Fsquatch-js@2.4.0...@saasquatch%2Fsquatch-js@2.4.1
-[2.4.0]: https://github.com/saasquatch/squatch-js/compare/v2.3.1...@saasquatch%2Fsquatch-js@2.4.0
-[2.3.1]: https://github.com/saasquatch/squatch-js/compare/v2.3.0...v2.3.1
-[2.3.0]: https://github.com/saasquatch/squatch-js/compare/v2.2.1...v2.3.0
-[2.2.1]: https://github.com/saasquatch/squatch-js/compare/v2.2.0...v2.2.1
-[2.2.0]: https://github.com/saasquatch/squatch-js/compare/v2.1.8...v2.2.0
-[2.1.8]: https://github.com/saasquatch/squatch-js/compare/v2.1.7...v2.1.8
-[2.1.7]: https://github.com/saasquatch/squatch-js/compare/v2.1.6...v2.1.7
-[2.1.6]: https://github.com/saasquatch/squatch-js/compare/v2.1.5...v2.1.6
-[2.1.5]: https://github.com/saasquatch/squatch-js/compare/v2.1.4...v2.1.5
-[2.1.4]: https://github.com/saasquatch/squatch-js/compare/v2.1.3...v2.1.4
-[2.1.3]: https://github.com/saasquatch/squatch-js/compare/v2.1.2...v2.1.3
-[2.1.2]: https://github.com/saasquatch/squatch-js/compare/v2.1.1...v2.1.2
-[2.1.1]: https://github.com/saasquatch/squatch-js/compare/v2.1.0...v2.1.1
-[2.1.0]: https://github.com/saasquatch/squatch-js/compare/v2.0.17...v2.1.0
-[2.0.17]: https://github.com/saasquatch/squatch-js/compare/v2.0.16...v2.0.17
-[2.0.16]: https://github.com/saasquatch/squatch-js/compare/v2.0.15...v2.0.16
-[2.0.15]: https://github.com/saasquatch/squatch-js/compare/v2.0.14...v2.0.15
-[2.0.14]: https://github.com/saasquatch/squatch-js/compare/v2.0.13...v2.0.14
-[2.0.13]: https://github.com/saasquatch/squatch-js/compare/v2.0.12...v2.0.13
-[2.0.12]: https://github.com/saasquatch/squatch-js/compare/v2.0.11...v2.0.12
-[2.0.11]: https://github.com/saasquatch/squatch-js/compare/v2.0.10...v2.0.11
-[2.0.10]: https://github.com/saasquatch/squatch-js/compare/v2.0.9...v2.0.10
-[2.0.9]: https://github.com/saasquatch/squatch-js/compare/v2.0.8...v2.0.9
-[2.0.8]: https://github.com/saasquatch/squatch-js/compare/v2.0.7...v2.0.8
-[2.0.7]: https://github.com/saasquatch/squatch-js/compare/v2.0.6...v2.0.7
-[2.0.6]: https://github.com/saasquatch/squatch-js/compare/v2.0.5...v2.0.6
-[2.0.5]: https://github.com/saasquatch/squatch-js/compare/v2.0.4...v2.0.5
-[2.0.4]: https://github.com/saasquatch/squatch-js/compare/v2.0.3...v2.0.4
-[2.0.3]: https://github.com/saasquatch/squatch-js/compare/v2.0.2...v2.0.3
-[2.0.2]: https://github.com/saasquatch/squatch-js/compare/v2.0.1...v2.0.2
-[2.0.1]: https://github.com/saasquatch/squatch-js/compare/v2.0.0...v2.0.1
-[2.0.0]: https://github.com/saasquatch/squatch-js/releases/tag/v2.0.0
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [2.4.1] - 2022-09-23
+
+### Added
+
+- Added event idempotencyKey to types
+
+## [2.4.0] - 2022-03-15
+
+### Changed
+
+- EmbedWidget now supports a `container` as either a selector or an HTMLElement as a parameter
+
+  - Widget contents will be loaded in a hidden widget and can be opened and closed with `widget.open()` and `widget.close()`
+
+- Example:
+
+```js
+var initObj = {
+  id: "testUser",
+  accountId: "testUser",
+  widgetType: "<MY_WIDGET>",
+  user: {
+    id: "testUser",
+    accountId: "testUser",
+  },
+  jwt: "<MY_JWT>",
+  engagementMedium: "EMBED",
+  container: ".myContainer",
+};
+
+squatch
+  .widgets()
+  .upsertUser(initObj)
+  .then(function (response) {
+    widget = response.widget;
+    widget.open();
+  })
+  .catch(function (error) {
+    console.log(error);
+  });
+```
+
+- PopupWidget now supports a `trigger` as a selector
+
+  - provides the ability to use a class other than `.squatchpop` for opening the widget
+
+- `sq:refresh` event is sent when `.open()` is called on EmbedWidget and PopupWidget
+
+## [2.3.1] - 2022-01-11
+
+### Changed
+
+- Reduced resize timeout to 500ms from 5000ms
+
+## [2.3.0] - 2021-05-19
+
+### Added
+
+- Typescript definitions
+- CommonJS/ES modules build for smaller bundle sizes when using squatch-js from NPM
+
+### Changed
+
+- `main` is now a CommonJS build instead of a UMD build
+
+## [2.2.1] - 2020-06-17
+
+### Changed
+
+- Remove the need to have JS Options, so that older clients can upgrade to squatch.js v2 easily.
+
+## [2.2.0] - 2020-06-12
+
+### Added
+
+- Reads `_saasquatch` from the URL and stores a 1st-party cookie on the specified landing page's domain.
+- Sets `cookies` on users during an upsert **automatically**
+
+```js
+{
+  user: {
+     id: "abc",
+     accountId: "abc",
+     cookies: "SAASQUATCHCOOKIE",
+     ...
+}
+```
+
+- Reads the 1st-party cookie when using `autofill`
+
+```js
+squatch
+  .api()
+  .squatchReferralCookie()
+  .then(function (response) {
+    element.value = response.codes["program-id"];
+  });
+```
+
+## [2.1.8] - 2020-05-25
+
+No release notes.
+
+## [2.1.7] - 2020-05-21
+
+No release notes.
+
+## [2.1.6] - 2019-04-15
+
+No release notes.
+
+## [2.1.5] - 2019-02-19
+
+No release notes.
+
+## [2.1.4] - 2019-01-03
+
+No release notes.
+
+## [2.1.3] - 2018-12-05
+
+No release notes.
+
+## [2.1.2] - 2018-10-22
+
+No release notes.
+
+## [2.1.1] - 2018-10-19
+
+### Fixed
+
+- POPUP Widget in iOS Safari is not clickable when is hidden anymore
+
+## [2.1.0] - 2018-09-26
+
+No release notes.
+
+## [2.0.17] - 2017-12-21
+
+### Fixed
+
+- Fixed content-type detection bug
+
+## [2.0.16] - 2017-10-24
+
+### Fixed
+
+- Fix scrolling issue to allow scrolling within popup modal
+
+## [2.0.15] - 2017-10-12
+
+### Added
+
+- Support for scrolling popup in mobile
+
+## [2.0.14] - 2017-10-11
+
+### Fixed
+
+- Fix registration form message in popup
+
+## [2.0.13] - 2017-08-03
+
+No release notes.
+
+## [2.0.12] - 2017-07-18
+
+No release notes.
+
+## [2.0.11] - 2017-07-18
+
+No release notes.
+
+## [2.0.10] - 2017-06-30
+
+No release notes.
+
+## [2.0.9] - 2017-06-08
+
+No release notes.
+
+## [2.0.8] - 2017-06-08
+
+No release notes.
+
+## [2.0.7] - 2017-04-24
+
+No release notes.
+
+## [2.0.6] - 2017-02-14
+
+### Fixed
+
+- Fix share tracking
+- Ignore CONVERSION_WIDGET widget rules when there's no referrals
+
+### Changed
+
+- Auto-fill content type check changed to non-case sensitive
+
+## [2.0.5] - 2016-12-07
+
+No release notes.
+
+## [2.0.4] - 2016-12-06
+
+No release notes.
+
+## [2.0.3] - 2016-11-30
+
+No release notes.
+
+## [2.0.2] - 2016-11-29
+
+No release notes.
+
+## [2.0.1] - 2016-11-25
+
+No release notes.
+
+## [2.0.0] - 2016-11-25
+
+No release notes.
+
+[unreleased]: https://github.com/saasquatch/squatch-js/compare/@saasquatch%2Fsquatch-js@2.4.1...HEAD
+[2.4.1]: https://github.com/saasquatch/squatch-js/compare/@saasquatch%2Fsquatch-js@2.4.0...@saasquatch%2Fsquatch-js@2.4.1
+[2.4.0]: https://github.com/saasquatch/squatch-js/compare/v2.3.1...@saasquatch%2Fsquatch-js@2.4.0
+[2.3.1]: https://github.com/saasquatch/squatch-js/compare/v2.3.0...v2.3.1
+[2.3.0]: https://github.com/saasquatch/squatch-js/compare/v2.2.1...v2.3.0
+[2.2.1]: https://github.com/saasquatch/squatch-js/compare/v2.2.0...v2.2.1
+[2.2.0]: https://github.com/saasquatch/squatch-js/compare/v2.1.8...v2.2.0
+[2.1.8]: https://github.com/saasquatch/squatch-js/compare/v2.1.7...v2.1.8
+[2.1.7]: https://github.com/saasquatch/squatch-js/compare/v2.1.6...v2.1.7
+[2.1.6]: https://github.com/saasquatch/squatch-js/compare/v2.1.5...v2.1.6
+[2.1.5]: https://github.com/saasquatch/squatch-js/compare/v2.1.4...v2.1.5
+[2.1.4]: https://github.com/saasquatch/squatch-js/compare/v2.1.3...v2.1.4
+[2.1.3]: https://github.com/saasquatch/squatch-js/compare/v2.1.2...v2.1.3
+[2.1.2]: https://github.com/saasquatch/squatch-js/compare/v2.1.1...v2.1.2
+[2.1.1]: https://github.com/saasquatch/squatch-js/compare/v2.1.0...v2.1.1
+[2.1.0]: https://github.com/saasquatch/squatch-js/compare/v2.0.17...v2.1.0
+[2.0.17]: https://github.com/saasquatch/squatch-js/compare/v2.0.16...v2.0.17
+[2.0.16]: https://github.com/saasquatch/squatch-js/compare/v2.0.15...v2.0.16
+[2.0.15]: https://github.com/saasquatch/squatch-js/compare/v2.0.14...v2.0.15
+[2.0.14]: https://github.com/saasquatch/squatch-js/compare/v2.0.13...v2.0.14
+[2.0.13]: https://github.com/saasquatch/squatch-js/compare/v2.0.12...v2.0.13
+[2.0.12]: https://github.com/saasquatch/squatch-js/compare/v2.0.11...v2.0.12
+[2.0.11]: https://github.com/saasquatch/squatch-js/compare/v2.0.10...v2.0.11
+[2.0.10]: https://github.com/saasquatch/squatch-js/compare/v2.0.9...v2.0.10
+[2.0.9]: https://github.com/saasquatch/squatch-js/compare/v2.0.8...v2.0.9
+[2.0.8]: https://github.com/saasquatch/squatch-js/compare/v2.0.7...v2.0.8
+[2.0.7]: https://github.com/saasquatch/squatch-js/compare/v2.0.6...v2.0.7
+[2.0.6]: https://github.com/saasquatch/squatch-js/compare/v2.0.5...v2.0.6
+[2.0.5]: https://github.com/saasquatch/squatch-js/compare/v2.0.4...v2.0.5
+[2.0.4]: https://github.com/saasquatch/squatch-js/compare/v2.0.3...v2.0.4
+[2.0.3]: https://github.com/saasquatch/squatch-js/compare/v2.0.2...v2.0.3
+[2.0.2]: https://github.com/saasquatch/squatch-js/compare/v2.0.1...v2.0.2
+[2.0.1]: https://github.com/saasquatch/squatch-js/compare/v2.0.0...v2.0.1
+[2.0.0]: https://github.com/saasquatch/squatch-js/releases/tag/v2.0.0

package/README.md

@@ -45,7 +45,6 @@ Note: `engagementMedium` is required in the `squatch.widgets()` functions if you
       widgetType: 'p/PROGRAM-ID/w/referrerWidget',  // Update PROGRAM-ID
       jwt: 'TOKEN'                                  // String (required by default, or disable Security in the portal)
 
-    });
   });
 </script>
 ```

package/demo/sandbox.ts

@@ -36,8 +36,7 @@ export const popup: Sandbox = {
     widgetType: "REFERRER_WIDGET",
     engagementMedium: "POPUP",
     user: user,
-    jwt:
-      "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoiNWI5ODBkMzRlNGIwY2FiZWUwN2YyY2IwIiwiYWNjb3VudElkIjoiQVpKWlNWRzBMUzFMQjE5UiIsImVtYWlsIjoiY2hlc3RlcnNjb3R0LnVleHdsdGdoQG1haWxvc2F1ci5pbyJ9fQ.MkrO7-980M7NRJcOUcdqCO1JftqmynLMK8bTEB3WObo",
+    jwt: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoiNWI5ODBkMzRlNGIwY2FiZWUwN2YyY2IwIiwiYWNjb3VudElkIjoiQVpKWlNWRzBMUzFMQjE5UiIsImVtYWlsIjoiY2hlc3RlcnNjb3R0LnVleHdsdGdoQG1haWxvc2F1ci5pbyJ9fQ.MkrO7-980M7NRJcOUcdqCO1JftqmynLMK8bTEB3WObo",
   },
 };
 
@@ -53,8 +52,7 @@ export const embed: Sandbox = {
       accountId: "AZJZSVG0LS1LB19R",
       email: "chesterscott.uexwltgh@mailosaur.io",
     },
-    jwt:
-      "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoiNWI5ODBkMzRlNGIwY2FiZWUwN2YyY2IwIiwiYWNjb3VudElkIjoiQVpKWlNWRzBMUzFMQjE5UiIsImVtYWlsIjoiY2hlc3RlcnNjb3R0LnVleHdsdGdoQG1haWxvc2F1ci5pbyJ9fQ.MkrO7-980M7NRJcOUcdqCO1JftqmynLMK8bTEB3WObo",
+    jwt: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoiNWI5ODBkMzRlNGIwY2FiZWUwN2YyY2IwIiwiYWNjb3VudElkIjoiQVpKWlNWRzBMUzFMQjE5UiIsImVtYWlsIjoiY2hlc3RlcnNjb3R0LnVleHdsdGdoQG1haWxvc2F1ci5pbyJ9fQ.MkrO7-980M7NRJcOUcdqCO1JftqmynLMK8bTEB3WObo",
   },
 };
 
@@ -112,11 +110,15 @@ export function toURL(sandbox: 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("?"));
   }
-  url += `?sandbox=${encodeURIComponent(param)}`;
+
+  urlParams.delete("sandbox");
+
+  url += `?sandbox=${encodeURIComponent(param)}&${urlParams.toString()}`;
   return url;
 }

package/demo/toolbar.tsx

@@ -245,7 +245,7 @@ function ModeList(props) {
 function UserList(props) {
   return (
     <details
-      title={"User: " + window["sandbox"].initObj.user.firstName}
+      title={"User: " + window["sandbox"].initObj.user?.firstName}
       key={0}
       id={`dropdown-basic-1`}
     >

package/dist/api/WidgetApi.d.ts

@@ -1,4 +1,4 @@
-import { ConfigOptions, CookieUser, WidgetConfig, ReferralCookie } from "../types";
+import { ConfigOptions, CookieUser, WidgetConfig, WithRequired } from "../types";
 /**
  *
  * The WidgetApi class is a wrapper around the Widget Endpoints of the SaaSquatch REST API.
@@ -52,7 +52,7 @@ export default class WidgetApi {
      *
      * @return {Promise} string if true, with the widget template, jsOptions and user details.
      */
-    upsertUser(params: WidgetConfig): Promise<any>;
+    upsertUser(params: WithRequired<WidgetConfig, "user">): Promise<any>;
     /**
      * Description here.
      *
@@ -87,7 +87,7 @@ export default class WidgetApi {
     /**
      * Looks up the referral code of the current user, if there is any.
      *
-     * @return {Promise<ReferralCookie>} code referral code if true.
+     * @return {Promise<Object>} code referral code if true.
      */
-    squatchReferralCookie(): Promise<ReferralCookie>;
+    squatchReferralCookie(): Promise<object>;
 }

package/dist/squatch.d.ts

@@ -4,7 +4,7 @@ import PopupWidget from "./widgets/PopupWidget";
 import CtaWidget from "./widgets/CtaWidget";
 import WidgetApi from "./api/WidgetApi";
 import EventsApi from "./api/EventsApi";
-import { ConfigOptions } from "./types";
+import { ConfigOptions, WidgetConfig, WidgetResult } from "./types";
 export * from "./types";
 export * from "./docs";
 export { Widgets, EmbedWidget, PopupWidget, CtaWidget, WidgetApi };
@@ -32,6 +32,16 @@ export declare function widgets(): Widgets | null;
  * @returns EventsApi static instance
  */
 export declare function events(): EventsApi | null;
+/**
+ * Entry-point for high level API to render a widget using the instance of {@link Widgets} created when you call {@link #init init}.
+ */
+export declare function widget(widgetConfig: WidgetConfig): Promise<WidgetResult | undefined> | undefined;
+/**
+ * Initial concept for automatic widget rendering
+ *
+ * - `saasquatchExtra` utm param carries widgetIdent
+ */
+export declare function auto(configIn: ConfigOptions): Promise<WidgetResult | undefined> | undefined;
 /**
  * Initializes the static `squatch` global. This sets up:
  *