donobu 1.0.0

package/dist/esm/tools/Tool.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tool = void 0;
+const VerbConverter_1 = require("../utils/VerbConverter");
+const JsonUtils_1 = require("../utils/JsonUtils");
+/** Represents a tool call to be invoked by a DonobuFlow. */
+class Tool {
+    /**
+     * This is the name for the tool that will be shared with the LLM when making requests.
+     */
+    name;
+    /** This is the description that will be shared with the LLM when making requests. */
+    description;
+    /** This is the JSON-schema for the tool when it is invoked by a non-LLM. */
+    jsonSchema;
+    /**
+     * This is the JSON-schema that will be shared with the LLM when making
+     * requests during autonomous flows.
+     **/
+    jsonSchemaForGpt;
+    /**
+     * This is the message that will be displayed in the front-end control panel when this tool is
+     * invoked, assuming the control panel is enabled.
+     */
+    controlPanelMessage;
+    /** Returns true if this tool requires the usage of a GPT. */
+    requiresGpt;
+    constructor(name, description, parametersTypeNameForNonGptSchema, parametersTypeNameForGptSchema, requiresGpt = false) {
+        this.name = name;
+        this.description = description;
+        this.jsonSchema = JsonUtils_1.JsonUtils.getJsonSchemaFromTypeName(parametersTypeNameForNonGptSchema);
+        this.jsonSchemaForGpt = JsonUtils_1.JsonUtils.getJsonSchemaFromTypeName(parametersTypeNameForGptSchema);
+        this.requiresGpt = requiresGpt;
+        this.controlPanelMessage = VerbConverter_1.VerbConverter.toPresentTenseAction(this.name);
+    }
+}
+exports.Tool = Tool;
+//# sourceMappingURL=Tool.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Tool.js","sourceRoot":"","sources":["../../../src/tools/Tool.ts"],"names":[],"mappings":";;;AAGA,0DAAuD;AACvD,kDAA+C;AAE/C,4DAA4D;AAC5D,MAAsB,IAAI;IACxB;;OAEG;IACa,IAAI,CAAS;IAE7B,qFAAqF;IACrE,WAAW,CAAS;IAEpC,4EAA4E;IAC5D,UAAU,CAAc;IAExC;;;QAGI;IACY,gBAAgB,CAAc;IAE9C;;;OAGG;IACa,mBAAmB,CAAS;IAE5C,6DAA6D;IAC7C,WAAW,CAAU;IAErC,YACE,IAAY,EACZ,WAAmB,EACnB,iCAAyC,EACzC,8BAAsC,EACtC,WAAW,GAAG,KAAK;QAEnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,UAAU,GAAG,qBAAS,CAAC,yBAAyB,CACnD,iCAAiC,CACjC,CAAC;QACH,IAAI,CAAC,gBAAgB,GAAG,qBAAS,CAAC,yBAAyB,CACzD,8BAA8B,CAC9B,CAAC;QACH,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,mBAAmB,GAAG,6BAAa,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3E,CAAC;CAiBF;AA7DD,oBA6DC"}

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

@@ -0,0 +1,19 @@
+import { Tool } from './Tool';
+import { ToolCallContext } from '../models/ToolCallContext';
+import { ToolCallResult } from '../models/ToolCallResult';
+import { CreateDonobuFlow } from '../models/CreateDonobuFlow';
+import { BaseToolGptParameters } from '../models/BaseToolGptParameters';
+export interface TriggerDonobuFlowToolCoreParameters extends BaseToolGptParameters {
+    /**
+     * The parameters to use for the new Donobu flow.
+     */
+    donobuFlowParameters: CreateDonobuFlow;
+}
+export interface TriggerDonobuFlowToolGptParameters extends BaseToolGptParameters, TriggerDonobuFlowToolCoreParameters {
+}
+export declare class TriggerDonobuFlowTool extends Tool<TriggerDonobuFlowToolCoreParameters, TriggerDonobuFlowToolGptParameters> {
+    static readonly NAME = "triggerDonobuFlow";
+    constructor();
+    call(context: ToolCallContext, parameters: TriggerDonobuFlowToolCoreParameters): Promise<ToolCallResult>;
+    callFromGpt(context: ToolCallContext, parameters: TriggerDonobuFlowToolGptParameters): Promise<ToolCallResult>;
+}

package/dist/esm/tools/TriggerDonobuFlowTool.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TriggerDonobuFlowTool = void 0;
+const Tool_1 = require("./Tool");
+class TriggerDonobuFlowTool extends Tool_1.Tool {
+    static NAME = 'triggerDonobuFlow';
+    constructor() {
+        super(TriggerDonobuFlowTool.NAME, `Trigger a new Donobu flow. Note that the new flow will only have the specific context given via the
+"donobuFlowParameters" field and runs in its own distinct browser environment, so be detailed when
+specifying this data! Critical fields are "targetWebsite", "overallObjective", and "resultJsonSchema".
+The other fields may be ignored if they are not relevant to the flow.`, 'TriggerDonobuFlowToolCoreParameters', 'TriggerDonobuFlowToolGptParameters');
+    }
+    async call(context, parameters) {
+        const flowHandle = await context.flowsManager.createFlow(parameters.donobuFlowParameters);
+        return {
+            isSuccessful: true,
+            forLlm: `Successfully triggered a new Donobu flow with ID: ${flowHandle.donobuFlow.metadata.id}`,
+            metadata: flowHandle.donobuFlow.metadata,
+        };
+    }
+    async callFromGpt(context, parameters) {
+        return this.call(context, parameters);
+    }
+}
+exports.TriggerDonobuFlowTool = TriggerDonobuFlowTool;
+//# sourceMappingURL=TriggerDonobuFlowTool.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TriggerDonobuFlowTool.js","sourceRoot":"","sources":["../../../src/tools/TriggerDonobuFlowTool.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAiB9B,MAAa,qBAAsB,SAAQ,WAG1C;IACQ,MAAM,CAAU,IAAI,GAAG,mBAAmB,CAAC;IAElD;QACE,KAAK,CACH,qBAAqB,CAAC,IAAI,EAC1B;;;sEAGgE,EAChE,qCAAqC,EACrC,oCAAoC,CACrC,CAAC;IACJ,CAAC;IAEe,KAAK,CAAC,IAAI,CACxB,OAAwB,EACxB,UAA+C;QAE/C,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC,UAAU,CACtD,UAAU,CAAC,oBAAoB,CAChC,CAAC;QACF,OAAO;YACL,YAAY,EAAE,IAAI;YAClB,MAAM,EAAE,qDAAqD,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChG,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,QAAQ;SACzC,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;;AArCH,sDAsCC"}

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

@@ -0,0 +1,18 @@
+import { Tool } from './Tool';
+import { ToolCallContext } from '../models/ToolCallContext';
+import { ToolCallResult } from '../models/ToolCallResult';
+import { BaseToolGptParameters } from '../models/BaseToolGptParameters';
+export interface WaitToolCoreParameters {
+    /**
+     * The number of seconds to wait.
+     */
+    seconds: number;
+}
+export interface WaitToolGptParameters extends BaseToolGptParameters, WaitToolCoreParameters {
+}
+export declare class WaitTool extends Tool<WaitToolCoreParameters, WaitToolGptParameters> {
+    static readonly NAME = "wait";
+    constructor();
+    call(context: ToolCallContext, parameters: WaitToolCoreParameters): Promise<ToolCallResult>;
+    callFromGpt(context: ToolCallContext, parameters: WaitToolGptParameters): Promise<ToolCallResult>;
+}

package/dist/esm/tools/WaitTool.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WaitTool = void 0;
+const Tool_1 = require("./Tool");
+const ToolCallResult_1 = require("../models/ToolCallResult");
+class WaitTool extends Tool_1.Tool {
+    static NAME = 'wait';
+    constructor() {
+        super(WaitTool.NAME, 'Wait the given number of seconds.', 'WaitToolCoreParameters', 'WaitToolGptParameters');
+    }
+    async call(context, parameters) {
+        await context.page.waitForTimeout(parameters.seconds * 1000);
+        return ToolCallResult_1.ToolCallResult.successful();
+    }
+    async callFromGpt(context, parameters) {
+        return this.call(context, parameters);
+    }
+}
+exports.WaitTool = WaitTool;
+//# sourceMappingURL=WaitTool.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WaitTool.js","sourceRoot":"","sources":["../../../src/tools/WaitTool.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAE9B,6DAA0D;AAa1D,MAAa,QAAS,SAAQ,WAG7B;IACQ,MAAM,CAAU,IAAI,GAAG,MAAM,CAAC;IAErC;QACE,KAAK,CACH,QAAQ,CAAC,IAAI,EACb,mCAAmC,EACnC,wBAAwB,EACxB,uBAAuB,CACxB,CAAC;IACJ,CAAC;IAEe,KAAK,CAAC,IAAI,CACxB,OAAwB,EACxB,UAAkC;QAElC,MAAM,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;QAC7D,OAAO,+BAAc,CAAC,UAAU,EAAE,CAAC;IACrC,CAAC;IAEe,KAAK,CAAC,WAAW,CAC/B,OAAwB,EACxB,UAAiC;QAEjC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IACxC,CAAC;;AA5BH,4BA6BC"}

package/dist/esm/utils/DirectoryUtils.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This is the base working directory for the entire application. Care is made to ensure we do not
+ * access data outside of this directory to maintain proper permissions across platforms.
+ * Returns platform-specific application data directories:
+ * - macOS: ~/Library/Application Support/Donobu
+ * - Windows: %APPDATA%/Donobu
+ * - Linux: ~/.config/Donobu
+ *
+ * If the BASE_WORKING_DIR environment variable is set, its value is used instead.
+ */
+export declare function baseWorkingDirectory(): string;

package/dist/esm/utils/DirectoryUtils.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.baseWorkingDirectory = baseWorkingDirectory;
+const path_1 = require("path");
+const os_1 = require("os");
+/**
+ * This is the base working directory for the entire application. Care is made to ensure we do not
+ * access data outside of this directory to maintain proper permissions across platforms.
+ * Returns platform-specific application data directories:
+ * - macOS: ~/Library/Application Support/Donobu
+ * - Windows: %APPDATA%/Donobu
+ * - Linux: ~/.config/Donobu
+ *
+ * If the BASE_WORKING_DIR environment variable is set, its value is used instead.
+ */
+function baseWorkingDirectory() {
+    const persistenceDirOverride = process.env['BASE_WORKING_DIR'];
+    if (persistenceDirOverride) {
+        return persistenceDirOverride;
+    }
+    const appName = 'Donobu';
+    switch ((0, os_1.platform)()) {
+        case 'win32':
+            // Windows - typically use %APPDATA% (Roaming).
+            return (0, path_1.join)(process.env.APPDATA || (0, path_1.join)((0, os_1.homedir)(), 'AppData', 'Roaming'), appName);
+        case 'darwin':
+            // macOS
+            return (0, path_1.join)((0, os_1.homedir)(), 'Library', 'Application Support', appName);
+        case 'linux':
+            // Linux - following XDG Base Directory Specification.
+            return (0, path_1.join)(process.env.XDG_CONFIG_HOME || (0, path_1.join)((0, os_1.homedir)(), '.config'), appName);
+        default:
+            // Default fallback to home directory for other platforms.
+            return (0, path_1.join)((0, os_1.homedir)(), `.${appName}`);
+    }
+}
+//# sourceMappingURL=DirectoryUtils.js.map

package/dist/esm/utils/DirectoryUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DirectoryUtils.js","sourceRoot":"","sources":["../../../src/utils/DirectoryUtils.ts"],"names":[],"mappings":";;AAaA,oDAgCC;AA7CD,+BAA4B;AAC5B,2BAAuC;AAEvC;;;;;;;;;GASG;AACH,SAAgB,oBAAoB;IAClC,MAAM,sBAAsB,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAE/D,IAAI,sBAAsB,EAAE,CAAC;QAC3B,OAAO,sBAAsB,CAAC;IAChC,CAAC;IAED,MAAM,OAAO,GAAG,QAAQ,CAAC;IAEzB,QAAQ,IAAA,aAAQ,GAAE,EAAE,CAAC;QACnB,KAAK,OAAO;YACV,+CAA+C;YAC/C,OAAO,IAAA,WAAI,EACT,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,IAAA,WAAI,EAAC,IAAA,YAAO,GAAE,EAAE,SAAS,EAAE,SAAS,CAAC,EAC5D,OAAO,CACR,CAAC;QAEJ,KAAK,QAAQ;YACX,QAAQ;YACR,OAAO,IAAA,WAAI,EAAC,IAAA,YAAO,GAAE,EAAE,SAAS,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAC;QAEpE,KAAK,OAAO;YACV,sDAAsD;YACtD,OAAO,IAAA,WAAI,EACT,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,IAAA,WAAI,EAAC,IAAA,YAAO,GAAE,EAAE,SAAS,CAAC,EACzD,OAAO,CACR,CAAC;QAEJ;YACE,0DAA0D;YAC1D,OAAO,IAAA,WAAI,EAAC,IAAA,YAAO,GAAE,EAAE,IAAI,OAAO,EAAE,CAAC,CAAC;IAC1C,CAAC;AACH,CAAC"}

package/dist/esm/utils/JsonUtils.d.ts

@@ -0,0 +1,19 @@
+import { JSONSchema7 } from 'json-schema';
+export declare class JsonUtils {
+    private constructor();
+    static getJsonSchemaFromTypeName(typeName: string): JSONSchema7 | undefined;
+    static objectToJson(object: any): any;
+    static readResourceAsJson(source: string): unknown;
+    static jsonStringToJsonObject(jsonString: string): any | null;
+    /**
+     * Post-process the given schema to conform with OpenAI constraints
+     * @see https://platform.openai.com/docs/guides/structured-outputs/additionalproperties-false-must-always-be-set-in-objects
+     */
+    private static postProcessJsonSchema;
+    /**
+     * Ensures the given file path exists. If the file does not initially exist,
+     * all directories to it will be created and the file will be created with a
+     * value of an empty JSON object (AKA {}).
+     */
+    static maybeInitEmptyJsonFile(filePath: string): Promise<void>;
+}

package/dist/esm/utils/JsonUtils.js

@@ -0,0 +1,124 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonUtils = void 0;
+const MiscUtils_1 = require("./MiscUtils");
+const path_1 = __importDefault(require("path"));
+const Logger_1 = require("./Logger");
+const promises_1 = __importDefault(require("fs/promises"));
+class JsonUtils {
+    constructor() { }
+    static getJsonSchemaFromTypeName(typeName) {
+        return JSON.parse(MiscUtils_1.MiscUtils.getResourceFileAsString(path_1.default.join('generated', 'parameter-schemas.json')))[typeName];
+    }
+    static objectToJson(object) {
+        const getCircularReplacer = () => {
+            const seen = new WeakSet();
+            return (_key, value) => {
+                if (typeof value === 'object' && value !== null) {
+                    if (seen.has(value)) {
+                        return undefined;
+                    }
+                    seen.add(value);
+                }
+                return value;
+            };
+        };
+        return JSON.parse(JSON.stringify(object, getCircularReplacer()));
+    }
+    static readResourceAsJson(source) {
+        try {
+            const jsonString = MiscUtils_1.MiscUtils.getResourceFileAsString(source);
+            return JSON.parse(jsonString);
+        }
+        catch (error) {
+            Logger_1.Logger.appLogger.error('Failed to read resource as JSON:', error);
+            return null;
+        }
+    }
+    static jsonStringToJsonObject(jsonString) {
+        try {
+            return JSON.parse(jsonString);
+        }
+        catch (error) {
+            Logger_1.Logger.appLogger.error('Failed to parse JSON string to object: ', error);
+            return null;
+        }
+    }
+    /**
+     * Post-process the given schema to conform with OpenAI constraints
+     * @see https://platform.openai.com/docs/guides/structured-outputs/additionalproperties-false-must-always-be-set-in-objects
+     */
+    static postProcessJsonSchema(schema) {
+        if (schema.type === 'object') {
+            schema.additionalProperties = false;
+            if (schema.properties) {
+                const properties = schema.properties;
+                schema.required = schema.required || [];
+                Object.entries(properties).forEach(([fieldName, fieldSchema]) => {
+                    if (!schema.required?.includes(fieldName)) {
+                        schema.required?.push(fieldName);
+                        if (typeof fieldSchema.type === 'string') {
+                            fieldSchema.type = [fieldSchema.type, 'null'];
+                        }
+                        else if (Array.isArray(fieldSchema.type) &&
+                            !fieldSchema.type.includes('null')) {
+                            fieldSchema.type.push('null');
+                        }
+                    }
+                });
+            }
+        }
+        // Recursively process nested schemas
+        if (schema.properties) {
+            Object.values(schema.properties).forEach((prop) => {
+                if (typeof prop === 'object') {
+                    this.postProcessJsonSchema(prop);
+                }
+            });
+        }
+        if (schema.items) {
+            const items = Array.isArray(schema.items) ? schema.items : [schema.items];
+            items.forEach((item) => {
+                if (typeof item === 'object') {
+                    this.postProcessJsonSchema(item);
+                }
+            });
+        }
+    }
+    /**
+     * Ensures the given file path exists. If the file does not initially exist,
+     * all directories to it will be created and the file will be created with a
+     * value of an empty JSON object (AKA {}).
+     */
+    static async maybeInitEmptyJsonFile(filePath) {
+        // Ensure the directory exists
+        const directory = path_1.default.dirname(filePath);
+        await promises_1.default
+            .mkdir(directory, { recursive: true })
+            .catch((dirError) => {
+            // Directory already exists, continue...
+            if (dirError.code !== 'EEXIST') {
+                throw dirError;
+            }
+        });
+        // Try to access the file to check if it exists
+        try {
+            await promises_1.default.access(filePath);
+        }
+        catch (error) {
+            const fsError = error;
+            // File doesn't exist, create it.
+            if (fsError.code === 'ENOENT') {
+                await promises_1.default.writeFile(filePath, '{}', 'utf8');
+            }
+            else {
+                throw error;
+            }
+        }
+    }
+}
+exports.JsonUtils = JsonUtils;
+//# sourceMappingURL=JsonUtils.js.map

package/dist/esm/utils/JsonUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JsonUtils.js","sourceRoot":"","sources":["../../../src/utils/JsonUtils.ts"],"names":[],"mappings":";;;;;;AACA,2CAAwC;AACxC,gDAAwB;AACxB,qCAAkC;AAClC,2DAA6B;AAE7B,MAAa,SAAS;IACpB,gBAAuB,CAAC;IAEjB,MAAM,CAAC,yBAAyB,CACrC,QAAgB;QAEhB,OAAO,IAAI,CAAC,KAAK,CACf,qBAAS,CAAC,uBAAuB,CAC/B,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,wBAAwB,CAAC,CACjD,CACF,CAAC,QAAQ,CAAC,CAAC;IACd,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,MAAW;QACpC,MAAM,mBAAmB,GAAG,GAAG,EAAE;YAC/B,MAAM,IAAI,GAAG,IAAI,OAAO,EAAE,CAAC;YAC3B,OAAO,CAAC,IAAY,EAAE,KAAU,EAAE,EAAE;gBAClC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;oBAChD,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;wBACpB,OAAO,SAAS,CAAC;oBACnB,CAAC;oBACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBAClB,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC,CAAC;QACJ,CAAC,CAAC;QAEF,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,mBAAmB,EAAE,CAAC,CAAC,CAAC;IACnE,CAAC;IAEM,MAAM,CAAC,kBAAkB,CAAC,MAAc;QAC7C,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,qBAAS,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAChC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,eAAM,CAAC,SAAS,CAAC,KAAK,CAAC,kCAAkC,EAAE,KAAK,CAAC,CAAC;YAClE,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,sBAAsB,CAAC,UAAkB;QACrD,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAChC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,eAAM,CAAC,SAAS,CAAC,KAAK,CAAC,yCAAyC,EAAE,KAAK,CAAC,CAAC;YACzE,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,qBAAqB,CAAC,MAAmB;QACtD,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,MAAM,CAAC,oBAAoB,GAAG,KAAK,CAAC;YAEpC,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;gBACtB,MAAM,UAAU,GAAG,MAAM,CAAC,UAAyC,CAAC;gBACpE,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC;gBAExC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,WAAW,CAAC,EAAE,EAAE;oBAC9D,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;wBAC1C,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;wBAEjC,IAAI,OAAO,WAAW,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;4BACzC,WAAW,CAAC,IAAI,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;wBAChD,CAAC;6BAAM,IACL,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC;4BAC/B,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAClC,CAAC;4BACD,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;wBAChC,CAAC;oBACH,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,qCAAqC;QACrC,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YACtB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAChD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC7B,IAAI,CAAC,qBAAqB,CAAC,IAAmB,CAAC,CAAC;gBAClD,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC1E,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBACrB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC7B,IAAI,CAAC,qBAAqB,CAAC,IAAmB,CAAC,CAAC;gBAClD,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,QAAgB;QACzD,8BAA8B;QAC9B,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACzC,MAAM,kBAAE;aACL,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;aACrC,KAAK,CAAC,CAAC,QAA+B,EAAE,EAAE;YACzC,wCAAwC;YACxC,IAAI,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC/B,MAAM,QAAQ,CAAC;YACjB,CAAC;QACH,CAAC,CAAC,CAAC;QAEL,+CAA+C;QAC/C,IAAI,CAAC;YACH,MAAM,kBAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC5B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,OAAO,GAAG,KAA8B,CAAC;YAC/C,iCAAiC;YACjC,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC9B,MAAM,kBAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;YAC7C,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;CACF;AA/HD,8BA+HC"}

package/dist/esm/utils/Logger.d.ts

@@ -0,0 +1,17 @@
+import winston from 'winston';
+/**
+ * This class configures the logging system for the application. This includes both normal
+ * application logs and API access logs.
+ */
+export declare class Logger {
+    private static readonly APP_LOG_MAX_SIZE;
+    private static readonly ACCESS_LOG_MAX_SIZE;
+    private static readonly MAX_FILES;
+    static appLogger: winston.Logger;
+    static accessLogger: winston.Logger;
+    private constructor();
+    /**
+     * Formats an error object into a detailed string representation
+     */
+    private static formatError;
+}

package/dist/esm/utils/Logger.js

@@ -0,0 +1,95 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = void 0;
+const winston_1 = __importDefault(require("winston"));
+const winston_daily_rotate_file_1 = __importDefault(require("winston-daily-rotate-file"));
+const path_1 = __importDefault(require("path"));
+const MiscUtils_1 = require("../utils/MiscUtils");
+/**
+ * This class configures the logging system for the application. This includes both normal
+ * application logs and API access logs.
+ */
+class Logger {
+    static APP_LOG_MAX_SIZE = '1m';
+    static ACCESS_LOG_MAX_SIZE = '5m';
+    static MAX_FILES = 2;
+    static appLogger;
+    static accessLogger;
+    constructor() { }
+    /**
+     * Formats an error object into a detailed string representation
+     */
+    static formatError(error) {
+        return `${error.constructor.name}: ${error.message}\n${error.stack || ''}`;
+    }
+    /**
+     * Configure the logging system for the application.
+     */
+    static {
+        const basePath = MiscUtils_1.MiscUtils.baseWorkingDirectory();
+        const timestampFormat = 'YYYY-MM-DD HH:mm:ss';
+        // Custom format that handles errors properly
+        const errorAwareFormat = winston_1.default.format((info) => {
+            if (info instanceof Error) {
+                return {
+                    ...info,
+                    message: this.formatError(info),
+                    stack: info.stack,
+                    name: info.constructor.name,
+                };
+            }
+            else if (info.error instanceof Error) {
+                return {
+                    ...info,
+                    message: `${info.message}\n${this.formatError(info.error)}`,
+                    stack: info.error.stack,
+                    name: info.error.constructor.name,
+                };
+            }
+            return info;
+        });
+        // Configure application logger
+        this.appLogger = winston_1.default.createLogger({
+            level: 'info',
+            format: winston_1.default.format.combine(errorAwareFormat(), winston_1.default.format.timestamp({ format: timestampFormat }), winston_1.default.format.json()),
+            transports: [
+                // Console transport (stderr)
+                new winston_1.default.transports.Console({
+                    stderrLevels: ['info', 'warn', 'error'],
+                    format: winston_1.default.format.combine(winston_1.default.format.timestamp({ format: 'HH:mm:ss.SSS' }), winston_1.default.format.printf(({ timestamp, level, message, thread = 'main', stack }) => `${timestamp} [${thread}] ${level.toUpperCase().padEnd(5)} ${message}${stack ? '\n' + stack : ''}`)),
+                }),
+                // File transport with rotation
+                new winston_daily_rotate_file_1.default({
+                    filename: path_1.default.join(basePath, 'app.log'),
+                    maxSize: this.APP_LOG_MAX_SIZE,
+                    maxFiles: this.MAX_FILES,
+                    zippedArchive: false,
+                }),
+            ],
+        });
+        // Configure access logger
+        this.accessLogger = winston_1.default.createLogger({
+            level: 'info',
+            format: winston_1.default.format.combine(winston_1.default.format.timestamp({ format: timestampFormat }), winston_1.default.format.printf(({ timestamp, message }) => `${timestamp} access - ${message}`)),
+            transports: [
+                // Console transport (stderr)
+                new winston_1.default.transports.Console({
+                    stderrLevels: ['info', 'warn', 'error'],
+                    format: winston_1.default.format.combine(winston_1.default.format.timestamp({ format: 'HH:mm:ss.SSS' }), winston_1.default.format.printf(({ timestamp, message }) => `${timestamp} access - ${message}`)),
+                }),
+                // File transport with rotation
+                new winston_daily_rotate_file_1.default({
+                    filename: path_1.default.join(basePath, 'access.log'),
+                    maxSize: this.ACCESS_LOG_MAX_SIZE,
+                    maxFiles: this.MAX_FILES,
+                    zippedArchive: false,
+                }),
+            ],
+        });
+    }
+}
+exports.Logger = Logger;
+//# sourceMappingURL=Logger.js.map

package/dist/esm/utils/Logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logger.js","sourceRoot":"","sources":["../../../src/utils/Logger.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA8B;AAC9B,0FAAwD;AACxD,gDAAwB;AACxB,kDAA+C;AAE/C;;;GAGG;AACH,MAAa,MAAM;IACT,MAAM,CAAU,gBAAgB,GAAG,IAAI,CAAC;IACxC,MAAM,CAAU,mBAAmB,GAAG,IAAI,CAAC;IAC3C,MAAM,CAAU,SAAS,GAAG,CAAC,CAAC;IAE/B,MAAM,CAAC,SAAS,CAAiB;IACjC,MAAM,CAAC,YAAY,CAAiB;IAE3C,gBAAuB,CAAC;IAExB;;OAEG;IACK,MAAM,CAAC,WAAW,CAAC,KAAY;QACrC,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,KAAK,KAAK,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH;QACE,MAAM,QAAQ,GAAG,qBAAS,CAAC,oBAAoB,EAAE,CAAC;QAClD,MAAM,eAAe,GAAG,qBAAqB,CAAC;QAE9C,6CAA6C;QAC7C,MAAM,gBAAgB,GAAG,iBAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;YAC/C,IAAI,IAAI,YAAY,KAAK,EAAE,CAAC;gBAC1B,OAAO;oBACL,GAAG,IAAI;oBACP,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;oBAC/B,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;iBAC5B,CAAC;YACJ,CAAC;iBAAM,IAAI,IAAI,CAAC,KAAK,YAAY,KAAK,EAAE,CAAC;gBACvC,OAAO;oBACL,GAAG,IAAI;oBACP,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;oBAC3D,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;oBACvB,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI;iBAClC,CAAC;YACJ,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,+BAA+B;QAC/B,IAAI,CAAC,SAAS,GAAG,iBAAO,CAAC,YAAY,CAAC;YACpC,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,iBAAO,CAAC,MAAM,CAAC,OAAO,CAC5B,gBAAgB,EAAE,EAClB,iBAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC,EACrD,iBAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CACtB;YACD,UAAU,EAAE;gBACV,6BAA6B;gBAC7B,IAAI,iBAAO,CAAC,UAAU,CAAC,OAAO,CAAC;oBAC7B,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC;oBACvC,MAAM,EAAE,iBAAO,CAAC,MAAM,CAAC,OAAO,CAC5B,iBAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,EACpD,iBAAO,CAAC,MAAM,CAAC,MAAM,CACnB,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CACxD,GAAG,SAAS,KAAK,MAAM,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,OAAO,GAClE,KAAK,CAAC,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,EACzB,EAAE,CACL,CACF;iBACF,CAAC;gBACF,+BAA+B;gBAC/B,IAAI,mCAAe,CAAC;oBAClB,QAAQ,EAAE,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;oBACxC,OAAO,EAAE,IAAI,CAAC,gBAAgB;oBAC9B,QAAQ,EAAE,IAAI,CAAC,SAAS;oBACxB,aAAa,EAAE,KAAK;iBACrB,CAAC;aACH;SACF,CAAC,CAAC;QAEH,0BAA0B;QAC1B,IAAI,CAAC,YAAY,GAAG,iBAAO,CAAC,YAAY,CAAC;YACvC,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,iBAAO,CAAC,MAAM,CAAC,OAAO,CAC5B,iBAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC,EACrD,iBAAO,CAAC,MAAM,CAAC,MAAM,CACnB,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,GAAG,SAAS,aAAa,OAAO,EAAE,CAC/D,CACF;YACD,UAAU,EAAE;gBACV,6BAA6B;gBAC7B,IAAI,iBAAO,CAAC,UAAU,CAAC,OAAO,CAAC;oBAC7B,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC;oBACvC,MAAM,EAAE,iBAAO,CAAC,MAAM,CAAC,OAAO,CAC5B,iBAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,EACpD,iBAAO,CAAC,MAAM,CAAC,MAAM,CACnB,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,GAAG,SAAS,aAAa,OAAO,EAAE,CAC/D,CACF;iBACF,CAAC;gBACF,+BAA+B;gBAC/B,IAAI,mCAAe,CAAC;oBAClB,QAAQ,EAAE,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC;oBAC3C,OAAO,EAAE,IAAI,CAAC,mBAAmB;oBACjC,QAAQ,EAAE,IAAI,CAAC,SAAS;oBACxB,aAAa,EAAE,KAAK;iBACrB,CAAC;aACH;SACF,CAAC,CAAC;IACL,CAAC;;AAzGH,wBA0GC"}

package/dist/esm/utils/MiscUtils.d.ts

@@ -0,0 +1,62 @@
+export declare class MiscUtils {
+    private constructor();
+    static readonly DONOBU_VERSION: string;
+    /**
+     * This is the base working directory for the entire application. Care is made
+     * to ensure we do not access data outside of this directory to maintain
+     * proper permissions across platforms.
+     *
+     * Returns platform-specific application data directories:
+     * - macOS: ~/Library/Application Support/Donobu
+     * - Windows: %APPDATA%/Donobu
+     * - Linux: ~/.config/Donobu
+     *
+     * If the BASE_WORKING_DIR environment variable is set, its value is returned.
+     */
+    static baseWorkingDirectory(): string;
+    /**
+     * Updates token counts in flow metadata based on GPT response
+     */
+    static updateTokenCounts(gptResponse: {
+        promptTokensUsed: number;
+        completionTokensUsed: number;
+    }, flowMetadata: {
+        inputTokensUsed: number;
+        completionTokensUsed: number;
+    }): void;
+    /**
+     * Loads a resource file from the assets directory as a string
+     */
+    static getResourceFileAsString(fileName: string): string;
+    /**
+     * Loads a resource file from the assets directory as a Buffer
+     */
+    static getResourceFileAsBytes(fileName: string): Buffer;
+    /**
+     * Reduces the resolution of a PNG image by half.
+     *
+     * @param inputImageBytes - The input PNG image as a Buffer.
+     * @returns A Promise that resolves to the resized PNG image as a Buffer.
+     * @throws Error if image processing fails
+     */
+    static resizePngByHalf(inputImageBytes: Buffer): Promise<Buffer>;
+    /**
+     * Returns a duration (in milliseconds) that represents a statistically
+     * plausible human mouse-click press duration.
+     */
+    static generateHumanLikeClickDurationInMs(): number;
+    /**
+     * Returns a duration (in milliseconds) that represents a statistically
+     * plausible human key press duration.
+     */
+    static generateHumanLikeKeyPressDurationInMs(key: string): number;
+    /**
+     * Creates a new random tool call ID. This is useful for registering ProposedToolCall and
+     * ToolCalls that were proposed and/or invoked by a user rather than by a GPT, or by GPT
+     * APIs that do not natively use tool call IDs (i.e. Google Gemini). Note OpenAI constrains the
+     * length of tool call IDs to no longer than 40 characters.
+     *
+     * @returns A string representing a unique tool call ID.
+     */
+    static createAdHocToolCallId(): string;
+}