heroku-ai-provider 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,501 @@
+# Heroku AI SDK Provider
+
+A TypeScript provider for the [Vercel AI SDK](https://sdk.vercel.ai/) that enables you to use Heroku's AI inference capabilities in your applications. This provider supports both chat completions and embeddings through Heroku's AI infrastructure.
+
+## Features
+
+- 🤖 **Chat Completions**: Support for Claude 3.5 Sonnet, Claude 3 Haiku, and other Heroku-hosted models
+- 🧠 **Embeddings**: Generate vector embeddings using Cohere's multilingual embedding model
+- 🔧 **Tool Support**: Function calling capabilities for building AI agents and assistants
+- 📡 **Streaming**: Real-time streaming responses for chat completions
+- 🔐 **TypeScript**: Full TypeScript support with comprehensive type definitions
+- ⚡ **Dual Module Support**: Compatible with both ESM and CommonJS projects
+
+## Installation
+
+```bash
+npm install heroku-ai-provider
+# or
+yarn add heroku-ai-provider
+# or
+pnpm add heroku-ai-provider
+```
+
+## Prerequisites
+
+Before using this provider, you'll need:
+
+1. A Heroku account with access to AI services
+2. Heroku AI API keys for inference and/or embeddings
+3. The Vercel AI SDK installed in your project
+
+```bash
+npm install ai
+```
+
+## Basic Setup
+
+### Environment Variables
+
+Set your Heroku AI API keys as environment variables:
+
+```bash
+# For chat completions
+HEROKU_INFERENCE_KEY=your_inference_api_key
+
+# For embeddings
+HEROKU_EMBEDDING_KEY=your_embedding_api_key
+
+# Optional: Custom API endpoints
+HEROKU_INFERENCE_URL=https://us.inference.heroku.com
+HEROKU_EMBEDDING_URL=https://us.inference.heroku.com
+```
+
+### Basic Configuration
+
+```typescript
+import { createHerokuProvider } from "heroku-ai-provider";
+
+// Using environment variables (recommended)
+const heroku = createHerokuProvider();
+
+// Or with explicit configuration
+const heroku = createHerokuProvider({
+  chatApiKey: "your_inference_api_key",
+  embeddingsApiKey: "your_embedding_api_key",
+  chatBaseUrl: "https://us.inference.heroku.com/v1/chat/completions",
+  embeddingsBaseUrl: "https://us.inference.heroku.com/v1/embeddings",
+});
+```
+
+## Usage Examples
+
+### Chat Completions
+
+#### Basic Chat
+
+```typescript
+import { generateText } from "ai";
+import { createHerokuProvider } from "heroku-ai-provider";
+
+const heroku = createHerokuProvider();
+
+const { text } = await generateText({
+  model: heroku.chat("claude-3-5-sonnet-latest"),
+  prompt: "What is the capital of France?",
+});
+
+console.log(text); // "The capital of France is Paris."
+```
+
+#### Streaming Chat
+
+```typescript
+import { streamText } from "ai";
+import { createHerokuProvider } from "heroku-ai-provider";
+
+const heroku = createHerokuProvider();
+
+const { textStream } = await streamText({
+  model: heroku.chat("claude-3-haiku"),
+  prompt: "Write a short story about a robot learning to paint.",
+});
+
+for await (const delta of textStream) {
+  process.stdout.write(delta);
+}
+```
+
+#### Chat with System Message
+
+```typescript
+import { generateText } from "ai";
+import { createHerokuProvider } from "heroku-ai-provider";
+
+const heroku = createHerokuProvider();
+
+const { text } = await generateText({
+  model: heroku.chat("claude-3-5-sonnet-latest"),
+  system: "You are a helpful assistant that explains complex topics simply.",
+  prompt: "Explain quantum computing",
+});
+```
+
+### Tool/Function Calling
+
+```typescript
+import { generateText, tool } from "ai";
+import { createHerokuProvider } from "heroku-ai-provider";
+import { z } from "zod";
+
+const heroku = createHerokuProvider();
+
+const { text } = await generateText({
+  model: heroku.chat("claude-3-5-sonnet-latest"),
+  prompt: "What is the weather like in New York?",
+  tools: {
+    getWeather: tool({
+      description: "Get the current weather for a location",
+      parameters: z.object({
+        location: z.string().describe("The city and state"),
+      }),
+      execute: async ({ location }) => {
+        // Simulate weather API call
+        return {
+          location,
+          temperature: 72,
+          condition: "sunny",
+        };
+      },
+    }),
+  },
+  maxSteps: 5, // Allow multi-step tool conversations
+});
+```
+
+#### Advanced Tool Usage with Multiple Steps
+
+```typescript
+import { generateText, tool } from "ai";
+import { createHerokuProvider } from "heroku-ai-provider";
+import { z } from "zod";
+
+const heroku = createHerokuProvider();
+
+const { text, steps } = await generateText({
+  model: heroku.chat("claude-3-5-sonnet-latest"),
+  prompt:
+    "Check the weather in New York and then suggest appropriate clothing.",
+  tools: {
+    getWeather: tool({
+      description: "Get the current weather for a location",
+      parameters: z.object({
+        location: z.string().describe("The city and state"),
+      }),
+      execute: async ({ location }) => {
+        return {
+          location,
+          temperature: 45,
+          condition: "rainy",
+          humidity: 80,
+        };
+      },
+    }),
+    suggestClothing: tool({
+      description: "Suggest appropriate clothing based on weather conditions",
+      parameters: z.object({
+        temperature: z.number().describe("Temperature in Fahrenheit"),
+        condition: z.string().describe("Weather condition"),
+        humidity: z.number().optional().describe("Humidity percentage"),
+      }),
+      execute: async ({ temperature, condition, humidity }) => {
+        return {
+          suggestions: [
+            "Waterproof jacket",
+            "Warm layers",
+            "Waterproof shoes",
+            "Umbrella",
+          ],
+          reasoning: `Given ${temperature}°F and ${condition} weather${humidity ? ` with ${humidity}% humidity` : ""}, you'll want to stay warm and dry.`,
+        };
+      },
+    }),
+  },
+  maxSteps: 5,
+});
+
+console.log("Final response:", text);
+console.log("Tool execution steps:", steps.length);
+```
+
+### Embeddings
+
+#### Basic Embeddings
+
+```typescript
+import { embed } from "ai";
+import { createHerokuProvider } from "heroku-ai-provider";
+
+const heroku = createHerokuProvider();
+
+const { embedding } = await embed({
+  model: heroku.embedding("cohere-embed-multilingual"),
+  value: "Hello, world!",
+});
+
+console.log(embedding); // [0.1, 0.2, -0.3, ...]
+```
+
+#### Multiple Embeddings
+
+```typescript
+import { embedMany } from "ai";
+import { createHerokuProvider } from "heroku-ai-provider";
+
+const heroku = createHerokuProvider();
+
+const { embeddings } = await embedMany({
+  model: heroku.embedding("cohere-embed-multilingual"),
+  values: ["First document", "Second document", "Third document"],
+});
+
+console.log(embeddings.length); // 3
+```
+
+#### Using the Convenience Function
+
+```typescript
+import { createEmbedFunction } from "heroku-ai-provider";
+
+// Create a reusable embed function
+const embedText = createEmbedFunction({
+  apiKey: process.env.HEROKU_EMBEDDING_KEY!,
+  model: "cohere-embed-multilingual",
+});
+
+const embedding = await embedText("Hello, world!");
+console.log(embedding); // [0.1, 0.2, -0.3, ...]
+```
+
+## Configuration Options
+
+### HerokuProviderSettings
+
+```typescript
+interface HerokuProviderSettings {
+  // API keys (falls back to environment variables)
+  chatApiKey?: string; // HEROKU_INFERENCE_KEY
+  embeddingsApiKey?: string; // HEROKU_EMBEDDING_KEY
+
+  // Base URLs (falls back to environment variables or defaults)
+  chatBaseUrl?: string; // HEROKU_INFERENCE_URL
+  embeddingsBaseUrl?: string; // HEROKU_EMBEDDING_URL
+}
+```
+
+### Supported Models
+
+#### Chat Models
+
+- `claude-3-5-sonnet-latest` - Latest Claude 3.5 Sonnet (recommended)
+- `claude-3-haiku` - Fast and efficient Claude 3 Haiku
+- `claude-4-sonnet` - Claude 4 Sonnet (when available)
+- `claude-3-7-sonnet` - Claude 3.7 Sonnet
+- `claude-3-5-haiku` - Claude 3.5 Haiku
+
+#### Embedding Models
+
+- `cohere-embed-multilingual` - Multilingual embedding model by Cohere
+
+## Framework Integration
+
+### Next.js App Router
+
+```typescript
+// app/api/chat/route.ts
+import { streamText } from "ai";
+import { createHerokuProvider } from "heroku-ai-provider";
+
+const heroku = createHerokuProvider();
+
+export async function POST(req: Request) {
+  const { messages } = await req.json();
+
+  const result = await streamText({
+    model: heroku.chat("claude-3-5-sonnet-latest"),
+    messages,
+    maxSteps: 5, // Enable multi-step tool conversations
+  });
+
+  return result.toDataStreamResponse();
+}
+```
+
+### Next.js with Tool Support
+
+```typescript
+// app/api/chat/route.ts
+import { streamText, tool } from "ai";
+import { createHerokuProvider } from "heroku-ai-provider";
+import { z } from "zod";
+
+const heroku = createHerokuProvider();
+
+export async function POST(req: Request) {
+  const { messages } = await req.json();
+
+  const result = await streamText({
+    model: heroku.chat("claude-3-5-sonnet-latest"),
+    messages,
+    tools: {
+      getTime: tool({
+        description: "Get the current time",
+        parameters: z.object({
+          timezone: z
+            .string()
+            .optional()
+            .describe("Timezone (e.g., 'America/New_York')"),
+        }),
+        execute: async ({ timezone = "UTC" }) => {
+          return {
+            time: new Date().toLocaleString("en-US", { timeZone: timezone }),
+            timezone,
+          };
+        },
+      }),
+    },
+    maxSteps: 5,
+  });
+
+  return result.toDataStreamResponse();
+}
+```
+
+### Express.js
+
+```typescript
+import express from "express";
+import { generateText } from "ai";
+import { createHerokuProvider } from "heroku-ai-provider";
+
+const app = express();
+const heroku = createHerokuProvider();
+
+app.post("/chat", async (req, res) => {
+  const { prompt } = req.body;
+
+  const { text } = await generateText({
+    model: heroku.chat("claude-3-haiku"),
+    prompt,
+  });
+
+  res.json({ response: text });
+});
+```
+
+## Error Handling
+
+The provider includes comprehensive error handling with user-friendly error messages:
+
+```typescript
+import {
+  createHerokuProvider,
+  isConfigurationError,
+  isTemporaryServiceError,
+} from "heroku-ai-provider";
+
+try {
+  const heroku = createHerokuProvider();
+  const result = await generateText({
+    model: heroku.chat("claude-3-5-sonnet-latest"),
+    prompt: "Hello!",
+  });
+} catch (error) {
+  if (isConfigurationError(error)) {
+    console.error("Configuration error:", error.message);
+    // Handle API key or URL configuration issues
+  } else if (isTemporaryServiceError(error)) {
+    console.error("Service error:", error.message);
+    // Handle temporary service issues (retry logic)
+  } else {
+    console.error("Unexpected error:", error);
+  }
+}
+```
+
+## Troubleshooting
+
+### Common Issues
+
+#### Authentication Errors
+
+- **Issue**: "Chat API key is required" or "Embeddings API key is required"
+- **Solution**: Ensure your API keys are set in environment variables or passed directly to `createHerokuProvider()`
+
+#### Model Not Found
+
+- **Issue**: "Unsupported chat model" or "Unsupported embedding model"
+- **Solution**: Check that you're using a supported model from the list above
+
+#### Network Errors
+
+- **Issue**: Connection timeouts or network failures
+- **Solution**: Verify your internet connection and that Heroku's AI services are accessible
+
+#### URL Configuration
+
+- **Issue**: "Invalid URL format" errors
+- **Solution**: Ensure custom URLs are valid and use HTTP/HTTPS protocol
+
+#### Tool Execution Issues
+
+- **Issue**: Tools are called but AI doesn't provide final response
+- **Solution**: Ensure you're using `maxSteps: 5` or higher to allow multi-step tool conversations
+
+#### Schema Validation Errors
+
+- **Issue**: "Unrecognized request argument" errors when using tools
+- **Solution**: This provider automatically filters out problematic schema properties (like `$schema`) that some validation libraries add
+
+## Contributing
+
+We welcome contributions! Please follow these steps:
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature/amazing-feature`
+3. Make your changes and add tests
+4. Ensure tests pass: `npm test`
+5. Lint your code: `npm run lint`
+6. Commit your changes: `git commit -m 'Add amazing feature'`
+7. Push to the branch: `git push origin feature/amazing-feature`
+8. Open a Pull Request
+
+### Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/julianduque/heroku-ai-provider.git
+cd heroku-ai-provider
+
+# Install dependencies
+pnpm install
+
+# Run tests
+pnpm test
+
+# Build the project
+pnpm build
+
+# Lint code
+pnpm lint
+```
+
+### Testing
+
+The project uses Jest for testing. Run tests with:
+
+```bash
+# Run all tests
+pnpm test
+
+# Run tests in watch mode
+pnpm test --watch
+
+# Run tests with coverage
+pnpm test --coverage
+```
+
+## License
+
+This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.
+
+## Resources
+
+- 📖 Documentation: [Heroku AI Documentation](https://devcenter.heroku.com/categories/ai)
+- 🐛 Issues: [GitHub Issues](https://github.com/julianduque/heroku-ai-provider/issues)
+
+## Related Projects
+
+- [Vercel AI SDK](https://sdk.vercel.ai/) - The AI SDK this provider integrates with
+- [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) - Command line interface for Heroku
+- [Heroku AI Services](https://devcenter.heroku.com/categories/ai) - Official Heroku AI documentation