@windstream/react-shared-components 0.1.37 → 0.1.40

package/dist/contentful/index.d.ts

@@ -1,9 +1,12 @@
-import React$1, { ReactNode, FC } from 'react';
+import * as React$1 from 'react';
+import React__default, { ReactNode, FC } from 'react';
 import { ResponsiveSize } from '@shared/components/brand-button/types';
 import { Fill, Size } from '@shared/components/material-icon/types';
 import { CheckPlansProps, Asset, Button as Button$1, ButtonGroup } from '@shared/types/micro-components';
 import { ButtonProps as ButtonProps$1 } from '@shared/contentful/blocks/button/types';
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import { Document } from '@contentful/rich-text-types';
+import { Options } from '@contentful/rich-text-react-renderer';
 
 type AccordionProps = {
     title: string;
@@ -11,12 +14,12 @@ type AccordionProps = {
     background?: "blue" | "green" | "navy" | "purple" | "white" | "yellow";
     items: {
         title: string;
-        description: React$1.ReactNode;
+        description: React__default.ReactNode;
     }[];
     maxWidth?: boolean;
 };
 
-declare const Accordion: React$1.FC<AccordionProps>;
+declare const Accordion: React__default.FC<AccordionProps>;
 
 type CalloutProps = {
     title?: string;
@@ -34,7 +37,7 @@ type CalloutProps = {
     cardType?: "simple" | "blog";
 };
 
-declare const Callout: React$1.FC<CalloutProps>;
+declare const Callout: React__default.FC<CalloutProps>;
 
 type CardsProps = {};
 
@@ -58,14 +61,14 @@ type ButtonProps = {
     clickToOpen?: string;
     tabmodalNameToOpen?: string;
     preDefinedFunctionExecution?: string;
-    renderCheckPlans?: (overrides?: CheckPlansProps) => React$1.ReactNode;
+    renderCheckPlans?: (overrides?: CheckPlansProps) => React__default.ReactNode;
     linkClassName?: string;
     buttonClassName?: string;
     linkVariant?: "unstyled" | "default";
     fullWidth?: boolean;
     size?: ResponsiveSize;
-    onClick?: (event: React$1.MouseEvent<HTMLAnchorElement | HTMLButtonElement>) => void;
-    children?: React$1.ReactNode;
+    onClick?: (event: React__default.MouseEvent<HTMLAnchorElement | HTMLButtonElement>) => void;
+    children?: React__default.ReactNode;
     modalTitle?: string;
     modalSubtitle?: string;
     onModalButtonClick?: (id?: string) => void;
@@ -90,7 +93,7 @@ type SimpleCardProps = {
     mdWidth?: string;
 };
 
-declare const SimpleCard: React$1.FC<SimpleCardProps>;
+declare const SimpleCard: React__default.FC<SimpleCardProps>;
 
 interface carouselFieldsInterface {
     __typename: "ComponentCarousel";
@@ -201,37 +204,37 @@ type CarouselProps = {
     showSwitch?: boolean;
     testimonialAutoScroll?: boolean;
     onModalButtonClick?: (id?: string) => void;
-    renderCheckPlans?: (overrides?: CheckPlansProps) => React$1.ReactNode;
+    renderCheckPlans?: (overrides?: CheckPlansProps) => React__default.ReactNode;
 };
 
-declare const Carousel: React$1.FC<CarouselProps>;
+declare const Carousel: React__default.FC<CarouselProps>;
 
 type FloatingBannerProps = {
     title?: string;
     enableHeading?: boolean;
     subtitle?: string;
     icon?: string;
-    description?: React$1.ReactNode;
+    description?: React__default.ReactNode;
     cta?: any | null;
-    disclaimer?: React$1.ReactNode;
+    disclaimer?: React__default.ReactNode;
     background?: "green" | "navy" | "white" | "purple" | "blue" | "yellow";
     color?: "dark" | "light";
     maxWidth?: boolean;
 };
 
-declare const FloatingBanner: React$1.FC<FloatingBannerProps>;
+declare const FloatingBanner: React__default.FC<FloatingBannerProps>;
 
 type FooterProps = {
-    body: React$1.ReactNode;
+    body: React__default.ReactNode;
     links?: Array<any>;
     bottomLinks?: Array<any>;
-    copyrights?: React$1.ReactNode;
+    copyrights?: React__default.ReactNode;
     terms?: string;
     maxWidth?: boolean;
-    onClick?: (event: React$1.MouseEvent<HTMLAnchorElement | HTMLButtonElement>) => void;
+    onClick?: (event: React__default.MouseEvent<HTMLAnchorElement | HTMLButtonElement>) => void;
 };
 
-declare const Footer: React$1.FC<FooterProps>;
+declare const Footer: React__default.FC<FooterProps>;
 
 type VideoLinkProps = {
     image?: string;
@@ -247,25 +250,25 @@ type ImagePromoBarProps = {
     imageWidth: number;
     imageHeight: number;
     mediaPosition: boolean;
-    description: React$1.ReactNode;
+    description: React__default.ReactNode;
     openDescriptionLinksOnANewTab: boolean;
     checklist: string[];
-    disclaimer: React$1.ReactNode;
+    disclaimer: React__default.ReactNode;
     imageLinks: {
         url: string;
         image: string;
     }[];
     cta: any;
     secondaryCta: any;
-    ctaDisclaimer: React$1.ReactNode;
+    ctaDisclaimer: React__default.ReactNode;
     videoLink: VideoLinkProps;
     maxWidth?: boolean;
     color: "light" | "dark";
     onModalButtonClick?: (id?: string) => void;
-    renderCheckPlans?: (overrides?: CheckPlansProps) => React$1.ReactNode;
+    renderCheckPlans?: (overrides?: CheckPlansProps) => React__default.ReactNode;
 };
 
-declare const ImagePromoBar: React$1.FC<ImagePromoBarProps>;
+declare const ImagePromoBar: React__default.FC<ImagePromoBarProps>;
 
 type Color = string;
 interface Navigation$1 {
@@ -291,12 +294,12 @@ interface Navigation$1 {
     showCallNowCtaInMainNav?: boolean;
     invocaPhoneNumberLink?: string;
     invocaPhoneNumberDisplayText?: string;
-    checkPlansJSX?: React$1.ReactNode;
+    checkPlansJSX?: React__default.ReactNode;
     onSearch?: (query: string) => void;
 }
 type NavigationProps = Navigation$1;
 
-declare const Navigation: React$1.FC<NavigationProps>;
+declare const Navigation: React__default.FC<NavigationProps>;
 
 type PrimaryHeroProps = {
     title: string;
@@ -326,11 +329,11 @@ type PrimaryHeroProps = {
     badgeImage?: string;
     textColor?: string;
     maxWidth?: boolean;
-    renderCheckPlans?: (overrides?: CheckPlansProps) => React$1.ReactNode;
+    renderCheckPlans?: (overrides?: CheckPlansProps) => React__default.ReactNode;
     onModalButtonClick?: (id?: string) => void;
 };
 
-declare const PrimaryHero: React$1.FC<PrimaryHeroProps>;
+declare const PrimaryHero: React__default.FC<PrimaryHeroProps>;
 
 type TextProps = {};
 
@@ -338,16 +341,16 @@ declare const Text: React.FC<{
     fields: TextProps;
 }>;
 
-declare const Button: React$1.FC<ButtonProps>;
+declare const Button: React__default.FC<ButtonProps>;
 
 type ModalProps = {
     isOpen: boolean;
     onRequestClose?: () => void;
     size?: "lg" | "md" | "sm" | "xl" | "xs";
     title?: string;
-    description?: React$1.ReactNode;
-    content?: React$1.ReactNode;
-    children?: React$1.ReactNode;
+    description?: React__default.ReactNode;
+    content?: React__default.ReactNode;
+    children?: React__default.ReactNode;
     bodyClassName?: string;
 };
 
@@ -355,7 +358,7 @@ type ExtendedModalProps = ModalProps & {
     type?: string;
     index?: number;
 };
-declare const Modal: React$1.FC<ExtendedModalProps>;
+declare const Modal: React__default.FC<ExtendedModalProps>;
 
 declare const svgPaths: Record<string, string>;
 type ThemeKey = "blue" | "green" | "yellow" | "purple" | "white" | "navy";
@@ -364,13 +367,13 @@ type ShapeBackgroundWrapperProps = {
     path?: SvgPathKey;
     fill?: ThemeKey | string;
     className?: string;
-    children?: React$1.ReactNode;
+    children?: React__default.ReactNode;
     maxFit?: boolean;
     background?: ThemeKey | string;
     show?: boolean;
 };
 
-declare const ShapeBackgroundWrapper: React$1.FC<ShapeBackgroundWrapperProps>;
+declare const ShapeBackgroundWrapper: React__default.FC<ShapeBackgroundWrapperProps>;
 
 type CtaCalloutProps = {
     title?: string;
@@ -378,16 +381,16 @@ type CtaCalloutProps = {
     enableHeading?: boolean;
     color?: "dark" | "light";
     background?: "blue" | "green" | "navy" | "purple" | "white" | "yellow";
-    description?: React$1.ReactNode;
+    description?: React__default.ReactNode;
     descriptionAlignment?: "center" | "left" | "right";
     contentAlignment?: "center" | "left" | "right";
     button?: any;
     maxWidth?: boolean;
     onModalButtonClick?: (id?: string) => void;
-    renderCheckPlans?: (overrides?: CheckPlansProps) => React$1.ReactNode;
+    renderCheckPlans?: (overrides?: CheckPlansProps) => React__default.ReactNode;
 };
 
-declare const CtaCallout: React$1.FC<CtaCalloutProps>;
+declare const CtaCallout: React__default.FC<CtaCalloutProps>;
 
 type FindKineticProps = {
     title?: string;
@@ -404,7 +407,7 @@ type FindKineticProps = {
     color?: "dark" | "light";
 };
 
-declare const FindKinetic: React$1.FC<FindKineticProps>;
+declare const FindKinetic: React__default.FC<FindKineticProps>;
 
 type ComparisonTableProps = {
     title?: string;
@@ -413,7 +416,7 @@ type ComparisonTableProps = {
     maxWidth?: boolean;
 };
 
-declare const ComparisonTable: React$1.FC<ComparisonTableProps>;
+declare const ComparisonTable: React__default.FC<ComparisonTableProps>;
 
 interface TestimonialCardProps {
     title?: string;
@@ -426,7 +429,7 @@ interface TestimonialCardProps {
     className?: string;
 }
 
-declare const TestimonialCard: React$1.FC<TestimonialCardProps>;
+declare const TestimonialCard: React__default.FC<TestimonialCardProps>;
 
 interface ProductCardProps {
     planName: string;
@@ -455,10 +458,10 @@ interface ProductCardProps {
     cta?: ButtonProps$1;
     onCtaClick: () => void;
     hostType: "residential" | "smb";
-    renderCheckPlans?: (overrides?: CheckPlansProps) => React$1.ReactNode;
+    renderCheckPlans?: (overrides?: CheckPlansProps) => React__default.ReactNode;
 }
 
-declare const ProductCard: React$1.FC<ProductCardProps>;
+declare const ProductCard: React__default.FC<ProductCardProps>;
 
 interface BlogCardProps$1 {
     href: string;
@@ -479,7 +482,7 @@ interface BlogCardProps$1 {
     index?: number;
 }
 
-declare const BlogCard: React$1.FC<BlogCardProps$1>;
+declare const BlogCard: React__default.FC<BlogCardProps$1>;
 
 interface BlogCardProps {
     slug: string;
@@ -515,7 +518,7 @@ type BreadcrumbNavigationProps = {
     maxWidth?: boolean;
 };
 
-declare const BreadcrumbNavigation: React$1.FC<BreadcrumbNavigationProps>;
+declare const BreadcrumbNavigation: React__default.FC<BreadcrumbNavigationProps>;
 
 type SearchBlockProps = {
     anchorId?: string;
@@ -523,8 +526,8 @@ type SearchBlockProps = {
     subTitle?: string;
     searchDescription?: string;
     searchInputPlaceholder?: string;
-    caption?: React$1.ReactNode;
-    basicCaption?: React$1.ReactNode;
+    caption?: React__default.ReactNode;
+    basicCaption?: React__default.ReactNode;
     enableHeading?: boolean;
     backgroundColor: "supporting" | "white" | "brand";
     color: "light" | "dark";
@@ -533,7 +536,7 @@ type SearchBlockProps = {
     }) => void;
 };
 
-declare const SearchBlock: React$1.FC<SearchBlockProps>;
+declare const SearchBlock: React__default.FC<SearchBlockProps>;
 
 interface AddressInputBannerProps {
     entryName?: string;
@@ -542,7 +545,7 @@ interface AddressInputBannerProps {
     cta?: ButtonProps$1;
     navHeight?: number;
     isVisible?: boolean;
-    renderCheckPlans?: (overrides?: CheckPlansProps) => React$1.ReactNode;
+    renderCheckPlans?: (overrides?: CheckPlansProps) => React__default.ReactNode;
 }
 
 declare const AddressInputBanner: FC<AddressInputBannerProps>;
@@ -557,7 +560,7 @@ interface DynamicTabsT {
             };
         }[];
     };
-    tabsContent?: React$1.ReactNode[];
+    tabsContent?: React__default.ReactNode[];
     entryTitle?: string;
     anchorId?: string;
     title?: string;
@@ -582,7 +585,7 @@ interface AnchoredBottomBannerProps {
     anchorId?: string;
 }
 
-declare const AnchoredBottomBanner: React$1.FC<AnchoredBottomBannerProps>;
+declare const AnchoredBottomBanner: React__default.FC<AnchoredBottomBannerProps>;
 
 interface TypeComponentRichTextFields {
     entryName?: string;
@@ -596,5 +599,29 @@ declare function CookieBanner({ content, }: {
     content: TypeComponentRichTextFields;
 }): react_jsx_runtime.JSX.Element | null;
 
-export { Accordion, AddressInputBanner, AnchoredBottomBanner, BlogCard, BlogGrid, BreadcrumbNavigation, Button, Callout, Cards, Carousel, ComparisonTable, CookieBanner, CtaCallout, DynamicTabs, FindKinetic, FloatingBanner, Footer, ImagePromoBar, Modal, Navigation, PrimaryHero, ProductCard, SearchBlock, ShapeBackgroundWrapper, SimpleCard, TestimonialCard, Text };
-export type { AccordionProps, AddressInputBannerProps, AnchoredBottomBannerProps, BlogCardProps$1 as BlogCardProps, BlogGridProps, BreadcrumbNavigationProps, ButtonProps, CalloutProps, CardsProps, CarouselProps, ComparisonTableProps, TypeComponentRichTextFields as CookieBannerProps, CtaCalloutProps, DynamicTabsT, FindKineticProps, FloatingBannerProps, FooterProps, ImagePromoBarProps, ModalProps, NavigationProps, PrimaryHeroProps, ProductCardProps, SearchBlockProps, ShapeBackgroundWrapperProps, SimpleCardProps, TestimonialCardProps, TextProps };
+declare const toDocument: (v: unknown | null | undefined) => Document | null;
+
+/**
+ * Utility function to render Contentful Rich Text.
+ * Safe to use inside .map() loops.
+ */
+declare function renderContentfulRichText(doc: Document | null | undefined, target?: boolean, className?: string, linkClassName?: string, options?: Options): ReactNode | null;
+declare function useContentfulRichText(doc: Document | null | undefined, options?: Options): ReactNode | null;
+declare function renderContentfulRichTextTable(doc: Document | null | undefined, links?: any): ReactNode;
+
+declare const label1BoldOptions: {
+    renderMark: {
+        bold: (text: ReactNode) => React$1.DetailedReactHTMLElement<{
+            className: string;
+        }, HTMLElement>;
+    };
+};
+interface ProcessedChecklistItem {
+    title: string;
+    iconUrl?: string;
+    anchorId?: string;
+}
+declare function useProcessedChecklist<T extends boolean = false>(checklistData?: any, titlesOnly?: T, richTextOptions?: Options, richTextClassName?: string): T extends true ? string[] : ProcessedChecklistItem[];
+
+export { Accordion, AddressInputBanner, AnchoredBottomBanner, BlogCard, BlogGrid, BreadcrumbNavigation, Button, Callout, Cards, Carousel, ComparisonTable, CookieBanner, CtaCallout, DynamicTabs, FindKinetic, FloatingBanner, Footer, ImagePromoBar, Modal, Navigation, PrimaryHero, ProductCard, SearchBlock, ShapeBackgroundWrapper, SimpleCard, TestimonialCard, Text, label1BoldOptions, renderContentfulRichText, renderContentfulRichTextTable, toDocument, useContentfulRichText, useProcessedChecklist };
+export type { AccordionProps, AddressInputBannerProps, AnchoredBottomBannerProps, BlogCardProps$1 as BlogCardProps, BlogGridProps, BreadcrumbNavigationProps, ButtonProps, CalloutProps, CardsProps, CarouselProps, ComparisonTableProps, TypeComponentRichTextFields as CookieBannerProps, CtaCalloutProps, DynamicTabsT, FindKineticProps, FloatingBannerProps, FooterProps, ImagePromoBarProps, ModalProps, NavigationProps, PrimaryHeroProps, ProcessedChecklistItem, ProductCardProps, SearchBlockProps, ShapeBackgroundWrapperProps, SimpleCardProps, TestimonialCardProps, TextProps };