Type Alias CMSProperties

Interface

type CMSProperties = {
    venue?: {
        defaultLanguage: { code: string; name: string };
        id: `ev_${string}`;
        languages: { code: string; name: string }[];
        slug: string;
        countrycode?: string;
        coverImage?: string;
        logo?: string;
        mappedinWebUrl?: string;
        operationHours?: {
            "@type"?: "OpeningHoursSpecification";
            closes?: string;
            dayOfWeek?:
                | "Sunday"
                | "Monday"
                | "Tuesday"
                | "Wednesday"
                | "Thursday"
                | "Friday"
                | "Saturday"
                | "PublicHolidays"
                | ((...) | (...) | (...) | (...) | (...) | (...) | (...) | (...))[];
            opens?: string;
            validFrom?: string;
            validThrough?: string;
        }[];
        topLocations?: `loc_${string}`[];
    } & {
        details: { name: string } & {
            description?: string;
            externalId?: string;
            icon?: string;
            shortName?: string;
        };
    } & { extra?: { [key: string]: unknown } };
    locations?: {
        cmsId: string;
        id: `el_${string}`;
        locationId: `loc_${string}`;
        sortOrder: number;
        type: string;
        amenity?: string;
        gallery?: { image: string; caption?: string; embeddedUrl?: string }[];
        picture?: string;
        primaryCategory?: `lcat_${string}`;
        showFloatingLabelWhenImagePresent?: boolean;
        showLogo?: boolean;
        siblingGroups?: { label: string; siblings: `loc_${string}`[] }[];
        states?: {
            type:
                | "closed-temporarily"
                | "new"
                | "pop-up"
                | "coming-soon"
                | "relocated"
                | "unknown";
            end?: string;
            start?: string;
        }[];
        tags?: string[];
    }[];
    locationInstances?: (
        {
            id: `eli_${string}`;
            locationInstanceId: `loci_${string}`;
            parentId: `el_${string}`;
        } & {
            amenity?: string;
            cmsId?: string;
            gallery?: { image: string; caption?: string; embeddedUrl?: string }[];
            picture?: string;
            primaryCategory?: `lcat_${string}`;
            showFloatingLabelWhenImagePresent?: boolean;
            showLogo?: boolean;
            siblingGroups?: { label: string; siblings: `loc_${(...)}`[] }[];
            sortOrder?: number;
            states?: {
                type:
                    | "closed-temporarily"
                    | "new"
                    | "pop-up"
                    | "coming-soon"
                    | "relocated"
                    | "unknown";
                end?: string;
                start?: string;
            }[];
            tags?: string[];
            type?: string;
        }
    )[];
    categories?: {
        categoryId: `lcat_${string}`;
        id: `ec_${string}`;
        sortOrder: number;
        color?: string;
        iconFromDefaultList?: null
        | string;
        picture?: string;
    }[];
    textures?: {
        [key: `f_${string}`]: (
            {
                bounds: [number, number, number, number];
                face: "unknown" | "top" | "side";
                offset: { u: number; v: number };
                path: string;
                repeat: { u: number; v: number };
                rotation: number;
                surface: "unknown" | "inside" | "outside" | "both";
            } & { geometryId: `g_${string}` }
        )[];
    };
    floorText?: {
        [key: `f_${string}`]: {
            features: {
                geometry: { coordinates: [number, number]; type: "Point" };
                properties:
                    | {
                        align: (...)
                        | (...)
                        | (...)
                        | (...);
                        color: string;
                        fontFamily: string;
                        fontSize: number;
                        id: `eft_${(...)}`;
                        rotation: number;
                        text: string;
                        visible: boolean;
                    } & { geometryId: `g_${(...)}` }
                    | {
                        align: (...) | (...) | (...) | (...);
                        color: string;
                        fontFamily: string;
                        fontSize: number;
                        id: `eft_${(...)}`;
                        rotation: number;
                        text: string;
                        visible: boolean;
                    } & { verticalOffset: number };
                type: "Feature";
            }[];
            type: "FeatureCollection";
        };
    };
    layers?: Partial<
        { [key: `f_${string}`]: Partial<{ [key: `g_${string}`]: string }> },
    >;
    textAreas?: {
        [key: `f_${string}`]: {
            features: {
                geometry: { coordinates: [number, number]; type: "Point" };
                properties:
                    | {
                        align: (...)
                        | (...)
                        | (...);
                        maxHeight: number;
                        maxWidth: number;
                        rotation: number;
                    } & { geometryId: `g_${(...)}` }
                    | {
                        align: (...) | (...) | (...);
                        maxHeight: number;
                        maxWidth: number;
                        rotation: number;
                    } & { verticalOffset: number };
                type: "Feature";
            }[];
            type: "FeatureCollection";
        };
    };
}

Index

Properties

venue? locations? locationInstances? categories? textures? floorText? layers? textAreas?

Properties

`Optional`venue

venue?: {
    defaultLanguage: { code: string; name: string };
    id: `ev_${string}`;
    languages: { code: string; name: string }[];
    slug: string;
    countrycode?: string;
    coverImage?: string;
    logo?: string;
    mappedinWebUrl?: string;
    operationHours?: {
        "@type"?: "OpeningHoursSpecification";
        closes?: string;
        dayOfWeek?:
            | "Sunday"
            | "Monday"
            | "Tuesday"
            | "Wednesday"
            | "Thursday"
            | "Friday"
            | "Saturday"
            | "PublicHolidays"
            | ((...) | (...) | (...) | (...) | (...) | (...) | (...) | (...))[];
        opens?: string;
        validFrom?: string;
        validThrough?: string;
    }[];
    topLocations?: `loc_${string}`[];
} & {
    details: { name: string } & {
        description?: string;
        externalId?: string;
        icon?: string;
        shortName?: string;
    };
} & { extra?: { [key: string]: unknown } }

Type declaration

defaultLanguage: { code: string; name: string }
The venue's default language name and code
id: `ev_${string}`
The venue's unique identifier
languages: { code: string; name: string }[]
The venue's supported languages. Includes the default language. Typically if a venue has multiple languages, at least SOME data will be set in each language, which means there will generally be a Locale Pack for each language.

However, there is no guarantee that localized data has actually been added in a given language.
slug: string
The venue's unique slug. This is typically the key used to identify the venue.
Optionalcountrycode?: string
The ISO 3166-1 alpha-2 country code of the venue, if known

Eg. CA or US
OptionalcoverImage?: string
The venue's cover image.

Format
uri
Optionallogo?: string
The venue's logo

Format
uri
OptionalmappedinWebUrl?: string
The base URL for Mappedin Web for this venue.

Format
uri
OptionaloperationHours?: {
    "@type"?: "OpeningHoursSpecification";
    closes?: string;
    dayOfWeek?:
        | "Sunday"
        | "Monday"
        | "Tuesday"
        | "Wednesday"
        | "Thursday"
        | "Friday"
        | "Saturday"
        | "PublicHolidays"
        | ((...) | (...) | (...) | (...) | (...) | (...) | (...) | (...))[];
    opens?: string;
    validFrom?: string;
    validThrough?: string;
}[]
The venue's operation hours.
OptionaltopLocations?: `loc_${string}`[]
The locations that are considered the "top" locations for this venue.

Usually used in a quick-access menu in applications to show the most important locations in the venue.

Note: These point to Locations not the EnterpriseLocations.

details: { name: string } & {
    description?: string;
    externalId?: string;
    icon?: string;
    shortName?: string;
}

Optionalextra?: { [key: string]: unknown }
{@inheritDoc utility-types/extra!Extra}

See
Extra

`Optional`locations

locations?: {
    cmsId: string;
    id: `el_${string}`;
    locationId: `loc_${string}`;
    sortOrder: number;
    type: string;
    amenity?: string;
    gallery?: { image: string; caption?: string; embeddedUrl?: string }[];
    picture?: string;
    primaryCategory?: `lcat_${string}`;
    showFloatingLabelWhenImagePresent?: boolean;
    showLogo?: boolean;
    siblingGroups?: { label: string; siblings: `loc_${string}`[] }[];
    states?: {
        type:
            | "closed-temporarily"
            | "new"
            | "pop-up"
            | "coming-soon"
            | "relocated"
            | "unknown";
        end?: string;
        start?: string;
    }[];
    tags?: string[];
}[]

Type declaration

cmsId: string
The original CMS ID of the EnterpriseLocation
id: `el_${string}`
locationId: `loc_${string}`
The ID of the Location that has most of the EnterpriseLocation's data
sortOrder: number
type: string
The type of the location, like amenity, tenant, etc.
Optionalamenity?: string
The location's amenity type. Only set if the location is an amenity
Optionalgallery?: { image: string; caption?: string; embeddedUrl?: string }[]
A gallery of images for a location. May be a mix of promotional images, or images of the location itself. Caption should be supplied for accessibility purposes, since it will not be clear from context what the image represents.
Optionalpicture?: string
A photograph of the location, used as a visual aid during navigation.

Format
uri
OptionalprimaryCategory?: `lcat_${string}`
The main category of the location. It must be one of the categories in the Location's categories array
OptionalshowFloatingLabelWhenImagePresent?: boolean
Whether to show the flat label when an image is present on the polygon a location is anchored to. This is often set to false for anchor stores in malls, since they often have a large logo image placed directly on their polygon.
OptionalshowLogo?: boolean
Whether to show the logo of the location
OptionalsiblingGroups?: { label: string; siblings: `loc_${string}`[] }[]
Locations that are related to this location in some manner (described by the label).

In airports, locations will typically get SiblingGroups with a label of "REFERENCE_POINT" linking to locations like "Terminal 1" and "Airside" to indicate which zone they are in, but SiblingGroups can be used for any type of relationship between locations.

Note this links to the LocationId, not the EnterpriseLocationId.
Optionalstates?: {
    type:
        | "closed-temporarily"
        | "new"
        | "pop-up"
        | "coming-soon"
        | "relocated"
        | "unknown";
    end?: string;
    start?: string;
}[]
The location's state. No more than one state should be active at a time, and all but at most one should have dates set
Optionaltags?: string[]
Tags are used primarily as keywords to match against when searching. They are typically not used for display.

`Optional`locationInstances

locationInstances?: (
    {
        id: `eli_${string}`;
        locationInstanceId: `loci_${string}`;
        parentId: `el_${string}`;
    } & {
        amenity?: string;
        cmsId?: string;
        gallery?: { image: string; caption?: string; embeddedUrl?: string }[];
        picture?: string;
        primaryCategory?: `lcat_${string}`;
        showFloatingLabelWhenImagePresent?: boolean;
        showLogo?: boolean;
        siblingGroups?: { label: string; siblings: `loc_${(...)}`[] }[];
        sortOrder?: number;
        states?: {
            type:
                | "closed-temporarily"
                | "new"
                | "pop-up"
                | "coming-soon"
                | "relocated"
                | "unknown";
            end?: string;
            start?: string;
        }[];
        tags?: string[];
        type?: string;
    }
)[]

Type declaration

id: `eli_${string}`
The unique ID for this Enterprise Location Instance. This ID might be ephemeral and is really only for localization.
locationInstanceId: `loci_${string}`
The LocationInstance that will have any Location instance properties set, in particular geometryAnchors.
parentId: `el_${string}`
The parent Enterprise Location for this Enterprise Location Instance.

Optionalamenity?: string
The location's amenity type. Only set if the location is an amenity
OptionalcmsId?: string
The original CMS ID of the EnterpriseLocation
Optionalgallery?: { image: string; caption?: string; embeddedUrl?: string }[]
A gallery of images for a location. May be a mix of promotional images, or images of the location itself. Caption should be supplied for accessibility purposes, since it will not be clear from context what the image represents.
Optionalpicture?: string
A photograph of the location, used as a visual aid during navigation.

Format
uri
OptionalprimaryCategory?: `lcat_${string}`
The main category of the location. It must be one of the categories in the Location's categories array
OptionalshowFloatingLabelWhenImagePresent?: boolean
Whether to show the flat label when an image is present on the polygon a location is anchored to. This is often set to false for anchor stores in malls, since they often have a large logo image placed directly on their polygon.
OptionalshowLogo?: boolean
Whether to show the logo of the location
OptionalsiblingGroups?: { label: string; siblings: `loc_${(...)}`[] }[]
Locations that are related to this location in some manner (described by the label).

In airports, locations will typically get SiblingGroups with a label of "REFERENCE_POINT" linking to locations like "Terminal 1" and "Airside" to indicate which zone they are in, but SiblingGroups can be used for any type of relationship between locations.

Note this links to the LocationId, not the EnterpriseLocationId.
OptionalsortOrder?: number
Optionalstates?: {
    type:
        | "closed-temporarily"
        | "new"
        | "pop-up"
        | "coming-soon"
        | "relocated"
        | "unknown";
    end?: string;
    start?: string;
}[]
The location's state. No more than one state should be active at a time, and all but at most one should have dates set
Optionaltags?: string[]
Tags are used primarily as keywords to match against when searching. They are typically not used for display.
Optionaltype?: string
The type of the location, like amenity, tenant, etc.

`Optional`textures

textures?: {
    [key: `f_${string}`]: (
        {
            bounds: [number, number, number, number];
            face: "unknown" | "top" | "side";
            offset: { u: number; v: number };
            path: string;
            repeat: { u: number; v: number };
            rotation: number;
            surface: "unknown" | "inside" | "outside" | "both";
        } & { geometryId: `g_${string}` }
    )[];
}

`Optional`floorText

floorText?: {
    [key: `f_${string}`]: {
        features: {
            geometry: { coordinates: [number, number]; type: "Point" };
            properties:
                | {
                    align: (...)
                    | (...)
                    | (...)
                    | (...);
                    color: string;
                    fontFamily: string;
                    fontSize: number;
                    id: `eft_${(...)}`;
                    rotation: number;
                    text: string;
                    visible: boolean;
                } & { geometryId: `g_${(...)}` }
                | {
                    align: (...) | (...) | (...) | (...);
                    color: string;
                    fontFamily: string;
                    fontSize: number;
                    id: `eft_${(...)}`;
                    rotation: number;
                    text: string;
                    visible: boolean;
                } & { verticalOffset: number };
            type: "Feature";
        }[];
        type: "FeatureCollection";
    };
}

`Optional`layers

layers?: Partial<
{ [key: `f_${string}`]: Partial<{ [key: `g_${string}`]: string }> },
>

`Optional`textAreas

textAreas?: {
    [key: `f_${string}`]: {
        features: {
            geometry: { coordinates: [number, number]; type: "Point" };
            properties:
                | {
                    align: (...)
                    | (...)
                    | (...);
                    maxHeight: number;
                    maxWidth: number;
                    rotation: number;
                } & { geometryId: `g_${(...)}` }
                | {
                    align: (...) | (...) | (...);
                    maxHeight: number;
                    maxWidth: number;
                    rotation: number;
                } & { verticalOffset: number };
            type: "Feature";
        }[];
        type: "FeatureCollection";
    };
}

Type Alias CMSProperties

Interface

Index

Properties

Properties

Optionalvenue

Type declaration

defaultLanguage: { code: string; name: string }

id: `ev_${string}`

languages: { code: string; name: string }[]

slug: string

Optionalcountrycode?: string

OptionalcoverImage?: string

Format

Optionallogo?: string

Format

OptionalmappedinWebUrl?: string

Format

OptionaltopLocations?: `loc_${string}`[]

details: { name: string } & { description?: string; externalId?: string; icon?: string; shortName?: string;}

Optionalextra?: { [key: string]: unknown }

See

Optionallocations

Type declaration

cmsId: string

id: `el_${string}`

locationId: `loc_${string}`

sortOrder: number

type: string

Optionalamenity?: string

Optionalgallery?: { image: string; caption?: string; embeddedUrl?: string }[]

Optionalpicture?: string

Format

OptionalprimaryCategory?: `lcat_${string}`

OptionalshowFloatingLabelWhenImagePresent?: boolean

OptionalshowLogo?: boolean

OptionalsiblingGroups?: { label: string; siblings: `loc_${string}`[] }[]

Optionalstates?: { type: | "closed-temporarily" | "new" | "pop-up" | "coming-soon" | "relocated" | "unknown"; end?: string; start?: string;}[]

Optionaltags?: string[]

OptionallocationInstances

Type declaration

id: `eli_${string}`

locationInstanceId: `loci_${string}`

parentId: `el_${string}`

Optionalamenity?: string

OptionalcmsId?: string

Optionalgallery?: { image: string; caption?: string; embeddedUrl?: string }[]

Optionalpicture?: string

Format

OptionalprimaryCategory?: `lcat_${string}`

OptionalshowFloatingLabelWhenImagePresent?: boolean

OptionalshowLogo?: boolean

OptionalsiblingGroups?: { label: string; siblings: `loc_${(...)}`[] }[]

OptionalsortOrder?: number

Optionalstates?: { type: | "closed-temporarily" | "new" | "pop-up" | "coming-soon" | "relocated" | "unknown"; end?: string; start?: string;}[]

Optionaltags?: string[]

Optionaltype?: string

Optionalcategories

Optionaltextures

OptionalfloorText

Optionallayers

OptionaltextAreas

Settings

On This Page

`Optional`venue

`Optional`countrycode?: string

`Optional`coverImage?: string

`Optional`logo?: string

`Optional`mappedinWebUrl?: string

`Optional`topLocations?: `loc_${string}`[]

details: { name: string } & {
description?: string;
externalId?: string;
icon?: string;
shortName?: string;
}

`Optional`extra?: { [key: string]: unknown }

`Optional`locations

`Optional`amenity?: string

`Optional`gallery?: { image: string; caption?: string; embeddedUrl?: string }[]

`Optional`picture?: string

`Optional`primaryCategory?: `lcat_${string}`

`Optional`showFloatingLabelWhenImagePresent?: boolean

`Optional`showLogo?: boolean

`Optional`siblingGroups?: { label: string; siblings: `loc_${string}`[] }[]

`Optional`states?: {
type:
| "closed-temporarily"
| "new"
| "pop-up"
| "coming-soon"
| "relocated"
| "unknown";
end?: string;
start?: string;
}[]

`Optional`tags?: string[]

`Optional`locationInstances

`Optional`amenity?: string

`Optional`cmsId?: string

`Optional`gallery?: { image: string; caption?: string; embeddedUrl?: string }[]

`Optional`picture?: string

`Optional`primaryCategory?: `lcat_${string}`

`Optional`showFloatingLabelWhenImagePresent?: boolean

`Optional`showLogo?: boolean

`Optional`siblingGroups?: { label: string; siblings: `loc_${(...)}`[] }[]

`Optional`sortOrder?: number

`Optional`states?: {
type:
| "closed-temporarily"
| "new"
| "pop-up"
| "coming-soon"
| "relocated"
| "unknown";
end?: string;
start?: string;
}[]

`Optional`tags?: string[]

`Optional`type?: string

`Optional`categories

`Optional`textures

`Optional`floorText

`Optional`layers

`Optional`textAreas