@xcodekit/xcode-wasm 0.6.0 → 0.6.1

package/node-wrapper.js

@@ -1,5 +1,5 @@
 /**
- * Node.js wrapper for @xcodekit/xcode-wasm/node.
+ * CJS wrapper for @xcodekit/xcode-wasm/node.
  *
  * Usage:
  *   const { XcodeProject, parse, build } = require("@xcodekit/xcode-wasm/node");
@@ -9,8 +9,14 @@ const { readFileSync, writeFileSync } = require("fs");
 const wasm = require("./xcode");
 
 class XcodeProject extends wasm.XcodeProject {
+  /** @type {string | null} */
   #filePath = null;
 
+  /**
+   * Open and parse a .pbxproj file from disk.
+   * @param {string} filePath
+   * @returns {XcodeProject}
+   */
   static open(filePath) {
     const content = readFileSync(filePath, "utf8");
     const project = new XcodeProject(content);
@@ -18,14 +24,21 @@ class XcodeProject extends wasm.XcodeProject {
     return project;
   }
 
+  /**
+   * Parse a .pbxproj string (no file on disk needed).
+   * @param {string} content
+   * @returns {XcodeProject}
+   */
   static fromString(content) {
     return new XcodeProject(content);
   }
 
+  /** The file path this project was opened from, or null if fromString/constructor. */
   get filePath() {
     return this.#filePath;
   }
 
+  /** Write the project back to its original file. Throws if no file path is set. */
   save() {
     if (!this.#filePath) throw new Error("No file path set — use open() or save(path)");
     writeFileSync(this.#filePath, this.toBuild());

package/node-wrapper.mjs

@@ -6,14 +6,17 @@
  */
 
 import { readFileSync, writeFileSync } from "fs";
-import { createRequire } from "module";
-
-const require = createRequire(import.meta.url);
-const wasm = require("./xcode.js");
+import * as wasm from "./xcode.js";
 
 class XcodeProject extends wasm.XcodeProject {
+  /** @type {string | null} */
   #filePath = null;
 
+  /**
+   * Open and parse a .pbxproj file from disk.
+   * @param {string} filePath
+   * @returns {XcodeProject}
+   */
   static open(filePath) {
     const content = readFileSync(filePath, "utf8");
     const project = new XcodeProject(content);
@@ -21,14 +24,21 @@ class XcodeProject extends wasm.XcodeProject {
     return project;
   }
 
+  /**
+   * Parse a .pbxproj string (no file on disk needed).
+   * @param {string} content
+   * @returns {XcodeProject}
+   */
   static fromString(content) {
     return new XcodeProject(content);
   }
 
+  /** The file path this project was opened from, or null if fromString/constructor. */
   get filePath() {
     return this.#filePath;
   }
 
+  /** Write the project back to its original file. Throws if no file path is set. */
   save() {
     if (!this.#filePath) throw new Error("No file path set — use open() or save(path)");
     writeFileSync(this.#filePath, this.toBuild());
@@ -36,4 +46,21 @@ class XcodeProject extends wasm.XcodeProject {
 }
 
 export { XcodeProject };
-export const { parse, build, parseAndBuild } = wasm;
+
+/**
+ * Parse a .pbxproj string into a JSON-compatible object.
+ * @type {(text: string) => any}
+ */
+export const parse = wasm.parse;
+
+/**
+ * Serialize a JSON object back to .pbxproj format.
+ * @type {(project: object) => string}
+ */
+export const build = wasm.build;
+
+/**
+ * Parse and immediately re-serialize. Stays in WASM, zero marshalling.
+ * @type {(text: string) => string}
+ */
+export const parseAndBuild = wasm.parseAndBuild;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@xcodekit/xcode-wasm",
   "type": "module",
   "description": "Parse, manipulate, and serialize Xcode .pbxproj files (WASM build)",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "license": "MIT",
   "files": [
     "xcode_bg.wasm",