ogi-addon 2.0.0 → 2.2.0

package/build/{EventResponse-D0TZjAVC.d.mts → EventResponse-BJ8gWjdT.d.mts}

@@ -271,15 +271,13 @@ declare class OGIAddon {
   searchGame(query: string, storefront: string): Promise<BasicLibraryInfo[]>;
   /**
    * Notify the OGI Addon Server that you are performing a background task. This can be used to help users understand what is happening in the background.
-   * @param id {string}
-   * @param progress {number}
-   * @param logs {string[]}
+   * @returns {Promise<Task>} A Task instance for managing the background task.
    */
-  task(): Promise<CustomTask>;
+  task(): Promise<Task>;
   /**
    * Register a task handler for a specific task name. The task name should match the taskName field in SearchResult or ActionOption.
    * @param taskName {string} The name of the task (should match taskName in SearchResult or ActionOption.setTaskName()).
-   * @param handler {(task: Task, data: { manifest: Record<string, unknown>; downloadPath: string; name: string }) => Promise<void> | void} The handler function.
+   * @param handler {(task: Task, data: { manifest: Record<string, unknown>; downloadPath: string; name: string; libraryInfo: LibraryInfo }) => Promise<void> | void} The handler function.
    * @example
    * ```typescript
    * addon.onTask('clearCache', async (task) => {
@@ -295,6 +293,7 @@ declare class OGIAddon {
     manifest: Record<string, unknown>;
     downloadPath: string;
     name: string;
+    libraryInfo: LibraryInfo;
   }) => Promise<void> | void): void;
   /**
    * Check if a task handler is registered for the given task name.
@@ -311,6 +310,7 @@ declare class OGIAddon {
     manifest: Record<string, unknown>;
     downloadPath: string;
     name: string;
+    libraryInfo?: LibraryInfo;
   }) => Promise<void> | void) | undefined;
   /**
    * Extract a file using 7-Zip on Windows, unzip on Linux/Mac.
@@ -321,27 +321,32 @@ declare class OGIAddon {
    */
   extractFile(path: string, outputPath: string, type: 'unrar' | 'unzip'): Promise<void>;
 }
-declare class CustomTask {
-  readonly id: string;
-  progress: number;
-  logs: string[];
-  finished: boolean;
-  ws: OGIAddonWSListener;
-  failed: string | undefined;
-  constructor(ws: OGIAddonWSListener, id: string, progress: number, logs: string[]);
-  log(log: string): void;
-  finish(): void;
-  fail(message: string): void;
-  setProgress(progress: number): void;
-  update(): void;
-}
 /**
- * A cleaner API wrapper around EventResponse for task handlers.
+ * A unified task API for both server-initiated tasks (via onTask handlers)
+ * and addon-initiated background tasks (via addon.task()).
  * Provides chainable methods for logging, progress updates, and completion.
  */
 declare class Task {
   private event;
+  private ws;
+  private readonly id;
+  private progress;
+  private logs;
+  private finished;
+  private failed;
+  /**
+   * Construct a Task from an EventResponse (for onTask handlers).
+   * @param event {EventResponse<void>} The event response to wrap.
+   */
   constructor(event: EventResponse<void>);
+  /**
+   * Construct a Task from WebSocket listener (for addon.task()).
+   * @param ws {OGIAddonWSListener} The WebSocket listener.
+   * @param id {string} The task ID.
+   * @param progress {number} Initial progress (0-100).
+   * @param logs {string[]} Initial logs array.
+   */
+  constructor(ws: OGIAddonWSListener, id: string, progress: number, logs: string[]);
   /**
    * Log a message to the task. Returns this for chaining.
    * @param message {string} The message to log.
@@ -363,13 +368,20 @@ declare class Task {
   fail(message: string): void;
   /**
    * Ask the user for input using a ConfigurationBuilder screen.
+   * Only available for EventResponse-based tasks (onTask handlers).
    * The return type is inferred from the ConfigurationBuilder's accumulated option types.
    * @param name {string} The name/title of the input prompt.
    * @param description {string} The description of what input is needed.
    * @param screen {ConfigurationBuilder<U>} The configuration builder for the input form.
    * @returns {Promise<U>} The user's input with types matching the configuration options.
+   * @throws {Error} If called on a WebSocket-based task.
    */
   askForInput<U extends Record<string, string | number | boolean>>(name: string, description: string, screen: ConfigurationBuilder<U>): Promise<U>;
+  /**
+   * Update the task state (for WebSocket-based tasks only).
+   * Called automatically when using log(), setProgress(), complete(), or fail().
+   */
+  private update;
 }
 /**
  * A search tool wrapper over Fuse.js for the OGI Addon. This tool is used to search for items in the library.
@@ -483,5 +495,5 @@ declare class EventResponse<T> {
   askForInput<U extends Record<string, string | number | boolean>>(name: string, description: string, screen: ConfigurationBuilder<U>): Promise<U>;
 }
 //#endregion
-export { WebsocketMessageClient as _, EventListenerTypes as a, OGIAddonClientSentEvent as c, OGIAddonServerSentEvent as d, SearchTool as f, VERSION as g, Task as h, CustomTask as i, OGIAddonConfiguration as l, StoreData as m, BasicLibraryInfo as n, LibraryInfo as o, SetupEventResponse as p, ClientSentEventTypes as r, OGIAddon as s, EventResponse as t, OGIAddonEvent as u, WebsocketMessageServer as v, ZodLibraryInfo as y };
-//# sourceMappingURL=EventResponse-D0TZjAVC.d.mts.map
+export { WebsocketMessageServer as _, LibraryInfo as a, OGIAddonConfiguration as c, SearchTool as d, SetupEventResponse as f, WebsocketMessageClient as g, VERSION as h, EventListenerTypes as i, OGIAddonEvent as l, Task as m, BasicLibraryInfo as n, OGIAddon as o, StoreData as p, ClientSentEventTypes as r, OGIAddonClientSentEvent as s, EventResponse as t, OGIAddonServerSentEvent as u, ZodLibraryInfo as v };
+//# sourceMappingURL=EventResponse-BJ8gWjdT.d.mts.map

package/build/{EventResponse-DgSuJPu8.d.cts → EventResponse-DrBsB9tW.d.cts}

@@ -271,15 +271,13 @@ declare class OGIAddon {
   searchGame(query: string, storefront: string): Promise<BasicLibraryInfo[]>;
   /**
    * Notify the OGI Addon Server that you are performing a background task. This can be used to help users understand what is happening in the background.
-   * @param id {string}
-   * @param progress {number}
-   * @param logs {string[]}
+   * @returns {Promise<Task>} A Task instance for managing the background task.
    */
-  task(): Promise<CustomTask>;
+  task(): Promise<Task>;
   /**
    * Register a task handler for a specific task name. The task name should match the taskName field in SearchResult or ActionOption.
    * @param taskName {string} The name of the task (should match taskName in SearchResult or ActionOption.setTaskName()).
-   * @param handler {(task: Task, data: { manifest: Record<string, unknown>; downloadPath: string; name: string }) => Promise<void> | void} The handler function.
+   * @param handler {(task: Task, data: { manifest: Record<string, unknown>; downloadPath: string; name: string; libraryInfo: LibraryInfo }) => Promise<void> | void} The handler function.
    * @example
    * ```typescript
    * addon.onTask('clearCache', async (task) => {
@@ -295,6 +293,7 @@ declare class OGIAddon {
     manifest: Record<string, unknown>;
     downloadPath: string;
     name: string;
+    libraryInfo: LibraryInfo;
   }) => Promise<void> | void): void;
   /**
    * Check if a task handler is registered for the given task name.
@@ -311,6 +310,7 @@ declare class OGIAddon {
     manifest: Record<string, unknown>;
     downloadPath: string;
     name: string;
+    libraryInfo?: LibraryInfo;
   }) => Promise<void> | void) | undefined;
   /**
    * Extract a file using 7-Zip on Windows, unzip on Linux/Mac.
@@ -321,27 +321,32 @@ declare class OGIAddon {
    */
   extractFile(path: string, outputPath: string, type: 'unrar' | 'unzip'): Promise<void>;
 }
-declare class CustomTask {
-  readonly id: string;
-  progress: number;
-  logs: string[];
-  finished: boolean;
-  ws: OGIAddonWSListener;
-  failed: string | undefined;
-  constructor(ws: OGIAddonWSListener, id: string, progress: number, logs: string[]);
-  log(log: string): void;
-  finish(): void;
-  fail(message: string): void;
-  setProgress(progress: number): void;
-  update(): void;
-}
 /**
- * A cleaner API wrapper around EventResponse for task handlers.
+ * A unified task API for both server-initiated tasks (via onTask handlers)
+ * and addon-initiated background tasks (via addon.task()).
  * Provides chainable methods for logging, progress updates, and completion.
  */
 declare class Task {
   private event;
+  private ws;
+  private readonly id;
+  private progress;
+  private logs;
+  private finished;
+  private failed;
+  /**
+   * Construct a Task from an EventResponse (for onTask handlers).
+   * @param event {EventResponse<void>} The event response to wrap.
+   */
   constructor(event: EventResponse<void>);
+  /**
+   * Construct a Task from WebSocket listener (for addon.task()).
+   * @param ws {OGIAddonWSListener} The WebSocket listener.
+   * @param id {string} The task ID.
+   * @param progress {number} Initial progress (0-100).
+   * @param logs {string[]} Initial logs array.
+   */
+  constructor(ws: OGIAddonWSListener, id: string, progress: number, logs: string[]);
   /**
    * Log a message to the task. Returns this for chaining.
    * @param message {string} The message to log.
@@ -363,13 +368,20 @@ declare class Task {
   fail(message: string): void;
   /**
    * Ask the user for input using a ConfigurationBuilder screen.
+   * Only available for EventResponse-based tasks (onTask handlers).
    * The return type is inferred from the ConfigurationBuilder's accumulated option types.
    * @param name {string} The name/title of the input prompt.
    * @param description {string} The description of what input is needed.
    * @param screen {ConfigurationBuilder<U>} The configuration builder for the input form.
    * @returns {Promise<U>} The user's input with types matching the configuration options.
+   * @throws {Error} If called on a WebSocket-based task.
    */
   askForInput<U extends Record<string, string | number | boolean>>(name: string, description: string, screen: ConfigurationBuilder<U>): Promise<U>;
+  /**
+   * Update the task state (for WebSocket-based tasks only).
+   * Called automatically when using log(), setProgress(), complete(), or fail().
+   */
+  private update;
 }
 /**
  * A search tool wrapper over Fuse.js for the OGI Addon. This tool is used to search for items in the library.
@@ -483,5 +495,5 @@ declare class EventResponse<T> {
   askForInput<U extends Record<string, string | number | boolean>>(name: string, description: string, screen: ConfigurationBuilder<U>): Promise<U>;
 }
 //#endregion
-export { WebsocketMessageClient as _, EventListenerTypes as a, OGIAddonClientSentEvent as c, OGIAddonServerSentEvent as d, SearchTool as f, VERSION as g, Task as h, CustomTask as i, OGIAddonConfiguration as l, StoreData as m, BasicLibraryInfo as n, LibraryInfo as o, SetupEventResponse as p, ClientSentEventTypes as r, OGIAddon as s, EventResponse as t, OGIAddonEvent as u, WebsocketMessageServer as v, ZodLibraryInfo as y };
-//# sourceMappingURL=EventResponse-DgSuJPu8.d.cts.map
+export { WebsocketMessageServer as _, LibraryInfo as a, OGIAddonConfiguration as c, SearchTool as d, SetupEventResponse as f, WebsocketMessageClient as g, VERSION as h, EventListenerTypes as i, OGIAddonEvent as l, Task as m, BasicLibraryInfo as n, OGIAddon as o, StoreData as p, ClientSentEventTypes as r, OGIAddonClientSentEvent as s, EventResponse as t, OGIAddonServerSentEvent as u, ZodLibraryInfo as v };
+//# sourceMappingURL=EventResponse-DrBsB9tW.d.cts.map

package/build/EventResponse.d.cts

@@ -1,2 +1,2 @@
-import { t as EventResponse } from "./EventResponse-DgSuJPu8.cjs";
+import { t as EventResponse } from "./EventResponse-DrBsB9tW.cjs";
 export = EventResponse;

package/build/EventResponse.d.mts

@@ -1,2 +1,2 @@
-import { t as EventResponse } from "./EventResponse-D0TZjAVC.mjs";
+import { t as EventResponse } from "./EventResponse-BJ8gWjdT.mjs";
 export { EventResponse as default };

package/build/main.cjs

@@ -14,7 +14,7 @@ let node_fs = require("node:fs");
 node_fs = require_ConfigurationBuilder.__toESM(node_fs);
 
 //#region package.json
-var version = "2.0.0";
+var version = "2.2.0";
 
 //#endregion
 //#region src/main.ts
@@ -97,15 +97,13 @@ var OGIAddon = class {
 	}
 	/**
 	* Notify the OGI Addon Server that you are performing a background task. This can be used to help users understand what is happening in the background.
-	* @param id {string}
-	* @param progress {number}
-	* @param logs {string[]}
+	* @returns {Promise<Task>} A Task instance for managing the background task.
 	*/
 	async task() {
 		const id = Math.random().toString(36).substring(7);
 		const progress = 0;
 		const logs = [];
-		const task = new CustomTask(this.addonWSListener, id, progress, logs);
+		const task = new Task(this.addonWSListener, id, progress, logs);
 		this.addonWSListener.send("task-update", {
 			id,
 			progress,
@@ -118,7 +116,7 @@ var OGIAddon = class {
 	/**
 	* Register a task handler for a specific task name. The task name should match the taskName field in SearchResult or ActionOption.
 	* @param taskName {string} The name of the task (should match taskName in SearchResult or ActionOption.setTaskName()).
-	* @param handler {(task: Task, data: { manifest: Record<string, unknown>; downloadPath: string; name: string }) => Promise<void> | void} The handler function.
+	* @param handler {(task: Task, data: { manifest: Record<string, unknown>; downloadPath: string; name: string; libraryInfo: LibraryInfo }) => Promise<void> | void} The handler function.
 	* @example
 	* ```typescript
 	* addon.onTask('clearCache', async (task) => {
@@ -232,61 +230,40 @@ var OGIAddon = class {
 		});
 	}
 };
-var CustomTask = class {
-	id;
-	progress;
-	logs;
-	finished = false;
-	ws;
-	failed = void 0;
-	constructor(ws$2, id, progress, logs) {
-		this.id = id;
-		this.progress = progress;
-		this.logs = logs;
-		this.ws = ws$2;
-	}
-	log(log) {
-		this.logs.push(log);
-		this.update();
-	}
-	finish() {
-		this.finished = true;
-		this.update();
-	}
-	fail(message) {
-		this.failed = message;
-		this.update();
-	}
-	setProgress(progress) {
-		this.progress = progress;
-		this.update();
-	}
-	update() {
-		this.ws.send("task-update", {
-			id: this.id,
-			progress: this.progress,
-			logs: this.logs,
-			finished: this.finished,
-			failed: this.failed
-		});
-	}
-};
 /**
-* A cleaner API wrapper around EventResponse for task handlers.
+* A unified task API for both server-initiated tasks (via onTask handlers)
+* and addon-initiated background tasks (via addon.task()).
 * Provides chainable methods for logging, progress updates, and completion.
 */
 var Task = class {
 	event;
-	constructor(event) {
-		this.event = event;
-		this.event.defer();
+	ws;
+	id;
+	progress = 0;
+	logs = [];
+	finished = false;
+	failed = void 0;
+	constructor(eventOrWs, id, progress, logs) {
+		if (eventOrWs instanceof require_EventResponse) {
+			this.event = eventOrWs;
+			this.event.defer();
+		} else {
+			this.ws = eventOrWs;
+			this.id = id;
+			this.progress = progress ?? 0;
+			this.logs = logs ?? [];
+		}
 	}
 	/**
 	* Log a message to the task. Returns this for chaining.
 	* @param message {string} The message to log.
 	*/
 	log(message) {
-		this.event.log(message);
+		if (this.event) this.event.log(message);
+		else {
+			this.logs.push(message);
+			this.update();
+		}
 		return this;
 	}
 	/**
@@ -294,33 +271,61 @@ var Task = class {
 	* @param progress {number} The progress value (0-100).
 	*/
 	setProgress(progress) {
-		this.event.progress = progress;
+		if (this.event) this.event.progress = progress;
+		else {
+			this.progress = progress;
+			this.update();
+		}
 		return this;
 	}
 	/**
 	* Complete the task successfully.
 	*/
 	complete() {
-		this.event.complete();
+		if (this.event) this.event.complete();
+		else {
+			this.finished = true;
+			this.update();
+		}
 	}
 	/**
 	* Fail the task with an error message.
 	* @param message {string} The error message.
 	*/
 	fail(message) {
-		this.event.fail(message);
+		if (this.event) this.event.fail(message);
+		else {
+			this.failed = message;
+			this.update();
+		}
 	}
 	/**
 	* Ask the user for input using a ConfigurationBuilder screen.
+	* Only available for EventResponse-based tasks (onTask handlers).
 	* The return type is inferred from the ConfigurationBuilder's accumulated option types.
 	* @param name {string} The name/title of the input prompt.
 	* @param description {string} The description of what input is needed.
 	* @param screen {ConfigurationBuilder<U>} The configuration builder for the input form.
 	* @returns {Promise<U>} The user's input with types matching the configuration options.
+	* @throws {Error} If called on a WebSocket-based task.
 	*/
 	async askForInput(name, description, screen) {
+		if (!this.event) throw new Error("askForInput() is only available for EventResponse-based tasks (onTask handlers)");
 		return this.event.askForInput(name, description, screen);
 	}
+	/**
+	* Update the task state (for WebSocket-based tasks only).
+	* Called automatically when using log(), setProgress(), complete(), or fail().
+	*/
+	update() {
+		if (this.ws && this.id !== void 0) this.ws.send("task-update", {
+			id: this.id,
+			progress: this.progress,
+			logs: this.logs,
+			finished: this.finished,
+			failed: this.failed
+		});
+	}
 };
 /**
 * A search tool wrapper over Fuse.js for the OGI Addon. This tool is used to search for items in the library.
@@ -537,7 +542,8 @@ var OGIAddonWSListener = class {
 							const result$1 = handler(task, {
 								manifest: message.args.manifest || {},
 								downloadPath: message.args.downloadPath || "",
-								name: message.args.name || ""
+								name: message.args.name || "",
+								libraryInfo: message.args.libraryInfo
 							});
 							if (result$1 instanceof Promise) await result$1;
 							clearInterval(interval);
@@ -614,7 +620,6 @@ var OGIAddonWSListener = class {
 //#endregion
 exports.Configuration = require_config_Configuration.Configuration;
 exports.ConfigurationBuilder = require_ConfigurationBuilder.ConfigurationBuilder;
-exports.CustomTask = CustomTask;
 exports.EventResponse = require_EventResponse;
 exports.SearchTool = SearchTool;
 exports.Task = Task;