@decky/ui 4.15.0 → 4.16.0

package/src/globals/stores/libraryuistore.ts

@@ -0,0 +1,395 @@
+import type { CSteamID } from '../shared';
+import type { CMInterface } from '../shared/cm';
+import type { CUserLocalStorage } from '../shared/storage';
+import type { EAppType } from '../steam-client/App';
+import type {
+  CCollection,
+  CCollectionBase,
+  CCollectionFilterBase,
+  CDynamicCollectionFilter,
+  FilterOptionByIndex_t,
+  FilterSpec_t,
+} from './collectionstore';
+import type { SteamUIWindowInstance } from './steamuistore/window';
+import type { CStoreItem } from './storeitemcache';
+
+enum EGameListView {
+  /** Usually this */
+  kNormal = 1,
+  /** Single collection */
+  kSingleCollection = 10,
+  /** Searching */
+  kSearchResults = 11,
+}
+
+export enum EAppPropertiesSection {
+  General = 'general',
+  Compatibility = 'compatibility',
+  Updates = 'updates',
+  LocalFiles = 'localfiles',
+  Language = 'language',
+  Betas = 'betas',
+  Controller = 'controller',
+  Shortcut = 'shortcut',
+  Dlc = 'dlc',
+  Workshop = 'workshop',
+  Feedback = 'feedback',
+}
+
+export enum EControllerConfiguratorSection {
+  Main = 'Main',
+  Summary = 'Summary',
+  Preview = 'Preview',
+  ActionSets = 'ActionSets',
+  Buttons = 'Buttons',
+  Triggers = 'Triggers',
+  Sticks = 'Sticks',
+  Touchpads = 'Touchpads',
+  Gyroscopes = 'Gyroscopes',
+  VirtualMenus = 'VirtualMenus',
+  ChooseBinding = 'ChooseBinding',
+}
+
+export enum ESettingsZooSection {
+  Dropdowns = 'Dropdowns',
+  Modals = 'Modals',
+  Buttons = 'Buttons',
+  Sliders = 'Sliders',
+  Toggles = 'Toggles',
+  OtherControls = 'Misc',
+  Glyphs = 'Glyphs',
+  SVG = 'SVG',
+  Input = 'Input',
+  Type = 'Type',
+}
+
+export enum ESettingsZooDevSection {
+  DeveloperOptions = 'DeveloperOptions',
+  VRDeveloperOptions = 'VRDeveloperOptions',
+  AppSpotlight = 'AppSpotlight',
+  PlayNext = 'PlayNext',
+  Notifications = 'Notifications',
+  Share = 'Share',
+}
+
+interface GameListSelection_t {
+  nAppId: number;
+  strCollectionId: string;
+}
+
+/**
+ * You can get this by getting the "UIStoreLocalState" key from
+ * {@link CLibraryUIStore.m_localStorage}.
+ */
+interface LibraryState_t {
+  bGroupedByCollection: boolean;
+  bGroupBySharedLibraries: boolean;
+  bSortedByRecent: boolean;
+  collectionFilter: FilterSpec_t;
+  collectionFilterGamepad: FilterSpec_t;
+  currentSelection: GameListSelection_t;
+  eGameListView: EGameListView;
+  mapCollapsedState: Record<string, boolean>;
+  nVersion: number;
+}
+
+interface NavigateLibraryArgsMap_t {
+  /** appid */
+  collection: number;
+  /** Value is in the format of `{appid}` or `{appid}|{collection id}` */
+  details: string;
+  downloads: undefined;
+  // NavigateToCollectionSaveDialog arg
+  'dynamic-collection': any;
+  /** Value is in the format of `{appid}` or `{appid}|{partner event id}` */
+  event: string;
+  games: undefined;
+  library: undefined;
+  media: undefined;
+  recent: undefined;
+  // NavigateToSharedAppsDesktopUI arg
+  'shared-apps': any;
+  view:
+    | 'all'
+    | 'all-collections'
+    | 'games'
+    | 'installed'
+    | 'login'
+    | 'recent'
+    | 'software'
+    | 'soundtracks'
+    | 'tools'
+    | 'videos';
+
+  // #region BPM only
+  /**
+   * Value is in the format of `{appid}|{section}`
+   *
+   * For section names see {@link EAppPropertiesSection}
+   */
+  appproperties: string;
+  apprunning: undefined;
+  /**
+   * Value is in the format of `{appid}|{section}|{browser history state json ?}`
+   *
+   * For section names see {@link EControllerConfiguratorSection}
+   */
+  controllerconfigurator: string;
+  /** TODO: what is this */
+  gamepadapiosk: undefined;
+  search: undefined;
+  settings:
+    | 'general'
+    | 'display'
+    | 'internet'
+    | 'bluetooth'
+    | 'audio'
+    | 'storage'
+    | 'system'
+    | 'internal'
+    | 'developer'
+    | 'controller'
+    | 'downloads'
+    | 'remoteplay'
+    | 'library'
+    | 'family';
+  settingszoo: ESettingsZooSection | ESettingsZooDevSection;
+  // #endregion
+}
+
+export interface CLibraryUIStore {
+  m_RecentGamesFirstApp: number;
+  m_bGameListGroupedByCollection: boolean;
+  m_bGameListGroupedBySharedLibraries: boolean;
+  m_bGameListSortedByRecent: boolean;
+  m_bIsCollectionEditorOpen: boolean;
+  m_bIsCollectionRenameOpen: boolean;
+  m_bIsSearchByTypePaneOpen: boolean;
+  m_cm: CMInterface;
+  m_collectionsAppFilter: CCollectionFilterBase;
+  m_collectionsAppFilterGamepad: CCollectionFilterBase;
+  m_currentAppFilter: CCollectionFilterBase;
+  m_eSelectedGameListView: EGameListView;
+  m_gameListSelection: GameListSelection_t;
+  m_latchedMostRecentApp: number;
+  m_localStorage: CUserLocalStorage;
+  m_mapLibrarySectionCollapseState: Map<string, boolean>;
+  m_setClientSuggestionIds: Set<number>;
+  m_setStoreSuggestionIds: Set<number>;
+  // not a mistake, actually valve
+  m_setStoreSuggestions: CStoreItem[];
+
+  /**
+   * @returns `true` if searching by app type.
+   */
+  BIsSearchByTypeActive(): boolean;
+
+  /**
+   * @returns `true` if the advanced search pane is open.
+   */
+  BIsSearchByTypePaneOpen(): boolean;
+
+  BIsSuggestionVisible(appid: number): boolean;
+
+  /**
+   * @returns `true` if searching by app name.
+   */
+  BIsTextSearchActive(): boolean;
+
+  CleanupCollapseStateMap(): void;
+
+  /**
+   * Collapses all visible collections.
+   */
+  CollapseAll(): void;
+
+  /**
+   * Switches to large mode if not already.
+   */
+  EnsureLargeMode(): void;
+
+  /**
+   * Resets the search and closes the advanced search pane.
+   */
+  ExitSearch(): void;
+
+  /**
+   * Collapses all visible collections.
+   */
+  ExpandAll(): void;
+
+  /**
+   * Expands or collapses all collections from the provided argument.
+   */
+  ExpandOrCollapseAll(collapse: boolean): void;
+
+  // SendMsgSearchAppDataCacheByStoreKeywords
+  FetchSearchSuggestions(query: string): Promise<void>;
+
+  /**
+   * @returns the active window instance.
+   */
+  GetActiveWindowInstance(): SteamUIWindowInstance;
+
+  /**
+   * @returns all collections, including system ones.
+   */
+  GetCollectionList(): Array<CCollectionBase | CCollection>;
+
+  /**
+   * @returns the last game played from recent games.
+   */
+  GetRecentGamesFirstApp(): number;
+
+  /**
+   * @returns all visible collections.
+   */
+  GetVisibleCollections(): Array<CCollectionBase | CCollection>;
+
+  InitializeAppFilter(state: LibraryState_t, param1?: boolean): CCollectionFilterBase;
+
+  /**
+   * @returns `true` if provided collection is collapsed.
+   */
+  IsCollapsed(collectionId: string): boolean;
+
+  /**
+   * @returns `true` if there is a BPM window open.
+   */
+  IsGamepadUIWindowActive(wnd?: SteamUIWindowInstance): boolean;
+
+  NavigateForward(): void;
+
+  // TODO: "value" isn't optional for some keys, but idk how to do that
+  NavigateLibrary<K extends keyof NavigateLibraryArgsMap_t>(
+    wnd: SteamUIWindowInstance | null,
+    key: K,
+    value?: NavigateLibraryArgsMap_t[K],
+  ): void;
+
+  NavigateToCollectionSaveDialog(param0: string): void;
+
+  NavigateToSharedAppsDesktopUI(json: string): void;
+
+  PreserveNavigation(): void;
+
+  /**
+   * Resets the search.
+   */
+  ResetSearch(): void;
+
+  RestoreNavigation(): void;
+
+  /**
+   * Saves current library settings to storage.
+   */
+  SaveLocalState(): Promise<void>;
+
+  /**
+   * @todo Is there a better way to extract args from SelectOption *but* retain
+   * the template ? Parameters<T> will just get me "EFilterGroup.Partner" for
+   * "group" and "EPartnerCollection | number" for "option". For now, see
+   * {@link CCollectionFilterBase.SelectOption}
+   */
+  SelectCollectionsAppFilterOption<K extends keyof FilterOptionByIndex_t>(
+    group: K,
+    option: FilterOptionByIndex_t[K],
+    value: boolean,
+  ): Promise<void>;
+
+  SelectGameListView(param0: EGameListView, collectionId: string): void;
+
+  /**
+   * @todo Is there a better way to extract args from SelectOption *but* retain
+   * the template ? Parameters<T> will just get me "EFilterGroup.Partner" for
+   * "group" and "EPartnerCollection | number" for "option". For now, see
+   * {@link CCollectionFilterBase.SelectOption}
+   */
+  SelectGamepadCollectionsAppFilterOption<K extends keyof FilterOptionByIndex_t>(
+    group: K,
+    option: FilterOptionByIndex_t[K],
+    value: boolean,
+  ): Promise<void>;
+
+  /**
+   * Shows/hides the dynamic collection's advanced search pane.
+   */
+  SetCollectionEditorOpen(value: boolean): void;
+
+  /**
+   * Shows/hides the rename collection text field.
+   */
+  SetCollectionRenameOpen(value: boolean): void;
+
+  /**
+   * Sets the game list to (not) be grouped by collections.
+   */
+  SetGameListGroupedByCollection(value: boolean): void;
+
+  SetGameListGroupedBySharedLibrary(value: boolean): void;
+
+  // look at the function name... it should do *that* but it doesn't? i swear it
+  // used to
+  SetGameListSelection(strCollectionId: string, nAppId: number): Promise<void>;
+
+  /**
+   * Sets the game list to (not) be sorted by recently played.
+   */
+  SetGameListSortedByRecent(value: boolean): void;
+
+  /**
+   * Sets the provided collection's collapsed state.
+   */
+  SetIsCollapsed(collectionId: string, value: boolean): void;
+
+  SetMultiSelectHooksForGameListSelection(): void;
+
+  SetRecentGamesFirstApp(appid: number): void;
+
+  /**
+   * Shows/hides the advanced search pane.
+   */
+  SetSearchByTypePaneOpen(value: boolean): void;
+
+  /**
+   * Starts searching for `query`.
+   */
+  SetSearchText(query: string): Promise<void>;
+
+  ShowCollectionViewWithAppTypes(...appTypes: EAppType[]): void;
+
+  // lol wtf is this
+  ShowDurationControlDialog(callbacks: { ConfirmContinue: () => void; Cancel: () => void } | null): void;
+
+  /**
+   *
+   * @param filter
+   * @param steamIds Steam3 IDs
+   */
+  ShowSharedAppsInLibrary(filter: CDynamicCollectionFilter, steamIds: number[]): void;
+
+  StartSearchByType(filter: CCollectionFilterBase): void;
+
+  /**
+   * Toggles the provided collection's collapsed state.
+   */
+  toggleCollapsed(collectionId: string): void;
+
+  UpdateGameListSelection(): void;
+
+  get bIsGameListGroupedByCollection(): boolean;
+  get bIsGameListGroupedBySharedLibraries(): boolean;
+  get bIsGameListSortedByRecent(): boolean;
+  get clientSearchSuggestionIds(): Set<number>;
+  get collectionsAppFilter(): CCollectionFilterBase;
+  get collectionsAppFilterGamepad(): CCollectionFilterBase;
+  get currentAppFilter(): CCollectionFilterBase;
+  get currentCollectionID(): string;
+  get currentGameListSelection(): GameListSelection_t;
+  get currentUserSteamID(): CSteamID;
+  get isCollectionEditorOpen(): boolean;
+  get isCollectionRenameOpen(): boolean;
+  get searchSuggestionIds(): Set<number>;
+  get searchSuggestions(): CStoreItem[];
+  get selectedGameListView(): EGameListView;
+}

package/src/globals/stores/localizationmanager.ts

@@ -0,0 +1,56 @@
+import type { ESteamRealm } from '../shared/enums';
+import type { CCallbackList } from '../shared/interfaces';
+import type { ELanguage } from '../steam-client/Settings';
+
+export interface CLocalizationManager {
+  m_cbkTokensChanged: CCallbackList;
+  m_mapFallbackTokens: Map<string, string>;
+  m_mapTokens: Map<string, string>;
+  m_rgLocalesToUse: string[];
+
+  /**
+   * Adds the provided list of tokens to the token map.
+   */
+  AddTokens(dict: Record<string, string>, fallback?: Record<string, string>): void;
+
+  /**
+   * @returns `true` if the string looks like a token (starts with a "#").
+   */
+  BLooksLikeToken(value: string): boolean;
+
+  GetELanguageFallbackOrder(realm?: ESteamRealm): ELanguage[];
+
+  /**
+   * @returns user's preferred locales.
+   */
+  GetPreferredLocales(): string[];
+
+  GetTokensChangedCallbackList(): CCallbackList;
+
+  /**
+   * Localizes a token.
+   *
+   * @returns a localized string.
+   */
+  LocalizeString(token: string, failSilently?: boolean): string;
+
+  /**
+   * Like {@link LocalizeString}, but falls back to the given string
+   * if not found.
+   *
+   * @returns a localized or the given string.
+   */
+  LocalizeIfToken(token: string, failSilently?: boolean): string;
+
+  /**
+   * Like {@link LocalizeString}, but uses fallback tokens instead.
+   *
+   * @returns a localized string.
+   */
+  LocalizeStringFromFallback(token: string): string;
+
+  /**
+   * Sets user's preferred locales.
+   */
+  SetPreferredLocales(locales: string[]): void;
+}

package/src/globals/stores/mainwindowbrowsermanager.ts

@@ -0,0 +1,135 @@
+import type { Action, Location } from '../shared/history';
+import type { CCallbackList } from '../shared/interfaces';
+import type {
+  BrowserViewHistory,
+  BrowserViewPageSecurity,
+  BrowserViewPopup,
+} from '../steam-client/browser-view/BrowserViewPopup';
+
+type SteamBrowserTab_t = 'community' | 'store' | 'me';
+
+type SteamBrowserTabs_t = {
+  [key in SteamBrowserTab_t]: string;
+};
+
+export interface SteamBrowserHistoryState {
+  /**
+   * @todo actually im not sure what this is
+   */
+  bExternal?: boolean;
+
+  /**
+   * Entry URL.
+   */
+  strURL?: string;
+}
+
+interface TabbedBrowserWebPageRequest {
+  requestid: number;
+  strLastURL: string;
+  strTitle: string;
+  strURL: string;
+}
+
+interface CTabbedBrowserStore {
+  m_cbWebPageRequestsChanged: CCallbackList;
+  m_nActiveWebpageRequestID: number;
+  m_nWebPageRequestID: number;
+  m_rgWebPageRequests: TabbedBrowserWebPageRequest[];
+
+  /**
+   * @param url Web page's URL. `data:text/html,<body></body>` by default.
+   */
+  AddWebPageRequest(url?: string, param1?: boolean): void;
+
+  GetWebPageRequestsChangedCallbackList(): CCallbackList;
+
+  /**
+   * Removes all requests and closes the browser.
+   */
+  RemoveAllRequests(): void;
+
+  RemoveWebPageRequest(requestId: number): boolean;
+
+  ReorderWebPageRequest(param0: number, param1: number): void;
+
+  /**
+   * @todo Probably used to init this.
+   */
+  Set(activeWebpageRequestId: number, webPageRequestId: number, webPageRequests: TabbedBrowserWebPageRequest[]): void;
+
+  /**
+   * @param requestId Web page request ID, like in
+   * {@link TabbedBrowserWebPageRequest.requestid}.
+   * @param url Web page's URL.
+   * @param title Web page's `<title>`.
+   *
+   * @returns `true` if request ID exists.
+   */
+  UpdateWebPageRequest(requestId?: number, url?: string, title?: string): boolean;
+}
+
+export interface CMainWindowBrowserManager {
+  m_URL: string;
+  m_URLRequested: string;
+  m_bExpectImportantReplace: boolean;
+  m_bLoading: boolean;
+  m_bRouterChangeTroggeredBySync: boolean;
+  m_browser: BrowserViewPopup;
+  m_browserHistory: BrowserViewHistory;
+  /**
+   * `History` in `index.d.ts` of https://www.npmjs.com/package/history/v/5.0.0
+   */
+  m_history: any;
+  m_lastActiveTab: SteamBrowserTab_t;
+  m_lastActiveTabURLs: SteamBrowserTabs_t;
+  m_lastLocation: Location<SteamBrowserHistoryState>;
+  m_loadErrorCode: number | null;
+  m_loadErrorDesc: string | null;
+  m_loadErrorURL: string | null;
+  m_pageSecurity: BrowserViewPageSecurity | null;
+  m_rootTabURLs: SteamBrowserTabs_t;
+  m_strTitle: string;
+  m_tabbedBrowserStore: CTabbedBrowserStore;
+  m_tsWaitingForBrowserChange: number | undefined;
+
+  /**
+   * Opens the provided tab in the browser.
+   */
+  ActivateTab(tab: SteamBrowserTab_t): void;
+
+  BIsWaitingForHistoryCallback(): boolean;
+
+  /**
+   * @returns the last active/opened tab in the browser.
+   */
+  GetLastActiveTab(): SteamBrowserTab_t;
+
+  /**
+   * @param url A Steam store/community URL.
+   * @returns a browser tab responsible for provided URL or `ignore` or
+   * `maintain`.
+   */
+  GetTabForURL(url: string): SteamBrowserTab_t | 'ignore' | 'maintain';
+
+  /**
+   * @todo Loads a URL, but `bExternal` is `false`.
+   */
+  LoadURL(url: string): void;
+
+  /**
+   * Reloads the current page.
+   */
+  Reload(): void;
+
+  /**
+   * @todo Loads a URL, but `bExternal` is `true`.
+   */
+  ShowURL(url: string, state: SteamBrowserHistoryState): void;
+
+  SyncWithNewBrowserHistory(entry: BrowserViewHistory): void;
+
+  SyncWithNewRouterEvent(location: Location<SteamBrowserHistoryState>, action: Action): void;
+
+  UpdateActiveTab(url: string): void;
+}