@citolab/qti-components 6.0.34 → 6.1.0

package/dist/index.d.cts

@@ -26,7 +26,7 @@ type Cardinality = 'multiple' | 'ordered' | 'single';
 interface OutcomeChangedDetails {
     item: string;
     outcomeIdentifier: string;
-    value: string | string[];
+    value: Readonly<string | string[]>;
 }
 type InteractionChangedDetails = ResponseInteraction & {
     item: string;
@@ -76,27 +76,15 @@ interface VariableDeclaration<T> {
     identifier: string;
     cardinality: Cardinality;
     baseType: BaseType;
-    value: T;
-}
-interface ResultVariable {
-    cardinality: Cardinality;
-    baseType: BaseType;
-    result: number | boolean | string | (number | boolean | string)[];
+    value: Readonly<T>;
+    type: 'outcome' | 'response';
 }
-declare class OutcomeVariable implements VariableDeclaration<string | string[] | null> {
-    identifier: string;
-    cardinality: Cardinality;
-    baseType: BaseType;
-    value: string | string[] | null;
+interface OutcomeVariable extends VariableDeclaration<string | string[] | null> {
 }
-declare class ResponseVariable implements VariableDeclaration<string | string[] | null> {
-    identifier: string;
-    cardinality: Cardinality;
-    baseType: BaseType;
-    value: string | string[] | null;
-    candidateResponse: string | string[] | null;
-    mapping: QtiMapping;
-    correctResponse: string | string[] | null;
+interface ResponseVariable extends VariableDeclaration<string | string[] | null> {
+    candidateResponse?: string | string[] | null;
+    mapping?: QtiMapping;
+    correctResponse?: string | string[] | null;
 }
 
 type QtiRegisterVariable = CustomEvent<{
@@ -209,6 +197,15 @@ declare const Events: {
     ON_CHOICE_ELEMENT_SELECTED: string;
 };
 
+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
@@ -226,35 +223,37 @@ declare const Events: {
  *
  */
 declare class QtiAssessmentItem extends LitElement {
-    variables: VariableDeclaration<string | string[]>[];
-    private feedbackElements;
-    private interactionElements;
-    disabled: boolean;
-    readonly: boolean;
     title: string;
-    identifier: string;
-    private _numAttempts;
-    render(): lit_html.TemplateResult<1>;
+    identifier: string | undefined;
+    adaptive: 'true' | 'false';
+    timeDependent: 'true' | 'false';
+    disabled: boolean;
     _handleDisabledChange: (_: boolean, disabled: boolean) => void;
+    readonly: boolean;
     _handleReadonlyChange: (_: boolean, readonly: boolean) => void;
-    constructor();
+    private _context;
+    get context(): ItemContext;
+    set variables(value: VariableDeclaration<string | string[] | null>[]);
+    private _initialContext;
+    private _feedbackElements;
+    private _interactionElements;
     firstUpdated(val: any): void;
     disconnectedCallback(): void;
-    private _registerVariable;
-    showCorrectResponse(): void;
-    processResponse(): boolean;
+    /** @deprecated use context property instead */
     set responses(myResponses: ResponseInteraction[]);
-    resetInteractions(): void;
-    validateResponses(): boolean;
-    getVariable(identifier: string): VariableDeclaration<string | string[] | undefined>;
-    getResponse(identifier: string): ResponseVariable | null;
-    getOutcome(identifier: string): OutcomeVariable | null;
-    private registerFeedbackElement;
-    private registerInteractionElement;
-    private interactionResponse;
-    private outcomeChanged;
-    private showFeedback;
-    setOutcomeValue(identifier: string, value: string): void;
+    render(): lit_html.TemplateResult<1>;
+    constructor();
+    showCorrectResponse(): void;
+    processResponse(countNumAttempts?: boolean): boolean;
+    resetResponses(): void;
+    getResponse(identifier: string): Readonly<ResponseVariable>;
+    getOutcome(identifier: string): Readonly<OutcomeVariable>;
+    getVariable(identifier: string): Readonly<VariableDeclaration<string | string[] | null>>;
+    private handleUpdateResponseVariable;
+    updateResponseVariable(identifier: string, value: string | string[] | undefined): void;
+    updateOutcomeVariable(identifier: string, value: string | string[] | undefined): void;
+    private _getCompletionStatus;
+    private _emit;
 }
 declare global {
     interface HTMLElementTagNameMap {
@@ -353,7 +352,7 @@ declare class QtiOutcomeDeclaration extends QtiVariableDeclaration {
 declare class QtiCompanionMaterialsInfo extends LitElement {
 }
 
-interface Audience {
+interface AudienceContext {
     view: 'author' | 'candidate' | 'proctor' | 'scorer' | 'testConstructor' | 'tutor';
 }
 
@@ -365,7 +364,7 @@ declare class qtiRubricBlock extends LitElement {
     handleclassNamesChange(old: any, disabled: boolean): void;
     static styles: lit.CSSResult;
     logger: ContextConsumer<{
-        __context__: Audience;
+        __context__: AudienceContext;
     }, this>;
     render(): lit_html.TemplateResult<1>;
     connectedCallback(): void;
@@ -377,10 +376,9 @@ declare class qtiContentBody extends LitElement {
 
 declare abstract class QtiFeedback extends LitElement {
     protected showHide: string;
-    protected outcomeIdentifier: string;
+    outcomeIdentifier: string;
     protected identifier: string;
     protected showStatus: string;
-    constructor();
     connectedCallback(): void;
     checkShowFeedback(outcomeIdentifier: string): void;
     private showFeedback;
@@ -408,9 +406,8 @@ declare abstract class Interaction extends LitElement {
     disabled: boolean;
     /** readonly should be exposed to the attributes and accessible as property */
     readonly: boolean;
-    abstract reset(): void;
     abstract validate(): boolean;
-    abstract set response(val: string | string[]);
+    abstract set response(val: Readonly<string | string[]>);
     connectedCallback(): void;
     saveResponse(value: string | string[]): void;
 }
@@ -472,9 +469,8 @@ declare abstract class Choices extends Interaction {
     _handleReadonlyChange: (_: boolean, readonly: boolean) => void;
     _handleMaxChoicesChange: () => void;
     constructor();
-    reset(): void;
     validate(): boolean;
-    set response(myResponse: ResponseType);
+    set response(responseValue: string | string[]);
     connectedCallback(): void;
     disconnectedCallback(): void;
     private _registerChoiceElement;
@@ -595,7 +591,7 @@ declare abstract class QtiExpression<T> extends LitElement {
     protected set error(val: string);
     static styles: lit.CSSResult;
     render(): lit_html.TemplateResult<1>;
-    calculate(): T;
+    calculate(): Readonly<T>;
     protected get assessmentItem(): QtiAssessmentItem;
     protected getVariables: () => VariableDeclaration<number | string | (number | string)[] | null>[];
 }
@@ -690,7 +686,7 @@ declare class QtPrintedVariable extends LitElement {
     value: string | string[];
     render(): lit_html.TemplateResult<1>;
     constructor();
-    calculate(): string | string[];
+    calculate(): Readonly<string | string[]>;
 }
 
 declare class QtiProduct extends QtiExpression<number> {
@@ -698,7 +694,7 @@ declare class QtiProduct extends QtiExpression<number> {
 }
 
 declare class QtiVariable extends QtiExpression<string | string[]> {
-    calculate(): string | string[];
+    calculate(): Readonly<string | string[]>;
 }
 
 declare class QtiStringMatch extends QtiExpression<boolean> {
@@ -955,8 +951,11 @@ declare class QtiSliderInteraction extends Interaction {
     private getPositionFromEvent;
 }
 
-declare class QtiEndAttemptInteraction extends LitElement {
+declare class QtiEndAttemptInteraction extends Interaction {
+    countAttempt: string;
     title: 'end attempt';
+    validate(): boolean;
+    set response(val: undefined);
     render(): lit_html.TemplateResult<1>;
     endAttempt(e: Event): void;
 }
@@ -1022,16 +1021,35 @@ declare global {
     }
 }
 
+/**
+ * https://www.imsglobal.org/spec/qti/v3p0/impl#h.fi29q8dubjgw
+ * <qti-custom-operator class="js.org">
+        <qti-base-value base-type="string"><![CDATA[
+          console.log(context.variables);
+          return 'B'
+          document.querySelector('qti-end-attempt-interaction').disabled = true;
+          ]]></qti-base-value>
+      </qti-custom-operator>
+    </qti-set-outcome-value>
+ */
+declare class QtiCustomOperator extends LitElement implements Calculate {
+    private operatorFunction;
+    context?: ItemContext;
+    render(): lit_html.TemplateResult<1>;
+    handleSlotChange(event: Event): void;
+    calculate(): any;
+}
+
 declare class QtiItem extends LitElement {
     itemLocation: string;
-    set audienceContext(context: {
-        view: 'author' | 'candidate' | 'proctor' | 'scorer' | 'testConstructor' | 'tutor';
-    });
-    private provider;
-    private _xml;
+    disabled: boolean;
+    update(changedProperties: Map<string | number | symbol, unknown>): void;
+    protected _xml: string;
     set xml(val: string);
-    get xml(): string;
-    static styles: lit.CSSResult;
+    set css(val: string);
+    get assessmentItem(): QtiAssessmentItem | null;
+    audienceContext: AudienceContext;
+    constructor();
     connectedCallback(): void;
     render: () => lit_html.TemplateResult<1>;
 }
@@ -1039,6 +1057,7 @@ declare class QtiItem extends LitElement {
 declare const qtiTransform: (xmlValue: string) => {
     mathml(): any;
     removeNamesSpaces(): any;
+    cDataToComment(): any;
     pciHooks(uri: string): any;
     assetsLocation(uri: string, attributes?: string[]): any;
     customTypes(): any;
@@ -1051,4 +1070,116 @@ declare const qtiTransform: (xmlValue: string) => {
     xml(): string;
 };
 
-export { BaseType, Calculate, Cardinality, Events, Interaction, InteractionChangedDetails, Multiple, Ordered, OutcomeChangedDetails, OutcomeVariable, QtPrintedVariable, QtiAnd, QtiAssessmentItem, QtiAssociableHotspot, QtiAssociateInteraction, QtiBaseValue, QtiChoice, qtiChoiceElementSelected as QtiChoiceElementSelected, 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 as QtiInteractionChanged, qtiInteractionResponse as QtiInteractionResponse, QtiIsNull, QtiItem, qtiLooseChoice as QtiLooseChoice, QtiLt, QtiLte, QtiMapResponse, QtiMapping, QtiMatch, QtiMatchInteraction, QtiMediaInteraction, QtiMember, QtiModalFeedback, QtiMultiple, QtiNot, QtiOr, QtiOrderInteraction, QtiOrdered, qtiOutcomeChanged as QtiOutcomeChanged, QtiOutcomeDeclaration, QtiPortableCustomInteraction, QtiPositionObjectStage, QtiProduct, QtiPrompt, qtiRegisterChoice as QtiRegisterChoice, qtiRegisterHotspot as QtiRegisterHotspot, qtiRegisterInteraction as QtiRegisterInteraction, qtiRegisterVariable as QtiRegisterVariable, QtiResponseCondition, QtiResponseDeclaration, QtiResponseElse, QtiResponseElseIf, QtiResponseIf, QtiResponseProcessing, QtiRule, QtiSPositionObjectInteraction, QtiSelectPointInteraction, QtiSetOutcomeValue, QtiSimpleAssociableChoice, QtiSimpleChoice, QtiSliderInteraction, QtiStringMatch, QtiStylesheet, QtiSum, QtiTextEntryInteraction, QtiVariable, ResponseInteraction, ResponseVariable, ResultVariable, VariableDeclaration, directedPair, float, integer, qtiContentBody, qtiRubricBlock, qtiTransform };
+declare class QtiAssessmentItemRef extends QtiItem {
+    identifier: string;
+    href: string;
+    connectedCallback(): void;
+}
+
+interface ItemInfo {
+    href: string;
+}
+interface TestContext {
+    itemIndex: number | null;
+    items: (ItemContext & ItemInfo)[];
+}
+
+declare class QtiAssessmentTest extends LitElement {
+    context: TestContext;
+    itemRefEls: Map<string, QtiAssessmentItemRef>;
+    private copyItemVariables;
+    getAssessmentItem(identifier: string): QtiAssessmentItem;
+    private onItemRefRegistered;
+    private onTestRequestItem;
+    firstUpdated(a: any): void;
+    constructor();
+    private itemConnected;
+    private _requestItem;
+    render(): lit_html.TemplateResult<1>;
+}
+
+declare class QtiTestPart extends LitElement {
+    private _navigationMode;
+    render(): lit_html.TemplateResult<1>;
+}
+
+declare class QtiTest extends LitElement {
+    private _navigationMode;
+    private assessmentTestURI;
+    loadedItems: any[];
+    itemRefEls: {
+        current: Map<string, QtiAssessmentItemRef>;
+    };
+    controller: AbortController;
+    requestItem(identifier: string): void;
+    render(): lit_html.TemplateResult<1>;
+}
+
+declare class TestNext extends LitElement {
+    _testContext?: TestContext;
+    _requestItem(index: any): void;
+    render(): lit_html.TemplateResult<1>;
+}
+
+declare class TestPrev extends LitElement {
+    _testContext?: TestContext;
+    _requestItem(index: any): void;
+    render(): lit_html.TemplateResult<1>;
+}
+
+declare class QtiTestProgress extends LitElement {
+    _testProvider?: TestContext;
+    render(): lit_html.TemplateResult<1>;
+}
+
+declare class QtiTestSlider extends LitElement {
+    _testProvider?: TestContext;
+    _requestItem(index: any): void;
+    render(): lit_html.TemplateResult<1>;
+}
+
+declare class QtiTestPagingRadio extends LitElement {
+    _testProvider?: TestContext;
+    protected createRenderRoot(): Element | ShadowRoot;
+    _requestItem(index: any): void;
+    render(): lit_html.TemplateResult<1>;
+}
+
+declare class QtiTestPagingButtons extends LitElement {
+    _testProvider?: TestContext;
+    protected createRenderRoot(): Element | ShadowRoot;
+    _requestItem(index: any): void;
+    render(): lit_html.TemplateResult<1>;
+}
+
+declare class QtiTestShowCorrect extends LitElement {
+    _testProvider?: TestContext;
+    render(): lit_html.TemplateResult<1>;
+}
+
+declare class TestScript extends LitElement {
+    private operatorFunction;
+    private _context;
+    private _printed;
+    render(): lit_html.TemplateResult<1>;
+    handleSlotChange(event: Event): void;
+}
+
+declare class TestShowIndex extends LitElement {
+    _testContext?: TestContext;
+    _requestItem(index: any): void;
+    render(): lit_html.TemplateResult<1>;
+}
+
+declare class QtiPrintVariables extends LitElement {
+    _testProvider?: TestContext;
+    render(): lit_html.TemplateResult<1>;
+}
+
+declare class QtiTestPrintScore extends LitElement {
+    _testContext?: TestContext;
+    _requestItem(index: any): void;
+    render(): lit_html.TemplateResult<1>;
+}
+
+export { BaseType, Calculate, Cardinality, Events, Interaction, InteractionChangedDetails, ItemContext, Multiple, Ordered, OutcomeChangedDetails, OutcomeVariable, QtPrintedVariable, QtiAnd, QtiAssessmentItem, QtiAssessmentItemRef, QtiAssessmentTest, QtiAssociableHotspot, QtiAssociateInteraction, QtiBaseValue, QtiChoice, qtiChoiceElementSelected as QtiChoiceElementSelected, QtiChoiceInteraction, QtiCompanionMaterialsInfo, QtiConditionExpression, QtiContains, QtiCorrect, QtiCustomOperator, QtiEndAttemptInteraction, QtiEqual, QtiEqualRounded, QtiExpression, QtiExtendedTextInteraction, QtiFeedbackBlock, QtiFeedbackInline, QtiGap, QtiGapImg, QtiGapMatchInteraction, QtiGapText, QtiGraphicAssociateInteraction, QtiGraphicGapMatchInteraction, QtiGraphicOrderInteraction, QtiGt, QtiGte, QtiHotspotChoice, QtiHotspotInteraction, QtiHottext, QtiHottextInteraction, QtiInlineChoice, QtiInlineChoiceInteraction, qtiInteractionChanged as QtiInteractionChanged, qtiInteractionResponse as QtiInteractionResponse, QtiIsNull, QtiItem, qtiLooseChoice as QtiLooseChoice, QtiLt, QtiLte, QtiMapResponse, QtiMapping, QtiMatch, QtiMatchInteraction, QtiMediaInteraction, QtiMember, QtiModalFeedback, QtiMultiple, QtiNot, QtiOr, QtiOrderInteraction, QtiOrdered, qtiOutcomeChanged as QtiOutcomeChanged, QtiOutcomeDeclaration, QtiPortableCustomInteraction, QtiPositionObjectStage, QtiPrintVariables, QtiProduct, QtiPrompt, qtiRegisterChoice as QtiRegisterChoice, qtiRegisterHotspot as QtiRegisterHotspot, qtiRegisterInteraction as QtiRegisterInteraction, qtiRegisterVariable as QtiRegisterVariable, QtiResponseCondition, QtiResponseDeclaration, QtiResponseElse, QtiResponseElseIf, QtiResponseIf, QtiResponseProcessing, QtiRule, QtiSPositionObjectInteraction, QtiSelectPointInteraction, QtiSetOutcomeValue, QtiSimpleAssociableChoice, QtiSimpleChoice, QtiSliderInteraction, QtiStringMatch, QtiStylesheet, QtiSum, QtiTest, QtiTestPagingButtons, QtiTestPagingRadio, QtiTestPart, QtiTestPrintScore, QtiTestProgress, QtiTestShowCorrect, QtiTestSlider, QtiTextEntryInteraction, QtiVariable, ResponseInteraction, ResponseVariable, TestNext, TestPrev, TestScript, TestShowIndex, VariableDeclaration, directedPair, float, integer, itemContext, qtiContentBody, qtiRubricBlock, qtiTransform };