donobu 1.0.0

package/dist/esm/tools/MarkObjectiveCompleteTool.d.ts

@@ -0,0 +1,27 @@
+import { Tool } from './Tool';
+import { ToolCallContext } from '../models/ToolCallContext';
+import { ToolCallResult } from '../models/ToolCallResult';
+import { BaseToolGptParameters } from '../models/BaseToolGptParameters';
+/**
+ * Parameters for marking an objective as complete
+ */
+export interface MarkObjectiveCompleteToolCoreParameters {
+}
+/**
+ * Parameters for marking an objective as complete
+ */
+export interface MarkObjectiveCompleteToolGptParameters extends BaseToolGptParameters, MarkObjectiveCompleteToolCoreParameters {
+    /**
+     * Relevant details for the completed objective.
+     */
+    details: string;
+}
+/**
+ * Tool for marking the overall objective as complete
+ */
+export declare class MarkObjectiveCompleteTool extends Tool<MarkObjectiveCompleteToolCoreParameters, MarkObjectiveCompleteToolGptParameters> {
+    static readonly NAME = "markObjectiveComplete";
+    constructor();
+    call(context: ToolCallContext, _parameters: MarkObjectiveCompleteToolCoreParameters): Promise<ToolCallResult>;
+    callFromGpt(context: ToolCallContext, parameters: MarkObjectiveCompleteToolGptParameters): Promise<ToolCallResult>;
+}

package/dist/esm/tools/MarkObjectiveCompleteTool.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarkObjectiveCompleteTool = void 0;
+const Tool_1 = require("./Tool");
+const FlowMetadata_1 = require("../models/FlowMetadata");
+/**
+ * Tool for marking the overall objective as complete
+ */
+class MarkObjectiveCompleteTool extends Tool_1.Tool {
+    static NAME = 'markObjectiveComplete';
+    constructor() {
+        super(MarkObjectiveCompleteTool.NAME, 'The overall objective is complete.\n' +
+            'For example, being asked to sign up for a webpage and now the account has been created.', 'MarkObjectiveCompleteToolCoreParameters', 'MarkObjectiveCompleteToolGptParameters');
+    }
+    async call(context, _parameters) {
+        context.metadata.nextState = FlowMetadata_1.State.SUCCESS;
+        return {
+            isSuccessful: true,
+            forLlm: 'Objective has been marked as complete.',
+            metadata: {
+                success: 'Objective complete',
+            },
+        };
+    }
+    async callFromGpt(context, parameters) {
+        context.metadata.nextState = FlowMetadata_1.State.SUCCESS;
+        return {
+            isSuccessful: true,
+            forLlm: 'Objective has been marked as complete.',
+            metadata: {
+                success: 'Objective complete',
+                rationale: parameters.rationale,
+                details: parameters.details,
+            },
+        };
+    }
+}
+exports.MarkObjectiveCompleteTool = MarkObjectiveCompleteTool;
+//# sourceMappingURL=MarkObjectiveCompleteTool.js.map

package/dist/esm/tools/MarkObjectiveCompleteTool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MarkObjectiveCompleteTool.js","sourceRoot":"","sources":["../../../src/tools/MarkObjectiveCompleteTool.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAG9B,yDAA+C;AAoB/C;;GAEG;AACH,MAAa,yBAA0B,SAAQ,WAG9C;IACQ,MAAM,CAAU,IAAI,GAAG,uBAAuB,CAAC;IAEtD;QACE,KAAK,CACH,yBAAyB,CAAC,IAAI,EAC9B,sCAAsC;YACpC,yFAAyF,EAC3F,yCAAyC,EACzC,wCAAwC,CACzC,CAAC;IACJ,CAAC;IAEe,KAAK,CAAC,IAAI,CACxB,OAAwB,EACxB,WAAoD;QAEpD,OAAO,CAAC,QAAQ,CAAC,SAAS,GAAG,oBAAK,CAAC,OAAO,CAAC;QAC3C,OAAO;YACL,YAAY,EAAE,IAAI;YAClB,MAAM,EAAE,wCAAwC;YAChD,QAAQ,EAAE;gBACR,OAAO,EAAE,oBAAoB;aAC9B;SACF,CAAC;IACJ,CAAC;IAEe,KAAK,CAAC,WAAW,CAC/B,OAAwB,EACxB,UAAkD;QAElD,OAAO,CAAC,QAAQ,CAAC,SAAS,GAAG,oBAAK,CAAC,OAAO,CAAC;QAC3C,OAAO;YACL,YAAY,EAAE,IAAI;YAClB,MAAM,EAAE,wCAAwC;YAChD,QAAQ,EAAE;gBACR,OAAO,EAAE,oBAAoB;gBAC7B,SAAS,EAAE,UAAU,CAAC,SAAS;gBAC/B,OAAO,EAAE,UAAU,CAAC,OAAO;aAC5B;SACF,CAAC;IACJ,CAAC;;AA5CH,8DA6CC"}

package/dist/esm/tools/MarkObjectiveNotCompletableTool.d.ts

@@ -0,0 +1,14 @@
+import { Tool } from './Tool';
+import { ToolCallContext } from '../models/ToolCallContext';
+import { ToolCallResult } from '../models/ToolCallResult';
+import { BaseToolGptParameters } from '../models/BaseToolGptParameters';
+export interface MarkObjectiveNotCompletableToolCoreParameters {
+}
+export interface MarkObjectiveNotCompletableToolGptParameters extends BaseToolGptParameters, MarkObjectiveNotCompletableToolCoreParameters {
+}
+export declare class MarkObjectiveNotCompletableTool extends Tool<MarkObjectiveNotCompletableToolCoreParameters, MarkObjectiveNotCompletableToolGptParameters> {
+    static readonly NAME = "markObjectiveNotCompletable";
+    constructor();
+    callFromGpt(context: ToolCallContext, _parameters: MarkObjectiveNotCompletableToolCoreParameters): Promise<ToolCallResult>;
+    call(context: ToolCallContext, parameters: MarkObjectiveNotCompletableToolGptParameters): Promise<ToolCallResult>;
+}

package/dist/esm/tools/MarkObjectiveNotCompletableTool.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarkObjectiveNotCompletableTool = void 0;
+const Tool_1 = require("./Tool");
+const FlowMetadata_1 = require("../models/FlowMetadata");
+class MarkObjectiveNotCompletableTool extends Tool_1.Tool {
+    static NAME = 'markObjectiveNotCompletable';
+    constructor() {
+        super(MarkObjectiveNotCompletableTool.NAME, 'Mark the current objective as not being completable. ' +
+            'For example, being asked to sign up for a webpage that does not support signups.', 'MarkObjectiveNotCompletableToolCoreParameters', 'MarkObjectiveNotCompletableToolGptParameters');
+    }
+    async callFromGpt(context, _parameters) {
+        context.metadata.nextState = FlowMetadata_1.State.FAILED;
+        return {
+            isSuccessful: true,
+            forLlm: 'Objective has been marked as not completable.',
+            metadata: {
+                failed: 'Objective not completable',
+            },
+        };
+    }
+    async call(context, parameters) {
+        context.metadata.nextState = FlowMetadata_1.State.FAILED;
+        return {
+            isSuccessful: true,
+            forLlm: 'Objective has been marked as not completable.',
+            metadata: {
+                failed: 'Objective not completable',
+                rationale: parameters.rationale,
+            },
+        };
+    }
+}
+exports.MarkObjectiveNotCompletableTool = MarkObjectiveNotCompletableTool;
+//# sourceMappingURL=MarkObjectiveNotCompletableTool.js.map

package/dist/esm/tools/MarkObjectiveNotCompletableTool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MarkObjectiveNotCompletableTool.js","sourceRoot":"","sources":["../../../src/tools/MarkObjectiveNotCompletableTool.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAG9B,yDAA+C;AAQ/C,MAAa,+BAAgC,SAAQ,WAGpD;IACQ,MAAM,CAAU,IAAI,GAAG,6BAA6B,CAAC;IAE5D;QACE,KAAK,CACH,+BAA+B,CAAC,IAAI,EACpC,uDAAuD;YACrD,kFAAkF,EACpF,+CAA+C,EAC/C,8CAA8C,CAC/C,CAAC;IACJ,CAAC;IAEe,KAAK,CAAC,WAAW,CAC/B,OAAwB,EACxB,WAA0D;QAE1D,OAAO,CAAC,QAAQ,CAAC,SAAS,GAAG,oBAAK,CAAC,MAAM,CAAC;QAC1C,OAAO;YACL,YAAY,EAAE,IAAI;YAClB,MAAM,EAAE,+CAA+C;YACvD,QAAQ,EAAE;gBACR,MAAM,EAAE,2BAA2B;aACpC;SACF,CAAC;IACJ,CAAC;IAEe,KAAK,CAAC,IAAI,CACxB,OAAwB,EACxB,UAAwD;QAExD,OAAO,CAAC,QAAQ,CAAC,SAAS,GAAG,oBAAK,CAAC,MAAM,CAAC;QAC1C,OAAO;YACL,YAAY,EAAE,IAAI;YAClB,MAAM,EAAE,+CAA+C;YACvD,QAAQ,EAAE;gBACR,MAAM,EAAE,2BAA2B;gBACnC,SAAS,EAAE,UAAU,CAAC,SAAS;aAChC;SACF,CAAC;IACJ,CAAC;;AA3CH,0EA4CC"}

package/dist/esm/tools/NavigateToWebpageTool.d.ts

@@ -0,0 +1,20 @@
+import { Tool } from './Tool';
+import { ToolCallContext } from '../models/ToolCallContext';
+import { ToolCallResult } from '../models/ToolCallResult';
+import { BaseToolGptParameters } from '../models/BaseToolGptParameters';
+export interface NavigateToWebpageToolCoreParameters {
+    /**
+     * The URL to navigate to. Must use HTTP or file protocol (example is https://google.com).
+     */
+    url: string;
+}
+export interface NavigateToWebpageToolGptParameters extends BaseToolGptParameters, NavigateToWebpageToolCoreParameters {
+}
+/** Directly navigate to the specified URL. */
+export declare class NavigateToWebpageTool extends Tool<NavigateToWebpageToolCoreParameters, NavigateToWebpageToolGptParameters> {
+    static readonly NAME = "navigateToWebpage";
+    private static readonly VALID_PROTOCOLS;
+    constructor();
+    call(context: ToolCallContext, parameters: NavigateToWebpageToolCoreParameters): Promise<ToolCallResult>;
+    callFromGpt(context: ToolCallContext, parameters: NavigateToWebpageToolGptParameters): Promise<ToolCallResult>;
+}

package/dist/esm/tools/NavigateToWebpageTool.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NavigateToWebpageTool = void 0;
+const Tool_1 = require("./Tool");
+const PlaywrightUtils_1 = require("../utils/PlaywrightUtils");
+/** Directly navigate to the specified URL. */
+class NavigateToWebpageTool extends Tool_1.Tool {
+    static NAME = 'navigateToWebpage';
+    static VALID_PROTOCOLS = ['https://', 'http://', 'file://'];
+    constructor() {
+        super(NavigateToWebpageTool.NAME, 'Navigate to the specified URL.', 'NavigateToWebpageToolCoreParameters', 'NavigateToWebpageToolGptParameters');
+    }
+    async call(context, parameters) {
+        const page = context.page;
+        const url = parameters.url.trim();
+        if (NavigateToWebpageTool.VALID_PROTOCOLS.some((protocol) => url.startsWith(protocol))) {
+            await page.goto(url, {
+                waitUntil: 'domcontentloaded',
+            });
+            await PlaywrightUtils_1.PlaywrightUtils.waitForPageStability(page);
+            return {
+                isSuccessful: true,
+                forLlm: `Successfully navigated to ${url}`,
+                metadata: null,
+            };
+        }
+        else {
+            return {
+                isSuccessful: false,
+                forLlm: `Will not navigate a URL not using the following prefixes: ${NavigateToWebpageTool.VALID_PROTOCOLS}`,
+                metadata: null,
+            };
+        }
+    }
+    async callFromGpt(context, parameters) {
+        return this.call(context, parameters);
+    }
+}
+exports.NavigateToWebpageTool = NavigateToWebpageTool;
+//# sourceMappingURL=NavigateToWebpageTool.js.map

package/dist/esm/tools/NavigateToWebpageTool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NavigateToWebpageTool.js","sourceRoot":"","sources":["../../../src/tools/NavigateToWebpageTool.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAI9B,8DAA2D;AAY3D,8CAA8C;AAC9C,MAAa,qBAAsB,SAAQ,WAG1C;IACQ,MAAM,CAAU,IAAI,GAAG,mBAAmB,CAAC;IAE1C,MAAM,CAAU,eAAe,GAAG,CAAC,UAAU,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IAE7E;QACE,KAAK,CACH,qBAAqB,CAAC,IAAI,EAC1B,gCAAgC,EAChC,qCAAqC,EACrC,oCAAoC,CACrC,CAAC;IACJ,CAAC;IAEe,KAAK,CAAC,IAAI,CACxB,OAAwB,EACxB,UAA+C;QAE/C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QAC1B,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QAElC,IACE,qBAAqB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CACtD,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,CACzB,EACD,CAAC;YACD,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnB,SAAS,EAAE,kBAAkB;aAC9B,CAAC,CAAC;YACH,MAAM,iCAAe,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;YACjD,OAAO;gBACL,YAAY,EAAE,IAAI;gBAClB,MAAM,EAAE,6BAA6B,GAAG,EAAE;gBAC1C,QAAQ,EAAE,IAAI;aACf,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO;gBACL,YAAY,EAAE,KAAK;gBACnB,MAAM,EAAE,6DAA6D,qBAAqB,CAAC,eAAe,EAAE;gBAC5G,QAAQ,EAAE,IAAI;aACf,CAAC;QACJ,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,WAAW,CAC/B,OAAwB,EACxB,UAA8C;QAE9C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IACxC,CAAC;;AApDH,sDAqDC"}

package/dist/esm/tools/NavigateWithinStreetView.d.ts

@@ -0,0 +1,38 @@
+import { Tool } from './Tool';
+import { ToolCallContext } from '../models/ToolCallContext';
+import { ToolCallResult } from '../models/ToolCallResult';
+import { Page } from 'playwright';
+import { BaseToolGptParameters } from '../models/BaseToolGptParameters';
+export declare enum Action {
+    ROTATE_CLOCKWISE = "ROTATE_CLOCKWISE",
+    ROTATE_COUNTERCLOCKWISE = "ROTATE_COUNTERCLOCKWISE",
+    ZOOM_IN = "ZOOM_IN",
+    ZOOM_OUT = "ZOOM_OUT"
+}
+export interface NavigateWithinStreetViewToolCoreParameters {
+    /**
+     * Choose a value that will most likely help towards the current objective.
+     * - A value of ZOOM_IN will zoom in on current street maps view.
+     * - A value of ZOOM_OUT will zoom out on current street maps view.
+     * - A value of ROTATE_CLOCKWISE will rotate the current street maps view clockwise.
+     * - A value of ROTATE_COUNTERCLOCKWISE will rotate the current street maps view counterclockwise.
+     */
+    action: Action;
+}
+export interface NavigateWithinStreetViewToolGptParameters extends BaseToolGptParameters, NavigateWithinStreetViewToolCoreParameters {
+}
+export declare class NavigateWithinStreetViewTool extends Tool<NavigateWithinStreetViewToolCoreParameters, NavigateWithinStreetViewToolGptParameters> {
+    static readonly NAME = "navigateWithinStreetView";
+    constructor();
+    call(context: ToolCallContext, parameters: NavigateWithinStreetViewToolCoreParameters): Promise<ToolCallResult>;
+    callFromGpt(context: ToolCallContext, parameters: NavigateWithinStreetViewToolGptParameters): Promise<ToolCallResult>;
+    /**
+     * Removes the Google Maps survey iframe from the given Page.
+     * If no survey exists, this call has no effect.
+     *
+     * @param page - The Playwright Page object to remove the survey from
+     */
+    static removeGoogleMapsSurvey(page: Page): Promise<void>;
+    private static rotateStreetView;
+    private static zoomStreetView;
+}

package/dist/esm/tools/NavigateWithinStreetView.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NavigateWithinStreetViewTool = exports.Action = void 0;
+const Tool_1 = require("./Tool");
+const ToolCallResult_1 = require("../models/ToolCallResult");
+const GoToGoogleMapsStreetViewTool_1 = require("./GoToGoogleMapsStreetViewTool");
+const ExtractGoogleStreetviewEntityDataTool_1 = require("./ExtractGoogleStreetviewEntityDataTool");
+const PlaywrightUtils_1 = require("../utils/PlaywrightUtils");
+const MiscUtils_1 = require("../utils/MiscUtils");
+var Action;
+(function (Action) {
+    Action["ROTATE_CLOCKWISE"] = "ROTATE_CLOCKWISE";
+    Action["ROTATE_COUNTERCLOCKWISE"] = "ROTATE_COUNTERCLOCKWISE";
+    Action["ZOOM_IN"] = "ZOOM_IN";
+    Action["ZOOM_OUT"] = "ZOOM_OUT";
+})(Action || (exports.Action = Action = {}));
+class NavigateWithinStreetViewTool extends Tool_1.Tool {
+    static NAME = 'navigateWithinStreetView';
+    constructor() {
+        super(NavigateWithinStreetViewTool.NAME, 'Zoom in or out or rotate clockwise or counterclockwise on Google Street View.', 'NavigateWithinStreetViewToolCoreParameters', 'NavigateWithinStreetViewToolGptParameters');
+    }
+    async call(context, parameters) {
+        const page = context.page;
+        await NavigateWithinStreetViewTool.removeGoogleMapsSurvey(page);
+        let isSuccess;
+        if (parameters.action === Action.ROTATE_CLOCKWISE ||
+            parameters.action === Action.ROTATE_COUNTERCLOCKWISE) {
+            // First zoom out before rotating so that we do not miss content.
+            await NavigateWithinStreetViewTool.zoomStreetView(page, Action.ZOOM_OUT);
+            isSuccess = await NavigateWithinStreetViewTool.rotateStreetView(page, parameters.action);
+        }
+        else {
+            isSuccess = await NavigateWithinStreetViewTool.zoomStreetView(page, parameters.action);
+        }
+        const goToGoogleMapsStreetViewTool = new GoToGoogleMapsStreetViewTool_1.GoToGoogleMapsStreetViewTool();
+        // Queue a ExtractGoogleStreetviewEntityDataTool call if one is not already planned.
+        const isExtractToolAlreadyProposed = context.proposedToolCalls.some((call) => call.name === ExtractGoogleStreetviewEntityDataTool_1.ExtractGoogleStreetviewEntityDataTool.NAME);
+        if (!isExtractToolAlreadyProposed) {
+            // Extract the target business/entity name from the original GoToGoogleMapsStreetViewTool tool call.
+            const originalToolCall = context.invokedToolCalls.find((tc) => tc.toolName === goToGoogleMapsStreetViewTool.name);
+            if (originalToolCall) {
+                const entityName = originalToolCall.parameters.entityName;
+                const extractEntityDataProposedToolCall = {
+                    name: ExtractGoogleStreetviewEntityDataTool_1.ExtractGoogleStreetviewEntityDataTool.NAME,
+                    parameters: {
+                        entityName,
+                    },
+                };
+                context.proposedToolCalls.push(extractEntityDataProposedToolCall);
+            }
+        }
+        await PlaywrightUtils_1.PlaywrightUtils.waitForPageStability(page);
+        return isSuccess
+            ? ToolCallResult_1.ToolCallResult.successful()
+            : {
+                isSuccessful: false,
+                forLlm: 'FAILED',
+                metadata: null,
+            };
+    }
+    callFromGpt(context, parameters) {
+        return this.call(context, parameters);
+    }
+    /**
+     * Removes the Google Maps survey iframe from the given Page.
+     * If no survey exists, this call has no effect.
+     *
+     * @param page - The Playwright Page object to remove the survey from
+     */
+    static async removeGoogleMapsSurvey(page) {
+        return page.evaluate(() => {
+            document.querySelectorAll('#google-hats-survey').forEach((element) => {
+                element.remove();
+            });
+        });
+    }
+    static async rotateStreetView(googleMapsPage, direction) {
+        const rotateDirection = direction === Action.ROTATE_COUNTERCLOCKWISE
+            ? 'Rotate the view counterclockwise'
+            : 'Rotate the view clockwise';
+        const rotateStreetViewButton = await googleMapsPage.$(`button[aria-label="${rotateDirection}"]`);
+        if (rotateStreetViewButton) {
+            await rotateStreetViewButton.click({
+                delay: MiscUtils_1.MiscUtils.generateHumanLikeClickDurationInMs(),
+            });
+            await googleMapsPage.waitForLoadState();
+            await googleMapsPage.waitForTimeout(931);
+            return true;
+        }
+        return false;
+    }
+    static async zoomStreetView(googleMapsPage, direction) {
+        const zoomDirection = direction === Action.ZOOM_OUT ? 'Zoom out' : 'Zoom in';
+        const zoomStreetViewButton = await googleMapsPage.$(`button[aria-label="${zoomDirection}"]`);
+        if (zoomStreetViewButton && !(await zoomStreetViewButton.isDisabled())) {
+            await zoomStreetViewButton.click({
+                delay: MiscUtils_1.MiscUtils.generateHumanLikeClickDurationInMs(),
+            });
+            await googleMapsPage.waitForLoadState();
+            await googleMapsPage.waitForTimeout(931);
+            return true;
+        }
+        return false;
+    }
+}
+exports.NavigateWithinStreetViewTool = NavigateWithinStreetViewTool;
+//# sourceMappingURL=NavigateWithinStreetView.js.map

package/dist/esm/tools/NavigateWithinStreetView.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NavigateWithinStreetView.js","sourceRoot":"","sources":["../../../src/tools/NavigateWithinStreetView.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAE9B,6DAA0D;AAE1D,iFAA8E;AAC9E,mGAGiD;AAEjD,8DAA2D;AAC3D,kDAA+C;AAE/C,IAAY,MAKX;AALD,WAAY,MAAM;IAChB,+CAAqC,CAAA;IACrC,6DAAmD,CAAA;IACnD,6BAAmB,CAAA;IACnB,+BAAqB,CAAA;AACvB,CAAC,EALW,MAAM,sBAAN,MAAM,QAKjB;AAiBD,MAAa,4BAA6B,SAAQ,WAGjD;IACQ,MAAM,CAAU,IAAI,GAAG,0BAA0B,CAAC;IAEzD;QACE,KAAK,CACH,4BAA4B,CAAC,IAAI,EACjC,+EAA+E,EAC/E,4CAA4C,EAC5C,2CAA2C,CAC5C,CAAC;IACJ,CAAC;IAEe,KAAK,CAAC,IAAI,CACxB,OAAwB,EACxB,UAAsD;QAEtD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QAC1B,MAAM,4BAA4B,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAEhE,IAAI,SAAkB,CAAC;QAEvB,IACE,UAAU,CAAC,MAAM,KAAK,MAAM,CAAC,gBAAgB;YAC7C,UAAU,CAAC,MAAM,KAAK,MAAM,CAAC,uBAAuB,EACpD,CAAC;YACD,iEAAiE;YACjE,MAAM,4BAA4B,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;YACzE,SAAS,GAAG,MAAM,4BAA4B,CAAC,gBAAgB,CAC7D,IAAI,EACJ,UAAU,CAAC,MAAM,CAClB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,SAAS,GAAG,MAAM,4BAA4B,CAAC,cAAc,CAC3D,IAAI,EACJ,UAAU,CAAC,MAAM,CAClB,CAAC;QACJ,CAAC;QAED,MAAM,4BAA4B,GAAG,IAAI,2DAA4B,EAAE,CAAC;QACxE,oFAAoF;QACpF,MAAM,4BAA4B,GAAG,OAAO,CAAC,iBAAiB,CAAC,IAAI,CACjE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,6EAAqC,CAAC,IAAI,CACnE,CAAC;QAEF,IAAI,CAAC,4BAA4B,EAAE,CAAC;YAClC,oGAAoG;YACpG,MAAM,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,IAAI,CACpD,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,KAAK,4BAA4B,CAAC,IAAI,CAC1D,CAAC;YAEF,IAAI,gBAAgB,EAAE,CAAC;gBACrB,MAAM,UAAU,GAAG,gBAAgB,CAAC,UAAU,CAAC,UAAU,CAAC;gBAC1D,MAAM,iCAAiC,GAAG;oBACxC,IAAI,EAAE,6EAAqC,CAAC,IAAI;oBAChD,UAAU,EAAE;wBACV,UAAU;qBACmD;iBAChE,CAAC;gBACF,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;YACpE,CAAC;QACH,CAAC;QAED,MAAM,iCAAe,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACjD,OAAO,SAAS;YACd,CAAC,CAAC,+BAAc,CAAC,UAAU,EAAE;YAC7B,CAAC,CAAC;gBACE,YAAY,EAAE,KAAK;gBACnB,MAAM,EAAE,QAAQ;gBAChB,QAAQ,EAAE,IAAI;aACf,CAAC;IACR,CAAC;IAEe,WAAW,CACzB,OAAwB,EACxB,UAAqD;QAErD,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,IAAU;QACnD,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;YACxB,QAAQ,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBACnE,OAAO,CAAC,MAAM,EAAE,CAAC;YACnB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,gBAAgB,CACnC,cAAoB,EACpB,SAAiB;QAEjB,MAAM,eAAe,GACnB,SAAS,KAAK,MAAM,CAAC,uBAAuB;YAC1C,CAAC,CAAC,kCAAkC;YACpC,CAAC,CAAC,2BAA2B,CAAC;QAElC,MAAM,sBAAsB,GAAG,MAAM,cAAc,CAAC,CAAC,CACnD,sBAAsB,eAAe,IAAI,CAC1C,CAAC;QAEF,IAAI,sBAAsB,EAAE,CAAC;YAC3B,MAAM,sBAAsB,CAAC,KAAK,CAAC;gBACjC,KAAK,EAAE,qBAAS,CAAC,kCAAkC,EAAE;aACtD,CAAC,CAAC;YACH,MAAM,cAAc,CAAC,gBAAgB,EAAE,CAAC;YACxC,MAAM,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;YACzC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,cAAc,CACjC,cAAoB,EACpB,SAAiB;QAEjB,MAAM,aAAa,GACjB,SAAS,KAAK,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;QAEzD,MAAM,oBAAoB,GAAG,MAAM,cAAc,CAAC,CAAC,CACjD,sBAAsB,aAAa,IAAI,CACxC,CAAC;QAEF,IAAI,oBAAoB,IAAI,CAAC,CAAC,MAAM,oBAAoB,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC;YACvE,MAAM,oBAAoB,CAAC,KAAK,CAAC;gBAC/B,KAAK,EAAE,qBAAS,CAAC,kCAAkC,EAAE;aACtD,CAAC,CAAC;YACH,MAAM,cAAc,CAAC,gBAAgB,EAAE,CAAC;YACxC,MAAM,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;YACzC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;;AA5IH,oEA6IC"}

package/dist/esm/tools/PauseForUserInteractionTool.d.ts

@@ -0,0 +1,18 @@
+import { Tool } from './Tool';
+import { ToolCallContext } from '../models/ToolCallContext';
+import { ToolCallResult } from '../models/ToolCallResult';
+import { BaseToolGptParameters } from '../models/BaseToolGptParameters';
+interface PauseForUserInteractionToolCoreParameters {
+}
+interface PauseForUserInteractionToolGptParameters extends BaseToolGptParameters, PauseForUserInteractionToolCoreParameters {
+}
+/**
+ * This tool pauses the script to let the user interact with the webpage manually.
+ */
+export declare class PauseForUserInteractionTool extends Tool<PauseForUserInteractionToolCoreParameters, PauseForUserInteractionToolGptParameters> {
+    static readonly NAME = "pauseForUserInteraction";
+    constructor();
+    call(context: ToolCallContext, _parameters: PauseForUserInteractionToolCoreParameters): Promise<ToolCallResult>;
+    callFromGpt(context: ToolCallContext, parameters: PauseForUserInteractionToolGptParameters): Promise<ToolCallResult>;
+}
+export {};

package/dist/esm/tools/PauseForUserInteractionTool.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PauseForUserInteractionTool = void 0;
+const Tool_1 = require("./Tool");
+const ToolCallResult_1 = require("../models/ToolCallResult");
+const FlowMetadata_1 = require("../models/FlowMetadata");
+/**
+ * This tool pauses the script to let the user interact with the webpage manually.
+ */
+class PauseForUserInteractionTool extends Tool_1.Tool {
+    static NAME = 'pauseForUserInteraction';
+    constructor() {
+        super(PauseForUserInteractionTool.NAME, 'Temporarily pause Playwright script execution so that the user can interact with the webpage.', 'PauseForUserInteractionToolCoreParameters', 'PauseForUserInteractionToolGptParameters');
+    }
+    async call(context, _parameters) {
+        context.metadata.nextState = FlowMetadata_1.State.PAUSED;
+        return ToolCallResult_1.ToolCallResult.successful();
+    }
+    async callFromGpt(context, parameters) {
+        return this.call(context, parameters);
+    }
+}
+exports.PauseForUserInteractionTool = PauseForUserInteractionTool;
+//# sourceMappingURL=PauseForUserInteractionTool.js.map

package/dist/esm/tools/PauseForUserInteractionTool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PauseForUserInteractionTool.js","sourceRoot":"","sources":["../../../src/tools/PauseForUserInteractionTool.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAE9B,6DAA0D;AAC1D,yDAA+C;AAQ/C;;GAEG;AACH,MAAa,2BAA4B,SAAQ,WAGhD;IACQ,MAAM,CAAU,IAAI,GAAG,yBAAyB,CAAC;IAExD;QACE,KAAK,CACH,2BAA2B,CAAC,IAAI,EAChC,+FAA+F,EAC/F,2CAA2C,EAC3C,0CAA0C,CAC3C,CAAC;IACJ,CAAC;IAEe,KAAK,CAAC,IAAI,CACxB,OAAwB,EACxB,WAAsD;QAEtD,OAAO,CAAC,QAAQ,CAAC,SAAS,GAAG,oBAAK,CAAC,MAAM,CAAC;QAC1C,OAAO,+BAAc,CAAC,UAAU,EAAE,CAAC;IACrC,CAAC;IAEe,KAAK,CAAC,WAAW,CAC/B,OAAwB,EACxB,UAAoD;QAEpD,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IACxC,CAAC;;AA5BH,kEA6BC"}

package/dist/esm/tools/PressKeyTool.d.ts

@@ -0,0 +1,18 @@
+import { Locator } from 'playwright';
+import { ToolCallContext } from '../models/ToolCallContext';
+import { ReplayableInteraction, AnnotationBasedParameters, SelectorBasedParameters } from './ReplayableInteraction';
+export interface PressKeyToolCoreParameters {
+    /**
+     * The key to press.
+     */
+    key: string;
+}
+export interface SelectorBasedPressKeyToolParameters extends SelectorBasedParameters, PressKeyToolCoreParameters {
+}
+export interface AnnotationBasedPressKeyToolParameters extends AnnotationBasedParameters, PressKeyToolCoreParameters {
+}
+export declare class PressKeyTool extends ReplayableInteraction<PressKeyToolCoreParameters, SelectorBasedPressKeyToolParameters, AnnotationBasedPressKeyToolParameters> {
+    static readonly NAME = "pressKey";
+    constructor();
+    invoke(_context: ToolCallContext, parameters: PressKeyToolCoreParameters, element: Locator): Promise<string>;
+}

package/dist/esm/tools/PressKeyTool.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PressKeyTool = void 0;
+const ReplayableInteraction_1 = require("./ReplayableInteraction");
+const MiscUtils_1 = require("../utils/MiscUtils");
+class PressKeyTool extends ReplayableInteraction_1.ReplayableInteraction {
+    static NAME = 'pressKey';
+    constructor() {
+        super(PressKeyTool.NAME, `Press a single key, the element to input the keypress at is designated by an annotation
+located dead-center of the target element. Note that if there is existing text in the element,
+it is appended rather than cleared.
+
+Generally, prefer using the 'inputText' tool instead as it automatically clears existing text
+and it allows the input of multiple characters at a time. The only advantage this tool has is
+that it allows the passing of control keys like "Tab", "Backspace", etc.`, 'SelectorBasedPressKeyToolParameters', 'AnnotationBasedPressKeyToolParameters');
+    }
+    async invoke(_context, parameters, element) {
+        // First focus the element
+        await element.focus();
+        // Move cursor to end of existing text
+        await element.evaluate((el) => {
+            if (el instanceof HTMLInputElement || el instanceof HTMLTextAreaElement) {
+                el.setSelectionRange(el.value.length, el.value.length);
+            }
+            else if (el instanceof HTMLElement && el.isContentEditable) {
+                // Handle contenteditable elements
+                const range = document.createRange();
+                const sel = window.getSelection();
+                range.selectNodeContents(el);
+                range.collapse(false); // false means collapse to end
+                sel?.removeAllRanges();
+                sel?.addRange(range);
+            }
+        });
+        await element.press(parameters.key, {
+            delay: MiscUtils_1.MiscUtils.generateHumanLikeKeyPressDurationInMs(parameters.key),
+            timeout: 3000,
+        });
+        return 'Pressed the key at the element.';
+    }
+}
+exports.PressKeyTool = PressKeyTool;
+//# sourceMappingURL=PressKeyTool.js.map

package/dist/esm/tools/PressKeyTool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PressKeyTool.js","sourceRoot":"","sources":["../../../src/tools/PressKeyTool.ts"],"names":[],"mappings":";;;AAEA,mEAIiC;AACjC,kDAA+C;AAe/C,MAAa,YAAa,SAAQ,6CAIjC;IACQ,MAAM,CAAU,IAAI,GAAG,UAAU,CAAC;IAEzC;QACE,KAAK,CACH,YAAY,CAAC,IAAI,EACjB;;;;;;yEAMmE,EACnE,qCAAqC,EACrC,uCAAuC,CACxC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CACV,QAAyB,EACzB,UAAsC,EACtC,OAAgB;QAEhB,0BAA0B;QAC1B,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;QAEtB,sCAAsC;QACtC,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,EAAE;YAC5B,IAAI,EAAE,YAAY,gBAAgB,IAAI,EAAE,YAAY,mBAAmB,EAAE,CAAC;gBACxE,EAAE,CAAC,iBAAiB,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACzD,CAAC;iBAAM,IAAI,EAAE,YAAY,WAAW,IAAI,EAAE,CAAC,iBAAiB,EAAE,CAAC;gBAC7D,kCAAkC;gBAClC,MAAM,KAAK,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;gBACrC,MAAM,GAAG,GAAG,MAAM,CAAC,YAAY,EAAE,CAAC;gBAClC,KAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;gBAC7B,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,8BAA8B;gBACrD,GAAG,EAAE,eAAe,EAAE,CAAC;gBACvB,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE;YAClC,KAAK,EAAE,qBAAS,CAAC,qCAAqC,CAAC,UAAU,CAAC,GAAG,CAAC;YACtE,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;QACH,OAAO,iCAAiC,CAAC;IAC3C,CAAC;;AAlDH,oCAmDC"}

package/dist/esm/tools/ReloadPageTool.d.ts

@@ -0,0 +1,14 @@
+import { Tool } from './Tool';
+import { ToolCallContext } from '../models/ToolCallContext';
+import { ToolCallResult } from '../models/ToolCallResult';
+import { BaseToolGptParameters } from '../models/BaseToolGptParameters';
+export interface ReloadPageToolCoreParameters {
+}
+export interface ReloadPageToolGptParameters extends BaseToolGptParameters {
+}
+export declare class ReloadPageTool extends Tool<ReloadPageToolCoreParameters, ReloadPageToolGptParameters> {
+    static readonly NAME = "reloadPage";
+    constructor();
+    call(context: ToolCallContext, _parameters: ReloadPageToolCoreParameters): Promise<ToolCallResult>;
+    callFromGpt(context: ToolCallContext, parameters: ReloadPageToolGptParameters): Promise<ToolCallResult>;
+}

package/dist/esm/tools/ReloadPageTool.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReloadPageTool = void 0;
+const Tool_1 = require("./Tool");
+const ToolCallResult_1 = require("../models/ToolCallResult");
+class ReloadPageTool extends Tool_1.Tool {
+    static NAME = 'reloadPage';
+    constructor() {
+        super(ReloadPageTool.NAME, 'Reload the current page (maps to Playwright Page::reload).', 'ReloadPageToolCoreParameters', 'ReloadPageToolGptParameters');
+    }
+    async call(context, _parameters) {
+        await context.page.reload();
+        return ToolCallResult_1.ToolCallResult.successful();
+    }
+    async callFromGpt(context, parameters) {
+        return this.call(context, parameters);
+    }
+}
+exports.ReloadPageTool = ReloadPageTool;
+//# sourceMappingURL=ReloadPageTool.js.map

package/dist/esm/tools/ReloadPageTool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReloadPageTool.js","sourceRoot":"","sources":["../../../src/tools/ReloadPageTool.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAE9B,6DAA0D;AAM1D,MAAa,cAAe,SAAQ,WAGnC;IACQ,MAAM,CAAU,IAAI,GAAG,YAAY,CAAC;IAE3C;QACE,KAAK,CACH,cAAc,CAAC,IAAI,EACnB,4DAA4D,EAC5D,8BAA8B,EAC9B,6BAA6B,CAC9B,CAAC;IACJ,CAAC;IAEe,KAAK,CAAC,IAAI,CACxB,OAAwB,EACxB,WAAyC;QAEzC,MAAM,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QAC5B,OAAO,+BAAc,CAAC,UAAU,EAAE,CAAC;IACrC,CAAC;IAEe,KAAK,CAAC,WAAW,CAC/B,OAAwB,EACxB,UAAuC;QAEvC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IACxC,CAAC;;AA5BH,wCA6BC"}

package/dist/esm/tools/ReplayableInteraction.d.ts

@@ -0,0 +1,62 @@
+import { Locator, Page } from 'playwright';
+import { ToolCallContext } from '../models/ToolCallContext';
+import { ToolCallResult } from '../models/ToolCallResult';
+import { Tool } from './Tool';
+import { ElementSelector } from '../models/ElementSelector';
+import { BaseToolGptParameters } from '../models/BaseToolGptParameters';
+export interface CoreParameters {
+}
+export interface SelectorBasedParameters extends CoreParameters {
+    selector: ElementSelector;
+}
+export interface AnnotationBasedParameters extends BaseToolGptParameters, CoreParameters {
+    /**
+     * The reason why this particular numbered annotation was chosen.
+     */
+    whyThisAnnotation: string;
+    /**
+     * The numbered annotation of the element to click.
+     */
+    annotation: string;
+}
+/**
+ * Tools that specify a numbered Donobu annotation to indicate which element to
+ * interact with and support deterministic reruns should extend this interface.
+ */
+export declare abstract class ReplayableInteraction<CoreParameters, NonGptParameters extends SelectorBasedParameters & CoreParameters, GptParameters extends AnnotationBasedParameters & CoreParameters> extends Tool<SelectorBasedParameters, GptParameters> {
+    static readonly MAX_LOCATOR_MATCH_COUNT = 5;
+    constructor(name: string, description: string, parametersTypeNameForGptlessSchema: string, parametersTypeNameForGptSchema: string);
+    call(context: ToolCallContext, parameters: NonGptParameters): Promise<ToolCallResult>;
+    callFromGpt(context: ToolCallContext, parameters: GptParameters): Promise<ToolCallResult>;
+    /**
+     * Apply an operation to the given element.
+     *
+     * If the function does not throw, the operation is considered a success and
+     * the returned string is written to the LLM message history.
+     */
+    protected abstract invoke(context: ToolCallContext, parameters: CoreParameters, element: Locator): Promise<string>;
+    private callCore;
+    /**
+     * Retrieves a list of {@link Locator} objects based on the provided selector
+     * candidates, ordered by their match count in ascending order. If the match
+     * count for a locator exceeds
+     * {@link ReplayableInteraction.MAX_LOCATOR_MATCH_COUNT}, then they are ignored, as
+     * it is considered too broad of a locator to be useful.
+     *
+     * This method iterates through a list of CSS selector candidates and creates
+     * a {@link Locator} for each candidate. It counts the number of elements that
+     * match each selector within a given page. If a frame selector is provided,
+     * it looks for the elements within the specified frame; otherwise, it
+     * searches within the entire page. Only locators with a positive match count
+     * are added to the result list.
+     *
+     * @param page - The the web page to search within.
+     * @param frameSelector - An optional CSS selector for a frame within the
+     *   page. If {@code null}, the search is performed in the entire page.
+     * @param selectorCandidates A list of CSS selector strings to be used for
+     *   locating elements.
+     * @return A list of {@link Locator} objects that have been found, ordered by
+     *   their match count in ascending order.
+     */
+    static getLocatorsOrderedByMatchCount(page: Page, frameSelector: string | null, selectorCandidates: string[]): Promise<Locator[]>;
+}