@open-feishu-card/validator 0.1.5 → 0.1.7

package/dist/index.cjs

@@ -26,64 +26,155 @@ function pointerToString(path) {
   return "/" + path.map((s) => String(s).replace(/~/g, "~0").replace(/\//g, "~1")).join("/");
 }
 var DEPRECATED_PROPS = {
-  // 常见 1.0 → 2.0 迁移期废弃写法
-  i18n_elements: "2.0 \u8BF7\u4F7F\u7528 body.elements + config.locale",
-  card_link: "2.0 \u8BF7\u4F7F\u7528 elements \u4E2D\u7684 button/open_url \u884C\u4E3A"
+  i18n_elements: "2.0 \u4E0D\u518D\u652F\u6301\u5168\u5C40 i18n_elements\uFF0C\u8BF7\u4F7F\u7528\u7EC4\u4EF6\u7EA7 i18n \u5B57\u6BB5",
+  i18n_header: "2.0 \u4E0D\u518D\u652F\u6301 i18n_header\uFF0C\u8BF7\u4F7F\u7528 header \u5185\u7684\u5C40\u90E8\u591A\u8BED\u8A00\u5B57\u6BB5"
 };
-function validateAst(result, options = {}) {
-  const diagnostics = [];
-  for (const e of result.errors) {
+var BUILDER_ROOT_KEYS = /* @__PURE__ */ new Set(["name", "dsl", "variables"]);
+function getProp(node, key) {
+  return node.properties.find((p) => p.key.value === key)?.value;
+}
+function validateBuilderEnvelope(resolved, diagnostics) {
+  if (resolved.kind !== "builder") return;
+  const root = resolved.rootAst;
+  for (const prop of root.properties) {
+    const key = prop.key.value;
+    if (!BUILDER_ROOT_KEYS.has(key)) {
+      diagnostics.push({
+        message: `\u642D\u5EFA\u5DE5\u5177\u6587\u6863\u4E0D\u8BA4\u8BC6\u7684\u9876\u5C42\u5B57\u6BB5 "${key}"\uFF08\u4EC5\u652F\u6301 name / dsl / variables\uFF09`,
+        severity: "warning",
+        range: prop.key.range,
+        path: "/" + key,
+        code: "builder-unknown-key"
+      });
+    }
+  }
+  const nameNode = getProp(root, "name");
+  if (nameNode && nameNode.type !== "string") {
     diagnostics.push({
-      message: `JSON \u8BED\u6CD5\u9519\u8BEF: ${e.message}`,
+      message: '\u642D\u5EFA\u5DE5\u5177\u6587\u6863\u7684 "name" \u5E94\u4E3A\u5B57\u7B26\u4E32',
       severity: "error",
-      range: e.range,
-      path: "/"
+      range: nameNode.range,
+      path: "/name",
+      code: "builder-envelope"
     });
   }
-  if (!result.ast || result.data === void 0) return diagnostics;
-  const checkResult = schema.FeishuCardV2Schema.safeParse(result.data);
+  const variablesNode = getProp(root, "variables");
+  if (variablesNode && variablesNode.type !== "array") {
+    diagnostics.push({
+      message: '\u642D\u5EFA\u5DE5\u5177\u6587\u6863\u7684 "variables" \u5E94\u4E3A\u6570\u7EC4',
+      severity: "error",
+      range: variablesNode.range,
+      path: "/variables",
+      code: "builder-envelope"
+    });
+  }
+}
+function validateCardAgainstSchema(cardAst, cardData, pathPrefix, options, diagnostics) {
+  const checkResult = schema.FeishuCardV2Schema.safeParse(cardData);
   if (!checkResult.success) {
     for (const issue of checkResult.error.issues) {
-      const node = findNodeAtPointer(result.ast, issue.path);
-      const range = node ? node.range : { start: result.ast.range.start, end: result.ast.range.start };
+      const node = findNodeAtPointer(cardAst, issue.path);
+      const range = node ? node.range : { start: cardAst.range.start, end: cardAst.range.start };
       diagnostics.push({
         message: issue.message,
         severity: "error",
         range,
-        path: pointerToString(issue.path)
+        path: parser.joinCardPointer(pathPrefix, pointerToString(issue.path))
       });
     }
   }
   const deprecated = { ...DEPRECATED_PROPS, ...options.deprecatedProps ?? {} };
-  for (const prop of result.ast.properties) {
+  for (const prop of cardAst.properties) {
     const hint = deprecated[prop.key.value];
     if (hint) {
       diagnostics.push({
         message: `\u5E9F\u5F03\u5C5E\u6027 "${prop.key.value}": ${hint}`,
         severity: "warning",
         range: prop.key.range,
-        path: "/" + prop.key.value,
+        path: parser.joinCardPointer(pathPrefix, "/" + prop.key.value),
         code: "deprecated-prop"
       });
     }
   }
+}
+function validateAst(result, options = {}) {
+  const diagnostics = [];
+  for (const e of result.errors) {
+    diagnostics.push({
+      message: `JSON \u8BED\u6CD5\u9519\u8BEF: ${e.message}`,
+      severity: "error",
+      range: e.range,
+      path: "/"
+    });
+  }
+  if (!result.ast || result.data === void 0) return diagnostics;
+  const resolved = parser.resolveCardDocument(result);
+  if (!resolved) return diagnostics;
+  validateBuilderEnvelope(resolved, diagnostics);
+  validateCardAgainstSchema(
+    resolved.cardAst,
+    resolved.cardData,
+    resolved.pathPrefix,
+    options,
+    diagnostics
+  );
   return diagnostics;
 }
 function validate(source, options) {
   return validateAst(parser.parse(source), options);
 }
 function validateData(data) {
-  const checkResult = schema.FeishuCardV2Schema.safeParse(data);
-  if (checkResult.success) return [];
-  return checkResult.error.issues.map((issue) => ({
-    message: issue.message,
-    severity: "error",
-    range: {
-      start: { offset: 0, line: 1, column: 1 },
-      end: { offset: 0, line: 1, column: 1 }
-    },
-    path: pointerToString(issue.path)
-  }));
+  const ZERO = {
+    start: { offset: 0, line: 1, column: 1 },
+    end: { offset: 0, line: 1, column: 1 }
+  };
+  const diagnostics = [];
+  if (parser.isBuilderDocument(data)) {
+    const rec = data;
+    for (const key of Object.keys(rec)) {
+      if (!BUILDER_ROOT_KEYS.has(key)) {
+        diagnostics.push({
+          message: `\u642D\u5EFA\u5DE5\u5177\u6587\u6863\u4E0D\u8BA4\u8BC6\u7684\u9876\u5C42\u5B57\u6BB5 "${key}"\uFF08\u4EC5\u652F\u6301 name / dsl / variables\uFF09`,
+          severity: "warning",
+          range: ZERO,
+          path: "/" + key,
+          code: "builder-unknown-key"
+        });
+      }
+    }
+    if ("name" in rec && typeof rec.name !== "string") {
+      diagnostics.push({
+        message: '\u642D\u5EFA\u5DE5\u5177\u6587\u6863\u7684 "name" \u5E94\u4E3A\u5B57\u7B26\u4E32',
+        severity: "error",
+        range: ZERO,
+        path: "/name",
+        code: "builder-envelope"
+      });
+    }
+    if ("variables" in rec && !Array.isArray(rec.variables)) {
+      diagnostics.push({
+        message: '\u642D\u5EFA\u5DE5\u5177\u6587\u6863\u7684 "variables" \u5E94\u4E3A\u6570\u7EC4',
+        severity: "error",
+        range: ZERO,
+        path: "/variables",
+        code: "builder-envelope"
+      });
+    }
+  }
+  const card = parser.unwrapCardData(data);
+  const checkResult = schema.FeishuCardV2Schema.safeParse(card);
+  if (!checkResult.success) {
+    const prefix = parser.isBuilderDocument(data) ? "/dsl" : "";
+    for (const issue of checkResult.error.issues) {
+      diagnostics.push({
+        message: issue.message,
+        severity: "error",
+        range: ZERO,
+        path: parser.joinCardPointer(prefix, pointerToString(issue.path))
+      });
+    }
+  }
+  return diagnostics;
 }
 
 exports.findNodeAtPointer = findNodeAtPointer;

package/dist/index.d.ts

@@ -3,6 +3,9 @@
  *
  * 把 Zod Schema 2.0 的校验结果映射回 parser 产出的 AST 节点，
  * 让每条诊断都精确定位到源码的 Line/Column/Range（字符级）。
+ *
+ * 输入可为裸 Card JSON，或搭建工具文档 `{ name, dsl, variables }`；
+ * Schema 只校验解包后的卡片层。
  */
 import { type JsonNode, type JsonObjectNode, type ParseResult, type Range } from '@open-feishu-card/parser';
 export type DiagnosticSeverity = 'error' | 'warning' | 'information' | 'hint';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAEL,KAAK,QAAQ,EACb,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,KAAK,EACX,MAAM,0BAA0B,CAAC;AAGlC,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,SAAS,GAAG,aAAa,GAAG,MAAM,CAAC;AAE9E,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,KAAK,EAAE,KAAK,CAAC;IACb,sDAAsD;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,uCAAuC;AACvC,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,cAAc,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,QAAQ,GAAG,SAAS,CAgBnG;AAaD,MAAM,WAAW,eAAe;IAC9B,yBAAyB;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1C;AAED,6BAA6B;AAC7B,wBAAgB,WAAW,CACzB,MAAM,EAAE,WAAW,EACnB,OAAO,GAAE,eAAoB,GAC5B,UAAU,EAAE,CA4Cd;AAED,wBAAwB;AACxB,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,UAAU,EAAE,CAEhF;AAED,yCAAyC;AACzC,wBAAgB,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,UAAU,EAAE,CAYxD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EAML,KAAK,QAAQ,EACb,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,KAAK,EAEX,MAAM,0BAA0B,CAAC;AAGlC,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,SAAS,GAAG,aAAa,GAAG,MAAM,CAAC;AAE9E,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,KAAK,EAAE,KAAK,CAAC;IACb,sDAAsD;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,uCAAuC;AACvC,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,cAAc,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,QAAQ,GAAG,SAAS,CAgBnG;AAcD,MAAM,WAAW,eAAe;IAC9B,yBAAyB;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1C;AAsFD,6BAA6B;AAC7B,wBAAgB,WAAW,CACzB,MAAM,EAAE,WAAW,EACnB,OAAO,GAAE,eAAoB,GAC5B,UAAU,EAAE,CAyBd;AAED,wBAAwB;AACxB,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,UAAU,EAAE,CAEhF;AAED,yCAAyC;AACzC,wBAAgB,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,UAAU,EAAE,CAsDxD"}

package/dist/index.js

@@ -1,4 +1,4 @@
-import { parse } from '@open-feishu-card/parser';
+import { resolveCardDocument, parse, isBuilderDocument, unwrapCardData, joinCardPointer } from '@open-feishu-card/parser';
 import { FeishuCardV2Schema } from '@open-feishu-card/schema';
 
 // src/index.ts
@@ -24,64 +24,155 @@ function pointerToString(path) {
   return "/" + path.map((s) => String(s).replace(/~/g, "~0").replace(/\//g, "~1")).join("/");
 }
 var DEPRECATED_PROPS = {
-  // 常见 1.0 → 2.0 迁移期废弃写法
-  i18n_elements: "2.0 \u8BF7\u4F7F\u7528 body.elements + config.locale",
-  card_link: "2.0 \u8BF7\u4F7F\u7528 elements \u4E2D\u7684 button/open_url \u884C\u4E3A"
+  i18n_elements: "2.0 \u4E0D\u518D\u652F\u6301\u5168\u5C40 i18n_elements\uFF0C\u8BF7\u4F7F\u7528\u7EC4\u4EF6\u7EA7 i18n \u5B57\u6BB5",
+  i18n_header: "2.0 \u4E0D\u518D\u652F\u6301 i18n_header\uFF0C\u8BF7\u4F7F\u7528 header \u5185\u7684\u5C40\u90E8\u591A\u8BED\u8A00\u5B57\u6BB5"
 };
-function validateAst(result, options = {}) {
-  const diagnostics = [];
-  for (const e of result.errors) {
+var BUILDER_ROOT_KEYS = /* @__PURE__ */ new Set(["name", "dsl", "variables"]);
+function getProp(node, key) {
+  return node.properties.find((p) => p.key.value === key)?.value;
+}
+function validateBuilderEnvelope(resolved, diagnostics) {
+  if (resolved.kind !== "builder") return;
+  const root = resolved.rootAst;
+  for (const prop of root.properties) {
+    const key = prop.key.value;
+    if (!BUILDER_ROOT_KEYS.has(key)) {
+      diagnostics.push({
+        message: `\u642D\u5EFA\u5DE5\u5177\u6587\u6863\u4E0D\u8BA4\u8BC6\u7684\u9876\u5C42\u5B57\u6BB5 "${key}"\uFF08\u4EC5\u652F\u6301 name / dsl / variables\uFF09`,
+        severity: "warning",
+        range: prop.key.range,
+        path: "/" + key,
+        code: "builder-unknown-key"
+      });
+    }
+  }
+  const nameNode = getProp(root, "name");
+  if (nameNode && nameNode.type !== "string") {
     diagnostics.push({
-      message: `JSON \u8BED\u6CD5\u9519\u8BEF: ${e.message}`,
+      message: '\u642D\u5EFA\u5DE5\u5177\u6587\u6863\u7684 "name" \u5E94\u4E3A\u5B57\u7B26\u4E32',
       severity: "error",
-      range: e.range,
-      path: "/"
+      range: nameNode.range,
+      path: "/name",
+      code: "builder-envelope"
     });
   }
-  if (!result.ast || result.data === void 0) return diagnostics;
-  const checkResult = FeishuCardV2Schema.safeParse(result.data);
+  const variablesNode = getProp(root, "variables");
+  if (variablesNode && variablesNode.type !== "array") {
+    diagnostics.push({
+      message: '\u642D\u5EFA\u5DE5\u5177\u6587\u6863\u7684 "variables" \u5E94\u4E3A\u6570\u7EC4',
+      severity: "error",
+      range: variablesNode.range,
+      path: "/variables",
+      code: "builder-envelope"
+    });
+  }
+}
+function validateCardAgainstSchema(cardAst, cardData, pathPrefix, options, diagnostics) {
+  const checkResult = FeishuCardV2Schema.safeParse(cardData);
   if (!checkResult.success) {
     for (const issue of checkResult.error.issues) {
-      const node = findNodeAtPointer(result.ast, issue.path);
-      const range = node ? node.range : { start: result.ast.range.start, end: result.ast.range.start };
+      const node = findNodeAtPointer(cardAst, issue.path);
+      const range = node ? node.range : { start: cardAst.range.start, end: cardAst.range.start };
       diagnostics.push({
         message: issue.message,
         severity: "error",
         range,
-        path: pointerToString(issue.path)
+        path: joinCardPointer(pathPrefix, pointerToString(issue.path))
       });
     }
   }
   const deprecated = { ...DEPRECATED_PROPS, ...options.deprecatedProps ?? {} };
-  for (const prop of result.ast.properties) {
+  for (const prop of cardAst.properties) {
     const hint = deprecated[prop.key.value];
     if (hint) {
       diagnostics.push({
         message: `\u5E9F\u5F03\u5C5E\u6027 "${prop.key.value}": ${hint}`,
         severity: "warning",
         range: prop.key.range,
-        path: "/" + prop.key.value,
+        path: joinCardPointer(pathPrefix, "/" + prop.key.value),
         code: "deprecated-prop"
       });
     }
   }
+}
+function validateAst(result, options = {}) {
+  const diagnostics = [];
+  for (const e of result.errors) {
+    diagnostics.push({
+      message: `JSON \u8BED\u6CD5\u9519\u8BEF: ${e.message}`,
+      severity: "error",
+      range: e.range,
+      path: "/"
+    });
+  }
+  if (!result.ast || result.data === void 0) return diagnostics;
+  const resolved = resolveCardDocument(result);
+  if (!resolved) return diagnostics;
+  validateBuilderEnvelope(resolved, diagnostics);
+  validateCardAgainstSchema(
+    resolved.cardAst,
+    resolved.cardData,
+    resolved.pathPrefix,
+    options,
+    diagnostics
+  );
   return diagnostics;
 }
 function validate(source, options) {
   return validateAst(parse(source), options);
 }
 function validateData(data) {
-  const checkResult = FeishuCardV2Schema.safeParse(data);
-  if (checkResult.success) return [];
-  return checkResult.error.issues.map((issue) => ({
-    message: issue.message,
-    severity: "error",
-    range: {
-      start: { offset: 0, line: 1, column: 1 },
-      end: { offset: 0, line: 1, column: 1 }
-    },
-    path: pointerToString(issue.path)
-  }));
+  const ZERO = {
+    start: { offset: 0, line: 1, column: 1 },
+    end: { offset: 0, line: 1, column: 1 }
+  };
+  const diagnostics = [];
+  if (isBuilderDocument(data)) {
+    const rec = data;
+    for (const key of Object.keys(rec)) {
+      if (!BUILDER_ROOT_KEYS.has(key)) {
+        diagnostics.push({
+          message: `\u642D\u5EFA\u5DE5\u5177\u6587\u6863\u4E0D\u8BA4\u8BC6\u7684\u9876\u5C42\u5B57\u6BB5 "${key}"\uFF08\u4EC5\u652F\u6301 name / dsl / variables\uFF09`,
+          severity: "warning",
+          range: ZERO,
+          path: "/" + key,
+          code: "builder-unknown-key"
+        });
+      }
+    }
+    if ("name" in rec && typeof rec.name !== "string") {
+      diagnostics.push({
+        message: '\u642D\u5EFA\u5DE5\u5177\u6587\u6863\u7684 "name" \u5E94\u4E3A\u5B57\u7B26\u4E32',
+        severity: "error",
+        range: ZERO,
+        path: "/name",
+        code: "builder-envelope"
+      });
+    }
+    if ("variables" in rec && !Array.isArray(rec.variables)) {
+      diagnostics.push({
+        message: '\u642D\u5EFA\u5DE5\u5177\u6587\u6863\u7684 "variables" \u5E94\u4E3A\u6570\u7EC4',
+        severity: "error",
+        range: ZERO,
+        path: "/variables",
+        code: "builder-envelope"
+      });
+    }
+  }
+  const card = unwrapCardData(data);
+  const checkResult = FeishuCardV2Schema.safeParse(card);
+  if (!checkResult.success) {
+    const prefix = isBuilderDocument(data) ? "/dsl" : "";
+    for (const issue of checkResult.error.issues) {
+      diagnostics.push({
+        message: issue.message,
+        severity: "error",
+        range: ZERO,
+        path: joinCardPointer(prefix, pointerToString(issue.path))
+      });
+    }
+  }
+  return diagnostics;
 }
 
 export { findNodeAtPointer, validate, validateAst, validateData };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-feishu-card/validator",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "对比 AST 与 Schema 2.0，输出精确定位到源码字符级的诊断信息",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -17,8 +17,8 @@
     "dist"
   ],
   "dependencies": {
-    "@open-feishu-card/parser": "0.1.2",
-    "@open-feishu-card/schema": "0.1.5"
+    "@open-feishu-card/parser": "0.1.3",
+    "@open-feishu-card/schema": "0.1.6"
   },
   "devDependencies": {
     "tsup": "^8.3.5",