@happyvertical/smrt-education 0.57.46 → 0.57.48

package/dist/question-extraction.d.ts

@@ -0,0 +1,317 @@
+import { type QuestionContentInput, type WorksheetBundle } from './question-contracts.js';
+import { type ExtractedAnchor, type ExtractedAnchorInput, type ExtractedOrigin, type ExtractedQuestion, type QuestionExtraction, type QuestionExtractionGrounding, type QuestionExtractionMatch, type QuestionExtractionSourceKind } from './question-extraction-contracts.js';
+/**
+ * Closed argument schema of the `extract-questions` handler: what a proposal
+ * generator may fill. Every object is closed; every optional fact is explicit null.
+ */
+export declare const QUESTION_EXTRACTION_ARGS_SCHEMA: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["version", "sourceKind", "worksheetVersionId", "pages", "sections", "questions", "studentWork", "omissions"];
+    readonly properties: {
+        readonly version: {
+            readonly type: "integer";
+            readonly enum: readonly [1];
+        };
+        readonly sourceKind: {
+            readonly type: "string";
+            readonly enum: readonly QuestionExtractionSourceKind[];
+        };
+        readonly worksheetVersionId: {
+            anyOf: Record<string, unknown>[];
+        };
+        readonly pages: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly maxItems: 1000;
+            readonly items: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["evidenceId", "page", "role", "readability"];
+                readonly properties: {
+                    readonly evidenceId: {
+                        type: string;
+                        minLength: number;
+                        maxLength: number;
+                    };
+                    readonly page: {
+                        anyOf: Record<string, unknown>[];
+                    };
+                    readonly role: {
+                        readonly type: "string";
+                        readonly enum: readonly import("./question-extraction-contracts.js").ExtractedPageRole[];
+                    };
+                    readonly readability: {
+                        readonly type: "string";
+                        readonly enum: readonly import("./question-extraction-contracts.js").ExtractedReadability[];
+                    };
+                };
+            };
+        };
+        readonly sections: {
+            readonly type: "array";
+            readonly maxItems: 64;
+            readonly items: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["id", "label", "evidenceId", "page"];
+                readonly properties: {
+                    readonly id: {
+                        type: string;
+                        pattern: string;
+                    };
+                    readonly label: {
+                        anyOf: Record<string, unknown>[];
+                    };
+                    readonly evidenceId: {
+                        type: string;
+                        minLength: number;
+                        maxLength: number;
+                    };
+                    readonly page: {
+                        anyOf: Record<string, unknown>[];
+                    };
+                };
+            };
+        };
+        readonly questions: {
+            readonly type: "array";
+            readonly maxItems: 200;
+            readonly items: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["key", "numbering", "role", "sectionId", "status", "prompt", "responseType", "responseTypeOrigin", "choices", "subparts", "media", "answerKey", "rubric", "pointsPossible", "pointsOrigin", "anchors"];
+                readonly properties: {
+                    readonly key: {
+                        type: string;
+                        pattern: string;
+                    };
+                    readonly numbering: {
+                        anyOf: Record<string, unknown>[];
+                    };
+                    readonly role: {
+                        readonly type: "string";
+                        readonly enum: readonly ["exercise", "example"];
+                    };
+                    readonly sectionId: {
+                        anyOf: Record<string, unknown>[];
+                    };
+                    readonly status: {
+                        readonly type: "string";
+                        readonly enum: readonly import("./question-extraction-contracts.js").ExtractedQuestionStatus[];
+                    };
+                    readonly prompt: {
+                        anyOf: Record<string, unknown>[];
+                    };
+                    readonly responseType: {
+                        anyOf: Record<string, unknown>[];
+                    };
+                    readonly responseTypeOrigin: {
+                        type: string;
+                        enum: ExtractedOrigin[];
+                    };
+                    readonly choices: {
+                        readonly type: "array";
+                        readonly maxItems: 50;
+                        readonly items: {
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly required: readonly ["id", "label"];
+                            readonly properties: {
+                                readonly id: {
+                                    type: string;
+                                    pattern: string;
+                                };
+                                readonly label: {
+                                    type: string;
+                                    minLength: number;
+                                    maxLength: number;
+                                };
+                            };
+                        };
+                    };
+                    readonly subparts: {
+                        readonly type: "array";
+                        readonly maxItems: 50;
+                        readonly items: {
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly required: readonly ["partKey", "prompt"];
+                            readonly properties: {
+                                readonly partKey: {
+                                    type: string;
+                                    pattern: string;
+                                };
+                                readonly prompt: {
+                                    type: string;
+                                    minLength: number;
+                                    maxLength: number;
+                                };
+                            };
+                        };
+                    };
+                    readonly media: {
+                        readonly type: "array";
+                        readonly maxItems: 20;
+                        readonly items: {
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly required: readonly ["kind", "description", "anchor"];
+                            readonly properties: {
+                                readonly kind: {
+                                    readonly type: "string";
+                                    readonly enum: readonly import("./question-extraction-contracts.js").ExtractedMediaKind[];
+                                };
+                                readonly description: {
+                                    type: string;
+                                    minLength: number;
+                                    maxLength: number;
+                                };
+                                readonly anchor: {
+                                    anyOf: Record<string, unknown>[];
+                                };
+                            };
+                        };
+                    };
+                    readonly answerKey: {
+                        anyOf: Record<string, unknown>[];
+                    };
+                    readonly rubric: {
+                        anyOf: Record<string, unknown>[];
+                    };
+                    readonly pointsPossible: {
+                        anyOf: Record<string, unknown>[];
+                    };
+                    readonly pointsOrigin: {
+                        anyOf: Record<string, unknown>[];
+                    };
+                    readonly anchors: {
+                        type: string;
+                        maxItems: number;
+                        items: {
+                            type: string;
+                            additionalProperties: boolean;
+                            required: string[];
+                            properties: {
+                                evidenceId: {
+                                    type: string;
+                                    minLength: number;
+                                    maxLength: number;
+                                };
+                                page: {
+                                    anyOf: Record<string, unknown>[];
+                                };
+                                regionId: {
+                                    anyOf: Record<string, unknown>[];
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        readonly studentWork: {
+            readonly type: "array";
+            readonly maxItems: 400;
+            readonly items: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["questionKey", "observed", "legibility", "anchors"];
+                readonly properties: {
+                    readonly questionKey: {
+                        anyOf: Record<string, unknown>[];
+                    };
+                    readonly observed: {
+                        anyOf: Record<string, unknown>[];
+                    };
+                    readonly legibility: {
+                        readonly type: "string";
+                        readonly enum: readonly import("./question-extraction-contracts.js").ExtractedLegibility[];
+                    };
+                    readonly anchors: {
+                        type: string;
+                        maxItems: number;
+                        items: {
+                            type: string;
+                            additionalProperties: boolean;
+                            required: string[];
+                            properties: {
+                                evidenceId: {
+                                    type: string;
+                                    minLength: number;
+                                    maxLength: number;
+                                };
+                                page: {
+                                    anyOf: Record<string, unknown>[];
+                                };
+                                regionId: {
+                                    anyOf: Record<string, unknown>[];
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        readonly omissions: {
+            readonly type: "array";
+            readonly maxItems: 200;
+            readonly items: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["evidenceId", "page", "reason", "description"];
+                readonly properties: {
+                    readonly evidenceId: {
+                        type: string;
+                        minLength: number;
+                        maxLength: number;
+                    };
+                    readonly page: {
+                        anyOf: Record<string, unknown>[];
+                    };
+                    readonly reason: {
+                        readonly type: "string";
+                        readonly enum: readonly import("./question-extraction-contracts.js").ExtractedOmissionReason[];
+                    };
+                    readonly description: {
+                        type: string;
+                        minLength: number;
+                        maxLength: number;
+                    };
+                };
+            };
+        };
+    };
+};
+/**
+ * Validate extractor output against the closed contract and the intake's
+ * retained evidence. Every source page must be accounted for (an entry in
+ * `pages`), so unreadable or unsupported content is marked, never dropped.
+ * Throws `QuestionExtractionValidationError`; never repairs or guesses.
+ */
+export declare function normalizeQuestionExtraction(value: unknown, grounding: QuestionExtractionGrounding): QuestionExtraction;
+/**
+ * Idempotency identity of an extraction source: the source kind plus the
+ * sorted retained evidence hashes. Re-ingesting the same bytes yields the same
+ * identity; a fresh scan (new bytes) is a new source. Never derived from text.
+ */
+export declare function questionExtractionSourceIdentity(sourceKind: QuestionExtractionSourceKind, grounding: QuestionExtractionGrounding): string;
+/**
+ * Link extracted questions to known worksheet revisions on evidence only: a
+ * worksheet identity (printed on the page, or supplied by the host) plus the
+ * printed position, checked against section, response type, choice and part
+ * counts. Prompt text is never used. Conflicts and duplicate claims are
+ * `ambiguous` and stay unattached.
+ */
+export declare function matchExtractedQuestions(extraction: QuestionExtraction, worksheets: readonly WorksheetBundle[], options?: {
+    expectedWorksheetVersionId?: string;
+}): QuestionExtractionMatch;
+/**
+ * Question content for a readable printed exercise, or null when the item must
+ * not become a record (an example, or unreadable/unsupported). Printed facts are
+ * `extracted`; extractor guesses are `inferred`. Student work never enters here.
+ */
+export declare function extractedQuestionContent(question: ExtractedQuestion): QuestionContentInput | null;
+/** Re-exported for hosts building their own anchor display. */
+export type { ExtractedAnchor, ExtractedAnchorInput };
+//# sourceMappingURL=question-extraction.d.ts.map

package/dist/question-extraction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question-extraction.d.ts","sourceRoot":"","sources":["../src/question-extraction.ts"],"names":[],"mappings":"AAMA,OAAO,EAGL,KAAK,oBAAoB,EAIzB,KAAK,eAAe,EACrB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAQL,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EAUtB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,uBAAuB,EAC5B,KAAK,4BAA4B,EAGlC,MAAM,oCAAoC,CAAC;AAmC5C;;;GAGG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0MlC,CAAC;AAkHX;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACzC,KAAK,EAAE,OAAO,EACd,SAAS,EAAE,2BAA2B,GACrC,kBAAkB,CAkKpB;AAsJD;;;;GAIG;AACH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,4BAA4B,EACxC,SAAS,EAAE,2BAA2B,GACrC,MAAM,CAGR;AAQD;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,kBAAkB,EAC9B,UAAU,EAAE,SAAS,eAAe,EAAE,EACtC,OAAO,GAAE;IAAE,0BAA0B,CAAC,EAAE,MAAM,CAAA;CAAO,GACpD,uBAAuB,CAgHzB;AAOD;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,iBAAiB,GAC1B,oBAAoB,GAAG,IAAI,CA4C7B;AAED,+DAA+D;AAC/D,YAAY,EAAE,eAAe,EAAE,oBAAoB,EAAE,CAAC"}