@pixerate/editor 0.154.0 → 0.156.0

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

@@ -191,6 +191,23 @@ export interface FillLayerOptions {
     pressure?: number;
     blend?: BlendMode;
 }
+/** Pixels to add on each side of the canvas (whole numbers, 0 or more; missing = 0). */
+export interface PaintCanvasExtension {
+    left?: number;
+    top?: number;
+    right?: number;
+    bottom?: number;
+}
+export interface PaintCanvasExtended {
+    canvas: PaintCanvas;
+    /** The new canvas in the previous document's pixels: x −left, y −top and the new size. */
+    rect: RasterRect;
+    /** The document's origin after the change (see `PaintDocumentState.origin`). */
+    origin: {
+        x: number;
+        y: number;
+    };
+}
 export interface ReplayOptions extends StrokeVariation {
     /** Recorded stroke ids (see `getStrokes`). */
     strokeIds: readonly string[];
@@ -288,6 +305,14 @@ export declare class PaintEditorController {
      * The viewport passes it to `compositeTiles` as `dirty`.
      */
     takeDirty(): RasterRect[] | 'all';
+    private docRevision;
+    /**
+     * Bumped on every change to the painting (a committed or amended step, undo, redo, opening a
+     * document), not on wet-paint frames or view changes. `createPaintEditorDocument` uses it.
+     */
+    get documentRevision(): number;
+    /** Why the document cannot be replaced or stepped through right now, or `null`. */
+    busyReason(): string | null;
     private requireIdle;
     private commit;
     /**
@@ -315,6 +340,7 @@ export declare class PaintEditorController {
     private withWetEvents;
     undo(): string | null;
     redo(): string | null;
+    private restoreGuides;
     /** Labels of the undo steps, oldest first. */
     historyLabels(): {
         undo: string[];
@@ -327,6 +353,18 @@ export declare class PaintEditorController {
     }): PaintDocumentState;
     /** Changes the canvas size (keeping the pixels where they are, anchored top-left) or resolution. */
     setCanvas(update: Partial<PaintCanvas>): PaintCanvas;
+    /**
+     * Grows the canvas by `left`, `top`, `right` and `bottom` pixels without moving anything
+     * relative to anything else: the layers (with their masks, relief and stickers), the paper grain,
+     * the effect paper, guides, stencils, the tracing image and the recorded strokes and events all
+     * move by (left, top) in document pixels, `document.origin` moves by (−left, −top), and the view
+     * pans so the picture stays still on screen.
+     *
+     * Wet paint dries first (the wet simulation is canvas-sized), as with `setCanvas`; one undo step
+     * (undo brings back the old size, origin and guides, and the wet paint). Returns the new canvas,
+     * where it sits in the previous document's pixels, and the origin.
+     */
+    extendCanvas(by: PaintCanvasExtension): PaintCanvasExtended;
     /** Changes the paper: a library preset (`preset`), and / or any of its settings (one undo step). */
     setPaper(update: Partial<PaperSettings> & {
         preset?: string;

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

@@ -49,6 +49,14 @@ export interface PaintDocumentState {
     effectLayers?: Readonly<Record<string, PaintEffectSource>>;
     /** Effect paper: a provider generator drawn over the paper, under the paint. */
     paperEffect?: PaintPaperEffect;
+    /**
+     * Where this document's (0, 0) is in the coordinates of the canvas it grew from (missing = 0, 0).
+     * `extendCanvas({ left: 100 })` moves it to x −100; a host maps its own coordinates with it.
+     */
+    origin?: {
+        x: number;
+        y: number;
+    };
 }
 /** A change a replay repeats besides strokes, recorded with how many strokes came before it. */
 export interface PaintEvent {

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

@@ -49,6 +49,14 @@ export interface PaintDocumentState {
     effectLayers?: Readonly<Record<string, PaintEffectSource>>;
     /** Effect paper: a provider generator drawn over the paper, under the paint. */
     paperEffect?: PaintPaperEffect;
+    /**
+     * Where this document's (0, 0) is in the coordinates of the canvas it grew from (missing = 0, 0).
+     * `extendCanvas({ left: 100 })` moves it to x −100; a host maps its own coordinates with it.
+     */
+    origin?: {
+        x: number;
+        y: number;
+    };
 }
 /** A change a replay repeats besides strokes, recorded with how many strokes came before it. */
 export interface PaintEvent {

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

@@ -0,0 +1,17 @@
+import { type EditorAssetRegistry } from '../persistence/assets.cjs';
+import { type EditorDocument } from '../persistence/editorDocument.cjs';
+import type { PaintEditorController } from './controller.cjs';
+import type { SerializedPaintDocument } from './serialize.cjs';
+export interface PaintEditorDocumentOptions {
+    /** Where layer, thick-paint, mixing-pad and guide images are kept (default: a registry of its own). */
+    assets?: EditorAssetRegistry;
+    /** Include the recorded strokes (default `true`), so the painting can be replayed and repainted at a higher resolution. */
+    strokes?: boolean;
+}
+/**
+ * The save / load / undo contract for a `PaintEditorController` (kind `paint`, document: the
+ * saved painting from `toJSON()` with every image as an asset reference kept in `assets`). Wet
+ * paint is saved dry. Opening a document clears the history (`recordsLoads: false`), and the
+ * document is read-only while a stroke or a wet-paint step is in progress.
+ */
+export declare function createPaintEditorDocument(controller: PaintEditorController, options?: PaintEditorDocumentOptions): EditorDocument<SerializedPaintDocument>;

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

@@ -0,0 +1,17 @@
+import { type EditorAssetRegistry } from '../persistence/assets.js';
+import { type EditorDocument } from '../persistence/editorDocument.js';
+import type { PaintEditorController } from './controller.js';
+import type { SerializedPaintDocument } from './serialize.js';
+export interface PaintEditorDocumentOptions {
+    /** Where layer, thick-paint, mixing-pad and guide images are kept (default: a registry of its own). */
+    assets?: EditorAssetRegistry;
+    /** Include the recorded strokes (default `true`), so the painting can be replayed and repainted at a higher resolution. */
+    strokes?: boolean;
+}
+/**
+ * The save / load / undo contract for a `PaintEditorController` (kind `paint`, document: the
+ * saved painting from `toJSON()` with every image as an asset reference kept in `assets`). Wet
+ * paint is saved dry. Opening a document clears the history (`recordsLoads: false`), and the
+ * document is read-only while a stroke or a wet-paint step is in progress.
+ */
+export declare function createPaintEditorDocument(controller: PaintEditorController, options?: PaintEditorDocumentOptions): EditorDocument<SerializedPaintDocument>;