@pixerate/editor 0.246.0 → 0.248.0

package/dist/image-editor/effect-tools.d.ts

@@ -1,11 +1,44 @@
 import type { AgentTool } from '../tools/registry.js';
 import type { ImageEditorController } from './controller.js';
-import { type LayerEffects } from '../raster/effects/model.js';
+import { type LayerEffectKind, type GlobalLight, type LayerEffects } from '../raster/effects/model.js';
+import { type EffectPattern } from '../raster/effects/patterns.js';
 /** A layer's effects for agents: the master switch, scale, reach and every effect with its settings. */
 export declare function describeLayerEffects(effects: LayerEffects): Record<string, unknown>;
 /**
- * Agent tools for layer effects: `list_layer_effects`, `add_layer_effect`, `update_layer_effect`,
- * `remove_layer_effect`, `set_layer_effects_enabled` and `set_global_light`. Each write validates
- * every setting first, is one undo step and returns the layer's effects after the change.
+ * What the layer effect tools need of an editor. The image and paint editors both provide it, so
+ * both get the same tools, schemas and defaults (`../raster/effects/model`).
  */
+export interface LayerEffectsHost {
+    /** Throws a helpful error when `id` is not a layer that can take effects. */
+    requireLayer(id: string): void;
+    getLayerEffects(id: string): LayerEffects;
+    addLayerEffect(id: string, kind: LayerEffectKind, settings: Record<string, unknown>, index?: number): {
+        effect: {
+            id: string;
+        };
+    };
+    updateLayerEffect(id: string, effectId: string, changes: Record<string, unknown>): unknown;
+    removeLayerEffect(id: string, effectId: string): unknown;
+    setLayerEffectsEnabled(id: string, enabled: boolean, scale?: number): unknown;
+    /** The light shadows and bevels with useGlobalLight follow; without it, the default 120° / 30°. */
+    getGlobalLight?(): GlobalLight;
+    /** With it, the `set_global_light` tool is offered. */
+    setGlobalLight?(light: Partial<GlobalLight>): GlobalLight;
+    /** Document patterns beside the built-in ones (from a PSD). */
+    getDocumentPatterns?(): readonly EffectPattern[];
+}
+export interface LayerEffectToolsOptions {
+    /** What a layerId may name, for its description (e.g. "a pixel, shape, smart object, annotation or group layer"). */
+    layers: string;
+    /** Turns a refusal into the host's error type (default LayerOperationError). */
+    error?: (message: string) => Error;
+}
+/** The image editor's layer effect tools (see `createLayerEffectTools`). */
 export declare function createImageEffectTools(controller: ImageEditorController): AgentTool[];
+/**
+ * Agent tools for layer effects: `list_layer_effects`, `add_layer_effect`, `update_layer_effect`,
+ * `remove_layer_effect`, `set_layer_effects_enabled` and, when the host has a global light to set,
+ * `set_global_light`. Each write validates every setting first, is one undo step and returns the
+ * layer's effects after the change.
+ */
+export declare function createLayerEffectTools(host: LayerEffectsHost, options: LayerEffectToolsOptions): AgentTool[];