@xcodekit/xcode-node 0.6.8

package/index.d.ts

@@ -0,0 +1,118 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+/** Parse a .pbxproj string into a JSON-compatible object. */
+export declare function parse(text: string): any
+/** Serialize a JSON object back to .pbxproj format. */
+export declare function build(project: any): string
+/**
+ * Serialize a JSON string back to .pbxproj format.
+ * Faster than `build()` — accepts `JSON.stringify(project)` directly,
+ * avoiding napi's recursive JS→Rust object marshalling.
+ */
+export declare function buildFromJSON(json: string): string
+/**
+ * Parse and immediately re-serialize a .pbxproj string.
+ * Fastest path — stays entirely in Rust, zero JS↔Rust marshalling.
+ */
+export declare function parseAndBuild(text: string): string
+/** XcodeProject class for high-level API. */
+export declare class XcodeProject {
+  /** Open and parse a .pbxproj file from disk. */
+  static open(filePath: string): XcodeProject
+  /** Parse a .pbxproj string into an XcodeProject (no file on disk needed). */
+  static fromString(content: string): XcodeProject
+  /** Convert the project to a JSON-compatible object. */
+  toJSON(): any
+  /** Serialize the project back to .pbxproj format. */
+  toBuild(): string
+  /** Write the project back to its original file. */
+  save(): void
+  /** Get the file path this project was loaded from. */
+  get filePath(): string | null
+  /** Get the archive version. */
+  get archiveVersion(): number
+  /** Get the object version. */
+  get objectVersion(): number
+  /** Get all native target UUIDs. */
+  getNativeTargets(): Array<string>
+  /** Get a build setting value from a target. */
+  getBuildSetting(targetUuid: string, key: string): any
+  /** Set a build setting on all configurations for a target. */
+  setBuildSetting(targetUuid: string, key: string, value: string): boolean
+  /** Remove a build setting from all configurations for a target. */
+  removeBuildSetting(targetUuid: string, key: string): boolean
+  /**
+   * Find orphaned references (UUIDs referenced but not present in objects).
+   * Returns array of { referrerUuid, referrerIsa, property, orphanUuid }.
+   */
+  findOrphanedReferences(): Array<any>
+  /** Find the main app target UUID. */
+  findMainAppTarget(platform?: string | undefined | null): string | null
+  /** Generate a unique UUID. */
+  getUniqueId(seed: string): string
+  /** Get the main group UUID. */
+  get mainGroupUuid(): string | null
+  /** Get children UUIDs of a group. */
+  getGroupChildren(groupUuid: string): Array<string>
+  /**
+   * Add a file reference to the project and a group.
+   * Returns the UUID of the new PBXFileReference.
+   */
+  addFile(groupUuid: string, path: string): string | null
+  /**
+   * Create a group and add it as a child of a parent group.
+   * Returns the UUID of the new PBXGroup.
+   */
+  addGroup(parentUuid: string, name: string): string | null
+  /**
+   * Add a build file to a build phase.
+   * Returns the UUID of the new PBXBuildFile.
+   */
+  addBuildFile(phaseUuid: string, fileRefUuid: string): string | null
+  /**
+   * Find or create a build phase for a target.
+   * Returns the UUID of the build phase.
+   */
+  ensureBuildPhase(targetUuid: string, phaseIsa: string): string | null
+  /**
+   * Add a framework to a target.
+   * Returns the UUID of the PBXBuildFile.
+   */
+  addFramework(targetUuid: string, frameworkName: string): string | null
+  /**
+   * Create a native target with Debug/Release configs, standard build phases, and product ref.
+   * Returns the UUID of the new PBXNativeTarget.
+   */
+  createNativeTarget(name: string, productType: string, bundleId: string): string | null
+  /**
+   * Add a dependency from one target to another.
+   * Returns the UUID of the PBXTargetDependency.
+   */
+  addDependency(targetUuid: string, dependsOnUuid: string): string | null
+  /**
+   * Embed an extension target into a host app target.
+   * Creates PBXCopyFilesBuildPhase with correct dstSubfolderSpec.
+   * Returns the UUID of the copy files build phase.
+   */
+  embedExtension(hostTargetUuid: string, extensionTargetUuid: string): string | null
+  /**
+   * Add a PBXFileSystemSynchronizedRootGroup to a target (Xcode 16+).
+   * Returns the UUID of the sync group.
+   */
+  addFileSystemSyncGroup(targetUuid: string, path: string): string | null
+  /** Get a string property from any object. */
+  getObjectProperty(uuid: string, key: string): string | null
+  /** Set a string property on any object. */
+  setObjectProperty(uuid: string, key: string, value: string): boolean
+  /** Find all object UUIDs matching a given ISA type. */
+  findObjectsByIsa(isa: string): Array<string>
+  /** Get the name of a target. */
+  getTargetName(targetUuid: string): string | null
+  /** Set the name and productName of a target. */
+  setTargetName(targetUuid: string, name: string): boolean
+  /** Rename a target and cascade through the project (group paths, product refs, proxies). */
+  renameTarget(targetUuid: string, oldName: string, newName: string): boolean
+}

package/index.js

@@ -0,0 +1,319 @@
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
+
+const { platform, arch } = process
+
+let nativeBinding = null
+let localFileExisted = false
+let loadError = null
+
+function isMusl() {
+  // For Node 10
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      const lddPath = require('child_process').execSync('which ldd').toString().trim()
+      return readFileSync(lddPath, 'utf8').includes('musl')
+    } catch (e) {
+      return true
+    }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header
+    return !glibcVersionRuntime
+  }
+}
+
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'xcode.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./xcode.android-arm64.node')
+          } else {
+            nativeBinding = require('undefined-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'xcode.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./xcode.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('undefined-android-arm-eabi')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Android ${arch}`)
+    }
+    break
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(
+          join(__dirname, 'xcode.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./xcode.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('undefined-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'xcode.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./xcode.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('undefined-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'xcode.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./xcode.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('undefined-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'xcode.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./xcode.darwin-universal.node')
+      } else {
+        nativeBinding = require('undefined-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'xcode.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./xcode.darwin-x64.node')
+          } else {
+            nativeBinding = require('undefined-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'xcode.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./xcode.darwin-arm64.node')
+          } else {
+            nativeBinding = require('undefined-darwin-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on macOS: ${arch}`)
+    }
+    break
+  case 'freebsd':
+    if (arch !== 'x64') {
+      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
+    }
+    localFileExisted = existsSync(join(__dirname, 'xcode.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./xcode.freebsd-x64.node')
+      } else {
+        nativeBinding = require('undefined-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'xcode.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./xcode.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('undefined-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'xcode.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./xcode.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('undefined-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'xcode.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./xcode.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('undefined-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'xcode.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./xcode.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('undefined-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'xcode.linux-arm-musleabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./xcode.linux-arm-musleabihf.node')
+            } else {
+              nativeBinding = require('undefined-linux-arm-musleabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'xcode.linux-arm-gnueabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./xcode.linux-arm-gnueabihf.node')
+            } else {
+              nativeBinding = require('undefined-linux-arm-gnueabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'xcode.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./xcode.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('undefined-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'xcode.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./xcode.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('undefined-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, 'xcode.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./xcode.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('undefined-linux-s390x-gnu')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Linux: ${arch}`)
+    }
+    break
+  default:
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+const { parse, build, buildFromJSON, parseAndBuild, XcodeProject } = nativeBinding
+
+module.exports.parse = parse
+module.exports.build = build
+module.exports.buildFromJSON = buildFromJSON
+module.exports.parseAndBuild = parseAndBuild
+module.exports.XcodeProject = XcodeProject

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@xcodekit/xcode-node",
+  "version": "0.6.8",
+  "description": "Parse, manipulate, and serialize Xcode .pbxproj files — native Node.js addon (napi-rs)",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "types.d.ts"
+  ],
+  "optionalDependencies": {
+    "@xcodekit/xcode-darwin-arm64": "0.6.8",
+    "@xcodekit/xcode-darwin-x64": "0.6.8",
+    "@xcodekit/xcode-linux-arm64-gnu": "0.6.8",
+    "@xcodekit/xcode-linux-x64-gnu": "0.6.8",
+    "@xcodekit/xcode-win32-x64-msvc": "0.6.8"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mozharovsky/xcode"
+  },
+  "license": "MIT",
+  "keywords": [
+    "xcode",
+    "pbxproj",
+    "ios",
+    "apple",
+    "parser",
+    "native",
+    "napi",
+    "rust"
+  ]
+}

package/types.d.ts

@@ -0,0 +1,252 @@
+/**
+ * Supplemental type definitions for @xcodekit/xcode.
+ *
+ * These provide rich types for the parsed .pbxproj JSON structure
+ * beyond what napi-rs auto-generates.
+ */
+
+/** ISA types for all known Xcode project object types. */
+export type ISA =
+  | "PBXBuildFile"
+  | "PBXAppleScriptBuildPhase"
+  | "PBXCopyFilesBuildPhase"
+  | "PBXFrameworksBuildPhase"
+  | "PBXHeadersBuildPhase"
+  | "PBXResourcesBuildPhase"
+  | "PBXShellScriptBuildPhase"
+  | "PBXSourcesBuildPhase"
+  | "PBXRezBuildPhase"
+  | "PBXContainerItemProxy"
+  | "PBXFileReference"
+  | "PBXGroup"
+  | "PBXVariantGroup"
+  | "XCVersionGroup"
+  | "PBXFileSystemSynchronizedRootGroup"
+  | "PBXFileSystemSynchronizedBuildFileExceptionSet"
+  | "PBXFileSystemSynchronizedGroupBuildPhaseMembershipExceptionSet"
+  | "PBXNativeTarget"
+  | "PBXAggregateTarget"
+  | "PBXLegacyTarget"
+  | "PBXProject"
+  | "PBXTargetDependency"
+  | "XCBuildConfiguration"
+  | "XCConfigurationList"
+  | "PBXBuildRule"
+  | "PBXReferenceProxy"
+  | "XCSwiftPackageProductDependency"
+  | "XCRemoteSwiftPackageReference"
+  | "XCLocalSwiftPackageReference";
+
+/** A 24-character hexadecimal UUID string. */
+export type UUID = string;
+
+/** Boolean as 0 | 1 integer. */
+export type BoolNumber = 0 | 1;
+
+/** Boolean as YES/NO string. */
+export type BoolString = "YES" | "NO" | "YES_ERROR" | "YES_AGGRESSIVE";
+
+/** Source tree reference types. */
+export type SourceTree = "BUILT_PRODUCTS_DIR" | "DEVELOPER_DIR" | "SOURCE_ROOT" | "SDKROOT" | "<group>" | "<absolute>";
+
+/** CopyFilesBuildPhase destination subfolder spec. */
+export enum SubFolder {
+  absolutePath = 0,
+  wrapper = 1,
+  executables = 6,
+  resources = 7,
+  frameworks = 10,
+  sharedFrameworks = 11,
+  sharedSupport = 12,
+  plugins = 13,
+  javaResources = 15,
+  productsDirectory = 16,
+}
+
+/** Container item proxy type. */
+export enum ProxyType {
+  targetReference = 1,
+  reference = 2,
+}
+
+/** Common file type UTIs. */
+export type FileType =
+  | "sourcecode.swift"
+  | "sourcecode.c.c"
+  | "sourcecode.c.h"
+  | "sourcecode.c.objc"
+  | "sourcecode.cpp.cpp"
+  | "sourcecode.cpp.objcpp"
+  | "sourcecode.javascript"
+  | "wrapper.application"
+  | "wrapper.framework"
+  | "wrapper.app-extension"
+  | "wrapper.plug-in"
+  | "wrapper.xcframework"
+  | "compiled.mach-o.dylib"
+  | "archive.ar"
+  | "folder.assetcatalog"
+  | "text.plist.xml"
+  | "text.plist.strings"
+  | "text.plist.entitlements"
+  | "text.xcconfig"
+  | "file.storyboard"
+  | "file.xib"
+  | "file.intentdefinition"
+  | "image.png"
+  | "image.jpeg"
+  | "net.daringfireball.markdown"
+  | string;
+
+/** Common product type UTIs. */
+export type ProductType =
+  | "com.apple.product-type.application"
+  | "com.apple.product-type.application.on-demand-install-capable"
+  | "com.apple.product-type.app-extension"
+  | "com.apple.product-type.bundle"
+  | "com.apple.product-type.framework"
+  | "com.apple.product-type.library.dynamic"
+  | "com.apple.product-type.library.static"
+  | "com.apple.product-type.tool"
+  | "com.apple.product-type.unit-test-bundle"
+  | "com.apple.product-type.ui-testing-bundle"
+  | "com.apple.product-type.application.watchapp"
+  | "com.apple.product-type.application.watchapp2"
+  | "com.apple.product-type.watchkit-extension"
+  | "com.apple.product-type.extensionkit-extension"
+  | string;
+
+/** Build settings dictionary. */
+export interface BuildSettings {
+  ALWAYS_SEARCH_USER_PATHS?: BoolString;
+  ASSETCATALOG_COMPILER_APPICON_NAME?: string;
+  CLANG_ENABLE_MODULES?: BoolString;
+  CLANG_ENABLE_OBJC_ARC?: BoolString;
+  CODE_SIGN_ENTITLEMENTS?: string;
+  CODE_SIGN_IDENTITY?: string;
+  CODE_SIGN_STYLE?: "Automatic" | "Manual";
+  CURRENT_PROJECT_VERSION?: string;
+  DEBUG_INFORMATION_FORMAT?: "dwarf" | "dwarf-with-dsym";
+  DEVELOPMENT_TEAM?: string;
+  GCC_OPTIMIZATION_LEVEL?: string;
+  GCC_PREPROCESSOR_DEFINITIONS?: string | string[];
+  GENERATE_INFOPLIST_FILE?: BoolString;
+  INFOPLIST_FILE?: string;
+  INFOPLIST_KEY_CFBundleDisplayName?: string;
+  IPHONEOS_DEPLOYMENT_TARGET?: string;
+  MACOSX_DEPLOYMENT_TARGET?: string;
+  TVOS_DEPLOYMENT_TARGET?: string;
+  WATCHOS_DEPLOYMENT_TARGET?: string;
+  MARKETING_VERSION?: string;
+  PRODUCT_BUNDLE_IDENTIFIER?: string;
+  PRODUCT_NAME?: string;
+  SWIFT_VERSION?: string;
+  TARGETED_DEVICE_FAMILY?: string;
+  [key: string]: string | string[] | number | undefined;
+}
+
+/** Base object with isa field. */
+export interface PBXObjectBase {
+  isa: ISA;
+  [key: string]: any;
+}
+
+/** PBXBuildFile object. */
+export interface PBXBuildFile extends PBXObjectBase {
+  isa: "PBXBuildFile";
+  fileRef?: UUID;
+  productRef?: UUID;
+  settings?: Record<string, any>;
+  platformFilter?: string;
+  platformFilters?: string[];
+}
+
+/** PBXFileReference object. */
+export interface PBXFileReference extends PBXObjectBase {
+  isa: "PBXFileReference";
+  fileEncoding?: number;
+  lastKnownFileType?: FileType;
+  explicitFileType?: FileType;
+  includeInIndex?: BoolNumber;
+  name?: string;
+  path?: string;
+  sourceTree?: SourceTree;
+}
+
+/** PBXGroup object. */
+export interface PBXGroup extends PBXObjectBase {
+  isa: "PBXGroup";
+  children: UUID[];
+  name?: string;
+  path?: string;
+  sourceTree?: SourceTree;
+}
+
+/** Build phase (shared fields for all 8 types). */
+export interface AbstractBuildPhase extends PBXObjectBase {
+  buildActionMask?: number;
+  files: UUID[];
+  runOnlyForDeploymentPostprocessing?: BoolNumber;
+}
+
+/** PBXNativeTarget object. */
+export interface PBXNativeTarget extends PBXObjectBase {
+  isa: "PBXNativeTarget";
+  buildConfigurationList: UUID;
+  buildPhases: UUID[];
+  buildRules: UUID[];
+  dependencies: UUID[];
+  name: string;
+  productName?: string;
+  productReference?: UUID;
+  productType: ProductType;
+  packageProductDependencies?: UUID[];
+  fileSystemSynchronizedGroups?: UUID[];
+}
+
+/** PBXProject (root object). */
+export interface PBXProject extends PBXObjectBase {
+  isa: "PBXProject";
+  buildConfigurationList: UUID;
+  compatibilityVersion: string;
+  developmentRegion: string;
+  hasScannedForEncodings: BoolNumber;
+  knownRegions: string[];
+  mainGroup: UUID;
+  productRefGroup?: UUID;
+  projectDirPath: string;
+  projectRoot: string;
+  targets: UUID[];
+  packageReferences?: UUID[];
+  attributes?: {
+    LastSwiftUpdateCheck?: string;
+    LastUpgradeCheck?: string;
+    TargetAttributes?: Record<UUID, Record<string, any>>;
+    [key: string]: any;
+  };
+}
+
+/** XCBuildConfiguration object. */
+export interface XCBuildConfiguration extends PBXObjectBase {
+  isa: "XCBuildConfiguration";
+  name: string;
+  buildSettings: BuildSettings;
+  baseConfigurationReference?: UUID;
+}
+
+/** XCConfigurationList object. */
+export interface XCConfigurationList extends PBXObjectBase {
+  isa: "XCConfigurationList";
+  buildConfigurations: UUID[];
+  defaultConfigurationIsVisible?: BoolNumber;
+  defaultConfigurationName?: string;
+}
+
+/** The top-level parsed .pbxproj structure. */
+export interface ParsedProject {
+  archiveVersion: number;
+  classes: Record<string, any>;
+  objectVersion: number;
+  objects: Record<UUID, PBXObjectBase>;
+  rootObject: UUID;
+}