@ray-js/ray-ipc-utils 1.1.5 → 1.1.6

package/README.md

@@ -1,8 +1,8 @@
 [English](./README.md) | 简体中文
 
-# @ray/ray-ipc-utils
+# @ray-js/ray-ipc-utils
 
-[![latest](https://img.shields.io/npm/v/@ray/ray-ipc-utils/latest.svg)](https://www.npmjs.com/package/@ray/ray-ipc-utils) [![download](https://img.shields.io/npm/dt/@ray/ray-ipc-utils.svg)](https://www.npmjs.com/package/@ray/ray-ipc-utils)
+[![latest](https://img.shields.io/npm/v/@ray/ray-ipc-utils/latest.svg)](https://www.npmjs.com/package/@ray-js/ray-ipc-utils) [![download](https://img.shields.io/npm/dt/@ray/ray-ipc-utils.svg)](https://www.npmjs.com/package/@ray-js/ray-ipc-utils)
 
 > IPC utility library
 
@@ -14,113 +14,17 @@ $ npm install @ray-js/ray-ipc-utils
 $ yarn add @ray-js/ray-ipc-utils
 ```
 
-## Usage
-
-### preloadPanel
-
-预下载设置二级页
-
-入参：
-
-| 参数名称 | 描述     |
-| -------- | -------- |
-| devInfo  | 设备信息 |
-
-devInfo
-
-| 参数名称       | 描述             |
-| -------------- | ---------------- |
-| devId          | 设备 id          |
-| productId      | 产品 id          |
-| productVersion | 产品版本         |
-| i18nTime       | 面板多语言时间戳 |
-
-示例
-
-```tsx
-import { preloadPanel } from '@ray/ray-ipc-utils';
-
-// 预下载面板小程序
-export const getPanelApp = () => {
-  const { devInfo } = store.getState();
-  preloadPanel({
-    devId: devInfo.devId, // 设备id
-    productId: devInfo.productId, // 产品id
-    productVersion: devInfo.pv, // 产品版本
-    i18nTime: devInfo.time, // 面板多语言时间戳
-  });
-};
-```
-
-### openPanel
-
-打开设置二级页
-
-入参：
-
-| 参数名称  | 描述                                       |
-| --------- | ------------------------------------------ |
-| devId     | 设备 id                                    |
-| extraData | 额外参数（一般是主小程序与二级页通信数据） |
-| fn        | 监听二级页传递消息事件                     |
-
-示例
-
-```tsx
-import { openPanel } from '@ray/ray-ipc-utils';
-
-// 打开面板小程序
-export const openPanelApp = () => {
-  const { devInfo, ipcCommon } = store.getState();
-  const { mainDeviceCameraConfig } = ipcCommon;
-
-  openPanel(devInfo.devId, { mainDeviceCameraConfig }, data => {
-    const { type } = data;
-    const supportedAudioMode = data?.mainDeviceCameraConfig?.supportedAudioMode;
-    switch (type) {
-      case 'changeTalkType':
-        // 切换对讲方式
-        Storage.setDevItem('talkType', supportedAudioMode).then(() => {
-          store.dispatch(
-            actions.common.mainDeviceCameraConfig({
-              supportedAudioMode,
-            })
-          );
-        });
-        break;
-      // 退出设置页
-      case 'exitMiniProgram':
-        setTimeout(() => {
-          exitMiniProgram();
-        }, 50);
-        break;
-      default:
-    }
-  });
-};
-```
-
-### useEmitMessage
-
-向一级小程序传递消息，结合 openPanel 传入的第三个参数使用
-
-示例
+## Example
 
 ```tsx
-import { openPanel } from '@ray/ray-ipc-utils';
+import { goToIpcPageNativeRoute } from '@ray-js/ray-ipc-utils';
 
-const emitMessage = useEmitMessage();
+const id = 'ipc_album_panel';
+const deviceId = '1234567890xxxxxx';
 
-useEmitMessage({
-  type: 'exitMiniProgram',
-});
+const result = await goToIpcPageNativeRoute(id, deviceId);
 ```
 
-### 其他方法
+## Documentation
 
-| 方法名称     | 描述          | 返回值类型 |
-| ------------ | ------------- | ---------- |
-| isIos        | 是否 ios 系统 | boolean    |
-| isIphoneX    | 是否 iPhoneX  | boolean    |
-| smallScreen  | 是否小屏幕    | boolean    |
-| middleScreen | 是否中屏幕    | boolean    |
+See [API Reference](https://developer.tuya.com/en/miniapp/solution-panel/ability/special/ipc/toolkit/general) for more information.

package/lib/interface.d.ts

@@ -11,6 +11,7 @@ export declare enum IntercomMode {
     OneWay = "OneWay",
     TwoWay = "TwoWay"
 }
+export declare type TalkMode = 1 | 2;
 export declare enum ServeTpe {
     trafficService = "traffic_service",
     securityCloudService = "security_cloud_service",
@@ -62,3 +63,47 @@ export interface IpcConfigInfo {
      */
     maxZoomSettings: number;
 }
+export interface IApiError {
+    errorMsg: string;
+    errorCode: string | number;
+    innerError: {
+        errorMsg: string;
+        errorCode: string | number;
+    };
+}
+export interface IRes<T> {
+    code?: number;
+    data?: T;
+    msg?: IApiError | string | boolean | Record<string, any>;
+}
+export interface IResData<T> {
+    data: T;
+}
+export interface IResError {
+    code: number;
+    msg: string;
+}
+export interface IResDataError {
+    data: IResError;
+}
+export interface IResDataList<T> {
+    data: T[];
+}
+export interface IResDataListError {
+    data: IResError[];
+}
+export interface HomeInfo {
+    homeId: number;
+    [key: string]: any;
+}
+export interface DevInfo {
+    uuid: string;
+    dps: Record<string, any>;
+    schema: Record<string, any>;
+    [key: string]: any;
+}
+export interface SystemInfo {
+    theme: 'light' | 'dark';
+    [key: string]: any;
+}
+export declare type NativeStorageValue = any;

package/lib/interface.js

@@ -30,4 +30,6 @@ export let MuteMode = /*#__PURE__*/function (MuteMode) {
   MuteMode["ON"] = "ON";
   MuteMode["OFF"] = "OFF";
   return MuteMode;
-}({});
+}({});
+
+// 封装app-api的返回类型

package/lib/kit/device/index.d.ts

@@ -1,4 +1,4 @@
-import { IRes } from '../interface';
+import { IRes } from '../../interface';
 /**
  * 获取信号强度
  * @param deviceId
@@ -8,7 +8,7 @@ import { IRes } from '../interface';
 export declare const requestWifiSignal: <T>(deviceId: string, dps?: {}) => Promise<IRes<T>>;
 /**
  * IPC-低功耗唤醒:低功耗唤醒,唤醒门铃设备
- * 需引入DeviceKit，且在>=3.1.0-ipcwake.1版本才可使用
+ * 需引入DeviceKit
  * @param deviceId
  * @returns
  */

package/lib/kit/device/index.js

@@ -12,14 +12,12 @@ export const requestWifiSignal = function (deviceId) {
         deviceId,
         dps: dps,
         success: res => {
-          console.log('res===requestWifiSignal success', res);
           resolve({
             code: 0,
             data: res
           });
         },
         fail: err => {
-          console.log('res===requestWifiSignal err', err);
           resolve({
             code: -1,
             msg: err
@@ -37,7 +35,7 @@ export const requestWifiSignal = function (deviceId) {
 
 /**
  * IPC-低功耗唤醒:低功耗唤醒,唤醒门铃设备
- * 需引入DeviceKit，且在>=3.1.0-ipcwake.1版本才可使用
+ * 需引入DeviceKit
  * @param deviceId
  * @returns
  */
@@ -49,14 +47,12 @@ export const wakeUpDevice = function (deviceId) {
         deviceId,
         dps: dps,
         success: res => {
-          console.log('res===wakeUpDevice success', res);
           resolve({
             code: 0,
             data: res
           });
         },
         fail: err => {
-          console.log('res===wakeUpDevice err', err);
           resolve({
             code: -1,
             msg: err

package/lib/kit/ipc/index.d.ts

@@ -1,4 +1,4 @@
-import { IRes } from '../interface';
+import { IRes, TalkMode } from '../../interface';
 /**
  *
  * @param deviceId 设备id
@@ -16,7 +16,7 @@ export declare const getNativeStorage: <T>(key: string) => Promise<IRes<T>>;
  * @param key 保存的key属性
  *
  */
-export declare const setNativeStorage: <T>(key: string, data: string) => Promise<IRes<T>>;
+export declare const setNativeStorage: <T>(key: string, data: string | number | boolean | Record<string, any>) => Promise<IRes<T>>;
 /**
  * 清除本地缓存
  * @param key 保存的key属性
@@ -28,7 +28,7 @@ export declare const removeNativeStorage: <T>(key: string) => Promise<IRes<T>>;
  * @param key 保存的key属性
  *
  */
-export declare const publishDps: <T>(deviceId: string, dps: any) => Promise<IRes<T>>;
+export declare const publishDps: <T>(deviceId: string, dps: Record<string, any>) => Promise<IRes<T>>;
 /**
  * 根据DPCode获取最新的DP点的值
  * @param key 保存的key属性
@@ -98,6 +98,13 @@ export declare const isSupportedTalk: <T>(deviceId: string, extendParam?: {}) =>
  * @returns 设备支持的对讲模式。回掉方法的参数为数值型，0 未知；1：单向对讲；2：双向对讲。
  */
 export declare const getCurrentSupportedTalkMode: <T>(deviceId: string, extendParam?: {}) => Promise<IRes<T>>;
+/**
+ * 更新对讲方式
+ * @param deviceId
+ * @param mode 1：单向对讲；2：双向对讲
+ * @returns true
+ */
+export declare const updateTalkMode: (deviceId: string, mode: TalkMode) => Promise<IRes<boolean>>;
 /**
  * 跳转 APP 原生页面
  * @param {string} url 页面路由
@@ -109,7 +116,7 @@ export declare const getCurrentSupportedTalkMode: <T>(deviceId: string, extendPa
  */
 export declare const goToIpcPageNativeRoute: <T>(url: string, deviceId: string, theme?: 'dark' | 'light', extraParams?: {
     [key: string]: any;
-} | undefined, isGeneral?: false) => Promise<IRes<T>>;
+} | undefined, isGeneral?: boolean) => Promise<IRes<T>>;
 /**
  * 跳转 通用帮助反馈小程序
  */
@@ -128,15 +135,7 @@ export declare const goToIpcHelpMini: <T>(errCode: number, deviceId: string, hel
  * @param deviceId 设备id
  * @returns true/false
  */
-export declare const getIsSupportedCloudStorageSync: (deviceId: string) => Promise<{
-    code: number;
-    data: boolean;
-    msg?: undefined;
-} | {
-    code: number;
-    data: boolean;
-    msg: string | boolean | import("../interface").IApiError | undefined;
-}>;
+export declare const getIsSupportedCloudStorageSync: (deviceId: string) => Promise<IRes<boolean>>;
 /**
  * 预埋业务日志
  * @param ipcLogString 日志字符串

package/lib/kit/ipc/index.js

@@ -587,6 +587,41 @@ export const getCurrentSupportedTalkMode = function (deviceId) {
   });
 };
 
+/**
+ * 更新对讲方式
+ * @param deviceId
+ * @param mode 1：单向对讲；2：双向对讲
+ * @returns true
+ */
+export const updateTalkMode = (deviceId, mode) => {
+  return new Promise(resolve => {
+    try {
+      var _ty;
+      (_ty = ty) === null || _ty === void 0 || _ty.ipc.updateCameraAudioMode({
+        devId: deviceId,
+        mode,
+        success: () => {
+          resolve({
+            code: 0,
+            data: true
+          });
+        },
+        fail: err => {
+          resolve({
+            code: -1,
+            msg: err
+          });
+        }
+      });
+    } catch (err) {
+      resolve({
+        code: -1,
+        msg: String(err)
+      });
+    }
+  });
+};
+
 /**
  * 处理 IPC URL 跳转
  * @param {string} nativeUrl - 构建好的目标 URL。
@@ -682,7 +717,7 @@ const buildUrl = (url, param, isGeneral) => {
 export const goToIpcPageNativeRoute = async function (url, deviceId) {
   let theme = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : undefined;
   let extraParams = arguments.length > 3 ? arguments[3] : undefined;
-  let isGeneral = arguments.length > 4 ? arguments[4] : undefined;
+  let isGeneral = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : false;
   try {
     const systemInfo = await ty.getSystemInfo();
     const pageTheme = theme || (systemInfo === null || systemInfo === void 0 ? void 0 : systemInfo.theme);
@@ -792,7 +827,6 @@ export const ipcTTTOperatorLog = ipcLogString => {
           });
         },
         fail: error => {
-          console.log(error, 'error');
           resolve({
             code: -1,
             msg: error

package/lib/service/index.d.ts

@@ -1,5 +1,4 @@
-import { ServeTpe } from '../interface';
-import { IRes } from '@/kit/interface';
+import { IRes, ServeTpe } from '../interface';
 /**
  * 获取IPC设备配置信息
  * @param deviceId 设备ID

package/lib/service/index.js

@@ -9,7 +9,6 @@ import Strings from '../i18n';
 import { JsonUtil, getInitUtmTid } from '../utils';
 import { getDevInfo, getNativeStorage, setNativeStorage, publishDps, getDpStateValue, getDpIdByCode, jumpToWebView, goToMiniProgramByShortLink, getCurrentSupportedTalkMode, ipcTTTOperatorLog } from '../kit';
 import { ClarityType, IntercomMode, MuteMode, ServeTpe } from '../interface';
-const errStyle = 'background: red; color: #fff;';
 
 /**
  * @description: 对讲模式

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ray-js/ray-ipc-utils",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "IPC 工具库",
   "main": "lib/index",
   "files": [

package/lib/kit/interface.d.ts

@@ -1,13 +0,0 @@
-export interface IApiError {
-    errorMsg: string;
-    errorCode: string | number;
-    innerError: {
-        errorMsg: string;
-        errorCode: string | number;
-    };
-}
-export interface IRes<T> {
-    code?: number;
-    data?: T;
-    msg?: IApiError | string | boolean;
-}

package/lib/kit/interface.js

@@ -1 +0,0 @@
-export {};