donobu 1.0.0

package/dist/managers/GptPlatformApiKeysManagerFilesystem.js

@@ -0,0 +1,136 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GptPlatformApiKeysManagerFilesystem = void 0;
+const FlowMetadata_1 = require("../models/FlowMetadata");
+const ApiKeyNotSetUpException_1 = require("../exceptions/ApiKeyNotSetUpException");
+const GptClientFactory_1 = require("../clients/GptClientFactory");
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const Logger_1 = require("../utils/Logger");
+/**
+ * An implementation of the GptPlatformApiKeysManager that uses the local filesystem for
+ * persistence.
+ */
+class GptPlatformApiKeysManagerFilesystem {
+    static API_KEYS_FILENAME = '.gptplatforms';
+    static LEGACY_API_KEY_FILENAME_TEMPLATE = '.%skey';
+    apiKeysFilepath;
+    /**
+     * Creates a new instance, initializing keys using the following rules:
+     * 1. If there are API keys specified in environment variables, save those.
+     * 2. Use the given directory to persist data.
+     *
+     * @param storageDirectory - The directory to store API keys
+     */
+    static async create(storageDirectory) {
+        const instance = new GptPlatformApiKeysManagerFilesystem(storageDirectory);
+        await instance.initialize(storageDirectory);
+        return instance;
+    }
+    constructor(storageDirectory) {
+        this.apiKeysFilepath = path_1.default.join(storageDirectory, GptPlatformApiKeysManagerFilesystem.API_KEYS_FILENAME);
+    }
+    async initialize(storageDirectory) {
+        await this.migrateLegacyKeys(storageDirectory);
+        await this.setApiKeysFromEnvironmentVariables();
+    }
+    async setKey(gptPlatform, apiKey) {
+        const gptModel = this.getGptModelToValidateKeyWith(gptPlatform);
+        // Attempt to create a GPT client using the given key
+        await GptClientFactory_1.GptClientFactory.create(gptPlatform, gptModel, apiKey);
+        await this.setKeyWithNoValidation(gptPlatform, apiKey);
+    }
+    async getKey(gptPlatform) {
+        try {
+            const content = await fs_1.promises.readFile(this.apiKeysFilepath, 'utf-8');
+            const apiKeys = JSON.parse(content);
+            if (apiKeys[gptPlatform]) {
+                return apiKeys[gptPlatform];
+            }
+        }
+        catch (error) {
+            Logger_1.Logger.appLogger.error('Error reading API keys file', error);
+        }
+        throw new ApiKeyNotSetUpException_1.ApiKeyNotSetUpException(gptPlatform.toLowerCase());
+    }
+    async getGptPlatformsWithKeys() {
+        const platforms = Object.values(FlowMetadata_1.Platform);
+        const results = await Promise.all(platforms.map(async (platform) => {
+            try {
+                await this.getKey(platform);
+                return platform;
+            }
+            catch (error) {
+                if (error instanceof ApiKeyNotSetUpException_1.ApiKeyNotSetUpException) {
+                    return null;
+                }
+                throw error;
+            }
+        }));
+        return results.filter((platform) => platform !== null);
+    }
+    async deleteKey(gptPlatform) {
+        await this.setKeyWithNoValidation(gptPlatform, null);
+    }
+    async setKeyWithNoValidation(gptPlatform, apiKey) {
+        let apiKeys = {};
+        try {
+            const content = await fs_1.promises.readFile(this.apiKeysFilepath, 'utf-8');
+            apiKeys = JSON.parse(content);
+        }
+        catch (_e) {
+            // File doesn't exist or is invalid, start with empty object
+        }
+        apiKeys[gptPlatform] = apiKey;
+        await fs_1.promises.writeFile(this.apiKeysFilepath, JSON.stringify(apiKeys));
+    }
+    getGptModelToValidateKeyWith(gptPlatform) {
+        switch (gptPlatform) {
+            case FlowMetadata_1.Platform.OPENAI:
+                return 'gpt-4o-mini';
+            case FlowMetadata_1.Platform.ANTHROPIC:
+                return 'claude-3-haiku-20240307';
+            case FlowMetadata_1.Platform.GOOGLE:
+                return 'gemini-1.5-flash';
+        }
+    }
+    async migrateLegacyKeys(storageDirectory) {
+        for (const platform of Object.values(FlowMetadata_1.Platform)) {
+            const legacyPath = path_1.default.join(storageDirectory, GptPlatformApiKeysManagerFilesystem.LEGACY_API_KEY_FILENAME_TEMPLATE.replace('%s', platform.toLowerCase()));
+            try {
+                const exists = await fs_1.promises
+                    .access(legacyPath)
+                    .then(() => true)
+                    .catch(() => false);
+                if (exists) {
+                    const apiKey = await fs_1.promises.readFile(legacyPath, 'utf-8');
+                    await this.setKeyWithNoValidation(platform, apiKey);
+                    await fs_1.promises.unlink(legacyPath);
+                }
+            }
+            catch (error) {
+                Logger_1.Logger.appLogger.error(`Error migrating legacy API key file for ${platform}`, error);
+            }
+        }
+    }
+    async setApiKeysFromEnvironmentVariables() {
+        for (const platform of Object.values(FlowMetadata_1.Platform)) {
+            const keyName = `${platform}_KEY`;
+            const keyValue = process.env[keyName];
+            if (keyValue) {
+                try {
+                    Logger_1.Logger.appLogger.info(`Setting ${platform} API key using the ${keyName} environment variable.`);
+                    await this.setKeyWithNoValidation(platform, keyValue);
+                }
+                catch (error) {
+                    Logger_1.Logger.appLogger.error(`Failed to set API key for ${platform} using the ${keyName} environment variable.`, error);
+                }
+            }
+        }
+    }
+}
+exports.GptPlatformApiKeysManagerFilesystem = GptPlatformApiKeysManagerFilesystem;
+//# sourceMappingURL=GptPlatformApiKeysManagerFilesystem.js.map

package/dist/managers/GptPlatformApiKeysManagerFilesystem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GptPlatformApiKeysManagerFilesystem.js","sourceRoot":"","sources":["../../src/managers/GptPlatformApiKeysManagerFilesystem.ts"],"names":[],"mappings":";;;;;;AAAA,yDAAkD;AAClD,mFAAgF;AAEhF,kEAA+D;AAC/D,2BAAoC;AACpC,gDAAwB;AACxB,4CAAyC;AAEzC;;;GAGG;AACH,MAAa,mCAAmC;IAGtC,MAAM,CAAU,iBAAiB,GAAG,eAAe,CAAC;IACpD,MAAM,CAAU,gCAAgC,GAAG,QAAQ,CAAC;IACnD,eAAe,CAAS;IAEzC;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACxB,gBAAwB;QAExB,MAAM,QAAQ,GAAG,IAAI,mCAAmC,CAAC,gBAAgB,CAAC,CAAC;QAC3E,MAAM,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QAC5C,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,YAAoB,gBAAwB;QAC1C,IAAI,CAAC,eAAe,GAAG,cAAI,CAAC,IAAI,CAC9B,gBAAgB,EAChB,mCAAmC,CAAC,iBAAiB,CACtD,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,gBAAwB;QAC/C,MAAM,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;QAC/C,MAAM,IAAI,CAAC,kCAAkC,EAAE,CAAC;IAClD,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,WAAqB,EAAE,MAAc;QACvD,MAAM,QAAQ,GAAG,IAAI,CAAC,4BAA4B,CAAC,WAAW,CAAC,CAAC;QAChE,qDAAqD;QACrD,MAAM,mCAAgB,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC7D,MAAM,IAAI,CAAC,sBAAsB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,WAAqB;QACvC,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,aAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YACjE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAEpC,IAAI,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;gBACzB,OAAO,OAAO,CAAC,WAAW,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,eAAM,CAAC,SAAS,CAAC,KAAK,CAAC,6BAA6B,EAAE,KAAK,CAAC,CAAC;QAC/D,CAAC;QAED,MAAM,IAAI,iDAAuB,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC,CAAC;IAC/D,CAAC;IAEM,KAAK,CAAC,uBAAuB;QAClC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,uBAAQ,CAAC,CAAC;QAC1C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;YAC/B,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBAC5B,OAAO,QAAQ,CAAC;YAClB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,KAAK,YAAY,iDAAuB,EAAE,CAAC;oBAC7C,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC,CAAC,CACH,CAAC;QACF,OAAO,OAAO,CAAC,MAAM,CACnB,CAAC,QAAQ,EAAwB,EAAE,CAAC,QAAQ,KAAK,IAAI,CACtD,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,WAAqB;QAC1C,MAAM,IAAI,CAAC,sBAAsB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IACvD,CAAC;IAEO,KAAK,CAAC,sBAAsB,CAClC,WAAqB,EACrB,MAAqB;QAErB,IAAI,OAAO,GAAkC,EAAE,CAAC;QAEhD,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,aAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YACjE,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAChC,CAAC;QAAC,OAAO,EAAE,EAAE,CAAC;YACZ,4DAA4D;QAC9D,CAAC;QAED,OAAO,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC;QAC9B,MAAM,aAAE,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IACpE,CAAC;IAEO,4BAA4B,CAAC,WAAqB;QACxD,QAAQ,WAAW,EAAE,CAAC;YACpB,KAAK,uBAAQ,CAAC,MAAM;gBAClB,OAAO,aAAa,CAAC;YACvB,KAAK,uBAAQ,CAAC,SAAS;gBACrB,OAAO,yBAAyB,CAAC;YACnC,KAAK,uBAAQ,CAAC,MAAM;gBAClB,OAAO,kBAAkB,CAAC;QAC9B,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAAC,gBAAwB;QACtD,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,uBAAQ,CAAC,EAAE,CAAC;YAC/C,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAC1B,gBAAgB,EAChB,mCAAmC,CAAC,gCAAgC,CAAC,OAAO,CAC1E,IAAI,EACJ,QAAQ,CAAC,WAAW,EAAE,CACvB,CACF,CAAC;YAEF,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,aAAE;qBACpB,MAAM,CAAC,UAAU,CAAC;qBAClB,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;qBAChB,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;gBACtB,IAAI,MAAM,EAAE,CAAC;oBACX,MAAM,MAAM,GAAG,MAAM,aAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;oBACtD,MAAM,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;oBACpD,MAAM,aAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,eAAM,CAAC,SAAS,CAAC,KAAK,CACpB,2CAA2C,QAAQ,EAAE,EACrD,KAAK,CACN,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,kCAAkC;QAC9C,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,uBAAQ,CAAC,EAAE,CAAC;YAC/C,MAAM,OAAO,GAAG,GAAG,QAAQ,MAAM,CAAC;YAClC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAEtC,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAI,CAAC;oBACH,eAAM,CAAC,SAAS,CAAC,IAAI,CACnB,WAAW,QAAQ,sBAAsB,OAAO,wBAAwB,CACzE,CAAC;oBACF,MAAM,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;gBACxD,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,eAAM,CAAC,SAAS,CAAC,KAAK,CACpB,6BAA6B,QAAQ,cAAc,OAAO,wBAAwB,EAClF,KAAK,CACN,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;;AA5JH,kFA6JC"}

package/dist/managers/GptPlatformApiKeysManagerVolatile.d.ts

@@ -0,0 +1,35 @@
+import { Platform } from '../models/FlowMetadata';
+import { GptPlatformApiKeysManager } from './GptPlatformApiKeysManager';
+/**
+ * A volatile (in-memory) implementation of GptPlatformApiKeysManager.
+ */
+export declare class GptPlatformApiKeysManagerVolatile implements GptPlatformApiKeysManager {
+    private readonly apiKeys;
+    /**
+     * Sets the given API key with the given GPT platform.
+     *
+     * @param gptPlatform - The GPT platform to set the key for
+     * @param apiKey - The API key to set
+     */
+    setKey(gptPlatform: Platform, apiKey: string): Promise<void>;
+    /**
+     * Returns the API key for the given Platform in plaintext.
+     *
+     * @param gptPlatform - The GPT platform to get the key for
+     * @returns The API key in plaintext
+     * @throws {ApiKeyNotSetUpException} If no API key is set up for the platform
+     */
+    getKey(gptPlatform: Platform): Promise<string>;
+    /**
+     * Returns the list of platforms that have API keys available.
+     *
+     * @returns Array of platforms that have API keys set up
+     */
+    getGptPlatformsWithKeys(): Promise<Platform[]>;
+    /**
+     * Deletes the API key for the given platform.
+     *
+     * @param gptPlatform - The GPT platform to delete the key for
+     */
+    deleteKey(gptPlatform: Platform): Promise<void>;
+}

package/dist/managers/GptPlatformApiKeysManagerVolatile.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GptPlatformApiKeysManagerVolatile = void 0;
+const ApiKeyNotSetUpException_1 = require("../exceptions/ApiKeyNotSetUpException");
+/**
+ * A volatile (in-memory) implementation of GptPlatformApiKeysManager.
+ */
+class GptPlatformApiKeysManagerVolatile {
+    apiKeys = new Map();
+    /**
+     * Sets the given API key with the given GPT platform.
+     *
+     * @param gptPlatform - The GPT platform to set the key for
+     * @param apiKey - The API key to set
+     */
+    async setKey(gptPlatform, apiKey) {
+        this.apiKeys.set(gptPlatform, apiKey);
+    }
+    /**
+     * Returns the API key for the given Platform in plaintext.
+     *
+     * @param gptPlatform - The GPT platform to get the key for
+     * @returns The API key in plaintext
+     * @throws {ApiKeyNotSetUpException} If no API key is set up for the platform
+     */
+    async getKey(gptPlatform) {
+        const apiKey = this.apiKeys.get(gptPlatform);
+        if (!apiKey) {
+            throw new ApiKeyNotSetUpException_1.ApiKeyNotSetUpException(gptPlatform);
+        }
+        return apiKey;
+    }
+    /**
+     * Returns the list of platforms that have API keys available.
+     *
+     * @returns Array of platforms that have API keys set up
+     */
+    async getGptPlatformsWithKeys() {
+        return Array.from(this.apiKeys.keys());
+    }
+    /**
+     * Deletes the API key for the given platform.
+     *
+     * @param gptPlatform - The GPT platform to delete the key for
+     */
+    async deleteKey(gptPlatform) {
+        this.apiKeys.delete(gptPlatform);
+    }
+}
+exports.GptPlatformApiKeysManagerVolatile = GptPlatformApiKeysManagerVolatile;
+//# sourceMappingURL=GptPlatformApiKeysManagerVolatile.js.map

package/dist/managers/GptPlatformApiKeysManagerVolatile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GptPlatformApiKeysManagerVolatile.js","sourceRoot":"","sources":["../../src/managers/GptPlatformApiKeysManagerVolatile.ts"],"names":[],"mappings":";;;AAEA,mFAAgF;AAEhF;;GAEG;AACH,MAAa,iCAAiC;IAG3B,OAAO,GAA0B,IAAI,GAAG,EAAE,CAAC;IAE5D;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,WAAqB,EAAE,MAAc;QACvD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,WAAqB;QACvC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,iDAAuB,CAAC,WAAW,CAAC,CAAC;QACjD,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,uBAAuB;QAClC,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,WAAqB;QAC1C,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACnC,CAAC;CACF;AA/CD,8EA+CC"}

package/dist/managers/GptResourcesManager.d.ts

@@ -0,0 +1,44 @@
+import { Platform } from '../models/FlowMetadata';
+import { GptResource } from '../models/GptResource';
+import { GptResourcesPersistence } from '../persistence/GptResourcesPersistence';
+import { GptPlatformApiKeysManager } from './GptPlatformApiKeysManager';
+/**
+ * This class manages GPT resources and is responsible for validation around
+ * that context.
+ */
+export declare class GptResourcesManager {
+    private readonly persistence;
+    private constructor();
+    static create(persistence: GptResourcesPersistence, legacyApiKeysManager?: GptPlatformApiKeysManager): Promise<GptResourcesManager>;
+    /**
+     * Attempt to save the given GPT resource. Where possible, a zero-cost
+     * request is attempted to be made with the GPT resource before saving it.
+     * If the zero-cost request is attemted and it fails, this method throws.
+     */
+    set(name: string, resource: GptResource): Promise<void>;
+    /**
+     * Fetch a GPT resource by name.
+     */
+    get(name: string): Promise<GptResource>;
+    /**
+     * Fetch all GPT resources.
+     */
+    getAll(): Promise<Map<string, GptResource>>;
+    /**
+     * Delete a GPT resource by name.
+     */
+    delete(name: string): Promise<void>;
+    /**
+     * Verifies the given GPT resource and name or throws if they are invalid.
+     */
+    private verifyGptResourceOrThrow;
+    static portGptResourceFromLegacy(gptResourcesManager: GptResourcesManager, legacyApiKeysManager: GptPlatformApiKeysManager, platform: Platform | null, modelName: string | null): Promise<{
+        name: string;
+        resource: GptResource;
+    } | null>;
+    /**
+     * Ports legacy GPT platform keys to GPT resources if a corresponding GPT
+     * resource does not exist.
+     */
+    private static portLegacyApiKeys;
+}

package/dist/managers/GptResourcesManager.js

@@ -0,0 +1,180 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GptResourcesManager = void 0;
+const GptClientFactory_1 = require("../clients/GptClientFactory");
+const InvalidParamValueException_1 = require("../exceptions/InvalidParamValueException");
+const FlowMetadata_1 = require("../models/FlowMetadata");
+/**
+ * This class manages GPT resources and is responsible for validation around
+ * that context.
+ */
+class GptResourcesManager {
+    persistence;
+    constructor(persistence) {
+        this.persistence = persistence;
+    }
+    static async create(persistence, legacyApiKeysManager) {
+        const instance = new GptResourcesManager(persistence);
+        if (legacyApiKeysManager) {
+            await GptResourcesManager.portLegacyApiKeys(instance, legacyApiKeysManager);
+        }
+        return instance;
+    }
+    /**
+     * Attempt to save the given GPT resource. Where possible, a zero-cost
+     * request is attempted to be made with the GPT resource before saving it.
+     * If the zero-cost request is attemted and it fails, this method throws.
+     */
+    async set(name, resource) {
+        await this.verifyGptResourceOrThrow(name, resource);
+        await this.persistence.set(name, resource);
+    }
+    /**
+     * Fetch a GPT resource by name.
+     */
+    async get(name) {
+        return this.persistence.get(name);
+    }
+    /**
+     * Fetch all GPT resources.
+     */
+    async getAll() {
+        return this.persistence.getAll();
+    }
+    /**
+     * Delete a GPT resource by name.
+     */
+    async delete(name) {
+        return this.persistence.delete(name);
+    }
+    /**
+     * Verifies the given GPT resource and name or throws if they are invalid.
+     */
+    async verifyGptResourceOrThrow(name, resource) {
+        if (!name || name.length > 64) {
+            throw new InvalidParamValueException_1.InvalidParamValueException('name', name, 'the GPT resource name must be a non-blank string 64 characters or fewer');
+        }
+        // Creating a GPT client performs validation on its own.
+        await GptClientFactory_1.GptClientFactory.createFromGptResource(resource);
+    }
+    static async portGptResourceFromLegacy(gptResourcesManager, legacyApiKeysManager, platform, modelName) {
+        if (!platform) {
+            return null;
+        }
+        const defaultModelForPlatform = new Map([
+            [FlowMetadata_1.Platform.ANTHROPIC, 'claude-3-7-sonnet-latest'],
+            [FlowMetadata_1.Platform.GOOGLE, 'gemini-2.0-flash'],
+            [FlowMetadata_1.Platform.OPENAI, 'gpt-4o'],
+        ]);
+        if (!modelName) {
+            modelName = defaultModelForPlatform.get(platform);
+        }
+        try {
+            return {
+                name: modelName,
+                resource: await gptResourcesManager.get(modelName),
+            };
+        }
+        catch (_error) {
+            // Nothing found, so port it.
+            if (platform === FlowMetadata_1.Platform.ANTHROPIC) {
+                await gptResourcesManager.set(modelName, {
+                    type: 'ANTHROPIC',
+                    apiKey: await legacyApiKeysManager.getKey(platform),
+                    modelName: modelName,
+                });
+            }
+            else if (platform === FlowMetadata_1.Platform.GOOGLE) {
+                await gptResourcesManager.set(modelName, {
+                    type: 'GOOGLE_GEMINI',
+                    apiKey: await legacyApiKeysManager.getKey(platform),
+                    modelName: modelName,
+                });
+            }
+            else if (platform === FlowMetadata_1.Platform.OPENAI) {
+                await gptResourcesManager.set(modelName, {
+                    type: 'OPENAI',
+                    apiKey: await legacyApiKeysManager.getKey(platform),
+                    modelName: modelName,
+                });
+            }
+            else {
+                return null;
+            }
+        }
+        return {
+            name: modelName,
+            resource: await gptResourcesManager.get(modelName),
+        };
+    }
+    /**
+     * Ports legacy GPT platform keys to GPT resources if a corresponding GPT
+     * resource does not exist.
+     */
+    static async portLegacyApiKeys(gptResourcesManager, legacyApiKeysManager) {
+        const standardModelsForPlatform = new Map([
+            [
+                FlowMetadata_1.Platform.ANTHROPIC,
+                ['claude-3-7-sonnet-latest', 'claude-3-5-sonnet-latest'],
+            ],
+            [FlowMetadata_1.Platform.GOOGLE, ['gemini-2.0-flash', 'gemini-1.5-pro']],
+            [FlowMetadata_1.Platform.OPENAI, ['gpt-4o', 'gpt-4o-mini']],
+        ]);
+        const gptPlatformsWithKeys = await legacyApiKeysManager.getGptPlatformsWithKeys();
+        for (const platform of gptPlatformsWithKeys) {
+            if (platform === FlowMetadata_1.Platform.ANTHROPIC) {
+                const modelsToPort = standardModelsForPlatform.get(platform);
+                for (const modelName of modelsToPort) {
+                    try {
+                        await gptResourcesManager.get(modelName);
+                    }
+                    catch (_error) {
+                        // Nothing found, so port it.
+                        await gptResourcesManager.set(modelName, {
+                            type: 'ANTHROPIC',
+                            apiKey: await legacyApiKeysManager.getKey(platform),
+                            modelName: modelName,
+                        });
+                    }
+                }
+            }
+            else if (platform === FlowMetadata_1.Platform.GOOGLE) {
+                const modelsToPort = standardModelsForPlatform.get(platform);
+                for (const modelName of modelsToPort) {
+                    try {
+                        await gptResourcesManager.get(modelName);
+                    }
+                    catch (_error) {
+                        // Nothing found, so port it.
+                        await gptResourcesManager.set(modelName, {
+                            type: 'GOOGLE_GEMINI',
+                            apiKey: await legacyApiKeysManager.getKey(platform),
+                            modelName: modelName,
+                        });
+                    }
+                }
+            }
+            else if (platform === FlowMetadata_1.Platform.OPENAI) {
+                const modelsToPort = standardModelsForPlatform.get(platform);
+                for (const modelName of modelsToPort) {
+                    try {
+                        await gptResourcesManager.get(modelName);
+                    }
+                    catch (_error) {
+                        // Nothing found, so port it.
+                        await gptResourcesManager.set(modelName, {
+                            type: 'OPENAI',
+                            apiKey: await legacyApiKeysManager.getKey(platform),
+                            modelName: modelName,
+                        });
+                    }
+                }
+            }
+            else {
+                // Unknown platform, do nothing.
+            }
+        }
+    }
+}
+exports.GptResourcesManager = GptResourcesManager;
+//# sourceMappingURL=GptResourcesManager.js.map

package/dist/managers/GptResourcesManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GptResourcesManager.js","sourceRoot":"","sources":["../../src/managers/GptResourcesManager.ts"],"names":[],"mappings":";;;AAAA,kEAA+D;AAC/D,yFAAsF;AACtF,yDAAkD;AAKlD;;;GAGG;AACH,MAAa,mBAAmB;IACO;IAArC,YAAqC,WAAoC;QAApC,gBAAW,GAAX,WAAW,CAAyB;IAAG,CAAC;IAEtE,MAAM,CAAC,KAAK,CAAC,MAAM,CACxB,WAAoC,EACpC,oBAAgD;QAEhD,MAAM,QAAQ,GAAG,IAAI,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAEtD,IAAI,oBAAoB,EAAE,CAAC;YACzB,MAAM,mBAAmB,CAAC,iBAAiB,CACzC,QAAQ,EACR,oBAAoB,CACrB,CAAC;QACJ,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,GAAG,CAAC,IAAY,EAAE,QAAqB;QAClD,MAAM,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACpD,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,GAAG,CAAC,IAAY;QAC3B,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,wBAAwB,CACpC,IAAY,EACZ,QAAqB;QAErB,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YAC9B,MAAM,IAAI,uDAA0B,CAClC,MAAM,EACN,IAAI,EACJ,yEAAyE,CAC1E,CAAC;QACJ,CAAC;QACD,wDAAwD;QACxD,MAAM,mCAAgB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAC3C,mBAAwC,EACxC,oBAA+C,EAC/C,QAAyB,EACzB,SAAwB;QAExB,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,uBAAuB,GAAG,IAAI,GAAG,CAAmB;YACxD,CAAC,uBAAQ,CAAC,SAAS,EAAE,0BAA0B,CAAC;YAChD,CAAC,uBAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;YACrC,CAAC,uBAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;SAC5B,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAS,GAAG,uBAAuB,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC;QACrD,CAAC;QAED,IAAI,CAAC;YACH,OAAO;gBACL,IAAI,EAAE,SAAS;gBACf,QAAQ,EAAE,MAAM,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC;aACnD,CAAC;QACJ,CAAC;QAAC,OAAO,MAAM,EAAE,CAAC;YAChB,6BAA6B;YAC7B,IAAI,QAAQ,KAAK,uBAAQ,CAAC,SAAS,EAAE,CAAC;gBACpC,MAAM,mBAAmB,CAAC,GAAG,CAAC,SAAS,EAAE;oBACvC,IAAI,EAAE,WAAW;oBACjB,MAAM,EAAE,MAAM,oBAAoB,CAAC,MAAM,CAAC,QAAQ,CAAC;oBACnD,SAAS,EAAE,SAAS;iBACrB,CAAC,CAAC;YACL,CAAC;iBAAM,IAAI,QAAQ,KAAK,uBAAQ,CAAC,MAAM,EAAE,CAAC;gBACxC,MAAM,mBAAmB,CAAC,GAAG,CAAC,SAAS,EAAE;oBACvC,IAAI,EAAE,eAAe;oBACrB,MAAM,EAAE,MAAM,oBAAoB,CAAC,MAAM,CAAC,QAAQ,CAAC;oBACnD,SAAS,EAAE,SAAS;iBACrB,CAAC,CAAC;YACL,CAAC;iBAAM,IAAI,QAAQ,KAAK,uBAAQ,CAAC,MAAM,EAAE,CAAC;gBACxC,MAAM,mBAAmB,CAAC,GAAG,CAAC,SAAS,EAAE;oBACvC,IAAI,EAAE,QAAQ;oBACd,MAAM,EAAE,MAAM,oBAAoB,CAAC,MAAM,CAAC,QAAQ,CAAC;oBACnD,SAAS,EAAE,SAAS;iBACrB,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QAED,OAAO;YACL,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,MAAM,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC;SACnD,CAAC;IACJ,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,KAAK,CAAC,iBAAiB,CACpC,mBAAwC,EACxC,oBAA+C;QAE/C,MAAM,yBAAyB,GAAG,IAAI,GAAG,CAAqB;YAC5D;gBACE,uBAAQ,CAAC,SAAS;gBAClB,CAAC,0BAA0B,EAAE,0BAA0B,CAAC;aACzD;YACD,CAAC,uBAAQ,CAAC,MAAM,EAAE,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAC;YACzD,CAAC,uBAAQ,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;SAC7C,CAAC,CAAC;QACH,MAAM,oBAAoB,GACxB,MAAM,oBAAoB,CAAC,uBAAuB,EAAE,CAAC;QAEvD,KAAK,MAAM,QAAQ,IAAI,oBAAoB,EAAE,CAAC;YAC5C,IAAI,QAAQ,KAAK,uBAAQ,CAAC,SAAS,EAAE,CAAC;gBACpC,MAAM,YAAY,GAAG,yBAAyB,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC;gBAE9D,KAAK,MAAM,SAAS,IAAI,YAAY,EAAE,CAAC;oBACrC,IAAI,CAAC;wBACH,MAAM,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;oBAC3C,CAAC;oBAAC,OAAO,MAAM,EAAE,CAAC;wBAChB,6BAA6B;wBAC7B,MAAM,mBAAmB,CAAC,GAAG,CAAC,SAAS,EAAE;4BACvC,IAAI,EAAE,WAAW;4BACjB,MAAM,EAAE,MAAM,oBAAoB,CAAC,MAAM,CAAC,QAAQ,CAAC;4BACnD,SAAS,EAAE,SAAS;yBACrB,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,IAAI,QAAQ,KAAK,uBAAQ,CAAC,MAAM,EAAE,CAAC;gBACxC,MAAM,YAAY,GAAG,yBAAyB,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC;gBAE9D,KAAK,MAAM,SAAS,IAAI,YAAY,EAAE,CAAC;oBACrC,IAAI,CAAC;wBACH,MAAM,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;oBAC3C,CAAC;oBAAC,OAAO,MAAM,EAAE,CAAC;wBAChB,6BAA6B;wBAC7B,MAAM,mBAAmB,CAAC,GAAG,CAAC,SAAS,EAAE;4BACvC,IAAI,EAAE,eAAe;4BACrB,MAAM,EAAE,MAAM,oBAAoB,CAAC,MAAM,CAAC,QAAQ,CAAC;4BACnD,SAAS,EAAE,SAAS;yBACrB,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,IAAI,QAAQ,KAAK,uBAAQ,CAAC,MAAM,EAAE,CAAC;gBACxC,MAAM,YAAY,GAAG,yBAAyB,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC;gBAE9D,KAAK,MAAM,SAAS,IAAI,YAAY,EAAE,CAAC;oBACrC,IAAI,CAAC;wBACH,MAAM,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;oBAC3C,CAAC;oBAAC,OAAO,MAAM,EAAE,CAAC;wBAChB,6BAA6B;wBAC7B,MAAM,mBAAmB,CAAC,GAAG,CAAC,SAAS,EAAE;4BACvC,IAAI,EAAE,QAAQ;4BACd,MAAM,EAAE,MAAM,oBAAoB,CAAC,MAAM,CAAC,QAAQ,CAAC;4BACnD,SAAS,EAAE,SAAS;yBACrB,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,gCAAgC;YAClC,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAlMD,kDAkMC"}

package/dist/managers/RequestContextHolder.d.ts

@@ -0,0 +1,24 @@
+import { RequestContext } from '../models/RequestContext';
+export declare class RequestContextHolder {
+    private static readonly requestContextStorage;
+    private fallbackContext;
+    constructor();
+    /**
+     * Returns the current request context if one exists for this async context,
+     * otherwise returns the fallback context.
+     */
+    get(): RequestContext;
+    /**
+     * Sets the context-local request context for this request.
+     * Should be called at the start of handling a request.
+     */
+    setForCurrentContext(context: RequestContext): void;
+    /**
+     * Clears the context-local request context after a request is finished.
+     */
+    clearForCurrentContext(): void;
+    /**
+     * Sets a global fallback request context to use when no request context is available.
+     */
+    setFallbackContext(context: RequestContext): void;
+}

package/dist/managers/RequestContextHolder.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestContextHolder = void 0;
+const async_hooks_1 = require("async_hooks");
+const RequestContext_1 = require("../models/RequestContext");
+class RequestContextHolder {
+    static requestContextStorage = new async_hooks_1.AsyncLocalStorage();
+    fallbackContext;
+    constructor() {
+        this.fallbackContext = new RequestContext_1.RequestContext(null);
+    }
+    /**
+     * Returns the current request context if one exists for this async context,
+     * otherwise returns the fallback context.
+     */
+    get() {
+        return (RequestContextHolder.requestContextStorage.getStore() ??
+            this.fallbackContext);
+    }
+    /**
+     * Sets the context-local request context for this request.
+     * Should be called at the start of handling a request.
+     */
+    setForCurrentContext(context) {
+        RequestContextHolder.requestContextStorage.enterWith(context);
+    }
+    /**
+     * Clears the context-local request context after a request is finished.
+     */
+    clearForCurrentContext() {
+        // Note: AsyncLocalStorage doesn't have a direct "remove" equivalent
+        // The context will be automatically cleaned up when the async context ends
+        RequestContextHolder.requestContextStorage.disable();
+    }
+    /**
+     * Sets a global fallback request context to use when no request context is available.
+     */
+    setFallbackContext(context) {
+        this.fallbackContext = context;
+    }
+}
+exports.RequestContextHolder = RequestContextHolder;
+//# sourceMappingURL=RequestContextHolder.js.map

package/dist/managers/RequestContextHolder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RequestContextHolder.js","sourceRoot":"","sources":["../../src/managers/RequestContextHolder.ts"],"names":[],"mappings":";;;AAAA,6CAAgD;AAChD,6DAA0D;AAE1D,MAAa,oBAAoB;IACvB,MAAM,CAAU,qBAAqB,GAC3C,IAAI,+BAAiB,EAAkB,CAAC;IAClC,eAAe,CAAiB;IAExC;QACE,IAAI,CAAC,eAAe,GAAG,IAAI,+BAAc,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACI,GAAG;QACR,OAAO,CACL,oBAAoB,CAAC,qBAAqB,CAAC,QAAQ,EAAE;YACrD,IAAI,CAAC,eAAe,CACrB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,oBAAoB,CAAC,OAAuB;QACjD,oBAAoB,CAAC,qBAAqB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACI,sBAAsB;QAC3B,oEAAoE;QACpE,2EAA2E;QAC3E,oBAAoB,CAAC,qBAAqB,CAAC,OAAO,EAAE,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,kBAAkB,CAAC,OAAuB;QAC/C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC;IACjC,CAAC;;AA1CH,oDA2CC"}

package/dist/managers/SelectorGenerator.d.ts

@@ -0,0 +1,8 @@
+import { Locator } from 'playwright';
+/**
+ * Generate valid selectors for the given element. The generated selectors are in a priority order
+ * based on their ability to identify the given element. For example, an unambiguous selector that
+ * matches the element exactly are first in the list, and weaker selectors that match multiple
+ * elements are last.
+ */
+export declare function generateSelectors(element: Locator): Promise<string[]>;

package/dist/managers/SelectorGenerator.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateSelectors = generateSelectors;
+/**
+ * Generate valid selectors for the given element. The generated selectors are in a priority order
+ * based on their ability to identify the given element. For example, an unambiguous selector that
+ * matches the element exactly are first in the list, and weaker selectors that match multiple
+ * elements are last.
+ */
+async function generateSelectors(element) {
+    return element.evaluate((elem) => {
+        return window.donobuGenerateSmartSelectors(elem);
+    });
+}
+//# sourceMappingURL=SelectorGenerator.js.map

package/dist/managers/SelectorGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SelectorGenerator.js","sourceRoot":"","sources":["../../src/managers/SelectorGenerator.ts"],"names":[],"mappings":";;AAQA,8CAIC;AAVD;;;;;GAKG;AACI,KAAK,UAAU,iBAAiB,CAAC,OAAgB;IACtD,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE;QAC/B,OAAO,MAAM,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/managers/ToolManager.d.ts

@@ -0,0 +1,21 @@
+import { ProposedToolCall } from '../models/ProposedToolCall';
+import { ToolCall } from '../models/ToolCall';
+import { ToolCallContext } from '../models/ToolCallContext';
+import { Tool } from '../tools/Tool';
+/**
+ * Manages calls to a given list of tools.
+ */
+export declare class ToolManager {
+    readonly tools: Tool<any, any>[];
+    private static readonly logger;
+    static readonly ALL_TOOLS: Tool<any, any>[];
+    static readonly DEFAULT_TOOLS: Tool<any, any>[];
+    constructor(tools: Tool<any, any>[]);
+    invokeTool(context: ToolCallContext, proposedToolCall: ProposedToolCall<any>, isFromGpt: boolean): Promise<ToolCall>;
+    private executeToolCall;
+    /**
+     * Maps a proposed Donobu tool call to valid NodeJS Playwright code that uses
+     * the `DonobuExtendedPage` extension.
+     */
+    convertToPlaywrightCode(proposedToolCall: ProposedToolCall<any>): string;
+}