@pie-players/pie-default-tool-loaders 1.0.0-beta.7 → 1.0.0-beta.9

package/dist/index.d.ts

@@ -3,10 +3,11 @@ export { createEmptyPersonalNeedsProfile, createPackagedToolRegistry, createUniv
 export { type AfaFeatureSet, type AfaPnpRecord, type AfaSpoken, type AfaZoomAmount, createPersonalNeedsProfileFromAfa, } from "./afa-profile.js";
 export { CONTENT_ALTERNATE_REGISTRATIONS } from "./content-alternates.js";
 export { annotationToolbarRegistration, lineReaderToolRegistration, magnificationToolRegistration, themeToolRegistration, } from "./registrations/accessibility-tools.js";
-export { AUDIO_TRANSCRIPT_FEATURE_ID, AUDIO_TRANSCRIPT_REGION_CLASS, AUDIO_TRANSCRIPT_REGION_LABEL, audioTranscriptRegistration, CONTENT_LEAD_SURFACE, resolveAudioTranscript, type ResolvedAudioTranscript, } from "./registrations/audio-transcript.js";
+export { AUDIO_TRANSCRIPT_FEATURE_ID, AUDIO_TRANSCRIPT_REGION_CLASS, AUDIO_TRANSCRIPT_REGION_LABEL, audioTranscriptRegistration, resolveAudioTranscript, type ResolvedAudioTranscript, } from "./registrations/audio-transcript.js";
+export { CONTENT_LEAD_SURFACE } from "@pie-players/pie-assessment-toolkit/tools/registration";
 export { type CalculatorProviderDefinition, type CalculatorRegistrationOptions, calculatorToolRegistration, createCalculatorToolRegistration, } from "./registrations/calculator.js";
 export { createDictionaryToolRegistration, createPictureDictionaryToolRegistration, dictionaryToolRegistration, type DictionaryVariantOptions, pictureDictionaryToolRegistration, spanishDictionaryToolRegistration, spanishPictureDictionaryToolRegistration, } from "./registrations/dictionary-tools.js";
-export { answerEliminatorToolRegistration } from "./registrations/interaction-tools.js";
+export { type AnswerEliminatorToolConfig, answerEliminatorToolRegistration, } from "./registrations/interaction-tools.js";
 export { protractorToolRegistration, rulerToolRegistration, } from "./registrations/measurement-tools.js";
 export { graphToolRegistration, periodicTableToolRegistration, } from "./registrations/subject-specific-tools.js";
 export { ttsToolRegistration } from "./registrations/tts.js";

package/dist/index.js

@@ -7,10 +7,13 @@ export { CONTENT_ALTERNATE_REGISTRATIONS } from "./content-alternates.js";
 // Individual registrations, for a host composing a subset rather than the whole
 // packaged set.
 export { annotationToolbarRegistration, lineReaderToolRegistration, magnificationToolRegistration, themeToolRegistration, } from "./registrations/accessibility-tools.js";
-export { AUDIO_TRANSCRIPT_FEATURE_ID, AUDIO_TRANSCRIPT_REGION_CLASS, AUDIO_TRANSCRIPT_REGION_LABEL, audioTranscriptRegistration, CONTENT_LEAD_SURFACE, resolveAudioTranscript, } from "./registrations/audio-transcript.js";
+export { AUDIO_TRANSCRIPT_FEATURE_ID, AUDIO_TRANSCRIPT_REGION_CLASS, AUDIO_TRANSCRIPT_REGION_LABEL, audioTranscriptRegistration, resolveAudioTranscript, } from "./registrations/audio-transcript.js";
+// The canonical surface ids live in the toolkit; re-exported so the packaged
+// set's surface stays unchanged.
+export { CONTENT_LEAD_SURFACE } from "@pie-players/pie-assessment-toolkit/tools/registration";
 export { calculatorToolRegistration, createCalculatorToolRegistration, } from "./registrations/calculator.js";
 export { createDictionaryToolRegistration, createPictureDictionaryToolRegistration, dictionaryToolRegistration, pictureDictionaryToolRegistration, spanishDictionaryToolRegistration, spanishPictureDictionaryToolRegistration, } from "./registrations/dictionary-tools.js";
-export { answerEliminatorToolRegistration } from "./registrations/interaction-tools.js";
+export { answerEliminatorToolRegistration, } from "./registrations/interaction-tools.js";
 export { protractorToolRegistration, rulerToolRegistration, } from "./registrations/measurement-tools.js";
 export { graphToolRegistration, periodicTableToolRegistration, } from "./registrations/subject-specific-tools.js";
 export { ttsToolRegistration } from "./registrations/tts.js";

package/dist/registrations/audio-transcript.d.ts

@@ -66,11 +66,4 @@ export interface ResolvedAudioTranscript {
  * transcript is in the language of the audio it transcribes, one per prompt.
  */
 export declare function resolveAudioTranscript(context: ToolContentDependencyContext): ResolvedAudioTranscript | null;
-/**
- * Host surface this capability fills: the full-width slot above a card's content.
- *
- * Item cards and passage cards open the same surface, so declaring it once
- * reaches both — a passage can carry an audio prompt as an item can.
- */
-export declare const CONTENT_LEAD_SURFACE = "content-lead";
 export declare const audioTranscriptRegistration: ToolRegistration;

package/dist/registrations/audio-transcript.js

@@ -35,6 +35,7 @@
  * absent from the universal preset — a content-dependent support never belongs in
  * a wholesale grant.
  */
+import { CONTENT_LEAD_SURFACE } from "@pie-players/pie-assessment-toolkit/tools/registration";
 import { toLanguageTag } from "@pie-players/pie-players-shared/i18n/language-tags";
 /** QTI 3.0 / AfA support id gating an audio transcript. */
 export const AUDIO_TRANSCRIPT_FEATURE_ID = "transcript";
@@ -103,13 +104,6 @@ export function resolveAudioTranscript(context) {
     // and being asked anyway is the price of also serving the authored case.
     return context.granted ? firstOnGrant : null;
 }
-/**
- * Host surface this capability fills: the full-width slot above a card's content.
- *
- * Item cards and passage cards open the same surface, so declaring it once
- * reaches both — a passage can carry an audio prompt as an item can.
- */
-export const CONTENT_LEAD_SURFACE = "content-lead";
 /**
  * A labelled region holding the transcript text.
  *

package/dist/registrations/interaction-tools.d.ts

@@ -4,7 +4,20 @@
  * Registers tools for interacting with question content:
  * - Answer Eliminator (strike through answer choices)
  */
-import type { ToolRegistration } from "@pie-players/pie-assessment-toolkit/tools/registration";
+import type { ToolProviderConfig, ToolRegistration } from "@pie-players/pie-assessment-toolkit/tools/registration";
+/**
+ * The answer eliminator's `tools.providers.answerEliminator` entry.
+ */
+export interface AnswerEliminatorToolConfig extends ToolProviderConfig {
+    /**
+     * The elements the eliminator acts on, by the name `<name>` of their
+     * `@pie-element/<name>` package, such as `["multiple-choice"]`. An element
+     * must also support answer masking. Omitted, every element that supports it
+     * takes the eliminator; empty, none does. A host lists the elements whose
+     * support it has vetted.
+     */
+    elements?: readonly string[];
+}
 /**
  * Answer Eliminator tool registration
  *

package/dist/registrations/interaction-tools.js

@@ -19,24 +19,84 @@ const ANSWER_MASKING = "answer-masking";
  * its supports is decided by its declaration, these two included.
  */
 const UNDECLARED_ANSWER_MASKING_ELEMENTS = new Set(["multiple-choice", "ebsr"]);
-// Content names one element several ways: `multiple-choice`,
-// `pie-multiple-choice`, `pie-element-multiple-choice`, a runtime `--version-*`
-// tag, or any tag the item's `elements` map binds to `@pie-element/multiple-choice`.
-function isUndeclaredAnswerMaskingElement(tag, packageSpec) {
-    const name = tag
+function elementName(tag) {
+    return tag
         .toLowerCase()
         .replace(/--version-[0-9a-z-]+$/, "")
         .replace(/^pie-(element-)?/, "");
-    if (UNDECLARED_ANSWER_MASKING_ELEMENTS.has(name))
-        return true;
-    const packageName = packageSpec?.match(/^@pie-element\/([^@]+)/)?.[1];
-    return !!packageName && UNDECLARED_ANSWER_MASKING_ELEMENTS.has(packageName);
 }
-/** Whether an element of the context supports answer masking. */
-function supportsAnswerMasking(context) {
-    return elementSupports(context).some(({ supports, tag, packageSpec }) => supports
-        ? supports.includes(ANSWER_MASKING)
-        : isUndeclaredAnswerMaskingElement(tag, packageSpec));
+// Content names one element several ways: `multiple-choice`,
+// `pie-multiple-choice`, `pie-element-multiple-choice`, a runtime `--version-*`
+// tag, or any tag the item's `elements` map binds to `@pie-element/multiple-choice`.
+function elementNames(tag, packageSpec) {
+    const names = [elementName(tag)];
+    const packageName = pieElementPackageName(packageSpec);
+    if (packageName)
+        names.push(packageName);
+    return names;
+}
+function pieElementPackageName(packageSpec) {
+    return packageSpec?.match(/^@pie-element\/([^@]+)/)?.[1]?.toLowerCase() ?? null;
+}
+/**
+ * The name an `elements` list matches: the `@pie-element/<name>` package the
+ * item binds the tag to, else the tag's own name. A tag bound to another
+ * package matches no name, whatever the tag says.
+ */
+function listedName(tag, packageSpec) {
+    return packageSpec ? pieElementPackageName(packageSpec) : elementName(tag);
+}
+/**
+ * The element names `config.elements` allows, or `null` for every element. An
+ * `elements` that is not a list allows none: validation reports it, and an
+ * element a host has not vetted stays without the eliminator.
+ */
+function allowedElementNames(config) {
+    const elements = config
+        ?.elements;
+    if (elements === undefined)
+        return null;
+    if (!Array.isArray(elements))
+        return new Set();
+    return new Set(elements
+        .filter((name) => typeof name === "string")
+        .map(elementName));
+}
+/**
+ * The model ids of the context's elements that support answer masking and the
+ * host config allows.
+ */
+function answerMaskingElementIds(context, config) {
+    const allowed = allowedElementNames(config);
+    return elementSupports(context)
+        .filter(({ supports, tag, packageSpec }) => {
+        if (allowed) {
+            const name = listedName(tag, packageSpec);
+            if (name === null || !allowed.has(name))
+                return false;
+        }
+        return supports
+            ? supports.includes(ANSWER_MASKING)
+            : elementNames(tag, packageSpec).some((name) => UNDECLARED_ANSWER_MASKING_ELEMENTS.has(name));
+    })
+        .flatMap(({ elementId }) => (elementId ? [elementId] : []));
+}
+function validateAnswerEliminatorConfig(config) {
+    const { elements } = config;
+    if (elements === undefined)
+        return [];
+    if (Array.isArray(elements) &&
+        elements.every((name) => typeof name === "string" && name.trim() !== "")) {
+        return [];
+    }
+    return [
+        {
+            code: "tools.invalidProviderConfig",
+            severity: "error",
+            path: "providers.answerEliminator.elements",
+            message: '`elements` must be a list of element names, such as ["multiple-choice"].',
+        },
+    ];
 }
 /** The state-store key of each PIE element in the item, by model id. */
 function resolveElementStateKeys(context, toolbarContext) {
@@ -67,23 +127,25 @@ export const answerEliminatorToolRegistration = {
     descriptionKey: "tools.answerEliminator.description",
     icon: "strikethrough",
     supportedLevels: ["item"],
+    validateConfig: validateAnswerEliminatorConfig,
     /**
      * Pass 2: relevant where an element supports answer masking. An element
      * declares it on its class, and the answer eliminator's README says what the
      * element then supplies.
      */
     isVisibleInContext(context) {
-        return supportsAnswerMasking(context);
+        return answerMaskingElementIds(context, null).length > 0;
     },
     /**
-     * Pass 3: the same question, asked as a capability. Elimination controls are
-     * rendered per choice, so an item none of whose elements supports answer
-     * masking gives this tool nothing to act on. Answering the relevance gate
-     * alone left the button on such items for any learner whose profile grants
-     * answer masking.
+     * Pass 3: the same question, asked as a capability and narrowed to the
+     * elements the host config allows. Elimination controls are rendered per
+     * choice, so an item none of whose allowed elements supports answer masking
+     * gives this tool nothing to act on. Answering the relevance gate alone left
+     * the button on such items for any learner whose profile grants answer
+     * masking.
      */
-    isApplicableToContent(context) {
-        return supportsAnswerMasking(context);
+    isApplicableToContent(context, config) {
+        return answerMaskingElementIds(context, config).length > 0;
     },
     renderToolbar(context, toolbarContext) {
         const visibility = createScopedVisibilityBinding(this.toolId, toolbarContext);
@@ -94,7 +156,7 @@ export const answerEliminatorToolRegistration = {
         const button = {
             toolId: this.toolId,
             label: this.name,
-            icon: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="20" height="20" fill="currentColor" aria-hidden="true"><path d="M19,3H16.3H7.7H5A2,2 0 0,0 3,5V7.7V16.4V19A2,2 0 0,0 5,21H7.7H16.4H19A2,2 0 0,0 21,19V16.3V7.7V5A2,2 0 0,0 19,3M15.6,17L12,13.4L8.4,17L7,15.6L10.6,12L7,8.4L8.4,7L12,10.6L15.6,7L17,8.4L13.4,12L17,15.6L15.6,17Z"/></svg>',
+            icon: typeof this.icon === "function" ? this.icon(context) : this.icon,
             disabled: false,
             ariaLabel: toolbarContext.i18n.t("tools.answerEliminator.buttonA11y"),
             tooltip: toolbarContext.i18n.t("tools.answerEliminator.tooltip"),
@@ -112,6 +174,12 @@ export const answerEliminatorToolRegistration = {
                     isActive: visibility.isActive,
                 });
                 overlay.elementStateKeys = resolveElementStateKeys(context, toolbarContext);
+                const config = toolbarContext.toolkitCoordinator?.getToolConfig(this.toolId) ??
+                    null;
+                overlay.elementIds =
+                    allowedElementNames(config) === null
+                        ? undefined
+                        : answerMaskingElementIds(context, config);
             },
             subscribeActive: visibility.subscribeActive,
         };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pie-players/pie-default-tool-loaders",
-	"version": "1.0.0-beta.7",
+	"version": "1.0.0-beta.9",
 	"type": "module",
 	"description": "Composition layer for the packaged PIE assessment tools: registrations, tag map, placement preset, universal and empty profiles, and lazy module loaders",
 	"repository": {
@@ -33,28 +33,28 @@
 		"test": "bun test"
 	},
 	"dependencies": {
-		"@pie-players/pie-assessment-toolkit": "1.0.0-beta.7",
-		"@pie-players/pie-calculator": "1.0.0-beta.7",
-		"@pie-players/pie-calculator-desmos": "1.0.0-beta.7",
-		"@pie-players/pie-calculator-geogebra": "1.0.0-beta.7",
-		"@pie-players/pie-players-shared": "1.0.0-beta.7",
-		"@pie-players/pie-tool-annotation-toolbar": "1.0.0-beta.7",
-		"@pie-players/pie-tool-answer-eliminator": "1.0.0-beta.7",
-		"@pie-players/pie-tool-calculator-shared": "1.0.0-beta.7",
-		"@pie-players/pie-tool-dictionary": "1.0.0-beta.7",
-		"@pie-players/pie-tool-graph": "1.0.0-beta.7",
-		"@pie-players/pie-tool-line-reader": "1.0.0-beta.7",
-		"@pie-players/pie-tool-magnifier": "1.0.0-beta.7",
-		"@pie-players/pie-tool-periodic-table": "1.0.0-beta.7",
-		"@pie-players/pie-tool-picture-dictionary": "1.0.0-beta.7",
-		"@pie-players/pie-tool-protractor": "1.0.0-beta.7",
-		"@pie-players/pie-tool-ruler": "1.0.0-beta.7",
-		"@pie-players/pie-tool-theme": "1.0.0-beta.7",
-		"@pie-players/pie-tool-tts-inline": "1.0.0-beta.7",
-		"@pie-players/tts-client-server": "1.0.0-beta.7"
+		"@pie-players/pie-assessment-toolkit": "1.0.0-beta.9",
+		"@pie-players/pie-calculator": "1.0.0-beta.9",
+		"@pie-players/pie-calculator-desmos": "1.0.0-beta.9",
+		"@pie-players/pie-calculator-geogebra": "1.0.0-beta.9",
+		"@pie-players/pie-players-shared": "1.0.0-beta.9",
+		"@pie-players/pie-tool-annotation-toolbar": "1.0.0-beta.9",
+		"@pie-players/pie-tool-answer-eliminator": "1.0.0-beta.9",
+		"@pie-players/pie-tool-calculator-shared": "1.0.0-beta.9",
+		"@pie-players/pie-tool-dictionary": "1.0.0-beta.9",
+		"@pie-players/pie-tool-graph": "1.0.0-beta.9",
+		"@pie-players/pie-tool-line-reader": "1.0.0-beta.9",
+		"@pie-players/pie-tool-magnifier": "1.0.0-beta.9",
+		"@pie-players/pie-tool-periodic-table": "1.0.0-beta.9",
+		"@pie-players/pie-tool-picture-dictionary": "1.0.0-beta.9",
+		"@pie-players/pie-tool-protractor": "1.0.0-beta.9",
+		"@pie-players/pie-tool-ruler": "1.0.0-beta.9",
+		"@pie-players/pie-tool-theme": "1.0.0-beta.9",
+		"@pie-players/pie-tool-tts-inline": "1.0.0-beta.9",
+		"@pie-players/tts-client-server": "1.0.0-beta.9"
 	},
 	"devDependencies": {
-		"@biomejs/biome": "^2.6.2",
+		"@biomejs/biome": "^2.6.4",
 		"@happy-dom/global-registrator": "^21.0.4",
 		"typescript": "^5.9.3"
 	},