@formspec/core 0.1.0-alpha.23 → 0.1.0-alpha.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -32,10 +32,15 @@ export declare type AnyField = TextField<string> | NumberField<string> | Boolean
32
32
  * @beta
33
33
  */
34
34
  export declare interface ArrayCardinalityConstraintNode {
35
+ /** Discriminator identifying this node as a constraint. */
35
36
  readonly kind: "constraint";
37
+ /** Specific array-cardinality constraint represented by this node. */
36
38
  readonly constraintKind: "uniqueItems";
39
+ /** Marker value used for boolean-style array uniqueness constraints. */
37
40
  readonly value: true;
41
+ /** Nested path target, when the constraint applies below the field root. */
38
42
  readonly path?: PathTarget;
43
+ /** Source location that produced this constraint. */
39
44
  readonly provenance: Provenance;
40
45
  }
41
46
 
@@ -74,7 +79,9 @@ export declare interface ArrayField<N extends string, Items extends readonly For
74
79
  * @beta
75
80
  */
76
81
  export declare interface ArrayTypeNode {
82
+ /** Discriminator identifying this node as an array type. */
77
83
  readonly kind: "array";
84
+ /** Item type for each array entry. */
78
85
  readonly items: TypeNode;
79
86
  }
80
87
 
@@ -146,6 +153,7 @@ export declare interface Conditional<FieldName extends string, Value, Elements e
146
153
  * @beta
147
154
  */
148
155
  export declare interface ConditionalLayoutNode {
156
+ /** Discriminator identifying this node as a conditional layout. */
149
157
  readonly kind: "conditional";
150
158
  /** The field whose value triggers visibility. */
151
159
  readonly fieldName: string;
@@ -153,6 +161,7 @@ export declare interface ConditionalLayoutNode {
153
161
  readonly value: JsonValue;
154
162
  /** Elements shown when the condition is met. */
155
163
  readonly elements: readonly FormIRElement[];
164
+ /** Source location that produced this layout node. */
156
165
  readonly provenance: Provenance;
157
166
  }
158
167
 
@@ -162,10 +171,15 @@ export declare interface ConditionalLayoutNode {
162
171
  * @beta
163
172
  */
164
173
  export declare interface ConstConstraintNode {
174
+ /** Discriminator identifying this node as a constraint. */
165
175
  readonly kind: "constraint";
176
+ /** Specific literal-equality constraint represented by this node. */
166
177
  readonly constraintKind: "const";
178
+ /** JSON-serializable literal value the field must equal. */
167
179
  readonly value: JsonValue;
180
+ /** Nested path target, when the constraint applies below the field root. */
168
181
  readonly path?: PathTarget;
182
+ /** Source location that produced this constraint. */
169
183
  readonly provenance: Provenance;
170
184
  }
171
185
 
@@ -232,11 +246,15 @@ export declare function createInitialFieldState<T>(value: T): FieldState<T>;
232
246
  * @beta
233
247
  */
234
248
  export declare interface CustomAnnotationNode {
249
+ /** Discriminator identifying this node as an annotation. */
235
250
  readonly kind: "annotation";
251
+ /** Specific annotation kind represented by this node. */
236
252
  readonly annotationKind: "custom";
237
253
  /** Extension-qualified ID: `"<vendor-prefix>/<extension-name>/<annotation-name>"` */
238
254
  readonly annotationId: string;
255
+ /** JSON-serializable extension payload carried by this annotation. */
239
256
  readonly value: JsonValue;
257
+ /** Source location that produced this annotation. */
240
258
  readonly provenance: Provenance;
241
259
  }
242
260
 
@@ -264,7 +282,9 @@ export declare interface CustomAnnotationRegistration {
264
282
  * @beta
265
283
  */
266
284
  export declare interface CustomConstraintNode {
285
+ /** Discriminator identifying this node as a constraint. */
267
286
  readonly kind: "constraint";
287
+ /** Specific custom-constraint marker used for extension nodes. */
268
288
  readonly constraintKind: "custom";
269
289
  /** Extension-qualified ID: `"<vendor-prefix>/<extension-name>/<constraint-name>"` */
270
290
  readonly constraintId: string;
@@ -272,7 +292,9 @@ export declare interface CustomConstraintNode {
272
292
  readonly payload: JsonValue;
273
293
  /** How this constraint composes with others of the same `constraintId`. */
274
294
  readonly compositionRule: "intersect" | "override";
295
+ /** Nested path target, when the constraint applies below the field root. */
275
296
  readonly path?: PathTarget;
297
+ /** Source location that produced this constraint. */
276
298
  readonly provenance: Provenance;
277
299
  }
278
300
 
@@ -329,6 +351,7 @@ export declare interface CustomConstraintRegistration {
329
351
  * @beta
330
352
  */
331
353
  export declare interface CustomTypeNode {
354
+ /** Discriminator identifying this node as an extension-provided type. */
332
355
  readonly kind: "custom";
333
356
  /**
334
357
  * The extension-qualified type identifier.
@@ -428,10 +451,13 @@ export declare type DataSourceValueType<Source extends string> = Source extends
428
451
  * @beta
429
452
  */
430
453
  export declare interface DefaultValueAnnotationNode {
454
+ /** Discriminator identifying this node as an annotation. */
431
455
  readonly kind: "annotation";
456
+ /** Specific annotation kind represented by this node. */
432
457
  readonly annotationKind: "defaultValue";
433
458
  /** Must be JSON-serializable and type-compatible (verified during Validate phase). */
434
459
  readonly value: JsonValue;
460
+ /** Source location that produced this annotation. */
435
461
  readonly provenance: Provenance;
436
462
  }
437
463
 
@@ -495,10 +521,13 @@ export declare function defineExtension(def: ExtensionDefinition): ExtensionDefi
495
521
  * @beta
496
522
  */
497
523
  export declare interface DeprecatedAnnotationNode {
524
+ /** Discriminator identifying this node as an annotation. */
498
525
  readonly kind: "annotation";
526
+ /** Specific annotation kind represented by this node. */
499
527
  readonly annotationKind: "deprecated";
500
528
  /** Optional deprecation message. */
501
529
  readonly message?: string;
530
+ /** Source location that produced this annotation. */
502
531
  readonly provenance: Provenance;
503
532
  }
504
533
 
@@ -508,9 +537,13 @@ export declare interface DeprecatedAnnotationNode {
508
537
  * @beta
509
538
  */
510
539
  export declare interface DescriptionAnnotationNode {
540
+ /** Discriminator identifying this node as an annotation. */
511
541
  readonly kind: "annotation";
542
+ /** Specific annotation kind represented by this node. */
512
543
  readonly annotationKind: "description";
544
+ /** Description text surfaced in generated schemas and tooling. */
513
545
  readonly value: string;
546
+ /** Source location that produced this annotation. */
514
547
  readonly provenance: Provenance;
515
548
  }
516
549
 
@@ -520,9 +553,13 @@ export declare interface DescriptionAnnotationNode {
520
553
  * @beta
521
554
  */
522
555
  export declare interface DisplayNameAnnotationNode {
556
+ /** Discriminator identifying this node as an annotation. */
523
557
  readonly kind: "annotation";
558
+ /** Specific annotation kind represented by this node. */
524
559
  readonly annotationKind: "displayName";
560
+ /** Human-readable display label for the field or type. */
525
561
  readonly value: string;
562
+ /** Source location that produced this annotation. */
526
563
  readonly provenance: Provenance;
527
564
  }
528
565
 
@@ -581,7 +618,9 @@ export declare interface DynamicSchemaField<N extends string> {
581
618
  * @beta
582
619
  */
583
620
  export declare interface DynamicTypeNode {
621
+ /** Discriminator identifying this node as a runtime-resolved type. */
584
622
  readonly kind: "dynamic";
623
+ /** Dynamic schema family resolved for this field. */
585
624
  readonly dynamicKind: "enum" | "schema";
586
625
  /** Key identifying the runtime data source or schema provider. */
587
626
  readonly sourceKey: string;
@@ -610,10 +649,15 @@ export declare interface EnumMember {
610
649
  * @beta
611
650
  */
612
651
  export declare interface EnumMemberConstraintNode {
652
+ /** Discriminator identifying this node as a constraint. */
613
653
  readonly kind: "constraint";
654
+ /** Specific enum-membership constraint represented by this node. */
614
655
  readonly constraintKind: "allowedMembers";
656
+ /** Subset of enum member values that remain valid. */
615
657
  readonly members: readonly (string | number)[];
658
+ /** Nested path target, when the constraint applies below the field root. */
616
659
  readonly path?: PathTarget;
660
+ /** Source location that produced this constraint. */
617
661
  readonly provenance: Provenance;
618
662
  }
619
663
 
@@ -625,7 +669,9 @@ export declare interface EnumMemberConstraintNode {
625
669
  * @public
626
670
  */
627
671
  export declare interface EnumOption {
672
+ /** Stored enum value written into submitted data. */
628
673
  readonly id: string;
674
+ /** Human-readable label shown to end users. */
629
675
  readonly label: string;
630
676
  }
631
677
 
@@ -642,7 +688,9 @@ export declare type EnumOptionValue = string | EnumOption;
642
688
  * @beta
643
689
  */
644
690
  export declare interface EnumTypeNode {
691
+ /** Discriminator identifying this node as an enum type. */
645
692
  readonly kind: "enum";
693
+ /** Allowed enum members in declaration order. */
646
694
  readonly members: readonly EnumMember[];
647
695
  }
648
696
 
@@ -762,6 +810,7 @@ export declare interface FetchOptionsResponse<T = unknown> {
762
810
  * @beta
763
811
  */
764
812
  export declare interface FieldNode {
813
+ /** Discriminator identifying this node as a field. */
765
814
  readonly kind: "field";
766
815
  /** The field's key in the data schema. */
767
816
  readonly name: string;
@@ -811,9 +860,13 @@ export declare interface FieldState<T> {
811
860
  * @beta
812
861
  */
813
862
  export declare interface FormatAnnotationNode {
863
+ /** Discriminator identifying this node as an annotation. */
814
864
  readonly kind: "annotation";
865
+ /** Specific annotation kind represented by this node. */
815
866
  readonly annotationKind: "format";
867
+ /** Schema format keyword value to emit downstream. */
816
868
  readonly value: string;
869
+ /** Source location that produced this annotation. */
817
870
  readonly provenance: Provenance;
818
871
  }
819
872
 
@@ -824,10 +877,13 @@ export declare interface FormatAnnotationNode {
824
877
  * @beta
825
878
  */
826
879
  export declare interface FormatHintAnnotationNode {
880
+ /** Discriminator identifying this node as an annotation. */
827
881
  readonly kind: "annotation";
882
+ /** Specific annotation kind represented by this node. */
828
883
  readonly annotationKind: "formatHint";
829
884
  /** Renderer-specific format identifier: "textarea", "radio", "date", "color", etc. */
830
885
  readonly format: string;
886
+ /** Source location that produced this annotation. */
831
887
  readonly provenance: Provenance;
832
888
  }
833
889
 
@@ -849,6 +905,7 @@ export declare type FormElement = AnyField | Group<readonly FormElement[]> | Con
849
905
  * @beta
850
906
  */
851
907
  export declare interface FormIR {
908
+ /** Discriminator identifying this document as a top-level FormIR payload. */
852
909
  readonly kind: "form-ir";
853
910
  /**
854
911
  * Schema version for the IR format itself.
@@ -933,10 +990,13 @@ export declare interface Group<Elements extends readonly FormElement[]> {
933
990
  * @beta
934
991
  */
935
992
  export declare interface GroupLayoutNode {
993
+ /** Discriminator identifying this node as a group layout. */
936
994
  readonly kind: "group";
995
+ /** Display label associated with the visual group. */
937
996
  readonly label: string;
938
997
  /** Elements contained in this group — may be fields or nested groups. */
939
998
  readonly elements: readonly FormIRElement[];
999
+ /** Source location that produced this layout node. */
940
1000
  readonly provenance: Provenance;
941
1001
  }
942
1002
 
@@ -1054,10 +1114,15 @@ export declare type LayoutNode = GroupLayoutNode | ConditionalLayoutNode;
1054
1114
  * @beta
1055
1115
  */
1056
1116
  export declare interface LengthConstraintNode {
1117
+ /** Discriminator identifying this node as a constraint. */
1057
1118
  readonly kind: "constraint";
1119
+ /** Specific length or cardinality constraint represented by this node. */
1058
1120
  readonly constraintKind: "minLength" | "maxLength" | "minItems" | "maxItems";
1121
+ /** Inclusive bound value carried by the constraint. */
1059
1122
  readonly value: number;
1123
+ /** Nested path target, when the constraint applies below the field root. */
1060
1124
  readonly path?: PathTarget;
1125
+ /** Source location that produced this constraint. */
1061
1126
  readonly provenance: Provenance;
1062
1127
  }
1063
1128
 
@@ -1100,11 +1165,15 @@ export declare interface NumberField<N extends string> {
1100
1165
  * @beta
1101
1166
  */
1102
1167
  export declare interface NumericConstraintNode {
1168
+ /** Discriminator identifying this node as a constraint. */
1103
1169
  readonly kind: "constraint";
1170
+ /** Specific numeric constraint represented by this node. */
1104
1171
  readonly constraintKind: "minimum" | "maximum" | "exclusiveMinimum" | "exclusiveMaximum" | "multipleOf";
1172
+ /** Numeric value carried by the constraint. */
1105
1173
  readonly value: number;
1106
1174
  /** If present, targets a nested sub-field rather than the field itself. */
1107
1175
  readonly path?: PathTarget;
1176
+ /** Source location that produced this constraint. */
1108
1177
  readonly provenance: Provenance;
1109
1178
  }
1110
1179
 
@@ -1139,8 +1208,11 @@ export declare interface ObjectField<N extends string, Properties extends readon
1139
1208
  * @beta
1140
1209
  */
1141
1210
  export declare interface ObjectProperty {
1211
+ /** Property name as it appears in the containing object type. */
1142
1212
  readonly name: string;
1213
+ /** Canonical IR type for this property. */
1143
1214
  readonly type: TypeNode;
1215
+ /** Whether the property may be omitted from object values. */
1144
1216
  readonly optional: boolean;
1145
1217
  /**
1146
1218
  * Use-site constraints on this property.
@@ -1151,6 +1223,7 @@ export declare interface ObjectProperty {
1151
1223
  readonly constraints: readonly ConstraintNode[];
1152
1224
  /** Use-site annotations on this property. */
1153
1225
  readonly annotations: readonly AnnotationNode[];
1226
+ /** Source location that produced this property entry. */
1154
1227
  readonly provenance: Provenance;
1155
1228
  }
1156
1229
 
@@ -1160,6 +1233,7 @@ export declare interface ObjectProperty {
1160
1233
  * @beta
1161
1234
  */
1162
1235
  export declare interface ObjectTypeNode {
1236
+ /** Discriminator identifying this node as an object type. */
1163
1237
  readonly kind: "object";
1164
1238
  /**
1165
1239
  * Named properties of this object. Order is preserved from the source
@@ -1200,11 +1274,15 @@ export declare interface PathTarget {
1200
1274
  * @beta
1201
1275
  */
1202
1276
  export declare interface PatternConstraintNode {
1277
+ /** Discriminator identifying this node as a constraint. */
1203
1278
  readonly kind: "constraint";
1279
+ /** Specific pattern constraint represented by this node. */
1204
1280
  readonly constraintKind: "pattern";
1205
1281
  /** ECMA-262 regular expression, without delimiters. */
1206
1282
  readonly pattern: string;
1283
+ /** Nested path target, when the constraint applies below the field root. */
1207
1284
  readonly path?: PathTarget;
1285
+ /** Source location that produced this constraint. */
1208
1286
  readonly provenance: Provenance;
1209
1287
  }
1210
1288
 
@@ -1214,9 +1292,13 @@ export declare interface PatternConstraintNode {
1214
1292
  * @beta
1215
1293
  */
1216
1294
  export declare interface PlaceholderAnnotationNode {
1295
+ /** Discriminator identifying this node as an annotation. */
1217
1296
  readonly kind: "annotation";
1297
+ /** Specific annotation kind represented by this node. */
1218
1298
  readonly annotationKind: "placeholder";
1299
+ /** Placeholder text intended for UI renderers. */
1219
1300
  readonly value: string;
1301
+ /** Source location that produced this annotation. */
1220
1302
  readonly provenance: Provenance;
1221
1303
  }
1222
1304
 
@@ -1241,7 +1323,9 @@ export declare type Predicate<K extends string = string, V = unknown> = EqualsPr
1241
1323
  * @beta
1242
1324
  */
1243
1325
  export declare interface PrimitiveTypeNode {
1326
+ /** Discriminator identifying this node as a primitive type. */
1244
1327
  readonly kind: "primitive";
1328
+ /** Primitive value family represented by this node. */
1245
1329
  readonly primitiveKind: "string" | "number" | "integer" | "bigint" | "boolean" | "null";
1246
1330
  }
1247
1331
 
@@ -1279,6 +1363,7 @@ export declare interface Provenance {
1279
1363
  * @beta
1280
1364
  */
1281
1365
  export declare interface RecordTypeNode {
1366
+ /** Discriminator identifying this node as a record type. */
1282
1367
  readonly kind: "record";
1283
1368
  /** The type of each value in the dictionary. */
1284
1369
  readonly valueType: TypeNode;
@@ -1290,6 +1375,7 @@ export declare interface RecordTypeNode {
1290
1375
  * @beta
1291
1376
  */
1292
1377
  export declare interface ReferenceTypeNode {
1378
+ /** Discriminator identifying this node as a named reference type. */
1293
1379
  readonly kind: "reference";
1294
1380
  /**
1295
1381
  * The fully-qualified name of the referenced type.
@@ -1315,9 +1401,13 @@ export declare interface ReferenceTypeNode {
1315
1401
  * @beta
1316
1402
  */
1317
1403
  export declare interface RemarksAnnotationNode {
1404
+ /** Discriminator identifying this node as an annotation. */
1318
1405
  readonly kind: "annotation";
1406
+ /** Specific annotation kind represented by this node. */
1319
1407
  readonly annotationKind: "remarks";
1408
+ /** Long-form remarks content carried through canonicalization. */
1320
1409
  readonly value: string;
1410
+ /** Source location that produced this annotation. */
1321
1411
  readonly provenance: Provenance;
1322
1412
  }
1323
1413
 
@@ -1411,7 +1501,9 @@ export declare type TypeNode = PrimitiveTypeNode | EnumTypeNode | ArrayTypeNode
1411
1501
  * @beta
1412
1502
  */
1413
1503
  export declare interface UnionTypeNode {
1504
+ /** Discriminator identifying this node as a union type. */
1414
1505
  readonly kind: "union";
1506
+ /** Member types that participate in the union. */
1415
1507
  readonly members: readonly TypeNode[];
1416
1508
  }
1417
1509
 
package/dist/core.d.ts CHANGED
@@ -444,7 +444,9 @@ export declare interface DynamicSchemaField<N extends string> {
444
444
  * @public
445
445
  */
446
446
  export declare interface EnumOption {
447
+ /** Stored enum value written into submitted data. */
447
448
  readonly id: string;
449
+ /** Human-readable label shown to end users. */
448
450
  readonly label: string;
449
451
  }
450
452
 
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts","../src/types/field-state.ts","../src/types/ir.ts","../src/extensions/index.ts","../src/guards.ts"],"sourcesContent":["/**\n * `@formspec/core` - Core type definitions for FormSpec\n *\n * This package provides the foundational types used throughout the FormSpec ecosystem:\n * - Form element types (fields, groups, conditionals)\n * - Field and form state types\n * - Data source registry for dynamic enums\n * - Canonical IR types (FormIR, FieldNode, TypeNode, ConstraintNode, AnnotationNode, etc.)\n *\n * @packageDocumentation\n */\n\n// Re-export all types\nexport type {\n // Validity\n Validity,\n\n // Field state\n FieldState,\n\n // Form state\n FormState,\n\n // Data sources\n DataSourceRegistry,\n DataSourceOption,\n FetchOptionsResponse,\n DataSourceValueType,\n\n // Elements\n TextField,\n NumberField,\n BooleanField,\n EnumOption,\n EnumOptionValue,\n StaticEnumField,\n DynamicEnumField,\n DynamicSchemaField,\n ArrayField,\n ObjectField,\n AnyField,\n Group,\n Conditional,\n FormElement,\n FormSpec,\n\n // Predicates\n EqualsPredicate,\n Predicate,\n\n // Built-in constraints\n BuiltinConstraintName,\n\n // Canonical IR\n JsonValue,\n Provenance,\n PathTarget,\n TypeNode,\n PrimitiveTypeNode,\n EnumMember,\n EnumTypeNode,\n ArrayTypeNode,\n ObjectProperty,\n ObjectTypeNode,\n RecordTypeNode,\n UnionTypeNode,\n ReferenceTypeNode,\n DynamicTypeNode,\n CustomTypeNode,\n ConstraintNode,\n NumericConstraintNode,\n LengthConstraintNode,\n PatternConstraintNode,\n ArrayCardinalityConstraintNode,\n EnumMemberConstraintNode,\n ConstConstraintNode,\n CustomConstraintNode,\n AnnotationNode,\n DisplayNameAnnotationNode,\n DescriptionAnnotationNode,\n RemarksAnnotationNode,\n FormatAnnotationNode,\n PlaceholderAnnotationNode,\n DefaultValueAnnotationNode,\n DeprecatedAnnotationNode,\n FormatHintAnnotationNode,\n CustomAnnotationNode,\n FieldNode,\n LayoutNode,\n GroupLayoutNode,\n ConditionalLayoutNode,\n FormIRElement,\n TypeDefinition,\n FormIR,\n} from \"./types/index.js\";\n\n// Re-export functions and constants\nexport { createInitialFieldState, IR_VERSION } from \"./types/index.js\";\n\n// Extension API\nexport type {\n ExtensionPayloadValue,\n ExtensionTypeKind,\n ExtensionApplicableType,\n ExtensionDefinition,\n CustomTypeRegistration,\n CustomConstraintRegistration,\n ConstraintTagRegistration,\n BuiltinConstraintBroadeningRegistration,\n ConstraintSemanticRole,\n CustomAnnotationRegistration,\n VocabularyKeywordRegistration,\n} from \"./extensions/index.js\";\n\nexport {\n defineExtension,\n defineCustomType,\n defineConstraint,\n defineConstraintTag,\n defineAnnotation,\n} from \"./extensions/index.js\";\n\n// Re-export type guards\nexport {\n isField,\n isTextField,\n isNumberField,\n isBooleanField,\n isStaticEnumField,\n isDynamicEnumField,\n isDynamicSchemaField,\n isArrayField,\n isObjectField,\n isGroup,\n isConditional,\n} from \"./guards.js\";\n","import type { Validity } from \"./validity.js\";\n\n/**\n * Represents the runtime state of a single form field.\n *\n * @typeParam T - The value type of the field\n *\n * @public\n */\nexport interface FieldState<T> {\n /** Current value of the field */\n readonly value: T;\n\n /** Whether the field has been modified by the user */\n readonly dirty: boolean;\n\n /** Whether the field has been focused and blurred */\n readonly touched: boolean;\n\n /** Current validity state */\n readonly validity: Validity;\n\n /** Validation error messages, if any */\n readonly errors: readonly string[];\n}\n\n/**\n * Creates initial field state with default values.\n *\n * @typeParam T - The value type of the field\n * @param value - The initial value for the field\n * @returns Initial field state\n *\n * @public\n */\nexport function createInitialFieldState<T>(value: T): FieldState<T> {\n return {\n value,\n dirty: false,\n touched: false,\n validity: \"unknown\",\n errors: [],\n };\n}\n","/**\n * Canonical Intermediate Representation (IR) types for FormSpec.\n *\n * The IR is the shared intermediate structure that both authoring surfaces\n * (chain DSL and TSDoc-annotated types) compile to. All downstream operations\n * — JSON Schema generation, UI Schema generation, constraint validation,\n * diagnostics — consume the IR exclusively.\n *\n * All types are plain, serializable objects (no live compiler references).\n *\n * @see {@link https://github.com/stripe/formspec-workspace/blob/main/scratch/design/001-canonical-ir.md}\n */\n\n// =============================================================================\n// IR VERSION\n// =============================================================================\n\n/**\n * The current IR format version. Centralized here so all canonicalizers\n * and consumers reference a single source of truth.\n *\n * @beta\n */\nexport const IR_VERSION = \"0.1.0\" as const;\n\n// =============================================================================\n// UTILITY TYPES\n// =============================================================================\n\n/**\n * A JSON-serializable value. All IR nodes must be representable as JSON.\n *\n * @beta\n */\nexport type JsonValue =\n | null\n | boolean\n | number\n | string\n | readonly JsonValue[]\n | { readonly [key: string]: JsonValue };\n\n// =============================================================================\n// PROVENANCE\n// =============================================================================\n\n/**\n * Describes the origin of an IR node.\n * Enables diagnostics that point to the source of a contradiction or error.\n *\n * @beta\n */\nexport interface Provenance {\n /** The authoring surface that produced this node. */\n readonly surface: \"tsdoc\" | \"chain-dsl\" | \"extension\" | \"inferred\";\n /** Absolute path to the source file. */\n readonly file: string;\n /** 1-based line number in the source file. */\n readonly line: number;\n /** 0-based column number in the source file. */\n readonly column: number;\n /** Length of the source span in characters (for IDE underline ranges). */\n readonly length?: number;\n /**\n * The specific tag, call, or construct that produced this node.\n * Examples: `@minimum`, `field.number({ min: 0 })`, `optional`\n */\n readonly tagName?: string;\n}\n\n// =============================================================================\n// PATH TARGET\n// =============================================================================\n\n/**\n * A path targeting a sub-field within a complex type.\n * Used by constraints and annotations to target nested properties.\n *\n * @beta\n */\nexport interface PathTarget {\n /**\n * Sequence of property names forming a path from the annotated field's type\n * to the target sub-field.\n * e.g., `[\"value\"]` or `[\"address\", \"zip\"]`\n */\n readonly segments: readonly string[];\n}\n\n// =============================================================================\n// TYPE NODES\n// =============================================================================\n\n/**\n * Discriminated union of all type representations in the IR.\n *\n * @beta\n */\nexport type TypeNode =\n | PrimitiveTypeNode\n | EnumTypeNode\n | ArrayTypeNode\n | ObjectTypeNode\n | RecordTypeNode\n | UnionTypeNode\n | ReferenceTypeNode\n | DynamicTypeNode\n | CustomTypeNode;\n\n/**\n * Primitive types mapping directly to JSON Schema primitives.\n *\n * Note: integer is NOT a primitive kind — integer semantics are expressed\n * via a `multipleOf: 1` constraint on a number type.\n *\n * @beta\n */\nexport interface PrimitiveTypeNode {\n readonly kind: \"primitive\";\n readonly primitiveKind: \"string\" | \"number\" | \"integer\" | \"bigint\" | \"boolean\" | \"null\";\n}\n\n/**\n * A member of a static enum type.\n *\n * @beta\n */\nexport interface EnumMember {\n /** The serialized value stored in data. */\n readonly value: string | number;\n /** Optional per-member display name. */\n readonly displayName?: string;\n}\n\n/**\n * Static enum type with members known at build time.\n *\n * @beta\n */\nexport interface EnumTypeNode {\n readonly kind: \"enum\";\n readonly members: readonly EnumMember[];\n}\n\n/**\n * Array type with a single items type.\n *\n * @beta\n */\nexport interface ArrayTypeNode {\n readonly kind: \"array\";\n readonly items: TypeNode;\n}\n\n/**\n * A named property within an object type.\n *\n * @beta\n */\nexport interface ObjectProperty {\n readonly name: string;\n readonly type: TypeNode;\n readonly optional: boolean;\n /**\n * Use-site constraints on this property.\n * Distinct from constraints on the property's type — these are\n * use-site constraints (e.g., `@minimum :amount 0` targets the\n * `amount` property of a `MonetaryAmount` field).\n */\n readonly constraints: readonly ConstraintNode[];\n /** Use-site annotations on this property. */\n readonly annotations: readonly AnnotationNode[];\n readonly provenance: Provenance;\n}\n\n/**\n * Object type with named properties.\n *\n * @beta\n */\nexport interface ObjectTypeNode {\n readonly kind: \"object\";\n /**\n * Named properties of this object. Order is preserved from the source\n * declaration for deterministic output.\n */\n readonly properties: readonly ObjectProperty[];\n /**\n * Whether additional properties beyond those listed are permitted.\n * Ordinary static object types default to true under the current spec.\n * Explicitly closed-object modes may still set this to false.\n */\n readonly additionalProperties: boolean;\n}\n\n/**\n * Record (dictionary) type — an object with a string index signature and no\n * named properties. Corresponds to `Record<string, T>` or `{ [k: string]: T }`.\n *\n * Emitted as `{ \"type\": \"object\", \"additionalProperties\": <value schema> }` in\n * JSON Schema per spec 003 §2.5.\n *\n * @beta\n */\nexport interface RecordTypeNode {\n readonly kind: \"record\";\n /** The type of each value in the dictionary. */\n readonly valueType: TypeNode;\n}\n\n/**\n * Union type for non-enum unions. Nullable types are represented as `T | null`.\n *\n * @beta\n */\nexport interface UnionTypeNode {\n readonly kind: \"union\";\n readonly members: readonly TypeNode[];\n}\n\n/**\n * Named type reference preserved for `$defs` and `$ref` emission.\n *\n * @beta\n */\nexport interface ReferenceTypeNode {\n readonly kind: \"reference\";\n /**\n * The fully-qualified name of the referenced type.\n * For TypeScript interfaces/type aliases: `\"<module>#<TypeName>\"`.\n * For built-in types: the primitive kind string.\n */\n readonly name: string;\n /**\n * Type arguments if this is a generic instantiation.\n * e.g., `Array<string>` → `{ name: \"Array\", typeArguments: [PrimitiveTypeNode(\"string\")] }`\n */\n readonly typeArguments: readonly TypeNode[];\n}\n\n/**\n * Dynamic type whose schema is resolved at runtime from a named data source.\n *\n * @beta\n */\nexport interface DynamicTypeNode {\n readonly kind: \"dynamic\";\n readonly dynamicKind: \"enum\" | \"schema\";\n /** Key identifying the runtime data source or schema provider. */\n readonly sourceKey: string;\n /**\n * For dynamic enums: field names whose current values are passed as\n * parameters to the data source resolver.\n */\n readonly parameterFields: readonly string[];\n}\n\n/**\n * Custom type registered by an extension.\n *\n * @beta\n */\nexport interface CustomTypeNode {\n readonly kind: \"custom\";\n /**\n * The extension-qualified type identifier.\n * Format: `\"<vendor-prefix>/<extension-name>/<type-name>\"`\n * e.g., `\"x-stripe/monetary/MonetaryAmount\"`\n */\n readonly typeId: string;\n /**\n * Opaque payload serialized by the extension that registered this type.\n * Must be JSON-serializable.\n */\n readonly payload: JsonValue;\n}\n\n// =============================================================================\n// CONSTRAINT NODES\n// =============================================================================\n\n/**\n * Discriminated union of all constraint types.\n * Constraints are set-influencing: they narrow the set of valid values.\n *\n * @beta\n */\nexport type ConstraintNode =\n | NumericConstraintNode\n | LengthConstraintNode\n | PatternConstraintNode\n | ArrayCardinalityConstraintNode\n | EnumMemberConstraintNode\n | ConstConstraintNode\n | CustomConstraintNode;\n\n/**\n * Numeric constraints: bounds and multipleOf.\n *\n * `minimum` and `maximum` are inclusive; `exclusiveMinimum` and\n * `exclusiveMaximum` are exclusive bounds (matching JSON Schema 2020-12\n * semantics).\n *\n * Type applicability: may only attach to fields with `PrimitiveTypeNode(\"number\")`\n * or a `ReferenceTypeNode` that resolves to one.\n *\n * @beta\n */\nexport interface NumericConstraintNode {\n readonly kind: \"constraint\";\n readonly constraintKind:\n | \"minimum\"\n | \"maximum\"\n | \"exclusiveMinimum\"\n | \"exclusiveMaximum\"\n | \"multipleOf\";\n readonly value: number;\n /** If present, targets a nested sub-field rather than the field itself. */\n readonly path?: PathTarget;\n readonly provenance: Provenance;\n}\n\n/**\n * String length and array item count constraints.\n *\n * `minLength`/`maxLength` apply to strings; `minItems`/`maxItems` apply to\n * arrays. They share the same node shape because the composition rules are\n * identical.\n *\n * Type applicability: `minLength`/`maxLength` require `PrimitiveTypeNode(\"string\")`;\n * `minItems`/`maxItems` require `ArrayTypeNode`.\n *\n * @beta\n */\nexport interface LengthConstraintNode {\n readonly kind: \"constraint\";\n readonly constraintKind: \"minLength\" | \"maxLength\" | \"minItems\" | \"maxItems\";\n readonly value: number;\n readonly path?: PathTarget;\n readonly provenance: Provenance;\n}\n\n/**\n * String pattern constraint (ECMA-262 regex without delimiters).\n *\n * Multiple `pattern` constraints on the same field compose via intersection:\n * all patterns must match simultaneously.\n *\n * Type applicability: requires `PrimitiveTypeNode(\"string\")`.\n *\n * @beta\n */\nexport interface PatternConstraintNode {\n readonly kind: \"constraint\";\n readonly constraintKind: \"pattern\";\n /** ECMA-262 regular expression, without delimiters. */\n readonly pattern: string;\n readonly path?: PathTarget;\n readonly provenance: Provenance;\n}\n\n/**\n * Array uniqueness constraint.\n *\n * @beta\n */\nexport interface ArrayCardinalityConstraintNode {\n readonly kind: \"constraint\";\n readonly constraintKind: \"uniqueItems\";\n readonly value: true;\n readonly path?: PathTarget;\n readonly provenance: Provenance;\n}\n\n/**\n * Enum member subset constraint that only narrows the allowed member set.\n *\n * @beta\n */\nexport interface EnumMemberConstraintNode {\n readonly kind: \"constraint\";\n readonly constraintKind: \"allowedMembers\";\n readonly members: readonly (string | number)[];\n readonly path?: PathTarget;\n readonly provenance: Provenance;\n}\n\n/**\n * Literal-value equality constraint.\n *\n * @beta\n */\nexport interface ConstConstraintNode {\n readonly kind: \"constraint\";\n readonly constraintKind: \"const\";\n readonly value: JsonValue;\n readonly path?: PathTarget;\n readonly provenance: Provenance;\n}\n\n/**\n * Extension-registered custom constraint.\n *\n * @beta\n */\nexport interface CustomConstraintNode {\n readonly kind: \"constraint\";\n readonly constraintKind: \"custom\";\n /** Extension-qualified ID: `\"<vendor-prefix>/<extension-name>/<constraint-name>\"` */\n readonly constraintId: string;\n /** JSON-serializable payload defined by the extension. */\n readonly payload: JsonValue;\n /** How this constraint composes with others of the same `constraintId`. */\n readonly compositionRule: \"intersect\" | \"override\";\n readonly path?: PathTarget;\n readonly provenance: Provenance;\n}\n\n// =============================================================================\n// ANNOTATION NODES\n// =============================================================================\n\n/**\n * Discriminated union of all annotation types.\n * Annotations are value-influencing: they describe or present a field\n * but do not affect which values are valid.\n *\n * @beta\n */\nexport type AnnotationNode =\n | DisplayNameAnnotationNode\n | DescriptionAnnotationNode\n | RemarksAnnotationNode\n | FormatAnnotationNode\n | PlaceholderAnnotationNode\n | DefaultValueAnnotationNode\n | DeprecatedAnnotationNode\n | FormatHintAnnotationNode\n | CustomAnnotationNode;\n\n/**\n * Display-name annotation.\n *\n * @beta\n */\nexport interface DisplayNameAnnotationNode {\n readonly kind: \"annotation\";\n readonly annotationKind: \"displayName\";\n readonly value: string;\n readonly provenance: Provenance;\n}\n\n/**\n * Description annotation.\n *\n * @beta\n */\nexport interface DescriptionAnnotationNode {\n readonly kind: \"annotation\";\n readonly annotationKind: \"description\";\n readonly value: string;\n readonly provenance: Provenance;\n}\n\n/**\n * Remarks annotation — programmatic-persona documentation carried via\n * the `x-<vendor>-remarks` JSON Schema extension keyword.\n *\n * Populated from `@remarks` TSDoc tag content. SDK codegen can include\n * this in doc comments; API Documenter renders the source `@remarks`\n * natively in a dedicated Remarks section.\n *\n * @beta\n */\nexport interface RemarksAnnotationNode {\n readonly kind: \"annotation\";\n readonly annotationKind: \"remarks\";\n readonly value: string;\n readonly provenance: Provenance;\n}\n\n/**\n * Schema format annotation, for example `email`, `date`, or `uri`.\n *\n * @beta\n */\nexport interface FormatAnnotationNode {\n readonly kind: \"annotation\";\n readonly annotationKind: \"format\";\n readonly value: string;\n readonly provenance: Provenance;\n}\n\n/**\n * Placeholder annotation.\n *\n * @beta\n */\nexport interface PlaceholderAnnotationNode {\n readonly kind: \"annotation\";\n readonly annotationKind: \"placeholder\";\n readonly value: string;\n readonly provenance: Provenance;\n}\n\n/**\n * Default-value annotation.\n *\n * @beta\n */\nexport interface DefaultValueAnnotationNode {\n readonly kind: \"annotation\";\n readonly annotationKind: \"defaultValue\";\n /** Must be JSON-serializable and type-compatible (verified during Validate phase). */\n readonly value: JsonValue;\n readonly provenance: Provenance;\n}\n\n/**\n * Deprecated annotation.\n *\n * @beta\n */\nexport interface DeprecatedAnnotationNode {\n readonly kind: \"annotation\";\n readonly annotationKind: \"deprecated\";\n /** Optional deprecation message. */\n readonly message?: string;\n readonly provenance: Provenance;\n}\n\n/**\n * UI rendering hint — does not affect schema validation.\n * Unlike FormatAnnotationNode, this never emits a JSON Schema `format`.\n *\n * @beta\n */\nexport interface FormatHintAnnotationNode {\n readonly kind: \"annotation\";\n readonly annotationKind: \"formatHint\";\n /** Renderer-specific format identifier: \"textarea\", \"radio\", \"date\", \"color\", etc. */\n readonly format: string;\n readonly provenance: Provenance;\n}\n\n/**\n * Extension-registered custom annotation.\n *\n * @beta\n */\nexport interface CustomAnnotationNode {\n readonly kind: \"annotation\";\n readonly annotationKind: \"custom\";\n /** Extension-qualified ID: `\"<vendor-prefix>/<extension-name>/<annotation-name>\"` */\n readonly annotationId: string;\n readonly value: JsonValue;\n readonly provenance: Provenance;\n}\n\n// =============================================================================\n// FIELD NODE\n// =============================================================================\n\n/**\n * A single form field after canonicalization.\n *\n * @beta\n */\nexport interface FieldNode {\n readonly kind: \"field\";\n /** The field's key in the data schema. */\n readonly name: string;\n /** The resolved type of this field. */\n readonly type: TypeNode;\n /** Whether this field is required in the data schema. */\n readonly required: boolean;\n /** Set-influencing constraints, after merging. */\n readonly constraints: readonly ConstraintNode[];\n /** Value-influencing annotations, after merging. */\n readonly annotations: readonly AnnotationNode[];\n /** Where this field was declared. */\n readonly provenance: Provenance;\n /**\n * Debug only — ordered list of constraint/annotation nodes that participated\n * in merging, including dominated ones.\n */\n readonly mergeHistory?: readonly {\n readonly node: ConstraintNode | AnnotationNode;\n readonly dominated: boolean;\n }[];\n}\n\n// =============================================================================\n// LAYOUT NODES\n// =============================================================================\n\n/**\n * Union of layout node types.\n *\n * @beta\n */\nexport type LayoutNode = GroupLayoutNode | ConditionalLayoutNode;\n\n/**\n * A visual grouping of form elements.\n *\n * @beta\n */\nexport interface GroupLayoutNode {\n readonly kind: \"group\";\n readonly label: string;\n /** Elements contained in this group — may be fields or nested groups. */\n readonly elements: readonly FormIRElement[];\n readonly provenance: Provenance;\n}\n\n/**\n * Conditional visibility based on another field's value.\n *\n * @beta\n */\nexport interface ConditionalLayoutNode {\n readonly kind: \"conditional\";\n /** The field whose value triggers visibility. */\n readonly fieldName: string;\n /** The value that makes the condition true (SHOW). */\n readonly value: JsonValue;\n /** Elements shown when the condition is met. */\n readonly elements: readonly FormIRElement[];\n readonly provenance: Provenance;\n}\n\n/**\n * Union of all IR element types.\n *\n * @beta\n */\nexport type FormIRElement = FieldNode | LayoutNode;\n\n// =============================================================================\n// TYPE REGISTRY\n// =============================================================================\n\n/**\n * A named type definition stored in the type registry.\n *\n * @beta\n */\nexport interface TypeDefinition {\n /** The fully-qualified reference name (key in the registry). */\n readonly name: string;\n /** The resolved type node. */\n readonly type: TypeNode;\n /** Constraints declared on the named type itself. */\n readonly constraints?: readonly ConstraintNode[];\n /** Root-level value metadata for a named type definition. */\n readonly annotations?: readonly AnnotationNode[];\n /** Where this type was declared. */\n readonly provenance: Provenance;\n}\n\n// =============================================================================\n// FORM IR (TOP-LEVEL)\n// =============================================================================\n\n/**\n * The complete Canonical Intermediate Representation for a form.\n *\n * Output of the Canonicalize phase; input to Validate, Generate (JSON Schema),\n * and Generate (UI Schema) phases.\n *\n * Serializable to JSON — no live compiler objects.\n *\n * @beta\n */\nexport interface FormIR {\n readonly kind: \"form-ir\";\n /**\n * Schema version for the IR format itself.\n * Should equal `IR_VERSION`.\n */\n readonly irVersion: string;\n /** Top-level elements of the form: fields and layout nodes. */\n readonly elements: readonly FormIRElement[];\n /** Root-level annotations derived from the source declaration itself. */\n readonly rootAnnotations?: readonly AnnotationNode[];\n /**\n * Registry of named types referenced by fields in this form.\n * Keys are fully-qualified type names matching `ReferenceTypeNode.name`.\n */\n readonly typeRegistry: Readonly<Record<string, TypeDefinition>>;\n /** Root-level metadata for the form itself. */\n readonly annotations?: readonly AnnotationNode[];\n /** Provenance of the form definition itself. */\n readonly provenance: Provenance;\n}\n","/**\n * Extension API for registering custom types, constraints, annotations,\n * and vocabulary keywords with FormSpec.\n *\n * Extensions allow third-party packages (e.g., \"Decimal\", \"DateOnly\") to\n * plug into the FormSpec pipeline. The types and factory functions defined\n * here are consumed by the FormSpec build pipeline.\n *\n * @packageDocumentation\n */\n\nimport type { BuiltinConstraintName } from \"../types/constraint-definitions.js\";\n\n// =============================================================================\n// REGISTRATION TYPES\n// =============================================================================\n\n/**\n * A JSON-serializable payload value used by extension registration hooks.\n *\n * @public\n */\nexport type ExtensionPayloadValue =\n | null\n | boolean\n | number\n | string\n | readonly ExtensionPayloadValue[]\n | { readonly [key: string]: ExtensionPayloadValue };\n\n/**\n * Top-level type kinds that extension applicability hooks may inspect.\n *\n * @public\n */\nexport type ExtensionTypeKind =\n | \"primitive\"\n | \"enum\"\n | \"array\"\n | \"object\"\n | \"record\"\n | \"union\"\n | \"reference\"\n | \"dynamic\"\n | \"custom\";\n\n/**\n * A curated type shape exposed to extension applicability hooks.\n *\n * This intentionally exposes only the fields needed to determine tag/type\n * applicability without committing the entire canonical IR as public API.\n *\n * @public\n */\nexport type ExtensionApplicableType =\n | {\n readonly kind: \"primitive\";\n readonly primitiveKind: \"string\" | \"number\" | \"integer\" | \"bigint\" | \"boolean\" | \"null\";\n }\n | {\n readonly kind: \"custom\";\n readonly typeId: string;\n readonly payload: ExtensionPayloadValue;\n }\n | { readonly kind: Exclude<ExtensionTypeKind, \"primitive\" | \"custom\"> };\n\n/**\n * Registration for a custom type that maps to a JSON Schema representation.\n *\n * Custom types are referenced by FormSpec's internal custom-type IR nodes and\n * resolved to JSON Schema via `toJsonSchema` during generation.\n *\n * @public\n */\nexport interface CustomTypeRegistration {\n /** The type name, unique within the extension. */\n readonly typeName: string;\n /**\n * Optional TypeScript surface names that should resolve to this custom type\n * during TSDoc/class analysis. Defaults to `typeName` when omitted.\n */\n readonly tsTypeNames?: readonly string[];\n /**\n * Converts the custom type's payload into a JSON Schema fragment.\n *\n * @param payload - The opaque JSON payload stored on the custom type node.\n * @param vendorPrefix - The vendor prefix for extension keywords (e.g., \"x-stripe\").\n * @returns A JSON Schema fragment representing this type.\n */\n readonly toJsonSchema: (\n payload: ExtensionPayloadValue,\n vendorPrefix: string\n ) => Record<string, unknown>;\n /**\n * Optional broadening of built-in constraint tags so they can apply to this\n * custom type without modifying the core built-in constraint tables.\n */\n readonly builtinConstraintBroadenings?: readonly BuiltinConstraintBroadeningRegistration[];\n}\n\n/**\n * Registration for a custom constraint that maps to JSON Schema keywords.\n *\n * Custom constraints are referenced by FormSpec's internal custom-constraint nodes.\n *\n * @public\n */\nexport interface CustomConstraintRegistration {\n /** The constraint name, unique within the extension. */\n readonly constraintName: string;\n /**\n * How this constraint composes with other constraints of the same kind.\n * - \"intersect\": combine with logical AND (both must hold)\n * - \"override\": last writer wins\n */\n readonly compositionRule: \"intersect\" | \"override\";\n /**\n * TypeNode kinds this constraint is applicable to, or `null` for any type.\n * Used by the validator to emit TYPE_MISMATCH diagnostics.\n */\n readonly applicableTypes: readonly ExtensionApplicableType[\"kind\"][] | null;\n /**\n * Optional precise type predicate used when kind-level applicability is too\n * broad (for example, constraints that apply to integer-like primitives but\n * not strings).\n */\n readonly isApplicableToType?: (type: ExtensionApplicableType) => boolean;\n /**\n * Optional comparator for payloads belonging to the same custom constraint.\n * Return values follow the `Array.prototype.sort()` contract.\n */\n readonly comparePayloads?: (left: ExtensionPayloadValue, right: ExtensionPayloadValue) => number;\n /**\n * Optional semantic family metadata for generic contradiction/broadening\n * handling across ordered constraints.\n */\n readonly semanticRole?: ConstraintSemanticRole;\n /**\n * Converts the custom constraint's payload into JSON Schema keywords.\n *\n * @param payload - The opaque JSON payload stored on the custom constraint node.\n * @param vendorPrefix - The vendor prefix for extension keywords.\n * @returns A JSON Schema fragment with the constraint keywords.\n */\n readonly toJsonSchema: (\n payload: ExtensionPayloadValue,\n vendorPrefix: string\n ) => Record<string, unknown>;\n}\n\n/**\n * Registration for a custom annotation that may produce JSON Schema keywords.\n *\n * Custom annotations are referenced by FormSpec's internal custom-annotation nodes.\n * They describe or present a field but do not affect which values are valid.\n *\n * @public\n */\nexport interface CustomAnnotationRegistration {\n /** The annotation name, unique within the extension. */\n readonly annotationName: string;\n /**\n * Optionally converts the annotation value into JSON Schema keywords.\n * If omitted, the annotation has no JSON Schema representation (UI-only).\n */\n readonly toJsonSchema?: (\n value: ExtensionPayloadValue,\n vendorPrefix: string\n ) => Record<string, unknown>;\n}\n\n/**\n * Registration for a vocabulary keyword to include in a JSON Schema `$vocabulary` declaration.\n *\n * @public\n */\nexport interface VocabularyKeywordRegistration {\n /** The keyword name (without vendor prefix). */\n readonly keyword: string;\n /** JSON Schema that describes the valid values for this keyword. */\n readonly schema: ExtensionPayloadValue;\n}\n\n/**\n * Declarative authoring-side registration for a custom TSDoc constraint tag.\n *\n * @public\n */\nexport interface ConstraintTagRegistration {\n /** Tag name without the `@` prefix, e.g. `\"maxSigFig\"`. */\n readonly tagName: string;\n /** The custom constraint that this tag should produce. */\n readonly constraintName: string;\n /** Parser from raw TSDoc text to JSON-serializable payload. */\n readonly parseValue: (raw: string) => ExtensionPayloadValue;\n /**\n * Optional precise applicability predicate for the field type being parsed.\n * When omitted, the target custom constraint registration controls type\n * applicability during validation.\n */\n readonly isApplicableToType?: (type: ExtensionApplicableType) => boolean;\n}\n\n/**\n * Registration for mapping a built-in TSDoc tag onto a custom constraint when\n * it is used on a particular custom type.\n *\n * @public\n */\nexport interface BuiltinConstraintBroadeningRegistration {\n /** The built-in tag being broadened, without the `@` prefix. */\n readonly tagName: BuiltinConstraintName;\n /** The custom constraint to emit for this built-in tag. */\n readonly constraintName: string;\n /** Parser from raw TSDoc text to extension payload. */\n readonly parseValue: (raw: string) => ExtensionPayloadValue;\n}\n\n/**\n * Semantic metadata for ordered custom constraints that should participate in\n * the generic contradiction/broadening logic.\n *\n * @public\n */\nexport interface ConstraintSemanticRole {\n /**\n * Logical family identifier shared by related constraints, for example\n * `\"decimal-bound\"` or `\"date-bound\"`.\n */\n readonly family: string;\n /** Whether this constraint acts as a lower or upper bound. */\n readonly bound: \"lower\" | \"upper\" | \"exact\";\n /** Whether equality is allowed when comparing against the bound. */\n readonly inclusive: boolean;\n}\n\n// =============================================================================\n// EXTENSION DEFINITION\n// =============================================================================\n\n/**\n * A complete extension definition bundling types, constraints, annotations,\n * and vocabulary keywords.\n *\n * @example\n * ```typescript\n * const monetaryExtension = defineExtension({\n * extensionId: \"x-stripe/monetary\",\n * types: [\n * defineCustomType({\n * typeName: \"Decimal\",\n * toJsonSchema: (_payload, prefix) => ({\n * type: \"string\",\n * [`${prefix}-decimal`]: true,\n * }),\n * }),\n * ],\n * });\n * ```\n *\n * @public\n */\nexport interface ExtensionDefinition {\n /** Globally unique extension identifier, e.g., \"x-stripe/monetary\". */\n readonly extensionId: string;\n /** Custom type registrations provided by this extension. */\n readonly types?: readonly CustomTypeRegistration[];\n /** Custom constraint registrations provided by this extension. */\n readonly constraints?: readonly CustomConstraintRegistration[];\n /** Authoring-side TSDoc tag registrations provided by this extension. */\n readonly constraintTags?: readonly ConstraintTagRegistration[];\n /** Custom annotation registrations provided by this extension. */\n readonly annotations?: readonly CustomAnnotationRegistration[];\n /** Vocabulary keyword registrations provided by this extension. */\n readonly vocabularyKeywords?: readonly VocabularyKeywordRegistration[];\n}\n\n// =============================================================================\n// FACTORY FUNCTIONS\n// =============================================================================\n\n/**\n * Defines a complete extension. Currently an identity function that provides\n * type-checking and IDE autocompletion for the definition shape.\n *\n * @param def - The extension definition.\n * @returns The same definition, validated at the type level.\n *\n * @public\n */\nexport function defineExtension(def: ExtensionDefinition): ExtensionDefinition {\n return def;\n}\n\n/**\n * Defines a custom type registration. Currently an identity function that\n * provides type-checking and IDE autocompletion.\n *\n * @param reg - The custom type registration.\n * @returns The same registration, validated at the type level.\n *\n * @public\n */\nexport function defineCustomType(reg: CustomTypeRegistration): CustomTypeRegistration {\n return reg;\n}\n\n/**\n * Defines a custom constraint registration. Currently an identity function\n * that provides type-checking and IDE autocompletion.\n *\n * @param reg - The custom constraint registration.\n * @returns The same registration, validated at the type level.\n *\n * @public\n */\nexport function defineConstraint(reg: CustomConstraintRegistration): CustomConstraintRegistration {\n return reg;\n}\n\n/**\n * Defines a custom TSDoc constraint tag registration.\n *\n * @param reg - The custom tag registration.\n * @returns The same registration, validated at the type level.\n *\n * @public\n */\nexport function defineConstraintTag(reg: ConstraintTagRegistration): ConstraintTagRegistration {\n return reg;\n}\n\n/**\n * Defines a custom annotation registration. Currently an identity function\n * that provides type-checking and IDE autocompletion.\n *\n * @param reg - The custom annotation registration.\n * @returns The same registration, validated at the type level.\n *\n * @public\n */\nexport function defineAnnotation(reg: CustomAnnotationRegistration): CustomAnnotationRegistration {\n return reg;\n}\n","/**\n * Type guards for FormSpec form elements.\n *\n * Each guard narrows a {@link FormElement} to a specific field, group, or conditional type.\n */\n\nimport type {\n FormElement,\n AnyField,\n TextField,\n NumberField,\n BooleanField,\n StaticEnumField,\n DynamicEnumField,\n DynamicSchemaField,\n ArrayField,\n ObjectField,\n Group,\n Conditional,\n EnumOptionValue,\n} from \"./types/elements.js\";\n\n/**\n * Narrows a `FormElement` to any field type.\n *\n * @public\n */\nexport function isField(element: FormElement): element is AnyField {\n return element._type === \"field\";\n}\n\n/**\n * Narrows a `FormElement` to a text input field.\n *\n * @public\n */\nexport function isTextField(element: FormElement): element is TextField<string> {\n return element._type === \"field\" && element._field === \"text\";\n}\n\n/**\n * Narrows a `FormElement` to a numeric input field.\n *\n * @public\n */\nexport function isNumberField(element: FormElement): element is NumberField<string> {\n return element._type === \"field\" && element._field === \"number\";\n}\n\n/**\n * Narrows a `FormElement` to a boolean checkbox field.\n *\n * @public\n */\nexport function isBooleanField(element: FormElement): element is BooleanField<string> {\n return element._type === \"field\" && element._field === \"boolean\";\n}\n\n/**\n * Narrows a `FormElement` to a static enum field.\n *\n * @public\n */\nexport function isStaticEnumField(\n element: FormElement\n): element is StaticEnumField<string, readonly EnumOptionValue[]> {\n return element._type === \"field\" && element._field === \"enum\";\n}\n\n/**\n * Narrows a `FormElement` to a dynamic enum field.\n *\n * @public\n */\nexport function isDynamicEnumField(\n element: FormElement\n): element is DynamicEnumField<string, string> {\n return element._type === \"field\" && element._field === \"dynamic_enum\";\n}\n\n/**\n * Narrows a `FormElement` to a dynamic schema field.\n *\n * @public\n */\nexport function isDynamicSchemaField(element: FormElement): element is DynamicSchemaField<string> {\n return element._type === \"field\" && element._field === \"dynamic_schema\";\n}\n\n/**\n * Narrows a `FormElement` to an array field.\n *\n * @public\n */\nexport function isArrayField(\n element: FormElement\n): element is ArrayField<string, readonly FormElement[]> {\n return element._type === \"field\" && element._field === \"array\";\n}\n\n/**\n * Narrows a `FormElement` to an object field.\n *\n * @public\n */\nexport function isObjectField(\n element: FormElement\n): element is ObjectField<string, readonly FormElement[]> {\n return element._type === \"field\" && element._field === \"object\";\n}\n\n/**\n * Narrows a `FormElement` to a visual group.\n *\n * @public\n */\nexport function isGroup(element: FormElement): element is Group<readonly FormElement[]> {\n return element._type === \"group\";\n}\n\n/**\n * Narrows a `FormElement` to a conditional wrapper.\n *\n * @public\n */\nexport function isConditional(\n element: FormElement\n): element is Conditional<string, unknown, readonly FormElement[]> {\n return element._type === \"conditional\";\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACmCO,SAAS,wBAA2B,OAAyB;AAClE,SAAO;AAAA,IACL;AAAA,IACA,OAAO;AAAA,IACP,SAAS;AAAA,IACT,UAAU;AAAA,IACV,QAAQ,CAAC;AAAA,EACX;AACF;;;ACpBO,IAAM,aAAa;;;AC2QnB,SAAS,gBAAgB,KAA+C;AAC7E,SAAO;AACT;AAWO,SAAS,iBAAiB,KAAqD;AACpF,SAAO;AACT;AAWO,SAAS,iBAAiB,KAAiE;AAChG,SAAO;AACT;AAUO,SAAS,oBAAoB,KAA2D;AAC7F,SAAO;AACT;AAWO,SAAS,iBAAiB,KAAiE;AAChG,SAAO;AACT;;;AC5TO,SAAS,QAAQ,SAA2C;AACjE,SAAO,QAAQ,UAAU;AAC3B;AAOO,SAAS,YAAY,SAAoD;AAC9E,SAAO,QAAQ,UAAU,WAAW,QAAQ,WAAW;AACzD;AAOO,SAAS,cAAc,SAAsD;AAClF,SAAO,QAAQ,UAAU,WAAW,QAAQ,WAAW;AACzD;AAOO,SAAS,eAAe,SAAuD;AACpF,SAAO,QAAQ,UAAU,WAAW,QAAQ,WAAW;AACzD;AAOO,SAAS,kBACd,SACgE;AAChE,SAAO,QAAQ,UAAU,WAAW,QAAQ,WAAW;AACzD;AAOO,SAAS,mBACd,SAC6C;AAC7C,SAAO,QAAQ,UAAU,WAAW,QAAQ,WAAW;AACzD;AAOO,SAAS,qBAAqB,SAA6D;AAChG,SAAO,QAAQ,UAAU,WAAW,QAAQ,WAAW;AACzD;AAOO,SAAS,aACd,SACuD;AACvD,SAAO,QAAQ,UAAU,WAAW,QAAQ,WAAW;AACzD;AAOO,SAAS,cACd,SACwD;AACxD,SAAO,QAAQ,UAAU,WAAW,QAAQ,WAAW;AACzD;AAOO,SAAS,QAAQ,SAAgE;AACtF,SAAO,QAAQ,UAAU;AAC3B;AAOO,SAAS,cACd,SACiE;AACjE,SAAO,QAAQ,UAAU;AAC3B;","names":[]}
1
+ {"version":3,"sources":["../src/index.ts","../src/types/field-state.ts","../src/types/ir.ts","../src/extensions/index.ts","../src/guards.ts"],"sourcesContent":["/**\n * `@formspec/core` - Core type definitions for FormSpec\n *\n * This package provides the foundational types used throughout the FormSpec ecosystem:\n * - Form element types (fields, groups, conditionals)\n * - Field and form state types\n * - Data source registry for dynamic enums\n * - Canonical IR types (FormIR, FieldNode, TypeNode, ConstraintNode, AnnotationNode, etc.)\n *\n * @packageDocumentation\n */\n\n// Re-export all types\nexport type {\n // Validity\n Validity,\n\n // Field state\n FieldState,\n\n // Form state\n FormState,\n\n // Data sources\n DataSourceRegistry,\n DataSourceOption,\n FetchOptionsResponse,\n DataSourceValueType,\n\n // Elements\n TextField,\n NumberField,\n BooleanField,\n EnumOption,\n EnumOptionValue,\n StaticEnumField,\n DynamicEnumField,\n DynamicSchemaField,\n ArrayField,\n ObjectField,\n AnyField,\n Group,\n Conditional,\n FormElement,\n FormSpec,\n\n // Predicates\n EqualsPredicate,\n Predicate,\n\n // Built-in constraints\n BuiltinConstraintName,\n\n // Canonical IR\n JsonValue,\n Provenance,\n PathTarget,\n TypeNode,\n PrimitiveTypeNode,\n EnumMember,\n EnumTypeNode,\n ArrayTypeNode,\n ObjectProperty,\n ObjectTypeNode,\n RecordTypeNode,\n UnionTypeNode,\n ReferenceTypeNode,\n DynamicTypeNode,\n CustomTypeNode,\n ConstraintNode,\n NumericConstraintNode,\n LengthConstraintNode,\n PatternConstraintNode,\n ArrayCardinalityConstraintNode,\n EnumMemberConstraintNode,\n ConstConstraintNode,\n CustomConstraintNode,\n AnnotationNode,\n DisplayNameAnnotationNode,\n DescriptionAnnotationNode,\n RemarksAnnotationNode,\n FormatAnnotationNode,\n PlaceholderAnnotationNode,\n DefaultValueAnnotationNode,\n DeprecatedAnnotationNode,\n FormatHintAnnotationNode,\n CustomAnnotationNode,\n FieldNode,\n LayoutNode,\n GroupLayoutNode,\n ConditionalLayoutNode,\n FormIRElement,\n TypeDefinition,\n FormIR,\n} from \"./types/index.js\";\n\n// Re-export functions and constants\nexport { createInitialFieldState, IR_VERSION } from \"./types/index.js\";\n\n// Extension API\nexport type {\n ExtensionPayloadValue,\n ExtensionTypeKind,\n ExtensionApplicableType,\n ExtensionDefinition,\n CustomTypeRegistration,\n CustomConstraintRegistration,\n ConstraintTagRegistration,\n BuiltinConstraintBroadeningRegistration,\n ConstraintSemanticRole,\n CustomAnnotationRegistration,\n VocabularyKeywordRegistration,\n} from \"./extensions/index.js\";\n\nexport {\n defineExtension,\n defineCustomType,\n defineConstraint,\n defineConstraintTag,\n defineAnnotation,\n} from \"./extensions/index.js\";\n\n// Re-export type guards\nexport {\n isField,\n isTextField,\n isNumberField,\n isBooleanField,\n isStaticEnumField,\n isDynamicEnumField,\n isDynamicSchemaField,\n isArrayField,\n isObjectField,\n isGroup,\n isConditional,\n} from \"./guards.js\";\n","import type { Validity } from \"./validity.js\";\n\n/**\n * Represents the runtime state of a single form field.\n *\n * @typeParam T - The value type of the field\n *\n * @public\n */\nexport interface FieldState<T> {\n /** Current value of the field */\n readonly value: T;\n\n /** Whether the field has been modified by the user */\n readonly dirty: boolean;\n\n /** Whether the field has been focused and blurred */\n readonly touched: boolean;\n\n /** Current validity state */\n readonly validity: Validity;\n\n /** Validation error messages, if any */\n readonly errors: readonly string[];\n}\n\n/**\n * Creates initial field state with default values.\n *\n * @typeParam T - The value type of the field\n * @param value - The initial value for the field\n * @returns Initial field state\n *\n * @public\n */\nexport function createInitialFieldState<T>(value: T): FieldState<T> {\n return {\n value,\n dirty: false,\n touched: false,\n validity: \"unknown\",\n errors: [],\n };\n}\n","/**\n * Canonical Intermediate Representation (IR) types for FormSpec.\n *\n * The IR is the shared intermediate structure that both authoring surfaces\n * (chain DSL and TSDoc-annotated types) compile to. All downstream operations\n * — JSON Schema generation, UI Schema generation, constraint validation,\n * diagnostics — consume the IR exclusively.\n *\n * All types are plain, serializable objects (no live compiler references).\n *\n * @see {@link https://github.com/stripe/formspec-workspace/blob/main/scratch/design/001-canonical-ir.md}\n */\n\n// =============================================================================\n// IR VERSION\n// =============================================================================\n\n/**\n * The current IR format version. Centralized here so all canonicalizers\n * and consumers reference a single source of truth.\n *\n * @beta\n */\nexport const IR_VERSION = \"0.1.0\" as const;\n\n// =============================================================================\n// UTILITY TYPES\n// =============================================================================\n\n/**\n * A JSON-serializable value. All IR nodes must be representable as JSON.\n *\n * @beta\n */\nexport type JsonValue =\n | null\n | boolean\n | number\n | string\n | readonly JsonValue[]\n | { readonly [key: string]: JsonValue };\n\n// =============================================================================\n// PROVENANCE\n// =============================================================================\n\n/**\n * Describes the origin of an IR node.\n * Enables diagnostics that point to the source of a contradiction or error.\n *\n * @beta\n */\nexport interface Provenance {\n /** The authoring surface that produced this node. */\n readonly surface: \"tsdoc\" | \"chain-dsl\" | \"extension\" | \"inferred\";\n /** Absolute path to the source file. */\n readonly file: string;\n /** 1-based line number in the source file. */\n readonly line: number;\n /** 0-based column number in the source file. */\n readonly column: number;\n /** Length of the source span in characters (for IDE underline ranges). */\n readonly length?: number;\n /**\n * The specific tag, call, or construct that produced this node.\n * Examples: `@minimum`, `field.number({ min: 0 })`, `optional`\n */\n readonly tagName?: string;\n}\n\n// =============================================================================\n// PATH TARGET\n// =============================================================================\n\n/**\n * A path targeting a sub-field within a complex type.\n * Used by constraints and annotations to target nested properties.\n *\n * @beta\n */\nexport interface PathTarget {\n /**\n * Sequence of property names forming a path from the annotated field's type\n * to the target sub-field.\n * e.g., `[\"value\"]` or `[\"address\", \"zip\"]`\n */\n readonly segments: readonly string[];\n}\n\n// =============================================================================\n// TYPE NODES\n// =============================================================================\n\n/**\n * Discriminated union of all type representations in the IR.\n *\n * @beta\n */\nexport type TypeNode =\n | PrimitiveTypeNode\n | EnumTypeNode\n | ArrayTypeNode\n | ObjectTypeNode\n | RecordTypeNode\n | UnionTypeNode\n | ReferenceTypeNode\n | DynamicTypeNode\n | CustomTypeNode;\n\n/**\n * Primitive types mapping directly to JSON Schema primitives.\n *\n * Note: integer is NOT a primitive kind — integer semantics are expressed\n * via a `multipleOf: 1` constraint on a number type.\n *\n * @beta\n */\nexport interface PrimitiveTypeNode {\n /** Discriminator identifying this node as a primitive type. */\n readonly kind: \"primitive\";\n /** Primitive value family represented by this node. */\n readonly primitiveKind: \"string\" | \"number\" | \"integer\" | \"bigint\" | \"boolean\" | \"null\";\n}\n\n/**\n * A member of a static enum type.\n *\n * @beta\n */\nexport interface EnumMember {\n /** The serialized value stored in data. */\n readonly value: string | number;\n /** Optional per-member display name. */\n readonly displayName?: string;\n}\n\n/**\n * Static enum type with members known at build time.\n *\n * @beta\n */\nexport interface EnumTypeNode {\n /** Discriminator identifying this node as an enum type. */\n readonly kind: \"enum\";\n /** Allowed enum members in declaration order. */\n readonly members: readonly EnumMember[];\n}\n\n/**\n * Array type with a single items type.\n *\n * @beta\n */\nexport interface ArrayTypeNode {\n /** Discriminator identifying this node as an array type. */\n readonly kind: \"array\";\n /** Item type for each array entry. */\n readonly items: TypeNode;\n}\n\n/**\n * A named property within an object type.\n *\n * @beta\n */\nexport interface ObjectProperty {\n /** Property name as it appears in the containing object type. */\n readonly name: string;\n /** Canonical IR type for this property. */\n readonly type: TypeNode;\n /** Whether the property may be omitted from object values. */\n readonly optional: boolean;\n /**\n * Use-site constraints on this property.\n * Distinct from constraints on the property's type — these are\n * use-site constraints (e.g., `@minimum :amount 0` targets the\n * `amount` property of a `MonetaryAmount` field).\n */\n readonly constraints: readonly ConstraintNode[];\n /** Use-site annotations on this property. */\n readonly annotations: readonly AnnotationNode[];\n /** Source location that produced this property entry. */\n readonly provenance: Provenance;\n}\n\n/**\n * Object type with named properties.\n *\n * @beta\n */\nexport interface ObjectTypeNode {\n /** Discriminator identifying this node as an object type. */\n readonly kind: \"object\";\n /**\n * Named properties of this object. Order is preserved from the source\n * declaration for deterministic output.\n */\n readonly properties: readonly ObjectProperty[];\n /**\n * Whether additional properties beyond those listed are permitted.\n * Ordinary static object types default to true under the current spec.\n * Explicitly closed-object modes may still set this to false.\n */\n readonly additionalProperties: boolean;\n}\n\n/**\n * Record (dictionary) type — an object with a string index signature and no\n * named properties. Corresponds to `Record<string, T>` or `{ [k: string]: T }`.\n *\n * Emitted as `{ \"type\": \"object\", \"additionalProperties\": <value schema> }` in\n * JSON Schema per spec 003 §2.5.\n *\n * @beta\n */\nexport interface RecordTypeNode {\n /** Discriminator identifying this node as a record type. */\n readonly kind: \"record\";\n /** The type of each value in the dictionary. */\n readonly valueType: TypeNode;\n}\n\n/**\n * Union type for non-enum unions. Nullable types are represented as `T | null`.\n *\n * @beta\n */\nexport interface UnionTypeNode {\n /** Discriminator identifying this node as a union type. */\n readonly kind: \"union\";\n /** Member types that participate in the union. */\n readonly members: readonly TypeNode[];\n}\n\n/**\n * Named type reference preserved for `$defs` and `$ref` emission.\n *\n * @beta\n */\nexport interface ReferenceTypeNode {\n /** Discriminator identifying this node as a named reference type. */\n readonly kind: \"reference\";\n /**\n * The fully-qualified name of the referenced type.\n * For TypeScript interfaces/type aliases: `\"<module>#<TypeName>\"`.\n * For built-in types: the primitive kind string.\n */\n readonly name: string;\n /**\n * Type arguments if this is a generic instantiation.\n * e.g., `Array<string>` → `{ name: \"Array\", typeArguments: [PrimitiveTypeNode(\"string\")] }`\n */\n readonly typeArguments: readonly TypeNode[];\n}\n\n/**\n * Dynamic type whose schema is resolved at runtime from a named data source.\n *\n * @beta\n */\nexport interface DynamicTypeNode {\n /** Discriminator identifying this node as a runtime-resolved type. */\n readonly kind: \"dynamic\";\n /** Dynamic schema family resolved for this field. */\n readonly dynamicKind: \"enum\" | \"schema\";\n /** Key identifying the runtime data source or schema provider. */\n readonly sourceKey: string;\n /**\n * For dynamic enums: field names whose current values are passed as\n * parameters to the data source resolver.\n */\n readonly parameterFields: readonly string[];\n}\n\n/**\n * Custom type registered by an extension.\n *\n * @beta\n */\nexport interface CustomTypeNode {\n /** Discriminator identifying this node as an extension-provided type. */\n readonly kind: \"custom\";\n /**\n * The extension-qualified type identifier.\n * Format: `\"<vendor-prefix>/<extension-name>/<type-name>\"`\n * e.g., `\"x-stripe/monetary/MonetaryAmount\"`\n */\n readonly typeId: string;\n /**\n * Opaque payload serialized by the extension that registered this type.\n * Must be JSON-serializable.\n */\n readonly payload: JsonValue;\n}\n\n// =============================================================================\n// CONSTRAINT NODES\n// =============================================================================\n\n/**\n * Discriminated union of all constraint types.\n * Constraints are set-influencing: they narrow the set of valid values.\n *\n * @beta\n */\nexport type ConstraintNode =\n | NumericConstraintNode\n | LengthConstraintNode\n | PatternConstraintNode\n | ArrayCardinalityConstraintNode\n | EnumMemberConstraintNode\n | ConstConstraintNode\n | CustomConstraintNode;\n\n/**\n * Numeric constraints: bounds and multipleOf.\n *\n * `minimum` and `maximum` are inclusive; `exclusiveMinimum` and\n * `exclusiveMaximum` are exclusive bounds (matching JSON Schema 2020-12\n * semantics).\n *\n * Type applicability: may only attach to fields with `PrimitiveTypeNode(\"number\")`\n * or a `ReferenceTypeNode` that resolves to one.\n *\n * @beta\n */\nexport interface NumericConstraintNode {\n /** Discriminator identifying this node as a constraint. */\n readonly kind: \"constraint\";\n /** Specific numeric constraint represented by this node. */\n readonly constraintKind:\n | \"minimum\"\n | \"maximum\"\n | \"exclusiveMinimum\"\n | \"exclusiveMaximum\"\n | \"multipleOf\";\n /** Numeric value carried by the constraint. */\n readonly value: number;\n /** If present, targets a nested sub-field rather than the field itself. */\n readonly path?: PathTarget;\n /** Source location that produced this constraint. */\n readonly provenance: Provenance;\n}\n\n/**\n * String length and array item count constraints.\n *\n * `minLength`/`maxLength` apply to strings; `minItems`/`maxItems` apply to\n * arrays. They share the same node shape because the composition rules are\n * identical.\n *\n * Type applicability: `minLength`/`maxLength` require `PrimitiveTypeNode(\"string\")`;\n * `minItems`/`maxItems` require `ArrayTypeNode`.\n *\n * @beta\n */\nexport interface LengthConstraintNode {\n /** Discriminator identifying this node as a constraint. */\n readonly kind: \"constraint\";\n /** Specific length or cardinality constraint represented by this node. */\n readonly constraintKind: \"minLength\" | \"maxLength\" | \"minItems\" | \"maxItems\";\n /** Inclusive bound value carried by the constraint. */\n readonly value: number;\n /** Nested path target, when the constraint applies below the field root. */\n readonly path?: PathTarget;\n /** Source location that produced this constraint. */\n readonly provenance: Provenance;\n}\n\n/**\n * String pattern constraint (ECMA-262 regex without delimiters).\n *\n * Multiple `pattern` constraints on the same field compose via intersection:\n * all patterns must match simultaneously.\n *\n * Type applicability: requires `PrimitiveTypeNode(\"string\")`.\n *\n * @beta\n */\nexport interface PatternConstraintNode {\n /** Discriminator identifying this node as a constraint. */\n readonly kind: \"constraint\";\n /** Specific pattern constraint represented by this node. */\n readonly constraintKind: \"pattern\";\n /** ECMA-262 regular expression, without delimiters. */\n readonly pattern: string;\n /** Nested path target, when the constraint applies below the field root. */\n readonly path?: PathTarget;\n /** Source location that produced this constraint. */\n readonly provenance: Provenance;\n}\n\n/**\n * Array uniqueness constraint.\n *\n * @beta\n */\nexport interface ArrayCardinalityConstraintNode {\n /** Discriminator identifying this node as a constraint. */\n readonly kind: \"constraint\";\n /** Specific array-cardinality constraint represented by this node. */\n readonly constraintKind: \"uniqueItems\";\n /** Marker value used for boolean-style array uniqueness constraints. */\n readonly value: true;\n /** Nested path target, when the constraint applies below the field root. */\n readonly path?: PathTarget;\n /** Source location that produced this constraint. */\n readonly provenance: Provenance;\n}\n\n/**\n * Enum member subset constraint that only narrows the allowed member set.\n *\n * @beta\n */\nexport interface EnumMemberConstraintNode {\n /** Discriminator identifying this node as a constraint. */\n readonly kind: \"constraint\";\n /** Specific enum-membership constraint represented by this node. */\n readonly constraintKind: \"allowedMembers\";\n /** Subset of enum member values that remain valid. */\n readonly members: readonly (string | number)[];\n /** Nested path target, when the constraint applies below the field root. */\n readonly path?: PathTarget;\n /** Source location that produced this constraint. */\n readonly provenance: Provenance;\n}\n\n/**\n * Literal-value equality constraint.\n *\n * @beta\n */\nexport interface ConstConstraintNode {\n /** Discriminator identifying this node as a constraint. */\n readonly kind: \"constraint\";\n /** Specific literal-equality constraint represented by this node. */\n readonly constraintKind: \"const\";\n /** JSON-serializable literal value the field must equal. */\n readonly value: JsonValue;\n /** Nested path target, when the constraint applies below the field root. */\n readonly path?: PathTarget;\n /** Source location that produced this constraint. */\n readonly provenance: Provenance;\n}\n\n/**\n * Extension-registered custom constraint.\n *\n * @beta\n */\nexport interface CustomConstraintNode {\n /** Discriminator identifying this node as a constraint. */\n readonly kind: \"constraint\";\n /** Specific custom-constraint marker used for extension nodes. */\n readonly constraintKind: \"custom\";\n /** Extension-qualified ID: `\"<vendor-prefix>/<extension-name>/<constraint-name>\"` */\n readonly constraintId: string;\n /** JSON-serializable payload defined by the extension. */\n readonly payload: JsonValue;\n /** How this constraint composes with others of the same `constraintId`. */\n readonly compositionRule: \"intersect\" | \"override\";\n /** Nested path target, when the constraint applies below the field root. */\n readonly path?: PathTarget;\n /** Source location that produced this constraint. */\n readonly provenance: Provenance;\n}\n\n// =============================================================================\n// ANNOTATION NODES\n// =============================================================================\n\n/**\n * Discriminated union of all annotation types.\n * Annotations are value-influencing: they describe or present a field\n * but do not affect which values are valid.\n *\n * @beta\n */\nexport type AnnotationNode =\n | DisplayNameAnnotationNode\n | DescriptionAnnotationNode\n | RemarksAnnotationNode\n | FormatAnnotationNode\n | PlaceholderAnnotationNode\n | DefaultValueAnnotationNode\n | DeprecatedAnnotationNode\n | FormatHintAnnotationNode\n | CustomAnnotationNode;\n\n/**\n * Display-name annotation.\n *\n * @beta\n */\nexport interface DisplayNameAnnotationNode {\n /** Discriminator identifying this node as an annotation. */\n readonly kind: \"annotation\";\n /** Specific annotation kind represented by this node. */\n readonly annotationKind: \"displayName\";\n /** Human-readable display label for the field or type. */\n readonly value: string;\n /** Source location that produced this annotation. */\n readonly provenance: Provenance;\n}\n\n/**\n * Description annotation.\n *\n * @beta\n */\nexport interface DescriptionAnnotationNode {\n /** Discriminator identifying this node as an annotation. */\n readonly kind: \"annotation\";\n /** Specific annotation kind represented by this node. */\n readonly annotationKind: \"description\";\n /** Description text surfaced in generated schemas and tooling. */\n readonly value: string;\n /** Source location that produced this annotation. */\n readonly provenance: Provenance;\n}\n\n/**\n * Remarks annotation — programmatic-persona documentation carried via\n * the `x-<vendor>-remarks` JSON Schema extension keyword.\n *\n * Populated from `@remarks` TSDoc tag content. SDK codegen can include\n * this in doc comments; API Documenter renders the source `@remarks`\n * natively in a dedicated Remarks section.\n *\n * @beta\n */\nexport interface RemarksAnnotationNode {\n /** Discriminator identifying this node as an annotation. */\n readonly kind: \"annotation\";\n /** Specific annotation kind represented by this node. */\n readonly annotationKind: \"remarks\";\n /** Long-form remarks content carried through canonicalization. */\n readonly value: string;\n /** Source location that produced this annotation. */\n readonly provenance: Provenance;\n}\n\n/**\n * Schema format annotation, for example `email`, `date`, or `uri`.\n *\n * @beta\n */\nexport interface FormatAnnotationNode {\n /** Discriminator identifying this node as an annotation. */\n readonly kind: \"annotation\";\n /** Specific annotation kind represented by this node. */\n readonly annotationKind: \"format\";\n /** Schema format keyword value to emit downstream. */\n readonly value: string;\n /** Source location that produced this annotation. */\n readonly provenance: Provenance;\n}\n\n/**\n * Placeholder annotation.\n *\n * @beta\n */\nexport interface PlaceholderAnnotationNode {\n /** Discriminator identifying this node as an annotation. */\n readonly kind: \"annotation\";\n /** Specific annotation kind represented by this node. */\n readonly annotationKind: \"placeholder\";\n /** Placeholder text intended for UI renderers. */\n readonly value: string;\n /** Source location that produced this annotation. */\n readonly provenance: Provenance;\n}\n\n/**\n * Default-value annotation.\n *\n * @beta\n */\nexport interface DefaultValueAnnotationNode {\n /** Discriminator identifying this node as an annotation. */\n readonly kind: \"annotation\";\n /** Specific annotation kind represented by this node. */\n readonly annotationKind: \"defaultValue\";\n /** Must be JSON-serializable and type-compatible (verified during Validate phase). */\n readonly value: JsonValue;\n /** Source location that produced this annotation. */\n readonly provenance: Provenance;\n}\n\n/**\n * Deprecated annotation.\n *\n * @beta\n */\nexport interface DeprecatedAnnotationNode {\n /** Discriminator identifying this node as an annotation. */\n readonly kind: \"annotation\";\n /** Specific annotation kind represented by this node. */\n readonly annotationKind: \"deprecated\";\n /** Optional deprecation message. */\n readonly message?: string;\n /** Source location that produced this annotation. */\n readonly provenance: Provenance;\n}\n\n/**\n * UI rendering hint — does not affect schema validation.\n * Unlike FormatAnnotationNode, this never emits a JSON Schema `format`.\n *\n * @beta\n */\nexport interface FormatHintAnnotationNode {\n /** Discriminator identifying this node as an annotation. */\n readonly kind: \"annotation\";\n /** Specific annotation kind represented by this node. */\n readonly annotationKind: \"formatHint\";\n /** Renderer-specific format identifier: \"textarea\", \"radio\", \"date\", \"color\", etc. */\n readonly format: string;\n /** Source location that produced this annotation. */\n readonly provenance: Provenance;\n}\n\n/**\n * Extension-registered custom annotation.\n *\n * @beta\n */\nexport interface CustomAnnotationNode {\n /** Discriminator identifying this node as an annotation. */\n readonly kind: \"annotation\";\n /** Specific annotation kind represented by this node. */\n readonly annotationKind: \"custom\";\n /** Extension-qualified ID: `\"<vendor-prefix>/<extension-name>/<annotation-name>\"` */\n readonly annotationId: string;\n /** JSON-serializable extension payload carried by this annotation. */\n readonly value: JsonValue;\n /** Source location that produced this annotation. */\n readonly provenance: Provenance;\n}\n\n// =============================================================================\n// FIELD NODE\n// =============================================================================\n\n/**\n * A single form field after canonicalization.\n *\n * @beta\n */\nexport interface FieldNode {\n /** Discriminator identifying this node as a field. */\n readonly kind: \"field\";\n /** The field's key in the data schema. */\n readonly name: string;\n /** The resolved type of this field. */\n readonly type: TypeNode;\n /** Whether this field is required in the data schema. */\n readonly required: boolean;\n /** Set-influencing constraints, after merging. */\n readonly constraints: readonly ConstraintNode[];\n /** Value-influencing annotations, after merging. */\n readonly annotations: readonly AnnotationNode[];\n /** Where this field was declared. */\n readonly provenance: Provenance;\n /**\n * Debug only — ordered list of constraint/annotation nodes that participated\n * in merging, including dominated ones.\n */\n readonly mergeHistory?: readonly {\n readonly node: ConstraintNode | AnnotationNode;\n readonly dominated: boolean;\n }[];\n}\n\n// =============================================================================\n// LAYOUT NODES\n// =============================================================================\n\n/**\n * Union of layout node types.\n *\n * @beta\n */\nexport type LayoutNode = GroupLayoutNode | ConditionalLayoutNode;\n\n/**\n * A visual grouping of form elements.\n *\n * @beta\n */\nexport interface GroupLayoutNode {\n /** Discriminator identifying this node as a group layout. */\n readonly kind: \"group\";\n /** Display label associated with the visual group. */\n readonly label: string;\n /** Elements contained in this group — may be fields or nested groups. */\n readonly elements: readonly FormIRElement[];\n /** Source location that produced this layout node. */\n readonly provenance: Provenance;\n}\n\n/**\n * Conditional visibility based on another field's value.\n *\n * @beta\n */\nexport interface ConditionalLayoutNode {\n /** Discriminator identifying this node as a conditional layout. */\n readonly kind: \"conditional\";\n /** The field whose value triggers visibility. */\n readonly fieldName: string;\n /** The value that makes the condition true (SHOW). */\n readonly value: JsonValue;\n /** Elements shown when the condition is met. */\n readonly elements: readonly FormIRElement[];\n /** Source location that produced this layout node. */\n readonly provenance: Provenance;\n}\n\n/**\n * Union of all IR element types.\n *\n * @beta\n */\nexport type FormIRElement = FieldNode | LayoutNode;\n\n// =============================================================================\n// TYPE REGISTRY\n// =============================================================================\n\n/**\n * A named type definition stored in the type registry.\n *\n * @beta\n */\nexport interface TypeDefinition {\n /** The fully-qualified reference name (key in the registry). */\n readonly name: string;\n /** The resolved type node. */\n readonly type: TypeNode;\n /** Constraints declared on the named type itself. */\n readonly constraints?: readonly ConstraintNode[];\n /** Root-level value metadata for a named type definition. */\n readonly annotations?: readonly AnnotationNode[];\n /** Where this type was declared. */\n readonly provenance: Provenance;\n}\n\n// =============================================================================\n// FORM IR (TOP-LEVEL)\n// =============================================================================\n\n/**\n * The complete Canonical Intermediate Representation for a form.\n *\n * Output of the Canonicalize phase; input to Validate, Generate (JSON Schema),\n * and Generate (UI Schema) phases.\n *\n * Serializable to JSON — no live compiler objects.\n *\n * @beta\n */\nexport interface FormIR {\n /** Discriminator identifying this document as a top-level FormIR payload. */\n readonly kind: \"form-ir\";\n /**\n * Schema version for the IR format itself.\n * Should equal `IR_VERSION`.\n */\n readonly irVersion: string;\n /** Top-level elements of the form: fields and layout nodes. */\n readonly elements: readonly FormIRElement[];\n /** Root-level annotations derived from the source declaration itself. */\n readonly rootAnnotations?: readonly AnnotationNode[];\n /**\n * Registry of named types referenced by fields in this form.\n * Keys are fully-qualified type names matching `ReferenceTypeNode.name`.\n */\n readonly typeRegistry: Readonly<Record<string, TypeDefinition>>;\n /** Root-level metadata for the form itself. */\n readonly annotations?: readonly AnnotationNode[];\n /** Provenance of the form definition itself. */\n readonly provenance: Provenance;\n}\n","/**\n * Extension API for registering custom types, constraints, annotations,\n * and vocabulary keywords with FormSpec.\n *\n * Extensions allow third-party packages (e.g., \"Decimal\", \"DateOnly\") to\n * plug into the FormSpec pipeline. The types and factory functions defined\n * here are consumed by the FormSpec build pipeline.\n *\n * @packageDocumentation\n */\n\nimport type { BuiltinConstraintName } from \"../types/constraint-definitions.js\";\n\n// =============================================================================\n// REGISTRATION TYPES\n// =============================================================================\n\n/**\n * A JSON-serializable payload value used by extension registration hooks.\n *\n * @public\n */\nexport type ExtensionPayloadValue =\n | null\n | boolean\n | number\n | string\n | readonly ExtensionPayloadValue[]\n | { readonly [key: string]: ExtensionPayloadValue };\n\n/**\n * Top-level type kinds that extension applicability hooks may inspect.\n *\n * @public\n */\nexport type ExtensionTypeKind =\n | \"primitive\"\n | \"enum\"\n | \"array\"\n | \"object\"\n | \"record\"\n | \"union\"\n | \"reference\"\n | \"dynamic\"\n | \"custom\";\n\n/**\n * A curated type shape exposed to extension applicability hooks.\n *\n * This intentionally exposes only the fields needed to determine tag/type\n * applicability without committing the entire canonical IR as public API.\n *\n * @public\n */\nexport type ExtensionApplicableType =\n | {\n readonly kind: \"primitive\";\n readonly primitiveKind: \"string\" | \"number\" | \"integer\" | \"bigint\" | \"boolean\" | \"null\";\n }\n | {\n readonly kind: \"custom\";\n readonly typeId: string;\n readonly payload: ExtensionPayloadValue;\n }\n | { readonly kind: Exclude<ExtensionTypeKind, \"primitive\" | \"custom\"> };\n\n/**\n * Registration for a custom type that maps to a JSON Schema representation.\n *\n * Custom types are referenced by FormSpec's internal custom-type IR nodes and\n * resolved to JSON Schema via `toJsonSchema` during generation.\n *\n * @public\n */\nexport interface CustomTypeRegistration {\n /** The type name, unique within the extension. */\n readonly typeName: string;\n /**\n * Optional TypeScript surface names that should resolve to this custom type\n * during TSDoc/class analysis. Defaults to `typeName` when omitted.\n */\n readonly tsTypeNames?: readonly string[];\n /**\n * Converts the custom type's payload into a JSON Schema fragment.\n *\n * @param payload - The opaque JSON payload stored on the custom type node.\n * @param vendorPrefix - The vendor prefix for extension keywords (e.g., \"x-stripe\").\n * @returns A JSON Schema fragment representing this type.\n */\n readonly toJsonSchema: (\n payload: ExtensionPayloadValue,\n vendorPrefix: string\n ) => Record<string, unknown>;\n /**\n * Optional broadening of built-in constraint tags so they can apply to this\n * custom type without modifying the core built-in constraint tables.\n */\n readonly builtinConstraintBroadenings?: readonly BuiltinConstraintBroadeningRegistration[];\n}\n\n/**\n * Registration for a custom constraint that maps to JSON Schema keywords.\n *\n * Custom constraints are referenced by FormSpec's internal custom-constraint nodes.\n *\n * @public\n */\nexport interface CustomConstraintRegistration {\n /** The constraint name, unique within the extension. */\n readonly constraintName: string;\n /**\n * How this constraint composes with other constraints of the same kind.\n * - \"intersect\": combine with logical AND (both must hold)\n * - \"override\": last writer wins\n */\n readonly compositionRule: \"intersect\" | \"override\";\n /**\n * TypeNode kinds this constraint is applicable to, or `null` for any type.\n * Used by the validator to emit TYPE_MISMATCH diagnostics.\n */\n readonly applicableTypes: readonly ExtensionApplicableType[\"kind\"][] | null;\n /**\n * Optional precise type predicate used when kind-level applicability is too\n * broad (for example, constraints that apply to integer-like primitives but\n * not strings).\n */\n readonly isApplicableToType?: (type: ExtensionApplicableType) => boolean;\n /**\n * Optional comparator for payloads belonging to the same custom constraint.\n * Return values follow the `Array.prototype.sort()` contract.\n */\n readonly comparePayloads?: (left: ExtensionPayloadValue, right: ExtensionPayloadValue) => number;\n /**\n * Optional semantic family metadata for generic contradiction/broadening\n * handling across ordered constraints.\n */\n readonly semanticRole?: ConstraintSemanticRole;\n /**\n * Converts the custom constraint's payload into JSON Schema keywords.\n *\n * @param payload - The opaque JSON payload stored on the custom constraint node.\n * @param vendorPrefix - The vendor prefix for extension keywords.\n * @returns A JSON Schema fragment with the constraint keywords.\n */\n readonly toJsonSchema: (\n payload: ExtensionPayloadValue,\n vendorPrefix: string\n ) => Record<string, unknown>;\n}\n\n/**\n * Registration for a custom annotation that may produce JSON Schema keywords.\n *\n * Custom annotations are referenced by FormSpec's internal custom-annotation nodes.\n * They describe or present a field but do not affect which values are valid.\n *\n * @public\n */\nexport interface CustomAnnotationRegistration {\n /** The annotation name, unique within the extension. */\n readonly annotationName: string;\n /**\n * Optionally converts the annotation value into JSON Schema keywords.\n * If omitted, the annotation has no JSON Schema representation (UI-only).\n */\n readonly toJsonSchema?: (\n value: ExtensionPayloadValue,\n vendorPrefix: string\n ) => Record<string, unknown>;\n}\n\n/**\n * Registration for a vocabulary keyword to include in a JSON Schema `$vocabulary` declaration.\n *\n * @public\n */\nexport interface VocabularyKeywordRegistration {\n /** The keyword name (without vendor prefix). */\n readonly keyword: string;\n /** JSON Schema that describes the valid values for this keyword. */\n readonly schema: ExtensionPayloadValue;\n}\n\n/**\n * Declarative authoring-side registration for a custom TSDoc constraint tag.\n *\n * @public\n */\nexport interface ConstraintTagRegistration {\n /** Tag name without the `@` prefix, e.g. `\"maxSigFig\"`. */\n readonly tagName: string;\n /** The custom constraint that this tag should produce. */\n readonly constraintName: string;\n /** Parser from raw TSDoc text to JSON-serializable payload. */\n readonly parseValue: (raw: string) => ExtensionPayloadValue;\n /**\n * Optional precise applicability predicate for the field type being parsed.\n * When omitted, the target custom constraint registration controls type\n * applicability during validation.\n */\n readonly isApplicableToType?: (type: ExtensionApplicableType) => boolean;\n}\n\n/**\n * Registration for mapping a built-in TSDoc tag onto a custom constraint when\n * it is used on a particular custom type.\n *\n * @public\n */\nexport interface BuiltinConstraintBroadeningRegistration {\n /** The built-in tag being broadened, without the `@` prefix. */\n readonly tagName: BuiltinConstraintName;\n /** The custom constraint to emit for this built-in tag. */\n readonly constraintName: string;\n /** Parser from raw TSDoc text to extension payload. */\n readonly parseValue: (raw: string) => ExtensionPayloadValue;\n}\n\n/**\n * Semantic metadata for ordered custom constraints that should participate in\n * the generic contradiction/broadening logic.\n *\n * @public\n */\nexport interface ConstraintSemanticRole {\n /**\n * Logical family identifier shared by related constraints, for example\n * `\"decimal-bound\"` or `\"date-bound\"`.\n */\n readonly family: string;\n /** Whether this constraint acts as a lower or upper bound. */\n readonly bound: \"lower\" | \"upper\" | \"exact\";\n /** Whether equality is allowed when comparing against the bound. */\n readonly inclusive: boolean;\n}\n\n// =============================================================================\n// EXTENSION DEFINITION\n// =============================================================================\n\n/**\n * A complete extension definition bundling types, constraints, annotations,\n * and vocabulary keywords.\n *\n * @example\n * ```typescript\n * const monetaryExtension = defineExtension({\n * extensionId: \"x-stripe/monetary\",\n * types: [\n * defineCustomType({\n * typeName: \"Decimal\",\n * toJsonSchema: (_payload, prefix) => ({\n * type: \"string\",\n * [`${prefix}-decimal`]: true,\n * }),\n * }),\n * ],\n * });\n * ```\n *\n * @public\n */\nexport interface ExtensionDefinition {\n /** Globally unique extension identifier, e.g., \"x-stripe/monetary\". */\n readonly extensionId: string;\n /** Custom type registrations provided by this extension. */\n readonly types?: readonly CustomTypeRegistration[];\n /** Custom constraint registrations provided by this extension. */\n readonly constraints?: readonly CustomConstraintRegistration[];\n /** Authoring-side TSDoc tag registrations provided by this extension. */\n readonly constraintTags?: readonly ConstraintTagRegistration[];\n /** Custom annotation registrations provided by this extension. */\n readonly annotations?: readonly CustomAnnotationRegistration[];\n /** Vocabulary keyword registrations provided by this extension. */\n readonly vocabularyKeywords?: readonly VocabularyKeywordRegistration[];\n}\n\n// =============================================================================\n// FACTORY FUNCTIONS\n// =============================================================================\n\n/**\n * Defines a complete extension. Currently an identity function that provides\n * type-checking and IDE autocompletion for the definition shape.\n *\n * @param def - The extension definition.\n * @returns The same definition, validated at the type level.\n *\n * @public\n */\nexport function defineExtension(def: ExtensionDefinition): ExtensionDefinition {\n return def;\n}\n\n/**\n * Defines a custom type registration. Currently an identity function that\n * provides type-checking and IDE autocompletion.\n *\n * @param reg - The custom type registration.\n * @returns The same registration, validated at the type level.\n *\n * @public\n */\nexport function defineCustomType(reg: CustomTypeRegistration): CustomTypeRegistration {\n return reg;\n}\n\n/**\n * Defines a custom constraint registration. Currently an identity function\n * that provides type-checking and IDE autocompletion.\n *\n * @param reg - The custom constraint registration.\n * @returns The same registration, validated at the type level.\n *\n * @public\n */\nexport function defineConstraint(reg: CustomConstraintRegistration): CustomConstraintRegistration {\n return reg;\n}\n\n/**\n * Defines a custom TSDoc constraint tag registration.\n *\n * @param reg - The custom tag registration.\n * @returns The same registration, validated at the type level.\n *\n * @public\n */\nexport function defineConstraintTag(reg: ConstraintTagRegistration): ConstraintTagRegistration {\n return reg;\n}\n\n/**\n * Defines a custom annotation registration. Currently an identity function\n * that provides type-checking and IDE autocompletion.\n *\n * @param reg - The custom annotation registration.\n * @returns The same registration, validated at the type level.\n *\n * @public\n */\nexport function defineAnnotation(reg: CustomAnnotationRegistration): CustomAnnotationRegistration {\n return reg;\n}\n","/**\n * Type guards for FormSpec form elements.\n *\n * Each guard narrows a {@link FormElement} to a specific field, group, or conditional type.\n */\n\nimport type {\n FormElement,\n AnyField,\n TextField,\n NumberField,\n BooleanField,\n StaticEnumField,\n DynamicEnumField,\n DynamicSchemaField,\n ArrayField,\n ObjectField,\n Group,\n Conditional,\n EnumOptionValue,\n} from \"./types/elements.js\";\n\n/**\n * Narrows a `FormElement` to any field type.\n *\n * @public\n */\nexport function isField(element: FormElement): element is AnyField {\n return element._type === \"field\";\n}\n\n/**\n * Narrows a `FormElement` to a text input field.\n *\n * @public\n */\nexport function isTextField(element: FormElement): element is TextField<string> {\n return element._type === \"field\" && element._field === \"text\";\n}\n\n/**\n * Narrows a `FormElement` to a numeric input field.\n *\n * @public\n */\nexport function isNumberField(element: FormElement): element is NumberField<string> {\n return element._type === \"field\" && element._field === \"number\";\n}\n\n/**\n * Narrows a `FormElement` to a boolean checkbox field.\n *\n * @public\n */\nexport function isBooleanField(element: FormElement): element is BooleanField<string> {\n return element._type === \"field\" && element._field === \"boolean\";\n}\n\n/**\n * Narrows a `FormElement` to a static enum field.\n *\n * @public\n */\nexport function isStaticEnumField(\n element: FormElement\n): element is StaticEnumField<string, readonly EnumOptionValue[]> {\n return element._type === \"field\" && element._field === \"enum\";\n}\n\n/**\n * Narrows a `FormElement` to a dynamic enum field.\n *\n * @public\n */\nexport function isDynamicEnumField(\n element: FormElement\n): element is DynamicEnumField<string, string> {\n return element._type === \"field\" && element._field === \"dynamic_enum\";\n}\n\n/**\n * Narrows a `FormElement` to a dynamic schema field.\n *\n * @public\n */\nexport function isDynamicSchemaField(element: FormElement): element is DynamicSchemaField<string> {\n return element._type === \"field\" && element._field === \"dynamic_schema\";\n}\n\n/**\n * Narrows a `FormElement` to an array field.\n *\n * @public\n */\nexport function isArrayField(\n element: FormElement\n): element is ArrayField<string, readonly FormElement[]> {\n return element._type === \"field\" && element._field === \"array\";\n}\n\n/**\n * Narrows a `FormElement` to an object field.\n *\n * @public\n */\nexport function isObjectField(\n element: FormElement\n): element is ObjectField<string, readonly FormElement[]> {\n return element._type === \"field\" && element._field === \"object\";\n}\n\n/**\n * Narrows a `FormElement` to a visual group.\n *\n * @public\n */\nexport function isGroup(element: FormElement): element is Group<readonly FormElement[]> {\n return element._type === \"group\";\n}\n\n/**\n * Narrows a `FormElement` to a conditional wrapper.\n *\n * @public\n */\nexport function isConditional(\n element: FormElement\n): element is Conditional<string, unknown, readonly FormElement[]> {\n return element._type === \"conditional\";\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACmCO,SAAS,wBAA2B,OAAyB;AAClE,SAAO;AAAA,IACL;AAAA,IACA,OAAO;AAAA,IACP,SAAS;AAAA,IACT,UAAU;AAAA,IACV,QAAQ,CAAC;AAAA,EACX;AACF;;;ACpBO,IAAM,aAAa;;;AC2QnB,SAAS,gBAAgB,KAA+C;AAC7E,SAAO;AACT;AAWO,SAAS,iBAAiB,KAAqD;AACpF,SAAO;AACT;AAWO,SAAS,iBAAiB,KAAiE;AAChG,SAAO;AACT;AAUO,SAAS,oBAAoB,KAA2D;AAC7F,SAAO;AACT;AAWO,SAAS,iBAAiB,KAAiE;AAChG,SAAO;AACT;;;AC5TO,SAAS,QAAQ,SAA2C;AACjE,SAAO,QAAQ,UAAU;AAC3B;AAOO,SAAS,YAAY,SAAoD;AAC9E,SAAO,QAAQ,UAAU,WAAW,QAAQ,WAAW;AACzD;AAOO,SAAS,cAAc,SAAsD;AAClF,SAAO,QAAQ,UAAU,WAAW,QAAQ,WAAW;AACzD;AAOO,SAAS,eAAe,SAAuD;AACpF,SAAO,QAAQ,UAAU,WAAW,QAAQ,WAAW;AACzD;AAOO,SAAS,kBACd,SACgE;AAChE,SAAO,QAAQ,UAAU,WAAW,QAAQ,WAAW;AACzD;AAOO,SAAS,mBACd,SAC6C;AAC7C,SAAO,QAAQ,UAAU,WAAW,QAAQ,WAAW;AACzD;AAOO,SAAS,qBAAqB,SAA6D;AAChG,SAAO,QAAQ,UAAU,WAAW,QAAQ,WAAW;AACzD;AAOO,SAAS,aACd,SACuD;AACvD,SAAO,QAAQ,UAAU,WAAW,QAAQ,WAAW;AACzD;AAOO,SAAS,cACd,SACwD;AACxD,SAAO,QAAQ,UAAU,WAAW,QAAQ,WAAW;AACzD;AAOO,SAAS,QAAQ,SAAgE;AACtF,SAAO,QAAQ,UAAU;AAC3B;AAOO,SAAS,cACd,SACiE;AACjE,SAAO,QAAQ,UAAU;AAC3B;","names":[]}