donobu 1.0.0

package/dist/esm/clients/OpenAiGptClient.js

@@ -0,0 +1,269 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenAiGptClient = void 0;
+const GptClient_1 = require("./GptClient");
+const Logger_1 = require("../utils/Logger");
+const JsonUtils_1 = require("../utils/JsonUtils");
+const GptModelNotFoundException_1 = require("../exceptions/GptModelNotFoundException");
+const GptPlatformAuthenticationFailedException_1 = require("../exceptions/GptPlatformAuthenticationFailedException");
+const GptPlatformInternalErrorException_1 = require("../exceptions/GptPlatformInternalErrorException");
+const GptPlatformNotReachableException_1 = require("../exceptions/GptPlatformNotReachableException");
+/**
+ * A GPT client implemented using the OpenAI API.
+ * @see https://platform.openai.com/docs/api-reference/chat
+ */
+class OpenAiGptClient extends GptClient_1.GptClient {
+    openAiConfig;
+    static API_URL = 'https://api.openai.com';
+    static REQUEST_TIMEOUT_MILLISECONDS = 60000;
+    headers;
+    /**
+     * Create a new instance.
+     * @param apiKey The OpenAI API key to use for all requests with this client.
+     * @param modelName See https://platform.openai.com/docs/models for the list of models.
+     * @param apiUrl The URL of the API to use for all requests with this client.
+     */
+    constructor(openAiConfig) {
+        super(openAiConfig);
+        this.openAiConfig = openAiConfig;
+        this.headers = new Headers({
+            Authorization: `Bearer ${openAiConfig.apiKey}`,
+            'Content-Type': 'application/json',
+        });
+    }
+    async ping() {
+        const resp = await this.makeRequest(`/v1/models/${this.openAiConfig.modelName}`);
+        if (resp.status === 404) {
+            throw new GptModelNotFoundException_1.GptModelNotFoundException(this.config.type, this.openAiConfig.modelName);
+        }
+        else if (resp.status !== 200) {
+            throw await this.mapErrorResponseToDonobuException(resp);
+        }
+    }
+    async getMessage(messages) {
+        const body = {
+            model: this.openAiConfig.modelName,
+            temperature: 0.0,
+            messages: messages.map((msg) => this.chatRequestMessageFromGptMessage(msg)),
+        };
+        const resp = await this.makeRequest('/v1/chat/completions', 'POST', body);
+        if (resp.status !== 200) {
+            throw await this.mapErrorResponseToDonobuException(resp);
+        }
+        else {
+            const data = await resp.json();
+            return this.parseAssistantMessage(data);
+        }
+    }
+    async getStructuredOutputWithSchema(messages, jsonSchema) {
+        const body = {
+            model: this.openAiConfig.modelName,
+            temperature: 0.0,
+            response_format: {
+                type: 'json_schema',
+                json_schema: {
+                    name: jsonSchema.title || 'output',
+                    strict: true,
+                    schema: jsonSchema,
+                },
+            },
+            messages: messages.map((msg) => this.chatRequestMessageFromGptMessage(msg)),
+        };
+        const resp = await this.makeRequest('/v1/chat/completions', 'POST', body);
+        if (resp.status !== 200) {
+            throw await this.mapErrorResponseToDonobuException(resp);
+        }
+        else {
+            const data = await resp.json();
+            return this.parseStructuredOutputMessage(data);
+        }
+    }
+    async getToolCalls(messages, tools) {
+        const body = {
+            model: this.openAiConfig.modelName,
+            temperature: 0.0,
+            tool_choice: 'required',
+            tools: tools.length > 0
+                ? tools.map((tool) => this.toolChoiceFromTool(tool))
+                : undefined,
+            messages: messages.map((msg) => this.chatRequestMessageFromGptMessage(msg)),
+        };
+        const resp = await this.makeRequest('/v1/chat/completions', 'POST', body);
+        if (resp.status !== 200) {
+            throw await this.mapErrorResponseToDonobuException(resp);
+        }
+        else {
+            const data = await resp.json();
+            return this.parseProposedToolCallsMessage(tools, data);
+        }
+    }
+    chatRequestMessageFromGptMessage(gptMessage) {
+        if (gptMessage.type === 'assistant') {
+            return {
+                role: 'assistant',
+                content: { type: 'text', text: gptMessage.text },
+            };
+        }
+        if (gptMessage.type === 'structured_output') {
+            return {
+                role: 'assistant',
+                content: {
+                    type: 'text',
+                    text: JSON.stringify(gptMessage.output, null, 2),
+                },
+            };
+        }
+        if (gptMessage.type === 'proposed_tool_calls') {
+            return {
+                role: 'assistant',
+                tool_calls: gptMessage.proposedToolCalls.map((tc) => ({
+                    id: tc.toolCallId,
+                    type: 'function',
+                    function: {
+                        name: tc.name,
+                        arguments: JSON.stringify(tc.parameters),
+                    },
+                })),
+            };
+        }
+        if (gptMessage.type === 'system') {
+            return {
+                role: 'system',
+                content: gptMessage.text,
+            };
+        }
+        if (gptMessage.type === 'user') {
+            return {
+                role: 'user',
+                content: gptMessage.items.map((item) => {
+                    if ('bytes' in item) {
+                        // PNG
+                        return {
+                            type: 'image_url',
+                            image_url: {
+                                url: `data:image/jpeg;base64,${Buffer.from(item.bytes).toString('base64')}`,
+                            },
+                        };
+                    }
+                    else {
+                        // Text
+                        return {
+                            type: 'text',
+                            text: item.text,
+                        };
+                    }
+                }),
+            };
+        }
+        if (gptMessage.type === 'tool_call_result') {
+            return {
+                role: 'tool',
+                content: gptMessage.data,
+                tool_call_id: gptMessage.toolCallId,
+            };
+        }
+        throw new Error(`Unsupported message type: ${JsonUtils_1.JsonUtils.objectToJson(gptMessage)}`);
+    }
+    toolChoiceFromTool(tool) {
+        return {
+            type: 'function',
+            function: {
+                name: tool.name,
+                description: tool.description.trim(),
+                parameters: tool.jsonSchema,
+            },
+        };
+    }
+    parseAssistantMessage(response) {
+        const text = response.choices[0].message.content;
+        const promptTokensUsed = response.usage.prompt_tokens;
+        const completionTokensUsed = response.usage.completion_tokens;
+        return {
+            type: 'assistant',
+            text: text,
+            promptTokensUsed: promptTokensUsed,
+            completionTokensUsed: completionTokensUsed,
+        };
+    }
+    parseStructuredOutputMessage(response) {
+        const text = response.choices[0].message.content;
+        const output = JsonUtils_1.JsonUtils.jsonStringToJsonObject(text);
+        if (!output) {
+            throw new Error('Failed to parse structured output');
+        }
+        const promptTokensUsed = response.usage.prompt_tokens;
+        const completionTokensUsed = response.usage.completion_tokens;
+        return {
+            type: 'structured_output',
+            output: output,
+            promptTokensUsed: promptTokensUsed,
+            completionTokensUsed: completionTokensUsed,
+        };
+    }
+    parseProposedToolCallsMessage(tools, response) {
+        const toolCalls = response.choices[0].message.tool_calls;
+        if (!toolCalls?.length) {
+            throw new Error('No tool calls found in response');
+        }
+        const proposedCalls = toolCalls.map((tc) => {
+            const functionName = tc.function.name;
+            const parameters = JsonUtils_1.JsonUtils.jsonStringToJsonObject(tc.function.arguments);
+            const toolCallId = tc.id;
+            const tool = tools.find((t) => t.name === functionName);
+            if (!tool) {
+                throw new Error(`Tool not found: ${functionName}`);
+            }
+            return {
+                name: functionName,
+                parameters: parameters,
+                toolCallId: toolCallId,
+            };
+        });
+        const promptTokensUsed = response.usage.prompt_tokens;
+        const completionTokensUsed = response.usage.completion_tokens;
+        return {
+            type: 'proposed_tool_calls',
+            proposedToolCalls: proposedCalls,
+            promptTokensUsed: promptTokensUsed,
+            completionTokensUsed: completionTokensUsed,
+        };
+    }
+    async mapErrorResponseToDonobuException(error) {
+        try {
+            const errorData = await error.json();
+            Logger_1.Logger.appLogger.error(`OpenAI error response: ${JSON.stringify(JsonUtils_1.JsonUtils.objectToJson(errorData))}`);
+            // Handle authentication errors
+            if (errorData.error?.code === 'invalid_api_key') {
+                return new GptPlatformAuthenticationFailedException_1.GptPlatformAuthenticationFailedException(this.config.type);
+            }
+            return new GptPlatformInternalErrorException_1.GptPlatformInternalErrorException(errorData.error?.message || `HTTP ${error.status}: ${error.statusText}`);
+        }
+        catch (_) {
+            Logger_1.Logger.appLogger.error(`Failed to parse ${this.config.type} error response: HTTP ${error.status}: ${error.statusText}`);
+            return new GptPlatformInternalErrorException_1.GptPlatformInternalErrorException(`HTTP ${error.status}: ${error.statusText}`);
+        }
+    }
+    /**
+     * Makes an HTTP request to the OpenAI API with standard configuration.
+     */
+    async makeRequest(endpoint, method = 'GET', body) {
+        try {
+            return await fetch(`${OpenAiGptClient.API_URL}${endpoint}`, {
+                method,
+                headers: this.headers,
+                body: body ? JSON.stringify(body) : undefined,
+                signal: AbortSignal.timeout(OpenAiGptClient.REQUEST_TIMEOUT_MILLISECONDS),
+            });
+        }
+        catch (error) {
+            if (error instanceof TypeError) {
+                throw new GptPlatformNotReachableException_1.GptPlatformNotReachableException(this.config.type);
+            }
+            else {
+                throw error;
+            }
+        }
+    }
+}
+exports.OpenAiGptClient = OpenAiGptClient;
+//# sourceMappingURL=OpenAiGptClient.js.map

package/dist/esm/clients/OpenAiGptClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OpenAiGptClient.js","sourceRoot":"","sources":["../../../src/clients/OpenAiGptClient.ts"],"names":[],"mappings":";;;AAAA,2CAAoD;AACpD,4CAAyC;AACzC,kDAA+C;AAS/C,uFAAoF;AACpF,qHAAkH;AAClH,uGAAoG;AACpG,qGAAkG;AAGlG;;;GAGG;AACH,MAAa,eAAgB,SAAQ,qBAAS;IAWf;IAVrB,MAAM,CAAU,OAAO,GAAG,wBAAwB,CAAC;IACnD,MAAM,CAAU,4BAA4B,GAAG,KAAK,CAAC;IAC5C,OAAO,CAAU;IAElC;;;;;OAKG;IACH,YAA6B,YAA2B;QACtD,KAAK,CAAC,YAAY,CAAC,CAAC;QADO,iBAAY,GAAZ,YAAY,CAAe;QAEtD,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC;YACzB,aAAa,EAAE,UAAU,YAAY,CAAC,MAAM,EAAE;YAC9C,cAAc,EAAE,kBAAkB;SACnC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CACjC,cAAc,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAC5C,CAAC;QAEF,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YACxB,MAAM,IAAI,qDAAyB,CACjC,IAAI,CAAC,MAAM,CAAC,IAAI,EAChB,IAAI,CAAC,YAAY,CAAC,SAAS,CAC5B,CAAC;QACJ,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC/B,MAAM,MAAM,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,QAAsB;QAC5C,MAAM,IAAI,GAAG;YACX,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,SAAS;YAClC,WAAW,EAAE,GAAG;YAChB,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAC7B,IAAI,CAAC,gCAAgC,CAAC,GAAG,CAAC,CAC3C;SACF,CAAC;QACF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,sBAAsB,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAE1E,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YACxB,MAAM,MAAM,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC,CAAC;QAC3D,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,6BAA6B,CACxC,QAAsB,EACtB,UAAuB;QAEvB,MAAM,IAAI,GAAG;YACX,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,SAAS;YAClC,WAAW,EAAE,GAAG;YAChB,eAAe,EAAE;gBACf,IAAI,EAAE,aAAa;gBACnB,WAAW,EAAE;oBACX,IAAI,EAAE,UAAU,CAAC,KAAK,IAAI,QAAQ;oBAClC,MAAM,EAAE,IAAI;oBACZ,MAAM,EAAE,UAAU;iBACnB;aACF;YACD,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAC7B,IAAI,CAAC,gCAAgC,CAAC,GAAG,CAAC,CAC3C;SACF,CAAC;QACF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,sBAAsB,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAE1E,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YACxB,MAAM,MAAM,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC,CAAC;QAC3D,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,YAAY,CACvB,QAAsB,EACtB,KAAmB;QAEnB,MAAM,IAAI,GAAG;YACX,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,SAAS;YAClC,WAAW,EAAE,GAAG;YAChB,WAAW,EAAE,UAAU;YACvB,KAAK,EACH,KAAK,CAAC,MAAM,GAAG,CAAC;gBACd,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;gBACpD,CAAC,CAAC,SAAS;YACf,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAC7B,IAAI,CAAC,gCAAgC,CAAC,GAAG,CAAC,CAC3C;SACF,CAAC;QACF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,sBAAsB,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAE1E,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YACxB,MAAM,MAAM,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC,CAAC;QAC3D,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC,6BAA6B,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAEO,gCAAgC,CACtC,UAAsB;QAEtB,IAAI,UAAU,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YACpC,OAAO;gBACL,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE;aACjD,CAAC;QACJ,CAAC;QAED,IAAI,UAAU,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;YAC5C,OAAO;gBACL,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE;oBACP,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;iBACjD;aACF,CAAC;QACJ,CAAC;QAED,IAAI,UAAU,CAAC,IAAI,KAAK,qBAAqB,EAAE,CAAC;YAC9C,OAAO;gBACL,IAAI,EAAE,WAAW;gBACjB,UAAU,EAAE,UAAU,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;oBACpD,EAAE,EAAE,EAAE,CAAC,UAAU;oBACjB,IAAI,EAAE,UAAU;oBAChB,QAAQ,EAAE;wBACR,IAAI,EAAE,EAAE,CAAC,IAAI;wBACb,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,UAAU,CAAC;qBACzC;iBACF,CAAC,CAAC;aACJ,CAAC;QACJ,CAAC;QAED,IAAI,UAAU,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACjC,OAAO;gBACL,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,UAAU,CAAC,IAAI;aACzB,CAAC;QACJ,CAAC;QAED,IAAI,UAAU,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC/B,OAAO;gBACL,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;oBACrC,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;wBACpB,MAAM;wBACN,OAAO;4BACL,IAAI,EAAE,WAAW;4BACjB,SAAS,EAAE;gCACT,GAAG,EAAE,0BAA0B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;6BAC5E;yBACF,CAAC;oBACJ,CAAC;yBAAM,CAAC;wBACN,OAAO;wBACP,OAAO;4BACL,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,IAAI,CAAC,IAAI;yBAChB,CAAC;oBACJ,CAAC;gBACH,CAAC,CAAC;aACH,CAAC;QACJ,CAAC;QAED,IAAI,UAAU,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;YAC3C,OAAO;gBACL,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,UAAU,CAAC,IAAI;gBACxB,YAAY,EAAE,UAAU,CAAC,UAAU;aACpC,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,KAAK,CACb,6BAA6B,qBAAS,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,CAClE,CAAC;IACJ,CAAC;IAEO,kBAAkB,CAAC,IAAgB;QACzC,OAAO;YACL,IAAI,EAAE,UAAU;YAChB,QAAQ,EAAE;gBACR,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE;gBACpC,UAAU,EAAE,IAAI,CAAC,UAAU;aAC5B;SACF,CAAC;IACJ,CAAC;IAEO,qBAAqB,CAAC,QAAa;QACzC,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;QACjD,MAAM,gBAAgB,GAAG,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC;QACtD,MAAM,oBAAoB,GAAG,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC;QAC9D,OAAO;YACL,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,IAAI;YACV,gBAAgB,EAAE,gBAAgB;YAClC,oBAAoB,EAAE,oBAAoB;SAChB,CAAC;IAC/B,CAAC;IAEO,4BAA4B,CAAC,QAAa;QAChD,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;QACjD,MAAM,MAAM,GAAG,qBAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAEtD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QAED,MAAM,gBAAgB,GAAG,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC;QACtD,MAAM,oBAAoB,GAAG,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC;QAC9D,OAAO;YACL,IAAI,EAAE,mBAAmB;YACzB,MAAM,EAAE,MAAM;YACd,gBAAgB,EAAE,gBAAgB;YAClC,oBAAoB,EAAE,oBAAoB;SACT,CAAC;IACtC,CAAC;IAEO,6BAA6B,CACnC,KAAmB,EACnB,QAAa;QAEb,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;QAEzD,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;QAED,MAAM,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,EAAO,EAAE,EAAE;YAC9C,MAAM,YAAY,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;YACtC,MAAM,UAAU,GAAG,qBAAS,CAAC,sBAAsB,CACjD,EAAE,CAAC,QAAQ,CAAC,SAAS,CACtB,CAAC;YACF,MAAM,UAAU,GAAG,EAAE,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC;YAExD,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,MAAM,IAAI,KAAK,CAAC,mBAAmB,YAAY,EAAE,CAAC,CAAC;YACrD,CAAC;YAED,OAAO;gBACL,IAAI,EAAE,YAAY;gBAClB,UAAU,EAAE,UAAU;gBACtB,UAAU,EAAE,UAAU;aACvB,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,MAAM,gBAAgB,GAAG,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC;QACtD,MAAM,oBAAoB,GAAG,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC;QAC9D,OAAO;YACL,IAAI,EAAE,qBAAqB;YAC3B,iBAAiB,EAAE,aAAa;YAChC,gBAAgB,EAAE,gBAAgB;YAClC,oBAAoB,EAAE,oBAAoB;SACR,CAAC;IACvC,CAAC;IAEO,KAAK,CAAC,iCAAiC,CAC7C,KAAe;QAEf,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;YACrC,eAAM,CAAC,SAAS,CAAC,KAAK,CACpB,0BAA0B,IAAI,CAAC,SAAS,CAAC,qBAAS,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,CAC9E,CAAC;YAEF,+BAA+B;YAC/B,IAAI,SAAS,CAAC,KAAK,EAAE,IAAI,KAAK,iBAAiB,EAAE,CAAC;gBAChD,OAAO,IAAI,mFAAwC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACxE,CAAC;YAED,OAAO,IAAI,qEAAiC,CAC1C,SAAS,CAAC,KAAK,EAAE,OAAO,IAAI,QAAQ,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,UAAU,EAAE,CACxE,CAAC;QACJ,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,eAAM,CAAC,SAAS,CAAC,KAAK,CACpB,mBAAmB,IAAI,CAAC,MAAM,CAAC,IAAI,yBAAyB,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,UAAU,EAAE,CAChG,CAAC;YACF,OAAO,IAAI,qEAAiC,CAC1C,QAAQ,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,UAAU,EAAE,CAC5C,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,WAAW,CACvB,QAAgB,EAChB,SAAyB,KAAK,EAC9B,IAAc;QAEd,IAAI,CAAC;YACH,OAAO,MAAM,KAAK,CAAC,GAAG,eAAe,CAAC,OAAO,GAAG,QAAQ,EAAE,EAAE;gBAC1D,MAAM;gBACN,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;gBAC7C,MAAM,EAAE,WAAW,CAAC,OAAO,CACzB,eAAe,CAAC,4BAA4B,CAC7C;aACF,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,SAAS,EAAE,CAAC;gBAC/B,MAAM,IAAI,mEAAgC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC/D,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;;AA3TH,0CA4TC"}

package/dist/esm/clients/SupabaseClient.d.ts

@@ -0,0 +1,16 @@
+export declare class SupabaseClient {
+    private readonly tokenManager;
+    private readonly supabaseBaseUrl;
+    private readonly supabasePublishableApiKey;
+    private static readonly DEFAULT_SUPABASE_URL;
+    private static readonly DEFAULT_SUPABASE_PUBLISHABLE_API_KEY;
+    private constructor();
+    static createClient(userAccessToken: string, supabaseJwtSecretKey: string): SupabaseClient;
+    static createClientWithConfig(userAccessToken: string, supabaseBaseUrl: string, supabasePublishableApiKey: string, supabaseJwtSecretKey: string): SupabaseClient;
+    /**
+     * Makes a request with automatic token refresh handling.
+     */
+    private makeRequest;
+    executeGet(path: string, headers?: Record<string, string>): Promise<string | null>;
+    executeMethod(path: string, method: string, body?: string): Promise<string | null>;
+}

package/dist/esm/clients/SupabaseClient.js

@@ -0,0 +1,200 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SupabaseClient = void 0;
+const jose_1 = require("jose");
+const Logger_1 = require("../utils/Logger");
+const JsonUtils_1 = require("../utils/JsonUtils");
+/**
+ * A utility class that, given a Supabase service role key, can generate a custom JWT to impersonate
+ * a user.
+ */
+class SupabaseTokenImpersonator {
+    supabasePublishableApiKey;
+    supabaseJwtSecretKey;
+    authApiUrl;
+    /**
+     * Constructs a new SupabaseTokenImpersonator.
+     *
+     * @param supabasePublishableApiKey - This is a non-secret API key to be sent as the `apikey`
+     *     header field when fetching user data.
+     * @param supabaseJwtSecretKey - The Supabase JWT secret key (from your project's API settings).
+     *     This key should be handled with utmost care.
+     * @param supabaseProjectUrl - The Supabase project's base URL, for example:
+     *     "https://<your-project>.supabase.co"
+     */
+    constructor(supabasePublishableApiKey, supabaseJwtSecretKey, supabaseProjectUrl) {
+        this.supabasePublishableApiKey = supabasePublishableApiKey;
+        this.supabaseJwtSecretKey = new TextEncoder().encode(supabaseJwtSecretKey);
+        this.authApiUrl = `${supabaseProjectUrl}/auth/v1/user`;
+    }
+    /**
+     * Creates a custom JWT that impersonates the user identified by the provided access token.
+     *
+     * 1. It verifies the user's token by making a request to /auth/v1/user.
+     * 2. If valid, Supabase returns the user's profile; we extract the user ID from there.
+     * 3. We then return a new custom JWT signed with the service role key.
+     *
+     * @param userAccessToken - The user's existing JWT access token.
+     * @returns A custom JWT signed with the service role key, containing the user's ID as the subject.
+     * @throws Error If the provided userAccessToken is invalid/expired or if there are any issues
+     *     during the process.
+     */
+    async createCustomUserToken(userAccessToken) {
+        // Validate the user's token by calling Supabase.
+        const userId = await this.fetchUserIdFromSupabase(userAccessToken);
+        if (!userId) {
+            throw new Error('Unable to fetch a valid user ID from the provided token.');
+        }
+        const now = Math.floor(Date.now() / 1000);
+        // NOTE: This expiry is coupled with the expiry defined in the
+        // `AccessTokenManager::getValidAccessToken` method.
+        const exp = now + 3600; // 1 hour expiration
+        const jwt = new jose_1.SignJWT({ role: 'authenticated' })
+            .setProtectedHeader({ alg: 'HS256' })
+            .setSubject(userId)
+            .setIssuedAt(now)
+            .setExpirationTime(exp)
+            .setAudience('authenticated')
+            .setIssuer('https://www.donobu.com');
+        return jwt.sign(this.supabaseJwtSecretKey);
+    }
+    /**
+     * Uses the user token in a Bearer header to call Supabase's /auth/v1/user endpoint. If
+     * successful, returns the user's ID from the JSON response.
+     *
+     * @param userAccessToken - The user's JWT to validate.
+     * @returns The user's ID if successful.
+     * @throws Error If the user token is invalid/expired or if there are any issues during the process.
+     */
+    async fetchUserIdFromSupabase(userAccessToken) {
+        try {
+            const response = await fetch(this.authApiUrl, {
+                headers: {
+                    apikey: this.supabasePublishableApiKey,
+                    Authorization: `Bearer ${userAccessToken}`,
+                },
+            });
+            if (!response.ok) {
+                throw new Error(`User token is invalid or expired. HTTP status: ${response.status}`);
+            }
+            const userData = await response.json();
+            if (!userData?.id) {
+                throw new Error("Failed to retrieve 'id' from user details");
+            }
+            return userData.id;
+        }
+        catch (error) {
+            Logger_1.Logger.appLogger.error('Error fetching user ID from Supabase:', error);
+            throw error;
+        }
+    }
+}
+class SupabaseClient {
+    tokenManager;
+    supabaseBaseUrl;
+    supabasePublishableApiKey;
+    static DEFAULT_SUPABASE_URL = 'https://pxxliqamgggjpeltoeus.supabase.co';
+    static DEFAULT_SUPABASE_PUBLISHABLE_API_KEY = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6InB4eGxpcWFtZ2dnanBlbHRvZXVzIiwicm9sZSI6ImFub24iLCJpYXQiOjE3MjUyOTA1MjMsImV4cCI6MjA0MDg2NjUyM30.iQrTLwdzVO1zN7mawZ7hSUnZP-GrVU_vrJR4iACML3A';
+    constructor(tokenManager, supabaseBaseUrl, supabasePublishableApiKey) {
+        this.tokenManager = tokenManager;
+        this.supabaseBaseUrl = supabaseBaseUrl;
+        this.supabasePublishableApiKey = supabasePublishableApiKey;
+    }
+    static createClient(userAccessToken, supabaseJwtSecretKey) {
+        return this.createClientWithConfig(userAccessToken, this.DEFAULT_SUPABASE_URL, this.DEFAULT_SUPABASE_PUBLISHABLE_API_KEY, supabaseJwtSecretKey);
+    }
+    static createClientWithConfig(userAccessToken, supabaseBaseUrl, supabasePublishableApiKey, supabaseJwtSecretKey) {
+        const tokenManager = new AccessTokenManager(userAccessToken, supabaseBaseUrl, supabasePublishableApiKey, supabaseJwtSecretKey);
+        return new SupabaseClient(tokenManager, supabaseBaseUrl, supabasePublishableApiKey);
+    }
+    /**
+     * Makes a request with automatic token refresh handling.
+     */
+    async makeRequest(path, method, customHeaders, body) {
+        const makeRequestWithToken = async (token) => {
+            const headers = new Headers({
+                'Content-Type': 'application/json',
+                Prefer: 'resolution=merge-duplicates',
+                apikey: this.supabasePublishableApiKey,
+                Authorization: `Bearer ${token}`,
+            });
+            // Add custom headers if provided.
+            if (customHeaders) {
+                Object.entries(customHeaders).forEach(([key, value]) => {
+                    headers.append(key, value);
+                });
+            }
+            return fetch(`${this.supabaseBaseUrl}${path}`, {
+                method,
+                headers,
+                body,
+            });
+        };
+        // Initial request.
+        let token = await this.tokenManager.getValidAccessToken();
+        let response = await makeRequestWithToken(token);
+        // Handle 401 with retry.
+        if (response.status === 401) {
+            // Get fresh token and retry once.
+            token = await this.tokenManager.getValidAccessToken();
+            response = await makeRequestWithToken(token);
+        }
+        return response;
+    }
+    async executeGet(path, headers) {
+        try {
+            // Modify makeRequest to accept custom headers
+            const response = await this.makeRequest(path, 'GET', headers);
+            if (response.status === 404) {
+                return null;
+            }
+            if (!response.ok) {
+                throw new Error(`HTTP error! status: ${response.status}`);
+            }
+            return await response.text();
+        }
+        catch (error) {
+            Logger_1.Logger.appLogger.error(`GET request failed: ${JSON.stringify(JsonUtils_1.JsonUtils.objectToJson(error))}`);
+            throw error;
+        }
+    }
+    async executeMethod(path, method, body) {
+        try {
+            const response = await this.makeRequest(path, method, undefined, body);
+            if (!response.ok) {
+                throw new Error(`HTTP error! status: ${response.status}`);
+            }
+            return await response.text();
+        }
+        catch (error) {
+            Logger_1.Logger.appLogger.error(`Request failed: ${error}`);
+            throw error;
+        }
+    }
+}
+exports.SupabaseClient = SupabaseClient;
+class AccessTokenManager {
+    originalUserAccessToken;
+    supabaseBaseUrl;
+    supabasePublishableApiKey;
+    supabaseJwtSecretKey;
+    accessToken = null;
+    accessTokenExpiresAt = new Date(0);
+    constructor(originalUserAccessToken, supabaseBaseUrl, supabasePublishableApiKey, supabaseJwtSecretKey) {
+        this.originalUserAccessToken = originalUserAccessToken;
+        this.supabaseBaseUrl = supabaseBaseUrl;
+        this.supabasePublishableApiKey = supabasePublishableApiKey;
+        this.supabaseJwtSecretKey = supabaseJwtSecretKey;
+    }
+    async getValidAccessToken() {
+        if (this.accessToken && new Date() < this.accessTokenExpiresAt) {
+            return this.accessToken;
+        }
+        const tokenImpersonator = new SupabaseTokenImpersonator(this.supabasePublishableApiKey, this.supabaseJwtSecretKey, this.supabaseBaseUrl);
+        this.accessTokenExpiresAt = new Date(Date.now() + 60 * 60 * 1000); // 1 hour from now
+        const tmp = await tokenImpersonator.createCustomUserToken(this.originalUserAccessToken);
+        this.accessToken = tmp;
+        return tmp;
+    }
+}
+//# sourceMappingURL=SupabaseClient.js.map

package/dist/esm/clients/SupabaseClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SupabaseClient.js","sourceRoot":"","sources":["../../../src/clients/SupabaseClient.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAC/B,4CAAyC;AACzC,kDAA+C;AAE/C;;;GAGG;AACH,MAAM,yBAAyB;IAeV;IAdF,oBAAoB,CAAa;IACjC,UAAU,CAAS;IAEpC;;;;;;;;;OASG;IACH,YACmB,yBAAiC,EAClD,oBAA4B,EAC5B,kBAA0B;QAFT,8BAAyB,GAAzB,yBAAyB,CAAQ;QAIlD,IAAI,CAAC,oBAAoB,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;QAC3E,IAAI,CAAC,UAAU,GAAG,GAAG,kBAAkB,eAAe,CAAC;IACzD,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,qBAAqB,CAAC,eAAuB;QACxD,iDAAiD;QACjD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,eAAe,CAAC,CAAC;QAEnE,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAC;QACJ,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QAC1C,8DAA8D;QAC9D,oDAAoD;QACpD,MAAM,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC,oBAAoB;QAC5C,MAAM,GAAG,GAAG,IAAI,cAAO,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;aAC/C,kBAAkB,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC;aACpC,UAAU,CAAC,MAAM,CAAC;aAClB,WAAW,CAAC,GAAG,CAAC;aAChB,iBAAiB,CAAC,GAAG,CAAC;aACtB,WAAW,CAAC,eAAe,CAAC;aAC5B,SAAS,CAAC,wBAAwB,CAAC,CAAC;QACvC,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;OAOG;IACK,KAAK,CAAC,uBAAuB,CACnC,eAAuB;QAEvB,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE;gBAC5C,OAAO,EAAE;oBACP,MAAM,EAAE,IAAI,CAAC,yBAAyB;oBACtC,aAAa,EAAE,UAAU,eAAe,EAAE;iBAC3C;aACF,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CACb,kDAAkD,QAAQ,CAAC,MAAM,EAAE,CACpE,CAAC;YACJ,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAEvC,IAAI,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;YAC/D,CAAC;YAED,OAAO,QAAQ,CAAC,EAAE,CAAC;QACrB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,eAAM,CAAC,SAAS,CAAC,KAAK,CAAC,uCAAuC,EAAE,KAAK,CAAC,CAAC;YACvE,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;CACF;AAED,MAAa,cAAc;IAON;IACA;IACA;IARX,MAAM,CAAU,oBAAoB,GAC1C,0CAA0C,CAAC;IACrC,MAAM,CAAU,oCAAoC,GAC1D,kNAAkN,CAAC;IAErN,YACmB,YAAgC,EAChC,eAAuB,EACvB,yBAAiC;QAFjC,iBAAY,GAAZ,YAAY,CAAoB;QAChC,oBAAe,GAAf,eAAe,CAAQ;QACvB,8BAAyB,GAAzB,yBAAyB,CAAQ;IACjD,CAAC;IAEG,MAAM,CAAC,YAAY,CACxB,eAAuB,EACvB,oBAA4B;QAE5B,OAAO,IAAI,CAAC,sBAAsB,CAChC,eAAe,EACf,IAAI,CAAC,oBAAoB,EACzB,IAAI,CAAC,oCAAoC,EACzC,oBAAoB,CACrB,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,sBAAsB,CAClC,eAAuB,EACvB,eAAuB,EACvB,yBAAiC,EACjC,oBAA4B;QAE5B,MAAM,YAAY,GAAG,IAAI,kBAAkB,CACzC,eAAe,EACf,eAAe,EACf,yBAAyB,EACzB,oBAAoB,CACrB,CAAC;QAEF,OAAO,IAAI,cAAc,CACvB,YAAY,EACZ,eAAe,EACf,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,WAAW,CACvB,IAAY,EACZ,MAAc,EACd,aAAsC,EACtC,IAAa;QAEb,MAAM,oBAAoB,GAAG,KAAK,EAAE,KAAa,EAAqB,EAAE;YACtE,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC;gBAC1B,cAAc,EAAE,kBAAkB;gBAClC,MAAM,EAAE,6BAA6B;gBACrC,MAAM,EAAE,IAAI,CAAC,yBAAyB;gBACtC,aAAa,EAAE,UAAU,KAAK,EAAE;aACjC,CAAC,CAAC;YAEH,kCAAkC;YAClC,IAAI,aAAa,EAAE,CAAC;gBAClB,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;oBACrD,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAC7B,CAAC,CAAC,CAAC;YACL,CAAC;YAED,OAAO,KAAK,CAAC,GAAG,IAAI,CAAC,eAAe,GAAG,IAAI,EAAE,EAAE;gBAC7C,MAAM;gBACN,OAAO;gBACP,IAAI;aACL,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,mBAAmB;QACnB,IAAI,KAAK,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,mBAAmB,EAAE,CAAC;QAC1D,IAAI,QAAQ,GAAG,MAAM,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAEjD,yBAAyB;QACzB,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,kCAAkC;YAClC,KAAK,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,mBAAmB,EAAE,CAAC;YACtD,QAAQ,GAAG,MAAM,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,UAAU,CACrB,IAAY,EACZ,OAAgC;QAEhC,IAAI,CAAC;YACH,8CAA8C;YAC9C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;YAE9D,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC5B,OAAO,IAAI,CAAC;YACd,CAAC;YAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,uBAAuB,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YAC5D,CAAC;YAED,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC/B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,eAAM,CAAC,SAAS,CAAC,KAAK,CACpB,uBAAuB,IAAI,CAAC,SAAS,CAAC,qBAAS,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,CACvE,CAAC;YACF,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,aAAa,CACxB,IAAY,EACZ,MAAc,EACd,IAAa;QAEb,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YAEvE,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,uBAAuB,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YAC5D,CAAC;YAED,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC/B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,eAAM,CAAC,SAAS,CAAC,KAAK,CAAC,mBAAmB,KAAK,EAAE,CAAC,CAAC;YACnD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;;AAnIH,wCAoIC;AAED,MAAM,kBAAkB;IAKH;IACA;IACA;IACA;IAPX,WAAW,GAAkB,IAAI,CAAC;IAClC,oBAAoB,GAAS,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;IAEjD,YACmB,uBAA+B,EAC/B,eAAuB,EACvB,yBAAiC,EACjC,oBAA4B;QAH5B,4BAAuB,GAAvB,uBAAuB,CAAQ;QAC/B,oBAAe,GAAf,eAAe,CAAQ;QACvB,8BAAyB,GAAzB,yBAAyB,CAAQ;QACjC,yBAAoB,GAApB,oBAAoB,CAAQ;IAC5C,CAAC;IAEG,KAAK,CAAC,mBAAmB;QAC9B,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,IAAI,EAAE,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC/D,OAAO,IAAI,CAAC,WAAW,CAAC;QAC1B,CAAC;QAED,MAAM,iBAAiB,GAAG,IAAI,yBAAyB,CACrD,IAAI,CAAC,yBAAyB,EAC9B,IAAI,CAAC,oBAAoB,EACzB,IAAI,CAAC,eAAe,CACrB,CAAC;QAEF,IAAI,CAAC,oBAAoB,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,kBAAkB;QACrF,MAAM,GAAG,GAAG,MAAM,iBAAiB,CAAC,qBAAqB,CACvD,IAAI,CAAC,uBAAuB,CAC7B,CAAC;QACF,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;QACvB,OAAO,GAAG,CAAC;IACb,CAAC;CACF"}

package/dist/esm/donobu.fixtures.d.ts

@@ -0,0 +1,57 @@
+import type { Page } from '@playwright/test';
+import { DonobuFlowsManager } from './managers/DonobuFlowsManager';
+import { FlowsPersistenceFactory } from './managers/FlowsPersistenceFactory';
+import { ToolManager } from './managers/ToolManager';
+import { GptPlatformApiKeysManagerFilesystem } from './managers/GptPlatformApiKeysManagerFilesystem';
+import { FlowMetadata, Platform } from './models/FlowMetadata';
+import { BrowserStorageState } from './models/BrowserState';
+import { FlowsPersistence } from './managers/FlowsPersistence';
+import { DonobuDeploymentEnvironment } from './models/DonobuDeploymentEnvironment';
+import { BrowserStateFlowReference } from './models/BrowserStateFlowReference';
+import { ToolCallResult } from './models/ToolCallResult';
+import { AnalyzePageTextToolCoreParameters } from './tools/AnalyzePageTextTool';
+import { AssertToolCoreParameters } from './tools/AssertTool';
+import { GptClient } from './clients/GptClient';
+import { SelectorBasedClickButtonToolParameters } from './tools/ChooseSelectOptionTool';
+import { InputRandomizedEmailAddressToolCoreParameters } from './tools/InputRandomizedEmailAddressTool';
+import { SelectorBasedInputTextToolParameters } from './tools/InputTextTool';
+import { SelectorBasedPressKeyToolParameters } from './tools/PressKeyTool';
+import { ScrollPageToolCoreParameters } from './tools/ScrollPageTool';
+import { SelectorBasedHoverOverElementToolParameters } from './tools/HoverOverElementTool';
+/**
+ * Extends the Page object with additional test-related methods.
+ */
+interface DonobuExtendedPage extends Page {
+    run(toolName: string, toolParams?: any): Promise<ToolCallResult>;
+    analyzePageText(params: AnalyzePageTextToolCoreParameters): Promise<ToolCallResult>;
+    chooseSelectOption(params: SelectorBasedClickButtonToolParameters): Promise<ToolCallResult>;
+    clickElement(params: SelectorBasedClickButtonToolParameters): Promise<ToolCallResult>;
+    createCookieReport(): Promise<ToolCallResult>;
+    detectBrokenLinks(): Promise<ToolCallResult>;
+    hoverOverElement(params: SelectorBasedHoverOverElementToolParameters): Promise<ToolCallResult>;
+    inputRandomizedEmailAddress(params: InputRandomizedEmailAddressToolCoreParameters): Promise<ToolCallResult>;
+    inputText(params: SelectorBasedInputTextToolParameters): Promise<ToolCallResult>;
+    pressKey(params: SelectorBasedPressKeyToolParameters): Promise<ToolCallResult>;
+    runAccessibilityTest(): Promise<ToolCallResult>;
+    scroll(params: ScrollPageToolCoreParameters): Promise<ToolCallResult>;
+    visuallyAssert(params: AssertToolCoreParameters): Promise<ToolCallResult>;
+    _donobu: DonobuParams;
+    _donobuFlowMetadata: FlowMetadata;
+    _gptClient: GptClient | null;
+}
+type DonobuParams = {
+    workingDir: string;
+    donobuVersion: string;
+    deploymentEnvironment: DonobuDeploymentEnvironment;
+    gptPlatformApiKeysManager: GptPlatformApiKeysManagerFilesystem;
+    enabledGptPlatforms: Platform[];
+    flowsPersistenceFactory: FlowsPersistenceFactory;
+    toolManager: ToolManager;
+    flowsManager: DonobuFlowsManager;
+    persistenceLayer: FlowsPersistence;
+};
+export declare function getBrowserStorageState(flowIdOrName: BrowserStateFlowReference): Promise<BrowserStorageState>;
+export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & {
+    page: DonobuExtendedPage;
+}, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
+export {};