@saasquatch/squatch-js 2.5.0-0 → 2.5.0

package/CHANGELOG.md

@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [2.5.0] - 2022-12-01
+## [2.5.0] - 2023-05-16
 
 ### Removed
 
@@ -15,7 +15,53 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- Widgets.render now calls upsertUser rather than cookieUser api method
+- Widgets.render now queries renderWidget rather than cookieUser api method
+- Added squatch.widget function to render a widget without user upsert
+
+- Example:
+
+```js
+var initObj = {
+  widgetType: "<MY_WIDGET>",
+  engagementMedium: "EMBED",
+  container: ".myContainer",
+};
+
+squatch
+  .widget(initObj)
+  .then(function (response) {
+    const widget = response.widget
+  })
+  .catch(function (error) {
+    console.log(error);
+  });
+```
+
+- Added auto-popup widget support:
+  - Reads `_saasquatchExtra` from the URL on load
+  - Renders the encoded widget from `_saasquatchExtra` parameter as a Popup Widget on load
+
+## [2.4.3] - 2023-04-20
+
+### Changed
+- Updated license copyright to be in line with SaaSquatch open-source policy.
+
+## [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
 
@@ -243,6 +289,8 @@ No release notes.
 
 [unreleased]: https://github.com/saasquatch/squatch-js/compare/@saasquatch%2Fsquatch-js@2.5.0...HEAD
 [2.5.0]: https://github.com/saasquatch/squatch-js/compare/@saasquatch%2Fsquatch-js@2.4.1...@saasquatch%2Fsquatch-js@2.5.0
+[2.4.3]: https://github.com/saasquatch/squatch-js/compare/@saasquatch%2Fsquatch-js@2.4.2...@saasquatch%2Fsquatch-js@2.4.3
+[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

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 ReferralSaaSquatch.com, Inc
+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

package/README.md

@@ -45,6 +45,7 @@ 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/AnalyticsApi.d.ts

@@ -18,7 +18,7 @@ export default class AnalyticsApi {
     constructor(config: {
         domain: string;
     });
-    pushAnalyticsLoadEvent(params: SQHDetails): Promise<any>;
+    pushAnalyticsLoadEvent(params: SQHDetails): Promise<any> | undefined;
     pushAnalyticsShareClickedEvent(params: SQHDetails & {
         shareMedium: string;
     }): Promise<any>;

package/dist/api/WidgetApi.d.ts

@@ -1,4 +1,4 @@
-import { ConfigOptions, WidgetConfig } from "../types";
+import { ConfigOptions, ReferralCookie, WidgetConfig, WithRequired } from "../types";
 /**
  *
  * The WidgetApi class is a wrapper around the Widget Endpoints of the SaaSquatch REST API.
@@ -39,7 +39,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.
      *
@@ -74,7 +74,7 @@ export default class WidgetApi {
     /**
      * Looks up the referral code of the current user, if there is any.
      *
-     * @return {Promise<Object>} code referral code if true.
+     * @return {Promise<ReferralCookie>} code referral code if true.
      */
-    squatchReferralCookie(): Promise<object>;
+    squatchReferralCookie(): Promise<ReferralCookie>;
 }

package/dist/api/graphql.d.ts

@@ -0,0 +1 @@
+export declare const RENDER_WIDGET_QUERY = "\n  query renderWidget ($user: UserIdInput, $engagementMedium: UserEngagementMedium, $widgetType: WidgetType, $locale: RSLocale) {\n    renderWidget(user: $user, engagementMedium: $engagementMedium, widgetType: $widgetType, locale: $locale) {\n      template\n      user {\n        id\n        accountId\n      }\n      jsOptions\n      widgetConfig {\n        values\n      }\n    }\n  }\n";

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,14 @@ 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;
+/**
+ * Extracts widget configuration from `_saasquatchExtra` UTM parameter. Initialises `squatch` and renders the widget as a {@link PopupWidget} via static instanct of {@link Widgets}.
+ */
+export declare function _auto(configIn: ConfigOptions): Promise<WidgetResult | undefined> | undefined;
 /**
  * Initializes the static `squatch` global. This sets up:
  *
@@ -54,7 +62,7 @@ export declare function init(configIn: ConfigOptions): void;
  * @example
  * squatch.ready(function() {
  *   console.log("ready!");
- *   squatch.api().cookieUser();
+ *   squatch.api().upsertUser();
  * });
  */
 export declare function ready(fn: () => any): void;