@vulfram/engine 0.5.8-alpha → 0.17.1-alpha

package/src/types/cmds/window.ts

@@ -22,6 +22,9 @@ export interface CmdWindowCreateArgs {
 export interface CmdResultWindowCreate {
   success: boolean;
   message: string;
+  realmId?: number;
+  surfaceId?: number;
+  presentId?: number;
 }
 
 /** Command payload for closing a window. */
@@ -35,229 +38,63 @@ export interface CmdResultWindowClose {
   message: string;
 }
 
-/** Command payload for setting window title. */
-export interface CmdWindowSetTitleArgs {
+/** Command payload for changing and/or querying window measurements. */
+export interface CmdWindowMeasurementArgs {
   windowId: number;
-  title: string;
+  position?: [number, number];
+  size?: [number, number];
+  getPosition?: boolean;
+  getSize?: boolean;
+  getOuterSize?: boolean;
+  getSurfaceSize?: boolean;
 }
 
-/** Result payload for window title update. */
-export interface CmdResultWindowSetTitle {
+/** Result payload for window measurement command. */
+export interface CmdResultWindowMeasurement {
   success: boolean;
   message: string;
+  position?: [number, number];
+  size?: [number, number];
+  outerSize?: [number, number];
+  surfaceSize?: [number, number];
 }
 
-/** Command payload for setting window position. */
-export interface CmdWindowSetPositionArgs {
+/** Command payload for cursor updates. */
+export interface CmdWindowCursorArgs {
   windowId: number;
-  position: [number, number];
+  visible?: boolean;
+  mode?: CursorGrabMode;
+  icon?: CursorIcon;
 }
 
-/** Result payload for window position update. */
-export interface CmdResultWindowSetPosition {
+/** Result payload for cursor command. */
+export interface CmdResultWindowCursor {
   success: boolean;
   message: string;
 }
 
-/** Command payload for querying window position. */
-export interface CmdWindowGetPositionArgs {
-  windowId: number;
-}
-
-/** Result payload for window position query. */
-export interface CmdResultWindowGetPosition {
-  success: boolean;
-  message: string;
-  content: [number, number];
-}
-
-/** Command payload for setting window size. */
-export interface CmdWindowSetSizeArgs {
-  windowId: number;
-  size: [number, number];
-}
-
-/** Result payload for window size update. */
-export interface CmdResultWindowSetSize {
-  success: boolean;
-  message: string;
-}
-
-/** Command payload for querying window size. */
-export interface CmdWindowGetSizeArgs {
-  windowId: number;
-}
-
-/** Result payload for window size query. */
-export interface CmdResultWindowGetSize {
-  success: boolean;
-  message: string;
-  content: [number, number];
-}
-
-/** Command payload for querying outer window size. */
-export interface CmdWindowGetOuterSizeArgs {
-  windowId: number;
-}
-
-/** Result payload for outer window size query. */
-export interface CmdResultWindowGetOuterSize {
-  success: boolean;
-  message: string;
-  content: [number, number];
-}
-
-/** Command payload for querying surface size. */
-export interface CmdWindowGetSurfaceSizeArgs {
-  windowId: number;
-}
-
-/** Result payload for surface size query. */
-export interface CmdResultWindowGetSurfaceSize {
-  success: boolean;
-  message: string;
-  content: [number, number];
-}
-
-/** Command payload for setting window state. */
-export interface CmdWindowSetStateArgs {
-  windowId: number;
-  state: WindowState;
-}
-
-/** Result payload for window state update. */
-export interface CmdResultWindowSetState {
-  success: boolean;
-  message: string;
-}
-
-/** Command payload for querying window state. */
-export interface CmdWindowGetStateArgs {
-  windowId: number;
-}
-
-/** Result payload for window state query. */
-export interface CmdResultWindowGetState {
-  success: boolean;
-  message: string;
-  content: WindowState;
-}
-
-/** Command payload for setting window icon. */
-export interface CmdWindowSetIconArgs {
-  windowId: number;
-  icon: string; // Buffer ID pointing to an image
-}
-
-/** Result payload for window icon update. */
-export interface CmdResultWindowSetIcon {
-  success: boolean;
-  message: string;
-}
-
-/** Command payload for toggling window decorations. */
-export interface CmdWindowSetDecorationsArgs {
-  windowId: number;
-  decorations: boolean;
-}
-
-/** Result payload for window decoration update. */
-export interface CmdResultWindowSetDecorations {
-  success: boolean;
-  message: string;
-}
+export type WindowStateAction = 'focus' | 'request-attention';
 
-/** Command payload for querying window decorations. */
-export interface CmdWindowHasDecorationsArgs {
-  windowId: number;
-}
-
-/** Result payload for window decoration query. */
-export interface CmdResultWindowHasDecorations {
-  success: boolean;
-  message: string;
-  content: boolean;
-}
-
-/** Command payload for toggling window resizable state. */
-export interface CmdWindowSetResizableArgs {
-  windowId: number;
-  resizable: boolean;
-}
-
-/** Result payload for window resizable update. */
-export interface CmdResultWindowSetResizable {
-  success: boolean;
-  message: string;
-}
-
-/** Command payload for querying resizable state. */
-export interface CmdWindowIsResizableArgs {
-  windowId: number;
-}
-
-/** Result payload for resizable query. */
-export interface CmdResultWindowIsResizable {
-  success: boolean;
-  message: string;
-  content: boolean;
-}
-
-/** Command payload for requesting user attention. */
-export interface CmdWindowRequestAttentionArgs {
+/** Command payload for state updates/queries. */
+export interface CmdWindowStateArgs {
   windowId: number;
+  title?: string;
+  state?: WindowState;
+  iconBufferId?: number;
+  decorations?: boolean;
+  resizable?: boolean;
+  action?: WindowStateAction;
   attentionType?: UserAttentionType;
+  getState?: boolean;
+  getDecorations?: boolean;
+  getResizable?: boolean;
 }
 
-/** Result payload for attention request. */
-export interface CmdResultWindowRequestAttention {
-  success: boolean;
-  message: string;
-}
-
-/** Command payload for focusing a window. */
-export interface CmdWindowFocusArgs {
-  windowId: number;
-}
-
-/** Result payload for window focus. */
-export interface CmdResultWindowFocus {
-  success: boolean;
-  message: string;
-}
-
-/** Command payload for toggling cursor visibility. */
-export interface CmdWindowSetCursorVisibleArgs {
-  windowId: number;
-  visible: boolean;
-}
-
-/** Result payload for cursor visibility update. */
-export interface CmdResultWindowSetCursorVisible {
-  success: boolean;
-  message: string;
-}
-
-/** Command payload for setting cursor grab mode. */
-export interface CmdWindowSetCursorGrabArgs {
-  windowId: number;
-  mode: CursorGrabMode;
-}
-
-/** Result payload for cursor grab update. */
-export interface CmdResultWindowSetCursorGrab {
-  success: boolean;
-  message: string;
-}
-
-/** Command payload for setting cursor icon. */
-export interface CmdWindowSetCursorIconArgs {
-  windowId: number;
-  icon: CursorIcon;
-}
-
-/** Result payload for cursor icon update. */
-export interface CmdResultWindowSetCursorIcon {
+/** Result payload for state command. */
+export interface CmdResultWindowState {
   success: boolean;
   message: string;
+  state?: WindowState;
+  decorations?: boolean;
+  resizable?: boolean;
 }

package/src/types/events/index.ts

@@ -3,12 +3,14 @@ import type { PointerEvent } from './pointer';
 import type { KeyboardEvent } from './keyboard';
 import type { GamepadEvent } from './gamepad';
 import type { SystemEvent } from './system';
+import type { UiEvent } from './ui';
 
 export * from './window';
 export * from './pointer';
 export * from './keyboard';
 export * from './gamepad';
 export * from './system';
+export * from './ui';
 
 /** Discriminated union of all engine events. */
 export type EngineEvent =
@@ -16,4 +18,5 @@ export type EngineEvent =
   | { type: 'pointer'; content: PointerEvent }
   | { type: 'keyboard'; content: KeyboardEvent }
   | { type: 'gamepad'; content: GamepadEvent }
-  | { type: 'system'; content: SystemEvent };
+  | { type: 'system'; content: SystemEvent }
+  | { type: 'ui'; content: UiEvent };

package/src/types/events/pointer.ts

@@ -1,33 +1,63 @@
 import type { ElementState, TouchPhase } from '../kinds';
 
-/** Scroll delta reported in line or pixel units. */
 export type ScrollDelta =
   | { type: 'line'; value: [number, number] }
   | { type: 'pixel'; value: [number, number] };
 
-/** Payload for pointer move event. */
+export type PointerTraceStage =
+  | 'root-window'
+  | 'capture'
+  | 'focus-fallback'
+  | 'connector-hit'
+  | 'realm-plane-hit'
+  | 'hop-forward'
+  | 'stop-no-hit'
+  | 'stop-cycle'
+  | 'stop-step-budget';
+
+export interface PointerTraceHop {
+  stage: PointerTraceStage;
+  realmId?: number;
+  targetId?: number;
+  layerRealmId?: number;
+  connectorId?: number;
+  surfaceId?: number;
+  cameraId?: number;
+  uv?: [number, number];
+}
+
+export interface PointerEventTrace {
+  windowId: number;
+  realmId: number;
+  targetId?: number;
+  connectorId?: number;
+  sourceRealmId?: number;
+  uv?: [number, number];
+  hops: PointerTraceHop[];
+}
+
 export interface PointerEventOnMoveData {
   windowId: number;
   pointerType: number;
   pointerId: number;
   position: [number, number];
+  trace?: PointerEventTrace;
 }
 
-/** Payload for pointer enter event. */
 export interface PointerEventOnEnterData {
   windowId: number;
   pointerType: number;
   pointerId: number;
+  trace?: PointerEventTrace;
 }
 
-/** Payload for pointer leave event. */
 export interface PointerEventOnLeaveData {
   windowId: number;
   pointerType: number;
   pointerId: number;
+  trace?: PointerEventTrace;
 }
 
-/** Payload for pointer button event. */
 export interface PointerEventOnButtonData {
   windowId: number;
   pointerType: number;
@@ -35,51 +65,51 @@ export interface PointerEventOnButtonData {
   button: MouseButton;
   state: ElementState;
   position: [number, number];
+  trace?: PointerEventTrace;
 }
 
-/** Payload for pointer scroll event. */
 export interface PointerEventOnScrollData {
   windowId: number;
   delta: ScrollDelta;
   phase: TouchPhase;
+  trace?: PointerEventTrace;
 }
 
-/** Payload for touch event. */
 export interface PointerEventOnTouchData {
   windowId: number;
   pointerId: number;
   phase: TouchPhase;
   position: [number, number];
   pressure?: number;
+  trace?: PointerEventTrace;
 }
 
-/** Payload for pinch gesture event. */
 export interface PointerEventOnPinchGestureData {
   windowId: number;
   delta: number;
   phase: TouchPhase;
+  trace?: PointerEventTrace;
 }
 
-/** Payload for pan gesture event. */
 export interface PointerEventOnPanGestureData {
   windowId: number;
   delta: [number, number];
   phase: TouchPhase;
+  trace?: PointerEventTrace;
 }
 
-/** Payload for rotation gesture event. */
 export interface PointerEventOnRotationGestureData {
   windowId: number;
   delta: number;
   phase: TouchPhase;
+  trace?: PointerEventTrace;
 }
 
-/** Payload for double tap gesture event. */
 export interface PointerEventOnDoubleTapGestureData {
   windowId: number;
+  trace?: PointerEventTrace;
 }
 
-/** Discriminated union of pointer events. */
 export type PointerEvent =
   | { event: 'on-move'; data: PointerEventOnMoveData }
   | { event: 'on-enter'; data: PointerEventOnEnterData }
@@ -95,7 +125,6 @@ export type PointerEvent =
       data: PointerEventOnDoubleTapGestureData;
     };
 
-/** Mouse button identifiers. */
 export enum MouseButton {
   Left = 0,
   Right = 1,

package/src/types/events/system.ts

@@ -1,13 +1,156 @@
-/** Payload for notification system events. */
-export interface SystemEventOnNotificationData {
-  id: string;
-}
+import type { CursorGrabMode } from '../kinds';
+
+export type PointerTraceLevel = 'off' | 'errors' | 'basic' | 'full';
+
+export type UiViewportClass = 'root' | 'deferred' | 'immediate' | 'embedded';
+
+export type UiViewportCommand =
+  | { type: 'close' }
+  | { type: 'title'; content: { title: string } }
+  | { type: 'inner-size'; content: { width: number; height: number } }
+  | { type: 'outer-position'; content: { x: number; y: number } }
+  | { type: 'resizable'; content: { value: boolean } }
+  | { type: 'decorations'; content: { value: boolean } }
+  | { type: 'fullscreen'; content: { value: boolean } }
+  | { type: 'minimized'; content: { value: boolean } }
+  | { type: 'maximized'; content: { value: boolean } }
+  | { type: 'focus' }
+  | { type: 'screenshot' }
+  | { type: 'cursor-visible'; content: { value: boolean } }
+  | { type: 'cursor-grab'; content: { mode: CursorGrabMode } }
+  | { type: 'ime-allowed'; content: { value: boolean } }
+  | {
+      type: 'ime-rect';
+      content: { minX: number; minY: number; maxX: number; maxY: number };
+    };
 
-/** Discriminated union of system-level events. */
 export type SystemEvent =
+  | {
+      event: 'error';
+      data: {
+        scope: string;
+        message: string;
+        commandId?: number;
+        commandType?: string;
+      };
+    }
   | { event: 'on-resume' }
   | { event: 'on-suspend' }
   | { event: 'on-memory-warning' }
   | { event: 'on-exit' }
-  | { event: 'on-notification-clicked'; data: SystemEventOnNotificationData }
-  | { event: 'on-notification-dismissed'; data: SystemEventOnNotificationData };
+  | { event: 'on-notification-clicked'; data: { id: string } }
+  | { event: 'on-notification-dismissed'; data: { id: string } }
+  | {
+      event: 'texture-ready';
+      data: { windowId: number; textureId: number; success: boolean; message: string };
+    }
+  | {
+      event: 'texture-processing-started';
+      data: { windowId: number; textureId: number; totalBytes: number };
+    }
+  | {
+      event: 'texture-processing-progress';
+      data: {
+        windowId: number;
+        textureId: number;
+        processedBytes: number;
+        totalBytes: number;
+      };
+    }
+  | {
+      event: 'texture-processing-finished';
+      data: {
+        windowId: number;
+        textureId: number;
+        success: boolean;
+        message: string;
+        totalBytes: number;
+      };
+    }
+  | {
+      event: 'ui-image-ready';
+      data: { imageId: number; success: boolean; message: string };
+    }
+  | {
+      event: 'ui-image-processing-started';
+      data: { imageId: number; totalBytes: number };
+    }
+  | {
+      event: 'ui-image-processing-progress';
+      data: { imageId: number; processedBytes: number; totalBytes: number };
+    }
+  | {
+      event: 'ui-image-processing-finished';
+      data: {
+        imageId: number;
+        success: boolean;
+        message: string;
+        totalBytes: number;
+      };
+    }
+  | {
+      event: 'audio-ready';
+      data: { resourceId: number; success: boolean; message: string };
+    }
+  | {
+      event: 'audio-stream-progress';
+      data: {
+        resourceId: number;
+        receivedBytes: number;
+        totalBytes: number;
+        complete: boolean;
+      };
+    }
+  | {
+      event: 'ui-open-url';
+      data: { windowId: number; realmId: number; url: string; newTab: boolean };
+    }
+  | {
+      event: 'ui-clipboard-set-text';
+      data: { windowId: number; realmId: number; text: string };
+    }
+  | {
+      event: 'ui-clipboard-request-copy';
+      data: { windowId: number; realmId: number };
+    }
+  | {
+      event: 'ui-clipboard-request-cut';
+      data: { windowId: number; realmId: number };
+    }
+  | {
+      event: 'ui-clipboard-request-paste';
+      data: { windowId: number; realmId: number };
+    }
+  | {
+      event: 'ui-screenshot-request';
+      data: { windowId: number; realmId: number };
+    }
+  | {
+      event: 'ui-viewport-sync';
+      data: {
+        windowId: number;
+        realmId: number;
+        viewportId: number;
+        parentViewportId?: number;
+        class: UiViewportClass;
+        title?: string;
+      };
+    }
+  | {
+      event: 'ui-viewport-command';
+      data: {
+        windowId: number;
+        realmId: number;
+        viewportId: number;
+        command: UiViewportCommand;
+      };
+    }
+  | {
+      event: 'ui-viewport-fallback-embedded';
+      data: {
+        windowId: number;
+        realmId: number;
+        viewportId: number;
+        parentViewportId?: number;
+      };
+    };

package/src/types/events/ui.ts

@@ -0,0 +1,21 @@
+export type UiEventKind =
+  | 'click'
+  | 'double-click'
+  | 'pressed'
+  | 'released'
+  | 'hover-enter'
+  | 'hover-leave'
+  | 'changed'
+  | 'change-commit'
+  | 'focus'
+  | 'blur'
+  | 'submit'
+  | 'anim-complete';
+
+export interface UiEvent {
+  realmId: number;
+  documentId: number;
+  nodeId: number;
+  kind: UiEventKind;
+  label?: string;
+}

package/src/types/index.ts

@@ -1,3 +1,4 @@
 export * from './kinds';
+export * from './json';
 export * from './cmds';
 export * from './events';

package/src/types/json.ts

@@ -0,0 +1,15 @@
+/**
+ * JSON-like values that are safe to serialize across the host/core boundary.
+ */
+export type JsonValue =
+  | null
+  | boolean
+  | number
+  | string
+  | JsonValue[]
+  | { [key: string]: JsonValue };
+
+/**
+ * Convenience alias for object-shaped JSON payloads.
+ */
+export type JsonObject = { [key: string]: JsonValue };

package/src/types/kinds.ts

@@ -1,6 +1,9 @@
 /** Camera projection mode. */
 export type CameraKind = 'perspective' | 'orthographic';
 
+/** Audio playback mode. */
+export type AudioPlayMode = 'once' | 'loop';
+
 /** Standard cursor icons. */
 export type CursorIcon =
   | 'default'

package/src/window.ts

@@ -0,0 +1,8 @@
+export {
+  closeWindow,
+  createWindow,
+  focusWindow,
+  requestAttention,
+  updateWindow,
+} from './engine/window/manager';
+export type { WindowId } from './engine/world/types';

package/src/world-ui.ts

@@ -0,0 +1,2 @@
+export * from './engine/world/world-ui';
+export type { EntityId, TargetId, WorldId, WorldUIId } from './engine/world/types';

package/src/world3d.ts

@@ -0,0 +1,10 @@
+export * from './engine/world/world3d';
+export type {
+  EntityId,
+  GeometryId,
+  MaterialId,
+  TargetId,
+  TextureId,
+  World3DId,
+  WorldId,
+} from './engine/world/types';