ogi-addon 0.2.1 → 0.3.0

package/package.json

@@ -1,50 +1,50 @@
-{
-  "name": "ogi-addon",
-  "module": "./build/main.js",
-  "type": "module",
-  "main": "./build/main.cjs",
-  "exports": {
-    ".": {
-      "import": {
-        "default": "./build/main.js",
-        "types": "./build/main.d.ts"
-      },
-      "require": {
-        "default": "./build/main.cjs",
-        "types": "./build/main.d.cts"
-      }
-    },
-    "./config": {
-      "import": {
-        "default": "./build/config/Configuration.js",
-        "types": "./build/config/Configuration.d.ts"
-      },
-      "require": {
-        "default": "./build/config/Configuration.cjs",
-        "types": "./build/config/Configuration.d.cts"
-      }
-    }
-  },
-  "typings": "./build/main.d.ts",
-  "author": {
-    "name": "Nat3z",
-    "email": "me@nat3z.com",
-    "url": "https://nat3z.com/"
-  },
-  "version": "0.2.1",
-  "dependencies": {
-    "ws": "^8.4.0",
-    "zod": "^3.23.8"
-  },
-  "scripts": {
-    "auto-build": "tsc -w",
-    "build": "tsup --config tsup.config.js",
-    "release": "bun run build && npm publish"
-  },
-  "devDependencies": {
-    "@types/node": "^20.14.12",
-    "@types/ws": "^8.4.0",
-    "tsup": "^8.2.3",
-    "typescript": "^5.0.0"
-  }
+{
+  "name": "ogi-addon",
+  "module": "./build/main.js",
+  "type": "module",
+  "main": "./build/main.cjs",
+  "exports": {
+    ".": {
+      "import": {
+        "default": "./build/main.js",
+        "types": "./build/main.d.ts"
+      },
+      "require": {
+        "default": "./build/main.cjs",
+        "types": "./build/main.d.cts"
+      }
+    },
+    "./config": {
+      "import": {
+        "default": "./build/config/Configuration.js",
+        "types": "./build/config/Configuration.d.ts"
+      },
+      "require": {
+        "default": "./build/config/Configuration.cjs",
+        "types": "./build/config/Configuration.d.cts"
+      }
+    }
+  },
+  "typings": "./build/main.d.ts",
+  "author": {
+    "name": "Nat3z",
+    "email": "me@nat3z.com",
+    "url": "https://nat3z.com/"
+  },
+  "version": "0.3.0",
+  "dependencies": {
+    "ws": "^8.4.0",
+    "zod": "^3.23.8"
+  },
+  "scripts": {
+    "auto-build": "tsc -w",
+    "build": "tsup --config tsup.config.js",
+    "release": "bun run build && npm publish"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.12",
+    "@types/ws": "^8.4.0",
+    "tsup": "^8.2.3",
+    "typescript": "^5.0.0"
+  }
 }

package/src/EventResponse.ts

@@ -1,9 +1,17 @@
+import { ConfigurationBuilder } from "./main";
+
 export default class EventResponse<T> {
   data: T | undefined = undefined;
   deffered: boolean = false;
   resolved: boolean = false;
   progress: number = 0;
   logs: string[] = [];
+  onInputAsked?: (screen: ConfigurationBuilder, name: string, description: string) => Promise<{ [key: string]: boolean | string | number }>;
+
+  constructor(onInputAsked?: (screen: ConfigurationBuilder, name: string, description: string) => Promise<{ [key: string]: boolean | string | number }>) {
+    this.onInputAsked = onInputAsked;
+  }
+  
 
   public defer() {
     this.deffered = true;
@@ -22,5 +30,12 @@ export default class EventResponse<T> {
     this.logs.push(message);
   }
 
+  public async askForInput(name: string, description: string, screen: ConfigurationBuilder) {
+    if (!this.onInputAsked) {
+      throw new Error('No input asked callback');
+    }
+    return await this.onInputAsked(screen, name, description);
+  }
+
   
 }

package/src/config/ConfigurationBuilder.ts

@@ -100,6 +100,7 @@ export class StringOption extends ConfigurationOption {
   public minTextLength: number = 0;
   public maxTextLength: number = Number.MAX_SAFE_INTEGER;
   public defaultValue: string = '';
+  public inputType: 'text' | 'file' | 'password' | 'folder' = 'text';
   public type: ConfigurationOptionType = 'string'
 
   setAllowedValues(allowedValues: string[]): this {
@@ -122,6 +123,11 @@ export class StringOption extends ConfigurationOption {
     return this;
   }
 
+  setInputType(inputType: 'text' | 'file' | 'password' | 'folder'): this {
+    this.inputType = inputType;
+    return this;
+  }
+
   override validate(input: unknown): [ boolean, string ] {
     if (typeof input !== 'string') {
       return [ false, 'Input is not a string' ];

package/src/main.ts

@@ -6,11 +6,12 @@ import EventResponse from './EventResponse';
 import { SearchResult } from './SearchEngine';
 
 export type OGIAddonEvent = 'connect' | 'disconnect' | 'configure' | 'authenticate' | 'search' | 'setup';
-export type OGIAddonClientSentEvent = 'response' | 'authenticate' | 'configure' | 'defer-update' | 'notification';
+export type OGIAddonClientSentEvent = 'response' | 'authenticate' | 'configure' | 'defer-update' | 'notification' | 'input-asked';
 
-export type OGIAddonServerSentEvent = 'authenticate' | 'configure' | 'config-update' | 'search' | 'setup';
+export type OGIAddonServerSentEvent = 'authenticate' | 'configure' | 'config-update' | 'search' | 'setup' | 'response';
 export { ConfigurationBuilder, Configuration, EventResponse, SearchResult };
 const defaultPort = 7654;
+const version = process.env.npm_package_version;
 
 export interface ClientSentEventTypes {
   response: any;
@@ -21,6 +22,7 @@ export interface ClientSentEventTypes {
     progress: number
   };
   notification: Notification;
+  'input-asked': ConfigurationBuilder;
 }
 
 export interface EventListenerTypes {
@@ -29,7 +31,7 @@ export interface EventListenerTypes {
   configure: (config: ConfigurationBuilder) => ConfigurationBuilder;
   response: (response: any) => void;
   authenticate: (config: any) => void;
-  search: (query: { type: 'steamapp' | 'query', text: string }, event: EventResponse<SearchResult[]>) => void;
+  search: (query: { type: 'steamapp', text: string }, event: EventResponse<SearchResult[]>) => void;
   setup: (
     data: { 
       path: string, 
@@ -40,7 +42,8 @@ export interface EventListenerTypes {
         name: string,
         downloadURL: string
       }[],
-    }, event: EventResponse<undefined | null>
+      steamAppID: number
+    }, event: EventResponse<LibraryInfo>
   ) => void;
 }
 
@@ -86,6 +89,16 @@ export default class OGIAddon {
     this.addonWSListener.send('notification', [ notification ]);
   }
 }
+
+export interface LibraryInfo {
+  name: string;
+  version: string;
+  cwd: string;
+  steamAppID: number;
+  launchExecutable: string;
+  launchArguments?: string;
+  capsuleImage: string;
+}
 interface Notification {
   type: 'warning' | 'error' | 'info' | 'success';
   message: string;
@@ -105,13 +118,15 @@ class OGIAddonWSListener {
     this.socket = new ws('ws://localhost:' + defaultPort);
     this.socket.on('open', () => {
       console.log('Connected to OGI Addon Server');
+      console.log('OGI Addon Server Version:', version);
 
       // Authenticate with OGI Addon Server
       this.socket.send(JSON.stringify({
         event: 'authenticate',
         args: {
           ...this.addon.addonInfo,
-          secret: process.argv[process.argv.length - 1].split('=')[1]
+          secret: process.argv[process.argv.length - 1].split('=')[1],
+          ogiVersion: version
         }
       }));
 
@@ -142,12 +157,31 @@ class OGIAddonWSListener {
       }
       this.eventEmitter.emit('disconnect', reason);
       console.log("Disconnected from OGI Addon Server")
+      console.log(reason.toString())
       this.socket.close();
     });
 
     this.registerMessageReceiver();
   }
 
+  private async userInputAsked(configBuilt: ConfigurationBuilder, name: string, description: string, socket: WebSocket): Promise<{ [key: string]: number | boolean | string }> {
+    const config = configBuilt.build(false);
+    const id = Math.random().toString(36).substring(7);
+    if (!socket) {
+      return {};
+    }
+    socket.send(JSON.stringify({
+      event: 'input-asked',
+      args: {
+        config,
+        name,
+        description
+      },
+      id: id
+    }));
+    return await this.waitForResponseFromServer(id);
+  }
+
   private registerMessageReceiver() {
     this.socket.on('message', async (data: string) => {
       const message: WebsocketMessageServer = JSON.parse(data);
@@ -162,15 +196,15 @@ class OGIAddonWSListener {
           }
           break 
         case 'search':
-          let searchResultEvent = new EventResponse<SearchResult[]>();
+          let searchResultEvent = new EventResponse<SearchResult[]>((screen, name, description) => this.userInputAsked(screen, name, description, this.socket));
           this.eventEmitter.emit('search', message.args, searchResultEvent);
           const searchResult = await this.waitForEventToRespond(searchResultEvent);         
           console.log(searchResult.data)
           this.respondToMessage(message.id!!, searchResult.data);
           break
         case 'setup':
-          let setupEvent = new EventResponse<undefined | null>();
-          this.eventEmitter.emit('setup', { path: message.args.path, type: message.args.type, name: message.args.name, usedRealDebrid: message.args.usedRealDebrid, multiPartFiles: message.args.multiPartFiles }, setupEvent);
+          let setupEvent = new EventResponse<LibraryInfo>((screen, name, description) => this.userInputAsked(screen, name, description, this.socket));
+          this.eventEmitter.emit('setup', { path: message.args.path, steamAppID: message.args.steamAppID, 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);
@@ -224,6 +258,27 @@ class OGIAddonWSListener {
     console.log("dispatched response to " + messageID)
   }
 
+  public waitForResponseFromServer<T>(messageID: string): Promise<T> {
+    return new Promise((resolve) => {
+      const waiter = (data: string) => {
+        const message: WebsocketMessageClient = JSON.parse(data);
+        if (message.event !== 'response') {
+          this.socket.once('message', waiter);
+          return;
+        }
+        console.log("received response from " + messageID)
+
+        if (message.id === messageID) {
+          resolve(message.args);
+        }
+        else {
+          this.socket.once('message', waiter);
+        }
+      }
+      this.socket.once('message', waiter);
+    });
+  }
+
   public send(event: OGIAddonClientSentEvent, args: Parameters<ClientSentEventTypes[OGIAddonClientSentEvent]>) {
     this.socket.send(JSON.stringify({
       event,