@cadenya/cadenya 0.96.0 → 0.98.0

package/src/internal/decoders/line.ts

@@ -0,0 +1,135 @@
+import { concatBytes, decodeUTF8, encodeUTF8 } from '../utils/bytes';
+
+export type Bytes = string | ArrayBuffer | Uint8Array | null | undefined;
+
+/**
+ * A re-implementation of httpx's `LineDecoder` in Python that handles incrementally
+ * reading lines from text.
+ *
+ * https://github.com/encode/httpx/blob/920333ea98118e9cf617f246905d7b202510941c/httpx/_decoders.py#L258
+ */
+export class LineDecoder {
+  // prettier-ignore
+  static NEWLINE_CHARS = new Set(['\n', '\r']);
+  static NEWLINE_REGEXP = /\r\n|[\n\r]/g;
+
+  #buffer: Uint8Array;
+  #carriageReturnIndex: number | null;
+
+  constructor() {
+    this.#buffer = new Uint8Array();
+    this.#carriageReturnIndex = null;
+  }
+
+  decode(chunk: Bytes): string[] {
+    if (chunk == null) {
+      return [];
+    }
+
+    const binaryChunk =
+      chunk instanceof ArrayBuffer ? new Uint8Array(chunk)
+      : typeof chunk === 'string' ? encodeUTF8(chunk)
+      : chunk;
+
+    this.#buffer = concatBytes([this.#buffer, binaryChunk]);
+
+    const lines: string[] = [];
+    let patternIndex;
+    while ((patternIndex = findNewlineIndex(this.#buffer, this.#carriageReturnIndex)) != null) {
+      if (patternIndex.carriage && this.#carriageReturnIndex == null) {
+        // skip until we either get a corresponding `\n`, a new `\r` or nothing
+        this.#carriageReturnIndex = patternIndex.index;
+        continue;
+      }
+
+      // we got double \r or \rtext\n
+      if (
+        this.#carriageReturnIndex != null &&
+        (patternIndex.index !== this.#carriageReturnIndex + 1 || patternIndex.carriage)
+      ) {
+        lines.push(decodeUTF8(this.#buffer.subarray(0, this.#carriageReturnIndex - 1)));
+        this.#buffer = this.#buffer.subarray(this.#carriageReturnIndex);
+        this.#carriageReturnIndex = null;
+        continue;
+      }
+
+      const endIndex =
+        this.#carriageReturnIndex !== null ? patternIndex.preceding - 1 : patternIndex.preceding;
+
+      const line = decodeUTF8(this.#buffer.subarray(0, endIndex));
+      lines.push(line);
+
+      this.#buffer = this.#buffer.subarray(patternIndex.index);
+      this.#carriageReturnIndex = null;
+    }
+
+    return lines;
+  }
+
+  flush(): string[] {
+    if (!this.#buffer.length) {
+      return [];
+    }
+    return this.decode('\n');
+  }
+}
+
+/**
+ * This function searches the buffer for the end patterns, (\r or \n)
+ * and returns an object with the index preceding the matched newline and the
+ * index after the newline char. `null` is returned if no new line is found.
+ *
+ * ```ts
+ * findNewLineIndex('abc\ndef') -> { preceding: 2, index: 3 }
+ * ```
+ */
+function findNewlineIndex(
+  buffer: Uint8Array,
+  startIndex: number | null,
+): { preceding: number; index: number; carriage: boolean } | null {
+  const newline = 0x0a; // \n
+  const carriage = 0x0d; // \r
+
+  for (let i = startIndex ?? 0; i < buffer.length; i++) {
+    if (buffer[i] === newline) {
+      return { preceding: i, index: i + 1, carriage: false };
+    }
+
+    if (buffer[i] === carriage) {
+      return { preceding: i, index: i + 1, carriage: true };
+    }
+  }
+
+  return null;
+}
+
+export function findDoubleNewlineIndex(buffer: Uint8Array): number {
+  // This function searches the buffer for the end patterns (\r\r, \n\n, \r\n\r\n)
+  // and returns the index right after the first occurrence of any pattern,
+  // or -1 if none of the patterns are found.
+  const newline = 0x0a; // \n
+  const carriage = 0x0d; // \r
+
+  for (let i = 0; i < buffer.length - 1; i++) {
+    if (buffer[i] === newline && buffer[i + 1] === newline) {
+      // \n\n
+      return i + 2;
+    }
+    if (buffer[i] === carriage && buffer[i + 1] === carriage) {
+      // \r\r
+      return i + 2;
+    }
+    if (
+      buffer[i] === carriage &&
+      buffer[i + 1] === newline &&
+      i + 3 < buffer.length &&
+      buffer[i + 2] === carriage &&
+      buffer[i + 3] === newline
+    ) {
+      // \r\n\r\n
+      return i + 4;
+    }
+  }
+
+  return -1;
+}

package/src/internal/parse.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import type { FinalRequestOptions } from './request-options';
+import { Stream } from '../core/streaming';
 import { type Cadenya } from '../client';
 import { formatRequestDetails, loggerFor } from './utils/log';
 
@@ -16,6 +17,19 @@ export type APIResponseProps = {
 export async function defaultParseResponse<T>(client: Cadenya, props: APIResponseProps): Promise<T> {
   const { response, requestLogID, retryOfRequestLogID, startTime } = props;
   const body = await (async () => {
+    if (props.options.stream) {
+      loggerFor(client).debug('response', response.status, response.url, response.headers, response.body);
+
+      // Note: there is an invariant here that isn't represented in the type system
+      // that if you set `stream: true` the response type must also be `Stream<T>`
+
+      if (props.options.__streamClass) {
+        return props.options.__streamClass.fromSSEResponse(response, props.controller, client) as any;
+      }
+
+      return Stream.fromSSEResponse(response, props.controller, client) as any;
+    }
+
     // fetch refuses to read the body when the status code is 204.
     if (response.status === 204) {
       return null as T;

package/src/internal/request-options.ts

@@ -3,6 +3,7 @@
 import { NullableHeaders } from './headers';
 
 import type { BodyInit } from './builtin-types';
+import { Stream } from '../core/streaming';
 import type { HTTPMethod, MergedRequestInit } from './types';
 import { type HeadersLike } from './headers';
 
@@ -76,6 +77,7 @@ export type RequestOptions = {
   defaultBaseURL?: string | undefined;
 
   __binaryResponse?: boolean | undefined;
+  __streamClass?: typeof Stream;
 };
 
 export type EncodedContent = { bodyHeaders: HeadersLike; body: BodyInit };

package/src/resources/index.ts

@@ -87,6 +87,7 @@ export {
   type ObjectiveContextWindow,
   type ObjectiveContextWindowData,
   type ObjectiveError,
+  type ObjectiveEvent,
   type ObjectiveEventData,
   type ObjectiveEventInfo,
   type ObjectiveEventWebhookData,
@@ -102,8 +103,6 @@ export {
   type ToolResult,
   type UserMessage,
   type ObjectiveCompactResponse,
-  type ObjectiveContinueResponse,
-  type ObjectiveListEventsResponse,
   type ObjectiveCreateParams,
   type ObjectiveRetrieveParams,
   type ObjectiveListParams,
@@ -112,9 +111,10 @@ export {
   type ObjectiveContinueParams,
   type ObjectiveListContextWindowsParams,
   type ObjectiveListEventsParams,
+  type ObjectiveStreamEventsParams,
   type ObjectivesCursorPagination,
   type ObjectiveContextWindowsCursorPagination,
-  type ObjectiveListEventsResponsesCursorPagination,
+  type ObjectiveEventsCursorPagination,
 } from './objectives/objectives';
 export { Profiles } from './profiles';
 export {

package/src/resources/objectives/index.ts

@@ -22,6 +22,7 @@ export {
   type ObjectiveContextWindow,
   type ObjectiveContextWindowData,
   type ObjectiveError,
+  type ObjectiveEvent,
   type ObjectiveEventData,
   type ObjectiveEventInfo,
   type ObjectiveEventWebhookData,
@@ -37,8 +38,6 @@ export {
   type ToolResult,
   type UserMessage,
   type ObjectiveCompactResponse,
-  type ObjectiveContinueResponse,
-  type ObjectiveListEventsResponse,
   type ObjectiveCreateParams,
   type ObjectiveRetrieveParams,
   type ObjectiveListParams,
@@ -47,9 +46,10 @@ export {
   type ObjectiveContinueParams,
   type ObjectiveListContextWindowsParams,
   type ObjectiveListEventsParams,
+  type ObjectiveStreamEventsParams,
   type ObjectivesCursorPagination,
   type ObjectiveContextWindowsCursorPagination,
-  type ObjectiveListEventsResponsesCursorPagination,
+  type ObjectiveEventsCursorPagination,
 } from './objectives';
 export {
   Tasks,

package/src/resources/objectives/objectives.ts

@@ -49,6 +49,8 @@ import * as ToolsAPI from './tools';
 import { ObjectiveTool, ObjectiveToolsCursorPagination, ToolListParams, Tools } from './tools';
 import { APIPromise } from '../../core/api-promise';
 import { CursorPagination, type CursorPaginationParams, PagePromise } from '../../core/pagination';
+import { Stream } from '../../core/streaming';
+import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
@@ -127,7 +129,7 @@ export class Objectives extends APIResource {
     objectiveID: string,
     params: ObjectiveContinueParams,
     options?: RequestOptions,
-  ): APIPromise<ObjectiveContinueResponse> {
+  ): APIPromise<ObjectiveEvent> {
     const { workspaceId, ...body } = params;
     return this._client.post(path`/v1/workspaces/${workspaceId}/objectives/${objectiveID}:continue`, {
       body,
@@ -159,21 +161,37 @@ export class Objectives extends APIResource {
     objectiveID: string,
     params: ObjectiveListEventsParams,
     options?: RequestOptions,
-  ): PagePromise<ObjectiveListEventsResponsesCursorPagination, ObjectiveListEventsResponse> {
+  ): PagePromise<ObjectiveEventsCursorPagination, ObjectiveEvent> {
     const { workspaceId, ...query } = params;
     return this._client.getAPIList(
       path`/v1/workspaces/${workspaceId}/objectives/${objectiveID}/events`,
-      CursorPagination<ObjectiveListEventsResponse>,
+      CursorPagination<ObjectiveEvent>,
       { query, ...options },
     );
   }
+
+  /**
+   * Streams events for an objective in real-time using server-sent events (SSE)
+   */
+  streamEvents(
+    objectiveID: string,
+    params: ObjectiveStreamEventsParams,
+    options?: RequestOptions,
+  ): APIPromise<Stream<ObjectiveEvent>> {
+    const { workspaceId } = params;
+    return this._client.get(path`/v1/workspaces/${workspaceId}/objectives/${objectiveID}/events:stream`, {
+      ...options,
+      headers: buildHeaders([{ Accept: 'text/event-stream' }, options?.headers]),
+      stream: true,
+    }) as APIPromise<Stream<ObjectiveEvent>>;
+  }
 }
 
 export type ObjectivesCursorPagination = CursorPagination<Objective>;
 
 export type ObjectiveContextWindowsCursorPagination = CursorPagination<ObjectiveContextWindow>;
 
-export type ObjectiveListEventsResponsesCursorPagination = CursorPagination<ObjectiveListEventsResponse>;
+export type ObjectiveEventsCursorPagination = CursorPagination<ObjectiveEvent>;
 
 export interface AssistantMessage {
   content?: string;
@@ -503,6 +521,20 @@ export interface ObjectiveError {
   type?: string;
 }
 
+export interface ObjectiveEvent {
+  data: ObjectiveEventData;
+
+  /**
+   * Metadata for ephemeral operations and activities (e.g., objectives, executions,
+   * runs)
+   */
+  metadata: Shared.OperationMetadata;
+
+  contextWindowId?: string;
+
+  info?: ObjectiveEventInfo;
+}
+
 export interface ObjectiveEventData {
   assistantMessage?: AssistantMessage;
 
@@ -639,23 +671,7 @@ export namespace ObjectiveEventWebhookData {
      */
     objective: Shared.OperationMetadata;
 
-    objectiveEvent: Data.ObjectiveEvent;
-  }
-
-  export namespace Data {
-    export interface ObjectiveEvent {
-      data: ObjectivesAPI.ObjectiveEventData;
-
-      /**
-       * Metadata for ephemeral operations and activities (e.g., objectives, executions,
-       * runs)
-       */
-      metadata: Shared.OperationMetadata;
-
-      contextWindowId?: string;
-
-      info?: ObjectivesAPI.ObjectiveEventInfo;
-    }
+    objectiveEvent: ObjectivesAPI.ObjectiveEvent;
   }
 }
 
@@ -851,34 +867,6 @@ export interface ObjectiveCompactResponse {
   contextWindow?: ObjectiveContextWindowData;
 }
 
-export interface ObjectiveContinueResponse {
-  data: ObjectiveEventData;
-
-  /**
-   * Metadata for ephemeral operations and activities (e.g., objectives, executions,
-   * runs)
-   */
-  metadata: Shared.OperationMetadata;
-
-  contextWindowId?: string;
-
-  info?: ObjectiveEventInfo;
-}
-
-export interface ObjectiveListEventsResponse {
-  data: ObjectiveEventData;
-
-  /**
-   * Metadata for ephemeral operations and activities (e.g., objectives, executions,
-   * runs)
-   */
-  metadata: Shared.OperationMetadata;
-
-  contextWindowId?: string;
-
-  info?: ObjectiveEventInfo;
-}
-
 export interface ObjectiveCreateParams {
   agentId: string;
 
@@ -1109,6 +1097,10 @@ export interface ObjectiveListEventsParams extends CursorPaginationParams {
   windowId?: string;
 }
 
+export interface ObjectiveStreamEventsParams {
+  workspaceId: string;
+}
+
 Objectives.Tools = Tools;
 Objectives.ToolCalls = ToolCalls;
 Objectives.Tasks = Tasks;
@@ -1127,6 +1119,7 @@ export declare namespace Objectives {
     type ObjectiveContextWindow as ObjectiveContextWindow,
     type ObjectiveContextWindowData as ObjectiveContextWindowData,
     type ObjectiveError as ObjectiveError,
+    type ObjectiveEvent as ObjectiveEvent,
     type ObjectiveEventData as ObjectiveEventData,
     type ObjectiveEventInfo as ObjectiveEventInfo,
     type ObjectiveEventWebhookData as ObjectiveEventWebhookData,
@@ -1142,11 +1135,9 @@ export declare namespace Objectives {
     type ToolResult as ToolResult,
     type UserMessage as UserMessage,
     type ObjectiveCompactResponse as ObjectiveCompactResponse,
-    type ObjectiveContinueResponse as ObjectiveContinueResponse,
-    type ObjectiveListEventsResponse as ObjectiveListEventsResponse,
     type ObjectivesCursorPagination as ObjectivesCursorPagination,
     type ObjectiveContextWindowsCursorPagination as ObjectiveContextWindowsCursorPagination,
-    type ObjectiveListEventsResponsesCursorPagination as ObjectiveListEventsResponsesCursorPagination,
+    type ObjectiveEventsCursorPagination as ObjectiveEventsCursorPagination,
     type ObjectiveCreateParams as ObjectiveCreateParams,
     type ObjectiveRetrieveParams as ObjectiveRetrieveParams,
     type ObjectiveListParams as ObjectiveListParams,
@@ -1155,6 +1146,7 @@ export declare namespace Objectives {
     type ObjectiveContinueParams as ObjectiveContinueParams,
     type ObjectiveListContextWindowsParams as ObjectiveListContextWindowsParams,
     type ObjectiveListEventsParams as ObjectiveListEventsParams,
+    type ObjectiveStreamEventsParams as ObjectiveStreamEventsParams,
   };
 
   export {

package/src/resources/webhooks.ts

@@ -66,23 +66,7 @@ export namespace UnsafeUnwrapWebhookEvent {
      */
     objective: Shared.OperationMetadata;
 
-    objectiveEvent: Data.ObjectiveEvent;
-  }
-
-  export namespace Data {
-    export interface ObjectiveEvent {
-      data: ObjectivesAPI.ObjectiveEventData;
-
-      /**
-       * Metadata for ephemeral operations and activities (e.g., objectives, executions,
-       * runs)
-       */
-      metadata: Shared.OperationMetadata;
-
-      contextWindowId?: string;
-
-      info?: ObjectivesAPI.ObjectiveEventInfo;
-    }
+    objectiveEvent: ObjectivesAPI.ObjectiveEvent;
   }
 }
 
@@ -128,23 +112,7 @@ export namespace UnwrapWebhookEvent {
      */
     objective: Shared.OperationMetadata;
 
-    objectiveEvent: Data.ObjectiveEvent;
-  }
-
-  export namespace Data {
-    export interface ObjectiveEvent {
-      data: ObjectivesAPI.ObjectiveEventData;
-
-      /**
-       * Metadata for ephemeral operations and activities (e.g., objectives, executions,
-       * runs)
-       */
-      metadata: Shared.OperationMetadata;
-
-      contextWindowId?: string;
-
-      info?: ObjectivesAPI.ObjectiveEventInfo;
-    }
+    objectiveEvent: ObjectivesAPI.ObjectiveEvent;
   }
 }
 

package/src/streaming.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/streaming instead */
+export * from './core/streaming';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.96.0'; // x-release-please-version
+export const VERSION = '0.98.0'; // x-release-please-version

package/streaming.d.mts

@@ -0,0 +1,3 @@
+/** @deprecated Import from ./core/streaming instead */
+export * from "./core/streaming.mjs";
+//# sourceMappingURL=streaming.d.mts.map

package/streaming.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streaming.d.mts","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,qCAAiC"}

package/streaming.d.ts

@@ -0,0 +1,3 @@
+/** @deprecated Import from ./core/streaming instead */
+export * from "./core/streaming.js";
+//# sourceMappingURL=streaming.d.ts.map

package/streaming.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streaming.d.ts","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,oCAAiC"}

package/streaming.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/streaming instead */
+tslib_1.__exportStar(require("./core/streaming.js"), exports);
+//# sourceMappingURL=streaming.js.map

package/streaming.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streaming.js","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AACvD,8DAAiC"}

package/streaming.mjs

@@ -0,0 +1,3 @@
+/** @deprecated Import from ./core/streaming instead */
+export * from "./core/streaming.mjs";
+//# sourceMappingURL=streaming.mjs.map

package/streaming.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"streaming.mjs","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,qCAAiC"}

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.96.0";
+export declare const VERSION = "0.98.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.96.0";
+export declare const VERSION = "0.98.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.96.0'; // x-release-please-version
+exports.VERSION = '0.98.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.96.0'; // x-release-please-version
+export const VERSION = '0.98.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map