Steam client reference

src/deck-components/steam-client/Auth.ts

@@ -0,0 +1,98 @@
+import {JsPbMessage} from "./index";
+import {OSType} from "./system";
+
+export interface Auth {
+    /**
+     * @returns a boolean indicating if the operation succeeded.
+     */
+    ClearCachedSignInPin(): Promise<boolean>;
+
+    CurrentUserHasCachedSignInPin(): Promise<boolean>;
+
+    GetLocalHostname(): Promise<string>;
+
+    /**
+     * @returns A Promise that resolves to a ProtoBuf message. If deserialized, returns {@link Authentication_DeviceDetails}.
+     */
+    GetMachineID(): Promise<ArrayBuffer>;
+
+    GetRefreshInfo(): Promise<AuthRefreshInfo>;
+
+    GetSteamGuardData(param0: any): any;
+
+    IsSecureComputer(): Promise<boolean>;
+
+    SetCachedSignInPin(pin: string): Promise<boolean>;
+
+    SetLoginToken(refreshToken: string, accountName: string): any;
+
+    SetSteamGuardData(accountName: string, newGuardData: string): any;
+
+    StartSignInFromCache(param0: any, login: string): Promise<any>;
+
+    UserHasCachedSignInPin(accountName: string): Promise<boolean>;
+
+    ValidateCachedSignInPin(accountName: string, pin: string): Promise<boolean>;
+}
+
+export interface AuthRefreshInfo {
+    reason: number;
+    account_name: string;
+    login_id_token: string;
+}
+
+/**
+ * CAuthentication_DeviceDetails
+ *
+ * `deserializeBinary` argument:
+ * ```
+ * [
+ *     await SteamClient.System.GetOSType(),
+ *     await SteamClient.Auth.GetLocalHostname(),
+ *     await SteamClient.Auth.GetMachineID(),
+ * ];
+ * ```
+ */
+export interface Authentication_DeviceDetails extends JsPbMessage {
+    client_count(): number | undefined;
+
+    device_friendly_name(): string | undefined;
+
+    gaming_device_type(): GamingDeviceType | undefined;
+
+    machine_id(): Uint8Array | string;
+
+    os_type(): OSType | undefined;
+
+    platform_type(): AuthTokenPlatformType | undefined;
+
+    set_client_count(): any;
+
+    set_device_friendly_name(): any;
+
+    set_gaming_device_type(): any;
+
+    set_machine_id(): any;
+
+    set_os_type(): any;
+
+    set_platform_type(): any;
+}
+
+export enum AuthTokenPlatformType {
+    Unknown = 0,
+    SteamClient = 1,
+    WebBrowser = 2,
+    MobileApp = 3,
+}
+
+export enum GamingDeviceType {
+    Unknown = 0,
+    StandardPC = 1,
+    Console = 256,
+    PS3 = 272,
+    Steambox = 288,
+    Handheld = 512,
+    Phone = 528,
+    SteamDeck = 544,
+}

src/deck-components/steam-client/Broadcast.ts

@@ -0,0 +1,59 @@
+import {Result, Unregisterable} from "./index";
+
+export interface Broadcast {
+    /**
+     * Approves a viewer request for the broadcast.
+     * @param steamId64 The SteamID64 of the user whose request is to be approved.
+     * @param param1 Unknown parameter.
+     */
+    ApproveViewerRequest(steamId64: string, param1: number): void;
+
+    /**
+     * Invites a user identified by their SteamID64 to watch the broadcast.
+     * @param steamId64 The SteamID64 of the user to invite.
+     * @returns A Promise indicating the result of the invitation (1 for success, 2 for error).
+     */
+    InviteToWatch(steamId64: string): Promise<number>;
+
+    /**
+     * Registers a callback to be called when the broadcast status changes.
+     * @param callback The callback function to be called.
+     * @returns An object that can be used to unregister the callback.
+     */
+    RegisterForBroadcastStatus(callback: (broadcastStatus: BroadcastStatus) => void): Unregisterable;
+
+    /**
+     * Registers a callback to be called when viewer requests are received.
+     * @param callback The callback function to be called.
+     * @returns An object that can be used to unregister the callback.
+     */
+    RegisterForViewerRequests(
+        callback: (viewerFriendCode: number, param1: number, param2: number) => void,
+    ): Unregisterable;
+
+    /**
+     * Rejects a viewer request for the broadcast.
+     * @param steamId64 The SteamID64 of the user whose request is to be rejected.
+     * @param param1 Unknown parameter.
+     */
+    RejectViewerRequest(steamId64: string, param1: number): void;
+
+    /**
+     * Stops the broadcast.
+     */
+    StopBroadcasting(): void;
+}
+
+export interface BroadcastStatus {
+    broadcastid: string;
+    nViewers: number;
+    nRequests: number;
+    bIsBroadcasting: boolean;
+    bIsRecordingDesktop: boolean;
+    eBroadcastReady: Result;
+    bBroadcastCapable: boolean;
+    bMicrophoneEnabled: boolean;
+    bMicrophoneActive: boolean;
+    nCurrentFPS: number;
+    nUploadKbps: number;
+}

src/deck-components/steam-client/Browser.ts

@@ -0,0 +1,87 @@
+import {Unregisterable} from "./index";
+
+export interface Browser {
+    AddWordToDictionary(word: string): void;
+
+    ClearAllBrowsingData(): void;
+
+    ClearHistory(): void;
+
+    CloseDevTools(): void;
+
+    GetBrowserID(): Promise<number>;
+
+    GetSpellingSuggestions(word: string): string[];
+
+    GetSteamBrowserID(): Promise<number>; // 16-bit unsigned integer?
+
+    /**
+     * Hides the mouse cursor until input.
+     */
+    HideCursorUntilMouseEvent(): void;
+
+    /**
+     * yup that's right, clientY and clientX are reversed
+     */
+    InspectElement(clientY: number, clientX: number): void;
+
+    NotifyUserActivation(): void;
+
+    OpenDevTools(): void;
+
+    /**
+     * Pastes the clipboard contents.
+     */
+    Paste(): void;
+
+    /**
+     * @todo unconfirmed
+     */
+    RegisterForGestureEvents(callback: (gesture: TouchGesture) => void): Unregisterable;
+
+    RegisterForOpenNewTab: Unregisterable;
+
+    ReplaceMisspelling: any;
+
+    /**
+     * Restarts the Steam JS context.
+     */
+    RestartJSContext(): void;
+
+    SetBackgroundThrottlingDisabled(value: boolean): void;
+
+    SetPendingFilePath(path: string): Promise<boolean>;
+
+    SetShouldExitSteamOnBrowserClosed(value: boolean): any;
+
+    SetTouchGesturesToCancel(gestures: TouchGestureType[]): void;
+
+    /**
+     * Prompts and downloads a file.
+     * @param url The URL of the file to download.
+     */
+    StartDownload(url: string): void;
+}
+
+export interface TouchGesture {
+    eTouchGesture: TouchGestureType;
+    x: number;
+    y: number;
+}
+
+export enum TouchGestureType {
+    None = 0,
+    Touch = 1,
+    Tap = 2,
+    DoubleTap = 3,
+    ShortPress = 4,
+    LongPress = 5,
+    LongTap = 6,
+    TwoFingerTap = 7,
+    TapCancelled = 8,
+    PinchBegin = 9,
+    PinchUpdate = 10,
+    PinchEnd = 11,
+    FlingStart = 12,
+    FlingCancelled = 13,
+}

src/deck-components/steam-client/ClientNotifications.ts

@@ -0,0 +1,39 @@
+import { BrowserContext } from "./index";
+
+export interface ClientNotifications {
+    /**
+     * Displays a Steam notification.
+     * @param notification Notification type.
+     * @param options Stringified object of {@link SteamNotificationOptions}.
+     * @param callback
+     */
+    DisplayClientNotification(
+        notification: ClientUINotificationType,
+        options: string,
+        callback: (context: BrowserContext) => void,
+    ): void;
+
+    /**
+     * @param notificationId The ID of the notification to handle.
+     * @param handleAction `true` to execute the callback function associated with the notification, `false` otherwise.
+     */
+    OnRespondToClientNotification(notificationId: number, handleAction: boolean): void;
+}
+
+export interface SteamNotificationOptions {
+    body: string;
+    chatroomgroupid?: number;
+    chatroomid?: number;
+    icon?: string;
+    state: string;
+    /** A Steam64 ID. */
+    steamid: string;
+    tag?: string;
+    title?: string;
+}
+
+export enum ClientUINotificationType {
+    GroupChatMessage = 1,
+    FriendChatMessage = 2,
+    FriendPersonaState = 3,
+}

src/deck-components/steam-client/Cloud.ts

@@ -0,0 +1,16 @@
+export interface Cloud {
+    /**
+     * Resolves a synchronization conflict for an app in the cloud.
+     * @param appId The ID of the app with the sync conflict.
+     * @param keepLocal Whether to keep the local version during conflict resolution.
+     * @returns Returns data related to resolving the sync conflict.
+     */
+    ResolveAppSyncConflict(appId: number, keepLocal: boolean): void;
+
+    /**
+     * Retries syncing an app with the cloud.
+     * @param appId The ID of the app to retry syncing.
+     * @returns Returns data related to retrying the app sync.
+     */
+    RetryAppSync(appId: number): void;
+}

src/deck-components/steam-client/CommunityItems.ts

@@ -0,0 +1,24 @@
+export interface CommunityItems {
+    /*
+    DownloadMovie(e) {
+            return (0, o.mG)(this, void 0, void 0, (function* () {
+                if (0 != e.movie_webm_local_path.length) return !0;
+                let t = yield SteamClient.CommunityItems.DownloadItemAsset(e.communityitemid, w, e.movie_webm),
+                    n = 1 == t.result;
+                if (n) {
+                    e.movie_webm_local_path = t.path;
+                    let n = [];
+                    this.m_startupMovies.forEach((t => {
+                        t.movie_webm == e.movie_webm ? n.push(e) : n.push(t)
+                    })), this.m_startupMovies = n
+                }
+                return n
+            }))
+        }
+     */
+    DownloadItemAsset(communityItemId: string, param1: any, param2: string): any;
+
+    GetItemAssetPath(communityItemId: string, param1: any, param2: string): any;
+
+    RemoveDownloadedItemAsset(communityItemId: string, param1: any, param2: string): any;
+}

src/deck-components/steam-client/Console.ts

@@ -0,0 +1,41 @@
+import {Unregisterable} from "./index";
+
+/**
+ * Represents the console functionality for executing commands and handling spew output.
+ */
+export interface Console {
+    /**
+     * Executes a console command.
+     * @param command The command to execute in the console.
+     */
+    ExecCommand(command: string): void;
+
+    /**
+     * Retrieves autocomplete suggestions for a given console command.
+     * @param command The console command to provide autocomplete suggestions for.
+     * @returns A Promise that resolves to an array of autocomplete suggestions.
+     */
+    GetAutocompleteSuggestions(command: string): Promise<string[]>;
+
+    /**
+     * Registers a callback function to receive spew output.
+     * @param callback The callback function that will receive spew output.
+     * @returns An object that can be used to unregister the callback.
+     */
+    RegisterForSpewOutput(callback: (spewOutput: SpewOutput) => void): Unregisterable;
+}
+
+/**
+ * Represents spew output information.
+ */
+export interface SpewOutput {
+    /**
+     * The content of the spew output.
+     */
+    spew: string;
+
+    /**
+     * The type or category of the spew output.
+     */
+    spew_type: "error" | "info" | "input";
+}

src/deck-components/steam-client/Customization.ts

@@ -0,0 +1,12 @@
+export interface Customization {
+    GenerateLocalStartupMoviesThumbnails(param0: number): Promise<number>;
+
+    //param0: "startupmovies"
+    GetDownloadedStartupMovies(param0: string): Promise<StartupMovie[]>;
+
+    GetLocalStartupMovies(): Promise<StartupMovie[]>;
+}
+
+export interface StartupMovie {
+    strMovieURL: string;
+}