@revenium/perplexity 1.0.10 → 1.0.14

package/examples/basic.ts

@@ -0,0 +1,17 @@
+import { PerplexityReveniumMiddleware } from "../src";
+
+async function basicRequest() {
+  console.log("=".repeat(50));
+  try {
+    const middleware = new PerplexityReveniumMiddleware();
+    const model = middleware.getGenerativeModel("sonar-pro");
+    const result = await model.createChatCompletion({
+      model: "sonar-pro",
+      messages: [{ role: "user", content: "What is the capital of France?" }],
+    });
+    console.log("[BASIC REQUEST]", result.choices[0].message);
+  } catch (error) {
+    console.log(error);
+  }
+}
+basicRequest();

package/examples/chat-completions.ts

@@ -0,0 +1,22 @@
+import { PerplexityReveniumMiddleware } from "../src";
+
+const chatCompletionsExample = async () => {
+  console.log("=".repeat(50));
+  try {
+    const middleware = new PerplexityReveniumMiddleware();
+    const model = middleware.getGenerativeModel("sonar-pro");
+    const result = await model.createChatCompletion({
+      messages: [
+        {
+          role: "user",
+          content: "Hello world",
+        },
+      ],
+    });
+    console.log(result.choices[0].message.content);
+  } catch (error) {
+    console.log(error);
+  }
+};
+
+chatCompletionsExample();

package/examples/enhanced.ts

@@ -0,0 +1,20 @@
+import { PerplexityReveniumMiddleware } from "../src";
+
+async function enhancedRequest() {
+  console.log("=".repeat(50));
+  try {
+    const middleware = new PerplexityReveniumMiddleware();
+    const model = middleware.getGenerativeModel("sonar-pro");
+    const result = await model.createChatCompletion({
+      messages: [
+        { role: "user", content: "Explain quantum computing in simple terms" },
+      ],
+      max_tokens: 100,
+      temperature: 0.7,
+    });
+    console.log("[ENHANCED REQUEST]", result.choices[0].message.content);
+  } catch (error) {
+    console.log(error);
+  }
+}
+enhancedRequest();

package/examples/streaming.ts

@@ -0,0 +1,24 @@
+import { PerplexityReveniumMiddleware } from "../src";
+
+const chatCompletionStreamingExample = async () => {
+  console.log("=".repeat(50));
+  try {
+    const middleware = new PerplexityReveniumMiddleware();
+    const model = middleware.getGenerativeModel("sonar-pro");
+    const result = await model.createChatCompletionStream({
+      messages: [
+        {
+          role: "user",
+          content: "Hello world",
+        },
+      ],
+    });
+    for await (const chunk of result) {
+      process.stdout.write(chunk.choices[0]?.delta?.content || "");
+    }
+  } catch (error) {
+    console.log(error);
+  }
+};
+
+chatCompletionStreamingExample();

package/package.json

@@ -1,61 +1,45 @@
-{
-  "name": "@revenium/perplexity",
-  "version": "1.0.10",
-  "description": "NodeJS middleware for perplexity's AI API",
-  "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"
-  },
-  "license": "ISC",
-  "author": "",
-  "type": "commonjs",
-  "main": "dist/index.js",
-  "scripts": {
-    "build": "tsc",
-    "dev": "tsc --watch",
-    "clean": "rimraf dist",
-    "prebuild": "npm run clean",
-    "simple-test": "npx ts-node examples/simple-test.ts",
-    "perplexity-basic-example": "npx ts-node examples/perplexity_basic_example.ts",
-    "perplexity-middleware-example": "npx ts-node examples/perplexity_middleware_example.ts",
-    "basic-client-example": "npx ts-node examples/basic-client-example.ts",
-    "streaming-example": "npx ts-node examples/streaming-example.ts",
-    "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",
-    "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",
-    "middleware",
-    "perplexity",
-    "ai",
-    "chat",
-    "completion",
-    "metering",
-    "monitoring",
-    "typescript"
-  ],
-  "dependencies": {
-    "axios": "^1.11.0",
-    "dotenv": "^17.2.1",
-    "openai": "^5.15.0",
-    "uuid": "^11.1.0"
-  },
-  "devDependencies": {
-    "@types/node": "^24.3.0",
-    "rimraf": "^6.0.1",
-    "typescript": "^5.9.2"
-  }
-}
+{
+  "name": "@revenium/perplexity",
+  "version": "1.0.14",
+  "description": "NodeJS middleware for perplexity's AI API",
+  "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": "index.js",
+  "scripts": {
+    "build": "tsc",
+    "p-basic": "npx ts-node playground/basic.js",
+    "p-streaming": "npx ts-node playground/streaming.js",
+    "p-enhanced": "npx ts-node playground/enhanced.js",
+    "e-basic": "npx ts-node examples/basic.ts",
+    "e-streaming": "npx ts-node examples/streaming.ts",
+    "e-chat-completions": "npx ts-node examples/chat-completions.ts",
+    "e-enhanced": "npx ts-node examples/enhanced.ts"
+  },
+  "keywords": [
+    "revenium",
+    "middleware",
+    "perplexity",
+    "ai",
+    "chat",
+    "completion",
+    "metering",
+    "monitoring",
+    "typescript"
+  ],
+  "author": "",
+  "license": "ISC",
+  "type": "commonjs",
+  "dependencies": {
+    "dotenv": "^17.2.2",
+    "openai": "^5.23.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.2",
+    "uuid": "^13.0.0"
+  }
+}

package/playground/basic.js

@@ -1,30 +1,20 @@
-import { createPerplexityClient } from "@revenium/perplexity";
+import { PerplexityReveniumMiddleware } from "@revenium/perplexity";
 
 const basicExample = async () => {
-  console.log("\n🤖 Perplexity AI - Basic Client Example");
-  console.log("=".repeat(50));
-
   try {
-    // Create client instance
-    const client = createPerplexityClient();
-
-    // Make a simple chat completion
-    const response = await client.createChatCompletion({
-      model: "sonar-pro",
+    const middleware = new PerplexityReveniumMiddleware();
+    const model = middleware.getGenerativeModel("sonar-pro");
+    const result = await model.createChatCompletion({
       messages: [
         {
           role: "user",
-          content: "What is the meaning of life, the universe and everything?",
+          content: "Hello world",
         },
       ],
     });
-
-    console.log("✅ Response received:");
-    console.log(response.choices[0].message.content);
-    console.log("\n📊 Token usage automatically tracked by middleware");
-    console.log("🎉 Basic client example successful!");
+    console.log("[BASIC EXAMPLE]", result.choices[0].message.content);
   } catch (error) {
-    console.error("❌ Error:", error);
+    console.log(error);
   }
 };
 

package/playground/enhanced.js

@@ -1,35 +1,22 @@
-import { createPerplexityClient } from "@revenium/perplexity";
+import { PerplexityReveniumMiddleware } from "@revenium/perplexity";
 
 const enhancedExample = async () => {
-  console.log("\n1️⃣ Enhanced Example:");
-
   try {
-    const client = createPerplexityClient();
-    const advancedResponse = await client.createChatCompletion({
-      model: "sonar-pro",
+    const middleware = new PerplexityReveniumMiddleware();
+    const model = middleware.getGenerativeModel("sonar-pro");
+    const result = await model.createChatCompletion({
       messages: [
         {
           role: "user",
-          content: "What are the latest developments in AI?",
+          content: "Explain quantum computing in simple terms",
         },
       ],
-      usageMetadata: {
-        traceId: "conv-advanced-123",
-        taskType: "research",
-        subscriberId: "user-12345",
-        subscriberCredentialName: "api-key-1",
-        productId: "business-intelligence",
-        agent: "research-assistant-v2",
-        responseQualityScore: 0.95,
-      },
+      max_tokens: 100,
+      temperature: 0.7,
     });
-
-    console.log(
-      "✅ Response:",
-      advancedResponse.choices[0]?.message?.content?.substring(0, 100) + "..."
-    );
+    console.log("[ENHANCED EXAMPLE]", result.choices[0].message.content);
   } catch (error) {
-    console.error("❌ Error:", error);
+    console.log(error);
   }
 };
 

package/playground/streaming.js

@@ -1,40 +1,24 @@
-import { createPerplexityClient } from "@revenium/perplexity";
+import { PerplexityReveniumMiddleware } from "@revenium/perplexity";
 
-async function streamingExample() {
-  console.log("\n📊 Perplexity AI - Streaming Example");
+const streamingExample = async () => {
   console.log("=".repeat(50));
-
   try {
-    const client = createPerplexityClient();
-    console.log("\n3️⃣ Streaming with metadata:");
-    const stream = await client.createStreamingChatCompletion({
-      model: "sonar-pro",
+    const middleware = new PerplexityReveniumMiddleware();
+    const model = middleware.getGenerativeModel("sonar-pro");
+    const result = await model.createChatCompletionStream({
       messages: [
         {
           role: "user",
-          content: "Write a creative story about AI",
+          content: "Hello world",
         },
       ],
-      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);
-      }
+    for await (const chunk of result) {
+      process.stdout.write(chunk.choices[0]?.delta?.content || "");
     }
-
-    console.log("\n\n🎉 Streaming completed!");
   } catch (error) {
-    console.error("❌ Error:", error);
+    console.log(error);
   }
-}
+};
 
 streamingExample();

package/src/index.ts

@@ -1,38 +1,4 @@
 import { config } from "dotenv";
-import { Logger } from "./models";
-import { activeMiddleware } from "./utils/activeMiddleware";
-import { verifyLogVerbose } from "./utils/verifyLogVerbose";
-
-// Import the Perplexity middleware to activate it
-import "./perplexity-ai/middleware";
-
 config();
 
-const verboseStartup:boolean =
-  process.env.REVENIUM_VERBOSE_STARTUP?.toLowerCase() === "true";
-
-verifyLogVerbose(
-  verboseStartup,
-  "Revenium Perplexity middleware initialization starting"
-);
-
-// Activate middleware for Perplexity AI
-let activeSDKs: string[] = [];
-activeMiddleware(verboseStartup, activeSDKs, "perplexity-ai");
-
-// Export all utilities, types, and models
-export * from "./utils";
-export * from "./types";
-export * from "./models";
-
-// Export Perplexity client and middleware
-export * from "./perplexity-ai";
-
-// Log the active SDKs
-Logger.info(
-  "Revenium Perplexity middleware activated for: %s",
-  activeSDKs.length > 0 ? activeSDKs.join(", ") : "none"
-);
-
-export const version:string = "0.1.0";
-export const activeSDKList:string[] = activeSDKs;
+export * from "./middleware";

package/src/interfaces/chatCompletionRequest.ts

@@ -0,0 +1,9 @@
+import { ChatCompletionMessageParam } from "openai/resources/index";
+
+export interface IChatCompletionRequest {
+  model?: string;
+  messages: ChatCompletionMessageParam[];
+  stream?: boolean;
+  usageMetadata?: any;
+  [key: string]: any;
+}

package/src/interfaces/credential.ts

@@ -0,0 +1,4 @@
+export interface ICredential {
+  name: string;
+  value: string;
+}

package/src/interfaces/meteringRequest.ts

@@ -0,0 +1,14 @@
+import { IOperationType } from "./operation";
+import { ITokenCounts } from "./tokenCounts";
+import { IUsageMetadata } from "./usageMetadata";
+
+export interface IMeteringRequest {
+  transactionId?: string;
+  startTime: Date;
+  endTime: Date;
+  modelName: string;
+  tokenCounts: ITokenCounts;
+  stopReason: string;
+  operationType: IOperationType;
+  usageMetadata?: IUsageMetadata;
+}

package/src/{types/metering.ts → interfaces/meteringResponse.ts}

@@ -1,6 +1,6 @@
-import { Subscriber } from "./subscriber";
+import { ISubscriber } from "./subscriber";
 
-export interface MeteringRequest {
+export interface IMeteringResponse {
   stopReason: string;
   costType: string;
   isStreamed: boolean;
@@ -15,7 +15,7 @@ export interface MeteringRequest {
   totalTokenCount: number;
   organizationId: string;
   productId: string;
-  subscriber: Subscriber;
+  subscriber: ISubscriber;
   model: string;
   transactionId: string;
   responseTime: string;

package/src/interfaces/operation.ts

@@ -0,0 +1,4 @@
+export enum IOperationType {
+  CHAT = "CHAT",
+  EMBED = "EMBED",
+}

package/src/{types → interfaces}/subscriber.ts

@@ -1,4 +1,4 @@
-export interface Subscriber {
+export interface ISubscriber {
   id: string;
   email: string;
   credential: {

package/src/interfaces/tokenCounts.ts

@@ -0,0 +1,7 @@
+export interface ITokenCounts {
+  inputTokens: number;
+  outputTokens: number;
+  totalTokens: number;
+  cachedTokens?: number;
+  reasoningTokens?: number;
+}

package/src/{types → interfaces}/usageMetadata.ts

@@ -1,4 +1,4 @@
-export interface UsageMetadata {
+export interface IUsageMetadata {
   traceId?: string;
   taskType?: string;
   subscriberEmail?: string;

package/src/middleware.ts

@@ -0,0 +1,151 @@
+import OpenAI, { APIPromise } from "openai";
+import {
+  models,
+  PERPLEXITY_API_BASE_URL,
+  PERPLEXITY_API_KEY,
+  PERPLEXITY_API_KEY_INVALID_MESSAGE,
+  PERPLEXITY_CLIENT_INITIALIZED_MESSAGE,
+  PERPLEXITY_METERING_API_KEY_IS_NOT_SET_MESSAGE,
+  PERPLEXITY_METERING_BASE_URL_IS_NOT_SET_MESSAGE,
+  PERPLEXITY_REQUIRED_API_KEY_MESSAGE,
+  REVENIUM_METERING_API_KEY,
+  REVENIUM_METERING_BASE_URL,
+} from "./utils";
+import { logger } from "./models/Logger";
+import { IChatCompletionRequest } from "./interfaces/chatCompletionRequest";
+import { Metering } from "./models/Metering";
+import { IOperationType } from "./interfaces/operation";
+import { extractGoogleAITokenCounts } from "./utils/extractTokenCount";
+import { RequestOptions } from "openai/internal/request-options";
+
+export class PerplexityReveniumMiddleware {
+  private client: OpenAI;
+  private working: boolean = true;
+  private modelName: string = "";
+  constructor() {
+    this.verifyEnv();
+    this.client = new OpenAI({
+      apiKey: PERPLEXITY_API_KEY,
+      baseURL: PERPLEXITY_API_BASE_URL,
+    });
+    logger.info(PERPLEXITY_CLIENT_INITIALIZED_MESSAGE);
+  }
+  public getGenerativeModel(model: string) {
+    this.modelName = model;
+    if (!models.includes(model)) {
+      throw new Error(`Model ${model} is not supported`);
+    }
+    return {
+      createChatCompletion: this.chatCompletion,
+      createChatCompletionStream: this.streamingChatCompletion,
+      createEmbeddings: this.embeddings,
+    };
+  }
+
+  private embeddings = async (
+    _body: Omit<OpenAI.Embeddings.EmbeddingCreateParams, "model">,
+    _options?: RequestOptions
+  ) => {};
+
+  private streamingChatCompletion = async (params: IChatCompletionRequest) => {
+    const startTime: Date = new Date();
+    try {
+      const { usageMetadata, ...openaiParams } = params;
+      const requestParams = {
+        ...openaiParams,
+        model: this.modelName,
+      };
+      const result = await this.client?.chat.completions.create({
+        ...requestParams,
+        stream: true,
+      });
+      if (!this.working) {
+        logger.warning("Metering is not working. Check your configuration.");
+        return result;
+      }
+      const tokenCounts = extractGoogleAITokenCounts(result);
+      const endTime: Date = new Date();
+      logger.info("Metering is working.");
+      const metering = new Metering(
+        REVENIUM_METERING_API_KEY ?? "",
+        REVENIUM_METERING_BASE_URL ?? ""
+      );
+      const getMetering = metering.createMetering({
+        modelName: this.modelName,
+        endTime,
+        startTime,
+        operationType: IOperationType.CHAT,
+        stopReason: "END",
+        tokenCounts,
+        usageMetadata,
+      });
+      await metering.sendMeteringData(getMetering);
+      return result;
+    } catch (error) {
+      throw error;
+    }
+  };
+
+  private chatCompletion = async (params: IChatCompletionRequest) => {
+    const startTime: Date = new Date();
+    try {
+      const { usageMetadata, ...openaiParams } = params;
+      const requestParams = {
+        ...openaiParams,
+        model: this.modelName,
+      };
+      const result: OpenAI.Chat.Completions.ChatCompletion & {
+        _request_id?: string | null | undefined;
+      } = await this.client?.chat.completions.create({
+        ...requestParams,
+        stream: false,
+      });
+      if (!this.working) {
+        logger.warning("Metering is not working. Check your configuration.");
+        return result;
+      }
+      const tokenCounts = extractGoogleAITokenCounts(result);
+      const endTime: Date = new Date();
+      logger.info(" Metering is working.");
+      const metering = new Metering(
+        REVENIUM_METERING_API_KEY ?? "",
+        REVENIUM_METERING_BASE_URL ?? ""
+      );
+      const getMetering = metering.createMetering({
+        modelName: this.modelName,
+        endTime,
+        startTime,
+        operationType: IOperationType.CHAT,
+        stopReason: "END",
+        tokenCounts,
+        usageMetadata,
+      });
+      await metering.sendMeteringData(getMetering);
+      return result;
+    } catch (error) {
+      throw error;
+    }
+  };
+
+  private verifyEnv(): void {
+    if (!PERPLEXITY_API_KEY) {
+      logger.error(PERPLEXITY_REQUIRED_API_KEY_MESSAGE);
+      throw new Error(PERPLEXITY_REQUIRED_API_KEY_MESSAGE);
+    }
+
+    if (!PERPLEXITY_API_KEY.includes("pplx-")) {
+      logger.error(PERPLEXITY_API_KEY_INVALID_MESSAGE);
+      throw new Error(PERPLEXITY_API_KEY_INVALID_MESSAGE);
+    }
+
+    if (!REVENIUM_METERING_API_KEY) {
+      logger.warning(PERPLEXITY_METERING_API_KEY_IS_NOT_SET_MESSAGE);
+      this.working = false;
+    }
+
+    if (!REVENIUM_METERING_BASE_URL) {
+      logger.warning(PERPLEXITY_METERING_BASE_URL_IS_NOT_SET_MESSAGE);
+      this.working = false;
+    }
+  }
+}

package/src/models/Logger.ts

@@ -1,29 +1,29 @@
-import { LOG_LEVELS } from "../utils/constants/constants";
+import { LOG_LEVELS } from "../utils";
 
 export class Logger {
   private static logLevel: string = process.env.REVENIUM_LOG_LEVEL || "INFO";
 
   static debug(message: string, data?: any): void {
     if (this.shouldLog(LOG_LEVELS[0])) {
-      console.log(`${LOG_LEVELS[0]} ${message}`, data || "");
+      console.log(`[${LOG_LEVELS[0]}] ${message}`, data || "");
     }
   }
 
   static info(message: string, data?: any): void {
     if (this.shouldLog(LOG_LEVELS[1])) {
-      console.log(`${LOG_LEVELS[1]} ${message}`, data || "");
+      console.log(`[${LOG_LEVELS[1]}] ${message}`, data || "");
     }
   }
 
   static warning(message: string, data?: any): void {
     if (this.shouldLog(LOG_LEVELS[2])) {
-      console.warn(`${LOG_LEVELS[2]} ${message}`, data || "");
+      console.warn(`[${LOG_LEVELS[2]}] ${message}`, data || "");
     }
   }
 
   static error(message: string, data?: any): void {
     if (this.shouldLog(LOG_LEVELS[3])) {
-      console.error(`${LOG_LEVELS[3]} ${message}`, data || "");
+      console.error(`[${LOG_LEVELS[3]}] ${message}`, data || "");
     }
   }