@fieldnotes/core 0.1.2 → 0.2.1

package/dist/index.d.cts

@@ -13,6 +13,11 @@ interface Point {
     x: number;
     y: number;
 }
+interface StrokePoint {
+    x: number;
+    y: number;
+    pressure: number;
+}
 interface Size {
     w: number;
     h: number;
@@ -28,7 +33,7 @@ interface BaseElement {
 }
 interface StrokeElement extends BaseElement {
     type: 'stroke';
-    points: Point[];
+    points: StrokePoint[];
     color: string;
     width: number;
     opacity: number;
@@ -73,6 +78,34 @@ declare function exportState(elements: CanvasElement[], camera: {
 }): CanvasState;
 declare function parseState(json: string): CanvasState;
 
+interface ElementUpdateEvent {
+    previous: CanvasElement;
+    current: CanvasElement;
+}
+interface ElementStoreEvents {
+    add: CanvasElement;
+    remove: CanvasElement;
+    update: ElementUpdateEvent;
+    clear: null;
+}
+declare class ElementStore {
+    private elements;
+    private bus;
+    get count(): number;
+    getAll(): CanvasElement[];
+    getById(id: string): CanvasElement | undefined;
+    getElementsByType<T extends ElementType>(type: T): Extract<CanvasElement, {
+        type: T;
+    }>[];
+    add(element: CanvasElement): void;
+    update(id: string, partial: Partial<CanvasElement>): void;
+    remove(id: string): void;
+    clear(): void;
+    snapshot(): CanvasElement[];
+    loadSnapshot(elements: CanvasElement[]): void;
+    on<K extends keyof ElementStoreEvents>(event: K, listener: (data: ElementStoreEvents[K]) => void): () => void;
+}
+
 interface CameraOptions {
     minZoom?: number;
     maxZoom?: number;
@@ -98,6 +131,27 @@ declare class Camera {
     private notifyChange;
 }
 
+interface AutoSaveOptions {
+    key?: string;
+    debounceMs?: number;
+}
+declare class AutoSave {
+    private readonly store;
+    private readonly camera;
+    private readonly key;
+    private readonly debounceMs;
+    private timerId;
+    private unsubscribers;
+    constructor(store: ElementStore, camera: Camera, options?: AutoSaveOptions);
+    start(): void;
+    stop(): void;
+    load(): CanvasState | null;
+    clear(): void;
+    private scheduleSave;
+    private cancelPending;
+    private save;
+}
+
 type BackgroundPattern = 'dots' | 'grid' | 'none';
 interface BackgroundOptions {
     pattern?: BackgroundPattern;
@@ -119,34 +173,6 @@ declare class Background {
     private renderGrid;
 }
 
-interface ElementUpdateEvent {
-    previous: CanvasElement;
-    current: CanvasElement;
-}
-interface ElementStoreEvents {
-    add: CanvasElement;
-    remove: CanvasElement;
-    update: ElementUpdateEvent;
-    clear: null;
-}
-declare class ElementStore {
-    private elements;
-    private bus;
-    get count(): number;
-    getAll(): CanvasElement[];
-    getById(id: string): CanvasElement | undefined;
-    getElementsByType<T extends ElementType>(type: T): Extract<CanvasElement, {
-        type: T;
-    }>[];
-    add(element: CanvasElement): void;
-    update(id: string, partial: Partial<CanvasElement>): void;
-    remove(id: string): void;
-    clear(): void;
-    snapshot(): CanvasElement[];
-    loadSnapshot(elements: CanvasElement[]): void;
-    on<K extends keyof ElementStoreEvents>(event: K, listener: (data: ElementStoreEvents[K]) => void): () => void;
-}
-
 interface ToolContext {
     camera: Camera;
     store: ElementStore;
@@ -179,6 +205,7 @@ declare class ToolManager {
     get activeTool(): Tool | null;
     get toolNames(): string[];
     register(tool: Tool): void;
+    getTool<T extends Tool = Tool>(name: string): T | undefined;
     setTool(name: string, ctx: ToolContext): void;
     handlePointerDown(state: PointerState, ctx: ToolContext): void;
     handlePointerMove(state: PointerState, ctx: ToolContext): void;
@@ -259,7 +286,6 @@ declare class InputHandler {
     destroy(): void;
     private bind;
     private onWheel;
-    private isInteractiveHtmlContent;
     private onPointerDown;
     private onPointerMove;
     private onPointerUp;
@@ -307,6 +333,7 @@ declare class Viewport {
     private needsRender;
     private domNodes;
     private htmlContent;
+    private interactingElementId;
     constructor(container: HTMLElement, options?: ViewportOptions);
     get ctx(): CanvasRenderingContext2D | null;
     requestRender(): void;
@@ -322,7 +349,7 @@ declare class Viewport {
     }, size?: {
         w: number;
         h: number;
-    }): void;
+    }): string;
     addHtmlElement(dom: HTMLElement, position: {
         x: number;
         y: number;
@@ -335,6 +362,11 @@ declare class Viewport {
     private render;
     private startEditingNote;
     private onDblClick;
+    private hitTestWorld;
+    private startInteracting;
+    stopInteracting(): void;
+    private onInteractKeyDown;
+    private onInteractPointerDown;
     private onDragOver;
     private onDrop;
     private syncDomNode;
@@ -380,7 +412,7 @@ interface BaseDefaults {
     locked?: boolean;
 }
 interface StrokeInput extends BaseDefaults {
-    points: Point[];
+    points: StrokePoint[];
     color?: string;
     width?: number;
     opacity?: number;
@@ -467,6 +499,7 @@ declare class HandTool implements Tool {
 interface PencilToolOptions {
     color?: string;
     width?: number;
+    smoothing?: number;
 }
 declare class PencilTool implements Tool {
     readonly name = "pencil";
@@ -474,6 +507,7 @@ declare class PencilTool implements Tool {
     private points;
     private color;
     private width;
+    private smoothing;
     constructor(options?: PencilToolOptions);
     onActivate(ctx: ToolContext): void;
     onDeactivate(ctx: ToolContext): void;
@@ -544,6 +578,7 @@ declare class ArrowTool implements Tool {
     private color;
     private width;
     constructor(options?: ArrowToolOptions);
+    setOptions(options: ArrowToolOptions): void;
     onPointerDown(state: PointerState, ctx: ToolContext): void;
     onPointerMove(state: PointerState, ctx: ToolContext): void;
     onPointerUp(_state: PointerState, ctx: ToolContext): void;
@@ -559,6 +594,7 @@ declare class NoteTool implements Tool {
     private backgroundColor;
     private size;
     constructor(options?: NoteToolOptions);
+    setOptions(options: NoteToolOptions): void;
     onPointerDown(_state: PointerState, _ctx: ToolContext): void;
     onPointerMove(_state: PointerState, _ctx: ToolContext): void;
     onPointerUp(state: PointerState, ctx: ToolContext): void;
@@ -578,6 +614,6 @@ declare class ImageTool implements Tool {
     onPointerUp(state: PointerState, ctx: ToolContext): void;
 }
 
-declare const VERSION = "0.1.2";
+declare const VERSION = "0.2.1";
 
-export { AddElementCommand, type ArrowElement, ArrowTool, type ArrowToolOptions, Background, type BackgroundOptions, type BackgroundPattern, BatchCommand, type Bounds, Camera, type CameraOptions, type CanvasElement, type CanvasState, type Command, ElementRenderer, ElementStore, type ElementType, type ElementUpdateEvent, EraserTool, type EraserToolOptions, EventBus, HandTool, HistoryRecorder, HistoryStack, type HistoryStackOptions, type HtmlElement, type ImageElement, ImageTool, type ImageToolOptions, InputHandler, NoteEditor, type NoteElement, NoteTool, type NoteToolOptions, PencilTool, type PencilToolOptions, type Point, type PointerState, RemoveElementCommand, SelectTool, type Size, type StrokeElement, type Tool, type ToolContext, ToolManager, type ToolName, UpdateElementCommand, VERSION, Viewport, type ViewportOptions, createArrow, createHtmlElement, createId, createImage, createNote, createStroke, exportState, getArrowBounds, getArrowControlPoint, getArrowMidpoint, getArrowTangentAngle, getBendFromPoint, isNearBezier, parseState };
+export { AddElementCommand, type ArrowElement, ArrowTool, type ArrowToolOptions, AutoSave, type AutoSaveOptions, Background, type BackgroundOptions, type BackgroundPattern, BatchCommand, type Bounds, Camera, type CameraOptions, type CanvasElement, type CanvasState, type Command, ElementRenderer, ElementStore, type ElementType, type ElementUpdateEvent, EraserTool, type EraserToolOptions, EventBus, HandTool, HistoryRecorder, HistoryStack, type HistoryStackOptions, type HtmlElement, type ImageElement, ImageTool, type ImageToolOptions, InputHandler, NoteEditor, type NoteElement, NoteTool, type NoteToolOptions, PencilTool, type PencilToolOptions, type Point, type PointerState, RemoveElementCommand, SelectTool, type Size, type StrokeElement, type StrokePoint, type Tool, type ToolContext, ToolManager, type ToolName, UpdateElementCommand, VERSION, Viewport, type ViewportOptions, createArrow, createHtmlElement, createId, createImage, createNote, createStroke, exportState, getArrowBounds, getArrowControlPoint, getArrowMidpoint, getArrowTangentAngle, getBendFromPoint, isNearBezier, parseState };

package/dist/index.d.ts

@@ -13,6 +13,11 @@ interface Point {
     x: number;
     y: number;
 }
+interface StrokePoint {
+    x: number;
+    y: number;
+    pressure: number;
+}
 interface Size {
     w: number;
     h: number;
@@ -28,7 +33,7 @@ interface BaseElement {
 }
 interface StrokeElement extends BaseElement {
     type: 'stroke';
-    points: Point[];
+    points: StrokePoint[];
     color: string;
     width: number;
     opacity: number;
@@ -73,6 +78,34 @@ declare function exportState(elements: CanvasElement[], camera: {
 }): CanvasState;
 declare function parseState(json: string): CanvasState;
 
+interface ElementUpdateEvent {
+    previous: CanvasElement;
+    current: CanvasElement;
+}
+interface ElementStoreEvents {
+    add: CanvasElement;
+    remove: CanvasElement;
+    update: ElementUpdateEvent;
+    clear: null;
+}
+declare class ElementStore {
+    private elements;
+    private bus;
+    get count(): number;
+    getAll(): CanvasElement[];
+    getById(id: string): CanvasElement | undefined;
+    getElementsByType<T extends ElementType>(type: T): Extract<CanvasElement, {
+        type: T;
+    }>[];
+    add(element: CanvasElement): void;
+    update(id: string, partial: Partial<CanvasElement>): void;
+    remove(id: string): void;
+    clear(): void;
+    snapshot(): CanvasElement[];
+    loadSnapshot(elements: CanvasElement[]): void;
+    on<K extends keyof ElementStoreEvents>(event: K, listener: (data: ElementStoreEvents[K]) => void): () => void;
+}
+
 interface CameraOptions {
     minZoom?: number;
     maxZoom?: number;
@@ -98,6 +131,27 @@ declare class Camera {
     private notifyChange;
 }
 
+interface AutoSaveOptions {
+    key?: string;
+    debounceMs?: number;
+}
+declare class AutoSave {
+    private readonly store;
+    private readonly camera;
+    private readonly key;
+    private readonly debounceMs;
+    private timerId;
+    private unsubscribers;
+    constructor(store: ElementStore, camera: Camera, options?: AutoSaveOptions);
+    start(): void;
+    stop(): void;
+    load(): CanvasState | null;
+    clear(): void;
+    private scheduleSave;
+    private cancelPending;
+    private save;
+}
+
 type BackgroundPattern = 'dots' | 'grid' | 'none';
 interface BackgroundOptions {
     pattern?: BackgroundPattern;
@@ -119,34 +173,6 @@ declare class Background {
     private renderGrid;
 }
 
-interface ElementUpdateEvent {
-    previous: CanvasElement;
-    current: CanvasElement;
-}
-interface ElementStoreEvents {
-    add: CanvasElement;
-    remove: CanvasElement;
-    update: ElementUpdateEvent;
-    clear: null;
-}
-declare class ElementStore {
-    private elements;
-    private bus;
-    get count(): number;
-    getAll(): CanvasElement[];
-    getById(id: string): CanvasElement | undefined;
-    getElementsByType<T extends ElementType>(type: T): Extract<CanvasElement, {
-        type: T;
-    }>[];
-    add(element: CanvasElement): void;
-    update(id: string, partial: Partial<CanvasElement>): void;
-    remove(id: string): void;
-    clear(): void;
-    snapshot(): CanvasElement[];
-    loadSnapshot(elements: CanvasElement[]): void;
-    on<K extends keyof ElementStoreEvents>(event: K, listener: (data: ElementStoreEvents[K]) => void): () => void;
-}
-
 interface ToolContext {
     camera: Camera;
     store: ElementStore;
@@ -179,6 +205,7 @@ declare class ToolManager {
     get activeTool(): Tool | null;
     get toolNames(): string[];
     register(tool: Tool): void;
+    getTool<T extends Tool = Tool>(name: string): T | undefined;
     setTool(name: string, ctx: ToolContext): void;
     handlePointerDown(state: PointerState, ctx: ToolContext): void;
     handlePointerMove(state: PointerState, ctx: ToolContext): void;
@@ -259,7 +286,6 @@ declare class InputHandler {
     destroy(): void;
     private bind;
     private onWheel;
-    private isInteractiveHtmlContent;
     private onPointerDown;
     private onPointerMove;
     private onPointerUp;
@@ -307,6 +333,7 @@ declare class Viewport {
     private needsRender;
     private domNodes;
     private htmlContent;
+    private interactingElementId;
     constructor(container: HTMLElement, options?: ViewportOptions);
     get ctx(): CanvasRenderingContext2D | null;
     requestRender(): void;
@@ -322,7 +349,7 @@ declare class Viewport {
     }, size?: {
         w: number;
         h: number;
-    }): void;
+    }): string;
     addHtmlElement(dom: HTMLElement, position: {
         x: number;
         y: number;
@@ -335,6 +362,11 @@ declare class Viewport {
     private render;
     private startEditingNote;
     private onDblClick;
+    private hitTestWorld;
+    private startInteracting;
+    stopInteracting(): void;
+    private onInteractKeyDown;
+    private onInteractPointerDown;
     private onDragOver;
     private onDrop;
     private syncDomNode;
@@ -380,7 +412,7 @@ interface BaseDefaults {
     locked?: boolean;
 }
 interface StrokeInput extends BaseDefaults {
-    points: Point[];
+    points: StrokePoint[];
     color?: string;
     width?: number;
     opacity?: number;
@@ -467,6 +499,7 @@ declare class HandTool implements Tool {
 interface PencilToolOptions {
     color?: string;
     width?: number;
+    smoothing?: number;
 }
 declare class PencilTool implements Tool {
     readonly name = "pencil";
@@ -474,6 +507,7 @@ declare class PencilTool implements Tool {
     private points;
     private color;
     private width;
+    private smoothing;
     constructor(options?: PencilToolOptions);
     onActivate(ctx: ToolContext): void;
     onDeactivate(ctx: ToolContext): void;
@@ -544,6 +578,7 @@ declare class ArrowTool implements Tool {
     private color;
     private width;
     constructor(options?: ArrowToolOptions);
+    setOptions(options: ArrowToolOptions): void;
     onPointerDown(state: PointerState, ctx: ToolContext): void;
     onPointerMove(state: PointerState, ctx: ToolContext): void;
     onPointerUp(_state: PointerState, ctx: ToolContext): void;
@@ -559,6 +594,7 @@ declare class NoteTool implements Tool {
     private backgroundColor;
     private size;
     constructor(options?: NoteToolOptions);
+    setOptions(options: NoteToolOptions): void;
     onPointerDown(_state: PointerState, _ctx: ToolContext): void;
     onPointerMove(_state: PointerState, _ctx: ToolContext): void;
     onPointerUp(state: PointerState, ctx: ToolContext): void;
@@ -578,6 +614,6 @@ declare class ImageTool implements Tool {
     onPointerUp(state: PointerState, ctx: ToolContext): void;
 }
 
-declare const VERSION = "0.1.2";
+declare const VERSION = "0.2.1";
 
-export { AddElementCommand, type ArrowElement, ArrowTool, type ArrowToolOptions, Background, type BackgroundOptions, type BackgroundPattern, BatchCommand, type Bounds, Camera, type CameraOptions, type CanvasElement, type CanvasState, type Command, ElementRenderer, ElementStore, type ElementType, type ElementUpdateEvent, EraserTool, type EraserToolOptions, EventBus, HandTool, HistoryRecorder, HistoryStack, type HistoryStackOptions, type HtmlElement, type ImageElement, ImageTool, type ImageToolOptions, InputHandler, NoteEditor, type NoteElement, NoteTool, type NoteToolOptions, PencilTool, type PencilToolOptions, type Point, type PointerState, RemoveElementCommand, SelectTool, type Size, type StrokeElement, type Tool, type ToolContext, ToolManager, type ToolName, UpdateElementCommand, VERSION, Viewport, type ViewportOptions, createArrow, createHtmlElement, createId, createImage, createNote, createStroke, exportState, getArrowBounds, getArrowControlPoint, getArrowMidpoint, getArrowTangentAngle, getBendFromPoint, isNearBezier, parseState };
+export { AddElementCommand, type ArrowElement, ArrowTool, type ArrowToolOptions, AutoSave, type AutoSaveOptions, Background, type BackgroundOptions, type BackgroundPattern, BatchCommand, type Bounds, Camera, type CameraOptions, type CanvasElement, type CanvasState, type Command, ElementRenderer, ElementStore, type ElementType, type ElementUpdateEvent, EraserTool, type EraserToolOptions, EventBus, HandTool, HistoryRecorder, HistoryStack, type HistoryStackOptions, type HtmlElement, type ImageElement, ImageTool, type ImageToolOptions, InputHandler, NoteEditor, type NoteElement, NoteTool, type NoteToolOptions, PencilTool, type PencilToolOptions, type Point, type PointerState, RemoveElementCommand, SelectTool, type Size, type StrokeElement, type StrokePoint, type Tool, type ToolContext, ToolManager, type ToolName, UpdateElementCommand, VERSION, Viewport, type ViewportOptions, createArrow, createHtmlElement, createId, createImage, createNote, createStroke, exportState, getArrowBounds, getArrowControlPoint, getArrowMidpoint, getArrowTangentAngle, getBendFromPoint, isNearBezier, parseState };