Merge pull request #143 from ai-zen/main

Update SDK to 1.58a and Add more method to the workshop mod.

Cargo.toml

@@ -11,7 +11,7 @@ napi = { version = "2.13.1", features = ["tokio_rt", "napi6", "serde-json"] }
 napi-derive = "2.13.0"
 lazy_static = "1"
 tokio = { version = "1", features = ["sync", "time"] }
-steamworks = { version="0.11.0", features = [ "serde", ] }
+steamworks = { version = "0.11.0", features = ["serde"] }
 serde = "1"
 serde_json = "1"
 

client.d.ts

@@ -297,6 +297,78 @@ export namespace workshop {
    * @returns an array of subscribed workshop item ids
    */
   export function getSubscribedItems(): Array<bigint>
+  export const enum UGCQueryType {
+    RankedByVote = 0,
+    RankedByPublicationDate = 1,
+    AcceptedForGameRankedByAcceptanceDate = 2,
+    RankedByTrend = 3,
+    FavoritedByFriendsRankedByPublicationDate = 4,
+    CreatedByFriendsRankedByPublicationDate = 5,
+    RankedByNumTimesReported = 6,
+    CreatedByFollowedUsersRankedByPublicationDate = 7,
+    NotYetRated = 8,
+    RankedByTotalVotesAsc = 9,
+    RankedByVotesUp = 10,
+    RankedByTextSearch = 11,
+    RankedByTotalUniqueSubscriptions = 12,
+    RankedByPlaytimeTrend = 13,
+    RankedByTotalPlaytime = 14,
+    RankedByAveragePlaytimeTrend = 15,
+    RankedByLifetimeAveragePlaytime = 16,
+    RankedByPlaytimeSessionsTrend = 17,
+    RankedByLifetimePlaytimeSessions = 18,
+    RankedByLastUpdatedDate = 19
+  }
+  export const enum UGCType {
+    Items = 0,
+    ItemsMtx = 1,
+    ItemsReadyToUse = 2,
+    Collections = 3,
+    Artwork = 4,
+    Videos = 5,
+    Screenshots = 6,
+    AllGuides = 7,
+    WebGuides = 8,
+    IntegratedGuides = 9,
+    UsableInGame = 10,
+    ControllerBindings = 11,
+    GameManagedItems = 12,
+    All = 13
+  }
+  export const enum UserListType {
+    Published = 0,
+    VotedOn = 1,
+    VotedUp = 2,
+    VotedDown = 3,
+    Favorited = 4,
+    Subscribed = 5,
+    UsedOrPlayed = 6,
+    Followed = 7
+  }
+  export const enum UserListOrder {
+    CreationOrderAsc = 0,
+    CreationOrderDesc = 1,
+    TitleAsc = 2,
+    LastUpdatedDesc = 3,
+    SubscriptionDateDesc = 4,
+    VoteScoreDesc = 5,
+    ForModeration = 6
+  }
+  export interface WorkshopItemStatistic {
+    numSubscriptions?: bigint
+    numFavorites?: bigint
+    numFollowers?: bigint
+    numUniqueSubscriptions?: bigint
+    numUniqueFavorites?: bigint
+    numUniqueFollowers?: bigint
+    numUniqueWebsiteViews?: bigint
+    reportScore?: bigint
+    numSecondsPlayed?: bigint
+    numPlaytimeSessions?: bigint
+    numComments?: bigint
+    numSecondsPlayedDuringTimePeriod?: bigint
+    numPlaytimeSessionsDuringTimePeriod?: bigint
+  }
   export interface WorkshopItem {
     publishedFileId: bigint
     creatorAppId?: number
@@ -308,6 +380,9 @@ export namespace workshop {
     timeCreated: number
     /** Time updated in unix epoch seconds format */
     timeUpdated: number
+    /** Time when the user added the published item to their list (not always applicable), provided in Unix epoch format (time since Jan 1st, 1970). */
+    timeAddedToUserList: number
+    visibility: UgcItemVisibility
     banned: boolean
     acceptedForUse: boolean
     tags: Array<string>
@@ -317,13 +392,34 @@ export namespace workshop {
     numDownvotes: number
     numChildren: number
     previewUrl?: string
+    statistics: WorkshopItemStatistic
+  }
+  export interface WorkshopPaginatedResult {
+    items: Array<WorkshopItem | undefined | null>
+    returnedResults: number
+    totalResults: number
+    wasCached: boolean
+  }
+  export interface WorkshopItemsResult {
+    items: Array<WorkshopItem | undefined | null>
+    wasCached: boolean
   }
-  export interface WorkshopItemQuery {
+  export interface WorkshopItemQueryConfig {
     cachedResponseMaxAge?: number
     includeMetadata?: boolean
     includeLongDescription?: boolean
+    includeAdditionalPreviews?: boolean
+    onlyIds?: boolean
+    onlyTotal?: boolean
     language?: string
+    matchAnyTag?: boolean
+    requiredTags?: Array<string>
+    excludedTags?: Array<string>
+    searchText?: string
+    rankedByTrendDays?: number
   }
-  export function getItem(item: bigint, query?: WorkshopItemQuery | undefined | null): Promise<WorkshopItem | null>
-  export function getItems(items: Array<bigint>, query?: WorkshopItemQuery | undefined | null): Promise<Array<WorkshopItem | undefined | null>>
+  export function getItem(item: bigint, queryConfig?: WorkshopItemQueryConfig | undefined | null): Promise<WorkshopItem | null>
+  export function getItems(items: Array<bigint>, queryConfig?: WorkshopItemQueryConfig | undefined | null): Promise<WorkshopItemsResult>
+  export function getAllItems(page: number, queryType: UGCQueryType, itemType: UGCType, creatorAppId: number, consumerAppId: number, queryConfig?: WorkshopItemQueryConfig | undefined | null): Promise<WorkshopPaginatedResult>
+  export function getUserItems(page: number, accountId: number, listType: UserListType, itemType: UGCType, sortOrder: UserListOrder, creatorAppId: number, consumerAppId: number, queryConfig?: WorkshopItemQueryConfig | undefined | null): Promise<WorkshopPaginatedResult>
 }

src/api/workshop.rs

@@ -16,6 +16,7 @@ pub mod workshop {
         pub needs_to_accept_agreement: bool,
     }
 
+    #[derive(Debug)]
     #[napi]
     pub enum UgcItemVisibility {
         Public,
@@ -24,9 +25,20 @@ pub mod workshop {
         Unlisted,
     }
 
-    impl From<UgcItemVisibility> for steamworks::PublishedFileVisibility {
-        fn from(visibility: UgcItemVisibility) -> Self {
+    impl From<steamworks::PublishedFileVisibility> for UgcItemVisibility {
+        fn from(visibility: steamworks::PublishedFileVisibility) -> Self {
             match visibility {
+                steamworks::PublishedFileVisibility::Public => UgcItemVisibility::Public,
+                steamworks::PublishedFileVisibility::FriendsOnly => UgcItemVisibility::FriendsOnly,
+                steamworks::PublishedFileVisibility::Private => UgcItemVisibility::Private,
+                steamworks::PublishedFileVisibility::Unlisted => UgcItemVisibility::Unlisted,
+            }
+        }
+    }
+
+    impl Into<steamworks::PublishedFileVisibility> for UgcItemVisibility {
+        fn into(self) -> steamworks::PublishedFileVisibility {
+            match self {
                 UgcItemVisibility::Public => steamworks::PublishedFileVisibility::Public,
                 UgcItemVisibility::FriendsOnly => steamworks::PublishedFileVisibility::FriendsOnly,
                 UgcItemVisibility::Private => steamworks::PublishedFileVisibility::Private,
@@ -96,6 +108,7 @@ pub mod workshop {
         pub total: BigInt,
     }
 
+    #[derive(Debug)]
     #[napi]
     pub enum UpdateStatus {
         Invalid,