@conform-ed/qti-react 0.0.13 → 0.0.15

package/dist/capability.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Capability Report types (ADR-0003): the runtime's answer to "can this content be
+ * delivered, and if not, why". In their own module so the RP interpreter can report
+ * issues without importing the React runtime.
+ */
+export type CapabilityIssueType = "unsupported-interaction" | "invalid-interaction" | "unsupported-element" | "unsupported-rp";
+export interface CapabilityIssue {
+    readonly type: CapabilityIssueType;
+    /** The interaction kind, element name, or RP rule/operator/template at issue. */
+    readonly name: string;
+    readonly responseIdentifier?: string;
+    readonly detail?: string;
+}
+export interface CapabilityReport {
+    readonly deliverable: boolean;
+    readonly issues: readonly CapabilityIssue[];
+}

package/dist/content-model.d.ts

@@ -0,0 +1,42 @@
+/**
+ * The single source of truth for what may appear inside an item/stimulus body.
+ *
+ * Both the renderer's allowlist tree-walk and (later) the authoring editor schema
+ * derive from this definition. QTI 3 bodies are validated for *structure* by
+ * `@conform-ed/contracts`, but their embedded HTML flow content is modelled as a
+ * generic node tree — so validation does not sanitize. This allowlist is the
+ * sanitizer: the renderer emits React only for elements/attributes named here and
+ * drops everything else. It never injects HTML strings.
+ *
+ * v0 scope: the minimal flow/inline vocabulary plus the language-critical bits
+ * (ruby/furigana, MathML). It grows incrementally with the renderer — never "all of
+ * HTML5 at once".
+ */
+/** Interaction node kinds conform-ed ships descriptors and Reference Skins for. */
+export declare const v0InteractionKinds: readonly ["associateInteraction", "choiceInteraction", "drawingInteraction", "endAttemptInteraction", "extendedTextInteraction", "gapMatchInteraction", "graphicAssociateInteraction", "graphicGapMatchInteraction", "graphicOrderInteraction", "hotspotInteraction", "hottextInteraction", "inlineChoiceInteraction", "matchInteraction", "mediaInteraction", "orderInteraction", "positionObjectStage", "selectPointInteraction", "sliderInteraction", "textEntryInteraction", "uploadInteraction"];
+export type V0InteractionKind = (typeof v0InteractionKinds)[number];
+export interface ContentModel {
+    readonly interactionKinds: ReadonlySet<string>;
+    readonly flowElements: ReadonlySet<string>;
+    readonly mathRoot: string;
+    readonly globalAttributes: ReadonlySet<string>;
+    /** Per-element attribute allowlists, additive to `globalAttributes`. */
+    readonly elementAttributes: ReadonlyMap<string, ReadonlySet<string>>;
+    /** Attributes whose values are asset references, routed through the Asset Resolver. */
+    readonly urlAttributes: ReadonlySet<string>;
+}
+export declare const v0ContentModel: ContentModel;
+export declare function isAllowedFlowElement(model: ContentModel, name: string): boolean;
+export declare function isInteractionKind(model: ContentModel, kind: string): boolean;
+/**
+ * Reduce a raw attribute bag to the safe, allowlisted subset for one element. Used by
+ * the body walk so a node that validates against QTI structure still cannot carry
+ * script or handlers. The allowlist is the global set plus the element's own entries.
+ */
+export declare function sanitizeAttributes(model: ContentModel, elementName: string, attributes: Record<string, unknown> | undefined): Record<string, string>;
+/**
+ * Attribute hardening for MathML subtrees: presentation attributes (mathvariant,
+ * linethickness, …) are not individually allowlisted — MathML has no scripting surface
+ * once event handlers and javascript: URLs are stripped.
+ */
+export declare function sanitizeMathAttributes(attributes: Record<string, unknown> | undefined): Record<string, string>;

package/dist/graphic.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Graphic primitives shared by the graphic interaction family and areaMapping scoring:
+ * QTI shape/coords parsing and point-in-shape hit testing. Pure logic, no React.
+ *
+ * Shapes follow the QTI (HTML image-map) conventions:
+ * - `circle`:  center-x, center-y, radius
+ * - `rect`:    left-x, top-y, right-x, bottom-y
+ * - `poly`:    x1, y1, ..., xn, yn
+ * - `ellipse`: center-x, center-y, radius-x, radius-y
+ * - `default`: the entire image
+ */
+export type QtiShape = "circle" | "rect" | "poly" | "ellipse" | "default";
+export interface Point {
+    readonly x: number;
+    readonly y: number;
+}
+/** Parse a QTI coords attribute ("10,20,30") into numbers. */
+export declare function parseCoords(coords: string): number[];
+/** Parse a QTI point value ("x y") or null when malformed. */
+export declare function parsePoint(value: string): Point | null;
+export declare function formatPoint(point: Point): string;
+/** QTI hit test: is `point` inside the area described by (shape, coords)? */
+export declare function pointInShape(shape: string, coords: readonly number[], point: Point): boolean;

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+export declare const qtiReactPackageName = "@conform-ed/qti-react";
+export { v0ContentModel, v0InteractionKinds, isAllowedFlowElement, isInteractionKind, sanitizeAttributes, type ContentModel, type V0InteractionKind, } from "./content-model";
+export { foldString, mapResponse, matchCorrect, mapResponsePoint, scoreResponse } from "./response-processing";
+export { assessmentItemViewFromNormalized, assessmentTestViewFromNormalized } from "./normalized-item";
+export { formatPoint, parseCoords, parsePoint, pointInShape, type Point, type QtiShape } from "./graphic";
+export { applyCorrectResponseOverrides, collectRpIssues, collectTemplateIssues, executeResponseProcessing, executeTemplateProcessing, mulberry32, resolveTemplate, } from "./rp";
+export type { CustomOperatorImplementation, MaybeRpValue, OutcomeDeclarationView, OutcomeValue, ResponseNormalization, ResponseProcessingContext, ResponseProcessingResult, ResponseProcessingView, RpConditionBranch, RpExpressionView, RpRecordField, RpRuleView, RpScalar, RpValue, TemplateConditionBranch, TemplateDeclarationView, TemplateProcessingContext, TemplateProcessingResult, TemplateProcessingView, TemplateRuleView, } from "./rp";
+export { createAttemptStore, type AttemptSnapshot, type AttemptStore, type AttemptStoreOptions } from "./store";
+export { createTestController, createTestSessionStore, type TestSessionSnapshot, type TestSessionStore, type TestSessionStoreOptions, type AssessmentItemRefView, type AssessmentSectionView, type AssessmentTestView, type BranchRuleView, type ItemSessionControlView, type OutcomeConditionBranch, type OutcomeRuleView, type TestController, type TestFeedbackView, type TestItemResult, type TestPartView, type TestPlan, type TestPlanItem, type TestPlanPart, type TestSessionState, type TimeLimitsView, } from "./test";
+export { createQtiRuntime, defineInteraction, type AssessmentItemView, type AttemptController, type BodyNode, type CapabilityIssue, type CapabilityIssueType, type CapabilityReport, type ContentRendererProps, type FeedbackView, type InteractionDescriptor, type InteractionNode, type InteractionRenderProps, type InteractionSkin, type InteractionStatus, type ItemRendererProps, type NodeOverrides, type OptionProps, type OptionStatus, type QtiRuntime, type QtiRuntimeConfig, type SkinRegistry, type XmlContentNode, } from "./runtime";
+export { createPciModuleRegistry, createPciSkin, mountPci, pciResponseToValue, portableCustomInteraction, serializePciMarkup, valueToPciResponse, type PciConfiguration, type PciInstance, type PciInteractionNode, type PciModule, type PciModuleRegistry, type PciModuleRegistryOptions, type PciMountHandle, type PciMountOptions, type PciSkinOptions, } from "./pci";
+export { associateInteraction, choiceInteraction, drawingInteraction, endAttemptInteraction, extendedTextInteraction, gapMatchInteraction, graphicAssociateInteraction, graphicGapMatchInteraction, graphicOrderInteraction, hotspotInteraction, hottextInteraction, inlineChoiceInteraction, matchInteraction, mediaInteraction, orderInteraction, positionObjectStage, qtiCoreInteractions, selectPointInteraction, sliderInteraction, textEntryInteraction, uploadInteraction, } from "./interactions";
+export { AssociateReferenceSkin, ChoiceReferenceSkin, DrawingReferenceSkin, EndAttemptReferenceSkin, ExtendedTextReferenceSkin, GapMatchReferenceSkin, GraphicAssociateReferenceSkin, GraphicGapMatchReferenceSkin, GraphicOrderReferenceSkin, GraphicStage, HotspotReferenceSkin, HottextReferenceSkin, InlineChoiceReferenceSkin, MatchReferenceSkin, MediaReferenceSkin, OrderReferenceSkin, PositionObjectReferenceSkin, SelectPointReferenceSkin, SliderReferenceSkin, TextEntryReferenceSkin, UploadReferenceSkin, referenceSkin, textOf, } from "./reference-skin";
+export type { AreaMapEntryView, AreaMappingView, Cardinality, CorrectResponseView, MapEntryView, MappingView, ResponseDeclarationView, ResponseValue, ScoreResult, } from "./types";