@frontmcp/ui 0.5.0

package/src/components/form.schema.d.ts

@@ -0,0 +1,441 @@
+/**
+ * @file form.schema.ts
+ * @description Zod schemas for Form component options validation.
+ *
+ * Provides strict validation schemas for all form-related components including
+ * input, select, textarea, checkbox, radio groups, and form layouts.
+ *
+ * @example
+ * ```typescript
+ * import { InputOptionsSchema, SelectOptionsSchema } from '@frontmcp/ui';
+ *
+ * const inputResult = InputOptionsSchema.safeParse({
+ *   name: 'email',
+ *   type: 'email',
+ *   label: 'Email Address',
+ * });
+ * ```
+ *
+ * @module @frontmcp/ui/components/form.schema
+ */
+import { z } from 'zod';
+/**
+ * Input type enum schema
+ */
+export declare const InputTypeSchema: z.ZodEnum<{
+    number: "number";
+    url: "url";
+    text: "text";
+    search: "search";
+    time: "time";
+    email: "email";
+    date: "date";
+    password: "password";
+    tel: "tel";
+    "datetime-local": "datetime-local";
+    hidden: "hidden";
+}>;
+/**
+ * Input type
+ */
+export type InputType = z.infer<typeof InputTypeSchema>;
+/**
+ * Input size enum schema
+ */
+export declare const InputSizeSchema: z.ZodEnum<{
+    sm: "sm";
+    lg: "lg";
+    md: "md";
+}>;
+/**
+ * Input size type
+ */
+export type InputSize = z.infer<typeof InputSizeSchema>;
+/**
+ * Input state enum schema
+ */
+export declare const InputStateSchema: z.ZodEnum<{
+    default: "default";
+    success: "success";
+    warning: "warning";
+    error: "error";
+}>;
+/**
+ * Input state type
+ */
+export type InputState = z.infer<typeof InputStateSchema>;
+/**
+ * Form field HTMX options schema
+ */
+export declare const FormHtmxSchema: z.ZodOptional<z.ZodObject<{
+    post: z.ZodOptional<z.ZodString>;
+    get: z.ZodOptional<z.ZodString>;
+    target: z.ZodOptional<z.ZodString>;
+    swap: z.ZodOptional<z.ZodString>;
+    trigger: z.ZodOptional<z.ZodString>;
+    validate: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>>;
+/**
+ * Form field HTMX type
+ */
+export type FormHtmx = z.infer<typeof FormHtmxSchema>;
+/**
+ * Complete input options schema
+ */
+export declare const InputOptionsSchema: z.ZodObject<{
+    type: z.ZodOptional<z.ZodEnum<{
+        number: "number";
+        url: "url";
+        text: "text";
+        search: "search";
+        time: "time";
+        email: "email";
+        date: "date";
+        password: "password";
+        tel: "tel";
+        "datetime-local": "datetime-local";
+        hidden: "hidden";
+    }>>;
+    name: z.ZodString;
+    id: z.ZodOptional<z.ZodString>;
+    value: z.ZodOptional<z.ZodString>;
+    placeholder: z.ZodOptional<z.ZodString>;
+    label: z.ZodOptional<z.ZodString>;
+    helper: z.ZodOptional<z.ZodString>;
+    error: z.ZodOptional<z.ZodString>;
+    size: z.ZodOptional<z.ZodEnum<{
+        sm: "sm";
+        lg: "lg";
+        md: "md";
+    }>>;
+    state: z.ZodOptional<z.ZodEnum<{
+        default: "default";
+        success: "success";
+        warning: "warning";
+        error: "error";
+    }>>;
+    required: z.ZodOptional<z.ZodBoolean>;
+    disabled: z.ZodOptional<z.ZodBoolean>;
+    readonly: z.ZodOptional<z.ZodBoolean>;
+    autocomplete: z.ZodOptional<z.ZodString>;
+    pattern: z.ZodOptional<z.ZodString>;
+    min: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    max: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    step: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    className: z.ZodOptional<z.ZodString>;
+    htmx: z.ZodOptional<z.ZodObject<{
+        post: z.ZodOptional<z.ZodString>;
+        get: z.ZodOptional<z.ZodString>;
+        target: z.ZodOptional<z.ZodString>;
+        swap: z.ZodOptional<z.ZodString>;
+        trigger: z.ZodOptional<z.ZodString>;
+        validate: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>>;
+    data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    iconBefore: z.ZodOptional<z.ZodString>;
+    iconAfter: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * Input options type (derived from schema)
+ */
+export type InputOptions = z.infer<typeof InputOptionsSchema>;
+/**
+ * Select option item schema
+ */
+export declare const SelectOptionItemSchema: z.ZodObject<{
+    value: z.ZodString;
+    label: z.ZodString;
+    disabled: z.ZodOptional<z.ZodBoolean>;
+    selected: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+/**
+ * Select option item type
+ */
+export type SelectOptionItem = z.infer<typeof SelectOptionItemSchema>;
+/**
+ * Complete select options schema
+ */
+export declare const SelectOptionsSchema: z.ZodObject<{
+    name: z.ZodString;
+    id: z.ZodOptional<z.ZodString>;
+    value: z.ZodOptional<z.ZodString>;
+    placeholder: z.ZodOptional<z.ZodString>;
+    label: z.ZodOptional<z.ZodString>;
+    helper: z.ZodOptional<z.ZodString>;
+    error: z.ZodOptional<z.ZodString>;
+    size: z.ZodOptional<z.ZodEnum<{
+        sm: "sm";
+        lg: "lg";
+        md: "md";
+    }>>;
+    state: z.ZodOptional<z.ZodEnum<{
+        default: "default";
+        success: "success";
+        warning: "warning";
+        error: "error";
+    }>>;
+    required: z.ZodOptional<z.ZodBoolean>;
+    disabled: z.ZodOptional<z.ZodBoolean>;
+    readonly: z.ZodOptional<z.ZodBoolean>;
+    className: z.ZodOptional<z.ZodString>;
+    htmx: z.ZodOptional<z.ZodObject<{
+        post: z.ZodOptional<z.ZodString>;
+        get: z.ZodOptional<z.ZodString>;
+        target: z.ZodOptional<z.ZodString>;
+        swap: z.ZodOptional<z.ZodString>;
+        trigger: z.ZodOptional<z.ZodString>;
+        validate: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>>;
+    data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    iconBefore: z.ZodOptional<z.ZodString>;
+    iconAfter: z.ZodOptional<z.ZodString>;
+    options: z.ZodArray<z.ZodObject<{
+        value: z.ZodString;
+        label: z.ZodString;
+        disabled: z.ZodOptional<z.ZodBoolean>;
+        selected: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>>;
+    multiple: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+/**
+ * Select options type
+ */
+export type SelectOptions = z.infer<typeof SelectOptionsSchema>;
+/**
+ * Textarea resize enum schema
+ */
+export declare const TextareaResizeSchema: z.ZodEnum<{
+    none: "none";
+    horizontal: "horizontal";
+    vertical: "vertical";
+    both: "both";
+}>;
+/**
+ * Complete textarea options schema
+ */
+export declare const TextareaOptionsSchema: z.ZodObject<{
+    name: z.ZodString;
+    id: z.ZodOptional<z.ZodString>;
+    value: z.ZodOptional<z.ZodString>;
+    placeholder: z.ZodOptional<z.ZodString>;
+    label: z.ZodOptional<z.ZodString>;
+    helper: z.ZodOptional<z.ZodString>;
+    error: z.ZodOptional<z.ZodString>;
+    size: z.ZodOptional<z.ZodEnum<{
+        sm: "sm";
+        lg: "lg";
+        md: "md";
+    }>>;
+    state: z.ZodOptional<z.ZodEnum<{
+        default: "default";
+        success: "success";
+        warning: "warning";
+        error: "error";
+    }>>;
+    required: z.ZodOptional<z.ZodBoolean>;
+    disabled: z.ZodOptional<z.ZodBoolean>;
+    readonly: z.ZodOptional<z.ZodBoolean>;
+    autocomplete: z.ZodOptional<z.ZodString>;
+    className: z.ZodOptional<z.ZodString>;
+    htmx: z.ZodOptional<z.ZodObject<{
+        post: z.ZodOptional<z.ZodString>;
+        get: z.ZodOptional<z.ZodString>;
+        target: z.ZodOptional<z.ZodString>;
+        swap: z.ZodOptional<z.ZodString>;
+        trigger: z.ZodOptional<z.ZodString>;
+        validate: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>>;
+    data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    iconBefore: z.ZodOptional<z.ZodString>;
+    iconAfter: z.ZodOptional<z.ZodString>;
+    rows: z.ZodOptional<z.ZodNumber>;
+    resize: z.ZodOptional<z.ZodEnum<{
+        none: "none";
+        horizontal: "horizontal";
+        vertical: "vertical";
+        both: "both";
+    }>>;
+}, z.core.$strict>;
+/**
+ * Textarea options type
+ */
+export type TextareaOptions = z.infer<typeof TextareaOptionsSchema>;
+/**
+ * Checkbox HTMX options schema
+ */
+export declare const CheckboxHtmxSchema: z.ZodOptional<z.ZodObject<{
+    post: z.ZodOptional<z.ZodString>;
+    get: z.ZodOptional<z.ZodString>;
+    target: z.ZodOptional<z.ZodString>;
+    swap: z.ZodOptional<z.ZodString>;
+    trigger: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>>;
+/**
+ * Complete checkbox options schema
+ */
+export declare const CheckboxOptionsSchema: z.ZodObject<{
+    name: z.ZodString;
+    id: z.ZodOptional<z.ZodString>;
+    value: z.ZodOptional<z.ZodString>;
+    label: z.ZodString;
+    checked: z.ZodOptional<z.ZodBoolean>;
+    disabled: z.ZodOptional<z.ZodBoolean>;
+    helper: z.ZodOptional<z.ZodString>;
+    error: z.ZodOptional<z.ZodString>;
+    className: z.ZodOptional<z.ZodString>;
+    htmx: z.ZodOptional<z.ZodObject<{
+        post: z.ZodOptional<z.ZodString>;
+        get: z.ZodOptional<z.ZodString>;
+        target: z.ZodOptional<z.ZodString>;
+        swap: z.ZodOptional<z.ZodString>;
+        trigger: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+/**
+ * Checkbox options type
+ */
+export type CheckboxOptions = z.infer<typeof CheckboxOptionsSchema>;
+/**
+ * Radio option item schema
+ */
+export declare const RadioOptionItemSchema: z.ZodObject<{
+    value: z.ZodString;
+    label: z.ZodString;
+    disabled: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+/**
+ * Radio option item type
+ */
+export type RadioOptionItem = z.infer<typeof RadioOptionItemSchema>;
+/**
+ * Complete radio group options schema
+ */
+export declare const RadioGroupOptionsSchema: z.ZodObject<{
+    name: z.ZodString;
+    options: z.ZodArray<z.ZodObject<{
+        value: z.ZodString;
+        label: z.ZodString;
+        disabled: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>>;
+    value: z.ZodOptional<z.ZodString>;
+    label: z.ZodOptional<z.ZodString>;
+    helper: z.ZodOptional<z.ZodString>;
+    error: z.ZodOptional<z.ZodString>;
+    direction: z.ZodOptional<z.ZodEnum<{
+        horizontal: "horizontal";
+        vertical: "vertical";
+    }>>;
+    className: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * Radio group options type
+ */
+export type RadioGroupOptions = z.infer<typeof RadioGroupOptionsSchema>;
+/**
+ * Form method enum schema
+ */
+export declare const FormMethodSchema: z.ZodEnum<{
+    get: "get";
+    post: "post";
+    dialog: "dialog";
+}>;
+/**
+ * Form enctype enum schema
+ */
+export declare const FormEnctypeSchema: z.ZodEnum<{
+    "application/x-www-form-urlencoded": "application/x-www-form-urlencoded";
+    "multipart/form-data": "multipart/form-data";
+    "text/plain": "text/plain";
+}>;
+/**
+ * Form HTMX options schema
+ */
+export declare const FormFormHtmxSchema: z.ZodOptional<z.ZodObject<{
+    post: z.ZodOptional<z.ZodString>;
+    put: z.ZodOptional<z.ZodString>;
+    patch: z.ZodOptional<z.ZodString>;
+    delete: z.ZodOptional<z.ZodString>;
+    target: z.ZodOptional<z.ZodString>;
+    swap: z.ZodOptional<z.ZodString>;
+    encoding: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>>;
+/**
+ * Complete form options schema
+ */
+export declare const FormOptionsSchema: z.ZodObject<{
+    action: z.ZodOptional<z.ZodString>;
+    method: z.ZodOptional<z.ZodEnum<{
+        get: "get";
+        post: "post";
+        dialog: "dialog";
+    }>>;
+    id: z.ZodOptional<z.ZodString>;
+    enctype: z.ZodOptional<z.ZodEnum<{
+        "application/x-www-form-urlencoded": "application/x-www-form-urlencoded";
+        "multipart/form-data": "multipart/form-data";
+        "text/plain": "text/plain";
+    }>>;
+    novalidate: z.ZodOptional<z.ZodBoolean>;
+    autocomplete: z.ZodOptional<z.ZodEnum<{
+        on: "on";
+        off: "off";
+    }>>;
+    className: z.ZodOptional<z.ZodString>;
+    htmx: z.ZodOptional<z.ZodObject<{
+        post: z.ZodOptional<z.ZodString>;
+        put: z.ZodOptional<z.ZodString>;
+        patch: z.ZodOptional<z.ZodString>;
+        delete: z.ZodOptional<z.ZodString>;
+        target: z.ZodOptional<z.ZodString>;
+        swap: z.ZodOptional<z.ZodString>;
+        encoding: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+/**
+ * Form options type
+ */
+export type FormOptions = z.infer<typeof FormOptionsSchema>;
+/**
+ * Form row options schema
+ */
+export declare const FormRowOptionsSchema: z.ZodObject<{
+    cols: z.ZodOptional<z.ZodNumber>;
+    gap: z.ZodOptional<z.ZodEnum<{
+        sm: "sm";
+        lg: "lg";
+        md: "md";
+    }>>;
+    className: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * Form row options type
+ */
+export type FormRowOptions = z.infer<typeof FormRowOptionsSchema>;
+/**
+ * Form section options schema
+ */
+export declare const FormSectionOptionsSchema: z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    className: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * Form section options type
+ */
+export type FormSectionOptions = z.infer<typeof FormSectionOptionsSchema>;
+/**
+ * Form actions options schema
+ */
+export declare const FormActionsOptionsSchema: z.ZodObject<{
+    align: z.ZodOptional<z.ZodEnum<{
+        center: "center";
+        left: "left";
+        right: "right";
+        between: "between";
+    }>>;
+    className: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * Form actions options type
+ */
+export type FormActionsOptions = z.infer<typeof FormActionsOptionsSchema>;