@aapicoits/powermap-web-sdk 1.0.1 → 1.1.0

package/README.md

@@ -945,16 +945,42 @@ map.on('geometrySelectionChanged', ({ features }) => {
 
 ## 16. 🏠 Indoor Mapping
 
-The PowerMap SDK provides a robust API for managing indoor environments, including floor switching, category filtering, and specialized geometry handling.
+The PowerMap SDK provides a robust API for managing indoor environments with **OGC IMDF 1.0.0 Full Compliance** — supporting all 16 standard feature types, ZIP archive import/export, and schema validation.
 
-### 16.1 Enabling Indoor Mode
+> [!TIP]
+> For the complete IMDF reference including all feature types, properties, archive format, and validation — see [GEOMETRY.md](./GEOMETRY.md#ogc-imdf-100-compliance)
+
+### 16.1 Indoor Venue Selection (NEW)
 
-Switch to indoor mode to enable building-specific logic and specialized drawing tools (e.g., Beacons, Walkways).
+The new `loadIndoorMap()` API lets you select and activate a venue from pre-loaded data. It handles mode switching, floor detection, and camera fitting automatically.
 
 ```javascript
-map.setMode('indoor');
+// 1. Load data from your API
+const data = await fetch('/api/venues/siam-paragon/features').then(r => r.json());
+map.geometry.import(data);
+
+// 2. Select venue → auto enters indoor mode
+const result = map.loadIndoorMap('siam_paragon');
+console.log(result.floors);       // [0, 1, 2, 3, 4]
+console.log(result.currentFloor); // 0
+
+// 3. Switch floors
+map.setFloor(2);  // Convenience alias for map.indoor.setFloor()
+
+// 4. Query venue metadata
+map.indoor.getVenueInfo();   // { id, name, floors, bounds, buildingCount }
+map.indoor.getFloorInfo(2);  // { name, unitCount, poiCount, beaconCount }
+
+// 5. Exit
+map.unloadIndoorMap();
 ```
 
+| Method | Returns | Description |
+| :--- | :--- | :--- |
+| `loadIndoorMap(venueId, opts)` | `{ venue, floors, currentFloor }` | Select venue, enter indoor mode, fit bounds |
+| `setFloor(level, opts)` | `PowerMap` | Convenience alias for `map.indoor.setFloor()` |
+| `unloadIndoorMap()` | `PowerMap` | Exit indoor mode, clear selection |
+
 ### 16.2 Floor Management (`map.indoor`)
 
 When in indoor mode, use the `map.indoor` facade to control the vertical context of the map.
@@ -964,6 +990,11 @@ When in indoor mode, use the `map.indoor` facade to control the vertical context
 | `setFloor(ordinal, opts)` | `number, Object` | Switch to a specific floor level (e.g., 1, 2, -1). |
 | `getAvailableFloors()` | - | Returns a sorted array of all unique floor ordinals found in the map data. |
 | `getCurrentFloor()` | - | Returns the ordinal of the currently active floor. |
+| `getActiveVenue()` | - | Returns the currently selected venue feature or `null`. |
+| `getVenues()` | - | Lists all venue features in loaded data. |
+| `getVenueInfo()` | - | Summary of active venue (name, floors, bounds, building count). |
+| `getFloorInfo(ordinal)` | `number` | Floor details (unit count, POI count, beacon count). |
+| `getBuildings()` | - | Lists all building features in loaded data. |
 
 #### Switching Floors with Animation
 
@@ -992,19 +1023,58 @@ map.indoor.setCategoryVisible('walkway', true);   // Navigation Paths
 map.indoor.setCategoryVisible('obstacle', true);  // 3D Obstacles/Buildings
 ```
 
-### 16.4 Indoor Data Kinds
+### 16.4 Indoor Data Kinds (IMDF Compliant)
 
-The SDK categorizes indoor features using the `user_kind` (or `kind`) property:
+The SDK categorizes indoor features using `user_kind` (or `kind`) mapped to OGC IMDF `feature_type`:
 
-- **floor**: The walkable surface area of a floor (Polygon).
-- **obstacle**: Non-walkable areas. Can be extruded into 3D.
-- **walkway**: Navigable path lines for indoor routing.
-- **poi**: Indoor points of interest with custom icons.
-- **beacon**: Positioning hardware or logical points.
+| SDK Kind | IMDF Feature Type | Geometry | Description |
+| :--- | :--- | :--- | :--- |
+| `venue` | venue | Polygon | Main venue (mall, airport) |
+| `building` | building | Polygon | Building within venue |
+| `floor` | level | Polygon | Floor plan surface |
+| `unit` | unit | Polygon | Room, corridor, area |
+| `opening` | opening | LineString | Door, gate, passage |
+| `amenity` | amenity | Point | ATM, restroom, etc. |
+| `anchor` | anchor | Point | Reference point |
+| `footprint` | footprint | Polygon | Building shadow |
+| `fixture` | fixture | Polygon | Furniture, permanent |
+| `section` | section | Polygon | Zone, terminal |
+| `geofence` | geofence | Polygon | Virtual fence |
+| `kiosk` | kiosk | Polygon | Service booth |
+| `detail` | detail | LineString | Crosswalk, railing |
+| `beacon` | anchor (beacon) | Point | BLE beacon device |
+| `poi` | anchor (poi) | Point | Point of interest |
+| `walkway` | pathway | LineString | Indoor navigation path |
+| `obstacle` | unit (restricted) | Polygon | Non-walkable area |
+
+### 16.5 IMDF Archive & Validation
 
-### 16.5 Event Synchronization
+```javascript
+import { IMDFArchive, IMDFValidator } from '@powermap/web-sdk';
+
+// Export as IMDF ZIP archive
+const blob = await IMDFArchive.toArchive(map.geometry.export());
+
+// Import IMDF ZIP archive
+const fc = await IMDFArchive.fromArchive(zipFile);
+map.geometry.import(fc);
+
+// Validate IMDF data
+const result = IMDFValidator.validate(map.geometry.export());
+if (!result.valid) console.error(result.errors);
+```
+
+> [!NOTE]
+> IMDF Archive requires [JSZip](https://stuk.github.io/jszip/) as an optional dependency.
+
+### 16.6 Event Synchronization
 
 ```javascript
+// Listen for venue selection
+map.on('indoorMapLoaded', ({ venue, floors, currentFloor }) => {
+  console.log(`Entered: ${venue.properties?.name?.en}`);
+});
+
 // Listen for mode changes
 map.on('onModeChanged', ({ mode }) => {
   console.log(`Mode switched to: ${mode}`); // 'standard' or 'indoor'
@@ -1114,6 +1184,9 @@ The SDK emits the following events through its central `EventBus`. You can subsc
 | Event | Payload | Description |
 |---|---|---|
 | `floorChanged` | `ordinal (number)` | Fired when the active indoor floor changes. |
+| `venueChanged` | `VenueInfo` | Fired when the active venue selection changes. |
+| `indoorMapLoaded` | `{ venue, floors, currentFloor }` | Fired when a venue is successfully selected via `loadIndoorMap()`. |
+| `indoorMapUnloaded` | `-` | Fired when indoor mode is exited via `unloadIndoorMap()`. |
 
 ### 🗺️ Routing & Navigation
 | Event | Payload | Description |