@pixerate/editor 0.257.0 → 0.258.0

package/dist/paint-editor/collaboration.d.cts

@@ -178,3 +178,41 @@ export declare function paintProposalGhost(proposal: PaintProposal): {
     height: number;
     data: Uint8ClampedArray;
 } | null;
+/** A stroke an agent is painting live, drawn over the canvas until it is painted for real. */
+export interface PaintAgentStroke {
+    id: string;
+    /** Who paints it (`agent:<id>`). */
+    origin: string;
+    /** Path in document pixels. */
+    points: readonly {
+        x: number;
+        y: number;
+    }[];
+    /** #rrggbb */
+    color: string;
+    /** Line width in document pixels. */
+    size: number;
+    /** 0..1 (default 0.6). */
+    opacity?: number;
+}
+export interface PaintAgentStrokesState {
+    strokes: readonly PaintAgentStroke[];
+}
+/** Agent strokes in progress, for `PaintCanvas` (`agentStrokes`) to draw while the user's pen is down. */
+export interface PaintAgentStrokes {
+    getState(): PaintAgentStrokesState;
+    subscribe(listener: (state: PaintAgentStrokesState) => void): () => void;
+    /** Adds or replaces a stroke (by id). */
+    set(stroke: PaintAgentStroke): void;
+    remove(id: string): void;
+    /** Removes every stroke (or those of one origin). */
+    clear(origin?: string): void;
+}
+/**
+ * Live agent strokes: an agent painting along with the user draws its companion strokes here
+ * while the user's stroke is in progress (the editor can't paint two strokes at once), then paints
+ * them for real when the user lifts the pen. `PaintCanvas` draws them as soft lines over the canvas.
+ */
+export declare function createPaintAgentStrokes(): PaintAgentStrokes;
+/** An SVG `points` attribute for a live agent stroke. */
+export declare function paintAgentStrokePoints(stroke: PaintAgentStroke): string;

package/dist/paint-editor/collaboration.d.ts

@@ -178,3 +178,41 @@ export declare function paintProposalGhost(proposal: PaintProposal): {
     height: number;
     data: Uint8ClampedArray;
 } | null;
+/** A stroke an agent is painting live, drawn over the canvas until it is painted for real. */
+export interface PaintAgentStroke {
+    id: string;
+    /** Who paints it (`agent:<id>`). */
+    origin: string;
+    /** Path in document pixels. */
+    points: readonly {
+        x: number;
+        y: number;
+    }[];
+    /** #rrggbb */
+    color: string;
+    /** Line width in document pixels. */
+    size: number;
+    /** 0..1 (default 0.6). */
+    opacity?: number;
+}
+export interface PaintAgentStrokesState {
+    strokes: readonly PaintAgentStroke[];
+}
+/** Agent strokes in progress, for `PaintCanvas` (`agentStrokes`) to draw while the user's pen is down. */
+export interface PaintAgentStrokes {
+    getState(): PaintAgentStrokesState;
+    subscribe(listener: (state: PaintAgentStrokesState) => void): () => void;
+    /** Adds or replaces a stroke (by id). */
+    set(stroke: PaintAgentStroke): void;
+    remove(id: string): void;
+    /** Removes every stroke (or those of one origin). */
+    clear(origin?: string): void;
+}
+/**
+ * Live agent strokes: an agent painting along with the user draws its companion strokes here
+ * while the user's stroke is in progress (the editor can't paint two strokes at once), then paints
+ * them for real when the user lifts the pen. `PaintCanvas` draws them as soft lines over the canvas.
+ */
+export declare function createPaintAgentStrokes(): PaintAgentStrokes;
+/** An SVG `points` attribute for a live agent stroke. */
+export declare function paintAgentStrokePoints(stroke: PaintAgentStroke): string;

package/dist/paint-editor/controller.d.cts

@@ -204,6 +204,21 @@ export interface PaintLayerInfo {
     /** How many live layer effects (glows, shadows, strokes…) it has, when any (`getLayerEffects`). */
     effects?: number;
 }
+/** A live stroke as it is painted (`onStrokeSample`), for agents that paint along with the user. */
+export interface PaintStrokeSample {
+    /** `begin`: the pen went down. `points`: new samples. `end`: the stroke was recorded. `cancel`: it was abandoned. */
+    phase: 'begin' | 'points' | 'end' | 'cancel';
+    layerId: string;
+    brush: PaintBrush;
+    /** #rrggbb */
+    color: string;
+    /** Every raw sample so far (document pixels), in order. */
+    points: readonly PenPoint[];
+    /** The samples this event added (`points` only). */
+    added: readonly PenPoint[];
+    /** `end`: the recorded stroke's id, or `null` when it painted nothing. */
+    strokeId?: string | null;
+}
 /** One change to the paint history, for hosts and change feeds (`onCommit`). */
 export interface PaintCommitEvent {
     /** `execute`: a new undo step. `merge`: folded into the last one (a slider drag). */
@@ -371,6 +386,7 @@ export declare class PaintEditorController {
     private readonly encodeImage;
     private listeners;
     private commitListeners;
+    private sampleListeners;
     /** Origins set by `withOrigin`, innermost last. */
     private origins;
     /** `group` in progress: commits fold into one step, recorded when it ends. */
@@ -433,6 +449,21 @@ export declare class PaintEditorController {
     private paperEffectNodeCache;
     constructor(options?: PaintEditorOptions);
     subscribe(listener: () => void): () => void;
+    /**
+     * Hears the user's live strokes as they are painted (`beginStroke` sessions, not strokes painted
+     * from data): when the pen goes down, each batch of samples, and the end or cancel. For agents
+     * that paint along in real time. Returns an unsubscribe function.
+     */
+    onStrokeSample(listener: (sample: PaintStrokeSample) => void): () => void;
+    private notifySample;
+    /** The stroke being painted now, or `null`: its layer, brush, colour and samples so far. */
+    getLiveStroke(): {
+        layerId: string;
+        brushId: string;
+        brushName: string;
+        color: string;
+        points: readonly PenPoint[];
+    } | null;
     /** Hears each undo step recorded, merged, undone or redone, with who made it. Returns an unsubscribe function. */
     onCommit(listener: (event: PaintCommitEvent) => void): () => void;
     private notifyCommit;

package/dist/paint-editor/controller.d.ts

@@ -204,6 +204,21 @@ export interface PaintLayerInfo {
     /** How many live layer effects (glows, shadows, strokes…) it has, when any (`getLayerEffects`). */
     effects?: number;
 }
+/** A live stroke as it is painted (`onStrokeSample`), for agents that paint along with the user. */
+export interface PaintStrokeSample {
+    /** `begin`: the pen went down. `points`: new samples. `end`: the stroke was recorded. `cancel`: it was abandoned. */
+    phase: 'begin' | 'points' | 'end' | 'cancel';
+    layerId: string;
+    brush: PaintBrush;
+    /** #rrggbb */
+    color: string;
+    /** Every raw sample so far (document pixels), in order. */
+    points: readonly PenPoint[];
+    /** The samples this event added (`points` only). */
+    added: readonly PenPoint[];
+    /** `end`: the recorded stroke's id, or `null` when it painted nothing. */
+    strokeId?: string | null;
+}
 /** One change to the paint history, for hosts and change feeds (`onCommit`). */
 export interface PaintCommitEvent {
     /** `execute`: a new undo step. `merge`: folded into the last one (a slider drag). */
@@ -371,6 +386,7 @@ export declare class PaintEditorController {
     private readonly encodeImage;
     private listeners;
     private commitListeners;
+    private sampleListeners;
     /** Origins set by `withOrigin`, innermost last. */
     private origins;
     /** `group` in progress: commits fold into one step, recorded when it ends. */
@@ -433,6 +449,21 @@ export declare class PaintEditorController {
     private paperEffectNodeCache;
     constructor(options?: PaintEditorOptions);
     subscribe(listener: () => void): () => void;
+    /**
+     * Hears the user's live strokes as they are painted (`beginStroke` sessions, not strokes painted
+     * from data): when the pen goes down, each batch of samples, and the end or cancel. For agents
+     * that paint along in real time. Returns an unsubscribe function.
+     */
+    onStrokeSample(listener: (sample: PaintStrokeSample) => void): () => void;
+    private notifySample;
+    /** The stroke being painted now, or `null`: its layer, brush, colour and samples so far. */
+    getLiveStroke(): {
+        layerId: string;
+        brushId: string;
+        brushName: string;
+        color: string;
+        points: readonly PenPoint[];
+    } | null;
     /** Hears each undo step recorded, merged, undone or redone, with who made it. Returns an unsubscribe function. */
     onCommit(listener: (event: PaintCommitEvent) => void): () => void;
     private notifyCommit;