@simplybusiness/services 2.4.5 → 2.4.7

package/dist/types/snowplow/event-definitions/pcp.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;
-    };
-};

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

@@ -1,2 +0,0 @@
-import { EventDefinition } from "../types";
-export declare const progressbarEventDefinitions: EventDefinition[];

package/dist/types/snowplow/event-definitions/questionnaire/questionnaire.test.d.ts

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

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

@@ -1,2 +0,0 @@
-import type { EventDefinition } from "../types";
-export declare const questionnaireEventDefinitions: EventDefinition[];

package/dist/types/snowplow/event-definitions/questionnaire.test.d.ts

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

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

@@ -1,5 +0,0 @@
-import type { ParamsType } from "../types";
-export declare const redact: (params: ParamsType) => {
-    question: string;
-    answer: string;
-};

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

@@ -1,2 +0,0 @@
-import { EventDefinition } from "../types";
-export declare const sharedEventDefinitions: EventDefinition[];

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

@@ -1,2 +0,0 @@
-import { EventDefinition } from "../types";
-export declare const shoppingCartEventDefinitions: EventDefinition[];

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

@@ -1,2 +0,0 @@
-import { EventDefinition } from "../types";
-export declare const thankYouEventDefinitions: EventDefinition[];

package/dist/types/snowplow/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;
-    };
-};

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

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

package/dist/types/src/address-lookup/index.d.ts

@@ -1,15 +0,0 @@
-import type { AddressLookupConfig, Options } from "./types";
-export declare class AddressLookup {
-    private apiKey;
-    private limit;
-    private findUrl;
-    private retrieveUrl;
-    private countries;
-    constructor({ apiKey, limit, countries }: AddressLookupConfig);
-    private static fetchFromApi;
-    find(partialAddress: string): Promise<Options>;
-    findById(id: string): Promise<Options>;
-    get(id: string): Promise<Record<string, string>>;
-    private formatItems;
-    private static formatUkAddress;
-}

package/dist/types/src/address-lookup/types.d.ts

@@ -1,44 +0,0 @@
-export type Option = {
-    id: string;
-    label: string;
-    value: string | number | boolean;
-    callback?: () => Promise<Options>;
-};
-export type OptionGroup = {
-    heading: string;
-    options: Option[];
-};
-export type Options = Option[] | OptionGroup[];
-export type FindAddressResult = {
-    Id: string;
-    Type: string;
-    Text: string;
-    Highlight: string;
-    Description: string;
-};
-export type AddressError = {
-    Cause: string;
-    Error: string;
-    Description: string;
-    Resolution: string;
-};
-export type FindAddressResponse = {
-    Items: FindAddressResult[] | AddressError[];
-};
-export type RetrieveAddressResult = {
-    Id: string;
-    Type: string;
-    City: string;
-    Line1: string;
-    Line2: string;
-    PostalCode: string;
-    Label: string;
-};
-export type RetrieveAddressResponse = {
-    Items: RetrieveAddressResult[] | AddressError[];
-};
-export type AddressLookupConfig = {
-    apiKey: string;
-    limit?: number;
-    countries?: string[];
-};

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

@@ -1,9 +0,0 @@
-export declare const getAirbrakeEnvironment: () => string;
-export type GetAirbrakeOptions = {
-    projectId?: number;
-    projectKey?: string;
-    forceSend?: boolean;
-};
-export declare function getAirbrake(options?: GetAirbrakeOptions): {
-    notify: (...data: any[]) => void;
-};

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

@@ -1,3 +0,0 @@
-export * from "./address-lookup";
-export * from "./airbrake";
-export * from "./snowplow";

package/dist/types/src/mocks/eventDefinitions.d.ts

@@ -1,61 +0,0 @@
-import type { ParamsType } from "../snowplow";
-declare const _default: ({
-    name: string;
-    type: string;
-    makePayload: (params: {
-        label: "next" | "back" | "redirect";
-    }) => {
-        category: string;
-        action: string;
-        label: "next" | "back" | "redirect";
-        property: string;
-    };
-    contexts?: undefined;
-} | {
-    name: string;
-    type: string;
-    makePayload: (params: ParamsType) => {
-        schema: string;
-        data: {
-            site: string;
-            page_index: number;
-            page_name: string;
-            submitted_from: string;
-            section_name: string;
-            question: string;
-            answer: string;
-            vertical: string;
-            journey_id: string;
-        };
-    };
-    contexts: string[];
-} | {
-    name: string;
-    type: string;
-    makePayload: (params: ParamsType) => {
-        schema: string;
-        data: {
-            site: string;
-            vertical: string;
-            primary_detail: string;
-            selected_type: string;
-        };
-    };
-    contexts?: undefined;
-} | {
-    name: string;
-    type: string;
-    makePayload: (params: ParamsType) => {
-        schema: string;
-        data: {
-            vertical: string;
-            site: string;
-            help_text: string;
-            primary_text: string;
-            label: string;
-            page_name: string;
-        };
-    };
-    contexts?: undefined;
-})[];
-export default _default;

package/dist/types/src/mocks/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;
-                    superSegment: string;
-                    primaryDetail: string;
-                    journeyName: string;
-                    journeyId: string;
-                    pageStepName: string;
-                    pageStepDepth: number;
-                };
-            };
-            distributionChannelContext: {
-                schema: string;
-                data: {
-                    service_channel_identifier: string;
-                };
-            };
-            serviceChannelContext: {
-                schema: string;
-                data: {
-                    service_channel_identifier: string;
-                };
-            };
-            forceSecureTracker: boolean;
-        };
-    }[];
-};

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

@@ -1,34 +0,0 @@
-import type { PageViewEvent, StructuredEvent } from "@snowplow/browser-tracker";
-import type { EventDefinition, SerialisedEvent, 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: Record<string, SerialisedEvent>;
-    pvContext: SerialisedEvent[];
-    structContext: SerialisedEvent[];
-    serverData: Record<string, unknown>;
-    eventHandlers: Record<string, (params?: Record<string, unknown>) => void>;
-    static instance: Snowplow | undefined;
-    constructor(props?: TrackingProps);
-    setContexts(contexts: Record<string, SerialisedEvent>): this;
-    trackView(event?: PageViewEvent): this;
-    trackEvent(event: StructuredEvent): this;
-    trackUnstructEvent(event: SerialisedEvent, contexts?: string[]): this;
-    addEventHandlers(eventDefinitions: EventDefinition[]): this;
-    private addEventHandler;
-    private removeEventHandler;
-    trigger(name: string, params?: Record<string, unknown>): this;
-    static getInstance(props?: TrackingProps): Snowplow;
-}

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

@@ -1,14 +0,0 @@
-import { type ReactNode } from "react";
-import { Snowplow } from "./Snowplow";
-import type { 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/src/snowplow/constants.d.ts

@@ -1 +0,0 @@
-export declare const DELIMITER = "|";

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

@@ -1,4 +0,0 @@
-import type { SerialisedEvent, TrackingProps } from "./types";
-export declare const getContexts: (config: TrackingProps) => Record<string, SerialisedEvent>;
-export declare const updateIdentityContext: (contexts: Record<string, SerialisedEvent>, uid: unknown) => Record<string, SerialisedEvent>;
-export declare const makeContexts: (keys: string[], config: Record<string, SerialisedEvent>) => SerialisedEvent[];

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

@@ -1,22 +0,0 @@
-import type { 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
- * Parent
- * import { getSnowplowConfig, SnowplowProvider } from "@simplybusiness/services";
- * const snowplowProps = getSnowplowConfig(pageData);
- * <SnowplowProvider scripts={snowplowProps!}>{children}</SnowplowProvider>
- *
- * Child
- * import { useSnowplowContext } from "@simplybusiness/services";
- * const { snowplow } = useSnowplowContext();
- * const handlerFunction = () => snowplow?.trigger("eventNameHere");
- */
-export declare const baseEventDefinitions: EventDefinition[];

package/dist/types/src/snowplow/event-definitions/coverage-selection.d.ts

@@ -1,2 +0,0 @@
-import type { EventDefinition } from "../types";
-export declare const coverageSelectionEventDefinitions: EventDefinition[];

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

@@ -1,8 +0,0 @@
-export declare const eventDefinitions: import("..").EventDefinition[];
-export declare const qcpPageEvents: import("..").EventDefinition[];
-export declare const referralPageEvents: import("..").EventDefinition[];
-export declare const personalisedCoverPageEvents: import("..").EventDefinition[];
-export declare const interventionPageEvents: import("..").EventDefinition[];
-export type { InterventionPayload } from "./intervention";
-export declare const questionnairePageEvents: import("..").EventDefinition[];
-export declare const coverageSelectionPageEvents: import("..").EventDefinition[];

package/dist/types/src/snowplow/event-definitions/intervention.d.ts

@@ -1,12 +0,0 @@
-import type { EventDefinition } from "../types";
-type InterventionIdTypes = "duid";
-export type InterventionPayload = {
-    interventionId: string;
-    interventionName: string;
-    userUniqueIdentifier: string;
-    userUniqueIdentifierType: InterventionIdTypes;
-    action: string;
-    site?: string;
-};
-export declare const interventionEventDefinitions: EventDefinition[];
-export {};

package/dist/types/src/snowplow/event-definitions/personalised_cover.d.ts

@@ -1,22 +0,0 @@
-import type { 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
- * Parent
- * import { getSnowplowConfig, SnowplowProvider } from "@simplybusiness/services";
- * const snowplowProps = getSnowplowConfig(pageData);
- * <SnowplowProvider scripts={snowplowProps!}>{children}</SnowplowProvider>
- *
- * Child
- * import { useSnowplowContext } from "@simplybusiness/services";
- * const { snowplow } = useSnowplowContext();
- * const handlerFunction = () => snowplow?.trigger("eventNameHere");
- */
-export declare const personalisedCoverEventDefinitions: EventDefinition[];

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

@@ -1,2 +0,0 @@
-import type { EventDefinition } from "../types";
-export declare const qcpEventDefinitions: EventDefinition[];

package/dist/types/src/snowplow/event-definitions/questionnaire/questionnaire.d.ts

@@ -1,2 +0,0 @@
-import type { EventDefinition } from "../../types";
-export declare const questionnaireEventDefinitions: EventDefinition[];

package/dist/types/src/snowplow/event-definitions/questionnaire/redaction.d.ts

@@ -1,5 +0,0 @@
-import type { ParamsType } from "../../types";
-export declare const redact: (params: ParamsType) => {
-    question: string;
-    answer: string;
-};

package/dist/types/src/snowplow/event-definitions/referral.d.ts

@@ -1,2 +0,0 @@
-import type { EventDefinition } from "../types";
-export declare const referralEventDefinitions: EventDefinition[];

package/dist/types/src/snowplow/event-definitions/test-utils.d.ts

@@ -1,2 +0,0 @@
-import type { EventDefinition } from "../types";
-export declare const findEventByName: (eventDefinitions: EventDefinition[], eventName: string) => EventDefinition;

package/dist/types/src/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/src/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/src/snowplow/types.d.ts

@@ -1,54 +0,0 @@
-import type { EventMethod, SelfDescribingJson, StructuredEvent } from "@snowplow/browser-tracker";
-type BaseConfig = {
-    appId: string;
-    avalancheCollector: string;
-    eventMethod: EventMethod;
-    trackPageView: boolean;
-    includeGAContext: boolean;
-    duid?: string;
-    uid?: string;
-    postPath?: string;
-};
-export type EnvConfig = BaseConfig & {
-    cookieDomain: Record<string, string>;
-};
-export type TrackingProps = BaseConfig & {
-    eventMethod: EventMethod;
-    cookieDomain?: string;
-    pageViewContext?: ChannelContext;
-};
-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<string, string> & {
-    context: ServerContext;
-};
-type ServerContext = {
-    site: string;
-    vertical: string;
-    primaryDetail: string;
-    journeyName: string;
-    journeyId: string;
-};
-export type LinkType = Record<string, string> & {
-    targetUrl: string;
-    elementContent: string;
-};
-export type SerialisedEvent = SelfDescribingJson<Record<string, unknown>>;
-export type EventDefinition = {
-    name: string;
-    type: "structured" | "unstructured";
-    makePayload: (params?: Record<string, unknown>) => StructuredEvent | SerialisedEvent;
-    contexts?: string[];
-};
-export interface PageDataProps extends Partial<Record<"scripts", Array<{
-    metadata: {
-        name: string;
-    };
-    props?: Record<string, unknown>;
-}>>> {
-}
-export {};

package/dist/types/src/utils/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./text";
-export * from "./isObject";

package/dist/types/src/utils/isObject.d.ts

@@ -1 +0,0 @@
-export declare function isObject(value: unknown): value is Record<string, unknown>;

package/dist/types/src/utils/testUtils.d.ts

@@ -1,7 +0,0 @@
-import type { RenderOptions } from "@testing-library/react";
-import type { ReactElement } from "react";
-export declare const renderWithProviders: (ui: ReactElement, options?: RenderOptions) => import("@testing-library/react").RenderResult<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>;
-export declare const mockLocation: ({ origin, pathname, }: {
-    origin?: string;
-    pathname?: string;
-}) => Window & typeof globalThis;

package/dist/types/src/utils/text.d.ts

@@ -1,3 +0,0 @@
-export declare const snakeCaseKeys: (object: Record<string, unknown>) => Record<string, unknown>;
-export declare const snakeCase: (text?: string) => string;
-export declare const camelToSnakeCase: (text: string) => string;

package/dist/types/tracking-helper/TrackingHelper.d.ts

@@ -1,15 +0,0 @@
-export interface TrackingHandler {
-    event: string;
-    action: () => void;
-    onInit?: () => boolean;
-    trigger?: Element | Window;
-}
-export interface TrackingHelperOptions {
-    onInit?: () => boolean;
-    trigger?: Element | Window;
-}
-export declare class TrackingHelper {
-    private handlers;
-    register(event: string, action: () => void, opts?: TrackingHelperOptions): void;
-    attach(): void;
-}

package/dist/types/tracking-helper/index.d.ts

@@ -1,15 +0,0 @@
-export interface TrackingHandler {
-    event: string;
-    action: () => void;
-    onInit?: () => boolean;
-    trigger?: Element | Window;
-}
-export interface TrackingHelperOptions {
-    onInit?: () => boolean;
-    trigger?: Element | Window;
-}
-export declare class TrackingHelper {
-    private handlers;
-    register(event: string, action: () => void, opts?: TrackingHelperOptions): void;
-    attach(): void;
-}

package/dist/types/types.d.ts

@@ -1,5 +0,0 @@
-export type OpeningHoursEntryType = {
-    day: string;
-    hours: string;
-};
-export type OpeningHoursType = OpeningHoursEntryType[];

package/dist/types/utils/StoryContainer.d.ts

@@ -1 +0,0 @@
-export declare const StoryContainer: (props: Record<string, unknown>) => import("react/jsx-runtime").JSX.Element;

package/dist/types/utils/TrackingHelper.d.ts

@@ -1,15 +0,0 @@
-export interface TrackingHandler {
-    event: string;
-    action: () => void;
-    onInit?: () => boolean;
-    trigger?: Element | Window;
-}
-export interface TrackingHelperOptions {
-    onInit?: () => boolean;
-    trigger?: Element | Window;
-}
-export declare class TrackingHelper {
-    private handlers;
-    register(event: string, action: () => void, opts?: TrackingHelperOptions): void;
-    attach(): void;
-}

package/dist/types/utils/TrustpilotProvider.d.ts

@@ -1,4 +0,0 @@
-import { ReactNode } from "react";
-export declare const TrustpilotProvider: ({ children }: {
-    children: ReactNode;
-}) => import("react/jsx-runtime").JSX.Element;

package/dist/types/utils/env.d.ts

@@ -1,5 +0,0 @@
-export declare const getEnvironment: () => string;
-export declare const isTestEnv: () => boolean;
-export declare const hasRailsEnv: () => boolean;
-export declare const isHosted: (host?: string) => boolean;
-export declare const urlIncludes: (text: string, mockOrigin?: string) => boolean;

package/dist/types/utils/env.test.d.ts

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

package/dist/types/utils/excludeControls.d.ts

@@ -1 +0,0 @@
-export declare const excludeControls: (...args: string[]) => {};

package/dist/types/utils/excludeControls.test.d.ts

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

package/dist/types/utils/isObject.test.d.ts

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

package/dist/types/utils/spaceDelimitedList.d.ts

@@ -1 +0,0 @@
-export declare function spaceDelimitedList(list: (string | null | undefined)[]): string | undefined;

package/dist/types/utils/spaceDelimitedList.test.d.ts

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

package/dist/types/utils/text.test.d.ts

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

package/dist/types/vitest.config.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("vite").UserConfig;
-export default _default;