effect-agent 0.1.0-beta.153 → 0.1.0-beta.154

package/dist/capabilities/BrowserUse.d.mts

@@ -0,0 +1,545 @@
+import { DecisionModel, Tool, Toolkit } from "effect/unstable/ai";
+import { Context, Effect, Schema } from "effect";
+declare namespace BrowserUse_d_exports {
+  export { Action, ActionResult, BrowserActions, BrowserUseError, LayerOptions, Observation, Options, TargetAction, make, selectTargets };
+}
+export declare const Action: Schema.Union<readonly [Schema.Struct<{
+  readonly kind: Schema.Literal<"click">;
+  readonly ref: Schema.String;
+}>, Schema.Struct<{
+  readonly kind: Schema.Literal<"fill">;
+  readonly ref: Schema.String;
+  readonly value: Schema.String;
+}>, Schema.Struct<{
+  readonly kind: Schema.Literal<"select">;
+  readonly ref: Schema.String;
+  readonly value: Schema.String;
+}>]>;
+export type Action = typeof Action.Type;
+export declare const Observation: Schema.Struct<{
+  readonly text: Schema.String;
+  readonly controls: Schema.$Array<Schema.Struct<{
+    readonly ref: Schema.String;
+    readonly kind: Schema.String;
+    readonly name: Schema.String;
+    readonly value: Schema.String;
+    readonly options: Schema.$Array<Schema.String>;
+  }>>;
+}>;
+export declare const ActionResult: Schema.Struct<{
+  readonly completed: Schema.Natural;
+  readonly error: Schema.NullOr<Schema.String>;
+  readonly observation: Schema.NullOr<Schema.Struct<{
+    readonly text: Schema.String;
+    readonly controls: Schema.$Array<Schema.Struct<{
+      readonly ref: Schema.String;
+      readonly kind: Schema.String;
+      readonly name: Schema.String;
+      readonly value: Schema.String;
+      readonly options: Schema.$Array<Schema.String>;
+    }>>;
+  }>>;
+}>;
+export declare const TargetAction: Schema.Union<readonly [Schema.Struct<{
+  readonly kind: Schema.Literal<"click">;
+  readonly target: Schema.NonEmptyString;
+}>, Schema.Struct<{
+  readonly kind: Schema.Literal<"fill">;
+  readonly target: Schema.NonEmptyString;
+  readonly value: Schema.String;
+}>, Schema.Struct<{
+  readonly kind: Schema.Literal<"select">;
+  readonly target: Schema.NonEmptyString;
+  readonly value: Schema.String;
+}>]>;
+export type TargetAction = typeof TargetAction.Type;
+declare const BrowserUseError_base: Schema.Class<BrowserUseError, Schema.TaggedStruct<"BrowserUseError", {
+  readonly code: Schema.Literals<readonly ["invalid", "browser"]>;
+  readonly message: Schema.String;
+}>, import("effect/Cause").YieldableError>;
+/** Safe model-visible failure. Dispatch evidence belongs in ActionResult, never an automatic retry. */
+export declare class BrowserUseError extends BrowserUseError_base {}
+declare const BrowserActions_base: Context.ServiceClass<BrowserActions, "@effect-agent/BrowserUse/BrowserActions", {
+  readonly observe: Effect.Effect<typeof Observation.Type, BrowserUseError>;
+  readonly act: (actions: ReadonlyArray<Action>) => Effect.Effect<typeof ActionResult.Type, BrowserUseError>;
+}>;
+/** Application-owned page adapter. Revalidate refs before input; stop a batch at its first failure.
+ * Return acknowledged actions even if the following observation fails. Never replay uncertain input.
+ */
+export declare class BrowserActions extends BrowserActions_base {}
+/** A DecisionModel selects from observed, action-compatible controls. It cannot create selectors or dispatch actions. */
+export declare const selectTargets: (observation: {
+  readonly text: string;
+  readonly controls: readonly {
+    readonly ref: string;
+    readonly kind: string;
+    readonly name: string;
+    readonly value: string;
+    readonly options: readonly string[];
+  }[];
+}, targets: readonly ({
+  readonly kind: "click";
+  readonly target: string;
+} | {
+  readonly kind: "fill";
+  readonly target: string;
+  readonly value: string;
+} | {
+  readonly kind: "select";
+  readonly target: string;
+  readonly value: string;
+})[]) => Effect.Effect<{
+  actions: ({
+    readonly kind: "click";
+    readonly ref: string;
+  } | {
+    readonly kind: "fill";
+    readonly ref: string;
+    readonly value: string;
+  } | {
+    readonly kind: "select";
+    readonly ref: string;
+    readonly value: string;
+  })[];
+  choices: {
+    target: string;
+    ref: string;
+    probability: number;
+  }[];
+  usage: DecisionModel.DecisionUsage;
+}, BrowserUseError, DecisionModel.DecisionModel>;
+export interface Options {
+  /** Who resolves controls: the planner supplies refs by default; "decision" uses a native DecisionModel. */
+  readonly grounding?: "direct" | "decision";
+  /** One action by default; "batched" accepts 1–8 actions on already observed controls. */
+  readonly mode?: "single" | "batched";
+}
+export interface LayerOptions {
+  /** Already prepared observation from this page/run. Omit to observe before the first selection. */
+  readonly initialObservation?: typeof Observation.Type;
+}
+declare const single: {
+  toolkit: Toolkit.Toolkit<{
+    readonly act: Tool.Tool<"act", {
+      readonly parameters: Schema.Struct<{
+        readonly action: Schema.Union<readonly [Schema.Struct<{
+          readonly kind: Schema.Literal<"click">;
+          readonly ref: Schema.String;
+        }>, Schema.Struct<{
+          readonly kind: Schema.Literal<"fill">;
+          readonly ref: Schema.String;
+          readonly value: Schema.String;
+        }>, Schema.Struct<{
+          readonly kind: Schema.Literal<"select">;
+          readonly ref: Schema.String;
+          readonly value: Schema.String;
+        }>]>;
+      }>;
+      readonly success: Schema.Struct<{
+        readonly completed: Schema.Natural;
+        readonly error: Schema.NullOr<Schema.String>;
+        readonly observation: Schema.NullOr<Schema.Struct<{
+          readonly text: Schema.String;
+          readonly controls: Schema.$Array<Schema.Struct<{
+            readonly ref: Schema.String;
+            readonly kind: Schema.String;
+            readonly name: Schema.String;
+            readonly value: Schema.String;
+            readonly options: Schema.$Array<Schema.String>;
+          }>>;
+        }>>;
+      }>;
+      readonly failure: typeof BrowserUseError;
+      readonly failureMode: "return";
+    }, never>;
+    readonly observe: Tool.Tool<"observe", {
+      readonly parameters: Tool.EmptyParams;
+      readonly success: Schema.Struct<{
+        readonly text: Schema.String;
+        readonly controls: Schema.$Array<Schema.Struct<{
+          readonly ref: Schema.String;
+          readonly kind: Schema.String;
+          readonly name: Schema.String;
+          readonly value: Schema.String;
+          readonly options: Schema.$Array<Schema.String>;
+        }>>;
+      }>;
+      readonly failure: typeof BrowserUseError;
+      readonly failureMode: "return";
+    }, never>;
+  }>;
+  layer: () => import("effect/Layer").Layer<Tool.HandlersFor<{
+    readonly act: Tool.Tool<"act", {
+      readonly parameters: Schema.Struct<{
+        readonly action: Schema.Union<readonly [Schema.Struct<{
+          readonly kind: Schema.Literal<"click">;
+          readonly ref: Schema.String;
+        }>, Schema.Struct<{
+          readonly kind: Schema.Literal<"fill">;
+          readonly ref: Schema.String;
+          readonly value: Schema.String;
+        }>, Schema.Struct<{
+          readonly kind: Schema.Literal<"select">;
+          readonly ref: Schema.String;
+          readonly value: Schema.String;
+        }>]>;
+      }>;
+      readonly success: Schema.Struct<{
+        readonly completed: Schema.Natural;
+        readonly error: Schema.NullOr<Schema.String>;
+        readonly observation: Schema.NullOr<Schema.Struct<{
+          readonly text: Schema.String;
+          readonly controls: Schema.$Array<Schema.Struct<{
+            readonly ref: Schema.String;
+            readonly kind: Schema.String;
+            readonly name: Schema.String;
+            readonly value: Schema.String;
+            readonly options: Schema.$Array<Schema.String>;
+          }>>;
+        }>>;
+      }>;
+      readonly failure: typeof BrowserUseError;
+      readonly failureMode: "return";
+    }, never>;
+    readonly observe: Tool.Tool<"observe", {
+      readonly parameters: Tool.EmptyParams;
+      readonly success: Schema.Struct<{
+        readonly text: Schema.String;
+        readonly controls: Schema.$Array<Schema.Struct<{
+          readonly ref: Schema.String;
+          readonly kind: Schema.String;
+          readonly name: Schema.String;
+          readonly value: Schema.String;
+          readonly options: Schema.$Array<Schema.String>;
+        }>>;
+      }>;
+      readonly failure: typeof BrowserUseError;
+      readonly failureMode: "return";
+    }, never>;
+  }>, never, BrowserActions>;
+};
+declare const batched: {
+  toolkit: Toolkit.Toolkit<{
+    readonly act: Tool.Tool<"act", {
+      readonly parameters: Schema.Struct<{
+        readonly actions: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+          readonly kind: Schema.Literal<"click">;
+          readonly ref: Schema.String;
+        }>, Schema.Struct<{
+          readonly kind: Schema.Literal<"fill">;
+          readonly ref: Schema.String;
+          readonly value: Schema.String;
+        }>, Schema.Struct<{
+          readonly kind: Schema.Literal<"select">;
+          readonly ref: Schema.String;
+          readonly value: Schema.String;
+        }>]>>;
+      }>;
+      readonly success: Schema.Struct<{
+        readonly completed: Schema.Natural;
+        readonly error: Schema.NullOr<Schema.String>;
+        readonly observation: Schema.NullOr<Schema.Struct<{
+          readonly text: Schema.String;
+          readonly controls: Schema.$Array<Schema.Struct<{
+            readonly ref: Schema.String;
+            readonly kind: Schema.String;
+            readonly name: Schema.String;
+            readonly value: Schema.String;
+            readonly options: Schema.$Array<Schema.String>;
+          }>>;
+        }>>;
+      }>;
+      readonly failure: typeof BrowserUseError;
+      readonly failureMode: "return";
+    }, never>;
+    readonly observe: Tool.Tool<"observe", {
+      readonly parameters: Tool.EmptyParams;
+      readonly success: Schema.Struct<{
+        readonly text: Schema.String;
+        readonly controls: Schema.$Array<Schema.Struct<{
+          readonly ref: Schema.String;
+          readonly kind: Schema.String;
+          readonly name: Schema.String;
+          readonly value: Schema.String;
+          readonly options: Schema.$Array<Schema.String>;
+        }>>;
+      }>;
+      readonly failure: typeof BrowserUseError;
+      readonly failureMode: "return";
+    }, never>;
+  }>;
+  layer: () => import("effect/Layer").Layer<Tool.HandlersFor<{
+    readonly act: Tool.Tool<"act", {
+      readonly parameters: Schema.Struct<{
+        readonly actions: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+          readonly kind: Schema.Literal<"click">;
+          readonly ref: Schema.String;
+        }>, Schema.Struct<{
+          readonly kind: Schema.Literal<"fill">;
+          readonly ref: Schema.String;
+          readonly value: Schema.String;
+        }>, Schema.Struct<{
+          readonly kind: Schema.Literal<"select">;
+          readonly ref: Schema.String;
+          readonly value: Schema.String;
+        }>]>>;
+      }>;
+      readonly success: Schema.Struct<{
+        readonly completed: Schema.Natural;
+        readonly error: Schema.NullOr<Schema.String>;
+        readonly observation: Schema.NullOr<Schema.Struct<{
+          readonly text: Schema.String;
+          readonly controls: Schema.$Array<Schema.Struct<{
+            readonly ref: Schema.String;
+            readonly kind: Schema.String;
+            readonly name: Schema.String;
+            readonly value: Schema.String;
+            readonly options: Schema.$Array<Schema.String>;
+          }>>;
+        }>>;
+      }>;
+      readonly failure: typeof BrowserUseError;
+      readonly failureMode: "return";
+    }, never>;
+    readonly observe: Tool.Tool<"observe", {
+      readonly parameters: Tool.EmptyParams;
+      readonly success: Schema.Struct<{
+        readonly text: Schema.String;
+        readonly controls: Schema.$Array<Schema.Struct<{
+          readonly ref: Schema.String;
+          readonly kind: Schema.String;
+          readonly name: Schema.String;
+          readonly value: Schema.String;
+          readonly options: Schema.$Array<Schema.String>;
+        }>>;
+      }>;
+      readonly failure: typeof BrowserUseError;
+      readonly failureMode: "return";
+    }, never>;
+  }>, never, BrowserActions>;
+};
+declare const groundedSingle: {
+  toolkit: Toolkit.Toolkit<{
+    readonly act: Tool.Tool<"act", {
+      readonly parameters: Schema.Struct<{
+        readonly action: Schema.Union<readonly [Schema.Struct<{
+          readonly kind: Schema.Literal<"click">;
+          readonly target: Schema.NonEmptyString;
+        }>, Schema.Struct<{
+          readonly kind: Schema.Literal<"fill">;
+          readonly target: Schema.NonEmptyString;
+          readonly value: Schema.String;
+        }>, Schema.Struct<{
+          readonly kind: Schema.Literal<"select">;
+          readonly target: Schema.NonEmptyString;
+          readonly value: Schema.String;
+        }>]>;
+      }>;
+      readonly success: Schema.Struct<{
+        readonly completed: Schema.Natural;
+        readonly error: Schema.NullOr<Schema.String>;
+        readonly observation: Schema.NullOr<Schema.Struct<{
+          readonly text: Schema.String;
+          readonly controls: Schema.$Array<Schema.Struct<{
+            readonly ref: Schema.String;
+            readonly kind: Schema.String;
+            readonly name: Schema.String;
+            readonly value: Schema.String;
+            readonly options: Schema.$Array<Schema.String>;
+          }>>;
+        }>>;
+      }>;
+      readonly failure: typeof BrowserUseError;
+      readonly failureMode: "return";
+    }, never>;
+    readonly observe: Tool.Tool<"observe", {
+      readonly parameters: Tool.EmptyParams;
+      readonly success: Schema.Struct<{
+        readonly text: Schema.String;
+        readonly controls: Schema.$Array<Schema.Struct<{
+          readonly ref: Schema.String;
+          readonly kind: Schema.String;
+          readonly name: Schema.String;
+          readonly value: Schema.String;
+          readonly options: Schema.$Array<Schema.String>;
+        }>>;
+      }>;
+      readonly failure: typeof BrowserUseError;
+      readonly failureMode: "return";
+    }, never>;
+  }>;
+  layer: (options?: LayerOptions) => import("effect/Layer").Layer<Tool.HandlersFor<{
+    readonly act: Tool.Tool<"act", {
+      readonly parameters: Schema.Struct<{
+        readonly action: Schema.Union<readonly [Schema.Struct<{
+          readonly kind: Schema.Literal<"click">;
+          readonly target: Schema.NonEmptyString;
+        }>, Schema.Struct<{
+          readonly kind: Schema.Literal<"fill">;
+          readonly target: Schema.NonEmptyString;
+          readonly value: Schema.String;
+        }>, Schema.Struct<{
+          readonly kind: Schema.Literal<"select">;
+          readonly target: Schema.NonEmptyString;
+          readonly value: Schema.String;
+        }>]>;
+      }>;
+      readonly success: Schema.Struct<{
+        readonly completed: Schema.Natural;
+        readonly error: Schema.NullOr<Schema.String>;
+        readonly observation: Schema.NullOr<Schema.Struct<{
+          readonly text: Schema.String;
+          readonly controls: Schema.$Array<Schema.Struct<{
+            readonly ref: Schema.String;
+            readonly kind: Schema.String;
+            readonly name: Schema.String;
+            readonly value: Schema.String;
+            readonly options: Schema.$Array<Schema.String>;
+          }>>;
+        }>>;
+      }>;
+      readonly failure: typeof BrowserUseError;
+      readonly failureMode: "return";
+    }, never>;
+    readonly observe: Tool.Tool<"observe", {
+      readonly parameters: Tool.EmptyParams;
+      readonly success: Schema.Struct<{
+        readonly text: Schema.String;
+        readonly controls: Schema.$Array<Schema.Struct<{
+          readonly ref: Schema.String;
+          readonly kind: Schema.String;
+          readonly name: Schema.String;
+          readonly value: Schema.String;
+          readonly options: Schema.$Array<Schema.String>;
+        }>>;
+      }>;
+      readonly failure: typeof BrowserUseError;
+      readonly failureMode: "return";
+    }, never>;
+  }>, never, BrowserActions | DecisionModel.DecisionModel>;
+};
+declare const groundedBatched: {
+  toolkit: Toolkit.Toolkit<{
+    readonly act: Tool.Tool<"act", {
+      readonly parameters: Schema.Struct<{
+        readonly actions: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+          readonly kind: Schema.Literal<"click">;
+          readonly target: Schema.NonEmptyString;
+        }>, Schema.Struct<{
+          readonly kind: Schema.Literal<"fill">;
+          readonly target: Schema.NonEmptyString;
+          readonly value: Schema.String;
+        }>, Schema.Struct<{
+          readonly kind: Schema.Literal<"select">;
+          readonly target: Schema.NonEmptyString;
+          readonly value: Schema.String;
+        }>]>>;
+      }>;
+      readonly success: Schema.Struct<{
+        readonly completed: Schema.Natural;
+        readonly error: Schema.NullOr<Schema.String>;
+        readonly observation: Schema.NullOr<Schema.Struct<{
+          readonly text: Schema.String;
+          readonly controls: Schema.$Array<Schema.Struct<{
+            readonly ref: Schema.String;
+            readonly kind: Schema.String;
+            readonly name: Schema.String;
+            readonly value: Schema.String;
+            readonly options: Schema.$Array<Schema.String>;
+          }>>;
+        }>>;
+      }>;
+      readonly failure: typeof BrowserUseError;
+      readonly failureMode: "return";
+    }, never>;
+    readonly observe: Tool.Tool<"observe", {
+      readonly parameters: Tool.EmptyParams;
+      readonly success: Schema.Struct<{
+        readonly text: Schema.String;
+        readonly controls: Schema.$Array<Schema.Struct<{
+          readonly ref: Schema.String;
+          readonly kind: Schema.String;
+          readonly name: Schema.String;
+          readonly value: Schema.String;
+          readonly options: Schema.$Array<Schema.String>;
+        }>>;
+      }>;
+      readonly failure: typeof BrowserUseError;
+      readonly failureMode: "return";
+    }, never>;
+  }>;
+  layer: (options?: LayerOptions) => import("effect/Layer").Layer<Tool.HandlersFor<{
+    readonly act: Tool.Tool<"act", {
+      readonly parameters: Schema.Struct<{
+        readonly actions: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+          readonly kind: Schema.Literal<"click">;
+          readonly target: Schema.NonEmptyString;
+        }>, Schema.Struct<{
+          readonly kind: Schema.Literal<"fill">;
+          readonly target: Schema.NonEmptyString;
+          readonly value: Schema.String;
+        }>, Schema.Struct<{
+          readonly kind: Schema.Literal<"select">;
+          readonly target: Schema.NonEmptyString;
+          readonly value: Schema.String;
+        }>]>>;
+      }>;
+      readonly success: Schema.Struct<{
+        readonly completed: Schema.Natural;
+        readonly error: Schema.NullOr<Schema.String>;
+        readonly observation: Schema.NullOr<Schema.Struct<{
+          readonly text: Schema.String;
+          readonly controls: Schema.$Array<Schema.Struct<{
+            readonly ref: Schema.String;
+            readonly kind: Schema.String;
+            readonly name: Schema.String;
+            readonly value: Schema.String;
+            readonly options: Schema.$Array<Schema.String>;
+          }>>;
+        }>>;
+      }>;
+      readonly failure: typeof BrowserUseError;
+      readonly failureMode: "return";
+    }, never>;
+    readonly observe: Tool.Tool<"observe", {
+      readonly parameters: Tool.EmptyParams;
+      readonly success: Schema.Struct<{
+        readonly text: Schema.String;
+        readonly controls: Schema.$Array<Schema.Struct<{
+          readonly ref: Schema.String;
+          readonly kind: Schema.String;
+          readonly name: Schema.String;
+          readonly value: Schema.String;
+          readonly options: Schema.$Array<Schema.String>;
+        }>>;
+      }>;
+      readonly failure: typeof BrowserUseError;
+      readonly failureMode: "return";
+    }, never>;
+  }>, never, BrowserActions | DecisionModel.DecisionModel>;
+};
+/**
+ * Define browser tools and their matching handlers together. Include `toolkit` in your Agent
+ * and provide `layer()` once per page/run. All modes require BrowserActions; decision grounding
+ * also requires a native DecisionModel. The library never chooses a provider or opens a browser.
+ */
+export declare function make(options: {
+  grounding: "decision";
+  mode: "batched";
+}): typeof groundedBatched;
+export declare function make(options: {
+  grounding: "decision";
+  mode?: "single";
+}): typeof groundedSingle;
+export declare function make(options: {
+  grounding?: "direct";
+  mode: "batched";
+}): typeof batched;
+export declare function make(options?: {
+  grounding?: "direct";
+  mode?: "single";
+}): typeof single;
+export declare function make(options: Options): typeof single | typeof batched | typeof groundedSingle | typeof groundedBatched;
+//#endregion
+export { BrowserUse_d_exports as t };
+//# sourceMappingURL=BrowserUse.d.mts.map