@formspec/build 0.1.0-alpha.1

package/dist/ui-schema/generator.js

@@ -0,0 +1,150 @@
+/**
+ * JSON Forms UI Schema generator for FormSpec forms.
+ */
+/**
+ * Converts a field name to a JSON Pointer scope.
+ */
+function fieldToScope(fieldName) {
+    return `#/properties/${fieldName}`;
+}
+/**
+ * Creates a rule for conditional visibility.
+ */
+function createShowRule(fieldName, value) {
+    return {
+        effect: "SHOW",
+        condition: {
+            scope: fieldToScope(fieldName),
+            schema: { const: value },
+        },
+    };
+}
+/**
+ * Combines two rules into one using allOf.
+ *
+ * When elements are nested inside multiple conditionals, all conditions
+ * must be met for the element to be visible.
+ */
+function combineRules(parentRule, childRule) {
+    // Both rules should have the same effect (SHOW)
+    // Combine conditions using allOf
+    const parentCondition = parentRule.condition;
+    const childCondition = childRule.condition;
+    return {
+        effect: "SHOW",
+        condition: {
+            scope: "#",
+            schema: {
+                allOf: [
+                    {
+                        properties: {
+                            [parentCondition.scope.replace("#/properties/", "")]: parentCondition.schema,
+                        },
+                    },
+                    {
+                        properties: {
+                            [childCondition.scope.replace("#/properties/", "")]: childCondition.schema,
+                        },
+                    },
+                ],
+            },
+        },
+    };
+}
+/**
+ * Converts form elements to UI Schema elements.
+ *
+ * @param elements - The form elements to convert
+ * @param parentRule - Optional rule inherited from parent conditional
+ * @returns Array of UI Schema elements
+ */
+function elementsToUiSchema(elements, parentRule) {
+    const result = [];
+    for (const element of elements) {
+        switch (element._type) {
+            case "field": {
+                const control = {
+                    type: "Control",
+                    scope: fieldToScope(element.name),
+                    ...(element.label !== undefined && { label: element.label }),
+                    ...(parentRule !== undefined && { rule: parentRule }),
+                };
+                result.push(control);
+                break;
+            }
+            case "group": {
+                const groupElement = element;
+                const group = {
+                    type: "Group",
+                    label: groupElement.label,
+                    elements: elementsToUiSchema(groupElement.elements, parentRule),
+                    ...(parentRule !== undefined && { rule: parentRule }),
+                };
+                result.push(group);
+                break;
+            }
+            case "conditional": {
+                const conditionalElement = element;
+                // Create a rule for this conditional
+                const newRule = createShowRule(conditionalElement.field, conditionalElement.value);
+                // Combine with parent rule if present (for nested conditionals)
+                const combinedRule = parentRule !== undefined
+                    ? combineRules(parentRule, newRule)
+                    : newRule;
+                // Apply the combined rule to all children
+                const childElements = elementsToUiSchema(conditionalElement.elements, combinedRule);
+                result.push(...childElements);
+                break;
+            }
+        }
+    }
+    return result;
+}
+/**
+ * Generates a JSON Forms UI Schema from a FormSpec.
+ *
+ * @example
+ * ```typescript
+ * const form = formspec(
+ *   group("Customer",
+ *     field.text("name", { label: "Name" }),
+ *   ),
+ *   when("status", "draft",
+ *     field.text("notes", { label: "Notes" }),
+ *   ),
+ * );
+ *
+ * const uiSchema = generateUiSchema(form);
+ * // {
+ * //   type: "VerticalLayout",
+ * //   elements: [
+ * //     {
+ * //       type: "Group",
+ * //       label: "Customer",
+ * //       elements: [
+ * //         { type: "Control", scope: "#/properties/name", label: "Name" }
+ * //       ]
+ * //     },
+ * //     {
+ * //       type: "Control",
+ * //       scope: "#/properties/notes",
+ * //       label: "Notes",
+ * //       rule: {
+ * //         effect: "SHOW",
+ * //         condition: { scope: "#/properties/status", schema: { const: "draft" } }
+ * //       }
+ * //     }
+ * //   ]
+ * // }
+ * ```
+ *
+ * @param form - The FormSpec to convert
+ * @returns A JSON Forms UI Schema
+ */
+export function generateUiSchema(form) {
+    return {
+        type: "VerticalLayout",
+        elements: elementsToUiSchema(form.elements),
+    };
+}
+//# sourceMappingURL=generator.js.map

package/dist/ui-schema/generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../src/ui-schema/generator.ts"],"names":[],"mappings":"AAAA;;GAEG;AAgBH;;GAEG;AACH,SAAS,YAAY,CAAC,SAAiB;IACrC,OAAO,gBAAgB,SAAS,EAAE,CAAC;AACrC,CAAC;AAED;;GAEG;AACH,SAAS,cAAc,CAAC,SAAiB,EAAE,KAAc;IACvD,OAAO;QACL,MAAM,EAAE,MAAM;QACd,SAAS,EAAE;YACT,KAAK,EAAE,YAAY,CAAC,SAAS,CAAC;YAC9B,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE;SACzB;KACF,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,YAAY,CAAC,UAAgB,EAAE,SAAe;IACrD,gDAAgD;IAChD,iCAAiC;IACjC,MAAM,eAAe,GAAG,UAAU,CAAC,SAAS,CAAC;IAC7C,MAAM,cAAc,GAAG,SAAS,CAAC,SAAS,CAAC;IAE3C,OAAO;QACL,MAAM,EAAE,MAAM;QACd,SAAS,EAAE;YACT,KAAK,EAAE,GAAG;YACV,MAAM,EAAE;gBACN,KAAK,EAAE;oBACL;wBACE,UAAU,EAAE;4BACV,CAAC,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,MAAM;yBAC7E;qBACF;oBACD;wBACE,UAAU,EAAE;4BACV,CAAC,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,EAAE,cAAc,CAAC,MAAM;yBAC3E;qBACF;iBACF;aACF;SACF;KACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CACzB,QAAgC,EAChC,UAAiB;IAEjB,MAAM,MAAM,GAAsB,EAAE,CAAC;IAErC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,QAAQ,OAAO,CAAC,KAAK,EAAE,CAAC;YACtB,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,MAAM,OAAO,GAAmB;oBAC9B,IAAI,EAAE,SAAS;oBACf,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC;oBACjC,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;oBAC5D,GAAG,CAAC,UAAU,KAAK,SAAS,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;iBACtD,CAAC;gBACF,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACrB,MAAM;YACR,CAAC;YAED,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,MAAM,YAAY,GAAG,OAAwC,CAAC;gBAC9D,MAAM,KAAK,GAAgB;oBACzB,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,YAAY,CAAC,KAAK;oBACzB,QAAQ,EAAE,kBAAkB,CAAC,YAAY,CAAC,QAAQ,EAAE,UAAU,CAAC;oBAC/D,GAAG,CAAC,UAAU,KAAK,SAAS,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;iBACtD,CAAC;gBACF,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACnB,MAAM;YACR,CAAC;YAED,KAAK,aAAa,CAAC,CAAC,CAAC;gBACnB,MAAM,kBAAkB,GAAG,OAI1B,CAAC;gBACF,qCAAqC;gBACrC,MAAM,OAAO,GAAG,cAAc,CAC5B,kBAAkB,CAAC,KAAK,EACxB,kBAAkB,CAAC,KAAK,CACzB,CAAC;gBACF,gEAAgE;gBAChE,MAAM,YAAY,GAAG,UAAU,KAAK,SAAS;oBAC3C,CAAC,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC;oBACnC,CAAC,CAAC,OAAO,CAAC;gBACZ,0CAA0C;gBAC1C,MAAM,aAAa,GAAG,kBAAkB,CACtC,kBAAkB,CAAC,QAAQ,EAC3B,YAAY,CACb,CAAC;gBACF,MAAM,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC;gBAC9B,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,UAAU,gBAAgB,CAC9B,IAAiB;IAEjB,OAAO;QACL,IAAI,EAAE,gBAAgB;QACtB,QAAQ,EAAE,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC;KAC5C,CAAC;AACJ,CAAC"}

package/dist/ui-schema/types.d.ts

@@ -0,0 +1,87 @@
+/**
+ * JSON Forms UI Schema type definitions.
+ *
+ * These types define the UI layout structure for JSON Forms.
+ * See: https://jsonforms.io/docs/uischema/
+ */
+/**
+ * UI Schema element types.
+ */
+export type UISchemaElementType = "Control" | "VerticalLayout" | "HorizontalLayout" | "Group" | "Categorization" | "Category";
+/**
+ * Rule effect types for conditional visibility.
+ */
+export type RuleEffect = "SHOW" | "HIDE" | "ENABLE" | "DISABLE";
+/**
+ * JSON Schema subset for rule conditions.
+ */
+export interface RuleConditionSchema {
+    const?: unknown;
+    enum?: readonly unknown[];
+    type?: string;
+    minimum?: number;
+    maximum?: number;
+    properties?: Record<string, RuleConditionSchema>;
+    allOf?: RuleConditionSchema[];
+}
+/**
+ * Condition for a rule.
+ */
+export interface SchemaBasedCondition {
+    scope: string;
+    schema: RuleConditionSchema;
+}
+/**
+ * Rule for conditional element visibility/enablement.
+ */
+export interface Rule {
+    effect: RuleEffect;
+    condition: SchemaBasedCondition;
+}
+/**
+ * Base interface for all UI Schema elements.
+ */
+export interface UISchemaElementBase {
+    type: UISchemaElementType;
+    rule?: Rule;
+    options?: Record<string, unknown>;
+}
+/**
+ * A Control element that binds to a JSON Schema property.
+ */
+export interface ControlElement extends UISchemaElementBase {
+    type: "Control";
+    scope: string;
+    label?: string;
+}
+/**
+ * A vertical layout element.
+ */
+export interface VerticalLayout extends UISchemaElementBase {
+    type: "VerticalLayout";
+    elements: UISchemaElement[];
+}
+/**
+ * A horizontal layout element.
+ */
+export interface HorizontalLayout extends UISchemaElementBase {
+    type: "HorizontalLayout";
+    elements: UISchemaElement[];
+}
+/**
+ * A group element with a label.
+ */
+export interface GroupLayout extends UISchemaElementBase {
+    type: "Group";
+    label: string;
+    elements: UISchemaElement[];
+}
+/**
+ * Union of all UI Schema element types.
+ */
+export type UISchemaElement = ControlElement | VerticalLayout | HorizontalLayout | GroupLayout;
+/**
+ * Root UI Schema (always a layout).
+ */
+export type UISchema = VerticalLayout | HorizontalLayout | GroupLayout;
+//# sourceMappingURL=types.d.ts.map

package/dist/ui-schema/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/ui-schema/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC3B,SAAS,GACT,gBAAgB,GAChB,kBAAkB,GAClB,OAAO,GACP,gBAAgB,GAChB,UAAU,CAAC;AAEf;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IACjD,KAAK,CAAC,EAAE,mBAAmB,EAAE,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,mBAAmB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB,MAAM,EAAE,UAAU,CAAC;IACnB,SAAS,EAAE,oBAAoB,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,mBAAmB,CAAC;IAC1B,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,mBAAmB;IACzD,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,mBAAmB;IACzD,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;IAC3D,IAAI,EAAE,kBAAkB,CAAC;IACzB,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,mBAAmB;IACtD,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,cAAc,GACd,cAAc,GACd,gBAAgB,GAChB,WAAW,CAAC;AAEhB;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,cAAc,GAAG,gBAAgB,GAAG,WAAW,CAAC"}

package/dist/ui-schema/types.js

@@ -0,0 +1,8 @@
+/**
+ * JSON Forms UI Schema type definitions.
+ *
+ * These types define the UI layout structure for JSON Forms.
+ * See: https://jsonforms.io/docs/uischema/
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/ui-schema/types.js.map

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

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@formspec/build",
+  "version": "0.1.0-alpha.1",
+  "description": "Build tools to compile FormSpec forms to JSON Schema and UI Schema",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/build.d.ts",
+  "bin": {
+    "formspec-build": "./dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/build.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@formspec/core": "0.1.0-alpha.0"
+  },
+  "devDependencies": {
+    "vitest": "^3.0.0",
+    "@formspec/dsl": "0.1.0-alpha.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [],
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist temp",
+    "typecheck": "tsc --noEmit",
+    "test": "pnpm run build && vitest run",
+    "api-extractor": "api-extractor run",
+    "api-extractor:local": "api-extractor run --local",
+    "api-documenter": "api-documenter markdown -i temp -o docs"
+  }
+}