@pixerate/editor 0.208.0 → 0.209.0

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

@@ -1,4 +1,4 @@
-import { AdjustmentKind, AdjustmentLayer, AdjustmentParamsMap, Annotation, CreateAnnotationPayload, AspectRatio, CropBox, DepthMaskOptions, ExportOptions, ImageAdjustments, ImageDimensions, ImageEditorFit, ImageEditorOptions, ImageEditorState, ImageEditorTool, ImageTransform, ImagePoint, SerializedImageEditorState } from './types.cjs';
+import { AdjustmentKind, AdjustmentLayer, AdjustmentParamsMap, Annotation, CreateAnnotationPayload, AspectRatio, CropBox, DepthMaskOptions, ExportOptions, ImageAdjustments, ImageDimensions, ImageEditorFit, ImageEditorOptions, ImageEditorState, ImageEditorTool, ImageTransform, ImagePoint, SerializedImageEditorState, DocumentOpener } from './types.cjs';
 import { type PathToSelectionOptions, type SelectionToPathOptions } from './selection/path.cjs';
 import { type MagneticEdgeOptions } from './selection/magnetic.cjs';
 import type { ObjectTarget } from './selection/segment/grabcut.cjs';
@@ -168,7 +168,7 @@ export interface FocusAreaCommandOptions extends FocusAreaOptions {
     sampleAllLayers?: boolean;
 }
 /** Where Select and Mask puts its result (Photoshop's Output To). */
-export type RefineOutput = 'selection' | 'layer-mask' | 'new-layer' | 'new-layer-with-mask';
+export type RefineOutput = 'selection' | 'layer-mask' | 'new-layer' | 'new-layer-with-mask' | 'new-document' | 'new-document-with-mask';
 /** What {@link ImageEditorController.refineSelectionTo} made. */
 export interface RefineOutputResult {
     output: RefineOutput;
@@ -176,6 +176,8 @@ export interface RefineOutputResult {
     layerId?: string;
     /** The layer it made (`new-layer`, `new-layer-with-mask`). */
     newLayerId?: string;
+    /** The id the host's document opener returned (`new-document`, `new-document-with-mask`). */
+    documentId?: string;
     /** How the edge was refined: by colour, or with the segmentation model (object aware). */
     refineMode: 'color' | 'object';
 }
@@ -691,6 +693,7 @@ export declare class ImageEditorController {
     /** The segmentation provider behind `selectSubject` (see `setSegmentationProvider`). */
     private segmentation;
     private selectionWorker;
+    private documentOpener;
     /** The effects provider slot (see `setEffectsProvider`). */
     readonly effects: EffectsSlot;
     /** Renders provider effects: effect smart filter results and effect layers. */
@@ -726,6 +729,24 @@ export declare class ImageEditorController {
      * A worker that is cancelled or fails is replaced by a fresh one on the next job.
      */
     setSelectionWorker(factory: SelectionWorkerFactory | null): void;
+    /** Sets (or with `null` removes) how new documents are opened (see `DocumentOpener`). Not an edit. */
+    setDocumentOpener(opener: DocumentOpener | null): void;
+    /** Whether the host can open new documents (the New Document outputs are available). */
+    get canOpenDocuments(): boolean;
+    /**
+     * A new one-layer document from the selection (or `options.selection`) on a pixel layer
+     * (`layerId`, default the active one), the size of this image: the selected pixels on
+     * transparency, or with `withMask` the whole layer masked by the selection. This document is
+     * not changed. `decontaminate` (0..100) cleans the soft edge's colours as the new-layer
+     * outputs do.
+     */
+    documentFromSelection(options?: {
+        layerId?: string;
+        withMask?: boolean;
+        selection?: SelectionMask | null;
+        decontaminate?: number;
+        radius?: number;
+    }): SerializedLayeredImageEditorState;
     /** Whether the long selections run in a worker. */
     get hasSelectionWorker(): boolean;
     /**
@@ -1696,6 +1717,8 @@ export declare class ImageEditorController {
      * its alpha.
      */
     private decontaminateLayer;
+    /** `layer`'s surface with Decontaminate Colors applied along `coverage`'s soft edge, colours read from `source`. */
+    private decontaminatedSurface;
     /**
      * Loads a selection from a mask image (an AI segmentation, a saved mask): a data URL / URL or
      * RGBA pixels, by luminance (white = selected) or a channel. Any size; it is resampled.

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

@@ -1,4 +1,4 @@
-import { AdjustmentKind, AdjustmentLayer, AdjustmentParamsMap, Annotation, CreateAnnotationPayload, AspectRatio, CropBox, DepthMaskOptions, ExportOptions, ImageAdjustments, ImageDimensions, ImageEditorFit, ImageEditorOptions, ImageEditorState, ImageEditorTool, ImageTransform, ImagePoint, SerializedImageEditorState } from './types.js';
+import { AdjustmentKind, AdjustmentLayer, AdjustmentParamsMap, Annotation, CreateAnnotationPayload, AspectRatio, CropBox, DepthMaskOptions, ExportOptions, ImageAdjustments, ImageDimensions, ImageEditorFit, ImageEditorOptions, ImageEditorState, ImageEditorTool, ImageTransform, ImagePoint, SerializedImageEditorState, DocumentOpener } from './types.js';
 import { type PathToSelectionOptions, type SelectionToPathOptions } from './selection/path.js';
 import { type MagneticEdgeOptions } from './selection/magnetic.js';
 import type { ObjectTarget } from './selection/segment/grabcut.js';
@@ -168,7 +168,7 @@ export interface FocusAreaCommandOptions extends FocusAreaOptions {
     sampleAllLayers?: boolean;
 }
 /** Where Select and Mask puts its result (Photoshop's Output To). */
-export type RefineOutput = 'selection' | 'layer-mask' | 'new-layer' | 'new-layer-with-mask';
+export type RefineOutput = 'selection' | 'layer-mask' | 'new-layer' | 'new-layer-with-mask' | 'new-document' | 'new-document-with-mask';
 /** What {@link ImageEditorController.refineSelectionTo} made. */
 export interface RefineOutputResult {
     output: RefineOutput;
@@ -176,6 +176,8 @@ export interface RefineOutputResult {
     layerId?: string;
     /** The layer it made (`new-layer`, `new-layer-with-mask`). */
     newLayerId?: string;
+    /** The id the host's document opener returned (`new-document`, `new-document-with-mask`). */
+    documentId?: string;
     /** How the edge was refined: by colour, or with the segmentation model (object aware). */
     refineMode: 'color' | 'object';
 }
@@ -691,6 +693,7 @@ export declare class ImageEditorController {
     /** The segmentation provider behind `selectSubject` (see `setSegmentationProvider`). */
     private segmentation;
     private selectionWorker;
+    private documentOpener;
     /** The effects provider slot (see `setEffectsProvider`). */
     readonly effects: EffectsSlot;
     /** Renders provider effects: effect smart filter results and effect layers. */
@@ -726,6 +729,24 @@ export declare class ImageEditorController {
      * A worker that is cancelled or fails is replaced by a fresh one on the next job.
      */
     setSelectionWorker(factory: SelectionWorkerFactory | null): void;
+    /** Sets (or with `null` removes) how new documents are opened (see `DocumentOpener`). Not an edit. */
+    setDocumentOpener(opener: DocumentOpener | null): void;
+    /** Whether the host can open new documents (the New Document outputs are available). */
+    get canOpenDocuments(): boolean;
+    /**
+     * A new one-layer document from the selection (or `options.selection`) on a pixel layer
+     * (`layerId`, default the active one), the size of this image: the selected pixels on
+     * transparency, or with `withMask` the whole layer masked by the selection. This document is
+     * not changed. `decontaminate` (0..100) cleans the soft edge's colours as the new-layer
+     * outputs do.
+     */
+    documentFromSelection(options?: {
+        layerId?: string;
+        withMask?: boolean;
+        selection?: SelectionMask | null;
+        decontaminate?: number;
+        radius?: number;
+    }): SerializedLayeredImageEditorState;
     /** Whether the long selections run in a worker. */
     get hasSelectionWorker(): boolean;
     /**
@@ -1696,6 +1717,8 @@ export declare class ImageEditorController {
      * its alpha.
      */
     private decontaminateLayer;
+    /** `layer`'s surface with Decontaminate Colors applied along `coverage`'s soft edge, colours read from `source`. */
+    private decontaminatedSurface;
     /**
      * Loads a selection from a mask image (an AI segmentation, a saved mask): a data URL / URL or
      * RGBA pixels, by luminance (white = selected) or a channel. Any size; it is resampled.