@ray-js/robot-map-sdk 0.0.15 → 0.0.16-beta.10

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","getCustomCarpetPointsByViewportCenter","getRectPointsByCenter","getFurnitures","drawCustomZones","getCustomZones","clearCustomZones","setEditingCustomZones"],o=["onMapFirstDrawed","onMapDrawed","onPathDrawed","onRoomPropertiesDrawed","onRoomsDrawed","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};
+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};

package/dist/index.d.ts

@@ -312,6 +312,25 @@ export declare type AppConfig = {
          *
          * */
         incrementalThreshold: number
+        /**
+         * 合并阈值（路径点数）
+         *
+         * 距上次全量重绘累计新增点数超过该值时，强制转全量重绘，把增量追加堆积的
+         * 绘图指令收敛成一条抽稀后的折线，避免 speed=0 长会话下指令/显存无限增长。
+         *
+         * 越小越频繁收敛（峰值内存低、偶发重绘更频繁）；越大收敛越少（重绘更少、
+         * 指令堆积峰值更高）。默认 200。
+         */
+        consolidateThreshold: number
+        /**
+         * 抽稀容差（屏幕像素）
+         *
+         * 全量重绘时对折线做 RDP 抽稀的容差，以“屏幕像素”表达，内部按运行时最大
+         * 缩放折算为世界坐标，保证即使放到最大倍数，被删点的偏差也 < 该像素值。
+         *
+         * 设为 0 时关闭抽稀。默认 0.5（比常见的 1px 更保守，优先保证视觉无变化）。
+         */
+        simplifyTolerancePx: number
         /** 清扫路径配置 */
         commonPath: {
             /** 是否可见 */
@@ -622,6 +641,23 @@ export declare type BaseCustomElementParam = {
     customData?: Record<string, any>
     /** 尺寸是否固定 */
     sizeFixed?: boolean
+    /**
+     * 屏幕像素偏移（仅 `sizeFixed: true` 生效）
+     *
+     * 在元素锚定到 (x, y) 之后，再按「屏幕像素」平移指定距离。该偏移不随地图
+     * 缩放或旋转变化，始终对应相同的屏幕位移——与房间属性气泡停留在房间名上方
+     * 的行为一致。适合把图标稳定贴在气泡旁边等固定相对位置。
+     *
+     * 坐标约定（与 PIXI 屏幕坐标及 `getWallPointsByViewportCenter` 等 offset API 一致）：
+     * - `x` 正值向右，负值向左
+     * - `y` 正值向下，负值向上
+     *
+     * 例：贴在房间属性气泡上方 → `pixelOffset: { x: 12, y: -10 }`。
+     *
+     * 注意：`sizeFixed` 为 `false` 或未设置时该字段被忽略（随缩放变化的尺寸与
+     * 固定像素偏移没有自洽语义）。
+     */
+    pixelOffset?: Point
 }
 
 /** 区域和地毯配置的基础类型 */
@@ -710,6 +746,7 @@ export declare type ControlRenderItem =
 | 'cleanZone'
 | 'virtualWall'
 | 'spot'
+| 'roomAnchor'
 | 'wayPoint'
 | 'divider'
 // Allow any string for custom zone types while keeping IDE autocomplete
@@ -764,6 +801,12 @@ export declare type ControlsConfig = {
     virtualWall: VirtualWallConfig
     /** 定点清扫配置 */
     spot: SpotConfig
+    /**
+     * 房间锚点配置。房间锚点是一路由外侧主动上报的独立数据源（类似禁区/划框），
+     * 复用定点（Spot）渲染，但拥有独立配置：默认尖端对齐坐标、默认不展示，
+     * 需 `show` 为 true 才渲染。不影响普通定点（controls.spot）的行为。
+     */
+    roomAnchor: RoomAnchorConfig
     wayPoint: WayPointConfig
 }
 
@@ -1028,6 +1071,12 @@ export declare type LoggerConfig = {
     appLogEnabled: boolean
     /** 转发到 App 原生日志的级别 */
     appLogLevels: LoggerLevel[]
+    /**
+     * 是否对转发到 App 通道的大数据日志做摘要瘦身。
+     * 仅影响 emitToApp 路径，console 输出始终保留完整数据。
+     * 默认 true：对地图/路径绘制入口提取关键字段，其他大数据按尺寸阈值裁剪。
+     */
+    appLogSummary?: boolean
     tag: string
 }
 
@@ -1041,9 +1090,9 @@ export declare type LoggerPayload = {
     ts: number
 }
 
-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", "getCustomCarpetPointsByViewportCenter", "getRectPointsByCenter", "getFurnitures", "drawCustomZones", "getCustomZones", "clearCustomZones", "setEditingCustomZones"];
+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_CALLBACK_METHODS: readonly ["onMapFirstDrawed", "onMapDrawed", "onPathDrawed", "onRoomPropertiesDrawed", "onRoomsDrawed", "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 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"];
 
 /**
  * 地图 API 接口定义
@@ -1188,6 +1237,15 @@ export declare interface MapApi {
      * @returns 定点清扫数据数组
      */
     getSpots(): SpotParam[];
+    /**
+     * 获取当前地图上所有房间锚点数据
+     *
+     * 房间锚点是由外侧主动上报的独立数据源，与定点相互独立。返回值以数据缓存为准，
+     * 不受 `controls.roomAnchor.show` 当前显隐状态影响。
+     *
+     * @returns 房间锚点数据数组
+     */
+    getRoomAnchors(): RoomAnchorParam[];
     /**
      * 获取当前地图上所有家具数据
      *
@@ -1656,6 +1714,15 @@ export declare interface MapCallbacks {
      * @param.en spot - Updated spot clean data
      */
     onUpdateSpot?: (spot: SpotParam) => void;
+    /**
+     * @description.zh 更新房间锚点的回调
+     * @description.en Callback when updating room anchor
+     * @description.zh 当用户操作房间锚点位置后触发（房间锚点复用定点渲染，可编辑时生效）。
+     * @description.en Triggered when user operates room anchor position (room anchors reuse spot rendering; effective when editable).
+     * @param.zh point - 更新后的房间锚点数据
+     * @param.en point - Updated room anchor data
+     */
+    onUpdateRoomAnchor?: (point: RoomAnchorParam) => void;
     /**
      * @description.zh 更新途经点的回调
      * @description.en Callback when updating way point
@@ -1719,6 +1786,15 @@ export declare interface MapCallbacks {
      * @param.en spot - Clicked spot clean data
      */
     onClickSpot?: (spot: SpotParam) => void;
+    /**
+     * @description.zh 点击房间锚点回调
+     * @description.en Callback when clicking room anchor
+     * @description.zh 当用户点击房间锚点时触发。
+     * @description.en Triggered when user clicks room anchor.
+     * @param.zh point - 被点击的房间锚点数据
+     * @param.en point - Clicked room anchor data
+     */
+    onClickRoomAnchor?: (point: RoomAnchorParam) => void;
     /**
      * @description.zh 点击检测物体回调
      * @description.en Callback when clicking detected object
@@ -2115,6 +2191,43 @@ export declare type Room = {
     colorIndex?: number
 }
 
+/**
+ * 房间锚点配置。
+ *
+ * 房间锚点复用定点（Spot）的全部渲染能力，因此其配置就是一份 {@link SpotConfig}，
+ * 额外增加一个 `show` 开关：
+ * - `show` 默认 `false`，房间锚点默认不展示；置为 `true` 后才渲染（类似 showName 的显隐能力）。
+ *
+ * 房间锚点数据由外侧主动上报（见 `drawRoomAnchors`），与普通定点相互独立，
+ * 互不影响。默认 `iconAnchor` 为 `{ x: 0.5, y: 1 }`（尖端对齐坐标），
+ * 而普通定点默认居中，因此两者可拥有不同视觉表现。
+ */
+export declare type RoomAnchorConfig = SpotConfig & {
+    /** 是否展示房间锚点，默认 false；关闭时不渲染任何房间锚点 */
+    show: boolean
+}
+
+/**
+ * 房间锚点参数。
+ *
+ * 房间锚点是与定点（{@link SpotParam}）完全独立的一类元素，拥有自己的数据类型，
+ * 二者互不耦合、互不影响。字段结构目前与定点相近，但可各自独立演进。
+ */
+export declare type RoomAnchorParam = {
+    /** 房间锚点ID */
+    id: string
+    /** 点坐标 */
+    point: Point
+    /** 可选显示名称 */
+    name?: string
+    /**
+     * 可选所属房间 ID。设置后该房间锚点即与房间关联：编辑态拖拽被硬约束在该房间内，
+     * 无法拖出房间边界（拖到房间外的位置会被拒绝，停留在最后一个合法位置）。
+     * 不设置则为普通房间锚点，可自由拖拽。
+     */
+    roomId?: number
+}
+
 /**
  * 房间中心点信息
  *
@@ -2224,6 +2337,8 @@ export declare type RuntimeConfig = {
     editingVirtualWallIds: string[]
     /** 正在编辑的定点清扫ID列表 */
     editingSpotIds: string[]
+    /** 正在编辑的房间锚点ID列表（独立于 editingSpotIds，互不影响） */
+    editingRoomAnchorIds: string[]
     /** 正在编辑的途径点ID列表 */
     editingWayPointIds: string[]
     /** 正在编辑的地毯ID列表 */
@@ -2286,6 +2401,16 @@ export declare type SpotConfig = {
     iconSize: number
     /** 图标尺寸是否固定（不跟随地图缩放） */
     iconSizeFixed: boolean
+    /**
+     * 图标锚点位置
+     *
+     * 定义中心图标相对于坐标点的对齐方式
+     * - {x: 0, y: 0} 表示左上角
+     * - {x: 0.5, y: 0.5} 表示中心（默认）
+     * - {x: 0.5, y: 1} 表示底部中心（适用于气泡/水滴形状的图标）
+     * - {x: 1, y: 1} 表示右下角
+     */
+    iconAnchor: Point
     /** 尺寸 (米) */
     size: number
     /** 描边颜色 */
@@ -2336,8 +2461,10 @@ export declare type SpotConfig = {
         dashArray: [number, number]
         /** 是否显示图标 */
         showIcon: boolean
-        /** 是否显示框体（填充和边框） */
+        /** 是否显示框体（边框；同时作为填充的默认开关） */
         showFrame: boolean
+        /** 是否显示填充面积（缺省时回退到 showFrame） */
+        showFill?: boolean
     }
     /** 普通模式样式 */
     normal: {
@@ -2347,8 +2474,10 @@ export declare type SpotConfig = {
         dashArray: [number, number]
         /** 是否显示图标 */
         showIcon: boolean
-        /** 是否显示框体（填充和边框） */
+        /** 是否显示框体（边框；同时作为填充的默认开关） */
         showFrame: boolean
+        /** 是否显示填充面积（缺省时回退到 showFrame） */
+        showFill?: boolean
     }
 }
 
@@ -2360,6 +2489,12 @@ export declare type SpotParam = {
     point: Point
     /** 可选显示名称 */
     name?: string
+    /**
+     * 可选所属房间 ID。设置后该定点即与房间关联：编辑态拖拽被硬约束在该房间内，
+     * 无法拖出房间边界（拖到房间外的位置会被拒绝，停留在最后一个合法位置）。
+     * 不设置则为普通定点，可自由拖拽。
+     */
+    roomId?: number
 }
 
 /** 虚拟墙配置 */