feat: add ExplorerUiEventsResult component and share the ExplorerUi enum (#1511)

Round 2 of scene-triggered explorer UI. Round 1 (#1503) gave scenes `openExplorerUi`; this adds the result channel, so a scene can observe when the panel it opened is actually shown or dismissed.

Depends on decentraland/protocol#455 — **do not merge before it**.

## What changes

- `ExplorerUiEventsResult` is registered in `GROWN_ONLY_COMPONENTS`, so it generates as a grow-only value set (`APPEND`) rather than LWW, matching `PointerEventsResult` and friends. The generated `maxElements: 100` lines up with the explorer's `MAX_APPEND_COMPONENTS_COUNT`.
- `~system/RestrictedActions` no longer re-declares `ExplorerUi`. The enum moved to `sdk/components/common/explorer_ui.proto` upstream, so `apis.d.ts` now reads `ui: import('../ecs').ExplorerUi` and scene code sees a single nominal type:

  ```ts
  for (const e of ExplorerUiEventsResult.get(engine.RootEntity)) {
    if (e.ui === ExplorerUi.EU_MAP) { /* no cast needed */ }
  }
  ```
- Regenerated: `playground-assets.api.md`, 12 CRDT snapshots, three lockfiles.
- New: `test/ecs/components/ExplorerUiEventsResult.spec.ts` (3 tests). The accumulation test is a deliberate guard — the serialization tests alone would still pass if the `GROWN_ONLY_COMPONENTS` entry were dropped.

## Before merging

- [ ] decentraland/protocol#455 merged
- [ ] `@dcl/protocol` repinned from the PR tarball to the published version, lockfiles refreshed, snapshots and `api.md` regenerated

The pin is currently a tarball URL in both `package.json` and `packages/@dcl/sdk-commands/package.json`, because PR builds are not published to npm. It carries one unrelated delta into `api.md` — `AvatarEmoteMask`, from `avatar_shape.proto` — which disappears on repin.

## Verification

Locally: `make build` exit 0 (38/38, including the `check no conflict in types` and `ae-forgotten-export` gates); snapshot comparison 17/17.

`make test` on this Windows checkout reports 12 failures in `test/ecs/composite.spec.ts` plus 3 jest timeouts in sdk-commands. The composite failures are a CRLF artifact: the fixtures are `i/lf w/crlf` under `core.autocrlf=true`, and `composite.spec.ts` compares without the `\r\n` normalization that `snapshots.spec.ts` applies. No `ExplorerUi` line appears in any of those diffs and this branch touches no fixture. CI on Linux is the real signal.

## Follow-up

`openExplorerUiAndWaitClose` — a promise-based helper wrapping the call and its matching result event — is a separate PR.

Author: popuz

package-lock.json

@@ -9,7 +9,7 @@
     "@babel/plugin-transform-modules-commonjs": "^7.28.5",
     "@babel/plugin-transform-react-jsx": "^7.28.5",
     "@babel/preset-typescript": "^7.28.5",
-    "@dcl/protocol": "1.0.0-31211128817.commit-215d09c",
+    "@dcl/protocol": "1.0.0-31617402096.commit-86c4613",
     "@dcl/quickjs-emscripten": "^0.21.0-3680274614.commit-1808aa1",
     "@dcl/ts-proto": "1.153.0",
     "@types/fs-extra": "^9.0.12",

package.json

@@ -726,6 +726,7 @@ export const componentDefinitionByName: {
     "core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
     "core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
     "core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
+    "core::ExplorerUiEventsResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBExplorerUiEventsResult>>;
     "core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
     "core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
     "core::GltfNodeModifiers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>>;
@@ -1278,6 +1279,27 @@ export type ExcludeUndefined<T> = {
 // @public
 export const executeTask: (task: Task<unknown>) => void;
 
+// @public (undocumented)
+export const enum ExplorerUi {
+    // (undocumented)
+    EU_BACKPACK = 2,
+    // (undocumented)
+    EU_CAMERA_REEL = 3,
+    // (undocumented)
+    EU_COMMUNITIES = 4,
+    // (undocumented)
+    EU_EVENTS = 6,
+    // (undocumented)
+    EU_MAP = 1,
+    // (undocumented)
+    EU_PLACES = 5,
+    // (undocumented)
+    EU_SETTINGS = 0
+}
+
+// @public (undocumented)
+export const ExplorerUiEventsResult: GrowOnlyValueSetComponentDefinition<PBExplorerUiEventsResult>;
+
 // @public
 export interface FlatMaterial {
     albedoColor: PBColor4 | undefined;
@@ -2747,6 +2769,52 @@ export namespace PBEngineInfo {
     export function encode(message: PBEngineInfo, writer?: _m0.Writer): _m0.Writer;
 }
 
+// @public (undocumented)
+export interface PBExplorerUiEventsResult {
+    // (undocumented)
+    event?: {
+        $case: "opened";
+        opened: PBExplorerUiEventsResult_UiOpened;
+    } | {
+        $case: "closed";
+        closed: PBExplorerUiEventsResult_UiClosed;
+    } | undefined;
+    timestamp: number;
+    ui: ExplorerUi;
+}
+
+// @public (undocumented)
+export namespace PBExplorerUiEventsResult {
+    // (undocumented)
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerUiEventsResult;
+    // (undocumented)
+    export function encode(message: PBExplorerUiEventsResult, writer?: _m0.Writer): _m0.Writer;
+}
+
+// @public (undocumented)
+export interface PBExplorerUiEventsResult_UiClosed {
+}
+
+// @public (undocumented)
+export namespace PBExplorerUiEventsResult_UiClosed {
+    // (undocumented)
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerUiEventsResult_UiClosed;
+    // (undocumented)
+    export function encode(_: PBExplorerUiEventsResult_UiClosed, writer?: _m0.Writer): _m0.Writer;
+}
+
+// @public (undocumented)
+export interface PBExplorerUiEventsResult_UiOpened {
+}
+
+// @public (undocumented)
+export namespace PBExplorerUiEventsResult_UiOpened {
+    // (undocumented)
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerUiEventsResult_UiOpened;
+    // (undocumented)
+    export function encode(_: PBExplorerUiEventsResult_UiOpened, writer?: _m0.Writer): _m0.Writer;
+}
+
 // @public (undocumented)
 export interface PBGltfContainer {
     invisibleMeshesCollisionMask?: number | undefined;

packages/@dcl/playground-assets/etc/playground-assets.api.md

@@ -14,7 +14,7 @@
     "@dcl/inspector": "7.36.3",
     "@dcl/linker-dapp": "0.15.2",
     "@dcl/mini-comms": "1.0.1-20230216163137.commit-a4c75be",
-    "@dcl/protocol": "1.0.0-31211128817.commit-215d09c",
+    "@dcl/protocol": "1.0.0-31617402096.commit-86c4613",
     "@dcl/quests-client": "^1.0.3",
     "@dcl/quests-manager": "^0.1.4",
     "@dcl/rpc": "^1.1.1",

packages/@dcl/sdk-commands/package-lock.json

@@ -15,7 +15,7 @@ function exportComponent(component: Component) {
   return `export * from './pb/decentraland/sdk/components/${component.componentFile}.gen'`
 }
 
-const GROWN_ONLY_COMPONENTS = ['PointerEventsResult', 'VideoEvent', 'AvatarEmoteCommand', 'AudioEvent', 'TriggerAreaResult', 'AssetLoadLoadingState']
+const GROWN_ONLY_COMPONENTS = ['PointerEventsResult', 'VideoEvent', 'AvatarEmoteCommand', 'AudioEvent', 'TriggerAreaResult', 'AssetLoadLoadingState', 'ExplorerUiEventsResult']
 function isGrowOnlyValueSet(component: Component): boolean {
   return GROWN_ONLY_COMPONENTS.includes(component.componentPascalName)
 }

packages/@dcl/sdk-commands/package.json

@@ -0,0 +1,80 @@
+import { components, Engine, ExplorerUi } from '../../../packages/@dcl/ecs/src'
+import { testSchemaSerializationIdentity } from './assertion'
+
+describe('Generated ExplorerUiEventsResult ProtoBuf', () => {
+  it('should serialize', () => {
+    const newEngine = Engine()
+    const ExplorerUiEventsResult = components.ExplorerUiEventsResult(newEngine)
+
+    testSchemaSerializationIdentity(ExplorerUiEventsResult.schema, {
+      ui: ExplorerUi.EU_MAP,
+      timestamp: 10,
+      event: { $case: 'opened', opened: {} }
+    })
+
+    testSchemaSerializationIdentity(ExplorerUiEventsResult.schema, {
+      ui: ExplorerUi.EU_MAP,
+      timestamp: 20,
+      event: { $case: 'closed', closed: {} }
+    })
+
+    testSchemaSerializationIdentity(ExplorerUiEventsResult.schema, {
+      ui: ExplorerUi.EU_SETTINGS,
+      timestamp: 30,
+      event: { $case: 'opened', opened: {} }
+    })
+
+    testSchemaSerializationIdentity(ExplorerUiEventsResult.schema, {
+      ui: ExplorerUi.EU_EVENTS,
+      timestamp: 40,
+      event: undefined
+    })
+
+    testSchemaSerializationIdentity(ExplorerUiEventsResult.schema, ExplorerUiEventsResult.schema.create())
+  })
+
+  it('should serialize every ExplorerUi panel', () => {
+    const newEngine = Engine()
+    const ExplorerUiEventsResult = components.ExplorerUiEventsResult(newEngine)
+
+    const panels = [
+      ExplorerUi.EU_SETTINGS,
+      ExplorerUi.EU_MAP,
+      ExplorerUi.EU_BACKPACK,
+      ExplorerUi.EU_CAMERA_REEL,
+      ExplorerUi.EU_COMMUNITIES,
+      ExplorerUi.EU_PLACES,
+      ExplorerUi.EU_EVENTS
+    ]
+
+    for (const ui of panels) {
+      testSchemaSerializationIdentity(ExplorerUiEventsResult.schema, {
+        ui,
+        timestamp: ui + 1,
+        event: { $case: 'opened', opened: {} }
+      })
+    }
+  })
+
+  it('should accumulate appended values on the grow only value set', () => {
+    const newEngine = Engine()
+    const ExplorerUiEventsResult = components.ExplorerUiEventsResult(newEngine)
+    const entity = newEngine.addEntity()
+
+    ExplorerUiEventsResult.addValue(entity, {
+      ui: ExplorerUi.EU_BACKPACK,
+      timestamp: 1,
+      event: { $case: 'opened', opened: {} }
+    })
+    ExplorerUiEventsResult.addValue(entity, {
+      ui: ExplorerUi.EU_BACKPACK,
+      timestamp: 2,
+      event: { $case: 'closed', closed: {} }
+    })
+
+    expect(Array.from(ExplorerUiEventsResult.get(entity))).toEqual([
+      { ui: ExplorerUi.EU_BACKPACK, timestamp: 1, event: { $case: 'opened', opened: {} } },
+      { ui: ExplorerUi.EU_BACKPACK, timestamp: 2, event: { $case: 'closed', closed: {} } }
+    ])
+  })
+})

scripts/protocol-buffer-generation/generateIndex.ts

@@ -1,4 +1,4 @@
-SCENE_COMPILED_JS_SIZE_PROD=613.9k bytes
+SCENE_COMPILED_JS_SIZE_PROD=619.9k bytes
 THE BUNDLE HAS SOURCEMAPS
 (start empty vm 0.21.0-3680274614.commit-1808aa1)
   OPCODES ~= 0k
@@ -10,8 +10,8 @@ EVAL test/snapshots/development-bundles/static-scene.test.js
   REQUIRE: ~system/EngineApi
   REQUIRE: ~system/Runtime
   OPCODES ~= 74k
-  MALLOC_COUNT = 16723
-  ALIVE_OBJS_DELTA ~= 3.28k
+  MALLOC_COUNT = 16866
+  ALIVE_OBJS_DELTA ~= 3.31k
 CALL onStart()
   main.crdt: PUT_COMPONENT e=0x200 c=1 t=0 data={"position":{"x":5.880000114440918,"y":2.7916901111602783,"z":7.380000114440918},"rotation":{"x":0,"y":0,"z":0,"w":1},"scale":{"x":1,"y":1,"z":1},"parent":0}
   main.crdt: PUT_COMPONENT e=0x202 c=1 t=0 data={"position":{"x":4,"y":0.800000011920929,"z":8},"rotation":{"x":0,"y":0,"z":0,"w":1},"scale":{"x":1,"y":1,"z":1},"parent":0}
@@ -55,4 +55,4 @@ CALL onUpdate(0.1)
   OPCODES ~= 5k
   MALLOC_COUNT = -5
   ALIVE_OBJS_DELTA ~= 0.00k
-  MEMORY_USAGE_COUNT ~= 1536.00k bytes
+  MEMORY_USAGE_COUNT ~= 1546.52k bytes

test/ecs/components/ExplorerUiEventsResult.spec.ts

@@ -1,4 +1,4 @@
-SCENE_COMPILED_JS_SIZE_PROD=614.4k bytes
+SCENE_COMPILED_JS_SIZE_PROD=620.4k bytes
 THE BUNDLE HAS SOURCEMAPS
 (start empty vm 0.21.0-3680274614.commit-1808aa1)
   OPCODES ~= 0k
@@ -9,9 +9,9 @@ EVAL test/snapshots/development-bundles/testing-fw.test.js
   REQUIRE: ~system/EngineApi
   REQUIRE: ~system/EngineApi
   REQUIRE: ~system/Runtime
-  OPCODES ~= 83k
-  MALLOC_COUNT = 17275
-  ALIVE_OBJS_DELTA ~= 3.43k
+  OPCODES ~= 84k
+  MALLOC_COUNT = 17418
+  ALIVE_OBJS_DELTA ~= 3.46k
 CALL onStart()
   LOG: ["Adding one to position.y=0"]
   Renderer: PUT_COMPONENT e=0x0 c=1 t=1 data={"position":{"x":1,"y":0,"z":0},"rotation":{"x":0,"y":0,"z":0,"w":1},"scale":{"x":9,"y":9,"z":9},"parent":0}
@@ -61,4 +61,4 @@ CALL onUpdate(0.1)
   OPCODES ~= 6k
   MALLOC_COUNT = -53
   ALIVE_OBJS_DELTA ~= -0.01k
-  MEMORY_USAGE_COUNT ~= 1541.70k bytes
+  MEMORY_USAGE_COUNT ~= 1552.21k bytes