@encatch/schema 1.2.0-beta.2 → 1.2.0-beta.4

package/dist/esm/index.js

@@ -930,12 +930,12 @@ var csatQuestionSchema = questionSchema.extend({
   scale: csatScaleSchema.optional().default(5).describe("Number of response points (2\u20135); 2 and 4 have no neutral option, default is 5"),
   displayStyle: csatDisplayStyleSchema.optional().default("emoji").describe("How response options are rendered \u2014 emoji faces (default) or text buttons"),
   multicolor: z2.boolean().optional().default(false).describe("Whether to apply distinct colors to negative, neutral, and positive segments"),
-  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"),
-  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"),
-  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"),
+  negativeColor: z2.string().max(50).optional().describe("Color for negative response options (lower half of scale); any valid CSS color; used when multicolor is true"),
+  neutralColor: z2.string().max(50).optional().describe("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"),
+  positiveColor: z2.string().max(50).optional().describe("Color for positive response options (upper half of scale); any valid CSS color; used when multicolor is true"),
   showLabels: z2.boolean().optional().default(false).describe("Whether to render per-point labels below each response option"),
-  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')")
-}).describe("Schema for a CSAT (Customer Satisfaction Score) question using a 2\u20135 point semantic scale");
+  scaleLabels: z2.record(z2.string(), z2.string().max(100)).optional().describe("Per-point label text keyed by value string ('1'\u2013'5'); keys must match the chosen scale size")
+}).describe("Schema for a CSAT (Customer Satisfaction Score) question using an industry-standard 1-to-N positive scale (N = 2\u20135)");
 var opinionScaleQuestionSchema = questionSchema.extend({
   type: z2.literal("opinion_scale").describe("Must be exactly 'opinion_scale'"),
   startValue: z2.union([z2.literal(0), z2.literal(1)]).optional().default(0).describe("Starting value of the scale \u2014 0 (default) or 1"),
@@ -1185,23 +1185,29 @@ var QnaWithAiPairSchema = z3.object({
   answer: z3.string().describe("The AI-generated answer based on the knowledge base")
 }).describe("A single Q&A exchange between the respondent and the AI");
 var QnaWithAiAnswerSchema = z3.array(QnaWithAiPairSchema).describe("Answer for a qna_with_ai question; ordered transcript of Q&A pairs from the session");
-var SchedulerAnswerSchema = z3.object({
-  provider: z3.enum(["google_calendar", "calendly"]).describe("The calendar integration used to make the booking"),
-  slotStart: z3.string().describe("ISO 8601 datetime of the booked slot start (e.g. '2026-05-15T14:00:00Z')"),
-  slotEnd: z3.string().describe("ISO 8601 datetime of the booked slot end (e.g. '2026-05-15T14:30:00Z')"),
-  eventId: z3.string().optional().describe("Calendar event ID (Google Calendar) or Calendly event UUID"),
-  bookedAt: z3.string().describe("ISO 8601 datetime when the respondent completed the booking")
-}).describe("Answer for a scheduler question");
+var SchedulerAnswerSchema = z3.discriminatedUnion("provider", [
+  z3.object({
+    provider: z3.literal("google_calendar").describe("The calendar integration used to make the booking"),
+    bookedAt: z3.string().describe("Unix timestamp in seconds as a string when the respondent confirmed the booking")
+  }),
+  z3.object({
+    provider: z3.literal("calendly").describe("The calendar integration used to make the booking"),
+    slotStart: z3.string().describe("ISO 8601 datetime of the booked slot start (e.g. '2026-05-15T14:00:00Z')"),
+    slotEnd: z3.string().describe("ISO 8601 datetime of the booked slot end (e.g. '2026-05-15T14:30:00Z')"),
+    eventId: z3.string().optional().describe("Calendly event UUID"),
+    bookedAt: z3.string().describe("Unix timestamp in seconds as a string when the respondent completed the booking")
+  })
+]).describe("Answer for a scheduler question");
 var AnswerItemSchema = z3.object({
   nps: z3.number().optional().describe("Net Promoter Score value (e.g., 0-10)"),
   nestedSelection: z3.array(z3.string()).optional().describe("Array of selected nested option IDs"),
   longText: z3.string().optional().describe("Long text answer, e.g., paragraph or essay"),
   shortAnswer: z3.string().optional().describe("Short text answer, e.g., single sentence or word"),
-  singleChoice: z3.string().optional().describe("single selected option ID (for single choice questions)"),
+  singleChoice: z3.string().optional().describe("Single selected option value for single choice questions"),
   rating: z3.number().optional().describe("Star rating value (e.g., 1-5)"),
   yesNo: z3.boolean().optional().describe("Yes/no answer for yes_no questions (true = Yes, false = No)"),
   consent: z3.boolean().optional().describe("Consent answer for consent questions (true = checked/agreed, false = unchecked)"),
-  multipleChoiceMultiple: z3.array(z3.string()).optional().describe("Array of selected option IDs for multiple choice questions"),
+  multipleChoiceMultiple: z3.array(z3.string()).optional().describe("Array of selected option values for multiple choice questions"),
   singleChoiceOther: z3.string().optional().describe('Free-text "other" answer for single choice questions when allowOther is enabled'),
   multipleChoiceOther: z3.string().optional().describe('Free-text "other" answer for multiple choice questions when allowOther is enabled'),
   annotation: AnnotationSchema.optional().describe(
@@ -1222,15 +1228,14 @@ var AnswerItemSchema = z3.object({
   // Date question
   date: z3.string().optional().describe("Answer for a date question; ISO 8601 format (YYYY-MM-DD or YYYY-MM-DDTHH:MM)"),
   // CSAT question
-  csat: z3.number().optional().describe("Answer for a CSAT question; semantic value: -2, -1, 0, 1, or 2"),
+  csat: z3.number().optional().describe("Answer for a CSAT question; industry-standard value: 1 (lowest/worst) to N (highest/best) where N is the scale size (2\u20135)"),
   // Opinion scale question
   opinionScale: z3.number().optional().describe("Answer for an opinion scale question; the selected numeric value on the scale"),
-  // Ranking question — ordered array of option IDs; index 0 = rank 1
-  ranking: z3.array(z3.string()).optional().describe("Answer for a ranking question; ordered array of option IDs where index 0 is rank 1"),
-  // Picture choice — single selection
-  pictureChoice: z3.string().optional().describe("Answer for a picture choice question (single selection); the selected option ID"),
-  // Picture choice — multiple selection
-  pictureChoiceMultiple: z3.array(z3.string()).optional().describe("Answer for a picture choice question (multiple selection); array of selected option IDs"),
+  // Ranking question — ordered array of option values; index 0 = rank 1
+  ranking: z3.array(z3.string()).optional().describe("Answer for a ranking question; ordered array of option values where index 0 is rank 1"),
+  // Picture choice — always an array of selected option values (single selection = one-element array)
+  pictureChoice: z3.array(z3.string()).optional().describe("Answer for a picture choice question; array of selected option values (single selection produces a one-element array)"),
+  pictureChoiceOther: z3.string().optional().describe('Free-text "other" answer for picture choice questions when allowOther is enabled'),
   // Signature question
   signature: SignatureAnswerSchema.optional().describe("Answer for a signature question"),
   // File upload question
@@ -1238,7 +1243,7 @@ var AnswerItemSchema = z3.object({
   // Email question
   email: z3.string().optional().describe("Answer for an email question; the submitted email address"),
   // Number question
-  number: z3.number().optional().describe("Answer for a number question; the submitted numeric value"),
+  number: z3.string().optional().describe("Answer for a number question; the submitted numeric value as a string"),
   // Website question
   website: z3.string().optional().describe("Answer for a website question; the submitted URL"),
   // Phone number question
@@ -1799,8 +1804,11 @@ var fetchFeedbackDetailsSchema = z13.object({
 }).strict().describe("Request schema for fetching specific feedback form details");
 var formConfigurationResponseSchema = z13.object({
   formTitle: z13.string().describe("Title of the feedback form"),
-  formDescription: z13.string().describe("Description of the feedback form")
-}).describe("Form configuration response with title and description");
+  formDescription: z13.string().describe("Description of the feedback form"),
+  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 welcome badge"
+  )
+}).describe("Form configuration response with title, description, and optional respondent count");
 var logicJumpRuleSchema = z13.object({
   jsonLogic: z13.record(z13.string(), z13.unknown()).describe("JSON Logic expression to evaluate"),
   targetQuestionId: z13.string().describe("Question ID to navigate to when this rule matches")
@@ -1832,7 +1840,7 @@ var fetchFeedbackDetailsResponseSchema = z13.object({
   feedbackConfigurationId: z13.string().uuid().describe("Unique identifier for the feedback configuration"),
   feedbackIdentifier: z13.string().uuid().describe("Unique identifier for this specific feedback instance"),
   formConfiguration: formConfigurationResponseSchema.describe(
-    "Form configuration with title and description"
+    "Form configuration including title, description, and optional respondent count for the welcome badge"
   ),
   questionnaireFields: questionnaireFieldsResponseSchema.describe(
     "Questionnaire structure including questions, sections, translations, and languages"
@@ -1842,8 +1850,7 @@ var fetchFeedbackDetailsResponseSchema = z13.object({
   ),
   appearanceProperties: appearancePropertiesSchema.describe(
     "Appearance properties including theme configuration"
-  ),
-  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")
+  )
 }).strict().describe(
   "Complete response schema for fetchFeedbackDetails API using existing field schemas"
 );