@streamline-pulse/formkrafter-core 0.32.1 → 0.34.0

package/dist/services/option_source_service.d.ts

@@ -1,8 +1,21 @@
+/** A catalog the host offers to select / multi-select fields (shown in the builder). */
+export interface OptionCatalogEntry {
+    /** What to put in `optionsRef` (filters may be appended: `towns?region={{data.region}}`). */
+    ref: string;
+    label: string;
+    description?: string;
+    /** Query parameters the catalog accepts, for dependent lists. */
+    filters?: string[];
+}
 export interface OptionSourceService {
     fetchOptions(ref: string): Promise<unknown>;
+    /** Optional: the catalogs available, so the builder can suggest refs. */
+    listCatalogs?(): Promise<OptionCatalogEntry[]>;
 }
 export interface FetchOptionSourceDefaults {
     baseUrl?: string;
+    /** Where to list the catalogs (default: `baseUrl`). The response is an array, or `{ data: [...] }`, of `{ ref | value, name | label, description?, filters? }`. */
+    catalogsUrl?: string;
     headers?: Record<string, string>;
     credentials?: RequestCredentials;
     fetch?: typeof fetch;
@@ -13,4 +26,6 @@ export declare class FetchOptionSourceService implements OptionSourceService {
     constructor(defaults?: FetchOptionSourceDefaults);
     private resolveUrl;
     fetchOptions(ref: string): Promise<unknown>;
+    private catalogs?;
+    listCatalogs(): Promise<OptionCatalogEntry[]>;
 }

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

@@ -5,6 +5,13 @@ 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";
+/** Where a brick sits in its row: `columns` 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. */
+    columns?: number;
+    /** On a child of a row: how many of the row's columns it takes (1 by default). */
+    span?: number;
+}
 export interface BrickSpec {
     type: BrickType;
     dataType?: JSONSchemaType;
@@ -20,6 +27,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.32.1",
+  "version": "0.34.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",

package/schema/form-spec.schema.json

@@ -68,6 +68,15 @@
           "description": "Style tokens applied to the brick, as CSS-like key/value pairs.",
           "additionalProperties": true
         },
+        "layout": {
+          "type": "object",
+          "description": "Placement in a row: \"columns\" on the row itself (equal columns, a lone field keeps its share), \"span\" on one of its children (how many columns it takes). A row still stacks on narrow screens.",
+          "properties": {
+            "columns": { "type": "integer", "minimum": 1, "maximum": 12 },
+            "span": { "type": "integer", "minimum": 1, "maximum": 12 }
+          },
+          "additionalProperties": false
+        },
         "children": {
           "type": "array",
           "items": { "$ref": "#/$defs/brick" },