@myrmidon/gve-snapshot-rendition 2.0.4 → 2.0.6

package/dist/src/settings/settings.d.ts

@@ -1,118 +0,0 @@
-import { OperationHint } from "./hint-models";
-/**
- * Settings for a custom button added to the toolbar.
- */
-export interface CustomButtonSettings {
-    /** Unique ID for the custom button */
-    id: string;
-    /** Icon to use for the button (can be emoji, Unicode symbol, or HTML) */
-    icon: string;
-    /** Text label for the button */
-    label: string;
-    /** Tooltip shown on hover */
-    tooltip: string;
-    /** Callback invoked when button is pressed */
-    callback: (id: string, svg: SVGElement) => void;
-}
-/**
- * Settings for the GVE Snapshot Rendition component.
- */
-export interface GveRenditionSettings {
-    /** Default font size in pixels */
-    fontSize: number;
-    /** Default font family */
-    fontFamily: string;
-    /** Default foreground color */
-    foreColor: string;
-    /** Default background color */
-    backColor: string;
-    /** Default italic state */
-    italic: boolean;
-    /** Default bold state */
-    bold: boolean;
-    /** Default underline thickness in pixels (undefined = no underline) */
-    underline?: number;
-    /** Default overline thickness in pixels (undefined = no overline) */
-    overline?: number;
-    /** Default strikethrough thickness in pixels (undefined = no strike) */
-    strike?: number;
-    /** Fraction of reference character width to use for space width (default: 0.33) */
-    spaceWidthFraction: number;
-    /** Spacing between each character in pixels */
-    charSpacing: number;
-    /** Line height multiplier (1.5 = 150% of font size) */
-    lineHeight: number;
-    /** Additional spacing between lines in pixels */
-    lineSpacing: number;
-    /** Top margin of the text rendition area in pixels */
-    marginTop: number;
-    /** Left margin of the text rendition area in pixels */
-    marginLeft: number;
-    /** Right margin of the text rendition area in pixels */
-    marginRight: number;
-    /** Bottom margin of the text rendition area in pixels */
-    marginBottom: number;
-    /** Initial zoom factor */
-    initialZoom: number;
-    /** Minimum zoom factor */
-    minZoom: number;
-    /** Maximum zoom factor */
-    maxZoom: number;
-    /** Zoom step for zoom in/out */
-    zoomStep: number;
-    /** Milliseconds between each frame in slideshow mode */
-    slideshowInterval: number;
-    /** Whether to loop the slideshow when it ends */
-    slideshowLoop: boolean;
-    /** Milliseconds delay between slideshow restarts (when looping) */
-    slideshowDelay: number;
-    /** Automatically continue forward through operations with the same groupId */
-    autoForwardOnGroup: boolean;
-    /** Enable detailed logging for diagnostic purposes */
-    debug?: boolean;
-    /** Array of custom buttons to add to the toolbar */
-    customButtons?: CustomButtonSettings[];
-    /** Array of button IDs (including custom buttons) to disable */
-    disabledButtonIds?: string[];
-    /** Catalog of animation JS code fragments, keyed by ID */
-    animations: Record<string, string>;
-    /** ID of animation to use for each character (from animations catalog) */
-    charAnimationId?: string;
-    /** Duration in milliseconds for element fade-out animation
-     * (backward navigation only): 0=no animation */
-    backwardFadeOutTime: number;
-    /** Duration in milliseconds for prolog panning animation when added
-     * elements would be outside viewport (0=no animation) */
-    prologDuration: number;
-    /** Dictionary of hints, keyed by hint ID */
-    hints: Record<string, OperationHint>;
-    /** Design-time width used when creating hints */
-    hintDesignWidth: number;
-    /** Design-time height used when creating hints */
-    hintDesignHeight: number;
-    /** Show the handle element from SVG hint (for diagnostic purposes) */
-    showHintHandles: boolean;
-    /** Padding to increase hilite rectangle size in pixels */
-    hilitePadding: number;
-    /** Duration in milliseconds for hilite fade in/out animation */
-    hiliteFadeTime: number;
-    /** Font family for the version text pane */
-    textPaneFontFamily: string;
-    /** Font size for the version text pane in pixels */
-    textPaneFontSize: number;
-    /** Function to generate operation summary HTML from data, version tag,
-     *  and summary service */
-    opSummaryFn?: (data: any, versionTag: string, summaryService: any) => string;
-    /** Reference glyph width in pixels for scaling hovered text elements */
-    refGlyphWidth: number;
-    /** Reference glyph height in pixels for scaling hovered text elements */
-    refGlyphHeight: number;
-    /** Array of feature names to hide when "hidden features" option is not checked */
-    hiddenFeatures?: string[];
-    /** Optional map of version tag to color (e.g., {v0: '#FFE4E1', v1: '#E1FFE4'}) */
-    versionColors?: Record<string, string>;
-}
-/**
- * Default settings for the component.
- */
-export declare const DEFAULT_SETTINGS: GveRenditionSettings;

package/dist/src/ui/details-area.d.ts

@@ -1,112 +0,0 @@
-import { GveRenditionSettings } from "../settings/settings";
-import { Logger } from "../core/logger";
-import { CharChainResult, CharNode } from "../models";
-/**
- * Details area component - displays operation metadata and hovered element details.
- */
-export declare class DetailsArea {
-    private container;
-    private operationSection;
-    private versionFeaturesSection;
-    private hoveredElementsSection;
-    private hiddenFeaturesCheckbox;
-    private collapseBtn;
-    private resizeHandle;
-    private _settings;
-    private _logger;
-    private _summaryService;
-    private _isCollapsed;
-    private _showHiddenFeatures;
-    private _data;
-    private _currentVersionTag;
-    private _isResizing;
-    private _initialHeight;
-    private _initialMouseY;
-    private _isPinned;
-    private _pinnedElements;
-    constructor(settings: GveRenditionSettings, logger: Logger);
-    create(): HTMLElement;
-    /**
-     * Replace feather icon placeholders with actual SVG icons.
-     */
-    private replaceFeatherIcons;
-    /**
-     * Attach event listeners.
-     */
-    private attachEventListeners;
-    /**
-     * Start resizing the details area.
-     */
-    private startResize;
-    /**
-     * Handle resize drag.
-     */
-    private handleResize;
-    /**
-     * Stop resizing the details area.
-     */
-    private stopResize;
-    /**
-     * Toggle collapse/expand state.
-     */
-    private toggleCollapse;
-    /**
-     * Update the details area with version information.
-     * @param data - The CharChainResult data
-     * @param versionTag - The version tag (e.g., "v0", "v1")
-     */
-    updateVersion(data: CharChainResult | null, versionTag: string): void;
-    /**
-     * Update the operation section with operation summary and features.
-     */
-    private updateOperationSection;
-    /**
-     * Update the version features section with global features.
-     */
-    private updateVersionFeaturesSection;
-    /**
-     * Update the hovered elements section.
-     * @param hoveredElements - Array of hovered text SVG elements with their node data
-     */
-    updateHoveredElements(hoveredElements: Array<{
-        element: SVGTextElement;
-        node: CharNode;
-        versionTag: string;
-    }>): void;
-    /**
-     * Render hovered elements with pin button.
-     */
-    private renderHoveredElements;
-    /**
-     * Toggle pin state.
-     */
-    private togglePin;
-    /**
-     * Pin a specific element (triggered by click).
-     */
-    pinElement(element: SVGTextElement, node: CharNode, versionTag: string): void;
-    /**
-     * Filter features based on hidden features setting.
-     */
-    private filterFeatures;
-    /**
-     * Render a list of features as HTML.
-     */
-    private renderFeatureList;
-    /**
-     * Get version index from version tag.
-     */
-    private getVersionIndex;
-    /**
-     * Escape HTML special characters.
-     */
-    private escapeHtml;
-    /**
-     * Clear all sections.
-     */
-    clear(): void;
-    /**
-     * Update settings.
-     */
-    updateSettings(settings: GveRenditionSettings): void;
-}

package/dist/src/ui/hilites.d.ts

@@ -1,63 +0,0 @@
-import { Logger } from "../core/logger";
-/**
- * Hilites manager - handles creating and animating hilite rectangles.
- */
-export declare class Hilites {
-    private _logger;
-    private _rootSvg;
-    private _hilitesGroup;
-    private _activeHilites;
-    private _hilitePadding;
-    private _hiliteFadeTime;
-    constructor(logger: Logger, hilitePadding: number, hiliteFadeTime: number);
-    /**
-     * Set root SVG element reference.
-     */
-    setRootSvg(rootSvg: SVGSVGElement): void;
-    /**
-     * Update settings.
-     */
-    updateSettings(hilitePadding: number, hiliteFadeTime: number): void;
-    /**
-     * Show hilites for a specific version.
-     * @param nodeIds - IDs of nodes to hilite (from versionNodeIds[versionTag])
-     * @param versionTag - Version tag label (for logging)
-     * @param color - Hilite color
-     */
-    showHilites(nodeIds: number[], versionTag: string, color: string): Promise<void>;
-    /**
-     * Clear all hilites.
-     */
-    clearHilites(): Promise<void>;
-    /**
-     * Create a hilite rectangle for a text element.
-     *
-     * IMPORTANT: Since hilites are now placed in the same container (viewport group)
-     * as the text elements, they share the same coordinate space and transforms.
-     * This means getBBox() gives us the correct relative coordinates, and the
-     * hilites will automatically pan/zoom with the text when PROLOG is triggered.
-     */
-    private createHiliteRect;
-    /**
-     * Animate hilites in using GSAP.
-     */
-    private animateHilitesIn;
-    /**
-     * Animate hilites out using GSAP.
-     */
-    private animateHilitesOut;
-    /**
-     * Check if hilites are currently active.
-     */
-    hasActiveHilites(): boolean;
-    /**
-     * Get the SVG container where hilites should be added.
-     * When svg-pan-zoom is active, this returns the viewport group.
-     * Otherwise, returns the root SVG.
-     *
-     * CRITICAL: svg-pan-zoom wraps all content in a <g> viewport element.
-     * Hilites MUST be added to this group, not the root SVG, so they
-     * transform with the content when PROLOG panning occurs.
-     */
-    private getSvgContainer;
-}

package/dist/src/ui/operation-summary-service.d.ts

@@ -1,73 +0,0 @@
-import { CharChainResult, CharNode, ChainOperationContextStep, OperationType } from "../models";
-import { Logger } from "../core/logger";
-/**
- * Service for building operation summaries.
- * Provides helper functions to extract and format operation data.
- */
-export declare class OperationSummaryService {
-    private _logger;
-    private _data;
-    constructor(logger: Logger);
-    /**
-     * Update the data reference.
-     */
-    setData(data: CharChainResult | null): void;
-    /**
-     * Get operation by version tag.
-     * @param versionTag - Version tag (e.g., "v1", "v2")
-     * @returns The step containing the operation, or null
-     */
-    getStepByVersionTag(versionTag: string): ChainOperationContextStep | null;
-    /**
-     * Get operation by ID.
-     * @param operationId - Operation ID
-     * @returns The step containing the operation, or null
-     */
-    getStepByOperationId(operationId: string): ChainOperationContextStep | null;
-    /**
-     * Get text from a node ID by searching in version tagged nodes.
-     * @param nodeId - Node ID
-     * @param versionTag - Version tag to search in (searches backwards if not found)
-     * @returns The node's text, or empty string
-     */
-    getNodeText(nodeId: number, versionTag: string): string;
-    /**
-     * Get a node by ID from the flat nodes array.
-     * All nodes (including deleted ones) are always present.
-     *
-     * @param nodeId - Node ID
-     * @param versionTag - Unused in new model; kept for API compatibility
-     * @returns The node, or null
-     */
-    getNode(nodeId: number, versionTag?: string): CharNode | null;
-    /**
-     * Get text from a span of nodes.
-     * @param nodeIds - Array of node IDs
-     * @param versionTag - Version tag
-     * @returns Concatenated text
-     */
-    getSpanText(nodeIds: number[], versionTag: string): string;
-    /**
-     * Get context text around a node or span, including the affected text.
-     * Extends context to word boundaries (space or LF) after collecting minimum characters.
-     * @param nodeIds - Node IDs of the target span (used when atAsIndex is false)
-     * @param versionTag - Version tag
-     * @param atValue - The 'at' value from the operation (node ID or index depending on atAsIndex)
-     * @param atAsIndex - Whether 'at' is an index (true) or node ID (false)
-     * @param contextSize - Minimum number of characters before/after (default: 20)
-     * @returns Context text including the affected span
-     */
-    getContext(nodeIds: number[], versionTag: string, atValue?: number, atAsIndex?: boolean, contextSize?: number): string;
-    /**
-     * Get the operation type as a readable string.
-     */
-    getOperationTypeName(type: OperationType): string;
-    /**
-     * Get version index from version tag.
-     */
-    private getVersionIndex;
-    /**
-     * Escape HTML special characters.
-     */
-    escapeHtml(text: string): string;
-}

package/dist/src/ui/toolbar.d.ts

@@ -1,141 +0,0 @@
-import { CharChainResult } from "../models";
-import { CustomButtonSettings } from "../settings/settings";
-/**
- * Comprehensive toolbar component for version navigation, slideshow, zoom, and custom actions.
- */
-export declare class Toolbar {
-    private container;
-    private firstBtn;
-    private prevBtn;
-    private prevStagedBtn;
-    private nextStagedBtn;
-    private nextBtn;
-    private lastBtn;
-    private versionLabel;
-    private groupBadge;
-    private logDisplay;
-    private slideshowStartBtn;
-    private slideshowStopBtn;
-    private slideshowReverseBtn;
-    private autoForwardBtn;
-    private zoomInBtn;
-    private zoomOutBtn;
-    private fitBtn;
-    private downloadBtn;
-    private resetLayoutBtn;
-    private _data;
-    private _currentVersionIndex;
-    private _customButtons;
-    private _disabledButtonIds;
-    private _slideshowReverse;
-    private _autoForwardEnabled;
-    /**
-     * Get slideshow reverse state.
-     */
-    getSlideshowReverse(): boolean;
-    constructor(container: HTMLElement);
-    /**
-     * Render toolbar UI elements.
-     */
-    private render;
-    /**
-     * Replace feather icon placeholders with actual SVG icons.
-     */
-    private replaceFeatherIcons;
-    /**
-     * Attach event listeners to buttons.
-     */
-    private attachEventListeners;
-    /**
-     * Render custom buttons from settings.
-     */
-    private renderCustomButtons;
-    /**
-     * Update button states and version label.
-     */
-    private updateButtons;
-    /**
-     * Update version label with current version information.
-     */
-    private updateVersionLabel;
-    /**
-     * Update the log display with the current operation's log feature.
-     */
-    private updateLogDisplay;
-    /**
-     * Get version information for current step.
-     */
-    private getVersionInfo;
-    /**
-     * Check if there is a previous staged version.
-     */
-    private hasPrevStagedVersion;
-    /**
-     * Check if there is a next staged version.
-     */
-    private hasNextStagedVersion;
-    /**
-     * Update slideshow reverse button appearance.
-     */
-    private updateSlideshowReverseButton;
-    /**
-     * Update auto-forward button visual state.
-     */
-    private updateAutoForwardButton;
-    /**
-     * Apply disabled state to buttons from settings.
-     */
-    private applyDisabledButtons;
-    /**
-     * Dispatch navigation event for parent component to handle.
-     */
-    private dispatchNavigationEvent;
-    /**
-     * Dispatch slideshow event for parent component to handle.
-     */
-    private dispatchSlideshowEvent;
-    /**
-     * Dispatch auto-forward event for parent component to handle.
-     */
-    private dispatchAutoForwardEvent;
-    /**
-     * Dispatch display event for parent component to handle.
-     */
-    private dispatchDisplayEvent;
-    /**
-     * Dispatch layout event for parent component to handle.
-     */
-    private dispatchLayoutEvent;
-    /**
-     * Update data reference (for staged version detection).
-     */
-    updateData(data: CharChainResult | null): void;
-    /**
-     * Set current version index (for external updates).
-     */
-    setCurrentIndex(index: number): void;
-    /**
-     * Get current version index.
-     */
-    getCurrentIndex(): number;
-    /**
-     * Set custom buttons from settings.
-     */
-    setCustomButtons(customButtons: CustomButtonSettings[]): void;
-    /**
-     * Set disabled button IDs from settings.
-     */
-    setDisabledButtons(disabledButtonIds: string[]): void;
-    /**
-     * Set slideshow active state (show/hide start/stop buttons).
-     */
-    setSlideshowActive(active: boolean): void;
-    /**
-     * Disable all navigation buttons (e.g., during slideshow).
-     */
-    setNavigationDisabled(disabled: boolean): void;
-    /**
-     * Set auto-forward enabled state and update button appearance.
-     */
-    setAutoForwardEnabled(enabled: boolean): void;
-}

package/dist/src/ui/version-text-area.d.ts

@@ -1,131 +0,0 @@
-import { GveRenditionSettings } from "../settings/settings";
-import { Logger } from "../core/logger";
-/**
- * Version text area component - displays plain text for current version.
- * Can be collapsed/expanded and includes toolbar for text manipulation.
- * Now includes previous text (Text B), pinning, and diff view.
- */
-export declare class VersionTextArea {
-    private container;
-    private textAreaA;
-    private textAreaB;
-    private diffPanel;
-    private textPanelA;
-    private textPanelB;
-    private textPanelDiff;
-    private copyBtn;
-    private wrapBtn;
-    private increaseFontBtn;
-    private decreaseFontBtn;
-    private pinBtn;
-    private diffDirectionBtn;
-    private collapseBtn;
-    private resizeHandle;
-    private _settings;
-    private _logger;
-    private _isCollapsed;
-    private _wordWrap;
-    private _currentFontSize;
-    private _isDragging;
-    private _startY;
-    private _startHeight;
-    private _isPinned;
-    private _diffDirection;
-    private _previousText;
-    private _panelResizing;
-    constructor(settings: GveRenditionSettings, logger: Logger);
-    /**
-     * Create and return the version text area container.
-     */
-    create(): HTMLElement;
-    /**
-     * Replace feather icon placeholders with actual SVG icons.
-     */
-    private replaceFeatherIcons;
-    /**
-     * Apply text styles from settings.
-     */
-    private applyTextStyles;
-    /**
-     * Attach event listeners to toolbar buttons.
-     */
-    private attachEventListeners;
-    /**
-     * Copy current text (A) to clipboard.
-     */
-    private copyText;
-    /**
-     * Toggle word wrap for text areas.
-     */
-    private toggleWordWrap;
-    /**
-     * Increase font size.
-     */
-    private increaseFontSize;
-    /**
-     * Decrease font size.
-     */
-    private decreaseFontSize;
-    /**
-     * Toggle pin state for previous text (B).
-     */
-    private togglePin;
-    /**
-     * Toggle diff direction (B→A or A→B).
-     */
-    private toggleDiffDirection;
-    /**
-     * Toggle collapse/expand state.
-     */
-    private toggleCollapse;
-    /**
-     * Update the displayed text.
-     * @param text - The plain text to display
-     */
-    updateText(text: string): void;
-    /**
-     * Update the diff panel.
-     */
-    private updateDiff;
-    /**
-     * Render diff results as HTML.
-     * @param diffs - Array of diff operations
-     */
-    private renderDiff;
-    /**
-     * Escape HTML special characters.
-     */
-    private escapeHtml;
-    /**
-     * Clear the text area.
-     */
-    clear(): void;
-    /**
-     * Update settings.
-     */
-    updateSettings(settings: GveRenditionSettings): void;
-    /**
-     * Start resize operation.
-     */
-    private startResize;
-    /**
-     * Handle resize during drag.
-     */
-    private handleResize;
-    /**
-     * End resize operation.
-     */
-    private endResize;
-    /**
-     * Start panel resize operation.
-     */
-    private startPanelResize;
-    /**
-     * Handle panel resize during drag.
-     */
-    private handlePanelResize;
-    /**
-     * End panel resize operation.
-     */
-    private endPanelResize;
-}