@revenium/perplexity 2.0.2 → 2.0.4

package/examples/basic.ts

@@ -0,0 +1,50 @@
+/**
+ * Basic Chat Completion Example
+ *
+ * This example demonstrates how to use the Perplexity middleware
+ * to create a simple chat completion with Revenium metering.
+ */
+
+import {
+  initializeReveniumFromEnv,
+  initializePerplexityFromEnv,
+  createChatCompletion,
+  UsageMetadata,
+} from "../src";
+
+async function main() {
+  // Initialize configurations from environment variables
+  initializeReveniumFromEnv();
+  initializePerplexityFromEnv();
+
+  // Create a simple chat completion with basic metadata
+  const usageMetadata: UsageMetadata = {
+    subscriber: { id: "user-123" },
+    traceId: "session-abc",
+  };
+
+  const result = await createChatCompletion({
+    messages: [
+      {
+        role: "user",
+        content: "What is the capital of France? Answer in one sentence.",
+      },
+    ],
+    model: "sonar-pro",
+    maxTokens: 100,
+    usageMetadata,
+  });
+
+  // Display essential results
+  console.log("\n✓ Chat Completion Successful");
+  console.log(`Response: ${result.content}`);
+  console.log(`Model: ${result.model}`);
+  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

@@ -0,0 +1,73 @@
+/**
+ * Multi-turn Chat Example
+ *
+ * This example demonstrates how to have a multi-turn conversation
+ * with the Perplexity middleware.
+ */
+
+import {
+  initializeReveniumFromEnv,
+  initializePerplexityFromEnv,
+  createChatCompletion,
+  type PerplexityMessage,
+} from "../src";
+
+async function main() {
+  // Initialize configurations from environment variables
+  initializeReveniumFromEnv();
+  initializePerplexityFromEnv();
+
+  // Start a conversation
+  const messages: PerplexityMessage[] = [
+    {
+      role: "system",
+      content: "You are a helpful assistant that provides concise answers.",
+    },
+    {
+      role: "user",
+      content: "What is the capital of France?",
+    },
+  ];
+
+  console.log("\n--- Turn 1 ---");
+  console.log("User: What is the capital of France?");
+
+  const response1 = await createChatCompletion({
+    messages,
+    model: "sonar",
+    maxTokens: 100,
+  });
+
+  console.log(`Assistant: ${response1.content}`);
+
+  // Continue the conversation
+  messages.push({
+    role: "assistant",
+    content: response1.content,
+  });
+
+  messages.push({
+    role: "user",
+    content: "What is its population?",
+  });
+
+  console.log("\n--- Turn 2 ---");
+  console.log("User: What is its population?");
+
+  const response2 = await createChatCompletion({
+    messages,
+    model: "sonar-pro",
+    maxTokens: 500,
+  });
+
+  console.log(`Assistant: ${response2.content}`);
+
+  // 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

@@ -0,0 +1,65 @@
+/**
+ * Custom Metadata Example
+ *
+ * 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,
+  UsageMetadata,
+} from "../src";
+
+async function main() {
+  // Initialize configurations from environment variables
+  initializeReveniumFromEnv();
+  initializePerplexityFromEnv();
+
+  // 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: [
+      {
+        role: "user",
+        content: "What is 2 + 2?",
+      },
+    ],
+    model: "sonar-pro",
+    maxTokens: 200,
+    usageMetadata,
+  });
+
+  console.log("\n✓ Chat Completion Successful");
+  console.log(`Response: ${result.content}`);
+  console.log(`Model: ${result.model}`);
+  console.log(
+    `Tokens Used: ${result.usage.totalTokens} (prompt: ${result.usage.promptTokens}, completion: ${result.usage.completionTokens})`
+  );
+  console.log(
+    "Metadata tracked: subscriber, organization, product, agent, trace"
+  );
+}
+
+main().catch((error) => {
+  console.error("Error:", error.message);
+  process.exit(1);
+});

package/examples/streaming.ts

@@ -0,0 +1,50 @@
+/**
+ * Streaming Chat Completion Example
+ *
+ * This example demonstrates how to use streaming responses
+ * with the Perplexity middleware and Revenium metering.
+ */
+
+import {
+  initializeReveniumFromEnv,
+  initializePerplexityFromEnv,
+  createStreamingChatCompletion,
+} from "../src";
+
+async function main() {
+  // Initialize configurations from environment variables
+  initializeReveniumFromEnv();
+  initializePerplexityFromEnv();
+
+  // Create a streaming chat completion
+  const result = await createStreamingChatCompletion({
+    messages: [
+      {
+        role: "user",
+        content: "Count from 1 to 5 slowly, one number per line.",
+      },
+    ],
+    model: "sonar-pro",
+    maxTokens: 200,
+  });
+
+  console.log(`\nModel: ${result.model}`);
+  console.log("Streaming response:\n");
+
+  // Process the stream
+  let fullContent = "";
+  for await (const chunk of result.stream) {
+    const content = chunk.choices[0]?.delta?.content || "";
+    if (content) {
+      process.stdout.write(content);
+      fullContent += content;
+    }
+  }
+
+  console.log("\n\n✓ Streaming completed");
+}
+
+main().catch((error) => {
+  console.error("Error:", error.message);
+  process.exit(1);
+});

package/package.json

@@ -1,69 +1,72 @@
-{
-  "name": "@revenium/perplexity",
-  "version": "2.0.2",
-  "description": "NodeJS middleware for Perplexity AI API with Revenium metering",
-  "homepage": "https://github.com/revenium/revenium-middleware-perplexity-node#readme",
-  "bugs": {
-    "url": "https://github.com/revenium/revenium-middleware-perplexity-node/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/revenium/revenium-middleware-perplexity-node.git"
-  },
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "types": "dist/types/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js",
-      "types": "./dist/types/index.d.ts"
-    }
-  },
-  "files": [
-    "dist/**/*",
-    "README.md",
-    "LICENSE"
-  ],
-  "scripts": {
-    "clean": "if exist dist rmdir /s /q dist",
-    "build:esm": "tsc -p tsconfig.esm.json",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
-    "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"
-  },
-  "keywords": [
-    "revenium",
-    "middleware",
-    "perplexity",
-    "ai",
-    "chat",
-    "completion",
-    "metering",
-    "monitoring",
-    "typescript"
-  ],
-  "author": "",
-  "license": "ISC",
-  "type": "commonjs",
-  "dependencies": {
-    "dotenv": "^17.2.2",
-    "openai": "^5.23.1",
-    "tsx": "^4.19.2",
-    "typescript": "^5.9.2",
-    "uuid": "^13.0.0"
-  },
-  "devDependencies": {
-    "@types/node": "^24.7.1"
-  }
-}
+{
+  "name": "@revenium/perplexity",
+  "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": {
+    "url": "https://github.com/revenium/revenium-middleware-perplexity-node/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/revenium/revenium-middleware-perplexity-node.git"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "files": [
+    "dist/",
+    "examples/",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "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",
+    "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",
+    "middleware",
+    "perplexity",
+    "ai",
+    "chat",
+    "completion",
+    "metering",
+    "monitoring",
+    "typescript"
+  ],
+  "author": "Revenium",
+  "license": "MIT",
+  "type": "commonjs",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "dependencies": {
+    "dotenv": "^17.2.2",
+    "openai": "^5.23.1",
+    "tsx": "^4.19.2",
+    "typescript": "^5.9.2",
+    "uuid": "^13.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.7.1"
+  }
+}