@namzu/sdk 44.3.0 → 45.1.0

package/dist/tools/builtins/browser.d.ts

@@ -0,0 +1,367 @@
+import { z } from 'zod';
+import type { BrowserHost, BrowserHostError, BrowserPageInfo } from '../../types/browser/index.js';
+import type { ToolDefinition } from '../../types/tool/index.js';
+export declare const BROWSER_TOOL_NAME: "browser";
+export declare const BROWSER_ACT_TOOL_NAME: "browser_act";
+declare const observeSchema: z.ZodEffects<z.ZodDiscriminatedUnion<"action", [z.ZodObject<{
+    action: z.ZodLiteral<"navigate">;
+    url: z.ZodEffects<z.ZodString, string, string>;
+}, "strip", z.ZodTypeAny, {
+    action: "navigate";
+    url: string;
+}, {
+    action: "navigate";
+    url: string;
+}>, z.ZodObject<{
+    action: z.ZodLiteral<"back">;
+}, "strip", z.ZodTypeAny, {
+    action: "back";
+}, {
+    action: "back";
+}>, z.ZodObject<{
+    action: z.ZodLiteral<"forward">;
+}, "strip", z.ZodTypeAny, {
+    action: "forward";
+}, {
+    action: "forward";
+}>, z.ZodObject<{
+    action: z.ZodLiteral<"reload">;
+}, "strip", z.ZodTypeAny, {
+    action: "reload";
+}, {
+    action: "reload";
+}>, z.ZodObject<{
+    action: z.ZodLiteral<"snapshot">;
+    ref: z.ZodOptional<z.ZodString>;
+    cursor: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    action: "snapshot";
+    cursor?: string | undefined;
+    ref?: string | undefined;
+}, {
+    action: "snapshot";
+    cursor?: string | undefined;
+    ref?: string | undefined;
+}>, z.ZodObject<{
+    action: z.ZodLiteral<"screenshot">;
+    ref: z.ZodOptional<z.ZodString>;
+    fullPage: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    action: "screenshot";
+    ref?: string | undefined;
+    fullPage?: boolean | undefined;
+}, {
+    action: "screenshot";
+    ref?: string | undefined;
+    fullPage?: boolean | undefined;
+}>, z.ZodObject<{
+    action: z.ZodLiteral<"scroll">;
+    direction: z.ZodEnum<["up", "down", "left", "right"]>;
+    ref: z.ZodOptional<z.ZodString>;
+    amount: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    action: "scroll";
+    direction: "left" | "right" | "up" | "down";
+    amount?: number | undefined;
+    ref?: string | undefined;
+}, {
+    action: "scroll";
+    direction: "left" | "right" | "up" | "down";
+    amount?: number | undefined;
+    ref?: string | undefined;
+}>, z.ZodObject<{
+    action: z.ZodLiteral<"wait_for">;
+    text: z.ZodOptional<z.ZodString>;
+    textGone: z.ZodOptional<z.ZodString>;
+    timeMs: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    action: "wait_for";
+    text?: string | undefined;
+    textGone?: string | undefined;
+    timeMs?: number | undefined;
+}, {
+    action: "wait_for";
+    text?: string | undefined;
+    textGone?: string | undefined;
+    timeMs?: number | undefined;
+}>, z.ZodObject<{
+    action: z.ZodLiteral<"tabs">;
+    op: z.ZodEnum<["list", "select", "close", "new"]>;
+    tab: z.ZodOptional<z.ZodString>;
+    url: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+}, "strip", z.ZodTypeAny, {
+    action: "tabs";
+    op: "close" | "list" | "select" | "new";
+    url?: string | undefined;
+    tab?: string | undefined;
+}, {
+    action: "tabs";
+    op: "close" | "list" | "select" | "new";
+    url?: string | undefined;
+    tab?: string | undefined;
+}>]>, {
+    action: "navigate";
+    url: string;
+} | {
+    action: "back";
+} | {
+    action: "forward";
+} | {
+    action: "reload";
+} | {
+    action: "snapshot";
+    cursor?: string | undefined;
+    ref?: string | undefined;
+} | {
+    action: "screenshot";
+    ref?: string | undefined;
+    fullPage?: boolean | undefined;
+} | {
+    action: "scroll";
+    direction: "left" | "right" | "up" | "down";
+    amount?: number | undefined;
+    ref?: string | undefined;
+} | {
+    action: "wait_for";
+    text?: string | undefined;
+    textGone?: string | undefined;
+    timeMs?: number | undefined;
+} | {
+    action: "tabs";
+    op: "close" | "list" | "select" | "new";
+    url?: string | undefined;
+    tab?: string | undefined;
+}, {
+    action: "navigate";
+    url: string;
+} | {
+    action: "back";
+} | {
+    action: "forward";
+} | {
+    action: "reload";
+} | {
+    action: "snapshot";
+    cursor?: string | undefined;
+    ref?: string | undefined;
+} | {
+    action: "screenshot";
+    ref?: string | undefined;
+    fullPage?: boolean | undefined;
+} | {
+    action: "scroll";
+    direction: "left" | "right" | "up" | "down";
+    amount?: number | undefined;
+    ref?: string | undefined;
+} | {
+    action: "wait_for";
+    text?: string | undefined;
+    textGone?: string | undefined;
+    timeMs?: number | undefined;
+} | {
+    action: "tabs";
+    op: "close" | "list" | "select" | "new";
+    url?: string | undefined;
+    tab?: string | undefined;
+}>;
+declare const actSchema: z.ZodDiscriminatedUnion<"action", [z.ZodObject<{
+    origin: z.ZodEffects<z.ZodString, string, string>;
+    snapshot: z.ZodOptional<z.ZodBoolean>;
+    action: z.ZodLiteral<"click">;
+    ref: z.ZodString;
+    doubleClick: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    origin: string;
+    action: "click";
+    ref: string;
+    snapshot?: boolean | undefined;
+    doubleClick?: boolean | undefined;
+}, {
+    origin: string;
+    action: "click";
+    ref: string;
+    snapshot?: boolean | undefined;
+    doubleClick?: boolean | undefined;
+}>, z.ZodObject<{
+    origin: z.ZodEffects<z.ZodString, string, string>;
+    snapshot: z.ZodOptional<z.ZodBoolean>;
+    action: z.ZodLiteral<"type">;
+    ref: z.ZodString;
+    text: z.ZodString;
+    submit: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    text: string;
+    origin: string;
+    action: "type";
+    ref: string;
+    snapshot?: boolean | undefined;
+    submit?: boolean | undefined;
+}, {
+    text: string;
+    origin: string;
+    action: "type";
+    ref: string;
+    snapshot?: boolean | undefined;
+    submit?: boolean | undefined;
+}>, z.ZodObject<{
+    origin: z.ZodEffects<z.ZodString, string, string>;
+    snapshot: z.ZodOptional<z.ZodBoolean>;
+    action: z.ZodLiteral<"fill_form">;
+    fields: z.ZodArray<z.ZodObject<{
+        ref: z.ZodString;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        ref: string;
+    }, {
+        value: string;
+        ref: string;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    origin: string;
+    action: "fill_form";
+    fields: {
+        value: string;
+        ref: string;
+    }[];
+    snapshot?: boolean | undefined;
+}, {
+    origin: string;
+    action: "fill_form";
+    fields: {
+        value: string;
+        ref: string;
+    }[];
+    snapshot?: boolean | undefined;
+}>, z.ZodObject<{
+    origin: z.ZodEffects<z.ZodString, string, string>;
+    snapshot: z.ZodOptional<z.ZodBoolean>;
+    action: z.ZodLiteral<"select">;
+    ref: z.ZodString;
+    values: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    values: string[];
+    origin: string;
+    action: "select";
+    ref: string;
+    snapshot?: boolean | undefined;
+}, {
+    values: string[];
+    origin: string;
+    action: "select";
+    ref: string;
+    snapshot?: boolean | undefined;
+}>, z.ZodObject<{
+    origin: z.ZodEffects<z.ZodString, string, string>;
+    snapshot: z.ZodOptional<z.ZodBoolean>;
+    action: z.ZodLiteral<"press">;
+    key: z.ZodString;
+    ref: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    key: string;
+    origin: string;
+    action: "press";
+    snapshot?: boolean | undefined;
+    ref?: string | undefined;
+}, {
+    key: string;
+    origin: string;
+    action: "press";
+    snapshot?: boolean | undefined;
+    ref?: string | undefined;
+}>, z.ZodObject<{
+    origin: z.ZodEffects<z.ZodString, string, string>;
+    snapshot: z.ZodOptional<z.ZodBoolean>;
+    action: z.ZodLiteral<"hover">;
+    ref: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    origin: string;
+    action: "hover";
+    ref: string;
+    snapshot?: boolean | undefined;
+}, {
+    origin: string;
+    action: "hover";
+    ref: string;
+    snapshot?: boolean | undefined;
+}>, z.ZodObject<{
+    origin: z.ZodEffects<z.ZodString, string, string>;
+    snapshot: z.ZodOptional<z.ZodBoolean>;
+    action: z.ZodLiteral<"upload">;
+    ref: z.ZodString;
+    path: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    path: string;
+    origin: string;
+    action: "upload";
+    ref: string;
+    snapshot?: boolean | undefined;
+}, {
+    path: string;
+    origin: string;
+    action: "upload";
+    ref: string;
+    snapshot?: boolean | undefined;
+}>, z.ZodObject<{
+    origin: z.ZodEffects<z.ZodString, string, string>;
+    snapshot: z.ZodOptional<z.ZodBoolean>;
+    action: z.ZodLiteral<"dialog">;
+    accept: z.ZodBoolean;
+    promptText: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    origin: string;
+    action: "dialog";
+    accept: boolean;
+    snapshot?: boolean | undefined;
+    promptText?: string | undefined;
+}, {
+    origin: string;
+    action: "dialog";
+    accept: boolean;
+    snapshot?: boolean | undefined;
+    promptText?: string | undefined;
+}>]>;
+/** The `browser` tool's input after canonicalisation. */
+export type BrowserToolInput = z.infer<typeof observeSchema>;
+/** The `browser_act` tool's input after canonicalisation. */
+export type BrowserActToolInput = z.infer<typeof actSchema>;
+/**
+ * Whether a `browser` call only observes. Navigation, history moves, reload
+ * and opening a tab change what the browser has loaded, and are what a site
+ * rule on `url` decides; looking, scrolling, waiting and moving between or
+ * closing tabs the browser already holds do not.
+ */
+export declare function isBrowserCallReadOnly(input: BrowserToolInput): boolean;
+/**
+ * `Page: <origin> — "<title>" (tab t1)`.
+ *
+ * The origin is the host's and canonical; the model copies it into
+ * `browser_act`. The title is the page's, so it is quoted, cut to one line
+ * and stripped of the envelope's delimiter.
+ */
+export declare function formatBrowserPageHeader(page: BrowserPageInfo): string;
+/**
+ * The structural error a browser host threw, or undefined. Recognised by
+ * shape, so a separately installed host and SDK need not share a class.
+ */
+export declare function browserHostErrorOf(value: unknown): BrowserHostError | undefined;
+/**
+ * The browser tools over a {@link BrowserHost}: `browser` (observe and
+ * navigate) and `browser_act` (change the page).
+ *
+ * The split is what makes the gate useful. `browser` calls that only look
+ * are read-only; `navigate` and `tabs new` carry a canonical `url` a site
+ * rule can match; every `browser_act` call carries the canonical `origin`
+ * it means to act on, which a site rule can match and which the host checks
+ * against the live page before acting.
+ *
+ * @example
+ * ```ts sketch
+ * import { createBrowserTools } from '@namzu/sdk'
+ *
+ * for (const tool of createBrowserTools(host)) registry.register(tool)
+ * ```
+ */
+export declare function createBrowserTools(host: BrowserHost): [ToolDefinition<BrowserToolInput>, ToolDefinition<BrowserActToolInput>];
+export {};
+//# sourceMappingURL=browser.d.ts.map

package/dist/tools/builtins/browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../src/tools/builtins/browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,KAAK,EAKX,WAAW,EACX,gBAAgB,EAIhB,eAAe,EAGf,MAAM,8BAA8B,CAAA;AAOrC,OAAO,KAAK,EAAE,cAAc,EAAc,MAAM,2BAA2B,CAAA;AAO3E,eAAO,MAAM,iBAAiB,EAAG,SAAkB,CAAA;AACnD,eAAO,MAAM,qBAAqB,EAAG,aAAsB,CAAA;AAmC3D,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqDhB,CAAA;AAOH,QAAA,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA+Cb,CAAA;AAEF,yDAAyD;AACzD,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AAC5D,6DAA6D;AAC7D,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAA;AAyB3D;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAetE;AAqJD;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,CAIrE;AA6FD;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,GAAG,SAAS,CAwB/E;AAqND;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,kBAAkB,CACjC,IAAI,EAAE,WAAW,GACf,CAAC,cAAc,CAAC,gBAAgB,CAAC,EAAE,cAAc,CAAC,mBAAmB,CAAC,CAAC,CAiFzE"}