@myrmidon/gve-snapshot-rendition 2.0.5 → 2.0.7

package/dist/src/animation/animation-engine.d.ts

@@ -1,105 +0,0 @@
-import { Logger } from "../core/logger";
-import { AnimationFactory, AnimationFunction } from "./animation-factory";
-/**
- * Animation engine that wraps GSAP and provides a consistent API.
- */
-export declare class AnimationEngine {
-    private _gsap;
-    private _logger;
-    private _factory;
-    constructor(gsap: any, logger: Logger);
-    /**
-     * Get the animation factory.
-     */
-    getFactory(): AnimationFactory;
-    /**
-     * Animate an element with an animation function.
-     *
-     * @param element - The target SVG element
-     * @param animation - The animation function to execute
-     * @param rootElement - The root SVG element
-     * @returns Promise that resolves when animation completes
-     */
-    animate(element: SVGElement, animation: AnimationFunction, rootElement: SVGElement): Promise<void>;
-    /**
-     * Fade in multiple elements (used for hilites).
-     *
-     * @param elements - Array of elements to fade in
-     * @param duration - Duration in milliseconds
-     * @returns Promise that resolves when animation completes
-     */
-    fadeIn(elements: SVGElement[], duration: number): Promise<void>;
-    /**
-     * Fade out multiple elements (used for hilites).
-     *
-     * @param elements - Array of elements to fade out
-     * @param duration - Duration in milliseconds
-     * @returns Promise that resolves when animation completes
-     */
-    fadeOut(elements: SVGElement[], duration: number): Promise<void>;
-    /**
-     * Animate pan and zoom transition.
-     *
-     * @param panZoomInstance - The svg-pan-zoom instance
-     * @param newPan - New pan coordinates {x, y}
-     * @param newZoom - New zoom level
-     * @param duration - Duration in milliseconds
-     * @returns Promise that resolves when animation completes
-     */
-    animatePanZoom(panZoomInstance: any, newPan: {
-        x: number;
-        y: number;
-    }, newZoom: number, duration: number): Promise<void>;
-    /**
-     * Animate prolog panning to make an element visible.
-     * This gracefully pans the viewport so there is room to display an element
-     * that would otherwise fall outside the visible area.
-     *
-     * @param panZoomInstance - The svg-pan-zoom instance
-     * @param elementBounds - Bounding rectangle of the element to make visible
-     * @param viewportWidth - Width of the visible viewport
-     * @param viewportHeight - Height of the visible viewport
-     * @param duration - Duration in milliseconds
-     * @returns Promise that resolves when animation completes
-     */
-    animateProlog(panZoomInstance: any, elementBounds: {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    }, viewportWidth: number, viewportHeight: number, duration: number): Promise<void>;
-    /**
-     * Calculate the pan adjustment needed to make an element visible.
-     * Returns null if the element is already fully visible.
-     *
-     * @param elementBounds - Bounding rectangle of the element in SVG coordinates
-     * @param panZoomInstance - The svg-pan-zoom instance
-     * @param viewportWidth - Width of the visible viewport
-     * @param viewportHeight - Height of the visible viewport
-     * @returns New pan coordinates or null if no adjustment needed
-     */
-    private calculatePrologPan;
-    /**
-     * Check if an element is fully visible in the current viewport.
-     *
-     * @param elementBounds - Bounding rectangle of the element in SVG coordinates
-     * @param panZoomInstance - The svg-pan-zoom instance
-     * @param viewportWidth - Width of the visible viewport
-     * @param viewportHeight - Height of the visible viewport
-     * @returns True if element is fully visible, false otherwise
-     */
-    isElementVisible(elementBounds: {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    }, panZoomInstance: any, viewportWidth: number, viewportHeight: number): boolean;
-    /**
-     * Kill all active animations.
-     */
-    killAll(): void;
-    /**
-     * Get the GSAP instance.
-     */
-    getGsap(): any;
-}

package/dist/src/animation/animation-factory.d.ts

@@ -1,49 +0,0 @@
-import { Logger } from "../core/logger";
-/**
- * Animation function signature.
- * Receives gsap instance, target element, and root SVG element.
- * Returns a Promise that resolves when animation completes.
- */
-export type AnimationFunction = (gsap: any, targetEl: SVGElement, rootEl: SVGElement) => Promise<void>;
-/**
- * Factory for creating animation functions from code strings.
- * This wraps user-provided GSAP animation code into executable functions.
- */
-export declare class AnimationFactory {
-    private _logger;
-    private _gsap;
-    constructor(gsap: any, logger: Logger);
-    /**
-     * Create an animation function from a code string.
-     *
-     * @param code - The JavaScript code as a string that uses GSAP
-     * @param label - Optional label for debugging
-     * @returns An animation function that returns a Promise
-     */
-    createAnimation(code: string, label?: string): AnimationFunction;
-    /**
-     * Create an animation function from an ID reference.
-     * The ID should exist in the animations catalog.
-     *
-     * @param animationId - The ID of the animation (with or without # prefix)
-     * @param animationsCatalog - The catalog of animations from settings
-     * @param label - Optional label for debugging
-     * @returns An animation function or undefined if not found
-     */
-    createAnimationFromId(animationId: string, animationsCatalog: Record<string, string>, label?: string): AnimationFunction | undefined;
-    /**
-     * Resolve an animation property value to an animation function.
-     * Handles both direct code strings and ID references.
-     *
-     * @param animationValue - Either a code string or an ID reference (starting with #)
-     * @param animationsCatalog - The catalog of animations from settings
-     * @param label - Optional label for debugging
-     * @returns An animation function or undefined
-     */
-    resolveAnimation(animationValue: string | undefined, animationsCatalog: Record<string, string>, label?: string): AnimationFunction | undefined;
-    /**
-     * Create a no-op animation that resolves immediately.
-     * Used when no animation is specified.
-     */
-    createNoOpAnimation(): AnimationFunction;
-}

package/dist/src/core/color-palette.d.ts

@@ -1,39 +0,0 @@
-/**
- * Generate a pastel color palette for version tags with maximum visual distinction.
- * Uses HSL color space to generate evenly distributed, light, pastel colors.
- */
-export declare class ColorPalette {
-    private colors;
-    /**
-     * Generate a pastel color for a given version tag.
-     * The color generation is idempotent - same version tag always generates the same color.
-     * @param versionTag - Version tag (e.g., "v0", "v1", "v2")
-     * @returns Pastel color as hex string (e.g., "#FFE4E1")
-     */
-    getColor(versionTag: string): string;
-    /**
-     * Extract version number from version tag.
-     * @param versionTag - Version tag like "v0", "v1", etc.
-     * @returns Version number
-     */
-    private extractVersionNumber;
-    /**
-     * Generate a pastel color using HSL color space with golden ratio distribution.
-     * This ensures maximum visual distinction between colors.
-     * @param index - Version index number
-     * @returns Hex color string
-     */
-    private generatePastelColor;
-    /**
-     * Convert HSL to hex color.
-     * @param h - Hue (0-360)
-     * @param s - Saturation (0-100)
-     * @param l - Lightness (0-100)
-     * @returns Hex color string
-     */
-    private hslToHex;
-    /**
-     * Clear all cached colors.
-     */
-    clear(): void;
-}

package/dist/src/core/gve-snapshot-rendition.d.ts

@@ -1,359 +0,0 @@
-import { CharChainResult } from "../models";
-import { GveRenditionSettings } from "../settings/settings";
-/**
- * Relative position for elements (hints and additional text) with respect to the RBR.
- * Specifies how the EBR (Element Bounding Rectangle) aligns with the RBR (Reference Bounding Rectangle).
- */
-export type RelativePosition = "n" | "ne" | "e" | "se" | "s" | "sw" | "w" | "nw" | "inw" | "ine" | "isw" | "ise" | "o";
-/**
- * GVE Snapshot Rendition Web Component.
- * Renders interactive text transformations from snapshot model data.
- */
-export declare class GveSnapshotRendition extends HTMLElement {
-    private _settings;
-    private _data?;
-    private _versionTag?;
-    private _logger;
-    private _animationEngine?;
-    private _boundsCache;
-    private _textRenderer?;
-    private _hintRenderer?;
-    private _featureResolver;
-    private _shadow;
-    private _rootSvg?;
-    private _container?;
-    private _toolbar?;
-    private _versionTextArea?;
-    private _detailsArea?;
-    private _versionsListArea?;
-    private _hilites?;
-    private _panZoomInstance?;
-    private _keyboardHandler?;
-    private _goldenLayout?;
-    private _versionsListEl?;
-    private _svgContainerEl?;
-    private _versionTextEl?;
-    private _detailsEl?;
-    /**
-     * Get the library version.
-     * This value is injected at build time via @rollup/plugin-replace
-     * from package.json. It allows consumers to verify which version
-     * of the web component is loaded.
-     */
-    static get version(): string;
-    private _baseNodes;
-    private _nodeMap;
-    private _slideshowTimerId;
-    private _currentVersion;
-    private _currentVersionIndex;
-    private _autoForwardEnabled;
-    private _autoForwardTimerId;
-    private _renderScheduled;
-    constructor();
-    /**
-     * Observed attributes for the web component.
-     */
-    static get observedAttributes(): string[];
-    /**
-     * Called when component is added to the DOM.
-     */
-    connectedCallback(): void;
-    /**
-     * Called when component is removed from the DOM.
-     */
-    disconnectedCallback(): void;
-    /**
-     * Called when observed attributes change.
-     */
-    attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
-    /**
-     * Settings property (bindable).
-     */
-    get settings(): GveRenditionSettings;
-    set settings(value: GveRenditionSettings);
-    /**
-     * Data property (bindable).
-     */
-    get data(): CharChainResult | undefined;
-    set data(value: CharChainResult | undefined);
-    /**
-     * Version tag property (bindable).
-     */
-    get versionTag(): string | undefined;
-    set versionTag(value: string | undefined);
-    /**
-     * Initialize GSAP when available.
-     */
-    private initializeGsap;
-    /**
-     * Process data to prepare for rendering.
-     */
-    private processData;
-    /**
-     * Render the component UI.
-     */
-    private render;
-    /**
-     * Wire up the drag-to-resize handle at the bottom of the component.
-     * Dragging it adjusts the host element's inline height, which overrides
-     * the --gve-height CSS variable while keeping GL's ResizeObserver in sync.
-     */
-    private setupBottomResizeHandle;
-    /**
-     * Initialize Golden Layout with the four resizable panels.
-     * The SVG rendition panel has no header and acts as the fixed background.
-     */
-    private initializeGoldenLayout;
-    /**
-     * Default layout: mirrors the original Split.js arrangement.
-     *  Column:
-     *    Row (60 %): VersionsList (15 %) | TextRendition (85 %, no header)
-     *    Row (40 %): VersionText (60 %)  | Details (40 %)
-     */
-    private getDefaultLayout;
-    /**
-     * Reset layout to default panel sizes by reloading the default config.
-     */
-    resetLayout(): void;
-    /**
-     * Coalesce concurrent render requests into a single call.
-     * Multiple same-turn invocations (e.g. settings setter + data setter both
-     * firing in the same Angular expression) collapse into one microtask render,
-     * always running after all synchronous assignments have completed so the
-     * latest data is used.
-     */
-    private scheduleRenderContent;
-    /**
-     * Render content (base text only - starts at v0).
-     * Use goToVersionIndex() to navigate to specific versions.
-     */
-    private renderContent;
-    /**
-     * Initialize pan/zoom functionality on the SVG element.
-     * Enables mouse wheel zoom, click-and-drag pan, with configurable limits.
-     */
-    private initializePanZoom;
-    /**
-     * Process a single operation step.
-     */
-    private processOperation;
-    /**
-     * Internal operation processing (called with pan/zoom disabled).
-     */
-    private processOperationInternal;
-    /**
-     * Get reference nodes for an operation from the flat node map.
-     * All nodes (including deleted ones) are always present in the map.
-     *
-     * @param nodeIds - Array of node IDs from step.refNodeIds
-     * @param inputTag - Kept for API compatibility; unused in new model
-     * @returns Array of CharNode objects matching the IDs
-     */
-    private getReferenceNodes;
-    /**
-     * Get nodes added by a specific operation.
-     * Nodes added by an operation carry an `opid` feature in their per-version
-     * features for the output tag.
-     *
-     * @param operationId - The operation ID to match
-     * @param outputTag - The output version tag (e.g., "v3") where the nodes were added
-     * @returns Array of nodes added by this operation
-     */
-    private getAddedNodes;
-    /**
-     * Render hints for an operation.
-     */
-    private renderHints;
-    /**
-     * Navigate to a specific version index (0 = base text, 1+ = after operations).
-     * Uses accumulation model: forward adds elements, backward removes them.
-     */
-    private goToVersionIndex;
-    /**
-     * Update the version text area with the current version's text.
-     * @param versionIndex - The version index (0 = base text)
-     */
-    private updateVersionText;
-    /**
-     * Update the details area with the current version's information.
-     * @param versionIndex - The version index (0 = base text)
-     */
-    private updateDetailsArea;
-    /**
-     * Set up hover listeners on all text elements to update details area.
-     */
-    private setupTextElementHoverListeners;
-    /**
-     * Get the node from the node map by its SVG element ID.
-     * Returns the node and the version tag at which to read its features.
-     */
-    private getNodeForElement;
-    /**
-     * Handle hover over a text element.
-     */
-    private handleTextElementHover;
-    /**
-     * Handle leaving a text element.
-     */
-    private handleTextElementLeave;
-    /**
-     * Handle click on a text element (for pinning).
-     */
-    private handleTextElementClick;
-    /**
-     * Navigate forward by processing operations one by one.
-     * Each operation adds hints and/or text that persist for all future versions.
-     */
-    private navigateForward;
-    /**
-     * Navigate backward by removing elements added in later versions.
-     * Reverses operations from current down to target.
-     */
-    private navigateBackward;
-    /**
-     * Remove all elements belonging to a specific version.
-     * Optionally fades them out before removal based on settings.
-     */
-    private removeVersionElements;
-    /**
-     * Extract char offsets from first operation if it's an annotate.
-     */
-    private extractCharOffsets;
-    /**
-     * Extract per-node rendition configs from the first operation if it's an annotate.
-     * This allows init features like r_font-size, r_fore-color, etc. to override
-     * the component-wide settings for specific base text nodes.
-     */
-    private extractInitNodeConfigs;
-    /**
-     * Zoom in by configured step amount.
-     */
-    zoomIn(): void;
-    /**
-     * Zoom out by configured step amount.
-     */
-    zoomOut(): void;
-    /**
-     * Reset zoom to 100% and center pan.
-     */
-    resetZoom(): void;
-    /**
-     * Set zoom to specific level (1.0 = 100%).
-     */
-    setZoom(zoomLevel: number): void;
-    /**
-     * Get current zoom level.
-     */
-    getZoom(): number;
-    /**
-     * Update toolbar with current zoom level.
-     */
-    private updateToolbarZoom;
-    /**
-     * Handle toolbar navigation actions.
-     */
-    private handleToolbarNavigation;
-    /**
-     * Returns true when the given version tag is a staged version.
-     * Checks globalFeatures (from new API) for a "version" feature.
-     */
-    private isStagedVersion;
-    /**
-     * Navigate to previous staged version.
-     */
-    private goToPrevStagedVersion;
-    /**
-     * Navigate to next staged version.
-     */
-    private goToNextStagedVersion;
-    /**
-     * Handle toolbar slideshow actions.
-     */
-    private handleToolbarSlideshow;
-    /**
-     * Handle toolbar display actions.
-     */
-    private handleToolbarDisplay;
-    /**
-     * Fit SVG to view (center and zoom to fit all content).
-     */
-    private fitToView;
-    /**
-     * Download SVG as a file.
-     */
-    private downloadSVG;
-    /**
-     * Start slideshow mode.
-     */
-    private startSlideshow;
-    /**
-     * Stop slideshow mode.
-     */
-    private stopSlideshow;
-    /**
-     * Advance slideshow by one frame.
-     */
-    private slideshowAdvance;
-    /**
-     * Check if the current version belongs to a group and trigger auto-forward if needed.
-     * Auto-forward continues to the next version after a delay, as long as operations
-     * share the same groupId.
-     *
-     * @param versionIndex - The current version index (just navigated to)
-     */
-    private checkAndTriggerAutoForward;
-    /**
-     * Stop any pending auto-forward timer.
-     */
-    private stopAutoForward;
-    /**
-     * Toggle auto-forward on group feature.
-     * @param enabled - Whether to enable auto-forward
-     */
-    setAutoForwardEnabled(enabled: boolean): void;
-    /**
-     * Get current auto-forward enabled state.
-     */
-    getAutoForwardEnabled(): boolean;
-    /**
-     * Setup keyboard shortcuts for navigation and zoom.
-     * Shortcuts:
-     * - ArrowLeft/ArrowRight: Previous/Next version
-     * - Home/End: First/Last version
-     * - 0-9: Jump to version 0-9
-     * - +/-: Zoom in/out
-     */
-    private setupKeyboardShortcuts;
-    /**
-     * Get the SVG element where content should be appended.
-     * When pan/zoom is active, returns the transformed viewport group.
-     * When pan/zoom is inactive, returns the root SVG.
-     *
-     * CRITICAL: svg-pan-zoom wraps content in a <g> element. New elements
-     * must be added to this group, not the root SVG, or they won't transform.
-     */
-    private getSvgContainer;
-    /**
-     * Temporarily disable pan/zoom for rendering operations.
-     * CRITICAL: Disables user input but preserves viewport transform.
-     */
-    private disablePanZoom;
-    /**
-     * Re-enable pan/zoom after rendering operations complete.
-     */
-    private enablePanZoom;
-    /**
-     * Navigate to a specific version by tag.
-     * @param versionTag - Version tag (e.g., "v0", "v1")
-     */
-    private navigateToVersion;
-    /**
-     * Toggle hilites for a specific version.
-     * @param versionTag - Version tag to hilite, or null to clear hilites
-     */
-    private toggleHilites;
-    /**
-     * Get component styles (includes inlined GL CSS for Shadow DOM compatibility).
-     */
-    private getStyles;
-}

package/dist/src/core/logger.d.ts

@@ -1,37 +0,0 @@
-/**
- * Logger utility for diagnostic output.
- * Logging is controlled by the debug setting in component settings.
- */
-export declare class Logger {
-    private _enabled;
-    private _prefix;
-    constructor(prefix?: string, enabled?: boolean);
-    /**
-     * Enable or disable logging.
-     */
-    setEnabled(enabled: boolean): void;
-    /**
-     * Log an informational message.
-     */
-    info(message: string, ...args: any[]): void;
-    /**
-     * Log a warning message.
-     */
-    warn(message: string, ...args: any[]): void;
-    /**
-     * Log an error message (always logged, regardless of debug setting).
-     */
-    error(message: string, ...args: any[]): void;
-    /**
-     * Log a debug message with detailed context.
-     */
-    debug(category: string, message: string, data?: any): void;
-    /**
-     * Time a block of code execution.
-     */
-    time(label: string): void;
-    /**
-     * End timing a block of code.
-     */
-    timeEnd(label: string): void;
-}