feat: Add Item and NFT utility property (#268)

* feat: Add the utility property to the NFT and Item types * feat: Refresh API
decentraland · May 1, 2024 · 9d0091b · 9d0091b
1 parent 40cbf8b
commit 9d0091b
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/report/schemas.api.md b/report/schemas.api.md
@@ -965,6 +965,7 @@ export type Item = {
     maxListingPrice?: string | null;
     listings?: number | null;
     owners?: number | null;
+    utility?: string;
 };
 
 // @public (undocumented)
@@ -1305,6 +1306,7 @@ export type NFT = {
     updatedAt: number;
     soldAt: number;
     urn?: string;
+    utility?: string;
 };
 
 // @public (undocumented)
@@ -2697,15 +2699,15 @@ export namespace WorldConfiguration {
 // src/dapps/contract.ts:16:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
 // src/dapps/item.ts:30:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
 // src/dapps/item.ts:31:3 - (ae-incompatible-release-tags) The symbol "chainId" is marked as @public, but its signature references "ChainId" which is marked as @alpha
-// src/dapps/item.ts:69:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
+// src/dapps/item.ts:71:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
 // src/dapps/mint.ts:16:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
 // src/dapps/mint.ts:17:3 - (ae-incompatible-release-tags) The symbol "chainId" is marked as @public, but its signature references "ChainId" which is marked as @alpha
 // src/dapps/mint.ts:37:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
 // src/dapps/nft.ts:44:7 - (ae-incompatible-release-tags) The symbol "bodyShapes" is marked as @public, but its signature references "BodyShape" which is marked as @alpha
 // src/dapps/nft.ts:54:7 - (ae-incompatible-release-tags) The symbol "bodyShapes" is marked as @public, but its signature references "BodyShape" which is marked as @alpha
 // src/dapps/nft.ts:60:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
 // src/dapps/nft.ts:61:3 - (ae-incompatible-release-tags) The symbol "chainId" is marked as @public, but its signature references "ChainId" which is marked as @alpha
-// src/dapps/nft.ts:91:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
+// src/dapps/nft.ts:93:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
 // src/dapps/order.ts:18:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha
 // src/dapps/order.ts:19:3 - (ae-incompatible-release-tags) The symbol "chainId" is marked as @public, but its signature references "ChainId" which is marked as @alpha
 // src/dapps/order.ts:33:3 - (ae-incompatible-release-tags) The symbol "network" is marked as @public, but its signature references "Network" which is marked as @alpha

diff --git a/src/dapps/item.ts b/src/dapps/item.ts
@@ -42,6 +42,8 @@ export type Item = {
   maxListingPrice?: string | null
   listings?: number | null
   owners?: number | null
+  /** A description of the utility the item has in the explorer */
+  utility?: string
 }
 
 export type ItemFilters = {
@@ -177,6 +179,10 @@ export namespace Item {
         type: 'string',
         nullable: true
       },
+      utility: {
+        type: 'string',
+        nullable: true
+      },
       minListingPrice: {
         type: 'string',
         nullable: true

diff --git a/src/dapps/nft.ts b/src/dapps/nft.ts
@@ -63,6 +63,8 @@ export type NFT = {
   updatedAt: number
   soldAt: number
   urn?: string
+  /** A description of the utility the nft has in the explorer */
+  utility?: string
 }
 
 export type NFTFilters = {
@@ -144,6 +146,10 @@ export namespace NFT {
         type: 'string',
         nullable: true
       },
+      utility: {
+        type: 'string',
+        nullable: true
+      },
       openRentalId: {
         type: 'string',
         nullable: true