@ai-sdk/vercel 2.0.17 → 2.0.19

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @ai-sdk/vercel
 
+## 2.0.19
+
+### Patch Changes
+
+- 4de5a1d: chore: excluded tests from src folder in npm package
+- Updated dependencies [4de5a1d]
+  - @ai-sdk/openai-compatible@2.0.18
+  - @ai-sdk/provider@3.0.5
+  - @ai-sdk/provider-utils@4.0.9
+
+## 2.0.18
+
+### Patch Changes
+
+- 2b8369d: chore: add docs to package dist
+
 ## 2.0.17
 
 ### Patch Changes

package/dist/index.js

@@ -32,7 +32,7 @@ var import_openai_compatible = require("@ai-sdk/openai-compatible");
 var import_provider_utils = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "2.0.17" : "0.0.0-test";
+var VERSION = true ? "2.0.19" : "0.0.0-test";
 
 // src/vercel-provider.ts
 function createVercel(options = {}) {

package/dist/index.mjs

@@ -10,7 +10,7 @@ import {
 } from "@ai-sdk/provider-utils";
 
 // src/version.ts
-var VERSION = true ? "2.0.17" : "0.0.0-test";
+var VERSION = true ? "2.0.19" : "0.0.0-test";
 
 // src/vercel-provider.ts
 function createVercel(options = {}) {

package/docs/02-vercel.mdx

@@ -0,0 +1,129 @@
+---
+title: Vercel
+description: Learn how to use Vercel's v0 models with the AI SDK.
+---
+
+# Vercel Provider
+
+The [Vercel](https://vercel.com) provider gives you access to the [v0 API](https://v0.app/docs/api/model), designed for building modern web applications. The v0 models support text and image inputs and provide fast streaming responses.
+
+You can create your Vercel API key at [v0.dev](https://v0.dev/chat/settings/keys).
+
+<Note>
+  The v0 API is currently in beta and requires a Premium or Team plan with
+  usage-based billing enabled. For details, visit the [pricing
+  page](https://v0.dev/pricing). To request a higher limit, contact Vercel at
+  support@v0.dev.
+</Note>
+
+## Features
+
+- **Framework aware completions**: Evaluated on modern stacks like Next.js and Vercel
+- **Auto-fix**: Identifies and corrects common coding issues during generation
+- **Quick edit**: Streams inline edits as they're available
+- **Multimodal**: Supports both text and image inputs
+
+## Setup
+
+The Vercel provider is available via the `@ai-sdk/vercel` module. You can install it with:
+
+<Tabs items={['pnpm', 'npm', 'yarn', 'bun']}>
+  <Tab>
+    <Snippet text="pnpm add @ai-sdk/vercel" dark />
+  </Tab>
+  <Tab>
+    <Snippet text="npm install @ai-sdk/vercel" dark />
+  </Tab>
+  <Tab>
+    <Snippet text="yarn add @ai-sdk/vercel" dark />
+  </Tab>
+
+  <Tab>
+    <Snippet text="bun add @ai-sdk/vercel" dark />
+  </Tab>
+</Tabs>
+
+## Provider Instance
+
+You can import the default provider instance `vercel` from `@ai-sdk/vercel`:
+
+```ts
+import { vercel } from '@ai-sdk/vercel';
+```
+
+If you need a customized setup, you can import `createVercel` from `@ai-sdk/vercel` and create a provider instance with your settings:
+
+```ts
+import { createVercel } from '@ai-sdk/vercel';
+
+const vercel = createVercel({
+  apiKey: process.env.VERCEL_API_KEY ?? '',
+});
+```
+
+You can use the following optional settings to customize the Vercel provider instance:
+
+- **baseURL** _string_
+
+  Use a different URL prefix for API calls. The default prefix is `https://api.v0.dev/v1`.
+
+- **apiKey** _string_
+
+  API key that is being sent using the `Authorization` header. It defaults to
+  the `VERCEL_API_KEY` environment variable.
+
+- **headers** _Record&lt;string,string&gt;_
+
+  Custom headers to include in the requests.
+
+- **fetch** _(input: RequestInfo, init?: RequestInit) => Promise&lt;Response&gt;_
+
+  Custom [fetch](https://developer.mozilla.org/en-US/docs/Web/API/fetch) implementation.
+  Defaults to the global `fetch` function.
+  You can use it as a middleware to intercept requests,
+  or to provide a custom fetch implementation for e.g. testing.
+
+## Language Models
+
+You can create language models using a provider instance. The first argument is the model ID, for example:
+
+```ts
+import { vercel } from '@ai-sdk/vercel';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: vercel('v0-1.0-md'),
+  prompt: 'Create a Next.js AI chatbot',
+});
+```
+
+Vercel language models can also be used in the `streamText` function (see [AI SDK Core](/docs/ai-sdk-core)).
+
+## Models
+
+### v0-1.5-md
+
+The `v0-1.5-md` model is for everyday tasks and UI generation.
+
+### v0-1.5-lg
+
+The `v0-1.5-lg` model is for advanced thinking or reasoning.
+
+### v0-1.0-md (legacy)
+
+The `v0-1.0-md` model is the legacy model served by the v0 API.
+
+All v0 models have the following capabilities:
+
+- Supports text and image inputs (multimodal)
+- Supports function/tool calls
+- Streaming responses with low latency
+- Optimized for frontend and full-stack web development
+
+## Model Capabilities
+
+| Model       | Image Input         | Object Generation   | Tool Usage          | Tool Streaming      |
+| ----------- | ------------------- | ------------------- | ------------------- | ------------------- |
+| `v0-1.5-md` | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `v0-1.5-lg` | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `v0-1.0-md` | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/vercel",
-  "version": "2.0.17",
+  "version": "2.0.19",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -8,10 +8,18 @@
   "types": "./dist/index.d.ts",
   "files": [
     "dist/**/*",
+    "docs/**/*",
     "src",
+    "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
+    "!src/**/__snapshots__",
+    "!src/**/__fixtures__",
     "CHANGELOG.md",
     "README.md"
   ],
+  "directories": {
+    "doc": "./docs"
+  },
   "exports": {
     "./package.json": "./package.json",
     ".": {
@@ -21,9 +29,9 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/openai-compatible": "2.0.17",
-    "@ai-sdk/provider": "3.0.4",
-    "@ai-sdk/provider-utils": "4.0.8"
+    "@ai-sdk/openai-compatible": "2.0.18",
+    "@ai-sdk/provider": "3.0.5",
+    "@ai-sdk/provider-utils": "4.0.9"
   },
   "devDependencies": {
     "@types/node": "20.17.24",
@@ -55,7 +63,7 @@
   "scripts": {
     "build": "pnpm clean && tsup --tsconfig tsconfig.build.json",
     "build:watch": "pnpm clean && tsup --watch",
-    "clean": "del-cli dist *.tsbuildinfo",
+    "clean": "del-cli dist docs *.tsbuildinfo",
     "lint": "eslint \"./**/*.ts*\"",
     "type-check": "tsc --build",
     "prettier-check": "prettier --check \"./**/*.ts*\"",

package/src/vercel-provider.test.ts

@@ -1,102 +0,0 @@
-import { createVercel } from './vercel-provider';
-import { OpenAICompatibleChatLanguageModel } from '@ai-sdk/openai-compatible';
-import { LanguageModelV3 } from '@ai-sdk/provider';
-import { loadApiKey } from '@ai-sdk/provider-utils';
-import { describe, it, expect, vi, beforeEach, Mock } from 'vitest';
-
-const OpenAICompatibleChatLanguageModelMock =
-  OpenAICompatibleChatLanguageModel as unknown as Mock;
-
-vi.mock('@ai-sdk/openai-compatible', () => ({
-  OpenAICompatibleChatLanguageModel: vi.fn(),
-  OpenAICompatibleCompletionLanguageModel: vi.fn(),
-}));
-
-vi.mock('@ai-sdk/provider-utils', async () => {
-  const actual = await vi.importActual('@ai-sdk/provider-utils');
-  return {
-    ...actual,
-    loadApiKey: vi.fn().mockReturnValue('mock-api-key'),
-    withoutTrailingSlash: vi.fn(url => url),
-  };
-});
-
-vi.mock('./vercel-image-model', () => ({
-  VercelImageModel: vi.fn(),
-}));
-
-describe('VercelProvider', () => {
-  let mockLanguageModel: LanguageModelV3;
-
-  beforeEach(() => {
-    mockLanguageModel = {
-      // Add any required methods for LanguageModelV1
-    } as LanguageModelV3;
-
-    // Reset mocks
-    vi.clearAllMocks();
-  });
-
-  describe('createVercel', () => {
-    it('should create a VercelProvider instance with default options', () => {
-      const provider = createVercel();
-      provider('model-id');
-
-      // Use the mocked version
-      const constructorCall =
-        OpenAICompatibleChatLanguageModelMock.mock.calls[0];
-      const config = constructorCall[1];
-      config.headers();
-
-      expect(loadApiKey).toHaveBeenCalledWith({
-        apiKey: undefined,
-        environmentVariableName: 'VERCEL_API_KEY',
-        description: 'Vercel',
-      });
-    });
-
-    it('should create a VercelProvider instance with custom options', () => {
-      const options = {
-        apiKey: 'custom-key',
-        baseURL: 'https://custom.url',
-        headers: { 'Custom-Header': 'value' },
-      };
-      const provider = createVercel(options);
-      provider('model-id');
-
-      const constructorCall =
-        OpenAICompatibleChatLanguageModelMock.mock.calls[0];
-      const config = constructorCall[1];
-      config.headers();
-
-      expect(loadApiKey).toHaveBeenCalledWith({
-        apiKey: 'custom-key',
-        environmentVariableName: 'VERCEL_API_KEY',
-        description: 'Vercel',
-      });
-    });
-
-    it('should return a chat model when called as a function', () => {
-      const provider = createVercel();
-      const modelId = 'foo-model-id';
-
-      const model = provider(modelId);
-      expect(model).toBeInstanceOf(OpenAICompatibleChatLanguageModel);
-    });
-  });
-
-  it('should construct a language model with correct configuration', () => {
-    const provider = createVercel();
-    const modelId = 'vercel-chat-model';
-
-    const model = provider.languageModel(modelId);
-
-    expect(model).toBeInstanceOf(OpenAICompatibleChatLanguageModel);
-    expect(OpenAICompatibleChatLanguageModelMock).toHaveBeenCalledWith(
-      modelId,
-      expect.objectContaining({
-        provider: 'vercel.chat',
-      }),
-    );
-  });
-});