donobu 1.0.0

package/dist/managers/ToolManager.js

@@ -0,0 +1,264 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolManager = void 0;
+const Logger_1 = require("../utils/Logger");
+const PlaywrightUtils_1 = require("../utils/PlaywrightUtils");
+const ToolRequiresGptException_1 = require("../exceptions/ToolRequiresGptException");
+const ChooseSelectOptionTool_1 = require("../tools/ChooseSelectOptionTool");
+const ClickTool_1 = require("../tools/ClickTool");
+const HandleBrowserDialogTool_1 = require("../tools/HandleBrowserDialogTool");
+const InputRandomizedEmailAddressTool_1 = require("../tools/InputRandomizedEmailAddressTool");
+const MarkObjectiveCompleteTool_1 = require("../tools/MarkObjectiveCompleteTool");
+const GoToWebpageTool_1 = require("../tools/GoToWebpageTool");
+const PressKeyTool_1 = require("../tools/PressKeyTool");
+const RunAccessibilityTestTool_1 = require("../tools/RunAccessibilityTestTool");
+const ScrollPageTool_1 = require("../tools/ScrollPageTool");
+const AssertTool_1 = require("../tools/AssertTool");
+const InputTextTool_1 = require("../tools/InputTextTool");
+const AnalyzePageTextTool_1 = require("../tools/AnalyzePageTextTool");
+const CreateBrowserCookieReportTool_1 = require("../tools/CreateBrowserCookieReportTool");
+const MarkObjectiveNotCompletableTool_1 = require("../tools/MarkObjectiveNotCompletableTool");
+const RunInlineJavaScriptCodeTool_1 = require("../tools/RunInlineJavaScriptCodeTool");
+const RunSandboxedJavaScriptCodeTool_1 = require("../tools/RunSandboxedJavaScriptCodeTool");
+const SummarizeLearningsTool_1 = require("../tools/SummarizeLearningsTool");
+const TriggerDonobuFlowTool_1 = require("../tools/TriggerDonobuFlowTool");
+const ChangeWebBrowserTabTool_1 = require("../tools/ChangeWebBrowserTabTool");
+const AggregateExtractedStreetviewDataTool_1 = require("../tools/AggregateExtractedStreetviewDataTool");
+const ExtractGoogleStreetviewEntityDataTool_1 = require("../tools/ExtractGoogleStreetviewEntityDataTool");
+const ExtractPaymentProviderKeyTool_1 = require("../tools/ExtractPaymentProviderKeyTool");
+const ExtractPublicFacebookEntityDataTool_1 = require("../tools/ExtractPublicFacebookEntityDataTool");
+const GetEntityDataFromGoogleMapResult_1 = require("../tools/GetEntityDataFromGoogleMapResult");
+const GoForwardOrBackTool_1 = require("../tools/GoForwardOrBackTool");
+const GoToGoogleMapsStreetViewTool_1 = require("../tools/GoToGoogleMapsStreetViewTool");
+const MakeCommentTool_1 = require("../tools/MakeCommentTool");
+const NavigateWithinStreetView_1 = require("../tools/NavigateWithinStreetView");
+const PauseForUserInteractionTool_1 = require("../tools/PauseForUserInteractionTool");
+const ReloadPageTool_1 = require("../tools/ReloadPageTool");
+const SaveWebpageAsPdfTool_1 = require("../tools/SaveWebpageAsPdfTool");
+const SetRunModeTool_1 = require("../tools/SetRunModeTool");
+const DownloadPdfTool_1 = require("../tools/DownloadPdfTool");
+const WaitTool_1 = require("../tools/WaitTool");
+const HoverOverElementTool_1 = require("../tools/HoverOverElementTool");
+const DetectBrokenLinksTool_1 = require("../tools/DetectBrokenLinksTool");
+const JsonUtils_1 = require("../utils/JsonUtils");
+const json5_1 = __importDefault(require("json5"));
+/**
+ * Manages calls to a given list of tools.
+ */
+class ToolManager {
+    tools;
+    static logger = Logger_1.Logger.appLogger;
+    static ALL_TOOLS = [
+        new AnalyzePageTextTool_1.AnalyzePageTextTool(),
+        new AssertTool_1.AssertTool(),
+        new CreateBrowserCookieReportTool_1.CreateBrowserCookieReportTool(),
+        new ChangeWebBrowserTabTool_1.ChangeWebBrowserTabTool(),
+        new ChooseSelectOptionTool_1.ChooseSelectOptionTool(),
+        new ClickTool_1.ClickTool(),
+        new DownloadPdfTool_1.DownloadPdfTool(),
+        new ExtractGoogleStreetviewEntityDataTool_1.ExtractGoogleStreetviewEntityDataTool(),
+        new ExtractPaymentProviderKeyTool_1.ExtractPaymentProviderKeyTool(),
+        new ExtractPublicFacebookEntityDataTool_1.ExtractPublicFacebookEntityDataTool(),
+        new DetectBrokenLinksTool_1.DetectBrokenLinksTool(),
+        new GetEntityDataFromGoogleMapResult_1.GetEntityDataFromGoogleMapResultTool(),
+        new GoForwardOrBackTool_1.GoForwardOrBackTool(),
+        new GoToGoogleMapsStreetViewTool_1.GoToGoogleMapsStreetViewTool(),
+        new GoToWebpageTool_1.GoToWebpageTool(),
+        new HandleBrowserDialogTool_1.HandleBrowserDialogTool(),
+        new HoverOverElementTool_1.HoverOverElementTool(),
+        new InputRandomizedEmailAddressTool_1.InputRandomizedEmailAddressTool(),
+        new InputTextTool_1.InputTextTool(),
+        new MakeCommentTool_1.MakeCommentTool(),
+        new NavigateWithinStreetView_1.NavigateWithinStreetViewTool(),
+        new MarkObjectiveCompleteTool_1.MarkObjectiveCompleteTool(),
+        new MarkObjectiveNotCompletableTool_1.MarkObjectiveNotCompletableTool(),
+        new PauseForUserInteractionTool_1.PauseForUserInteractionTool(),
+        new AggregateExtractedStreetviewDataTool_1.AggregateExtractedStreetviewDataTool(),
+        new PressKeyTool_1.PressKeyTool(),
+        new ReloadPageTool_1.ReloadPageTool(),
+        new RunAccessibilityTestTool_1.RunAccessibilityTestTool(),
+        new RunInlineJavaScriptCodeTool_1.RunInlineJavaScriptCodeTool(),
+        new RunSandboxedJavaScriptCodeTool_1.RunSandboxedJavaScriptCodeTool(),
+        new SaveWebpageAsPdfTool_1.SaveWebpageAsPdfTool(),
+        new ScrollPageTool_1.ScrollPageTool(),
+        new SetRunModeTool_1.SetRunModeTool(),
+        new SummarizeLearningsTool_1.SummarizeLearningsTool(),
+        new TriggerDonobuFlowTool_1.TriggerDonobuFlowTool(),
+        new WaitTool_1.WaitTool(),
+    ];
+    static DEFAULT_TOOLS = [
+        new AnalyzePageTextTool_1.AnalyzePageTextTool(),
+        new AssertTool_1.AssertTool(),
+        new CreateBrowserCookieReportTool_1.CreateBrowserCookieReportTool(),
+        new ChangeWebBrowserTabTool_1.ChangeWebBrowserTabTool(),
+        new ChooseSelectOptionTool_1.ChooseSelectOptionTool(),
+        new ClickTool_1.ClickTool(),
+        new DetectBrokenLinksTool_1.DetectBrokenLinksTool(),
+        new GoForwardOrBackTool_1.GoForwardOrBackTool(),
+        new GoToWebpageTool_1.GoToWebpageTool(),
+        new HandleBrowserDialogTool_1.HandleBrowserDialogTool(),
+        new HoverOverElementTool_1.HoverOverElementTool(),
+        new InputRandomizedEmailAddressTool_1.InputRandomizedEmailAddressTool(),
+        new InputTextTool_1.InputTextTool(),
+        new MakeCommentTool_1.MakeCommentTool(),
+        new MarkObjectiveCompleteTool_1.MarkObjectiveCompleteTool(),
+        new MarkObjectiveNotCompletableTool_1.MarkObjectiveNotCompletableTool(),
+        new PauseForUserInteractionTool_1.PauseForUserInteractionTool(),
+        new PressKeyTool_1.PressKeyTool(),
+        new RunAccessibilityTestTool_1.RunAccessibilityTestTool(),
+        new SetRunModeTool_1.SetRunModeTool(),
+        new ScrollPageTool_1.ScrollPageTool(),
+        new SummarizeLearningsTool_1.SummarizeLearningsTool(),
+    ];
+    constructor(tools) {
+        this.tools = tools;
+        this.tools = tools;
+    }
+    async invokeTool(context, proposedToolCall, isFromGpt) {
+        const page = context.page;
+        const startedAt = new Date().getTime();
+        const initialPageUrl = page.url();
+        ToolManager.logger.info(`Taking action: ${proposedToolCall.name}`);
+        let toolCallResult;
+        try {
+            const tool = this.tools.find((t) => t.name === proposedToolCall.name);
+            toolCallResult = tool
+                ? await this.executeToolCall(tool, context, proposedToolCall, page, isFromGpt)
+                : {
+                    isSuccessful: false,
+                    forLlm: `FAILED! No tool named '${proposedToolCall.name}' found.`,
+                    metadata: null,
+                };
+        }
+        catch (error) {
+            ToolManager.logger.error(`Exception while calling the ${proposedToolCall.name} tool with parameters ${JSON.stringify(proposedToolCall.parameters)}`, error);
+            toolCallResult = {
+                isSuccessful: false,
+                forLlm: `FAILED! ${typeof error}: ${error.message}`,
+                metadata: null,
+            };
+        }
+        const postCallImage = await PlaywrightUtils_1.PlaywrightUtils.takePngScreenshot(page);
+        const postCallImageId = await context.persistence.savePngScreenShot(context.metadata.id, postCallImage);
+        ToolManager.logger.info(`The ${proposedToolCall.name} tool completed with outcome ${JSON.stringify(toolCallResult)}`);
+        const endedAt = new Date().getTime();
+        return {
+            id: context.toolCallId,
+            toolName: proposedToolCall.name,
+            parameters: proposedToolCall.parameters,
+            outcome: toolCallResult,
+            postCallImageId: postCallImageId,
+            page: initialPageUrl,
+            startedAt: startedAt,
+            completedAt: endedAt,
+        };
+    }
+    async executeToolCall(tool, context, proposedToolCall, page, isFromGpt) {
+        const flowMetadata = context.metadata;
+        if (flowMetadata.isControlPanelEnabled) {
+            await PlaywrightUtils_1.PlaywrightUtils.updateControlPanel(page, flowMetadata, tool.controlPanelMessage);
+        }
+        try {
+            if (tool.requiresGpt && !context.gptClient) {
+                const exception = new ToolRequiresGptException_1.ToolRequiresGptException(tool.name);
+                return {
+                    isSuccessful: false,
+                    forLlm: exception.userFacingMessage,
+                    metadata: JsonUtils_1.JsonUtils.objectToJson(exception),
+                };
+            }
+            else {
+                return isFromGpt
+                    ? await tool.callFromGpt(context, proposedToolCall.parameters)
+                    : await tool.call(context, proposedToolCall.parameters);
+            }
+        }
+        catch (error) {
+            if (PlaywrightUtils_1.PlaywrightUtils.isPageClosedError(error)) {
+                return {
+                    isSuccessful: false,
+                    forLlm: `FAILED! This tool call failed because the webpage in which this operation was being formed had closed.`,
+                    metadata: null,
+                };
+            }
+            else if (error instanceof Error) {
+                ToolManager.logger.error(`Exception while calling the ${proposedToolCall.name} tool with parameters ${JSON.stringify(proposedToolCall.parameters)}: ${error.message}`, error);
+                return {
+                    isSuccessful: false,
+                    forLlm: `FAILED! ${error.constructor.name}: ${error.message}`,
+                    metadata: null,
+                };
+            }
+            throw error;
+        }
+    }
+    /**
+     * Maps a proposed Donobu tool call to valid NodeJS Playwright code that uses
+     * the `DonobuExtendedPage` extension.
+     */
+    convertToPlaywrightCode(proposedToolCall) {
+        const rawParams = JsonUtils_1.JsonUtils.objectToJson(proposedToolCall.parameters);
+        const rationale = rawParams.rationale
+            ? '// ' + rawParams.rationale + '\n'
+            : '';
+        // Delete fields that should not be directly mapped.
+        delete rawParams.rationale;
+        delete rawParams.whyThisAnnotation;
+        delete rawParams.annotation;
+        const hasNonEmptyParameters = Object.keys(rawParams).length > 0;
+        // Used JSON5 to stringify instead of JSON so that object properties do not
+        // get double-quoted (this makes the code look more natural for NodeJS).
+        const serializedParams = json5_1.default.stringify(rawParams, null, 2);
+        switch (proposedToolCall.name) {
+            case AssertTool_1.AssertTool.NAME: {
+                return `${rationale}await page.visuallyAssert(${serializedParams});`;
+            }
+            case ChangeWebBrowserTabTool_1.ChangeWebBrowserTabTool.NAME: {
+                return `${rationale}page = page.context().pages().find((tab) => tab.url() === '${rawParams.tabUrl}');`;
+            }
+            case ChooseSelectOptionTool_1.ChooseSelectOptionTool.NAME: {
+                return `${rationale}await page.chooseSelectOption(${serializedParams});`;
+            }
+            case ClickTool_1.ClickTool.NAME: {
+                return `${rationale}await page.clickElement(${serializedParams});`;
+            }
+            case GoForwardOrBackTool_1.GoForwardOrBackTool.NAME:
+                if (rawParams.direction === 'FORWARD') {
+                    return `${rationale}await page.goForward();`;
+                }
+                else if (rawParams.direction === 'BACK') {
+                    return `${rationale}await page.goBack();`;
+                }
+                else {
+                    throw new Error(`Invalid ${GoForwardOrBackTool_1.GoForwardOrBackTool.NAME} params: ${serializedParams}`);
+                }
+            case GoToWebpageTool_1.GoToWebpageTool.NAME:
+                return `${rationale}await page.goto('${rawParams.url}');`;
+            case ReloadPageTool_1.ReloadPageTool.NAME:
+                return `${rationale}await page.reload();`;
+            case ScrollPageTool_1.ScrollPageTool.NAME:
+                return `${rationale}await page.scroll(${serializedParams});`;
+            // The following tools can be mapped directly.
+            case CreateBrowserCookieReportTool_1.CreateBrowserCookieReportTool.NAME:
+            case DetectBrokenLinksTool_1.DetectBrokenLinksTool.NAME:
+            case HoverOverElementTool_1.HoverOverElementTool.NAME:
+            case InputRandomizedEmailAddressTool_1.InputRandomizedEmailAddressTool.NAME:
+            case InputTextTool_1.InputTextTool.NAME:
+            case PressKeyTool_1.PressKeyTool.NAME:
+            case RunAccessibilityTestTool_1.RunAccessibilityTestTool.NAME: {
+                return `${rationale}await page.${proposedToolCall.name}(${hasNonEmptyParameters ? serializedParams : ''});`;
+            }
+            default:
+                const toolName = proposedToolCall.name;
+                const toolCallScript = hasNonEmptyParameters
+                    ? `${rationale}await page.run('${toolName}', ${serializedParams});`
+                    : `${rationale}await page.run('${toolName}');`;
+                return toolCallScript;
+        }
+    }
+}
+exports.ToolManager = ToolManager;
+//# sourceMappingURL=ToolManager.js.map

package/dist/managers/ToolManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolManager.js","sourceRoot":"","sources":["../../src/managers/ToolManager.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAyC;AACzC,8DAA2D;AAC3D,qFAAkF;AAOlF,4EAAyE;AACzE,kDAA+C;AAC/C,8EAA2E;AAC3E,8FAA2F;AAC3F,kFAA+E;AAC/E,8DAA2D;AAC3D,wDAAqD;AACrD,gFAA6E;AAC7E,4DAAyD;AACzD,oDAAiD;AACjD,0DAAuD;AACvD,sEAAmE;AACnE,0FAAuF;AACvF,8FAA2F;AAC3F,sFAAmF;AACnF,4FAAyF;AACzF,4EAAyE;AACzE,0EAAuE;AACvE,8EAA2E;AAC3E,wGAAqG;AACrG,0GAAuG;AACvG,0FAAuF;AACvF,sGAAmG;AACnG,gGAAiG;AACjG,sEAAmE;AACnE,wFAAqF;AACrF,8DAA2D;AAC3D,gFAAiF;AACjF,sFAAmF;AACnF,4DAAyD;AACzD,wEAAqE;AACrE,4DAAyD;AACzD,8DAA2D;AAC3D,gDAA6C;AAC7C,wEAAqE;AACrE,0EAAuE;AACvE,kDAA+C;AAC/C,kDAA0B;AAE1B;;GAEG;AACH,MAAa,WAAW;IAkEM;IAjEpB,MAAM,CAAU,MAAM,GAAG,eAAM,CAAC,SAAS,CAAC;IAE3C,MAAM,CAAU,SAAS,GAAqB;QACnD,IAAI,yCAAmB,EAAE;QACzB,IAAI,uBAAU,EAAE;QAChB,IAAI,6DAA6B,EAAE;QACnC,IAAI,iDAAuB,EAAE;QAC7B,IAAI,+CAAsB,EAAE;QAC5B,IAAI,qBAAS,EAAE;QACf,IAAI,iCAAe,EAAE;QACrB,IAAI,6EAAqC,EAAE;QAC3C,IAAI,6DAA6B,EAAE;QACnC,IAAI,yEAAmC,EAAE;QACzC,IAAI,6CAAqB,EAAE;QAC3B,IAAI,uEAAoC,EAAE;QAC1C,IAAI,yCAAmB,EAAE;QACzB,IAAI,2DAA4B,EAAE;QAClC,IAAI,iCAAe,EAAE;QACrB,IAAI,iDAAuB,EAAE;QAC7B,IAAI,2CAAoB,EAAE;QAC1B,IAAI,iEAA+B,EAAE;QACrC,IAAI,6BAAa,EAAE;QACnB,IAAI,iCAAe,EAAE;QACrB,IAAI,uDAA4B,EAAE;QAClC,IAAI,qDAAyB,EAAE;QAC/B,IAAI,iEAA+B,EAAE;QACrC,IAAI,yDAA2B,EAAE;QACjC,IAAI,2EAAoC,EAAE;QAC1C,IAAI,2BAAY,EAAE;QAClB,IAAI,+BAAc,EAAE;QACpB,IAAI,mDAAwB,EAAE;QAC9B,IAAI,yDAA2B,EAAE;QACjC,IAAI,+DAA8B,EAAE;QACpC,IAAI,2CAAoB,EAAE;QAC1B,IAAI,+BAAc,EAAE;QACpB,IAAI,+BAAc,EAAE;QACpB,IAAI,+CAAsB,EAAE;QAC5B,IAAI,6CAAqB,EAAE;QAC3B,IAAI,mBAAQ,EAAE;KACf,CAAC;IACK,MAAM,CAAU,aAAa,GAAqB;QACvD,IAAI,yCAAmB,EAAE;QACzB,IAAI,uBAAU,EAAE;QAChB,IAAI,6DAA6B,EAAE;QACnC,IAAI,iDAAuB,EAAE;QAC7B,IAAI,+CAAsB,EAAE;QAC5B,IAAI,qBAAS,EAAE;QACf,IAAI,6CAAqB,EAAE;QAC3B,IAAI,yCAAmB,EAAE;QACzB,IAAI,iCAAe,EAAE;QACrB,IAAI,iDAAuB,EAAE;QAC7B,IAAI,2CAAoB,EAAE;QAC1B,IAAI,iEAA+B,EAAE;QACrC,IAAI,6BAAa,EAAE;QACnB,IAAI,iCAAe,EAAE;QACrB,IAAI,qDAAyB,EAAE;QAC/B,IAAI,iEAA+B,EAAE;QACrC,IAAI,yDAA2B,EAAE;QACjC,IAAI,2BAAY,EAAE;QAClB,IAAI,mDAAwB,EAAE;QAC9B,IAAI,+BAAc,EAAE;QACpB,IAAI,+BAAc,EAAE;QACpB,IAAI,+CAAsB,EAAE;KAC7B,CAAC;IAEF,YAA4B,KAAuB;QAAvB,UAAK,GAAL,KAAK,CAAkB;QACjD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEM,KAAK,CAAC,UAAU,CACrB,OAAwB,EACxB,gBAAuC,EACvC,SAAkB;QAElB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QAC1B,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QACvC,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAElC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,gBAAgB,CAAC,IAAI,EAAE,CAAC,CAAC;QAEnE,IAAI,cAAc,CAAC;QAEnB,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC,IAAI,CAAC,CAAC;YACtE,cAAc,GAAG,IAAI;gBACnB,CAAC,CAAC,MAAM,IAAI,CAAC,eAAe,CACxB,IAAI,EACJ,OAAO,EACP,gBAAgB,EAChB,IAAI,EACJ,SAAS,CACV;gBACH,CAAC,CAAE;oBACC,YAAY,EAAE,KAAK;oBACnB,MAAM,EAAE,0BAA0B,gBAAgB,CAAC,IAAI,UAAU;oBACjE,QAAQ,EAAE,IAAI;iBACW,CAAC;QAClC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,WAAW,CAAC,MAAM,CAAC,KAAK,CACtB,+BAA+B,gBAAgB,CAAC,IAAI,yBAAyB,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,EAC1H,KAAK,CACN,CAAC;YACF,cAAc,GAAG;gBACf,YAAY,EAAE,KAAK;gBACnB,MAAM,EAAE,WAAW,OAAO,KAAK,KAAM,KAAa,CAAC,OAAO,EAAE;gBAC5D,QAAQ,EAAE,IAAI;aACU,CAAC;QAC7B,CAAC;QAED,MAAM,aAAa,GAAG,MAAM,iCAAe,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACpE,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,iBAAiB,CACjE,OAAO,CAAC,QAAQ,CAAC,EAAE,EACnB,aAAa,CACd,CAAC;QAEF,WAAW,CAAC,MAAM,CAAC,IAAI,CACrB,OAAO,gBAAgB,CAAC,IAAI,gCAAgC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAC7F,CAAC;QAEF,MAAM,OAAO,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAErC,OAAO;YACL,EAAE,EAAE,OAAO,CAAC,UAAU;YACtB,QAAQ,EAAE,gBAAgB,CAAC,IAAI;YAC/B,UAAU,EAAE,gBAAgB,CAAC,UAAU;YACvC,OAAO,EAAE,cAAc;YACvB,eAAe,EAAE,eAAe;YAChC,IAAI,EAAE,cAAc;YACpB,SAAS,EAAE,SAAS;YACpB,WAAW,EAAE,OAAO;SACF,CAAC;IACvB,CAAC;IAEO,KAAK,CAAC,eAAe,CAC3B,IAAoB,EACpB,OAAwB,EACxB,gBAAuC,EACvC,IAAU,EACV,SAAkB;QAElB,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC;QAEtC,IAAI,YAAY,CAAC,qBAAqB,EAAE,CAAC;YACvC,MAAM,iCAAe,CAAC,kBAAkB,CACtC,IAAI,EACJ,YAAY,EACZ,IAAI,CAAC,mBAAmB,CACzB,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACH,IAAI,IAAI,CAAC,WAAW,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;gBAC3C,MAAM,SAAS,GAAG,IAAI,mDAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC1D,OAAO;oBACL,YAAY,EAAE,KAAK;oBACnB,MAAM,EAAE,SAAS,CAAC,iBAAiB;oBACnC,QAAQ,EAAE,qBAAS,CAAC,YAAY,CAAC,SAAS,CAAC;iBAC5C,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,SAAS;oBACd,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,gBAAgB,CAAC,UAAU,CAAC;oBAC9D,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,iCAAe,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC7C,OAAO;oBACL,YAAY,EAAE,KAAK;oBACnB,MAAM,EAAE,wGAAwG;oBAChH,QAAQ,EAAE,IAAI;iBACU,CAAC;YAC7B,CAAC;iBAAM,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBAClC,WAAW,CAAC,MAAM,CAAC,KAAK,CACtB,+BAA+B,gBAAgB,CAAC,IAAI,yBAAyB,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,UAAU,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,EAC5I,KAAK,CACN,CAAC;gBACF,OAAO;oBACL,YAAY,EAAE,KAAK;oBACnB,MAAM,EAAE,WAAW,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE;oBAC7D,QAAQ,EAAE,IAAI;iBACU,CAAC;YAC7B,CAAC;YAED,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,uBAAuB,CAC5B,gBAAuC;QAEvC,MAAM,SAAS,GAAG,qBAAS,CAAC,YAAY,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACtE,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS;YACnC,CAAC,CAAC,KAAK,GAAG,SAAS,CAAC,SAAS,GAAG,IAAI;YACpC,CAAC,CAAC,EAAE,CAAC;QACP,oDAAoD;QACpD,OAAO,SAAS,CAAC,SAAS,CAAC;QAC3B,OAAO,SAAS,CAAC,iBAAiB,CAAC;QACnC,OAAO,SAAS,CAAC,UAAU,CAAC;QAC5B,MAAM,qBAAqB,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;QAChE,2EAA2E;QAC3E,wEAAwE;QACxE,MAAM,gBAAgB,GAAG,eAAK,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAE7D,QAAQ,gBAAgB,CAAC,IAAI,EAAE,CAAC;YAC9B,KAAK,uBAAU,CAAC,IAAI,CAAC,CAAC,CAAC;gBACrB,OAAO,GAAG,SAAS,6BAA6B,gBAAgB,IAAI,CAAC;YACvE,CAAC;YACD,KAAK,iDAAuB,CAAC,IAAI,CAAC,CAAC,CAAC;gBAClC,OAAO,GAAG,SAAS,8DAA8D,SAAS,CAAC,MAAM,KAAK,CAAC;YACzG,CAAC;YACD,KAAK,+CAAsB,CAAC,IAAI,CAAC,CAAC,CAAC;gBACjC,OAAO,GAAG,SAAS,iCAAiC,gBAAgB,IAAI,CAAC;YAC3E,CAAC;YACD,KAAK,qBAAS,CAAC,IAAI,CAAC,CAAC,CAAC;gBACpB,OAAO,GAAG,SAAS,2BAA2B,gBAAgB,IAAI,CAAC;YACrE,CAAC;YACD,KAAK,yCAAmB,CAAC,IAAI;gBAC3B,IAAI,SAAS,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;oBACtC,OAAO,GAAG,SAAS,yBAAyB,CAAC;gBAC/C,CAAC;qBAAM,IAAI,SAAS,CAAC,SAAS,KAAK,MAAM,EAAE,CAAC;oBAC1C,OAAO,GAAG,SAAS,sBAAsB,CAAC;gBAC5C,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CACb,WAAW,yCAAmB,CAAC,IAAI,YAAY,gBAAgB,EAAE,CAClE,CAAC;gBACJ,CAAC;YACH,KAAK,iCAAe,CAAC,IAAI;gBACvB,OAAO,GAAG,SAAS,oBAAoB,SAAS,CAAC,GAAG,KAAK,CAAC;YAC5D,KAAK,+BAAc,CAAC,IAAI;gBACtB,OAAO,GAAG,SAAS,sBAAsB,CAAC;YAC5C,KAAK,+BAAc,CAAC,IAAI;gBACtB,OAAO,GAAG,SAAS,qBAAqB,gBAAgB,IAAI,CAAC;YAC/D,8CAA8C;YAC9C,KAAK,6DAA6B,CAAC,IAAI,CAAC;YACxC,KAAK,6CAAqB,CAAC,IAAI,CAAC;YAChC,KAAK,2CAAoB,CAAC,IAAI,CAAC;YAC/B,KAAK,iEAA+B,CAAC,IAAI,CAAC;YAC1C,KAAK,6BAAa,CAAC,IAAI,CAAC;YACxB,KAAK,2BAAY,CAAC,IAAI,CAAC;YACvB,KAAK,mDAAwB,CAAC,IAAI,CAAC,CAAC,CAAC;gBACnC,OAAO,GAAG,SAAS,cAAc,gBAAgB,CAAC,IAAI,IAAI,qBAAqB,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;YAC9G,CAAC;YACD;gBACE,MAAM,QAAQ,GAAG,gBAAgB,CAAC,IAAI,CAAC;gBACvC,MAAM,cAAc,GAAG,qBAAqB;oBAC1C,CAAC,CAAC,GAAG,SAAS,mBAAmB,QAAQ,MAAM,gBAAgB,IAAI;oBACnE,CAAC,CAAC,GAAG,SAAS,mBAAmB,QAAQ,KAAK,CAAC;gBACjD,OAAO,cAAc,CAAC;QAC1B,CAAC;IACH,CAAC;;AA7PH,kCA8PC"}

package/dist/managers/ToolTipper.d.ts

@@ -0,0 +1,35 @@
+import { Page, Locator } from 'playwright';
+export declare class ToolTipper {
+    readonly defaultDuration: number;
+    private static readonly logger;
+    constructor(defaultDuration: number);
+    /**
+     * Show the given tooltip text in the top-left corner of the page for the given duration.
+     * If duration <= 0 or toolTip is empty, does nothing. Blocks execution for the duration.
+     */
+    blipToolTip(page: Page, toolTip: string, duration?: number): Promise<void>;
+    /**
+     * Show the given tooltip text visually adjacent to the given element for the given duration.
+     * Blocks execution for the duration.
+     */
+    blipToolTipAtElement(page: Page, element: Locator, toolTip: string, duration?: number): Promise<void>;
+    /**
+     * Creates a tooltip in the top-left corner, inside a shadow root to avoid CSS collisions.
+     * Returns the tooltip's unique ID.
+     */
+    private displayToolTip;
+    /**
+     * Creates a tooltip adjacent to the element, inside a shadow root to avoid CSS collisions.
+     * Returns the tooltip's unique ID.
+     */
+    private displayToolTipForElement;
+    /**
+     * Removes the tooltip with the given ID from the shadow root (top-level).
+     */
+    private static removeElementById;
+    /**
+     * Same as removeElementById but uses the element's frame context
+     * in case the tooltip was created via that element's evaluate call.
+     */
+    private static useElementToRemoveElementById;
+}

package/dist/managers/ToolTipper.js

@@ -0,0 +1,201 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolTipper = void 0;
+const Logger_1 = require("../utils/Logger");
+class ToolTipper {
+    defaultDuration;
+    static logger = Logger_1.Logger.appLogger;
+    constructor(defaultDuration) {
+        this.defaultDuration = defaultDuration;
+    }
+    /**
+     * Show the given tooltip text in the top-left corner of the page for the given duration.
+     * If duration <= 0 or toolTip is empty, does nothing. Blocks execution for the duration.
+     */
+    async blipToolTip(page, toolTip, duration = this.defaultDuration) {
+        if (!toolTip.trim() || !duration || duration <= 0) {
+            return;
+        }
+        try {
+            const toolTipId = await this.displayToolTip(page, toolTip);
+            await page.waitForTimeout(duration);
+            await ToolTipper.removeElementById(page, toolTipId);
+        }
+        catch (e) {
+            ToolTipper.logger.error('Failed to display tooltip at top-left corner', e);
+        }
+    }
+    /**
+     * Show the given tooltip text visually adjacent to the given element for the given duration.
+     * Blocks execution for the duration.
+     */
+    async blipToolTipAtElement(page, element, toolTip, duration = this.defaultDuration) {
+        if (!toolTip.trim() || !duration || duration <= 0) {
+            return;
+        }
+        try {
+            const toolTipId = await this.displayToolTipForElement(element, toolTip);
+            await page.waitForTimeout(duration);
+            await ToolTipper.useElementToRemoveElementById(element, toolTipId);
+        }
+        catch (e) {
+            ToolTipper.logger.error('Failed to display tooltip at element', e);
+        }
+    }
+    /**
+     * Creates a tooltip in the top-left corner, inside a shadow root to avoid CSS collisions.
+     * Returns the tooltip's unique ID.
+     */
+    async displayToolTip(page, toolTip) {
+        const toolTipId = `tool-tip-${crypto.randomUUID()}`;
+        await page.evaluate(([toolTipId, toolTip]) => {
+            // 1) Find or create the container in the main document
+            let container = document.getElementById('tool-tip-shadow-container');
+            if (!container) {
+                container = document.createElement('div');
+                container.id = 'tool-tip-shadow-container';
+                // Absolutely position so child tooltips can use absolute coords
+                container.style.position = 'absolute';
+                container.style.top = '0';
+                container.style.left = '0';
+                container.style.width = '100%';
+                container.style.height = '100%';
+                container.style.pointerEvents = 'none'; // let clicks pass through
+                document.body.appendChild(container);
+                const shadowRoot = container.attachShadow({ mode: 'open' });
+                // Insert style to reset everything in the shadow root & define .tooltip
+                const styleEl = document.createElement('style');
+                styleEl.textContent = `
+            :host {
+              all: initial; /* Reset inherited styles */
+            }
+            .tooltip {
+              z-index: 2147483647; /* Very high to float above overlays */
+              background-color: black;
+              color: white;
+              padding: 8px;
+              border-radius: 5px;
+              font-size: 12px;
+              font-family: 'Source Sans Pro', 'Helvetica Neue', Helvetica, Arial, sans-serif;
+              display: block; /* visible once inserted */
+              max-width: 300px;
+              white-space: pre-wrap;
+              box-shadow: 2px 2px 10px rgba(0,0,0,0.2);
+              position: absolute;
+            }
+          `;
+                shadowRoot.appendChild(styleEl);
+            }
+            // 2) Insert the tooltip into the shadow root
+            const shadow = container.shadowRoot;
+            const tooltipElement = document.createElement('div');
+            tooltipElement.id = toolTipId;
+            tooltipElement.className = 'tooltip';
+            tooltipElement.textContent = toolTip;
+            // Position top-left
+            tooltipElement.style.left = '10px';
+            tooltipElement.style.top = '10px';
+            shadow.appendChild(tooltipElement);
+        }, [toolTipId, toolTip]);
+        return toolTipId;
+    }
+    /**
+     * Creates a tooltip adjacent to the element, inside a shadow root to avoid CSS collisions.
+     * Returns the tooltip's unique ID.
+     */
+    async displayToolTipForElement(element, toolTip) {
+        const toolTipId = `tool-tip-${crypto.randomUUID()}`;
+        await element.evaluate((targetElement, [toolTipId, toolTip]) => {
+            // 1) Find or create the container
+            let container = document.getElementById('tool-tip-shadow-container');
+            if (!container) {
+                container = document.createElement('div');
+                container.id = 'tool-tip-shadow-container';
+                container.style.position = 'absolute';
+                container.style.top = '0';
+                container.style.left = '0';
+                container.style.width = '100%';
+                container.style.height = '100%';
+                container.style.pointerEvents = 'none';
+                document.body.appendChild(container);
+                const shadowRoot = container.attachShadow({ mode: 'open' });
+                // Insert style
+                const styleEl = document.createElement('style');
+                styleEl.textContent = `
+            :host { all: initial; }
+            .tooltip {
+              z-index: 2147483647;
+              background-color: black;
+              color: white;
+              padding: 8px;
+              border-radius: 5px;
+              font-size: 12px;
+              font-family: 'Source Sans Pro', 'Helvetica Neue', Helvetica, Arial, sans-serif;
+              display: block;
+              max-width: 300px;
+              white-space: pre-wrap;
+              box-shadow: 2px 2px 10px rgba(0,0,0,0.2);
+              position: absolute;
+            }
+          `;
+                shadowRoot.appendChild(styleEl);
+            }
+            // 2) Insert tooltip
+            const shadow = container.shadowRoot;
+            const tooltipElement = document.createElement('div');
+            tooltipElement.id = toolTipId;
+            tooltipElement.className = 'tooltip';
+            tooltipElement.textContent = toolTip;
+            // Temporarily place off-screen to measure size
+            tooltipElement.style.left = '-9999px';
+            tooltipElement.style.top = '-9999px';
+            shadow.appendChild(tooltipElement);
+            // 3) Compute final position
+            const rect = targetElement.getBoundingClientRect();
+            let x = rect.left + window.scrollX;
+            let y = rect.bottom + window.scrollY + 10;
+            tooltipElement.style.left = `${x}px`;
+            tooltipElement.style.top = `${y}px`;
+            // Adjust if it goes off-screen to the right
+            const tipRect = tooltipElement.getBoundingClientRect();
+            const overflowRight = tipRect.right - window.innerWidth;
+            if (overflowRight > 0) {
+                tooltipElement.style.left = `${x - overflowRight - 10}px`;
+            }
+            // Adjust if it goes off-screen to the left
+            if (tipRect.left < 0) {
+                tooltipElement.style.left = `${window.scrollX + 10}px`;
+            }
+        }, [toolTipId, toolTip]);
+        return toolTipId;
+    }
+    /**
+     * Removes the tooltip with the given ID from the shadow root (top-level).
+     */
+    static async removeElementById(page, elementId) {
+        await page.evaluate((elementId) => {
+            const container = document.getElementById('tool-tip-shadow-container');
+            if (!container || !container.shadowRoot)
+                return;
+            const el = container.shadowRoot.getElementById(elementId);
+            if (el)
+                el.remove();
+        }, elementId);
+    }
+    /**
+     * Same as removeElementById but uses the element's frame context
+     * in case the tooltip was created via that element's evaluate call.
+     */
+    static async useElementToRemoveElementById(element, elementId) {
+        await element.evaluate((_, elementId) => {
+            const container = document.getElementById('tool-tip-shadow-container');
+            if (!container || !container.shadowRoot)
+                return;
+            const el = container.shadowRoot.getElementById(elementId);
+            if (el)
+                el.remove();
+        }, elementId);
+    }
+}
+exports.ToolTipper = ToolTipper;
+//# sourceMappingURL=ToolTipper.js.map

package/dist/managers/ToolTipper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolTipper.js","sourceRoot":"","sources":["../../src/managers/ToolTipper.ts"],"names":[],"mappings":";;;AACA,4CAAyC;AAEzC,MAAa,UAAU;IAIH;IAHV,MAAM,CAAU,MAAM,GAAG,eAAM,CAAC,SAAS,CAAC;IAElD,YACkB,eAAuB;QAAvB,oBAAe,GAAf,eAAe,CAAQ;IACtC,CAAC;IAEJ;;;OAGG;IACI,KAAK,CAAC,WAAW,CACtB,IAAU,EACV,OAAe,EACf,WAAmB,IAAI,CAAC,eAAe;QAEvC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,IAAI,QAAQ,IAAI,CAAC,EAAE,CAAC;YAClD,OAAO;QACT,CAAC;QACD,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAC3D,MAAM,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;YACpC,MAAM,UAAU,CAAC,iBAAiB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACtD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,UAAU,CAAC,MAAM,CAAC,KAAK,CACrB,8CAA8C,EAC9C,CAAC,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,oBAAoB,CAC/B,IAAU,EACV,OAAgB,EAChB,OAAe,EACf,WAAmB,IAAI,CAAC,eAAe;QAEvC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,IAAI,QAAQ,IAAI,CAAC,EAAE,CAAC;YAClD,OAAO;QACT,CAAC;QACD,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACxE,MAAM,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;YACpC,MAAM,UAAU,CAAC,6BAA6B,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACrE,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,sCAAsC,EAAE,CAAC,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,cAAc,CAAC,IAAU,EAAE,OAAe;QACtD,MAAM,SAAS,GAAG,YAAY,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;QACpD,MAAM,IAAI,CAAC,QAAQ,CACjB,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,EAAE;YACvB,uDAAuD;YACvD,IAAI,SAAS,GAAG,QAAQ,CAAC,cAAc,CAAC,2BAA2B,CAAC,CAAC;YACrE,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,SAAS,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;gBAC1C,SAAS,CAAC,EAAE,GAAG,2BAA2B,CAAC;gBAC3C,gEAAgE;gBAChE,SAAS,CAAC,KAAK,CAAC,QAAQ,GAAG,UAAU,CAAC;gBACtC,SAAS,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC;gBAC1B,SAAS,CAAC,KAAK,CAAC,IAAI,GAAG,GAAG,CAAC;gBAC3B,SAAS,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC;gBAC/B,SAAS,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;gBAChC,SAAS,CAAC,KAAK,CAAC,aAAa,GAAG,MAAM,CAAC,CAAC,0BAA0B;gBAClE,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;gBAErC,MAAM,UAAU,GAAG,SAAS,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;gBAE5D,wEAAwE;gBACxE,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBAChD,OAAO,CAAC,WAAW,GAAG;;;;;;;;;;;;;;;;;;WAkBrB,CAAC;gBACF,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YAClC,CAAC;YAED,6CAA6C;YAC7C,MAAM,MAAM,GAAI,SAA4B,CAAC,UAAW,CAAC;YACzD,MAAM,cAAc,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACrD,cAAc,CAAC,EAAE,GAAG,SAAS,CAAC;YAC9B,cAAc,CAAC,SAAS,GAAG,SAAS,CAAC;YACrC,cAAc,CAAC,WAAW,GAAG,OAAO,CAAC;YAErC,oBAAoB;YACpB,cAAc,CAAC,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC;YACnC,cAAc,CAAC,KAAK,CAAC,GAAG,GAAG,MAAM,CAAC;YAElC,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;QACrC,CAAC,EACD,CAAC,SAAS,EAAE,OAAO,CAAC,CACrB,CAAC;QACF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,wBAAwB,CACpC,OAAgB,EAChB,OAAe;QAEf,MAAM,SAAS,GAAG,YAAY,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;QACpD,MAAM,OAAO,CAAC,QAAQ,CACpB,CAAC,aAAa,EAAE,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,EAAE;YACtC,kCAAkC;YAClC,IAAI,SAAS,GAAG,QAAQ,CAAC,cAAc,CAAC,2BAA2B,CAAC,CAAC;YACrE,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,SAAS,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;gBAC1C,SAAS,CAAC,EAAE,GAAG,2BAA2B,CAAC;gBAC3C,SAAS,CAAC,KAAK,CAAC,QAAQ,GAAG,UAAU,CAAC;gBACtC,SAAS,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC;gBAC1B,SAAS,CAAC,KAAK,CAAC,IAAI,GAAG,GAAG,CAAC;gBAC3B,SAAS,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC;gBAC/B,SAAS,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;gBAChC,SAAS,CAAC,KAAK,CAAC,aAAa,GAAG,MAAM,CAAC;gBACvC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;gBAErC,MAAM,UAAU,GAAG,SAAS,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;gBAE5D,eAAe;gBACf,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBAChD,OAAO,CAAC,WAAW,GAAG;;;;;;;;;;;;;;;;WAgBrB,CAAC;gBACF,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YAClC,CAAC;YAED,oBAAoB;YACpB,MAAM,MAAM,GAAI,SAA4B,CAAC,UAAW,CAAC;YACzD,MAAM,cAAc,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACrD,cAAc,CAAC,EAAE,GAAG,SAAS,CAAC;YAC9B,cAAc,CAAC,SAAS,GAAG,SAAS,CAAC;YACrC,cAAc,CAAC,WAAW,GAAG,OAAO,CAAC;YAErC,+CAA+C;YAC/C,cAAc,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;YACtC,cAAc,CAAC,KAAK,CAAC,GAAG,GAAG,SAAS,CAAC;YAErC,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;YAEnC,4BAA4B;YAC5B,MAAM,IAAI,GAAI,aAAyB,CAAC,qBAAqB,EAAE,CAAC;YAChE,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC;YACnC,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;YAE1C,cAAc,CAAC,KAAK,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;YACrC,cAAc,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC;YAEpC,4CAA4C;YAC5C,MAAM,OAAO,GAAG,cAAc,CAAC,qBAAqB,EAAE,CAAC;YACvD,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC;YACxD,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;gBACtB,cAAc,CAAC,KAAK,CAAC,IAAI,GAAG,GAAG,CAAC,GAAG,aAAa,GAAG,EAAE,IAAI,CAAC;YAC5D,CAAC;YACD,2CAA2C;YAC3C,IAAI,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;gBACrB,cAAc,CAAC,KAAK,CAAC,IAAI,GAAG,GAAG,MAAM,CAAC,OAAO,GAAG,EAAE,IAAI,CAAC;YACzD,CAAC;QACH,CAAC,EACD,CAAC,SAAS,EAAE,OAAO,CAAC,CACrB,CAAC;QACF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,KAAK,CAAC,iBAAiB,CACpC,IAAU,EACV,SAAiB;QAEjB,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,SAAS,EAAE,EAAE;YAChC,MAAM,SAAS,GAAG,QAAQ,CAAC,cAAc,CAAC,2BAA2B,CAAC,CAAC;YACvE,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,UAAU;gBAAE,OAAO;YAChD,MAAM,EAAE,GAAG,SAAS,CAAC,UAAU,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;YAC1D,IAAI,EAAE;gBAAE,EAAE,CAAC,MAAM,EAAE,CAAC;QACtB,CAAC,EAAE,SAAS,CAAC,CAAC;IAChB,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAChD,OAAgB,EAChB,SAAiB;QAEjB,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE;YACtC,MAAM,SAAS,GAAG,QAAQ,CAAC,cAAc,CAAC,2BAA2B,CAAC,CAAC;YACvE,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,UAAU;gBAAE,OAAO;YAChD,MAAM,EAAE,GAAG,SAAS,CAAC,UAAU,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;YAC1D,IAAI,EAAE;gBAAE,EAAE,CAAC,MAAM,EAAE,CAAC;QACtB,CAAC,EAAE,SAAS,CAAC,CAAC;IAChB,CAAC;;AAzOH,gCA0OC"}

package/dist/models/AskAiRequest.d.ts

@@ -0,0 +1,14 @@
+import { JSONSchema7 } from 'json-schema';
+export type AskAiRequest = {
+    /**
+     * The prompt to use with the AI to generate a response from.
+     */
+    readonly prompt: string;
+    /**
+     * The name of a specific GPT configuration to use. If this is not defined,
+     * the default agent configuration will be used.
+     **/
+    readonly gptConfigNameOverride?: string;
+    /** If non-null, will attempt to respond using this JSON-schema. */
+    readonly resultJsonSchema?: JSONSchema7;
+};

package/dist/models/AskAiRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=AskAiRequest.js.map

package/dist/models/AskAiRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AskAiRequest.js","sourceRoot":"","sources":["../../src/models/AskAiRequest.ts"],"names":[],"mappings":""}

package/dist/models/BaseToolGptParameters.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This interface is intended to be the base for all tool parameters that are generated by a GPT.
+ */
+export interface BaseToolGptParameters {
+    /**
+     * The reason why this particular action is being taken. It MUST relate to the overall objective.
+     */
+    rationale: string;
+}

package/dist/models/BaseToolGptParameters.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=BaseToolGptParameters.js.map

package/dist/models/BaseToolGptParameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseToolGptParameters.js","sourceRoot":"","sources":["../../src/models/BaseToolGptParameters.ts"],"names":[],"mappings":""}

package/dist/models/BaseToolParam.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This interface is intended to be the base for all tool parameters.
+ */
+export interface BaseToolParameters {
+    /**
+     * The reason why this particular action is being taken. It MUST relate to the overall objective.
+     */
+    rationale: string;
+}

package/dist/models/BaseToolParam.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=BaseToolParam.js.map

package/dist/models/BaseToolParam.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseToolParam.js","sourceRoot":"","sources":["../../src/models/BaseToolParam.ts"],"names":[],"mappings":""}

package/dist/models/BaseToolParameters.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This interface is intended to be the base for all tool parameters.
+ */
+export interface BaseToolParameters {
+    /**
+     * The reason why this particular action is being taken. It MUST relate to the overall objective.
+     */
+    rationale: string;
+}

package/dist/models/BaseToolParameters.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=BaseToolParameters.js.map

package/dist/models/BaseToolParameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseToolParameters.js","sourceRoot":"","sources":["../../src/models/BaseToolParameters.ts"],"names":[],"mappings":""}

package/dist/models/BrowserDevice.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This type is expected to match the shape of entries in the `assets/devices.json` file.
+ */
+export type BrowserDevice = {
+    readonly defaultBrowserType: string;
+    readonly userAgent?: string;
+    readonly viewport?: {
+        width: number;
+        height: number;
+    };
+    readonly screen?: {
+        width: number;
+        height: number;
+    };
+    readonly deviceScaleFactor?: number;
+    readonly isMobile?: boolean;
+    readonly hasTouch?: boolean;
+};

package/dist/models/BrowserDevice.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=BrowserDevice.js.map

package/dist/models/BrowserDevice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrowserDevice.js","sourceRoot":"","sources":["../../src/models/BrowserDevice.ts"],"names":[],"mappings":""}