@revenium/perplexity 1.0.15 → 1.0.17

package/README.md

@@ -69,29 +69,32 @@ Create `test-perplexity.js`:
 
 ```javascript
 // test-perplexity.js
-import { createPerplexityClient } from "@revenium/perplexity";
+import { PerplexityReveniumMiddleware } from "@revenium/perplexity";
 
-const client = createPerplexityClient();
+const basicExample = async () => {
+  try {
+    const middleware = new PerplexityReveniumMiddleware();
+    const model = middleware.getGenerativeModel("sonar-pro");
+    const result = await model.createChatCompletion({
+      messages: [
+        {
+          role: "user",
+          content: "What is the universe?",
+        },
+      ],
+    });
+
+    const text = result.choices[0]?.message?.content;
+    console.log("*** RESPONSE ***");
+    console.log(text);
+    console.log("✅ Basic Perplexity AI example successful!");
+  } catch (error) {
+    console.error("❌ Perplexity basic example failed:", error);
+    process.exit(1);
+  }
+};
 
-try {
-  const result = await client.createChatCompletion({
-    model: "sonar-pro",
-    messages: [
-      {
-        role: "user",
-        content: "What is the universe?",
-      },
-    ],
-  });
-
-  const text = result.choices[0]?.message?.content;
-  console.log("*** RESPONSE ***");
-  console.log(text);
-  console.log("✅ Basic Perplexity AI example successful!");
-} catch (error) {
-  console.error("❌ Perplexity basic example failed:", error);
-  process.exit(1);
-}
+basicExample();
 ```
 
 ### Step 5: Update package.json
@@ -147,38 +150,89 @@ Create `examples/streaming-perplexity.js`:
 
 ```javascript
 // examples/streaming-perplexity.js
-import { createPerplexityClient } from "@revenium/perplexity";
+import { PerplexityReveniumMiddleware } from "@revenium/perplexity";
 
-const client = createPerplexityClient();
+const streamingExample = async () => {
+  try {
+    const middleware = new PerplexityReveniumMiddleware();
+    const model = middleware.getGenerativeModel("sonar-pro");
+    const stream = await model.createChatCompletionStream({
+      messages: [
+        {
+          role: "user",
+          content: "What is artificial intelligence?",
+        },
+      ],
+    });
+
+    console.log("*** STREAMING RESPONSE ***");
+    let fullText = "";
+
+    for await (const chunk of stream) {
+      const content = chunk.choices[0]?.delta?.content;
+      if (content) {
+        process.stdout.write(content);
+        fullText += content;
+      }
+    }
 
-try {
-  const stream = await client.createStreamingChatCompletion({
-    model: "sonar-pro",
-    messages: [
-      {
-        role: "user",
-        content: "What is artificial intelligence?",
-      },
-    ],
-  });
+    console.log("\n✅ Streaming with metering successful!");
+    console.log(`📊 Total response length: ${fullText.length} characters`);
+  } catch (error) {
+    console.error("❌ Perplexity streaming example failed:", error);
+    process.exit(1);
+  }
+};
 
-  console.log("*** STREAMING RESPONSE ***");
-  let fullText = "";
+streamingExample();
+```
 
-  for await (const chunk of stream) {
-    const content = chunk.choices[0]?.delta?.content;
-    if (content) {
-      process.stdout.write(content);
-      fullText += content;
-    }
+#### Metadata Example
+
+Create `examples/metadata-perplexity.js`:
+
+```javascript
+// examples/metadata-perplexity.js
+import { PerplexityReveniumMiddleware } from "@revenium/perplexity";
+
+const metadataExample = async () => {
+  try {
+    const middleware = new PerplexityReveniumMiddleware();
+    const model = middleware.getGenerativeModel("sonar-pro");
+    const result = await model.createChatCompletion({
+      messages: [
+        {
+          role: "user",
+          content: "Analyze this quarterly report",
+        },
+      ],
+      usageMetadata: {
+        // User tracking
+        traceId: "conv-28a7e9d4",
+        taskType: "document-analysis",
+        subscriberEmail: "user@example.com",
+        subscriberId: "user-123",
+        subscriberCredentialName: "api-key-1",
+
+        // Business context
+        organizationId: "acme-corp",
+        subscriptionId: "premium-plan",
+        productId: "business-intelligence",
+        agent: "analysis-assistant",
+        responseQualityScore: 0.95,
+      },
+    });
+
+    console.log("*** METADATA RESPONSE ***");
+    console.log("Response:", result.choices[0]?.message?.content);
+    console.log("✅ Metadata tracking with metering successful!");
+  } catch (error) {
+    console.error("❌ Perplexity metadata example failed:", error);
+    process.exit(1);
   }
+};
 
-  console.log("\n✅ Streaming with metering successful!");
-  console.log(`📊 Total response length: ${fullText.length} characters`);
-} catch (error) {
-  console.error("❌ Perplexity streaming example failed:", error);
-  process.exit(1);
-}
+metadataExample();
 ```
 
 ### Step 8: Update package.json
@@ -190,7 +244,8 @@ try {
   "type": "module",
   "scripts": {
     "test-perplexity": "node test-perplexity.js",
-    "test-perplexity-stream": "node examples/streaming-perplexity.js"
+    "test-perplexity-stream": "node examples/streaming-perplexity.js",
+    "test-perplexity-metadata": "node examples/metadata-perplexity.js"
   },
   "dependencies": {
     "@revenium/perplexity": "^1.0.0"
@@ -204,6 +259,8 @@ try {
 # Test streaming
 npm run test-perplexity-stream
 
+# Test metadata
+npm run test-perplexity-metadata
 ```
 
 ---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revenium/perplexity",
-  "version": "1.0.15",
+  "version": "1.0.17",
   "description": "NodeJS middleware for perplexity's AI API",
   "homepage": "https://github.com/revenium/revenium-middleware-perplexity-node#readme",
   "bugs": {
@@ -35,9 +35,8 @@
   ],
   "author": "",
   "license": "ISC",
-  "type": "module",
+  "type": "commonjs",
   "dependencies": {
-    "@revenium/perplexity": "^1.0.14",
     "dotenv": "^17.2.2",
     "openai": "^5.23.1",
     "ts-node": "^10.9.2",

package/src/middleware.ts

@@ -1,4 +1,4 @@
-import OpenAI, { APIPromise } from "openai";
+import OpenAI from "openai";
 import {
   models,
   PERPLEXITY_API_BASE_URL,