@orpc/ai-sdk 0.0.0-next.d92c7aa

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 oRPC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,81 @@
+<div align="center">
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
+</div>
+
+<h1></h1>
+
+<div align="center">
+  <a href="https://codecov.io/gh/unnoq/orpc">
+    <img alt="codecov" src="https://codecov.io/gh/unnoq/orpc/branch/main/graph/badge.svg">
+  </a>
+  <a href="https://www.npmjs.com/package/@orpc/ai-sdk">
+    <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fai-sdk?logo=npm" />
+  </a>
+  <a href="https://github.com/unnoq/orpc/blob/main/LICENSE">
+    <img alt="MIT License" src="https://img.shields.io/github/license/unnoq/orpc?logo=open-source-initiative" />
+  </a>
+  <a href="https://discord.gg/TXEbwRBvQn">
+    <img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
+  </a>
+  <a href="https://deepwiki.com/unnoq/orpc">
+    <img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki">
+  </a>
+</div>
+
+<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
+
+**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
+
+---
+
+## Highlights
+
+- **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
+- **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
+- **📝 Contract-First Development**: Optionally define your API contract before implementation.
+- **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
+- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, Pinia Colada, and more.
+- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
+- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
+- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
+- **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
+- **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
+- **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
+- **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
+
+## Documentation
+
+You can find the full documentation [here](https://orpc.unnoq.com).
+
+## Packages
+
+- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
+- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
+- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
+- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
+- [@orpc/otel](https://www.npmjs.com/package/@orpc/otel): [OpenTelemetry](https://opentelemetry.io/) integration for observability.
+- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
+- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
+- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
+- [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
+- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
+- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
+- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
+- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
+- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
+
+## `@orpc/ai-sdk`
+
+The [AI SDK](https://ai-sdk.dev/) integration for oRPC.
+
+## Sponsors
+
+<p align="center">
+  <a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
+    <img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
+  </a>
+</p>
+
+## License
+
+Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.

package/dist/index.d.mts

@@ -0,0 +1,114 @@
+import { ClientOptions } from '@orpc/client';
+import { Meta, ContractProcedure, Schema, AnySchema, ErrorMap, InferSchemaOutput, InferSchemaInput } from '@orpc/contract';
+import { Context, Procedure, CreateProcedureClientOptions } from '@orpc/server';
+import { MaybeOptionalOptions, SetOptional } from '@orpc/shared';
+export { AsyncIteratorClass, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
+import { Tool } from 'ai';
+
+declare const AI_SDK_TOOL_META_SYMBOL: unique symbol;
+interface AiSdkToolMeta extends Meta {
+    [AI_SDK_TOOL_META_SYMBOL]?: Partial<Tool<unknown, unknown>>;
+}
+declare class CreateToolError extends Error {
+}
+/**
+ * Implements [procedure contract](https://orpc.unnoq.com/docs/contract-first/define-contract#procedure-contract)
+ * as an [AI SDK Tool](https://ai-sdk.dev/docs/foundations/tools) by leveraging existing contract definitions.
+ *
+ * @warning Requires a contract with an `input` schema defined.
+ * @info Standard [procedures](https://orpc.unnoq.com/docs/procedure) are also compatible with [procedure contracts](https://orpc.unnoq.com/docs/contract-first/define-contract).
+ *
+ * @example
+ * ```ts
+ * import { oc } from '@orpc/contract'
+ * import {
+ *   AI_SDK_TOOL_META_SYMBOL,
+ *   AiSdkToolMeta,
+ *   implementTool,
+ * } from '@orpc/ai-sdk'
+ * import { z } from 'zod'
+ *
+ * interface ORPCMeta extends AiSdkToolMeta {} // optional extend meta
+ * const base = oc.$meta<ORPCMeta>({})
+ *
+ * const getWeatherContract = base
+ *   .meta({
+ *     [AI_SDK_TOOL_META_SYMBOL]: {
+ *       name: 'custom-tool-name', // AI SDK tool name
+ *     },
+ *   })
+ *   .route({
+ *     summary: 'Get the weather in a location', // AI SDK tool description
+ *   })
+ *   .input(
+ *     z.object({
+ *       location: z.string().describe('The location to get the weather for'),
+ *     }),
+ *   )
+ *   .output(
+ *     z.object({
+ *       location: z.string().describe('The location the weather is for'),
+ *       temperature: z.number().describe('The temperature in Celsius'),
+ *     }),
+ *   )
+ *
+ * const getWeatherTool = implementTool(getWeatherContract, {
+ *   execute: async ({ location }) => ({
+ *     location,
+ *     temperature: 72 + Math.floor(Math.random() * 21) - 10,
+ *   }),
+ * })
+ * ```
+ */
+declare function implementTool<TOutInput, TInOutput>(contract: ContractProcedure<Schema<any, TOutInput>, Schema<TInOutput, any>, any, AiSdkToolMeta>, ...rest: MaybeOptionalOptions<SetOptional<Tool<TOutInput, TInOutput>, 'inputSchema' | 'outputSchema'>>): Tool<TOutInput, TInOutput>;
+/**
+ * Converts a [procedure](https://orpc.unnoq.com/docs/procedure) into an [AI SDK Tool](https://ai-sdk.dev/docs/foundations/tools)
+ * by leveraging existing procedure definitions.
+ *
+ * @warning Requires a contract with an `input` schema defined.
+ * @warning Validation occurs twice (once for the tool, once for the procedure call).
+ * So validation may fail if inputSchema or outputSchema transform the data into different shapes.
+ *
+ * @example
+ * ```ts
+ * import { os } from '@orpc/server'
+ * import {
+ *   AI_SDK_TOOL_META_SYMBOL,
+ *   AiSdkToolMeta,
+ *   createTool
+ * } from '@orpc/ai-sdk'
+ * import { z } from 'zod'
+ *
+ * interface ORPCMeta extends AiSdkToolMeta {} // optional extend meta
+ * const base = os.$meta<ORPCMeta>({})
+ *
+ * const getWeatherProcedure = base
+ *   .meta({
+ *     [AI_SDK_TOOL_META_SYMBOL]: {
+ *       name: 'custom-tool-name', // AI SDK tool name
+ *     },
+ *   })
+ *   .route({
+ *     summary: 'Get the weather in a location',
+ *   })
+ *   .input(z.object({
+ *     location: z.string().describe('The location to get the weather for'),
+ *   }))
+ *   .output(z.object({
+ *     location: z.string().describe('The location the weather is for'),
+ *     temperature: z.number().describe('The temperature in Celsius'),
+ *   }))
+ *   .handler(async ({ input }) => ({
+ *     location: input.location,
+ *     temperature: 72 + Math.floor(Math.random() * 21) - 10,
+ *   }))
+ *
+ * const getWeatherTool = createTool(getWeatherProcedure, {
+ *   context: {}, // provide initial context if needed
+ * })
+ * ```
+ */
+declare function createTool<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends AiSdkToolMeta>(procedure: Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>, ...rest: MaybeOptionalOptions<SetOptional<Tool<InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>>, 'inputSchema' | 'outputSchema' | 'execute'> & CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>> & Omit<ClientOptions<Record<never, never>>, 'context'>>): Tool<InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>>;
+
+export { AI_SDK_TOOL_META_SYMBOL, CreateToolError, createTool, implementTool };
+export type { AiSdkToolMeta };

package/dist/index.d.ts

@@ -0,0 +1,114 @@
+import { ClientOptions } from '@orpc/client';
+import { Meta, ContractProcedure, Schema, AnySchema, ErrorMap, InferSchemaOutput, InferSchemaInput } from '@orpc/contract';
+import { Context, Procedure, CreateProcedureClientOptions } from '@orpc/server';
+import { MaybeOptionalOptions, SetOptional } from '@orpc/shared';
+export { AsyncIteratorClass, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
+import { Tool } from 'ai';
+
+declare const AI_SDK_TOOL_META_SYMBOL: unique symbol;
+interface AiSdkToolMeta extends Meta {
+    [AI_SDK_TOOL_META_SYMBOL]?: Partial<Tool<unknown, unknown>>;
+}
+declare class CreateToolError extends Error {
+}
+/**
+ * Implements [procedure contract](https://orpc.unnoq.com/docs/contract-first/define-contract#procedure-contract)
+ * as an [AI SDK Tool](https://ai-sdk.dev/docs/foundations/tools) by leveraging existing contract definitions.
+ *
+ * @warning Requires a contract with an `input` schema defined.
+ * @info Standard [procedures](https://orpc.unnoq.com/docs/procedure) are also compatible with [procedure contracts](https://orpc.unnoq.com/docs/contract-first/define-contract).
+ *
+ * @example
+ * ```ts
+ * import { oc } from '@orpc/contract'
+ * import {
+ *   AI_SDK_TOOL_META_SYMBOL,
+ *   AiSdkToolMeta,
+ *   implementTool,
+ * } from '@orpc/ai-sdk'
+ * import { z } from 'zod'
+ *
+ * interface ORPCMeta extends AiSdkToolMeta {} // optional extend meta
+ * const base = oc.$meta<ORPCMeta>({})
+ *
+ * const getWeatherContract = base
+ *   .meta({
+ *     [AI_SDK_TOOL_META_SYMBOL]: {
+ *       name: 'custom-tool-name', // AI SDK tool name
+ *     },
+ *   })
+ *   .route({
+ *     summary: 'Get the weather in a location', // AI SDK tool description
+ *   })
+ *   .input(
+ *     z.object({
+ *       location: z.string().describe('The location to get the weather for'),
+ *     }),
+ *   )
+ *   .output(
+ *     z.object({
+ *       location: z.string().describe('The location the weather is for'),
+ *       temperature: z.number().describe('The temperature in Celsius'),
+ *     }),
+ *   )
+ *
+ * const getWeatherTool = implementTool(getWeatherContract, {
+ *   execute: async ({ location }) => ({
+ *     location,
+ *     temperature: 72 + Math.floor(Math.random() * 21) - 10,
+ *   }),
+ * })
+ * ```
+ */
+declare function implementTool<TOutInput, TInOutput>(contract: ContractProcedure<Schema<any, TOutInput>, Schema<TInOutput, any>, any, AiSdkToolMeta>, ...rest: MaybeOptionalOptions<SetOptional<Tool<TOutInput, TInOutput>, 'inputSchema' | 'outputSchema'>>): Tool<TOutInput, TInOutput>;
+/**
+ * Converts a [procedure](https://orpc.unnoq.com/docs/procedure) into an [AI SDK Tool](https://ai-sdk.dev/docs/foundations/tools)
+ * by leveraging existing procedure definitions.
+ *
+ * @warning Requires a contract with an `input` schema defined.
+ * @warning Validation occurs twice (once for the tool, once for the procedure call).
+ * So validation may fail if inputSchema or outputSchema transform the data into different shapes.
+ *
+ * @example
+ * ```ts
+ * import { os } from '@orpc/server'
+ * import {
+ *   AI_SDK_TOOL_META_SYMBOL,
+ *   AiSdkToolMeta,
+ *   createTool
+ * } from '@orpc/ai-sdk'
+ * import { z } from 'zod'
+ *
+ * interface ORPCMeta extends AiSdkToolMeta {} // optional extend meta
+ * const base = os.$meta<ORPCMeta>({})
+ *
+ * const getWeatherProcedure = base
+ *   .meta({
+ *     [AI_SDK_TOOL_META_SYMBOL]: {
+ *       name: 'custom-tool-name', // AI SDK tool name
+ *     },
+ *   })
+ *   .route({
+ *     summary: 'Get the weather in a location',
+ *   })
+ *   .input(z.object({
+ *     location: z.string().describe('The location to get the weather for'),
+ *   }))
+ *   .output(z.object({
+ *     location: z.string().describe('The location the weather is for'),
+ *     temperature: z.number().describe('The temperature in Celsius'),
+ *   }))
+ *   .handler(async ({ input }) => ({
+ *     location: input.location,
+ *     temperature: 72 + Math.floor(Math.random() * 21) - 10,
+ *   }))
+ *
+ * const getWeatherTool = createTool(getWeatherProcedure, {
+ *   context: {}, // provide initial context if needed
+ * })
+ * ```
+ */
+declare function createTool<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends AiSdkToolMeta>(procedure: Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>, ...rest: MaybeOptionalOptions<SetOptional<Tool<InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>>, 'inputSchema' | 'outputSchema' | 'execute'> & CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>> & Omit<ClientOptions<Record<never, never>>, 'context'>>): Tool<InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>>;
+
+export { AI_SDK_TOOL_META_SYMBOL, CreateToolError, createTool, implementTool };
+export type { AiSdkToolMeta };

package/dist/index.mjs

@@ -0,0 +1,32 @@
+import { call } from '@orpc/server';
+import { resolveMaybeOptionalOptions } from '@orpc/shared';
+export { AsyncIteratorClass, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
+import { tool } from 'ai';
+
+const AI_SDK_TOOL_META_SYMBOL = Symbol("ORPC_AI_SDK_TOOL_META");
+class CreateToolError extends Error {
+}
+function implementTool(contract, ...rest) {
+  if (contract["~orpc"].inputSchema === void 0) {
+    throw new CreateToolError("Cannot implement tool from a contract procedure without input schema.");
+  }
+  const options = resolveMaybeOptionalOptions(rest);
+  return tool({
+    inputSchema: contract["~orpc"].inputSchema,
+    outputSchema: contract["~orpc"].outputSchema,
+    description: contract["~orpc"].route.summary ?? contract["~orpc"].route.description,
+    ...contract["~orpc"].meta[AI_SDK_TOOL_META_SYMBOL],
+    ...options
+  });
+}
+function createTool(procedure, ...rest) {
+  const options = resolveMaybeOptionalOptions(rest);
+  return implementTool(procedure, {
+    execute: (input) => {
+      return call(procedure, input, options);
+    },
+    ...options
+  });
+}
+
+export { AI_SDK_TOOL_META_SYMBOL, CreateToolError, createTool, implementTool };

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@orpc/ai-sdk",
+  "type": "module",
+  "version": "0.0.0-next.d92c7aa",
+  "license": "MIT",
+  "homepage": "https://orpc.unnoq.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/unnoq/orpc.git",
+    "directory": "packages/ai-sdk"
+  },
+  "keywords": [
+    "ai-sdk",
+    "orpc"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "ai": ">=5.0.76"
+  },
+  "dependencies": {
+    "@orpc/client": "0.0.0-next.d92c7aa",
+    "@orpc/contract": "0.0.0-next.d92c7aa",
+    "@orpc/server": "0.0.0-next.d92c7aa",
+    "@orpc/shared": "0.0.0-next.d92c7aa"
+  },
+  "devDependencies": {
+    "ai": "6.0.0-beta.85",
+    "zod": "^4.1.12"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "build:watch": "pnpm run build --watch",
+    "type:check": "tsc -b"
+  }
+}