@decky/ui 4.9.2 → 4.10.0

package/src/globals/steam-client/User.ts

@@ -0,0 +1,266 @@
+import { EResult, OperationResponse, Unregisterable } from "./shared";
+
+export interface User {
+    AuthorizeMicrotxn(txnId: number | string): void;
+
+    CancelLogin(): void;
+
+    CancelMicrotxn(txnId: number | string): void;
+
+    /**
+     * Tries to cancel Steam shutdown.
+     * @remarks Used in the "Shutting down" dialog.
+     */
+    CancelShutdown(): void;
+
+    /**
+     * Opens the "Change Account" dialog.
+     */
+    ChangeUser(): void;
+
+    Connect(): Promise<OperationResponse>;
+
+    FlipToLogin(): void;
+
+    /**
+     * Forces a shutdown while shutting down.
+     * @remarks Used in the "Shutting down" dialog.
+     */
+    ForceShutdown(): void;
+
+    /**
+     * Forgets an account's password.
+     * @param accountName Login of the account to forget.
+     * @returns a boolean indicating whether the operation succeeded or not.
+     */
+    ForgetPassword(accountName: string): Promise<boolean>;
+
+    /**
+     * Gets your country code.
+     * @returns a string containing your country code.
+     */
+    GetIPCountry(): Promise<string>;
+
+    /**
+     * @todo param0 mirrors param3 of {@link RegisterForLoginStateChange}
+     */
+    GetLoginProgress(callback: (param0: number, param1: number) => void): Unregisterable;
+
+    GetLoginUsers(): Promise<LoginUser[]>;
+
+    GoOffline(): void;
+
+    GoOnline(): void;
+
+    OptOutOfSurvey(): void;
+
+    PrepareForSystemSuspend(): Promise<{
+        result: EResult;
+    }>;
+
+    Reconnect(): void;
+
+    RegisterForConnectionAttemptsThrottled(callback: (data: ConnectionAttempt) => void): Unregisterable;
+
+    RegisterForCurrentUserChanges(callback: (user: CurrentUser) => void): void;
+
+    RegisterForLoginStateChange(
+        callback: (
+            /**
+             * Empty if not logged in.
+             */
+            accountName: string,
+            state: ELoginState,
+            result: EResult,
+            param3: number,
+            percentage: number,
+            /**
+             * @todo name is from CLoginStore, but it's always empty, unused ?
+             */
+            emailDomain: string,
+        ) => void
+    ): Unregisterable;
+
+    RegisterForPrepareForSystemSuspendProgress(callback: (progress: SuspendProgress) => void): Unregisterable;
+
+    RegisterForResumeSuspendedGamesProgress(callback: (progress: SuspendProgress) => void): Unregisterable;
+
+    RegisterForShowHardwareSurvey(callback: () => void): Unregisterable;
+
+    /**
+     * Register a function to be executed when shutdown completes.
+     * @param callback The function to be executed on completion.
+     */
+    RegisterForShutdownDone(callback: (state: EShutdownStep, appid: number, param2: boolean) => void): Unregisterable;
+
+    RegisterForShutdownFailed(callback: (state: EShutdownStep, appid: number, success: boolean) => void): Unregisterable;
+
+    /**
+     * Register a function to be executed when Steam starts shutting down.
+     * @param callback The function to be executed on shutdown start.
+     */
+    RegisterForShutdownStart(callback: (param0: boolean) => void): Unregisterable;
+
+    /**
+     * Register a function to be executed when shutdown state changes.
+     * @param callback The function to be executed on change.
+     */
+    RegisterForShutdownState(callback: (state: EShutdownStep, appid: number, allowForceQuit: boolean) => void): Unregisterable;
+
+    /**
+     * Removes an account from remembered users.
+     * @param accountName The account to remove.
+     */
+    RemoveUser(accountName: string): void;
+
+    RequestSupportSystemReport(reportId: string): Promise<{
+        bSuccess: boolean;
+    }>;
+
+    ResumeSuspendedGames(param0: boolean): Promise<ResumeSuspendedGamesResult>;
+
+    // Hardware survey information
+    RunSurvey(callback: (surveySections: SurveySection[]) => void): void;
+
+    SendSurvey(): void;
+
+    SetAsyncNotificationEnabled(appId: number, enable: boolean): void;
+
+    /**
+     * Sets given login credentials, but don't log in to that account.
+     * @param accountName Account name.
+     * @param password Account password.
+     * @param rememberMe Whether to remember that account.
+     */
+    SetLoginCredentials(accountName: string, password: string, rememberMe: boolean): void;
+
+    SetOOBEComplete(): void;
+
+    ShouldShowUserChooser(): Promise<boolean>;
+
+    /**
+     * Signs out and restarts Steam.
+     */
+    SignOutAndRestart(): void;
+
+    /**
+     * Relogin after disabling offline mode. Not sure what else it's useful for,
+     * there isn't even a single mention of it in steam's js, lol
+     */
+    StartLogin(): void;
+
+    /**
+     * Toggles offline mode.
+     *
+     * Note that after disabling offline mode, you have to relogin with
+     * {@link StartLogin}.
+     */
+    StartOffline(value: boolean): void;
+
+    /**
+     * Restarts the Steam client.
+     *
+     * @todo I don't remember what the arg is, but IIRC with `true` it disables
+     * some ldd check or whatever, really it's only noticeable on slow PCs.
+     */
+    StartRestart(force: boolean): void;
+
+    /**
+     * @todo I don't remember what the arg is, but IIRC with `true` it disables
+     * some ldd check or whatever, really it's only noticeable on slow PCs.
+     */
+    StartShutdown(force: boolean): void;
+}
+
+export interface ConnectionAttempt {
+    rtCooldownExpiration: number;
+}
+
+export interface CurrentUser {
+    NotificationCounts: {
+        async_game_updates: number;
+        comments: number;
+        gifts: number;
+        help_request_replies: number;
+        inventory_items: number;
+        invites: number;
+        moderator_messages: number;
+        offline_messages: number;
+        trade_offers: number;
+    };
+    bHWSurveyPending: boolean;
+    bIsLimited: boolean;
+    bIsOfflineMode: boolean;
+    bPromptToChangePassword: boolean;
+    bSupportAckOnlyMessages: boolean;
+    bSupportAlertActive: boolean;
+    bSupportPopupMessage: boolean;
+    clientinstanceid: string;
+    strAccountBalance: string;
+    strAccountBalancePending: string;
+    strAccountName: string;
+    strFamilyGroupID: string;
+    strSteamID: string;
+}
+
+export enum ELoginState {
+    None,
+    WelcomeDialog,
+    WaitingForCreateUser,
+    WaitingForCredentials,
+    WaitingForNetwork,
+    WaitingForServerResponse,
+    WaitingForLibraryReady,
+    Success,
+    Quit,
+}
+
+export enum EShutdownStep {
+  None,
+  Start,
+  WaitForGames,
+  WaitForCloud,
+  FinishingDownload,
+  WaitForDownload,
+  WaitForServiceApps,
+  WaitForLogOff,
+  Done,
+  // TODO: RegisterForShutdownDone outputs 9 here
+}
+
+export enum ESuspendResumeProgressState {
+  Invalid,
+  Complete,
+  CloudSync,
+  LoggingIn,
+  WaitingForApp,
+  Working,
+}
+
+export interface LoginUser {
+    personaName: string;
+    accountName: string;
+    hasPin: boolean;
+    rememberPassword: boolean;
+    avatarUrl: string;
+}
+
+export interface ResumeSuspendedGamesResult {
+  nAppIDPlayingElsewhere: number;
+  result: EResult;
+}
+
+export interface SuspendProgress {
+  bGameSuspended: boolean;
+  state: ESuspendResumeProgressState;
+}
+
+export interface SurveyEntry {
+    strName: string;
+    vecArgs: string[];
+}
+
+export interface SurveySection {
+    strSectionName: string;
+    vecEntries: SurveyEntry[];
+}

package/src/globals/steam-client/WebChat.ts

@@ -0,0 +1,164 @@
+import {OverlayBrowserInfo} from "./Overlay";
+import { EResult, EUIMode, Unregisterable } from "./shared";
+
+export interface WebChat {
+    BSuppressPopupsInRestore(): Promise<boolean>;
+
+    /**
+     * Gets your Steam3 ID.
+     * @returns a Steam3 ID.
+     */
+    GetCurrentUserAccountID(): Promise<number>;
+
+    /**
+     * Gets the current user's 64x64 avatar as a data URL.
+     * @returns the data URL.
+     */
+    GetLocalAvatarBase64(): Promise<string>;
+
+    /**
+     * Gets the current user's nickname.
+     * @returns the nickname.
+     */
+    GetLocalPersonaName(): Promise<string>;
+
+    GetOverlayChatBrowserInfo(): Promise<OverlayBrowserInfo[]>;
+
+    // param0 - appid ?
+    GetPrivateConnectString(param0: number): Promise<string>;
+
+    /**
+     * Gets information about push-to-Talk.
+     * @returns
+     */
+    GetPushToTalkEnabled(): Promise<PushToTalkInfo>;
+
+    /**
+     * Gets the "Sign in to friends when Steam starts" option value.
+     * @returns a boolean indicating whether the option is enabled or not.
+     */
+    GetSignIntoFriendsOnStart(): Promise<boolean>;
+
+    /**
+     * Retrieves the current UI mode.
+     * @returns the current UI mode.
+     */
+    GetUIMode(): Promise<EUIMode>;
+
+    OnGroupChatUserStateChange(chatGroupId: number, accountId: number, action: number): void;
+
+    OnNewGroupChatMsgAdded(
+        groupId: string,
+        chatId: string,
+        accountId: number,
+        timestamp: number,
+        param4: number,
+        message: string,
+    ): void;
+
+    /**
+     * Opens a provided URL in the Steam client. Does NOT work on desktop mode -
+     * will open in default web browser instead!
+     * @param url The URL to open.
+     */
+    OpenURLInClient(url: string, pid: number, forceExternal: boolean): void;
+
+    /**
+     * Registers a callback function to be called when the computer's active state changes.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     * @todo Changes to 2 after 10 seconds?
+     * @todo Does not affect the keyboard?
+     */
+    RegisterForComputerActiveStateChange(
+        callback: (state: EComputerActiveState, time: number) => void,
+    ): Unregisterable;
+
+    /**
+     * @todo WebChat.ShowFriendChatDialog does this.
+     */
+    RegisterForFriendPostMessage(callback: (data: FriendChatDialogData) => void): Unregisterable;
+
+    /**
+     * To unregister, use {@link UnregisterForMouseXButtonDown}.
+     */
+    RegisterForMouseXButtonDown(callback: (param0: number) => void): void;
+
+    /**
+     * Registers a callback function to be called when the push-to-talk state changes.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForPushToTalkStateChange(callback: (state: boolean) => void): Unregisterable;
+
+    /**
+     * Registers a callback function to be called when the UI mode is changed.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForUIModeChange(callback: (mode: EUIMode) => void): Unregisterable;
+
+    RegisterOverlayChatBrowserInfoChanged(callback: () => void): Unregisterable;
+
+    SetActiveClanChatIDs(clanChatIds: number[]): void;
+
+    SetNumChatsWithUnreadPriorityMessages(size: number): void;
+
+    SetPersonaName(value: string): Promise<SetPersonaNameResult>;
+
+    SetPushToMuteEnabled(value: boolean): void;
+
+    SetPushToTalkEnabled(value: boolean): void;
+
+    SetPushToTalkHotKey(param0: number): void;
+
+    SetPushToTalkMouseButton(param0: number): void;
+
+    SetVoiceChatActive(value: boolean): void;
+    SetVoiceChatStatus(muted: boolean, deafened: boolean): void;
+    ShowChatRoomGroupDialog(param0: number, param1: number): void;
+
+    ShowFriendChatDialog(steamid64: string): void;
+
+    UnregisterForMouseXButtonDown(): void;
+}
+
+export enum EComputerActiveState {
+    Invalid,
+    Active,
+    Idle,
+}
+
+export interface FriendChatDialog {
+    browserid: number;
+    btakefocus: string;
+    command: string;
+    pid: number;
+    steamid: string;
+}
+
+export interface FriendChatDialogData {
+    data: FriendChatDialog;
+}
+
+interface SetPersonaNameResult {
+    eResult: EResult;
+    /**
+     * Localization token. Empty if success.
+     */
+    strMessageToken: string;
+}
+
+export interface PushToTalkInfo {
+    /** Indicates whether push-to-talk is enabled. */
+    bEnabled: boolean;
+    /** Indicates whether push-to-mute is in use instead. */
+    bPushToMute: boolean;
+    /**
+     * Push-to-talk hotkey.
+     * @todo enum? this is not EHIDKeyboardKey
+     */
+    vkHotKey: number;
+    /** Push-to-talk hotkey name. */
+    strKeyName: string;
+}

package/src/globals/steam-client/WebUITransport.ts

@@ -0,0 +1,21 @@
+import { OperationResponse } from "./shared";
+
+export interface WebUITransport {
+    GetTransportInfo(): Promise<TransportInfo>;
+
+    /**
+     * Tells Steam the websocket failed and opens a troubleshooting dialog.
+     *
+     * The responsible message for this is `CMsgWebUITransportFailure`.
+     *
+     * @param base64 Serialized ProtoBuf message.
+     */
+    NotifyTransportFailure(base64: string): Promise<OperationResponse>;
+}
+
+export interface TransportInfo {
+    authKeyClientdll: string;
+    authKeySteamUI: string;
+    portClientdll: number;
+    portSteamUI: number;
+}

package/src/globals/steam-client/Window.ts

@@ -0,0 +1,235 @@
+import { EUIComposition } from "./shared";
+
+/**
+ * Represents functionality for managing Steam's windows.
+ *
+ * "Restore details" here refers to a string that is similiar to
+ * `1&x=604&y=257&w=1010&h=600`, which is usable with certain
+ * `window.open()` parameters and methods from here.
+ *
+ * Note that methods here have to be called from the
+ * window you want to use (not SharedJSContext).
+ */
+export interface Window {
+    BringToFront(forceOS?: EWindowBringToFront): void;
+
+    /**
+     * Closes the window.
+     */
+    Close(): void;
+
+    /**
+     * @returns the window's fullscreen state.
+     */
+    DefaultMonitorHasFullscreenWindow(): Promise<boolean>;
+
+    /**
+     * Flashes the window in the taskbar.
+     */
+    FlashWindow(): void;
+
+    GetDefaultMonitorDimensions(): Promise<MonitorDimensions>;
+
+    /**
+     * @returns the mouse position's restore details.
+     */
+    GetMousePositionDetails(): Promise<string>;
+
+    /**
+     * @returns the window's details.
+     */
+    GetWindowDetails(): Promise<WindowDetails>;
+
+    /**
+     * @returns the window's dimensions.
+     */
+    GetWindowDimensions(): Promise<WindowDimensions>;
+
+    /**
+     * @returns the window's restore details.
+     */
+    GetWindowRestoreDetails(): Promise<string>;
+
+    /**
+     * Hides the window.
+     */
+    HideWindow(): void;
+
+    /**
+     * @returns the window's maximized state.
+     */
+    IsWindowMaximized(): Promise<boolean>;
+
+    /**
+     * @returns the window's minimized state.
+     */
+    IsWindowMinimized(): Promise<boolean>;
+
+    MarkLastFocused(): void;
+
+    /**
+     * Minimizes the window.
+     */
+    Minimize(): void;
+
+    /**
+     * Moves the window to given coordinates.
+     * @param x Window X position.
+     * @param y Window Y position.
+     * @param dpi Screen DPI.
+     */
+    MoveTo(x: number, y: number, dpi?: number): void;
+
+    /**
+     * Moves the window to a given location.
+     * @param location Window location.
+     * @param offset X/Y offset.
+     */
+    MoveToLocation(location: WindowLocation_t, offset?: number): void;
+
+    /**
+     * Moves the window relatively to given details.
+     * @param details Window restore details string from {@link GetWindowRestoreDetails}.
+     * @param x Window X position.
+     * @param y Window Y position.
+     * @param width Window width.
+     * @param height Window height.
+     *
+     * @example
+     * Move the window to bottom right by 50 pixels:
+     * ```
+     * SteamClient.Window.GetWindowRestoreDetails((e) => {
+     *     SteamClient.Window.PositionWindowRelative(e, 50, 50, 0, 0);
+     * });
+     * ```
+     */
+    PositionWindowRelative(details: string, x: number, y: number, width: number, height: number): void;
+
+    /**
+     * @returns `true` if yje naun [tpcess od about to shut down.]
+     */
+    ProcessShuttingDown(): Promise<boolean>;
+
+    /**
+     * Resizes the window to given dimension.
+     * The window has to be created with the resizable flag.
+     * @param width Window width.
+     * @param height Window height.
+     * @param applyBrowserScaleOrDPIValue
+     */
+    ResizeTo(width: number, height: number, applyBrowserScaleOrDPIValue: boolean | number): void;
+
+    /**
+     * Moves the window to given details.
+     * @param details Window details string from `Window.GetWindowRestoreDetails`.
+     */
+    RestoreWindowSizeAndPosition(details: string): void;
+
+    SetAutoDisplayScale(value: boolean): void;
+
+    SetComposition(mode: EUIComposition, appIdCompositionQueue: number[], windowId: number): void;
+
+    /**
+     * Makes the window hide, but not close on pressing the close button.
+     * @param value Hide on close?
+     */
+    SetHideOnClose(value: boolean): void;
+
+    SetKeyFocus(value: boolean): void;
+
+    SetManualDisplayScaleFactor(displayScaleFactor: number): void;
+
+    /**
+     * Sets the window's max size.
+     * @param width Window's max width.
+     * @param height Window's max height.
+     */
+    SetMaxSize(width: number, height: number): void;
+
+    /**
+     * Sets the window's min size.
+     * @param width Window's max width.
+     * @param height Window's max height.
+     */
+    SetMinSize(width: number, height: number): void;
+
+    SetModal(value: boolean): void;
+
+    /**
+     * Sets the window's resize grip size.
+     * The window has to be created with the resizable flag for this to take any effect.
+     * @param width Resize grip width.
+     * @param height Resize grip height.
+     */
+    SetResizeGrip(width: number, height: number): void;
+
+    /**
+     * Set the window's icon.
+     * @param icon The window icon to be used.
+     */
+    SetWindowIcon(icon: WindowIcon_t): void;
+
+    /**
+     * Shows the window.
+     */
+    ShowWindow(): void;
+
+    /**
+     * Stops the window's taskbar flashing.
+     */
+    StopFlashWindow(): void;
+
+    /**
+     * Toggles the window's fullscreen state.
+     */
+    ToggleFullscreen(): void;
+
+    /**
+     * Toggles the window's maximized state.
+     */
+    ToggleMaximize(): void;
+}
+
+export enum EWindowBringToFront {
+    Invalid,
+    AndForceOS,
+    WithoutForcingOS,
+}
+
+export type WindowLocation_t =
+    | 'upper-left'
+    | 'lower-left'
+    | 'center-top'
+    | 'center-bottom'
+    | 'upper-right'
+    | 'lower-right';
+
+export type WindowIcon_t = 'steam' | 'messages' | 'voice';
+
+/**
+ * "Usable" here refers to space that is not taken by the taskbar.
+ */
+export interface MonitorDimensions {
+    flHorizontalScale: number;
+    flVerticalScale: number;
+    nFullHeight: number;
+    nFullLeft: number;
+    nFullTop: number;
+    nFullWidth: number;
+    nUsableHeight: number;
+    nUsableLeft: number;
+    nUsableTop: number;
+    nUsableWidth: number;
+}
+
+export interface WindowDetails {
+    bGPUEnabled: boolean;
+    bUnderlaySupported: boolean;
+}
+
+export interface WindowDimensions {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}