@examplary/schemas 1.11.0 → 1.12.0

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

@@ -10,5 +10,7 @@ export * from "./question-type-grading-options";
 export type * from "./question-type-grading-options";
 export * from "./question-type-scanning-options";
 export type * from "./question-type-scanning-options";
+export * from "./question-type-capabilities";
+export type * from "./question-type-capabilities";
 export * from "./question-type-qti3";
 export type * from "./question-type-qti3";

package/dist/question-type/index.js

@@ -20,4 +20,5 @@ __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);

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

@@ -0,0 +1,5 @@
+import { z } from "zod";
+export declare const QuestionTypeCapabilitiesSchema: z.ZodObject<{
+    "answer-scanning": z.ZodOptional<z.ZodBoolean>;
+}, z.core.$loose>;
+export type QuestionTypeCapabilities = z.infer<typeof QuestionTypeCapabilitiesSchema>;

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

@@ -0,0 +1,10 @@
+"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
+        .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-setting.d.ts

@@ -21,13 +21,13 @@ export declare const QuestionTypeSetting: z.ZodObject<{
     }>;
     index: z.ZodOptional<z.ZodNumber>;
     hidden: z.ZodOptional<z.ZodBoolean>;
-    default: z.ZodOptional<z.ZodAny>;
+    default: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
     required: z.ZodOptional<z.ZodBoolean>;
     options: z.ZodOptional<z.ZodArray<z.ZodObject<{
         value: z.ZodString;
         label: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
     }, z.core.$strict>>>;
-    placeholder: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>;
+    placeholder: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>>;
     step: z.ZodOptional<z.ZodNumber>;
     min: z.ZodOptional<z.ZodNumber>;
     max: z.ZodOptional<z.ZodNumber>;

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

@@ -39,7 +39,7 @@ exports.QuestionTypeSetting = zod_1.z
         .boolean()
         .optional()
         .describe("Whether the setting is hidden from the user"),
-    default: zod_1.z.any().optional().describe("Default value for the setting"),
+    default: zod_1.z.any().nullish().describe("Default value for the setting"),
     required: zod_1.z
         .boolean()
         .optional()
@@ -48,7 +48,7 @@ exports.QuestionTypeSetting = zod_1.z
         .array(exports.QuestionTypeSettingOption)
         .optional()
         .describe("Available options for enum type settings"),
-    placeholder: translatable_1.Translatable.optional().describe("Placeholder text for the setting"),
+    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
         .number()

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

@@ -55,19 +55,22 @@ export declare const QuestionTypeSchema: z.ZodObject<{
         }>;
         index: z.ZodOptional<z.ZodNumber>;
         hidden: z.ZodOptional<z.ZodBoolean>;
-        default: z.ZodOptional<z.ZodAny>;
+        default: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
         required: z.ZodOptional<z.ZodBoolean>;
         options: z.ZodOptional<z.ZodArray<z.ZodObject<{
             value: z.ZodString;
             label: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
         }, z.core.$strict>>>;
-        placeholder: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>;
+        placeholder: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>>;
         step: z.ZodOptional<z.ZodNumber>;
         min: z.ZodOptional<z.ZodNumber>;
         max: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strict>>>;
     public: z.ZodOptional<z.ZodBoolean>;
     translations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>>;
+    capabilities: z.ZodOptional<z.ZodObject<{
+        "answer-scanning": z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$loose>>;
     export: z.ZodOptional<z.ZodObject<{
         qti3: z.ZodOptional<z.ZodObject<{
             interaction: z.ZodObject<{

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

@@ -2,6 +2,7 @@
 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");
@@ -74,6 +75,7 @@ exports.QuestionTypeSchema = zod_1.z
         .record(zod_1.z.string(), translatable_1.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
         .object({
         qti3: question_type_qti3_1.Qti3Mapping.optional().describe("QTI 3.0 mapping configuration for transforming questions to QTI format"),

package/dist/schemas/question-type.json

@@ -354,7 +354,13 @@
             "type": "boolean"
           },
           "default": {
-            "description": "Default value for the setting"
+            "description": "Default value for the setting",
+            "anyOf": [
+              {},
+              {
+                "type": "null"
+              }
+            ]
           },
           "required": {
             "description": "Whether this setting is required",
@@ -403,19 +409,26 @@
             "description": "Placeholder text for the setting",
             "anyOf": [
               {
-                "type": "string",
-                "description": "Simple string value"
+                "anyOf": [
+                  {
+                    "type": "string",
+                    "description": "Simple string value"
+                  },
+                  {
+                    "type": "object",
+                    "propertyNames": {
+                      "type": "string",
+                      "pattern": "^[a-z]{2}(-[A-Z]{2})?$"
+                    },
+                    "additionalProperties": {
+                      "type": "string"
+                    },
+                    "description": "Translation object with language codes as keys"
+                  }
+                ]
               },
               {
-                "type": "object",
-                "propertyNames": {
-                  "type": "string",
-                  "pattern": "^[a-z]{2}(-[A-Z]{2})?$"
-                },
-                "additionalProperties": {
-                  "type": "string"
-                },
-                "description": "Translation object with language codes as keys"
+                "type": "null"
               }
             ]
           },
@@ -471,6 +484,17 @@
         ]
       }
     },
+    "capabilities": {
+      "description": "Capabilities of the question type for various operations",
+      "type": "object",
+      "properties": {
+        "answer-scanning": {
+          "description": "Whether this question type allows the student to scan an answer using their phone. Only supported for practice spaces.",
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": {}
+    },
     "export": {
       "description": "Export configuration for various formats",
       "type": "object",

package/package.json

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