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

package/dist/tools/registrations/calculator.js

@@ -1,228 +0,0 @@
-/**
- * Calculator Tool Registration
- *
- * Registers the calculator tool with support for multiple calculator types
- * (basic, scientific, graphing) via Desmos provider.
- *
- * Maps to QTI 3.0 standard access features:
- * - calculator (cognitive support)
- * - graphingCalculator (assessment tool)
- */
-import { hasMathContent } from "../../services/tool-context.js";
-import { createScopedToolId } from "../../services/tool-instance-id.js";
-import { DesmosToolProvider } from "../../services/tool-providers/index.js";
-import { createToolElement } from "../tool-tag-map.js";
-// The toolbar parent re-derives `renderedTools` whenever item state changes
-// (e.g. the learner answers a question and `effectiveItem`/`renderContext`
-// recompute). Calculator initialization is expensive (Desmos boot, container
-// mount), so we cache the overlay element by coordinator + scoped tool id.
-// Reusing the same element keeps `mountContent` a no-op and avoids tearing
-// down and re-initializing the calculator on every re-render.
-const overlayElementCache = new WeakMap();
-function getCachedOverlay(coordinator, fullToolId) {
-    if (!coordinator)
-        return null;
-    const scoped = overlayElementCache.get(coordinator);
-    const element = scoped?.get(fullToolId);
-    if (!element)
-        return null;
-    // Svelte custom elements destroy their component when disconnected.
-    // A detached cached element is a dead instance — drop it and recreate.
-    if (!element.isConnected) {
-        scoped?.delete(fullToolId);
-        return null;
-    }
-    return element;
-}
-function setCachedOverlay(coordinator, fullToolId, element) {
-    if (!coordinator)
-        return;
-    let scoped = overlayElementCache.get(coordinator);
-    if (!scoped) {
-        scoped = new Map();
-        overlayElementCache.set(coordinator, scoped);
-    }
-    scoped.set(fullToolId, element);
-}
-function normalizeCalculatorType(value) {
-    return value === "basic" || value === "scientific" ? value : null;
-}
-function getCalculatorRenderParams(toolbarContext) {
-    const params = toolbarContext.getToolRenderParams?.("calculator") ?? {};
-    const calculatorType = normalizeCalculatorType(params.calculatorType);
-    const availableTypesRaw = params.availableTypes;
-    const availableTypes = Array.isArray(availableTypesRaw)
-        ? availableTypesRaw
-            .map((value) => normalizeCalculatorType(value))
-            .filter((value) => value !== null)
-        : calculatorType
-            ? [calculatorType]
-            : null;
-    return {
-        calculatorType,
-        availableTypes,
-        displayName: calculatorType === "scientific"
-            ? "Scientific Calculator"
-            : calculatorType === "basic"
-                ? "Basic Calculator"
-                : "Calculator",
-    };
-}
-function applyCalculatorParamsToElement(element, calculatorType, availableTypes) {
-    const calculatorElement = element;
-    if (calculatorType) {
-        calculatorElement.calculatorType = calculatorType;
-        element.setAttribute("calculator-type", calculatorType);
-    }
-    else {
-        delete calculatorElement.calculatorType;
-        element.removeAttribute("calculator-type");
-    }
-    if (availableTypes && availableTypes.length > 0) {
-        calculatorElement.availableTypes = availableTypes;
-    }
-    else {
-        delete calculatorElement.availableTypes;
-    }
-}
-/**
- * Calculator tool registration
- *
- * Supports:
- * - Basic, scientific, and graphing calculators via Desmos
- * - Context-aware visibility (shows only when math content is detected)
- * - Item level only
- */
-export const calculatorToolRegistration = {
-    toolId: "calculator",
-    name: "Calculator",
-    description: "Multi-type calculator (basic, scientific, graphing)",
-    icon: "calculator",
-    provider: {
-        getProviderId: (config) => typeof config?.provider?.id === "string" && config.provider.id.length > 0
-            ? config.provider.id
-            : "calculator-desmos",
-        createProvider: () => new DesmosToolProvider(),
-        getInitConfig: (config) => config?.provider?.init ?? {},
-        getAuthFetcher: (config) => {
-            const runtimeAuthFetcher = config?.provider?.runtime?.authFetcher;
-            if (typeof runtimeAuthFetcher === "function")
-                return runtimeAuthFetcher;
-            return async () => {
-                const response = await fetch("/api/tools/desmos/auth", {
-                    method: "GET",
-                    credentials: "same-origin",
-                });
-                if (!response.ok) {
-                    throw new Error(`Failed to fetch Desmos auth config (${response.status})`);
-                }
-                return (await response.json());
-            };
-        },
-        lazy: true,
-    },
-    // Calculator is item-level in this player architecture.
-    supportedLevels: ["item"],
-    // PNP support IDs that enable this tool
-    // Maps to QTI 3.0 standard features: calculator, graphingCalculator
-    pnpSupportIds: [
-        "calculator", // QTI 3.0 standard (cognitive.calculator)
-        "graphingCalculator", // QTI 3.0 standard (assessment.graphingCalculator)
-        "basicCalculator", // Common variant
-        "scientificCalculator", // Common variant
-    ],
-    /**
-     * Pass 2: Determine if calculator is relevant in this context
-     *
-     * Calculator is relevant when context contains mathematical content
-     * (MathML, LaTeX, arithmetic markers).
-     */
-    isVisibleInContext(context) {
-        // Show only when math is present in item content.
-        return hasMathContent(context);
-    },
-    renderToolbar(context, toolbarContext) {
-        const { calculatorType, availableTypes, displayName } = getCalculatorRenderParams(toolbarContext);
-        const fullToolId = createScopedToolId(this.toolId, toolbarContext.scope.level, toolbarContext.scope.scopeId);
-        const componentOverrides = toolbarContext.componentOverrides;
-        const cachedOverlay = getCachedOverlay(toolbarContext.toolCoordinator, fullToolId);
-        const overlay = (cachedOverlay ??
-            createToolElement(this.toolId, context, toolbarContext, componentOverrides));
-        if (!cachedOverlay) {
-            setCachedOverlay(toolbarContext.toolCoordinator, fullToolId, overlay);
-        }
-        overlay.setAttribute("tool-id", fullToolId);
-        overlay.toolkitCoordinator = toolbarContext.toolkitCoordinator;
-        applyCalculatorParamsToElement(overlay, calculatorType, availableTypes);
-        const openLabel = calculatorType === null
-            ? "Open scientific calculator"
-            : `Open ${displayName.toLowerCase()}`;
-        const closeLabel = calculatorType === null
-            ? "Close scientific calculator"
-            : `Close ${displayName.toLowerCase()}`;
-        const button = {
-            toolId: this.toolId,
-            label: displayName,
-            icon: typeof this.icon === "function" ? this.icon(context) : this.icon,
-            disabled: false,
-            ariaLabel: openLabel,
-            tooltip: displayName,
-            onClick: () => toolbarContext.toggleTool(this.toolId),
-            active: toolbarContext.isToolVisible(fullToolId),
-        };
-        let lastVisibleState = button.active;
-        if (overlay.visible !== button.active) {
-            overlay.visible = button.active;
-        }
-        return {
-            toolId: this.toolId,
-            elements: [
-                {
-                    element: overlay,
-                    mount: "after-buttons",
-                    shell: {
-                        title: this.name,
-                        draggable: true,
-                        resizable: true,
-                        closeable: true,
-                        initialWidth: 380,
-                        initialHeight: 420,
-                        minWidth: 380,
-                        minHeight: 420,
-                        initialAlign: "bottom-right",
-                        initialMargin: 16,
-                        content: {
-                            overflowY: "auto",
-                            preserveMinHeight: true,
-                        },
-                    },
-                },
-            ],
-            button,
-            sync: () => {
-                const active = toolbarContext.isToolVisible(fullToolId);
-                button.active = active;
-                button.label = displayName;
-                button.ariaLabel = active ? closeLabel : openLabel;
-                button.tooltip = active
-                    ? `Close ${displayName.toLowerCase()}`
-                    : displayName;
-                if (lastVisibleState !== active) {
-                    overlay.visible = active;
-                    lastVisibleState = active;
-                }
-                if (overlay.toolkitCoordinator !== toolbarContext.toolkitCoordinator) {
-                    overlay.toolkitCoordinator = toolbarContext.toolkitCoordinator;
-                }
-                applyCalculatorParamsToElement(overlay, calculatorType, availableTypes);
-            },
-            subscribeActive: (callback) => {
-                if (!toolbarContext.subscribeVisibility)
-                    return () => { };
-                return toolbarContext.subscribeVisibility(() => {
-                    callback(toolbarContext.isToolVisible(fullToolId));
-                });
-            },
-        };
-    },
-};

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

@@ -1,27 +0,0 @@
-/**
- * Interaction Tools Registrations
- *
- * Registers tools for interacting with question content:
- * - Answer Eliminator (strike through answer choices)
- * - Highlighter (highlight text passages)
- *
- * Maps to QTI 3.0 standard access features:
- * - answerMasking (assessment tool)
- * - strikethrough (visual transformation)
- * - highlighting (cognitive/reading support)
- */
-import type { ToolRegistration } from "../../services/ToolRegistry.js";
-/**
- * Answer Eliminator tool registration
- *
- * Allows students to strike through incorrect answer choices.
- * Only appears on multiple-choice style questions.
- */
-export declare const answerEliminatorToolRegistration: ToolRegistration;
-/**
- * Highlighter tool registration
- *
- * Allows students to highlight text in passages and questions.
- * Appears on items with readable text content.
- */
-export declare const highlighterToolRegistration: ToolRegistration;

package/dist/tools/registrations/interaction-tools.js

@@ -1,143 +0,0 @@
-/**
- * Interaction Tools Registrations
- *
- * Registers tools for interacting with question content:
- * - Answer Eliminator (strike through answer choices)
- * - Highlighter (highlight text passages)
- *
- * Maps to QTI 3.0 standard access features:
- * - answerMasking (assessment tool)
- * - strikethrough (visual transformation)
- * - highlighting (cognitive/reading support)
- */
-import { hasChoiceInteraction, hasReadableText, } from "../../services/tool-context.js";
-import { createToolElement, } from "../tool-tag-map.js";
-import { createScopedVisibilityBinding, syncButtonAndOverlayVisibility, } from "./toolbar-registration-helpers.js";
-/**
- * Answer Eliminator tool registration
- *
- * Allows students to strike through incorrect answer choices.
- * Only appears on multiple-choice style questions.
- */
-export const answerEliminatorToolRegistration = {
-    toolId: "answerEliminator",
-    name: "Answer Eliminator",
-    description: "Strike through answer choices",
-    icon: "strikethrough",
-    // Answer eliminator appears at item level only
-    supportedLevels: ["item"],
-    // PNP support IDs
-    // Maps to QTI 3.0 standard feature: answerMasking
-    pnpSupportIds: [
-        "answerMasking", // QTI 3.0 standard (assessment.answerMasking)
-        "answerEliminator", // QTI 3.0 standard (assessment.answerEliminator)
-        "strikethrough", // Common variant
-        "choiceMasking", // Common variant
-    ],
-    /**
-     * Pass 2: Answer eliminator is relevant only for choice-based questions
-     */
-    isVisibleInContext(context) {
-        return hasChoiceInteraction(context);
-    },
-    renderToolbar(context, toolbarContext) {
-        const visibility = createScopedVisibilityBinding(this.toolId, toolbarContext);
-        const componentOverrides = toolbarContext.componentOverrides ?? {};
-        const overlay = createToolElement(this.toolId, context, toolbarContext, componentOverrides);
-        overlay.setAttribute("tool-id", visibility.fullToolId);
-        overlay.setAttribute("strategy", "strikethrough");
-        overlay.setAttribute("button-alignment", "inline");
-        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>',
-            disabled: false,
-            ariaLabel: "Answer eliminator - Strike through choices",
-            tooltip: "Strike Through",
-            onClick: () => toolbarContext.toggleTool(this.toolId),
-            active: visibility.isActive(),
-        };
-        return {
-            toolId: this.toolId,
-            button,
-            elements: [{ element: overlay, mount: "after-buttons" }],
-            sync: () => {
-                syncButtonAndOverlayVisibility({
-                    button,
-                    overlay,
-                    isActive: visibility.isActive,
-                });
-                if (toolbarContext.toolCoordinator) {
-                    overlay.coordinator = toolbarContext.toolCoordinator;
-                }
-                overlay.scopeElement = toolbarContext.getScopeElement?.() || null;
-                if (toolbarContext.elementToolStateStore) {
-                    overlay.elementToolStateStore = toolbarContext.elementToolStateStore;
-                }
-                const globalElementId = toolbarContext.getGlobalElementId?.();
-                if (globalElementId) {
-                    overlay.globalElementId = globalElementId;
-                }
-            },
-            subscribeActive: visibility.subscribeActive,
-        };
-    },
-};
-/**
- * Highlighter tool registration
- *
- * Allows students to highlight text in passages and questions.
- * Appears on items with readable text content.
- */
-export const highlighterToolRegistration = {
-    toolId: "highlighter",
-    name: "Highlighter",
-    description: "Highlight text",
-    icon: "highlighter",
-    activation: "toolbar-toggle",
-    // Highlighter appears at passage, rubric, item, and element levels
-    supportedLevels: ["passage", "rubric", "item", "element"],
-    // PNP support IDs
-    pnpSupportIds: ["highlighter", "textHighlight", "annotation"],
-    /**
-     * Pass 2: Highlighter is relevant when readable text is available
-     */
-    isVisibleInContext(context) {
-        return hasReadableText(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: "Highlighter - Highlight text",
-            tooltip: "Highlight",
-            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" }],
-            sync: () => {
-                syncButtonAndOverlayVisibility({
-                    button,
-                    overlay,
-                    isActive: visibility.isActive,
-                    onActiveChange: (active) => {
-                        overlay.enabled = active;
-                    },
-                });
-                if (toolbarContext.ttsService) {
-                    overlay.ttsService = toolbarContext.ttsService;
-                }
-            },
-            subscribeActive: visibility.subscribeActive,
-        };
-    },
-};

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

@@ -1,24 +0,0 @@
-/**
- * Measurement Tools Registrations
- *
- * Registers ruler and protractor tools for on-screen measurements.
- *
- * Maps to QTI 3.0 standard access features:
- * - ruler (assessment tool)
- * - protractor (assessment tool)
- */
-import type { ToolRegistration } from "../../services/ToolRegistry.js";
-/**
- * Ruler tool registration
- *
- * Provides an on-screen ruler for measuring lengths.
- * Typically appears on geometry or measurement problems.
- */
-export declare const rulerToolRegistration: ToolRegistration;
-/**
- * Protractor tool registration
- *
- * Provides an on-screen protractor for measuring angles.
- * Typically appears on geometry problems.
- */
-export declare const protractorToolRegistration: ToolRegistration;

package/dist/tools/registrations/measurement-tools.js

@@ -1,130 +0,0 @@
-/**
- * Measurement Tools Registrations
- *
- * Registers ruler and protractor tools for on-screen measurements.
- *
- * Maps to QTI 3.0 standard access features:
- * - ruler (assessment tool)
- * - protractor (assessment tool)
- */
-import { hasMathContent } from "../../services/tool-context.js";
-import { createToolElement, } from "../tool-tag-map.js";
-import { applyOverlaySurface, createScopedVisibilityBinding, syncButtonAndOverlayVisibility, } from "./toolbar-registration-helpers.js";
-/**
- * Ruler tool registration
- *
- * Provides an on-screen ruler for measuring lengths.
- * Typically appears on geometry or measurement problems.
- */
-export const rulerToolRegistration = {
-    toolId: "ruler",
-    name: "Ruler",
-    description: "On-screen ruler for measurements",
-    icon: "ruler",
-    // Ruler typically appears at section/item/element level
-    supportedLevels: ["section", "item", "element"],
-    // PNP support IDs
-    // Maps to QTI 3.0 standard feature: ruler
-    pnpSupportIds: [
-        "ruler", // QTI 3.0 standard (assessment.ruler)
-        "measurement", // Common variant
-    ],
-    /**
-     * Pass 2: Ruler 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: "Open ruler tool",
-            tooltip: "Ruler",
-            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);
-        applyOverlaySurface(overlay, "frameless");
-        return {
-            toolId: this.toolId,
-            button,
-            elements: [{ element: overlay, mount: "after-buttons" }],
-            sync: () => {
-                syncButtonAndOverlayVisibility({
-                    button,
-                    overlay,
-                    isActive: visibility.isActive,
-                });
-                if (toolbarContext.toolkitCoordinator) {
-                    overlay.toolkitCoordinator = toolbarContext.toolkitCoordinator;
-                }
-            },
-            subscribeActive: visibility.subscribeActive,
-        };
-    },
-};
-/**
- * Protractor tool registration
- *
- * Provides an on-screen protractor for measuring angles.
- * Typically appears on geometry problems.
- */
-export const protractorToolRegistration = {
-    toolId: "protractor",
-    name: "Protractor",
-    description: "On-screen protractor for angle measurements",
-    icon: "protractor",
-    // Protractor typically appears at section/item/element level
-    supportedLevels: ["section", "item", "element"],
-    // PNP support IDs
-    // Maps to QTI 3.0 standard feature: protractor
-    pnpSupportIds: [
-        "protractor", // QTI 3.0 standard (assessment.protractor)
-        "angleMeasurement", // Common variant
-    ],
-    /**
-     * Pass 2: Protractor 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: "Open protractor tool",
-            tooltip: "Protractor",
-            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);
-        applyOverlaySurface(overlay, "frameless");
-        return {
-            toolId: this.toolId,
-            button,
-            elements: [{ element: overlay, mount: "after-buttons" }],
-            sync: () => {
-                syncButtonAndOverlayVisibility({
-                    button,
-                    overlay,
-                    isActive: visibility.isActive,
-                });
-                if (toolbarContext.toolkitCoordinator) {
-                    overlay.toolkitCoordinator = toolbarContext.toolkitCoordinator;
-                }
-            },
-            subscribeActive: visibility.subscribeActive,
-        };
-    },
-};

package/dist/tools/registrations/subject-specific-tools.d.ts

@@ -1,27 +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 type { ToolRegistration } from "../../services/ToolRegistry.js";
-/**
- * Graph tool registration
- *
- * Provides graphing calculator and coordinate plane functionality.
- * Context-smart: appears automatically for math content or when explicitly enabled.
- */
-export declare const graphToolRegistration: ToolRegistration;
-/**
- * Periodic Table tool registration
- *
- * Provides chemistry periodic table reference.
- * Context-smart: appears automatically for science content or when explicitly enabled.
- */
-export declare const periodicTableToolRegistration: ToolRegistration;