@revenium/perplexity 2.0.3 → 2.0.4

package/examples/basic.ts

@@ -1,6 +1,6 @@
 /**
  * Basic Chat Completion Example
- * 
+ *
  * This example demonstrates how to use the Perplexity middleware
  * to create a simple chat completion with Revenium metering.
  */
@@ -9,20 +9,20 @@ import {
   initializeReveniumFromEnv,
   initializePerplexityFromEnv,
   createChatCompletion,
-  PERPLEXITY_MODELS,
+  UsageMetadata,
 } from "../src";
 
 async function main() {
-  console.log("Basic Chat Completion Example\n");
-
   // Initialize configurations from environment variables
-  console.log("Initializing configurations...");
   initializeReveniumFromEnv();
   initializePerplexityFromEnv();
-  console.log("Configurations initialized\n");
 
-  // Create a simple chat completion
-  console.log("Creating chat completion...");
+  // Create a simple chat completion with basic metadata
+  const usageMetadata: UsageMetadata = {
+    subscriber: { id: "user-123" },
+    traceId: "session-abc",
+  };
+
   const result = await createChatCompletion({
     messages: [
       {
@@ -30,26 +30,21 @@ async function main() {
         content: "What is the capital of France? Answer in one sentence.",
       },
     ],
-    model: PERPLEXITY_MODELS.SONAR_PRO,
+    model: "sonar-pro",
     maxTokens: 100,
+    usageMetadata,
   });
 
-  console.log("\nResponse:");
-  console.log("─────────────────────────────────────────");
-  console.log(`Content: ${result.content}`);
+  // Display essential results
+  console.log("\n✓ Chat Completion Successful");
+  console.log(`Response: ${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("─────────────────────────────────────────\n");
-
-  console.log("Example completed successfully!");
+  console.log(
+    `Tokens Used: ${result.usage.totalTokens} (prompt: ${result.usage.promptTokens}, completion: ${result.usage.completionTokens})`
+  );
 }
 
 main().catch((error) => {
   console.error("Error:", error.message);
   process.exit(1);
 });
-

package/examples/chat.ts

@@ -1,6 +1,6 @@
 /**
  * Multi-turn Chat Example
- * 
+ *
  * This example demonstrates how to have a multi-turn conversation
  * with the Perplexity middleware.
  */
@@ -9,18 +9,13 @@ import {
   initializeReveniumFromEnv,
   initializePerplexityFromEnv,
   createChatCompletion,
-  PERPLEXITY_MODELS,
   type PerplexityMessage,
 } from "../src";
 
 async function main() {
-  console.log("Multi-turn Chat Example\n");
-
   // Initialize configurations from environment variables
-  console.log("Initializing configurations...");
   initializeReveniumFromEnv();
   initializePerplexityFromEnv();
-  console.log("Configurations initialized\n");
 
   // Start a conversation
   const messages: PerplexityMessage[] = [
@@ -34,16 +29,16 @@ async function main() {
     },
   ];
 
-  console.log("Turn 1:");
+  console.log("\n--- Turn 1 ---");
   console.log("User: What is the capital of France?");
 
   const response1 = await createChatCompletion({
     messages,
-    model: PERPLEXITY_MODELS.SONAR_PRO,
+    model: "sonar",
     maxTokens: 100,
   });
 
-  console.log(`Assistant: ${response1.content}\n`);
+  console.log(`Assistant: ${response1.content}`);
 
   // Continue the conversation
   messages.push({
@@ -56,32 +51,23 @@ async function main() {
     content: "What is its population?",
   });
 
-  console.log("Turn 2:");
+  console.log("\n--- Turn 2 ---");
   console.log("User: What is its population?");
 
   const response2 = await createChatCompletion({
     messages,
-    model: PERPLEXITY_MODELS.SONAR_PRO,
-    maxTokens: 100,
+    model: "sonar-pro",
+    maxTokens: 500,
   });
 
-  console.log(`Assistant: ${response2.content}\n`);
+  console.log(`Assistant: ${response2.content}`);
 
-  console.log("Summary:");
-  console.log("─────────────────────────────────────────");
-  console.log(`Total turns: 2`);
-  console.log(`Transaction ID 1: ${response1.transactionId}`);
-  console.log(`Transaction ID 2: ${response2.transactionId}`);
-  console.log(
-    `Total tokens used: ${response1.usage.totalTokens + response2.usage.totalTokens}`
-  );
-  console.log("─────────────────────────────────────────\n");
-
-  console.log("Chat completed successfully!");
+  // Summary
+  const totalTokens = response1.usage.totalTokens + response2.usage.totalTokens;
+  console.log(`\n✓ Chat completed - Total tokens used: ${totalTokens}`);
 }
 
 main().catch((error) => {
   console.error("Error:", error.message);
   process.exit(1);
 });
-

package/examples/getting_started.ts

@@ -0,0 +1,64 @@
+/**
+ * Getting Started with Revenium Perplexity Middleware
+ *
+ * This is the simplest possible entry point for new users.
+ * Shows basic usage with all metadata options documented.
+ */
+
+import {
+  initializeReveniumFromEnv,
+  initializePerplexityFromEnv,
+  createChatCompletion,
+} from "../src";
+
+async function main() {
+  // Initialize from environment variables (.env file)
+  initializeReveniumFromEnv();
+  initializePerplexityFromEnv();
+
+  // Create a simple chat completion
+  const result = await createChatCompletion({
+    messages: [
+      {
+        role: "user",
+        content: "What is artificial intelligence?",
+      },
+    ],
+    model: "sonar-pro",
+    maxTokens: 500,
+
+    /* Optional: Add metadata for advanced tracking and analytics
+    usageMetadata: {
+      // User identification
+      subscriber: {
+        id: 'user-123',
+        email: 'user@example.com',
+        credential: {
+          name: 'api-key-prod',
+          value: 'key-abc-123'
+        }
+      },
+
+      // Organization & billing
+      organizationId: 'my-customers-name',
+      subscriptionId: 'plan-enterprise-2024',
+
+      // Product & task tracking
+      productId: 'my-product',
+      taskType: 'qa',
+      agent: 'customer-support',
+
+      // Session tracking
+      traceId: 'session-' + Date.now(),
+
+      // Quality metrics
+      responseQualityScore: 0.95
+    }
+    */
+  });
+
+  console.log("Response:", result.content);
+  console.log("\nUsage:", result.usage);
+}
+
+main().catch(console.error);

package/examples/metadata.ts

@@ -1,28 +1,41 @@
 /**
  * Custom Metadata Example
- * 
- * This example demonstrates how to pass custom metadata
- * for tracking and metering purposes.
+ *
+ * This example demonstrates how to pass comprehensive metadata
+ * for enhanced tracking, analytics, and metering purposes.
+ *
+ * For complete metadata options and details, see:
+ * https://revenium.readme.io/reference/meter_ai_completion
  */
 
 import {
   initializeReveniumFromEnv,
   initializePerplexityFromEnv,
   createChatCompletion,
-  PERPLEXITY_MODELS,
+  UsageMetadata,
 } from "../src";
 
 async function main() {
-  console.log("Custom Metadata Example\n");
-
   // Initialize configurations from environment variables
-  console.log("Initializing configurations...");
-  const reveniumConfig = initializeReveniumFromEnv();
+  initializeReveniumFromEnv();
   initializePerplexityFromEnv();
-  console.log("Configurations initialized\n");
 
-  // Create a chat completion with custom metadata
-  console.log("Creating chat completion with custom metadata...");
+  // Create a chat completion with comprehensive metadata
+  const usageMetadata: UsageMetadata = {
+    subscriber: {
+      id: "user-123",
+      email: "metadata-user@example.com",
+      credential: {
+        name: "api-key",
+        value: "key-premium-abc123",
+      },
+    },
+    organizationId: "org-example",
+    productId: "product-premium",
+    agent: "calculator-bot-v1",
+    traceId: "trace-abc-123",
+  };
+
   const result = await createChatCompletion({
     messages: [
       {
@@ -30,38 +43,19 @@ async function main() {
         content: "What is 2 + 2?",
       },
     ],
-    model: PERPLEXITY_MODELS.SONAR_PRO,
-    maxTokens: 50,
-    usageMetadata: {
-      subscriber: {
-        id: "user-123",
-        email: "user@example.com",
-      },
-      organizationId: "org-example",
-      productId: "product-premium",
-      traceId: "trace-abc-123",
-    },
+    model: "sonar-pro",
+    maxTokens: 200,
+    usageMetadata,
   });
 
-  console.log("\nResponse:");
-  console.log("─────────────────────────────────────────");
-  console.log(`Content: ${result.content}`);
+  console.log("\n✓ Chat Completion Successful");
+  console.log(`Response: ${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");
-
-  console.log("Example completed successfully!");
   console.log(
-    "Check your Revenium dashboard to see the metering data with custom metadata."
+    `Tokens Used: ${result.usage.totalTokens} (prompt: ${result.usage.promptTokens}, completion: ${result.usage.completionTokens})`
+  );
+  console.log(
+    "Metadata tracked: subscriber, organization, product, agent, trace"
   );
 }
 
@@ -69,4 +63,3 @@ main().catch((error) => {
   console.error("Error:", error.message);
   process.exit(1);
 });
-

package/examples/streaming.ts

@@ -1,6 +1,6 @@
 /**
  * Streaming Chat Completion Example
- * 
+ *
  * This example demonstrates how to use streaming responses
  * with the Perplexity middleware and Revenium metering.
  */
@@ -9,20 +9,14 @@ import {
   initializeReveniumFromEnv,
   initializePerplexityFromEnv,
   createStreamingChatCompletion,
-  PERPLEXITY_MODELS,
 } from "../src";
 
 async function main() {
-  console.log("Streaming Chat Completion Example\n");
-
   // Initialize configurations from environment variables
-  console.log("Initializing configurations...");
   initializeReveniumFromEnv();
   initializePerplexityFromEnv();
-  console.log("Configurations initialized\n");
 
   // Create a streaming chat completion
-  console.log("Creating streaming chat completion...");
   const result = await createStreamingChatCompletion({
     messages: [
       {
@@ -30,14 +24,12 @@ async function main() {
         content: "Count from 1 to 5 slowly, one number per line.",
       },
     ],
-    model: PERPLEXITY_MODELS.SONAR_PRO,
-    maxTokens: 100,
+    model: "sonar-pro",
+    maxTokens: 200,
   });
 
-  console.log("\nStreaming Response:");
-  console.log("─────────────────────────────────────────");
-  console.log(`Transaction ID: ${result.transactionId}`);
-  console.log(`Model: ${result.model}\n`);
+  console.log(`\nModel: ${result.model}`);
+  console.log("Streaming response:\n");
 
   // Process the stream
   let fullContent = "";
@@ -49,13 +41,10 @@ async function main() {
     }
   }
 
-  console.log("\n─────────────────────────────────────────");
-  console.log(`\nFull Response: ${fullContent}`);
-  console.log("\nStreaming completed successfully!");
+  console.log("\n\n✓ Streaming completed");
 }
 
 main().catch((error) => {
   console.error("Error:", error.message);
   process.exit(1);
 });
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revenium/perplexity",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "NodeJS middleware for Perplexity AI API with Revenium metering",
   "homepage": "https://github.com/revenium/revenium-middleware-perplexity-node#readme",
   "bugs": {
@@ -21,10 +21,8 @@
     }
   },
   "files": [
-    "dist/cjs/**/*.js",
-    "dist/esm/**/*.js",
-    "dist/types/**/*.d.ts",
-    "examples/**/*",
+    "dist/",
+    "examples/",
     "README.md",
     "CHANGELOG.md",
     "LICENSE"
@@ -36,15 +34,13 @@
     "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:getting-started": "tsx examples/getting_started.ts",
     "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:advanced": "tsx examples/advanced-features.ts",
+    "test": "npm run example:getting-started && npm run example:basic && npm run example:streaming && npm run example:chat && npm run example:metadata && npm run example:advanced"
   },
   "keywords": [
     "revenium",
@@ -61,7 +57,7 @@
   "license": "MIT",
   "type": "commonjs",
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=20.0.0"
   },
   "dependencies": {
     "dotenv": "^17.2.2",