@mappedin/mappedin-js 5.45.1 → 5.46.0

package/lib/esm/get-venue/index.d.ts

@@ -949,6 +949,51 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/MappedinLocation' {
                 */
             get parent(): MappedinLocation | undefined;
             set parent(parent: MappedinLocation | undefined);
+            /**
+                * Specific instances of this location with different properties.
+                * Typically, there will be at least one node or polygon defined,
+                * plus one or more other properties that are different from the parent.
+                * The remaining properties will be the same as the parent.
+                * For example, suppose there is a location like this:
+                *
+                * ```json
+                * {
+                *   "id": "location-id-1",
+                *   "name": "Location 1",
+                *   "nodes": ["node-1", "node-2"],
+                *   "polygons": ["polygon-1", "polygon-2"],
+                *   "externalId": "externalId-1",
+                *   "description": "Description 1",
+                * }
+                * ```
+                *
+                * (Note that for clarity, we have put strings in for nodes and polygons, but in practice they would be objects.)
+                *
+                * Then suppose it had an `instances` array that contained an object that looked like this:
+                *
+                * ```json
+                * {
+                *   "id": "instance-id-1",
+                *   "name": "Location 1 - A",
+                *   "nodes": ["node-1"],
+                *   "polygons": ["polygon-1"],
+                *   "externalId": "externalId-1-A",
+                *   "description": "Description 1",
+                * }
+                * ```
+                * This says "Location 1" is the parent location, and "Location 1 - A" is an instance of it. The instance has a different name, and a different external ID, and it only applies to node `node-1` and polygon `polygon-1`.
+                * The ID will always be different, but other properties (like the description) are the same as the parent.
+                *
+                * Example use cases:
+                * - A Mall may have a location with two nodes and one polygon. It may then have an instance with one of the nodes, and operating hours
+                * that are different from the parent. This indicates that this instance is an entrance for the location that is accessible at different times, perhaps for an interior mall entrance, when the main location (and other, exterior entrance) is open later than the rest of the mall.
+                * - An airport may have a location with several polygons and nodes, and an instance for each node (and corresponding polygon, if any) with a different siblingGroup. The location in the sibling group may be the airport terminal, or airside vs landside.
+                * This would allow an application to show the location once in a search result, but offer UX to select the instance that is in the right terminal.
+                *
+                * Note: Instances are actual EnterpriseLocations. This means they have all the properties of a normal EnterpriseLocation, including an `instances` property, that will always be undefined. They also do NOT have a parent property, or any other explicit reference to the parent location. These instances are
+                * only referenced from their parent location, and will not show up in other places in the map data. However, they should otherwise behave like normal EnterpriseLocations, being targetable for things like navigation and focus.
+                */
+            get instances(): MappedinLocation[];
             /**
                 * Categories related to this location.
                 *