ogi-addon 1.2.0 → 1.3.0

package/build/main.js

@@ -14,7 +14,7 @@ var ConfigurationBuilder = class {
   /**
    * Add a number option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.
    * @param option { (option: NumberOption) => NumberOption }
-   * @returns 
+   * @returns
    */
   addNumberOption(option) {
     let newOption = new NumberOption();
@@ -25,7 +25,7 @@ var ConfigurationBuilder = class {
   /**
    * Add a string option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.
    * @param option { (option: StringOption) => StringOption }
-  */
+   */
   addStringOption(option) {
     let newOption = new StringOption();
     newOption = option(newOption);
@@ -35,7 +35,7 @@ var ConfigurationBuilder = class {
   /**
    * Add a boolean option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.
    * @param option { (option: BooleanOption) => BooleanOption }
-  */
+   */
   addBooleanOption(option) {
     let newOption = new BooleanOption();
     newOption = option(newOption);
@@ -74,9 +74,9 @@ var ConfigurationOption = class {
     return this;
   }
   /**
-   * Set the display name of the option. This is used to show the user a human readable version of what the option is. **REQUIRED** 
-   * @param displayName {string} The display name of the option. 
-   * @returns 
+   * Set the display name of the option. This is used to show the user a human readable version of what the option is. **REQUIRED**
+   * @param displayName {string} The display name of the option.
+   * @returns
    */
   setDisplayName(displayName) {
     this.displayName = displayName;
@@ -84,8 +84,8 @@ var ConfigurationOption = class {
   }
   /**
    * Set the description of the option. This is to show the user a brief description of what this option does. **REQUIRED**
-   * @param description {string} The description of the option. 
-   * @returns 
+   * @param description {string} The description of the option.
+   * @returns
    */
   setDescription(description) {
     this.description = description;
@@ -107,7 +107,7 @@ var StringOption = class extends ConfigurationOption {
   inputType = "text";
   type = "string";
   /**
-   * Set the allowed values for the string. If the array is empty, any value is allowed. When provided, the client will act like this option is a dropdown.  
+   * Set the allowed values for the string. If the array is empty, any value is allowed. When provided, the client will act like this option is a dropdown.
    * @param allowedValues {string[]} An array of allowed values for the string. If the array is empty, any value is allowed.
    */
   setAllowedValues(allowedValues) {
@@ -123,15 +123,15 @@ var StringOption = class extends ConfigurationOption {
     return this;
   }
   /**
-   * Set the minimum text length for the string. If the user provides a string that is less than this value, the validation will fail. 
-   * @param minTextLength {number} The minimum text length for the string. 
+   * Set the minimum text length for the string. If the user provides a string that is less than this value, the validation will fail.
+   * @param minTextLength {number} The minimum text length for the string.
    */
   setMinTextLength(minTextLength) {
     this.minTextLength = minTextLength;
     return this;
   }
   /**
-   * Set the maximum text length for the string. If the user provides a string that is greater than this value, the validation will fail. 
+   * Set the maximum text length for the string. If the user provides a string that is greater than this value, the validation will fail.
    * @param maxTextLength {number} The maximum text length for the string.
    */
   setMaxTextLength(maxTextLength) {
@@ -139,8 +139,8 @@ var StringOption = class extends ConfigurationOption {
     return this;
   }
   /**
-   * Set the input type for the string. This will change how the client renders the input. 
-   * @param inputType {'text' | 'file' | 'password' | 'folder'} The input type for the string. 
+   * Set the input type for the string. This will change how the client renders the input.
+   * @param inputType {'text' | 'file' | 'password' | 'folder'} The input type for the string.
    */
   setInputType(inputType) {
     this.inputType = inputType;
@@ -153,9 +153,15 @@ var StringOption = class extends ConfigurationOption {
     if (this.allowedValues.length === 0 && input.length !== 0)
       return [true, ""];
     if (input.length < this.minTextLength || input.length > this.maxTextLength) {
-      return [false, "Input is not within the text length " + this.minTextLength + " and " + this.maxTextLength + " characters (currently " + input.length + " characters)"];
+      return [
+        false,
+        "Input is not within the text length " + this.minTextLength + " and " + this.maxTextLength + " characters (currently " + input.length + " characters)"
+      ];
     }
-    return [this.allowedValues.includes(input), "Input is not an allowed value"];
+    return [
+      this.allowedValues.includes(input),
+      "Input is not an allowed value"
+    ];
   }
 };
 var NumberOption = class extends ConfigurationOption {
@@ -173,8 +179,8 @@ var NumberOption = class extends ConfigurationOption {
     return this;
   }
   /**
-   * Set the input type for the number. This will change how the client renders the input. 
-   * @param type {'range' | 'number'} The input type for the number. 
+   * Set the input type for the number. This will change how the client renders the input.
+   * @param type {'range' | 'number'} The input type for the number.
    */
   setInputType(type) {
     this.inputType = type;
@@ -201,7 +207,10 @@ var NumberOption = class extends ConfigurationOption {
       return [false, "Input is not a number"];
     }
     if (Number(input) < this.min || Number(input) > this.max) {
-      return [false, "Input is not within the range of " + this.min + " and " + this.max];
+      return [
+        false,
+        "Input is not within the range of " + this.min + " and " + this.max
+      ];
     }
     return [true, ""];
   }
@@ -245,20 +254,26 @@ var Configuration = class {
     const erroredKeys = /* @__PURE__ */ new Map();
     for (const key in this.storedConfigTemplate) {
       if (this.definiteConfig[key] === null || this.definiteConfig[key] === void 0) {
-        console.warn("Option " + key + " is not defined. Using default value Value: " + this.definiteConfig[key]);
+        console.warn(
+          "Option " + key + " is not defined. Using default value Value: " + this.definiteConfig[key]
+        );
         this.definiteConfig[key] = this.storedConfigTemplate[key].defaultValue;
       }
       if (this.storedConfigTemplate[key].type !== typeof this.definiteConfig[key]) {
         throw new Error("Option " + key + " is not of the correct type");
       }
-      const result = this.storedConfigTemplate[key].validate(this.definiteConfig[key]);
+      const result = this.storedConfigTemplate[key].validate(
+        this.definiteConfig[key]
+      );
       if (!result[0]) {
         erroredKeys.set(key, result[1]);
       }
     }
     for (const key in this.definiteConfig) {
       if (!this.storedConfigTemplate[key]) {
-        throw new Error("Option " + key + " is not defined in the configuration template");
+        throw new Error(
+          "Option " + key + " is not defined in the configuration template"
+        );
       }
     }
     if (erroredKeys.size > 0) {
@@ -302,15 +317,19 @@ var EventResponse = class {
   resolved = false;
   progress = 0;
   logs = [];
+  failed = void 0;
   onInputAsked;
   constructor(onInputAsked) {
     this.onInputAsked = onInputAsked;
   }
-  defer() {
+  defer(promise) {
     this.deffered = true;
+    if (promise) {
+      promise();
+    }
   }
   /**
-   * Resolve the event with data. This acts like a promise resolve, and will stop the event from being processed further. **You must always call this method when you are done with the event.** 
+   * Resolve the event with data. This acts like a promise resolve, and will stop the event from being processed further. **You must always call this method when you are done with the event.**
    * @param data {T}
    */
   resolve(data) {
@@ -318,13 +337,17 @@ var EventResponse = class {
     this.data = data;
   }
   /**
-   * Completes the event and resolves it, but does not return any data. **You must always call this method when you are done with the event.** 
+   * Completes the event and resolves it, but does not return any data. **You must always call this method when you are done with the event.**
    */
   complete() {
     this.resolved = true;
   }
+  fail(message) {
+    this.resolved = true;
+    this.failed = message;
+  }
   /**
-   * Logs a message to the event. This is useful for debugging and logging information to the user. 
+   * Logs a message to the event. This is useful for debugging and logging information to the user.
    * @param message {string}
    */
   log(message) {
@@ -355,7 +378,7 @@ var package_default = {
   module: "./build/main.js",
   type: "module",
   main: "./build/main.cjs",
-  version: "1.2.0",
+  version: "1.3.0",
   exports: {
     ".": {
       import: {
@@ -398,6 +421,7 @@ var package_default = {
   devDependencies: {
     "@types/node": "^20.14.12",
     "@types/ws": "^8.4.0",
+    prettier: "^3.6.0",
     tsup: "^8.2.3",
     typescript: "^5.0.0"
   }
@@ -412,34 +436,45 @@ var OGIAddon = class {
   addonInfo;
   config = new Configuration({});
   constructor(addonInfo) {
-    this.addonInfo = addonInfo;
+    this.addonInfo = { storeFrontServerCapable: false, ...addonInfo };
     this.addonWSListener = new OGIAddonWSListener(this, this.eventEmitter);
   }
   /**
-   * Register an event listener for the addon. (See EventListenerTypes) 
+   * Register an event listener for the addon. (See EventListenerTypes)
    * @param event {OGIAddonEvent}
-   * @param listener {EventListenerTypes[OGIAddonEvent]} 
+   * @param listener {EventListenerTypes[OGIAddonEvent]}
    */
   on(event, listener) {
     this.eventEmitter.on(event, listener);
+    if (event === "game-details") {
+      this.addonInfo.storeFrontServerCapable = true;
+      this.addonWSListener.send("flag", {
+        flag: "storeFrontServerCapable",
+        value: this.addonInfo.storeFrontServerCapable
+      });
+    }
   }
   emit(event, ...args) {
     this.eventEmitter.emit(event, ...args);
   }
   /**
-   * Notify the client using a notification. Provide the type of notification, the message, and an ID. 
+   * Notify the client using a notification. Provide the type of notification, the message, and an ID.
    * @param notification {Notification}
    */
   notify(notification) {
     this.addonWSListener.send("notification", [notification]);
   }
   /**
-   * Search for items in the OGI Steam-Synced Library. Query can either be a Steam AppID or a Steam Game Name.
-   * @param query {string}
-   * @param event {EventResponse<BasicLibraryInfo[]>}
+   * Get the app details for a given appID and storefront.
+   * @param appID {number}
+   * @param storefront {string}
+   * @returns {Promise<StoreData>}
    */
-  async steamSearch(query, strict = false) {
-    const id = this.addonWSListener.send("steam-search", { query, strict });
+  async getAppDetails(appID, storefront) {
+    const id = this.addonWSListener.send("get-app-details", {
+      appID,
+      storefront
+    });
     return await this.addonWSListener.waitForResponseFromServer(id);
   }
   /**
@@ -453,7 +488,13 @@ var OGIAddon = class {
     const progress = 0;
     const logs = [];
     const task = new CustomTask(this.addonWSListener, id, progress, logs);
-    this.addonWSListener.send("task-update", { id, progress, logs, finished: false });
+    this.addonWSListener.send("task-update", {
+      id,
+      progress,
+      logs,
+      finished: false,
+      failed: void 0
+    });
     return task;
   }
 };
@@ -463,6 +504,7 @@ var CustomTask = class {
   logs;
   finished = false;
   ws;
+  failed = void 0;
   constructor(ws2, id, progress, logs) {
     this.id = id;
     this.progress = progress;
@@ -477,17 +519,30 @@ var CustomTask = class {
     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 });
+    this.ws.send("task-update", {
+      id: this.id,
+      progress: this.progress,
+      logs: this.logs,
+      finished: this.finished,
+      failed: this.failed
+    });
   }
 };
 var SearchTool = class {
   fuse;
-  constructor(items, keys, options = { threshold: 0.3, includeScore: true }) {
+  constructor(items, keys, options = {
+    threshold: 0.3,
+    includeScore: true
+  }) {
     this.fuse = new Fuse(items, {
       keys,
       ...options
@@ -506,7 +561,9 @@ var OGIAddonWSListener = class {
   addon;
   constructor(ogiAddon, eventEmitter) {
     if (process.argv[process.argv.length - 1].split("=")[0] !== "--addonSecret") {
-      throw new Error("No secret provided. This usually happens because the addon was not started by the OGI Addon Server.");
+      throw new Error(
+        "No secret provided. This usually happens because the addon was not started by the OGI Addon Server."
+      );
     }
     this.addon = ogiAddon;
     this.eventEmitter = eventEmitter;
@@ -527,7 +584,9 @@ var OGIAddonWSListener = class {
     });
     this.socket.on("error", (error) => {
       if (error.message.includes("Failed to connect")) {
-        throw new Error("OGI Addon Server is not running/is unreachable. Please start the server and try again.");
+        throw new Error(
+          "OGI Addon Server is not running/is unreachable. Please start the server and try again."
+        );
       }
       console.error("An error occurred:", error);
     });
@@ -550,15 +609,17 @@ var OGIAddonWSListener = class {
     if (!socket) {
       return {};
     }
-    socket.send(JSON.stringify({
-      event: "input-asked",
-      args: {
-        config,
-        name,
-        description
-      },
-      id
-    }));
+    socket.send(
+      JSON.stringify({
+        event: "input-asked",
+        args: {
+          config,
+          name,
+          description
+        },
+        id
+      })
+    );
     return await this.waitForResponseFromServer(id);
   }
   registerMessageReceiver() {
@@ -568,20 +629,39 @@ var OGIAddonWSListener = class {
         case "config-update":
           const result = this.addon.config.updateConfig(message.args);
           if (!result[0]) {
-            this.respondToMessage(message.id, { success: false, error: result[1] });
+            this.respondToMessage(message.id, {
+              success: false,
+              error: result[1]
+            });
           } else {
             this.respondToMessage(message.id, { success: true });
           }
           break;
         case "search":
-          let searchResultEvent = new EventResponse((screen, name, description) => this.userInputAsked(screen, name, description, this.socket));
+          let searchResultEvent = new EventResponse(
+            (screen, name, description) => this.userInputAsked(screen, name, description, this.socket)
+          );
           this.eventEmitter.emit("search", message.args, searchResultEvent);
           const searchResult = await this.waitForEventToRespond(searchResultEvent);
           this.respondToMessage(message.id, searchResult.data);
           break;
         case "setup":
-          let setupEvent = new EventResponse((screen, name, description) => this.userInputAsked(screen, name, description, this.socket));
-          this.eventEmitter.emit("setup", { path: message.args.path, appID: message.args.appID, storefront: message.args.storefront, type: message.args.type, name: message.args.name, usedRealDebrid: message.args.usedRealDebrid, multiPartFiles: message.args.multiPartFiles }, setupEvent);
+          let setupEvent = new EventResponse(
+            (screen, name, description) => this.userInputAsked(screen, name, description, this.socket)
+          );
+          this.eventEmitter.emit(
+            "setup",
+            {
+              path: message.args.path,
+              appID: message.args.appID,
+              storefront: message.args.storefront,
+              type: message.args.type,
+              name: message.args.name,
+              usedRealDebrid: message.args.usedRealDebrid,
+              multiPartFiles: message.args.multiPartFiles
+            },
+            setupEvent
+          );
           const interval = setInterval(() => {
             if (setupEvent.resolved) {
               clearInterval(interval);
@@ -590,45 +670,83 @@ var OGIAddonWSListener = class {
             this.send("defer-update", {
               logs: setupEvent.logs,
               deferID: message.args.deferID,
-              progress: setupEvent.progress
+              progress: setupEvent.progress,
+              failed: setupEvent.failed
             });
           }, 100);
           const setupResult = await this.waitForEventToRespond(setupEvent);
           this.respondToMessage(message.id, setupResult.data);
           break;
         case "library-search":
-          let librarySearchEvent = new EventResponse((screen, name, description) => this.userInputAsked(screen, name, description, this.socket));
+          let librarySearchEvent = new EventResponse(
+            (screen, name, description) => this.userInputAsked(screen, name, description, this.socket)
+          );
           if (this.eventEmitter.listenerCount("game-details") === 0) {
             this.respondToMessage(message.id, []);
             break;
           }
-          this.eventEmitter.emit("library-search", message.args, librarySearchEvent);
+          this.eventEmitter.emit(
+            "library-search",
+            message.args,
+            librarySearchEvent
+          );
           const librarySearchResult = await this.waitForEventToRespond(librarySearchEvent);
           this.respondToMessage(message.id, librarySearchResult.data);
           break;
         case "game-details":
-          let gameDetailsEvent = new EventResponse((screen, name, description) => this.userInputAsked(screen, name, description, this.socket));
+          let gameDetailsEvent = new EventResponse(
+            (screen, name, description) => this.userInputAsked(screen, name, description, this.socket)
+          );
           if (this.eventEmitter.listenerCount("game-details") === 0) {
-            this.respondToMessage(message.id, { error: "No event listener for game-details" });
+            this.respondToMessage(message.id, {
+              error: "No event listener for game-details"
+            });
             break;
           }
-          this.eventEmitter.emit("game-details", message.args, gameDetailsEvent);
+          this.eventEmitter.emit(
+            "game-details",
+            message.args,
+            gameDetailsEvent
+          );
           const gameDetailsResult = await this.waitForEventToRespond(gameDetailsEvent);
           this.respondToMessage(message.id, gameDetailsResult.data);
           break;
         case "request-dl":
-          let requestDLEvent = new EventResponse((screen, name, description) => this.userInputAsked(screen, name, description, this.socket));
+          let requestDLEvent = new EventResponse(
+            (screen, name, description) => this.userInputAsked(screen, name, description, this.socket)
+          );
           if (this.eventEmitter.listenerCount("request-dl") === 0) {
-            this.respondToMessage(message.id, { error: "No event listener for request-dl" });
+            this.respondToMessage(message.id, {
+              error: "No event listener for request-dl"
+            });
             break;
           }
-          this.eventEmitter.emit("request-dl", message.args.appID, message.args.info, requestDLEvent);
+          this.eventEmitter.emit(
+            "request-dl",
+            message.args.appID,
+            message.args.info,
+            requestDLEvent
+          );
           const requestDLResult = await this.waitForEventToRespond(requestDLEvent);
-          if (requestDLEvent.data === null || requestDLEvent.data?.downloadType === "request") {
-            throw new Error("Request DL event did not return a valid result. Please ensure that the event does not resolve with another `request` download type.");
+          if (requestDLEvent.failed) {
+            this.respondToMessage(message.id, {
+              statusError: requestDLEvent.failed
+            });
+            break;
+          }
+          if (requestDLEvent.data === void 0 || requestDLEvent.data?.downloadType === "request") {
+            throw new Error(
+              "Request DL event did not return a valid result. Please ensure that the event does not resolve with another `request` download type."
+            );
           }
           this.respondToMessage(message.id, requestDLResult.data);
           break;
+        case "catalog":
+          let catalogEvent = new EventResponse();
+          this.eventEmitter.emit("catalog", catalogEvent);
+          const catalogResult = await this.waitForEventToRespond(catalogEvent);
+          this.respondToMessage(message.id, catalogResult.data);
+          break;
       }
     });
   }
@@ -656,11 +774,13 @@ var OGIAddonWSListener = class {
     });
   }
   respondToMessage(messageID, response) {
-    this.socket.send(JSON.stringify({
-      event: "response",
-      id: messageID,
-      args: response
-    }));
+    this.socket.send(
+      JSON.stringify({
+        event: "response",
+        id: messageID,
+        args: response
+      })
+    );
     console.log("dispatched response to " + messageID);
   }
   waitForResponseFromServer(messageID) {
@@ -683,11 +803,13 @@ var OGIAddonWSListener = class {
   }
   send(event, args) {
     const id = Math.random().toString(36).substring(7);
-    this.socket.send(JSON.stringify({
-      event,
-      args,
-      id
-    }));
+    this.socket.send(
+      JSON.stringify({
+        event,
+        args,
+        id
+      })
+    );
     return id;
   }
   close() {