@saasquatch/component-boilerplate 1.5.0-8 → 1.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saasquatch/component-boilerplate",
-  "version": "1.5.0-8",
+  "version": "1.5.0",
   "private": false,
   "description": "Boilerplate for writing web components for the SaaSquatch widget environments",
   "source": "src/index.ts",
@@ -41,7 +41,7 @@
   },
   "dependencies": {
     "@formatjs/intl": "^1.8.2",
-    "@saasquatch/component-environment": "^1.0.0-5",
+    "@saasquatch/component-environment": "^1.0.0",
     "@saasquatch/dom-context-hooks": "^1.0.0",
     "@saasquatch/universal-hooks": "^1.0.0",
     "@wry/equality": "^0.5.2",

package/dist/environment/BatchedGraphQLClient.d.ts

@@ -1,9 +0,0 @@
-import { Subject } from "rxjs";
-import { RequestDocument } from "graphql-request/dist/types";
-import { GraphQLClient } from "graphql-request";
-export declare class BatchedGraphQLClient extends GraphQLClient {
-    subject: Subject<unknown>;
-    constructor(url: string, opts?: any);
-    superRequest<T>(query: RequestDocument, variables?: any): Promise<T>;
-    request<T>(query: any, variables: any): Promise<T>;
-}

package/dist/environment/GraphQLRequestManager.d.ts

@@ -1 +0,0 @@
-export declare function addQuery(queryObj: any): void;

package/dist/environment/LocaleContext.d.ts

@@ -1,15 +0,0 @@
-import { ContextProvider } from "dom-context";
-import { WidgetIdent } from "./environment";
-declare global {
-    interface Window {
-        widgetIdent: WidgetIdent;
-        squatchLocale: ContextProvider<string>;
-    }
-}
-export declare function useLocale(): string | undefined;
-/**
- * Overide the globally defined Locale context
- *
- * @param locale the new locale used by the user
- */
-export declare function setLocale(locale: string): void;

package/dist/environment/ProgramContext.d.ts

@@ -1,15 +0,0 @@
-import { ContextProvider } from "dom-context";
-import { WidgetIdent } from "./environment";
-declare global {
-    interface Window {
-        widgetIdent: WidgetIdent;
-        squatchProgramId: ContextProvider<string>;
-    }
-}
-export declare function useProgramId(): 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): void;

package/dist/environment/SquatchPortal.d.ts

@@ -1,26 +0,0 @@
-import { WidgetIdent } from "./environment";
-/**
- * Environment provided by components hosted in a web component (`sqh-widget`)
- */
-export declare type SquatchPortal = typeof SquatchPortalInstance;
-declare global {
-    interface Window {
-        SquatchPortal?: PortalEnv;
-    }
-}
-/**
- * Portal env doesn't include User Id
- */
-export declare type PortalEnv = Pick<WidgetIdent, "tenantAlias" | "appDomain" | "programId"> & { portalAuthUrl: string };
-export declare const SquatchPortalInstance: {
-    readonly localeContext: {
-        useContext: (host: HTMLElement, options?: Pick<import("dom-context").ListenerOptions<unknown>, "onStatus" | "pollingMs" | "attempts">) => string;
-        useContextState: (host: HTMLElement, initialState?: string) => readonly [string, (value: string | ((previousState?: string) => string)) => void, import("dom-context").ContextProvider<string>];
-        Listener: new (o: Pick<import("dom-context").ListenerOptions<string>, "element" | "onChange" | "onStatus" | "pollingMs" | "attempts">) => import("dom-context").ContextListener<string>;
-        listen(o: Pick<import("dom-context").ListenerOptions<string>, "element" | "onChange" | "onStatus" | "pollingMs" | "attempts">): import("dom-context").ContextListener<string>;
-        Provider: new (o: Pick<import("dom-context").ProviderOptions<string>, "element" | "initialState">) => import("dom-context").ContextProvider<string>;
-        provide(o: Pick<import("dom-context").ProviderOptions<string>, "element" | "initialState">): import("dom-context").ContextProvider<string>;
-        provideGlobally(next: string): void;
-        name: string;
-    };
-};

package/dist/environment/UserIdentityContext.d.ts

@@ -1,51 +0,0 @@
-import { ContextProvider } from "dom-context";
-import debugFn from "debug";
-export declare const debug: debugFn.Debugger;
-export declare type UserIdentity = {
-    id: string;
-    accountId: string;
-    jwt?: string;
-    managedIdentity?: {
-        email: string;
-        emailVerified: boolean;
-        sessionData?: {
-            [key: string]: any;
-        };
-    };
-};
-export interface DecodedSquatchJWT {
-    exp?: number;
-    user?: {
-        accountId: string;
-        id: string;
-    };
-}
-export interface DecodedWidgetAPIJWT {
-    exp?: number;
-    sub?: string;
-}
-declare global {
-    interface Window {
-        squatchUserIdentity: ContextProvider<UserIdentity>;
-    }
-}
-/**
- * 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;
-/**
- * Gets the SessionData of the current user, or undefined if logged out
- */
-export declare function useSessionData(): {
-    [key: string]: any;
-} | undefined;
-/**
- * Gets the JWT of the current user, or undefined if logged out
- */
-export declare function useToken(): string | undefined;
-/**
- * Get the IDs and JWT of the current user, or undefined if logged out
- */
-export declare function useUserIdentity(): UserIdentity | undefined;

package/dist/environment/environment.d.ts

@@ -1,134 +0,0 @@
-/**
- * Environment provided by components hosted in a web component (`sqh-widget`)
- */
-declare global {
-    interface Window {
-        SquatchPortal?: PortalEnv;
-    }
-}
-/**
- * Portal env doesn't include User Id
- */
-export declare type PortalEnv = Pick<WidgetIdent, "tenantAlias" | "appDomain" | "programId">;
-/**
- * Program ID context helpers
- */
-export { useProgramId, setProgramId } from "./ProgramContext";
-/**
- * Locale context helpers
- */
-export { useLocale } from "./LocaleContext";
-/**
- * Provided by the SaaSquatch GraphQL backend when a widget is rendered.
- *
- * Source: https://github.com/saasquatch/saasquatch/blob/805e51284f818f8656b6458bcee6181f378819d3/packages/saasquatch-core/app/saasquatch/controllers/api/widget/WidgetApi.java
- *
- */
-export interface WidgetIdent {
-    tenantAlias: string;
-    appDomain: string;
-    token: string;
-    userId: string;
-    accountId: string;
-    locale?: string;
-    engagementMedium?: "POPUP" | "EMBED";
-    programId?: string;
-    env?: string;
-}
-/**
- * An interface for interacting with the SaaSquatch Admin Portal.
- *
- * Used for rendering widgets in a preview/demo mode.
- */
-export interface SquatchAdmin {
-    /**
-     * Provides a way of providing user feedback when a widget is rendered in the SaaSquatch admin portal
-     *
-     * @param text
-     */
-    showMessage(text: string): void;
-}
-/**
- * Type for the Javascript environment added by https://github.com/saasquatch/squatch-android
- *
- * Should exist as `window.SquatchAndroid`
- */
-export interface SquatchAndroid {
-    /**
-     *
-     * @param shareLink
-     * @param messageLink fallback URL to redirect to if the app is not installed
-     */
-    shareOnFacebook(shareLink: string, messageLink: string): void;
-    /**
-     * Shows a native Android toast
-     *
-     * @param text
-     */
-    showToast(text: string): void;
-}
-/**
- * An interface provided by Squatch.js V2 for widgets.
- *
- * See: https://github.com/saasquatch/squatch-js/blob/8f2b218c9d55567e0cc12d27d635a5fb545e6842/src/widgets/Widget.ts#L47
- *
- */
-export interface SquatchJS2 {
-    /**
-     * Opens the current popup widget (if loaded as a popup)
-     */
-    open?: () => void;
-    /**
-     * Closes the current popup widget (if loaded as a popup)
-     */
-    close?: () => void;
-    /**
-     * DEPRECATED used to update user details from inside the widget.
-     *
-     * Should no longer be used. Replace with natively using the GraphQL API and re-rendering locally. Will be removed in a future version of Squatch.js
-     *
-     * @deprecated
-     */
-    reload(userDetails: {
-        email: string;
-        firstName: string;
-        lastName: string;
-    }, jwt: string): void;
-}
-export declare type Environment = EnvironmentSDK["type"];
-export declare type EnvironmentSDK = {
-    type: "SquatchJS2";
-    api: SquatchJS2;
-    widgetIdent: WidgetIdent;
-} | {
-    type: "SquatchAndroid";
-    android: SquatchAndroid;
-    widgetIdent: WidgetIdent;
-} | {
-    type: "SquatchPortal";
-    env: PortalEnv;
-} | {
-    type: "SquatchAdmin";
-    adminSDK: SquatchAdmin;
-} | {
-    type: "None";
-};
-/**
- * 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 useTenantAlias(): string;
-export declare function useAppDomain(): string;
-export declare type UserId = {
-    id: string;
-    accountId: string;
-};
-declare type EngagementMedium = "EMBED" | "POPUP";
-export declare function useEngagementMedium(): EngagementMedium;

package/dist/environment/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./environment";
-/**
- * User identity context helpers
- */
-export { useUserIdentity, useToken, setUserIdentity, useSessionData, } from "./UserIdentityContext";

package/dist/hooks/graphql/useBatchedQuery.d.ts

@@ -1,45 +0,0 @@
-import { RequestDocument } from "graphql-request/dist/types";
-export declare type GqlType = RequestDocument;
-export interface BaseQueryData<T = unknown> {
-    loading: boolean;
-    data?: T;
-    errors?: GraphQlRequestError<T>;
-}
-export declare type QueryData<T> = BaseQueryData<T> & {
-    refetch: (variables?: unknown) => unknown;
-};
-/**
- * Note: reverse-engineered from a returned error. May not capture all error types.
- */
-export declare type GraphQlRequestError<T> = {
-    response: {
-        errors: [
-            {
-                message: string;
-                locations: [{
-                    line: number;
-                    column: number;
-                }];
-                path: string[];
-                extensions: {
-                    apiError: {
-                        message: string;
-                        statusCode: number;
-                        apiErrorCode: string;
-                        rsCode: string;
-                    };
-                    classification: string;
-                };
-            }
-        ];
-        data: Partial<T>;
-        status: number;
-    };
-    request: {
-        query: string;
-        variables: {
-            [key: string]: unknown;
-        };
-    };
-};
-export declare function useBatchedQuery<T = any>(query: GqlType, initialState: BaseQueryData<T>): [BaseQueryData<T>, (variables: unknown) => unknown];

package/dist/hooks/graphql/useCustomQuery.d.ts

@@ -1,30 +0,0 @@
-import { RequestDocument } from "graphql-request/dist/types";
-declare type GqlType = RequestDocument;
-interface CustomQueryData<T = unknown, E = any> {
-    loading: boolean;
-    data?: T;
-    errors?: CustomGraphQlRequestError<T, E>;
-}
-declare type QueryData<T> = CustomQueryData<T> & {
-    refetch: (variables?: unknown) => unknown;
-};
-declare type CustomGraphQlRequestError<T, E> = {
-    response: {
-        errors: E[];
-        data: Partial<T>;
-        status: number;
-    };
-    request: {
-        query: string;
-        variables: {
-            [key: string]: unknown;
-        };
-    };
-};
-export declare function useCustomQuery<T = any, E = any>(query: GqlType, initialState: CustomQueryData<T>, url: string): [CustomQueryData<T>, (variables: unknown) => unknown];
-export declare const customQueryHooksFactory: <E>(url: string) => {
-    useQuery: <T = any>(query: GqlType, variables: unknown, skip?: boolean) => QueryData<T>;
-    useLazyQuery: <T_1 = any>(query: GqlType) => [(e: unknown) => unknown, QueryData<T_1>];
-    useMutation: <T_2 = any>(query: GqlType) => [(e: unknown) => unknown, CustomQueryData<T_2, any>];
-};
-export {};

package/dist/hooks/managedIdentity/useManagedIdentityQuery.d.ts

@@ -1,13 +0,0 @@
-import { QueryData } from "../graphql/useBaseQuery";
-interface ManagedIdentityResult {
-    managedIdentity: {
-        email: string;
-        emailVerified: boolean;
-        sessionData: Record<string, any>;
-    };
-}
-export declare function useManagedIdentityQuery(): [
-    () => unknown,
-    QueryData<ManagedIdentityResult>
-];
-export {};