@pixerate/editor-react 0.77.0 → 0.78.0

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

@@ -1,5 +1,7 @@
-import { ImageEditorController, ImageEditorState, ImageEditorTool, CropBox, AspectRatio, ImageAdjustments, AdjustmentKind, AdjustmentLayerInit, AdjustmentLayerUpdate, ImageHistogram, DepthMaskOptions, CreateAnnotationPayload, Annotation, ImagePoint, ExportOptions, SerializedImageEditorState, AIResultOptions, ImageEditorOptions, InpaintHook, RemoveBackgroundHook, ImageEditorAIHooks, ControlSpec, CurvePoint, AdjustmentLayer, SelectionToolOptions, SelectionMask, FreeTransformTool, ShapeToolOptions, TypeToolOptions, TextEditSession } from '@pixerate/editor/image-editor';
+import { ToolRegistry } from '@pixerate/editor/tools';
+import { ImageEditorController, ImageEditorState, ImageEditorTool, CropBox, AspectRatio, ImageAdjustments, AdjustmentKind, AdjustmentLayerInit, AdjustmentLayerUpdate, ImageHistogram, DepthMaskOptions, CreateAnnotationPayload, Annotation, ImagePoint, ExportOptions, SerializedImageEditorState, AIResultOptions, ImageEditorOptions, ImageEffectsToolProviderOptions, InpaintHook, RemoveBackgroundHook, ImageEditorAIHooks, ControlSpec, CurvePoint, AdjustmentLayer, SelectionToolOptions, SelectionMask, FreeTransformTool, ShapeToolOptions, TypeToolOptions, TextEditSession } from '@pixerate/editor/image-editor';
 import React__default from 'react';
+import { EffectProvider } from '@pixerate/editor/effects';
 import { P as PaintGradientEditorProps } from '../PaintGradientEditorView-CCPCY5Ib.cjs';
 import '@pixerate/editor/paint-editor';
 
@@ -64,6 +66,13 @@ interface UseImageEditorReturn {
     applyBackgroundRemovedImage: (newDataUrl: string, options?: AIResultOptions) => Promise<string | void>;
 }
 declare function useImageEditor(options?: ImageEditorOptions): UseImageEditorReturn;
+/**
+ * Registers the image editor's provider-effect tools (`search_effects`, `describe_effect`,
+ * `apply_effect`, `add_effect_layer`, …) in `registry` while mounted. They work once an effects
+ * provider is registered (see `useEffects`); before that the read tools say so and the write tools
+ * refuse.
+ */
+declare function useImageEffectsTools(registry: ToolRegistry | null | undefined, controller: ImageEditorController, options?: ImageEffectsToolProviderOptions): void;
 
 interface ImageEditorProps {
     editor?: UseImageEditorReturn;
@@ -75,6 +84,12 @@ interface ImageEditorProps {
     onInpaint?: InpaintHook;
     onRemoveBackground?: RemoveBackgroundHook;
     aiHooks?: ImageEditorAIHooks;
+    /**
+     * An effects provider (see `@pixerate/editor/effects`), registered with the controller while
+     * mounted: filter effects as smart filters and generator or overlay effects as effect layers,
+     * with an Effects section in the Layers tab. Optional: without one the editor is as before.
+     */
+    effects?: EffectProvider | null;
 }
 declare const ImageEditor: React__default.FC<ImageEditorProps>;
 
@@ -263,7 +278,19 @@ interface TypeOptionsBarProps {
  */
 declare const TypeOptionsBar: React__default.FC<TypeOptionsBarProps>;
 
+interface ImageProviderEffectsPanelProps {
+    controller: ImageEditorController;
+    className?: string;
+}
+/**
+ * Provider effects in the image editor, for the active layer: its effect smart filters (apply,
+ * turn on and off, opacity, reorder, change controls, remove) and, for an effect layer, its own
+ * controls; plus adding effect layers. Applying a filter effect to a pixel layer converts it to a
+ * smart object in the same undo step. Without a provider it says why nothing can be added.
+ */
+declare function ImageProviderEffectsPanel({ controller, className }: ImageProviderEffectsPanelProps): React__default.JSX.Element;
+
 /** The gradient paint editor for the image editor's brush (see `PaintGradientEditorView`). */
 declare const PaintGradientEditor: React__default.FC<PaintGradientEditorProps>;
 
-export { AdjustmentLayersPanel, type AdjustmentLayersPanelProps, BrushOptionsBar, type BrushOptionsBarProps, ColorProfilePanel, type ColorProfilePanelProps, ControlSlider, type ControlSliderProps, CurvesEditor, type CurvesEditorProps, FreeTransformOptionsBar, type FreeTransformOptionsBarProps, Histogram, type HistogramProps, ImageEditor, type ImageEditorProps, LayerEffectsPanel, type LayerEffectsPanelProps, LayersPanel, type LayersPanelProps, PaintGradientEditor, PaintGradientEditorProps, RefineEdgePanel, type RefineEdgePanelProps, SelectionOptionsBar, type SelectionOptionsBarProps, ShapeOptionsBar, type ShapeOptionsBarProps, TypeOptionsBar, type TypeOptionsBarProps, type UseImageEditorReturn, useImageEditor, useImageHistogram };
+export { AdjustmentLayersPanel, type AdjustmentLayersPanelProps, BrushOptionsBar, type BrushOptionsBarProps, ColorProfilePanel, type ColorProfilePanelProps, ControlSlider, type ControlSliderProps, CurvesEditor, type CurvesEditorProps, FreeTransformOptionsBar, type FreeTransformOptionsBarProps, Histogram, type HistogramProps, ImageEditor, type ImageEditorProps, ImageProviderEffectsPanel, type ImageProviderEffectsPanelProps, LayerEffectsPanel, type LayerEffectsPanelProps, LayersPanel, type LayersPanelProps, PaintGradientEditor, PaintGradientEditorProps, RefineEdgePanel, type RefineEdgePanelProps, SelectionOptionsBar, type SelectionOptionsBarProps, ShapeOptionsBar, type ShapeOptionsBarProps, TypeOptionsBar, type TypeOptionsBarProps, type UseImageEditorReturn, useImageEditor, useImageEffectsTools, useImageHistogram };

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

@@ -1,5 +1,7 @@
-import { ImageEditorController, ImageEditorState, ImageEditorTool, CropBox, AspectRatio, ImageAdjustments, AdjustmentKind, AdjustmentLayerInit, AdjustmentLayerUpdate, ImageHistogram, DepthMaskOptions, CreateAnnotationPayload, Annotation, ImagePoint, ExportOptions, SerializedImageEditorState, AIResultOptions, ImageEditorOptions, InpaintHook, RemoveBackgroundHook, ImageEditorAIHooks, ControlSpec, CurvePoint, AdjustmentLayer, SelectionToolOptions, SelectionMask, FreeTransformTool, ShapeToolOptions, TypeToolOptions, TextEditSession } from '@pixerate/editor/image-editor';
+import { ToolRegistry } from '@pixerate/editor/tools';
+import { ImageEditorController, ImageEditorState, ImageEditorTool, CropBox, AspectRatio, ImageAdjustments, AdjustmentKind, AdjustmentLayerInit, AdjustmentLayerUpdate, ImageHistogram, DepthMaskOptions, CreateAnnotationPayload, Annotation, ImagePoint, ExportOptions, SerializedImageEditorState, AIResultOptions, ImageEditorOptions, ImageEffectsToolProviderOptions, InpaintHook, RemoveBackgroundHook, ImageEditorAIHooks, ControlSpec, CurvePoint, AdjustmentLayer, SelectionToolOptions, SelectionMask, FreeTransformTool, ShapeToolOptions, TypeToolOptions, TextEditSession } from '@pixerate/editor/image-editor';
 import React__default from 'react';
+import { EffectProvider } from '@pixerate/editor/effects';
 import { P as PaintGradientEditorProps } from '../PaintGradientEditorView-CCPCY5Ib.js';
 import '@pixerate/editor/paint-editor';
 
@@ -64,6 +66,13 @@ interface UseImageEditorReturn {
     applyBackgroundRemovedImage: (newDataUrl: string, options?: AIResultOptions) => Promise<string | void>;
 }
 declare function useImageEditor(options?: ImageEditorOptions): UseImageEditorReturn;
+/**
+ * Registers the image editor's provider-effect tools (`search_effects`, `describe_effect`,
+ * `apply_effect`, `add_effect_layer`, …) in `registry` while mounted. They work once an effects
+ * provider is registered (see `useEffects`); before that the read tools say so and the write tools
+ * refuse.
+ */
+declare function useImageEffectsTools(registry: ToolRegistry | null | undefined, controller: ImageEditorController, options?: ImageEffectsToolProviderOptions): void;
 
 interface ImageEditorProps {
     editor?: UseImageEditorReturn;
@@ -75,6 +84,12 @@ interface ImageEditorProps {
     onInpaint?: InpaintHook;
     onRemoveBackground?: RemoveBackgroundHook;
     aiHooks?: ImageEditorAIHooks;
+    /**
+     * An effects provider (see `@pixerate/editor/effects`), registered with the controller while
+     * mounted: filter effects as smart filters and generator or overlay effects as effect layers,
+     * with an Effects section in the Layers tab. Optional: without one the editor is as before.
+     */
+    effects?: EffectProvider | null;
 }
 declare const ImageEditor: React__default.FC<ImageEditorProps>;
 
@@ -263,7 +278,19 @@ interface TypeOptionsBarProps {
  */
 declare const TypeOptionsBar: React__default.FC<TypeOptionsBarProps>;
 
+interface ImageProviderEffectsPanelProps {
+    controller: ImageEditorController;
+    className?: string;
+}
+/**
+ * Provider effects in the image editor, for the active layer: its effect smart filters (apply,
+ * turn on and off, opacity, reorder, change controls, remove) and, for an effect layer, its own
+ * controls; plus adding effect layers. Applying a filter effect to a pixel layer converts it to a
+ * smart object in the same undo step. Without a provider it says why nothing can be added.
+ */
+declare function ImageProviderEffectsPanel({ controller, className }: ImageProviderEffectsPanelProps): React__default.JSX.Element;
+
 /** The gradient paint editor for the image editor's brush (see `PaintGradientEditorView`). */
 declare const PaintGradientEditor: React__default.FC<PaintGradientEditorProps>;
 
-export { AdjustmentLayersPanel, type AdjustmentLayersPanelProps, BrushOptionsBar, type BrushOptionsBarProps, ColorProfilePanel, type ColorProfilePanelProps, ControlSlider, type ControlSliderProps, CurvesEditor, type CurvesEditorProps, FreeTransformOptionsBar, type FreeTransformOptionsBarProps, Histogram, type HistogramProps, ImageEditor, type ImageEditorProps, LayerEffectsPanel, type LayerEffectsPanelProps, LayersPanel, type LayersPanelProps, PaintGradientEditor, PaintGradientEditorProps, RefineEdgePanel, type RefineEdgePanelProps, SelectionOptionsBar, type SelectionOptionsBarProps, ShapeOptionsBar, type ShapeOptionsBarProps, TypeOptionsBar, type TypeOptionsBarProps, type UseImageEditorReturn, useImageEditor, useImageHistogram };
+export { AdjustmentLayersPanel, type AdjustmentLayersPanelProps, BrushOptionsBar, type BrushOptionsBarProps, ColorProfilePanel, type ColorProfilePanelProps, ControlSlider, type ControlSliderProps, CurvesEditor, type CurvesEditorProps, FreeTransformOptionsBar, type FreeTransformOptionsBarProps, Histogram, type HistogramProps, ImageEditor, type ImageEditorProps, ImageProviderEffectsPanel, type ImageProviderEffectsPanelProps, LayerEffectsPanel, type LayerEffectsPanelProps, LayersPanel, type LayersPanelProps, PaintGradientEditor, PaintGradientEditorProps, RefineEdgePanel, type RefineEdgePanelProps, SelectionOptionsBar, type SelectionOptionsBarProps, ShapeOptionsBar, type ShapeOptionsBarProps, TypeOptionsBar, type TypeOptionsBarProps, type UseImageEditorReturn, useImageEditor, useImageEffectsTools, useImageHistogram };

package/dist/image-editor/index.js

@@ -7,6 +7,7 @@ import {
   FreeTransformOptionsBar,
   Histogram,
   ImageEditor,
+  ImageProviderEffectsPanel,
   LayerEffectsPanel,
   LayersPanel,
   PaintGradientEditor,
@@ -15,8 +16,11 @@ import {
   ShapeOptionsBar,
   TypeOptionsBar,
   useImageEditor,
+  useImageEffectsTools,
   useImageHistogram
-} from "../chunk-QARGR5E5.js";
+} from "../chunk-2EW42UXC.js";
+import "../chunk-FX3EREF5.js";
+import "../chunk-ZQZAKUUM.js";
 import "../chunk-MO354USR.js";
 export {
   AdjustmentLayersPanel,
@@ -27,6 +31,7 @@ export {
   FreeTransformOptionsBar,
   Histogram,
   ImageEditor,
+  ImageProviderEffectsPanel,
   LayerEffectsPanel,
   LayersPanel,
   PaintGradientEditor,
@@ -35,6 +40,7 @@ export {
   ShapeOptionsBar,
   TypeOptionsBar,
   useImageEditor,
+  useImageEffectsTools,
   useImageHistogram
 };
 //# sourceMappingURL=index.js.map