@richardmcquiston01/unofficial-xcs-writer 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.7.0] - 2026-09-21
+
+### Added
+
+- **`.xs` processing-profile support**: `.addText()`/`.addPath()`/`.addBitmap()` accept a new
+  `processing: { processingType, values }` option (`src/builder.ts`), which `.toXsBytes()`
+  (`src/xs.ts`'s `buildXsArchive`, now taking an optional `XsProcessingBinding[]`) turns into a
+  real `profiles.json` entry plus a matching `LASER_PLANE`-mode binding in
+  `devices/device-<id>.json`. Displays given identical `processingType`+`values` are merged into
+  one shared profile/binding, matching how real xTool Studio exports dedupe identical settings.
+  `.toBytes()` (`.xcs` output) ignores this option -- `.xcs`'s own per-display processing format
+  is structurally different and much less understood, so it isn't implemented (see `CLAUDE.md`'s
+  Open Issues).
+
 ## [0.6.0] - 2026-09-21
 
 ### Added

package/README.md

@@ -93,15 +93,25 @@ const project = createXCS('P2S')
     fontSize: 18,
     layout: layoutCurvedGlyphText(font, 'Arch Text', 6, 90, 60, 20, 'center'),
   })
-  .addPath('M0 0L10 0L10 10L0 10Z', 0, 60, 10, 10)
+  .addPath('M0 0L10 0L10 10L0 10Z', 0, 60, 10, 10, {
+    // Only affects .toXsBytes() output -- see below.
+    processing: { processingType: 'VECTOR_CUTTING', values: { power: 80, speed: 10 } },
+  })
   .toBytes(); // Uint8Array, ready to write to a .xcs file
 ```
 
 Call `.toXsBytes()` instead of `.toBytes()` to export the same project as a `.xs` (v2 workspace)
-archive — same chainable builder, same display objects, different container. Processing
-profiles/device bindings aren't populated (there's no `addProfile`-style API yet), so a
-generated `.xs` file's power/speed may need to be set manually in xTool Studio before
-cutting/engraving.
+archive — same chainable builder, same display objects, different container.
+
+Pass `processing: { processingType, values }` to `.addText()`/`.addPath()`/`.addBitmap()`'s
+options to set that display's power/speed/etc. in the exported `.xs` file's `profiles.json` +
+device bindings — `.xcs` output (`.toBytes()`) ignores this option; its own per-display
+processing format is different and not supported yet. Displays given identical settings share
+one profile/binding automatically. `processingType`/`values`' exact shape is xTool Studio's own
+and undocumented beyond real exports — see `xs_samples/*.xs`'s `profiles.json` for examples
+(`VECTOR_ENGRAVING`, `VECTOR_CUTTING`, `FILL_VECTOR_ENGRAVING`). Displays with no `processing`
+option behave as before: a generated `.xs` file's power/speed may need to be set manually in
+xTool Studio before cutting/engraving.
 
 ## API
 
@@ -176,7 +186,9 @@ Lower-level glyph-extraction primitives everything else in this library is built
 | `.addBitmap(pngBase64, x, y, widthMm, heightMm, originWidthPx, originHeightPx, options?)` | An embedded PNG, physically sized in mm. |
 | `.addLayer(color, name, order)` | A named, colored layer (one `#00befe` "Cyan" layer exists by default). |
 
-Then `.generate()` (the plain `XCSFile` object), `.toJSON()` (string), `.toBytes()` (`Uint8Array`, matching `renderXcsFile`'s output type, as `.xcs`), or `.toXsBytes()` (`Uint8Array`, matching `renderXsFile`'s output type, as `.xs` — see the note in "Building a project from scratch" above about unset processing profiles).
+`.addText()`/`.addPath()`/`.addBitmap()` all also accept a `processing: { processingType, values }` option — see "Building a project from scratch" above; it only affects `.toXsBytes()` output.
+
+Then `.generate()` (the plain `XCSFile` object), `.toJSON()` (string), `.toBytes()` (`Uint8Array`, matching `renderXcsFile`'s output type, as `.xcs`), or `.toXsBytes()` (`Uint8Array`, matching `renderXsFile`'s output type, as `.xs`).
 
 Text layout — build the `layout` option for `.addText()` with one of:
 

package/dist/index.cjs

@@ -362,6 +362,36 @@ function renderXsFile(buffer, variables, values, fonts) {
 function encodeJson(value) {
   return new TextEncoder().encode(JSON.stringify(value));
 }
+function generateXsId(prefix) {
+  const uuid = typeof crypto !== "undefined" && crypto.randomUUID ? crypto.randomUUID() : "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, (c) => {
+    const r = Math.random() * 16 | 0;
+    const v = c === "x" ? r : r & 3 | 8;
+    return v.toString(16);
+  });
+  return `${prefix}:${uuid}`;
+}
+function buildProcessing(canvasId, bindings) {
+  const profiles = {};
+  const profileRefs = [];
+  const deviceBindings = [];
+  for (const binding of bindings) {
+    const profileId = generateXsId("profile");
+    profiles[profileId] = {
+      id: profileId,
+      processingType: binding.processingType,
+      values: binding.values
+    };
+    profileRefs.push(profileId);
+    deviceBindings.push({
+      bindingId: generateXsId("binding"),
+      canvasId,
+      mode: "LASER_PLANE",
+      baseProfileId: profileId,
+      displayIds: binding.displayIds
+    });
+  }
+  return { profiles, profileRefs, deviceBindings };
+}
 function decodeDataUrl(dataUrl) {
   const match = /^data:([^;]+);base64,(.*)$/.exec(dataUrl);
   if (!match) return null;
@@ -386,11 +416,15 @@ function coverResourceEntries(coverDataUrl) {
     })
   };
 }
-function buildXsArchive(file) {
+function buildXsArchive(file, processingBindings = []) {
   const canvas = file.canvas[0];
   if (!canvas) {
     throw new Error("Cannot build a .xs archive from a project with no canvas.");
   }
+  const { profiles, profileRefs, deviceBindings } = buildProcessing(
+    canvas.id,
+    processingBindings
+  );
   return (0, import_fflate.zipSync)({
     ".format": new TextEncoder().encode("v2"),
     "meta/persistence-meta.json": encodeJson({
@@ -421,7 +455,7 @@ function buildXsArchive(file) {
       cover: "resources/project-cover.png",
       customProjectData: { projectTraceID: file.projectTraceID }
     }),
-    "profiles.json": encodeJson({ profiles: {} }),
+    "profiles.json": encodeJson({ profiles }),
     [`canvases/${canvas.id}.json`]: encodeJson({
       id: canvas.id,
       title: canvas.title,
@@ -468,9 +502,9 @@ function buildXsArchive(file) {
                 focalLen: null,
                 focalLength: null
               },
-              profileRefs: [],
+              profileRefs,
               patches: {},
-              bindings: []
+              bindings: deviceBindings
             }
           }
         }
@@ -739,6 +773,8 @@ var XCSGenerator = class {
   displays = [];
   layers = /* @__PURE__ */ new Map();
   options;
+  /** Keyed by `JSON.stringify([processingType, values])` to merge displays sharing identical settings into one profile. */
+  processingBindings = /* @__PURE__ */ new Map();
   constructor(options = {}) {
     this.options = {
       deviceId: options.deviceId || "P2S",
@@ -760,6 +796,7 @@ var XCSGenerator = class {
   addText(text, x, y, options = {}) {
     const textObj = this.createTextObject(text, x, y, options);
     this.displays.push(textObj);
+    this.registerProcessing(textObj.id, options.processing);
     return this;
   }
   /**
@@ -768,6 +805,7 @@ var XCSGenerator = class {
   addPath(pathData, x, y, width, height, options = {}) {
     const pathObj = this.createPathObject(pathData, x, y, width, height, options);
     this.displays.push(pathObj);
+    this.registerProcessing(pathObj.id, options.processing);
     return this;
   }
   /**
@@ -851,6 +889,7 @@ var XCSGenerator = class {
       opacity: 1
     };
     this.displays.push(bitmap);
+    this.registerProcessing(bitmap.id, options.processing);
     return this;
   }
   /**
@@ -919,7 +958,22 @@ var XCSGenerator = class {
    * container differs from `toBytes()`.
    */
   toXsBytes() {
-    return buildXsArchive(this.generate());
+    return buildXsArchive(this.generate(), Array.from(this.processingBindings.values()));
+  }
+  /** Merges a display into an existing profile when another display already shares its exact `processing` settings, else starts a new one. */
+  registerProcessing(displayId, processing) {
+    if (!processing) return;
+    const key = JSON.stringify([processing.processingType, processing.values]);
+    const existing = this.processingBindings.get(key);
+    if (existing) {
+      existing.displayIds.push(displayId);
+      return;
+    }
+    this.processingBindings.set(key, {
+      processingType: processing.processingType,
+      values: processing.values,
+      displayIds: [displayId]
+    });
   }
   createCanvas() {
     return {