@push.rocks/smartbrowser 4.0.2 → 4.2.0

package/ts_web/interfaces.livebrowsercanvas.ts

@@ -26,10 +26,11 @@ export interface ILiveBrowserCanvasClient {
     requestArg: ILiveBrowserFrameAcknowledgementRequest,
     optionsArg: ILiveBrowserCanvasOperationOptions,
   ): Promise<ILiveBrowserFrameAcknowledgement>;
+  /** Shared hosts return their effective viewport, which may be constrained by another viewer. */
   setViewport(
     viewportArg: ILiveBrowserViewport,
     optionsArg: ILiveBrowserCanvasOperationOptions,
-  ): Promise<void>;
+  ): Promise<void | ILiveBrowserCanvasViewportResult>;
   dispatchMouse(
     inputArg: ILiveBrowserMouseInput,
     optionsArg: ILiveBrowserCanvasOperationOptions,
@@ -48,6 +49,12 @@ export interface ILiveBrowserCanvasClient {
   ): Promise<void>;
 }
 
+export interface ILiveBrowserCanvasViewportResult {
+  viewport: ILiveBrowserViewport;
+  /** The authoritative revision, including when the aggregate viewport did not change. */
+  viewportRevision: number;
+}
+
 export interface ILiveBrowserCanvasOperationOptions {
   /** Adapters must propagate this signal and reject promptly when it aborts. */
   signal: AbortSignal;
@@ -81,3 +88,24 @@ export interface ILiveBrowserCanvasRendererOptions {
   onError?: (errorArg: ILiveBrowserCanvasError) => void;
   onFrameRendered?: (frameArg: ILiveBrowserFrame) => void;
 }
+
+/**
+ * Cumulative renderer counters. Counts accumulate across runs of one instance;
+ * inputCommandsInFlight is the live value at the time of the call.
+ */
+export interface ILiveBrowserCanvasRendererStatistics {
+  /** Frame events delivered to an active run, including ones rejected by validation. */
+  framesReceived: number;
+  /** Frames whose bitmap decoded with matching dimensions. */
+  framesDecoded: number;
+  /** Frames retired without being drawn: superseded, stale, or replaced before presentation. */
+  framesSkipped: number;
+  /** Input submissions accepted by the renderer, including ones later merged. */
+  inputCommandsEnqueued: number;
+  /** Submissions merged into another command or dropped under queue pressure. */
+  inputCommandsCoalesced: number;
+  /** Client input operations currently awaiting a result. */
+  inputCommandsInFlight: number;
+  /** Duration of the most recently completed input dispatch in milliseconds; 0 before the first. */
+  lastInputRoundTripMs: number;
+}