mrac-sn-refer-sdk 1.0.0

package/README.md

@@ -0,0 +1,77 @@
+# mrac-sn-refer-sdk
+
+【MRAC内部专用】SN REFER。
+
+## 📦 安装
+
+编译SDK（维护者）：
+
+```bash
+npm install
+npm run build
+```
+
+## 使用方法
+
+#### 集成sdk：
+
+```bash
+npm install mrac-sn-refer-sdk
+```
+
+#### JS调用示例：
+
+```js
+import { getReferSN, reportBase } from 'mrac-sn-refer-sdk'
+
+const storageModule = weex.requireModule('storage') //或 nativeService,需实现setItem & getItem
+
+//或自定义缓存模块，如
+const storageModule = {
+  setItem: (key, value, callback) => {
+    storage.setItem(key, JSON.stringify(value))
+    if (callback) {
+      callback()
+    }
+  },
+  getItem: (key, callback) => {
+    const value = storage.getItem(key)
+    callback(value ? JSON.parse(value) : null)
+  }
+}
+
+const httpModule = {
+  post: (api, body, success) => {
+    //示例。插件中应替换为相应nativeService.request方法
+    fetch(api, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify(body)
+    })
+      .then(res => res.json())
+      .then(data => 
+        //...先判断数据有效
+        const dataValid = xxxxx
+        if (dataValid) {
+          success(data.result) //根据实际接口返回结果数据
+        }
+      )
+  }
+}
+
+const run = async () => {
+  //示例。获取refer sn
+  const shouldCheck = true or false //当前sn无本地配置时为true
+  const result = await getReferSN('1234A', shouldCheck, storageModule, httpModule)
+  if (result.valid) {
+    console.log('refer sn:', result.refer)
+  }
+
+  //示例。上报
+  const shouldReport = !shouldCheck //当前sn有本地配置时为true
+  const serial = '_WDAD3' //应从SnFuncMap动态获取
+  reportBase('1234A', shouldReport, serial, storageModule, httpModule)
+}
+
+run()
+```

package/lib/index.d.ts

@@ -0,0 +1,19 @@
+import { type HttpModule, type ReferResult, type StorageModule } from './internal';
+/**
+ * 产品之间的关联关系检查（验证A产品与B产品存在关联关系）
+ * @param sn 当前产品SN
+ * @param shouldCheck 是否需要检查
+ * @param storageModule 外部传入存储模块
+ * @param httpModule 外部传入HTTP模块
+ */
+export declare const getReferSN: (sn: string, shouldCheck: boolean, storageModule: StorageModule, httpModule: HttpModule) => Promise<ReferResult>;
+/**
+ * 上报本地是否已配置当前产品的SN
+ * @param sn 当前产品SN
+ * @param shouldReport 是否需要上报
+ * @param serial 产品系列名（必填，SnFuncMap中的系列）
+ * @param storageModule 外部传入存储模块
+ * @param httpModule 外部传入HTTP模块
+ */
+export declare const reportBase: (sn: string, shouldReport: boolean, serial: string, storageModule: StorageModule, httpModule: HttpModule) => Promise<void>;
+export type { StorageModule, HttpModule, ReferResult };

package/lib/index.js

@@ -0,0 +1,76 @@
+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());
+    });
+};
+import { getStorageItem, parseReferCache, postRequest, REPORT_CACHE_SUFFIX, setStorageItem, ONE_DAY_MS } from './internal';
+const API_QUERY = '/product/app/config/query';
+const API_REPORT = '/product/app/config/report';
+/**
+ * 产品之间的关联关系检查（验证A产品与B产品存在关联关系）
+ * @param sn 当前产品SN
+ * @param shouldCheck 是否需要检查
+ * @param storageModule 外部传入存储模块
+ * @param httpModule 外部传入HTTP模块
+ */
+export const getReferSN = (sn, shouldCheck, storageModule, httpModule) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    if (!shouldCheck) {
+        return { valid: false, refer: null };
+    }
+    const sn5 = sn.length === 5
+        ? sn
+        : sn.length === 32
+            ? sn.slice(12, 17)
+            : sn.length === 22
+                ? sn.slice(6, 11)
+                : '';
+    if (sn5.length === 0) {
+        return { valid: false, refer: null };
+    }
+    const cached = parseReferCache(yield getStorageItem(storageModule, sn5));
+    const now = Date.now();
+    if (cached && cached.referSn && cached.expiredAt > now) {
+        return { valid: true, refer: cached.referSn };
+    }
+    const response = yield postRequest(httpModule, API_QUERY, { sn8: sn5 });
+    const referSn = (_a = response === null || response === void 0 ? void 0 : response.inherit_from) !== null && _a !== void 0 ? _a : null;
+    if (referSn) {
+        const cacheValue = {
+            referSn,
+            expiredAt: Date.now() + ONE_DAY_MS
+        };
+        //直接存储即可，不需要await
+        setStorageItem(storageModule, sn5, cacheValue);
+    }
+    return { valid: Boolean(referSn), refer: referSn };
+});
+/**
+ * 上报本地是否已配置当前产品的SN
+ * @param sn 当前产品SN
+ * @param shouldReport 是否需要上报
+ * @param serial 产品系列名（必填，SnFuncMap中的系列）
+ * @param storageModule 外部传入存储模块
+ * @param httpModule 外部传入HTTP模块
+ */
+export const reportBase = (sn, shouldReport, serial, storageModule, httpModule) => __awaiter(void 0, void 0, void 0, function* () {
+    if (!shouldReport) {
+        return;
+    }
+    const cacheKey = `${sn}${REPORT_CACHE_SUFFIX}`;
+    const cached = yield getStorageItem(storageModule, cacheKey);
+    if (cached) {
+        return;
+    }
+    yield postRequest(httpModule, API_REPORT, {
+        sn,
+        is_base: shouldReport,
+        profile_key: serial
+    });
+    //直接存储即可，不需要await
+    setStorageItem(storageModule, cacheKey, true);
+});

package/lib/internal.d.ts

@@ -0,0 +1,22 @@
+export type StorageModule = {
+    setItem: (key: string, value: unknown, callback?: () => void) => void;
+    getItem: (key: string, callback: (result: unknown) => void) => void;
+};
+export type HttpModule = {
+    post: (api: string, body: Record<string, unknown>, success: (result: unknown) => void) => void;
+};
+export type ReferCache = {
+    referSn: string;
+    expiredAt: number;
+};
+export type ReferResult = {
+    valid: boolean;
+    refer: string | null;
+};
+export declare const ONE_DAY_MS: number;
+export declare const REPORT_CACHE_SUFFIX = "__reported__";
+export declare const toPromise: <T>(executor: (resolve: (value: T) => void) => void) => Promise<T>;
+export declare const getStorageItem: <T>(storage: StorageModule, key: string) => Promise<T | null>;
+export declare const setStorageItem: (storage: StorageModule, key: string, value: unknown) => Promise<void>;
+export declare const postRequest: <T>(httpModule: HttpModule, api: string, body: Record<string, unknown>) => Promise<T>;
+export declare const parseReferCache: (cache: unknown) => ReferCache | null;

package/lib/internal.js

@@ -0,0 +1,52 @@
+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());
+    });
+};
+export const ONE_DAY_MS = 24 * 60 * 60 * 1000;
+export const REPORT_CACHE_SUFFIX = '__reported__';
+export const toPromise = (executor) => new Promise(resolve => executor(resolve));
+export const getStorageItem = (storage, key) => __awaiter(void 0, void 0, void 0, function* () {
+    return toPromise(resolve => {
+        storage.getItem(key, result => {
+            if (typeof result === 'undefined' || result === null) {
+                resolve(null);
+                return;
+            }
+            resolve(result);
+        });
+    });
+});
+export const setStorageItem = (storage, key, value) => __awaiter(void 0, void 0, void 0, function* () {
+    return toPromise(resolve => {
+        storage.setItem(key, value, () => resolve());
+    });
+});
+export const postRequest = (httpModule, api, body) => __awaiter(void 0, void 0, void 0, function* () {
+    return toPromise(resolve => {
+        httpModule.post(api, body, result => resolve(result));
+    });
+});
+export const parseReferCache = (cache) => {
+    if (!cache) {
+        return null;
+    }
+    if (typeof cache === 'string') {
+        try {
+            return JSON.parse(cache);
+        }
+        catch (error) {
+            return null;
+        }
+    }
+    if (typeof cache === 'object' &&
+        'referSn' in cache &&
+        'expiredAt' in cache) {
+        return cache;
+    }
+    return null;
+};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "mrac-sn-refer-sdk",
+  "version": "1.0.0",
+  "description": "** Internal use for mrac department. A refer tool.",
+  "type": "module",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
+    }
+  },
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "mrac",
+    "sn",
+    "refer"
+  ],
+  "author": "weicheng.chen@midea.com",
+  "license": "MIT",
+  "dependencies": {},
+  "devDependencies": {
+    "typescript": "^5.4.5"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}