@revenium/anthropic 1.0.4 → 1.0.5

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.0.5] - 2025-10-23
+
+### Changed
+- Updated .gitignore to GitHub official standard for professional presentation
+- Improved .env.example with realistic key format examples (hak_, sk-ant-)
+- Created initial public repository structure
+
 ## [1.0.4] - 2025-10-21
 
 ### Changed
@@ -45,6 +52,7 @@ All notable changes to this project will be documented in this file.
 - Configurable retry logic
 - Debug logging support
 
+[1.0.5]: https://github.com/revenium/revenium-middleware-anthropic-node/releases/tag/v1.0.5
 [1.0.4]: https://github.com/revenium/revenium-middleware-anthropic-node/releases/tag/v1.0.4
 [1.0.3]: https://github.com/revenium/revenium-middleware-anthropic-node/releases/tag/v1.0.3
 [1.0.2]: https://github.com/revenium/revenium-middleware-anthropic-node/releases/tag/v1.0.2

package/README.md

@@ -7,8 +7,6 @@
 
 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.
 
-> **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
 
 - **Seamless Integration**: Drop-in replacement with zero code changes required
@@ -21,134 +19,39 @@ Automatically track and meter your Anthropic Claude API usage with Revenium. Thi
 - **Fire-and-forget**: Never blocks your application flow
 - **Analytics**: Detailed usage analytics and reporting
 
-## Package Migration
-
-This package has been renamed from `revenium-middleware-anthropic-node` to `@revenium/anthropic` for better organization and simpler naming.
-
-### Migration Steps
-
-If you're upgrading from the old package:
-
-```bash
-# Uninstall the old package
-npm uninstall revenium-middleware-anthropic-node
-
-# Install the new package
-npm install @revenium/anthropic
-```
-
-**Update your imports:**
-
-```typescript
-// Old import
-import "revenium-middleware-anthropic-node";
-
-// New import
-import "@revenium/anthropic";
-```
-
-All functionality remains exactly the same - only the package name has changed.
-
 ## Getting Started
 
-### Quick Start
+**Installation:**
 
 ```bash
 npm install @revenium/anthropic @anthropic-ai/sdk
 ```
 
-For complete setup instructions, TypeScript patterns, and usage examples, see [examples/README.md](https://github.com/revenium/revenium-middleware-anthropic-node/blob/HEAD/examples/README.md).
-
-### Step-by-Step Guide
-
-The following guide walks you through creating a new project from scratch:
-
-### Step 1: Create Your Project
-
-```bash
-# Create project directory
-mkdir my-anthropic-project
-cd my-anthropic-project
-
-# Initialize Node.js project
-npm init -y
-```
+**Quick Start:**
 
-### Step 2: Install Dependencies
-
-```bash
-# Install Revenium middleware and Anthropic SDK
-npm install @revenium/anthropic @anthropic-ai/sdk@^0.55.1 dotenv
-
-# For TypeScript projects (optional)
-npm install -D typescript tsx @types/node
-```
-
-### Step 3: Setup Environment Variables
-
-Create a `.env` file in your project root:
-
-```bash
-# Create .env file
-echo. > .env  # On Windows (CMD)
-touch .env  # On Mac/Linux
-# OR PowerShell
-New-Item -Path .env -ItemType File
-```
-
-Copy and paste the following into `.env`:
-
-```env
-# Anthropic Configuration
-ANTHROPIC_API_KEY=sk-ant-your_anthropic_api_key_here
-
-# Revenium Configuration
-REVENIUM_METERING_API_KEY=hak_your_revenium_api_key_here
-REVENIUM_METERING_BASE_URL=https://api.revenium.io/meter
+```typescript
+import "@revenium/anthropic";
+import Anthropic from "@anthropic-ai/sdk";
 
-# Optional: Enable debug logging
-REVENIUM_DEBUG=true
+const client = new Anthropic();
+// Middleware automatically tracks all requests
 ```
 
-**NOTE**: Replace each `your_..._here` with your actual values.
-
-### Step 4: Protect Your API Keys
-
-**CRITICAL**: Create a `.gitignore` file to prevent committing sensitive data like API keys.
-
-**Recommended**: Use the industry-standard [GitHub Node.gitignore](https://github.com/github/gitignore/blob/main/Node.gitignore)
+**Environment Setup:**
 
 ```bash
-# Download GitHub's standard Node.gitignore
-curl -o .gitignore https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
+export ANTHROPIC_API_KEY="sk-ant-your_anthropic_key"
+export REVENIUM_METERING_API_KEY="hak_your_revenium_key"
 ```
 
-**IMPORTANT**: Ensure these patterns are included to protect your environment variables:
-
-```gitignore
-# Environment variables - CRITICAL for API key protection
-.env
-.env.*
-!.env.example
-```
-
-Never commit `.env` files containing your API keys to version control.
-
-### Step 5: Follow the Examples
+**For complete step-by-step setup, TypeScript configuration, and running examples, see [examples/README.md](https://github.com/revenium/revenium-middleware-anthropic-node/blob/HEAD/examples/README.md).**
 
-See [examples/README.md](https://github.com/revenium/revenium-middleware-anthropic-node/blob/HEAD/examples/README.md) for complete examples and setup instructions.
-
-**Cloned from GitHub?** Run examples with:
-
-```bash
-npm install
-npm run example:basic
-npm run example:advanced
-```
-
-**Browse online:** [`examples/` directory](https://github.com/revenium/revenium-middleware-anthropic-node/tree/HEAD/examples)
+## Requirements
 
----
+- Node.js 18+
+- TypeScript 5.0+ (for TypeScript projects)
+- Anthropic SDK (@anthropic-ai/sdk) v0.20.0+
+- Revenium API key
 
 ## What Gets Tracked
 
@@ -168,166 +71,57 @@ The middleware automatically captures:
 
 The middleware supports three initialization patterns:
 
-#### Option A: Automatic Initialization (Simplest)
+**Automatic (Recommended)** - Simply import the middleware and it auto-initializes:
 
 ```typescript
-// Simply import - auto-initializes with graceful fallback
 import "@revenium/anthropic";
 import Anthropic from "@anthropic-ai/sdk";
 
-// If env vars are set, tracking works automatically
 const anthropic = new Anthropic();
+// Tracking works automatically if env vars are set
 ```
 
-#### Option B: Explicit Initialization (More Control)
-
-```typescript
-import { initialize } from "@revenium/anthropic";
-import Anthropic from "@anthropic-ai/sdk";
-
-try {
-  initialize();
-  // Middleware initialized successfully
-} catch (error) {
-  // Handle initialization error appropriately
-  throw new Error(`Initialization failed: ${error.message}`);
-}
-
-const anthropic = new Anthropic();
-```
-
-#### Option C: Manual Configuration (Full Control)
-
-```typescript
-import { configure } from "@revenium/anthropic";
-import Anthropic from "@anthropic-ai/sdk";
+**Explicit** - Call `initialize()` for error handling control
 
-configure({
-  reveniumApiKey: "hak_your_api_key_here",
-  reveniumBaseUrl: "https://api.revenium.io/meter",
-  anthropicApiKey: "sk-ant-your_key_here",
-  apiTimeout: 5000,
-  failSilent: true,
-  maxRetries: 3,
-});
+**Manual** - Use `configure()` to set all options programmatically
 
-const anthropic = new Anthropic();
-```
+For detailed examples of all initialization patterns, see [examples/](https://github.com/revenium/revenium-middleware-anthropic-node/blob/HEAD/examples/README.md).
 
 ### Streaming Responses
 
-```typescript
-import "@revenium/anthropic";
-import Anthropic from "@anthropic-ai/sdk";
+Streaming is fully supported with real-time token tracking and time-to-first-token metrics. The middleware automatically tracks streaming responses without any additional configuration.
 
-const anthropic = new Anthropic();
-
-const stream = await anthropic.messages.create({
-  model: "claude-3-5-sonnet-latest",
-  max_tokens: 1000,
-  messages: [{ role: "user", content: "Write a story about AI" }],
-  stream: true,
-  usageMetadata: {
-    subscriber: {
-      id: "user-123",
-      email: "user@example.com",
-    },
-    organizationId: "story-org",
-    taskType: "creative-writing",
-    agent: "story-writer",
-  },
-});
-
-for await (const event of stream) {
-  if (
-    event.type === "content_block_delta" &&
-    event.delta.type === "text_delta"
-  ) {
-    process.stdout.write(event.delta.text);
-  }
-}
-```
+See [examples/advanced-features.ts](https://github.com/revenium/revenium-middleware-anthropic-node/blob/HEAD/examples/advanced-features.ts) for working streaming examples.
 
 ### Custom Metadata Tracking
 
-Add business context to your AI usage:
-
-```typescript
-// Custom metadata for enhanced tracking (following project structure)
-const customMetadata = {
-  subscriber: {
-    id: "user-789",
-    email: "user@company.com",
-    credential: {
-      name: "premium-user",
-      value: "tier-1",
-    },
-  },
-  organizationId: "org-456",
-  productId: "premium-plan",
-  taskType: "CUSTOMER_SUPPORT",
-  agent: "CustomerSupportBot",
-  traceId: "user-session-123",
-  responseQualityScore: 9.2,
-};
-
-const response = await anthropic.messages.create({
-  model: "claude-3-5-sonnet-latest",
-  max_tokens: 1024,
-  messages: [{ role: "user", content: "Help me with my account" }],
-  usageMetadata: customMetadata,
-});
-```
-
-### Usage Metadata Interface
+Add business context to track usage by organization, user, task type, or custom fields. Pass a `usageMetadata` object with any of these optional fields:
 
-All metadata fields are optional:
+- **subscriber**: User ID, email, and credentials
+- **organizationId**: Organization or company identifier
+- **taskType**: Type of AI task (e.g., chat, analysis, generation)
+- **agent**: AI agent or bot identifier
+- **traceId**: Session or conversation tracking
+- **productId**: Your product or feature identifier
+- **responseQualityScore**: Custom quality metrics
 
-```typescript
-interface UsageMetadata {
-  traceId?: string; // Session or conversation ID
-  taskType?: string; // Type of AI task (e.g., "chat", "analysis")
-  organizationId?: string; // Organization/company ID
-  subscriptionId?: string; // Billing plan ID
-  productId?: string; // Your product/feature ID
-  agent?: string; // AI agent identifier
-  responseQualityScore?: number; // Quality score (0-1)
-  subscriber?: {
-    id?: string; // User ID from your system
-    email?: string; // User's email address
-    credential?: {
-      name?: string; // Credential name
-      value?: string; // Credential value
-    };
-  };
-}
-```
+**Resources:**
+- [API Reference](https://revenium.readme.io/reference/meter_ai_completion) - Complete metadata field documentation
 
 ## Configuration Options
 
 ### Environment Variables
 
-| Variable                     | Required | Default                         | Description                       |
-| ---------------------------- | -------- | ------------------------------- | --------------------------------- |
-| `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) |
+| Variable                     | Required | Default                    | Description                       |
+| ---------------------------- | -------- | -------------------------- | --------------------------------- |
+| `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`  | Revenium metering API base URL    |
+| `REVENIUM_DEBUG`             | No       | `false`                    | Enable debug logging (true/false) |
 
 ### Manual Configuration
 
-```typescript
-import { configure } from "@revenium/anthropic";
-
-configure({
-  reveniumApiKey: "hak_your_api_key",
-  reveniumBaseUrl: "https://api.revenium.io/meter",
-  anthropicApiKey: "sk-ant-your_key",
-  apiTimeout: 5000,
-  failSilent: true,
-  maxRetries: 3,
-});
-```
+For programmatic configuration instead of environment variables, use the `configure()` function. See the initialization options above and [examples/](https://github.com/revenium/revenium-middleware-anthropic-node/blob/HEAD/examples/README.md) for details.
 
 ## Troubleshooting
 
@@ -411,13 +205,6 @@ All examples are in the `examples/` directory of the installed package. For deta
 
 The middleware never blocks your application - if Revenium tracking fails, your Anthropic requests continue normally.
 
-## Requirements
-
-- Node.js 16+
-- Anthropic SDK (@anthropic-ai/sdk) v0.20.0+
-- TypeScript 5.0+ (for TypeScript projects)
-- Revenium API key
-
 ## Documentation
 
 For detailed documentation, visit [docs.revenium.io](https://docs.revenium.io)
@@ -445,7 +232,7 @@ For issues, feature requests, or contributions:
 - **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)
 - **Documentation**: [docs.revenium.io](https://docs.revenium.io)
-- **Contact**: Reach out to the Revenium team for additional support
+- **Email**: support@revenium.io
 
 ## Development
 

package/dist/cjs/constants.js

@@ -10,7 +10,7 @@ exports.ANTHROPIC_PATTERNS = exports.API_ENDPOINTS = exports.ENV_VARS = exports.
  */
 exports.DEFAULT_CONFIG = {
     /** Default Revenium API base URL */
-    REVENIUM_BASE_URL: 'https://api.revenium.io/meter',
+    REVENIUM_BASE_URL: 'https://api.revenium.io',
     /** Default API timeout in milliseconds */
     API_TIMEOUT: 5000,
     /** Default maximum retries for failed API calls */
@@ -118,7 +118,7 @@ exports.ENV_VARS = {
  */
 exports.API_ENDPOINTS = {
     /** Revenium AI completions endpoint */
-    AI_COMPLETIONS: '/v2/ai/completions',
+    AI_COMPLETIONS: '/meter/v2/ai/completions',
 };
 /**
  * Anthropic model patterns

package/dist/cjs/utils/validation.js

@@ -161,7 +161,7 @@ function validateReveniumConfig(config) {
         }
         catch {
             errors.push('reveniumBaseUrl must be a valid URL');
-            suggestions.push('Use format: https://api.revenium.io/meter');
+            suggestions.push('Use format: https://api.revenium.io');
         }
     }
     // Validate optional Anthropic API key

package/dist/esm/constants.js

@@ -7,7 +7,7 @@
  */
 export const DEFAULT_CONFIG = {
     /** Default Revenium API base URL */
-    REVENIUM_BASE_URL: 'https://api.revenium.io/meter',
+    REVENIUM_BASE_URL: 'https://api.revenium.io',
     /** Default API timeout in milliseconds */
     API_TIMEOUT: 5000,
     /** Default maximum retries for failed API calls */
@@ -115,7 +115,7 @@ export const ENV_VARS = {
  */
 export const API_ENDPOINTS = {
     /** Revenium AI completions endpoint */
-    AI_COMPLETIONS: '/v2/ai/completions',
+    AI_COMPLETIONS: '/meter/v2/ai/completions',
 };
 /**
  * Anthropic model patterns

package/dist/esm/utils/validation.js

@@ -150,7 +150,7 @@ export function validateReveniumConfig(config) {
         }
         catch {
             errors.push('reveniumBaseUrl must be a valid URL');
-            suggestions.push('Use format: https://api.revenium.io/meter');
+            suggestions.push('Use format: https://api.revenium.io');
         }
     }
     // Validate optional Anthropic API key

package/dist/types/constants.d.ts

@@ -7,7 +7,7 @@
  */
 export declare const DEFAULT_CONFIG: {
     /** Default Revenium API base URL */
-    readonly REVENIUM_BASE_URL: "https://api.revenium.io/meter";
+    readonly REVENIUM_BASE_URL: "https://api.revenium.io";
     /** Default API timeout in milliseconds */
     readonly API_TIMEOUT: 5000;
     /** Default maximum retries for failed API calls */
@@ -115,7 +115,7 @@ export declare const ENV_VARS: {
  */
 export declare const API_ENDPOINTS: {
     /** Revenium AI completions endpoint */
-    readonly AI_COMPLETIONS: "/v2/ai/completions";
+    readonly AI_COMPLETIONS: "/meter/v2/ai/completions";
 };
 /**
  * Anthropic model patterns

package/dist/types/types.d.ts

@@ -52,7 +52,7 @@ export interface Subscriber {
  * ```typescript
  * const config: ReveniumConfig = {
  *   reveniumApiKey: 'hak_1234567890abcdef',
- *   reveniumBaseUrl: 'https://api.revenium.io/meter/v2',
+ *   reveniumBaseUrl: 'https://api.revenium.io',
  *   anthropicApiKey: 'sk-ant-1234567890abcdef',
  *   apiTimeout: 8000,
  *   failSilent: true,

package/examples/README.md

@@ -2,16 +2,27 @@
 
 **TypeScript-first** examples demonstrating automatic Revenium usage tracking with the Anthropic SDK.
 
-## Quick Start
+## Getting Started - Step by Step
 
-### 1. Install Dependencies
+### 1. Create Your Project
+
+```bash
+# Create project directory
+mkdir my-anthropic-project
+cd my-anthropic-project
+
+# Initialize Node.js project
+npm init -y
+```
+
+### 2. Install Dependencies
 
 ```bash
 npm install @revenium/anthropic @anthropic-ai/sdk dotenv
 npm install -D typescript tsx @types/node  # For TypeScript
 ```
 
-### 2. Environment Setup
+### 3. Environment Setup
 
 Create a `.env` file in your project root:
 
@@ -21,11 +32,11 @@ REVENIUM_METERING_API_KEY=hak_your_revenium_api_key
 ANTHROPIC_API_KEY=sk-ant-your_anthropic_api_key
 
 # Optional
-REVENIUM_METERING_BASE_URL=https://api.revenium.io/meter
+REVENIUM_METERING_BASE_URL=https://api.revenium.io
 REVENIUM_DEBUG=false
 ```
 
-### 3. Run Examples
+### 4. Run Examples
 
 **If you cloned from GitHub:**
 
@@ -152,14 +163,6 @@ import Anthropic from "@anthropic-ai/sdk";
 }
 ```
 
-### IntelliSense Not Working
-
-**Solutions:**
-1. Restart TypeScript language server in your IDE
-2. Ensure `@revenium/anthropic` is imported at the top
-3. Verify `@anthropic-ai/sdk` types are installed
-4. Check TypeScript version is 4.5 or higher
-
 ### Debug Mode
 
 Enable detailed logging to troubleshoot issues:

package/examples/advanced-features.ts

@@ -462,7 +462,7 @@ function checkEnvironment(): void {
     console.error("   ANTHROPIC_API_KEY=sk-ant-your_anthropic_key");
     console.error("\nOptional (uses defaults if not set):");
     console.error(
-      "   REVENIUM_METERING_BASE_URL=https://api.revenium.io/meter/v2"
+      "   REVENIUM_METERING_BASE_URL=https://api.revenium.io"
     );
     console.error("   REVENIUM_DEBUG=true  # For detailed logging");
     process.exit(1);

package/examples/basic-usage.ts

@@ -200,7 +200,7 @@ async function demonstrateManualConfiguration() {
         process.env.REVENIUM_METERING_API_KEY || "hak_your_api_key_here",
       reveniumBaseUrl:
         process.env.REVENIUM_METERING_BASE_URL ||
-        "https://api.revenium.io/meter",
+        "https://api.revenium.io",
 
       // Optional: Anthropic API key (can also be set in Anthropic client)
       anthropicApiKey: process.env.ANTHROPIC_API_KEY,
@@ -286,7 +286,7 @@ function checkEnvironment() {
     console.error("   ANTHROPIC_API_KEY=sk-ant-your_anthropic_key");
     console.error("\nOptional (uses defaults if not set):");
     console.error(
-      "   REVENIUM_METERING_BASE_URL=https://api.revenium.io/meter"
+      "   REVENIUM_METERING_BASE_URL=https://api.revenium.io"
     );
     console.error("   REVENIUM_DEBUG=true  # For detailed logging");
     process.exit(1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revenium/anthropic",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Transparent TypeScript middleware for automatic Revenium usage tracking with Anthropic Claude AI",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",