@newskit-render/my-account 0.0.0-014af081

package/dist/cjs/context/types.d.ts

@@ -0,0 +1,678 @@
+import { ReactNode } from 'react';
+import { NavigationSecondaryInterface, NavigationSecondarySelected, NavigationSecondaryOverrides } from '../Components/Sections/NavigationSecondary';
+import { ContentContainerProps } from '../Components/Sections/ContentContainer';
+import { As, ListItemType, ListCellProps, ListItemProps, RequestHeaders, PastDueBannerType, TitleOverrides, DescriptionOverrides, FooterContext, FooterContextOverrides, HeaderProps, InputText, NavigationPrimaryProps, ButtonGroupProps, ModalProps, TealiumEventContext } from '@newskit-render/shared-components';
+import { MQ, InlineMessageProps, NewsKitIcon, InstrumentationEvent, EventContext } from 'newskit';
+import { HeadProps } from '../Components/Elements/Head';
+import { UserData, Data } from '../pages/types';
+import { PaymentProvider, ZuoraCustomErrorMessages, ZuoraPaymentPageData } from '../Components/Sections/Form/Payment';
+import { MessageMap, GenericMessageMap } from '../Components/Elements/Toast';
+import { CommentingNotificationsProps } from '../Components/Sections/Form/CommentingNotifications';
+import { CancellationReasonProps } from '../Components/Sections/Form/CancellationReason';
+import { ConfirmCancellationProps } from '../Components/Sections/Form/ConfirmCancellation';
+import { SubscriptionStatusProps } from '../Components/Sections/NoSubscription';
+import { DeliveryInstructionsProps } from '../Components/Sections/Form/DeliveryInstructions';
+import { HolidayStopProps } from '../Components/Sections/Form/HolidayStop';
+import { VouchersProps } from '../Components/Sections/Form/Vouchers';
+import { ButtonProps } from '@newskit-render/shared-components';
+import { CardContentContainerProps } from 'Components/Sections/CardContentContainer';
+import { FamilyMemberProps } from '../Components/Sections/Form/InviteFamilyMember/types';
+import { PaymentMethodsMap } from 'Components/Templates';
+import { TileProps } from '../Components/Elements/Tile';
+interface InfoPanel extends InlineMessageProps {
+    infoPanelCells?: MQ<number>;
+    href?: boolean;
+    useInlineMessageComponent?: boolean;
+}
+interface FormProps {
+    text?: string[];
+    textOverriders?: {
+        stylePreset?: MQ<string>;
+        typographyPreset?: MQ<string>;
+        marginBlockEnd?: MQ<string>;
+    };
+    buttonGroupProps?: Partial<ButtonGroupProps>;
+    inputText?: Omit<InputText, 'labelProps.text' | 'assistiveTextProps.text'>;
+    labelObject?: {
+        [key: string]: string;
+    };
+    listItems?: ListItemType[];
+    infoPanel?: InfoPanel;
+}
+interface FormContext {
+    header?: HeaderProps;
+    props?: FormProps;
+    tealiumContext?: TealiumEventContext;
+    textInputsTealiumTracking?: {
+        fieldName: string;
+        trackingContext: InstrumentationEvent;
+    };
+}
+interface PasswordContext {
+    header?: HeaderProps;
+    props?: FormProps & {
+        resendButtonGroupProps?: Partial<ButtonGroupProps>;
+    };
+    tealiumContext?: TealiumEventContext;
+}
+interface AddressFormContext {
+    header?: HeaderProps;
+    props?: FormProps & {
+        fullAddressInput?: InputText;
+        line1Input?: InputText;
+        line2Input?: InputText;
+        line3Input?: InputText;
+        cityInput?: InputText;
+        countyInput?: InputText;
+        postcodeInput?: InputText;
+        countryInput?: InputText & {
+            panelProps?: {
+                maxHeight?: string;
+                zIndex?: string;
+            };
+        } & {
+            optionsProps?: {
+                defaultValue?: string;
+            };
+        };
+        marginBlockEnd?: MQ<string>;
+    };
+    tealiumContext?: TealiumEventContext;
+}
+interface VoucherFormContext {
+    header?: HeadProps;
+    props?: VouchersProps;
+    tealiumContext?: TealiumEventContext;
+}
+interface CancellationContext {
+    header?: HeaderProps;
+    props?: CancellationReasonProps | ConfirmCancellationProps;
+    tealiumContext?: TealiumEventContext;
+}
+interface CommentingNotificationsContext {
+    header?: HeaderProps;
+    props?: CommentingNotificationsProps;
+    tealiumContext?: TealiumEventContext;
+}
+interface DeliveryInstructionsContext {
+    header?: HeaderProps;
+    props?: DeliveryInstructionsProps;
+    tealiumContext?: TealiumEventContext;
+}
+interface HolidayStopContext {
+    header?: HeaderProps;
+    props?: HolidayStopProps;
+    tealiumContext?: TealiumEventContext;
+}
+interface FamilyMemberContext {
+    header?: HeaderProps;
+    props?: FormProps & FamilyMemberProps;
+    tealiumContext?: TealiumEventContext;
+}
+export interface InfoBannerProps {
+    bannerName: string;
+    title?: string;
+    text?: string;
+    disableClose?: boolean;
+}
+export interface Notice {
+    title: string;
+    text: string;
+    dismissDays?: number;
+    phoneNumber?: string;
+    button?: string;
+}
+export interface ContextProviderProps {
+    children: ReactNode;
+    context: ContextOptions;
+    contextName: ContextName;
+}
+export declare enum ContextName {
+    'personalDetails' = "personalDetails",
+    'subscriptionAndBilling' = "subscriptionAndBilling",
+    'holidayStop' = "holidayStop",
+    'newslettersAndAlerts' = "newslettersAndAlerts",
+    'payment' = "payment",
+    'editField' = "editField",
+    'addField' = "addField",
+    'cancellation' = "cancellation",
+    'error' = "error",
+    'paymentMethods' = "paymentMethods",
+    'direct-debit' = "paymentDirectDebit",
+    'credit-card' = "paymentCreditCard",
+    'dreamTeam' = "dreamTeam",
+    'newsletters' = "newsletters",
+    'accountDeletion' = "accountDeletion",
+    'confirmAccountDeletion' = "confirmAccountDeletion",
+    'family' = "family",
+    'userHubPage' = "userHubPage"
+}
+export interface BaseContextOptions {
+    navigationPrimary: NavigationPrimaryProps;
+    pastDueBanner?: PastDueBannerType;
+    baseUrl: string;
+    head: HeadProps;
+    header: HeaderProps;
+    env?: Record<string, unknown>;
+    footer?: FooterContext;
+    requestHeaders?: RequestHeaders;
+    featureFlags?: Record<string, any>;
+    infoBanner?: InfoBannerProps;
+}
+interface BaseContextOptionsWithUserData extends BaseContextOptions {
+    userData: UserData;
+    env: Record<string, unknown>;
+    errorMessages?: MessageMap;
+    genericErrorMessage?: GenericMessageMap;
+    handleError: (type: string, messageMap?: MessageMap, genericMessageMap?: GenericMessageMap, message?: string, autoHideDuration?: number) => void;
+    handleWarning: (type: string, messageMap?: MessageMap, genericMessageMap?: GenericMessageMap, message?: string) => void;
+    handleLoading: (type: string, messageMap?: MessageMap, genericMessageMap?: GenericMessageMap, message?: string, autoHideDuration?: number) => void;
+    handleSuccess: () => void;
+}
+interface LayoutMainContentOverrides {
+    fullWidth?: boolean;
+    width?: MQ<string>;
+    paddingInline?: MQ<string>;
+    paddingBlockStart?: MQ<string>;
+}
+interface InteractiveContextOptions extends BaseContextOptionsWithUserData {
+    validation: Record<string, any>;
+    env: Record<string, unknown>;
+    buttonGroupProps: Partial<ButtonGroupProps>;
+}
+interface NonInteractiveContextOptions extends BaseContextOptionsWithUserData {
+    sideNav: NavigationSecondaryInterface[];
+    sideNavSelected: NavigationSecondarySelected;
+    sideNavOverrides?: NavigationSecondaryOverrides;
+    footerOverrides?: FooterContextOverrides;
+    layoutMainContentOverrides?: LayoutMainContentOverrides;
+}
+export interface EditFieldContextOptions extends InteractiveContextOptions {
+    data: Data;
+    forms: {
+        default?: FormContext;
+        password?: PasswordContext;
+        name?: FormContext;
+        displayName?: FormContext;
+        email?: FormContext;
+        landline?: FormContext;
+        mobile?: FormContext;
+        payment?: FormContext;
+        address?: AddressFormContext;
+        'commenting-notifications'?: CommentingNotificationsContext;
+        'delivery-instructions'?: DeliveryInstructionsContext;
+        'holiday-stop'?: HolidayStopContext;
+        vouchers?: VoucherFormContext;
+    };
+    outsideDeliveryAddressModal?: Omit<ModalProps, 'onDismiss'> & {
+        redirectUrl?: string;
+    };
+    isFooterVisible?: boolean;
+}
+export interface AddFieldContextOption extends InteractiveContextOptions {
+    data: Data;
+    forms: {
+        [x: string]: any;
+        default?: FormContext;
+        'holiday-stop'?: HolidayStopContext;
+        family?: FamilyMemberContext;
+    };
+    isFooterVisible?: boolean;
+}
+export interface CancellationContextOptions extends InteractiveContextOptions {
+    cancellation: {
+        reason: Partial<CancellationContext>;
+        confirm: Partial<CancellationContext>;
+    };
+}
+export interface AccountLandingPageSection {
+    type: SectionTypes;
+    billingType?: SectionBillingType;
+    componentType: string;
+    props?: ContentContainerProps | CardContentContainerProps;
+}
+export declare enum SectionTypes {
+    'Digital' = "digital",
+    'Print' = "print"
+}
+export declare enum SectionBillingType {
+    'AllBilling' = "all_billing",
+    'Billing' = "billing",
+    'NoBilling' = "no_billing"
+}
+export declare enum SubscriptionType {
+    digital = "digital",
+    print = "print",
+    digi_print = "digi-print"
+}
+export interface AccountLandingPageContextOptions extends NonInteractiveContextOptions {
+    fontFamilies: Array<{
+        family: string;
+    }>;
+    sections: AccountLandingPageSection[];
+    sectionsOverrides?: {
+        list: {
+            titleOverrides?: TitleOverrides;
+            descriptionOverrides?: DescriptionOverrides;
+        };
+    };
+    tealiumContext?: TealiumEventContext;
+    updateAccountData: (data: any) => void;
+}
+export interface PaymentPageContextOptions extends BaseContextOptionsWithUserData {
+    buttonGroupProps: Partial<ButtonGroupProps>;
+    zuoraCustomErrorMessages: ZuoraCustomErrorMessages;
+    paymentPageData: ZuoraPaymentPageData;
+    paymentProvider: PaymentProvider;
+    paymentType?: string;
+    infoPanel: InfoPanel;
+    cancelButton?: ButtonProps;
+    tealiumContext?: TealiumEventContext;
+    paymentMethodsMap?: PaymentMethodsMap;
+}
+export interface ContentPassContext {
+    contentPassPanelOverrides?: {
+        stylePreset?: string;
+        paddingBlock?: MQ<string>;
+        paddingInline?: MQ<string>;
+    };
+    headlineOverrides?: {
+        text: string;
+        typographyPreset?: string;
+    };
+    textOverrides?: {
+        text: string;
+        paddingBlock?: MQ<string>;
+    };
+    linkOverrides?: {
+        text: string;
+        href: string;
+        stylePreset?: string;
+    };
+    tealiumClickContext: TealiumEventContext;
+    tealiumComponentTrackingContext: TealiumEventContext;
+}
+export interface SubscriptionAndBillingContextOptions extends AccountLandingPageContextOptions {
+    noSubscription: SubscriptionStatusProps;
+    previousSubscription: SubscriptionStatusProps;
+    pendingSubscription: SubscriptionStatusProps;
+    freeSubscription: SubscriptionStatusProps | null;
+    tealiumContext?: TealiumEventContext;
+    contentPass?: ContentPassContext;
+}
+export interface HolidayStopButton extends ButtonProps {
+    label: string;
+    marginBlockEnd: MQ<string>;
+    marginBlockStart: MQ<string>;
+    overrides: {
+        stylePreset: string;
+        width: MQ<string>;
+    };
+}
+export interface HolidayStopSubscriptionType {
+    textList: string[];
+    moreInfo: {
+        text: string;
+        textList: string[];
+    };
+}
+export interface HolidayStopsConfirmationModalButtonsProps extends ButtonProps {
+    text: string;
+    ariaLabel: string;
+    overrides: {
+        stylePreset: string;
+        typographyPreset: MQ<string>;
+    };
+    paddingInline?: MQ<string>;
+    paddingBlock?: MQ<string>;
+}
+export interface HolidayStopContextOptions extends NonInteractiveContextOptions {
+    addHolidayStopButton: HolidayStopButton;
+    subscriptionTypes: {
+        print: HolidayStopSubscriptionType;
+        'digi-print': HolidayStopSubscriptionType;
+    };
+    textOverrides: {
+        typographyPreset: MQ<string>;
+        stylePreset: string;
+        marginBlockEnd: MQ<string>;
+    };
+    unorderedListOverrides: {
+        content: {
+            stylePreset: string;
+            typographyPreset: MQ<string>;
+        };
+        marginBlockEnd: MQ<string>;
+    };
+    expandButtonOverrides?: {
+        stylePreset: MQ<string>;
+        paddingInline?: MQ<string>;
+        paddingBlock?: MQ<string>;
+        minHeight: MQ<string>;
+        minWidth: MQ<string>;
+        width: MQ<string>;
+    };
+    expandButton: {
+        expand: string;
+        collapse: string;
+    };
+    inProgressStatusOverrides: {
+        stylePreset?: MQ<string>;
+        typographyPreset?: MQ<string>;
+    };
+    cancellation: {
+        genericErrorMessage: {
+            error: string;
+            success: string;
+        };
+        errorMessages: {
+            deleteUserHolidayStop: {
+                success: string;
+                error: string;
+                pending: string;
+            };
+        };
+        baseUrl: string;
+        confirmationModal: {
+            href: string;
+            overrides: {
+                panel: {
+                    width: MQ<string>;
+                    maxHeight: string;
+                };
+                content: {
+                    paddingInline?: MQ<string>;
+                    paddingBlock?: MQ<string>;
+                };
+            };
+            paddingInline?: MQ<string>;
+            paddingBlock?: MQ<string>;
+            introduction: {
+                title: string;
+                titleOverrides: {
+                    as: As;
+                    typographyPreset?: MQ<string>;
+                    stylePreset: string;
+                    marginBlockEnd: MQ<string>;
+                };
+                description: string;
+                descriptionOverrides: {
+                    typographyPreset?: MQ<string>;
+                    stylePreset: string;
+                    marginBlockEnd: MQ<string>;
+                };
+            };
+            buttonGroup: {
+                primaryButton: HolidayStopsConfirmationModalButtonsProps;
+                secondaryButton: HolidayStopsConfirmationModalButtonsProps;
+                paddingInline?: MQ<string>;
+                paddingBlock?: MQ<string>;
+            };
+        };
+    };
+    tealiumContext?: TealiumEventContext;
+}
+type NewsKitSize = 'small' | 'medium' | 'large';
+export interface NewslettersContextOptions extends NonInteractiveContextOptions {
+    cardOverrides: {
+        stylePreset: string;
+        maxWidth?: MQ<string>;
+        minWidth?: MQ<string>;
+        maxHeight?: MQ<string>;
+        minHeight?: MQ<string>;
+        paddingInline?: MQ<string>;
+        paddingBlock?: MQ<string>;
+    };
+    cardContentOverrides: {
+        rowGap?: MQ<string>;
+        rows?: MQ<string>;
+        overrides?: {
+            paddingInline?: MQ<string>;
+            paddingBlock?: MQ<string>;
+        };
+    };
+    headlineOverrides: {
+        content: {
+            typographyPreset: MQ<string>;
+            heading?: {
+                stylePreset?: MQ<string>;
+            };
+            paddingInlineEnd?: MQ<string>;
+        };
+        marginBlockEnd?: MQ<string>;
+    };
+    frequencyOverrides: {
+        stylePreset: MQ<string>;
+        typographyPreset: MQ<string>;
+    };
+    textOverrides: {
+        stylePreset: MQ<string>;
+        typographyPreset: MQ<string>;
+        marginBlockEnd?: MQ<string>;
+    };
+    gridLayoutOverrides: {
+        columns: MQ<string>;
+        columnGap: MQ<string>;
+        autoFlow: MQ<string>;
+        rowGap: MQ<string>;
+    };
+    newsletterImages: {
+        [key: string]: string;
+    };
+    featuredNewsletterIds?: string[];
+    newsletterOrderIds?: string[];
+    switchButtonProps: {
+        label: string;
+        size: NewsKitSize;
+        overrides: {
+            onIcon?: NewsKitIcon;
+            offIcon?: NewsKitIcon;
+            input?: {
+                stylePreset: string;
+            };
+        };
+    };
+    tealiumContext?: TealiumEventContext;
+    handleShowSuccess: (type: string, messageMap?: MessageMap, genericMessageMap?: GenericMessageMap, message?: string, autoHideDuration?: number) => void;
+}
+interface MemberFlag {
+    overrides: {
+        stylePreset: MQ<string>;
+        paddingInline: MQ<string>;
+        iconSize?: MQ<string>;
+        typographyPreset: MQ<string>;
+    };
+    size: NewsKitSize;
+    text: string;
+}
+interface removeFamilyConfirmationModal {
+    introduction: {
+        title: string;
+        descriptionFirstParagraph: string;
+        descriptionSecondParagraph: string;
+    };
+    buttonGroup: ButtonGroupProps;
+}
+export interface FamilyContextOptions extends NonInteractiveContextOptions {
+    headlineOverrides: {
+        content: {
+            typographyPreset: MQ<string>;
+            heading?: {
+                stylePreset?: MQ<string>;
+            };
+            paddingInlineEnd?: MQ<string>;
+        };
+        marginBlockEnd?: MQ<string>;
+    };
+    tealiumContext?: TealiumEventContext;
+    mainGridLayoutOverrides: {
+        rowGap: MQ<string>;
+    };
+    accountDataGridLayoutOverrides: {
+        rowGap: MQ<string>;
+    };
+    allocatedMembersFlag: MemberFlag;
+    activeMembersFlag: MemberFlag;
+    invitedMembersFlag: MemberFlag;
+    allocatedMembersDefaultCount: number;
+    removeMemberMessageOverrides: {
+        stylePreset: MQ<string>;
+        typographyPreset: MQ<string>;
+        text: string;
+    };
+    addMemberButtonOverrides: {
+        size: NewsKitSize;
+        overrides: {
+            stylePreset: MQ<string>;
+        };
+        href: string;
+        text: string;
+        eventContext: EventContext;
+    };
+    memberGridLayoutOverrides: {
+        columns: MQ<string>;
+        rowGap: MQ<string>;
+        justifyContent: MQ<string>;
+    };
+    memberGridLayoutItemOverrides: {
+        alignSelf: MQ<string>;
+        justifySelf: MQ<string>;
+    };
+    removeMemberButtonOverrides: {
+        size: NewsKitSize;
+        overrides: {
+            stylePreset: MQ<string>;
+            typographyPreset: MQ<string>;
+            paddingInline: MQ<string>;
+            paddingBlock: MQ<string>;
+        };
+        removeText: string;
+        cancelText: string;
+        eventNavigationNameCancel: string;
+        eventNavigationNameRemove: string;
+        eventContext: EventContext;
+    };
+    memberNameOverrides: {
+        stylePreset: MQ<string>;
+        typographyPreset: MQ<string>;
+        marginBlockEnd: MQ<string>;
+    };
+    memberEmailOverrides: {
+        stylePreset: MQ<string>;
+        typographyPreset: MQ<string>;
+        marginBlockEnd: MQ<string>;
+    };
+    memberStatusOverrides: {
+        typographyPreset: MQ<string>;
+        stylePresetActive: MQ<string>;
+        stylePresetPending: MQ<string>;
+    };
+    termsAndConditionsLinkOverrides?: {
+        overrides: {
+            typographyPreset: MQ<string>;
+            marginBlock: MQ<string>;
+        };
+        href: string;
+        text: string;
+    };
+    confirmationModalOverrides: {
+        overrides: {
+            panel: {
+                width: MQ<string>;
+            };
+            content: {
+                paddingInline: MQ<string>;
+                paddingBlock: MQ<string>;
+            };
+        };
+        paddingInline?: MQ<string>;
+        paddingBlock?: MQ<string>;
+        introduction: {
+            titleOverrides: {
+                stylePreset: string;
+                marginBlockEnd: MQ<string>;
+            };
+            descriptionOverrides: {
+                typographyPreset: MQ<string>;
+                stylePreset: string;
+                marginBlockEnd: MQ<string>;
+                removeLastMarginBlockEnd: boolean;
+            };
+        };
+        buttonGroup: {
+            primaryButton: {
+                overrides: {
+                    stylePreset: MQ<string>;
+                    typographyPreset: MQ<string>;
+                };
+                paddingInline: MQ<string>;
+                paddingBlock: MQ<string>;
+            };
+            secondaryButton: {
+                overrides: {
+                    stylePreset: MQ<string>;
+                    typographyPreset: MQ<string>;
+                };
+                paddingInline: MQ<string>;
+                paddingBlock: MQ<string>;
+            };
+            paddingInline: MQ<string>;
+        };
+    };
+    cancelInviteConfirmationModalOverrides: removeFamilyConfirmationModal;
+    removeMemberConfirmationModalOverrides: removeFamilyConfirmationModal;
+}
+type LandingPageTile = TileProps;
+export interface UserHubContextOptions extends NonInteractiveContextOptions {
+    headlineOverrides: {
+        content: {
+            typographyPreset: MQ<string>;
+            heading?: {
+                stylePreset?: MQ<string>;
+            };
+            paddingInlineEnd?: MQ<string>;
+        };
+        marginBlockEnd?: MQ<string>;
+    };
+    tealiumContext?: TealiumEventContext;
+    tiles: LandingPageTile[];
+}
+export declare enum FamilyMemberStatusTypes {
+    'PENDING' = "PENDING",
+    'ACTIVE' = "ACTIVE"
+}
+export interface PaymentMethodsContextOptions extends NonInteractiveContextOptions {
+    items: Array<ListItemType>;
+    infoPanel: InfoPanel;
+    listCellProps?: ListCellProps;
+    listItemProps?: ListItemProps;
+    tealiumContext?: TealiumEventContext;
+}
+export interface AccountDeletionContextOptions extends BaseContextOptionsWithUserData {
+    content?: ReactNode;
+    buttons?: {
+        primary?: ButtonProps;
+        secondary?: ButtonProps;
+    };
+    success?: {
+        title?: string;
+        content?: ReactNode;
+        button?: ButtonProps;
+    };
+    error?: {
+        title?: string;
+        description?: string;
+        infoMessage?: string;
+        button?: ButtonProps;
+    };
+}
+export interface ConfirmAccountDeletionContextOptions extends AccountDeletionContextOptions {
+    supportMail?: string;
+    onSuccess?: () => void;
+    onError?: () => void;
+}
+export type ContextNameProps = {
+    contextName: ContextName;
+};
+export type ContextOptions = HolidayStopContextOptions | PaymentPageContextOptions | AccountLandingPageContextOptions | CancellationContextOptions | EditFieldContextOptions | SubscriptionAndBillingContextOptions | BaseContextOptions | AddFieldContextOption | AccountDeletionContextOptions | ConfirmAccountDeletionContextOptions;
+export {};