👌 IMPROVE: Tests

Author: ahmadawais

.gitignore

@@ -16,3 +16,4 @@ public/dist
 /playwright-report/
 /blob-report/
 /playwright/.cache/
+.x*

packages/langbase/package.json

@@ -17,7 +17,8 @@
 		"clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
 		"type-check": "tsc --noEmit",
 		"prettier-check": "prettier --check \"./**/*.ts*\"",
-		"test": "pnpm test:node && pnpm test:edge && pnpm test:ui && pnpm test:e2e",
+		"test": "pnpm test:node && pnpm test:edge",
+		"#test": "pnpm test:node && pnpm test:edge && pnpm test:ui && pnpm test:e2e",
 		"test:edge": "vitest --config vitest.edge.config.js --run",
 		"test:node": "vitest --config vitest.node.config.js --run",
 		"test:ui": "pnpm test:ui:react",

packages/langbase/readme.md

@@ -4,11 +4,12 @@ The AI SDK for building declarative and composable AI-powered LLM products.
 
 ## Documentation
 
-Check the [Langbase SDK documentation](https://langbase.com/docs/langbase-sdk/overview) for more details.
+> [!NOTE]
+> Check the [Langbase SDK documentation](https://langbase.com/docs/langbase-sdk/overview) for more details.
 
 The following examples are for reference only. Prefer docs for the latest information.
 
-## Getting Started with `langbase` SDK
+## Getting started with `langbase` SDK
 
 ### Installation
 
@@ -30,91 +31,10 @@ or
 yarn add langbase
 ```
 
-### Usage
-
-You can [`generateText`](https://langbase.com/docs/langbase-sdk/generate-text) or [`streamText`](https://langbase.com/docs/langbase-sdk/stream-text) based on the type of a pipe.
-
-Check our [SDK documentation](https://langbase.com/docs/langbase-sdk/overview) for more details.
-
-### Example projects
-
-Check the following examples:
-
-- [Node: Generate Text](https://github.com/LangbaseInc/langbase-sdk/blob/main/examples/everything/generate-text.ts)
-- [Node: Stream Text](https://github.com/LangbaseInc/langbase-sdk/blob/main/examples/everything/stream-text.ts)
-- [Next.js Example](https://github.com/LangbaseInc/langbase-sdk/tree/main/examples/nextjs)
-  - TypeScript code
-  - [React component](https://github.com/LangbaseInc/langbase-sdk/tree/main/examples/nextjs/components/langbase) to display the response
-  - [API Route handlers](https://github.com/LangbaseInc/langbase-sdk/tree/main/examples/nextjs/app/api/langbase/pipe) to send requests to ⌘ Langbase
-
-### Node.js Example Code
-
-
-## Node.js Examples
-
-### Add a `.env` file with your Pipe API key
-
-```bash
-# Add your Pipe API key here.
-LANGBASE_PIPE_API_KEY="pipe_12345`"
-```
-
----
-
-### Generate text [`generateText()`](https://langbase.com/docs/langbase-sdk/generate-text)
-
-For more check the API reference of [`generateText()`](https://langbase.com/docs/langbase-sdk/generate-text)
-
-```ts
-import 'dotenv/config';
-import {Pipe} from 'langbase';
-
-// 1. Initiate the Pipe.
-const pipe = new Pipe({
-	// Make sure you have a .env file with any pipe you wanna use.
-	// As a demo we're using a pipe that has less wordy responses.
-	apiKey: process.env.LANGBASE_PIPE_API_KEY!,
-});
-
-// 3. Generate the text by asking a question.
-const result = await pipe.generateText({
-	messages: [{role: 'user', content: 'Who is an AI Engineer?'}],
-});
-
-// 4. Done: You got the generated completion.
-console.log(result.completion);
-```
-
----
-
-### Stream text [`streamText()`](https://langbase.com/docs/langbase-sdk/stream-text)
-
-For more check the API reference of [`streamText()`](https://langbase.com/docs/langbase-sdk/stream-text)
-
-```ts
-import 'dotenv/config';
-import {Pipe} from 'langbase';
-
-// 1. Initiate the Pipe.
-const pipe = new Pipe({
-	// Make sure you have a .env file with any pipe you wanna use.
-	// As a demo we're using a pipe that has less wordy responses.
-	apiKey: process.env.LANGBASE_PIPE_API_KEY!,
-});
-
-// 2. Generate a stream by asking a question
-const stream = await pipe.streamText({
-	messages: [{role: 'user', content: 'Who is an AI Engineer?'}],
-});
+## Documentation
 
-// 3. Print the stream
-for await (const chunk of stream) {
-	// Streaming text part — a single word or several.
-	const textPart = chunk.choices[0]?.delta?.content || '';
+Please read the [SDK documentation](https://langbase.com/docs/langbase-sdk/overview) →
 
-	// Demo: Print the stream — you can use it however.
-	process.stdout.write(textPart);
-}
-```
+## Examples
 
-Check out [more examples in the docs](https://langbase.com/docs/langbase-sdk/examples) →
+Check out  [more examples in the docs](https://langbase.com/docs/langbase-sdk/examples) →

packages/langbase/src/pipes/example.ts

@@ -1,11 +1,5 @@
 import {beforeEach, describe, expect, it, vi} from 'vitest';
-import {Request} from '../common/request';
-import {
-	GenerateNonStreamResponse,
-	GenerateOptions,
-	GenerateStreamResponse,
-	Pipe,
-} from './pipes';
+import {GenerateOptions, GenerateResponse, Pipe, StreamResponse} from './pipes';
 
 // Mock the Request class
 vi.mock('../common/request');
@@ -16,14 +10,15 @@ describe('Pipe', () => {
 
 	beforeEach(() => {
 		pipe = new Pipe({apiKey: mockApiKey});
+		vi.resetAllMocks();
 	});
 
 	describe('generateText', () => {
-		it('should call request.post with correct parameters', async () => {
+		it('should call request.post with correct parameters for non-chat generation', async () => {
 			const mockOptions: GenerateOptions = {
 				messages: [{role: 'user', content: 'Hello'}],
 			};
-			const mockResponse: GenerateNonStreamResponse = {
+			const mockResponse: GenerateResponse = {
 				completion: 'Hello, how can I help you?',
 				raw: {
 					id: 'test-id',
@@ -37,6 +32,8 @@ describe('Pipe', () => {
 								role: 'assistant',
 								content: 'Hello, how can I help you?',
 							},
+							logprobs: null,
+							finish_reason: 'stop',
 						},
 					],
 					usage: {
@@ -48,36 +45,104 @@ describe('Pipe', () => {
 				},
 			};
 
-			(Request.prototype.post as any).mockResolvedValue(mockResponse);
+			const mockPost = vi.fn().mockResolvedValue(mockResponse);
+			(pipe as any).request = {post: mockPost};
 
 			const result = await pipe.generateText(mockOptions);
 
-			expect(Request.prototype.post).toHaveBeenCalledWith({
+			expect(mockPost).toHaveBeenCalledWith({
 				endpoint: '/beta/generate',
-				body: mockOptions,
+				body: {...mockOptions, stream: false},
+			});
+			expect(result).toEqual(mockResponse);
+		});
+
+		it('should call request.post with correct parameters for chat generation', async () => {
+			const mockOptions: GenerateOptions = {
+				messages: [{role: 'user', content: 'Hello'}],
+				chat: true,
+			};
+			const mockResponse: GenerateResponse = {
+				completion: 'Hello! How can I assist you today?',
+				threadId: 'chat-thread-123',
+				raw: {
+					id: 'chat-id',
+					object: 'chat-object',
+					created: 123456789,
+					model: 'chat-model',
+					choices: [
+						{
+							index: 0,
+							message: {
+								role: 'assistant',
+								content: 'Hello! How can I assist you today?',
+							},
+							logprobs: null,
+							finish_reason: 'stop',
+						},
+					],
+					usage: {
+						prompt_tokens: 5,
+						completion_tokens: 12,
+						total_tokens: 17,
+					},
+					system_fingerprint: null,
+				},
+			};
+
+			const mockPost = vi.fn().mockResolvedValue(mockResponse);
+			(pipe as any).request = {post: mockPost};
+
+			const result = await pipe.generateText(mockOptions);
+
+			expect(mockPost).toHaveBeenCalledWith({
+				endpoint: '/beta/chat',
+				body: {...mockOptions, stream: false},
 			});
 			expect(result).toEqual(mockResponse);
 		});
 	});
 
 	describe('streamText', () => {
-		it('should call request.post with correct parameters and stream option', async () => {
+		it('should call request.post with correct parameters for non-chat streaming', async () => {
 			const mockOptions: GenerateOptions = {
 				messages: [{role: 'user', content: 'Hello'}],
 			};
-			const mockStreamResponse: GenerateStreamResponse =
-				{} as GenerateStreamResponse; // You might need to create a more detailed mock
+			const mockStreamResponse: StreamResponse = {
+				stream: {} as any,
+				threadId: null,
+			};
 
-			(Request.prototype.post as any).mockResolvedValue(
-				mockStreamResponse,
-			);
+			const mockPost = vi.fn().mockResolvedValue(mockStreamResponse);
+			(pipe as any).request = {post: mockPost};
 
 			const result = await pipe.streamText(mockOptions);
 
-			expect(Request.prototype.post).toHaveBeenCalledWith({
+			expect(mockPost).toHaveBeenCalledWith({
 				endpoint: '/beta/generate',
-				body: mockOptions,
-				stream: true,
+				body: {...mockOptions, stream: true},
+			});
+			expect(result).toEqual(mockStreamResponse);
+		});
+
+		it('should call request.post with correct parameters for chat streaming', async () => {
+			const mockOptions: GenerateOptions = {
+				messages: [{role: 'user', content: 'Hello'}],
+				chat: true,
+			};
+			const mockStreamResponse: StreamResponse = {
+				stream: {} as any,
+				threadId: 'chat-thread-123',
+			};
+
+			const mockPost = vi.fn().mockResolvedValue(mockStreamResponse);
+			(pipe as any).request = {post: mockPost};
+
+			const result = await pipe.streamText(mockOptions);
+
+			expect(mockPost).toHaveBeenCalledWith({
+				endpoint: '/beta/chat',
+				body: {...mockOptions, stream: true},
 			});
 			expect(result).toEqual(mockStreamResponse);
 		});