@examplary/schemas 1.7.0 → 1.9.0

package/dist/common/scalar.d.ts

@@ -0,0 +1,3 @@
+import { z } from "zod";
+export declare const ScalarSchema: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>;
+export type Scalar = z.infer<typeof ScalarSchema>;

package/dist/common/scalar.js

@@ -0,0 +1,10 @@
+"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(),
+]);

package/dist/index.d.ts

@@ -1,10 +1,8 @@
-export * from "./translatable";
-export type * from "./translatable";
 export * from "./question-type";
 export type * from "./question-type";
-export * from "./question-type-setting";
-export type * from "./question-type-setting";
-export * from "./question-type-components";
-export type * from "./question-type-components";
-export * from "./question-type-generation-options";
-export type * from "./question-type-generation-options";
+export * from "./question";
+export type * from "./question";
+export * from "./common/scalar";
+export type * from "./common/scalar";
+export * from "./common/translatable";
+export type * from "./common/translatable";

package/dist/index.js

@@ -14,10 +14,10 @@ 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 });
-// General
-__exportStar(require("./translatable"), exports);
 // Question types
 __exportStar(require("./question-type"), exports);
-__exportStar(require("./question-type-setting"), exports);
-__exportStar(require("./question-type-components"), exports);
-__exportStar(require("./question-type-generation-options"), exports);
+// Questions
+__exportStar(require("./question"), exports);
+// Common
+__exportStar(require("./common/scalar"), exports);
+__exportStar(require("./common/translatable"), exports);

package/dist/question/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./question";
+export type * from "./question";
+export * from "./question-scoring";
+export type * from "./question-scoring";

package/dist/question/index.js

@@ -0,0 +1,18 @@
+"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);

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

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,10 @@
+"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),
+}));

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

@@ -0,0 +1,55 @@
+import { z } from "zod";
+export declare const ScoringCriterionSchema: z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    points: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    minPoints: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    maxPoints: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, z.core.$strip>;
+export type ScoringCriterion = z.infer<typeof ScoringCriterionSchema>;
+export declare const TopLevelScoringCriterionSchema: z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    points: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    minPoints: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    maxPoints: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    levels: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        points: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        minPoints: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        maxPoints: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>>>;
+}, z.core.$strip>;
+export declare enum RubricType {
+    Simple = "simple",
+    Analytical = "analytical",
+    Holistic = "holistic",
+    ExactValues = "exact-values"
+}
+export declare const QuestionScoringSchema: z.ZodObject<{
+    rubricType: z.ZodOptional<z.ZodNullable<z.ZodEnum<typeof RubricType>>>;
+    criteria: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        points: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        minPoints: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        maxPoints: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        levels: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            points: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            minPoints: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            maxPoints: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        }, z.core.$strip>>>>;
+    }, z.core.$strip>>>>;
+    guidance: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    modelAnswer: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    templateId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type QuestionScoring = z.infer<typeof QuestionScoringSchema>;

package/dist/question/question-scoring.js

@@ -0,0 +1,29 @@
+"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(),
+});
+exports.TopLevelScoringCriterionSchema = exports.ScoringCriterionSchema.extend({
+    levels: zod_1.z.array(exports.ScoringCriterionSchema).nullish(),
+});
+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(),
+    guidance: zod_1.z.string().nullish(),
+    modelAnswer: zod_1.z.string().nullish(),
+    templateId: zod_1.z.string().nullish(),
+});

package/dist/question/question.d.ts

@@ -0,0 +1,42 @@
+import { z } from "zod";
+export declare const QuestionSchema: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodString;
+    title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    settings: z.ZodObject<{}, z.core.$loose>;
+    scoring: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        rubricType: z.ZodOptional<z.ZodNullable<z.ZodEnum<typeof import("./question-scoring").RubricType>>>;
+        criteria: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            points: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            minPoints: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            maxPoints: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            levels: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                points: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+                minPoints: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+                maxPoints: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            }, z.core.$strip>>>>;
+        }, z.core.$strip>>>>;
+        guidance: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        modelAnswer: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        templateId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>>;
+    tags: z.ZodOptional<z.ZodNullable<z.ZodArray<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

@@ -0,0 +1,26 @@
+"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({}),
+    // Scoring
+    scoring: question_scoring_1.QuestionScoringSchema.nullish(),
+    // 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(),
+    // 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(),
+});

package/{src/index.ts → dist/question-type/index.d.ts}

@@ -1,8 +1,3 @@
-// General
-export * from "./translatable";
-export type * from "./translatable";
-
-// Question types
 export * from "./question-type";
 export type * from "./question-type";
 export * from "./question-type-setting";

package/dist/question-type/index.js

@@ -0,0 +1,20 @@
+"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);

package/dist/{question-type-qti3.d.ts → question-type/question-type-qti3.d.ts}

@@ -18,6 +18,7 @@ export declare const QtiInteractionType: z.ZodEnum<{
     MatchInteraction: "MatchInteraction";
     MediaInteraction: "MediaInteraction";
     OrderInteraction: "OrderInteraction";
+    PortableCustomInteraction: "PortableCustomInteraction";
     PositionObjectInteraction: "PositionObjectInteraction";
     SelectPointInteraction: "SelectPointInteraction";
     SliderInteraction: "SliderInteraction";
@@ -46,6 +47,7 @@ export declare const Qti3Mapping: z.ZodObject<{
             MatchInteraction: "MatchInteraction";
             MediaInteraction: "MediaInteraction";
             OrderInteraction: "OrderInteraction";
+            PortableCustomInteraction: "PortableCustomInteraction";
             PositionObjectInteraction: "PositionObjectInteraction";
             SelectPointInteraction: "SelectPointInteraction";
             SliderInteraction: "SliderInteraction";

package/dist/{question-type-qti3.js → question-type/question-type-qti3.js}

@@ -28,6 +28,7 @@ exports.QtiInteractionType = zod_1.z.enum([
     "MatchInteraction",
     "MediaInteraction",
     "OrderInteraction",
+    "PortableCustomInteraction",
     "PositionObjectInteraction",
     "SelectPointInteraction",
     "SliderInteraction",

package/dist/{question-type-setting.js → question-type/question-type-setting.js}

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.QuestionTypeSetting = exports.QuestionTypeSettingOption = void 0;
 var zod_1 = require("zod");
-var translatable_1 = require("./translatable");
+var translatable_1 = require("../common/translatable");
 // Setting option for enum type settings
 exports.QuestionTypeSettingOption = zod_1.z
     .object({

package/dist/{question-type.d.ts → question-type/question-type.d.ts}

@@ -84,6 +84,7 @@ export declare const QuestionTypeSchema: z.ZodObject<{
                     MatchInteraction: "MatchInteraction";
                     MediaInteraction: "MediaInteraction";
                     OrderInteraction: "OrderInteraction";
+                    PortableCustomInteraction: "PortableCustomInteraction";
                     PositionObjectInteraction: "PositionObjectInteraction";
                     SelectPointInteraction: "SelectPointInteraction";
                     SliderInteraction: "SliderInteraction";
@@ -96,6 +97,6 @@ export declare const QuestionTypeSchema: z.ZodObject<{
     }, z.core.$strip>>;
     stylesheet: z.ZodOptional<z.ZodURL>;
     index: z.ZodOptional<z.ZodNumber>;
-    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
 }, z.core.$strict>;
 export type QuestionType = z.infer<typeof QuestionTypeSchema>;

package/dist/{question-type.js → question-type/question-type.js}

@@ -7,7 +7,8 @@ var question_type_generation_options_1 = require("./question-type-generation-opt
 var question_type_grading_options_1 = require("./question-type-grading-options");
 var question_type_qti3_1 = require("./question-type-qti3");
 var question_type_setting_1 = require("./question-type-setting");
-var translatable_1 = require("./translatable");
+var scalar_1 = require("../common/scalar");
+var translatable_1 = require("../common/translatable");
 exports.QuestionTypeSchema = zod_1.z
     .object({
     $schema: zod_1.z.string().optional(),
@@ -80,7 +81,7 @@ exports.QuestionTypeSchema = zod_1.z
     stylesheet: zod_1.z.url().optional(),
     index: zod_1.z.number().optional(),
     metadata: zod_1.z
-        .record(zod_1.z.string(), zod_1.z.any())
+        .record(zod_1.z.string(), scalar_1.ScalarSchema)
         .optional()
         .describe("Optional metadata for the question type, only used by external applications"),
 })

package/dist/schemas/question-scoring.json

@@ -0,0 +1,197 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "rubricType": {
+      "anyOf": [
+        {
+          "type": "string",
+          "enum": [
+            "simple",
+            "analytical",
+            "holistic",
+            "exact-values"
+          ]
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "criteria": {
+      "anyOf": [
+        {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              },
+              "title": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              },
+              "description": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              },
+              "points": {
+                "anyOf": [
+                  {
+                    "type": "number"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              },
+              "minPoints": {
+                "anyOf": [
+                  {
+                    "type": "number"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              },
+              "maxPoints": {
+                "anyOf": [
+                  {
+                    "type": "number"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              },
+              "levels": {
+                "anyOf": [
+                  {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "id": {
+                          "type": "string"
+                        },
+                        "title": {
+                          "anyOf": [
+                            {
+                              "type": "string"
+                            },
+                            {
+                              "type": "null"
+                            }
+                          ]
+                        },
+                        "description": {
+                          "anyOf": [
+                            {
+                              "type": "string"
+                            },
+                            {
+                              "type": "null"
+                            }
+                          ]
+                        },
+                        "points": {
+                          "anyOf": [
+                            {
+                              "type": "number"
+                            },
+                            {
+                              "type": "null"
+                            }
+                          ]
+                        },
+                        "minPoints": {
+                          "anyOf": [
+                            {
+                              "type": "number"
+                            },
+                            {
+                              "type": "null"
+                            }
+                          ]
+                        },
+                        "maxPoints": {
+                          "anyOf": [
+                            {
+                              "type": "number"
+                            },
+                            {
+                              "type": "null"
+                            }
+                          ]
+                        }
+                      },
+                      "required": [
+                        "id"
+                      ],
+                      "additionalProperties": false
+                    }
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              }
+            },
+            "required": [
+              "id"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "guidance": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "modelAnswer": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "templateId": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  },
+  "additionalProperties": false
+}