@yext/pages-components 1.1.7 → 1.1.9

package/dist/index.d.cts

@@ -144,7 +144,7 @@ interface TemplateProps<T = Record<string, any>> {
 
 type TrackProps = {
     action: Action;
-    destinationUrl: string;
+    destinationUrl?: string;
     scope?: string;
     eventName: string;
     amount?: number;
@@ -1557,6 +1557,41 @@ declare const LegacyRichText: (props: {
     markdown: string;
 }) => ReactElement<any, string | React$1.JSXElementConstructor<any>> | null;
 
+declare class HoursInterval {
+    end: DateTime;
+    start: DateTime;
+    /**
+     * @param date - DateTime the DateTime for the day on which the interval starts
+     * @param interval - the Yext Streams interval data
+     */
+    constructor(date: DateTime, interval: IntervalType, zone: string);
+    /**
+     * @param date - A moment in time
+     * @returns boolean - True if the given moment is within the interval
+     */
+    contains(date: DateTime): boolean;
+    /**
+     * @param opts - intl.DateTimeFormatOptions
+     * @param locale - defaults to 'en-US'
+     * @returns string - representation of this interval's start time
+     */
+    getStartTime(locale?: string, opts?: Intl.DateTimeFormatOptions): string;
+    /**
+     * @param opts - intl.DateTimeFormatOptions
+     * @param locale - defaults to 'en-US'
+     * @returns string representation of this interval's end time
+     */
+    getEndTime(locale?: string, opts?: Intl.DateTimeFormatOptions): string;
+    /**
+     * @returns boolean if this interval and 'other' have the same start/end
+     */
+    timeIsEqualTo(other: HoursInterval): boolean;
+    /**
+     * @returns boolean if this interval is 24 hours
+     */
+    is24h(): boolean;
+}
+
 interface WeekType {
     monday?: DayType;
     tuesday?: DayType;
@@ -1567,8 +1602,8 @@ interface WeekType {
     sunday?: DayType;
 }
 interface DayType {
-    isClosed: boolean;
-    openIntervals: IntervalType[];
+    isClosed?: boolean;
+    openIntervals?: IntervalType[];
 }
 interface HolidayType extends DayType {
     date: string;
@@ -1597,8 +1632,20 @@ interface HoursTableProps {
     collapseDays?: boolean;
     /** Override rendering for the interval on each table row */
     intervalStringsBuilderFn?: (h: HoursTableDayData, t?: Intl.DateTimeFormatOptions) => string[];
+    /** Override values for hardcoded strings */
+    intervalTranslations?: HoursTableIntervalTranslations;
     className?: string;
 }
+interface HoursTableIntervalTranslations {
+    /** Displayed when an interval is marked as closed */
+    isClosed?: string;
+    /** Displayed when an interval is marked as open 24 hours */
+    open24Hours?: string;
+    /** Displayed when there is a reopen date set */
+    reopenDate?: string;
+    /** Sets the locale for time interval formatting */
+    timeFormatLocale?: string;
+}
 interface HoursTableDayData {
     dayName: string;
     intervals: HoursInterval[];
@@ -1615,64 +1662,46 @@ declare enum Day {
     Saturday = "SATURDAY",
     Sunday = "SUNDAY"
 }
-
-declare class HoursInterval {
-    end: DateTime;
-    start: DateTime;
-    /**
-     * @param date - DateTime the DateTime for the day on which the interval starts
-     * @param interval - the Yext Streams interval data
-     */
-    constructor(date: DateTime, interval: IntervalType, zone: string);
-    /**
-     * @param date - A moment in time
-     * @returns boolean - True if the given moment is within the interval
-     */
-    contains(date: DateTime): boolean;
-    /**
-     * @param opts - intl.DateTimeFormatOptions
-     * @param locale - defaults to 'en-US'
-     * @returns string - representation of this interval's start time
-     */
-    getStartTime(locale?: string, opts?: Intl.DateTimeFormatOptions): string;
-    /**
-     * @param opts - intl.DateTimeFormatOptions
-     * @param locale - defaults to 'en-US'
-     * @returns string representation of this interval's end time
-     */
-    getEndTime(locale?: string, opts?: Intl.DateTimeFormatOptions): string;
-    /**
-     * @returns boolean if this interval and 'other' have the same start/end
-     */
-    timeIsEqualTo(other: HoursInterval): boolean;
-    /**
-     * @returns boolean if this interval is 24 hours
-     */
-    is24h(): boolean;
-}
-
 interface StatusParams {
+    /** Whether the entity is currently open */
     isOpen: boolean;
+    /** The first interval that contains the current time */
     currentInterval: HoursInterval | null;
+    /** The next interval that hasn't started */
     futureInterval: HoursInterval | null;
+    /** Formatting intended for the "time" part of this component "Open Now - closes at [[5:00PM]] Monday" */
     timeOptions?: Intl.DateTimeFormatOptions;
+    /** Formatting intended for the "day" part of this component "Open Now - closes at 5:00PM [[Monday]]" */
     dayOptions?: Intl.DateTimeFormatOptions;
 }
 interface TemplateParams {
-    currentTemplate?: (s: StatusParams) => React__default.ReactNode;
-    separatorTemplate?: (s: StatusParams) => React__default.ReactNode;
-    futureTemplate?: (s: StatusParams) => React__default.ReactNode;
-    timeTemplate?: (s: StatusParams) => React__default.ReactNode;
-    dayOfWeekTemplate?: (s: StatusParams) => React__default.ReactNode;
+    /** Override rendering for the "current" part of this component "[[Open Now]] - closes at 5:00PM Monday" */
+    currentTemplate?: (s: StatusParams) => React.ReactNode;
+    /** Override rendering for the "separator" part of this component "Open Now [[-]] closes at 5:00PM Monday" */
+    separatorTemplate?: (s: StatusParams) => React.ReactNode;
+    /** FutureTemplate override rendering for the "future" part of this component "Open Now - [[closes at]] 5:00PM Monday" */
+    futureTemplate?: (s: StatusParams) => React.ReactNode;
+    /** Override rendering for the "time" part of this component "Open Now - closes at [[5:00PM]] Monday" */
+    timeTemplate?: (s: StatusParams) => React.ReactNode;
+    /** Override rendering for the "dayOfWeek" part of this component "Open Now - closes at 5:00PM [[Monday]]" */
+    dayOfWeekTemplate?: (s: StatusParams) => React.ReactNode;
+}
+interface StatusTemplateParams extends StatusParams, TemplateParams {
 }
 interface HoursStatusProps extends TemplateParams {
+    /** Hours data from Yext Streams */
     hours: HoursType;
+    /** The IANA or UTC Offset timezone of the hours data from Yext Streams */
     timezone: string;
+    /** Formatting for the "time" part of this component "Open Now - closes at [[5:00PM]] Monday" */
     timeOptions?: Intl.DateTimeFormatOptions;
+    /** Formatting for the "day" part of this component "Open Now - closes at 5:00PM [[Monday]]" */
     dayOptions?: Intl.DateTimeFormatOptions;
-    statusTemplate?: (s: StatusParams) => React__default.ReactNode;
+    /** Completely override rendering for this component */
+    statusTemplate?: (s: StatusParams) => React.ReactNode;
     className?: string;
 }
+
 declare const HoursStatus: React__default.FC<HoursStatusProps>;
 
 declare const HoursTable: React__default.FC<HoursTableProps>;
@@ -1682,82 +1711,10 @@ declare const SchemaWrapper: (json: any) => string;
 declare const BaseSchema: (document: Record<string, any>, schemaType: string) => {
     "@context": string;
     "@type": string;
-    name: any;
-};
+    name: string;
+} | undefined;
 
-declare const Event: (document: Record<string, any>, schemaType?: string) => {
-    offers?: {
-        "@type": string;
-        url: string | undefined;
-        priceCurrency: string | undefined;
-        price: string | undefined;
-        priceValidUntil: string | undefined;
-        itemCondition: string | undefined;
-        availability: string | undefined;
-    } | undefined;
-    organizer?: {
-        "@type": string;
-        name: string | undefined;
-        url: string | undefined;
-    } | undefined;
-    performer?: {
-        "@type": string;
-        name: string;
-    } | undefined;
-    startDate: any;
-    endDate: any;
-    description: any;
-    eventAttendanceMode: any;
-    eventStatus: any;
-    address?: {
-        "@type": string;
-        streetAddress: string;
-        addressLocality: string;
-        addressRegion: string | undefined;
-        postalCode: string;
-        addressCountry: string;
-    } | undefined;
-    "@type": string;
-    name: any;
-    image?: undefined;
-    "@context": string;
-} | {
-    offers?: {
-        "@type": string;
-        url: string | undefined;
-        priceCurrency: string | undefined;
-        price: string | undefined;
-        priceValidUntil: string | undefined;
-        itemCondition: string | undefined;
-        availability: string | undefined;
-    } | undefined;
-    organizer?: {
-        "@type": string;
-        name: string | undefined;
-        url: string | undefined;
-    } | undefined;
-    performer?: {
-        "@type": string;
-        name: string;
-    } | undefined;
-    startDate: any;
-    endDate: any;
-    description: any;
-    eventAttendanceMode: any;
-    eventStatus: any;
-    address?: {
-        "@type": string;
-        streetAddress: string;
-        addressLocality: string;
-        addressRegion: string | undefined;
-        postalCode: string;
-        addressCountry: string;
-    } | undefined;
-    "@type": string;
-    name: any;
-    image: string[];
-    "@context": string;
-};
+declare const Event: (document: Record<string, any>, schemaType?: string) => any;
 
 declare const LocalBusiness: (document: Record<string, any>, schemaType?: string) => {
     description: any;
@@ -1773,9 +1730,9 @@ declare const LocalBusiness: (document: Record<string, any>, schemaType?: string
         postalCode: string;
         addressCountry: string;
     } | undefined;
-    "@context": string;
-    "@type": string;
-    name: any;
+    "@context"?: string | undefined;
+    "@type"?: string | undefined;
+    name?: string | undefined;
 } | {
     description: any;
     telephone: any;
@@ -1790,9 +1747,9 @@ declare const LocalBusiness: (document: Record<string, any>, schemaType?: string
         postalCode: string;
         addressCountry: string;
     } | undefined;
-    "@context": string;
-    "@type": string;
-    name: any;
+    "@context"?: string | undefined;
+    "@type"?: string | undefined;
+    name?: string | undefined;
 } | {
     description: any;
     telephone: any;
@@ -1807,9 +1764,9 @@ declare const LocalBusiness: (document: Record<string, any>, schemaType?: string
         postalCode: string;
         addressCountry: string;
     } | undefined;
-    "@context": string;
-    "@type": string;
-    name: any;
+    "@context"?: string | undefined;
+    "@type"?: string | undefined;
+    name?: string | undefined;
 } | {
     description: any;
     telephone: any;
@@ -1824,88 +1781,12 @@ declare const LocalBusiness: (document: Record<string, any>, schemaType?: string
         postalCode: string;
         addressCountry: string;
     } | undefined;
-    "@context": string;
-    "@type": string;
-    name: any;
+    "@context"?: string | undefined;
+    "@type"?: string | undefined;
+    name?: string | undefined;
 };
 
-declare const Product: (document: Record<string, any>, schemaType?: string) => {
-    description: any;
-    sku: any;
-    mpn: any;
-    brand: {
-        "@type": string;
-        name: any;
-    };
-    offers?: {
-        "@type": string;
-        url: string | undefined;
-        priceCurrency: string | undefined;
-        price: string | undefined;
-        priceValidUntil: string | undefined;
-        itemCondition: string | undefined;
-        availability: string | undefined;
-    } | undefined;
-    aggregateRating?: {
-        "@type": string;
-        ratingValue: string | undefined;
-        reviewCount: string | undefined;
-    } | undefined;
-    review?: {
-        "@type": string;
-        reviewRating: {
-            "@type": string;
-            ratingValue: string | undefined;
-            bestRating: string | undefined;
-        };
-        author: {
-            "@type": string;
-            name: string | undefined;
-        };
-    } | undefined;
-    image?: undefined;
-    "@context": string;
-    "@type": string;
-    name: any;
-} | {
-    description: any;
-    sku: any;
-    mpn: any;
-    brand: {
-        "@type": string;
-        name: any;
-    };
-    offers?: {
-        "@type": string;
-        url: string | undefined;
-        priceCurrency: string | undefined;
-        price: string | undefined;
-        priceValidUntil: string | undefined;
-        itemCondition: string | undefined;
-        availability: string | undefined;
-    } | undefined;
-    aggregateRating?: {
-        "@type": string;
-        ratingValue: string | undefined;
-        reviewCount: string | undefined;
-    } | undefined;
-    review?: {
-        "@type": string;
-        reviewRating: {
-            "@type": string;
-            ratingValue: string | undefined;
-            bestRating: string | undefined;
-        };
-        author: {
-            "@type": string;
-            name: string | undefined;
-        };
-    } | undefined;
-    image: string[];
-    "@context": string;
-    "@type": string;
-    name: any;
-};
+declare const Product: (document: Record<string, any>, schemaType?: string) => any;
 
 type RTF2 = {
     json?: Record<string, any>;
@@ -1919,6 +1800,7 @@ type RichTextFAQ = {
     question: string;
     answerV2: RTF2;
 };
+declare function getRichTextContent(answer: RTF2): string;
 declare const FAQPage: (data: FAQ[]) => {
     "@context": string;
     "@type": string;
@@ -1930,7 +1812,7 @@ declare const FAQPage: (data: FAQ[]) => {
             text: string;
         };
     } | undefined)[];
-};
+} | undefined;
 
 type Location = {
     name?: string;
@@ -1971,8 +1853,9 @@ type Offer = {
     price?: string;
     priceValidUntil?: string;
     itemCondition?: string;
-    availability?: string;
+    availability?: (typeof availabilityOptions)[number];
 };
+declare const availabilityOptions: string[];
 declare const OfferSchema: (offer?: Offer) => false | {
     offers: {
         "@type": string;
@@ -1997,9 +1880,9 @@ declare const PerformerSchema: (performers?: string[]) => false | {
 };
 declare const OrganizationSchema: (org?: Organization) => false | {
     organizer: {
+        url?: string | undefined;
         "@type": string;
         name: string | undefined;
-        url: string | undefined;
     };
 };
 
@@ -2027,16 +1910,16 @@ type AggregateRating = {
 };
 declare const ReviewSchema: (review?: Review) => false | {
     review: {
+        author?: {
+            "@type": string;
+            name: string;
+        } | undefined;
         "@type": string;
         reviewRating: {
             "@type": string;
             ratingValue: string | undefined;
             bestRating: string | undefined;
         };
-        author: {
-            "@type": string;
-            name: string | undefined;
-        };
     };
 };
 declare const AggregateRatingSchema: (rating?: AggregateRating) => {
@@ -2059,4 +1942,4 @@ declare const LeafletMaps: MapProvider;
 
 declare const MapQuestMaps: MapProvider;
 
-export { Address, type AddressLine, type AddressLineProps, type AddressProps, AddressSchema, type AddressType, type AggregateRating, AggregateRatingSchema, Analytics, AnalyticsContext, AnalyticsProvider, AnalyticsScopeProvider, BaiduMaps, BaseSchema, BingMaps, type CTA, type CTAWithChildrenLinkProps, type CTAWithoutChildrenLinkProps, type ClusterTemplateProps, Clusterer, type ClustererContextType, type ClustererProps, type ComplexImageType, type Coordinate, Coordinate$1 as CoordinateClass, Day, type DayOfWeekNames, type DayType, type DirectionCoordinate, Event, FAQPage, type GetDirectionsConfig, GoogleMaps, type HREFLinkProps, type HolidayType, HoursStatus, HoursTable, type HoursTableDayData, type HoursTableProps, type HoursType, Image, type ImageLayout, ImageLayoutOption, type ImageProps, type ImageType, type IntervalType, LeafletMaps, LegacyRichText, LexicalRichText, type LexicalRichTextProps, Link, type LinkProps, type LinkType, type ListingPublisher, ListingPublisherOption, type ListingType, LocalBusiness, type Location, LocationMap, type LocationMapProps, LocationSchema, Map, type MapContextType, type MapProps, type MapProvider$1 as MapProvider, MapProviderOption, MapQuestMaps, MapboxMaps, Marker, type MarkerProps, type Offer, OfferSchema, OpeningHoursSchema, type Organization, OrganizationSchema, PerformerSchema, type PhotoGallery, PhotoGallerySchema, PhotoSchema, type PinStoreType, Product, type Review, ReviewSchema, SchemaWrapper, type ThumbnailType, type WeekType, debuggingParamDetected, getDirections, useAnalytics, useClusterContext, useIdentify, useMapContext, usePageView, useScope, useTrack };
+export { Address, type AddressLine, type AddressLineProps, type AddressProps, AddressSchema, type AddressType, type AggregateRating, AggregateRatingSchema, Analytics, AnalyticsContext, AnalyticsProvider, AnalyticsScopeProvider, BaiduMaps, BaseSchema, BingMaps, type CTA, type CTAWithChildrenLinkProps, type CTAWithoutChildrenLinkProps, type ClusterTemplateProps, Clusterer, type ClustererContextType, type ClustererProps, type ComplexImageType, type Coordinate, Coordinate$1 as CoordinateClass, Day, type DayOfWeekNames, type DayType, type DirectionCoordinate, Event, FAQPage, type GetDirectionsConfig, GoogleMaps, type HREFLinkProps, type HolidayType, HoursStatus, type HoursStatusProps, HoursTable, type HoursTableDayData, type HoursTableIntervalTranslations, type HoursTableProps, type HoursType, Image, type ImageLayout, ImageLayoutOption, type ImageProps, type ImageType, type IntervalType, LeafletMaps, LegacyRichText, LexicalRichText, type LexicalRichTextProps, Link, type LinkProps, type LinkType, type ListingPublisher, ListingPublisherOption, type ListingType, LocalBusiness, type Location, LocationMap, type LocationMapProps, LocationSchema, Map, type MapContextType, type MapProps, type MapProvider$1 as MapProvider, MapProviderOption, MapQuestMaps, MapboxMaps, Marker, type MarkerProps, type Offer, OfferSchema, OpeningHoursSchema, type Organization, OrganizationSchema, PerformerSchema, type PhotoGallery, PhotoGallerySchema, PhotoSchema, type PinStoreType, Product, type Review, ReviewSchema, SchemaWrapper, type StatusParams, type StatusTemplateParams, type TemplateParams, type ThumbnailType, type WeekType, debuggingParamDetected, getDirections, getRichTextContent, useAnalytics, useClusterContext, useIdentify, useMapContext, usePageView, useScope, useTrack };