@saasquatch/squatch-js 2.4.3-4 → 2.4.3

package/dist/types.d.ts

@@ -1,7 +1,4 @@
 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.
  *
@@ -26,14 +23,12 @@ export interface ConfigOptions {
  * @param jwt the JSON Web Token (JWT) that is used
  */
 export interface WidgetConfig {
-    user?: User;
+    user: User;
     widgetType?: WidgetType;
     engagementMedium?: EngagementMedium;
     container?: HTMLElement | string;
     trigger?: string;
     jwt?: JWT;
-    locale?: string;
-    displayOnLoad?: boolean;
 }
 /**
  * @param user The user details
@@ -77,19 +72,18 @@ export declare type EngagementMedium =
 /**  Displays the widget embedded in the page. Create an {@link EmbedWidget} */
  | "EMBED";
 export declare type WidgetContext = {
-    type: "cookie" | "error" | "passwordless";
+    type: "cookie" | "error";
     engagementMedium?: EngagementMedium;
     container?: HTMLElement | string;
     trigger?: string;
-    displayOnLoad?: boolean;
 } | {
     type: "upsert";
-    user?: User | null;
+    user: User;
     engagementMedium?: EngagementMedium;
     container?: HTMLElement | string;
     trigger?: string;
 };
-export declare type WidgetContextType = "upsert" | "cookie" | "error" | "passwordless";
+export declare type WidgetContextType = "upsert" | "cookie" | "error";
 /**
  * WidgetType is an enum for types of ways a Widget can be displayed.
  */
@@ -100,3 +94,7 @@ export declare type WidgetType =
  | "CONVERSION_WIDGET" | string;
 export declare type ShareMedium = string;
 export declare type JWT = string;
+export declare type ReferralCookie = {
+    codes: string[];
+    encodedCookie: string;
+};

package/dist/utils/cookieUtils.d.ts

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

package/dist/utils/io.d.ts

@@ -1,6 +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(url: any, jwt?: string): Promise<any>;
+export declare function doGet<T>(url: any, jwt?: string): Promise<T>;
 /**
  * @hidden
  *

package/dist/utils/validate.d.ts

@@ -10,7 +10,5 @@ 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 {};

package/dist/widgets/Widgets.d.ts

@@ -1,5 +1,5 @@
 import WidgetApi from "../api/WidgetApi";
-import { WidgetResult, WithRequired } from "../types";
+import { WidgetResult } from "../types";
 import { ConfigOptions, WidgetConfig } from "../types";
 /**
  *
@@ -30,6 +30,20 @@ export default class Widgets {
      * let widgets = new Widgets({tenantAlias:'test_12b5bo1b25125'});
      */
     constructor(configin: ConfigOptions);
+    /**
+     * This function calls the {@link WidgetApi.cookieUser} method, and it renders
+     * the widget if it is successful. Otherwise it shows the "error" widget.
+     *
+     * @param {Object} config Config details
+     * @param {WidgetType} config.widgetType The content of the widget.
+     * @param {EngagementMedium} config.engagementMedium How to display the widget.
+     * @param {User} config.user An optional user to include
+     * @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.
+     */
+    createCookieUser(config: WidgetConfig): Promise<WidgetResult>;
     /**
      * This function calls the {@link WidgetApi.upsertUser} method, and it renders
      * the widget if it is successful. Otherwise it shows the "error" widget.
@@ -46,7 +60,7 @@ export default class Widgets {
      *
      * @return {Promise<WidgetResult>} json object if true, with a Widget and user details.
      */
-    upsertUser(config: WithRequired<WidgetConfig, "user">): Promise<{
+    upsertUser(config: WidgetConfig): Promise<{
         widget: any;
         user: any;
     }>;
@@ -65,7 +79,7 @@ export default class Widgets {
      *
      * @return {Promise<WidgetResult>} json object if true, with a Widget and user details.
      */
-    render(config: WidgetConfig): Promise<WidgetResult | undefined>;
+    render(config: WidgetConfig): Promise<WidgetResult>;
     /**
      * Autofills a referral code into an element when someone has been referred.
      * Uses {@link WidgetApi.squatchReferralCookie} behind the scenes.

package/package.json

@@ -1,104 +1,105 @@
-{
-  "name": "@saasquatch/squatch-js",
-  "version": "2.4.3-4",
-  "description": "The official Referral SaaSquatch Javascript Web/Browser SDK https://docs.referralsaasquatch.com/developer/squatchjs/",
-  "license": "MIT",
-  "types": "dist/squatch.d.ts",
-  "source": "src/squatch.ts",
-  "main": "dist/squatch.js",
-  "module": "dist/squatch.esm.js",
-  "umd:main": "dist/squatch.min.js",
-  "browser": "dist/squatch.min.js",
-  "bugs": {
-    "url": "https://github.com/saasquatch/squatch-js/issues",
-    "email": "support@referralsaasquatch.com"
-  },
-  "engines": {
-    "node": ">=12.16.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/saasquatch/squatch-js.git"
-  },
-  "tsd": {
-    "directory": "test/tsd"
-  },
-  "sideEffects": false,
-  "scripts": {
-    "build:es": "microbundle --target node --format cjs,es",
-    "build:umd": "webpack",
-    "build": "run-s build:es build:umd",
-    "watch": "webpack --watch",
-    "declaration": "tsc --emitDeclarationOnly",
-    "test:browser": "cucumber-js",
-    "test:webkit": "cross-env BROWSER=webkit cucumber-js",
-    "test:firefox": "cross-env BROWSER=firefox cucumber-js",
-    "test:types": "tsd",
-    "test": "run-s test:types test:browser",
-    "build:docs": "typedoc --out docs/ src/ ",
-    "deploy": "np --no-cleanup",
-    "deploy:docs": "surge ./ -d squathjsv2.surge.sh",
-    "preversion": "run-s build",
-    "demo": "msw init demo/dist/ --save && run-p static parcel",
-    "demo:deploy": "run-s parcel:build parcel:deploy",
-    "static": "serve -l 3333 -s dist",
-    "parcel": "cd demo && parcel index.html",
-    "parcel:build": "cd demo && parcel build index.html",
-    "parcel:deploy": "surge demo/dist -d squathjs-demo.surge.sh"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.14.3",
-    "@babel/plugin-proposal-class-properties": "^7.13.0",
-    "@babel/plugin-transform-runtime": "^7.14.3",
-    "@babel/preset-env": "^7.14.2",
-    "@babel/preset-typescript": "^7.13.0",
-    "@babel/register": "^7.13.16",
-    "@babel/runtime-corejs2": "^7.14.0",
-    "@types/chai": "^4.2.11",
-    "@types/cucumber": "^6.0.1",
-    "@types/debug": "4.1.5",
-    "@types/express": "^4.17.6",
-    "@types/js-cookie": "^2.2.6",
-    "@types/jsdom-global": "^3.0.2",
-    "@types/react": "^16.9.35",
-    "@types/superagent": "^4.1.7",
-    "@ungap/url-search-params": "^0.2.0",
-    "babel-loader": "^8.2.2",
-    "base64-url": "^2.3.3",
-    "chai": "^4.2.0",
-    "cross-env": "^7.0.2",
-    "cucumber": "^6.0.5",
-    "express": "^4.17.1",
-    "microbundle": "^0.13.0",
-    "msw": "^0.36.0",
-    "np": "^6.2.3",
-    "npm-run-all": "^4.1.5",
-    "parcel": "^1.12.3",
-    "parcel-bundler": "^1.12.4",
-    "playwright": "^1.33.0-alpha-mar-29-2023",
-    "react": "^16.13.1",
-    "react-bootstrap": "^1.0.1",
-    "react-dom": "^16.13.1",
-    "react-url-query": "^1.5.0",
-    "serve": "^11.3.0",
-    "ts-loader": "^7.0.4",
-    "ts-node": "^8.10.2",
-    "tsd": "^0.13.1",
-    "typedoc": "^0.17.7",
-    "typescript": "^3.9.3",
-    "webpack": "^4.46.0",
-    "webpack-cli": "^3.3.12",
-    "webpack-visualizer-plugin": "^0.1.11"
-  },
-  "prettier": {},
-  "dependencies": {
-    "debug": "^3.2.6",
-    "eventbusjs": "^0.2.0",
-    "js-cookie": "^2.2.1",
-    "superagent": "^5.2.2"
-  },
-  "browserslist": "> 0.25%, not dead",
-  "msw": {
-    "workerDirectory": "demo/dist"
-  }
-}
+{
+  "name": "@saasquatch/squatch-js",
+  "version": "2.4.3",
+  "description": "The official Referral SaaSquatch Javascript Web/Browser SDK https://docs.referralsaasquatch.com/developer/squatchjs/",
+  "license": "MIT",
+  "author": "ReferralSaaSquatch.com, Inc.",
+  "types": "dist/squatch.d.ts",
+  "source": "src/squatch.ts",
+  "main": "dist/squatch.js",
+  "module": "dist/squatch.esm.js",
+  "umd:main": "dist/squatch.min.js",
+  "browser": "dist/squatch.min.js",
+  "bugs": {
+    "url": "https://github.com/saasquatch/squatch-js/issues",
+    "email": "support@referralsaasquatch.com"
+  },
+  "engines": {
+    "node": ">=12.16.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/saasquatch/squatch-js.git"
+  },
+  "tsd": {
+    "directory": "test/tsd"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build:es": "microbundle --target node --format cjs,es",
+    "build:umd": "webpack",
+    "build": "run-s build:es build:umd",
+    "watch": "microbundle watch",
+    "declaration": "tsc --emitDeclarationOnly",
+    "test:browser": "cucumber-js",
+    "test:webkit": "cross-env BROWSER=webkit cucumber-js",
+    "test:firefox": "cross-env BROWSER=firefox cucumber-js",
+    "test:types": "tsd",
+    "test": "run-s test:types test:browser",
+    "build:docs": "typedoc --out docs/ src/ ",
+    "deploy": "np --no-cleanup",
+    "deploy:docs": "surge ./ -d squathjsv2.surge.sh",
+    "preversion": "run-s build",
+    "demo": "msw init demo/dist/ --save && run-p static parcel",
+    "demo:deploy": "run-s parcel:build parcel:deploy",
+    "static": "serve dist",
+    "parcel": "cd demo && parcel index.html",
+    "parcel:build": "cd demo && parcel build index.html",
+    "parcel:deploy": "surge demo/dist -d squathjs-demo.surge.sh"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.14.3",
+    "@babel/plugin-proposal-class-properties": "^7.13.0",
+    "@babel/plugin-transform-runtime": "^7.14.3",
+    "@babel/preset-env": "^7.14.2",
+    "@babel/preset-typescript": "^7.13.0",
+    "@babel/register": "^7.13.16",
+    "@babel/runtime-corejs2": "^7.14.0",
+    "@types/chai": "^4.2.11",
+    "@types/cucumber": "^6.0.1",
+    "@types/debug": "4.1.5",
+    "@types/express": "^4.17.6",
+    "@types/js-cookie": "^2.2.6",
+    "@types/jsdom-global": "^3.0.2",
+    "@types/react": "^16.9.35",
+    "@types/superagent": "^4.1.7",
+    "@ungap/url-search-params": "^0.2.0",
+    "babel-loader": "^8.2.2",
+    "base64-url": "^2.3.3",
+    "chai": "^4.2.0",
+    "cross-env": "^7.0.2",
+    "cucumber": "^6.0.5",
+    "express": "^4.17.1",
+    "microbundle": "^0.13.0",
+    "msw": "^0.36.0",
+    "np": "^6.2.3",
+    "npm-run-all": "^4.1.5",
+    "parcel": "^1.12.3",
+    "parcel-bundler": "^1.12.4",
+    "playwright": "^1.0.2",
+    "react": "^16.13.1",
+    "react-bootstrap": "^1.0.1",
+    "react-dom": "^16.13.1",
+    "react-url-query": "^1.5.0",
+    "serve": "^11.3.0",
+    "ts-loader": "^7.0.4",
+    "ts-node": "^8.10.2",
+    "tsd": "^0.13.1",
+    "typedoc": "^0.17.7",
+    "typescript": "^3.9.3",
+    "webpack": "^4.46.0",
+    "webpack-cli": "^3.3.12",
+    "webpack-visualizer-plugin": "^0.1.11"
+  },
+  "prettier": {},
+  "dependencies": {
+    "debug": "^3.2.6",
+    "eventbusjs": "^0.2.0",
+    "js-cookie": "^2.2.1",
+    "superagent": "^5.2.2"
+  },
+  "browserslist": "> 0.25%, not dead",
+  "msw": {
+    "workerDirectory": "demo\\dist"
+  }
+}

package/dist/utils/utmUtils.d.ts

@@ -1,14 +0,0 @@
-import { ConfigOptions, WidgetConfig } from "../types";
-export declare function _getAutoConfig(configIn: ConfigOptions): {
-    widgetConfig: WidgetConfig;
-    squatchConfig: ConfigOptions;
-} | undefined;
-/**
- * Converts _saasquatchExtra into
- * @param obj
- */
-export declare function convertExtraToConfig(obj: Record<string, any>): {
-    domain: string | undefined;
-    tenantAlias: string;
-    widgetConfig: any;
-};