@ray-js/api 1.5.0-beta.12 → 1.5.0

package/lib/cloud/doorlock/member.md

@@ -0,0 +1,276 @@
+## getCurrentMemberInfo
+
+获取当前登录用户信息。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getCurrentMemberInfo } from '@ray-js/ray'
+```
+
+### 参数
+
+**CurrentMemberInfoParams**
+
+| 属性  | 类型     | 必填 | 说明      |
+| ----- | -------- | ---- | --------- |
+| devId | `string` | 是   | 设备 ID   |
+| dpIds | `string` | 是   | 数据点 ID |
+
+### 返回
+
+**CurrentMemberInfoResult**
+
+| 属性             | 类型            | 说明               |
+| ---------------- | --------------- | ------------------ |
+| userId           | `number`        | 用户 ID            |
+| lockUserId       | `number`        | 锁用户 ID          |
+| userType         | `number`        | 用户类型           |
+| allOpenDps       | `string`        | 所有开放的数据点   |
+| allOpenType      | `Array<number>` | 所有开放类型的数组 |
+| productAttribute | `number`        | 产品属性           |
+| phase            | `number`        | 阶段               |
+| expireTime       | `number`        | 过期时间           |
+| expireDate       | `number`        | 过期日期           |
+
+### 函数定义示例
+
+```typescript
+/**
+ * 获取当前登录用户信息
+ */
+export function getCurrentMemberInfo(
+  params: CurrentMemberInfoParams
+): Promise<CurrentMemberInfoResult>
+```
+
+## getFamilyMemberListWithUnlockCount
+
+获取家庭成员列表（带解锁方式个数）。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getFamilyMemberListWithUnlockCount } from '@ray-js/ray'
+```
+
+### 参数
+
+**FamilyMemberListWithUnlockCountParams**
+
+| 属性  | 类型            | 必填 | 说明           |
+| ----- | --------------- | ---- | -------------- |
+| devId | `string`        | 是   | 设备 ID        |
+| dpIds | `Array<number>` | 是   | 数据点 ID 数组 |
+
+### 返回
+
+**FamilyMemberListWithUnlockCountResult**
+
+`Array<FamilyMemberWithUnlockDetail>`，家庭成员列表数组。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 获取家庭成员列表（带解锁方式个数）
+ */
+export function getFamilyMemberListWithUnlockCount(
+  params: FamilyMemberListWithUnlockCountParams
+): Promise<FamilyMemberListWithUnlockCountResult>
+```
+
+## removeFamilyMember
+
+家庭成员移除成功通知。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { removeFamilyMember } from '@ray-js/ray'
+```
+
+### 参数
+
+**FamilyMemberRemovalParams**
+
+| 属性   | 类型     | 必填 | 说明    |
+| ------ | -------- | ---- | ------- |
+| devId  | `string` | 是   | 设备 ID |
+| userId | `string` | 是   | 用户 ID |
+
+### 返回
+
+**FamilyMemberRemovalResult**
+
+`boolean`，表示操作是否成功。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 家庭成员移除成功通知
+ */
+export function removeFamilyMember(
+  params: FamilyMemberRemovalParams
+): Promise<FamilyMemberRemovalResult>
+```
+
+## queryUserDeletion
+
+查询是否有家庭里已删除但是门锁端未删除且有设置硬件解锁方式的成员。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { queryUserDeletion } from '@ray-js/ray'
+```
+
+### 参数
+
+**UserDeletionQueryParams**
+
+| 属性  | 类型     | 必填 | 说明    |
+| ----- | -------- | ---- | ------- |
+| devId | `string` | 是   | 设备 ID |
+
+### 返回
+
+**UserDeletionQueryResult**
+
+`Array<{ userId: number, lockUserId: number }>`，数组包含已删除用户的 ID 和锁用户 ID。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 查询是否有家庭里已删除但是门锁端未删除且有设置硬件解锁方式的成员
+ */
+export function queryUserDeletion(params: UserDeletionQueryParams): Promise<UserDeletionQueryResult>
+```
+
+## syncLockBatch
+
+门锁批量同步。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { syncLockBatch } from '@ray-js/ray'
+```
+
+### 参数
+
+**LockSyncBatchParams**
+
+| 属性  | 类型     | 必填 | 说明    |
+| ----- | -------- | ---- | ------- |
+| devId | `string` | 是   | 设备 ID |
+
+### 返回
+
+**LockSyncBatchResult**
+
+| 属性        | 类型     | 说明           |
+| ----------- | -------- | -------------- |
+| lockRandom  | `object` | 随机锁信息     |
+| lockFitting | `object` | 锁具信息       |
+| lockRecord  | `string` | 锁记录         |
+| removedUser | `Array`  | 已移除用户信息 |
+
+### 函数定义示例
+
+```typescript
+/**
+ * 门锁批量同步
+ */
+export function syncLockBatch(params: LockSyncBatchParams): Promise<LockSyncBatchResult>
+```
+
+## updateUserTimeSchedule
+
+更新用户时效。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { updateUserTimeSchedule } from '@ray-js/ray'
+```
+
+### 参数
+
+**UpdateUserTimeScheduleParams**
+
+| 属性             | 类型               | 必填 | 说明     |
+| ---------------- | ------------------ | ---- | -------- |
+| devId            | `string`           | 是   | 设备 ID  |
+| userId           | `string`           | 是   | 用户 ID  |
+| timeScheduleInfo | `TimeScheduleInfo` | 是   | 时效信息 |
+
+### 返回
+
+**UpdateUserTimeScheduleResult**
+
+`boolean`，表示操作是否成功。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 更新用户时效
+ */
+export function updateUserTimeSchedule(
+  params: UpdateUserTimeScheduleParams
+): Promise<UpdateUserTimeScheduleResult>
+```
+
+## openCloseOfflineUnlock
+
+打开/关闭离线解锁开关。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { openCloseOfflineUnlock } from '@ray-js/ray'
+```
+
+### 参数
+
+**OpenCloseOfflineUnlockParams**
+
+| 属性   | 类型      | 必填 | 说明     |
+| ------ | --------- | ---- | -------- |
+| devId  | `string`  | 是   | 设备 ID  |
+| userId | `string`  | 是   | 用户 ID  |
+| enable | `boolean` | 是   | 是否启用 |
+
+### 返回
+
+**OpenCloseOfflineUnlockResult**
+
+`boolean`，表示操作是否成功。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 打开/关闭离线解锁开关
+ */
+export function openCloseOfflineUnlock(
+  params: OpenCloseOfflineUnlockParams
+): Promise<OpenCloseOfflineUnlockResult>
+```

package/lib/cloud/doorlock/offline-pwd.d.ts

@@ -0,0 +1,61 @@
+type OfflinePwdParams = {
+    devId: string;
+    pwdType: string;
+    gmtStart: number;
+    gmtExpired: number;
+    pwdName?: string;
+    countryCode?: string;
+    mobile?: string;
+};
+type OfflinePwdResult = {
+    pwd: string;
+    pwdId: string;
+    unlockBindingId: string;
+};
+/**
+ * 获取离线临时密码
+ * @param {OfflinePwdParams} params - 请求参数
+ * @returns {Promise<OfflinePwdResult>} - 响应结果的 Promise
+ */
+export declare const getOfflinePassword: (params: OfflinePwdParams) => Promise<OfflinePwdResult>;
+type PwdRevokeParams = {
+    devId: string;
+    unlockBindingId: string;
+    name?: string;
+};
+type PwdRevokeResult = string;
+/**
+ * 删除离线临时密码
+ * @param {PwdRevokeParams} params - 请求参数
+ * @returns {Promise<PwdRevokeResult>} - 响应结果的 Promise
+ */
+export declare const revokeOfflinePassword: (params: PwdRevokeParams) => Promise<PwdRevokeResult>;
+type PwdNameUpdateParams = {
+    devId: string;
+    unlockBindingId: string;
+    pwdName: string;
+};
+type PwdNameUpdateResult = string;
+/**
+ * 更新离线密码名称
+ * @param {PwdNameUpdateParams} params - 请求参数
+ * @returns {Promise<PwdNameUpdateResult>} - 响应结果的 Promise
+ */
+export declare const updateOfflinePasswordName: (params: PwdNameUpdateParams) => Promise<PwdNameUpdateResult>;
+type RevocablePwdParams = {
+    devId: string;
+};
+type RevocablePwdResultEntry = {
+    gmtExpired: string;
+    pwdName: string;
+    pwdId: string;
+    gmtStart: string;
+};
+type RevocablePwdResult = RevocablePwdResultEntry[];
+/**
+ * 获取可清空的多次离线临时密码
+ * @param {RevocablePwdParams} params - 请求参数
+ * @returns {Promise<RevocablePwdResult>} - 响应结果的 Promise
+ */
+export declare const getRevocableOfflinePasswords: (params: RevocablePwdParams) => Promise<RevocablePwdResult>;
+export {};

package/lib/cloud/doorlock/offline-pwd.js

@@ -0,0 +1,67 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+// 6.1. 获取离线临时密码
+
+/**
+ * 获取离线临时密码
+ * @param {OfflinePwdParams} params - 请求参数
+ * @returns {Promise<OfflinePwdResult>} - 响应结果的 Promise
+ */
+export const getOfflinePassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.offlinepwd.get"),
+    version: '3.0',
+    data: params
+  });
+};
+
+// 6.2. 获取某个离线临时密码的删除密码
+
+// 离线删除密码
+
+/**
+ * 删除离线临时密码
+ * @param {PwdRevokeParams} params - 请求参数
+ * @returns {Promise<PwdRevokeResult>} - 响应结果的 Promise
+ */
+export const revokeOfflinePassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.offlinepwd.revoke"),
+    version: '2.0',
+    data: params
+  });
+};
+
+// 6.3. 设置某个密码的名称
+
+// 更新结果
+
+/**
+ * 更新离线密码名称
+ * @param {PwdNameUpdateParams} params - 请求参数
+ * @returns {Promise<PwdNameUpdateResult>} - 响应结果的 Promise
+ */
+export const updateOfflinePasswordName = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.offlinepwd.name.update"),
+    version: '2.0',
+    data: params
+  });
+};
+
+// 6.4. 获取生效中的，可以被清空的多次离线临时密码
+
+// 结果的数组
+
+/**
+ * 获取可清空的多次离线临时密码
+ * @param {RevocablePwdParams} params - 请求参数
+ * @returns {Promise<RevocablePwdResult>} - 响应结果的 Promise
+ */
+export const getRevocableOfflinePasswords = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.offlinepwd.revocable"),
+    version: '1.0',
+    data: params
+  });
+};

package/lib/cloud/doorlock/offline-pwd.md

@@ -0,0 +1,155 @@
+## getOfflinePassword
+
+获取离线临时密码。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getOfflinePassword } from '@ray-js/ray'
+```
+
+### 参数
+
+**OfflinePwdParams**
+
+| 属性        | 类型     | 必填 | 说明     |
+| ----------- | -------- | ---- | -------- |
+| devId       | `string` | 是   | 设备 ID  |
+| pwdType     | `string` | 是   | 密码类型 |
+| gmtStart    | `number` | 是   | 开始时间 |
+| gmtExpired  | `number` | 是   | 结束时间 |
+| pwdName     | `string` | 否   | 密码名称 |
+| countryCode | `string` | 否   | 国家码   |
+| mobile      | `string` | 否   | 手机号   |
+
+### 返回
+
+**OfflinePwdResult**
+
+| 属性            | 类型     | 说明         |
+| --------------- | -------- | ------------ |
+| pwd             | `string` | 离线临时密码 |
+| pwdId           | `string` | 密码 ID      |
+| unlockBindingId | `string` | 解锁绑定 ID  |
+
+### 函数定义示例
+
+```typescript
+/**
+ * 获取离线临时密码
+ */
+export function getOfflinePassword(params: OfflinePwdParams): Promise<OfflinePwdResult>
+```
+
+## revokeOfflinePassword
+
+获取某个离线临时密码的删除密码。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { revokeOfflinePassword } from '@ray-js/ray'
+```
+
+### 参数
+
+**PwdRevokeParams**
+
+| 属性            | 类型     | 必填 | 说明           |
+| --------------- | -------- | ---- | -------------- |
+| devId           | `string` | 是   | 设备 ID        |
+| unlockBindingId | `string` | 是   | 离线密码的编号 |
+| name            | `string` | 否   | 离线密码名称   |
+
+### 返回
+
+**PwdRevokeResult**
+
+`string`，离线删除密码。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 删除离线临时密码
+ */
+export function revokeOfflinePassword(params: PwdRevokeParams): Promise<PwdRevokeResult>
+```
+
+## updateOfflinePasswordName
+
+设置某个密码的名称。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { updateOfflinePasswordName } from '@ray-js/ray'
+```
+
+### 参数
+
+**PwdNameUpdateParams**
+
+| 属性            | 类型     | 必填 | 说明     |
+| --------------- | -------- | ---- | -------- |
+| devId           | `string` | 是   | 设备 ID  |
+| unlockBindingId | `string` | 是   | 密码编号 |
+| pwdName         | `string` | 是   | 密码名称 |
+
+### 返回
+
+**PwdNameUpdateResult**
+
+`string`，更新结果。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 更新离线密码名称
+ */
+export function updateOfflinePasswordName(params: PwdNameUpdateParams): Promise<PwdNameUpdateResult>
+```
+
+## getRevocableOfflinePasswords
+
+获取生效中的，可以被清空的多次离线临时密码。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getRevocableOfflinePasswords } from '@ray-js/ray'
+```
+
+### 参数
+
+**RevocablePwdParams**
+
+| 属性  | 类型     | 必填 | 说明    |
+| ----- | -------- | ---- | ------- |
+| devId | `string` | 是   | 设备 ID |
+
+### 返回
+
+**RevocablePwdResult**
+
+`Array<RevocablePwdResultEntry>`，结果的数组。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 获取可清空的多次离线临时密码
+ */
+export function getRevocableOfflinePasswords(
+  params: RevocablePwdParams
+): Promise<RevocablePwdResult>
+```

package/lib/cloud/doorlock/old.d.ts

@@ -0,0 +1,36 @@
+export declare const getUiConfig: (productId: any, productConfigTimestamp?: string, productPanelPowerTimestamp?: string) => void;
+export declare const getUserRegion: () => void;
+/**
+ * 获取门锁最新日志
+ * @param params {devId: string}
+ * @returns
+ */
+export declare const getLockLatestLog: (params: {
+    devId: string;
+}) => void;
+/**
+ * 获取门锁安全天数
+ * @param param {devId: string}
+ * @returns
+ */
+export declare const getLockActivePeriod: ({ devId }: {
+    devId: string;
+}) => void;
+/**
+ * 获取门锁成员信息
+ * @param param {devId: string, userId?: string}
+ * @returns
+ */
+export declare const getLockMemberInfo: ({ devId, userId }: {
+    devId: string;
+    userId?: string | undefined;
+}) => void;
+/**
+ * 远程开门
+ * @param param { devId: string, open: boolean }
+ * @returns
+ */
+export declare const remoteLockExecute: ({ devId, open }: {
+    devId: string;
+    open: boolean;
+}) => void;

package/lib/cloud/doorlock/old.js

@@ -0,0 +1,102 @@
+// 仅用于门锁模版
+// 门锁模版中涉及到的atop接口，暂时封装，后续会根据实际情况进行封装。
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+
+// 获取云能力
+export const getUiConfig = function (productId) {
+  let productConfigTimestamp = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '0';
+  let productPanelPowerTimestamp = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '0';
+  return requestCloud({
+    api: "".concat(THING, ".m.app.panel.info.get"),
+    version: '2.0',
+    data: {
+      productId,
+      productConfigTimestamp,
+      productPanelPowerTimestamp,
+      options: 'uiContent,cloudDp,powerCode'
+    }
+  });
+};
+
+// 获取当前帐号所属地区
+export const getUserRegion = () => {
+  return requestCloud({
+    api: "".concat(THING, ".m.user.region.get"),
+    version: '1.0',
+    data: {}
+  });
+};
+
+/**
+ * 获取门锁最新日志
+ * @param params {devId: string}
+ * @returns
+ */
+export const getLockLatestLog = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.log.latest"),
+    version: '1.0',
+    data: {
+      devId: params.devId
+    }
+  });
+};
+
+/**
+ * 获取门锁安全天数
+ * @param param {devId: string}
+ * @returns
+ */
+export const getLockActivePeriod = _ref => {
+  let {
+    devId
+  } = _ref;
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.active.period"),
+    version: '1.0',
+    data: {
+      devId
+    }
+  });
+};
+
+/**
+ * 获取门锁成员信息
+ * @param param {devId: string, userId?: string}
+ * @returns
+ */
+export const getLockMemberInfo = _ref2 => {
+  let {
+    devId,
+    userId
+  } = _ref2;
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.panel.get"),
+    version: '1.0',
+    data: {
+      devId: devId,
+      userId: userId || ''
+    }
+  });
+};
+
+/**
+ * 远程开门
+ * @param param { devId: string, open: boolean }
+ * @returns
+ */
+export const remoteLockExecute = _ref3 => {
+  let {
+    devId,
+    open
+  } = _ref3;
+  return requestCloud({
+    api: "".concat(THING, ".m.zigbee.lock.remotepwd.execute"),
+    version: '1.0',
+    data: {
+      devId: devId,
+      open
+    }
+  });
+};