donobu 1.0.0

package/dist/apis/GptResourcesApi.d.ts

@@ -0,0 +1,20 @@
+import { Request, Response } from 'express';
+import { GptResourcesManager } from '../managers/GptResourcesManager';
+import { GptResource } from '../models/GptResource';
+/**
+ * This API manages the GPT resources available to the Donobu runtime.
+ */
+export declare class GptResourcesApi {
+    private readonly gptResourcesManager;
+    private static readonly REDACTED_FIELD_NAME;
+    constructor(gptResourcesManager: GptResourcesManager);
+    set(req: Request, res: Response): Promise<void>;
+    get(req: Request, res: Response): Promise<void>;
+    getAll(_req: Request, res: Response): Promise<void>;
+    delete(req: Request, res: Response): Promise<void>;
+    /**
+     * Redacts sensative data from the given GPT resource so that the record can
+     * be safely returned through the API.
+     */
+    static redactSensativeData(gptResource: GptResource): GptResource;
+}

package/dist/apis/GptResourcesApi.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GptResourcesApi = void 0;
+const GptResourceNotFoundException_1 = require("../exceptions/GptResourceNotFoundException");
+/**
+ * This API manages the GPT resources available to the Donobu runtime.
+ */
+class GptResourcesApi {
+    gptResourcesManager;
+    static REDACTED_FIELD_NAME = 'apiKey';
+    constructor(gptResourcesManager) {
+        this.gptResourcesManager = gptResourcesManager;
+    }
+    async set(req, res) {
+        const gptResource = req.body;
+        const gptResourceName = req.params.name;
+        if (!gptResourceName) {
+            throw new GptResourceNotFoundException_1.GptResourceNotFoundException(gptResourceName);
+        }
+        await this.gptResourcesManager.set(gptResourceName, gptResource);
+        res.status(200);
+    }
+    async get(req, res) {
+        const gptResourceName = req.params.name;
+        const gptResource = GptResourcesApi.redactSensativeData(await this.gptResourcesManager.get(gptResourceName));
+        res.json(gptResource);
+    }
+    async getAll(_req, res) {
+        const gptResources = await this.gptResourcesManager.getAll();
+        const redactedGptResources = new Map(Array.from(gptResources.entries()).map(([key, value]) => [
+            key,
+            GptResourcesApi.redactSensativeData(value),
+        ]));
+        res.json(Object.fromEntries(redactedGptResources));
+    }
+    async delete(req, res) {
+        const gptResourceName = req.params.name;
+        await this.gptResourcesManager.delete(gptResourceName);
+        res.status(200);
+    }
+    /**
+     * Redacts sensative data from the given GPT resource so that the record can
+     * be safely returned through the API.
+     */
+    static redactSensativeData(gptResource) {
+        if (GptResourcesApi.REDACTED_FIELD_NAME in gptResource) {
+            gptResource[GptResourcesApi.REDACTED_FIELD_NAME] = '****************';
+        }
+        return gptResource;
+    }
+}
+exports.GptResourcesApi = GptResourcesApi;
+//# sourceMappingURL=GptResourcesApi.js.map

package/dist/apis/GptResourcesApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GptResourcesApi.js","sourceRoot":"","sources":["../../src/apis/GptResourcesApi.ts"],"names":[],"mappings":";;;AAEA,6FAA0F;AAG1F;;GAEG;AACH,MAAa,eAAe;IAIP;IAHX,MAAM,CAAU,mBAAmB,GAAG,QAAQ,CAAC;IAEvD,YACmB,mBAAwC;QAAxC,wBAAmB,GAAnB,mBAAmB,CAAqB;IACxD,CAAC;IAEG,KAAK,CAAC,GAAG,CAAC,GAAY,EAAE,GAAa;QAC1C,MAAM,WAAW,GAAG,GAAG,CAAC,IAAmB,CAAC;QAC5C,MAAM,eAAe,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;QAExC,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,2DAA4B,CAAC,eAAe,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;QACjE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,GAAY,EAAE,GAAa;QAC1C,MAAM,eAAe,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;QACxC,MAAM,WAAW,GAAG,eAAe,CAAC,mBAAmB,CACrD,MAAM,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,eAAe,CAAC,CACpD,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,IAAa,EAAE,GAAa;QAC9C,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,CAAC;QAC7D,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAClC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;YACvD,GAAG;YACH,eAAe,CAAC,mBAAmB,CAAC,KAAK,CAAC;SAC3C,CAAC,CACH,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACrD,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,GAAY,EAAE,GAAa;QAC7C,MAAM,eAAe,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;QACxC,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QACvD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAClB,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,mBAAmB,CAAC,WAAwB;QACjD,IAAI,eAAe,CAAC,mBAAmB,IAAI,WAAW,EAAE,CAAC;YACvD,WAAW,CAAC,eAAe,CAAC,mBAAmB,CAAC,GAAG,kBAAkB,CAAC;QACxE,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;;AAtDH,0CAuDC"}

package/dist/apis/KeysApi.d.ts

@@ -0,0 +1,25 @@
+import { Request, Response } from 'express';
+import { GptPlatformApiKeysManager } from '../managers/GptPlatformApiKeysManager';
+export declare class KeysApi {
+    private readonly gptPlatformApiKeysManager;
+    constructor(gptPlatformApiKeysManager: GptPlatformApiKeysManager);
+    /**
+     * NOTE: This does not actually return the API key itself, but rather, flags if it exists or not.
+     */
+    getApiKey(req: Request, res: Response): Promise<void>;
+    /**
+     * NOTE: This does not actually return the API keys themselves, but rather, the map of Platforms
+     * that have API keys available. Example response:
+     *
+     * <pre>
+     * {
+     *     "OPENAI": true,
+     *     "ANTHROPIC": false,
+     *     "GOOGLE": false
+     * }
+     * </pre>
+     */
+    getApiKeys(_req: Request, res: Response): Promise<void>;
+    setApiKey(req: Request, res: Response): Promise<void>;
+    deleteApiKey(req: Request, res: Response): Promise<void>;
+}

package/dist/apis/KeysApi.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeysApi = void 0;
+const FlowMetadata_1 = require("../models/FlowMetadata");
+const InvalidParamValueException_1 = require("../exceptions/InvalidParamValueException");
+class KeysApi {
+    gptPlatformApiKeysManager;
+    constructor(gptPlatformApiKeysManager) {
+        this.gptPlatformApiKeysManager = gptPlatformApiKeysManager;
+    }
+    /**
+     * NOTE: This does not actually return the API key itself, but rather, flags if it exists or not.
+     */
+    async getApiKey(req, res) {
+        const platformName = req.params.platform.toUpperCase();
+        const platform = FlowMetadata_1.Platform[platformName];
+        if (!platform) {
+            throw new InvalidParamValueException_1.InvalidParamValueException('/api-keys/{platform}', platformName);
+        }
+        await this.gptPlatformApiKeysManager.getKey(platform);
+        res.sendStatus(200);
+    }
+    /**
+     * NOTE: This does not actually return the API keys themselves, but rather, the map of Platforms
+     * that have API keys available. Example response:
+     *
+     * <pre>
+     * {
+     *     "OPENAI": true,
+     *     "ANTHROPIC": false,
+     *     "GOOGLE": false
+     * }
+     * </pre>
+     */
+    async getApiKeys(_req, res) {
+        const platformsWithKeys = await this.gptPlatformApiKeysManager.getGptPlatformsWithKeys();
+        const response = {};
+        for (const platform of Object.values(FlowMetadata_1.Platform)) {
+            response[platform] = platformsWithKeys.includes(platform);
+        }
+        res.json(response);
+    }
+    async setApiKey(req, res) {
+        const body = req.body;
+        const platformName = req.params.platform.toUpperCase();
+        const platform = FlowMetadata_1.Platform[platformName];
+        if (!platform) {
+            throw new InvalidParamValueException_1.InvalidParamValueException('/api-keys/{platform}', platformName);
+        }
+        await this.gptPlatformApiKeysManager.setKey(platform, body.key);
+        res.sendStatus(200);
+    }
+    async deleteApiKey(req, res) {
+        const platformName = req.params.platform.toUpperCase();
+        const platform = FlowMetadata_1.Platform[platformName];
+        if (!platform) {
+            throw new InvalidParamValueException_1.InvalidParamValueException('/api-keys/{platform}', platformName);
+        }
+        await this.gptPlatformApiKeysManager.deleteKey(platform);
+        res.sendStatus(200);
+    }
+}
+exports.KeysApi = KeysApi;
+//# sourceMappingURL=KeysApi.js.map

package/dist/apis/KeysApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeysApi.js","sourceRoot":"","sources":["../../src/apis/KeysApi.ts"],"names":[],"mappings":";;;AACA,yDAAkD;AAElD,yFAAsF;AAEtF,MAAa,OAAO;IAEC;IADnB,YACmB,yBAAoD;QAApD,8BAAyB,GAAzB,yBAAyB,CAA2B;IACpE,CAAC;IAEJ;;OAEG;IACI,KAAK,CAAC,SAAS,CAAC,GAAY,EAAE,GAAa;QAChD,MAAM,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QACvD,MAAM,QAAQ,GAAG,uBAAQ,CAAC,YAAqC,CAAC,CAAC;QAEjE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,uDAA0B,CAClC,sBAAsB,EACtB,YAAY,CACb,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACtD,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACtB,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,UAAU,CAAC,IAAa,EAAE,GAAa;QAClD,MAAM,iBAAiB,GACrB,MAAM,IAAI,CAAC,yBAAyB,CAAC,uBAAuB,EAAE,CAAC;QACjE,MAAM,QAAQ,GAA4B,EAAE,CAAC;QAE7C,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,uBAAQ,CAAC,EAAE,CAAC;YAC/C,QAAQ,CAAC,QAAQ,CAAC,GAAG,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC5D,CAAC;QAED,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrB,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,GAAY,EAAE,GAAa;QAChD,MAAM,IAAI,GAAG,GAAG,CAAC,IAEhB,CAAC;QACF,MAAM,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QACvD,MAAM,QAAQ,GAAG,uBAAQ,CAAC,YAAqC,CAAC,CAAC;QAEjE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,uDAA0B,CAClC,sBAAsB,EACtB,YAAY,CACb,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QAChE,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACtB,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,GAAY,EAAE,GAAa;QACnD,MAAM,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QACvD,MAAM,QAAQ,GAAG,uBAAQ,CAAC,YAAqC,CAAC,CAAC;QAEjE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,uDAA0B,CAClC,sBAAsB,EACtB,YAAY,CACb,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACzD,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACtB,CAAC;CACF;AA/ED,0BA+EC"}

package/dist/apis/PingApi.d.ts

@@ -0,0 +1,13 @@
+import { Request, Response } from 'express';
+/**
+ * API endpoints for basic health/connectivity checks.
+ */
+export declare class PingApi {
+    /**
+     * No-op endpoint that just returns HTTP 200.
+     *
+     * @param _req - Express request object (unused)
+     * @param res - Express response object
+     */
+    ping(_req: Request, res: Response): Promise<void>;
+}

package/dist/apis/PingApi.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PingApi = void 0;
+/**
+ * API endpoints for basic health/connectivity checks.
+ */
+class PingApi {
+    /**
+     * No-op endpoint that just returns HTTP 200.
+     *
+     * @param _req - Express request object (unused)
+     * @param res - Express response object
+     */
+    async ping(_req, res) {
+        res.sendStatus(200);
+    }
+}
+exports.PingApi = PingApi;
+//# sourceMappingURL=PingApi.js.map

package/dist/apis/PingApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PingApi.js","sourceRoot":"","sources":["../../src/apis/PingApi.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,MAAa,OAAO;IAClB;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CAAC,IAAa,EAAE,GAAa;QAC5C,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACtB,CAAC;CACF;AAVD,0BAUC"}

package/dist/apis/SpecialFlowsApi.d.ts

@@ -0,0 +1,17 @@
+import { Request, Response } from 'express';
+import { DonobuFlowsManager } from '../managers/DonobuFlowsManager';
+export declare class SpecialFlowsApi {
+    private readonly donobuFlowsManager;
+    private static readonly BROWSERBASE_API_KEY_ENV;
+    constructor(donobuFlowsManager: DonobuFlowsManager);
+    analyzeCookieConsent(req: Request, res: Response): Promise<void>;
+    detectBrokenLinks(req: Request, res: Response): Promise<void>;
+    extractPublicFacebookEntityData(req: Request, res: Response): Promise<void>;
+    extractPaymentProviderData(req: Request, res: Response): Promise<void>;
+    extractGoogleStreetviewEntityData(req: Request, res: Response): Promise<void>;
+    private divineTargetEntityDataFromGoogleMapUrl;
+    private wrapUp;
+    private wrapUpWithStreetDataRecovery;
+    private parseUrl;
+    private browserType;
+}

package/dist/apis/SpecialFlowsApi.js

@@ -0,0 +1,430 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpecialFlowsApi = void 0;
+const FlowMetadata_1 = require("../models/FlowMetadata");
+const FlowMetadata_2 = require("../models/FlowMetadata");
+const JsonUtils_1 = require("../utils/JsonUtils");
+const Logger_1 = require("../utils/Logger");
+const CreateBrowserCookieReportTool_1 = require("../tools/CreateBrowserCookieReportTool");
+const GoToWebpageTool_1 = require("../tools/GoToWebpageTool");
+const ClickTool_1 = require("../tools/ClickTool");
+const MarkObjectiveNotCompletableTool_1 = require("../tools/MarkObjectiveNotCompletableTool");
+const MarkObjectiveCompleteTool_1 = require("../tools/MarkObjectiveCompleteTool");
+const WaitTool_1 = require("../tools/WaitTool");
+const ExtractPublicFacebookEntityDataTool_1 = require("../tools/ExtractPublicFacebookEntityDataTool");
+const ChooseSelectOptionTool_1 = require("../tools/ChooseSelectOptionTool");
+const ExtractPaymentProviderKeyTool_1 = require("../tools/ExtractPaymentProviderKeyTool");
+const GoForwardOrBackTool_1 = require("../tools/GoForwardOrBackTool");
+const InputRandomizedEmailAddressTool_1 = require("../tools/InputRandomizedEmailAddressTool");
+const InputTextTool_1 = require("../tools/InputTextTool");
+const PressKeyTool_1 = require("../tools/PressKeyTool");
+const ScrollPageTool_1 = require("../tools/ScrollPageTool");
+const ExtractGoogleStreetviewEntityDataTool_1 = require("../tools/ExtractGoogleStreetviewEntityDataTool");
+const AggregateExtractedStreetviewDataTool_1 = require("../tools/AggregateExtractedStreetviewDataTool");
+const GoToGoogleMapsStreetViewTool_1 = require("../tools/GoToGoogleMapsStreetViewTool");
+const NavigateWithinStreetView_1 = require("../tools/NavigateWithinStreetView");
+const GetEntityDataFromGoogleMapResult_1 = require("../tools/GetEntityDataFromGoogleMapResult");
+const DetectBrokenLinksTool_1 = require("../tools/DetectBrokenLinksTool");
+class SpecialFlowsApi {
+    donobuFlowsManager;
+    static BROWSERBASE_API_KEY_ENV = 'BROWSERBASE_API_KEY';
+    constructor(donobuFlowsManager) {
+        this.donobuFlowsManager = donobuFlowsManager;
+    }
+    async analyzeCookieConsent(req, res) {
+        const httpBodyParams = req.body;
+        const url = httpBodyParams.url;
+        const overallObjective = `
+You are a web-browsing QA agent verifying a website's cookie banner behavior and compliance. Follow the steps below carefully.
+If any step (such as rejecting cookies) is not possible due to the absence of a cookie banner or a lack of “Reject”/“Customize” options,
+document your observations but do not conclude “objective not completable.” Instead, continue with the process and produce a final report.
+
+1. Initial Cookie Report:
+    - After the webpage initially loads, but before interacting with any cookie banner, generate a comprehensive cookie report.
+    - This report should capture all cookies present in the browser at this moment.
+
+2. Check for Cookie Banner:
+    - If a cookie banner is present:
+      - Look for a “Reject” option.
+      - If found, select “Reject” (reject all non-essential cookies).
+      - If there is no explicit “Reject” option, select the most restrictive choice (e.g., “Customize” and deselect all possible categories).
+      - Document the absence of a direct “Reject” button as a potential compliance concern.
+      - Proceed to Step 3.
+    - If no cookie banner is present:
+      - Document the absence of a banner as a potential compliance concern.
+      - For the relevant schema fields, set:
+        - cookieBannerDisplayed = false
+        - rejectOptionAvailable = false
+        - retainedCookies = [] (empty list, assuming no cookies are added after rejecting).
+      - Skip Step 3 and proceed directly to Step 4.
+
+3. Post-Rejection Cookie Report:
+    - Generate a second cookie report after you have selected “Reject” or the most restrictive settings in the cookie banner.
+    - This second report helps determine if any non-essential cookies remain.
+
+4. Analysis & Summary:
+    - Compare the two cookie reports (initial vs. post-rejection).
+    - If a second report was generated (i.e., a cookie banner existed):
+      - Verify whether only strictly necessary cookies remain post-rejection.
+      - Identify any non-essential cookies that were retained and flag them as potential compliance issues.
+      - Document whether a “Reject” option was available and whether the site appears to respect the user’s preferences.
+    - If no banner was present:
+      - Note that no second report was generated.
+      - Document the absence of a cookie banner as a compliance concern, since users could not explicitly reject non-essential cookies.
+
+5. End the Flow Gracefully:
+    - Regardless of whether a cookie banner was found, finalize your findings in a clear, structured format.
+    - Do not mark the objective as “not completable” or abruptly end the flow just because the banner was missing.
+    - Instead, complete all the documentation steps and conclude with a summary of potential compliance issues and overall observations.`;
+        const resultJsonSchema = {
+            type: 'object',
+            required: [
+                'cookieBannerDisplayed',
+                'potentialCookieIssues',
+                'rejectOptionAvailable',
+                'initialCookies',
+                'retainedCookies',
+            ],
+            additionalProperties: false,
+            properties: {
+                cookieBannerDisplayed: {
+                    type: 'boolean',
+                    description: 'Whether a cookie banner was displayed on the page.',
+                },
+                potentialCookieIssues: {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                    description: 'The list of potential cookie issues (if any).\nExamples:\n- A marketing/advertising cookies being retained.\n- Lack of a "Reject" option in the cookie banner.\n- No cookie banner present (if expected).\n- Other indications of non-compliance with regional cookie laws.',
+                },
+                rejectOptionAvailable: {
+                    type: 'boolean',
+                    description: 'Indicates whether the cookie banner had a "Reject" option.\n- true: Banner provided a "Reject" option.\n- false: Banner lacked a "Reject" option.',
+                },
+                initialCookies: {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                    description: 'Cookies discovered immediately after page load, before any user interaction.',
+                },
+                retainedCookies: {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                    description: 'Cookies that remain after attempting to reject or minimize non-essential cookies.',
+                },
+            },
+        };
+        const flowParams = {
+            targetWebsite: url,
+            overallObjective: overallObjective,
+            deviceName: 'Desktop Chromium',
+            headless: false,
+            maxIterations: 10,
+            defaultToolTipDurationMilliseconds: 0,
+            initialRunMode: FlowMetadata_1.RunMode.AUTONOMOUS,
+            isControlPanelEnabled: false,
+            allowedTools: [
+                CreateBrowserCookieReportTool_1.CreateBrowserCookieReportTool.NAME,
+                GoToWebpageTool_1.GoToWebpageTool.NAME,
+                ClickTool_1.ClickTool.NAME,
+                MarkObjectiveNotCompletableTool_1.MarkObjectiveNotCompletableTool.NAME,
+                MarkObjectiveCompleteTool_1.MarkObjectiveCompleteTool.NAME,
+                WaitTool_1.WaitTool.NAME,
+            ],
+            toolCallsOnStart: [
+                {
+                    name: GoToWebpageTool_1.GoToWebpageTool.NAME,
+                    parameters: {
+                        url: url.toString(),
+                    },
+                },
+                {
+                    name: WaitTool_1.WaitTool.NAME,
+                    parameters: {
+                        seconds: 3,
+                    },
+                },
+                {
+                    name: CreateBrowserCookieReportTool_1.CreateBrowserCookieReportTool.NAME,
+                    parameters: {},
+                },
+            ],
+            resultJsonSchema: resultJsonSchema,
+        };
+        const flowHandle = await this.donobuFlowsManager.createFlow(flowParams);
+        const isAsync = req.query.async === 'true';
+        if (isAsync) {
+            res.json({ id: flowHandle.donobuFlow.metadata.id });
+        }
+        else {
+            await this.wrapUp(res, flowHandle);
+        }
+    }
+    async detectBrokenLinks(req, res) {
+        const httpBodyParams = req.body;
+        const flowParams = {
+            targetWebsite: httpBodyParams.url,
+            deviceName: 'Desktop Chromium',
+            headless: false,
+            defaultToolTipDurationMilliseconds: 0,
+            initialRunMode: FlowMetadata_1.RunMode.DETERMINISTIC,
+            isControlPanelEnabled: false,
+            toolCallsOnStart: [
+                {
+                    name: GoToWebpageTool_1.GoToWebpageTool.NAME,
+                    parameters: {
+                        url: httpBodyParams.url,
+                    },
+                },
+                {
+                    name: DetectBrokenLinksTool_1.DetectBrokenLinksTool.NAME,
+                    parameters: {},
+                },
+            ],
+        };
+        const flowHandle = await this.donobuFlowsManager.createFlow(flowParams);
+        res.json({ id: flowHandle.donobuFlow.metadata.id });
+    }
+    async extractPublicFacebookEntityData(req, res) {
+        const httpBodyParams = req.body;
+        const overallObjective = `Source Facebook transparency data for ${httpBodyParams.facebookEntityName || httpBodyParams.facebookEntityUrl}`;
+        const browserType = this.browserType('Desktop Firefox');
+        const flowParams = {
+            targetWebsite: 'https://www.facebook.com',
+            overallObjective: overallObjective,
+            deviceName: browserType.deviceName ?? undefined,
+            remoteBrowserInstanceUrl: browserType.remoteBrowserInstanceUrl ?? undefined,
+            headless: true,
+            maxIterations: 0,
+            gptConfigNameOverride: 'claude-3-5-sonnet-latest',
+            defaultToolTipDurationMilliseconds: 0,
+            initialRunMode: FlowMetadata_1.RunMode.AUTONOMOUS,
+            isControlPanelEnabled: false,
+            allowedTools: [ExtractPublicFacebookEntityDataTool_1.ExtractPublicFacebookEntityDataTool.NAME],
+            toolCallsOnStart: [
+                {
+                    name: ExtractPublicFacebookEntityDataTool_1.ExtractPublicFacebookEntityDataTool.NAME,
+                    parameters: httpBodyParams,
+                },
+            ],
+        };
+        const flowHandle = await this.donobuFlowsManager.createFlow(flowParams);
+        await this.wrapUp(res, flowHandle);
+    }
+    async extractPaymentProviderData(req, res) {
+        const httpBodyParams = req.body;
+        const url = this.parseUrl(httpBodyParams.website);
+        if (!url) {
+            throw new Error(`Invalid website parameter: ${httpBodyParams.website}`);
+        }
+        const overallObjective = `
+      Find the payments provider for ${url}
+
+      Try to checkout some product. Make up real sounding data if needed.
+      Add a paid product to cart. Sometimes you might need to scroll to see the option to add product to cart.
+      Once a product is in cart, continue to checkout.
+      Fill out the shopping cart page with made up shipping and other info and go to payments details page.
+      Continue through the flow until you see an option to input credit card number on the page.
+      Do not actually submit credit card details. At the final checkout page extract payment provider information.
+    `;
+        const flowParams = {
+            targetWebsite: url,
+            overallObjective: overallObjective,
+            deviceName: 'High Resolution Chromium Skinny Long',
+            headless: true,
+            maxIterations: 30,
+            defaultToolTipDurationMilliseconds: 0,
+            initialRunMode: FlowMetadata_1.RunMode.AUTONOMOUS,
+            isControlPanelEnabled: false,
+            allowedTools: [
+                ChooseSelectOptionTool_1.ChooseSelectOptionTool.NAME,
+                ClickTool_1.ClickTool.NAME,
+                ExtractPaymentProviderKeyTool_1.ExtractPaymentProviderKeyTool.NAME,
+                GoForwardOrBackTool_1.GoForwardOrBackTool.NAME,
+                InputRandomizedEmailAddressTool_1.InputRandomizedEmailAddressTool.NAME,
+                InputTextTool_1.InputTextTool.NAME,
+                GoToWebpageTool_1.GoToWebpageTool.NAME,
+                MarkObjectiveNotCompletableTool_1.MarkObjectiveNotCompletableTool.NAME,
+                PressKeyTool_1.PressKeyTool.NAME,
+                ScrollPageTool_1.ScrollPageTool.NAME,
+            ],
+        };
+        const flowHandle = await this.donobuFlowsManager.createFlow(flowParams);
+        await this.wrapUp(res, flowHandle);
+    }
+    async extractGoogleStreetviewEntityData(req, res) {
+        const httpBodyParams = req.body;
+        if (!httpBodyParams.entityName && !httpBodyParams.googleMapsUrl) {
+            throw new Error('entityName and googleMapsUrl cannot both be null.');
+        }
+        else if (httpBodyParams.entityName && !httpBodyParams.entityLocation) {
+            throw new Error('entityLocation cannot be null if entityName is non-null.');
+        }
+        let entityName;
+        let entityLocation;
+        let inputTokensForTmpFlow;
+        let completionTokensForTmpFlow;
+        if (httpBodyParams.entityName) {
+            entityName = httpBodyParams.entityName;
+            entityLocation = httpBodyParams.entityLocation;
+            inputTokensForTmpFlow = 0;
+            completionTokensForTmpFlow = 0;
+        }
+        else {
+            const tmpFlow = await this.divineTargetEntityDataFromGoogleMapUrl(httpBodyParams.googleMapsUrl);
+            const entityData = JsonUtils_1.JsonUtils.objectToJson(tmpFlow.metadata.result);
+            entityName = entityData.entityName;
+            entityLocation = entityData.entityAddress;
+            inputTokensForTmpFlow = tmpFlow.metadata.inputTokensUsed;
+            completionTokensForTmpFlow = tmpFlow.metadata.completionTokensUsed;
+        }
+        const browserType = this.browserType('High Resolution Chromium');
+        const mainExtractionTool = new ExtractGoogleStreetviewEntityDataTool_1.ExtractGoogleStreetviewEntityDataTool();
+        const aggregationTool = new AggregateExtractedStreetviewDataTool_1.AggregateExtractedStreetviewDataTool();
+        const overallObjective = `
+      Attempt to locate the business/entity, ${entityName}, at (or around!) the location ${entityLocation}, using Google Maps street view.
+      Note that the initial street view will likely already been oriented towards the business/entity, so if
+      business/entity signage is initially blurry, first try zooming in the view before rotating the view.
+
+      Business/entity data can be extracted using the '${mainExtractionTool.name}' tool.
+
+      If the target business/entity is not found, DO NOT instantly give up! Here is what to do for various conditions:
+      - If building is visible but business/entity signage wasn't a match, prefer zooming in first.
+      - Business/entity signage is illegible/blurry/etc -> Try zooming in.
+      - Business/entity is not present -> Try rotating, or, moving the current position of the street view.
+
+      If the street view has been adjusted, be sure to follow that up with a call to the '${mainExtractionTool.name}' tool.
+
+      Once confident about the existence or non-existence of the target business/entity at the given location,
+      using (perhaps multiple times) the '${mainExtractionTool.name}' tool, call the '${aggregationTool.name}' tool.
+    `;
+        const flowParams = {
+            targetWebsite: 'https://maps.google.com',
+            overallObjective: overallObjective,
+            deviceName: browserType.deviceName ?? undefined,
+            remoteBrowserInstanceUrl: browserType.remoteBrowserInstanceUrl ?? undefined,
+            headless: false,
+            maxIterations: 10,
+            defaultToolTipDurationMilliseconds: 0,
+            initialRunMode: FlowMetadata_1.RunMode.AUTONOMOUS,
+            isControlPanelEnabled: false,
+            allowedTools: [
+                ClickTool_1.ClickTool.NAME,
+                GoToGoogleMapsStreetViewTool_1.GoToGoogleMapsStreetViewTool.NAME,
+                NavigateWithinStreetView_1.NavigateWithinStreetViewTool.NAME,
+                mainExtractionTool.name,
+                aggregationTool.name,
+            ],
+            toolCallsOnStart: [
+                {
+                    name: GoToGoogleMapsStreetViewTool_1.GoToGoogleMapsStreetViewTool.NAME,
+                    parameters: {
+                        entityName,
+                        entityLocation,
+                    },
+                },
+                {
+                    name: ExtractGoogleStreetviewEntityDataTool_1.ExtractGoogleStreetviewEntityDataTool.NAME,
+                    parameters: {
+                        entityName,
+                    },
+                },
+            ],
+        };
+        const flowHandle = await this.donobuFlowsManager.createFlow(flowParams);
+        flowHandle.donobuFlow.metadata.inputTokensUsed += inputTokensForTmpFlow;
+        flowHandle.donobuFlow.metadata.completionTokensUsed +=
+            completionTokensForTmpFlow;
+        await this.wrapUpWithStreetDataRecovery(res, flowHandle);
+    }
+    async divineTargetEntityDataFromGoogleMapUrl(googleMapUrl) {
+        const browserType = this.browserType('High Resolution Chromium');
+        const flowParams = {
+            targetWebsite: googleMapUrl,
+            overallObjective: 'Extract the business/entity data from the current Google Maps page.',
+            deviceName: browserType.deviceName ?? undefined,
+            remoteBrowserInstanceUrl: browserType.remoteBrowserInstanceUrl ?? undefined,
+            headless: false,
+            maxIterations: 1,
+            defaultToolTipDurationMilliseconds: 0,
+            initialRunMode: FlowMetadata_1.RunMode.AUTONOMOUS,
+            isControlPanelEnabled: false,
+            allowedTools: [
+                GetEntityDataFromGoogleMapResult_1.GetEntityDataFromGoogleMapResultTool.NAME,
+                GoToWebpageTool_1.GoToWebpageTool.NAME,
+            ],
+            toolCallsOnStart: [],
+        };
+        const flowHandle = await this.donobuFlowsManager.createFlow(flowParams);
+        await flowHandle.job;
+        return flowHandle.donobuFlow;
+    }
+    // Helper methods
+    async wrapUp(res, flowHandle) {
+        const flowId = flowHandle.donobuFlow.metadata.id;
+        const flow = flowHandle.donobuFlow;
+        await flowHandle.job;
+        if (!flow.metadata.result) {
+            res.status(500);
+        }
+        else if (typeof flow.metadata.result.failed === 'string' &&
+            flow.metadata.result.failed.toLowerCase().includes('internal error')) {
+            res.status(500);
+        }
+        else if (flow.metadata.state !== FlowMetadata_2.State.SUCCESS) {
+            res.status(400);
+        }
+        res.header('x-input-tokens-used', flow.metadata.inputTokensUsed.toString());
+        res.header('x-completion-tokens-used', flow.metadata.completionTokensUsed.toString());
+        res.header('x-gpt-config-name', flow.metadata.gptConfigName ?? '');
+        res.header('x-flow-id', flow.metadata.id);
+        res.json(flow.metadata.result ?? {
+            error: `Unexpected null result for flow ${flowId}.`,
+        });
+    }
+    async wrapUpWithStreetDataRecovery(res, flowHandle) {
+        const flowId = flowHandle.donobuFlow.metadata.id;
+        const flow = flowHandle.donobuFlow;
+        await flowHandle.job;
+        let flowResult = flow.metadata.result;
+        if (!flowResult) {
+            Logger_1.Logger.appLogger.error(`Unexpected null result for flow ${flowId}.`);
+            res.status(500);
+        }
+        else if (flow.metadata.state !== FlowMetadata_2.State.SUCCESS) {
+            flowResult = AggregateExtractedStreetviewDataTool_1.AggregateExtractedStreetviewDataTool.aggregateStreetviewData(flow.invokedToolCalls, flow.metadata);
+        }
+        else {
+            res.status(200);
+        }
+        res.header('x-input-tokens-used', flow.metadata.inputTokensUsed.toString());
+        res.header('x-completion-tokens-used', flow.metadata.completionTokensUsed.toString());
+        res.header('x-gpt-config-name', flow.metadata.gptConfigName ?? '');
+        res.header('x-flow-id', flowHandle.donobuFlow.metadata.id);
+        res.json(flowResult || {});
+    }
+    parseUrl(url) {
+        if (!url) {
+            return null;
+        }
+        if (!url.startsWith('http')) {
+            url = `https://${url}`;
+        }
+        return url;
+    }
+    browserType(defaultDeviceName) {
+        const deviceName = !process.env[SpecialFlowsApi.BROWSERBASE_API_KEY_ENV]
+            ? defaultDeviceName
+            : null;
+        const remoteBrowserUrl = process.env[SpecialFlowsApi.BROWSERBASE_API_KEY_ENV]
+            ? `wss://connect.browserbase.com?apiKey=\${env.${SpecialFlowsApi.BROWSERBASE_API_KEY_ENV}}`
+            : null;
+        return { deviceName, remoteBrowserInstanceUrl: remoteBrowserUrl };
+    }
+}
+exports.SpecialFlowsApi = SpecialFlowsApi;
+//# sourceMappingURL=SpecialFlowsApi.js.map