@saasquatch/squatch-js 2.6.0-4 → 2.6.0-6

package/dist/api/WidgetApi.d.ts

@@ -26,7 +26,7 @@ export default class WidgetApi {
      */
     constructor(config?: ConfigOptions);
     /**
-     * Creates/upserts user.
+     * Creates/upserts user, requests widget template.
      *
      * @param {Object} params Parameters for request
      * @param {Object?} params.user The user details
@@ -41,7 +41,7 @@ export default class WidgetApi {
      */
     upsertUser(params: WithRequired<WidgetConfig, "user">): Promise<any>;
     /**
-     * Description here.
+     * Requests widget template
      *
      * @param {Object} params Parameters for request
      * @param {Object} params.user The user details

package/dist/squatch.d.ts

@@ -14,6 +14,10 @@ export { Widgets, EmbedWidget, PopupWidget, DeclarativeEmbedWidget, DeclarativeP
  * Read the {@link WidgetApi} docs.
  *
  * @returns WidgetApi static instance
+ * @example
+ * squatch.api().render({ ... })
+ * squatch.api().upsertUser({ ... })
+ * squatch.api().squatchReferralCookie()
  */
 export declare function api(): WidgetApi | null;
 /**
@@ -22,6 +26,10 @@ export declare function api(): WidgetApi | null;
  * Read the {@link Widgets} docs.
  *
  * @returns static instance
+ * @example
+ * squatch.widgets().render({ widgetType: "w/widget-type" })
+ * squatch.widgets().upsertUser({ user: { ... }, widgetType: "w/widget-type" })
+ * squatch.widgets().autofill(".referral-code")
  */
 export declare function widgets(): Widgets | null;
 /**
@@ -30,14 +38,27 @@ export declare function widgets(): Widgets | null;
  * Read the {@link EventsApi} docs.
  *
  * @returns EventsApi static instance
+ *
+ * @example
+ * squatch.events().track({ ... })
  */
 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}.
+ *
+ * Read the {@link Widgets.render} docs.
+ *
+ * @example
+ * squatch.widget().then(res => {
+ *   const widget = res.widget
+ * }).catch(e => console.error("Did not render widget:", e))
  */
 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}.
+ *
+ * Called by default on startup via the loader script.
+ * @private
  */
 export declare function _auto(configIn: ConfigOptions): Promise<WidgetResult | undefined> | undefined;
 /**
@@ -50,7 +71,9 @@ export declare function _auto(configIn: ConfigOptions): Promise<WidgetResult | u
  * @param config Configuration details
  *
  * @example
- * squatch.init({tenantAlias:'test_basbtabstq51v'});
+ * squatch.init({
+ *   tenantAlias:'test_basbtabstq51v',
+ * });
  */
 export declare function init(configIn: ConfigOptions): void;
 /**
@@ -72,6 +95,10 @@ export declare function ready(fn: () => any): void;
  *
  * @param {string} selector Element class/id
  * @returns {void}
+ *
+ * @example
+ * squatch.autofill("input.referral-code")
+ * squatch.autofill("input#referral-code")
  */
 export declare function autofill(selector: string): void;
 /**