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

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
+    }
+  });
+};

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

@@ -0,0 +1,194 @@
+type GetDynapwdParams = {
+    devId: string;
+    adminPwd: string;
+};
+type GetDynapwdResponse = {
+    dynamicPassword: string;
+};
+/**
+ * 获取动态密码
+ * @param {GetDynapwdParams} params - 包含设备Id和管理员密码的参数对象
+ * @returns {Promise<GetDynapwdResponse>} - 包含动态密码数据的响应对象的 Promise
+ */
+export declare const getDynamicPassword: (params: GetDynapwdParams) => Promise<GetDynapwdResponse>;
+type ValidateTempPasswordParams = {
+    unlockBindingId?: number;
+    devId: string;
+    effectiveTime: number;
+    invalidTime: number;
+    name: string;
+    schedule?: {
+        invalidTime?: number;
+        workingDay?: number;
+        allDay?: boolean;
+        effectiveTime?: number;
+    }[];
+    countryCode?: string;
+    phone?: string;
+    password: string;
+};
+type ValidateTempPasswordResult = {
+    valid: boolean;
+    errorCode?: string;
+    errorMsg?: string;
+};
+/**
+ * 临时密码参数有效性校验（包括密码内容）
+ * @param {ValidateTempPasswordParams} params - 临时密码参数
+ * @returns {Promise<ValidateTempPasswordResult>} - 校验结果的 Promise
+ */
+export declare const validateTemporaryPassword: (params: ValidateTempPasswordParams) => Promise<ValidateTempPasswordResult>;
+/**
+ * Schedule_Ver2 - 版本2的周期设置
+ */
+type Schedule_Ver2 = {
+    invalidTime?: number;
+    workingDay?: number;
+    allDay: boolean;
+    effectiveTime?: number;
+};
+/**
+ * ValidateUpdateTempPasswordParams - 校验临时密码参数
+ */
+type ValidateUpdateTempPasswordParams = {
+    unlockBindingId?: number;
+    devId: string;
+    effectiveTime: number;
+    invalidTime: number;
+    name?: string;
+    schedule?: string;
+    countryCode?: string;
+    phone?: string;
+};
+/**
+ * ValidateUpdateTempPasswordResult - 校验临时密码结果
+ */
+type ValidateUpdateTempPasswordResult = {
+    valid?: boolean;
+    errorCode?: string;
+    errorMsg?: string;
+};
+/**
+ * 校验临时密码是否可以添加或更新
+ * @param {ValidateUpdateTempPasswordParams} params - 临时密码参数
+ * @returns {Promise<ValidateUpdateTempPasswordResult>} - 校验结果的 Promise
+ */
+export declare const validateAndUpdateTemporaryPassword: (params: ValidateUpdateTempPasswordParams) => Promise<ValidateUpdateTempPasswordResult>;
+/**
+ * CreateTempPasswordParams - 创建临时密码参数
+ */
+type CreateTempPasswordParams = {
+    devId: string;
+    sn: number;
+    effectiveTime: number;
+    invalidTime: number;
+    availTime?: number;
+    name?: string;
+    symbolic: boolean;
+    dpTunnel?: string;
+    schedule?: Schedule_Ver2;
+};
+/**
+ * CreateTempPasswordResult - 创建临时密码结果
+ */
+type CreateTempPasswordResult = {
+    unlockBindingId?: string;
+};
+/**
+ * 临时开锁页创建临时密码
+ * @param {CreateTempPasswordParams} params - 创建临时密码参数
+ * @returns {Promise<CreateTempPasswordResult>} - 创建结果的 Promise
+ */
+export declare const createTemporaryPassword: (params: CreateTempPasswordParams) => Promise<CreateTempPasswordResult>;
+/**
+ * UpdateTempPasswordParams - 更新临时密码参数
+ */
+type UpdateTempPasswordParams = {
+    unlockBindingId: number;
+    devId: string;
+    effectiveTime?: number;
+    invalidTime?: number;
+    name?: string;
+    phase?: number;
+    symbolic: boolean;
+    dpTunnel: number;
+    schedule?: Schedule_Ver2;
+};
+/**
+ * UpdateTempPasswordResult - 更新临时密码结果
+ */
+type UpdateTempPasswordResult = boolean;
+/**
+ * 更新临时密码相关的信息
+ * @param {UpdateTempPasswordParams} params - 更新临时密码参数
+ * @returns {Promise<UpdateTempPasswordResult>} - 更新结果的 Promise
+ */
+export declare const updateTempPassword: (params: UpdateTempPasswordParams) => Promise<UpdateTempPasswordResult>;
+/**
+ * UpdateTempPasswordNameParams - 更新临时密码名称参数
+ */
+type UpdateTempPasswordNameParams = {
+    unlockBindingId: number;
+    devId: string;
+    name?: string;
+};
+/**
+ * UpdateTempPasswordNameResult - 更新临时密码名称结果
+ */
+type UpdateTempPasswordNameResult = boolean;
+/**
+ * 更新临时密码的名称
+ * @param {UpdateTempPasswordNameParams} params - 更新临时密码名称参数
+ * @returns {Promise<UpdateTempPasswordNameResult>} - 更新结果的 Promise
+ */
+export declare const updateTempPasswordName: (params: UpdateTempPasswordNameParams) => Promise<UpdateTempPasswordNameResult>;
+/**
+ * DeleteTempPasswordParams - 删除临时密码参数
+ */
+type DeleteTempPasswordParams = {
+    unlockBindingId: number;
+    devId: string;
+    symbolic?: boolean;
+    dpTunnel?: boolean;
+};
+/**
+ * DeleteTempPasswordResult - 删除临时密码结果
+ */
+type DeleteTempPasswordResult = boolean;
+/**
+ * 删除生效中的临时密码
+ * @param {DeleteTempPasswordParams} params - 删除临时密码参数
+ * @returns {Promise<DeleteTempPasswordResult>} - 删除结果的 Promise
+ */
+export declare const deleteTemporaryPassword: (params: DeleteTempPasswordParams) => Promise<DeleteTempPasswordResult>;
+/**
+ * ShareAvailabilityParams - 检查分享可用性参数
+ */
+type ShareAvailabilityParams = {
+    unlockBindingId?: number;
+    devId: string;
+    availTime: number;
+    countryCode: string;
+    account: string;
+    name?: string;
+    effectiveTime: number;
+    invalidTime: number;
+    schedule?: string;
+};
+/**
+ * ShareAvailabilityResult - 检查分享可用性结果
+ */
+type ShareAvailabilityResult = {
+    validateResult: boolean;
+    registered?: boolean;
+    dialogueType: number;
+    errorMsg: string;
+    errorCode: string;
+};
+/**
+ * 获取某个账号是否可以用于分享
+ * @param {ShareAvailabilityParams} params - 检查分享可用性参数
+ * @returns {Promise<ShareAvailabilityResult>} - 检查结果的 Promise
+ */
+export declare const checkShareAvailability: (params: ShareAvailabilityParams) => Promise<ShareAvailabilityResult>;
+export {};

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

@@ -0,0 +1,193 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+// 5.1. 获取动态密码参数类型定义
+
+// 5.1. 获取动态密码响应类型定义
+
+/**
+ * 获取动态密码
+ * @param {GetDynapwdParams} params - 包含设备Id和管理员密码的参数对象
+ * @returns {Promise<GetDynapwdResponse>} - 包含动态密码数据的响应对象的 Promise
+ */
+export const getDynamicPassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.dynapwd.get"),
+    version: '3.0',
+    data: params
+  });
+};
+
+// 5.2. 临时密码参数有效性校验参数类型定义
+
+// 5.2. 临时密码参数有效性校验响应类型定义
+
+/**
+ * 临时密码参数有效性校验（包括密码内容）
+ * @param {ValidateTempPasswordParams} params - 临时密码参数
+ * @returns {Promise<ValidateTempPasswordResult>} - 校验结果的 Promise
+ */
+export const validateTemporaryPassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.temppwd.validate"),
+    version: '3.0',
+    data: params
+  });
+};
+
+//#region 5.3. 校验临时密码参数
+
+/**
+ * Schedule_Ver2 - 版本2的周期设置
+ */
+
+/**
+ * ValidateUpdateTempPasswordParams - 校验临时密码参数
+ */
+
+/**
+ * ValidateUpdateTempPasswordResult - 校验临时密码结果
+ */
+
+/**
+ * 校验临时密码是否可以添加或更新
+ * @param {ValidateUpdateTempPasswordParams} params - 临时密码参数
+ * @returns {Promise<ValidateUpdateTempPasswordResult>} - 校验结果的 Promise
+ */
+export const validateAndUpdateTemporaryPassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.temppwd.validate"),
+    version: '2.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 5.4.  临时密码页创建临时密码
+
+/**
+ * CreateTempPasswordParams - 创建临时密码参数
+ */
+
+/**
+ * CreateTempPasswordResult - 创建临时密码结果
+ */
+
+/**
+ * 临时开锁页创建临时密码
+ * @param {CreateTempPasswordParams} params - 创建临时密码参数
+ * @returns {Promise<CreateTempPasswordResult>} - 创建结果的 Promise
+ */
+export const createTemporaryPassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.temppwd.create"),
+    version: '8.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 5.5.  更新临时密码
+
+/**
+ * UpdateTempPasswordParams - 更新临时密码参数
+ */
+
+/**
+ * UpdateTempPasswordResult - 更新临时密码结果
+ */
+
+// 请求结果：是否成功更新临时密码
+
+/**
+ * 更新临时密码相关的信息
+ * @param {UpdateTempPasswordParams} params - 更新临时密码参数
+ * @returns {Promise<UpdateTempPasswordResult>} - 更新结果的 Promise
+ */
+export const updateTempPassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.temppwd.update"),
+    version: '4.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 更新临时密码名称
+
+/**
+ * UpdateTempPasswordNameParams - 更新临时密码名称参数
+ */
+
+/**
+ * UpdateTempPasswordNameResult - 更新临时密码名称结果
+ */
+
+// 请求结果：是否成功更新临时密码名称
+
+/**
+ * 更新临时密码的名称
+ * @param {UpdateTempPasswordNameParams} params - 更新临时密码名称参数
+ * @returns {Promise<UpdateTempPasswordNameResult>} - 更新结果的 Promise
+ */
+export const updateTempPasswordName = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.temppwd.name"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region  删除临时密码
+
+/**
+ * DeleteTempPasswordParams - 删除临时密码参数
+ */
+
+/**
+ * DeleteTempPasswordResult - 删除临时密码结果
+ */
+
+// 请求结果：是否成功删除临时密码
+
+/**
+ * 删除生效中的临时密码
+ * @param {DeleteTempPasswordParams} params - 删除临时密码参数
+ * @returns {Promise<DeleteTempPasswordResult>} - 删除结果的 Promise
+ */
+export const deleteTemporaryPassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.temppwd.remove"),
+    version: '5.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region  检查分享可用性
+
+/**
+ * ShareAvailabilityParams - 检查分享可用性参数
+ */
+
+/**
+ * ShareAvailabilityResult - 检查分享可用性结果
+ */
+
+/**
+ * 获取某个账号是否可以用于分享
+ * @param {ShareAvailabilityParams} params - 检查分享可用性参数
+ * @returns {Promise<ShareAvailabilityResult>} - 检查结果的 Promise
+ */
+export const checkShareAvailability = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.share.available"),
+    version: '1.0',
+    data: params
+  });
+};