donobu 1.0.0

package/dist/models/BrowserFramework.d.ts

@@ -0,0 +1,36 @@
+import { Browser, BrowserContext } from 'playwright';
+import { BrowserStorageState } from '../models/BrowserState';
+export declare class BrowserFramework {
+    readonly browser: Browser;
+    readonly browserContext: BrowserContext;
+    private static readonly DEVICES;
+    constructor(browser: Browser, browserContext: BrowserContext);
+    /**
+     * Returns the list of supported devices by name. These values can be passed as a deviceName to
+     * the {@link forDevice} function.
+     */
+    static supportedDevicesNames(): string[];
+    /**
+     * Connects to an existing Chromium browser using the Chrome DevTools Protocol (CDP) at the given
+     * URL. If the URL contains "${env.VARIABLE_NAME}", then it will be expanded to the value of the
+     * specified environment variable.
+     */
+    static forRemoteBrowser(remoteBrowserInstanceUrl: string, outputDir: string, storageState?: BrowserStorageState): Promise<BrowserFramework>;
+    /**
+     * If {@link storageState} is present, must be an object conforming to what is returned by
+     * {@link BrowserContext.storageState()}.
+     */
+    static forDevice(deviceName: string, headless: boolean, outputDir: string, storageState?: BrowserStorageState): Promise<BrowserFramework>;
+    private static forDeviceWithType;
+    private static browserFramework;
+    private static expandEnvVariablesInUrl;
+    /**
+     * Loads all the pre-canned browser device configurations from the local
+     * filesystem.
+     *
+     * The returned map keys the devices by their name (ex: 'Desktop Firefox').
+     *
+     * See `assets/devices.json` for details.
+     */
+    private static getDevices;
+}

package/dist/models/BrowserFramework.js

@@ -0,0 +1,164 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrowserFramework = void 0;
+const playwright_extra_1 = require("playwright-extra");
+const puppeteer_extra_plugin_stealth_1 = __importDefault(require("puppeteer-extra-plugin-stealth"));
+const JsonUtils_1 = require("../utils/JsonUtils");
+const InvalidParamValueException_1 = require("../exceptions/InvalidParamValueException");
+const path_1 = __importDefault(require("path"));
+class BrowserFramework {
+    browser;
+    browserContext;
+    static {
+        playwright_extra_1.firefox.use((0, puppeteer_extra_plugin_stealth_1.default)());
+        playwright_extra_1.chromium.use((0, puppeteer_extra_plugin_stealth_1.default)());
+        playwright_extra_1.webkit.use((0, puppeteer_extra_plugin_stealth_1.default)());
+    }
+    static DEVICES = BrowserFramework.getDevices();
+    constructor(browser, browserContext) {
+        this.browser = browser;
+        this.browserContext = browserContext;
+    }
+    /**
+     * Returns the list of supported devices by name. These values can be passed as a deviceName to
+     * the {@link forDevice} function.
+     */
+    static supportedDevicesNames() {
+        return [...BrowserFramework.DEVICES.keys()].reverse();
+    }
+    /**
+     * Connects to an existing Chromium browser using the Chrome DevTools Protocol (CDP) at the given
+     * URL. If the URL contains "${env.VARIABLE_NAME}", then it will be expanded to the value of the
+     * specified environment variable.
+     */
+    static async forRemoteBrowser(remoteBrowserInstanceUrl, outputDir, storageState) {
+        const expandedUrl = this.expandEnvVariablesInUrl(remoteBrowserInstanceUrl);
+        try {
+            const browser = await playwright_extra_1.chromium.connectOverCDP(expandedUrl);
+            const contextOptions = {
+                recordVideo: { dir: outputDir },
+            };
+            if (storageState) {
+                contextOptions.storageState = storageState;
+            }
+            return new BrowserFramework(browser, await browser.newContext(contextOptions));
+        }
+        catch (_) {
+            throw new InvalidParamValueException_1.InvalidParamValueException('remoteBrowserInstanceUrl', remoteBrowserInstanceUrl);
+        }
+    }
+    /**
+     * If {@link storageState} is present, must be an object conforming to what is returned by
+     * {@link BrowserContext.storageState()}.
+     */
+    static async forDevice(deviceName, headless, outputDir, storageState) {
+        const device = BrowserFramework.DEVICES.get(deviceName);
+        if (device) {
+            return this.forDeviceWithType(deviceName, device.defaultBrowserType, headless, outputDir, storageState);
+        }
+        else {
+            throw new InvalidParamValueException_1.InvalidParamValueException('deviceName', deviceName);
+        }
+    }
+    static async forDeviceWithType(deviceName, browserType, headless, outputDir, storageState) {
+        const device = BrowserFramework.DEVICES.get(deviceName);
+        if (device) {
+            const contextOptions = {
+                userAgent: device.userAgent,
+                recordVideo: {
+                    dir: outputDir,
+                    size: {
+                        width: device.viewport?.width ?? 1280,
+                        height: device.viewport?.height ?? 720,
+                    },
+                },
+                viewport: {
+                    width: device.viewport?.width ?? 1280,
+                    height: device.viewport?.height ?? 720,
+                },
+                screen: {
+                    width: device.screen?.width ?? device.viewport?.width ?? 1280,
+                    height: device.screen?.height ?? device.viewport?.height ?? 720,
+                },
+                deviceScaleFactor: device.deviceScaleFactor ?? 1.0,
+                isMobile: device.isMobile ?? false,
+                hasTouch: device.hasTouch ?? false,
+            };
+            if (storageState) {
+                contextOptions.storageState = storageState;
+            }
+            const launchOptions = {
+                headless,
+                args: [
+                    '--ignore-certificate-errors',
+                    '--disable-blink-features=AutomationControlled',
+                ],
+            };
+            return this.browserFramework(contextOptions, launchOptions, browserType.toLowerCase());
+        }
+        else {
+            throw new InvalidParamValueException_1.InvalidParamValueException('deviceName', deviceName);
+        }
+    }
+    static async browserFramework(contextOptions, launchOptions, browserType) {
+        let browser;
+        switch (browserType) {
+            case 'firefox':
+                browser = await playwright_extra_1.firefox.launch(launchOptions);
+                break;
+            case 'chromium':
+                browser = await playwright_extra_1.chromium.launch(launchOptions);
+                break;
+            case 'chrome':
+                browser = await playwright_extra_1.chromium.launch({
+                    ...launchOptions,
+                    channel: 'chrome',
+                });
+                break;
+            case 'webkit':
+            case 'ios':
+                browser = await playwright_extra_1.webkit.launch(launchOptions);
+                break;
+            default:
+                throw new InvalidParamValueException_1.InvalidParamValueException('browserType', browserType);
+        }
+        try {
+            const context = await browser.newContext(contextOptions);
+            return new BrowserFramework(browser, context);
+        }
+        catch (error) {
+            await browser.close();
+            throw error;
+        }
+    }
+    static expandEnvVariablesInUrl(url) {
+        const pattern = /\${env\.(\w+)}/g;
+        return url.replace(pattern, (_, envVarName) => {
+            const envVarValue = process.env[envVarName];
+            if (!envVarValue) {
+                throw new InvalidParamValueException_1.InvalidParamValueException(envVarName, null);
+            }
+            return envVarValue;
+        });
+    }
+    /**
+     * Loads all the pre-canned browser device configurations from the local
+     * filesystem.
+     *
+     * The returned map keys the devices by their name (ex: 'Desktop Firefox').
+     *
+     * See `assets/devices.json` for details.
+     */
+    static getDevices() {
+        const rawDevices = JsonUtils_1.JsonUtils.readResourceAsJson(path_1.default.join('devices.json'));
+        if (!rawDevices) {
+            throw new Error('Failed to load devices configuration');
+        }
+        return new Map(Object.entries(rawDevices));
+    }
+}
+exports.BrowserFramework = BrowserFramework;
+//# sourceMappingURL=BrowserFramework.js.map

package/dist/models/BrowserFramework.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrowserFramework.js","sourceRoot":"","sources":["../../src/models/BrowserFramework.ts"],"names":[],"mappings":";;;;;;AAMA,uDAA6D;AAC7D,oGAAqD;AACrD,kDAA+C;AAC/C,yFAAsF;AAGtF,gDAAwB;AAExB,MAAa,gBAAgB;IAWT;IACA;IAXlB;QACE,0BAAO,CAAC,GAAG,CAAC,IAAA,wCAAO,GAAE,CAAC,CAAC;QACvB,2BAAQ,CAAC,GAAG,CAAC,IAAA,wCAAO,GAAE,CAAC,CAAC;QACxB,yBAAM,CAAC,GAAG,CAAC,IAAA,wCAAO,GAAE,CAAC,CAAC;IACxB,CAAC;IAEO,MAAM,CAAU,OAAO,GAC7B,gBAAgB,CAAC,UAAU,EAAE,CAAC;IAEhC,YACkB,OAAgB,EAChB,cAA8B;QAD9B,YAAO,GAAP,OAAO,CAAS;QAChB,mBAAc,GAAd,cAAc,CAAgB;IAC7C,CAAC;IAEJ;;;OAGG;IACI,MAAM,CAAC,qBAAqB;QACjC,OAAO,CAAC,GAAG,gBAAgB,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAClC,wBAAgC,EAChC,SAAiB,EACjB,YAAkC;QAElC,MAAM,WAAW,GAAG,IAAI,CAAC,uBAAuB,CAAC,wBAAwB,CAAC,CAAC;QAE3E,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,2BAAQ,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;YAC3D,MAAM,cAAc,GAA0B;gBAC5C,WAAW,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE;aAChC,CAAC;YAEF,IAAI,YAAY,EAAE,CAAC;gBACjB,cAAc,CAAC,YAAY,GAAG,YAAY,CAAC;YAC7C,CAAC;YAED,OAAO,IAAI,gBAAgB,CACzB,OAAO,EACP,MAAM,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CACzC,CAAC;QACJ,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,uDAA0B,CAClC,0BAA0B,EAC1B,wBAAwB,CACzB,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,SAAS,CAC3B,UAAkB,EAClB,QAAiB,EACjB,SAAiB,EACjB,YAAkC;QAElC,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAExD,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,IAAI,CAAC,iBAAiB,CAC3B,UAAU,EACV,MAAM,CAAC,kBAAkB,EACzB,QAAQ,EACR,SAAS,EACT,YAAY,CACb,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,uDAA0B,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,iBAAiB,CACpC,UAAkB,EAClB,WAAmB,EACnB,QAAiB,EACjB,SAAiB,EACjB,YAAkB;QAElB,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAExD,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,cAAc,GAA0B;gBAC5C,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,WAAW,EAAE;oBACX,GAAG,EAAE,SAAS;oBACd,IAAI,EAAE;wBACJ,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,KAAK,IAAI,IAAI;wBACrC,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG;qBACvC;iBACF;gBACD,QAAQ,EAAE;oBACR,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,KAAK,IAAI,IAAI;oBACrC,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG;iBACvC;gBACD,MAAM,EAAE;oBACN,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,IAAI,MAAM,CAAC,QAAQ,EAAE,KAAK,IAAI,IAAI;oBAC7D,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG;iBAChE;gBACD,iBAAiB,EAAE,MAAM,CAAC,iBAAiB,IAAI,GAAG;gBAClD,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,KAAK;gBAClC,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,KAAK;aACnC,CAAC;YAEF,IAAI,YAAY,EAAE,CAAC;gBACjB,cAAc,CAAC,YAAY,GAAG,YAAY,CAAC;YAC7C,CAAC;YAED,MAAM,aAAa,GAAkB;gBACnC,QAAQ;gBACR,IAAI,EAAE;oBACJ,6BAA6B;oBAC7B,+CAA+C;iBAChD;aACF,CAAC;YAEF,OAAO,IAAI,CAAC,gBAAgB,CAC1B,cAAc,EACd,aAAa,EACb,WAAW,CAAC,WAAW,EAAE,CAC1B,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,uDAA0B,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,gBAAgB,CACnC,cAAqC,EACrC,aAA4B,EAC5B,WAAmB;QAEnB,IAAI,OAAgB,CAAC;QAErB,QAAQ,WAAW,EAAE,CAAC;YACpB,KAAK,SAAS;gBACZ,OAAO,GAAG,MAAM,0BAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;gBAC9C,MAAM;YACR,KAAK,UAAU;gBACb,OAAO,GAAG,MAAM,2BAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;gBAC/C,MAAM;YACR,KAAK,QAAQ;gBACX,OAAO,GAAG,MAAM,2BAAQ,CAAC,MAAM,CAAC;oBAC9B,GAAG,aAAa;oBAChB,OAAO,EAAE,QAAQ;iBAClB,CAAC,CAAC;gBACH,MAAM;YACR,KAAK,QAAQ,CAAC;YACd,KAAK,KAAK;gBACR,OAAO,GAAG,MAAM,yBAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;gBAC7C,MAAM;YACR;gBACE,MAAM,IAAI,uDAA0B,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;QACrE,CAAC;QAED,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;YACzD,OAAO,IAAI,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;YACtB,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,uBAAuB,CAAC,GAAW;QAChD,MAAM,OAAO,GAAG,iBAAiB,CAAC;QAClC,OAAO,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,EAAE;YAC5C,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAC5C,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,MAAM,IAAI,uDAA0B,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YACzD,CAAC;YACD,OAAO,WAAW,CAAC;QACrB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACK,MAAM,CAAC,UAAU;QACvB,MAAM,UAAU,GAAG,qBAAS,CAAC,kBAAkB,CAC7C,cAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CACO,CAAC;QAEnC,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,OAAO,IAAI,GAAG,CAAwB,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;IACpE,CAAC;;AA1MH,4CA2MC"}

package/dist/models/BrowserState.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This type is expected to match the data returned by the Playwright `BrowserContext.storageState()` method.
+ */
+export type BrowserStorageState = {
+    readonly cookies: Array<{
+        readonly name: string;
+        readonly value: string;
+        readonly domain: string;
+        readonly path: string;
+        /**
+         * Unix time in seconds.
+         */
+        readonly expires: number;
+        readonly httpOnly: boolean;
+        readonly secure: boolean;
+        readonly sameSite: 'Strict' | 'Lax' | 'None';
+    }>;
+    readonly origins: Array<{
+        readonly origin: string;
+        readonly localStorage: Array<{
+            readonly name: string;
+            readonly value: string;
+        }>;
+    }>;
+};

package/dist/models/BrowserState.js

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

package/dist/models/BrowserState.js.map

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

package/dist/models/BrowserStateFlowReference.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Specifies how to reference a flow from which to restore browser state.
+ */
+export type BrowserStateFlowReference = {
+    readonly type: 'id';
+    readonly value: string;
+} | {
+    readonly type: 'name';
+    readonly value: string;
+};

package/dist/models/BrowserStateFlowReference.js

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

package/dist/models/BrowserStateFlowReference.js.map

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

package/dist/models/CreateDonobuFlow.d.ts

@@ -0,0 +1,88 @@
+import { CustomTool } from './CustomTool';
+import { ProposedToolCall } from './ProposedToolCall';
+import { RunMode } from './FlowMetadata';
+import { JSONSchema7 } from 'json-schema';
+import { BrowserStateFlowReference } from './BrowserStateFlowReference';
+/**
+ * This is the expected payload for a request to create a new DonobuFlow flow.
+ */
+export type CreateDonobuFlow = {
+    /** The initial website to load */
+    readonly targetWebsite: string;
+    /**
+     * The overall objective to pursue; can only be omitted if `initialRunMode`
+     * has an effective value of `INSTRUCT` or `DETEMINISTIC`.
+     */
+    readonly overallObjective?: string;
+    /** The name for this flow; if present, must be fewer than 256 characters. */
+    readonly name?: string;
+    /**
+     * When starting the flow, initialize the browser state from the given flow
+     * by its ID or name.
+     **/
+    readonly initialBrowserState?: BrowserStateFlowReference;
+    /** If set to true, saves the browser state at the end of the flow. */
+    readonly persistBrowserState?: boolean;
+    /**
+     * The name of the device to run the flow with. See `devices.json` for details.
+     * If not specified, defaults to DonobuFlowsManager.DEFAULT_DEVICE_NAME unless
+     * remoteBrowserInstanceUrl is specified. If this is non-null, then
+     * remoteBrowserInstanceUrl must be null.
+     */
+    readonly deviceName?: string;
+    /**
+     * The URL of a remote browser instance to connect to using the Chrome DevTools
+     * Protocol (CDP). If this is non-null, then deviceName must be null. If the URL
+     * contains "${env.VARIABLE_NAME}", then it will be expanded to the value of the
+     * specified environment variable.
+     */
+    readonly remoteBrowserInstanceUrl?: string;
+    /**
+     * The URL to HTTP POST to when the flow completes. The body will contain a
+     * JSON object with single field, "id", of which is the ID of the flow that
+     * completed.
+     */
+    readonly callbackUrl?: string;
+    /**
+     * If true, will not open a real browser window to perform the flow.
+     * If remoteBrowserInstanceUrl is non-null, this parameter is ignored.
+     */
+    readonly headless?: boolean;
+    /**
+     * Custom tools to enable for this flow. Any tools specified here will be
+     * implicitly added to allowedTools.
+     */
+    readonly customTools?: CustomTool[];
+    /**
+     * The maximum number of times to iterate with the underlying GPT.
+     */
+    readonly maxIterations?: number;
+    /**
+     * The name of a specific GPT configuration to use. If the corresponding GPT
+     * configuration is not defined or unresolvable, the default flow agent
+     * configuration will be used.
+     **/
+    readonly gptConfigNameOverride?: string;
+    /** The default amount of time a tool tip should show (in milliseconds). */
+    readonly defaultToolTipDurationMilliseconds?: number;
+    /**
+     * The initial run mode of the flow. If not specified, defaults to
+     * AUTONOMOUS if gptPlatform is non-null, otherwise, defaults to INSTRUCT.
+     */
+    readonly initialRunMode?: RunMode;
+    /**
+     * Set to true if the in-browser control panel should be enabled.
+     * If the headless parameter is true, then this parameter is ignored.
+     */
+    readonly isControlPanelEnabled?: boolean;
+    /**
+     * If present and non-empty, will constrain the flow to only use these tools (by
+     * Tool.name()). If null or empty, then there are no constraints on the types of
+     * tools used. Note that all tools in customTools are implicitly added here.
+     */
+    readonly allowedTools?: string[];
+    /** An ordered series of tool calls to invoke when starting the flow. */
+    readonly toolCallsOnStart?: ProposedToolCall<any>[];
+    /** If non-null, the Donobu flow will attempt to save its result using this JSON-schema. */
+    readonly resultJsonSchema?: JSONSchema7;
+};

package/dist/models/CreateDonobuFlow.js

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

package/dist/models/CreateDonobuFlow.js.map

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

package/dist/models/CreateGoogleSteetviewExtractionFlow.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This is the expected payload for a request to create a new DonobuFlow that is
+ * specific for SpecialFlowsApi.extractGoogleStreetviewEntityData.
+ */
+export type CreateGoogleSteetviewExtractionFlow = {
+    /**
+     * The name of the business/entity to verify. If this is specified, then entityLocation
+     * must also be specified. If this is null, then googleMapsUrl cannot also be null.
+     */
+    readonly entityName?: string | null;
+    /**
+     * The location of the business/entity to verify. If this is specified, then entityName
+     * must also be specified. If this is null, then googleMapsUrl cannot also be null.
+     */
+    readonly entityLocation?: string | null;
+    /**
+     * The Google Maps URL of the entity to verify. If this is null, then entityName
+     * and entityLocation cannot also be null.
+     */
+    readonly googleMapsUrl?: string | null;
+};

package/dist/models/CreateGoogleSteetviewExtractionFlow.js

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

package/dist/models/CreateGoogleSteetviewExtractionFlow.js.map

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

package/dist/models/CustomTool.d.ts

@@ -0,0 +1,9 @@
+/**
+ * A definition of a user-defined tool to use for a DonobuFlow.
+ */
+export type CustomTool = {
+    readonly name: string;
+    readonly description: string;
+    readonly jsonSchema: Record<string, unknown>;
+    readonly javascript: string;
+};

package/dist/models/CustomTool.js

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

package/dist/models/CustomTool.js.map

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

package/dist/models/DonobuAgentType.d.ts

@@ -0,0 +1,2 @@
+export declare const DonobuAgent: readonly ["flow-runner"];
+export type DonobuAgent = (typeof DonobuAgent)[number];

package/dist/models/DonobuAgentType.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DonobuAgent = void 0;
+exports.DonobuAgent = ['flow-runner'];
+//# sourceMappingURL=DonobuAgentType.js.map

package/dist/models/DonobuAgentType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DonobuAgentType.js","sourceRoot":"","sources":["../../src/models/DonobuAgentType.ts"],"names":[],"mappings":";;;AAAa,QAAA,WAAW,GAAG,CAAC,aAAa,CAAU,CAAC"}

package/dist/models/DonobuAnnotated.d.ts

@@ -0,0 +1,23 @@
+import { ElementSelectorForReplay } from './ElementSelectorForReplay';
+/**
+ * Tools that specify a numbered Donobu annotation to indicate which element to
+ * interact with and support deterministic reruns should extend this interface.
+ */
+export interface DonobuAnnotated {
+    /**
+     * The reason why this particular numbered annotation was chosen.
+     */
+    whyThisAnnotation: string;
+    /**
+     * The numbered annotation of the element to click.
+     */
+    annotation: string;
+    /**
+     * IGNORE THIS PARAMETER. Set to a value of null.
+     */
+    selectorForReplay?: ElementSelectorForReplay;
+}
+export declare const DonobuAnnotated: {
+    /** Returns true if the tool call is considered a replay from a previous run. */
+    isReplay(parameters: DonobuAnnotated): boolean;
+};

package/dist/models/DonobuAnnotated.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DonobuAnnotated = void 0;
+exports.DonobuAnnotated = {
+    /** Returns true if the tool call is considered a replay from a previous run. */
+    isReplay(parameters) {
+        return ((!parameters.annotation || parameters.annotation.trim() === '') &&
+            parameters.selectorForReplay !== undefined &&
+            parameters.selectorForReplay.element.length > 0);
+    },
+};
+//# sourceMappingURL=DonobuAnnotated.js.map

package/dist/models/DonobuAnnotated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DonobuAnnotated.js","sourceRoot":"","sources":["../../src/models/DonobuAnnotated.ts"],"names":[],"mappings":";;;AAuBa,QAAA,eAAe,GAAG;IAC7B,gFAAgF;IAChF,QAAQ,CAAC,UAA2B;QAClC,OAAO,CACL,CAAC,CAAC,UAAU,CAAC,UAAU,IAAI,UAAU,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;YAC/D,UAAU,CAAC,iBAAiB,KAAK,SAAS;YAC1C,UAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAChD,CAAC;IACJ,CAAC;CACF,CAAC"}

package/dist/models/DonobuDeploymentEnvironment.d.ts

@@ -0,0 +1,5 @@
+export declare enum DonobuDeploymentEnvironment {
+    LOCAL = "LOCAL",
+    DONOBU_HOSTED_MULTI_TENANT = "DONOBU_HOSTED_MULTI_TENANT",
+    DONOBU_HOSTED_SINGLE_TENANT = "DONOBU_HOSTED_SINGLE_TENANT"
+}

package/dist/models/DonobuDeploymentEnvironment.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DonobuDeploymentEnvironment = void 0;
+var DonobuDeploymentEnvironment;
+(function (DonobuDeploymentEnvironment) {
+    DonobuDeploymentEnvironment["LOCAL"] = "LOCAL";
+    DonobuDeploymentEnvironment["DONOBU_HOSTED_MULTI_TENANT"] = "DONOBU_HOSTED_MULTI_TENANT";
+    DonobuDeploymentEnvironment["DONOBU_HOSTED_SINGLE_TENANT"] = "DONOBU_HOSTED_SINGLE_TENANT";
+})(DonobuDeploymentEnvironment || (exports.DonobuDeploymentEnvironment = DonobuDeploymentEnvironment = {}));
+//# sourceMappingURL=DonobuDeploymentEnvironment.js.map

package/dist/models/DonobuDeploymentEnvironment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DonobuDeploymentEnvironment.js","sourceRoot":"","sources":["../../src/models/DonobuDeploymentEnvironment.ts"],"names":[],"mappings":";;;AAAA,IAAY,2BAIX;AAJD,WAAY,2BAA2B;IACrC,8CAAe,CAAA;IACf,wFAAyD,CAAA;IACzD,0FAA2D,CAAA;AAC7D,CAAC,EAJW,2BAA2B,2CAA3B,2BAA2B,QAItC"}

package/dist/models/DonobuErrorResponse.d.ts

@@ -0,0 +1,13 @@
+/**
+ * A thin response wrapper for non-5xx errors.
+ */
+export type DonobuErrorResponse = {
+    /**
+     * The Donobu error code. This matches DonobuException's donobuErrorCode.
+     */
+    readonly code: string;
+    /**
+     * The human-readable message for the error. This matches DonobuException's userFacingMessage.
+     */
+    readonly message: string;
+};

package/dist/models/DonobuErrorResponse.js

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

package/dist/models/DonobuErrorResponse.js.map

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

package/dist/models/ElementSelector.d.ts

@@ -0,0 +1,14 @@
+/**
+ * A query structure used to resolve specific a HTML element in a webpage.
+ */
+export type ElementSelector = {
+    /**
+     * An ordered list of element selectors, going from most specific to least specific.
+     */
+    readonly element: string[];
+    /**
+     * A selector for the corresponding frame of the element to select.
+     * If null, this means the primary frame of the page is used.
+     */
+    readonly frame: string | null;
+};

package/dist/models/ElementSelector.js

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

package/dist/models/ElementSelector.js.map

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

package/dist/models/ElementSelectorForReplay.d.ts

@@ -0,0 +1,14 @@
+/**
+ * A query structure used to resolve specific a HTML element in a webpage.
+ */
+export type ElementSelector = {
+    /**
+     * An ordered list of element selectors, going from most specific to least specific.
+     */
+    readonly element: string[];
+    /**
+     * A selector for the corresponding frame of the element to select.
+     * If null, this means the primary frame of the page is used.
+     */
+    readonly frame: string | null;
+};

package/dist/models/ElementSelectorForReplay.js

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

package/dist/models/ElementSelectorForReplay.js.map

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