@longsightgroup/qti3-player 0.1.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Longsight, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,49 @@
+# @longsightgroup/qti3-player
+
+Style-neutral web component player for QTI 3 assessment items.
+
+This package renders one QTI item at a time, captures responses, validates responses,
+scores attempts through `@longsightgroup/qti3-core`, and emits host-readable state events.
+
+## Install
+
+```sh
+npm install @longsightgroup/qti3-player
+```
+
+## Use
+
+```ts
+import { defineQtiAssessmentItemPlayer } from "@longsightgroup/qti3-player";
+
+defineQtiAssessmentItemPlayer();
+```
+
+```html
+<qti-assessment-item-player id="player"></qti-assessment-item-player>
+```
+
+```ts
+const player = document.querySelector("qti-assessment-item-player");
+
+await player?.loadXml(xml, {
+  status: "interacting",
+  sessionControl: {
+    validateResponses: true,
+    showFeedback: true,
+  },
+});
+
+player?.addEventListener("qti-statechange", (event) => {
+  console.log(event.detail.state);
+});
+```
+
+## Styling
+
+The player uses light DOM and is style-neutral by design. Host applications can style
+the rendered `qti3-*` classes directly while preserving the item author's QTI shared
+vocabulary classes.
+
+See the main repository README for the support matrix and release notes:
+https://github.com/LongsightGroup/qti3

package/dist/index.d.ts

@@ -0,0 +1,62 @@
+import { type QtiAttemptStatus, type QtiAttemptStateV1, type QtiScoreResult } from "@longsightgroup/qti3-core";
+export interface QtiPlayerSessionControl {
+    validateResponses?: boolean | undefined;
+    showFeedback?: boolean | undefined;
+}
+export type QtiPlayerFetchXml = (url: string) => Promise<string>;
+export type QtiPlayerResolveAsset = (url: string) => string;
+export interface QtiPlayerLoadOptions {
+    state?: QtiAttemptStateV1 | undefined;
+    status?: QtiAttemptStatus | undefined;
+    sessionControl?: QtiPlayerSessionControl | undefined;
+    fetchXml?: QtiPlayerFetchXml | undefined;
+    resolveAsset?: QtiPlayerResolveAsset | undefined;
+}
+declare const HTMLElementBase: typeof HTMLElement;
+export declare class QtiAssessmentItemPlayer extends HTMLElementBase {
+    private documentModel?;
+    private session?;
+    private resolveAsset;
+    private validationMessages;
+    private sessionControl;
+    loadXml(xml: string, options?: QtiPlayerLoadOptions): Promise<void>;
+    loadUrl(url: string, options?: QtiPlayerLoadOptions): Promise<void>;
+    scoreAttempt(): QtiScoreResult | undefined;
+    reset(): void;
+    restore(state: QtiAttemptStateV1): void;
+    suspend(): void;
+    endAttempt(): void;
+    serialize(): QtiAttemptStateV1 | undefined;
+    private emitStateChange;
+    private render;
+    private renderInteraction;
+    private renderEmbeddedInteraction;
+    private renderContentNodes;
+    private renderContentNode;
+    private renderTemplateContent;
+    private renderPrintedVariable;
+    private renderFeedbackContent;
+    private updateDynamicBodyState;
+    private updateAttemptAvailability;
+    private attemptIsCompleted;
+    private isFeedbackVisible;
+    private isTemplateContentVisible;
+    private currentVariableValue;
+    private currentTemplateValue;
+    private mathTemplateValue;
+    private currentResponseValue;
+    private applyDefaultStyles;
+    private resolveRenderedAssets;
+    private validateResponses;
+    private renderValidationMessages;
+    private clearValidationMessage;
+    private renderFeedback;
+}
+export declare function defineQtiAssessmentItemPlayer(): void;
+declare global {
+    interface HTMLElementTagNameMap {
+        "qti-assessment-item-player": QtiAssessmentItemPlayer;
+    }
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EAQtB,KAAK,cAAc,EAEpB,MAAM,2BAA2B,CAAC;AAEnC,MAAM,WAAW,uBAAuB;IACtC,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACpC;AAED,MAAM,MAAM,iBAAiB,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AACjE,MAAM,MAAM,qBAAqB,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;AAE5D,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IACtC,MAAM,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IACtC,cAAc,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAC;IACrD,QAAQ,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IACzC,YAAY,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;CAClD;AAED,QAAA,MAAM,eAAe,EAAE,OAAO,WAOO,CAAC;AAEtC,qBAAa,uBAAwB,SAAQ,eAAe;IAC1D,OAAO,CAAC,aAAa,CAAC,CAAc;IACpC,OAAO,CAAC,OAAO,CAAC,CAAiB;IACjC,OAAO,CAAC,YAAY,CAAoC;IACxD,OAAO,CAAC,kBAAkB,CAAuB;IACjD,OAAO,CAAC,cAAc,CAGpB;IAEI,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BvE,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAK7E,YAAY,IAAI,cAAc,GAAG,SAAS;IA0B1C,KAAK,IAAI,IAAI;IAUb,OAAO,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAmBvC,OAAO,IAAI,IAAI;IAMf,UAAU,IAAI,IAAI;IAclB,SAAS;IAMT,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,MAAM;IAqDd,OAAO,CAAC,iBAAiB;IAiJzB,OAAO,CAAC,yBAAyB;IAqCjC,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,iBAAiB;IAwCzB,OAAO,CAAC,qBAAqB;IAc7B,OAAO,CAAC,qBAAqB;IAU7B,OAAO,CAAC,qBAAqB;IAW7B,OAAO,CAAC,sBAAsB;IA+B9B,OAAO,CAAC,yBAAyB;IAgCjC,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,iBAAiB;IAQzB,OAAO,CAAC,wBAAwB;IAWhC,OAAO,CAAC,oBAAoB;IAU5B,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,iBAAiB;IAezB,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,kBAAkB;IAM1B,OAAO,CAAC,qBAAqB;IAW7B,OAAO,CAAC,iBAAiB;IAkDzB,OAAO,CAAC,wBAAwB;IAgChC,OAAO,CAAC,sBAAsB;IAQ9B,OAAO,CAAC,cAAc;CAgBvB;AAED,wBAAgB,6BAA6B,IAAI,IAAI,CAIpD;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,4BAA4B,EAAE,uBAAuB,CAAC;KACvD;CACF"}