@revenium/anthropic 1.0.8 → 1.1.0

package/examples/getting_started.ts

@@ -1,6 +1,6 @@
-import 'dotenv/config';
-import '@revenium/anthropic';
-import Anthropic from '@anthropic-ai/sdk';
+import "dotenv/config";
+import "@revenium/anthropic";
+import Anthropic from "@anthropic-ai/sdk";
 
 async function main() {
   // Create Anthropic client
@@ -8,10 +8,10 @@ async function main() {
 
   // Chat completion with metadata
   const response = await anthropic.messages.create({
-    model: 'claude-haiku-4-5',
+    model: "claude-haiku-4-5",
     max_tokens: 2000,
     messages: [
-      { role: 'user', content: 'Please verify you are ready to assist me.' }
+      { role: "user", content: "Please verify you are ready to assist me." },
     ],
 
     /* Optional metadata for advanced reporting, lineage tracking, and cost allocation
@@ -44,7 +44,7 @@ async function main() {
     */
   });
 
-  console.log('Response:', response.content[0]?.text);
+  console.log("Response:", response.content[0]?.text);
 }
 
 main().catch(console.error);

package/examples/metadata.ts

@@ -0,0 +1,58 @@
+import "dotenv/config";
+import "@revenium/anthropic";
+import Anthropic from "@anthropic-ai/sdk";
+import { UsageMetadata } from "@revenium/anthropic";
+
+async function main() {
+  console.log("Revenium Anthropic Middleware - Metadata Example\n");
+  const anthropic = new Anthropic();
+  try {
+    const metadata: UsageMetadata = {
+      subscriber: {
+        id: "user-123",
+        email: "user@example.com",
+        credential: { name: "api-key", value: "key-123" },
+      },
+      traceId: "trace-123",
+      taskType: "task-123",
+      organizationId: "org-123",
+      subscriptionId: "sub-123",
+      productId: "prod-123",
+      agent: "agent-123",
+      responseQualityScore: 0.95,
+    };
+    const response = await anthropic.messages.create({
+      model: "claude-haiku-4-5",
+      max_tokens: 50,
+      messages: [
+        { role: "user", content: "What is the capital of France? Be concise." },
+      ],
+      usageMetadata: metadata,
+      tools: [
+        {
+          name: "get_weather",
+          description: "Get weather for a location",
+          input_schema: {
+            type: "object",
+            properties: {
+              location: { type: "string" },
+            },
+          },
+        },
+      ],
+    });
+
+    const textResponse =
+      response.content[0].type === "text"
+        ? response.content[0].text
+        : "Non-text response";
+    console.log("RESPONSE: \n", textResponse);
+    console.log(
+      `Tokens: ${response.usage?.input_tokens} input + ${response.usage?.output_tokens} output\n`
+    );
+  } catch (error) {
+    console.error("Error: ", error);
+  }
+}
+
+main().catch(console.error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revenium/anthropic",
-  "version": "1.0.8",
+  "version": "1.1.0",
   "description": "Transparent TypeScript middleware for automatic Revenium usage tracking with Anthropic Claude AI",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -24,10 +24,9 @@
     "build:types": "tsc -p tsconfig.types.json",
     "fix-esm": "node scripts/fix-esm-imports.js",
     "dev": "tsc --watch",
-    "test": "npm run build && echo 'Build successful - no automated tests configured'",
-    "example": "npm run build && tsx examples/basic-usage.ts",
-    "example:basic": "npm run build && tsx examples/basic-usage.ts",
-    "example:advanced": "npm run build && tsx examples/advanced-features.ts",
+    "example": "npm run build && tsx examples/basic.ts",
+    "example:basic": "npm run build && tsx examples/basic.ts",
+    "example:advanced": "npm run build && tsx examples/advanced.ts",
     "clean": "rimraf dist",
     "prepublishOnly": "npm run clean && npm run build"
   },
@@ -75,7 +74,6 @@
     "examples/**/*",
     "!examples/.claude/**",
     "!examples/**/*.log",
-    "!examples/**/*.sh",
     "README.md",
     "CHANGELOG.md",
     "LICENSE"

package/examples/advanced-features.ts

@@ -1,469 +0,0 @@
-/**
- * Revenium Anthropic Middleware - Advanced TypeScript Features Example
- *
- * This example demonstrates advanced TypeScript patterns and features:
- * • Streaming responses with type-safe real-time tracking
- * • Tool use (function calling) with strongly typed metadata
- * • Manual tracking for custom scenarios with full type safety
- * • Comprehensive error handling with typed error responses
- * • Generic functions with type constraints
- * • Advanced metadata patterns with custom fields support
- * • Type-safe event handling and stream processing
- *
- * All features leverage TypeScript's type system for maximum safety and IntelliSense.
- */
-
-// Load environment variables from .env file
-import "dotenv/config";
-
-// Import for module augmentation - enables native usageMetadata support
-import "@revenium/anthropic";
-import Anthropic from "@anthropic-ai/sdk";
-
-// Import types for advanced TypeScript patterns
-import type {
-  UsageMetadata,
-  TrackingData,
-  MiddlewareStatus,
-  Logger,
-} from "@revenium/anthropic";
-
-import { trackUsageAsync, getStatus, setLogger } from "@revenium/anthropic";
-
-/**
- * Streaming event types with full type safety
- */
-type StreamEvent =
-  | { type: "start"; timestamp: Date; metadata: UsageMetadata }
-  | { type: "content"; content: string; timestamp: Date }
-  | { type: "complete"; totalTokens: number; duration: number; timestamp: Date }
-  | { type: "error"; error: string; timestamp: Date };
-
-/**
- * Custom logger implementation for advanced scenarios
- */
-class AdvancedLogger implements Logger {
-  private context: Record<string, unknown> = {};
-
-  setContext(context: Record<string, unknown>): void {
-    this.context = { ...this.context, ...context };
-  }
-
-  debug(message: string, data?: Record<string, unknown>): void {
-    console.log(`[DEBUG] ${message}`, { ...this.context, ...data });
-  }
-
-  info(message: string, data?: Record<string, unknown>): void {
-    console.log(`[INFO] ${message}`, { ...this.context, ...data });
-  }
-
-  warn(message: string, data?: Record<string, unknown>): void {
-    console.warn(`[WARN] ${message}`, { ...this.context, ...data });
-  }
-
-  error(message: string, data?: Record<string, unknown>): void {
-    console.error(`[ERROR] ${message}`, { ...this.context, ...data });
-  }
-}
-
-async function demonstrateAdvancedFeatures(): Promise<void> {
-  console.log("Revenium Anthropic Middleware - Advanced TypeScript Features\n");
-
-  // Initialize custom logger with type safety
-  const logger = new AdvancedLogger();
-  logger.setContext({
-    service: "advanced-features-demo",
-    version: "1.0.0",
-    environment: "development",
-  });
-  setLogger(logger);
-
-  const anthropic = new Anthropic();
-
-  try {
-    // =============================================================================
-    // ADVANCED TYPESCRIPT PATTERNS WITH STREAMING
-    // =============================================================================
-    console.log("Advanced TypeScript Streaming Patterns");
-    console.log(
-      "Type-safe streaming with event handling and metadata validation\n"
-    );
-
-    // Example 1: Type-safe streaming with advanced metadata
-    console.log(
-      "Example 1: Creative writing with advanced metadata patterns..."
-    );
-
-    // Create strongly typed metadata with satisfies operator
-    const advancedMetadata: UsageMetadata = {
-      subscriber: {
-        id: "artist-456",
-        email: "artist@creative-studio.com",
-        credential: {
-          name: "creative-api-key",
-          value: "creative-key-789",
-        },
-      },
-      organizationId: "creative-ai-studio",
-      productId: "story-generator-pro",
-      taskType: "creative-writing",
-      agent: "storyteller-v2",
-      traceId: `session_${Date.now()}`,
-    } satisfies UsageMetadata;
-
-    // Type-safe streaming with event tracking
-    const streamEvents: StreamEvent[] = [];
-    const startTime = new Date();
-
-    streamEvents.push({
-      type: "start",
-      timestamp: startTime,
-      metadata: advancedMetadata,
-    });
-
-    const stream1 = await anthropic.messages.create({
-      model: "claude-haiku-4-5",
-      max_tokens: 150,
-      messages: [
-        {
-          role: "user",
-          content: "Write a short story about a robot learning to paint.",
-        },
-      ],
-      stream: true,
-      usageMetadata: advancedMetadata, // Fully typed with module augmentation
-    });
-
-    console.log("Streaming response:");
-    let content1 = "";
-    let tokenCount = 0;
-
-    for await (const event of stream1) {
-      if (
-        event.type === "content_block_delta" &&
-        event.delta.type === "text_delta"
-      ) {
-        process.stdout.write(event.delta.text);
-        content1 += event.delta.text;
-        tokenCount++;
-
-        // Add streaming event with type safety
-        streamEvents.push({
-          type: "content",
-          content: event.delta.text,
-          timestamp: new Date(),
-        });
-      }
-    }
-
-    // Complete streaming event tracking
-    const endTime = new Date();
-    streamEvents.push({
-      type: "complete",
-      totalTokens: tokenCount,
-      duration: endTime.getTime() - startTime.getTime(),
-      timestamp: endTime,
-    });
-
-    if (!content1.trim()) throw new Error("No content received from stream");
-    console.log("\nStream 1 completed with type-safe event tracking");
-    console.log(
-      `Events captured: ${streamEvents.length}, Duration: ${
-        endTime.getTime() - startTime.getTime()
-      }ms\n`
-    );
-
-    // =============================================================================
-    // ADVANCED MANUAL TRACKING WITH TYPE SAFETY
-    // =============================================================================
-    console.log("Advanced Manual Tracking with TypeScript");
-    console.log(
-      "Demonstrating manual tracking with full type safety and validation\n"
-    );
-
-    // Example 2: Manual tracking with type-safe data
-    console.log("Example 2: Manual tracking with custom metrics...");
-
-    const now = new Date();
-    const trackingData: TrackingData = {
-      requestId: `manual_${Date.now()}`,
-      model: "claude-haiku-4-5",
-      inputTokens: 25,
-      outputTokens: 150,
-      duration: 2500,
-      isStreamed: false,
-      requestTime: new Date(now.getTime() - 2500), // 2.5 seconds ago
-      responseTime: now,
-      metadata: {
-        subscriber: { id: "manual-user-123" },
-        organizationId: "manual-tracking-org",
-        productId: "custom-analytics",
-        taskType: "manual-analysis",
-      } satisfies UsageMetadata,
-    };
-
-    // Type-safe manual tracking
-    try {
-      trackUsageAsync(trackingData); // Note: this function is synchronous
-      console.log("Manual tracking completed successfully");
-      console.log(
-        `Tracked: ${
-          trackingData.inputTokens + trackingData.outputTokens
-        } tokens, ${trackingData.duration}ms duration\n`
-      );
-    } catch (error) {
-      const errorMessage =
-        error instanceof Error ? error.message : String(error);
-      console.log(`Manual tracking failed: ${errorMessage}\n`);
-    }
-
-    // =============================================================================
-    // SERVICE STATUS WITH TYPE SAFETY
-    // =============================================================================
-    console.log("Service Status and Health Check");
-    console.log("Type-safe middleware status monitoring\n");
-
-    const status: MiddlewareStatus = getStatus();
-    console.log("Middleware Status:", {
-      initialized: status.initialized,
-      patched: status.patched,
-      hasConfig: status.hasConfig,
-      configValid: status.initialized && status.patched && status.hasConfig,
-    });
-
-    // Example 3: Educational content with different metadata pattern
-    console.log(
-      "\nExample 3: Educational content with different metadata pattern..."
-    );
-
-    const educationalMetadata: UsageMetadata = {
-      subscriber: { id: "student-789" },
-      organizationId: "green-tech-edu",
-      productId: "sustainability-tutor",
-      taskType: "educational-query",
-      traceId: `edu_session_${Date.now()}`,
-    } satisfies UsageMetadata;
-
-    const stream2 = await anthropic.messages.create({
-      model: "claude-haiku-4-5",
-      max_tokens: 100,
-      messages: [
-        {
-          role: "user",
-          content: "Explain three benefits of renewable energy.",
-        },
-      ],
-      stream: true,
-      usageMetadata: educationalMetadata, // Fully typed
-    });
-
-    console.log("Educational response:");
-    let content2 = "";
-    for await (const event of stream2) {
-      if (
-        event.type === "content_block_delta" &&
-        event.delta.type === "text_delta"
-      ) {
-        process.stdout.write(event.delta.text);
-        content2 += event.delta.text;
-      }
-    }
-
-    if (!content2.trim()) throw new Error("No content received from stream");
-    console.log("\nStream 2 completed with educational metadata pattern\n");
-
-    // =============================================================================
-    // ADVANCED TOOL USE WITH TYPESCRIPT PATTERNS
-    // =============================================================================
-    console.log("Advanced Tool Use with TypeScript Patterns");
-    console.log(
-      "Tool usage with strongly typed metadata and comprehensive tracking\n"
-    );
-
-    console.log("Example 4: Weather tool with advanced TypeScript patterns...");
-
-    // Create tool-specific metadata with type safety
-    const toolMetadata: UsageMetadata = {
-      subscriber: {
-        id: "weather-user-456",
-        email: "user@weather-app.com",
-      },
-      organizationId: "weather-services-inc",
-      productId: "smart-weather-assistant",
-      taskType: "tool-usage",
-      agent: "weather-bot-v3",
-      traceId: `weather_${Date.now()}`,
-    } satisfies UsageMetadata;
-
-    const toolStream = await anthropic.messages.create({
-      model: "claude-haiku-4-5",
-      max_tokens: 200,
-      tools: [
-        {
-          name: "get_weather",
-          description: "Get current weather for a location",
-          input_schema: {
-            type: "object",
-            properties: {
-              location: {
-                type: "string",
-                description: "City and state, e.g. San Francisco, CA",
-              },
-              units: {
-                type: "string",
-                enum: ["celsius", "fahrenheit"],
-                description: "Temperature units",
-              },
-            },
-            required: ["location"],
-          },
-        },
-      ],
-      messages: [
-        {
-          role: "user",
-          content: "What's the weather like in New York? Use the weather tool.",
-        },
-      ],
-      stream: true,
-      usageMetadata: toolMetadata, // Using strongly typed metadata
-    });
-
-    console.log("Tool use streaming response:");
-    let toolContent = "";
-    for await (const event of toolStream) {
-      if (
-        event.type === "content_block_delta" &&
-        event.delta.type === "text_delta"
-      ) {
-        process.stdout.write(event.delta.text);
-        toolContent += event.delta.text;
-      } else if (
-        event.type === "content_block_start" &&
-        event.content_block.type === "tool_use"
-      ) {
-        console.log(`\nTool called: ${event.content_block.name}`);
-      }
-    }
-
-    if (!toolContent.trim())
-      throw new Error("No content received from tool stream");
-    console.log(
-      "\nTool streaming completed with advanced TypeScript patterns\n"
-    );
-
-    // =============================================================================
-    // SUMMARY AND TYPESCRIPT BENEFITS
-    // =============================================================================
-    console.log("Advanced TypeScript Features Summary");
-    console.log("All examples completed successfully with full type safety!\n");
-
-    console.log("TypeScript Benefits Demonstrated:");
-    console.log("   • Module augmentation for native usageMetadata support");
-    console.log("   • Type-safe metadata with satisfies operator");
-    console.log("   • Strongly typed event handling and streaming");
-    console.log("   • Custom logger implementation with typed interfaces");
-    console.log("   • Comprehensive error handling with typed responses");
-    console.log("   • Generic functions with type constraints");
-    console.log("   • Full IntelliSense support throughout\n");
-
-    console.log("Middleware Status Summary:");
-    const finalStatus = getStatus();
-    console.log(`   • Initialized: ${finalStatus.initialized}`);
-    console.log(`   • Patched: ${finalStatus.patched}`);
-    console.log(`   • Has Config: ${finalStatus.hasConfig}`);
-    console.log(
-      `   • All Systems: ${
-        finalStatus.initialized && finalStatus.patched && finalStatus.hasConfig
-          ? "Operational"
-          : "Check Configuration"
-      }\n`
-    );
-
-    console.log("Next Steps:");
-    console.log("   • Review comprehensive JSDoc in your IDE");
-    console.log(
-      "   • Check the TypeScript-first examples/README.md for more patterns"
-    );
-    console.log(
-      "   • Implement custom metadata extensions for your use case\n"
-    );
-  } catch (error) {
-    // Comprehensive TypeScript error handling
-    const errorMessage = error instanceof Error ? error.message : String(error);
-    console.error("Advanced TypeScript features demo failed:", errorMessage);
-
-    // Type-safe error analysis
-    if (error && typeof error === "object" && "status" in error) {
-      const httpError = error as { status: number; message?: string };
-      if (httpError.status >= 400) {
-        console.error(
-          `HTTP ${httpError.status} Error - API connectivity issue`
-        );
-        console.error("Check your API keys and network connectivity");
-      }
-    }
-
-    // Log final status even on error
-    const errorStatus = getStatus();
-    console.error("Final Middleware Status:", {
-      initialized: errorStatus.initialized,
-      patched: errorStatus.patched,
-      hasConfig: errorStatus.hasConfig,
-    });
-
-    throw error;
-  }
-}
-
-/**
- * Type-safe environment validation
- */
-function checkEnvironment(): void {
-  const required = ["REVENIUM_METERING_API_KEY", "ANTHROPIC_API_KEY"];
-  const missing = required.filter((key) => !process.env[key]);
-
-  if (missing.length > 0) {
-    console.error(
-      "Missing required environment variables for advanced TypeScript features:"
-    );
-    missing.forEach((key) => console.error(`   • ${key}`));
-    console.error("\nSet them in a .env file in the project root:");
-    console.error("   REVENIUM_METERING_API_KEY=hak_your_api_key");
-    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.ai");
-    console.error("   REVENIUM_DEBUG=true  # For detailed logging");
-    process.exit(1);
-  }
-}
-
-// Run the TypeScript demonstration
-if (require.main === module) {
-  checkEnvironment();
-
-  demonstrateAdvancedFeatures()
-    .then(() => {
-      console.log(
-        "\nAdvanced TypeScript Features Demo Completed Successfully!"
-      );
-      console.log("\nTypeScript Features Demonstrated:");
-      console.log("   • Type-safe streaming with event handling");
-      console.log("   • Custom logger implementation with typed interfaces");
-      console.log("   • Manual tracking with full type safety");
-      console.log("   • Comprehensive error handling with typed responses");
-      console.log("   • Module augmentation for native usageMetadata support");
-      console.log("   • Generic functions with type constraints");
-      console.log("   • Full IntelliSense support throughout");
-      console.log(
-        "\nNext: Check examples/README.md for more TypeScript patterns!"
-      );
-      console.log(
-        "\nTip: Set REVENIUM_DEBUG=true in .env file for detailed tracking logs"
-      );
-    })
-    .catch((error) => {
-      console.error("\nAdvanced TypeScript features demo failed:", error);
-      process.exit(1);
-    });
-}