@examplary/schemas 1.3.0 → 1.4.0

package/src/question-type-setting.ts

@@ -0,0 +1,67 @@
+import { z } from "zod";
+
+import { Translatable } from "./translatable";
+
+// Setting option for enum type settings
+export const QuestionTypeSettingOption = z
+  .object({
+    value: z.string().describe("Option value"),
+    label: Translatable.describe("Option label"),
+  })
+  .strict()
+  .describe("Setting option");
+
+// Setting configuration
+export const QuestionTypeSetting = z
+  .object({
+    id: z.string().describe("Unique identifier for the setting"),
+    name: Translatable.describe("Display name for the setting"),
+    description: z
+      .string()
+      .optional()
+      .describe(
+        "Description to help AI agents auto-generate question settings",
+      ),
+    type: z
+      .enum([
+        "enum",
+        "string",
+        "string-array",
+        "number",
+        "boolean",
+        "custom",
+        "scoring-criteria",
+        "question-type",
+      ])
+      .describe("Type of the setting"),
+    hidden: z
+      .boolean()
+      .optional()
+      .describe("Whether the setting is hidden from the user"),
+    default: z.any().optional().describe("Default value for the setting"),
+    required: z
+      .boolean()
+      .optional()
+      .describe("Whether this setting is required"),
+    options: z
+      .array(QuestionTypeSettingOption)
+      .optional()
+      .describe("Available options for enum type settings"),
+    placeholder: Translatable.optional().describe(
+      "Placeholder text for the setting",
+    ),
+    step: z.number().optional().describe("Step value for number type settings"),
+    min: z
+      .number()
+      .optional()
+      .describe("Minimum value for number type settings"),
+    max: z
+      .number()
+      .optional()
+      .describe("Maximum value for number type settings"),
+  })
+  .strict()
+  .describe("Setting configuration");
+
+export type SettingType = z.infer<typeof QuestionTypeSetting>;
+export type SettingOptionType = z.infer<typeof QuestionTypeSettingOption>;

package/src/question-type.ts

@@ -1,103 +1,14 @@
 import { z } from "zod";
 
-// Translatable type - can be a simple string or translation object
-const Translatable = z.union([
-  z.string().describe("Simple string value"),
-  z
-    .record(
-      z.string().regex(/^[a-z]{2}(-[A-Z]{2})?$/, "Language code format"),
-      z.string(),
-    )
-    .refine(
-      (obj) => Object.keys(obj).length >= 1,
-      "Translation object must have at least one property",
-    )
-    .describe("Translation object with language codes as keys"),
-]);
+import {
+  PathOrUrlReference,
+  QuestionTypeComponents,
+} from "./question-type-components";
+import { QuestionTypeGenerationOptions } from "./question-type-generation-options";
+import { QuestionTypeGradingOptions } from "./question-type-grading-options";
+import { QuestionTypeSetting } from "./question-type-setting";
+import { Translatable } from "./translatable";
 
-// Path or URL reference type
-const PathOrUrlReference = z
-  .string()
-  .regex(
-    /^(https?:\/\/|\.)([a-zA-Z0-9._~:/?#@!$&'()*+,;=%-]+)$/,
-    "Valid path or URL format",
-  );
-
-// Component reference type
-const ComponentReference = PathOrUrlReference.describe(
-  "Reference to a component, typically a file path or URL",
-);
-
-// Setting option for enum type settings
-const SettingOption = z
-  .object({
-    value: z.string().describe("Option value"),
-    label: Translatable.describe("Option label"),
-  })
-  .strict()
-  .describe("Setting option");
-
-// Setting configuration
-const Setting = z
-  .object({
-    id: z.string().describe("Unique identifier for the setting"),
-    name: Translatable.describe("Display name for the setting"),
-    type: z
-      .enum([
-        "enum",
-        "string",
-        "number",
-        "boolean",
-        "custom",
-        "scoring-criteria",
-        "question-type",
-      ])
-      .describe("Type of the setting"),
-    default: z.any().optional().describe("Default value for the setting"),
-    required: z
-      .boolean()
-      .optional()
-      .describe("Whether this setting is required"),
-    options: z
-      .array(SettingOption)
-      .optional()
-      .describe("Available options for enum type settings"),
-    placeholder: Translatable.optional().describe(
-      "Placeholder text for the setting",
-    ),
-    step: z.number().optional().describe("Step value for number type settings"),
-    min: z
-      .number()
-      .optional()
-      .describe("Minimum value for number type settings"),
-    max: z
-      .number()
-      .optional()
-      .describe("Maximum value for number type settings"),
-  })
-  .strict()
-  .describe("Setting configuration");
-
-// Components configuration
-const Components = z
-  .object({
-    assessment: ComponentReference.optional().describe(
-      "Path to the assessment component (question content)",
-    ),
-    print: ComponentReference.optional().describe(
-      "Path to the print component (for printing the question)",
-    ),
-    "settings-area": ComponentReference.optional().describe(
-      "Path to the settings area component (for configuring question settings)",
-    ),
-    results: ComponentReference.optional().describe(
-      "Path to the results component (for displaying answers)",
-    ),
-  })
-  .strict()
-  .describe("Paths to the components used by this question type");
-
-// Main question type schema
 export const QuestionTypeSchema = z
   .object({
     $schema: z.string().optional(),
@@ -124,10 +35,8 @@ export const QuestionTypeSchema = z
       .max(1)
       .optional()
       .describe("Keyboard shortcut for quick access to this question type"),
-    canAutoGenerate: z
-      .boolean()
-      .optional()
-      .describe("Whether this question type can be automatically generated"),
+    generation: QuestionTypeGenerationOptions.optional(),
+    grading: QuestionTypeGradingOptions.optional(),
     timeEstimateMinutes: z
       .number()
       .min(1)
@@ -173,11 +82,11 @@ export const QuestionTypeSchema = z
     untitledPlaceholder: Translatable.optional().describe(
       "Placeholder text for untitled questions",
     ),
-    components: Components.optional().describe(
+    components: QuestionTypeComponents.optional().describe(
       "Paths to the components used by this question type",
     ),
     settings: z
-      .array(Setting)
+      .array(QuestionTypeSetting)
       .optional()
       .describe("Configuration settings for the question type"),
     public: z
@@ -197,8 +106,3 @@ export const QuestionTypeSchema = z
   .describe("Schema for defining question types in the Examplary system");
 
 export type QuestionType = z.infer<typeof QuestionTypeSchema>;
-export type TranslatableType = z.infer<typeof Translatable>;
-export type ComponentReferenceType = z.infer<typeof ComponentReference>;
-export type SettingType = z.infer<typeof Setting>;
-export type SettingOptionType = z.infer<typeof SettingOption>;
-export type ComponentsType = z.infer<typeof Components>;

package/src/translatable.ts

@@ -0,0 +1,17 @@
+import { z } from "zod";
+
+// Translatable type - can be a simple string or translation object
+export const Translatable = z.union([
+  z.string().describe("Simple string value"),
+  z
+    .record(
+      z.string().regex(/^[a-z]{2}(-[A-Z]{2})?$/, "Language code format"),
+      z.string(),
+    )
+    .refine(
+      (obj) => Object.keys(obj).length >= 1,
+      "Translation object must have at least one property",
+    )
+    .describe("Translation object with language codes as keys"),
+]);
+export type TranslatableType = z.infer<typeof Translatable>;