@encatch/schema 1.3.0-beta.6 → 1.3.0-beta.8

package/dist/esm/index.js

@@ -4,6 +4,130 @@ var __name = (target, value) => __defProp(target, "name", { value, configurable:
 // src/schemas/fields/field-schema.ts
 import { z as z4 } from "zod";
 
+// src/helpers/csat-emoji-helper.ts
+var CSAT_DEFAULT_EMOJIS_BY_SCALE = {
+  2: ["\u{1F621}", "\u{1F604}"],
+  3: ["\u{1F621}", "\u{1F610}", "\u{1F604}"],
+  4: ["\u{1F621}", "\u{1F615}", "\u{1F642}", "\u{1F604}"],
+  5: ["\u{1F621}", "\u{1F615}", "\u{1F610}", "\u{1F642}", "\u{1F604}"]
+};
+var CSAT_EMOJI_CATEGORIES = [
+  {
+    id: "unhappy",
+    label: "Unhappy",
+    emojis: ["\u{1F621}", "\u{1F620}", "\u{1F624}", "\u{1F61E}", "\u{1F615}", "\u{1F61F}", "\u{1F622}", "\u{1F62D}", "\u{1F630}", "\u{1F628}"]
+  },
+  {
+    id: "neutral",
+    label: "Neutral",
+    emojis: ["\u{1F610}", "\u{1F611}", "\u{1F643}", "\u{1F636}", "\u{1F972}"]
+  },
+  {
+    id: "happy",
+    label: "Happy",
+    emojis: ["\u{1F642}", "\u{1F60A}", "\u{1F604}", "\u{1F601}", "\u{1F606}", "\u{1F929}", "\u{1F60D}", "\u{1F970}", "\u{1F60E}"]
+  },
+  {
+    id: "gestures",
+    label: "Gestures",
+    emojis: ["\u{1F44D}", "\u{1F44E}", "\u{1F44F}", "\u{1F64C}", "\u{1F91D}", "\u270C\uFE0F"]
+  },
+  {
+    id: "hearts",
+    label: "Hearts",
+    emojis: ["\u2764\uFE0F", "\u{1F9E1}", "\u{1F49B}", "\u{1F49A}", "\u{1F499}", "\u{1F49C}", "\u{1F494}"]
+  },
+  {
+    id: "symbols",
+    label: "Symbols",
+    emojis: ["\u2B50", "\u{1F31F}", "\u{1F4AF}", "\u2705", "\u274C", "\u26A0\uFE0F"]
+  },
+  {
+    id: "celebration",
+    label: "Celebration",
+    emojis: ["\u{1F389}", "\u{1F973}", "\u{1F38A}", "\u{1F3C6}", "\u{1F525}"]
+  }
+];
+var CSAT_EMOJI_PALETTE = [
+  ...new Set(CSAT_EMOJI_CATEGORIES.flatMap((category) => category.emojis))
+];
+var PALETTE_SET = new Set(CSAT_EMOJI_PALETTE);
+function isCsatEmojiPaletteItem(value) {
+  return PALETTE_SET.has(value);
+}
+__name(isCsatEmojiPaletteItem, "isCsatEmojiPaletteItem");
+function getDefaultOverrideEmojiForScale(scale) {
+  const normalizedScale = [2, 3, 4, 5].includes(scale) ? scale : 5;
+  const defaults = CSAT_DEFAULT_EMOJIS_BY_SCALE[normalizedScale] ?? CSAT_DEFAULT_EMOJIS_BY_SCALE[5];
+  return defaults.map(
+    (emoji) => isCsatEmojiPaletteItem(emoji) ? emoji : CSAT_EMOJI_PALETTE[0] ?? "\u{1F610}"
+  );
+}
+__name(getDefaultOverrideEmojiForScale, "getDefaultOverrideEmojiForScale");
+function parseOverrideEmoji(overrideEmoji) {
+  if (overrideEmoji == null || overrideEmoji.trim() === "") return null;
+  try {
+    const parsed = JSON.parse(overrideEmoji);
+    if (!Array.isArray(parsed)) return null;
+    if (!parsed.every((item) => typeof item === "string")) return null;
+    return parsed;
+  } catch {
+    return null;
+  }
+}
+__name(parseOverrideEmoji, "parseOverrideEmoji");
+function serializeOverrideEmoji(emojis) {
+  return JSON.stringify([...emojis]);
+}
+__name(serializeOverrideEmoji, "serializeOverrideEmoji");
+function validateOverrideEmojiForScale(overrideEmoji, scale) {
+  if (overrideEmoji == null || overrideEmoji.trim() === "") {
+    return { valid: true, emojis: null };
+  }
+  const emojis = parseOverrideEmoji(overrideEmoji);
+  if (!emojis) {
+    return { valid: false, emojis: null, error: "overrideEmoji must be a valid JSON array of strings" };
+  }
+  if (emojis.length !== scale) {
+    return {
+      valid: false,
+      emojis: null,
+      error: `overrideEmoji must contain exactly ${scale} emoji(s) for a ${scale}-point scale`
+    };
+  }
+  for (const emoji of emojis) {
+    if (!isCsatEmojiPaletteItem(emoji)) {
+      return {
+        valid: false,
+        emojis: null,
+        error: `Emoji "${emoji}" is not in the allowed CSAT palette`
+      };
+    }
+  }
+  return { valid: true, emojis };
+}
+__name(validateOverrideEmojiForScale, "validateOverrideEmojiForScale");
+function resolveCsatEmojis(scale, overrideEmoji) {
+  const normalizedScale = [2, 3, 4, 5].includes(scale) ? scale : 5;
+  const { emojis } = validateOverrideEmojiForScale(overrideEmoji, normalizedScale);
+  if (emojis) return emojis;
+  return [...CSAT_DEFAULT_EMOJIS_BY_SCALE[normalizedScale] ?? CSAT_DEFAULT_EMOJIS_BY_SCALE[5]];
+}
+__name(resolveCsatEmojis, "resolveCsatEmojis");
+function getCsatEmojiForPoint(point, scale, overrideEmoji) {
+  const emojis = resolveCsatEmojis(scale, overrideEmoji);
+  return emojis[point - 1] ?? emojis[emojis.length - 1] ?? "\u{1F610}";
+}
+__name(getCsatEmojiForPoint, "getCsatEmojiForPoint");
+function trimOverrideEmojiForScale(overrideEmoji, newScale) {
+  const parsed = parseOverrideEmoji(overrideEmoji);
+  if (!parsed) return void 0;
+  const trimmed = parsed.slice(0, newScale);
+  if (trimmed.length === 0) return void 0;
+  return serializeOverrideEmoji(trimmed);
+}
+__name(trimOverrideEmojiForScale, "trimOverrideEmojiForScale");
+
 // src/schemas/fields/translations-schema.ts
 import { z } from "zod";
 var translationEntrySchema = z.string().min(1).describe("Translated text content");
@@ -96,7 +220,18 @@ var videoAudioQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.ex
   videoIdleHint: z.string().max(200).optional().describe("Translated video idle overlay hint"),
   photoEmptyHint: z.string().max(200).optional().describe("Translated empty photo area hint"),
   photoUseCameraButtonLabel: z.string().max(80).optional().describe("Translated Use camera button"),
-  photoUploadImageButtonLabel: z.string().max(80).optional().describe("Translated Upload image button")
+  photoUploadImageButtonLabel: z.string().max(80).optional().describe("Translated Upload image button"),
+  capturePhotoButtonLabel: z.string().max(80).optional().describe("Translated Capture photo button"),
+  cancelButtonLabel: z.string().max(80).optional().describe("Translated Cancel button in live photo mode"),
+  uploadPhotoButtonLabel: z.string().max(80).optional().describe("Translated Upload Photo button"),
+  replaceButtonLabel: z.string().max(80).optional().describe("Translated Replace button"),
+  removeButtonLabel: z.string().max(80).optional().describe("Translated Remove button"),
+  stopRecordingButtonLabel: z.string().max(80).optional().describe("Translated Stop recording button"),
+  playButtonLabel: z.string().max(80).optional().describe("Translated Play button"),
+  pauseButtonLabel: z.string().max(80).optional().describe("Translated Pause button"),
+  uploadButtonLabel: z.string().max(80).optional().describe("Translated Upload button on preview"),
+  rerecordButtonLabel: z.string().max(80).optional().describe("Translated Re-record button"),
+  dismissErrorButtonLabel: z.string().max(80).optional().describe("Translated dismiss error control label")
 }).describe("Translation schema for video/audio/photo/text questions");
 var dateQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
   type: z.literal("date").describe("Question type identifier"),
@@ -114,7 +249,11 @@ var signatureQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.ext
   modeTabLabelUpload: z.string().max(80).optional().describe("Translated Upload tab label"),
   drawCanvasHint: z.string().max(200).optional().describe("Translated empty-canvas hint"),
   uploadZonePrimary: z.string().max(200).optional().describe("Translated idle upload prompt"),
-  uploadZoneDrag: z.string().max(120).optional().describe("Translated drag-over upload prompt")
+  uploadZoneDrag: z.string().max(120).optional().describe("Translated drag-over upload prompt"),
+  uploadSignatureButtonLabel: z.string().max(80).optional().describe("Translated Upload Signature button"),
+  uploadButtonLabel: z.string().max(80).optional().describe("Translated Upload button in upload mode"),
+  removeButtonLabel: z.string().max(80).optional().describe("Translated Remove button"),
+  dismissErrorButtonLabel: z.string().max(80).optional().describe("Translated dismiss error control label")
 }).describe("Translation schema for signature questions");
 var schedulerQuestionTranslationSchema = baseQuestionTranslationFieldsSchema.extend({
   type: z.literal("scheduler").describe("Question type identifier"),
@@ -1390,7 +1529,53 @@ var csatQuestionSchema = questionSchema.extend({
   ),
   scaleLabels: z4.record(z4.string(), z4.string().max(100)).optional().describe(
     "Per-point label text keyed by value string ('1'\u2013'5'); keys must match the chosen scale size"
+  ),
+  overrideEmoji: z4.string().max(500).optional().describe(
+    "JSON string array of emoji characters ordered low\u2192high (index 0 = point 1); length must match scale when set; values must be from the allowed CSAT emoji palette"
   )
+}).superRefine((data, ctx) => {
+  if (data.overrideEmoji == null || data.overrideEmoji.trim() === "") {
+    return;
+  }
+  const scale = data.scale ?? 5;
+  let parsed;
+  try {
+    parsed = JSON.parse(data.overrideEmoji);
+  } catch {
+    ctx.addIssue({
+      code: z4.ZodIssueCode.custom,
+      message: "overrideEmoji must be a valid JSON array of strings",
+      path: ["overrideEmoji"]
+    });
+    return;
+  }
+  if (!Array.isArray(parsed) || !parsed.every((item) => typeof item === "string")) {
+    ctx.addIssue({
+      code: z4.ZodIssueCode.custom,
+      message: "overrideEmoji must be a JSON array of strings",
+      path: ["overrideEmoji"]
+    });
+    return;
+  }
+  if (parsed.length !== scale) {
+    ctx.addIssue({
+      code: z4.ZodIssueCode.custom,
+      message: `overrideEmoji must contain exactly ${scale} emoji(s) for a ${scale}-point scale`,
+      path: ["overrideEmoji"]
+    });
+    return;
+  }
+  const allowed = new Set(CSAT_EMOJI_PALETTE);
+  for (const emoji of parsed) {
+    if (!allowed.has(emoji)) {
+      ctx.addIssue({
+        code: z4.ZodIssueCode.custom,
+        message: `Emoji "${emoji}" is not in the allowed CSAT palette`,
+        path: ["overrideEmoji"]
+      });
+      return;
+    }
+  }
 }).describe(
   "Schema for a CSAT (Customer Satisfaction Score) question using an industry-standard 1-to-N positive scale (N = 2\u20135)"
 );
@@ -1561,7 +1746,11 @@ var signatureQuestionSchema = questionSchema.extend({
   ),
   uploadZoneDrag: z4.string().max(120).optional().describe(
     "Short prompt when dragging a file over the upload zone; falls back to platform default"
-  )
+  ),
+  uploadSignatureButtonLabel: z4.string().max(80).optional().describe("Label for the Upload Signature button in draw mode"),
+  uploadButtonLabel: z4.string().max(80).optional().describe("Label for the Upload button in upload mode preview"),
+  removeButtonLabel: z4.string().max(80).optional().describe("Label for Remove controls in upload mode"),
+  dismissErrorButtonLabel: z4.string().max(80).optional().describe("Accessible label for the dismiss control on upload error overlays")
 }).describe(
   "Schema for a signature question where respondents can type, draw, or upload their electronic signature"
 );
@@ -1723,7 +1912,18 @@ var videoAudioQuestionSchema = questionSchema.extend({
     "Hint in the empty photo preview area; falls back to placeholder then built-in copy"
   ),
   photoUseCameraButtonLabel: z4.string().max(80).optional().describe("Label for the Use camera button in photo mode"),
-  photoUploadImageButtonLabel: z4.string().max(80).optional().describe("Label for the upload image button in photo mode")
+  photoUploadImageButtonLabel: z4.string().max(80).optional().describe("Label for the upload image button in photo mode"),
+  capturePhotoButtonLabel: z4.string().max(80).optional().describe("Label for the Capture photo button in live photo mode"),
+  cancelButtonLabel: z4.string().max(80).optional().describe("Label for the Cancel button when live photo camera is open"),
+  uploadPhotoButtonLabel: z4.string().max(80).optional().describe("Label for the Upload Photo button on photo preview"),
+  replaceButtonLabel: z4.string().max(80).optional().describe("Label for the Replace button on photo preview"),
+  removeButtonLabel: z4.string().max(80).optional().describe("Label for Remove controls across media modes"),
+  stopRecordingButtonLabel: z4.string().max(80).optional().describe("Label for the Stop recording button while recording"),
+  playButtonLabel: z4.string().max(80).optional().describe("Label for the Play button on recording preview"),
+  pauseButtonLabel: z4.string().max(80).optional().describe("Label for the Pause button on recording preview"),
+  uploadButtonLabel: z4.string().max(80).optional().describe("Label for the Upload button on recording preview"),
+  rerecordButtonLabel: z4.string().max(80).optional().describe("Label for the Re-record button on recording preview"),
+  dismissErrorButtonLabel: z4.string().max(80).optional().describe("Accessible label for dismiss on media upload error overlays")
 }).describe(
   "Schema for a video, audio, and photo question where respondents can record or upload media or enter a text answer"
 );
@@ -2689,6 +2889,9 @@ export {
   AnnotationSchema,
   AnswerItemSchema,
   AnswerSchema,
+  CSAT_DEFAULT_EMOJIS_BY_SCALE,
+  CSAT_EMOJI_CATEGORIES,
+  CSAT_EMOJI_PALETTE,
   ChoiceOrderOptions,
   CsatDisplayStyles,
   CsatScales,
@@ -2786,9 +2989,12 @@ export {
   formConfigurationResponseSchema,
   formDetailsSchema,
   formPropertiesSchema,
+  getCsatEmojiForPoint,
+  getDefaultOverrideEmojiForScale,
   gradientAttachmentSchema,
   imageAttachmentSchema,
   inAppDisplayTypeSchema,
+  isCsatEmojiPaletteItem,
   layoutAttachmentSchema,
   layoutSurfaceSchema,
   logicJumpRuleSchema,
@@ -2821,6 +3027,7 @@ export {
   objectToSnake,
   opinionScaleQuestionSchema,
   otherConfigurationPropertiesSchema,
+  parseOverrideEmoji,
   partialFeedbackSchema,
   paymentsUpiAmountConfigSchema,
   paymentsUpiQuestionSchema,
@@ -2857,6 +3064,7 @@ export {
   refineTextDataSchema,
   refineTextParamsSchema,
   refineTextResponseSchema,
+  resolveCsatEmojis,
   responseSchema,
   schedulerProviderSchema,
   schedulerQuestionSchema,
@@ -2866,6 +3074,7 @@ export {
   sectionSchema,
   sectionTranslationSchema,
   sectionTranslationsByLanguageSchema,
+  serializeOverrideEmoji,
   sessionInfoSchema,
   shareableModeSchema,
   shortAnswerQuestionSchema,
@@ -2890,8 +3099,10 @@ export {
   translationEntrySchema,
   translationsSchema,
   triggerActionSchema,
+  trimOverrideEmojiForScale,
   userInfoSchema,
   userPropertiesSchema,
+  validateOverrideEmojiForScale,
   validationRuleSchema,
   validationRuleTypeSchema,
   videoAttachmentSchema,