@richardmcquiston01/unofficial-xcs-writer 0.4.1 → 0.6.0

package/CHANGELOG.md

@@ -5,6 +5,37 @@ 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.6.0] - 2026-09-21
+
+### Added
+
+- **`.xs` generation**: `XCSGenerator.toXsBytes()` (`src/xs.ts`'s new `buildXsArchive`) exports a
+  built project as a `.xs` v2 archive instead of `.xcs` -- the same chainable builder
+  (`.addText()`/`.addPath()`/`.addBitmap()`/`.addLayer()`), same display objects, different
+  container. `project.json`/`profiles.json`/`devices/`/`canvases/` metadata is synthesized
+  fresh, always as a single canvas in a single `displays-0.json` chunk, with the cover image
+  written as a real `resources/project-cover.png` file instead of inline base64. Processing
+  profiles and device bindings are left empty (no `addProfile`-style API exists yet) -- a
+  generated `.xs` file's power/speed settings may need to be configured manually in xTool
+  Studio before cutting/engraving.
+
+## [0.5.0] - 2026-09-20
+
+### Added
+
+- **`.xs` (v2 workspace) format support** (`src/xs.ts`): `assertXsFormat`, `extractXsTokens`,
+  and `renderXsFile` read and apply `{{token}}` substitution to xTool Studio v1.7+'s new `.xs`
+  format — a ZIP archive of chunked per-canvas display files, unlike `.xcs`'s single plain-JSON
+  document. `.xcs` is now legacy as of xTool Studio v1.7 (still readable, no longer savable from
+  the app). The `TEXT` display schema itself (`text`/`style`/`fontData`/`charJSONs`) is
+  unchanged from `.xcs`, so token extraction and glyph regeneration share their implementation
+  with `renderXcsFile`/`extractXcsTokens` via a new `src/substitution.ts` module; only the
+  container format differs. Archives are read/written with [fflate](https://github.com/101arrowz/fflate)
+  (new runtime dependency); every entry other than the modified displays chunks round-trips
+  byte-for-byte unchanged, including large `PATH` displays' deduplicated `vectors/<bucketType>/`
+  vector store. `.xs` *generation* (building a new project from scratch) isn't implemented yet
+  — see `CLAUDE.md`'s "Open Issues".
+
 ## [0.4.1] - 2026-09-19
 
 ### Changed

package/README.md

@@ -1,15 +1,19 @@
 # unofficial-xcs-writer
 
-A framework-agnostic TypeScript library for reading, writing, building, and applying variable substitution to `.xcs` files produced by [xTool Creative Space](https://www.xtool.com/pages/software). Not affiliated with xTool.
+A framework-agnostic TypeScript library for reading, writing, building, and applying variable substitution to `.xcs` and `.xs` files produced by [xTool Creative Space](https://www.xtool.com/pages/software). Not affiliated with xTool.
 
-## What is an XCS file?
+## What is an XCS / XS file?
 
-An `.xcs` file is a plain UTF-8 JSON document exported by xTool Creative Space. It describes a laser project — canvas dimensions, design objects (shapes, text, images), layer assignments, and device parameters. This library lets you:
+An `.xcs` file is a plain UTF-8 JSON document exported by xTool Creative Space. It describes a laser project — canvas dimensions, design objects (shapes, text, images), layer assignments, and device parameters.
 
-- **Read** an XCS file and inspect its contents
+Starting with xTool Studio v1.7, new projects are saved as `.xs` instead — a ZIP archive of several JSON files (project metadata, per-canvas display chunks, processing profiles, device bindings, and binary resources as real files rather than inline base64). `.xcs` is now legacy: v1.7+ can still open `.xcs` files but can no longer save back to that format. See `src/xs.ts` for the full format writeup.
+
+This library lets you, for both formats:
+
+- **Read** a file and inspect its contents
 - **Extract** `{{token}}` template placeholders from text objects
 - **Render** a filled-in copy by substituting values for those placeholders
-- **Build** a new `.xcs` project from scratch — text (straight, multi-line, or curved), paths, and embedded images
+- **Build** a new project from scratch — text (straight, multi-line, or curved), paths, and embedded images — and export it as either `.xcs` or `.xs`
 
 ## Installation
 
@@ -46,6 +50,21 @@ const values = { FirstName: 'Jane', LastName: 'Smith' };
 const output: Uint8Array = renderXcsFile(buffer, variables, values);
 ```
 
+### Working with `.xs` files
+
+Same shape, different functions — `.xs` is a ZIP archive, so there's no `readXsFile` equivalent to `readXcsFile` (there's no single JSON string to return), but token extraction and substitution work the same way:
+
+```ts
+import { assertXsFormat, extractXsTokens, renderXsFile } from '@richardmcquiston01/unofficial-xcs-writer';
+
+const buffer = await fetch('/templates/name-tag.xs').then(r => r.arrayBuffer());
+
+assertXsFormat(buffer); // throws if invalid
+const tokens = extractXsTokens(buffer); // e.g. ['FirstName', 'LastName']
+
+const output: Uint8Array = renderXsFile(buffer, variables, values);
+```
+
 ### Building a project from scratch
 
 ```ts
@@ -78,6 +97,12 @@ const project = createXCS('P2S')
   .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.
+
 ## API
 
 ### `assertXcsFormat(buffer: ArrayBuffer): void`
@@ -118,6 +143,24 @@ interface XcsVariable {
 }
 ```
 
+### `.xs` (v2 workspace) format
+
+### `assertXsFormat(buffer: ArrayBuffer): void`
+
+Validates that `buffer` is a ZIP archive with a `.format` entry equal to `"v2"` and a `project.json` entry. Throws a descriptive error otherwise.
+
+### `extractXsTokens(buffer: ArrayBuffer): string[]`
+
+Same as `extractXcsTokens`, but scans every `canvases/<canvasId>/displays-<chunkIndex>.json` chunk across the archive instead of a single `canvas` array.
+
+### `renderXsFile(buffer, variables, values, fonts?): Uint8Array`
+
+Same substitution and glyph-regeneration behavior as `renderXcsFile` (see above — including the same `fonts` parameter and curved-text limitation), applied to every displays chunk. Returns a re-zipped `.xs` archive; every entry other than the modified displays chunks is passed through byte-for-byte unchanged.
+
+### `buildXsArchive(file: XCSFile): Uint8Array`
+
+Packages an already-`generate()`d project (see Building, below) into a `.xs` v2 ZIP archive. You won't normally call this directly — use `XCSGenerator.toXsBytes()` instead, which calls it for you.
+
 ### `loadFont(buffer: ArrayBuffer)` / `loadDefaultFont()` / `layoutText(font, text, originX, originY)`
 
 Lower-level glyph-extraction primitives everything else in this library is built on, exported for direct use. See `src/glyphs.ts` for the exact xTool JSON conventions these were reverse-engineered against.
@@ -133,7 +176,7 @@ 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), or `.toBytes()` (`Uint8Array`, matching `renderXcsFile`'s output type).
+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).
 
 Text layout — build the `layout` option for `.addText()` with one of:
 
@@ -175,7 +218,8 @@ It needs an `NPM_TOKEN` repository secret with publish rights.
 
 - All inputs and outputs use plain browser-compatible types (`ArrayBuffer`, `Uint8Array`, `string`) — no Node.js APIs, no DOM, no framework required. (`atob`/`crypto.randomUUID` are used for the bundled font and glyph IDs; both are available in browsers and Node ≥ 19.)
 - Only `TEXT` display objects are modified during substitution. Geometry, bitmaps, device configuration, and all other fields pass through unchanged.
-- This library targets the current xTool Creative Space JSON format. Older versions of the software may export a different structure.
+- This library targets the current xTool Creative Space JSON/`.xs` formats. Older versions of the software may export a different structure.
+- `.xs` archives are read and re-written with [fflate](https://github.com/101arrowz/fflate); large `PATH` displays' vector data may be deduplicated into a separate `vectors/<bucketType>/` store rather than inlined — this library never touches `PATH` displays, so that structure round-trips untouched.
 - Glyph outline extraction is powered by [opentype.js](https://github.com/opentypejs/opentype.js). The bundled fallback font is [Arimo](https://fonts.google.com/specimen/Arimo) v5.2.8 via [`@fontsource/arimo`](https://www.npmjs.com/package/@fontsource/arimo) (Apache License 2.0, see `third_party/arimo/LICENSE`).
 
 ## License

package/dist/index.cjs

@@ -32,9 +32,12 @@ var index_exports = {};
 __export(index_exports, {
   XCSGenerator: () => XCSGenerator,
   assertXcsFormat: () => assertXcsFormat,
+  assertXsFormat: () => assertXsFormat,
+  buildXsArchive: () => buildXsArchive,
   createXCS: () => createXCS,
   effectiveCurveDeg: () => effectiveCurveDeg,
   extractXcsTokens: () => extractXcsTokens,
+  extractXsTokens: () => extractXsTokens,
   fontSizePoints: () => fontSizePoints,
   layoutCurvedGlyphText: () => layoutCurvedGlyphText,
   layoutGlyphText: () => layoutGlyphText,
@@ -44,6 +47,7 @@ __export(index_exports, {
   loadFont: () => loadFont,
   readXcsFile: () => readXcsFile,
   renderXcsFile: () => renderXcsFile,
+  renderXsFile: () => renderXsFile,
   translateGlyphLayout: () => translateGlyphLayout
 });
 module.exports = __toCommonJS(index_exports);
@@ -228,8 +232,56 @@ function layoutText(font, text, originX, originY) {
   };
 }
 
-// src/xcs.ts
+// src/substitution.ts
 var TOKEN_RE = /\{\{([^}]+)\}\}/g;
+function collectTextTokens(displays, seen) {
+  for (const display of displays) {
+    if (display.type === "TEXT" && typeof display.text === "string") {
+      for (const match of display.text.matchAll(TOKEN_RE)) {
+        seen.add(match[1]);
+      }
+    }
+  }
+}
+function resolveFont(fontFamily, fonts, cache) {
+  const key = fontFamily ?? "";
+  const cached = cache.get(key);
+  if (cached) return cached;
+  const suppliedBuffer = fontFamily ? fonts?.[fontFamily] : void 0;
+  const font = suppliedBuffer ? loadFont(suppliedBuffer) : loadDefaultFont();
+  cache.set(key, font);
+  return font;
+}
+function substituteTextDisplays(displays, variables, values, fonts, fontCache) {
+  for (const display of displays) {
+    if (display.type !== "TEXT" || typeof display.text !== "string") continue;
+    const originalText = display.text;
+    let text = originalText;
+    for (const variable of variables) {
+      const replacement = values[variable.token] ?? variable.defaultValue ?? "";
+      text = text.replaceAll(`{{${variable.token}}}`, replacement);
+    }
+    display.text = text;
+    if (text === originalText) continue;
+    const style = display.style;
+    const font = resolveFont(style?.fontFamily, fonts, fontCache);
+    const originX = typeof display.x === "number" ? display.x : 0;
+    const originY = typeof display.y === "number" ? display.y : 0;
+    const layout = layoutText(font, text, originX, originY);
+    display.fontData = layout.fontData;
+    display.charJSONs = layout.charJSONs;
+    if (layout.x !== null && layout.y !== null) {
+      display.x = layout.x;
+      display.y = layout.y;
+      display.offsetX = layout.x;
+      display.offsetY = layout.y;
+      display.width = layout.width;
+      display.height = layout.height;
+    }
+  }
+}
+
+// src/xcs.ts
 function assertXcsFormat(buffer) {
   let project;
   try {
@@ -248,60 +300,186 @@ function extractXcsTokens(buffer) {
   const project = JSON.parse(readXcsFile(buffer));
   const seen = /* @__PURE__ */ new Set();
   for (const canvas of project.canvas) {
-    for (const display of canvas.displays) {
-      if (display.type === "TEXT" && typeof display.text === "string") {
-        for (const match of display.text.matchAll(TOKEN_RE)) {
-          seen.add(match[1]);
-        }
-      }
-    }
+    collectTextTokens(canvas.displays, seen);
   }
   return Array.from(seen);
 }
-function resolveFont(fontFamily, fonts, cache) {
-  const key = fontFamily ?? "";
-  const cached = cache.get(key);
-  if (cached) return cached;
-  const suppliedBuffer = fontFamily ? fonts?.[fontFamily] : void 0;
-  const font = suppliedBuffer ? loadFont(suppliedBuffer) : loadDefaultFont();
-  cache.set(key, font);
-  return font;
-}
 function renderXcsFile(buffer, variables, values, fonts) {
   const project = JSON.parse(readXcsFile(buffer));
   const fontCache = /* @__PURE__ */ new Map();
   for (const canvas of project.canvas) {
-    for (const display of canvas.displays) {
-      if (display.type === "TEXT" && typeof display.text === "string") {
-        const originalText = display.text;
-        let text = originalText;
-        for (const variable of variables) {
-          const replacement = values[variable.token] ?? variable.defaultValue ?? "";
-          text = text.replaceAll(`{{${variable.token}}}`, replacement);
-        }
-        display.text = text;
-        if (text === originalText) continue;
-        const style = display.style;
-        const font = resolveFont(style?.fontFamily, fonts, fontCache);
-        const originX = typeof display.x === "number" ? display.x : 0;
-        const originY = typeof display.y === "number" ? display.y : 0;
-        const layout = layoutText(font, text, originX, originY);
-        display.fontData = layout.fontData;
-        display.charJSONs = layout.charJSONs;
-        if (layout.x !== null && layout.y !== null) {
-          display.x = layout.x;
-          display.y = layout.y;
-          display.offsetX = layout.x;
-          display.offsetY = layout.y;
-          display.width = layout.width;
-          display.height = layout.height;
-        }
-      }
-    }
+    substituteTextDisplays(canvas.displays, variables, values, fonts, fontCache);
   }
   return new TextEncoder().encode(JSON.stringify(project));
 }
 
+// src/xs.ts
+var import_fflate = require("fflate");
+var DISPLAYS_CHUNK_RE = /^canvases\/[^/]+\/displays-\d+\.json$/;
+function decodeJson(bytes) {
+  return JSON.parse(new TextDecoder().decode(bytes));
+}
+function assertXsFormat(buffer) {
+  let entries;
+  try {
+    entries = (0, import_fflate.unzipSync)(new Uint8Array(buffer));
+  } catch (err) {
+    throw new Error(`Not a valid .xs file: ${err.message}`);
+  }
+  const format = entries[".format"];
+  if (!format) {
+    throw new Error("Not a valid .xs file: missing .format entry.");
+  }
+  const formatVersion = new TextDecoder().decode(format).trim();
+  if (formatVersion !== "v2") {
+    throw new Error(`Unsupported .xs format version "${formatVersion}" (expected "v2").`);
+  }
+  if (!entries["project.json"]) {
+    throw new Error("Not a valid .xs file: missing project.json.");
+  }
+}
+function extractXsTokens(buffer) {
+  const entries = (0, import_fflate.unzipSync)(new Uint8Array(buffer));
+  const seen = /* @__PURE__ */ new Set();
+  for (const [path, data] of Object.entries(entries)) {
+    if (!DISPLAYS_CHUNK_RE.test(path)) continue;
+    const chunk = decodeJson(data);
+    collectTextTokens(chunk.displays, seen);
+  }
+  return Array.from(seen);
+}
+function renderXsFile(buffer, variables, values, fonts) {
+  const entries = (0, import_fflate.unzipSync)(new Uint8Array(buffer));
+  const fontCache = /* @__PURE__ */ new Map();
+  for (const [path, data] of Object.entries(entries)) {
+    if (!DISPLAYS_CHUNK_RE.test(path)) continue;
+    const chunk = decodeJson(data);
+    substituteTextDisplays(chunk.displays, variables, values, fonts, fontCache);
+    entries[path] = new TextEncoder().encode(JSON.stringify(chunk));
+  }
+  return (0, import_fflate.zipSync)(entries);
+}
+function encodeJson(value) {
+  return new TextEncoder().encode(JSON.stringify(value));
+}
+function decodeDataUrl(dataUrl) {
+  const match = /^data:([^;]+);base64,(.*)$/.exec(dataUrl);
+  if (!match) return null;
+  const [, mimeType, base64] = match;
+  const binary = atob(base64);
+  const bytes = new Uint8Array(binary.length);
+  for (let i = 0; i < binary.length; i++) bytes[i] = binary.charCodeAt(i);
+  return { bytes, mimeType };
+}
+function coverResourceEntries(coverDataUrl) {
+  const cover = decodeDataUrl(coverDataUrl);
+  if (!cover) return {};
+  return {
+    "resources/project-cover.png": cover.bytes,
+    "resources/project-cover.png.meta.json": encodeJson({
+      ref: "resources/project-cover.png",
+      metadata: {
+        kind: "image",
+        source: { type: "workspace", value: "project-cover.png" },
+        mimeType: cover.mimeType
+      }
+    })
+  };
+}
+function buildXsArchive(file) {
+  const canvas = file.canvas[0];
+  if (!canvas) {
+    throw new Error("Cannot build a .xs archive from a project with no canvas.");
+  }
+  return (0, import_fflate.zipSync)({
+    ".format": new TextEncoder().encode("v2"),
+    "meta/persistence-meta.json": encodeJson({
+      schemaVersion: "2.0.0",
+      protocol: "xcs-workspace-v2"
+    }),
+    "project.json": encodeJson({
+      __v2__: true,
+      version: "2.0.0",
+      schemaMeta: { schemaVersion: "2.1.0", format: "directory" },
+      projectId: file.projectTraceID,
+      projectTraceID: file.projectTraceID,
+      projectName: "Untitled",
+      activeCanvasId: canvas.id,
+      activeDeviceId: file.device.id,
+      versionInfo: {
+        source: "web",
+        appVersion: "",
+        savedAt: file.modify,
+        ua: file.ua,
+        minRequiredVersion: file.minRequiredVersion,
+        appMinRequiredVersion: file.appMinRequiredVersion,
+        webMinRequiredVersion: file.webMinRequiredVersion
+      },
+      created: file.created,
+      modify: file.modify,
+      modules: { canvases: [canvas.id], devices: [file.device.id] },
+      cover: "resources/project-cover.png",
+      customProjectData: { projectTraceID: file.projectTraceID }
+    }),
+    "profiles.json": encodeJson({ profiles: {} }),
+    [`canvases/${canvas.id}.json`]: encodeJson({
+      id: canvas.id,
+      title: canvas.title,
+      hidden: false,
+      layerData: canvas.layerData,
+      groupData: canvas.groupData,
+      extendInfo: {
+        version: canvas.extendInfo.version,
+        minCanvasVersion: canvas.extendInfo.minCanvasVersion,
+        displayProcessConfigMap: {},
+        rulerPluginData: { rulerGuide: [] },
+        type: "2d"
+      },
+      chunkLayout: { displayCount: canvas.displays.length, chunkCount: 1, chunkIndexes: [0] }
+    }),
+    [`canvases/${canvas.id}/displays-0.json`]: encodeJson({
+      canvasId: canvas.id,
+      chunkIndex: 0,
+      displays: canvas.displays
+    }),
+    [`devices/device-${file.device.id}.json`]: encodeJson({
+      id: file.device.id,
+      deviceCode: file.device.id,
+      extId: file.extId,
+      extName: file.extName,
+      power: [file.device.power],
+      processing: {
+        [canvas.id]: {
+          id: canvas.id,
+          activeMode: "LASER_PLANE",
+          modes: {
+            LASER_PLANE: {
+              ignoredDisplayIds: [],
+              data: {
+                material: 0,
+                thickness: null,
+                perimeter: null,
+                diameter: null,
+                isProcessByLayer: false,
+                pathPlanning: "auto",
+                fillPlanning: "separate",
+                scanDirection: "topToBottom",
+                enableOddEvenKerf: true,
+                focalLen: null,
+                focalLength: null
+              },
+              profileRefs: [],
+              patches: {},
+              bindings: []
+            }
+          }
+        }
+      }
+    }),
+    ...coverResourceEntries(file.cover)
+  });
+}
+
 // src/layout.ts
 var LAYOUT_MM_PER_EM = 25.4;
 function fontSizePoints(emSizeMm) {
@@ -733,6 +911,16 @@ var XCSGenerator = class {
   toBytes() {
     return new TextEncoder().encode(this.toJSON());
   }
+  /**
+   * Export as a `.xs` (v2 workspace) ZIP archive instead of `.xcs` --
+   * see `buildXsArchive` in `src/xs.ts` for the container format and
+   * its limitations (no processing profiles/device bindings yet).
+   * Display objects themselves carry over unchanged; only the
+   * container differs from `toBytes()`.
+   */
+  toXsBytes() {
+    return buildXsArchive(this.generate());
+  }
   createCanvas() {
     return {
       id: this.canvasId,
@@ -967,9 +1155,12 @@ function createXCS(deviceId = "P2S") {
 0 && (module.exports = {
   XCSGenerator,
   assertXcsFormat,
+  assertXsFormat,
+  buildXsArchive,
   createXCS,
   effectiveCurveDeg,
   extractXcsTokens,
+  extractXsTokens,
   fontSizePoints,
   layoutCurvedGlyphText,
   layoutGlyphText,
@@ -979,6 +1170,7 @@ function createXCS(deviceId = "P2S") {
   loadFont,
   readXcsFile,
   renderXcsFile,
+  renderXsFile,
   translateGlyphLayout
 });
 //# sourceMappingURL=index.cjs.map