Change impl Form to impl Into. Refactoring `WorkshopItemStatistic…

…` and `WorkshopItem`, Add `WorkshopPaginatedResult` and `WorkshopItemsResult`. Add `time_added_to_user_list` and `time_added_to_user_list` for `WorkshopItem`.
ai-zen · Jan 21, 2024 · 8b78658 · 8b78658
1 parent d9aef31
commit 8b78658
Show file tree

Hide file tree

Showing 5 changed files with 114 additions and 93 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/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 = { git = "ssh://git@github.com/ai-zen/steamworks-rs.git", branch = "master", features = [
+steamworks = { git = "ssh://git@github.com/ai-zen/steamworks-rs.git", branch = "feature/ugc-result", features = [
     "serde",
 ] }
 serde = "1"

diff --git a/client.d.ts b/client.d.ts
@@ -349,8 +349,7 @@ export namespace workshop {
     VoteScoreDesc = 5,
     ForModeration = 6
   }
-  export interface WorkshopItemAdditionalInformation {
-    previewUrl?: string
+  export interface WorkshopItemStatistic {
     numSubscriptions?: bigint
     numFavorites?: bigint
     numFollowers?: bigint
@@ -376,6 +375,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>
@@ -384,14 +386,19 @@ export namespace workshop {
     numUpvotes: number
     numDownvotes: number
     numChildren: number
-    additional?: WorkshopItemAdditionalInformation
+    previewUrl?: string
+    statistics: WorkshopItemStatistic
   }
-  export interface WorkshopPageResult {
+  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 WorkshopItemQueryConfig {
     cachedResponseMaxAge?: number
     includeMetadata?: boolean
@@ -407,7 +414,7 @@ export namespace workshop {
     rankedByTrendDays?: number
   }
   export function getItem(item: bigint, queryConfig?: WorkshopItemQueryConfig | undefined | null): Promise<WorkshopItem | null>
-  export function getItems(items: Array<bigint>, queryConfig?: WorkshopItemQueryConfig | undefined | null): Promise<WorkshopPageResult>
-  export function getAllItems(page: number, queryType: UGCQueryType, itemType: UGCType, creatorAppId: number, consumerAppId: number, queryConfig?: WorkshopItemQueryConfig | undefined | null): Promise<WorkshopPageResult>
-  export function getUserItems(page: number, accountId: number, listType: UserListType, itemType: UGCType, sortOrder: UserListOrder, creatorAppId: number, consumerAppId: number, queryConfig?: WorkshopItemQueryConfig | undefined | null): Promise<WorkshopPageResult>
+  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>
 }
diff --git a/src/api/workshop.rs b/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,