@3dsource/angular-unreal-module 0.0.182 → 0.0.183

package/fesm2022/3dsource-angular-unreal-module.mjs

@@ -281,15 +281,6 @@ const OrchestrationMessageTypes = {
     interruptClientStream: 'interruptClientStream',
 };
 
-const SpecialKeyCodes = {
-    BackSpace: 8,
-    Shift: 16,
-    Control: 17,
-    Alt: 18,
-    RightShift: 253,
-    RightControl: 254,
-    RightAlt: 255,
-};
 // https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/button
 const MouseButton = {
     MainButton: 0, // Left button.
@@ -308,7 +299,8 @@ const MouseButtonsMask = {
 };
 
 /**
- * `KeyboardEvent.code` → the Windows virtual-key code Unreal expects.
+ * `KeyboardEvent.code` → the virtual-key code Unreal expects: Windows VK
+ * values, plus Pixel Streaming's own 253-255 for the right-hand modifiers.
  *
  * Only keys whose `event.keyCode` cannot be trusted belong here. The browser
  * already resolves `keyCode` correctly for everything else, so the table exists
@@ -316,56 +308,47 @@ const MouseButtonsMask = {
  * punctuation keys by ASCII — `;` as 59, `=` as 61, `-` as 173) and keys Unreal
  * numbers differently from the DOM (the right-hand modifiers, the Cmd/Win keys).
  *
- * The numpad digits, `NumpadDecimal` and `NumpadEnter` are the exception to the
- * rule above, and the reason it is worded as a rule. A numpad key reports the
- * same `code` in both NumLock states but a different virtual key — `Numpad4` is
- * 37/`VK_LEFT` with NumLock off and 100/`VK_NUMPAD4` with it on. Their entries
- * here hold the NumLock-*off* values, so an entry wins over the value the
- * browser resolved and pins that state: with NumLock on the engine is told
- * `VK_LEFT`. Read `event.keyCode` directly if you need the other state.
- * `NumpadAdd`/`Subtract`/`Multiply`/`Divide` carry no such caveat — they do not
- * change with NumLock.
+ * `Pause`, `CapsLock` and the navigation block — `PageUp`, `PageDown`, `End`,
+ * `Home`, `Insert`, `Delete` — are the exception to that rule. The browser
+ * numbers them correctly, so their entries repeat the value `event.keyCode`
+ * already reports and change nothing at runtime; they are listed so `IKeyName`
+ * completes them in an editor.
  *
- * `SpecialKeyCodes` in `./buttons-codes` repeats seven of these entries with
- * the same values. The two are kept apart because both are public API; merging
- * them would be a breaking change.
+ * The NumLock-dependent numpad keys — `Numpad0`-`Numpad9`, `NumpadDecimal`,
+ * `NumpadEnter` — are deliberately absent. Such a key reports the same `code` in
+ * both NumLock states but a different virtual key: `Numpad4` is 37/`VK_LEFT`
+ * with NumLock off and 100/`VK_NUMPAD4` with it on. An entry here would have to
+ * commit to one state and be wrong in the other, and it would win over the value
+ * the browser resolved; falling through to `event.keyCode` is right in both.
+ * `NumpadAdd`/`Subtract`/`Multiply`/`Divide` stay because they do not change with
+ * NumLock. A key needs no entry here to be forwarded — the allow-list matches
+ * `event.code`, so `'Numpad4'` passed to `useKeyboardKeys()` works regardless.
  *
- * `InvertedKeyMap` is consequently lossy. `NumpadEnter` and `Numpad4/8/6/2`
- * share their values with `Enter` and `Arrow*`, and the derivation keeps the
- * last name written for a value, so those five cannot be reached through it —
- * which is what makes them unnameable through the numeric form of
- * `useKeyboardKeys()`. The `OSLeft`/`MetaLeft` and `OSRight`/`MetaRight` pairs
- * share a value on purpose: they are legacy and current names for the same
- * physical key.
+ * Two names may share a value — `OSLeft`/`MetaLeft` and `OSRight`/`MetaRight`
+ * are the legacy and current names for one physical key. Nothing reads this
+ * table backwards, so a shared value costs nothing.
  */
-const KeyboardNumericCode = {
+const UnrealKeyCode = {
     Backspace: 8,
     Tab: 9,
-    // The NumLock-*off* virtual keys. Declared before `Enter` and the arrows on
-    // purpose: those come later and so win the `InvertedKeyMap` derivation, which
-    // keeps 13 resolving to `Enter` and 37-40 to `Arrow*`.
-    Numpad5: 12,
-    NumpadEnter: 13,
-    Numpad9: 33,
-    Numpad3: 34,
-    Numpad1: 35,
-    Numpad7: 36,
-    Numpad4: 37,
-    Numpad8: 38,
-    Numpad6: 39,
-    Numpad2: 40,
-    Numpad0: 45,
-    NumpadDecimal: 46,
     Enter: 13,
     ShiftLeft: 16,
     ControlLeft: 17,
     AltLeft: 18,
+    Pause: 19,
+    CapsLock: 20,
     Escape: 27,
     Space: 32,
+    PageUp: 33,
+    PageDown: 34,
+    End: 35,
+    Home: 36,
     ArrowLeft: 37,
     ArrowUp: 38,
     ArrowRight: 39,
     ArrowDown: 40,
+    Insert: 45,
+    Delete: 46,
     Digit0: 48,
     Digit1: 49,
     Digit2: 50,
@@ -471,14 +454,36 @@ const MODIFIER_KEY_CODES = new Set([
     'OSLeft',
     'OSRight',
 ]);
-const InvertedKeyMapValues = {};
-//For use for InvertedKeyMap[32] will return 'Space' and so on
-const InvertedKeyMap = InvertedKeyMapValues;
-Object.entries(KeyboardNumericCode).forEach(
-// @ts-expect-error @typescript-eslint/ban-ts-comment
-([key, value]) => {
-    InvertedKeyMapValues[value] = key;
-});
+/**
+ * Every key this module can forward, for `InputService.useKeyboardKeys()`.
+ *
+ * The table's own names cover everything whose `code` it knows; the numpad
+ * digits, `NumpadDecimal` and `NumpadEnter` are left out of the table on purpose
+ * — a numpad key reports the same `code` in both NumLock states but a different
+ * virtual key — and so are reachable only by name. The allow-list is matched
+ * against `event.code`, which needs no entry, so naming them here is enough.
+ *
+ * Passing this list forwards the browser keys too — F1-F12, `Tab`, `Escape`,
+ * `Backspace`, the lock keys, `ContextMenu`, `Meta`/`OS`. With
+ * `suppressBrowserKeys` on, F1-F12 and `Tab` also stop reaching the browser, so
+ * F5 no longer reloads and F12 no longer opens devtools. Prefer a narrower list
+ * unless the scene really owns the whole keyboard.
+ */
+const ALL_KEYBOARD_KEYS = [
+    ...Object.keys(UnrealKeyCode),
+    'Numpad0',
+    'Numpad1',
+    'Numpad2',
+    'Numpad3',
+    'Numpad4',
+    'Numpad5',
+    'Numpad6',
+    'Numpad7',
+    'Numpad8',
+    'Numpad9',
+    'NumpadDecimal',
+    'NumpadEnter',
+];
 
 const ControlScheme = {
     // A mouse can lock inside the WebRTC player, so the user can simply move the
@@ -6096,15 +6101,12 @@ class InputService extends SubService {
     }
     /**
      * Replaces the forwarded-key allow-list. Takes physical key names
-     * (`KeyboardEvent.code`) such as `'KeyW'` or `'BracketLeft'`.
-     *
-     * Legacy numeric `keyCode` values are still accepted and converted, but they
-     * cannot express every key: `InvertedKeyMap` is many-to-one, so 37 resolves
-     * to `'ArrowLeft'` and 17 to `'ControlLeft'`, and `'Numpad4'`/`'ControlRight'`
-     * are unreachable through the numeric form. Pass names.
+     * (`KeyboardEvent.code`) such as `'KeyW'`, `'BracketLeft'` or `'Numpad4'` —
+     * the same units `isKeyAllowed()` compares against, so no conversion happens
+     * and a key needs no entry in `UnrealKeyCode` to be forwarded.
      */
     useKeyboardKeys(keys) {
-        this.availableKeys = new Set(keys.map((key) => (typeof key === 'number' ? InvertedKeyMap[key] : key)));
+        this.availableKeys = new Set(keys);
     }
     get video() {
         return this.videoService.video;
@@ -6459,7 +6461,7 @@ class InputService extends SubService {
      * The key code Unreal expects — the Windows virtual-key code — or `null` when
      * the event carries no key worth forwarding.
      *
-     * `KeyboardNumericCode` covers only the keys whose `event.keyCode` cannot be
+     * `UnrealKeyCode` covers only the keys whose `event.keyCode` cannot be
      * trusted; everything else, the numpad included, falls through to the value
      * the browser resolved.
      *
@@ -6471,8 +6473,7 @@ class InputService extends SubService {
         if (e.keyCode === IME_PROCESS_KEY) {
             return null;
         }
-        const keyCode = KeyboardNumericCode[e.code] ??
-            e.keyCode;
+        const keyCode = UnrealKeyCode[e.code] ?? e.keyCode;
         return keyCode || null;
     }
     /**
@@ -6554,10 +6555,10 @@ class InputService extends SubService {
             this.heldKeys.add(keyCode);
             // Backspace isn't a keypress in JS, but UE4 text-entry fields need it
             // to delete characters.
-            if (keyCode === SpecialKeyCodes.BackSpace) {
+            if (keyCode === UnrealKeyCode.Backspace) {
                 const data = this.keyPressView;
                 data.setUint8(0, MessageType.KeyPress);
-                data.setUint16(1, SpecialKeyCodes.BackSpace, true);
+                data.setUint16(1, UnrealKeyCode.Backspace, true);
                 this.sendInputData(data.buffer);
             }
         });
@@ -9056,5 +9057,5 @@ function provideUnrealModule() {
  * Generated bundle index. Do not edit.
  */
 
-export { AFKService, AUTO_HIGH_RESOLUTION_IDLE_MS, AfkTimeoutModalComponent, AggregatorService, AnalyticsService, AnswerHandler, CommandTelemetryService, ConfigHandler, ConsoleExtensionsService, ControlScheme, DATA_CHANNEL_CONNECTION_TIMEOUT, DEBOUNCE_TO_MANY_RESIZE_CALLS, DEFAULT_AFK_TIMEOUT, DEFAULT_AFK_TIMEOUT_PERIOD, DESTROY_DISCONNECT_REASONS, DevModeService, DisconnectReason, FULL_HD_HEIGHT, FULL_HD_WIDTH, FileHandlerService, FileReceiverService, FpsMonitorService, FreezeFrameComponent, FreezeFrameService, IME_PROCESS_KEY, INNER_RETRY_LIMIT, INSTANCE_READY_TIMEOUT, IceCandidateHandler, ImageLoadingSrcComponent, InputOptions, InputService, InstanceReadyHandler, InstanceReservedHandler, IntroSrcComponent, InvertedKeyMap, KeyboardNumericCode, LatencyTimings, LoadingProgressService, MINIMAL_FPS, MIN_CONTAINER_SIZE, MODIFIER_KEY_CODES, MessageType, MouseButton, MouseButtonsMask, OUTER_RETRY_DELAY, OnCloseHandler, OnErrorHandler, OnMessageHandler, OnOpenHandler, OrchestrationMessageTypes, POLLING_TIME, PlayerCountHandler, RECONNECT_CONFIG, REGION_PING_ACCURATE_SAMPLES, REGION_PING_BACKGROUND_REFRESH_DELAY_MS, REGION_PING_CACHE_KEY, REGION_PING_CACHE_TTL_MS, REGION_PING_WARMUP_DEADLINE_MS, RegionsPingService, SAME_SIZE_THRESHOLD, SCREEN_LOCKER_CONTAINER_ID, SIGNALLING_PERCENT_VALUE, SSInfoHandler, STREAMING_AUDIO_ID, STREAMING_VIDEO_ID, SafePipe, SignallingService, SpecialKeyCodes, StatGraphComponent, StreamAdoptionService, StreamStatusTelemetryService, StreamStatusTelemetryService2, SubService, ToClientMessage, UnrealAfkSlotDirective, UnrealCallbackService, UnrealCommunicatorService, UnrealEffects, UnrealResumeSlotDirective, UnrealSceneComponent, UnrealStatusMessage, UnrealStatusSlotDirective, VideoService, VideoStatsComponent, WSCloseCode_CIRRUS_ABNORMAL_CLOSURE, WSCloseCode_CIRRUS_MAX_PLAYERS_ERROR, WSCloseCode_CIRRUS_PLAYER_DISCONNECTED, WSCloseCode_CIRRUS_STREAMER_KIKED_PLAYER, WSCloseCode_FORCE_CIRRUS_CLOSE, WSCloseCode_NORMAL_AFK_TIMEOUT, WSCloseCode_NORMAL_CLOSURE, WSCloseCode_NORMAL_MANUAL_DISCONNECT, WSCloseCode_UNKNOWN, WSCloseCodes, WS_OPEN_STATE, WS_RETRY_PER_INSTANCE, WS_TIMEOUT, WebRtcPlayerService, WebrtcErrorModalComponent, abortEstablishingConnection, answerSent, changeStatusMainVideoOnScene, changeStreamResolutionAction, commandCompleted, commandStarted, dataChannelConnected, dataChannelReady, decodeData, destroyRemoteConnections, destroyUnrealScene, disconnectStream, dispatchResize, dropConnection, dropDC, dropPC, floatToPercents, floatToSmoothPercents, forceResizeViewport, fromResizeObserver, getActiveUrl, getImageFromVideoStream, getResizeStudioValues, getResizeValuesUniversal, getRtcErrorMessage, iceConnectionFailed, initSignalling, instanceReady, isAppOwned, isMetaboxMode, keepMaxUntilReset, makeEven, pollingEnded, pollingStarted, provideUnrealModule, provideUnrealState, qpToQuality, reconnectPeer, reconnectPeerFailed, reconnectPeerSuccess, regionPingFetchEnd, regionPingFetchStart, regionResolved, resetAfk, resetConfig, resetDataChannelForReconnect, resetIntroSrc, resetUserInactivityTimeout, resetWarnTimeout, resolveSkin, saveAnalyticsEvent, selectCirrusConnectionId, selectClientAndViewIds, selectCommandProgress, selectFreezeFrameCombinedDataUrl, selectFreezeFrameDataUrl, selectFreezeFrameDataUrlFromVideo, selectFreezeFrameProgressMessageFromVideo, selectIsAutostart, selectIsExistMatchUrls, selectIsFreezeFrameLoading, selectIsFullyConnected, selectIsLoaderScreenVisible, selectIsVideoPlayingAndDataChannelConnected, selectShowLoader, selectShowReconnectPopup, selectSignalingParameters, selectStreamConfig, selectTotalProgress, selectUserInactivityDetected, selectWarnTimeout, setAfkTimerCountdown, setAfkTimerHide, setAfkTimerVisible, setAwsInstance, setCirrusConnected, setCirrusDisconnected, setConfig, setEstablishingConnection, setFreezeFrame, setFreezeFrameFromVideo, setIntroImageSrc, setIntroVideoSrc, setLoadingImageSrc, setLoopBackCommandIsCompleted, setMaxFps, setOrchestrationContext, setOrchestrationMessage, setOrchestrationParameters, setOrchestrationProgress, setSignalingName, setStatusMessage, setStatusPercentSignallingServer, setStreamClientCompanyId, setStreamViewId, setUnrealPlaywrightConfig, setUserInactivityTimeout, setViewportNotReady, setViewportReady, showLoadingProgress, showResumeStreamPopup, showUnrealErrorMessage, showUserInactivityTimeoutPopup, signalingRetryAttempted, startStream, streamAdopted, trackMixpanelEvent, trackTelemetryData, uint8ToBase64, unrealCommandCallback, unrealFeature, unrealReducer, updateCirrusInfo, videoAdaptedToContainer, videoStreamInitialized };
+export { AFKService, ALL_KEYBOARD_KEYS, AUTO_HIGH_RESOLUTION_IDLE_MS, AfkTimeoutModalComponent, AggregatorService, AnalyticsService, AnswerHandler, CommandTelemetryService, ConfigHandler, ConsoleExtensionsService, ControlScheme, DATA_CHANNEL_CONNECTION_TIMEOUT, DEBOUNCE_TO_MANY_RESIZE_CALLS, DEFAULT_AFK_TIMEOUT, DEFAULT_AFK_TIMEOUT_PERIOD, DESTROY_DISCONNECT_REASONS, DevModeService, DisconnectReason, FULL_HD_HEIGHT, FULL_HD_WIDTH, FileHandlerService, FileReceiverService, FpsMonitorService, FreezeFrameComponent, FreezeFrameService, IME_PROCESS_KEY, INNER_RETRY_LIMIT, INSTANCE_READY_TIMEOUT, IceCandidateHandler, ImageLoadingSrcComponent, InputOptions, InputService, InstanceReadyHandler, InstanceReservedHandler, IntroSrcComponent, LatencyTimings, LoadingProgressService, MINIMAL_FPS, MIN_CONTAINER_SIZE, MODIFIER_KEY_CODES, MessageType, MouseButton, MouseButtonsMask, OUTER_RETRY_DELAY, OnCloseHandler, OnErrorHandler, OnMessageHandler, OnOpenHandler, OrchestrationMessageTypes, POLLING_TIME, PlayerCountHandler, RECONNECT_CONFIG, REGION_PING_ACCURATE_SAMPLES, REGION_PING_BACKGROUND_REFRESH_DELAY_MS, REGION_PING_CACHE_KEY, REGION_PING_CACHE_TTL_MS, REGION_PING_WARMUP_DEADLINE_MS, RegionsPingService, SAME_SIZE_THRESHOLD, SCREEN_LOCKER_CONTAINER_ID, SIGNALLING_PERCENT_VALUE, SSInfoHandler, STREAMING_AUDIO_ID, STREAMING_VIDEO_ID, SafePipe, SignallingService, StatGraphComponent, StreamAdoptionService, StreamStatusTelemetryService, StreamStatusTelemetryService2, SubService, ToClientMessage, UnrealAfkSlotDirective, UnrealCallbackService, UnrealCommunicatorService, UnrealEffects, UnrealKeyCode, UnrealResumeSlotDirective, UnrealSceneComponent, UnrealStatusMessage, UnrealStatusSlotDirective, VideoService, VideoStatsComponent, WSCloseCode_CIRRUS_ABNORMAL_CLOSURE, WSCloseCode_CIRRUS_MAX_PLAYERS_ERROR, WSCloseCode_CIRRUS_PLAYER_DISCONNECTED, WSCloseCode_CIRRUS_STREAMER_KIKED_PLAYER, WSCloseCode_FORCE_CIRRUS_CLOSE, WSCloseCode_NORMAL_AFK_TIMEOUT, WSCloseCode_NORMAL_CLOSURE, WSCloseCode_NORMAL_MANUAL_DISCONNECT, WSCloseCode_UNKNOWN, WSCloseCodes, WS_OPEN_STATE, WS_RETRY_PER_INSTANCE, WS_TIMEOUT, WebRtcPlayerService, WebrtcErrorModalComponent, abortEstablishingConnection, answerSent, changeStatusMainVideoOnScene, changeStreamResolutionAction, commandCompleted, commandStarted, dataChannelConnected, dataChannelReady, decodeData, destroyRemoteConnections, destroyUnrealScene, disconnectStream, dispatchResize, dropConnection, dropDC, dropPC, floatToPercents, floatToSmoothPercents, forceResizeViewport, fromResizeObserver, getActiveUrl, getImageFromVideoStream, getResizeStudioValues, getResizeValuesUniversal, getRtcErrorMessage, iceConnectionFailed, initSignalling, instanceReady, isAppOwned, isMetaboxMode, keepMaxUntilReset, makeEven, pollingEnded, pollingStarted, provideUnrealModule, provideUnrealState, qpToQuality, reconnectPeer, reconnectPeerFailed, reconnectPeerSuccess, regionPingFetchEnd, regionPingFetchStart, regionResolved, resetAfk, resetConfig, resetDataChannelForReconnect, resetIntroSrc, resetUserInactivityTimeout, resetWarnTimeout, resolveSkin, saveAnalyticsEvent, selectCirrusConnectionId, selectClientAndViewIds, selectCommandProgress, selectFreezeFrameCombinedDataUrl, selectFreezeFrameDataUrl, selectFreezeFrameDataUrlFromVideo, selectFreezeFrameProgressMessageFromVideo, selectIsAutostart, selectIsExistMatchUrls, selectIsFreezeFrameLoading, selectIsFullyConnected, selectIsLoaderScreenVisible, selectIsVideoPlayingAndDataChannelConnected, selectShowLoader, selectShowReconnectPopup, selectSignalingParameters, selectStreamConfig, selectTotalProgress, selectUserInactivityDetected, selectWarnTimeout, setAfkTimerCountdown, setAfkTimerHide, setAfkTimerVisible, setAwsInstance, setCirrusConnected, setCirrusDisconnected, setConfig, setEstablishingConnection, setFreezeFrame, setFreezeFrameFromVideo, setIntroImageSrc, setIntroVideoSrc, setLoadingImageSrc, setLoopBackCommandIsCompleted, setMaxFps, setOrchestrationContext, setOrchestrationMessage, setOrchestrationParameters, setOrchestrationProgress, setSignalingName, setStatusMessage, setStatusPercentSignallingServer, setStreamClientCompanyId, setStreamViewId, setUnrealPlaywrightConfig, setUserInactivityTimeout, setViewportNotReady, setViewportReady, showLoadingProgress, showResumeStreamPopup, showUnrealErrorMessage, showUserInactivityTimeoutPopup, signalingRetryAttempted, startStream, streamAdopted, trackMixpanelEvent, trackTelemetryData, uint8ToBase64, unrealCommandCallback, unrealFeature, unrealReducer, updateCirrusInfo, videoAdaptedToContainer, videoStreamInitialized };
 //# sourceMappingURL=3dsource-angular-unreal-module.mjs.map