@encatch/schema 1.3.0 → 1.4.0

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

@@ -3,17 +3,18 @@ export { AnnotationMarkerSchema, AnnotationSchema, SignatureAnswerSchema, FileUp
 export { externalPublishingPropertiesSchema, publicationStatusSchema, feedbackConfigurationSchema, PublicationStatuses, type PublicationStatus, type FeedbackConfiguration, type ExternalPublishingProperties, } from "./schemas/fields/form-schema";
 export { otherConfigurationPropertiesSchema, appearancePropertiesSchema, formPropertiesSchema, type FormProperties, type OtherConfigurationProperties, type AppearanceProperties, } from "./schemas/fields/form-properties-schema";
 export { OtherFieldsSchema, LanguageFieldSchema, LanguagesSchema, OtherFieldsTranslationSchema, type OtherFields, type OtherFieldsTranslation, type LanguageField, type Languages, } from "./schemas/fields/other-screen-schema";
-export { positionSchema, themeModeSchema, shareableModeSchema, previousButtonModeSchema, featureSettingsSchema, themeColorsSchema, themesSchema, themeConfigurationSchema, Positions, ThemeModes, ShareableModes, PreviousButtonModes, type Position, type FeatureSettings, type ThemeColors, type Themes, type ThemeMode, type ShareableMode, type PreviousButtonMode, type ThemeConfiguration, } from "./schemas/fields/theme-schema";
+export { positionSchema, themeModeSchema, shareableModeSchema, previousButtonModeSchema, inAppDisplayTypeSchema, featureSettingsSchema, themeColorsSchema, themesSchema, themeConfigurationSchema, Positions, ThemeModes, ShareableModes, PreviousButtonModes, InAppDisplayTypes, type Position, type FeatureSettings, type InAppDisplayType, type ThemeColors, type Themes, type ThemeMode, type ShareableMode, type PreviousButtonMode, type ThemeConfiguration, } from "./schemas/fields/theme-schema";
 export { focalPointSchema, imageAttachmentSchema, videoAttachmentSchema, colorAttachmentSchema, gradientAttachmentSchema, layoutAttachmentSchema, stackLayoutSchema, floatLayoutSchema, splitLayoutSchema, wallpaperLayoutSchema, sectionLayoutVariantSchema, layoutSurfaceSchema, sectionLayoutSchema, LayoutAttachmentTypes, LayoutTypes, type FocalPoint, type ImageAttachment, type VideoAttachment, type ColorAttachment, type GradientAttachment, type LayoutAttachment, type StackLayout, type FloatLayout, type SplitLayout, type WallpaperLayout, type SectionLayoutVariant, type LayoutSurface, type SectionLayout, } from "./schemas/fields/layout-schema";
 export { translationEntrySchema, ratingQuestionTranslationSchema, singleChoiceQuestionTranslationSchema, multipleChoiceQuestionTranslationSchema, npsQuestionTranslationSchema, shortAnswerQuestionTranslationSchema, longAnswerQuestionTranslationSchema, videoAudioQuestionTranslationSchema, dateQuestionTranslationSchema, signatureQuestionTranslationSchema, schedulerQuestionTranslationSchema, qnaWithAiQuestionTranslationSchema, paymentsUpiQuestionTranslationSchema, nestedSelectionQuestionTranslationSchema, annotationQuestionTranslationSchema, welcomeQuestionTranslationSchema, thankYouQuestionTranslationSchema, messagePanelQuestionTranslationSchema, yesNoQuestionTranslationSchema, consentQuestionTranslationSchema, ratingMatrixQuestionTranslationSchema, matrixSingleChoiceQuestionTranslationSchema, matrixMultipleChoiceQuestionTranslationSchema, questionTranslationSchema, sectionTranslationSchema, sectionTranslationsByLanguageSchema, questionCentricTranslationsSchema, translationsSchema, TranslationProvider, createTranslationProvider, type TranslationEntry, type RatingQuestionTranslation, type SingleChoiceQuestionTranslation, type MultipleChoiceQuestionTranslation, type NpsQuestionTranslation, type ShortAnswerQuestionTranslation, type LongAnswerQuestionTranslation, type VideoAudioQuestionTranslation, type DateQuestionTranslation, type SignatureQuestionTranslation, type SchedulerQuestionTranslation, type QnaWithAiQuestionTranslation, type PaymentsUpiQuestionTranslation, type NestedSelectionQuestionTranslation, type AnnotationQuestionTranslation, type WelcomeQuestionTranslation, type ThankYouQuestionTranslation, type MessagePanelQuestionTranslation, type YesNoQuestionTranslation, type ConsentQuestionTranslation, type RatingMatrixQuestionTranslation, type MatrixSingleChoiceQuestionTranslation, type MatrixMultipleChoiceQuestionTranslation, type QuestionTranslation, type SectionTranslation, type SectionTranslationsByLanguage, type QuestionCentricTranslations, type Translations, } from "./schemas/fields/translations-schema";
 export { platformCompletionCtaSchema, completionCtaSecondarySchema, completionCtaSchema, type PlatformCompletionCta, type CompletionCtaSecondary, type CompletionCta, type CompletionCtaAction, } from "./schemas/fields/completion-cta-schema";
 export { customEventFieldOperatorSchema, customEventFieldSchema, conditionalIfMetadataSchema, queryOutputSchema, conditionalIfSchema, triggerActionSchema, conditionalWhenSchema, filterConditionSchema, categorySpecificFiltersSchema, whoSchema, audienceSegmentSchema, audienceTriggerPropertiesSchema, type CustomEventFieldOperator, type CustomEventField, type ConditionalIfMetadata, type QueryOutput, type ConditionalIf, type TriggerAction, type ConditionalWhen, type FilterCondition, type CategorySpecificFilters, type Who, type AudienceSegment, type AudienceTriggerProperties, } from "./schemas/fields/auto-trigger-schema";
 export { masterPropertiesSchema, type MasterProperties, } from "./schemas/fields/other-properties-schema";
 export { deviceThemeSchema, deviceInfoSchema, sessionInfoSchema, deviceSessionInfoSchema, userPropertiesSchema, userInfoSchema, DeviceThemes, type DeviceTheme, type DeviceInfo, type SessionInfo, type DeviceSessionInfo, type UserProperties, type UserInfo, } from "./schemas/api/other-schema";
-export { formConfigSchema, questionResponseSchema, responseSchema, matchedTriggerPropertiesSchema, baseSubmitFeedbackSchema, partialFeedbackSchema, submitFeedbackSchema, feedbackRequestSchema, type FormConfig, type QuestionResponse, type Response, type MatchedTriggerProperties, type BaseSubmitFeedback, type PartialFeedback, type SubmitFeedback, type FeedbackRequest, } from "./schemas/api/submit-feedback-schema";
+export { formConfigSchema, questionResponseSchema, responseSchema, matchedTriggerPropertiesSchema, baseSubmitFeedbackSchema, partialFeedbackSchema, submitFeedbackSchema, feedbackRequestSchema, formDetailsSchema, submitFormRequestSchema, type FormConfig, type QuestionResponse, type Response, type MatchedTriggerProperties, type BaseSubmitFeedback, type PartialFeedback, type SubmitFeedback, type FeedbackRequest, type FormDetails, type FormDetailsResponse, type SubmitFormRequest, } from "./schemas/api/submit-feedback-schema";
 export { feedbackConfigurationItemSchema, fetchFormConfigSchema, fetchConfigurationListSchema, fetchFeedbackDetailsSchema, formConfigurationResponseSchema, questionnaireFieldsResponseSchema, fetchFeedbackDetailsResponseSchema, fetchConfigurationListResponseSchema, logicJumpRuleSchema, logicJumpRulesSchema, type FeedbackConfigurationItem, type FetchFormConfig, type FetchConfigurationListRequest, type FetchFeedbackDetailsRequest, type FormConfigurationResponse, type QuestionnaireFieldsResponse, type FetchFeedbackDetailsResponse, type FetchConfigurationListResponse, type LogicJumpRule, type LogicJumpRules, } from "./schemas/api/fetch-feedback-schema";
 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/internal/type-assert.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Compile-time helpers used to guarantee that the hand-authored, Zod-free
+ * public interfaces stay in lock-step with their Zod `z.infer` counterparts.
+ *
+ * These are pure type-level utilities — they emit no runtime code and are never
+ * re-exported from the package entrypoint, so they never leak into consumer
+ * (SDK) type bundles.
+ */
+/** True when `A` and `B` are mutually assignable (tuple-wrapped to avoid union distribution). */
+export type MutuallyAssignable<A, B> = [A] extends [B] ? [B] extends [A] ? true : false : false;
+/** True when `A` and `B` expose the exact same set of top-level keys. */
+export type SameKeys<A, B> = [keyof A] extends [keyof B] ? [keyof B] extends [keyof A] ? true : false : false;
+/**
+ * True when interface `I` is a faithful, drift-free representation of schema
+ * type `S` — i.e. structurally interchangeable AND with an identical key set.
+ */
+export type MatchesSchema<I, S> = MutuallyAssignable<I, S> extends true ? SameKeys<I, S> extends true ? true : false : false;
+/** Compiles only when `T` is exactly `true`; otherwise raises a type error. */
+export type AssertTrue<T extends true> = T;