@decky/ui 4.9.1 → 4.10.0

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

@@ -0,0 +1,24 @@
+import { OperationResponse } from "./shared";
+
+/**
+ * SteamClient.MachineStorage affects the "STEAMPATH/config/config.vdf" file.
+ * SteamClient.RoamingStorage affects the "STEAMPATH/userdata/STEAMID3/7/remote/sharedconfig.vdf" file.
+ * SteamClient.Storage affects the "STEAMPATH/userdata/STEAMID3/config/localconfig.vdf" file.
+ */
+export interface Storage {
+    DeleteKey(key: string): Promise<OperationResponse | undefined>;
+
+    /**
+     * @remarks Use {@link SetObject} to set.
+     */
+    GetJSON(key: string): Promise<OperationResponse | string>;
+
+    GetString(key: string): Promise<OperationResponse | string>;
+
+    /**
+     * @remarks Use {@link SetObject} to get.
+     */
+    SetObject(key: string, value: object): Promise<OperationResponse | undefined>;
+
+    SetString(key: string, value: string): Promise<OperationResponse | undefined>;
+}

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

@@ -0,0 +1,59 @@
+import { EResult, Unregisterable } from "./shared";
+import {LaunchOption} from "./App";
+
+export interface Streaming {
+    AcceptStreamingEULA(appId: number, id: string, version: number): void;
+
+    CancelStreamGame(): void; // existing stream
+
+    /**
+     * Registers a callback function to be called when the streaming client finishes.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForStreamingClientFinished(callback: (code: EResult, result: string) => void): Unregisterable;
+
+    /**
+     * Registers a callback function to be called when there is progress in the launch of the streaming client.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForStreamingClientLaunchProgress(
+        callback: (actionType: string, taskDetails: string, done: number, total: number) => void,
+    ): Unregisterable;
+
+    /**
+     * Registers a callback function to be called when the streaming client is started (e.g., when clicking the stream button).
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForStreamingClientStarted(callback: (appId: number) => void): Unregisterable;
+
+    /**
+     * Registers a callback function to be called when the streaming launch is complete.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForStreamingLaunchComplete(callback: (code: EResult, result: string) => void): Unregisterable;
+
+    RegisterForStreamingShowEula(callback: (appId: number) => void): Unregisterable;
+
+    RegisterForStreamingShowIntro(callback: (appId: number, param: string) => void): Unregisterable;
+
+    /**
+     * Registers a callback function to be called when the streaming client receives launch options from the host.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForStreamingShowLaunchOptions(
+        callback: (appId: number, launchOptions: LaunchOption[]) => void,
+    ): Unregisterable; // Callback when streaming client receives launch options from host
+
+    StreamingContinueStreamGame(): void; // existing game running on another streaming capable device
+
+    /**
+     * Chooses the launch option for the streamed app by its index
+     * and restarts the stream.
+     */
+    StreamingSetLaunchOption(index: number): void;
+}

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

@@ -0,0 +1,90 @@
+import { EUIMode, Unregisterable } from "./shared";
+import {EOSType} from "./system";
+
+export interface UI {
+    EnsureMainWindowCreated(): void;
+
+    ExitBigPictureMode(): void;
+
+    GetDesiredSteamUIWindows(): Promise<SteamWindow[]>;
+
+    /**
+     * Gets information about whether your OS will be unsupported in the future or not.
+     */
+    GetOSEndOfLifeInfo(): Promise<OSEndOfLifeInfo>;
+
+    /**
+     * Retrieves the current UI mode.
+     * @returns the current UI mode.
+     */
+    GetUIMode(): Promise<EUIMode>;
+
+    NotifyAppInitialized(): void;
+
+    RegisterDesiredSteamUIWindowsChanged(callback: () => void): Unregisterable;
+
+    /**
+     * Registers a callback function to be called when a convar's value gets changed.
+     *
+     * Hard crashes if such a convar does not exist or if you can't set it.
+     *
+     * @param convar The ConVar to watch.
+     * @param callback The callback function to be called.
+     */
+    RegisterForClientConVar(convar: string, callback: (value: string) => void): Unregisterable;
+
+    /**
+     * @todo param{0,1} are enums
+     */
+    RegisterForErrorCondition(callback: (param0: number, param1: number) => void): Unregisterable;
+
+    RegisterForKioskModeResetSignal(callback: () => void): Unregisterable;
+
+    /**
+     * @todo This fires multiple times.
+     */
+    RegisterForStartupFinished(callback: () => void): Unregisterable;
+
+    RegisterForUIModeChanged(callback: (mode: EUIMode) => void): Unregisterable;
+
+    ResetErrorCondition(): void;
+
+    /**
+     * Sets the UI mode to the specified value.
+     * @param mode The UI mode to set.
+     */
+    SetUIMode(mode: EUIMode): void;
+}
+
+export enum EWindowType {
+    MainGamepadUI,
+    OverlayGamepadUI,
+    Keyboard,
+    ControllerConfigurator,
+    VR,
+    MainDesktopUI,
+    DesktopLogin,
+    OverlayDesktopUI,
+    SteamChinaReviewLauncher,
+}
+
+export interface OSEndOfLifeInfo {
+    bOSWillBeUnsupported: boolean;
+    osType: EOSType;
+}
+
+/**
+ * The following might have more correct information:
+ * https://github.com/SteamDatabase/SteamTracking/blob/master/Protobufs/webuimessages_sharedjscontext.proto
+ */
+export interface SteamWindow {
+    appid: number;
+    hwndParent: number;
+    nBrowserID: number;
+    strAppName: string;
+    unID: number;
+    unPID: number;
+    windowType: EWindowType;
+    x: number;
+    y: number;
+}

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

@@ -0,0 +1,174 @@
+import { Unregisterable } from "./shared";
+
+export interface URL {
+    /**
+     * Executes a steam:// URL.
+     * @param url The URL to execute.
+     */
+    ExecuteSteamURL(url: string): void;
+
+    /**
+     * @param urls Additional URLs to get. May be empty.
+     */
+    GetSteamURLList(urls: SteamWebURL_t[]): Promise<SteamURLs>;
+
+    GetWebSessionID(): Promise<string>;
+
+    /**
+     * Registers a callback to be called when a steam:// URL gets executed.
+     * @param section `rungameid`, `open`, etc.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForRunSteamURL(section: string, callback: (param0: number, url: string) => void): Unregisterable;
+
+    RegisterForSteamURLChanges(callback: () => void): void;
+}
+
+export type SteamWebURL_t =
+    | "AllNotifications"
+    | "AppHoverPublic"
+    | "AppHoverPublicFull"
+    | "AppNewsPage"
+    | "AsyncGames"
+    | "AvatarBaseURL"
+    | "BaseURLSharedCDN"
+    | "Chat"
+    | "ChatRoot"
+    | "ClaimEntitlements"
+    | "ClanAssetCDN"
+    | "CommentNotifications"
+    | "CommunityHome"
+    | "CommunityAddFriends"
+    | "CommunityCDN"
+    | "CommunityFilePage"
+    | "CommunityFriendsThatPlay"
+    | "CommunityFrontPage"
+    | "CommunityGroupSearch"
+    | "CommunityImages"
+    | "CommunityInventory"
+    | "CommunityMarket"
+    | "CommunityMarketApp"
+    | "CommunityRecommendations"
+    | "CommunityScreenshots"
+    | "CommunitySingleScreenshot"
+    | "CurrentlyPlayedWith"
+    | "EventAnnouncementPage"
+    | "FamilyManagement"
+    | "FamilySharing"
+    | "GameHub"
+    | "GameHubBroadcasts"
+    | "GameHubDiscussions"
+    | "GameHubGuides"
+    | "GameHubNews"
+    | "GameHubReviews"
+    | "GlobalAchievementStatsPage"
+    | "GlobalLeaderboardsPage"
+    | "GroupSteamIDPage"
+    | "HardwareSurvey"
+    | "HelpAppPage"
+    | "HelpChangeEmail"
+    | "HelpChangePassword"
+    | "HelpFAQ"
+    | "HelpFrontPage"
+    | "HelpWithLogin"
+    | "HelpWithLoginInfo"
+    | "HelpWithSteamGuardCode"
+    | "HelpVacBans"
+    | "ItemStorePage"
+    | "ItemStoreDetailPage"
+    | "JoinTrade"
+    | "LegalInformation"
+    | "LibraryAppDetails"
+    | "LibraryAppReview"
+    | "LibraryFeaturedBroadcasts"
+    | "ManageGiftsPage"
+    | "ManageSteamGuard"
+    | "ModeratorMessages"
+    | "Mobile"
+    | "MyHelpRequests"
+    | "OfficialGameGroupPage"
+    | "NewsHomePage"
+    | "ParentalBlocked"
+    | "ParentalSetup"
+    | "PendingFriends"
+    | "PendingGift"
+    | "PointsShop"
+    | "PrivacyPolicy"
+    | "RecommendGame"
+    | "RedeemWalletVoucher"
+    | "RegisterKey"
+    | "RegisterKeyNoParams"
+    | "SSA"
+    | "SteamAnnouncements"
+    | "SteamClientBetaBugReports"
+    | "SteamClientBetaNewsPage"
+    | "SteamClientBetaNewsPageFancy"
+    | "SteamClientNewsPage"
+    | "SteamClientPatchNotes"
+    | "SteamClientBetaPatchNotes"
+    | "SteamDiscussions"
+    | "SteamIDAchievementsPage"
+    | "SteamIDAppTradingCardsPage"
+    | "SteamIDBadgeInfo"
+    | "SteamIDBadgePage"
+    | "SteamIDBroadcastPage"
+    | "SteamIDEditPage"
+    | "SteamIDEditPrivacyPage"
+    | "SteamIDFriendsList"
+    | "SteamIDFriendsPage"
+    | "SteamIDGroupsPage"
+    | "SteamIDMyProfile"
+    | "SteamIDPage"
+    | "SteamLanguage"
+    | "SteamPreferences"
+    | "SteamVRHMDHelp"
+    | "SteamWorkshop"
+    | "SteamWorkshopPage"
+    | "SteamWorkshopSubscriptions"
+    | "SteamWorkshopUpdatedSubscriptions"
+    | "StoreAccount"
+    | "StoreAddFundsPage"
+    | "StoreAppHover"
+    | "StoreAppImages"
+    | "StoreAppPage"
+    | "StoreAppPageAddToCart"
+    | "StoreCart"
+    | "StoreCDN"
+    | "StoreDlcPage"
+    | "StoreExplore"
+    | "StoreExploreNew"
+    | "StoreFreeToPlay"
+    | "StoreFrontPage"
+    | "StoreGameSearchPage"
+    | "StoreGreatOnDeck"
+    | "StorePublisherPage"
+    | "StoreSpecials"
+    | "StoreStats"
+    | "StoreVR"
+    | "StoreWebMicroTxnPage"
+    | "SupportMessages"
+    | "TextFilterSettings"
+    | "TodayPage"
+    | "TradeOffers"
+    | "VideoCDN"
+    | "UserAchievementsPage"
+    | "UserLeaderboardsPage"
+    | "UserStatsPage"
+    | "UserWishlist"
+    | "WatchVideo"
+    | "WebAPI"
+    | "WorkshopEula"
+    | "YearInReview";
+
+export interface SteamURL {
+    url: string;
+    /**
+     * @todo enum?
+     */
+    feature: number;
+}
+
+export type SteamURLs = {
+    [url in SteamWebURL_t]: SteamURL;
+}

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

@@ -0,0 +1,101 @@
+import { EResult, JsPbMessage, OperationResponse, Unregisterable } from "./shared";
+
+export interface Updates {
+    /**
+     * @param base64 Serialized base64 message from `CMsgSystemUpdateApplyParams`.
+     */
+    ApplyUpdates(base64: string): Promise<OperationResponse>;
+
+    CheckForUpdates(): Promise<OperationResponse>; // Checks for software updates
+
+    GetCurrentOSBranch(): Promise<OSBranch>;
+
+    GetOSBranchList(): Promise<any[]>;
+
+    /**
+     * If `data` is deserialized, returns {@link MsgSystemUpdateState}.
+     * @returns a ProtoBuf message.
+     */
+    RegisterForUpdateStateChanges(callback: (data: ArrayBuffer) => void): Unregisterable;
+
+    /**
+     * @param base64 Serialized base64 message from `CMsgSelectOSBranchParams`.
+     */
+    SelectOSBranch(base64: string): Promise<OperationResponse>;
+}
+
+
+export interface OSBranch {
+    eBranch: EOSBranch; // 1 - Stable
+    sRawName: string;
+}
+
+export enum EOSBranch {
+    Unknown,
+    Release,
+    ReleaseCandidate,
+    Beta,
+    BetaCandidate,
+    Preview,
+    PreviewCandidate,
+    Main,
+    Staging,
+}
+
+/**
+ * CMsgSystemUpdateState
+ */
+export interface MsgSystemUpdateState extends JsPbMessage {
+    state(): EUpdaterState | undefined;
+
+    progress(): UpdateProgress | undefined;
+
+    supports_os_updates(): boolean | undefined;
+
+    update_apply_results(): UpdateApplyResult[];
+
+    update_check_results(): UpdateCheckResult[];
+}
+
+export interface UpdateApplyResult {
+    type: EUpdaterType;
+    eresult: EResult;
+    requires_client_restart: boolean;
+    requires_system_restart: boolean;
+}
+
+export interface UpdateCheckResult {
+    type: EUpdaterType;
+    eresult: EResult;
+    rtime_checked: number;
+    available: boolean;
+}
+
+export interface UpdateProgress {
+    stage_progress: number | undefined;
+    stage_size_bytes: number | undefined;
+    rtime_estimated_completion: number | undefined;
+}
+
+export enum EUpdaterState {
+    Invalid,
+    // ty valve
+    UpToDate = 2,
+    Checking,
+    Available,
+    Applying,
+    ClientRestartPending,
+    SystemRestartPending,
+    RollBack,
+}
+
+export enum EUpdaterType {
+    Invalid,
+    Client,
+    OS,
+    BIOS,
+    Aggregated,
+    Test1,
+    Test2,
+    Dummy,
+}