refactor: rename ModelProviderStreamEvent to ModelStreamEvent (#43)

This change improves naming consistency in the streaming API:
- Individual event types use Model* prefix (ModelMessageStartEvent, etc.)
- Union type now also uses Model* prefix (ModelStreamEvent)

BREAKING CHANGE: ModelProviderStreamEvent has been renamed to ModelStreamEvent.
All imports and type references must be updated.

Updated 6 files:
- src/models/streaming.ts: Type definition
- src/index.ts: Public API export
- src/models/model.ts: Interface signature
- src/models/bedrock.ts: Implementation
- tests_integ/bedrock.test.ts: Integration tests
- src/models/__tests__/bedrock.test.ts: Unit tests

Resolves: #38

Co-authored-by: Strands Agent <[email protected]>

Author: Unshure

src/index.ts

@@ -51,7 +51,7 @@ export type {
   ModelContentBlockStopEvent,
   ModelMessageStopEvent,
   ModelMetadataEvent,
-  ModelProviderStreamEvent,
+  ModelStreamEvent,
 } from './models/streaming'
 
 // Model provider types

src/models/__tests__/bedrock.test.ts

@@ -4,13 +4,13 @@ import { BedrockModel } from '../bedrock'
 import { ContextWindowOverflowError } from '../../errors'
 import type { Message } from '../../types/messages'
 import type { StreamOptions } from '../model'
-import type { ModelProviderStreamEvent } from '../streaming'
+import type { ModelStreamEvent } from '../streaming'
 
 /**
  * Helper function to collect all events from a stream.
  */
-async function collectEvents(stream: AsyncIterable<ModelProviderStreamEvent>): Promise<ModelProviderStreamEvent[]> {
-  const events: ModelProviderStreamEvent[] = []
+async function collectEvents(stream: AsyncIterable<ModelStreamEvent>): Promise<ModelStreamEvent[]> {
+  const events: ModelStreamEvent[] = []
   for await (const event of stream) {
     events.push(event)
   }

src/models/bedrock.ts

@@ -28,7 +28,7 @@ import {
 } from '@aws-sdk/client-bedrock-runtime'
 import type { Model, BaseModelConfig, StreamOptions } from '../models/model'
 import type { Message, ContentBlock } from '../types/messages'
-import type { ModelProviderStreamEvent, ReasoningDelta, Usage } from '../models/streaming'
+import type { ModelStreamEvent, ReasoningDelta, Usage } from '../models/streaming'
 import type { JSONValue } from '../types/json'
 import { ContextWindowOverflowError } from '../errors'
 import { ensureDefined } from '../types/validation'
@@ -303,7 +303,7 @@ export class BedrockModel implements Model<BedrockModelConfig, BedrockRuntimeCli
    * }
    * ```
    */
-  async *stream(messages: Message[], options?: StreamOptions): AsyncIterable<ModelProviderStreamEvent> {
+  async *stream(messages: Message[], options?: StreamOptions): AsyncIterable<ModelStreamEvent> {
     try {
       // Format the request for Bedrock
       const request = this._formatRequest(messages, options)
@@ -503,8 +503,8 @@ export class BedrockModel implements Model<BedrockModelConfig, BedrockRuntimeCli
    * @param chunk - Bedrock event chunk
    * @returns Array of SDK streaming events
    */
-  private _mapBedrockEventToSDKEvents(chunk: ConverseStreamOutput): ModelProviderStreamEvent[] {
-    const events: ModelProviderStreamEvent[] = []
+  private _mapBedrockEventToSDKEvents(chunk: ConverseStreamOutput): ModelStreamEvent[] {
+    const events: ModelStreamEvent[] = []
 
     // Extract the event type key
     const eventType = ensureDefined(Object.keys(chunk)[0], 'eventType') as keyof ConverseStreamOutput
@@ -523,7 +523,7 @@ export class BedrockModel implements Model<BedrockModelConfig, BedrockRuntimeCli
       case 'contentBlockStart': {
         const data = eventData as BedrockContentBlockStartEvent
 
-        const event: ModelProviderStreamEvent = {
+        const event: ModelStreamEvent = {
           type: 'modelContentBlockStartEvent',
         }
 
@@ -547,7 +547,7 @@ export class BedrockModel implements Model<BedrockModelConfig, BedrockRuntimeCli
       case 'contentBlockDelta': {
         const data = eventData as BedrockContentBlockDeltaEvent
         const delta = ensureDefined(data.delta, 'contentBlockDelta.delta')
-        let event: ModelProviderStreamEvent | undefined = {
+        let event: ModelStreamEvent | undefined = {
           type: 'modelContentBlockDeltaEvent',
           delta: { type: 'textDelta', text: '' },
         }
@@ -604,7 +604,7 @@ export class BedrockModel implements Model<BedrockModelConfig, BedrockRuntimeCli
       case 'contentBlockStop': {
         const data = eventData as BedrockContentBlockStopEvent
 
-        const event: ModelProviderStreamEvent = {
+        const event: ModelStreamEvent = {
           type: 'modelContentBlockStopEvent',
         }
 
@@ -619,7 +619,7 @@ export class BedrockModel implements Model<BedrockModelConfig, BedrockRuntimeCli
       case 'messageStop': {
         const data = eventData as BedrockMessageStopEvent
 
-        const event: ModelProviderStreamEvent = {
+        const event: ModelStreamEvent = {
           type: 'modelMessageStopEvent',
         }
 
@@ -645,7 +645,7 @@ export class BedrockModel implements Model<BedrockModelConfig, BedrockRuntimeCli
       case 'metadata': {
         const data = eventData as BedrockConverseStreamMetadataEvent
 
-        const event: ModelProviderStreamEvent = {
+        const event: ModelStreamEvent = {
           type: 'modelMetadataEvent',
         }
 

src/models/model.ts

@@ -1,6 +1,6 @@
 import type { Message } from '../types/messages'
 import type { ToolSpec, ToolChoice } from '../tools/types'
-import type { ModelProviderStreamEvent } from './streaming'
+import type { ModelStreamEvent } from './streaming'
 
 /**
  * Base configuration interface for all model providers.
@@ -85,5 +85,5 @@ export interface Model<T extends BaseModelConfig, _C = unknown> {
    * }
    * ```
    */
-  stream(messages: Message[], options?: StreamOptions): AsyncIterable<ModelProviderStreamEvent>
+  stream(messages: Message[], options?: StreamOptions): AsyncIterable<ModelStreamEvent>
 }

src/models/streaming.ts

@@ -26,7 +26,7 @@ import type { JSONValue } from '../types/json'
  * }
  * ```
  */
-export type ModelProviderStreamEvent =
+export type ModelStreamEvent =
   | ModelMessageStartEvent
   | ModelContentBlockStartEvent
   | ModelContentBlockDeltaEvent

tests_integ/bedrock.test.ts

@@ -4,14 +4,14 @@ import { BedrockModel } from '@strands-agents/sdk'
 import { ContextWindowOverflowError } from '@strands-agents/sdk'
 import type { Message } from '@strands-agents/sdk'
 import type { ToolSpec } from '@strands-agents/sdk'
-import type { ModelProviderStreamEvent } from '@strands-agents/sdk'
+import type { ModelStreamEvent } from '@strands-agents/sdk'
 import { ValidationException } from '@aws-sdk/client-bedrock-runtime'
 
 /**
  * Helper function to collect all events from a stream.
  */
-async function collectEvents(stream: AsyncIterable<ModelProviderStreamEvent>): Promise<ModelProviderStreamEvent[]> {
-  const events: ModelProviderStreamEvent[] = []
+async function collectEvents(stream: AsyncIterable<ModelStreamEvent>): Promise<ModelStreamEvent[]> {
+  const events: ModelStreamEvent[] = []
   for await (const event of stream) {
     events.push(event)
   }