v0-sdk 0.0.2

package/README.md

@@ -0,0 +1,230 @@
+### v0 Chats API Client
+
+A lightweight client for interacting with the v0 Chats API to create and manage AI-powered chat conversations.
+
+## Installation
+
+```shellscript
+npm install v0-sdk
+# or
+yarn add v0-sdk
+# or
+pnpm add v0-sdk
+```
+
+## Quick Start
+
+Get your API key from [v0.dev/chat/settings/keys](https://v0.dev/chat/settings/keys) and start creating chats.
+
+```javascript
+import { ChatsClient } from 'v0-sdk'
+
+// Initialize with your API key
+const client = new ChatsClient('your_v0_api_key')
+
+// Create a new chat
+const chat = await client.createChat({
+  message: 'Create a responsive navbar with Tailwind CSS',
+  system: 'You are an expert React developer',
+})
+
+console.log(`Chat created: ${chat.url}`)
+console.log(`Generated code: ${chat.files.length} files`)
+
+// Add a message to the chat
+const response = await client.addMessage(chat.chatId, {
+  message: 'Add a dropdown menu to the navbar',
+})
+
+console.log(`AI response: ${response.text}`)
+```
+
+## Authentication
+
+The client requires a v0 API key, which you can create at [v0.dev/chat/settings/keys](https://v0.dev/chat/settings/keys).
+
+```javascript
+// Initialize with API key
+const client = new ChatsClient('your_v0_api_key')
+
+// Or set it later
+client.setApiKey('your_v0_api_key')
+```
+
+## API Reference
+
+### Create a Chat
+
+Create a new chat conversation with the AI.
+
+```javascript
+const result = await client.createChat({
+  message: 'Create a login form with validation',
+  system: 'You are an expert in React and form validation',
+  chatPrivacy: 'private',
+  attachments: [{ url: 'https://example.com/design.png' }],
+  modelConfiguration: {
+    modelId: 'v0-1.5-md',
+    thinking: true,
+    imageGenerations: false,
+  },
+})
+```
+
+**Response:**
+
+```javascript
+{
+  chatId: 'abc123',
+  url: 'https://v0.dev/chat/abc123',
+  text: 'I'll create a login form with validation...',
+  files: [
+    {
+      name: 'login-form.tsx',
+      content: '...',
+      type: 'component'
+    }
+  ],
+  demo: 'https://v0.dev/demo/abc123'
+}
+```
+
+### Add a Message
+
+Add a message to an existing chat.
+
+```javascript
+const response = await client.addMessage('abc123', {
+  message: 'Add password strength indicator',
+  attachments: [{ url: 'https://example.com/mockup.jpg' }],
+  modelConfiguration: {
+    thinking: true,
+  },
+})
+```
+
+### Get Chat History
+
+Coming soon
+
+## Working with Attachments
+
+The client supports both URL and base64-encoded attachments:
+
+```javascript
+// URL attachment
+const response = await client.createChat({
+  message: 'Create a component based on this design',
+  attachments: [{ url: 'https://example.com/design.png' }],
+})
+
+// Base64 attachment (from file input)
+document
+  .querySelector('input[type="file"]')
+  .addEventListener('change', async e => {
+    const file = e.target.files[0]
+    const reader = new FileReader()
+
+    reader.onload = async () => {
+      const response = await client.createChat({
+        message: 'Create a component based on this image',
+        attachments: [{ url: reader.result }],
+      })
+
+      console.log(response)
+    }
+
+    reader.readAsDataURL(file)
+  })
+```
+
+## Customizing Model Behavior
+
+Control the AI model's behavior with the `modelConfiguration` parameter:
+
+```javascript
+const response = await client.createChat({
+  message: 'Create a dashboard layout',
+  modelConfiguration: {
+    // Use a specific model version
+    modelId: 'v0-1.5-md',
+
+    // Enable AI-generated images in the response
+    imageGenerations: true,
+
+    // Show the AI's reasoning process
+    thinking: true,
+  },
+})
+```
+
+## Error Handling
+
+The client throws descriptive errors for various failure scenarios:
+
+```javascript
+try {
+  const chat = await client.createChat({
+    message: 'Create a component',
+  })
+} catch (error) {
+  if (error.status === 403) {
+    console.error('Authentication error:', error.message)
+  } else if (error.status === 429) {
+    console.error('Rate limit exceeded:', error.message)
+  } else {
+    console.error('API error:', error.message)
+  }
+}
+```
+
+## Advanced Usage
+
+### Streaming Responses
+
+Coming soon
+
+### Team Collaboration
+
+Share chats with your team:
+
+```javascript
+const chat = await client.createChat({
+  message: 'Create a component for our design system',
+  chatPrivacy: 'team-edit',
+  teamId: 'your-team-id',
+})
+
+// Now team members can view and edit this chat
+console.log(`Team chat URL: ${chat.url}`)
+```
+
+## Troubleshooting
+
+### Rate Limiting
+
+The API has rate limits of 100 requests per minute and 1,000 requests per hour. If you hit these limits, you'll receive a 429 status code.
+
+### Common Errors
+
+- **403 Forbidden**: Check your API key and ensure you have a valid subscription.
+- **400 Bad Request**: Verify your request parameters match the API requirements.
+- **404 Not Found**: Ensure the chat ID exists and is accessible to your API key.
+- **413 Payload Too Large**: Reduce attachment size (max 10MB per attachment).
+
+### Debugging
+
+Enable debug mode to see detailed request and response information:
+
+```javascript
+const client = new ChatsClient('your_api_key', undefined, { debug: true })
+```
+
+## Resources
+
+- [v0 Documentation](https://v0.dev/docs)
+- [API Terms](https://vercel.com/legal/api-terms)
+
+## License
+
+MIT

package/dist/index.js

@@ -0,0 +1,105 @@
+/**
+ * v0 Chats API SDK
+ * A client library for interacting with the v0 Chats API
+ */ class V0ChatsError extends Error {
+    constructor(message, status, data){
+        super(message);
+        this.name = 'V0ChatsError';
+        this.status = status;
+        this.data = data;
+    }
+}
+/**
+ * Client for the v0 Chats API
+ */ class V0Client {
+    /**
+   * Create a new v0 Chats API client
+   *
+   * @param options Client configuration options
+   */ constructor(options){
+        this.apiKey = options.apiKey;
+        this.baseUrl = options.baseUrl || 'https://api.v0.dev/api';
+        this.fetchFn = options.fetch || fetch;
+    }
+    /**
+   * Create a new chat
+   *
+   * @param options Options for creating a new chat
+   * @returns Promise with the created chat details
+   */ async createChat(options) {
+        const response = await this.request('POST', '/chats', options);
+        return response;
+    }
+    /**
+   * Add a message to an existing chat
+   *
+   * @param chatId The ID of the chat to add a message to
+   * @param options Options for adding a message
+   * @returns Promise with the updated chat details
+   */ async addMessage(chatId, options) {
+        const response = await this.request('POST', `/chats/${chatId}`, options);
+        return response;
+    }
+    /**
+   * Get chat details and message history
+   *
+   * @param chatId The ID of the chat to retrieve
+   * @returns Promise with the chat details and messages
+   */ async getChat(chatId) {
+        const response = await this.request('GET', `/chats/${chatId}`);
+        return response;
+    }
+    /**
+   * Continue an existing chat (deprecated)
+   *
+   * This method is deprecated. Use addMessage() instead.
+   *
+   * @deprecated Use addMessage() instead
+   * @param chatId The ID of the chat to continue
+   * @param options Options for continuing the chat
+   * @returns Promise with the updated chat details
+   */ async continueChat(chatId, options) {
+        console.warn('continueChat() is deprecated. Use addMessage() instead.');
+        const payload = {
+            ...options,
+            chatId
+        };
+        const response = await this.request('POST', '/chats', payload);
+        return response;
+    }
+    /**
+   * Make a request to the v0 Chats API
+   *
+   * @param method HTTP method
+   * @param path API path
+   * @param data Request data
+   * @returns Promise with the response data
+   */ async request(method, path, data) {
+        const url = `${this.baseUrl}${path}`;
+        const headers = {
+            Authorization: `Bearer ${this.apiKey}`,
+            'Content-Type': 'application/json'
+        };
+        const options = {
+            method,
+            headers,
+            body: data && method !== 'GET' ? JSON.stringify(data) : undefined
+        };
+        try {
+            const response = await this.fetchFn(url, options);
+            const responseData = await response.json();
+            if (!response.ok) {
+                throw new V0ChatsError(responseData.error || `API request failed with status ${response.status}`, response.status, responseData);
+            }
+            return responseData;
+        } catch (error) {
+            if (error instanceof V0ChatsError) {
+                throw error;
+            }
+            throw new V0ChatsError(error instanceof Error ? error.message : 'Unknown error occurred', 500);
+        }
+    }
+}
+
+exports.V0ChatsError = V0ChatsError;
+exports.V0Client = V0Client;

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "v0-sdk",
+  "version": "0.0.2",
+  "description": "TypeScript SDK for the v0 Chats API",
+  "main": "dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "v0",
+    "vercel",
+    "ai",
+    "chat",
+    "sdk"
+  ],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "bunchee": "^6.5.2",
+    "typescript": "5.7.3"
+  },
+  "scripts": {
+    "build": "bunchee"
+  }
+}