fix: Naming of Response

Author: asafgardin

.gitignore

@@ -123,4 +123,5 @@ dist/
 node_modules/
 .cursorrules
 .vscode/
-coverage/
+coverage/
+.env*

README.md

@@ -72,7 +72,7 @@ For detailed information about the available methods and their parameters, pleas
 
 ## Contributing
 
-If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request on the [GitHub repository](https://github.com/ai21-labs/api-client).
+If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request on the [GitHub repository](https://github.com/AI21Labs/ai21-typescript).
 
 ## License
 

src/APIClient.ts

@@ -7,7 +7,7 @@ import {
   APIResponseProps,
   HTTPMethod,
   Headers,
-  UnifiedResponse,
+  CrossPlatformResponse,
 } from './types';
 import { AI21EnvConfig } from './EnvConfig';
 import { createFetchInstance } from './runtime';
@@ -108,7 +108,7 @@ export abstract class APIClient {
       throw new AI21Error(`Request failed with status ${response.status}. ${await response.text()}`);
     }
 
-    return { response: response as UnifiedResponse, options };
+    return { response: response as CrossPlatformResponse, options };
   }
 
   protected isRunningInBrowser(): boolean {

src/Streaming/SSEDecoder.ts

@@ -1,10 +1,10 @@
 import { SSE_DATA_PREFIX } from './Consts';
 import { StreamingDecodeError } from '../errors';
-import { UnifiedResponse } from 'types';
+import { CrossPlatformResponse } from 'types';
 
 export interface SSEDecoder {
   decode(line: string): string | null;
-  iterLines(response: UnifiedResponse): AsyncIterableIterator<string>;
+  iterLines(response: CrossPlatformResponse): AsyncIterableIterator<string>;
 }
 
 abstract class BaseSSEDecoder implements SSEDecoder {
@@ -18,7 +18,7 @@ abstract class BaseSSEDecoder implements SSEDecoder {
     throw new StreamingDecodeError(`Invalid SSE line: ${line}`);
   }
 
-  abstract iterLines(response: UnifiedResponse): AsyncIterableIterator<string>;
+  abstract iterLines(response: CrossPlatformResponse): AsyncIterableIterator<string>;
 
   async *_iterLines(reader: ReadableStreamDefaultReader<Uint8Array>): AsyncIterableIterator<string> {
     let buffer = '';
@@ -51,7 +51,7 @@ abstract class BaseSSEDecoder implements SSEDecoder {
 }
 
 export class BrowserSSEDecoder extends BaseSSEDecoder {
-  async *iterLines(response: UnifiedResponse): AsyncIterableIterator<string> {
+  async *iterLines(response: CrossPlatformResponse): AsyncIterableIterator<string> {
     if (!response.body) {
       throw new Error('Response body is null');
     }
@@ -62,7 +62,7 @@ export class BrowserSSEDecoder extends BaseSSEDecoder {
 }
 
 export class NodeSSEDecoder extends BaseSSEDecoder {
-  async *iterLines(response: UnifiedResponse): AsyncIterableIterator<string> {
+  async *iterLines(response: CrossPlatformResponse): AsyncIterableIterator<string> {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const readerStream = (await import('stream/web')).ReadableStream as any;
     const reader = readerStream.from(response.body).getReader();

src/Streaming/Stream.ts

@@ -1,8 +1,7 @@
-import { BrowserSSEDecoder } from './SSEDecoder';
-import { SSEDecoder } from './SSEDecoder';
+import { SSEDecoder, BrowserSSEDecoder } from './SSEDecoder';
 import { SSE_DONE_MSG } from './Consts';
 import { StreamingDecodeError } from '../errors';
-import { UnifiedResponse } from '../types';
+import { CrossPlatformResponse } from '../types';
 
 function getStreamMessage<T>(chunk: string): T {
   try {
@@ -17,7 +16,7 @@ export class Stream<T> implements AsyncIterableIterator<T> {
   private iterator: AsyncIterableIterator<T>;
 
   constructor(
-    private response: UnifiedResponse,
+    private response: CrossPlatformResponse,
     decoder?: SSEDecoder,
   ) {
     this.decoder = decoder || new BrowserSSEDecoder();

src/Streaming/index.ts

@@ -1,2 +1,6 @@
 export { Stream } from './Stream';
-export { BrowserSSEDecoder, NodeSSEDecoder, SSEDecoder } from './SSEDecoder';
+export { 
+    BrowserSSEDecoder,
+    NodeSSEDecoder,
+    type SSEDecoder,
+} from './SSEDecoder';

src/fetch/BaseFetch.ts

@@ -1,14 +1,14 @@
 import { AI21Error } from '../errors';
 import { Stream } from '../Streaming';
-import { FinalRequestOptions, UnifiedResponse } from '../types';
+import { FinalRequestOptions, CrossPlatformResponse } from '../types';
 import { APIResponseProps } from '../types/API';
 
 export type APIResponse<T> = {
   data?: T;
-  response: UnifiedResponse;
+  response: CrossPlatformResponse;
 };
 export abstract class Fetch {
-  abstract call(url: string, options: FinalRequestOptions): Promise<UnifiedResponse>;
+  abstract call(url: string, options: FinalRequestOptions): Promise<CrossPlatformResponse>;
   async handleResponse<T>({ response, options }: APIResponseProps) {
     if (options.stream) {
       if (!response.body) {
@@ -21,5 +21,5 @@ export abstract class Fetch {
     const contentType = response.headers.get('content-type');
     return contentType?.includes('application/json') ? await response.json() : null;
   }
-  abstract handleStream<T>(response: UnifiedResponse): Stream<T>;
+  abstract handleStream<T>(response: CrossPlatformResponse): Stream<T>;
 }

src/fetch/BrowserFetch.ts

@@ -1,9 +1,9 @@
-import { FinalRequestOptions, UnifiedResponse } from 'types';
+import { FinalRequestOptions, CrossPlatformResponse } from 'types';
 import { Fetch } from './BaseFetch';
 import { Stream, BrowserSSEDecoder } from '../Streaming';
 
 export class BrowserFetch extends Fetch {
-  call(url: string, options: FinalRequestOptions): Promise<UnifiedResponse> {
+  call(url: string, options: FinalRequestOptions): Promise<CrossPlatformResponse> {
     const controller = new AbortController();
 
     return fetch(url, {
@@ -14,7 +14,7 @@ export class BrowserFetch extends Fetch {
     });
   }
 
-  handleStream<T>(response: UnifiedResponse): Stream<T> {
+  handleStream<T>(response: CrossPlatformResponse): Stream<T> {
     return new Stream<T>(response as Response, new BrowserSSEDecoder());
   }
 }

src/fetch/NodeFetch.ts

@@ -1,9 +1,9 @@
-import { FinalRequestOptions, UnifiedResponse } from 'types';
+import { FinalRequestOptions, CrossPlatformResponse } from 'types';
 import { Fetch } from './BaseFetch';
 import { Stream, NodeSSEDecoder } from '../Streaming';
 
 export class NodeFetch extends Fetch {
-  async call(url: string, options: FinalRequestOptions): Promise<UnifiedResponse> {
+  async call(url: string, options: FinalRequestOptions): Promise<CrossPlatformResponse> {
     const nodeFetchModule = await import('node-fetch');
     const nodeFetch = nodeFetchModule.default;
 
@@ -14,7 +14,7 @@ export class NodeFetch extends Fetch {
     });
   }
 
-  handleStream<T>(response: UnifiedResponse): Stream<T> {
+  handleStream<T>(response: CrossPlatformResponse): Stream<T> {
     type NodeRespose = import('node-fetch').Response;
     return new Stream<T>(response as NodeRespose, new NodeSSEDecoder());
   }

src/types/index.ts

@@ -34,7 +34,7 @@ export {
   type HTTPMethod,
   type DefaultQuery,
   type Headers,
-  type CrossPlatformResponse as UnifiedResponse,
+  type CrossPlatformResponse,
 } from './API';
 
 export {