@simplybusiness/services 2.4.5 → 2.4.7

package/dist/types/components/TradeSelector/types.d.ts

@@ -1,51 +0,0 @@
-import { Ref, RefAttributes } from "react";
-import { DOMProps } from "@react-types/shared";
-export type DialogRef = HTMLDialogElement;
-export type InputRef = HTMLInputElement;
-export type TradeSelectorSearchScope = "all_verticals" | "current_and_supported_verticals" | "current_vertical" | "except_current_vertical" | "usa_contractors" | "commercial_landlord_business_types" | "contractors_combined" | "supported_for_current_vertical" | "commercial_combined_manufacturer" | "commercial_combined_wholesaler" | "commercial_combined_all";
-export type TradeSelectorVertical = string;
-export type TradeProps = {
-    value: string;
-    vertical: string;
-    supported_verticals: string[] | null;
-    label: string;
-    type: string;
-    trade_detail: string | null;
-    trade_type: string | null;
-    blocked: boolean;
-};
-export type LabelProps = {
-    input: string;
-    exact: string;
-    suggested: string;
-    noResults: string;
-    loading: string;
-    description: string;
-    placeholder: string;
-};
-export type UrlProps = {
-    quoteRedirect: string;
-    tradeApi: string;
-    allOccupations?: string | undefined;
-};
-export type TradeSelectorCommonProps = {
-    minInput: number;
-    apiRequestDebounceInMs: number;
-    urls: Partial<UrlProps>;
-    onTradeSelected?: (trade: TradeProps | string) => void;
-    initialTrade?: string;
-    vertical?: TradeSelectorVertical;
-    searchScope?: TradeSelectorSearchScope;
-};
-export type TradeSelectorElementType = HTMLDivElement;
-export interface TradeSelectorProps extends Partial<TradeSelectorCommonProps>, DOMProps, RefAttributes<TradeSelectorElementType> {
-    /** Custom class name for setting specific CSS */
-    className?: string;
-    elementType?: string | React.ElementType;
-    onTradeSelected?: (trade: TradeProps | string) => void;
-    labels?: Partial<LabelProps>;
-    hideLabel?: boolean;
-    "data-cy"?: string;
-    "aria-describedby"?: string;
-}
-export type TradeSelectorRef = Ref<TradeSelectorElementType>;

package/dist/types/components/TradeSelector/useFetchTrades/index.d.ts

@@ -1 +0,0 @@
-export * from "./useFetchTrades";

package/dist/types/components/TradeSelector/useFetchTrades/useFetchTrades.d.ts

@@ -1,7 +0,0 @@
-import { TradeProps } from "../types";
-export declare const useFetchTrades: (endpoint: URL, debounceInMs: number) => {
-    isLoading: boolean;
-    error: Error | null;
-    trades: TradeProps[] | null;
-    fetchTrades: import("react").Dispatch<import("react").SetStateAction<boolean>>;
-};

package/dist/types/components/TradeSelector/useTradeSelectorUrl/index.d.ts

@@ -1 +0,0 @@
-export * from "./useTradeSelectorUrl";

package/dist/types/components/TradeSelector/useTradeSelectorUrl/useTradeSelectorUrl.d.ts

@@ -1,6 +0,0 @@
-export type TradeSelectorUrlOptions = {
-    vertical?: string;
-    searchScope?: string;
-    site?: string;
-};
-export declare function useTradeSelectorUrl(tradeApi: string, userInput: string, { vertical, searchScope, site }?: TradeSelectorUrlOptions): URL;

package/dist/types/components/TradeSelector/useTradeSelectorUrl/useTradeSelectorUrl.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/components/TrustSection/TrustSection.d.ts

@@ -1,10 +0,0 @@
-import { Ref, RefAttributes } from "react";
-import { DOMProps, ForwardedRefComponent } from "@simplybusiness/mobius";
-export type TrustSectionElementType = HTMLDivElement;
-export interface TrustSectionProps extends DOMProps, RefAttributes<TrustSectionElementType> {
-    /** Custom class name for setting specific CSS */
-    className?: string;
-    elementType?: string | React.ElementType;
-}
-export type TrustSectionRef = Ref<TrustSectionElementType>;
-export declare const TrustSection: ForwardedRefComponent<TrustSectionProps, TrustSectionElementType>;

package/dist/types/components/TrustSection/TrustSection.stories.d.ts

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from "@storybook/react";
-import { TrustSection } from "./TrustSection";
-type StoryType = StoryObj<typeof TrustSection>;
-declare const meta: Meta<typeof TrustSection>;
-export declare const Normal: StoryType;
-export default meta;

package/dist/types/components/TrustSection/TrustSection.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/components/TrustSection/index.d.ts

@@ -1 +0,0 @@
-export * from "./TrustSection";

package/dist/types/data/page-contract-flat.d.ts

@@ -1,17 +0,0 @@
-import { FooterProps } from "../components/Footer";
-import { HeaderProps } from "../components/Header";
-export type PageProps = {
-    layout: PageLayoutProps;
-};
-type PageLayoutProps = {
-    site: string;
-    header: HeaderProps;
-    footer: FooterProps;
-    main: {
-        firstName: string;
-        referenceNumber: string;
-        contactNumber: string;
-    };
-};
-declare const pageData: PageProps;
-export default pageData;

package/dist/types/data/page-contract-nested.d.ts

@@ -1,17 +0,0 @@
-import { FooterProps } from "../components/Footer";
-import { HeaderProps } from "../components/Header";
-export type PageProps = {
-    layout: PageLayoutProps;
-};
-type Feature = {
-    name: string;
-    props?: HeaderProps | FooterProps | Record<string, unknown>;
-};
-type PageLayoutProps = {
-    site: string;
-    header: Feature[];
-    footer: Feature[];
-    main: Feature[];
-};
-declare const pageData: PageProps;
-export default pageData;

package/dist/types/data/page-contract-v1.d.ts

@@ -1,2 +0,0 @@
-import { GeneralPageProps } from "../pages/GeneralPage/types";
-export declare const pageData: GeneralPageProps;

package/dist/types/data/page-contract-v2.d.ts

@@ -1,2 +0,0 @@
-import { GeneralPageProps } from "../pages/GeneralPage/types";
-export declare const pageData: GeneralPageProps;

package/dist/types/data/scripts-mock.d.ts

@@ -1,44 +0,0 @@
-export declare const pageData: {
-    scripts: {
-        metadata: {
-            name: string;
-        };
-        props: {
-            uid: string;
-            cookieDomain: string;
-            avalancheCollector: string;
-            appId: string;
-            includeGAContext: boolean;
-            eventMethod: string;
-            postPath: string;
-            trackActivity: boolean;
-            trackPageView: boolean;
-            pageViewContext: {
-                schema: string;
-                data: {
-                    site: string;
-                    vertical: string;
-                    super_segment: string;
-                    primary_detail: string;
-                    journey_name: string;
-                    journey_id: string;
-                    page_step_name: string;
-                    page_step_depth: number;
-                };
-            };
-            distributionChannelContext: {
-                schema: string;
-                data: {
-                    service_channel_identifier: string;
-                };
-            };
-            serviceChannelContext: {
-                schema: string;
-                data: {
-                    service_channel_identifier: string;
-                };
-            };
-            forceSecureTracker: boolean;
-        };
-    }[];
-};

package/dist/types/data/thank-you-page-mock.d.ts

@@ -1,44 +0,0 @@
-export declare const pageData: {
-    scripts: {
-        metadata: {
-            name: string;
-        };
-        props: {
-            uid: string;
-            cookieDomain: string;
-            avalancheCollector: string;
-            appId: string;
-            includeGAContext: boolean;
-            eventMethod: string;
-            postPath: string;
-            trackActivity: boolean;
-            trackPageView: boolean;
-            pageViewContext: {
-                schema: string;
-                data: {
-                    site: string;
-                    vertical: string;
-                    super_segment: string;
-                    primary_detail: string;
-                    journey_name: string;
-                    journey_id: string;
-                    page_step_name: string;
-                    page_step_depth: number;
-                };
-            };
-            distributionChannelContext: {
-                schema: string;
-                data: {
-                    service_channel_identifier: string;
-                };
-            };
-            serviceChannelContext: {
-                schema: string;
-                data: {
-                    service_channel_identifier: string;
-                };
-            };
-            forceSecureTracker: boolean;
-        };
-    }[];
-};

package/dist/types/hooks/useOnClickOutside/index.d.ts

@@ -1 +0,0 @@
-export * from "./useOnClickOutside";

package/dist/types/hooks/useOnClickOutside/useOnClickOutside.d.ts

@@ -1,2 +0,0 @@
-import { RefObject } from "react";
-export declare const useOnClickOutside: (ref: RefObject<HTMLElement>, handler: (event: MouseEvent | TouchEvent) => void) => void;

package/dist/types/hooks/useWindowEvent/index.d.ts

@@ -1 +0,0 @@
-export * from "./useWindowEvent";

package/dist/types/hooks/useWindowEvent/useWindowEvent.d.ts

@@ -1 +0,0 @@
-export declare function useWindowEvent<EventType extends keyof WindowEventMap>(type: EventType, listener: (this: Window, ev: WindowEventMap[EventType]) => any, options?: AddEventListenerOptions): void;

package/dist/types/pages/GeneralPage/GeneralPage.d.ts

@@ -1,2 +0,0 @@
-import type { GeneralPageProps } from "./types";
-export declare const GeneralPage: (props: GeneralPageProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/pages/GeneralPage/GeneralPage.stories.d.ts

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from "@storybook/react";
-import { GeneralPage } from "./GeneralPage";
-type StoryType = StoryObj<typeof GeneralPage>;
-declare const meta: Meta<typeof GeneralPage>;
-export declare const Normal: StoryType;
-export default meta;

package/dist/types/pages/GeneralPage/GeneralPage.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/pages/GeneralPage/Main.d.ts

@@ -1,5 +0,0 @@
-import type { FeatureProps } from "./types";
-export type MainProps = {
-    components: FeatureProps[];
-};
-export declare const Main: (props: MainProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/pages/GeneralPage/getMainComponents.d.ts

@@ -1,6 +0,0 @@
-import { ReactNode } from "react";
-import type { FeatureProps } from "./types";
-type FeatureMapProps = Record<string, (props: unknown) => ReactNode>;
-export declare const mainFeatureMap: FeatureMapProps;
-export declare const getMainComponents: (components: FeatureProps[]) => ReactNode[];
-export {};

package/dist/types/pages/GeneralPage/index.d.ts

@@ -1 +0,0 @@
-export * from "./GeneralPage";

package/dist/types/pages/GeneralPage/mainComponents.d.ts

@@ -1,2 +0,0 @@
-import { ReactNode } from "react";
-export declare const AVAILABLE_COMPONENTS: Record<string, (props: unknown) => ReactNode>;

package/dist/types/pages/GeneralPage/types.d.ts

@@ -1,23 +0,0 @@
-import type { FooterProps } from "../../components/Footer";
-import type { HeaderProps } from "../../components/Header";
-import { ThankYouProps } from "../../components/ThankYou";
-export type GeneralPageProps = {
-    layout: GeneralPageLayout;
-};
-type GeneralPageLayout = {
-    components: FeatureProps[];
-    variations?: FeatureProps[];
-};
-export type FeatureProps = {
-    metadata: MetaData;
-    props?: HeaderProps | FooterProps | ThankYouProps;
-    components?: FeatureProps[];
-};
-export type VariationProps = {
-    metadata: MetaData;
-    props?: Record<string, unknown>;
-};
-type MetaData = {
-    name: string;
-};
-export {};

package/dist/types/pages/Page/Page.d.ts

@@ -1,2 +0,0 @@
-import type { PageProps } from "./types";
-export declare const Page: (props: PageProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/pages/Page/index.d.ts

@@ -1 +0,0 @@
-export * from "./Page";

package/dist/types/pages/Page/types.d.ts

@@ -1,29 +0,0 @@
-import { ReactNode } from "react";
-import type { FooterProps } from "../../components/Footer";
-import type { HeaderProps } from "../../components/Header";
-export type PageProps = {
-    layout: PageLayout;
-    scripts?: GenericFeatureProps[];
-    children?: ReactNode;
-};
-type StandardFeatures = HeaderProps | FooterProps | Record<string, unknown>;
-type PageLayout = {
-    components: FeatureProps[];
-    variations?: GenericFeatureProps[];
-};
-export type FeatureProps = {
-    metadata: MetaData;
-    props?: StandardFeatures;
-    components?: FeatureProps[];
-};
-export type GenericFeatureProps = {
-    metadata: MetaData;
-    props?: Record<string, unknown>;
-};
-export type MetaData = {
-    name: string;
-};
-export type Replace<T, From, To> = T extends (...args: any[]) => any ? T : {
-    [K in keyof T]: [T[K], From] extends [From, T[K]] ? To : Replace<T[K], From, To>;
-};
-export {};

package/dist/types/pages/Simple/Main.d.ts

@@ -1,5 +0,0 @@
-import { Feature } from "../../data/page-contract-v1";
-export type MainProps = {
-    components: Feature[];
-};
-export declare const Main: (props: MainProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/pages/Simple/Simple.d.ts

@@ -1,2 +0,0 @@
-import { PageProps } from "../../data/page-contract-v1";
-export declare const Simple: (props: PageProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/pages/Simple/Simple.stories.d.ts

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from "@storybook/react";
-import { Simple } from "./Simple";
-type StoryType = StoryObj<typeof Simple>;
-declare const meta: Meta<typeof Simple>;
-export declare const Normal: StoryType;
-export default meta;

package/dist/types/pages/Simple/index.d.ts

@@ -1 +0,0 @@
-export * from "./Simple";

package/dist/types/pages/Simple/useMainComponents.d.ts

@@ -1,3 +0,0 @@
-import { ReactNode } from "react";
-import { Feature } from "../../data/page-contract-v1";
-export declare const useMainComponents: (components: Feature[]) => ReactNode[];

package/dist/types/pages/ThankYouPage/ThankYouPage.d.ts

@@ -1,2 +0,0 @@
-import type { ThankYouPageProps } from "./types";
-export declare const ThankYouPage: (props: ThankYouPageProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/pages/ThankYouPage/ThankYouPage.stories.d.ts

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from "@storybook/react";
-import { ThankYouPage } from "./ThankYouPage";
-type StoryType = StoryObj<typeof ThankYouPage>;
-declare const meta: Meta<typeof ThankYouPage>;
-export declare const Normal: StoryType;
-export default meta;

package/dist/types/pages/ThankYouPage/ThankYouPage.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/pages/ThankYouPage/index.d.ts

@@ -1 +0,0 @@
-export * from "./ThankYouPage";

package/dist/types/pages/ThankYouPage/types.d.ts

@@ -1,10 +0,0 @@
-import type { FooterProps } from "../../components/Footer";
-import type { HeaderProps } from "../../components/Header";
-import { ThankYouProps } from "../../components/ThankYou";
-import { FeatureProps, MetaData, PageProps, Replace } from "../Page/types";
-export type ThankYouContentProps = Pick<ThankYouProps, "firstName" | "showTrustSection" | "referenceNumber" | "phoneNumbers" | "sbDirect">;
-export type ThankYouFeatureProps = {
-    metadata: MetaData;
-    props?: HeaderProps | FooterProps | ThankYouContentProps;
-};
-export type ThankYouPageProps = Replace<PageProps, FeatureProps, ThankYouFeatureProps>;

package/dist/types/services/airbrake/index.d.ts

@@ -1,2 +0,0 @@
-import { Notifier } from "@airbrake/browser";
-export declare const airbrake: Notifier;

package/dist/types/services/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./snowplow";
-export * from "./airbrake";

package/dist/types/services/snowplow/Snowplow.d.ts

@@ -1,29 +0,0 @@
-import { SelfDescribingJson, StructuredEvent } from "@snowplow/browser-tracker";
-import { EventDefinition, TrackingProps } from "./types";
-export type FrontOfficeStructuredEvent = StructuredEvent & {
-    serviceChannelIdentifier: string;
-};
-/**
- * This class is an abstraction which wraps Snowplow
- * and exposes common methods with other services:
- * - trackEvent            : sends a standard payload
- * - trackUnstructEvent    : sends a payload for custom schema
- */
-export declare class Snowplow {
-    avalancheTrackerName: string;
-    bronzeAvalancheTrackerName: string;
-    pvAvalancheTrackerName: string;
-    uid: unknown;
-    trackPageView: boolean;
-    contexts: SelfDescribingJson<Record<string, unknown>>[];
-    eventHandlers: Record<string, (params?: Record<string, unknown>) => void>;
-    constructor(props?: TrackingProps);
-    setContexts(contexts: SelfDescribingJson<Record<string, unknown>>[]): this;
-    trackView(): this;
-    trackEvent(event: StructuredEvent): Promise<this>;
-    trackUnstructEvent(event: SelfDescribingJson<Record<string, unknown>>): Promise<this>;
-    addEventHandlers(eventDefinitions: EventDefinition[]): this;
-    private addEventHandler;
-    private removeEventHandler;
-    trigger(name: string, params?: Record<string, unknown>): this;
-}

package/dist/types/services/snowplow/SnowplowContext.d.ts

@@ -1,14 +0,0 @@
-import { type ReactNode } from "react";
-import { Snowplow } from "./Snowplow";
-import { TrackingProps } from "./types";
-export interface SnowplowContextInterface {
-    config: TrackingProps;
-    snowplow?: Snowplow;
-}
-type ProviderProps = {
-    scripts: TrackingProps;
-    children: ReactNode;
-};
-export declare const SnowplowProvider: ({ scripts, children }: ProviderProps) => import("react/jsx-runtime").JSX.Element;
-export declare function useSnowplowContext(): SnowplowContextInterface;
-export {};

package/dist/types/services/snowplow/SnowplowContext.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/services/snowplow/contexts.d.ts

@@ -1,3 +0,0 @@
-import { SelfDescribingJson } from "@snowplow/browser-tracker";
-import { TrackingProps } from "./types";
-export declare const getContexts: (config: TrackingProps) => SelfDescribingJson<Record<string, unknown>>[];

package/dist/types/services/snowplow/contexts.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/services/snowplow/event-definitions/base.d.ts

@@ -1,18 +0,0 @@
-import { EventDefinition } from "../types";
-/**
- * Event definitions for Snowplow
- * @type {EventDefinition[]}
- * @property {string} name - The name of the event, to use when triggering
- * @property {string} type - The type of the event (structured | unstructured)
- * @property {makePayload} makePayload
- *   - Function that creates the payload for the event;
- *   - Allows optional params object to be passed in
- *
- * @example
- * import { Snowplow } from "./Snowplow";
- * import { eventDefinitions } from "./event-definitions";
- *
- * const snowplow = new Snowplow();
- * snowplow.addEventHandlers(eventDefinitions);
- */
-export declare const baseEventDefinitions: EventDefinition[];

package/dist/types/services/snowplow/event-definitions/index.d.ts

@@ -1,2 +0,0 @@
-export declare const eventDefinitions: import("..").EventDefinition[];
-export declare const qcpPageEvents: import("..").EventDefinition[];

package/dist/types/services/snowplow/event-definitions/qcp.d.ts

@@ -1,18 +0,0 @@
-import { EventDefinition } from "../types";
-/**
- * Event definitions for Snowplow
- * @type {EventDefinition[]}
- * @property {string} name - The name of the event, to use when triggering
- * @property {string} type - The type of the event (structured | unstructured)
- * @property {makePayload} makePayload
- *   - Function that creates the payload for the event;
- *   - Allows optional params object to be passed in
- *
- * @example
- * import { Snowplow } from "./Snowplow";
- * import { eventDefinitions } from "./event-definitions";
- *
- * const snowplow = new Snowplow();
- * snowplow.addEventHandlers(eventDefinitions);
- */
-export declare const qcpEventDefinitions: EventDefinition[];

package/dist/types/services/snowplow/event-definitions.d.ts

@@ -1,18 +0,0 @@
-import { EventDefinition } from "./types";
-/**
- * Event definitions for Snowplow
- * @type {EventDefinition[]}
- * @property {string} name - The name of the event, to use when triggering
- * @property {string} type - The type of the event (structured | unstructured)
- * @property {makePayload} makePayload
- *   - Function that creates the payload for the event;
- *   - Allows optional params object to be passed in
- *
- * @example
- * import { Snowplow } from "./Snowplow";
- * import { eventDefinitions } from "./event-definitions";
- *
- * const snowplow = new Snowplow();
- * snowplow.addEventHandlers(eventDefinitions);
- */
-export declare const eventDefinitions: EventDefinition[];

package/dist/types/services/snowplow/getSnowplowConfig.d.ts

@@ -1,2 +0,0 @@
-import type { TrackingProps, PageDataProps } from "./types";
-export declare const getSnowplowConfig: (pageData: PageDataProps) => TrackingProps | undefined;

package/dist/types/services/snowplow/index.d.ts

@@ -1,6 +0,0 @@
-export * from "./contexts";
-export * from "./event-definitions";
-export * from "./getSnowplowConfig";
-export * from "./Snowplow";
-export * from "./SnowplowContext";
-export * from "./types";

package/dist/types/services/snowplow/index.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/services/snowplow/types.d.ts

@@ -1,37 +0,0 @@
-import { EventMethod, SelfDescribingJson, StructuredEvent } from "@snowplow/browser-tracker";
-type BaseConfig = {
-    appId: string;
-    avalancheCollector: string;
-    eventMethod: EventMethod;
-    trackPageView: boolean;
-    includeGAContext: boolean;
-    uid?: string;
-    postPath?: string;
-};
-export type EnvConfig = BaseConfig & {
-    cookieDomain: Record<string, string>;
-};
-export type TrackingProps = BaseConfig & {
-    eventMethod: EventMethod;
-    cookieDomain?: string;
-};
-export type ChannelContext = {
-    schema: string;
-    data: Record<string, string | number>;
-};
-export type ChannelContexts = Record<string, ChannelContext>;
-export type ArrayOneOrMore<T> = [T, ...T[]];
-export type ParamsType = Record<"label" | "deviceType" | "category" | "product" | "title" | "label" | "name" | "fromValue" | "toValue", string>;
-export type EventDefinition = {
-    name: string;
-    type: "structured" | "unstructured";
-    makePayload: (params?: Record<string, unknown>) => StructuredEvent | SelfDescribingJson<Record<string, unknown>>;
-};
-export interface PageDataProps extends Partial<Record<"scripts", Array<{
-    metadata: {
-        name: string;
-    };
-    props?: Record<string, unknown>;
-}>>> {
-}
-export {};

package/dist/types/snowplow/SnowplowContext.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/snowplow/contexts.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/snowplow/event-definitions/events.d.ts

@@ -1,20 +0,0 @@
-export declare const snowplowEvents: {
-    limitChanged: (primaryText: string, newLimit: string) => {
-        label: string;
-        limit: string;
-    };
-    validationShown: (coverName: string, fieldName: string) => {
-        cover: string;
-        question: string;
-    };
-    coverQuestionAnswered: (questionText: string, answerValue: string) => {
-        question: string;
-        answer: string;
-    };
-    coverPresented: (primaryText: string) => {
-        property: string;
-    };
-    moreInfoClicked: (primaryText: string) => {
-        property: string;
-    };
-};