@cpzxrobot/sdk 1.0.0 → 1.0.3

package/dist/index.js

@@ -48,10 +48,10 @@ class shzx {
     inApp() {
         return this.mode === "miniapp_in_app";
     }
-    initAxios() {
+    initAxios(baseURL) {
         if (this.mode !== "miniapp_in_app") {
             const instance = axios_1.default.create({
-                baseURL: "/",
+                baseURL,
             });
             instance.interceptors.request.use((config) => {
                 // 在发送请求之前在头部添加token
@@ -126,7 +126,7 @@ class shzx {
             this.setTitle = function (title) {
                 document.title = title;
             };
-            console.log("欢迎使用上海正芯物联网IOT系统，您当前是开发环境，请在平台获取开发用jwt key，并传入devAuth设置");
+            console.log("欢迎使用上海正诚物联网IOT系统，您当前是开发环境，请在平台获取开发用jwt key，并传入devAuth设置");
         }
         else {
             this.mode = "miniapp_in_web";
@@ -149,16 +149,16 @@ class shzx {
     openMiniApp(url) {
         this._jumpToMiniApp(url);
     }
-    setAuth(auth) {
+    setAuth(auth, baseURL) {
         if (this.mode === "miniapp_in_app") {
             this.platformReady.then(() => {
-                this.initAxios();
+                this.initAxios(baseURL);
                 console.log("shzx is ready");
                 this.resolveReady(this.axios);
             });
             return;
         }
-        this.initAxios();
+        this.initAxios(baseURL);
         this.auth = auth;
         this.axios
             .post("/api/v1/user/auth", {
@@ -190,6 +190,7 @@ let _instance;
 function default_1(args = {
     devAuth: "",
     appCode: "",
+    baseURL: "https://www.cpzxrobot.com/",
     selectedFarm: {
         id: 0,
         code: "",
@@ -203,7 +204,7 @@ function default_1(args = {
 }) {
     if (!_instance) {
         _instance = new shzx(args.appCode);
-        _instance.setAuth(args.devAuth);
+        _instance.setAuth(args.devAuth, args.baseURL);
         if (args.selectedFarm) {
             _instance.user.selectedFarm = args.selectedFarm;
         }

package/index.ts

@@ -65,10 +65,10 @@ class shzx {
     return this.mode === "miniapp_in_app";
   }
 
-  initAxios() {
+  initAxios(baseURL:string) {
     if (this.mode !== "miniapp_in_app") {
       const instance = axios.create({
-        baseURL: "/",
+        baseURL,
       });
       instance.interceptors.request.use(
         (config) => {
@@ -181,16 +181,16 @@ class shzx {
     this._jumpToMiniApp(url);
   }
 
-  setAuth(auth: string) {
+  setAuth(auth: string,baseURL:string) {
     if (this.mode === "miniapp_in_app") {
       this.platformReady.then(() => {
-        this.initAxios();
+        this.initAxios(baseURL);
         console.log("shzx is ready");
         this.resolveReady(this.axios);
       });
       return;
     }
-    this.initAxios();
+    this.initAxios(baseURL);
     this.auth = auth;
     this.axios
       .post("/api/v1/user/auth", {
@@ -225,12 +225,14 @@ let _instance!: shzx;
 export default function (
   args: {
     devAuth: string;
+    baseURL: string;
     appCode: string;
     selectedFarm: Factory;
     selectedUnit: Unit;
   } = {
     devAuth: "",
     appCode: "",
+    baseURL: "https://www.cpzxrobot.com/",
     selectedFarm: {
       id: 0,
       code: "",
@@ -245,7 +247,7 @@ export default function (
 ): shzx {
   if (!_instance) {
     _instance = new shzx(args.appCode);
-    _instance.setAuth(args.devAuth);
+    _instance.setAuth(args.devAuth,args.baseURL);
     if (args.selectedFarm) {
       _instance.user.selectedFarm = args.selectedFarm;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cpzxrobot/sdk",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "提供给上海正芯数智APP第三方H5应用使用的SDK",
   "main": "dist/index.js",
   "scripts": {

package/readme.md

@@ -4,3 +4,95 @@
 
 ## 使用方式
 
+```
+npm i @cpzxrobot/sdk
+```
+
+## 开发指南
+
+### 引入包
+
+```
+import cpzxrobot from "@cpzxrobot/sdk"
+```
+
+### 配置开发信息
+```
+cpzxrobot({
+  devAuth: "从上海正芯获得的开发临时token",
+  appCode: "上海正芯分配的App Code",
+  selectedFarm: {
+    code: "xxxx",
+    company_code: "xxxx",
+    id: 123456,
+    name: "自定义用户测试的工厂，请从后台根据业务选择合适的工厂",
+  },
+  selectedUnit: {
+    id: 123456,
+    name: "自定义用户测试的单元，请从后台根据业务选择合适的单元",
+    workshopName: 'A栋'
+  },
+});
+```
+
+使用上述模板进行sdk初始化
+
+#### 开发时的CORS问题
+
+如果上述配置后，出现调用接口CORS问题，请在初始化增加参数：
+```
+baseURL: "/"
+```
+并在vite.config.js等开发环境配置文件中配置：
+```
+  server: {
+    proxy: {
+      "/api": {
+        target: "https://www.cpzxrobot.com/",
+        changeOrigin: true,
+      },
+    },
+  },
+```
+
+### 调用接口
+
+主要包入口：
+
+| 调用入口                | 功能说明             |
+| ----------------------- | -------------------- |
+| cpzxrobot().factory.xxx | 获得工厂的相关信息   |
+| cpzxrobot().device.xxx  | 获得设备的相关信息   |
+| cpzxrobot().camera.xxx  | 获得摄像头的相关信息 |
+
+### 工厂信息接口
+
+#### cpzxrobot().factory.workshops(factory_id)
+
+获得工厂的所有车间
+
+入参：
+
+factory_id: 工厂id
+
+#### cpzxrobot().factory.units(factory_id)
+
+获得工厂的所有单元
+
+入参：
+
+factory_id: 工厂id
+
+### 摄像头相关
+
+cpzxrobot().camera.search(args)
+
+搜索摄像头
+
+入参：
+
+入参为json object，可接受多种参数中的一个
+
+如果入参为：{unit_id:xxx}则按单元搜索
+
+如果入参为:{factory_id:xxx}则按工厂搜索