@overlayed/app 0.11.0 → 0.12.0

package/dist/index.d.ts

@@ -66,8 +66,6 @@ declare type Brand<Base, Branding, ReservedName extends string = "__type__"> = B
 
 declare interface CortexEvents extends Record<string, unknown> {}
 
-declare interface CortexLogs extends Record<string, unknown> {}
-
 declare type CustomLoggerScope = ReturnType<typeof Logger.prototype.scope>;
 
 declare type ErrorEvents = ErrorPipeServerError | ErrorInvalidConfigFile;
@@ -179,7 +177,15 @@ export interface KeyboardKeyEvent extends WindowEvent {
 	key: VirtualKey;
 }
 
-declare const Logger = AsSingleton(LoggerClass);
+declare const Logger = AsSingleton(LoggerClass, "main.log");
+
+declare interface LoggerScope {
+	scope: (name: string) => LoggerScope;
+	error: (...args: any[]) => void;
+	warn: (...args: any[]) => void;
+	info: (...args: any[]) => void;
+	log: (...args: any[]) => void;
+}
 
 /** This should be kept in sync with EventEmitterManager */
 declare class Manager {
@@ -216,6 +222,7 @@ export declare type OverlayedApp<
 		input: OverlayedAppInputModule;
 		ads: OverlayedAppAdsModule;
 		cortex: OverlayedAppCortexModule;
+		log: OverlayedAppLoggingModule;
 		/**
 		 * Returns true if any monitored processes are running.
 		 *
@@ -251,8 +258,7 @@ declare interface OverlayedAppAdsModule {
 }
 
 declare interface OverlayedAppCortexModule {
-	trackEvent: <TEventName extends keyof CortexEvents>(name: TEventName, data: CortexEvents[TEventName]) => void;
-	trackLog: <TEventName extends keyof CortexLogs>(name: TEventName, data: CortexLogs[TEventName]) => void;
+	track: <TEventName extends keyof CortexEvents>(name: TEventName, data: CortexEvents[TEventName]) => void;
 }
 
 declare type OverlayedAppGameModules<TModule extends GameModule> = {
@@ -438,6 +444,62 @@ declare type OverlayedAppKeybindsConfigKey =
 
 declare type OverlayedAppKeybindsConfigMode = "toggle" | "hold";
 
+declare interface OverlayedAppLoggingModule {
+	/**
+	 * Returns a scoped logging instance. Each message will be prefixed with the scope name.
+	 *
+	 * ```ts
+	 * const scope = overlayed.log.scope("MyScope");
+	 * scope.info("Hello, world!");
+	 * // [2025-07-20 01:51:40.969] [log] [MyScope] Hello, world!
+	 * ```
+	 *
+	 * @param scopeName - The name of the scope.
+	 * @returns The logger scope.
+	 */
+	scope: (scopeName: string) => LoggerScope;
+	info: (message: string) => void;
+	warn: (message: string) => void;
+	error: (message: string) => void;
+	/**
+	 * Submits info you provide, app logs, overlayed logs, and any additional files you provide to be viewed
+	 * in your Overlayed dashboard.
+	 *
+	 * @param info - The information to include in the bug report.
+	 * @param options - The options to include in the bug report.
+	 * @returns The bug report id.
+	 */
+	submitBugReport: (
+		info: OverlayedAppLoggingModuleInfo,
+		options?: OverlayedAppLoggingModuleSubmitBugReportOptions,
+	) => Promise<
+		Result<
+			true,
+			{
+				message: string;
+				error: unknown;
+			}
+		>
+	>;
+}
+
+declare interface OverlayedAppLoggingModuleInfo extends Record<string, string | undefined> {
+	email?: string;
+	username?: string;
+	message?: string;
+	category?: string;
+	version?: string;
+}
+
+declare interface OverlayedAppLoggingModuleSubmitBugReportOptions {
+	/**
+	 * A key value record of additional files to include in the bug report.
+	 *
+	 * The key is the name of the file, and the value is the content of the file.
+	 */
+	additionalFiles?: Record<string, string>;
+}
+
 declare interface OverlayedAppWindowsModule
 	extends Pick<
 		RenderInterface,
@@ -496,6 +558,12 @@ declare interface OverlayedOptions<TModule extends GameModule, TKeybind extends
 	 * @deprecated
 	 */
 	channel?: string;
+	/**
+	 * The version of the app.
+	 *
+	 * @deprecated
+	 */
+	version?: string;
 }
 
 declare class OverridesManager extends Manager {
@@ -647,6 +715,8 @@ export interface RenderWindowConstructorOptions extends Electron.BrowserWindowCo
 	hasCursorOverride?: boolean; // default: true
 }
 
+declare type Result<T, E = string> = [T, undefined] | [undefined, E];
+
 export declare function setFetchLatestTokenCallback(newFetchLatestToken: () => Promise<unknown> | undefined): void;
 
 export declare function setUpdaterTokenResolver(newTokenResolver: () => string | undefined): void;