feat: add UsedEmoteEvent from Explorer (#307)

decentraland · Sep 4, 2024 · 0177104 · 0177104
1 parent 71b37ee
commit 0177104
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 16 deletions.
diff --git a/report/schemas.api.md b/report/schemas.api.md
@@ -1045,7 +1045,7 @@ export namespace EthAddress {
 // Warning: (ae-missing-release-tag) "Event" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export type Event = BidAcceptedEvent | BidReceivedEvent | ItemSoldEvent | RentalEndedEvent | RentalStartedEvent | RoyaltiesEarnedEvent | CollectionCreatedEvent | MoveToParcelEvent | CatalystDeploymentEvent | RewardInProgressEvent | RewardAssignedEvent | CampaignOutOfFundsEvent | CampaignGasPriceHigherThanExpectedEvent | CampaignOutOfStockEvent | RewardDelayedEvent | BadgeGrantedEvent;
+export type Event = BidAcceptedEvent | BidReceivedEvent | ItemSoldEvent | RentalEndedEvent | RentalStartedEvent | RoyaltiesEarnedEvent | CollectionCreatedEvent | MoveToParcelEvent | CatalystDeploymentEvent | RewardInProgressEvent | RewardAssignedEvent | CampaignOutOfFundsEvent | CampaignGasPriceHigherThanExpectedEvent | CampaignOutOfStockEvent | RewardDelayedEvent | BadgeGrantedEvent | UsedEmoteEvent;
 
 // Warning: (ae-missing-release-tag) "Events" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
@@ -1091,7 +1091,9 @@ export namespace Events {
         // (undocumented)
         export enum Client {
             // (undocumented)
-            MOVE_TO_PARCEL = "move-to-parcel"
+            MOVE_TO_PARCEL = "move-to-parcel",
+            // (undocumented)
+            USED_EMOTE = "used-emote"
         }
         // (undocumented)
         export enum Marketplace {
@@ -1705,18 +1707,13 @@ export enum MintSortBy {
 export type MoveToParcelEvent = BaseEvent & {
     type: Events.Type.CLIENT;
     subType: Events.SubType.Client.MOVE_TO_PARCEL;
-    metadata: {
-        authChain: AuthChain;
+    metadata: ClientBaseMetadata & {
         parcel: {
             isEmptyParcel: boolean;
             newParcel: string;
             oldParcel: string;
             sceneHash: string;
         };
-        timestamp: number;
-        userAddress: EthAddress;
-        sessionId: string;
-        realm: string;
     };
 };
 
@@ -3338,6 +3335,22 @@ export type USDPeggedManaTradeAsset = BaseTradeAsset & {
     amount: string;
 };
 
+// Warning: (ae-missing-release-tag) "UsedEmoteEvent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type UsedEmoteEvent = BaseEvent & {
+    type: Events.Type.CLIENT;
+    subType: Events.SubType.Client.USED_EMOTE;
+    metadata: ClientBaseMetadata & {
+        emote: {
+            emoteIndex: number;
+            isBase: boolean;
+            itemId: string;
+            source: string;
+        };
+    };
+};
+
 // @public
 export interface ValidateFunction<T = unknown> {
     // (undocumented)
@@ -3599,6 +3612,7 @@ export namespace WorldConfiguration {
 // src/dapps/trade.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/trade.ts:92:3 - (ae-incompatible-release-tags) The symbol "chainId" is marked as @public, but its signature references "ChainId" which is marked as @alpha
 // src/platform/events/blockchain.ts:128:3 - (ae-forgotten-export) The symbol "RentalMetadata" needs to be exported by the entry point index.d.ts
+// src/platform/events/client.ts:16:3 - (ae-forgotten-export) The symbol "ClientBaseMetadata" needs to be exported by the entry point index.d.ts
 // src/platform/item/emote/adr74/emote-data-adr74.ts:7:3 - (ae-incompatible-release-tags) The symbol "representations" is marked as @public, but its signature references "EmoteRepresentationADR74" which is marked as @alpha
 // src/platform/item/linked-wearable-mappings.ts:251:3 - (ae-incompatible-release-tags) The symbol "getMappings" is marked as @public, but its signature references "Mappings" which is marked as @alpha
 // src/platform/item/linked-wearable-mappings.ts:252:3 - (ae-incompatible-release-tags) The symbol "addMapping" is marked as @public, but its signature references "ContractNetwork" which is marked as @alpha

diff --git a/src/platform/events/base.ts b/src/platform/events/base.ts
@@ -7,7 +7,7 @@ import {
   RoyaltiesEarnedEvent
 } from './blockchain'
 import { CatalystDeploymentEvent } from './catalyst'
-import { MoveToParcelEvent } from './client'
+import { MoveToParcelEvent, UsedEmoteEvent } from './client'
 import { BidReceivedEvent } from './marketplace'
 import {
   RewardInProgressEvent,
@@ -53,7 +53,8 @@ export namespace Events {
     }
 
     export enum Client {
-      MOVE_TO_PARCEL = 'move-to-parcel'
+      MOVE_TO_PARCEL = 'move-to-parcel',
+      USED_EMOTE = 'used-emote'
     }
 
     export enum Rewards {
@@ -101,3 +102,4 @@ export type Event =
   | CampaignOutOfStockEvent
   | RewardDelayedEvent
   | BadgeGrantedEvent
+  | UsedEmoteEvent
diff --git a/src/platform/events/client.ts b/src/platform/events/client.ts
@@ -2,20 +2,36 @@ import { EthAddress } from '../../misc'
 import { AuthChain } from '../../misc/auth-chain'
 import { BaseEvent, Events } from './base'
 
+type ClientBaseMetadata = {
+  authChain: AuthChain
+  timestamp: number
+  userAddress: EthAddress
+  sessionId: string
+  realm: string
+}
+
 export type MoveToParcelEvent = BaseEvent & {
   type: Events.Type.CLIENT
   subType: Events.SubType.Client.MOVE_TO_PARCEL
-  metadata: {
-    authChain: AuthChain
+  metadata: ClientBaseMetadata & {
     parcel: {
       isEmptyParcel: boolean
       newParcel: string
       oldParcel: string
       sceneHash: string
     }
-    timestamp: number
-    userAddress: EthAddress
-    sessionId: string
-    realm: string
+  }
+}
+
+export type UsedEmoteEvent = BaseEvent & {
+  type: Events.Type.CLIENT
+  subType: Events.SubType.Client.USED_EMOTE
+  metadata: ClientBaseMetadata & {
+    emote: {
+      emoteIndex: number
+      isBase: boolean
+      itemId: string
+      source: string
+    }
   }
 }