@revenium/perplexity 2.0.4 → 2.0.6

package/examples/basic.ts

@@ -1,50 +1,45 @@
-/**
- * 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);
-});
+/**
+ * Basic Example
+ * Demonstrates basic usage of Revenium Perplexity middleware.
+ */
+
+import { Initialize, GetClient, UsageMetadata } from "@revenium/perplexity";
+
+async function main() {
+  // Initialize middleware
+  Initialize();
+
+  // Get client
+  const client = GetClient();
+  const metadata: UsageMetadata = {
+    organizationId: "org-basic-demo",
+    productId: "prod-perplexity-basic",
+  };
+
+  // Create chat completion
+  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
+    );
+
+  // 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(console.error);

package/examples/getting_started.ts

@@ -1,64 +1,41 @@
-/**
- * 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);
+/**
+ * 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,65 +1,68 @@
-/**
- * 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);
-});
+/**
+ * Metadata Example
+ * Demonstrates advanced metadata usage with Revenium Perplexity middleware.
+ */
+
+import { Initialize, GetClient, UsageMetadata } from "@revenium/perplexity";
+
+async function main() {
+  // Initialize middleware
+  Initialize();
+
+  // Get client
+  const client = GetClient();
+
+  // 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",
+      },
+    },
+  };
+
+  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
+    );
+
+  // 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(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,72 +1,72 @@
-{
-  "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"
-  }
-}
+{
+  "name": "@revenium/perplexity",
+  "version": "2.0.6",
+  "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",
+    "SECURITY.md"
+  ],
+  "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 build:esm && npm run build:cjs && npm run build:types",
+    "prepublishOnly": "npm run build",
+    "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",
+    "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"
+  }
+}

package/dist/cjs/constants.js

@@ -1,70 +0,0 @@
-"use strict";
-/**
- * Configuration constants for Revenium Perplexity middleware
- * Centralizes all magic numbers and default values
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.API_ENDPOINTS = exports.DEFAULT_CONFIG = exports.PERPLEXITY_PATTERNS = exports.MIDDLEWARE_INFO = void 0;
-/**
- * Middleware identification
- *
- * Per Revenium API spec (https://revenium.readme.io/reference/meter_ai_completion):
- * "middlewareSource: Identifier of the Revenium middleware package or SDK that
- * captured and submitted this AI completion metadata. This field is AUTOMATICALLY
- * SET by Revenium's middleware packages (e.g., 'revenium-openai-python',
- * 'revenium-anthropic-node')."
- */
-exports.MIDDLEWARE_INFO = {
-    /** Package name */
-    NAME: "@revenium/perplexity",
-    /** Package version */
-    VERSION: "2.0.4",
-    /** Full middleware source identifier for API tracking */
-    SOURCE: "@revenium/perplexity-2.0.4",
-};
-/**
- * Perplexity model patterns and API response mappings
- *
- * Per Revenium API spec (https://revenium.readme.io/reference/meter_ai_completion):
- * stopReason enum: "END", "END_SEQUENCE", "TIMEOUT", "TOKEN_LIMIT",
- * "COST_LIMIT", "COMPLETION_LIMIT", "ERROR", "CANCELLED"
- *
- * We map Perplexity's finish_reason values to these Revenium enums.
- * Only provider-reported values are mapped; middleware-level values
- * (TIMEOUT, COST_LIMIT, etc.) are not applicable to provider responses.
- */
-exports.PERPLEXITY_PATTERNS = {
-    /** Known Perplexity/OpenAI finish reasons */
-    FINISH_REASONS: {
-        STOP: "stop",
-        LENGTH: "length",
-        TOOL_CALLS: "tool_calls",
-        CONTENT_FILTER: "content_filter",
-        FUNCTION_CALL: "function_call",
-    },
-    /** Revenium stop reason mappings from Perplexity finish_reason to Revenium enum */
-    REVENIUM_STOP_REASON_MAP: {
-        stop: "END",
-        length: "TOKEN_LIMIT",
-        tool_calls: "END",
-        content_filter: "END",
-        function_call: "END",
-    },
-};
-/**
- * Default configuration values
- */
-exports.DEFAULT_CONFIG = {
-    /** Default Revenium API base URL */
-    REVENIUM_BASE_URL: "https://api.revenium.ai",
-    /** Default Perplexity API base URL */
-    PERPLEXITY_BASE_URL: "https://api.perplexity.ai",
-};
-/**
- * API endpoints
- */
-exports.API_ENDPOINTS = {
-    /** Revenium AI completions endpoint */
-    AI_COMPLETIONS: "/meter/v2/ai/completions",
-};
-//# sourceMappingURL=constants.js.map

package/dist/cjs/constants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;;;;;;;GAQG;AACU,QAAA,eAAe,GAAG;IAC7B,mBAAmB;IACnB,IAAI,EAAE,sBAAsB;IAC5B,sBAAsB;IACtB,OAAO,EAAE,OAAO;IAChB,yDAAyD;IACzD,MAAM,EAAE,4BAA4B;CAC5B,CAAC;AAEX;;;;;;;;;;GAUG;AACU,QAAA,mBAAmB,GAAG;IACjC,6CAA6C;IAC7C,cAAc,EAAE;QACd,IAAI,EAAE,MAAM;QACZ,MAAM,EAAE,QAAQ;QAChB,UAAU,EAAE,YAAY;QACxB,cAAc,EAAE,gBAAgB;QAChC,aAAa,EAAE,eAAe;KACtB;IAEV,mFAAmF;IACnF,wBAAwB,EAAE;QACxB,IAAI,EAAE,KAAK;QACX,MAAM,EAAE,aAAa;QACrB,UAAU,EAAE,KAAK;QACjB,cAAc,EAAE,KAAK;QACrB,aAAa,EAAE,KAAK;KACZ;CACF,CAAC;AAEX;;GAEG;AACU,QAAA,cAAc,GAAG;IAC5B,oCAAoC;IACpC,iBAAiB,EAAE,yBAAyB;IAE5C,sCAAsC;IACtC,mBAAmB,EAAE,2BAA2B;CACxC,CAAC;AAEX;;GAEG;AACU,QAAA,aAAa,GAAG;IAC3B,uCAAuC;IACvC,cAAc,EAAE,0BAA0B;CAClC,CAAC"}

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/perplexity-config.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"perplexity-config.js","sourceRoot":"","sources":["../../../../src/core/config/perplexity-config.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AAcH,kEAkBC;AAKD,oDAWC;AAKD,kDAEC;AArDD,+CAA4C;AAO5C,IAAI,gBAAgB,GAA4B,IAAI,CAAC;AAErD;;GAEG;AACH,SAAgB,2BAA2B;IACzC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;IAC9C,MAAM,OAAO,GACX,OAAO,CAAC,GAAG,CAAC,uBAAuB,IAAI,2BAA2B,CAAC;IAErE,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAC;IACJ,CAAC;IAED,gBAAgB,GAAG;QACjB,MAAM;QACN,OAAO;KACR,CAAC;IAEF,eAAM,CAAC,IAAI,CAAC,mDAAmD,CAAC,CAAC;IACjE,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,SAAgB,oBAAoB,CAAC,MAGpC;IACC,gBAAgB,GAAG;QACjB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,2BAA2B;KACvD,CAAC;IAEF,eAAM,CAAC,IAAI,CAAC,yDAAyD,CAAC,CAAC;IACvE,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,SAAgB,mBAAmB;IACjC,OAAO,gBAAgB,CAAC;AAC1B,CAAC"}