@ray-js/robot-map-sdk 0.0.14-beta.5 → 0.0.14

package/dist/constant/methods.js

@@ -1 +1 @@
-const e=["areRoomsAdjacent","getForbiddenSweepZones","getForbiddenMopZones","getCleanZones","getVirtualWalls","getSpots","getWayPoints","getViewportCenterPoint","getMapCenterPoint","getWallPointsByViewportCenter","getForbiddenSweepZonePointsByViewportCenter","getForbiddenMopZonePointsByViewportCenter","getCleanZonePointsByViewportCenter","getSpotPointByViewportCenter","getEffectiveDividerPoints","getDividerEndPoints","isNearChargerOrRobot","isPointInAnyRoom","isWallIntersectsAnyRoom","isZoneIntersectsAnyRoom","resetPanZoom","snapshot","snapshotByData","getCustomCarpets","forceEndGesture","getFurniturePointsByViewportCenter","getFurnitures"],o=["onMapFirstDrawed","onMapDrawed","onPathDrawed","onRoomPropertiesDrawed","onClickRoom","onClickRoomProperties","onRemoveForbiddenSweepZone","onRemoveForbiddenMopZone","onRemoveCleanZone","onRemoveVirtualWall","onUpdateForbiddenSweepZone","onUpdateForbiddenMopZone","onUpdateCleanZone","onUpdateVirtualWall","onUpdateSpot","onUpdateWayPoint","onUpdateDivider","onClickForbiddenSweepZone","onClickForbiddenMopZone","onClickCleanZone","onClickVirtualWall","onClickSpot","onClickWayPoint","onClickDetectedObject","onClickCustomElement","onClickMap","onClickCarpet","onDeleteCarpet","onUpdateCustomCarpet","onDeleteCustomCarpet","onGestureStart","onGestureEnd","onClickRobot","onClickChargingStation","onRemoveFurniture","onUpdateFurniture","onClickFurniture"];export{e as MAP_API_METHODS,o as MAP_CALLBACK_METHODS};
+const e=["areRoomsAdjacent","getForbiddenSweepZones","getForbiddenMopZones","getCleanZones","getVirtualWalls","getSpots","getWayPoints","getViewportCenterPoint","getMapCenterPoint","getWallPointsByViewportCenter","getForbiddenSweepZonePointsByViewportCenter","getForbiddenMopZonePointsByViewportCenter","getCleanZonePointsByViewportCenter","getSpotPointByViewportCenter","getEffectiveDividerPoints","getDividerEndPoints","isNearChargerOrRobot","isPointInAnyRoom","isWallIntersectsAnyRoom","isZoneIntersectsAnyRoom","resetPanZoom","snapshot","snapshotByData","getCustomCarpets","forceEndGesture","getFurniturePointsByViewportCenter","getFurnitures","drawCustomZones","getCustomZones","clearCustomZones","setEditingCustomZones"],o=["onMapFirstDrawed","onMapDrawed","onPathDrawed","onRoomPropertiesDrawed","onClickRoom","onClickRoomProperties","onRemoveForbiddenSweepZone","onRemoveForbiddenMopZone","onRemoveCleanZone","onRemoveVirtualWall","onUpdateForbiddenSweepZone","onUpdateForbiddenMopZone","onUpdateCleanZone","onUpdateVirtualWall","onUpdateSpot","onUpdateWayPoint","onUpdateDivider","onClickForbiddenSweepZone","onClickForbiddenMopZone","onClickCleanZone","onClickVirtualWall","onClickSpot","onClickWayPoint","onClickDetectedObject","onClickCustomElement","onClickMap","onClickCarpet","onDeleteCarpet","onUpdateCustomCarpet","onDeleteCustomCarpet","onGestureStart","onGestureEnd","onClickRobot","onClickChargingStation","onRemoveFurniture","onUpdateFurniture","onClickFurniture","onRemoveCustomZone","onUpdateCustomZone","onClickCustomZone"];export{e as MAP_API_METHODS,o as MAP_CALLBACK_METHODS};

package/dist/index.d.ts

@@ -536,6 +536,16 @@ export declare type AppConfig = {
         /** 分辨率 */
         resolution: number
     }
+
+    /**
+     * Custom zone-type definitions. Keys are the zone-type names used as the
+     * grouping key of the `customZones` prop, the grouping key of
+     * `runtime.editingCustomZoneIds`, and the `type` argument of the
+     * `on*CustomZone` callbacks. Must NOT collide with the three built-in types
+     * (forbiddenSweepZone, forbiddenMopZone, cleanZone); use `config.controls.*`
+     * for built-in styling.
+     */
+    customZoneTypes?: Record<string, Partial<ZoneTypeDefinition>>
 }
 
 /**
@@ -616,6 +626,8 @@ export declare type BaseCustomElementParam = {
 export declare type BaseZoneConfig = {
     /** 最小尺寸 (米) */
     minSize: number
+    /** 最大尺寸 (米)，可选。缺省或 ≤ minSize 时不限制。 */
+    maxSize?: number
     /** 图标容器填充颜色 */
     iconWrapperFillColor: ColorSource
     /** 描边颜色 */
@@ -673,10 +685,7 @@ export declare type Bounds = {
 }
 
 /** 地毯配置 */
-export declare type CarpetConfig = BaseZoneConfig & {
-    /** 是否开启自由旋转模式 */
-    enableFreeRotate: boolean
-}
+export declare type CarpetConfig = Omit<BaseZoneConfig, 'strokeColor' | 'strokeWidth'>
 
 /** 组件属性类型 */
 export declare type ComponentPropsApp = {
@@ -693,6 +702,9 @@ export declare type ControlRenderItem =
 | 'spot'
 | 'wayPoint'
 | 'divider'
+// Allow any string for custom zone types while keeping IDE autocomplete
+// for the seven built-in items via the `(string & {})` trick.
+| (string & {})
 
 /**
  * 控制元素配置
@@ -1000,9 +1012,9 @@ export declare type ImageCustomElementParam = BaseCustomElementParam & {
     anchor?: Point
 }
 
-export declare const MAP_API_METHODS: readonly ["areRoomsAdjacent", "getForbiddenSweepZones", "getForbiddenMopZones", "getCleanZones", "getVirtualWalls", "getSpots", "getWayPoints", "getViewportCenterPoint", "getMapCenterPoint", "getWallPointsByViewportCenter", "getForbiddenSweepZonePointsByViewportCenter", "getForbiddenMopZonePointsByViewportCenter", "getCleanZonePointsByViewportCenter", "getSpotPointByViewportCenter", "getEffectiveDividerPoints", "getDividerEndPoints", "isNearChargerOrRobot", "isPointInAnyRoom", "isWallIntersectsAnyRoom", "isZoneIntersectsAnyRoom", "resetPanZoom", "snapshot", "snapshotByData", "getCustomCarpets", "forceEndGesture", "getFurniturePointsByViewportCenter", "getFurnitures"];
+export declare const MAP_API_METHODS: readonly ["areRoomsAdjacent", "getForbiddenSweepZones", "getForbiddenMopZones", "getCleanZones", "getVirtualWalls", "getSpots", "getWayPoints", "getViewportCenterPoint", "getMapCenterPoint", "getWallPointsByViewportCenter", "getForbiddenSweepZonePointsByViewportCenter", "getForbiddenMopZonePointsByViewportCenter", "getCleanZonePointsByViewportCenter", "getSpotPointByViewportCenter", "getEffectiveDividerPoints", "getDividerEndPoints", "isNearChargerOrRobot", "isPointInAnyRoom", "isWallIntersectsAnyRoom", "isZoneIntersectsAnyRoom", "resetPanZoom", "snapshot", "snapshotByData", "getCustomCarpets", "forceEndGesture", "getFurniturePointsByViewportCenter", "getFurnitures", "drawCustomZones", "getCustomZones", "clearCustomZones", "setEditingCustomZones"];
 
-export declare const MAP_CALLBACK_METHODS: readonly ["onMapFirstDrawed", "onMapDrawed", "onPathDrawed", "onRoomPropertiesDrawed", "onClickRoom", "onClickRoomProperties", "onRemoveForbiddenSweepZone", "onRemoveForbiddenMopZone", "onRemoveCleanZone", "onRemoveVirtualWall", "onUpdateForbiddenSweepZone", "onUpdateForbiddenMopZone", "onUpdateCleanZone", "onUpdateVirtualWall", "onUpdateSpot", "onUpdateWayPoint", "onUpdateDivider", "onClickForbiddenSweepZone", "onClickForbiddenMopZone", "onClickCleanZone", "onClickVirtualWall", "onClickSpot", "onClickWayPoint", "onClickDetectedObject", "onClickCustomElement", "onClickMap", "onClickCarpet", "onDeleteCarpet", "onUpdateCustomCarpet", "onDeleteCustomCarpet", "onGestureStart", "onGestureEnd", "onClickRobot", "onClickChargingStation", "onRemoveFurniture", "onUpdateFurniture", "onClickFurniture"];
+export declare const MAP_CALLBACK_METHODS: readonly ["onMapFirstDrawed", "onMapDrawed", "onPathDrawed", "onRoomPropertiesDrawed", "onClickRoom", "onClickRoomProperties", "onRemoveForbiddenSweepZone", "onRemoveForbiddenMopZone", "onRemoveCleanZone", "onRemoveVirtualWall", "onUpdateForbiddenSweepZone", "onUpdateForbiddenMopZone", "onUpdateCleanZone", "onUpdateVirtualWall", "onUpdateSpot", "onUpdateWayPoint", "onUpdateDivider", "onClickForbiddenSweepZone", "onClickForbiddenMopZone", "onClickCleanZone", "onClickVirtualWall", "onClickSpot", "onClickWayPoint", "onClickDetectedObject", "onClickCustomElement", "onClickMap", "onClickCarpet", "onDeleteCarpet", "onUpdateCustomCarpet", "onDeleteCustomCarpet", "onGestureStart", "onGestureEnd", "onClickRobot", "onClickChargingStation", "onRemoveFurniture", "onUpdateFurniture", "onClickFurniture", "onRemoveCustomZone", "onUpdateCustomZone", "onClickCustomZone"];
 
 /**
  * 地图 API 接口定义
@@ -1757,6 +1769,33 @@ export declare interface MapCallbacks {
      * @param.en point - Charging station current position and orientation
      */
     onClickChargingStation?: (point: IconPoint) => void;
+    /**
+     * @description.zh 自定义区域删除回调（仅自定义类型，内置类型走 onRemoveCleanZone 等）
+     * @description.en Custom-zone remove callback (custom types only; built-in types use onRemoveCleanZone etc.)
+     * @param.zh type - 自定义区域类型
+     * @param.en type - Custom zone type
+     * @param.zh id - 被删除的区域ID
+     * @param.en id - ID of the deleted zone
+     */
+    onRemoveCustomZone?: (type: string, id: string) => void;
+    /**
+     * @description.zh 自定义区域更新回调（仅自定义类型）
+     * @description.en Custom-zone update callback (custom types only)
+     * @param.zh type - 自定义区域类型
+     * @param.en type - Custom zone type
+     * @param.zh zone - 更新后的区域数据
+     * @param.en zone - Updated zone data
+     */
+    onUpdateCustomZone?: (type: string, zone: ZoneParam) => void;
+    /**
+     * @description.zh 自定义区域点击回调（仅自定义类型）
+     * @description.en Custom-zone click callback (custom types only)
+     * @param.zh type - 自定义区域类型
+     * @param.en type - Custom zone type
+     * @param.zh zone - 被点击的区域数据
+     * @param.en zone - Clicked zone data
+     */
+    onClickCustomZone?: (type: string, zone: ZoneParam) => void;
 }
 
 /**
@@ -2069,6 +2108,8 @@ export declare type RuntimeConfig = {
     editingForbiddenMopZoneIds: string[]
     /** 正在编辑的清洁区域ID列表 */
     editingCleanZoneIds: string[]
+    /** Editing ids for custom zone types, keyed by zone type. Built-in types use their own `editing*ZoneIds` fields. */
+    editingCustomZoneIds?: Record<string, string[]>
     /** 正在编辑的虚拟墙ID列表 */
     editingVirtualWallIds: string[]
     /** 正在编辑的定点清扫ID列表 */
@@ -2212,6 +2253,8 @@ export declare type VirtualWallConfig = {
     textOffset: number
     /** 最小宽度 (米) */
     minWidth: number
+    /** 最大宽度 (米)，可选。缺省或 ≤ minWidth 时不限制。 */
+    maxWidth?: number
 
     /** 编辑模式样式 */
     editing: {
@@ -2318,6 +2361,18 @@ export declare type ZoneParam = {
     id: string
     /** 点集合 */
     points: Point[]
+    /**
+     * Optional business-specific metadata. The SDK never reads or validates
+     * this field; it is stored as-is on the zone instance and returned
+     * unchanged. Use it to tag custom zone instances with type-specific data.
+     */
+    metadata?: Record<string, unknown>
 }
 
+/**
+ * A zone type definition. Has exactly the shape of the existing built-in
+ * zone configs; both built-in and custom types are described with this.
+ */
+export declare type ZoneTypeDefinition = ZoneConfig
+
 export { }