@vcp-dev/contracts 0.6.10 → 0.6.11

package/dist/form-design.d.ts

@@ -1,6 +1,7 @@
 import { z } from "zod";
 import { type SiteLocale } from "./site-locale.js";
 export declare const FORM_SPEC_MULTISTEP_MIN_RUNTIME_VERSION = 2;
+export declare const FORM_SPEC_FILE_MIN_RUNTIME_VERSION = 3;
 export declare const FormDefinitionIdSchema: z.ZodString;
 export declare const FormBlockIdSchema: z.ZodString;
 export declare const FormDesignOperationIdSchema: z.ZodString;
@@ -29,8 +30,9 @@ export declare const FormSpecFieldNodeSchema: z.ZodObject<{
         number: "number";
         boolean: "boolean";
         date: "date";
-        text: "text";
+        file: "file";
         email: "email";
+        text: "text";
         select: "select";
         multiselect: "multiselect";
         textarea: "textarea";
@@ -47,6 +49,7 @@ export declare const FormSpecFieldNodeSchema: z.ZodObject<{
         value: z.ZodString;
         label: z.ZodString;
     }, z.core.$strict>>;
+    max_files: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strict>;
 export type FormSpecFieldNode = z.infer<typeof FormSpecFieldNodeSchema>;
 /** A step break starts the next step; the first step is implicit. */
@@ -62,8 +65,9 @@ export declare const FormSpecNodeSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
         number: "number";
         boolean: "boolean";
         date: "date";
-        text: "text";
+        file: "file";
         email: "email";
+        text: "text";
         select: "select";
         multiselect: "multiselect";
         textarea: "textarea";
@@ -80,11 +84,13 @@ export declare const FormSpecNodeSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
         value: z.ZodString;
         label: z.ZodString;
     }, z.core.$strict>>;
+    max_files: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strict>, z.ZodObject<{
     kind: z.ZodLiteral<"step-break">;
     step_id: z.ZodString;
 }, z.core.$strict>], "kind">;
 export type FormSpecNode = z.infer<typeof FormSpecNodeSchema>;
+export declare function normalizeFormOptionLabelIdentity(value: string, locale: string): string;
 export declare const FormSpecV1Schema: z.ZodObject<{
     schema_version: z.ZodLiteral<1>;
     min_runtime_version: z.ZodNumber;
@@ -214,8 +220,9 @@ export declare const FormSpecV1Schema: z.ZodObject<{
             number: "number";
             boolean: "boolean";
             date: "date";
-            text: "text";
+            file: "file";
             email: "email";
+            text: "text";
             select: "select";
             multiselect: "multiselect";
             textarea: "textarea";
@@ -232,6 +239,7 @@ export declare const FormSpecV1Schema: z.ZodObject<{
             value: z.ZodString;
             label: z.ZodString;
         }, z.core.$strict>>;
+        max_files: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strict>, z.ZodObject<{
         kind: z.ZodLiteral<"step-break">;
         step_id: z.ZodString;
@@ -250,8 +258,9 @@ export declare const FormSpecV1Schema: z.ZodObject<{
                 number: "number";
                 boolean: "boolean";
                 date: "date";
-                text: "text";
+                file: "file";
                 email: "email";
+                text: "text";
                 select: "select";
                 multiselect: "multiselect";
                 textarea: "textarea";
@@ -343,25 +352,16 @@ export declare const FormTemplateTextSchema: z.ZodObject<{
 export type FormTemplateText = z.infer<typeof FormTemplateTextSchema>;
 export declare const FORM_TEMPLATE_CATEGORY_SLUGS: readonly ["lead-generation", "trial-and-samples", "quote-and-commerce", "appointments-and-visits", "resources-and-subscriptions", "service-and-channel"];
 export declare const FORM_TEMPLATE_CATEGORY_COUNTS: readonly [1, 1, 1, 1, 1, 1];
-export declare const FormTemplateCategorySlugSchema: z.ZodEnum<{
-    "lead-generation": "lead-generation";
-    "trial-and-samples": "trial-and-samples";
-    "quote-and-commerce": "quote-and-commerce";
-    "appointments-and-visits": "appointments-and-visits";
-    "resources-and-subscriptions": "resources-and-subscriptions";
-    "service-and-channel": "service-and-channel";
-}>;
+/**
+ * The resource platform owns form taxonomy. Keep the historical category
+ * constants for the built-in fixture, but accept any valid taxonomy slug at
+ * the public contract boundary.
+ */
+export declare const FormTemplateCategorySlugSchema: z.ZodString;
 export type FormTemplateCategorySlug = z.infer<typeof FormTemplateCategorySlugSchema>;
 export declare const FormTemplateCategoryV1Schema: z.ZodObject<{
     schema_version: z.ZodLiteral<1>;
-    slug: z.ZodEnum<{
-        "lead-generation": "lead-generation";
-        "trial-and-samples": "trial-and-samples";
-        "quote-and-commerce": "quote-and-commerce";
-        "appointments-and-visits": "appointments-and-visits";
-        "resources-and-subscriptions": "resources-and-subscriptions";
-        "service-and-channel": "service-and-channel";
-    }>;
+    slug: z.ZodString;
     name: z.ZodObject<{
         english: z.ZodString;
         translations: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
@@ -421,14 +421,7 @@ export declare const FormTemplateV1Schema: z.ZodObject<{
     schema_version: z.ZodLiteral<1>;
     slug: z.ZodString;
     version: z.ZodString;
-    category: z.ZodEnum<{
-        "lead-generation": "lead-generation";
-        "trial-and-samples": "trial-and-samples";
-        "quote-and-commerce": "quote-and-commerce";
-        "appointments-and-visits": "appointments-and-visits";
-        "resources-and-subscriptions": "resources-and-subscriptions";
-        "service-and-channel": "service-and-channel";
-    }>;
+    category: z.ZodString;
     copy: z.ZodObject<{
         title: z.ZodObject<{
             english: z.ZodString;
@@ -703,8 +696,9 @@ export declare const FormTemplateV1Schema: z.ZodObject<{
             number: "number";
             boolean: "boolean";
             date: "date";
-            text: "text";
+            file: "file";
             email: "email";
+            text: "text";
             select: "select";
             multiselect: "multiselect";
             textarea: "textarea";
@@ -838,14 +832,7 @@ export declare const FormTemplateCatalogResponseSchema: z.ZodObject<{
     }>;
     categories: z.ZodArray<z.ZodObject<{
         schema_version: z.ZodLiteral<1>;
-        slug: z.ZodEnum<{
-            "lead-generation": "lead-generation";
-            "trial-and-samples": "trial-and-samples";
-            "quote-and-commerce": "quote-and-commerce";
-            "appointments-and-visits": "appointments-and-visits";
-            "resources-and-subscriptions": "resources-and-subscriptions";
-            "service-and-channel": "service-and-channel";
-        }>;
+        slug: z.ZodString;
         name: z.ZodObject<{
             english: z.ZodString;
             translations: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
@@ -904,14 +891,7 @@ export declare const FormTemplateCatalogResponseSchema: z.ZodObject<{
         schema_version: z.ZodLiteral<1>;
         slug: z.ZodString;
         version: z.ZodString;
-        category: z.ZodEnum<{
-            "lead-generation": "lead-generation";
-            "trial-and-samples": "trial-and-samples";
-            "quote-and-commerce": "quote-and-commerce";
-            "appointments-and-visits": "appointments-and-visits";
-            "resources-and-subscriptions": "resources-and-subscriptions";
-            "service-and-channel": "service-and-channel";
-        }>;
+        category: z.ZodString;
         copy: z.ZodObject<{
             title: z.ZodObject<{
                 english: z.ZodString;
@@ -1186,8 +1166,9 @@ export declare const FormTemplateCatalogResponseSchema: z.ZodObject<{
                 number: "number";
                 boolean: "boolean";
                 date: "date";
-                text: "text";
+                file: "file";
                 email: "email";
+                text: "text";
                 select: "select";
                 multiselect: "multiselect";
                 textarea: "textarea";
@@ -1315,7 +1296,7 @@ export declare const FormTemplateCatalogResponseSchema: z.ZodObject<{
 }, z.core.$strict>;
 export type FormTemplateCatalogResponse = z.infer<typeof FormTemplateCatalogResponseSchema>;
 export declare function resolveFormTemplateText(text: FormTemplateText, locale: SiteLocale): string;
-export declare const CMS_FORM_FIELD_TYPES: readonly ["Text", "Summary", "Email", "Phone", "DropdownSelection", "RadioButton", "Checkbox", "Boolean", "Date", "Num"];
+export declare const CMS_FORM_FIELD_TYPES: readonly ["Text", "Summary", "Email", "Phone", "DropdownSelection", "RadioButton", "Checkbox", "Boolean", "Date", "Num", "MultipleFile", "SpecificFile"];
 export type CmsFormFieldType = (typeof CMS_FORM_FIELD_TYPES)[number];
 export declare const FORM_SPEC_FIELD_TYPE_TO_CMS: {
     readonly text: "Text";
@@ -1328,6 +1309,7 @@ export declare const FORM_SPEC_FIELD_TYPE_TO_CMS: {
     readonly boolean: "Boolean";
     readonly date: "Date";
     readonly number: "Num";
+    readonly file: "MultipleFile";
 };
 export declare const CmsFormSchemaProjectionSchema: z.ZodObject<{
     version: z.ZodLiteral<1>;
@@ -1426,16 +1408,18 @@ export declare const CmsFormSchemaProjectionSchema: z.ZodObject<{
     fields: z.ZodArray<z.ZodObject<{
         field_name: z.ZodString;
         field_type: z.ZodEnum<{
+            DropdownSelection: "DropdownSelection";
+            RadioButton: "RadioButton";
+            Checkbox: "Checkbox";
             Text: "Text";
             Summary: "Summary";
             Email: "Email";
             Phone: "Phone";
-            DropdownSelection: "DropdownSelection";
-            RadioButton: "RadioButton";
-            Checkbox: "Checkbox";
             Boolean: "Boolean";
             Date: "Date";
             Num: "Num";
+            MultipleFile: "MultipleFile";
+            SpecificFile: "SpecificFile";
         }>;
         field_label: z.ZodString;
         is_required: z.ZodBoolean;
@@ -1451,7 +1435,12 @@ export declare function projectFormSpecToCmsSchema(spec: FormSpecV1): CmsFormSch
 export declare const FormDesignHashSchema: z.ZodString;
 export type FormDesignHash = z.infer<typeof FormDesignHashSchema>;
 export declare const FormDesignAffectedFilesSchema: z.ZodArray<z.ZodObject<{
-    path: z.ZodString;
+    path: z.ZodUnion<readonly [z.ZodString, z.ZodEnum<{
+        "app/api/forms/[code]/route.ts": "app/api/forms/[code]/route.ts";
+        "hooks/use-cms-form-submit.ts": "hooks/use-cms-form-submit.ts";
+        "lib/cms/forms.ts": "lib/cms/forms.ts";
+        "lib/cms/client.ts": "lib/cms/client.ts";
+    }>]>;
     content_hash: z.ZodNullable<z.ZodString>;
 }, z.core.$strict>>;
 export type FormDesignAffectedFiles = z.infer<typeof FormDesignAffectedFilesSchema>;
@@ -1654,8 +1643,9 @@ export declare const FormDesignOpenResponseSchema: z.ZodObject<{
                 number: "number";
                 boolean: "boolean";
                 date: "date";
-                text: "text";
+                file: "file";
                 email: "email";
+                text: "text";
                 select: "select";
                 multiselect: "multiselect";
                 textarea: "textarea";
@@ -1672,6 +1662,7 @@ export declare const FormDesignOpenResponseSchema: z.ZodObject<{
                 value: z.ZodString;
                 label: z.ZodString;
             }, z.core.$strict>>;
+            max_files: z.ZodOptional<z.ZodNumber>;
         }, z.core.$strict>, z.ZodObject<{
             kind: z.ZodLiteral<"step-break">;
             step_id: z.ZodString;
@@ -1690,8 +1681,9 @@ export declare const FormDesignOpenResponseSchema: z.ZodObject<{
                     number: "number";
                     boolean: "boolean";
                     date: "date";
-                    text: "text";
+                    file: "file";
                     email: "email";
+                    text: "text";
                     select: "select";
                     multiselect: "multiselect";
                     textarea: "textarea";
@@ -1881,8 +1873,9 @@ export declare const FormDesignSaveRequestSchema: z.ZodObject<{
                 number: "number";
                 boolean: "boolean";
                 date: "date";
-                text: "text";
+                file: "file";
                 email: "email";
+                text: "text";
                 select: "select";
                 multiselect: "multiselect";
                 textarea: "textarea";
@@ -1899,6 +1892,7 @@ export declare const FormDesignSaveRequestSchema: z.ZodObject<{
                 value: z.ZodString;
                 label: z.ZodString;
             }, z.core.$strict>>;
+            max_files: z.ZodOptional<z.ZodNumber>;
         }, z.core.$strict>, z.ZodObject<{
             kind: z.ZodLiteral<"step-break">;
             step_id: z.ZodString;
@@ -1917,8 +1911,9 @@ export declare const FormDesignSaveRequestSchema: z.ZodObject<{
                     number: "number";
                     boolean: "boolean";
                     date: "date";
-                    text: "text";
+                    file: "file";
                     email: "email";
+                    text: "text";
                     select: "select";
                     multiselect: "multiselect";
                     textarea: "textarea";
@@ -1990,10 +1985,10 @@ export type FormDesignOperationStage = z.infer<typeof FormDesignOperationStageSc
 export declare const FORM_DESIGN_OPERATION_STATUSES: readonly ["pending", "running", "succeeded", "failed", "recovery_required"];
 export declare const FormDesignOperationStatusSchema: z.ZodEnum<{
     failed: "failed";
+    succeeded: "succeeded";
     pending: "pending";
-    recovery_required: "recovery_required";
     running: "running";
-    succeeded: "succeeded";
+    recovery_required: "recovery_required";
 }>;
 export type FormDesignOperationStatus = z.infer<typeof FormDesignOperationStatusSchema>;
 export declare const FORM_DESIGN_FAILURE_STAGES: readonly ["candidate_abandon", "snapshot_reconcile", "cms_restore"];
@@ -2033,8 +2028,8 @@ export declare const FormDesignOperationNextActionSchema: z.ZodEnum<{
 }>;
 export declare const FormDesignPreviewRefreshStatusSchema: z.ZodEnum<{
     failed: "failed";
-    pending: "pending";
     succeeded: "succeeded";
+    pending: "pending";
     not_started: "not_started";
 }>;
 export declare const FormDesignOperationSchema: z.ZodObject<{
@@ -2056,10 +2051,10 @@ export declare const FormDesignOperationSchema: z.ZodObject<{
     }>;
     status: z.ZodEnum<{
         failed: "failed";
+        succeeded: "succeeded";
         pending: "pending";
-        recovery_required: "recovery_required";
         running: "running";
-        succeeded: "succeeded";
+        recovery_required: "recovery_required";
     }>;
     base_snapshot_id: z.ZodUUID;
     candidate_snapshot_id: z.ZodNullable<z.ZodUUID>;
@@ -2105,8 +2100,8 @@ export declare const FormDesignOperationSchema: z.ZodObject<{
     }>;
     preview_refresh_status: z.ZodEnum<{
         failed: "failed";
-        pending: "pending";
         succeeded: "succeeded";
+        pending: "pending";
         not_started: "not_started";
     }>;
     created_at: z.ZodString;
@@ -2133,10 +2128,10 @@ export declare const FormDesignOperationResponseSchema: z.ZodObject<{
         }>;
         status: z.ZodEnum<{
             failed: "failed";
+            succeeded: "succeeded";
             pending: "pending";
-            recovery_required: "recovery_required";
             running: "running";
-            succeeded: "succeeded";
+            recovery_required: "recovery_required";
         }>;
         base_snapshot_id: z.ZodUUID;
         candidate_snapshot_id: z.ZodNullable<z.ZodUUID>;
@@ -2182,8 +2177,8 @@ export declare const FormDesignOperationResponseSchema: z.ZodObject<{
         }>;
         preview_refresh_status: z.ZodEnum<{
             failed: "failed";
-            pending: "pending";
             succeeded: "succeeded";
+            pending: "pending";
             not_started: "not_started";
         }>;
         created_at: z.ZodString;
@@ -2211,10 +2206,10 @@ export declare const FormDesignSaveResponseSchema: z.ZodObject<{
         }>;
         status: z.ZodEnum<{
             failed: "failed";
+            succeeded: "succeeded";
             pending: "pending";
-            recovery_required: "recovery_required";
             running: "running";
-            succeeded: "succeeded";
+            recovery_required: "recovery_required";
         }>;
         base_snapshot_id: z.ZodUUID;
         candidate_snapshot_id: z.ZodNullable<z.ZodUUID>;
@@ -2260,8 +2255,8 @@ export declare const FormDesignSaveResponseSchema: z.ZodObject<{
         }>;
         preview_refresh_status: z.ZodEnum<{
             failed: "failed";
-            pending: "pending";
             succeeded: "succeeded";
+            pending: "pending";
             not_started: "not_started";
         }>;
         created_at: z.ZodString;
@@ -2288,10 +2283,10 @@ export declare const FormDesignQueryResponseSchema: z.ZodObject<{
         }>;
         status: z.ZodEnum<{
             failed: "failed";
+            succeeded: "succeeded";
             pending: "pending";
-            recovery_required: "recovery_required";
             running: "running";
-            succeeded: "succeeded";
+            recovery_required: "recovery_required";
         }>;
         base_snapshot_id: z.ZodUUID;
         candidate_snapshot_id: z.ZodNullable<z.ZodUUID>;
@@ -2337,8 +2332,8 @@ export declare const FormDesignQueryResponseSchema: z.ZodObject<{
         }>;
         preview_refresh_status: z.ZodEnum<{
             failed: "failed";
-            pending: "pending";
             succeeded: "succeeded";
+            pending: "pending";
             not_started: "not_started";
         }>;
         created_at: z.ZodString;
@@ -2371,10 +2366,10 @@ export declare const FormDesignResumeResponseSchema: z.ZodObject<{
         }>;
         status: z.ZodEnum<{
             failed: "failed";
+            succeeded: "succeeded";
             pending: "pending";
-            recovery_required: "recovery_required";
             running: "running";
-            succeeded: "succeeded";
+            recovery_required: "recovery_required";
         }>;
         base_snapshot_id: z.ZodUUID;
         candidate_snapshot_id: z.ZodNullable<z.ZodUUID>;
@@ -2420,8 +2415,8 @@ export declare const FormDesignResumeResponseSchema: z.ZodObject<{
         }>;
         preview_refresh_status: z.ZodEnum<{
             failed: "failed";
-            pending: "pending";
             succeeded: "succeeded";
+            pending: "pending";
             not_started: "not_started";
         }>;
         created_at: z.ZodString;
@@ -2450,10 +2445,10 @@ export declare const FormDesignOperationRecordSchema: z.ZodObject<{
         }>;
         status: z.ZodEnum<{
             failed: "failed";
+            succeeded: "succeeded";
             pending: "pending";
-            recovery_required: "recovery_required";
             running: "running";
-            succeeded: "succeeded";
+            recovery_required: "recovery_required";
         }>;
         base_snapshot_id: z.ZodUUID;
         candidate_snapshot_id: z.ZodNullable<z.ZodUUID>;
@@ -2499,8 +2494,8 @@ export declare const FormDesignOperationRecordSchema: z.ZodObject<{
         }>;
         preview_refresh_status: z.ZodEnum<{
             failed: "failed";
-            pending: "pending";
             succeeded: "succeeded";
+            pending: "pending";
             not_started: "not_started";
         }>;
         created_at: z.ZodString;
@@ -2643,8 +2638,9 @@ export declare const FormDesignOperationRecordSchema: z.ZodObject<{
                     number: "number";
                     boolean: "boolean";
                     date: "date";
-                    text: "text";
+                    file: "file";
                     email: "email";
+                    text: "text";
                     select: "select";
                     multiselect: "multiselect";
                     textarea: "textarea";
@@ -2661,6 +2657,7 @@ export declare const FormDesignOperationRecordSchema: z.ZodObject<{
                     value: z.ZodString;
                     label: z.ZodString;
                 }, z.core.$strict>>;
+                max_files: z.ZodOptional<z.ZodNumber>;
             }, z.core.$strict>, z.ZodObject<{
                 kind: z.ZodLiteral<"step-break">;
                 step_id: z.ZodString;
@@ -2679,8 +2676,9 @@ export declare const FormDesignOperationRecordSchema: z.ZodObject<{
                         number: "number";
                         boolean: "boolean";
                         date: "date";
-                        text: "text";
+                        file: "file";
                         email: "email";
+                        text: "text";
                         select: "select";
                         multiselect: "multiselect";
                         textarea: "textarea";
@@ -2754,10 +2752,10 @@ export declare const FormDesignOperationTransitionRequestSchema: z.ZodObject<{
         }>>;
         status: z.ZodOptional<z.ZodEnum<{
             failed: "failed";
+            succeeded: "succeeded";
             pending: "pending";
-            recovery_required: "recovery_required";
             running: "running";
-            succeeded: "succeeded";
+            recovery_required: "recovery_required";
         }>>;
         candidate_snapshot_id: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
         before_form_code: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -2798,8 +2796,8 @@ export declare const FormDesignOperationTransitionRequestSchema: z.ZodObject<{
         }>>;
         preview_refresh_status: z.ZodOptional<z.ZodEnum<{
             failed: "failed";
-            pending: "pending";
             succeeded: "succeeded";
+            pending: "pending";
             not_started: "not_started";
         }>>;
     }, z.core.$strict>;