@antelopejs/interface-dms 0.3.5 → 0.4.0

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

@@ -3,14 +3,24 @@ import { z } from "zod";
 import type { DataType } from "./data-types/core";
 import type { DefaultValue } from "./types";
 import { HttpMethod } from "./types/http";
-export declare const FORM_COMPONENT_NAME = "dms-form";
+/**
+ * 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.
+ */
 export declare const SubmitMessageOptions: {
     successMessage: z.ZodOptional<z.ZodString>;
     errorMessage: z.ZodOptional<z.ZodString>;
 };
+/** The options `Form` accepts, without loading its runtime or models. */
 export declare const FormSchema: z.ZodObject<{
     submitLabel: z.ZodOptional<z.ZodString>;
-    showActions: z.ZodOptional<z.ZodBoolean>;
+    saveMode: z.ZodOptional<z.ZodEnum<["bar", "footer", "none", "instant"]>>;
+    kind: z.ZodOptional<z.ZodEnum<["record", "action"]>>;
+    backTo: z.ZodOptional<z.ZodString>;
+    labelKey: z.ZodOptional<z.ZodString>;
     fieldsOrientation: z.ZodOptional<z.ZodEnum<["horizontal", "vertical"]>>;
     redirectOnSuccess: z.ZodOptional<z.ZodString>;
     submitDefaults: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
@@ -19,7 +29,7 @@ export declare const FormSchema: z.ZodObject<{
     errorMessage: z.ZodOptional<z.ZodString>;
     title: z.ZodOptional<z.ZodString>;
     description: z.ZodOptional<z.ZodString>;
-    fields: z.ZodArray<z.ZodUnion<[z.ZodObject<{
+    fields: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodObject<{
         id: z.ZodString;
         label: z.ZodOptional<z.ZodString>;
         description: z.ZodOptional<z.ZodString>;
@@ -27,9 +37,11 @@ export declare const FormSchema: z.ZodObject<{
             id: z.ZodString;
             label: z.ZodOptional<z.ZodString>;
             description: z.ZodOptional<z.ZodString>;
+            hint: z.ZodOptional<z.ZodString>;
             type: z.ZodType<DataType, z.ZodTypeDef, DataType>;
             inputComponent: z.ZodOptional<z.ZodType<ComponentInfoSerialized, z.ZodTypeDef, ComponentInfoSerialized>>;
             disabled: z.ZodOptional<z.ZodBoolean>;
+            readonly: z.ZodOptional<z.ZodType<boolean | import("./form-types").FormFieldReadonly | undefined, z.ZodTypeDef, boolean | import("./form-types").FormFieldReadonly | undefined>>;
             required: z.ZodOptional<z.ZodBoolean>;
             defaultValue: z.ZodOptional<z.ZodType<DefaultValue, z.ZodTypeDef, DefaultValue>>;
             localized: z.ZodOptional<z.ZodBoolean>;
@@ -38,20 +50,24 @@ export declare const FormSchema: z.ZodObject<{
             id: string;
             required?: boolean | undefined;
             description?: string | undefined;
+            readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
             defaultValue?: DefaultValue | undefined;
-            disabled?: boolean | undefined;
             label?: string | undefined;
+            disabled?: boolean | undefined;
             inputComponent?: ComponentInfoSerialized | undefined;
+            hint?: string | undefined;
             localized?: boolean | undefined;
         }, {
             type: DataType;
             id: string;
             required?: boolean | undefined;
             description?: string | undefined;
+            readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
             defaultValue?: DefaultValue | undefined;
-            disabled?: boolean | undefined;
             label?: string | undefined;
+            disabled?: boolean | undefined;
             inputComponent?: ComponentInfoSerialized | undefined;
+            hint?: string | undefined;
             localized?: boolean | undefined;
         }>, "many">;
         orientation: z.ZodOptional<z.ZodEnum<["horizontal", "vertical"]>>;
@@ -63,10 +79,12 @@ export declare const FormSchema: z.ZodObject<{
             id: string;
             required?: boolean | undefined;
             description?: string | undefined;
+            readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
             defaultValue?: DefaultValue | undefined;
-            disabled?: boolean | undefined;
             label?: string | undefined;
+            disabled?: boolean | undefined;
             inputComponent?: ComponentInfoSerialized | undefined;
+            hint?: string | undefined;
             localized?: boolean | undefined;
         }[];
         description?: string | undefined;
@@ -80,10 +98,12 @@ export declare const FormSchema: z.ZodObject<{
             id: string;
             required?: boolean | undefined;
             description?: string | undefined;
+            readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
             defaultValue?: DefaultValue | undefined;
-            disabled?: boolean | undefined;
             label?: string | undefined;
+            disabled?: boolean | undefined;
             inputComponent?: ComponentInfoSerialized | undefined;
+            hint?: string | undefined;
             localized?: boolean | undefined;
         }[];
         description?: string | undefined;
@@ -94,9 +114,11 @@ export declare const FormSchema: z.ZodObject<{
         id: z.ZodString;
         label: z.ZodOptional<z.ZodString>;
         description: z.ZodOptional<z.ZodString>;
+        hint: z.ZodOptional<z.ZodString>;
         type: z.ZodType<DataType, z.ZodTypeDef, DataType>;
         inputComponent: z.ZodOptional<z.ZodType<ComponentInfoSerialized, z.ZodTypeDef, ComponentInfoSerialized>>;
         disabled: z.ZodOptional<z.ZodBoolean>;
+        readonly: z.ZodOptional<z.ZodType<boolean | import("./form-types").FormFieldReadonly | undefined, z.ZodTypeDef, boolean | import("./form-types").FormFieldReadonly | undefined>>;
         required: z.ZodOptional<z.ZodBoolean>;
         defaultValue: z.ZodOptional<z.ZodType<DefaultValue, z.ZodTypeDef, DefaultValue>>;
         localized: z.ZodOptional<z.ZodBoolean>;
@@ -105,36 +127,246 @@ export declare const FormSchema: z.ZodObject<{
         id: string;
         required?: boolean | undefined;
         description?: string | undefined;
+        readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
         defaultValue?: DefaultValue | undefined;
-        disabled?: boolean | undefined;
         label?: string | undefined;
+        disabled?: boolean | undefined;
         inputComponent?: ComponentInfoSerialized | undefined;
+        hint?: string | undefined;
         localized?: boolean | undefined;
     }, {
         type: DataType;
         id: string;
         required?: boolean | undefined;
         description?: string | undefined;
+        readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
         defaultValue?: DefaultValue | undefined;
-        disabled?: boolean | undefined;
         label?: string | undefined;
+        disabled?: boolean | undefined;
         inputComponent?: ComponentInfoSerialized | undefined;
+        hint?: string | undefined;
         localized?: boolean | undefined;
-    }>]>, "many">;
+    }>]>, "many">>;
+    sections: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        icon: z.ZodOptional<z.ZodString>;
+        fields: z.ZodArray<z.ZodUnion<[z.ZodObject<{
+            id: z.ZodString;
+            label: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+            fields: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                label: z.ZodOptional<z.ZodString>;
+                description: z.ZodOptional<z.ZodString>;
+                hint: z.ZodOptional<z.ZodString>;
+                type: z.ZodType<DataType, z.ZodTypeDef, DataType>;
+                inputComponent: z.ZodOptional<z.ZodType<ComponentInfoSerialized, z.ZodTypeDef, ComponentInfoSerialized>>;
+                disabled: z.ZodOptional<z.ZodBoolean>;
+                readonly: z.ZodOptional<z.ZodType<boolean | import("./form-types").FormFieldReadonly | undefined, z.ZodTypeDef, boolean | import("./form-types").FormFieldReadonly | undefined>>;
+                required: z.ZodOptional<z.ZodBoolean>;
+                defaultValue: z.ZodOptional<z.ZodType<DefaultValue, z.ZodTypeDef, DefaultValue>>;
+                localized: z.ZodOptional<z.ZodBoolean>;
+            }, "strip", z.ZodTypeAny, {
+                type: DataType;
+                id: string;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
+                defaultValue?: DefaultValue | undefined;
+                label?: string | undefined;
+                disabled?: boolean | undefined;
+                inputComponent?: ComponentInfoSerialized | undefined;
+                hint?: string | undefined;
+                localized?: boolean | undefined;
+            }, {
+                type: DataType;
+                id: string;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
+                defaultValue?: DefaultValue | undefined;
+                label?: string | undefined;
+                disabled?: boolean | undefined;
+                inputComponent?: ComponentInfoSerialized | undefined;
+                hint?: string | undefined;
+                localized?: boolean | undefined;
+            }>, "many">;
+            orientation: z.ZodOptional<z.ZodEnum<["horizontal", "vertical"]>>;
+            order: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            fields: {
+                type: DataType;
+                id: string;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
+                defaultValue?: DefaultValue | undefined;
+                label?: string | undefined;
+                disabled?: boolean | undefined;
+                inputComponent?: ComponentInfoSerialized | undefined;
+                hint?: string | undefined;
+                localized?: boolean | undefined;
+            }[];
+            description?: string | undefined;
+            label?: string | undefined;
+            orientation?: "horizontal" | "vertical" | undefined;
+            order?: number | undefined;
+        }, {
+            id: string;
+            fields: {
+                type: DataType;
+                id: string;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
+                defaultValue?: DefaultValue | undefined;
+                label?: string | undefined;
+                disabled?: boolean | undefined;
+                inputComponent?: ComponentInfoSerialized | undefined;
+                hint?: string | undefined;
+                localized?: boolean | undefined;
+            }[];
+            description?: string | undefined;
+            label?: string | undefined;
+            orientation?: "horizontal" | "vertical" | undefined;
+            order?: number | undefined;
+        }>, z.ZodObject<{
+            id: z.ZodString;
+            label: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+            hint: z.ZodOptional<z.ZodString>;
+            type: z.ZodType<DataType, z.ZodTypeDef, DataType>;
+            inputComponent: z.ZodOptional<z.ZodType<ComponentInfoSerialized, z.ZodTypeDef, ComponentInfoSerialized>>;
+            disabled: z.ZodOptional<z.ZodBoolean>;
+            readonly: z.ZodOptional<z.ZodType<boolean | import("./form-types").FormFieldReadonly | undefined, z.ZodTypeDef, boolean | import("./form-types").FormFieldReadonly | undefined>>;
+            required: z.ZodOptional<z.ZodBoolean>;
+            defaultValue: z.ZodOptional<z.ZodType<DefaultValue, z.ZodTypeDef, DefaultValue>>;
+            localized: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            type: DataType;
+            id: string;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
+            defaultValue?: DefaultValue | undefined;
+            label?: string | undefined;
+            disabled?: boolean | undefined;
+            inputComponent?: ComponentInfoSerialized | undefined;
+            hint?: string | undefined;
+            localized?: boolean | undefined;
+        }, {
+            type: DataType;
+            id: string;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
+            defaultValue?: DefaultValue | undefined;
+            label?: string | undefined;
+            disabled?: boolean | undefined;
+            inputComponent?: ComponentInfoSerialized | undefined;
+            hint?: string | undefined;
+            localized?: boolean | undefined;
+        }>]>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        label: string;
+        fields: ({
+            type: DataType;
+            id: string;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
+            defaultValue?: DefaultValue | undefined;
+            label?: string | undefined;
+            disabled?: boolean | undefined;
+            inputComponent?: ComponentInfoSerialized | undefined;
+            hint?: string | undefined;
+            localized?: boolean | undefined;
+        } | {
+            id: string;
+            fields: {
+                type: DataType;
+                id: string;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
+                defaultValue?: DefaultValue | undefined;
+                label?: string | undefined;
+                disabled?: boolean | undefined;
+                inputComponent?: ComponentInfoSerialized | undefined;
+                hint?: string | undefined;
+                localized?: boolean | undefined;
+            }[];
+            description?: string | undefined;
+            label?: string | undefined;
+            orientation?: "horizontal" | "vertical" | undefined;
+            order?: number | undefined;
+        })[];
+        description?: string | undefined;
+        icon?: string | undefined;
+    }, {
+        id: string;
+        label: string;
+        fields: ({
+            type: DataType;
+            id: string;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
+            defaultValue?: DefaultValue | undefined;
+            label?: string | undefined;
+            disabled?: boolean | undefined;
+            inputComponent?: ComponentInfoSerialized | undefined;
+            hint?: string | undefined;
+            localized?: boolean | undefined;
+        } | {
+            id: string;
+            fields: {
+                type: DataType;
+                id: string;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
+                defaultValue?: DefaultValue | undefined;
+                label?: string | undefined;
+                disabled?: boolean | undefined;
+                inputComponent?: ComponentInfoSerialized | undefined;
+                hint?: string | undefined;
+                localized?: boolean | undefined;
+            }[];
+            description?: string | undefined;
+            label?: string | undefined;
+            orientation?: "horizontal" | "vertical" | undefined;
+            order?: number | undefined;
+        })[];
+        description?: string | undefined;
+        icon?: string | undefined;
+    }>, "many">>;
+    sectionNav: z.ZodOptional<z.ZodEnum<["side", "jump", "none"]>>;
     fetchUrl: z.ZodOptional<z.ZodString>;
     fetchUrlMethod: z.ZodOptional<z.ZodNativeEnum<typeof HttpMethod>>;
     submitUrl: z.ZodOptional<z.ZodString>;
     submitUrlMethod: z.ZodOptional<z.ZodNativeEnum<typeof HttpMethod>>;
 }, "strip", z.ZodTypeAny, {
-    fields: ({
+    kind?: "record" | "action" | undefined;
+    slotId?: string | undefined;
+    description?: string | undefined;
+    errorMessage?: string | undefined;
+    title?: string | undefined;
+    fields?: ({
         type: DataType;
         id: string;
         required?: boolean | undefined;
         description?: string | undefined;
+        readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
         defaultValue?: DefaultValue | undefined;
-        disabled?: boolean | undefined;
         label?: string | undefined;
+        disabled?: boolean | undefined;
         inputComponent?: ComponentInfoSerialized | undefined;
+        hint?: string | undefined;
         localized?: boolean | undefined;
     } | {
         id: string;
@@ -143,41 +375,87 @@ export declare const FormSchema: z.ZodObject<{
             id: string;
             required?: boolean | undefined;
             description?: string | undefined;
+            readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
             defaultValue?: DefaultValue | undefined;
-            disabled?: boolean | undefined;
             label?: string | undefined;
+            disabled?: boolean | undefined;
             inputComponent?: ComponentInfoSerialized | undefined;
+            hint?: string | undefined;
             localized?: boolean | undefined;
         }[];
         description?: string | undefined;
         label?: string | undefined;
         orientation?: "horizontal" | "vertical" | undefined;
         order?: number | undefined;
-    })[];
-    slotId?: string | undefined;
-    description?: string | undefined;
-    errorMessage?: string | undefined;
-    title?: string | undefined;
+    })[] | undefined;
+    sections?: {
+        id: string;
+        label: string;
+        fields: ({
+            type: DataType;
+            id: string;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
+            defaultValue?: DefaultValue | undefined;
+            label?: string | undefined;
+            disabled?: boolean | undefined;
+            inputComponent?: ComponentInfoSerialized | undefined;
+            hint?: string | undefined;
+            localized?: boolean | undefined;
+        } | {
+            id: string;
+            fields: {
+                type: DataType;
+                id: string;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
+                defaultValue?: DefaultValue | undefined;
+                label?: string | undefined;
+                disabled?: boolean | undefined;
+                inputComponent?: ComponentInfoSerialized | undefined;
+                hint?: string | undefined;
+                localized?: boolean | undefined;
+            }[];
+            description?: string | undefined;
+            label?: string | undefined;
+            orientation?: "horizontal" | "vertical" | undefined;
+            order?: number | undefined;
+        })[];
+        description?: string | undefined;
+        icon?: string | undefined;
+    }[] | undefined;
+    sectionNav?: "none" | "side" | "jump" | undefined;
     fetchUrl?: string | undefined;
     fetchUrlMethod?: HttpMethod | undefined;
     submitUrl?: string | undefined;
     submitUrlMethod?: HttpMethod | undefined;
     successMessage?: string | undefined;
     submitLabel?: string | undefined;
-    showActions?: boolean | undefined;
+    saveMode?: "none" | "bar" | "footer" | "instant" | undefined;
+    backTo?: string | undefined;
     fieldsOrientation?: "horizontal" | "vertical" | undefined;
     redirectOnSuccess?: string | undefined;
     submitDefaults?: Record<string, unknown> | undefined;
+    labelKey?: string | undefined;
 }, {
-    fields: ({
+    kind?: "record" | "action" | undefined;
+    slotId?: string | undefined;
+    description?: string | undefined;
+    errorMessage?: string | undefined;
+    title?: string | undefined;
+    fields?: ({
         type: DataType;
         id: string;
         required?: boolean | undefined;
         description?: string | undefined;
+        readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
         defaultValue?: DefaultValue | undefined;
-        disabled?: boolean | undefined;
         label?: string | undefined;
+        disabled?: boolean | undefined;
         inputComponent?: ComponentInfoSerialized | undefined;
+        hint?: string | undefined;
         localized?: boolean | undefined;
     } | {
         id: string;
@@ -186,29 +464,68 @@ export declare const FormSchema: z.ZodObject<{
             id: string;
             required?: boolean | undefined;
             description?: string | undefined;
+            readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
             defaultValue?: DefaultValue | undefined;
-            disabled?: boolean | undefined;
             label?: string | undefined;
+            disabled?: boolean | undefined;
             inputComponent?: ComponentInfoSerialized | undefined;
+            hint?: string | undefined;
             localized?: boolean | undefined;
         }[];
         description?: string | undefined;
         label?: string | undefined;
         orientation?: "horizontal" | "vertical" | undefined;
         order?: number | undefined;
-    })[];
-    slotId?: string | undefined;
-    description?: string | undefined;
-    errorMessage?: string | undefined;
-    title?: string | undefined;
+    })[] | undefined;
+    sections?: {
+        id: string;
+        label: string;
+        fields: ({
+            type: DataType;
+            id: string;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
+            defaultValue?: DefaultValue | undefined;
+            label?: string | undefined;
+            disabled?: boolean | undefined;
+            inputComponent?: ComponentInfoSerialized | undefined;
+            hint?: string | undefined;
+            localized?: boolean | undefined;
+        } | {
+            id: string;
+            fields: {
+                type: DataType;
+                id: string;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                readonly?: boolean | import("./form-types").FormFieldReadonly | undefined;
+                defaultValue?: DefaultValue | undefined;
+                label?: string | undefined;
+                disabled?: boolean | undefined;
+                inputComponent?: ComponentInfoSerialized | undefined;
+                hint?: string | undefined;
+                localized?: boolean | undefined;
+            }[];
+            description?: string | undefined;
+            label?: string | undefined;
+            orientation?: "horizontal" | "vertical" | undefined;
+            order?: number | undefined;
+        })[];
+        description?: string | undefined;
+        icon?: string | undefined;
+    }[] | undefined;
+    sectionNav?: "none" | "side" | "jump" | undefined;
     fetchUrl?: string | undefined;
     fetchUrlMethod?: HttpMethod | undefined;
     submitUrl?: string | undefined;
     submitUrlMethod?: HttpMethod | undefined;
     successMessage?: string | undefined;
     submitLabel?: string | undefined;
-    showActions?: boolean | undefined;
+    saveMode?: "none" | "bar" | "footer" | "instant" | undefined;
+    backTo?: string | undefined;
     fieldsOrientation?: "horizontal" | "vertical" | undefined;
     redirectOnSuccess?: string | undefined;
     submitDefaults?: Record<string, unknown> | undefined;
+    labelKey?: string | undefined;
 }>;