@pie-players/pie-assessment-toolkit 0.3.64 → 0.3.65

package/dist/tools/registrations/subject-specific-tools.js

@@ -1,158 +0,0 @@
-/**
- * Subject-Specific Tools Registrations
- *
- * Registers tools for specific subject areas:
- * - Graph (graphing calculator/coordinate plane)
- * - Periodic Table (chemistry reference)
- *
- * Maps to QTI 3.0 standard access features:
- * - graphingCalculator (assessment tool)
- * - graph (assessment tool)
- * - periodicTable (assessment tool)
- */
-import { hasMathContent, hasScienceContent, } from "../../services/tool-context.js";
-import { createToolElement, } from "../tool-tag-map.js";
-import { createScopedVisibilityBinding, syncButtonAndOverlayVisibility, } from "./toolbar-registration-helpers.js";
-/**
- * Graph tool registration
- *
- * Provides graphing calculator and coordinate plane functionality.
- * Context-smart: appears automatically for math content or when explicitly enabled.
- */
-export const graphToolRegistration = {
-    toolId: "graph",
-    name: "Graph",
-    description: "Graphing calculator and coordinate plane",
-    icon: "chart-bar",
-    // Graph is a section-level floating tool.
-    supportedLevels: ["section"],
-    // PNP support IDs
-    // Maps to QTI 3.0 standard features: graph, graphingCalculator
-    pnpSupportIds: [
-        "graph", // QTI 3.0 standard (assessment.graph)
-        "graphingCalculator", // QTI 3.0 standard (assessment.graphingCalculator)
-        "coordinatePlane", // Common variant
-        "graphingTool", // Common variant
-    ],
-    /**
-     * Pass 2: Graph is relevant when math content is present
-     */
-    isVisibleInContext(context) {
-        return hasMathContent(context);
-    },
-    renderToolbar(context, toolbarContext) {
-        const visibility = createScopedVisibilityBinding(this.toolId, toolbarContext);
-        const button = {
-            toolId: this.toolId,
-            label: this.name,
-            icon: typeof this.icon === "function" ? this.icon(context) : this.icon,
-            disabled: false,
-            ariaLabel: "Graph - Graphing calculator",
-            tooltip: "Graph",
-            onClick: () => toolbarContext.toggleTool(this.toolId),
-            active: visibility.isActive(),
-        };
-        const componentOverrides = toolbarContext.componentOverrides ?? {};
-        const overlay = createToolElement(this.toolId, context, toolbarContext, componentOverrides);
-        overlay.setAttribute("tool-id", visibility.fullToolId);
-        return {
-            toolId: this.toolId,
-            button,
-            elements: [
-                {
-                    element: overlay,
-                    mount: "after-buttons",
-                    shell: {
-                        title: this.name,
-                        draggable: true,
-                        resizable: true,
-                        closeable: true,
-                        initialWidth: 920,
-                        initialHeight: 680,
-                        minWidth: 640,
-                        minHeight: 500,
-                    },
-                },
-            ],
-            sync: () => {
-                syncButtonAndOverlayVisibility({
-                    button,
-                    overlay,
-                    isActive: visibility.isActive,
-                });
-            },
-            subscribeActive: visibility.subscribeActive,
-        };
-    },
-};
-/**
- * Periodic Table tool registration
- *
- * Provides chemistry periodic table reference.
- * Context-smart: appears automatically for science content or when explicitly enabled.
- */
-export const periodicTableToolRegistration = {
-    toolId: "periodicTable",
-    name: "Periodic Table",
-    description: "Chemistry periodic table reference",
-    icon: "beaker",
-    // Periodic table is a section-level floating tool.
-    supportedLevels: ["section"],
-    // PNP support IDs
-    // Maps to QTI 3.0 standard feature: periodicTable
-    pnpSupportIds: [
-        "periodicTable", // QTI 3.0 standard (assessment.periodicTable)
-        "chemistryReference", // Common variant
-        "elementReference", // Common variant
-    ],
-    /**
-     * Pass 2: Periodic table is relevant when science content is present
-     */
-    isVisibleInContext(context) {
-        return hasScienceContent(context);
-    },
-    renderToolbar(context, toolbarContext) {
-        const visibility = createScopedVisibilityBinding(this.toolId, toolbarContext);
-        const button = {
-            toolId: this.toolId,
-            label: this.name,
-            icon: typeof this.icon === "function" ? this.icon(context) : this.icon,
-            disabled: false,
-            ariaLabel: "Periodic table - Chemistry reference",
-            tooltip: "Periodic Table",
-            onClick: () => toolbarContext.toggleTool(this.toolId),
-            active: visibility.isActive(),
-        };
-        const componentOverrides = toolbarContext.componentOverrides ?? {};
-        const overlay = createToolElement(this.toolId, context, toolbarContext, componentOverrides);
-        overlay.setAttribute("tool-id", visibility.fullToolId);
-        return {
-            toolId: this.toolId,
-            button,
-            elements: [
-                {
-                    element: overlay,
-                    mount: "after-buttons",
-                    shell: {
-                        title: this.name,
-                        draggable: true,
-                        resizable: true,
-                        closeable: true,
-                        initialWidth: 1160,
-                        initialHeight: 760,
-                        minWidth: 920,
-                        minHeight: 620,
-                    },
-                },
-            ],
-            sync: () => {
-                syncButtonAndOverlayVisibility({
-                    button,
-                    overlay,
-                    isActive: visibility.isActive,
-                });
-            },
-            subscribeActive: visibility.subscribeActive,
-        };
-    },
-};

package/dist/tools/registrations/tts.d.ts

@@ -1,21 +0,0 @@
-/**
- * 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 type { ToolRegistration } from "../../services/ToolRegistry.js";
-export declare const TOOL_ELEMENT_UNMOUNT_CALLBACK_PROP = "__pieToolElementUnmount";
-export declare const TOOL_ACTIVE_CHANGE_EVENT = "pie-tool-active-change";
-/**
- * Text-to-Speech tool registration
- *
- * Supports:
- * - Reading content aloud using browser TTS or external providers
- * - Context-aware visibility (shows when readable text is available)
- * - All levels except assessment and element
- */
-export declare const ttsToolRegistration: ToolRegistration;

package/dist/tools/registrations/tts.js

@@ -1,184 +0,0 @@
-/**
- * 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 "../../services/tool-context.js";
-import { createScopedToolId } from "../../services/tool-instance-id.js";
-import { buildRuntimeTTSConfig, normalizeTTSLayoutMode, normalizeTTSSpeedControlOptions, resolveTTSHostToolbarLayout, resolveTTSLayoutMode, resolveTTSBackend, resolveTTSRuntimeSettings, resolveRuntimeProvider, resolveTransportMode, } from "../../services/tts-runtime-config.js";
-import { TTSToolProvider } from "../../services/tool-providers/index.js";
-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
- *
- * Supports:
- * - Reading content aloud using browser TTS or external providers
- * - Context-aware visibility (shows when readable text is available)
- * - All levels except assessment and element
- */
-export const ttsToolRegistration = {
-    toolId: "textToSpeech",
-    name: "Text to Speech",
-    description: "Read content aloud",
-    icon: "volume-up",
-    provider: {
-        getProviderId: () => "tts",
-        createProvider: (config) => {
-            const settings = resolveTTSRuntimeSettings(config);
-            return new TTSToolProvider(resolveTTSBackend(settings));
-        },
-        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),
-            };
-        },
-        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,
-    },
-    // 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)
-        "tts", // Common abbreviation
-        "speechOutput", // Common variant
-    ],
-    /**
-     * Pass 2: Determine if TTS is relevant in this context
-     *
-     * TTS is relevant when:
-     * - Context contains readable text (at least 10 characters)
-     */
-    isVisibleInContext(context) {
-        return hasReadableText(context);
-    },
-    renderToolbar(_context, toolbarContext) {
-        const resolveRuntimeSettings = () => resolveTTSRuntimeSettings(toolbarContext.toolkitCoordinator?.getToolConfig(this.toolId) ||
-            undefined);
-        const resolveElementSpeedOptions = () => {
-            const runtimeSettings = resolveRuntimeSettings();
-            return normalizeTTSSpeedControlOptions(runtimeSettings.speedOptions);
-        };
-        const resolveLayoutMode = () => resolveTTSLayoutMode(resolveRuntimeSettings());
-        const resolveHostLayout = () => resolveTTSHostToolbarLayout(resolveRuntimeSettings());
-        const fullToolId = createScopedToolId(this.toolId, toolbarContext.scope.level, toolbarContext.scope.scopeId);
-        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);
-            }
-            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;
-            return element;
-        };
-        const hostLayout = resolveHostLayout();
-        return {
-            toolId: this.toolId,
-            button: null,
-            elements: [
-                {
-                    element: ensureElement(),
-                    mount: hostLayout.mount,
-                    layoutHints: {
-                        controlsRow: {
-                            reserveSpace: hostLayout.controlsRow.reserveSpace,
-                            showWhenToolActive: hostLayout.controlsRow.expandWhenToolActive,
-                        },
-                        headerOverlay: {
-                            showWhenToolActive: hostLayout.headerOverlay.expandWhenToolActive,
-                        },
-                    },
-                },
-            ],
-            subscribeActive: (callback) => {
-                const element = ensureElement();
-                const handler = (event) => {
-                    const detail = event.detail;
-                    callback(detail?.active === true);
-                };
-                element.addEventListener(TOOL_ACTIVE_CHANGE_EVENT, handler);
-                return () => {
-                    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;
-            },
-        };
-    },
-};