@decky/ui 4.9.1 → 4.10.0

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

@@ -0,0 +1,167 @@
+import { Unregisterable } from "./shared";
+import {EAppUpdateError} from "./App";
+
+/**
+ * Represents functions related to Steam Install Folders.
+ */
+export interface InstallFolder {
+    /**
+     * Adds a Steam Library folder to the Steam client.
+     * @param path The path of the Steam Library folder to be added.
+     * @returns the index of the added folder.
+     */
+    AddInstallFolder(path: string): Promise<number>;
+
+    /**
+     * Opens the file explorer to browse files in a specific Steam Library folder.
+     * @param folderIndex The index of the folder to be opened.
+     */
+    BrowseFilesInFolder(folderIndex: number): void;
+
+    /**
+     * Cancels the current move operation for moving game content.
+     */
+    CancelMove(): void;
+
+    /**
+     * Retrieves a list of installed Steam Library folders.
+     * @returns an array of SteamInstallFolder objects.
+     */
+    GetInstallFolders(): Promise<SteamInstallFolder[]>;
+
+    /**
+     * Retrieves a list of potential Steam Library folders that can be added.
+     * @returns an array of PotentialInstallFolder objects.
+     */
+    GetPotentialFolders(): Promise<PotentialInstallFolder[]>;
+
+    /**
+     * Moves the installation folder for a specific app to another Steam Library folder.
+     * @param appId The ID of the application to be moved.
+     * @param folderIndex The index of the target Steam Library folder.
+     */
+    MoveInstallFolderForApp(appId: number, folderIndex: number): void;
+
+    /**
+     * Refreshes the list of installed Steam Library folders.
+     */
+    RefreshFolders(): void;
+
+    /**
+     * Registers a callback function to be called when changes occur in Steam Install Folders.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForInstallFolderChanges(callback: (change: FolderChange) => void): Unregisterable;
+
+    /**
+     * Registers a callback function to be called when moving game content progresses.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForMoveContentProgress(callback: (progress: MoveContentProgress) => void): Unregisterable;
+
+    /**
+     * Registers a callback function to be called when repairing an install folder is finished.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForRepairFolderFinished(callback: (change: FolderChange) => void): Unregisterable;
+
+    /**
+     * Removes a Steam Library folder from the Steam client.
+     * @param folderIndex The index of the folder to be removed.
+     */
+    RemoveInstallFolder(folderIndex: number): void;
+
+    /**
+     * Repairs an installed Steam Library folder.
+     * @param folderIndex The index of the folder to be repaired.
+     */
+    RepairInstallFolder(folderIndex: number): void;
+
+    /**
+     * Sets a specific Steam Library folder as the default install folder.
+     * @param folderIndex The index of the folder to be set as default.
+     */
+    SetDefaultInstallFolder(folderIndex: number): void;
+
+    /**
+     * Sets a user-defined label for a specific Steam Library folder.
+     * @param folderIndex The index of the folder to be labeled.
+     * @param label The label to be assigned to the folder.
+     */
+    SetFolderLabel(folderIndex: number, label: string): void;
+}
+
+/**
+ * Represents information about an installation folder.
+ */
+export interface SteamInstallFolder extends PotentialInstallFolder {
+    /** Index of the folder. */
+    nFolderIndex: number;
+    /** Used space in the folder. */
+    strUsedSize: string;
+    /** Size of DLC storage used in the folder. */
+    strDLCSize: string;
+    /** Size of workshop storage used in the folder. */
+    strWorkshopSize: string;
+    /** Size of staged storage used in the folder. */
+    strStagedSize: string;
+    /** Indicates if the folder is set as the default installation folder. */
+    bIsDefaultFolder: boolean;
+    /** Indicates if the folder is currently mounted. */
+    bIsMounted: boolean;
+    /** List of applications installed in the folder. */
+    vecApps: AppInfo[];
+}
+
+export interface PotentialInstallFolder {
+    /** Path of the folder. */
+    strFolderPath: string;
+    /** User label for the folder. */
+    strUserLabel: string;
+    /** Name of the drive where the folder is located. */
+    strDriveName: string;
+    /** Total capacity of the folder. */
+    strCapacity: string;
+    /** Available free space in the folder. */
+    strFreeSpace: string;
+    /** Indicates if the folder is on a fixed drive. */
+    bIsFixed: boolean;
+}
+
+/**
+ * Represents information about an installed application.
+ */
+export interface AppInfo {
+    /** ID of the application. */
+    nAppID: number;
+    /** Name of the application. */
+    strAppName: string;
+    /** Sorting information for the application. */
+    strSortAs: string;
+    /** Last played time in Unix Epoch time format. */
+    rtLastPlayed: number;
+    /** Size of used storage by the application. */
+    strUsedSize: string;
+    /** Size of DLC storage used by the application. */
+    strDLCSize: string;
+    /** Size of workshop storage used by the application. */
+    strWorkshopSize: string;
+    /** Size of staged storage used by the application. */
+    strStagedSize: string;
+}
+
+export interface FolderChange {
+    folderIndex: number;
+}
+
+export interface MoveContentProgress {
+    appid: number;
+    eError: EAppUpdateError;
+    flProgress: number;
+    strBytesMoved: string;
+    strTotalBytesToMove: string;
+    nFilesMoved: number;
+}

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

@@ -0,0 +1,131 @@
+import { Unregisterable } from "./shared";
+import {EAppUpdateError} from "./App";
+
+/**
+ * Represents functions related to managing installs and installation wizards in Steam.
+ */
+export interface Installs {
+    /**
+     * Cancels the installation wizard if it is open.
+     */
+    CancelInstall(): void;
+
+    /**
+     * Continues and starts the installation if the wizard is still open.
+     */
+    ContinueInstall(): void;
+
+    /**
+     * Retrieves information from the last opened or currently opened installation wizard.
+     */
+    GetInstallManagerInfo(): Promise<InstallMgrInfo>;
+
+    /**
+     * Opens the restore from backup installer wizard for a specific app.
+     * @param appBackupPath The backup path of the app.
+     */
+    OpenInstallBackup(appBackupPath: string): void;
+
+    /**
+     * Opens the installation wizard for specified app IDs.
+     * @param appIds An array of app IDs to install.
+     */
+    OpenInstallWizard(appIds: number[]): void;
+
+    /**
+     * Opens the uninstall wizard for specified app IDs.
+     * @param appIds An array of app IDs to uninstall.
+     * @param dontPrompt Whether to *not* prompt the user to uninstall.
+     */
+    OpenUninstallWizard(appIds: number[], dontPrompt: boolean): void;
+
+    RegisterForShowConfirmUninstall: Unregisterable; // Broken? doesn't seem to work
+
+    /**
+     * Registers a callback function to be called when the "Failed Uninstall" dialog is shown.
+     * @param callback The callback function to be called when the dialog is shown.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForShowFailedUninstall(callback: (appId: number, reason: EAppUpdateError) => void): Unregisterable;
+
+    /**
+     * Registers a callback function to be called when the installation wizard is shown.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForShowInstallWizard(callback: (data: InstallMgrInfo) => void): Unregisterable;
+
+    RegisterForShowRegisterCDKey: any;
+
+    /**
+     * Sets a list of app identifiers for downloads in the installation wizard.
+     * @param appIds An array of app IDs to set.
+     * @remarks The wizard will not reflect this change immediately, but changing another option will.
+     */
+    SetAppList(appIds: number[]): void;
+
+    /**
+     * Sets the options for creating shortcuts in the installation wizard.
+     * @param bDesktopShortcut Whether to create a desktop shortcut.
+     * @param bSystemMenuShortcut Whether to create a system menu shortcut.
+     * @remarks The wizard will not reflect this change immediately, but changing another option will.
+     */
+    SetCreateShortcuts(bDesktopShortcut: boolean, bSystemMenuShortcut: boolean): void;
+
+    /**
+     * Sets the install folder for the installation wizard using an install folder index.
+     * @param folderIndex The index of the install folder.
+     * @remarks The wizard will not reflect this change immediately, but changing another option will.
+     */
+    SetInstallFolder(folderIndex: number): void;
+}
+
+export interface InstallMgrInfo {
+    rgAppIDs: InstallInfoApps[];
+    eInstallState: EInstallMgrState;
+    nDiskSpaceRequired: number;
+    nDiskSpaceAvailable: number;
+    nCurrentDisk: number;
+    nTotalDisks: number;
+    bCanChangeInstallFolder: boolean;
+    /**
+     * Index of the install folder. -1 if not installed.
+     */
+    iInstallFolder: number;
+    iUnmountedFolder: number;
+    currentAppID: number;
+    eAppError: EAppUpdateError;
+    errorDetail: string;
+    bSystemMenuShortcut: boolean;
+    bDesktopShortcut: boolean;
+    bIsBackupInstall: boolean;
+    // device/hostname
+    strPeerContentServer: string;
+    bPeerContentServerOnline: boolean;
+    bPeerContentServerAvailable: boolean;
+}
+
+export interface InstallInfoApps {
+    nAppID: number;
+    lDiskSpaceRequiredBytes: number;
+}
+
+export enum EInstallMgrState {
+    None,
+    Setup,
+    WaitLicense,
+    FreeLicense,
+    ShowCDKey,
+    WaitAppInfo,
+    ShowPassword,
+    ShowConfig,
+    ShowEULAs,
+    CreateApps,
+    ReadFromMedia,
+    ShowChangeMedia,
+    WaitLegacyCDKeys,
+    ShowSignup,
+    Complete,
+    Failed,
+    Canceled,
+}

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

@@ -0,0 +1,20 @@
+import { Unregisterable } from "./shared";
+
+export interface Messaging {
+    // section - "ContentManagement", "JumpList", "PostToLibrary"
+    // seems multipurpose
+    RegisterForMessages<T extends string>(
+        message: T,
+        callback: (message: T, section: string, args: string) => void,
+    ): Unregisterable;
+
+    /*
+    function m(e) {
+        SteamClient.Messaging.PostMessage("LibraryCommands", "ShowFriendChatDialog", JSON.stringify({
+            steamid: e.persona.m_steamid.ConvertTo64BitString()
+        }))
+    }
+    SteamClient.Messaging.PostMessage("FriendsUI", "AcceptedRemotePlayInvite", JSON.stringify({id: this.appID})) : SteamClient.Messaging.PostMessage("FriendsUI", "AcceptedGameInvite", JSON.stringify({id: this.appID}))
+     */
+    PostMessage(message: string, section: string, args: string): void;
+}

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

@@ -0,0 +1,99 @@
+import { Unregisterable } from "./shared";
+
+/**
+ * Represents functions related to controlling music playback in the Steam client.
+ */
+export interface Music {
+    /**
+     * Decreases the music volume by 10%.
+     */
+    DecreaseVolume(): void;
+
+    /**
+     * Increases the music volume by 10%.
+     */
+    IncreaseVolume(): void;
+
+    /**
+     * Plays the next track in the music playlist.
+     */
+    PlayNext(): void;
+
+    /**
+     * Plays the previous track in the music playlist.
+     */
+    PlayPrevious(): void;
+
+    /**
+     * Registers a callback function to be called when music playback changes.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForMusicPlaybackChanges(callback: (param0: boolean | MusicTrack) => void): Unregisterable;
+
+    /**
+     * Registers a callback function to be called when the music playback position changes.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForMusicPlaybackPosition(callback: (position: number) => void): Unregisterable;
+
+    /**
+     * Sets the playback position of the music track.
+     * @param position The position to set in seconds.
+     */
+    SetPlaybackPosition(position: number): void;
+
+    /**
+     * Sets the repeat status for music playback.
+     * @param status The repeat status.
+     */
+    SetPlayingRepeatStatus(status: EMusicPlayingRepeatStatus): void;
+
+    /**
+     * Sets the shuffle status for music playback.
+     * @param value True to enable shuffle, false to disable shuffle.
+     */
+    SetPlayingShuffled(value: boolean): void;
+
+    /**
+     * Sets the volume for music playback.
+     * @param volume The volume level to set.
+     * @remarks Ranges from 0 to 100.
+     */
+    SetVolume(volume: number): void;
+
+    /**
+     * Toggles the mute state of the music volume.
+     */
+    ToggleMuteVolume(): void;
+
+    /**
+     * Toggles between play and pause for music playback.
+     */
+    TogglePlayPause(): void;
+}
+
+export interface MusicTrack {
+    uSoundtrackAppId: number;
+    ePlaybackStatus: EAudioPlayback;
+    eRepeatStatus: EMusicPlayingRepeatStatus;
+    bShuffle: boolean;
+    nVolume: number;
+    nActiveTrack: number;
+    nLengthInMsec: number;
+}
+
+export enum EAudioPlayback {
+    Undefined,
+    Playing,
+    Paused,
+    Idle,
+}
+
+export enum EMusicPlayingRepeatStatus {
+    None,
+    All,
+    Once,
+    Max,
+}