@citolab/qti-components 7.0.1 → 7.0.2

package/dist/qti-test/index.d.cts

@@ -1,304 +0,0 @@
-import * as lit_html from 'lit-html';
-import { I as ItemContext, V as VariableDeclaration, p as QtiAssessmentItem } from '../qti-simple-choice-CynLWb8d.cjs';
-import * as lit from 'lit';
-import { LitElement } from 'lit';
-import 'lit-html/directives/ref.js';
-
-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;
-    }
-}
-
-export { QtiAssessmentItemRef, QtiAssessmentSection, QtiAssessmentTest, QtiTest, QtiTestPart, TestContainer, TestItemLink, TestNext, TestPagingButtonsStamp, TestPrev, TestView };