@overlayed/app 0.8.4 → 0.9.2

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 /// <reference types="electron" />
 /// <reference types="node" />
 
+import { BrowserWindow } from 'electron';
+import { electron } from 'electron';
 import { Module } from 'arktype';
 import { ObjectType } from 'arktype/internal/methods/object.ts';
 import { Out } from 'arktype/internal/attributes.ts';
@@ -201,6 +203,7 @@ export declare type OverlayedApp<TModule extends GameModule, TKeybind extends st
     keybinds: OverlayedAppKeybindModule<TKeybind>;
     windows: OverlayedAppWindowsModule;
     input: OverlayedAppInputModule;
+    ads: OverlayedAppAdsModule;
     /**
      * Returns true if any monitored processes are running.
      *
@@ -224,6 +227,10 @@ export declare type OverlayedApp<TModule extends GameModule, TKeybind extends st
     initialized: boolean;
 };
 
+declare interface OverlayedAppAdsModule {
+    registerWindow(window: BrowserWindow, electron: electron): void;
+}
+
 declare type OverlayedAppGameModules<TModule extends GameModule> = {
     [TKey in TModule["key"]]: {
         onAny<TEvent extends Extract<TModule, {
@@ -361,11 +368,22 @@ declare interface OverlayedAppWindowsModule extends Pick<RenderInterface, "on" |
 
 declare interface OverlayedOptions<TModule extends GameModule, TKeybind extends string> {
     /**
-     * The app name.
+     * The electron instance.
      *
-     * TODO: replace with endpoint to get app name from server.
+     * Must be imported globally like:
+     * ```ts
+     * import { electron } from "electron";
+     * ```
+     * or
+     * ```ts
+     * const electron = require("electron");
+     * ```
      */
-    appName: string;
+    electron: electron;
+    /**
+     * The application id, this can be found in the [Overlayed Dashboard](https://dashboard.overlayed.gg/settings/applications).
+     */
+    applicationId: string;
     /**
      * App modules to load.
      */
@@ -390,6 +408,14 @@ declare interface OverlayedOptions<TModule extends GameModule, TKeybind extends
      * @deprecated
      */
     channel?: string;
+    /**
+     * The app name.
+     *
+     * TODO: replace with endpoint to get app name from server.
+     *
+     * @deprecated This field will be removed in the future.
+     */
+    appName: string;
 }
 
 declare class OverridesManager extends Manager {