@pie-players/pie-default-tool-loaders 0.3.74 → 0.3.75

package/dist/registrations/tts.js

@@ -2,20 +2,15 @@
  * Text-to-Speech (TTS) Tool Registration
  *
  * Registers the TTS tool for reading content aloud.
- *
- * Maps to QTI 3.0 standard access features:
- * - textToSpeech (auditory support)
- * - readAloud (auditory support)
  */
-import { hasReadableText } from "@pie-players/pie-assessment-toolkit/tools/internal";
-import { createScopedToolId } from "@pie-players/pie-assessment-toolkit/tools/internal";
-import { buildRuntimeTTSConfig, normalizeTTSLayoutMode, normalizeTTSSpeedControlOptions, resolveTTSHostToolbarLayout, resolveTTSLayoutMode, resolveTTSBackend, resolveTTSRuntimeSettings, resolveRuntimeProvider, resolveTransportMode, } from "@pie-players/pie-assessment-toolkit/tools/internal";
-import { TTSToolProvider } from "@pie-players/pie-assessment-toolkit/tools/internal";
+import { hasReadableText } from "@pie-players/pie-assessment-toolkit/tools/registration";
+import { createScopedToolId, createToolElement, } from "@pie-players/pie-assessment-toolkit/tools/registration";
+import { buildRuntimeTTSConfig, normalizeTTSLayoutMode, normalizeTTSSpeedControlOptions, resolveTTSHostToolbarLayout, resolveTTSLayoutMode, resolveTTSRuntimeSettings, } from "@pie-players/pie-assessment-toolkit/tools/registration";
+import { TTSToolProvider } from "@pie-players/pie-assessment-toolkit/tools/registration";
+import { resolveOverlayElement } from "./overlay-element-cache.js";
 // This package owns the server adapter's import, so the toolkit never names it
 // and a bundler building the toolkit alone has nothing to resolve.
 const loadServerTTSProvider = async () => (await import("@pie-players/tts-client-server")).ServerTTSProvider;
-const inlineTTSControls = new Map();
-export const TOOL_ELEMENT_UNMOUNT_CALLBACK_PROP = "__pieToolElementUnmount";
 export const TOOL_ACTIVE_CHANGE_EVENT = "pie-tool-active-change";
 /**
  * Text-to-Speech tool registration
@@ -33,65 +28,34 @@ export const ttsToolRegistration = {
     descriptionKey: "tools.textToSpeech.description",
     icon: "volume-up",
     provider: {
-        getProviderId: () => "tts",
         createProvider: (config) => {
-            const settings = resolveTTSRuntimeSettings(config);
-            return new TTSToolProvider(resolveTTSBackend(settings), {
+            return new TTSToolProvider(resolveTTSRuntimeSettings(config).backend, {
                 loadServerProvider: loadServerTTSProvider,
             });
         },
-        getInitConfig: (config) => {
-            const settings = resolveTTSRuntimeSettings(config);
-            const backend = resolveTTSBackend(settings);
-            const serverProvider = resolveRuntimeProvider(settings, backend);
-            const transportMode = resolveTransportMode(settings, serverProvider);
-            return {
-                backend,
-                serverProvider,
-                transportMode,
-                ...buildRuntimeTTSConfig(settings),
-            };
-        },
+        getInitConfig: (config) => buildRuntimeTTSConfig(resolveTTSRuntimeSettings(config)),
         getAuthFetcher: (config) => {
             const runtimeAuthFetcher = config?.provider?.runtime?.authFetcher;
             return typeof runtimeAuthFetcher === "function"
                 ? runtimeAuthFetcher
                 : undefined;
         },
-        sanitizeConfig: (config) => {
-            const settings = config.settings && typeof config.settings === "object"
-                ? { ...config.settings }
-                : undefined;
-            if (settings && "layoutMode" in settings) {
-                settings.layoutMode = normalizeTTSLayoutMode(settings.layoutMode);
-            }
-            if (settings && "speedOptions" in settings) {
-                settings.speedOptions = normalizeTTSSpeedControlOptions(settings.speedOptions);
-            }
-            const normalizedConfig = {
-                ...config,
-            };
-            if ("layoutMode" in normalizedConfig) {
-                normalizedConfig.layoutMode = normalizeTTSLayoutMode(normalizedConfig.layoutMode);
-            }
-            if ("speedOptions" in normalizedConfig) {
-                normalizedConfig.speedOptions = normalizeTTSSpeedControlOptions(normalizedConfig.speedOptions);
-            }
-            if (settings) {
-                normalizedConfig.settings = settings;
-            }
-            return normalizedConfig;
-        },
         lazy: true,
     },
+    sanitizeConfig: (config) => {
+        const normalizedConfig = {
+            ...config,
+        };
+        if ("layoutMode" in normalizedConfig) {
+            normalizedConfig.layoutMode = normalizeTTSLayoutMode(normalizedConfig.layoutMode);
+        }
+        if ("speedOptions" in normalizedConfig) {
+            normalizedConfig.speedOptions = normalizeTTSSpeedControlOptions(normalizedConfig.speedOptions);
+        }
+        return normalizedConfig;
+    },
     // TTS is inline-only and scoped to item/passage contexts.
     supportedLevels: ["item", "passage"],
-    // PNP support IDs that enable this tool
-    // Maps to QTI 3.0 standard features: textToSpeech, readAloud
-    pnpSupportIds: [
-        "textToSpeech", // QTI 3.0 standard (auditory.textToSpeech)
-        "readAloud", // QTI 3.0 standard (auditory.readAloud)
-    ],
     /**
      * Pass 2: Determine if TTS is relevant in this context
      *
@@ -101,7 +65,7 @@ export const ttsToolRegistration = {
     isVisibleInContext(context) {
         return hasReadableText(context);
     },
-    renderToolbar(_context, toolbarContext) {
+    renderToolbar(context, toolbarContext) {
         const resolveRuntimeSettings = () => resolveTTSRuntimeSettings(toolbarContext.toolkitCoordinator?.getToolConfig(this.toolId) ||
             undefined);
         const resolveElementSpeedOptions = () => {
@@ -111,44 +75,38 @@ export const ttsToolRegistration = {
         const resolveLayoutMode = () => resolveTTSLayoutMode(resolveRuntimeSettings());
         const resolveHostLayout = () => resolveTTSHostToolbarLayout(resolveRuntimeSettings());
         const fullToolId = createScopedToolId(this.toolId, toolbarContext.scope.level, toolbarContext.scope.scopeId);
+        // Only a language the toolbar or its host named: unnamed, the control resolves
+        // markup `lang`, and the browser voice follows the browser's language.
+        const applyContentLanguage = (element) => {
+            if (toolbarContext.language) {
+                element.setAttribute("language", toolbarContext.language);
+            }
+            else {
+                element.removeAttribute("language");
+            }
+        };
         const resolveControlSize = () => {
             const raw = toolbarContext.ui?.size;
             return raw === "sm" || raw === "lg" ? raw : "md";
         };
-        const ensureElement = () => {
-            let element = inlineTTSControls.get(fullToolId);
-            if (element &&
-                typeof element.isConnected ===
-                    "boolean" &&
-                !element.isConnected) {
-                inlineTTSControls.delete(fullToolId);
-                element = undefined;
-            }
-            if (!element) {
-                element = document.createElement("pie-tool-tts-inline");
-                element[TOOL_ELEMENT_UNMOUNT_CALLBACK_PROP] = () => {
-                    if (inlineTTSControls.get(fullToolId) === element) {
-                        inlineTTSControls.delete(fullToolId);
-                    }
-                };
-                inlineTTSControls.set(fullToolId, element);
-            }
+        const element = resolveOverlayElement(toolbarContext, fullToolId, () => createToolElement(this.toolId, context, toolbarContext, toolbarContext.componentOverrides));
+        const applyAttributes = () => {
             element.setAttribute("catalog-id", toolbarContext.catalogId || toolbarContext.itemId);
-            element.setAttribute("language", toolbarContext.language || "en-US");
+            applyContentLanguage(element);
             element.setAttribute("size", resolveControlSize());
             element.setAttribute("layout-mode", resolveLayoutMode());
             element.speedOptions = resolveElementSpeedOptions();
             element.showSingleSpeedOption =
                 resolveRuntimeSettings().showSingleSpeedOption === true;
-            return element;
         };
+        applyAttributes();
         const hostLayout = resolveHostLayout();
         return {
             toolId: this.toolId,
             button: null,
             elements: [
                 {
-                    element: ensureElement(),
+                    element,
                     mount: hostLayout.mount,
                     layoutHints: {
                         controlsRow: {
@@ -162,7 +120,6 @@ export const ttsToolRegistration = {
                 },
             ],
             subscribeActive: (callback) => {
-                const element = ensureElement();
                 const handler = (event) => {
                     const detail = event.detail;
                     callback(detail?.active === true);
@@ -172,17 +129,7 @@ export const ttsToolRegistration = {
                     element.removeEventListener(TOOL_ACTIVE_CHANGE_EVENT, handler);
                 };
             },
-            sync: () => {
-                const element = ensureElement();
-                element.setAttribute("tool-id", fullToolId);
-                element.setAttribute("catalog-id", toolbarContext.catalogId || toolbarContext.itemId);
-                element.setAttribute("language", toolbarContext.language || "en-US");
-                element.setAttribute("size", resolveControlSize());
-                element.setAttribute("layout-mode", resolveLayoutMode());
-                element.speedOptions = resolveElementSpeedOptions();
-                element.showSingleSpeedOption =
-                    resolveRuntimeSettings().showSingleSpeedOption === true;
-            },
+            sync: applyAttributes,
         };
     },
 };

package/package.json

@@ -1,8 +1,8 @@
 {
 	"name": "@pie-players/pie-default-tool-loaders",
-	"version": "0.3.74",
+	"version": "0.3.75",
 	"type": "module",
-	"description": "Composition layer for the packaged PIE assessment tools: registrations, tag map, placement presets, universal supports and lazy module loaders",
+	"description": "Composition layer for the packaged PIE assessment tools: registrations, tag map, placement preset, universal and empty profiles, and lazy module loaders",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/pie-framework/pie-players.git",
@@ -33,30 +33,29 @@
 		"test": "bun test"
 	},
 	"dependencies": {
-		"@pie-players/pie-assessment-toolkit": "0.3.74",
-		"@pie-players/pie-calculator": "0.3.74",
-		"@pie-players/pie-calculator-cortex": "0.3.74",
-		"@pie-players/pie-calculator-desmos": "0.3.74",
-		"@pie-players/pie-calculator-geogebra": "0.3.74",
-		"@pie-players/pie-players-shared": "0.3.74",
-		"@pie-players/pie-tool-annotation-toolbar": "0.3.74",
-		"@pie-players/pie-tool-answer-eliminator": "0.3.74",
-		"@pie-players/pie-tool-calculator-cortex": "0.3.74",
-		"@pie-players/pie-tool-calculator-geogebra": "0.3.74",
-		"@pie-players/pie-tool-calculator-shared": "0.3.74",
-		"@pie-players/pie-tool-dictionary": "0.3.74",
-		"@pie-players/pie-tool-graph": "0.3.74",
-		"@pie-players/pie-tool-line-reader": "0.3.74",
-		"@pie-players/pie-tool-periodic-table": "0.3.74",
-		"@pie-players/pie-tool-picture-dictionary": "0.3.74",
-		"@pie-players/pie-tool-protractor": "0.3.74",
-		"@pie-players/pie-tool-ruler": "0.3.74",
-		"@pie-players/pie-tool-theme": "0.3.74",
-		"@pie-players/pie-tool-tts-inline": "0.3.74",
-		"@pie-players/tts-client-server": "0.3.74"
+		"@pie-players/pie-assessment-toolkit": "0.3.75",
+		"@pie-players/pie-calculator": "0.3.75",
+		"@pie-players/pie-calculator-cortex": "0.3.75",
+		"@pie-players/pie-calculator-desmos": "0.3.75",
+		"@pie-players/pie-calculator-geogebra": "0.3.75",
+		"@pie-players/pie-players-shared": "0.3.75",
+		"@pie-players/pie-tool-annotation-toolbar": "0.3.75",
+		"@pie-players/pie-tool-answer-eliminator": "0.3.75",
+		"@pie-players/pie-tool-calculator-shared": "0.3.75",
+		"@pie-players/pie-tool-dictionary": "0.3.75",
+		"@pie-players/pie-tool-graph": "0.3.75",
+		"@pie-players/pie-tool-line-reader": "0.3.75",
+		"@pie-players/pie-tool-periodic-table": "0.3.75",
+		"@pie-players/pie-tool-picture-dictionary": "0.3.75",
+		"@pie-players/pie-tool-protractor": "0.3.75",
+		"@pie-players/pie-tool-ruler": "0.3.75",
+		"@pie-players/pie-tool-theme": "0.3.75",
+		"@pie-players/pie-tool-tts-inline": "0.3.75",
+		"@pie-players/tts-client-server": "0.3.75"
 	},
 	"devDependencies": {
 		"@biomejs/biome": "^2.5.15",
+		"@happy-dom/global-registrator": "^20.14.5",
 		"typescript": "^5.9.3"
 	},
 	"homepage": "https://github.com/pie-framework/pie-players/tree/master/packages/default-tool-loaders#readme",