donobu 1.0.0

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

@@ -0,0 +1,14 @@
+import { Tool } from './Tool';
+import { ToolCallContext } from '../models/ToolCallContext';
+import { ToolCallResult } from '../models/ToolCallResult';
+import { CustomTool } from '../models/CustomTool';
+/**
+ * This is a special Tool implementation that wraps a CustomTool to be used in a
+ * flow.
+ */
+export declare class CustomToolRunnerTool extends Tool<object, object> {
+    private readonly javascript;
+    constructor(customTool: CustomTool);
+    call(context: ToolCallContext, parameters: object): Promise<ToolCallResult>;
+    callFromGpt(context: ToolCallContext, parameters: object): Promise<ToolCallResult>;
+}

package/dist/esm/tools/CustomToolRunnerTool.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomToolRunnerTool = void 0;
+const Tool_1 = require("./Tool");
+/**
+ * This is a special Tool implementation that wraps a CustomTool to be used in a
+ * flow.
+ */
+class CustomToolRunnerTool extends Tool_1.Tool {
+    javascript;
+    constructor(customTool) {
+        super(customTool.name, customTool.description, 'object', 'object', false);
+        // Override the jsonSchema that were set in the parent constructor
+        Object.defineProperty(this, 'jsonSchemaForNonGpt', {
+            value: customTool.jsonSchema,
+        });
+        Object.defineProperty(this, 'jsonSchemaForGpt', {
+            value: customTool.jsonSchema,
+        });
+        this.javascript = customTool.javascript;
+    }
+    async call(context, parameters) {
+        const result = await context.page.evaluate(this.javascript, parameters);
+        return {
+            isSuccessful: true,
+            forLlm: '' + JSON.stringify(result),
+            metadata: null,
+        };
+    }
+    async callFromGpt(context, parameters) {
+        return this.call(context, parameters);
+    }
+}
+exports.CustomToolRunnerTool = CustomToolRunnerTool;
+//# sourceMappingURL=CustomToolRunnerTool.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CustomToolRunnerTool.js","sourceRoot":"","sources":["../../../src/tools/CustomToolRunnerTool.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAK9B;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,WAAoB;IAC3C,UAAU,CAAS;IAEpC,YAAmB,UAAsB;QACvC,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC1E,kEAAkE;QAClE,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,qBAAqB,EAAE;YACjD,KAAK,EAAE,UAAU,CAAC,UAAU;SAC7B,CAAC,CAAC;QACH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,kBAAkB,EAAE;YAC9C,KAAK,EAAE,UAAU,CAAC,UAAU;SAC7B,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;IAC1C,CAAC;IAEe,KAAK,CAAC,IAAI,CACxB,OAAwB,EACxB,UAAkB;QAElB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QACxE,OAAO;YACL,YAAY,EAAE,IAAI;YAClB,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;YACnC,QAAQ,EAAE,IAAI;SACf,CAAC;IACJ,CAAC;IAEe,KAAK,CAAC,WAAW,CAC/B,OAAwB,EACxB,UAAkB;QAElB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IACxC,CAAC;CACF;AAjCD,oDAiCC"}

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

@@ -0,0 +1,38 @@
+import { Tool } from './Tool';
+import { ToolCallContext } from '../models/ToolCallContext';
+import { ToolCallResult } from '../models/ToolCallResult';
+import { BaseToolGptParameters } from '../models/BaseToolGptParameters';
+export interface DetectBrokenLinksToolCoreParameters {
+    /**
+     * (Optional) Whether to capture screenshots for dead links for visual verification.
+     */
+    captureScreenshots?: boolean;
+}
+export interface DetectBrokenLinksToolGptParameters extends BaseToolGptParameters, DetectBrokenLinksToolCoreParameters {
+}
+export declare class DetectBrokenLinksTool extends Tool<DetectBrokenLinksToolCoreParameters, DetectBrokenLinksToolGptParameters> {
+    static readonly NAME = "detectBrokenLinks";
+    constructor();
+    call(context: ToolCallContext, parameters: DetectBrokenLinksToolCoreParameters): Promise<ToolCallResult>;
+    callFromGpt(context: ToolCallContext, parameters: DetectBrokenLinksToolGptParameters): Promise<ToolCallResult>;
+    /**
+     * Returns an array of LinkInfo objects containing a URL and an array of all associated link texts.
+     * Filters out invalid URLs.
+     */
+    private static getLinksForPage;
+    /**
+     * Checks all links concurrently and returns a map from the original URL to its traversal result.
+     * If a link is a mailto, it is marked as skipped.
+     */
+    private static traverseLinks;
+    /**
+     * Traverses a single link, following redirects up to maxRedirects.
+     * Returns a LinkTraversalResult that includes the full redirect chain.
+     */
+    private static traverseSingleLink;
+    /**
+     * Generates a JSON report of the link scan.
+     * The report now includes a "linkTexts" field for each link.
+     */
+    private static generateJsonReport;
+}

package/dist/esm/tools/DetectBrokenLinksTool.js

@@ -0,0 +1,264 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DetectBrokenLinksTool = void 0;
+const Tool_1 = require("./Tool");
+const PlaywrightUtils_1 = require("../utils/PlaywrightUtils");
+class DetectBrokenLinksTool extends Tool_1.Tool {
+    static NAME = 'detectBrokenLinks';
+    constructor() {
+        super(DetectBrokenLinksTool.NAME, 'Detect broken links in the current page and return a report of them.', 'DetectBrokenLinksToolCoreParameters', 'DetectBrokenLinksToolGptParameters');
+    }
+    async call(context, parameters) {
+        const page = context.page;
+        // Get all links along with their texts.
+        const links = await DetectBrokenLinksTool.getLinksForPage(page);
+        const linksData = await DetectBrokenLinksTool.traverseLinks(page, links);
+        // Optionally capture screenshots for dead links.
+        if (parameters.captureScreenshots) {
+            await Promise.all(Array.from(linksData.entries()).map(async ([originalUrl, result]) => {
+                // Only try to capture screenshot for non-skipped (i.e. HTTP) links
+                if (result.isDead && !result.skipped) {
+                    let newPage;
+                    try {
+                        const finalUrl = result.redirectChain[result.redirectChain.length - 1];
+                        newPage = await page.context().newPage();
+                        await newPage.goto(finalUrl, { timeout: 10000 });
+                        const screenshotBuffer = await PlaywrightUtils_1.PlaywrightUtils.takePngScreenshot(newPage);
+                        // Generate a filename (encoded original URL plus timestamp)
+                        const screenshotFilename = `dead-link-screenshot-${encodeURIComponent(originalUrl)}-${Date.now()}.png`;
+                        await context.persistence.setFlowFile(context.metadata.id, screenshotFilename, screenshotBuffer);
+                        result.screenshotFilename = screenshotFilename;
+                    }
+                    catch (_error) {
+                        // Log error or ignore if screenshot capture fails.
+                    }
+                    finally {
+                        if (newPage) {
+                            await newPage.close().catch(() => { });
+                        }
+                    }
+                }
+            }));
+        }
+        const linksReport = await DetectBrokenLinksTool.generateJsonReport(page, linksData);
+        const linksReportAsJson = JSON.stringify(linksReport, null, 2);
+        return {
+            isSuccessful: true,
+            forLlm: linksReportAsJson,
+            metadata: linksReport,
+        };
+    }
+    async callFromGpt(context, parameters) {
+        return this.call(context, parameters);
+    }
+    /**
+     * Returns an array of LinkInfo objects containing a URL and an array of all associated link texts.
+     * Filters out invalid URLs.
+     */
+    static async getLinksForPage(page) {
+        // Get all <a> tag links.
+        const aTagLinks = await page.evaluate(() => {
+            return Array.from(document.querySelectorAll('a')).map((a) => ({
+                url: a.href,
+                text: (a.textContent || '').trim(),
+            }));
+        });
+        // Get links from onclick attributes.
+        const onClickLinks = await page.evaluate(() => {
+            return Array.from(document.querySelectorAll('[onclick]'))
+                .map((el) => {
+                const onclick = el.getAttribute('onclick') || '';
+                const match = onclick.match(/window\.location\.href\s*=\s*['"]([^'"]+)['"]/);
+                return match
+                    ? { url: match[1], text: (el.textContent || '').trim() }
+                    : null;
+            })
+                .filter((link) => link !== null);
+        });
+        // Get links from data-href attributes.
+        const dataHrefLinks = await page.evaluate(() => {
+            return Array.from(document.querySelectorAll('[data-href]')).map((el) => ({
+                url: el.getAttribute('data-href') || '',
+                text: (el.textContent || '').trim(),
+            }));
+        });
+        // Combine and deduplicate links by URL, accumulating all texts.
+        const linksMap = new Map();
+        const allLinks = [...aTagLinks, ...onClickLinks, ...dataHrefLinks];
+        for (const link of allLinks) {
+            try {
+                const _parsed = new URL(link.url);
+                if (!linksMap.has(link.url)) {
+                    linksMap.set(link.url, { url: link.url, texts: [link.text] });
+                }
+                else {
+                    const entry = linksMap.get(link.url);
+                    if (link.text && !entry.texts.includes(link.text)) {
+                        entry.texts.push(link.text);
+                    }
+                }
+            }
+            catch {
+                // Ignore invalid URLs.
+                // TODO: add better logic for handling different URL types like file://, etc.
+            }
+        }
+        return Array.from(linksMap.values());
+    }
+    /**
+     * Checks all links concurrently and returns a map from the original URL to its traversal result.
+     * If a link is a mailto, it is marked as skipped.
+     */
+    static async traverseLinks(page, links) {
+        const results = new Map();
+        const maxRedirects = 5;
+        await Promise.all(links.map(async (link) => {
+            // If it's a mailto link, record it as skipped.
+            if (link.url.startsWith('mailto:')) {
+                results.set(link.url, {
+                    redirectChain: [link.url],
+                    responseBody: 'Mailto link: not traversed',
+                    responseCode: 0,
+                    isDead: false,
+                    skipped: true,
+                    linkTexts: link.texts,
+                });
+                return;
+            }
+            try {
+                const result = await this.traverseSingleLink(page, link.url, maxRedirects);
+                results.set(link.url, { ...result, linkTexts: link.texts });
+            }
+            catch (error) {
+                results.set(link.url, {
+                    redirectChain: [link.url],
+                    responseBody: error instanceof Error ? error.toString() : String(error),
+                    responseCode: 0,
+                    isDead: true,
+                    linkTexts: link.texts,
+                });
+            }
+        }));
+        return results;
+    }
+    /**
+     * Traverses a single link, following redirects up to maxRedirects.
+     * Returns a LinkTraversalResult that includes the full redirect chain.
+     */
+    static async traverseSingleLink(page, link, maxRedirects) {
+        let currentUrl = link;
+        const redirectChain = [link];
+        let redirectCount = 0;
+        while (redirectCount < maxRedirects) {
+            const response = await page.context().request.get(currentUrl, {
+                maxRedirects: 0,
+                timeout: 10000,
+                failOnStatusCode: false,
+            });
+            const responseBody = await response.text();
+            const responseCode = response.status();
+            // TODO: Define better and more specific textual indicators.
+            const deadLinkIndicators = [
+                'page not found',
+                '404 error',
+                'content not available',
+            ];
+            const lowerBody = responseBody.toLowerCase();
+            // Mark as dead if status code is 404, 410, or >=500,
+            // or if one of the more specific phrases is found.
+            const isDead = responseCode === 404 ||
+                responseCode === 410 ||
+                responseCode >= 500 ||
+                deadLinkIndicators.some((indicator) => lowerBody.includes(indicator));
+            // Handle redirects.
+            if (responseCode >= 300 && responseCode < 400) {
+                const location = response.headers()['location'];
+                if (!location) {
+                    // No location header — cannot follow redirect.
+                    return {
+                        redirectChain,
+                        responseBody,
+                        responseCode,
+                        isDead: true,
+                    };
+                }
+                try {
+                    // Using new URL with currentUrl as base handles relative URLs.
+                    currentUrl = new URL(location, currentUrl).toString();
+                    redirectChain.push(currentUrl);
+                    redirectCount++;
+                    continue;
+                }
+                catch {
+                    return {
+                        redirectChain,
+                        responseBody,
+                        responseCode,
+                        isDead: true,
+                    };
+                }
+            }
+            else {
+                return {
+                    redirectChain,
+                    responseBody,
+                    responseCode,
+                    isDead,
+                };
+            }
+        }
+        // If max redirects reached without a final response, mark as dead.
+        return {
+            redirectChain,
+            responseBody: '',
+            responseCode: 0,
+            isDead: true,
+        };
+    }
+    /**
+     * Generates a JSON report of the link scan.
+     * The report now includes a "linkTexts" field for each link.
+     */
+    static async generateJsonReport(page, linksData) {
+        const currentPageUrl = page.url();
+        const deadLinks = [];
+        const workingLinks = [];
+        linksData.forEach((result, originalUrl) => {
+            const finalUrl = result.redirectChain[result.redirectChain.length - 1];
+            const linkData = {
+                originalUrl,
+                linkTexts: result.linkTexts, // All accumulated texts.
+                finalUrl,
+                responseCode: result.responseCode,
+                isDead: result.isDead,
+                redirectChain: result.redirectChain,
+                error: result.responseCode === 0 ? result.responseBody : undefined,
+            };
+            if (result.screenshotFilename) {
+                linkData.screenshot = result.screenshotFilename;
+            }
+            if (result.skipped) {
+                linkData.skipped = true;
+            }
+            if (result.isDead) {
+                deadLinks.push(linkData);
+            }
+            else {
+                workingLinks.push(linkData);
+            }
+        });
+        return {
+            scanDateTime: new Date().toISOString(),
+            sourcePageUrl: currentPageUrl,
+            summary: {
+                totalLinks: linksData.size,
+                deadLinks: deadLinks.length,
+                workingLinks: workingLinks.length,
+            },
+            deadLinks,
+            workingLinks,
+        };
+    }
+}
+exports.DetectBrokenLinksTool = DetectBrokenLinksTool;
+//# sourceMappingURL=DetectBrokenLinksTool.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DetectBrokenLinksTool.js","sourceRoot":"","sources":["../../../src/tools/DetectBrokenLinksTool.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAI9B,8DAA2D;AAmC3D,MAAa,qBAAsB,SAAQ,WAG1C;IACQ,MAAM,CAAU,IAAI,GAAG,mBAAmB,CAAC;IAElD;QACE,KAAK,CACH,qBAAqB,CAAC,IAAI,EAC1B,sEAAsE,EACtE,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,wCAAwC;QACxC,MAAM,KAAK,GAAG,MAAM,qBAAqB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAChE,MAAM,SAAS,GAAG,MAAM,qBAAqB,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAEzE,iDAAiD;QACjD,IAAI,UAAU,CAAC,kBAAkB,EAAE,CAAC;YAClC,MAAM,OAAO,CAAC,GAAG,CACf,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,EAAE;gBAClE,mEAAmE;gBACnE,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;oBACrC,IAAI,OAAyB,CAAC;oBAC9B,IAAI,CAAC;wBACH,MAAM,QAAQ,GACZ,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;wBACxD,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,CAAC;wBACzC,MAAM,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;wBACjD,MAAM,gBAAgB,GACpB,MAAM,iCAAe,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;wBACnD,4DAA4D;wBAC5D,MAAM,kBAAkB,GAAG,wBAAwB,kBAAkB,CACnE,WAAW,CACZ,IAAI,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC;wBACtB,MAAM,OAAO,CAAC,WAAW,CAAC,WAAW,CACnC,OAAO,CAAC,QAAQ,CAAC,EAAE,EACnB,kBAAkB,EAClB,gBAAgB,CACjB,CAAC;wBACF,MAAM,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;oBACjD,CAAC;oBAAC,OAAO,MAAM,EAAE,CAAC;wBAChB,mDAAmD;oBACrD,CAAC;4BAAS,CAAC;wBACT,IAAI,OAAO,EAAE,CAAC;4BACZ,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;wBACxC,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC,CAAC,CACH,CAAC;QACJ,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,qBAAqB,CAAC,kBAAkB,CAChE,IAAI,EACJ,SAAS,CACV,CAAC;QACF,MAAM,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC/D,OAAO;YACL,YAAY,EAAE,IAAI;YAClB,MAAM,EAAE,iBAAiB;YACzB,QAAQ,EAAE,WAAW;SACtB,CAAC;IACJ,CAAC;IAEe,KAAK,CAAC,WAAW,CAC/B,OAAwB,EACxB,UAA8C;QAE9C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAU;QAC7C,yBAAyB;QACzB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;YACzC,OAAO,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC5D,GAAG,EAAE,CAAC,CAAC,IAAI;gBACX,IAAI,EAAE,CAAC,CAAC,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;aACnC,CAAC,CAAC,CAAC;QACN,CAAC,CAAC,CAAC;QAEH,qCAAqC;QACrC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;YAC5C,OAAO,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;iBACtD,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;gBACV,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;gBACjD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CACzB,+CAA+C,CAChD,CAAC;gBACF,OAAO,KAAK;oBACV,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE;oBACxD,CAAC,CAAC,IAAI,CAAC;YACX,CAAC,CAAC;iBACD,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,CAAoC,CAAC;QACxE,CAAC,CAAC,CAAC;QAEH,uCAAuC;QACvC,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;YAC7C,OAAO,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;gBACvE,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,EAAE;gBACvC,IAAI,EAAE,CAAC,EAAE,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;aACpC,CAAC,CAAC,CAAC;QACN,CAAC,CAAC,CAAC;QAEH,gEAAgE;QAChE,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAoB,CAAC;QAC7C,MAAM,QAAQ,GAAG,CAAC,GAAG,SAAS,EAAE,GAAG,YAAY,EAAE,GAAG,aAAa,CAAC,CAAC;QACnE,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;YAC5B,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAClC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC5B,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAChE,CAAC;qBAAM,CAAC;oBACN,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAE,CAAC;oBACtC,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;wBAClD,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBAC9B,CAAC;gBACH,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,uBAAuB;gBACvB,6EAA6E;YAC/E,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,KAAK,CAAC,aAAa,CAChC,IAAU,EACV,KAAiB;QAEjB,MAAM,OAAO,GAAG,IAAI,GAAG,EAGpB,CAAC;QACJ,MAAM,YAAY,GAAG,CAAC,CAAC;QAEvB,MAAM,OAAO,CAAC,GAAG,CACf,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACvB,+CAA+C;YAC/C,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;gBACnC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE;oBACpB,aAAa,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC;oBACzB,YAAY,EAAE,4BAA4B;oBAC1C,YAAY,EAAE,CAAC;oBACf,MAAM,EAAE,KAAK;oBACb,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,IAAI,CAAC,KAAK;iBACtB,CAAC,CAAC;gBACH,OAAO;YACT,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAC1C,IAAI,EACJ,IAAI,CAAC,GAAG,EACR,YAAY,CACb,CAAC;gBACF,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;YAC9D,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE;oBACpB,aAAa,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC;oBACzB,YAAY,EACV,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;oBAC3D,YAAY,EAAE,CAAC;oBACf,MAAM,EAAE,IAAI;oBACZ,SAAS,EAAE,IAAI,CAAC,KAAK;iBACtB,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC,CACH,CAAC;QACF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,KAAK,CAAC,kBAAkB,CACrC,IAAU,EACV,IAAY,EACZ,YAAoB;QAEpB,IAAI,UAAU,GAAG,IAAI,CAAC;QACtB,MAAM,aAAa,GAAa,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,aAAa,GAAG,CAAC,CAAC;QAEtB,OAAO,aAAa,GAAG,YAAY,EAAE,CAAC;YACpC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE;gBAC5D,YAAY,EAAE,CAAC;gBACf,OAAO,EAAE,KAAK;gBACd,gBAAgB,EAAE,KAAK;aACxB,CAAC,CAAC;YACH,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC3C,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;YAEvC,4DAA4D;YAC5D,MAAM,kBAAkB,GAAG;gBACzB,gBAAgB;gBAChB,WAAW;gBACX,uBAAuB;aACxB,CAAC;YACF,MAAM,SAAS,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC;YAC7C,qDAAqD;YACrD,mDAAmD;YACnD,MAAM,MAAM,GACV,YAAY,KAAK,GAAG;gBACpB,YAAY,KAAK,GAAG;gBACpB,YAAY,IAAI,GAAG;gBACnB,kBAAkB,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;YAExE,oBAAoB;YACpB,IAAI,YAAY,IAAI,GAAG,IAAI,YAAY,GAAG,GAAG,EAAE,CAAC;gBAC9C,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,CAAC;gBAChD,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,+CAA+C;oBAC/C,OAAO;wBACL,aAAa;wBACb,YAAY;wBACZ,YAAY;wBACZ,MAAM,EAAE,IAAI;qBACb,CAAC;gBACJ,CAAC;gBACD,IAAI,CAAC;oBACH,+DAA+D;oBAC/D,UAAU,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,QAAQ,EAAE,CAAC;oBACtD,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBAC/B,aAAa,EAAE,CAAC;oBAChB,SAAS;gBACX,CAAC;gBAAC,MAAM,CAAC;oBACP,OAAO;wBACL,aAAa;wBACb,YAAY;wBACZ,YAAY;wBACZ,MAAM,EAAE,IAAI;qBACb,CAAC;gBACJ,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO;oBACL,aAAa;oBACb,YAAY;oBACZ,YAAY;oBACZ,MAAM;iBACP,CAAC;YACJ,CAAC;QACH,CAAC;QAED,mEAAmE;QACnE,OAAO;YACL,aAAa;YACb,YAAY,EAAE,EAAE;YAChB,YAAY,EAAE,CAAC;YACf,MAAM,EAAE,IAAI;SACb,CAAC;IACJ,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,KAAK,CAAC,kBAAkB,CACrC,IAAU,EACV,SAAqE;QAErE,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAClC,MAAM,SAAS,GAAU,EAAE,CAAC;QAC5B,MAAM,YAAY,GAAU,EAAE,CAAC;QAE/B,SAAS,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE;YACxC,MAAM,QAAQ,GAAG,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACvE,MAAM,QAAQ,GAAQ;gBACpB,WAAW;gBACX,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,yBAAyB;gBACtD,QAAQ;gBACR,YAAY,EAAE,MAAM,CAAC,YAAY;gBACjC,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,aAAa,EAAE,MAAM,CAAC,aAAa;gBACnC,KAAK,EAAE,MAAM,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;aACnE,CAAC;YACF,IAAI,MAAM,CAAC,kBAAkB,EAAE,CAAC;gBAC9B,QAAQ,CAAC,UAAU,GAAG,MAAM,CAAC,kBAAkB,CAAC;YAClD,CAAC;YACD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;YAC1B,CAAC;YACD,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClB,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACN,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO;YACL,YAAY,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACtC,aAAa,EAAE,cAAc;YAC7B,OAAO,EAAE;gBACP,UAAU,EAAE,SAAS,CAAC,IAAI;gBAC1B,SAAS,EAAE,SAAS,CAAC,MAAM;gBAC3B,YAAY,EAAE,YAAY,CAAC,MAAM;aAClC;YACD,SAAS;YACT,YAAY;SACb,CAAC;IACJ,CAAC;;AA5TH,sDA6TC"}

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

@@ -0,0 +1,19 @@
+import { Tool } from './Tool';
+import { ToolCallContext } from '../models/ToolCallContext';
+import { ToolCallResult } from '../models/ToolCallResult';
+import { BaseToolGptParameters } from '../models/BaseToolGptParameters';
+interface DownloadPdfToolCoreParameters {
+    /**
+     * The URL of the PDF file to be downloaded.
+     */
+    url: string;
+}
+interface DownloadPdfToolGptParameters extends BaseToolGptParameters, DownloadPdfToolCoreParameters {
+}
+export declare class DownloadPdfTool extends Tool<DownloadPdfToolCoreParameters, DownloadPdfToolGptParameters> {
+    static readonly NAME = "downloadPdf";
+    constructor();
+    call(context: ToolCallContext, parameters: DownloadPdfToolCoreParameters): Promise<ToolCallResult>;
+    callFromGpt(context: ToolCallContext, parameters: DownloadPdfToolGptParameters): Promise<ToolCallResult>;
+}
+export {};

package/dist/esm/tools/DownloadPdfTool.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DownloadPdfTool = void 0;
+const Tool_1 = require("./Tool");
+class DownloadPdfTool extends Tool_1.Tool {
+    static NAME = 'downloadPdf';
+    constructor() {
+        super(DownloadPdfTool.NAME, 'Download the specified PDF file.', 'DownloadPdfToolCoreParameters', 'DownloadPdfToolGptParameters');
+    }
+    async call(context, parameters) {
+        const url = parameters.url;
+        if (!url.toLowerCase().endsWith('.pdf')) {
+            return {
+                isSuccessful: false,
+                forLlm: 'The provided URL does not point to a PDF file.',
+                metadata: null,
+            };
+        }
+        try {
+            const response = await fetch(url);
+            if (!response.ok) {
+                throw new Error(`HTTP error! status: ${response.status}`);
+            }
+            const pdfBytes = Buffer.from(await response.arrayBuffer());
+            const filename = new Date().toISOString() + '.pdf';
+            await context.persistence.setFlowFile(context.metadata.id, filename, pdfBytes);
+            return {
+                isSuccessful: true,
+                forLlm: `Successfully downloaded the PDF file: ${filename}`,
+                metadata: {
+                    pdfFilename: filename,
+                },
+            };
+        }
+        catch (e) {
+            return {
+                isSuccessful: false,
+                forLlm: `Failed to download the PDF file: ${e.message}`,
+                metadata: null,
+            };
+        }
+    }
+    async callFromGpt(context, parameters) {
+        return this.call(context, parameters);
+    }
+}
+exports.DownloadPdfTool = DownloadPdfTool;
+//# sourceMappingURL=DownloadPdfTool.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DownloadPdfTool.js","sourceRoot":"","sources":["../../../src/tools/DownloadPdfTool.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAe9B,MAAa,eAAgB,SAAQ,WAGpC;IACQ,MAAM,CAAU,IAAI,GAAG,aAAa,CAAC;IAE5C;QACE,KAAK,CACH,eAAe,CAAC,IAAI,EACpB,kCAAkC,EAClC,+BAA+B,EAC/B,8BAA8B,CAC/B,CAAC;IACJ,CAAC;IAEe,KAAK,CAAC,IAAI,CACxB,OAAwB,EACxB,UAAyC;QAEzC,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC;QAE3B,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACxC,OAAO;gBACL,YAAY,EAAE,KAAK;gBACnB,MAAM,EAAE,gDAAgD;gBACxD,QAAQ,EAAE,IAAI;aACf,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,uBAAuB,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YAC5D,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;YAC3D,MAAM,QAAQ,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,GAAG,MAAM,CAAC;YAEnD,MAAM,OAAO,CAAC,WAAW,CAAC,WAAW,CACnC,OAAO,CAAC,QAAQ,CAAC,EAAE,EACnB,QAAQ,EACR,QAAQ,CACT,CAAC;YAEF,OAAO;gBACL,YAAY,EAAE,IAAI;gBAClB,MAAM,EAAE,yCAAyC,QAAQ,EAAE;gBAC3D,QAAQ,EAAE;oBACR,WAAW,EAAE,QAAQ;iBACtB;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO;gBACL,YAAY,EAAE,KAAK;gBACnB,MAAM,EAAE,oCAAqC,CAAW,CAAC,OAAO,EAAE;gBAClE,QAAQ,EAAE,IAAI;aACf,CAAC;QACJ,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,WAAW,CAC/B,OAAwB,EACxB,UAAwC;QAExC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IACxC,CAAC;;AAjEH,0CAkEC"}

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

@@ -0,0 +1,50 @@
+import { Tool } from './Tool';
+import { ToolCallContext } from '../models/ToolCallContext';
+import { ToolCallResult } from '../models/ToolCallResult';
+import { Action } from './NavigateWithinStreetView';
+import { BaseToolGptParameters } from '../models/BaseToolGptParameters';
+export declare enum PropertyType {
+    RESIDENTIAL = "RESIDENTIAL",
+    RETAIL = "RETAIL",
+    OFFICE_BUILDING = "OFFICE_BUILDING",
+    INDUSTRIAL = "INDUSTRIAL",
+    EMPTY_LOT = "EMPTY_LOT"
+}
+export interface ExtractGoogleStreetviewEntityDataToolCoreParameters {
+    /**
+     * The target business/entity to keep a careful eye out for.
+     */
+    entityName: string;
+}
+export interface ExtractGoogleStreetviewEntityDataToolGptParameters extends BaseToolGptParameters, ExtractGoogleStreetviewEntityDataToolCoreParameters {
+}
+export interface Metadata {
+    businessSignage: string[];
+    otherSignage: string[];
+    isBusinessMatch: boolean;
+    imageId: string;
+    googleMapsStreetviewUrl: string;
+    typeOfProperty: PropertyType;
+    recommendedNextStepForStreetViewNavigator: Action;
+}
+export interface ExtractBusinessDataAtStreetViewResponse {
+    businessSignage: string[];
+    otherSignage: string[];
+    typeOfProperty: PropertyType;
+    recommendedNextStepForStreetViewNavigator: Action;
+}
+/**
+ * Extracts data from the current Google Maps Street View. If the current page is not a Google Maps
+ * Street View, then the operation is undefined.
+ */
+export declare class ExtractGoogleStreetviewEntityDataTool extends Tool<ExtractGoogleStreetviewEntityDataToolCoreParameters, ExtractGoogleStreetviewEntityDataToolGptParameters> {
+    static readonly NAME = "extractGoogleStreetviewEntityData";
+    constructor();
+    call(context: ToolCallContext, parameters: ExtractGoogleStreetviewEntityDataToolCoreParameters): Promise<ToolCallResult>;
+    callFromGpt(context: ToolCallContext, parameters: ExtractGoogleStreetviewEntityDataToolGptParameters): Promise<ToolCallResult>;
+    private wiggleMouseThenPause;
+    private extractEntityData;
+    private doesBusinessExistInSignage;
+    private static readonly EXTRACT_BUSINESS_DATA_SCHEMA;
+    private static readonly DOES_BUSINESS_EXIST_SCHEMA;
+}