@ray-js/api 1.6.23 → 1.6.25

package/@types/api-cloud.d.ts

@@ -158,4 +158,84 @@ declare namespace ty {
    * @returns 获取扫地机的语音包列表结果的 Promise
    */
   function getVoiceList(params: GetVoiceListParams): Promise<GetVoiceListResponse>
+
+  // #region 获取陀螺仪扫地机的清扫记录
+  type GetGyroCleanRecordsParams = {
+    userId?: string | '0'
+    dpIds: number[] // dp点集合
+    offset: number // 偏移量
+    limit: number // 分页
+    devId: string // 设备id
+  }
+
+  type GetGyroCleanRecordsResponse = {
+    datas: {
+      uuid: string
+      dps: any[]
+    }[]
+  }
+
+  /**
+   * 获取陀螺仪扫地机的清扫记录
+   * @returns 获取陀螺仪扫地机的清扫记录结果的 Promise
+   */
+  function getGyroCleanRecords(
+    params: GetGyroCleanRecordsParams
+  ): Promise<GetGyroCleanRecordsResponse>
+
+  // #endregion
+
+  // #region 获取陀螺仪扫地机的清扫记录详情
+  type GetGyroCleanRecordDetailParams = {
+    start: number // startRow
+    size: number // 分页
+    devId: string // 设备id
+    subRecordId: number // 记录id
+  }
+
+  type GetGyroCleanRecordDetailResponse = {
+    datas: {
+      dataList: string[]
+      startRow: string
+      devId: string
+      subRecordId: number // 记录id;
+      hasNext: boolean // 是否有下一页
+    }
+  }
+
+  /**
+   * 获取陀螺仪扫地机的清扫记录详情
+   * @returns 获取陀螺仪扫地机的清扫记录详情结果的 Promise
+   */
+  function getGyroCleanRecordDetail(
+    params: GetGyroCleanRecordDetailParams
+  ): Promise<GetGyroCleanRecordDetailResponse>
+
+  // #region 获取扫地机的历史地图
+  type GetGyroLatestCleanMapParams = {
+    start: number // startRow
+    size: number // 分页
+    devId: string // 设备id
+  }
+
+  type GetGyroLatestCleanMapResponse = {
+    datas: {
+      dataList: string[]
+      startRow: string
+      devId: string
+      subRecordId: number // 记录id;
+      hasNext: boolean // 是否有下一页
+    }
+  }
+
+  /**
+   * @note扫地机新增接口
+   * 获取陀螺仪扫地机的最新清扫地图
+   * @returns 获取陀螺仪扫地机的最新清扫地图结果的 Promise
+   */
+  function getGyroLatestCleanMap(
+    params: GetGyroLatestCleanMapParams
+  ): Promise<GetGyroLatestCleanMapResponse>
+
+  // #endregion
 }

package/@types/api-extend.d.ts

@@ -296,6 +296,7 @@ declare namespace ty {
   export function offThemeChange(listener?: OffThemeChangelisteners)
   export function onPageNotFound(listeners: ({ url: string, query: CommonObject }) => void)
   export function onNavigationBarBack(callback: (res?: any) => void)
+  export function offNavigationBarBack(callback: (res?: any) => void)
   export function setNavigationBarBack(param: setNavigationBarBackParam)
   /**
    * 0.10.3
@@ -390,6 +391,39 @@ declare namespace ty {
    *@description 从本地缓存中异步获取指定 key 的内容
    *@error {6: 'The parameter format is incorrect'}*/
   export function getStorageSync(storageKeyBean?: StorageKeyBean): any
+
+  /**
+   * @description对页面内的唯一元素进行截图
+   * 基础库 2.23.0 开始支持
+   * 属性类型默认值必填说明
+   * selector string 否 元素唯一ID 或唯一 class , 默认: 截取当前页面
+   * backgroundColor string 否 背景颜色, 默认: jpeg #ffffff png 透明
+   * format string 否 图片格式, 默认: png 可选值: jpeg, png
+   * quality number 否 图片质量, 默认: 1 可选值: 0-1, 仅在 jpeg 格式下有效
+   * success function 否 接口调用成功的回调函数
+   * fail function 否 接口调用失败的回调函数
+   * complete function 否 接口调用结束的回调函数
+   * 注意: 可能由于页面样式的复杂度因素，截图结果可能会有所不同，如遇到此类问题，可尝试调整页面样式
+   */
+  export function snapshot(params: {
+    selector?: string
+    backgroundColor?: string
+    format?: string
+    quality?: number
+    success?: (params: {
+      /** 截图的临时文件路径 */
+      tempFilePath: string
+    }) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError?: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+    complete?: () => void
+  }): void
 }
 
 declare namespace WechatMiniprogram {

package/lib/cloud/laser-clean/index.d.ts

@@ -1,3 +1,3 @@
-export { getCleaningRecords, deleteCleaningRecord } from './record';
+export { getCleaningRecords, deleteCleaningRecord, getGyroCleanRecords, getGyroCleanRecordDetail, } from './record';
 export { getVoiceList } from './voice';
-export { getMultipleMapFiles, getSweeperStorageConfig, deleteMultipleMapFiles } from './map';
+export { getMultipleMapFiles, getSweeperStorageConfig, deleteMultipleMapFiles, getGyroLatestCleanMap, } from './map';

package/lib/cloud/laser-clean/index.js

@@ -1,3 +1,3 @@
-export { getCleaningRecords, deleteCleaningRecord } from './record';
+export { getCleaningRecords, deleteCleaningRecord, getGyroCleanRecords, getGyroCleanRecordDetail } from './record';
 export { getVoiceList } from './voice';
-export { getMultipleMapFiles, getSweeperStorageConfig, deleteMultipleMapFiles } from './map';
+export { getMultipleMapFiles, getSweeperStorageConfig, deleteMultipleMapFiles, getGyroLatestCleanMap } from './map';

package/lib/cloud/laser-clean/map.d.ts

@@ -1,4 +1,5 @@
 declare const getMultipleMapFiles: typeof ty.getMultipleMapFiles;
 declare const getSweeperStorageConfig: typeof ty.getSweeperStorageConfig;
 declare const deleteMultipleMapFiles: typeof ty.deleteMultipleMapFiles;
-export { getMultipleMapFiles, getSweeperStorageConfig, deleteMultipleMapFiles };
+declare const getGyroLatestCleanMap: typeof ty.getGyroLatestCleanMap;
+export { getMultipleMapFiles, getSweeperStorageConfig, deleteMultipleMapFiles, getGyroLatestCleanMap, };

package/lib/cloud/laser-clean/map.js

@@ -4,4 +4,5 @@ import { factory } from '../../utils';
 const getMultipleMapFiles = factory('getMultipleMapFiles');
 const getSweeperStorageConfig = factory('getSweeperStorageConfig');
 const deleteMultipleMapFiles = factory('deleteMultipleMapFiles');
-export { getMultipleMapFiles, getSweeperStorageConfig, deleteMultipleMapFiles };
+const getGyroLatestCleanMap = factory('getGyroLatestCleanMap');
+export { getMultipleMapFiles, getSweeperStorageConfig, deleteMultipleMapFiles, getGyroLatestCleanMap };

package/lib/cloud/laser-clean/record.d.ts

@@ -1,3 +1,5 @@
 declare const getCleaningRecords: typeof ty.getCleaningRecords;
 declare const deleteCleaningRecord: typeof ty.deleteCleaningRecord;
-export { getCleaningRecords, deleteCleaningRecord };
+declare const getGyroCleanRecords: typeof ty.getGyroCleanRecords;
+declare const getGyroCleanRecordDetail: typeof ty.getGyroCleanRecordDetail;
+export { getCleaningRecords, deleteCleaningRecord, getGyroCleanRecords, getGyroCleanRecordDetail };

package/lib/cloud/laser-clean/record.js

@@ -2,4 +2,6 @@
 import { factory } from '../../utils';
 const getCleaningRecords = factory('getCleaningRecords');
 const deleteCleaningRecord = factory('deleteCleaningRecord');
-export { getCleaningRecords, deleteCleaningRecord };
+const getGyroCleanRecords = factory('getGyroCleanRecords');
+const getGyroCleanRecordDetail = factory('getGyroCleanRecordDetail');
+export { getCleaningRecords, deleteCleaningRecord, getGyroCleanRecords, getGyroCleanRecordDetail };

package/lib/index.d.ts

@@ -76,7 +76,7 @@ export { default as setNavigationBarTitle } from './setNavigationBarTitle';
 export { default as showNotification } from './showNotification';
 export { default as showTabBar } from './showTabBar';
 export { default as switchTab } from './switchTab';
-export { default as onNavigationBarBack } from './onNavigationBarBack';
+export { onNavigationBarBack, offNavigationBarBack } from './onNavigationBarBack';
 export { default as setNavigationBarBack } from './setNavigationBarBack';
 export { default as getCdnUrl, getCdnUrlAsync } from './getCdnUrl';
 /**

package/lib/index.js

@@ -24,7 +24,7 @@ export { default as setNavigationBarTitle } from './setNavigationBarTitle';
 export { default as showNotification } from './showNotification';
 export { default as showTabBar } from './showTabBar';
 export { default as switchTab } from './switchTab';
-export { default as onNavigationBarBack } from './onNavigationBarBack';
+export { onNavigationBarBack, offNavigationBarBack } from './onNavigationBarBack';
 export { default as setNavigationBarBack } from './setNavigationBarBack';
 export { default as getCdnUrl, getCdnUrlAsync } from './getCdnUrl';
 

package/lib/onNavigationBarBack/index.d.ts

@@ -1,2 +1,3 @@
 declare const onNavigationBarBack: typeof ty.onNavigationBarBack;
-export default onNavigationBarBack;
+declare const offNavigationBarBack: typeof ty.offNavigationBarBack;
+export { onNavigationBarBack, offNavigationBarBack };

package/lib/onNavigationBarBack/index.js

@@ -1,4 +1,7 @@
 const onNavigationBarBack = function () {
   console.warn('尚未支持');
 };
-export default onNavigationBarBack;
+const offNavigationBarBack = function () {
+  console.warn('尚未支持');
+};
+export { onNavigationBarBack, offNavigationBarBack };

package/lib/onNavigationBarBack/index.thing.d.ts

@@ -1,2 +1,2 @@
-declare const _default: typeof ty.onNavigationBarBack;
-export default _default;
+export declare const onNavigationBarBack: typeof ty.onNavigationBarBack;
+export declare const offNavigationBarBack: typeof ty.offNavigationBarBack;

package/lib/onNavigationBarBack/index.thing.js

@@ -1 +1,2 @@
-export default ty.onNavigationBarBack;
+export const onNavigationBarBack = ty.onNavigationBarBack;
+export const offNavigationBarBack = ty.offNavigationBarBack;

package/lib/onNavigationBarBack/index.wechat.d.ts

@@ -1,2 +1,3 @@
 declare const onNavigationBarBack: typeof ty.onNavigationBarBack;
-export default onNavigationBarBack;
+declare const offNavigationBarBack: typeof ty.offNavigationBarBack;
+export { onNavigationBarBack, offNavigationBarBack };

package/lib/onNavigationBarBack/index.wechat.js

@@ -1,4 +1,7 @@
 const onNavigationBarBack = function () {
   console.warn('尚未支持');
 };
-export default onNavigationBarBack;
+const offNavigationBarBack = function () {
+  console.warn('尚未支持');
+};
+export { onNavigationBarBack, offNavigationBarBack };

package/lib/viewAPI.d.ts

@@ -13,3 +13,16 @@ export declare const createIpcPlayerContext: typeof ty.createIpcPlayerContext;
 export declare const createCameraContext: typeof ty.createCameraContext;
 export declare const createWebviewContext: typeof ty.createWebviewContext;
 export declare const connectSocket: typeof ty.connectSocket;
+/**
+ * @description 对页面内的唯一元素进行截图，注意: 可能由于页面样式的复杂度因素，截图结果可能会有所不同，如遇到此类问题，可尝试调整页面样式
+ * @since 基础库 2.23.0 @ray-js/ray 1.6.24
+ * @param {Object} params
+ * @property {string} params.selector 元素唯一ID 或唯一 class , 默认: 截取当前页面
+ * @property {string} params.backgroundColor 背景颜色, 默认: jpeg #ffffff png 透明
+ * @property {string} params.format 图片格式, 默认: png 可选值: jpeg, png
+ * @property {number} params.quality 图片质量, 默认: 1 可选值: 0-1, 仅在 jpeg 格式下有效
+ * @returns {Promise} 接口调用成功的回调函数
+ * @returns {Promise} 接口调用失败的回调函数
+ * @returns {Promise} 接口调用结束的回调函数
+ */
+export declare const snapshot: typeof ty.snapshot;

package/lib/viewAPI.js

@@ -15,4 +15,18 @@ export const createMapContext = factory('createMapContext');
 export const createIpcPlayerContext = factory('createIpcPlayerContext');
 export const createCameraContext = factory('createCameraContext');
 export const createWebviewContext = factory('createWebviewContext');
-export const connectSocket = factory('connectSocket');
+export const connectSocket = factory('connectSocket');
+
+/**
+ * @description 对页面内的唯一元素进行截图，注意: 可能由于页面样式的复杂度因素，截图结果可能会有所不同，如遇到此类问题，可尝试调整页面样式
+ * @since 基础库 2.23.0 @ray-js/ray 1.6.24
+ * @param {Object} params
+ * @property {string} params.selector 元素唯一ID 或唯一 class , 默认: 截取当前页面
+ * @property {string} params.backgroundColor 背景颜色, 默认: jpeg #ffffff png 透明
+ * @property {string} params.format 图片格式, 默认: png 可选值: jpeg, png
+ * @property {number} params.quality 图片质量, 默认: 1 可选值: 0-1, 仅在 jpeg 格式下有效
+ * @returns {Promise} 接口调用成功的回调函数
+ * @returns {Promise} 接口调用失败的回调函数
+ * @returns {Promise} 接口调用结束的回调函数
+ */
+export const snapshot = factory('snapshot');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ray-js/api",
-  "version": "1.6.23",
+  "version": "1.6.25",
   "description": "Ray universal api",
   "keywords": [
     "ray"
@@ -29,14 +29,14 @@
     "watch": "ray start --type=component"
   },
   "dependencies": {
-    "@ray-js/framework": "1.6.23",
-    "@ray-js/router": "1.6.23",
+    "@ray-js/framework": "1.6.25",
+    "@ray-js/router": "1.6.25",
     "@ray-js/wechat": "^0.2.19",
     "base64-browser": "^1.0.1",
     "query-string": "^7.1.3"
   },
   "devDependencies": {
-    "@ray-js/cli": "1.6.23",
+    "@ray-js/cli": "1.6.25",
     "art-template": "^4.13.2",
     "fs-extra": "^10.1.0",
     "miniprogram-api-typings": "^3.12.3",
@@ -46,5 +46,5 @@
     "access": "public",
     "registry": "https://registry.npmjs.com"
   },
-  "gitHead": "cd98eb4ba0a92a48313b16b54e598c6f506a2fad"
+  "gitHead": "a2c08384889bbc2b1812c4a37490126c18aa1803"
 }