@decky/ui 4.15.0 → 4.16.0

package/src/globals/stores/appdetailsstore.ts

@@ -0,0 +1,235 @@
+import type {
+  AppAchievements,
+  AppAssociations,
+  AppDescription,
+  AppDetails,
+  LogoPosition,
+  SteamAppOverview,
+} from '../steam-client/App';
+import type { EResult } from '../steam-client/shared';
+
+type AjaxLibraryDetails_t = AppDescription &
+  Omit<AppAssociations, 'rgFranchises'> & {
+    appid: string;
+    name: string;
+    // TODO: GetLinks() somewhere maybe idek
+    rgSocialMedia: any[];
+    status: EResult;
+  };
+
+type AssetsWith2x_t<T extends string[]> = [
+  /**
+   * Relative to `https://steamloopback.host`.
+   */
+  cached2xAsset: string,
+  ...T,
+];
+
+/**
+ * Hero, header image, etc.
+ */
+type AppAssets_t = [
+  /**
+   * Relative to `https://steamloopback.host`.
+   */
+  cachedAsset: string,
+
+  /**
+   * Relative to `https://steamloopback.host`.
+   */
+  legacyCachedAsset: string,
+
+  /**
+   * Relative to {@link CURLStore.GetStoreAppImageURL}.
+   */
+  storeAsset: string,
+];
+
+/**
+ * Like {@link AppAssets_t}, but including custom assets.
+ */
+type AppAssetsWithCustomImage_t = [
+  /**
+   * Custom asset with the `.jpg` extension.
+   *
+   * Note that you will have to check if it exists, depending on what file type
+   * the user has uploaded.
+   * Relative to `https://steamloopback.host`. Empty if not set.
+   */
+  customJpgAsset: string,
+
+  /**
+   * Custom asset with the `.png` extension.
+   *
+   * Note that you will have to check if it exists, depending on what file type
+   * the user has uploaded.
+   * Relative to `https://steamloopback.host`. Empty if not set.
+   */
+  customPngAsset: string,
+
+  /**
+   * Relative to `https://steamloopback.host`.
+   */
+  cachedAsset: string,
+
+  /**
+   * Relative to `https://steamloopback.host`.
+   */
+  cachedLegacyAsset: string,
+
+  /**
+   * Relative to {@link CURLStore.GetStoreAppImageURL}.
+   */
+  storeAsset: string,
+];
+
+interface AppDetailsSpotlight {
+  data: {
+    events: any[];
+  };
+  dtLoaded: Date;
+}
+
+type LogoPositionInStorage = LogoPosition & {
+  nVersion: number;
+};
+
+interface AppData_t {
+  appDetailsSpotlight: AppDetailsSpotlight | null;
+  associationData: AppAssociations | null;
+  bLoadingAchievments: boolean;
+  cRegistered: number;
+  customImageInfo: LogoPositionInStorage | null;
+  /** UNIX timestamp. */
+  customImageInfoRtime: number;
+  descriptionsData: AppDescription | null;
+  details: AppDetails;
+}
+
+interface GetLogoImagesResult<T> {
+  logoPosition: LogoPosition;
+  rgLogoImages: T;
+}
+
+interface GetHeroImagesResult<T> {
+  appid: number;
+  bHasHeroImage: boolean;
+  rgHeroImages: T;
+}
+
+export declare class CAppDetailsStore {
+  m_mapAppData: Map<number, AppData_t>;
+
+  /**
+   * @param name Localized achievement name.
+   * @returns `true` if the app's provided achievement is hidden and achieved.
+   */
+  BAchievementIsHiddenAndAchieved(appid: number, name: string): boolean;
+
+  /**
+   * @returns `true` if the provided app has community market support.
+   */
+  BHasMarketPresence(details: AppDetails): boolean;
+
+  /**
+   * @returns `true` if the provided app was recently () launched.
+   * @todo broken ? doesn't work lol
+   */
+  BHasRecentlyLaunched(details: AppDetails): boolean;
+
+  /**
+   * @returns `true` if the provided app has workshop support.
+   */
+  BIsWorkshopVisible(details: AppDetails): boolean;
+
+  /**
+   * Resets the provided app's custom logo position to default.
+   */
+  ClearCustomLogoPosition(overview: SteamAppOverview): Promise<void>;
+
+  /**
+   * @returns the provided app's achievements.
+   * @throws if data hasn't been loaded yet. Call {@link RequestAchievements}
+   * before calling this in order to avoid it! (Most likely a bug in
+   * {@link RequestAchievements}, since GetAchievement *does* call it if data
+   * hasn't been loaded yet.)
+   */
+  GetAchievements(appid: number): AppAchievements;
+
+  GetAjaxLibraryAppDetails(appid: number): Promise<AjaxLibraryDetails_t | null>;
+
+  GetAppData(appid: number): AppData_t;
+
+  GetAppDetails(appid: number): AppDetails | null;
+
+  GetAppDetailsSpotlight(appid: number): AppDetailsSpotlight;
+
+  /**
+   * @returns the provided app's associations (developers, publishers, franchises, etc.).
+   */
+  GetAssociations(appid: number): AppAssociations;
+
+  /**
+   * @returns the provided app's custom logo position or `null` if not loaded
+   * yet or `undefined` if not set.
+   */
+  GetCustomLogoPosition(appid: number): LogoPosition | null | undefined;
+
+  GetDescriptions(appid: number): AppDescription;
+
+  GetHeaderImages<T extends boolean>(
+    overview: SteamAppOverview,
+    prefer2x?: T,
+  ): T extends true ? AssetsWith2x_t<AppAssetsWithCustomImage_t> : AppAssetsWithCustomImage_t;
+
+  GetHeaderImagesForAppId<T extends boolean>(
+    appid: number,
+    localCacheVersion?: number,
+    storeAssetMtime?: number,
+    prefer2x?: T,
+  ): T extends true ? AssetsWith2x_t<AppAssets_t> : AppAssets_t;
+
+  GetHeroBlurImages(overview: SteamAppOverview): AppAssetsWithCustomImage_t;
+
+  GetHeroBlurImagesForAppId(appid: number, localCacheVersion?: number, storeAssetMtime?: number): AppAssets_t;
+
+  GetHeroImages(overview: SteamAppOverview): GetHeroImagesResult<AppAssetsWithCustomImage_t>;
+
+  GetHeroImagesForAppId(
+    appid: number,
+    localCacheVersion?: number,
+    storeAssetMtime?: number,
+  ): GetHeroImagesResult<AppAssets_t>;
+
+  GetLogoImages(overview: SteamAppOverview): GetLogoImagesResult<AppAssetsWithCustomImage_t>;
+
+  GetLogoImagesForAppId(
+    appid: number,
+    localCacheVersion?: number,
+    storeAssetMtime?: number,
+  ): GetLogoImagesResult<AppAssets_t>;
+
+  RequestAppDetails(appid: number): Promise<AppDetails | undefined>;
+
+  RequestAchievements(appid: number): Promise<void>;
+
+  RequestAppDetailsSpotlight(appid: number): Promise<void>;
+
+  RequestAssociationData(appid: number): Promise<void>;
+
+  RequestCustomImageInfo(overview: SteamAppOverview): Promise<void>;
+
+  RequestDescriptionsData(appid: number): Promise<void>;
+
+  /**
+   * Sets a provided logo position for a specified app.
+   */
+  SaveCustomLogoPosition(overview: SteamAppOverview, position: LogoPosition): Promise<void>;
+
+  SetAjaxLibraryAppDetails(appid: number, data: AppData_t, details: AjaxLibraryDetails_t): void;
+
+  /**
+   * @returns `true` if the provided custom logo position is valid.
+   */
+  ValidateCustomImageInfo(info: LogoPositionInStorage): boolean;
+}

package/src/globals/stores/appinfostore.ts

@@ -0,0 +1,65 @@
+import type { CCallbackList } from '../shared';
+import type { EAppType } from '../steam-client/App';
+
+interface AppInfoCacheObject_t {
+  eAppType: EAppType;
+  strIconURL: string;
+  strName: string;
+  strUpdatedFromServer: string;
+}
+
+declare class CAppInfo {
+  m_unAppID: number;
+  m_bInitialized: boolean;
+  m_strName: string;
+  m_strIconURL: string;
+  m_dtUpdatedFromServer: Date;
+  m_eAppType: EAppType;
+
+  get appid(): number;
+  get is_initialized(): boolean;
+  get is_valid(): boolean;
+  get name(): string;
+  get icon_url_no_default(): string;
+  get time_updated_from_server(): Date;
+  get apptype(): EAppType;
+
+  /**
+   * @returns `true` if this app is an application or tool.
+   */
+  BIsApplicationOrTool(): boolean;
+
+  BuildAppURL(imageName: string): string;
+  DeserializeFromMessage(e: any): void;
+  DeserializeFromAppOverview(e: any): void;
+  DeserializeFromCacheObject(e: any): void;
+  SerializeToCacheObject(): AppInfoCacheObject_t | null;
+}
+
+export declare class CAppInfoStore {
+  m_mapAppInfo: Map<number, CAppInfo>;
+  m_mapRichPresenceLoc: any;
+  m_cAppInfoRequestsInFlight: number;
+  m_setPendingAppInfo: Set<unknown>;
+  m_PendingAppInfoPromise: any;
+  m_PendingAppInfoResolve: any;
+  m_CacheStorage: any | null;
+  m_fnCallbackOnAppInfoLoaded: CCallbackList;
+
+  BHavePendingAppInfoRequests(): boolean;
+  EnsureAppInfoForAppIDs(rgAppIDs: number[]): Promise<any>;
+  FlushPendingAppInfo(): Promise<void>;
+  GetAppInfo(appid: number): CAppInfo;
+  GetCacheKeyForAppID(appid: number): string;
+  GetRichPresenceLocAsync(e: any): any;
+  GetRichPresenceLoc(e: any): any;
+  IsLoadingAppID(appid: number): boolean;
+  LoadAppInfoBatchFromLocalCache(rgAppInfoBatch: any[]): Promise<any[]>;
+  LoadAppInfoBatch(rgAppInfoBatch: any[]): Promise<void>;
+  Localize(appid: number, strToken: string, r: any): any;
+  QueueAppInfoRequest(e: any): any;
+  QueueRichPresenceLocRequest(e: any): any;
+  RegisterCallbackOnLoad(callback: () => void): void;
+  SaveAppInfoBatchToLocalCache(rgAppInfoBatch: any[]): Promise<void>;
+  SetCacheStorage(storage: any): void;
+}

package/src/globals/stores/appstore.ts

@@ -0,0 +1,166 @@
+import type { SteamAppOverview, SteamAppOverviewRemoteClientData } from '../steam-client/App';
+import type { EGenre, EStoreCategory } from './collectionstore';
+
+// protoMsg here is CAppOverview or something
+export interface IAppOverview extends SteamAppOverview {
+  m_setStoreCategories: Set<EStoreCategory>;
+  m_setStoreTags: Set<EGenre>;
+
+  BAreCategoriesEqual(protoMsg: any): boolean;
+  BAreSetsEqual(lhs: Set<any>, rhs: Set<any>): boolean;
+  BAreStoreTagsEqual(): boolean;
+  BHasCustomImages(): boolean;
+  BHasStoreCategory(category: EStoreCategory): boolean;
+  BHasStoreTag(tag: EGenre): boolean;
+  BIsAppBlocked(): boolean;
+  BIsAppInBlockList(): boolean;
+  BIsApplicationOrTool(): boolean;
+  BIsBorrowed(): boolean;
+  BIsDemo(): boolean;
+  BIsGameIDEqual(protoMsg: any): boolean;
+  BIsHardware(): boolean;
+  BIsLastTimePlayedEqual(protoMsg: any): boolean;
+  BIsModOrShortcut(): boolean;
+  BIsMusicAlbum(): boolean;
+  BIsNewToLibrary(): boolean;
+  BIsOwned(): boolean;
+  BIsOwnedByAnotherUser(): boolean;
+  BIsPerClientDataEqual(protoMsg: any): boolean;
+  BIsPerClientDataLocal(protoMsg: any): boolean;
+  BIsSelectedClientLocal(): boolean;
+  BIsShortcut(): boolean;
+  BIsSortAsEqual(protoMsg: any): boolean;
+  BIsSteamDeckVerified(): boolean;
+  BIsSteamOSCompatible(): boolean;
+  BIsSteamVR(): boolean;
+  BIsUnreleased(): boolean;
+  BIsVisibleInMRUList(): boolean;
+  BSupportsVR(): boolean;
+  GetCanonicalReleaseDate(): number;
+  GetCanonicalReleaseYear(): string;
+  GetGameID(): string;
+  GetLastPlayedSectionName(): string;
+  GetLastTimePlayed(): number;
+  GetPerClientData(which: 'local' | 'mostavailable' | 'selected'): SteamAppOverviewRemoteClientData;
+  GetPrimaryAppID(): number;
+  GetStoreTags(): Set<EGenre>;
+}
+
+interface StoreTag {
+  nTagId: EGenre;
+  nCount: number;
+}
+
+export declare class CAppStore {
+  m_bIsInitialized: boolean;
+  m_mapApps: Map<IAppOverview, string>;
+  m_mapStoreTagLocalization: Map<EGenre, string>;
+  m_msTagMapLoaded: number;
+
+  /**
+   * @returns the soundtrack's album cover URL or `null` if not a soundtrack.
+   */
+  GetAlbumCoverURLForApp(app: SteamAppOverview): string | null;
+
+  /**
+   * @returns the overview for a provided app ID.
+   */
+  GetAppOverviewByAppID(appid: number): SteamAppOverview | null;
+
+  /**
+   * @returns the overview for a provided app ID.
+   */
+  GetAppOverviewByGameID(gameid: string): SteamAppOverview | null;
+
+  /**
+   * Like {@link GetAlbumCoverURLForApp}, but the URL is relative to
+   * `https://steamloopback.host`.
+   */
+  GetCachedAlbumCoverURL(app: SteamAppOverview): string | null;
+
+  /**
+   * Like {@link GetVerticalCapsuleURLForApp}, but the URL is relative to
+   * `https://steamloopback.host`.
+   */
+  GetCachedVerticalCapsuleURL(app: SteamAppOverview): string[];
+
+  /**
+   * @returns the app's custom hero image URLs.
+   * @see {@link GetCustomImageURLs}
+   */
+  GetCustomHeroImageURLs(app: SteamAppOverview): string[];
+
+  /**
+   * You most likely want to use {@link GetCustomHeroImageURLs},
+   * {@link GetCustomLandcapeImageURLs}, {@link GetCustomLogoImageURLs} or
+   * {@link GetCustomVerticalCapsuleURLs} instead!
+   *
+   * Gets the URLs for the provided asset.
+   *
+   * Note that only one of them will be available, depending on which extension
+   * ("jpg" or "png") was uploaded.
+   *
+   * @param assetName For example "", "_hero", "_logo", etc.
+   * @returns the URLs relative to `https://steamloopback.host` for the provided
+   * asset name.
+   */
+  GetCustomImageURLs(app: SteamAppOverview, assetName: string): string[];
+
+  /**
+   * @returns the custom hero image URLs.
+   * @see {@link GetCustomImageURLs}
+   */
+  GetCustomLandcapeImageURLs(app: SteamAppOverview): string[];
+
+  /**
+   * @returns the app's custom logo image URLs.
+   * @see {@link GetCustomImageURLs}
+   */
+  GetCustomLogoImageURLs(app: SteamAppOverview): string[];
+
+  /**
+   * @returns the app's custom vertical capsule image URLs.
+   * @see {@link GetCustomImageURLs}
+   */
+  GetCustomVerticalCapsuleURLs(app: SteamAppOverview): string[];
+
+  /**
+   * @returns the app's 32x32 icon URL.
+   */
+  GetIconURLForApp(app: SteamAppOverview): string;
+
+  /**
+   * @returns the localized string for a provided store category.
+   */
+  GetLocalizationForStoreTag(category: EGenre): string;
+
+  /**
+   * Like {@link GetVerticalCapsuleURLForApp}, but "pregenerated" here means
+   * that if the app doesn't have a vertical capsule (usually older apps), then
+   * it will return its hero instead with blur on the side to match the size.
+   *
+   * @returns the app's vertical capsule URL.
+   */
+  GetPregeneratedVerticalCapsuleForApp(app: SteamAppOverview): string;
+
+  /**
+   * @returns the app's store page URL.
+   */
+  GetStorePageURLForApp(app: SteamAppOverview): string;
+
+  /**
+   * Gets the similiar store tags from a provided localized string.
+   *
+   * @param s The string to match.
+   */
+  GetTopStoreTags(s: string): StoreTag[];
+
+  /**
+   * @returns the app's vertical capsule URL.
+   */
+  GetVerticalCapsuleURLForApp(app: SteamAppOverview): string;
+
+  get allApps(): IAppOverview[];
+  get sharedLibraryAccountIds(): number[];
+  get siteLicenseApps(): { strSiteName: string; rgApps: IAppOverview[] } | null;
+}

package/src/globals/stores/badgestore.ts

@@ -0,0 +1,87 @@
+import type { VDFBoolean_t } from '../steam-client/shared';
+
+interface BadgeCard_t {
+  strName: string;
+  strTitle: string;
+  strImgURL: string;
+  strArtworkURL: string;
+  strMarketHash: string;
+  nOwned: 0;
+}
+
+interface BadgeInfo_t {
+  bMaxed: VDFBoolean_t;
+  dtNextRetry: number;
+  strIconURL: string;
+  strName: string;
+  strNextLevelName: string;
+  nLevel: number;
+  nMaxLevel: number;
+  nXP: number;
+  nNextLevelXP: number;
+  rgCards: BadgeCard_t[];
+}
+
+// Seems like there are protobufs for this named
+// "CQuest_GetCommunityItemDefinitions_Response_ItemDefinition"
+// & "CommunityItemDefinition" but they are not in SteamDatabase/SteamTracking
+// but present in some js files... don't wanna do shit with it right now
+interface CommunityItemDefinition {
+  active: boolean;
+  appid: number;
+  item_class: number;
+  item_description: string;
+  item_image_composed: string;
+  item_image_composed_foil: string;
+  item_image_large: string;
+  item_image_small: string;
+  item_internal_name: string;
+  item_last_changed: number;
+  item_movie_mp4: string;
+  item_movie_mp4_small: string;
+  item_movie_webm: string;
+  item_movie_webm_small: string;
+  item_name: string;
+  item_series: number;
+  item_title: string;
+  item_type: number;
+}
+
+export declare class CBadgeStore {
+  m_mapBadgeData: Map<number, BadgeInfo_t>;
+  m_mapCommunityItemDefs: Map<number, CommunityItemDefinition[]>;
+
+  /**
+   * Fetches badge data for a provided app from the internet.
+   *
+   * @note It seems like there is a bug that won't let you run this if provided
+   * app's badge info has not been loaded yet, so you have to run the following
+   * before calling this:
+   * ```js
+   * badgeStore.m_mapBadgeData.set(appid, { dtNextRetry: 0 });
+   * ```
+   */
+  FetchBadgeData(appid: number): Promise<void>;
+
+  FetchCommunityItemDefinitions(appid: number): Promise<void>;
+
+  /**
+   * Gets badge info for a provided app. Call {@link FetchBadgeData} before
+   * calling this.
+   */
+  GetBadgeData(appid: number): BadgeInfo_t;
+
+  GetCommunityItemDefinition(
+    defs: CommunityItemDefinition[],
+    itemClass: number,
+    itemType: number,
+  ): CommunityItemDefinition | null;
+
+  GetCommunityItemDefinitions(appid: number): CommunityItemDefinition[];
+
+  /**
+   * Lets the provided app's badge data be fetched again, since it won't let you
+   * fetch it after it's been loaded already.
+   */
+  InvalidateBadgeData(appid: number): void;
+}