@zh-xx/antu 0.10.0 → 0.12.0

package/lib/validate.d.ts

@@ -0,0 +1,38 @@
+// Declarations of `@zh-xx/antu/validate` (tools/api/validate.mjs). The contract is in spec/embed.md;
+// test/embed.test.mjs checks that every function the module exports is declared here and nothing else.
+
+export interface ValidateResult {
+  ok: boolean
+  /** Each names its field, e.g. `nodes[2] (n-3): \`kind\` is "bogus", …` */
+  errors: string[]
+  /** Not errors, but the author should see them; only when there are no errors */
+  notes: string[]
+}
+
+export type LayoutResult =
+  | ({ ok: true; type: string; kind: string; text: string } & Record<string, unknown>)
+  | { ok: false; reason: string; errors?: string[] }
+
+export interface VersionsReport {
+  release: string
+  types: Array<{
+    type: string
+    specVersion: number
+    diagrams: Array<{ kind: string; version: number; status: 'experimental' | 'stable' | 'deprecated'; since: string }>
+  }>
+}
+
+export function validate(spec: unknown): ValidateResult
+export function layout(spec: unknown, options?: { kind?: string; orientation?: 'vertical' | 'horizontal' }): LayoutResult
+export interface NormalizeResult {
+  /** A repaired copy; the input is not modified */
+  spec: unknown
+  /** What was changed, in words an agent can read; empty when nothing was */
+  changes: string[]
+}
+
+/** Repair what is inconsistent in the marks of a spec but not in its content (a procedure's main line). Call it before `validate` */
+export function normalize(spec: unknown): NormalizeResult
+/** Each type and its kinds, the first kind being the one a diagram opens in */
+export function kinds(): Record<string, string[]>
+export function versions(): VersionsReport