@ray-js/robot-map-sdk 0.0.16-beta.9 → 0.0.17-beta.1

package/dist/constant/methods.js

@@ -1 +1 @@
-const e=["areRoomsAdjacent","getForbiddenSweepZones","getForbiddenMopZones","getCleanZones","getVirtualWalls","getSpots","getRoomAnchors","getWayPoints","getViewportCenterPoint","getMapCenterPoint","getWallPointsByViewportCenter","getForbiddenSweepZonePointsByViewportCenter","getForbiddenMopZonePointsByViewportCenter","getCleanZonePointsByViewportCenter","getSpotPointByViewportCenter","getEffectiveDividerPoints","getDividerEndPoints","isNearChargerOrRobot","isPointInAnyRoom","isWallIntersectsAnyRoom","isZoneIntersectsAnyRoom","resetPanZoom","snapshot","snapshotByData","getCustomCarpets","forceEndGesture","getFurniturePointsByViewportCenter","getCustomCarpetPointsByViewportCenter","getRectPointsByCenter","getFurnitures","drawCustomZones","getCustomZones","clearCustomZones","setEditingCustomZones"],o=["onMapFirstDrawed","onMapDrawed","onPathDrawed","onRoomPropertiesDrawed","onRoomsDrawed","onClickRoom","onClickRoomProperties","onRemoveForbiddenSweepZone","onRemoveForbiddenMopZone","onRemoveCleanZone","onRemoveVirtualWall","onUpdateForbiddenSweepZone","onUpdateForbiddenMopZone","onUpdateCleanZone","onUpdateVirtualWall","onUpdateSpot","onUpdateRoomAnchor","onUpdateWayPoint","onUpdateDivider","onClickForbiddenSweepZone","onClickForbiddenMopZone","onClickCleanZone","onClickVirtualWall","onClickSpot","onClickRoomAnchor","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};
+const e=["areRoomsAdjacent","getForbiddenSweepZones","getForbiddenMopZones","getCleanZones","getVirtualWalls","getThresholds","getSpots","getRoomAnchors","getWayPoints","getViewportCenterPoint","getMapCenterPoint","getWallPointsByViewportCenter","getForbiddenSweepZonePointsByViewportCenter","getForbiddenMopZonePointsByViewportCenter","getCleanZonePointsByViewportCenter","getSpotPointByViewportCenter","getEffectiveDividerPoints","getDividerEndPoints","isNearChargerOrRobot","isPointInAnyRoom","isWallIntersectsAnyRoom","isZoneIntersectsAnyRoom","resetPanZoom","snapshot","snapshotByData","getCustomCarpets","forceEndGesture","getFurniturePointsByViewportCenter","getCustomCarpetPointsByViewportCenter","getRectPointsByCenter","getFurnitures","drawCustomZones","getCustomZones","clearCustomZones","setEditingCustomZones"],o=["onMapFirstDrawed","onMapDrawed","onPathDrawed","onRoomPropertiesDrawed","onRoomsDrawed","onClickRoom","onClickRoomProperties","onRemoveForbiddenSweepZone","onRemoveForbiddenMopZone","onRemoveCleanZone","onRemoveVirtualWall","onRemoveThreshold","onUpdateForbiddenSweepZone","onUpdateForbiddenMopZone","onUpdateCleanZone","onUpdateVirtualWall","onUpdateThreshold","onUpdateSpot","onUpdateRoomAnchor","onUpdateWayPoint","onUpdateDivider","onClickForbiddenSweepZone","onClickForbiddenMopZone","onClickCleanZone","onClickVirtualWall","onClickThreshold","onClickSpot","onClickRoomAnchor","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

@@ -745,6 +745,7 @@ export declare type ControlRenderItem =
 | 'forbiddenMopZone'
 | 'cleanZone'
 | 'virtualWall'
+| 'threshold'
 | 'spot'
 | 'roomAnchor'
 | 'wayPoint'
@@ -799,6 +800,8 @@ export declare type ControlsConfig = {
     carpet: CarpetConfig
     /** 虚拟墙配置 */
     virtualWall: VirtualWallConfig
+    /** 门槛配置 */
+    threshold: ThresholdConfig
     /** 定点清扫配置 */
     spot: SpotConfig
     /**
@@ -1090,9 +1093,9 @@ export declare type LoggerPayload = {
     ts: number
 }
 
-export declare const MAP_API_METHODS: readonly ["areRoomsAdjacent", "getForbiddenSweepZones", "getForbiddenMopZones", "getCleanZones", "getVirtualWalls", "getSpots", "getRoomAnchors", "getWayPoints", "getViewportCenterPoint", "getMapCenterPoint", "getWallPointsByViewportCenter", "getForbiddenSweepZonePointsByViewportCenter", "getForbiddenMopZonePointsByViewportCenter", "getCleanZonePointsByViewportCenter", "getSpotPointByViewportCenter", "getEffectiveDividerPoints", "getDividerEndPoints", "isNearChargerOrRobot", "isPointInAnyRoom", "isWallIntersectsAnyRoom", "isZoneIntersectsAnyRoom", "resetPanZoom", "snapshot", "snapshotByData", "getCustomCarpets", "forceEndGesture", "getFurniturePointsByViewportCenter", "getCustomCarpetPointsByViewportCenter", "getRectPointsByCenter", "getFurnitures", "drawCustomZones", "getCustomZones", "clearCustomZones", "setEditingCustomZones"];
+export declare const MAP_API_METHODS: readonly ["areRoomsAdjacent", "getForbiddenSweepZones", "getForbiddenMopZones", "getCleanZones", "getVirtualWalls", "getThresholds", "getSpots", "getRoomAnchors", "getWayPoints", "getViewportCenterPoint", "getMapCenterPoint", "getWallPointsByViewportCenter", "getForbiddenSweepZonePointsByViewportCenter", "getForbiddenMopZonePointsByViewportCenter", "getCleanZonePointsByViewportCenter", "getSpotPointByViewportCenter", "getEffectiveDividerPoints", "getDividerEndPoints", "isNearChargerOrRobot", "isPointInAnyRoom", "isWallIntersectsAnyRoom", "isZoneIntersectsAnyRoom", "resetPanZoom", "snapshot", "snapshotByData", "getCustomCarpets", "forceEndGesture", "getFurniturePointsByViewportCenter", "getCustomCarpetPointsByViewportCenter", "getRectPointsByCenter", "getFurnitures", "drawCustomZones", "getCustomZones", "clearCustomZones", "setEditingCustomZones"];
 
-export declare const MAP_CALLBACK_METHODS: readonly ["onMapFirstDrawed", "onMapDrawed", "onPathDrawed", "onRoomPropertiesDrawed", "onRoomsDrawed", "onClickRoom", "onClickRoomProperties", "onRemoveForbiddenSweepZone", "onRemoveForbiddenMopZone", "onRemoveCleanZone", "onRemoveVirtualWall", "onUpdateForbiddenSweepZone", "onUpdateForbiddenMopZone", "onUpdateCleanZone", "onUpdateVirtualWall", "onUpdateSpot", "onUpdateRoomAnchor", "onUpdateWayPoint", "onUpdateDivider", "onClickForbiddenSweepZone", "onClickForbiddenMopZone", "onClickCleanZone", "onClickVirtualWall", "onClickSpot", "onClickRoomAnchor", "onClickWayPoint", "onClickDetectedObject", "onClickCustomElement", "onClickMap", "onClickCarpet", "onDeleteCarpet", "onUpdateCustomCarpet", "onDeleteCustomCarpet", "onGestureStart", "onGestureEnd", "onClickRobot", "onClickChargingStation", "onRemoveFurniture", "onUpdateFurniture", "onClickFurniture", "onRemoveCustomZone", "onUpdateCustomZone", "onClickCustomZone"];
+export declare const MAP_CALLBACK_METHODS: readonly ["onMapFirstDrawed", "onMapDrawed", "onPathDrawed", "onRoomPropertiesDrawed", "onRoomsDrawed", "onClickRoom", "onClickRoomProperties", "onRemoveForbiddenSweepZone", "onRemoveForbiddenMopZone", "onRemoveCleanZone", "onRemoveVirtualWall", "onRemoveThreshold", "onUpdateForbiddenSweepZone", "onUpdateForbiddenMopZone", "onUpdateCleanZone", "onUpdateVirtualWall", "onUpdateThreshold", "onUpdateSpot", "onUpdateRoomAnchor", "onUpdateWayPoint", "onUpdateDivider", "onClickForbiddenSweepZone", "onClickForbiddenMopZone", "onClickCleanZone", "onClickVirtualWall", "onClickThreshold", "onClickSpot", "onClickRoomAnchor", "onClickWayPoint", "onClickDetectedObject", "onClickCustomElement", "onClickMap", "onClickCarpet", "onDeleteCarpet", "onUpdateCustomCarpet", "onDeleteCustomCarpet", "onGestureStart", "onGestureEnd", "onClickRobot", "onClickChargingStation", "onRemoveFurniture", "onUpdateFurniture", "onClickFurniture", "onRemoveCustomZone", "onUpdateCustomZone", "onClickCustomZone"];
 
 /**
  * 地图 API 接口定义
@@ -1231,6 +1234,12 @@ export declare interface MapApi {
      * @returns 虚拟墙数据数组
      */
     getVirtualWalls(): VirtualWallParam[];
+    /**
+     * 获取当前地图上所有门槛数据
+     *
+     * @returns 门槛数据数组（长度已修正，`height` 已补默认值并钳制）
+     */
+    getThresholds(): ThresholdParam[];
     /**
      * 获取当前地图上所有定点清扫数据
      *
@@ -1669,6 +1678,15 @@ export declare interface MapCallbacks {
      * @param.en id - ID of the deleted virtual wall
      */
     onRemoveVirtualWall?: (id: string) => void;
+    /**
+     * @description.zh 点击门槛删除按钮的回调
+     * @description.en Callback when clicking the delete button of threshold
+     * @description.zh 当用户点击编辑态门槛的删除按钮时触发。SDK 不会移除该门槛，宿主更新自己的门槛列表后重绘。
+     * @description.en Triggered when the user clicks the delete button of an editing threshold. The SDK does not remove it; the host updates its own list and redraws.
+     * @param.zh id - 被删除的门槛ID
+     * @param.en id - ID of the deleted threshold
+     */
+    onRemoveThreshold?: (id: string) => void;
     /**
      * @description.zh 更新禁扫区域的回调
      * @description.en Callback when updating forbidden sweep zone
@@ -1705,6 +1723,15 @@ export declare interface MapCallbacks {
      * @param.en wall - Updated virtual wall data
      */
     onUpdateVirtualWall?: (wall: VirtualWallParam) => void;
+    /**
+     * @description.zh 更新门槛的回调
+     * @description.en Callback when updating threshold
+     * @description.zh 当用户完成一次门槛编辑操作（旋转 / 缩放 / 移动，或拖拽整体平移）后触发，携带最终几何与类型。
+     * @description.en Triggered after the user finishes a threshold edit (rotate/scale/move, or body drag), carrying the final geometry and type.
+     * @param.zh threshold - 更新后的门槛数据
+     * @param.en threshold - Updated threshold data
+     */
+    onUpdateThreshold?: (threshold: ThresholdParam) => void;
     /**
      * @description.zh 更新定点清扫的回调
      * @description.en Callback when updating spot clean
@@ -1777,6 +1804,15 @@ export declare interface MapCallbacks {
      * @param.en wall - Clicked virtual wall data
      */
     onClickVirtualWall?: (wall: VirtualWallParam) => void;
+    /**
+     * @description.zh 点击门槛回调
+     * @description.en Callback when clicking threshold
+     * @description.zh 点击门槛时触发。常用于「点击进入编辑」（把该 id 加入 editingThresholdIds）或切换类型 / 打开详情 UI。
+     * @description.en Triggered when the user taps a threshold. Commonly used to enter edit mode (add the id to editingThresholdIds) or to switch type / open a detail UI.
+     * @param.zh threshold - 被点击的门槛数据
+     * @param.en threshold - Clicked threshold data
+     */
+    onClickThreshold?: (threshold: ThresholdParam) => void;
     /**
      * @description.zh 点击定点清扫回调
      * @description.en Callback when clicking spot clean
@@ -2335,6 +2371,15 @@ export declare type RuntimeConfig = {
     editingCustomZoneIds?: Record<string, string[]>
     /** 正在编辑的虚拟墙ID列表 */
     editingVirtualWallIds: string[]
+    /**
+     * 正在编辑的门槛ID列表。
+     *
+     * 列入的门槛显示编辑控件（虚线轮廓、尺寸标签与删除 / 旋转 / 缩放 / 移动
+     * 按钮）；未列入的门槛不显示编辑控件，但点击仍会触发 `onClickThreshold`
+     * （宿主可借此实现「点击进入编辑」）。只读展示设备识别的门槛时，不把其 id
+     * 加入本列表即可。
+     */
+    editingThresholdIds: string[]
     /** 正在编辑的定点清扫ID列表 */
     editingSpotIds: string[]
     /** 正在编辑的房间锚点ID列表（独立于 editingSpotIds，互不影响） */
@@ -2497,6 +2542,100 @@ export declare type SpotParam = {
     roomId?: number
 }
 
+/** 门槛配置 */
+export declare type ThresholdConfig = {
+    /** 条纹线宽（屏幕像素，不随地图缩放变化） */
+    stripeWidth: number
+    /** 相邻条纹间距（屏幕像素） */
+    stripeGap: number
+    /** 条带边框线宽（屏幕像素） */
+    borderWidth: number
+    /** 条带圆角半径（屏幕像素，自动不超过条带半厚 / 半长） */
+    cornerRadius: number
+    /** 可通行门槛样式（默认绿色斜纹） */
+    passable: ThresholdStyle
+    /** 不可通行门槛样式（默认红色斜纹） */
+    impassable: ThresholdStyle
+    /** 最小长度 (米)，绘制与缩放时长度被钳制到不小于该值 */
+    minLength: number
+    /** 最大长度 (米)，可选。缺省或 ≤ minLength 时不限制。 */
+    maxLength?: number
+    /** 最小高度 (米)，绘制与缩放时条带高度被钳制到不小于该值 */
+    minHeight: number
+    /** 最大高度 (米)，可选。缺省或 ≤ minHeight 时不限制。 */
+    maxHeight?: number
+    /** 数据未携带 height 时的默认条带高度 (米) */
+    defaultHeight: number
+    /** 四角控制按钮图标容器填充颜色（编辑态显示） */
+    iconWrapperFillColor: ColorSource
+    /**
+     * 点击热区在条带每一侧向外扩展的可抓边距（屏幕像素，不随地图缩放）。
+     * 热区厚度 = 条带高度 + 2 × 该值，因此条带无论多厚都保有固定的可抓边距，
+     * 细条带也不会难以点中。
+     */
+    hitAreaPadding: number
+    /** 编辑态轮廓相对条带边缘的偏移（屏幕像素） */
+    outlineOffset: number
+    /** 编辑态轮廓描边颜色 */
+    outlineStrokeColor: ColorSource
+    /** 编辑态轮廓描边宽度 */
+    outlineStrokeWidth: number
+    /** 编辑态轮廓是否虚线 */
+    outlineDashed: boolean
+    /** 编辑态轮廓虚线数组 */
+    outlineDashArray: [number, number]
+    /** 编辑态轮廓填充颜色 */
+    outlineFillColor: ColorSource
+    /** 尺寸标签（长×高）文本颜色（编辑态显示） */
+    textColor: ColorSource
+    /** 尺寸标签相对轮廓边缘向外的偏移（屏幕像素） */
+    textOffset: number
+}
+
+/**
+ * 门槛参数。
+ *
+ * 门槛是「中心线 + 高度」的矩形条带元素，用可通行 / 不可通行两种类型标记
+ * 机器人能否跨越的通道，渲染为斜纹条带（可通行绿色 / 不可通行红色）。条带
+ * 为真实世界尺寸：长度由两端点决定，厚度由 `height` 决定，随地图缩放。
+ *
+ * 交互由运行时 `editingThresholdIds` 门控：列入的门槛显示编辑控件（虚线
+ * 轮廓、尺寸标签与删除 / 旋转 / 缩放 / 移动按钮，与禁区等四边形元素同一套
+ * 编辑面），长与高在缩放时各自钳制到 `minLength`/`maxLength` 与
+ * `minHeight`/`maxHeight`（米）区间。编辑结束触发 `onUpdateThreshold`，
+ * 点击触发 `onClickThreshold`，删除按钮触发 `onRemoveThreshold`。
+ */
+export declare type ThresholdParam = {
+    /** 门槛ID */
+    id: string
+    /** 中心线两端点坐标（起点、终点），与其他元素同为地图像素坐标系 */
+    points: [Point, Point]
+    /**
+     * 条带高度（厚度），单位与 points 相同（地图像素）。缺省时取
+     * `controls.threshold.defaultHeight`（米）换算；绘制与缩放时被钳制在
+     * `minHeight` / `maxHeight`（米）区间内。
+     */
+    height?: number
+    /** 门槛类型（可通行 / 不可通行）。缺省为 `passable`（可通行）。 */
+    type?: ThresholdType
+}
+
+/** 门槛单类型样式 */
+export declare type ThresholdStyle = {
+    /** 条纹与描边颜色 */
+    color: ColorSource
+    /** 条带底色 */
+    fillColor: ColorSource
+}
+
+/**
+ * 门槛类型。
+ *
+ * - `'passable'`：可通行门槛，机器人可尝试跨越，默认渲染为绿色斜纹条带
+ * - `'impassable'`：不可通行门槛，机器人不得跨越，默认渲染为红色斜纹条带
+ */
+export declare type ThresholdType = 'passable' | 'impassable'
+
 /** 虚拟墙配置 */
 export declare type VirtualWallConfig = {
     /** 图标容器填充颜色 */