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

package/dist/widgets/Widgets.d.ts

@@ -1,116 +1,108 @@
-import WidgetApi from "../api/WidgetApi";
-import { WidgetResult, WithRequired } from "../types";
-import { ConfigOptions, WidgetConfig } from "../types";
-/**
- *
- * `Widgets` is a factory for creating widgets. It's possible to build your own widgets using the
- * {@link WidgetApi} but most people will prefer to use these easy methods.
- *
- */
-export default class Widgets {
-    api: WidgetApi;
-    tenantAlias: string;
-    domain: string;
-    npmCdn: string;
-    eventBus: any;
-    /**
-     * Initialize a new {@link Widgets} instance.
-     *
-     * @param {ConfigOptions} config Config details
-     *
-     * @example <caption>Browser example</caption>
-     * var widgets = new squatch.Widgets({tenantAlias:'test_12b5bo1b25125'});
-     *
-     * @example <caption>Browserify/Webpack example</caption>
-     * var Widgets = require('@saasquatch/squatch-js').Widgets;
-     * var widgets = new Widgets({tenantAlias:'test_12b5bo1b25125'});
-     *
-     * @example <caption>Babel+Browserify/Webpack example</caption>
-     * import {Widgets} from '@saasquatch/squatch-js';
-     * let widgets = new Widgets({tenantAlias:'test_12b5bo1b25125'});
-     */
-    constructor(configin: ConfigOptions);
-    /**
-     * This function calls the {@link WidgetApi.upsertUser} method, and it renders
-     * the widget if it is successful. Otherwise it shows the "error" widget.
-     *
-     * @param {Object} config Config details
-     * @param {Object} config.user The user details
-     * @param {string} config.user.id The user id
-     * @param {string} config.user.accountId The user account id
-     * @param {WidgetType} config.widgetType The content of the widget.
-     * @param {EngagementMedium} config.engagementMedium How to display the widget.
-     * @param {string} config.jwt the JSON Web Token (JWT) that is used to validate the data (can be disabled)
-     * @param {HTMLElement | string | undefined} config.container Element to load the widget into
-     * @param {string | undefined} config.trigger Trigger element for opening the popup widget
-     *
-     * @return {Promise<WidgetResult>} json object if true, with a Widget and user details.
-     */
-    upsertUser(config: WithRequired<WidgetConfig, "user">): Promise<{
-        widget: any;
-        user: any;
-    }>;
-    /**
-     * This function calls the {@link WidgetApi.render} method, and it renders
-     * the widget if it is successful. Otherwise it shows the "error" widget.
-     *
-     * @param {Object} config Config details
-     * @param {Object} config.user The user details
-     * @param {string} config.user.id The user id
-     * @param {string} config.user.accountId The user account id
-     * @param {WidgetType} config.widgetType The content of the widget.
-     * @param {EngagementMedium} config.engagementMedium How to display the widget.
-     * @param {string} config.jwt the JSON Web Token (JWT) that is used
-     *                            to validate the data (can be disabled)
-     *
-     * @return {Promise<WidgetResult>} json object if true, with a Widget and user details.
-     */
-    render(config: WidgetConfig): Promise<WidgetResult | undefined>;
-    /**
-     * Autofills a referral code into an element when someone has been referred.
-     * Uses {@link WidgetApi.squatchReferralCookie} behind the scenes.
-     *
-     * @param selector Element class/id selector, or a callback function
-     * @returns
-     */
-    autofill(selector: string | Function): void;
-    /**
-     * Overrides the default function that submits the user email. If you have
-     * Security enabled, the email needs to be signed before it's submitted.
-     *
-     * @param {function} fn Callback function for the 'submit_email' event.
-     * @returns {void}
-     */
-    submitEmail(fn: any): void;
-    /**
-     * @hidden
-     * @param {Object} response The json object return from the WidgetApi
-     * @param {Object} config Config details
-     * @param {string} config.widgetType The widget type (REFERRER_WIDGET, CONVERSION_WIDGET)
-     * @param {string} config.engagementMedium (POPUP, EMBED)
-     * @returns {Widget} widget (PopupWidget, EmbedWidget, or CtaWidget)
-     */
-    private _renderWidget;
-    /**
-     * @hidden
-     * @param {Object} error The json object containing the error details
-     * @param {string} em The engagementMedium
-     * @returns {void}
-     */
-    private _renderErrorWidget;
-    /**
-     * @hidden
-     * @param {string} rule A regular expression
-     * @returns {boolean} true if rule matches Url, false otherwise
-     */
-    private static _matchesUrl;
-    /**
-     * @hidden
-     * @param {Object} target Object containing the target DOM element
-     * @param {Widget} widget A widget (EmbedWidget, PopupWidget, CtaWidget)
-     * @param {Object} params An object with valid parameters
-     *                        (e.g) {email:'email', firstName:'firstName'}
-     * @returns {void}
-     */
-    private static _cb;
-}
+import WidgetApi from "../api/WidgetApi";
+import { ConfigOptions, WidgetConfig, WidgetResult, WithRequired } from "../types";
+/**
+ *
+ * `Widgets` is a factory for creating widgets. It's possible to build your own widgets using the
+ * {@link WidgetApi} but most people will prefer to use these easy methods.
+ *
+ */
+export default class Widgets {
+    api: WidgetApi;
+    tenantAlias: string;
+    domain: string;
+    npmCdn: string;
+    /**
+     * Initialize a new {@link Widgets} instance.
+     *
+     * @param {ConfigOptions} config Config details
+     *
+     * @example <caption>Browser example</caption>
+     * var widgets = new squatch.Widgets({tenantAlias:'test_12b5bo1b25125'});
+     *
+     * @example <caption>Browserify/Webpack example</caption>
+     * var Widgets = require('@saasquatch/squatch-js').Widgets;
+     * var widgets = new Widgets({tenantAlias:'test_12b5bo1b25125'});
+     *
+     * @example <caption>Babel+Browserify/Webpack example</caption>
+     * import {Widgets} from '@saasquatch/squatch-js';
+     * let widgets = new Widgets({tenantAlias:'test_12b5bo1b25125'});
+     */
+    constructor(configin: ConfigOptions);
+    /**
+     * This function calls the {@link WidgetApi.upsertUser} method, and it renders
+     * the widget if it is successful. Otherwise it shows the "error" widget.
+     *
+     * @param {Object} config Config details
+     * @param {Object} config.user The user details
+     * @param {string} config.user.id The user id
+     * @param {string} config.user.accountId The user account id
+     * @param {WidgetType} config.widgetType The content of the widget.
+     * @param {EngagementMedium} config.engagementMedium How to display the widget.
+     * @param {string} config.jwt the JSON Web Token (JWT) that is used to validate the data (can be disabled)
+     * @param {HTMLElement | string | undefined} config.container Element to load the widget into
+     * @param {string | undefined} config.trigger Trigger element for opening the popup widget
+     *
+     * @return {Promise<WidgetResult>} json object if true, with a Widget and user details.
+     */
+    upsertUser(config: WithRequired<WidgetConfig, "user">): Promise<{
+        widget: any;
+        user: any;
+    }>;
+    /**
+     * This function calls the {@link WidgetApi.render} method, and it renders
+     * the widget if it is successful. Otherwise it shows the "error" widget.
+     *
+     * @param {Object} config Config details
+     * @param {Object} config.user The user details
+     * @param {string} config.user.id The user id
+     * @param {string} config.user.accountId The user account id
+     * @param {WidgetType} config.widgetType The content of the widget.
+     * @param {EngagementMedium} config.engagementMedium How to display the widget.
+     * @param {string} config.jwt the JSON Web Token (JWT) that is used
+     *                            to validate the data (can be disabled)
+     *
+     * @return {Promise<WidgetResult>} json object if true, with a Widget and user details.
+     */
+    render(config: WidgetConfig): Promise<WidgetResult | undefined>;
+    /**
+     * Autofills a referral code into an element when someone has been referred.
+     * Uses {@link WidgetApi.squatchReferralCookie} behind the scenes.
+     *
+     * @param selector Element class/id selector, or a callback function
+     * @returns
+     */
+    autofill(selector: string | Function): void;
+    /**
+     * @hidden
+     * @param {Object} response The json object return from the WidgetApi
+     * @param {Object} config Config details
+     * @param {string} config.widgetType The widget type (REFERRER_WIDGET, CONVERSION_WIDGET)
+     * @param {string} config.engagementMedium (POPUP, EMBED)
+     * @returns {Widget} widget (PopupWidget or EmbedWidget)
+     */
+    private _renderWidget;
+    private _renderPopupWidget;
+    private _renderEmbedWidget;
+    /**
+     * @hidden
+     * @param {Object} error The json object containing the error details
+     * @param {string} em The engagementMedium
+     * @returns {void}
+     */
+    private _renderErrorWidget;
+    /**
+     * @hidden
+     * @param {string} rule A regular expression
+     * @returns {boolean} true if rule matches Url, false otherwise
+     */
+    private static _matchesUrl;
+    /**
+     * @hidden
+     * @param {Object} target Object containing the target DOM element
+     * @param {Widget} widget A widget (EmbedWidget, PopupWidget)
+     * @param {Object} params An object with valid parameters
+     *                        (e.g) {email:'email', firstName:'firstName'}
+     * @returns {void}
+     */
+    private static _cb;
+}

package/dist/widgets/declarative/DeclarativeEmbedWidget.d.ts

@@ -0,0 +1,12 @@
+import DeclarativeWidget from "./DeclarativeWidget";
+export declare class DeclarativeEmbedWidget extends DeclarativeWidget {
+    constructor();
+    static get observedAttributes(): string[];
+    attributeChangedCallback(attr: string, oldVal: string, newVal: string): void;
+    renderWidget(): void;
+}
+export declare class DeclarativePopupWidget extends DeclarativeWidget {
+    constructor();
+    static get observedAttributes(): string[];
+    attributeChangedCallback(attr: string, oldVal: string, newVal: string): void;
+}

package/dist/widgets/declarative/DeclarativeWidget.d.ts

@@ -0,0 +1,32 @@
+import AnalyticsApi from "../../api/AnalyticsApi";
+import WidgetApi from "../../api/WidgetApi";
+import { DeclarativeConfigOptions } from "../../types";
+import EmbedWidget from "../EmbedWidget";
+import PopupWidget from "../PopupWidget";
+export default abstract class DeclarativeWidget extends HTMLElement {
+    config: DeclarativeConfigOptions | undefined;
+    token: string | undefined;
+    tenant: string | undefined;
+    widgetType: string | undefined;
+    widgetApi: WidgetApi;
+    analyticsApi: AnalyticsApi;
+    type: "EMBED" | "POPUP";
+    widgetInstance: EmbedWidget | PopupWidget;
+    frame: HTMLIFrameElement;
+    container: string | HTMLElement | undefined | null;
+    element: HTMLElement | undefined;
+    constructor();
+    private _setupApis;
+    renderPasswordlessVariant(): Promise<EmbedWidget | PopupWidget>;
+    renderUserUpsertVariant(): Promise<EmbedWidget | PopupWidget>;
+    _setWidget: (template: any, config: {
+        type: "upsert" | "passwordless";
+    }) => EmbedWidget | PopupWidget;
+    getWidgetInstance(): Promise<EmbedWidget | PopupWidget>;
+    renderWidget(): Promise<void>;
+    setErrorWidget: (e: Error) => EmbedWidget | PopupWidget;
+    open(): void;
+    close(): void;
+    show: () => void;
+    hide: () => void;
+}

package/dist/widgets/declarative/DeclarativeWidgets.d.ts

@@ -0,0 +1,13 @@
+import DeclarativeWidget from "./DeclarativeWidget";
+export declare class DeclarativeEmbedWidget extends DeclarativeWidget {
+    constructor();
+    static get observedAttributes(): string[];
+    attributeChangedCallback(attr: string, oldVal: string, newVal: string): void;
+    connectedCallback(): Promise<void>;
+}
+export declare class DeclarativePopupWidget extends DeclarativeWidget {
+    constructor();
+    static get observedAttributes(): string[];
+    attributeChangedCallback(attr: string, oldVal: string, newVal: string): void;
+    connectedCallback(): Promise<void>;
+}

package/jest.config.ts

@@ -0,0 +1,202 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+export default {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/zv/t83jrkg12jx3bqgq3vx_v29h0000gp/T/jest_dy",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  // clearMocks: false,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  // coverageProvider: "babel",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  moduleDirectories: ["node_modules"],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  moduleNameMapper: {
+    "source-map-support/register": "identity-obj-proxy",
+    "^uuid$": "uuid",
+  },
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  preset: "ts-jest",
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: "@happy-dom/jest-environment",
+
+  // Options that will be passed to the testEnvironment
+  testEnvironmentOptions: {
+    resources: "usable",
+  },
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  testMatch: [
+    "**/*.steps.[tj]s",
+    "**/__tests__/**/*.[jt]s?(x)",
+    "**/?(*.)+(spec|test).[tj]s?(x)",
+  ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  transform: {
+    "^.+\\.(ts|tsx)?$": "ts-jest",
+    "^.+\\.(js|jsx)$": "babel-jest",
+  },
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  transformIgnorePatterns: [
+    "node_modules/(?!(@open-wc|lit|jest-cucumber|lit-html|@lit|lit-element)/)",
+    "\\.pnp\\.[^\\/]+$",
+  ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};