@windstream/react-shared-components 0.2.55 → 0.2.56

package/dist/contentful/index.d.ts

@@ -927,6 +927,204 @@ type IframeEmbedProps = {
  */
 declare const IframeEmbed: React__default.FC<IframeEmbedProps>;
 
+/**
+ * The set of submit actions the DynamicForm understands. Each maps to an
+ * injected async handler provided by the consuming application. The package
+ * owns the UI, validation, payload building and orchestration; the app owns
+ * the actual transport (HTTP calls, redirects, etc.).
+ */
+type FormAction = "email" | "sftp" | "sms" | "voice" | "post";
+type DynamicFormFieldType = "Text" | "Checkbox" | "Radio" | "Dropdown" | "Datepicker" | "Imageupload";
+interface DynamicFormFieldOption {
+    label: string;
+    value: string;
+    /** When true, selecting this option should trigger the success popup. */
+    popup?: boolean;
+    [key: string]: any;
+}
+/**
+ * A single, Contentful-agnostic form field descriptor. The consuming app is
+ * responsible for transforming its CMS entries into this plain shape.
+ */
+interface DynamicFormFieldConfig {
+    fieldId: string;
+    fieldType: DynamicFormFieldType;
+    displayName?: string;
+    requiredField?: boolean;
+    textInputType?: "phone" | "email" | "multiline" | string;
+    errorMessage?: string;
+    dataSource?: DynamicFormFieldOption[] | null;
+    existingDataSource?: string;
+    note?: string;
+    noteClassName?: string;
+    fieldClassName?: string;
+    /** true => full width, false => half width, undefined => full width. */
+    fieldWidth?: boolean;
+    validationGroupId?: string;
+    validationType?: string;
+    validationNote?: string;
+    formSection?: string;
+    sftpFieldId?: string;
+    applyRegularExpression?: boolean;
+    regexPattern?: string;
+    applyPresetValidations?: boolean;
+    selectPresetValidationsToApply?: string;
+}
+interface ConditionalFieldConfig {
+    fieldId: string;
+    displayName?: string;
+    requiredField?: boolean;
+    dataSource?: DynamicFormFieldOption[] | null;
+    note?: string;
+    formFieldsToShow: DynamicFormItem[];
+}
+/**
+ * A flat list item rendered by the form. Either a form field, a conditional
+ * field group, or an arbitrary pre-rendered node (e.g. a nested CMS block that
+ * the app rendered itself and passes through).
+ */
+type DynamicFormItem = ({
+    itemType: "formField";
+} & DynamicFormFieldConfig) | ({
+    itemType: "conditional";
+} & ConditionalFieldConfig) | {
+    itemType: "custom";
+    fieldId?: string;
+    content: React__default.ReactNode;
+};
+interface DynamicFormPayload {
+    submissionId: string;
+    formName?: string;
+    subject?: string;
+    emailTemplate?: string;
+    submittedOn: string;
+    formSubmitOptions: FormAction[];
+    /** Grouped form data, keyed by form section. */
+    formData: Record<string, any>;
+    files: File[];
+    toEmail?: string;
+    toPhone?: string;
+    toSms?: string;
+    [key: string]: any;
+}
+interface SubmitContext {
+    /** The structured payload (as built by the form, before transport encoding). */
+    payload: DynamicFormPayload;
+    /** The raw flat form values keyed by fieldId. */
+    formValues: Record<string, any>;
+    /** Map of fieldId -> sftpFieldId for SMTP/SFTP payload mapping. */
+    sftpMap: Record<string, string>;
+    formSubmitOptions: FormAction[];
+    files: File[];
+    /** The action currently being executed. */
+    action: FormAction;
+    /** Transport hints (e.g. for FormData uploads). */
+    options: Record<string, any>;
+}
+/**
+ * Injected transport for a single action. `body` is the ready-to-send payload
+ * (a plain object with a stringified `formData`, or a `FormData` instance when
+ * files are present). Handlers that need to build their own body (e.g. SMTP)
+ * can use `context.formValues` and `context.sftpMap` instead.
+ */
+type SubmitHandler = (body: DynamicFormPayload | FormData, context: SubmitContext) => Promise<any> | any;
+interface FieldRenderProps {
+    loading?: boolean;
+    displayName?: string;
+    requiredField?: boolean;
+    formData: Record<string, any>;
+    fieldId?: string;
+    textInputType?: string;
+    handleInputChange: (event: any) => void;
+    dataSource?: DynamicFormFieldOption[] | null;
+    error: {
+        fieldId?: string;
+        errorMessage: string;
+    };
+    errorClass: string;
+    hasError: boolean;
+    existingDataSource?: string;
+    isConsentCheckbox?: boolean;
+    [key: string]: any;
+}
+/**
+ * Resolves the options for a field that references an app-owned data source
+ * (e.g. "State List" / "City List"). Injected by the app so the package stays
+ * transport-agnostic.
+ */
+type ExistingDataSourceResolver = (name: string, ctx: {
+    selectedState?: any;
+}) => Promise<DynamicFormFieldOption[]>;
+interface DynamicFormProps {
+    anchorId?: string;
+    title?: string;
+    subTitle?: string;
+    formHeading?: string;
+    /** Pre-rendered rich text supplied by the app. */
+    description?: React__default.ReactNode;
+    disclaimer?: React__default.ReactNode;
+    successMessage?: React__default.ReactNode;
+    errorMessage?: React__default.ReactNode;
+    formClassName?: string;
+    fields: DynamicFormItem[];
+    formSubmitOptions?: FormAction[];
+    /** CTA */
+    submitLabel?: string;
+    ctaClassName?: string;
+    /** Copy overrides */
+    validationErrorText?: string;
+    /** Payload metadata */
+    formName?: string;
+    emailSubject?: string;
+    emailTemplateName?: string;
+    toEmail?: string;
+    segmentEventId?: string;
+    /** Injected per-action async submit handlers. */
+    onEmailSubmit?: SubmitHandler;
+    onSmtpSubmit?: SubmitHandler;
+    onSmsSubmit?: SubmitHandler;
+    /** Optional additional handlers for extra actions (voice/post/custom). */
+    actionHandlers?: Partial<Record<FormAction, SubmitHandler>>;
+    /**
+     * Allows the app to mutate the base payload before actions run
+     * (e.g. custom email routing, non-prod rerouting, adding toPhone/toSms).
+     */
+    buildPayload?: (basePayload: DynamicFormPayload, formValues: Record<string, any>) => DynamicFormPayload;
+    /** Called after a successful (or partial) submission. */
+    onSubmitSuccess?: (formValues: Record<string, any>, meta: {
+        shouldShowPopup: boolean;
+    }) => void;
+    /** Injected analytics + logging. */
+    onTrack?: (eventId: string | undefined, payload: any) => void;
+    onError?: (info: {
+        type: string;
+        error: unknown;
+        metadata?: Record<string, any>;
+    }) => void;
+    /** Whether the current environment is production (affects nothing in the
+     * base component today but reserved for parity with app behavior). */
+    isProduction?: boolean;
+    /** Field customization + async data. */
+    fieldComponentOverrides?: Partial<Record<DynamicFormFieldType, React__default.FC<FieldRenderProps>>>;
+    resolveExistingDataSource?: ExistingDataSourceResolver;
+}
+
+declare const DynamicForm: React__default.FC<DynamicFormProps>;
+
+declare const constants: {
+    IP_PHONE_NUMBER: string;
+    TARGET_EMAIL: string;
+    REQUIRED_FIELDS_MISSING: string;
+    PROVIDE_AT_LEAST_ONE: string;
+    ONE_REQUIRED_FIELD: string;
+};
+declare const Regex: {
+    phone: RegExp;
+    ipv4: RegExp;
+    ipv6: RegExp;
+    email: RegExp;
+};
+
 declare const toDocument: (v: unknown | null | undefined) => Document | null;
 
 /**
@@ -954,5 +1152,5 @@ interface ProcessedChecklistItem {
 }
 declare function useProcessedChecklist<T extends boolean = false>(checklistData?: any, titlesOnly?: T, richTextOptions?: Options, richTextClassName?: string): T extends true ? string[] : ProcessedChecklistItem[];
 
-export { Accordion, AddressInputBanner, AnchoredBottomBanner, AwardMarquee, BlogCard, BlogGrid, BlogGridBase, BreadcrumbNavigation, Button, Callout, Cards, Carousel, CartRetentionBanner, ComparisonTable, CookieBanner, CtaCallout, DynamicTabs, EmailInputBlock, FindKinetic, FloatingBanner, Footer, IframeEmbed, ImagePromoBar, Modal, Navigation, OrderedList, PrimaryHero, ProductCard, SearchBlock, ShapeBackgroundWrapper, SimpleCard, TestimonialCard, Text, label1BoldOptions, renderContentfulRichText, renderContentfulRichTextTable, toDocument, useContentfulRichText, useProcessedChecklist };
-export type { AccordionProps, AddressInputBannerProps, AnchoredBottomBannerProps, AwardMarqueeBackground, AwardMarqueeItem, AwardMarqueeProps, AwardMarqueeSpeed, BlogCardProps$2 as BlogCardProps, BlogGridBaseProps, BlogGridProps, BreadcrumbNavigationProps, ButtonProps, CalloutProps, CardsProps, CarouselProps, TypeCartRetentionBannerFields as CartRetentionBannerProps, ComparisonTableProps, TypeComponentRichTextFields as CookieBannerProps, CtaCalloutProps, DynamicTabsT, EmailInputBlockProps, FindKineticProps, FloatingBannerProps, FooterProps, IframeEmbedProps, ImagePromoBarProps, ModalProps, NavigationProps, OrderedListProps, PrimaryHeroProps, ProcessedChecklistItem, ProductCardProps, SearchBlockProps, ShapeBackgroundWrapperProps, SimpleCardProps, TestimonialCardProps, TextProps };
+export { Accordion, AddressInputBanner, AnchoredBottomBanner, AwardMarquee, BlogCard, BlogGrid, BlogGridBase, BreadcrumbNavigation, Button, Callout, Cards, Carousel, CartRetentionBanner, ComparisonTable, CookieBanner, CtaCallout, DynamicForm, DynamicTabs, EmailInputBlock, FindKinetic, FloatingBanner, Footer, IframeEmbed, ImagePromoBar, Modal, Navigation, OrderedList, PrimaryHero, ProductCard, SearchBlock, ShapeBackgroundWrapper, SimpleCard, TestimonialCard, Text, constants as dynamicFormConstants, Regex as dynamicFormRegex, label1BoldOptions, renderContentfulRichText, renderContentfulRichTextTable, toDocument, useContentfulRichText, useProcessedChecklist };
+export type { AccordionProps, AddressInputBannerProps, AnchoredBottomBannerProps, AwardMarqueeBackground, AwardMarqueeItem, AwardMarqueeProps, AwardMarqueeSpeed, BlogCardProps$2 as BlogCardProps, BlogGridBaseProps, BlogGridProps, BreadcrumbNavigationProps, ButtonProps, CalloutProps, CardsProps, CarouselProps, TypeCartRetentionBannerFields as CartRetentionBannerProps, ComparisonTableProps, ConditionalFieldConfig, TypeComponentRichTextFields as CookieBannerProps, CtaCalloutProps, DynamicFormFieldConfig, DynamicFormFieldOption, DynamicFormFieldType, DynamicFormItem, DynamicFormPayload, DynamicFormProps, DynamicTabsT, EmailInputBlockProps, ExistingDataSourceResolver, FieldRenderProps, FindKineticProps, FloatingBannerProps, FooterProps, FormAction, IframeEmbedProps, ImagePromoBarProps, ModalProps, NavigationProps, OrderedListProps, PrimaryHeroProps, ProcessedChecklistItem, ProductCardProps, SearchBlockProps, ShapeBackgroundWrapperProps, SimpleCardProps, SubmitContext, SubmitHandler, TestimonialCardProps, TextProps };