@encatch/schema 1.0.1-beta.1 → 1.0.1-beta.2

package/dist/esm/index.js

@@ -18,7 +18,8 @@ var questionTypeSchema = z.enum([
   "yes_no",
   "rating_matrix",
   "matrix_single_choice",
-  "matrix_multiple_choice"
+  "matrix_multiple_choice",
+  "exit_form"
 ]).describe("Enumeration of all supported question types for form fields");
 var QuestionTypes = {
   RATING: "rating",
@@ -35,7 +36,8 @@ var QuestionTypes = {
   YES_NO: "yes_no",
   RATING_MATRIX: "rating_matrix",
   MATRIX_SINGLE_CHOICE: "matrix_single_choice",
-  MATRIX_MULTIPLE_CHOICE: "matrix_multiple_choice"
+  MATRIX_MULTIPLE_CHOICE: "matrix_multiple_choice",
+  EXIT_FORM: "exit_form"
 };
 var validationRuleTypeSchema = z.enum([
   "required",
@@ -179,19 +181,19 @@ var questionSchema = z.object({
   ),
   title: z.string().min(1).max(200).describe("The main title/question text displayed to users"),
   description: z.string().max(1e3).optional().describe("Optional detailed description or help text"),
-  descriptionMarkdown: z.string().max(5e3).optional().describe("Optional description in Markdown format"),
   describe: z.string().max(2e3).optional().describe(
     "LLM tool call description for better AI understanding and context"
   ),
   required: z.boolean().default(false).describe("Whether this question must be answered"),
+  isHidden: z.boolean().default(false).describe("When true, the question is hidden from the form UI"),
   errorMessage: z.string().max(500).optional().describe("Custom error message when validation fails"),
   validations: z.array(validationRuleSchema).optional().default([]).describe("Array of validation rules to apply"),
   visibility: z.array(visibilityConditionSchema).optional().default([]).describe("Conditions that control when this question is shown"),
-  isFixed: z.boolean().describe("Whether this question position is fixed or can be reordered"),
   sectionId: z.string().optional().describe("ID of the section this question belongs to"),
   status: questionStatusSchema.describe(
     "Current status of the question (Draft, Published, etc.)"
-  )
+  ),
+  textAlign: z.enum(["left", "center"]).optional().default("left").describe("Text alignment for the question title and description")
 }).describe("Base schema for all question types with common properties");
 var ratingQuestionSchema = questionSchema.extend({
   type: z.literal("rating").describe("Must be exactly 'rating'"),
@@ -221,12 +223,12 @@ var thankYouQuestionSchema = questionSchema.extend({
   type: z.literal("thank_you").describe("Must be exactly 'thank_you'"),
   title: z.string().min(1).max(200).describe("The main heading displayed on the thank you screen"),
   description: z.string().max(1e3).optional().describe(
-    "Optional thank you body text (plain); use descriptionMarkdown for rich content"
+    "Optional thank you body text; rendered as Markdown where the form supports it"
   ),
   buttonLabel: z.string().min(1).max(50).optional().describe("Label for the dismiss/done button (e.g. 'Done', 'Close')"),
   imageUrl: z.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; use descriptionMarkdown from the base question for rich copy"
+  "Schema for a thank you screen shown at the end or inline within a form"
 );
 var messagePanelQuestionSchema = questionSchema.extend({
   type: z.literal("message_panel").describe("Must be exactly 'message_panel'"),
@@ -237,6 +239,11 @@ var messagePanelQuestionSchema = questionSchema.extend({
 }).describe(
   "Schema for an inline message panel (informational); distinct from welcome for UI semantics and analytics"
 );
+var exitFormQuestionSchema = questionSchema.extend({
+  type: z.literal("exit_form").describe("Must be exactly 'exit_form'")
+}).describe(
+  "Schema for an exit marker that silently ends the survey; carries no UI and captures no answer \u2014 intended for branch logic paths that should terminate without showing a thank-you screen"
+);
 var yesNoQuestionSchema = questionSchema.extend({
   type: z.literal("yes_no").describe("Must be exactly 'yes_no'"),
   yesLabel: z.string().min(1).max(50).optional().describe("Label for the Yes option (defaults to 'Yes' in the UI if omitted)"),
@@ -268,23 +275,21 @@ var ratingMatrixScalePointSchema = z.object({
   describe: z.string().max(500).optional().describe("LLM tool call description for this scale point")
 }).describe("Schema for a single point on a custom rating scale");
 var ratingMatrixScaleSchema = z.discriminatedUnion("kind", [
-  // Likert: symmetric ordinal scale -2…+2, implicit 5 points
+  // Likert: symmetric ordinal scale -2…+2, explicit scale points with labels
   z.object({
     kind: z.literal("likert").describe("Symmetric ordinal scale (-2 to +2)"),
-    minLabel: z.string().max(100).optional().describe("Optional label for the negative end of the Likert scale"),
-    maxLabel: z.string().max(100).optional().describe("Optional label for the positive end of the Likert scale")
+    scalePoints: z.array(ratingMatrixScalePointSchema).min(2).max(10).describe("Scale points with display labels for each column")
   }),
-  // Numerical: 1…N points where N is 2, 3, 4, or 5
+  // Numerical: 1…N points where N is 2, 3, 4, or 5, explicit scale points with labels
   z.object({
-    kind: z.literal("numerical").describe("Numerical scale from 1 to N (N = 2-5)"),
-    pointCount: z.union([z.literal(2), z.literal(3), z.literal(4), z.literal(5)]).describe("Number of scale points (2, 3, 4, or 5)"),
-    minLabel: z.string().max(100).optional().describe("Optional label for the lowest numerical value"),
-    maxLabel: z.string().max(100).optional().describe("Optional label for the highest numerical value")
+    kind: z.literal("numerical").describe("Numerical scale from 1 to N"),
+    scalePoints: z.array(ratingMatrixScalePointSchema).min(2).max(10).describe("Scale points with display labels for each column"),
+    pointCount: z.union([z.literal(2), z.literal(3), z.literal(4), z.literal(5)]).describe("Number of scale points (2, 3, 4, or 5)")
   }),
   // Custom: consumer defines each point's value and label
   z.object({
     kind: z.literal("custom").describe("Custom scale with user-defined points and values"),
-    scalePoints: z.array(ratingMatrixScalePointSchema).min(2).max(5).describe("User-defined scale points (2-5 points)")
+    scalePoints: z.array(ratingMatrixScalePointSchema).min(2).max(10).describe("Scale points with display labels for each column")
   })
 ]).describe("Scale configuration for rating matrix questions");
 var ratingMatrixQuestionSchema = questionSchema.extend({
@@ -541,6 +546,7 @@ var combinedQuestionSchema = z.discriminatedUnion("type", [
   welcomeQuestionSchema,
   thankYouQuestionSchema,
   messagePanelQuestionSchema,
+  exitFormQuestionSchema,
   yesNoQuestionSchema,
   ratingMatrixQuestionSchema,
   matrixSingleChoiceQuestionSchema,
@@ -586,13 +592,13 @@ var AnswerItemSchema = z2.object({
     "Annotation object containing file and marker details"
   ),
   ratingMatrix: z2.record(z2.string(), z2.union([z2.number(), z2.string()])).optional().describe(
-    "Rating matrix answers keyed by statement id, value is the selected scale value (number for likert/numerical, string for custom)"
+    "Rating matrix answers keyed by statement value (export key), value is the selected scale value (number for likert/numerical, string for custom)"
   ),
   matrixSingleChoice: z2.record(z2.string(), z2.string()).optional().describe(
-    "Matrix single-choice answers keyed by row id, value is the selected column option id"
+    "Matrix single-choice answers keyed by row value (export key), map value is the selected column option value"
   ),
   matrixMultipleChoice: z2.record(z2.string(), z2.array(z2.string())).optional().describe(
-    "Matrix multiple-choice answers keyed by row id, value is array of selected column option ids"
+    "Matrix multiple-choice answers keyed by row value (export key), map value is array of selected column option values"
   ),
   others: z2.string().optional().describe(
     "For multiple choice questions and single choice questions, this is the value of the other option"
@@ -722,14 +728,12 @@ var translationEntrySchema = z4.string().min(1).describe("Translated text conten
 var baseQuestionTranslationFieldsSchema = z4.object({
   title: translationEntrySchema.describe("Question title translation"),
   description: translationEntrySchema.optional().describe("Question description translation"),
-  descriptionMarkdown: translationEntrySchema.optional().describe("Question description Markdown translation"),
   errorMessage: translationEntrySchema.optional().describe("Error message translation")
 });
 var BASE_QUESTION_TRANSLATION_KEYS = [
   "type",
   "title",
   "description",
-  "descriptionMarkdown",
   "errorMessage"
 ];
 var ratingQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
@@ -987,33 +991,6 @@ __name(createTranslationProvider, "createTranslationProvider");
 
 // src/schemas/fields/other-screen-schema.ts
 import { z as z5 } from "zod";
-var dismissBehaviorSchema = z5.enum(["fade", "manual"]).describe("How the end screen should be dismissed (fade out or manual dismissal)");
-var DismissBehaviors = {
-  FADE: "fade",
-  MANUAL: "manual"
-};
-var WelcomeScreenFieldsSchema = z5.object({
-  title: z5.string().min(1).max(200).describe("The main title displayed on the welcome screen"),
-  description: z5.string().min(1).max(1e3).describe("Description text shown on the welcome screen"),
-  buttonLabel: z5.string().min(1).max(50).describe("Text displayed on the welcome screen button")
-}).describe("Schema for welcome screen configuration fields");
-var EndScreenFieldsSchema = z5.object({
-  title: z5.string().min(1).max(200).describe("The main title displayed on the end screen"),
-  message: z5.string().min(1).max(1e3).describe("Message text shown on the end screen"),
-  buttonLabel: z5.string().min(1).max(50).describe("Text displayed on the end screen button"),
-  dismissBehavior: dismissBehaviorSchema.describe("How the end screen should be dismissed (fade out or manual dismissal)"),
-  fadeDuration: z5.number().int().min(0).max(1e4).describe("Duration in milliseconds for fade dismissal (0-10000)")
-}).describe("Schema for end screen configuration fields");
-var WelcomeFieldsTranslationSchema = z5.object({
-  title: z5.string().min(1).max(200).describe("Translated title text for welcome screen"),
-  description: z5.string().min(1).max(1e3).describe("Translated description text for welcome screen"),
-  buttonLabel: z5.string().min(1).max(50).describe("Translated text for the welcome button label")
-}).describe("Schema for welcome screen translation fields");
-var EndFieldsTranslationSchema = z5.object({
-  buttonLabel: z5.string().min(1).max(50).describe("Translated text for the end button label"),
-  title: z5.string().min(1).max(200).describe("Translated title text for end screen"),
-  message: z5.string().min(1).max(1e3).describe("Translated message text for end screen")
-}).describe("Schema for end screen translation fields");
 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"),
@@ -1028,9 +1005,8 @@ var OtherFieldsSchema = z5.object({
 }).describe("Schema for other form configuration fields");
 var LanguageFieldSchema = z5.object({
   value: z5.string().min(1).max(10).describe("Language code (e.g., 'en', 'es', 'fr')"),
-  label: z5.string().min(1).max(50).describe("Display name for the language (e.g., 'English', 'Spanish', 'French')"),
-  isFixed: z5.boolean().default(false).describe("Whether this language is fixed and cannot be deleted by users")
-}).describe("Schema for individual language field with value, label, and fixed status");
+  label: z5.string().min(1).max(50).describe("Display name for the language (e.g., 'English', 'Spanish', 'French')")
+}).describe("Schema for individual language field with value and label");
 var LanguagesSchema = z5.array(LanguageFieldSchema).describe("Schema for array of available languages");
 var OtherFieldsTranslationSchema = z5.object({
   submitButtonLabel: z5.string().min(1).max(50).describe("Translated text for the submit button"),
@@ -1206,34 +1182,6 @@ var otherConfigurationPropertiesSchema = z8.discriminatedUnion("isEnabled", [
     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");
-var welcomeScreenPropertiesSchema = z8.discriminatedUnion("isEnabled", [
-  // When welcome screen is disabled
-  z8.object({
-    isEnabled: z8.literal(false).describe("Whether welcome screen is enabled"),
-    welcomeFields: WelcomeScreenFieldsSchema.optional().describe("Welcome screen configuration fields including title, description, and button label"),
-    translations: z8.record(z8.string(), WelcomeFieldsTranslationSchema).optional().describe("Translations for welcome screen content keyed by language code")
-  }),
-  // When welcome screen is enabled
-  z8.object({
-    isEnabled: z8.literal(true).describe("Whether welcome screen is enabled"),
-    welcomeFields: WelcomeScreenFieldsSchema.describe("Welcome screen configuration fields including title, description, and button label"),
-    translations: z8.record(z8.string(), WelcomeFieldsTranslationSchema).describe("Translations for welcome screen content keyed by language code")
-  })
-]).describe("Schema for welcome screen properties including fields and translations");
-var endScreenPropertiesSchema = z8.discriminatedUnion("isEnabled", [
-  // When end screen is disabled
-  z8.object({
-    isEnabled: z8.literal(false).describe("Whether end screen is enabled"),
-    endFields: EndScreenFieldsSchema.optional().describe("End screen configuration fields including title, message, button label, and dismissal behavior"),
-    translations: z8.record(z8.string(), EndFieldsTranslationSchema).optional().describe("Translations for end screen content keyed by language code")
-  }),
-  // When end screen is enabled
-  z8.object({
-    isEnabled: z8.literal(true).describe("Whether end screen is enabled"),
-    endFields: EndScreenFieldsSchema.describe("End screen configuration fields including title, message, button label, and dismissal behavior"),
-    translations: z8.record(z8.string(), EndFieldsTranslationSchema).describe("Translations for end screen content keyed by language code")
-  })
-]).describe("Schema for end screen properties including fields and translations");
 var appearancePropertiesSchema = z8.object({
   themeConfiguration: themeConfigurationSchema.describe("Theme configuration including colors, features, and positioning")
 }).describe("Schema for appearance properties including theme configuration");
@@ -1250,10 +1198,8 @@ var formPropertiesSchema = z8.object({
   externalPublishingProperties: externalPublishingPropertiesSchema.describe("Properties controlling external sharing and publishing of feedback results"),
   audienceTriggerProperties: audienceTriggerPropertiesSchema.describe("Properties defining audience targeting and trigger conditions for the feedback form"),
   otherConfigurationProperties: otherConfigurationPropertiesSchema.describe("Additional configuration properties including form display options and translations"),
-  welcomeScreenProperties: welcomeScreenPropertiesSchema.describe("Welcome screen configuration including content and translations"),
-  endScreenProperties: endScreenPropertiesSchema.describe("End screen configuration including content, dismissal behavior, and translations"),
   appearanceProperties: appearancePropertiesSchema.describe("Appearance configuration including themes, colors, and UI feature settings")
-}).describe("Complete schema for all feedback-level properties including scheduling, publishing, audience targeting, configuration, screens, and appearance");
+}).describe("Complete schema for all feedback-level properties including scheduling, publishing, audience targeting, configuration, and appearance");
 
 // src/schemas/fields/other-properties-schema.ts
 import { z as z9 } from "zod";
@@ -1439,12 +1385,6 @@ var fetchFeedbackDetailsResponseSchema = z12.object({
   otherConfigurationProperties: otherConfigurationPropertiesSchema.describe(
     "Other configuration properties using existing schema"
   ),
-  welcomeScreenProperties: welcomeScreenPropertiesSchema.describe(
-    "Welcome screen properties using existing schema"
-  ),
-  endScreenProperties: endScreenPropertiesSchema.describe(
-    "End screen properties using existing schema"
-  ),
   appearanceProperties: appearancePropertiesSchema.describe(
     "Appearance properties including theme configuration"
   )
@@ -1563,8 +1503,6 @@ var appPropsSchema = z14.object({
   otherConfigurationProperties: otherConfigurationPropertiesSchema.describe(
     "Other configuration properties including form display options and translations"
   ),
-  welcomeScreenProperties: welcomeScreenPropertiesSchema.optional().describe("Welcome screen configuration (optional)"),
-  endScreenProperties: endScreenPropertiesSchema.optional().describe("End screen configuration (optional)"),
   translations: translationsSchema.optional().describe(
     "Multi-language translations for questions and form content (optional)"
   ),
@@ -1596,9 +1534,6 @@ export {
   ChoiceOrderOptions,
   CurrentModes,
   DeviceThemes,
-  DismissBehaviors,
-  EndFieldsTranslationSchema,
-  EndScreenFieldsSchema,
   LanguageFieldSchema,
   LanguagesSchema,
   MultipleChoiceDisplayStyles,
@@ -1619,8 +1554,6 @@ export {
   TranslationProvider,
   ValidationRuleTypes,
   VisibilityConditionOperators,
-  WelcomeFieldsTranslationSchema,
-  WelcomeScreenFieldsSchema,
   YesNoDisplayStyles,
   YesNoValues,
   annotationQuestionSchema,
@@ -1643,8 +1576,7 @@ export {
   deviceInfoSchema,
   deviceSessionInfoSchema,
   deviceThemeSchema,
-  dismissBehaviorSchema,
-  endScreenPropertiesSchema,
+  exitFormQuestionSchema,
   externalPublishingPropertiesSchema,
   featureSettingsSchema,
   feedbackConfigurationItemSchema,
@@ -1740,7 +1672,6 @@ export {
   visibilityConditionSchema,
   welcomeQuestionSchema,
   welcomeQuestionTranslationSchema,
-  welcomeScreenPropertiesSchema,
   whoSchema,
   yesNoDisplayStyleSchema,
   yesNoQuestionSchema,