@saasquatch/component-environment 1.0.0-1 → 1.0.0-2

package/dist/UserIdentityContext.js

@@ -1,124 +0,0 @@
-import decode from "jwt-decode";
-import { ContextProvider } from "dom-context";
-import { equal } from "@wry/equality";
-import { getEnvironmentSDK } from "./environment";
-import { setLocale } from "./LocaleContext";
-import { USER_CONTEXT_NAME, } from "./types";
-export function lazilyStartUserContext() {
-    let globalProvider = window.squatchUserIdentity;
-    if (!globalProvider) {
-        // Lazily creates a global provider
-        globalProvider = new ContextProvider({
-            element: document.documentElement,
-            initialState: _getInitialValue(),
-            contextName: USER_CONTEXT_NAME,
-        }).start();
-        window.squatchUserIdentity = globalProvider;
-    }
-    return globalProvider;
-}
-function isDecodedSquatchJWT(decoded) {
-    return decoded.user && decoded.user.id && decoded.user.accountId;
-}
-function isDecodedWidgetAPIJWT(decoded) {
-    return decoded.sub && /.*:.*@.*:users/.test(decoded.sub);
-}
-export function userIdentityFromJwt(jwt) {
-    if (!jwt)
-        return undefined;
-    try {
-        const decoded = decode(jwt);
-        const exp = decoded.exp;
-        let userId = undefined;
-        let accountId = undefined;
-        if (isDecodedWidgetAPIJWT(decoded)) {
-            // Pull the accountId and userId from the subject and Base64-decode them
-            // NOTE: This is to support classic theme engine widget token generation
-            const matches = decoded.sub.match(/(.*):(.*)@(.*):users/);
-            if (matches?.[1])
-                accountId = atob(matches[1]);
-            if (matches?.[2])
-                userId = atob(matches[2]);
-        }
-        else if (isDecodedSquatchJWT(decoded)) {
-            accountId = decoded.user.accountId;
-            userId = decoded.user.id;
-        }
-        if (!userId || !accountId) {
-            return undefined;
-        }
-        // Check if the JWT has expired
-        if (exp && Date.now() >= exp * 1000) {
-            return undefined;
-        }
-        return {
-            id: userId,
-            accountId: accountId,
-            jwt,
-        };
-    }
-    catch (e) {
-        // Invalid JWT
-        return undefined;
-    }
-}
-function _getInitialValue() {
-    const sdk = getEnvironmentSDK();
-    switch (sdk.type) {
-        case "SquatchAndroid":
-        case "SquatchJS2":
-            return {
-                id: sdk.widgetIdent.userId,
-                accountId: sdk.widgetIdent.accountId,
-                jwt: sdk.widgetIdent.token,
-            };
-        case "SquatchPortal":
-            // Portals can have the jwt provided as a URL parameter, so look for that first
-            const searchParams = new URLSearchParams(document.location.search);
-            if (searchParams.has("jwt")) {
-                return userIdentityFromJwt(searchParams.get("jwt"));
-            }
-            // Look for user identity in local storage
-            const stored = localStorage.getItem(USER_CONTEXT_NAME);
-            if (!stored)
-                return undefined;
-            try {
-                const potentialUserIdent = JSON.parse(stored);
-                const identity = userIdentityFromJwt(potentialUserIdent.jwt);
-                if (identity) {
-                    return {
-                        ...potentialUserIdent,
-                        ...identity,
-                    };
-                }
-                return undefined;
-            }
-            catch (e) {
-                // Not valid JSON
-                return undefined;
-            }
-        case "SquatchAdmin":
-        case "None":
-            // Not logged in for admin portal / none default case
-            return undefined;
-    }
-}
-/**
- * Overide the globally defined user context, and persists the user identity in local storage
- *
- * @param identity the new identity of the user, or undefined if logged out
- */
-export function setUserIdentity(identity) {
-    const globalProvider = lazilyStartUserContext();
-    if (!equal(globalProvider.context, identity)) {
-        setLocale(undefined);
-        globalProvider.context = identity;
-    }
-    // Portals store identity in local storage
-    if (identity && getEnvironmentSDK().type === "SquatchPortal") {
-        localStorage.setItem(USER_CONTEXT_NAME, JSON.stringify(identity));
-    }
-    else if (!identity) {
-        localStorage.removeItem(USER_CONTEXT_NAME);
-    }
-}

package/dist/contexts/LocaleContext.d.ts

@@ -1,18 +0,0 @@
-import { ContextProvider } from "dom-context";
-/**
- * Lazily start the locale context provider. If it already exists, the existing provider is
- * returned. This function is safe to call multiple times.
- *
- * @returns The global locale context provider
- */
-export declare function lazilyStartLocaleContext(): ContextProvider<string | undefined>;
-/**
- * Overide the globally defined Locale context
- *
- * @param locale the new locale used by the user
- */
-export declare function setLocale(locale?: string): void;
-/**
- * Get the current value of the locale context
- */
-export declare function getLocale(): string | undefined;

package/dist/contexts/LocaleContext.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLocale = exports.setLocale = exports.lazilyStartLocaleContext = void 0;
-const dom_context_1 = require("dom-context");
-const types_1 = require("../types");
-const debug_1 = require("../debug");
-const debug = (...args) => (0, debug_1.debug)(types_1.LOCALE_CONTEXT_NAME, ...args);
-/**
- * Lazily start the locale context provider. If it already exists, the existing provider is
- * returned. This function is safe to call multiple times.
- *
- * @returns The global locale context provider
- */
-function lazilyStartLocaleContext() {
-    let globalProvider = window.squatchLocale;
-    if (!globalProvider) {
-        debug("Creating locale context provider");
-        globalProvider = new dom_context_1.ContextProvider({
-            element: document.documentElement,
-            initialState: window.widgetIdent?.locale || navigator.language.replace("-", "_"),
-            contextName: types_1.LOCALE_CONTEXT_NAME,
-        }).start();
-        window.squatchLocale = globalProvider;
-    }
-    return globalProvider;
-}
-exports.lazilyStartLocaleContext = lazilyStartLocaleContext;
-/**
- * Overide the globally defined Locale context
- *
- * @param locale the new locale used by the user
- */
-function setLocale(locale) {
-    const globalProvider = lazilyStartLocaleContext();
-    if (globalProvider.context !== locale) {
-        debug(`Setting locale context value [${locale}]`);
-        globalProvider.context = locale;
-    }
-}
-exports.setLocale = setLocale;
-/**
- * Get the current value of the locale context
- */
-function getLocale() {
-    return window.squatchLocale?.context;
-}
-exports.getLocale = getLocale;

package/dist/contexts/ProgramContext.d.ts

@@ -1,18 +0,0 @@
-import { ContextProvider } from "dom-context";
-/**
- * Lazily start the program context provider. If it already exists, the existing provider is
- * returned. This function is safe to call multiple times.
- *
- * @returns The global program context provider
- */
-export declare function lazilyStartProgramContext(): ContextProvider<string | undefined>;
-/**
- * Overide the globally defined Program ID context
- *
- * @param programId the new programID used by the user, or undefined if logged out
- */
-export declare function setProgramId(programId: string | undefined): void;
-/**
- * Get the current value of the program context
- */
-export declare function getProgramId(): string | undefined;

package/dist/contexts/ProgramContext.js

@@ -1,48 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getProgramId = exports.setProgramId = exports.lazilyStartProgramContext = void 0;
-const dom_context_1 = require("dom-context");
-const types_1 = require("../types");
-const debug_1 = require("../debug");
-const debug = (...args) => (0, debug_1.debug)(types_1.PROGRAM_CONTEXT_NAME, ...args);
-/**
- * Lazily start the program context provider. If it already exists, the existing provider is
- * returned. This function is safe to call multiple times.
- *
- * @returns The global program context provider
- */
-function lazilyStartProgramContext() {
-    let globalProvider = window.squatchProgramId;
-    if (!globalProvider) {
-        debug("Creating program context provider");
-        // Lazily creates a global provider
-        globalProvider = new dom_context_1.ContextProvider({
-            element: document.documentElement,
-            initialState: window.widgetIdent?.programId || undefined,
-            contextName: types_1.PROGRAM_CONTEXT_NAME,
-        }).start();
-        window.squatchProgramId = globalProvider;
-    }
-    return globalProvider;
-}
-exports.lazilyStartProgramContext = lazilyStartProgramContext;
-/**
- * Overide the globally defined Program ID context
- *
- * @param programId the new programID used by the user, or undefined if logged out
- */
-function setProgramId(programId) {
-    const globalProvider = lazilyStartProgramContext();
-    if (globalProvider.context !== programId) {
-        debug(`Setting program context value [${programId}]`);
-        globalProvider.context = programId;
-    }
-}
-exports.setProgramId = setProgramId;
-/**
- * Get the current value of the program context
- */
-function getProgramId() {
-    return window.squatchLocale?.context;
-}
-exports.getProgramId = getProgramId;

package/dist/contexts/UserIdentityContext.d.ts

@@ -1,26 +0,0 @@
-import { ContextProvider } from "dom-context";
-import { UserIdentity } from "../types";
-/**
- * Lazily start the user context provider. If it already exists, the existing provider is
- * returned. This function is safe to call multiple times.
- *
- * @returns The global user context provider
- */
-export declare function lazilyStartUserContext(): ContextProvider<UserIdentity | undefined>;
-/**
- * Extract a user identity from a JWT
- *
- * @param jwt The JWT to extract a user identity from
- * @returns The user identity or undefined if the JWT is not valid
- */
-export declare function userIdentityFromJwt(jwt?: string): UserIdentity | undefined;
-/**
- * Overide the globally defined user context, and persists the user identity in local storage
- *
- * @param identity the new identity of the user, or undefined if logged out
- */
-export declare function setUserIdentity(identity?: UserIdentity): void;
-/**
- * Get the current value of the user context
- */
-export declare function getUserIdentity(): UserIdentity | undefined;

package/dist/contexts/UserIdentityContext.js

@@ -1,156 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getUserIdentity = exports.setUserIdentity = exports.userIdentityFromJwt = exports.lazilyStartUserContext = void 0;
-const jwt_decode_1 = __importDefault(require("jwt-decode"));
-const dom_context_1 = require("dom-context");
-const equality_1 = require("@wry/equality");
-const environment_1 = require("../environment");
-const types_1 = require("../types");
-const listeners_1 = require("../listeners");
-const debug_1 = require("../debug");
-const debug = (...args) => (0, debug_1.debug)(types_1.USER_CONTEXT_NAME, ...args);
-/**
- * Lazily start the user context provider. If it already exists, the existing provider is
- * returned. This function is safe to call multiple times.
- *
- * @returns The global user context provider
- */
-function lazilyStartUserContext() {
-    let globalProvider = window.squatchUserIdentity;
-    if (!globalProvider) {
-        debug("Creating user context provider");
-        // Lazily creates a global provider
-        globalProvider = new dom_context_1.ContextProvider({
-            element: document.documentElement,
-            initialState: _getInitialValue(),
-            contextName: types_1.USER_CONTEXT_NAME,
-        }).start();
-        window.squatchUserIdentity = globalProvider;
-        (0, listeners_1.startUserContextListenerForLocale)();
-    }
-    return globalProvider;
-}
-exports.lazilyStartUserContext = lazilyStartUserContext;
-function isDecodedSquatchJWT(decoded) {
-    return decoded.user && decoded.user.id && decoded.user.accountId;
-}
-function isDecodedWidgetAPIJWT(decoded) {
-    return decoded.sub && /.*:.*@.*:users/.test(decoded.sub);
-}
-/**
- * Extract a user identity from a JWT
- *
- * @param jwt The JWT to extract a user identity from
- * @returns The user identity or undefined if the JWT is not valid
- */
-function userIdentityFromJwt(jwt) {
-    if (!jwt)
-        return undefined;
-    try {
-        const decoded = (0, jwt_decode_1.default)(jwt);
-        const exp = decoded.exp;
-        let userId = undefined;
-        let accountId = undefined;
-        if (isDecodedWidgetAPIJWT(decoded)) {
-            // Pull the accountId and userId from the subject and Base64-decode them
-            // NOTE: This is to support classic theme engine widget token generation
-            const matches = decoded.sub.match(/(.*):(.*)@(.*):users/);
-            if (matches?.[1])
-                accountId = atob(matches[1]);
-            if (matches?.[2])
-                userId = atob(matches[2]);
-        }
-        else if (isDecodedSquatchJWT(decoded)) {
-            accountId = decoded.user.accountId;
-            userId = decoded.user.id;
-        }
-        if (!userId || !accountId) {
-            return undefined;
-        }
-        // Check if the JWT has expired
-        if (exp && Date.now() >= exp * 1000) {
-            return undefined;
-        }
-        return {
-            id: userId,
-            accountId: accountId,
-            jwt,
-        };
-    }
-    catch (e) {
-        // Invalid JWT
-        return undefined;
-    }
-}
-exports.userIdentityFromJwt = userIdentityFromJwt;
-function _getInitialValue() {
-    const sdk = (0, environment_1.getEnvironmentSDK)();
-    switch (sdk.type) {
-        case "SquatchAndroid":
-        case "SquatchJS2":
-            return {
-                id: sdk.widgetIdent.userId,
-                accountId: sdk.widgetIdent.accountId,
-                jwt: sdk.widgetIdent.token,
-            };
-        case "SquatchPortal":
-            // Portals can have the jwt provided as a URL parameter, so look for that first
-            const searchParams = new URLSearchParams(document.location.search);
-            if (searchParams.has("jwt")) {
-                return userIdentityFromJwt(searchParams.get("jwt"));
-            }
-            // Look for user identity in local storage
-            const stored = localStorage.getItem(types_1.USER_CONTEXT_NAME);
-            if (!stored)
-                return undefined;
-            try {
-                const potentialUserIdent = JSON.parse(stored);
-                const identity = userIdentityFromJwt(potentialUserIdent.jwt);
-                if (identity) {
-                    return {
-                        ...potentialUserIdent,
-                        ...identity,
-                    };
-                }
-                return undefined;
-            }
-            catch (e) {
-                // Not valid JSON
-                return undefined;
-            }
-        case "SquatchAdmin":
-        case "None":
-            // Not logged in for admin portal / none default case
-            return undefined;
-    }
-}
-/**
- * Overide the globally defined user context, and persists the user identity in local storage
- *
- * @param identity the new identity of the user, or undefined if logged out
- */
-function setUserIdentity(identity) {
-    const globalProvider = lazilyStartUserContext();
-    if (!(0, equality_1.equal)(globalProvider.context, identity)) {
-        debug(`Setting user context value [${JSON.stringify(identity)}]`);
-        globalProvider.context = identity;
-    }
-    // Portals store identity in local storage
-    if (identity && (0, environment_1.getEnvironmentSDK)().type === "SquatchPortal") {
-        localStorage.setItem(types_1.USER_CONTEXT_NAME, JSON.stringify(identity));
-    }
-    else if (!identity) {
-        localStorage.removeItem(types_1.USER_CONTEXT_NAME);
-    }
-}
-exports.setUserIdentity = setUserIdentity;
-/**
- * Get the current value of the user context
- */
-function getUserIdentity() {
-    return window.squatchUserIdentity?.context;
-}
-exports.getUserIdentity = getUserIdentity;

package/dist/debug.d.ts

@@ -1 +0,0 @@
-export declare function debug(ns: string, ...args: any[]): void;

package/dist/debug.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.debug = void 0;
-const debugEnabled = localStorage.getItem("debug");
-function debug(ns, ...args) {
-    if (debugEnabled) {
-        console.debug(`sq:environment:${ns}`, ...args);
-    }
-}
-exports.debug = debug;

package/dist/environment.d.ts

@@ -1,15 +0,0 @@
-import { Environment, EnvironmentSDK, EngagementMedium } from "./types";
-/**
- * Get the type of environment that this widget is being rendered in
- *
- * Should never return null.
- */
-export declare function getEnvironment(): Environment;
-/**
- * Get the SDK for interacting with the host environment
- */
-export declare function getEnvironmentSDK(): EnvironmentSDK;
-export declare function isDemo(): boolean;
-export declare function getTenantAlias(): string;
-export declare function getAppDomain(): string;
-export declare function getEngagementMedium(): EngagementMedium;

package/dist/environment.js

@@ -1,107 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEngagementMedium = exports.getAppDomain = exports.getTenantAlias = exports.isDemo = exports.getEnvironmentSDK = exports.getEnvironment = void 0;
-const types_1 = require("./types");
-/**
- * Get the type of environment that this widget is being rendered in
- *
- * Should never return null.
- */
-function getEnvironment() {
-    return getEnvironmentSDK().type;
-}
-exports.getEnvironment = getEnvironment;
-/**
- * Get the SDK for interacting with the host environment
- */
-function getEnvironmentSDK() {
-    //@ts-ignore
-    if (window["SquatchAndroid"]) {
-        return {
-            type: "SquatchAndroid",
-            //@ts-ignore
-            android: window["SquatchAndroid"],
-            //@ts-ignore
-            widgetIdent: window["widgetIdent"],
-        };
-    }
-    //@ts-ignore
-    if (window["SquatchPortal"]) {
-        return {
-            type: "SquatchPortal",
-            //@ts-ignore
-            env: window["SquatchPortal"],
-        };
-    }
-    //@ts-ignore
-    if (window["SquatchAdmin"]) {
-        return {
-            type: "SquatchAdmin",
-            //@ts-ignore
-            adminSDK: window["SquatchAdmin"],
-        };
-    }
-    // Vanilla components mutates `widgetIdent` for portal, causing boilerplate to render as SquatchJS2
-    if (window["widgetIdent"] && window["widgetIdent"]?.env !== "demo") {
-        return {
-            type: "SquatchJS2",
-            //@ts-ignore
-            api: window.frameElement?.["squatchJsApi"],
-            //@ts-ignore
-            widgetIdent: window["widgetIdent"],
-        };
-    }
-    return {
-        type: "None",
-    };
-}
-exports.getEnvironmentSDK = getEnvironmentSDK;
-function isDemo() {
-    const sdk = getEnvironmentSDK();
-    return sdk.type === "None" || sdk.type === "SquatchAdmin";
-}
-exports.isDemo = isDemo;
-// Fake tenant alias in demo mode
-const FAKE_TENANT = "demo";
-function getTenantAlias() {
-    const sdk = getEnvironmentSDK();
-    switch (sdk.type) {
-        case "SquatchAndroid":
-        case "SquatchJS2":
-            return sdk.widgetIdent.tenantAlias;
-        case "SquatchAdmin":
-        case "None":
-            return FAKE_TENANT;
-        case "SquatchPortal":
-            return sdk.env.tenantAlias;
-    }
-}
-exports.getTenantAlias = getTenantAlias;
-const DEFAULT_DOMAIN = "https://app.referralsaasquatch.com";
-function getAppDomain() {
-    const sdk = getEnvironmentSDK();
-    switch (sdk.type) {
-        case "SquatchAndroid":
-        case "SquatchJS2":
-            return sdk.widgetIdent.appDomain;
-        case "SquatchPortal":
-            return sdk.env?.appDomain || DEFAULT_DOMAIN;
-        case "SquatchAdmin":
-        case "None":
-            return DEFAULT_DOMAIN;
-    }
-}
-exports.getAppDomain = getAppDomain;
-function getEngagementMedium() {
-    const sdk = getEnvironmentSDK();
-    switch (sdk.type) {
-        case "SquatchJS2":
-            return sdk.widgetIdent.engagementMedium || types_1.DEFAULT_MEDIUM;
-        case "SquatchAndroid":
-        case "SquatchPortal":
-        case "SquatchAdmin":
-        case "None":
-            return types_1.DEFAULT_MEDIUM;
-    }
-}
-exports.getEngagementMedium = getEngagementMedium;

package/dist/fetchLocale.d.ts

@@ -1 +0,0 @@
-export declare function fetchLocale(): Promise<string | undefined>;

package/dist/fetchLocale.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchLocale = void 0;
-const environment_1 = require("./environment");
-const types_1 = require("./types");
-const debug_1 = require("./debug");
-const debug = (...args) => (0, debug_1.debug)(types_1.LOCALE_CONTEXT_NAME, ...args);
-const GET_LOCALE = `
-  query {
-    viewer {
-      ... on User {
-        locale
-      }
-    }
-  }
-`;
-async function fetchLocale() {
-    debug("Fetching locale from GraphQL for current user");
-    try {
-        const result = await fetch(`${(0, environment_1.getAppDomain)()}/api/v1/${(0, environment_1.getTenantAlias)()}/graphql`, {
-            method: "POST",
-            headers: { "Content-Type": "application/json" },
-            body: JSON.stringify({
-                query: GET_LOCALE,
-            }),
-        });
-        if (!result.ok) {
-            throw new Error("Failed to fetch locale");
-        }
-        const json = await result.json();
-        if (json.errors) {
-            throw new Error(JSON.stringify(json.errors, null, 2));
-        }
-        return json.viewer.locale || undefined;
-    }
-    catch (e) {
-        debug(`Failed to fetch locale for current user`, e.message);
-        return undefined;
-    }
-}
-exports.fetchLocale = fetchLocale;

package/dist/listeners.d.ts

@@ -1 +0,0 @@
-export declare function startUserContextListenerForLocale(): void;

package/dist/listeners.js

@@ -1,51 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.startUserContextListenerForLocale = void 0;
-const equality_1 = __importDefault(require("@wry/equality"));
-const dom_context_1 = require("dom-context");
-const types_1 = require("./types");
-const LocaleContext_1 = require("./contexts/LocaleContext");
-const UserIdentityContext_1 = require("./contexts/UserIdentityContext");
-const fetchLocale_1 = require("./fetchLocale");
-const debug_1 = require("./debug");
-const debug = (...args) => (0, debug_1.debug)(types_1.LOCALE_CONTEXT_NAME, ...args);
-const userContextListenerDiv = (() => {
-    const id = "__environment_context_listener";
-    let div = document.getElementById(id);
-    if (!div) {
-        div = document.createElement("div");
-        div.id = id;
-        document.documentElement.appendChild(div);
-    }
-    return div;
-})();
-// Listens to user changes and refetches the locale from GraphQL
-const userContextListenerForLocale = new dom_context_1.ContextListener({
-    contextName: types_1.USER_CONTEXT_NAME,
-    element: userContextListenerDiv,
-    onChange: async (next) => {
-        if (next) {
-            const userProvider = (0, UserIdentityContext_1.lazilyStartUserContext)();
-            if (!(0, equality_1.default)(userProvider.context, next)) {
-                debug("User context changed, refetching locale");
-                const locale = await (0, fetchLocale_1.fetchLocale)();
-                const localeProvider = (0, LocaleContext_1.lazilyStartLocaleContext)();
-                if (localeProvider.context !== locale) {
-                    debug(`New value fetched from GraphQL [${locale}]`);
-                    localeProvider.context =
-                        locale ||
-                            window.widgetIdent?.locale ||
-                            navigator.language.replace("-", "_");
-                }
-            }
-        }
-    },
-});
-function startUserContextListenerForLocale() {
-    debug("Starting user context listener for locale updates");
-    userContextListenerForLocale.start();
-}
-exports.startUserContextListenerForLocale = startUserContextListenerForLocale;