@revenium/anthropic 1.0.0 → 1.0.2

package/README.md

@@ -7,21 +7,21 @@
 
 Automatically track and meter your Anthropic Claude API usage with Revenium. This middleware provides seamless integration with **Anthropic Claude SDK**, requiring minimal code changes and featuring native TypeScript support.
 
-> **📦 Package Renamed**: This package has been renamed from `revenium-middleware-anthropic-node` to `@revenium/anthropic` for better organization and simpler naming. Please update your dependencies accordingly.
+> **Note - Package Renamed**: This package has been renamed from `revenium-middleware-anthropic-node` to `@revenium/anthropic` for better organization and simpler naming. Please update your dependencies accordingly.
 
-## ✨ Features
+## Features
 
-- 🔄 **Seamless Integration**: Drop-in replacement with zero code changes required
-- 📊 **Complete Metering**: Track tokens, costs, and performance metrics automatically
-- 🎯 **Custom Metadata**: Add business context with native TypeScript support
-- 🌊 **Streaming Support**: Real-time streaming with comprehensive analytics
-- 🛠️ **Tool Use Support**: Full support for Anthropic's function calling and tools
-- 🖼️ **Multi-modal Support**: Works with text, images, and all Claude capabilities
-- 🛡️ **Type Safe**: Complete TypeScript support with no type casting required
-- 🚀 **Fire-and-forget**: Never blocks your application flow
-- 📈 **Analytics**: Detailed usage analytics and reporting
+- **Seamless Integration**: Drop-in replacement with zero code changes required
+- **Complete Metering**: Track tokens, costs, and performance metrics automatically
+- **Custom Metadata**: Add business context with native TypeScript support
+- **Streaming Support**: Real-time streaming with comprehensive analytics
+- **Tool Use Support**: Full support for Anthropic's function calling and tools
+- **Multi-modal Support**: Works with text, images, and all Claude capabilities
+- **Type Safe**: Complete TypeScript support with no type casting required
+- **Fire-and-forget**: Never blocks your application flow
+- **Analytics**: Detailed usage analytics and reporting
 
-## � Package Migration
+## Package Migration
 
 This package has been renamed from `revenium-middleware-anthropic-node` to `@revenium/anthropic` for better organization and simpler naming.
 
@@ -49,24 +49,24 @@ import "@revenium/anthropic";
 
 All functionality remains exactly the same - only the package name has changed.
 
-## �🚀 Getting Started
+## Getting Started
 
 You have **3 options** to start using Revenium middleware:
 
 ### Option 1: Create Project from Scratch
 
 Perfect for new projects. We'll guide you step-by-step from `mkdir` to running tests.
-[👉 Go to Step-by-Step Guide](#option-1-create-project-from-scratch)
+[Go to Step-by-Step Guide](#option-1-create-project-from-scratch)
 
 ### Option 2: Clone Our Repository
 
 Clone and run the repository with working examples.
-[👉 Go to Repository Guide](#option-2-clone-our-repository)
+[Go to Repository Guide](#option-2-clone-our-repository)
 
 ### Option 3: Add to Existing Project
 
 Already have a project? Just install and replace imports.
-[👉 Go to Quick Integration](#option-3-add-to-existing-project)
+[Go to Quick Integration](#option-3-add-to-existing-project)
 
 ---
 
@@ -119,9 +119,9 @@ REVENIUM_METERING_BASE_URL=https://api.revenium.io/meter
 REVENIUM_DEBUG=true
 ```
 
-**💡 NOTE**: Replace each `your_..._here` with your actual values.
+**NOTE**: Replace each `your_..._here` with your actual values.
 
-**⚠️ IMPORTANT - Environment Matching**:
+**IMPORTANT - Environment Matching**:
 
 - If using QA environment URL `"https://api.qa.hcapp.io/meter"`, ensure your `REVENIUM_METERING_API_KEY` is from the **QA environment**
 - If using Production environment URL `"https://api.revenium.io/meter"`, ensure your `REVENIUM_METERING_API_KEY` is from the **Production environment**
@@ -271,9 +271,9 @@ async function streamingExample() {
       }
     }
 
-    console.log("\n✅ Streaming completed with metering!");
+    console.log("\nStreaming completed with metering!");
   } catch (error) {
-    console.error("❌ Streaming error:", error);
+    console.error("Streaming error:", error);
   }
 }
 
@@ -335,8 +335,8 @@ my-anthropic-project/
 
 ```bash
 # Clone the repository
-git clone https://github.com/revenium/revenium-middleware-anthropic-node-internal.git
-cd revenium-middleware-anthropic-node-internal
+git clone git@github.com:revenium/revenium-middleware-anthropic-node.git
+cd revenium-middleware-anthropic-node
 ```
 
 ### Step 2: Install Dependencies
@@ -369,7 +369,7 @@ REVENIUM_METERING_BASE_URL=https://api.revenium.io/meter
 REVENIUM_DEBUG=true
 ```
 
-**⚠️ IMPORTANT - Environment Matching**:
+**IMPORTANT - Environment Matching**:
 
 - If using QA environment URL `"https://api.qa.hcapp.io/meter"`, ensure your `REVENIUM_METERING_API_KEY` is from the **QA environment**
 - If using Production environment URL `"https://api.revenium.io/meter"`, ensure your `REVENIUM_METERING_API_KEY` is from the **Production environment**
@@ -488,7 +488,7 @@ const response = await anthropic.messages.create({
 
 ---
 
-## 📊 What Gets Tracked
+## What Gets Tracked
 
 The middleware automatically captures:
 
@@ -500,7 +500,7 @@ The middleware automatically captures:
 - **Streaming Metrics**: Time to first token for streaming responses
 - **Custom Metadata**: Business context you provide
 
-## 🔧 Advanced Usage
+## Advanced Usage
 
 ### Initialization Options
 
@@ -641,18 +641,18 @@ interface UsageMetadata {
 }
 ```
 
-## 🛠️ Configuration Options
+## Configuration Options
 
 ### Environment Variables
 
 | Variable                     | Required | Default                         | Description                       |
 | ---------------------------- | -------- | ------------------------------- | --------------------------------- |
-| `REVENIUM_METERING_API_KEY`  | ✅       | -                               | Your Revenium API key             |
-| `ANTHROPIC_API_KEY`          | ✅       | -                               | Anthropic Claude API key          |
-| `REVENIUM_METERING_BASE_URL` | ❌       | `https://api.revenium.io/meter` | Revenium metering API base URL    |
-| `REVENIUM_DEBUG`             | ❌       | `false`                         | Enable debug logging (true/false) |
+| `REVENIUM_METERING_API_KEY`  | Yes      | -                               | Your Revenium API key             |
+| `ANTHROPIC_API_KEY`          | Yes      | -                               | Anthropic Claude API key          |
+| `REVENIUM_METERING_BASE_URL` | No       | `https://api.revenium.io/meter` | Revenium metering API base URL    |
+| `REVENIUM_DEBUG`             | No       | `false`                         | Enable debug logging (true/false) |
 
-**⚠️ Important Note about `REVENIUM_METERING_BASE_URL`:**
+**Important Note about `REVENIUM_METERING_BASE_URL`:**
 
 - This variable is **optional** and defaults to the production URL (`https://api.revenium.io/meter`)
 - If you don't set it explicitly, the middleware will use the default production endpoint
@@ -684,7 +684,7 @@ configure({
 });
 ```
 
-## 🚨 Troubleshooting
+## Troubleshooting
 
 ### Common Issues
 
@@ -747,29 +747,28 @@ Look for log messages like:
 - `[Revenium] Usage metadata extracted`
 - `[Revenium] Revenium tracking successful`
 
-## 🔗 Supported Models
+## Supported Models
 
 All Claude models are supported:
 
-| Model                      | Status    | Use Case                              |
-| -------------------------- | --------- | ------------------------------------- |
-| `claude-3-5-sonnet-latest` | ✅ Latest | General purpose, best performance     |
-| `claude-3-5-haiku-latest`  | ✅ Latest | Fast responses, cost-effective        |
-| `claude-3-opus-latest`     | ✅ Latest | Complex reasoning, highest capability |
-| `claude-3-sonnet-20240229` | ✅ Stable | Production workloads                  |
-| `claude-3-haiku-20240307`  | ✅ Stable | High-volume applications              |
+| Model                      | Status             | Use Case                              |
+| -------------------------- | ------------------ | ------------------------------------- |
+| `claude-3-5-sonnet-latest` | Supported (Latest) | General purpose, best performance     |
+| `claude-3-5-haiku-latest`  | Supported (Latest) | Fast responses, cost-effective        |
+| `claude-3-opus-latest`     | Supported (Latest) | Complex reasoning, highest capability |
+| `claude-3-sonnet-20240229` | Supported (Stable) | Production workloads                  |
+| `claude-3-haiku-20240307`  | Supported (Stable) | High-volume applications              |
 
-## 📚 Included Examples
+## Included Examples
 
 The package includes these example files:
 
 - **basic-usage.ts**: Simple chat completions with all initialization methods
 - **advanced-features.ts**: Streaming, tools, and custom metadata
-- **typescript-monorepo.ts**: TypeScript monorepo integration patterns
 
-All examples are in the `examples/` directory of the installed package.
+All examples are in the `examples/` directory of the installed package. For detailed TypeScript patterns and usage, see [examples/README.md](examples/README.md).
 
-## 🔄 How It Works
+## How It Works
 
 1. **Automatic Patching**: When imported, the middleware patches Anthropic's `messages.create` method
 2. **Request Interception**: All Anthropic requests are intercepted to extract metadata
@@ -779,23 +778,23 @@ All examples are in the `examples/` directory of the installed package.
 
 The middleware never blocks your application - if Revenium tracking fails, your Anthropic requests continue normally.
 
-## 📋 Requirements
+## Requirements
 
 - Node.js 16+
 - Anthropic SDK (@anthropic-ai/sdk) v0.20.0+
 - TypeScript 5.0+ (for TypeScript projects)
 - Revenium API key
 
-## 📄 License
+## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
-## 🤝 Support
+## Support
 
 For issues, feature requests, or contributions:
 
-- **GitHub Repository**: [revenium/revenium-middleware-anthropic-node-internal](https://github.com/revenium/revenium-middleware-anthropic-node-internal)
-- **Issues**: [Report bugs or request features](https://github.com/revenium/revenium-middleware-anthropic-node-internal/issues)
+- **GitHub Repository**: [revenium/revenium-middleware-anthropic-node](https://github.com/revenium/revenium-middleware-anthropic-node)
+- **Issues**: [Report bugs or request features](https://github.com/revenium/revenium-middleware-anthropic-node/issues)
 - **Contact**: Reach out to the Revenium team for additional support
 
 ## Development
@@ -804,4 +803,4 @@ For development and testing instructions, see [DEVELOPMENT.md](DEVELOPMENT.md).
 
 ---
 
-**Built with ❤️ by Revenium**
+**Built by Revenium**

package/dist/cjs/types/anthropic-augmentation.js

@@ -23,7 +23,7 @@
  *
  * ### Basic Usage:
  * ```typescript
- * import 'revenium-middleware-anthropic-node';
+ * import '@revenium/anthropic';
  * import Anthropic from '@anthropic-ai/sdk';
  *
  * const anthropic = new Anthropic();

package/dist/esm/types/anthropic-augmentation.js

@@ -22,7 +22,7 @@
  *
  * ### Basic Usage:
  * ```typescript
- * import 'revenium-middleware-anthropic-node';
+ * import '@revenium/anthropic';
  * import Anthropic from '@anthropic-ai/sdk';
  *
  * const anthropic = new Anthropic();

package/dist/types/types/anthropic-augmentation.d.ts

@@ -22,7 +22,7 @@
  *
  * ### Basic Usage:
  * ```typescript
- * import 'revenium-middleware-anthropic-node';
+ * import '@revenium/anthropic';
  * import Anthropic from '@anthropic-ai/sdk';
  *
  * const anthropic = new Anthropic();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revenium/anthropic",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Transparent TypeScript middleware for automatic Revenium usage tracking with Anthropic Claude AI",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -44,6 +44,14 @@
   ],
   "author": "Revenium",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/revenium/revenium-middleware-anthropic-node.git"
+  },
+  "homepage": "https://github.com/revenium/revenium-middleware-anthropic-node#readme",
+  "bugs": {
+    "url": "https://github.com/revenium/revenium-middleware-anthropic-node/issues"
+  },
   "dependencies": {
     "node-fetch": "^3.3.2"
   },