@revenium/perplexity 2.0.3 → 2.0.5

package/examples/getting_started.ts

@@ -0,0 +1,41 @@
+/**
+ * Getting Started with Revenium Perplexity Middleware
+ *
+ * This example shows the new Initialize/GetClient pattern.
+ */
+
+import { Initialize, GetClient, UsageMetadata } from "@revenium/perplexity";
+
+async function main() {
+  Initialize();
+
+  // Get client
+  const client = GetClient();
+  const metadata: UsageMetadata = {
+    organizationId: "org-getting-started",
+    productId: "prod-perplexity-getting-started",
+  };
+
+  // Create a simple chat completion
+  const response = await client
+    .chat()
+    .completions()
+    .create(
+      {
+        model: "sonar-pro",
+        messages: [
+          {
+            role: "user",
+            content: "What is artificial intelligence?",
+          },
+        ],
+        max_tokens: 500,
+      },
+      metadata
+    );
+
+  console.log("Assistant:", response.choices[0]?.message?.content);
+  console.log("\nUsage:", response.usage);
+}
+
+main().catch(console.error);

package/examples/metadata.ts

@@ -1,72 +1,68 @@
 /**
- * Custom Metadata Example
- * 
- * This example demonstrates how to pass custom metadata
- * for tracking and metering purposes.
+ * Metadata Example
+ * Demonstrates advanced metadata usage with Revenium Perplexity middleware.
  */
 
-import {
-  initializeReveniumFromEnv,
-  initializePerplexityFromEnv,
-  createChatCompletion,
-  PERPLEXITY_MODELS,
-} from "../src";
+import { Initialize, GetClient, UsageMetadata } from "@revenium/perplexity";
 
 async function main() {
-  console.log("Custom Metadata Example\n");
+  // Initialize middleware
+  Initialize();
 
-  // Initialize configurations from environment variables
-  console.log("Initializing configurations...");
-  const reveniumConfig = initializeReveniumFromEnv();
-  initializePerplexityFromEnv();
-  console.log("Configurations initialized\n");
+  // Get client
+  const client = GetClient();
 
-  // Create a chat completion with custom metadata
-  console.log("Creating chat completion with custom metadata...");
-  const result = await createChatCompletion({
-    messages: [
-      {
-        role: "user",
-        content: "What is 2 + 2?",
-      },
-    ],
-    model: PERPLEXITY_MODELS.SONAR_PRO,
-    maxTokens: 50,
-    usageMetadata: {
-      subscriber: {
-        id: "user-123",
-        email: "user@example.com",
+  // Optional metadata for advanced reporting, lineage tracking, and cost allocation
+  const metadata: UsageMetadata = {
+    // Organization & billing
+    organizationId: "org-metadata-demo",
+    subscriptionId: "plan-premium-2025",
+
+    // Product & task tracking
+    productId: "ai-assistant",
+    taskType: "explanation-request",
+    agent: "perplexity-metadata-chat-node",
+
+    // Session tracking
+    traceId: "session-" + Date.now(),
+
+    // Quality metrics
+    responseQualityScore: 0.95, // 0.0-1.0 scale
+
+    // User tracking
+    subscriber: {
+      id: "user-12345",
+      email: "developer@company.com",
+      credential: {
+        name: "api-key-prod",
+        value: "key-abc-123",
       },
-      organizationId: "org-example",
-      productId: "product-premium",
-      traceId: "trace-abc-123",
     },
-  });
+  };
 
-  console.log("\nResponse:");
-  console.log("─────────────────────────────────────────");
-  console.log(`Content: ${result.content}`);
-  console.log(`Model: ${result.model}`);
-  console.log(`Transaction ID: ${result.transactionId}`);
-  console.log(`\nToken Usage:`);
-  console.log(`  - Prompt Tokens: ${result.usage.promptTokens}`);
-  console.log(`  - Completion Tokens: ${result.usage.completionTokens}`);
-  console.log(`  - Total Tokens: ${result.usage.totalTokens}`);
-  console.log("\nCustom Metadata:");
-  console.log(`  - Subscriber ID: user-123`);
-  console.log(`  - Organization ID: org-example`);
-  console.log(`  - Product ID: product-premium`);
-  console.log(`  - Trace ID: trace-abc-123`);
-  console.log("─────────────────────────────────────────\n");
+  const response = await client
+    .chat()
+    .completions()
+    .create(
+      {
+        model: "sonar-pro",
+        messages: [
+          {
+            role: "user",
+            content:
+              "Say hello in Spanish and explain why Spanish is a beautiful language in 2-3 sentences.",
+          },
+        ],
+        max_tokens: 1000,
+      },
+      metadata
+    );
 
-  console.log("Example completed successfully!");
-  console.log(
-    "Check your Revenium dashboard to see the metering data with custom metadata."
-  );
+  // Display response
+  if (response.choices.length > 0) {
+    console.log(`Assistant: ${response.choices[0].message.content}`);
+  }
+  console.log("\nUsage data sent to Revenium! Check your dashboard");
 }
 
-main().catch((error) => {
-  console.error("Error:", error.message);
-  process.exit(1);
-});
-
+main().catch(console.error);

package/examples/stream.ts

@@ -0,0 +1,53 @@
+/**
+ * Streaming Example with Revenium Perplexity Middleware (New Go-Aligned API)
+ *
+ * This example shows how to use streaming with the new API.
+ */
+
+import { Initialize, GetClient } from "@revenium/perplexity";
+
+async function main() {
+  // Initialize from environment variables
+  Initialize();
+
+  // Get client
+  const client = GetClient();
+
+  console.log("Streaming response:\n");
+
+  // Create a streaming chat completion
+  const stream = await client
+    .chat()
+    .completions()
+    .createStreaming(
+      {
+        model: "sonar-pro",
+        messages: [
+          {
+            role: "user",
+            content: "Write a short poem about AI",
+          },
+        ],
+        max_tokens: 200,
+      },
+      {
+        // Optional metadata
+        organizationId: "my-customers-name",
+        productId: "my-product",
+        subscriber: {
+          id: "user-123",
+          email: "user@example.com",
+        },
+      }
+    );
+
+  // Process stream
+  for await (const chunk of stream) {
+    const content = chunk.choices[0]?.delta?.content || "";
+    process.stdout.write(content);
+  }
+
+  console.log("\n\nUsage data sent to Revenium! Check your dashboard");
+}
+
+main().catch(console.error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revenium/perplexity",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "description": "NodeJS middleware for Perplexity AI API with Revenium metering",
   "homepage": "https://github.com/revenium/revenium-middleware-perplexity-node#readme",
   "bugs": {
@@ -21,13 +21,12 @@
     }
   },
   "files": [
-    "dist/cjs/**/*.js",
-    "dist/esm/**/*.js",
-    "dist/types/**/*.d.ts",
-    "examples/**/*",
+    "dist/",
+    "examples/",
     "README.md",
     "CHANGELOG.md",
-    "LICENSE"
+    "LICENSE",
+    "SECURITY.md"
   ],
   "scripts": {
     "clean": "rm -rf dist",
@@ -36,15 +35,12 @@
     "build:types": "tsc -p tsconfig.types.json",
     "build": "npm run clean && npm run build:esm && npm run build:cjs && npm run build:types",
     "prepublishOnly": "npm run build",
-    "example:basic": "tsx examples/basic.ts",
-    "example:streaming": "tsx examples/streaming.ts",
-    "example:chat": "tsx examples/chat.ts",
-    "example:metadata": "tsx examples/metadata.ts",
-    "playground:basic": "node playground/basic.js",
-    "playground:streaming": "node playground/streaming.js",
-    "playground:chat": "node playground/chat.js",
-    "playground:metadata": "node playground/metadata.js",
-    "test": "npm run example:basic && npm run example:streaming && npm run example:chat && npm run example:metadata"
+    "example:getting-started": "npx tsx examples/getting_started.ts",
+    "example:basic": "npx tsx examples/basic.ts",
+    "example:metadata": "npx tsx examples/metadata.ts",
+    "example:advanced": "npx tsx examples/advanced.ts",
+    "example:stream": "npx tsx examples/stream.ts",
+    "test": "npm run example:getting-started && npm run example:stream"
   },
   "keywords": [
     "revenium",
@@ -59,9 +55,8 @@
   ],
   "author": "Revenium",
   "license": "MIT",
-  "type": "commonjs",
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=20.0.0"
   },
   "dependencies": {
     "dotenv": "^17.2.2",

package/dist/cjs/core/config/perplexity-config.js

@@ -1,45 +0,0 @@
-"use strict";
-/**
- * Perplexity Configuration Module
- * Manages Perplexity API configuration
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.initializePerplexityFromEnv = initializePerplexityFromEnv;
-exports.initializePerplexity = initializePerplexity;
-exports.getPerplexityConfig = getPerplexityConfig;
-const logger_1 = require("../../utils/logger");
-let perplexityConfig = null;
-/**
- * Initialize Perplexity configuration from environment variables
- */
-function initializePerplexityFromEnv() {
-    const apiKey = process.env.PERPLEXITY_API_KEY;
-    const baseUrl = process.env.PERPLEXITY_API_BASE_URL || "https://api.perplexity.ai";
-    if (!apiKey) {
-        throw new Error("PERPLEXITY_API_KEY environment variable is required but not set");
-    }
-    perplexityConfig = {
-        apiKey,
-        baseUrl,
-    };
-    logger_1.logger.info("Perplexity configuration initialized successfully");
-    return perplexityConfig;
-}
-/**
- * Initialize Perplexity configuration with custom values
- */
-function initializePerplexity(config) {
-    perplexityConfig = {
-        apiKey: config.apiKey,
-        baseUrl: config.baseUrl || "https://api.perplexity.ai",
-    };
-    logger_1.logger.info("Perplexity configuration initialized with custom config");
-    return perplexityConfig;
-}
-/**
- * Get current Perplexity configuration
- */
-function getPerplexityConfig() {
-    return perplexityConfig;
-}
-//# sourceMappingURL=perplexity-config.js.map

package/dist/cjs/core/config/revenium-config.js

@@ -1,80 +0,0 @@
-"use strict";
-/**
- * Revenium Configuration Module
- * Manages Revenium metering configuration and initialization
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.initializeReveniumFromEnv = initializeReveniumFromEnv;
-exports.initializeRevenium = initializeRevenium;
-exports.getReveniumConfig = getReveniumConfig;
-exports.isReveniumEnabled = isReveniumEnabled;
-exports.disableRevenium = disableRevenium;
-exports.enableRevenium = enableRevenium;
-const logger_1 = require("../../utils/logger");
-let reveniumConfig = null;
-/**
- * Initialize Revenium configuration from environment variables
- */
-function initializeReveniumFromEnv() {
-    const meteringApiKey = process.env.REVENIUM_METERING_API_KEY?.trim().replace(/^["']|["']$/g, "");
-    const meteringBaseUrl = process.env.REVENIUM_METERING_BASE_URL?.trim().replace(/^["']|["']$/g, "");
-    if (!meteringApiKey || !meteringBaseUrl) {
-        logger_1.logger.warn("Revenium metering disabled: Missing REVENIUM_METERING_API_KEY or REVENIUM_METERING_BASE_URL");
-        reveniumConfig = {
-            meteringApiKey: "",
-            meteringBaseUrl: "",
-            enabled: false,
-        };
-        return reveniumConfig;
-    }
-    reveniumConfig = {
-        meteringApiKey,
-        meteringBaseUrl,
-        enabled: true,
-    };
-    logger_1.logger.info("Revenium configuration initialized successfully");
-    logger_1.logger.debug(`Metering Base URL: ${meteringBaseUrl}`);
-    return reveniumConfig;
-}
-/**
- * Initialize Revenium configuration with custom values
- */
-function initializeRevenium(config) {
-    reveniumConfig = {
-        ...config,
-        enabled: true,
-    };
-    logger_1.logger.info("Revenium configuration initialized with custom config");
-    return reveniumConfig;
-}
-/**
- * Get current Revenium configuration
- */
-function getReveniumConfig() {
-    return reveniumConfig;
-}
-/**
- * Check if Revenium is enabled
- */
-function isReveniumEnabled() {
-    return reveniumConfig?.enabled ?? false;
-}
-/**
- * Disable Revenium metering
- */
-function disableRevenium() {
-    if (reveniumConfig) {
-        reveniumConfig.enabled = false;
-        logger_1.logger.info("Revenium metering disabled");
-    }
-}
-/**
- * Enable Revenium metering
- */
-function enableRevenium() {
-    if (reveniumConfig) {
-        reveniumConfig.enabled = true;
-        logger_1.logger.info("Revenium metering enabled");
-    }
-}
-//# sourceMappingURL=revenium-config.js.map

package/dist/cjs/core/tracking/metering.js

@@ -1,131 +0,0 @@
-"use strict";
-/**
- * Revenium Metering Module
- * Handles tracking and sending metering data to Revenium
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateTransactionId = generateTransactionId;
-exports.buildMeteringData = buildMeteringData;
-exports.sendMeteringData = sendMeteringData;
-const revenium_config_1 = require("../config/revenium-config");
-const logger_1 = require("../../utils/logger");
-/**
- * Generate a unique transaction ID
- */
-function generateTransactionId() {
-    return `txn_${Date.now()}_${Math.random().toString(36).substring(2, 15)}`;
-}
-/**
- * Format timestamp to ISO string
- */
-function formatTimestamp(date) {
-    return date.toISOString();
-}
-/**
- * Calculate duration in milliseconds
- */
-function calculateDuration(startTime, endTime) {
-    return endTime.getTime() - startTime.getTime();
-}
-/**
- * Build metering data from request information
- */
-function buildMeteringData(params) {
-    const { model, startTime, endTime, inputTokens, outputTokens, totalTokens, reasoningTokens = 0, cachedTokens = 0, transactionId, isStreamed, stopReason, usageMetadata = {}, } = params;
-    const config = (0, revenium_config_1.getReveniumConfig)();
-    const agent = "perplexity";
-    const costType = "TOKEN";
-    const operationType = "CHAT";
-    // Build subscriber information
-    const subscriberId = usageMetadata.subscriber?.id ||
-        usageMetadata.subscriberId ||
-        `user-${generateTransactionId()}`;
-    const subscriberEmail = usageMetadata.subscriber?.email ||
-        usageMetadata.subscriberEmail ||
-        `user@${agent}.ai`;
-    const subscriberCredential = usageMetadata.subscriber?.credential ||
-        (usageMetadata.subscriberCredentialName &&
-            usageMetadata.subscriberCredential
-            ? {
-                name: usageMetadata.subscriberCredentialName,
-                value: usageMetadata.subscriberCredential,
-            }
-            : {
-                name: "default",
-                value: "default-credential",
-            });
-    const subscriber = {
-        id: subscriberId,
-        email: subscriberEmail,
-        credential: subscriberCredential,
-    };
-    // Build the payload in the exact order expected by Revenium API v2
-    const payload = {
-        stopReason: "END",
-        costType: "AI", // Fixed value as per Google middleware
-        isStreamed,
-        taskType: "AI", // Fixed value as per Google middleware
-        agent: usageMetadata.agent || agent,
-        operationType: usageMetadata.operationType || operationType,
-        inputTokenCount: usageMetadata.inputTokenCount ?? inputTokens,
-        outputTokenCount: usageMetadata.outputTokenCount ?? outputTokens,
-        reasoningTokenCount: usageMetadata.reasoningTokenCount ?? reasoningTokens,
-        cacheCreationTokenCount: usageMetadata.cacheCreationTokenCount ?? cachedTokens,
-        cacheReadTokenCount: usageMetadata.cacheReadTokenCount ?? 0,
-        totalTokenCount: usageMetadata.totalTokenCount ?? totalTokens,
-        organizationId: usageMetadata.organizationId || "my-customers-name",
-        productId: usageMetadata.productId || "free-trial",
-        subscriber,
-        model,
-        transactionId: usageMetadata.transactionId || transactionId,
-        responseTime: usageMetadata.responseTime || formatTimestamp(endTime),
-        requestDuration: calculateDuration(startTime, endTime),
-        provider: agent,
-        requestTime: usageMetadata.requestTime || formatTimestamp(startTime),
-        completionStartTime: usageMetadata.completionStartTime || formatTimestamp(endTime),
-        timeToFirstToken: usageMetadata.timeToFirstToken || 0,
-        middleware_source: "node",
-    };
-    // Only add traceId if it's provided
-    if (usageMetadata.traceId) {
-        payload.traceId = usageMetadata.traceId;
-    }
-    return payload;
-}
-/**
- * Send metering data to Revenium
- */
-async function sendMeteringData(meteringData) {
-    if (!(0, revenium_config_1.isReveniumEnabled)()) {
-        logger_1.logger.debug("Revenium metering is disabled, skipping metering data");
-        return;
-    }
-    const config = (0, revenium_config_1.getReveniumConfig)();
-    if (!config) {
-        logger_1.logger.warn("Revenium configuration not initialized");
-        return;
-    }
-    try {
-        const url = `${config.meteringBaseUrl}/v2/ai/completions`;
-        logger_1.logger.debug("Sending metering data to Revenium:", JSON.stringify(meteringData, null, 2));
-        const response = await fetch(url, {
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-                "x-api-key": config.meteringApiKey,
-                accept: "application/json",
-            },
-            body: JSON.stringify(meteringData),
-        });
-        if (!response.ok) {
-            const errorData = await response.text();
-            logger_1.logger.error(`Metering API request failed with status ${response.status}: ${errorData}`);
-            return;
-        }
-        logger_1.logger.info("Metering data sent successfully to Revenium");
-    }
-    catch (error) {
-        logger_1.logger.error("Error sending metering data:", error.message);
-    }
-}
-//# sourceMappingURL=metering.js.map