@seayoo-web/kms 1.0.1 → 2.0.1

package/README.md

@@ -1,5 +1,7 @@
-# kms agent
+# KMS Agent
 
-! internal experimental project
-
-! 内部工具，勿作他用
+- dsi 查询工具
+  - `queryDsi` 以 ajax 方式查询 dsi 数据
+  - `jsonpDsi` 以 jsonp 方式查询 dsi 数据
+  - `jsonxDsi` 以 script 方式查询 dsi 数据
+  - `convertDsiParam` 工具函数，将 dsi query 参数转成 request param

package/dist/index.js

@@ -0,0 +1,32 @@
+import { NetRequest as L, jsonp as k, jsonx as q } from "@seayoo-web/request";
+const { get: z } = L({ timeout: 15e3 });
+function y(t) {
+  const r = {}, { group: i, filter: a, filterLogic: n, range: l, created: d, updated: m, size: A, page: $, sort: s } = t, { sn: g, fields: o, dataFields: e, multi: h, combo: v, pure: b = "items", label: f, value: c, option: w } = t;
+  if (g && (r.sn = g), i && (r.g = Array.isArray(i) ? i.join(",") : i), a) {
+    const D = n === "or" ? "|" : "+", x = Object.keys(a);
+    r.filter = x.map((p) => {
+      const u = a[p];
+      return Array.isArray(u) ? `${p}:${u.join(",")}` : `${p}:${u}`;
+    }).join(D);
+  }
+  return l && (r.r = l), d && (r.created = d.join("-")), m && (r.updated = m.join("-")), s && (r.sort = Array.isArray(s) ? s.join(",") : s), h === !1 && (r.m = "n"), A && (r.s = `${A}`), $ && (r.p = `${$}`), o && (r.f = Array.isArray(o) ? o.join(",") : o), e && (r.df = Array.isArray(e) ? e.join(",") : e), v === !0 && (o ? r.c = "y" : console.warn("设置 combo:true 必须要同步设置 fields")), b && (r.pure = b === "items" ? "items" : "y"), f && (r.label = Array.isArray(f) ? f.join(",") : f), c && (r.value = Array.isArray(c) ? c.join(",") : c), w && (r.option = w), r;
+}
+async function E({ endpoint: t, key: r, query: i, guard: a }) {
+  const { data: n } = await z(`https://${j(t)}/${r}`, a, { params: y(i) });
+  return n;
+}
+async function F({ endpoint: t, key: r, query: i, guard: a }) {
+  return await k(`https://${j(t)}/${r}/jsonp`, a, y(i));
+}
+async function N({ endpoint: t, key: r, query: i, guard: a }) {
+  return await q(`https://${j(t)}/${r}/script`, a, y(i));
+}
+function j(t) {
+  return t.replace(/(?:^https?:\/\/|\/*$)/gi, "").toLowerCase();
+}
+export {
+  y as convertDsiParam,
+  F as jsonpDsi,
+  N as jsonxDsi,
+  E as queryDsi
+};

package/package.json

@@ -1,23 +1,38 @@
 {
   "name": "@seayoo-web/kms",
-  "version": "1.0.1",
-  "description": "agent for kms",
-  "main": "index.js",
-  "scripts": {
-    "minify": "node minify",
-    "pubup": "node minify && npm publish"
+  "version": "2.0.1",
+  "description": "agent for seayoo.kms",
+  "type": "module",
+  "source": "index.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./types/index.d.ts",
+  "files": [
+    "dist",
+    "types",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
   },
   "author": "web@seayoo.com",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
   },
-  "dependencies": {
-    "needle": "^3.1.0",
-    "colors": "^1.4.0",
-    "open": "^8.4.0"
-  },
   "devDependencies": {
-    "terser": "^5.12.1"
+    "@seayoo-web/request": "^2.0.6",
+    "@seayoo-web/tsconfig": "^1.0.2"
+  },
+  "peerDependencies": {
+    "@seayoo-web/request": "^2.0.6"
+  },
+  "scripts": {
+    "build": "vite build && tsc --emitDeclarationOnly",
+    "prepublish": "pnpm build"
   }
-}
+}

package/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./src/dsi";

package/types/src/dsi.d.ts

@@ -0,0 +1,165 @@
+type BaseFieldType = string | number | null;
+type QuerySortBaseField = "start" | "end" | "created" | "order" | "updated" | `data.${string}`;
+type QuerySortField = QuerySortBaseField | `-${QuerySortBaseField}`;
+type QuerySortWithDefault = QuerySortField | `${QuerySortField}|${QuerySortField}`;
+type RecordRootField = "group" | "sn" | "start" | "end" | "order" | "data" | "created" | "updated";
+export interface DsiQueryParam {
+    /**
+     * 指定获取某个配置，设定 sn 后，所有过滤以及分页参数均失效
+     *
+     * 此时不考虑配置是否过期，一律返回该配置
+     */
+    sn?: string;
+    /**
+     * 指定获取某个或多个分组的数据
+     */
+    group?: string | string[];
+    /**
+     * 过滤 data 字段根节点的数据
+     */
+    filter?: Record<string, BaseFieldType | BaseFieldType[]>;
+    /**
+     * 如果设置了 filter 则限制 filter 条件的逻辑组合关系，默认是 and
+     */
+    filterLogic?: "or" | "and";
+    /**
+     * 可选有效期过滤参数，对配置的有效期进行过滤，可选值有五个：
+     *
+     * - left 过滤所有已经失效的配置
+     * - center 过滤所有生效中的配置（默认值）
+     * - right 过滤所有尚未生效的配置
+     * - forward 过滤所有生效中以及待生效的配置
+     * - all 返回所有配置
+     */
+    range?: "left" | "center" | "right" | "forward" | "all";
+    /**
+     * 表示过滤出 created 为指定时间范围内的记录，时间格式支持:
+     *
+     * yyyy / yyyyMM / yyyyMMdd / yyyyMMddhh / yyyyMMddhhmm / yyyyMMddhhmmss
+     *
+     * - 其中起始时间不足 14 位的情况下，将以 1月1日0点0分0秒进行补足；
+     * - 结束时间不足 14 位的情况下，将以 12月31日23点59分59秒进行补足；
+     * - 起始时间和结束时间可以忽略其中一个(设置为空字符串)，表示开放时间段进行选择；
+     * - 时间格式为双闭区间，即 >= 起始时间 且 <= 结束时间的记录都会被选中；
+     */
+    created?: [string, string];
+    /**
+     * 表示过滤出 updated 为指定时间范围内的记录，时间格式支持:
+     *
+     * yyyy / yyyyMM / yyyyMMdd / yyyyMMddhh / yyyyMMddhhmm / yyyyMMddhhmmss
+     *
+     * - 其中起始时间不足 14 位的情况下，将以 1月1日0点0分0秒进行补足；
+     * - 结束时间不足 14 位的情况下，将以 12月31日23点59分59秒进行补足；
+     * - 起始时间和结束时间可以忽略其中一个(设置为空字符串)，表示开放时间段进行选择；
+     * - 当记录的 updated 属性无值时，以 created 作为默认值；
+     * - 时间格式为双闭区间，即 >= 起始时间 且 <= 结束时间的记录都会被选中；
+     */
+    updated?: [string, string];
+    /**
+     * 用于对集合数据指定排序方法，默认是 sort=order 即按照 order 字段从大到小排序；
+     *
+     * - 如果是从小到大排序，需要在参数值前加一个中划线；
+     * - 字段必须是数字类型，如果类型不符，排序出的结果将可能变得不可靠，并会影响分页的准确性；
+     * - 如果字段为非真值，则转化为数字 0 参与排序；
+     * - sort支持多个字段排序，按照数组顺序从左到右依次排序；
+     * - 其中每个排序字段可以设置多个默认值字段（以竖线分割）
+     */
+    sort?: QuerySortWithDefault | QuerySortWithDefault[];
+    /**
+     * 是否返回所有符合要求的数据记录合集，默认 true
+     */
+    multi?: boolean;
+    /**
+     * 返回单页数据记录的最大数量，默认返回所有符合记录的数据。
+     *
+     * 可设置的最大值 100
+     */
+    size?: number;
+    /**
+     * 返回数据记录指定页数的内容，默认第一页，最大值 10000。
+     *
+     * 如果超过最后一页，则返回最后一页。
+     */
+    page?: number;
+    /**
+     * 过滤数据根节点的字段，默认不过滤
+     */
+    fields?: RecordRootField | RecordRootField[];
+    /**
+     * 过滤 data 字段根节点的字段，区分大小写，默认不过滤
+     */
+    dataFields?: string | string[];
+    /**
+     * 是否将 fields 参数指定的根节点数据全部合并到一起。
+     *
+     * - 其中系统自带的字段优先级高于 data 根节点字段，相同字段内容会被覆盖；
+     * - 为了防止 key 误覆盖，必须显式设置 fields 参数后方才生效；
+     */
+    combo?: boolean;
+    /**
+     * 设置数据整理的方式，当设置为 true 时仅仅对 ajax 模式有效，items 对所有模式有效
+     *
+     * - true 将直接返回数据本身，而不带有 { err, data } 包装结构
+     * - false 默认行为，ajax 返回会带有 { err, data } 包装结构
+     * - "items" 在 pure=true 的基础上进一步精简，删除 pagination 信息，直接返回 items 数组。如果同时设置了 sn 或者 multi=false 则效果等同于 pure=true
+     */
+    pure?: boolean | "items";
+    /**
+     * 设定有效值后，格式化输出数据为 [{ label, value, key }] 形式，方便前端选择组件直接使用。
+     *
+     * - label 值为 data 字段的属性名，区分大小写，支持链式取值，比如 a.b.c；
+     * - value 值为 data 字段的属性名，区分大小写，支持链式取值，默认是该条记录的 sn；
+     * - 返回数据中的 key 固定为记录的 sn；
+     *
+     * - 任何数据错误都不会报错，而是返回空数组 []；
+     * - 设置了 label / value 后，除了 group / sn / filter 参数外，其他用于过滤数据的参数均无效；
+     * - 设置多个字段后，比如 label=["name","desc"] 此时返回的内容，会是 data.name 和 data.desc 拼接成的字符串，并用空格连接；
+     */
+    label?: string | string[];
+    /**
+     * 设定有效值后，格式化输出数据为 [{ label, value, key }] 形式，方便前端选择组件直接使用。
+     *
+     * - label 值为 data 字段的属性名，区分大小写，支持链式取值，比如 a.b.c；
+     * - value 值为 data 字段的属性名，区分大小写，支持链式取值，默认是该条记录的 sn；
+     * - 返回数据中的 key 固定为记录的 sn；
+     *
+     * - 任何数据错误都不会报错，而是返回空数组 []；
+     * - 设置了 label / value 后，除了 group / sn / filter 参数外，其他用于过滤数据的参数均无效；
+     * - 设置多个字段后，比如 value=["id","name"] 此时返回的数据，会多出一个 payload 字段，内容为 { id, name }
+     *    - 此时会强制 value 和 key 均为 该条记录的 sn；
+     *    - 这种特殊结构的选项数据在 KMS 中直接受到支持，并将 payload 作为实际的选项值；
+     *    - 这种方式可以突破 value 不能为 object 复合数据的限制；
+     */
+    value?: string | string[];
+    /**
+     * 设置 option 后，等价于设置 label=option 和 value=option；其优先级低于 label/value
+     */
+    option?: string;
+}
+/**
+ * 将查询配置转成 dsi 查询参数
+ */
+export declare function convertDsiParam(query: DsiQueryParam): Record<string, string>;
+interface DsiQueryOption<T> {
+    /** dsi 服务器地址，比如 xxx.dsi.seayoo.com */
+    endpoint: string;
+    /** dsi key / alias */
+    key: string;
+    /** 查询参数 */
+    query: DsiQueryParam;
+    /** 响应数据守卫函数 */
+    guard: (data: unknown) => data is T;
+}
+/**
+ * 查询 Dsi 数据接口并返回接口响应
+ */
+export declare function queryDsi<T = unknown>({ endpoint, key, query, guard }: DsiQueryOption<T>): Promise<T | null>;
+/**
+ * 通过 jsonp 方式加载 dsi 数据
+ */
+export declare function jsonpDsi<T = unknown>({ endpoint, key, query, guard }: DsiQueryOption<T>): Promise<T | null>;
+/**
+ * 通过 jsonx(script) 方式加载 dsi 数据
+ */
+export declare function jsonxDsi<T = unknown>({ endpoint, key, query, guard }: DsiQueryOption<T>): Promise<T | null>;
+export {};

package/dist/core.js

@@ -1 +0,0 @@
-const pkg=require("../package.json"),needle=require("needle"),path=require("path"),fs=require("fs");async function syncTemplate({user:e,service:t},s){if(!t)return!1;if(!e)throw"插件参数缺失，需要传递 user";if(/^https:\/\/([^.]*.)?kms\.seayoo\.(?:com|io)\/sync\/template\/[^/]+/i.test(t))throw"service 参数格式错误，请检查";const n=path.join(s,"index.html");if(!fs.existsSync(n))throw"index.html 没有找到";const r=fs.readFileSync(n).toString("utf-8");if(!r.includes("<script src=/")&&!r.includes("<link href=/"))throw"SPA 资源引用路径需要是以 / 开头的绝对路径";return new Promise(((s,n)=>{needle.post(t,{content:r},{headers:{"x-kms-user":e,"User-Agent":"kms agent/"+pkg.version}},(function(e){e?n(e):s(!0)}))}))}exports.syncTemplate=syncTemplate,exports.getTemplateListUrl=function(e){const t=e.match(/^(https:\/\/[^\/]+)\/.+\/([^/]+)$/);return t?`${t[1]}/tmpl/edit/${t[2]}`:null};

package/dist/plugin.vite.js

@@ -1 +0,0 @@
-const{syncTemplate:syncTemplate,getTemplateListUrl:getTemplateListUrl}=require("./core"),distCacheKey="_kms_dist",path=require("path");require("colors"),module.exports=function(e){return{name:"kmsAgent",generateBundle({dir:e}){let t=process.cwd();e&&(t=path.resolve(t,e)),this.cache.set("_kms_dist",t)},writeBundle(t,s){this.cache.get("_kms_dist");return syncTemplate({user:e.user,service:e.service}).then((function(e){e&&console.log("[KMS Agent]".bgGreen,"模板同步成功".green,getTemplateListUrl(syncOptions.service))}))}}};

package/dist/plugin.webpack.js

@@ -1 +0,0 @@
-const{syncTemplate:syncTemplate,getTemplateListUrl:getTemplateListUrl}=require("./core"),path=require("path");function syncKMSTemplate({user:e,service:t}){this.syncOptions={user:e,service:t}}function log(...e){setTimeout((()=>{console.log(...e)}))}require("colors"),syncKMSTemplate.prototype.apply=function(e){const t=this.syncOptions;e.hooks.done.tapAsync("kmsAgent",(function({compilation:e},n){const s=e.outputOptions.path;syncTemplate(t,s).then((e=>{e&&log("[KMS Agent]".bgGreen,"模板同步成功".green,getTemplateListUrl(t.service)),n()})).catch((e=>{log("[KMS Agent]".bgBrightRed,e.bgBrightRed),n()}))}))},module.exports=syncKMSTemplate;

package/index.js

@@ -1,9 +0,0 @@
-const WebpackPlugin = require('./dist/plugin.webpack');
-const VitePlugin = require('./dist/plugin.vite');
-
-module.exports = {
-  templateSyncPlugin: {
-    webpack: WebpackPlugin,
-    vite: VitePlugin
-  }
-}