@citolab/qti-components 6.5.0 → 6.5.1

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as lit from 'lit';
-import { LitElement, PropertyValueMap, CSSResultGroup } from 'lit';
+import { LitElement, CSSResultGroup, PropertyValueMap } from 'lit';
 import * as lit_html from 'lit-html';
 import * as lit_html_directives_ref from 'lit-html/directives/ref';
 
@@ -30,32 +30,6 @@ type InteractionChangedDetails = ResponseInteraction & {
     item: string;
 };
 
-declare class QtiMapping extends LitElement {
-    defaultValue: number;
-    lowerBound: number;
-    upperBound: number;
-    get mapEntries(): {
-        mapKey: string;
-        mappedValue: number;
-    }[];
-}
-
-interface VariableDeclaration<T> {
-    identifier: string;
-    cardinality: Cardinality;
-    baseType: BaseType;
-    value: Readonly<T>;
-    type: 'outcome' | 'response';
-}
-interface OutcomeVariable extends VariableDeclaration<string | string[] | null> {
-    interpolationTable?: Map<number, number>;
-}
-interface ResponseVariable extends VariableDeclaration<string | string[] | null> {
-    candidateResponse?: string | string[] | null;
-    mapping?: QtiMapping;
-    correctResponse?: string | string[] | null;
-}
-
 type QtiChoiceElementSelected = CustomEvent<{
     identifier: string;
     checked: boolean;
@@ -108,6 +82,34 @@ declare global {
     }
 }
 
+declare class QtiMapping extends LitElement {
+    defaultValue: number;
+    lowerBound: number;
+    upperBound: number;
+    get mapEntries(): {
+        mapKey: string;
+        mappedValue: number;
+    }[];
+}
+
+interface VariableValue<T> {
+    identifier: string;
+    value: Readonly<T>;
+    type: 'outcome' | 'response';
+}
+interface VariableDeclaration<T> extends VariableValue<T> {
+    cardinality: Cardinality;
+    baseType: BaseType;
+}
+interface OutcomeVariable extends VariableDeclaration<string | string[] | null> {
+    interpolationTable?: Map<number, number>;
+}
+interface ResponseVariable extends VariableDeclaration<string | string[] | null> {
+    candidateResponse?: string | string[] | null;
+    mapping?: QtiMapping;
+    correctResponse?: string | string[] | null;
+}
+
 type QtiRegisterVariable = CustomEvent<{
     variable: VariableDeclaration<string | string[]>;
 }>;
@@ -124,15 +126,6 @@ declare global {
     }
 }
 
-interface ItemContext {
-    href?: string;
-    identifier: string;
-    variables: ReadonlyArray<VariableDeclaration<string | string[]>>;
-}
-declare const itemContext: {
-    __context__: ItemContext;
-};
-
 /**
  * @summary The qti-assessment-item element contains all the other QTI 3 item structures.
  * @documentation https://www.imsglobal.org/spec/qti/v3p0/impl#h.dltnnj87l0yj
@@ -151,7 +144,7 @@ declare const itemContext: {
  */
 declare class QtiAssessmentItem extends LitElement {
     title: string;
-    identifier: string | undefined;
+    identifier: string;
     adaptive: 'true' | 'false';
     timeDependent: 'true' | 'false';
     disabled: boolean;
@@ -159,8 +152,8 @@ declare class QtiAssessmentItem extends LitElement {
     readonly: boolean;
     _handleReadonlyChange: (_: boolean, readonly: boolean) => void;
     private _context;
-    get context(): ItemContext;
-    set variables(value: VariableDeclaration<string | string[] | null>[]);
+    get variables(): VariableValue<string | string[] | null>[];
+    set variables(value: VariableValue<string | string[] | null>[]);
     private _initialContext;
     private _feedbackElements;
     private _interactionElements;
@@ -188,38 +181,6 @@ declare global {
     }
 }
 
-declare class QtiStylesheet extends LitElement {
-    private styleLink;
-    constructor();
-    protected firstUpdated(_changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>): void;
-    disconnectedCallback(): void;
-}
-
-/**
- * @summary The qti-item-body node contains the text, graphics, media objects and interactions that describe the item's content and information about how it is structured.
- * @documentation https://www.imsglobal.org/spec/qti/v3p0/impl#h.sphpo6lu6zqi
- * @status stable
- * @since 4.0
- *
- * @slot - item body content.
- * @slot qti-rubric-block - the qti rubric block is placed above the item
- *
- */
-declare class QtiItemBody extends LitElement {
-    static styles: CSSResultGroup;
-    render(): lit_html.TemplateResult<1>;
-}
-declare global {
-    interface HTMLElementTagNameMap {
-        'qti-item-body': QtiItemBody;
-    }
-}
-
-declare class QtiPrompt extends LitElement {
-    render(): lit_html.TemplateResult<1>;
-    connectedCallback(): void;
-}
-
 /**
  * @summary qti-choice is used by qti-simple-choice, qti-inline-choice, qti-hottext, qti-hotspot-choice.
  *
@@ -254,32 +215,82 @@ declare global {
     }
 }
 
+/**
+ * @summary The qti-item-body node contains the text, graphics, media objects and interactions that describe the item's content and information about how it is structured.
+ * @documentation https://www.imsglobal.org/spec/qti/v3p0/impl#h.sphpo6lu6zqi
+ * @status stable
+ * @since 4.0
+ *
+ * @slot - item body content.
+ * @slot qti-rubric-block - the qti rubric block is placed above the item
+ *
+ */
+declare class QtiItemBody extends LitElement {
+    static styles: CSSResultGroup;
+    render(): lit_html.TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'qti-item-body': QtiItemBody;
+    }
+}
+
+declare class QtiPrompt extends LitElement {
+    render(): lit_html.TemplateResult<1>;
+    connectedCallback(): void;
+}
+
+declare class QtiStylesheet extends LitElement {
+    private styleLink;
+    constructor();
+    protected firstUpdated(_changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>): void;
+    disconnectedCallback(): void;
+}
+
+interface ItemContext {
+    href?: string;
+    identifier: string;
+    variables: ReadonlyArray<VariableDeclaration<string | string[]>>;
+}
+declare const itemContext: {
+    __context__: ItemContext;
+};
+
 declare class QtiVariableDeclaration extends LitElement {
     render(): lit_html.TemplateResult<1>;
     protected defaultValues(variable: VariableDeclaration<string | string[] | null>): string | string[];
 }
 
-declare class QtiResponseDeclaration extends QtiVariableDeclaration {
+declare class QtiOutcomeDeclaration extends QtiVariableDeclaration {
     baseType: BaseType;
     identifier: string;
     cardinality: Cardinality;
+    itemContext?: ItemContext;
+    static styles: lit.CSSResult[];
+    render(): lit_html.TemplateResult<1>;
+    get interpolationTable(): Map<number, number> | null;
     connectedCallback(): void;
-    private get correctResponse();
-    private get mapping();
 }
 
-declare class QtiOutcomeDeclaration extends QtiVariableDeclaration {
+declare class QtiResponseDeclaration extends QtiVariableDeclaration {
     baseType: BaseType;
     identifier: string;
     cardinality: Cardinality;
-    get interpolationTable(): Map<number, number> | null;
-    constructor();
+    itemContext?: ItemContext;
+    static styles: lit.CSSResult[];
+    render(): lit_html.TemplateResult<1>;
     connectedCallback(): void;
+    private get correctResponse();
+    private get mapping();
 }
 
 declare class QtiCompanionMaterialsInfo extends LitElement {
 }
 
+declare class qtiContentBody extends LitElement {
+    render(): lit_html.TemplateResult<1>;
+}
+
 declare class qtiRubricBlock extends LitElement {
     id: any;
     use: 'instructions' | 'scoring' | 'navigation';
@@ -291,10 +302,6 @@ declare class qtiRubricBlock extends LitElement {
     connectedCallback(): void;
 }
 
-declare class qtiContentBody extends LitElement {
-    render(): lit_html.TemplateResult<1>;
-}
-
 declare abstract class QtiFeedback extends LitElement {
     protected showHide: string;
     outcomeIdentifier: string;
@@ -305,20 +312,20 @@ declare abstract class QtiFeedback extends LitElement {
     private showFeedback;
 }
 
-declare class QtiFeedbackInline extends QtiFeedback {
+declare class QtiFeedbackBlock extends QtiFeedback {
     static styles: lit.CSSResult;
-    render: () => lit_html.TemplateResult<1>;
+    render(): lit_html.TemplateResult<1>;
+    protected firstUpdated(_changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>): void;
 }
 
-declare class QtiModalFeedback extends QtiFeedback {
+declare class QtiFeedbackInline extends QtiFeedback {
     static styles: lit.CSSResult;
     render: () => lit_html.TemplateResult<1>;
 }
 
-declare class QtiFeedbackBlock extends QtiFeedback {
+declare class QtiModalFeedback extends QtiFeedback {
     static styles: lit.CSSResult;
-    render(): lit_html.TemplateResult<1>;
-    protected firstUpdated(_changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>): void;
+    render: () => lit_html.TemplateResult<1>;
 }
 
 declare abstract class Interaction extends LitElement {
@@ -334,16 +341,17 @@ declare abstract class Interaction extends LitElement {
     saveResponse(value: string | string[]): void;
 }
 
-declare class QtiTextEntryInteraction extends Interaction {
+declare class QtiExtendedTextInteraction extends Interaction {
+    textareaRef: lit_html_directives_ref.Ref<HTMLTextAreaElement>;
+    /** expected length is mapped to the property maxlength on the textarea */
     expectedLength: number;
     patternMask: string;
+    /** text appearing in the extended-text-nteraction if it is empty */
     placeholderText: string;
     private _value;
-    private _size;
-    inputRef: lit_html_directives_ref.Ref<HTMLInputElement>;
     classNames: any;
-    handleclassNamesChange(old: any, classes: string): void;
-    set response(value: string | undefined);
+    handleclassNamesChange(old: any, disabled: boolean): void;
+    set response(value: string);
     validate(): boolean;
     static get styles(): lit.CSSResult[];
     render(): lit_html.TemplateResult<1>;
@@ -353,21 +361,20 @@ declare class QtiTextEntryInteraction extends Interaction {
 }
 declare global {
     interface HTMLElementTagNameMap {
-        'qti-text-entry-interaction': QtiTextEntryInteraction;
+        'qti-extended-text-interaction': QtiExtendedTextInteraction;
     }
 }
 
-declare class QtiExtendedTextInteraction extends Interaction {
-    textareaRef: lit_html_directives_ref.Ref<HTMLTextAreaElement>;
-    /** expected length is mapped to the property maxlength on the textarea */
+declare class QtiTextEntryInteraction extends Interaction {
     expectedLength: number;
     patternMask: string;
-    /** text appearing in the extended-text-nteraction if it is empty */
     placeholderText: string;
     private _value;
+    private _size;
+    inputRef: lit_html_directives_ref.Ref<HTMLInputElement>;
     classNames: any;
-    handleclassNamesChange(old: any, disabled: boolean): void;
-    set response(value: string);
+    handleclassNamesChange(old: any, classes: string): void;
+    set response(value: string | undefined);
     validate(): boolean;
     static get styles(): lit.CSSResult[];
     render(): lit_html.TemplateResult<1>;
@@ -377,7 +384,7 @@ declare class QtiExtendedTextInteraction extends Interaction {
 }
 declare global {
     interface HTMLElementTagNameMap {
-        'qti-extended-text-interaction': QtiExtendedTextInteraction;
+        'qti-text-entry-interaction': QtiTextEntryInteraction;
     }
 }
 
@@ -460,22 +467,21 @@ declare class QtiResponseProcessing extends LitElement {
     render(): lit_html.TemplateResult<1>;
     static get observedAttributes(): string[];
     process(): void;
+    firstUpdated(_changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>): void;
     private fragmentFromString;
 }
 declare global {
     interface HTMLElementTagNameMap {
-        'qti-response-processed': QtiResponseProcessing;
+        'qti-response-processing': QtiResponseProcessing;
     }
 }
 
 declare abstract class QtiExpression<T> extends LitElement {
-    protected _result: any;
-    protected _error: any[];
-    private _debug;
-    protected set error(val: string);
+    protected result: any;
     static styles: lit.CSSResult;
     render(): lit_html.TemplateResult<1>;
     calculate(): Readonly<T>;
+    protected getResult(): Readonly<T>;
     protected get assessmentItem(): QtiAssessmentItem;
     protected getVariables: () => VariableDeclaration<number | string | (number | string)[] | null>[];
 }
@@ -516,11 +522,6 @@ declare class QtiSetOutcomeValue extends QtiRule {
 }
 
 declare class QtiResponseElse extends LitElement {
-    static get properties(): {
-        debugCalculateResult: {
-            type: ObjectConstructor;
-        };
-    };
     render(): lit_html.TemplateResult<1>;
     calculate(): boolean;
     getSubRules(): QtiRule[];
@@ -528,7 +529,6 @@ declare class QtiResponseElse extends LitElement {
 }
 
 declare class QtiResponseIf extends QtiResponseElse {
-    render(): lit_html.TemplateResult<1>;
     calculate(): boolean;
     getSubRules(): QtiRule[];
 }
@@ -538,7 +538,8 @@ declare class QtiResponseElseIf extends QtiResponseIf {
 }
 
 declare abstract class QtiConditionExpression extends QtiExpression<boolean> {
-    calculate(): boolean;
+    calculate(): Readonly<boolean>;
+    getResult(): Readonly<boolean>;
 }
 
 type Constructor<T> = new (...args: any[]) => T;
@@ -568,104 +569,102 @@ declare global {
 
 declare class QtiBaseValue extends QtiExpression<string> {
     baseType: BaseType;
-    calculate(): string;
+    getResult(): string;
 }
 
 declare class QtiContains extends QtiConditionExpression {
-    calculate(): boolean;
+    getResult(): boolean;
 }
 
 declare class QtiCorrect extends QtiExpression<string | string[]> {
     get interpretation(): string;
-    calculate(): string | string[];
+    getResult(): string | string[];
 }
 
 declare class QtiEqualRounded extends QtiExpression<boolean> {
     roundingMode: 'decimalPlaces' | 'significantFigures';
     get figures(): number;
-    calculate(): boolean;
+    getResult(): boolean;
 }
 
 declare class QtiEqual extends QtiExpression<boolean> {
     toleranceMode: 'exact' | 'relative' | 'absolute';
-    calculate(): boolean;
+    getResult(): boolean;
 }
 
 declare class QtiGt extends QtiExpression<boolean> {
-    calculate(): boolean;
+    getResult(): boolean;
 }
 
 declare class QtiGte extends QtiConditionExpression {
-    calculate(): boolean;
+    getResult(): boolean;
 }
 
 declare class QtiIsNull extends QtiExpression<boolean> {
-    calculate(): boolean;
+    getResult(): boolean;
 }
 
 declare class QtiLt extends QtiExpression<boolean> {
-    calculate(): boolean;
+    getResult(): boolean;
 }
 
 declare class QtiLte extends QtiConditionExpression {
-    calculate(): boolean;
+    getResult(): boolean;
 }
 
 declare class QtiMapResponse extends QtiExpression<number> {
     identifier: string;
-    calculate(): number;
+    getResult(): number;
 }
 
 declare class QtiMatch extends QtiExpression<boolean> {
-    calculate(): any;
+    getResult(): boolean;
     static match(valueToMap: ResponseVariable, correctValueInfo: ResponseVariable): boolean;
 }
 
 declare class QtiMember extends QtiExpression<boolean | null> {
-    calculate(): boolean;
+    getResult(): boolean;
 }
 
 declare class QtiMultiple extends QtiExpression<VariableDeclaration<string | string[]>[]> {
-    calculate(): ResponseVariable[];
+    getResult(): ResponseVariable[];
 }
 
 declare class QtiNot extends QtiExpression<boolean> {
     render(): lit_html.TemplateResult<1>;
-    calculate(): boolean;
+    getResult(): boolean;
 }
 
 declare class QtiOr extends QtiConditionExpression {
-    render(): lit_html.TemplateResult<1>;
-    calculate(): boolean;
+    getResult(): boolean;
 }
 
 declare class QtiOrdered extends QtiExpression<ResponseVariable[]> {
-    calculate(): ResponseVariable[];
+    getResult(): ResponseVariable[];
 }
 
 declare class QtPrintedVariable extends LitElement {
     identifier: string;
-    value: string | string[];
+    itemContext?: ItemContext;
     render(): lit_html.TemplateResult<1>;
-    constructor();
     calculate(): Readonly<string | string[]>;
 }
 
 declare class QtiProduct extends QtiExpression<number> {
-    calculate(): number;
+    getResult(): number;
 }
 
 declare class QtiStringMatch extends QtiExpression<boolean> {
     caseSensitive: string;
-    calculate(): boolean;
+    getResult(): boolean;
 }
 
 declare class QtiSum extends QtiExpression<number> {
-    calculate(): number;
+    getResult(): number;
 }
 
 declare class QtiVariable extends QtiExpression<string | string[]> {
-    calculate(): Readonly<string | string[]>;
+    getResult(): Readonly<string | string[]>;
 }
 
 declare class QtiPortableCustomInteraction extends LitElement {
@@ -928,19 +927,19 @@ declare class QtiAssociableHotspot extends LitElement {
     render(): lit_html.TemplateResult<1>;
 }
 
-declare class QtiGapImg extends LitElement {
+declare class QtiGap extends LitElement {
     tabindex: number | undefined;
-    connectedCallback(): void;
+    render(): lit_html.TemplateResult<1>;
 }
 
-declare class QtiGapText extends LitElement {
+declare class QtiGapImg extends LitElement {
     tabindex: number | undefined;
     connectedCallback(): void;
-    render(): lit_html.TemplateResult<1>;
 }
 
-declare class QtiGap extends LitElement {
+declare class QtiGapText extends LitElement {
     tabindex: number | undefined;
+    connectedCallback(): void;
     render(): lit_html.TemplateResult<1>;
 }
 
@@ -983,4 +982,4 @@ declare global {
     }
 }
 
-export { BaseType, Calculate, Cardinality, Interaction, InteractionChangedDetails, ItemContext, MockQtiExpression, Multiple, Ordered, OutcomeChangedDetails, OutcomeVariable, QtPrintedVariable, QtiAnd, QtiAssessmentItem, QtiAssociableHotspot, QtiAssociateInteraction, QtiBaseValue, QtiChoice, QtiChoiceInteraction, QtiCompanionMaterialsInfo, QtiConditionExpression, QtiContains, QtiCorrect, QtiEndAttemptInteraction, QtiEqual, QtiEqualRounded, QtiExpression, QtiExtendedTextInteraction, QtiFeedbackBlock, QtiFeedbackInline, QtiGap, QtiGapImg, QtiGapMatchInteraction, QtiGapText, QtiGraphicAssociateInteraction, QtiGraphicGapMatchInteraction, QtiGraphicOrderInteraction, QtiGt, QtiGte, QtiHotspotChoice, QtiHotspotInteraction, QtiHottext, QtiHottextInteraction, QtiInlineChoice, QtiInlineChoiceInteraction, QtiInteractionChanged, QtiIsNull, QtiLookupOutcomeValue, QtiLt, QtiLte, QtiMapResponse, QtiMapping, QtiMatch, QtiMatchInteraction, QtiMediaInteraction, QtiMember, QtiModalFeedback, QtiMultiple, QtiNot, QtiOr, QtiOrderInteraction, QtiOrdered, QtiOutcomeChanged, QtiOutcomeDeclaration, QtiPortableCustomInteraction, QtiPositionObjectStage, QtiProduct, QtiPrompt, QtiResponseCondition, QtiResponseDeclaration, QtiResponseElse, QtiResponseElseIf, QtiResponseIf, QtiResponseProcessing, QtiRule, QtiSPositionObjectInteraction, QtiSelectPointInteraction, QtiSetOutcomeValue, QtiSimpleAssociableChoice, QtiSimpleChoice, QtiSliderInteraction, QtiStringMatch, QtiStylesheet, QtiSum, QtiTextEntryInteraction, QtiVariable, ResponseInteraction, ResponseVariable, VariableDeclaration, directedPair, float, integer, itemContext, qtiAndMixin, qtiContentBody, qtiRubricBlock };
+export { BaseType, Calculate, Cardinality, Interaction, InteractionChangedDetails, ItemContext, MockQtiExpression, Multiple, Ordered, OutcomeChangedDetails, OutcomeVariable, QtPrintedVariable, QtiAnd, QtiAssessmentItem, QtiAssociableHotspot, QtiAssociateInteraction, QtiBaseValue, QtiChoice, QtiChoiceInteraction, QtiCompanionMaterialsInfo, QtiConditionExpression, QtiContains, QtiCorrect, QtiEndAttemptInteraction, QtiEqual, QtiEqualRounded, QtiExpression, QtiExtendedTextInteraction, QtiFeedbackBlock, QtiFeedbackInline, QtiGap, QtiGapImg, QtiGapMatchInteraction, QtiGapText, QtiGraphicAssociateInteraction, QtiGraphicGapMatchInteraction, QtiGraphicOrderInteraction, QtiGt, QtiGte, QtiHotspotChoice, QtiHotspotInteraction, QtiHottext, QtiHottextInteraction, QtiInlineChoice, QtiInlineChoiceInteraction, QtiInteractionChanged, QtiIsNull, QtiLookupOutcomeValue, QtiLt, QtiLte, QtiMapResponse, QtiMapping, QtiMatch, QtiMatchInteraction, QtiMediaInteraction, QtiMember, QtiModalFeedback, QtiMultiple, QtiNot, QtiOr, QtiOrderInteraction, QtiOrdered, QtiOutcomeChanged, QtiOutcomeDeclaration, QtiPortableCustomInteraction, QtiPositionObjectStage, QtiProduct, QtiPrompt, QtiResponseCondition, QtiResponseDeclaration, QtiResponseElse, QtiResponseElseIf, QtiResponseIf, QtiResponseProcessing, QtiRule, QtiSPositionObjectInteraction, QtiSelectPointInteraction, QtiSetOutcomeValue, QtiSimpleAssociableChoice, QtiSimpleChoice, QtiSliderInteraction, QtiStringMatch, QtiStylesheet, QtiSum, QtiTextEntryInteraction, QtiVariable, ResponseInteraction, ResponseVariable, VariableDeclaration, VariableValue, directedPair, float, integer, itemContext, qtiAndMixin, qtiContentBody, qtiRubricBlock };