@streamline-pulse/formkrafter-core 0.33.0 → 0.36.0

package/dist/ai/brick-catalog.d.ts

@@ -0,0 +1,39 @@
+import type { BrickType } from "../utils/brick-type.js";
+/**
+ * The bricks a language model may write, with the configs each one reads. The
+ * strict schema (schema/form-spec.strict.schema.json) is generated from this
+ * list and fromStrictSpec reads it back, so a brick or a config a model can use
+ * is declared once, here. The web components test that every registered brick
+ * is either listed here or in AI_EXCLUDED_BRICKS, with the configs it reads.
+ */
+export type CatalogConfig = {
+    kind: "text";
+    description: string;
+} | {
+    kind: "string";
+    description: string;
+} | {
+    kind: "number";
+    description: string;
+} | {
+    kind: "options";
+    description: string;
+};
+export type CatalogDataType = "string" | "number" | "boolean" | "array" | "void";
+export interface CatalogBrick {
+    id: string;
+    type: BrickType;
+    dataType: CatalogDataType;
+    /** What the brick is for, written for the model. */
+    description: string;
+    /** Configs besides key, label and description, which every field has. */
+    configs: Record<string, CatalogConfig>;
+    /** Whether the brick holds a value under configs.key. */
+    field: boolean;
+    /** "bricks": any brick; "fields": the fields of one row of a collection. */
+    children?: "bricks" | "fields";
+}
+export declare const BRICK_CATALOG: readonly CatalogBrick[];
+/** Registered bricks a model does not write, and why. */
+export declare const AI_EXCLUDED_BRICKS: Readonly<Record<string, string>>;
+export declare const catalogBrick: (id: string) => CatalogBrick | undefined;

package/dist/ai/from-strict-spec.d.ts

@@ -0,0 +1,9 @@
+import type { BrickSpec } from "../utils/brick-spec.js";
+/**
+ * Turns what a model wrote against schema/form-spec.strict.schema.json into a
+ * canonical spec that fk-form-render and validateFormData take unchanged: it
+ * unwraps { form }, drops the nulls strict mode fills absent properties with,
+ * restores type, dataType and name from the brick id, and expands hiddenWhen /
+ * disabledWhen into rules. A form whose root is not a panel gets a column.
+ */
+export declare function fromStrictSpec(output: unknown): BrickSpec;

package/dist/index.d.ts

@@ -3,9 +3,11 @@ export { BrickMold } from "./utils/brick-mold.js";
 export { DropType, BrickMoldDropType, BrickSpecDropType } from "./utils/drop-type.js";
 export { BrickStyles } from "./utils/brick-styles.js";
 export { BrickBaseConfigs, CommonBrickProps, WithBrickBaseConfigs } from "./utils/common-brick-props.js";
-export { BrickSpec, buildValidationSchema, iterateBricks, iterateSchemaBricks, defaultFormData, } from "./utils/brick-spec.js";
+export { BrickLayout, BrickSpec, RowTrack, buildValidationSchema, iterateBricks, iterateSchemaBricks, defaultFormData, } from "./utils/brick-spec.js";
 export { getBrickData, wrapBrickData } from "./utils/brick-data.js";
 export { SelectOption, normalizeOptions } from "./utils/options.js";
+export { BRICK_CATALOG, AI_EXCLUDED_BRICKS, CatalogBrick, CatalogConfig, CatalogDataType, catalogBrick } from "./ai/brick-catalog.js";
+export { fromStrictSpec } from "./ai/from-strict-spec.js";
 export { RecapItem, collectRecapItems } from "./utils/recap.js";
 export { FieldDescriptor, CollectFieldsOptions, collectFields } from "./utils/fields.js";
 export { IdentityFormat, IDENTITY_FORMATS, checkIdentity, checkFrNir, checkBjNpi, checkDigits, checkLuhn, checkFrSiren, checkFrSiret, checkBjIfu, checkIban, formatIban } from "./utils/identity.js";

package/dist/index.js

@@ -7130,6 +7130,154 @@ function normalizeOptions(raw, labelKey = "label", valueKey = "value") {
   return String(raw ?? "").split(`
 `).map((line) => line.trim()).filter(Boolean).map((line) => ({ label: line, value: line }));
 }
+// lib/ai/brick-catalog.ts
+var placeholder = { kind: "text", description: "Example shown in the empty control." };
+var options = { kind: "options", description: "The choices, in display order: label shown, value stored." };
+var field = (id, dataType, description, configs = {}) => ({ id, type: "input", dataType, description, configs, field: true });
+var BRICK_CATALOG = [
+  field("text", "string", "One line of free text.", {
+    placeholder,
+    mask: { kind: "string", description: "Input mask: 9 a digit, a a letter, A a letter in capitals, * either; other characters are inserted as they are." }
+  }),
+  field("textarea", "string", "Several lines of free text.", { placeholder }),
+  field("email", "string", "An email address.", { placeholder }),
+  field("url", "string", "A web address (https://…).", { placeholder }),
+  field("phone", "string", "A phone number.", {
+    placeholder,
+    mask: { kind: "string", description: "Input mask: 9 a digit, other characters inserted as they are, for example +228 99 99 99 99." }
+  }),
+  field("number", "number", "A number.", {
+    placeholder,
+    prefix: { kind: "text", description: "Shown before the control, for example a currency." },
+    suffix: { kind: "text", description: "Shown after the control, for example a unit." }
+  }),
+  field("date", "string", "A date, stored as YYYY-MM-DD."),
+  field("time", "string", "A time of day, stored as HH:MM."),
+  field("datetime", "string", "A date and a time."),
+  field("checkbox", "boolean", "A yes/no box; the label sits beside it. Use it for each item of a list someone ticks."),
+  field("select", "string", "One choice in a drop-down list. Prefer radio for 2 to 4 short choices.", { placeholder, options }),
+  field("radio", "string", "One choice among a few options, all visible.", { options }),
+  field("multi-select", "array", "Several choices in a drop-down list.", { placeholder, options }),
+  field("select-boxes", "array", "Several choices, one box each, all visible.", { options }),
+  {
+    id: "data-grid",
+    type: "collection",
+    dataType: "array",
+    description: "A table whose rows the person adds; children are the fields of one row.",
+    configs: {},
+    field: true,
+    children: "fields"
+  },
+  {
+    id: "content",
+    type: "output",
+    dataType: "void",
+    description: "Fixed text shown to the person, not a question. Put it above or below a row, not in it.",
+    configs: { content: { kind: "text", description: "The text, one paragraph per line." } },
+    field: false
+  },
+  {
+    id: "group",
+    type: "panel",
+    dataType: "void",
+    description: "A titled box around related bricks.",
+    configs: { label: { kind: "text", description: "The group's title." } },
+    field: false,
+    children: "bricks"
+  },
+  {
+    id: "row",
+    type: "panel",
+    dataType: "void",
+    description: "Bricks side by side; they stack on narrow screens. Put in one row only questions shown together.",
+    configs: {},
+    field: false,
+    children: "bricks"
+  },
+  {
+    id: "column",
+    type: "panel",
+    dataType: "void",
+    description: "Bricks one under the other; the usual root of a form.",
+    configs: {},
+    field: false,
+    children: "bricks"
+  }
+];
+var AI_EXCLUDED_BRICKS = {
+  password: "a form written by a model must not ask for a password",
+  hidden: "carries a value the host sets, not one a person enters",
+  tags: "free list of words; select-boxes or textarea cover what a model needs",
+  signature: "legal capture belongs in forms a person designs",
+  "geo-point": "needs the host's map tiles",
+  "geo-area": "needs the host's map tiles",
+  "geo-address": "needs the host's search and map services",
+  "geo-layer": "needs the host's layers",
+  "national-id": "country identifier formats are a design decision",
+  mrz: "identity documents belong in forms a person designs",
+  "tax-id": "country identifier formats are a design decision",
+  iban: "bank details belong in forms a person designs",
+  money: "currency lists are a design decision",
+  appointment: "needs the host's slot provider",
+  document: "needs the host's document reader",
+  measure: "unit families are a design decision",
+  "vehicle-plate": "country plate formats are a design decision",
+  "company-registry": "country registry formats are a design decision",
+  "date-range": "two dates cover it",
+  tabs: "navigation belongs in forms a person designs",
+  stepper: "navigation belongs in forms a person designs",
+  address: "the host's address model is a design decision",
+  file: "needs the host's upload service",
+  "key-value": "free-form object, not a question",
+  recap: "a summary page, not a question",
+  code: "a code editor is not a question for a person",
+  "nested-form": "references the host's stored forms"
+};
+var byId = new Map(BRICK_CATALOG.map((brick) => [brick.id, brick]));
+var catalogBrick = (id) => byId.get(id);
+// lib/ai/from-strict-spec.ts
+var isNode = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+var present = (record) => Object.fromEntries(Object.entries(record).filter(([, value]) => value !== null));
+var RULE_TARGETS = { hiddenWhen: "hidden", disabledWhen: "disabled" };
+var rulesOf = (node) => Object.keys(RULE_TARGETS).filter((name) => isNode(node[name])).map((name) => ({
+  name,
+  type: "jsonLogic",
+  logic: node[name],
+  effects: [{ property: { target: RULE_TARGETS[name], type: "boolean" }, boolean: true }]
+}));
+var toBrick = (node, path) => {
+  if (!isNode(node))
+    throw new Error(`fromStrictSpec: ${path} is not a brick`);
+  const id = String(node.id);
+  const entry = catalogBrick(id);
+  if (!entry)
+    throw new Error(`fromStrictSpec: ${path} has an unknown brick id "${id}"`);
+  const configs = isNode(node.configs) ? present(node.configs) : {};
+  if ("options" in configs && (id === "select" || id === "multi-select"))
+    configs.optionsSource = "static";
+  const validations = Array.isArray(node.validations) ? node.validations.filter(isNode).map((validation2) => present(validation2)) : [];
+  const rules = rulesOf(node);
+  const layout = isNode(node.layout) ? present(node.layout) : {};
+  const children = Array.isArray(node.children) ? node.children.map((child, index) => toBrick(child, `${path}.${index}`)) : [];
+  return {
+    type: entry.type,
+    dataType: entry.dataType,
+    id,
+    name: String(configs.label ?? configs.key ?? id),
+    configs,
+    ...validations.length ? { validations } : {},
+    ...rules.length ? { rules } : {},
+    ...Object.keys(layout).length ? { layout } : {},
+    ...children.length ? { children } : {}
+  };
+};
+function fromStrictSpec(output) {
+  const root = isNode(output) && "form" in output ? output.form : output;
+  const spec = toBrick(root, "form");
+  if (spec.type === "panel")
+    return spec;
+  return { type: "panel", dataType: "void", id: "column", name: "Form", configs: {}, children: [spec] };
+}
 // lib/i18n.ts
 var en = {
   "palette.search": "Search bricks…",
@@ -8962,6 +9110,7 @@ function documentFillPatch(fields, fills) {
 var flaggedKeys = (annotations) => Object.entries(annotations ?? {}).filter(([, annotation]) => annotation?.incorrect === true).map(([key]) => key);
 // lib/utils/lint-spec.ts
 var isDataCarrying = (brick) => brick.type === "input" || brick.type === "collection";
+var isRow = (brick) => brick.type === "panel" && brick.id === "row";
 function lintSpec(spec) {
   if (!spec)
     return [];
@@ -9008,6 +9157,17 @@ function lintSpec(spec) {
         message: `collection "${key ?? brick.id}" has no row template — it can never produce data`
       });
     }
+    if (isRow(brick)) {
+      for (const [index, child] of (brick.children ?? []).entries()) {
+        if (child?.type !== "output")
+          continue;
+        issues.push({
+          code: "content-in-row",
+          path: `${path}.${index}`,
+          message: `${child.id} brick in a row takes a column like a field and reads as a label without one — place it above or below the row`
+        });
+      }
+    }
   }
   return issues;
 }
@@ -10065,6 +10225,8 @@ async function expandSpec(spec, options = {}) {
   return expandBrick(structuredClone(spec), []);
 }
 export {
+  AI_EXCLUDED_BRICKS,
+  BRICK_CATALOG,
   Base64FileUploadService,
   Brick,
   FetchDataSourceService,
@@ -10082,6 +10244,7 @@ export {
   addBrick,
   appendSearchParam,
   buildValidationSchema,
+  catalogBrick,
   checkBjIfu,
   checkBjNpi,
   checkCompanyRegistry,
@@ -10113,6 +10276,7 @@ export {
   formatMeasure,
   formatPlate,
   frFkTranslations,
+  fromStrictSpec,
   generateSlots,
   getAffectedProperties,
   getBrickAt,
@@ -10159,5 +10323,5 @@ export {
   wrapBrickData
 };
 
-//# debugId=C3D4B3C74EC4E31D64756E2164756E21
+//# debugId=4A8FDDA420C6F9E564756E2164756E21
 //# sourceMappingURL=index.js.map