@revenium/perplexity 1.0.7 → 1.0.8

package/.env.example

@@ -0,0 +1,3 @@
+PERPLEXITY_API_KEY=your_perplexity_api_key_here
+REVENIUM_METERING_API_KEY=your_revenium_api_key_here
+REVENIUM_METERING_BASE_URL="https://api.revenium.io/meter"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revenium/perplexity",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "NodeJS middleware for perplexity's AI API",
   "homepage": "https://github.com/revenium/revenium-middleware-perplexity-node#readme",
   "bugs": {
@@ -27,7 +27,14 @@
     "multiple-models-example": "npx ts-node examples/multiple-models-example.ts",
     "openai-client-example": "npx ts-node examples/openai-client-example.ts",
     "metadata-example": "npx ts-node examples/metadata-example.ts",
-    "run-all-examples": "npx ts-node examples/run-all-examples.ts"
+    "run-all-examples": "npx ts-node examples/run-all-examples.ts",
+    "p-basic": "npx ts-node playground/basic.js",
+    "p-custom-config": "npx ts-node playground/custom-config.js",
+    "p-enhanced": "npx ts-node playground/enhanced.js",
+    "p-metadata": "npx ts-node playground/metadata.js",
+    "p-multiple-models": "npx ts-node playground/multiple-models.js",
+    "p-openai-client": "npx ts-node playground/openai-client.js",
+    "p-streaming": "npx ts-node playground/openai-client.js"
   },
   "keywords": [
     "revenium",

package/playground/custom-config.js

@@ -1,82 +1,82 @@
-import { createPerplexityClient } from "@revenium/perplexity";
-
-async function customConfigExample() {
-  console.log("\n⚙️ Perplexity AI - Custom Configuration Example");
-  console.log("=".repeat(50));
-
-  try {
-    // Example 1: Using environment variables (default)
-    console.log("\n1️⃣ Using environment variables:");
-    const defaultClient = createPerplexityClient();
-    
-    const response1 = await defaultClient.createChatCompletion({
-      model: "sonar-pro",
-      messages: [
-        {
-          role: "user",
-          content: "Hello from default configuration!",
-        },
-      ],
-    });
-    console.log("✅ Default config response:", response1.choices[0]?.message?.content?.substring(0, 50) + "...");
-
-    // Example 2: Custom API key only
-    console.log("\n2️⃣ Using custom API key:");
-    const customKeyClient = createPerplexityClient(process.env.PERPLEXITY_API_KEY);
-    
-    const response2 = await customKeyClient.createChatCompletion({
-      model: "sonar-pro",
-      messages: [
-        {
-          role: "user",
-          content: "Hello from custom API key configuration!",
-        },
-      ],
-    });
-    console.log("✅ Custom key response:", response2.choices[0]?.message?.content?.substring(0, 50) + "...");
-
-    // Example 3: Custom API key and base URL
-    console.log("\n3️⃣ Using custom API key and base URL:");
-    const fullCustomClient = createPerplexityClient(
-      process.env.PERPLEXITY_API_KEY,
-      "https://api.perplexity.ai"
-    );
-    
-    const response3 = await fullCustomClient.createChatCompletion({
-      model: "sonar-pro",
-      messages: [
-        {
-          role: "user",
-          content: "Hello from fully custom configuration!",
-        },
-      ],
-    });
-    console.log("✅ Full custom response:", response3.choices[0]?.message?.content?.substring(0, 50) + "...");
-
-    // Example 4: Custom base URL only (API key from env)
-    console.log("\n4️⃣ Using custom base URL only:");
-    const customUrlClient = createPerplexityClient(
-      undefined,
-      "https://api.perplexity.ai"
-    );
-    
-    const response4 = await customUrlClient.createChatCompletion({
-      model: "sonar-pro",
-      messages: [
-        {
-          role: "user",
-          content: "Hello from custom URL configuration!",
-        },
-      ],
-    });
-    console.log("✅ Custom URL response:", response4.choices[0]?.message?.content?.substring(0, 50) + "...");
-
-    console.log("\n🎉 All configuration examples completed successfully!");
-    console.log("📊 All requests tracked by middleware regardless of configuration");
-
-  } catch (error) {
-    console.error("❌ Error:", error);
-  }
-}
-
-customConfigExample();
+import { createPerplexityClient } from "@revenium/perplexity";
+
+async function customConfigExample() {
+  console.log("\n⚙️ Perplexity AI - Custom Configuration Example");
+  console.log("=".repeat(50));
+
+  try {
+    // Example 1: Using environment variables (default)
+    console.log("\n1️⃣ Using environment variables:");
+    const defaultClient = createPerplexityClient();
+    
+    const response1 = await defaultClient.createChatCompletion({
+      model: "sonar-pro",
+      messages: [
+        {
+          role: "user",
+          content: "Hello from default configuration!",
+        },
+      ],
+    });
+    console.log("✅ Default config response:", response1.choices[0]?.message?.content?.substring(0, 50) + "...");
+
+    // Example 2: Custom API key only
+    console.log("\n2️⃣ Using custom API key:");
+    const customKeyClient = createPerplexityClient(process.env.PERPLEXITY_API_KEY);
+    
+    const response2 = await customKeyClient.createChatCompletion({
+      model: "sonar-pro",
+      messages: [
+        {
+          role: "user",
+          content: "Hello from custom API key configuration!",
+        },
+      ],
+    });
+    console.log("✅ Custom key response:", response2.choices[0]?.message?.content?.substring(0, 50) + "...");
+
+    // Example 3: Custom API key and base URL
+    console.log("\n3️⃣ Using custom API key and base URL:");
+    const fullCustomClient = createPerplexityClient(
+      process.env.PERPLEXITY_API_KEY,
+      "https://api.perplexity.ai"
+    );
+    
+    const response3 = await fullCustomClient.createChatCompletion({
+      model: "sonar-pro",
+      messages: [
+        {
+          role: "user",
+          content: "Hello from fully custom configuration!",
+        },
+      ],
+    });
+    console.log("✅ Full custom response:", response3.choices[0]?.message?.content?.substring(0, 50) + "...");
+
+    // Example 4: Custom base URL only (API key from env)
+    console.log("\n4️⃣ Using custom base URL only:");
+    const customUrlClient = createPerplexityClient(
+      undefined,
+      "https://api.perplexity.ai"
+    );
+    
+    const response4 = await customUrlClient.createChatCompletion({
+      model: "sonar-pro",
+      messages: [
+        {
+          role: "user",
+          content: "Hello from custom URL configuration!",
+        },
+      ],
+    });
+    console.log("✅ Custom URL response:", response4.choices[0]?.message?.content?.substring(0, 50) + "...");
+
+    console.log("\n🎉 All configuration examples completed successfully!");
+    console.log("📊 All requests tracked by middleware regardless of configuration");
+
+  } catch (error) {
+    console.error("❌ Error:", error);
+  }
+}
+
+customConfigExample();

package/playground/metadata.js

@@ -1,94 +1,94 @@
-import { createPerplexityClient } from "@revenium/perplexity";
-
-async function metadataExample() {
-  console.log("\n📊 Perplexity AI - Metadata Tracking Example");
-  console.log("=".repeat(50));
-
-  try {
-    // Create client instance
-    const client = createPerplexityClient();
-
-    // Example 1: Basic metadata
-    console.log("\n1️⃣ Basic metadata tracking:");
-    const basicResponse = await client.createChatCompletion({
-      model: "sonar-pro",
-      messages: [
-        {
-          role: "user",
-          content: "Analyze this quarterly report for key insights",
-        },
-      ],
-      usageMetadata: {
-        traceId: "conv-28a7e9d4",
-        taskType: "document-analysis",
-        subscriberEmail: "user@example.com",
-        organizationId: "acme-corp",
-        subscriptionId: "premium-plan",
-      },
-    });
-
-    console.log(
-      "✅ Response:",
-      basicResponse.choices[0]?.message?.content?.substring(0, 100) + "..."
-    );
-
-    // Example 2: Advanced metadata
-    console.log("\n2️⃣ Advanced metadata tracking:");
-    const advancedResponse = await client.createChatCompletion({
-      model: "sonar-pro",
-      messages: [
-        {
-          role: "user",
-          content: "What are the latest developments in AI?",
-        },
-      ],
-      usageMetadata: {
-        traceId: "conv-advanced-123",
-        taskType: "research",
-        subscriberId: "user-12345",
-        subscriberCredentialName: "api-key-1",
-        productId: "business-intelligence",
-        agent: "research-assistant-v2",
-        responseQualityScore: 0.95,
-      },
-    });
-
-    console.log(
-      "✅ Response:",
-      advancedResponse.choices[0]?.message?.content?.substring(0, 100) + "..."
-    );
-
-    // Example 3: Streaming with metadata
-    console.log("\n3️⃣ Streaming with metadata:");
-    const stream = await client.createStreamingChatCompletion({
-      model: "sonar-pro",
-      messages: [
-        {
-          role: "user",
-          content: "Write a creative story about AI",
-        },
-      ],
-      usageMetadata: {
-        traceId: "conv-streaming-456",
-        taskType: "creative-writing",
-        organizationId: "creative-studio",
-        agent: "story-generator",
-      },
-    });
-
-    console.log("📝 Streaming response with metadata:");
-    for await (const chunk of stream) {
-      const content = chunk.choices[0]?.delta?.content;
-      if (content) {
-        process.stdout.write(content);
-      }
-    }
-
-    console.log("\n\n🎉 All metadata examples completed successfully!");
-    console.log("📊 All usage tracked with custom metadata");
-  } catch (error) {
-    console.error("❌ Error:", error);
-  }
-}
-
-metadataExample();
+import { createPerplexityClient } from "@revenium/perplexity";
+
+async function metadataExample() {
+  console.log("\n📊 Perplexity AI - Metadata Tracking Example");
+  console.log("=".repeat(50));
+
+  try {
+    // Create client instance
+    const client = createPerplexityClient();
+
+    // Example 1: Basic metadata
+    console.log("\n1️⃣ Basic metadata tracking:");
+    const basicResponse = await client.createChatCompletion({
+      model: "sonar-pro",
+      messages: [
+        {
+          role: "user",
+          content: "Analyze this quarterly report for key insights",
+        },
+      ],
+      usageMetadata: {
+        traceId: "conv-28a7e9d4",
+        taskType: "document-analysis",
+        subscriberEmail: "user@example.com",
+        organizationId: "acme-corp",
+        subscriptionId: "premium-plan",
+      },
+    });
+
+    console.log(
+      "✅ Response:",
+      basicResponse.choices[0]?.message?.content?.substring(0, 100) + "..."
+    );
+
+    // Example 2: Advanced metadata
+    console.log("\n2️⃣ Advanced metadata tracking:");
+    const advancedResponse = await client.createChatCompletion({
+      model: "sonar-pro",
+      messages: [
+        {
+          role: "user",
+          content: "What are the latest developments in AI?",
+        },
+      ],
+      usageMetadata: {
+        traceId: "conv-advanced-123",
+        taskType: "research",
+        subscriberId: "user-12345",
+        subscriberCredentialName: "api-key-1",
+        productId: "business-intelligence",
+        agent: "research-assistant-v2",
+        responseQualityScore: 0.95,
+      },
+    });
+
+    console.log(
+      "✅ Response:",
+      advancedResponse.choices[0]?.message?.content?.substring(0, 100) + "..."
+    );
+
+    // Example 3: Streaming with metadata
+    console.log("\n3️⃣ Streaming with metadata:");
+    const stream = await client.createStreamingChatCompletion({
+      model: "sonar-pro",
+      messages: [
+        {
+          role: "user",
+          content: "Write a creative story about AI",
+        },
+      ],
+      usageMetadata: {
+        traceId: "conv-streaming-456",
+        taskType: "creative-writing",
+        organizationId: "creative-studio",
+        agent: "story-generator",
+      },
+    });
+
+    console.log("📝 Streaming response with metadata:");
+    for await (const chunk of stream) {
+      const content = chunk.choices[0]?.delta?.content;
+      if (content) {
+        process.stdout.write(content);
+      }
+    }
+
+    console.log("\n\n🎉 All metadata examples completed successfully!");
+    console.log("📊 All usage tracked with custom metadata");
+  } catch (error) {
+    console.error("❌ Error:", error);
+  }
+}
+
+metadataExample();

package/playground/multiple-models.js

@@ -1,62 +1,62 @@
-import { createPerplexityClient } from "@revenium/perplexity";
-
-async function multipleModelsExample() {
-  console.log("\n🔧 Perplexity AI - Multiple Models Example");
-  console.log("=".repeat(50));
-
-  try {
-    // Create client instance
-    const client = createPerplexityClient();
-
-    // Test different prompts with the same model
-    const testCases = [
-      {
-        name: "sonar-pro (Quantum Computing)",
-        description: "Latest and most capable model",
-        prompt: "Explain quantum computing in simple terms",
-      },
-      {
-        name: "sonar-pro (AI Developments)",
-        description: "Latest and most capable model",
-        prompt: "What are the latest developments in AI?",
-      },
-      {
-        name: "sonar-pro (Weather)",
-        description: "Latest and most capable model",
-        prompt: "What is the weather like today?",
-      },
-    ];
-
-    for (const testCase of testCases) {
-      console.log(`\n🤖 Testing: ${testCase.name}`);
-      console.log(`📝 Description: ${testCase.description}`);
-      console.log("-".repeat(40));
-
-      try {
-        const response = await client.createChatCompletion({
-          model: "sonar-pro",
-          messages: [
-            {
-              role: "user",
-              content: testCase.prompt,
-            },
-          ],
-        });
-
-        console.log("✅ Response:");
-        console.log(response.choices[0]?.message?.content?.substring(0, 200) + "...");
-        console.log("📊 Usage tracked by middleware");
-
-      } catch (error) {
-        console.log(`❌ Error with ${testCase.name}:`, error);
-      }
-    }
-
-    console.log("\n🎉 Multiple models example completed!");
-
-  } catch (error) {
-    console.error("❌ Error:", error);
-  }
-}
-
-multipleModelsExample();
+import { createPerplexityClient } from "@revenium/perplexity";
+
+async function multipleModelsExample() {
+  console.log("\n🔧 Perplexity AI - Multiple Models Example");
+  console.log("=".repeat(50));
+
+  try {
+    // Create client instance
+    const client = createPerplexityClient();
+
+    // Test different prompts with the same model
+    const testCases = [
+      {
+        name: "sonar-pro (Quantum Computing)",
+        description: "Latest and most capable model",
+        prompt: "Explain quantum computing in simple terms",
+      },
+      {
+        name: "sonar-pro (AI Developments)",
+        description: "Latest and most capable model",
+        prompt: "What are the latest developments in AI?",
+      },
+      {
+        name: "sonar-pro (Weather)",
+        description: "Latest and most capable model",
+        prompt: "What is the weather like today?",
+      },
+    ];
+
+    for (const testCase of testCases) {
+      console.log(`\n🤖 Testing: ${testCase.name}`);
+      console.log(`📝 Description: ${testCase.description}`);
+      console.log("-".repeat(40));
+
+      try {
+        const response = await client.createChatCompletion({
+          model: "sonar-pro",
+          messages: [
+            {
+              role: "user",
+              content: testCase.prompt,
+            },
+          ],
+        });
+
+        console.log("✅ Response:");
+        console.log(response.choices[0]?.message?.content?.substring(0, 200) + "...");
+        console.log("📊 Usage tracked by middleware");
+
+      } catch (error) {
+        console.log(`❌ Error with ${testCase.name}:`, error);
+      }
+    }
+
+    console.log("\n🎉 Multiple models example completed!");
+
+  } catch (error) {
+    console.error("❌ Error:", error);
+  }
+}
+
+multipleModelsExample();

package/playground/openai-client.js

@@ -1,73 +1,73 @@
-import { OpenAI } from "openai";
-
-// Import middleware to activate automatic tracking
-import "@revenium/perplexity";
-
-async function openaiClientExample() {
-  console.log("\n🤖 Perplexity AI - OpenAI Client Example");
-  console.log("=".repeat(50));
-
-  try {
-    // Create OpenAI client configured for Perplexity (like in basic example)
-    const client = new OpenAI({
-      apiKey: process.env.PERPLEXITY_API_KEY,
-      baseURL: "https://api.perplexity.ai",
-    });
-
-    console.log("✅ OpenAI client configured for Perplexity AI");
-    console.log("📊 Middleware automatically tracking all requests");
-
-    // Test different types of requests
-    console.log("\n1️⃣ Basic chat completion:");
-    const basicResponse = await client.chat.completions.create({
-      model: "sonar-pro",
-      messages: [
-        {
-          role: "user",
-          content: "What is the meaning of life, the universe and everything?",
-        },
-      ],
-    });
-    console.log("✅ Response:", basicResponse.choices[0]?.message?.content?.substring(0, 100) + "...");
-
-    console.log("\n2️⃣ Streaming chat completion:");
-    const stream = await client.chat.completions.create({
-      model: "sonar-pro",
-      messages: [
-        {
-          role: "user",
-          content: "Write a short poem about AI",
-        },
-      ],
-      stream: true,
-    });
-
-    console.log("📝 Streaming response:");
-    for await (const chunk of stream) {
-      const content = chunk.choices[0]?.delta?.content;
-      if (content) {
-        process.stdout.write(content);
-      }
-    }
-
-    console.log("\n\n3️⃣ Different prompt:");
-    const differentResponse = await client.chat.completions.create({
-      model: "sonar-pro",
-      messages: [
-        {
-          role: "user",
-          content: "Explain machine learning in one sentence",
-        },
-      ],
-    });
-    console.log("✅ Response:", differentResponse.choices[0]?.message?.content);
-
-    console.log("\n🎉 All examples completed successfully!");
-    console.log("📊 All usage automatically tracked by middleware");
-
-  } catch (error) {
-    console.error("❌ Error:", error);
-  }
-}
-
-openaiClientExample();
+import { OpenAI } from "openai";
+
+// Import middleware to activate automatic tracking
+import "@revenium/perplexity";
+
+async function openaiClientExample() {
+  console.log("\n🤖 Perplexity AI - OpenAI Client Example");
+  console.log("=".repeat(50));
+
+  try {
+    // Create OpenAI client configured for Perplexity (like in basic example)
+    const client = new OpenAI({
+      apiKey: process.env.PERPLEXITY_API_KEY,
+      baseURL: "https://api.perplexity.ai",
+    });
+
+    console.log("✅ OpenAI client configured for Perplexity AI");
+    console.log("📊 Middleware automatically tracking all requests");
+
+    // Test different types of requests
+    console.log("\n1️⃣ Basic chat completion:");
+    const basicResponse = await client.chat.completions.create({
+      model: "sonar-pro",
+      messages: [
+        {
+          role: "user",
+          content: "What is the meaning of life, the universe and everything?",
+        },
+      ],
+    });
+    console.log("✅ Response:", basicResponse.choices[0]?.message?.content?.substring(0, 100) + "...");
+
+    console.log("\n2️⃣ Streaming chat completion:");
+    const stream = await client.chat.completions.create({
+      model: "sonar-pro",
+      messages: [
+        {
+          role: "user",
+          content: "Write a short poem about AI",
+        },
+      ],
+      stream: true,
+    });
+
+    console.log("📝 Streaming response:");
+    for await (const chunk of stream) {
+      const content = chunk.choices[0]?.delta?.content;
+      if (content) {
+        process.stdout.write(content);
+      }
+    }
+
+    console.log("\n\n3️⃣ Different prompt:");
+    const differentResponse = await client.chat.completions.create({
+      model: "sonar-pro",
+      messages: [
+        {
+          role: "user",
+          content: "Explain machine learning in one sentence",
+        },
+      ],
+    });
+    console.log("✅ Response:", differentResponse.choices[0]?.message?.content);
+
+    console.log("\n🎉 All examples completed successfully!");
+    console.log("📊 All usage automatically tracked by middleware");
+
+  } catch (error) {
+    console.error("❌ Error:", error);
+  }
+}
+
+openaiClientExample();