browserscale-ts 1.1.0 → 1.2.0

package/dist/gen/wrc_pb.d.ts

@@ -349,12 +349,95 @@ export type WaitResult = Message<"browserscale.v1.WaitResult"> & {
      * @generated from field: browserscale.v1.Rect bounds = 5;
      */
     bounds?: Rect;
+    /**
+     * Present iff no condition matched before the deadline (index is -1): the
+     * per-condition breakdown of why nothing matched. A timeout is a normal
+     * result, not an RPC error.
+     *
+     * @generated from field: optional browserscale.v1.WaitError error = 6;
+     */
+    error?: WaitError;
 };
 /**
  * Describes the message browserscale.v1.WaitResult.
  * Use `create(WaitResultSchema)` to create a new message.
  */
 export declare const WaitResultSchema: GenMessage<WaitResult>;
+/**
+ * Per-condition diagnostic status returned inside WaitError when WaitForAny
+ * times out; one entry per input condition, in the same order.
+ *
+ * @generated from message browserscale.v1.WaitConditionStatus
+ */
+export type WaitConditionStatus = Message<"browserscale.v1.WaitConditionStatus"> & {
+    /**
+     * @generated from field: int32 index = 1;
+     */
+    index: number;
+    /**
+     * "not_found" | "found_hidden" | "found_occluded" | "pending_steady".
+     *
+     * @generated from field: string state = 2;
+     */
+    state: string;
+    /**
+     * @generated from field: int32 backend_node_id = 3;
+     */
+    backendNodeId: number;
+    /**
+     * @generated from field: string frame_id = 4;
+     */
+    frameId: string;
+    /**
+     * @generated from field: bool is_visible = 5;
+     */
+    isVisible: boolean;
+    /**
+     * @generated from field: optional browserscale.v1.Rect bounds = 6;
+     */
+    bounds?: Rect;
+    /**
+     * The intercepting element, present iff state == "found_occluded".
+     *
+     * @generated from field: optional browserscale.v1.OccluderInfo occluder = 7;
+     */
+    occluder?: OccluderInfo;
+};
+/**
+ * Describes the message browserscale.v1.WaitConditionStatus.
+ * Use `create(WaitConditionStatusSchema)` to create a new message.
+ */
+export declare const WaitConditionStatusSchema: GenMessage<WaitConditionStatus>;
+/**
+ * Error detail for WaitForAny. Present in WaitResult iff no condition matched
+ * before the deadline. Same per-command WRCError<Command> convention as
+ * ClickError, plus a per-condition breakdown.
+ *
+ * @generated from message browserscale.v1.WaitError
+ */
+export type WaitError = Message<"browserscale.v1.WaitError"> & {
+    /**
+     * Machine-stable failure code. Currently always "timeout".
+     *
+     * @generated from field: string code = 1;
+     */
+    code: string;
+    /**
+     * @generated from field: string message = 2;
+     */
+    message: string;
+    /**
+     * Per-condition status, same order/length as the input conditions.
+     *
+     * @generated from field: repeated browserscale.v1.WaitConditionStatus conditions = 3;
+     */
+    conditions: WaitConditionStatus[];
+};
+/**
+ * Describes the message browserscale.v1.WaitError.
+ * Use `create(WaitErrorSchema)` to create a new message.
+ */
+export declare const WaitErrorSchema: GenMessage<WaitError>;
 /**
  * @generated from message browserscale.v1.ElementResult
  */
@@ -393,6 +476,238 @@ export type ElementResult = Message<"browserscale.v1.ElementResult"> & {
  * Use `create(ElementResultSchema)` to create a new message.
  */
 export declare const ElementResultSchema: GenMessage<ElementResult>;
+/**
+ * Describes the element that intercepted a click — the element sitting on top
+ * of the target at the intended click point. Coordinates are root-viewport CSS
+ * pixels, consistent with ClickResult.bounds.
+ *
+ * @generated from message browserscale.v1.OccluderInfo
+ */
+export type OccluderInfo = Message<"browserscale.v1.OccluderInfo"> & {
+    /**
+     * @generated from field: int32 backend_node_id = 1;
+     */
+    backendNodeId: number;
+    /**
+     * @generated from field: string frame_id = 2;
+     */
+    frameId: string;
+    /**
+     * @generated from field: string tag_name = 3;
+     */
+    tagName: string;
+    /**
+     * @generated from field: optional string id = 4;
+     */
+    id?: string;
+    /**
+     * @generated from field: optional string class_name = 5;
+     */
+    className?: string;
+    /**
+     * @generated from field: optional string text = 6;
+     */
+    text?: string;
+    /**
+     * @generated from field: browserscale.v1.Rect bounds = 7;
+     */
+    bounds?: Rect;
+    /**
+     * Computed pointer-events keyword (e.g. "auto", "none", "all"). Lets the
+     * caller tell an invisible pass-through layer from one that genuinely
+     * swallows clicks.
+     *
+     * @generated from field: optional string pointer_events = 8;
+     */
+    pointerEvents?: string;
+    /**
+     * Computed visibility keyword ("visible", "hidden", "collapse").
+     *
+     * @generated from field: optional string visibility = 9;
+     */
+    visibility?: string;
+    /**
+     * Computed opacity (0..1). 0 means visually invisible but may still
+     * intercept clicks depending on pointer_events.
+     *
+     * @generated from field: optional double opacity = 10;
+     */
+    opacity?: number;
+    /**
+     * Computed effective z-index as a string ("0" when auto/not stacked).
+     *
+     * @generated from field: optional string z_index = 11;
+     */
+    zIndex?: string;
+    /**
+     * True when this element can intercept clicks even while invisible (computed
+     * pointer-events in {all, painted, fill, stroke}); i.e. a real click here is
+     * swallowed even at visibility:hidden / opacity:0. When false and invisible,
+     * a real click would fall through.
+     *
+     * @generated from field: optional bool hittable_while_invisible = 12;
+     */
+    hittableWhileInvisible?: boolean;
+};
+/**
+ * Describes the message browserscale.v1.OccluderInfo.
+ * Use `create(OccluderInfoSchema)` to create a new message.
+ */
+export declare const OccluderInfoSchema: GenMessage<OccluderInfo>;
+/**
+ * Error detail for a Click that did not land. Present in ClickResult iff
+ * success is false. First instance of the per-command WRCError<Command>
+ * convention; other commands migrate to the same shape later.
+ *
+ * @generated from message browserscale.v1.ClickError
+ */
+export type ClickError = Message<"browserscale.v1.ClickError"> & {
+    /**
+     * Machine-stable failure code, e.g. "occluded_no_reachable_point" or
+     * "occluded_after_evade".
+     *
+     * @generated from field: string code = 1;
+     */
+    code: string;
+    /**
+     * @generated from field: string message = 2;
+     */
+    message: string;
+    /**
+     * The intercepting element (present for occlusion codes).
+     *
+     * @generated from field: optional browserscale.v1.OccluderInfo occluder = 3;
+     */
+    occluder?: OccluderInfo;
+    /**
+     * Whether a pointer reposition/evade was attempted before giving up.
+     *
+     * @generated from field: optional bool evade_attempted = 4;
+     */
+    evadeAttempted?: boolean;
+};
+/**
+ * Describes the message browserscale.v1.ClickError.
+ * Use `create(ClickErrorSchema)` to create a new message.
+ */
+export declare const ClickErrorSchema: GenMessage<ClickError>;
+/**
+ * ClickResult mirrors ElementResult (field numbers 1-7 kept identical, so it is
+ * wire-compatible) plus an optional error describing why the click did not land
+ * when success is false. A failed click is a normal response, not an RPC error.
+ *
+ * @generated from message browserscale.v1.ClickResult
+ */
+export type ClickResult = Message<"browserscale.v1.ClickResult"> & {
+    /**
+     * @generated from field: bool success = 1;
+     */
+    success: boolean;
+    /**
+     * @generated from field: string frame_id = 2;
+     */
+    frameId: string;
+    /**
+     * @generated from field: int32 backend_node_id = 3;
+     */
+    backendNodeId: number;
+    /**
+     * @generated from field: bool is_visible = 4;
+     */
+    isVisible: boolean;
+    /**
+     * @generated from field: browserscale.v1.Rect bounds = 5;
+     */
+    bounds?: Rect;
+    /**
+     * @generated from field: double root_x = 6;
+     */
+    rootX: number;
+    /**
+     * @generated from field: double root_y = 7;
+     */
+    rootY: number;
+    /**
+     * @generated from field: optional browserscale.v1.ClickError error = 8;
+     */
+    error?: ClickError;
+};
+/**
+ * Describes the message browserscale.v1.ClickResult.
+ * Use `create(ClickResultSchema)` to create a new message.
+ */
+export declare const ClickResultSchema: GenMessage<ClickResult>;
+/**
+ * Error detail for a Fill that did not complete. Present in FillResult iff
+ * success is false. Fill focuses the field with the exact same smart click as
+ * Click, so any pre-typing failure is a click failure: code/message mirror it
+ * and the full click diagnostics are nested under click_error.
+ *
+ * @generated from message browserscale.v1.FillError
+ */
+export type FillError = Message<"browserscale.v1.FillError"> & {
+    /**
+     * Mirrored from the underlying click failure: "not_found",
+     * "occluded_no_reachable_point" or "occluded_after_evade".
+     *
+     * @generated from field: string code = 1;
+     */
+    code: string;
+    /**
+     * @generated from field: string message = 2;
+     */
+    message: string;
+    /**
+     * The underlying click-core failure that prevented focusing/typing.
+     *
+     * @generated from field: optional browserscale.v1.ClickError click_error = 3;
+     */
+    clickError?: ClickError;
+};
+/**
+ * Describes the message browserscale.v1.FillError.
+ * Use `create(FillErrorSchema)` to create a new message.
+ */
+export declare const FillErrorSchema: GenMessage<FillError>;
+/**
+ * FillResult mirrors the fill return: the success payload plus an optional error
+ * when the field could not be focused/typed. Field numbers 1-3/6-7 match
+ * ElementResult so it stays wire-compatible; is_visible/bounds are not part of
+ * fill's contract.
+ *
+ * @generated from message browserscale.v1.FillResult
+ */
+export type FillResult = Message<"browserscale.v1.FillResult"> & {
+    /**
+     * @generated from field: bool success = 1;
+     */
+    success: boolean;
+    /**
+     * @generated from field: string frame_id = 2;
+     */
+    frameId: string;
+    /**
+     * @generated from field: int32 backend_node_id = 3;
+     */
+    backendNodeId: number;
+    /**
+     * @generated from field: double root_x = 6;
+     */
+    rootX: number;
+    /**
+     * @generated from field: double root_y = 7;
+     */
+    rootY: number;
+    /**
+     * @generated from field: optional browserscale.v1.FillError error = 8;
+     */
+    error?: FillError;
+};
+/**
+ * Describes the message browserscale.v1.FillResult.
+ * Use `create(FillResultSchema)` to create a new message.
+ */
+export declare const FillResultSchema: GenMessage<FillResult>;
 /**
  * @generated from message browserscale.v1.DragResult
  */
@@ -425,12 +740,43 @@ export type DragResult = Message<"browserscale.v1.DragResult"> & {
      * @generated from field: double end_y = 7;
      */
     endY: number;
+    /**
+     * @generated from field: optional browserscale.v1.DragError error = 8;
+     */
+    error?: DragError;
 };
 /**
  * Describes the message browserscale.v1.DragResult.
  * Use `create(DragResultSchema)` to create a new message.
  */
 export declare const DragResultSchema: GenMessage<DragResult>;
+/**
+ * Error detail for a Drag whose source pickup failed. Present in DragResult iff
+ * success is false. Drag acquires+presses the source with the same smart click
+ * as Click, so a pre-drag failure is a click failure: code/message mirror it
+ * and the full click diagnostics are nested under click_error.
+ *
+ * @generated from message browserscale.v1.DragError
+ */
+export type DragError = Message<"browserscale.v1.DragError"> & {
+    /**
+     * @generated from field: string code = 1;
+     */
+    code: string;
+    /**
+     * @generated from field: string message = 2;
+     */
+    message: string;
+    /**
+     * @generated from field: optional browserscale.v1.ClickError click_error = 3;
+     */
+    clickError?: ClickError;
+};
+/**
+ * Describes the message browserscale.v1.DragError.
+ * Use `create(DragErrorSchema)` to create a new message.
+ */
+export declare const DragErrorSchema: GenMessage<DragError>;
 /**
  * @generated from message browserscale.v1.SelectOptionResult
  */
@@ -447,12 +793,176 @@ export type SelectOptionResult = Message<"browserscale.v1.SelectOptionResult"> &
      * @generated from field: string selected_text = 3;
      */
     selectedText: string;
+    /**
+     * @generated from field: bool success = 4;
+     */
+    success: boolean;
+    /**
+     * @generated from field: optional browserscale.v1.SelectOptionError error = 5;
+     */
+    error?: SelectOptionError;
 };
 /**
  * Describes the message browserscale.v1.SelectOptionResult.
  * Use `create(SelectOptionResultSchema)` to create a new message.
  */
 export declare const SelectOptionResultSchema: GenMessage<SelectOptionResult>;
+/**
+ * Error detail for a SelectOption that failed. Present iff success is false.
+ * selectOption is programmatic (no pointer gate), so it only reports semantic
+ * failures.
+ *
+ * @generated from message browserscale.v1.SelectOptionError
+ */
+export type SelectOptionError = Message<"browserscale.v1.SelectOptionError"> & {
+    /**
+     * "not_found" (the <select> was not located) or "option_not_found" (no option
+     * matched the requested index/value/text).
+     *
+     * @generated from field: string code = 1;
+     */
+    code: string;
+    /**
+     * @generated from field: string message = 2;
+     */
+    message: string;
+};
+/**
+ * Describes the message browserscale.v1.SelectOptionError.
+ * Use `create(SelectOptionErrorSchema)` to create a new message.
+ */
+export declare const SelectOptionErrorSchema: GenMessage<SelectOptionError>;
+/**
+ * ScrollResult mirrors the scrollTo return: the success payload plus an optional
+ * error when the target could not be located/scrolled. Field numbers 1-5 match
+ * ElementResult so it stays wire-compatible; scrollTo returns no root_x/root_y.
+ *
+ * @generated from message browserscale.v1.ScrollResult
+ */
+export type ScrollResult = Message<"browserscale.v1.ScrollResult"> & {
+    /**
+     * @generated from field: bool success = 1;
+     */
+    success: boolean;
+    /**
+     * @generated from field: string frame_id = 2;
+     */
+    frameId: string;
+    /**
+     * @generated from field: int32 backend_node_id = 3;
+     */
+    backendNodeId: number;
+    /**
+     * @generated from field: bool is_visible = 4;
+     */
+    isVisible: boolean;
+    /**
+     * @generated from field: browserscale.v1.Rect bounds = 5;
+     */
+    bounds?: Rect;
+    /**
+     * @generated from field: optional browserscale.v1.ScrollError error = 8;
+     */
+    error?: ScrollError;
+};
+/**
+ * Describes the message browserscale.v1.ScrollResult.
+ * Use `create(ScrollResultSchema)` to create a new message.
+ */
+export declare const ScrollResultSchema: GenMessage<ScrollResult>;
+/**
+ * Error detail for a ScrollTo that failed. Present iff success is false; the
+ * only semantic failure is the target not being locatable/scrollable.
+ *
+ * @generated from message browserscale.v1.ScrollError
+ */
+export type ScrollError = Message<"browserscale.v1.ScrollError"> & {
+    /**
+     * Currently always "not_found".
+     *
+     * @generated from field: string code = 1;
+     */
+    code: string;
+    /**
+     * @generated from field: string message = 2;
+     */
+    message: string;
+};
+/**
+ * Describes the message browserscale.v1.ScrollError.
+ * Use `create(ScrollErrorSchema)` to create a new message.
+ */
+export declare const ScrollErrorSchema: GenMessage<ScrollError>;
+/**
+ * MoveResult mirrors the moveTo return: the success payload plus an optional
+ * error when the target could not be located. Field numbers 1-7 match
+ * ElementResult so it stays wire-compatible.
+ *
+ * @generated from message browserscale.v1.MoveResult
+ */
+export type MoveResult = Message<"browserscale.v1.MoveResult"> & {
+    /**
+     * @generated from field: bool success = 1;
+     */
+    success: boolean;
+    /**
+     * @generated from field: string frame_id = 2;
+     */
+    frameId: string;
+    /**
+     * @generated from field: int32 backend_node_id = 3;
+     */
+    backendNodeId: number;
+    /**
+     * @generated from field: bool is_visible = 4;
+     */
+    isVisible: boolean;
+    /**
+     * @generated from field: browserscale.v1.Rect bounds = 5;
+     */
+    bounds?: Rect;
+    /**
+     * @generated from field: double root_x = 6;
+     */
+    rootX: number;
+    /**
+     * @generated from field: double root_y = 7;
+     */
+    rootY: number;
+    /**
+     * @generated from field: optional browserscale.v1.MoveError error = 8;
+     */
+    error?: MoveError;
+};
+/**
+ * Describes the message browserscale.v1.MoveResult.
+ * Use `create(MoveResultSchema)` to create a new message.
+ */
+export declare const MoveResultSchema: GenMessage<MoveResult>;
+/**
+ * Error detail for a MoveTo that failed. Present iff success is false; a move
+ * has no occlusion notion, so the only failure is the target not being
+ * locatable.
+ *
+ * @generated from message browserscale.v1.MoveError
+ */
+export type MoveError = Message<"browserscale.v1.MoveError"> & {
+    /**
+     * Currently always "not_found".
+     *
+     * @generated from field: string code = 1;
+     */
+    code: string;
+    /**
+     * @generated from field: string message = 2;
+     */
+    message: string;
+};
+/**
+ * Describes the message browserscale.v1.MoveError.
+ * Use `create(MoveErrorSchema)` to create a new message.
+ */
+export declare const MoveErrorSchema: GenMessage<MoveError>;
 /**
  * @generated from message browserscale.v1.SetProxyRequest
  */
@@ -674,6 +1184,62 @@ export type EvaluateResponse = Message<"browserscale.v1.EvaluateResponse"> & {
  * Use `create(EvaluateResponseSchema)` to create a new message.
  */
 export declare const EvaluateResponseSchema: GenMessage<EvaluateResponse>;
+/**
+ * Run executes a JavaScript automation script inside the God-VM — a bare V8
+ * isolate that lives outside every renderer.
+ *
+ * @generated from message browserscale.v1.RunRequest
+ */
+export type RunRequest = Message<"browserscale.v1.RunRequest"> & {
+    /**
+     * @generated from field: string session_id = 1;
+     */
+    sessionId: string;
+    /**
+     * @generated from field: string api_key = 2;
+     */
+    apiKey: string;
+    /**
+     * JavaScript source to execute in the God-VM.
+     *
+     * @generated from field: string source = 3;
+     */
+    source: string;
+    /**
+     * Page the script should be able to drive (reserved; frame bridge wired in a
+     * follow-up). Optional for now — ignored server-side.
+     *
+     * @generated from field: optional string page_id = 4;
+     */
+    pageId?: string;
+};
+/**
+ * Describes the message browserscale.v1.RunRequest.
+ * Use `create(RunRequestSchema)` to create a new message.
+ */
+export declare const RunRequestSchema: GenMessage<RunRequest>;
+/**
+ * @generated from message browserscale.v1.RunResponse
+ */
+export type RunResponse = Message<"browserscale.v1.RunResponse"> & {
+    /**
+     * False if compilation or execution threw; then `result` holds the message.
+     *
+     * @generated from field: bool success = 1;
+     */
+    success: boolean;
+    /**
+     * JSON-serialized result value (or "undefined"), or the error message.
+     *
+     * @generated from field: string result = 2;
+     */
+    result: string;
+};
+/**
+ * Describes the message browserscale.v1.RunResponse.
+ * Use `create(RunResponseSchema)` to create a new message.
+ */
+export declare const RunResponseSchema: GenMessage<RunResponse>;
 /**
  * Note: named "WaitForAnyParams" instead of "WaitForAnyRequest" to avoid
  * colliding with the rpc method name "WaitForAnyRequest" (network intercept).
@@ -2143,6 +2709,14 @@ export declare const Browser: GenService<{
         input: typeof EvaluateRequestSchema;
         output: typeof EvaluateResponseSchema;
     };
+    /**
+     * @generated from rpc browserscale.v1.Browser.Run
+     */
+    run: {
+        methodKind: "unary";
+        input: typeof RunRequestSchema;
+        output: typeof RunResponseSchema;
+    };
     /**
      * Waiting
      *
@@ -2169,7 +2743,7 @@ export declare const Browser: GenService<{
     scrollTo: {
         methodKind: "unary";
         input: typeof ScrollToRequestSchema;
-        output: typeof ElementResultSchema;
+        output: typeof ScrollResultSchema;
     };
     /**
      * @generated from rpc browserscale.v1.Browser.MoveTo
@@ -2177,7 +2751,7 @@ export declare const Browser: GenService<{
     moveTo: {
         methodKind: "unary";
         input: typeof MoveToRequestSchema;
-        output: typeof ElementResultSchema;
+        output: typeof MoveResultSchema;
     };
     /**
      * @generated from rpc browserscale.v1.Browser.Click
@@ -2185,7 +2759,7 @@ export declare const Browser: GenService<{
     click: {
         methodKind: "unary";
         input: typeof ClickRequestSchema;
-        output: typeof ElementResultSchema;
+        output: typeof ClickResultSchema;
     };
     /**
      * @generated from rpc browserscale.v1.Browser.Drag
@@ -2201,7 +2775,7 @@ export declare const Browser: GenService<{
     fill: {
         methodKind: "unary";
         input: typeof FillRequestSchema;
-        output: typeof ElementResultSchema;
+        output: typeof FillResultSchema;
     };
     /**
      * Network interception