@notask/unity-cli-tools 1.0.7 → 1.1.0-rc.1

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [1.1.0-rc.1](https://github.com/NoTaskStudios/unity-cli-tools/compare/1.0.7...1.1.0-rc.1) (2025-05-04)
+
+
+### Bug Fixes
+
+* access modifiers and catch execa errors ([78c7d26](https://github.com/NoTaskStudios/unity-cli-tools/commit/78c7d26e863fecfe6518384335f9f403cf4144e7))
+
+
+### Features
+
+* **Hub:** Added Error track event for installers ([7333430](https://github.com/NoTaskStudios/unity-cli-tools/commit/7333430a87b2a306e0d9915f2d5bb60baf538698))
+* **Hub:** Added install event emitter for hub events ([cb26730](https://github.com/NoTaskStudios/unity-cli-tools/commit/cb26730c94840218dbc6300573dd601003632a33))
+* **Hub:** Added installer std parser to event emitter ([ffe57b4](https://github.com/NoTaskStudios/unity-cli-tools/commit/ffe57b4b09a1d921573351526df5e887b23875cf))
+* **Hub:** Added types for installer event emitter ([f25e486](https://github.com/NoTaskStudios/unity-cli-tools/commit/f25e48611e0d7b8b49aafea4f0900f65e42cc079))
+
 ## [1.0.7](https://github.com/NoTaskStudios/unity-cli-tools/compare/1.0.6...1.0.7) (2025-05-03)
 
 

package/README.md

@@ -69,6 +69,34 @@ await UnityHub.addEditor("2022.3.60f1", undefined, [UnityModules.AndroidBuildSup
 await UnityHub.addModule("2022.3.60f1", [UnityModules.IOSBuildSupport]);
 ```
 
+### Installation Events
+
+```typescript
+import { UnityHub, UnityModules, InstallerEventType } from "unity-cli-tools";
+
+// Install with event tracking (addEditor returns an event emitter)
+const installer = await UnityHub.addEditor("2022.3.60f1");
+
+// Get a promise that resolves when installation completes
+const installation = installer.completed;
+
+// Or listen to specific events
+installer.on(InstallerEventType.Progress, (events) => {
+  console.log("Progress:", events.map(e => `${e.module}: ${e.status} ${e.progress || 0}%`));
+});
+
+installer.on(InstallerEventType.Error, (error) => {
+  console.error("Installation error:", error);
+});
+
+installer.on(InstallerEventType.Completed, (events) => {
+  console.log("Installation completed!");
+});
+
+// Cancel installation if needed
+installer.Cancel();
+```
+
 ### Projects Management
 
 ```typescript
@@ -225,6 +253,30 @@ console.log(executionResult);
 | `ChineseTraditional` | Traditional Chinese language pack |
 | `Chinese`            | Chinese language pack (legacy)    |
 
+### InstallerStatus
+
+| Constant           | Description                     |
+| ------------------ | ------------------------------- |
+| `Queued`           | Queued for download            |
+| `Validating`       | Validating download            |
+| `InProgress`       | Installation in progress       |
+| `Downloading`      | Downloading installation files |
+| `QueuedInstall`    | Queued for install            |
+| `ValidatingInstall`| Validating installation        |
+| `Installing`       | Installing                     |
+| `Verifying`        | Verifying installation         |
+| `Installed`        | Installed successfully         |
+| `Error`            | Installation error             |
+
+### InstallerEventType
+
+| Constant     | Description                                 |
+| ------------ | ------------------------------------------- |
+| `Progress`   | Installation progress update event          |
+| `Error`      | Installation error event                    |
+| `Completed`  | Installation completed successfully event   |
+| `Cancelled`  | Installation cancelled by user event        |
+
 
 ## Configuration
 

package/dist/cjs/events/hubEventEmitter.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnityHubInstallerEvent = void 0;
+const events_1 = require("events");
+const unity_ts_1 = require("../types/unity.js");
+const hubEventParser_ts_1 = require("./hubEventParser.js");
+class UnityHubInstallerEvent extends events_1.EventEmitter {
+    #moduleTracker = new Map();
+    constructor() {
+        super();
+    }
+    completed = new Promise((resolve, reject) => {
+        this.on(unity_ts_1.InstallerEventType.Completed, (events) => resolve(events));
+        this.on(unity_ts_1.InstallerEventType.Error, (error) => reject(error));
+        this.on(unity_ts_1.InstallerEventType.Cancelled, (events) => reject(new Error("Cancelled")));
+    });
+    Progress(raw) {
+        const events = hubEventParser_ts_1.UnityHubEventParser.parseUnityHubEvent(raw);
+        if (events.length === 0)
+            return;
+        this.#Error(events);
+        const progressEvents = events.filter((e) => e.status !== unity_ts_1.InstallerStatus.Error);
+        if (progressEvents.length === 0)
+            return;
+        this.emit(unity_ts_1.InstallerEventType.Progress, progressEvents);
+        this.#updateModuleTracker(events);
+        this.#Complete(progressEvents);
+    }
+    #Error(events) {
+        const errorEvents = events.filter((e) => e.status === unity_ts_1.InstallerStatus.Error);
+        if (errorEvents.length === 0)
+            return;
+        this.emit(unity_ts_1.InstallerEventType.Error, errorEvents);
+    }
+    #Complete(events) {
+        const installed = events.filter((e) => e.status === unity_ts_1.InstallerStatus.Installed);
+        if (installed.length > 0 && installed.length === events.length) {
+            this.emit(unity_ts_1.InstallerEventType.Completed, installed);
+        }
+    }
+    Cancel() {
+        this.#moduleTracker.clear();
+        this.#Cancelled([]);
+    }
+    #Cancelled(event) {
+        this.emit(unity_ts_1.InstallerEventType.Cancelled, event);
+    }
+    #updateModuleTracker(events) {
+        for (const event of events) {
+            this.#moduleTracker.set(event.module, event.status);
+        }
+    }
+}
+exports.UnityHubInstallerEvent = UnityHubInstallerEvent;

package/dist/cjs/events/hubEventParser.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnityHubEventParser = void 0;
+const unity_ts_1 = require("../types/unity.js");
+class UnityHubEventParser {
+    static errorPatterns = [/Error:.*/];
+    static parseUnityHubEvent(event) {
+        const events = [];
+        const lines = event.split("\n");
+        for (const line of lines) {
+            const errorLine = this.checkForErrors(line);
+            if (errorLine) {
+                events.push(errorLine);
+                continue;
+            }
+        }
+        const pattern = /^\[(?<module>[^\]]+)\]\s+(?<status>.+?)(?:(?:\s+(?<progress>\d+(?:\.\d+)?))%)?\.*$/;
+        for (const line of lines) {
+            const match = line.match(pattern);
+            if (match?.groups) {
+                const { module, status, progress } = match.groups;
+                events.push({
+                    module: module.trim(),
+                    status: status.replace(/\.\.\.$/, "").trim(),
+                    progress: progress ? parseFloat(progress) : status !== unity_ts_1.InstallerStatus.Downloading ? null : 0,
+                });
+            }
+        }
+        return events;
+    }
+    static checkForErrors(line) {
+        for (const pattern of this.errorPatterns) {
+            if (pattern.test(line)) {
+                return {
+                    module: "UnityHub",
+                    status: unity_ts_1.InstallerStatus.Error,
+                    error: line.trim(),
+                };
+            }
+        }
+        return null;
+    }
+}
+exports.UnityHubEventParser = UnityHubEventParser;

package/dist/cjs/types/unity.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnityBuildTarget = exports.TestMode = exports.EditorArchitecture = exports.UnityEditorLanguages = exports.UnityModules = void 0;
+exports.InstallerEventType = exports.InstallerStatus = exports.UnityBuildTarget = exports.TestMode = exports.EditorArchitecture = exports.UnityEditorLanguages = exports.UnityModules = void 0;
 var UnityModules;
 (function (UnityModules) {
     UnityModules["Documentation"] = "documentation";
@@ -59,3 +59,23 @@ var UnityBuildTarget;
     UnityBuildTarget["PS5"] = "PS5";
     UnityBuildTarget["VisionOS"] = "VisionOS";
 })(UnityBuildTarget || (exports.UnityBuildTarget = UnityBuildTarget = {}));
+var InstallerStatus;
+(function (InstallerStatus) {
+    InstallerStatus["Queued"] = "queued for download";
+    InstallerStatus["Validating"] = "validating download";
+    InstallerStatus["InProgress"] = "in progress";
+    InstallerStatus["Downloading"] = "downloading";
+    InstallerStatus["QueuedInstall"] = "queued for install";
+    InstallerStatus["ValidatingInstall"] = "validation installation";
+    InstallerStatus["Installing"] = "installing";
+    InstallerStatus["Verifying"] = "verifying";
+    InstallerStatus["Installed"] = "installed successfully";
+    InstallerStatus["Error"] = "Error";
+})(InstallerStatus || (exports.InstallerStatus = InstallerStatus = {}));
+var InstallerEventType;
+(function (InstallerEventType) {
+    InstallerEventType["Progress"] = "progress";
+    InstallerEventType["Error"] = "error";
+    InstallerEventType["Completed"] = "completed";
+    InstallerEventType["Cancelled"] = "cancelled";
+})(InstallerEventType || (exports.InstallerEventType = InstallerEventType = {}));

package/dist/cjs/unityHub.js

@@ -9,6 +9,7 @@ const path_1 = __importDefault(require("path"));
 const unity_js_1 = require("./types/unity.js");
 const commandExecutor_js_1 = require("./utils/commandExecutor.js");
 const unity_changeset_1 = require("unity-changeset");
+const hubEventEmitter_ts_1 = require("./events/hubEventEmitter.js");
 class UnityHub {
     static CONFIG_PATHS = {
         win32: {
@@ -130,18 +131,14 @@ class UnityHub {
             else {
                 throw new Error("No module IDs provided.");
             }
-            const { stderr } = await this.execUnityHubCommand(args, {
+            const installerEmitter = new hubEventEmitter_ts_1.UnityHubInstallerEvent();
+            this.execUnityHubCommand(args, {
                 reject: false,
-                onStderr: (data) => {
-                    console.warn(`Unity Hub stderr: ${data}`);
-                },
-                onStdout: (data) => {
-                    console.debug(`Unity Hub stdout: ${data}`);
-                },
+                onStdout: (data) => installerEmitter.Progress(data),
+            }).catch((error) => {
+                console.error(`Error adding module ${modules} to Unity ${editorVersion}:`, error);
             });
-            if (stderr) {
-                console.warn(`Add module command warning/error: ${stderr}`);
-            }
+            return installerEmitter;
         }
         catch (error) {
             console.error(`Error adding module ${modules} to Unity ${editorVersion}:`, error);
@@ -163,19 +160,14 @@ class UnityHub {
                 architecture = defaultArchitecture;
             }
             args.push("--architecture", architecture);
-            const { stdout, stderr } = await this.execUnityHubCommand(args, {
+            const installerEmitter = new hubEventEmitter_ts_1.UnityHubInstallerEvent();
+            this.execUnityHubCommand(args, {
                 reject: false,
-                onStderr: (data) => {
-                    console.warn(`Unity Hub stderr: ${data}`);
-                },
-                onStdout: (data) => {
-                    console.debug(`Unity Hub stdout: ${data}`);
-                },
+                onStdout: (data) => installerEmitter.Progress(data),
+            }).catch((error) => {
+                console.error(`Error installing Unity ${version}:`, error);
             });
-            if (stderr) {
-                throw new Error(`Error installing Unity ${version}: ${stderr}`);
-            }
-            console.debug(`Unity ${version}. ${stdout}`);
+            return installerEmitter;
         }
         catch (error) {
             console.error(error);

package/dist/esm/events/hubEventEmitter.d.ts

@@ -0,0 +1,20 @@
+import { EventEmitter } from "events";
+import { InstallerEventType, InstallerEvent } from "../types/unity.ts";
+export interface InstallerEmitter extends EventEmitter {
+    on(event: InstallerEventType.Progress, listener: (info: InstallerEvent[]) => void): this;
+    on(event: InstallerEventType.Error, listener: (error: Error) => void): this;
+    on(event: InstallerEventType.Completed, listener: (info: InstallerEvent[]) => void): this;
+    on(event: InstallerEventType.Cancelled, listener: (info: InstallerEvent[]) => void): this;
+    emit(event: InstallerEventType.Progress, info: InstallerEvent[]): boolean;
+    emit(event: InstallerEventType.Error, info: InstallerEvent[]): boolean;
+    emit(event: InstallerEventType.Completed, info: InstallerEvent[]): boolean;
+    emit(event: InstallerEventType.Cancelled, info: InstallerEvent[]): boolean;
+    readonly completed: Promise<InstallerEvent[]>;
+}
+export declare class UnityHubInstallerEvent extends EventEmitter implements InstallerEmitter {
+    #private;
+    constructor();
+    completed: Promise<InstallerEvent[]>;
+    Progress(raw: string): void;
+    Cancel(): void;
+}

package/dist/esm/events/hubEventEmitter.js

@@ -0,0 +1,50 @@
+import { EventEmitter } from "events";
+import { InstallerEventType, InstallerStatus } from "../types/unity.js";
+import { UnityHubEventParser } from "./hubEventParser.js";
+export class UnityHubInstallerEvent extends EventEmitter {
+    #moduleTracker = new Map();
+    constructor() {
+        super();
+    }
+    completed = new Promise((resolve, reject) => {
+        this.on(InstallerEventType.Completed, (events) => resolve(events));
+        this.on(InstallerEventType.Error, (error) => reject(error));
+        this.on(InstallerEventType.Cancelled, (events) => reject(new Error("Cancelled")));
+    });
+    Progress(raw) {
+        const events = UnityHubEventParser.parseUnityHubEvent(raw);
+        if (events.length === 0)
+            return;
+        this.#Error(events);
+        const progressEvents = events.filter((e) => e.status !== InstallerStatus.Error);
+        if (progressEvents.length === 0)
+            return;
+        this.emit(InstallerEventType.Progress, progressEvents);
+        this.#updateModuleTracker(events);
+        this.#Complete(progressEvents);
+    }
+    #Error(events) {
+        const errorEvents = events.filter((e) => e.status === InstallerStatus.Error);
+        if (errorEvents.length === 0)
+            return;
+        this.emit(InstallerEventType.Error, errorEvents);
+    }
+    #Complete(events) {
+        const installed = events.filter((e) => e.status === InstallerStatus.Installed);
+        if (installed.length > 0 && installed.length === events.length) {
+            this.emit(InstallerEventType.Completed, installed);
+        }
+    }
+    Cancel() {
+        this.#moduleTracker.clear();
+        this.#Cancelled([]);
+    }
+    #Cancelled(event) {
+        this.emit(InstallerEventType.Cancelled, event);
+    }
+    #updateModuleTracker(events) {
+        for (const event of events) {
+            this.#moduleTracker.set(event.module, event.status);
+        }
+    }
+}

package/dist/esm/events/hubEventParser.d.ts

@@ -0,0 +1,6 @@
+import { InstallerEvent } from "../types/unity.ts";
+export declare class UnityHubEventParser {
+    private static errorPatterns;
+    static parseUnityHubEvent(event: string): InstallerEvent[];
+    private static checkForErrors;
+}

package/dist/esm/events/hubEventParser.js

@@ -0,0 +1,40 @@
+import { InstallerStatus } from "../types/unity.js";
+export class UnityHubEventParser {
+    static errorPatterns = [/Error:.*/];
+    static parseUnityHubEvent(event) {
+        const events = [];
+        const lines = event.split("\n");
+        for (const line of lines) {
+            const errorLine = this.checkForErrors(line);
+            if (errorLine) {
+                events.push(errorLine);
+                continue;
+            }
+        }
+        const pattern = /^\[(?<module>[^\]]+)\]\s+(?<status>.+?)(?:(?:\s+(?<progress>\d+(?:\.\d+)?))%)?\.*$/;
+        for (const line of lines) {
+            const match = line.match(pattern);
+            if (match?.groups) {
+                const { module, status, progress } = match.groups;
+                events.push({
+                    module: module.trim(),
+                    status: status.replace(/\.\.\.$/, "").trim(),
+                    progress: progress ? parseFloat(progress) : status !== InstallerStatus.Downloading ? null : 0,
+                });
+            }
+        }
+        return events;
+    }
+    static checkForErrors(line) {
+        for (const pattern of this.errorPatterns) {
+            if (pattern.test(line)) {
+                return {
+                    module: "UnityHub",
+                    status: InstallerStatus.Error,
+                    error: line.trim(),
+                };
+            }
+        }
+        return null;
+    }
+}

package/dist/esm/types/unity.d.ts

@@ -75,3 +75,27 @@ export declare enum UnityBuildTarget {
     PS5 = "PS5",
     VisionOS = "VisionOS"
 }
+export declare enum InstallerStatus {
+    Queued = "queued for download",
+    Validating = "validating download",
+    InProgress = "in progress",
+    Downloading = "downloading",
+    QueuedInstall = "queued for install",
+    ValidatingInstall = "validation installation",
+    Installing = "installing",
+    Verifying = "verifying",
+    Installed = "installed successfully",
+    Error = "Error"
+}
+export interface InstallerEvent {
+    module: string;
+    status: InstallerStatus;
+    progress?: number | null;
+    error?: string | null;
+}
+export declare enum InstallerEventType {
+    Progress = "progress",
+    Error = "error",
+    Completed = "completed",
+    Cancelled = "cancelled"
+}

package/dist/esm/types/unity.js

@@ -56,3 +56,23 @@ export var UnityBuildTarget;
     UnityBuildTarget["PS5"] = "PS5";
     UnityBuildTarget["VisionOS"] = "VisionOS";
 })(UnityBuildTarget || (UnityBuildTarget = {}));
+export var InstallerStatus;
+(function (InstallerStatus) {
+    InstallerStatus["Queued"] = "queued for download";
+    InstallerStatus["Validating"] = "validating download";
+    InstallerStatus["InProgress"] = "in progress";
+    InstallerStatus["Downloading"] = "downloading";
+    InstallerStatus["QueuedInstall"] = "queued for install";
+    InstallerStatus["ValidatingInstall"] = "validation installation";
+    InstallerStatus["Installing"] = "installing";
+    InstallerStatus["Verifying"] = "verifying";
+    InstallerStatus["Installed"] = "installed successfully";
+    InstallerStatus["Error"] = "Error";
+})(InstallerStatus || (InstallerStatus = {}));
+export var InstallerEventType;
+(function (InstallerEventType) {
+    InstallerEventType["Progress"] = "progress";
+    InstallerEventType["Error"] = "error";
+    InstallerEventType["Completed"] = "completed";
+    InstallerEventType["Cancelled"] = "cancelled";
+})(InstallerEventType || (InstallerEventType = {}));

package/dist/esm/unityHub.d.ts

@@ -1,5 +1,6 @@
 import { EditorArchitecture, ModuleId, UnityInstallations } from "./types/unity.js";
 import { CommandOptions, CommandResult } from "./utils/commandExecutor.js";
+import { UnityHubInstallerEvent } from "./events/hubEventEmitter.ts";
 declare class UnityHub {
     private static CONFIG_PATHS;
     static getUnityHubPath(): string;
@@ -8,8 +9,8 @@ declare class UnityHub {
     static getInstallPath(): Promise<string>;
     static setInstallPath(path: string): Promise<void>;
     static getUnityInstallations(filter?: string): Promise<UnityInstallations>;
-    static addModule(editorVersion: string, modules: ModuleId[], childModules?: boolean): Promise<void>;
-    static addEditor(version: string, modules?: ModuleId[], architecture?: EditorArchitecture): Promise<void>;
+    static addModule(editorVersion: string, modules: ModuleId[], childModules?: boolean): Promise<UnityHubInstallerEvent>;
+    static addEditor(version: string, modules?: ModuleId[], architecture?: EditorArchitecture): Promise<UnityHubInstallerEvent>;
     static getProjects(): Promise<{
         name: string;
         path: string;

package/dist/esm/unityHub.js

@@ -4,6 +4,7 @@ import path from "path";
 import { EditorArchitecture, } from "./types/unity.js";
 import { executeCommand } from "./utils/commandExecutor.js";
 import { getUnityChangeset } from "unity-changeset";
+import { UnityHubInstallerEvent } from "./events/hubEventEmitter.js";
 class UnityHub {
     static CONFIG_PATHS = {
         win32: {
@@ -125,18 +126,14 @@ class UnityHub {
             else {
                 throw new Error("No module IDs provided.");
             }
-            const { stderr } = await this.execUnityHubCommand(args, {
+            const installerEmitter = new UnityHubInstallerEvent();
+            this.execUnityHubCommand(args, {
                 reject: false,
-                onStderr: (data) => {
-                    console.warn(`Unity Hub stderr: ${data}`);
-                },
-                onStdout: (data) => {
-                    console.debug(`Unity Hub stdout: ${data}`);
-                },
+                onStdout: (data) => installerEmitter.Progress(data),
+            }).catch((error) => {
+                console.error(`Error adding module ${modules} to Unity ${editorVersion}:`, error);
             });
-            if (stderr) {
-                console.warn(`Add module command warning/error: ${stderr}`);
-            }
+            return installerEmitter;
         }
         catch (error) {
             console.error(`Error adding module ${modules} to Unity ${editorVersion}:`, error);
@@ -158,19 +155,14 @@ class UnityHub {
                 architecture = defaultArchitecture;
             }
             args.push("--architecture", architecture);
-            const { stdout, stderr } = await this.execUnityHubCommand(args, {
+            const installerEmitter = new UnityHubInstallerEvent();
+            this.execUnityHubCommand(args, {
                 reject: false,
-                onStderr: (data) => {
-                    console.warn(`Unity Hub stderr: ${data}`);
-                },
-                onStdout: (data) => {
-                    console.debug(`Unity Hub stdout: ${data}`);
-                },
+                onStdout: (data) => installerEmitter.Progress(data),
+            }).catch((error) => {
+                console.error(`Error installing Unity ${version}:`, error);
             });
-            if (stderr) {
-                throw new Error(`Error installing Unity ${version}: ${stderr}`);
-            }
-            console.debug(`Unity ${version}. ${stdout}`);
+            return installerEmitter;
         }
         catch (error) {
             console.error(error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@notask/unity-cli-tools",
-  "version": "1.0.7",
+  "version": "1.1.0-rc.1",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",