@encatch/schema 0.1.10 → 0.1.12

package/dist/esm/index.js

@@ -13,34 +13,67 @@ var questionTypeSchema = z.enum([
   "long_text",
   "annotation"
 ]).describe("Enumeration of all supported question types for form fields");
+var QuestionTypes = {
+  RATING: questionTypeSchema.options[0],
+  SINGLE_CHOICE: questionTypeSchema.options[1],
+  NPS: questionTypeSchema.options[2],
+  NESTED_SELECTION: questionTypeSchema.options[3],
+  MULTIPLE_CHOICE_MULTIPLE: questionTypeSchema.options[4],
+  SHORT_ANSWER: questionTypeSchema.options[5],
+  LONG_TEXT: questionTypeSchema.options[6],
+  ANNOTATION: questionTypeSchema.options[7]
+};
+var validationRuleTypeSchema = z.enum([
+  "required",
+  "min",
+  "max",
+  "minLength",
+  "maxLength",
+  "pattern",
+  "email",
+  "url",
+  "custom"
+]).describe("Enumeration of all supported validation rule types");
+var ValidationRuleTypes = {
+  REQUIRED: validationRuleTypeSchema.options[0],
+  MIN: validationRuleTypeSchema.options[1],
+  MAX: validationRuleTypeSchema.options[2],
+  MIN_LENGTH: validationRuleTypeSchema.options[3],
+  MAX_LENGTH: validationRuleTypeSchema.options[4],
+  PATTERN: validationRuleTypeSchema.options[5],
+  EMAIL: validationRuleTypeSchema.options[6],
+  URL: validationRuleTypeSchema.options[7],
+  CUSTOM: validationRuleTypeSchema.options[8]
+};
 var validationRuleSchema = z.object({
-  type: z.enum([
-    "required",
-    "min",
-    "max",
-    "minLength",
-    "maxLength",
-    "pattern",
-    "email",
-    "url",
-    "custom"
-  ]).describe("Type of validation rule to apply"),
+  type: validationRuleTypeSchema.describe("Type of validation rule to apply"),
   value: z.union([z.string(), z.number(), z.boolean()]).optional().describe("Value for the validation rule (string, number, or boolean)"),
   message: z.string().optional().describe("Custom error message when validation fails"),
   describe: z.string().max(500).optional().describe("LLM tool call description for this validation rule")
 }).describe("Schema defining validation rules for question responses");
+var visibilityConditionOperatorSchema = z.enum([
+  "equals",
+  "not_equals",
+  "contains",
+  "not_contains",
+  "greater_than",
+  "less_than",
+  "is_empty",
+  "is_not_empty"
+]).describe("Enumeration of all supported visibility condition operators");
+var VisibilityConditionOperators = {
+  EQUALS: visibilityConditionOperatorSchema.options[0],
+  NOT_EQUALS: visibilityConditionOperatorSchema.options[1],
+  CONTAINS: visibilityConditionOperatorSchema.options[2],
+  NOT_CONTAINS: visibilityConditionOperatorSchema.options[3],
+  GREATER_THAN: visibilityConditionOperatorSchema.options[4],
+  LESS_THAN: visibilityConditionOperatorSchema.options[5],
+  IS_EMPTY: visibilityConditionOperatorSchema.options[6],
+  IS_NOT_EMPTY: visibilityConditionOperatorSchema.options[7]
+};
 var visibilityConditionSchema = z.object({
   field: z.string().describe("ID of the field to check against"),
-  operator: z.enum([
-    "equals",
-    "not_equals",
-    "contains",
-    "not_contains",
-    "greater_than",
-    "less_than",
-    "is_empty",
-    "is_not_empty"
-  ]).describe("Comparison operator for the condition"),
+  operator: visibilityConditionOperatorSchema.describe("Comparison operator for the condition"),
   value: z.union([z.string(), z.number(), z.boolean()]).optional().describe("Value to compare against (string, number, or boolean)"),
   describe: z.string().max(500).optional().describe("LLM tool call description for this visibility condition")
 }).describe(
@@ -52,6 +85,12 @@ var sectionSchema = z.object({
   question_ids: z.array(z.string()).min(1).describe("Array of question IDs that belong to this section")
 }).describe("Schema defining sections that organize questions into logical groups");
 var questionStatusSchema = z.enum(["D", "P", "A", "S"]);
+var QuestionStatuses = {
+  DRAFT: questionStatusSchema.options[0],
+  PUBLISHED: questionStatusSchema.options[1],
+  ARCHIVED: questionStatusSchema.options[2],
+  SUSPENDED: questionStatusSchema.options[3]
+};
 var ratingDisplayStyleSchema = z.enum([
   "star",
   "heart",
@@ -60,22 +99,46 @@ var ratingDisplayStyleSchema = z.enum([
   "emoji",
   "emoji-exp"
 ]);
+var RatingDisplayStyles = {
+  STAR: ratingDisplayStyleSchema.options[0],
+  HEART: ratingDisplayStyleSchema.options[1],
+  THUMBS_UP: ratingDisplayStyleSchema.options[2],
+  DIAMOND: ratingDisplayStyleSchema.options[3],
+  EMOJI: ratingDisplayStyleSchema.options[4],
+  EMOJI_EXP: ratingDisplayStyleSchema.options[5]
+};
 var ratingRepresentationSizeSchema = z.enum([
   "small",
   "medium",
   "large"
 ]);
+var RatingRepresentationSizes = {
+  SMALL: ratingRepresentationSizeSchema.options[0],
+  MEDIUM: ratingRepresentationSizeSchema.options[1],
+  LARGE: ratingRepresentationSizeSchema.options[2]
+};
 var multipleChoiceDisplayStyleSchema = z.enum([
   "radio",
   "list",
   "chip",
   "dropdown"
 ]);
+var MultipleChoiceDisplayStyles = {
+  RADIO: multipleChoiceDisplayStyleSchema.options[0],
+  LIST: multipleChoiceDisplayStyleSchema.options[1],
+  CHIP: multipleChoiceDisplayStyleSchema.options[2],
+  DROPDOWN: multipleChoiceDisplayStyleSchema.options[3]
+};
 var multipleChoiceMultipleDisplayStyleSchema = z.enum([
   "checkbox",
   "list",
   "chip"
 ]);
+var MultipleChoiceMultipleDisplayStyles = {
+  CHECKBOX: multipleChoiceMultipleDisplayStyleSchema.options[0],
+  LIST: multipleChoiceMultipleDisplayStyleSchema.options[1],
+  CHIP: multipleChoiceMultipleDisplayStyleSchema.options[2]
+};
 var choiceOrderOptionSchema = z.enum([
   "randomize",
   "flip",
@@ -83,6 +146,13 @@ var choiceOrderOptionSchema = z.enum([
   "ascending",
   "none"
 ]);
+var ChoiceOrderOptions = {
+  RANDOMIZE: choiceOrderOptionSchema.options[0],
+  FLIP: choiceOrderOptionSchema.options[1],
+  ROTATE: choiceOrderOptionSchema.options[2],
+  ASCENDING: choiceOrderOptionSchema.options[3],
+  NONE: choiceOrderOptionSchema.options[4]
+};
 var questionSchema = z.object({
   id: z.string().describe("Unique identifier for the question"),
   type: questionTypeSchema.describe(
@@ -104,7 +174,7 @@ var questionSchema = z.object({
   )
 }).describe("Base schema for all question types with common properties");
 var ratingQuestionSchema = questionSchema.extend({
-  type: z.literal(questionTypeSchema.enum.rating).describe("Must be exactly 'rating'"),
+  type: z.literal("rating").describe("Must be exactly 'rating'"),
   showLabels: z.boolean().optional().describe("Whether to show min/max labels"),
   minLabel: z.string().max(100).optional().describe("Label for the minimum rating value"),
   maxLabel: z.string().max(100).optional().describe("Label for the maximum rating value"),
@@ -114,7 +184,7 @@ var ratingQuestionSchema = questionSchema.extend({
   color: z.string().regex(/^#[0-9A-F]{6}$/i, "Must be a valid hex color").optional().describe("Hex color for rating elements")
 }).describe("Schema for rating questions with customizable display options");
 var annotationQuestionSchema = questionSchema.extend({
-  type: z.literal(questionTypeSchema.enum.annotation).describe("Must be exactly 'annotation'"),
+  type: z.literal("annotation").describe("Must be exactly 'annotation'"),
   annotationText: z.string().max(1e3).optional().describe("Text to display when annotation is provided"),
   noAnnotationText: z.string().max(500).optional().describe("Text to display when no annotation is provided")
 }).describe(
@@ -143,13 +213,13 @@ var nestedOptionSchema = z.lazy(
   }).describe("Schema for nested options with hierarchical structure support")
 );
 var multipleChoiceSingleQuestionSchema = questionSchema.extend({
-  type: z.literal(questionTypeSchema.enum.single_choice).describe("Must be exactly 'single_choice'"),
+  type: z.literal("single_choice").describe("Must be exactly 'single_choice'"),
   displayStyle: multipleChoiceDisplayStyleSchema.optional().describe("Visual style for displaying options"),
   randomizeOptions: z.boolean().optional().default(false).describe("Whether to randomize the order of options"),
   options: z.array(questionOptionSchema).min(1).max(50).describe("Array of options for user selection (1-50 options)")
 }).describe("Schema for single-choice multiple selection questions");
 var multipleChoiceMultipleQuestionSchema = questionSchema.extend({
-  type: z.literal(questionTypeSchema.enum.multiple_choice_multiple).describe("Must be exactly 'multiple_choice_multiple'"),
+  type: z.literal("multiple_choice_multiple").describe("Must be exactly 'multiple_choice_multiple'"),
   displayStyle: multipleChoiceMultipleDisplayStyleSchema.optional().describe("Visual style for displaying multiple options"),
   minSelections: z.number().int().min(0).optional().describe("Minimum number of options that must be selected"),
   maxSelections: z.number().int().min(1).optional().describe("Maximum number of options that can be selected"),
@@ -171,7 +241,7 @@ var multipleChoiceMultipleQuestionSchema = questionSchema.extend({
   "Schema for multiple-choice questions allowing multiple selections"
 );
 var npsQuestionSchema = questionSchema.extend({
-  type: z.literal(questionTypeSchema.enum.nps).describe("Must be exactly 'nps'"),
+  type: z.literal("nps").describe("Must be exactly 'nps'"),
   min: z.literal(0).describe("NPS always starts at 0"),
   max: z.literal(10).describe("NPS always ends at 10"),
   minLabel: z.string().max(100).optional().describe("Label for the minimum NPS value (0)"),
@@ -195,7 +265,7 @@ var npsQuestionSchema = questionSchema.extend({
   }
 ).describe("Schema for Net Promoter Score questions with 0-10 scale");
 var shortAnswerQuestionSchema = questionSchema.extend({
-  type: z.literal(questionTypeSchema.enum.short_answer).describe("Must be exactly 'short_answer'"),
+  type: z.literal("short_answer").describe("Must be exactly 'short_answer'"),
   maxCharacters: z.number().int().min(1).max(1e4).optional().describe("Maximum number of characters allowed"),
   minCharacters: z.number().int().min(0).optional().describe("Minimum number of characters required"),
   placeholder: z.string().max(200).optional().describe("Placeholder text shown in the input field"),
@@ -242,7 +312,7 @@ var shortAnswerQuestionSchema = questionSchema.extend({
   }
 ).describe("Schema for short answer questions with optional AI enhancement");
 var longAnswerQuestionSchema = questionSchema.extend({
-  type: z.literal(questionTypeSchema.enum.long_text).describe("Must be exactly 'long_text'"),
+  type: z.literal("long_text").describe("Must be exactly 'long_text'"),
   maxCharacters: z.number().int().min(1).max(5e4).optional().describe(
     "Maximum number of characters allowed (higher limit for long text)"
   ),
@@ -282,7 +352,7 @@ var longAnswerQuestionSchema = questionSchema.extend({
   "Schema for long answer questions with rich text support and AI enhancement"
 );
 var nestedDropdownQuestionSchema = questionSchema.extend({
-  type: z.literal(questionTypeSchema.enum.nested_selection).describe("Must be exactly 'nested_selection'"),
+  type: z.literal("nested_selection").describe("Must be exactly 'nested_selection'"),
   placeholder: z.string().max(200).optional().describe("Placeholder text for the nested dropdown"),
   options: z.array(nestedOptionSchema).min(1).max(100).describe(
     "Array of nested options for hierarchical selection (1-100 options)"
@@ -404,8 +474,24 @@ var AnswerSchema = z2.discriminatedUnion("type", [
 // src/schemas/fields/form-schema.ts
 import { z as z3 } from "zod";
 var surveyTypeSchema = z3.enum(["R", "O"]).describe("Enumeration of feedback types: R=Recurring, O=One-time");
+var SurveyTypes = {
+  RECURRING: surveyTypeSchema.options[0],
+  ONE_TIME: surveyTypeSchema.options[1]
+};
 var yesNoSchema = z3.enum(["Y", "N"]).describe("Yes/No enumeration using Y/N values");
+var YesNoValues = {
+  YES: yesNoSchema.options[0],
+  NO: yesNoSchema.options[1]
+};
 var recurringUnitSchema = z3.enum(["minutes", "hours", "days", "weeks", "months", "years"]).describe("Time units for recurring feedback schedules");
+var RecurringUnits = {
+  MINUTES: recurringUnitSchema.options[0],
+  HOURS: recurringUnitSchema.options[1],
+  DAYS: recurringUnitSchema.options[2],
+  WEEKS: recurringUnitSchema.options[3],
+  MONTHS: recurringUnitSchema.options[4],
+  YEARS: recurringUnitSchema.options[5]
+};
 var frequencyAndSchedulingPropertiesSchema = z3.object({
   surveyType: surveyTypeSchema.describe("Type of feedback: R for recurring, O for one-time"),
   showOnce: yesNoSchema.describe("Whether the feedback should be shown only once per user"),
@@ -459,6 +545,11 @@ var externalPublishingPropertiesSchema = z3.object({
   isEmailShareable: z3.boolean().describe("Whether the feedback can be shared via email")
 }).describe("Schema defining external publishing and sharing properties for feedback");
 var publicationStatusSchema = z3.enum(["P", "D", "A"]).describe("Publication status: P=Published, D=Draft, A=Archived");
+var PublicationStatuses = {
+  PUBLISHED: publicationStatusSchema.options[0],
+  DRAFT: publicationStatusSchema.options[1],
+  ARCHIVED: publicationStatusSchema.options[2]
+};
 var feedbackConfigurationSchema = z3.object({
   form_title: z3.string().describe("Title of the feedback form"),
   form_description: z3.string().describe("Description of the feedback form"),
@@ -644,6 +735,11 @@ __name(createTranslationProvider, "createTranslationProvider");
 
 // src/schemas/fields/other-screen-schema.ts
 import { z as z5 } from "zod";
+var dismissBehaviorSchema = z5.enum(["fade", "manual"]).describe("How the end screen should be dismissed (fade out or manual dismissal)");
+var DismissBehaviors = {
+  FADE: dismissBehaviorSchema.options[0],
+  MANUAL: dismissBehaviorSchema.options[1]
+};
 var WelcomeScreenFieldsSchema = z5.object({
   title: z5.string().min(1).max(200).describe("The main title displayed on the welcome screen"),
   description: z5.string().min(1).max(1e3).describe("Description text shown on the welcome screen"),
@@ -653,7 +749,7 @@ var EndScreenFieldsSchema = z5.object({
   title: z5.string().min(1).max(200).describe("The main title displayed on the end screen"),
   message: z5.string().min(1).max(1e3).describe("Message text shown on the end screen"),
   buttonLabel: z5.string().min(1).max(50).describe("Text displayed on the end screen button"),
-  dismissBehavior: z5.enum(["fade", "manual"]).describe("How the end screen should be dismissed (fade out or manual dismissal)"),
+  dismissBehavior: dismissBehaviorSchema.describe("How the end screen should be dismissed (fade out or manual dismissal)"),
   fadeDuration: z5.number().int().min(0).max(1e4).describe("Duration in milliseconds for fade dismissal (0-10000)")
 }).describe("Schema for end screen configuration fields");
 var WelcomeFieldsTranslationSchema = z5.object({
@@ -700,7 +796,22 @@ var positionSchema = z6.enum([
   "bottom-center",
   "bottom-right"
 ]).describe("Available positions for widget placement");
+var Positions = {
+  TOP_LEFT: positionSchema.options[0],
+  TOP_CENTER: positionSchema.options[1],
+  TOP_RIGHT: positionSchema.options[2],
+  MIDDLE_LEFT: positionSchema.options[3],
+  MIDDLE_CENTER: positionSchema.options[4],
+  MIDDLE_RIGHT: positionSchema.options[5],
+  BOTTOM_LEFT: positionSchema.options[6],
+  BOTTOM_CENTER: positionSchema.options[7],
+  BOTTOM_RIGHT: positionSchema.options[8]
+};
 var themeModeSchema = z6.enum(["light", "dark"]).describe("Available theme modes for the widget");
+var ThemeModes = {
+  LIGHT: themeModeSchema.options[0],
+  DARK: themeModeSchema.options[1]
+};
 var featureSettingsSchema = z6.object({
   darkOverlay: z6.boolean().describe("Whether to show a dark overlay behind the widget"),
   closeButton: z6.boolean().describe("Whether to display a close button on the widget"),
@@ -759,13 +870,13 @@ var otherConfigurationPropertiesSchema = z8.discriminatedUnion("isEnabled", [
   z8.object({
     isEnabled: z8.literal(false).describe("Whether other configuration properties are enabled"),
     otherFields: OtherFieldsSchema.optional().describe("Other form configuration fields including pagination, buttons, and display options"),
-    translations: OtherFieldsTranslationSchema.optional().describe("Translations for other configuration field labels and buttons")
+    translations: z8.record(z8.string(), OtherFieldsTranslationSchema).optional().describe("Translations for other configuration field labels and buttons keyed by language code")
   }),
   // When other configuration is enabled
   z8.object({
     isEnabled: z8.literal(true).describe("Whether other configuration properties are enabled"),
     otherFields: OtherFieldsSchema.describe("Other form configuration fields including pagination, buttons, and display options"),
-    translations: OtherFieldsTranslationSchema.describe("Translations for other configuration field labels and buttons")
+    translations: z8.record(z8.string(), OtherFieldsTranslationSchema).describe("Translations for other configuration field labels and buttons keyed by language code")
   })
 ]).describe("Schema for other configuration properties including fields and translations");
 var welcomeScreenPropertiesSchema = z8.discriminatedUnion("isEnabled", [
@@ -773,13 +884,13 @@ var welcomeScreenPropertiesSchema = z8.discriminatedUnion("isEnabled", [
   z8.object({
     isEnabled: z8.literal(false).describe("Whether welcome screen is enabled"),
     welcomeFields: WelcomeScreenFieldsSchema.optional().describe("Welcome screen configuration fields including title, description, and button label"),
-    translations: WelcomeFieldsTranslationSchema.optional().describe("Translations for welcome screen content")
+    translations: z8.record(z8.string(), WelcomeFieldsTranslationSchema).optional().describe("Translations for welcome screen content keyed by language code")
   }),
   // When welcome screen is enabled
   z8.object({
     isEnabled: z8.literal(true).describe("Whether welcome screen is enabled"),
     welcomeFields: WelcomeScreenFieldsSchema.describe("Welcome screen configuration fields including title, description, and button label"),
-    translations: WelcomeFieldsTranslationSchema.describe("Translations for welcome screen content")
+    translations: z8.record(z8.string(), WelcomeFieldsTranslationSchema).describe("Translations for welcome screen content keyed by language code")
   })
 ]).describe("Schema for welcome screen properties including fields and translations");
 var endScreenPropertiesSchema = z8.discriminatedUnion("isEnabled", [
@@ -787,13 +898,13 @@ var endScreenPropertiesSchema = z8.discriminatedUnion("isEnabled", [
   z8.object({
     isEnabled: z8.literal(false).describe("Whether end screen is enabled"),
     endFields: EndScreenFieldsSchema.optional().describe("End screen configuration fields including title, message, button label, and dismissal behavior"),
-    translations: EndFieldsTranslationSchema.optional().describe("Translations for end screen content")
+    translations: z8.record(z8.string(), EndFieldsTranslationSchema).optional().describe("Translations for end screen content keyed by language code")
   }),
   // When end screen is enabled
   z8.object({
     isEnabled: z8.literal(true).describe("Whether end screen is enabled"),
     endFields: EndScreenFieldsSchema.describe("End screen configuration fields including title, message, button label, and dismissal behavior"),
-    translations: EndFieldsTranslationSchema.describe("Translations for end screen content")
+    translations: z8.record(z8.string(), EndFieldsTranslationSchema).describe("Translations for end screen content keyed by language code")
   })
 ]).describe("Schema for end screen properties including fields and translations");
 var appearancePropertiesSchema = z8.object({
@@ -822,21 +933,37 @@ import { z as z9 } from "zod";
 export {
   AnswerSchema,
   ChoiceAnswerSchema,
+  ChoiceOrderOptions,
   ContinuousSumAnswerSchema,
+  DismissBehaviors,
   EndFieldsTranslationSchema,
   EndScreenFieldsSchema,
   LanguageFieldSchema,
   LanguagesSchema,
   MultipleChoiceAnswerSchema,
+  MultipleChoiceDisplayStyles,
+  MultipleChoiceMultipleDisplayStyles,
   OtherFieldsSchema,
   OtherFieldsTranslationSchema,
+  Positions,
+  PublicationStatuses,
+  QuestionStatuses,
+  QuestionTypes,
   RankingAnswerSchema,
+  RatingDisplayStyles,
+  RatingRepresentationSizes,
+  RecurringUnits,
   ScaleAnswerSchema,
   SimpleAnswerSchema,
+  SurveyTypes,
   TextAnswerSchema,
+  ThemeModes,
   TranslationProvider,
+  ValidationRuleTypes,
+  VisibilityConditionOperators,
   WelcomeFieldsTranslationSchema,
   WelcomeScreenFieldsSchema,
+  YesNoValues,
   annotationQuestionSchema,
   annotationTranslationsSchema,
   appearancePropertiesSchema,
@@ -845,6 +972,7 @@ export {
   choiceOrderOptionSchema,
   combinedQuestionSchema,
   createTranslationProvider,
+  dismissBehaviorSchema,
   endScreenPropertiesSchema,
   externalPublishingPropertiesSchema,
   featureSettingsSchema,
@@ -884,10 +1012,12 @@ export {
   surveyTypeSchema,
   themeColorsSchema,
   themeConfigurationSchema,
+  themeModeSchema,
   themesSchema,
   translationEntrySchema,
   translationsSchema,
   validationRuleSchema,
+  validationRuleTypeSchema,
   visibilityConditionSchema,
   welcomeScreenPropertiesSchema,
   yesNoSchema,