@fieldnotes/core 0.53.0 → 0.55.0

package/dist/index.d.cts

@@ -249,7 +249,7 @@ interface Tool {
     setOptions?(options: object): void;
     onOptionsChange?(listener: () => void): () => void;
 }
-type ToolName = 'hand' | 'select' | 'pencil' | 'eraser' | 'arrow' | 'note' | 'image' | 'text' | 'shape' | 'measure' | 'template' | 'laser';
+type ToolName = 'hand' | 'select' | 'pencil' | 'eraser' | 'arrow' | 'note' | 'image' | 'text' | 'shape' | 'measure' | 'template' | 'laser' | 'ping';
 
 declare function snapPoint(point: Point, gridSize: number): Point;
 declare function snapToHexCenter(point: Point, cellSize: number, orientation: HexOrientation): Point;
@@ -510,6 +510,15 @@ interface RenderStatsSnapshot {
     frameCount: number;
 }
 
+/**
+ * A world-space draw callback rendered above elements on every frame,
+ * regardless of which tool is active. The context arrives with the camera
+ * transform applied; implementations must not assume exclusive context state
+ * (each renderer is wrapped in save/restore). A throwing renderer is isolated
+ * per frame and must not break the render loop.
+ */
+type OverlayRenderer = (ctx: CanvasRenderingContext2D) => void;
+
 interface ElementStyle {
     color?: string;
     fillColor?: string;
@@ -609,6 +618,15 @@ declare class Viewport {
     setSmartGuides(enabled: boolean): void;
     fitToContent(padding?: number): void;
     requestRender(): void;
+    /**
+     * Registers a world-space overlay drawn above elements on every frame,
+     * regardless of the active tool — the surface for remote presence visuals
+     * such as laser trails, cursors, pings, and shared rulers. Overlays draw
+     * beneath the active tool's own `renderOverlay` and never touch elements,
+     * history, or persisted state. Returns an idempotent unsubscribe that also
+     * erases the overlay's last frame.
+     */
+    registerOverlay(draw: OverlayRenderer): () => void;
     exportState(): CanvasState;
     exportJSON(): string;
     exportImage(options?: ExportImageOptions): Promise<Blob | null>;
@@ -698,6 +716,276 @@ declare class Viewport {
     private observeResize;
 }
 
+interface LaserToolOptions {
+    name?: string;
+    color?: string;
+    width?: number;
+    fadeMs?: number;
+}
+/**
+ * A coalesced batch of locally drawn trail points, flushed at most once per
+ * animation frame — the outgoing side of a shared laser pointer. Emissions
+ * carry world coordinates and the tool's current style so a host can forward
+ * them as ephemeral presence without duplicating the tool's input handling.
+ */
+interface LaserTrailEmission {
+    /** World-space points recorded since the previous emission, oldest first. */
+    readonly points: readonly Point[];
+    readonly color: string;
+    readonly width: number;
+    readonly fadeMs: number;
+}
+declare class LaserTool implements Tool {
+    readonly name: string;
+    private color;
+    private width;
+    private fadeMs;
+    private trail;
+    private rafId;
+    private drawing;
+    private optionListeners;
+    private trailListeners;
+    private pendingEmission;
+    constructor(options?: LaserToolOptions);
+    private now;
+    onActivate(ctx: ToolContext): void;
+    onDeactivate(ctx: ToolContext): void;
+    getOptions(): LaserToolOptions;
+    onOptionsChange(listener: () => void): () => void;
+    /**
+     * Subscribes to coalesced trail emissions. Points recorded by pointer input
+     * are batched and delivered at most once per animation frame, keeping
+     * outgoing presence packets small. Listeners must not throw; a throwing
+     * listener is isolated so it cannot stall the fade loop.
+     */
+    onTrail(listener: (emission: LaserTrailEmission) => void): () => void;
+    setOptions(options: LaserToolOptions): void;
+    onPointerDown(state: PointerState, ctx: ToolContext): void;
+    onPointerMove(state: PointerState, ctx: ToolContext): void;
+    private recordPoint;
+    onPointerUp(_state: PointerState, _ctx: ToolContext): void;
+    renderOverlay(ctx: CanvasRenderingContext2D): void;
+    private ensureAnimating;
+    private flushEmission;
+    private tick;
+    private notifyOptionsChange;
+}
+
+/**
+ * The wire shape of a laser-trail presence payload. Presence data is untyped
+ * on the wire, so hosts discriminate on `kind`; `isLaserTrailPresence`
+ * validates a received payload before it reaches the overlay. Trails are
+ * ephemeral by contract: they must travel as presence only — never as
+ * elements, undo history, persisted canvas state, or durable operations.
+ */
+interface LaserTrailPresence {
+    readonly kind: 'laser';
+    /** World-space points, oldest first. */
+    readonly points: readonly Point[];
+    readonly color?: string;
+    readonly width?: number;
+    readonly fadeMs?: number;
+}
+declare const LASER_TRAIL_PRESENCE_KIND = "laser";
+declare function isLaserTrailPresence(data: unknown): data is LaserTrailPresence;
+/** Builds the presence payload for one local `LaserTool` emission. */
+declare function toLaserTrailPresence(emission: LaserTrailEmission): LaserTrailPresence;
+/**
+ * The two viewport capabilities the overlay needs; `Viewport` satisfies it.
+ */
+interface RemoteLaserOverlayHost {
+    registerOverlay(draw: OverlayRenderer): () => void;
+    requestRender(): void;
+}
+interface RemoteLaserOverlayOptions {
+    /** Style fallbacks when a payload omits them. */
+    color?: string;
+    width?: number;
+    fadeMs?: number;
+    /** Per-sender point cap; oldest points drop first. Default `512`. */
+    maxPointsPerSender?: number;
+}
+/**
+ * Renders fading laser trails for remote senders through the viewport overlay
+ * registration, independent of the viewer's active tool. Points are stamped
+ * with local receive time (remote clocks are never trusted), fade like the
+ * local `LaserTool`, and a sender's trail disappears immediately on
+ * `remove()` — wire that to `presence-leave`/disconnect. The controller never
+ * touches elements, history, or persisted state.
+ */
+declare class RemoteLaserOverlay {
+    private readonly host;
+    private readonly color;
+    private readonly width;
+    private readonly fadeMs;
+    private readonly maxPointsPerSender;
+    private readonly trails;
+    private unregister;
+    private rafId;
+    private disposed;
+    constructor(host: RemoteLaserOverlayHost, options?: RemoteLaserOverlayOptions);
+    private now;
+    /**
+     * Applies a presence payload from `sender` (any opaque per-sender key, e.g.
+     * the envelope `from`). Non-laser or malformed payloads are ignored and
+     * reported as `false`, so hosts can feed every presence frame through.
+     */
+    apply(sender: string, data: unknown): boolean;
+    /** Removes a sender's trail immediately (presence-leave/disconnect). */
+    remove(sender: string): void;
+    /** Removes every trail immediately. */
+    clear(): void;
+    /** Number of senders with a live (unfaded) trail. */
+    get activeSenderCount(): number;
+    /** Unregisters the overlay and stops the fade loop. Idempotent. */
+    dispose(): void;
+    private ensureAnimating;
+    private tick;
+    private renderTrails;
+}
+
+interface PingToolOptions {
+    name?: string;
+    color?: string;
+    /** Total pulse animation length in milliseconds. */
+    durationMs?: number;
+    /** Maximum ripple radius in world units. */
+    radius?: number;
+    /**
+     * Minimum interval between emitted pings. Taps arriving faster are ignored
+     * entirely (no local pulse, no emission), so rapid-fire pings cannot starve
+     * durable sync traffic.
+     */
+    minIntervalMs?: number;
+}
+/**
+ * One emitted ping — the outgoing side of a shared "look here" marker.
+ * Emissions carry the world position and the tool's current style so a host
+ * can forward them as ephemeral presence without duplicating input handling.
+ */
+interface PingEmission {
+    /** World-space ping position. */
+    readonly x: number;
+    readonly y: number;
+    readonly color: string;
+    readonly durationMs: number;
+    readonly radius: number;
+}
+/**
+ * Tap or click to ping a world position: a short expanding-pulse animation is
+ * rendered locally and one `PingEmission` is delivered to `onPing` listeners
+ * per accepted tap. Pings are ephemeral by contract: they never create
+ * elements, enter undo history, or touch persisted canvas state — hosts
+ * forward emissions as presence only.
+ */
+declare class PingTool implements Tool {
+    readonly name: string;
+    private color;
+    private durationMs;
+    private radius;
+    private minIntervalMs;
+    private pings;
+    private lastEmitAt;
+    private rafId;
+    private optionListeners;
+    private pingListeners;
+    constructor(options?: PingToolOptions);
+    private now;
+    onActivate(ctx: ToolContext): void;
+    onDeactivate(ctx: ToolContext): void;
+    getOptions(): PingToolOptions;
+    setOptions(options: PingToolOptions): void;
+    onOptionsChange(listener: () => void): () => void;
+    /**
+     * Subscribes to accepted pings. Listeners must not throw; a throwing
+     * listener is isolated so it cannot break the tap handling or other
+     * listeners.
+     */
+    onPing(listener: (emission: PingEmission) => void): () => void;
+    onPointerDown(state: PointerState, ctx: ToolContext): void;
+    onPointerMove(_state: PointerState, _ctx: ToolContext): void;
+    onPointerUp(_state: PointerState, _ctx: ToolContext): void;
+    renderOverlay(ctx: CanvasRenderingContext2D): void;
+    private ensureAnimating;
+    private tick;
+    private notifyOptionsChange;
+}
+
+/**
+ * The wire shape of a map-ping presence payload. Presence data is untyped on
+ * the wire, so hosts discriminate on `kind`; `isPingPresence` validates a
+ * received payload before it reaches the overlay. Pings are ephemeral by
+ * contract: they must travel as presence only — never as elements, undo
+ * history, persisted canvas state, or durable operations.
+ */
+interface PingPresence {
+    readonly kind: 'ping';
+    /** World-space ping position. */
+    readonly x: number;
+    readonly y: number;
+    readonly color?: string;
+    readonly durationMs?: number;
+    readonly radius?: number;
+}
+declare const PING_PRESENCE_KIND = "ping";
+declare function isPingPresence(data: unknown): data is PingPresence;
+/** Builds the presence payload for one local `PingTool` emission. */
+declare function toPingPresence(emission: PingEmission): PingPresence;
+/**
+ * The two viewport capabilities the overlay needs; `Viewport` satisfies it.
+ */
+interface RemotePingOverlayHost {
+    registerOverlay(draw: OverlayRenderer): () => void;
+    requestRender(): void;
+}
+interface RemotePingOverlayOptions {
+    /** Style fallbacks when a payload omits them. */
+    color?: string;
+    durationMs?: number;
+    radius?: number;
+    /** Per-sender live-ping cap; oldest pings drop first. Default `8`. */
+    maxPingsPerSender?: number;
+}
+/**
+ * Renders expanding-pulse pings for remote senders through the viewport
+ * overlay registration, independent of the viewer's active tool. Pings are
+ * stamped with local receive time (remote clocks are never trusted),
+ * self-expire when their animation ends, and a sender's pings disappear
+ * immediately on `remove()` — wire that to `presence-leave`/disconnect. The
+ * controller never touches elements, history, or persisted state, and it
+ * never moves the viewer's camera: pings are visual only.
+ */
+declare class RemotePingOverlay {
+    private readonly host;
+    private readonly color;
+    private readonly durationMs;
+    private readonly radius;
+    private readonly maxPingsPerSender;
+    private readonly pings;
+    private unregister;
+    private rafId;
+    private disposed;
+    constructor(host: RemotePingOverlayHost, options?: RemotePingOverlayOptions);
+    private now;
+    /**
+     * Applies a presence payload from `sender` (any opaque per-sender key, e.g.
+     * the envelope `from`). Non-ping or malformed payloads are ignored and
+     * reported as `false`, so hosts can feed every presence frame through.
+     */
+    apply(sender: string, data: unknown): boolean;
+    /** Removes a sender's pings immediately (presence-leave/disconnect). */
+    remove(sender: string): void;
+    /** Removes every ping immediately. */
+    clear(): void;
+    /** Number of senders with a live (unexpired) ping. */
+    get activeSenderCount(): number;
+    /** Unregisters the overlay and stops the animation loop. Idempotent. */
+    dispose(): void;
+    private ensureAnimating;
+    private tick;
+    private renderPings;
+}
+
 interface ActiveFormats {
     bold: boolean;
     italic: boolean;
@@ -1136,37 +1424,6 @@ declare class TemplateTool implements Tool {
     private notifyOptionsChange;
 }
 
-interface LaserToolOptions {
-    name?: string;
-    color?: string;
-    width?: number;
-    fadeMs?: number;
-}
-declare class LaserTool implements Tool {
-    readonly name: string;
-    private color;
-    private width;
-    private fadeMs;
-    private trail;
-    private rafId;
-    private drawing;
-    private optionListeners;
-    constructor(options?: LaserToolOptions);
-    private now;
-    onActivate(ctx: ToolContext): void;
-    onDeactivate(ctx: ToolContext): void;
-    getOptions(): LaserToolOptions;
-    onOptionsChange(listener: () => void): () => void;
-    setOptions(options: LaserToolOptions): void;
-    onPointerDown(state: PointerState, ctx: ToolContext): void;
-    onPointerMove(state: PointerState, ctx: ToolContext): void;
-    onPointerUp(_state: PointerState, _ctx: ToolContext): void;
-    renderOverlay(ctx: CanvasRenderingContext2D): void;
-    private ensureAnimating;
-    private tick;
-    private notifyOptionsChange;
-}
-
-declare const VERSION = "0.53.0";
+declare const VERSION = "0.55.0";
 
-export { type ActiveFormats, type AlignEdge, type ArrowElement, type ArrowStrokeStyle, ArrowTool, type ArrowToolOptions, AutoSave, type AutoSaveOptions, type BackgroundOptions, type BackgroundPattern, type Binding, type Bounds, Camera, type CameraChangeInfo, type CameraOptions, type CanvasElement, type CanvasState, type Command, DEFAULT_NOTE_FONT_SIZE, type DistributeAxis, type ElementChangeMeta, ElementStore, type ElementStyle, type ElementType, type ElementUpdateEvent, EraserTool, type EraserToolOptions, type ExportAssetError, type ExportAssetErrorReason, type ExportImageOptions, type ExportResourceOptions, type ExportSvgOptions, type FontSizePreset, type GridElement, type GridInfo, HandTool, type HexOrientation, HistoryStack, type HistoryStackOptions, type HtmlElement, type HtmlExportError, type HtmlExportErrorReason, type HtmlExportOptions, type HtmlExportRenderer, type ImageElement, ImageTool, type ImageToolOptions, IndexedDBAdapter, type IndexedDBAdapterOptions, LaserTool, type LaserToolOptions, type Layer, LayerManager, LocalStorageAdapter, MeasureTool, type MeasureToolOptions, type Measurement, MemoryAdapter, type NoteElement, NoteTool, type NoteToolOptions, PencilTool, type PencilToolOptions, type Point, type PointerState, type RenderStatsSnapshot, type RotateDirection, SelectTool, type ShapeElement, type ShapeKind, ShapeTool, type ShapeToolOptions, type ShortcutBindings, type ShortcutOptions, type ShortcutsApi, type Size, type StorageAdapter, type StrokeElement, type StrokePoint, type TemplateElement, type TemplateRenderStyle, type TemplateShape, TemplateTool, type TemplateToolOptions, type TextElement, TextTool, type TextToolOptions, type Tool, type ToolContext, ToolManager, type ToolName, VERSION, Viewport, type ViewportOptions, boundsIntersect, createArrow, createGrid, createHtmlElement, createImage, createNote, createShape, createStroke, createTemplate, createText, drawHexPath, exportImage, exportSvg, getActiveFormats, getArrowBounds, getArrowControlPoint, getArrowMidpoint, getArrowTangentAngle, getBendFromPoint, getElementBounds, getElementStyle, getElementsBoundingBox, getHexCellsInCone, getHexCellsInLine, getHexCellsInRadius, getHexCellsInRectangle, getHexCellsInSquare, getHexDistance, isNearBezier, setFontSize, smartSnap, snapPoint, snapToHexCenter, styleToPatch, toggleBold, toggleItalic, toggleStrikethrough, toggleUnderline };
+export { type ActiveFormats, type AlignEdge, type ArrowElement, type ArrowStrokeStyle, ArrowTool, type ArrowToolOptions, AutoSave, type AutoSaveOptions, type BackgroundOptions, type BackgroundPattern, type Binding, type Bounds, Camera, type CameraChangeInfo, type CameraOptions, type CanvasElement, type CanvasState, type Command, DEFAULT_NOTE_FONT_SIZE, type DistributeAxis, type ElementChangeMeta, ElementStore, type ElementStyle, type ElementType, type ElementUpdateEvent, EraserTool, type EraserToolOptions, type ExportAssetError, type ExportAssetErrorReason, type ExportImageOptions, type ExportResourceOptions, type ExportSvgOptions, type FontSizePreset, type GridElement, type GridInfo, HandTool, type HexOrientation, HistoryStack, type HistoryStackOptions, type HtmlElement, type HtmlExportError, type HtmlExportErrorReason, type HtmlExportOptions, type HtmlExportRenderer, type ImageElement, ImageTool, type ImageToolOptions, IndexedDBAdapter, type IndexedDBAdapterOptions, LASER_TRAIL_PRESENCE_KIND, LaserTool, type LaserToolOptions, type LaserTrailEmission, type LaserTrailPresence, type Layer, LayerManager, LocalStorageAdapter, MeasureTool, type MeasureToolOptions, type Measurement, MemoryAdapter, type NoteElement, NoteTool, type NoteToolOptions, type OverlayRenderer, PING_PRESENCE_KIND, PencilTool, type PencilToolOptions, type PingEmission, type PingPresence, PingTool, type PingToolOptions, type Point, type PointerState, RemoteLaserOverlay, type RemoteLaserOverlayHost, type RemoteLaserOverlayOptions, RemotePingOverlay, type RemotePingOverlayHost, type RemotePingOverlayOptions, type RenderStatsSnapshot, type RotateDirection, SelectTool, type ShapeElement, type ShapeKind, ShapeTool, type ShapeToolOptions, type ShortcutBindings, type ShortcutOptions, type ShortcutsApi, type Size, type StorageAdapter, type StrokeElement, type StrokePoint, type TemplateElement, type TemplateRenderStyle, type TemplateShape, TemplateTool, type TemplateToolOptions, type TextElement, TextTool, type TextToolOptions, type Tool, type ToolContext, ToolManager, type ToolName, VERSION, Viewport, type ViewportOptions, boundsIntersect, createArrow, createGrid, createHtmlElement, createImage, createNote, createShape, createStroke, createTemplate, createText, drawHexPath, exportImage, exportSvg, getActiveFormats, getArrowBounds, getArrowControlPoint, getArrowMidpoint, getArrowTangentAngle, getBendFromPoint, getElementBounds, getElementStyle, getElementsBoundingBox, getHexCellsInCone, getHexCellsInLine, getHexCellsInRadius, getHexCellsInRectangle, getHexCellsInSquare, getHexDistance, isLaserTrailPresence, isNearBezier, isPingPresence, setFontSize, smartSnap, snapPoint, snapToHexCenter, styleToPatch, toLaserTrailPresence, toPingPresence, toggleBold, toggleItalic, toggleStrikethrough, toggleUnderline };