@examplary/schemas 1.12.0 → 1.14.0

package/dist/common/scalar.js

@@ -1,10 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ScalarSchema = void 0;
-var zod_1 = require("zod");
-exports.ScalarSchema = zod_1.z.union([
-    zod_1.z.string(),
-    zod_1.z.number(),
-    zod_1.z.boolean(),
-    zod_1.z.null(),
+import { z } from "zod";
+export const ScalarSchema = z.union([
+    z.string(),
+    z.number(),
+    z.boolean(),
+    z.null(),
 ]);

package/dist/common/translatable.js

@@ -1,12 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Translatable = void 0;
-var zod_1 = require("zod");
+import { z } from "zod";
 // Translatable type - can be a simple string or translation object
-exports.Translatable = zod_1.z.union([
-    zod_1.z.string().describe("Simple string value"),
-    zod_1.z
-        .record(zod_1.z.string().regex(/^[a-z]{2}(-[A-Z]{2})?$/, "Language code format"), zod_1.z.string())
-        .refine(function (obj) { return Object.keys(obj).length >= 1; }, "Translation object must have at least one property")
+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"),
 ]);

package/dist/index.js

@@ -1,23 +1,7 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
 // Question types
-__exportStar(require("./question-type"), exports);
+export * from "./question-type";
 // Questions
-__exportStar(require("./question"), exports);
+export * from "./question";
 // Common
-__exportStar(require("./common/scalar"), exports);
-__exportStar(require("./common/translatable"), exports);
+export * from "./common/scalar";
+export * from "./common/translatable";

package/dist/question/index.js

@@ -1,18 +1,2 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./question"), exports);
-__exportStar(require("./question-scoring"), exports);
+export * from "./question";
+export * from "./question-scoring";

package/dist/question/question-scoring.js

@@ -1,30 +1,63 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuestionScoringSchema = exports.RubricType = exports.TopLevelScoringCriterionSchema = exports.ScoringCriterionSchema = void 0;
-var zod_1 = require("zod");
-exports.ScoringCriterionSchema = zod_1.z.object({
-    id: zod_1.z.string(),
-    title: zod_1.z.string().nullish(),
-    description: zod_1.z.string().nullish(),
-    points: zod_1.z.number().nullish(),
-    minPoints: zod_1.z.number().nullish(),
-    maxPoints: zod_1.z.number().nullish(),
+import { z } from "zod";
+export const ScoringCriterionSchema = z.object({
+    id: z.string(),
+    title: z
+        .string()
+        .nullish()
+        .describe("The title of the scoring criterion or level. Only applies to analytical levels and holistic criteria."),
+    description: z
+        .string()
+        .nullish()
+        .describe("The description of the scoring criterion or level. For analytical levels, this describes the specific requirements to earn the points for that level. For holistic criteria, this describes the overall requirement to earn the points for that criterion."),
+    points: z
+        .number()
+        .nullish()
+        .describe("The default amount of points to assign if this criterion or level is selected."),
+    minPoints: z
+        .number()
+        .nullish()
+        .describe("The minimum amount of points that can be assigned if this criterion or level is selected."),
+    maxPoints: z
+        .number()
+        .nullish()
+        .describe("The maximum amount of points that can be assigned if this criterion or level is selected."),
 });
-exports.TopLevelScoringCriterionSchema = exports.ScoringCriterionSchema.extend({
-    levels: zod_1.z.array(exports.ScoringCriterionSchema).nullish(),
+export const TopLevelScoringCriterionSchema = ScoringCriterionSchema.extend({
+    levels: z
+        .array(ScoringCriterionSchema)
+        .nullish()
+        .describe("The levels of a analytical rubric criterion. Each level represents a different point value and description for the same criterion."),
 });
-var RubricType;
+export var RubricType;
 (function (RubricType) {
     RubricType["Simple"] = "simple";
     RubricType["Analytical"] = "analytical";
     RubricType["Holistic"] = "holistic";
     RubricType["ExactValues"] = "exact-values";
-})(RubricType || (exports.RubricType = RubricType = {}));
-exports.QuestionScoringSchema = zod_1.z.object({
-    rubricType: zod_1.z.enum(RubricType).nullish(),
-    criteria: zod_1.z.array(exports.TopLevelScoringCriterionSchema).nullish(),
-    exactValuesCaseInsensitive: zod_1.z.boolean().nullish(),
-    guidance: zod_1.z.string().nullish(),
-    modelAnswer: zod_1.z.string().nullish(),
-    templateId: zod_1.z.string().nullish(),
+})(RubricType || (RubricType = {}));
+export const QuestionScoringSchema = z.object({
+    rubricType: z
+        .enum(RubricType)
+        .nullish()
+        .describe("The type of rubric. Different rubric types have different shapes."),
+    criteria: z
+        .array(TopLevelScoringCriterionSchema)
+        .nullish()
+        .describe("The criteria for scoring the question. For 'simple' rubric type, criteria have no levels, and their points stack (total = sum of points for all criteria that apply). For 'analytical' rubric type, there should be at least one criteria, with levels. For each criteria, a matching level is picked. For 'holistic' rubric type, there should be multiple criteria, without levels (score = single selected criteria). For 'exact-values' rubric type, each criteria represents a specific value that must be matched exactly."),
+    exactValuesCaseInsensitive: z
+        .boolean()
+        .nullish()
+        .describe("Whether exact values matching should be case insensitive. Only applicable for 'exact-values' rubric type."),
+    guidance: z
+        .string()
+        .nullish()
+        .describe("Optional additional grading guidance text."),
+    modelAnswer: z
+        .string()
+        .nullish()
+        .describe("Optional example model answer text to show to graders."),
+    templateId: z
+        .string()
+        .nullish()
+        .describe("The ID of the scoring template applied, if any."),
 });

package/dist/question/question.d.ts

@@ -29,15 +29,10 @@ export declare const QuestionSchema: z.ZodObject<{
         templateId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     }, z.core.$strip>>>;
     tags: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     metadata: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>>;
     v: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     questionBankItemId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     traceIds: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
-    /** @deprecated Replaced with `scoring` object */
-    scoringCriteria: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
-        id: z.ZodOptional<z.ZodString>;
-        description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        points: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodNumber>>>;
-    }, z.core.$strip>>>>;
 }, z.core.$loose>;
 export type Question = z.infer<typeof QuestionSchema>;

package/dist/question/question.js

@@ -1,26 +1,43 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuestionSchema = void 0;
-var zod_1 = require("zod");
-var legacy_question_scoring_criteria_1 = require("./legacy-question-scoring-criteria");
-var question_scoring_1 = require("./question-scoring");
-var scalar_1 = require("../common/scalar");
-exports.QuestionSchema = zod_1.z.looseObject({
-    id: zod_1.z.string(),
-    type: zod_1.z.string(),
-    title: zod_1.z.string().nullish(),
-    description: zod_1.z.string().nullish(),
-    settings: zod_1.z.looseObject({}),
+import { z } from "zod";
+import { QuestionScoringSchema } from "./question-scoring";
+import { ScalarSchema } from "../common/scalar";
+export const QuestionSchema = z.looseObject({
+    id: z.string().describe("Question ID"),
+    type: z.string().describe("ID of the question type"),
+    title: z.string().nullish().describe("Title for the question (stem)"),
+    description: z
+        .string()
+        .nullish()
+        .describe("Optional description for the question"),
+    settings: z
+        .looseObject({})
+        .describe("Settings for the question, often specific to the question type"),
     // Scoring
-    scoring: question_scoring_1.QuestionScoringSchema.nullish(),
+    scoring: QuestionScoringSchema.nullish().describe("Scoring configuration for the question"),
     // Tags and metadata
-    tags: zod_1.z.array(zod_1.z.string()).nullish(),
-    metadata: zod_1.z.record(zod_1.z.string(), scalar_1.ScalarSchema).nullish(),
+    tags: z
+        .array(z.string())
+        .nullish()
+        .describe("Tags associated with the question for categorization and search"),
+    externalId: z
+        .string()
+        .nullish()
+        .describe("Optional external ID for the question, used to link to external systems"),
+    metadata: z
+        .record(z.string(), ScalarSchema)
+        .nullish()
+        .describe("Metadata for the question"),
     // Internal tracking
-    v: zod_1.z.number().nullish(), // version number, incremented when question is edited
-    questionBankItemId: zod_1.z.string().nullish(),
-    traceIds: zod_1.z.array(zod_1.z.string()).nullish(),
-    // Deprecated
-    /** @deprecated Replaced with `scoring` object */
-    scoringCriteria: legacy_question_scoring_criteria_1.LegacyQuestionScoringCriteriaSchema.nullish(),
+    v: z
+        .number()
+        .nullish()
+        .describe("Version number, incremented when question is edited"),
+    questionBankItemId: z
+        .string()
+        .nullish()
+        .describe("ID of the question in the question bank"),
+    traceIds: z
+        .array(z.string())
+        .nullish()
+        .describe("Trace IDs for internal tracking of AI generation processes"),
 });

package/dist/question-type/index.js

@@ -1,24 +1,8 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./question-type"), exports);
-__exportStar(require("./question-type-setting"), exports);
-__exportStar(require("./question-type-components"), exports);
-__exportStar(require("./question-type-generation-options"), exports);
-__exportStar(require("./question-type-grading-options"), exports);
-__exportStar(require("./question-type-scanning-options"), exports);
-__exportStar(require("./question-type-capabilities"), exports);
-__exportStar(require("./question-type-qti3"), exports);
+export * from "./question-type";
+export * from "./question-type-setting";
+export * from "./question-type-components";
+export * from "./question-type-generation-options";
+export * from "./question-type-grading-options";
+export * from "./question-type-scanning-options";
+export * from "./question-type-capabilities";
+export * from "./question-type-qti3";

package/dist/question-type/question-type-capabilities.js

@@ -1,9 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuestionTypeCapabilitiesSchema = void 0;
-var zod_1 = require("zod");
-exports.QuestionTypeCapabilitiesSchema = zod_1.z.looseObject({
-    "answer-scanning": zod_1.z
+import { z } from "zod";
+export const QuestionTypeCapabilitiesSchema = z.looseObject({
+    "answer-scanning": z
         .boolean()
         .optional()
         .describe("Whether this question type allows the student to scan an answer using their phone. Only supported for practice spaces."),

package/dist/question-type/question-type-components.js

@@ -1,20 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuestionTypeComponents = exports.ComponentReference = exports.PathOrUrlReference = void 0;
-var zod_1 = require("zod");
+import { z } from "zod";
 // Path or URL reference type
-exports.PathOrUrlReference = zod_1.z
+export const PathOrUrlReference = z
     .string()
     .regex(/^(https?:\/\/|\.)([a-zA-Z0-9._~:/?#@!$&'()*+,;=%-]+)$/, "Valid path or URL format");
 // Component reference type
-exports.ComponentReference = exports.PathOrUrlReference.describe("Reference to a component, typically a file path or URL");
+export const ComponentReference = PathOrUrlReference.describe("Reference to a component, typically a file path or URL");
 // Components configuration
-exports.QuestionTypeComponents = zod_1.z
+export const QuestionTypeComponents = z
     .object({
-    assessment: exports.ComponentReference.optional().describe("Path to the assessment component (question content)"),
-    print: exports.ComponentReference.optional().describe("Path to the print component (for printing the question)"),
-    "settings-area": exports.ComponentReference.optional().describe("Path to the settings area component (for configuring question settings)"),
-    results: exports.ComponentReference.optional().describe("Path to the results component (for displaying answers)"),
+    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");

package/dist/question-type/question-type-generation-options.js

@@ -1,15 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuestionTypeGenerationOptions = void 0;
-var zod_1 = require("zod");
-exports.QuestionTypeGenerationOptions = zod_1.z
+import { z } from "zod";
+export const QuestionTypeGenerationOptions = z
     .object({
-    enabled: zod_1.z
+    enabled: z
         .boolean()
         .describe("Whether this question type can be automatically generated using AI (default to false)"),
-    instructions: zod_1.z
+    instructions: z
         .string()
-        .or(zod_1.z.array(zod_1.z.string()))
+        .or(z.array(z.string()))
         .optional()
         .describe("Optional instructions to guide AI in generating this question type"),
 })

package/dist/question-type/question-type-grading-options.js

@@ -1,15 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuestionTypeGradingOptions = void 0;
-var zod_1 = require("zod");
-exports.QuestionTypeGradingOptions = zod_1.z
+import { z } from "zod";
+export const QuestionTypeGradingOptions = z
     .object({
-    enabled: zod_1.z
+    enabled: z
         .boolean()
         .describe("Whether this question type can be automatically graded using AI (default to false)"),
-    instructions: zod_1.z
+    instructions: z
         .string()
-        .or(zod_1.z.array(zod_1.z.string()))
+        .or(z.array(z.string()))
         .optional()
         .describe("Optional instructions to guide AI in grading this question type"),
 })

package/dist/question-type/question-type-qti3.js

@@ -1,18 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Qti3Mapping = exports.QtiInteractionType = void 0;
-var zod_1 = require("zod");
+import { z } from "zod";
 /**
  * A value that can either be a literal or a JSONata expression string.
  * JSONata expressions are evaluated at transform time against the question context.
  */
-var JsonataExpr = zod_1.z
-    .union([zod_1.z.string(), zod_1.z.number(), zod_1.z.boolean(), zod_1.z.array(zod_1.z.any()), zod_1.z.object({})])
+const JsonataExpr = z
+    .union([z.string(), z.number(), z.boolean(), z.array(z.any()), z.object({})])
     .describe("Literal or JSONata expression string starting with '='");
 /**
  * Supported QTI 3.0 interaction types
  */
-exports.QtiInteractionType = zod_1.z.enum([
+export const QtiInteractionType = z.enum([
     "AssociateInteraction",
     "ChoiceInteraction",
     "DrawingInteraction",
@@ -38,11 +35,11 @@ exports.QtiInteractionType = zod_1.z.enum([
 /**
  * Complete QTI mapping configuration for a question type
  */
-exports.Qti3Mapping = zod_1.z
+export const Qti3Mapping = z
     .object({
-    interaction: zod_1.z.object({
-        type: exports.QtiInteractionType.describe("The QTI interaction type to generate"),
-        options: zod_1.z.record(zod_1.z.string(), JsonataExpr).optional(),
+    interaction: z.object({
+        type: QtiInteractionType.describe("The QTI interaction type to generate"),
+        options: z.record(z.string(), JsonataExpr).optional(),
     }),
 })
     .describe("QTI 3.0 mapping configuration for transforming questions to QTI format");

package/dist/question-type/question-type-scanning-options.js

@@ -1,12 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuestionTypeScanningOptions = void 0;
-var zod_1 = require("zod");
-exports.QuestionTypeScanningOptions = zod_1.z
+import { z } from "zod";
+export const QuestionTypeScanningOptions = z
     .object({
-    instructions: zod_1.z
+    instructions: z
         .string()
-        .or(zod_1.z.array(zod_1.z.string()))
+        .or(z.array(z.string()))
         .optional()
         .describe("Optional instructions to guide AI in converting answers for this question type when scanning documents"),
 })

package/dist/question-type/question-type-setting.js

@@ -1,27 +1,24 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuestionTypeSetting = exports.QuestionTypeSettingOption = void 0;
-var zod_1 = require("zod");
-var translatable_1 = require("../common/translatable");
+import { z } from "zod";
+import { Translatable } from "../common/translatable";
 // Setting option for enum type settings
-exports.QuestionTypeSettingOption = zod_1.z
+export const QuestionTypeSettingOption = z
     .object({
-    value: zod_1.z.string().describe("Option value"),
-    label: translatable_1.Translatable.describe("Option label"),
+    value: z.string().describe("Option value"),
+    label: Translatable.describe("Option label"),
 })
     .strict()
     .describe("Setting option");
 // Setting configuration
-exports.QuestionTypeSetting = zod_1.z
+export const QuestionTypeSetting = z
     .object({
-    id: zod_1.z.string().describe("Unique identifier for the setting"),
-    name: translatable_1.Translatable.describe("Display name for the setting"),
-    helpText: translatable_1.Translatable.optional().describe("Help text for the setting"),
-    description: zod_1.z
+    id: z.string().describe("Unique identifier for the setting"),
+    name: Translatable.describe("Display name for the setting"),
+    helpText: Translatable.optional().describe("Help text for the setting"),
+    description: z
         .string()
         .optional()
         .describe("Description to help AI agents auto-generate question settings"),
-    type: zod_1.z
+    type: z
         .enum([
         "enum",
         "string",
@@ -34,27 +31,27 @@ exports.QuestionTypeSetting = zod_1.z
         "question-type",
     ])
         .describe("Type of the setting"),
-    index: zod_1.z.number().optional(),
-    hidden: zod_1.z
+    index: z.number().optional(),
+    hidden: z
         .boolean()
         .optional()
         .describe("Whether the setting is hidden from the user"),
-    default: zod_1.z.any().nullish().describe("Default value for the setting"),
-    required: zod_1.z
+    default: z.any().nullish().describe("Default value for the setting"),
+    required: z
         .boolean()
         .optional()
         .describe("Whether this setting is required"),
-    options: zod_1.z
-        .array(exports.QuestionTypeSettingOption)
+    options: z
+        .array(QuestionTypeSettingOption)
         .optional()
         .describe("Available options for enum type settings"),
-    placeholder: translatable_1.Translatable.nullish().describe("Placeholder text for the setting"),
-    step: zod_1.z.number().optional().describe("Step value for number type settings"),
-    min: zod_1.z
+    placeholder: Translatable.nullish().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: zod_1.z
+    max: z
         .number()
         .optional()
         .describe("Maximum value for number type settings"),

package/dist/question-type/question-type.js

@@ -1,94 +1,91 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuestionTypeSchema = void 0;
-var zod_1 = require("zod");
-var question_type_capabilities_1 = require("./question-type-capabilities");
-var question_type_components_1 = require("./question-type-components");
-var question_type_generation_options_1 = require("./question-type-generation-options");
-var question_type_grading_options_1 = require("./question-type-grading-options");
-var question_type_qti3_1 = require("./question-type-qti3");
-var question_type_scanning_options_1 = require("./question-type-scanning-options");
-var question_type_setting_1 = require("./question-type-setting");
-var scalar_1 = require("../common/scalar");
-var translatable_1 = require("../common/translatable");
-exports.QuestionTypeSchema = zod_1.z
+import { z } from "zod";
+import { QuestionTypeCapabilitiesSchema } from "./question-type-capabilities";
+import { PathOrUrlReference, QuestionTypeComponents, } from "./question-type-components";
+import { QuestionTypeGenerationOptions } from "./question-type-generation-options";
+import { QuestionTypeGradingOptions } from "./question-type-grading-options";
+import { Qti3Mapping } from "./question-type-qti3";
+import { QuestionTypeScanningOptions } from "./question-type-scanning-options";
+import { QuestionTypeSetting } from "./question-type-setting";
+import { ScalarSchema } from "../common/scalar";
+import { Translatable } from "../common/translatable";
+export const QuestionTypeSchema = z
     .object({
-    $schema: zod_1.z.string().optional(),
-    id: zod_1.z
+    $schema: z.string().optional(),
+    id: z
         .string()
         .regex(/^([a-z][a-z0-9-]*)(\.[a-z][a-z0-9-]*)+$/, "Valid question type ID format")
         .describe("Unique identifier for the question type (e.g. 'my-org.color-picker')"),
-    name: translatable_1.Translatable.describe("Display name for the question type, can be a simple string or translation object"),
-    description: translatable_1.Translatable.describe("Description of the question type, can be a simple string or translation object"),
-    icon: question_type_components_1.PathOrUrlReference.optional().describe("Path to the icon for this question type"),
-    shortcut: zod_1.z
+    name: Translatable.describe("Display name for the question type, can be a simple string or translation object"),
+    description: Translatable.describe("Description of the question type, can be a simple string or translation object"),
+    icon: PathOrUrlReference.optional().describe("Path to the icon for this question type"),
+    shortcut: z
         .string()
         .max(1)
         .optional()
         .describe("Keyboard shortcut for quick access to this question type"),
-    generation: question_type_generation_options_1.QuestionTypeGenerationOptions.optional(),
-    grading: question_type_grading_options_1.QuestionTypeGradingOptions.optional(),
-    scanning: question_type_scanning_options_1.QuestionTypeScanningOptions.optional(),
-    timeEstimateMinutes: zod_1.z
+    generation: QuestionTypeGenerationOptions.optional(),
+    grading: QuestionTypeGradingOptions.optional(),
+    scanning: QuestionTypeScanningOptions.optional(),
+    timeEstimateMinutes: z
         .number()
         .min(1)
         .optional()
         .describe("Estimated time in minutes to complete this question type"),
-    isAi: zod_1.z
+    isAi: z
         .boolean()
         .optional()
         .describe("Whether this question type uses AI functionality"),
-    backgroundColor: zod_1.z
+    backgroundColor: z
         .string()
         .optional()
         .describe("Background color for the question type"),
-    enforcePosition: zod_1.z
+    enforcePosition: z
         .enum(["start", "end"])
         .optional()
         .describe("Position enforcement for this question type"),
-    enforceTitle: translatable_1.Translatable.optional().describe("Enforced title for this question type"),
-    hideSettings: zod_1.z
+    enforceTitle: Translatable.optional().describe("Enforced title for this question type"),
+    hideSettings: z
         .boolean()
         .optional()
         .describe("Whether to hide settings for this question type"),
-    isPreviewRefreshable: zod_1.z
+    isPreviewRefreshable: z
         .boolean()
         .optional()
         .describe("Whether the preview can be refreshed for this question type"),
-    hasSimpleScoring: zod_1.z
+    hasSimpleScoring: z
         .boolean()
         .optional()
         .describe("Whether this question type has simple scoring"),
-    titlePlaceholder: translatable_1.Translatable.optional().describe("Placeholder text for the title field"),
-    descriptionPlaceholder: translatable_1.Translatable.optional().describe("Placeholder text for the description field"),
-    untitledPlaceholder: translatable_1.Translatable.optional().describe("Placeholder text for untitled questions"),
-    components: question_type_components_1.QuestionTypeComponents.optional().describe("Paths to the components used by this question type"),
-    settings: zod_1.z
-        .array(question_type_setting_1.QuestionTypeSetting)
+    titlePlaceholder: Translatable.optional().describe("Placeholder text for the title field"),
+    descriptionPlaceholder: Translatable.optional().describe("Placeholder text for the description field"),
+    untitledPlaceholder: Translatable.optional().describe("Placeholder text for untitled questions"),
+    components: QuestionTypeComponents.optional().describe("Paths to the components used by this question type"),
+    settings: z
+        .array(QuestionTypeSetting)
         .optional()
         .describe("Configuration settings for the question type"),
-    public: zod_1.z
+    public: z
         .boolean()
         .optional()
         .describe("Whether this question type is public and can be used by all users"),
-    translations: zod_1.z
-        .record(zod_1.z.string(), translatable_1.Translatable)
+    translations: z
+        .record(z.string(), Translatable)
         .optional()
         .describe("Custom translations for this question type"),
-    capabilities: question_type_capabilities_1.QuestionTypeCapabilitiesSchema.optional().describe("Capabilities of the question type for various operations"),
-    export: zod_1.z
+    capabilities: QuestionTypeCapabilitiesSchema.optional().describe("Capabilities of the question type for various operations"),
+    export: z
         .object({
-        qti3: question_type_qti3_1.Qti3Mapping.optional().describe("QTI 3.0 mapping configuration for transforming questions to QTI format"),
+        qti3: Qti3Mapping.optional().describe("QTI 3.0 mapping configuration for transforming questions to QTI format"),
     })
         .optional()
         .describe("Export configuration for various formats"),
-    metadata: zod_1.z
-        .record(zod_1.z.string(), scalar_1.ScalarSchema)
+    metadata: z
+        .record(z.string(), ScalarSchema)
         .optional()
         .describe("Optional metadata for the question type, only used by external applications"),
-    stylesheet: zod_1.z.url().optional(),
-    index: zod_1.z.number().optional(),
-    isDefault: zod_1.z.boolean().optional(),
+    stylesheet: z.url().optional(),
+    index: z.number().optional(),
+    isDefault: z.boolean().optional(),
 })
     .strict()
     .describe("Schema for defining question types in the Examplary system");

package/dist/schemas/question-scoring.json

@@ -3,6 +3,7 @@
   "type": "object",
   "properties": {
     "rubricType": {
+      "description": "The type of rubric. Different rubric types have different shapes.",
       "anyOf": [
         {
           "type": "string",
@@ -19,6 +20,7 @@
       ]
     },
     "criteria": {
+      "description": "The criteria for scoring the question. For 'simple' rubric type, criteria have no levels, and their points stack (total = sum of points for all criteria that apply). For 'analytical' rubric type, there should be at least one criteria, with levels. For each criteria, a matching level is picked. For 'holistic' rubric type, there should be multiple criteria, without levels (score = single selected criteria). For 'exact-values' rubric type, each criteria represents a specific value that must be matched exactly.",
       "anyOf": [
         {
           "type": "array",
@@ -29,6 +31,7 @@
                 "type": "string"
               },
               "title": {
+                "description": "The title of the scoring criterion or level. Only applies to analytical levels and holistic criteria.",
                 "anyOf": [
                   {
                     "type": "string"
@@ -39,6 +42,7 @@
                 ]
               },
               "description": {
+                "description": "The description of the scoring criterion or level. For analytical levels, this describes the specific requirements to earn the points for that level. For holistic criteria, this describes the overall requirement to earn the points for that criterion.",
                 "anyOf": [
                   {
                     "type": "string"
@@ -49,6 +53,7 @@
                 ]
               },
               "points": {
+                "description": "The default amount of points to assign if this criterion or level is selected.",
                 "anyOf": [
                   {
                     "type": "number"
@@ -59,6 +64,7 @@
                 ]
               },
               "minPoints": {
+                "description": "The minimum amount of points that can be assigned if this criterion or level is selected.",
                 "anyOf": [
                   {
                     "type": "number"
@@ -69,6 +75,7 @@
                 ]
               },
               "maxPoints": {
+                "description": "The maximum amount of points that can be assigned if this criterion or level is selected.",
                 "anyOf": [
                   {
                     "type": "number"
@@ -79,6 +86,7 @@
                 ]
               },
               "levels": {
+                "description": "The levels of a analytical rubric criterion. Each level represents a different point value and description for the same criterion.",
                 "anyOf": [
                   {
                     "type": "array",
@@ -89,6 +97,7 @@
                           "type": "string"
                         },
                         "title": {
+                          "description": "The title of the scoring criterion or level. Only applies to analytical levels and holistic criteria.",
                           "anyOf": [
                             {
                               "type": "string"
@@ -99,6 +108,7 @@
                           ]
                         },
                         "description": {
+                          "description": "The description of the scoring criterion or level. For analytical levels, this describes the specific requirements to earn the points for that level. For holistic criteria, this describes the overall requirement to earn the points for that criterion.",
                           "anyOf": [
                             {
                               "type": "string"
@@ -109,6 +119,7 @@
                           ]
                         },
                         "points": {
+                          "description": "The default amount of points to assign if this criterion or level is selected.",
                           "anyOf": [
                             {
                               "type": "number"
@@ -119,6 +130,7 @@
                           ]
                         },
                         "minPoints": {
+                          "description": "The minimum amount of points that can be assigned if this criterion or level is selected.",
                           "anyOf": [
                             {
                               "type": "number"
@@ -129,6 +141,7 @@
                           ]
                         },
                         "maxPoints": {
+                          "description": "The maximum amount of points that can be assigned if this criterion or level is selected.",
                           "anyOf": [
                             {
                               "type": "number"
@@ -163,6 +176,7 @@
       ]
     },
     "exactValuesCaseInsensitive": {
+      "description": "Whether exact values matching should be case insensitive. Only applicable for 'exact-values' rubric type.",
       "anyOf": [
         {
           "type": "boolean"
@@ -173,6 +187,7 @@
       ]
     },
     "guidance": {
+      "description": "Optional additional grading guidance text.",
       "anyOf": [
         {
           "type": "string"
@@ -183,6 +198,7 @@
       ]
     },
     "modelAnswer": {
+      "description": "Optional example model answer text to show to graders.",
       "anyOf": [
         {
           "type": "string"
@@ -193,6 +209,7 @@
       ]
     },
     "templateId": {
+      "description": "The ID of the scoring template applied, if any.",
       "anyOf": [
         {
           "type": "string"

package/dist/schemas/question.json

@@ -3,12 +3,15 @@
   "type": "object",
   "properties": {
     "id": {
-      "type": "string"
+      "type": "string",
+      "description": "Question ID"
     },
     "type": {
-      "type": "string"
+      "type": "string",
+      "description": "ID of the question type"
     },
     "title": {
+      "description": "Title for the question (stem)",
       "anyOf": [
         {
           "type": "string"
@@ -19,6 +22,7 @@
       ]
     },
     "description": {
+      "description": "Optional description for the question",
       "anyOf": [
         {
           "type": "string"
@@ -31,14 +35,17 @@
     "settings": {
       "type": "object",
       "properties": {},
-      "additionalProperties": {}
+      "additionalProperties": {},
+      "description": "Settings for the question, often specific to the question type"
     },
     "scoring": {
+      "description": "Scoring configuration for the question",
       "anyOf": [
         {
           "type": "object",
           "properties": {
             "rubricType": {
+              "description": "The type of rubric. Different rubric types have different shapes.",
               "anyOf": [
                 {
                   "type": "string",
@@ -55,6 +62,7 @@
               ]
             },
             "criteria": {
+              "description": "The criteria for scoring the question. For 'simple' rubric type, criteria have no levels, and their points stack (total = sum of points for all criteria that apply). For 'analytical' rubric type, there should be at least one criteria, with levels. For each criteria, a matching level is picked. For 'holistic' rubric type, there should be multiple criteria, without levels (score = single selected criteria). For 'exact-values' rubric type, each criteria represents a specific value that must be matched exactly.",
               "anyOf": [
                 {
                   "type": "array",
@@ -65,6 +73,7 @@
                         "type": "string"
                       },
                       "title": {
+                        "description": "The title of the scoring criterion or level. Only applies to analytical levels and holistic criteria.",
                         "anyOf": [
                           {
                             "type": "string"
@@ -75,6 +84,7 @@
                         ]
                       },
                       "description": {
+                        "description": "The description of the scoring criterion or level. For analytical levels, this describes the specific requirements to earn the points for that level. For holistic criteria, this describes the overall requirement to earn the points for that criterion.",
                         "anyOf": [
                           {
                             "type": "string"
@@ -85,6 +95,7 @@
                         ]
                       },
                       "points": {
+                        "description": "The default amount of points to assign if this criterion or level is selected.",
                         "anyOf": [
                           {
                             "type": "number"
@@ -95,6 +106,7 @@
                         ]
                       },
                       "minPoints": {
+                        "description": "The minimum amount of points that can be assigned if this criterion or level is selected.",
                         "anyOf": [
                           {
                             "type": "number"
@@ -105,6 +117,7 @@
                         ]
                       },
                       "maxPoints": {
+                        "description": "The maximum amount of points that can be assigned if this criterion or level is selected.",
                         "anyOf": [
                           {
                             "type": "number"
@@ -115,6 +128,7 @@
                         ]
                       },
                       "levels": {
+                        "description": "The levels of a analytical rubric criterion. Each level represents a different point value and description for the same criterion.",
                         "anyOf": [
                           {
                             "type": "array",
@@ -125,6 +139,7 @@
                                   "type": "string"
                                 },
                                 "title": {
+                                  "description": "The title of the scoring criterion or level. Only applies to analytical levels and holistic criteria.",
                                   "anyOf": [
                                     {
                                       "type": "string"
@@ -135,6 +150,7 @@
                                   ]
                                 },
                                 "description": {
+                                  "description": "The description of the scoring criterion or level. For analytical levels, this describes the specific requirements to earn the points for that level. For holistic criteria, this describes the overall requirement to earn the points for that criterion.",
                                   "anyOf": [
                                     {
                                       "type": "string"
@@ -145,6 +161,7 @@
                                   ]
                                 },
                                 "points": {
+                                  "description": "The default amount of points to assign if this criterion or level is selected.",
                                   "anyOf": [
                                     {
                                       "type": "number"
@@ -155,6 +172,7 @@
                                   ]
                                 },
                                 "minPoints": {
+                                  "description": "The minimum amount of points that can be assigned if this criterion or level is selected.",
                                   "anyOf": [
                                     {
                                       "type": "number"
@@ -165,6 +183,7 @@
                                   ]
                                 },
                                 "maxPoints": {
+                                  "description": "The maximum amount of points that can be assigned if this criterion or level is selected.",
                                   "anyOf": [
                                     {
                                       "type": "number"
@@ -199,6 +218,7 @@
               ]
             },
             "exactValuesCaseInsensitive": {
+              "description": "Whether exact values matching should be case insensitive. Only applicable for 'exact-values' rubric type.",
               "anyOf": [
                 {
                   "type": "boolean"
@@ -209,6 +229,7 @@
               ]
             },
             "guidance": {
+              "description": "Optional additional grading guidance text.",
               "anyOf": [
                 {
                   "type": "string"
@@ -219,6 +240,7 @@
               ]
             },
             "modelAnswer": {
+              "description": "Optional example model answer text to show to graders.",
               "anyOf": [
                 {
                   "type": "string"
@@ -229,6 +251,7 @@
               ]
             },
             "templateId": {
+              "description": "The ID of the scoring template applied, if any.",
               "anyOf": [
                 {
                   "type": "string"
@@ -247,6 +270,7 @@
       ]
     },
     "tags": {
+      "description": "Tags associated with the question for categorization and search",
       "anyOf": [
         {
           "type": "array",
@@ -259,7 +283,19 @@
         }
       ]
     },
+    "externalId": {
+      "description": "Optional external ID for the question, used to link to external systems",
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
     "metadata": {
+      "description": "Metadata for the question",
       "anyOf": [
         {
           "type": "object",
@@ -289,6 +325,7 @@
       ]
     },
     "v": {
+      "description": "Version number, incremented when question is edited",
       "anyOf": [
         {
           "type": "number"
@@ -299,6 +336,7 @@
       ]
     },
     "questionBankItemId": {
+      "description": "ID of the question in the question bank",
       "anyOf": [
         {
           "type": "string"
@@ -309,6 +347,7 @@
       ]
     },
     "traceIds": {
+      "description": "Trace IDs for internal tracking of AI generation processes",
       "anyOf": [
         {
           "type": "array",
@@ -320,49 +359,6 @@
           "type": "null"
         }
       ]
-    },
-    "scoringCriteria": {
-      "anyOf": [
-        {
-          "type": "array",
-          "items": {
-            "type": "object",
-            "properties": {
-              "id": {
-                "type": "string"
-              },
-              "description": {
-                "anyOf": [
-                  {
-                    "type": "string"
-                  },
-                  {
-                    "type": "null"
-                  }
-                ]
-              },
-              "points": {
-                "default": 1,
-                "anyOf": [
-                  {
-                    "type": "number"
-                  },
-                  {
-                    "type": "null"
-                  }
-                ]
-              }
-            },
-            "required": [
-              "points"
-            ],
-            "additionalProperties": false
-          }
-        },
-        {
-          "type": "null"
-        }
-      ]
     }
   },
   "required": [

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@examplary/schemas",
   "packageManager": "yarn@4.8.1",
-  "version": "1.12.0",
+  "version": "1.14.0",
   "description": "Schemas for the Examplary platform.",
   "scripts": {
     "build:schema": "tsx ./scripts/build.ts",
@@ -20,15 +20,15 @@
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "devDependencies": {
-    "serverless": "^4.33.0",
+    "serverless": "^4.34.0",
     "serverless-lift": "^1.34.1",
     "tsx": "^4.20.6",
-    "typescript": "^5.9.3"
+    "typescript": "^6.0.3"
   },
   "dependencies": {
     "zod": "^4.3.6"
   },
-  "homepage": "https://developers.examplary.ai/",
+  "homepage": "https://examplary.ai/developers",
   "author": {
     "name": "Examplary AI",
     "email": "hi@examplary.ai"

package/dist/question/legacy-question-scoring-criteria.d.ts

@@ -1,9 +0,0 @@
-import { z } from "zod";
-/** @deprecated Replaced with `scoring` object */
-export declare const LegacyQuestionScoringCriteriaSchema: z.ZodArray<z.ZodObject<{
-    id: z.ZodOptional<z.ZodString>;
-    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    points: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodNumber>>>;
-}, z.core.$strip>>;
-/** @deprecated Replaced with `scoring` object */
-export type LegacyQuestionScoringCriteria = z.infer<typeof LegacyQuestionScoringCriteriaSchema>;

package/dist/question/legacy-question-scoring-criteria.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LegacyQuestionScoringCriteriaSchema = void 0;
-var zod_1 = require("zod");
-/** @deprecated Replaced with `scoring` object */
-exports.LegacyQuestionScoringCriteriaSchema = zod_1.z.array(zod_1.z.object({
-    id: zod_1.z.string().optional(),
-    description: zod_1.z.string().nullish(),
-    points: zod_1.z.number().nullish().default(1),
-}));