@saasquatch/squatch-js 2.5.0-0 → 2.5.0

package/dist/types.d.ts

@@ -1,4 +1,7 @@
 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.
  *
@@ -23,12 +26,14 @@ 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
@@ -72,18 +77,19 @@ export declare type EngagementMedium =
 /**  Displays the widget embedded in the page. Create an {@link EmbedWidget} */
  | "EMBED";
 export declare type WidgetContext = {
-    type: "cookie" | "error";
+    type: "cookie" | "error" | "passwordless";
     engagementMedium?: EngagementMedium;
     container?: HTMLElement | string;
     trigger?: string;
+    displayOnLoad?: boolean;
 } | {
     type: "upsert";
-    user: User;
+    user?: User | null;
     engagementMedium?: EngagementMedium;
     container?: HTMLElement | string;
     trigger?: string;
 };
-export declare type WidgetContextType = "upsert" | "cookie" | "error";
+export declare type WidgetContextType = "upsert" | "cookie" | "error" | "passwordless";
 /**
  * WidgetType is an enum for types of ways a Widget can be displayed.
  */
@@ -94,3 +100,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 +1,2 @@
+export declare function b64decode(input: any): string;
 export declare function _pushCookie(): void;

package/dist/utils/io.d.ts

@@ -1,5 +1,6 @@
 import { JWT } from "../types";
-export declare function doGet(url: any, jwt?: string): Promise<any>;
+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
  *

package/dist/utils/utmUtils.d.ts

@@ -0,0 +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;
+};

package/dist/utils/validate.d.ts

@@ -10,5 +10,7 @@ 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 } from "../types";
+import { WidgetResult, WithRequired } from "../types";
 import { ConfigOptions, WidgetConfig } from "../types";
 /**
  *
@@ -46,7 +46,7 @@ export default class Widgets {
      *
      * @return {Promise<WidgetResult>} json object if true, with a Widget and user details.
      */
-    upsertUser(config: WidgetConfig): Promise<{
+    upsertUser(config: WithRequired<WidgetConfig, "user">): Promise<{
         widget: any;
         user: any;
     }>;
@@ -65,7 +65,7 @@ export default class Widgets {
      *
      * @return {Promise<WidgetResult>} json object if true, with a Widget and user details.
      */
-    render(config: WidgetConfig): Promise<WidgetResult>;
+    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.

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@saasquatch/squatch-js",
-  "version": "2.5.0-0",
+  "version": "2.5.0",
   "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",
@@ -28,7 +29,7 @@
     "build:es": "microbundle --target node --format cjs,es",
     "build:umd": "webpack",
     "build": "run-s build:es build:umd",
-    "watch": "microbundle watch",
+    "watch": "webpack --watch",
     "declaration": "tsc --emitDeclarationOnly",
     "test:browser": "cucumber-js",
     "test:webkit": "cross-env BROWSER=webkit cucumber-js",
@@ -41,7 +42,7 @@
     "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",
+    "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"
@@ -75,7 +76,7 @@
     "npm-run-all": "^4.1.5",
     "parcel": "^1.12.3",
     "parcel-bundler": "^1.12.4",
-    "playwright": "^1.28.1",
+    "playwright": "^1.33.0-alpha-mar-29-2023",
     "react": "^16.13.1",
     "react-bootstrap": "^1.0.1",
     "react-dom": "^16.13.1",
@@ -99,6 +100,6 @@
   },
   "browserslist": "> 0.25%, not dead",
   "msw": {
-    "workerDirectory": "demo\\dist"
+    "workerDirectory": "demo/dist"
   }
-}
+}