@ray-js/api 1.7.83 → 1.7.84

package/lib/nativeRouters/device.d.ts

@@ -6,7 +6,6 @@ type OpenSceneCreateParams = {
 /**
  * 跳转创建场景页面
  * @param params - 创建场景参数
- * @param params.devId 设备 ID
  * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
  * @public
  * @since @ray-js/ray 1.4.32
@@ -28,7 +27,6 @@ export declare function openSceneCreate(params?: OpenSceneCreateParams): Promise
 /**
  * 跳转创建场景页面
  * @param params - 创建场景参数
- * @param params.devId 设备 ID
  * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
  * @public
  * @since @ray-js/ray 1.4.32
@@ -78,8 +76,6 @@ type OpenSceneEdit = {
 /**
  * 跳转编辑场景页面
  * @param params - 编辑场景参数
- * @param params.devId 设备 ID
- * @param params.sceneId 场景 ID
  * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
  * @public
  * @since @ray-js/ray 1.4.32
@@ -104,8 +100,6 @@ export declare function openSceneEdit(params?: OpenSceneEdit): Promise<void>;
 /**
  * 跳转编辑场景页面
  * @param params - 编辑场景参数
- * @param params.devId 设备 ID
- * @param params.sceneId 场景 ID
  * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
  * @public
  * @since @ray-js/ray 1.4.32
@@ -134,7 +128,6 @@ type OpenGuideScene = {
 /**
  * 跳转场景引导页面
  * @param params - 引导页参数
- * @param params.action 操作类型，'add' 为新增，'edit' 为编辑
  * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
  * @public
  * @since @ray-js/ray 1.4.32
@@ -154,32 +147,74 @@ type OpenGuideScene = {
  */
 export declare function openGuideScene(params?: OpenGuideScene): Promise<void>;
 type OpenConfigDevice = {
+    /** 设备 ID */
     devId?: string;
+    /** 场景 ID */
     sceneId?: string;
 } & ICommon;
 /**
- * 打开编辑场景页面
- * @param params { devId?: string, sceneId?: string, success?: () => void, fail?: (err?: { errorMsg: string, errorCode: string | number, innerError: { errorCode: string | number, errorMsg: string } }) => void, complete?: () => void, [key: string]: string | boolean | number }
- * @returns
+ * 跳转设备场景配置页面
+ * @param params - 设备场景配置参数
+ * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
+ * @public
+ * @since @ray-js/ray 1.4.32
+ * @example
+ * ```typescript
+ * import { openConfigDevice } from '@ray-js/ray';
+ *
+ * await openConfigDevice({
+ *   devId: 'device_001',
+ *   sceneId: 'scene_001',
+ * });
+ * ```
  */
 export declare function openConfigDevice(params?: OpenConfigDevice): Promise<void>;
 type OpenDevNetworkCheck = {} & ICommon;
 /**
- * 检测设备网络
- * @param params { }
- * @returns
+ * 跳转设备网络检测页面
+ * @param params - 通用跳转参数
+ * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
+ * @public
+ * @since @ray-js/ray 1.4.47
+ * @example
+ * ```typescript
+ * import { openDevNetworkCheck } from '@ray-js/ray';
+ *
+ * await openDevNetworkCheck();
+ * ```
  */
 export declare function openDevNetworkCheck(params?: OpenDevNetworkCheck): Promise<void>;
 type OpenSmartScene = {} & ICommon;
 /**
- * 跳转场景
+ * 跳转智能场景页面
+ * @param params - 通用跳转参数
+ * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
+ * @public
+ * @since @ray-js/ray 1.4.47
+ * @example
+ * ```typescript
+ * import { openSmartScene } from '@ray-js/ray';
+ *
+ * await openSmartScene();
+ * ```
  */
 export declare function openSmartScene(params?: OpenSmartScene): Promise<void>;
 type OpenDevManualAndSmart = {
+    /** 设备 ID */
     devId?: string;
 } & ICommon;
 /**
- * 打开 “一键执行”和“自动化”
+ * 跳转设备的“一键执行”和“自动化”页面
+ * @param params - 跳转参数
+ * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
+ * @public
+ * @since @ray-js/ray 1.4.47
+ * @example
+ * ```typescript
+ * import { openDevManualAndSmart } from '@ray-js/ray';
+ *
+ * await openDevManualAndSmart({ devId: 'device_001' });
+ * ```
  */
 export declare function openDevManualAndSmart(params?: OpenDevManualAndSmart): Promise<void>;
 type OpenDeviceOnlySearchConfigGwSub = {

package/lib/nativeRouters/device.js

@@ -3,7 +3,6 @@ import { nativeRouter } from './common';
 /**
  * 跳转创建场景页面
  * @param params - 创建场景参数
- * @param params.devId 设备 ID
  * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
  * @public
  * @since @ray-js/ray 1.4.32
@@ -28,7 +27,6 @@ export function openSceneCreate(params) {
 /**
  * 跳转创建场景页面
  * @param params - 创建场景参数
- * @param params.devId 设备 ID
  * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
  * @public
  * @since @ray-js/ray 1.4.32
@@ -84,8 +82,6 @@ export function openUniversalCreateScene(params) {
 /**
  * 跳转编辑场景页面
  * @param params - 编辑场景参数
- * @param params.devId 设备 ID
- * @param params.sceneId 场景 ID
  * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
  * @public
  * @since @ray-js/ray 1.4.32
@@ -113,8 +109,6 @@ export function openSceneEdit(params) {
 /**
  * 跳转编辑场景页面
  * @param params - 编辑场景参数
- * @param params.devId 设备 ID
- * @param params.sceneId 场景 ID
  * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
  * @public
  * @since @ray-js/ray 1.4.32
@@ -141,7 +135,6 @@ export function openEditScene(params) {
 /**
  * 跳转场景引导页面
  * @param params - 引导页参数
- * @param params.action 操作类型，'add' 为新增，'edit' 为编辑
  * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
  * @public
  * @since @ray-js/ray 1.4.32
@@ -163,9 +156,20 @@ export function openGuideScene(params) {
   return nativeRouter('thing_add_scene', params);
 }
 /**
- * 打开编辑场景页面
- * @param params { devId?: string, sceneId?: string, success?: () => void, fail?: (err?: { errorMsg: string, errorCode: string | number, innerError: { errorCode: string | number, errorMsg: string } }) => void, complete?: () => void, [key: string]: string | boolean | number }
- * @returns
+ * 跳转设备场景配置页面
+ * @param params - 设备场景配置参数
+ * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
+ * @public
+ * @since @ray-js/ray 1.4.32
+ * @example
+ * ```typescript
+ * import { openConfigDevice } from '@ray-js/ray';
+ *
+ * await openConfigDevice({
+ *   devId: 'device_001',
+ *   sceneId: 'scene_001',
+ * });
+ * ```
  */
 export function openConfigDevice(params) {
   return nativeRouter('config_device', params);
@@ -174,9 +178,17 @@ export function openConfigDevice(params) {
 // dev_network_check
 
 /**
- * 检测设备网络
- * @param params { }
- * @returns
+ * 跳转设备网络检测页面
+ * @param params - 通用跳转参数
+ * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
+ * @public
+ * @since @ray-js/ray 1.4.47
+ * @example
+ * ```typescript
+ * import { openDevNetworkCheck } from '@ray-js/ray';
+ *
+ * await openDevNetworkCheck();
+ * ```
  */
 export function openDevNetworkCheck(params) {
   return nativeRouter('dev_network_check', params);
@@ -185,7 +197,17 @@ export function openDevNetworkCheck(params) {
 // 跳转场景 smartScene
 
 /**
- * 跳转场景
+ * 跳转智能场景页面
+ * @param params - 通用跳转参数
+ * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
+ * @public
+ * @since @ray-js/ray 1.4.47
+ * @example
+ * ```typescript
+ * import { openSmartScene } from '@ray-js/ray';
+ *
+ * await openSmartScene();
+ * ```
  */
 export function openSmartScene(params) {
   return nativeRouter('smartScene', params);
@@ -194,7 +216,17 @@ export function openSmartScene(params) {
 // 打开 “一键执行”和“自动化” devManualAndSmart
 
 /**
- * 打开 “一键执行”和“自动化”
+ * 跳转设备的“一键执行”和“自动化”页面
+ * @param params - 跳转参数
+ * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
+ * @public
+ * @since @ray-js/ray 1.4.47
+ * @example
+ * ```typescript
+ * import { openDevManualAndSmart } from '@ray-js/ray';
+ *
+ * await openDevManualAndSmart({ devId: 'device_001' });
+ * ```
  */
 export function openDevManualAndSmart(params) {
   return nativeRouter('devManualAndSmart', params);

package/lib/nativeRouters/gw.d.ts

@@ -6,7 +6,6 @@ type GwIdParams = {
 /**
  * 打开 ZigBee 网关面板配网子设备(旧版)
  * @param params - 网关参数
- * @param params.gwId 网关 ID
  * @returns void
  * @public
  * @since @ray-js/ray 1.7.60
@@ -29,7 +28,6 @@ export declare function openPresentGatewayCategroy(params?: GwIdParams): Promise
 /**
  * 打开网关面板搜索配网页面，用于搜索并添加子设备
  * @param params - 网关参数
- * @param params.gwId 网关 ID
  * @returns void
  * @public
  * @since @ray-js/ray 1.7.60
@@ -51,7 +49,6 @@ export declare function openDeviceGWSubSearchConfigure(params?: GwIdParams): Pro
 /**
  * 打开网关面板配网子设备帮助列表页面
  * @param params - 网关参数
- * @param params.gwId 网关 ID
  * @returns void
  * @public
  * @since @ray-js/ray 1.7.60

package/lib/nativeRouters/gw.js

@@ -2,7 +2,6 @@ import { nativeRouter } from './common';
 /**
  * 打开 ZigBee 网关面板配网子设备(旧版)
  * @param params - 网关参数
- * @param params.gwId 网关 ID
  * @returns void
  * @public
  * @since @ray-js/ray 1.7.60
@@ -28,7 +27,6 @@ export function openPresentGatewayCategroy(params) {
 /**
  * 打开网关面板搜索配网页面，用于搜索并添加子设备
  * @param params - 网关参数
- * @param params.gwId 网关 ID
  * @returns void
  * @public
  * @since @ray-js/ray 1.7.60
@@ -53,7 +51,6 @@ export function openDeviceGWSubSearchConfigure(params) {
 /**
  * 打开网关面板配网子设备帮助列表页面
  * @param params - 网关参数
- * @param params.gwId 网关 ID
  * @returns void
  * @public
  * @since @ray-js/ray 1.7.60

package/lib/nativeRouters/outdoors.d.ts

@@ -51,12 +51,21 @@ type OpenOutdoorShortcutSiriParams = {
  */
 export declare function openOutdoorShortcutSiri(params: OpenOutdoorShortcutSiriParams): Promise<void>;
 type OpenOutdoorConfigDeviceHomeParams = {
+    /** 产品 ID */
     productId?: string;
 } & ICommon;
 /**
- * 打开配网
- * @param params {productId: string}
- * @returns
+ * 跳转户外设备配网页面
+ * @param params - 配网参数
+ * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
+ * @public
+ * @since @ray-js/ray 1.4.29
+ * @example
+ * ```typescript
+ * import { openOutdoorConfigDeviceHome } from '@ray-js/ray';
+ *
+ * await openOutdoorConfigDeviceHome({ productId: 'product_001' });
+ * ```
  */
 export declare function openOutdoorConfigDeviceHome(params: OpenOutdoorConfigDeviceHomeParams): Promise<void>;
 export {};

package/lib/nativeRouters/outdoors.js

@@ -47,9 +47,17 @@ export function openOutdoorShortcutSiri(params) {
   return nativeRouter('tsod_shortcut_siri', params);
 }
 /**
- * 打开配网
- * @param params {productId: string}
- * @returns
+ * 跳转户外设备配网页面
+ * @param params - 配网参数
+ * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
+ * @public
+ * @since @ray-js/ray 1.4.29
+ * @example
+ * ```typescript
+ * import { openOutdoorConfigDeviceHome } from '@ray-js/ray';
+ *
+ * await openOutdoorConfigDeviceHome({ productId: 'product_001' });
+ * ```
  */
 export function openOutdoorConfigDeviceHome(params) {
   return nativeRouter('config_device_home', params);

package/lib/nativeRouters/root.d.ts

@@ -11,14 +11,31 @@ type OpenAppScanParams = {
 export declare function openAppScan(params?: OpenAppScanParams): Promise<void>;
 type OpenHelpAndFeedback = {} & ICommon;
 /**
- * 打开帮助与反馈
- * @param params { }
- * @returns
+ * 跳转帮助与反馈页面
+ * @param params - 通用跳转参数
+ * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
+ * @public
+ * @since @ray-js/ray 1.4.47
+ * @example
+ * ```typescript
+ * import { openHelpAndFeedback } from '@ray-js/ray';
+ *
+ * await openHelpAndFeedback();
+ * ```
  */
 export declare function openHelpAndFeedback(params?: OpenHelpAndFeedback): Promise<void>;
 type OpenMoreService = {} & ICommon;
 /**
- * 跳转到更多服务
+ * 跳转更多服务页面
+ * @param params - 通用跳转参数
+ * @public
+ * @since @ray-js/ray 1.4.47
+ * @example
+ * ```typescript
+ * import { openMoreService } from '@ray-js/ray';
+ *
+ * await openMoreService();
+ * ```
  */
 export declare function openMoreService(params?: OpenMoreService): Promise<void>;
 type OpenAppHelpCenter = {
@@ -49,10 +66,21 @@ type OpenAppHelpCenter = {
  */
 export declare function openAppHelpCenter(params?: OpenAppHelpCenter): Promise<void>;
 type OpenMessageCenter = {
+    /** 消息分类：0 告警，1 家庭，2 通知 */
     category?: 0 | 1 | 2;
 } & ICommon;
 /**
- * 跳转到消息中心
+ * 跳转消息中心页面
+ * @param params - 消息中心参数
+ * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
+ * @public
+ * @since @ray-js/ray 1.4.47
+ * @example
+ * ```typescript
+ * import { openMessageCenter } from '@ray-js/ray';
+ *
+ * await openMessageCenter({ category: 2 });
+ * ```
  */
 export declare function openMessageCenter(params?: OpenMessageCenter): Promise<void>;
 type OpenCompleteUserInfo = {} & ICommon;

package/lib/nativeRouters/root.js

@@ -11,9 +11,17 @@ export function openAppScan(params) {
   return nativeRouter('scan', params);
 }
 /**
- * 打开帮助与反馈
- * @param params { }
- * @returns
+ * 跳转帮助与反馈页面
+ * @param params - 通用跳转参数
+ * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
+ * @public
+ * @since @ray-js/ray 1.4.47
+ * @example
+ * ```typescript
+ * import { openHelpAndFeedback } from '@ray-js/ray';
+ *
+ * await openHelpAndFeedback();
+ * ```
  */
 export function openHelpAndFeedback(params) {
   return nativeRouter('helpAndFeedBack', params);
@@ -22,7 +30,16 @@ export function openHelpAndFeedback(params) {
 // more_service
 
 /**
- * 跳转到更多服务
+ * 跳转更多服务页面
+ * @param params - 通用跳转参数
+ * @public
+ * @since @ray-js/ray 1.4.47
+ * @example
+ * ```typescript
+ * import { openMoreService } from '@ray-js/ray';
+ *
+ * await openMoreService();
+ * ```
  */
 export function openMoreService(params) {
   return nativeRouter('more_service', params);
@@ -67,7 +84,17 @@ export function openAppHelpCenter(params) {
 // messageCenter
 
 /**
- * 跳转到消息中心
+ * 跳转消息中心页面
+ * @param params - 消息中心参数
+ * @returns 跳转结果的 Promise，成功时 resolve，失败时 reject
+ * @public
+ * @since @ray-js/ray 1.4.47
+ * @example
+ * ```typescript
+ * import { openMessageCenter } from '@ray-js/ray';
+ *
+ * await openMessageCenter({ category: 2 });
+ * ```
  */
 export function openMessageCenter(params) {
   return nativeRouter('messageCenter', params);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ray-js/api",
-  "version": "1.7.83",
+  "version": "1.7.84",
   "description": "Ray universal api",
   "keywords": [
     "ray"
@@ -29,8 +29,8 @@
     "watch": "ray start --type=component"
   },
   "dependencies": {
-    "@ray-js/framework": "1.7.83",
-    "@ray-js/router": "1.7.83",
+    "@ray-js/framework": "1.7.84",
+    "@ray-js/router": "1.7.84",
     "base64-browser": "^1.0.1",
     "query-string": "^7.1.3"
   },
@@ -38,7 +38,7 @@
     "@ray-js/wechat": "^0.3.13"
   },
   "devDependencies": {
-    "@ray-js/cli": "1.7.83",
+    "@ray-js/cli": "1.7.84",
     "art-template": "^4.13.4",
     "fs-extra": "^10.1.0",
     "miniprogram-api-typings": "^3.12.3",
@@ -48,5 +48,5 @@
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
-  "gitHead": "f431d6e9c446b1f0668fcb11f04c5df98a3c0ac2"
+  "gitHead": "a4a58d3a6b2559b9d00c1b2d99e86c4764ee2332"
 }