@formspec/dsl 0.1.0-alpha.0

package/dist/field.d.ts

@@ -0,0 +1,167 @@
+/**
+ * Field builder functions for creating form field definitions.
+ *
+ * Each function creates a field descriptor that captures both schema information
+ * (name, type) and UI hints (label, placeholder, etc.).
+ */
+import type { TextField, NumberField, BooleanField, StaticEnumField, DynamicEnumField, DynamicSchemaField, ArrayField, ObjectField, FormElement } from "@formspec/core";
+/**
+ * Field builder namespace containing functions to create each field type.
+ *
+ * @example
+ * ```typescript
+ * import { field } from "@formspec/dsl";
+ *
+ * field.text("name", { label: "Full Name" });
+ * field.number("age", { min: 0, max: 150 });
+ * field.enum("status", ["draft", "sent", "paid"]);
+ * field.dynamicEnum("country", "countries", { label: "Country" });
+ * ```
+ */
+export declare const field: {
+    /**
+     * Creates a text input field.
+     *
+     * @param name - The field name (used as the schema key)
+     * @param config - Optional configuration for label, placeholder, etc.
+     * @returns A TextField descriptor
+     */
+    text: <const N extends string>(name: N, config?: Omit<TextField<N>, "_type" | "_field" | "name">) => TextField<N>;
+    /**
+     * Creates a numeric input field.
+     *
+     * @param name - The field name (used as the schema key)
+     * @param config - Optional configuration for label, min, max, etc.
+     * @returns A NumberField descriptor
+     */
+    number: <const N extends string>(name: N, config?: Omit<NumberField<N>, "_type" | "_field" | "name">) => NumberField<N>;
+    /**
+     * Creates a boolean checkbox field.
+     *
+     * @param name - The field name (used as the schema key)
+     * @param config - Optional configuration for label, etc.
+     * @returns A BooleanField descriptor
+     */
+    boolean: <const N extends string>(name: N, config?: Omit<BooleanField<N>, "_type" | "_field" | "name">) => BooleanField<N>;
+    /**
+     * Creates a field with static enum options (known at compile time).
+     *
+     * Literal types are automatically inferred - no `as const` needed:
+     * ```typescript
+     * field.enum("status", ["draft", "sent", "paid"])
+     * // Schema type: "draft" | "sent" | "paid"
+     * ```
+     *
+     * @param name - The field name (used as the schema key)
+     * @param options - Array of allowed string values
+     * @param config - Optional configuration for label, etc.
+     * @returns A StaticEnumField descriptor
+     */
+    enum: <const N extends string, const O extends readonly string[]>(name: N, options: O, config?: Omit<StaticEnumField<N, O>, "_type" | "_field" | "name" | "options">) => StaticEnumField<N, O>;
+    /**
+     * Creates a field with dynamic enum options (fetched from a data source at runtime).
+     *
+     * The data source must be registered in DataSourceRegistry via module augmentation:
+     * ```typescript
+     * declare module "@formspec/core" {
+     *   interface DataSourceRegistry {
+     *     countries: { id: string; code: string; name: string };
+     *   }
+     * }
+     *
+     * field.dynamicEnum("country", "countries", { label: "Country" })
+     * ```
+     *
+     * @param name - The field name (used as the schema key)
+     * @param source - The data source key (must be in DataSourceRegistry)
+     * @param config - Optional configuration for label, params, etc.
+     * @returns A DynamicEnumField descriptor
+     */
+    dynamicEnum: <const N extends string, const Source extends string>(name: N, source: Source, config?: Omit<DynamicEnumField<N, Source>, "_type" | "_field" | "name" | "source">) => DynamicEnumField<N, Source>;
+    /**
+     * Creates a field that loads its schema dynamically (e.g., from an extension).
+     *
+     * @param name - The field name (used as the schema key)
+     * @param schemaSource - Identifier for the schema source
+     * @param config - Optional configuration for label, etc.
+     * @returns A DynamicSchemaField descriptor
+     */
+    dynamicSchema: <const N extends string>(name: N, schemaSource: string, config?: Omit<DynamicSchemaField<N>, "_type" | "_field" | "name" | "schemaSource">) => DynamicSchemaField<N>;
+    /**
+     * Creates an array field containing repeating items.
+     *
+     * Use this for lists of values (e.g., multiple addresses, line items).
+     *
+     * @example
+     * ```typescript
+     * field.array("addresses",
+     *   field.text("street", { label: "Street" }),
+     *   field.text("city", { label: "City" }),
+     *   field.text("zip", { label: "ZIP Code" }),
+     * )
+     * ```
+     *
+     * @param name - The field name (used as the schema key)
+     * @param items - The form elements that define each array item
+     * @returns An ArrayField descriptor
+     */
+    array: <const N extends string, const Items extends readonly FormElement[]>(name: N, ...items: Items) => ArrayField<N, Items>;
+    /**
+     * Creates an array field with additional configuration options.
+     *
+     * @example
+     * ```typescript
+     * field.arrayWithConfig("lineItems", {
+     *   label: "Line Items",
+     *   minItems: 1,
+     *   maxItems: 10,
+     * },
+     *   field.text("description"),
+     *   field.number("quantity"),
+     * )
+     * ```
+     *
+     * @param name - The field name (used as the schema key)
+     * @param config - Configuration for label, minItems, maxItems, etc.
+     * @param items - The form elements that define each array item
+     * @returns An ArrayField descriptor
+     */
+    arrayWithConfig: <const N extends string, const Items extends readonly FormElement[]>(name: N, config: Omit<ArrayField<N, Items>, "_type" | "_field" | "name" | "items">, ...items: Items) => ArrayField<N, Items>;
+    /**
+     * Creates an object field containing nested properties.
+     *
+     * Use this for grouping related fields under a single key in the schema.
+     *
+     * @example
+     * ```typescript
+     * field.object("address",
+     *   field.text("street", { label: "Street" }),
+     *   field.text("city", { label: "City" }),
+     *   field.text("zip", { label: "ZIP Code" }),
+     * )
+     * ```
+     *
+     * @param name - The field name (used as the schema key)
+     * @param properties - The form elements that define the object's properties
+     * @returns An ObjectField descriptor
+     */
+    object: <const N extends string, const Properties extends readonly FormElement[]>(name: N, ...properties: Properties) => ObjectField<N, Properties>;
+    /**
+     * Creates an object field with additional configuration options.
+     *
+     * @example
+     * ```typescript
+     * field.objectWithConfig("billingAddress", { label: "Billing Address", required: true },
+     *   field.text("street"),
+     *   field.text("city"),
+     * )
+     * ```
+     *
+     * @param name - The field name (used as the schema key)
+     * @param config - Configuration for label, required, etc.
+     * @param properties - The form elements that define the object's properties
+     * @returns An ObjectField descriptor
+     */
+    objectWithConfig: <const N extends string, const Properties extends readonly FormElement[]>(name: N, config: Omit<ObjectField<N, Properties>, "_type" | "_field" | "name" | "properties">, ...properties: Properties) => ObjectField<N, Properties>;
+};
+//# sourceMappingURL=field.d.ts.map

package/dist/field.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../src/field.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EACV,SAAS,EACT,WAAW,EACX,YAAY,EACZ,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,UAAU,EACV,WAAW,EACX,WAAW,EACZ,MAAM,gBAAgB,CAAC;AAExB;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,KAAK;IAChB;;;;;;OAMG;iBACU,CAAC,SAAS,MAAM,QACrB,CAAC,WACE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC,KACvD,SAAS,CAAC,CAAC,CAAC;IAOf;;;;;;OAMG;mBACY,CAAC,SAAS,MAAM,QACvB,CAAC,WACE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC,KACzD,WAAW,CAAC,CAAC,CAAC;IAOjB;;;;;;OAMG;oBACa,CAAC,SAAS,MAAM,QACxB,CAAC,WACE,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC,KAC1D,YAAY,CAAC,CAAC,CAAC;IAOlB;;;;;;;;;;;;;OAaG;iBACU,CAAC,SAAS,MAAM,QAAQ,CAAC,SAAS,SAAS,MAAM,EAAE,QACxD,CAAC,WACE,CAAC,WACD,IAAI,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC,KAC5E,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC;IAQxB;;;;;;;;;;;;;;;;;;OAkBG;wBACiB,CAAC,SAAS,MAAM,QAAQ,MAAM,SAAS,MAAM,QACzD,CAAC,UACC,MAAM,WACL,IAAI,CAAC,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC,KACjF,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC;IAQ9B;;;;;;;OAOG;0BACmB,CAAC,SAAS,MAAM,QAC9B,CAAC,gBACO,MAAM,WACX,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,cAAc,CAAC,KACjF,kBAAkB,CAAC,CAAC,CAAC;IAQxB;;;;;;;;;;;;;;;;;OAiBG;kBACW,CAAC,SAAS,MAAM,QAAQ,KAAK,SAAS,SAAS,WAAW,EAAE,QAClE,CAAC,YACG,KAAK,KACd,UAAU,CAAC,CAAC,EAAE,KAAK,CAAC;IAOvB;;;;;;;;;;;;;;;;;;;OAmBG;4BACqB,CAAC,SAAS,MAAM,QAAQ,KAAK,SAAS,SAAS,WAAW,EAAE,QAC5E,CAAC,UACC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC,YAC/D,KAAK,KACd,UAAU,CAAC,CAAC,EAAE,KAAK,CAAC;IAQvB;;;;;;;;;;;;;;;;;OAiBG;mBACY,CAAC,SAAS,MAAM,QAAQ,UAAU,SAAS,SAAS,WAAW,EAAE,QACxE,CAAC,iBACQ,UAAU,KACxB,WAAW,CAAC,CAAC,EAAE,UAAU,CAAC;IAO7B;;;;;;;;;;;;;;;OAeG;6BACsB,CAAC,SAAS,MAAM,QAAQ,UAAU,SAAS,SAAS,WAAW,EAAE,QAClF,CAAC,UACC,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,YAAY,CAAC,iBACrE,UAAU,KACxB,WAAW,CAAC,CAAC,EAAE,UAAU,CAAC;CAO9B,CAAC"}

package/dist/field.js

@@ -0,0 +1,221 @@
+/**
+ * Field builder functions for creating form field definitions.
+ *
+ * Each function creates a field descriptor that captures both schema information
+ * (name, type) and UI hints (label, placeholder, etc.).
+ */
+/**
+ * Field builder namespace containing functions to create each field type.
+ *
+ * @example
+ * ```typescript
+ * import { field } from "@formspec/dsl";
+ *
+ * field.text("name", { label: "Full Name" });
+ * field.number("age", { min: 0, max: 150 });
+ * field.enum("status", ["draft", "sent", "paid"]);
+ * field.dynamicEnum("country", "countries", { label: "Country" });
+ * ```
+ */
+export const field = {
+    /**
+     * Creates a text input field.
+     *
+     * @param name - The field name (used as the schema key)
+     * @param config - Optional configuration for label, placeholder, etc.
+     * @returns A TextField descriptor
+     */
+    text: (name, config) => ({
+        _type: "field",
+        _field: "text",
+        name,
+        ...config,
+    }),
+    /**
+     * Creates a numeric input field.
+     *
+     * @param name - The field name (used as the schema key)
+     * @param config - Optional configuration for label, min, max, etc.
+     * @returns A NumberField descriptor
+     */
+    number: (name, config) => ({
+        _type: "field",
+        _field: "number",
+        name,
+        ...config,
+    }),
+    /**
+     * Creates a boolean checkbox field.
+     *
+     * @param name - The field name (used as the schema key)
+     * @param config - Optional configuration for label, etc.
+     * @returns A BooleanField descriptor
+     */
+    boolean: (name, config) => ({
+        _type: "field",
+        _field: "boolean",
+        name,
+        ...config,
+    }),
+    /**
+     * Creates a field with static enum options (known at compile time).
+     *
+     * Literal types are automatically inferred - no `as const` needed:
+     * ```typescript
+     * field.enum("status", ["draft", "sent", "paid"])
+     * // Schema type: "draft" | "sent" | "paid"
+     * ```
+     *
+     * @param name - The field name (used as the schema key)
+     * @param options - Array of allowed string values
+     * @param config - Optional configuration for label, etc.
+     * @returns A StaticEnumField descriptor
+     */
+    enum: (name, options, config) => ({
+        _type: "field",
+        _field: "enum",
+        name,
+        options,
+        ...config,
+    }),
+    /**
+     * Creates a field with dynamic enum options (fetched from a data source at runtime).
+     *
+     * The data source must be registered in DataSourceRegistry via module augmentation:
+     * ```typescript
+     * declare module "@formspec/core" {
+     *   interface DataSourceRegistry {
+     *     countries: { id: string; code: string; name: string };
+     *   }
+     * }
+     *
+     * field.dynamicEnum("country", "countries", { label: "Country" })
+     * ```
+     *
+     * @param name - The field name (used as the schema key)
+     * @param source - The data source key (must be in DataSourceRegistry)
+     * @param config - Optional configuration for label, params, etc.
+     * @returns A DynamicEnumField descriptor
+     */
+    dynamicEnum: (name, source, config) => ({
+        _type: "field",
+        _field: "dynamic_enum",
+        name,
+        source,
+        ...config,
+    }),
+    /**
+     * Creates a field that loads its schema dynamically (e.g., from an extension).
+     *
+     * @param name - The field name (used as the schema key)
+     * @param schemaSource - Identifier for the schema source
+     * @param config - Optional configuration for label, etc.
+     * @returns A DynamicSchemaField descriptor
+     */
+    dynamicSchema: (name, schemaSource, config) => ({
+        _type: "field",
+        _field: "dynamic_schema",
+        name,
+        schemaSource,
+        ...config,
+    }),
+    /**
+     * Creates an array field containing repeating items.
+     *
+     * Use this for lists of values (e.g., multiple addresses, line items).
+     *
+     * @example
+     * ```typescript
+     * field.array("addresses",
+     *   field.text("street", { label: "Street" }),
+     *   field.text("city", { label: "City" }),
+     *   field.text("zip", { label: "ZIP Code" }),
+     * )
+     * ```
+     *
+     * @param name - The field name (used as the schema key)
+     * @param items - The form elements that define each array item
+     * @returns An ArrayField descriptor
+     */
+    array: (name, ...items) => ({
+        _type: "field",
+        _field: "array",
+        name,
+        items,
+    }),
+    /**
+     * Creates an array field with additional configuration options.
+     *
+     * @example
+     * ```typescript
+     * field.arrayWithConfig("lineItems", {
+     *   label: "Line Items",
+     *   minItems: 1,
+     *   maxItems: 10,
+     * },
+     *   field.text("description"),
+     *   field.number("quantity"),
+     * )
+     * ```
+     *
+     * @param name - The field name (used as the schema key)
+     * @param config - Configuration for label, minItems, maxItems, etc.
+     * @param items - The form elements that define each array item
+     * @returns An ArrayField descriptor
+     */
+    arrayWithConfig: (name, config, ...items) => ({
+        _type: "field",
+        _field: "array",
+        name,
+        items,
+        ...config,
+    }),
+    /**
+     * Creates an object field containing nested properties.
+     *
+     * Use this for grouping related fields under a single key in the schema.
+     *
+     * @example
+     * ```typescript
+     * field.object("address",
+     *   field.text("street", { label: "Street" }),
+     *   field.text("city", { label: "City" }),
+     *   field.text("zip", { label: "ZIP Code" }),
+     * )
+     * ```
+     *
+     * @param name - The field name (used as the schema key)
+     * @param properties - The form elements that define the object's properties
+     * @returns An ObjectField descriptor
+     */
+    object: (name, ...properties) => ({
+        _type: "field",
+        _field: "object",
+        name,
+        properties,
+    }),
+    /**
+     * Creates an object field with additional configuration options.
+     *
+     * @example
+     * ```typescript
+     * field.objectWithConfig("billingAddress", { label: "Billing Address", required: true },
+     *   field.text("street"),
+     *   field.text("city"),
+     * )
+     * ```
+     *
+     * @param name - The field name (used as the schema key)
+     * @param config - Configuration for label, required, etc.
+     * @param properties - The form elements that define the object's properties
+     * @returns An ObjectField descriptor
+     */
+    objectWithConfig: (name, config, ...properties) => ({
+        _type: "field",
+        _field: "object",
+        name,
+        properties,
+        ...config,
+    }),
+};
+//# sourceMappingURL=field.js.map

package/dist/field.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"field.js","sourceRoot":"","sources":["../src/field.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAcH;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB;;;;;;OAMG;IACH,IAAI,EAAE,CACJ,IAAO,EACP,MAAwD,EAC1C,EAAE,CAAC,CAAC;QAClB,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,MAAM;QACd,IAAI;QACJ,GAAG,MAAM;KACV,CAAC;IAEF;;;;;;OAMG;IACH,MAAM,EAAE,CACN,IAAO,EACP,MAA0D,EAC1C,EAAE,CAAC,CAAC;QACpB,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,QAAQ;QAChB,IAAI;QACJ,GAAG,MAAM;KACV,CAAC;IAEF;;;;;;OAMG;IACH,OAAO,EAAE,CACP,IAAO,EACP,MAA2D,EAC1C,EAAE,CAAC,CAAC;QACrB,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,SAAS;QACjB,IAAI;QACJ,GAAG,MAAM;KACV,CAAC;IAEF;;;;;;;;;;;;;OAaG;IACH,IAAI,EAAE,CACJ,IAAO,EACP,OAAU,EACV,MAA6E,EACtD,EAAE,CAAC,CAAC;QAC3B,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,MAAM;QACd,IAAI;QACJ,OAAO;QACP,GAAG,MAAM;KACV,CAAC;IAEF;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,EAAE,CACX,IAAO,EACP,MAAc,EACd,MAAkF,EACrD,EAAE,CAAC,CAAC;QACjC,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,cAAc;QACtB,IAAI;QACJ,MAAM;QACN,GAAG,MAAM;KACV,CAAC;IAEF;;;;;;;OAOG;IACH,aAAa,EAAE,CACb,IAAO,EACP,YAAoB,EACpB,MAAkF,EAC3D,EAAE,CAAC,CAAC;QAC3B,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,gBAAgB;QACxB,IAAI;QACJ,YAAY;QACZ,GAAG,MAAM;KACV,CAAC;IAEF;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,EAAE,CACL,IAAO,EACP,GAAG,KAAY,EACO,EAAE,CAAC,CAAC;QAC1B,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,OAAO;QACf,IAAI;QACJ,KAAK;KACN,CAAC;IAEF;;;;;;;;;;;;;;;;;;;OAmBG;IACH,eAAe,EAAE,CACf,IAAO,EACP,MAAyE,EACzE,GAAG,KAAY,EACO,EAAE,CAAC,CAAC;QAC1B,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,OAAO;QACf,IAAI;QACJ,KAAK;QACL,GAAG,MAAM;KACV,CAAC;IAEF;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,EAAE,CACN,IAAO,EACP,GAAG,UAAsB,EACG,EAAE,CAAC,CAAC;QAChC,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,QAAQ;QAChB,IAAI;QACJ,UAAU;KACX,CAAC;IAEF;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,EAAE,CAChB,IAAO,EACP,MAAoF,EACpF,GAAG,UAAsB,EACG,EAAE,CAAC,CAAC;QAChC,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,QAAQ;QAChB,IAAI;QACJ,UAAU;QACV,GAAG,MAAM;KACV,CAAC;CACH,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * `@formspec/dsl` - DSL functions for defining FormSpec forms
+ *
+ * This package provides the builder functions for creating form specifications:
+ * - `field.*` - Field builders (text, number, boolean, enum, dynamicEnum)
+ * - `group()` - Visual grouping
+ * - `when()` + `is()` - Conditional visibility
+ * - `formspec()` - Top-level form definition
+ *
+ * @example
+ * ```typescript
+ * import { formspec, field, group, when, is } from "@formspec/dsl";
+ *
+ * const InvoiceForm = formspec(
+ *   group("Customer",
+ *     field.text("customerName", { label: "Customer Name" }),
+ *     field.dynamicEnum("country", "fetch_countries", { label: "Country" }),
+ *   ),
+ *   group("Invoice Details",
+ *     field.number("amount", { label: "Amount", min: 0 }),
+ *     field.enum("status", ["draft", "sent", "paid"] as const),
+ *     when(is("status", "draft"),
+ *       field.text("internalNotes", { label: "Internal Notes" }),
+ *     ),
+ *   ),
+ * );
+ * ```
+ *
+ * @packageDocumentation
+ */
+export { field } from "./field.js";
+export { is } from "./predicate.js";
+export { group, when, formspec, formspecWithValidation } from "./structure.js";
+export type { FormSpecOptions } from "./structure.js";
+export { validateForm, logValidationIssues } from "./validation.js";
+export type { ValidationSeverity, ValidationIssue, ValidationResult, } from "./validation.js";
+export type { InferFieldValue, ExtractFields, ExtractFieldsFromArray, BuildSchema, InferSchema, InferFormSchema, } from "./inference.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAGH,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAGnC,OAAO,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAGpC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAC/E,YAAY,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAGtD,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACpE,YAAY,EACV,kBAAkB,EAClB,eAAe,EACf,gBAAgB,GACjB,MAAM,iBAAiB,CAAC;AAGzB,YAAY,EACV,eAAe,EACf,aAAa,EACb,sBAAsB,EACtB,WAAW,EACX,WAAW,EACX,eAAe,GAChB,MAAM,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,39 @@
+/**
+ * `@formspec/dsl` - DSL functions for defining FormSpec forms
+ *
+ * This package provides the builder functions for creating form specifications:
+ * - `field.*` - Field builders (text, number, boolean, enum, dynamicEnum)
+ * - `group()` - Visual grouping
+ * - `when()` + `is()` - Conditional visibility
+ * - `formspec()` - Top-level form definition
+ *
+ * @example
+ * ```typescript
+ * import { formspec, field, group, when, is } from "@formspec/dsl";
+ *
+ * const InvoiceForm = formspec(
+ *   group("Customer",
+ *     field.text("customerName", { label: "Customer Name" }),
+ *     field.dynamicEnum("country", "fetch_countries", { label: "Country" }),
+ *   ),
+ *   group("Invoice Details",
+ *     field.number("amount", { label: "Amount", min: 0 }),
+ *     field.enum("status", ["draft", "sent", "paid"] as const),
+ *     when(is("status", "draft"),
+ *       field.text("internalNotes", { label: "Internal Notes" }),
+ *     ),
+ *   ),
+ * );
+ * ```
+ *
+ * @packageDocumentation
+ */
+// Field builders
+export { field } from "./field.js";
+// Predicate builders
+export { is } from "./predicate.js";
+// Structure builders
+export { group, when, formspec, formspecWithValidation } from "./structure.js";
+// Validation
+export { validateForm, logValidationIssues } from "./validation.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,iBAAiB;AACjB,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC,qBAAqB;AACrB,OAAO,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAEpC,qBAAqB;AACrB,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAG/E,aAAa;AACb,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/inference.d.ts

@@ -0,0 +1,93 @@
+/**
+ * Type-level utilities for inferring schema types from form elements.
+ *
+ * These types allow TypeScript to automatically derive the form's schema type
+ * from its nested element structure.
+ */
+import type { TextField, NumberField, BooleanField, StaticEnumField, DynamicEnumField, DynamicSchemaField, ArrayField, ObjectField, AnyField, Group, Conditional, FormElement, FormSpec, DataSourceValueType } from "@formspec/core";
+/**
+ * Infers the value type from a single field.
+ *
+ * - TextField returns string
+ * - NumberField returns number
+ * - BooleanField returns boolean
+ * - StaticEnumField returns union of option literals
+ * - DynamicEnumField returns DataSourceValueType (usually string)
+ * - DynamicSchemaField returns Record of string to unknown
+ * - ArrayField returns array of inferred item schema
+ * - ObjectField returns object of inferred property schema
+ *
+ * @example
+ * ```typescript
+ * // Simple fields
+ * type T1 = InferFieldValue<TextField<"name">>; // string
+ * type T2 = InferFieldValue<NumberField<"age">>; // number
+ *
+ * // Enum fields
+ * type T3 = InferFieldValue<StaticEnumField<"status", ["draft", "sent"]>>; // "draft" | "sent"
+ *
+ * // Nested fields
+ * type T4 = InferFieldValue<ArrayField<"items", [TextField<"name">]>>; // { name: string }[]
+ * type T5 = InferFieldValue<ObjectField<"address", [TextField<"city">]>>; // { city: string }
+ * ```
+ */
+export type InferFieldValue<F> = F extends TextField<string> ? string : F extends NumberField<string> ? number : F extends BooleanField<string> ? boolean : F extends StaticEnumField<string, infer O> ? O[number] : F extends DynamicEnumField<string, infer Source> ? DataSourceValueType<Source> : F extends DynamicSchemaField<string> ? Record<string, unknown> : F extends ArrayField<string, infer Items extends readonly FormElement[]> ? InferSchema<Items>[] : F extends ObjectField<string, infer Properties extends readonly FormElement[]> ? InferSchema<Properties> : never;
+/**
+ * Extracts all fields from a single element (recursively).
+ *
+ * - Field elements return themselves
+ * - Groups extract fields from all child elements
+ * - Conditionals extract fields from all child elements
+ */
+export type ExtractFields<E> = E extends AnyField ? E : E extends Group<infer Elements> ? ExtractFieldsFromArray<Elements> : E extends Conditional<string, unknown, infer Elements> ? ExtractFieldsFromArray<Elements> : never;
+/**
+ * Extracts fields from an array of elements.
+ *
+ * Recursively processes each element and unions the results.
+ */
+export type ExtractFieldsFromArray<Elements> = Elements extends readonly [
+    infer First,
+    ...infer Rest
+] ? ExtractFields<First> | ExtractFieldsFromArray<Rest> : never;
+/**
+ * Builds a schema type from extracted fields.
+ *
+ * Maps field names to their inferred value types.
+ */
+export type BuildSchema<Fields> = {
+    [F in Fields as F extends {
+        name: infer N extends string;
+    } ? N : never]: F extends AnyField ? InferFieldValue<F> : never;
+};
+/**
+ * Infers the complete schema type from a form's elements.
+ *
+ * This is the main inference type that converts a form structure
+ * into its corresponding TypeScript schema type.
+ *
+ * @example
+ * ```typescript
+ * const form = formspec(
+ *   field.text("name"),
+ *   field.number("age"),
+ *   field.enum("status", ["active", "inactive"] as const),
+ * );
+ *
+ * type Schema = InferSchema<typeof form.elements>;
+ * // { name: string; age: number; status: "active" | "inactive" }
+ * ```
+ */
+export type InferSchema<Elements extends readonly FormElement[]> = BuildSchema<ExtractFieldsFromArray<Elements>>;
+/**
+ * Infers the schema type from a FormSpec.
+ *
+ * Convenience type that extracts elements and infers the schema.
+ *
+ * @example
+ * ```typescript
+ * const form = formspec(...);
+ * type Schema = InferFormSchema<typeof form>;
+ * ```
+ */
+export type InferFormSchema<F extends FormSpec<readonly FormElement[]>> = F extends FormSpec<infer Elements> ? InferSchema<Elements> : never;
+//# sourceMappingURL=inference.d.ts.map

package/dist/inference.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inference.d.ts","sourceRoot":"","sources":["../src/inference.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EACV,SAAS,EACT,WAAW,EACX,YAAY,EACZ,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,UAAU,EACV,WAAW,EACX,QAAQ,EACR,KAAK,EACL,WAAW,EACX,WAAW,EACX,QAAQ,EACR,mBAAmB,EACpB,MAAM,gBAAgB,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,CAAC,MAAM,CAAC,GACxD,MAAM,GACN,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,GAC3B,MAAM,GACN,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,GAC5B,OAAO,GACP,CAAC,SAAS,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GACxC,CAAC,CAAC,MAAM,CAAC,GACT,CAAC,SAAS,gBAAgB,CAAC,MAAM,EAAE,MAAM,MAAM,CAAC,GAC9C,mBAAmB,CAAC,MAAM,CAAC,GAC3B,CAAC,SAAS,kBAAkB,CAAC,MAAM,CAAC,GAClC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,CAAC,SAAS,UAAU,CAAC,MAAM,EAAE,MAAM,KAAK,SAAS,SAAS,WAAW,EAAE,CAAC,GACtE,WAAW,CAAC,KAAK,CAAC,EAAE,GACpB,CAAC,SAAS,WAAW,CAAC,MAAM,EAAE,MAAM,UAAU,SAAS,SAAS,WAAW,EAAE,CAAC,GAC5E,WAAW,CAAC,UAAU,CAAC,GACvB,KAAK,CAAC;AAExB;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,GAC7C,CAAC,GACD,CAAC,SAAS,KAAK,CAAC,MAAM,QAAQ,CAAC,GAC7B,sBAAsB,CAAC,QAAQ,CAAC,GAChC,CAAC,SAAS,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC,GACpD,sBAAsB,CAAC,QAAQ,CAAC,GAChC,KAAK,CAAC;AAEd;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,CAAC,QAAQ,IAAI,QAAQ,SAAS,SAAS;IACvE,MAAM,KAAK;IACX,GAAG,MAAM,IAAI;CACd,GACG,aAAa,CAAC,KAAK,CAAC,GAAG,sBAAsB,CAAC,IAAI,CAAC,GACnD,KAAK,CAAC;AAEV;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,MAAM,IAAI;KAC/B,CAAC,IAAI,MAAM,IAAI,CAAC,SAAS;QAAE,IAAI,EAAE,MAAM,CAAC,SAAS,MAAM,CAAA;KAAE,GACtD,CAAC,GACD,KAAK,GAAG,CAAC,SAAS,QAAQ,GAAG,eAAe,CAAC,CAAC,CAAC,GAAG,KAAK;CAC5D,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,WAAW,CAAC,QAAQ,SAAS,SAAS,WAAW,EAAE,IAAI,WAAW,CAC5E,sBAAsB,CAAC,QAAQ,CAAC,CACjC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,QAAQ,CAAC,SAAS,WAAW,EAAE,CAAC,IACpE,CAAC,SAAS,QAAQ,CAAC,MAAM,QAAQ,CAAC,GAAG,WAAW,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC"}

package/dist/inference.js

@@ -0,0 +1,8 @@
+/**
+ * Type-level utilities for inferring schema types from form elements.
+ *
+ * These types allow TypeScript to automatically derive the form's schema type
+ * from its nested element structure.
+ */
+export {};
+//# sourceMappingURL=inference.js.map

package/dist/inference.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inference.js","sourceRoot":"","sources":["../src/inference.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/predicate.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Predicate builder functions for conditional logic.
+ *
+ * These functions create predicates for use with `when()`:
+ * - `is()` - Check if a field equals a specific value
+ *
+ * @example
+ * ```typescript
+ * when(is("status", "draft"),
+ *   field.text("notes"),
+ * )
+ * ```
+ */
+import type { EqualsPredicate } from "@formspec/core";
+/**
+ * Creates an equality predicate that checks if a field equals a specific value.
+ *
+ * Use this with `when()` to create readable conditional expressions:
+ *
+ * @example
+ * ```typescript
+ * // Show cardNumber field when paymentMethod is "card"
+ * when(is("paymentMethod", "card"),
+ *   field.text("cardNumber", { label: "Card Number" }),
+ * )
+ * ```
+ *
+ * @typeParam K - The field name (inferred as string literal)
+ * @typeParam V - The value type (inferred as literal)
+ * @param field - The name of the field to check
+ * @param value - The value the field must equal
+ * @returns An EqualsPredicate for use with `when()`
+ */
+export declare function is<const K extends string, const V>(field: K, value: V): EqualsPredicate<K, V>;
+//# sourceMappingURL=predicate.d.ts.map

package/dist/predicate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"predicate.d.ts","sourceRoot":"","sources":["../src/predicate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEtD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,EAAE,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,CAAC,CAAC,EAChD,KAAK,EAAE,CAAC,EACR,KAAK,EAAE,CAAC,GACP,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAMvB"}