ogi-addon 3.1.0 → 4.0.0

package/build/main.d.cts

@@ -1,301 +1,25 @@
-import { ConfigurationBuilder, ConfigurationFile } from "./config/ConfigurationBuilder.cjs";
+import { ConfigurationBuilder } from "./config/ConfigurationBuilder.cjs";
 import { Configuration } from "./config/Configuration.cjs";
-import { SearchResult } from "./SearchEngine.cjs";
 import { extraction } from "./extraction.cjs";
 import EventResponse from "./EventResponse.cjs";
+import { AddonClientToServerEventArgs, AddonClientToServerEventArgs as AddonClientToServerEventArgs$1, AddonClientToServerEventName, AddonClientToServerEventName as AddonClientToServerEventName$1, AddonClientToServerWebsocketMessage, AddonNotificationMessage, AddonNotificationMessage as AddonNotificationMessage$1, AddonProtocolEventListenerTypes, AddonProtocolEventListenerTypes as AddonProtocolEventListenerTypes$1, AddonSDKLifecycleEventListenerTypes, AddonSDKLifecycleEventListenerTypes as AddonSDKLifecycleEventListenerTypes$1, AddonServerHostEventListeners, AddonServerHostEventName, AddonServerLifecycleEvent, AddonServerToClientEventName, AddonServerToClientWebsocketMessage, AddonTaskRunEventArgs as TaskRunMessageArgs, BasicLibraryInfo as BasicLibraryInfo$1, CatalogCarouselItem, CatalogResponse, CatalogResponse as CatalogResponse$1, CatalogSection, CatalogWithCarousel, ConfigurationFile, ConfigurationOptionType, ConfigurationOptionWire, LibraryInfo, LibraryInfo as LibraryInfo$1, OGIAddonConfiguration, OGIAddonConfiguration as OGIAddonConfiguration$1, OGIAddonSDKEventListener, OGIAddonSDKEventListener as OGIAddonSDKEventListener$1, SearchResult, SetupCommandData, SetupEventResponse, SetupResponse, StoreData, UmuId } from "@ogi-sdk/connect";
 import events from "node:events";
 import { IFuseOptions } from "fuse.js";
 import { z } from "zod";
 
 //#region src/main.d.ts
-/**
- * Exposed events that the programmer can use to listen to and emit events.
- */
-type OGIAddonEvent = 'connect' | 'disconnect' | 'configure' | 'authenticate' | 'search' | 'setup' | 'library-search' | 'game-details' | 'exit' | 'check-for-updates' | 'request-dl' | 'catalog' | 'launch-app';
-/**
- * The events that the client can send to the server and are handled by the server.
- */
-type OGIAddonClientSentEvent = 'response' | 'authenticate' | 'configure' | 'defer-update' | 'notification' | 'input-asked' | 'get-app-details' | 'search-app-name' | 'flag' | 'task-update';
-/**
- * The events that the server sends to the client
- * This is the events that the server can send to the client and are handled by the client.
- */
-type OGIAddonServerSentEvent = 'authenticate' | 'configure' | 'config-update' | 'launch-app' | 'search' | 'setup' | 'response' | 'library-search' | 'check-for-updates' | 'task-run' | 'game-details' | 'request-dl' | 'catalog';
 declare const VERSION: string;
-interface ClientSentEventTypes {
-  response: any;
-  authenticate: {
-    name: string;
-    id: string;
-    description: string;
-    version: string;
-    author: string;
-  };
-  configure: ConfigurationFile;
-  'defer-update': {
-    logs: string[];
-    progress: number;
-  };
-  notification: Notification;
-  'input-asked': ConfigurationBuilder<Record<string, string | number | boolean>>;
-  'task-update': {
-    id: string;
-    progress: number;
-    logs: string[];
-    finished: boolean;
-    failed: string | undefined;
-  };
-  'get-app-details': {
-    appID: number;
-    storefront: string;
-  };
-  'search-app-name': {
-    query: string;
-    storefront: string;
-  };
-  flag: {
-    flag: string;
-    value: string | string[];
-  };
-}
-type BasicLibraryInfo = {
-  name: string;
-  capsuleImage: string;
-  appID: number;
-  storefront: string;
-};
-interface CatalogSection {
-  name: string;
-  description: string;
-  listings: BasicLibraryInfo[];
-}
-interface CatalogCarouselItem {
-  name: string;
-  description: string;
-  carouselImage: string;
-  fullBannerImage?: string;
-  appID?: number;
-  storefront?: string;
-  capsuleImage?: string;
-}
-interface CatalogWithCarousel {
-  sections: Record<string, CatalogSection>;
-  carousel?: Record<string, CatalogCarouselItem> | CatalogCarouselItem[];
-}
-type CatalogResponse = Record<string, CatalogSection> | CatalogWithCarousel;
+/** @deprecated Use {@link AddonNotificationMessage}. */
+type Notification = AddonNotificationMessage$1;
 /**
- * UMU ID format: 'steam:${number}' or 'umu:${string | number}'
- * - steam:${number} → maps to umu-${number} for Steam games
- * - umu:${string | number} → maps to umu-${string | number} for non-Steam games
+ * Addon SDK listener signatures. Protocol commands come from `addonProtocol` in
+ * `@ogi-sdk/connect`; lifecycle and builder-specific hooks are merged below.
  */
-type UmuId = `steam:${number}` | `umu:${string | number}`;
-type SetupEventResponse = Omit<LibraryInfo, 'capsuleImage' | 'coverImage' | 'name' | 'appID' | 'storefront' | 'addonsource' | 'titleImage'> & {
-  redistributables?: {
-    name: string;
-    path: string;
-  }[];
-  /**
-   * UMU Proton integration configuration
-   */
-  umu?: {
-    /**
-     * UMU ID for the game. Format: 'steam:${number}' or 'umu:${string | number}'
-     * - steam:${number} → maps to umu-${number} for Steam games
-     * - umu:${string | number} → maps to umu-${string | number} for non-Steam games
-     */
-    umuId: UmuId;
-    /**
-     * Optional DLL overrides. Can be WINEDLLOVERRIDES-style (e.g. "dinput8=n,b") or bare DLL names.
-     * Bare names get "=n,b" inferred; entries that already include "=..." are used as-is.
-     */
-    dllOverrides?: string[];
-    /**
-     * Optional PROTONPATH override to use for UMU launches.
-     * Omit this unless you absolutely need a specific Proton build/path.
-     */
-    protonVersion?: string;
-    /**
-     * Optional store identifier for protonfixes (e.g., 'gog', 'egs', 'none')
-     */
-    store?: string;
-    /**
-     * Cached Steam shortcut app ID after adding UMU game to Steam (avoids re-adding on each launch)
-     */
-    steamShortcutId?: number;
-  };
-};
-interface EventListenerTypes {
-  /**
-   * This event is emitted when the addon connects to the OGI Addon Server. Addon does not need to resolve anything.
-   * @param event
-   * @returns
-   */
-  connect: (event: EventResponse<void>) => 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
-   */
+type EventListenerTypes = AddonSDKLifecycleEventListenerTypes$1<EventResponse<unknown>> & AddonProtocolEventListenerTypes$1<EventResponse<unknown>, 'authenticate' | 'configure' | 'catalog'> & {
+  authenticate: (config: unknown) => void;
   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: {
-    storefront: string;
-    appID: number;
-  } & ({
-    for: 'game' | 'task' | 'all';
-  } | {
-    for: 'update';
-    libraryInfo: LibraryInfo;
-  }), 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' | 'empty';
-    name: string;
-    usedRealDebrid: boolean;
-    clearOldFilesBeforeUpdate?: boolean;
-    multiPartFiles?: {
-      name: string;
-      downloadURL: string;
-    }[];
-    appID: number;
-    storefront: string;
-    manifest?: Record<string, unknown>;
-  } & ({
-    for: 'game';
-  } | {
-    for: 'update';
-    currentLibraryInfo: LibraryInfo;
-  }), event: EventResponse<SetupEventResponse>) => 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;
-  /**
-   * This event is emitted when the client requests for a game details to be fetched. Addon should resolve the event with the game details. This is used to generate a store page for the game.
-   * @param appID
-   * @param event
-   * @returns
-   */
-  'game-details': (details: {
-    appID: number;
-    storefront: string;
-  }, event: EventResponse<StoreData | undefined>) => void;
-  /**
-   * This event is emitted when the client requests for the addon to exit. Use this to perform any cleanup tasks, ending with a `process.exit(0)`.
-   * @returns
-   */
-  exit: () => void;
-  /**
-   * This event is emitted when the client requests for a download to be performed with the 'request' type. Addon should resolve the event with a SearchResult containing the actual download info.
-   * @param appID
-   * @param info
-   * @param event
-   * @returns
-   */
-  'request-dl': (appID: number, info: SearchResult, event: EventResponse<SearchResult>) => void;
-  /**
-   * This event is emitted when the client requests for a catalog to be fetched. Addon should resolve the event with the catalog.
-   * @param event
-   * @returns
-   */
-  catalog: (event: Omit<EventResponse<CatalogResponse>, 'askForInput'>) => void;
-  /**
-   * This event is emitted when the client requests for an addon to check for updates. Addon should resolve the event with the update information.
-   * @param data
-   * @param event
-   * @returns
-   */
-  'check-for-updates': (data: {
-    appID: number;
-    storefront: string;
-    currentVersion: string;
-  }, event: EventResponse<{
-    available: true;
-    version: string;
-  } | {
-    available: false;
-  }>) => void;
-  /**
-   * This event is emitted when the client is going to launch an app. Addon should use this to perform any pre or post launch tasks.
-   * @param data {LibraryInfo} The library information for the app to be launched.
-   * @param launchType { 'pre' | 'post' } The type of launch task to perform.
-   * @param event {EventResponse<void>} The event response from the server.
-   */
-  'launch-app': (data: {
-    libraryInfo: LibraryInfo;
-    launchType: 'pre' | 'post';
-  }, event: EventResponse<void>) => void;
-}
-interface StoreData {
-  name: string;
-  publishers: string[];
-  developers: string[];
-  appID: number;
-  releaseDate: string;
-  capsuleImage: string;
-  coverImage: string;
-  basicDescription: string;
-  description: string;
-  headerImage: string;
-  latestVersion: string;
-}
-interface WebsocketMessageClient {
-  event: OGIAddonClientSentEvent;
-  id?: string;
-  args: any;
-  statusError?: string;
-}
-interface WebsocketMessageServer {
-  event: OGIAddonServerSentEvent;
-  id?: string;
-  args: any;
-  statusError?: string;
-}
-/**
- * The configuration for the addon. This is used to identify the addon and provide information about it.
- * Storefronts is an array of names of stores that the addon supports.
- */
-interface OGIAddonConfiguration {
-  name: string;
-  id: string;
-  description: string;
-  version: string;
-  author: string;
-  repository: string;
-  storefronts: string[];
-}
+  catalog: (event: Omit<EventResponse<CatalogResponse$1>, 'askForInput'>) => void;
+};
 /**
  * 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
@@ -314,31 +38,31 @@ interface OGIAddonConfiguration {
 declare class OGIAddon {
   eventEmitter: events<[never]>;
   addonWSListener: OGIAddonWSListener;
-  addonInfo: OGIAddonConfiguration;
+  addonInfo: OGIAddonConfiguration$1;
   config: Configuration;
   private eventsAvailable;
   private registeredConnectEvent;
   private taskHandlers;
-  constructor(addonInfo: OGIAddonConfiguration);
+  constructor(addonInfo: OGIAddonConfiguration$1);
   /**
    * Register an event listener for the addon. (See EventListenerTypes)
-   * @param event {OGIAddonEvent}
-   * @param listener {EventListenerTypes[OGIAddonEvent]}
+   * @param event {OGIAddonSDKEventListener}
+   * @param listener {EventListenerTypes[OGIAddonSDKEventListener]}
    */
-  on<T extends OGIAddonEvent>(event: T, listener: EventListenerTypes[T]): void;
-  emit<T extends OGIAddonEvent>(event: T, ...args: Parameters<EventListenerTypes[T]>): void;
+  on<T extends OGIAddonSDKEventListener$1>(event: T, listener: EventListenerTypes[T]): void;
+  emit<T extends OGIAddonSDKEventListener$1>(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;
+  notify(notification: AddonNotificationMessage$1): void;
   /**
    * Get the app details for a given appID and storefront.
    * @param appID {number}
    * @param storefront {string}
    * @returns {Promise<StoreData>}
    */
-  getAppDetails(appID: number, storefront: string): Promise<StoreData | undefined>;
+  getAppDetails(appID: number, storefront: string): Promise<any>;
   searchGame(query: string, storefront: string): Promise<BasicLibraryInfo[]>;
   /**
    * Notify the OGI Addon Server that you are performing a background task. This can be used to help users understand what is happening in the background.
@@ -364,7 +88,7 @@ declare class OGIAddon {
     manifest: Record<string, unknown>;
     downloadPath: string;
     name: string;
-    libraryInfo: LibraryInfo;
+    libraryInfo: LibraryInfo$1;
   }) => Promise<void> | void): void;
   /**
    * Check if a task handler is registered for the given task name.
@@ -381,7 +105,7 @@ declare class OGIAddon {
     manifest: Record<string, unknown>;
     downloadPath: string;
     name: string;
-    libraryInfo?: LibraryInfo;
+    libraryInfo?: LibraryInfo$1;
   }) => Promise<void> | void) | undefined;
   /**
    * Extract a file using 7-Zip on Windows, unzip on Linux/Mac.
@@ -470,116 +194,10 @@ declare class SearchTool<T> {
 /**
  * Library Info is the metadata for a library entry after setting up a game.
  */
-declare const ZodLibraryInfo: z.ZodObject<{
-  name: z.ZodString;
-  version: z.ZodString;
-  cwd: z.ZodString;
-  appID: z.ZodNumber;
-  launchExecutable: z.ZodString;
-  launchArguments: z.ZodOptional<z.ZodString>;
-  launchEnv: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-  capsuleImage: z.ZodString;
-  storefront: z.ZodString;
-  addonsource: z.ZodString;
-  coverImage: z.ZodString;
-  titleImage: z.ZodOptional<z.ZodString>;
-  /**
-   * UMU Proton integration configuration (Linux only)
-   */
-  umu: z.ZodOptional<z.ZodObject<{
-    umuId: z.ZodString;
-    dllOverrides: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    protonVersion: z.ZodOptional<z.ZodString>;
-    store: z.ZodOptional<z.ZodString>;
-    winePrefixPath: z.ZodOptional<z.ZodString>;
-    steamShortcutId: z.ZodOptional<z.ZodNumber>;
-  }, "strip", z.ZodTypeAny, {
-    umuId: string;
-    dllOverrides?: string[] | undefined;
-    protonVersion?: string | undefined;
-    store?: string | undefined;
-    winePrefixPath?: string | undefined;
-    steamShortcutId?: number | undefined;
-  }, {
-    umuId: string;
-    dllOverrides?: string[] | undefined;
-    protonVersion?: string | undefined;
-    store?: string | undefined;
-    winePrefixPath?: string | undefined;
-    steamShortcutId?: number | undefined;
-  }>>;
-  /**
-   * Redistributables to install (for backward compatibility)
-   */
-  redistributables: z.ZodOptional<z.ZodArray<z.ZodObject<{
-    name: z.ZodString;
-    path: z.ZodString;
-  }, "strip", z.ZodTypeAny, {
-    name: string;
-    path: string;
-  }, {
-    name: string;
-    path: string;
-  }>, "many">>;
-}, "strip", z.ZodTypeAny, {
-  name: string;
-  version: string;
-  cwd: string;
-  appID: number;
-  launchExecutable: string;
-  capsuleImage: string;
-  storefront: string;
-  addonsource: string;
-  coverImage: string;
-  launchArguments?: string | undefined;
-  launchEnv?: Record<string, string> | undefined;
-  titleImage?: string | undefined;
-  umu?: {
-    umuId: string;
-    dllOverrides?: string[] | undefined;
-    protonVersion?: string | undefined;
-    store?: string | undefined;
-    winePrefixPath?: string | undefined;
-    steamShortcutId?: number | undefined;
-  } | undefined;
-  redistributables?: {
-    name: string;
-    path: string;
-  }[] | undefined;
-}, {
-  name: string;
-  version: string;
-  cwd: string;
-  appID: number;
-  launchExecutable: string;
-  capsuleImage: string;
-  storefront: string;
-  addonsource: string;
-  coverImage: string;
-  launchArguments?: string | undefined;
-  launchEnv?: Record<string, string> | undefined;
-  titleImage?: string | undefined;
-  umu?: {
-    umuId: string;
-    dllOverrides?: string[] | undefined;
-    protonVersion?: string | undefined;
-    store?: string | undefined;
-    winePrefixPath?: string | undefined;
-    steamShortcutId?: number | undefined;
-  } | undefined;
-  redistributables?: {
-    name: string;
-    path: string;
-  }[] | undefined;
-}>;
-type LibraryInfo = z.infer<typeof ZodLibraryInfo>;
-interface Notification {
-  type: 'warning' | 'error' | 'info' | 'success';
-  message: string;
-  id: string;
-}
+declare const ZodLibraryInfo: z.ZodType<LibraryInfo$1>;
 declare class OGIAddonWSListener {
   private socket;
+  private transport;
   eventEmitter: events.EventEmitter;
   addon: OGIAddon;
   constructor(ogiAddon: OGIAddon, eventEmitter: events.EventEmitter);
@@ -599,10 +217,10 @@ declare class OGIAddonWSListener {
    */
   private handleEventWithResponseNoInput;
   respondToMessage(messageID: string, response: any, originalEvent: EventResponse<any> | undefined): void;
-  waitForResponseFromServer<T>(messageID: string): Promise<T>;
-  send(event: OGIAddonClientSentEvent, args: ClientSentEventTypes[OGIAddonClientSentEvent]): string;
+  requestResponse<T>(event: AddonClientToServerEventName$1, args: AddonClientToServerEventArgs$1[AddonClientToServerEventName$1]): Promise<T>;
+  send(event: AddonClientToServerEventName$1, args: AddonClientToServerEventArgs$1[AddonClientToServerEventName$1]): string;
   close(): void;
 }
 //#endregion
-export { BasicLibraryInfo, CatalogCarouselItem, CatalogResponse, CatalogSection, CatalogWithCarousel, ClientSentEventTypes, Configuration, ConfigurationBuilder, EventListenerTypes, EventResponse, LibraryInfo, OGIAddonClientSentEvent, OGIAddonConfiguration, OGIAddonEvent, OGIAddonServerSentEvent, type SearchResult, SearchTool, SetupEventResponse, StoreData, Task, UmuId, VERSION, WebsocketMessageClient, WebsocketMessageServer, ZodLibraryInfo, OGIAddon as default, extraction };
+export { type AddonClientToServerEventArgs, type AddonClientToServerEventName, type AddonClientToServerWebsocketMessage, type AddonNotificationMessage, type AddonProtocolEventListenerTypes, type AddonSDKLifecycleEventListenerTypes, type AddonServerHostEventListeners, type AddonServerHostEventName, type AddonServerLifecycleEvent, type AddonServerToClientEventName, type AddonServerToClientWebsocketMessage, type BasicLibraryInfo$1 as BasicLibraryInfo, type CatalogCarouselItem, type CatalogResponse, type CatalogSection, type CatalogWithCarousel, Configuration, ConfigurationBuilder, type ConfigurationFile, type ConfigurationOptionType, type ConfigurationOptionWire, EventListenerTypes, EventResponse, type LibraryInfo, Notification, type OGIAddonConfiguration, type OGIAddonSDKEventListener, type SearchResult, SearchTool, type SetupCommandData, type SetupEventResponse, type SetupResponse, type StoreData, Task, type TaskRunMessageArgs, type UmuId, VERSION, ZodLibraryInfo, OGIAddon as default, extraction };
 //# sourceMappingURL=main.d.cts.map