Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/shiny-llamas-hunt.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@workflow/ai": patch
---

Add support for AI SDK v6
43 changes: 43 additions & 0 deletions packages/ai/README.md
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,46 @@
# @workflow/ai

[Workflow DevKit](https://useworkflow.dev) compatible helper library for the [AI SDK](https://ai-sdk.dev/).

## Installation

```bash
npm install @workflow/ai
```

## AI SDK Compatibility

This package supports both **AI SDK v5** and **AI SDK v6**. The `ai` package is a peer dependency, so you control which version to use:

```bash
# For AI SDK v6 (recommended, latest)
npm install ai

# For AI SDK v5
npm install ai@5
```

### Version Differences

| Feature | AI SDK v5 | AI SDK v6 |
|---------|-----------|-----------|
| Model interface | `LanguageModelV2` | `LanguageModelV3` |
| Provider package | `@ai-sdk/provider@2.x` | `@ai-sdk/provider@3.x` |

Both versions work seamlessly with `@workflow/ai` - the package handles the differences internally through a compatibility layer.

### Provider Packages

If you use the provider wrappers (e.g., `@workflow/ai/anthropic`, `@workflow/ai/openai`), install the corresponding provider packages:

```bash
# Example: Using Anthropic with AI SDK v6
npm install ai @ai-sdk/anthropic

# Example: Using OpenAI with AI SDK v5
npm install ai@5 @ai-sdk/openai@2
```

## Documentation

For usage examples and full documentation, see the [API reference](https://useworkflow.dev/docs/api-reference/workflow-ai/).
16 changes: 9 additions & 7 deletions packages/ai/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,16 +62,18 @@
"workflow": "workspace:*"
},
"peerDependencies": {
"ai": "^5",
"ai": "^5 || ^6",
"workflow": "4.0.1-beta.36"
},
"dependencies": {
"@ai-sdk/anthropic": "2.0.49",
"@ai-sdk/gateway": "2.0.15",
"@ai-sdk/google": "2.0.43",
"@ai-sdk/openai": "2.0.72",
"@ai-sdk/provider": "2.0.0",
"@ai-sdk/xai": "2.0.37",
"@ai-sdk/provider": "^2.0.0 || ^3.0.0",
"zod": "catalog:"
},
"optionalDependencies": {
"@ai-sdk/anthropic": "^2.0.0 || ^3.0.0",
"@ai-sdk/gateway": "^2.0.0 || ^3.0.0",
"@ai-sdk/google": "^2.0.0 || ^3.0.0",
"@ai-sdk/openai": "^2.0.0 || ^3.0.0",
"@ai-sdk/xai": "^2.0.0 || ^3.0.0"
}
}
15 changes: 10 additions & 5 deletions packages/ai/src/agent/do-stream-step.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2StreamPart,
Expand All@@ -20,6 +19,7 @@ import type {
StreamTextTransform,
TelemetrySettings,
} from './durable-agent.js';
import type { CompatibleLanguageModel } from './types.js';

export type FinishPart = Extract<LanguageModelV2StreamPart, { type: 'finish' }>;

Expand DownExpand Up@@ -87,21 +87,26 @@ function toLanguageModelToolChoice(

export async function doStreamStep(
conversationPrompt: LanguageModelV2Prompt,
modelInit: string | (() => Promise<LanguageModelV2>),
modelInit: string | (() => Promise<CompatibleLanguageModel>),
writable: WritableStream<UIMessageChunk>,
tools?: LanguageModelV2CallOptions['tools'],
options?: DoStreamStepOptions
) {
'use step';

let model: LanguageModelV2 | undefined;
// Model can be LanguageModelV2 (AI SDK v5) or LanguageModelV3 (AI SDK v6)
// Both have compatible doStream interfaces for our use case
let model: CompatibleLanguageModel | undefined;
if (typeof modelInit === 'string') {
model = gateway(modelInit);
// gateway() returns LanguageModelV2 in AI SDK v5 and LanguageModelV3 in AI SDK v6
// Both are compatible at runtime for doStream operations
model = gateway(modelInit) as CompatibleLanguageModel;
} else if (typeof modelInit === 'function') {
// User-provided model factory - could return V2 or V3
model = await modelInit();
} else {
throw new Error(
'Invalid "model initialization" argument. Must be a string or a function that returns a LanguageModelV2 instance.'
'Invalid "model initialization" argument. Must be a string or a function that returns a LanguageModel instance.'
);
}

Expand Down
17 changes: 11 additions & 6 deletions packages/ai/src/agent/durable-agent.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2StreamPart,
Expand All@@ -24,6 +23,10 @@ import {
import { convertToLanguageModelPrompt, standardizePrompt } from 'ai/internal';
import { FatalError } from 'workflow';
import { streamTextIterator } from './stream-text-iterator.js';
import type { CompatibleLanguageModel } from './types.js';

// Re-export for consumers
export type { CompatibleLanguageModel } from './types.js';

/**
* Re-export the Output helper for structured output specifications.
Expand DownExpand Up@@ -211,8 +214,9 @@ export interface GenerationSettings {
export interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
/**
* The current model configuration (string or function).
* The function should return a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);

/**
* The current step number (0-indexed).
Expand DownExpand Up@@ -243,8 +247,9 @@ export interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
export interface PrepareStepResult extends Partial<GenerationSettings> {
/**
* Override the model for this step.
* The function should return a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model?: string | (() => Promise<LanguageModelV2>);
model?: string | (() => Promise<CompatibleLanguageModel>);

/**
* Override the system message for this step.
Expand DownExpand Up@@ -291,9 +296,9 @@ export interface DurableAgentOptions extends GenerationSettings {
* The model provider to use for the agent.
*
* This should be a string compatible with the Vercel AI Gateway (e.g., 'anthropic/claude-opus'),
* or a step function that returns a `LanguageModelV2` instance.
* or a step function that returns a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);

/**
* A set of tools available to the agent.
Expand DownExpand Up@@ -594,7 +599,7 @@ export interface DurableAgentStreamResult<
* ```
*/
export class DurableAgent<TBaseTools extends ToolSet = ToolSet> {
private model: string | (() => Promise<LanguageModelV2>);
private model: string | (() => Promise<CompatibleLanguageModel>);
private tools: TBaseTools;
private system?: string;
private generationSettings: GenerationSettings;
Expand Down
6 changes: 3 additions & 3 deletions packages/ai/src/agent/stream-text-iterator.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2ToolCall,
Expand All@@ -21,6 +20,7 @@ import type {
TelemetrySettings,
} from './durable-agent.js';
import { toolsToModelTools } from './tools-to-model-tools.js';
import type { CompatibleLanguageModel } from './types.js';

/**
* The value yielded by the stream text iterator when tool calls are requested.
Expand DownExpand Up@@ -60,7 +60,7 @@ export async function* streamTextIterator({
prompt: LanguageModelV2Prompt;
tools: ToolSet;
writable: WritableStream<UIMessageChunk>;
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);
stopConditions?: ModelStopCondition[] | ModelStopCondition;
maxSteps?: number;
sendStart?: boolean;
Expand All@@ -82,7 +82,7 @@ export async function* streamTextIterator({
LanguageModelV2ToolResultPart[]
> {
let conversationPrompt = [...prompt]; // Create a mutable copy
let currentModel = model;
let currentModel: string | (() => Promise<CompatibleLanguageModel>) = model;
let currentGenerationSettings = generationSettings ?? {};
let currentToolChoice = toolChoice;
let currentContext = experimental_context;
Expand Down
36 changes: 36 additions & 0 deletions packages/ai/src/agent/types.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
/**
* Shared types for AI SDK v5 and v6 compatibility.
*/
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2StreamPart,
} from '@ai-sdk/provider';

/**
* Compatible language model type that works with both AI SDK v5 and v6.
*
* AI SDK v5 uses LanguageModelV2, while AI SDK v6 uses LanguageModelV3.
* Both have compatible `doStream` interfaces for our use case.
*
* This type represents the union of both model versions, allowing code
* to work seamlessly with either AI SDK version.
*
* Note: V3 models accept LanguageModelV2CallOptions at runtime due to
* structural compatibility between V2 and V3 prompt/options formats.
*/
export type CompatibleLanguageModel =
| LanguageModelV2
| {
readonly specificationVersion: 'v3';
readonly provider: string;
readonly modelId: string;
/**
* Stream method compatible with both V2 and V3 models.
* V3 models accept V2-style call options due to structural compatibility
* at runtime - the prompt and options structures are essentially identical.
*/
doStream(options: LanguageModelV2CallOptions): PromiseLike<{
stream: ReadableStream<LanguageModelV2StreamPart>;
}>;
};
1 change: 1 addition & 0 deletions packages/ai/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ export * from './workflow-chat-transport.js';
*/
export { DurableAgent, Output } from './agent/durable-agent.js';
export type {
CompatibleLanguageModel,
DurableAgentOptions,
DurableAgentStreamOptions,
DurableAgentStreamResult,
Expand Down
52 changes: 23 additions & 29 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/shiny-llamas-hunt.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@workflow/ai": patch
---

Add support for AI SDK v6
43 changes: 43 additions & 0 deletions packages/ai/README.md
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,46 @@
# @workflow/ai

[Workflow DevKit](https://useworkflow.dev) compatible helper library for the [AI SDK](https://ai-sdk.dev/).

## Installation

```bash
npm install @workflow/ai
```

## AI SDK Compatibility

This package supports both **AI SDK v5** and **AI SDK v6**. The `ai` package is a peer dependency, so you control which version to use:

```bash
# For AI SDK v6 (recommended, latest)
npm install ai

# For AI SDK v5
npm install ai@5
```

### Version Differences

| Feature | AI SDK v5 | AI SDK v6 |
|---------|-----------|-----------|
| Model interface | `LanguageModelV2` | `LanguageModelV3` |
| Provider package | `@ai-sdk/provider@2.x` | `@ai-sdk/provider@3.x` |

Both versions work seamlessly with `@workflow/ai` - the package handles the differences internally through a compatibility layer.

### Provider Packages

If you use the provider wrappers (e.g., `@workflow/ai/anthropic`, `@workflow/ai/openai`), install the corresponding provider packages:

```bash
# Example: Using Anthropic with AI SDK v6
npm install ai @ai-sdk/anthropic

# Example: Using OpenAI with AI SDK v5
npm install ai@5 @ai-sdk/openai@2
```

## Documentation

For usage examples and full documentation, see the [API reference](https://useworkflow.dev/docs/api-reference/workflow-ai/).
16 changes: 9 additions & 7 deletions packages/ai/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,16 +62,18 @@
"workflow": "workspace:*"
},
"peerDependencies": {
"ai": "^5",
"ai": "^5 || ^6",
"workflow": "4.0.1-beta.36"
},
"dependencies": {
"@ai-sdk/anthropic": "2.0.49",
"@ai-sdk/gateway": "2.0.15",
"@ai-sdk/google": "2.0.43",
"@ai-sdk/openai": "2.0.72",
"@ai-sdk/provider": "2.0.0",
"@ai-sdk/xai": "2.0.37",
"@ai-sdk/provider": "^2.0.0 || ^3.0.0",
"zod": "catalog:"
},
"optionalDependencies": {
"@ai-sdk/anthropic": "^2.0.0 || ^3.0.0",
"@ai-sdk/gateway": "^2.0.0 || ^3.0.0",
"@ai-sdk/google": "^2.0.0 || ^3.0.0",
"@ai-sdk/openai": "^2.0.0 || ^3.0.0",
"@ai-sdk/xai": "^2.0.0 || ^3.0.0"
}
}
15 changes: 10 additions & 5 deletions packages/ai/src/agent/do-stream-step.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2StreamPart,
Expand All@@ -20,6 +19,7 @@ import type {
StreamTextTransform,
TelemetrySettings,
} from './durable-agent.js';
import type { CompatibleLanguageModel } from './types.js';

export type FinishPart = Extract<LanguageModelV2StreamPart, { type: 'finish' }>;

Expand DownExpand Up@@ -87,21 +87,26 @@ function toLanguageModelToolChoice(

export async function doStreamStep(
conversationPrompt: LanguageModelV2Prompt,
modelInit: string | (() => Promise<LanguageModelV2>),
modelInit: string | (() => Promise<CompatibleLanguageModel>),
writable: WritableStream<UIMessageChunk>,
tools?: LanguageModelV2CallOptions['tools'],
options?: DoStreamStepOptions
) {
'use step';

let model: LanguageModelV2 | undefined;
// Model can be LanguageModelV2 (AI SDK v5) or LanguageModelV3 (AI SDK v6)
// Both have compatible doStream interfaces for our use case
let model: CompatibleLanguageModel | undefined;
if (typeof modelInit === 'string') {
model = gateway(modelInit);
// gateway() returns LanguageModelV2 in AI SDK v5 and LanguageModelV3 in AI SDK v6
// Both are compatible at runtime for doStream operations
model = gateway(modelInit) as CompatibleLanguageModel;
} else if (typeof modelInit === 'function') {
// User-provided model factory - could return V2 or V3
model = await modelInit();
} else {
throw new Error(
'Invalid "model initialization" argument. Must be a string or a function that returns a LanguageModelV2 instance.'
'Invalid "model initialization" argument. Must be a string or a function that returns a LanguageModel instance.'
);
}

Expand Down
17 changes: 11 additions & 6 deletions packages/ai/src/agent/durable-agent.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2StreamPart,
Expand All@@ -24,6 +23,10 @@ import {
import { convertToLanguageModelPrompt, standardizePrompt } from 'ai/internal';
import { FatalError } from 'workflow';
import { streamTextIterator } from './stream-text-iterator.js';
import type { CompatibleLanguageModel } from './types.js';

// Re-export for consumers
export type { CompatibleLanguageModel } from './types.js';

/**
* Re-export the Output helper for structured output specifications.
Expand DownExpand Up@@ -211,8 +214,9 @@ export interface GenerationSettings {
export interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
/**
* The current model configuration (string or function).
* The function should return a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);

/**
* The current step number (0-indexed).
Expand DownExpand Up@@ -243,8 +247,9 @@ export interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
export interface PrepareStepResult extends Partial<GenerationSettings> {
/**
* Override the model for this step.
* The function should return a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model?: string | (() => Promise<LanguageModelV2>);
model?: string | (() => Promise<CompatibleLanguageModel>);

/**
* Override the system message for this step.
Expand DownExpand Up@@ -291,9 +296,9 @@ export interface DurableAgentOptions extends GenerationSettings {
* The model provider to use for the agent.
*
* This should be a string compatible with the Vercel AI Gateway (e.g., 'anthropic/claude-opus'),
* or a step function that returns a `LanguageModelV2` instance.
* or a step function that returns a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);

/**
* A set of tools available to the agent.
Expand DownExpand Up@@ -594,7 +599,7 @@ export interface DurableAgentStreamResult<
* ```
*/
export class DurableAgent<TBaseTools extends ToolSet = ToolSet> {
private model: string | (() => Promise<LanguageModelV2>);
private model: string | (() => Promise<CompatibleLanguageModel>);
private tools: TBaseTools;
private system?: string;
private generationSettings: GenerationSettings;
Expand Down
6 changes: 3 additions & 3 deletions packages/ai/src/agent/stream-text-iterator.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2ToolCall,
Expand All@@ -21,6 +20,7 @@ import type {
TelemetrySettings,
} from './durable-agent.js';
import { toolsToModelTools } from './tools-to-model-tools.js';
import type { CompatibleLanguageModel } from './types.js';

/**
* The value yielded by the stream text iterator when tool calls are requested.
Expand DownExpand Up@@ -60,7 +60,7 @@ export async function* streamTextIterator({
prompt: LanguageModelV2Prompt;
tools: ToolSet;
writable: WritableStream<UIMessageChunk>;
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);
stopConditions?: ModelStopCondition[] | ModelStopCondition;
maxSteps?: number;
sendStart?: boolean;
Expand All@@ -82,7 +82,7 @@ export async function* streamTextIterator({
LanguageModelV2ToolResultPart[]
> {
let conversationPrompt = [...prompt]; // Create a mutable copy
let currentModel = model;
let currentModel: string | (() => Promise<CompatibleLanguageModel>) = model;
let currentGenerationSettings = generationSettings ?? {};
let currentToolChoice = toolChoice;
let currentContext = experimental_context;
Expand Down
36 changes: 36 additions & 0 deletions packages/ai/src/agent/types.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
/**
* Shared types for AI SDK v5 and v6 compatibility.
*/
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2StreamPart,
} from '@ai-sdk/provider';

/**
* Compatible language model type that works with both AI SDK v5 and v6.
*
* AI SDK v5 uses LanguageModelV2, while AI SDK v6 uses LanguageModelV3.
* Both have compatible `doStream` interfaces for our use case.
*
* This type represents the union of both model versions, allowing code
* to work seamlessly with either AI SDK version.
*
* Note: V3 models accept LanguageModelV2CallOptions at runtime due to
* structural compatibility between V2 and V3 prompt/options formats.
*/
export type CompatibleLanguageModel =
| LanguageModelV2
| {
readonly specificationVersion: 'v3';
readonly provider: string;
readonly modelId: string;
/**
* Stream method compatible with both V2 and V3 models.
* V3 models accept V2-style call options due to structural compatibility
* at runtime - the prompt and options structures are essentially identical.
*/
doStream(options: LanguageModelV2CallOptions): PromiseLike<{
stream: ReadableStream<LanguageModelV2StreamPart>;
}>;
};
1 change: 1 addition & 0 deletions packages/ai/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ export * from './workflow-chat-transport.js';
*/
export { DurableAgent, Output } from './agent/durable-agent.js';
export type {
CompatibleLanguageModel,
DurableAgentOptions,
DurableAgentStreamOptions,
DurableAgentStreamResult,
Expand Down
52 changes: 23 additions & 29 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/shiny-llamas-hunt.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@workflow/ai": patch
---

Add support for AI SDK v6
43 changes: 43 additions & 0 deletions packages/ai/README.md
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,46 @@
# @workflow/ai

[Workflow DevKit](https://useworkflow.dev) compatible helper library for the [AI SDK](https://ai-sdk.dev/).

## Installation

```bash
npm install @workflow/ai
```

## AI SDK Compatibility

This package supports both **AI SDK v5** and **AI SDK v6**. The `ai` package is a peer dependency, so you control which version to use:

```bash
# For AI SDK v6 (recommended, latest)
npm install ai

# For AI SDK v5
npm install ai@5
```

### Version Differences

| Feature | AI SDK v5 | AI SDK v6 |
|---------|-----------|-----------|
| Model interface | `LanguageModelV2` | `LanguageModelV3` |
| Provider package | `@ai-sdk/provider@2.x` | `@ai-sdk/provider@3.x` |

Both versions work seamlessly with `@workflow/ai` - the package handles the differences internally through a compatibility layer.

### Provider Packages

If you use the provider wrappers (e.g., `@workflow/ai/anthropic`, `@workflow/ai/openai`), install the corresponding provider packages:

```bash
# Example: Using Anthropic with AI SDK v6
npm install ai @ai-sdk/anthropic

# Example: Using OpenAI with AI SDK v5
npm install ai@5 @ai-sdk/openai@2
```

## Documentation

For usage examples and full documentation, see the [API reference](https://useworkflow.dev/docs/api-reference/workflow-ai/).
16 changes: 9 additions & 7 deletions packages/ai/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,16 +62,18 @@
"workflow": "workspace:*"
},
"peerDependencies": {
"ai": "^5",
"ai": "^5 || ^6",
"workflow": "4.0.1-beta.36"
},
"dependencies": {
"@ai-sdk/anthropic": "2.0.49",
"@ai-sdk/gateway": "2.0.15",
"@ai-sdk/google": "2.0.43",
"@ai-sdk/openai": "2.0.72",
"@ai-sdk/provider": "2.0.0",
"@ai-sdk/xai": "2.0.37",
"@ai-sdk/provider": "^2.0.0 || ^3.0.0",
"zod": "catalog:"
},
"optionalDependencies": {
"@ai-sdk/anthropic": "^2.0.0 || ^3.0.0",
"@ai-sdk/gateway": "^2.0.0 || ^3.0.0",
"@ai-sdk/google": "^2.0.0 || ^3.0.0",
"@ai-sdk/openai": "^2.0.0 || ^3.0.0",
"@ai-sdk/xai": "^2.0.0 || ^3.0.0"
}
}
15 changes: 10 additions & 5 deletions packages/ai/src/agent/do-stream-step.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2StreamPart,
Expand All@@ -20,6 +19,7 @@ import type {
StreamTextTransform,
TelemetrySettings,
} from './durable-agent.js';
import type { CompatibleLanguageModel } from './types.js';

export type FinishPart = Extract<LanguageModelV2StreamPart, { type: 'finish' }>;

Expand DownExpand Up@@ -87,21 +87,26 @@ function toLanguageModelToolChoice(

export async function doStreamStep(
conversationPrompt: LanguageModelV2Prompt,
modelInit: string | (() => Promise<LanguageModelV2>),
modelInit: string | (() => Promise<CompatibleLanguageModel>),
writable: WritableStream<UIMessageChunk>,
tools?: LanguageModelV2CallOptions['tools'],
options?: DoStreamStepOptions
) {
'use step';

let model: LanguageModelV2 | undefined;
// Model can be LanguageModelV2 (AI SDK v5) or LanguageModelV3 (AI SDK v6)
// Both have compatible doStream interfaces for our use case
let model: CompatibleLanguageModel | undefined;
if (typeof modelInit === 'string') {
model = gateway(modelInit);
// gateway() returns LanguageModelV2 in AI SDK v5 and LanguageModelV3 in AI SDK v6
// Both are compatible at runtime for doStream operations
model = gateway(modelInit) as CompatibleLanguageModel;
} else if (typeof modelInit === 'function') {
// User-provided model factory - could return V2 or V3
model = await modelInit();
} else {
throw new Error(
'Invalid "model initialization" argument. Must be a string or a function that returns a LanguageModelV2 instance.'
'Invalid "model initialization" argument. Must be a string or a function that returns a LanguageModel instance.'
);
}

Expand Down
17 changes: 11 additions & 6 deletions packages/ai/src/agent/durable-agent.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2StreamPart,
Expand All@@ -24,6 +23,10 @@ import {
import { convertToLanguageModelPrompt, standardizePrompt } from 'ai/internal';
import { FatalError } from 'workflow';
import { streamTextIterator } from './stream-text-iterator.js';
import type { CompatibleLanguageModel } from './types.js';

// Re-export for consumers
export type { CompatibleLanguageModel } from './types.js';

/**
* Re-export the Output helper for structured output specifications.
Expand DownExpand Up@@ -211,8 +214,9 @@ export interface GenerationSettings {
export interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
/**
* The current model configuration (string or function).
* The function should return a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);

/**
* The current step number (0-indexed).
Expand DownExpand Up@@ -243,8 +247,9 @@ export interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
export interface PrepareStepResult extends Partial<GenerationSettings> {
/**
* Override the model for this step.
* The function should return a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model?: string | (() => Promise<LanguageModelV2>);
model?: string | (() => Promise<CompatibleLanguageModel>);

/**
* Override the system message for this step.
Expand DownExpand Up@@ -291,9 +296,9 @@ export interface DurableAgentOptions extends GenerationSettings {
* The model provider to use for the agent.
*
* This should be a string compatible with the Vercel AI Gateway (e.g., 'anthropic/claude-opus'),
* or a step function that returns a `LanguageModelV2` instance.
* or a step function that returns a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);

/**
* A set of tools available to the agent.
Expand DownExpand Up@@ -594,7 +599,7 @@ export interface DurableAgentStreamResult<
* ```
*/
export class DurableAgent<TBaseTools extends ToolSet = ToolSet> {
private model: string | (() => Promise<LanguageModelV2>);
private model: string | (() => Promise<CompatibleLanguageModel>);
private tools: TBaseTools;
private system?: string;
private generationSettings: GenerationSettings;
Expand Down
6 changes: 3 additions & 3 deletions packages/ai/src/agent/stream-text-iterator.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2ToolCall,
Expand All@@ -21,6 +20,7 @@ import type {
TelemetrySettings,
} from './durable-agent.js';
import { toolsToModelTools } from './tools-to-model-tools.js';
import type { CompatibleLanguageModel } from './types.js';

/**
* The value yielded by the stream text iterator when tool calls are requested.
Expand DownExpand Up@@ -60,7 +60,7 @@ export async function* streamTextIterator({
prompt: LanguageModelV2Prompt;
tools: ToolSet;
writable: WritableStream<UIMessageChunk>;
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);
stopConditions?: ModelStopCondition[] | ModelStopCondition;
maxSteps?: number;
sendStart?: boolean;
Expand All@@ -82,7 +82,7 @@ export async function* streamTextIterator({
LanguageModelV2ToolResultPart[]
> {
let conversationPrompt = [...prompt]; // Create a mutable copy
let currentModel = model;
let currentModel: string | (() => Promise<CompatibleLanguageModel>) = model;
let currentGenerationSettings = generationSettings ?? {};
let currentToolChoice = toolChoice;
let currentContext = experimental_context;
Expand Down
36 changes: 36 additions & 0 deletions packages/ai/src/agent/types.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
/**
* Shared types for AI SDK v5 and v6 compatibility.
*/
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2StreamPart,
} from '@ai-sdk/provider';

/**
* Compatible language model type that works with both AI SDK v5 and v6.
*
* AI SDK v5 uses LanguageModelV2, while AI SDK v6 uses LanguageModelV3.
* Both have compatible `doStream` interfaces for our use case.
*
* This type represents the union of both model versions, allowing code
* to work seamlessly with either AI SDK version.
*
* Note: V3 models accept LanguageModelV2CallOptions at runtime due to
* structural compatibility between V2 and V3 prompt/options formats.
*/
export type CompatibleLanguageModel =
| LanguageModelV2
| {
readonly specificationVersion: 'v3';
readonly provider: string;
readonly modelId: string;
/**
* Stream method compatible with both V2 and V3 models.
* V3 models accept V2-style call options due to structural compatibility
* at runtime - the prompt and options structures are essentially identical.
*/
doStream(options: LanguageModelV2CallOptions): PromiseLike<{
stream: ReadableStream<LanguageModelV2StreamPart>;
}>;
};
1 change: 1 addition & 0 deletions packages/ai/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ export * from './workflow-chat-transport.js';
*/
export { DurableAgent, Output } from './agent/durable-agent.js';
export type {
CompatibleLanguageModel,
DurableAgentOptions,
DurableAgentStreamOptions,
DurableAgentStreamResult,
Expand Down
52 changes: 23 additions & 29 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/shiny-llamas-hunt.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@workflow/ai": patch
---

Add support for AI SDK v6
43 changes: 43 additions & 0 deletions packages/ai/README.md
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,46 @@
# @workflow/ai

[Workflow DevKit](https://useworkflow.dev) compatible helper library for the [AI SDK](https://ai-sdk.dev/).

## Installation

```bash
npm install @workflow/ai
```

## AI SDK Compatibility

This package supports both **AI SDK v5** and **AI SDK v6**. The `ai` package is a peer dependency, so you control which version to use:

```bash
# For AI SDK v6 (recommended, latest)
npm install ai

# For AI SDK v5
npm install ai@5
```

### Version Differences

| Feature | AI SDK v5 | AI SDK v6 |
|---------|-----------|-----------|
| Model interface | `LanguageModelV2` | `LanguageModelV3` |
| Provider package | `@ai-sdk/provider@2.x` | `@ai-sdk/provider@3.x` |

Both versions work seamlessly with `@workflow/ai` - the package handles the differences internally through a compatibility layer.

### Provider Packages

If you use the provider wrappers (e.g., `@workflow/ai/anthropic`, `@workflow/ai/openai`), install the corresponding provider packages:

```bash
# Example: Using Anthropic with AI SDK v6
npm install ai @ai-sdk/anthropic

# Example: Using OpenAI with AI SDK v5
npm install ai@5 @ai-sdk/openai@2
```

## Documentation

For usage examples and full documentation, see the [API reference](https://useworkflow.dev/docs/api-reference/workflow-ai/).
16 changes: 9 additions & 7 deletions packages/ai/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,16 +62,18 @@
"workflow": "workspace:*"
},
"peerDependencies": {
"ai": "^5",
"ai": "^5 || ^6",
"workflow": "4.0.1-beta.36"
},
"dependencies": {
"@ai-sdk/anthropic": "2.0.49",
"@ai-sdk/gateway": "2.0.15",
"@ai-sdk/google": "2.0.43",
"@ai-sdk/openai": "2.0.72",
"@ai-sdk/provider": "2.0.0",
"@ai-sdk/xai": "2.0.37",
"@ai-sdk/provider": "^2.0.0 || ^3.0.0",
"zod": "catalog:"
},
"optionalDependencies": {
"@ai-sdk/anthropic": "^2.0.0 || ^3.0.0",
"@ai-sdk/gateway": "^2.0.0 || ^3.0.0",
"@ai-sdk/google": "^2.0.0 || ^3.0.0",
"@ai-sdk/openai": "^2.0.0 || ^3.0.0",
"@ai-sdk/xai": "^2.0.0 || ^3.0.0"
}
}
15 changes: 10 additions & 5 deletions packages/ai/src/agent/do-stream-step.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2StreamPart,
Expand All@@ -20,6 +19,7 @@ import type {
StreamTextTransform,
TelemetrySettings,
} from './durable-agent.js';
import type { CompatibleLanguageModel } from './types.js';

export type FinishPart = Extract<LanguageModelV2StreamPart, { type: 'finish' }>;

Expand DownExpand Up@@ -87,21 +87,26 @@ function toLanguageModelToolChoice(

export async function doStreamStep(
conversationPrompt: LanguageModelV2Prompt,
modelInit: string | (() => Promise<LanguageModelV2>),
modelInit: string | (() => Promise<CompatibleLanguageModel>),
writable: WritableStream<UIMessageChunk>,
tools?: LanguageModelV2CallOptions['tools'],
options?: DoStreamStepOptions
) {
'use step';

let model: LanguageModelV2 | undefined;
// Model can be LanguageModelV2 (AI SDK v5) or LanguageModelV3 (AI SDK v6)
// Both have compatible doStream interfaces for our use case
let model: CompatibleLanguageModel | undefined;
if (typeof modelInit === 'string') {
model = gateway(modelInit);
// gateway() returns LanguageModelV2 in AI SDK v5 and LanguageModelV3 in AI SDK v6
// Both are compatible at runtime for doStream operations
model = gateway(modelInit) as CompatibleLanguageModel;
} else if (typeof modelInit === 'function') {
// User-provided model factory - could return V2 or V3
model = await modelInit();
} else {
throw new Error(
'Invalid "model initialization" argument. Must be a string or a function that returns a LanguageModelV2 instance.'
'Invalid "model initialization" argument. Must be a string or a function that returns a LanguageModel instance.'
);
}

Expand Down
17 changes: 11 additions & 6 deletions packages/ai/src/agent/durable-agent.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2StreamPart,
Expand All@@ -24,6 +23,10 @@ import {
import { convertToLanguageModelPrompt, standardizePrompt } from 'ai/internal';
import { FatalError } from 'workflow';
import { streamTextIterator } from './stream-text-iterator.js';
import type { CompatibleLanguageModel } from './types.js';

// Re-export for consumers
export type { CompatibleLanguageModel } from './types.js';

/**
* Re-export the Output helper for structured output specifications.
Expand DownExpand Up@@ -211,8 +214,9 @@ export interface GenerationSettings {
export interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
/**
* The current model configuration (string or function).
* The function should return a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);

/**
* The current step number (0-indexed).
Expand DownExpand Up@@ -243,8 +247,9 @@ export interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
export interface PrepareStepResult extends Partial<GenerationSettings> {
/**
* Override the model for this step.
* The function should return a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model?: string | (() => Promise<LanguageModelV2>);
model?: string | (() => Promise<CompatibleLanguageModel>);

/**
* Override the system message for this step.
Expand DownExpand Up@@ -291,9 +296,9 @@ export interface DurableAgentOptions extends GenerationSettings {
* The model provider to use for the agent.
*
* This should be a string compatible with the Vercel AI Gateway (e.g., 'anthropic/claude-opus'),
* or a step function that returns a `LanguageModelV2` instance.
* or a step function that returns a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);

/**
* A set of tools available to the agent.
Expand DownExpand Up@@ -594,7 +599,7 @@ export interface DurableAgentStreamResult<
* ```
*/
export class DurableAgent<TBaseTools extends ToolSet = ToolSet> {
private model: string | (() => Promise<LanguageModelV2>);
private model: string | (() => Promise<CompatibleLanguageModel>);
private tools: TBaseTools;
private system?: string;
private generationSettings: GenerationSettings;
Expand Down
6 changes: 3 additions & 3 deletions packages/ai/src/agent/stream-text-iterator.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2ToolCall,
Expand All@@ -21,6 +20,7 @@ import type {
TelemetrySettings,
} from './durable-agent.js';
import { toolsToModelTools } from './tools-to-model-tools.js';
import type { CompatibleLanguageModel } from './types.js';

/**
* The value yielded by the stream text iterator when tool calls are requested.
Expand DownExpand Up@@ -60,7 +60,7 @@ export async function* streamTextIterator({
prompt: LanguageModelV2Prompt;
tools: ToolSet;
writable: WritableStream<UIMessageChunk>;
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);
stopConditions?: ModelStopCondition[] | ModelStopCondition;
maxSteps?: number;
sendStart?: boolean;
Expand All@@ -82,7 +82,7 @@ export async function* streamTextIterator({
LanguageModelV2ToolResultPart[]
> {
let conversationPrompt = [...prompt]; // Create a mutable copy
let currentModel = model;
let currentModel: string | (() => Promise<CompatibleLanguageModel>) = model;
let currentGenerationSettings = generationSettings ?? {};
let currentToolChoice = toolChoice;
let currentContext = experimental_context;
Expand Down
36 changes: 36 additions & 0 deletions packages/ai/src/agent/types.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
/**
* Shared types for AI SDK v5 and v6 compatibility.
*/
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2StreamPart,
} from '@ai-sdk/provider';

/**
* Compatible language model type that works with both AI SDK v5 and v6.
*
* AI SDK v5 uses LanguageModelV2, while AI SDK v6 uses LanguageModelV3.
* Both have compatible `doStream` interfaces for our use case.
*
* This type represents the union of both model versions, allowing code
* to work seamlessly with either AI SDK version.
*
* Note: V3 models accept LanguageModelV2CallOptions at runtime due to
* structural compatibility between V2 and V3 prompt/options formats.
*/
export type CompatibleLanguageModel =
| LanguageModelV2
| {
readonly specificationVersion: 'v3';
readonly provider: string;
readonly modelId: string;
/**
* Stream method compatible with both V2 and V3 models.
* V3 models accept V2-style call options due to structural compatibility
* at runtime - the prompt and options structures are essentially identical.
*/
doStream(options: LanguageModelV2CallOptions): PromiseLike<{
stream: ReadableStream<LanguageModelV2StreamPart>;
}>;
};
1 change: 1 addition & 0 deletions packages/ai/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ export * from './workflow-chat-transport.js';
*/
export { DurableAgent, Output } from './agent/durable-agent.js';
export type {
CompatibleLanguageModel,
DurableAgentOptions,
DurableAgentStreamOptions,
DurableAgentStreamResult,
Expand Down
52 changes: 23 additions & 29 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/shiny-llamas-hunt.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@workflow/ai": patch
---

Add support for AI SDK v6
43 changes: 43 additions & 0 deletions packages/ai/README.md
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,46 @@
# @workflow/ai

[Workflow DevKit](https://useworkflow.dev) compatible helper library for the [AI SDK](https://ai-sdk.dev/).

## Installation

```bash
npm install @workflow/ai
```

## AI SDK Compatibility

This package supports both **AI SDK v5** and **AI SDK v6**. The `ai` package is a peer dependency, so you control which version to use:

```bash
# For AI SDK v6 (recommended, latest)
npm install ai

# For AI SDK v5
npm install ai@5
```

### Version Differences

| Feature | AI SDK v5 | AI SDK v6 |
|---------|-----------|-----------|
| Model interface | `LanguageModelV2` | `LanguageModelV3` |
| Provider package | `@ai-sdk/provider@2.x` | `@ai-sdk/provider@3.x` |

Both versions work seamlessly with `@workflow/ai` - the package handles the differences internally through a compatibility layer.

### Provider Packages

If you use the provider wrappers (e.g., `@workflow/ai/anthropic`, `@workflow/ai/openai`), install the corresponding provider packages:

```bash
# Example: Using Anthropic with AI SDK v6
npm install ai @ai-sdk/anthropic

# Example: Using OpenAI with AI SDK v5
npm install ai@5 @ai-sdk/openai@2
```

## Documentation

For usage examples and full documentation, see the [API reference](https://useworkflow.dev/docs/api-reference/workflow-ai/).
16 changes: 9 additions & 7 deletions packages/ai/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,16 +62,18 @@
"workflow": "workspace:*"
},
"peerDependencies": {
"ai": "^5",
"ai": "^5 || ^6",
"workflow": "4.0.1-beta.36"
},
"dependencies": {
"@ai-sdk/anthropic": "2.0.49",
"@ai-sdk/gateway": "2.0.15",
"@ai-sdk/google": "2.0.43",
"@ai-sdk/openai": "2.0.72",
"@ai-sdk/provider": "2.0.0",
"@ai-sdk/xai": "2.0.37",
"@ai-sdk/provider": "^2.0.0 || ^3.0.0",
"zod": "catalog:"
},
"optionalDependencies": {
"@ai-sdk/anthropic": "^2.0.0 || ^3.0.0",
"@ai-sdk/gateway": "^2.0.0 || ^3.0.0",
"@ai-sdk/google": "^2.0.0 || ^3.0.0",
"@ai-sdk/openai": "^2.0.0 || ^3.0.0",
"@ai-sdk/xai": "^2.0.0 || ^3.0.0"
}
}
15 changes: 10 additions & 5 deletions packages/ai/src/agent/do-stream-step.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2StreamPart,
Expand All@@ -20,6 +19,7 @@ import type {
StreamTextTransform,
TelemetrySettings,
} from './durable-agent.js';
import type { CompatibleLanguageModel } from './types.js';

export type FinishPart = Extract<LanguageModelV2StreamPart, { type: 'finish' }>;

Expand DownExpand Up@@ -87,21 +87,26 @@ function toLanguageModelToolChoice(

export async function doStreamStep(
conversationPrompt: LanguageModelV2Prompt,
modelInit: string | (() => Promise<LanguageModelV2>),
modelInit: string | (() => Promise<CompatibleLanguageModel>),
writable: WritableStream<UIMessageChunk>,
tools?: LanguageModelV2CallOptions['tools'],
options?: DoStreamStepOptions
) {
'use step';

let model: LanguageModelV2 | undefined;
// Model can be LanguageModelV2 (AI SDK v5) or LanguageModelV3 (AI SDK v6)
// Both have compatible doStream interfaces for our use case
let model: CompatibleLanguageModel | undefined;
if (typeof modelInit === 'string') {
model = gateway(modelInit);
// gateway() returns LanguageModelV2 in AI SDK v5 and LanguageModelV3 in AI SDK v6
// Both are compatible at runtime for doStream operations
model = gateway(modelInit) as CompatibleLanguageModel;
} else if (typeof modelInit === 'function') {
// User-provided model factory - could return V2 or V3
model = await modelInit();
} else {
throw new Error(
'Invalid "model initialization" argument. Must be a string or a function that returns a LanguageModelV2 instance.'
'Invalid "model initialization" argument. Must be a string or a function that returns a LanguageModel instance.'
);
}

Expand Down
17 changes: 11 additions & 6 deletions packages/ai/src/agent/durable-agent.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2StreamPart,
Expand All@@ -24,6 +23,10 @@ import {
import { convertToLanguageModelPrompt, standardizePrompt } from 'ai/internal';
import { FatalError } from 'workflow';
import { streamTextIterator } from './stream-text-iterator.js';
import type { CompatibleLanguageModel } from './types.js';

// Re-export for consumers
export type { CompatibleLanguageModel } from './types.js';

/**
* Re-export the Output helper for structured output specifications.
Expand DownExpand Up@@ -211,8 +214,9 @@ export interface GenerationSettings {
export interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
/**
* The current model configuration (string or function).
* The function should return a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);

/**
* The current step number (0-indexed).
Expand DownExpand Up@@ -243,8 +247,9 @@ export interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
export interface PrepareStepResult extends Partial<GenerationSettings> {
/**
* Override the model for this step.
* The function should return a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model?: string | (() => Promise<LanguageModelV2>);
model?: string | (() => Promise<CompatibleLanguageModel>);

/**
* Override the system message for this step.
Expand DownExpand Up@@ -291,9 +296,9 @@ export interface DurableAgentOptions extends GenerationSettings {
* The model provider to use for the agent.
*
* This should be a string compatible with the Vercel AI Gateway (e.g., 'anthropic/claude-opus'),
* or a step function that returns a `LanguageModelV2` instance.
* or a step function that returns a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);

/**
* A set of tools available to the agent.
Expand DownExpand Up@@ -594,7 +599,7 @@ export interface DurableAgentStreamResult<
* ```
*/
export class DurableAgent<TBaseTools extends ToolSet = ToolSet> {
private model: string | (() => Promise<LanguageModelV2>);
private model: string | (() => Promise<CompatibleLanguageModel>);
private tools: TBaseTools;
private system?: string;
private generationSettings: GenerationSettings;
Expand Down
6 changes: 3 additions & 3 deletions packages/ai/src/agent/stream-text-iterator.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2ToolCall,
Expand All@@ -21,6 +20,7 @@ import type {
TelemetrySettings,
} from './durable-agent.js';
import { toolsToModelTools } from './tools-to-model-tools.js';
import type { CompatibleLanguageModel } from './types.js';

/**
* The value yielded by the stream text iterator when tool calls are requested.
Expand DownExpand Up@@ -60,7 +60,7 @@ export async function* streamTextIterator({
prompt: LanguageModelV2Prompt;
tools: ToolSet;
writable: WritableStream<UIMessageChunk>;
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);
stopConditions?: ModelStopCondition[] | ModelStopCondition;
maxSteps?: number;
sendStart?: boolean;
Expand All@@ -82,7 +82,7 @@ export async function* streamTextIterator({
LanguageModelV2ToolResultPart[]
> {
let conversationPrompt = [...prompt]; // Create a mutable copy
let currentModel = model;
let currentModel: string | (() => Promise<CompatibleLanguageModel>) = model;
let currentGenerationSettings = generationSettings ?? {};
let currentToolChoice = toolChoice;
let currentContext = experimental_context;
Expand Down
36 changes: 36 additions & 0 deletions packages/ai/src/agent/types.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
/**
* Shared types for AI SDK v5 and v6 compatibility.
*/
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2StreamPart,
} from '@ai-sdk/provider';

/**
* Compatible language model type that works with both AI SDK v5 and v6.
*
* AI SDK v5 uses LanguageModelV2, while AI SDK v6 uses LanguageModelV3.
* Both have compatible `doStream` interfaces for our use case.
*
* This type represents the union of both model versions, allowing code
* to work seamlessly with either AI SDK version.
*
* Note: V3 models accept LanguageModelV2CallOptions at runtime due to
* structural compatibility between V2 and V3 prompt/options formats.
*/
export type CompatibleLanguageModel =
| LanguageModelV2
| {
readonly specificationVersion: 'v3';
readonly provider: string;
readonly modelId: string;
/**
* Stream method compatible with both V2 and V3 models.
* V3 models accept V2-style call options due to structural compatibility
* at runtime - the prompt and options structures are essentially identical.
*/
doStream(options: LanguageModelV2CallOptions): PromiseLike<{
stream: ReadableStream<LanguageModelV2StreamPart>;
}>;
};
1 change: 1 addition & 0 deletions packages/ai/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ export * from './workflow-chat-transport.js';
*/
export { DurableAgent, Output } from './agent/durable-agent.js';
export type {
CompatibleLanguageModel,
DurableAgentOptions,
DurableAgentStreamOptions,
DurableAgentStreamResult,
Expand Down
52 changes: 23 additions & 29 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/shiny-llamas-hunt.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@workflow/ai": patch
---

Add support for AI SDK v6
43 changes: 43 additions & 0 deletions packages/ai/README.md
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,46 @@
# @workflow/ai

[Workflow DevKit](https://useworkflow.dev) compatible helper library for the [AI SDK](https://ai-sdk.dev/).

## Installation

```bash
npm install @workflow/ai
```

## AI SDK Compatibility

This package supports both **AI SDK v5** and **AI SDK v6**. The `ai` package is a peer dependency, so you control which version to use:

```bash
# For AI SDK v6 (recommended, latest)
npm install ai

# For AI SDK v5
npm install ai@5
```

### Version Differences

| Feature | AI SDK v5 | AI SDK v6 |
|---------|-----------|-----------|
| Model interface | `LanguageModelV2` | `LanguageModelV3` |
| Provider package | `@ai-sdk/provider@2.x` | `@ai-sdk/provider@3.x` |

Both versions work seamlessly with `@workflow/ai` - the package handles the differences internally through a compatibility layer.

### Provider Packages

If you use the provider wrappers (e.g., `@workflow/ai/anthropic`, `@workflow/ai/openai`), install the corresponding provider packages:

```bash
# Example: Using Anthropic with AI SDK v6
npm install ai @ai-sdk/anthropic

# Example: Using OpenAI with AI SDK v5
npm install ai@5 @ai-sdk/openai@2
```

## Documentation

For usage examples and full documentation, see the [API reference](https://useworkflow.dev/docs/api-reference/workflow-ai/).
16 changes: 9 additions & 7 deletions packages/ai/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,16 +62,18 @@
"workflow": "workspace:*"
},
"peerDependencies": {
"ai": "^5",
"ai": "^5 || ^6",
"workflow": "4.0.1-beta.36"
},
"dependencies": {
"@ai-sdk/anthropic": "2.0.49",
"@ai-sdk/gateway": "2.0.15",
"@ai-sdk/google": "2.0.43",
"@ai-sdk/openai": "2.0.72",
"@ai-sdk/provider": "2.0.0",
"@ai-sdk/xai": "2.0.37",
"@ai-sdk/provider": "^2.0.0 || ^3.0.0",
"zod": "catalog:"
},
"optionalDependencies": {
"@ai-sdk/anthropic": "^2.0.0 || ^3.0.0",
"@ai-sdk/gateway": "^2.0.0 || ^3.0.0",
"@ai-sdk/google": "^2.0.0 || ^3.0.0",
"@ai-sdk/openai": "^2.0.0 || ^3.0.0",
"@ai-sdk/xai": "^2.0.0 || ^3.0.0"
}
}
15 changes: 10 additions & 5 deletions packages/ai/src/agent/do-stream-step.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2StreamPart,
Expand All@@ -20,6 +19,7 @@ import type {
StreamTextTransform,
TelemetrySettings,
} from './durable-agent.js';
import type { CompatibleLanguageModel } from './types.js';

export type FinishPart = Extract<LanguageModelV2StreamPart, { type: 'finish' }>;

Expand DownExpand Up@@ -87,21 +87,26 @@ function toLanguageModelToolChoice(

export async function doStreamStep(
conversationPrompt: LanguageModelV2Prompt,
modelInit: string | (() => Promise<LanguageModelV2>),
modelInit: string | (() => Promise<CompatibleLanguageModel>),
writable: WritableStream<UIMessageChunk>,
tools?: LanguageModelV2CallOptions['tools'],
options?: DoStreamStepOptions
) {
'use step';

let model: LanguageModelV2 | undefined;
// Model can be LanguageModelV2 (AI SDK v5) or LanguageModelV3 (AI SDK v6)
// Both have compatible doStream interfaces for our use case
let model: CompatibleLanguageModel | undefined;
if (typeof modelInit === 'string') {
model = gateway(modelInit);
// gateway() returns LanguageModelV2 in AI SDK v5 and LanguageModelV3 in AI SDK v6
// Both are compatible at runtime for doStream operations
model = gateway(modelInit) as CompatibleLanguageModel;
} else if (typeof modelInit === 'function') {
// User-provided model factory - could return V2 or V3
model = await modelInit();
} else {
throw new Error(
'Invalid "model initialization" argument. Must be a string or a function that returns a LanguageModelV2 instance.'
'Invalid "model initialization" argument. Must be a string or a function that returns a LanguageModel instance.'
);
}

Expand Down
17 changes: 11 additions & 6 deletions packages/ai/src/agent/durable-agent.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2StreamPart,
Expand All@@ -24,6 +23,10 @@ import {
import { convertToLanguageModelPrompt, standardizePrompt } from 'ai/internal';
import { FatalError } from 'workflow';
import { streamTextIterator } from './stream-text-iterator.js';
import type { CompatibleLanguageModel } from './types.js';

// Re-export for consumers
export type { CompatibleLanguageModel } from './types.js';

/**
* Re-export the Output helper for structured output specifications.
Expand DownExpand Up@@ -211,8 +214,9 @@ export interface GenerationSettings {
export interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
/**
* The current model configuration (string or function).
* The function should return a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);

/**
* The current step number (0-indexed).
Expand DownExpand Up@@ -243,8 +247,9 @@ export interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
export interface PrepareStepResult extends Partial<GenerationSettings> {
/**
* Override the model for this step.
* The function should return a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model?: string | (() => Promise<LanguageModelV2>);
model?: string | (() => Promise<CompatibleLanguageModel>);

/**
* Override the system message for this step.
Expand DownExpand Up@@ -291,9 +296,9 @@ export interface DurableAgentOptions extends GenerationSettings {
* The model provider to use for the agent.
*
* This should be a string compatible with the Vercel AI Gateway (e.g., 'anthropic/claude-opus'),
* or a step function that returns a `LanguageModelV2` instance.
* or a step function that returns a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);

/**
* A set of tools available to the agent.
Expand DownExpand Up@@ -594,7 +599,7 @@ export interface DurableAgentStreamResult<
* ```
*/
export class DurableAgent<TBaseTools extends ToolSet = ToolSet> {
private model: string | (() => Promise<LanguageModelV2>);
private model: string | (() => Promise<CompatibleLanguageModel>);
private tools: TBaseTools;
private system?: string;
private generationSettings: GenerationSettings;
Expand Down
6 changes: 3 additions & 3 deletions packages/ai/src/agent/stream-text-iterator.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2ToolCall,
Expand All@@ -21,6 +20,7 @@ import type {
TelemetrySettings,
} from './durable-agent.js';
import { toolsToModelTools } from './tools-to-model-tools.js';
import type { CompatibleLanguageModel } from './types.js';

/**
* The value yielded by the stream text iterator when tool calls are requested.
Expand DownExpand Up@@ -60,7 +60,7 @@ export async function* streamTextIterator({
prompt: LanguageModelV2Prompt;
tools: ToolSet;
writable: WritableStream<UIMessageChunk>;
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);
stopConditions?: ModelStopCondition[] | ModelStopCondition;
maxSteps?: number;
sendStart?: boolean;
Expand All@@ -82,7 +82,7 @@ export async function* streamTextIterator({
LanguageModelV2ToolResultPart[]
> {
let conversationPrompt = [...prompt]; // Create a mutable copy
let currentModel = model;
let currentModel: string | (() => Promise<CompatibleLanguageModel>) = model;
let currentGenerationSettings = generationSettings ?? {};
let currentToolChoice = toolChoice;
let currentContext = experimental_context;
Expand Down
36 changes: 36 additions & 0 deletions packages/ai/src/agent/types.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
/**
* Shared types for AI SDK v5 and v6 compatibility.
*/
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2StreamPart,
} from '@ai-sdk/provider';

/**
* Compatible language model type that works with both AI SDK v5 and v6.
*
* AI SDK v5 uses LanguageModelV2, while AI SDK v6 uses LanguageModelV3.
* Both have compatible `doStream` interfaces for our use case.
*
* This type represents the union of both model versions, allowing code
* to work seamlessly with either AI SDK version.
*
* Note: V3 models accept LanguageModelV2CallOptions at runtime due to
* structural compatibility between V2 and V3 prompt/options formats.
*/
export type CompatibleLanguageModel =
| LanguageModelV2
| {
readonly specificationVersion: 'v3';
readonly provider: string;
readonly modelId: string;
/**
* Stream method compatible with both V2 and V3 models.
* V3 models accept V2-style call options due to structural compatibility
* at runtime - the prompt and options structures are essentially identical.
*/
doStream(options: LanguageModelV2CallOptions): PromiseLike<{
stream: ReadableStream<LanguageModelV2StreamPart>;
}>;
};
1 change: 1 addition & 0 deletions packages/ai/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ export * from './workflow-chat-transport.js';
*/
export { DurableAgent, Output } from './agent/durable-agent.js';
export type {
CompatibleLanguageModel,
DurableAgentOptions,
DurableAgentStreamOptions,
DurableAgentStreamResult,
Expand Down
52 changes: 23 additions & 29 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/shiny-llamas-hunt.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@workflow/ai": patch
---

Add support for AI SDK v6
43 changes: 43 additions & 0 deletions packages/ai/README.md
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,46 @@
# @workflow/ai

[Workflow DevKit](https://useworkflow.dev) compatible helper library for the [AI SDK](https://ai-sdk.dev/).

## Installation

```bash
npm install @workflow/ai
```

## AI SDK Compatibility

This package supports both **AI SDK v5** and **AI SDK v6**. The `ai` package is a peer dependency, so you control which version to use:

```bash
# For AI SDK v6 (recommended, latest)
npm install ai

# For AI SDK v5
npm install ai@5
```

### Version Differences

| Feature | AI SDK v5 | AI SDK v6 |
|---------|-----------|-----------|
| Model interface | `LanguageModelV2` | `LanguageModelV3` |
| Provider package | `@ai-sdk/provider@2.x` | `@ai-sdk/provider@3.x` |

Both versions work seamlessly with `@workflow/ai` - the package handles the differences internally through a compatibility layer.

### Provider Packages

If you use the provider wrappers (e.g., `@workflow/ai/anthropic`, `@workflow/ai/openai`), install the corresponding provider packages:

```bash
# Example: Using Anthropic with AI SDK v6
npm install ai @ai-sdk/anthropic

# Example: Using OpenAI with AI SDK v5
npm install ai@5 @ai-sdk/openai@2
```

## Documentation

For usage examples and full documentation, see the [API reference](https://useworkflow.dev/docs/api-reference/workflow-ai/).
16 changes: 9 additions & 7 deletions packages/ai/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,16 +62,18 @@
"workflow": "workspace:*"
},
"peerDependencies": {
"ai": "^5",
"ai": "^5 || ^6",
"workflow": "4.0.1-beta.36"
},
"dependencies": {
"@ai-sdk/anthropic": "2.0.49",
"@ai-sdk/gateway": "2.0.15",
"@ai-sdk/google": "2.0.43",
"@ai-sdk/openai": "2.0.72",
"@ai-sdk/provider": "2.0.0",
"@ai-sdk/xai": "2.0.37",
"@ai-sdk/provider": "^2.0.0 || ^3.0.0",
"zod": "catalog:"
},
"optionalDependencies": {
"@ai-sdk/anthropic": "^2.0.0 || ^3.0.0",
"@ai-sdk/gateway": "^2.0.0 || ^3.0.0",
"@ai-sdk/google": "^2.0.0 || ^3.0.0",
"@ai-sdk/openai": "^2.0.0 || ^3.0.0",
"@ai-sdk/xai": "^2.0.0 || ^3.0.0"
}
}
15 changes: 10 additions & 5 deletions packages/ai/src/agent/do-stream-step.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2StreamPart,
Expand All@@ -20,6 +19,7 @@ import type {
StreamTextTransform,
TelemetrySettings,
} from './durable-agent.js';
import type { CompatibleLanguageModel } from './types.js';

export type FinishPart = Extract<LanguageModelV2StreamPart, { type: 'finish' }>;

Expand DownExpand Up@@ -87,21 +87,26 @@ function toLanguageModelToolChoice(

export async function doStreamStep(
conversationPrompt: LanguageModelV2Prompt,
modelInit: string | (() => Promise<LanguageModelV2>),
modelInit: string | (() => Promise<CompatibleLanguageModel>),
writable: WritableStream<UIMessageChunk>,
tools?: LanguageModelV2CallOptions['tools'],
options?: DoStreamStepOptions
) {
'use step';

let model: LanguageModelV2 | undefined;
// Model can be LanguageModelV2 (AI SDK v5) or LanguageModelV3 (AI SDK v6)
// Both have compatible doStream interfaces for our use case
let model: CompatibleLanguageModel | undefined;
if (typeof modelInit === 'string') {
model = gateway(modelInit);
// gateway() returns LanguageModelV2 in AI SDK v5 and LanguageModelV3 in AI SDK v6
// Both are compatible at runtime for doStream operations
model = gateway(modelInit) as CompatibleLanguageModel;
} else if (typeof modelInit === 'function') {
// User-provided model factory - could return V2 or V3
model = await modelInit();
} else {
throw new Error(
'Invalid "model initialization" argument. Must be a string or a function that returns a LanguageModelV2 instance.'
'Invalid "model initialization" argument. Must be a string or a function that returns a LanguageModel instance.'
);
}

Expand Down
17 changes: 11 additions & 6 deletions packages/ai/src/agent/durable-agent.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2StreamPart,
Expand All@@ -24,6 +23,10 @@ import {
import { convertToLanguageModelPrompt, standardizePrompt } from 'ai/internal';
import { FatalError } from 'workflow';
import { streamTextIterator } from './stream-text-iterator.js';
import type { CompatibleLanguageModel } from './types.js';

// Re-export for consumers
export type { CompatibleLanguageModel } from './types.js';

/**
* Re-export the Output helper for structured output specifications.
Expand DownExpand Up@@ -211,8 +214,9 @@ export interface GenerationSettings {
export interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
/**
* The current model configuration (string or function).
* The function should return a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);

/**
* The current step number (0-indexed).
Expand DownExpand Up@@ -243,8 +247,9 @@ export interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
export interface PrepareStepResult extends Partial<GenerationSettings> {
/**
* Override the model for this step.
* The function should return a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model?: string | (() => Promise<LanguageModelV2>);
model?: string | (() => Promise<CompatibleLanguageModel>);

/**
* Override the system message for this step.
Expand DownExpand Up@@ -291,9 +296,9 @@ export interface DurableAgentOptions extends GenerationSettings {
* The model provider to use for the agent.
*
* This should be a string compatible with the Vercel AI Gateway (e.g., 'anthropic/claude-opus'),
* or a step function that returns a `LanguageModelV2` instance.
* or a step function that returns a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);

/**
* A set of tools available to the agent.
Expand DownExpand Up@@ -594,7 +599,7 @@ export interface DurableAgentStreamResult<
* ```
*/
export class DurableAgent<TBaseTools extends ToolSet = ToolSet> {
private model: string | (() => Promise<LanguageModelV2>);
private model: string | (() => Promise<CompatibleLanguageModel>);
private tools: TBaseTools;
private system?: string;
private generationSettings: GenerationSettings;
Expand Down
6 changes: 3 additions & 3 deletions packages/ai/src/agent/stream-text-iterator.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2ToolCall,
Expand All@@ -21,6 +20,7 @@ import type {
TelemetrySettings,
} from './durable-agent.js';
import { toolsToModelTools } from './tools-to-model-tools.js';
import type { CompatibleLanguageModel } from './types.js';

/**
* The value yielded by the stream text iterator when tool calls are requested.
Expand DownExpand Up@@ -60,7 +60,7 @@ export async function* streamTextIterator({
prompt: LanguageModelV2Prompt;
tools: ToolSet;
writable: WritableStream<UIMessageChunk>;
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);
stopConditions?: ModelStopCondition[] | ModelStopCondition;
maxSteps?: number;
sendStart?: boolean;
Expand All@@ -82,7 +82,7 @@ export async function* streamTextIterator({
LanguageModelV2ToolResultPart[]
> {
let conversationPrompt = [...prompt]; // Create a mutable copy
let currentModel = model;
let currentModel: string | (() => Promise<CompatibleLanguageModel>) = model;
let currentGenerationSettings = generationSettings ?? {};
let currentToolChoice = toolChoice;
let currentContext = experimental_context;
Expand Down
36 changes: 36 additions & 0 deletions packages/ai/src/agent/types.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
/**
* Shared types for AI SDK v5 and v6 compatibility.
*/
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2StreamPart,
} from '@ai-sdk/provider';

/**
* Compatible language model type that works with both AI SDK v5 and v6.
*
* AI SDK v5 uses LanguageModelV2, while AI SDK v6 uses LanguageModelV3.
* Both have compatible `doStream` interfaces for our use case.
*
* This type represents the union of both model versions, allowing code
* to work seamlessly with either AI SDK version.
*
* Note: V3 models accept LanguageModelV2CallOptions at runtime due to
* structural compatibility between V2 and V3 prompt/options formats.
*/
export type CompatibleLanguageModel =
| LanguageModelV2
| {
readonly specificationVersion: 'v3';
readonly provider: string;
readonly modelId: string;
/**
* Stream method compatible with both V2 and V3 models.
* V3 models accept V2-style call options due to structural compatibility
* at runtime - the prompt and options structures are essentially identical.
*/
doStream(options: LanguageModelV2CallOptions): PromiseLike<{
stream: ReadableStream<LanguageModelV2StreamPart>;
}>;
};
1 change: 1 addition & 0 deletions packages/ai/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ export * from './workflow-chat-transport.js';
*/
export { DurableAgent, Output } from './agent/durable-agent.js';
export type {
CompatibleLanguageModel,
DurableAgentOptions,
DurableAgentStreamOptions,
DurableAgentStreamResult,
Expand Down
52 changes: 23 additions & 29 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/shiny-llamas-hunt.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@workflow/ai": patch
---

Add support for AI SDK v6
43 changes: 43 additions & 0 deletions packages/ai/README.md
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,46 @@
# @workflow/ai

[Workflow DevKit](https://useworkflow.dev) compatible helper library for the [AI SDK](https://ai-sdk.dev/).

## Installation

```bash
npm install @workflow/ai
```

## AI SDK Compatibility

This package supports both **AI SDK v5** and **AI SDK v6**. The `ai` package is a peer dependency, so you control which version to use:

```bash
# For AI SDK v6 (recommended, latest)
npm install ai

# For AI SDK v5
npm install ai@5
```

### Version Differences

| Feature | AI SDK v5 | AI SDK v6 |
|---------|-----------|-----------|
| Model interface | `LanguageModelV2` | `LanguageModelV3` |
| Provider package | `@ai-sdk/provider@2.x` | `@ai-sdk/provider@3.x` |

Both versions work seamlessly with `@workflow/ai` - the package handles the differences internally through a compatibility layer.

### Provider Packages

If you use the provider wrappers (e.g., `@workflow/ai/anthropic`, `@workflow/ai/openai`), install the corresponding provider packages:

```bash
# Example: Using Anthropic with AI SDK v6
npm install ai @ai-sdk/anthropic

# Example: Using OpenAI with AI SDK v5
npm install ai@5 @ai-sdk/openai@2
```

## Documentation

For usage examples and full documentation, see the [API reference](https://useworkflow.dev/docs/api-reference/workflow-ai/).
16 changes: 9 additions & 7 deletions packages/ai/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,16 +62,18 @@
"workflow": "workspace:*"
},
"peerDependencies": {
"ai": "^5",
"ai": "^5 || ^6",
"workflow": "4.0.1-beta.36"
},
"dependencies": {
"@ai-sdk/anthropic": "2.0.49",
"@ai-sdk/gateway": "2.0.15",
"@ai-sdk/google": "2.0.43",
"@ai-sdk/openai": "2.0.72",
"@ai-sdk/provider": "2.0.0",
"@ai-sdk/xai": "2.0.37",
"@ai-sdk/provider": "^2.0.0 || ^3.0.0",
"zod": "catalog:"
},
"optionalDependencies": {
"@ai-sdk/anthropic": "^2.0.0 || ^3.0.0",
"@ai-sdk/gateway": "^2.0.0 || ^3.0.0",
"@ai-sdk/google": "^2.0.0 || ^3.0.0",
"@ai-sdk/openai": "^2.0.0 || ^3.0.0",
"@ai-sdk/xai": "^2.0.0 || ^3.0.0"
}
}
15 changes: 10 additions & 5 deletions packages/ai/src/agent/do-stream-step.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2StreamPart,
Expand All@@ -20,6 +19,7 @@ import type {
StreamTextTransform,
TelemetrySettings,
} from './durable-agent.js';
import type { CompatibleLanguageModel } from './types.js';

export type FinishPart = Extract<LanguageModelV2StreamPart, { type: 'finish' }>;

Expand DownExpand Up@@ -87,21 +87,26 @@ function toLanguageModelToolChoice(

export async function doStreamStep(
conversationPrompt: LanguageModelV2Prompt,
modelInit: string | (() => Promise<LanguageModelV2>),
modelInit: string | (() => Promise<CompatibleLanguageModel>),
writable: WritableStream<UIMessageChunk>,
tools?: LanguageModelV2CallOptions['tools'],
options?: DoStreamStepOptions
) {
'use step';

let model: LanguageModelV2 | undefined;
// Model can be LanguageModelV2 (AI SDK v5) or LanguageModelV3 (AI SDK v6)
// Both have compatible doStream interfaces for our use case
let model: CompatibleLanguageModel | undefined;
if (typeof modelInit === 'string') {
model = gateway(modelInit);
// gateway() returns LanguageModelV2 in AI SDK v5 and LanguageModelV3 in AI SDK v6
// Both are compatible at runtime for doStream operations
model = gateway(modelInit) as CompatibleLanguageModel;
} else if (typeof modelInit === 'function') {
// User-provided model factory - could return V2 or V3
model = await modelInit();
} else {
throw new Error(
'Invalid "model initialization" argument. Must be a string or a function that returns a LanguageModelV2 instance.'
'Invalid "model initialization" argument. Must be a string or a function that returns a LanguageModel instance.'
);
}

Expand Down
17 changes: 11 additions & 6 deletions packages/ai/src/agent/durable-agent.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2StreamPart,
Expand All@@ -24,6 +23,10 @@ import {
import { convertToLanguageModelPrompt, standardizePrompt } from 'ai/internal';
import { FatalError } from 'workflow';
import { streamTextIterator } from './stream-text-iterator.js';
import type { CompatibleLanguageModel } from './types.js';

// Re-export for consumers
export type { CompatibleLanguageModel } from './types.js';

/**
* Re-export the Output helper for structured output specifications.
Expand DownExpand Up@@ -211,8 +214,9 @@ export interface GenerationSettings {
export interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
/**
* The current model configuration (string or function).
* The function should return a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);

/**
* The current step number (0-indexed).
Expand DownExpand Up@@ -243,8 +247,9 @@ export interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
export interface PrepareStepResult extends Partial<GenerationSettings> {
/**
* Override the model for this step.
* The function should return a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model?: string | (() => Promise<LanguageModelV2>);
model?: string | (() => Promise<CompatibleLanguageModel>);

/**
* Override the system message for this step.
Expand DownExpand Up@@ -291,9 +296,9 @@ export interface DurableAgentOptions extends GenerationSettings {
* The model provider to use for the agent.
*
* This should be a string compatible with the Vercel AI Gateway (e.g., 'anthropic/claude-opus'),
* or a step function that returns a `LanguageModelV2` instance.
* or a step function that returns a LanguageModel instance (V2 or V3 depending on AI SDK version).
*/
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);

/**
* A set of tools available to the agent.
Expand DownExpand Up@@ -594,7 +599,7 @@ export interface DurableAgentStreamResult<
* ```
*/
export class DurableAgent<TBaseTools extends ToolSet = ToolSet> {
private model: string | (() => Promise<LanguageModelV2>);
private model: string | (() => Promise<CompatibleLanguageModel>);
private tools: TBaseTools;
private system?: string;
private generationSettings: GenerationSettings;
Expand Down
6 changes: 3 additions & 3 deletions packages/ai/src/agent/stream-text-iterator.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2Prompt,
LanguageModelV2ToolCall,
Expand All@@ -21,6 +20,7 @@ import type {
TelemetrySettings,
} from './durable-agent.js';
import { toolsToModelTools } from './tools-to-model-tools.js';
import type { CompatibleLanguageModel } from './types.js';

/**
* The value yielded by the stream text iterator when tool calls are requested.
Expand DownExpand Up@@ -60,7 +60,7 @@ export async function* streamTextIterator({
prompt: LanguageModelV2Prompt;
tools: ToolSet;
writable: WritableStream<UIMessageChunk>;
model: string | (() => Promise<LanguageModelV2>);
model: string | (() => Promise<CompatibleLanguageModel>);
stopConditions?: ModelStopCondition[] | ModelStopCondition;
maxSteps?: number;
sendStart?: boolean;
Expand All@@ -82,7 +82,7 @@ export async function* streamTextIterator({
LanguageModelV2ToolResultPart[]
> {
let conversationPrompt = [...prompt]; // Create a mutable copy
let currentModel = model;
let currentModel: string | (() => Promise<CompatibleLanguageModel>) = model;
let currentGenerationSettings = generationSettings ?? {};
let currentToolChoice = toolChoice;
let currentContext = experimental_context;
Expand Down
36 changes: 36 additions & 0 deletions packages/ai/src/agent/types.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
/**
* Shared types for AI SDK v5 and v6 compatibility.
*/
import type {
LanguageModelV2,
LanguageModelV2CallOptions,
LanguageModelV2StreamPart,
} from '@ai-sdk/provider';

/**
* Compatible language model type that works with both AI SDK v5 and v6.
*
* AI SDK v5 uses LanguageModelV2, while AI SDK v6 uses LanguageModelV3.
* Both have compatible `doStream` interfaces for our use case.
*
* This type represents the union of both model versions, allowing code
* to work seamlessly with either AI SDK version.
*
* Note: V3 models accept LanguageModelV2CallOptions at runtime due to
* structural compatibility between V2 and V3 prompt/options formats.
*/
export type CompatibleLanguageModel =
| LanguageModelV2
| {
readonly specificationVersion: 'v3';
readonly provider: string;
readonly modelId: string;
/**
* Stream method compatible with both V2 and V3 models.
* V3 models accept V2-style call options due to structural compatibility
* at runtime - the prompt and options structures are essentially identical.
*/
doStream(options: LanguageModelV2CallOptions): PromiseLike<{
stream: ReadableStream<LanguageModelV2StreamPart>;
}>;
};
1 change: 1 addition & 0 deletions packages/ai/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ export * from './workflow-chat-transport.js';
*/
export { DurableAgent, Output } from './agent/durable-agent.js';
export type {
CompatibleLanguageModel,
DurableAgentOptions,
DurableAgentStreamOptions,
DurableAgentStreamResult,
Expand Down
52 changes: 23 additions & 29 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.