venue-js 1.4.0-next.3 → 1.4.0-next.5

package/dist/index.d.mts

@@ -1,13 +1,13 @@
 import { QueryClient, QueryObserver, EnsureQueryDataOptions } from '@tanstack/query-core';
 export { QueryObserver } from '@tanstack/query-core';
 import * as geojson from 'geojson';
-import { Position, Geometry, GeoJsonProperties, Feature, Point, Polygon, MultiPolygon, LineString, GeometryCollection } from 'geojson';
+import { Position, Geometry, GeoJsonProperties, Feature, Point, Polygon, MultiPolygon, LineString, MultiLineString, GeometryCollection } from 'geojson';
 import * as maptalks_dist_core_Class from 'maptalks/dist/core/Class';
 import * as maptalks$1 from 'maptalks-gl';
 import { Map, Coordinate as Coordinate$1 } from 'maptalks-gl';
 import { BaseObject, ThreeLayer } from 'maptalks.three';
 import * as maptalks from 'maptalks';
-import { Coordinate, Extent, Marker, ui, LineString as LineString$1, Polygon as Polygon$1, MultiPolygon as MultiPolygon$1, MultiLineString } from 'maptalks';
+import { Coordinate, Extent, Marker, ui, LineString as LineString$1, Polygon as Polygon$1, MultiPolygon as MultiPolygon$1, MultiLineString as MultiLineString$1 } from 'maptalks';
 import { BaseObjectOptionType, BarOptionType, ExtrudePolygonOptionType, ExtrudeLineOptionType } from 'maptalks.three/dist/type';
 import { PolygonOptionsType } from 'maptalks/dist/geometry/Polygon';
 import { LineStringOptionsType } from 'maptalks/dist/geometry/LineString';
@@ -113,7 +113,7 @@ type DetailProperties = {
     [k: string]: any;
 };
 type DetailFeature = ImdfFeature<DetailGeometry, DetailProperties>;
-type FixtureGeometry = Point;
+type FixtureGeometry = Polygon | MultiPolygon | LineString | MultiLineString;
 type FixtureProperties = EntityTimestamps & {
     anchor_id: Id | null;
     category: string;
@@ -126,7 +126,9 @@ type FixtureProperties = EntityTimestamps & {
     venue_id: Id;
     [k: string]: any;
 };
-type FixtureFeature = ImdfFeature<FixtureGeometry, FixtureProperties>;
+type FixtureFeature = ImdfFeature<FixtureGeometry, FixtureProperties> & {
+    feature_type: "fixture";
+};
 type KioskGeometry = Polygon | MultiPolygon;
 type KioskProperties = EntityTimestamps & {
     alt_name: string;
@@ -139,7 +141,9 @@ type KioskProperties = EntityTimestamps & {
     style: SymbolProperties;
     venue_id: Id;
 };
-type KioskFeature = ImdfFeature<KioskGeometry, KioskProperties>;
+type KioskFeature = ImdfFeature<KioskGeometry, KioskProperties> & {
+    feature_type: "kiosk";
+};
 type LevelGeometry = Polygon | MultiPolygon;
 type LevelProperties = EntityTimestamps & {
     alt_name: string | null;
@@ -149,7 +153,9 @@ type LevelProperties = EntityTimestamps & {
     properties: unknown;
     venue_id: Id;
 };
-type LevelFeature = ImdfFeature<LevelGeometry, LevelProperties>;
+type LevelFeature = ImdfFeature<LevelGeometry, LevelProperties> & {
+    feature_type: "level";
+};
 type OccupantGeometry = null;
 type OccupantProperties = EntityTimestamps & {
     anchor_id: Id;
@@ -190,11 +196,14 @@ type OccupantProperties = EntityTimestamps & {
     website_link: string | null;
     show_name_on_all_units: boolean;
 };
-type OccupantFeature = ImdfFeature<OccupantGeometry, OccupantProperties>;
+type OccupantFeature = ImdfFeature<OccupantGeometry, OccupantProperties> & {
+    feature_type: "occupant";
+};
+type OpeningCategories = "automobile" | "bicycle" | "emergencyexit" | "pedestrian" | "pedestrian.principal" | "pedestrian.transit" | "service" | string;
 type OpeningGeometry = LineString;
 type OpeningProperties = EntityTimestamps & {
     alt_name: string;
-    category: string;
+    category: OpeningCategories;
     door: {
         type: string;
     };
@@ -203,15 +212,19 @@ type OpeningProperties = EntityTimestamps & {
     style: SymbolProperties;
     venue_id: Id;
 };
-type OpeningFeature = ImdfFeature<OpeningGeometry, OpeningProperties>;
+type OpeningFeature = ImdfFeature<OpeningGeometry, OpeningProperties> & {
+    feature_type: "opening";
+};
+type RelationshipCategories = "elevator" | "escalator" | "movingwalkway" | "ramp" | "stairs" | "stairs.emergencyexit" | "traversal" | "traversal.path" | string;
+type RelationshipDirectionTypes = "directed" | "undirected";
 type RelationshipGeometry = Geometry | null;
-type RelationshipProperties = EntityTimestamps & {
-    category: string;
+type RelationshipProperties<T extends RelationshipCategories = RelationshipCategories> = EntityTimestamps & {
+    category: RelationshipCategories;
     destination: {
         id: Id;
         feature_type: FeatureType;
     };
-    direction: string;
+    direction: RelationshipDirectionTypes;
     hours: string | null;
     intermediary: {
         id: Id;
@@ -233,9 +246,17 @@ type SectionProperties = EntityTimestamps & {
     category: string;
     ordinal: number;
     imdf_category: string;
+    local_category_ids: string[];
+    feature_image: Media | null;
+    cover_image: Media | null;
+    gallery: Media[] | null;
+    is_featured: boolean;
+    hours: string | null;
     [k: string]: any;
 };
-type SectionFeature = ImdfFeature<SectionGeometry, SectionProperties>;
+type SectionFeature = ImdfFeature<SectionGeometry, SectionProperties> & {
+    feature_type: "section";
+};
 type UnitGeometry = Polygon | MultiPolygon;
 type UnitProperties = EntityTimestamps & {
     alt_name: string | null;
@@ -248,7 +269,9 @@ type UnitProperties = EntityTimestamps & {
     style: SymbolProperties;
     venue_id: Id;
 };
-type UnitFeature = ImdfFeature<UnitGeometry, UnitProperties>;
+type UnitFeature = ImdfFeature<UnitGeometry, UnitProperties> & {
+    feature_type: "unit";
+};
 type VenueGeometry = Polygon | MultiPolygon;
 type VenueProperties = EntityTimestamps & {
     address: string;
@@ -272,7 +295,9 @@ type VenueProperties = EntityTimestamps & {
     theme_color: string;
     zoom: string | null;
 };
-type VenueFeature = ImdfFeature<VenueGeometry, VenueProperties>;
+type VenueFeature = ImdfFeature<VenueGeometry, VenueProperties> & {
+    feature_type: "venue";
+};
 /**
  * Non-IMDF
  *********************** */
@@ -521,6 +546,10 @@ type FixtureFeaturePopulated = FixtureFeature & {
           * [IMDF] Venue that kiosk is in
           */
         venue?: VenueFeaturePopulated;
+        /**
+         * [Derived] Level's ordinal that fixture is on
+         */
+        ordinal: number;
     };
 };
 type KioskFeaturePopulated = KioskFeature & {
@@ -547,6 +576,10 @@ type KioskFeaturePopulated = KioskFeature & {
          * This is added during feature enrichment and not part of the original IMDF dataset.
          */
         section?: SectionFeaturePopulated;
+        /**
+         * [Derived] Level's ordinal that fixture is on
+         */
+        ordinal: number;
     };
 };
 type LevelFeaturePopulated = LevelFeature & {
@@ -563,6 +596,9 @@ type OccupantFeaturePopulated = OccupantFeature & {
          * [IMDF] Occupant's position
          */
         anchor: AnchorFeaturePopulated;
+        /**
+         * [Derived] Level's ordinal that occupant is on
+         */
         ordinal: number;
         /**
          * [venue.in.th] Occupant's category
@@ -1206,7 +1242,7 @@ declare function styledFeatureGenerator(mapTheme: any): {
     createFixture: (feature: any) => any;
     createLineStringFromGeometries: (geometries: any) => LineString$1;
     create3DStepPath: (feature: any, threeLayer: any, option?: {}) => NavigationPath;
-    createDecoration: (decoration: any, options: any) => LineString$1 | Polygon$1 | MultiPolygon$1 | MultiLineString;
+    createDecoration: (decoration: any, options: any) => LineString$1 | Polygon$1 | MultiPolygon$1 | MultiLineString$1;
     create3DBillboard: (billboard: any, threeLayer: any) => Billboard;
     create3DAmenityMarker: (feature: any, threeLayer: any, config: any) => SpriteMarker;
     create3DOccupantAmenityMarker: (feature: any, threeLayer: any, config: any) => SpriteMarker;

package/dist/index.d.ts

@@ -1,13 +1,13 @@
 import { QueryClient, QueryObserver, EnsureQueryDataOptions } from '@tanstack/query-core';
 export { QueryObserver } from '@tanstack/query-core';
 import * as geojson from 'geojson';
-import { Position, Geometry, GeoJsonProperties, Feature, Point, Polygon, MultiPolygon, LineString, GeometryCollection } from 'geojson';
+import { Position, Geometry, GeoJsonProperties, Feature, Point, Polygon, MultiPolygon, LineString, MultiLineString, GeometryCollection } from 'geojson';
 import * as maptalks_dist_core_Class from 'maptalks/dist/core/Class';
 import * as maptalks$1 from 'maptalks-gl';
 import { Map, Coordinate as Coordinate$1 } from 'maptalks-gl';
 import { BaseObject, ThreeLayer } from 'maptalks.three';
 import * as maptalks from 'maptalks';
-import { Coordinate, Extent, Marker, ui, LineString as LineString$1, Polygon as Polygon$1, MultiPolygon as MultiPolygon$1, MultiLineString } from 'maptalks';
+import { Coordinate, Extent, Marker, ui, LineString as LineString$1, Polygon as Polygon$1, MultiPolygon as MultiPolygon$1, MultiLineString as MultiLineString$1 } from 'maptalks';
 import { BaseObjectOptionType, BarOptionType, ExtrudePolygonOptionType, ExtrudeLineOptionType } from 'maptalks.three/dist/type';
 import { PolygonOptionsType } from 'maptalks/dist/geometry/Polygon';
 import { LineStringOptionsType } from 'maptalks/dist/geometry/LineString';
@@ -113,7 +113,7 @@ type DetailProperties = {
     [k: string]: any;
 };
 type DetailFeature = ImdfFeature<DetailGeometry, DetailProperties>;
-type FixtureGeometry = Point;
+type FixtureGeometry = Polygon | MultiPolygon | LineString | MultiLineString;
 type FixtureProperties = EntityTimestamps & {
     anchor_id: Id | null;
     category: string;
@@ -126,7 +126,9 @@ type FixtureProperties = EntityTimestamps & {
     venue_id: Id;
     [k: string]: any;
 };
-type FixtureFeature = ImdfFeature<FixtureGeometry, FixtureProperties>;
+type FixtureFeature = ImdfFeature<FixtureGeometry, FixtureProperties> & {
+    feature_type: "fixture";
+};
 type KioskGeometry = Polygon | MultiPolygon;
 type KioskProperties = EntityTimestamps & {
     alt_name: string;
@@ -139,7 +141,9 @@ type KioskProperties = EntityTimestamps & {
     style: SymbolProperties;
     venue_id: Id;
 };
-type KioskFeature = ImdfFeature<KioskGeometry, KioskProperties>;
+type KioskFeature = ImdfFeature<KioskGeometry, KioskProperties> & {
+    feature_type: "kiosk";
+};
 type LevelGeometry = Polygon | MultiPolygon;
 type LevelProperties = EntityTimestamps & {
     alt_name: string | null;
@@ -149,7 +153,9 @@ type LevelProperties = EntityTimestamps & {
     properties: unknown;
     venue_id: Id;
 };
-type LevelFeature = ImdfFeature<LevelGeometry, LevelProperties>;
+type LevelFeature = ImdfFeature<LevelGeometry, LevelProperties> & {
+    feature_type: "level";
+};
 type OccupantGeometry = null;
 type OccupantProperties = EntityTimestamps & {
     anchor_id: Id;
@@ -190,11 +196,14 @@ type OccupantProperties = EntityTimestamps & {
     website_link: string | null;
     show_name_on_all_units: boolean;
 };
-type OccupantFeature = ImdfFeature<OccupantGeometry, OccupantProperties>;
+type OccupantFeature = ImdfFeature<OccupantGeometry, OccupantProperties> & {
+    feature_type: "occupant";
+};
+type OpeningCategories = "automobile" | "bicycle" | "emergencyexit" | "pedestrian" | "pedestrian.principal" | "pedestrian.transit" | "service" | string;
 type OpeningGeometry = LineString;
 type OpeningProperties = EntityTimestamps & {
     alt_name: string;
-    category: string;
+    category: OpeningCategories;
     door: {
         type: string;
     };
@@ -203,15 +212,19 @@ type OpeningProperties = EntityTimestamps & {
     style: SymbolProperties;
     venue_id: Id;
 };
-type OpeningFeature = ImdfFeature<OpeningGeometry, OpeningProperties>;
+type OpeningFeature = ImdfFeature<OpeningGeometry, OpeningProperties> & {
+    feature_type: "opening";
+};
+type RelationshipCategories = "elevator" | "escalator" | "movingwalkway" | "ramp" | "stairs" | "stairs.emergencyexit" | "traversal" | "traversal.path" | string;
+type RelationshipDirectionTypes = "directed" | "undirected";
 type RelationshipGeometry = Geometry | null;
-type RelationshipProperties = EntityTimestamps & {
-    category: string;
+type RelationshipProperties<T extends RelationshipCategories = RelationshipCategories> = EntityTimestamps & {
+    category: RelationshipCategories;
     destination: {
         id: Id;
         feature_type: FeatureType;
     };
-    direction: string;
+    direction: RelationshipDirectionTypes;
     hours: string | null;
     intermediary: {
         id: Id;
@@ -233,9 +246,17 @@ type SectionProperties = EntityTimestamps & {
     category: string;
     ordinal: number;
     imdf_category: string;
+    local_category_ids: string[];
+    feature_image: Media | null;
+    cover_image: Media | null;
+    gallery: Media[] | null;
+    is_featured: boolean;
+    hours: string | null;
     [k: string]: any;
 };
-type SectionFeature = ImdfFeature<SectionGeometry, SectionProperties>;
+type SectionFeature = ImdfFeature<SectionGeometry, SectionProperties> & {
+    feature_type: "section";
+};
 type UnitGeometry = Polygon | MultiPolygon;
 type UnitProperties = EntityTimestamps & {
     alt_name: string | null;
@@ -248,7 +269,9 @@ type UnitProperties = EntityTimestamps & {
     style: SymbolProperties;
     venue_id: Id;
 };
-type UnitFeature = ImdfFeature<UnitGeometry, UnitProperties>;
+type UnitFeature = ImdfFeature<UnitGeometry, UnitProperties> & {
+    feature_type: "unit";
+};
 type VenueGeometry = Polygon | MultiPolygon;
 type VenueProperties = EntityTimestamps & {
     address: string;
@@ -272,7 +295,9 @@ type VenueProperties = EntityTimestamps & {
     theme_color: string;
     zoom: string | null;
 };
-type VenueFeature = ImdfFeature<VenueGeometry, VenueProperties>;
+type VenueFeature = ImdfFeature<VenueGeometry, VenueProperties> & {
+    feature_type: "venue";
+};
 /**
  * Non-IMDF
  *********************** */
@@ -521,6 +546,10 @@ type FixtureFeaturePopulated = FixtureFeature & {
           * [IMDF] Venue that kiosk is in
           */
         venue?: VenueFeaturePopulated;
+        /**
+         * [Derived] Level's ordinal that fixture is on
+         */
+        ordinal: number;
     };
 };
 type KioskFeaturePopulated = KioskFeature & {
@@ -547,6 +576,10 @@ type KioskFeaturePopulated = KioskFeature & {
          * This is added during feature enrichment and not part of the original IMDF dataset.
          */
         section?: SectionFeaturePopulated;
+        /**
+         * [Derived] Level's ordinal that fixture is on
+         */
+        ordinal: number;
     };
 };
 type LevelFeaturePopulated = LevelFeature & {
@@ -563,6 +596,9 @@ type OccupantFeaturePopulated = OccupantFeature & {
          * [IMDF] Occupant's position
          */
         anchor: AnchorFeaturePopulated;
+        /**
+         * [Derived] Level's ordinal that occupant is on
+         */
         ordinal: number;
         /**
          * [venue.in.th] Occupant's category
@@ -1206,7 +1242,7 @@ declare function styledFeatureGenerator(mapTheme: any): {
     createFixture: (feature: any) => any;
     createLineStringFromGeometries: (geometries: any) => LineString$1;
     create3DStepPath: (feature: any, threeLayer: any, option?: {}) => NavigationPath;
-    createDecoration: (decoration: any, options: any) => LineString$1 | Polygon$1 | MultiPolygon$1 | MultiLineString;
+    createDecoration: (decoration: any, options: any) => LineString$1 | Polygon$1 | MultiPolygon$1 | MultiLineString$1;
     create3DBillboard: (billboard: any, threeLayer: any) => Billboard;
     create3DAmenityMarker: (feature: any, threeLayer: any, config: any) => SpriteMarker;
     create3DOccupantAmenityMarker: (feature: any, threeLayer: any, config: any) => SpriteMarker;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "venue-js",
-  "version": "1.4.0-next.3",
+  "version": "1.4.0-next.5",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",