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

package/README.md

@@ -77,34 +77,34 @@ function processForm(form: FormSpec<readonly FormElement[]>) {
 
 ### 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 |
+| 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 |
+| 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 |
+| `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 |
+| Type            | Description                         |
+| --------------- | ----------------------------------- |
+| `Validity`      | `"valid"`, `"invalid"`, `"unknown"` |
+| `FieldState<T>` | Runtime state of a single field     |
+| `FormState<S>`  | Runtime state of entire form        |
 
 ## License
 

package/dist/core.d.ts

@@ -77,6 +77,27 @@ export declare interface Conditional<FieldName extends string, Value, Elements e
     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.
  *
@@ -253,6 +274,12 @@ export declare interface FormSpec<Elements extends readonly FormElement[]> {
     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.
  *

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.4",
+  "version": "0.1.0-alpha.9",
   "description": "Core utilities for formspec",
   "type": "module",
   "main": "./dist/index.js",