@pixerate/editor 0.262.1 → 0.264.0

package/dist/vector/index.js

@@ -26,7 +26,7 @@ import {
   traceField,
   traceVectorImage,
   vectorTraceContours
-} from "../chunk-CQVTGBQI.js";
+} from "../chunk-CECCP2V7.js";
 import {
   applyHomography,
   homographyFromPoints,
@@ -53,7 +53,7 @@ import {
   reverseMorphContour,
   subpathToMorphContour,
   turnMorphContour
-} from "../chunk-QAR2N7HZ.js";
+} from "../chunk-ROBSFJ6F.js";
 import {
   DEFAULT_VECTOR_FONT,
   IDENTITY_MATRIX,
@@ -529,11 +529,11 @@ import {
   withVectorStrokes,
   withVectorTargetPaint,
   zigzagPaths
-} from "../chunk-6NZL24W4.js";
+} from "../chunk-WWI6FLH2.js";
 import {
   snapshotBrushLibrary
-} from "../chunk-5IW65VQ6.js";
-import "../chunk-APX63ILU.js";
+} from "../chunk-EE7SAYBF.js";
+import "../chunk-ACFSFUQH.js";
 import {
   createProvenance
 } from "../chunk-M6DNZNVY.js";
@@ -6829,6 +6829,8 @@ var VectorEditorController = class _VectorEditorController {
   colorScheme;
   constructor(options = {}) {
     this.colorScheme = options.colorScheme ?? "light";
+    this.brushLibrary = options.brushLibrary ?? null;
+    this.brushPreview = options.brushPreview ?? null;
     this.brushes = options.brushLibrary ? snapshotBrushLibrary(options.brushLibrary, () => this.notify()) : null;
     this.history = options.history ?? new HistoryManager();
     this.doc = options.document ? loadedDocument(options.document) : { width: 800, height: 600, nodes: [] };
@@ -6867,6 +6869,14 @@ var VectorEditorController = class _VectorEditorController {
    */
   /** The saved brushes of the brush library as last read (empty without one). */
   brushes;
+  /** The brush library brushstrokes use (`brushLibrary` option), or `null`. A full `BrushLibrary` lets the UI edit brushes (`isBrushLibrary`). */
+  brushLibrary;
+  /** The `brushPreview` option: draws the brush editor's preview stroke, or `null`. */
+  brushPreview;
+  /** Reads the brush library again now (it is also read after every change to it); resolves once read. */
+  refreshBrushes() {
+    return this.brushes?.refresh() ?? Promise.resolve();
+  }
   /** The brushes a brushstroke can use: the presets, then the brush library's saved brushes the vector profile admits. */
   listBrushstrokeBrushes() {
     return vectorBrushstrokeBrushes(this.brushes?.user ?? []);
@@ -8236,7 +8246,7 @@ var VectorEditorController = class _VectorEditorController {
       (stack, path) => {
         const layer = stack[index];
         if (!layer || layer.kind !== "brushstroke" || !layer.brush) return `Path "${path.id}" has no brushstroke at stroke ${index} (vector.getAppearance lists its strokes; 0 is the bottom).`;
-        const brush = patch.brushId && patch.brushId !== layer.brush.brushId ? { ...layer.brush, brushId: patch.brushId, spec: void 0 } : { ...layer.brush };
+        const brush = patch.brushId ? { ...layer.brush, brushId: patch.brushId, spec: void 0 } : { ...layer.brush };
         if (patch.size === null) delete brush.size;
         else if (patch.size !== void 0) brush.size = patch.size;
         if (patch.pressure === null) delete brush.pressure;
@@ -15985,7 +15995,7 @@ function createVectorCommands(controller, options = {}) {
       id: `${prefix}setBrushstroke`,
       label: "Edit Brushstroke\u2026",
       keywords: ["brushstroke", "brush", "size", "pressure", "taper"],
-      description: "Changes the brushstroke at stroke layer `index` of path `id` (vector.getAppearance lists strokes; 0 is the bottom): `brushId`, `size` (null: the brush's own), `pressure` (null: full pressure), `color`, `opacity`, `seed` (turns the brush's character on; null: plain dabs) and `paper` (replaced whole; null: no grain; {}: the default paper). Pass at least one. One undo step. Returns { id, strokes }.",
+      description: "Changes the brushstroke at stroke layer `index` of path `id` (vector.getAppearance lists strokes; 0 is the bottom): `brushId` (the same id again takes that saved brush as the library has it now), `size` (null: the brush's own), `pressure` (null: full pressure), `color`, `opacity`, `seed` (turns the brush's character on; null: plain dabs) and `paper` (replaced whole; null: no grain; {}: the default paper). Pass at least one. One undo step. Returns { id, strokes }.",
       params: {
         type: "object",
         properties: {
@@ -18372,10 +18382,11 @@ function stickerVectorGroup(placement, id = "sticker") {
   const s = placement.width / box.width;
   return transformVectorNode(group, [s, 0, 0, s, placement.x - box.width * s / 2, placement.y - box.height * s / 2]);
 }
-function createVectorStickerHost(controller) {
+function createVectorStickerHost(controller, options = {}) {
   return {
     noun: "group of editable paths",
     format: "svg",
+    ...options.dark ? { dark: options.dark } : {},
     defaultCentre: () => {
       const d = controller.getDocument();
       return { x: d.width / 2, y: d.height / 2 };

package/dist/vector/stickers.d.cts

@@ -7,5 +7,10 @@ import type { VectorEditorController } from './controller.cjs';
 import type { VectorGroupNode } from './types.cjs';
 /** A group of the sticker's paths, `placement.width` wide and centred on (`x`, `y`). */
 export declare function stickerVectorGroup(placement: StickerPlacement, id?: string): VectorGroupNode;
-/** `insert_sticker` for a vector editor: a group of editable paths, one undo step, selected. */
-export declare function createVectorStickerHost(controller: VectorEditorController): StickerInsertHost;
+/**
+ * `insert_sticker` for a vector editor: a group of editable paths, one undo step, selected. With
+ * `dark` (the host's dark theme or artboard), stickers that have a dark variant use it.
+ */
+export declare function createVectorStickerHost(controller: VectorEditorController, options?: {
+    dark?: () => boolean;
+}): StickerInsertHost;

package/dist/vector/stickers.d.ts

@@ -7,5 +7,10 @@ import type { VectorEditorController } from './controller.js';
 import type { VectorGroupNode } from './types.js';
 /** A group of the sticker's paths, `placement.width` wide and centred on (`x`, `y`). */
 export declare function stickerVectorGroup(placement: StickerPlacement, id?: string): VectorGroupNode;
-/** `insert_sticker` for a vector editor: a group of editable paths, one undo step, selected. */
-export declare function createVectorStickerHost(controller: VectorEditorController): StickerInsertHost;
+/**
+ * `insert_sticker` for a vector editor: a group of editable paths, one undo step, selected. With
+ * `dark` (the host's dark theme or artboard), stickers that have a dark variant use it.
+ */
+export declare function createVectorStickerHost(controller: VectorEditorController, options?: {
+    dark?: () => boolean;
+}): StickerInsertHost;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pixerate/editor",
-  "version": "0.262.1",
+  "version": "0.264.0",
   "description": "UI-agnostic rich text and media editing core library",
   "author": "Pixerate",
   "license": "MIT",

package/skills/pixerate-brushes/SKILL.md

@@ -47,6 +47,9 @@ paints without (warnings), each with a fix; lists and writes use the current hos
 
 Every host lists the presets its profile admits and the library's saved brushes it admits, and
 each registers these tools with its own profile, so `list_brush_presets` shows that host's brushes.
+People edit brushes in every host with the same brush editor, scoped the same way: it shows only
+the controls the host uses (no velocity on canvas, no grain in the image editor), and what the
+brush has for other hosts is kept on save. The tools follow the same rule (see Pitfalls).
 A saved brush used in canvas or vector strokes is copied into the stroke, so the document renders
 where the library is not; changing the brush in the library later doesn't change strokes already
 drawn.
@@ -87,8 +90,13 @@ drawn.
 
 ## Pitfalls
 
-- **A facet the host refuses.** `create_brush` and `update_brush` refuse it with the facet and
-  fix; `check_brush` returns `degraded`, the brush with those facets stripped, to start from.
+- **A facet the host refuses.** `create_brush` refuses it, and `update_brush` refuses a change
+  that adds it, with the facet and fix; `check_brush` returns `degraded`, the brush with those
+  facets stripped, to start from.
+- **Tuning a brush in a host that can't paint all of it.** `update_brush` keeps what the brush
+  already has for other hosts (a paint brush's light, changed from canvas) and lists it in
+  `kept`; it is not stripped. To make a copy for this host only, `create_brush` from
+  `check_brush`'s `degraded` brush instead.
 - **Ids.** Built-in ids can't be reused or changed; a taken id is refused (update it instead).
 - **Stamps.** Any marks take any sticker ref from `find_stickers`, or an editor stamp
   (`editor:star`…). A ref the host's sticker library can't load is refused with the closest
@@ -113,7 +121,7 @@ drawn.
 | `list_brush_presets` | Find brushes this host renders: `kind`, `medium`, `variety`, `tool`, `tag`, `text`, `source` (all, builtin, user), `all`, `offset`, `limit`. Returns `brushes` (id, name, builtin, kind, medium, variety or tool, category, engine, tip, size, marks, surface, light) and `total`. Call first. |
 | `describe_brush` | One brush by `id`: its full facet `brush` (with its `colour`: default, palette, own), `builtin`, `engine`, `category` and `check` for this host (stamp stickers included). Unknown ids are refused with the closest ones. |
 | `create_brush` | Save a new brush: `id`, `name`, optional `basedOn`, and the facets, `colour` included (to keep an editor's current brush, pass the `brush` its `get_brush` returns). Normalised and checked for this host (and its sticker library, for stamp tips); refused brushes save nothing. Returns `id`, `brush`, `engine`, `problems`, `warnings`. |
-| `update_brush` | Change a saved brush: facets to merge in, `unset` facets to drop. Refuses built-ins (duplicate first) and changes the host can't render. Returns `brush`, `changed` paths, `problems`, `warnings`. |
+| `update_brush` | Change a saved brush: facets to merge in, `unset` facets to drop. Refuses built-ins (duplicate first) and changes that add what the host can't render; keeps what the brush already had for other hosts. Returns `brush`, `changed` paths, `problems`, `warnings` and, when there are any, `kept` (facets this host can't use, left as they were). |
 | `duplicate_brush` | Copy any brush, built-ins included, to a saved brush (`newId` default `<id>-copy`, `name`). Returns the new `id` and `brush`; then `update_brush` it. |
 | `remove_brush` | Delete a saved brush for good (export it first to keep a copy). Built-ins are refused. Returns `removed`. |
 | `check_brush` | Check a brush (`id`, or an unsaved `brush` spec) for a `host` (paint, image, canvas, vector). Returns `ok`, `issues` (facet, severity, reason, fix) and, when refused, `degraded`. |

package/skills/pixerate-brushes-design/SKILL.md

@@ -61,6 +61,7 @@ Ask when you cannot tell from the request; say what you assumed when you can.
 | A shape as the tip (stars, leaves, a logo) | `tip.shape` stamp with `stamps` (an editor stamp or a ref from `find_stickers`), continuous marks; it paints in the user's colour. Keep the sticker's colours with `marks` objects. Paint editor only. |
 | A spray can or mist | `basedOn` `spray-can`, or `medium` spray with `marks` scatter (`density`, `size`). Paint editor only. |
 | A change to a built-in | `duplicate_brush`, then `update_brush` the copy. |
+| Tune a brush from a host that can't paint all of it | `update_brush` there: what the host can't use is kept (`kept`), not stripped; refused only if the change adds it. |
 
 ## Recipes
 

package/skills/pixerate-stickers/SKILL.md

@@ -1,6 +1,6 @@
 ---
 name: pixerate-stickers
-description: How to find, check and use stickers from the Pixerate sticker library through find_stickers and describe_sticker - the editor's own stamps (editor:star, editor:heart, ...) or any library a host plugged in (brand packs, uploads, third-party APIs), with refs (provider:id), categories, tags, tintable art and licences. Use when asked to add, spray, place, search for or credit stickers, or when find_stickers or describe_sticker are available.
+description: How to find, check and use stickers from the Pixerate sticker library through find_stickers and describe_sticker - the editor's own stamps (editor:star, editor:heart, ...) or any library a host plugged in (brand packs, uploads, third-party APIs), with refs (provider:id), categories, collections, tags, tintable art, light / dark variants, AI-generated labels and licences. Use when asked to add, spray, place, search for or credit stickers, or when find_stickers or describe_sticker are available.
 ---
 
 # Stickers
@@ -14,17 +14,22 @@ none, it is the editor's own stamps (`editorStickers()`: `editor:dot`, `editor:s
 ## Working method
 
 1. **Find.** `find_stickers` with a few words (`query`) and, when the result's `categories`
-   suggest one, a `category`. Pages are small: pass `next` as `after` for more, or narrow the
-   query. Filter with `commercial: true` for anything that will be sold or used in marketing.
+   suggest one, a `category`. When the result lists `collections` (themed sets, such as one per
+   brand) and the job names one, pass its id as `collection`. Pages are small: pass `next` as
+   `after` for more, or narrow the query. Filter with `commercial: true` for anything that will
+   be sold or used in marketing.
 2. **Check.** `describe_sticker` when the choice matters: its licence (and the attribution line
-   it asks for), dominant colours, variants and outline.
+   it asks for), whether the art is `aiGenerated`, its `variants`, dominant colours and outline.
 3. **Use.** Pass refs to the editor that places them: in the paint editor, a sticker brush
    (`set_brush` `tip.stamps`, then `paint_stroke`) sprays them and `add_stickers` places
    them exactly. In the vector, image and canvas editors, `insert_sticker` puts one in (`x`,
    `y` centre, `width`): vector, a group of editable paths; image, a pixel layer; canvas, a
    shape node from its outline in one colour. A provider's art loads before it is drawn.
 4. **Colour.** Tintable stickers (flat, single-colour art) take the paint colour or a sticker's
-   `color`; the rest keep their own colours.
+   `color`; the rest keep their own colours. A sticker whose `variants` include `dark` has art
+   drawn for dark backgrounds: `insert_sticker` uses it when the host's canvas or theme is dark
+   (or pass `variant`), and the paint editor's sticker brush sprays it on a dark colour scheme
+   (each sticker keeps the variant it was drawn in).
 5. **Treat it with an effect.** In the image editor, `insert_sticker` returns the layer `id`;
    `apply_effect` with that `target` and any effect whose `describe_effect` inputs take an
    image (`appliesHere`) uses the sticker as its picture (holo foil, cut-out). For a whole set,
@@ -35,6 +40,10 @@ none, it is the editor's own stamps (`editorStickers()`: `editor:dot`, `editor:s
 - Keep refs exactly as `find_stickers` returns them; a bare editor stamp (`star`) also works
   and means `editor:star`.
 - Credit stickers whose licence has an `attribution` wherever the work is published.
+- Say when art is `aiGenerated: true` if the user asked for hand-made art or must disclose AI
+  content; absent means the provider didn't say, not that it is hand-made.
+- Leave `variant` out of `insert_sticker` unless the user asked for one: the default matches the
+  background.
 - Prefer tintable stickers when they must match a palette.
 - Vector stickers need SVG art and canvas stickers an outline (`silhouette`); `find_stickers`
   lists `formats`, and `describe_sticker` the outline. The image editor takes either.
@@ -42,7 +51,9 @@ none, it is the editor's own stamps (`editorStickers()`: `editor:dot`, `editor:s
 ## Pitfalls
 
 - An unknown ref is refused with the closest refs: pick one of those or search again.
-- A category that the library doesn't have is refused with the list of its categories.
+- A category or collection that the library doesn't have is refused with the list of its
+  categories or collections. In a combined library, collection ids are `provider:collection`.
+- `variant: "dark"` on a sticker without a dark variant is refused; check `variants` first.
 - `limit` is 1..100; results beyond a page need `after`, not a larger limit.
 - `color` on a sticker that is not tintable is refused; leave it out.
 - On the canvas, multi-colour art becomes its outline in its dominant colour; for the art itself,
@@ -52,6 +63,6 @@ none, it is the editor's own stamps (`editorStickers()`: `editor:dot`, `editor:s
 
 | Tool | Use |
 | --- | --- |
-| `find_stickers` | Search or list the library: `query`, `category`, `tags`, `commercial`, `limit`, `after`. Returns `items` (each `ref`, name, category, tags, width, height, formats, tintable, licence), `total`, `next`, `categories`. Changes nothing. |
-| `insert_sticker` | Put one sticker (`ref`) into the vector, image or canvas editor, centred at `x`, `y` (default the middle), `width` wide (default natural), tinted with `color` when tintable. One undo step. Returns the new group, layer or node `id`, the size and the licence. |
-| `describe_sticker` | One sticker by `ref`: everything `find_stickers` returns plus `silhouette` (SVG path data), `colours` and `variants`. Unknown refs are refused with the closest ones. Changes nothing. |
+| `find_stickers` | Search or list the library: `query`, `category`, `collection`, `tags`, `commercial`, `limit`, `after`. Returns `items` (each `ref`, name, category, collection, tags, width, height, formats, tintable, aiGenerated, variants, licence), `total`, `next`, `categories`, `collections`. Changes nothing. |
+| `insert_sticker` | Put one sticker (`ref`) into the vector, image or canvas editor, centred at `x`, `y` (default the middle), `width` wide (default natural), tinted with `color` when tintable, in its dark `variant` on a dark background (or the one passed). One undo step. Returns the new group, layer or node `id`, the size, the `variant` used and the licence. |
+| `describe_sticker` | One sticker by `ref`: everything `find_stickers` returns plus `silhouette` (SVG path data) and `colours`. Unknown refs are refused with the closest ones. Changes nothing. |

package/skills/pixerate-vector/SKILL.md

@@ -375,7 +375,7 @@ contents whole while you work, without losing the mask.
 | --- | --- |
 | `vector.listBrushes` | List the brushes a brushstroke can use: the dry presets (pencils, pastels, charcoal, crayon, chalk, markers, inks, ballpoint, gel pen, fineliner), then saved brushes from the brush library the vector profile admits, with their sizes and `builtin`. Brushes it refuses (wet, thick, particles, stickers, tools) are refused by `vector.addBrushstroke` with the reason. A saved brush is kept in the layer, so the document renders without the library. |
 | `vector.addBrushstroke` | Paint paths with a brush along their outline (`brushId`, `size`, `pressure` profile such as [0.2, 1, 0.2] for a taper, `color`, default the brush's default colour (ballpoint blue, chalk), else the path's stroke; `keepColour` keeps the path's colour): sketchy, hand-drawn or inked lines that stay editable. Pass a `seed` (any integer) so the brush gets its character, the seeded jitter and paper grain that make pencil, pastel and charcoal look real; `paper` picks the grain (`{ pattern, seed, scale, depth }`) or `null` turns it off. Returns the stroke stacks. |
-| `vector.setBrushstroke` | Change brushstroke layer `index` of path `id`: brush (another brush without `color` takes its default colour, unless `keepColour`), size, pressure, colour, opacity, `seed` (a new seed is a new take on the same stroke; null: plain dabs) and `paper` (replaced whole; null: no grain; {}: the default sanded paper). Remove it with `vector.removeStroke`. |
+| `vector.setBrushstroke` | Change brushstroke layer `index` of path `id`: brush (another brush without `color` takes its default colour, unless `keepColour`; giving the same `brushId` again takes that saved brush as the library has it now), size, pressure, colour, opacity, `seed` (a new seed is a new take on the same stroke; null: plain dabs) and `paper` (replaced whole; null: no grain; {}: the default sanded paper). Remove it with `vector.removeStroke`. |
 
 Give brushstrokes a `seed` unless you want flat, even dabs: without one a charcoal or pastel line looks like a felt pen. Use different seeds on neighbouring strokes so they do not repeat each other, and `paper: null` for clean ink or marker lines that should not catch grain. The grain is laid in each path's own space, so it moves with the path.