@encatch/schema 0.0.1 → 0.1.0

package/dist/esm/schemas/fields/field-schema.js

@@ -1,675 +0,0 @@
-import { z } from "zod";
-// Question type enum for different form field types
-export const questionTypeSchema = z
-    .enum([
-    "rating",
-    "single_choice",
-    "nps",
-    "nested_selection",
-    "multiple_choice_multiple",
-    "short_answer",
-    "long_text",
-    "annotation",
-])
-    .describe("Enumeration of all supported question types for form fields");
-// Validation rule schema for question validations
-export const validationRuleSchema = z
-    .object({
-    type: z
-        .enum([
-        "required",
-        "min",
-        "max",
-        "minLength",
-        "maxLength",
-        "pattern",
-        "email",
-        "url",
-        "custom",
-    ])
-        .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");
-// Visibility condition schema for conditional visibility
-export const 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"),
-    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("Schema defining conditions that control when questions are visible");
-// Section schema for organizing questions
-export const sectionSchema = z
-    .object({
-    id: z
-        .uuid()
-        .describe("Unique identifier for the section"),
-    title: z
-        .string()
-        .min(1)
-        .max(200)
-        .describe("Display title for the section"),
-    question_ids: z
-        .array(z.uuid())
-        .min(1)
-        .describe("Array of question IDs that belong to this section"),
-})
-    .describe("Schema defining sections that organize questions into logical groups");
-// Question status enum
-export const questionStatusSchema = z.enum(["D", "P", "A", "S"]); // Draft, Published, Archived, Suspended
-// Display style enum for rating questions
-export const ratingDisplayStyleSchema = z.enum([
-    "star",
-    "heart",
-    "thumbs-up",
-    "diamond",
-    "emoji",
-    "emoji-exp",
-]);
-// Representation size enum for rating questions
-export const ratingRepresentationSizeSchema = z.enum([
-    "small",
-    "medium",
-    "large",
-]);
-// Display style enum for multiple choice questions
-export const multipleChoiceDisplayStyleSchema = z.enum([
-    "radio",
-    "list",
-    "chip",
-    "dropdown",
-]);
-// Display style enum for multiple choice multiple questions
-export const multipleChoiceMultipleDisplayStyleSchema = z.enum([
-    "checkbox",
-    "list",
-    "chip",
-]);
-// Choice order options for nested selection questions
-export const choiceOrderOptionSchema = z.enum([
-    "randomize",
-    "flip",
-    "rotate",
-    "ascending",
-    "none",
-]);
-// Main Question schema
-export const questionSchema = z
-    .object({
-    id: z.uuid().describe("Unique identifier for the question"),
-    type: questionTypeSchema.describe("The type of question (rating, single_choice, etc.)"),
-    title: z
-        .string()
-        .min(1)
-        .max(200)
-        .describe("The main title/question text displayed to users"),
-    description: z
-        .string()
-        .max(1000)
-        .optional()
-        .describe("Optional detailed description or help text"),
-    describe: z
-        .string()
-        .max(2000)
-        .optional()
-        .describe("LLM tool call description for better AI understanding and context"),
-    required: z
-        .boolean()
-        .default(false)
-        .describe("Whether this question must be answered"),
-    errorMessage: z
-        .string()
-        .max(500)
-        .optional()
-        .describe("Custom error message when validation fails"),
-    validations: z
-        .array(validationRuleSchema)
-        .optional()
-        .default([])
-        .describe("Array of validation rules to apply"),
-    visibility: z
-        .array(visibilityConditionSchema)
-        .optional()
-        .default([])
-        .describe("Conditions that control when this question is shown"),
-    isFixed: z
-        .boolean()
-        .describe("Whether this question position is fixed or can be reordered"),
-    sectionId: z
-        .string()
-        .uuid()
-        .optional()
-        .describe("ID of the section this question belongs to"),
-    status: questionStatusSchema.describe("Current status of the question (Draft, Published, etc.)"),
-})
-    .describe("Base schema for all question types with common properties");
-// Rating question schema (extends base question with specific rating properties)
-export const ratingQuestionSchema = questionSchema
-    .extend({
-    type: z
-        .literal(questionTypeSchema.enum.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"),
-    displayStyle: ratingDisplayStyleSchema
-        .optional()
-        .describe("Visual style for rating display"),
-    numberOfRatings: z
-        .number()
-        .int()
-        .min(1)
-        .max(10)
-        .describe("Number of rating options (1-10)"),
-    representationSize: ratingRepresentationSizeSchema
-        .optional()
-        .describe("Size of rating visual elements"),
-    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");
-// Annotation question schema (extends base question with annotation properties)
-export const annotationQuestionSchema = questionSchema
-    .extend({
-    type: z
-        .literal(questionTypeSchema.enum.annotation)
-        .describe("Must be exactly 'annotation'"),
-    annotationText: z
-        .string()
-        .max(1000)
-        .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("Schema for annotation questions that provide additional context or instructions");
-// Question option schema for choice-based questions
-export const questionOptionSchema = z
-    .object({
-    id: z.uuid().describe("Unique identifier for this option"),
-    value: z
-        .string()
-        .min(1)
-        .max(100)
-        .describe("The internal value used for this option"),
-    label: z
-        .string()
-        .min(1)
-        .max(200)
-        .describe("The display text shown to users for this option"),
-    describe: z
-        .string()
-        .max(500)
-        .optional()
-        .describe("LLM tool call description providing context about this option"),
-    imageUrl: z
-        .string()
-        .url()
-        .optional()
-        .describe("Optional image URL to display with this option"),
-})
-    .describe("Schema for individual options in choice-based questions");
-// Nested option schema for hierarchical choice structures (recursive)
-export const nestedOptionSchema = z.lazy(() => z
-    .object({
-    id: z
-        .string()
-        .uuid()
-        .describe("Unique identifier for this nested option"),
-    value: z
-        .string()
-        .min(1)
-        .max(100)
-        .describe("The internal value used for this nested option"),
-    label: z
-        .string()
-        .min(1)
-        .max(200)
-        .describe("The display text shown for this nested option"),
-    describe: z
-        .string()
-        .max(500)
-        .optional()
-        .describe("LLM tool call description for this nested option context"),
-    imageUrl: z
-        .string()
-        .url()
-        .optional()
-        .describe("Optional image URL for this nested option"),
-    hint: z
-        .string()
-        .max(500)
-        .optional()
-        .describe("Optional hint text to help users understand this nested option"),
-    children: z
-        .array(nestedOptionSchema)
-        .optional()
-        .default([])
-        .describe("Array of child options for hierarchical structure"),
-})
-    .describe("Schema for nested options with hierarchical structure support"));
-// Multiple choice single question schema (extends base question with choice-specific properties)
-export const multipleChoiceSingleQuestionSchema = questionSchema
-    .extend({
-    type: z
-        .literal(questionTypeSchema.enum.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");
-// Multiple choice multiple question schema (extends base question with multiple choice properties)
-export const multipleChoiceMultipleQuestionSchema = questionSchema
-    .extend({
-    type: z
-        .literal(questionTypeSchema.enum.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"),
-    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)"),
-})
-    .refine((data) => {
-    // If both minSelections and maxSelections are provided, minSelections should be <= maxSelections
-    if (data.minSelections !== undefined &&
-        data.maxSelections !== undefined) {
-        return data.minSelections <= data.maxSelections;
-    }
-    return true;
-}, {
-    message: "minSelections cannot be greater than maxSelections",
-    path: ["minSelections"], // Point to minSelections field for the error
-})
-    .describe("Schema for multiple-choice questions allowing multiple selections");
-// NPS question schema (extends base question with NPS-specific properties)
-export const npsQuestionSchema = questionSchema
-    .extend({
-    type: z
-        .literal(questionTypeSchema.enum.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)"),
-    maxLabel: z
-        .string()
-        .max(100)
-        .optional()
-        .describe("Label for the maximum NPS value (10)"),
-    scaleLabels: z
-        .record(z.string().regex(/^\d+$/).transform(Number).refine(val => val >= 0 && val <= 10), z.string().max(50))
-        .optional()
-        .describe("Custom labels for specific NPS values (0-10)"),
-    prepopulatedValue: z
-        .number()
-        .int()
-        .min(0)
-        .max(10)
-        .optional()
-        .describe("Default value to pre-select (0-10)"),
-})
-    .refine((data) => {
-    // If scaleLabels is provided, validate that all keys are within the 0-10 range
-    if (data.scaleLabels) {
-        const keys = Object.keys(data.scaleLabels).map(Number);
-        return keys.every((key) => key >= 0 && key <= 10);
-    }
-    return true;
-}, {
-    message: "scaleLabels keys must be between 0 and 10 (inclusive)",
-    path: ["scaleLabels"],
-})
-    .describe("Schema for Net Promoter Score questions with 0-10 scale");
-// Short answer question schema (extends base question with text input properties)
-export const shortAnswerQuestionSchema = questionSchema
-    .extend({
-    type: z
-        .literal(questionTypeSchema.enum.short_answer)
-        .describe("Must be exactly 'short_answer'"),
-    maxCharacters: z
-        .number()
-        .int()
-        .min(1)
-        .max(10000)
-        .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"),
-    enableRegexValidation: z
-        .boolean()
-        .optional()
-        .default(false)
-        .describe("Whether to enable regex pattern validation"),
-    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(2000)
-        .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(10000)
-        .optional()
-        .describe("Maximum tokens allowed for AI processing"),
-    minCharactersToEnhance: z
-        .number()
-        .int()
-        .min(1)
-        .optional()
-        .describe("Minimum characters needed to trigger AI enhancement"),
-})
-    .refine((data) => {
-    // If both minCharacters and maxCharacters are provided, minCharacters should be <= maxCharacters
-    if (data.minCharacters !== undefined &&
-        data.maxCharacters !== undefined) {
-        return data.minCharacters <= data.maxCharacters;
-    }
-    return true;
-}, {
-    message: "minCharacters cannot be greater than maxCharacters",
-    path: ["minCharacters"],
-})
-    .refine((data) => {
-    // If enableRegexValidation is true, regexPattern should be provided
-    if (data.enableRegexValidation && !data.regexPattern) {
-        return false;
-    }
-    return true;
-}, {
-    message: "regexPattern is required when enableRegexValidation is true",
-    path: ["regexPattern"],
-})
-    .refine((data) => {
-    // If enableEnhanceWithAi is true, promptTemplate should be provided
-    if (data.enableEnhanceWithAi && !data.promptTemplate) {
-        return false;
-    }
-    return true;
-}, {
-    message: "promptTemplate is required when enableEnhanceWithAi is true",
-    path: ["promptTemplate"],
-})
-    .describe("Schema for short answer questions with optional AI enhancement");
-// Long answer question schema (extends base question with rich text input properties)
-export const longAnswerQuestionSchema = questionSchema
-    .extend({
-    type: z
-        .literal(questionTypeSchema.enum.long_text)
-        .describe("Must be exactly 'long_text'"),
-    maxCharacters: z
-        .number()
-        .int()
-        .min(1)
-        .max(50000)
-        .optional()
-        .describe("Maximum number of characters allowed (higher limit for long text)"),
-    minCharacters: z
-        .number()
-        .int()
-        .min(0)
-        .optional()
-        .describe("Minimum number of characters required"),
-    rows: z
-        .number()
-        .int()
-        .min(1)
-        .max(20)
-        .optional()
-        .describe("Number of textarea rows to display (1-20)"),
-    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(2000)
-        .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(25000)
-        .optional()
-        .describe("Maximum tokens allowed for AI processing (higher for long text)"),
-})
-    .refine((data) => {
-    // If both minCharacters and maxCharacters are provided, minCharacters should be <= maxCharacters
-    if (data.minCharacters !== undefined &&
-        data.maxCharacters !== undefined) {
-        return data.minCharacters <= data.maxCharacters;
-    }
-    return true;
-}, {
-    message: "minCharacters cannot be greater than maxCharacters",
-    path: ["minCharacters"],
-})
-    .refine((data) => {
-    // If enableEnhanceWithAi is true, promptTemplate should be provided
-    if (data.enableEnhanceWithAi && !data.promptTemplate) {
-        return false;
-    }
-    return true;
-}, {
-    message: "promptTemplate is required when enableEnhanceWithAi is true",
-    path: ["promptTemplate"],
-})
-    .describe("Schema for long answer questions with rich text support and AI enhancement");
-// Nested dropdown question schema (extends base question with hierarchical selection properties)
-export const nestedDropdownQuestionSchema = questionSchema
-    .extend({
-    type: z
-        .literal(questionTypeSchema.enum.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)"),
-    displayStyle: z
-        .literal("list")
-        .describe("Fixed display style for nested dropdowns"),
-    choiceOrderOption: choiceOrderOptionSchema
-        .optional()
-        .default("none")
-        .describe("How to order the nested choices"),
-    preserveLastChoices: z
-        .number()
-        .int()
-        .min(0)
-        .max(10)
-        .optional()
-        .describe("Number of choice levels to preserve (0-10)"),
-    prepopulatedValue: z
-        .string()
-        .max(1000)
-        .optional()
-        .describe("Default value to pre-populate"),
-    allowOther: z
-        .boolean()
-        .optional()
-        .default(false)
-        .describe('Whether to allow custom "other" options'),
-    otherColumnName: z
-        .string()
-        .max(100)
-        .optional()
-        .describe('Column name for storing custom "other" values'),
-    maxDepth: z
-        .number()
-        .int()
-        .min(1)
-        .max(10)
-        .optional()
-        .describe("Maximum nesting depth allowed (1-10)"),
-    cascadeLabels: z
-        .boolean()
-        .optional()
-        .default(false)
-        .describe("Whether to cascade labels from parent options"),
-})
-    .refine((data) => {
-    // If allowOther is true, otherColumnName should be provided
-    if (data.allowOther && !data.otherColumnName) {
-        return false;
-    }
-    return true;
-}, {
-    message: "otherColumnName is required when allowOther is true",
-    path: ["otherColumnName"],
-})
-    .describe("Schema for nested dropdown questions with hierarchical option structure");
-// Combined question schema using discriminated union for proper type safety
-export const combinedQuestionSchema = z.discriminatedUnion("type", [
-    ratingQuestionSchema,
-    annotationQuestionSchema,
-    multipleChoiceSingleQuestionSchema,
-    multipleChoiceMultipleQuestionSchema,
-    npsQuestionSchema,
-    shortAnswerQuestionSchema,
-    longAnswerQuestionSchema,
-    nestedDropdownQuestionSchema,
-]);
-//# sourceMappingURL=field-schema.js.map