donobu 2.23.0 → 2.23.1

package/dist/esm/persistence/FlowsPersistence.d.ts

@@ -1,104 +0,0 @@
-import { BrowserStorageState } from '../models/BrowserStorageState';
-import { FlowMetadata, FlowsQuery } from '../models/FlowMetadata';
-import { PaginatedResult } from '../models/PaginatedResult';
-import { ToolCall } from '../models/ToolCall';
-import { VideoSegment } from '../models/VideoSegment';
-/**
- * Interface for persisting data relating to DonobuFlow runs.
- */
-export interface FlowsPersistence {
-    /**
-     * Set a piece of environment data that is available across all flows.
-     */
-    setEnvironmentDatum(key: string, value: string): Promise<void>;
-    /**
-     * Delete a piece of environment data by its key.
-     * No-op if the data does not exist.
-     */
-    deleteEnvironmentDatum(key: string): Promise<void>;
-    /**
-     * Retrieve a piece of environment data by its key.
-     */
-    getEnvironmentDatum(key: string): Promise<string | undefined>;
-    /**
-     * Get all environment data.
-     */
-    getEnvironmentData(): Promise<Record<string, string>>;
-    /**
-     * Set the given FlowMetadata for the associated flow. It can be looked up by
-     * its {@link FlowMetadata.id}.
-     */
-    setMetadata(flowMetadata: FlowMetadata): Promise<void>;
-    /**
-     * Load metadata for a specific flow.
-     * @throws FlowNotFoundException if the flow is not found
-     */
-    getMetadataByFlowId(flowId: string): Promise<FlowMetadata>;
-    /**
-     * Load metadata by a given flow name.
-     * @throws FlowNotFoundException if the flow is not found
-     */
-    getMetadataByFlowName(flowName: string): Promise<FlowMetadata>;
-    /**
-     * Save a screenshot for a specific flow. Supports PNG and JPEG images.
-     * @returns The identifier for the saved screenshot
-     */
-    saveScreenShot(flowId: string, bytes: Buffer): Promise<string>;
-    /**
-     * Loads a screenshot. The returned image may be in PNG or a JPEG format.
-     */
-    getScreenShot(flowId: string, screenShotId: string): Promise<Buffer | null>;
-    /**
-     * Save a tool call for a specific flow.
-     */
-    saveToolCall(flowId: string, toolCall: ToolCall): Promise<void>;
-    /**
-     * Load all tool calls for a specific flow.
-     * @throws FlowNotFoundException if the flow is not found
-     */
-    getToolCalls(flowId: string): Promise<ToolCall[]>;
-    /**
-     * Get flows matching a given query.
-     */
-    getFlows(query: FlowsQuery): Promise<PaginatedResult<FlowMetadata>>;
-    /**
-     * Set video data for a specific flow.
-     */
-    setVideo(flowId: string, bytes: Buffer): Promise<void>;
-    /**
-     * Get a video segment for a specific flow.
-     * @throws FlowNotFoundException if the flow is not found
-     */
-    getVideoSegment(flowId: string, startOffset: number, length: number): Promise<VideoSegment | null>;
-    /**
-     * Get a file associated with a specific flow.
-     *
-     * @throws FlowNotFoundException if the flow is not found.
-     */
-    getFlowFile(flowId: string, fileId: string): Promise<Buffer | null>;
-    /**
-     * Set a file for a specific flow.
-     */
-    setFlowFile(flowId: string, fileId: string, fileBytes: Buffer): Promise<void>;
-    /**
-     * Sets the given browser state for a specific flow.
-     *
-     * WARNING: This will NOT override the runtime browser state for a flow that
-     * is currently running. This is only for persisting the browser state for a
-     * flow that has completed so that it can be used by other flows in the
-     * future.
-     */
-    setBrowserState(flowId: string, browserState: BrowserStorageState): Promise<void>;
-    /**
-     * Get the browser state for a specific flow. Note that not all flows will
-     * have an associated persisted browser state.
-     *
-     * @throws FlowNotFoundException if the flow is not found.
-     */
-    getBrowserState(flowId: string): Promise<BrowserStorageState | null>;
-    /**
-     * Delete a specific flow and all associated data.
-     */
-    deleteFlow(flowId: string): Promise<void>;
-}
-//# sourceMappingURL=FlowsPersistence.d.ts.map

package/dist/esm/persistence/FlowsPersistence.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FlowsPersistence.d.ts","sourceRoot":"","sources":["../../../src/persistence/FlowsPersistence.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/D;;;OAGG;IACH,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD;;OAEG;IACH,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAE9D;;OAEG;IACH,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEtD;;;OAGG;IACH,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvD;;;OAGG;IACH,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAE3D;;;OAGG;IACH,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAE/D;;;OAGG;IACH,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE/D;;OAEG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE5E;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhE;;;OAGG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAElD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC;IAEpE;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvD;;;OAGG;IACH,eAAe,CACb,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IAEhC;;;;OAIG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAEpE;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9E;;;;;;;OAOG;IACH,eAAe,CACb,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,mBAAmB,GAChC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;OAKG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAAC;IAErE;;OAEG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3C"}

package/dist/esm/persistence/FlowsPersistence.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=FlowsPersistence.js.map

package/dist/esm/persistence/FlowsPersistence.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FlowsPersistence.js","sourceRoot":"","sources":["../../../src/persistence/FlowsPersistence.ts"],"names":[],"mappings":""}

package/dist/esm/persistence/FlowsPersistenceAwsS3.d.ts

@@ -1,75 +0,0 @@
-import { FlowsPersistence } from './FlowsPersistence';
-import { FlowMetadata, FlowsQuery } from '../models/FlowMetadata';
-import { ToolCall } from '../models/ToolCall';
-import { VideoSegment } from '../models/VideoSegment';
-import { BrowserStorageState } from '../models/BrowserStorageState';
-import { PaginatedResult } from '../models/PaginatedResult';
-/**
- * A persistence implementation that uses AWS S3.
- * Ensure AWS credentials are properly configured in your environment,
- * or provide them directly in the constructor.
- */
-export declare class FlowsPersistenceAwsS3 implements FlowsPersistence {
-    private static readonly ENVIRONMENT_DATA_PREFIX;
-    private static readonly NAME_INDEX_PREFIX;
-    private static readonly RUN_MODE_INDEX_PREFIX;
-    private static readonly STATE_INDEX_PREFIX;
-    private static readonly RUN_MODE_STATE_INDEX_PREFIX;
-    private static readonly METADATA_FILENAME;
-    private static readonly BROWSER_STATE_FILENAME;
-    private static readonly TOOL_CALL_FILENAME_SUFFIX;
-    private static readonly VIDEO_FILENAME;
-    private readonly s3Client;
-    private readonly bucketName;
-    /**
-     * Creates a new instance of the AWS S3 persistence layer.
-     *
-     * @param bucketName The name of the S3 bucket to use for storage
-     * @param region AWS region (defaults to 'us-east-1')
-     * @param credentials Optional AWS credentials (if not provided, will use environment variables)
-     */
-    constructor(bucketName: string, region: string, credentials?: {
-        accessKeyId: string;
-        secretAccessKey: string;
-    });
-    setEnvironmentDatum(key: string, value: string): Promise<void>;
-    deleteEnvironmentDatum(key: string): Promise<void>;
-    getEnvironmentDatum(key: string): Promise<string | undefined>;
-    getEnvironmentData(): Promise<Record<string, string>>;
-    setMetadata(flowMetadata: FlowMetadata): Promise<void>;
-    getMetadataByFlowId(flowId: string): Promise<FlowMetadata>;
-    getMetadataByFlowName(flowName: string): Promise<FlowMetadata>;
-    saveScreenShot(flowId: string, bytes: Buffer): Promise<string>;
-    getScreenShot(flowId: string, screenShotId: string): Promise<Buffer | null>;
-    saveToolCall(flowId: string, toolCall: ToolCall): Promise<void>;
-    getToolCalls(flowId: string): Promise<ToolCall[]>;
-    getFlows(query: FlowsQuery): Promise<PaginatedResult<FlowMetadata>>;
-    setVideo(flowId: string, bytes: Buffer): Promise<void>;
-    getVideoSegment(flowId: string, startOffset: number, length: number): Promise<VideoSegment | null>;
-    getFlowFile(flowId: string, fileId: string): Promise<Buffer | null>;
-    setFlowFile(flowId: string, fileId: string, fileBytes: Buffer): Promise<void>;
-    setBrowserState(flowId: string, browserState: BrowserStorageState): Promise<void>;
-    getBrowserState(flowId: string): Promise<BrowserStorageState | null>;
-    deleteFlow(flowId: string): Promise<void>;
-    /**
-     * Utility method to stream S3 object data to a Buffer
-     */
-    private streamToBuffer;
-    /**
-     * Update name-to-id index.
-     */
-    private updateNameIndex;
-    /**
-     * Update runMode-to-id index.
-     */
-    private updateRunModeIndex;
-    /**
-     * Update state-to-id index.
-     */
-    private updateStateIndex;
-    /**
-     * Update combined runMode+state-to-id index.
-     */
-    private updateRunModeStateIndex;
-}
-//# sourceMappingURL=FlowsPersistenceAwsS3.d.ts.map

package/dist/esm/persistence/FlowsPersistenceAwsS3.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FlowsPersistenceAwsS3.d.ts","sourceRoot":"","sources":["../../../src/persistence/FlowsPersistenceAwsS3.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAGtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAIpE,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE5D;;;;GAIG;AACH,qBAAa,qBAAsB,YAAW,gBAAgB;IAC5D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,uBAAuB,CAAkB;IACjE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAkB;IAC3D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CAAsB;IACnE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAmB;IAC7D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,2BAA2B,CACxB;IAC3B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAmB;IAC5D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,sBAAsB,CAAuB;IACrE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,yBAAyB,CAAqB;IACtE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAgB;IAEtD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IACpC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IAEpC;;;;;;OAMG;gBAED,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,WAAW,CAAC,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,CAAA;KAAE;IASnD,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB9D,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBlD,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAqB7D,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAmDrD,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAgCtD,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAiB1D,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IA0B9D,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB9D,aAAa,CACxB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAqBZ,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAc/D,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IA8CjD,QAAQ,CACnB,KAAK,EAAE,UAAU,GAChB,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;IAiK5B,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAatD,eAAe,CAC1B,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAwClB,WAAW,CACtB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAgBZ,WAAW,CACtB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC;IAaV,eAAe,CACnB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,mBAAmB,GAChC,OAAO,CAAC,IAAI,CAAC;IAaV,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;IAuB7D,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAyCtD;;OAEG;YACW,cAAc;IAS5B;;OAEG;YACW,eAAe;IAgB7B;;OAEG;YACW,kBAAkB;IAgBhC;;OAEG;YACW,gBAAgB;IAa9B;;OAEG;YACW,uBAAuB;CAgBtC"}