fix: update tool-usage example and add docs action

Author: julianduque

.github/workflows/docs.yml

@@ -0,0 +1,52 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "pnpm"
+      - name: Install dependencies
+        run: pnpm install
+      - name: Build project
+        run: pnpm run build
+      - name: Generate documentation
+        run: pnpm run docs
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -489,12 +489,10 @@ pnpm test --coverage
 
 This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.
 
-## Support
+## Resources
 
-- 📧 Email: [[email protected]](mailto:[email protected])
 - 📖 Documentation: [Heroku AI Documentation](https://devcenter.heroku.com/categories/ai)
 - 🐛 Issues: [GitHub Issues](https://github.com/julianduque/heroku-ai-provider/issues)
-- 💬 Community: [Heroku Discord](https://discord.gg/heroku)
 
 ## Related Projects
 

dist/cjs/models/chat.cjs

@@ -13,7 +13,7 @@ const error_handling_js_1 = require('../utils/error-handling.cjs');
  * AI SDK features.
  *
  * @class HerokuChatLanguageModel
- * @implements {LanguageModelV1}
+ * Implements the LanguageModelV1 interface from @ai-sdk/provider.
  *
  * @example
  * Basic usage with AI SDK:

dist/cjs/models/chat.d.cts

@@ -10,7 +10,7 @@ export type ToolChoiceInput = LanguageModelV1ToolChoice;
  * AI SDK features.
  *
  * @class HerokuChatLanguageModel
- * @implements {LanguageModelV1}
+ * Implements the LanguageModelV1 interface from @ai-sdk/provider.
  *
  * @example
  * Basic usage with AI SDK:

dist/cjs/models/embedding.cjs

@@ -245,8 +245,8 @@ class HerokuEmbeddingModel {
             model: this.model,
             input: inputArray,
         };
-        // Note: Custom embedding options (inputType, embeddingType, truncate) 
-        // are not supported in the AI SDK interface. They would need to be 
+        // Note: Custom embedding options (inputType, embeddingType, truncate)
+        // are not supported in the AI SDK interface. They would need to be
         // passed through provider-specific options if needed.
         try {
             // Make API request with enhanced error handling
@@ -310,7 +310,9 @@ class HerokuEmbeddingModel {
             }
             return {
                 embeddings,
-                usage: response.usage ? { tokens: response.usage.total_tokens } : undefined,
+                usage: response.usage
+                    ? { tokens: response.usage.total_tokens }
+                    : undefined,
                 rawResponse: {
                     headers: {},
                 },

dist/cjs/models/embedding.d.ts.map

@@ -10,7 +10,7 @@ export type ToolChoiceInput = LanguageModelV1ToolChoice;
  * AI SDK features.
  *
  * @class HerokuChatLanguageModel
- * @implements {LanguageModelV1}
+ * Implements the LanguageModelV1 interface from @ai-sdk/provider.
  *
  * @example
  * Basic usage with AI SDK: