ogi-addon 1.0.0 → 1.1.0

package/build/main.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/main.ts","../src/config/ConfigurationBuilder.ts","../src/config/Configuration.ts","../src/EventResponse.ts","../package.json"],"sourcesContent":["import ws, { WebSocket } from 'ws';\r\nimport events from 'node:events';\r\nimport { ConfigurationBuilder, ConfigurationFile } from './config/ConfigurationBuilder';\r\nimport { Configuration } from './config/Configuration';\r\nimport EventResponse from './EventResponse';\r\nimport { SearchResult } from './SearchEngine';\r\n\r\nexport type OGIAddonEvent = 'connect' | 'disconnect' | 'configure' | 'authenticate' | 'search' | 'setup' | 'library-search' | 'game-details' | 'exit';\r\nexport type OGIAddonClientSentEvent = 'response' | 'authenticate' | 'configure' | 'defer-update' | 'notification' | 'input-asked';\r\n\r\nexport type OGIAddonServerSentEvent = 'authenticate' | 'configure' | 'config-update' | 'search' | 'setup' | 'response' | 'library-search' | 'game-details';\r\nexport { ConfigurationBuilder, Configuration, EventResponse, SearchResult };\r\nconst defaultPort = 7654;\r\nimport pjson from '../package.json';\r\nconst version = pjson.version;\r\n\r\nexport interface ClientSentEventTypes {\r\n  response: any;\r\n  authenticate: any;\r\n  configure: ConfigurationFile;\r\n  'defer-update': {\r\n    logs: string[], \r\n    progress: number\r\n  };\r\n  notification: Notification;\r\n  'input-asked': ConfigurationBuilder;\r\n}\r\n\r\nexport type BasicLibraryInfo = {\r\n  name: string;\r\n  capsuleImage: string;\r\n  appID: number;\r\n}\r\n\r\nexport interface EventListenerTypes {\r\n  connect: (socket: ws) => void;\r\n  disconnect: (reason: string) => void;\r\n  configure: (config: ConfigurationBuilder) => ConfigurationBuilder;\r\n  response: (response: any) => void;\r\n  authenticate: (config: any) => void;\r\n  search: (query: { type: 'steamapp' | 'internal', text: string }, event: EventResponse<SearchResult[]>) => void;\r\n  setup: (\r\n    data: { \r\n      path: string, \r\n      type: 'direct' | 'torrent' | 'magnet',\r\n      name: string,\r\n      usedRealDebrid: boolean, \r\n      multiPartFiles?: {\r\n        name: string,\r\n        downloadURL: string\r\n      }[],\r\n      appID: number,\r\n      storefront: 'steam' | 'internal'\r\n    }, event: EventResponse<LibraryInfo>\r\n  ) => void;\r\n  'library-search': (query: string, event: EventResponse<BasicLibraryInfo[]>) => void;\r\n  'game-details': (appID: number, event: EventResponse<StoreData>) => void;\r\n  exit: () => void;\r\n}\r\n\r\nexport interface StoreData {\r\n  name: string;\r\n  publishers: string[];\r\n  developers: string[];\r\n  appID: number;\r\n  releaseDate: string;\r\n  capsuleImage: string;\r\n  coverImage: string;\r\n  basicDescription: string;\r\n  description: string;\r\n  headerImage: string;\r\n}\r\nexport interface WebsocketMessageClient {\r\n  event: OGIAddonClientSentEvent;\r\n  id?: string;\r\n  args: any;\r\n}\r\nexport interface WebsocketMessageServer {\r\n  event: OGIAddonServerSentEvent;\r\n  id?: string;\r\n  args: any;\r\n}\r\nexport interface OGIAddonConfiguration {\r\n  name: string;\r\n  id: string;\r\n  description: string;\r\n  version: string;\r\n\r\n  author: string;\r\n  repository: string;\r\n}\r\nexport default class OGIAddon {\r\n  public eventEmitter = new events.EventEmitter();\r\n  public addonWSListener: OGIAddonWSListener;\r\n  public addonInfo: OGIAddonConfiguration;\r\n  public config: Configuration = new Configuration({});\r\n\r\n  constructor(addonInfo: OGIAddonConfiguration) {\r\n    this.addonInfo = addonInfo;\r\n    this.addonWSListener = new OGIAddonWSListener(this, this.eventEmitter);\r\n  }\r\n  \r\n  public on<T extends OGIAddonEvent>(event: T, listener: EventListenerTypes[T]) {\r\n    this.eventEmitter.on(event, listener);\r\n  }\r\n\r\n  public emit<T extends OGIAddonEvent>(event: T, ...args: Parameters<EventListenerTypes[T]>) {\r\n    this.eventEmitter.emit(event, ...args);\r\n  }\r\n\r\n  public notify(notification: Notification) {\r\n    this.addonWSListener.send('notification', [ notification ]);\r\n  }\r\n}\r\n\r\nexport interface LibraryInfo {\r\n  name: string;\r\n  version: string;\r\n  cwd: string;\r\n  appID: number;\r\n  launchExecutable: string;\r\n  launchArguments?: string;\r\n  capsuleImage: string;\r\n  storefront: 'steam' | 'internal';\r\n  addonsource: string;\r\n  coverImage: string;\r\n  titleImage?: string;\r\n}\r\ninterface Notification {\r\n  type: 'warning' | 'error' | 'info' | 'success';\r\n  message: string;\r\n  id: string\r\n}\r\nclass OGIAddonWSListener {\r\n  private socket: WebSocket;\r\n  public eventEmitter: events.EventEmitter;\r\n  public addon: OGIAddon;\r\n\r\n  constructor(ogiAddon: OGIAddon, eventEmitter: events.EventEmitter) {\r\n    if (process.argv[process.argv.length - 1].split('=')[0] !== '--addonSecret') {\r\n      throw new Error('No secret provided. This usually happens because the addon was not started by the OGI Addon Server.');\r\n    }\r\n    this.addon = ogiAddon;\r\n    this.eventEmitter = eventEmitter;\r\n    this.socket = new ws('ws://localhost:' + defaultPort);\r\n    this.socket.on('open', () => {\r\n      console.log('Connected to OGI Addon Server');\r\n      console.log('OGI Addon Server Version:', version);\r\n\r\n      // Authenticate with OGI Addon Server\r\n      this.socket.send(JSON.stringify({\r\n        event: 'authenticate',\r\n        args: {\r\n          ...this.addon.addonInfo,\r\n          secret: process.argv[process.argv.length - 1].split('=')[1],\r\n          ogiVersion: version\r\n        }\r\n      }));\r\n\r\n      this.eventEmitter.emit('connect');\r\n\r\n      // send a configuration request\r\n      let configBuilder = new ConfigurationBuilder();\r\n      this.eventEmitter.emit('configure', configBuilder);\r\n     \r\n      this.socket.send(JSON.stringify({\r\n        event: 'configure',\r\n        args: configBuilder.build(false) \r\n      }));\r\n      this.addon.config = new Configuration(configBuilder.build(true));\r\n    });\r\n\r\n    this.socket.on('error', (error) => {\r\n      if (error.message.includes('Failed to connect')) {\r\n        throw new Error('OGI Addon Server is not running/is unreachable. Please start the server and try again.');\r\n      }\r\n      console.error('An error occurred:', error);\r\n    })\r\n\r\n    this.socket.on('close', (code, reason) => {\r\n      if (code === 1008) {\r\n        console.error('Authentication failed:', reason);\r\n        return;\r\n      }\r\n      this.eventEmitter.emit('disconnect', reason);\r\n      console.log(\"Disconnected from OGI Addon Server\")\r\n      console.error(reason.toString())\r\n      this.eventEmitter.emit('exit');\r\n      this.socket.close();\r\n    });\r\n\r\n    this.registerMessageReceiver();\r\n  }\r\n\r\n  private async userInputAsked(configBuilt: ConfigurationBuilder, name: string, description: string, socket: WebSocket): Promise<{ [key: string]: number | boolean | string }> {\r\n    const config = configBuilt.build(false);\r\n    const id = Math.random().toString(36).substring(7);\r\n    if (!socket) {\r\n      return {};\r\n    }\r\n    socket.send(JSON.stringify({\r\n      event: 'input-asked',\r\n      args: {\r\n        config,\r\n        name,\r\n        description\r\n      },\r\n      id: id\r\n    }));\r\n    return await this.waitForResponseFromServer(id);\r\n  }\r\n\r\n  private registerMessageReceiver() {\r\n    this.socket.on('message', async (data: string) => {\r\n      const message: WebsocketMessageServer = JSON.parse(data);\r\n      switch (message.event) {\r\n        case 'config-update':\r\n          const result = this.addon.config.updateConfig(message.args);\r\n          if (!result[0]) {\r\n            this.respondToMessage(message.id!!, { success: false, error: result[1] });\r\n          }\r\n          else {\r\n            this.respondToMessage(message.id!!, { success: true });\r\n          }\r\n          break \r\n        case 'search':\r\n          let searchResultEvent = new EventResponse<SearchResult[]>((screen, name, description) => this.userInputAsked(screen, name, description, this.socket));\r\n          this.eventEmitter.emit('search', message.args, searchResultEvent);\r\n          const searchResult = await this.waitForEventToRespond(searchResultEvent);         \r\n          this.respondToMessage(message.id!!, searchResult.data);\r\n          break\r\n        case 'setup':\r\n          let setupEvent = new EventResponse<LibraryInfo>((screen, name, description) => this.userInputAsked(screen, name, description, this.socket));\r\n          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);\r\n          const interval = setInterval(() => {\r\n            if (setupEvent.resolved) {\r\n              clearInterval(interval);\r\n              return;\r\n            }\r\n            this.send('defer-update', { \r\n              logs: setupEvent.logs,\r\n              deferID: message.args.deferID,\r\n              progress: setupEvent.progress\r\n            } as any);\r\n          }, 100);\r\n          const setupResult = await this.waitForEventToRespond(setupEvent);\r\n          this.respondToMessage(message.id!!, setupResult.data);\r\n          break\r\n        case 'library-search':\r\n          let librarySearchEvent = new EventResponse<BasicLibraryInfo[]>((screen, name, description) => this.userInputAsked(screen, name, description, this.socket));\r\n          if (this.eventEmitter.listenerCount('game-details') === 0) {\r\n            this.respondToMessage(message.id!!, []);\r\n            break;\r\n          }\r\n          this.eventEmitter.emit('library-search', message.args, librarySearchEvent);\r\n          const librarySearchResult = await this.waitForEventToRespond(librarySearchEvent);\r\n          this.respondToMessage(message.id!!, librarySearchResult.data);\r\n          break\r\n        case 'game-details':\r\n          let gameDetailsEvent = new EventResponse<StoreData>((screen, name, description) => this.userInputAsked(screen, name, description, this.socket));\r\n          if (this.eventEmitter.listenerCount('game-details') === 0) {\r\n            this.respondToMessage(message.id!!, { error: 'No event listener for game-details' });\r\n            break;\r\n          }\r\n          this.eventEmitter.emit('game-details', message.args, gameDetailsEvent);\r\n          const gameDetailsResult = await this.waitForEventToRespond(gameDetailsEvent);\r\n          this.respondToMessage(message.id!!, gameDetailsResult.data);\r\n          break\r\n      }\r\n    });\r\n  }\r\n\r\n  private waitForEventToRespond<T>(event: EventResponse<T>): Promise<EventResponse<T>> {\r\n    // check the handlers to see if there even is any\r\n    return new Promise((resolve, reject) => {\r\n      const dataGet = setInterval(() => {\r\n        if (event.resolved) {\r\n          resolve(event);\r\n          clearTimeout(timeout);\r\n        }\r\n      }, 5);      \r\n\r\n      const timeout = setTimeout(() => {\r\n        if (event.deffered) {\r\n          clearInterval(dataGet);\r\n          const interval = setInterval(() => {\r\n            if (event.resolved) {\r\n              clearInterval(interval);\r\n              resolve(event);\r\n            }\r\n          }, 100);\r\n        }\r\n        else {\r\n          reject('Event did not respond in time');\r\n        }\r\n      }, 5000)\r\n    });\r\n  }\r\n\r\n  public respondToMessage(messageID: string, response: any) {\r\n    this.socket.send(JSON.stringify({\r\n      event: 'response',\r\n      id: messageID,\r\n      args: response\r\n    }));\r\n    console.log(\"dispatched response to \" + messageID)\r\n  }\r\n\r\n  public waitForResponseFromServer<T>(messageID: string): Promise<T> {\r\n    return new Promise((resolve) => {\r\n      const waiter = (data: string) => {\r\n        const message: WebsocketMessageClient = JSON.parse(data);\r\n        if (message.event !== 'response') {\r\n          this.socket.once('message', waiter);\r\n          return;\r\n        }\r\n        console.log(\"received response from \" + messageID)\r\n\r\n        if (message.id === messageID) {\r\n          resolve(message.args);\r\n        }\r\n        else {\r\n          this.socket.once('message', waiter);\r\n        }\r\n      }\r\n      this.socket.once('message', waiter);\r\n    });\r\n  }\r\n\r\n  public send(event: OGIAddonClientSentEvent, args: Parameters<ClientSentEventTypes[OGIAddonClientSentEvent]>) {\r\n    this.socket.send(JSON.stringify({\r\n      event,\r\n      args\r\n    }));\r\n  }\r\n\r\n  public close() {\r\n    this.socket.close();\r\n  }\r\n\r\n  \r\n}","import z, { ZodError } from \"zod\"\r\n\r\nexport interface ConfigurationFile {\r\n  [key: string]: ConfigurationOption\r\n}\r\n\r\nconst configValidation = z.object({\r\n  name: z.string().min(1),\r\n  displayName: z.string().min(1),\r\n  description: z.string().min(1),\r\n})\r\n\r\nexport function isStringOption(option: ConfigurationOption): option is StringOption {\r\n    return option.type === 'string';\r\n  }\r\n\r\nexport function isNumberOption(option: ConfigurationOption): option is NumberOption {\r\n  return option.type === 'number';\r\n}\r\n\r\nexport function isBooleanOption(option: ConfigurationOption): option is BooleanOption {\r\n  return option.type === 'boolean';\r\n}\r\n\r\nexport class ConfigurationBuilder {\r\n  private options: ConfigurationOption[] = [];\r\n  public addNumberOption(option: (option: NumberOption) => NumberOption): ConfigurationBuilder {\r\n    let newOption = new NumberOption();\r\n    newOption = option(newOption);\r\n    this.options.push(newOption);\r\n    return this;\r\n  }\r\n\r\n  public addStringOption(option: (option: StringOption) => StringOption) {\r\n    let newOption = new StringOption();\r\n    newOption = option(newOption);\r\n    this.options.push(newOption);\r\n    return this;\r\n  }\r\n\r\n  public addBooleanOption(option: (option: BooleanOption) => BooleanOption) {\r\n    let newOption = new BooleanOption();\r\n    newOption = option(newOption);\r\n    this.options.push(newOption);\r\n    return this;\r\n  }\r\n\r\n  public build(includeFunctions: boolean): ConfigurationFile {\r\n    let config: ConfigurationFile = {};\r\n    this.options.forEach(option => {\r\n      // remove all functions from the option object\r\n      if (!includeFunctions) {\r\n        option = JSON.parse(JSON.stringify(option));\r\n        const optionData = configValidation.safeParse(option)\r\n        if (!optionData.success) {\r\n          throw new ZodError(optionData.error.errors)\r\n        }\r\n\r\n        config[option.name] = option;\r\n      }\r\n      else {\r\n        config[option.name] = option;\r\n      }\r\n    });\r\n    return config;\r\n  }\r\n}\r\n\r\nexport type ConfigurationOptionType = 'string' | 'number' | 'boolean' | 'unset'\r\nexport class ConfigurationOption {\r\n  public name: string = '';\r\n  public defaultValue: unknown = '';\r\n  public displayName: string = '';\r\n  public description: string = '';\r\n  public type: ConfigurationOptionType = 'unset'\r\n  \r\n  setName(name: string) {\r\n    this.name = name;\r\n    return this;\r\n  }\r\n\r\n  setDisplayName(displayName: string) {\r\n    this.displayName = displayName;\r\n    return this;\r\n  }\r\n\r\n  setDescription(description: string) {\r\n    this.description = description;\r\n    return this;\r\n  }\r\n\r\n\r\n  validate(input: unknown): [ boolean, string ] {\r\n    throw new Error('Validation code not implemented. Value: ' + input)\r\n  };\r\n}\r\n\r\nexport class StringOption extends ConfigurationOption {\r\n  public allowedValues: string[] = [];\r\n  public minTextLength: number = 0;\r\n  public maxTextLength: number = Number.MAX_SAFE_INTEGER;\r\n  public defaultValue: string = '';\r\n  public inputType: 'text' | 'file' | 'password' | 'folder' = 'text';\r\n  public type: ConfigurationOptionType = 'string'\r\n\r\n  setAllowedValues(allowedValues: string[]): this {\r\n    this.allowedValues = allowedValues;\r\n    return this;\r\n  }\r\n\r\n  setDefaultValue(defaultValue: string): this {\r\n    this.defaultValue = defaultValue;\r\n    return this;\r\n  }\r\n\r\n  setMinTextLength(minTextLength: number): this {\r\n    this.minTextLength = minTextLength;\r\n    return this;\r\n  }\r\n\r\n  setMaxTextLength(maxTextLength: number): this {\r\n    this.maxTextLength = maxTextLength;\r\n    return this;\r\n  }\r\n\r\n  setInputType(inputType: 'text' | 'file' | 'password' | 'folder'): this {\r\n    this.inputType = inputType;\r\n    return this;\r\n  }\r\n\r\n  override validate(input: unknown): [ boolean, string ] {\r\n    if (typeof input !== 'string') {\r\n      return [ false, 'Input is not a string' ];\r\n    }\r\n    if (this.allowedValues.length === 0 && input.length !== 0)\r\n      return [ true, '' ];\r\n    if (input.length < this.minTextLength || input.length > this.maxTextLength) {\r\n      return [ false, 'Input is not within the text length ' + this.minTextLength + ' and ' + this.maxTextLength + ' characters (currently ' + input.length + ' characters)' ];\r\n    }\r\n\r\n    return [ this.allowedValues.includes(input), 'Input is not an allowed value' ];\r\n  }\r\n}\r\n\r\nexport class NumberOption extends ConfigurationOption {\r\n  public min: number = 0;\r\n  public max: number = Number.MAX_SAFE_INTEGER;\r\n  public defaultValue: number = 0;\r\n  public type: ConfigurationOptionType = 'number'\r\n  public inputType: 'range' | 'number' = 'number';\r\n  setMin(min: number): this {\r\n    this.min = min;\r\n    return this;\r\n  }\r\n\r\n  setInputType(type: 'range' | 'number'): this {\r\n    this.inputType = type;\r\n    return this;\r\n  }\r\n\r\n  setMax(max: number): this {\r\n    this.max = max;\r\n    return this\r\n  }\r\n\r\n  setDefaultValue(defaultValue: number): this {\r\n    this.defaultValue = defaultValue;\r\n    return this;\r\n  }\r\n\r\n  override validate(input: unknown): [ boolean, string ] {\r\n    if (isNaN(Number(input))) {\r\n      return [ false, 'Input is not a number' ];\r\n    }\r\n    if (Number(input) < this.min || Number(input) > this.max) {\r\n      return [ false, 'Input is not within the range of ' + this.min + ' and ' + this.max ];\r\n    }\r\n    return [ true, '' ];\r\n  }\r\n\r\n}\r\n\r\nexport class BooleanOption extends ConfigurationOption {\r\n  public type: ConfigurationOptionType = 'boolean'\r\n  public defaultValue: boolean = false;\r\n\r\n  setDefaultValue(defaultValue: boolean): this {\r\n    this.defaultValue = defaultValue;\r\n    return this;\r\n  }\r\n\r\n  override validate(input: unknown): [ boolean, string ] {\r\n    if (typeof input !== 'boolean') {\r\n      return [ false, 'Input is not a boolean' ];\r\n    }\r\n    return [ true, '' ];\r\n  }\r\n\r\n}","import { ConfigurationFile, ConfigurationBuilder, BooleanOption, ConfigurationOption, ConfigurationOptionType, NumberOption, StringOption, isBooleanOption, isNumberOption, isStringOption } from \"./ConfigurationBuilder\";\r\n\r\ninterface DefiniteConfig {\r\n  [key: string]: string | number | boolean;\r\n}\r\nexport class Configuration {\r\n  readonly storedConfigTemplate: ConfigurationFile;\r\n  definiteConfig: DefiniteConfig = {};\r\n  constructor(configTemplate: ConfigurationFile) {\r\n    this.storedConfigTemplate = configTemplate;\r\n  }\r\n\r\n  updateConfig(config: DefiniteConfig, validate: boolean = true): [ boolean, { [key: string]: string } ] {\r\n    this.definiteConfig = config;\r\n    if (validate) {\r\n      const result = this.validateConfig();\r\n      return result;\r\n    }\r\n    return [ true, {} ];\r\n  }\r\n  // provides falsey or truthy value, and an error message if falsey\r\n  private validateConfig(): [ boolean, { [key: string]: string } ] {\r\n    const erroredKeys = new Map<string, string>();\r\n    for (const key in this.storedConfigTemplate) {\r\n      if (this.definiteConfig[key] === null || this.definiteConfig[key] === undefined) {\r\n        console.warn('Option ' + key + ' is not defined. Using default value Value: ' + this.definiteConfig[key]);\r\n        this.definiteConfig[key] = this.storedConfigTemplate[key].defaultValue as string | number | boolean;\r\n      }\r\n      if (this.storedConfigTemplate[key].type !== typeof this.definiteConfig[key]) {\r\n        throw new Error('Option ' + key + ' is not of the correct type');\r\n      }\r\n\r\n      const result = this.storedConfigTemplate[key].validate(this.definiteConfig[key]);\r\n      if (!result[0]) {\r\n        erroredKeys.set(key, result[1]);\r\n      }\r\n    }\r\n\r\n    for (const key in this.definiteConfig) {\r\n      if (!this.storedConfigTemplate[key]) {\r\n        throw new Error('Option ' + key + ' is not defined in the configuration template');\r\n      }\r\n    }\r\n\r\n    if (erroredKeys.size > 0) {\r\n      return [ false, Object.fromEntries(erroredKeys) ];\r\n    }\r\n\r\n    return [ true, Object.fromEntries(erroredKeys) ];\r\n  }\r\n\r\n  getStringValue(optionName: string): string {\r\n    if (!this.definiteConfig[optionName] === null) {\r\n      throw new Error('Option ' + optionName + ' is not defined');\r\n    }\r\n    if (typeof this.definiteConfig[optionName] !== 'string') {\r\n      throw new Error('Option ' + optionName + ' is not a string');\r\n    }\r\n    return this.definiteConfig[optionName];\r\n  }\r\n\r\n  getNumberValue(optionName: string): number {\r\n    if (!this.definiteConfig[optionName] === null) {\r\n      throw new Error('Option ' + optionName + ' is not defined');\r\n    }\r\n    if (typeof this.definiteConfig[optionName] !== 'number') {\r\n      throw new Error('Option ' + optionName + ' is not a number');\r\n    }\r\n    return this.definiteConfig[optionName];\r\n  }\r\n\r\n  getBooleanValue(optionName: string): boolean {\r\n    if (this.definiteConfig[optionName] === null) {\r\n      throw new Error('Option ' + optionName + ' is not defined');\r\n    }\r\n    if (typeof this.definiteConfig[optionName] !== 'boolean') {\r\n      throw new Error('Option ' + optionName + ' is not a boolean');\r\n    }\r\n    return this.definiteConfig[optionName];\r\n  }\r\n}\r\n\r\nexport { ConfigurationFile, ConfigurationBuilder, BooleanOption, ConfigurationOption, ConfigurationOptionType, NumberOption, StringOption, isBooleanOption, isNumberOption, isStringOption };","import { ConfigurationBuilder } from \"./main\";\r\n\r\nexport default class EventResponse<T> {\r\n  data: T | undefined = undefined;\r\n  deffered: boolean = false;\r\n  resolved: boolean = false;\r\n  progress: number = 0;\r\n  logs: string[] = [];\r\n  onInputAsked?: (screen: ConfigurationBuilder, name: string, description: string) => Promise<{ [key: string]: boolean | string | number }>;\r\n\r\n  constructor(onInputAsked?: (screen: ConfigurationBuilder, name: string, description: string) => Promise<{ [key: string]: boolean | string | number }>) {\r\n    this.onInputAsked = onInputAsked;\r\n  }\r\n  \r\n\r\n  public defer() {\r\n    this.deffered = true;\r\n  }\r\n\r\n  public resolve(data: T) {\r\n    this.resolved = true;\r\n    this.data = data;\r\n  }\r\n\r\n  public complete() {\r\n    this.resolved = true;\r\n  }\r\n\r\n  public log(message: string) {\r\n    this.logs.push(message);\r\n  }\r\n\r\n  public async askForInput(name: string, description: string, screen: ConfigurationBuilder) {\r\n    if (!this.onInputAsked) {\r\n      throw new Error('No input asked callback');\r\n    }\r\n    return await this.onInputAsked(screen, name, description);\r\n  }\r\n\r\n  \r\n}","{\r\n  \"name\": \"ogi-addon\",\r\n  \"module\": \"./build/main.js\",\r\n  \"type\": \"module\",\r\n  \"main\": \"./build/main.cjs\",\r\n  \"exports\": {\r\n    \".\": {\r\n      \"import\": {\r\n        \"default\": \"./build/main.js\",\r\n        \"types\": \"./build/main.d.ts\"\r\n      },\r\n      \"require\": {\r\n        \"default\": \"./build/main.cjs\",\r\n        \"types\": \"./build/main.d.cts\"\r\n      }\r\n    },\r\n    \"./config\": {\r\n      \"import\": {\r\n        \"default\": \"./build/config/Configuration.js\",\r\n        \"types\": \"./build/config/Configuration.d.ts\"\r\n      },\r\n      \"require\": {\r\n        \"default\": \"./build/config/Configuration.cjs\",\r\n        \"types\": \"./build/config/Configuration.d.cts\"\r\n      }\r\n    }\r\n  },\r\n  \"typings\": \"./build/main.d.ts\",\r\n  \"author\": {\r\n    \"name\": \"Nat3z\",\r\n    \"email\": \"me@nat3z.com\",\r\n    \"url\": \"https://nat3z.com/\"\r\n  },\r\n  \"version\": \"1.0.0\",\r\n  \"dependencies\": {\r\n    \"ws\": \"^8.4.0\",\r\n    \"zod\": \"^3.23.8\"\r\n  },\r\n  \"scripts\": {\r\n    \"auto-build\": \"tsc -w\",\r\n    \"build\": \"tsup --config tsup.config.js\",\r\n    \"release\": \"bun run build && npm publish\"\r\n  },\r\n  \"devDependencies\": {\r\n    \"@types/node\": \"^20.14.12\",\r\n    \"@types/ws\": \"^8.4.0\",\r\n    \"tsup\": \"^8.2.3\",\r\n    \"typescript\": \"^5.0.0\"\r\n  }\r\n}"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,gBAA8B;AAC9B,yBAAmB;;;ACDnB,iBAA4B;AAM5B,IAAM,mBAAmB,WAAAA,QAAE,OAAO;AAAA,EAChC,MAAM,WAAAA,QAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EACtB,aAAa,WAAAA,QAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EAC7B,aAAa,WAAAA,QAAE,OAAO,EAAE,IAAI,CAAC;AAC/B,CAAC;AAcM,IAAM,uBAAN,MAA2B;AAAA,EACxB,UAAiC,CAAC;AAAA,EACnC,gBAAgB,QAAsE;AAC3F,QAAI,YAAY,IAAI,aAAa;AACjC,gBAAY,OAAO,SAAS;AAC5B,SAAK,QAAQ,KAAK,SAAS;AAC3B,WAAO;AAAA,EACT;AAAA,EAEO,gBAAgB,QAAgD;AACrE,QAAI,YAAY,IAAI,aAAa;AACjC,gBAAY,OAAO,SAAS;AAC5B,SAAK,QAAQ,KAAK,SAAS;AAC3B,WAAO;AAAA,EACT;AAAA,EAEO,iBAAiB,QAAkD;AACxE,QAAI,YAAY,IAAI,cAAc;AAClC,gBAAY,OAAO,SAAS;AAC5B,SAAK,QAAQ,KAAK,SAAS;AAC3B,WAAO;AAAA,EACT;AAAA,EAEO,MAAM,kBAA8C;AACzD,QAAI,SAA4B,CAAC;AACjC,SAAK,QAAQ,QAAQ,YAAU;AAE7B,UAAI,CAAC,kBAAkB;AACrB,iBAAS,KAAK,MAAM,KAAK,UAAU,MAAM,CAAC;AAC1C,cAAM,aAAa,iBAAiB,UAAU,MAAM;AACpD,YAAI,CAAC,WAAW,SAAS;AACvB,gBAAM,IAAI,oBAAS,WAAW,MAAM,MAAM;AAAA,QAC5C;AAEA,eAAO,OAAO,IAAI,IAAI;AAAA,MACxB,OACK;AACH,eAAO,OAAO,IAAI,IAAI;AAAA,MACxB;AAAA,IACF,CAAC;AACD,WAAO;AAAA,EACT;AACF;AAGO,IAAM,sBAAN,MAA0B;AAAA,EACxB,OAAe;AAAA,EACf,eAAwB;AAAA,EACxB,cAAsB;AAAA,EACtB,cAAsB;AAAA,EACtB,OAAgC;AAAA,EAEvC,QAAQ,MAAc;AACpB,SAAK,OAAO;AACZ,WAAO;AAAA,EACT;AAAA,EAEA,eAAe,aAAqB;AAClC,SAAK,cAAc;AACnB,WAAO;AAAA,EACT;AAAA,EAEA,eAAe,aAAqB;AAClC,SAAK,cAAc;AACnB,WAAO;AAAA,EACT;AAAA,EAGA,SAAS,OAAqC;AAC5C,UAAM,IAAI,MAAM,6CAA6C,KAAK;AAAA,EACpE;AACF;AAEO,IAAM,eAAN,cAA2B,oBAAoB;AAAA,EAC7C,gBAA0B,CAAC;AAAA,EAC3B,gBAAwB;AAAA,EACxB,gBAAwB,OAAO;AAAA,EAC/B,eAAuB;AAAA,EACvB,YAAqD;AAAA,EACrD,OAAgC;AAAA,EAEvC,iBAAiB,eAA+B;AAC9C,SAAK,gBAAgB;AACrB,WAAO;AAAA,EACT;AAAA,EAEA,gBAAgB,cAA4B;AAC1C,SAAK,eAAe;AACpB,WAAO;AAAA,EACT;AAAA,EAEA,iBAAiB,eAA6B;AAC5C,SAAK,gBAAgB;AACrB,WAAO;AAAA,EACT;AAAA,EAEA,iBAAiB,eAA6B;AAC5C,SAAK,gBAAgB;AACrB,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,WAA0D;AACrE,SAAK,YAAY;AACjB,WAAO;AAAA,EACT;AAAA,EAES,SAAS,OAAqC;AACrD,QAAI,OAAO,UAAU,UAAU;AAC7B,aAAO,CAAE,OAAO,uBAAwB;AAAA,IAC1C;AACA,QAAI,KAAK,cAAc,WAAW,KAAK,MAAM,WAAW;AACtD,aAAO,CAAE,MAAM,EAAG;AACpB,QAAI,MAAM,SAAS,KAAK,iBAAiB,MAAM,SAAS,KAAK,eAAe;AAC1E,aAAO,CAAE,OAAO,yCAAyC,KAAK,gBAAgB,UAAU,KAAK,gBAAgB,4BAA4B,MAAM,SAAS,cAAe;AAAA,IACzK;AAEA,WAAO,CAAE,KAAK,cAAc,SAAS,KAAK,GAAG,+BAAgC;AAAA,EAC/E;AACF;AAEO,IAAM,eAAN,cAA2B,oBAAoB;AAAA,EAC7C,MAAc;AAAA,EACd,MAAc,OAAO;AAAA,EACrB,eAAuB;AAAA,EACvB,OAAgC;AAAA,EAChC,YAAgC;AAAA,EACvC,OAAO,KAAmB;AACxB,SAAK,MAAM;AACX,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,MAAgC;AAC3C,SAAK,YAAY;AACjB,WAAO;AAAA,EACT;AAAA,EAEA,OAAO,KAAmB;AACxB,SAAK,MAAM;AACX,WAAO;AAAA,EACT;AAAA,EAEA,gBAAgB,cAA4B;AAC1C,SAAK,eAAe;AACpB,WAAO;AAAA,EACT;AAAA,EAES,SAAS,OAAqC;AACrD,QAAI,MAAM,OAAO,KAAK,CAAC,GAAG;AACxB,aAAO,CAAE,OAAO,uBAAwB;AAAA,IAC1C;AACA,QAAI,OAAO,KAAK,IAAI,KAAK,OAAO,OAAO,KAAK,IAAI,KAAK,KAAK;AACxD,aAAO,CAAE,OAAO,sCAAsC,KAAK,MAAM,UAAU,KAAK,GAAI;AAAA,IACtF;AACA,WAAO,CAAE,MAAM,EAAG;AAAA,EACpB;AAEF;AAEO,IAAM,gBAAN,cAA4B,oBAAoB;AAAA,EAC9C,OAAgC;AAAA,EAChC,eAAwB;AAAA,EAE/B,gBAAgB,cAA6B;AAC3C,SAAK,eAAe;AACpB,WAAO;AAAA,EACT;AAAA,EAES,SAAS,OAAqC;AACrD,QAAI,OAAO,UAAU,WAAW;AAC9B,aAAO,CAAE,OAAO,wBAAyB;AAAA,IAC3C;AACA,WAAO,CAAE,MAAM,EAAG;AAAA,EACpB;AAEF;;;ACjMO,IAAM,gBAAN,MAAoB;AAAA,EAChB;AAAA,EACT,iBAAiC,CAAC;AAAA,EAClC,YAAY,gBAAmC;AAC7C,SAAK,uBAAuB;AAAA,EAC9B;AAAA,EAEA,aAAa,QAAwB,WAAoB,MAA8C;AACrG,SAAK,iBAAiB;AACtB,QAAI,UAAU;AACZ,YAAM,SAAS,KAAK,eAAe;AACnC,aAAO;AAAA,IACT;AACA,WAAO,CAAE,MAAM,CAAC,CAAE;AAAA,EACpB;AAAA;AAAA,EAEQ,iBAAyD;AAC/D,UAAM,cAAc,oBAAI,IAAoB;AAC5C,eAAW,OAAO,KAAK,sBAAsB;AAC3C,UAAI,KAAK,eAAe,GAAG,MAAM,QAAQ,KAAK,eAAe,GAAG,MAAM,QAAW;AAC/E,gBAAQ,KAAK,YAAY,MAAM,iDAAiD,KAAK,eAAe,GAAG,CAAC;AACxG,aAAK,eAAe,GAAG,IAAI,KAAK,qBAAqB,GAAG,EAAE;AAAA,MAC5D;AACA,UAAI,KAAK,qBAAqB,GAAG,EAAE,SAAS,OAAO,KAAK,eAAe,GAAG,GAAG;AAC3E,cAAM,IAAI,MAAM,YAAY,MAAM,6BAA6B;AAAA,MACjE;AAEA,YAAM,SAAS,KAAK,qBAAqB,GAAG,EAAE,SAAS,KAAK,eAAe,GAAG,CAAC;AAC/E,UAAI,CAAC,OAAO,CAAC,GAAG;AACd,oBAAY,IAAI,KAAK,OAAO,CAAC,CAAC;AAAA,MAChC;AAAA,IACF;AAEA,eAAW,OAAO,KAAK,gBAAgB;AACrC,UAAI,CAAC,KAAK,qBAAqB,GAAG,GAAG;AACnC,cAAM,IAAI,MAAM,YAAY,MAAM,+CAA+C;AAAA,MACnF;AAAA,IACF;AAEA,QAAI,YAAY,OAAO,GAAG;AACxB,aAAO,CAAE,OAAO,OAAO,YAAY,WAAW,CAAE;AAAA,IAClD;AAEA,WAAO,CAAE,MAAM,OAAO,YAAY,WAAW,CAAE;AAAA,EACjD;AAAA,EAEA,eAAe,YAA4B;AACzC,QAAI,CAAC,KAAK,eAAe,UAAU,MAAM,MAAM;AAC7C,YAAM,IAAI,MAAM,YAAY,aAAa,iBAAiB;AAAA,IAC5D;AACA,QAAI,OAAO,KAAK,eAAe,UAAU,MAAM,UAAU;AACvD,YAAM,IAAI,MAAM,YAAY,aAAa,kBAAkB;AAAA,IAC7D;AACA,WAAO,KAAK,eAAe,UAAU;AAAA,EACvC;AAAA,EAEA,eAAe,YAA4B;AACzC,QAAI,CAAC,KAAK,eAAe,UAAU,MAAM,MAAM;AAC7C,YAAM,IAAI,MAAM,YAAY,aAAa,iBAAiB;AAAA,IAC5D;AACA,QAAI,OAAO,KAAK,eAAe,UAAU,MAAM,UAAU;AACvD,YAAM,IAAI,MAAM,YAAY,aAAa,kBAAkB;AAAA,IAC7D;AACA,WAAO,KAAK,eAAe,UAAU;AAAA,EACvC;AAAA,EAEA,gBAAgB,YAA6B;AAC3C,QAAI,KAAK,eAAe,UAAU,MAAM,MAAM;AAC5C,YAAM,IAAI,MAAM,YAAY,aAAa,iBAAiB;AAAA,IAC5D;AACA,QAAI,OAAO,KAAK,eAAe,UAAU,MAAM,WAAW;AACxD,YAAM,IAAI,MAAM,YAAY,aAAa,mBAAmB;AAAA,IAC9D;AACA,WAAO,KAAK,eAAe,UAAU;AAAA,EACvC;AACF;;;AC9EA,IAAqB,gBAArB,MAAsC;AAAA,EACpC,OAAsB;AAAA,EACtB,WAAoB;AAAA,EACpB,WAAoB;AAAA,EACpB,WAAmB;AAAA,EACnB,OAAiB,CAAC;AAAA,EAClB;AAAA,EAEA,YAAY,cAA2I;AACrJ,SAAK,eAAe;AAAA,EACtB;AAAA,EAGO,QAAQ;AACb,SAAK,WAAW;AAAA,EAClB;AAAA,EAEO,QAAQ,MAAS;AACtB,SAAK,WAAW;AAChB,SAAK,OAAO;AAAA,EACd;AAAA,EAEO,WAAW;AAChB,SAAK,WAAW;AAAA,EAClB;AAAA,EAEO,IAAI,SAAiB;AAC1B,SAAK,KAAK,KAAK,OAAO;AAAA,EACxB;AAAA,EAEA,MAAa,YAAY,MAAc,aAAqB,QAA8B;AACxF,QAAI,CAAC,KAAK,cAAc;AACtB,YAAM,IAAI,MAAM,yBAAyB;AAAA,IAC3C;AACA,WAAO,MAAM,KAAK,aAAa,QAAQ,MAAM,WAAW;AAAA,EAC1D;AAGF;;;ACxCA;AAAA,EACE,MAAQ;AAAA,EACR,QAAU;AAAA,EACV,MAAQ;AAAA,EACR,MAAQ;AAAA,EACR,SAAW;AAAA,IACT,KAAK;AAAA,MACH,QAAU;AAAA,QACR,SAAW;AAAA,QACX,OAAS;AAAA,MACX;AAAA,MACA,SAAW;AAAA,QACT,SAAW;AAAA,QACX,OAAS;AAAA,MACX;AAAA,IACF;AAAA,IACA,YAAY;AAAA,MACV,QAAU;AAAA,QACR,SAAW;AAAA,QACX,OAAS;AAAA,MACX;AAAA,MACA,SAAW;AAAA,QACT,SAAW;AAAA,QACX,OAAS;AAAA,MACX;AAAA,IACF;AAAA,EACF;AAAA,EACA,SAAW;AAAA,EACX,QAAU;AAAA,IACR,MAAQ;AAAA,IACR,OAAS;AAAA,IACT,KAAO;AAAA,EACT;AAAA,EACA,SAAW;AAAA,EACX,cAAgB;AAAA,IACd,IAAM;AAAA,IACN,KAAO;AAAA,EACT;AAAA,EACA,SAAW;AAAA,IACT,cAAc;AAAA,IACd,OAAS;AAAA,IACT,SAAW;AAAA,EACb;AAAA,EACA,iBAAmB;AAAA,IACjB,eAAe;AAAA,IACf,aAAa;AAAA,IACb,MAAQ;AAAA,IACR,YAAc;AAAA,EAChB;AACF;;;AJrCA,IAAM,cAAc;AAEpB,IAAM,UAAU,gBAAM;AA6EtB,IAAqB,WAArB,MAA8B;AAAA,EACrB,eAAe,IAAI,mBAAAC,QAAO,aAAa;AAAA,EACvC;AAAA,EACA;AAAA,EACA,SAAwB,IAAI,cAAc,CAAC,CAAC;AAAA,EAEnD,YAAY,WAAkC;AAC5C,SAAK,YAAY;AACjB,SAAK,kBAAkB,IAAI,mBAAmB,MAAM,KAAK,YAAY;AAAA,EACvE;AAAA,EAEO,GAA4B,OAAU,UAAiC;AAC5E,SAAK,aAAa,GAAG,OAAO,QAAQ;AAAA,EACtC;AAAA,EAEO,KAA8B,UAAa,MAAyC;AACzF,SAAK,aAAa,KAAK,OAAO,GAAG,IAAI;AAAA,EACvC;AAAA,EAEO,OAAO,cAA4B;AACxC,SAAK,gBAAgB,KAAK,gBAAgB,CAAE,YAAa,CAAC;AAAA,EAC5D;AACF;AAoBA,IAAM,qBAAN,MAAyB;AAAA,EACf;AAAA,EACD;AAAA,EACA;AAAA,EAEP,YAAY,UAAoB,cAAmC;AACjE,QAAI,QAAQ,KAAK,QAAQ,KAAK,SAAS,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC,MAAM,iBAAiB;AAC3E,YAAM,IAAI,MAAM,qGAAqG;AAAA,IACvH;AACA,SAAK,QAAQ;AACb,SAAK,eAAe;AACpB,SAAK,SAAS,IAAI,UAAAC,QAAG,oBAAoB,WAAW;AACpD,SAAK,OAAO,GAAG,QAAQ,MAAM;AAC3B,cAAQ,IAAI,+BAA+B;AAC3C,cAAQ,IAAI,6BAA6B,OAAO;AAGhD,WAAK,OAAO,KAAK,KAAK,UAAU;AAAA,QAC9B,OAAO;AAAA,QACP,MAAM;AAAA,UACJ,GAAG,KAAK,MAAM;AAAA,UACd,QAAQ,QAAQ,KAAK,QAAQ,KAAK,SAAS,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC;AAAA,UAC1D,YAAY;AAAA,QACd;AAAA,MACF,CAAC,CAAC;AAEF,WAAK,aAAa,KAAK,SAAS;AAGhC,UAAI,gBAAgB,IAAI,qBAAqB;AAC7C,WAAK,aAAa,KAAK,aAAa,aAAa;AAEjD,WAAK,OAAO,KAAK,KAAK,UAAU;AAAA,QAC9B,OAAO;AAAA,QACP,MAAM,cAAc,MAAM,KAAK;AAAA,MACjC,CAAC,CAAC;AACF,WAAK,MAAM,SAAS,IAAI,cAAc,cAAc,MAAM,IAAI,CAAC;AAAA,IACjE,CAAC;AAED,SAAK,OAAO,GAAG,SAAS,CAAC,UAAU;AACjC,UAAI,MAAM,QAAQ,SAAS,mBAAmB,GAAG;AAC/C,cAAM,IAAI,MAAM,wFAAwF;AAAA,MAC1G;AACA,cAAQ,MAAM,sBAAsB,KAAK;AAAA,IAC3C,CAAC;AAED,SAAK,OAAO,GAAG,SAAS,CAAC,MAAM,WAAW;AACxC,UAAI,SAAS,MAAM;AACjB,gBAAQ,MAAM,0BAA0B,MAAM;AAC9C;AAAA,MACF;AACA,WAAK,aAAa,KAAK,cAAc,MAAM;AAC3C,cAAQ,IAAI,oCAAoC;AAChD,cAAQ,MAAM,OAAO,SAAS,CAAC;AAC/B,WAAK,aAAa,KAAK,MAAM;AAC7B,WAAK,OAAO,MAAM;AAAA,IACpB,CAAC;AAED,SAAK,wBAAwB;AAAA,EAC/B;AAAA,EAEA,MAAc,eAAe,aAAmC,MAAc,aAAqB,QAA0E;AAC3K,UAAM,SAAS,YAAY,MAAM,KAAK;AACtC,UAAM,KAAK,KAAK,OAAO,EAAE,SAAS,EAAE,EAAE,UAAU,CAAC;AACjD,QAAI,CAAC,QAAQ;AACX,aAAO,CAAC;AAAA,IACV;AACA,WAAO,KAAK,KAAK,UAAU;AAAA,MACzB,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,MACA;AAAA,IACF,CAAC,CAAC;AACF,WAAO,MAAM,KAAK,0BAA0B,EAAE;AAAA,EAChD;AAAA,EAEQ,0BAA0B;AAChC,SAAK,OAAO,GAAG,WAAW,OAAO,SAAiB;AAChD,YAAM,UAAkC,KAAK,MAAM,IAAI;AACvD,cAAQ,QAAQ,OAAO;AAAA,QACrB,KAAK;AACH,gBAAM,SAAS,KAAK,MAAM,OAAO,aAAa,QAAQ,IAAI;AAC1D,cAAI,CAAC,OAAO,CAAC,GAAG;AACd,iBAAK,iBAAiB,QAAQ,IAAM,EAAE,SAAS,OAAO,OAAO,OAAO,CAAC,EAAE,CAAC;AAAA,UAC1E,OACK;AACH,iBAAK,iBAAiB,QAAQ,IAAM,EAAE,SAAS,KAAK,CAAC;AAAA,UACvD;AACA;AAAA,QACF,KAAK;AACH,cAAI,oBAAoB,IAAI,cAA8B,CAAC,QAAQ,MAAM,gBAAgB,KAAK,eAAe,QAAQ,MAAM,aAAa,KAAK,MAAM,CAAC;AACpJ,eAAK,aAAa,KAAK,UAAU,QAAQ,MAAM,iBAAiB;AAChE,gBAAM,eAAe,MAAM,KAAK,sBAAsB,iBAAiB;AACvE,eAAK,iBAAiB,QAAQ,IAAM,aAAa,IAAI;AACrD;AAAA,QACF,KAAK;AACH,cAAI,aAAa,IAAI,cAA2B,CAAC,QAAQ,MAAM,gBAAgB,KAAK,eAAe,QAAQ,MAAM,aAAa,KAAK,MAAM,CAAC;AAC1I,eAAK,aAAa,KAAK,SAAS,EAAE,MAAM,QAAQ,KAAK,MAAM,OAAO,QAAQ,KAAK,OAAO,YAAY,QAAQ,KAAK,YAAY,MAAM,QAAQ,KAAK,MAAM,MAAM,QAAQ,KAAK,MAAM,gBAAgB,QAAQ,KAAK,gBAAgB,gBAAgB,QAAQ,KAAK,eAAe,GAAG,UAAU;AACnR,gBAAM,WAAW,YAAY,MAAM;AACjC,gBAAI,WAAW,UAAU;AACvB,4BAAc,QAAQ;AACtB;AAAA,YACF;AACA,iBAAK,KAAK,gBAAgB;AAAA,cACxB,MAAM,WAAW;AAAA,cACjB,SAAS,QAAQ,KAAK;AAAA,cACtB,UAAU,WAAW;AAAA,YACvB,CAAQ;AAAA,UACV,GAAG,GAAG;AACN,gBAAM,cAAc,MAAM,KAAK,sBAAsB,UAAU;AAC/D,eAAK,iBAAiB,QAAQ,IAAM,YAAY,IAAI;AACpD;AAAA,QACF,KAAK;AACH,cAAI,qBAAqB,IAAI,cAAkC,CAAC,QAAQ,MAAM,gBAAgB,KAAK,eAAe,QAAQ,MAAM,aAAa,KAAK,MAAM,CAAC;AACzJ,cAAI,KAAK,aAAa,cAAc,cAAc,MAAM,GAAG;AACzD,iBAAK,iBAAiB,QAAQ,IAAM,CAAC,CAAC;AACtC;AAAA,UACF;AACA,eAAK,aAAa,KAAK,kBAAkB,QAAQ,MAAM,kBAAkB;AACzE,gBAAM,sBAAsB,MAAM,KAAK,sBAAsB,kBAAkB;AAC/E,eAAK,iBAAiB,QAAQ,IAAM,oBAAoB,IAAI;AAC5D;AAAA,QACF,KAAK;AACH,cAAI,mBAAmB,IAAI,cAAyB,CAAC,QAAQ,MAAM,gBAAgB,KAAK,eAAe,QAAQ,MAAM,aAAa,KAAK,MAAM,CAAC;AAC9I,cAAI,KAAK,aAAa,cAAc,cAAc,MAAM,GAAG;AACzD,iBAAK,iBAAiB,QAAQ,IAAM,EAAE,OAAO,qCAAqC,CAAC;AACnF;AAAA,UACF;AACA,eAAK,aAAa,KAAK,gBAAgB,QAAQ,MAAM,gBAAgB;AACrE,gBAAM,oBAAoB,MAAM,KAAK,sBAAsB,gBAAgB;AAC3E,eAAK,iBAAiB,QAAQ,IAAM,kBAAkB,IAAI;AAC1D;AAAA,MACJ;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEQ,sBAAyB,OAAoD;AAEnF,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,YAAM,UAAU,YAAY,MAAM;AAChC,YAAI,MAAM,UAAU;AAClB,kBAAQ,KAAK;AACb,uBAAa,OAAO;AAAA,QACtB;AAAA,MACF,GAAG,CAAC;AAEJ,YAAM,UAAU,WAAW,MAAM;AAC/B,YAAI,MAAM,UAAU;AAClB,wBAAc,OAAO;AACrB,gBAAM,WAAW,YAAY,MAAM;AACjC,gBAAI,MAAM,UAAU;AAClB,4BAAc,QAAQ;AACtB,sBAAQ,KAAK;AAAA,YACf;AAAA,UACF,GAAG,GAAG;AAAA,QACR,OACK;AACH,iBAAO,+BAA+B;AAAA,QACxC;AAAA,MACF,GAAG,GAAI;AAAA,IACT,CAAC;AAAA,EACH;AAAA,EAEO,iBAAiB,WAAmB,UAAe;AACxD,SAAK,OAAO,KAAK,KAAK,UAAU;AAAA,MAC9B,OAAO;AAAA,MACP,IAAI;AAAA,MACJ,MAAM;AAAA,IACR,CAAC,CAAC;AACF,YAAQ,IAAI,4BAA4B,SAAS;AAAA,EACnD;AAAA,EAEO,0BAA6B,WAA+B;AACjE,WAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,YAAM,SAAS,CAAC,SAAiB;AAC/B,cAAM,UAAkC,KAAK,MAAM,IAAI;AACvD,YAAI,QAAQ,UAAU,YAAY;AAChC,eAAK,OAAO,KAAK,WAAW,MAAM;AAClC;AAAA,QACF;AACA,gBAAQ,IAAI,4BAA4B,SAAS;AAEjD,YAAI,QAAQ,OAAO,WAAW;AAC5B,kBAAQ,QAAQ,IAAI;AAAA,QACtB,OACK;AACH,eAAK,OAAO,KAAK,WAAW,MAAM;AAAA,QACpC;AAAA,MACF;AACA,WAAK,OAAO,KAAK,WAAW,MAAM;AAAA,IACpC,CAAC;AAAA,EACH;AAAA,EAEO,KAAK,OAAgC,MAAiE;AAC3G,SAAK,OAAO,KAAK,KAAK,UAAU;AAAA,MAC9B;AAAA,MACA;AAAA,IACF,CAAC,CAAC;AAAA,EACJ;AAAA,EAEO,QAAQ;AACb,SAAK,OAAO,MAAM;AAAA,EACpB;AAGF;","names":["z","events","ws"]}
+{"version":3,"sources":["../src/main.ts","../src/config/ConfigurationBuilder.ts","../src/config/Configuration.ts","../src/EventResponse.ts","../package.json"],"sourcesContent":["import ws, { WebSocket } from 'ws';\r\nimport events from 'node:events';\r\nimport { ConfigurationBuilder, ConfigurationFile } from './config/ConfigurationBuilder';\r\nimport { Configuration } from './config/Configuration';\r\nimport EventResponse from './EventResponse';\r\nimport { SearchResult } from './SearchEngine';\r\n\r\nexport type OGIAddonEvent = 'connect' | 'disconnect' | 'configure' | 'authenticate' | 'search' | 'setup' | 'library-search' | 'game-details' | 'exit' | 'request-dl';\r\nexport type OGIAddonClientSentEvent = 'response' | 'authenticate' | 'configure' | 'defer-update' | 'notification' | 'input-asked';\r\n\r\nexport type OGIAddonServerSentEvent = 'authenticate' | 'configure' | 'config-update' | 'search' | 'setup' | 'response' | 'library-search' | 'game-details' | 'request-dl';\r\nexport { ConfigurationBuilder, Configuration, EventResponse, SearchResult };\r\nconst defaultPort = 7654;\r\nimport pjson from '../package.json';\r\nexport const version = pjson.version;\r\n\r\nexport interface ClientSentEventTypes {\r\n  response: any;\r\n  authenticate: any;\r\n  configure: ConfigurationFile;\r\n  'defer-update': {\r\n    logs: string[], \r\n    progress: number\r\n  };\r\n  notification: Notification;\r\n  'input-asked': ConfigurationBuilder;\r\n}\r\n\r\nexport type BasicLibraryInfo = {\r\n  name: string;\r\n  capsuleImage: string;\r\n  appID: number;\r\n}\r\n\r\nexport interface EventListenerTypes {\r\n  /**\r\n   * This event is emitted when the addon connects to the OGI Addon Server. Addon does not need to resolve anything.\r\n   * @param socket \r\n   * @returns \r\n   */\r\n  connect: (socket: ws) => void;\r\n\r\n  /**\r\n   * This event is emitted when the client requests for the addon to disconnect. Addon does not need to resolve this event, but we recommend `process.exit(0)` so the addon can exit gracefully instead of by force by the addon server.\r\n   * @param reason \r\n   * @returns \r\n   */\r\n  disconnect: (reason: string) => void;\r\n  /**\r\n   * This event is emitted when the client requests for the addon to configure itself. Addon should resolve the event with the internal configuration. (See ConfigurationBuilder) \r\n   * @param config \r\n   * @returns \r\n   */\r\n  configure: (config: ConfigurationBuilder) => ConfigurationBuilder;\r\n  /**\r\n   * This event is called when the client provides a response to any event. This should be treated as middleware. \r\n   * @param response \r\n   * @returns \r\n   */\r\n  response: (response: any) => void;\r\n\r\n  /**\r\n   * This event is called when the client requests for the addon to authenticate itself. You don't need to provide any info. \r\n   * @param config \r\n   * @returns \r\n   */\r\n  authenticate: (config: any) => void;\r\n  /**\r\n   * This event is emitted when the client requests for a torrent/direct download search to be performed. Addon is given the gameID (could be a steam appID or custom store appID), along with the storefront type. Addon should resolve the event with the search results. (See SearchResult) \r\n   * @param query \r\n   * @param event \r\n   * @returns \r\n   */\r\n  search: (query: { type: 'steamapp' | 'internal', text: string }, event: EventResponse<SearchResult[]>) => void;\r\n  /**\r\n   * This event is emitted when the client requests for app setup to be performed. Addon should resolve the event with the metadata for the library entry. (See LibraryInfo)\r\n   * @param data \r\n   * @param event \r\n   * @returns \r\n   */\r\n  setup: (\r\n    data: { \r\n      path: string, \r\n      type: 'direct' | 'torrent' | 'magnet',\r\n      name: string,\r\n      usedRealDebrid: boolean, \r\n      multiPartFiles?: {\r\n        name: string,\r\n        downloadURL: string\r\n      }[],\r\n      appID: number,\r\n      storefront: 'steam' | 'internal'\r\n    }, event: EventResponse<LibraryInfo>\r\n  ) => void;\r\n\r\n  /**\r\n   * This event is emitted when the client requires for a search to be performed. Input is the search query. \r\n   * @param query \r\n   * @param event \r\n   * @returns \r\n   */\r\n  'library-search': (query: string, event: EventResponse<BasicLibraryInfo[]>) => void;\r\n  'game-details': (appID: number, event: EventResponse<StoreData>) => void;\r\n  exit: () => void;\r\n  'request-dl': (appID: number, info: SearchResult, event: EventResponse<SearchResult>) => void;\r\n}\r\n\r\nexport interface StoreData {\r\n  name: string;\r\n  publishers: string[];\r\n  developers: string[];\r\n  appID: number;\r\n  releaseDate: string;\r\n  capsuleImage: string;\r\n  coverImage: string;\r\n  basicDescription: string;\r\n  description: string;\r\n  headerImage: string;\r\n}\r\nexport interface WebsocketMessageClient {\r\n  event: OGIAddonClientSentEvent;\r\n  id?: string;\r\n  args: any;\r\n}\r\nexport interface WebsocketMessageServer {\r\n  event: OGIAddonServerSentEvent;\r\n  id?: string;\r\n  args: any;\r\n}\r\nexport interface OGIAddonConfiguration {\r\n  name: string;\r\n  id: string;\r\n  description: string;\r\n  version: string;\r\n\r\n  author: string;\r\n  repository: string;\r\n}\r\n\r\n/**\r\n * The main class for the OGI Addon. This class is used to interact with the OGI Addon Server. The OGI Addon Server provides a `--addonSecret` to the addon so it can securely connect.\r\n * @example \r\n * ```typescript\r\n * const addon = new OGIAddon({\r\n *  name: 'Test Addon',\r\n*   id: 'test-addon',\r\n *  description: 'A test addon',\r\n *  version: '1.0.0',\r\n *  author: 'OGI Developers',\r\n *  repository: ''\r\n * });\r\n * ```\r\n * \r\n */\r\nexport default class OGIAddon {\r\n  public eventEmitter = new events.EventEmitter();\r\n  public addonWSListener: OGIAddonWSListener;\r\n  public addonInfo: OGIAddonConfiguration;\r\n  public config: Configuration = new Configuration({});\r\n\r\n  constructor(addonInfo: OGIAddonConfiguration) {\r\n    this.addonInfo = addonInfo;\r\n    this.addonWSListener = new OGIAddonWSListener(this, this.eventEmitter);\r\n  }\r\n  \r\n  /**\r\n   * Register an event listener for the addon. (See EventListenerTypes) \r\n   * @param event {OGIAddonEvent}\r\n   * @param listener {EventListenerTypes[OGIAddonEvent]} \r\n   */\r\n  public on<T extends OGIAddonEvent>(event: T, listener: EventListenerTypes[T]) {\r\n    this.eventEmitter.on(event, listener);\r\n  }\r\n\r\n  public emit<T extends OGIAddonEvent>(event: T, ...args: Parameters<EventListenerTypes[T]>) {\r\n    this.eventEmitter.emit(event, ...args);\r\n  }\r\n\r\n  /**\r\n   * Notify the client using a notification. Provide the type of notification, the message, and an ID. \r\n   * @param notification {Notification}\r\n   */\r\n  public notify(notification: Notification) {\r\n    this.addonWSListener.send('notification', [ notification ]);\r\n  }\r\n}\r\n\r\n/**\r\n * Library Info is the metadata for a library entry after setting up a game.\r\n */\r\nexport interface LibraryInfo {\r\n  name: string;\r\n  version: string;\r\n  cwd: string;\r\n  appID: number;\r\n  launchExecutable: string;\r\n  launchArguments?: string;\r\n  capsuleImage: string;\r\n  storefront: 'steam' | 'internal';\r\n  addonsource: string;\r\n  coverImage: string;\r\n  titleImage?: string;\r\n}\r\ninterface Notification {\r\n  type: 'warning' | 'error' | 'info' | 'success';\r\n  message: string;\r\n  id: string\r\n}\r\nclass OGIAddonWSListener {\r\n  private socket: WebSocket;\r\n  public eventEmitter: events.EventEmitter;\r\n  public addon: OGIAddon;\r\n\r\n  constructor(ogiAddon: OGIAddon, eventEmitter: events.EventEmitter) {\r\n    if (process.argv[process.argv.length - 1].split('=')[0] !== '--addonSecret') {\r\n      throw new Error('No secret provided. This usually happens because the addon was not started by the OGI Addon Server.');\r\n    }\r\n    this.addon = ogiAddon;\r\n    this.eventEmitter = eventEmitter;\r\n    this.socket = new ws('ws://localhost:' + defaultPort);\r\n    this.socket.on('open', () => {\r\n      console.log('Connected to OGI Addon Server');\r\n      console.log('OGI Addon Server Version:', version);\r\n\r\n      // Authenticate with OGI Addon Server\r\n      this.socket.send(JSON.stringify({\r\n        event: 'authenticate',\r\n        args: {\r\n          ...this.addon.addonInfo,\r\n          secret: process.argv[process.argv.length - 1].split('=')[1],\r\n          ogiVersion: version\r\n        }\r\n      }));\r\n\r\n      this.eventEmitter.emit('connect');\r\n\r\n      // send a configuration request\r\n      let configBuilder = new ConfigurationBuilder();\r\n      this.eventEmitter.emit('configure', configBuilder);\r\n     \r\n      this.socket.send(JSON.stringify({\r\n        event: 'configure',\r\n        args: configBuilder.build(false) \r\n      }));\r\n      this.addon.config = new Configuration(configBuilder.build(true));\r\n    });\r\n\r\n    this.socket.on('error', (error) => {\r\n      if (error.message.includes('Failed to connect')) {\r\n        throw new Error('OGI Addon Server is not running/is unreachable. Please start the server and try again.');\r\n      }\r\n      console.error('An error occurred:', error);\r\n    })\r\n\r\n    this.socket.on('close', (code, reason) => {\r\n      if (code === 1008) {\r\n        console.error('Authentication failed:', reason);\r\n        return;\r\n      }\r\n      this.eventEmitter.emit('disconnect', reason);\r\n      console.log(\"Disconnected from OGI Addon Server\")\r\n      console.error(reason.toString())\r\n      this.eventEmitter.emit('exit');\r\n      this.socket.close();\r\n    });\r\n\r\n    this.registerMessageReceiver();\r\n  }\r\n\r\n  private async userInputAsked(configBuilt: ConfigurationBuilder, name: string, description: string, socket: WebSocket): Promise<{ [key: string]: number | boolean | string }> {\r\n    const config = configBuilt.build(false);\r\n    const id = Math.random().toString(36).substring(7);\r\n    if (!socket) {\r\n      return {};\r\n    }\r\n    socket.send(JSON.stringify({\r\n      event: 'input-asked',\r\n      args: {\r\n        config,\r\n        name,\r\n        description\r\n      },\r\n      id: id\r\n    }));\r\n    return await this.waitForResponseFromServer(id);\r\n  }\r\n\r\n  private registerMessageReceiver() {\r\n    this.socket.on('message', async (data: string) => {\r\n      const message: WebsocketMessageServer = JSON.parse(data);\r\n      switch (message.event) {\r\n        case 'config-update':\r\n          const result = this.addon.config.updateConfig(message.args);\r\n          if (!result[0]) {\r\n            this.respondToMessage(message.id!!, { success: false, error: result[1] });\r\n          }\r\n          else {\r\n            this.respondToMessage(message.id!!, { success: true });\r\n          }\r\n          break \r\n        case 'search':\r\n          let searchResultEvent = new EventResponse<SearchResult[]>((screen, name, description) => this.userInputAsked(screen, name, description, this.socket));\r\n          this.eventEmitter.emit('search', message.args, searchResultEvent);\r\n          const searchResult = await this.waitForEventToRespond(searchResultEvent);         \r\n          this.respondToMessage(message.id!!, searchResult.data);\r\n          break\r\n        case 'setup':\r\n          let setupEvent = new EventResponse<LibraryInfo>((screen, name, description) => this.userInputAsked(screen, name, description, this.socket));\r\n          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);\r\n          const interval = setInterval(() => {\r\n            if (setupEvent.resolved) {\r\n              clearInterval(interval);\r\n              return;\r\n            }\r\n            this.send('defer-update', { \r\n              logs: setupEvent.logs,\r\n              deferID: message.args.deferID,\r\n              progress: setupEvent.progress\r\n            } as any);\r\n          }, 100);\r\n          const setupResult = await this.waitForEventToRespond(setupEvent);\r\n          this.respondToMessage(message.id!!, setupResult.data);\r\n          break\r\n        case 'library-search':\r\n          let librarySearchEvent = new EventResponse<BasicLibraryInfo[]>((screen, name, description) => this.userInputAsked(screen, name, description, this.socket));\r\n          if (this.eventEmitter.listenerCount('game-details') === 0) {\r\n            this.respondToMessage(message.id!!, []);\r\n            break;\r\n          }\r\n          this.eventEmitter.emit('library-search', message.args, librarySearchEvent);\r\n          const librarySearchResult = await this.waitForEventToRespond(librarySearchEvent);\r\n          this.respondToMessage(message.id!!, librarySearchResult.data);\r\n          break\r\n        case 'game-details':\r\n          let gameDetailsEvent = new EventResponse<StoreData>((screen, name, description) => this.userInputAsked(screen, name, description, this.socket));\r\n          if (this.eventEmitter.listenerCount('game-details') === 0) {\r\n            this.respondToMessage(message.id!!, { error: 'No event listener for game-details' });\r\n            break;\r\n          }\r\n          this.eventEmitter.emit('game-details', message.args, gameDetailsEvent);\r\n          const gameDetailsResult = await this.waitForEventToRespond(gameDetailsEvent);\r\n          this.respondToMessage(message.id!!, gameDetailsResult.data);\r\n          break\r\n        case 'request-dl':\r\n          let requestDLEvent = new EventResponse<SearchResult>((screen, name, description) => this.userInputAsked(screen, name, description, this.socket));\r\n          if (this.eventEmitter.listenerCount('request-dl') === 0) {\r\n            this.respondToMessage(message.id!!, { error: 'No event listener for request-dl' });\r\n            break;\r\n          }\r\n          this.eventEmitter.emit('request-dl', message.args.appID, message.args.info, requestDLEvent);\r\n          const requestDLResult = await this.waitForEventToRespond(requestDLEvent);\r\n          if (requestDLEvent.data === null || requestDLEvent.data?.downloadType === 'request') {\r\n            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.');\r\n          }\r\n          this.respondToMessage(message.id!!, requestDLResult.data);\r\n          break\r\n        }\r\n      });\r\n  }\r\n\r\n  private waitForEventToRespond<T>(event: EventResponse<T>): Promise<EventResponse<T>> {\r\n    // check the handlers to see if there even is any\r\n    return new Promise((resolve, reject) => {\r\n      const dataGet = setInterval(() => {\r\n        if (event.resolved) {\r\n          resolve(event);\r\n          clearTimeout(timeout);\r\n        }\r\n      }, 5);      \r\n\r\n      const timeout = setTimeout(() => {\r\n        if (event.deffered) {\r\n          clearInterval(dataGet);\r\n          const interval = setInterval(() => {\r\n            if (event.resolved) {\r\n              clearInterval(interval);\r\n              resolve(event);\r\n            }\r\n          }, 100);\r\n        }\r\n        else {\r\n          reject('Event did not respond in time');\r\n        }\r\n      }, 5000)\r\n    });\r\n  }\r\n\r\n  public respondToMessage(messageID: string, response: any) {\r\n    this.socket.send(JSON.stringify({\r\n      event: 'response',\r\n      id: messageID,\r\n      args: response\r\n    }));\r\n    console.log(\"dispatched response to \" + messageID)\r\n  }\r\n\r\n  public waitForResponseFromServer<T>(messageID: string): Promise<T> {\r\n    return new Promise((resolve) => {\r\n      const waiter = (data: string) => {\r\n        const message: WebsocketMessageClient = JSON.parse(data);\r\n        if (message.event !== 'response') {\r\n          this.socket.once('message', waiter);\r\n          return;\r\n        }\r\n        console.log(\"received response from \" + messageID)\r\n\r\n        if (message.id === messageID) {\r\n          resolve(message.args);\r\n        }\r\n        else {\r\n          this.socket.once('message', waiter);\r\n        }\r\n      }\r\n      this.socket.once('message', waiter);\r\n    });\r\n  }\r\n\r\n  public send(event: OGIAddonClientSentEvent, args: Parameters<ClientSentEventTypes[OGIAddonClientSentEvent]>) {\r\n    this.socket.send(JSON.stringify({\r\n      event,\r\n      args\r\n    }));\r\n  }\r\n\r\n  public close() {\r\n    this.socket.close();\r\n  }\r\n\r\n  \r\n}","import z, { ZodError } from \"zod\"\r\n\r\nexport interface ConfigurationFile {\r\n  [key: string]: ConfigurationOption\r\n}\r\n\r\nconst configValidation = z.object({\r\n  name: z.string().min(1),\r\n  displayName: z.string().min(1),\r\n  description: z.string().min(1),\r\n})\r\n\r\nexport function isStringOption(option: ConfigurationOption): option is StringOption {\r\n    return option.type === 'string';\r\n  }\r\n\r\nexport function isNumberOption(option: ConfigurationOption): option is NumberOption {\r\n  return option.type === 'number';\r\n}\r\n\r\nexport function isBooleanOption(option: ConfigurationOption): option is BooleanOption {\r\n  return option.type === 'boolean';\r\n}\r\n\r\nexport class ConfigurationBuilder {\r\n  private options: ConfigurationOption[] = [];\r\n\r\n  /**\r\n   * 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.\r\n   * @param option { (option: NumberOption) => NumberOption }\r\n   * @returns \r\n   */\r\n  public addNumberOption(option: (option: NumberOption) => NumberOption): ConfigurationBuilder {\r\n    let newOption = new NumberOption();\r\n    newOption = option(newOption);\r\n    this.options.push(newOption);\r\n    return this;\r\n  }\r\n\r\n  /**\r\n   * 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.\r\n   * @param option { (option: StringOption) => StringOption }\r\n  */\r\n  public addStringOption(option: (option: StringOption) => StringOption) {\r\n    let newOption = new StringOption();\r\n    newOption = option(newOption);\r\n    this.options.push(newOption);\r\n    return this;\r\n  }\r\n\r\n  /**\r\n   * 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.\r\n   * @param option { (option: BooleanOption) => BooleanOption }\r\n  */\r\n  public addBooleanOption(option: (option: BooleanOption) => BooleanOption) {\r\n    let newOption = new BooleanOption();\r\n    newOption = option(newOption);\r\n    this.options.push(newOption);\r\n    return this;\r\n  }\r\n\r\n  public build(includeFunctions: boolean): ConfigurationFile {\r\n    let config: ConfigurationFile = {};\r\n    this.options.forEach(option => {\r\n      // remove all functions from the option object\r\n      if (!includeFunctions) {\r\n        option = JSON.parse(JSON.stringify(option));\r\n        const optionData = configValidation.safeParse(option)\r\n        if (!optionData.success) {\r\n          throw new ZodError(optionData.error.errors)\r\n        }\r\n\r\n        config[option.name] = option;\r\n      }\r\n      else {\r\n        config[option.name] = option;\r\n      }\r\n    });\r\n    return config;\r\n  }\r\n}\r\n\r\nexport type ConfigurationOptionType = 'string' | 'number' | 'boolean' | 'unset'\r\nexport class ConfigurationOption {\r\n  public name: string = '';\r\n  public defaultValue: unknown = '';\r\n  public displayName: string = '';\r\n  public description: string = '';\r\n  public type: ConfigurationOptionType = 'unset'\r\n  \r\n  /**\r\n   * Set the name of the option. **REQUIRED**\r\n   * @param name {string} The name of the option. This is used to reference the option in the configuration file.\r\n   */\r\n  setName(name: string) {\r\n    this.name = name;\r\n    return this;\r\n  }\r\n\r\n  /**\r\n   * Set the display name of the option. This is used to show the user a human readable version of what the option is. **REQUIRED** \r\n   * @param displayName {string} The display name of the option. \r\n   * @returns \r\n   */\r\n  setDisplayName(displayName: string) {\r\n    this.displayName = displayName;\r\n    return this;\r\n  }\r\n\r\n  /**\r\n   * Set the description of the option. This is to show the user a brief description of what this option does. **REQUIRED**\r\n   * @param description {string} The description of the option. \r\n   * @returns \r\n   */\r\n  setDescription(description: string) {\r\n    this.description = description;\r\n    return this;\r\n  }\r\n\r\n  /**\r\n   * Validation code for the option. This is called when the user provides input to the option. If the validation fails, the user will be prompted to provide input again.\r\n   * @param input {unknown} The input to validate\r\n   */\r\n  validate(input: unknown): [ boolean, string ] {\r\n    throw new Error('Validation code not implemented. Value: ' + input)\r\n  };\r\n}\r\n\r\nexport class StringOption extends ConfigurationOption {\r\n  public allowedValues: string[] = [];\r\n  public minTextLength: number = 0;\r\n  public maxTextLength: number = Number.MAX_SAFE_INTEGER;\r\n  public defaultValue: string = '';\r\n  public inputType: 'text' | 'file' | 'password' | 'folder' = 'text';\r\n  public type: ConfigurationOptionType = 'string'\r\n\r\n  /**\r\n   * 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.  \r\n   * @param allowedValues {string[]} An array of allowed values for the string. If the array is empty, any value is allowed.\r\n   */\r\n  setAllowedValues(allowedValues: string[]): this {\r\n    this.allowedValues = allowedValues;\r\n    return this;\r\n  }\r\n\r\n  /**\r\n   * Set the default value for the string. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**\r\n   * @param defaultValue {string} The default value for the string.\r\n   */\r\n  setDefaultValue(defaultValue: string): this {\r\n    this.defaultValue = defaultValue;\r\n    return this;\r\n  }\r\n\r\n  /**\r\n   * Set the minimum text length for the string. If the user provides a string that is less than this value, the validation will fail. \r\n   * @param minTextLength {number} The minimum text length for the string. \r\n   */\r\n  setMinTextLength(minTextLength: number): this {\r\n    this.minTextLength = minTextLength;\r\n    return this;\r\n  }\r\n\r\n  /**\r\n   * Set the maximum text length for the string. If the user provides a string that is greater than this value, the validation will fail. \r\n   * @param maxTextLength {number} The maximum text length for the string.\r\n   */\r\n  setMaxTextLength(maxTextLength: number): this {\r\n    this.maxTextLength = maxTextLength;\r\n    return this;\r\n  }\r\n\r\n  /**\r\n   * Set the input type for the string. This will change how the client renders the input. \r\n   * @param inputType {'text' | 'file' | 'password' | 'folder'} The input type for the string. \r\n   */\r\n  setInputType(inputType: 'text' | 'file' | 'password' | 'folder'): this {\r\n    this.inputType = inputType;\r\n    return this;\r\n  }\r\n\r\n  override validate(input: unknown): [ boolean, string ] {\r\n    if (typeof input !== 'string') {\r\n      return [ false, 'Input is not a string' ];\r\n    }\r\n    if (this.allowedValues.length === 0 && input.length !== 0)\r\n      return [ true, '' ];\r\n    if (input.length < this.minTextLength || input.length > this.maxTextLength) {\r\n      return [ false, 'Input is not within the text length ' + this.minTextLength + ' and ' + this.maxTextLength + ' characters (currently ' + input.length + ' characters)' ];\r\n    }\r\n\r\n    return [ this.allowedValues.includes(input), 'Input is not an allowed value' ];\r\n  }\r\n}\r\n\r\nexport class NumberOption extends ConfigurationOption {\r\n  public min: number = 0;\r\n  public max: number = Number.MAX_SAFE_INTEGER;\r\n  public defaultValue: number = 0;\r\n  public type: ConfigurationOptionType = 'number'\r\n  public inputType: 'range' | 'number' = 'number';\r\n\r\n  /**\r\n   * Set the minimum value for the number. If the user provides a number that is less than this value, the validation will fail.\r\n   * @param min {number} The minimum value for the number.\r\n   */\r\n  setMin(min: number): this {\r\n    this.min = min;\r\n    return this;\r\n  }\r\n\r\n  /**\r\n   * Set the input type for the number. This will change how the client renders the input. \r\n   * @param type {'range' | 'number'} The input type for the number. \r\n   */\r\n  setInputType(type: 'range' | 'number'): this {\r\n    this.inputType = type;\r\n    return this;\r\n  }\r\n\r\n  /**\r\n   * Set the maximum value for the number. If the user provides a number that is greater than this value, the validation will fail.\r\n   * @param max {number} The maximum value for the number.\r\n   */\r\n  setMax(max: number): this {\r\n    this.max = max;\r\n    return this\r\n  }\r\n\r\n  /**\r\n   * Set the default value for the number. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**\r\n   * @param defaultValue {number} The default value for the number.\r\n   */\r\n  setDefaultValue(defaultValue: number): this {\r\n    this.defaultValue = defaultValue;\r\n    return this;\r\n  }\r\n\r\n  override validate(input: unknown): [ boolean, string ] {\r\n    if (isNaN(Number(input))) {\r\n      return [ false, 'Input is not a number' ];\r\n    }\r\n    if (Number(input) < this.min || Number(input) > this.max) {\r\n      return [ false, 'Input is not within the range of ' + this.min + ' and ' + this.max ];\r\n    }\r\n    return [ true, '' ];\r\n  }\r\n\r\n}\r\n\r\nexport class BooleanOption extends ConfigurationOption {\r\n  public type: ConfigurationOptionType = 'boolean'\r\n  public defaultValue: boolean = false;\r\n\r\n  /**\r\n   * Set the default value for the boolean. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**\r\n   * @param defaultValue {boolean} The default value for the boolean.\r\n   */\r\n  setDefaultValue(defaultValue: boolean): this {\r\n    this.defaultValue = defaultValue;\r\n    return this;\r\n  }\r\n\r\n  override validate(input: unknown): [ boolean, string ] {\r\n    if (typeof input !== 'boolean') {\r\n      return [ false, 'Input is not a boolean' ];\r\n    }\r\n    return [ true, '' ];\r\n  }\r\n\r\n}","import { ConfigurationFile, ConfigurationBuilder, BooleanOption, ConfigurationOption, ConfigurationOptionType, NumberOption, StringOption, isBooleanOption, isNumberOption, isStringOption } from \"./ConfigurationBuilder\";\r\n\r\ninterface DefiniteConfig {\r\n  [key: string]: string | number | boolean;\r\n}\r\nexport class Configuration {\r\n  readonly storedConfigTemplate: ConfigurationFile;\r\n  definiteConfig: DefiniteConfig = {};\r\n  constructor(configTemplate: ConfigurationFile) {\r\n    this.storedConfigTemplate = configTemplate;\r\n  }\r\n\r\n  updateConfig(config: DefiniteConfig, validate: boolean = true): [ boolean, { [key: string]: string } ] {\r\n    this.definiteConfig = config;\r\n    if (validate) {\r\n      const result = this.validateConfig();\r\n      return result;\r\n    }\r\n    return [ true, {} ];\r\n  }\r\n  // provides falsey or truthy value, and an error message if falsey\r\n  private validateConfig(): [ boolean, { [key: string]: string } ] {\r\n    const erroredKeys = new Map<string, string>();\r\n    for (const key in this.storedConfigTemplate) {\r\n      if (this.definiteConfig[key] === null || this.definiteConfig[key] === undefined) {\r\n        console.warn('Option ' + key + ' is not defined. Using default value Value: ' + this.definiteConfig[key]);\r\n        this.definiteConfig[key] = this.storedConfigTemplate[key].defaultValue as string | number | boolean;\r\n      }\r\n      if (this.storedConfigTemplate[key].type !== typeof this.definiteConfig[key]) {\r\n        throw new Error('Option ' + key + ' is not of the correct type');\r\n      }\r\n\r\n      const result = this.storedConfigTemplate[key].validate(this.definiteConfig[key]);\r\n      if (!result[0]) {\r\n        erroredKeys.set(key, result[1]);\r\n      }\r\n    }\r\n\r\n    for (const key in this.definiteConfig) {\r\n      if (!this.storedConfigTemplate[key]) {\r\n        throw new Error('Option ' + key + ' is not defined in the configuration template');\r\n      }\r\n    }\r\n\r\n    if (erroredKeys.size > 0) {\r\n      return [ false, Object.fromEntries(erroredKeys) ];\r\n    }\r\n\r\n    return [ true, Object.fromEntries(erroredKeys) ];\r\n  }\r\n\r\n  getStringValue(optionName: string): string {\r\n    if (!this.definiteConfig[optionName] === null) {\r\n      throw new Error('Option ' + optionName + ' is not defined');\r\n    }\r\n    if (typeof this.definiteConfig[optionName] !== 'string') {\r\n      throw new Error('Option ' + optionName + ' is not a string');\r\n    }\r\n    return this.definiteConfig[optionName];\r\n  }\r\n\r\n  getNumberValue(optionName: string): number {\r\n    if (!this.definiteConfig[optionName] === null) {\r\n      throw new Error('Option ' + optionName + ' is not defined');\r\n    }\r\n    if (typeof this.definiteConfig[optionName] !== 'number') {\r\n      throw new Error('Option ' + optionName + ' is not a number');\r\n    }\r\n    return this.definiteConfig[optionName];\r\n  }\r\n\r\n  getBooleanValue(optionName: string): boolean {\r\n    if (this.definiteConfig[optionName] === null) {\r\n      throw new Error('Option ' + optionName + ' is not defined');\r\n    }\r\n    if (typeof this.definiteConfig[optionName] !== 'boolean') {\r\n      throw new Error('Option ' + optionName + ' is not a boolean');\r\n    }\r\n    return this.definiteConfig[optionName];\r\n  }\r\n}\r\n\r\nexport { ConfigurationFile, ConfigurationBuilder, BooleanOption, ConfigurationOption, ConfigurationOptionType, NumberOption, StringOption, isBooleanOption, isNumberOption, isStringOption };","import { ConfigurationBuilder } from \"./main\";\r\n\r\nexport default class EventResponse<T> {\r\n  data: T | undefined = undefined;\r\n  deffered: boolean = false;\r\n  resolved: boolean = false;\r\n  progress: number = 0;\r\n  logs: string[] = [];\r\n  onInputAsked?: (screen: ConfigurationBuilder, name: string, description: string) => Promise<{ [key: string]: boolean | string | number }>;\r\n\r\n  constructor(onInputAsked?: (screen: ConfigurationBuilder, name: string, description: string) => Promise<{ [key: string]: boolean | string | number }>) {\r\n    this.onInputAsked = onInputAsked;\r\n  }\r\n  \r\n\r\n  public defer() {\r\n    this.deffered = true;\r\n  }\r\n\r\n  /**\r\n   * 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.** \r\n   * @param data {T}\r\n   */\r\n  public resolve(data: T) {\r\n    this.resolved = true;\r\n    this.data = data;\r\n  }\r\n\r\n  /**\r\n   * 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.** \r\n   */\r\n  public complete() {\r\n    this.resolved = true;\r\n  }\r\n\r\n  /**\r\n   * Logs a message to the event. This is useful for debugging and logging information to the user. \r\n   * @param message {string}\r\n   */\r\n  public log(message: string) {\r\n    this.logs.push(message);\r\n  }\r\n\r\n  /**\r\n   * Send a screen to the client to ask for input. Use the `ConfigurationBuilder` system to build the screen. Once sent to the user, the addon cannot change the screen.\r\n   * @async\r\n   * @param name {string}\r\n   * @param description {string}\r\n   * @param screen {ConfigurationBuilder}\r\n   * @returns {Promise<{ [key: string]: boolean | string | number }>}\r\n   */\r\n  public async askForInput(name: string, description: string, screen: ConfigurationBuilder): Promise<{ [key: string]: boolean | string | number; }> {\r\n    if (!this.onInputAsked) {\r\n      throw new Error('No input asked callback');\r\n    }\r\n    return await this.onInputAsked(screen, name, description);\r\n  }\r\n\r\n  \r\n}","{\r\n  \"name\": \"ogi-addon\",\r\n  \"module\": \"./build/main.js\",\r\n  \"type\": \"module\",\r\n  \"main\": \"./build/main.cjs\",\r\n  \"version\": \"1.1.0\",\r\n  \"exports\": {\r\n    \".\": {\r\n      \"import\": {\r\n        \"default\": \"./build/main.js\",\r\n        \"types\": \"./build/main.d.ts\"\r\n      },\r\n      \"require\": {\r\n        \"default\": \"./build/main.cjs\",\r\n        \"types\": \"./build/main.d.cts\"\r\n      }\r\n    },\r\n    \"./config\": {\r\n      \"import\": {\r\n        \"default\": \"./build/config/Configuration.js\",\r\n        \"types\": \"./build/config/Configuration.d.ts\"\r\n      },\r\n      \"require\": {\r\n        \"default\": \"./build/config/Configuration.cjs\",\r\n        \"types\": \"./build/config/Configuration.d.cts\"\r\n      }\r\n    }\r\n  },\r\n  \"typings\": \"./build/main.d.ts\",\r\n  \"author\": {\r\n    \"name\": \"Nat3z\",\r\n    \"email\": \"me@nat3z.com\",\r\n    \"url\": \"https://nat3z.com/\"\r\n  },\r\n  \"dependencies\": {\r\n    \"ws\": \"^8.4.0\",\r\n    \"zod\": \"^3.23.8\"\r\n  },\r\n  \"scripts\": {\r\n    \"auto-build\": \"tsc -w\",\r\n    \"build\": \"tsup --config tsup.config.js\",\r\n    \"release\": \"bun run build && npm publish\"\r\n  },\r\n  \"devDependencies\": {\r\n    \"@types/node\": \"^20.14.12\",\r\n    \"@types/ws\": \"^8.4.0\",\r\n    \"tsup\": \"^8.2.3\",\r\n    \"typescript\": \"^5.0.0\"\r\n  }\r\n}"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,gBAA8B;AAC9B,yBAAmB;;;ACDnB,iBAA4B;AAM5B,IAAM,mBAAmB,WAAAA,QAAE,OAAO;AAAA,EAChC,MAAM,WAAAA,QAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EACtB,aAAa,WAAAA,QAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EAC7B,aAAa,WAAAA,QAAE,OAAO,EAAE,IAAI,CAAC;AAC/B,CAAC;AAcM,IAAM,uBAAN,MAA2B;AAAA,EACxB,UAAiC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOnC,gBAAgB,QAAsE;AAC3F,QAAI,YAAY,IAAI,aAAa;AACjC,gBAAY,OAAO,SAAS;AAC5B,SAAK,QAAQ,KAAK,SAAS;AAC3B,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,gBAAgB,QAAgD;AACrE,QAAI,YAAY,IAAI,aAAa;AACjC,gBAAY,OAAO,SAAS;AAC5B,SAAK,QAAQ,KAAK,SAAS;AAC3B,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,iBAAiB,QAAkD;AACxE,QAAI,YAAY,IAAI,cAAc;AAClC,gBAAY,OAAO,SAAS;AAC5B,SAAK,QAAQ,KAAK,SAAS;AAC3B,WAAO;AAAA,EACT;AAAA,EAEO,MAAM,kBAA8C;AACzD,QAAI,SAA4B,CAAC;AACjC,SAAK,QAAQ,QAAQ,YAAU;AAE7B,UAAI,CAAC,kBAAkB;AACrB,iBAAS,KAAK,MAAM,KAAK,UAAU,MAAM,CAAC;AAC1C,cAAM,aAAa,iBAAiB,UAAU,MAAM;AACpD,YAAI,CAAC,WAAW,SAAS;AACvB,gBAAM,IAAI,oBAAS,WAAW,MAAM,MAAM;AAAA,QAC5C;AAEA,eAAO,OAAO,IAAI,IAAI;AAAA,MACxB,OACK;AACH,eAAO,OAAO,IAAI,IAAI;AAAA,MACxB;AAAA,IACF,CAAC;AACD,WAAO;AAAA,EACT;AACF;AAGO,IAAM,sBAAN,MAA0B;AAAA,EACxB,OAAe;AAAA,EACf,eAAwB;AAAA,EACxB,cAAsB;AAAA,EACtB,cAAsB;AAAA,EACtB,OAAgC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMvC,QAAQ,MAAc;AACpB,SAAK,OAAO;AACZ,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,eAAe,aAAqB;AAClC,SAAK,cAAc;AACnB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,eAAe,aAAqB;AAClC,SAAK,cAAc;AACnB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAS,OAAqC;AAC5C,UAAM,IAAI,MAAM,6CAA6C,KAAK;AAAA,EACpE;AACF;AAEO,IAAM,eAAN,cAA2B,oBAAoB;AAAA,EAC7C,gBAA0B,CAAC;AAAA,EAC3B,gBAAwB;AAAA,EACxB,gBAAwB,OAAO;AAAA,EAC/B,eAAuB;AAAA,EACvB,YAAqD;AAAA,EACrD,OAAgC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMvC,iBAAiB,eAA+B;AAC9C,SAAK,gBAAgB;AACrB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,gBAAgB,cAA4B;AAC1C,SAAK,eAAe;AACpB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,iBAAiB,eAA6B;AAC5C,SAAK,gBAAgB;AACrB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,iBAAiB,eAA6B;AAC5C,SAAK,gBAAgB;AACrB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAa,WAA0D;AACrE,SAAK,YAAY;AACjB,WAAO;AAAA,EACT;AAAA,EAES,SAAS,OAAqC;AACrD,QAAI,OAAO,UAAU,UAAU;AAC7B,aAAO,CAAE,OAAO,uBAAwB;AAAA,IAC1C;AACA,QAAI,KAAK,cAAc,WAAW,KAAK,MAAM,WAAW;AACtD,aAAO,CAAE,MAAM,EAAG;AACpB,QAAI,MAAM,SAAS,KAAK,iBAAiB,MAAM,SAAS,KAAK,eAAe;AAC1E,aAAO,CAAE,OAAO,yCAAyC,KAAK,gBAAgB,UAAU,KAAK,gBAAgB,4BAA4B,MAAM,SAAS,cAAe;AAAA,IACzK;AAEA,WAAO,CAAE,KAAK,cAAc,SAAS,KAAK,GAAG,+BAAgC;AAAA,EAC/E;AACF;AAEO,IAAM,eAAN,cAA2B,oBAAoB;AAAA,EAC7C,MAAc;AAAA,EACd,MAAc,OAAO;AAAA,EACrB,eAAuB;AAAA,EACvB,OAAgC;AAAA,EAChC,YAAgC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMvC,OAAO,KAAmB;AACxB,SAAK,MAAM;AACX,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAa,MAAgC;AAC3C,SAAK,YAAY;AACjB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO,KAAmB;AACxB,SAAK,MAAM;AACX,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,gBAAgB,cAA4B;AAC1C,SAAK,eAAe;AACpB,WAAO;AAAA,EACT;AAAA,EAES,SAAS,OAAqC;AACrD,QAAI,MAAM,OAAO,KAAK,CAAC,GAAG;AACxB,aAAO,CAAE,OAAO,uBAAwB;AAAA,IAC1C;AACA,QAAI,OAAO,KAAK,IAAI,KAAK,OAAO,OAAO,KAAK,IAAI,KAAK,KAAK;AACxD,aAAO,CAAE,OAAO,sCAAsC,KAAK,MAAM,UAAU,KAAK,GAAI;AAAA,IACtF;AACA,WAAO,CAAE,MAAM,EAAG;AAAA,EACpB;AAEF;AAEO,IAAM,gBAAN,cAA4B,oBAAoB;AAAA,EAC9C,OAAgC;AAAA,EAChC,eAAwB;AAAA;AAAA;AAAA;AAAA;AAAA,EAM/B,gBAAgB,cAA6B;AAC3C,SAAK,eAAe;AACpB,WAAO;AAAA,EACT;AAAA,EAES,SAAS,OAAqC;AACrD,QAAI,OAAO,UAAU,WAAW;AAC9B,aAAO,CAAE,OAAO,wBAAyB;AAAA,IAC3C;AACA,WAAO,CAAE,MAAM,EAAG;AAAA,EACpB;AAEF;;;ACzQO,IAAM,gBAAN,MAAoB;AAAA,EAChB;AAAA,EACT,iBAAiC,CAAC;AAAA,EAClC,YAAY,gBAAmC;AAC7C,SAAK,uBAAuB;AAAA,EAC9B;AAAA,EAEA,aAAa,QAAwB,WAAoB,MAA8C;AACrG,SAAK,iBAAiB;AACtB,QAAI,UAAU;AACZ,YAAM,SAAS,KAAK,eAAe;AACnC,aAAO;AAAA,IACT;AACA,WAAO,CAAE,MAAM,CAAC,CAAE;AAAA,EACpB;AAAA;AAAA,EAEQ,iBAAyD;AAC/D,UAAM,cAAc,oBAAI,IAAoB;AAC5C,eAAW,OAAO,KAAK,sBAAsB;AAC3C,UAAI,KAAK,eAAe,GAAG,MAAM,QAAQ,KAAK,eAAe,GAAG,MAAM,QAAW;AAC/E,gBAAQ,KAAK,YAAY,MAAM,iDAAiD,KAAK,eAAe,GAAG,CAAC;AACxG,aAAK,eAAe,GAAG,IAAI,KAAK,qBAAqB,GAAG,EAAE;AAAA,MAC5D;AACA,UAAI,KAAK,qBAAqB,GAAG,EAAE,SAAS,OAAO,KAAK,eAAe,GAAG,GAAG;AAC3E,cAAM,IAAI,MAAM,YAAY,MAAM,6BAA6B;AAAA,MACjE;AAEA,YAAM,SAAS,KAAK,qBAAqB,GAAG,EAAE,SAAS,KAAK,eAAe,GAAG,CAAC;AAC/E,UAAI,CAAC,OAAO,CAAC,GAAG;AACd,oBAAY,IAAI,KAAK,OAAO,CAAC,CAAC;AAAA,MAChC;AAAA,IACF;AAEA,eAAW,OAAO,KAAK,gBAAgB;AACrC,UAAI,CAAC,KAAK,qBAAqB,GAAG,GAAG;AACnC,cAAM,IAAI,MAAM,YAAY,MAAM,+CAA+C;AAAA,MACnF;AAAA,IACF;AAEA,QAAI,YAAY,OAAO,GAAG;AACxB,aAAO,CAAE,OAAO,OAAO,YAAY,WAAW,CAAE;AAAA,IAClD;AAEA,WAAO,CAAE,MAAM,OAAO,YAAY,WAAW,CAAE;AAAA,EACjD;AAAA,EAEA,eAAe,YAA4B;AACzC,QAAI,CAAC,KAAK,eAAe,UAAU,MAAM,MAAM;AAC7C,YAAM,IAAI,MAAM,YAAY,aAAa,iBAAiB;AAAA,IAC5D;AACA,QAAI,OAAO,KAAK,eAAe,UAAU,MAAM,UAAU;AACvD,YAAM,IAAI,MAAM,YAAY,aAAa,kBAAkB;AAAA,IAC7D;AACA,WAAO,KAAK,eAAe,UAAU;AAAA,EACvC;AAAA,EAEA,eAAe,YAA4B;AACzC,QAAI,CAAC,KAAK,eAAe,UAAU,MAAM,MAAM;AAC7C,YAAM,IAAI,MAAM,YAAY,aAAa,iBAAiB;AAAA,IAC5D;AACA,QAAI,OAAO,KAAK,eAAe,UAAU,MAAM,UAAU;AACvD,YAAM,IAAI,MAAM,YAAY,aAAa,kBAAkB;AAAA,IAC7D;AACA,WAAO,KAAK,eAAe,UAAU;AAAA,EACvC;AAAA,EAEA,gBAAgB,YAA6B;AAC3C,QAAI,KAAK,eAAe,UAAU,MAAM,MAAM;AAC5C,YAAM,IAAI,MAAM,YAAY,aAAa,iBAAiB;AAAA,IAC5D;AACA,QAAI,OAAO,KAAK,eAAe,UAAU,MAAM,WAAW;AACxD,YAAM,IAAI,MAAM,YAAY,aAAa,mBAAmB;AAAA,IAC9D;AACA,WAAO,KAAK,eAAe,UAAU;AAAA,EACvC;AACF;;;AC9EA,IAAqB,gBAArB,MAAsC;AAAA,EACpC,OAAsB;AAAA,EACtB,WAAoB;AAAA,EACpB,WAAoB;AAAA,EACpB,WAAmB;AAAA,EACnB,OAAiB,CAAC;AAAA,EAClB;AAAA,EAEA,YAAY,cAA2I;AACrJ,SAAK,eAAe;AAAA,EACtB;AAAA,EAGO,QAAQ;AACb,SAAK,WAAW;AAAA,EAClB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,QAAQ,MAAS;AACtB,SAAK,WAAW;AAChB,SAAK,OAAO;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAKO,WAAW;AAChB,SAAK,WAAW;AAAA,EAClB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,IAAI,SAAiB;AAC1B,SAAK,KAAK,KAAK,OAAO;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAa,YAAY,MAAc,aAAqB,QAAsF;AAChJ,QAAI,CAAC,KAAK,cAAc;AACtB,YAAM,IAAI,MAAM,yBAAyB;AAAA,IAC3C;AACA,WAAO,MAAM,KAAK,aAAa,QAAQ,MAAM,WAAW;AAAA,EAC1D;AAGF;;;AC3DA;AAAA,EACE,MAAQ;AAAA,EACR,QAAU;AAAA,EACV,MAAQ;AAAA,EACR,MAAQ;AAAA,EACR,SAAW;AAAA,EACX,SAAW;AAAA,IACT,KAAK;AAAA,MACH,QAAU;AAAA,QACR,SAAW;AAAA,QACX,OAAS;AAAA,MACX;AAAA,MACA,SAAW;AAAA,QACT,SAAW;AAAA,QACX,OAAS;AAAA,MACX;AAAA,IACF;AAAA,IACA,YAAY;AAAA,MACV,QAAU;AAAA,QACR,SAAW;AAAA,QACX,OAAS;AAAA,MACX;AAAA,MACA,SAAW;AAAA,QACT,SAAW;AAAA,QACX,OAAS;AAAA,MACX;AAAA,IACF;AAAA,EACF;AAAA,EACA,SAAW;AAAA,EACX,QAAU;AAAA,IACR,MAAQ;AAAA,IACR,OAAS;AAAA,IACT,KAAO;AAAA,EACT;AAAA,EACA,cAAgB;AAAA,IACd,IAAM;AAAA,IACN,KAAO;AAAA,EACT;AAAA,EACA,SAAW;AAAA,IACT,cAAc;AAAA,IACd,OAAS;AAAA,IACT,SAAW;AAAA,EACb;AAAA,EACA,iBAAmB;AAAA,IACjB,eAAe;AAAA,IACf,aAAa;AAAA,IACb,MAAQ;AAAA,IACR,YAAc;AAAA,EAChB;AACF;;;AJrCA,IAAM,cAAc;AAEb,IAAM,UAAU,gBAAM;AA4I7B,IAAqB,WAArB,MAA8B;AAAA,EACrB,eAAe,IAAI,mBAAAC,QAAO,aAAa;AAAA,EACvC;AAAA,EACA;AAAA,EACA,SAAwB,IAAI,cAAc,CAAC,CAAC;AAAA,EAEnD,YAAY,WAAkC;AAC5C,SAAK,YAAY;AACjB,SAAK,kBAAkB,IAAI,mBAAmB,MAAM,KAAK,YAAY;AAAA,EACvE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,GAA4B,OAAU,UAAiC;AAC5E,SAAK,aAAa,GAAG,OAAO,QAAQ;AAAA,EACtC;AAAA,EAEO,KAA8B,UAAa,MAAyC;AACzF,SAAK,aAAa,KAAK,OAAO,GAAG,IAAI;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,OAAO,cAA4B;AACxC,SAAK,gBAAgB,KAAK,gBAAgB,CAAE,YAAa,CAAC;AAAA,EAC5D;AACF;AAuBA,IAAM,qBAAN,MAAyB;AAAA,EACf;AAAA,EACD;AAAA,EACA;AAAA,EAEP,YAAY,UAAoB,cAAmC;AACjE,QAAI,QAAQ,KAAK,QAAQ,KAAK,SAAS,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC,MAAM,iBAAiB;AAC3E,YAAM,IAAI,MAAM,qGAAqG;AAAA,IACvH;AACA,SAAK,QAAQ;AACb,SAAK,eAAe;AACpB,SAAK,SAAS,IAAI,UAAAC,QAAG,oBAAoB,WAAW;AACpD,SAAK,OAAO,GAAG,QAAQ,MAAM;AAC3B,cAAQ,IAAI,+BAA+B;AAC3C,cAAQ,IAAI,6BAA6B,OAAO;AAGhD,WAAK,OAAO,KAAK,KAAK,UAAU;AAAA,QAC9B,OAAO;AAAA,QACP,MAAM;AAAA,UACJ,GAAG,KAAK,MAAM;AAAA,UACd,QAAQ,QAAQ,KAAK,QAAQ,KAAK,SAAS,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC;AAAA,UAC1D,YAAY;AAAA,QACd;AAAA,MACF,CAAC,CAAC;AAEF,WAAK,aAAa,KAAK,SAAS;AAGhC,UAAI,gBAAgB,IAAI,qBAAqB;AAC7C,WAAK,aAAa,KAAK,aAAa,aAAa;AAEjD,WAAK,OAAO,KAAK,KAAK,UAAU;AAAA,QAC9B,OAAO;AAAA,QACP,MAAM,cAAc,MAAM,KAAK;AAAA,MACjC,CAAC,CAAC;AACF,WAAK,MAAM,SAAS,IAAI,cAAc,cAAc,MAAM,IAAI,CAAC;AAAA,IACjE,CAAC;AAED,SAAK,OAAO,GAAG,SAAS,CAAC,UAAU;AACjC,UAAI,MAAM,QAAQ,SAAS,mBAAmB,GAAG;AAC/C,cAAM,IAAI,MAAM,wFAAwF;AAAA,MAC1G;AACA,cAAQ,MAAM,sBAAsB,KAAK;AAAA,IAC3C,CAAC;AAED,SAAK,OAAO,GAAG,SAAS,CAAC,MAAM,WAAW;AACxC,UAAI,SAAS,MAAM;AACjB,gBAAQ,MAAM,0BAA0B,MAAM;AAC9C;AAAA,MACF;AACA,WAAK,aAAa,KAAK,cAAc,MAAM;AAC3C,cAAQ,IAAI,oCAAoC;AAChD,cAAQ,MAAM,OAAO,SAAS,CAAC;AAC/B,WAAK,aAAa,KAAK,MAAM;AAC7B,WAAK,OAAO,MAAM;AAAA,IACpB,CAAC;AAED,SAAK,wBAAwB;AAAA,EAC/B;AAAA,EAEA,MAAc,eAAe,aAAmC,MAAc,aAAqB,QAA0E;AAC3K,UAAM,SAAS,YAAY,MAAM,KAAK;AACtC,UAAM,KAAK,KAAK,OAAO,EAAE,SAAS,EAAE,EAAE,UAAU,CAAC;AACjD,QAAI,CAAC,QAAQ;AACX,aAAO,CAAC;AAAA,IACV;AACA,WAAO,KAAK,KAAK,UAAU;AAAA,MACzB,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,MACA;AAAA,IACF,CAAC,CAAC;AACF,WAAO,MAAM,KAAK,0BAA0B,EAAE;AAAA,EAChD;AAAA,EAEQ,0BAA0B;AAChC,SAAK,OAAO,GAAG,WAAW,OAAO,SAAiB;AAChD,YAAM,UAAkC,KAAK,MAAM,IAAI;AACvD,cAAQ,QAAQ,OAAO;AAAA,QACrB,KAAK;AACH,gBAAM,SAAS,KAAK,MAAM,OAAO,aAAa,QAAQ,IAAI;AAC1D,cAAI,CAAC,OAAO,CAAC,GAAG;AACd,iBAAK,iBAAiB,QAAQ,IAAM,EAAE,SAAS,OAAO,OAAO,OAAO,CAAC,EAAE,CAAC;AAAA,UAC1E,OACK;AACH,iBAAK,iBAAiB,QAAQ,IAAM,EAAE,SAAS,KAAK,CAAC;AAAA,UACvD;AACA;AAAA,QACF,KAAK;AACH,cAAI,oBAAoB,IAAI,cAA8B,CAAC,QAAQ,MAAM,gBAAgB,KAAK,eAAe,QAAQ,MAAM,aAAa,KAAK,MAAM,CAAC;AACpJ,eAAK,aAAa,KAAK,UAAU,QAAQ,MAAM,iBAAiB;AAChE,gBAAM,eAAe,MAAM,KAAK,sBAAsB,iBAAiB;AACvE,eAAK,iBAAiB,QAAQ,IAAM,aAAa,IAAI;AACrD;AAAA,QACF,KAAK;AACH,cAAI,aAAa,IAAI,cAA2B,CAAC,QAAQ,MAAM,gBAAgB,KAAK,eAAe,QAAQ,MAAM,aAAa,KAAK,MAAM,CAAC;AAC1I,eAAK,aAAa,KAAK,SAAS,EAAE,MAAM,QAAQ,KAAK,MAAM,OAAO,QAAQ,KAAK,OAAO,YAAY,QAAQ,KAAK,YAAY,MAAM,QAAQ,KAAK,MAAM,MAAM,QAAQ,KAAK,MAAM,gBAAgB,QAAQ,KAAK,gBAAgB,gBAAgB,QAAQ,KAAK,eAAe,GAAG,UAAU;AACnR,gBAAM,WAAW,YAAY,MAAM;AACjC,gBAAI,WAAW,UAAU;AACvB,4BAAc,QAAQ;AACtB;AAAA,YACF;AACA,iBAAK,KAAK,gBAAgB;AAAA,cACxB,MAAM,WAAW;AAAA,cACjB,SAAS,QAAQ,KAAK;AAAA,cACtB,UAAU,WAAW;AAAA,YACvB,CAAQ;AAAA,UACV,GAAG,GAAG;AACN,gBAAM,cAAc,MAAM,KAAK,sBAAsB,UAAU;AAC/D,eAAK,iBAAiB,QAAQ,IAAM,YAAY,IAAI;AACpD;AAAA,QACF,KAAK;AACH,cAAI,qBAAqB,IAAI,cAAkC,CAAC,QAAQ,MAAM,gBAAgB,KAAK,eAAe,QAAQ,MAAM,aAAa,KAAK,MAAM,CAAC;AACzJ,cAAI,KAAK,aAAa,cAAc,cAAc,MAAM,GAAG;AACzD,iBAAK,iBAAiB,QAAQ,IAAM,CAAC,CAAC;AACtC;AAAA,UACF;AACA,eAAK,aAAa,KAAK,kBAAkB,QAAQ,MAAM,kBAAkB;AACzE,gBAAM,sBAAsB,MAAM,KAAK,sBAAsB,kBAAkB;AAC/E,eAAK,iBAAiB,QAAQ,IAAM,oBAAoB,IAAI;AAC5D;AAAA,QACF,KAAK;AACH,cAAI,mBAAmB,IAAI,cAAyB,CAAC,QAAQ,MAAM,gBAAgB,KAAK,eAAe,QAAQ,MAAM,aAAa,KAAK,MAAM,CAAC;AAC9I,cAAI,KAAK,aAAa,cAAc,cAAc,MAAM,GAAG;AACzD,iBAAK,iBAAiB,QAAQ,IAAM,EAAE,OAAO,qCAAqC,CAAC;AACnF;AAAA,UACF;AACA,eAAK,aAAa,KAAK,gBAAgB,QAAQ,MAAM,gBAAgB;AACrE,gBAAM,oBAAoB,MAAM,KAAK,sBAAsB,gBAAgB;AAC3E,eAAK,iBAAiB,QAAQ,IAAM,kBAAkB,IAAI;AAC1D;AAAA,QACF,KAAK;AACH,cAAI,iBAAiB,IAAI,cAA4B,CAAC,QAAQ,MAAM,gBAAgB,KAAK,eAAe,QAAQ,MAAM,aAAa,KAAK,MAAM,CAAC;AAC/I,cAAI,KAAK,aAAa,cAAc,YAAY,MAAM,GAAG;AACvD,iBAAK,iBAAiB,QAAQ,IAAM,EAAE,OAAO,mCAAmC,CAAC;AACjF;AAAA,UACF;AACA,eAAK,aAAa,KAAK,cAAc,QAAQ,KAAK,OAAO,QAAQ,KAAK,MAAM,cAAc;AAC1F,gBAAM,kBAAkB,MAAM,KAAK,sBAAsB,cAAc;AACvE,cAAI,eAAe,SAAS,QAAQ,eAAe,MAAM,iBAAiB,WAAW;AACnF,kBAAM,IAAI,MAAM,qIAAqI;AAAA,UACvJ;AACA,eAAK,iBAAiB,QAAQ,IAAM,gBAAgB,IAAI;AACxD;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACL;AAAA,EAEQ,sBAAyB,OAAoD;AAEnF,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,YAAM,UAAU,YAAY,MAAM;AAChC,YAAI,MAAM,UAAU;AAClB,kBAAQ,KAAK;AACb,uBAAa,OAAO;AAAA,QACtB;AAAA,MACF,GAAG,CAAC;AAEJ,YAAM,UAAU,WAAW,MAAM;AAC/B,YAAI,MAAM,UAAU;AAClB,wBAAc,OAAO;AACrB,gBAAM,WAAW,YAAY,MAAM;AACjC,gBAAI,MAAM,UAAU;AAClB,4BAAc,QAAQ;AACtB,sBAAQ,KAAK;AAAA,YACf;AAAA,UACF,GAAG,GAAG;AAAA,QACR,OACK;AACH,iBAAO,+BAA+B;AAAA,QACxC;AAAA,MACF,GAAG,GAAI;AAAA,IACT,CAAC;AAAA,EACH;AAAA,EAEO,iBAAiB,WAAmB,UAAe;AACxD,SAAK,OAAO,KAAK,KAAK,UAAU;AAAA,MAC9B,OAAO;AAAA,MACP,IAAI;AAAA,MACJ,MAAM;AAAA,IACR,CAAC,CAAC;AACF,YAAQ,IAAI,4BAA4B,SAAS;AAAA,EACnD;AAAA,EAEO,0BAA6B,WAA+B;AACjE,WAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,YAAM,SAAS,CAAC,SAAiB;AAC/B,cAAM,UAAkC,KAAK,MAAM,IAAI;AACvD,YAAI,QAAQ,UAAU,YAAY;AAChC,eAAK,OAAO,KAAK,WAAW,MAAM;AAClC;AAAA,QACF;AACA,gBAAQ,IAAI,4BAA4B,SAAS;AAEjD,YAAI,QAAQ,OAAO,WAAW;AAC5B,kBAAQ,QAAQ,IAAI;AAAA,QACtB,OACK;AACH,eAAK,OAAO,KAAK,WAAW,MAAM;AAAA,QACpC;AAAA,MACF;AACA,WAAK,OAAO,KAAK,WAAW,MAAM;AAAA,IACpC,CAAC;AAAA,EACH;AAAA,EAEO,KAAK,OAAgC,MAAiE;AAC3G,SAAK,OAAO,KAAK,KAAK,UAAU;AAAA,MAC9B;AAAA,MACA;AAAA,IACF,CAAC,CAAC;AAAA,EACJ;AAAA,EAEO,QAAQ;AACb,SAAK,OAAO,MAAM;AAAA,EACpB;AAGF;","names":["z","events","ws"]}

package/build/main.d.cts

@@ -5,10 +5,11 @@ import { Configuration } from './config/Configuration.cjs';
 import EventResponse from './EventResponse.cjs';
 import { SearchResult } from './SearchEngine.cjs';
 
-type OGIAddonEvent = 'connect' | 'disconnect' | 'configure' | 'authenticate' | 'search' | 'setup' | 'library-search' | 'game-details' | 'exit';
+type OGIAddonEvent = 'connect' | 'disconnect' | 'configure' | 'authenticate' | 'search' | 'setup' | 'library-search' | 'game-details' | 'exit' | 'request-dl';
 type OGIAddonClientSentEvent = 'response' | 'authenticate' | 'configure' | 'defer-update' | 'notification' | 'input-asked';
-type OGIAddonServerSentEvent = 'authenticate' | 'configure' | 'config-update' | 'search' | 'setup' | 'response' | 'library-search' | 'game-details';
+type OGIAddonServerSentEvent = 'authenticate' | 'configure' | 'config-update' | 'search' | 'setup' | 'response' | 'library-search' | 'game-details' | 'request-dl';
 
+declare const version: string;
 interface ClientSentEventTypes {
     response: any;
     authenticate: any;
@@ -26,15 +27,52 @@ type BasicLibraryInfo = {
     appID: number;
 };
 interface EventListenerTypes {
+    /**
+     * This event is emitted when the addon connects to the OGI Addon Server. Addon does not need to resolve anything.
+     * @param socket
+     * @returns
+     */
     connect: (socket: ws) => void;
+    /**
+     * This event is emitted when the client requests for the addon to disconnect. Addon does not need to resolve this event, but we recommend `process.exit(0)` so the addon can exit gracefully instead of by force by the addon server.
+     * @param reason
+     * @returns
+     */
     disconnect: (reason: string) => void;
+    /**
+     * This event is emitted when the client requests for the addon to configure itself. Addon should resolve the event with the internal configuration. (See ConfigurationBuilder)
+     * @param config
+     * @returns
+     */
     configure: (config: ConfigurationBuilder) => ConfigurationBuilder;
+    /**
+     * This event is called when the client provides a response to any event. This should be treated as middleware.
+     * @param response
+     * @returns
+     */
     response: (response: any) => void;
+    /**
+     * This event is called when the client requests for the addon to authenticate itself. You don't need to provide any info.
+     * @param config
+     * @returns
+     */
     authenticate: (config: any) => void;
+    /**
+     * This event is emitted when the client requests for a torrent/direct download search to be performed. Addon is given the gameID (could be a steam appID or custom store appID), along with the storefront type. Addon should resolve the event with the search results. (See SearchResult)
+     * @param query
+     * @param event
+     * @returns
+     */
     search: (query: {
         type: 'steamapp' | 'internal';
         text: string;
     }, event: EventResponse<SearchResult[]>) => void;
+    /**
+     * This event is emitted when the client requests for app setup to be performed. Addon should resolve the event with the metadata for the library entry. (See LibraryInfo)
+     * @param data
+     * @param event
+     * @returns
+     */
     setup: (data: {
         path: string;
         type: 'direct' | 'torrent' | 'magnet';
@@ -47,9 +85,16 @@ interface EventListenerTypes {
         appID: number;
         storefront: 'steam' | 'internal';
     }, event: EventResponse<LibraryInfo>) => void;
+    /**
+     * This event is emitted when the client requires for a search to be performed. Input is the search query.
+     * @param query
+     * @param event
+     * @returns
+     */
     'library-search': (query: string, event: EventResponse<BasicLibraryInfo[]>) => void;
     'game-details': (appID: number, event: EventResponse<StoreData>) => void;
     exit: () => void;
+    'request-dl': (appID: number, info: SearchResult, event: EventResponse<SearchResult>) => void;
 }
 interface StoreData {
     name: string;
@@ -81,16 +126,43 @@ interface OGIAddonConfiguration {
     author: string;
     repository: string;
 }
+/**
+ * The main class for the OGI Addon. This class is used to interact with the OGI Addon Server. The OGI Addon Server provides a `--addonSecret` to the addon so it can securely connect.
+ * @example
+ * ```typescript
+ * const addon = new OGIAddon({
+ *  name: 'Test Addon',
+*   id: 'test-addon',
+ *  description: 'A test addon',
+ *  version: '1.0.0',
+ *  author: 'OGI Developers',
+ *  repository: ''
+ * });
+ * ```
+ *
+ */
 declare class OGIAddon {
     eventEmitter: events<[never]>;
     addonWSListener: OGIAddonWSListener;
     addonInfo: OGIAddonConfiguration;
     config: Configuration;
     constructor(addonInfo: OGIAddonConfiguration);
+    /**
+     * Register an event listener for the addon. (See EventListenerTypes)
+     * @param event {OGIAddonEvent}
+     * @param listener {EventListenerTypes[OGIAddonEvent]}
+     */
     on<T extends OGIAddonEvent>(event: T, listener: EventListenerTypes[T]): void;
     emit<T extends OGIAddonEvent>(event: T, ...args: Parameters<EventListenerTypes[T]>): void;
+    /**
+     * Notify the client using a notification. Provide the type of notification, the message, and an ID.
+     * @param notification {Notification}
+     */
     notify(notification: Notification): void;
 }
+/**
+ * Library Info is the metadata for a library entry after setting up a game.
+ */
 interface LibraryInfo {
     name: string;
     version: string;
@@ -123,4 +195,4 @@ declare class OGIAddonWSListener {
     close(): void;
 }
 
-export { type BasicLibraryInfo, type ClientSentEventTypes, Configuration, ConfigurationBuilder, type EventListenerTypes, EventResponse, type LibraryInfo, type OGIAddonClientSentEvent, type OGIAddonConfiguration, type OGIAddonEvent, type OGIAddonServerSentEvent, SearchResult, type StoreData, type WebsocketMessageClient, type WebsocketMessageServer, OGIAddon as default };
+export { type BasicLibraryInfo, type ClientSentEventTypes, Configuration, ConfigurationBuilder, type EventListenerTypes, EventResponse, type LibraryInfo, type OGIAddonClientSentEvent, type OGIAddonConfiguration, type OGIAddonEvent, type OGIAddonServerSentEvent, SearchResult, type StoreData, type WebsocketMessageClient, type WebsocketMessageServer, OGIAddon as default, version };

package/build/main.d.ts

@@ -5,10 +5,11 @@ import { Configuration } from './config/Configuration.js';
 import EventResponse from './EventResponse.js';
 import { SearchResult } from './SearchEngine.js';
 
-type OGIAddonEvent = 'connect' | 'disconnect' | 'configure' | 'authenticate' | 'search' | 'setup' | 'library-search' | 'game-details' | 'exit';
+type OGIAddonEvent = 'connect' | 'disconnect' | 'configure' | 'authenticate' | 'search' | 'setup' | 'library-search' | 'game-details' | 'exit' | 'request-dl';
 type OGIAddonClientSentEvent = 'response' | 'authenticate' | 'configure' | 'defer-update' | 'notification' | 'input-asked';
-type OGIAddonServerSentEvent = 'authenticate' | 'configure' | 'config-update' | 'search' | 'setup' | 'response' | 'library-search' | 'game-details';
+type OGIAddonServerSentEvent = 'authenticate' | 'configure' | 'config-update' | 'search' | 'setup' | 'response' | 'library-search' | 'game-details' | 'request-dl';
 
+declare const version: string;
 interface ClientSentEventTypes {
     response: any;
     authenticate: any;
@@ -26,15 +27,52 @@ type BasicLibraryInfo = {
     appID: number;
 };
 interface EventListenerTypes {
+    /**
+     * This event is emitted when the addon connects to the OGI Addon Server. Addon does not need to resolve anything.
+     * @param socket
+     * @returns
+     */
     connect: (socket: ws) => void;
+    /**
+     * This event is emitted when the client requests for the addon to disconnect. Addon does not need to resolve this event, but we recommend `process.exit(0)` so the addon can exit gracefully instead of by force by the addon server.
+     * @param reason
+     * @returns
+     */
     disconnect: (reason: string) => void;
+    /**
+     * This event is emitted when the client requests for the addon to configure itself. Addon should resolve the event with the internal configuration. (See ConfigurationBuilder)
+     * @param config
+     * @returns
+     */
     configure: (config: ConfigurationBuilder) => ConfigurationBuilder;
+    /**
+     * This event is called when the client provides a response to any event. This should be treated as middleware.
+     * @param response
+     * @returns
+     */
     response: (response: any) => void;
+    /**
+     * This event is called when the client requests for the addon to authenticate itself. You don't need to provide any info.
+     * @param config
+     * @returns
+     */
     authenticate: (config: any) => void;
+    /**
+     * This event is emitted when the client requests for a torrent/direct download search to be performed. Addon is given the gameID (could be a steam appID or custom store appID), along with the storefront type. Addon should resolve the event with the search results. (See SearchResult)
+     * @param query
+     * @param event
+     * @returns
+     */
     search: (query: {
         type: 'steamapp' | 'internal';
         text: string;
     }, event: EventResponse<SearchResult[]>) => void;
+    /**
+     * This event is emitted when the client requests for app setup to be performed. Addon should resolve the event with the metadata for the library entry. (See LibraryInfo)
+     * @param data
+     * @param event
+     * @returns
+     */
     setup: (data: {
         path: string;
         type: 'direct' | 'torrent' | 'magnet';
@@ -47,9 +85,16 @@ interface EventListenerTypes {
         appID: number;
         storefront: 'steam' | 'internal';
     }, event: EventResponse<LibraryInfo>) => void;
+    /**
+     * This event is emitted when the client requires for a search to be performed. Input is the search query.
+     * @param query
+     * @param event
+     * @returns
+     */
     'library-search': (query: string, event: EventResponse<BasicLibraryInfo[]>) => void;
     'game-details': (appID: number, event: EventResponse<StoreData>) => void;
     exit: () => void;
+    'request-dl': (appID: number, info: SearchResult, event: EventResponse<SearchResult>) => void;
 }
 interface StoreData {
     name: string;
@@ -81,16 +126,43 @@ interface OGIAddonConfiguration {
     author: string;
     repository: string;
 }
+/**
+ * The main class for the OGI Addon. This class is used to interact with the OGI Addon Server. The OGI Addon Server provides a `--addonSecret` to the addon so it can securely connect.
+ * @example
+ * ```typescript
+ * const addon = new OGIAddon({
+ *  name: 'Test Addon',
+*   id: 'test-addon',
+ *  description: 'A test addon',
+ *  version: '1.0.0',
+ *  author: 'OGI Developers',
+ *  repository: ''
+ * });
+ * ```
+ *
+ */
 declare class OGIAddon {
     eventEmitter: events<[never]>;
     addonWSListener: OGIAddonWSListener;
     addonInfo: OGIAddonConfiguration;
     config: Configuration;
     constructor(addonInfo: OGIAddonConfiguration);
+    /**
+     * Register an event listener for the addon. (See EventListenerTypes)
+     * @param event {OGIAddonEvent}
+     * @param listener {EventListenerTypes[OGIAddonEvent]}
+     */
     on<T extends OGIAddonEvent>(event: T, listener: EventListenerTypes[T]): void;
     emit<T extends OGIAddonEvent>(event: T, ...args: Parameters<EventListenerTypes[T]>): void;
+    /**
+     * Notify the client using a notification. Provide the type of notification, the message, and an ID.
+     * @param notification {Notification}
+     */
     notify(notification: Notification): void;
 }
+/**
+ * Library Info is the metadata for a library entry after setting up a game.
+ */
 interface LibraryInfo {
     name: string;
     version: string;
@@ -123,4 +195,4 @@ declare class OGIAddonWSListener {
     close(): void;
 }
 
-export { type BasicLibraryInfo, type ClientSentEventTypes, Configuration, ConfigurationBuilder, type EventListenerTypes, EventResponse, type LibraryInfo, type OGIAddonClientSentEvent, type OGIAddonConfiguration, type OGIAddonEvent, type OGIAddonServerSentEvent, SearchResult, type StoreData, type WebsocketMessageClient, type WebsocketMessageServer, OGIAddon as default };
+export { type BasicLibraryInfo, type ClientSentEventTypes, Configuration, ConfigurationBuilder, type EventListenerTypes, EventResponse, type LibraryInfo, type OGIAddonClientSentEvent, type OGIAddonConfiguration, type OGIAddonEvent, type OGIAddonServerSentEvent, SearchResult, type StoreData, type WebsocketMessageClient, type WebsocketMessageServer, OGIAddon as default, version };