@decky/ui 4.9.2 → 4.10.1

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

@@ -0,0 +1,70 @@
+import { Unregisterable } from "./shared";
+
+/**
+ * Represents functions related to managing friends in Steam.
+ */
+export interface Friends {
+    /**
+     * Adds a user to the friend list.
+     * @param steamId The Steam ID of the user to add as a friend.
+     * @returns `true` if the friend was added successfully.
+     */
+    AddFriend(steamId: string): Promise<boolean>;
+
+    /**
+     * @returns a list of players you recently played with.
+     */
+    GetCoplayData(): Promise<CoplayData>;
+
+    InviteUserToCurrentGame(steam64Id: string, steamIdTarget: string): Promise<boolean>;
+
+    /**
+     * Invites a user to a specific game.
+     * @param steamId The Steam ID of the user to invite.
+     * @param appId The ID of the game to invite the user to.
+     * @param connectString Additional parameters for the invitation.
+     * @returns `true` if the user was invited successfully.
+     */
+    InviteUserToGame(steamId: string, appId: number, connectString: string): Promise<boolean>;
+
+    /**
+     * Invites a user to a specific lobby.
+     * @returns `true` if the user was invited successfully.
+     */
+    InviteUserToLobby(steam64Id: string, steamIdTarget: string): Promise<boolean>;
+
+    InviteUserToRemotePlayTogetherCurrentGame(steam64Id: string): Promise<boolean>;
+
+    RegisterForMultiplayerSessionShareURLChanged(
+        appId: number,
+        callback: (param0: string, param1: string) => void,
+    ): Unregisterable;
+
+    RegisterForVoiceChatStatus(callback: (status: VoiceChatStatus) => void): Unregisterable;
+
+    /**
+     * Removes a user from the friend list.
+     * @param steamId The Steam ID of the user to remove from the friend list.
+     * @returns `true` if the friend was removed successfully.
+     */
+    RemoveFriend(steamId: string): Promise<boolean>;
+
+    ShowRemotePlayTogetherUI(): void;
+}
+
+export interface CoplayData {
+    currentUsers: CoplayUser[];
+    recentUsers: CoplayUser[];
+}
+
+export interface CoplayUser {
+    accountid: number;
+    rtTimePlayed: number;
+    appid: number;
+}
+
+export interface VoiceChatStatus {
+    bVoiceChatActive: boolean;
+    bMicMuted: boolean;
+    bOutputMuted: boolean;
+}

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

@@ -0,0 +1,73 @@
+import { EResult, OperationResponse } from "./shared";
+
+export interface GameNotes {
+    /**
+     * @returns a boolean indicating whether the operation was successful.
+     */
+    DeleteImage(param0: string): Promise<boolean>;
+
+    /**
+     * @returns a boolean indicating whether the operation was successful.
+     */
+    DeleteNotes(param0: string): Promise<boolean>;
+
+    GetNotes(filenameForNotes: string, directoryForNoteImages: string): Promise<Notes>;
+
+    GetNotesMetadata(note: string): Promise<NoteMetadata>;
+    GetNumNotes(): Promise<number>;
+    GetQuota: Promise<NotesQuota>;
+
+    IterateNotes(appId: number, length: number): Promise<NoteMetadata[]>;
+    ResolveSyncConflicts(param0: boolean): Promise<EResult>;
+
+    /**
+     * @param notes Escaped JSON array of {@link Note}.
+     */
+    SaveNotes(filenameForNotes: string, notes: string): Promise<EResult>;
+    SyncToClient(): Promise<EResult>;
+
+    SyncToServer(): Promise<EResult>;
+
+    /**
+     * @param mimeType Image MIME type.
+     * @param base64 Image contents in base64.
+     * @returns an image file name with its extension that's meant to be used as a part of some URL. (todo)
+     * @throws OperationResponse if invalid MIME type or unable to parse base64 BUT NOT if it failed.
+     */
+    UploadImage(imageFileNamePrefix: string, mimeType: string, base64: string): Promise<EResult | OperationResponse>;
+}
+
+export interface Note {
+    appid: number;
+    id: string;
+    /**
+     * Note contents in BB code.
+     */
+    content: string;
+    ordinal: number;
+    time_created: number;
+    time_modified: number;
+    title: string;
+}
+
+interface Notes {
+    result: EResult;
+    /**
+     * Escaped JSON array of {@link Note}. Not present if {@link result} is {@link EResult.FileNotFound}.
+     */
+    notes?: string;
+}
+
+interface NoteMetadata {
+    filename: string;
+    filesize: number;
+    result: EResult;
+    timestamp: number;
+}
+
+interface NotesQuota {
+    bytes: number;
+    bytesAvailable: number;
+    numFiles: number;
+    numFilesAvailable: number;
+}

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

@@ -0,0 +1,29 @@
+import type { JsPbMessage, Unregisterable } from "./shared";
+
+export interface GameRecording {
+  /**
+   * If `data` is deserialized, returns {@link CGameRecording_AudioSessionsChanged_Notification}.
+   */
+  RegisterForAudioSessionsChanged(callback: (data: ArrayBuffer) => void): Unregisterable;
+  SetAudioSessionCaptureState(id: string, name: string, state: boolean): void;
+}
+
+export interface AudioSession {
+  id(): string | undefined;
+  name(): string | undefined;
+  is_system(): boolean | undefined;
+  is_muted(): boolean | undefined;
+  is_active(): boolean | undefined;
+  is_captured(): boolean | undefined;
+  recent_peak(): number | undefined;
+  is_game(): boolean | undefined;
+  is_steam(): boolean | undefined;
+  is_saved(): boolean | undefined;
+}
+
+/**
+ * @note Taken from https://github.com/SteamDatabase/SteamTracking/blob/master/Protobufs/steammessages_gamerecording_objects.proto
+ */
+export interface CGameRecording_AudioSessionsChanged_Notification extends JsPbMessage {
+  sessions(): AudioSession[];
+}

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

@@ -0,0 +1,59 @@
+import { Unregisterable } from "./shared";
+import {AppAchievements} from "./App";
+import { Screenshot } from "./Screenshots";
+
+/**
+ * Represents functions related to Steam Game Sessions.
+ */
+export interface GameSessions {
+    /**
+     * Registers a callback function to be called when an achievement notification is received.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForAchievementNotification(
+        callback: (notification: AchievementNotification) => void,
+    ): Unregisterable;
+
+    /**
+     * Registers a callback function to be called when an app lifetime notification is received.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForAppLifetimeNotifications(
+        callback: (notification: AppLifetimeNotification) => void,
+    ): Unregisterable;
+
+    /**
+     * Registers a callback function to be called when a screenshot notification is received.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForScreenshotNotification(
+        callback: (notification: ScreenshotNotification) => void,
+    ): Unregisterable;
+}
+
+/**
+ * @prop unAppID is not properly set by Steam for non-steam game shortcuts, so it defaults to 0 for them
+ */
+interface GameSessionNotificationBase {
+  unAppID: number;
+}
+
+export interface AchievementNotification extends GameSessionNotificationBase {
+    achievement: AppAchievements;
+    nCurrentProgress: number;
+    nMaxProgress: number;
+}
+
+export interface AppLifetimeNotification extends GameSessionNotificationBase {
+    nInstanceID: number;
+    bRunning: boolean;
+}
+
+export interface ScreenshotNotification extends GameSessionNotificationBase {
+    details: Screenshot;
+    hScreenshot: number;
+    strOperation: "deleted" | "written";
+}