From 47e478772e3363a12957a53699a08b6bb459d046 Mon Sep 17 00:00:00 2001
From: Young-Jin Park <youngjinpark20@gmail.com>
Date: Thu, 18 Jul 2024 16:48:31 -0400
Subject: [PATCH 1/4] [wip]: refactor

---
 src/lib/AbstractChatCompletionRunner.ts       | 253 ++----------------
 src/lib/AssistantStream.ts                    |  63 +++--
 src/lib/ChatCompletionRunner.ts               |   6 +-
 src/lib/ChatCompletionStream.ts               |   8 +-
 ...ssistantStreamRunner.ts => EventStream.ts} | 186 ++++---------
 5 files changed, 118 insertions(+), 398 deletions(-)
 rename src/lib/{AbstractAssistantStreamRunner.ts => EventStream.ts} (55%)

diff --git a/src/lib/AbstractChatCompletionRunner.ts b/src/lib/AbstractChatCompletionRunner.ts
index 5764b85b2..627b9fbba 100644
--- a/src/lib/AbstractChatCompletionRunner.ts
+++ b/src/lib/AbstractChatCompletionRunner.ts
@@ -8,7 +8,7 @@ import {
   type ChatCompletionCreateParams,
   type ChatCompletionTool,
 } from 'openai/resources/chat/completions';
-import { APIUserAbortError, OpenAIError } from 'openai/error';
+import { OpenAIError } from 'openai/error';
 import {
   type RunnableFunction,
   isRunnableFunctionWithParse,
@@ -20,6 +20,7 @@ import {
   ChatCompletionStreamingToolRunnerParams,
 } from './ChatCompletionStreamingRunner';
 import { isAssistantMessage, isFunctionMessage, isToolMessage } from './chatCompletionUtils';
+import { BaseEvents, EventStream } from './EventStream';
 
 const DEFAULT_MAX_CHAT_COMPLETIONS = 10;
 export interface RunnerOptions extends Core.RequestOptions {
@@ -27,60 +28,16 @@ export interface RunnerOptions extends Core.RequestOptions {
   maxChatCompletions?: number;
 }
 
-export abstract class AbstractChatCompletionRunner<
-  Events extends CustomEvents<any> = AbstractChatCompletionRunnerEvents,
-> {
-  controller: AbortController = new AbortController();
-
-  #connectedPromise: Promise<void>;
-  #resolveConnectedPromise: () => void = () => {};
-  #rejectConnectedPromise: (error: OpenAIError) => void = () => {};
-
-  #endPromise: Promise<void>;
-  #resolveEndPromise: () => void = () => {};
-  #rejectEndPromise: (error: OpenAIError) => void = () => {};
-
-  #listeners: { [Event in keyof Events]?: ListenersForEvent<Events, Event> } = {};
+export class AbstractChatCompletionRunner extends EventStream {
+  declare _Events: AbstractChatCompletionRunnerEvents;
 
   protected _chatCompletions: ChatCompletion[] = [];
   messages: ChatCompletionMessageParam[] = [];
 
-  #ended = false;
-  #errored = false;
-  #aborted = false;
-  #catchingPromiseCreated = false;
-
-  constructor() {
-    this.#connectedPromise = new Promise<void>((resolve, reject) => {
-      this.#resolveConnectedPromise = resolve;
-      this.#rejectConnectedPromise = reject;
-    });
-
-    this.#endPromise = new Promise<void>((resolve, reject) => {
-      this.#resolveEndPromise = resolve;
-      this.#rejectEndPromise = reject;
-    });
-
-    // Don't let these promises cause unhandled rejection errors.
-    // we will manually cause an unhandled rejection error later
-    // if the user hasn't registered any error listener or called
-    // any promise-returning method.
-    this.#connectedPromise.catch(() => {});
-    this.#endPromise.catch(() => {});
-  }
-
-  protected _run(executor: () => Promise<any>) {
-    // Unfortunately if we call `executor()` immediately we get runtime errors about
-    // references to `this` before the `super()` constructor call returns.
-    setTimeout(() => {
-      executor().then(() => {
-        this._emitFinal();
-        this._emit('end');
-      }, this.#handleError);
-    }, 0);
-  }
-
-  protected _addChatCompletion(chatCompletion: ChatCompletion): ChatCompletion {
+  protected _addChatCompletion(
+    this: AbstractChatCompletionRunner,
+    chatCompletion: ChatCompletion,
+  ): ChatCompletion {
     this._chatCompletions.push(chatCompletion);
     this._emit('chatCompletion', chatCompletion);
     const message = chatCompletion.choices[0]?.message;
@@ -88,7 +45,11 @@ export abstract class AbstractChatCompletionRunner<
     return chatCompletion;
   }
 
-  protected _addMessage(message: ChatCompletionMessageParam, emit = true) {
+  protected _addMessage(
+    this: AbstractChatCompletionRunner,
+    message: ChatCompletionMessageParam,
+    emit = true,
+  ) {
     if (!('content' in message)) message.content = null;
 
     this.messages.push(message);
@@ -110,99 +71,6 @@ export abstract class AbstractChatCompletionRunner<
     }
   }
 
-  protected _connected() {
-    if (this.ended) return;
-    this.#resolveConnectedPromise();
-    this._emit('connect');
-  }
-
-  get ended(): boolean {
-    return this.#ended;
-  }
-
-  get errored(): boolean {
-    return this.#errored;
-  }
-
-  get aborted(): boolean {
-    return this.#aborted;
-  }
-
-  abort() {
-    this.controller.abort();
-  }
-
-  /**
-   * Adds the listener function to the end of the listeners array for the event.
-   * No checks are made to see if the listener has already been added. Multiple calls passing
-   * the same combination of event and listener will result in the listener being added, and
-   * called, multiple times.
-   * @returns this ChatCompletionStream, so that calls can be chained
-   */
-  on<Event extends keyof Events>(event: Event, listener: ListenerForEvent<Events, Event>): this {
-    const listeners: ListenersForEvent<Events, Event> =
-      this.#listeners[event] || (this.#listeners[event] = []);
-    listeners.push({ listener });
-    return this;
-  }
-
-  /**
-   * Removes the specified listener from the listener array for the event.
-   * off() will remove, at most, one instance of a listener from the listener array. If any single
-   * listener has been added multiple times to the listener array for the specified event, then
-   * off() must be called multiple times to remove each instance.
-   * @returns this ChatCompletionStream, so that calls can be chained
-   */
-  off<Event extends keyof Events>(event: Event, listener: ListenerForEvent<Events, Event>): this {
-    const listeners = this.#listeners[event];
-    if (!listeners) return this;
-    const index = listeners.findIndex((l) => l.listener === listener);
-    if (index >= 0) listeners.splice(index, 1);
-    return this;
-  }
-
-  /**
-   * Adds a one-time listener function for the event. The next time the event is triggered,
-   * this listener is removed and then invoked.
-   * @returns this ChatCompletionStream, so that calls can be chained
-   */
-  once<Event extends keyof Events>(event: Event, listener: ListenerForEvent<Events, Event>): this {
-    const listeners: ListenersForEvent<Events, Event> =
-      this.#listeners[event] || (this.#listeners[event] = []);
-    listeners.push({ listener, once: true });
-    return this;
-  }
-
-  /**
-   * This is similar to `.once()`, but returns a Promise that resolves the next time
-   * the event is triggered, instead of calling a listener callback.
-   * @returns a Promise that resolves the next time given event is triggered,
-   * or rejects if an error is emitted.  (If you request the 'error' event,
-   * returns a promise that resolves with the error).
-   *
-   * Example:
-   *
-   *   const message = await stream.emitted('message') // rejects if the stream errors
-   */
-  emitted<Event extends keyof Events>(
-    event: Event,
-  ): Promise<
-    EventParameters<Events, Event> extends [infer Param] ? Param
-    : EventParameters<Events, Event> extends [] ? void
-    : EventParameters<Events, Event>
-  > {
-    return new Promise((resolve, reject) => {
-      this.#catchingPromiseCreated = true;
-      if (event !== 'error') this.once('error', reject);
-      this.once(event, resolve as any);
-    });
-  }
-
-  async done(): Promise<void> {
-    this.#catchingPromiseCreated = true;
-    await this.#endPromise;
-  }
-
   /**
    * @returns a promise that resolves with the final ChatCompletion, or rejects
    * if an error occurred or the stream ended prematurely without producing a ChatCompletion.
@@ -327,75 +195,7 @@ export abstract class AbstractChatCompletionRunner<
     return [...this._chatCompletions];
   }
 
-  #handleError = (error: unknown) => {
-    this.#errored = true;
-    if (error instanceof Error && error.name === 'AbortError') {
-      error = new APIUserAbortError();
-    }
-    if (error instanceof APIUserAbortError) {
-      this.#aborted = true;
-      return this._emit('abort', error);
-    }
-    if (error instanceof OpenAIError) {
-      return this._emit('error', error);
-    }
-    if (error instanceof Error) {
-      const openAIError: OpenAIError = new OpenAIError(error.message);
-      // @ts-ignore
-      openAIError.cause = error;
-      return this._emit('error', openAIError);
-    }
-    return this._emit('error', new OpenAIError(String(error)));
-  };
-
-  protected _emit<Event extends keyof Events>(event: Event, ...args: EventParameters<Events, Event>) {
-    // make sure we don't emit any events after end
-    if (this.#ended) {
-      return;
-    }
-
-    if (event === 'end') {
-      this.#ended = true;
-      this.#resolveEndPromise();
-    }
-
-    const listeners: ListenersForEvent<Events, Event> | undefined = this.#listeners[event];
-    if (listeners) {
-      this.#listeners[event] = listeners.filter((l) => !l.once) as any;
-      listeners.forEach(({ listener }: any) => listener(...args));
-    }
-
-    if (event === 'abort') {
-      const error = args[0] as APIUserAbortError;
-      if (!this.#catchingPromiseCreated && !listeners?.length) {
-        Promise.reject(error);
-      }
-      this.#rejectConnectedPromise(error);
-      this.#rejectEndPromise(error);
-      this._emit('end');
-      return;
-    }
-
-    if (event === 'error') {
-      // NOTE: _emit('error', error) should only be called from #handleError().
-
-      const error = args[0] as OpenAIError;
-      if (!this.#catchingPromiseCreated && !listeners?.length) {
-        // Trigger an unhandled rejection if the user hasn't registered any error handlers.
-        // If you are seeing stack traces here, make sure to handle errors via either:
-        // - runner.on('error', () => ...)
-        // - await runner.done()
-        // - await runner.finalChatCompletion()
-        // - etc.
-        Promise.reject(error);
-      }
-      this.#rejectConnectedPromise(error);
-      this.#rejectEndPromise(error);
-      this._emit('end');
-    }
-  }
-
-  protected _emitFinal() {
+  protected override _emitFinal(this: AbstractChatCompletionRunner) {
     const completion = this._chatCompletions[this._chatCompletions.length - 1];
     if (completion) this._emit('finalChatCompletion', completion);
     const finalMessage = this.#getFinalMessage();
@@ -650,27 +450,7 @@ export abstract class AbstractChatCompletionRunner<
   }
 }
 
-type CustomEvents<Event extends string> = {
-  [k in Event]: k extends keyof AbstractChatCompletionRunnerEvents ? AbstractChatCompletionRunnerEvents[k]
-  : (...args: any[]) => void;
-};
-
-type ListenerForEvent<Events extends CustomEvents<any>, Event extends keyof Events> = Event extends (
-  keyof AbstractChatCompletionRunnerEvents
-) ?
-  AbstractChatCompletionRunnerEvents[Event]
-: Events[Event];
-
-type ListenersForEvent<Events extends CustomEvents<any>, Event extends keyof Events> = Array<{
-  listener: ListenerForEvent<Events, Event>;
-  once?: boolean;
-}>;
-type EventParameters<Events extends CustomEvents<any>, Event extends keyof Events> = Parameters<
-  ListenerForEvent<Events, Event>
->;
-
-export interface AbstractChatCompletionRunnerEvents {
-  connect: () => void;
+export interface AbstractChatCompletionRunnerEvents extends BaseEvents {
   functionCall: (functionCall: ChatCompletionMessage.FunctionCall) => void;
   message: (message: ChatCompletionMessageParam) => void;
   chatCompletion: (completion: ChatCompletion) => void;
@@ -680,8 +460,5 @@ export interface AbstractChatCompletionRunnerEvents {
   finalFunctionCall: (functionCall: ChatCompletionMessage.FunctionCall) => void;
   functionCallResult: (content: string) => void;
   finalFunctionCallResult: (content: string) => void;
-  error: (error: OpenAIError) => void;
-  abort: (error: APIUserAbortError) => void;
-  end: () => void;
   totalUsage: (usage: CompletionUsage) => void;
 }
diff --git a/src/lib/AssistantStream.ts b/src/lib/AssistantStream.ts
index de7511b5d..c3cdfc3e5 100644
--- a/src/lib/AssistantStream.ts
+++ b/src/lib/AssistantStream.ts
@@ -19,10 +19,6 @@ import {
   RunSubmitToolOutputsParamsBase,
   RunSubmitToolOutputsParamsStreaming,
 } from 'openai/resources/beta/threads/runs/runs';
-import {
-  AbstractAssistantRunnerEvents,
-  AbstractAssistantStreamRunner,
-} from './AbstractAssistantStreamRunner';
 import { type ReadableStream } from 'openai/_shims/index';
 import { Stream } from 'openai/streaming';
 import { APIUserAbortError, OpenAIError } from 'openai/error';
@@ -34,9 +30,12 @@ import {
 } from 'openai/resources/beta/assistants';
 import { RunStep, RunStepDelta, ToolCall, ToolCallDelta } from 'openai/resources/beta/threads/runs/steps';
 import { ThreadCreateAndRunParamsBase, Threads } from 'openai/resources/beta/threads/threads';
+import { BaseEvents, EventStream } from './EventStream';
 import MessageDelta = Messages.MessageDelta;
 
-export interface AssistantStreamEvents extends AbstractAssistantRunnerEvents {
+export interface AssistantStreamEvents extends BaseEvents {
+  run: (run: Run) => void;
+
   //New event structure
   messageCreated: (message: Message) => void;
   messageDelta: (message: MessageDelta, snapshot: Message) => void;
@@ -57,8 +56,6 @@ export interface AssistantStreamEvents extends AbstractAssistantRunnerEvents {
   //No created or delta as this is not streamed
   imageFileDone: (content: ImageFile, snapshot: Message) => void;
 
-  end: () => void;
-
   event: (event: AssistantStreamEvent) => void;
 }
 
@@ -74,10 +71,9 @@ export type RunSubmitToolOutputsParamsStream = Omit<RunSubmitToolOutputsParamsBa
   stream?: true;
 };
 
-export class AssistantStream
-  extends AbstractAssistantStreamRunner<AssistantStreamEvents>
-  implements AsyncIterable<AssistantStreamEvent>
-{
+export class AssistantStream extends EventStream implements AsyncIterable<AssistantStreamEvent> {
+  declare _Events: AssistantStreamEvents;
+
   //Track all events in a single list for reference
   #events: AssistantStreamEvent[] = [];
 
@@ -207,7 +203,7 @@ export class AssistantStream
     return runner;
   }
 
-  protected override async _createToolAssistantStream(
+  protected async _createToolAssistantStream(
     run: Runs,
     threadId: string,
     runId: string,
@@ -304,7 +300,7 @@ export class AssistantStream
     return this.#finalRun;
   }
 
-  protected override async _createThreadAssistantStream(
+  protected async _createThreadAssistantStream(
     thread: Threads,
     params: ThreadCreateAndRunParamsBase,
     options?: Core.RequestOptions,
@@ -330,7 +326,7 @@ export class AssistantStream
     return this._addRun(this.#endRequest());
   }
 
-  protected override async _createAssistantStream(
+  protected async _createAssistantStream(
     run: Runs,
     threadId: string,
     params: RunCreateParamsBase,
@@ -417,7 +413,7 @@ export class AssistantStream
     return this.#finalRun;
   }
 
-  #handleMessage(event: MessageStreamEvent) {
+  #handleMessage(this: AssistantStream, event: MessageStreamEvent) {
     const [accumulatedMessage, newContent] = this.#accumulateMessage(event, this.#messageSnapshot);
     this.#messageSnapshot = accumulatedMessage;
     this.#messageSnapshots[accumulatedMessage.id] = accumulatedMessage;
@@ -500,7 +496,7 @@ export class AssistantStream
     }
   }
 
-  #handleRunStep(event: RunStepStreamEvent) {
+  #handleRunStep(this: AssistantStream, event: RunStepStreamEvent) {
     const accumulatedRunStep = this.#accumulateRunStep(event);
     this.#currentRunStepSnapshot = accumulatedRunStep;
 
@@ -556,7 +552,7 @@ export class AssistantStream
     }
   }
 
-  #handleEvent(event: AssistantStreamEvent) {
+  #handleEvent(this: AssistantStream, event: AssistantStreamEvent) {
     this.#events.push(event);
     this._emit('event', event);
   }
@@ -696,7 +692,7 @@ export class AssistantStream
     return acc;
   }
 
-  #handleRun(event: RunStreamEvent) {
+  #handleRun(this: AssistantStream, event: RunStreamEvent) {
     this.#currentRunSnapshot = event.data;
     switch (event.event) {
       case 'thread.run.created':
@@ -720,4 +716,35 @@ export class AssistantStream
         break;
     }
   }
+
+  protected _addRun(run: Run): Run {
+    return run;
+  }
+
+  protected async _threadAssistantStream(
+    body: ThreadCreateAndRunParamsBase,
+    thread: Threads,
+    options?: Core.RequestOptions,
+  ): Promise<Run> {
+    return await this._createThreadAssistantStream(thread, body, options);
+  }
+
+  protected async _runAssistantStream(
+    threadId: string,
+    runs: Runs,
+    params: RunCreateParamsBase,
+    options?: Core.RequestOptions,
+  ): Promise<Run> {
+    return await this._createAssistantStream(runs, threadId, params, options);
+  }
+
+  protected async _runToolAssistantStream(
+    threadId: string,
+    runId: string,
+    runs: Runs,
+    params: RunSubmitToolOutputsParamsStream,
+    options?: Core.RequestOptions,
+  ): Promise<Run> {
+    return await this._createToolAssistantStream(runs, threadId, runId, params, options);
+  }
 }
diff --git a/src/lib/ChatCompletionRunner.ts b/src/lib/ChatCompletionRunner.ts
index a110f0192..297d74cf3 100644
--- a/src/lib/ChatCompletionRunner.ts
+++ b/src/lib/ChatCompletionRunner.ts
@@ -29,7 +29,9 @@ export type ChatCompletionToolRunnerParams<FunctionsArgs extends BaseFunctionsAr
   tools: RunnableTools<FunctionsArgs>;
 };
 
-export class ChatCompletionRunner extends AbstractChatCompletionRunner<ChatCompletionRunnerEvents> {
+export class ChatCompletionRunner extends AbstractChatCompletionRunner {
+  declare _Events: ChatCompletionRunnerEvents;
+
   /** @deprecated - please use `runTools` instead. */
   static runFunctions(
     completions: Completions,
@@ -59,7 +61,7 @@ export class ChatCompletionRunner extends AbstractChatCompletionRunner<ChatCompl
     return runner;
   }
 
-  override _addMessage(message: ChatCompletionMessageParam) {
+  override _addMessage(this: ChatCompletionRunner, message: ChatCompletionMessageParam) {
     super._addMessage(message);
     if (isAssistantMessage(message) && message.content) {
       this._emit('content', message.content as string);
diff --git a/src/lib/ChatCompletionStream.ts b/src/lib/ChatCompletionStream.ts
index 2ea040383..95b3041bc 100644
--- a/src/lib/ChatCompletionStream.ts
+++ b/src/lib/ChatCompletionStream.ts
@@ -24,9 +24,11 @@ export type ChatCompletionStreamParams = Omit<ChatCompletionCreateParamsBase, 's
 };
 
 export class ChatCompletionStream
-  extends AbstractChatCompletionRunner<ChatCompletionStreamEvents>
+  extends AbstractChatCompletionRunner
   implements AsyncIterable<ChatCompletionChunk>
 {
+  declare _Events: ChatCompletionStreamEvents;
+
   #currentChatCompletionSnapshot: ChatCompletionSnapshot | undefined;
 
   get currentChatCompletionSnapshot(): ChatCompletionSnapshot | undefined {
@@ -66,7 +68,7 @@ export class ChatCompletionStream
     if (this.ended) return;
     this.#currentChatCompletionSnapshot = undefined;
   }
-  #addChunk(chunk: ChatCompletionChunk) {
+  #addChunk(this: ChatCompletionStream, chunk: ChatCompletionChunk) {
     if (this.ended) return;
     const completion = this.#accumulateChatCompletion(chunk);
     this._emit('chunk', chunk, completion);
@@ -208,7 +210,7 @@ export class ChatCompletionStream
     return snapshot;
   }
 
-  [Symbol.asyncIterator](): AsyncIterator<ChatCompletionChunk> {
+  [Symbol.asyncIterator](this: ChatCompletionStream): AsyncIterator<ChatCompletionChunk> {
     const pushQueue: ChatCompletionChunk[] = [];
     const readQueue: {
       resolve: (chunk: ChatCompletionChunk | undefined) => void;
diff --git a/src/lib/AbstractAssistantStreamRunner.ts b/src/lib/EventStream.ts
similarity index 55%
rename from src/lib/AbstractAssistantStreamRunner.ts
rename to src/lib/EventStream.ts
index b600f0df3..c24eb35a0 100644
--- a/src/lib/AbstractAssistantStreamRunner.ts
+++ b/src/lib/EventStream.ts
@@ -1,12 +1,8 @@
-import * as Core from 'openai/core';
 import { APIUserAbortError, OpenAIError } from 'openai/error';
-import { Run, RunSubmitToolOutputsParamsBase } from 'openai/resources/beta/threads/runs/runs';
-import { RunCreateParamsBase, Runs } from 'openai/resources/beta/threads/runs/runs';
-import { ThreadCreateAndRunParamsBase, Threads } from 'openai/resources/beta/threads/threads';
 
-export abstract class AbstractAssistantStreamRunner<
-  Events extends CustomEvents<any> = AbstractAssistantRunnerEvents,
-> {
+export class EventStream {
+  declare _Events: BaseEvents;
+
   controller: AbortController = new AbortController();
 
   #connectedPromise: Promise<void>;
@@ -17,7 +13,9 @@ export abstract class AbstractAssistantStreamRunner<
   #resolveEndPromise: () => void = () => {};
   #rejectEndPromise: (error: OpenAIError) => void = () => {};
 
-  #listeners: { [Event in keyof Events]?: ListenersForEvent<Events, Event> } = {};
+  #listeners: {
+    [Event in keyof (typeof this)['_Events']]?: EventListeners<(typeof this)['_Events'], Event>;
+  } = {};
 
   #ended = false;
   #errored = false;
@@ -43,22 +41,18 @@ export abstract class AbstractAssistantStreamRunner<
     this.#endPromise.catch(() => {});
   }
 
-  protected _run(executor: () => Promise<any>) {
+  protected _run(this: EventStream, executor: () => Promise<any>) {
     // Unfortunately if we call `executor()` immediately we get runtime errors about
     // references to `this` before the `super()` constructor call returns.
     setTimeout(() => {
       executor().then(() => {
-        // this._emitFinal();
+        this._emitFinal();
         this._emit('end');
       }, this.#handleError);
     }, 0);
   }
 
-  protected _addRun(run: Run): Run {
-    return run;
-  }
-
-  protected _connected() {
+  protected _connected(this: EventStream) {
     if (this.ended) return;
     this.#resolveConnectedPromise();
     this._emit('connect');
@@ -87,8 +81,11 @@ export abstract class AbstractAssistantStreamRunner<
    * called, multiple times.
    * @returns this ChatCompletionStream, so that calls can be chained
    */
-  on<Event extends keyof Events>(event: Event, listener: ListenerForEvent<Events, Event>): this {
-    const listeners: ListenersForEvent<Events, Event> =
+  on<Event extends keyof (typeof this)['_Events']>(
+    event: Event,
+    listener: EventListener<(typeof this)['_Events'], Event>,
+  ): this {
+    const listeners: EventListeners<(typeof this)['_Events'], Event> =
       this.#listeners[event] || (this.#listeners[event] = []);
     listeners.push({ listener });
     return this;
@@ -101,7 +98,10 @@ export abstract class AbstractAssistantStreamRunner<
    * off() must be called multiple times to remove each instance.
    * @returns this ChatCompletionStream, so that calls can be chained
    */
-  off<Event extends keyof Events>(event: Event, listener: ListenerForEvent<Events, Event>): this {
+  off<Event extends keyof (typeof this)['_Events']>(
+    event: Event,
+    listener: EventListener<(typeof this)['_Events'], Event>,
+  ): this {
     const listeners = this.#listeners[event];
     if (!listeners) return this;
     const index = listeners.findIndex((l) => l.listener === listener);
@@ -114,8 +114,11 @@ export abstract class AbstractAssistantStreamRunner<
    * this listener is removed and then invoked.
    * @returns this ChatCompletionStream, so that calls can be chained
    */
-  once<Event extends keyof Events>(event: Event, listener: ListenerForEvent<Events, Event>): this {
-    const listeners: ListenersForEvent<Events, Event> =
+  once<Event extends keyof (typeof this)['_Events']>(
+    event: Event,
+    listener: EventListener<(typeof this)['_Events'], Event>,
+  ): this {
+    const listeners: EventListeners<(typeof this)['_Events'], Event> =
       this.#listeners[event] || (this.#listeners[event] = []);
     listeners.push({ listener, once: true });
     return this;
@@ -132,12 +135,12 @@ export abstract class AbstractAssistantStreamRunner<
    *
    *   const message = await stream.emitted('message') // rejects if the stream errors
    */
-  emitted<Event extends keyof Events>(
+  emitted<Event extends keyof (typeof this)['_Events']>(
     event: Event,
   ): Promise<
-    EventParameters<Events, Event> extends [infer Param] ? Param
-    : EventParameters<Events, Event> extends [] ? void
-    : EventParameters<Events, Event>
+    EventParameters<(typeof this)['_Events'], Event> extends [infer Param] ? Param
+    : EventParameters<(typeof this)['_Events'], Event> extends [] ? void
+    : EventParameters<(typeof this)['_Events'], Event>
   > {
     return new Promise((resolve, reject) => {
       this.#catchingPromiseCreated = true;
@@ -151,7 +154,7 @@ export abstract class AbstractAssistantStreamRunner<
     await this.#endPromise;
   }
 
-  #handleError = (error: unknown) => {
+  #handleError(this: EventStream, error: unknown) {
     this.#errored = true;
     if (error instanceof Error && error.name === 'AbortError') {
       error = new APIUserAbortError();
@@ -170,9 +173,17 @@ export abstract class AbstractAssistantStreamRunner<
       return this._emit('error', openAIError);
     }
     return this._emit('error', new OpenAIError(String(error)));
-  };
+  }
 
-  protected _emit<Event extends keyof Events>(event: Event, ...args: EventParameters<Events, Event>) {
+  _emit<Event extends keyof (typeof this)['_Events']>(
+    event: Event,
+    ...args: EventParameters<(typeof this)['_Events'], Event>
+  ): void;
+  _emit<Event extends keyof (typeof this)['_Events']>(
+    this: EventStream,
+    event: Event,
+    ...args: EventParameters<(typeof this)['_Events'], Event>
+  ) {
     // make sure we don't emit any events after end
     if (this.#ended) {
       return;
@@ -183,10 +194,10 @@ export abstract class AbstractAssistantStreamRunner<
       this.#resolveEndPromise();
     }
 
-    const listeners: ListenersForEvent<Events, Event> | undefined = this.#listeners[event];
+    const listeners: EventListeners<(typeof this)['_Events'], Event> | undefined = this.#listeners[event];
     if (listeners) {
       this.#listeners[event] = listeners.filter((l) => !l.once) as any;
-      listeners.forEach(({ listener }: any) => listener(...args));
+      listeners.forEach(({ listener }: any) => listener(...(args as any)));
     }
 
     if (event === 'abort') {
@@ -219,121 +230,22 @@ export abstract class AbstractAssistantStreamRunner<
     }
   }
 
-  protected async _threadAssistantStream(
-    body: ThreadCreateAndRunParamsBase,
-    thread: Threads,
-    options?: Core.RequestOptions,
-  ): Promise<Run> {
-    return await this._createThreadAssistantStream(thread, body, options);
-  }
-
-  protected async _runAssistantStream(
-    threadId: string,
-    runs: Runs,
-    params: RunCreateParamsBase,
-    options?: Core.RequestOptions,
-  ): Promise<Run> {
-    return await this._createAssistantStream(runs, threadId, params, options);
-  }
-
-  protected async _runToolAssistantStream(
-    threadId: string,
-    runId: string,
-    runs: Runs,
-    params: RunSubmitToolOutputsParamsBase,
-    options?: Core.RequestOptions,
-  ): Promise<Run> {
-    return await this._createToolAssistantStream(runs, threadId, runId, params, options);
-  }
-
-  protected async _createThreadAssistantStream(
-    thread: Threads,
-    body: ThreadCreateAndRunParamsBase,
-    options?: Core.RequestOptions,
-  ): Promise<Run> {
-    const signal = options?.signal;
-    if (signal) {
-      if (signal.aborted) this.controller.abort();
-      signal.addEventListener('abort', () => this.controller.abort());
-    }
-    // this.#validateParams(params);
-
-    const runResult = await thread.createAndRun(
-      { ...body, stream: false },
-      { ...options, signal: this.controller.signal },
-    );
-    this._connected();
-    return this._addRun(runResult as Run);
-  }
-
-  protected async _createToolAssistantStream(
-    run: Runs,
-    threadId: string,
-    runId: string,
-    params: RunSubmitToolOutputsParamsBase,
-    options?: Core.RequestOptions,
-  ): Promise<Run> {
-    const signal = options?.signal;
-    if (signal) {
-      if (signal.aborted) this.controller.abort();
-      signal.addEventListener('abort', () => this.controller.abort());
-    }
-
-    const runResult = await run.submitToolOutputs(
-      threadId,
-      runId,
-      { ...params, stream: false },
-      { ...options, signal: this.controller.signal },
-    );
-    this._connected();
-    return this._addRun(runResult as Run);
-  }
-
-  protected async _createAssistantStream(
-    run: Runs,
-    threadId: string,
-    params: RunCreateParamsBase,
-    options?: Core.RequestOptions,
-  ): Promise<Run> {
-    const signal = options?.signal;
-    if (signal) {
-      if (signal.aborted) this.controller.abort();
-      signal.addEventListener('abort', () => this.controller.abort());
-    }
-    // this.#validateParams(params);
-
-    const runResult = await run.create(
-      threadId,
-      { ...params, stream: false },
-      { ...options, signal: this.controller.signal },
-    );
-    this._connected();
-    return this._addRun(runResult as Run);
-  }
+  protected _emitFinal(): void {}
 }
 
-type CustomEvents<Event extends string> = {
-  [k in Event]: k extends keyof AbstractAssistantRunnerEvents ? AbstractAssistantRunnerEvents[k]
-  : (...args: any[]) => void;
-};
-
-type ListenerForEvent<Events extends CustomEvents<any>, Event extends keyof Events> = Event extends (
-  keyof AbstractAssistantRunnerEvents
-) ?
-  AbstractAssistantRunnerEvents[Event]
-: Events[Event];
+type EventListener<Events, EventType extends keyof Events> = Events[EventType];
 
-type ListenersForEvent<Events extends CustomEvents<any>, Event extends keyof Events> = Array<{
-  listener: ListenerForEvent<Events, Event>;
+type EventListeners<Events, EventType extends keyof Events> = Array<{
+  listener: EventListener<Events, EventType>;
   once?: boolean;
 }>;
-type EventParameters<Events extends CustomEvents<any>, Event extends keyof Events> = Parameters<
-  ListenerForEvent<Events, Event>
->;
 
-export interface AbstractAssistantRunnerEvents {
+export type EventParameters<Events, EventType extends keyof Events> = {
+  [Event in EventType]: EventListener<Events, EventType> extends (...args: infer P) => any ? P : never;
+}[EventType];
+
+export interface BaseEvents {
   connect: () => void;
-  run: (run: Run) => void;
   error: (error: OpenAIError) => void;
   abort: (error: APIUserAbortError) => void;
   end: () => void;

From 1ad508552e93b5a04f9d50e91fdc24e4b9de5260 Mon Sep 17 00:00:00 2001
From: Robert Craigie <robert@craigie.dev>
Date: Fri, 19 Jul 2024 13:37:04 +0100
Subject: [PATCH 2/4] a solution

---
 src/lib/AbstractChatCompletionRunner.ts | 11 ++---
 src/lib/AssistantStream.ts              |  4 +-
 src/lib/ChatCompletionRunner.ts         |  4 +-
 src/lib/ChatCompletionStream.ts         |  4 +-
 src/lib/EventStream.ts                  | 53 ++++++++++---------------
 5 files changed, 29 insertions(+), 47 deletions(-)

diff --git a/src/lib/AbstractChatCompletionRunner.ts b/src/lib/AbstractChatCompletionRunner.ts
index 627b9fbba..6c7c2ff8e 100644
--- a/src/lib/AbstractChatCompletionRunner.ts
+++ b/src/lib/AbstractChatCompletionRunner.ts
@@ -28,14 +28,15 @@ export interface RunnerOptions extends Core.RequestOptions {
   maxChatCompletions?: number;
 }
 
-export class AbstractChatCompletionRunner extends EventStream {
-  declare _Events: AbstractChatCompletionRunnerEvents;
+export class AbstractChatCompletionRunner<
+  EventTypes extends AbstractChatCompletionRunnerEvents,
+> extends EventStream<EventTypes> {
 
   protected _chatCompletions: ChatCompletion[] = [];
   messages: ChatCompletionMessageParam[] = [];
 
   protected _addChatCompletion(
-    this: AbstractChatCompletionRunner,
+    this: AbstractChatCompletionRunner<AbstractChatCompletionRunnerEvents>,
     chatCompletion: ChatCompletion,
   ): ChatCompletion {
     this._chatCompletions.push(chatCompletion);
@@ -46,7 +47,7 @@ export class AbstractChatCompletionRunner extends EventStream {
   }
 
   protected _addMessage(
-    this: AbstractChatCompletionRunner,
+    this: AbstractChatCompletionRunner<AbstractChatCompletionRunnerEvents>,
     message: ChatCompletionMessageParam,
     emit = true,
   ) {
@@ -195,7 +196,7 @@ export class AbstractChatCompletionRunner extends EventStream {
     return [...this._chatCompletions];
   }
 
-  protected override _emitFinal(this: AbstractChatCompletionRunner) {
+  protected override _emitFinal(this: AbstractChatCompletionRunner<AbstractChatCompletionRunnerEvents>) {
     const completion = this._chatCompletions[this._chatCompletions.length - 1];
     if (completion) this._emit('finalChatCompletion', completion);
     const finalMessage = this.#getFinalMessage();
diff --git a/src/lib/AssistantStream.ts b/src/lib/AssistantStream.ts
index c3cdfc3e5..5095e4878 100644
--- a/src/lib/AssistantStream.ts
+++ b/src/lib/AssistantStream.ts
@@ -71,9 +71,7 @@ export type RunSubmitToolOutputsParamsStream = Omit<RunSubmitToolOutputsParamsBa
   stream?: true;
 };
 
-export class AssistantStream extends EventStream implements AsyncIterable<AssistantStreamEvent> {
-  declare _Events: AssistantStreamEvents;
-
+export class AssistantStream extends EventStream<AssistantStreamEvents> implements AsyncIterable<AssistantStreamEvent> {
   //Track all events in a single list for reference
   #events: AssistantStreamEvent[] = [];
 
diff --git a/src/lib/ChatCompletionRunner.ts b/src/lib/ChatCompletionRunner.ts
index 297d74cf3..c756919b0 100644
--- a/src/lib/ChatCompletionRunner.ts
+++ b/src/lib/ChatCompletionRunner.ts
@@ -29,9 +29,7 @@ export type ChatCompletionToolRunnerParams<FunctionsArgs extends BaseFunctionsAr
   tools: RunnableTools<FunctionsArgs>;
 };
 
-export class ChatCompletionRunner extends AbstractChatCompletionRunner {
-  declare _Events: ChatCompletionRunnerEvents;
-
+export class ChatCompletionRunner extends AbstractChatCompletionRunner<ChatCompletionRunnerEvents> {
   /** @deprecated - please use `runTools` instead. */
   static runFunctions(
     completions: Completions,
diff --git a/src/lib/ChatCompletionStream.ts b/src/lib/ChatCompletionStream.ts
index 95b3041bc..5eee904a2 100644
--- a/src/lib/ChatCompletionStream.ts
+++ b/src/lib/ChatCompletionStream.ts
@@ -24,11 +24,9 @@ export type ChatCompletionStreamParams = Omit<ChatCompletionCreateParamsBase, 's
 };
 
 export class ChatCompletionStream
-  extends AbstractChatCompletionRunner
+  extends AbstractChatCompletionRunner<ChatCompletionStreamEvents>
   implements AsyncIterable<ChatCompletionChunk>
 {
-  declare _Events: ChatCompletionStreamEvents;
-
   #currentChatCompletionSnapshot: ChatCompletionSnapshot | undefined;
 
   get currentChatCompletionSnapshot(): ChatCompletionSnapshot | undefined {
diff --git a/src/lib/EventStream.ts b/src/lib/EventStream.ts
index c24eb35a0..c4e3825be 100644
--- a/src/lib/EventStream.ts
+++ b/src/lib/EventStream.ts
@@ -1,8 +1,6 @@
 import { APIUserAbortError, OpenAIError } from 'openai/error';
 
-export class EventStream {
-  declare _Events: BaseEvents;
-
+export class EventStream<EventTypes extends BaseEvents> {
   controller: AbortController = new AbortController();
 
   #connectedPromise: Promise<void>;
@@ -14,7 +12,7 @@ export class EventStream {
   #rejectEndPromise: (error: OpenAIError) => void = () => {};
 
   #listeners: {
-    [Event in keyof (typeof this)['_Events']]?: EventListeners<(typeof this)['_Events'], Event>;
+    [Event in keyof EventTypes]?: EventListeners<EventTypes, Event>;
   } = {};
 
   #ended = false;
@@ -41,7 +39,7 @@ export class EventStream {
     this.#endPromise.catch(() => {});
   }
 
-  protected _run(this: EventStream, executor: () => Promise<any>) {
+  protected _run(this: EventStream<EventTypes>, executor: () => Promise<any>) {
     // Unfortunately if we call `executor()` immediately we get runtime errors about
     // references to `this` before the `super()` constructor call returns.
     setTimeout(() => {
@@ -52,7 +50,7 @@ export class EventStream {
     }, 0);
   }
 
-  protected _connected(this: EventStream) {
+  protected _connected(this: EventStream<EventTypes>) {
     if (this.ended) return;
     this.#resolveConnectedPromise();
     this._emit('connect');
@@ -81,11 +79,8 @@ export class EventStream {
    * called, multiple times.
    * @returns this ChatCompletionStream, so that calls can be chained
    */
-  on<Event extends keyof (typeof this)['_Events']>(
-    event: Event,
-    listener: EventListener<(typeof this)['_Events'], Event>,
-  ): this {
-    const listeners: EventListeners<(typeof this)['_Events'], Event> =
+  on<Event extends keyof EventTypes>(event: Event, listener: EventListener<EventTypes, Event>): this {
+    const listeners: EventListeners<EventTypes, Event> =
       this.#listeners[event] || (this.#listeners[event] = []);
     listeners.push({ listener });
     return this;
@@ -98,10 +93,7 @@ export class EventStream {
    * off() must be called multiple times to remove each instance.
    * @returns this ChatCompletionStream, so that calls can be chained
    */
-  off<Event extends keyof (typeof this)['_Events']>(
-    event: Event,
-    listener: EventListener<(typeof this)['_Events'], Event>,
-  ): this {
+  off<Event extends keyof EventTypes>(event: Event, listener: EventListener<EventTypes, Event>): this {
     const listeners = this.#listeners[event];
     if (!listeners) return this;
     const index = listeners.findIndex((l) => l.listener === listener);
@@ -114,11 +106,8 @@ export class EventStream {
    * this listener is removed and then invoked.
    * @returns this ChatCompletionStream, so that calls can be chained
    */
-  once<Event extends keyof (typeof this)['_Events']>(
-    event: Event,
-    listener: EventListener<(typeof this)['_Events'], Event>,
-  ): this {
-    const listeners: EventListeners<(typeof this)['_Events'], Event> =
+  once<Event extends keyof EventTypes>(event: Event, listener: EventListener<EventTypes, Event>): this {
+    const listeners: EventListeners<EventTypes, Event> =
       this.#listeners[event] || (this.#listeners[event] = []);
     listeners.push({ listener, once: true });
     return this;
@@ -135,12 +124,12 @@ export class EventStream {
    *
    *   const message = await stream.emitted('message') // rejects if the stream errors
    */
-  emitted<Event extends keyof (typeof this)['_Events']>(
+  emitted<Event extends keyof EventTypes>(
     event: Event,
   ): Promise<
-    EventParameters<(typeof this)['_Events'], Event> extends [infer Param] ? Param
-    : EventParameters<(typeof this)['_Events'], Event> extends [] ? void
-    : EventParameters<(typeof this)['_Events'], Event>
+    EventParameters<EventTypes, Event> extends [infer Param] ? Param
+    : EventParameters<EventTypes, Event> extends [] ? void
+    : EventParameters<EventTypes, Event>
   > {
     return new Promise((resolve, reject) => {
       this.#catchingPromiseCreated = true;
@@ -154,7 +143,7 @@ export class EventStream {
     await this.#endPromise;
   }
 
-  #handleError(this: EventStream, error: unknown) {
+  #handleError(this: EventStream<EventTypes>, error: unknown) {
     this.#errored = true;
     if (error instanceof Error && error.name === 'AbortError') {
       error = new APIUserAbortError();
@@ -175,14 +164,12 @@ export class EventStream {
     return this._emit('error', new OpenAIError(String(error)));
   }
 
-  _emit<Event extends keyof (typeof this)['_Events']>(
-    event: Event,
-    ...args: EventParameters<(typeof this)['_Events'], Event>
-  ): void;
-  _emit<Event extends keyof (typeof this)['_Events']>(
-    this: EventStream,
+  _emit<Event extends keyof BaseEvents>(event: Event, ...args: EventParameters<BaseEvents, Event>): void;
+  _emit<Event extends keyof EventTypes>(event: Event, ...args: EventParameters<EventTypes, Event>): void;
+  _emit<Event extends keyof EventTypes>(
+    this: EventStream<EventTypes>,
     event: Event,
-    ...args: EventParameters<(typeof this)['_Events'], Event>
+    ...args: EventParameters<EventTypes, Event>
   ) {
     // make sure we don't emit any events after end
     if (this.#ended) {
@@ -194,7 +181,7 @@ export class EventStream {
       this.#resolveEndPromise();
     }
 
-    const listeners: EventListeners<(typeof this)['_Events'], Event> | undefined = this.#listeners[event];
+    const listeners: EventListeners<EventTypes, Event> | undefined = this.#listeners[event];
     if (listeners) {
       this.#listeners[event] = listeners.filter((l) => !l.once) as any;
       listeners.forEach(({ listener }: any) => listener(...(args as any)));

From f41a982c10ef20555be934fe790704e015ebcbdb Mon Sep 17 00:00:00 2001
From: Young-Jin Park <youngjinpark20@gmail.com>
Date: Tue, 23 Jul 2024 10:17:37 -0400
Subject: [PATCH 3/4] Bind this

---
 src/lib/EventStream.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/lib/EventStream.ts b/src/lib/EventStream.ts
index c4e3825be..a18c771dd 100644
--- a/src/lib/EventStream.ts
+++ b/src/lib/EventStream.ts
@@ -46,7 +46,7 @@ export class EventStream<EventTypes extends BaseEvents> {
       executor().then(() => {
         this._emitFinal();
         this._emit('end');
-      }, this.#handleError);
+      }, this.#handleError.bind(this));
     }, 0);
   }
 

From 1e3bd9fdd3935fb03dddd1b709188ba71ac7a60b Mon Sep 17 00:00:00 2001
From: Robert Craigie <robert@craigie.dev>
Date: Tue, 30 Jul 2024 14:03:16 +0100
Subject: [PATCH 4/4] fix formatting

---
 src/lib/AbstractChatCompletionRunner.ts | 1 -
 src/lib/AssistantStream.ts              | 5 ++++-
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/src/lib/AbstractChatCompletionRunner.ts b/src/lib/AbstractChatCompletionRunner.ts
index 6c7c2ff8e..590013aa6 100644
--- a/src/lib/AbstractChatCompletionRunner.ts
+++ b/src/lib/AbstractChatCompletionRunner.ts
@@ -31,7 +31,6 @@ export interface RunnerOptions extends Core.RequestOptions {
 export class AbstractChatCompletionRunner<
   EventTypes extends AbstractChatCompletionRunnerEvents,
 > extends EventStream<EventTypes> {
-
   protected _chatCompletions: ChatCompletion[] = [];
   messages: ChatCompletionMessageParam[] = [];
 
diff --git a/src/lib/AssistantStream.ts b/src/lib/AssistantStream.ts
index 5095e4878..0f88530b3 100644
--- a/src/lib/AssistantStream.ts
+++ b/src/lib/AssistantStream.ts
@@ -71,7 +71,10 @@ export type RunSubmitToolOutputsParamsStream = Omit<RunSubmitToolOutputsParamsBa
   stream?: true;
 };
 
-export class AssistantStream extends EventStream<AssistantStreamEvents> implements AsyncIterable<AssistantStreamEvent> {
+export class AssistantStream
+  extends EventStream<AssistantStreamEvents>
+  implements AsyncIterable<AssistantStreamEvent>
+{
   //Track all events in a single list for reference
   #events: AssistantStreamEvent[] = [];