@saasquatch/squatch-js 2.4.3-4 → 2.4.3

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> | undefined;
+    pushAnalyticsLoadEvent(params: SQHDetails): Promise<any>;
     pushAnalyticsShareClickedEvent(params: SQHDetails & {
         shareMedium: string;
     }): Promise<any>;

package/dist/api/WidgetApi.d.ts

@@ -1,4 +1,4 @@
-import { ConfigOptions, WidgetConfig, WithRequired } from "../types";
+import { ConfigOptions, CookieUser, WidgetConfig, ReferralCookie } from "../types";
 /**
  *
  * The WidgetApi class is a wrapper around the Widget Endpoints of the SaaSquatch REST API.
@@ -25,6 +25,19 @@ export default class WidgetApi {
      * let squatchApi = new WidgetApi({tenantAlias:'test_12b5bo1b25125'});
      */
     constructor(config: ConfigOptions);
+    /**
+     * Creates/upserts an anonymous user.
+     *
+     * @param {Object} params Parameters for request
+     * @param {WidgetType} params.widgetType The content of the widget.
+     * @param {EngagementMedium} params.engagementMedium How to display the widget.
+     * @param {CookieUser} params.user An optional user object
+     * @param {string} params.jwt the JSON Web Token (JWT) that is used to
+     *                            validate the data (can be disabled)
+     *
+     * @return {Promise} json object if true, with the widget template, jsOptions and user details.
+     */
+    cookieUser(params: CookieUser): Promise<any>;
     /**
      * Creates/upserts user.
      *
@@ -39,7 +52,7 @@ export default class WidgetApi {
      *
      * @return {Promise} string if true, with the widget template, jsOptions and user details.
      */
-    upsertUser(params: WithRequired<WidgetConfig, "user">): Promise<any>;
+    upsertUser(params: WidgetConfig): Promise<any>;
     /**
      * Description here.
      *
@@ -74,7 +87,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/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, WidgetConfig, WidgetResult } from "./types";
+import { ConfigOptions } from "./types";
 export * from "./types";
 export * from "./docs";
 export { Widgets, EmbedWidget, PopupWidget, CtaWidget, WidgetApi };
@@ -32,16 +32,6 @@ 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:
  *
@@ -64,7 +54,7 @@ export declare function init(configIn: ConfigOptions): void;
  * @example
  * squatch.ready(function() {
  *   console.log("ready!");
- *   squatch.api().upsertUser();
+ *   squatch.api().cookieUser();
  * });
  */
 export declare function ready(fn: () => any): void;