@decky/ui 4.15.0 → 4.16.0

package/src/globals/shared/interfaces.ts

@@ -0,0 +1,147 @@
+import type { EResult } from '../steam-client/shared';
+import type { EMsg_t } from './cm';
+import type { EBrowserType, EUIMode } from './enums';
+
+export interface BrowserContext {
+  /**
+   * Window type.
+   */
+  m_eBrowserType?: EBrowserType;
+
+  /**
+   * The UI mode in use.
+   */
+  m_eUIMode: EUIMode;
+
+  /**
+   * If overlay, game's app ID, otherwise doesn't appear.
+   */
+  m_gameID?: string;
+
+  /**
+   * If not overlay, -1.
+   * @todo Not the same as `SteamClient.Browser.GetBrowserID()`
+   */
+  m_nBrowserID: number;
+
+  /**
+   * If overlay, game's app ID, otherwise 0.
+   */
+  m_unAppID?: number;
+
+  /**
+   * If overlay, gameoverlayui's PID, otherwise 0.
+   */
+  m_unPID: number;
+}
+
+export interface Unsubscribable {
+  /**
+   * Unregisters the callback.
+   */
+  Unregister(): void;
+}
+
+// biome-ignore lint/suspicious/noExplicitAny: intentional, not used yet
+export interface CBaseProtoBufMsg<T = any> {
+  BIsValid(): boolean;
+  Body(): T;
+  BSuccess(): boolean;
+  GetEMsg(): EMsg_t;
+  GetEResult(): EResult;
+  GetErrorMessage(): string;
+}
+
+/**
+ * Interface to register and unregister callbacks from, with ability to
+ * dispatch.
+ */
+// biome-ignore lint/suspicious/noExplicitAny: intentional
+export interface CCallbackList<T extends any[] = never> {
+  m_vecCallbacks: ((...args: [...T]) => void)[];
+
+  /**
+   * Removes all callbacks.
+   */
+  ClearAllCallbacks(): void;
+
+  /**
+   * @returns the registered callbacks count.
+   */
+  CountRegistered(): number;
+
+  /**
+   * Dispatches all callbacks at once.
+   *
+   * @param args Callback arguments.
+   */
+  Dispatch(...args: [...T]): void;
+
+  /**
+   * Registers a callback to dispatch.
+   *
+   * @param callback The callback to register.
+   * @returns an object that can be used to unregister the callback.
+   */
+  Register(callback: (...args: [...T]) => void): Unsubscribable;
+}
+
+/**
+ * This is kind of like an `@observable` field but without using mobx.
+ */
+export interface SubscribableValue<T> {
+  m_callbacks: CCallbackList<[T]>;
+  m_currentValue: T;
+  m_fnEquals?: (currentValue: T, newValue: T) => boolean;
+
+  /**
+   * Sets a new value and notifies Subscribers of the new value.
+   */
+  Set(value: T): void;
+
+  /**
+   * Adds a subscription to the backing {@link CCallbackList}.
+   */
+  Subscribe(subscriber: (value: T) => void): Unsubscribable;
+
+  /**
+   * Subscription count of the backing {@link CCallbackList}.
+   */
+  get SubscriberCount(): number;
+
+  /**
+   * A snapshot of the current value which can change at any time.
+   */
+  get Value(): T;
+}
+
+export interface MappedSubscribableValue<T> {
+  m_bMappedValueStale: boolean;
+  m_fnMap: (value: T) => T;
+  m_originalSubscribableValue: SubscribableValue<T>;
+  m_mappedSubscribableValue: SubscribableValue<T>;
+
+  /**
+   * Adds a subscription to the backing {@link CCallbackList}.
+   */
+  Subscribe(subscriber: (value: T) => void): Unsubscribable;
+
+  /**
+   * Updates the value from the backing {@link SubscribableValue}.
+   */
+  UpdateMappedValue(): void;
+
+  /**
+   * A snapshot of the current value which can change at any time.
+   */
+  get Value(): T;
+}
+
+export interface CScheduledFunc {
+  m_fnCallback: () => void;
+  m_schTimer: number;
+
+  Cancel(): void;
+  IsScheduled(): boolean;
+  Schedule(timeout: number, fn: () => void): void;
+}

package/src/globals/shared/navigation.ts

@@ -0,0 +1,15 @@
+export enum ENavigationSourceType {
+  UNKNOWN,
+  GAMEPAD,
+  KEYBOARD_SIMULATOR,
+  MOUSE,
+  TOUCH,
+  LPAD,
+  RPAD,
+}
+
+export interface NavigationSource {
+  eActivationSourceType: ENavigationSourceType;
+  nActiveGamepadIndex: number;
+  nLastActiveGamepadIndex: number;
+}

package/src/globals/shared/steamid.ts

@@ -0,0 +1,49 @@
+import type { ESteamRealm } from './enums';
+
+export enum EAccountType {
+  Invalid,
+  Individual,
+  Multiseat,
+  GameServer,
+  AnonGameServer,
+  Pending,
+  ContentServer,
+  Clan,
+  Chat,
+  ConsoleUser,
+  AnonUser,
+  Max,
+}
+
+export interface CSteamID {
+  m_ulSteamID: {
+    high: number;
+    low: number;
+    unsigned: boolean;
+  };
+
+  BIsClanAccount(): boolean;
+  BIsIndividualAccount(): boolean;
+  BIsValid(): boolean;
+
+  /**
+   * @returns SteamID 64
+   */
+  ConvertTo64BitString(): string;
+
+  GetAccountID(): number;
+  GetAccountType(): EAccountType;
+  GetInstance(): number;
+  GetUniverse(): ESteamRealm;
+
+  /**
+   * @returns SteamID 3
+   */
+  Render(): string;
+
+  SetAccountID(value: number): void;
+  SetAccountType(value: number): void;
+  SetFromComponents(accountId: number, instance: number, accountType: EAccountType, universe: ESteamRealm): void;
+  SetInstance(value: number): void;
+  SetUniverse(value: ESteamRealm): void;
+}

package/src/globals/shared/storage.ts

@@ -0,0 +1,62 @@
+export enum EUserConfigStoreNamespace {
+  Invalid,
+  Library,
+}
+
+export enum EConflictResolutionMethod {
+  LastWriteWins = 'last-write',
+  CustomMethod = 'custom',
+  InitializationOnly = 'initial',
+}
+
+export declare class CUserLocalStorage {
+  GetObject<T extends object>(key: string): Promise<T | null>;
+  GetString(key: string): Promise<string | null>;
+
+  /**
+   * @param resolutionMethodId Must include if selecting
+   * {@link EConflictResolutionMethod.CustomMethod}.
+   */
+  RemoveObject(key: string, resolutionMethod: EConflictResolutionMethod, resolutionMethodId?: string): Promise<void>;
+
+  /**
+   * @param resolutionMethodId Must include if selecting
+   * {@link EConflictResolutionMethod.CustomMethod}.
+   */
+  StoreObject<T extends object>(
+    key: string,
+    value: T,
+    resolutionMethod?: EConflictResolutionMethod,
+    resolutionMethodId?: string,
+  ): Promise<void>;
+}
+
+export declare class CCloudStorage extends CUserLocalStorage {
+  m_eNamespace: EUserConfigStoreNamespace;
+
+  Get(key: string): string | null;
+  GetByPrefix(prefix: string): Map<string, string>;
+  GetMapForPrefix(prefix: string): CCloudStorageMap;
+
+  /**
+   * @param resolutionMethodId Must include if selecting
+   * {@link EConflictResolutionMethod.CustomMethod}.
+   */
+  StoreString(
+    key: string,
+    value: string,
+    resolutionMethod?: EConflictResolutionMethod,
+    resolutionMethodId?: string,
+  ): Promise<void>;
+}
+
+export interface CCloudStorageMap
+  extends Map<string, string>, Pick<CCloudStorage, 'GetObject' | 'StoreObject' | 'StoreString'> {
+  m_cloudStorage: CCloudStorage;
+  m_strKeyPrefix: string;
+
+  /**
+   * The backing Map for all the inherited methods.
+   */
+  get mapInternal(): Map<string, string>;
+}

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

@@ -1,6 +1,6 @@
 import type { EResult, JsPbMessage, OperationResponse, Unregisterable, VDFBoolean_t } from "./shared";
 import type { EControllerRumbleSetting, EThirdPartyControllerConfiguration } from "./Input";
-import {EUCMFilePrivacyState, Screenshot} from "./Screenshots";
+import { EUCMFilePrivacyState, Screenshot } from "./Screenshots";
 
 /**
  * Represents various functions related to Steam applications.
@@ -1282,7 +1282,7 @@ export interface Badge {
   strNextLevelName: string;
 }
 
-interface AppDescription {
+export interface AppDescription {
   /**
    * Full app description. Note that it uses BB code and so must be rendered.
    */

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

@@ -39,7 +39,7 @@ export interface Auth {
 }
 
 export interface AuthRefreshInfo {
-    reason: number;
+    reason: EResult;
     account_name: string;
     login_id_token: string;
 }
@@ -102,4 +102,4 @@ export enum EGamingDeviceType {
     Handheld = 512,
     Phone = 528,
     SteamDeck = 544,
-}
+}

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

@@ -1,4 +1,4 @@
-import { BrowserContext } from "./shared";
+import { BrowserContext } from '../shared/interfaces';
 
 export interface ClientNotifications {
     /**

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

@@ -1,4 +1,5 @@
-import type { EBrowserType, ESteamRealm, EUIComposition, EUIMode, Unregisterable } from "./shared";
+import type { EBrowserType, ESteamRealm, EUIMode } from '../shared/enums';
+import type { EUIComposition, Unregisterable } from './shared';
 
 export interface Overlay {
     /**

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

@@ -72,7 +72,7 @@ export interface Screenshots {
      * @param hHandle The handle of the screenshot.
      * @returns the screenshot path or the screenshot directory if no such handle.
      */
-    GetLocalScreenshotPath(appId: number, hHandle: number): Promise<string>;
+    GetLocalScreenshotPath(appId: string, hHandle: number): Promise<string>;
 
     /**
      * Retrieves the number of games with local screenshots.

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

@@ -207,7 +207,7 @@ interface AvailableClientBeta {
     strName: string;
 }
 
-interface SteamSettings {
+export interface SteamSettings {
     bIsInClientBeta: boolean;
     bIsSteamSideload: boolean;
     eClientBetaState: EClientBetaState;

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

@@ -1,4 +1,5 @@
-import { ESteamRealm, Unregisterable } from "./shared";
+import type { ESteamRealm } from '../shared/enums';
+import type { Unregisterable } from './shared';
 
 /**
  * `hSharedConnection` is the number from {@link AllocateSharedConnection}.

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

@@ -1,5 +1,6 @@
-import { EUIMode, Unregisterable } from "./shared";
-import {EOSType} from "./system";
+import type { EUIMode } from '../shared/enums';
+import type { EResult, Unregisterable } from './shared';
+import type { EOSType } from './system';
 
 export interface UI {
     EnsureMainWindowCreated(): void;
@@ -33,10 +34,7 @@ export interface UI {
      */
     RegisterForClientConVar(convar: string, callback: (value: string) => void): Unregisterable;
 
-    /**
-     * @todo param{0,1} are enums
-     */
-    RegisterForErrorCondition(callback: (param0: number, param1: number) => void): Unregisterable;
+    RegisterForErrorCondition(callback: (param0: ERefreshLoginReason, param1: EResult) => void): Unregisterable;
 
     RegisterForKioskModeResetSignal(callback: () => void): Unregisterable;
 
@@ -56,6 +54,17 @@ export interface UI {
     SetUIMode(mode: EUIMode): void;
 }
 
+export enum ERefreshLoginReason {
+  Success = 1,
+  LoggedInElsewhere,
+  SteamGuard,
+  AccountDisabled,
+  Offline,
+  UnhandledMailTo,
+  Success2,
+  InfoTicketExpired,
+}
+
 export enum EWindowType {
     MainGamepadUI,
     OverlayGamepadUI,

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

@@ -176,6 +176,10 @@ export interface ConnectionAttempt {
     rtCooldownExpiration: number;
 }
 
+interface FamilyGroupMember {
+  accountid: number;
+}
+
 export interface CurrentUser {
     NotificationCounts: {
         async_game_updates: number;
@@ -196,11 +200,27 @@ export interface CurrentUser {
     bSupportAlertActive: boolean;
     bSupportPopupMessage: boolean;
     clientinstanceid: string;
+    eFamilyGroupRole: EFamilyGroupRole;
     strAccountBalance: string;
     strAccountBalancePending: string;
     strAccountName: string;
     strFamilyGroupID: string;
+    /**
+     * @todo unused ?
+     */
+    strFamilyGroupName: string;
     strSteamID: string;
+    /**
+     * @todo unused ?
+     */
+    rgFamilyGroupMembers: FamilyGroupMember[];
+}
+
+export enum EFamilyGroupRole {
+  None,
+  Adult,
+  Child,
+  MAX,
 }
 
 export enum ELoginState {

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

@@ -1,5 +1,6 @@
-import {OverlayBrowserInfo} from "./Overlay";
-import { EResult, EUIMode, Unregisterable } from "./shared";
+import type { EUIMode } from '../shared/enums';
+import type { OverlayBrowserInfo } from './Overlay';
+import type { EResult, Unregisterable } from './shared';
 
 export interface WebChat {
     BSuppressPopupsInRestore(): Promise<boolean>;

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

@@ -112,37 +112,6 @@ export enum EResult {
   LimitedUserAccount,
 }
 
-export enum EBrowserType {
-  /**
-   * No window is created (like SharedJSContext).
-   */
-  OffScreen,
-  OpenVROverlay,
-  OpenVROverlay_Dashboard,
-  /**
-   * A normal window.
-   */
-  DirectHWND,
-  /**
-   * A borderless window.
-   */
-  DirectHWND_Borderless,
-  /**
-   * An initially hidden window.
-   * May be shown with {@link SteamClient.Window.ShowWindow}.
-   */
-  DirectHWND_Hidden,
-  ChildHWNDNative,
-  Offscreen_SteamUI = 12,
-  OpenVROverlay_Subview,
-}
-
-export enum ESteamRealm {
-  Unknown,
-  Global,
-  China,
-}
-
 /**
  * Controls how Gamescope renders the GamepadUI window when a game is running.
  */
@@ -172,47 +141,9 @@ export enum EUIComposition {
   OverlayKeyboard,
 }
 
-export enum EUIMode {
-  Unknown = -1,
-  GamePad = 4,
-  Desktop = 7,
-}
-
 /** 0 - false, 1 - true */
 export type VDFBoolean_t = 0 | 1;
 
-export interface BrowserContext {
-  /**
-   * Window type.
-   */
-  m_eBrowserType?: EBrowserType;
-
-  /**
-   * The UI mode in use.
-   */
-  m_eUIMode?: EUIMode;
-
-  /**
-   * @todo Appears when {@link m_eBrowserType} == 0 ?
-   */
-  m_gameID?: string;
-
-  /**
-   * @todo Same as `SteamClient.Browser.GetBrowserID()` ?
-   */
-  m_nBrowserID: number;
-
-  /**
-   * Game's app ID.
-   */
-  m_unAppID?: number;
-
-  /**
-   * If overlay, game's PID.
-   */
-  m_unPID: number;
-}
-
 /**
  * Represents the response of an operation. It appears to be not necessary to await for this operation response. It is only used to indicate the result of an operation.
  */

package/src/globals/stores/app.ts

@@ -0,0 +1,102 @@
+import type { CMInterface } from '../shared/cm';
+import type { CCloudStorage, EUserConfigStoreNamespace } from '../shared/storage';
+import type { CurrentUser, ELoginState } from '../steam-client/User';
+
+export interface CApp {
+  m_CurrentUser: CurrentUser;
+  m_bFinishedStage1: boolean;
+  m_bHaveShownSupportAlertModal: boolean;
+  m_bServicesInitialized: boolean;
+  m_bStartedStage2: boolean;
+  m_bWasEverLoggedIn: boolean;
+  m_cm: CMInterface;
+  m_eLoginState: ELoginState;
+  m_mapCloudStorage: Map<EUserConfigStoreNamespace, CCloudStorage>;
+
+  BFinishedInitStageOne(): boolean;
+
+  /**
+   * @returns `true` if there is a hardware survey pending.
+   */
+  BHardwareSurveyPending(): boolean;
+
+  BHasAckOnlyActiveSupportAlerts(): boolean;
+
+  BHasActiveSupportAlerts(): boolean;
+
+  /**
+   * @returns `true` if there is a currently logged in user.
+   */
+  BHasCurrentUser(): boolean;
+
+  /**
+   * @returns `true` if provided SteamID3 is in the current user's family group.
+   */
+  BIsFamilyGroupMember(steamid3: number): boolean;
+
+  /**
+   * @returns `true` if the current user is in a family group.
+   */
+  BIsInFamilyGroup(): boolean;
+
+  /**
+   * @returns `true` if Steam is in out of the box experience.
+   */
+  BIsInOOBE(): boolean;
+
+  /**
+   * @returns `true` if Steam is in offline mode.
+   */
+  BIsOfflineMode(): boolean;
+
+  BMustShowSupportAlertDialog(): boolean;
+
+  /**
+   * @todo Does not seem to be used.
+   */
+  BWasEverLoggedIn(): boolean;
+
+  /**
+   * @returns the cloud storage for the provided namespace.
+   */
+  GetCloudStorage(namespace: EUserConfigStoreNamespace): CCloudStorage | undefined;
+
+  /**
+   * Like {@link GetCloudStorage}, but for
+   * {@link EUserConfigStoreNamespace.Library}.
+   */
+  GetCloudStorageForLibrary(): CCloudStorage;
+
+  /**
+   * @returns the currently logged in user.
+   */
+  GetCurrentUser(): CurrentUser;
+
+  /**
+   * @returns the currently logged in user's family group ID.
+   */
+  GetFamilyGroupID(): CurrentUser['strFamilyGroupID'];
+
+  /**
+   * @returns the currently logged in user's family group name.
+   */
+  GetFamilyGroupName(): CurrentUser['strFamilyGroupName'];
+
+  /**
+   * @returns `true` if all services have been initialized.
+   */
+  GetServicesInitialized(): boolean;
+
+  OptOutOfSurvey(): void;
+
+  SendSurvey(): void;
+
+  ShowSupportAlertsModal(): void;
+
+  /**
+   * Wait until all stores (e.g. AppStore & SettingsStore globals) load.
+   *
+   * Full list of stores can be found in the `App.InitStage2` function def.
+   */
+  WaitForServicesInitialized(): Promise<boolean>;
+}