@seayoo-web/kms 3.2.0 → 3.3.1

package/dist/index.js

@@ -1,35 +1,77 @@
-function w(t) {
-  const r = {}, { group: i, filter: e, filterLogic: c, range: u, created: p, updated: m, size: A, page: d, sort: o } = t, { sn: j, fields: a, dataFields: s, multi: b, combo: h, pure: g = "items", label: n, value: f, option: $ } = t;
-  if (j && (r.sn = j), i && (r.g = Array.isArray(i) ? i.join(",") : i), e) {
-    const v = c === "or" ? "|" : "+", q = Object.keys(e);
-    r.filter = q.map((y) => {
-      const l = e[y];
-      return Array.isArray(l) ? `${y}:${l.join(",")}` : `${y}:${l}`;
-    }).join(v);
+const h = typeof globalThis < "u" ? globalThis : typeof self < "u" ? self : typeof window < "u" ? window : Function("return this")();
+function v(r) {
+  return typeof r == "function";
+}
+function x(r) {
+  return typeof r == "object" && r !== null;
+}
+function C() {
+  return "localStorage" in h && x(h.localStorage) && "getItem" in h.localStorage && v(h.localStorage.getItem);
+}
+function I(r, t) {
+  try {
+    const e = JSON.parse(r);
+    return t ? t(e) ? e : null : e;
+  } catch {
+    return null;
+  }
+}
+function P(r) {
+  const t = {}, { group: e, filter: n, filterLogic: o, range: i, created: a, updated: u, size: f, page: c, sort: s } = r, { sn: d, fields: l, dataFields: p, multi: S, combo: $, pure: A = "items", label: y, value: g, option: j } = r;
+  if (d && (t.sn = d), e && (t.g = Array.isArray(e) ? e.join(",") : e), n) {
+    const w = o === "or" ? "|" : "+", O = Object.keys(n);
+    t.filter = O.map((m) => {
+      const b = n[m];
+      return Array.isArray(b) ? `${m}:${b.join(",")}` : `${m}:${b}`;
+    }).join(w);
   }
-  return u && (r.r = u), p && (r.created = p.join("-")), m && (r.updated = m.join("-")), o && (r.sort = Array.isArray(o) ? o.join(",") : o), b === !1 && (r.m = "n"), A && (r.s = `${A}`), d && (r.p = `${d}`), a && (r.f = Array.isArray(a) ? a.join(",") : a), s && (r.df = Array.isArray(s) ? s.join(",") : s), h === !0 && (a ? r.c = "y" : console.warn("设置 combo:true 必须要同步设置 fields")), g && (r.pure = g === "items" ? "items" : "y"), n && (r.label = Array.isArray(n) ? n.join(",") : n), f && (r.value = Array.isArray(f) ? f.join(",") : f), $ && (r.option = $), r._ = Math.random().toString(16).slice(-8), r;
+  return i && (t.r = i), a && (t.created = a.join("-")), u && (t.updated = u.join("-")), s && (t.sort = Array.isArray(s) ? s.join(",") : s), S === !1 && (t.m = "n"), f && (t.s = `${f}`), c && (t.p = `${c}`), l && (t.f = Array.isArray(l) ? l.join(",") : l), p && (t.df = Array.isArray(p) ? p.join(",") : p), $ === !0 && (l ? t.c = "y" : console.warn("设置 combo:true 必须要同步设置 fields")), A && (t.pure = A === "items" ? "items" : "y"), y && (t.label = Array.isArray(y) ? y.join(",") : y), g && (t.value = Array.isArray(g) ? g.join(",") : g), j && (t.option = j), t._ = Math.random().toString(16).slice(-8), t;
 }
-function L(t) {
-  return t.replace(/(?:^https?:\/\/|\/*$)/gi, "").toLowerCase();
+function D(r) {
+  return r.replace(/(?:^https?:\/\/|\/*$)/gi, "").toLowerCase();
 }
-class x {
+class N {
   req;
-  constructor(r, i) {
-    this.req = i({
-      baseURL: `https://${L(r)}`,
-      timeout: 8e3,
-      maxRetry: 3,
-      retryInterval: 150
-    });
+  enabledCache;
+  cachePrefix;
+  /**
+   * 设置请求的 endpoint 和请求工具来初始化 KMS Dsi，第三个可选参数 enabledCache 来激活本地缓存数据
+   *
+   * 当启用本地缓存数据时，会将成功返回的数据缓存到本地，并在后续 dsi 接口出现问题时以缓存数据返回
+   *
+   * 本地缓存有效期最长为 24 小时
+   */
+  constructor(t, e, n = !1) {
+    const o = `https://${D(t)}`;
+    this.enabledCache = n, this.cachePrefix = o.replace(/^https:\/\//i, "").replace(/[./]/g, "-") + ":", this.req = e({ baseURL: o, timeout: 6e3, maxRetry: 2, retryInterval: 150 });
   }
   /**
-   * 查询 Dsi 数据接口并返回接口响应
+   * 查询 Dsi 数据接口并返回接口响应，可设置是否启用本地缓存以应对网络错误的情况
    */
-  async query({ key: r, query: i, guard: e }) {
-    const { data: c } = await this.req.get(r, e, { params: w(i) });
-    return c;
+  async query({ key: t, query: e, guard: n, cache: o }) {
+    const { data: i } = await this.req.get(t, n, { params: P(e) }), a = (o ?? this.enabledCache) && C(), u = this.cachePrefix + t + (e.page ? `:p${e.page}` : "");
+    if (i !== null)
+      return a && localStorage.setItem(u, JSON.stringify([Date.now(), e, i])), i;
+    if (!a)
+      return i;
+    const f = localStorage.getItem(`${this.cachePrefix}${t}`);
+    if (f) {
+      const c = I(f, function(s) {
+        return Array.isArray(s) && s.length === 2 && typeof s[0] == "number" && n(s[1]);
+      });
+      if (c && J(e, c[1]) && c[0] + 24 * 3600 * 1e3 > Date.now())
+        return c[2];
+    }
+    return i;
   }
 }
+function J(r, t) {
+  const e = Object.keys(r);
+  return e.length === Object.keys(t).length && e.every((n) => {
+    const o = r[n], i = t[n], a = typeof o;
+    return a === "string" || a === "number" || a === "boolean" || a === "bigint" ? o === i : JSON.stringify(o) === JSON.stringify(i);
+  });
+}
 export {
-  x as KMSDsi
+  N as KMSDsi
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seayoo-web/kms",
-  "version": "3.2.0",
+  "version": "3.3.1",
   "description": "agent for seayoo.kms",
   "type": "module",
   "source": "index.ts",
@@ -20,7 +20,8 @@
   },
   "devDependencies": {
     "@seayoo-web/request": "^3.4.0",
-    "@seayoo-web/scripts": "^3.0.0",
+    "@seayoo-web/utils": "4.1.3",
+    "@seayoo-web/scripts": "^3.1.2",
     "@seayoo-web/tsconfig": "^1.0.5"
   },
   "peerDependencies": {

package/types/src/dsi.d.ts

@@ -4,7 +4,6 @@ type QuerySortBaseField = "start" | "end" | "created" | "order" | "updated" | `d
 type QuerySortField = QuerySortBaseField | `-${QuerySortBaseField}`;
 type QuerySortWithDefault = QuerySortField | `${QuerySortField}|${QuerySortField}`;
 type RecordRootField = "group" | "sn" | "start" | "end" | "order" | "data" | "created" | "updated";
-/** spell-checker:ignore Mddhh, Mddhhmm */
 export interface DsiQueryParam {
     /**
      * 指定获取某个配置，设定 sn 后，所有过滤以及分页参数均失效
@@ -149,13 +148,24 @@ export interface DsiQueryOption<T> {
     query: DsiQueryParam;
     /** 响应数据守卫函数 */
     guard: (data: unknown) => data is T;
+    /** 开启自动缓存配置，开启后将缓存 dsi 数据，并在 dsi 接口错误时以缓存数据作为返回 */
+    cache?: boolean;
 }
 export declare class KMSDsi {
     req: ReturnType<NetRequestFactory>;
-    constructor(endpoint: string, request: NetRequestFactory);
+    private enabledCache;
+    private cachePrefix;
     /**
-     * 查询 Dsi 数据接口并返回接口响应
+     * 设置请求的 endpoint 和请求工具来初始化 KMS Dsi，第三个可选参数 enabledCache 来激活本地缓存数据
+     *
+     * 当启用本地缓存数据时，会将成功返回的数据缓存到本地，并在后续 dsi 接口出现问题时以缓存数据返回
+     *
+     * 本地缓存有效期最长为 24 小时
+     */
+    constructor(endpoint: string, request: NetRequestFactory, enabledCache?: boolean);
+    /**
+     * 查询 Dsi 数据接口并返回接口响应，可设置是否启用本地缓存以应对网络错误的情况
      */
-    query<T = unknown>({ key, query, guard }: DsiQueryOption<T>): Promise<T | null>;
+    query<T = unknown>({ key, query, guard, cache }: DsiQueryOption<T>): Promise<T | null>;
 }
 export {};