v0-sdk 0.0.7 → 0.0.8

package/README.md

@@ -1,6 +1,8 @@
-# v0 Chat SDK
+# v0 SDK
 
-A TypeScript SDK for interacting with the v0 API to create and manage AI-powered chat conversations, projects, integrations, and more.
+> **⚠️ Developer Preview**: This SDK is currently in beta and is subject to change. Use in production at your own risk.
+
+A TypeScript SDK for interacting with the v0 Platform API to create and manage AI-powered chat conversations, projects, integrations, and more.
 
 ## Features
 
@@ -37,15 +39,6 @@ const chat = await v0.chats.create({
 })
 
 console.log(`Chat created: ${chat.url}`)
-console.log(`Generated code: ${chat.files?.length} files`)
-
-// Add a message to the chat
-const response = await v0.chats.createMessage({
-  chatId: chat.chatId,
-  message: 'Add a dropdown menu to the navbar',
-})
-
-console.log(`AI response: ${response.text}`)
 ```
 
 ## Authentication
@@ -85,33 +78,6 @@ const result = await v0.chats.create({
 
 ```typescript
 const chat = await v0.chats.getById({ chatId: 'chat_id' })
-console.log(chat.messages) // Fully typed message array
-```
-
-#### Manage Chat Favorites
-
-```typescript
-// Favorite a chat
-await v0.chats.favorite({ chatId: 'chat_id' })
-
-// Unfavorite a chat
-await v0.chats.unfavorite({ chatId: 'chat_id' })
-
-// Get favorite chats
-const favorites = await v0.chats.find()
-```
-
-#### Chat History and Management
-
-```typescript
-// Get chat history
-const chats = await v0.chats.find()
-
-// Delete a chat
-await v0.chats.delete({ chatId: 'chat_id' })
-
-// Get chat's associated project
-const project = await v0.chats.getProject({ chatId: 'chat_id' })
 ```
 
 #### Add Messages to Chat
@@ -120,126 +86,65 @@ const project = await v0.chats.getProject({ chatId: 'chat_id' })
 const response = await v0.chats.createMessage({
   chatId: 'chat_id',
   message: 'Add password strength indicator',
-  attachments: [{ url: 'https://example.com/mockup.jpg' }],
-  modelConfiguration: {
-    imageGenerations: true,
-  },
 })
 ```
 
-#### Get Version Frame Token
+#### Other Chat Operations
 
-```typescript
-const token = await v0.chats.getVersionFrameToken({
-  chatId: 'chat_id',
-  versionId: 'version_id',
-})
-```
+- `v0.chats.find()` - Get chat history
+- `v0.chats.delete({ chatId })` - Delete a chat
+- `v0.chats.favorite({ chatId })` - Favorite a chat
+- `v0.chats.unfavorite({ chatId })` - Unfavorite a chat
+- `v0.chats.getProject({ chatId })` - Get chat's associated project
+- `v0.chats.getVersionFrameToken({ chatId, versionId })` - Get version frame token
 
 ### Project Operations
 
-#### Create a Project
-
 ```typescript
+// Create a project
 const project = await v0.projects.create({
   name: 'My New Project',
   description: 'A sample project',
-  environmentVariables: [{ key: 'API_KEY', value: 'secret_value' }],
-  icon: 'https://example.com/icon.png',
 })
-```
 
-#### Find Projects
-
-```typescript
+// Find projects
 const projects = await v0.projects.find()
 ```
 
 ### Vercel Integration
 
-#### Create Vercel Integration Project
-
 ```typescript
+// Create Vercel integration project
 const integration = await v0.integrations.vercel.projects.create({
   projectId: 'vercel_project_id',
   name: 'project_name',
 })
-```
-
-#### Find Vercel Projects
 
-```typescript
+// Find Vercel projects
 const projects = await v0.integrations.vercel.projects.find()
 ```
 
 ### User Management
 
-#### Get User Information
-
 ```typescript
+// Get user information
 const userResponse = await v0.user.get()
-console.log(userResponse.user.name, userResponse.user.email)
-```
 
-#### Get User Plan and Billing
-
-```typescript
+// Get user plan and billing
 const planResponse = await v0.user.getPlan()
-console.log(planResponse.plan, planResponse.balance)
-```
-
-### Deployment and Monitoring
-
-#### Find Deployment Logs
 
-```typescript
-const logs = await v0.deployments.findLogs({
-  deploymentId: 'deployment_id',
-})
+// Get user scopes
+const scopesResponse = await v0.user.getScopes()
 ```
 
-### Scopes and Rate Limits
-
-#### Find Scopes
+### Other Operations
 
 ```typescript
-const scopesResponse = await v0.scopes.find()
-console.log(scopesResponse.scopes)
-```
-
-#### Check Rate Limits
+// Find deployment logs
+const logs = await v0.deployments.findLogs({ deploymentId: 'deployment_id' })
 
-```typescript
+// Check rate limits
 const rateLimits = await v0.rateLimits.find()
-console.log(rateLimits.remaining, rateLimits.reset)
-```
-
-## Working with Attachments
-
-The SDK supports URL and base64-encoded attachments:
-
-```typescript
-// URL attachment
-const response = await v0.chats.create({
-  message: 'Create a component based on this design',
-  attachments: [{ url: 'https://example.com/design.png' }],
-})
-
-// Base64 attachment
-const handleFileUpload = async (file: File) => {
-  const reader = new FileReader()
-
-  reader.onload = async () => {
-    const response = await v0.chats.create({
-      message: 'Create a component based on this image',
-      attachments: [{ url: reader.result as string }],
-    })
-
-    console.log(response)
-  }
-
-  reader.readAsDataURL(file)
-}
 ```
 
 ## TypeScript Support
@@ -252,14 +157,7 @@ import type {
   ChatsCreateResponse,
   User,
   Project,
-  ScopeSummary,
 } from 'v0-sdk'
-
-// All request and response types are fully typed
-const createChatRequest: ChatsCreateRequest = {
-  message: 'Create a component',
-  system: 'You are a helpful assistant',
-}
 ```
 
 ## Error Handling
@@ -276,8 +174,6 @@ try {
     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)
   }
 }
 ```
@@ -290,39 +186,6 @@ The SDK includes comprehensive test coverage. Run tests with:
 npm test
 ```
 
-### Test Structure
-
-Tests are organized by functionality:
-
-```
-tests/
-├── chats/
-│   ├── create.test.ts
-│   ├── find.test.ts
-│   ├── delete.test.ts
-│   ├── getById.test.ts
-│   ├── favorite.test.ts
-│   ├── unfavorite.test.ts
-│   ├── getProject.test.ts
-│   ├── createMessage.test.ts
-│   └── getVersionFrameToken.test.ts
-├── projects/
-│   ├── create.test.ts
-│   └── find.test.ts
-├── integrations/vercel/projects/
-│   ├── create.test.ts
-│   └── find.test.ts
-├── user/
-│   ├── get.test.ts
-│   └── getPlan.test.ts
-├── deployments/
-│   └── findLogs.test.ts
-├── scopes/
-│   └── find.test.ts
-└── rateLimits/
-    └── find.test.ts
-```
-
 ## Development
 
 ### Building
@@ -345,51 +208,6 @@ npm run generate
 npm test
 ```
 
-## Advanced Usage
-
-### Custom Configuration
-
-```typescript
-const client = new V0Client('your_api_key', 'https://custom-api.example.com', {
-  timeout: 30000,
-  retries: 3,
-})
-```
-
-### Team Collaboration
-
-Share chats with your team:
-
-```typescript
-const chat = await v0.chats.create({
-  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. Check your current limits:
-
-```typescript
-const limits = await v0.rateLimits.find()
-console.log(`Remaining requests: ${limits.remaining}`)
-```
-
-### 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 resource ID exists and is accessible to your API key
-- **413 Payload Too Large**: Reduce attachment size (max 10MB per attachment)
-- **429 Too Many Requests**: You've hit the rate limit, wait before making more requests
-
 ## Resources
 
 - [v0 Documentation](https://v0.dev/docs)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "v0-sdk",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "TypeScript SDK for the v0 Chats API",
   "type": "module",
   "main": "dist/index.js",