@push.rocks/smartbrowser 3.0.0 → 4.0.0

package/ts_web/interfaces.livebrowsercanvas.ts

@@ -11,17 +11,46 @@ import type {
   TLiveBrowserEventListener,
 } from '@push.rocks/smartpuppeteer';
 
+/**
+ * Transport adapter for one renderer. Frame events must use strictly increasing
+ * sequence values for each onEvent subscription/renderer run.
+ */
 export interface ILiveBrowserCanvasClient {
   getState(): ILiveBrowserState;
   onEvent(listenerArg: TLiveBrowserEventListener): () => void;
+  /**
+   * A fulfilled result, including accepted: false, settles the local attempt.
+   * It does not prove that the upstream frame was retired.
+   */
   acknowledgeFrame(
     requestArg: ILiveBrowserFrameAcknowledgementRequest,
+    optionsArg: ILiveBrowserCanvasOperationOptions,
   ): Promise<ILiveBrowserFrameAcknowledgement>;
-  setViewport(viewportArg: ILiveBrowserViewport): Promise<void>;
-  dispatchMouse(inputArg: ILiveBrowserMouseInput): Promise<void>;
-  dispatchWheel(inputArg: ILiveBrowserWheelInput): Promise<void>;
-  dispatchKey(inputArg: ILiveBrowserKeyInput): Promise<void>;
-  insertText(inputArg: ILiveBrowserInsertTextInput): Promise<void>;
+  setViewport(
+    viewportArg: ILiveBrowserViewport,
+    optionsArg: ILiveBrowserCanvasOperationOptions,
+  ): Promise<void>;
+  dispatchMouse(
+    inputArg: ILiveBrowserMouseInput,
+    optionsArg: ILiveBrowserCanvasOperationOptions,
+  ): Promise<void>;
+  dispatchWheel(
+    inputArg: ILiveBrowserWheelInput,
+    optionsArg: ILiveBrowserCanvasOperationOptions,
+  ): Promise<void>;
+  dispatchKey(
+    inputArg: ILiveBrowserKeyInput,
+    optionsArg: ILiveBrowserCanvasOperationOptions,
+  ): Promise<void>;
+  insertText(
+    inputArg: ILiveBrowserInsertTextInput,
+    optionsArg: ILiveBrowserCanvasOperationOptions,
+  ): Promise<void>;
+}
+
+export interface ILiveBrowserCanvasOperationOptions {
+  /** Adapters must propagate this signal and reject promptly when it aborts. */
+  signal: AbortSignal;
 }
 
 export type TLiveBrowserCanvasErrorCode =