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

package/dist/esm/index.js

@@ -160,6 +160,7 @@ var questionSchema = z.object({
   ),
   title: z.string().min(1).max(200).describe("The main title/question text displayed to users"),
   description: z.string().max(1e3).optional().describe("Optional detailed description or help text"),
+  descriptionMarkdown: z.string().max(5e3).optional().describe("Optional description in Markdown format"),
   describe: z.string().max(2e3).optional().describe(
     "LLM tool call description for better AI understanding and context"
   ),
@@ -285,8 +286,6 @@ var shortAnswerQuestionSchema = questionSchema.extend({
   regexPattern: z.string().optional().describe("Regular expression pattern for validation"),
   enableEnhanceWithAi: z.boolean().optional().default(false).describe("Whether to enable AI enhancement features"),
   promptTemplate: z.string().max(2e3).optional().describe("Template for AI enhancement prompts"),
-  cooldownSeconds: z.number().int().min(0).max(3600).optional().describe("Cooldown period between AI enhancements (0-3600 seconds)"),
-  maxEnhancements: z.number().int().min(1).max(10).optional().describe("Maximum number of AI enhancements allowed"),
   maxTokenAllowed: z.number().int().min(1).max(1e4).optional().describe("Maximum tokens allowed for AI processing"),
   minCharactersToEnhance: z.number().int().min(1).optional().describe("Minimum characters needed to trigger AI enhancement")
 }).refine(
@@ -333,8 +332,6 @@ var longAnswerQuestionSchema = questionSchema.extend({
   placeholder: z.string().max(500).optional().describe("Placeholder text for the textarea (longer for long text)"),
   enableEnhanceWithAi: z.boolean().optional().default(false).describe("Whether to enable AI enhancement features"),
   promptTemplate: z.string().max(2e3).optional().describe("Template for AI enhancement prompts"),
-  cooldownSeconds: z.number().int().min(0).max(3600).optional().describe("Cooldown period between AI enhancements (0-3600 seconds)"),
-  maxEnhancements: z.number().int().min(1).max(10).optional().describe("Maximum number of AI enhancements allowed"),
   maxTokenAllowed: z.number().int().min(1).max(25e3).optional().describe(
     "Maximum tokens allowed for AI processing (higher for long text)"
   ),
@@ -559,90 +556,83 @@ import { z as z8 } from "zod";
 // src/schemas/fields/translations-schema.ts
 import { z as z4 } from "zod";
 var translationEntrySchema = z4.string().min(1).describe("Translated text content");
-var ratingQuestionTranslationSchema = z4.object({
-  type: z4.literal("rating").describe("Question type identifier"),
+var baseQuestionTranslationFieldsSchema = z4.object({
   title: translationEntrySchema.describe("Question title translation"),
   description: translationEntrySchema.optional().describe("Question description translation"),
-  errorMessage: translationEntrySchema.optional().describe("Error message translation"),
+  descriptionMarkdown: translationEntrySchema.optional().describe("Question description Markdown translation"),
+  errorMessage: translationEntrySchema.optional().describe("Error message translation")
+});
+var BASE_QUESTION_TRANSLATION_KEYS = [
+  "type",
+  "title",
+  "description",
+  "descriptionMarkdown",
+  "errorMessage"
+];
+var ratingQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
+  type: z4.literal("rating").describe("Question type identifier"),
   minLabel: translationEntrySchema.optional().describe("Minimum rating label translation"),
   maxLabel: translationEntrySchema.optional().describe("Maximum rating label translation")
 }).describe("Translation schema for rating questions");
-var singleChoiceQuestionTranslationSchema = z4.object({
+var singleChoiceQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
   type: z4.literal("single_choice").describe("Question type identifier"),
-  title: translationEntrySchema.describe("Question title translation"),
-  description: translationEntrySchema.optional().describe("Question description translation"),
-  errorMessage: translationEntrySchema.optional().describe("Error message translation"),
   placeholder: translationEntrySchema.optional().describe("Input placeholder translation")
-}).catchall(translationEntrySchema).refine((data) => {
-  const additionalKeys = Object.keys(data).filter(
-    (key) => !["type", "title", "description", "errorMessage", "placeholder"].includes(key)
-  );
-  return additionalKeys.every((key) => /^option\..+\.(label|value)$/.test(key));
-}, {
-  message: "Additional keys must follow the pattern 'option.{id}.{label|value}'"
-}).describe("Translation schema for single choice questions");
-var multipleChoiceQuestionTranslationSchema = z4.object({
+}).catchall(translationEntrySchema).refine(
+  (data) => {
+    const additionalKeys = Object.keys(data).filter(
+      (key) => ![...BASE_QUESTION_TRANSLATION_KEYS, "placeholder"].includes(key)
+    );
+    return additionalKeys.every((key) => /^option\..+\.(label|value)$/.test(key));
+  },
+  { message: "Additional keys must follow the pattern 'option.{id}.{label|value}'" }
+).describe("Translation schema for single choice questions");
+var multipleChoiceQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
   type: z4.literal("multiple_choice_multiple").describe("Question type identifier"),
-  title: translationEntrySchema.describe("Question title translation"),
-  description: translationEntrySchema.optional().describe("Question description translation"),
-  errorMessage: translationEntrySchema.optional().describe("Error message translation"),
   placeholder: translationEntrySchema.optional().describe("Input placeholder translation")
-}).catchall(translationEntrySchema).refine((data) => {
-  const additionalKeys = Object.keys(data).filter(
-    (key) => !["type", "title", "description", "errorMessage", "placeholder"].includes(key)
-  );
-  return additionalKeys.every((key) => /^option\..+\.(label|value)$/.test(key));
-}, {
-  message: "Additional keys must follow the pattern 'option.{id}.{label|value}'"
-}).describe("Translation schema for multiple choice questions");
-var npsQuestionTranslationSchema = z4.object({
+}).catchall(translationEntrySchema).refine(
+  (data) => {
+    const additionalKeys = Object.keys(data).filter(
+      (key) => ![...BASE_QUESTION_TRANSLATION_KEYS, "placeholder"].includes(key)
+    );
+    return additionalKeys.every((key) => /^option\..+\.(label|value)$/.test(key));
+  },
+  { message: "Additional keys must follow the pattern 'option.{id}.{label|value}'" }
+).describe("Translation schema for multiple choice questions");
+var npsQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
   type: z4.literal("nps").describe("Question type identifier"),
-  title: translationEntrySchema.describe("Question title translation"),
-  description: translationEntrySchema.optional().describe("Question description translation"),
-  errorMessage: translationEntrySchema.optional().describe("Error message translation"),
   minLabel: translationEntrySchema.optional().describe("Minimum NPS label (0) translation"),
   maxLabel: translationEntrySchema.optional().describe("Maximum NPS label (10) translation")
-}).catchall(translationEntrySchema).refine((data) => {
-  const additionalKeys = Object.keys(data).filter(
-    (key) => !["type", "title", "description", "errorMessage", "minLabel", "maxLabel"].includes(key)
-  );
-  return additionalKeys.every((key) => /^scaleLabel\.\d+$/.test(key));
-}, {
-  message: "Additional keys must follow the pattern 'scaleLabel.{number}'"
-}).describe("Translation schema for NPS questions");
-var shortAnswerQuestionTranslationSchema = z4.object({
+}).catchall(translationEntrySchema).refine(
+  (data) => {
+    const additionalKeys = Object.keys(data).filter(
+      (key) => ![...BASE_QUESTION_TRANSLATION_KEYS, "minLabel", "maxLabel"].includes(key)
+    );
+    return additionalKeys.every((key) => /^scaleLabel\.\d+$/.test(key));
+  },
+  { message: "Additional keys must follow the pattern 'scaleLabel.{number}'" }
+).describe("Translation schema for NPS questions");
+var shortAnswerQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
   type: z4.literal("short_answer").describe("Question type identifier"),
-  title: translationEntrySchema.describe("Question title translation"),
-  description: translationEntrySchema.optional().describe("Question description translation"),
-  errorMessage: translationEntrySchema.optional().describe("Error message translation"),
   placeholder: translationEntrySchema.optional().describe("Input placeholder translation")
 }).describe("Translation schema for short answer questions");
-var longAnswerQuestionTranslationSchema = z4.object({
+var longAnswerQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
   type: z4.literal("long_text").describe("Question type identifier"),
-  title: translationEntrySchema.describe("Question title translation"),
-  description: translationEntrySchema.optional().describe("Question description translation"),
-  errorMessage: translationEntrySchema.optional().describe("Error message translation"),
   placeholder: translationEntrySchema.optional().describe("Textarea placeholder translation")
 }).describe("Translation schema for long answer questions");
-var nestedSelectionQuestionTranslationSchema = z4.object({
+var nestedSelectionQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
   type: z4.literal("nested_selection").describe("Question type identifier"),
-  title: translationEntrySchema.describe("Question title translation"),
-  description: translationEntrySchema.optional().describe("Question description translation"),
-  errorMessage: translationEntrySchema.optional().describe("Error message translation"),
   placeholder: translationEntrySchema.optional().describe("Dropdown placeholder translation")
-}).catchall(translationEntrySchema).refine((data) => {
-  const additionalKeys = Object.keys(data).filter(
-    (key) => !["type", "title", "description", "errorMessage", "placeholder"].includes(key)
-  );
-  return additionalKeys.every((key) => /^nestedOption\..+\.(label|hint)$/.test(key));
-}, {
-  message: "Additional keys must follow the pattern 'nestedOption.{id}.{label|hint}'"
-}).describe("Translation schema for nested selection questions");
-var annotationQuestionTranslationSchema = z4.object({
+}).catchall(translationEntrySchema).refine(
+  (data) => {
+    const additionalKeys = Object.keys(data).filter(
+      (key) => ![...BASE_QUESTION_TRANSLATION_KEYS, "placeholder"].includes(key)
+    );
+    return additionalKeys.every((key) => /^nestedOption\..+\.(label|hint)$/.test(key));
+  },
+  { message: "Additional keys must follow the pattern 'nestedOption.{id}.{label|hint}'" }
+).describe("Translation schema for nested selection questions");
+var annotationQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
   type: z4.literal("annotation").describe("Question type identifier"),
-  title: translationEntrySchema.describe("Question title translation"),
-  description: translationEntrySchema.optional().describe("Question description translation"),
-  errorMessage: translationEntrySchema.optional().describe("Error message translation"),
   annotationText: translationEntrySchema.optional().describe("Annotation display text translation"),
   noAnnotationText: translationEntrySchema.optional().describe("No annotation display text translation")
 }).describe("Translation schema for annotation questions");
@@ -1221,22 +1211,20 @@ var fetchConfigurationListResponseSchema = z12.object({
 import { z as z13 } from "zod";
 var refineTextParamsSchema = z13.object({
   questionId: z13.string().describe("Unique identifier for the question"),
-  identifier: z13.string().uuid().describe("Unique identifier for the feedback instance"),
   feedbackConfigurationId: z13.string().uuid().describe("Unique identifier for the feedback configuration"),
   userText: z13.string().describe("Original text input from the user")
 }).strict().describe("Request schema for refining user text input");
+var refineTextResponseSchema = z13.object({
+  message: z13.string().optional().describe("Human-readable message"),
+  refinedText: z13.string().optional().describe("Refined/improved version of the user text (success only)"),
+  status: z13.number().optional().describe("HTTP status code (error responses)"),
+  error: z13.string().optional().describe("Error type (error responses)"),
+  code: z13.string().optional().describe("Error code for display mapping")
+}).describe("Response schema for refine text API operation");
 var refineTextDataSchema = z13.object({
   userText: z13.string().describe("Original text input from the user"),
   refinedText: z13.string().describe("Refined/improved version of the user text")
-}).describe("Data containing original and refined text");
-var refineTextResponseSchema = z13.object({
-  success: z13.boolean().describe("Indicates whether the operation was successful"),
-  code: z13.string().describe("Response code indicating the status"),
-  message: z13.string().describe("Human-readable message describing the result"),
-  messageId: z13.string().describe("Unique identifier for the response message"),
-  data: refineTextDataSchema.describe("Response data containing original and refined text"),
-  error: z13.string().optional().describe("Error message if the operation failed (optional)")
-}).strict().describe("Response schema for refine text API operation");
+}).describe("Data containing original and refined text (legacy nested format)");
 
 // src/helpers/case-convert-helper.ts
 function convertObject(obj, keyConverter) {