@formspec/core 0.1.0-alpha.2 → 0.1.0-alpha.9

package/README.md

@@ -0,0 +1,111 @@
+# @formspec/core
+
+Core type definitions for the FormSpec library.
+
+## Installation
+
+```bash
+npm install @formspec/core
+# or
+pnpm add @formspec/core
+```
+
+> **Note:** Most users should install the `formspec` umbrella package instead, which re-exports everything from this package.
+
+## Requirements
+
+This package is ESM-only and requires:
+
+```json
+// package.json
+{
+  "type": "module"
+}
+```
+
+```json
+// tsconfig.json
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext"
+  }
+}
+```
+
+## Overview
+
+This package provides the foundational types used throughout the FormSpec ecosystem:
+
+- **Form element types**: `TextField`, `NumberField`, `BooleanField`, `StaticEnumField`, `DynamicEnumField`, `ArrayField`, `ObjectField`
+- **Structural types**: `Group`, `Conditional`, `FormElement`, `FormSpec`
+- **State types**: `FieldState`, `FormState`, `Validity`
+- **Data source types**: `DataSourceRegistry`, `DataSourceOption`, `FetchOptionsResponse`
+- **Predicate types**: `EqualsPredicate`, `Predicate`
+
+## Usage
+
+```typescript
+import type {
+  FormSpec,
+  FormElement,
+  TextField,
+  NumberField,
+  AnyField,
+  Group,
+  Conditional,
+} from "@formspec/core";
+
+// Type guard for field elements
+function isField(element: FormElement): element is AnyField {
+  return element._type === "field";
+}
+
+// Process form elements
+function processForm(form: FormSpec<readonly FormElement[]>) {
+  for (const element of form.elements) {
+    if (isField(element)) {
+      console.log(`Field: ${element.name} (${element._field})`);
+    } else if (element._type === "group") {
+      console.log(`Group: ${element.label}`);
+    }
+  }
+}
+```
+
+## Type Reference
+
+### Field Types
+
+| Type                 | Description                                 |
+| -------------------- | ------------------------------------------- |
+| `TextField`          | Text input field                            |
+| `NumberField`        | Numeric input field                         |
+| `BooleanField`       | Boolean/checkbox field                      |
+| `StaticEnumField`    | Dropdown with static options                |
+| `DynamicEnumField`   | Dropdown with dynamic options from resolver |
+| `DynamicSchemaField` | Field with dynamic schema from resolver     |
+| `ArrayField`         | Array of nested elements                    |
+| `ObjectField`        | Nested object with child fields             |
+| `AnyField`           | Union of all field types                    |
+
+### Structural Types
+
+| Type          | Description                                 |
+| ------------- | ------------------------------------------- |
+| `Group`       | Groups related fields with a label          |
+| `Conditional` | Shows fields based on predicate             |
+| `FormElement` | Union of `AnyField`, `Group`, `Conditional` |
+| `FormSpec<E>` | Complete form specification                 |
+
+### State Types
+
+| Type            | Description                         |
+| --------------- | ----------------------------------- |
+| `Validity`      | `"valid"`, `"invalid"`, `"unknown"` |
+| `FieldState<T>` | Runtime state of a single field     |
+| `FormState<S>`  | Runtime state of entire form        |
+
+## License
+
+UNLICENSED

package/dist/core.d.ts

@@ -0,0 +1,430 @@
+/**
+ * `@formspec/core` - Core type definitions for FormSpec
+ *
+ * This package provides the foundational types used throughout the FormSpec ecosystem:
+ * - Form element types (fields, groups, conditionals)
+ * - Field and form state types
+ * - Data source registry for dynamic enums
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * Union of all field types.
+ */
+export declare type AnyField = TextField<string> | NumberField<string> | BooleanField<string> | StaticEnumField<string, readonly EnumOptionValue[]> | DynamicEnumField<string, string> | DynamicSchemaField<string> | ArrayField<string, readonly FormElement[]> | ObjectField<string, readonly FormElement[]>;
+
+/**
+ * An array field containing repeating items.
+ *
+ * Use this for lists of values (e.g., multiple addresses, line items).
+ *
+ * @typeParam N - The field name (string literal type)
+ * @typeParam Items - The form elements that define each array item
+ */
+export declare interface ArrayField<N extends string, Items extends readonly FormElement[]> {
+    /** Type discriminator for form elements */
+    readonly _type: "field";
+    /** Field type discriminator - identifies this as an array field */
+    readonly _field: "array";
+    /** Unique field identifier used as the schema key */
+    readonly name: N;
+    /** Form elements that define the schema for each array item */
+    readonly items: Items;
+    /** Display label for the field */
+    readonly label?: string;
+    /** Whether this field is required for form submission */
+    readonly required?: boolean;
+    /** Minimum number of items required */
+    readonly minItems?: number;
+    /** Maximum number of items allowed */
+    readonly maxItems?: number;
+}
+
+/**
+ * A boolean checkbox field.
+ *
+ * @typeParam N - The field name (string literal type)
+ */
+export declare interface BooleanField<N extends string> {
+    /** Type discriminator for form elements */
+    readonly _type: "field";
+    /** Field type discriminator - identifies this as a boolean field */
+    readonly _field: "boolean";
+    /** Unique field identifier used as the schema key */
+    readonly name: N;
+    /** Display label for the field */
+    readonly label?: string;
+    /** Whether this field is required for form submission */
+    readonly required?: boolean;
+}
+
+/**
+ * A conditional wrapper that shows/hides elements based on another field's value.
+ *
+ * @typeParam FieldName - The field to check
+ * @typeParam Value - The value that triggers the condition
+ * @typeParam Elements - Tuple of contained form elements
+ */
+export declare interface Conditional<FieldName extends string, Value, Elements extends readonly FormElement[]> {
+    /** Type discriminator - identifies this as a conditional element */
+    readonly _type: "conditional";
+    /** Name of the field whose value determines visibility */
+    readonly field: FieldName;
+    /** Value that triggers the condition (shows nested elements) */
+    readonly value: Value;
+    /** Form elements shown when condition is met */
+    readonly elements: Elements;
+}
+
+/**
+ * Constraint decorator names that are valid as TSDoc tags, mapped to
+ * their expected value type for parsing.
+ *
+ * Both `@formspec/build` (schema generation) and `@formspec/eslint-plugin`
+ * (lint-time validation) import this to determine which JSDoc tags to
+ * recognize and how to parse their values.
+ */
+export declare const CONSTRAINT_TAG_DEFINITIONS: {
+    readonly Minimum: "number";
+    readonly Maximum: "number";
+    readonly ExclusiveMinimum: "number";
+    readonly ExclusiveMaximum: "number";
+    readonly MinLength: "number";
+    readonly MaxLength: "number";
+    readonly Pattern: "string";
+};
+
+/** Type of a constraint tag name. */
+export declare type ConstraintTagName = keyof typeof CONSTRAINT_TAG_DEFINITIONS;
+
+/**
+ * Creates initial field state with default values.
+ *
+ * @typeParam T - The value type of the field
+ * @param value - The initial value for the field
+ * @returns Initial field state
+ */
+export declare function createInitialFieldState<T>(value: T): FieldState<T>;
+
+/**
+ * A single option returned by a data source resolver.
+ *
+ * @typeParam T - The data type for additional option metadata
+ */
+export declare interface DataSourceOption<T = unknown> {
+    /** The value stored when this option is selected */
+    readonly value: string;
+    /** The display label for this option */
+    readonly label: string;
+    /** Optional additional data associated with this option */
+    readonly data?: T;
+}
+
+/**
+ * Registry for dynamic data sources.
+ *
+ * Extend this interface via module augmentation to register your data sources:
+ *
+ * @example
+ * ```typescript
+ * declare module "@formspec/core" {
+ *   interface DataSourceRegistry {
+ *     countries: { id: string; code: string; name: string };
+ *     templates: { id: string; name: string; category: string };
+ *   }
+ * }
+ * ```
+ */
+export declare interface DataSourceRegistry {
+}
+
+/**
+ * Gets the value type for a registered data source.
+ *
+ * If the source has an `id` property, that becomes the value type.
+ * Otherwise, defaults to `string`.
+ */
+export declare type DataSourceValueType<Source extends string> = Source extends keyof DataSourceRegistry ? DataSourceRegistry[Source] extends {
+    id: infer ID;
+} ? ID : string : string;
+
+/**
+ * A field with dynamic enum options (fetched from a data source at runtime).
+ *
+ * @typeParam N - The field name (string literal type)
+ * @typeParam Source - The data source key (from DataSourceRegistry)
+ */
+export declare interface DynamicEnumField<N extends string, Source extends string> {
+    /** Type discriminator for form elements */
+    readonly _type: "field";
+    /** Field type discriminator - identifies this as a dynamic enum field */
+    readonly _field: "dynamic_enum";
+    /** Unique field identifier used as the schema key */
+    readonly name: N;
+    /** Data source key for fetching options at runtime */
+    readonly source: Source;
+    /** Display label for the field */
+    readonly label?: string;
+    /** Whether this field is required for form submission */
+    readonly required?: boolean;
+    /** Field names whose values are needed to fetch options */
+    readonly params?: readonly string[];
+}
+
+/**
+ * A field that loads its schema dynamically (e.g., from an extension).
+ *
+ * @typeParam N - The field name (string literal type)
+ */
+export declare interface DynamicSchemaField<N extends string> {
+    /** Type discriminator for form elements */
+    readonly _type: "field";
+    /** Field type discriminator - identifies this as a dynamic schema field */
+    readonly _field: "dynamic_schema";
+    /** Unique field identifier used as the schema key */
+    readonly name: N;
+    /** Identifier for the schema source */
+    readonly schemaSource: string;
+    /** Display label for the field */
+    readonly label?: string;
+    /** Whether this field is required for form submission */
+    readonly required?: boolean;
+}
+
+/**
+ * An enum option with a separate ID and display label.
+ *
+ * Use this when the stored value (id) should differ from the display text (label).
+ */
+export declare interface EnumOption {
+    readonly id: string;
+    readonly label: string;
+}
+
+/**
+ * Valid enum option types: either plain strings or objects with id/label.
+ */
+export declare type EnumOptionValue = string | EnumOption;
+
+/**
+ * Predicate types for conditional logic.
+ *
+ * Predicates are used with `when()` to define conditions in a readable way.
+ */
+/**
+ * An equality predicate that checks if a field equals a specific value.
+ *
+ * @typeParam K - The field name to check
+ * @typeParam V - The value to compare against
+ */
+export declare interface EqualsPredicate<K extends string, V> {
+    /** Predicate type discriminator */
+    readonly _predicate: "equals";
+    /** Name of the field to check */
+    readonly field: K;
+    /** Value that the field must equal */
+    readonly value: V;
+}
+
+/**
+ * Response from a data source resolver function.
+ *
+ * @typeParam T - The data type for option metadata
+ */
+export declare interface FetchOptionsResponse<T = unknown> {
+    /** The available options */
+    readonly options: readonly DataSourceOption<T>[];
+    /** Validity state of the fetch operation */
+    readonly validity: "valid" | "invalid" | "unknown";
+    /** Optional message (e.g., error description) */
+    readonly message?: string;
+}
+
+/**
+ * Represents the runtime state of a single form field.
+ *
+ * @typeParam T - The value type of the field
+ */
+export declare interface FieldState<T> {
+    /** Current value of the field */
+    readonly value: T;
+    /** Whether the field has been modified by the user */
+    readonly dirty: boolean;
+    /** Whether the field has been focused and blurred */
+    readonly touched: boolean;
+    /** Current validity state */
+    readonly validity: Validity;
+    /** Validation error messages, if any */
+    readonly errors: readonly string[];
+}
+
+/**
+ * Union of all form element types (fields and structural elements).
+ */
+export declare type FormElement = AnyField | Group<readonly FormElement[]> | Conditional<string, unknown, readonly FormElement[]>;
+
+/**
+ * A complete form specification.
+ *
+ * @typeParam Elements - Tuple of top-level form elements
+ */
+export declare interface FormSpec<Elements extends readonly FormElement[]> {
+    /** Top-level form elements */
+    readonly elements: Elements;
+}
+
+/** Names of all built-in FormSpec decorators. */
+export declare const FORMSPEC_DECORATOR_NAMES: readonly ["Field", "Group", "ShowWhen", "EnumOptions", "Minimum", "Maximum", "ExclusiveMinimum", "ExclusiveMaximum", "MinLength", "MaxLength", "Pattern"];
+
+/** Type of a FormSpec decorator name. */
+export declare type FormSpecDecoratorName = (typeof FORMSPEC_DECORATOR_NAMES)[number];
+
+/**
+ * Represents the runtime state of an entire form.
+ *
+ * @typeParam Schema - The form schema type (maps field names to value types)
+ */
+export declare interface FormState<Schema extends Record<string, unknown>> {
+    /** State for each field, keyed by field name */
+    readonly fields: {
+        readonly [K in keyof Schema]: FieldState<Schema[K]>;
+    };
+    /** Whether any field has been modified */
+    readonly dirty: boolean;
+    /** Whether the form is currently being submitted */
+    readonly submitting: boolean;
+    /** Overall form validity (derived from all field validities) */
+    readonly validity: Validity;
+}
+
+/**
+ * A visual grouping of form elements.
+ *
+ * Groups provide visual organization and can be rendered as fieldsets or sections.
+ *
+ * @typeParam Elements - Tuple of contained form elements
+ */
+export declare interface Group<Elements extends readonly FormElement[]> {
+    /** Type discriminator - identifies this as a group element */
+    readonly _type: "group";
+    /** Display label for the group */
+    readonly label: string;
+    /** Form elements contained within this group */
+    readonly elements: Elements;
+}
+
+/**
+ * A numeric input field.
+ *
+ * @typeParam N - The field name (string literal type)
+ */
+export declare interface NumberField<N extends string> {
+    /** Type discriminator for form elements */
+    readonly _type: "field";
+    /** Field type discriminator - identifies this as a number field */
+    readonly _field: "number";
+    /** Unique field identifier used as the schema key */
+    readonly name: N;
+    /** Display label for the field */
+    readonly label?: string;
+    /** Minimum allowed value */
+    readonly min?: number;
+    /** Maximum allowed value */
+    readonly max?: number;
+    /** Whether this field is required for form submission */
+    readonly required?: boolean;
+}
+
+/**
+ * An object field containing nested properties.
+ *
+ * Use this for grouping related fields under a single key in the schema.
+ *
+ * @typeParam N - The field name (string literal type)
+ * @typeParam Properties - The form elements that define the object's properties
+ */
+export declare interface ObjectField<N extends string, Properties extends readonly FormElement[]> {
+    /** Type discriminator for form elements */
+    readonly _type: "field";
+    /** Field type discriminator - identifies this as an object field */
+    readonly _field: "object";
+    /** Unique field identifier used as the schema key */
+    readonly name: N;
+    /** Form elements that define the properties of this object */
+    readonly properties: Properties;
+    /** Display label for the field */
+    readonly label?: string;
+    /** Whether this field is required for form submission */
+    readonly required?: boolean;
+}
+
+/**
+ * Union of all predicate types.
+ *
+ * Currently only supports equality, but can be extended with:
+ * - `OneOfPredicate` - field value is one of several options
+ * - `NotPredicate` - negation of another predicate
+ * - `AndPredicate` / `OrPredicate` - logical combinations
+ */
+export declare type Predicate<K extends string = string, V = unknown> = EqualsPredicate<K, V>;
+
+/**
+ * A field with static enum options (known at compile time).
+ *
+ * Options can be plain strings or objects with `id` and `label` properties.
+ *
+ * @typeParam N - The field name (string literal type)
+ * @typeParam O - Tuple of option values (strings or EnumOption objects)
+ */
+export declare interface StaticEnumField<N extends string, O extends readonly EnumOptionValue[]> {
+    /** Type discriminator for form elements */
+    readonly _type: "field";
+    /** Field type discriminator - identifies this as an enum field */
+    readonly _field: "enum";
+    /** Unique field identifier used as the schema key */
+    readonly name: N;
+    /** Array of allowed option values */
+    readonly options: O;
+    /** Display label for the field */
+    readonly label?: string;
+    /** Whether this field is required for form submission */
+    readonly required?: boolean;
+}
+
+/**
+ * Form element type definitions.
+ *
+ * These types define the structure of form specifications.
+ * The structure IS the definition - nesting implies layout and conditional logic.
+ */
+/**
+ * A text input field.
+ *
+ * @typeParam N - The field name (string literal type)
+ */
+export declare interface TextField<N extends string> {
+    /** Type discriminator for form elements */
+    readonly _type: "field";
+    /** Field type discriminator - identifies this as a text field */
+    readonly _field: "text";
+    /** Unique field identifier used as the schema key */
+    readonly name: N;
+    /** Display label for the field */
+    readonly label?: string;
+    /** Placeholder text shown when field is empty */
+    readonly placeholder?: string;
+    /** Whether this field is required for form submission */
+    readonly required?: boolean;
+}
+
+/**
+ * Represents the validity state of a field or form.
+ *
+ * - `"valid"` - All validations pass
+ * - `"invalid"` - One or more validations failed
+ * - `"unknown"` - Validation state not yet determined (e.g., async validation pending)
+ */
+export declare type Validity = "valid" | "invalid" | "unknown";
+
+export { }

package/dist/index.d.ts

@@ -8,6 +8,6 @@
  *
  * @packageDocumentation
  */
-export type { Validity, FieldState, FormState, DataSourceRegistry, DataSourceOption, FetchOptionsResponse, DataSourceValueType, TextField, NumberField, BooleanField, EnumOption, EnumOptionValue, StaticEnumField, DynamicEnumField, DynamicSchemaField, ArrayField, ObjectField, AnyField, Group, Conditional, FormElement, FormSpec, EqualsPredicate, Predicate, } from "./types/index.js";
-export { createInitialFieldState } from "./types/index.js";
+export type { Validity, FieldState, FormState, DataSourceRegistry, DataSourceOption, FetchOptionsResponse, DataSourceValueType, TextField, NumberField, BooleanField, EnumOption, EnumOptionValue, StaticEnumField, DynamicEnumField, DynamicSchemaField, ArrayField, ObjectField, AnyField, Group, Conditional, FormElement, FormSpec, EqualsPredicate, Predicate, FormSpecDecoratorName, ConstraintTagName, } from "./types/index.js";
+export { createInitialFieldState, FORMSPEC_DECORATOR_NAMES, CONSTRAINT_TAG_DEFINITIONS, } from "./types/index.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,YAAY,EAEV,QAAQ,EAGR,UAAU,EAGV,SAAS,EAGT,kBAAkB,EAClB,gBAAgB,EAChB,oBAAoB,EACpB,mBAAmB,EAGnB,SAAS,EACT,WAAW,EACX,YAAY,EACZ,UAAU,EACV,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,UAAU,EACV,WAAW,EACX,QAAQ,EACR,KAAK,EACL,WAAW,EACX,WAAW,EACX,QAAQ,EAGR,eAAe,EACf,SAAS,GACV,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,YAAY,EAEV,QAAQ,EAGR,UAAU,EAGV,SAAS,EAGT,kBAAkB,EAClB,gBAAgB,EAChB,oBAAoB,EACpB,mBAAmB,EAGnB,SAAS,EACT,WAAW,EACX,YAAY,EACZ,UAAU,EACV,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,UAAU,EACV,WAAW,EACX,QAAQ,EACR,KAAK,EACL,WAAW,EACX,WAAW,EACX,QAAQ,EAGR,eAAe,EACf,SAAS,EAGT,qBAAqB,EACrB,iBAAiB,GAClB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,0BAA0B,GAC3B,MAAM,kBAAkB,CAAC"}

package/dist/index.js

@@ -9,5 +9,5 @@
  * @packageDocumentation
  */
 // Re-export functions
-export { createInitialFieldState } from "./types/index.js";
+export { createInitialFieldState, FORMSPEC_DECORATOR_NAMES, CONSTRAINT_TAG_DEFINITIONS, } from "./types/index.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAyCH,sBAAsB;AACtB,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AA6CH,sBAAsB;AACtB,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,0BAA0B,GAC3B,MAAM,kBAAkB,CAAC"}

package/dist/types/data-source.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"data-source.d.ts","sourceRoot":"","sources":["../../src/types/data-source.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,MAAM,WAAW,kBAAkB;CAElC;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,GAAG,OAAO;IAC3C,oDAAoD;IACpD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB,wCAAwC;IACxC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB,2DAA2D;IAC3D,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC,GAAG,OAAO;IAC/C,4BAA4B;IAC5B,QAAQ,CAAC,OAAO,EAAE,SAAS,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC;IAEjD,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;IAEnD,iDAAiD;IACjD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,CAAC,MAAM,SAAS,MAAM,IACnD,MAAM,SAAS,MAAM,kBAAkB,GACnC,kBAAkB,CAAC,MAAM,CAAC,SAAS;IAAE,EAAE,EAAE,MAAM,EAAE,CAAA;CAAE,GACjD,EAAE,GACF,MAAM,GACR,MAAM,CAAC"}
+{"version":3,"file":"data-source.d.ts","sourceRoot":"","sources":["../../src/types/data-source.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,MAAM,WAAW,kBAAkB;CAElC;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,GAAG,OAAO;IAC3C,oDAAoD;IACpD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB,wCAAwC;IACxC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB,2DAA2D;IAC3D,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC,GAAG,OAAO;IAC/C,4BAA4B;IAC5B,QAAQ,CAAC,OAAO,EAAE,SAAS,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC;IAEjD,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;IAEnD,iDAAiD;IACjD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,CAAC,MAAM,SAAS,MAAM,IAAI,MAAM,SAAS,MAAM,kBAAkB,GAC5F,kBAAkB,CAAC,MAAM,CAAC,SAAS;IAAE,EAAE,EAAE,MAAM,EAAE,CAAA;CAAE,GACjD,EAAE,GACF,MAAM,GACR,MAAM,CAAC"}

package/dist/types/decorators.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Canonical set of FormSpec decorator names.
+ *
+ * This is the single source of truth for which decorators FormSpec recognizes.
+ * Both `@formspec/eslint-plugin` and `@formspec/build` import from here.
+ */
+/** Names of all built-in FormSpec decorators. */
+export declare const FORMSPEC_DECORATOR_NAMES: readonly ["Field", "Group", "ShowWhen", "EnumOptions", "Minimum", "Maximum", "ExclusiveMinimum", "ExclusiveMaximum", "MinLength", "MaxLength", "Pattern"];
+/** Type of a FormSpec decorator name. */
+export type FormSpecDecoratorName = (typeof FORMSPEC_DECORATOR_NAMES)[number];
+/**
+ * Constraint decorator names that are valid as TSDoc tags, mapped to
+ * their expected value type for parsing.
+ *
+ * Both `@formspec/build` (schema generation) and `@formspec/eslint-plugin`
+ * (lint-time validation) import this to determine which JSDoc tags to
+ * recognize and how to parse their values.
+ */
+export declare const CONSTRAINT_TAG_DEFINITIONS: {
+    readonly Minimum: "number";
+    readonly Maximum: "number";
+    readonly ExclusiveMinimum: "number";
+    readonly ExclusiveMaximum: "number";
+    readonly MinLength: "number";
+    readonly MaxLength: "number";
+    readonly Pattern: "string";
+};
+/** Type of a constraint tag name. */
+export type ConstraintTagName = keyof typeof CONSTRAINT_TAG_DEFINITIONS;
+//# sourceMappingURL=decorators.d.ts.map

package/dist/types/decorators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../src/types/decorators.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,iDAAiD;AACjD,eAAO,MAAM,wBAAwB,2JAY3B,CAAC;AAEX,yCAAyC;AACzC,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,wBAAwB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE9E;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;CAQ7B,CAAC;AAEX,qCAAqC;AACrC,MAAM,MAAM,iBAAiB,GAAG,MAAM,OAAO,0BAA0B,CAAC"}

package/dist/types/decorators.js

@@ -0,0 +1,38 @@
+/**
+ * Canonical set of FormSpec decorator names.
+ *
+ * This is the single source of truth for which decorators FormSpec recognizes.
+ * Both `@formspec/eslint-plugin` and `@formspec/build` import from here.
+ */
+/** Names of all built-in FormSpec decorators. */
+export const FORMSPEC_DECORATOR_NAMES = [
+    "Field",
+    "Group",
+    "ShowWhen",
+    "EnumOptions",
+    "Minimum",
+    "Maximum",
+    "ExclusiveMinimum",
+    "ExclusiveMaximum",
+    "MinLength",
+    "MaxLength",
+    "Pattern",
+];
+/**
+ * Constraint decorator names that are valid as TSDoc tags, mapped to
+ * their expected value type for parsing.
+ *
+ * Both `@formspec/build` (schema generation) and `@formspec/eslint-plugin`
+ * (lint-time validation) import this to determine which JSDoc tags to
+ * recognize and how to parse their values.
+ */
+export const CONSTRAINT_TAG_DEFINITIONS = {
+    Minimum: "number",
+    Maximum: "number",
+    ExclusiveMinimum: "number",
+    ExclusiveMaximum: "number",
+    MinLength: "number",
+    MaxLength: "number",
+    Pattern: "string",
+};
+//# sourceMappingURL=decorators.js.map

package/dist/types/decorators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/types/decorators.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,iDAAiD;AACjD,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACtC,OAAO;IACP,OAAO;IACP,UAAU;IACV,aAAa;IACb,SAAS;IACT,SAAS;IACT,kBAAkB;IAClB,kBAAkB;IAClB,WAAW;IACX,WAAW;IACX,SAAS;CACD,CAAC;AAKX;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,OAAO,EAAE,QAAQ;IACjB,OAAO,EAAE,QAAQ;IACjB,gBAAgB,EAAE,QAAQ;IAC1B,gBAAgB,EAAE,QAAQ;IAC1B,SAAS,EAAE,QAAQ;IACnB,SAAS,EAAE,QAAQ;IACnB,OAAO,EAAE,QAAQ;CACT,CAAC"}

package/dist/types/index.d.ts

@@ -5,4 +5,6 @@ export type { FormState } from "./form-state.js";
 export type { DataSourceRegistry, DataSourceOption, FetchOptionsResponse, DataSourceValueType, } from "./data-source.js";
 export type { TextField, NumberField, BooleanField, EnumOption, EnumOptionValue, StaticEnumField, DynamicEnumField, DynamicSchemaField, ArrayField, ObjectField, AnyField, Group, Conditional, FormElement, FormSpec, } from "./elements.js";
 export type { EqualsPredicate, Predicate } from "./predicate.js";
+export { FORMSPEC_DECORATOR_NAMES, CONSTRAINT_TAG_DEFINITIONS } from "./decorators.js";
+export type { FormSpecDecoratorName, ConstraintTagName } from "./decorators.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAEA,YAAY,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE9C,YAAY,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAE3D,YAAY,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEjD,YAAY,EACV,kBAAkB,EAClB,gBAAgB,EAChB,oBAAoB,EACpB,mBAAmB,GACpB,MAAM,kBAAkB,CAAC;AAE1B,YAAY,EACV,SAAS,EACT,WAAW,EACX,YAAY,EACZ,UAAU,EACV,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,UAAU,EACV,WAAW,EACX,QAAQ,EACR,KAAK,EACL,WAAW,EACX,WAAW,EACX,QAAQ,GACT,MAAM,eAAe,CAAC;AAEvB,YAAY,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAEA,YAAY,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE9C,YAAY,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAE3D,YAAY,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEjD,YAAY,EACV,kBAAkB,EAClB,gBAAgB,EAChB,oBAAoB,EACpB,mBAAmB,GACpB,MAAM,kBAAkB,CAAC;AAE1B,YAAY,EACV,SAAS,EACT,WAAW,EACX,YAAY,EACZ,UAAU,EACV,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,UAAU,EACV,WAAW,EACX,QAAQ,EACR,KAAK,EACL,WAAW,EACX,WAAW,EACX,QAAQ,GACT,MAAM,eAAe,CAAC;AAEvB,YAAY,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEjE,OAAO,EAAE,wBAAwB,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC;AACvF,YAAY,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/types/index.js

@@ -1,3 +1,4 @@
 // Re-export all types from the types directory
 export { createInitialFieldState } from "./field-state.js";
+export { FORMSPEC_DECORATOR_NAMES, CONSTRAINT_TAG_DEFINITIONS } from "./decorators.js";
 //# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAK/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAK/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AA+B3D,OAAO,EAAE,wBAAwB,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formspec/core",
-  "version": "0.1.0-alpha.2",
+  "version": "0.1.0-alpha.9",
   "description": "Core utilities for formspec",
   "type": "module",
   "main": "./dist/index.js",
@@ -12,7 +12,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "publishConfig": {
     "access": "public"
@@ -20,7 +21,7 @@
   "keywords": [],
   "license": "UNLICENSED",
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && api-extractor run --local",
     "clean": "rm -rf dist temp",
     "typecheck": "tsc --noEmit",
     "api-extractor": "api-extractor run",