@saasquatch/squatch-js 2.5.0-0 → 2.5.1-0

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;