donobu 2.15.1 → 2.17.0

package/dist/lib/fixtures/gptClients.d.ts

@@ -0,0 +1,40 @@
+import { TestFixture } from '@playwright/test';
+import { GptClient } from '../../clients/GptClient';
+import { LanguageModel } from 'ai';
+export declare function getOrCreateDefaultGptClient(): Promise<GptClient>;
+/**
+ * This fixture resolves a GPT client based on environment variables.
+ * Supplying different environment variables will result in different GPT
+ * clients being created. Here is a mapping of client type to environment
+ * variables for how to create the various types of clients...
+ *
+ * Anthropic AWS Bedrock GPT client requires:
+ *  - AWS_BEDROCK_MODEL_NAME
+ *  - AWS_REGION
+ *  - AWS_ACCESS_KEY_ID
+ *  - AWS_SECRET_ACCESS_KEY
+ *
+ * Anthropic GPT client requires:
+ *  - ANTHROPIC_API_KEY
+ *
+ * Google GPT client requires:
+ *  - GOOGLE_GENERATIVE_AI_API_KEY
+ *
+ * OpenAI GPT client requires:
+ *  - OPENAI_API_KEY
+ *
+ * If the modelName is not specified, it will be defaulted according to the
+ * DEFAULT_GPT_MODEL_FOR_PLATFORM mapping.
+ */
+export declare function createGptClient(modelName?: string): Promise<GptClient>;
+export declare function anthropicClient(modelName: string, apiKey?: string): Promise<GptClient>;
+export declare function anthropicClientFixture(modelName: string, apiKey?: string): TestFixture<GptClient, any>;
+export declare function anthropicAwsBedrockClient(modelName: string, region?: string, accessKeyId?: string, secretAccessKey?: string): Promise<GptClient>;
+export declare function anthropicAwsBedrockClientFixture(modelName: string, region?: string, accessKeyId?: string, secretAccessKey?: string): TestFixture<GptClient, any>;
+export declare function googleGeminiClient(modelName: string, apiKey?: string): Promise<GptClient>;
+export declare function googleGeminiClientFixture(modelName: string, apiKey?: string): TestFixture<GptClient, any>;
+export declare function openAiClient(modelName: string, apiKey?: string): Promise<GptClient>;
+export declare function openAiClientFixture(modelName: string, apiKey?: string): TestFixture<GptClient, any>;
+export declare function vercelAiClientFixture(model: LanguageModel): TestFixture<GptClient, any>;
+export declare function gptClientFixture(modelName?: string): TestFixture<GptClient, any>;
+//# sourceMappingURL=gptClients.d.ts.map

package/dist/lib/fixtures/gptClients.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gptClients.d.ts","sourceRoot":"","sources":["../../../src/lib/fixtures/gptClients.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAGpD,OAAO,EAAE,aAAa,EAAE,MAAM,IAAI,CAAC;AAkBnC,wBAAsB,2BAA2B,IAAI,OAAO,CAAC,SAAS,CAAC,CAOtE;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAsB,eAAe,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAiD5E;AAED,wBAAsB,eAAe,CACnC,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,SAAS,CAAC,CAcpB;AAED,wBAAgB,sBAAsB,CACpC,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,GACd,WAAW,CAAC,SAAS,EAAE,GAAG,CAAC,CAK7B;AAED,wBAAsB,yBAAyB,CAC7C,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,EACf,WAAW,CAAC,EAAE,MAAM,EACpB,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,SAAS,CAAC,CAmBpB;AAED,wBAAgB,gCAAgC,CAC9C,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,EACf,WAAW,CAAC,EAAE,MAAM,EACpB,eAAe,CAAC,EAAE,MAAM,GACvB,WAAW,CAAC,SAAS,EAAE,GAAG,CAAC,CAU7B;AAED,wBAAsB,kBAAkB,CACtC,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,SAAS,CAAC,CAepB;AAED,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,GACd,WAAW,CAAC,SAAS,EAAE,GAAG,CAAC,CAK7B;AAED,wBAAsB,YAAY,CAChC,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,SAAS,CAAC,CAcpB;AAED,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,GACd,WAAW,CAAC,SAAS,EAAE,GAAG,CAAC,CAK7B;AAED,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,aAAa,GACnB,WAAW,CAAC,SAAS,EAAE,GAAG,CAAC,CAK7B;AAED,wBAAgB,gBAAgB,CAC9B,SAAS,CAAC,EAAE,MAAM,GACjB,WAAW,CAAC,SAAS,EAAE,GAAG,CAAC,CAK7B"}

package/dist/lib/fixtures/gptClients.js

@@ -0,0 +1,187 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOrCreateDefaultGptClient = getOrCreateDefaultGptClient;
+exports.createGptClient = createGptClient;
+exports.anthropicClient = anthropicClient;
+exports.anthropicClientFixture = anthropicClientFixture;
+exports.anthropicAwsBedrockClient = anthropicAwsBedrockClient;
+exports.anthropicAwsBedrockClientFixture = anthropicAwsBedrockClientFixture;
+exports.googleGeminiClient = googleGeminiClient;
+exports.googleGeminiClientFixture = googleGeminiClientFixture;
+exports.openAiClient = openAiClient;
+exports.openAiClientFixture = openAiClientFixture;
+exports.vercelAiClientFixture = vercelAiClientFixture;
+exports.gptClientFixture = gptClientFixture;
+const GptClientFactory_1 = require("../../clients/GptClientFactory");
+const VercelAiGptClient_1 = require("../../clients/VercelAiGptClient");
+const envVars_1 = require("../../envVars");
+const donobuTestStack_1 = require("../utils/donobuTestStack");
+const DEFAULT_GPT_MODEL_FOR_PLATFORM = {
+    ANTHROPIC: process.env[envVars_1.ENV_VAR_NAMES.ANTHROPIC_MODEL_NAME] ||
+        'claude-3-5-sonnet-latest',
+    ANTHROPIC_AWS_BEDROCK: process.env[envVars_1.ENV_VAR_NAMES.AWS_BEDROCK_MODEL_NAME] || undefined,
+    GOOGLE_GEMINI: process.env[envVars_1.ENV_VAR_NAMES.GOOGLE_GENERATIVE_AI_MODEL_NAME] ||
+        'gemini-2.0-flash',
+    OPENAI: process.env[envVars_1.ENV_VAR_NAMES.OPENAI_API_MODEL_NAME] || 'gpt-4o',
+};
+let defaultGptClient = undefined;
+async function getOrCreateDefaultGptClient() {
+    if (!defaultGptClient) {
+        defaultGptClient = await createGptClient();
+        return defaultGptClient;
+    }
+    else {
+        return defaultGptClient;
+    }
+}
+/**
+ * This fixture resolves a GPT client based on environment variables.
+ * Supplying different environment variables will result in different GPT
+ * clients being created. Here is a mapping of client type to environment
+ * variables for how to create the various types of clients...
+ *
+ * Anthropic AWS Bedrock GPT client requires:
+ *  - AWS_BEDROCK_MODEL_NAME
+ *  - AWS_REGION
+ *  - AWS_ACCESS_KEY_ID
+ *  - AWS_SECRET_ACCESS_KEY
+ *
+ * Anthropic GPT client requires:
+ *  - ANTHROPIC_API_KEY
+ *
+ * Google GPT client requires:
+ *  - GOOGLE_GENERATIVE_AI_API_KEY
+ *
+ * OpenAI GPT client requires:
+ *  - OPENAI_API_KEY
+ *
+ * If the modelName is not specified, it will be defaulted according to the
+ * DEFAULT_GPT_MODEL_FOR_PLATFORM mapping.
+ */
+async function createGptClient(modelName) {
+    // Check which API keys are available
+    const hasAwsCredentials = !!DEFAULT_GPT_MODEL_FOR_PLATFORM.ANTHROPIC_AWS_BEDROCK &&
+        !!process.env[envVars_1.ENV_VAR_NAMES.AWS_ACCESS_KEY_ID] &&
+        !!process.env[envVars_1.ENV_VAR_NAMES.AWS_SECRET_ACCESS_KEY];
+    const hasAnthropicKey = !!process.env[envVars_1.ENV_VAR_NAMES.ANTHROPIC_API_KEY];
+    const hasGoogleKey = !!process.env[envVars_1.ENV_VAR_NAMES.GOOGLE_GENERATIVE_AI_API_KEY];
+    const hasOpenAiKey = !!process.env[envVars_1.ENV_VAR_NAMES.OPENAI_API_KEY];
+    // Priority order: Anthropic AWS Bedrock, Anthropic, Google, OpenAI
+    if (hasAwsCredentials) {
+        const model = modelName || DEFAULT_GPT_MODEL_FOR_PLATFORM.ANTHROPIC_AWS_BEDROCK;
+        const region = process.env[envVars_1.ENV_VAR_NAMES.AWS_REGION];
+        const accessKeyId = process.env[envVars_1.ENV_VAR_NAMES.AWS_ACCESS_KEY_ID];
+        const secretAccessKey = process.env[envVars_1.ENV_VAR_NAMES.AWS_SECRET_ACCESS_KEY];
+        return anthropicAwsBedrockClient(model, region, accessKeyId, secretAccessKey);
+    }
+    else if (hasAnthropicKey) {
+        const model = modelName || DEFAULT_GPT_MODEL_FOR_PLATFORM.ANTHROPIC;
+        return anthropicClient(model);
+    }
+    else if (hasGoogleKey) {
+        const model = modelName || DEFAULT_GPT_MODEL_FOR_PLATFORM.GOOGLE_GEMINI;
+        return googleGeminiClient(model);
+    }
+    else if (hasOpenAiKey) {
+        const model = modelName || DEFAULT_GPT_MODEL_FOR_PLATFORM.OPENAI;
+        return openAiClient(model);
+    }
+    else {
+        const donobu = await (0, donobuTestStack_1.getOrCreateDonobuStack)();
+        const defaultClient = (await donobu.flowsManager.createGptClient(null))
+            .gptClient;
+        if (defaultClient) {
+            return defaultClient;
+        }
+        else {
+            // No API keys are available and there is not flow-runner set up, throw an error.
+            throw new Error(`No API keys found for any supported GPT providers.
+Please set one of the following environment variables: ANTHROPIC_API_KEY, GOOGLE_GENERATIVE_AI_API_KEY, or OPENAI_API_KEY.
+Alternatively, set a flow-runner agent via POST /api/agents/flow-runner or via the Donobu app.`);
+        }
+    }
+}
+async function anthropicClient(modelName, apiKey) {
+    const divinedApiKey = apiKey || process.env[envVars_1.ENV_VAR_NAMES.ANTHROPIC_API_KEY];
+    if (!divinedApiKey) {
+        throw new Error('An API key is required to use the Anthropic API. Please provide one as an argument or set it using the ANTHROPIC_API_KEY environment variable.');
+    }
+    return GptClientFactory_1.GptClientFactory.createFromGptConfig({
+        type: 'ANTHROPIC',
+        apiKey: divinedApiKey,
+        modelName: modelName,
+    });
+}
+function anthropicClientFixture(modelName, apiKey) {
+    return async ({}, use) => {
+        const client = await anthropicClient(modelName, apiKey);
+        await use(client);
+    };
+}
+async function anthropicAwsBedrockClient(modelName, region, accessKeyId, secretAccessKey) {
+    const divinedAccessKeyId = accessKeyId || process.env[envVars_1.ENV_VAR_NAMES.AWS_ACCESS_KEY_ID];
+    const divinedSecretAccessKey = secretAccessKey || process.env[envVars_1.ENV_VAR_NAMES.AWS_SECRET_ACCESS_KEY];
+    if (!divinedAccessKeyId || !divinedSecretAccessKey) {
+        throw new Error('AWS access key ID and secret access key are required to use the Anthropic AWS Bedrock API. Please provide them as arguments or set them using the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables.');
+    }
+    return GptClientFactory_1.GptClientFactory.createFromGptConfig({
+        type: 'ANTHROPIC_AWS_BEDROCK',
+        region: region,
+        modelName: modelName,
+        accessKeyId: divinedAccessKeyId,
+        secretAccessKey: divinedSecretAccessKey,
+    });
+}
+function anthropicAwsBedrockClientFixture(modelName, region, accessKeyId, secretAccessKey) {
+    return async ({}, use) => {
+        const client = await anthropicAwsBedrockClient(modelName, region, accessKeyId, secretAccessKey);
+        await use(client);
+    };
+}
+async function googleGeminiClient(modelName, apiKey) {
+    const divinedApiKey = apiKey || process.env[envVars_1.ENV_VAR_NAMES.GOOGLE_GENERATIVE_AI_API_KEY];
+    if (!divinedApiKey) {
+        throw new Error('An API key is required to use the Google Gemini API. Please provide one as an argument or set it using the GOOGLE_GENERATIVE_AI_API_KEY environment variable.');
+    }
+    return GptClientFactory_1.GptClientFactory.createFromGptConfig({
+        type: 'GOOGLE_GEMINI',
+        apiKey: divinedApiKey,
+        modelName: modelName,
+    });
+}
+function googleGeminiClientFixture(modelName, apiKey) {
+    return async ({}, use) => {
+        const client = await googleGeminiClient(modelName, apiKey);
+        await use(client);
+    };
+}
+async function openAiClient(modelName, apiKey) {
+    const divinedApiKey = apiKey || process.env[envVars_1.ENV_VAR_NAMES.OPENAI_API_KEY];
+    if (!divinedApiKey) {
+        throw new Error('An API key is required to use the OpenAI API. Please provide one as an argument or set it using the OPENAI_API_KEY environment variable.');
+    }
+    return GptClientFactory_1.GptClientFactory.createFromGptConfig({
+        type: 'OPENAI',
+        apiKey: divinedApiKey,
+        modelName: modelName,
+    });
+}
+function openAiClientFixture(modelName, apiKey) {
+    return async ({}, use) => {
+        const client = await openAiClient(modelName, apiKey);
+        await use(client);
+    };
+}
+function vercelAiClientFixture(model) {
+    return async ({}, use) => {
+        const client = new VercelAiGptClient_1.VercelAiGptClient(model);
+        await use(client);
+    };
+}
+function gptClientFixture(modelName) {
+    return async ({}, use) => {
+        const client = await createGptClient(modelName);
+        await use(client);
+    };
+}
+//# sourceMappingURL=gptClients.js.map

package/dist/lib/fixtures/gptClients.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gptClients.js","sourceRoot":"","sources":["../../../src/lib/fixtures/gptClients.ts"],"names":[],"mappings":";;AAsBA,kEAOC;AA0BD,0CAiDC;AAED,0CAiBC;AAED,wDAQC;AAED,8DAwBC;AAED,4EAeC;AAED,gDAkBC;AAED,8DAQC;AAED,oCAiBC;AAED,kDAQC;AAED,sDAOC;AAED,4CAOC;AA3PD,qEAAkE;AAClE,uEAAoE;AAEpE,2CAA8C;AAC9C,8DAAkE;AAElE,MAAM,8BAA8B,GAAG;IACrC,SAAS,EACP,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,oBAAoB,CAAC;QAC/C,0BAA0B;IAC5B,qBAAqB,EACnB,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,sBAAsB,CAAC,IAAI,SAAS;IAChE,aAAa,EACX,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,+BAA+B,CAAC;QAC1D,kBAAkB;IACpB,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,qBAAqB,CAAC,IAAI,QAAQ;CACrE,CAAC;AAEF,IAAI,gBAAgB,GAA0B,SAAS,CAAC;AAEjD,KAAK,UAAU,2BAA2B;IAC/C,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,gBAAgB,GAAG,MAAM,eAAe,EAAE,CAAC;QAC3C,OAAO,gBAAgB,CAAC;IAC1B,CAAC;SAAM,CAAC;QACN,OAAO,gBAAgB,CAAC;IAC1B,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,KAAK,UAAU,eAAe,CAAC,SAAkB;IACtD,qCAAqC;IACrC,MAAM,iBAAiB,GACrB,CAAC,CAAC,8BAA8B,CAAC,qBAAqB;QACtD,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,iBAAiB,CAAC;QAC9C,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,qBAAqB,CAAC,CAAC;IACrD,MAAM,eAAe,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,iBAAiB,CAAC,CAAC;IACvE,MAAM,YAAY,GAChB,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,4BAA4B,CAAC,CAAC;IAC5D,MAAM,YAAY,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,cAAc,CAAC,CAAC;IAEjE,mEAAmE;IACnE,IAAI,iBAAiB,EAAE,CAAC;QACtB,MAAM,KAAK,GACT,SAAS,IAAI,8BAA8B,CAAC,qBAAqB,CAAC;QACpE,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,UAAU,CAAC,CAAC;QACrD,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,iBAAiB,CAAC,CAAC;QACjE,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,qBAAqB,CAAC,CAAC;QACzE,OAAO,yBAAyB,CAC9B,KAAM,EACN,MAAM,EACN,WAAW,EACX,eAAe,CAChB,CAAC;IACJ,CAAC;SAAM,IAAI,eAAe,EAAE,CAAC;QAC3B,MAAM,KAAK,GAAG,SAAS,IAAI,8BAA8B,CAAC,SAAS,CAAC;QACpE,OAAO,eAAe,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;SAAM,IAAI,YAAY,EAAE,CAAC;QACxB,MAAM,KAAK,GAAG,SAAS,IAAI,8BAA8B,CAAC,aAAa,CAAC;QACxE,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;SAAM,IAAI,YAAY,EAAE,CAAC;QACxB,MAAM,KAAK,GAAG,SAAS,IAAI,8BAA8B,CAAC,MAAM,CAAC;QACjE,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;SAAM,CAAC;QACN,MAAM,MAAM,GAAG,MAAM,IAAA,wCAAsB,GAAE,CAAC;QAC9C,MAAM,aAAa,GAAG,CAAC,MAAM,MAAM,CAAC,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;aACpE,SAAS,CAAC;QAEb,IAAI,aAAa,EAAE,CAAC;YAClB,OAAO,aAAa,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,iFAAiF;YACjF,MAAM,IAAI,KAAK,CACb;;+FAEuF,CACxF,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAEM,KAAK,UAAU,eAAe,CACnC,SAAiB,EACjB,MAAe;IAEf,MAAM,aAAa,GAAG,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,iBAAiB,CAAC,CAAC;IAE7E,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CACb,gJAAgJ,CACjJ,CAAC;IACJ,CAAC;IAED,OAAO,mCAAgB,CAAC,mBAAmB,CAAC;QAC1C,IAAI,EAAE,WAAW;QACjB,MAAM,EAAE,aAAa;QACrB,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,sBAAsB,CACpC,SAAiB,EACjB,MAAe;IAEf,OAAO,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE;QACvB,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QACxD,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAEM,KAAK,UAAU,yBAAyB,CAC7C,SAAiB,EACjB,MAAe,EACf,WAAoB,EACpB,eAAwB;IAExB,MAAM,kBAAkB,GACtB,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,iBAAiB,CAAC,CAAC;IAC9D,MAAM,sBAAsB,GAC1B,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,qBAAqB,CAAC,CAAC;IAEtE,IAAI,CAAC,kBAAkB,IAAI,CAAC,sBAAsB,EAAE,CAAC;QACnD,MAAM,IAAI,KAAK,CACb,sNAAsN,CACvN,CAAC;IACJ,CAAC;IAED,OAAO,mCAAgB,CAAC,mBAAmB,CAAC;QAC1C,IAAI,EAAE,uBAAuB;QAC7B,MAAM,EAAE,MAAM;QACd,SAAS,EAAE,SAAS;QACpB,WAAW,EAAE,kBAAkB;QAC/B,eAAe,EAAE,sBAAsB;KACxC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,gCAAgC,CAC9C,SAAiB,EACjB,MAAe,EACf,WAAoB,EACpB,eAAwB;IAExB,OAAO,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE;QACvB,MAAM,MAAM,GAAG,MAAM,yBAAyB,CAC5C,SAAS,EACT,MAAM,EACN,WAAW,EACX,eAAe,CAChB,CAAC;QACF,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAEM,KAAK,UAAU,kBAAkB,CACtC,SAAiB,EACjB,MAAe;IAEf,MAAM,aAAa,GACjB,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,4BAA4B,CAAC,CAAC;IAEpE,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CACb,+JAA+J,CAChK,CAAC;IACJ,CAAC;IAED,OAAO,mCAAgB,CAAC,mBAAmB,CAAC;QAC1C,IAAI,EAAE,eAAe;QACrB,MAAM,EAAE,aAAa;QACrB,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,yBAAyB,CACvC,SAAiB,EACjB,MAAe;IAEf,OAAO,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE;QACvB,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC3D,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAEM,KAAK,UAAU,YAAY,CAChC,SAAiB,EACjB,MAAe;IAEf,MAAM,aAAa,GAAG,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,cAAc,CAAC,CAAC;IAE1E,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CACb,0IAA0I,CAC3I,CAAC;IACJ,CAAC;IAED,OAAO,mCAAgB,CAAC,mBAAmB,CAAC;QAC1C,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,aAAa;QACrB,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,mBAAmB,CACjC,SAAiB,EACjB,MAAe;IAEf,OAAO,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE;QACvB,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QACrD,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAED,SAAgB,qBAAqB,CACnC,KAAoB;IAEpB,OAAO,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE;QACvB,MAAM,MAAM,GAAG,IAAI,qCAAiB,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAED,SAAgB,gBAAgB,CAC9B,SAAkB;IAElB,OAAO,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE;QACvB,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,SAAS,CAAC,CAAC;QAChD,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC"}

package/dist/lib/fixtures/testExtension.d.ts

@@ -0,0 +1,10 @@
+import { DonobuExtendedPage } from '../types';
+import { GptClient } from '../../clients/GptClient';
+import { BrowserStorageState } from '../../models/BrowserStorageState';
+export * from 'playwright/test';
+export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & {
+    storageState?: BrowserStorageState | Promise<BrowserStorageState>;
+    gptClient?: GptClient;
+    page: DonobuExtendedPage;
+}, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
+//# sourceMappingURL=testExtension.d.ts.map

package/dist/lib/fixtures/testExtension.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testExtension.d.ts","sourceRoot":"","sources":["../../../src/lib/fixtures/testExtension.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAmEpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAEvE,cAAc,iBAAiB,CAAC;AAIhC,eAAO,MAAM,IAAI;mBACA,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC;gBACrD,SAAS;UACf,kBAAkB;wGAqaxB,CAAC"}

package/dist/lib/fixtures/testExtension.js

@@ -0,0 +1,383 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.test = void 0;
+const test_1 = require("@playwright/test");
+const uuid_1 = require("uuid");
+const GptClient_1 = require("../../clients/GptClient");
+const VercelAiGptClient_1 = require("../../clients/VercelAiGptClient");
+const PlaywrightUtils_1 = require("../../utils/PlaywrightUtils");
+const donobuTestStack_1 = require("../utils/donobuTestStack");
+const selfHealing_1 = require("../utils/selfHealing");
+const envVars_1 = require("../../envVars");
+const MiscUtils_1 = require("../../utils/MiscUtils");
+const DonobuFlowsManager_1 = require("../../managers/DonobuFlowsManager");
+const gptClients_1 = require("./gptClients");
+const GoToWebpageTool_1 = require("../../tools/GoToWebpageTool");
+const PageInspector_1 = require("../../managers/PageInspector");
+const ControlPanel_1 = require("../../managers/ControlPanel");
+const InteractionVisualizer_1 = require("../../managers/InteractionVisualizer");
+const ToolManager_1 = require("../../managers/ToolManager");
+const AnalyzePageTextTool_1 = require("../../tools/AnalyzePageTextTool");
+const AssertPageTextTool_1 = require("../../tools/AssertPageTextTool");
+const Logger_1 = require("../../utils/Logger");
+const DonobuFlow_1 = require("../../managers/DonobuFlow");
+const HoverOverElementTool_1 = require("../../tools/HoverOverElementTool");
+const InputRandomizedEmailAddressTool_1 = require("../../tools/InputRandomizedEmailAddressTool");
+const AssertTool_1 = require("../../tools/AssertTool");
+const ChangeWebBrowserTabTool_1 = require("../../tools/ChangeWebBrowserTabTool");
+const ChooseSelectOptionTool_1 = require("../../tools/ChooseSelectOptionTool");
+const ClickTool_1 = require("../../tools/ClickTool");
+const CreateBrowserCookieReportTool_1 = require("../../tools/CreateBrowserCookieReportTool");
+const InputTextTool_1 = require("../../tools/InputTextTool");
+const PressKeyTool_1 = require("../../tools/PressKeyTool");
+const RunAccessibilityTestTool_1 = require("../../tools/RunAccessibilityTestTool");
+const ScrollPageTool_1 = require("../../tools/ScrollPageTool");
+__exportStar(require("playwright/test"), exports);
+const PLACEHOLDER_FLOW_URL = 'https://example.com';
+exports.test = test_1.test.extend({
+    // 1) Declare `gptClient` as an "option" fixture with a default of `undefined`.
+    gptClient: [
+        undefined, // default
+        { option: true }, // so that test.use({ gptClient: ... }) can override
+    ],
+    // Override the default page fixture
+    page: async ({ page, gptClient }, use, testInfo) => {
+        if (!gptClient) {
+            try {
+                gptClient = await (0, gptClients_1.getOrCreateDefaultGptClient)();
+            }
+            catch (_error) {
+                // Do nothing since we may not need a GPT client at all anyway.
+                // If something later on requires a GPT client, it will throw an error.
+            }
+        }
+        // Patch the page with "run", but do it lazily
+        const donobu = await (0, donobuTestStack_1.getOrCreateDonobuStack)();
+        await PlaywrightUtils_1.PlaywrightUtils.setupBasicBrowserContext(page.context());
+        let isTestRunInitialized = false;
+        let isTestRunFailed = false;
+        async function maybeInitDonobu() {
+            if (isTestRunInitialized) {
+                return;
+            }
+            const overallObjective = testInfo.annotations.find((v) => {
+                return v.type === 'objective';
+            })?.description ?? null;
+            // Get the implied allowed environment variables by inspecting the objective.
+            const allowedEnvVarsByName = DonobuFlowsManager_1.DonobuFlowsManager.distillAllowedEnvVariableNames(overallObjective, null);
+            const donobuTestFlowMetadata = {
+                id: (0, uuid_1.v4)(),
+                name: testInfo.title,
+                createdWithDonobuVersion: MiscUtils_1.MiscUtils.DONOBU_VERSION,
+                browser: {
+                    using: {
+                        type: 'device',
+                        deviceName: 'Desktop Chromium',
+                        headless: true,
+                    },
+                },
+                envVars: allowedEnvVarsByName,
+                gptConfigName: null,
+                hasGptConfigNameOverride: false,
+                customTools: null,
+                defaultMessageDuration: 0,
+                runMode: 'DETERMINISTIC',
+                isControlPanelEnabled: false,
+                callbackUrl: null,
+                targetWebsite: PLACEHOLDER_FLOW_URL,
+                overallObjective: overallObjective,
+                allowedTools: [],
+                resultJsonSchema: null,
+                result: null,
+                inputTokensUsed: 0,
+                completionTokensUsed: 0,
+                iterations: 0,
+                maxIterations: 0,
+                startedAt: new Date().getTime(),
+                completedAt: null,
+                state: 'RUNNING_ACTION',
+                nextState: null,
+            };
+            const persistenceLayer = await donobu.flowsPersistenceFactory.createPersistenceLayer();
+            await persistenceLayer.setMetadata(donobuTestFlowMetadata);
+            page._donobuFlowMetadata = donobuTestFlowMetadata;
+            isTestRunInitialized = true;
+        }
+        const originalGoto = page.goto;
+        // Intercept 'page.goto' so that Donobu can later re-run it as a standard
+        // Donobu action if necessary. This can happen if you run a Playwright
+        // test using npx, but later decide to rerun that run using the Donobu UI.
+        page.goto = async (url, options) => {
+            await maybeInitDonobu();
+            const startedAt = new Date().getTime();
+            const flowId = page._donobuFlowMetadata.id;
+            const persistenceLayer = await donobu.flowsPersistenceFactory.createPersistenceLayer();
+            // Update the target website to whatever the first place we are
+            // navigating to is.
+            if (page._donobuFlowMetadata.targetWebsite === PLACEHOLDER_FLOW_URL) {
+                page._donobuFlowMetadata = {
+                    ...page._donobuFlowMetadata,
+                    targetWebsite: url,
+                };
+                await persistenceLayer.setMetadata(page._donobuFlowMetadata);
+            }
+            try {
+                const resp = await originalGoto.call(page, url, options);
+                await PlaywrightUtils_1.PlaywrightUtils.waitForPageStability(page);
+                const pageTitle = await page.title();
+                const postCallImage = await PlaywrightUtils_1.PlaywrightUtils.takeScreenshot(page);
+                const postCallImageId = await persistenceLayer.saveScreenShot(flowId, postCallImage);
+                const completedAt = new Date().getTime();
+                await persistenceLayer.saveToolCall(flowId, {
+                    id: MiscUtils_1.MiscUtils.createAdHocToolCallId(),
+                    toolName: GoToWebpageTool_1.GoToWebpageTool.NAME,
+                    parameters: {
+                        url: url,
+                    },
+                    outcome: {
+                        isSuccessful: true,
+                        forLlm: `Successfully navigated to ${url}`,
+                        metadata: {
+                            pageTitle: pageTitle,
+                            resolvedUrl: page.url(),
+                        },
+                    },
+                    postCallImageId: postCallImageId,
+                    page: url,
+                    startedAt: startedAt,
+                    completedAt: completedAt,
+                });
+                return resp;
+            }
+            catch (error) {
+                const postCallImage = await PlaywrightUtils_1.PlaywrightUtils.takeScreenshot(page);
+                const postCallImageId = await persistenceLayer.saveScreenShot(flowId, postCallImage);
+                const completedAt = new Date().getTime();
+                await persistenceLayer.saveToolCall(flowId, {
+                    id: MiscUtils_1.MiscUtils.createAdHocToolCallId(),
+                    toolName: 'goToWebpage',
+                    parameters: {
+                        url: url,
+                    },
+                    outcome: {
+                        isSuccessful: false,
+                        forLlm: `FAILED! ${typeof error}: ${error.message}`,
+                        metadata: null,
+                    },
+                    postCallImageId: postCallImageId,
+                    page: url,
+                    startedAt: startedAt,
+                    completedAt: completedAt,
+                });
+                // Mark test as failed for later callback
+                isTestRunFailed = true;
+                throw error;
+            }
+        };
+        page.run = async (toolName, toolParams, gptClientOverride) => {
+            await maybeInitDonobu();
+            let finalGptClient = null;
+            if (gptClientOverride) {
+                if (!(gptClientOverride instanceof GptClient_1.GptClient)) {
+                    finalGptClient = new VercelAiGptClient_1.VercelAiGptClient(gptClientOverride);
+                }
+                else {
+                    finalGptClient = gptClientOverride;
+                }
+            }
+            else if (gptClient) {
+                finalGptClient = gptClient;
+            }
+            const pageInspector = new PageInspector_1.PageInspector();
+            const controlPanel = new ControlPanel_1.ControlPanel(page._donobuFlowMetadata);
+            const persistenceLayer = await donobu.flowsPersistenceFactory.createPersistenceLayer();
+            const clonedParams = toolParams
+                ? JSON.parse(JSON.stringify(toolParams))
+                : {};
+            clonedParams.rationale || (clonedParams.rationale = '');
+            const envData = await donobu.flowsManager.buildEnvData(page._donobuFlowMetadata.envVars ?? []);
+            const toolCallContext = {
+                flowsManager: donobu.flowsManager,
+                envData: envData,
+                pageInspector: pageInspector,
+                controlPanel: controlPanel,
+                persistence: persistenceLayer,
+                gptClient: finalGptClient,
+                interactionVisualizer: new InteractionVisualizer_1.InteractionVisualizer(0),
+                proposedToolCalls: [],
+                invokedToolCalls: [],
+                page: { current: page },
+                metadata: page._donobuFlowMetadata,
+                toolCallId: clonedParams.toolCallId ?? MiscUtils_1.MiscUtils.createAdHocToolCallId(),
+            };
+            try {
+                const result = await new ToolManager_1.ToolManager(ToolManager_1.ToolManager.ALL_TOOLS).invokeTool(toolCallContext, toolName, clonedParams, false);
+                await persistenceLayer.setMetadata(page._donobuFlowMetadata);
+                await persistenceLayer.saveToolCall(page._donobuFlowMetadata.id, result);
+                // Check if tool execution was successful
+                if (!result.outcome.isSuccessful) {
+                    throw new Error(`${toolName} execution failed: ${JSON.stringify(result, null, 2)}`);
+                }
+                return result.outcome;
+            }
+            catch (error) {
+                // Mark test as failed if an exception occurs during tool execution
+                isTestRunFailed = true;
+                throw error;
+            }
+        };
+        page.analyzePageText = async (params, gptClientOverride) => {
+            return page.run(AnalyzePageTextTool_1.AnalyzePageTextTool.NAME, params, gptClientOverride);
+        };
+        page.assertPageText = async (params, gptClientOverride) => {
+            return page.run(AssertPageTextTool_1.AssertPageTextTool.NAME, params, gptClientOverride);
+        };
+        page.changeTab = async (url) => {
+            // The underlying tool call is mostly performative. We do it so we can
+            // record the operation occurred, but the actual page reassignment happens
+            // at the call site of this function.
+            const result = await page.run(ChangeWebBrowserTabTool_1.ChangeWebBrowserTabTool.NAME, {
+                tabUrl: url,
+            });
+            if (result.isSuccessful) {
+                // We need to return a real Page object, not just the raw URL, so we
+                // loop through the pages of the current context, knowing we will find
+                // a match.
+                return page
+                    .context()
+                    .pages()
+                    .find((tab) => tab.url() === url);
+            }
+            else {
+                throw Error(result.forLlm);
+            }
+        };
+        page.chooseSelectOption = async (params) => {
+            return page.run(ChooseSelectOptionTool_1.ChooseSelectOptionTool.NAME, params);
+        };
+        page.clickElement = async (params) => {
+            return page.run(ClickTool_1.ClickTool.NAME, params);
+        };
+        page.createCookieReport = async (gptClientOverride) => {
+            return page.run(CreateBrowserCookieReportTool_1.CreateBrowserCookieReportTool.NAME, gptClientOverride);
+        };
+        page.extract = async (params, gptClientOverride) => {
+            await maybeInitDonobu();
+            let finalGptClient = null;
+            if (gptClientOverride) {
+                if (!(gptClientOverride instanceof GptClient_1.GptClient)) {
+                    finalGptClient = new VercelAiGptClient_1.VercelAiGptClient(gptClientOverride);
+                }
+                else {
+                    finalGptClient = gptClientOverride;
+                }
+            }
+            else if (gptClient) {
+                finalGptClient = gptClient;
+            }
+            if (!finalGptClient) {
+                isTestRunFailed = true;
+                throw Error('Cannot extract an object from page without a GPT client set up!');
+            }
+            try {
+                const persistenceLayer = await donobu.flowsPersistenceFactory.createPersistenceLayer();
+                const toolCallHistory = await persistenceLayer.getToolCalls(page._donobuFlowMetadata.id);
+                const structuredOutputMessage = await (0, DonobuFlow_1.extractFromPage)(params.instruction ??
+                    'Generate an object conforming to the given JSON-schema', params.schema, page, toolCallHistory, finalGptClient);
+                page._donobuFlowMetadata.resultJsonSchema = params.schema;
+                page._donobuFlowMetadata.result = structuredOutputMessage.output;
+                await persistenceLayer.setMetadata(page._donobuFlowMetadata);
+                return structuredOutputMessage.output;
+            }
+            catch (error) {
+                isTestRunFailed = true;
+                throw error;
+            }
+        };
+        page.hoverOverElement = async (params) => {
+            return page.run(HoverOverElementTool_1.HoverOverElementTool.NAME, params);
+        };
+        page.inputRandomizedEmailAddress = async (params) => {
+            return page.run(InputRandomizedEmailAddressTool_1.InputRandomizedEmailAddressTool.NAME, params);
+        };
+        page.inputText = async (params) => {
+            return page.run(InputTextTool_1.InputTextTool.NAME, params);
+        };
+        page.pressKey = async (params) => {
+            return page.run(PressKeyTool_1.PressKeyTool.NAME, params);
+        };
+        page.runAccessibilityTest = async () => {
+            return page.run(RunAccessibilityTestTool_1.RunAccessibilityTestTool.NAME);
+        };
+        page.scroll = async (params) => {
+            return page.run(ScrollPageTool_1.ScrollPageTool.NAME, params);
+        };
+        page.visuallyAssert = async (params, gptClientOverride) => {
+            return page.run(AssertTool_1.AssertTool.NAME, params, gptClientOverride);
+        };
+        try {
+            // Let Playwright continue and give tests the patched page.
+            await use(page);
+            // Check if the test status is failed in the testInfo
+            // This catches failures that were marked by Playwright itself
+            if (testInfo.status === 'failed' || testInfo.status === 'timedOut') {
+                isTestRunFailed = true;
+            }
+        }
+        catch (error) {
+            // Mark test as failed if an uncaught exception occurs during the test
+            isTestRunFailed = true;
+            throw error;
+        }
+        finally {
+            try {
+                const persistenceLayer = await donobu.flowsPersistenceFactory.createPersistenceLayer();
+                if (page._donobuFlowMetadata) {
+                    // Update metadata with final status
+                    page._donobuFlowMetadata.state = isTestRunFailed
+                        ? 'FAILED'
+                        : 'SUCCESS';
+                    page._donobuFlowMetadata.completedAt = new Date().getTime();
+                    await persistenceLayer.setMetadata(page._donobuFlowMetadata);
+                    await testInfo.attach('test-flow-metadata.json', {
+                        body: JSON.stringify(page._donobuFlowMetadata, null, 2),
+                        contentType: 'application/json',
+                    });
+                }
+            }
+            catch (error) {
+                // Log but don't throw, to ensure cleanup continues.
+                Logger_1.appLogger.error('Error during test cleanup:', error);
+            }
+            const isSelfHealEnabledEnvVar = process.env[envVars_1.ENV_VAR_NAMES.SELF_HEAL_TESTS_ENABLED]?.trim();
+            if (isTestRunFailed &&
+                (isSelfHealEnabledEnvVar === 'true' || isSelfHealEnabledEnvVar === '1')) {
+                if (!gptClient) {
+                    Logger_1.appLogger.warn('Will not self-heal due to no GPT client being set up.');
+                    return;
+                }
+                try {
+                    await (0, selfHealing_1.selfHeal)(gptClient, testInfo, page._donobuFlowMetadata);
+                }
+                catch (selfHealError) {
+                    Logger_1.appLogger.error('Error when attempting to self heal:', selfHealError);
+                }
+            }
+        }
+    },
+});
+//# sourceMappingURL=testExtension.js.map