@encatch/schema 1.3.0-beta.4 → 1.3.0-beta.6

package/dist/esm/index.js

@@ -1995,6 +1995,14 @@ var PreviousButtonModes = {
   ALWAYS: "always",
   AUTO: "auto"
 };
+var inAppDisplayTypeSchema = z7.enum(["auto", "modal", "selector"]).describe(
+  "How the form is presented on in-app surfaces: auto (#encatch host or modal), modal (always modal), or selector (render into inAppSelector)"
+);
+var InAppDisplayTypes = {
+  AUTO: "auto",
+  MODAL: "modal",
+  SELECTOR: "selector"
+};
 var logoPlacementSchema = z7.enum(["top-left", "top-center", "top-right"]).describe("Where the logo is anchored in the form header");
 var logoSizeSchema = z7.enum(["small", "medium", "large"]).describe("Rendered display size of the logo within the 96\xD740 px container");
 var logoSurfaceOverrideSchema = z7.object({
@@ -2036,6 +2044,10 @@ var featureSettingsSchema = z7.object({
   rtl: z7.boolean().default(false).describe("Whether right-to-left text direction is enabled"),
   previousButton: previousButtonModeSchema.default(PreviousButtonModes.ALWAYS).describe("Previous button: never (hidden) or always (shown)"),
   maxDialogHeightPercentInApp: z7.number().int().min(10).max(100).optional().describe("Maximum height of the in-app dialog as a percentage of the viewport height (10\u2013100); when absent the dialog uses its default height"),
+  inAppDisplayType: inAppDisplayTypeSchema.default(InAppDisplayTypes.AUTO).describe(
+    "How the form is presented on in-app surfaces: auto (#encatch host or modal), modal (always modal), or selector (render into inAppSelector)"
+  ),
+  inAppSelector: z7.string().optional().describe("CSS selector for the host element to render the form into when inAppDisplayType is 'selector'; if it matches nothing the form falls back to the modal"),
   faviconUrl: z7.string().optional().describe("URL of a custom favicon image to display in the browser tab; when absent the platform default favicon is used"),
   logo: logoSchema.optional().describe("Optional form-level logo shown in the header on link/shareable surfaces; omit to show no logo")
 }).describe("Feature settings controlling widget UI behavior and appearance");
@@ -2361,8 +2373,10 @@ var formConfigSchema = z13.object({
 }).describe("Configuration information for the feedback form");
 var questionResponseSchema = z13.object({
   questionId: z13.string().uuid().describe("Unique identifier for the question"),
-  answer: AnswerSchema.describe("The answer provided for this question"),
-  type: z13.string().describe("Type of the question (e.g., 'rating', 'single_choice')"),
+  answer: AnswerSchema.nullable().optional().describe(
+    "The answer provided for this question; null for display-only types (thank_you, welcome, exit_form) or unanswered questions on the respondent's path"
+  ),
+  type: z13.string().optional().describe("Type of the question (e.g., 'rating', 'single_choice')"),
   error: z13.string().optional().describe("Error message if any validation failed"),
   isOnPath: z13.boolean().optional().describe(
     "When present, whether this question was on the respondent's navigation path (e.g. logic jumps); false for questions not reached"
@@ -2405,6 +2419,26 @@ var submitFeedbackSchema = baseSubmitFeedbackSchema.extend({
   response: responseSchema.describe("User responses (required for full submit)")
 }).describe("Full submit feedback request schema (response required)");
 var feedbackRequestSchema = z13.union([partialFeedbackSchema, submitFeedbackSchema]).describe("Union schema for both partial and full feedback submissions");
+var formDetailsSchema = z13.object({
+  formConfigurationId: z13.string().uuid().describe("Server-issued configuration ID for this form"),
+  feedbackIdentifier: z13.string().optional().describe("Instance identifier for the feedback session"),
+  responseLanguageCode: z13.string().optional().describe("Two-letter language code for the response (e.g., 'en')"),
+  isPartialSubmit: z13.boolean().optional().describe("When true, marks this as a partial (mid-journey) submission"),
+  completionTimeInSeconds: z13.number().int().min(0).optional().describe("Total time taken to complete the form in seconds"),
+  response: z13.object({
+    questions: z13.array(questionResponseSchema).optional().describe("Array of per-question responses"),
+    context: z13.record(z13.string(), z13.unknown()).optional().describe("Liquid variable substitution values from the showForm context option"),
+    contact: z13.record(z13.string(), z13.unknown()).optional().describe("Contact properties from the server for Liquid substitution"),
+    sourceTrackingFieldValues: z13.record(z13.string(), z13.string()).optional().describe("Source tracking field values captured at survey load time")
+  }).optional().describe("User responses to the form questions"),
+  visitedQuestionIds: z13.array(z13.string()).optional().describe("Ordered list of question IDs the respondent actually navigated to"),
+  context: z13.record(z13.string(), z13.union([z13.string(), z13.number(), z13.boolean()])).optional().describe("Caller-provided metadata attached to this submission")
+}).describe("Form details for an SDK-style submit-form request");
+var submitFormRequestSchema = z13.object({
+  triggerType: z13.enum(["automatic", "manual"]).optional().describe("Whether the form was triggered automatically or manually"),
+  formDetails: formDetailsSchema.describe("Core submission payload"),
+  $deviceInfo: z13.record(z13.string(), z13.unknown()).optional().describe("Device and SDK metadata automatically injected by the SDK")
+}).describe("Complete submit-form request envelope (SDK-facing contract)");
 
 // src/schemas/api/fetch-feedback-schema.ts
 import { z as z14 } from "zod";
@@ -2664,6 +2698,7 @@ export {
   DeviceThemes,
   FileUploadAnswerItemSchema,
   FileUploadAnswerSchema,
+  InAppDisplayTypes,
   LanguageFieldSchema,
   LanguagesSchema,
   LayoutAttachmentTypes,
@@ -2749,9 +2784,11 @@ export {
   focalPointSchema,
   formConfigSchema,
   formConfigurationResponseSchema,
+  formDetailsSchema,
   formPropertiesSchema,
   gradientAttachmentSchema,
   imageAttachmentSchema,
+  inAppDisplayTypeSchema,
   layoutAttachmentSchema,
   layoutSurfaceSchema,
   logicJumpRuleSchema,
@@ -2840,6 +2877,7 @@ export {
   splitLayoutSchema,
   stackLayoutSchema,
   submitFeedbackSchema,
+  submitFormRequestSchema,
   thankYouQuestionSchema,
   thankYouQuestionTranslationSchema,
   themeColorsSchema,