@longsightgroup/qti3-player 0.2.0 → 0.3.0

package/README.md

@@ -39,6 +39,25 @@ player?.addEventListener("qti-statechange", (event) => {
 });
 ```
 
+## Player Chrome Messages
+
+The player keeps authored QTI content language separate from player chrome such as
+remove buttons. Chrome language defaults to the player `languageOfInterface` property,
+the `language-of-interface` attribute, browser language, document language, then
+English. Hosts can override it when delivery settings require a fixed interface language.
+
+Built-in catalogs are currently available for English, Spanish (`es-MX`, `es-ES`),
+Swedish (`sv-SE`), German (`de-DE`), Portuguese (`pt-BR`, `pt-PT`), and French
+(`fr-FR`, `fr-CA`).
+
+```ts
+player.languageOfInterface = "es-MX";
+player.messages = {
+  remove: () => "Eliminar",
+  removePair: ({ label }) => `Eliminar ${label}`,
+};
+```
+
 ## Portable Custom Interactions
 
 For `qti-portable-custom-interaction`, the player renders a

package/dist/icons.d.ts

@@ -0,0 +1,8 @@
+export type IconPath = string | {
+    d: string;
+    fill?: string;
+    stroke?: string;
+};
+export declare function inlineIcon(className: string, paths: IconPath[]): SVGSVGElement;
+export declare function trashIcon(): SVGSVGElement;
+//# sourceMappingURL=icons.d.ts.map

package/dist/icons.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"icons.d.ts","sourceRoot":"","sources":["../src/icons.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9E,wBAAgB,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,aAAa,CAiC9E;AAED,wBAAgB,SAAS,IAAI,aAAa,CASzC"}

package/dist/icons.js

@@ -0,0 +1,45 @@
+export function inlineIcon(className, paths) {
+    const svg = document.createElementNS("http://www.w3.org/2000/svg", "svg");
+    svg.setAttribute("xmlns", "http://www.w3.org/2000/svg");
+    svg.setAttribute("width", "24");
+    svg.setAttribute("height", "24");
+    svg.setAttribute("viewBox", "0 0 24 24");
+    svg.setAttribute("fill", "none");
+    svg.setAttribute("stroke", "currentColor");
+    svg.setAttribute("stroke-width", "2");
+    svg.setAttribute("stroke-linecap", "round");
+    svg.setAttribute("stroke-linejoin", "round");
+    svg.setAttribute("aria-hidden", "true");
+    svg.setAttribute("focusable", "false");
+    svg.setAttribute("class", className);
+    for (const entry of paths) {
+        const path = document.createElementNS("http://www.w3.org/2000/svg", "path");
+        if (typeof entry === "string") {
+            path.setAttribute("d", entry);
+        }
+        else {
+            path.setAttribute("d", entry.d);
+            if (entry.stroke) {
+                path.setAttribute("stroke", entry.stroke);
+                path.style.stroke = entry.stroke;
+            }
+            if (entry.fill) {
+                path.setAttribute("fill", entry.fill);
+                path.style.fill = entry.fill;
+            }
+        }
+        svg.append(path);
+    }
+    return svg;
+}
+export function trashIcon() {
+    return inlineIcon("qti3-trash-icon", [
+        { d: "M0 0h24v24H0z", stroke: "none", fill: "none" },
+        "M4 7l16 0",
+        "M10 11l0 6",
+        "M14 11l0 6",
+        "M5 7l1 12a2 2 0 0 0 2 2h8a2 2 0 0 0 2 -2l1 -12",
+        "M9 7v-3a1 1 0 0 1 1 -1h4a1 1 0 0 1 1 1v3",
+    ]);
+}
+//# sourceMappingURL=icons.js.map

package/dist/icons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"icons.js","sourceRoot":"","sources":["../src/icons.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,UAAU,CAAC,SAAiB,EAAE,KAAiB;IAC7D,MAAM,GAAG,GAAG,QAAQ,CAAC,eAAe,CAAC,4BAA4B,EAAE,KAAK,CAAC,CAAC;IAC1E,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAC;IACxD,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAChC,GAAG,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACjC,GAAG,CAAC,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACzC,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,GAAG,CAAC,YAAY,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;IAC3C,GAAG,CAAC,YAAY,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;IACtC,GAAG,CAAC,YAAY,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IAC5C,GAAG,CAAC,YAAY,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;IAC7C,GAAG,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;IACxC,GAAG,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IACvC,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAErC,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,QAAQ,CAAC,eAAe,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;QAC5E,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAChC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;YAChC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;gBACjB,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;gBAC1C,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;YACnC,CAAC;YACD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;gBACf,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBACtC,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;YAC/B,CAAC;QACH,CAAC;QACD,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,SAAS;IACvB,OAAO,UAAU,CAAC,iBAAiB,EAAE;QACnC,EAAE,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE;QACpD,WAAW;QACX,YAAY;QACZ,YAAY;QACZ,gDAAgD;QAChD,0CAA0C;KAC3C,CAAC,CAAC;AACL,CAAC"}

package/dist/index.d.ts

@@ -1,115 +1,4 @@
-import { type QtiAssessmentItem, type QtiAttemptStatus, type QtiAttemptStateV1, type QtiDiagnostic, type QtiInteraction, type QtiPortableCustomDefinition, type QtiPortableCustomStateValue, type QtiScoreResult, type QtiCatalogSupportResolution, type QtiCatalogSupportResolutionOptions, type QtiTextToSpeechTraversal, type QtiValue } from "@longsightgroup/qti3-core";
-export interface QtiPlayerSessionControl {
-    validateResponses?: boolean | undefined;
-    showFeedback?: boolean | undefined;
-}
-export interface QtiScoreAttemptOptions {
-    validateResponses?: boolean | undefined;
-}
-export type QtiPlayerFetchXml = (url: string) => Promise<string>;
-export type QtiPlayerResolveAsset = (url: string) => string;
-export interface QtiPlayerLoadOptions {
-    state?: QtiAttemptStateV1 | undefined;
-    status?: QtiAttemptStatus | undefined;
-    sessionControl?: QtiPlayerSessionControl | undefined;
-    fetchXml?: QtiPlayerFetchXml | undefined;
-    resolveAsset?: QtiPlayerResolveAsset | undefined;
-}
-export interface QtiReadyEventDetail {
-    item: QtiAssessmentItem;
-}
-export interface QtiStateChangeEventDetail {
-    state: QtiAttemptStateV1;
-}
-export interface QtiResponseChangeEventDetail {
-    responseIdentifier: string;
-    value: QtiValue;
-}
-export interface QtiPortableCustomMountEventDetail {
-    responseIdentifier: string;
-    interaction: QtiInteraction;
-    definition: QtiPortableCustomDefinition;
-    host: HTMLElement;
-    value: QtiValue;
-    state?: QtiPortableCustomStateValue | undefined;
-}
-export type QtiScoreEventDetail = QtiScoreResult;
-export interface QtiValidationEventDetail {
-    validationMessages: QtiDiagnostic[];
-    state: QtiAttemptStateV1;
-}
-export interface QtiSuspendEventDetail {
-    state: QtiAttemptStateV1;
-}
-export interface QtiEndAttemptEventDetail {
-    state: QtiAttemptStateV1;
-}
-export interface QtiAssessmentItemPlayerEventDetailMap {
-    "qti-ready": QtiReadyEventDetail;
-    "qti-statechange": QtiStateChangeEventDetail;
-    "qti-responsechange": QtiResponseChangeEventDetail;
-    "qti-portable-custom-mount": QtiPortableCustomMountEventDetail;
-    "qti-score": QtiScoreEventDetail;
-    "qti-validation": QtiValidationEventDetail;
-    "qti-suspend": QtiSuspendEventDetail;
-    "qti-endattempt": QtiEndAttemptEventDetail;
-}
-export type QtiAssessmentItemPlayerEventName = keyof QtiAssessmentItemPlayerEventDetailMap;
-export type QtiAssessmentItemPlayerEvent<T extends QtiAssessmentItemPlayerEventName = QtiAssessmentItemPlayerEventName> = CustomEvent<QtiAssessmentItemPlayerEventDetailMap[T]>;
-export type QtiAssessmentItemPlayerCustomEventMap = {
-    [T in QtiAssessmentItemPlayerEventName]: CustomEvent<QtiAssessmentItemPlayerEventDetailMap[T]>;
-};
-declare const HTMLElementBase: typeof HTMLElement;
-export declare class QtiAssessmentItemPlayer extends HTMLElementBase {
-    private documentModel?;
-    private session?;
-    private resolveAsset;
-    private validationMessages;
-    private sessionControl;
-    loadXml(xml: string, options?: QtiPlayerLoadOptions): Promise<void>;
-    loadUrl(url: string, options?: QtiPlayerLoadOptions): Promise<void>;
-    scoreAttempt(options?: QtiScoreAttemptOptions): QtiScoreResult | undefined;
-    reset(): void;
-    restore(state: QtiAttemptStateV1): void;
-    suspend(): void;
-    endAttempt(options?: QtiScoreAttemptOptions): void;
-    serialize(): QtiAttemptStateV1 | undefined;
-    getTextToSpeechTraversal(): QtiTextToSpeechTraversal | undefined;
-    getCatalogSupportResolution(options?: QtiCatalogSupportResolutionOptions): QtiCatalogSupportResolution | undefined;
-    private emitStateChange;
-    private dispatchPlayerEvent;
-    private render;
-    private renderInteraction;
-    private renderPortableCustomResponse;
-    private renderEmbeddedInteraction;
-    private renderContentNodes;
-    private renderContentNode;
-    private renderTemplateContent;
-    private renderPrintedVariable;
-    private renderFeedbackContent;
-    private updateDynamicBodyState;
-    private updateAttemptAvailability;
-    private attemptIsCompleted;
-    private isFeedbackVisible;
-    private isTemplateContentVisible;
-    private currentVariableValue;
-    private currentTemplateValue;
-    private mathTemplateValue;
-    private currentResponseValue;
-    private currentInteractionState;
-    private setPortableCustomValidity;
-    private applyDefaultStyles;
-    private resolveRenderedAssets;
-    private validateResponses;
-    private renderValidationMessages;
-    private clearValidationMessage;
-    private renderFeedback;
-}
-export declare function defineQtiAssessmentItemPlayer(): void;
-declare global {
-    interface HTMLElementTagNameMap {
-        "qti-assessment-item-player": QtiAssessmentItemPlayer;
-    }
-}
-export {};
+export type { QtiPlayerAssociationPairLabelParams, QtiPlayerMessages, QtiPlayerRemoveMessageParams, } from "./player-messages.js";
+export type { QtiAssessmentItemPlayerCustomEventMap, QtiAssessmentItemPlayerEvent, QtiAssessmentItemPlayerEventDetailMap, QtiAssessmentItemPlayerEventName, QtiEndAttemptEventDetail, QtiPlayerFetchXml, QtiPlayerLoadOptions, QtiPlayerMessageOverrides, QtiPlayerResolveAsset, QtiPlayerSessionControl, QtiPortableCustomMountEventDetail, QtiReadyEventDetail, QtiResponseChangeEventDetail, QtiScoreAttemptOptions, QtiScoreEventDetail, QtiStateChangeEventDetail, QtiSuspendEventDetail, QtiValidationEventDetail, } from "./player-types.js";
+export { QtiAssessmentItemPlayer, defineQtiAssessmentItemPlayer } from "./player-element.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EAGtB,KAAK,aAAa,EAElB,KAAK,cAAc,EAGnB,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,EAChC,KAAK,cAAc,EACnB,KAAK,2BAA2B,EAChC,KAAK,kCAAkC,EACvC,KAAK,wBAAwB,EAC7B,KAAK,QAAQ,EACd,MAAM,2BAA2B,CAAC;AAEnC,MAAM,WAAW,uBAAuB;IACtC,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACpC;AAED,MAAM,WAAW,sBAAsB;IACrC,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACzC;AAED,MAAM,MAAM,iBAAiB,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AACjE,MAAM,MAAM,qBAAqB,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;AAE5D,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IACtC,MAAM,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IACtC,cAAc,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAC;IACrD,QAAQ,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IACzC,YAAY,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;CAClD;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,iBAAiB,CAAC;CACzB;AAED,MAAM,WAAW,yBAAyB;IACxC,KAAK,EAAE,iBAAiB,CAAC;CAC1B;AAED,MAAM,WAAW,4BAA4B;IAC3C,kBAAkB,EAAE,MAAM,CAAC;IAC3B,KAAK,EAAE,QAAQ,CAAC;CACjB;AAED,MAAM,WAAW,iCAAiC;IAChD,kBAAkB,EAAE,MAAM,CAAC;IAC3B,WAAW,EAAE,cAAc,CAAC;IAC5B,UAAU,EAAE,2BAA2B,CAAC;IACxC,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,EAAE,QAAQ,CAAC;IAChB,KAAK,CAAC,EAAE,2BAA2B,GAAG,SAAS,CAAC;CACjD;AAED,MAAM,MAAM,mBAAmB,GAAG,cAAc,CAAC;AAEjD,MAAM,WAAW,wBAAwB;IACvC,kBAAkB,EAAE,aAAa,EAAE,CAAC;IACpC,KAAK,EAAE,iBAAiB,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,iBAAiB,CAAC;CAC1B;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,iBAAiB,CAAC;CAC1B;AAED,MAAM,WAAW,qCAAqC;IACpD,WAAW,EAAE,mBAAmB,CAAC;IACjC,iBAAiB,EAAE,yBAAyB,CAAC;IAC7C,oBAAoB,EAAE,4BAA4B,CAAC;IACnD,2BAA2B,EAAE,iCAAiC,CAAC;IAC/D,WAAW,EAAE,mBAAmB,CAAC;IACjC,gBAAgB,EAAE,wBAAwB,CAAC;IAC3C,aAAa,EAAE,qBAAqB,CAAC;IACrC,gBAAgB,EAAE,wBAAwB,CAAC;CAC5C;AAED,MAAM,MAAM,gCAAgC,GAAG,MAAM,qCAAqC,CAAC;AAE3F,MAAM,MAAM,4BAA4B,CACtC,CAAC,SAAS,gCAAgC,GAAG,gCAAgC,IAC3E,WAAW,CAAC,qCAAqC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE1D,MAAM,MAAM,qCAAqC,GAAG;KACjD,CAAC,IAAI,gCAAgC,GAAG,WAAW,CAAC,qCAAqC,CAAC,CAAC,CAAC,CAAC;CAC/F,CAAC;AAEF,QAAA,MAAM,eAAe,EAAE,OAAO,WAOO,CAAC;AAEtC,qBAAa,uBAAwB,SAAQ,eAAe;IAC1D,OAAO,CAAC,aAAa,CAAC,CAAc;IACpC,OAAO,CAAC,OAAO,CAAC,CAAiB;IACjC,OAAO,CAAC,YAAY,CAAoC;IACxD,OAAO,CAAC,kBAAkB,CAAuB;IACjD,OAAO,CAAC,cAAc,CAGpB;IAEI,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BvE,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAK7E,YAAY,CAAC,OAAO,GAAE,sBAA2B,GAAG,cAAc,GAAG,SAAS;IA6B9E,KAAK,IAAI,IAAI;IAUb,OAAO,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAmBvC,OAAO,IAAI,IAAI;IASf,UAAU,CAAC,OAAO,GAAE,sBAA2B,GAAG,IAAI;IAgBtD,SAAS,IAAI,iBAAiB,GAAG,SAAS;IAM1C,wBAAwB,IAAI,wBAAwB,GAAG,SAAS;IAKhE,2BAA2B,CACzB,OAAO,GAAE,kCAAuC,GAC/C,2BAA2B,GAAG,SAAS;IAK1C,OAAO,CAAC,eAAe;IAKvB,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,MAAM;IA0Cd,OAAO,CAAC,iBAAiB;IAoJzB,OAAO,CAAC,4BAA4B;IA6FpC,OAAO,CAAC,yBAAyB;IAiCjC,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,iBAAiB;IA0CzB,OAAO,CAAC,qBAAqB;IAc7B,OAAO,CAAC,qBAAqB;IAU7B,OAAO,CAAC,qBAAqB;IAW7B,OAAO,CAAC,sBAAsB;IA+B9B,OAAO,CAAC,yBAAyB;IAgCjC,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,iBAAiB;IAQzB,OAAO,CAAC,wBAAwB;IAWhC,OAAO,CAAC,oBAAoB;IAU5B,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,iBAAiB;IAezB,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,uBAAuB;IAI/B,OAAO,CAAC,yBAAyB;IAsBjC,OAAO,CAAC,kBAAkB;IAM1B,OAAO,CAAC,qBAAqB;IAW7B,OAAO,CAAC,iBAAiB;IAyDzB,OAAO,CAAC,wBAAwB;IAgChC,OAAO,CAAC,sBAAsB;IAQ9B,OAAO,CAAC,cAAc;CAgBvB;AAED,wBAAgB,6BAA6B,IAAI,IAAI,CAIpD;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,4BAA4B,EAAE,uBAAuB,CAAC;KACvD;CACF"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,mCAAmC,EACnC,iBAAiB,EACjB,4BAA4B,GAC7B,MAAM,sBAAsB,CAAC;AAC9B,YAAY,EACV,qCAAqC,EACrC,4BAA4B,EAC5B,qCAAqC,EACrC,gCAAgC,EAChC,wBAAwB,EACxB,iBAAiB,EACjB,oBAAoB,EACpB,yBAAyB,EACzB,qBAAqB,EACrB,uBAAuB,EACvB,iCAAiC,EACjC,mBAAmB,EACnB,4BAA4B,EAC5B,sBAAsB,EACtB,mBAAmB,EACnB,yBAAyB,EACzB,qBAAqB,EACrB,wBAAwB,GACzB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,uBAAuB,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAC"}