Merge pull request #8 from NoTaskStudios/feature/unity-editor-commands

Feature/unity editor commands

Author: MtMath

.npmignore

@@ -29,3 +29,4 @@ eslint.config.js
 # Build Packing
 dist-tar/
 *.zip
+*.tar

README.md

@@ -88,6 +88,107 @@ const result = await UnityHub.execUnityHubCommand(["editors", "-r"]);
 console.log(result.stdout);
 ```
 
+## UnityEditor API Reference
+
+UnityEditor provides an interface for automating tasks directly in the Unity Editor:
+
+### Installation and Availability
+```typescript
+import UnityEditor from "@notask/unity-cli-tools";
+
+// Get the executable path and verify installation
+const unityPath = UnityEditor.getUnityExecutablePath("2022.3.15f1");
+const isInstalled = await UnityEditor.isUnityVersionInstalled("2022.3.15f1");
+console.log(`Installed: ${isInstalled}`, unityPath);
+```
+
+### Executing Raw Editor Commands
+```typescript
+import { CommandResult } from "@notask/unity-cli-tools";
+
+const editorInfo = { version: "2022.3.15f1", path: unityPath };
+const result: CommandResult = await UnityEditor.execUnityEditorCommand(
+  editorInfo,
+  ["-batchmode", "-quit", "-projectPath", "/path/to/project"]
+);
+console.log(result.stdout);
+```
+
+### Creating and Opening Projects
+```typescript
+import { ProjectInfo } from "@notask/unity-cli-tools";
+
+const projectInfo: ProjectInfo = {
+  projectPath: "/path/to/new/project",
+  editorVersion: "2022.3.15f1"
+};
+
+await UnityEditor.createProject(projectInfo);
+await UnityEditor.openProject(projectInfo, true, true);
+```
+
+### Running Tests
+```typescript
+import { ProjectInfo, TestMode } from "@notask/unity-cli-tools";
+
+const projectInfo: ProjectInfo = {
+  projectPath: "/path/to/project",
+  editorVersion: "2022.3.15f1"
+};
+
+const { success, output } = await UnityEditor.runTests(projectInfo, TestMode.EditMode);
+console.log(success ? "Tests passed" : "Tests failed", output);
+```
+
+### License Management
+```typescript
+import { ProjectInfo } from "@notask/unity-cli-tools";
+
+const projectInfo: ProjectInfo = {
+  projectPath: "/path/to/project",
+  editorVersion: "2022.3.15f1"
+};
+
+await UnityEditor.activateLicense(projectInfo, "XXXX-XXXX-XXXX-XXXX-XXXX", "user@example.com", "password");
+await UnityEditor.returnLicense(projectInfo);
+```
+
+### Importing and Exporting Packages
+```typescript
+import { ProjectInfo } from "@notask/unity-cli-tools";
+
+const projectInfo: ProjectInfo = {
+  projectPath: "/path/to/project",
+  editorVersion: "2022.3.15f1"
+};
+
+await UnityEditor.exportPackage(
+  projectInfo,
+  ["Assets/UI", "Assets/Scripts"],
+  "/path/to/output/MyPackage.unitypackage"
+);
+await UnityEditor.importPackage(
+  projectInfo,
+  "/path/to/downloads/OtherPackage.unitypackage"
+);
+```
+
+### Executing Custom Editor Methods
+```typescript
+import { ProjectInfo } from "@notask/unity-cli-tools";
+
+const projectInfo: ProjectInfo = {
+  projectPath: "/path/to/project",
+  editorVersion: "2022.3.15f1"
+};
+
+const executionResult = await UnityEditor.executeMethod(
+  projectInfo,
+  "MyCompany.BuildTools.PerformBuild"
+);
+console.log(executionResult);
+```
+
 ## Available Constants
 
 ### UnityModules

package.json

@@ -21,7 +21,7 @@
     "url": "https://github.com/NoTaskStudios/unity-cli-tools.git"
   },
   "scripts": {
-    "clean": "rimraf dist dist-cjs",
+    "clean": "rimraf dist",
     "build": "npm run clean && npm run build:esm && npm run build:cjs",
     "build:esm": "tsc --project tsconfig.json",
     "build:cjs": "tsc --project tsconfig.cjs.json && node scripts/write-cjs-package.cjs",
@@ -66,4 +66,4 @@
     "typescript": "^5.8.3",
     "typescript-eslint": "8.30.1"
   }
-}
+}

src/index.ts

@@ -1,3 +1,4 @@
 export { default as UnityHub } from "./unityHub.ts";
+export { default as UnityEditor } from "./unityEditor.ts";
 
 export * from "./types/unity.ts";

src/types/unity.ts

@@ -40,7 +40,7 @@ export enum UnityModules {
   UWPBuildSupportDotNet = "uwp-.net",
 }
 
-export enum UnityLanguages {
+export enum UnityEditorLanguages {
   Japanese = "language-ja",
   Korean = "language-ko",
   ChineseSimplified = "language-zh-hans",
@@ -53,23 +53,17 @@ export enum EditorArchitecture {
   arm64 = "arm64",
 }
 
-export type ModuleId = UnityModules | UnityLanguages;
+export type ModuleId = UnityModules | UnityEditorLanguages;
 export type UnityInstallations = Record<string, string>;
 
 //EDITOR
 export interface ProjectInfo {
-  path: string;
-  editorVersion: string;
   projectName: string;
+  projectPath: string;
+  editorVersion: string;
   scenes?: string[];
 }
 
-export interface ProjectSettings {
-  companyName?: string;
-  productName?: string;
-  bundleVersion?: string;
-}
-
 // Ref https://docs.unity3d.com/Packages/com.unity.test-framework@1.4/manual/reference-command-line.html#testplatform
 export enum TestMode {
   EditMode = "editmode",
@@ -94,21 +88,3 @@ export enum UnityBuildTarget {
   PS5 = "PS5",
   VisionOS = "VisionOS",
 }
-
-/**
- * Represents a parsed Unity version
- */
-export interface ParsedVersion {
-  /** Major version number (e.g. 2022) */
-  major: number;
-  /** Minor version number (e.g. 3) */
-  minor: number;
-  /** Patch version number (e.g. 60) */
-  patch: number;
-  /** Release type: 'a' (alpha), 'b' (beta), 'f' (final) */
-  type: string;
-  /** Revision number (e.g. 1) */
-  revision: number;
-  /** Original version string */
-  original: string;
-}