feat(api/types): add stream event type aliases with a Raw prefix (#428)

this change is mainly for consistency with the Python SDK as there is a
distinct difference between `Raw` and non-`Raw` types, see this PR for
more details: anthropics/anthropic-sdk-python#528

api.md

@@ -16,6 +16,13 @@ Types:
 - <code><a href="./src/resources/messages.ts">MessageStartEvent</a></code>
 - <code><a href="./src/resources/messages.ts">MessageStopEvent</a></code>
 - <code><a href="./src/resources/messages.ts">MessageStreamEvent</a></code>
+- <code><a href="./src/resources/messages.ts">RawContentBlockDeltaEvent</a></code>
+- <code><a href="./src/resources/messages.ts">RawContentBlockStartEvent</a></code>
+- <code><a href="./src/resources/messages.ts">RawContentBlockStopEvent</a></code>
+- <code><a href="./src/resources/messages.ts">RawMessageDeltaEvent</a></code>
+- <code><a href="./src/resources/messages.ts">RawMessageStartEvent</a></code>
+- <code><a href="./src/resources/messages.ts">RawMessageStopEvent</a></code>
+- <code><a href="./src/resources/messages.ts">RawMessageStreamEvent</a></code>
 - <code><a href="./src/resources/messages.ts">TextBlock</a></code>
 - <code><a href="./src/resources/messages.ts">TextBlockParam</a></code>
 - <code><a href="./src/resources/messages.ts">TextDelta</a></code>
@@ -35,6 +42,9 @@ Methods:
 Types:
 
 - <code><a href="./src/resources/beta/tools/messages.ts">InputJsonDelta</a></code>
+- <code><a href="./src/resources/beta/tools/messages.ts">RawToolsBetaContentBlockDeltaEvent</a></code>
+- <code><a href="./src/resources/beta/tools/messages.ts">RawToolsBetaContentBlockStartEvent</a></code>
+- <code><a href="./src/resources/beta/tools/messages.ts">RawToolsBetaMessageStreamEvent</a></code>
 - <code><a href="./src/resources/beta/tools/messages.ts">Tool</a></code>
 - <code><a href="./src/resources/beta/tools/messages.ts">ToolResultBlockParam</a></code>
 - <code><a href="./src/resources/beta/tools/messages.ts">ToolUseBlock</a></code>

src/index.ts

@@ -249,6 +249,13 @@ export namespace Anthropic {
   export import MessageStartEvent = API.MessageStartEvent;
   export import MessageStopEvent = API.MessageStopEvent;
   export import MessageStreamEvent = API.MessageStreamEvent;
+  export import RawContentBlockDeltaEvent = API.RawContentBlockDeltaEvent;
+  export import RawContentBlockStartEvent = API.RawContentBlockStartEvent;
+  export import RawContentBlockStopEvent = API.RawContentBlockStopEvent;
+  export import RawMessageDeltaEvent = API.RawMessageDeltaEvent;
+  export import RawMessageStartEvent = API.RawMessageStartEvent;
+  export import RawMessageStopEvent = API.RawMessageStopEvent;
+  export import RawMessageStreamEvent = API.RawMessageStreamEvent;
   export import TextBlock = API.TextBlock;
   export import TextBlockParam = API.TextBlockParam;
   export import TextDelta = API.TextDelta;

src/resources/beta/tools/index.ts

@@ -2,6 +2,9 @@
 
 export {
   InputJsonDelta,
+  RawToolsBetaContentBlockDeltaEvent,
+  RawToolsBetaContentBlockStartEvent,
+  RawToolsBetaMessageStreamEvent,
   Tool,
   ToolResultBlockParam,
   ToolUseBlock,

src/resources/beta/tools/messages.ts

@@ -23,22 +23,22 @@ export class Messages extends APIResource {
   create(
     body: MessageCreateParamsStreaming,
     options?: Core.RequestOptions,
-  ): APIPromise<Stream<ToolsBetaMessageStreamEvent>>;
+  ): APIPromise<Stream<RawToolsBetaMessageStreamEvent>>;
   create(
     body: MessageCreateParamsBase,
     options?: Core.RequestOptions,
-  ): APIPromise<Stream<ToolsBetaMessageStreamEvent> | ToolsBetaMessage>;
+  ): APIPromise<Stream<RawToolsBetaMessageStreamEvent> | ToolsBetaMessage>;
   create(
     body: MessageCreateParams,
     options?: Core.RequestOptions,
-  ): APIPromise<ToolsBetaMessage> | APIPromise<Stream<ToolsBetaMessageStreamEvent>> {
+  ): APIPromise<ToolsBetaMessage> | APIPromise<Stream<RawToolsBetaMessageStreamEvent>> {
     return this._client.post('/v1/messages?beta=tools', {
       body,
       timeout: 600000,
       ...options,
       headers: { 'anthropic-beta': 'tools-2024-05-16', ...options?.headers },
       stream: body.stream ?? false,
-    }) as APIPromise<ToolsBetaMessage> | APIPromise<Stream<ToolsBetaMessageStreamEvent>>;
+    }) as APIPromise<ToolsBetaMessage> | APIPromise<Stream<RawToolsBetaMessageStreamEvent>>;
   }
 
   /**
@@ -55,6 +55,30 @@ export interface InputJsonDelta {
   type: 'input_json_delta';
 }
 
+export interface RawToolsBetaContentBlockDeltaEvent {
+  delta: MessagesAPI.TextDelta | InputJsonDelta;
+
+  index: number;
+
+  type: 'content_block_delta';
+}
+
+export interface RawToolsBetaContentBlockStartEvent {
+  content_block: MessagesAPI.TextBlock | ToolUseBlock;
+
+  index: number;
+
+  type: 'content_block_start';
+}
+
+export type RawToolsBetaMessageStreamEvent =
+  | MessagesAPI.RawMessageStartEvent
+  | MessagesAPI.RawMessageDeltaEvent
+  | MessagesAPI.RawMessageStopEvent
+  | RawToolsBetaContentBlockStartEvent
+  | RawToolsBetaContentBlockDeltaEvent
+  | MessagesAPI.RawContentBlockStopEvent;
+
 export interface Tool {
   /**
    * [JSON schema](https://json-schema.org/) for this tool's input.
@@ -124,21 +148,9 @@ export interface ToolUseBlockParam {
 
 export type ToolsBetaContentBlock = MessagesAPI.TextBlock | ToolUseBlock;
 
-export interface ToolsBetaContentBlockDeltaEvent {
-  delta: MessagesAPI.TextDelta | InputJsonDelta;
-
-  index: number;
-
-  type: 'content_block_delta';
-}
+export type ToolsBetaContentBlockDeltaEvent = RawToolsBetaContentBlockDeltaEvent;
 
-export interface ToolsBetaContentBlockStartEvent {
-  content_block: MessagesAPI.TextBlock | ToolUseBlock;
-
-  index: number;
-
-  type: 'content_block_start';
-}
+export type ToolsBetaContentBlockStartEvent = RawToolsBetaContentBlockStartEvent;
 
 export interface ToolsBetaMessage {
   /**
@@ -253,13 +265,7 @@ export interface ToolsBetaMessageParam {
   role: 'user' | 'assistant';
 }
 
-export type ToolsBetaMessageStreamEvent =
-  | MessagesAPI.MessageStartEvent
-  | MessagesAPI.MessageDeltaEvent
-  | MessagesAPI.MessageStopEvent
-  | ToolsBetaContentBlockStartEvent
-  | ToolsBetaContentBlockDeltaEvent
-  | MessagesAPI.ContentBlockStopEvent;
+export type ToolsBetaMessageStreamEvent = RawToolsBetaMessageStreamEvent;
 
 export type MessageCreateParams = MessageCreateParamsNonStreaming | MessageCreateParamsStreaming;
 
@@ -890,6 +896,9 @@ export namespace MessageStreamParams {
 
 export namespace Messages {
   export import InputJsonDelta = ToolsMessagesAPI.InputJsonDelta;
+  export import RawToolsBetaContentBlockDeltaEvent = ToolsMessagesAPI.RawToolsBetaContentBlockDeltaEvent;
+  export import RawToolsBetaContentBlockStartEvent = ToolsMessagesAPI.RawToolsBetaContentBlockStartEvent;
+  export import RawToolsBetaMessageStreamEvent = ToolsMessagesAPI.RawToolsBetaMessageStreamEvent;
   export import Tool = ToolsMessagesAPI.Tool;
   export import ToolResultBlockParam = ToolsMessagesAPI.ToolResultBlockParam;
   export import ToolUseBlock = ToolsMessagesAPI.ToolUseBlock;

src/resources/beta/tools/tools.ts

@@ -10,6 +10,9 @@ export class Tools extends APIResource {
 export namespace Tools {
   export import Messages = MessagesAPI.Messages;
   export import InputJsonDelta = MessagesAPI.InputJsonDelta;
+  export import RawToolsBetaContentBlockDeltaEvent = MessagesAPI.RawToolsBetaContentBlockDeltaEvent;
+  export import RawToolsBetaContentBlockStartEvent = MessagesAPI.RawToolsBetaContentBlockStartEvent;
+  export import RawToolsBetaMessageStreamEvent = MessagesAPI.RawToolsBetaMessageStreamEvent;
   export import Tool = MessagesAPI.Tool;
   export import ToolResultBlockParam = MessagesAPI.ToolResultBlockParam;
   export import ToolUseBlock = MessagesAPI.ToolUseBlock;

src/resources/index.ts

@@ -21,6 +21,13 @@ export {
   MessageStartEvent,
   MessageStopEvent,
   MessageStreamEvent,
+  RawContentBlockDeltaEvent,
+  RawContentBlockStartEvent,
+  RawContentBlockStopEvent,
+  RawMessageDeltaEvent,
+  RawMessageStartEvent,
+  RawMessageStopEvent,
+  RawMessageStreamEvent,
   TextBlock,
   TextBlockParam,
   TextDelta,

src/resources/messages.ts

@@ -22,21 +22,21 @@ export class Messages extends APIResource {
   create(
     body: MessageCreateParamsStreaming,
     options?: Core.RequestOptions,
-  ): APIPromise<Stream<MessageStreamEvent>>;
+  ): APIPromise<Stream<RawMessageStreamEvent>>;
   create(
     body: MessageCreateParamsBase,
     options?: Core.RequestOptions,
-  ): APIPromise<Stream<MessageStreamEvent> | Message>;
+  ): APIPromise<Stream<RawMessageStreamEvent> | Message>;
   create(
     body: MessageCreateParams,
     options?: Core.RequestOptions,
-  ): APIPromise<Message> | APIPromise<Stream<MessageStreamEvent>> {
+  ): APIPromise<Message> | APIPromise<Stream<RawMessageStreamEvent>> {
     return this._client.post('/v1/messages', {
       body,
       timeout: 600000,
       ...options,
       stream: body.stream ?? false,
-    }) as APIPromise<Message> | APIPromise<Stream<MessageStreamEvent>>;
+    }) as APIPromise<Message> | APIPromise<Stream<RawMessageStreamEvent>>;
   }
 
   /**
@@ -49,27 +49,11 @@ export class Messages extends APIResource {
 
 export type ContentBlock = TextBlock;
 
-export interface ContentBlockDeltaEvent {
-  delta: TextDelta;
+export type ContentBlockDeltaEvent = RawContentBlockDeltaEvent;
 
-  index: number;
+export type ContentBlockStartEvent = RawContentBlockStartEvent;
 
-  type: 'content_block_delta';
-}
-
-export interface ContentBlockStartEvent {
-  content_block: TextBlock;
-
-  index: number;
-
-  type: 'content_block_start';
-}
-
-export interface ContentBlockStopEvent {
-  index: number;
-
-  type: 'content_block_stop';
-}
+export type ContentBlockStopEvent = RawContentBlockStopEvent;
 
 export interface ImageBlockParam {
   source: ImageBlockParam.Source;
@@ -189,8 +173,51 @@ export interface Message {
   usage: Usage;
 }
 
-export interface MessageDeltaEvent {
-  delta: MessageDeltaEvent.Delta;
+export type MessageDeltaEvent = RawMessageDeltaEvent;
+
+export interface MessageDeltaUsage {
+  /**
+   * The cumulative number of output tokens which were used.
+   */
+  output_tokens: number;
+}
+
+export interface MessageParam {
+  content: string | Array<TextBlockParam | ImageBlockParam>;
+
+  role: 'user' | 'assistant';
+}
+
+export type MessageStartEvent = RawMessageStartEvent;
+
+export type MessageStopEvent = RawMessageStopEvent;
+
+export type MessageStreamEvent = RawMessageStreamEvent;
+
+export interface RawContentBlockDeltaEvent {
+  delta: TextDelta;
+
+  index: number;
+
+  type: 'content_block_delta';
+}
+
+export interface RawContentBlockStartEvent {
+  content_block: TextBlock;
+
+  index: number;
+
+  type: 'content_block_start';
+}
+
+export interface RawContentBlockStopEvent {
+  index: number;
+
+  type: 'content_block_stop';
+}
+
+export interface RawMessageDeltaEvent {
+  delta: RawMessageDeltaEvent.Delta;
 
   type: 'message_delta';
 
@@ -211,44 +238,31 @@ export interface MessageDeltaEvent {
   usage: MessageDeltaUsage;
 }
 
-export namespace MessageDeltaEvent {
+export namespace RawMessageDeltaEvent {
   export interface Delta {
     stop_reason: 'end_turn' | 'max_tokens' | 'stop_sequence' | null;
 
     stop_sequence: string | null;
   }
 }
 
-export interface MessageDeltaUsage {
-  /**
-   * The cumulative number of output tokens which were used.
-   */
-  output_tokens: number;
-}
-
-export interface MessageParam {
-  content: string | Array<TextBlockParam | ImageBlockParam>;
-
-  role: 'user' | 'assistant';
-}
-
-export interface MessageStartEvent {
+export interface RawMessageStartEvent {
   message: Message;
 
   type: 'message_start';
 }
 
-export interface MessageStopEvent {
+export interface RawMessageStopEvent {
   type: 'message_stop';
 }
 
-export type MessageStreamEvent =
-  | MessageStartEvent
-  | MessageDeltaEvent
-  | MessageStopEvent
-  | ContentBlockStartEvent
-  | ContentBlockDeltaEvent
-  | ContentBlockStopEvent;
+export type RawMessageStreamEvent =
+  | RawMessageStartEvent
+  | RawMessageDeltaEvent
+  | RawMessageStopEvent
+  | RawContentBlockStartEvent
+  | RawContentBlockDeltaEvent
+  | RawContentBlockStopEvent;
 
 export interface TextBlock {
   text: string;
@@ -718,6 +732,13 @@ export namespace Messages {
   export import MessageStartEvent = MessagesAPI.MessageStartEvent;
   export import MessageStopEvent = MessagesAPI.MessageStopEvent;
   export import MessageStreamEvent = MessagesAPI.MessageStreamEvent;
+  export import RawContentBlockDeltaEvent = MessagesAPI.RawContentBlockDeltaEvent;
+  export import RawContentBlockStartEvent = MessagesAPI.RawContentBlockStartEvent;
+  export import RawContentBlockStopEvent = MessagesAPI.RawContentBlockStopEvent;
+  export import RawMessageDeltaEvent = MessagesAPI.RawMessageDeltaEvent;
+  export import RawMessageStartEvent = MessagesAPI.RawMessageStartEvent;
+  export import RawMessageStopEvent = MessagesAPI.RawMessageStopEvent;
+  export import RawMessageStreamEvent = MessagesAPI.RawMessageStreamEvent;
   export import TextBlock = MessagesAPI.TextBlock;
   export import TextBlockParam = MessagesAPI.TextBlockParam;
   export import TextDelta = MessagesAPI.TextDelta;