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

package/dist/esm/index.js

@@ -11,7 +11,14 @@ var questionTypeSchema = z.enum([
   "multiple_choice_multiple",
   "short_answer",
   "long_text",
-  "annotation"
+  "annotation",
+  "welcome",
+  "thank_you",
+  "message_panel",
+  "yes_no",
+  "rating_matrix",
+  "matrix_single_choice",
+  "matrix_multiple_choice"
 ]).describe("Enumeration of all supported question types for form fields");
 var QuestionTypes = {
   RATING: "rating",
@@ -21,7 +28,14 @@ var QuestionTypes = {
   MULTIPLE_CHOICE_MULTIPLE: "multiple_choice_multiple",
   SHORT_ANSWER: "short_answer",
   LONG_TEXT: "long_text",
-  ANNOTATION: "annotation"
+  ANNOTATION: "annotation",
+  WELCOME: "welcome",
+  THANK_YOU: "thank_you",
+  MESSAGE_PANEL: "message_panel",
+  YES_NO: "yes_no",
+  RATING_MATRIX: "rating_matrix",
+  MATRIX_SINGLE_CHOICE: "matrix_single_choice",
+  MATRIX_MULTIPLE_CHOICE: "matrix_multiple_choice"
 };
 var validationRuleTypeSchema = z.enum([
   "required",
@@ -139,6 +153,11 @@ var MultipleChoiceMultipleDisplayStyles = {
   LIST: "list",
   CHIP: "chip"
 };
+var yesNoDisplayStyleSchema = z.enum(["horizontal", "vertical"]);
+var YesNoDisplayStyles = {
+  HORIZONTAL: "horizontal",
+  VERTICAL: "vertical"
+};
 var choiceOrderOptionSchema = z.enum([
   "randomize",
   "flip",
@@ -191,6 +210,133 @@ var annotationQuestionSchema = questionSchema.extend({
 }).describe(
   "Schema for annotation questions that provide additional context or instructions"
 );
+var welcomeQuestionSchema = questionSchema.extend({
+  type: z.literal("welcome").describe("Must be exactly 'welcome'"),
+  title: z.string().min(1).max(200).describe("The main heading displayed on the welcome screen"),
+  description: z.string().max(1e3).optional().describe("Optional sub-text body shown below the heading"),
+  buttonLabel: z.string().min(1).max(50).optional().describe("Label for the proceed/start button (e.g. 'Get Started', 'Begin')"),
+  imageUrl: z.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({
+  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"
+  ),
+  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"
+);
+var messagePanelQuestionSchema = questionSchema.extend({
+  type: z.literal("message_panel").describe("Must be exactly 'message_panel'"),
+  title: z.string().min(1).max(200).describe("The main heading displayed on the message panel"),
+  description: z.string().max(1e3).optional().describe("Optional body text shown below the heading"),
+  buttonLabel: z.string().min(1).max(50).optional().describe("Label for the continue button (e.g. 'Continue', 'Next')"),
+  imageUrl: z.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"
+);
+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)"),
+  noLabel: z.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 ratingMatrixDisplayStyleSchema = z.enum([
+  "radio",
+  "star",
+  "emoji",
+  "button"
+]);
+var RatingMatrixDisplayStyles = {
+  RADIO: "radio",
+  STAR: "star",
+  EMOJI: "emoji",
+  BUTTON: "button"
+};
+var ratingMatrixStatementSchema = z.object({
+  id: z.string().describe("Unique identifier for this statement (system time milliseconds)"),
+  value: z.string().min(1).max(100).describe("Internal value / export key for this statement"),
+  label: z.string().min(1).max(200).describe("Display text shown to users for this statement"),
+  describe: z.string().max(500).optional().describe("LLM tool call description for this statement")
+}).describe("Schema for an individual statement (row) in a rating matrix");
+var ratingMatrixScalePointSchema = z.object({
+  id: z.string().describe("Unique identifier for this scale point"),
+  value: z.union([z.number(), z.string()]).describe("Stored response value for this scale point (number or string)"),
+  label: z.string().min(1).max(200).describe("Display label shown for this scale point"),
+  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
+  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")
+  }),
+  // Numerical: 1…N points where N is 2, 3, 4, or 5
+  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")
+  }),
+  // 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)")
+  })
+]).describe("Scale configuration for rating matrix questions");
+var ratingMatrixQuestionSchema = questionSchema.extend({
+  type: z.literal("rating_matrix").describe("Must be exactly 'rating_matrix'"),
+  statements: z.array(ratingMatrixStatementSchema).min(1).max(10).describe("Statements (rows) users will rate on the shared scale (1-10)"),
+  scale: ratingMatrixScaleSchema.describe("Scale configuration shared across all statement rows"),
+  displayStyle: ratingMatrixDisplayStyleSchema.optional().describe(
+    "Visual representation of scale points per row (radio buttons, stars, emoji, or buttons)"
+  ),
+  randomizeStatements: z.boolean().optional().default(false).describe("Whether to randomize the order of statements")
+}).describe("Schema for rating matrix questions with multiple statements on a shared scale");
+var matrixRowSchema = z.object({
+  id: z.string().describe("Unique identifier for this row (system time milliseconds)"),
+  value: z.string().min(1).max(100).describe("Internal value / export key for this row"),
+  label: z.string().min(1).max(200).describe("Display text shown to users for this row"),
+  describe: z.string().max(500).optional().describe("LLM tool call description for this row")
+}).describe("Schema for an individual row in a matrix choice question");
+var matrixColumnSchema = z.object({
+  id: z.string().describe("Unique identifier for this column (system time milliseconds)"),
+  value: z.string().min(1).max(100).describe("Internal value / export key for this column"),
+  label: z.string().min(1).max(200).describe("Display label shown for this column"),
+  describe: z.string().max(500).optional().describe("LLM tool call description for this column")
+}).describe("Schema for an individual column in a matrix choice question");
+var matrixSingleChoiceQuestionSchema = questionSchema.extend({
+  type: z.literal("matrix_single_choice").describe("Must be exactly 'matrix_single_choice'"),
+  rows: z.array(matrixRowSchema).min(1).max(20).describe("Row items (1-20 rows)"),
+  columns: z.array(matrixColumnSchema).min(2).max(10).describe("Column options shared across all rows (2-10 columns)"),
+  randomizeRows: z.boolean().optional().default(false).describe("Whether to randomize the order of rows"),
+  randomizeColumns: z.boolean().optional().default(false).describe("Whether to randomize the order of columns")
+}).describe("Schema for matrix single-choice questions where one column is selected per row");
+var matrixMultipleChoiceQuestionSchema = questionSchema.extend({
+  type: z.literal("matrix_multiple_choice").describe("Must be exactly 'matrix_multiple_choice'"),
+  rows: z.array(matrixRowSchema).min(1).max(20).describe("Row items (1-20 rows)"),
+  columns: z.array(matrixColumnSchema).min(2).max(10).describe("Column options shared across all rows (2-10 columns)"),
+  minSelectionsPerRow: z.number().int().min(0).optional().describe("Minimum number of columns a user must select per row"),
+  maxSelectionsPerRow: z.number().int().min(1).optional().describe("Maximum number of columns a user can select per row"),
+  randomizeRows: z.boolean().optional().default(false).describe("Whether to randomize the order of rows"),
+  randomizeColumns: z.boolean().optional().default(false).describe("Whether to randomize the order of columns")
+}).refine(
+  (data) => {
+    if (data.minSelectionsPerRow !== void 0 && data.maxSelectionsPerRow !== void 0) {
+      return data.minSelectionsPerRow <= data.maxSelectionsPerRow;
+    }
+    return true;
+  },
+  {
+    message: "minSelectionsPerRow cannot be greater than maxSelectionsPerRow",
+    path: ["minSelectionsPerRow"]
+  }
+).describe(
+  "Schema for matrix multiple-choice questions where one or more columns can be selected per row"
+);
 var questionOptionSchema = z.object({
   id: z.string().describe("Unique identifier for this option (system time milliseconds)"),
   value: z.string().min(1).max(100).describe("The internal value used for this option"),
@@ -392,6 +538,13 @@ var nestedDropdownQuestionSchema = questionSchema.extend({
 var combinedQuestionSchema = z.discriminatedUnion("type", [
   ratingQuestionSchema,
   annotationQuestionSchema,
+  welcomeQuestionSchema,
+  thankYouQuestionSchema,
+  messagePanelQuestionSchema,
+  yesNoQuestionSchema,
+  ratingMatrixQuestionSchema,
+  matrixSingleChoiceQuestionSchema,
+  matrixMultipleChoiceQuestionSchema,
   multipleChoiceSingleQuestionSchema,
   multipleChoiceMultipleQuestionSchema,
   npsQuestionSchema,
@@ -421,6 +574,7 @@ var AnswerItemSchema = z2.object({
     "single selected option ID (for single choice questions)"
   ),
   rating: z2.number().optional().describe("Star rating value (e.g., 1-5)"),
+  yesNo: z2.boolean().optional().describe("Yes/no answer for yes_no questions (true = Yes, false = No)"),
   multipleChoiceMultiple: z2.array(z2.string()).optional().describe("Array of selected option IDs for multiple choice questions"),
   singleChoiceOther: z2.string().optional().describe(
     'Free-text "other" answer for single choice questions when allowOther is enabled'
@@ -431,6 +585,15 @@ var AnswerItemSchema = z2.object({
   annotation: AnnotationSchema.optional().describe(
     "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)"
+  ),
+  matrixSingleChoice: z2.record(z2.string(), z2.string()).optional().describe(
+    "Matrix single-choice answers keyed by row id, value is the selected column option id"
+  ),
+  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"
+  ),
   others: z2.string().optional().describe(
     "For multiple choice questions and single choice questions, this is the value of the other option"
   )
@@ -636,6 +799,80 @@ var annotationQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.ex
   annotationText: translationEntrySchema.optional().describe("Annotation display text translation"),
   noAnnotationText: translationEntrySchema.optional().describe("No annotation display text translation")
 }).describe("Translation schema for annotation questions");
+var welcomeQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
+  type: z4.literal("welcome").describe("Question type identifier"),
+  buttonLabel: translationEntrySchema.optional().describe("Translated proceed/start button label")
+}).describe("Translation schema for welcome screen questions");
+var thankYouQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
+  type: z4.literal("thank_you").describe("Question type identifier"),
+  buttonLabel: translationEntrySchema.optional().describe(
+    "Translated dismiss/done button label"
+  )
+}).describe("Translation schema for thank you screen questions");
+var messagePanelQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
+  type: z4.literal("message_panel").describe("Question type identifier"),
+  buttonLabel: translationEntrySchema.optional().describe(
+    "Translated continue/button label"
+  )
+}).describe("Translation schema for message panel questions");
+var yesNoQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
+  type: z4.literal("yes_no").describe("Question type identifier"),
+  yesLabel: translationEntrySchema.optional().describe("Translated Yes label"),
+  noLabel: translationEntrySchema.optional().describe("Translated No label")
+}).describe("Translation schema for yes/no questions");
+var ratingMatrixQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
+  type: z4.literal("rating_matrix").describe("Question type identifier"),
+  minLabel: translationEntrySchema.optional().describe(
+    "Translated scale minimum end label (for likert and numerical kinds)"
+  ),
+  maxLabel: translationEntrySchema.optional().describe(
+    "Translated scale maximum end label (for likert and numerical kinds)"
+  )
+}).catchall(translationEntrySchema).refine(
+  (data) => {
+    const additionalKeys = Object.keys(data).filter(
+      (key) => ![...BASE_QUESTION_TRANSLATION_KEYS, "minLabel", "maxLabel"].includes(
+        key
+      )
+    );
+    return additionalKeys.every(
+      (key) => /^statement\..+\.label$/.test(key) || /^scalePoint\..+\.label$/.test(key)
+    );
+  },
+  {
+    message: "Additional keys must follow 'statement.{id}.label' or 'scalePoint.{id}.label'"
+  }
+).describe("Translation schema for rating matrix questions");
+var matrixSingleChoiceQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
+  type: z4.literal("matrix_single_choice").describe("Question type identifier")
+}).catchall(translationEntrySchema).refine(
+  (data) => {
+    const additionalKeys = Object.keys(data).filter(
+      (key) => !BASE_QUESTION_TRANSLATION_KEYS.includes(key)
+    );
+    return additionalKeys.every(
+      (key) => /^row\..+\.label$/.test(key) || /^column\..+\.label$/.test(key)
+    );
+  },
+  {
+    message: "Additional keys must follow 'row.{id}.label' or 'column.{id}.label'"
+  }
+).describe("Translation schema for matrix single-choice questions");
+var matrixMultipleChoiceQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
+  type: z4.literal("matrix_multiple_choice").describe("Question type identifier")
+}).catchall(translationEntrySchema).refine(
+  (data) => {
+    const additionalKeys = Object.keys(data).filter(
+      (key) => !BASE_QUESTION_TRANSLATION_KEYS.includes(key)
+    );
+    return additionalKeys.every(
+      (key) => /^row\..+\.label$/.test(key) || /^column\..+\.label$/.test(key)
+    );
+  },
+  {
+    message: "Additional keys must follow 'row.{id}.label' or 'column.{id}.label'"
+  }
+).describe("Translation schema for matrix multiple-choice questions");
 var questionTranslationSchema = z4.union([
   ratingQuestionTranslationSchema,
   singleChoiceQuestionTranslationSchema,
@@ -644,7 +881,14 @@ var questionTranslationSchema = z4.union([
   shortAnswerQuestionTranslationSchema,
   longAnswerQuestionTranslationSchema,
   nestedSelectionQuestionTranslationSchema,
-  annotationQuestionTranslationSchema
+  annotationQuestionTranslationSchema,
+  welcomeQuestionTranslationSchema,
+  thankYouQuestionTranslationSchema,
+  messagePanelQuestionTranslationSchema,
+  yesNoQuestionTranslationSchema,
+  ratingMatrixQuestionTranslationSchema,
+  matrixSingleChoiceQuestionTranslationSchema,
+  matrixMultipleChoiceQuestionTranslationSchema
 ]).describe("Union of all question type translation schemas");
 var languageCodeSchema = z4.string().min(2).max(10).describe("Language code (e.g., 'en', 'es', 'hi')");
 var questionTranslationsByLanguageSchema = z4.record(languageCodeSchema, questionTranslationSchema).describe("Question translations keyed by language code");
@@ -834,6 +1078,7 @@ var ShareableModes = {
   DARK: "dark",
   SYSTEM: "system"
 };
+var previousButtonModeSchema = z6.enum(["never", "always", "auto"]).describe("Previous button visibility mode: never, always, or 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"),
@@ -844,7 +1089,10 @@ var featureSettingsSchema = z6.object({
   customCss: z6.string().optional().describe("Custom CSS link to apply for the feedback form"),
   shareableMode: shareableModeSchema.optional().describe(
     "Display mode for the shareable: light, dark, or system preference"
-  )
+  ),
+  allowMultipleQuestionsPerSection: z6.boolean().describe("Whether to allow multiple questions per section"),
+  rtl: z6.boolean().describe("Whether right-to-left text direction is enabled"),
+  previousButton: previousButtonModeSchema.describe("Previous button visibility mode: never, always, or auto")
 }).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)")
@@ -1133,7 +1381,10 @@ var feedbackConfigurationItemSchema = z12.object({
       showBranding: z12.boolean().describe("Whether to show branding"),
       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)")
+      customCss: z12.string().nullable().optional().describe("Custom CSS link (optional)"),
+      allowMultipleQuestionsPerSection: z12.boolean().describe("Whether to allow multiple questions per section"),
+      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")
     }).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")
@@ -1359,6 +1610,7 @@ export {
   QuestionStatuses,
   QuestionTypes,
   RatingDisplayStyles,
+  RatingMatrixDisplayStyles,
   RatingRepresentationSizes,
   RecurringUnits,
   ShareableModes,
@@ -1369,6 +1621,7 @@ export {
   VisibilityConditionOperators,
   WelcomeFieldsTranslationSchema,
   WelcomeScreenFieldsSchema,
+  YesNoDisplayStyles,
   YesNoValues,
   annotationQuestionSchema,
   annotationQuestionTranslationSchema,
@@ -1411,6 +1664,14 @@ export {
   longAnswerQuestionTranslationSchema,
   masterPropertiesSchema,
   matchedTriggerPropertiesSchema,
+  matrixColumnSchema,
+  matrixMultipleChoiceQuestionSchema,
+  matrixMultipleChoiceQuestionTranslationSchema,
+  matrixRowSchema,
+  matrixSingleChoiceQuestionSchema,
+  matrixSingleChoiceQuestionTranslationSchema,
+  messagePanelQuestionSchema,
+  messagePanelQuestionTranslationSchema,
   multipleChoiceDisplayStyleSchema,
   multipleChoiceMultipleDisplayStyleSchema,
   multipleChoiceMultipleQuestionSchema,
@@ -1438,6 +1699,12 @@ export {
   questionTypeSchema,
   questionnaireFieldsResponseSchema,
   ratingDisplayStyleSchema,
+  ratingMatrixDisplayStyleSchema,
+  ratingMatrixQuestionSchema,
+  ratingMatrixQuestionTranslationSchema,
+  ratingMatrixScalePointSchema,
+  ratingMatrixScaleSchema,
+  ratingMatrixStatementSchema,
   ratingQuestionSchema,
   ratingQuestionTranslationSchema,
   ratingRepresentationSizeSchema,
@@ -1454,6 +1721,8 @@ export {
   singleChoiceQuestionTranslationSchema,
   submitFeedbackSchema,
   surveyTypeSchema,
+  thankYouQuestionSchema,
+  thankYouQuestionTranslationSchema,
   themeColorsSchema,
   themeConfigurationSchema,
   themeModeSchema,
@@ -1469,8 +1738,13 @@ export {
   validationRuleSchema,
   validationRuleTypeSchema,
   visibilityConditionSchema,
+  welcomeQuestionSchema,
+  welcomeQuestionTranslationSchema,
   welcomeScreenPropertiesSchema,
   whoSchema,
+  yesNoDisplayStyleSchema,
+  yesNoQuestionSchema,
+  yesNoQuestionTranslationSchema,
   yesNoSchema,
   z15 as z
 };