@encatch/schema 1.0.1-beta.3 → 1.1.0-beta.11

package/dist/esm/index.js

@@ -10,13 +10,15 @@ var translationEntrySchema = z.string().min(1).describe("Translated text content
 var baseQuestionTranslationFieldsSchema = z.object({
   title: translationEntrySchema.describe("Question title translation"),
   description: translationEntrySchema.optional().describe("Question description translation"),
-  errorMessage: translationEntrySchema.optional().describe("Error message translation")
+  errorMessage: translationEntrySchema.optional().describe("Error message translation"),
+  nextButtonLabel: translationEntrySchema.max(50).optional().describe("Next button label translation when advancing past this question")
 });
 var BASE_QUESTION_TRANSLATION_KEYS = [
   "type",
   "title",
   "description",
-  "errorMessage"
+  "errorMessage",
+  "nextButtonLabel"
 ];
 var ratingQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
   type: z.literal("rating").describe("Question type identifier"),
@@ -86,21 +88,17 @@ var annotationQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.ex
   noAnnotationText: translationEntrySchema.optional().describe("No annotation display text translation")
 }).describe("Translation schema for annotation questions");
 var welcomeQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
-  type: z.literal("welcome").describe("Question type identifier"),
-  buttonLabel: translationEntrySchema.optional().describe("Translated proceed/start button label")
+  type: z.literal("welcome").describe("Question type identifier")
 }).describe("Translation schema for welcome screen questions");
 var thankYouQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
-  type: z.literal("thank_you").describe("Question type identifier"),
-  buttonLabel: translationEntrySchema.optional().describe(
-    "Translated dismiss/done button label"
-  )
+  type: z.literal("thank_you").describe("Question type identifier")
 }).describe("Translation schema for thank you screen questions");
 var messagePanelQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
-  type: z.literal("message_panel").describe("Question type identifier"),
-  buttonLabel: translationEntrySchema.optional().describe(
-    "Translated continue/button label"
-  )
+  type: z.literal("message_panel").describe("Question type identifier")
 }).describe("Translation schema for message panel questions");
+var consentQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
+  type: z.literal("consent").describe("Question type identifier")
+}).describe("Translation schema for consent questions; description carries the translated checkbox label (markdown supported)");
 var yesNoQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
   type: z.literal("yes_no").describe("Question type identifier"),
   yesLabel: translationEntrySchema.optional().describe("Translated Yes label"),
@@ -172,11 +170,18 @@ var questionTranslationSchema = z.union([
   thankYouQuestionTranslationSchema,
   messagePanelQuestionTranslationSchema,
   yesNoQuestionTranslationSchema,
+  consentQuestionTranslationSchema,
   ratingMatrixQuestionTranslationSchema,
   matrixSingleChoiceQuestionTranslationSchema,
   matrixMultipleChoiceQuestionTranslationSchema
 ]).describe("Union of all question type translation schemas");
 var languageCodeSchema = z.string().min(2).max(10).describe("Language code (e.g., 'en', 'es', 'hi')");
+var sectionTranslationSchema = z.object({
+  title: translationEntrySchema.max(200).describe("Section title translation"),
+  description: translationEntrySchema.max(1e3).optional().describe("Section description translation"),
+  nextButtonLabel: translationEntrySchema.max(50).optional().describe("Next button label translation for this section")
+}).describe("Translation payload for a section in a single language");
+var sectionTranslationsByLanguageSchema = z.record(languageCodeSchema, sectionTranslationSchema).describe("Section translations keyed by language code");
 var questionTranslationsByLanguageSchema = z.record(languageCodeSchema, questionTranslationSchema).describe("Question translations keyed by language code");
 var questionCentricTranslationsSchema = z.record(z.string().uuid(), questionTranslationsByLanguageSchema).describe("Question-centric translations keyed by question ID, then by language code");
 var translationsSchema = questionCentricTranslationsSchema.describe("Question-centric translations at root level");
@@ -288,7 +293,8 @@ var questionTypeSchema = z2.enum([
   "rating_matrix",
   "matrix_single_choice",
   "matrix_multiple_choice",
-  "exit_form"
+  "exit_form",
+  "consent"
 ]).describe("Enumeration of all supported question types for form fields");
 var QuestionTypes = {
   RATING: "rating",
@@ -306,7 +312,8 @@ var QuestionTypes = {
   RATING_MATRIX: "rating_matrix",
   MATRIX_SINGLE_CHOICE: "matrix_single_choice",
   MATRIX_MULTIPLE_CHOICE: "matrix_multiple_choice",
-  EXIT_FORM: "exit_form"
+  EXIT_FORM: "exit_form",
+  CONSENT: "consent"
 };
 var validationRuleTypeSchema = z2.enum([
   "required",
@@ -367,27 +374,19 @@ var visibilityConditionSchema = z2.object({
 var sectionSchema = z2.object({
   id: z2.string().describe("Unique identifier for the section"),
   title: z2.string().min(1).max(200).describe("Display title for the section"),
-  titleTranslations: z2.record(
-    languageCodeSchema,
-    z2.string().min(1).max(200)
-  ).optional().describe("Localized section titles keyed by language code"),
   description: z2.string().max(1e3).optional().describe("Optional detailed description or help text for the section"),
-  descriptionTranslations: z2.record(
-    languageCodeSchema,
-    z2.string().min(1).max(1e3)
-  ).optional().describe("Localized section descriptions keyed by language code"),
   showTitle: z2.boolean().default(true).describe("Whether to show the section title in the UI"),
   showDescription: z2.boolean().default(true).describe("Whether to show the section description in the UI"),
   nextButtonLabel: z2.string().min(1).max(50).optional().describe("Label for the next button when navigating from this section"),
-  nextButtonLabelTranslations: z2.record(
-    languageCodeSchema,
-    z2.string().min(1).max(50)
-  ).optional().describe(
-    "Localized next-button labels for this section keyed by language code"
+  translations: sectionTranslationsByLanguageSchema.optional().describe(
+    "Per-language section copy (title, optional description and nextButtonLabel), keyed by language code"
   ),
   inAppSingleQuestion: z2.boolean().default(false).describe(
     "When true, the native app shows one question at a time within this section"
   ),
+  isPreviousAllowed: z2.boolean().default(false).optional().describe(
+    "When the global previousButton mode is 'auto', controls whether the Previous button is shown for this section. Defaults to false (hidden)."
+  ),
   questionIds: z2.array(z2.string()).min(1).describe("Array of question IDs that belong to this section")
 }).describe("Schema defining sections that organize questions into logical groups");
 var questionStatusSchema = z2.enum(["D", "P", "A", "S"]);
@@ -466,6 +465,9 @@ var ChoiceOrderOptions = {
 };
 var questionSchema = z2.object({
   id: z2.string().describe("Unique identifier for the question"),
+  slug: z2.string().min(1).max(128).optional().describe(
+    "Optional stable identifier for the question (e.g. URLs, analytics, or integrations)"
+  ),
   type: questionTypeSchema.describe(
     "The type of question (rating, single_choice, etc.)"
   ),
@@ -483,7 +485,12 @@ var questionSchema = z2.object({
   status: questionStatusSchema.describe(
     "Current status of the question (Draft, Published, etc.)"
   ),
-  textAlign: z2.enum(["left", "center"]).optional().default("left").describe("Text alignment for the question title and description")
+  textAlign: z2.enum(["left", "center", "justify"]).optional().default("left").describe(
+    "Text alignment for the question title and description; `justify` is intended for consent questions (full-width justified consent body markdown)"
+  ),
+  nextButtonLabel: z2.string().min(1).max(50).optional().describe(
+    "Label for the next button when advancing past this question (overrides section or form defaults when set)"
+  )
 }).describe("Base schema for all question types with common properties");
 var ratingQuestionSchema = questionSchema.extend({
   type: z2.literal("rating").describe("Must be exactly 'rating'"),
@@ -506,7 +513,6 @@ var welcomeQuestionSchema = questionSchema.extend({
   type: z2.literal("welcome").describe("Must be exactly 'welcome'"),
   title: z2.string().min(1).max(200).describe("The main heading displayed on the welcome screen"),
   description: z2.string().max(1e3).optional().describe("Optional sub-text body shown below the heading"),
-  buttonLabel: z2.string().min(1).max(50).optional().describe("Label for the proceed/start button (e.g. 'Get Started', 'Begin')"),
   imageUrl: z2.string().url().optional().describe("Optional image URL displayed on the welcome screen")
 }).describe("Schema for a welcome screen displayed at the start or inline within a form");
 var thankYouQuestionSchema = questionSchema.extend({
@@ -515,7 +521,6 @@ var thankYouQuestionSchema = questionSchema.extend({
   description: z2.string().max(1e3).optional().describe(
     "Optional thank you body text; rendered as Markdown where the form supports it"
   ),
-  buttonLabel: z2.string().min(1).max(50).optional().describe("Label for the dismiss/done button (e.g. 'Done', 'Close')"),
   imageUrl: z2.string().url().optional().describe("Optional image URL displayed on the thank you screen")
 }).describe(
   "Schema for a thank you screen shown at the end or inline within a form"
@@ -524,7 +529,6 @@ var messagePanelQuestionSchema = questionSchema.extend({
   type: z2.literal("message_panel").describe("Must be exactly 'message_panel'"),
   title: z2.string().min(1).max(200).describe("The main heading displayed on the message panel"),
   description: z2.string().max(1e3).optional().describe("Optional body text shown below the heading"),
-  buttonLabel: z2.string().min(1).max(50).optional().describe("Label for the continue button (e.g. 'Continue', 'Next')"),
   imageUrl: z2.string().url().optional().describe("Optional image URL displayed on the message panel")
 }).describe(
   "Schema for an inline message panel (informational); distinct from welcome for UI semantics and analytics"
@@ -540,6 +544,11 @@ var yesNoQuestionSchema = questionSchema.extend({
   noLabel: z2.string().min(1).max(50).optional().describe("Label for the No option (defaults to 'No' in the UI if omitted)"),
   displayStyle: yesNoDisplayStyleSchema.optional().describe("Layout for the Yes/No controls (horizontal row or vertical stack)")
 }).describe("Schema for yes/no questions with optional custom labels and layout");
+var consentQuestionSchema = questionSchema.extend({
+  type: z2.literal("consent").describe("Must be exactly 'consent'")
+}).describe(
+  "Schema for a single-checkbox consent question; use description (rendered as markdown) for the checkbox label text and any policy/terms links; answer is boolean (true = checked)"
+);
 var ratingMatrixDisplayStyleSchema = z2.enum([
   "radio",
   "star",
@@ -838,6 +847,7 @@ var combinedQuestionSchema = z2.discriminatedUnion("type", [
   messagePanelQuestionSchema,
   exitFormQuestionSchema,
   yesNoQuestionSchema,
+  consentQuestionSchema,
   ratingMatrixQuestionSchema,
   matrixSingleChoiceQuestionSchema,
   matrixMultipleChoiceQuestionSchema,
@@ -871,6 +881,7 @@ var AnswerItemSchema = z3.object({
   ),
   rating: z3.number().optional().describe("Star rating value (e.g., 1-5)"),
   yesNo: z3.boolean().optional().describe("Yes/no answer for yes_no questions (true = Yes, false = No)"),
+  consent: z3.boolean().optional().describe("Consent answer for consent questions (true = checked/agreed, false = unchecked)"),
   multipleChoiceMultiple: z3.array(z3.string()).optional().describe("Array of selected option IDs for multiple choice questions"),
   singleChoiceOther: z3.string().optional().describe(
     'Free-text "other" answer for single choice questions when allowOther is enabled'
@@ -923,13 +934,9 @@ import { z as z8 } from "zod";
 // src/schemas/fields/other-screen-schema.ts
 import { z as z5 } from "zod";
 var OtherFieldsSchema = z5.object({
-  pagination: z5.boolean().describe("Whether to show pagination for multi-page forms"),
   questionNumber: z5.boolean().describe("Whether to display question numbers"),
-  pageTitle: z5.boolean().describe("Whether to show page titles in multi-page forms"),
-  blockerFeedback: z5.boolean().describe("Whether to show blocker feedback for validation errors"),
   submitButtonLabel: z5.string().min(1).max(50).describe("Text for the submit button"),
   previousButtonLabel: z5.string().min(1).max(50).describe("Text for the previous button in pagination"),
-  nextButtonLabel: z5.string().min(1).max(50).describe("Text for the next button in pagination"),
   aiEnhancementSuccessMessage: z5.string().min(1).max(100).describe("Message shown when AI enhancement is successful (max 100 characters)"),
   aiEnhancementCooldownErrorMessage: z5.string().min(1).max(100).describe("Message shown when AI enhancement is on cooldown (max 100 characters)"),
   aiEnhancementMaxReachedErrorMessage: z5.string().min(1).max(100).describe("Message shown when maximum AI enhancements reached (max 100 characters)")
@@ -942,7 +949,6 @@ var LanguagesSchema = z5.array(LanguageFieldSchema).describe("Schema for array o
 var OtherFieldsTranslationSchema = z5.object({
   submitButtonLabel: z5.string().min(1).max(50).describe("Translated text for the submit button"),
   previousButtonLabel: z5.string().min(1).max(50).describe("Translated text for the previous button in pagination"),
-  nextButtonLabel: z5.string().min(1).max(50).describe("Translated text for the next button in pagination"),
   aiEnhancementSuccessMessage: z5.string().min(1).max(100).describe("Translated message shown when AI enhancement is successful (max 100 characters)"),
   aiEnhancementCooldownErrorMessage: z5.string().min(1).max(100).describe("Translated message shown when AI enhancement is on cooldown (max 100 characters)"),
   aiEnhancementMaxReachedErrorMessage: z5.string().min(1).max(100).describe("Translated message shown when maximum AI enhancements reached (max 100 characters)")
@@ -985,19 +991,29 @@ var ShareableModes = {
   DARK: "dark",
   SYSTEM: "system"
 };
-var previousButtonModeSchema = z6.enum(["never", "always", "auto"]).describe("Previous button visibility mode: never, always, or auto");
+var previousButtonModeSchema = z6.enum(["never", "always", "auto"]).describe(
+  "Previous button visibility: never (always hidden), always (always shown), or auto (per-section via isPreviousAllowed)"
+);
+var PreviousButtonModes = {
+  NEVER: "never",
+  ALWAYS: "always",
+  AUTO: "auto"
+};
 var featureSettingsSchema = z6.object({
-  darkOverlay: z6.boolean().describe("Whether to show a dark overlay behind the widget"),
-  closeButton: z6.boolean().describe("Whether to display a close button on the widget"),
-  progressBar: z6.boolean().describe("Whether to show a progress bar indicating completion status"),
-  showBranding: z6.boolean().describe("Whether to display branding elements on the widget"),
+  darkOverlay: z6.boolean().default(false).describe("Whether to show a dark overlay behind the widget"),
+  closeButton: z6.boolean().default(true).describe("Whether to display a close button on the widget"),
+  progressBar: z6.boolean().default(true).describe("Whether to show a progress bar indicating completion status"),
+  showBranding: z6.boolean().default(true).describe("Whether to display branding elements on the widget"),
   customPosition: z6.boolean().describe("Whether custom positioning is enabled"),
   customCss: z6.string().optional().describe("Custom CSS link to apply for the feedback form"),
-  shareableMode: shareableModeSchema.optional().describe(
+  shareableMode: shareableModeSchema.optional().default(ShareableModes.LIGHT).describe(
     "Display mode for the shareable: light, dark, or system preference"
   ),
-  rtl: z6.boolean().describe("Whether right-to-left text direction is enabled"),
-  previousButton: previousButtonModeSchema.describe("Previous button visibility mode: never, always, or auto")
+  enableShareableKeyboardNavigation: z6.boolean().default(false).describe(
+    "Whether keyboard navigation is enabled for the shareable widget experience"
+  ),
+  rtl: z6.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)")
 }).describe("Feature settings controlling widget UI behavior and appearance");
 var themeColorsSchema = z6.object({
   theme: z6.string().optional().describe("Theme for a single mode (shadcn variables JSON)")
@@ -1101,13 +1117,13 @@ var otherConfigurationPropertiesSchema = z8.discriminatedUnion("isEnabled", [
   // When other configuration is disabled
   z8.object({
     isEnabled: z8.literal(false).describe("Whether other configuration properties are enabled"),
-    otherFields: OtherFieldsSchema.describe("Other form configuration fields including pagination, buttons, and display options"),
+    otherFields: OtherFieldsSchema.describe("Other form configuration fields including buttons and display options"),
     translations: z8.record(z8.string(), OtherFieldsTranslationSchema).optional().describe("Translations for other configuration field labels and buttons keyed by language code")
   }),
   // When other configuration is enabled
   z8.object({
     isEnabled: z8.literal(true).describe("Whether other configuration properties are enabled"),
-    otherFields: OtherFieldsSchema.describe("Other form configuration fields including pagination, buttons, and display options"),
+    otherFields: OtherFieldsSchema.describe("Other form configuration fields including buttons and display options"),
     translations: z8.record(z8.string(), OtherFieldsTranslationSchema).describe("Translations for other configuration field labels and buttons keyed by language code")
   })
 ]).describe("Schema for other configuration properties including fields and translations");
@@ -1195,7 +1211,16 @@ var questionResponseSchema = z11.object({
   questionId: z11.string().uuid().describe("Unique identifier for the question"),
   answer: AnswerSchema.describe("The answer provided for this question"),
   type: z11.string().describe("Type of the question (e.g., 'rating', 'single_choice')"),
-  error: z11.string().optional().describe("Error message if any validation failed")
+  error: z11.string().optional().describe("Error message if any validation failed"),
+  isOnPath: z11.boolean().optional().describe(
+    "When present, whether this question was on the respondent's navigation path (e.g. logic jumps); false for questions not reached"
+  ),
+  timeSpentMs: z11.number().int().min(0).optional().describe(
+    "Milliseconds the respondent spent on this question (even split across all visible questions in the section)"
+  ),
+  isPathTraversed: z11.boolean().optional().describe(
+    "Whether this question was on the logical traversal path \u2014 true for visible questions and hidden questions whose rules were evaluated, false for questions never reached"
+  )
 }).describe("Response to a specific question in the feedback form");
 var responseSchema = z11.object({
   questions: z11.array(questionResponseSchema).min(1).describe("Array of question responses")
@@ -1256,8 +1281,11 @@ var feedbackConfigurationItemSchema = z12.object({
       customPosition: z12.boolean().describe("Whether custom position is enabled"),
       customIconPosition: z12.boolean().describe("Whether custom icon position is enabled"),
       customCss: z12.string().nullable().optional().describe("Custom CSS link (optional)"),
+      enableShareableKeyboardNavigation: z12.boolean().default(false).describe(
+        "Whether keyboard navigation is enabled for the shareable widget experience"
+      ),
       rtl: z12.boolean().describe("Whether right-to-left text direction is enabled"),
-      previousButton: z12.enum(["never", "always", "auto"]).describe("Previous button visibility mode: never, always, or auto")
+      previousButton: z12.enum(["never", "always"]).describe("Previous button: never (hidden) or always (shown)")
     }).describe("Feature settings for the feedback form"),
     selectedIconPosition: z12.string().describe("Selected position for the feedback icon"),
     selectedPosition: z12.string().describe("Selected position for the feedback form")
@@ -1285,6 +1313,16 @@ var formConfigurationResponseSchema = z12.object({
   formTitle: z12.string().describe("Title of the feedback form"),
   formDescription: z12.string().describe("Description of the feedback form")
 }).describe("Form configuration response with title and description");
+var logicJumpRuleSchema = z12.object({
+  jsonLogic: z12.record(z12.string(), z12.unknown()).describe("JSON Logic expression to evaluate"),
+  targetQuestionId: z12.string().describe("Question ID to navigate to when this rule matches")
+}).describe("A single logic jump rule mapping a condition to a target question");
+var logicJumpRulesSchema = z12.record(
+  z12.string(),
+  z12.array(logicJumpRuleSchema)
+).describe(
+  "Logic jump rules keyed by question ID (or '__workflow_start__'). Each entry is an ordered array of rules evaluated top-down; the first matching rule wins."
+);
 var questionnaireFieldsResponseSchema = z12.object({
   questions: z12.record(z12.string(), combinedQuestionSchema).describe("Collection of questions keyed by their string identifiers"),
   sections: z12.array(sectionSchema).describe(
@@ -1295,9 +1333,12 @@ var questionnaireFieldsResponseSchema = z12.object({
   ),
   selectedLanguages: LanguagesSchema.describe(
     "Array of languages selected for this questionnaire"
-  )
+  ),
+  isLogicJumpsEnabled: z12.boolean().optional().default(false).describe("When true, form navigation follows logicJumpRules instead of linear section order"),
+  logicJumpRules: logicJumpRulesSchema.optional().describe("Conditional navigation rules evaluated per question to determine the next question to show"),
+  contextVariables: z12.array(z12.string()).optional().describe("List of context variable keys expected by the form (informational)")
 }).describe(
-  "Questionnaire fields response including questions, sections, translations, and selected languages"
+  "Questionnaire fields response including questions, sections, translations, selected languages, and optional logic jump configuration"
 );
 var fetchFeedbackDetailsResponseSchema = z12.object({
   feedbackConfigurationId: z12.string().uuid().describe("Unique identifier for the feedback configuration"),
@@ -1467,6 +1508,7 @@ export {
   OtherFieldsSchema,
   OtherFieldsTranslationSchema,
   Positions,
+  PreviousButtonModes,
   PublicationStatuses,
   QuestionStatuses,
   QuestionTypes,
@@ -1492,6 +1534,8 @@ export {
   conditionalIfMetadataSchema,
   conditionalIfSchema,
   conditionalWhenSchema,
+  consentQuestionSchema,
+  consentQuestionTranslationSchema,
   createTranslationProvider,
   currentModeSchema,
   customEventFieldOperatorSchema,
@@ -1514,6 +1558,8 @@ export {
   formConfigSchema,
   formConfigurationResponseSchema,
   formPropertiesSchema,
+  logicJumpRuleSchema,
+  logicJumpRulesSchema,
   longAnswerQuestionSchema,
   longAnswerQuestionTranslationSchema,
   masterPropertiesSchema,
@@ -1542,6 +1588,7 @@ export {
   otherConfigurationPropertiesSchema,
   partialFeedbackSchema,
   positionSchema,
+  previousButtonModeSchema,
   publicationStatusSchema,
   queryOutputSchema,
   questionCentricTranslationsSchema,
@@ -1567,6 +1614,8 @@ export {
   refineTextResponseSchema,
   responseSchema,
   sectionSchema,
+  sectionTranslationSchema,
+  sectionTranslationsByLanguageSchema,
   sessionInfoSchema,
   shareableModeSchema,
   shortAnswerQuestionSchema,