@encatch/schema 1.2.0-beta.1 → 1.2.0-beta.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/esm/index.js CHANGED
@@ -11,7 +11,9 @@ var baseQuestionTranslationFieldsSchema = z.object({
11
11
  title: translationEntrySchema.describe("Question title translation"),
12
12
  description: translationEntrySchema.optional().describe("Question description translation"),
13
13
  errorMessage: translationEntrySchema.optional().describe("Error message translation"),
14
- nextButtonLabel: translationEntrySchema.max(50).optional().describe("Next button label translation when advancing past this question")
14
+ nextButtonLabel: translationEntrySchema.max(50).optional().describe(
15
+ "Next button label translation when advancing past this question"
16
+ )
15
17
  });
16
18
  var BASE_QUESTION_TRANSLATION_KEYS = [
17
19
  "type",
@@ -33,9 +35,13 @@ var singleChoiceQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.
33
35
  const additionalKeys = Object.keys(data).filter(
34
36
  (key) => ![...BASE_QUESTION_TRANSLATION_KEYS, "placeholder"].includes(key)
35
37
  );
36
- return additionalKeys.every((key) => /^option\..+\.(label|value)$/.test(key));
38
+ return additionalKeys.every(
39
+ (key) => /^option\..+\.(label|value)$/.test(key)
40
+ );
37
41
  },
38
- { message: "Additional keys must follow the pattern 'option.{id}.{label|value}'" }
42
+ {
43
+ message: "Additional keys must follow the pattern 'option.{id}.{label|value}'"
44
+ }
39
45
  ).describe("Translation schema for single choice questions");
40
46
  var multipleChoiceQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
41
47
  type: z.literal("multiple_choice_multiple").describe("Question type identifier"),
@@ -45,9 +51,13 @@ var multipleChoiceQuestionTranslationSchema = baseQuestionTranslationFieldsSchem
45
51
  const additionalKeys = Object.keys(data).filter(
46
52
  (key) => ![...BASE_QUESTION_TRANSLATION_KEYS, "placeholder"].includes(key)
47
53
  );
48
- return additionalKeys.every((key) => /^option\..+\.(label|value)$/.test(key));
54
+ return additionalKeys.every(
55
+ (key) => /^option\..+\.(label|value)$/.test(key)
56
+ );
49
57
  },
50
- { message: "Additional keys must follow the pattern 'option.{id}.{label|value}'" }
58
+ {
59
+ message: "Additional keys must follow the pattern 'option.{id}.{label|value}'"
60
+ }
51
61
  ).describe("Translation schema for multiple choice questions");
52
62
  var npsQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
53
63
  type: z.literal("nps").describe("Question type identifier"),
@@ -56,11 +66,15 @@ var npsQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
56
66
  }).catchall(translationEntrySchema).refine(
57
67
  (data) => {
58
68
  const additionalKeys = Object.keys(data).filter(
59
- (key) => ![...BASE_QUESTION_TRANSLATION_KEYS, "minLabel", "maxLabel"].includes(key)
69
+ (key) => ![...BASE_QUESTION_TRANSLATION_KEYS, "minLabel", "maxLabel"].includes(
70
+ key
71
+ )
60
72
  );
61
73
  return additionalKeys.every((key) => /^scaleLabel\.\d+$/.test(key));
62
74
  },
63
- { message: "Additional keys must follow the pattern 'scaleLabel.{number}'" }
75
+ {
76
+ message: "Additional keys must follow the pattern 'scaleLabel.{number}'"
77
+ }
64
78
  ).describe("Translation schema for NPS questions");
65
79
  var shortAnswerQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
66
80
  type: z.literal("short_answer").describe("Question type identifier"),
@@ -70,6 +84,61 @@ var longAnswerQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.ex
70
84
  type: z.literal("long_text").describe("Question type identifier"),
71
85
  placeholder: translationEntrySchema.optional().describe("Textarea placeholder translation")
72
86
  }).describe("Translation schema for long answer questions");
87
+ var videoAudioQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
88
+ type: z.literal("video_audio").describe("Question type identifier"),
89
+ placeholder: translationEntrySchema.optional().describe("Placeholder for text/photo hints"),
90
+ modeTabLabelVideo: z.string().max(80).optional().describe("Translated tab label for video mode"),
91
+ modeTabLabelAudio: z.string().max(80).optional().describe("Translated tab label for audio mode"),
92
+ modeTabLabelPhoto: z.string().max(80).optional().describe("Translated tab label for photo mode"),
93
+ modeTabLabelText: z.string().max(80).optional().describe("Translated tab label for text mode"),
94
+ recordButtonLabel: z.string().max(80).optional().describe("Translated Record button label"),
95
+ uploadMediaButtonLabel: z.string().max(80).optional().describe("Translated upload button (video/audio)"),
96
+ videoIdleHint: z.string().max(200).optional().describe("Translated video idle overlay hint"),
97
+ photoEmptyHint: z.string().max(200).optional().describe("Translated empty photo area hint"),
98
+ photoUseCameraButtonLabel: z.string().max(80).optional().describe("Translated Use camera button"),
99
+ photoUploadImageButtonLabel: z.string().max(80).optional().describe("Translated Upload image button")
100
+ }).describe("Translation schema for video/audio/photo/text questions");
101
+ var dateQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
102
+ type: z.literal("date").describe("Question type identifier"),
103
+ placeholder: translationEntrySchema.optional().describe("Placeholder for the date field"),
104
+ segmentLabelDD: z.string().max(40).optional().describe("Label above the day digits"),
105
+ segmentLabelMM: z.string().max(40).optional().describe("Label above the month digits"),
106
+ segmentLabelYYYY: z.string().max(40).optional().describe("Label above the year digits")
107
+ }).describe("Translation schema for date questions");
108
+ var signatureQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
109
+ type: z.literal("signature").describe("Question type identifier"),
110
+ clearButtonLabel: z.string().max(50).optional().describe("Translated clear button in draw mode"),
111
+ placeholder: z.string().max(200).optional().describe("Shared fallback for draw/upload hints"),
112
+ modeTabLabelType: z.string().max(80).optional().describe("Translated Type tab label"),
113
+ modeTabLabelDraw: z.string().max(80).optional().describe("Translated Draw tab label"),
114
+ modeTabLabelUpload: z.string().max(80).optional().describe("Translated Upload tab label"),
115
+ drawCanvasHint: z.string().max(200).optional().describe("Translated empty-canvas hint"),
116
+ uploadZonePrimary: z.string().max(200).optional().describe("Translated idle upload prompt"),
117
+ uploadZoneDrag: z.string().max(120).optional().describe("Translated drag-over upload prompt")
118
+ }).describe("Translation schema for signature questions");
119
+ var schedulerQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
120
+ type: z.literal("scheduler").describe("Question type identifier"),
121
+ placeholder: z.string().max(200).optional().describe(
122
+ "Fallback for meeting CTA when scheduleMeetingLabel is unset"
123
+ ),
124
+ scheduleMeetingLabel: z.string().max(200).optional().describe("Book-a-meeting button and modal label")
125
+ }).describe("Translation schema for scheduler questions");
126
+ var qnaWithAiQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
127
+ type: z.literal("qna_with_ai").describe("Question type identifier"),
128
+ placeholder: z.string().max(200).optional().describe("Input placeholder for the question field"),
129
+ askButtonLabel: z.string().max(50).optional().describe("Ask / submit control label"),
130
+ emptyStateHint: z.string().max(200).optional().describe("Empty chat area hint"),
131
+ pairsRemainingTemplate: z.string().max(160).optional().describe("Under-limit counter; tokens {remaining} and {max}"),
132
+ pairsLimitReachedTemplate: z.string().max(160).optional().describe("At-limit message; token {max}")
133
+ }).describe("Translation schema for Q&A with AI questions");
134
+ var paymentsUpiQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
135
+ type: z.literal("payments_upi").describe("Question type identifier"),
136
+ qrLabel: z.string().max(100).optional().describe("Label shown above the UPI QR code"),
137
+ openUpiAppLabel: z.string().max(80).optional().describe("UPI intent button label"),
138
+ copyUpiIdLabel: z.string().max(80).optional().describe("Copy UPI ID button label"),
139
+ transactionIdLabel: z.string().max(100).optional().describe("Transaction ID / UTR input label"),
140
+ transactionIdPlaceholder: z.string().max(120).optional().describe("Transaction ID / UTR input placeholder")
141
+ }).describe("Translation schema for payments_upi questions");
73
142
  var nestedSelectionQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
74
143
  type: z.literal("nested_selection").describe("Question type identifier"),
75
144
  placeholder: translationEntrySchema.optional().describe("Dropdown placeholder translation")
@@ -78,9 +147,13 @@ var nestedSelectionQuestionTranslationSchema = baseQuestionTranslationFieldsSche
78
147
  const additionalKeys = Object.keys(data).filter(
79
148
  (key) => ![...BASE_QUESTION_TRANSLATION_KEYS, "placeholder"].includes(key)
80
149
  );
81
- return additionalKeys.every((key) => /^nestedOption\..+\.(label|hint)$/.test(key));
150
+ return additionalKeys.every(
151
+ (key) => /^nestedOption\..+\.(label|hint)$/.test(key)
152
+ );
82
153
  },
83
- { message: "Additional keys must follow the pattern 'nestedOption.{id}.{label|hint}'" }
154
+ {
155
+ message: "Additional keys must follow the pattern 'nestedOption.{id}.{label|hint}'"
156
+ }
84
157
  ).describe("Translation schema for nested selection questions");
85
158
  var annotationQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
86
159
  type: z.literal("annotation").describe("Question type identifier"),
@@ -98,7 +171,9 @@ var messagePanelQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.
98
171
  }).describe("Translation schema for message panel questions");
99
172
  var consentQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
100
173
  type: z.literal("consent").describe("Question type identifier")
101
- }).describe("Translation schema for consent questions; description carries the translated checkbox label (markdown supported)");
174
+ }).describe(
175
+ "Translation schema for consent questions; description carries the translated checkbox label (markdown supported)"
176
+ );
102
177
  var yesNoQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
103
178
  type: z.literal("yes_no").describe("Question type identifier"),
104
179
  yesLabel: translationEntrySchema.optional().describe("Translated Yes label"),
@@ -115,9 +190,11 @@ var ratingMatrixQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.
115
190
  }).catchall(translationEntrySchema).refine(
116
191
  (data) => {
117
192
  const additionalKeys = Object.keys(data).filter(
118
- (key) => ![...BASE_QUESTION_TRANSLATION_KEYS, "minLabel", "maxLabel"].includes(
119
- key
120
- )
193
+ (key) => ![
194
+ ...BASE_QUESTION_TRANSLATION_KEYS,
195
+ "minLabel",
196
+ "maxLabel"
197
+ ].includes(key)
121
198
  );
122
199
  return additionalKeys.every(
123
200
  (key) => /^statement\..+\.label$/.test(key) || /^scalePoint\..+\.label$/.test(key)
@@ -164,6 +241,12 @@ var questionTranslationSchema = z.union([
164
241
  npsQuestionTranslationSchema,
165
242
  shortAnswerQuestionTranslationSchema,
166
243
  longAnswerQuestionTranslationSchema,
244
+ videoAudioQuestionTranslationSchema,
245
+ dateQuestionTranslationSchema,
246
+ signatureQuestionTranslationSchema,
247
+ schedulerQuestionTranslationSchema,
248
+ qnaWithAiQuestionTranslationSchema,
249
+ paymentsUpiQuestionTranslationSchema,
167
250
  nestedSelectionQuestionTranslationSchema,
168
251
  annotationQuestionTranslationSchema,
169
252
  welcomeQuestionTranslationSchema,
@@ -183,8 +266,12 @@ var sectionTranslationSchema = z.object({
183
266
  }).describe("Translation payload for a section in a single language");
184
267
  var sectionTranslationsByLanguageSchema = z.record(languageCodeSchema, sectionTranslationSchema).describe("Section translations keyed by language code");
185
268
  var questionTranslationsByLanguageSchema = z.record(languageCodeSchema, questionTranslationSchema).describe("Question translations keyed by language code");
186
- var questionCentricTranslationsSchema = z.record(z.string().uuid(), questionTranslationsByLanguageSchema).describe("Question-centric translations keyed by question ID, then by language code");
187
- var translationsSchema = questionCentricTranslationsSchema.describe("Question-centric translations at root level");
269
+ var questionCentricTranslationsSchema = z.record(z.string().uuid(), questionTranslationsByLanguageSchema).describe(
270
+ "Question-centric translations keyed by question ID, then by language code"
271
+ );
272
+ var translationsSchema = questionCentricTranslationsSchema.describe(
273
+ "Question-centric translations at root level"
274
+ );
188
275
  var _TranslationProvider = class _TranslationProvider {
189
276
  constructor(translations, defaultLanguage = "en") {
190
277
  this.translations = translations;
@@ -206,7 +293,10 @@ var _TranslationProvider = class _TranslationProvider {
206
293
  * Get a specific translation text by field path
207
294
  */
208
295
  getTranslationText(questionId, languageCode, fieldPath) {
209
- const questionTranslation = this.getQuestionTranslations(questionId, languageCode);
296
+ const questionTranslation = this.getQuestionTranslations(
297
+ questionId,
298
+ languageCode
299
+ );
210
300
  if (!questionTranslation) return null;
211
301
  if (fieldPath in questionTranslation) {
212
302
  const value = questionTranslation[fieldPath];
@@ -309,7 +399,8 @@ var questionTypeSchema = z2.enum([
309
399
  "address",
310
400
  "video_audio",
311
401
  "scheduler",
312
- "qna_with_ai"
402
+ "qna_with_ai",
403
+ "payments_upi"
313
404
  ]).describe("Enumeration of all supported question types for form fields");
314
405
  var QuestionTypes = {
315
406
  RATING: "rating",
@@ -343,7 +434,8 @@ var QuestionTypes = {
343
434
  ADDRESS: "address",
344
435
  VIDEO_AUDIO: "video_audio",
345
436
  SCHEDULER: "scheduler",
346
- QNA_WITH_AI: "qna_with_ai"
437
+ QNA_WITH_AI: "qna_with_ai",
438
+ PAYMENTS_UPI: "payments_upi"
347
439
  };
348
440
  var validationRuleTypeSchema = z2.enum([
349
441
  "required",
@@ -395,7 +487,9 @@ var VisibilityConditionOperators = {
395
487
  };
396
488
  var visibilityConditionSchema = z2.object({
397
489
  field: z2.string().describe("ID of the field to check against"),
398
- operator: visibilityConditionOperatorSchema.describe("Comparison operator for the condition"),
490
+ operator: visibilityConditionOperatorSchema.describe(
491
+ "Comparison operator for the condition"
492
+ ),
399
493
  value: z2.union([z2.string(), z2.number(), z2.boolean()]).optional().describe("Value to compare against (string, number, or boolean)"),
400
494
  describe: z2.string().max(500).optional().describe("LLM tool call description for this visibility condition")
401
495
  }).describe(
@@ -418,7 +512,9 @@ var sectionSchema = z2.object({
418
512
  "When the global previousButton mode is 'auto', controls whether the Previous button is shown for this section. Defaults to false (hidden)."
419
513
  ),
420
514
  questionIds: z2.array(z2.string()).min(1).describe("Array of question IDs that belong to this section")
421
- }).describe("Schema defining sections that organize questions into logical groups");
515
+ }).describe(
516
+ "Schema defining sections that organize questions into logical groups"
517
+ );
422
518
  var questionStatusSchema = z2.enum(["D", "P", "A", "S"]);
423
519
  var QuestionStatuses = {
424
520
  DRAFT: "D",
@@ -525,7 +621,13 @@ var questionSchema = z2.object({
525
621
  nextButtonLabel: z2.string().min(1).max(50).default("Next").describe(
526
622
  "Label for the next button when advancing past this question (overrides section or form defaults when set)"
527
623
  ),
528
- showQuestionTitle: z2.boolean().default(true).describe("Whether to display the question title; defaults to true")
624
+ showQuestionTitle: z2.boolean().default(true).describe("Whether to display the question title; defaults to true"),
625
+ questionMediaUrl: z2.string().url().optional().describe(
626
+ "Optional URL for media (image or video) displayed alongside the question"
627
+ ),
628
+ questionMediaType: z2.enum(["image", "video", "youtube", "vimeo"]).optional().describe(
629
+ "Type of media referenced by questionMediaUrl; one of 'image', 'video', 'youtube', or 'vimeo'"
630
+ )
529
631
  }).describe("Base schema for all question types with common properties");
530
632
  var ratingQuestionSchema = questionSchema.extend({
531
633
  type: z2.literal("rating").describe("Must be exactly 'rating'"),
@@ -549,7 +651,9 @@ var welcomeQuestionSchema = questionSchema.extend({
549
651
  title: z2.string().min(1).max(200).describe("The main heading displayed on the welcome screen"),
550
652
  description: z2.string().max(1e3).optional().describe("Optional sub-text body shown below the heading"),
551
653
  imageUrl: z2.string().url().optional().describe("Optional image URL displayed on the welcome screen")
552
- }).describe("Schema for a welcome screen displayed at the start or inline within a form");
654
+ }).describe(
655
+ "Schema for a welcome screen displayed at the start or inline within a form"
656
+ );
553
657
  var thankYouQuestionSchema = questionSchema.extend({
554
658
  type: z2.literal("thank_you").describe("Must be exactly 'thank_you'"),
555
659
  title: z2.string().min(1).max(200).describe("The main heading displayed on the thank you screen"),
@@ -575,10 +679,18 @@ var exitFormQuestionSchema = questionSchema.extend({
575
679
  );
576
680
  var yesNoQuestionSchema = questionSchema.extend({
577
681
  type: z2.literal("yes_no").describe("Must be exactly 'yes_no'"),
578
- yesLabel: z2.string().min(1).max(50).optional().describe("Label for the Yes option (defaults to 'Yes' in the UI if omitted)"),
579
- noLabel: z2.string().min(1).max(50).optional().describe("Label for the No option (defaults to 'No' in the UI if omitted)"),
580
- displayStyle: yesNoDisplayStyleSchema.optional().describe("Layout for the Yes/No controls (horizontal row or vertical stack)")
581
- }).describe("Schema for yes/no questions with optional custom labels and layout");
682
+ yesLabel: z2.string().min(1).max(50).optional().describe(
683
+ "Label for the Yes option (defaults to 'Yes' in the UI if omitted)"
684
+ ),
685
+ noLabel: z2.string().min(1).max(50).optional().describe(
686
+ "Label for the No option (defaults to 'No' in the UI if omitted)"
687
+ ),
688
+ displayStyle: yesNoDisplayStyleSchema.optional().describe(
689
+ "Layout for the Yes/No controls (horizontal row or vertical stack)"
690
+ )
691
+ }).describe(
692
+ "Schema for yes/no questions with optional custom labels and layout"
693
+ );
582
694
  var consentQuestionSchema = questionSchema.extend({
583
695
  type: z2.literal("consent").describe("Must be exactly 'consent'")
584
696
  }).describe(
@@ -597,14 +709,18 @@ var RatingMatrixDisplayStyles = {
597
709
  BUTTON: "button"
598
710
  };
599
711
  var ratingMatrixStatementSchema = z2.object({
600
- id: z2.string().describe("Unique identifier for this statement (system time milliseconds)"),
712
+ id: z2.string().describe(
713
+ "Unique identifier for this statement (system time milliseconds)"
714
+ ),
601
715
  value: z2.string().min(1).max(100).describe("Internal value / export key for this statement"),
602
716
  label: z2.string().min(1).max(200).describe("Display text shown to users for this statement"),
603
717
  describe: z2.string().max(500).optional().describe("LLM tool call description for this statement")
604
718
  }).describe("Schema for an individual statement (row) in a rating matrix");
605
719
  var ratingMatrixScalePointSchema = z2.object({
606
720
  id: z2.string().describe("Unique identifier for this scale point"),
607
- value: z2.union([z2.number(), z2.string()]).describe("Stored response value for this scale point (number or string)"),
721
+ value: z2.union([z2.number(), z2.string()]).describe(
722
+ "Stored response value for this scale point (number or string)"
723
+ ),
608
724
  label: z2.string().min(1).max(200).describe("Display label shown for this scale point"),
609
725
  describe: z2.string().max(500).optional().describe("LLM tool call description for this scale point")
610
726
  }).describe("Schema for a single point on a custom rating scale");
@@ -629,12 +745,16 @@ var ratingMatrixScaleSchema = z2.discriminatedUnion("kind", [
629
745
  var ratingMatrixQuestionSchema = questionSchema.extend({
630
746
  type: z2.literal("rating_matrix").describe("Must be exactly 'rating_matrix'"),
631
747
  statements: z2.array(ratingMatrixStatementSchema).min(1).max(10).describe("Statements (rows) users will rate on the shared scale (1-10)"),
632
- scale: ratingMatrixScaleSchema.describe("Scale configuration shared across all statement rows"),
748
+ scale: ratingMatrixScaleSchema.describe(
749
+ "Scale configuration shared across all statement rows"
750
+ ),
633
751
  displayStyle: ratingMatrixDisplayStyleSchema.optional().describe(
634
752
  "Visual representation of scale points per row (radio buttons, stars, emoji, or buttons)"
635
753
  ),
636
754
  randomizeStatements: z2.boolean().optional().default(false).describe("Whether to randomize the order of statements")
637
- }).describe("Schema for rating matrix questions with multiple statements on a shared scale");
755
+ }).describe(
756
+ "Schema for rating matrix questions with multiple statements on a shared scale"
757
+ );
638
758
  var matrixRowSchema = z2.object({
639
759
  id: z2.string().describe("Unique identifier for this row (system time milliseconds)"),
640
760
  value: z2.string().min(1).max(100).describe("Internal value / export key for this row"),
@@ -653,7 +773,9 @@ var matrixSingleChoiceQuestionSchema = questionSchema.extend({
653
773
  columns: z2.array(matrixColumnSchema).min(2).max(10).describe("Column options shared across all rows (2-10 columns)"),
654
774
  randomizeRows: z2.boolean().optional().default(false).describe("Whether to randomize the order of rows"),
655
775
  randomizeColumns: z2.boolean().optional().default(false).describe("Whether to randomize the order of columns")
656
- }).describe("Schema for matrix single-choice questions where one column is selected per row");
776
+ }).describe(
777
+ "Schema for matrix single-choice questions where one column is selected per row"
778
+ );
657
779
  var matrixMultipleChoiceQuestionSchema = questionSchema.extend({
658
780
  type: z2.literal("matrix_multiple_choice").describe("Must be exactly 'matrix_multiple_choice'"),
659
781
  rows: z2.array(matrixRowSchema).min(1).max(20).describe("Row items (1-20 rows)"),
@@ -680,7 +802,9 @@ var questionOptionSchema = z2.object({
680
802
  id: z2.string().describe("Unique identifier for this option (system time milliseconds)"),
681
803
  value: z2.string().min(1).max(100).describe("The internal value used for this option"),
682
804
  label: z2.string().min(1).max(200).describe("The display text shown to users for this option"),
683
- hint: z2.string().max(300).optional().describe("Optional short description shown below the option label to help respondents understand what they are selecting or ranking"),
805
+ hint: z2.string().max(300).optional().describe(
806
+ "Optional short description shown below the option label to help respondents understand what they are selecting or ranking"
807
+ ),
684
808
  describe: z2.string().max(500).optional().describe(
685
809
  "LLM tool call description providing context about this option"
686
810
  ),
@@ -688,7 +812,9 @@ var questionOptionSchema = z2.object({
688
812
  }).describe("Schema for individual options in choice-based questions");
689
813
  var nestedOptionSchema = z2.lazy(
690
814
  () => z2.object({
691
- id: z2.string().describe("Unique identifier for this nested option (system time milliseconds)"),
815
+ id: z2.string().describe(
816
+ "Unique identifier for this nested option (system time milliseconds)"
817
+ ),
692
818
  value: z2.string().min(1).max(100).describe("The internal value used for this nested option"),
693
819
  label: z2.string().min(1).max(200).describe("The display text shown for this nested option"),
694
820
  describe: z2.string().max(500).optional().describe("LLM tool call description for this nested option context"),
@@ -707,7 +833,9 @@ var multipleChoiceSingleQuestionSchema = questionSchema.extend({
707
833
  minChars: z2.number().int().min(0).optional().describe("Minimum number of characters required for the other text"),
708
834
  maxChars: z2.number().int().min(1).optional().describe("Maximum number of characters allowed for the other text"),
709
835
  placeholder: z2.string().max(200).optional().describe("Placeholder text for the other text input"),
710
- showLimitIndicatorThreshold: z2.number().int().min(0).optional().describe("Show the character limit indicator (e.g. '12/100') once the user has typed this many characters; 0 = show immediately, absent = never show")
836
+ showLimitIndicatorThreshold: z2.number().int().min(0).optional().describe(
837
+ "Show the character limit indicator (e.g. '12/100') once the user has typed this many characters; 0 = show immediately, absent = never show"
838
+ )
711
839
  }).optional().describe('Configuration for the custom "other" text input'),
712
840
  randomizeOptions: z2.boolean().optional().default(false).describe("Whether to randomize the order of options"),
713
841
  options: z2.array(questionOptionSchema).min(1).max(50).describe("Array of options for user selection (1-50 options)")
@@ -720,7 +848,9 @@ var multipleChoiceMultipleQuestionSchema = questionSchema.extend({
720
848
  minChars: z2.number().int().min(0).optional().describe("Minimum number of characters required for the other text"),
721
849
  maxChars: z2.number().int().min(1).optional().describe("Maximum number of characters allowed for the other text"),
722
850
  placeholder: z2.string().max(200).optional().describe("Placeholder text for the other text input"),
723
- showLimitIndicatorThreshold: z2.number().int().min(0).optional().describe("Show the character limit indicator (e.g. '12/100') once the user has typed this many characters; 0 = show immediately, absent = never show")
851
+ showLimitIndicatorThreshold: z2.number().int().min(0).optional().describe(
852
+ "Show the character limit indicator (e.g. '12/100') once the user has typed this many characters; 0 = show immediately, absent = never show"
853
+ )
724
854
  }).optional().describe('Configuration for the custom "other" text input'),
725
855
  minSelections: z2.number().int().min(0).optional().describe("Minimum number of options that must be selected"),
726
856
  maxSelections: z2.number().int().min(1).optional().describe("Maximum number of options that can be selected"),
@@ -749,9 +879,15 @@ var npsQuestionSchema = questionSchema.extend({
749
879
  maxLabel: z2.string().max(100).optional().describe("Label for the maximum NPS value (10)"),
750
880
  scaleLabels: z2.record(z2.string().regex(/^\d+$/), z2.string().max(50)).optional().describe("Custom labels for specific NPS values (0-10)"),
751
881
  prepopulatedValue: z2.number().int().min(0).max(10).optional().describe("Default value to pre-select (0-10)"),
752
- detractorColor: z2.string().max(50).optional().describe("Color applied to detractor scores (0\u20136); accepts any valid CSS color value (hex, rgb, hsl, named)"),
753
- passiveColor: z2.string().max(50).optional().describe("Color applied to passive scores (7\u20138); accepts any valid CSS color value"),
754
- promoterColor: z2.string().max(50).optional().describe("Color applied to promoter scores (9\u201310); accepts any valid CSS color value")
882
+ detractorColor: z2.string().max(50).optional().describe(
883
+ "Color applied to detractor scores (0\u20136); accepts any valid CSS color value (hex, rgb, hsl, named)"
884
+ ),
885
+ passiveColor: z2.string().max(50).optional().describe(
886
+ "Color applied to passive scores (7\u20138); accepts any valid CSS color value"
887
+ ),
888
+ promoterColor: z2.string().max(50).optional().describe(
889
+ "Color applied to promoter scores (9\u201310); accepts any valid CSS color value"
890
+ )
755
891
  }).refine(
756
892
  (data) => {
757
893
  if (data.scaleLabels) {
@@ -772,7 +908,9 @@ var shortAnswerQuestionSchema = questionSchema.extend({
772
908
  type: z2.literal("short_answer").describe("Must be exactly 'short_answer'"),
773
909
  maxCharacters: z2.number().int().min(1).max(1e4).optional().describe("Maximum number of characters allowed"),
774
910
  minCharacters: z2.number().int().min(0).optional().describe("Minimum number of characters required"),
775
- showLimitIndicatorThreshold: z2.number().int().min(0).optional().describe("Show the character limit indicator (e.g. '12/100') once the user has typed this many characters; 0 = show immediately, absent = never show"),
911
+ showLimitIndicatorThreshold: z2.number().int().min(0).optional().describe(
912
+ "Show the character limit indicator (e.g. '12/100') once the user has typed this many characters; 0 = show immediately, absent = never show"
913
+ ),
776
914
  placeholder: z2.string().max(200).optional().describe("Placeholder text shown in the input field"),
777
915
  enableRegexValidation: z2.boolean().optional().default(false).describe("Whether to enable regex pattern validation"),
778
916
  regexPattern: z2.string().optional().describe("Regular expression pattern for validation"),
@@ -820,7 +958,9 @@ var longAnswerQuestionSchema = questionSchema.extend({
820
958
  "Maximum number of characters allowed (higher limit for long text)"
821
959
  ),
822
960
  minCharacters: z2.number().int().min(0).optional().describe("Minimum number of characters required"),
823
- showLimitIndicatorThreshold: z2.number().int().min(0).optional().describe("Show the character limit indicator (e.g. '12/100') once the user has typed this many characters; 0 = show immediately, absent = never show"),
961
+ showLimitIndicatorThreshold: z2.number().int().min(0).optional().describe(
962
+ "Show the character limit indicator (e.g. '12/100') once the user has typed this many characters; 0 = show immediately, absent = never show"
963
+ ),
824
964
  rows: z2.number().int().min(1).max(20).optional().describe("Number of textarea rows to display (1-20)"),
825
965
  placeholder: z2.string().max(500).optional().describe("Placeholder text for the textarea (longer for long text)"),
826
966
  enableEnhanceWithAi: z2.boolean().optional().default(false).describe("Whether to enable AI enhancement features"),
@@ -903,11 +1043,24 @@ var dateQuestionSchema = questionSchema.extend({
903
1043
  format: dateFormatSchema.optional().default("DD/MM/YYYY").describe("Order of day, month, and year segments in the input"),
904
1044
  separator: dateSeparatorSchema.optional().default("/").describe("Character used to separate day, month, and year segments"),
905
1045
  includeTime: z2.boolean().optional().default(false).describe("Whether to also collect a time (HH:MM) alongside the date"),
906
- minDate: z2.string().optional().describe("Earliest allowed date in ISO 8601 format (YYYY-MM-DD); when absent no lower bound is enforced"),
907
- maxDate: z2.string().optional().describe("Latest allowed date in ISO 8601 format (YYYY-MM-DD); when absent no upper bound is enforced"),
1046
+ minDate: z2.string().optional().describe(
1047
+ "Earliest allowed date in ISO 8601 format (YYYY-MM-DD); when absent no lower bound is enforced"
1048
+ ),
1049
+ maxDate: z2.string().optional().describe(
1050
+ "Latest allowed date in ISO 8601 format (YYYY-MM-DD); when absent no upper bound is enforced"
1051
+ ),
908
1052
  placeholder: z2.string().max(50).optional().describe("Placeholder text shown in the date input"),
909
- prepopulatedValue: z2.string().optional().describe("Default date value in ISO 8601 format (YYYY-MM-DD) to pre-fill the input")
910
- }).describe("Schema for a date question that collects a structured date (and optionally time) from the respondent");
1053
+ segmentLabelDD: z2.string().max(40).optional().describe(
1054
+ "Visible label above the day segment; when absent a locale default is used"
1055
+ ),
1056
+ segmentLabelMM: z2.string().max(40).optional().describe("Visible label above the month segment"),
1057
+ segmentLabelYYYY: z2.string().max(40).optional().describe("Visible label above the year segment"),
1058
+ prepopulatedValue: z2.string().optional().describe(
1059
+ "Default date value in ISO 8601 format (YYYY-MM-DD) to pre-fill the input"
1060
+ )
1061
+ }).describe(
1062
+ "Schema for a date question that collects a structured date (and optionally time) from the respondent"
1063
+ );
911
1064
  var csatScaleSchema = z2.union([
912
1065
  z2.literal(2),
913
1066
  z2.literal(3),
@@ -927,23 +1080,53 @@ var CsatDisplayStyles = {
927
1080
  };
928
1081
  var csatQuestionSchema = questionSchema.extend({
929
1082
  type: z2.literal("csat").describe("Must be exactly 'csat'"),
930
- scale: csatScaleSchema.optional().default(5).describe("Number of response points (2\u20135); 2 and 4 have no neutral option, default is 5"),
931
- displayStyle: csatDisplayStyleSchema.optional().default("emoji").describe("How response options are rendered \u2014 emoji faces (default) or text buttons"),
932
- multicolor: z2.boolean().optional().default(false).describe("Whether to apply distinct colors to negative, neutral, and positive segments"),
933
- negativeColor: z2.string().max(50).optional().describe("Color for negative response options (semantic values -2, -1); any valid CSS color; used when multicolor is true"),
934
- neutralColor: z2.string().max(50).optional().describe("Color for the neutral response option (semantic value 0); any valid CSS color; used when multicolor is true"),
935
- positiveColor: z2.string().max(50).optional().describe("Color for positive response options (semantic values 1, 2); any valid CSS color; used when multicolor is true"),
936
- showLabels: z2.boolean().optional().default(false).describe("Whether to render per-point labels below each response option"),
937
- scaleLabels: z2.record(z2.string(), z2.string().max(100)).optional().describe("Per-point label text keyed by semantic value string ('-2', '-1', '0', '1', '2')")
938
- }).describe("Schema for a CSAT (Customer Satisfaction Score) question using a 2\u20135 point semantic scale");
1083
+ scale: csatScaleSchema.optional().default(5).describe(
1084
+ "Number of response points (2\u20135); 2 and 4 have no neutral option, default is 5"
1085
+ ),
1086
+ displayStyle: csatDisplayStyleSchema.optional().default("emoji").describe(
1087
+ "How response options are rendered \u2014 emoji faces (default) or text buttons"
1088
+ ),
1089
+ multicolor: z2.boolean().optional().default(false).describe(
1090
+ "Whether to apply distinct colors to negative, neutral, and positive segments"
1091
+ ),
1092
+ negativeColor: z2.string().max(50).optional().describe(
1093
+ "Color for negative response options (lower half of scale); any valid CSS color; used when multicolor is true"
1094
+ ),
1095
+ neutralColor: z2.string().max(50).optional().describe(
1096
+ "Color for the neutral midpoint option (odd scales only: scale 3 = value 2, scale 5 = value 3); any valid CSS color; used when multicolor is true"
1097
+ ),
1098
+ positiveColor: z2.string().max(50).optional().describe(
1099
+ "Color for positive response options (upper half of scale); any valid CSS color; used when multicolor is true"
1100
+ ),
1101
+ showLabels: z2.boolean().optional().default(false).describe(
1102
+ "Whether to render per-point labels below each response option"
1103
+ ),
1104
+ scaleLabels: z2.record(z2.string(), z2.string().max(100)).optional().describe(
1105
+ "Per-point label text keyed by value string ('1'\u2013'5'); keys must match the chosen scale size"
1106
+ )
1107
+ }).describe(
1108
+ "Schema for a CSAT (Customer Satisfaction Score) question using an industry-standard 1-to-N positive scale (N = 2\u20135)"
1109
+ );
939
1110
  var opinionScaleQuestionSchema = questionSchema.extend({
940
1111
  type: z2.literal("opinion_scale").describe("Must be exactly 'opinion_scale'"),
941
1112
  startValue: z2.union([z2.literal(0), z2.literal(1)]).optional().default(0).describe("Starting value of the scale \u2014 0 (default) or 1"),
942
- steps: z2.number().int().min(5).max(11).optional().default(11).describe("Number of points on the scale (5\u201311); default 11 gives a 0\u201310 or 1\u201311 range depending on startValue"),
943
- minLabel: z2.string().max(100).optional().describe("Optional label anchoring the low end of the scale (e.g. 'Not at all likely')"),
944
- maxLabel: z2.string().max(100).optional().describe("Optional label anchoring the high end of the scale (e.g. 'Extremely likely')")
945
- }).describe("Schema for an opinion scale question \u2014 a horizontal numeric button scale with configurable range and optional end labels");
946
- var rankingDisplayStyleSchema = z2.enum(["drag_drop", "dropdown", "up_down"]);
1113
+ steps: z2.number().int().min(5).max(11).optional().default(11).describe(
1114
+ "Number of points on the scale (5\u201311); default 11 gives a 0\u201310 or 1\u201311 range depending on startValue"
1115
+ ),
1116
+ minLabel: z2.string().max(100).optional().describe(
1117
+ "Optional label anchoring the low end of the scale (e.g. 'Not at all likely')"
1118
+ ),
1119
+ maxLabel: z2.string().max(100).optional().describe(
1120
+ "Optional label anchoring the high end of the scale (e.g. 'Extremely likely')"
1121
+ )
1122
+ }).describe(
1123
+ "Schema for an opinion scale question \u2014 a horizontal numeric button scale with configurable range and optional end labels"
1124
+ );
1125
+ var rankingDisplayStyleSchema = z2.enum([
1126
+ "drag_drop",
1127
+ "dropdown",
1128
+ "up_down"
1129
+ ]);
947
1130
  var RankingDisplayStyles = {
948
1131
  DRAG_DROP: "drag_drop",
949
1132
  DROPDOWN: "dropdown",
@@ -951,32 +1134,54 @@ var RankingDisplayStyles = {
951
1134
  };
952
1135
  var rankingQuestionSchema = questionSchema.extend({
953
1136
  type: z2.literal("ranking").describe("Must be exactly 'ranking'"),
954
- options: z2.array(questionOptionSchema).min(2).max(30).describe("List of items to rank (2\u201330 items); each item supports an optional hint for clarification"),
955
- randomizeOptions: z2.boolean().optional().default(false).describe("Whether to shuffle item order per respondent to avoid position bias"),
956
- displayStyle: rankingDisplayStyleSchema.optional().default("drag_drop").describe("Interaction mode \u2014 drag_drop (default) for drag-and-drop reordering, dropdown for selecting a rank number per item, up_down for arrow button reordering"),
957
- maxRank: z2.number().int().min(1).optional().describe("Maximum number of items the respondent must rank (e.g. 3 = 'rank your top 3'); when absent all items must be ranked")
1137
+ options: z2.array(questionOptionSchema).min(2).max(30).describe(
1138
+ "List of items to rank (2\u201330 items); each item supports an optional hint for clarification"
1139
+ ),
1140
+ randomizeOptions: z2.boolean().optional().default(false).describe(
1141
+ "Whether to shuffle item order per respondent to avoid position bias"
1142
+ ),
1143
+ displayStyle: rankingDisplayStyleSchema.optional().default("drag_drop").describe(
1144
+ "Interaction mode \u2014 drag_drop (default) for drag-and-drop reordering, dropdown for selecting a rank number per item, up_down for arrow button reordering"
1145
+ ),
1146
+ maxRank: z2.number().int().min(1).optional().describe(
1147
+ "Maximum number of items the respondent must rank (e.g. 3 = 'rank your top 3'); when absent all items must be ranked"
1148
+ )
958
1149
  }).refine(
959
1150
  (data) => data.maxRank === void 0 || data.maxRank <= data.options.length,
960
1151
  {
961
1152
  message: "maxRank cannot exceed the number of options",
962
1153
  path: ["maxRank"]
963
1154
  }
964
- ).describe("Schema for a ranking question where respondents order items by preference");
1155
+ ).describe(
1156
+ "Schema for a ranking question where respondents order items by preference"
1157
+ );
965
1158
  var pictureChoiceQuestionSchema = questionSchema.extend({
966
1159
  type: z2.literal("picture_choice").describe("Must be exactly 'picture_choice'"),
967
- options: z2.array(questionOptionSchema).min(1).max(50).describe("Array of options; each should include an imageUrl for the picture to display"),
968
- multiple: z2.boolean().optional().default(false).describe("When true respondents may select more than one image; when false (default) only one image can be selected"),
969
- minSelections: z2.number().int().min(1).optional().describe("Minimum number of images the respondent must select (only applies when multiple is true)"),
970
- maxSelections: z2.number().int().min(1).optional().describe("Maximum number of images the respondent may select (only applies when multiple is true)"),
1160
+ options: z2.array(questionOptionSchema).min(1).max(50).describe(
1161
+ "Array of options; each should include an imageUrl for the picture to display"
1162
+ ),
1163
+ multiple: z2.boolean().optional().default(false).describe(
1164
+ "When true respondents may select more than one image; when false (default) only one image can be selected"
1165
+ ),
1166
+ minSelections: z2.number().int().min(1).optional().describe(
1167
+ "Minimum number of images the respondent must select (only applies when multiple is true)"
1168
+ ),
1169
+ maxSelections: z2.number().int().min(1).optional().describe(
1170
+ "Maximum number of images the respondent may select (only applies when multiple is true)"
1171
+ ),
971
1172
  supersize: z2.boolean().optional().default(false).describe("Whether to display images at an enlarged size"),
972
1173
  showLabels: z2.boolean().optional().default(true).describe("Whether to show the text label below each image"),
973
- randomizeOptions: z2.boolean().optional().default(false).describe("Whether to shuffle image order per respondent to avoid position bias"),
1174
+ randomizeOptions: z2.boolean().optional().default(false).describe(
1175
+ "Whether to shuffle image order per respondent to avoid position bias"
1176
+ ),
974
1177
  allowOther: z2.boolean().optional().default(false).describe('Whether to include a free-text "other" option'),
975
1178
  otherTextConfig: z2.object({
976
1179
  minChars: z2.number().int().min(0).optional().describe("Minimum number of characters required for the other text"),
977
1180
  maxChars: z2.number().int().min(1).optional().describe("Maximum number of characters allowed for the other text"),
978
1181
  placeholder: z2.string().max(200).optional().describe("Placeholder text for the other text input"),
979
- showLimitIndicatorThreshold: z2.number().int().min(0).optional().describe("Show the character limit indicator once the user has typed this many characters; 0 = show immediately, absent = never show")
1182
+ showLimitIndicatorThreshold: z2.number().int().min(0).optional().describe(
1183
+ "Show the character limit indicator once the user has typed this many characters; 0 = show immediately, absent = never show"
1184
+ )
980
1185
  }).optional().describe('Configuration for the custom "other" text input')
981
1186
  }).refine(
982
1187
  (data) => {
@@ -989,7 +1194,9 @@ var pictureChoiceQuestionSchema = questionSchema.extend({
989
1194
  message: "minSelections cannot be greater than maxSelections",
990
1195
  path: ["minSelections"]
991
1196
  }
992
- ).describe("Schema for a picture choice question where respondents select from image-based options");
1197
+ ).describe(
1198
+ "Schema for a picture choice question where respondents select from image-based options"
1199
+ );
993
1200
  var signatureModeSchema = z2.enum(["type", "draw", "upload"]);
994
1201
  var SignatureModes = {
995
1202
  TYPE: "type",
@@ -998,87 +1205,216 @@ var SignatureModes = {
998
1205
  };
999
1206
  var signatureQuestionSchema = questionSchema.extend({
1000
1207
  type: z2.literal("signature").describe("Must be exactly 'signature'"),
1001
- allowedModes: z2.array(signatureModeSchema).min(1).optional().describe("Which signing methods the respondent can choose from (type, draw, upload); when absent all three are enabled"),
1002
- defaultMode: signatureModeSchema.optional().describe("Which signing tab is pre-selected when the question is first shown; when absent the platform chooses"),
1003
- collectSignerEmail: z2.boolean().optional().default(true).describe("Whether to auto-collect the signer's email so a signed PDF copy can be sent to them; set to false if the form already collects an email via signerEmailFieldId or another question"),
1004
- signerEmailFieldId: z2.string().optional().describe("ID of an existing email question in the form whose value will be used as the signer's email address, instead of auto-appending a new email prompt"),
1005
- penColor: z2.string().max(50).optional().describe("Stroke color for the draw canvas; any valid CSS color; when absent the theme foreground color is used"),
1006
- penWidth: z2.number().int().min(1).max(20).optional().describe("Pen stroke thickness in pixels for the draw canvas (1\u201320); when absent the renderer default (typically 2) is used"),
1007
- backgroundColor: z2.string().max(50).optional().describe("Background color of the draw canvas; any valid CSS color; when absent the canvas is transparent and inherits the form background"),
1008
- canvasHeight: z2.number().int().min(60).max(600).optional().describe("Draw canvas height in logical pixels (60\u2013600); width always fills the container; when absent the renderer chooses a sensible default (typically 200)"),
1009
- clearButtonLabel: z2.string().max(50).optional().describe("Label for the clear/redo button in draw mode; when absent the platform default label or icon is shown")
1010
- }).describe("Schema for a signature question where respondents can type, draw, or upload their electronic signature");
1208
+ allowedModes: z2.array(signatureModeSchema).min(1).optional().describe(
1209
+ "Which signing methods the respondent can choose from (type, draw, upload); when absent all three are enabled"
1210
+ ),
1211
+ defaultMode: signatureModeSchema.optional().describe(
1212
+ "Which signing tab is pre-selected when the question is first shown; when absent the platform chooses"
1213
+ ),
1214
+ collectSignerEmail: z2.boolean().optional().default(true).describe(
1215
+ "Whether to auto-collect the signer's email so a signed PDF copy can be sent to them; set to false if the form already collects an email via signerEmailFieldId or another question"
1216
+ ),
1217
+ signerEmailFieldId: z2.string().optional().describe(
1218
+ "ID of an existing email question in the form whose value will be used as the signer's email address, instead of auto-appending a new email prompt"
1219
+ ),
1220
+ penColor: z2.string().max(50).optional().describe(
1221
+ "Stroke color for the draw canvas; any valid CSS color; when absent the theme foreground color is used"
1222
+ ),
1223
+ penWidth: z2.number().int().min(1).max(20).optional().describe(
1224
+ "Pen stroke thickness in pixels for the draw canvas (1\u201320); when absent the renderer default (typically 2) is used"
1225
+ ),
1226
+ backgroundColor: z2.string().max(50).optional().describe(
1227
+ "Background color of the draw canvas; any valid CSS color; when absent the canvas is transparent and inherits the form background"
1228
+ ),
1229
+ canvasHeight: z2.number().int().min(60).max(600).optional().describe(
1230
+ "Draw canvas height in logical pixels (60\u2013600); width always fills the container; when absent the renderer chooses a sensible default (typically 200)"
1231
+ ),
1232
+ clearButtonLabel: z2.string().max(50).optional().describe(
1233
+ "Label for the clear/redo button in draw mode; when absent the platform default label or icon is shown"
1234
+ ),
1235
+ placeholder: z2.string().max(200).optional().describe(
1236
+ "Optional shared fallback copy for draw-canvas and upload-zone hints when their dedicated fields are unset"
1237
+ ),
1238
+ modeTabLabelType: z2.string().max(80).optional().describe(
1239
+ "Custom visible label for the Type tab; when absent only the tab icon is shown (use aria-label on the client)"
1240
+ ),
1241
+ modeTabLabelDraw: z2.string().max(80).optional().describe(
1242
+ "Custom visible label for the Draw tab; when absent only the tab icon is shown"
1243
+ ),
1244
+ modeTabLabelUpload: z2.string().max(80).optional().describe(
1245
+ "Custom visible label for the Upload tab; when absent only the tab icon is shown"
1246
+ ),
1247
+ drawCanvasHint: z2.string().max(200).optional().describe(
1248
+ "Hint shown on the empty draw canvas (e.g. 'Draw your signature here'); falls back to placeholder then platform default"
1249
+ ),
1250
+ uploadZonePrimary: z2.string().max(200).optional().describe(
1251
+ "Main prompt on the upload drop zone when idle (e.g. click to upload); falls back to placeholder then default"
1252
+ ),
1253
+ uploadZoneDrag: z2.string().max(120).optional().describe(
1254
+ "Short prompt when dragging a file over the upload zone; falls back to platform default"
1255
+ )
1256
+ }).describe(
1257
+ "Schema for a signature question where respondents can type, draw, or upload their electronic signature"
1258
+ );
1011
1259
  var fileUploadQuestionSchema = questionSchema.extend({
1012
1260
  type: z2.literal("file_upload").describe("Must be exactly 'file_upload'"),
1013
- allowedFileTypes: z2.array(z2.string()).min(1).optional().describe("MIME types and/or file extensions the respondent is allowed to upload (e.g. ['image/jpeg', '.pdf']); when absent all file types are accepted"),
1014
- maxFileSizeMb: z2.number().int().min(1).max(100).optional().describe("Maximum size per uploaded file in megabytes (1\u2013100); when absent the platform enforces its own ceiling"),
1015
- multiple: z2.boolean().optional().default(false).describe("When true the respondent may upload more than one file in a single question; when false (default) only one file is accepted"),
1016
- maxFiles: z2.number().int().min(1).max(20).optional().describe("Maximum number of files the respondent may upload (1\u201320); only applies when multiple is true; when absent no per-question file count limit is enforced"),
1017
- placeholder: z2.string().max(200).optional().describe("Text shown inside the upload dropzone to guide respondents (e.g. 'Drop your CV here or click to browse')")
1018
- }).describe("Schema for a file upload question where respondents can attach one or more files from their device");
1261
+ allowedFileTypes: z2.array(z2.string()).min(1).optional().describe(
1262
+ "MIME types and/or file extensions the respondent is allowed to upload (e.g. ['image/jpeg', '.pdf']); when absent all file types are accepted"
1263
+ ),
1264
+ maxFileSizeMb: z2.number().int().min(1).max(100).optional().describe(
1265
+ "Maximum size per uploaded file in megabytes (1\u2013100); when absent the platform enforces its own ceiling"
1266
+ ),
1267
+ multiple: z2.boolean().optional().default(false).describe(
1268
+ "When true the respondent may upload more than one file in a single question; when false (default) only one file is accepted"
1269
+ ),
1270
+ maxFiles: z2.number().int().min(1).max(20).optional().describe(
1271
+ "Maximum number of files the respondent may upload (1\u201320); only applies when multiple is true; when absent no per-question file count limit is enforced"
1272
+ ),
1273
+ placeholder: z2.string().max(200).optional().describe(
1274
+ "Text shown inside the upload dropzone to guide respondents (e.g. 'Drop your CV here or click to browse')"
1275
+ )
1276
+ }).describe(
1277
+ "Schema for a file upload question where respondents can attach one or more files from their device"
1278
+ );
1019
1279
  var emailQuestionSchema = questionSchema.extend({
1020
1280
  type: z2.literal("email").describe("Must be exactly 'email'"),
1021
1281
  placeholder: z2.string().max(200).optional().describe("Placeholder text shown inside the email input"),
1022
- prepopulatedValue: z2.string().optional().describe("Default email address to pre-fill the input (e.g. passed via URL param or hidden field)")
1023
- }).describe("Schema for an email question that only accepts correctly formatted email addresses");
1282
+ prepopulatedValue: z2.string().optional().describe(
1283
+ "Default email address to pre-fill the input (e.g. passed via URL param or hidden field)"
1284
+ )
1285
+ }).describe(
1286
+ "Schema for an email question that only accepts correctly formatted email addresses"
1287
+ );
1024
1288
  var numberQuestionSchema = questionSchema.extend({
1025
1289
  type: z2.literal("number").describe("Must be exactly 'number'"),
1026
- min: z2.number().optional().describe("Minimum allowed value (inclusive); when absent no lower bound is enforced"),
1027
- max: z2.number().optional().describe("Maximum allowed value (inclusive); when absent no upper bound is enforced"),
1028
- allowDecimal: z2.boolean().optional().default(false).describe("Whether decimal (non-integer) values are accepted; Typeform restricts to whole numbers only, making this a differentiator"),
1029
- allowNegative: z2.boolean().optional().default(false).describe("Whether negative values are accepted; Typeform restricts to positive numbers only, making this a differentiator"),
1290
+ min: z2.number().optional().describe(
1291
+ "Minimum allowed value (inclusive); when absent no lower bound is enforced"
1292
+ ),
1293
+ max: z2.number().optional().describe(
1294
+ "Maximum allowed value (inclusive); when absent no upper bound is enforced"
1295
+ ),
1296
+ allowDecimal: z2.boolean().optional().default(false).describe(
1297
+ "Whether decimal (non-integer) values are accepted; Typeform restricts to whole numbers only, making this a differentiator"
1298
+ ),
1299
+ allowNegative: z2.boolean().optional().default(false).describe(
1300
+ "Whether negative values are accepted; Typeform restricts to positive numbers only, making this a differentiator"
1301
+ ),
1030
1302
  placeholder: z2.string().max(200).optional().describe("Placeholder text shown inside the number input"),
1031
1303
  prepopulatedValue: z2.number().optional().describe("Default numeric value to pre-fill the input"),
1032
- unit: z2.string().max(20).optional().describe("Unit label displayed beside the input (e.g. 'kg', '$', 'years')")
1304
+ unit: z2.string().max(10).optional().describe(
1305
+ "Unit label displayed beside the input (e.g. 'kg', '$', 'years')"
1306
+ )
1033
1307
  }).refine(
1034
1308
  (data) => data.min === void 0 || data.max === void 0 || data.min <= data.max,
1035
1309
  {
1036
1310
  message: "min cannot be greater than max",
1037
1311
  path: ["min"]
1038
1312
  }
1039
- ).describe("Schema for a number question that only accepts numeric input with configurable range and format constraints");
1313
+ ).describe(
1314
+ "Schema for a number question that only accepts numeric input with configurable range and format constraints"
1315
+ );
1040
1316
  var websiteQuestionSchema = questionSchema.extend({
1041
1317
  type: z2.literal("website").describe("Must be exactly 'website'"),
1042
- placeholder: z2.string().max(200).optional().describe("Placeholder text shown inside the URL input (e.g. 'https://yoursite.com')"),
1318
+ placeholder: z2.string().max(200).optional().describe(
1319
+ "Placeholder text shown inside the URL input (e.g. 'https://yoursite.com')"
1320
+ ),
1043
1321
  prepopulatedValue: z2.string().optional().describe("Default URL to pre-fill the input")
1044
- }).describe("Schema for a website question that collects a URL with built-in format validation");
1322
+ }).describe(
1323
+ "Schema for a website question that collects a URL with built-in format validation"
1324
+ );
1045
1325
  var phoneNumberQuestionSchema = questionSchema.extend({
1046
1326
  type: z2.literal("phone_number").describe("Must be exactly 'phone_number'"),
1047
- defaultCountryCode: z2.string().max(2).optional().describe("ISO 3166-1 alpha-2 country code to pre-select in the country picker (e.g. 'US', 'IN'); when absent the platform uses the device/locale default"),
1048
- allowCountryChange: z2.boolean().optional().default(true).describe("Whether the respondent can change the country code; when false the default country is locked"),
1327
+ defaultCountryCode: z2.string().max(2).optional().describe(
1328
+ "ISO 3166-1 alpha-2 country code to pre-select in the country picker (e.g. 'US', 'IN'); when absent the platform uses the device/locale default"
1329
+ ),
1330
+ allowCountryChange: z2.boolean().optional().default(true).describe(
1331
+ "Whether the respondent can change the country code; when false the default country is locked"
1332
+ ),
1049
1333
  placeholder: z2.string().max(200).optional().describe("Placeholder text shown inside the phone number input"),
1050
- prepopulatedValue: z2.string().optional().describe("Default phone number to pre-fill the input; E.164 format recommended (e.g. '+14155552671')")
1051
- }).describe("Schema for a phone number question with country code picker and country-specific format validation");
1334
+ prepopulatedValue: z2.string().optional().describe(
1335
+ "Default phone number to pre-fill the input; E.164 format recommended (e.g. '+14155552671')"
1336
+ )
1337
+ }).describe(
1338
+ "Schema for a phone number question with country code picker and country-specific format validation"
1339
+ );
1052
1340
  var addressSubFieldConfigSchema = z2.object({
1053
1341
  enabled: z2.boolean().default(true).describe("Whether this sub-field is shown in the question"),
1054
1342
  required: z2.boolean().default(false).describe("Whether the respondent must fill in this sub-field"),
1055
- placeholder: z2.string().max(200).optional().describe("Placeholder text for this sub-field input")
1343
+ placeholder: z2.string().max(200).optional().describe("Placeholder text for this sub-field input"),
1344
+ label: z2.string().max(120).optional().describe(
1345
+ "Visible caption above this sub-field; defaults to built-in copy when omitted"
1346
+ )
1056
1347
  }).describe("Configuration for an individual address sub-field");
1057
1348
  var addressQuestionSchema = questionSchema.extend({
1058
1349
  type: z2.literal("address").describe("Must be exactly 'address'"),
1059
1350
  addressLine1: addressSubFieldConfigSchema.optional().describe("Configuration for the primary street address line"),
1060
- addressLine2: addressSubFieldConfigSchema.optional().describe("Configuration for the secondary address line (apartment, suite, etc.); hidden by default"),
1351
+ addressLine2: addressSubFieldConfigSchema.optional().describe(
1352
+ "Configuration for the secondary address line (apartment, suite, etc.); hidden by default"
1353
+ ),
1061
1354
  city: addressSubFieldConfigSchema.optional().describe("Configuration for the city/town sub-field"),
1062
1355
  stateProvince: addressSubFieldConfigSchema.optional().describe("Configuration for the state, region, or province sub-field"),
1063
1356
  postalCode: addressSubFieldConfigSchema.optional().describe("Configuration for the ZIP/postal code sub-field"),
1064
1357
  country: addressSubFieldConfigSchema.optional().describe("Configuration for the country sub-field"),
1065
- defaultCountry: z2.string().max(2).optional().describe("ISO 3166-1 alpha-2 country code to pre-select in the country dropdown (e.g. 'US', 'GB')")
1066
- }).describe("Schema for an address question that collects a full structured address on a single screen");
1067
- var videoAudioModeSchema = z2.enum(["video", "audio", "text"]);
1358
+ defaultCountry: z2.string().max(2).optional().describe(
1359
+ "ISO 3166-1 alpha-2 country code to pre-select in the country dropdown (e.g. 'US', 'GB')"
1360
+ )
1361
+ }).describe(
1362
+ "Schema for an address question that collects a full structured address on a single screen"
1363
+ );
1364
+ var videoAudioModeSchema = z2.enum(["video", "audio", "photo", "text"]);
1068
1365
  var VideoAudioModes = {
1069
1366
  VIDEO: "video",
1070
1367
  AUDIO: "audio",
1368
+ PHOTO: "photo",
1071
1369
  TEXT: "text"
1072
1370
  };
1073
1371
  var videoAudioQuestionSchema = questionSchema.extend({
1074
1372
  type: z2.literal("video_audio").describe("Must be exactly 'video_audio'"),
1075
- allowedModes: z2.array(videoAudioModeSchema).min(1).optional().describe("Which answer types the respondent can choose from (video, audio, text); when absent all three are enabled"),
1076
- defaultMode: videoAudioModeSchema.optional().describe("Which mode tab is pre-selected when the question opens; when absent the platform chooses"),
1077
- maxDurationSeconds: z2.number().int().min(5).max(600).optional().describe("Maximum recording length in seconds (5\u2013600); Typeform hardcodes 120s with no config, making this a differentiator; when absent the platform default applies"),
1078
- maxFileSizeMb: z2.number().int().min(1).max(500).optional().describe("Maximum size in megabytes for uploaded pre-recorded files (1\u2013500); when absent the platform ceiling applies"),
1079
- allowUpload: z2.boolean().optional().default(true).describe("Whether the respondent can upload a pre-recorded file in addition to recording live"),
1080
- placeholder: z2.string().max(200).optional().describe("Instructional text shown to the respondent before they begin recording")
1081
- }).describe("Schema for a video and audio question where respondents can record or upload a video, audio clip, or text answer");
1373
+ allowedModes: z2.array(videoAudioModeSchema).min(1).optional().describe(
1374
+ "Which answer types the respondent can choose from (video, audio, photo, text); when absent all four are enabled"
1375
+ ),
1376
+ defaultMode: videoAudioModeSchema.optional().describe(
1377
+ "Which mode tab is pre-selected when the question opens; when absent the platform chooses"
1378
+ ),
1379
+ maxDurationSeconds: z2.number().int().min(5).max(600).optional().describe(
1380
+ "Maximum recording length in seconds (5\u2013600); Typeform hardcodes 120s with no config, making this a differentiator; when absent the platform default applies"
1381
+ ),
1382
+ maxFileSizeMb: z2.number().int().min(1).max(500).optional().describe(
1383
+ "Maximum size in megabytes for uploaded pre-recorded files (1\u2013500); when absent the platform ceiling applies"
1384
+ ),
1385
+ allowUpload: z2.boolean().optional().default(true).describe(
1386
+ "Whether the respondent can upload a file in addition to recording or capturing live (video, audio, or photo)"
1387
+ ),
1388
+ placeholder: z2.string().max(200).optional().describe(
1389
+ "Instructional text shown to the respondent before they begin recording or capturing"
1390
+ ),
1391
+ modeTabLabelVideo: z2.string().max(80).optional().describe(
1392
+ "Custom tab label for video mode in the respondent UI; when absent defaults to 'Video'"
1393
+ ),
1394
+ modeTabLabelAudio: z2.string().max(80).optional().describe(
1395
+ "Custom tab label for audio mode; when absent defaults to 'Audio'"
1396
+ ),
1397
+ modeTabLabelPhoto: z2.string().max(80).optional().describe(
1398
+ "Custom tab label for photo mode; when absent defaults to 'Photo'"
1399
+ ),
1400
+ modeTabLabelText: z2.string().max(80).optional().describe(
1401
+ "Custom tab label for text mode; when absent defaults to 'Text'"
1402
+ ),
1403
+ recordButtonLabel: z2.string().max(80).optional().describe("Label for the Record button in video/audio modes"),
1404
+ uploadMediaButtonLabel: z2.string().max(80).optional().describe(
1405
+ "Label for the upload control in video/audio modes when uploads are allowed"
1406
+ ),
1407
+ videoIdleHint: z2.string().max(200).optional().describe(
1408
+ "Hint shown over the video preview when idle; falls back to placeholder then built-in copy"
1409
+ ),
1410
+ photoEmptyHint: z2.string().max(200).optional().describe(
1411
+ "Hint in the empty photo preview area; falls back to placeholder then built-in copy"
1412
+ ),
1413
+ photoUseCameraButtonLabel: z2.string().max(80).optional().describe("Label for the Use camera button in photo mode"),
1414
+ photoUploadImageButtonLabel: z2.string().max(80).optional().describe("Label for the upload image button in photo mode")
1415
+ }).describe(
1416
+ "Schema for a video, audio, and photo question where respondents can record or upload media or enter a text answer"
1417
+ );
1082
1418
  var schedulerProviderSchema = z2.enum(["google_calendar", "calendly"]);
1083
1419
  var SchedulerProviders = {
1084
1420
  GOOGLE_CALENDAR: "google_calendar",
@@ -1086,21 +1422,123 @@ var SchedulerProviders = {
1086
1422
  };
1087
1423
  var schedulerQuestionSchema = questionSchema.extend({
1088
1424
  type: z2.literal("scheduler").describe("Must be exactly 'scheduler'"),
1089
- provider: schedulerProviderSchema.optional().describe("Which calendar integration to use (google_calendar or calendly); when absent the platform uses whatever is connected"),
1090
- calendarId: z2.string().optional().describe("Specific Google Calendar ID or Calendly event-type URL/slug to book from; when absent the default calendar or event type is used"),
1091
- showIntroScreen: z2.boolean().optional().default(true).describe("Whether to show the Calendly event intro screen (account name, event name, duration) before the time picker; only applies when provider is 'calendly'"),
1092
- autofillNameFieldId: z2.string().optional().describe("ID of a prior Short Text or Name question whose answer is pre-filled into the Calendly booking name field; only applies when provider is 'calendly'"),
1093
- autofillEmailFieldId: z2.string().optional().describe("ID of a prior Email question whose answer is pre-filled into the Calendly booking email field; only applies when provider is 'calendly'"),
1094
- placeholder: z2.string().max(200).optional().describe("Instructional text shown above the calendar picker to guide the respondent")
1095
- }).describe("Schema for a scheduler question where respondents book a time slot directly within the form via Google Calendar or Calendly");
1425
+ provider: schedulerProviderSchema.optional().describe(
1426
+ "Which calendar integration to use (google_calendar or calendly); when absent the platform uses whatever is connected"
1427
+ ),
1428
+ calendarId: z2.string().optional().describe(
1429
+ "Specific Google Calendar ID or Calendly event-type URL/slug to book from; when absent the default calendar or event type is used"
1430
+ ),
1431
+ showIntroScreen: z2.boolean().optional().default(true).describe(
1432
+ "Whether to show the Calendly event intro screen (account name, event name, duration) before the time picker; only applies when provider is 'calendly'"
1433
+ ),
1434
+ autofillNameFieldId: z2.string().optional().describe(
1435
+ "ID of a prior Short Text or Name question whose answer is pre-filled into the Calendly booking name field; only applies when provider is 'calendly'"
1436
+ ),
1437
+ autofillEmailFieldId: z2.string().optional().describe(
1438
+ "ID of a prior Email question whose answer is pre-filled into the Calendly booking email field; only applies when provider is 'calendly'"
1439
+ ),
1440
+ placeholder: z2.string().max(200).optional().describe(
1441
+ "Fallback text for the book-a-meeting button when scheduleMeetingLabel is unset; also used as a secondary fallback in the CTA copy chain"
1442
+ ),
1443
+ scheduleMeetingLabel: z2.string().max(200).optional().describe(
1444
+ "Primary label on the book-a-meeting button and modal; when absent uses placeholder then the built-in default (e.g. 'Schedule a meeting')"
1445
+ )
1446
+ }).describe(
1447
+ "Schema for a scheduler question where respondents book a time slot directly within the form via Google Calendar or Calendly"
1448
+ );
1096
1449
  var qnaWithAiQuestionSchema = questionSchema.extend({
1097
1450
  type: z2.literal("qna_with_ai").describe("Must be exactly 'qna_with_ai'"),
1098
- knowledgeBase: z2.string().max(2e4).describe("The knowledge base content the AI draws from when answering respondent questions; Markdown formatting is recommended; up to 20,000 characters"),
1099
- maxResponseLength: z2.number().int().min(50).max(2e3).optional().describe("Maximum number of characters per AI-generated response (50\u20132000); Typeform hardcodes 300, making this configurable a differentiator; when absent the platform default (300) applies"),
1100
- maxQaPairs: z2.number().int().min(1).max(100).optional().describe("Maximum number of Q&A exchanges allowed per submission (1\u2013100); Typeform hardcodes 20, making this configurable a differentiator; when absent the platform default (20) applies"),
1101
- placeholder: z2.string().max(200).optional().describe("Hint text shown in the respondent's question input field (e.g. 'Ask me anything about this event...')"),
1102
- askButtonLabel: z2.string().max(50).optional().describe("Label for the submit/ask button; when absent the platform default (e.g. 'Ask AI') is shown")
1103
- }).describe("Schema for a Q&A with AI question where respondents ask questions and receive AI-generated answers drawn from a configurable knowledge base");
1451
+ knowledgeBase: z2.string().max(2e4).describe(
1452
+ "The knowledge base content the AI draws from when answering respondent questions; Markdown formatting is recommended; up to 20,000 characters"
1453
+ ),
1454
+ maxResponseLength: z2.number().int().min(50).max(2e3).optional().describe(
1455
+ "Maximum number of characters per AI-generated response (50\u20132000); Typeform hardcodes 300, making this configurable a differentiator; when absent the platform default (300) applies"
1456
+ ),
1457
+ maxQaPairs: z2.number().int().min(1).max(100).optional().describe(
1458
+ "Maximum number of Q&A exchanges allowed per submission (1\u2013100); Typeform hardcodes 20, making this configurable a differentiator; when absent the platform default (20) applies"
1459
+ ),
1460
+ placeholder: z2.string().max(200).optional().describe(
1461
+ "Hint text shown in the respondent's question input field (e.g. 'Ask me anything about this event...')"
1462
+ ),
1463
+ askButtonLabel: z2.string().max(50).optional().describe(
1464
+ "Label for the submit/ask button; when absent the platform default (e.g. 'Ask AI') is shown"
1465
+ ),
1466
+ emptyStateHint: z2.string().max(200).optional().describe(
1467
+ "Message in the empty chat area (e.g. 'Ask the AI a question to get started.'); when absent uses placeholder then a built-in default"
1468
+ ),
1469
+ pairsRemainingTemplate: z2.string().max(160).optional().describe(
1470
+ "Counter when under the limit; use tokens {remaining} and {max} (e.g. '{remaining} of {max} questions remaining'); when absent the client uses built-in English with pluralization"
1471
+ ),
1472
+ pairsLimitReachedTemplate: z2.string().max(160).optional().describe(
1473
+ "Counter when the exchange limit is reached; use token {max}; when absent the client uses built-in English with pluralization"
1474
+ )
1475
+ }).describe(
1476
+ "Schema for a Q&A with AI question where respondents ask questions and receive AI-generated answers drawn from a configurable knowledge base"
1477
+ );
1478
+ var paymentsUpiAmountConfigSchema = z2.discriminatedUnion("mode", [
1479
+ z2.object({
1480
+ mode: z2.literal("fixed").describe("A fixed amount configured by the form builder"),
1481
+ amount: z2.number().positive().describe("Fixed amount to request in INR")
1482
+ }),
1483
+ z2.object({
1484
+ mode: z2.literal("range").describe("Respondent enters an amount within the configured range"),
1485
+ minAmount: z2.number().positive().describe("Minimum allowed amount in INR"),
1486
+ maxAmount: z2.number().positive().describe("Maximum allowed amount in INR"),
1487
+ defaultAmount: z2.number().positive().optional().describe("Optional initial amount shown to the respondent")
1488
+ }),
1489
+ z2.object({
1490
+ mode: z2.literal("question_mapping").describe("Amount is resolved from a previous question answer"),
1491
+ sourceQuestionId: z2.string().describe(
1492
+ "ID of the prior question whose answer determines the amount"
1493
+ ),
1494
+ mappings: z2.array(
1495
+ z2.object({
1496
+ answerValue: z2.string().describe("Previous question answer value to match"),
1497
+ amount: z2.number().positive().describe("Amount to request in INR when this answer matches"),
1498
+ label: z2.string().max(120).optional().describe("Optional display label for this mapped amount")
1499
+ })
1500
+ ).min(1).describe("Answer-to-amount mappings"),
1501
+ fallbackAmount: z2.number().positive().optional().describe("Optional amount to use when no mapping matches")
1502
+ })
1503
+ ]).superRefine((data, ctx) => {
1504
+ if (data.mode !== "range") return;
1505
+ if (data.minAmount > data.maxAmount) {
1506
+ ctx.addIssue({
1507
+ code: z2.ZodIssueCode.custom,
1508
+ message: "minAmount cannot be greater than maxAmount",
1509
+ path: ["minAmount"]
1510
+ });
1511
+ }
1512
+ if (data.defaultAmount !== void 0 && (data.defaultAmount < data.minAmount || data.defaultAmount > data.maxAmount)) {
1513
+ ctx.addIssue({
1514
+ code: z2.ZodIssueCode.custom,
1515
+ message: "defaultAmount must be within minAmount and maxAmount",
1516
+ path: ["defaultAmount"]
1517
+ });
1518
+ }
1519
+ }).describe("Amount configuration for a payments_upi question");
1520
+ var paymentsUpiQuestionSchema = questionSchema.extend({
1521
+ type: z2.literal("payments_upi").describe("Must be exactly 'payments_upi'"),
1522
+ payeeVpa: z2.string().min(3).max(255).regex(
1523
+ /^[\w.\-]+@[\w.\-]+$/,
1524
+ "payeeVpa must be a valid UPI VPA such as merchant@bank"
1525
+ ).describe("UPI virtual payment address that receives the payment"),
1526
+ payeeName: z2.string().max(100).optional().describe("Display name for the UPI payee"),
1527
+ amount: paymentsUpiAmountConfigSchema.describe(
1528
+ "How the requested INR amount is determined"
1529
+ ),
1530
+ transactionNote: z2.string().max(80).optional().describe(
1531
+ "Short note included in the UPI intent; the platform may append the Encatch reference"
1532
+ ),
1533
+ transactionReferencePrefix: z2.string().max(24).optional().describe("Optional prefix for generated Encatch payment references"),
1534
+ qrLabel: z2.string().max(100).optional().describe("Label shown above the UPI QR code"),
1535
+ openUpiAppLabel: z2.string().max(80).optional().describe("Label for the mobile UPI intent button"),
1536
+ copyUpiIdLabel: z2.string().max(80).optional().describe("Label for the copy UPI ID button"),
1537
+ transactionIdLabel: z2.string().max(100).optional().describe("Label for the self-reported transaction ID / UTR input"),
1538
+ transactionIdPlaceholder: z2.string().max(120).optional().describe("Placeholder for the transaction ID / UTR input")
1539
+ }).describe(
1540
+ "Schema for a self-reported UPI payment question that renders a UPI QR/intent link and collects the respondent-entered transaction ID"
1541
+ );
1104
1542
  var combinedQuestionSchema = z2.discriminatedUnion("type", [
1105
1543
  ratingQuestionSchema,
1106
1544
  annotationQuestionSchema,
@@ -1133,7 +1571,8 @@ var combinedQuestionSchema = z2.discriminatedUnion("type", [
1133
1571
  addressQuestionSchema,
1134
1572
  videoAudioQuestionSchema,
1135
1573
  schedulerQuestionSchema,
1136
- qnaWithAiQuestionSchema
1574
+ qnaWithAiQuestionSchema,
1575
+ paymentsUpiQuestionSchema
1137
1576
  ]);
1138
1577
 
1139
1578
  // src/schemas/fields/answer-schema.ts
@@ -1150,18 +1589,26 @@ var AnnotationSchema = z3.object({
1150
1589
  });
1151
1590
  var SignatureAnswerSchema = z3.object({
1152
1591
  mode: z3.enum(["type", "draw", "upload"]).describe("The signing method the respondent used"),
1153
- fileUrl: z3.string().optional().describe("Secure URL to the signature artifact for draw and upload modes"),
1592
+ fileUrl: z3.string().optional().describe(
1593
+ "Secure URL to the signature artifact for draw and upload modes"
1594
+ ),
1154
1595
  typedName: z3.string().optional().describe("The name the respondent typed for type mode")
1155
1596
  }).describe("Answer for a signature question");
1156
1597
  var FileUploadAnswerItemSchema = z3.object({
1157
1598
  fileUrl: z3.string().describe("Secure URL to the uploaded file"),
1158
1599
  fileName: z3.string().describe("Original filename as provided by the respondent"),
1159
1600
  fileSizeMb: z3.number().describe("File size in megabytes"),
1160
- mimeType: z3.string().optional().describe("MIME type of the uploaded file (e.g. 'application/pdf', 'image/jpeg')")
1601
+ mimeType: z3.string().optional().describe(
1602
+ "MIME type of the uploaded file (e.g. 'application/pdf', 'image/jpeg')"
1603
+ )
1161
1604
  }).describe("Metadata for a single uploaded file");
1162
- var FileUploadAnswerSchema = z3.array(FileUploadAnswerItemSchema).describe("Answer for a file upload question; array supports single and multiple file uploads");
1605
+ var FileUploadAnswerSchema = z3.array(FileUploadAnswerItemSchema).describe(
1606
+ "Answer for a file upload question; array supports single and multiple file uploads"
1607
+ );
1163
1608
  var PhoneNumberAnswerSchema = z3.object({
1164
- countryCode: z3.string().describe("Dialing country code including the + prefix (e.g. '+1', '+91')"),
1609
+ countryCode: z3.string().describe(
1610
+ "Dialing country code including the + prefix (e.g. '+1', '+91')"
1611
+ ),
1165
1612
  number: z3.string().describe("Local phone number without the country code"),
1166
1613
  e164: z3.string().optional().describe("Full phone number in E.164 format (e.g. '+14155552671')")
1167
1614
  }).describe("Answer for a phone number question");
@@ -1174,36 +1621,82 @@ var AddressAnswerSchema = z3.object({
1174
1621
  country: z3.string().optional().describe("Country name or ISO 3166-1 alpha-2 code")
1175
1622
  }).describe("Answer for an address question");
1176
1623
  var VideoAudioAnswerSchema = z3.object({
1177
- mode: z3.enum(["video", "audio", "text"]).describe("The answer mode the respondent chose"),
1178
- fileUrl: z3.string().optional().describe("Secure URL to the recorded or uploaded video/audio file"),
1624
+ mode: z3.enum(["video", "audio", "photo", "text"]).describe("The answer mode the respondent chose"),
1625
+ fileUrl: z3.string().optional().describe(
1626
+ "Secure URL or temporary data URL to the recorded, captured, or uploaded video, audio, or image file"
1627
+ ),
1179
1628
  text: z3.string().optional().describe("Written answer for text mode"),
1180
- durationSeconds: z3.number().optional().describe("Actual recording length in seconds for video and audio modes"),
1629
+ durationSeconds: z3.number().optional().describe(
1630
+ "Actual recording length in seconds for video and audio modes (not used for photo)"
1631
+ ),
1181
1632
  transcriptText: z3.string().optional().describe("Auto-generated transcript for video and audio recordings")
1182
1633
  }).describe("Answer for a video and audio question");
1183
1634
  var QnaWithAiPairSchema = z3.object({
1184
1635
  question: z3.string().describe("The question the respondent asked"),
1185
1636
  answer: z3.string().describe("The AI-generated answer based on the knowledge base")
1186
1637
  }).describe("A single Q&A exchange between the respondent and the AI");
1187
- var QnaWithAiAnswerSchema = z3.array(QnaWithAiPairSchema).describe("Answer for a qna_with_ai question; ordered transcript of Q&A pairs from the session");
1188
- var SchedulerAnswerSchema = z3.object({
1189
- provider: z3.enum(["google_calendar", "calendly"]).describe("The calendar integration used to make the booking"),
1190
- slotStart: z3.string().describe("ISO 8601 datetime of the booked slot start (e.g. '2026-05-15T14:00:00Z')"),
1191
- slotEnd: z3.string().describe("ISO 8601 datetime of the booked slot end (e.g. '2026-05-15T14:30:00Z')"),
1192
- eventId: z3.string().optional().describe("Calendar event ID (Google Calendar) or Calendly event UUID"),
1193
- bookedAt: z3.string().describe("ISO 8601 datetime when the respondent completed the booking")
1194
- }).describe("Answer for a scheduler question");
1638
+ var QnaWithAiAnswerSchema = z3.array(QnaWithAiPairSchema).describe(
1639
+ "Answer for a qna_with_ai question; ordered transcript of Q&A pairs from the session"
1640
+ );
1641
+ var SchedulerAnswerSchema = z3.discriminatedUnion("provider", [
1642
+ z3.object({
1643
+ provider: z3.literal("google_calendar").describe("The calendar integration used to make the booking"),
1644
+ bookedAt: z3.string().describe(
1645
+ "Unix timestamp in seconds as a string when the respondent confirmed the booking"
1646
+ )
1647
+ }),
1648
+ z3.object({
1649
+ provider: z3.literal("calendly").describe("The calendar integration used to make the booking"),
1650
+ slotStart: z3.string().describe(
1651
+ "ISO 8601 datetime of the booked slot start (e.g. '2026-05-15T14:00:00Z')"
1652
+ ),
1653
+ slotEnd: z3.string().describe(
1654
+ "ISO 8601 datetime of the booked slot end (e.g. '2026-05-15T14:30:00Z')"
1655
+ ),
1656
+ eventId: z3.string().optional().describe("Calendly event UUID"),
1657
+ bookedAt: z3.string().describe(
1658
+ "Unix timestamp in seconds as a string when the respondent completed the booking"
1659
+ )
1660
+ })
1661
+ ]).describe("Answer for a scheduler question");
1662
+ var PaymentsUpiAnswerSchema = z3.object({
1663
+ transactionId: z3.string().describe(
1664
+ "Respondent-entered UPI transaction ID / UTR; self-reported and not verified by Encatch"
1665
+ ),
1666
+ encatchPaymentReference: z3.string().describe(
1667
+ "Opaque Encatch-generated reconciliation reference included in the UPI intent"
1668
+ ),
1669
+ amount: z3.number().positive().describe(
1670
+ "INR amount shown to the respondent when the payment instruction was generated"
1671
+ ),
1672
+ currency: z3.literal("INR").describe("Currency for UPI payments"),
1673
+ payeeVpa: z3.string().describe("UPI VPA shown to the respondent"),
1674
+ payeeName: z3.string().optional().describe("Payee display name shown to the respondent"),
1675
+ upiIntentUri: z3.string().optional().describe("Generated UPI intent URI shown to the respondent"),
1676
+ selfReported: z3.literal(true).describe(
1677
+ "Always true: Encatch records this answer but does not verify the payment"
1678
+ )
1679
+ }).describe("Answer for a payments_upi question");
1195
1680
  var AnswerItemSchema = z3.object({
1196
1681
  nps: z3.number().optional().describe("Net Promoter Score value (e.g., 0-10)"),
1197
1682
  nestedSelection: z3.array(z3.string()).optional().describe("Array of selected nested option IDs"),
1198
1683
  longText: z3.string().optional().describe("Long text answer, e.g., paragraph or essay"),
1199
1684
  shortAnswer: z3.string().optional().describe("Short text answer, e.g., single sentence or word"),
1200
- singleChoice: z3.string().optional().describe("single selected option ID (for single choice questions)"),
1685
+ singleChoice: z3.string().optional().describe("Single selected option value for single choice questions"),
1201
1686
  rating: z3.number().optional().describe("Star rating value (e.g., 1-5)"),
1202
1687
  yesNo: z3.boolean().optional().describe("Yes/no answer for yes_no questions (true = Yes, false = No)"),
1203
- consent: z3.boolean().optional().describe("Consent answer for consent questions (true = checked/agreed, false = unchecked)"),
1204
- multipleChoiceMultiple: z3.array(z3.string()).optional().describe("Array of selected option IDs for multiple choice questions"),
1205
- singleChoiceOther: z3.string().optional().describe('Free-text "other" answer for single choice questions when allowOther is enabled'),
1206
- multipleChoiceOther: z3.string().optional().describe('Free-text "other" answer for multiple choice questions when allowOther is enabled'),
1688
+ consent: z3.boolean().optional().describe(
1689
+ "Consent answer for consent questions (true = checked/agreed, false = unchecked)"
1690
+ ),
1691
+ multipleChoiceMultiple: z3.array(z3.string()).optional().describe(
1692
+ "Array of selected option values for multiple choice questions"
1693
+ ),
1694
+ singleChoiceOther: z3.string().optional().describe(
1695
+ 'Free-text "other" answer for single choice questions when allowOther is enabled'
1696
+ ),
1697
+ multipleChoiceOther: z3.string().optional().describe(
1698
+ 'Free-text "other" answer for multiple choice questions when allowOther is enabled'
1699
+ ),
1207
1700
  annotation: AnnotationSchema.optional().describe(
1208
1701
  "Annotation object containing file and marker details"
1209
1702
  ),
@@ -1220,37 +1713,68 @@ var AnswerItemSchema = z3.object({
1220
1713
  "For multiple choice questions and single choice questions, this is the value of the other option"
1221
1714
  ),
1222
1715
  // Date question
1223
- date: z3.string().optional().describe("Answer for a date question; ISO 8601 format (YYYY-MM-DD or YYYY-MM-DDTHH:MM)"),
1716
+ date: z3.string().optional().describe(
1717
+ "Answer for a date question; ISO 8601 format (YYYY-MM-DD or YYYY-MM-DDTHH:MM)"
1718
+ ),
1224
1719
  // CSAT question
1225
- csat: z3.number().optional().describe("Answer for a CSAT question; semantic value: -2, -1, 0, 1, or 2"),
1720
+ csat: z3.number().optional().describe(
1721
+ "Answer for a CSAT question; industry-standard value: 1 (lowest/worst) to N (highest/best) where N is the scale size (2\u20135)"
1722
+ ),
1226
1723
  // Opinion scale question
1227
- opinionScale: z3.number().optional().describe("Answer for an opinion scale question; the selected numeric value on the scale"),
1228
- // Ranking question ordered array of option IDs; index 0 = rank 1
1229
- ranking: z3.array(z3.string()).optional().describe("Answer for a ranking question; ordered array of option IDs where index 0 is rank 1"),
1230
- // Picture choicesingle selection
1231
- pictureChoice: z3.string().optional().describe("Answer for a picture choice question (single selection); the selected option ID"),
1232
- // Picture choice multiple selection
1233
- pictureChoiceMultiple: z3.array(z3.string()).optional().describe("Answer for a picture choice question (multiple selection); array of selected option IDs"),
1724
+ opinionScale: z3.number().optional().describe(
1725
+ "Answer for an opinion scale question; the selected numeric value on the scale"
1726
+ ),
1727
+ // Ranking questionordered array of option values; index 0 = rank 1
1728
+ ranking: z3.array(z3.string()).optional().describe(
1729
+ "Answer for a ranking question; ordered array of option values where index 0 is rank 1"
1730
+ ),
1731
+ // Picture choice — always an array of selected option values (single selection = one-element array)
1732
+ pictureChoice: z3.array(z3.string()).optional().describe(
1733
+ "Answer for a picture choice question; array of selected option values (single selection produces a one-element array)"
1734
+ ),
1735
+ pictureChoiceOther: z3.string().optional().describe(
1736
+ 'Free-text "other" answer for picture choice questions when allowOther is enabled'
1737
+ ),
1234
1738
  // Signature question
1235
- signature: SignatureAnswerSchema.optional().describe("Answer for a signature question"),
1739
+ signature: SignatureAnswerSchema.optional().describe(
1740
+ "Answer for a signature question"
1741
+ ),
1236
1742
  // File upload question
1237
- fileUpload: FileUploadAnswerSchema.optional().describe("Answer for a file upload question; array supports single and multiple file uploads"),
1743
+ fileUpload: FileUploadAnswerSchema.optional().describe(
1744
+ "Answer for a file upload question; array supports single and multiple file uploads"
1745
+ ),
1238
1746
  // Email question
1239
1747
  email: z3.string().optional().describe("Answer for an email question; the submitted email address"),
1240
1748
  // Number question
1241
- number: z3.number().optional().describe("Answer for a number question; the submitted numeric value"),
1749
+ number: z3.string().optional().describe(
1750
+ "Answer for a number question; the submitted numeric value as a string"
1751
+ ),
1242
1752
  // Website question
1243
1753
  website: z3.string().optional().describe("Answer for a website question; the submitted URL"),
1244
1754
  // Phone number question
1245
- phoneNumber: PhoneNumberAnswerSchema.optional().describe("Answer for a phone number question"),
1755
+ phoneNumber: PhoneNumberAnswerSchema.optional().describe(
1756
+ "Answer for a phone number question"
1757
+ ),
1246
1758
  // Address question
1247
- address: AddressAnswerSchema.optional().describe("Answer for an address question"),
1759
+ address: AddressAnswerSchema.optional().describe(
1760
+ "Answer for an address question"
1761
+ ),
1248
1762
  // Video and audio question
1249
- videoAudio: VideoAudioAnswerSchema.optional().describe("Answer for a video and audio question"),
1763
+ videoAudio: VideoAudioAnswerSchema.optional().describe(
1764
+ "Answer for a video and audio question"
1765
+ ),
1250
1766
  // Scheduler question
1251
- scheduler: SchedulerAnswerSchema.optional().describe("Answer for a scheduler question"),
1767
+ scheduler: SchedulerAnswerSchema.optional().describe(
1768
+ "Answer for a scheduler question"
1769
+ ),
1252
1770
  // Q&A with AI question
1253
- qnaWithAi: QnaWithAiAnswerSchema.optional().describe("Answer for a qna_with_ai question; ordered transcript of Q&A pairs from the session")
1771
+ qnaWithAi: QnaWithAiAnswerSchema.optional().describe(
1772
+ "Answer for a qna_with_ai question; ordered transcript of Q&A pairs from the session"
1773
+ ),
1774
+ // Payments UPI question
1775
+ paymentsUpi: PaymentsUpiAnswerSchema.optional().describe(
1776
+ "Answer for a payments_upi question; self-reported UPI transaction reference"
1777
+ )
1254
1778
  }).describe(
1255
1779
  "Flexible answer item supporting various question types and custom fields"
1256
1780
  );
@@ -1290,6 +1814,7 @@ var OtherFieldsSchema = z5.object({
1290
1814
  remindMeLaterButtonLabel: z5.string().max(50).optional().describe("Label for the remind me later button; when absent or blank the button is not shown"),
1291
1815
  estimatedCompletionLabel: z5.string().max(100).optional().describe("Estimated completion time label shown on the welcome or first screen (e.g. 'Takes about 2 minutes'); when absent the label is not shown"),
1292
1816
  respondentsShowMinThreshold: z5.number().int().min(1).optional().describe("Minimum number of respondents required before the respondents badge is shown; when absent the badge is never shown"),
1817
+ respondentsLabel: z5.string().max(100).optional().describe("Label template for the respondents badge (e.g. '{count} people have already responded'); client interpolates {count} at render time"),
1293
1818
  windowTitle: z5.string().max(100).optional().describe("Custom browser window/tab title for the form; when absent the platform uses a default (e.g. the form title or app name)")
1294
1819
  }).describe("Schema for other form configuration fields");
1295
1820
  var LanguageFieldSchema = z5.object({
@@ -1798,8 +2323,11 @@ var fetchFeedbackDetailsSchema = z13.object({
1798
2323
  }).strict().describe("Request schema for fetching specific feedback form details");
1799
2324
  var formConfigurationResponseSchema = z13.object({
1800
2325
  formTitle: z13.string().describe("Title of the feedback form"),
1801
- formDescription: z13.string().describe("Description of the feedback form")
1802
- }).describe("Form configuration response with title and description");
2326
+ formDescription: z13.string().describe("Description of the feedback form"),
2327
+ respondentsCount: z13.number().int().min(0).optional().describe(
2328
+ "Total number of respondents enriched by the server at fetch time; used alongside respondentsShowMinThreshold to decide whether to display the welcome badge"
2329
+ )
2330
+ }).describe("Form configuration response with title, description, and optional respondent count");
1803
2331
  var logicJumpRuleSchema = z13.object({
1804
2332
  jsonLogic: z13.record(z13.string(), z13.unknown()).describe("JSON Logic expression to evaluate"),
1805
2333
  targetQuestionId: z13.string().describe("Question ID to navigate to when this rule matches")
@@ -1831,7 +2359,7 @@ var fetchFeedbackDetailsResponseSchema = z13.object({
1831
2359
  feedbackConfigurationId: z13.string().uuid().describe("Unique identifier for the feedback configuration"),
1832
2360
  feedbackIdentifier: z13.string().uuid().describe("Unique identifier for this specific feedback instance"),
1833
2361
  formConfiguration: formConfigurationResponseSchema.describe(
1834
- "Form configuration with title and description"
2362
+ "Form configuration including title, description, and optional respondent count for the welcome badge"
1835
2363
  ),
1836
2364
  questionnaireFields: questionnaireFieldsResponseSchema.describe(
1837
2365
  "Questionnaire structure including questions, sections, translations, and languages"
@@ -1841,8 +2369,7 @@ var fetchFeedbackDetailsResponseSchema = z13.object({
1841
2369
  ),
1842
2370
  appearanceProperties: appearancePropertiesSchema.describe(
1843
2371
  "Appearance properties including theme configuration"
1844
- ),
1845
- respondentsCount: z13.number().int().min(0).optional().describe("Total number of respondents enriched by the server at fetch time; used alongside respondentsShowMinThreshold to decide whether to display the badge")
2372
+ )
1846
2373
  }).strict().describe(
1847
2374
  "Complete response schema for fetchFeedbackDetails API using existing field schemas"
1848
2375
  );
@@ -2004,6 +2531,7 @@ export {
2004
2531
  MultipleChoiceMultipleDisplayStyles,
2005
2532
  OtherFieldsSchema,
2006
2533
  OtherFieldsTranslationSchema,
2534
+ PaymentsUpiAnswerSchema,
2007
2535
  PhoneNumberAnswerSchema,
2008
2536
  Positions,
2009
2537
  PreviousButtonModes,
@@ -2055,6 +2583,7 @@ export {
2055
2583
  customEventFieldSchema,
2056
2584
  dateFormatSchema,
2057
2585
  dateQuestionSchema,
2586
+ dateQuestionTranslationSchema,
2058
2587
  dateSeparatorSchema,
2059
2588
  deviceInfoSchema,
2060
2589
  deviceSessionInfoSchema,
@@ -2113,12 +2642,16 @@ export {
2113
2642
  opinionScaleQuestionSchema,
2114
2643
  otherConfigurationPropertiesSchema,
2115
2644
  partialFeedbackSchema,
2645
+ paymentsUpiAmountConfigSchema,
2646
+ paymentsUpiQuestionSchema,
2647
+ paymentsUpiQuestionTranslationSchema,
2116
2648
  phoneNumberQuestionSchema,
2117
2649
  pictureChoiceQuestionSchema,
2118
2650
  positionSchema,
2119
2651
  previousButtonModeSchema,
2120
2652
  publicationStatusSchema,
2121
2653
  qnaWithAiQuestionSchema,
2654
+ qnaWithAiQuestionTranslationSchema,
2122
2655
  queryOutputSchema,
2123
2656
  questionCentricTranslationsSchema,
2124
2657
  questionOptionSchema,
@@ -2146,6 +2679,7 @@ export {
2146
2679
  responseSchema,
2147
2680
  schedulerProviderSchema,
2148
2681
  schedulerQuestionSchema,
2682
+ schedulerQuestionTranslationSchema,
2149
2683
  sectionLayoutSchema,
2150
2684
  sectionLayoutVariantSchema,
2151
2685
  sectionSchema,
@@ -2157,6 +2691,7 @@ export {
2157
2691
  shortAnswerQuestionTranslationSchema,
2158
2692
  signatureModeSchema,
2159
2693
  signatureQuestionSchema,
2694
+ signatureQuestionTranslationSchema,
2160
2695
  singleChoiceQuestionTranslationSchema,
2161
2696
  splitLayoutSchema,
2162
2697
  stackLayoutSchema,
@@ -2180,6 +2715,7 @@ export {
2180
2715
  videoAttachmentSchema,
2181
2716
  videoAudioModeSchema,
2182
2717
  videoAudioQuestionSchema,
2718
+ videoAudioQuestionTranslationSchema,
2183
2719
  visibilityConditionSchema,
2184
2720
  wallpaperLayoutSchema,
2185
2721
  websiteQuestionSchema,