@ray-js/ray-ipc-utils 1.1.0-beta-1

package/README.md

@@ -0,0 +1,126 @@
+[English](./README.md) | 简体中文
+
+# @ray/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)
+
+> IPC utility library
+
+## Installation
+
+```sh
+$ npm install @ray-js/ray-ipc-utils
+// or
+$ 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 传入的第三个参数使用
+
+示例
+
+```tsx
+import { openPanel } from '@ray/ray-ipc-utils';
+
+const emitMessage = useEmitMessage();
+
+useEmitMessage({
+  type: 'exitMiniProgram',
+});
+```
+
+### 其他方法
+
+| 方法名称     | 描述          | 返回值类型 |
+| ------------ | ------------- | ---------- |
+| isIos        | 是否 ios 系统 | boolean    |
+| isIphoneX    | 是否 iPhoneX  | boolean    |
+| smallScreen  | 是否小屏幕    | boolean    |
+| middleScreen | 是否中屏幕    | boolean    |

package/lib/hooks/index.d.ts

@@ -0,0 +1 @@
+export * from './useTrafficViewTip';

package/lib/hooks/index.js

@@ -0,0 +1,2 @@
+// hooks相关分类
+export * from './useTrafficViewTip';

package/lib/hooks/useTrafficViewTip/index.d.ts

@@ -0,0 +1 @@
+export declare const useTrafficViewTip: () => boolean;

package/lib/hooks/useTrafficViewTip/index.js

@@ -0,0 +1,3 @@
+export const useTrafficViewTip = () => {
+  return false;
+};

package/lib/index.config.js

@@ -0,0 +1,14 @@
+export const tuya = {
+  backgroundColor: '#f2f4f6',
+  navigationBarTitleText: 'Ray 跨端组件'
+};
+export const wechat = {
+  backgroundColor: '#f2f4f6',
+  navigationBarTitleText: 'Ray 跨端组件'
+};
+export const native = {
+  backgroundColor: 'transparent',
+  isBleOfflineOverlay: false,
+  useSafeAreaView: true,
+  navigationBarTitleText: 'Ray 跨端组件'
+};

package/lib/index.d.ts

@@ -0,0 +1,44 @@
+declare const IpcUtils: {
+    getCameraConfigInfo: (deviceId: string) => Promise<import("./interface").IpcConfigInfo>;
+    getCollectionPointsInfo: (deviceId: string) => Promise<any>;
+    updateCollectionPointsInfo: (deviceId: string, id: number, name: string) => Promise<any>;
+    delCollectionPointsInfo: (deviceId: string, pointData: [{
+        devId: string;
+        mpId: number;
+    }]) => Promise<import("./kit/interface").IRes>;
+    addCollectionPointsInfo: (deviceId: string, name: string) => Promise<any>;
+    getServiceUrl: (deviceId: string, serveType: import("./interface").ServeTpe, paramData?: Record<string, any>, action?: boolean, utm_rtid?: string) => Promise<{
+        code: number;
+        msg?: string | undefined;
+        url?: string | undefined;
+        type?: number | undefined;
+    }>;
+    JsonUtil: any;
+    getInitUtmTid: () => string;
+    getDevInfo: <T>(deviceId: string) => Promise<import("./kit/interface").IRes>;
+    getNativeStorage: <T_1>(key: string) => Promise<import("./kit/interface").IRes>;
+    setNativeStorage: <T_2>(key: string, data: T_2) => Promise<import("./kit/interface").IRes>;
+    removeNativeStorage: <T_3>(key: string) => Promise<import("./kit/interface").IRes>;
+    publishDps: <T_4>(deviceId: string, dps: T_4) => Promise<import("./kit/interface").IRes>;
+    getDpStateValue: (deviceId: string, dpCode: string) => Promise<import("./kit/interface").IRes>;
+    getDpIdByCode: (deviceId: string, dpCode: string) => Promise<import("./kit/interface").IRes>;
+    goToMiniProgramByShortLink: <T_5>(url: string, position?: string) => Promise<import("./kit/interface").IRes>;
+    getVideoBitrateKbps: <T_6>(deviceId: string, extendParam?: {}) => Promise<import("./kit/interface").IRes>;
+    networkStatusDidChangedEvent: (callback: any) => void;
+    getMobileOrientation: <T_7>() => Promise<import("./kit/interface").IRes>;
+    jumpToWebView: <T_8>(url: string) => Promise<import("./kit/interface").IRes>;
+    setScreenOrientation: <T_9>(pageOrientation: string) => Promise<import("./kit/interface").IRes>;
+    isSupportFloatWindow: <T_10>(deviceId: string, extendParam?: {}) => Promise<import("./kit/interface").IRes>;
+    openFloatWindow: <T_11>(deviceId: string, extendParam?: {}) => Promise<import("./kit/interface").IRes>;
+    isSupportedTalk: <T_12>(deviceId: string, extendParam?: {}) => Promise<import("./kit/interface").IRes>;
+    getCurrentSupportedTalkMode: <T_13>(deviceId: string, extendParam?: {}) => Promise<import("./kit/interface").IRes>;
+    goToIpcPageNativeRoute: (url: string, deviceId: string, theme?: "dark" | "light", extraParams?: {
+        [key: string]: any;
+    } | undefined, isGeneral?: false | undefined) => Promise<import("./kit/interface").IRes>;
+    goToGeneralHelpMini: () => Promise<import("./kit/interface").IRes>;
+    goToIpcHelpMini: (errCode: number, deviceId: string, helpNum: number, helpFeedBack: boolean, brandColor?: string) => Promise<import("./kit/interface").IRes>;
+    requestWifiSignal: <T_14>(deviceId: string, dps?: {}) => Promise<import("./kit/interface").IRes>;
+    wakeUpDevice: <T_15>(deviceId: string, dps?: {}) => Promise<import("./kit/interface").IRes>;
+    useTrafficViewTip: () => boolean;
+};
+export default IpcUtils;

package/lib/index.js

@@ -0,0 +1,7 @@
+import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
+import * as hooks from './hooks';
+import * as kit from './kit';
+import * as utils from './utils';
+import * as service from './service';
+const IpcUtils = _objectSpread(_objectSpread(_objectSpread(_objectSpread({}, hooks), kit), utils), service);
+export default IpcUtils;

package/lib/index.module.less

@@ -0,0 +1,5 @@
+.text {
+  color: #000;
+  font-size: 48rpx;
+  font-weight: bold;
+}

package/lib/interface.d.ts

@@ -0,0 +1,63 @@
+export declare enum ClarityType {
+    SS = "SS",
+    SD = "SD",
+    HD = "HD",
+    UD = "UD",
+    SSP = "SSP",
+    AUDIO = "AUDIO"
+}
+export declare enum IntercomMode {
+    OneWay = "OneWay",
+    TwoWay = "TwoWay"
+}
+export declare enum ServeTpe {
+    trafficService = "traffic_service",
+    securityCloudService = "security_cloud_service",
+    aiService = "ai_service",
+    aiInspectionReport = "aiInspectionReport"
+}
+export declare enum MuteMode {
+    ON = "ON",
+    OFF = "OFF"
+}
+export interface IpcConfigInfo {
+    /**
+     *  清晰度信息
+     */
+    videoResolution: {
+        /** 默认清晰度 */
+        defaultResolution: ClarityType;
+        /** 缓存的清晰度 */
+        cachedResolution: ClarityType;
+        /** 支持的清晰度列表 */
+        availableResolutions: ClarityType[];
+    };
+    /**
+     *  对讲设置信息
+     */
+    intercomInfo: {
+        /** 是否支持对讲 */
+        isIntercomSupported: boolean;
+        /** 默认对讲方式 */
+        defaultIntercomMode: IntercomMode;
+        /** 缓存的对讲方式 */
+        cachedIntercomMode: IntercomMode;
+        /** 支持的对讲方式 */
+        supportedIntercomModes: IntercomMode[];
+    };
+    /**
+     * 拾音器信息
+     */
+    microphoneSettings: {
+        /** 是否支持拾音 */
+        isMicrophoneSupported: boolean;
+        /** 默认拾音模式 */
+        defaultMuteMode: MuteMode;
+        /** 缓存的拾音模式 */
+        cachedMuteMode: MuteMode;
+    };
+    /**
+     * 最大放大倍数
+     */
+    maxZoomSettings: number;
+}

package/lib/interface.js

@@ -0,0 +1,26 @@
+export let ClarityType = /*#__PURE__*/function (ClarityType) {
+  ClarityType["SS"] = "SS";
+  ClarityType["SD"] = "SD";
+  ClarityType["HD"] = "HD";
+  ClarityType["UD"] = "UD";
+  ClarityType["SSP"] = "SSP";
+  ClarityType["AUDIO"] = "AUDIO";
+  return ClarityType;
+}({}); // 音频模式
+export let IntercomMode = /*#__PURE__*/function (IntercomMode) {
+  IntercomMode["OneWay"] = "OneWay";
+  IntercomMode["TwoWay"] = "TwoWay";
+  return IntercomMode;
+}({});
+export let ServeTpe = /*#__PURE__*/function (ServeTpe) {
+  ServeTpe["trafficService"] = "traffic_service";
+  ServeTpe["securityCloudService"] = "security_cloud_service";
+  ServeTpe["aiService"] = "ai_service";
+  ServeTpe["aiInspectionReport"] = "aiInspectionReport";
+  return ServeTpe;
+}({});
+export let MuteMode = /*#__PURE__*/function (MuteMode) {
+  MuteMode["ON"] = "ON";
+  MuteMode["OFF"] = "OFF";
+  return MuteMode;
+}({});

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

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

package/lib/kit/device/index.js

@@ -0,0 +1,68 @@
+/**
+ * 获取信号强度
+ * @param deviceId
+ * @param dps 扩展参数
+ * @returns
+ */
+export const requestWifiSignal = function (deviceId) {
+  let dps = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  return new Promise(resolve => {
+    try {
+      ty.device.requestWifiSignal({
+        deviceId,
+        dps: dps,
+        success: res => {
+          resolve({
+            code: 0,
+            data: res
+          });
+        },
+        fail: err => {
+          resolve({
+            code: -1,
+            msg: err
+          });
+        }
+      });
+    } catch (err) {
+      resolve({
+        code: -1,
+        msg: String(err)
+      });
+    }
+  });
+};
+
+/**
+ * IPC-低功耗唤醒:低功耗唤醒,唤醒门铃设备
+ * 需引入DeviceKit，且在>=3.1.0-ipcwake.1版本才可使用
+ * @param deviceId
+ * @returns
+ */
+export const wakeUpDevice = function (deviceId) {
+  let dps = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  return new Promise(resolve => {
+    try {
+      ty.device.wakeUpDevice({
+        deviceId,
+        dps: dps,
+        success: res => {
+          resolve({
+            data: res
+          });
+        },
+        fail: error => {
+          resolve({
+            code: -1,
+            msg: error
+          });
+        }
+      });
+    } catch (err) {
+      resolve({
+        code: -1,
+        msg: String(err)
+      });
+    }
+  });
+};

package/lib/kit/index.d.ts

@@ -0,0 +1,2 @@
+export * from './ipc';
+export * from './device';

package/lib/kit/index.js

@@ -0,0 +1,2 @@
+export * from './ipc';
+export * from './device';

package/lib/kit/interface.d.ts

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

package/lib/kit/interface.js

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

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

@@ -0,0 +1,124 @@
+import { IRes } from '../interface';
+/**
+ *
+ * @param deviceId 设备id
+ * @returns 获取设备信息
+ */
+export declare const getDevInfo: <T>(deviceId: string) => Promise<IRes>;
+/**
+ * 获取本地缓存
+ * @param key 保存的key属性
+ *
+ */
+export declare const getNativeStorage: <T>(key: string) => Promise<IRes>;
+/**
+ * 存储数据到本地缓存
+ * @param key 保存的key属性
+ *
+ */
+export declare const setNativeStorage: <T>(key: string, data: T) => Promise<IRes>;
+/**
+ * 清除本地缓存
+ * @param key 保存的key属性
+ *
+ */
+export declare const removeNativeStorage: <T>(key: string) => Promise<IRes>;
+/**
+ * DP点下发, 包含针对低功耗设备情况下的DP点下发
+ * @param key 保存的key属性
+ *
+ */
+export declare const publishDps: <T>(deviceId: string, dps: T) => Promise<IRes>;
+/**
+ * 根据DPCode获取最新的DP点的值
+ * @param key 保存的key属性
+ *
+ */
+export declare const getDpStateValue: (deviceId: string, dpCode: string) => Promise<IRes>;
+/**
+ * 根据DPCode获取DpId
+ * @param key 保存的key属性
+ *
+ */
+export declare const getDpIdByCode: (deviceId: string, dpCode: string) => Promise<IRes>;
+/**
+ * 通过短链形式跳转小程序
+ * @param url 小程序链接
+ * @param position 弹出位置 bottom｜right
+ *
+ */
+export declare const goToMiniProgramByShortLink: <T>(url: string, position?: string) => Promise<IRes>;
+/**
+ * 获取视频码率
+ * @param deviceId
+ * @param extendParam 扩展参数
+ * @returns
+ */
+export declare const getVideoBitrateKbps: <T>(deviceId: string, extendParam?: {}) => Promise<IRes>;
+export declare const networkStatusDidChangedEvent: (callback: any) => void;
+/**
+ * 获取手机当前横竖屏状态
+ * 需引入IPCKit，且在>=1.0.0-TTT432.1版本才可使用
+ * @returns
+ */
+export declare const getMobileOrientation: <T>() => Promise<IRes>;
+/**
+ * 跳转到webView
+ * @param key 保存的key属性
+ *
+ */
+export declare const jumpToWebView: <T>(url: string) => Promise<IRes>;
+export declare const setScreenOrientation: <T>(pageOrientation: string) => Promise<IRes>;
+/**
+ * 画中画：是否支持画中画：只有安卓在用
+ * @param deviceId
+ * @param extendParam 扩展参数
+ * @returns
+ */
+export declare const isSupportFloatWindow: <T>(deviceId: string, extendParam?: {}) => Promise<IRes>;
+/**
+ * 画中画：开启画中画
+ * @param deviceId
+ * @param extendParam 扩展参数
+ * @returns
+ */
+export declare const openFloatWindow: <T>(deviceId: string, extendParam?: {}) => Promise<IRes>;
+/**
+ * IPC-APP 缓存支持的对讲方式:是否支持对讲
+ * @param deviceId
+ * @param extendParam 扩展参数
+ * @returns
+ */
+export declare const isSupportedTalk: <T>(deviceId: string, extendParam?: {}) => Promise<IRes>;
+/**
+ * 设备支持的对讲模式
+ * @param deviceId
+ * @param extendParam 扩展参数
+ * @returns 设备支持的对讲模式。回掉方法的参数为数值型，0 未知；1：单向对讲；2：双向对讲。
+ */
+export declare const getCurrentSupportedTalkMode: <T>(deviceId: string, extendParam?: {}) => Promise<IRes>;
+/**
+ * 跳转 APP 原生页面
+ * @param {string} url 页面路由
+ * @param {string} deviceId 设备Id
+ * @param {string} theme 主题 dark｜light 默认取APP 主题色
+ * @param {Object} extraParams 额外参数, 额外页面需要单独拼接的参数
+ * @param {boolean} isGeneral 是否为通用页面，IPC原生业务页面不用传, 默认false
+ *
+ */
+export declare const goToIpcPageNativeRoute: (url: string, deviceId: string, theme?: 'dark' | 'light', extraParams?: {
+    [key: string]: any;
+} | undefined, isGeneral?: false) => Promise<IRes>;
+/**
+ * 跳转 通用帮助反馈小程序
+ */
+export declare const goToGeneralHelpMini: () => Promise<IRes>;
+/**
+ * 跳转 Ipc帮助反馈小程序
+ * @param {number} errCode 错误码
+ * @param {string} deviceId 设备id
+ * @param {number} helpNum 帮助编号
+ * @param {boolean} helpFeedBack 是否是反馈
+ * @param {string} brandColor 品牌色
+ */
+export declare const goToIpcHelpMini: (errCode: number, deviceId: string, helpNum: number, helpFeedBack: boolean, brandColor?: string) => Promise<IRes>;