@runtypelabs/sdk 0.1.1

package/dist/flow-result.d.ts

@@ -0,0 +1,117 @@
+/**
+ * FlowResult - Wrapper for streaming flow execution responses
+ *
+ * Provides convenient methods for processing streaming responses
+ * from the Runtype API dispatch endpoint.
+ */
+import type { StreamCallbacks, FlowSummary } from './flow-builder';
+/**
+ * Result wrapper for flow execution
+ *
+ * Provides multiple ways to consume the streaming response:
+ * - `.stream(callbacks)` - Process with callbacks
+ * - `.getResult(stepName)` - Get result from a specific step
+ * - `.getAllResults()` - Get all step results
+ * - `.raw` - Access the raw Response for manual handling
+ *
+ * @example
+ * ```typescript
+ * const result = await flow.run(apiClient, options)
+ *
+ * // Option 1: Process with callbacks
+ * const summary = await result.stream({
+ *   onStepChunk: (chunk) => process.stdout.write(chunk),
+ * })
+ *
+ * // Option 2: Just get a specific step's result
+ * const analysis = await result.getResult('Analyze Data')
+ *
+ * // Option 3: Get all results
+ * const allResults = await result.getAllResults()
+ * ```
+ */
+export declare class FlowResult {
+    private response;
+    private consumed;
+    private cachedSummary;
+    constructor(response: Response, summary?: FlowSummary);
+    /**
+     * Get the raw Response object for manual handling
+     *
+     * Note: The response body can only be consumed once.
+     * Using this will prevent using other methods like stream() or getResult().
+     */
+    get raw(): Response;
+    /**
+     * Check if the response has already been consumed
+     */
+    get isConsumed(): boolean;
+    /**
+     * Process the streaming response with callbacks
+     *
+     * @param callbacks - Callbacks for different event types
+     * @returns Promise resolving to FlowSummary when complete
+     *
+     * @example
+     * ```typescript
+     * const summary = await result.stream({
+     *   onStepStart: (event) => console.log('Starting:', event.name),
+     *   onStepChunk: (chunk) => process.stdout.write(chunk),
+     *   onStepComplete: (result, event) => console.log('Done:', event.name),
+     *   onFlowComplete: (event) => console.log('Flow complete!'),
+     * })
+     * ```
+     */
+    stream(callbacks?: StreamCallbacks): Promise<FlowSummary>;
+    /**
+     * Get the result from a specific step by its name
+     *
+     * Matches against the `name` property you set when creating the step.
+     * - **Case-sensitive**: `'Analyze'` ≠ `'analyze'`
+     * - **Exact match only**: no partial or fuzzy matching
+     * - Returns `undefined` if no step with that name is found
+     *
+     * @param stepName - The exact step name (from the `name` property when creating the step)
+     * @returns The step's result, or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * // When building:
+     * .prompt({ name: 'Analyze Screenshot', model: 'gpt-4', ... })
+     *
+     * // When retrieving (must match exactly):
+     * const analysis = await result.getResult('Analyze Screenshot')  // ✓ Works
+     * const analysis = await result.getResult('analyze screenshot')  // ✗ undefined
+     * ```
+     */
+    getResult(stepName: string): Promise<any>;
+    /**
+     * Get all step results as a Map
+     *
+     * @returns Map of step name to result
+     *
+     * @example
+     * ```typescript
+     * const allResults = await result.getAllResults()
+     * for (const [stepName, result] of allResults) {
+     *   console.log(stepName, result)
+     * }
+     * ```
+     */
+    getAllResults(): Promise<Map<string, any>>;
+    /**
+     * Get the flow summary after processing
+     *
+     * @returns FlowSummary with execution details
+     */
+    getSummary(): Promise<FlowSummary>;
+    /**
+     * Ensure the stream has been processed and return the summary
+     */
+    private ensureSummary;
+    /**
+     * Ensure the response hasn't been consumed yet
+     */
+    private ensureNotConsumed;
+}
+//# sourceMappingURL=flow-result.d.ts.map

package/dist/flow-result.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow-result.d.ts","sourceRoot":"","sources":["../src/flow-result.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAGlE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAU;IAC1B,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,aAAa,CAA2B;gBAEpC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,WAAW;IAQrD;;;;;OAKG;IACH,IAAI,GAAG,IAAI,QAAQ,CAElB;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;;;;;;;;;;;;;;OAeG;IACG,MAAM,CAAC,SAAS,GAAE,eAAoB,GAAG,OAAO,CAAC,WAAW,CAAC;IAyBnE;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAW/C;;;;;;;;;;;;OAYG;IACG,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAKhD;;;;OAIG;IACG,UAAU,IAAI,OAAO,CAAC,WAAW,CAAC;IAIxC;;OAEG;YACW,aAAa;IAS3B;;OAEG;IACH,OAAO,CAAC,iBAAiB;CAS1B"}

package/dist/flow-result.js

@@ -0,0 +1,175 @@
+"use strict";
+/**
+ * FlowResult - Wrapper for streaming flow execution responses
+ *
+ * Provides convenient methods for processing streaming responses
+ * from the Runtype API dispatch endpoint.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlowResult = void 0;
+const stream_utils_1 = require("./stream-utils");
+/**
+ * Result wrapper for flow execution
+ *
+ * Provides multiple ways to consume the streaming response:
+ * - `.stream(callbacks)` - Process with callbacks
+ * - `.getResult(stepName)` - Get result from a specific step
+ * - `.getAllResults()` - Get all step results
+ * - `.raw` - Access the raw Response for manual handling
+ *
+ * @example
+ * ```typescript
+ * const result = await flow.run(apiClient, options)
+ *
+ * // Option 1: Process with callbacks
+ * const summary = await result.stream({
+ *   onStepChunk: (chunk) => process.stdout.write(chunk),
+ * })
+ *
+ * // Option 2: Just get a specific step's result
+ * const analysis = await result.getResult('Analyze Data')
+ *
+ * // Option 3: Get all results
+ * const allResults = await result.getAllResults()
+ * ```
+ */
+class FlowResult {
+    constructor(response, summary) {
+        this.consumed = false;
+        this.cachedSummary = null;
+        this.response = response;
+        if (summary) {
+            this.cachedSummary = summary;
+            this.consumed = true;
+        }
+    }
+    /**
+     * Get the raw Response object for manual handling
+     *
+     * Note: The response body can only be consumed once.
+     * Using this will prevent using other methods like stream() or getResult().
+     */
+    get raw() {
+        return this.response;
+    }
+    /**
+     * Check if the response has already been consumed
+     */
+    get isConsumed() {
+        return this.consumed;
+    }
+    /**
+     * Process the streaming response with callbacks
+     *
+     * @param callbacks - Callbacks for different event types
+     * @returns Promise resolving to FlowSummary when complete
+     *
+     * @example
+     * ```typescript
+     * const summary = await result.stream({
+     *   onStepStart: (event) => console.log('Starting:', event.name),
+     *   onStepChunk: (chunk) => process.stdout.write(chunk),
+     *   onStepComplete: (result, event) => console.log('Done:', event.name),
+     *   onFlowComplete: (event) => console.log('Flow complete!'),
+     * })
+     * ```
+     */
+    async stream(callbacks = {}) {
+        if (this.consumed && this.cachedSummary) {
+            // Replay events from cached summary if available? 
+            // For now, just return the summary immediately as we can't replay the stream.
+            // Callbacks for completion might be relevant though.
+            if (callbacks.onFlowComplete) {
+                callbacks.onFlowComplete({
+                    type: 'flow_complete',
+                    flowId: this.cachedSummary.flowId,
+                    totalSteps: this.cachedSummary.totalSteps,
+                    successfulSteps: this.cachedSummary.successfulSteps,
+                    failedSteps: this.cachedSummary.failedSteps,
+                    executionTime: this.cachedSummary.executionTime
+                });
+            }
+            return this.cachedSummary;
+        }
+        this.ensureNotConsumed();
+        this.consumed = true;
+        this.cachedSummary = await (0, stream_utils_1.processStream)(this.response, callbacks);
+        return this.cachedSummary;
+    }
+    /**
+     * Get the result from a specific step by its name
+     *
+     * Matches against the `name` property you set when creating the step.
+     * - **Case-sensitive**: `'Analyze'` ≠ `'analyze'`
+     * - **Exact match only**: no partial or fuzzy matching
+     * - Returns `undefined` if no step with that name is found
+     *
+     * @param stepName - The exact step name (from the `name` property when creating the step)
+     * @returns The step's result, or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * // When building:
+     * .prompt({ name: 'Analyze Screenshot', model: 'gpt-4', ... })
+     *
+     * // When retrieving (must match exactly):
+     * const analysis = await result.getResult('Analyze Screenshot')  // ✓ Works
+     * const analysis = await result.getResult('analyze screenshot')  // ✗ undefined
+     * ```
+     */
+    async getResult(stepName) {
+        const summary = await this.ensureSummary();
+        // Exact name match only
+        if (summary.results.has(stepName)) {
+            return summary.results.get(stepName);
+        }
+        return undefined;
+    }
+    /**
+     * Get all step results as a Map
+     *
+     * @returns Map of step name to result
+     *
+     * @example
+     * ```typescript
+     * const allResults = await result.getAllResults()
+     * for (const [stepName, result] of allResults) {
+     *   console.log(stepName, result)
+     * }
+     * ```
+     */
+    async getAllResults() {
+        const summary = await this.ensureSummary();
+        return summary.results;
+    }
+    /**
+     * Get the flow summary after processing
+     *
+     * @returns FlowSummary with execution details
+     */
+    async getSummary() {
+        return this.ensureSummary();
+    }
+    /**
+     * Ensure the stream has been processed and return the summary
+     */
+    async ensureSummary() {
+        if (this.cachedSummary) {
+            return this.cachedSummary;
+        }
+        // Process the stream silently to get results
+        return this.stream({});
+    }
+    /**
+     * Ensure the response hasn't been consumed yet
+     */
+    ensureNotConsumed() {
+        if (this.consumed) {
+            throw new Error('Response has already been consumed. ' +
+                'The streaming response body can only be read once. ' +
+                'Use the cached results from stream(), getResult(), or getAllResults() instead.');
+        }
+    }
+}
+exports.FlowResult = FlowResult;
+//# sourceMappingURL=flow-result.js.map

package/dist/flow-result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow-result.js","sourceRoot":"","sources":["../src/flow-result.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAGH,iDAA8C;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAa,UAAU;IAKrB,YAAY,QAAkB,EAAE,OAAqB;QAH7C,aAAQ,GAAG,KAAK,CAAA;QAChB,kBAAa,GAAuB,IAAI,CAAA;QAG9C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,aAAa,GAAG,OAAO,CAAA;YAC5B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;QACtB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,MAAM,CAAC,YAA6B,EAAE;QAC1C,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACxC,mDAAmD;YACnD,8EAA8E;YAC9E,qDAAqD;YACrD,IAAI,SAAS,CAAC,cAAc,EAAE,CAAC;gBAC5B,SAAS,CAAC,cAAc,CAAC;oBACrB,IAAI,EAAE,eAAe;oBACrB,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM;oBACjC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,UAAU;oBACzC,eAAe,EAAE,IAAI,CAAC,aAAa,CAAC,eAAe;oBACnD,WAAW,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW;oBAC3C,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,aAAa;iBAClD,CAAC,CAAA;YACL,CAAC;YACD,OAAO,IAAI,CAAC,aAAa,CAAA;QAC3B,CAAC;QAED,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;QAEpB,IAAI,CAAC,aAAa,GAAG,MAAM,IAAA,4BAAa,EAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;QAClE,OAAO,IAAI,CAAC,aAAa,CAAA;IAC3B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,SAAS,CAAC,QAAgB;QAC9B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QAE1C,wBAAwB;QACxB,IAAI,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAClC,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACtC,CAAC;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,aAAa;QACjB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QAC1C,OAAO,OAAO,CAAC,OAAO,CAAA;IACxB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU;QACd,OAAO,IAAI,CAAC,aAAa,EAAE,CAAA;IAC7B,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,aAAa;QACzB,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,OAAO,IAAI,CAAC,aAAa,CAAA;QAC3B,CAAC;QAED,6CAA6C;QAC7C,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IACxB,CAAC;IAED;;OAEG;IACK,iBAAiB;QACvB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CACb,sCAAsC;gBACtC,qDAAqD;gBACrD,gFAAgF,CACjF,CAAA;QACH,CAAC;IACH,CAAC;CACF;AA1JD,gCA0JC"}