@citolab/qti-components 8.0.0 → 8.0.1

package/dist/item.d.ts

@@ -1 +1,92 @@
-export * from '@qti-components/item';
+import * as lit from 'lit';
+import { LitElement } from 'lit';
+import { Q as QtiContext } from './qti.context.d-CejJMlfZ.js';
+import { C as ComputedItemContext } from './computed-item.types.d-BKZdSLLJ.js';
+import { QtiAssessmentItem } from './elements.js';
+import { C as ConfigContext } from './config.context.d-BvU9r-Mg.js';
+import './item.types.d-QU7LljEK.js';
+import './interaction.interface.d-CvjHM2bi.js';
+import './qti-feedback.d-DZbad0RN.js';
+import './qti-rule-base.d-ajOnfGXY.js';
+
+/**
+ * `<item-container>` is a custom element designed for hosting the qti-assessment-item.
+ * The `qti-assessment-item` will be placed inside the shadow DOM of this element.
+ * The element loads the item from the provided URL and renders it inside the shadow DOM.
+ *
+ * ### Styling
+ * Add a class to the element for styling.
+ *
+ * ```html
+ * <qti-item>
+ *   <item-container class="m-4 bg-white" item-url="./path/to/item.xml"></item-container>
+ * </qti-item>
+ * ```
+ */
+declare class ItemContainer extends LitElement {
+    #private;
+    /** Scoped registry used by the item shadow root. Must be set before connection. */
+    customElementRegistry: CustomElementRegistry | null;
+    /** URL of the item to load */
+    itemURL: string;
+    /** A parsed HTML document */
+    itemDoc: DocumentFragment;
+    /** The raw XML string */
+    itemXML: string;
+    protected qtiContext: QtiContext;
+    protected createRenderRoot(): HTMLElement | DocumentFragment;
+    protected handleItemURLChange(): Promise<void>;
+    protected handleItemXMLChange(): void;
+    connectedCallback(): Promise<void>;
+    render(): lit.TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'item-container': ItemContainer;
+    }
+}
+
+declare class ItemPrintVariables extends LitElement {
+    protected computedContext?: ComputedItemContext;
+    static styles: lit.CSSResult;
+    render(): lit.TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'item-print-variables': ItemPrintVariables;
+    }
+}
+
+/**
+ * `<qti-item>` is a custom element designed for rendering a single `qti-assessment-item`.
+ * It can also host some functionalities to interact with the item like scoring, showing feedback, etc.
+ * Placing a mandatory `<item-container>` inside '<qti-item>' will load or parse the item and render it.
+ * See `<item-container>` for more details.
+ *
+ * ```html
+ * <qti-item>
+ *   <item-container class="m-4 bg-white" item-url="./path/to/item.xml"></item-container>
+ * </qti-item>
+ * ```
+ */
+declare class QtiItem extends LitElement {
+    #private;
+    computedContext: ComputedItemContext;
+    protected assessmentItem?: QtiAssessmentItem;
+    configContext: ConfigContext;
+    /**
+     * Provided so that descendants (e.g. `<item-container>`) can read the QTI runtime
+     * context for standalone item delivery, including the optional shuffle `seed`.
+     */
+    qtiContext: QtiContext;
+    constructor();
+    render(): lit.TemplateResult<1>;
+    disconnectedCallback(): void;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'qti-item': QtiItem;
+    }
+}
+
+export { ItemContainer, ItemPrintVariables, QtiItem };

package/dist/item.js

@@ -1,10 +1,10 @@
-import "./chunk-MJVPNN7W.js";
+import "./chunk-3AJOQCDU.js";
 import {
   ItemContainer,
   ItemPrintVariables,
   QtiItem
-} from "./chunk-W4QZPCNC.js";
-import "./chunk-WCQ26LV7.js";
+} from "./chunk-QECOPVPO.js";
+import "./chunk-7HC5SMCU.js";
 import "./chunk-64XSIBGO.js";
 import "./chunk-IJD53WY6.js";
 import "./chunk-H3J7LFRO.js";

package/dist/item.types.d-QU7LljEK.d.ts

@@ -0,0 +1,82 @@
+interface directedPair {
+    destination: string;
+    source: string;
+}
+interface ResponseInteraction {
+    responseIdentifier: string;
+    response: string | string[];
+    state?: string | null;
+}
+interface Calculate {
+    calculate: () => string | string[];
+}
+type float = number;
+type integer = number;
+type BaseType = 'boolean' | 'directedPair' | 'duration' | 'float' | 'integer' | 'string' | 'identifier' | 'pair' | 'record';
+type Multiple = string | string[][];
+type Ordered = string | string[][];
+type Cardinality = 'multiple' | 'ordered' | 'single' | 'record';
+
+type QtiAreaMapping = {
+    defaultValue: number;
+    lowerBound?: number;
+    upperBound?: number;
+    areaMapEntries: QtiAreaMapEntry[];
+};
+type QtiAreaMapEntry = {
+    shape: areaShape;
+    coords: string;
+    mappedValue: number;
+    defaultValue: number;
+};
+type QtiMapping = {
+    defaultValue: number;
+    lowerBound?: number;
+    upperBound?: number;
+    mapEntries: QtiMapEntry[];
+};
+type QtiMapEntry = {
+    mapKey: string;
+    mappedValue: number;
+    caseSensitive: boolean;
+};
+type areaShape = 'default' | 'circle' | 'rect' | 'ellipse' | 'poly';
+interface VariableValue<T> {
+    identifier: string;
+    value: Readonly<T>;
+    defaultValue?: T | null;
+    type: 'outcome' | 'response' | 'context' | 'template';
+}
+interface VariableDeclaration<T> extends VariableValue<T> {
+    cardinality?: Cardinality;
+    baseType?: BaseType;
+}
+interface OutcomeVariable extends VariableDeclaration<string | string[] | null> {
+    interpolationTable?: Map<number, number>;
+    externalScored?: 'human' | 'externalMachine' | null;
+}
+interface ResponseVariable extends VariableDeclaration<string | string[] | null> {
+    candidateResponse?: string | string[] | null;
+    mapping?: QtiMapping;
+    areaMapping?: QtiAreaMapping;
+    correctResponse?: string | string[] | null;
+}
+interface TemplateVariable extends VariableDeclaration<string | string[] | number | boolean | null> {
+    type: 'template';
+    mathVariable?: boolean;
+    paramVariable?: boolean;
+}
+
+interface ItemContext {
+    identifier?: string;
+    href?: string;
+    variables?: ReadonlyArray<VariableDeclaration<string | string[] | null>>;
+    /**
+     * Optional per-interaction opaque state, keyed by responseIdentifier.
+     * Used for interactions that support state save/restore (e.g. PCI).
+     */
+    state?: Record<string, string | null>;
+}
+declare const itemContextVariables: VariableDeclaration<string | string[]>[];
+
+export { type BaseType as B, type Calculate as C, type ItemContext as I, type Multiple as M, type Ordered as O, type QtiAreaMapEntry as Q, type ResponseInteraction as R, type TemplateVariable as T, type VariableDeclaration as V, type Cardinality as a, type OutcomeVariable as b, type QtiAreaMapping as c, type QtiMapEntry as d, type QtiMapping as e, type ResponseVariable as f, type VariableValue as g, type areaShape as h, type directedPair as i, type float as j, type integer as k, itemContextVariables as l };

package/dist/loader.d.ts

@@ -1 +1,22 @@
-export * from '@qti-components/loader';
+import { QtiAssessmentItem } from './elements.js';
+import 'lit';
+import './item.types.d-QU7LljEK.js';
+import './interaction.interface.d-CvjHM2bi.js';
+import './qti-feedback.d-DZbad0RN.js';
+import './qti-rule-base.d-ajOnfGXY.js';
+
+type ManifestInfo = {
+    testIdentifier: string;
+    testHTMLDoc: DocumentFragment;
+    testURI: string;
+    testURL: string;
+    items: {
+        identifier: string;
+        href: string;
+        category: string;
+    }[];
+};
+declare const getManifestInfo: (manifestURL: string) => Promise<ManifestInfo>;
+declare const getItemByUri: (itemUri: string) => Promise<QtiAssessmentItem>;
+
+export { type ManifestInfo, getItemByUri, getManifestInfo };