@pixerate/editor 0.265.0 → 0.266.1

package/dist/vector/index.d.cts

@@ -56,3 +56,4 @@ export * from './playback.cjs';
 export * from './editorDocument.cjs';
 export * from './layers.cjs';
 export * from './stickers.cjs';
+export { createVectorConformanceHost, vectorContracts, VECTOR_CONTRACT_FORMAT_VERSION, VECTOR_DOCUMENT_JSON_SCHEMA, FAKE_VECTOR_ART_MODELS, fakeVectorArtGenerator } from './contract.cjs';

package/dist/vector/index.d.ts

@@ -56,3 +56,4 @@ export * from './playback.js';
 export * from './editorDocument.js';
 export * from './layers.js';
 export * from './stickers.js';
+export { createVectorConformanceHost, vectorContracts, VECTOR_CONTRACT_FORMAT_VERSION, VECTOR_DOCUMENT_JSON_SCHEMA, FAKE_VECTOR_ART_MODELS, fakeVectorArtGenerator } from './contract.js';

package/dist/vector/index.js

@@ -1,3 +1,7 @@
+import {
+  CommandRegistry,
+  createCommandToolProvider
+} from "../chunk-HAEB3MZD.js";
 import {
   planGenerationRequest,
   stableStringify
@@ -8,6 +12,11 @@ import {
   hatchPath,
   pathfinder
 } from "../chunk-65MDXWA7.js";
+import "../chunk-PXXXRCME.js";
+import {
+  ToolRegistry
+} from "../chunk-K4BGRCSH.js";
+import "../chunk-EHTX34RE.js";
 import {
   VECTOR_TRACE_MAX_PIXELS,
   bendSegment,
@@ -26,7 +35,7 @@ import {
   traceField,
   traceVectorImage,
   vectorTraceContours
-} from "../chunk-BLR4KWYQ.js";
+} from "../chunk-EZOJBP4D.js";
 import {
   applyHomography,
   homographyFromPoints,
@@ -35,6 +44,7 @@ import {
   orderQuad,
   solve8
 } from "../chunk-OHKOFKBY.js";
+import "../chunk-IVSWRVB4.js";
 import {
   correspondMorphContours,
   createVectorMorph,
@@ -53,7 +63,7 @@ import {
   reverseMorphContour,
   subpathToMorphContour,
   turnMorphContour
-} from "../chunk-Z2Z2OHRM.js";
+} from "../chunk-LK4SXL3V.js";
 import {
   DEFAULT_VECTOR_FONT,
   IDENTITY_MATRIX,
@@ -529,10 +539,10 @@ import {
   withVectorStrokes,
   withVectorTargetPaint,
   zigzagPaths
-} from "../chunk-7PW6VCNW.js";
+} from "../chunk-T2LDTEXK.js";
 import {
   snapshotBrushLibrary
-} from "../chunk-J4SGJCPW.js";
+} from "../chunk-CIJBSUM5.js";
 import "../chunk-ACFSFUQH.js";
 import {
   createProvenance
@@ -590,7 +600,9 @@ import {
 import "../chunk-SIFAIGB3.js";
 import "../chunk-VDGBHYC7.js";
 import {
-  defineEditorDocument
+  EDITOR_DOCUMENT_FORMAT,
+  defineEditorDocument,
+  toEditorDocumentFile
 } from "../chunk-XBQX76CT.js";
 import "../chunk-HF5QZS7Z.js";
 import {
@@ -18396,12 +18408,193 @@ function createVectorStickerHost(controller, options = {}) {
     }
   };
 }
+
+// src/vector/contract.ts
+var VECTOR_CONTRACT_FORMAT_VERSION = 1;
+var VECTOR_DOCUMENT_JSON_SCHEMA = {
+  type: "object",
+  description: "A saved vector document, as the vector editor's save tools and autosave write it.",
+  properties: {
+    format: { type: "string", const: EDITOR_DOCUMENT_FORMAT, description: `Always "${EDITOR_DOCUMENT_FORMAT}".` },
+    kind: { type: "string", const: "vector", description: 'Always "vector".' },
+    formatVersion: { type: "integer", minimum: 1, description: "Version of the envelope for this kind; readers migrate older ones." },
+    name: { type: "string", description: "Display name, when it has one." },
+    document: {
+      type: "object",
+      description: "The drawing (`VectorDocument`, as get_vector_document returns it).",
+      properties: {
+        width: { type: "number", exclusiveMinimum: 0, description: "Artboard width in document units." },
+        height: { type: "number", exclusiveMinimum: 0, description: "Artboard height in document units." },
+        background: { type: "string", description: "Artboard colour (default: transparent)." },
+        nodes: {
+          type: "array",
+          description: "Top-level nodes, bottom to top. Groups hold their own children.",
+          items: {
+            type: "object",
+            properties: {
+              id: { type: "string", description: "Node id." },
+              type: { type: "string", enum: ["path", "group", "text", "instance"], description: "path, group, text or instance (of a symbol)." },
+              name: { type: "string", description: "Layer name." },
+              visible: { type: "boolean", description: "false hides it (default true)." },
+              locked: { type: "boolean", description: "true keeps it from being selected on the canvas." },
+              transform: { type: "array", items: { type: "number" }, minItems: 6, maxItems: 6, description: "Affine matrix [a, b, c, d, e, f] (default identity)." }
+            },
+            required: ["id", "type"]
+          }
+        },
+        symbols: { type: "array", items: { type: "object", properties: { id: { type: "string", description: "Symbol id." } }, required: ["id"] }, description: "Symbols the document's instances draw." },
+        constraints: { type: "array", items: { type: "object" }, description: "Constraints between anchors, segments and circles, solved after every edit." },
+        parameters: { type: "array", items: { type: "object" }, description: "Named values the constraints' expressions use." },
+        perspective: { type: ["object", "null"], description: "The perspective grid, or null." }
+      },
+      required: ["width", "height", "nodes"]
+    }
+  },
+  required: ["format", "kind", "formatVersion", "document"]
+};
+function toolList(provider) {
+  const tools = typeof provider.tools === "function" ? provider.tools() : provider.tools;
+  return {
+    id: provider.id,
+    title: provider.title,
+    ...provider.skill ? { skill: provider.skill } : {},
+    tools: tools.map((t) => ({ name: t.name, title: t.title, description: t.description, inputSchema: t.inputSchema, annotations: t.annotations }))
+  };
+}
+function uiTables() {
+  return {
+    tools: { order: VECTOR_TOOLS, groups: VECTOR_TOOL_GROUPS, glyphs: VECTOR_TOOL_GLYPHS, shortcuts: VECTOR_TOOL_SHORTCUTS },
+    menus: {
+      blendModes: VECTOR_BLEND_MODE_MENU,
+      effects: VECTOR_EFFECT_MENU,
+      filters: VECTOR_FILTER_MENU,
+      pathActions: VECTOR_PATH_ACTIONS,
+      pathfinderActions: VECTOR_PATHFINDER_ACTIONS,
+      editToggles: VECTOR_EDIT_TOGGLES,
+      envelopeStyles: VECTOR_ENVELOPE_STYLE_OPTIONS,
+      maskTypes: VECTOR_MASK_TYPE_OPTIONS,
+      textAligns: VECTOR_TEXT_ALIGN_OPTIONS,
+      fontWeights: VECTOR_FONT_WEIGHTS
+    },
+    specs: {
+      effects: { defaults: VECTOR_EFFECT_DEFAULTS, params: VECTOR_EFFECT_PARAM_SPECS },
+      filters: { defaults: VECTOR_FILTER_DEFAULTS, params: VECTOR_FILTER_PARAM_SPECS },
+      lenses: VECTOR_LENS_SPECS,
+      widthPresets: VECTOR_WIDTH_PRESETS
+    },
+    labels: {
+      arrowheads: VECTOR_ARROWHEAD_LABELS,
+      blendModes: VECTOR_BLEND_MODE_LABELS,
+      blendSpacings: VECTOR_BLEND_SPACING_LABELS,
+      connectorRoutes: VECTOR_CONNECTOR_ROUTE_LABELS,
+      connectorSides: VECTOR_CONNECTOR_SIDE_LABELS,
+      constraints: VECTOR_CONSTRAINT_LABELS,
+      constraintGlyphs: VECTOR_CONSTRAINT_GLYPHS,
+      cornerKinds: VECTOR_CORNER_KIND_LABELS,
+      effects: VECTOR_EFFECT_LABELS,
+      filters: VECTOR_FILTER_LABELS,
+      gradientInterpolations: VECTOR_GRADIENT_INTERPOLATION_LABELS,
+      gradientSpreads: VECTOR_GRADIENT_SPREAD_LABELS,
+      gradientTypes: VECTOR_GRADIENT_TYPE_LABELS,
+      horizontalResizing: VECTOR_HORIZONTAL_RESIZING_LABELS,
+      verticalResizing: VECTOR_VERTICAL_RESIZING_LABELS,
+      layerKinds: VECTOR_LAYER_KIND_LABELS,
+      lenses: VECTOR_LENS_LABELS,
+      maskTypes: VECTOR_MASK_TYPE_LABELS,
+      pathfinder: VECTOR_PATHFINDER_LABELS,
+      strokeAligns: VECTOR_STROKE_ALIGN_LABELS,
+      strokeGradientModes: VECTOR_STROKE_GRADIENT_MODE_LABELS,
+      stylize: VECTOR_STYLIZE_LABELS,
+      symmetryModes: VECTOR_SYMMETRY_MODE_LABELS,
+      textAligns: VECTOR_TEXT_ALIGN_LABELS,
+      warpStyles: WARP_STYLE_LABELS
+    },
+    overlayTheme: VECTOR_OVERLAY_THEME
+  };
+}
+var FAKE_VECTOR_ART_MODELS = [{ id: "fake-svg", name: "Fake SVG", media: "text", seed: true }];
+var fakeVectorArtGenerator = (request) => {
+  const n2 = (request.prompt ?? "").length;
+  const r = 10 + n2 % 30;
+  const hue = ["#e11d48", "#2563eb", "#16a34a", "#d97706"][n2 % 4];
+  return { svg: `<svg xmlns="http://www.w3.org/2000/svg" width="100" height="100"><circle cx="50" cy="50" r="${r}" fill="${hue}"/></svg>` };
+};
+function vectorProviders(controller) {
+  const commands = new CommandRegistry({ context: controller, history: controller.history });
+  commands.register(createVectorCommands(controller));
+  return {
+    commands,
+    providers: [
+      createCommandToolProvider(commands, { id: "vector-commands", namespace: "" }),
+      createVectorEffectsToolProvider(controller, { id: "vector-effects" }),
+      createVectorGenerationToolProvider(controller, { models: FAKE_VECTOR_ART_MODELS, generate: fakeVectorArtGenerator })
+    ]
+  };
+}
+function vectorContracts(options) {
+  const controller = new VectorEditorController();
+  controller.setEffectsProvider(options.effects);
+  const specs = createVectorCommands(controller);
+  const providers = vectorProviders(controller).providers.map(toolList);
+  const document = createVectorEditorDocument(controller);
+  const files = {
+    "document.schema.json": { $schema: "https://json-schema.org/draft/2020-12/schema", $id: "document.schema.json", ...VECTOR_DOCUMENT_JSON_SCHEMA },
+    "tools.json": { providers },
+    // The commands agents run with run_command: `shortcut` is as written (`Mod` is ⌘ / Ctrl).
+    "commands.json": specs.map((s) => ({
+      id: s.id,
+      label: s.label,
+      ...s.group ? { group: s.group } : {},
+      ...s.keywords?.length ? { keywords: s.keywords } : {},
+      ...s.description ? { description: s.description } : {},
+      params: s.params ?? { type: "object", properties: {}, additionalProperties: false },
+      ...s.shortcut !== void 0 ? { shortcut: s.shortcut } : {},
+      ...s.scope ? { scope: s.scope } : {},
+      undoable: s.undoable !== false,
+      readOnly: !!s.readOnly,
+      ...s.hidden ? { hidden: true } : {}
+    })),
+    "ui.json": uiTables()
+  };
+  files["manifest.json"] = {
+    domain: "vector",
+    formatVersion: VECTOR_CONTRACT_FORMAT_VERSION,
+    document: { kind: document.kind, formatVersion: document.formatVersion },
+    counts: { providers: providers.length, tools: providers.reduce((n2, p) => n2 + p.tools.length, 0), commands: specs.length },
+    files: Object.keys(files).sort()
+  };
+  document.destroy?.();
+  return files;
+}
+function createVectorConformanceHost(setup, options) {
+  const shaper = getVectorTextShaper();
+  setVectorTextShaper(createMetricTextShaper());
+  let next = 0;
+  const sized = setup.width || setup.height ? { document: { width: setup.width ?? 800, height: setup.height ?? 600, nodes: [] } } : {};
+  const controller = new VectorEditorController({ ...sized, createId: () => `n${++next}` });
+  controller.setEffectsProvider(options.effects);
+  const registry = new ToolRegistry({ validateArguments: true });
+  for (const p of vectorProviders(controller).providers) registry.register(p);
+  const document = createVectorEditorDocument(controller);
+  return {
+    callTool: (name, args) => registry.callTool(name, args),
+    document: () => toEditorDocumentFile(document),
+    pixels: () => {
+      throw new Error("The vector editor has no pixels; compare its document, results and SVG export.");
+    },
+    dispose: () => {
+      document.destroy?.();
+      setVectorTextShaper(shaper);
+    }
+  };
+}
 export {
   DEFAULT_VECTOR_BLEND_DISTANCE,
   DEFAULT_VECTOR_BLEND_STEPS,
   DEFAULT_VECTOR_FONT,
   DEFAULT_VECTOR_PATH_EDIT,
   DEFAULT_VECTOR_SNAP,
+  FAKE_VECTOR_ART_MODELS,
   IDENTITY_MATRIX,
   KAPPA,
   LazyMouse,
@@ -18427,12 +18620,14 @@ export {
   VECTOR_CONSTRAINT_KINDS,
   VECTOR_CONSTRAINT_LABELS,
   VECTOR_CONSTRUCTION_ANGLES,
+  VECTOR_CONTRACT_FORMAT_VERSION,
   VECTOR_CORNER_KINDS,
   VECTOR_CORNER_KIND_LABELS,
   VECTOR_CORNER_WIDGET_INSET,
   VECTOR_DIMENSIONAL_KINDS,
   VECTOR_DISTORT_BRUSH_MODES,
   VECTOR_DISTORT_TOLERANCE,
+  VECTOR_DOCUMENT_JSON_SCHEMA,
   VECTOR_EDIT_TOGGLES,
   VECTOR_EFFECT_DEFAULTS,
   VECTOR_EFFECT_LABELS,
@@ -18567,6 +18762,7 @@ export {
   createMetricTextShaper,
   createOutlineTextShaper,
   createVectorCommands,
+  createVectorConformanceHost,
   createVectorEditorDocument,
   createVectorEffect,
   createVectorEffectsToolProvider,
@@ -18603,6 +18799,7 @@ export {
   expandVectorGradientSpread,
   expandVectorGradientStops,
   explicitVectorGradient,
+  fakeVectorArtGenerator,
   findVectorAnchorById,
   findVectorNode,
   fitCornerRadius,
@@ -18914,6 +19111,7 @@ export {
   vectorConstraintPanel,
   vectorConstraintResiduals,
   vectorConstraintValue,
+  vectorContracts,
   vectorCornerAt,
   vectorCorners,
   vectorCornersAttribute,

package/package.json

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