@yext/pages-components 1.2.4 → 2.0.1

package/dist/index.d.cts

@@ -1,2009 +0,0 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import { Action } from '@yext/analytics';
-import * as React$1 from 'react';
-import React__default, { PropsWithChildren, ReactElement } from 'react';
-import { EditorThemeClasses } from 'lexical';
-import { DateTime } from 'luxon';
-
-/**
- * The type definition for an address.
- *
- * @public
- */
-interface AddressType {
-    line1: string;
-    line2?: string;
-    line3?: string;
-    city: string;
-    region?: string;
-    postalCode: string;
-    countryCode: string;
-    sublocality?: string;
-    extraDescription?: string;
-    localizedRegionName?: string;
-    localizedCountryName?: string;
-}
-type AddressLine = (keyof AddressType | ",")[];
-/**
- * The shape of the data passed to {@link Address}.
- *
- * @public
- */
-interface AddressProps extends React.HTMLProps<HTMLDivElement> {
-    address: AddressType;
-    lines?: AddressLine[];
-    separator?: string;
-}
-/**
- * The shape of the data passed to {@link AddressLine}.
- *
- * @public
- */
-type AddressLineProps = {
-    address: AddressType;
-    line: AddressLine;
-    separator?: string;
-};
-/**
- * The available listing publishers
- *
- * @public
- */
-declare const ListingPublisherOption: {
-    readonly GOOGLEMYBUSINESS: "GOOGLEMYBUSINESS";
-};
-/**
- * The type definition for the listing publisher
- *
- * @public
- */
-type ListingPublisher = (typeof ListingPublisherOption)[keyof typeof ListingPublisherOption];
-/**
- * The type definition for a Listing
- *
- * @public
- */
-interface ListingType {
-    listingUrl: string;
-    publisher?: ListingPublisher;
-}
-/**
- * The available map providers
- *
- * @public
- */
-declare const MapProviderOption: {
-    readonly GOOGLE: "google";
-    readonly APPLE: "apple";
-    readonly BING: "bing";
-};
-/**
- * The type definition for the map provider
- *
- * @public
- */
-type MapProvider$1 = (typeof MapProviderOption)[keyof typeof MapProviderOption];
-/**
- * The Yext profile fields used to create a getDirections URL
- */
-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
- * a location entity's address from Yext Knowledge Graph:
- * ```
- * import { Address } from "@yext/pages/components";
- *
- * const address = (<Address address={document.address} />);
- *   --> 1101 Wilson Blvd., Suite 2300,
- *       Arlington, VA, 22201,
- *       US
- * const customAddress = (<Address address={document.address} lines={[['line1', 'city', 'region']]} />);
- *   --> 1101 Wilson Blvd., Arlington, VA
- * ```
- *
- * @public
- */
-declare const Address: ({ address, lines, separator, ...props }: AddressProps) => react_jsx_runtime.JSX.Element;
-
-/**
- * Get a third-party maps url for a Yext location
- *
- * @param address - Yext address
- * @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, coordinate?: DirectionCoordinate) => string | undefined;
-
-/**
- * The shape of the data passed directly to the different template functions with the
- * exception of the render function (getPath, getHeadConfig, etc).
- *
- * @public
- */
-interface TemplateProps<T = Record<string, any>> {
-    /** The entire document returned after applying the stream to a single entity */
-    document: T;
-}
-
-type TrackProps = {
-    action: Action;
-    destinationUrl?: string;
-    scope?: string;
-    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
- * the Analytics Provider.
- *
- */
-interface AnalyticsMethods {
-    /**
-     * The track method will send a generic analytics event to Yext.
-     *
-     * @param eventName - the name of the event, will appear in Yext's Report Builder UI
-     * @param conversionData - optional details for tracking an event as a conversion
-     */
-    track(props: TrackProps): Promise<void>;
-    /**
-     * The identify method will allow you to tie analytics events to a specific user.
-     *
-     * @param visitor - the Visitor object
-     */
-    identify(visitor: Record<string, string>): void;
-    /**
-     * The pageView method will track a pageview event.
-     */
-    pageView(): Promise<void>;
-    /**
-     * The optIn method should be called when a user opts into analytics tracking,
-     * e.g. via a Consent Management Banner or other opt-in method.
-     */
-    optIn(): Promise<void>;
-    /**
-     * Use the getDebugEnabled method to retrieve whether debugging is on or off.
-     */
-    getDebugEnabled(): boolean;
-}
-/**
- * The AnalyticsProviderProps interface represents the component properties
- * to be passed into the AnalyticsProvider.
- *
- * @public
- */
-interface AnalyticsProviderProps {
-    /**
-     * The API Key or OAuth for accessing the Analytics Events API
-     */
-    apiKey: string;
-    /**
-     * The TemplateProps that come from the rendering system
-     */
-    templateData: TemplateProps;
-    /**
-     * The ISO 4217 currency code of the currency the value is expressed in.
-     * For example, "USD" for US dollars.
-     *
-     * For more information see https://www.iso.org/iso-4217-currency-codes.html.
-     */
-    currency: string;
-    /**
-     * requireOptIn should be set to true if your compliance requirements require
-     * you to put all marketing analytics behind a user opt-in banner or if you
-     * use a Compliance Management tool of some kind.
-     */
-    requireOptIn?: boolean | undefined;
-    /**
-     * disableSessionTracking will set sessionId to undefined in the event payload
-     * when a user does any trackable action on your site, such as a page view,
-     * click, etc.
-     */
-    disableSessionTracking?: boolean | undefined;
-    /**
-     * enableDebugging can be set to true if you want to expose tracked events
-     * 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;
-    /**
-     * productionDomains is an optional list of domains that analytics should fire on. If your production site is hosted by Yext then this field is not required. It is only necessary if this code is being run in the context of a Yext module.
-     */
-    productionDomains?: string[];
-}
-/**
- * AnalyticsScopeProps defines the component properties required by the
- * AnalyticsScopeProvider component.
- *
- * @public
- */
-interface AnalyticsScopeProps {
-    /**
-     * The string to prepend to all analytics events that come from components
-     * below the AnalyticsScopeProvider component in the tree.
-     */
-    name: string;
-}
-
-/**
- * The Analytics class creates a stateful facade in front of the \@yext/analytics
- * Library's pagesAnalyticsProvider class. It takes in some data from the
- * template configuration and uses it to provide configuration to the
- * pagesAnalyticsProvider.
- *
- * Additionally, it provides handlers for controlling user opt-in for compliance
- * requirements as well as for debugging, enabling conversion tracking, saving
- * user identity information, and creating named analytics scopes for
- * easy tagging.
- *
- * @public
- */
-declare class Analytics implements AnalyticsMethods {
-    private apiKey;
-    private defaultCurrency;
-    private templateData;
-    private productionDomains?;
-    private enableDebugging;
-    private _optedIn;
-    private _sessionTrackingEnabled;
-    private _analyticsEventService;
-    private _pageViewFired;
-    /**
-     * Creates an Analytics instance, will fire a pageview event if requireOptin
-     * is false
-     *
-     * @param apiKey - the Yext API key for authorizing analytics events
-     * @param defaultCurrency - the ISO 4217 currency code to use for valued events
-     * @param templateData - template data object from the pages system
-     * @param requireOptIn - boolean, set to true if you require user opt in before tracking analytics
-     * @param disableSessionTracking - turns off session tracking
-     * @param productionDomains - the domains to fire Yext analytics on. Only necessary if this code is being run in the context of a Yext module.
-     * @param enableDebugging - turns debug mode on meaning requests are logged instead
-     */
-    constructor(apiKey: string, defaultCurrency: string, templateData: TemplateProps, requireOptIn?: boolean, disableSessionTracking?: boolean, productionDomains?: string[] | undefined, enableDebugging?: boolean);
-    private makeReporter;
-    private canTrack;
-    /** {@inheritDoc AnalyticsMethods.identify} */
-    identify(visitor: Record<string, string>): void;
-    /** {@inheritDoc AnalyticsMethods.async} */
-    optIn(): Promise<void>;
-    /** {@inheritDoc AnalyticsMethods.async} */
-    pageView(): Promise<void>;
-    /** {@inheritDoc AnalyticsMethods.track} */
-    track(props: TrackProps): Promise<void>;
-    /** {@inheritDoc AnalyticsMethods.getDebugEnabled} */
-    getDebugEnabled(): boolean;
-}
-
-/**
- * Default react context for use with Yext Analytics.
- *
- * @public
- */
-declare const AnalyticsContext: React$1.Context<AnalyticsMethods | null>;
-
-declare global {
-    interface Window {
-        setAnalyticsOptIn: () => void;
-    }
-}
-/**
- * The useAnalytics hook can be used anywhere in the tree below a configured
- * AnalyticsProvider. Calling it will return an object to give you access to
- * the analytics convenience methods for use in your components,
- * such as track(), pageView(), optIn() etc.
- *
- * @public
- */
-declare function useAnalytics(): AnalyticsMethods | null;
-/**
- * Simpler hook that just returns the analytics track() method.
- *
- * @public
- */
-declare const useTrack: () => ((props: TrackProps) => Promise<void>) | undefined;
-/**
- * Simpler hook that just returns the analytics pageView method
- *
- * @public
- */
-declare const usePageView: () => (() => Promise<void>) | undefined;
-/**
- * Simpler hook that just returns the analytics identify method
- *
- * @public
- */
-declare const useIdentify: () => ((visitor: Record<string, string>) => void) | undefined;
-
-/**
- * The main Analytics component for you to use. Sets up the proper react context
- * and bootstraps the Analytics reporter.
- *
- * @param props - A PropsWithChildren that implements AnalyticsProviderProps
- *
- * @public
- */
-declare function AnalyticsProvider(props: PropsWithChildren<AnalyticsProviderProps>): React.ReactElement;
-/**
- * This will look for the xYextDebug parameter and if it is present,
- * enable analytics debugging.
- */
-declare function debuggingParamDetected(): boolean;
-
-/**
- * The useScope hook will return the current scope from the Analytics Scope. For
- * use within the context of an AnalyticsScopeProvider for scoping analytics events.
- */
-declare const useScope: () => string;
-/**
- * The AnalyticsScopeProvider will allow you to pre-pend a given string to all
- * events that happen in the node tree below where setScope is called.
- * For example, if you call setScope('header') and there is an `a` element
- * below whose onClick calls `track('my link')` the calculated event name
- * that will be sent to Yext Analytics is `header_mylink`
- *
- * @param props - AnalyticsScopeProps
- */
-declare function AnalyticsScopeProvider(props: PropsWithChildren<AnalyticsScopeProps>): React.ReactElement;
-
-/**
- * The type definition for a thumbnail.
- *
- * @public
- */
-type ThumbnailType = {
-    height: number;
-    width: number;
-    url: string;
-};
-/**
- * The type definition for a complex image.
- *
- * @public
- */
-type ComplexImageType = {
-    image: {
-        alternateText?: string;
-        height: number;
-        width: number;
-        url: string;
-        thumbnails?: ThumbnailType[];
-    };
-};
-/**
- * The type definition for an image.
- *
- * @public
- */
-type ImageType = {
-    alternateText?: string;
-    height: number;
-    width: number;
-    url: string;
-};
-/**
- * Layout option on the Image component.
- *
- * @public
- */
-declare const ImageLayoutOption: {
-    /**
-     * The the default layout if one is not specified. An image will be scaled down to fit the
-     * container but not exceed the absolute size of the image.
-     */
-    readonly INTRINSIC: "intrinsic";
-    /**
-     * Shows the image in a fixed size. `width` or `height` must be passed in. If both `width` and
-     * `height` are passed in, but the aspect ratio does not match the aspect ratio of the image,
-     * the image will be centered. This behavior can be adjusted using the `objectFit` and
-     * `objectPosition` props of the `style` rpop.
-     */
-    readonly FIXED: "fixed";
-    /** Shows the image in a fixed aspect ratio. The `aspectRatio` prop must be provided. */
-    readonly ASPECT: "aspect";
-    /** Always fills the image to 100% of the container's width. */
-    readonly FILL: "fill";
-};
-/**
- * The type definition for the image layout.
- *
- * @public
- */
-type ImageLayout = (typeof ImageLayoutOption)[keyof typeof ImageLayoutOption];
-/**
- * The shape of the data passed to {@link Image}.
- */
-interface BaseImageProps {
-    /** The image field from Knowledge Graph. */
-    image: ComplexImageType | ImageType;
-    /** Overrides the className on the underlying img tag. */
-    className?: string;
-    /** Specifies how the image is rendered. */
-    layout?: ImageLayout;
-    /** The absolute width of the image. Only impacts if layout is set to "fixed". */
-    width?: number;
-    /** The absolute height of the image. Only impacts if layout is set to "fixed". */
-    height?: number;
-    /** The aspect ratio of the image. Only impacts if layout is set to "aspect". */
-    aspectRatio?: number;
-    /** A pass through react component that is displayed when the image is loading. */
-    placeholder?: React$1.ReactNode;
-    /** Pass through props that are on the native HTML img tag. The Image component may not work if src and/or srcsets are included. */
-    imgOverrides?: Record<string, unknown>;
-    /** The pass through style of the underlying img tag. */
-    style?: React$1.CSSProperties;
-    /** Set the loading state of the image. */
-    loading?: "eager" | "lazy";
-    /** Cloudflare Image transformations */
-    imageTransformations?: ImageTransformations;
-}
-/**
- * The shape of the data passed to {@link Image} when layout is {@link ImageLayoutOption.INTRINSIC},
- * {@link ImageLayoutOption.FILL} or not provided.
- */
-interface OtherImageProps extends BaseImageProps {
-    /** Specifies how the image is rendered. */
-    layout?: "intrinsic" | "fill";
-}
-/**
- * The shape of the data passed to {@link Image} when layout is {@link ImageLayoutOption.FIXED}.
- * Extends the {@link BaseImageProps} interface and has the additions of a width and height,
- * at least one of which must be specified.
- */
-interface FixedImageProps extends BaseImageProps {
-    /** Specifies how the image is rendered. */
-    layout: "fixed";
-    /** The absolute width of the image. Only impacts if layout is set to "fixed". */
-    width?: number;
-    /** The absolute height of the image. Only impacts if layout is set to "fixed". */
-    height?: number;
-}
-/**
- * The shape of the data passed to {@link Image} when layout is {@link ImageLayoutOption.ASPECT}.
- * Extends the {@link BaseImageProps} interface and has the additions of a required aspectRatio.
- */
-interface AspectImageProps extends BaseImageProps {
-    /** Specifies how the image is rendered. */
-    layout: "aspect";
-    /** The aspect ratio of the image. Only impacts if layout is set to "aspect". */
-    aspectRatio: number;
-}
-/**
- * Cloudflare Image transformations
- * See: https://developers.cloudflare.com/images/transform-images/transform-via-url
- */
-type ImageTransformations = {
-    /** Affects interpretation of width and height */
-    fit?: "scale-down" | "contain" | "cover" | "crop" | "pad" | "squeeze";
-    /** Image file format. Defaults to undefined, which uses webp if supported, original extension otherwise. */
-    format?: "avif" | "webp" | "jpeg";
-    /** Specifies how an image should be cropped with fit=cover or fit=crop. */
-    gravity?: "auto" | "left" | "right" | "top" | "bottom";
-    /** Quality of the image. Between 1 and 100. Defaults to 85. */
-    quality?: number;
-};
-/**
- * The shape of the data passed to {@link Image}.
- *
- * @public
- */
-type ImageProps = OtherImageProps | FixedImageProps | AspectImageProps;
-
-/**
- * Renders an image based from the Yext Knowledge Graph. Example of using the component to render
- * simple and complex image fields from Yext Knowledge Graph:
- * ```
- * import { Image } from "@yext/pages/components";
- *
- * const simpleImage = (<Image image={document.logo} />);
- * const complexImage = (<Image image={document.photoGallery[0]} />);
- * ```
- *
- * @public
- */
-declare const Image: ({ image, className, width, height, aspectRatio, layout, placeholder, imgOverrides, style, imageTransformations, loading, }: ImageProps) => react_jsx_runtime.JSX.Element;
-
-/**
- * Parses a raw a.mktgcdn.com type url and returns its corresponding dyn.mktgcdn.com version.
- * If the raw url cannot be parsed, it's simply returned as-is and used as a passthrough.
- */
-declare const getImageUrl: (rawUrl: string, width: number, height: number, imageTransformations?: ImageTransformations) => string | undefined;
-
-/**
- * Type of link types that might be received from the platform.
- *
- * @public
- */
-type LinkType = "URL" | "Email" | "EMAIL" | "Phone" | "PHONE" | "DRIVING_DIRECTIONS" | "CLICK_TO_WEBSITE" | "OTHER";
-/**
- * Type for CTA field
- * Note that when coming from the platform the label will always be a string
- * but ReactNode allows for more general usage.
- *
- * @public
- */
-interface CTA {
-    link: string;
-    label?: React.ReactNode;
-    linkType?: LinkType;
-}
-/**
- * Configuration options available for any usages of the Link component.
- */
-interface LinkConfig extends React.DetailedHTMLProps<React.AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement> {
-    /** Obfuscates the href and label. */
-    obfuscate?: boolean;
-    /** The custom name of the event. */
-    eventName?: string;
-    /** Scope the specific link event. Overrides the scope set by the provider. */
-    scope?: string;
-    /**
-     * The ISO 4217 currency code of the currency the value is expressed in.
-     * Overrides the defaultCurrency set on the provider.
-     * For example, "USD" for US dollars.
-     *
-     * For more information see https://www.iso.org/iso-4217-currency-codes.html.
-     */
-    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.
- *
- * @public
- */
-interface HREFLinkProps extends LinkConfig {
-    href: string;
-    cta?: never;
-}
-/**
- * The shape of the data passed to {@link Link} when using a CTA field, and not overriding children.
- *
- * @public
- */
-interface CTAWithChildrenLinkProps extends LinkConfig {
-    href?: never;
-    cta: CTA;
-    children?: React.ReactNode;
-}
-/**
- * The shape of the data passed to {@link Link} when using a CTA field, and overriding children.
- *
- * @public
- */
-interface CTAWithoutChildrenLinkProps extends LinkConfig {
-    href?: never;
-    cta: Omit<CTA, "label">;
-    children: React.ReactNode;
-}
-/**
- * The shape of the data passed to {@link Link} when using a CTA field.
- */
-type CTALinkProps = CTAWithChildrenLinkProps | CTAWithoutChildrenLinkProps;
-/**
- * The shape of the data passed to {@link Link}.
- *
- * @public
- */
-type LinkProps = CTALinkProps | HREFLinkProps;
-
-/**
- * Renders an anchor tag using either a directly provided HREF or from a field in the Yext Knowledge Graph.
- *
- * Example of using the component to render
- * a link with and without sourcing from a knowledge graph field:
- *
- * @example
- * ```ts
- * import { Link } from "@yext/pages/components";
- *
- * <Link href="/search">Locator</Link>
- * <Link cta={document.c_exampleCTA} />
- * <Link cta={{link: "https://www.yext.com", label: "Click Here", linkType: "URL"}} />
- * ```
- *
- * @public
- */
-declare const Link: React$1.ForwardRefExoticComponent<(Omit<HREFLinkProps, "ref"> | Omit<CTAWithChildrenLinkProps, "ref"> | Omit<CTAWithoutChildrenLinkProps, "ref">) & React$1.RefAttributes<HTMLAnchorElement>>;
-
-declare enum Unit {
-    DEGREE = "deg",
-    KILOMETER = "km",
-    MILE = "mi",
-    RADIAN = "r"
-}
-declare enum Projection {
-    MERCATOR = "mercator",
-    SPHERICAL = "spherical"
-}
-
-/**
- * This class represents a point on a sphere defined by latitude and longitude.
- * Latitude is a degree number in the range [-90, 90].
- * Longitude is a degree number without limits but is normalized to [-180, 180).
- */
-declare class Coordinate$1 {
-    _lat: number;
-    _lon: number;
-    /**
-     * Constructor takes either 1 or 2 arguments.
-     * 2 arguments: latitude and longitude.
-     * 1 argument: an object with at least one {@link LATITUDE_ALIASES | latitude alias}
-     * and one one {@link LONGITUDE_ALIASES | longitude alias}.
-     * @param longitude - Optional only if the first argument is a {@link Coordinate}-like object
-     */
-    constructor(latitudeOrObject: number | object, long?: number);
-    /**
-     * Degrees latitude in the range [-90, 90].
-     * If setting a value outside this range, it will be set to -90 or 90, whichever is closer.
-     */
-    get latitude(): number;
-    set latitude(newLat: number);
-    /**
-     * Degrees longitude in the range [-Infinity, Infinity].
-     */
-    get longitude(): number;
-    set longitude(newLon: number);
-    /**
-     * Degrees longitude in the range [-180, 180).
-     * If the coordinate's longitude is outside this range, the equivalent value within it is used.
-     * Examples: 123 =\> 123, 270 =\> -90, -541 =\> 179
-     */
-    get normalLon(): number;
-    /**
-     * Add distance to the coordinate to change its position.
-     * @param latDist - latitude distance
-     * @param lonDist - longitude distance
-     * @param unit - The unit of latDist and lonDist
-     * @param projection - The projection of Earth (not relevant when using a physical distance unit, e.g. Mile)
-     */
-    add(latDist: number, lonDist: number, unit?: Unit, projection?: Projection): void;
-    /**
-     * Calculate the distance from this coordinate to another coordinate.
-     * @param unit - The unit of distance
-     * @param projection - The projection of Earth (not relevant when using a physical distance unit, e.g. Mile)
-     * @returns Distance in the requested unit
-     */
-    distanceTo(coordinate: Coordinate$1, unit?: Unit, projection?: Projection): number;
-    /**
-     * Test if this coordinate has the same latitude and longitude as another.
-     */
-    equals(coordinate: Coordinate$1): boolean;
-    /**
-     * Get the coordinate as a string that can be used in a search query.
-     * Example: \{latitude: -45, longitude: 123\} =\> '-45,123'
-     */
-    searchQueryString(): string;
-}
-
-/**
- * This class represents a bounded coordinate region of a sphere.
- * The bounds are defined by two {@link Coordinates}: southwest and northeast.
- * If the northeast coordinate does not have a greater latitude and longitude than the soutwest
- * coordinate, the behavior of this object is undefined.
- */
-declare class GeoBounds {
-    _ne: Coordinate$1;
-    _sw: Coordinate$1;
-    /**
-     * Create a new {@link GeoBounds} with minimal area that
-     * contains all the given coordinates
-     */
-    static fit(coordinates: Coordinate$1[]): GeoBounds;
-    /**
-     * @param sw - Southwest coordinate
-     * @param ne - Northeast coordinate
-     */
-    constructor(sw: Coordinate$1, ne: Coordinate$1);
-    /**
-     * Northeast coordinate
-     */
-    get ne(): Coordinate$1;
-    set ne(newNE: Coordinate$1);
-    /**
-     * Southwest coordinate
-     */
-    get sw(): Coordinate$1;
-    set sw(newSW: Coordinate$1);
-    /**
-     * Whether the coordinate lies within the region defined by the bounds.
-     * {@link Normalized | longitudes} are used for the
-     * bounds and the coordinate.
-     */
-    contains(coordinate: Coordinate$1): boolean;
-    /**
-     * Extend the bounds if necessary so that the coordinate is contained by them.
-     */
-    extend(coordinate: Coordinate$1): void;
-    /**
-     * Calculate the center of the bounds using the given projection.
-     * To find the visual center on a Mercator map, use Projection.MERCATOR.
-     * To find the center for geolocation or geosearch purposes, use Projection.SPHERICAL.
-     */
-    getCenter(projection?: Projection): Coordinate$1;
-}
-
-/**
- * {@link ProviderMap} options class
- */
-declare class ProviderMapOptions {
-    /**
-     * @param wrapper - The wrapper element that the map will be inserted into
-     */
-    providerMapClass: typeof ProviderMap;
-    wrapper: HTMLElement | null;
-    controlEnabled: boolean;
-    panHandler: PanHandler;
-    panStartHandler: PanStartHandler;
-    providerOptions: {
-        [key: string]: any;
-    };
-    iframeWindow: Window | undefined;
-    apiKey: string | undefined;
-    constructor(provider: MapProvider, wrapper: HTMLElement | null);
-    /**
-     * @param controlEnabled - Whether the user can interact with the map
-     */
-    withControlEnabled(controlEnabled: boolean): ProviderMapOptions;
-    /**
-     * @param panHandler - Function called after the map bounds change
-     */
-    withPanHandler(panHandler: PanHandler): ProviderMapOptions;
-    /**
-     * @param panStartHandler - Function called before the map bounds change
-     */
-    withPanStartHandler(panStartHandler: PanStartHandler): ProviderMapOptions;
-    /**
-     * @param providerOptions - A free-form object used to set any additional provider-specific
-     *   options, usually by passing the object to the map's constructor
-     */
-    withProviderOptions(providerOptions: object): ProviderMapOptions;
-    /**
-     * @param iframeWindow - The window of the iframe that the map will be rendered in.
-     *   This is only necessary if the map is being rendered in an iframe.
-     */
-    withIframeWindow(iframeWindow: Window | undefined): ProviderMapOptions;
-    /**
-     * @param apiKey - The API key to use for the map provider, if required.
-     */
-    withApiKey(apiKey: string | undefined): ProviderMapOptions;
-    /**
-     * @returns An instance of a subclass of {@link ProviderMap}
-     *   for the given {@link MapProvider}
-     */
-    build(): ProviderMap;
-}
-/**
- * This class is an interface that should be implemented for each map provider, such as Google Maps.
- * It is used as an API for a {@link Map} to control a
- * provider-specific map instance. Ideally, this class should have minimal functionality so that
- * adding a new provider is easy and behavior is as consistent as possible across all providers.
- */
-declare class ProviderMap {
-    /**
-     * The constructor creates a map instance using the provider's API and initializes it with all the
-     * given options. See {@link ProviderMapOptions}
-     * for the supported options.
-     */
-    _panHandler: PanHandler;
-    _panStartHandler: PanStartHandler;
-    constructor(options: ProviderMapOptions);
-    /**
-     * The current center of the map
-     */
-    getCenter(): Coordinate$1;
-    /**
-     * Zoom level complies with the specifications in {@link Map#getZoom}
-     * @returns The current zoom level of the map
-     */
-    getZoom(): number;
-    /**
-     * @param coordinate - The new center for the map
-     * @param animated - Whether to transition smoothly to the new center
-     */
-    setCenter(_: Coordinate$1, __: boolean): void;
-    /**
-     * Zoom level complies with the specifications in {@link Map#getZoom}
-     * @param zoom - The new zoom level for the map
-     * @param animated - Whether to transition smoothly to the new zoom
-     */
-    setZoom(_: number, __: boolean): void;
-    /**
-     * @param center - Must be convertible to {@link Coordinate}
-     * @param animated - Whether to transition smoothly to the new bounds
-     * @see ProviderMap#setZoom
-     * @see ProviderMap#setCenter
-     */
-    setZoomCenter(zoom: number, center: Coordinate$1, animated: boolean): void;
-}
-
-/**
- * {@link ProviderPin} options class
- */
-declare class ProviderPinOptions {
-    providerPinClass: typeof ProviderPin;
-    clickHandler: PinClickHandler;
-    focusHandler: PinFocusHandler;
-    hoverHandler: PinHoverHandler;
-    icons: {
-        [key: string]: string;
-    };
-    hasPinUrl: boolean;
-    constructor(provider: MapProvider);
-    /**
-     * @param clickHandler - Function called when the pin is clicked
-     */
-    withClickHandler(clickHandler: PinClickHandler): ProviderPinOptions;
-    /**
-     * @param focusHandler - Function called when the pin becomes (un)focused
-     */
-    withFocusHandler(focusHandler: PinFocusHandler): ProviderPinOptions;
-    /**
-     * @param hoverHandler - Function called when the pin becomes (un)hovered
-     */
-    withHoverHandler(hoverHandler: PinHoverHandler): ProviderPinOptions;
-    /**
-     * Similar to {@link MapPinOptions#withIcon},
-     * but all icons are given as a map of key =\> icon. If a provider pin instance needs an icon to be
-     * a specialized class rather than a simple URL, the icons in this object can be converted in this
-     * function and assigned back to the icons object instead of being recreated from the URL every
-     * time the pin's icon changes.
-     * @param icons - Map of a string key to the URL or data URI of an image
-     */
-    withIcons(icons: {
-        [key: string]: string;
-    }): ProviderPinOptions;
-    /**
-     * @param hasPinUrl - Pass through from MapPin class
-     * @returns
-     */
-    withHasPinUrl(hasPinUrl: boolean): this;
-    /**
-     * @returns An instance of a subclass of {@link ProviderPin}
-     *   for the given {@link MapProvider}
-     */
-    build(): ProviderPin;
-}
-/**
- * This class is an interface that should be implemented for each map provider, such as Google Maps.
- * It is used as an API for a {@link MapPin} to control a
- * provider-specific pin instance. Ideally, this class should have minimal functionality so that
- * adding a new provider is easy and behavior is as consistent as possible across all providers.
- */
-declare class ProviderPin {
-    _clickHandler: PinClickHandler;
-    _focusHandler: PinFocusHandler;
-    _hoverHandler: PinHoverHandler;
-    _icons: {
-        [key: string]: string;
-    };
-    /**
-     * The constructor creates a pin instance using the provider's API and initializes it with all the
-     * given options. See {@link ProviderPinOptions}
-     * for the supported options.
-     */
-    constructor(options: ProviderPinOptions);
-    /**
-     * @param coordinate - The position of the pin
-     */
-    setCoordinate(_: Coordinate$1): void;
-    /**
-     * Remove the pin from its current map and, if newMap is not null, add it to the new map.
-     * @param newMap - The new map -- if null, the pin will not be
-     *   shown on any map
-     * @param currentMap - The current map -- if null, the pin is
-     *   not shown on any map
-     */
-    setMap(_: Map$1 | null, __: Map$1 | null): void;
-    /**
-     * Apply the given properties to modify the appearance of the pin.
-     * @see PinProperties
-     */
-    setProperties(_: PinProperties): void;
-}
-
-type ProviderLoadFunction = (resolve: () => void, reject: () => void, apiKey: string, options: object) => void;
-/**
- * {@link MapProvider} options class
- */
-declare class MapProviderOptions {
-    loadFunction: ProviderLoadFunction;
-    mapClass: typeof ProviderMap;
-    pinClass: typeof ProviderPin;
-    providerName: string;
-    constructor();
-    withLoadFunction(loadFunction: ProviderLoadFunction): MapProviderOptions;
-    /**
-     * @param mapClass - Subclass of {@link ProviderMap}
-     *   for the provider
-     */
-    withMapClass(mapClass: typeof ProviderMap): MapProviderOptions;
-    /**
-     * @param pinClass - Subclass of {@link ProviderPin} for the provider
-     */
-    withPinClass(pinClass: typeof ProviderPin): MapProviderOptions;
-    /**
-     * @param providerName - Name of the map provider
-     */
-    withProviderName(providerName: string): MapProviderOptions;
-    build(): MapProvider;
-}
-/**
- * This class is used for loading the API for a map provider such as Google Maps and creating {@link ProviderMap}
- * and {@link ProviderPin} instances.
- * Provider map implementations return an instance of this class for their provider that you can use
- * to load the API and pass in to {@link MapOptions} and {@link MapPinOptions} objects as the provider.
- * Example using {@link GoogleMaps}, an instance of this
- * class: GoogleMaps.load().then(() =\> map = new MapOptions().withProvider(GoogleMaps).build());
- */
-declare class MapProvider {
-    _loadFunction: ProviderLoadFunction;
-    _mapClass: typeof ProviderMap;
-    _pinClass: typeof ProviderPin;
-    _providerName: string;
-    _loadPromise: Promise<void>;
-    _resolveLoad?: () => void;
-    _rejectLoad?: () => void;
-    _apiKey: string;
-    _loadInvoked: boolean;
-    _loaded: boolean;
-    _options: any;
-    constructor(options: MapProviderOptions);
-    /**
-     * Returns true if the map provider has been successfully loaded
-     */
-    get loaded(): boolean;
-    /**
-     * @see ~MapProviderOptions#withMapClass
-     */
-    getMapClass(): typeof ProviderMap;
-    /**
-     * @see MapProviderOptions#withPinClass
-     */
-    getPinClass(): typeof ProviderPin;
-    /**
-     * @see MapProviderOptions#withProviderName
-     */
-    getProviderName(): string;
-    /**
-     * Call {@link loadFunction}
-     * and resolve or reject when loading succeeds or fails
-     * @param apiKey - Provider API key -- uses value from {@link MapProvider#setLoadOptions}
-     *   if not passed
-     * @param options - Additional provider-specific options -- uses value from {@link MapProvider#setLoadOptions}
-     *   if not passed
-     */
-    load(apiKey?: string, options?: any): Promise<void>;
-    /**
-     * Resolves or rejects when the map provider has loaded successfully or unsuccessfully
-     */
-    ready(): Promise<void>;
-    /**
-     * Set the API key and provider options used on load. Does nothing if load was already called.
-     * @param apiKey - Provider API key
-     * @param options - Additional provider-specific options
-     */
-    setLoadOptions(apiKey: string, options?: object | null): void;
-}
-
-/**
- * This class is used to set the appearance of a {@link MapPin}.
- * Most properties are supported by all providers, but some are only supported by providers that
- * implement {@link HTMLProviderPin}.
- */
-declare class PinProperties {
-    _anchorX: number;
-    _anchorY: number;
-    _height: number;
-    _icon: string;
-    _srText: string;
-    _width: number;
-    _zIndex: number;
-    _class: string;
-    _element: HTMLElement | null;
-    constructor();
-    /**
-     * @returns The point in the pin that should be positioned over the coordinate, from 0
-     *   (left edge) to 1 (right edge)
-     */
-    getAnchorX(): number;
-    /**
-     * @returns The point in the pin that should be positioned over the coordinate, from 0
-     *   (top edge) to 1 (bottom edge)
-     */
-    getAnchorY(): number;
-    /**
-     * {@link HTMLProviderPins} only
-     * @returns The class of the wrapper element for an HTML pin
-     */
-    getClass(): string;
-    /**
-     * {@link HTMLProviderPins} only
-     * @returns The HTML pin element
-     */
-    getElement(): HTMLElement | null;
-    /**
-     * @returns The pixel height of the pin
-     */
-    getHeight(): number;
-    /**
-     * This returns a string key that can be used with {@link MapPin#getIcon}
-     * to get the icon image for a pin.
-     * @returns The unique name of the icon
-     */
-    getIcon(): string;
-    /**
-     * @returns The text that a screen reader reads when focused on the pin
-     */
-    getSRText(): string;
-    /**
-     * @returns The pixel width of the pin
-     */
-    getWidth(): number;
-    /**
-     * @returns The z-index of the pin
-     */
-    getZIndex(): number;
-    /**
-     * @see PinProperties#getAnchorX
-     */
-    setAnchorX(anchorX: number): PinProperties;
-    /**
-     * @see PinProperties#getAnchorY
-     */
-    setAnchorY(anchorY: number): PinProperties;
-    /**
-     * @see PinProperties#getClass
-     */
-    setClass(className: string): PinProperties;
-    /**
-     * @see PinProperties#getElement
-     */
-    setElement(element: HTMLElement): PinProperties;
-    /**
-     * @see PinProperties#getHeight
-     */
-    setHeight(height: number): PinProperties;
-    /**
-     * @see PinProperties#getIcon
-     */
-    setIcon(icon: string): PinProperties;
-    /**
-     * @see PinProperties#getSRText
-     */
-    setSRText(srText: string): PinProperties;
-    /**
-     * @see PinProperties#getWidth
-     */
-    setWidth(width: number): PinProperties;
-    /**
-     * @see PinProperties#getZIndex
-     */
-    setZIndex(zIndex: number): PinProperties;
-}
-
-type PropertiesForStatus = (status: object) => PinProperties;
-type PinClickHandler = () => void;
-type PinFocusHandler = (focused: boolean) => void;
-type PinHoverHandler = (hovered: boolean) => void;
-/**
- * {@link MapPin} options class
- */
-declare class MapPinOptions {
-    /**
-     * Initialize with default options
-     */
-    coordinate: Coordinate$1;
-    hideOffscreen: boolean;
-    icons: {
-        [key: string]: string;
-    };
-    propertiesForStatus: PropertiesForStatus;
-    provider: MapProvider | null;
-    type: string;
-    hasPinUrl: boolean;
-    constructor();
-    /**
-     * @param coordinate - Must be convertible to {@link Coordinate}
-     */
-    withCoordinate(coordinate: Coordinate$1): MapPinOptions;
-    /**
-     * @param hideOffscreen - If true, the pin will only be rendered if it's in the visible
-     *   portion of the map to improve performance
-     */
-    withHideOffscreen(hideOffscreen: boolean): MapPinOptions;
-    /**
-     * @param key - The unique name for the icon, used in {@link PinProperties#getIcon}
-     *   and {@link PinProperties#setIcon}
-     * @param icon - The URL or data URI of the icon image
-     */
-    withIcon(key: string, icon: string): MapPinOptions;
-    withPropertiesForStatus(propertiesForStatus: PropertiesForStatus): MapPinOptions;
-    withProvider(provider: MapProvider | null): MapPinOptions;
-    /**
-     * @param hasPinUrl - If true, the pin's HTML element will be a div instead of a button since there is a nested anchor tag within the pin. This will fix current accessibility issues.
-     */
-    withHasPinUrl(hasPinUrl: boolean): MapPinOptions;
-    /**
-     * @param type - A string describing the type of the pin
-     */
-    withType(type: string): MapPinOptions;
-    build(): MapPin;
-}
-/**
- * A pin for a {@link Map} that displays at a given {@link Coordinate}.
- * A MapPin can be displayed on at most one Map at a time. Pins support event handlers for clicking,
- * hovering, and focusing. The pin can change its appearance based on its current status, which is
- * changed by {@link setStatus}.
- */
-declare class MapPin {
-    _coordinate: Coordinate$1;
-    _hideOffscreen: boolean;
-    _icons: {
-        [key: string]: string;
-    };
-    _propertiesForStatus: PropertiesForStatus;
-    _type: string;
-    _clickHandler: PinClickHandler;
-    _focusHandler: PinFocusHandler;
-    _hoverHandler: PinHoverHandler;
-    _hidden: boolean;
-    _cancelHiddenUpdater: () => void;
-    _map: Map$1 | null;
-    _pin: ProviderPin;
-    _status: object;
-    constructor(options: MapPinOptions);
-    /**
-     * @returns The coordinate of the pin
-     */
-    getCoordinate(): Coordinate$1;
-    /**
-     * Get the icon for a string key, such as 'default', 'hovered', or 'selected'
-     * @param key - The unique name of the icon
-     * @returns The URL or data URI of the icon image
-     * @see MapPinOptions#withIcon
-     */
-    getIcon(key: string): string;
-    /**
-     * @returns The map that the pin is currently on, or null if
-     * not on a map
-     */
-    getMap(): Map$1 | null;
-    /**
-     * Intended for internal use only
-     * @returns The pin's {@link ProviderPin}
-     *   instance
-     */
-    getProviderPin(): ProviderPin;
-    /**
-     * @returns The string describing the type of pin
-     */
-    getType(): string;
-    /**
-     * Remove this pin from its current map, if on one.
-     */
-    remove(): void;
-    /**
-     * Set a handler function for when the pin is clicked, replacing any previously set click handler.
-     */
-    setClickHandler(clickHandler: PinClickHandler): void;
-    /**
-     * @param coordinate - Must be convertible to {@link Coordinate}
-     */
-    setCoordinate(coordinate: Coordinate$1): void;
-    /**
-     * Set a handler function for when the pin is (un)focused, replacing any previously set focus handler.
-     */
-    setFocusHandler(focusHandler: PinFocusHandler): void;
-    /**
-     * Set a handler function for when the pin is (un)hovered, replacing any previously set hover handler.
-     */
-    setHoverHandler(hoverHandler: PinHoverHandler): void;
-    /**
-     * Add the pin to a map, removing it from its current map if on one.
-     */
-    setMap(map: Map$1 | null): void;
-    /**
-     * Assign all properties in an object to the pin's status.
-     * Example: if the pin's status is \{ a: true, b: true \}, passing in \{ a: false, c: true \} will
-     * change the pin's status to \{ a: false, b: true, c: true \}
-     */
-    setStatus(status: object): void;
-    /**
-     * Add or remove the pin from the map based on whether its coordinate is within the current bounds
-     */
-    _hideIfOffscreen(): void;
-}
-
-type PaddingFunction = () => number;
-type PanHandler = (previousBounds?: GeoBounds, currentBounds?: GeoBounds) => void;
-type PanStartHandler = (currentBounds?: GeoBounds) => void;
-type PaddingObject = {
-    bottom?: number | PaddingFunction;
-    left?: number | PaddingFunction;
-    right?: number | PaddingFunction;
-    top?: number | PaddingFunction;
-};
-/**
- * {@link Map} options class
- */
-declare class MapOptions {
-    controlEnabled: boolean;
-    defaultCenter: Coordinate$1;
-    defaultZoom: number;
-    legendPins: MapPin[];
-    padding: PaddingObject;
-    panHandler: PanHandler;
-    panStartHandler: PanStartHandler;
-    provider: MapProvider | null;
-    providerOptions: ProviderMapOptions | object;
-    singlePinZoom: number;
-    wrapper: HTMLElement | null;
-    iframeWindow: Window | undefined;
-    apiKey: string | undefined;
-    /**
-     * Initialize with default options
-     */
-    constructor();
-    /**
-     * @param controlEnabled - Whether the user can move and zoom the map
-     */
-    withControlEnabled(controlEnabled: boolean): MapOptions;
-    /**
-     * @param defaultCenter - The center on initial load and
-     *   when calling {@link Map#fitCoordinates} with an empty array
-     */
-    withDefaultCenter(defaultCenter: Coordinate$1): MapOptions;
-    /**
-     * @param defaultZoom - The zoom on initial load and when calling {@link Map#fitCoordinates}
-     *   with an empty array
-     */
-    withDefaultZoom(defaultZoom: number): MapOptions;
-    /**
-     * GENERATOR TODO Map legend not yet implemented
-     * @param legendPins - Pins used to construct the map legend
-     */
-    withLegendPins(legendPins: MapPin[]): MapOptions;
-    /**
-     * Padding is used by {@link Map#fitCoordinates}.
-     * Padding can either be constant values or funtions that return a padding value.
-     * See {@link Map#setPadding} for more information.
-     * @see {@link Map#setPadding}
-     */
-    withPadding(padding: {
-        bottom: number | PaddingFunction;
-        left: number | PaddingFunction;
-        right: number | PaddingFunction;
-        top: number | PaddingFunction;
-    }): MapOptions;
-    withPanHandler(panHandler: PanHandler): MapOptions;
-    withPanStartHandler(panStartHandler: PanStartHandler): MapOptions;
-    /**
-     * The {@link MapProvider} must be loaded before
-     * constructing the {@link Map}.
-     */
-    withProvider(provider: MapProvider): MapOptions;
-    /**
-     * @param providerOptions - A free-form object used to set any additional provider-specific
-     *   options in the {@link ProviderMap}
-     */
-    withProviderOptions(providerOptions: object): MapOptions;
-    /**
-     * @param singlePinZoom - The zoom when calling {@link Map#fitCoordinates}
-     *   with an array containing one coordinate
-     */
-    withSinglePinZoom(singlePinZoom: number): MapOptions;
-    /**
-     * @param wrapper - The wrapper element that the map will be inserted into. The
-     *   existing contents of the element will be removed.
-     */
-    withWrapper(wrapper: HTMLElement | null): MapOptions;
-    /**
-     * @param iframeWindow - The window of the iframe that the map will be rendered in.
-     *  This is only necessary if the map is being rendered in an iframe.
-     */
-    withIframeWindow(iframeWindow: Window | undefined): MapOptions;
-    /**
-     * @param apiKey - The API key to use for the map provider, if required.
-     */
-    withApiKey(apiKey: string | undefined): MapOptions;
-    build(): Map$1;
-}
-/**
- * An interactive map that supports various map providers, such as Google Maps and Mapbox, with a
- * single API. Code written using this class functions approximately the same regardless of the map
- * provider used. Any map provider can be supported via an instance of {@link MapProvider}.
- */
-declare class Map$1 {
-    /**
-     * The {@link MapProvider} for the map must be loaded
-     * before calling this constructor.
-     */
-    _defaultCenter: Coordinate$1;
-    _defaultZoom: number;
-    _legendPins: MapPin[];
-    _padding: PaddingObject;
-    _provider: MapProvider | null;
-    _singlePinZoom: number;
-    _wrapper: HTMLElement | null;
-    _cachedBounds: GeoBounds | null;
-    _resolveIdle: () => void;
-    _resolveMoving: () => void;
-    _idlePromise: Promise<void>;
-    _panHandlerRunning: boolean;
-    _panStartHandlerRunning: boolean;
-    _currentBounds: GeoBounds;
-    _movingPromise?: Promise<void>;
-    _panHandler?: PanHandler;
-    _panStartHandler?: PanStartHandler;
-    _map: ProviderMap;
-    constructor(options: MapOptions);
-    /**
-     * Set the map bounds so that all the given coordinates are within the {@link padded}
-     * view.
-     * @param animated - Whether to transition smoothly to the new bounds
-     * @param maxZoom - The max zoom level after fitting. Uses {@link singlePinZoom}
-     *   by default.
-     */
-    fitCoordinates(coordinates: Coordinate$1[], animated?: boolean, maxZoom?: number): void;
-    /**
-     * Get the current visible region of the map. If the map is zoomed out to show multiple copies of
-     * the world, the longitude bounds will be outside [-180, 180) but the center will always be
-     * within [-180, 180).
-     */
-    getBounds(): GeoBounds;
-    /**
-     * @returns The center of the current visible region of
-     *   the map
-     */
-    getCenter(): Coordinate$1;
-    /**
-     * Intended for internal use only
-     * @returns The map's {@link ProviderMap}
-     *   instance
-     */
-    getProviderMap(): ProviderMap;
-    /**
-     * To standardize zoom for all providers, zoom level is calculated with this formula:
-     * zoom = log2(pixel width of equator) - 8.
-     * At zoom = 0, the entire world is 256 pixels wide.
-     * At zoom = 1, the entire world is 512 pixels wide.
-     * Zoom 2 → 1024 pixels, zoom 3 → 2056 pixels, etc.
-     * Negative and non-integer zoom levels are valid and follow the formula.
-     * @returns The current zoom level of the map
-     */
-    getZoom(): number;
-    /**
-     * Returns when the map is not moving.
-     * Use map.idle().then(callback) to run callback immediately if the map is currently idle or once
-     * the map becomes idle if it's not.
-     */
-    idle(): Promise<void>;
-    /**
-     * Returns when the map is moving.
-     * Use map.moving().then(callback) to run callback immediately if the map is currently moving or
-     * once the map starts moving if it's not.
-     */
-    moving(): Promise<void>;
-    /**
-     * @returns A {@link MapPinOptions}
-     *   instance with the same provider as this map
-     */
-    newPinOptions(): MapPinOptions;
-    /**
-     * Called when the map has finished moving, at most once per animation frame.
-     * Passes the current and previous bounds to the custom pan handler given by {@link MapOptions#withPanHandler}
-     */
-    panHandler(): void;
-    /**
-     * Called when the map has started moving, at most once per animation frame.
-     * Passes the current bounds to the custom pan handler given by {@link MapOptions#withPanStartHandler}
-     */
-    panStartHandler(): void;
-    /**
-     * @param bounds - bounds.ne: The northeast corner of the bounds -- must be convertible to {@link Coordinate}
-     * bounds.se: The southwest corner of the bounds -- must be convertible to {@link Coordinate}
-     * @param animated - Whether to transition smoothly to the new bounds
-     * @param padding - padding.bottom: Minimum number of pixels between the map's bottom edge and a pin
-     * padding.left: Minimum number of pixels between the map's left edge and a pin
-     * padding.right: Minimum number of pixels between the map's right edge and a pin
-     * padding.top: Minimum number of pixels between the map's top edge and a pin
-     */
-    setBounds({ ne, sw }: GeoBounds, animated?: boolean, padding?: {
-        bottom?: number | PaddingFunction;
-        left?: number | PaddingFunction;
-        right?: number | PaddingFunction;
-        top?: number | PaddingFunction;
-    }, maxZoom?: number): void;
-    /**
-     * @param coordinate - Must be convertible to {@link Coordinate}
-     * @param animated - Whether to transition smoothly to the new center
-     */
-    setCenter(coordinate: object, animated?: boolean): void;
-    /**
-     * Padding is used by {@link Map#fitCoordinates}.
-     * Padding can either be constant values or funtions that return a padding value.
-     * Constant values are good if the map should always have the same padding on every breakpoint.
-     * Functions are useful if the map should have different padding at different breakpoints/layouts.
-     * The function can check window.innerWidth or any other condition before returning a number.
-     * @param padding - padding.bottom: Minimum number of pixels between the map's bottom edge and a pin
-     * padding.left: Minimum number of pixels between the map's left edge and a pin
-     * padding.right: Minimum number of pixels between the map's right edge and a pin
-     * padding.top: Minimum number of pixels between the map's top edge and a pin
-     */
-    setPadding({ bottom, left, right, top, }: {
-        bottom?: number | PaddingFunction;
-        left?: number | PaddingFunction;
-        right?: number | PaddingFunction;
-        top?: number | PaddingFunction;
-    }): Map$1;
-    setPanHandler(panHandler: PanHandler): void;
-    setPanStartHandler(panStartHandler: PanStartHandler): void;
-    /**
-     * @param animated - Whether to transition smoothly to the new zoom
-     * @see Map#getZoom
-     */
-    setZoom(zoom: number, animated?: boolean): void;
-    /**
-     * @param center - Must be convertible to {@link Coordinate}
-     * @param animated - Whether to transition smoothly to the new bounds
-     * @see Map#setZoom
-     * @see Map#setCenter
-     */
-    setZoomCenter(zoom: number, center: Coordinate$1, animated?: boolean): void;
-    /**
-     * Set the map state to idle
-     */
-    _setIdle(): void;
-    /**
-     * Set the map state to moving
-     */
-    _setMoving(): void;
-}
-
-interface Coordinate {
-    latitude: number;
-    longitude: number;
-}
-interface MapContextType {
-    map: Map$1;
-    provider: MapProvider;
-}
-interface MapProps {
-    apiKey?: string;
-    bounds?: Coordinate[];
-    className?: string;
-    clientKey?: string;
-    children?: any;
-    controls?: boolean;
-    defaultCenter?: Coordinate;
-    defaultZoom?: number;
-    mapRef?: React__default.MutableRefObject<Map$1 | null>;
-    padding?: {
-        bottom: number | PaddingFunction;
-        left: number | PaddingFunction;
-        right: number | PaddingFunction;
-        top: number | PaddingFunction;
-    };
-    panHandler?: PanHandler;
-    panStartHandler?: PanStartHandler;
-    provider?: MapProvider;
-    providerOptions?: {
-        [key: string]: any;
-    };
-    singleZoom?: number;
-    iframeId?: string;
-}
-interface MarkerProps {
-    children?: React__default.ReactElement;
-    coordinate: Coordinate;
-    hideOffscreen?: boolean;
-    icon?: React__default.ReactElement;
-    id: string;
-    onClick?: (id: string) => void;
-    onHover?: (hovered: boolean, id: string) => void;
-    onFocus?: (focused: boolean, id: string) => void;
-    statusOptions?: {
-        [key: string]: boolean;
-    };
-    zIndex?: number;
-    hasPinUrl?: boolean;
-}
-type ClusterTemplateProps = {
-    count?: number;
-};
-type ClustererProps = {
-    clusterRadius?: number;
-    children: React__default.ReactElement[] | React__default.ReactElement;
-    ClusterTemplate?: (props: ClusterTemplateProps) => React__default.ReactElement;
-};
-type PinStoreType = {
-    id: string;
-    pin: MapPin;
-};
-interface ClustererContextType {
-    clusters: PinStoreType[][];
-    clusterIds: string[];
-    setPinStore: React__default.Dispatch<React__default.SetStateAction<PinStoreType[]>>;
-}
-
-declare function useMapContext(): Map$1;
-declare const Map: ({ apiKey, bounds, children, className, clientKey, controls, defaultCenter, defaultZoom, mapRef, padding, panHandler, panStartHandler, provider, providerOptions, singleZoom, iframeId, }: MapProps) => react_jsx_runtime.JSX.Element;
-
-declare const Marker: ({ children, coordinate, hideOffscreen, id, icon, onClick, onFocus, onHover, zIndex, hasPinUrl, }: MarkerProps) => React__default.ReactElement | null;
-
-declare function useClusterContext(): ClustererContextType;
-declare const Clusterer: ({ clusterRadius, children, ClusterTemplate, }: ClustererProps) => react_jsx_runtime.JSX.Element;
-
-interface LocationMapProps extends MapProps {
-    children?: React.ReactElement;
-    coordinate: Coordinate;
-    linkSameTab?: boolean;
-    pinUrl?: string;
-    onClick?: (id: string) => void;
-    onHover?: (hovered: boolean, id: string) => void;
-    onFocus?: (focused: boolean, id: string) => void;
-}
-
-declare const LocationMap: ({ children, coordinate, linkSameTab, pinUrl, onClick, onHover, onFocus, ...mapProps }: LocationMapProps) => react_jsx_runtime.JSX.Element;
-
-/**
- * The shape of data passed to {@link LexicalRichText}.
- */
-interface LexicalRichTextProps {
-    /** A JSON-serialized Lexical Dev AST. */
-    serializedAST: string;
-    /** CSS Class names for the various Lexical Node types. */
-    nodeClassNames?: EditorThemeClasses;
-}
-
-/**
- * @deprecated Use the stream's .html version instead with `dangerouslySetInnerHTML`.
- * ```jsx
- * <div dangerouslySetInnerHTML={{ __html: c_lrt.html }} />
- * ```
- *
- * Renders a read-only view of a Lexical Rich Text field. Styling for the various
- * types of Rich Text element can be optionally provided. If not provided, Yext default
- * styling will be applied.
- *
- * Note: This component currently only supports rendering on the client side.
- */
-declare function LexicalRichText({ serializedAST, nodeClassNames, }: LexicalRichTextProps): react_jsx_runtime.JSX.Element;
-
-/**
- * A Component for rendering the legacy rich text field. This field's value
- * is stored as "Yext" Markdown.
- */
-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;
-    wednesday?: DayType;
-    thursday?: DayType;
-    friday?: DayType;
-    saturday?: DayType;
-    sunday?: DayType;
-}
-interface DayType {
-    isClosed?: boolean;
-    openIntervals?: IntervalType[];
-}
-interface HolidayType extends DayType {
-    date: string;
-    isRegularHours?: boolean;
-}
-interface IntervalType {
-    start: string;
-    end: string;
-}
-interface HoursType extends WeekType {
-    holidayHours?: HolidayType[];
-    reopenDate?: string;
-}
-type DayOfWeekNames = {
-    [Property in keyof WeekType]?: string;
-};
-interface HoursTableProps {
-    /** Hours data from Yext Streams */
-    hours: HoursType;
-    /** Label for each day of week, ordered starting from Sunday */
-    dayOfWeekNames?: DayOfWeekNames;
-    /** Set the day of the first row of the table */
-    startOfWeek?: keyof DayOfWeekNames | "today";
-    timeOptions?: Intl.DateTimeFormatOptions;
-    /** Combine adjacent rows (days) with the same intervals */
-    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[];
-    isToday: boolean;
-    startDay: Day;
-    endDay: Day;
-}
-declare enum Day {
-    Monday = "MONDAY",
-    Tuesday = "TUESDAY",
-    Wednesday = "WEDNESDAY",
-    Thursday = "THURSDAY",
-    Friday = "FRIDAY",
-    Saturday = "SATURDAY",
-    Sunday = "SUNDAY"
-}
-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 {
-    /** 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;
-    /** 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>;
-
-declare const SchemaWrapper: (json: any) => string;
-
-declare const BaseSchema: (document: Record<string, any>, schemaType: string) => {
-    "@context": string;
-    "@type": string;
-    name: string;
-} | undefined;
-
-declare const Event: (document: Record<string, any>, schemaType?: string) => any;
-
-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 | undefined;
-    "@type"?: string | undefined;
-    name?: string | undefined;
-} | {
-    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 | undefined;
-    "@type"?: string | undefined;
-    name?: string | undefined;
-} | {
-    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 | undefined;
-    "@type"?: string | undefined;
-    name?: string | undefined;
-} | {
-    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 | undefined;
-    "@type"?: string | undefined;
-    name?: string | undefined;
-};
-
-declare const Product: (document: Record<string, any>, schemaType?: string) => any;
-
-type RTF2 = {
-    json?: Record<string, any>;
-};
-type FAQ = PlainTextFAQ | RichTextFAQ;
-type PlainTextFAQ = {
-    question: string;
-    answer: string;
-};
-type RichTextFAQ = {
-    question: string;
-    answerV2: RTF2;
-};
-declare function getRichTextContent(answer: RTF2): string;
-declare const FAQPage: (data: FAQ[]) => {
-    "@context": string;
-    "@type": string;
-    mainEntity: ({
-        "@type": string;
-        name: string;
-        acceptedAnswer: {
-            "@type": string;
-            text: string;
-        };
-    } | undefined)[];
-} | undefined;
-
-type Location = {
-    name?: string;
-    address?: AddressType;
-};
-declare const AddressSchema: (address?: AddressType) => false | {
-    address: {
-        "@type": string;
-        streetAddress: string;
-        addressLocality: string;
-        addressRegion: string | undefined;
-        postalCode: string;
-        addressCountry: string;
-    };
-};
-declare const LocationSchema: (location?: Location) => false | {
-    address?: {
-        "@type": string;
-        streetAddress: string;
-        addressLocality: string;
-        addressRegion: string | undefined;
-        postalCode: string;
-        addressCountry: string;
-    } | undefined;
-    "@type": string;
-    name: string | undefined;
-};
-
-type OpeningHoursSpecification = {
-    "@type": "OpeningHoursSpecification";
-    dayOfWeek?: string | string[];
-    opens?: string;
-    closes?: string;
-    validFrom?: string;
-    validThrough?: string;
-};
-declare const OpeningHoursSchema: (hours?: HoursType) => {
-    openingHours?: undefined;
-} | {
-    openingHours: string[];
-};
-declare const OpeningHoursSpecificationSchema: (hours?: HoursType) => {
-    openingHoursSpecification?: OpeningHoursSpecification[];
-    specialOpeningHoursSpecification?: OpeningHoursSpecification[];
-};
-
-type Offer = {
-    url?: string;
-    priceCurrency?: string;
-    price?: string;
-    priceValidUntil?: string;
-    itemCondition?: string;
-    availability?: (typeof availabilityOptions)[number];
-};
-declare const availabilityOptions: string[];
-declare const OfferSchema: (offer?: Offer) => false | {
-    offers: {
-        "@type": string;
-        url: string | undefined;
-        priceCurrency: string | undefined;
-        price: string | undefined;
-        priceValidUntil: string | undefined;
-        itemCondition: string | undefined;
-        availability: string | undefined;
-    };
-};
-
-type Organization = {
-    name?: string;
-    url?: string;
-};
-declare const PerformerSchema: (performers?: string[]) => false | {
-    performer: {
-        "@type": string;
-        name: string;
-    };
-};
-declare const OrganizationSchema: (org?: Organization) => false | {
-    organizer: {
-        url?: string | undefined;
-        "@type": string;
-        name: string | undefined;
-    };
-};
-
-type PhotoGallery = Photo[];
-type Photo = {
-    image: ImageType;
-};
-declare const PhotoGallerySchema: (gallery?: PhotoGallery) => {
-    image?: undefined;
-} | {
-    image: string[];
-};
-declare const PhotoSchema: (photo?: Photo) => false | {
-    image: string;
-};
-
-type Review = {
-    ratingValue?: string;
-    bestRating?: string;
-    author?: string;
-};
-type AggregateRating = {
-    ratingValue?: string;
-    reviewCount?: string;
-};
-declare const ReviewSchema: (review?: Review) => false | {
-    review: {
-        author?: {
-            "@type": string;
-            name: string;
-        } | undefined;
-        "@type": string;
-        reviewRating: {
-            "@type": string;
-            ratingValue: string | undefined;
-            bestRating: string | undefined;
-        };
-    };
-};
-declare const AggregateRatingSchema: (rating?: AggregateRating) => {
-    aggregateRating: {
-        "@type": string;
-        ratingValue: string | undefined;
-        reviewCount: string | undefined;
-    };
-} | undefined;
-
-declare const BaiduMaps: MapProvider;
-
-declare const BingMaps: MapProvider;
-
-declare const GoogleMaps: MapProvider;
-
-declare const MapboxMaps: MapProvider;
-
-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, type HoursStatusProps, HoursTable, type HoursTableDayData, type HoursTableIntervalTranslations, type HoursTableProps, type HoursType, Image, type ImageLayout, ImageLayoutOption, type ImageProps, type ImageTransformations, 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, OpeningHoursSpecificationSchema, 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, getImageUrl, getRichTextContent, useAnalytics, useClusterContext, useIdentify, useMapContext, usePageView, useScope, useTrack };