@yext/pages-components 1.0.1 → 1.0.3

package/dist/index.d.ts

@@ -90,6 +90,15 @@ interface GetDirectionsConfig {
     provider?: MapProvider$1;
     route?: boolean;
 }
+/**
+ * Type definition for coordinate
+ *
+ * @public
+ */
+interface DirectionCoordinate {
+    latitude: number;
+    longitude: number;
+}
 
 /**
  * Renders an HTML address based from the Yext Knowledge Graph. Example of using the component to render
@@ -116,10 +125,11 @@ declare const Address: ({ address, lines, separator, ...props }: AddressProps) =
  * @param listings - List of available Yext Listings
  * @param googlePlaceId - Google Place ID
  * @param config - Options for determining URL
+ * @param coordinates - Coordinates of location, if provided will be used instead of address or listings
  *
  * @returns Maps service url
  */
-declare const getDirections: (address?: AddressType, listings?: ListingType[], googlePlaceId?: string, config?: GetDirectionsConfig) => string | undefined;
+declare const getDirections: (address?: AddressType, listings?: ListingType[], googlePlaceId?: string, config?: GetDirectionsConfig, coordinate?: DirectionCoordinate) => string | undefined;
 
 /**
  * The shape of the data passed directly to the different template functions with the
@@ -139,6 +149,8 @@ type TrackProps = {
     eventName?: string;
     amount?: number;
     currency?: string;
+    customTags?: Record<string, string>;
+    customValues?: Record<string, number>;
 };
 /**
  * The AnalyticsMethod interface specifies the methods that can be used with
@@ -209,7 +221,8 @@ interface AnalyticsProviderProps {
     disableSessionTracking?: boolean | undefined;
     /**
      * enableDebugging can be set to true if you want to expose tracked events
-     * in the developer console.
+     * in the Browser's developer console. When true, events will only be logged
+     * and will NOT be fired/sent through the Analytics SDK.
      */
     enableDebugging?: boolean | undefined;
 }
@@ -535,6 +548,16 @@ interface LinkConfig extends React.DetailedHTMLProps<React.AnchorHTMLAttributes<
     currency?: string;
     /** The monetary value of the event. */
     amount?: number;
+    /**
+     * Up to 10 pairs matching custom string keys to string values to associate with the event.
+     * Keys are case-insensitive; values are case-sensitive.
+     */
+    customTags?: Record<string, string>;
+    /**
+     * Up to 10 pairs matching custom string keys to number values to associate with the event.
+     * Keys are case-insensitive.
+     */
+    customValues?: Record<string, number>;
 }
 /**
  * The shape of the data passed to {@link Link} when directly passing an HREF to the Link component.
@@ -1277,6 +1300,374 @@ declare const HoursStatus: React__default.FC<HoursStatusProps>;
 
 declare const HoursTable: React__default.FC<HoursTableProps>;
 
+declare const SchemaWrapper: (json: any) => string;
+
+declare const BaseSchema: (document: Record<string, any>, schemaType: string) => {
+    "@context": string;
+    "@type": string;
+    name: any;
+};
+
+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 LocalBusiness: (document: Record<string, any>, schemaType?: string) => {
+    description: any;
+    telephone: any;
+    email: any;
+    image?: undefined;
+    openingHours?: undefined;
+    address?: {
+        "@type": string;
+        streetAddress: string;
+        addressLocality: string;
+        addressRegion: string | undefined;
+        postalCode: string;
+        addressCountry: string;
+    } | undefined;
+    "@context": string;
+    "@type": string;
+    name: any;
+} | {
+    description: any;
+    telephone: any;
+    email: any;
+    image: string[];
+    openingHours?: undefined;
+    address?: {
+        "@type": string;
+        streetAddress: string;
+        addressLocality: string;
+        addressRegion: string | undefined;
+        postalCode: string;
+        addressCountry: string;
+    } | undefined;
+    "@context": string;
+    "@type": string;
+    name: any;
+} | {
+    description: any;
+    telephone: any;
+    email: any;
+    image?: undefined;
+    openingHours: string[];
+    address?: {
+        "@type": string;
+        streetAddress: string;
+        addressLocality: string;
+        addressRegion: string | undefined;
+        postalCode: string;
+        addressCountry: string;
+    } | undefined;
+    "@context": string;
+    "@type": string;
+    name: any;
+} | {
+    description: any;
+    telephone: any;
+    email: any;
+    image: string[];
+    openingHours: string[];
+    address?: {
+        "@type": string;
+        streetAddress: string;
+        addressLocality: string;
+        addressRegion: string | undefined;
+        postalCode: string;
+        addressCountry: string;
+    } | undefined;
+    "@context": string;
+    "@type": string;
+    name: any;
+};
+
+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;
+};
+
+type RTF2 = {
+    json?: Record<string, any>;
+};
+type FAQ = {
+    question: string;
+    answer: string;
+} | {
+    question: string;
+    answerV2: RTF2;
+};
+declare const FAQPage: (data: FAQ[]) => {
+    "@context": string;
+    "@type": string;
+    mainEntity: {
+        "@type": string;
+        name: string;
+        acceptedAnswer: {
+            "@type": string;
+            text: string;
+        };
+    }[];
+};
+
+type Location = {
+    name?: string;
+    address?: AddressType;
+};
+declare const AddressSchema: (address?: AddressType) => {
+    address: {
+        "@type": string;
+        streetAddress: string;
+        addressLocality: string;
+        addressRegion: string | undefined;
+        postalCode: string;
+        addressCountry: string;
+    };
+} | undefined;
+declare const LocationSchema: (location?: Location) => {
+    address?: {
+        "@type": string;
+        streetAddress: string;
+        addressLocality: string;
+        addressRegion: string | undefined;
+        postalCode: string;
+        addressCountry: string;
+    } | undefined;
+    "@type": string;
+    name: string | undefined;
+} | undefined;
+
+declare const OpeningHoursSchema: (hours?: HoursType) => {
+    openingHours?: undefined;
+} | {
+    openingHours: string[];
+};
+
+type Offer = {
+    url?: string;
+    priceCurrency?: string;
+    price?: string;
+    priceValidUntil?: string;
+    itemCondition?: string;
+    availability?: string;
+};
+declare const OfferSchema: (offer?: Offer) => {
+    offers: {
+        "@type": string;
+        url: string | undefined;
+        priceCurrency: string | undefined;
+        price: string | undefined;
+        priceValidUntil: string | undefined;
+        itemCondition: string | undefined;
+        availability: string | undefined;
+    };
+} | undefined;
+
+type Organization = {
+    name?: string;
+    url?: string;
+};
+declare const PerformerSchema: (performers?: string[]) => {
+    performer: {
+        "@type": string;
+        name: string;
+    };
+} | undefined;
+declare const OrganizationSchema: (org?: Organization) => {
+    organizer: {
+        "@type": string;
+        name: string | undefined;
+        url: string | undefined;
+    };
+} | undefined;
+
+type PhotoGallery = Photo[];
+type Photo = {
+    image: ImageType;
+};
+declare const PhotoGallerySchema: (gallery?: PhotoGallery) => {
+    image?: undefined;
+} | {
+    image: string[];
+};
+declare const PhotoSchema: (photo?: Photo) => {
+    image: string;
+} | undefined;
+
+type Review = {
+    ratingValue?: string;
+    bestRating?: string;
+    author?: string;
+};
+type AggregateRating = {
+    ratingValue?: string;
+    reviewCount?: string;
+};
+declare const ReviewSchema: (review?: Review) => {
+    review: {
+        "@type": string;
+        reviewRating: {
+            "@type": string;
+            ratingValue: string | undefined;
+            bestRating: string | undefined;
+        };
+        author: {
+            "@type": string;
+            name: string | undefined;
+        };
+    };
+} | undefined;
+declare const AggregateRatingSchema: (rating?: AggregateRating) => {
+    aggregateRating: {
+        "@type": string;
+        ratingValue: string | undefined;
+        reviewCount: string | undefined;
+    };
+} | undefined;
+
 /**
  * @type {module:@yext/components-maps~MapProvider}
  */
@@ -1307,4 +1698,4 @@ declare const LeafletMaps: any;
  */
 declare const MapQuestMaps: any;
 
-export { Address, type AddressLine, type AddressLineProps, type AddressProps, type AddressType, Analytics, AnalyticsContext, AnalyticsProvider, AnalyticsScopeProvider, BaiduMaps, 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 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, LinkTypes, type ListingPublisher, ListingPublisherOption, type ListingType, LocationMap, type LocationMapProps, Map, type MapContextType, type MapProps, type MapProvider$1 as MapProvider, MapProviderOption, MapQuestMaps, MapboxMaps, Marker, type MarkerProps, type PinStoreType, 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, 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, LinkTypes, 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 };

package/dist/pages-components.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-Cads-eer.cjs");exports.Address=e.Address;exports.Analytics=e.Analytics;exports.AnalyticsContext=e.AnalyticsContext;exports.AnalyticsProvider=e.AnalyticsProvider;exports.AnalyticsScopeProvider=e.AnalyticsScopeProvider;exports.BaiduMaps=e.BaiduMaps;exports.BingMaps=e.BingMaps;exports.Clusterer=e.Clusterer;exports.CoordinateClass=e.Coordinate;exports.Day=e.Day;exports.GoogleMaps=e.GoogleMaps;exports.HoursStatus=e.HoursStatus;exports.HoursTable=e.HoursTable;exports.Image=e.Image;exports.ImageLayoutOption=e.ImageLayoutOption;exports.LeafletMaps=e.LeafletMaps;exports.LegacyRichText=e.LegacyRichText;exports.LexicalRichText=e.LexicalRichText;exports.Link=e.Link;exports.LinkTypes=e.LinkTypes;exports.ListingPublisherOption=e.ListingPublisherOption;exports.LocationMap=e.LocationMap;exports.Map=e.Map;exports.MapProviderOption=e.MapProviderOption;exports.MapQuestMaps=e.MapQuestMaps;exports.MapboxMaps=e.MapboxMaps;exports.Marker=e.Marker;exports.debuggingParamDetected=e.debuggingParamDetected;exports.getDirections=e.getDirections;exports.useAnalytics=e.useAnalytics;exports.useClusterContext=e.useClusterContext;exports.useIdentify=e.useIdentify;exports.useMapContext=e.useMapContext;exports.usePageView=e.usePageView;exports.useScope=e.useScope;exports.useTrack=e.useTrack;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-Eb3ckUJC.cjs");exports.Address=e.Address;exports.AddressSchema=e.AddressSchema;exports.AggregateRatingSchema=e.AggregateRatingSchema;exports.Analytics=e.Analytics;exports.AnalyticsContext=e.AnalyticsContext;exports.AnalyticsProvider=e.AnalyticsProvider;exports.AnalyticsScopeProvider=e.AnalyticsScopeProvider;exports.BaiduMaps=e.BaiduMaps;exports.BaseSchema=e.BaseSchema;exports.BingMaps=e.BingMaps;exports.Clusterer=e.Clusterer;exports.CoordinateClass=e.Coordinate;exports.Day=e.Day;exports.Event=e.Event;exports.FAQPage=e.FAQPage;exports.GoogleMaps=e.GoogleMaps;exports.HoursStatus=e.HoursStatus;exports.HoursTable=e.HoursTable;exports.Image=e.Image;exports.ImageLayoutOption=e.ImageLayoutOption;exports.LeafletMaps=e.LeafletMaps;exports.LegacyRichText=e.LegacyRichText;exports.LexicalRichText=e.LexicalRichText;exports.Link=e.Link;exports.LinkTypes=e.LinkTypes;exports.ListingPublisherOption=e.ListingPublisherOption;exports.LocalBusiness=e.LocalBusiness;exports.LocationMap=e.LocationMap;exports.LocationSchema=e.LocationSchema;exports.Map=e.Map;exports.MapProviderOption=e.MapProviderOption;exports.MapQuestMaps=e.MapQuestMaps;exports.MapboxMaps=e.MapboxMaps;exports.Marker=e.Marker;exports.OfferSchema=e.OfferSchema;exports.OpeningHoursSchema=e.OpeningHoursSchema;exports.OrganizationSchema=e.OrganizationSchema;exports.PerformerSchema=e.PerformerSchema;exports.PhotoGallerySchema=e.PhotoGallerySchema;exports.PhotoSchema=e.PhotoSchema;exports.Product=e.Product;exports.ReviewSchema=e.ReviewSchema;exports.SchemaWrapper=e.SchemaWrapper;exports.debuggingParamDetected=e.debuggingParamDetected;exports.getDirections=e.getDirections;exports.useAnalytics=e.useAnalytics;exports.useClusterContext=e.useClusterContext;exports.useIdentify=e.useIdentify;exports.useMapContext=e.useMapContext;exports.usePageView=e.usePageView;exports.useScope=e.useScope;exports.useTrack=e.useTrack;

package/dist/pages-components.js

@@ -1,39 +1,55 @@
-import { A as e, x as t, y as i, E as o, H as r, Z as n, _ as p, R as u, a3 as c, Y as M, $ as l, W as g, X as y, I as d, J as x, a1 as L, V as C, U as A, K as P, N as T, L as b, T as k, O as m, M as D, a2 as I, a0 as O, Q as S, F as f, w as h, z as v, S as B, D as H, P as R, C as w, G, B as Q } from "./index-BAeydPvg.js";
+import { A as e, a3 as t, ac as i, x as o, y as r, E as c, H as n, ad as p, _ as u, ae as g, R as h, aj as m, Y as l, $ as S, a2 as d, af as M, W as y, X as P, I as L, J as A, ah as x, V as C, U as f, K as O, N as T, L as b, a0 as v, T as B, a4 as R, O as k, M as D, ai as H, ag as I, Q as w, a6 as G, a5 as Q, a8 as z, a7 as E, a9 as F, aa as V, a1 as W, ab as j, Z as J, F as K, w as N, z as U, S as X, D as Y, P as Z, C as _, G as $, B as q } from "./index-DINajhKX.js";
 export {
   e as Address,
-  t as Analytics,
-  i as AnalyticsContext,
-  o as AnalyticsProvider,
-  r as AnalyticsScopeProvider,
-  n as BaiduMaps,
-  p as BingMaps,
-  u as Clusterer,
-  c as CoordinateClass,
-  M as Day,
-  l as GoogleMaps,
-  g as HoursStatus,
-  y as HoursTable,
-  d as Image,
-  x as ImageLayoutOption,
-  L as LeafletMaps,
+  t as AddressSchema,
+  i as AggregateRatingSchema,
+  o as Analytics,
+  r as AnalyticsContext,
+  c as AnalyticsProvider,
+  n as AnalyticsScopeProvider,
+  p as BaiduMaps,
+  u as BaseSchema,
+  g as BingMaps,
+  h as Clusterer,
+  m as CoordinateClass,
+  l as Day,
+  S as Event,
+  d as FAQPage,
+  M as GoogleMaps,
+  y as HoursStatus,
+  P as HoursTable,
+  L as Image,
+  A as ImageLayoutOption,
+  x as LeafletMaps,
   C as LegacyRichText,
-  A as LexicalRichText,
-  P as Link,
+  f as LexicalRichText,
+  O as Link,
   T as LinkTypes,
   b as ListingPublisherOption,
-  k as LocationMap,
-  m as Map,
+  v as LocalBusiness,
+  B as LocationMap,
+  R as LocationSchema,
+  k as Map,
   D as MapProviderOption,
-  I as MapQuestMaps,
-  O as MapboxMaps,
-  S as Marker,
-  f as debuggingParamDetected,
-  h as getDirections,
-  v as useAnalytics,
-  B as useClusterContext,
-  H as useIdentify,
-  R as useMapContext,
-  w as usePageView,
-  G as useScope,
-  Q as useTrack
+  H as MapQuestMaps,
+  I as MapboxMaps,
+  w as Marker,
+  G as OfferSchema,
+  Q as OpeningHoursSchema,
+  z as OrganizationSchema,
+  E as PerformerSchema,
+  F as PhotoGallerySchema,
+  V as PhotoSchema,
+  W as Product,
+  j as ReviewSchema,
+  J as SchemaWrapper,
+  K as debuggingParamDetected,
+  N as getDirections,
+  U as useAnalytics,
+  X as useClusterContext,
+  Y as useIdentify,
+  Z as useMapContext,
+  _ as usePageView,
+  $ as useScope,
+  q as useTrack
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yext/pages-components",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "A React component library that supports Yext Pages development",
   "author": "sumo@yext.com",
   "license": "BSD-3-Clause",
@@ -71,15 +71,15 @@
     "generate-license-file": "^3.0.1",
     "jest-image-snapshot": "^6.4.0",
     "jsdom": "^24.1.0",
-    "@playwright/test": "^1.45.2",
-    "playwright-core": "^1.45.2",
+    "@playwright/test": "^1.48.2",
+    "playwright-core": "^1.48.2",
     "prop-types": "^15.8.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "storybook": "^8.2.4",
     "tsup": "^8.0.1",
     "typescript": "^5.3.3",
-    "vite": "^5.3.4",
+    "vite": "^5.4.11",
     "vite-tsconfig-paths": "^4.2.2",
     "vitest": "^1.6.0"
   },