@saasquatch/squatch-js 2.5.1-9 → 2.6.0-0

package/dist/types.d.ts

@@ -1,106 +1,107 @@
-import Widget from "./widgets/Widget";
-export declare type WithRequired<T, K extends keyof T> = T & {
-    [P in K]-?: T[P];
-};
-/**
- * When you load Squatch.js you need to provide these configuration options.
- *
- * @param tenantAlias The Tenant that you're using.
- * @param domain The domain for API. Defaults to `https://app.referralsaasquatch.com`
- * @param debug Enables debug logging. Defaults to `false`.
- */
-export interface ConfigOptions {
-    tenantAlias: string;
-    domain?: string;
-    npmCdn?: string;
-    debug?: boolean;
-}
-/**
- * Config options for loading a widget
- *
- * @param user The user details
- * @param widgetType The content of the widget.
- * @param engagementMedium  How to display the widget.
- * @param container  Element to load the widget into.
- * @param trigger Trigger element's selector for opening the popup widget
- * @param jwt the JSON Web Token (JWT) that is used
- */
-export interface WidgetConfig {
-    user?: User;
-    widgetType?: WidgetType;
-    engagementMedium?: EngagementMedium;
-    container?: HTMLElement | string;
-    trigger?: string;
-    jwt?: JWT;
-    locale?: string;
-    displayOnLoad?: boolean;
-}
-/**
- * @param user The user details
- * @param widgetType The content of the widget.
- * @param engagementMedium  How to display the widget.
- * @param jwt the JSON Web Token (JWT) that is used
- */
-export interface CookieWidgetConfig {
-    user?: CookieUser;
-    widgetType?: WidgetType;
-    engagementMedium?: EngagementMedium;
-    jwt?: JWT;
-}
-/**
- * When a widget is loaded using {@link Widgets} you'll get both the `user` data and the `widget` object back.
- *
- * @param widget The widget that was created.
- * @param user The user that's in the widget.
- *
- */
-export interface WidgetResult {
-    widget: Widget;
-    user: User;
-}
-export declare type User = {
-    id: string;
-    accountId: string;
-    [key: string]: any;
-};
-export declare type CookieUser = {
-    [key: string]: any;
-};
-/**
- * EngagementMedium is an enum for the content of the widgets.
- *
- * @example `widgetType: "POPUP"`
- */
-export declare type EngagementMedium = 
-/**  Displays the widget as a modal popup. Creates a {@link PopupWidget} */
-"POPUP"
-/**  Displays the widget embedded in the page. Create an {@link EmbedWidget} */
- | "EMBED";
-export declare type WidgetContext = {
-    type: "cookie" | "error" | "passwordless";
-    engagementMedium?: EngagementMedium;
-    container?: HTMLElement | string;
-    trigger?: string;
-    displayOnLoad?: boolean;
-} | {
-    type: "upsert";
-    user?: User | null;
-    engagementMedium?: EngagementMedium;
-    container?: HTMLElement | string;
-    trigger?: string;
-};
-export declare type WidgetContextType = "upsert" | "cookie" | "error" | "passwordless";
-/**
- * WidgetType is an enum for types of ways a Widget can be displayed.
- */
-export declare type WidgetType = 
-/** Widget content that lets people make referrals */
-"REFERRER_WIDGET"
-/** Widget content that shows that someone has been referred */
- | "CONVERSION_WIDGET" | string;
-export declare type ShareMedium = string;
-export declare type JWT = string;
-export declare type ReferralCookie = {
-    codes: string[];
-    encodedCookie: string;
-};
+import Widget from "./widgets/Widget";
+export type WithRequired<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};
+/**
+ * When you load Squatch.js you need to provide these configuration options.
+ *
+ * @param tenantAlias The Tenant that you're using.
+ * @param domain The domain for API. Defaults to `https://app.referralsaasquatch.com`
+ * @param debug Enables debug logging. Defaults to `false`.
+ */
+export interface ConfigOptions {
+    tenantAlias: string;
+    domain?: string;
+    npmCdn?: string;
+    debug?: boolean;
+}
+export type DeclarativeConfigOptions = Omit<ConfigOptions, "tenantAlias">;
+/**
+ * Config options for loading a widget
+ *
+ * @param user The user details
+ * @param widgetType The content of the widget.
+ * @param engagementMedium  How to display the widget.
+ * @param container  Element to load the widget into.
+ * @param trigger Trigger element's selector for opening the popup widget
+ * @param jwt the JSON Web Token (JWT) that is used
+ */
+export interface WidgetConfig {
+    user?: User;
+    widgetType?: WidgetType;
+    engagementMedium?: EngagementMedium;
+    container?: HTMLElement | string;
+    trigger?: string;
+    jwt?: JWT;
+    locale?: string;
+    displayOnLoad?: boolean;
+}
+/**
+ * @param user The user details
+ * @param widgetType The content of the widget.
+ * @param engagementMedium  How to display the widget.
+ * @param jwt the JSON Web Token (JWT) that is used
+ */
+export interface CookieWidgetConfig {
+    user?: CookieUser;
+    widgetType?: WidgetType;
+    engagementMedium?: EngagementMedium;
+    jwt?: JWT;
+}
+/**
+ * When a widget is loaded using {@link Widgets} you'll get both the `user` data and the `widget` object back.
+ *
+ * @param widget The widget that was created.
+ * @param user The user that's in the widget.
+ *
+ */
+export interface WidgetResult {
+    widget: Widget;
+    user: User;
+}
+export type User = {
+    id: string;
+    accountId: string;
+    [key: string]: any;
+};
+export type CookieUser = {
+    [key: string]: any;
+};
+/**
+ * EngagementMedium is an enum for the content of the widgets.
+ *
+ * @example `widgetType: "POPUP"`
+ */
+export type EngagementMedium = 
+/**  Displays the widget as a modal popup. Creates a {@link PopupWidget} */
+"POPUP"
+/**  Displays the widget embedded in the page. Create an {@link EmbedWidget} */
+ | "EMBED";
+export type WidgetContext = {
+    type: "cookie" | "error" | "passwordless";
+    engagementMedium?: EngagementMedium;
+    container?: HTMLElement | string;
+    trigger?: string;
+    displayOnLoad?: boolean;
+} | {
+    type: "upsert";
+    user?: User | null;
+    engagementMedium?: EngagementMedium;
+    container?: HTMLElement | string;
+    trigger?: string;
+};
+export type WidgetContextType = "upsert" | "cookie" | "error" | "passwordless";
+/**
+ * WidgetType is an enum for types of ways a Widget can be displayed.
+ */
+export type WidgetType = 
+/** Widget content that lets people make referrals */
+"REFERRER_WIDGET"
+/** Widget content that shows that someone has been referred */
+ | "CONVERSION_WIDGET" | string;
+export type ShareMedium = string;
+export type JWT = string;
+export type ReferralCookie = {
+    codes: string[];
+    encodedCookie: string;
+};

package/dist/utils/cookieUtils.d.ts

@@ -1,2 +1,2 @@
-export declare function b64decode(input: any): string;
-export declare function _pushCookie(): void;
+export declare function b64decode(input: any): string;
+export declare function _pushCookie(): void;

package/dist/utils/decodeUserJwt.d.ts

@@ -0,0 +1,2 @@
+import { User } from "../types";
+export declare function decodeUserJwt(tokenStr: string): User | null;

package/dist/utils/domUtils.d.ts

@@ -0,0 +1 @@
+export declare const createFrame: (container: string | HTMLElement, instance: any) => void;

package/dist/utils/domready.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="node" />
-/*!
- * domready (c) Dustin Diaz 2014 - License MIT
- *
- */
-export declare function domready(targetDoc: any, fn: any): number | NodeJS.Timeout;
+/// <reference types="node" />
+/*!
+ * domready (c) Dustin Diaz 2014 - License MIT
+ *
+ */
+export declare function domready(targetDoc: any, fn: any): number | NodeJS.Timeout;

package/dist/utils/io.d.ts

@@ -1,13 +1,5 @@
-import { JWT } from "../types";
-export declare function doQuery(url: string, query: string, variables: any, token: string | undefined): Promise<any>;
-export declare function doGet<T>(url: any, jwt?: string): Promise<T>;
-/**
- * @hidden
- *
- * @param url The requested url
- * @param data Stringified json object
- *
- * @returns {Promise} superagent promise
- */
-export declare function doPost(url: string, data: any, jwt?: JWT): Promise<any>;
-export declare function doPut(url: string, data: any, jwt?: JWT): Promise<any>;
+import { JWT } from "../types";
+export declare function doQuery(url: string, query: string, variables: Record<string, unknown>, token: string | undefined): Promise<any>;
+export declare function doGet<T>(url: any, jwt?: string): Promise<T>;
+export declare function doPost(url: string, data: any, jwt?: JWT): Promise<any>;
+export declare function doPut(url: string, data: any, jwt?: JWT): Promise<any>;

package/dist/utils/loadEvent.d.ts

@@ -0,0 +1,2 @@
+import AnalyticsApi from "../api/AnalyticsApi";
+export declare function loadEvent(sqh: unknown, analyticsApi: AnalyticsApi): void;

package/dist/utils/utmUtils.d.ts

@@ -1,14 +1,14 @@
-import { ConfigOptions, WidgetConfig } from "../types";
-export declare function _getAutoConfig(configIn: ConfigOptions): {
-    widgetConfig: WidgetConfig;
-    squatchConfig: ConfigOptions;
-} | undefined;
-/**
- * Deconstructs _saasquatchExtra into domain, tenantAlias, and widgetConfig
- * @param obj {Record<string, any>} Expected to be of the form `{ [appDomain]: { [tenantAlias]: { autoPopupWidgetType: [widgetType], [rest]?: ... } } }`
- */
-export declare function convertExtraToConfig(obj: Record<string, any>): {
-    domain: string | undefined;
-    tenantAlias: string;
-    widgetConfig: any;
-};
+import { ConfigOptions, WidgetConfig } from "../types";
+export declare function _getAutoConfig(configIn?: ConfigOptions): {
+    widgetConfig: WidgetConfig;
+    squatchConfig: ConfigOptions;
+} | undefined;
+/**
+ * Deconstructs _saasquatchExtra into domain, tenantAlias, and widgetConfig
+ * @param obj {Record<string, any>} Expected to be of the form `{ [appDomain]: { [tenantAlias]: { autoPopupWidgetType: [widgetType], [rest]?: ... } } }`
+ */
+export declare function convertExtraToConfig(obj: Record<string, any>): {
+    domain: string | undefined;
+    tenantAlias: string;
+    widgetConfig: any;
+};

package/dist/utils/validate.d.ts

@@ -1,16 +1,12 @@
-import { ConfigOptions, WidgetConfig } from "../types";
-declare type KeysOf<T> = keyof T;
-declare type SimpleObject = {
-    [key: string]: unknown;
-};
-export declare function hasProps<T extends SimpleObject & {}>(object: unknown, props: KeysOf<T> | KeysOf<T>[]): object is T;
-export declare function isObject(x: unknown): x is {};
-export declare function assertProp<T extends SimpleObject & {}>(object: unknown, ...props: KeysOf<T>[]): object is T;
-declare type Required<T> = T extends object ? {
-    [P in keyof T]-?: NonNullable<T[P]>;
-} : T;
-export declare function validateConfig(raw: unknown): Required<ConfigOptions>;
-export declare function validateLocale(locale?: string): string | undefined;
-export declare function validateWidgetConfig(raw: unknown): WidgetConfig;
-export declare function validatePasswordlessConfig(raw: unknown): WidgetConfig;
-export {};
+import { ConfigOptions, WidgetConfig } from "../types";
+export declare const DEFAULT_DOMAIN = "https://app.referralsaasquatch.com";
+export declare const DEFAULT_NPM_CDN = "https://fast.ssqt.io/npm";
+type Required<T> = T extends object ? {
+    [P in keyof T]-?: NonNullable<T[P]>;
+} : T;
+export declare function validateConfig(_raw?: unknown | undefined): Required<ConfigOptions>;
+export declare function isObject(obj: unknown): obj is object;
+export declare function validateLocale(locale?: string): string | undefined;
+export declare function validateWidgetConfig(raw: unknown | undefined): WidgetConfig;
+export declare function validatePasswordlessConfig(raw: unknown | undefined): WidgetConfig;
+export {};

package/dist/widgets/EmbedWidget.d.ts

@@ -1,15 +1,16 @@
-import Widget, { Params } from "./Widget";
-/**
- * An EmbedWidget is displayed inline in part of your page.
- *
- * To create an EmbedWidget use {@link Widgets}
- *
- */
-export default class EmbedWidget extends Widget {
-    element: HTMLElement;
-    constructor(params: Params, container?: HTMLElement | string);
-    load(): Promise<void>;
-    open(): void;
-    close(): void;
-    protected _error(rs: any, mode?: string, style?: string): string;
-}
+import Widget, { Params } from "./Widget";
+/**
+ * An EmbedWidget is displayed inline in part of your page.
+ *
+ * To create an EmbedWidget use {@link Widgets}
+ *
+ */
+export default class EmbedWidget extends Widget {
+    constructor(params: Params, container?: HTMLElement | string);
+    load(frame: HTMLIFrameElement): Promise<void>;
+    open(frame: HTMLIFrameElement): void;
+    close(frame: HTMLIFrameElement): void;
+    protected _error(rs: any, mode?: string, style?: string): string;
+    show: (frame: HTMLIFrameElement) => void;
+    hide: (frame: HTMLIFrameElement) => void;
+}

package/dist/widgets/IREmbedWidget.d.ts

@@ -0,0 +1,29 @@
+import AnalyticsApi from "../api/AnalyticsApi";
+import { DeclarativeConfigOptions, EmbedWidget, WidgetApi } from "../squatch";
+export default class IREmbedWidget extends HTMLElement {
+    widgetType: string | null;
+    container: string | HTMLElement | null;
+    element: HTMLElement;
+    frame: HTMLIFrameElement;
+    content: string;
+    analyticsApi: AnalyticsApi;
+    widgetApi: WidgetApi;
+    config: DeclarativeConfigOptions;
+    tenantAlias: string;
+    token: string;
+    widget: EmbedWidget;
+    constructor();
+    static get observedAttributes(): string[];
+    attributeChangedCallback(attr: string, oldVal: string, newVal: string): void;
+    _setupApi({ domain, tenantAlias }: {
+        domain: string;
+        tenantAlias: string;
+    }): void;
+    _loadPasswordlessWidget(): void;
+    _loadUserWidget(jwt: string): void;
+    _renderErrorWidget: () => void;
+    _renderWidget: (res: any) => void;
+    connectedCallback(): void;
+    open(): void;
+    close(): void;
+}

package/dist/widgets/IRPopupWidget.d.ts

@@ -0,0 +1,32 @@
+import AnalyticsApi from "../api/AnalyticsApi";
+import { PopupWidget, WidgetApi, WidgetContext } from "../squatch";
+export default class IRPopupWidget extends HTMLElement {
+    triggerElement: HTMLElement | null;
+    popupdiv: HTMLElement;
+    popupcontent: HTMLElement;
+    widgetType: string | null;
+    frame: HTMLIFrameElement;
+    analyticsApi: AnalyticsApi;
+    widgetApi: WidgetApi;
+    content: string;
+    widget: PopupWidget;
+    constructor();
+    static get observedAttributes(): string[];
+    attributeChangedCallback(attr: string, oldVal: string, newVal: string): void;
+    connectedCallback(): void;
+    _setupApi({ domain, tenantAlias }: {
+        domain: string;
+        tenantAlias: string;
+    }): void;
+    _setFrameContents(res: any): void;
+    _loadPasswordlessWidget(): void;
+    _loadUserWidget(jwt: string): void;
+    _renderErrorWidget(): void;
+    _renderWidget(res: any, context: WidgetContext): void;
+    protected _setupResizeHandler(): void;
+    protected _clickedOutside({ target }: {
+        target: any;
+    }): void;
+    open(): void;
+    close(): void;
+}

package/dist/widgets/PopupWidget.d.ts

@@ -1,23 +1,25 @@
-import Widget, { Params } from "./Widget";
-/**
- * The PopupWidget is used to display popups (also known as "Modals").
- * Popups widgets are rendered on top of other elements in a page.
- *
- * To create a PopupWidget use {@link Widgets}
- *
- */
-export default class PopupWidget extends Widget {
-    triggerElement: HTMLElement | null;
-    triggerWhenCTA: HTMLElement | null;
-    popupdiv: HTMLElement;
-    popupcontent: HTMLElement;
-    constructor(params: Params, trigger?: string);
-    load(): void;
-    protected _setupResizeHandler(): void;
-    open(): void;
-    close(): void;
-    protected _clickedOutside({ target }: {
-        target: any;
-    }): void;
-    protected _error(rs: any, mode?: string, style?: string): string;
-}
+import Widget, { Params } from "./Widget";
+/**
+ * The PopupWidget is used to display popups (also known as "Modals").
+ * Popups widgets are rendered on top of other elements in a page.
+ *
+ * To create a PopupWidget use {@link Widgets}
+ *
+ */
+export default class PopupWidget extends Widget {
+    trigger: string;
+    id: string;
+    constructor(params: Params, trigger?: string);
+    _initialiseCTA(frame: HTMLIFrameElement): void;
+    _createPopupDialog(): HTMLDialogElement;
+    load(frame: HTMLIFrameElement): void;
+    protected _setupResizeHandler(frame: HTMLIFrameElement): void;
+    open(frame: HTMLIFrameElement): void;
+    close(): void;
+    protected _clickedOutside({ target }: {
+        target: any;
+    }): void;
+    protected _error(rs: any, mode?: string, style?: string): string;
+    show: (frame: HTMLIFrameElement) => void;
+    hide: () => void;
+}

package/dist/widgets/Widget.d.ts

@@ -1,33 +1,53 @@
-import AnalyticsApi from "../api/AnalyticsApi";
-import WidgetApi from "../api/WidgetApi";
-import { WidgetType, WidgetContext } from "../types";
-export interface Params {
-    type: WidgetType;
-    domain: string;
-    npmCdn: string;
-    content: string;
-    api: WidgetApi;
-    rsCode?: string;
-    context: WidgetContext;
-}
-export default abstract class Widget {
-    frame: HTMLIFrameElement;
-    type: WidgetType;
-    content: string;
-    analyticsApi: AnalyticsApi;
-    widgetApi: WidgetApi;
-    context: WidgetContext;
-    npmCdn: string;
-    protected constructor(params: Params);
-    abstract load(): any;
-    protected _loadEvent(sqh: unknown): void;
-    protected _shareEvent(sqh: any, medium: any): void;
-    protected _inviteContacts(sqh: any, emailList: any): void;
-    protected _error(rs: any, mode?: string, style?: string): string;
-    protected _findInnerContainer(): Promise<Element>;
-    reload({ email, firstName, lastName }: {
-        email: any;
-        firstName: any;
-        lastName: any;
-    }, jwt: any): void;
-}
+import AnalyticsApi from "../api/AnalyticsApi";
+import WidgetApi from "../api/WidgetApi";
+import { EngagementMedium, WidgetContext, WidgetType } from "../types";
+export interface Params {
+    type: WidgetType;
+    domain: string;
+    npmCdn: string;
+    content: string;
+    api: WidgetApi;
+    rsCode?: string;
+    context: WidgetContext;
+    container?: string | HTMLElement | null | undefined;
+}
+export type ProgramLoadEvent = {
+    programId: string;
+    tenantAlias?: string;
+    accountId?: string;
+    userId?: string;
+    engagementMedium?: EngagementMedium;
+};
+export type GenericLoadEvent = {
+    mode: any;
+    analytics: any;
+};
+export default abstract class Widget {
+    type: WidgetType;
+    content: string;
+    analyticsApi: AnalyticsApi;
+    widgetApi: WidgetApi;
+    context: WidgetContext;
+    npmCdn: string;
+    container: string | HTMLElement | undefined | null;
+    protected constructor(params: Params);
+    _findElement(): HTMLElement;
+    _createFrame(): HTMLIFrameElement;
+    abstract load(frame: HTMLIFrameElement): void;
+    protected _loadEvent(sqh: ProgramLoadEvent | GenericLoadEvent): void;
+    protected _shareEvent(sqh: any, medium: any): void;
+    protected _error(rs: any, mode?: string, style?: string): string;
+    protected _findInnerContainer(frame: HTMLIFrameElement): Promise<Element>;
+    /**
+     * Reloads the current widget, makes updated request to API and renders result.
+     * Primarily for Classic widgets with registration
+     * @param param0 Form field values
+     * @param jwt JWT for API authentication
+     */
+    reload(frame: HTMLIFrameElement, { email, firstName, lastName }: {
+        email: any;
+        firstName: any;
+        lastName: any;
+    }, jwt: any): void;
+    private __deprecated__register;
+}