@revenium/anthropic 1.0.8 → 1.1.0

package/examples/basic-usage.ts

@@ -1,314 +0,0 @@
-/**
- * Revenium Anthropic Middleware - TypeScript-First Basic Usage Example
- *
- * This example demonstrates TypeScript-first patterns with all initialization methods:
- * • Auto-initialization with module augmentation (TypeScript-native usageMetadata)
- * • Explicit initialization with type-safe error handling
- * • Manual configuration with full type control and validation
- * • Interface validation using the `satisfies` operator
- * • Comprehensive type safety throughout
- *
- * Features TypeScript patterns like:
- * - Module augmentation for native usageMetadata support
- * - Type-safe configuration with validation
- * - Strongly typed metadata with satisfies operator
- * - Generic functions with type constraints
- * - Comprehensive error handling with typed responses
- */
-
-// 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 and functions for full TypeScript support
-import type {
-  UsageMetadata,
-  ReveniumConfig,
-  ConfigValidationResult,
-  MiddlewareStatus,
-} from "@revenium/anthropic";
-
-// Import initialization and configuration functions
-import { initialize, getStatus, configure, getConfig } from "@revenium/anthropic";
-
-async function demonstrateBasicUsage() {
-  console.log("Revenium Anthropic Middleware - Basic Usage Examples\n");
-
-  // =============================================================================
-  // OPTION A: Auto-Initialization (Simplest - Recommended for Most Projects)
-  // =============================================================================
-  console.log("Option A: Auto-Initialization (Simplest)");
-  console.log(
-    "Just import the middleware - it auto-configures from environment variables\n"
-  );
-
-  // The middleware was already imported at the top of the file - auto-initialization happens automatically
-  const anthropic = new Anthropic();
-
-  try {
-    // Example 1: Basic request without metadata (still tracked automatically)
-    console.log("Example 1: Basic request without metadata...");
-    const basicResponse = await anthropic.messages.create({
-      model: "claude-haiku-4-5",
-      max_tokens: 50,
-      messages: [
-        { role: "user", content: "What is the capital of France? Be concise." },
-      ],
-      // No metadata - still tracked automatically
-    });
-
-    console.log(
-      "Response:",
-      basicResponse.content[0].type === "text"
-        ? basicResponse.content[0].text
-        : "Non-text response"
-    );
-    console.log(
-      `   Tokens: ${basicResponse.usage?.input_tokens} input + ${basicResponse.usage?.output_tokens} output\n`
-    );
-
-    // Example 2: Request with rich metadata for enhanced tracking
-    console.log("Example 2: Request with rich metadata...");
-    const metadataResponse = await anthropic.messages.create({
-      model: "claude-haiku-4-5",
-      max_tokens: 80,
-      messages: [
-        { role: "user", content: "Explain quantum computing in one sentence." },
-      ],
-      // Add rich metadata for enhanced analytics and billing
-      usageMetadata: {
-        subscriber: {
-          id: "user-456",
-          email: "user@demo-org.com",
-          credential: {
-            name: "demo-api-key",
-            value: "demo-key-123",
-          },
-        },
-        organizationId: "demo-org-123",
-        productId: "ai-assistant-v2",
-        taskType: "educational-query",
-        agent: "anthropic-basic-demo",
-        traceId: "session-" + Date.now(),
-      },
-    });
-
-    console.log(
-      "Response:",
-      metadataResponse.content[0].type === "text"
-        ? metadataResponse.content[0].text
-        : "Non-text response"
-    );
-    console.log(
-      `   Tokens: ${metadataResponse.usage?.input_tokens} input + ${metadataResponse.usage?.output_tokens} output\n`
-    );
-
-    // Wait a moment for async tracking to complete
-    console.log("Waiting for tracking to complete...");
-    await new Promise((resolve) => setTimeout(resolve, 2000));
-
-    console.log(
-      "✓ Auto-initialization: Both requests completed and tracking attempted\n"
-    );
-  } catch (error) {
-    console.error("Error: Auto-initialization failed:", error);
-    console.log("Falling back to explicit initialization...\n");
-
-    // =============================================================================
-    // OPTION B: Explicit Initialization (Better Error Control)
-    // =============================================================================
-    await demonstrateExplicitInitialization();
-  }
-}
-
-async function demonstrateExplicitInitialization() {
-  console.log("Option B: Explicit Initialization (Better Error Control)");
-  console.log(
-    "Call initialize() explicitly for clear error feedback and better control\n"
-  );
-
-  try {
-    // Explicitly initialize with clear error feedback
-    initialize();
-    console.log("✓ Explicit initialization successful!");
-
-    // Check status after initialization
-    const status = getStatus();
-    console.log("Middleware status:", {
-      initialized: status.initialized,
-      patched: status.patched,
-      hasConfig: status.hasConfig,
-    });
-
-    // Now use Anthropic with guaranteed tracking
-    const anthropic = new Anthropic();
-    const response = await anthropic.messages.create({
-      model: "claude-haiku-4-5",
-      max_tokens: 60,
-      messages: [
-        {
-          role: "user",
-          content: "What are the benefits of explicit initialization?",
-        },
-      ],
-      usageMetadata: {
-        subscriber: {
-          id: "explicit-user-789",
-          // email and credential are optional
-        },
-        organizationId: "explicit-demo",
-        taskType: "explicit-initialization-example",
-      },
-    });
-
-    console.log(
-      "Response:",
-      response.content[0].type === "text"
-        ? response.content[0].text
-        : "Non-text response"
-    );
-    console.log(
-      "✓ Explicit initialization: Request tracked with guaranteed configuration!\n"
-    );
-  } catch (error) {
-    console.error("Explicit initialization failed:", (error as Error).message);
-    console.log("Falling back to manual configuration...\n");
-
-    // =============================================================================
-    // OPTION C: Manual Configuration (Full Control)
-    // =============================================================================
-    await demonstrateManualConfiguration();
-  }
-}
-
-async function demonstrateManualConfiguration() {
-  console.log("Option C: Manual Configuration (Full Control)");
-
-  try {
-    // Manual configuration with all options
-    configure({
-      // Required: Revenium API configuration
-      reveniumApiKey:
-        process.env.REVENIUM_METERING_API_KEY || "hak_your_api_key_here",
-      reveniumBaseUrl:
-        process.env.REVENIUM_METERING_BASE_URL || "https://api.revenium.ai",
-
-      // Optional: Anthropic API key (can also be set in Anthropic client)
-      anthropicApiKey: process.env.ANTHROPIC_API_KEY,
-
-      // Optional: Performance and reliability settings
-      apiTimeout: 8000, // 8 second timeout (default: 5000)
-      maxRetries: 5, // 5 retry attempts (default: 3)
-      failSilent: false, // Throw errors instead of silent failure (default: true)
-    });
-
-    console.log("Success: Manual configuration completed!");
-
-    // Verify configuration
-    const config = getConfig();
-    console.log("Configuration:", {
-      hasReveniumKey: !!config?.reveniumApiKey,
-      baseUrl: config?.reveniumBaseUrl,
-      timeout: config?.apiTimeout,
-      maxRetries: config?.maxRetries,
-    });
-
-    // Use Anthropic with custom configuration
-    const anthropic = new Anthropic({
-      apiKey: process.env.ANTHROPIC_API_KEY || "sk-ant-your_anthropic_key_here",
-    });
-
-    const response = await anthropic.messages.create({
-      model: "claude-haiku-4-5",
-      max_tokens: 80,
-      messages: [
-        {
-          role: "user",
-          content:
-            "What are the advantages of manual configuration in enterprise software?",
-        },
-      ],
-      // Enterprise-grade metadata
-      usageMetadata: {
-        subscriber: {
-          id: "manual-config-user",
-          email: "enterprise@corp.com",
-          credential: {
-            name: "enterprise-api-key",
-            value: "ent-key-456",
-          },
-        },
-        organizationId: "enterprise-corp",
-        productId: "enterprise-ai-platform",
-        taskType: "manual-configuration-demo",
-        agent: "anthropic-enterprise-v1",
-        responseQualityScore: 0.98,
-      },
-    });
-
-    console.log(
-      "Response:",
-      response.content[0].type === "text"
-        ? response.content[0].text
-        : "Non-text response"
-    );
-    console.log(
-      "Success: Manual configuration - Request tracked with custom enterprise settings!\n"
-    );
-  } catch (error) {
-    console.error(
-      "Error: Manual configuration failed:",
-      (error as Error).message
-    );
-    throw error;
-  }
-}
-
-// Environment validation
-function checkEnvironment() {
-  const required = ["REVENIUM_METERING_API_KEY", "ANTHROPIC_API_KEY"];
-  const missing = required.filter((key) => !process.env[key]);
-
-  if (missing.length > 0) {
-    console.error("Error: Missing required environment variables:");
-    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 example
-if (require.main === module) {
-  checkEnvironment();
-
-  demonstrateBasicUsage()
-    .then(() => {
-      console.log("✓ Basic usage examples completed successfully!");
-      console.log("\nSummary of initialization methods:");
-      console.log("   • Auto-initialization: Simplest - just import and go");
-      console.log(
-        "   • Explicit initialization: Better error control and debugging"
-      );
-      console.log(
-        "   • Manual configuration: Full control for enterprise applications"
-      );
-      console.log(
-        "\n✓ All requests automatically tracked to Revenium with rich metadata support"
-      );
-      console.log(
-        "\nTo see detailed tracking logs, set REVENIUM_DEBUG=true in .env file"
-      );
-    })
-    .catch((error) => {
-      console.error("\nError: Basic usage examples failed:", error);
-      process.exit(1);
-    });
-}