chore: update @dcl/protocol version (#1356)

- Updated @dcl/protocol dependency to version 1.0.0-23348796189.commit-2417808 in package.json and package-lock.json.
- Added new interaction types and corresponding methods for proximity events in the PointerEventsSystem.
- Enhanced event options to include priority and interaction type in the event handling system.
- Updated tests and snapshots to reflect changes in pointer event handling.

Co-authored-by: Nicolas Earnshaw <nearnshaw@decentraland.org>

Author: Maurizio-dcl

package-lock.json

@@ -6,7 +6,7 @@
   "bugs": "https://github.com/decentraland/js-sdk-toolchain/issues",
   "dependencies": {
     "@actions/core": "^1.10.0",
-    "@dcl/protocol": "^1.0.0-22669986637.commit-fb11819",
+    "@dcl/protocol": "^1.0.0-23348796189.commit-2417808",
     "@dcl/quickjs-emscripten": "^0.21.0-3680274614.commit-1808aa1",
     "@dcl/ts-proto": "1.153.0",
     "@types/fs-extra": "^9.0.12",

package.json

@@ -1,4 +1,5 @@
 import { InputAction } from '../components/generated/pb/decentraland/sdk/components/common/input_action.gen'
+import { InteractionType } from '../components/generated/pb/decentraland/sdk/components/common/input_action.gen'
 import { PBPointerEventsResult } from '../components/generated/pb/decentraland/sdk/components/pointer_events_result.gen'
 import { PointerEventType } from '../components/generated/pb/decentraland/sdk/components/common/input_action.gen'
 import * as components from '../components'
@@ -22,6 +23,7 @@ export type EventSystemOptions = {
   showFeedback?: boolean
   showHighlight?: boolean
   maxPlayerDistance?: number
+  priority?: number
 }
 
 export const getDefaultOpts = (opts: Partial<EventSystemOptions> = {}): EventSystemOptions => ({
@@ -67,6 +69,34 @@ export interface PointerEventsSystem {
    */
   removeOnPointerHoverLeave(entity: Entity): void
 
+  /**
+   * @public
+   * Remove the callback for onProximityDown event
+   * @param entity - Entity where the callback was attached
+   */
+  removeOnProximityDown(entity: Entity): void
+
+  /**
+   * @public
+   * Remove the callback for onProximityUp event
+   * @param entity - Entity where the callback was attached
+   */
+  removeOnProximityUp(entity: Entity): void
+
+  /**
+   * @public
+   * Remove the callback for onProximityEnter event
+   * @param entity - Entity where the callback was attached
+   */
+  removeOnProximityEnter(entity: Entity): void
+
+  /**
+   * @public
+   * Remove the callback for onProximityLeave event
+   * @param entity - Entity where the callback was attached
+   */
+  removeOnProximityLeave(entity: Entity): void
+
   /**
    * @internal
    * Execute callback when the user clicks the entity.
@@ -125,6 +155,38 @@ export interface PointerEventsSystem {
     pointerData: { entity: Entity; opts?: Partial<EventSystemOptions> },
     cb: EventSystemCallback
   ): void
+
+  /**
+   * @public
+   * Execute callback when the user presses the proximity button on the entity
+   * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
+   * @param cb - Function to execute when click fires
+   */
+  onProximityDown(pointerData: { entity: Entity; opts?: Partial<EventSystemOptions> }, cb: EventSystemCallback): void
+
+  /**
+   * @public
+   * Execute callback when the user releases the proximity button on the entity
+   * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
+   * @param cb - Function to execute when event fires
+   */
+  onProximityUp(pointerData: { entity: Entity; opts?: Partial<EventSystemOptions> }, cb: EventSystemCallback): void
+
+  /**
+   * @public
+   * Execute callback when the entity enters the proximity zone of the user
+   * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
+   * @param cb - Function to execute when event fires
+   */
+  onProximityEnter(pointerData: { entity: Entity; opts?: Partial<EventSystemOptions> }, cb: EventSystemCallback): void
+
+  /**
+   * @public
+   * Execute callback when the entity leaves the proximity zone of the user
+   * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
+   * @param cb - Function to execute when event fires
+   */
+  onProximityLeave(pointerData: { entity: Entity; opts?: Partial<EventSystemOptions> }, cb: EventSystemCallback): void
 }
 
 /**
@@ -139,7 +201,9 @@ export function createPointerEventsSystem(engine: IEngine, inputSystem: IInputSy
     Down,
     Up,
     HoverEnter,
-    HoverLeave
+    HoverLeave,
+    ProximityEnter,
+    ProximityLeave
   }
   type EventMapType = Map<EventType, { cb: EventSystemCallback; opts: EventSystemOptions }>
 
@@ -149,7 +213,12 @@ export function createPointerEventsSystem(engine: IEngine, inputSystem: IInputSy
     return eventsMap.get(entity) || eventsMap.set(entity, new Map()).get(entity)!
   }
 
-  function setPointerEvent(entity: Entity, type: PointerEventType, opts: EventSystemOptions) {
+  function setPointerEvent(
+    entity: Entity,
+    type: PointerEventType,
+    opts: EventSystemOptions,
+    interactionType: InteractionType = InteractionType.CURSOR
+  ) {
     const pointerEvent = PointerEvents.getMutableOrNull(entity) || PointerEvents.create(entity)
     pointerEvent.pointerEvents.push({
       eventType: type,
@@ -159,16 +228,28 @@ export function createPointerEventsSystem(engine: IEngine, inputSystem: IInputSy
         showHighlight: opts.showHighlight,
         hoverText: opts.hoverText,
         maxDistance: opts.maxDistance,
-        maxPlayerDistance: opts.maxPlayerDistance
-      }
+        maxPlayerDistance: opts.maxPlayerDistance,
+        priority: opts.priority
+      },
+      interactionType: interactionType ?? InteractionType.CURSOR
     })
   }
 
-  function removePointerEvent(entity: Entity, type: PointerEventType, button: InputAction) {
+  function removePointerEvent(
+    entity: Entity,
+    type: PointerEventType,
+    button: InputAction,
+    interactionType: InteractionType = InteractionType.CURSOR
+  ) {
     const pointerEvent = PointerEvents.getMutableOrNull(entity)
     if (!pointerEvent) return
     pointerEvent.pointerEvents = pointerEvent.pointerEvents.filter(
-      (pointer) => !(pointer.eventInfo?.button === button && pointer.eventType === type)
+      (pointer) =>
+        !(
+          pointer.eventInfo?.button === button &&
+          pointer.eventType === type &&
+          pointer.interactionType === interactionType
+        )
     )
   }
 
@@ -179,11 +260,15 @@ export function createPointerEventsSystem(engine: IEngine, inputSystem: IInputSy
       return PointerEventType.PET_HOVER_LEAVE
     } else if (eventType === EventType.HoverEnter) {
       return PointerEventType.PET_HOVER_ENTER
+    } else if (eventType === EventType.ProximityEnter) {
+      return PointerEventType.PET_PROXIMITY_ENTER
+    } else if (eventType === EventType.ProximityLeave) {
+      return PointerEventType.PET_PROXIMITY_LEAVE
     }
     return PointerEventType.PET_DOWN
   }
 
-  function removeEvent(entity: Entity, type: EventType) {
+  function removeEvent(entity: Entity, type: EventType, interactionType: InteractionType = InteractionType.CURSOR) {
     const event = getEvent(entity)
     const pointerEvent = event.get(type)
 
@@ -212,7 +297,9 @@ export function createPointerEventsSystem(engine: IEngine, inputSystem: IInputSy
           eventType === EventType.Down ||
           eventType === EventType.Up ||
           eventType === EventType.HoverEnter ||
-          eventType === EventType.HoverLeave
+          eventType === EventType.HoverLeave ||
+          eventType === EventType.ProximityEnter ||
+          eventType === EventType.ProximityLeave
         ) {
           const command = inputSystem.getInputCommand(opts.button, getPointerEvent(eventType), entity)
           if (command) {
@@ -265,6 +352,42 @@ export function createPointerEventsSystem(engine: IEngine, inputSystem: IInputSy
     setPointerEvent(entity, PointerEventType.PET_HOVER_LEAVE, options)
   }
 
+  const onProximityDown: PointerEventsSystem['onProximityDown'] = (...args) => {
+    const [data, cb] = args
+    const { entity, opts } = data
+    const options = getDefaultOpts(opts)
+    removeEvent(entity, EventType.Down, InteractionType.PROXIMITY)
+    getEvent(entity).set(EventType.Down, { cb, opts: options })
+    setPointerEvent(entity, PointerEventType.PET_DOWN, options, InteractionType.PROXIMITY)
+  }
+
+  const onProximityUp: PointerEventsSystem['onProximityUp'] = (...args) => {
+    const [data, cb] = args
+    const { entity, opts } = data
+    const options = getDefaultOpts(opts)
+    removeEvent(entity, EventType.Up, InteractionType.PROXIMITY)
+    getEvent(entity).set(EventType.Up, { cb, opts: options })
+    setPointerEvent(entity, PointerEventType.PET_UP, options, InteractionType.PROXIMITY)
+  }
+
+  const onProximityEnter: PointerEventsSystem['onProximityEnter'] = (...args) => {
+    const [data, cb] = args
+    const { entity, opts } = data
+    const options = getDefaultOpts(opts)
+    removeEvent(entity, EventType.ProximityEnter, InteractionType.PROXIMITY)
+    getEvent(entity).set(EventType.ProximityEnter, { cb, opts: options })
+    setPointerEvent(entity, PointerEventType.PET_PROXIMITY_ENTER, options, InteractionType.PROXIMITY)
+  }
+
+  const onProximityLeave: PointerEventsSystem['onProximityLeave'] = (...args) => {
+    const [data, cb] = args
+    const { entity, opts } = data
+    const options = getDefaultOpts(opts)
+    removeEvent(entity, EventType.ProximityLeave, InteractionType.PROXIMITY)
+    getEvent(entity).set(EventType.ProximityLeave, { cb, opts: options })
+    setPointerEvent(entity, PointerEventType.PET_PROXIMITY_LEAVE, options, InteractionType.PROXIMITY)
+  }
+
   return {
     removeOnClick(entity: Entity) {
       removeEvent(entity, EventType.Click)
@@ -286,6 +409,22 @@ export function createPointerEventsSystem(engine: IEngine, inputSystem: IInputSy
       removeEvent(entity, EventType.HoverLeave)
     },
 
+    removeOnProximityDown(entity: Entity) {
+      removeEvent(entity, EventType.Down, InteractionType.PROXIMITY)
+    },
+
+    removeOnProximityUp(entity: Entity) {
+      removeEvent(entity, EventType.Up, InteractionType.PROXIMITY)
+    },
+
+    removeOnProximityEnter(entity: Entity) {
+      removeEvent(entity, EventType.ProximityEnter, InteractionType.PROXIMITY)
+    },
+
+    removeOnProximityLeave(entity: Entity) {
+      removeEvent(entity, EventType.ProximityLeave, InteractionType.PROXIMITY)
+    },
+
     onClick(value, cb) {
       const { entity } = value
       const options = getDefaultOpts(value.opts)
@@ -300,6 +439,10 @@ export function createPointerEventsSystem(engine: IEngine, inputSystem: IInputSy
     onPointerDown,
     onPointerUp,
     onPointerHoverEnter,
-    onPointerHoverLeave
+    onPointerHoverLeave,
+    onProximityDown,
+    onProximityUp,
+    onProximityEnter,
+    onProximityLeave
   }
 }