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

package/dist/types/helpers/csat-emoji-helper.d.ts

@@ -0,0 +1,52 @@
+/** Canonical CSAT default emojis when `overrideEmoji` is unset (index 0 = point 1). */
+export declare const CSAT_DEFAULT_EMOJIS_BY_SCALE: Record<number, readonly string[]>;
+/** Emoji picker categories for CSAT custom overrides. */
+export declare const CSAT_EMOJI_CATEGORIES: readonly [{
+    readonly id: "unhappy";
+    readonly label: "Unhappy";
+    readonly emojis: readonly ["😡", "😠", "😤", "😞", "😕", "😟", "😢", "😭", "😰", "😨"];
+}, {
+    readonly id: "neutral";
+    readonly label: "Neutral";
+    readonly emojis: readonly ["😐", "😑", "🙃", "😶", "🥲"];
+}, {
+    readonly id: "happy";
+    readonly label: "Happy";
+    readonly emojis: readonly ["🙂", "😊", "😄", "😁", "😆", "🤩", "😍", "🥰", "😎"];
+}, {
+    readonly id: "gestures";
+    readonly label: "Gestures";
+    readonly emojis: readonly ["👍", "👎", "👏", "🙌", "🤝", "✌️"];
+}, {
+    readonly id: "hearts";
+    readonly label: "Hearts";
+    readonly emojis: readonly ["❤️", "🧡", "💛", "💚", "💙", "💜", "💔"];
+}, {
+    readonly id: "symbols";
+    readonly label: "Symbols";
+    readonly emojis: readonly ["⭐", "🌟", "💯", "✅", "❌", "⚠️"];
+}, {
+    readonly id: "celebration";
+    readonly label: "Celebration";
+    readonly emojis: readonly ["🎉", "🥳", "🎊", "🏆", "🔥"];
+}];
+/** Flat allowed palette derived from categories (used for validation). */
+export declare const CSAT_EMOJI_PALETTE: readonly string[];
+export type CsatEmojiCategory = (typeof CSAT_EMOJI_CATEGORIES)[number];
+export type CsatEmojiPaletteItem = (typeof CSAT_EMOJI_PALETTE)[number];
+export declare function isCsatEmojiPaletteItem(value: string): value is CsatEmojiPaletteItem;
+/** Default override values when custom emojis are enabled — every emoji must exist in CSAT_EMOJI_PALETTE. */
+export declare function getDefaultOverrideEmojiForScale(scale: number): string[];
+export declare function parseOverrideEmoji(overrideEmoji: string | undefined | null): string[] | null;
+export declare function serializeOverrideEmoji(emojis: readonly string[]): string;
+export declare function validateOverrideEmojiForScale(overrideEmoji: string | undefined | null, scale: number): {
+    valid: boolean;
+    emojis: string[] | null;
+    error?: string;
+};
+/** Returns emojis for each scale point (index 0 = point 1). Falls back to defaults when unset. */
+export declare function resolveCsatEmojis(scale: number, overrideEmoji?: string | null): string[];
+/** Emoji for a 1-based CSAT point value. */
+export declare function getCsatEmojiForPoint(point: number, scale: number, overrideEmoji?: string | null): string;
+/** Trim custom emojis when scale shrinks; pad with defaults when scale grows (caller may require re-pick). */
+export declare function trimOverrideEmojiForScale(overrideEmoji: string | undefined | null, newScale: number): string | undefined;

package/dist/types/index.d.ts

@@ -15,5 +15,6 @@ export { feedbackConfigurationItemSchema, fetchFormConfigSchema, fetchConfigurat
 export { RefineTextParams, RefineTextResponse, RefineTextData, refineTextDataSchema, refineTextParamsSchema, refineTextResponseSchema, } from "./schemas/api/refine-text-schema";
 export { objectToCamel, objectToSnake, toSnake, toCamel, toPascal, objectToPascal, } from "./helpers/case-convert-helper";
 export type { ObjectToCamel, ObjectToSnake, ToSnake, ToCamel, ToPascal, ObjectToPascal, } from "./helpers/case-convert-helper";
+export { CSAT_DEFAULT_EMOJIS_BY_SCALE, CSAT_EMOJI_CATEGORIES, CSAT_EMOJI_PALETTE, getCsatEmojiForPoint, getDefaultOverrideEmojiForScale, isCsatEmojiPaletteItem, parseOverrideEmoji, resolveCsatEmojis, serializeOverrideEmoji, trimOverrideEmojiForScale, validateOverrideEmojiForScale, type CsatEmojiCategory, type CsatEmojiPaletteItem, } from "./helpers/csat-emoji-helper";
 export { currentModeSchema, appPropsSchema, CurrentModes, type CurrentMode, type AppProps, } from "./schemas/fields/app-props-schema";
 export { z } from "zod";

package/dist/types/schemas/api/fetch-feedback-schema.d.ts

@@ -1687,6 +1687,7 @@ export declare const questionnaireFieldsResponseSchema: z.ZodObject<{
         positiveColor: z.ZodOptional<z.ZodString>;
         showLabels: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
         scaleLabels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        overrideEmoji: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>, z.ZodObject<{
         id: z.ZodString;
         slug: z.ZodOptional<z.ZodString>;
@@ -4318,6 +4319,7 @@ export declare const fetchFeedbackDetailsResponseSchema: z.ZodObject<{
             positiveColor: z.ZodOptional<z.ZodString>;
             showLabels: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
             scaleLabels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            overrideEmoji: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>, z.ZodObject<{
             id: z.ZodString;
             slug: z.ZodOptional<z.ZodString>;

package/dist/types/schemas/fields/app-props-schema.d.ts

@@ -1530,6 +1530,7 @@ export declare const appPropsSchema: z.ZodObject<{
         positiveColor: z.ZodOptional<z.ZodString>;
         showLabels: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
         scaleLabels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        overrideEmoji: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>, z.ZodObject<{
         id: z.ZodString;
         slug: z.ZodOptional<z.ZodString>;

package/dist/types/schemas/fields/field-schema.d.ts

@@ -2035,6 +2035,7 @@ export declare const csatQuestionSchema: z.ZodObject<{
     positiveColor: z.ZodOptional<z.ZodString>;
     showLabels: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
     scaleLabels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    overrideEmoji: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export declare const opinionScaleQuestionSchema: z.ZodObject<{
     id: z.ZodString;
@@ -4709,6 +4710,7 @@ export declare const combinedQuestionSchema: z.ZodDiscriminatedUnion<[z.ZodObjec
     positiveColor: z.ZodOptional<z.ZodString>;
     showLabels: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
     scaleLabels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    overrideEmoji: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, z.ZodObject<{
     id: z.ZodString;
     slug: z.ZodOptional<z.ZodString>;

package/dist/types/schemas/fields/form-properties-schema.d.ts

@@ -2827,6 +2827,7 @@ export declare const formPropertiesSchema: z.ZodObject<{
             positiveColor: z.ZodOptional<z.ZodString>;
             showLabels: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
             scaleLabels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            overrideEmoji: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>, z.ZodObject<{
             id: z.ZodString;
             slug: z.ZodOptional<z.ZodString>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@encatch/schema",
-  "version": "1.3.0-beta.7",
+  "version": "1.3.0-beta.8",
   "description": "TypeScript schema definitions using Zod for validation and type inference of encatch product",
   "homepage": "https://encatch.com",
   "type": "module",