@nice2dev/ui-buildings 1.1.9 → 1.2.0

package/dist/index.d.ts

@@ -64,22 +64,13 @@ export declare interface BlindState {
 
 export declare type BmsProtocol = 'bacnet' | 'dali' | 'lonworks' | 'opc-ua' | 'knx' | 'modbus';
 
-export declare interface Building {
-    id: BuildingId;
-    name: string;
-    address?: string;
-    timezone?: string;
-    latitude?: number;
-    longitude?: number;
-    floors: BuildingFloor[];
-    rooms: BuildingZone[];
-    devices: BuildingDevice[];
-    scenes: BuildingScene[];
-    automations: BuildingAutomation[];
-    floorPlan?: FloorPlanFloor[];
-}
-
-/** Root aggregated building model used as top-level prop for most components */
+/**
+ * Root aggregated building model used as top-level prop for most components.
+ *
+ * Declared once since 1.2.0. Until then a second `interface Building` earlier in this file
+ * merged with this one, which is how `rooms` came to sit next to `zones` — both stay required,
+ * exactly as the merged type had them.
+ */
 export declare interface Building {
     id: BuildingId;
     name: string;
@@ -90,6 +81,8 @@ export declare interface Building {
     longitude?: number;
     floors: BuildingFloor[];
     zones: BuildingZone[];
+    /** Rooms as zones — kept from the second declaration this type used to merge with. */
+    rooms: BuildingZone[];
     devices: BuildingDevice[];
     scenes: BuildingScene[];
     automations: BuildingAutomation[];
@@ -168,8 +161,6 @@ export declare interface BuildingScene {
     description?: string;
     /** Per-device target states applied when the scene activates. */
     deviceTargets: SceneDeviceTarget[];
-    /** @deprecated alias for {@link deviceTargets}. */
-    devices?: SceneDeviceTarget[];
     isActive?: boolean;
     favorite?: boolean;
     category?: string;
@@ -352,8 +343,6 @@ export declare interface FloorPlanFloor {
     scale?: number;
     /** Floor zones (preferred). */
     zones: FloorPlanZone[];
-    /** @deprecated alias for {@link zones}. */
-    rooms?: FloorPlanZone[];
 }
 
 export declare interface FloorPlanSelection {
@@ -414,9 +403,6 @@ declare interface HistoryAction {
     after: unknown;
 }
 
-/** @deprecated Use OccupancyMode instead */
-export declare type HomeMode = OccupancyMode;
-
 export declare const LayerPanel: default_2.FC<LayerPanelProps>;
 
 declare interface LayerPanelProps {
@@ -537,10 +523,8 @@ export declare interface NiceAutomationEditorProps {
     /** Initial automations when uncontrolled. */
     defaultAutomations?: BuildingAutomation[];
     devices?: BuildingDevice[];
-    zones?: BuildingZone[];
     scenes?: BuildingScene[];
     onAutomationsChange?: (automations: BuildingAutomation[]) => void;
-    onSave?: (automation: BuildingAutomation) => Promise<void> | void;
     onDelete?: (id: BuildingId) => Promise<void> | void;
     onToggle?: (id: BuildingId, enabled: boolean) => Promise<void> | void;
     readOnly?: boolean;
@@ -556,25 +540,16 @@ export declare const NiceBuildingDashboard: default_2.FC<NiceBuildingDashboardPr
 export declare interface NiceBuildingDashboardProps {
     /** Building model (preferred). */
     building: Building;
-    /** @deprecated alias for {@link building}. */
-    home?: Building;
     state?: BuildingState;
     onDeviceControl?: (deviceId: BuildingId, state: Partial<DeviceState>) => Promise<void> | void;
     onSceneActivate?: (sceneId: BuildingId) => Promise<void> | void;
     onModeChange?: (mode: OccupancyMode) => void;
-    /** @deprecated use {@link onModeChange}. */
-    onHomeModeChange?: (mode: OccupancyMode) => void;
     onZoneClick?: (zoneId: BuildingId) => void;
     /** Optional weather widget data. */
     weather?: {
         temperature?: number;
         description?: string;
     };
-    showEnergy?: boolean;
-    showMap?: boolean;
-    showWeather?: boolean;
-    density?: DisplayDensity;
-    favoriteDeviceIds?: BuildingId[];
     className?: string;
     style?: CSSProperties;
     theme?: 'light' | 'dark';
@@ -645,11 +620,9 @@ export declare interface NiceSceneEditorProps {
     /** Initial scenes when uncontrolled. */
     defaultScenes?: BuildingScene[];
     devices?: BuildingDevice[];
-    zones?: BuildingZone[];
     /** Currently active scene ids (highlighted). */
     activeSceneIds?: BuildingId[];
     onScenesChange?: (scenes: BuildingScene[]) => void;
-    onSave?: (scene: BuildingScene) => Promise<void> | void;
     onDelete?: (id: BuildingId) => Promise<void> | void;
     onActivate?: (id: BuildingId) => Promise<void> | void;
     readOnly?: boolean;
@@ -717,8 +690,8 @@ export declare interface NiceSpatialEditorProps extends TracelessStorageProps {
 export declare const NiceSpatialViewer: default_2.FC<NiceSpatialViewerProps>;
 
 declare interface NiceSpatialViewerProps {
-    /** Floor plan document to display. */
-    document: FloorPlanDocument;
+    /** Floor plan document to display. Optional: without one the viewer shows an empty plan. */
+    document?: FloorPlanDocument;
     /** Initial floor ID to show. */
     initialFloorId?: string;
     /** Show navigation panel. */
@@ -769,10 +742,6 @@ export declare interface NiceThermostatControlProps {
     device: BuildingDevice;
     state?: ThermostatState;
     onControl?: (deviceId: BuildingId, state: Partial<ThermostatState>) => Promise<void> | void;
-    showSchedule?: boolean;
-    showHumidity?: boolean;
-    size?: 'sm' | 'md' | 'lg';
-    unit?: 'C' | 'F';
     compact?: boolean;
     className?: string;
     style?: CSSProperties;
@@ -784,16 +753,12 @@ export declare const NiceZoneCard: default_2.FC<NiceZoneCardProps>;
 export declare interface NiceZoneCardProps {
     /** Zone metadata (preferred). */
     zone: FloorPlanZone | BuildingZone;
-    /** @deprecated alias for {@link zone}. */
-    room?: BuildingZone;
     devices?: BuildingDevice[];
     temperature?: number;
     humidity?: number;
     expanded?: boolean;
     onExpand?: () => void;
     onDeviceControl?: (deviceId: BuildingId, state: Partial<DeviceState>) => Promise<void> | void;
-    /** @deprecated use {@link onDeviceControl}. */
-    onControl?: (deviceId: BuildingId, state: Partial<DeviceState>) => Promise<void> | void;
     onClick?: () => void;
     onRoomClick?: (roomId: BuildingId) => void;
     density?: DisplayDensity;
@@ -925,12 +890,6 @@ declare interface SensorThresholdTrigger {
     hysteresis?: number;
 }
 
-/** @deprecated Use Building instead */
-export declare type SmartHome = Building;
-
-/** @deprecated Use BuildingDevice instead */
-export declare type SmartHomeDevice = BuildingDevice;
-
 /**
  * Editor modes — each mode provides different tools and UI
  */
@@ -1027,10 +986,6 @@ export declare interface ThermostatState {
     temperature: number;
     /** Target setpoint in °C. */
     targetTemperature: number;
-    /** @deprecated use {@link temperature} */
-    currentTemp?: number;
-    /** @deprecated use {@link targetTemperature} */
-    targetTemp?: number;
     mode: 'heat' | 'cool' | 'auto' | 'off' | 'fan_only' | 'dry';
     fanMode?: 'auto' | 'low' | 'medium' | 'high';
     humidity?: number;
@@ -1204,13 +1159,6 @@ export declare interface ViewportState {
     snapModes: SnapMode[];
 }
 
-/**
- * @deprecated Use `BuildingZoneOccupancy`. `@nice2dev/events` exports a different
- * `ZoneOccupancy` (venue capacity), so importing both packages collided; this alias is
- * removed in 1.2.0.
- */
-export declare type ZoneOccupancy = BuildingZoneOccupancy;
-
 export declare type ZoneType = 'living_room' | 'bedroom' | 'master_bedroom' | 'kids_room' | 'bathroom' | 'kitchen' | 'dining_room' | 'hallway' | 'office' | 'garage' | 'basement' | 'attic' | 'balcony' | 'garden' | 'laundry' | 'storage' | 'gym' | 'cinema' | 'open_office' | 'private_office' | 'meeting_room' | 'boardroom' | 'reception' | 'waiting_area' | 'server_room' | 'it_room' | 'break_room' | 'lobby' | 'corridor' | 'stairwell' | 'parking' | 'cafeteria' | 'mechanical_room' | 'other';
 
 export { }