@pixerate/editor 0.266.2 → 0.267.0

package/dist/{chunk-472INMWH.js → chunk-ZA7L5YJB.js}

@@ -382,9 +382,72 @@ function createDrawCommands(target, options = {}) {
       readOnly: true,
       run: async () => ({ brushes: await target.listBrushes() })
     },
+    ...createBrushChoiceCommands(target, base, prefix),
     ...createGestureCommands(target, base, prefix, options)
   ];
 }
+function createBrushChoiceCommands(target, base, prefix) {
+  const { brushSettings, selectBrush, setColorLocked, setColorScheme } = target;
+  if (!brushSettings || !selectBrush || !setColorLocked || !setColorScheme) return [];
+  const settings = () => brushSettings();
+  const RESULT = "Returns { brush, color, colorScheme, colorLocked, colorFollowsScheme } (colorFollowsScheme: the colour is a brush's light / dark default and changes with the scheme).";
+  return [
+    {
+      ...base,
+      id: `${prefix}selectBrush`,
+      label: "Choose Pen Brush",
+      keywords: ["brush", "pen", "pick brush", "chalk", "pencil", "ink"],
+      description: `Chooses the brush the pen and highlighter draw with by hand (brushId from canvas.listBrushes, or null for a plain vector stroke), at the brush's own size. A brush with a default colour (the ballpoint's blue, the chalk's light / dark pair) makes it the stroke colour unless keepColour or the colour is locked (canvas.setColorLocked). Does not draw; canvas.drawFreehand takes its own brush. ${RESULT}`,
+      params: {
+        type: "object",
+        additionalProperties: false,
+        required: ["brushId"],
+        properties: {
+          brushId: { type: ["string", "null"], minLength: 1, description: "A brush id from canvas.listBrushes, or null for a plain vector stroke." },
+          keepColour: { type: "boolean", description: "Keep the current stroke colour this once instead of taking the brush's default colour (default false)." }
+        }
+      },
+      run: async (_ctx, params) => {
+        await selectBrush(params.brushId, params.keepColour ? { keepColour: true } : {});
+        return settings();
+      }
+    },
+    {
+      ...base,
+      id: `${prefix}setColorLocked`,
+      label: "Keep My Colour",
+      keywords: ["lock colour", "keep colour", "brush colour", "color lock"],
+      description: `Locks or unlocks the stroke colour ("Keep my colour"): while locked, canvas.selectBrush keeps the current colour instead of taking a brush's default colour. ${RESULT}`,
+      params: {
+        type: "object",
+        additionalProperties: false,
+        required: ["locked"],
+        properties: { locked: { type: "boolean", description: "true locks the colour, false unlocks it (the canvas starts unlocked)." } }
+      },
+      run: (_ctx, params) => {
+        setColorLocked(params.locked);
+        return settings();
+      }
+    },
+    {
+      ...base,
+      id: `${prefix}setColorScheme`,
+      label: "Brush Colours for Light / Dark",
+      keywords: ["colour scheme", "dark mode", "light mode", "theme", "brush colour"],
+      description: `Sets the colour scheme that picks the side of a brush's light / dark default colour (white chalk in dark, dark chalk in light). A stroke colour that came from such a default follows; strokes already drawn keep theirs, and canvas.drawFreehand resolves brush defaults for this scheme. The host usually sets it to match its theme. ${RESULT}`,
+      params: {
+        type: "object",
+        additionalProperties: false,
+        required: ["scheme"],
+        properties: { scheme: { type: "string", enum: ["light", "dark"], description: "light (dark chalk on a light background) or dark (light chalk on a dark one)." } }
+      },
+      run: (_ctx, params) => {
+        setColorScheme(params.scheme);
+        return settings();
+      }
+    }
+  ];
+}
 var GESTURE_RECT_PARAM = {
   type: "object",
   additionalProperties: false,

package/dist/commands/builtins.d.cts

@@ -1,7 +1,7 @@
 import type { HistoryState } from '../history/types.cjs';
 import type { CanvasArrangeAction } from '../canvas/arrangeShortcuts.cjs';
 import type { AlignEdge, DistributeAxis, DistributeMode, ZOrderOperation } from '../canvas/arrange.cjs';
-import type { CanvasBrush, CanvasBrushPaint, CanvasBrushPreset } from '../canvas/brushTypes.cjs';
+import type { CanvasBrush, CanvasBrushPaint, CanvasBrushPreset, CanvasBrushChoice } from '../canvas/brushTypes.cjs';
 import type { CommandSpec } from './registry.cjs';
 import type { PlaybackStep } from '../tools/playback.cjs';
 import { type ShortcutBinding } from './shortcuts.cjs';
@@ -133,6 +133,17 @@ export interface DrawCommandTarget {
         width: number;
         height: number;
     } | undefined;
+    /**
+     * The brush picker's state, for `canvas.selectBrush`, `canvas.setColorLocked` and
+     * `canvas.setColorScheme` (registered only when the target has all of these; the draw
+     * controller does).
+     */
+    brushSettings?(): CanvasBrushChoice;
+    selectBrush?(id: string | null, choice?: {
+        keepColour?: boolean;
+    }): Promise<CanvasBrushPreset | null>;
+    setColorLocked?(locked: boolean): void;
+    setColorScheme?(scheme: 'light' | 'dark'): void;
 }
 export interface DrawCommandOptions {
     /** Id prefix (default `canvas.`). */

package/dist/commands/builtins.d.ts

@@ -1,7 +1,7 @@
 import type { HistoryState } from '../history/types.js';
 import type { CanvasArrangeAction } from '../canvas/arrangeShortcuts.js';
 import type { AlignEdge, DistributeAxis, DistributeMode, ZOrderOperation } from '../canvas/arrange.js';
-import type { CanvasBrush, CanvasBrushPaint, CanvasBrushPreset } from '../canvas/brushTypes.js';
+import type { CanvasBrush, CanvasBrushPaint, CanvasBrushPreset, CanvasBrushChoice } from '../canvas/brushTypes.js';
 import type { CommandSpec } from './registry.js';
 import type { PlaybackStep } from '../tools/playback.js';
 import { type ShortcutBinding } from './shortcuts.js';
@@ -133,6 +133,17 @@ export interface DrawCommandTarget {
         width: number;
         height: number;
     } | undefined;
+    /**
+     * The brush picker's state, for `canvas.selectBrush`, `canvas.setColorLocked` and
+     * `canvas.setColorScheme` (registered only when the target has all of these; the draw
+     * controller does).
+     */
+    brushSettings?(): CanvasBrushChoice;
+    selectBrush?(id: string | null, choice?: {
+        keepColour?: boolean;
+    }): Promise<CanvasBrushPreset | null>;
+    setColorLocked?(locked: boolean): void;
+    setColorScheme?(scheme: 'light' | 'dark'): void;
 }
 export interface DrawCommandOptions {
     /** Id prefix (default `canvas.`). */

package/dist/commands/index.cjs

@@ -22,7 +22,7 @@ var _chunkKIJIONZFcjs = require('../chunk-KIJIONZF.cjs');
 
 
 
-var _chunk7KNW3WXZcjs = require('../chunk-7KNW3WXZ.cjs');
+var _chunkQEVLRLUNcjs = require('../chunk-QEVLRLUN.cjs');
 require('../chunk-E2Z4UARJ.cjs');
 
 
@@ -413,4 +413,4 @@ function createCanvasAnimationCommands(controller, options = {}) {
 
 
 
-exports.CommandRegistry = _chunkKIJIONZFcjs.CommandRegistry; exports.CommandRegistryError = _chunkKIJIONZFcjs.CommandRegistryError; exports.DEFAULT_HISTORY_SHORTCUTS = _chunk7KNW3WXZcjs.DEFAULT_HISTORY_SHORTCUTS; exports.DEFAULT_RECENT_LIMIT = _chunkKIJIONZFcjs.DEFAULT_RECENT_LIMIT; exports.PLATFORMS = _chunkQJVOJUTDcjs.PLATFORMS; exports.ShortcutMap = _chunkQJVOJUTDcjs.ShortcutMap; exports.chordToString = _chunkQJVOJUTDcjs.chordToString; exports.codeFromKey = _chunkQJVOJUTDcjs.codeFromKey; exports.codeToKeyText = _chunkQJVOJUTDcjs.codeToKeyText; exports.createArrangeCommands = _chunk7KNW3WXZcjs.createArrangeCommands; exports.createCanvasAnimationCommands = createCanvasAnimationCommands; exports.createCommandPaletteController = createCommandPaletteController; exports.createCommandRegistry = _chunkKIJIONZFcjs.createCommandRegistry; exports.createCommandToolProvider = _chunkKIJIONZFcjs.createCommandToolProvider; exports.createComponentCommands = _chunk7KNW3WXZcjs.createComponentCommands; exports.createDrawCommands = _chunk7KNW3WXZcjs.createDrawCommands; exports.createFormatCommands = _chunkVCL7CB56cjs.createFormatCommands; exports.createHistoryCommands = _chunk7KNW3WXZcjs.createHistoryCommands; exports.createShapeCommands = _chunk7KNW3WXZcjs.createShapeCommands; exports.createSpreadsheetCommands = _chunk7KNW3WXZcjs.createSpreadsheetCommands; exports.defineCommand = _chunkKIJIONZFcjs.defineCommand; exports.detectPlatform = _chunkQJVOJUTDcjs.detectPlatform; exports.effectiveChord = _chunkQJVOJUTDcjs.effectiveChord; exports.effectiveChordKey = _chunkQJVOJUTDcjs.effectiveChordKey; exports.eventCode = _chunkQJVOJUTDcjs.eventCode; exports.exactBonus = _chunkKIJIONZFcjs.exactBonus; exports.formatCommandsFor = _chunkVCL7CB56cjs.formatCommandsFor; exports.formatShortcut = _chunkQJVOJUTDcjs.formatShortcut; exports.fuzzyMatch = _chunkKIJIONZFcjs.fuzzyMatch; exports.fuzzyScore = _chunkKIJIONZFcjs.fuzzyScore; exports.hasVariantCommands = _chunk7KNW3WXZcjs.hasVariantCommands; exports.isEditableEventTarget = _chunkQJVOJUTDcjs.isEditableEventTarget; exports.keyToCode = _chunkQJVOJUTDcjs.keyToCode; exports.matchHistoryShortcut = _chunk7KNW3WXZcjs.matchHistoryShortcut; exports.matchPaletteHotkey = matchPaletteHotkey; exports.normalizeChord = _chunkQJVOJUTDcjs.normalizeChord; exports.parseChord = _chunkQJVOJUTDcjs.parseChord; exports.planFreehandPlayback = _chunk7KNW3WXZcjs.planFreehandPlayback; exports.pushRecent = _chunkKIJIONZFcjs.pushRecent; exports.rankCommands = _chunkKIJIONZFcjs.rankCommands; exports.shortcutCode = _chunkQJVOJUTDcjs.shortcutCode; exports.toShortcutBindings = _chunkQJVOJUTDcjs.toShortcutBindings;
+exports.CommandRegistry = _chunkKIJIONZFcjs.CommandRegistry; exports.CommandRegistryError = _chunkKIJIONZFcjs.CommandRegistryError; exports.DEFAULT_HISTORY_SHORTCUTS = _chunkQEVLRLUNcjs.DEFAULT_HISTORY_SHORTCUTS; exports.DEFAULT_RECENT_LIMIT = _chunkKIJIONZFcjs.DEFAULT_RECENT_LIMIT; exports.PLATFORMS = _chunkQJVOJUTDcjs.PLATFORMS; exports.ShortcutMap = _chunkQJVOJUTDcjs.ShortcutMap; exports.chordToString = _chunkQJVOJUTDcjs.chordToString; exports.codeFromKey = _chunkQJVOJUTDcjs.codeFromKey; exports.codeToKeyText = _chunkQJVOJUTDcjs.codeToKeyText; exports.createArrangeCommands = _chunkQEVLRLUNcjs.createArrangeCommands; exports.createCanvasAnimationCommands = createCanvasAnimationCommands; exports.createCommandPaletteController = createCommandPaletteController; exports.createCommandRegistry = _chunkKIJIONZFcjs.createCommandRegistry; exports.createCommandToolProvider = _chunkKIJIONZFcjs.createCommandToolProvider; exports.createComponentCommands = _chunkQEVLRLUNcjs.createComponentCommands; exports.createDrawCommands = _chunkQEVLRLUNcjs.createDrawCommands; exports.createFormatCommands = _chunkVCL7CB56cjs.createFormatCommands; exports.createHistoryCommands = _chunkQEVLRLUNcjs.createHistoryCommands; exports.createShapeCommands = _chunkQEVLRLUNcjs.createShapeCommands; exports.createSpreadsheetCommands = _chunkQEVLRLUNcjs.createSpreadsheetCommands; exports.defineCommand = _chunkKIJIONZFcjs.defineCommand; exports.detectPlatform = _chunkQJVOJUTDcjs.detectPlatform; exports.effectiveChord = _chunkQJVOJUTDcjs.effectiveChord; exports.effectiveChordKey = _chunkQJVOJUTDcjs.effectiveChordKey; exports.eventCode = _chunkQJVOJUTDcjs.eventCode; exports.exactBonus = _chunkKIJIONZFcjs.exactBonus; exports.formatCommandsFor = _chunkVCL7CB56cjs.formatCommandsFor; exports.formatShortcut = _chunkQJVOJUTDcjs.formatShortcut; exports.fuzzyMatch = _chunkKIJIONZFcjs.fuzzyMatch; exports.fuzzyScore = _chunkKIJIONZFcjs.fuzzyScore; exports.hasVariantCommands = _chunkQEVLRLUNcjs.hasVariantCommands; exports.isEditableEventTarget = _chunkQJVOJUTDcjs.isEditableEventTarget; exports.keyToCode = _chunkQJVOJUTDcjs.keyToCode; exports.matchHistoryShortcut = _chunkQEVLRLUNcjs.matchHistoryShortcut; exports.matchPaletteHotkey = matchPaletteHotkey; exports.normalizeChord = _chunkQJVOJUTDcjs.normalizeChord; exports.parseChord = _chunkQJVOJUTDcjs.parseChord; exports.planFreehandPlayback = _chunkQEVLRLUNcjs.planFreehandPlayback; exports.pushRecent = _chunkKIJIONZFcjs.pushRecent; exports.rankCommands = _chunkKIJIONZFcjs.rankCommands; exports.shortcutCode = _chunkQJVOJUTDcjs.shortcutCode; exports.toShortcutBindings = _chunkQJVOJUTDcjs.toShortcutBindings;

package/dist/commands/index.js

@@ -22,7 +22,7 @@ import {
   hasVariantCommands,
   matchHistoryShortcut,
   planFreehandPlayback
-} from "../chunk-472INMWH.js";
+} from "../chunk-ZA7L5YJB.js";
 import "../chunk-55ALHYJY.js";
 import {
   PLATFORMS,

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

@@ -2583,7 +2583,7 @@ export declare class ImageEditorController {
      */
     private checkPsdFonts;
     /**
-     * The document as an RGB PSD at its bit depth (8, 16 or 32) (PSB above 30 000 px) with real layers, groups, adjustment
+     * The document as a PSD in its colour mode (RGB, CMYK or Lab) at its bit depth (PSB above 30 000 px) with real layers, groups, adjustment
      * layers and masks, in the source frame. Layer filters and parametric (depth) masks are baked
      * into pixels and masks, annotation layers are rasterized (in a browser; elsewhere they are left
      * out), and the merged image is our composite. `warnings` lists every such change.

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

@@ -2583,7 +2583,7 @@ export declare class ImageEditorController {
      */
     private checkPsdFonts;
     /**
-     * The document as an RGB PSD at its bit depth (8, 16 or 32) (PSB above 30 000 px) with real layers, groups, adjustment
+     * The document as a PSD in its colour mode (RGB, CMYK or Lab) at its bit depth (PSB above 30 000 px) with real layers, groups, adjustment
      * layers and masks, in the source frame. Layer filters and parametric (depth) masks are baked
      * into pixels and masks, annotation layers are rasterized (in a browser; elsewhere they are left
      * out), and the merged image is our composite. `warnings` lists every such change.