@streamline-pulse/formkrafter-core 0.33.0 → 0.36.0

package/dist/utils/brick-spec.d.ts

@@ -5,6 +5,23 @@ import type { Rule } from "../rules/rule.js";
 import type { BrickType } from "./brick-type.js";
 import type { BrickBaseConfigs } from "./common-brick-props.js";
 import type { BrickStyles } from "../utils/brick-styles.js";
+/** One column of a row: `auto`, `min-content`, `max-content`, `2fr`, `12rem`, `30%`, or `minmax(a, b)` of those. */
+export type RowTrack = string;
+/** Where a brick sits in its row: `columns` and `labels` on a row, `span` on one of its children. */
+export interface BrickLayout {
+    /**
+     * On a row: the number of equal columns, so a lone field keeps its share instead of the whole width;
+     * or one track size per column, e.g. `["auto", "1fr", "2fr"]`, so a checkbox column takes only its content.
+     */
+    columns?: number | RowTrack[];
+    /** On a child of a row: how many of the row's columns it takes (1 by default). */
+    span?: number;
+    /**
+     * On a row: `"hidden"` hides its fields' labels from view and keeps them as accessible names,
+     * so a row of a table is one line high. A checkbox keeps its label beside the box.
+     */
+    labels?: "visible" | "hidden";
+}
 export interface BrickSpec {
     type: BrickType;
     dataType?: JSONSchemaType;
@@ -20,6 +37,7 @@ export interface BrickSpec {
     configsForm?: BrickSpec;
     configs?: BrickBaseConfigs & Record<string, unknown>;
     styles?: BrickStyles<string>;
+    layout?: BrickLayout;
     children?: BrickSpec[];
 }
 export declare function iterateBricks(spec?: BrickSpec, path?: string): Generator<{

package/dist/utils/lint-spec.d.ts

@@ -1,5 +1,5 @@
 import type { BrickSpec } from "./brick-spec.js";
-export type SpecIssueCode = "validations-without-data-type" | "input-without-key" | "duplicate-key" | "collection-without-children";
+export type SpecIssueCode = "validations-without-data-type" | "input-without-key" | "duplicate-key" | "collection-without-children" | "content-in-row";
 export interface SpecIssue {
     code: SpecIssueCode;
     path: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamline-pulse/formkrafter-core",
-  "version": "0.33.0",
+  "version": "0.36.0",
   "description": "Framework-agnostic core for FormKrafter: form specs, RFC 6902 ops with undo/redo, Ajv validation, sandboxed rules engine and injectable services",
   "license": "MIT",
   "type": "module",
@@ -41,7 +41,8 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     },
-    "./schema/form-spec.schema.json": "./schema/form-spec.schema.json"
+    "./schema/form-spec.schema.json": "./schema/form-spec.schema.json",
+    "./schema/form-spec.strict.schema.json": "./schema/form-spec.strict.schema.json"
   },
   "publishConfig": {
     "access": "public"

package/schema/form-spec.schema.json

@@ -68,6 +68,30 @@
           "description": "Style tokens applied to the brick, as CSS-like key/value pairs.",
           "additionalProperties": true
         },
+        "layout": {
+          "type": "object",
+          "description": "Placement in a row: \"columns\" and \"labels\" on the row itself, \"span\" on one of its children (how many columns it takes). A row still stacks on narrow screens.",
+          "properties": {
+            "columns": {
+              "description": "A number of equal columns (a lone field keeps its share), or one track size per column, e.g. [\"auto\", \"1fr\", \"2fr\"], so a checkbox column takes only its content.",
+              "anyOf": [
+                { "type": "integer", "minimum": 1, "maximum": 12 },
+                {
+                  "type": "array",
+                  "minItems": 1,
+                  "maxItems": 12,
+                  "items": { "$ref": "#/$defs/rowTrack" }
+                }
+              ]
+            },
+            "span": { "type": "integer", "minimum": 1, "maximum": 12 },
+            "labels": {
+              "enum": ["visible", "hidden"],
+              "description": "\"hidden\" hides the labels of the row's fields from view and keeps them as accessible names, so a row of a table is one line high. A checkbox keeps its label beside the box."
+            }
+          },
+          "additionalProperties": false
+        },
         "children": {
           "type": "array",
           "items": { "$ref": "#/$defs/brick" },
@@ -77,6 +101,12 @@
       "additionalProperties": false
     },
 
+    "rowTrack": {
+      "type": "string",
+      "description": "One column of a row: auto, min-content, max-content, 0, a length in fr, px, rem, em, ch or %, or minmax(a, b) of those.",
+      "pattern": "^((auto|min-content|max-content|0|[0-9]+(\\.[0-9]+)?(fr|px|rem|em|ch|%))|minmax\\( *(auto|min-content|max-content|0|[0-9]+(\\.[0-9]+)?(fr|px|rem|em|ch|%)) *, *(auto|min-content|max-content|0|[0-9]+(\\.[0-9]+)?(fr|px|rem|em|ch|%)) *\\))$"
+    },
+
     "brickType": {
       "enum": ["panel", "input", "collection", "output", "action"]
     },