@antelopejs/interface-dms 0.3.5 → 0.4.0

package/dist/base/form-block-schema.js

@@ -1,11 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FormSchema = exports.SubmitMessageOptions = exports.FORM_COMPONENT_NAME = void 0;
+exports.FormSchema = exports.SubmitMessageOptions = void 0;
 const zod_1 = require("zod");
 const block_registry_1 = require("./block-registry");
+const form_types_1 = require("./form-types");
 const http_1 = require("./types/http");
-exports.FORM_COMPONENT_NAME = "dms-form";
+const form_block_schema_1 = require("./internal/form-block-schema");
 const FIELD_ORIENTATIONS = ["horizontal", "vertical"];
+// Named for the config panel, which offers a form's entries as one or the
+// other of these: two branches both called after their kind read as one.
 const FormFieldSchema = (0, block_registry_1.ui)(zod_1.z.object({
     id: (0, block_registry_1.ui)(zod_1.z.string().describe("Field key in the submitted payload."), {
         label: "Key",
@@ -16,6 +19,10 @@ const FormFieldSchema = (0, block_registry_1.ui)(zod_1.z.object({
         label: "Help text",
         widget: "textarea",
     }),
+    hint: (0, block_registry_1.ui)(zod_1.z.string().optional(), {
+        label: "Hint under the control",
+        widget: "textarea",
+    }),
     type: (0, block_registry_1.ui)((0, block_registry_1.requiredOpaqueOption)().describe("The field's data type."), {
         label: "Type",
         widget: "dataType",
@@ -27,6 +34,11 @@ const FormFieldSchema = (0, block_registry_1.ui)(zod_1.z.object({
         label: "Disabled",
         widget: "switch",
     }),
+    readonly: (0, block_registry_1.ui)((0, block_registry_1.opaqueOption)().optional(), {
+        label: "Read-only",
+        widget: "json",
+        advanced: true,
+    }),
     required: (0, block_registry_1.ui)(zod_1.z.boolean().optional(), {
         label: "Required",
         widget: "switch",
@@ -58,7 +70,29 @@ const FieldGroupSchema = (0, block_registry_1.ui)(zod_1.z.object({
     }),
     order: (0, block_registry_1.ui)(zod_1.z.number().optional(), { label: "Order" }),
 }), { label: "Group" });
+// Group first: a field's opaque type would otherwise match a group and strip its fields.
+const FormEntriesSchema = zod_1.z.array(zod_1.z.union([FieldGroupSchema, FormFieldSchema]));
+const FormSectionSchema = (0, block_registry_1.ui)(zod_1.z.object({
+    id: (0, block_registry_1.ui)(zod_1.z.string().describe("Anchor of the section."), {
+        label: "Key",
+        derivedFrom: "label",
+    }),
+    label: (0, block_registry_1.ui)(zod_1.z.string(), { label: "Title" }),
+    description: (0, block_registry_1.ui)(zod_1.z.string().optional(), {
+        label: "Help text",
+        widget: "textarea",
+    }),
+    icon: (0, block_registry_1.ui)(zod_1.z.string().optional(), { label: "Icon", widget: "icon" }),
+    fields: (0, block_registry_1.ui)(FormEntriesSchema, { label: "Fields" }),
+}), { label: "Section" });
 const SUBMIT_MESSAGES = "Custom submit messages";
+/**
+ * The two messages a form shows once it is submitted.
+ *
+ * Left out, the form says its own, in the reader's language — or, on a failure,
+ * whatever the server answered. They sit behind one switch, and what they
+ * suggest is those same words in English, for an author to start from.
+ */
 exports.SubmitMessageOptions = {
     successMessage: (0, block_registry_1.ui)(zod_1.z.string().optional(), {
         label: "Success message",
@@ -73,6 +107,7 @@ exports.SubmitMessageOptions = {
         optIn: SUBMIT_MESSAGES,
     }),
 };
+/** The options `Form` accepts, without loading its runtime or models. */
 exports.FormSchema = zod_1.z.object({
     title: (0, block_registry_1.ui)(zod_1.z.string().optional(), { label: "Title", group: "content" }),
     description: (0, block_registry_1.ui)(zod_1.z.string().optional(), {
@@ -80,9 +115,22 @@ exports.FormSchema = zod_1.z.object({
         group: "content",
         widget: "textarea",
     }),
-    fields: (0, block_registry_1.ui)(zod_1.z
-        .array(zod_1.z.union([FieldGroupSchema, FormFieldSchema]))
-        .describe("The fields and field groups the form renders."), { label: "Fields", group: "content" }),
+    fields: (0, block_registry_1.ui)(FormEntriesSchema.optional().describe("The fields and field groups the form renders."), { label: "Fields", group: "content" }),
+    sections: (0, block_registry_1.ui)(zod_1.z
+        .array(FormSectionSchema)
+        .optional()
+        .describe("The form's fields split into titled cards."), { label: "Sections", group: "content" }),
+    sectionNav: (0, block_registry_1.ui)(zod_1.z
+        .enum(form_types_1.FORM_SECTION_NAVS)
+        .optional()
+        .describe("How a sectioned form lists its sections: beside them, as chips above them, or not at all."), {
+        label: "Section navigation",
+        group: "layout",
+        widget: "segmented",
+        valueLabels: { side: "Side", jump: "Chips", none: "None" },
+    }),
+    // Addresses and methods: written by the builder from the table an author
+    // picks in its simple view, and typed in its advanced one.
     fetchUrl: (0, block_registry_1.ui)(zod_1.z.string().optional().describe("Endpoint the initial values come from."), {
         label: "Load from",
         group: "data",
@@ -112,16 +160,39 @@ exports.FormSchema = zod_1.z.object({
         label: "Submit button label",
         group: "content",
     }),
-    showActions: (0, block_registry_1.ui)(zod_1.z
-        .boolean()
+    saveMode: (0, block_registry_1.ui)(zod_1.z
+        .enum(form_types_1.FORM_SAVE_MODES)
         .optional()
-        .describe("Show the reset and submit buttons, before the form has somewhere to submit to too."), {
-        label: "Show the buttons",
+        .describe("How the form offers to save: a sticky bar while there are changes, footer buttons, none, or each change on its own."), {
+        label: "Save buttons",
         group: "appearance",
-        widget: "switch",
-        initial: true,
+        widget: "select",
+        valueLabels: {
+            bar: "Save bar",
+            footer: "Footer buttons",
+            none: "None",
+            instant: "Instant",
+        },
+    }),
+    kind: (0, block_registry_1.ui)(zod_1.z
+        .enum(form_types_1.FORM_KINDS)
+        .optional()
+        .describe("A record keeps its values once saved; an action (send, invite, run) empties after a submit."), {
+        label: "Form kind",
+        group: "behavior",
+        widget: "segmented",
+        valueLabels: { record: "Record", action: "Action" },
+    }),
+    backTo: (0, block_registry_1.ui)(zod_1.z.string().optional().describe("Where Cancel leads a record form."), {
+        label: "Cancel leads to",
+        group: "behavior",
+        widget: "url",
         advanced: true,
     }),
+    labelKey: (0, block_registry_1.ui)(zod_1.z
+        .string()
+        .optional()
+        .describe("Field of the loaded record that ends the page's breadcrumb."), { label: "Record label field", group: "data", advanced: true }),
     fieldsOrientation: (0, block_registry_1.ui)(zod_1.z.enum(FIELD_ORIENTATIONS).optional(), {
         label: "Field orientation",
         group: "layout",
@@ -143,7 +214,7 @@ exports.FormSchema = zod_1.z.object({
 });
 (0, block_registry_1.RegisterBlockType)({
     type: "Form",
-    componentName: exports.FORM_COMPONENT_NAME,
+    componentName: form_block_schema_1.FORM_COMPONENT_NAME,
     schema: exports.FormSchema,
     meta: {
         name: "Form",

package/dist/base/form-block-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"form-block-schema.js","sourceRoot":"","sources":["../../src/base/form-block-schema.ts"],"names":[],"mappings":";;;AACA,6BAAwB;AACxB,qDAM0B;AAI1B,uCAA0C;AAG7B,QAAA,mBAAmB,GAAG,UAAU,CAAC;AAE9C,MAAM,kBAAkB,GAAG,CAAC,YAAY,EAAE,UAAU,CAAU,CAAC;AAI/D,MAAM,eAAe,GAAG,IAAA,mBAAE,EACxB,OAAC,CAAC,MAAM,CAAC;IACP,EAAE,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,qCAAqC,CAAC,EAAE;QACjE,KAAK,EAAE,KAAK;QACZ,WAAW,EAAE,OAAO;KACrB,CAAC;IACF,KAAK,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IACpD,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,WAAW;QAClB,MAAM,EAAE,UAAU;KACnB,CAAC;IACF,IAAI,EAAE,IAAA,mBAAE,EACN,IAAA,qCAAoB,GAAY,CAAC,QAAQ,CAAC,wBAAwB,CAAC,EACnE;QACE,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,UAAU;KACnB,CACF;IACD,cAAc,EAAE,IAAA,mBAAE,EAAC,IAAA,6BAAY,GAA2B,CAAC,QAAQ,EAAE,EAAE;QACrE,MAAM,EAAE,IAAI;KACb,CAAC;IACF,QAAQ,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QACnC,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,QAAQ,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QACnC,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,YAAY,EAAE,IAAA,mBAAE,EAAC,IAAA,6BAAY,GAAgB,CAAC,QAAQ,EAAE,EAAE;QACxD,KAAK,EAAE,eAAe;QACtB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,MAAM;KAChB,CAAC;IACF,SAAS,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QACpC,KAAK,EAAE,cAAc;QACrB,MAAM,EAAE,QAAQ;KACjB,CAAC;CACH,CAAsC,EACvC,EAAE,KAAK,EAAE,OAAO,EAAE,CACnB,CAAC;AAEF,MAAM,gBAAgB,GAAG,IAAA,mBAAE,EACzB,OAAC,CAAC,MAAM,CAAC;IACP,EAAE,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,4BAA4B,CAAC,EAAE;QACxD,KAAK,EAAE,KAAK;QACZ,WAAW,EAAE,OAAO;KACrB,CAAC;IACF,KAAK,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IACpD,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,WAAW;QAClB,MAAM,EAAE,UAAU;KACnB,CAAC;IACF,MAAM,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;IACzD,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE,EAAE;QACrD,KAAK,EAAE,mBAAmB;QAC1B,MAAM,EAAE,WAAW;KACpB,CAAC;IACF,KAAK,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;CACrD,CAAuC,EACxC,EAAE,KAAK,EAAE,OAAO,EAAE,CACnB,CAAC;AAEF,MAAM,eAAe,GAAG,wBAAwB,CAAC;AASpC,QAAA,oBAAoB,GAAG;IAClC,cAAc,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACxC,KAAK,EAAE,iBAAiB;QACxB,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,kCAAkC;QAC/C,KAAK,EAAE,eAAe;KACvB,CAAC;IACF,YAAY,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACtC,KAAK,EAAE,eAAe;QACtB,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,2BAA2B;QACxC,KAAK,EAAE,eAAe;KACvB,CAAC;CACH,CAAC;AAGW,QAAA,UAAU,GAAG,OAAC,CAAC,MAAM,CAAC;IACjC,KAAK,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;IACtE,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,SAAS;QAChB,MAAM,EAAE,UAAU;KACnB,CAAC;IACF,MAAM,EAAE,IAAA,mBAAE,EACR,OAAC;SAEE,KAAK,CAAC,OAAC,CAAC,KAAK,CAAC,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC,CAAC;SACnD,QAAQ,CAAC,+CAA+C,CAAC,EAC5D,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,CACtC;IAGD,QAAQ,EAAE,IAAA,mBAAE,EACV,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,wCAAwC,CAAC,EACxE;QACE,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,IAAI;KACf,CACF;IACD,cAAc,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,UAAU,CAAC,iBAAU,CAAC,CAAC,QAAQ,EAAE,EAAE;QACtD,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,SAAS,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACnC,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,eAAe,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,UAAU,CAAC,iBAAU,CAAC,CAAC,QAAQ,EAAE,EAAE;QACvD,KAAK,EAAE,eAAe;QACtB,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,GAAG,4BAAoB;IACvB,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,qBAAqB;QAC5B,KAAK,EAAE,SAAS;KACjB,CAAC;IACF,WAAW,EAAE,IAAA,mBAAE,EACb,OAAC;SACE,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP,oFAAoF,CACrF,EACH;QACE,KAAK,EAAE,kBAAkB;QACzB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,QAAQ;QAChB,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,IAAI;KACf,CACF;IACD,iBAAiB,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC3D,KAAK,EAAE,mBAAmB;QAC1B,KAAK,EAAE,QAAQ;QACf,MAAM,EAAE,WAAW;KACpB,CAAC;IACF,iBAAiB,EAAE,IAAA,mBAAE,EACnB,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qCAAqC,CAAC,EACrE;QACE,KAAK,EAAE,qBAAqB;QAC5B,KAAK,EAAE,UAAU;KAClB,CACF;IACD,cAAc,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE;QACnD,KAAK,EAAE,kBAAkB;QACzB,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,MAAM;KACf,CAAC;IACF,MAAM,EAAE,IAAA,mBAAE,EACR,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,wCAAwC,CAAC,EACxE;QACE,KAAK,EAAE,SAAS;QAChB,KAAK,EAAE,UAAU;KAClB,CACF;CACF,CAAsC,CAAC;AAExC,IAAA,kCAAiB,EAAC;IAChB,IAAI,EAAE,MAAM;IACZ,aAAa,EAAE,2BAAmB;IAClC,MAAM,EAAE,kBAAU;IAClB,IAAI,EAAE;QACJ,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,kBAAkB;QACxB,WAAW,EAAE,4DAA4D;QACzE,KAAK,EAAE,MAAM;KACd;CACF,CAAC,CAAC"}
+{"version":3,"file":"form-block-schema.js","sourceRoot":"","sources":["../../src/base/form-block-schema.ts"],"names":[],"mappings":";;;AACA,6BAAwB;AACxB,qDAM0B;AAE1B,6CAQsB;AAEtB,uCAA0C;AAC1C,oEAAmE;AAEnE,MAAM,kBAAkB,GAAG,CAAC,YAAY,EAAE,UAAU,CAAU,CAAC;AAE/D,0EAA0E;AAC1E,yEAAyE;AACzE,MAAM,eAAe,GAAG,IAAA,mBAAE,EACxB,OAAC,CAAC,MAAM,CAAC;IACP,EAAE,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,qCAAqC,CAAC,EAAE;QACjE,KAAK,EAAE,KAAK;QACZ,WAAW,EAAE,OAAO;KACrB,CAAC;IACF,KAAK,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IACpD,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,WAAW;QAClB,MAAM,EAAE,UAAU;KACnB,CAAC;IACF,IAAI,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QAC9B,KAAK,EAAE,wBAAwB;QAC/B,MAAM,EAAE,UAAU;KACnB,CAAC;IACF,IAAI,EAAE,IAAA,mBAAE,EACN,IAAA,qCAAoB,GAAY,CAAC,QAAQ,CAAC,wBAAwB,CAAC,EACnE;QACE,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,UAAU;KACnB,CACF;IACD,cAAc,EAAE,IAAA,mBAAE,EAAC,IAAA,6BAAY,GAA2B,CAAC,QAAQ,EAAE,EAAE;QACrE,MAAM,EAAE,IAAI;KACb,CAAC;IACF,QAAQ,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QACnC,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,QAAQ,EAAE,IAAA,mBAAE,EAAC,IAAA,6BAAY,GAAyB,CAAC,QAAQ,EAAE,EAAE;QAC7D,KAAK,EAAE,WAAW;QAClB,MAAM,EAAE,MAAM;QACd,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,QAAQ,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QACnC,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,YAAY,EAAE,IAAA,mBAAE,EAAC,IAAA,6BAAY,GAAgB,CAAC,QAAQ,EAAE,EAAE;QACxD,KAAK,EAAE,eAAe;QACtB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,MAAM;KAChB,CAAC;IACF,SAAS,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QACpC,KAAK,EAAE,cAAc;QACrB,MAAM,EAAE,QAAQ;KACjB,CAAC;CACH,CAAsC,EACvC,EAAE,KAAK,EAAE,OAAO,EAAE,CACnB,CAAC;AAEF,MAAM,gBAAgB,GAAG,IAAA,mBAAE,EACzB,OAAC,CAAC,MAAM,CAAC;IACP,EAAE,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,4BAA4B,CAAC,EAAE;QACxD,KAAK,EAAE,KAAK;QACZ,WAAW,EAAE,OAAO;KACrB,CAAC;IACF,KAAK,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IACpD,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,WAAW;QAClB,MAAM,EAAE,UAAU;KACnB,CAAC;IACF,MAAM,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;IACzD,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE,EAAE;QACrD,KAAK,EAAE,mBAAmB;QAC1B,MAAM,EAAE,WAAW;KACpB,CAAC;IACF,KAAK,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;CACrD,CAAuC,EACxC,EAAE,KAAK,EAAE,OAAO,EAAE,CACnB,CAAC;AAEF,yFAAyF;AACzF,MAAM,iBAAiB,GAAG,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,KAAK,CAAC,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;AAEhF,MAAM,iBAAiB,GAAG,IAAA,mBAAE,EAC1B,OAAC,CAAC,MAAM,CAAC;IACP,EAAE,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,wBAAwB,CAAC,EAAE;QACpD,KAAK,EAAE,KAAK;QACZ,WAAW,EAAE,OAAO;KACrB,CAAC;IACF,KAAK,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IACzC,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,WAAW;QAClB,MAAM,EAAE,UAAU;KACnB,CAAC;IACF,IAAI,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAClE,MAAM,EAAE,IAAA,mBAAE,EAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;CACnD,CAAwC,EACzC,EAAE,KAAK,EAAE,SAAS,EAAE,CACrB,CAAC;AAEF,MAAM,eAAe,GAAG,wBAAwB,CAAC;AAEjD;;;;;;GAMG;AACU,QAAA,oBAAoB,GAAG;IAClC,cAAc,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACxC,KAAK,EAAE,iBAAiB;QACxB,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,kCAAkC;QAC/C,KAAK,EAAE,eAAe;KACvB,CAAC;IACF,YAAY,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACtC,KAAK,EAAE,eAAe;QACtB,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,2BAA2B;QACxC,KAAK,EAAE,eAAe;KACvB,CAAC;CACH,CAAC;AAEF,yEAAyE;AAC5D,QAAA,UAAU,GAAG,OAAC,CAAC,MAAM,CAAC;IACjC,KAAK,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;IACtE,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,SAAS;QAChB,MAAM,EAAE,UAAU;KACnB,CAAC;IACF,MAAM,EAAE,IAAA,mBAAE,EACR,iBAAiB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CACnC,+CAA+C,CAChD,EACD,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,CACtC;IACD,QAAQ,EAAE,IAAA,mBAAE,EACV,OAAC;SACE,KAAK,CAAC,iBAAiB,CAAC;SACxB,QAAQ,EAAE;SACV,QAAQ,CAAC,4CAA4C,CAAC,EACzD,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,SAAS,EAAE,CACxC;IACD,UAAU,EAAE,IAAA,mBAAE,EACZ,OAAC;SACE,IAAI,CAAC,8BAAiB,CAAC;SACvB,QAAQ,EAAE;SACV,QAAQ,CACP,2FAA2F,CAC5F,EACH;QACE,KAAK,EAAE,oBAAoB;QAC3B,KAAK,EAAE,QAAQ;QACf,MAAM,EAAE,WAAW;QACnB,WAAW,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE;KAC3D,CACF;IACD,yEAAyE;IACzE,2DAA2D;IAC3D,QAAQ,EAAE,IAAA,mBAAE,EACV,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,wCAAwC,CAAC,EACxE;QACE,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,IAAI;KACf,CACF;IACD,cAAc,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,UAAU,CAAC,iBAAU,CAAC,CAAC,QAAQ,EAAE,EAAE;QACtD,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,SAAS,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACnC,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,eAAe,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,UAAU,CAAC,iBAAU,CAAC,CAAC,QAAQ,EAAE,EAAE;QACvD,KAAK,EAAE,eAAe;QACtB,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,GAAG,4BAAoB;IACvB,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,qBAAqB;QAC5B,KAAK,EAAE,SAAS;KACjB,CAAC;IACF,QAAQ,EAAE,IAAA,mBAAE,EACV,OAAC;SACE,IAAI,CAAC,4BAAe,CAAC;SACrB,QAAQ,EAAE;SACV,QAAQ,CACP,qHAAqH,CACtH,EACH;QACE,KAAK,EAAE,cAAc;QACrB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,QAAQ;QAChB,WAAW,EAAE;YACX,GAAG,EAAE,UAAU;YACf,MAAM,EAAE,gBAAgB;YACxB,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,SAAS;SACnB;KACF,CACF;IACD,IAAI,EAAE,IAAA,mBAAE,EACN,OAAC;SACE,IAAI,CAAC,uBAAU,CAAC;SAChB,QAAQ,EAAE;SACV,QAAQ,CACP,6FAA6F,CAC9F,EACH;QACE,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,WAAW;QACnB,WAAW,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE;KACpD,CACF;IACD,MAAM,EAAE,IAAA,mBAAE,EACR,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,mCAAmC,CAAC,EACnE;QACE,KAAK,EAAE,iBAAiB;QACxB,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,IAAI;KACf,CACF;IACD,QAAQ,EAAE,IAAA,mBAAE,EACV,OAAC;SACE,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,6DAA6D,CAAC,EAC1E,EAAE,KAAK,EAAE,oBAAoB,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAC/D;IACD,iBAAiB,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC3D,KAAK,EAAE,mBAAmB;QAC1B,KAAK,EAAE,QAAQ;QACf,MAAM,EAAE,WAAW;KACpB,CAAC;IACF,iBAAiB,EAAE,IAAA,mBAAE,EACnB,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qCAAqC,CAAC,EACrE;QACE,KAAK,EAAE,qBAAqB;QAC5B,KAAK,EAAE,UAAU;KAClB,CACF;IACD,cAAc,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE;QACnD,KAAK,EAAE,kBAAkB;QACzB,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,MAAM;KACf,CAAC;IACF,MAAM,EAAE,IAAA,mBAAE,EACR,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,wCAAwC,CAAC,EACxE;QACE,KAAK,EAAE,SAAS;QAChB,KAAK,EAAE,UAAU;KAClB,CACF;CACF,CAAsC,CAAC;AAExC,IAAA,kCAAiB,EAAC;IAChB,IAAI,EAAE,MAAM;IACZ,aAAa,EAAE,uCAAmB;IAClC,MAAM,EAAE,kBAAU;IAClB,IAAI,EAAE;QACJ,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,kBAAkB;QACxB,WAAW,EAAE,4DAA4D;QACzE,KAAK,EAAE,MAAM;KACd;CACF,CAAC,CAAC"}

package/dist/base/form-schema.d.ts

@@ -1,18 +1,31 @@
 import { type ComponentInfoSerialized } from "../component";
 import { z } from "zod";
 import type { DefaultDataTypes } from "./data-types/default-types";
-import type { TreeNode } from "./tree";
+import type { FormContainerPageTexts } from "./table-view/options";
 import type { AxeOrientation, EnumOption } from "./types";
+import { FormBuilder, FormField, FormFieldOrGroup, FormFieldOrGroupSerialized, FormFunctions, FormProps, FormPropsSerialized } from "./form-types";
 export * from "./form-block-schema";
-import { FormBuilder, FormFieldOrGroup, FormFieldOrGroupSerialized, FormFunctions, FormProps, FormPropsSerialized } from "./form-types";
+/**
+ * Adapts a Zod schema to handle localization and optional/required state
+ */
 export declare function adaptFieldValidationSchema(baseSchema: z.ZodTypeAny, options: {
     localized?: boolean;
     required?: boolean;
 }): z.ZodTypeAny;
+/** Whether a field is a box to tick: required, only `true` passes. */
+export declare function isAcceptanceField(field: FormField): boolean;
 export declare function buildFormSchema(fields: FormFieldOrGroup[]): z.ZodObject<Record<string, z.ZodTypeAny>>;
+/** Every entry of a form: its own fields and groups, then each section's. */
+export declare function formEntries(options: Pick<FormProps, "fields" | "sections">): FormFieldOrGroup[];
 export type FormSchemaSource = FormFieldOrGroup[] | FormProps | FormBuilder;
 export declare function formSchema(source: FormSchemaSource): z.ZodObject<Record<string, z.ZodTypeAny>>;
 export declare function serializeFormFields(fields: FormFieldOrGroup[]): FormFieldOrGroupSerialized[];
+/**
+ * `options` is optional because a page is written as it is built: the editor
+ * places a block before anything is configured, and writes that as the bare
+ * call `Form()`. A page under construction has to compile — it is typechecked
+ * on every edit — so a block with nothing set yet has to be a legal call.
+ */
 export declare const Form: (options?: FormProps) => FormBuilder;
 export declare namespace FormComponents {
     interface RichTextOptions {
@@ -21,11 +34,92 @@ export declare namespace FormComponents {
     interface SelectOption {
         label: string;
         value: string | number;
+        /** A line under the label, where the display shows one (cards, radio). */
+        description?: string;
         disabled?: boolean;
         icon?: string;
         iconColor?: string;
         textColor?: string;
     }
+    /** The text a boolean control shows beside it, or a card's title and body. */
+    interface BooleanControlOptions {
+        label?: string;
+        description?: string;
+    }
+    interface BooleanCardOptions extends BooleanControlOptions {
+        icon?: string;
+    }
+    interface ChoiceCardsOptions {
+        items: SelectOption[];
+        multiple?: boolean;
+    }
+    interface SegmentedSelectOptions {
+        items: SelectOption[];
+    }
+    /** A field of the rows a repeater edits: one column. */
+    interface RepeaterColumn {
+        id: string;
+        /** Eyebrow header of the column. */
+        label?: string;
+        /** Data type id of the field. */
+        type?: string;
+        component: ComponentInfoSerialized;
+        required?: boolean;
+    }
+    interface RepeaterOptions {
+        columns: RepeaterColumn[];
+        /** Rows reordered by a drag handle. */
+        sortable?: boolean;
+        min?: number;
+        max?: number;
+        /** Label of the "+ Add …" button (i18n key or literal). */
+        addLabel?: string;
+    }
+    /** The value column of a key-value editor. */
+    interface KeyValueColumn {
+        type?: string;
+        component: ComponentInfoSerialized;
+    }
+    interface KeyValueOptions {
+        value: KeyValueColumn;
+        /** Each pair has a box turning it on or off. */
+        toggleable?: boolean;
+        addLabel?: string;
+        keyLabel?: string;
+        valueLabel?: string;
+    }
+    interface SecretOptions {
+        revealable?: boolean;
+        copyable?: boolean;
+        /** POSTed (after a confirmation) to get a new value, `{ value }`. */
+        rotateUrl?: string;
+        placeholder?: string;
+    }
+    interface CopyableTextOptions {
+        placeholder?: string;
+    }
+    /** A suggestion of a code editor's autocomplete. */
+    interface CodeCompletion {
+        label: string;
+        detail?: string;
+        icon?: string;
+    }
+    interface CodeOptions {
+        language: string;
+        lineNumbers?: boolean;
+        minLines?: number;
+        maxLines?: number;
+        /** GET, answering `{ items: CodeCompletion[] }` or a list of them. */
+        completionsUrl?: string;
+        completions?: CodeCompletion[];
+        placeholder?: string;
+    }
+    interface TagsOptions {
+        itemType?: string;
+        max?: number;
+        suggestions?: string[];
+        placeholder?: string;
+    }
     interface InputEmailOptions {
         placeholder?: string;
     }
@@ -68,22 +162,6 @@ export declare namespace FormComponents {
         multiple?: boolean;
         deselectable?: boolean;
     }
-    interface TreeOptions {
-        items?: TreeNode[];
-        fetchUrl?: string;
-        placeholder?: string;
-        multiple?: boolean;
-    }
-    interface PermissionsTreeNode {
-        id: string;
-        label: string;
-        icon?: string;
-        children?: PermissionsTreeNode[];
-    }
-    interface PermissionsTreeOptions {
-        permissions?: PermissionsTreeNode[];
-        fetchUrl?: string;
-    }
     interface RelationOptions {
         placeholder?: string;
         searchUrl: string;
@@ -96,7 +174,17 @@ export declare namespace FormComponents {
             disabled?: string;
         };
         addForm?: ComponentInfoSerialized<FormPropsSerialized>;
+        /**
+         * The `add` permission of each TableView mounted on the related
+         * controller: the inline add form posts to their shared `new` route, which
+         * any one of them grants.
+         */
         addPermissionIds?: string[];
+        /**
+         * Title and description of the drawer the "add" entry opens.
+         * `$`-prefixed: i18n keys.
+         */
+        addFormTexts?: FormContainerPageTexts;
     }
     interface CascaderRelationKeyMapping {
         label: string;
@@ -145,6 +233,10 @@ export declare namespace FormComponents {
             countrySubdivision?: string;
             countryCode?: string;
         };
+        /**
+         * Address autocomplete (defaults to the public Photon geocoder when
+         * enabled). Set `url` to use a self-hosted / alternative provider.
+         */
         autocomplete?: DefaultDataTypes.AddressAutocomplete;
     }
     interface FileOptions {
@@ -158,6 +250,13 @@ export declare namespace FormComponents {
         attachmentField?: string;
         visibility?: "private" | "public";
     }
+    /**
+     * Client-side downscaling applied before upload. `cover` crops the image
+     * (centered) to the `maxWidth`/`maxHeight` aspect ratio before scaling down,
+     * `contain` (default) only scales down while preserving the source ratio.
+     * Images already within bounds are uploaded untouched; this is a UX-level
+     * bound, not a server-enforced guarantee.
+     */
     interface ImageResizeOptions {
         maxWidth: number;
         maxHeight: number;
@@ -167,7 +266,25 @@ export declare namespace FormComponents {
         max?: number;
         resize?: ImageResizeOptions;
     }
-    function InputCheckbox(): ComponentInfoSerialized;
+    function InputCheckbox(options?: BooleanControlOptions): ComponentInfoSerialized<BooleanControlOptions>;
+    /** A boolean as a bordered card: an icon, a title and a switch. */
+    function InputBooleanCard(options?: BooleanCardOptions): ComponentInfoSerialized<BooleanCardOptions>;
+    /** The options of a select as cards, one picked or several. */
+    function InputChoiceCards(options: ChoiceCardsOptions): ComponentInfoSerialized<ChoiceCardsOptions>;
+    /** The options of a select as segments of one control. */
+    function InputSegmentedSelect(options: SegmentedSelectOptions): ComponentInfoSerialized<SegmentedSelectOptions>;
+    /** Rows of fields, added, removed and reordered (`ArrayType`). */
+    function InputRepeater(options: RepeaterOptions): ComponentInfoSerialized<RepeaterOptions>;
+    /** Pairs of a name and a value (`KeyValueType`). */
+    function InputKeyValue(options: KeyValueOptions): ComponentInfoSerialized<KeyValueOptions>;
+    /** A secret, masked until shown (`SecretType`). */
+    function InputSecret(options?: SecretOptions): ComponentInfoSerialized<SecretOptions>;
+    /** A read-only value with a copy button (`StringType({ copyable })`). */
+    function InputCopyableText(options?: CopyableTextOptions): ComponentInfoSerialized<CopyableTextOptions>;
+    /** A code editor (`CodeType`). */
+    function InputCode(options: CodeOptions): ComponentInfoSerialized<CodeOptions>;
+    /** A list of short texts typed as tags (`TagsType`). */
+    function InputTags(options?: TagsOptions): ComponentInfoSerialized<TagsOptions>;
     function InputEmail(options?: InputEmailOptions): ComponentInfoSerialized<InputEmailOptions>;
     function InputColor(options?: InputColorOptions): ComponentInfoSerialized<InputColorOptions>;
     function InputPassword(options?: InputPasswordOptions): ComponentInfoSerialized<InputPasswordOptions>;
@@ -181,14 +298,12 @@ export declare namespace FormComponents {
     function InputRelation<T extends RelationOptions>(options: T): ComponentInfoSerialized<T>;
     function InputCascader<T extends CascaderRelationOptions>(options: T): ComponentInfoSerialized<T>;
     function InputSlider(options?: SliderOptions): ComponentInfoSerialized<SliderOptions>;
-    function InputSwitch(): ComponentInfoSerialized;
+    function InputSwitch(options?: BooleanControlOptions): ComponentInfoSerialized<BooleanControlOptions>;
     function InputTextarea(options?: TextareaOptions): ComponentInfoSerialized<TextareaOptions>;
     function Calendar(options?: CalendarOptions): ComponentInfoSerialized<CalendarOptions>;
     function DatePicker(options?: CalendarOptions): ComponentInfoSerialized<CalendarOptions>;
     function DatePickerRange(options?: DatePickerRangeOptions): ComponentInfoSerialized<DatePickerRangeOptions>;
-    function InputTree<T extends TreeOptions>(options: T): ComponentInfoSerialized<T>;
     function InputAddress<T extends AddressOptions>(options?: T): ComponentInfoSerialized<T>;
-    function PermissionsTree<T extends PermissionsTreeOptions>(options: T): ComponentInfoSerialized<T>;
     function RichText(options?: RichTextOptions): ComponentInfoSerialized<RichTextOptions>;
     function File(options?: FileOptions): ComponentInfoSerialized<FileOptions>;
     function Image(options?: ImageOptions): ComponentInfoSerialized<ImageOptions>;