@overlayed/app 0.36.3 → 1.0.1

package/dist/index.d.mts

@@ -2,8 +2,10 @@ import * as arktype0 from "arktype";
 import { Module, Type } from "arktype";
 import EventEmitter$1 from "events";
 import "xior";
+import JSZip from "jszip";
 import * as electron0 from "electron";
 import { BrowserWindow, BrowserWindowConstructorOptions } from "electron";
+import { CancellationToken, ProgressInfo, ProgressInfo as ProgressInfo$1, UpdateCheckResult, UpdateCheckResult as UpdateCheckResult$1, UpdateDownloadedEvent, UpdateInfo } from "electron-updater";
 import * as arktype_internal_variants_object_ts0 from "arktype/internal/variants/object.ts";
 import { KeyboardKeyEvent, MouseButtonEvent, RenderInterface, RenderInterface as RenderInterface$1, RenderWindow, RenderWindow as RenderWindow$1, RenderWindowConstructorOptions, RenderWindowConstructorOptions as RenderWindowConstructorOptions$1, VirtualKey, VirtualKey as VirtualKey$1, WindowEvent } from "@overlayed-gg/render-interface";
 
@@ -247,11 +249,12 @@ type EventCallback<TEvent extends BaseEvent, TEventType extends EventType<TEvent
 //#endregion
 //#region src/managers/manager.d.ts
 /** This should be kept in sync with EventEmitterManager */
-declare class Manager {
+declare class Manager<O extends Record<string, any> = {}> {
+  protected options: O | null;
   protected logger: CustomLoggerScope;
   initialized: boolean;
   constructor(name: string);
-  init(): void;
+  init(options?: O): void;
   destroy(): void;
 }
 //#endregion
@@ -273,10 +276,14 @@ declare const KeybindSchema: arktype_internal_variants_object_ts0.ObjectType<{
 type KeybindSchemaEntry = (typeof KeybindSchema.infer)[string];
 //#endregion
 //#region ../api/dist/index.d.ts
+
+//#endregion
+//#region src/endpoints/modules/releases.d.ts
+type ReleaseId = Brand<string, "release_id">;
+declare const ReleaseId: Brander<Brand<string, "release_id">>;
 type FeedbackType = "suggestion" | "bug_report";
 interface FeedbackRequestDataModel {
-  app_version: string;
-  app_channel: string;
+  release_id?: ReleaseId;
   type: FeedbackType;
   cortex_user_id: string;
   email?: string;
@@ -318,9 +325,6 @@ interface NoticeModel {
 }
 type NoticeId = NoticeModel["id"];
 //#endregion
-//#region src/instances.d.ts
-declare function setUpdaterTokenResolver(newTokenResolver: () => string | undefined): void;
-//#endregion
 //#region src/managers/gameLaunchManager.d.ts
 type GameReadyEvent = {
   game: string;
@@ -433,6 +437,37 @@ declare function module(): {
 //#endregion
 //#region src/events/loggedIn.d.ts
 //#endregion
+//#region src/managers/updateManager/updateManager.d.ts
+type UpdateManagerEvents = {
+  error: {
+    error: Error;
+    message?: string;
+  };
+  checkingForUpdates: {};
+  updateNotAvailable: {
+    info: UpdateInfo;
+  };
+  updateAvailable: {
+    info: UpdateInfo;
+  };
+  updateDownloaded: {
+    event: UpdateDownloadedEvent;
+  };
+  updateCancelled: {
+    info: UpdateInfo;
+  };
+  downloadProgress: {
+    info: ProgressInfo$1;
+  };
+  /**
+   * Emitted when the access token fetcher returns an invalid token.
+   *
+   * We strongly recommend logging the user out in this case, as it likely means
+   * their account no longer has access to the private channel.
+   */
+  authTokenInvalid: {};
+};
+//#endregion
 //#region src/utilities/types.d.ts
 type UniversalGameModule = ReturnType<typeof module>;
 type OverlayedAppGameModules<TModule extends GameModule> = { [TKey in TModule["key"]]: OverlayedAppGameModuleListeners<TModule, TKey> } & { [TKey in UniversalGameModule["key"]]: OverlayedAppGameModuleListeners<UniversalGameModule, TKey> };
@@ -536,8 +571,31 @@ type ActiveGameInfo = {
   };
 };
 interface OverlayedAppWindowsModule extends Pick<RenderInterface$1, "on" | "off" | "once" | "addListener" | "prependListener" | "prependOnceListener" | "removeListener" | "removeAllListeners"> {
+  /**
+   * Returns the production site url configured in the [Overlayed Dashboard](https://overlay.dev/settings).
+   *
+   * @returns The production site url.
+   */
+  getProductionSiteUrl: () => URL;
+  /**
+   * Creates a new window. All windows must be created with this method.
+   *
+   * @param options The options for the window.
+   * @returns The created window.
+   */
   createWindow(options: BrowserWindowConstructorOptions): BrowserWindow;
+  /**
+   * Creates a new in-game window. All in-game windows must be created with this method.
+   *
+   * @param options The options for the window.
+   * @returns The created window.
+   */
   createInGameWindow(options: RenderWindowConstructorOptions$1): RenderWindow$1;
+  /**
+   * Returns information about the currently active game.
+   *
+   * @returns The active game info.
+   */
   getActiveGameInfo: () => ActiveGameInfo;
 }
 type OverlayedAppInputModuleRaw = {
@@ -607,6 +665,12 @@ interface OverlayedAppLoggingModuleSubmitFeedbackOptions {
    * The key is the name of the file, and the value is the content of the file.
    */
   additionalFiles?: Record<string, string>;
+  /**
+   * When true, silences logs
+   *
+   * @default false
+   */
+  silent?: boolean;
 }
 /**
  * The logging module.
@@ -658,6 +722,20 @@ interface OverlayedAppLoggingModule {
    * @returns The unique feedback identifier, or undefined if the request fails.
    */
   submitFeedback: (type: FeedbackType, info: OverlayedAppLoggingModuleSubmitFeedbackInfo, options?: OverlayedAppLoggingModuleSubmitFeedbackOptions) => Promise<FeedbackId | undefined>;
+  /**
+   * Get the zip of logs sent via the submitFeedback method.
+   *
+   * ```ts
+   * const zip = overlayed.logger.getLogsZip();
+   *
+   * // prep to send off to a server
+   * const zipBase64 = await zip.generateAsync({ type: "base64" });
+   * ```
+   *
+   * @param options - The options to include in the zip.
+   * @returns Returns a zip of app and overlayed logs, and any additional files you provide.
+   */
+  getLogsZip: (options?: OverlayedAppLoggingModuleSubmitFeedbackOptions) => JSZip;
 }
 type OverlayedAppNoticeHandlerMapping = {
   /**
@@ -702,6 +780,140 @@ interface OverlayedAppNoticesModule {
    */
   getNotices: () => NoticeModel[];
 }
+type OverlayedAppUpdateHandlerMapping = { [K in keyof UpdateManagerEvents]: (data: UpdateManagerEvents[K]) => void };
+interface OverlayedAppUpdateModule {
+  site: OverlayedAppSiteModule;
+  on: <TEvent extends keyof OverlayedAppUpdateHandlerMapping = keyof OverlayedAppUpdateHandlerMapping>(event: TEvent, cb: OverlayedAppUpdateHandlerMapping[TEvent]) => void;
+  off: <TEvent extends keyof OverlayedAppUpdateHandlerMapping = keyof OverlayedAppUpdateHandlerMapping>(event: TEvent, cb: OverlayedAppUpdateHandlerMapping[TEvent]) => void;
+  /**
+   * Checks for updates.
+   * @returns Promise<UpdateCheckResult | null>
+   */
+  checkForUpdates: () => Promise<UpdateCheckResult$1 | null>;
+  /**
+   * Sets the function to fetch the access token.
+   * This function should return the access token or null if the channel is public.
+   *
+   * @param accessTokenFetcher - The function to fetch the access token. Optionally pass the new channel to fetch the access token for.
+   */
+  setAccessTokenFetcher: (accessTokenFetcher: (newChannel: string) => Promise<string | null>) => void;
+  /**
+   * Switches the channel for the next checkForUpdates call.
+   *
+   * Example code:
+   *
+   * ```ts
+   * function changeChannel(newChannel: string) {
+   * 	await overlayed.updater.switchChannel(newChannel);
+   * 	await overlayed.updater.checkForUpdates();
+   * }
+   * ```
+   *
+   * @param channel - The channel to switch to.
+   */
+  switchChannel: (channel: string) => Promise<UpdateCheckResult$1 | null>;
+  /**
+   * Restarts the app and installs the update after it has been downloaded.
+   * It should only be called after `update-downloaded` has been emitted.
+   *
+   * **Note:** `autoUpdater.quitAndInstall()` will close all application windows first and only emit `before-quit` event on `app` after that.
+   * This is different from the normal quit event sequence.
+   *
+   * @param isSilent *windows-only* Runs the installer in silent mode. Defaults to `false`.
+   * @param isForceRunAfter Run the app after finish even on silent install. Not applicable for macOS.
+   * Ignored if `isSilent` is set to `false`(In this case you can still set `autoRunAppAfterInstall` to `false` to prevent run the app after finish).
+   *
+   * @throws Error if `canUpdate` is false.
+   */
+  quitAndInstall: (isSilent?: boolean, isForceRunAfter?: boolean) => void;
+  /**
+   * Checks if the user can update.
+   *
+   * @example
+   * ```ts
+   * const [canUpdate, denialReason] = overlayed.updater.canUpdate();
+   * ```
+   *
+   * @returns `[true, null]` if the user can update, `[false, reason]` if the user cannot update.
+   *
+   * Reasons:
+   *   	- "User is in game"
+   */
+  canUpdate: () => [true, null] | [false, string];
+  /**
+   * Start downloading update manually. Use when `autoDownload` is false or to manually trigger download after `checkForUpdates`.
+   *
+   * @param cancellationToken - Optional token to cancel the download.
+   * @returns Promise resolving to paths of downloaded files.
+   */
+  downloadUpdate: (cancellationToken?: CancellationToken) => Promise<Array<string>>;
+}
+interface OverlayedAppApplicationModule {
+  /**
+   * Get the application channel.
+   * @returns string
+   */
+  getChannel: () => string;
+  /**
+   * Get the application version.
+   * @returns string
+   */
+  getVersion: () => string;
+  /**
+   * Get the application release id.
+   * @returns string | null
+   */
+  getReleaseId: () => string | null;
+}
+type OverlayedAppSiteHandlerMapping = {
+  /**
+   * Emitted when a new site version is available.
+   *
+   * @example
+   * ```ts
+   * overlayed.site.on("siteUpdateReady", () => {
+   *   showUserSiteUpdateButton();
+   * });
+   *
+   * onUserClickSiteUpdateButton(() => {
+   *   overlayed.site.allowSiteUpdateOnNextLoad();
+   *   allWindows.forEach((window) => {
+   *     window.webContents.reload();
+   *   });
+   * });
+   *
+   * @param data - releaseId and version
+   * @returns
+   */
+  siteUpdateReady: (data: {
+    releaseId: ReleaseId;
+    version: string;
+  }) => void;
+};
+interface OverlayedAppSiteModule {
+  on: <TEvent extends keyof OverlayedAppSiteHandlerMapping = keyof OverlayedAppSiteHandlerMapping>(event: TEvent, cb: OverlayedAppSiteHandlerMapping[TEvent]) => void;
+  off: <TEvent extends keyof OverlayedAppSiteHandlerMapping = keyof OverlayedAppSiteHandlerMapping>(event: TEvent, cb: OverlayedAppSiteHandlerMapping[TEvent]) => void;
+  /**
+   * If an update is available, the next time BrowserWindow#loadURL is called, the new site version will be used.
+   *
+   * Must be called only after `siteUpdateReady` has been emitted.
+   *
+   * @example
+   * ```ts
+   * overlayed.site.on("siteUpdateReady", () => {
+   *   showUserSiteUpdateButton();
+   * });
+   *
+   * onUserClickSiteUpdateButton(() => {
+   *   overlayed.site.allowSiteUpdateOnNextLoad();
+   *   allWindows.forEach((window) => {
+   *     window.webContents.reload();
+   *   });
+   * });
+   * ```
+   */
+  allowSiteUpdateOnNextLoad: () => void;
+}
 type OverlayedApp<TModule extends GameModule, TKeybind extends string> = OverlayedAppGameModules<TModule> & OverlayedAppHandlers & {
   keybinds: OverlayedAppKeybindModule<TKeybind>;
   windows: OverlayedAppWindowsModule;
@@ -710,6 +922,8 @@ type OverlayedApp<TModule extends GameModule, TKeybind extends string> = Overlay
   cortex: OverlayedAppCortexModule;
   log: OverlayedAppLoggingModule;
   notices: OverlayedAppNoticesModule;
+  updater: OverlayedAppUpdateModule;
+  application: OverlayedAppApplicationModule;
   /**
    * Returns true if any monitored processes are running.
    *
@@ -778,16 +992,6 @@ interface OverlayedOptions<TModule extends GameModule, TKeybind extends string>
    * @default false
    */
   universal?: boolean;
-  /**
-   * @deprecated
-   */
-  channel?: string;
-  /**
-   * The version of the app.
-   *
-   * @deprecated
-   */
-  version?: string;
   /**
    * When true, the overlay will be loaded in debug mode.
    *
@@ -800,12 +1004,23 @@ interface OverlayedOptions<TModule extends GameModule, TKeybind extends string>
    * @default true
    */
   silent?: boolean;
+  /**
+   * Site module configuration.
+   */
+  site?: {
+    /**
+     * When true, users will not update automatically when a new site version is available.
+     *
+     * If you'd prefer users to have to click an "update" button when a new site version,
+     * set this to true.
+     *
+     * @default false
+     */
+    manualUpdates?: boolean;
+  };
 }
 //#endregion
 //#region src/utilities/overlayed.d.ts
 declare function overlayed<TModule extends GameModule, TShortcut extends string>(optionsRaw: OverlayedOptions<TModule, TShortcut>): OverlayedApp<TModule, TShortcut>;
 //#endregion
-//#region src/managers/nativeModuleManager.d.ts
-declare function setFetchLatestTokenCallback(newFetchLatestToken: () => Promise<unknown> | undefined): void;
-//#endregion
-export { type ActiveGameInfo, type BundleAppConfig, type BundleSiteConfig, type ErrorEvents, type FatalEvents, type FeedbackId, type FeedbackType, type GameCloseEvent, type GameLaunchEvent, type GameReadyEvent, type KeybindSchemaEntry as KeybindConfig, type KeyboardKeyEvent, type LoggerScope, type MouseButtonEvent, type NoticeId, type NoticeModel, type NoticeType, type OverlayedApp, type OverlayedConfig, type OverridesManagerScope, RenderInterface, type RenderWindow, type RenderWindowConstructorOptions, VirtualKey, type WarningEvents, type WindowEvent, defineConfig, overlayed, setFetchLatestTokenCallback, setUpdaterTokenResolver };
+export { type ActiveGameInfo, type BundleAppConfig, type BundleSiteConfig, type ErrorEvents, type FatalEvents, type FeedbackId, type FeedbackType, type GameCloseEvent, type GameLaunchEvent, type GameReadyEvent, type KeybindSchemaEntry as KeybindConfig, type KeyboardKeyEvent, type LoggerScope, type MouseButtonEvent, type NoticeId, type NoticeModel, type NoticeType, type OverlayedApp, type OverlayedConfig, type OverridesManagerScope, type ProgressInfo, RenderInterface, type RenderWindow, type RenderWindowConstructorOptions, type UpdateCheckResult, VirtualKey, type WarningEvents, type WindowEvent, defineConfig, overlayed };