@richardmcquiston01/unofficial-xcs-writer 0.5.0 → 0.6.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.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

package/README.md

@@ -13,7 +13,7 @@ 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 (`.xs` generation isn't supported yet — see `CLAUDE.md`'s "Open Issues")
+- **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
 
@@ -97,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`
@@ -151,6 +157,10 @@ Same as `extractXcsTokens`, but scans every `canvases/<canvasId>/displays-<chunk
 
 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.
@@ -166,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:
 

package/dist/index.cjs

@@ -33,6 +33,7 @@ __export(index_exports, {
   XCSGenerator: () => XCSGenerator,
   assertXcsFormat: () => assertXcsFormat,
   assertXsFormat: () => assertXsFormat,
+  buildXsArchive: () => buildXsArchive,
   createXCS: () => createXCS,
   effectiveCurveDeg: () => effectiveCurveDeg,
   extractXcsTokens: () => extractXcsTokens,
@@ -358,6 +359,126 @@ function renderXsFile(buffer, variables, values, fonts) {
   }
   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;
@@ -790,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,
@@ -1025,6 +1156,7 @@ function createXCS(deviceId = "P2S") {
   XCSGenerator,
   assertXcsFormat,
   assertXsFormat,
+  buildXsArchive,
   createXCS,
   effectiveCurveDeg,
   extractXcsTokens,