donobu 1.0.0

package/dist/esm/managers/AdminApiController.js

@@ -0,0 +1,251 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdminApiController = void 0;
+const express_1 = __importDefault(require("express"));
+const Logger_1 = require("../utils/Logger");
+const RequestContextHolder_1 = require("./RequestContextHolder");
+const RequestContext_1 = require("../models/RequestContext");
+const DonobuException_1 = require("../exceptions/DonobuException");
+const FlowsPersistenceFactoryImpl_1 = require("../persistence/FlowsPersistenceFactoryImpl");
+const DonobuFlowsManager_1 = require("./DonobuFlowsManager");
+const ToolManager_1 = require("./ToolManager");
+const ToolsApi_1 = require("../apis/ToolsApi");
+const FlowsApi_1 = require("../apis/FlowsApi");
+const FlowsFilesApi_1 = require("../apis/FlowsFilesApi");
+const FlowsToolCallsApi_1 = require("../apis/FlowsToolCallsApi");
+const VersionApi_1 = require("../apis/VersionApi");
+const PingApi_1 = require("../apis/PingApi");
+const DefaultApiAuthApi_1 = require("../apis/DefaultApiAuthApi");
+const SpecialFlowsApi_1 = require("../apis/SpecialFlowsApi");
+const DonobuDeploymentEnvironment_1 = require("../models/DonobuDeploymentEnvironment");
+const GptConfigsApi_1 = require("../apis/GptConfigsApi");
+const GptConfigsManager_1 = require("./GptConfigsManager");
+const AgentsApi_1 = require("../apis/AgentsApi");
+const AgentsManager_1 = require("./AgentsManager");
+const GptConfigsPersistenceSqlite_1 = require("../persistence/GptConfigsPersistenceSqlite");
+const DonobuSqliteDb_1 = require("../persistence/DonobuSqliteDb");
+const AgentsPersistenceSqlite_1 = require("../persistence/AgentsPersistenceSqlite");
+const AskAiApi_1 = require("../apis/AskAiApi");
+/**
+ * This class sets up the API for managing DonobuFlow flows.
+ */
+class AdminApiController {
+    app;
+    server;
+    /**
+     * Creates a new instance.
+     * @param donobuDeploymentEnvironment The environment in which this application is running in.
+     * This has material consequences! If this is set to a value of LOCAL then...
+     * - additional API endpoints are registered, of which allow operations that would
+     *   otherwise be considered unsafe.
+     * - operations around active flows are considered fair game.
+     * - no checking for flow ownership is performed, as all flows are considered owned by the
+     *   local environment.
+     */
+    static async create(donobuDeploymentEnvironment) {
+        const expressApp = await this.setupExpressFramework(donobuDeploymentEnvironment);
+        return new AdminApiController(expressApp);
+    }
+    constructor(app) {
+        this.app = app;
+    }
+    /**
+     * Serves the API and web assets; this blocks until stop() is called.
+     * If the given port is 0, a random port is assigned.
+     */
+    start(port) {
+        Logger_1.Logger.appLogger.debug(`Starting AdminController on port ${port}`);
+        this.server = this.app.listen(port);
+    }
+    /**
+     * Stops the server.
+     */
+    stop() {
+        if (this.server) {
+            const address = this.server.address();
+            const port = typeof address === 'string' ? address : address?.port;
+            Logger_1.Logger.appLogger.debug(`Stopping AdminController on port ${port}`);
+            this.server.close();
+        }
+    }
+    static async setupExpressFramework(donobuDeploymentEnvironment) {
+        const app = (0, express_1.default)();
+        const requestContextHolder = new RequestContextHolder_1.RequestContextHolder();
+        // JSON body parser with 1MB limit.
+        app.use(express_1.default.json({
+            limit: '1mb',
+            type: '*/*',
+            strict: true,
+            verify: (_req, res, buf, _encoding) => {
+                try {
+                    JSON.parse(buf.toString());
+                }
+                catch (_e) {
+                    res.statusCode = 400;
+                    res.setHeader('Content-Type', 'application/json');
+                    res.end(JSON.stringify({
+                        error: 'Bad Request',
+                        message: 'Invalid JSON format in request body',
+                    }));
+                    throw new Error('Invalid JSON');
+                }
+            },
+        }));
+        // Request context middleware.
+        app.use((req, _, next) => {
+            const defaultApiAuth = requestContextHolder.get();
+            const authHeader = req.headers.authorization;
+            let accessToken = null;
+            if (authHeader?.startsWith('Bearer ')) {
+                accessToken = authHeader.substring(7);
+            }
+            else {
+                accessToken = defaultApiAuth.accessToken;
+            }
+            requestContextHolder.setForCurrentContext(new RequestContext_1.RequestContext(accessToken));
+            next();
+        });
+        // Clear request context after request.
+        app.use((_, res, next) => {
+            res.on('finish', () => {
+                requestContextHolder.clearForCurrentContext();
+            });
+            next();
+        });
+        // Disable caching for all API routes.
+        app.use((_req, res, next) => {
+            res.setHeader('Cache-Control', 'no-store, no-cache, must-revalidate, private');
+            res.setHeader('Pragma', 'no-cache');
+            res.setHeader('Expires', '0');
+            next();
+        });
+        // Access logging middleware.
+        app.use((req, res, next) => {
+            const start = process.hrtime();
+            res.on('finish', () => {
+                const diff = process.hrtime(start);
+                const time = (diff[0] * 1e3 + diff[1] * 1e-6).toFixed(0);
+                const logLevel = req.path === '/api/ping' ? 'debug' : 'info';
+                Logger_1.Logger.accessLogger[logLevel](`${req.method} | ${req.path} | ${res.statusCode} | ${time}ms`);
+            });
+            next();
+        });
+        // Set up the API endpoints.
+        await this.prepareEndpoints(donobuDeploymentEnvironment, app, requestContextHolder);
+        // Error handling middleware. This must happen after the endpoints have
+        // been set up, as the order in which Express's initialization methods
+        // are called matters.
+        app.use((err, req, res, _next) => {
+            // Check if response has already been sent. This can happen if some other
+            // middleware errored out and closed the request on its own.
+            if (res.headersSent) {
+                return;
+            }
+            try {
+                if (err instanceof DonobuException_1.DonobuException) {
+                    if (err.httpCode >= 500) {
+                        Logger_1.Logger.appLogger.error(`Unexpected exception when handling ${req.method} request at ${req.url}`, err);
+                    }
+                    res.status(err.httpCode).json({
+                        code: err.donobuErrorCode,
+                        message: err.userFacingMessage,
+                    });
+                }
+                else {
+                    Logger_1.Logger.appLogger.error(`Unexpected exception when handling ${req.method} request at ${req.url}`, err);
+                    // Only send error details in development
+                    const message = process.env.NODE_ENV === 'development'
+                        ? err.message
+                        : 'Internal Server Error';
+                    res.status(500).json({
+                        error: 'Internal Server Error',
+                        message,
+                    });
+                }
+            }
+            catch (error) {
+                Logger_1.Logger.appLogger.error('Error in error handling middleware: ', error);
+                res.status(500).send('Internal Server Error');
+            }
+        });
+        return app;
+    }
+    static async prepareEndpoints(donobuDeploymentEnvironment, app, requestContextHolder) {
+        const sqliteDb = (0, DonobuSqliteDb_1.getDonobuSqliteDatabase)();
+        const gptConfigsPersistence = await GptConfigsPersistenceSqlite_1.GptConfigsPersistenceSqlite.create(sqliteDb);
+        const gptConfigsManager = await GptConfigsManager_1.GptConfigsManager.create(gptConfigsPersistence);
+        const agentsPersistence = await AgentsPersistenceSqlite_1.AgentsPersistenceSqlite.create(sqliteDb);
+        const agentsManager = await AgentsManager_1.AgentsManager.create(agentsPersistence, gptConfigsManager);
+        const flowsPersistenceFactory = await FlowsPersistenceFactoryImpl_1.FlowsPersistenceFactoryImpl.fromEnvironment(donobuDeploymentEnvironment, requestContextHolder);
+        const flowsManager = new DonobuFlowsManager_1.DonobuFlowsManager(donobuDeploymentEnvironment, gptConfigsManager, agentsManager, flowsPersistenceFactory, ToolManager_1.ToolManager.ALL_TOOLS);
+        const gptConfigsApi = new GptConfigsApi_1.GptConfigsApi(gptConfigsManager, agentsManager);
+        const agentsApi = new AgentsApi_1.AgentsApi(agentsManager);
+        const askAiApi = new AskAiApi_1.AskAiApi(gptConfigsManager, agentsManager);
+        const toolsApi = new ToolsApi_1.ToolsApi(ToolManager_1.ToolManager.DEFAULT_TOOLS);
+        const flowsApi = new FlowsApi_1.FlowsApi(flowsManager);
+        const flowsFilesApi = new FlowsFilesApi_1.FlowsFilesApi(flowsPersistenceFactory);
+        const flowsToolCallsApi = new FlowsToolCallsApi_1.FlowsToolCallsApi(flowsManager);
+        const versionApi = new VersionApi_1.VersionApi();
+        const pingApi = new PingApi_1.PingApi();
+        const specialFlowsApi = new SpecialFlowsApi_1.SpecialFlowsApi(flowsManager);
+        // Set up routes based on deployment environment
+        switch (donobuDeploymentEnvironment) {
+            case DonobuDeploymentEnvironment_1.DonobuDeploymentEnvironment.LOCAL: {
+                const defaultApiAuthApi = new DefaultApiAuthApi_1.DefaultApiAuthApi(requestContextHolder);
+                app.post('/api/default-auth', this.asyncHandler(defaultApiAuthApi.setDefaultApiAuth.bind(defaultApiAuthApi)));
+                app.post('/api/flows/:flowId/cancel', this.asyncHandler(flowsApi.cancelFlow.bind(flowsApi)));
+                app.post('/api/flows/:flowId/pause', this.asyncHandler(flowsApi.pauseFlow.bind(flowsApi)));
+                app.post('/api/flows/:flowId/resume', this.asyncHandler(flowsApi.resumeFlow.bind(flowsApi)));
+                app.post('/api/flows/:flowId/tool-calls', this.asyncHandler(flowsToolCallsApi.postToolCalls.bind(flowsToolCallsApi)));
+                break;
+            }
+            case DonobuDeploymentEnvironment_1.DonobuDeploymentEnvironment.DONOBU_HOSTED_SINGLE_TENANT:
+            case DonobuDeploymentEnvironment_1.DonobuDeploymentEnvironment.DONOBU_HOSTED_MULTI_TENANT:
+                // No additional endpoints for these environments
+                break;
+        }
+        // Common endpoints for all environments
+        app.get('/api/gpt-configs', this.asyncHandler(gptConfigsApi.getAll.bind(gptConfigsApi)));
+        app.get('/api/gpt-configs/:name', this.asyncHandler(gptConfigsApi.get.bind(gptConfigsApi)));
+        app.post('/api/gpt-configs/:name', this.asyncHandler(gptConfigsApi.set.bind(gptConfigsApi)));
+        app.delete('/api/gpt-configs/:name', this.asyncHandler(gptConfigsApi.delete.bind(gptConfigsApi)));
+        app.get('/api/agents', this.asyncHandler(agentsApi.getAll.bind(agentsApi)));
+        app.get('/api/agents/:name', this.asyncHandler(agentsApi.get.bind(agentsApi)));
+        app.post('/api/agents/:name', this.asyncHandler(agentsApi.set.bind(agentsApi)));
+        app.post('/api/ask-ai', this.asyncHandler(askAiApi.ask.bind(askAiApi)));
+        app.get('/api/tools', this.asyncHandler(toolsApi.getSupportedTools.bind(toolsApi)));
+        app.get('/api/flows', this.asyncHandler(flowsApi.getFlows.bind(flowsApi)));
+        app.post('/api/flows', this.asyncHandler(flowsApi.createFlow.bind(flowsApi)));
+        app.get('/api/flows/:flowId', this.asyncHandler(flowsApi.getFlowMetadata.bind(flowsApi)));
+        app.get('/api/flows/:flowId/rerun', this.asyncHandler(flowsApi.getFlowAsRerun.bind(flowsApi)));
+        app.get('/api/flows/:flowId/code', this.asyncHandler(flowsApi.getFlowAsCode.bind(flowsApi)));
+        app.delete('/api/flows/:flowId', this.asyncHandler(flowsApi.deleteFlow.bind(flowsApi)));
+        app.get('/api/flows/:flowId/images/:imageId', this.asyncHandler(flowsFilesApi.getFlowImage.bind(flowsFilesApi)));
+        app.get('/api/flows/:flowId/video', this.asyncHandler(flowsFilesApi.getFlowVideo.bind(flowsFilesApi)));
+        app.get('/api/flows/:flowId/tool-calls', this.asyncHandler(flowsToolCallsApi.getToolCalls.bind(flowsToolCallsApi)));
+        app.get('/api/flows/:flowId/tool-calls/:toolCallId', this.asyncHandler(flowsToolCallsApi.getToolCall.bind(flowsToolCallsApi)));
+        app.get('/api/version', this.asyncHandler(versionApi.version.bind(versionApi)));
+        app.get('/api/ping', this.asyncHandler(pingApi.ping.bind(pingApi)));
+        /////////////////////////////
+        // BEGIN special endpoints //
+        /////////////////////////////
+        app.post('/api/analyze-cookie-consent', this.asyncHandler(specialFlowsApi.analyzeCookieConsent.bind(specialFlowsApi)));
+        app.post('/api/detect-broken-links', this.asyncHandler(specialFlowsApi.detectBrokenLinks.bind(specialFlowsApi)));
+        app.post('/api/extract-public-facebook-entity-data', this.asyncHandler(specialFlowsApi.extractPublicFacebookEntityData.bind(specialFlowsApi)));
+        app.post('/api/extract-google-streetview-entity-data', this.asyncHandler(specialFlowsApi.extractGoogleStreetviewEntityData.bind(specialFlowsApi)));
+        app.post('/api/extract-payment-provider-data', this.asyncHandler(specialFlowsApi.extractPaymentProviderData.bind(specialFlowsApi)));
+        ///////////////////////////
+        // END special endpoints //
+        ///////////////////////////
+    }
+    static asyncHandler(fn) {
+        return (req, res, next) => {
+            Promise.resolve(fn(req, res, next)).catch(next);
+        };
+    }
+}
+exports.AdminApiController = AdminApiController;
+//# sourceMappingURL=AdminApiController.js.map

package/dist/esm/managers/AdminApiController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AdminApiController.js","sourceRoot":"","sources":["../../../src/managers/AdminApiController.ts"],"names":[],"mappings":";;;;;;AACA,sDAA4E;AAC5E,4CAAyC;AACzC,iEAA8D;AAC9D,6DAA0D;AAC1D,mEAAgE;AAEhE,4FAAyF;AACzF,6DAA0D;AAC1D,+CAA4C;AAC5C,+CAA4C;AAC5C,+CAA4C;AAC5C,yDAAsD;AACtD,iEAA8D;AAC9D,mDAAgD;AAChD,6CAA0C;AAC1C,iEAA8D;AAC9D,6DAA0D;AAC1D,uFAAoF;AACpF,yDAAsD;AACtD,2DAAwD;AACxD,iDAA8C;AAC9C,mDAAgD;AAChD,4FAAyF;AACzF,kEAAwE;AACxE,oFAAiF;AACjF,+CAA4C;AAE5C;;GAEG;AACH,MAAa,kBAAkB;IAsBQ;IArB7B,MAAM,CAAe;IAE7B;;;;;;;;;OASG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACxB,2BAAwD;QAExD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,qBAAqB,CACjD,2BAA2B,CAC5B,CAAC;QACF,OAAO,IAAI,kBAAkB,CAAC,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,YAAqC,GAAY;QAAZ,QAAG,GAAH,GAAG,CAAS;IAAG,CAAC;IAErD;;;OAGG;IACI,KAAK,CAAC,IAAY;QACvB,eAAM,CAAC,SAAS,CAAC,KAAK,CAAC,oCAAoC,IAAI,EAAE,CAAC,CAAC;QACnE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,IAAI;QACT,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACtC,MAAM,IAAI,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC;YACnE,eAAM,CAAC,SAAS,CAAC,KAAK,CAAC,oCAAoC,IAAI,EAAE,CAAC,CAAC;YACnE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACtB,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,qBAAqB,CACxC,2BAAwD;QAExD,MAAM,GAAG,GAAG,IAAA,iBAAO,GAAE,CAAC;QACtB,MAAM,oBAAoB,GAAG,IAAI,2CAAoB,EAAE,CAAC;QACxD,mCAAmC;QACnC,GAAG,CAAC,GAAG,CACL,iBAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,KAAK;YACZ,IAAI,EAAE,KAAK;YACX,MAAM,EAAE,IAAI;YACZ,MAAM,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE;gBACpC,IAAI,CAAC;oBACH,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAC7B,CAAC;gBAAC,OAAO,EAAE,EAAE,CAAC;oBACZ,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;oBACrB,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;oBAClD,GAAG,CAAC,GAAG,CACL,IAAI,CAAC,SAAS,CAAC;wBACb,KAAK,EAAE,aAAa;wBACpB,OAAO,EAAE,qCAAqC;qBAC/C,CAAC,CACH,CAAC;oBACF,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;gBAClC,CAAC;YACH,CAAC;SACF,CAAC,CACH,CAAC;QACF,8BAA8B;QAC9B,GAAG,CAAC,GAAG,CAAC,CAAC,GAAY,EAAE,CAAW,EAAE,IAAkB,EAAE,EAAE;YACxD,MAAM,cAAc,GAAG,oBAAoB,CAAC,GAAG,EAAE,CAAC;YAClD,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC;YAC7C,IAAI,WAAW,GAAkB,IAAI,CAAC;YAEtC,IAAI,UAAU,EAAE,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;gBACtC,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACxC,CAAC;iBAAM,CAAC;gBACN,WAAW,GAAG,cAAc,CAAC,WAAW,CAAC;YAC3C,CAAC;YAED,oBAAoB,CAAC,oBAAoB,CACvC,IAAI,+BAAc,CAAC,WAAW,CAAC,CAChC,CAAC;YACF,IAAI,EAAE,CAAC;QACT,CAAC,CAAC,CAAC;QACH,uCAAuC;QACvC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAU,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;YACxD,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;gBACpB,oBAAoB,CAAC,sBAAsB,EAAE,CAAC;YAChD,CAAC,CAAC,CAAC;YACH,IAAI,EAAE,CAAC;QACT,CAAC,CAAC,CAAC;QACH,sCAAsC;QACtC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAa,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;YAC3D,GAAG,CAAC,SAAS,CACX,eAAe,EACf,8CAA8C,CAC/C,CAAC;YACF,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YACpC,GAAG,CAAC,SAAS,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;YAC9B,IAAI,EAAE,CAAC;QACT,CAAC,CAAC,CAAC;QACH,6BAA6B;QAC7B,GAAG,CAAC,GAAG,CAAC,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;YAC1D,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;YAE/B,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;gBACpB,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACnC,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;gBACzD,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;gBAE7D,eAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,CAC3B,GAAG,GAAG,CAAC,MAAM,MAAM,GAAG,CAAC,IAAI,MAAM,GAAG,CAAC,UAAU,MAAM,IAAI,IAAI,CAC9D,CAAC;YACJ,CAAC,CAAC,CAAC;YAEH,IAAI,EAAE,CAAC;QACT,CAAC,CAAC,CAAC;QACH,4BAA4B;QAC5B,MAAM,IAAI,CAAC,gBAAgB,CACzB,2BAA2B,EAC3B,GAAG,EACH,oBAAoB,CACrB,CAAC;QACF,uEAAuE;QACvE,sEAAsE;QACtE,sBAAsB;QACtB,GAAG,CAAC,GAAG,CAAC,CAAC,GAAU,EAAE,GAAY,EAAE,GAAa,EAAE,KAAmB,EAAE,EAAE;YACvE,yEAAyE;YACzE,4DAA4D;YAC5D,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;gBACpB,OAAO;YACT,CAAC;YAED,IAAI,CAAC;gBACH,IAAI,GAAG,YAAY,iCAAe,EAAE,CAAC;oBACnC,IAAK,GAAuB,CAAC,QAAQ,IAAI,GAAG,EAAE,CAAC;wBAC7C,eAAM,CAAC,SAAS,CAAC,KAAK,CACpB,sCAAsC,GAAG,CAAC,MAAM,eAAe,GAAG,CAAC,GAAG,EAAE,EACxE,GAAG,CACJ,CAAC;oBACJ,CAAC;oBAED,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;wBAC5B,IAAI,EAAE,GAAG,CAAC,eAAe;wBACzB,OAAO,EAAE,GAAG,CAAC,iBAAiB;qBACD,CAAC,CAAC;gBACnC,CAAC;qBAAM,CAAC;oBACN,eAAM,CAAC,SAAS,CAAC,KAAK,CACpB,sCAAsC,GAAG,CAAC,MAAM,eAAe,GAAG,CAAC,GAAG,EAAE,EACxE,GAAG,CACJ,CAAC;oBACF,yCAAyC;oBACzC,MAAM,OAAO,GACX,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa;wBACpC,CAAC,CAAC,GAAG,CAAC,OAAO;wBACb,CAAC,CAAC,uBAAuB,CAAC;oBAC9B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;wBACnB,KAAK,EAAE,uBAAuB;wBAC9B,OAAO;qBACR,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,eAAM,CAAC,SAAS,CAAC,KAAK,CAAC,sCAAsC,EAAE,KAAK,CAAC,CAAC;gBACtE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YAChD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,CAAC;IACb,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,gBAAgB,CACnC,2BAAwD,EACxD,GAAY,EACZ,oBAA0C;QAE1C,MAAM,QAAQ,GAAG,IAAA,wCAAuB,GAAE,CAAC;QAC3C,MAAM,qBAAqB,GACzB,MAAM,yDAA2B,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACrD,MAAM,iBAAiB,GAAG,MAAM,qCAAiB,CAAC,MAAM,CACtD,qBAAqB,CACtB,CAAC;QACF,MAAM,iBAAiB,GAAG,MAAM,iDAAuB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACzE,MAAM,aAAa,GAAG,MAAM,6BAAa,CAAC,MAAM,CAC9C,iBAAiB,EACjB,iBAAiB,CAClB,CAAC;QACF,MAAM,uBAAuB,GAC3B,MAAM,yDAA2B,CAAC,eAAe,CAC/C,2BAA2B,EAC3B,oBAAoB,CACrB,CAAC;QACJ,MAAM,YAAY,GAAG,IAAI,uCAAkB,CACzC,2BAA2B,EAC3B,iBAAiB,EACjB,aAAa,EACb,uBAAuB,EACvB,yBAAW,CAAC,SAAS,CACtB,CAAC;QAEF,MAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAC1E,MAAM,SAAS,GAAG,IAAI,qBAAS,CAAC,aAAa,CAAC,CAAC;QAC/C,MAAM,QAAQ,GAAG,IAAI,mBAAQ,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAChE,MAAM,QAAQ,GAAG,IAAI,mBAAQ,CAAC,yBAAW,CAAC,aAAa,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,IAAI,mBAAQ,CAAC,YAAY,CAAC,CAAC;QAC5C,MAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,uBAAuB,CAAC,CAAC;QACjE,MAAM,iBAAiB,GAAG,IAAI,qCAAiB,CAAC,YAAY,CAAC,CAAC;QAC9D,MAAM,UAAU,GAAG,IAAI,uBAAU,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,IAAI,iBAAO,EAAE,CAAC;QAC9B,MAAM,eAAe,GAAG,IAAI,iCAAe,CAAC,YAAY,CAAC,CAAC;QAE1D,gDAAgD;QAChD,QAAQ,2BAA2B,EAAE,CAAC;YACpC,KAAK,yDAA2B,CAAC,KAAK,CAAC,CAAC,CAAC;gBACvC,MAAM,iBAAiB,GAAG,IAAI,qCAAiB,CAAC,oBAAoB,CAAC,CAAC;gBACtE,GAAG,CAAC,IAAI,CACN,mBAAmB,EACnB,IAAI,CAAC,YAAY,CACf,iBAAiB,CAAC,iBAAiB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAC5D,CACF,CAAC;gBACF,GAAG,CAAC,IAAI,CACN,2BAA2B,EAC3B,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CACtD,CAAC;gBACF,GAAG,CAAC,IAAI,CACN,0BAA0B,EAC1B,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CACrD,CAAC;gBACF,GAAG,CAAC,IAAI,CACN,2BAA2B,EAC3B,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CACtD,CAAC;gBACF,GAAG,CAAC,IAAI,CACN,+BAA+B,EAC/B,IAAI,CAAC,YAAY,CACf,iBAAiB,CAAC,aAAa,CAAC,IAAI,CAAC,iBAAiB,CAAC,CACxD,CACF,CAAC;gBACF,MAAM;YACR,CAAC;YACD,KAAK,yDAA2B,CAAC,2BAA2B,CAAC;YAC7D,KAAK,yDAA2B,CAAC,0BAA0B;gBACzD,iDAAiD;gBACjD,MAAM;QACV,CAAC;QAED,wCAAwC;QACxC,GAAG,CAAC,GAAG,CACL,kBAAkB,EAClB,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAC5D,CAAC;QACF,GAAG,CAAC,GAAG,CACL,wBAAwB,EACxB,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CACzD,CAAC;QACF,GAAG,CAAC,IAAI,CACN,wBAAwB,EACxB,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CACzD,CAAC;QACF,GAAG,CAAC,MAAM,CACR,wBAAwB,EACxB,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAC5D,CAAC;QACF,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC5E,GAAG,CAAC,GAAG,CACL,mBAAmB,EACnB,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CACjD,CAAC;QACF,GAAG,CAAC,IAAI,CACN,mBAAmB,EACnB,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CACjD,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QACxE,GAAG,CAAC,GAAG,CACL,YAAY,EACZ,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAC7D,CAAC;QACF,GAAG,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC3E,GAAG,CAAC,IAAI,CACN,YAAY,EACZ,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CACtD,CAAC;QACF,GAAG,CAAC,GAAG,CACL,oBAAoB,EACpB,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAC3D,CAAC;QACF,GAAG,CAAC,GAAG,CACL,0BAA0B,EAC1B,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAC1D,CAAC;QACF,GAAG,CAAC,GAAG,CACL,yBAAyB,EACzB,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CACzD,CAAC;QACF,GAAG,CAAC,MAAM,CACR,oBAAoB,EACpB,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CACtD,CAAC;QACF,GAAG,CAAC,GAAG,CACL,oCAAoC,EACpC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAClE,CAAC;QACF,GAAG,CAAC,GAAG,CACL,0BAA0B,EAC1B,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAClE,CAAC;QACF,GAAG,CAAC,GAAG,CACL,+BAA+B,EAC/B,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAC1E,CAAC;QACF,GAAG,CAAC,GAAG,CACL,2CAA2C,EAC3C,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CACzE,CAAC;QACF,GAAG,CAAC,GAAG,CACL,cAAc,EACd,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CACvD,CAAC;QACF,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACpE,6BAA6B;QAC7B,6BAA6B;QAC7B,6BAA6B;QAC7B,GAAG,CAAC,IAAI,CACN,6BAA6B,EAC7B,IAAI,CAAC,YAAY,CACf,eAAe,CAAC,oBAAoB,CAAC,IAAI,CAAC,eAAe,CAAC,CAC3D,CACF,CAAC;QACF,GAAG,CAAC,IAAI,CACN,0BAA0B,EAC1B,IAAI,CAAC,YAAY,CACf,eAAe,CAAC,iBAAiB,CAAC,IAAI,CAAC,eAAe,CAAC,CACxD,CACF,CAAC;QACF,GAAG,CAAC,IAAI,CACN,0CAA0C,EAC1C,IAAI,CAAC,YAAY,CACf,eAAe,CAAC,+BAA+B,CAAC,IAAI,CAAC,eAAe,CAAC,CACtE,CACF,CAAC;QACF,GAAG,CAAC,IAAI,CACN,4CAA4C,EAC5C,IAAI,CAAC,YAAY,CACf,eAAe,CAAC,iCAAiC,CAAC,IAAI,CAAC,eAAe,CAAC,CACxE,CACF,CAAC;QACF,GAAG,CAAC,IAAI,CACN,oCAAoC,EACpC,IAAI,CAAC,YAAY,CACf,eAAe,CAAC,0BAA0B,CAAC,IAAI,CAAC,eAAe,CAAC,CACjE,CACF,CAAC;QACF,2BAA2B;QAC3B,2BAA2B;QAC3B,2BAA2B;IAC7B,CAAC;IAEO,MAAM,CAAC,YAAY,CACzB,EAAqE;QAErE,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;YACzD,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,CAAC,CAAC;IACJ,CAAC;CACF;AAlXD,gDAkXC"}

package/dist/esm/managers/AgentsManager.d.ts

@@ -0,0 +1,28 @@
+import { DonobuAgent } from '../models/DonobuAgentType';
+import { AgentsPersistence } from '../persistence/AgentsPersistence';
+import { GptConfigsManager } from './GptConfigsManager';
+/**
+ * This class is responsible for mapping Donobu agents to GPT configurations.
+ */
+export declare class AgentsManager {
+    private readonly agentsPersistence;
+    private readonly gptConfigsManager;
+    private constructor();
+    static create(agentsPersistence: AgentsPersistence, gptConfigsManager: GptConfigsManager): Promise<AgentsManager>;
+    /**
+     * Set the given Donobu agent's with the given GPT configuration by name. If
+     * the given GPT configuration name is non-null, and there is no corresponding
+     * GPT configuration with that name, an exception is thrown.
+     */
+    set(agent: DonobuAgent, gptConfigName: string | null): Promise<void>;
+    /**
+     * Return the GPT configuration name associated with the given Donobu agent.
+     */
+    get(agent: DonobuAgent): Promise<string | null>;
+    getAll(): Promise<Map<DonobuAgent, string | null>>;
+    /**
+     * Automatically sets the 'flow-runner' agent config to the value at the
+     * DEFAULT_FLOW_RUNNER_GPT_CONFIG_NAME environment variable if it exists.
+     */
+    private initializeDefaultConfigurations;
+}

package/dist/esm/managers/AgentsManager.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentsManager = void 0;
+const GptConfigNotFoundException_1 = require("../exceptions/GptConfigNotFoundException");
+/**
+ * This class is responsible for mapping Donobu agents to GPT configurations.
+ */
+class AgentsManager {
+    agentsPersistence;
+    gptConfigsManager;
+    constructor(agentsPersistence, gptConfigsManager) {
+        this.agentsPersistence = agentsPersistence;
+        this.gptConfigsManager = gptConfigsManager;
+    }
+    static async create(agentsPersistence, gptConfigsManager) {
+        const instance = new AgentsManager(agentsPersistence, gptConfigsManager);
+        await instance.initializeDefaultConfigurations();
+        return instance;
+    }
+    /**
+     * Set the given Donobu agent's with the given GPT configuration by name. If
+     * the given GPT configuration name is non-null, and there is no corresponding
+     * GPT configuration with that name, an exception is thrown.
+     */
+    async set(agent, gptConfigName) {
+        if (gptConfigName) {
+            // Verify that the given config exists at all. This will throw if it does
+            // not.
+            await this.gptConfigsManager.get(gptConfigName);
+        }
+        await this.agentsPersistence.set(agent, gptConfigName);
+    }
+    /**
+     * Return the GPT configuration name associated with the given Donobu agent.
+     */
+    async get(agent) {
+        const configName = await this.agentsPersistence.get(agent);
+        if (configName) {
+            try {
+                // Verify that a config exists by that name at all. This will throw if
+                // it does not.
+                await this.gptConfigsManager.get(configName);
+                return configName;
+            }
+            catch (error) {
+                if (error instanceof GptConfigNotFoundException_1.GptConfigNotFoundException) {
+                    // Data consistency issue. Attempt to heal.
+                    await this.set(agent, null);
+                    return null;
+                }
+                else {
+                    throw error;
+                }
+            }
+        }
+        else {
+            return null;
+        }
+    }
+    async getAll() {
+        return this.agentsPersistence.getAll();
+    }
+    /**
+     * Automatically sets the 'flow-runner' agent config to the value at the
+     * DEFAULT_FLOW_RUNNER_GPT_CONFIG_NAME environment variable if it exists.
+     */
+    async initializeDefaultConfigurations() {
+        const defaultFlowRunnerGptConfigName = process.env.DEFAULT_FLOW_RUNNER_GPT_CONFIG_NAME;
+        if (defaultFlowRunnerGptConfigName) {
+            await this.set('flow-runner', defaultFlowRunnerGptConfigName);
+        }
+    }
+}
+exports.AgentsManager = AgentsManager;
+//# sourceMappingURL=AgentsManager.js.map

package/dist/esm/managers/AgentsManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AgentsManager.js","sourceRoot":"","sources":["../../../src/managers/AgentsManager.ts"],"names":[],"mappings":";;;AAAA,yFAAsF;AAKtF;;GAEG;AACH,MAAa,aAAa;IAEL;IACA;IAFnB,YACmB,iBAAoC,EACpC,iBAAoC;QADpC,sBAAiB,GAAjB,iBAAiB,CAAmB;QACpC,sBAAiB,GAAjB,iBAAiB,CAAmB;IACpD,CAAC;IAEG,MAAM,CAAC,KAAK,CAAC,MAAM,CACxB,iBAAoC,EACpC,iBAAoC;QAEpC,MAAM,QAAQ,GAAG,IAAI,aAAa,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;QACzE,MAAM,QAAQ,CAAC,+BAA+B,EAAE,CAAC;QACjD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,GAAG,CACd,KAAkB,EAClB,aAA4B;QAE5B,IAAI,aAAa,EAAE,CAAC;YAClB,yEAAyE;YACzE,OAAO;YACP,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAClD,CAAC;QAED,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,GAAG,CAAC,KAAkB;QACjC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAE3D,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC;gBACH,sEAAsE;gBACtE,eAAe;gBACf,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBAC7C,OAAO,UAAU,CAAC;YACpB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,KAAK,YAAY,uDAA0B,EAAE,CAAC;oBAChD,2CAA2C;oBAC3C,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBAC5B,OAAO,IAAI,CAAC;gBACd,CAAC;qBAAM,CAAC;oBACN,MAAM,KAAK,CAAC;gBACd,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,MAAM;QACjB,OAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC;IACzC,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,+BAA+B;QAC3C,MAAM,8BAA8B,GAClC,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC;QAElD,IAAI,8BAA8B,EAAE,CAAC;YACnC,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,8BAA8B,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;CACF;AA3ED,sCA2EC"}

package/dist/esm/managers/DonobuFlow.d.ts

@@ -0,0 +1,115 @@
+import { BrowserContext } from 'playwright';
+import { GptClient } from '../clients/GptClient';
+import { FlowMetadata } from '../models/FlowMetadata';
+import { ProposedToolCall } from '../models/ProposedToolCall';
+import { ToolCall } from '../models/ToolCall';
+import { GptMessage } from '../models/GptMessage';
+import { ToolManager } from './ToolManager';
+import { ToolTipper } from './ToolTipper';
+import { FlowsPersistence } from '../persistence/FlowsPersistence';
+import { FocusedPage } from '../models/FocusedPage';
+import { DonobuFlowsManager } from './DonobuFlowsManager';
+export declare class DonobuFlow {
+    readonly flowsManager: DonobuFlowsManager;
+    readonly browserContext: BrowserContext;
+    readonly persistence: FlowsPersistence;
+    readonly gptClient: GptClient | null;
+    readonly toolManager: ToolManager;
+    readonly toolTipper: ToolTipper;
+    readonly proposedToolCalls: ProposedToolCall<any>[];
+    readonly invokedToolCalls: ToolCall[];
+    readonly gptMessages: GptMessage[];
+    readonly focusedPage: FocusedPage;
+    readonly metadata: FlowMetadata;
+    private static readonly logger;
+    private static readonly MAIN_MESSAGE_ELEMENT_LIST_MARKER;
+    private static readonly ADDITIONAL_PAGE_LOAD_WAIT;
+    constructor(flowsManager: DonobuFlowsManager, browserContext: BrowserContext, persistence: FlowsPersistence, gptClient: GptClient | null, toolManager: ToolManager, toolTipper: ToolTipper, proposedToolCalls: ProposedToolCall<any>[], invokedToolCalls: ToolCall[], gptMessages: GptMessage[], focusedPage: FocusedPage, metadata: FlowMetadata);
+    run(): Promise<void>;
+    /**
+     * This method re-assigns the currently focused page (presumably due to the
+     * current page being closed). If there are no other pages in the current
+     * browser context, then the flow is marked as a failure.
+     */
+    private onFocusedPageClosed;
+    /**
+     * This method is called if there are persistent GPT platform failures (there
+     * are internal retries). This method will mark the flow as a failure.
+     */
+    private onPersistentGptFailure;
+    /**
+     * This method is called if there is an unhandled unexpected exception. This
+     * method will mark the flow as a failure.
+     */
+    private onUnexpectedException;
+    /**
+     * This method is called when a flow is complete (i.e. when {@link DonobuFlow.run} should return).
+     */
+    private onComplete;
+    /**
+     * Attempt to POST a JSON body containing given flow ID to the given
+     * ${@link callbackUrl} if the URL is non-null. Note that there is no retying
+     * if the POST fails for any reason; this is a best-effort 1-shot try.
+     */
+    private static invokeFlowFinishedCallback;
+    close(): Promise<void>;
+    private onDialog;
+    private maybeUpdateControlPanel;
+    private getControlPanelMessage;
+    /**
+     * Transitions the flow to its next state. After this method completes, the
+     * `this.metadata.state` will have been updated and the
+     * `this.metadata.nextState` will have been cleared.
+     */
+    private transitionState;
+    private maybeForceEnableControlPanel;
+    private setupInitScriptsAndBindings;
+    /**
+     * Returns an object formatted according to the following priority:
+     *
+     * <ol>
+     *   <li>If the `result` for this flow is non-null, then it is returned as-is.
+     *   <li>If the given next state of the flow is `SUCCESS`, the
+     *       `resultJsonSchema` is non-null, and the `gptClient` is non-null,
+     *       then an attempt is made to take the context of the entire run and
+     *       conform it to this schema. If there is an error when attempting to
+     *       map the data of the current flow to the `resultJsonSchema`, then an
+     *       object with error details is returned.
+     *   <li>Otherwise, the `metadata` of the last tool call is returned.
+     * </ol>
+     */
+    private createResultJson;
+    /**
+     * All this method does is set the next state to {@link State.INITIALIZING}.
+     */
+    private onUnstarted;
+    /**
+     * This method sets up the page initialization scripts and bindings, and
+     * initializes the GPT message history.
+     */
+    private onInitializing;
+    private onRunningAction;
+    private onQueryingLlmForNextAction;
+    private onWaitingForUserForNextAction;
+    private onPaused;
+    private onResuming;
+    private onFailed;
+    private onSuccess;
+    private updateGptMessagesWithUserProposedToolCall;
+    private queryGptForProposedToolCalls;
+    /**
+     * Calls {@link #gptClient} with the given messages and will retry on failure
+     * up to an internally specified maximum number of attempts.
+     */
+    private queryGptWithRetry;
+    private updateTokenCounts;
+    private static createSystemMessageForOverallObjective;
+    private static createMainUserMessage;
+    private static createOptimizedHistoryForGptCall;
+    private setupDonobuControlPanel;
+    /**
+     * Attempts to wait until the currently focused page is stable. If the page
+     * never stabilizes, it just returns after timing out.
+     */
+    private waitForPageStability;
+}