@lazycatcloud/sdk 0.1.140 → 0.1.142

package/README.md

@@ -0,0 +1,51 @@
+<!--
+ * @Author: Bin
+ * @Date: 2023-03-06
+ * @FilePath: /lzc-sdk/lang/js/README.md
+-->
+# 懒猫云应用开发
+
+> 懒猫云应用平台提供大量系统以及应用层的接口，用户或开发者可以基于开放的接口创造出有趣的应用程序，可以通过阅读本接口文档来帮助开发。
+
+## 开始开发
+
+@lazycatcloud/sdk 通过 npm 和 yarn 进行分发，你可以通过相应的包管理工具进行安装。
+
+```
+npm i @lazycatcloud/sdk
+
+# or
+
+yarn add @lazycatcloud/sdk
+```
+
+@lazycatcloud/sdk 目前由 `grpc api` 和 `lzc sdk` 两个部分组成。
+
+- `grpc api` 是基于与懒猫云盒子以及其他组网设备数据以及交互所使用的接口。
+
+- `lzc sdk` 是针对懒猫云客户端提供的云应用客户端程序、客户端原生应用系列交互 SDK。
+
+我将通过下列两个示例帮助你分别理解 `grpc api` 和 `lzc sdk`
+
+通过 `grpc api` 获取当前设备信息示例代码：
+```
+import { lzcApiGateway } from '@lazycatcloud/sdk/dist/localdevice/device';
+
+const lzcApiGateway = new lzcAPIGateway();
+const currentDevice = lzcAPI.current?.currentDevice;
+console.log('currentDevice', currentDevice);
+```
+
+通过 `lzc sdk` 打开懒猫云相册应用（更多接口信息请参考 [懒猫云应用通用能力开发文档](./docs/extentions/AppCommon.md)）：
+```
+import { AppCommon } from '@lazycatcloud/sdk/dist/extentions';
+
+AppCommon.LaunchApp("https://pbkbin.zmide.com", "com.zmide.bin");
+```
+
+
+## 更多文档
+
+[懒猫云应用通用能力开发文档](./docs/extentions/AppCommon.md)
+
+[实践指南（面向内部开发者）](./docs/contribute.md)

package/dist/extentions/app_common.d.ts

@@ -1,8 +1,14 @@
-declare var view: any;
-declare function isWebShell(): boolean;
-declare function isAndroidWebShell(): boolean;
-declare function isPCWebShell(): boolean;
-declare function isIosWebShell(): boolean;
-declare function isControlView(): boolean;
-declare function isContentView(): boolean;
+import { LzcAppSdkManage } from './base';
+declare class AppCommon extends LzcAppSdkManage {
+    static ScriptHandlers(): Promise<string[]>;
+    /**
+     * @description: 打开应用
+     * @param {string} url
+     * @param {string} appid
+     * @return {Promise<void>}
+     */
+    static LaunchApp(url: string, appid: string): Promise<void>;
+    static LaunchNativeApp(): Promise<void>;
+}
+export { AppCommon };
 //# sourceMappingURL=app_common.d.ts.map

package/dist/extentions/app_common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"app_common.d.ts","sourceRoot":"","sources":["../../extentions/app_common.ts"],"names":[],"mappings":"AAAA,QAAA,IAAI,IAAI,KAAA,CAAC;AACT,iBAAS,UAAU,YAElB;AAED,iBAAS,iBAAiB,YAEzB;AAGD,iBAAS,YAAY,YAEpB;AAGD,iBAAS,aAAa,YAErB;AAGD,iBAAS,aAAa,YAErB;AAED,iBAAS,aAAa,YAErB"}
+{"version":3,"file":"app_common.d.ts","sourceRoot":"","sources":["../../extentions/app_common.ts"],"names":[],"mappings":"AAAA,OAAkB,EAAsB,eAAe,EAAU,MAAM,QAAQ,CAAC;AAEhF,cAAM,SAAU,SAAQ,eAAe;WAGf,cAAc,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IASvD;;;;;OAKG;WAMiB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;WAiBpD,eAAe;CAMtC;AAED,OAAO,EAAE,SAAS,EAAE,CAAA"}

package/dist/extentions/app_common.js

@@ -1,31 +1,104 @@
-var view;
-function isWebShell() {
-    return navigator.userAgent.indexOf("Lazycat") != -1 && !isControlView() && !isContentView();
-}
-// 是否是android webshell 环境
-function isAndroidWebShell() {
-    return navigator.userAgent.indexOf("Lazycat_101") != -1;
-}
-// 是否是pc webshell 环境
-function isPCWebShell() {
-    return navigator.userAgent.indexOf("Lazycat_102") != -1;
-}
-// 是否是ios webshell 环境
-function isIosWebShell() {
-    return navigator.userAgent.indexOf("Lazycat_103") != -1;
-}
-function isControlView() {
-    return navigator.userAgent.indexOf("Lazycat_ControlView") != -1;
-}
-function isContentView() {
-    return navigator.userAgent.indexOf("Lazycat_ContentView") != -1;
-}
-if (isAndroidWebShell()) {
-    // @ts-ignore
-    view = android;
-}
-else if (isPCWebShell()) {
-    // @ts-ignore
-    view = window.electronAPI;
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppCommon = void 0;
+const base_1 = __importStar(require("./base"));
+class AppCommon extends base_1.LzcAppSdkManage {
+    static ScriptHandlers() {
+        return __awaiter(this, void 0, void 0, function* () {
+            // const callback = await LzcAppSdk.useNative.ScriptHandlers()
+            // console.log("LzcAppSdk.useNative", LzcAppSdk.useNative);
+            const jsBridge = yield base_1.default.useNativeAsync();
+            const call = yield jsBridge.ScriptHandlers();
+            // jsBridge.Test()
+            return call;
+        });
+    }
+    /**
+     * @description: 打开应用
+     * @param {string} url
+     * @param {string} appid
+     * @return {Promise<void>}
+     */
+    static LaunchApp(url, appid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let browserOnly = false; // 读取用户是否设置为在浏览器打开
+            if (!base_1.default.isInApplication() || browserOnly) {
+                // 判断是否在浏览器中，在浏览器中时或者用户设置为在浏览器打开时，将直接使用 window.open 打开页面
+                window.open(url, '_blank');
+            }
+            else {
+                if (base_1.default.isAndroidWebShell()) {
+                    const jsBridge = yield base_1.default.useNativeAsync(android_launch_app);
+                    jsBridge.LaunchApp(url, appid);
+                }
+                else {
+                    // 判断是在客户端中
+                    const jsBridge = yield base_1.default.useNativeAsync();
+                    jsBridge.LaunchApp(url, appid);
+                }
+            }
+        });
+    }
+    static LaunchNativeApp() {
+        return __awaiter(this, void 0, void 0, function* () {
+            // TODO: 待实现
+            const jsBridge = base_1.default.useNative();
+            console.error("LaunchNativeApp 方法暂未实现。");
+        });
+    }
 }
+__decorate([
+    (0, base_1.native)(base_1.LzcAppPlatformType.IOS),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], AppCommon, "ScriptHandlers", null);
+__decorate([
+    (0, base_1.native)(base_1.LzcAppPlatformType.IOS, base_1.LzcAppPlatformType.Android, base_1.LzcAppPlatformType.PC, base_1.LzcAppPlatformType.Browser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String]),
+    __metadata("design:returntype", Promise)
+], AppCommon, "LaunchApp", null);
+exports.AppCommon = AppCommon;
 //# sourceMappingURL=app_common.js.map

package/dist/extentions/app_common.js.map

@@ -1 +1 @@
-{"version":3,"file":"app_common.js","sourceRoot":"","sources":["../../extentions/app_common.ts"],"names":[],"mappings":"AAAA,IAAI,IAAI,CAAC;AACT,SAAS,UAAU;IACf,OAAO,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;AAChG,CAAC;AACD,yBAAyB;AACzB,SAAS,iBAAiB;IACtB,OAAO,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;AAC5D,CAAC;AAED,oBAAoB;AACpB,SAAS,YAAY;IACjB,OAAO,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;AAC5D,CAAC;AAED,qBAAqB;AACrB,SAAS,aAAa;IAClB,OAAO,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;AAC5D,CAAC;AAGD,SAAS,aAAa;IAClB,OAAO,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC;AACpE,CAAC;AAED,SAAS,aAAa;IAClB,OAAO,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC;AACpE,CAAC;AAGD,IAAI,iBAAiB,EAAE,EAAE;IACrB,aAAa;IACb,IAAI,GAAG,OAAO,CAAC;CAClB;KAAM,IAAI,YAAY,EAAE,EAAE;IACvB,aAAa;IACb,IAAI,GAAG,MAAM,CAAC,WAAW,CAAA;CAC5B"}
+{"version":3,"file":"app_common.js","sourceRoot":"","sources":["../../extentions/app_common.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAgF;AAEhF,MAAM,SAAU,SAAQ,sBAAe;IAG5B,MAAM,CAAO,cAAc;;YAC9B,8DAA8D;YAC9D,2DAA2D;YAC3D,MAAM,QAAQ,GAAG,MAAM,cAAS,CAAC,cAAc,EAAE,CAAA;YACjD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,cAAc,EAAE,CAAA;YAC5C,kBAAkB;YAClB,OAAO,IAAI,CAAA;QACf,CAAC;KAAA;IAED;;;;;OAKG;IAMI,MAAM,CAAO,SAAS,CAAC,GAAW,EAAE,KAAa;;YACpD,IAAI,WAAW,GAAG,KAAK,CAAA,CAAC,kBAAkB;YAC1C,IAAI,CAAC,cAAS,CAAC,eAAe,EAAE,IAAI,WAAW,EAAE;gBAC7C,wDAAwD;gBACxD,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;aAC7B;iBAAM;gBACH,IAAG,cAAS,CAAC,iBAAiB,EAAE,EAAC;oBAC7B,MAAM,QAAQ,GAAG,MAAM,cAAS,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAA;oBACnE,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;iBACjC;qBAAI;oBACD,WAAW;oBACX,MAAM,QAAQ,GAAG,MAAM,cAAS,CAAC,cAAc,EAAE,CAAA;oBACjD,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;iBACjC;aACJ;QACL,CAAC;KAAA;IAEM,MAAM,CAAO,eAAe;;YAC/B,YAAY;YACZ,MAAM,QAAQ,GAAG,cAAS,CAAC,SAAS,EAAE,CAAA;YACtC,OAAO,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAA;QAC5C,CAAC;KAAA;CAEJ;AA3CG;IADC,IAAA,aAAM,EAAC,yBAAkB,CAAC,GAAG,CAAC;;;;qCAQ9B;AAaD;IALC,IAAA,aAAM,EAAC,yBAAkB,CAAC,GAAG,EAC1B,yBAAkB,CAAC,OAAO,EAC1B,yBAAkB,CAAC,EAAE,EACrB,yBAAkB,CAAC,OAAO,CAC7B;;;;gCAgBA;AAUI,8BAAS"}

package/dist/extentions/base.d.ts

@@ -0,0 +1,112 @@
+declare enum PlatformType {
+    Android = 0,
+    IOS = 1,
+    PC = 2,
+    Browser = 3
+}
+/**
+ * @description: 指定函数支持平台函数装饰器
+ * @param {array} platforms
+ * @return {Function}
+ */
+declare function native(...platforms: PlatformType[]): Function;
+declare class LzcAppSdk {
+    private static instance;
+    private static cacheJSBridgeIOS;
+    protected constructor();
+    /**
+     * @description: 获取 LzcAppSdk 对象实例
+     * @return {LzcAppSdk}
+     */
+    static getInstance(): LzcAppSdk;
+    /**
+     * @description: 初始化 JSBridge 全局回调队列
+     * @return {void}
+     */
+    private initCallbackQueue;
+    /**
+     * @description: JS 调用原生函数时，添加回调方法到回调方法存储器，并返回索引ID
+     * @param {Function} responseCallBackFunc
+     * @return {string}
+     */
+    static addToCallBackFuncDictWith(responseCallBackFunc: Function): string;
+    /**
+     * @description: 原生接受 JS 调用并处理相关操作后，发送回调给js, js 根据索引ID寻找回调方法来处理数据，然后移除js的回调方法
+     * @param {string} funcUniqueID
+     * @param {any} responseData
+     * @return {void}
+     */
+    static sendCallBackFunc(funcUniqueID: string, responseData: any): void;
+    /**
+     * @description: 注册一个 JS 函数
+     * @param {string} name
+     * @return {Promise<any> | undefined}
+     */
+    private static _registerCallBackFunc;
+    /**
+     * @description: 获取 IOS 原生 JSBridge 对象
+     * @return {Promise<any>}
+     */
+    private static initJSBridgeIOS;
+    /**
+     * @description: 根据原生注入命名空间 异步获取 JSBridge
+     * @param {any} namespaces
+     * @return {Promise<any>}
+     */
+    useNativeAsync(namespaces?: any): Promise<any>;
+    /**
+     * @description: 根据原生注入命名空间 同步获取 JSBridge (如调用原生方法不需要回调值的可以使用该函数获取原生对象否则最好使用 useNativeAsync 函数)
+     * @param {any} namespaces
+     * @return {any}
+     */
+    useNative(namespaces?: any): any;
+    /**
+     * @description: 判断是否属于 webshell 环境
+     * @return {boolean}
+     */
+    isWebShell(): boolean;
+    /**
+     * @description: 是否是android webshell 环境
+     * @return {boolean}
+     */
+    isAndroidWebShell(): boolean;
+    /**
+     * @description: 是否是pc webshell 环境
+     * @return {boolean}
+     */
+    isPCWebShell(): boolean;
+    /**
+     * @description: 是否是ios webshell 环境
+     * @return {boolean}
+     */
+    isIosWebShell(): boolean;
+    /**
+     * @description: 是否属于 Control webshell 环境
+     * @return {boolean}
+     */
+    isControlView(): boolean;
+    /**
+     * @description: 是否属于 Content webshell 环境
+     * @return {boolean}
+     */
+    isContentView(): boolean;
+    /**
+     * @description: 是否在客户端内
+     * @return {boolean}
+     */
+    isInApplication(): boolean;
+}
+declare class LzcAppSdkManage {
+    protected static LzcApp: LzcAppSdk;
+    protected LzcApp: LzcAppSdk;
+}
+declare const LzcApp: LzcAppSdk;
+/**
+ * @description: 兼容旧的 android 注入的 js 调用（待迁移后删除改引用）
+ * @deprecated: 该 JS 注入引用即将弃用，请尽快适配最新的 LzcAppSdk.useNative() 调用方式
+ * @return {any}
+ */
+declare const LzcClient: any;
+export default LzcApp;
+export { PlatformType as LzcAppPlatformType, LzcAppSdkManage, LzcClient, native };
+//# sourceMappingURL=base.d.ts.map

package/dist/extentions/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../extentions/base.ts"],"names":[],"mappings":"AAMA,aAAK,YAAY;IACb,OAAO,IAAA;IACP,GAAG,IAAA;IACH,EAAE,IAAA;IACF,OAAO,IAAA;CACV;AA2CD;;;;GAIG;AACH,iBAAS,MAAM,CAAC,GAAG,SAAS,EAAE,YAAY,EAAE,GAAG,QAAQ,CA+HtD;AAED,cAAM,SAAS;IACX,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAY;IACnC,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAM;IAErC,SAAS;IAiBT;;;OAGG;WACW,WAAW,IAAI,SAAS;IAOtC;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAezB;;;;OAIG;WACW,yBAAyB,CAAC,oBAAoB,EAAE,QAAQ,GAAG,MAAM;IAS/E;;;;;OAKG;WACW,gBAAgB,CAC1B,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,GAAG,GAClB,IAAI;IASP;;;;OAIG;mBACkB,qBAAqB;IA0B1C;;;OAGG;mBAEkB,eAAe;IAmCpC;;;;OAIG;IACU,cAAc,CAAC,UAAU,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAS3D;;;;OAIG;IACI,SAAS,CAAC,UAAU,CAAC,EAAE,GAAG,GAAG,GAAG;IAyBvC;;;OAGG;IACI,UAAU,IAAI,OAAO;IAI5B;;;OAGG;IACI,iBAAiB,IAAI,OAAO;IAInC;;;OAGG;IACI,YAAY,IAAI,OAAO;IAI9B;;;OAGG;IACI,aAAa,IAAI,OAAO;IAI/B;;;OAGG;IACI,aAAa,IAAI,OAAO;IAI/B;;;OAGG;IACI,aAAa,IAAI,OAAO;IAI/B;;;OAGG;IACI,eAAe,IAAI,OAAO;CAGpC;AAED,cAAM,eAAe;IACjB,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAA;IAClC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAA;CAC9B;AAED,QAAA,MAAM,MAAM,WAA0B,CAAA;AAEtC;;;;GAIG;AACH,QAAA,MAAM,SAAS,EAAE,GAAwB,CAAA;AAEzC,eAAe,MAAM,CAAA;AACrB,OAAO,EAAE,YAAY,IAAI,kBAAkB,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,EAAE,CAAA"}