@decky/ui 4.9.1 → 4.10.0

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

@@ -0,0 +1,333 @@
+import { JsPbMessage, Unregisterable } from "./shared";
+
+/**
+ * Everything is taken from here:
+ * https://github.com/SteamDatabase/SteamTracking/blob/master/Protobufs/steammessages_clientnotificationtypes.proto
+ */
+export interface Notifications {
+    /**
+     * If `data` is deserialized, returns one of the following here: {@link Notifications}
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForNotifications(
+        callback: (notificationIndex: number, type: EClientNotificationType, data: ArrayBuffer) => void,
+    ): Unregisterable;
+}
+
+export enum EClientNotificationType {
+    Invalid,
+    DownloadComplete,
+    FriendInvite,
+    FriendInGame,
+    FriendOnline,
+    Achievement,
+    LowBattery,
+    SystemUpdate,
+    FriendMessage,
+    GroupChatMessage,
+    FriendInviteRollup,
+    FamilySharingDeviceAuthorizationChanged,
+    FamilySharingStopPlaying,
+    FamilySharingLibraryAvailable,
+    Screenshot,
+    CloudSyncFailure,
+    CloudSyncConflict,
+    IncomingVoiceChat,
+    ClaimSteamDeckRewards,
+    GiftReceived,
+    ItemAnnouncement,
+    HardwareSurvey,
+    LowDiskSpace,
+    BatteryTemperature,
+    DockUnsupportedFirmware,
+    PeerContentUpload,
+    CannotReadControllerGuideButton,
+    Comment,
+    Wishlist,
+    TradeOffer,
+    AsyncGame,
+    General,
+    HelpRequest,
+    OverlaySplashScreen,
+    BroadcastAvailableToWatch,
+    TimedTrialRemaining,
+    LoginRefresh,
+    MajorSale,
+    TimerExpired,
+    ModeratorMsg,
+    SteamInputActionSetChanged,
+    RemoteClientConnection,
+    RemoteClientStartStream,
+    StreamingClientConnection,
+    FamilyInvite,
+    PlaytimeWarning,
+    FamilyPurchaseRequest,
+    FamilyPurchaseRequestResponse,
+    ParentalFeatureRequest,
+    ParentalPlaytimeRequest,
+    GameRecordingError,
+    ParentalFeatureResponse,
+    ParentalPlaytimeResponse,
+    RequestedGameAdded,
+    ClipDownloaded,
+    GameRecordingStart,
+    GameRecordingStop,
+    GameRecordingUserMarkerAdded,
+    GameRecordingInstantClip,
+}
+
+export enum ESystemUpdateNotificationType {
+    Invalid,
+    Available,
+    NeedsRestart,
+}
+
+export enum EGameRecordingErrorType {
+    General = 1,
+    LowDiskSpace,
+}
+
+export interface ClientNotificationGroupChatMessage extends JsPbMessage {
+    tag(): string;
+
+    /** A Steam64 ID. */
+    steamid_sender(): string;
+
+    chat_group_id(): string;
+
+    chat_id(): string;
+
+    title(): string;
+
+    body(): string;
+
+    rawbody(): string;
+
+    icon(): string;
+
+    notificationid(): number;
+}
+
+export interface ClientNotificationFriendMessage extends JsPbMessage {
+    body(): string;
+
+    icon(): string;
+
+    notificationid(): number;
+
+    response_steamurl(): string;
+
+    /** A Steam64 ID. */
+    steamid(): string;
+
+    tag(): string;
+
+    title(): string;
+}
+
+export interface ClientNotificationCloudSyncFailure extends JsPbMessage {
+	appid(): number;
+}
+
+export interface ClientNotificationCloudSyncConflict extends JsPbMessage {
+	appid(): number;
+}
+
+export interface ClientNotificationScreenshot extends JsPbMessage {
+	screenshot_handle(): string;
+	description(): string;
+	local_url(): string;
+}
+
+export interface ClientNotificationDownloadCompleted extends JsPbMessage {
+	appid(): number;
+	dlc_appid(): number;
+}
+
+export interface ClientNotificationFriendInvite extends JsPbMessage {
+	steamid(): number;
+}
+
+export interface ClientNotificationFriendInviteRollup extends JsPbMessage {
+	new_invite_count(): number;
+}
+
+export interface ClientNotificationFriendInGame extends JsPbMessage {
+	steamid(): number;
+	game_name(): string;
+}
+
+export interface ClientNotificationFriendOnline extends JsPbMessage {
+	steamid(): number;
+}
+
+export interface ClientNotificationAchievement extends JsPbMessage {
+	achievement_id(): string;
+	appid(): number;
+	name(): string;
+	description(): string;
+	image_url(): string;
+	achieved(): boolean;
+	rtime_unlocked(): number;
+	min_progress(): number;
+	current_progress(): number;
+	max_progress(): number;
+	global_achieved_pct(): number;
+}
+
+export interface ClientNotificationLowBattery extends JsPbMessage {
+	pct_remaining(): number;
+}
+
+export interface ClientNotificationSystemUpdate extends JsPbMessage {
+	type(): ESystemUpdateNotificationType;
+}
+
+export interface ClientNotificationFriendMessage extends JsPbMessage {
+	tag(): string;
+	steamid(): string;
+	title(): string;
+	body(): string;
+	icon(): string;
+	notificationid(): number;
+	response_steamurl(): string;
+}
+
+export interface ClientNotificationGroupChatMessage extends JsPbMessage {
+	tag(): string;
+	steamid_sender(): string;
+	chat_group_id(): string;
+	chat_id(): string;
+	title(): string;
+	body(): string;
+	rawbody(): string;
+	icon(): string;
+	notificationid(): number;
+}
+
+export interface ClientNotificationFamilySharingDeviceAuthorizationChanged extends JsPbMessage {
+	accountid_owner(): number;
+	authorized(): boolean;
+}
+
+export interface ClientNotificationFamilySharingStopPlaying extends JsPbMessage {
+	accountid_owner(): number;
+	seconds_remaining(): number;
+	appid(): number;
+}
+
+export interface ClientNotificationFamilySharingLibraryAvailable extends JsPbMessage {
+	accountid_owner(): number;
+}
+
+export interface ClientNotificationIncomingVoiceChat extends JsPbMessage {
+	steamid(): number;
+}
+
+export interface ClientNotificationClaimSteamDeckRewards extends JsPbMessage {
+}
+
+export interface ClientNotificationGiftReceived extends JsPbMessage {
+	sender_name(): string;
+}
+
+export interface ClientNotificationItemAnnouncement extends JsPbMessage {
+	new_item_count(): number;
+	new_backpack_items(): boolean;
+}
+
+export interface ClientNotificationHardwareSurveyPending extends JsPbMessage {
+}
+
+export interface ClientNotificationLowDiskSpace extends JsPbMessage {
+	folder_index(): number;
+}
+
+export interface ClientNotificationBatteryTemperature extends JsPbMessage {
+	temperature(): number;
+	notification_type(): string;
+}
+
+export interface ClientNotificationDockUnsupportedFirmware extends JsPbMessage {
+}
+
+export interface ClientNotificationPeerContentUpload extends JsPbMessage {
+	appid(): number;
+	peer_name(): string;
+}
+
+export interface ClientNotificationCannotReadControllerGuideButton extends JsPbMessage {
+	controller_index(): number;
+}
+
+export interface ClientNotificationOverlaySplashScreen extends JsPbMessage {
+}
+
+export interface ClientNotificationBroadcastAvailableToWatch extends JsPbMessage {
+	broadcast_permission(): number;
+}
+
+export interface ClientNotificationTimedTrialRemaining extends JsPbMessage {
+	appid(): number;
+	icon(): string;
+	offline(): boolean;
+	allowed_seconds(): number;
+	played_seconds(): number;
+}
+
+export interface ClientNotificationLoginRefresh extends JsPbMessage {
+}
+
+export interface ClientNotificationTimerExpired extends JsPbMessage {
+}
+
+export interface ClientNotificationSteamInputActionSetChanged extends JsPbMessage {
+	controller_index(): number;
+	action_set_name(): string;
+}
+
+export interface ClientNotificationRemoteClientConnection extends JsPbMessage {
+	machine(): string;
+	connected(): boolean;
+}
+
+export interface ClientNotificationRemoteClientStartStream extends JsPbMessage {
+	machine(): string;
+	game_name(): string;
+}
+
+export interface ClientNotificationStreamingClientConnection extends JsPbMessage {
+	hostname(): string;
+	machine(): string;
+	connected(): boolean;
+}
+
+export interface ClientNotificationPlaytimeWarning extends JsPbMessage {
+	type(): string;
+	playtime_remaining(): number;
+}
+
+export interface ClientNotificationGameRecordingError extends JsPbMessage {
+	game_id(): number;
+	error_type(): EGameRecordingErrorType;
+}
+
+export interface ClientNotificationGameRecordingStart extends JsPbMessage {
+	game_id(): number;
+}
+
+export interface ClientNotificationGameRecordingStop extends JsPbMessage {
+	game_id(): number;
+	clip_id(): string;
+	duration_secs(): number;
+}
+
+export interface ClientNotificationGameRecordingUserMarkerAdded extends JsPbMessage {
+    game_id(): number;
+}
+
+export interface CClientNotificationGameRecordingInstantClip extends JsPbMessage {
+    game_id(): number;
+    clip_id(): string;
+	duration_secs(): number;
+}

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

@@ -0,0 +1,122 @@
+import { Unregisterable } from "./shared";
+
+
+export interface OpenVR {
+    Device: VRDevice;
+    DeviceProperties: DeviceProperties;
+
+    /**
+     * @throws OperationResponse if mutual capabilities haven't been loaded.
+     */
+    GetMutualCapabilities(): Promise<any>;
+
+    GetWebSecret(): Promise<string>;
+
+    InstallVR(): any;
+
+    Keyboard: Keyboard;
+    PathProperties: PathProperties;
+
+    QuitAllVR(): any;
+
+    RegisterForButtonPress: Unregisterable;
+
+    RegisterForHMDActivityLevelChanged(callback: (m_eHMDActivityLevel: EHMDActivityLevel) => void): Unregisterable;
+
+    RegisterForInstallDialog: Unregisterable;
+
+    RegisterForStartupErrors(callback: (clientError: any, initError: any, initErrorString: string) => void): Unregisterable;
+
+    RegisterForVRHardwareDetected(callback: (m_bHMDPresent: any, m_bHMDHardwareDetected: any, m_strHMDName: any) => void): Unregisterable;
+
+    RegisterForVRModeChange(callback: (m_bIsVRRunning: boolean) => void): Unregisterable;
+
+    RegisterForVRSceneAppChange(callback: (param0: number) => void): Unregisterable;
+
+    SetOverlayInteractionAffordance: any;
+
+    StartVR: any;
+    TriggerOverlayHapticEffect: any;
+    VRNotifications: VRNotifications;
+    VROverlay: VROverlay;
+}
+
+export interface VRDevice {
+    BIsConnected: any;
+    RegisterForDeviceConnectivityChange: Unregisterable;
+
+    RegisterForVRDeviceSeenRecently(callback: (m_bVRDeviceSeenRecently: any) => void): Unregisterable;
+}
+
+export interface DeviceProperties {
+    GetBoolDeviceProperty: any;
+    GetDoubleDeviceProperty: any;
+    GetFloatDeviceProperty: any;
+    GetInt32DeviceProperty: any;
+    GetStringDeviceProperty: any;
+    RegisterForDevicePropertyChange: Unregisterable;
+}
+
+export interface Keyboard {
+    Hide(): any;
+
+    /**
+     * {@link EKeyboardFlags} could be useful here
+     */
+    RegisterForStatus(callback: (m_bIsKeyboardOpen: boolean, m_eKeyboardFlags: number, m_sInitialKeyboardText: string) => void): Unregisterable;
+
+    SendDone(): any;
+
+    SendText(key: string): any; //???
+    Show(): any;
+}
+
+export interface PathProperties {
+    GetBoolPathProperty: any;
+    GetDoublePathProperty: any;
+    GetFloatPathProperty: any;
+    GetInt32PathProperty: any;
+    GetStringPathProperty: any;
+    RegisterForPathPropertyChange: any;
+    SetBoolPathProperty: any;
+    SetDoublePathProperty: any;
+    SetFloatPathProperty: any;
+    SetInt32PathProperty: any;
+    SetStringPathProperty: any;
+}
+
+export interface VRNotifications {
+    HideCustomNotification: any;
+    RegisterForNotificationEvent: Unregisterable;
+    ShowCustomNotification: any;
+}
+
+export interface VROverlay {
+    HideDashboard: any;
+
+    IsDashboardVisible(): Promise<boolean>;
+
+    RegisterForButtonPress: Unregisterable;
+    RegisterForCursorMovement: Unregisterable;
+    RegisterForThumbnailChanged: Unregisterable;
+    RegisterForVisibilityChanged: Unregisterable;
+    ShowDashboard: any;
+
+    SwitchToDashboardOverlay(param0: string): void;
+}
+
+export enum EHMDActivityLevel {
+    Unknown = -1,
+    Idle,
+    UserInteraction,
+    UserInteraction_Timeout,
+    Standby,
+    Idle_Timeout,
+}
+
+export enum EKeyboardFlags {
+    Minimal = 1 << 0,
+    Modal = 1 << 1,
+    ShowArrowKeys = 1 << 2,
+    HideDoneKey = 1 << 3,
+}

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

@@ -0,0 +1,172 @@
+import type { EBrowserType, ESteamRealm, EUIComposition, EUIMode, Unregisterable } from "./shared";
+
+export interface Overlay {
+    /**
+     * Destroys the gamepad UI desktop configurator window if open.
+     */
+    DestroyGamePadUIDesktopConfiguratorWindow(): void;
+
+    GetOverlayBrowserInfo(): Promise<OverlayBrowserInfo[]>;
+
+    // steam://gamewebcallback
+    HandleGameWebCallback(url: string): void;
+
+    /**
+     * @param protocol Something like {@link OverlayBrowserProtocols.strScheme}
+     */
+    HandleProtocolForOverlayBrowser(appId: number, protocol: string): void;
+
+    /**
+     * Registers a callback function to be called when an overlay is activated from an app.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForActivateOverlayRequests(callback: (request: ActivateOverlayRequest) => void): Unregisterable;
+
+    /**
+     * Registers a callback function to be called when a microtransaction authorization is requested.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForMicroTxnAuth(
+        callback: (appId: number, microTxnId: string, realm: ESteamRealm, microTxnUrl: string) => void,
+    ): Unregisterable;
+
+    /**
+     * Registers a callback function to be called when a microtransaction authorization is dismissed by the user in Steam's authorization page.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForMicroTxnAuthDismiss(callback: (appId: number, microTxnId: string) => void): Unregisterable;
+
+    RegisterForNotificationPositionChanged(
+        callback: (appId: number, position: ENotificationPosition, horizontalInset: number, verticalInset: number) => void,
+    ): Unregisterable;
+
+    /**
+     * Registers a callback function to be called when an overlay is activated or closed.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForOverlayActivated(
+        callback: (overlayProcessPid: number, appId: number, active: boolean, param3: boolean) => void,
+    ): Unregisterable;
+
+    /**
+     * Registers a callback function to be called when the overlay browser protocols change.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForOverlayBrowserProtocols(
+        callback: (browseProtocols: OverlayBrowserProtocols) => void,
+    ): Unregisterable;
+
+    /**
+     * Registers **the** callback function to be called when the overlay browser information changes.
+     * @param callback The callback function to be called when the overlay browser information changes.
+     * @returns an object that can be used to unregister the callback.
+     * @remarks Do Not Use, this will break the overlay unless you know what you are doing.
+     */
+    RegisterOverlayBrowserInfoChanged(callback: () => void): Unregisterable;
+
+    SetOverlayState(appId: string, state: EUIComposition): void;
+}
+
+type OverlayRequestDialog_t =
+	| 'achievements'
+	| 'asyncnotificationsrequested'
+	| 'chat'
+	| 'community'
+	| 'friendadd'
+	| 'friendremove'
+	| 'friendrequestaccept'
+	| 'friendrequestignore'
+	| 'friendremove'
+	| 'jointrade'
+	| 'leaderboards'
+	| 'lobbyinvite'
+	| 'lobbyinviteconnectstring'
+	| 'officialgamegroup'
+	| 'requestplaytime'
+	| 'remoteplaytogether'
+	| 'remoteplaytogetherinvite'
+	| 'settings'
+	| 'stats'
+	| 'steamid'
+	| 'store';
+
+// EPosition
+export enum ENotificationPosition {
+    TopLeft,
+    TopRight,
+    BottomLeft,
+    BottomRight,
+}
+
+export interface ActivateOverlayRequest {
+    /**
+     * The app ID that just had an overlay request.
+     */
+    appid: number;
+
+    /**
+     * `true` if webpage, and so {@link strDialog} will start with `https://`.
+     */
+    bWebPage: boolean;
+
+    eFlag: EOverlayToStoreFlag;
+
+    eWebPageMode: EActivateGameOverlayToWebPageMode;
+
+    /**
+     * Steam64 ID.
+     */
+    steamidTarget: string;
+
+    /**
+     * Game invites string for `Friends.InviteUserToGame`.
+     */
+    strConnectString: string;
+
+    /**
+     * Web page URL if starts with `https://`, so cast the type to `string` if it is.
+     */
+    strDialog: OverlayRequestDialog_t;
+
+    /**
+     * App ID of the requesting game.
+     */
+    unRequestingAppID: number;
+}
+
+export interface OverlayBrowserInfo {
+    appID: number;
+    eBrowserType: EBrowserType;
+    eUIMode: EUIMode;
+    flDisplayScale?: number;
+    gameID: string;
+    nBrowserID: number;
+    nScreenHeight: number;
+    nScreenWidth: number;
+    /**
+     * The PID of the overlay process.
+     */
+    unPID: number;
+}
+
+export interface OverlayBrowserProtocols {
+    unAppID: number;
+    strScheme: string;
+    bAdded: boolean;
+}
+
+export enum EActivateGameOverlayToWebPageMode {
+    Default,
+    Modal,
+}
+
+export enum EOverlayToStoreFlag {
+    None,
+    AddToCart,
+    AddToCartAndShow,
+}