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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@3dsource/angular-unreal-module",
-  "version": "0.0.181",
+  "version": "0.0.183",
   "description": "Angular integration for Unreal Engine Pixel Streaming",
   "keywords": [
     "3dsource",

package/types/3dsource-angular-unreal-module.d.ts

@@ -235,15 +235,6 @@ declare class WebrtcErrorModalComponent {
     static ɵcmp: i0.ɵɵComponentDeclaration<WebrtcErrorModalComponent, "app-webrtc-error-modal", never, {}, {}, never, never, true, never>;
 }
 
-declare const SpecialKeyCodes: {
-    BackSpace: number;
-    Shift: number;
-    Control: number;
-    Alt: number;
-    RightShift: number;
-    RightControl: number;
-    RightAlt: number;
-};
 declare const MouseButton: {
     MainButton: number;
     AuxiliaryButton: number;
@@ -260,7 +251,8 @@ declare 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
@@ -268,34 +260,47 @@ declare 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 is deliberately absent. 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 — so any entry here would
- * have to commit to one state and be wrong in the other. Falling through to
- * `event.keyCode` is right in both. `NumpadAdd`/`Subtract`/`Multiply`/`Divide`
- * stay because 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.
  *
- * Values must stay unique so `InvertedKeyMap` is lossless. 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.
  */
-declare const KeyboardNumericCode: {
+declare const UnrealKeyCode: {
     readonly Backspace: 8;
     readonly Tab: 9;
     readonly Enter: 13;
     readonly ShiftLeft: 16;
     readonly ControlLeft: 17;
     readonly AltLeft: 18;
+    readonly Pause: 19;
+    readonly CapsLock: 20;
     readonly Escape: 27;
     readonly Space: 32;
+    readonly PageUp: 33;
+    readonly PageDown: 34;
+    readonly End: 35;
+    readonly Home: 36;
     readonly ArrowLeft: 37;
     readonly ArrowUp: 38;
     readonly ArrowRight: 39;
     readonly ArrowDown: 40;
+    readonly Insert: 45;
+    readonly Delete: 46;
     readonly Digit0: 48;
     readonly Digit1: 49;
     readonly Digit2: 50;
@@ -385,21 +390,33 @@ declare const IME_PROCESS_KEY = 229;
  * flight" check has to exempt them or `ControlRight` would block itself.
  */
 declare const MODIFIER_KEY_CODES: ReadonlySet<string>;
-type IKeyName = keyof typeof KeyboardNumericCode;
-type IKeyCode = (typeof KeyboardNumericCode)[IKeyName];
+type IKeyName = keyof typeof UnrealKeyCode;
+type IKeyCode = (typeof UnrealKeyCode)[IKeyName];
 /**
  * A physical key name as reported by `KeyboardEvent.code`.
  *
  * The union lists the names this table knows a virtual-key code for, so editors
  * complete them. The `string` branch keeps every other DOM code assignable —
- * `'Numpad4'`, `'Delete'`, `'Home'` — since a key needs no entry here to be
+ * `'Numpad4'`, `'NumpadEnter'`, `'F13'` — since a key needs no entry here to be
  * matched against `event.code`.
  */
 type IKeyCodeName = IKeyName | (string & Record<never, never>);
-type InvertedKeyMapType = {
-    [K in IKeyName as (typeof KeyboardNumericCode)[K]]: K;
-};
-declare const InvertedKeyMap: InvertedKeyMapType;
+/**
+ * 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.
+ */
+declare const ALL_KEYBOARD_KEYS: readonly IKeyCodeName[];
 
 declare const ControlScheme: {
     readonly LockedMouse: 0;
@@ -1457,14 +1474,11 @@ declare class InputService extends SubService {
     protected init(): void;
     /**
      * 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: readonly (IKeyCode | IKeyCodeName)[]): void;
+    useKeyboardKeys(keys: readonly IKeyCodeName[]): void;
     get video(): HTMLVideoElement | null;
     private setup;
     /**
@@ -1506,7 +1520,7 @@ declare 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.
      *
@@ -3583,5 +3597,5 @@ declare const selectUserInactivityDetected: _ngrx_store.MemoizedSelector<Record<
 /** Used by external consumers (e.g., metabox). Do not remove. */
 declare const selectIsVideoPlayingAndDataChannelConnected: _ngrx_store.MemoizedSelector<Record<string, any>, boolean, (s1: boolean, s2: boolean) => boolean>;
 
-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 };
 export type { AggregatedStat, AnySignalingMessage, AppOwnedStream, Area, AwsInstance, BootstrapInfo, CandidateMessage, CirrusRequestKind, CloseReason, CommandInProgress, ConfigMessage, ConnectionError, ControlSchemeValues, Coords, DisconnectReasonType, EmittedMilestone, EventId, FpsLowData, FreezeFrameMessage, IKeyCode, IKeyCodeName, IKeyName, ImageOutputValues, InboundVideoStats, InputProps, InstanceReady, InstanceReserved, InterruptClientStream, ListStreamersMessage, MessageBase, MessageTypeValues, OrchestrationErrorMessage, OrchestrationMessageType, P2PEstablishedMessage, ParkedStream, PhaseEndedData, PhaseOverlay, PhaseParam, PlayerCountMessage, PollingOrchestrationMessage, Quality, QualityAnomalyData, ReceivedFile, Rect, RequestStream, ResourceBucket, ResourceTotals, SSInfo, SampleData, SelectedIceCandidatePair, SessionEndReason, SessionEndedData, SessionStartedData, SignalingData, SignalingMessageHandler, SignalingMessageMap, SignalingRetryData, SignalingRetryKind, Size, SlowResource, StreamConfig, StreamRequestContext, StreamResolutionProps, StreamTelemetryEvent, StreamTelemetryEventMap, StreamTelemetryEventName, StreamTelemetryLifecycleData, StreamTelemetryLifecycleEventName, StreamTelemetryTrackData, StreamerListMessage, TelemetryEventEnvelope, TelemetryLifecycleEnvelope, TelemetryType, UnknownFields, UnrealAfkSlotContext, UnrealCallbackDescriptor, UnrealCallbackEventMap, UnrealCallbackJson, UnrealCallbackJsonWrapped, UnrealResumeSlotContext, UnrealSlotTemplateContext, UnrealState, UnrealStatusSlotContext, UnrealUiClasses, UnrealUiPart, WSCloseCodesValues, WindowAggregate };