@overlayed/app 0.9.1 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -61,6 +61,12 @@ declare type Brand<Base, Branding, ReservedName extends string = "__type__"> = B
61
61
  [K in ReservedName]: Branding;
62
62
  } & { __witness__: Base };
63
63
 
64
+ declare interface CortexEvents extends Record<string, unknown> {
65
+ }
66
+
67
+ declare interface CortexLogs extends Record<string, unknown> {
68
+ }
69
+
64
70
  declare type CustomLoggerScope = ReturnType<typeof Logger.prototype.scope>;
65
71
 
66
72
  declare type ErrorEvents = ErrorPipeServerError | ErrorInvalidConfigFile;
@@ -204,6 +210,7 @@ export declare type OverlayedApp<TModule extends GameModule, TKeybind extends st
204
210
  windows: OverlayedAppWindowsModule;
205
211
  input: OverlayedAppInputModule;
206
212
  ads: OverlayedAppAdsModule;
213
+ cortex: OverlayedAppCortexModule;
207
214
  /**
208
215
  * Returns true if any monitored processes are running.
209
216
  *
@@ -228,7 +235,16 @@ export declare type OverlayedApp<TModule extends GameModule, TKeybind extends st
228
235
  };
229
236
 
230
237
  declare interface OverlayedAppAdsModule {
231
- registerWindow(window: BrowserWindow, electron: electron): void;
238
+ registerWindow(window: BrowserWindow, options?: {
239
+ linkHandler?: {
240
+ allowHosts?: string[];
241
+ };
242
+ }): void;
243
+ }
244
+
245
+ declare interface OverlayedAppCortexModule {
246
+ trackEvent: <TEventName extends keyof CortexEvents>(name: TEventName, data: CortexEvents[TEventName]) => void;
247
+ trackLog: <TEventName extends keyof CortexLogs>(name: TEventName, data: CortexLogs[TEventName]) => void;
232
248
  }
233
249
 
234
250
  declare type OverlayedAppGameModules<TModule extends GameModule> = {
@@ -381,11 +397,9 @@ declare interface OverlayedOptions<TModule extends GameModule, TKeybind extends
381
397
  */
382
398
  electron: electron;
383
399
  /**
384
- * The app name.
385
- *
386
- * TODO: replace with endpoint to get app name from server.
400
+ * The application id, this can be found in the [Overlayed Dashboard](https://dashboard.overlayed.gg/settings/applications).
387
401
  */
388
- appName: string;
402
+ applicationId: string;
389
403
  /**
390
404
  * App modules to load.
391
405
  */