feat: add individual data to trimmed response (#453)

Author: MauroCicerchia

src/controllers/handlers/explorer-handler.ts

@@ -1,14 +1,16 @@
-import { Entity, Network } from '@dcl/schemas'
+import { Network } from '@dcl/schemas'
 import { fetchThirdPartyWearablesFromThirdPartyName } from '../../logic/fetch-elements/fetch-third-party-wearables'
 import { fetchAndPaginate, paginationObject } from '../../logic/pagination'
 import { createCombinedSorting } from '../../logic/sorting'
 import { ExplorerWearableEntity, parseUrn, buildTrimmedEntity } from '../../logic/utils'
 import {
   AppComponents,
-  BaseWearable,
   HandlerContextWithPath,
   InvalidRequestError,
-  OnChainWearable,
+  MixedBaseWearable,
+  MixedOnChainWearable,
+  MixedThirdPartyWearable,
+  MixedWearable,
   PaginatedResponse,
   ThirdPartyWearable
 } from '../../types'
@@ -20,23 +22,6 @@ export const THIRD_PARTY = 'third-party'
 
 const VALID_COLLECTION_TYPES = ['base-wearable', 'on-chain', 'third-party']
 
-export type MixedBaseWearable = BaseWearable & {
-  type: typeof BASE_WEARABLE
-  entity: Entity
-}
-
-export type MixedOnChainWearable = OnChainWearable & {
-  type: typeof ON_CHAIN
-  entity: Entity
-}
-
-export type MixedThirdPartyWearable = ThirdPartyWearable & {
-  type: typeof THIRD_PARTY
-}
-
-export type MixedWearable = (MixedBaseWearable | MixedOnChainWearable | MixedThirdPartyWearable) &
-  Partial<Pick<OnChainWearable, 'rarity' | 'itemType'>>
-
 export type MixedWearableResponse = Omit<MixedWearable, 'minTransferredAt' | 'maxTransferredAt'>
 
 export type MixedWearableTrimmedResponse = {
@@ -223,7 +208,7 @@ export async function explorerHandler(
   if (isTrimmed) {
     const results: MixedWearableTrimmedResponse[] = page.elements.map((wearable) => {
       const result: MixedWearableTrimmedResponse = {
-        entity: buildTrimmedEntity(wearable.entity, wearable.itemType)
+        entity: buildTrimmedEntity(wearable)
       }
       if (includeAmount) {
         result.amount = wearable.individualData?.length || 0

src/logic/utils.ts

@@ -1,6 +1,6 @@
 import { parseUrn as resolverParseUrn } from '@dcl/urn-resolver'
-import { ItemType, ThirdPartyProvider } from '../types'
-import { Entity, Rarity, WearableCategory } from '@dcl/schemas'
+import { ItemType, ThirdPartyProvider, MixedWearable } from '../types'
+import { Rarity, WearableCategory } from '@dcl/schemas'
 
 export type ExplorerWearableRepresentation = {
   bodyShapes: string[]
@@ -20,6 +20,7 @@ export type ExplorerWearableEntity = {
   id: string
   thumbnail?: string
   metadata: ExplorerWearableMetadata
+  individualData: MixedWearable['individualData']
 }
 
 export const SORTED_RARITIES = [
@@ -74,7 +75,7 @@ export function sanitizeContractList(thirdPartyProviders: ThirdPartyProvider[])
   }
 }
 
-export function buildTrimmedEntity(entity: Entity, itemType?: ItemType): ExplorerWearableEntity {
+export function buildTrimmedEntity({ entity, itemType, individualData }: MixedWearable): ExplorerWearableEntity {
   const thumbnailFile = entity?.metadata?.thumbnail as string | undefined
   const thumbnailHash = entity?.content?.find((c) => c.file === thumbnailFile)?.hash
   const metadata = entity?.metadata
@@ -87,6 +88,7 @@ export function buildTrimmedEntity(entity: Entity, itemType?: ItemType): Explore
   return {
     id: entity.id,
     thumbnail: thumbnailHash,
+    individualData,
     metadata: {
       id: metadata?.id,
       rarity: metadata?.rarity,

src/types.ts

@@ -179,6 +179,23 @@ export type ThirdPartyWearable = {
 
 export type BaseWearable = ThirdPartyWearable
 
+export type MixedBaseWearable = BaseWearable & {
+  type: 'base-wearable'
+  entity: Entity
+}
+
+export type MixedOnChainWearable = OnChainWearable & {
+  type: 'on-chain'
+  entity: Entity
+}
+
+export type MixedThirdPartyWearable = ThirdPartyWearable & {
+  type: 'third-party'
+}
+
+export type MixedWearable = (MixedBaseWearable | MixedOnChainWearable | MixedThirdPartyWearable) &
+  Partial<Pick<OnChainWearable, 'rarity' | 'itemType'>>
+
 export type Name = {
   name: string
   contractAddress: string

test/mocks/mixed-wearable-mock.ts

@@ -0,0 +1,52 @@
+import { WearableCategory } from '@dcl/schemas'
+import { ItemType, MixedBaseWearable, MixedOnChainWearable, MixedThirdPartyWearable } from '../../src/types'
+import { createMockEntity } from './entity-mock'
+
+export const createMockOnChainWearable = (overrides?: Partial<MixedOnChainWearable>): MixedOnChainWearable => {
+  const entity = overrides?.entity || createMockEntity()
+
+  return {
+    type: 'on-chain',
+    entity,
+    itemType: ItemType.WEARABLE_V2,
+    individualData: [{ id: 'nft-1', tokenId: '123', transferredAt: 1000, price: 100 }],
+    urn: 'urn:decentraland:ethereum:collections-v2:0xabc:0',
+    amount: 1,
+    name: 'Test Wearable',
+    rarity: 'common',
+    category: WearableCategory.HAT,
+    minTransferredAt: 1000,
+    maxTransferredAt: 1000,
+    ...overrides
+  }
+}
+
+export const createMockThirdPartyWearable = (overrides?: Partial<MixedThirdPartyWearable>): MixedThirdPartyWearable => {
+  const entity = overrides?.entity || createMockEntity()
+
+  return {
+    type: 'third-party',
+    entity,
+    individualData: [{ id: 'tp-1', tokenId: '456' }],
+    urn: 'urn:decentraland:matic:collections-thirdparty:thirdparty:collection:item',
+    amount: 1,
+    name: 'Test Third Party Wearable',
+    category: WearableCategory.HAT,
+    ...overrides
+  }
+}
+
+export const createMockBaseWearable = (overrides?: Partial<MixedBaseWearable>): MixedBaseWearable => {
+  const entity = overrides?.entity || createMockEntity()
+
+  return {
+    type: 'base-wearable',
+    entity,
+    individualData: [{ id: 'base-1' }],
+    urn: 'urn:decentraland:off-chain:base-avatars:hat',
+    amount: 1,
+    name: 'Base Hat',
+    category: WearableCategory.HAT,
+    ...overrides
+  }
+}