@citolab/qti-components 6.9.1-beta.9 → 7.0.2

package/dist/index.d.ts

@@ -0,0 +1,465 @@
+import * as lit_html from 'lit-html';
+import * as lit from 'lit';
+import { LitElement } from 'lit';
+import { Q as QtiRule, a as QtiRuleBase, b as QtiExpressionBase, c as QtiExpression, B as BaseType, d as QtiConditionExpression, R as ResponseVariable, V as VariableDeclaration, I as ItemContext, e as QtiAssessmentItem } from './qti-simple-choice-DG8ImdPz.js';
+export { s as ActiveElementMixin, A as ActiveElementMixinInterface, C as Calculate, n as Cardinality, r as ChoiceInterface, ai as Interaction, f as InteractionChangedDetails, M as Multiple, m as Ordered, N as Orientation, O as OutcomeChangedDetails, p as OutcomeVariable, X as QtiAnd, q as QtiAssessmentStimulusRef, aj as QtiAssociableHotspot, a1 as QtiAssociateInteraction, P as QtiChoiceInteraction, y as QtiCompanionMaterialsInfo, z as QtiContentBody, a2 as QtiCustomInteraction, ah as QtiCustomOperator, a3 as QtiEndAttemptInteraction, H as QtiExtendedTextInteraction, E as QtiFeedbackBlock, F as QtiFeedbackInline, ak as QtiGap, al as QtiGapImg, a4 as QtiGapMatchInteraction, am as QtiGapText, a5 as QtiGraphicAssociateInteraction, a6 as QtiGraphicGapMatchInteraction, a7 as QtiGraphicOrderInteraction, an as QtiHotspotChoice, a8 as QtiHotspotInteraction, ao as QtiHottext, K as QtiHottextInteraction, ap as QtiInlineChoice, L as QtiInlineChoiceInteraction, g as QtiInteractionChanged, t as QtiItemBody, W as QtiLookupOutcomeValue, Z as QtiMapping, a9 as QtiMatchInteraction, aa as QtiMediaInteraction, G as QtiModalFeedback, ab as QtiOrderInteraction, h as QtiOutcomeChanged, w as QtiOutcomeDeclaration, S as QtiOutcomeProcessing, T as QtiOutcomeProcessingProcessor, a0 as QtiPortableCustomInteraction, ac as QtiPositionObjectStage, u as QtiPrompt, x as QtiResponseDeclaration, U as QtiResponseProcessing, D as QtiRubricBlock, ad as QtiSelectPointInteraction, aq as QtiSimpleAssociableChoice, ar as QtiSimpleChoice, ae as QtiSliderInteraction, v as QtiStylesheet, _ as QtiSubtract, J as QtiTextEntryInteraction, j as ResponseInteraction, o as VariableValue, i as directedPair, k as float, l as integer, ag as itemContext, af as itemContextVariables, Y as qtiAndMixin, $ as qtiSubtractMixin } from './qti-simple-choice-DG8ImdPz.js';
+import 'lit-html/directives/ref.js';
+
+declare class QtiResponseCondition extends QtiRule {
+    render(): lit_html.TemplateResult<1>;
+    process(): void;
+}
+
+declare class QtiSetOutcomeValue extends QtiRule {
+    process(): void;
+}
+declare class QtiSetOutcomeValueRule<T> implements QtiRuleBase {
+    private expression;
+    constructor(expression: QtiExpressionBase<T>);
+    process(): any;
+}
+
+declare class QtiResponseElse extends LitElement {
+    render(): lit_html.TemplateResult<1>;
+    calculate(): boolean;
+    getSubRules(): QtiRule[];
+    process(): void;
+}
+
+declare class QtiResponseIf extends QtiResponseElse {
+    calculate(): boolean;
+    getSubRules(): QtiRule[];
+}
+
+declare class QtiResponseElseIf extends QtiResponseIf {
+    render(): lit_html.TemplateResult<1>;
+}
+
+declare class QtiBaseValue extends QtiExpression<string> {
+    baseType: BaseType;
+    getResult(): string;
+}
+
+declare class QtiContains extends QtiConditionExpression {
+    getResult(): boolean;
+}
+
+declare class QtiCorrect extends QtiExpression<string | string[]> {
+    get interpretation(): string;
+    getResult(): string | string[];
+}
+
+declare class QtiEqualRounded extends QtiExpression<boolean> {
+    roundingMode: 'decimalPlaces' | 'significantFigures';
+    get figures(): number;
+    getResult(): boolean;
+}
+
+declare class QtiEqual extends QtiExpression<boolean> {
+    toleranceMode: 'exact' | 'relative' | 'absolute';
+    getResult(): boolean;
+}
+
+declare class QtiGt extends QtiExpression<boolean> {
+    getResult(): boolean;
+}
+
+declare class QtiGte extends QtiConditionExpression {
+    getResult(): boolean;
+}
+
+declare class QtiIsNull extends QtiExpression<boolean> {
+    getResult(): boolean;
+}
+
+declare class QtiLt extends QtiExpression<boolean> {
+    getResult(): boolean;
+}
+
+declare class QtiLte extends QtiConditionExpression {
+    getResult(): boolean;
+}
+
+declare class QtiMapResponse extends QtiExpression<number> {
+    identifier: string;
+    getResult(): number;
+}
+
+declare class QtiMatch extends QtiExpression<boolean> {
+    getResult(): boolean;
+    static match(valueToMap: ResponseVariable, correctValueInfo: ResponseVariable): boolean;
+}
+
+declare class QtiMember extends QtiExpression<boolean | null> {
+    getResult(): boolean;
+}
+
+declare class QtiMultiple extends QtiExpression<VariableDeclaration<string | string[]>[]> {
+    getResult(): ResponseVariable[];
+}
+
+declare class QtiNot extends QtiExpression<boolean> {
+    render(): lit_html.TemplateResult<1>;
+    getResult(): boolean;
+}
+
+declare class QtiOr extends QtiConditionExpression {
+    getResult(): boolean;
+}
+
+declare class QtiOrdered extends QtiExpression<ResponseVariable[]> {
+    getResult(): ResponseVariable[];
+}
+
+declare class QtiPrintedVariable extends LitElement {
+    identifier: string;
+    protected context?: ItemContext;
+    render(): lit_html.TemplateResult<1>;
+    calculate(): VariableDeclaration<string | string[]>;
+}
+
+declare class QtiProduct extends QtiExpression<number> {
+    getResult(): number;
+}
+
+declare class QtiStringMatch extends QtiExpression<boolean> {
+    caseSensitive: string;
+    getResult(): boolean;
+}
+
+declare class QtiSum extends QtiExpression<number> {
+    private _expression;
+    constructor();
+    getResult(): number;
+}
+declare class QtiSumExpression implements QtiExpressionBase<number> {
+    private expressions;
+    constructor(expressions: QtiExpressionBase<number>[]);
+    calculate(): number;
+}
+
+declare class QtiVariable extends QtiExpression<string | string[]> {
+    getResult(): Readonly<string | string[]>;
+}
+
+declare class QtiPositionObjectInteraction extends LitElement {
+    render(): lit_html.TemplateResult<1>;
+    static styles: lit.CSSResult[];
+}
+
+interface TestContext {
+    items: (ItemContext & {
+        category?: string;
+    })[];
+    testOutcomeVariables: VariableDeclaration<string | string[]>[];
+}
+type TestElement = {
+    el: QtiAssessmentTest;
+};
+
+declare class QtiAssessmentItemRef extends LitElement {
+    category?: string;
+    identifier?: string;
+    required?: boolean;
+    fixed?: boolean;
+    href?: string;
+    _testContext?: TestContext;
+    weigths: Map<string, number>;
+    xmlDoc: DocumentFragment;
+    protected createRenderRoot(): HTMLElement | DocumentFragment;
+    get assessmentItem(): QtiAssessmentItem | null;
+    connectedCallback(): Promise<void>;
+    render(): lit_html.TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'qti-assessment-item-ref': QtiAssessmentItemRef;
+    }
+}
+
+declare class QtiAssessmentSection extends LitElement {
+    identifier: string;
+    required: string;
+    fixed: boolean;
+    title: string;
+    visible: boolean;
+    keepTogether: boolean;
+    _testContext?: TestContext;
+    connectedCallback(): Promise<void>;
+    render(): lit_html.TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'qti-assessment-section': QtiAssessmentSection;
+    }
+}
+
+declare class QtiAssessmentTest extends LitElement {
+    identifier: string;
+    title: string;
+    _testContext?: TestContext;
+    connectedCallback(): Promise<void>;
+    render(): lit_html.TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'qti-assessment-test': QtiAssessmentTest;
+    }
+}
+
+declare class QtiTestPart extends LitElement {
+    identifier: string;
+    title: string;
+    class: string;
+    NavigationMode: 'linear' | 'nonlinear';
+    submissionMode: 'individual' | 'simultaneous';
+    connectedCallback(): Promise<void>;
+    render(): lit_html.TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'qti-test-part': QtiTestPart;
+    }
+}
+
+declare abstract class TestBase extends LitElement {
+    protected _testContext: Readonly<TestContext>;
+    protected testElement: TestElement;
+    constructor();
+    get context(): TestContext;
+    set context(testContext: TestContext);
+    private _updateItemVariablesInTestContext;
+    /**
+     * Updates the variables of an assessment item in the test context.
+     * - Matches the assessment item with the corresponding test context item.
+     * - If the item is not found, logs a warning.
+     * - Updates variables in the test context if exactly one variable exists.
+     * - Otherwise, syncs the assessment item's variables with the test context.
+     *
+     * @param assessmentItem - The assessment item to update.
+     */
+    private _updateItemInTestContext;
+    connectedCallback(): void;
+}
+
+declare const QtiTest_base: (abstract new (...args: any[]) => {}) & (abstract new (...args: any[]) => {}) & (abstract new (...args: any[]) => {}) & typeof TestBase;
+/**
+ * `<qti-test>` is a custom element designed for rendering and interacting with QTI (Question and Test Interoperability) tests.
+ *
+ * This component leverages several mixins to provide functionality for loading, navigating, processing, and displaying QTI test assessments.
+ *
+ * ### Example Usage
+ *
+ * Minimal markup:
+ * ```html
+ * <qti-test test="./path/to/assessment.xml">
+ *   <test-container></test-container>
+ * </qti-test>
+ * ```
+ *
+ * With navigation buttons:
+ * ```html
+ * <qti-test >
+ *   <test-container test-url="./path/to/assessment.xml"></test-container>
+ *   <div class="flex">
+ *      <test-prev></test-prev>
+ *      <test-next></test-next>
+ *   </div>
+ * </qti-test>
+ * ```
+ *
+ * You can use normal class names to style the elements.
+ * And you can use the `test-prev` and `test-next` elements to navigate through the test.
+ *
+ * @attr {string} testURL - the relative location to the QTI assessment.xml file
+ *
+ * @tag qti-player
+ *
+ * ### Features
+ *
+ * - **Dynamic Template Loading**:
+ *   If a `<template>` element is included as a child of `<qti-test>`, its content is dynamically appended to the shadow DOM.
+ */
+declare class QtiTest extends QtiTest_base {
+    /**
+     * Lifecycle callback invoked when the element is added to the DOM.
+     * Automatically appends the content of a `<template>` element (if present)
+     * to the shadow DOM.
+     */
+    connectedCallback(): void;
+    /**
+     * Renders the component's template.
+     * Provides a default `<slot>` for content projection.
+     */
+    render(): lit_html.TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'qti-test': QtiTest;
+    }
+}
+
+declare abstract class TestComponent extends LitElement {
+    disabled: boolean;
+    _testContext?: TestContext;
+    _testElement?: TestElement;
+    _handleTestElementChange(_oldValue: TestElement, newValue: TestElement): void;
+    protected _internals: ElementInternals;
+    protected items: any;
+    protected itemIndex: any;
+    protected view: any;
+    constructor();
+    willUpdate(changedProperties: Map<string | number | symbol, unknown>): void;
+    protected _switchView(view: string): void;
+    protected _requestItem(identifier: string): void;
+}
+
+/**
+ * Represents a custom element for navigating to the next test item.
+ *
+ * @remarks
+ * This element provides functionality for navigating to the next test item.
+ *
+ * @example
+ * ```html
+ * <test-next></test-next>
+ * ```
+ */
+declare class TestNext extends TestComponent {
+    static styles: lit.CSSResult;
+    constructor();
+    willUpdate(changedProperties: Map<string | number | symbol, unknown>): void;
+    render(): lit_html.TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'test-next': TestNext;
+    }
+}
+
+/**
+ * Represents a custom element for navigating to the previous test item.
+ *
+ * @remarks
+ * This element provides functionality for navigating to the previous test item.
+ *
+ * @example
+ * ```html
+ * <test-prev></test-prev>
+ * ```
+ */
+declare class TestPrev extends TestComponent {
+    static styles: lit.CSSResult;
+    constructor();
+    willUpdate(changedProperties: Map<string | number | symbol, unknown>): void;
+    render(): lit_html.TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'test-previous': TestPrev;
+    }
+}
+
+declare class TestView extends TestComponent {
+    static DEFAULT_VIEW_OPTIONS: string[];
+    label: string;
+    viewOptions: string;
+    _handleViewOptionsChange: (_: string, viewOptions: string) => void;
+    private _viewOptions;
+    render(): lit_html.TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'test-view': TestView;
+    }
+}
+
+declare class TestItemLink extends TestComponent {
+    private itemId;
+    constructor();
+    render(): lit_html.TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'test-item-link': TestItemLink;
+    }
+}
+
+/**
+ * `<test-container>` is a custom element designed for hosting the qti-assessment-test.
+ * The `qti-assessment-test` will be placed inside the shadow DOM of this element.
+ *
+ * ### Example Usage
+ * The `test-container` element to hosts the visual representation of the items.
+ * You can style the container by adding a class to the element.
+ *
+ * ```html
+ * <qti-test testurl="./path/to/assessment.xml">
+ *   <test-container class="container bg-white m-2"></test-container>
+ * </qti-test>
+ * ```
+ *
+ * @tag test-container
+ */
+declare class TestContainer extends LitElement {
+    /**
+     * Internal state for the dynamically loaded content.
+     * This is a Promise resolving to the content that will be rendered.
+     */
+    private content;
+    testURL: string;
+    /**
+     * Preloaded content from a `<template>` child, if present.
+     */
+    private preContent;
+    /**
+     * Lifecycle callback invoked when the element is added to the DOM.
+     * Handles template preloading and dispatches a `qti-load-test-request` event
+     * if no template is found.
+     */
+    connectedCallback(): Promise<void>;
+    /**
+     * Renders the component content.
+     * Preloaded template content is rendered first, followed by the default slot
+     * and dynamically loaded content.
+     */
+    render(): lit_html.TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'test-container': TestContainer;
+    }
+}
+
+declare class TestPagingButtonsStamp extends TestComponent {
+    private maxDisplayedItems;
+    private skipOnCategory;
+    protected createRenderRoot(): this;
+    constructor();
+    render(): lit_html.TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'test-paging-buttons-stamp': TestPagingButtonsStamp;
+    }
+}
+
+type Constructor<T = {}> = new (...args: any[]) => T;
+interface QtiItemInterface {
+    identifier?: string;
+    href?: string;
+    xmlDoc: DocumentFragment;
+    assessmentItem: QtiAssessmentItem | null;
+}
+declare function QtiItemMixin<T extends Constructor<LitElement>>(Base: T): Constructor<QtiItemInterface> & T;
+
+declare const QtiItem_base: (new (...args: any[]) => QtiItemInterface) & typeof LitElement;
+declare class QtiItem extends QtiItem_base {
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'qti-item': QtiItem;
+    }
+}
+
+export { BaseType, ItemContext, QtiAssessmentItem, QtiAssessmentItemRef, QtiAssessmentSection, QtiAssessmentTest, QtiBaseValue, QtiConditionExpression, QtiContains, QtiCorrect, QtiEqual, QtiEqualRounded, QtiExpression, QtiExpressionBase, QtiGt, QtiGte, QtiIsNull, QtiItem, type QtiItemInterface, QtiItemMixin, QtiLt, QtiLte, QtiMapResponse, QtiMatch, QtiMember, QtiMultiple, QtiNot, QtiOr, QtiOrdered, QtiPositionObjectInteraction, QtiPrintedVariable, QtiProduct, QtiResponseCondition, QtiResponseElse, QtiResponseElseIf, QtiResponseIf, QtiRule, QtiRuleBase, QtiSetOutcomeValue, QtiSetOutcomeValueRule, QtiStringMatch, QtiSum, QtiSumExpression, QtiTest, QtiTestPart, QtiVariable, ResponseVariable, TestContainer, TestItemLink, TestNext, TestPagingButtonsStamp, TestPrev, TestView, VariableDeclaration };