@kensai/quiz-core 0.1.0

package/dist/schema.generated.d.ts

@@ -0,0 +1,503 @@
+export declare const quizSchema: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://github.com/kensai/quiz-core/spec/quiz.schema.json";
+    readonly title: "Kensai Quiz";
+    readonly description: "Specification for a single, portable, AI-authorable quiz (schema version 0.1).";
+    readonly type: "object";
+    readonly required: readonly ["schema_version", "metadata", "questions"];
+    readonly additionalProperties: false;
+    readonly properties: {
+        readonly schema_version: {
+            readonly type: "string";
+            readonly const: "0.1";
+            readonly description: "Spec version this file targets. Enables backward compatibility.";
+        };
+        readonly metadata: {
+            readonly $ref: "#/$defs/metadata";
+        };
+        readonly settings: {
+            readonly $ref: "#/$defs/settings";
+        };
+        readonly categories: {
+            readonly type: "array";
+            readonly description: "Optional registry of categories used for end-of-quiz statistics.";
+            readonly items: {
+                readonly $ref: "#/$defs/category";
+            };
+        };
+        readonly option_groups: {
+            readonly type: "object";
+            readonly description: "Reusable named option sets. Reference them from questions via `options_from` / `groups_from`.";
+            readonly additionalProperties: {
+                readonly type: "array";
+                readonly minItems: 1;
+                readonly items: {
+                    readonly $ref: "#/$defs/option";
+                };
+            };
+        };
+        readonly questions: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly items: {
+                readonly $ref: "#/$defs/question";
+            };
+        };
+    };
+    readonly $defs: {
+        readonly metadata: {
+            readonly type: "object";
+            readonly required: readonly ["title"];
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                    readonly description: "Optional stable slug.";
+                };
+                readonly title: {
+                    readonly type: "string";
+                    readonly description: "Human title (Markdown).";
+                };
+                readonly path: {
+                    readonly type: "string";
+                    readonly description: "Study-path breadcrumb, e.g. 'English / Verb system / Present tenses'.";
+                };
+                readonly description: {
+                    readonly type: "string";
+                    readonly description: "Optional overview (Markdown).";
+                };
+                readonly language: {
+                    readonly type: "string";
+                    readonly description: "BCP-47 content language tag, e.g. 'en', 'es'. Default: 'und'.";
+                };
+                readonly author: {
+                    readonly type: "string";
+                };
+                readonly tags: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+            };
+        };
+        readonly settings: {
+            readonly type: "object";
+            readonly description: "All fields optional. Author defaults; a player may override per attempt.";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly navigation: {
+                    readonly enum: readonly ["all", "sequential"];
+                    readonly default: "all";
+                    readonly description: "'all' shows every question at once; 'sequential' advances one by one.";
+                };
+                readonly order: {
+                    readonly enum: readonly ["fixed", "random"];
+                    readonly default: "fixed";
+                    readonly description: "Order in which questions are presented ('random' shuffles them).";
+                };
+                readonly feedback: {
+                    readonly enum: readonly ["immediate", "on_finish"];
+                    readonly default: "on_finish";
+                    readonly description: "Reveal correctness/explanation per question or only at the end.";
+                };
+                readonly time_limit: {
+                    readonly type: readonly ["number", "null"];
+                    readonly minimum: 1;
+                    readonly default: null;
+                    readonly description: "Seconds allowed. null or omitted = unlimited.";
+                };
+                readonly shuffle_options: {
+                    readonly type: "boolean";
+                    readonly default: false;
+                    readonly description: "Shuffle the answer-option order of choice questions, except those that set `shuffle_options: false`.";
+                };
+                readonly passing_score: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                    readonly description: "Pass threshold as a fraction 0..1.";
+                };
+            };
+        };
+        readonly category: {
+            readonly type: "object";
+            readonly required: readonly ["id", "label"];
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                };
+                readonly label: {
+                    readonly type: "string";
+                    readonly description: "Display label (Markdown).";
+                };
+            };
+        };
+        readonly option: {
+            readonly type: "object";
+            readonly required: readonly ["id", "text"];
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                    readonly description: "Unique within its option list.";
+                };
+                readonly text: {
+                    readonly type: "string";
+                    readonly description: "Option text (Markdown).";
+                };
+            };
+        };
+        readonly group: {
+            readonly type: "object";
+            readonly required: readonly ["id", "label"];
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                };
+                readonly label: {
+                    readonly type: "string";
+                    readonly description: "Bucket label (Markdown).";
+                };
+            };
+        };
+        readonly id_or_id_list: {
+            readonly description: "A single id or a list of ids.";
+            readonly oneOf: readonly [{
+                readonly type: "string";
+            }, {
+                readonly type: "array";
+                readonly minItems: 1;
+                readonly items: {
+                    readonly type: "string";
+                };
+            }];
+        };
+        readonly question: {
+            readonly type: "object";
+            readonly required: readonly ["type", "prompt"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                    readonly description: "Recommended: stable id for stats/resume.";
+                };
+                readonly type: {
+                    readonly enum: readonly ["choice", "true_false", "fill_blank", "classify", "matching", "ordering", "short_answer"];
+                };
+                readonly category: {
+                    readonly type: "string";
+                    readonly description: "References a categories[].id, or a free-form string.";
+                };
+                readonly points: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly default: 1;
+                };
+                readonly prompt: {
+                    readonly type: "string";
+                    readonly description: "Question text (Markdown).";
+                };
+                readonly explanation: {
+                    readonly type: "string";
+                    readonly description: "Optional rationale (Markdown).";
+                };
+            };
+            readonly oneOf: readonly [{
+                readonly $ref: "#/$defs/q_choice";
+            }, {
+                readonly $ref: "#/$defs/q_true_false";
+            }, {
+                readonly $ref: "#/$defs/q_fill_blank";
+            }, {
+                readonly $ref: "#/$defs/q_classify";
+            }, {
+                readonly $ref: "#/$defs/q_matching";
+            }, {
+                readonly $ref: "#/$defs/q_ordering";
+            }, {
+                readonly $ref: "#/$defs/q_short_answer";
+            }];
+        };
+        readonly q_choice: {
+            readonly properties: {
+                readonly type: {
+                    readonly const: "choice";
+                };
+                readonly id: true;
+                readonly category: true;
+                readonly points: true;
+                readonly prompt: true;
+                readonly explanation: true;
+                readonly select: {
+                    readonly enum: readonly ["single", "multiple"];
+                    readonly default: "single";
+                };
+                readonly options: {
+                    readonly type: "array";
+                    readonly minItems: 2;
+                    readonly items: {
+                        readonly $ref: "#/$defs/option";
+                    };
+                };
+                readonly options_from: {
+                    readonly type: "string";
+                    readonly description: "Name of an entry in option_groups.";
+                };
+                readonly answer: {
+                    readonly $ref: "#/$defs/id_or_id_list";
+                };
+                readonly shuffle_options: {
+                    readonly type: "boolean";
+                    readonly default: true;
+                    readonly description: "Whether these options may be reordered when the quiz enables option shuffling. Default true; set false to lock the order (e.g. an 'All of the above' option, or options like 'Both A and B').";
+                };
+            };
+            readonly required: readonly ["type", "prompt", "answer"];
+            readonly oneOf: readonly [{
+                readonly required: readonly ["options"];
+                readonly not: {
+                    readonly required: readonly ["options_from"];
+                };
+            }, {
+                readonly required: readonly ["options_from"];
+                readonly not: {
+                    readonly required: readonly ["options"];
+                };
+            }];
+            readonly additionalProperties: false;
+        };
+        readonly q_true_false: {
+            readonly properties: {
+                readonly type: {
+                    readonly const: "true_false";
+                };
+                readonly id: true;
+                readonly category: true;
+                readonly points: true;
+                readonly prompt: true;
+                readonly explanation: true;
+                readonly answer: {
+                    readonly type: "boolean";
+                };
+            };
+            readonly required: readonly ["type", "prompt", "answer"];
+            readonly additionalProperties: false;
+        };
+        readonly q_fill_blank: {
+            readonly properties: {
+                readonly type: {
+                    readonly const: "fill_blank";
+                };
+                readonly id: true;
+                readonly category: true;
+                readonly points: true;
+                readonly prompt: true;
+                readonly explanation: true;
+                readonly blanks: {
+                    readonly type: "object";
+                    readonly minProperties: 1;
+                    readonly description: "Map of placeholder id ({{id}} in prompt) to a blank definition.";
+                    readonly additionalProperties: {
+                        readonly $ref: "#/$defs/blank";
+                    };
+                };
+            };
+            readonly required: readonly ["type", "prompt", "blanks"];
+            readonly additionalProperties: false;
+        };
+        readonly blank: {
+            readonly type: "object";
+            readonly description: "A blank is either free-text (accept) or a per-blank choice (options + answer).";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly accept: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly description: "Accepted free-text answers (synonyms).";
+                };
+                readonly case_sensitive: {
+                    readonly type: "boolean";
+                    readonly default: false;
+                };
+                readonly options: {
+                    readonly type: "array";
+                    readonly minItems: 2;
+                    readonly items: {
+                        readonly $ref: "#/$defs/option";
+                    };
+                };
+                readonly answer: {
+                    readonly type: "string";
+                    readonly description: "Correct option id (choice-per-blank variant).";
+                };
+            };
+            readonly oneOf: readonly [{
+                readonly required: readonly ["accept"];
+                readonly not: {
+                    readonly required: readonly ["options"];
+                };
+            }, {
+                readonly required: readonly ["options", "answer"];
+                readonly not: {
+                    readonly required: readonly ["accept"];
+                };
+            }];
+        };
+        readonly q_classify: {
+            readonly properties: {
+                readonly type: {
+                    readonly const: "classify";
+                };
+                readonly id: true;
+                readonly category: true;
+                readonly points: true;
+                readonly prompt: true;
+                readonly explanation: true;
+                readonly groups: {
+                    readonly type: "array";
+                    readonly minItems: 2;
+                    readonly items: {
+                        readonly $ref: "#/$defs/group";
+                    };
+                };
+                readonly groups_from: {
+                    readonly type: "string";
+                    readonly description: "Name of an entry in option_groups (its options act as buckets: id + text).";
+                };
+                readonly items: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["id", "text", "answer"];
+                        readonly additionalProperties: false;
+                        readonly properties: {
+                            readonly id: {
+                                readonly type: "string";
+                            };
+                            readonly text: {
+                                readonly type: "string";
+                                readonly description: "Item text (Markdown).";
+                            };
+                            readonly answer: {
+                                readonly type: "string";
+                                readonly description: "Target group id.";
+                            };
+                        };
+                    };
+                };
+            };
+            readonly required: readonly ["type", "prompt", "items"];
+            readonly oneOf: readonly [{
+                readonly required: readonly ["groups"];
+                readonly not: {
+                    readonly required: readonly ["groups_from"];
+                };
+            }, {
+                readonly required: readonly ["groups_from"];
+                readonly not: {
+                    readonly required: readonly ["groups"];
+                };
+            }];
+            readonly additionalProperties: false;
+        };
+        readonly q_matching: {
+            readonly properties: {
+                readonly type: {
+                    readonly const: "matching";
+                };
+                readonly id: true;
+                readonly category: true;
+                readonly points: true;
+                readonly prompt: true;
+                readonly explanation: true;
+                readonly left: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly items: {
+                        readonly $ref: "#/$defs/option";
+                    };
+                };
+                readonly right: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly items: {
+                        readonly $ref: "#/$defs/option";
+                    };
+                };
+                readonly answer: {
+                    readonly type: "object";
+                    readonly minProperties: 1;
+                    readonly description: "Map of left id -> right id.";
+                    readonly additionalProperties: {
+                        readonly type: "string";
+                    };
+                };
+            };
+            readonly required: readonly ["type", "prompt", "left", "right", "answer"];
+            readonly additionalProperties: false;
+        };
+        readonly q_ordering: {
+            readonly properties: {
+                readonly type: {
+                    readonly const: "ordering";
+                };
+                readonly id: true;
+                readonly category: true;
+                readonly points: true;
+                readonly prompt: true;
+                readonly explanation: true;
+                readonly items: {
+                    readonly type: "array";
+                    readonly minItems: 2;
+                    readonly items: {
+                        readonly $ref: "#/$defs/option";
+                    };
+                };
+                readonly answer: {
+                    readonly type: "array";
+                    readonly minItems: 2;
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly description: "Item ids in the correct order.";
+                };
+            };
+            readonly required: readonly ["type", "prompt", "items", "answer"];
+            readonly additionalProperties: false;
+        };
+        readonly q_short_answer: {
+            readonly properties: {
+                readonly type: {
+                    readonly const: "short_answer";
+                };
+                readonly id: true;
+                readonly category: true;
+                readonly points: true;
+                readonly prompt: true;
+                readonly explanation: true;
+                readonly accept: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly description: "Accepted answers (synonyms).";
+                };
+                readonly case_sensitive: {
+                    readonly type: "boolean";
+                    readonly default: false;
+                };
+            };
+            readonly required: readonly ["type", "prompt", "accept"];
+            readonly additionalProperties: false;
+        };
+    };
+};
+export default quizSchema;
+//# sourceMappingURL=schema.generated.d.ts.map

package/dist/schema.generated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.generated.d.ts","sourceRoot":"","sources":["../src/schema.generated.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6mBb,CAAC;AAEX,eAAe,UAAU,CAAC"}