ogi-addon 1.5.1 → 1.6.0

package/src/main.ts

@@ -19,6 +19,7 @@ export type OGIAddonEvent =
   | 'library-search'
   | 'game-details'
   | 'exit'
+  | 'task-run'
   | 'request-dl'
   | 'catalog';
 
@@ -41,6 +42,7 @@ export type OGIAddonServerSentEvent =
   | 'setup'
   | 'response'
   | 'library-search'
+  | 'task-run'
   | 'game-details'
   | 'request-dl'
   | 'catalog';
@@ -89,6 +91,21 @@ export type BasicLibraryInfo = {
   storefront: string;
 };
 
+export type SetupEventResponse = Omit<
+  LibraryInfo,
+  | 'capsuleImage'
+  | 'coverImage'
+  | 'name'
+  | 'appID'
+  | 'storefront'
+  | 'addonsource'
+  | 'titleImage'
+> & {
+  redistributables?: {
+    name: string;
+    path: string;
+  }[];
+};
 export interface EventListenerTypes {
   /**
    * This event is emitted when the addon connects to the OGI Addon Server. Addon does not need to resolve anything.
@@ -150,19 +167,9 @@ export interface EventListenerTypes {
       }[];
       appID: number;
       storefront: string;
+      manifest?: Record<string, unknown>;
     },
-    event: EventResponse<
-      Omit<
-        LibraryInfo,
-        | 'capsuleImage'
-        | 'coverImage'
-        | 'name'
-        | 'appID'
-        | 'storefront'
-        | 'addonsource'
-        | 'titleImage'
-      >
-    >
+    event: EventResponse<SetupEventResponse>
   ) => void;
 
   /**
@@ -176,6 +183,21 @@ export interface EventListenerTypes {
     event: EventResponse<BasicLibraryInfo[]>
   ) => void;
 
+  /**
+   * This event is emitted when the client requests for a task to be run. Addon should resolve the event with the task.
+   * @param task
+   * @param event
+   * @returns
+   */
+  'task-run': (
+    task: {
+      manifest: Record<string, unknown>;
+      downloadPath: string;
+      name: string;
+    },
+    event: EventResponse<void>
+  ) => void;
+
   /**
    * This event is emitted when the client requests for a game details to be fetched. Addon should resolve the event with the game details. This is used to generate a store page for the game.
    * @param appID
@@ -241,11 +263,13 @@ export interface WebsocketMessageClient {
   event: OGIAddonClientSentEvent;
   id?: string;
   args: any;
+  statusError?: string;
 }
 export interface WebsocketMessageServer {
   event: OGIAddonServerSentEvent;
   id?: string;
   args: any;
+  statusError?: string;
 }
 
 /**
@@ -557,12 +581,16 @@ class OGIAddonWSListener {
         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],
+              },
+              undefined
+            );
           } else {
-            this.respondToMessage(message.id!!, { success: true });
+            this.respondToMessage(message.id!!, { success: true }, undefined);
           }
           break;
         case 'search':
@@ -573,26 +601,18 @@ class OGIAddonWSListener {
           this.eventEmitter.emit('search', message.args, searchResultEvent);
           const searchResult =
             await this.waitForEventToRespond(searchResultEvent);
-          this.respondToMessage(message.id!!, searchResult.data);
+          this.respondToMessage(
+            message.id!!,
+            searchResult.data,
+            searchResultEvent
+          );
           break;
-        case 'setup':
-          let setupEvent = new EventResponse<LibraryInfo>(
+        case 'setup': {
+          let setupEvent = new EventResponse<SetupEventResponse>(
             (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
-          );
+          this.eventEmitter.emit('setup', message.args, setupEvent);
           const interval = setInterval(() => {
             if (setupEvent.resolved) {
               clearInterval(interval);
@@ -606,15 +626,16 @@ class OGIAddonWSListener {
             } as ClientSentEventTypes['defer-update']);
           }, 100);
           const setupResult = await this.waitForEventToRespond(setupEvent);
-          this.respondToMessage(message.id!!, setupResult.data);
+          this.respondToMessage(message.id!!, setupResult.data, setupEvent);
           break;
+        }
         case 'library-search':
           let librarySearchEvent = new EventResponse<BasicLibraryInfo[]>(
             (screen, name, description) =>
               this.userInputAsked(screen, name, description, this.socket)
           );
           if (this.eventEmitter.listenerCount('game-details') === 0) {
-            this.respondToMessage(message.id!!, []);
+            this.respondToMessage(message.id!!, [], librarySearchEvent);
             break;
           }
           this.eventEmitter.emit(
@@ -624,7 +645,11 @@ class OGIAddonWSListener {
           );
           const librarySearchResult =
             await this.waitForEventToRespond(librarySearchEvent);
-          this.respondToMessage(message.id!!, librarySearchResult.data);
+          this.respondToMessage(
+            message.id!!,
+            librarySearchResult.data,
+            librarySearchEvent
+          );
           break;
         case 'game-details':
           let gameDetailsEvent = new EventResponse<StoreData | undefined>(
@@ -632,9 +657,13 @@ class OGIAddonWSListener {
               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',
+              },
+              gameDetailsEvent
+            );
             break;
           }
           this.eventEmitter.emit(
@@ -644,7 +673,11 @@ class OGIAddonWSListener {
           );
           const gameDetailsResult =
             await this.waitForEventToRespond(gameDetailsEvent);
-          this.respondToMessage(message.id!!, gameDetailsResult.data);
+          this.respondToMessage(
+            message.id!!,
+            gameDetailsResult.data,
+            gameDetailsEvent
+          );
           break;
         case 'request-dl':
           let requestDLEvent = new EventResponse<SearchResult>(
@@ -652,9 +685,13 @@ class OGIAddonWSListener {
               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',
+              },
+              requestDLEvent
+            );
             break;
           }
           this.eventEmitter.emit(
@@ -666,9 +703,7 @@ class OGIAddonWSListener {
           const requestDLResult =
             await this.waitForEventToRespond(requestDLEvent);
           if (requestDLEvent.failed) {
-            this.respondToMessage(message.id!!, {
-              statusError: requestDLEvent.failed,
-            });
+            this.respondToMessage(message.id!!, undefined, requestDLEvent);
             break;
           }
           if (
@@ -679,7 +714,11 @@ class OGIAddonWSListener {
               '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);
+          this.respondToMessage(
+            message.id!!,
+            requestDLResult.data,
+            requestDLEvent
+          );
           break;
         case 'catalog':
           let catalogEvent = new EventResponse<{
@@ -691,8 +730,30 @@ class OGIAddonWSListener {
           }>();
           this.eventEmitter.emit('catalog', catalogEvent);
           const catalogResult = await this.waitForEventToRespond(catalogEvent);
-          this.respondToMessage(message.id!!, catalogResult.data);
+          this.respondToMessage(message.id!!, catalogResult.data, catalogEvent);
           break;
+        case 'task-run': {
+          let taskRunEvent = new EventResponse<void>(
+            (screen, name, description) =>
+              this.userInputAsked(screen, name, description, this.socket)
+          );
+          this.eventEmitter.emit('task-run', message.args, taskRunEvent);
+          const interval = setInterval(() => {
+            if (taskRunEvent.resolved) {
+              clearInterval(interval);
+              return;
+            }
+            this.send('defer-update', {
+              logs: taskRunEvent.logs,
+              deferID: message.args.deferID,
+              progress: taskRunEvent.progress,
+              failed: taskRunEvent.failed,
+            } as ClientSentEventTypes['defer-update']);
+          }, 100);
+          const taskRunResult = await this.waitForEventToRespond(taskRunEvent);
+          this.respondToMessage(message.id!!, taskRunResult.data, taskRunEvent);
+          break;
+        }
       }
     });
   }
@@ -725,12 +786,17 @@ class OGIAddonWSListener {
     });
   }
 
-  public respondToMessage(messageID: string, response: any) {
+  public respondToMessage(
+    messageID: string,
+    response: any,
+    originalEvent: EventResponse<any> | undefined
+  ) {
     this.socket.send(
       JSON.stringify({
         event: 'response',
         id: messageID,
         args: response,
+        statusError: originalEvent ? originalEvent.failed : undefined,
       })
     );
     console.log('dispatched response to ' + messageID);