@ray-js/lock-sdk 1.1.1-beta.2 → 1.1.1-beta.3

package/lib/api/index.d.ts

@@ -27,4 +27,12 @@ export declare const fetchOfflineDpData: (deviceId: string) => Promise<{
 }[]>;
 export declare const publishOfflineDpData: (deviceId: string, dpData: Record<string, DpValue>) => Promise<unknown>;
 export declare const clearOfflineDpData: (deviceId: string) => Promise<unknown>;
+export declare const getFileRemoteUrl: ({ biz, resources, }: {
+    biz: string;
+    resources: {
+        objectKey: string;
+    }[];
+}) => Promise<{
+    signedUrls: Record<string, string>;
+}>;
 export {};

package/lib/api/index.js

@@ -70,3 +70,13 @@ export const clearOfflineDpData = async (deviceId) => {
         version: "1.0",
     });
 };
+export const getFileRemoteUrl = ({ biz, resources, }) => {
+    return requestApi({
+        api: `${THING}.web.fastroute.download.sign`,
+        version: "2.0",
+        data: {
+            biz,
+            signedRequest: { resources },
+        },
+    });
+};

package/lib/capability.js

@@ -45,6 +45,7 @@ export const getDeviceAdvancedAbilities = async () => {
             "tyabi4ucx5",
             "tyabis9tpe",
             "tyabiwxrn9",
+            "tyabipd4hh",
         ]),
         getDeviceAdvancedAbility(config.devInfo.devId),
     ]);
@@ -68,27 +69,52 @@ export const getDeviceAdvancedAbilities = async () => {
             support: false,
             config: {},
         },
+        unlockGuide: {
+            support: false,
+            config: {},
+        },
     };
     productAbilities.forEach((item) => {
-        const data = JSON.parse(item.extConfig);
-        if (item.abilityCode === "tyabi4ucx5" && item.isOpen) {
-            deviceAdvanceAbilityCache.ai.config = data;
-            const dataReport = data?.ai_data_report ?? false;
-            const itemRecognition = data?.ai_recognition?.[0]?.item_recognition ?? false;
-            const petRecognition = data?.ai_recognition?.[0]?.pet_recognition ?? false;
-            const voice = data?.ai_voice ?? false;
-            const message = data?.ai_message ?? false;
-            deviceAdvanceAbilityCache.ai.support =
-                dataReport || itemRecognition || petRecognition || voice || message;
-        }
-        else if (item.abilityCode === "tyabis9tpe" && item.isOpen) {
-            deviceAdvanceAbilityCache.wechat.support = true;
-            deviceAdvanceAbilityCache.wechat.config = data;
+        try {
+            if (item.isOpen) {
+                const data = JSON.parse(item.extConfig);
+                switch (item.abilityCode) {
+                    case "tyabi4ucx5": {
+                        deviceAdvanceAbilityCache.ai.config = data;
+                        const dataReport = data?.ai_data_report ?? false;
+                        const itemRecognition = data?.ai_recognition?.[0]?.item_recognition ?? false;
+                        const petRecognition = data?.ai_recognition?.[0]?.pet_recognition ?? false;
+                        const voice = data?.ai_voice ?? false;
+                        const message = data?.ai_message ?? false;
+                        deviceAdvanceAbilityCache.ai.support =
+                            dataReport ||
+                                itemRecognition ||
+                                petRecognition ||
+                                voice ||
+                                message;
+                        break;
+                    }
+                    case "tyabis9tpe": {
+                        deviceAdvanceAbilityCache.wechat.support = true;
+                        deviceAdvanceAbilityCache.wechat.config = data;
+                        break;
+                    }
+                    case "tyabiwxrn9": {
+                        deviceAdvanceAbilityCache.wechatVoip.support =
+                            !!data?.voipType?.includes("0");
+                        deviceAdvanceAbilityCache.wechatVoip.config = data;
+                        break;
+                    }
+                    case "tyabipd4hh": {
+                        deviceAdvanceAbilityCache.unlockGuide.support = true;
+                        deviceAdvanceAbilityCache.unlockGuide.config = data;
+                        break;
+                    }
+                }
+            }
         }
-        else if (item.abilityCode === "tyabiwxrn9" && item.isOpen) {
-            deviceAdvanceAbilityCache.wechatVoip.support =
-                !!data?.voipType?.includes("0");
-            deviceAdvanceAbilityCache.wechatVoip.config = data;
+        catch (error) {
+            console.warn(`setting [${item.abilityCode}] config error`, error);
         }
     });
     return deviceAdvanceAbilityCache;

package/lib/config/index.d.ts

@@ -18,9 +18,10 @@ declare const config: {
     videoAngle: number;
     supportMultipleFace: boolean;
     supportOfflineDps: boolean;
+    preFetch: boolean;
     deviceStatus: DeviceStatus;
 };
-type UpdateConfigParams = Omit<LockSDKOption, "devInfo" | "deviceId">;
+type UpdateConfigParams = Omit<LockSDKOption, "devInfo" | "deviceId" | "preFetch">;
 export declare const updateConfig: (options: UpdateConfigParams) => void;
 export declare const hasCapability: (capability: ProductCommunicationType) => boolean;
 export declare const hasDp: (dpCode: string) => boolean;

package/lib/config/index.js

@@ -16,6 +16,7 @@ const config = {
     videoAngle: 0,
     supportMultipleFace: false,
     supportOfflineDps: false,
+    preFetch: false,
     deviceStatus: {
         type: "offline",
         connectEnable: false,

package/lib/index.js

@@ -60,6 +60,7 @@ export const init = async (options) => {
     config.codesById = codesById;
     config.idsByCode = idsByCode;
     config.supportBigData = !!dpSchema[dpCodes.synchMethodW];
+    config.preFetch = options?.preFetch ?? false;
     config.communication = getCapabilities(devInfo.capability).map((item) => item.id);
     addEvents();
     await initState();

package/lib/interface.d.ts

@@ -10,6 +10,7 @@ export interface LockSDKOption {
     passwordSupportZero?: boolean;
     supportMultipleFace?: boolean;
     supportOfflineDps?: boolean;
+    preFetch?: boolean;
 }
 export interface ErrorData {
     errorCode: number;
@@ -312,6 +313,10 @@ export interface DeviceAdvancedAbility {
         support: boolean;
         config: Record<string, any>;
     };
+    unlockGuide: {
+        support: boolean;
+        config: Record<string, any>;
+    };
 }
 export interface OfflineDpInfo {
     value: DpValue;
@@ -320,4 +325,9 @@ export interface OfflineDpInfo {
 export interface OfflineDps {
     [code: string]: OfflineDpInfo;
 }
+export interface UnlockGuide {
+    videoUrl: string;
+    picUrl: string;
+    expireTime: number;
+}
 export {};

package/lib/open.js

@@ -42,18 +42,18 @@ export const checkRemoteEnabled = parallelMerge(async () => {
     if (deviceStatus.type !== "online") {
         throw getError(1001);
     }
-    if (deviceStatus.onlineType === "local") {
-        if (!hasThread) {
-            throw getError(1064);
-        }
+    const isLocalOnline = deviceStatus.onlineTypes.length === 1 &&
+        deviceStatus.onlineTypes.includes("local");
+    const isThreadLocalOnline = hasThread && isLocalOnline;
+    if (isThreadLocalOnline || deviceStatus.onlineTypes.includes("ble")) {
+        return;
+    }
+    if (isLocalOnline) {
+        throw getError(1064);
     }
     if (dpSchema[dpCodes.remoteNoDpKey] === undefined) {
         throw getError(1045);
     }
-    if ((hasThread && deviceStatus.onlineType === "local") ||
-        deviceStatus.onlineType === "ble") {
-        return;
-    }
     if (!remoteOpenEnabled) {
         throw getError(1046);
     }
@@ -65,7 +65,7 @@ export const checkRemoteEnabled = parallelMerge(async () => {
     }
 });
 const _doAction = async (isOpen, timeout) => {
-    const { devInfo, onlineType, capabilities, communication, dpSchema } = config;
+    const { devInfo, communication } = config;
     await checkRemoteEnabled();
     const deviceStatus = getDeviceStatus();
     const hasThread = hasCapability(ProductCommunicationType.THREAD);

package/lib/state.js

@@ -38,7 +38,7 @@ const updateOnlineType = async () => {
     updateDeviceStatus();
 };
 export const getDeviceStatus = () => {
-    const { onlineType, dpSchema, communication, capabilities, devInfo: { isCloudOnline, isOnline, wifiEnableState }, } = config;
+    const { onlineType, devInfo: { isCloudOnline, isOnline, wifiEnableState }, } = config;
     const status = {
         type: isOnline ? "online" : "offline",
         connectEnable: false,
@@ -46,7 +46,7 @@ export const getDeviceStatus = () => {
         onlineTypes: [],
         isWifiActive: wifiEnableState !== 1,
     };
-    const isBleOnline = !isCloudOnline && isOnlineByType(onlineType, 2);
+    const isBleOnline = isOnlineByType(onlineType, 2);
     const isLocalOnline = !isCloudOnline && isOnlineByType(onlineType, 1);
     const supportWifi = hasCapability(ProductCommunicationType.WIFI);
     const supportBle = hasCapability(ProductCommunicationType.BLUETOOTH);
@@ -199,24 +199,29 @@ export const permissions = [
     "everyOne",
     "noOne",
 ];
+var DeviceProperties;
+(function (DeviceProperties) {
+    DeviceProperties["REMOTE_UNLOCK_AUTH"] = "REMOTE_UNLOCK_AUTH";
+    DeviceProperties["UNLOCK_PHONE_REMOTE"] = "UNLOCK_PHONE_REMOTE";
+})(DeviceProperties || (DeviceProperties = {}));
+const propsList = [
+    DeviceProperties.REMOTE_UNLOCK_AUTH,
+    DeviceProperties.UNLOCK_PHONE_REMOTE,
+];
 const fetchDeviceProperties = async (isForce) => {
     let result = null;
     if (isForce) {
-        result = await getDeviceProperties(config.devInfo.devId, [
-            "REMOTE_UNLOCK_AUTH",
-            "UNLOCK_PHONE_REMOTE",
-        ]);
+        result = await getDeviceProperties(config.devInfo.devId, propsList);
     }
     else {
         result = await getDataWithPreFetch("getDeviceProperties", () => {
-            return getDeviceProperties(config.devInfo.devId, [
-                "REMOTE_UNLOCK_AUTH",
-                "UNLOCK_PHONE_REMOTE",
-            ]);
+            return getDeviceProperties(config.devInfo.devId, propsList);
         });
     }
-    config.remoteOpenEnabled = result["UNLOCK_PHONE_REMOTE"] === "true";
-    config.remoteOpenPermission = permissions[+result["REMOTE_UNLOCK_AUTH"] || 0];
+    config.remoteOpenEnabled =
+        result[DeviceProperties.UNLOCK_PHONE_REMOTE] === "true";
+    config.remoteOpenPermission =
+        permissions[+result[DeviceProperties.REMOTE_UNLOCK_AUTH] || 0];
 };
 export const initState = async () => {
     const { devInfo: { dps, devId }, dpSchema, } = config;

package/lib/unlock-method.d.ts

@@ -1,4 +1,4 @@
-import { ErrorData, UnBindUnlockMethodGroup, UnlockMethodDetail, UnlockMethodType } from "./interface";
+import { ErrorData, UnBindUnlockMethodGroup, UnlockGuide, UnlockMethodDetail, UnlockMethodType } from "./interface";
 export interface SpecialUnlockMethodInfo {
     appSend?: boolean;
     msgPhone?: string;
@@ -85,4 +85,5 @@ export type AddUnlockMethodEvent = StepEvent | SuccessEvent | ErrorEvent;
 export type AddUnlockMethodListener = (event: AddUnlockMethodEvent) => void;
 export declare const onAddUnlockMethod: (listener: AddUnlockMethodListener) => void;
 export declare const offAddUnlockMethod: (listener: AddUnlockMethodListener) => void;
+export declare const getUnlockGuide: (type: UnlockMethodType) => Promise<UnlockGuide | null>;
 export {};

package/lib/unlock-method.js

@@ -12,8 +12,9 @@ import { publishDps } from "./utils/publishDps";
 import { encrypt } from "./utils/device";
 import emitter from "./utils/event";
 import { DPCHANGE, UNLOCK_METHOD_EVENT } from "./utils/constant";
-import { sendPhoneVerifyCode } from "./api";
+import { getFileRemoteUrl, sendPhoneVerifyCode } from "./api";
 import { getUserInfo } from "./user";
+import { getDeviceAdvancedAbilities } from "./capability";
 const getAddUnlockError = (status) => {
     if (status >= 0 && status <= 10) {
         return getError(1015 + status);
@@ -560,3 +561,49 @@ export const onAddUnlockMethod = (listener) => {
 export const offAddUnlockMethod = (listener) => {
     emitter.off(UNLOCK_METHOD_EVENT, listener);
 };
+const guileTypeMap = {
+    card: ["addCard", "addCardPic"],
+    finger: ["addFingerprint", "addFingerprintPic"],
+    face: ["addFace", "addFacePic"],
+    fingerVein: ["addFingervein", "addFingerveinPic"],
+    hand: ["addPalmvein", "addPalmveinPic"],
+    eye: ["addIris", "addIrisPic"],
+};
+export const getUnlockGuide = async (type) => {
+    if (type === "password") {
+        return null;
+    }
+    const { unlockGuide } = await getDeviceAdvancedAbilities();
+    if (unlockGuide.support) {
+        const [videoKey, picKey] = guileTypeMap[type] || ["", ""];
+        const resources = [];
+        let videoUrlPath = "";
+        let picUrlPath = "";
+        if (unlockGuide.config[picKey]) {
+            picUrlPath = unlockGuide.config[picKey].url;
+            resources.push({
+                objectKey: picUrlPath,
+            });
+        }
+        if (unlockGuide.config[videoKey]) {
+            videoUrlPath = unlockGuide.config[videoKey].url;
+            resources.push({
+                objectKey: videoUrlPath,
+            });
+        }
+        if (resources.length === 0) {
+            return null;
+        }
+        const { signedUrls } = await getFileRemoteUrl({
+            biz: "hulk_video_tutorial_video",
+            resources,
+        });
+        const expireTime = Date.now() + 30 * 60 * 1000;
+        return {
+            videoUrl: signedUrls[videoUrlPath],
+            picUrl: signedUrls[picUrlPath],
+            expireTime,
+        };
+    }
+    return null;
+};

package/lib/utils/index.js

@@ -258,18 +258,20 @@ onBackgroundFetchData(preFetchKeys, (res) => {
     });
 });
 export const getDataWithPreFetch = async (key, apiCb) => {
-    if (preFetchData[key]) {
-        return preFetchData[key];
-    }
-    try {
-        const result = await getBackgroundFetchData([key]);
-        if (result &&
-            result.fetchedData[key] &&
-            result.fetchedData[key].fetchedData) {
-            return result.fetchedData[key].fetchedData;
+    if (config.preFetch) {
+        if (preFetchData[key]) {
+            return preFetchData[key];
+        }
+        try {
+            const result = await getBackgroundFetchData([key]);
+            if (result &&
+                result.fetchedData[key] &&
+                result.fetchedData[key].fetchedData) {
+                return result.fetchedData[key].fetchedData;
+            }
+        }
+        catch {
         }
-    }
-    catch {
     }
     return apiCb();
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ray-js/lock-sdk",
-  "version": "1.1.1-beta.2",
+  "version": "1.1.1-beta.3",
   "files": [
     "lib",
     "LICENSE.md"