@examplary/schemas 1.14.0 → 1.15.0

package/dist/question-type/question-type-qti3.d.ts

@@ -54,7 +54,47 @@ export declare const Qti3Mapping: z.ZodObject<{
             TextEntryInteraction: "TextEntryInteraction";
             UploadInteraction: "UploadInteraction";
         }>;
-        options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodAny>, z.ZodObject<{}, z.core.$strip>]>>>;
+        options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 export type Qti3Mapping = z.infer<typeof Qti3Mapping>;
+/**
+ * QTI 3.0 import mapping for a custom question type.
+ * When an incoming QTI item's interaction type matches, the question is imported
+ * as this question type with settings derived from the JSONata expressions.
+ *
+ * JSONata context: { interaction, correctResponse, points }
+ *   - interaction: plain-object representation of the QTI interaction element
+ *   - correctResponse: string[] of correct response identifiers/values
+ *   - points: number of points from the QTI score outcome
+ */
+export declare const Qti3ImportMapping: z.ZodObject<{
+    interaction: z.ZodObject<{
+        type: z.ZodEnum<{
+            AssociateInteraction: "AssociateInteraction";
+            ChoiceInteraction: "ChoiceInteraction";
+            DrawingInteraction: "DrawingInteraction";
+            EndAttemptInteraction: "EndAttemptInteraction";
+            ExtendedTextInteraction: "ExtendedTextInteraction";
+            GapMatchInteraction: "GapMatchInteraction";
+            GraphicAssociateInteraction: "GraphicAssociateInteraction";
+            GraphicGapMatchInteraction: "GraphicGapMatchInteraction";
+            GraphicOrderInteraction: "GraphicOrderInteraction";
+            HotspotInteraction: "HotspotInteraction";
+            HottextInteraction: "HottextInteraction";
+            InlineChoiceInteraction: "InlineChoiceInteraction";
+            MatchInteraction: "MatchInteraction";
+            MediaInteraction: "MediaInteraction";
+            OrderInteraction: "OrderInteraction";
+            PortableCustomInteraction: "PortableCustomInteraction";
+            PositionObjectInteraction: "PositionObjectInteraction";
+            SelectPointInteraction: "SelectPointInteraction";
+            SliderInteraction: "SliderInteraction";
+            TextEntryInteraction: "TextEntryInteraction";
+            UploadInteraction: "UploadInteraction";
+        }>;
+    }, z.core.$strip>;
+    condition: z.ZodOptional<z.ZodString>;
+    settings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>>;
+}, z.core.$strip>;
+export type Qti3ImportMapping = z.infer<typeof Qti3ImportMapping>;

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

@@ -4,7 +4,13 @@ import { z } from "zod";
  * JSONata expressions are evaluated at transform time against the question context.
  */
 const JsonataExpr = z
-    .union([z.string(), z.number(), z.boolean(), z.array(z.any()), z.object({})])
+    .union([
+    z.string(),
+    z.number(),
+    z.boolean(),
+    z.array(z.any()),
+    z.record(z.string(), z.any()),
+])
     .describe("Literal or JSONata expression string starting with '='");
 /**
  * Supported QTI 3.0 interaction types
@@ -43,3 +49,28 @@ export const Qti3Mapping = z
     }),
 })
     .describe("QTI 3.0 mapping configuration for transforming questions to QTI format");
+/**
+ * QTI 3.0 import mapping for a custom question type.
+ * When an incoming QTI item's interaction type matches, the question is imported
+ * as this question type with settings derived from the JSONata expressions.
+ *
+ * JSONata context: { interaction, correctResponse, points }
+ *   - interaction: plain-object representation of the QTI interaction element
+ *   - correctResponse: string[] of correct response identifiers/values
+ *   - points: number of points from the QTI score outcome
+ */
+export const Qti3ImportMapping = z
+    .object({
+    interaction: z.object({
+        type: QtiInteractionType.describe("The QTI interaction type this question type handles on import"),
+    }),
+    condition: z
+        .string()
+        .optional()
+        .describe("Optional JSONata expression (starting with =) that must evaluate to true for this mapping to be used. Evaluated against the same context as settings: { interaction, correctResponse, points }. Useful when multiple question types handle the same interaction type (e.g. single vs multiple choice)."),
+    settings: z
+        .record(z.string(), JsonataExpr)
+        .optional()
+        .describe("JSONata expressions mapping QTI interaction properties to question settings"),
+})
+    .describe("QTI 3.0 import mapping configuration for a custom question type");

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

@@ -97,10 +97,41 @@ export declare const QuestionTypeSchema: z.ZodObject<{
                     TextEntryInteraction: "TextEntryInteraction";
                     UploadInteraction: "UploadInteraction";
                 }>;
-                options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodAny>, z.ZodObject<{}, z.core.$strip>]>>>;
+                options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>>;
             }, z.core.$strip>;
         }, z.core.$strip>>;
     }, z.core.$strip>>;
+    import: z.ZodOptional<z.ZodObject<{
+        qti3: z.ZodOptional<z.ZodObject<{
+            interaction: z.ZodObject<{
+                type: z.ZodEnum<{
+                    AssociateInteraction: "AssociateInteraction";
+                    ChoiceInteraction: "ChoiceInteraction";
+                    DrawingInteraction: "DrawingInteraction";
+                    EndAttemptInteraction: "EndAttemptInteraction";
+                    ExtendedTextInteraction: "ExtendedTextInteraction";
+                    GapMatchInteraction: "GapMatchInteraction";
+                    GraphicAssociateInteraction: "GraphicAssociateInteraction";
+                    GraphicGapMatchInteraction: "GraphicGapMatchInteraction";
+                    GraphicOrderInteraction: "GraphicOrderInteraction";
+                    HotspotInteraction: "HotspotInteraction";
+                    HottextInteraction: "HottextInteraction";
+                    InlineChoiceInteraction: "InlineChoiceInteraction";
+                    MatchInteraction: "MatchInteraction";
+                    MediaInteraction: "MediaInteraction";
+                    OrderInteraction: "OrderInteraction";
+                    PortableCustomInteraction: "PortableCustomInteraction";
+                    PositionObjectInteraction: "PositionObjectInteraction";
+                    SelectPointInteraction: "SelectPointInteraction";
+                    SliderInteraction: "SliderInteraction";
+                    TextEntryInteraction: "TextEntryInteraction";
+                    UploadInteraction: "UploadInteraction";
+                }>;
+            }, z.core.$strip>;
+            condition: z.ZodOptional<z.ZodString>;
+            settings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
     stylesheet: z.ZodOptional<z.ZodURL>;
     index: z.ZodOptional<z.ZodNumber>;

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

@@ -3,7 +3,7 @@ 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 { Qti3ImportMapping, Qti3Mapping } from "./question-type-qti3";
 import { QuestionTypeScanningOptions } from "./question-type-scanning-options";
 import { QuestionTypeSetting } from "./question-type-setting";
 import { ScalarSchema } from "../common/scalar";
@@ -79,6 +79,12 @@ export const QuestionTypeSchema = z
     })
         .optional()
         .describe("Export configuration for various formats"),
+    import: z
+        .object({
+        qti3: Qti3ImportMapping.optional().describe("QTI 3.0 import configuration for mapping incoming QTI items to this question type"),
+    })
+        .optional()
+        .describe("Import configuration for various formats"),
     metadata: z
         .record(z.string(), ScalarSchema)
         .optional()

package/dist/schemas/question-type.json

@@ -555,8 +555,10 @@
                       },
                       {
                         "type": "object",
-                        "properties": {},
-                        "additionalProperties": false
+                        "propertyNames": {
+                          "type": "string"
+                        },
+                        "additionalProperties": {}
                       }
                     ],
                     "description": "Literal or JSONata expression string starting with '='"
@@ -577,6 +579,95 @@
       },
       "additionalProperties": false
     },
+    "import": {
+      "description": "Import configuration for various formats",
+      "type": "object",
+      "properties": {
+        "qti3": {
+          "description": "QTI 3.0 import configuration for mapping incoming QTI items to this question type",
+          "type": "object",
+          "properties": {
+            "interaction": {
+              "type": "object",
+              "properties": {
+                "type": {
+                  "type": "string",
+                  "enum": [
+                    "AssociateInteraction",
+                    "ChoiceInteraction",
+                    "DrawingInteraction",
+                    "EndAttemptInteraction",
+                    "ExtendedTextInteraction",
+                    "GapMatchInteraction",
+                    "GraphicAssociateInteraction",
+                    "GraphicGapMatchInteraction",
+                    "GraphicOrderInteraction",
+                    "HotspotInteraction",
+                    "HottextInteraction",
+                    "InlineChoiceInteraction",
+                    "MatchInteraction",
+                    "MediaInteraction",
+                    "OrderInteraction",
+                    "PortableCustomInteraction",
+                    "PositionObjectInteraction",
+                    "SelectPointInteraction",
+                    "SliderInteraction",
+                    "TextEntryInteraction",
+                    "UploadInteraction"
+                  ],
+                  "description": "The QTI interaction type this question type handles on import"
+                }
+              },
+              "required": [
+                "type"
+              ],
+              "additionalProperties": false
+            },
+            "condition": {
+              "description": "Optional JSONata expression (starting with =) that must evaluate to true for this mapping to be used. Evaluated against the same context as settings: { interaction, correctResponse, points }. Useful when multiple question types handle the same interaction type (e.g. single vs multiple choice).",
+              "type": "string"
+            },
+            "settings": {
+              "description": "JSONata expressions mapping QTI interaction properties to question settings",
+              "type": "object",
+              "propertyNames": {
+                "type": "string"
+              },
+              "additionalProperties": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "number"
+                  },
+                  {
+                    "type": "boolean"
+                  },
+                  {
+                    "type": "array",
+                    "items": {}
+                  },
+                  {
+                    "type": "object",
+                    "propertyNames": {
+                      "type": "string"
+                    },
+                    "additionalProperties": {}
+                  }
+                ],
+                "description": "Literal or JSONata expression string starting with '='"
+              }
+            }
+          },
+          "required": [
+            "interaction"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
     "metadata": {
       "description": "Optional metadata for the question type, only used by external applications",
       "type": "object",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@examplary/schemas",
   "packageManager": "yarn@4.8.1",
-  "version": "1.14.0",
+  "version": "1.15.0",
   "description": "Schemas for the Examplary platform.",
   "scripts": {
     "build:schema": "tsx ./scripts/build.ts",