@formspec/build 0.1.0-alpha.14 → 0.1.0-alpha.16

package/dist/analyzer/tsdoc-parser.d.ts

@@ -10,14 +10,13 @@
  * 1. **Constraint tags** (all alphanumeric, TSDoc-compliant):
  *    `@minimum`, `@maximum`, `@exclusiveMinimum`, `@exclusiveMaximum`,
  *    `@multipleOf`, `@minLength`, `@maxLength`, `@minItems`, `@maxItems`,
- *    `@pattern`, `@enumOptions`
+ *    `@uniqueItems`, `@pattern`, `@enumOptions`, `@const`
  *    — Parsed via TSDocParser as custom block tags.
  *    Both camelCase and PascalCase forms are accepted (e.g., `@Minimum`).
  *
- * 2. **Annotation tags** (`@Field_displayName`, `@Field_description`):
- *    These contain underscores which are not valid in TSDoc tag names.
- *    They are extracted via the TypeScript compiler's `ts.getJSDocTags()`
- *    until a future migration to underscore-free tag names.
+ * 2. **Annotation tags** (`@displayName`, `@description`, `@format`, `@placeholder`):
+ *    These are parsed as structured custom block tags and mapped directly
+ *    onto annotation IR nodes.
  *
  * The `@deprecated` tag is a standard TSDoc block tag, parsed structurally.
  *
@@ -36,18 +35,28 @@ import { type ConstraintNode, type AnnotationNode, type PathTarget } from "@form
 export interface TSDocParseResult {
     /** Constraint IR nodes extracted from custom block tags. */
     readonly constraints: readonly ConstraintNode[];
-    /** Annotation IR nodes extracted from modifier/block tags and TS JSDoc API. */
+    /** Annotation IR nodes extracted from canonical TSDoc block tags. */
     readonly annotations: readonly AnnotationNode[];
 }
+/**
+ * Display-name metadata extracted from a node's JSDoc tags.
+ *
+ * The root display name is returned separately from member-target labels so
+ * callers can apply the former to the enclosing type/form and the latter to
+ * enum members.
+ */
+export interface DisplayNameMetadata {
+    readonly displayName?: string;
+    readonly memberDisplayNames: ReadonlyMap<string, string>;
+}
 /**
  * Parses the JSDoc comment attached to a TypeScript AST node using the
  * official TSDoc parser and returns canonical IR constraint and annotation
  * nodes.
  *
  * For constraint tags (`@minimum`, `@pattern`, `@enumOptions`, etc.),
- * the structured TSDoc parser is used. For annotation tags that contain
- * underscores (`@Field_displayName`, `@Field_description`), the TypeScript
- * compiler JSDoc API is used as a fallback.
+ * the structured TSDoc parser is used. Canonical annotation tags
+ * (`@displayName`, `@description`) are also parsed structurally.
  *
  * @param node - The TS AST node to inspect (PropertyDeclaration, PropertySignature, etc.)
  * @param file - Absolute source file path for provenance
@@ -60,6 +69,13 @@ export declare function parseTSDocTags(node: ts.Node, file?: string): TSDocParse
  * Falls back to the TS compiler API for nodes without doc comments.
  */
 export declare function hasDeprecatedTagTSDoc(node: ts.Node): boolean;
+/**
+ * Extracts root and member-target display-name metadata from a node's JSDoc tags.
+ *
+ * Member-target display-name tags use the syntax `@displayName :member Label`.
+ * The first non-target `@displayName` is returned as the root display name.
+ */
+export declare function extractDisplayNameMetadata(node: ts.Node): DisplayNameMetadata;
 /**
  * Extracts a path-target prefix (`:fieldName`) from constraint tag text.
  * Returns the parsed PathTarget and remaining text, or null if no path target.

package/dist/analyzer/tsdoc-parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tsdoc-parser.d.ts","sourceRoot":"","sources":["../../src/analyzer/tsdoc-parser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAYjC,OAAO,EAIL,KAAK,cAAc,EACnB,KAAK,cAAc,EAInB,KAAK,UAAU,EAChB,MAAM,gBAAgB,CAAC;AA6ExB;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,4DAA4D;IAC5D,QAAQ,CAAC,WAAW,EAAE,SAAS,cAAc,EAAE,CAAC;IAChD,+EAA+E;IAC/E,QAAQ,CAAC,WAAW,EAAE,SAAS,cAAc,EAAE,CAAC;CACjD;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,SAAK,GAAG,gBAAgB,CAuHzE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,OAAO,CAsB5D;AAMD;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,MAAM,GACX;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAQpD"}
+{"version":3,"file":"tsdoc-parser.d.ts","sourceRoot":"","sources":["../../src/analyzer/tsdoc-parser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAYjC,OAAO,EAIL,KAAK,cAAc,EACnB,KAAK,cAAc,EAInB,KAAK,UAAU,EAEhB,MAAM,gBAAgB,CAAC;AAyFxB;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,4DAA4D;IAC5D,QAAQ,CAAC,WAAW,EAAE,SAAS,cAAc,EAAE,CAAC;IAChD,qEAAqE;IACrE,QAAQ,CAAC,WAAW,EAAE,SAAS,cAAc,EAAE,CAAC;CACjD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,kBAAkB,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,SAAK,GAAG,gBAAgB,CAiKzE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,OAAO,CAsB5D;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,mBAAmB,CA2B7E;AAMD;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,MAAM,GACX;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAQpD"}