@revenium/perplexity 1.0.25 → 2.0.1

package/playground/v1/chat.js

@@ -1,46 +0,0 @@
-import { PerplexityV1Controller } from "@revenium/perplexity";
-
-const chatV1Example = async () => {
-  console.log("=".repeat(50));
-  console.log("💬 Perplexity V1 Multi-turn Chat Example (JavaScript)");
-  console.log("=".repeat(50));
-
-  try {
-    const controller = new PerplexityV1Controller();
-
-    // Multi-turn conversation using message objects
-    const messages = [
-      { role: "user", content: "What are the benefits of renewable energy?" },
-      {
-        role: "assistant",
-        content:
-          "Renewable energy offers several key benefits including environmental sustainability, reduced greenhouse gas emissions, and long-term cost savings.",
-      },
-      {
-        role: "user",
-        content: "Can you elaborate on the cost savings aspect?",
-      },
-    ];
-
-    const result = await controller.createChat(messages, "sonar-pro");
-
-    console.log("📝 Multi-turn Chat Response:");
-    console.log(result.responses[0].text);
-
-    console.log("\n📊 Usage Statistics:");
-    console.log(`Input tokens: ${result.usageMetadata.inputTokenCount}`);
-    console.log(`Output tokens: ${result.usageMetadata.outputTokenCount}`);
-    console.log(`Total tokens: ${result.usageMetadata.totalTokenCount}`);
-
-    console.log("\n🔧 Model Information:");
-    const modelInfo = controller.getModelInfo("sonar-pro");
-    console.log(`Model: ${modelInfo.model}`);
-    console.log(`Version: ${modelInfo.version}`);
-    console.log(`Context Window: ${modelInfo.contextWindow} tokens`);
-    console.log(`Capabilities:`, modelInfo.capabilities);
-  } catch (error) {
-    console.error("❌ Error:", error);
-  }
-};
-
-chatV1Example();

package/playground/v1/metadata.js

@@ -1,50 +0,0 @@
-import { PerplexityV1Controller } from "@revenium/perplexity";
-
-const metadataV1Example = async () => {
-  console.log("=".repeat(50));
-  console.log("📊 Perplexity V1 Custom Metadata Example (JavaScript)");
-  console.log("=".repeat(50));
-
-  try {
-    const controller = new PerplexityV1Controller();
-
-    // Custom metadata for tracking
-    const customMetadata = {
-      traceId: "trace-js-12345",
-      taskType: "research-query",
-      subscriberEmail: "user@example.com",
-      subscriberId: "user-js-456",
-      organizationId: "org-js-789",
-      agent: "perplexity-v1-js-demo",
-    };
-
-    const result = await controller.createChat(
-      ["Explain quantum computing in simple terms"],
-      "sonar-pro",
-      customMetadata
-    );
-
-    console.log("📝 Response:");
-    console.log(result.responses[0].text);
-
-    console.log("\n📊 Usage Metadata:");
-    console.log(`Input tokens: ${result.usageMetadata.inputTokenCount}`);
-    console.log(`Output tokens: ${result.usageMetadata.outputTokenCount}`);
-    console.log(`Total tokens: ${result.usageMetadata.totalTokenCount}`);
-
-    console.log("\n🏷️ Custom Metadata Sent:");
-    console.log(`Trace ID: ${customMetadata.traceId}`);
-    console.log(`Task Type: ${customMetadata.taskType}`);
-    console.log(`Subscriber: ${customMetadata.subscriberEmail}`);
-    console.log(`Organization: ${customMetadata.organizationId}`);
-    console.log(`Agent: ${customMetadata.agent}`);
-
-    console.log("\n🔧 Transaction Info:");
-    console.log(`Model: ${result.modelVersion}`);
-    console.log(`Transaction ID: ${result.transactionId}`);
-  } catch (error) {
-    console.error("❌ Error:", error);
-  }
-};
-
-metadataV1Example();

package/playground/v1/streaming.js

@@ -1,44 +0,0 @@
-import { PerplexityV1Controller } from "@revenium/perplexity";
-
-const streamingV1Example = async () => {
-  console.log("=".repeat(50));
-  console.log(
-    "🌊 Perplexity V1 Streaming Example (JavaScript - @revenium/perplexity)"
-  );
-  console.log("=".repeat(50));
-
-  try {
-    const controller = new PerplexityV1Controller();
-
-    // Streaming chat completion
-    const result = await controller.createStreaming(
-      [
-        "Write a short story about a robot learning to paint. Make it creative and engaging.",
-      ],
-      "sonar-pro"
-    );
-
-    console.log("📝 Streaming Response:");
-    console.log("-".repeat(30));
-
-    let fullResponse = "";
-    for await (const chunk of result.stream) {
-      const content = chunk.choices?.[0]?.delta?.content || "";
-      if (content) {
-        process.stdout.write(content);
-        fullResponse += content;
-      }
-    }
-
-    console.log("\n" + "-".repeat(30));
-    console.log(
-      `\n📊 Total response length: ${fullResponse.length} characters`
-    );
-    console.log(`🔧 Model: ${result.modelVersion}`);
-    console.log(`🆔 Transaction ID: ${result.transactionId}`);
-  } catch (error) {
-    console.error("❌ Error:", error);
-  }
-};
-
-streamingV1Example();

package/playground/v2/basic.js

@@ -1,49 +0,0 @@
-import { PerplexityV2Controller } from "@revenium/perplexity";
-
-const basicV2Example = async () => {
-  console.log("=".repeat(50));
-  console.log(
-    "🚀 Perplexity V2 Basic Example (JavaScript - Enhanced Response Format)"
-  );
-  console.log("=".repeat(50));
-
-  try {
-    const controller = new PerplexityV2Controller();
-
-    // Basic chat completion with V2 enhanced response
-    const result = await controller.createChat([
-      "What is artificial intelligence and how does it work?",
-    ]);
-
-    console.log("📝 Response:");
-    console.log(result.choices[0].message.content);
-
-    console.log("\n📊 Enhanced Usage Info (V2):");
-    console.log(`Prompt tokens: ${result.usage.prompt_tokens}`);
-    console.log(`Completion tokens: ${result.usage.completion_tokens}`);
-    console.log(`Total tokens: ${result.usage.total_tokens}`);
-
-    console.log("\n🔧 Enhanced Metadata (V2):");
-    console.log(`ID: ${result.id}`);
-    console.log(`Object: ${result.object}`);
-    console.log(`Created: ${new Date(result.created * 1000).toISOString()}`);
-    console.log(`Model: ${result.model}`);
-    console.log(`Transaction ID: ${result.metadata.transactionId}`);
-    console.log(`Processing Time: ${result.metadata.processingTime}ms`);
-    console.log(`Version: ${result.metadata.version}`);
-
-    // Test V2 enhanced features
-    console.log("\n🎯 V2 Enhanced Features:");
-    const modelInfo = controller.getModelInfo("sonar-pro");
-    console.log(`Enhanced Model Info:`, modelInfo);
-
-    const recommendation = controller.getRecommendedModel("online-search");
-    console.log(
-      `Recommended for online search: ${recommendation.model} - ${recommendation.reason}`
-    );
-  } catch (error) {
-    console.error("❌ Error:", error);
-  }
-};
-
-basicV2Example();

package/playground/v2/chat.js

@@ -1,72 +0,0 @@
-import { PerplexityV2Controller } from "@revenium/perplexity";
-
-const chatV2Example = async () => {
-  console.log("=".repeat(50));
-  console.log(
-    "💬 Perplexity V2 Enhanced Chat Example (JavaScript - OpenAI Responses API)"
-  );
-  console.log("=".repeat(50));
-
-  try {
-    const controller = new PerplexityV2Controller();
-
-    // Multi-turn conversation with V2 enhanced features
-    const messages = [
-      {
-        role: "user",
-        content:
-          "What are the latest developments in renewable energy technology?",
-      },
-      {
-        role: "assistant",
-        content:
-          "Recent developments include improved solar panel efficiency, advanced battery storage systems, and offshore wind technology innovations.",
-      },
-      {
-        role: "user",
-        content: "Tell me more about the battery storage improvements",
-      },
-    ];
-
-    const result = await controller.createChat(messages, "sonar-pro");
-
-    console.log("📝 V2 Enhanced Chat Response:");
-    console.log(result.choices[0].message.content);
-
-    console.log("\n📊 V2 Enhanced Usage Statistics:");
-    console.log(`Prompt tokens: ${result.usage.prompt_tokens}`);
-    console.log(`Completion tokens: ${result.usage.completion_tokens}`);
-    console.log(`Total tokens: ${result.usage.total_tokens}`);
-
-    console.log("\n🔧 V2 Enhanced Response Metadata:");
-    console.log(`ID: ${result.id}`);
-    console.log(`Object: ${result.object}`);
-    console.log(`Created: ${new Date(result.created * 1000).toISOString()}`);
-    console.log(`Model: ${result.model}`);
-    console.log(`Finish Reason: ${result.choices[0].finish_reason}`);
-    console.log(`Processing Time: ${result.metadata.processingTime}ms`);
-    console.log(`Transaction ID: ${result.metadata.transactionId}`);
-    console.log(`Version: ${result.metadata.version}`);
-
-    // V2 Enhanced Features
-    console.log("\n🚀 V2 Enhanced Model Features:");
-    const modelInfo = controller.getModelInfo("sonar-pro");
-    console.log(`Enhanced: ${modelInfo.enhanced}`);
-    console.log(`Response Format: ${modelInfo.responseFormat}`);
-
-    const performance = controller.getModelPerformance("sonar-pro");
-    console.log(`Estimated Latency: ${performance.estimatedLatency}`);
-    console.log(`Cost Tier: ${performance.costTier}`);
-
-    // Model recommendations
-    console.log("\n🎯 V2 Model Recommendations:");
-    const onlineRec = controller.getRecommendedModel("online-search");
-    const offlineRec = controller.getRecommendedModel("offline-chat");
-    console.log(`For online search: ${onlineRec.model} - ${onlineRec.reason}`);
-    console.log(`For offline chat: ${offlineRec.model} - ${offlineRec.reason}`);
-  } catch (error) {
-    console.error("❌ Error:", error);
-  }
-};
-
-chatV2Example();

package/playground/v2/metadata.js

@@ -1,76 +0,0 @@
-import { PerplexityV2Controller } from "@revenium/perplexity";
-
-const metadataV2Example = async () => {
-  console.log("=".repeat(50));
-  console.log(
-    "📊 Perplexity V2 Enhanced Metadata Example (JavaScript - OpenAI Responses API)"
-  );
-  console.log("=".repeat(50));
-
-  try {
-    const controller = new PerplexityV2Controller();
-
-    // Enhanced custom metadata for V2
-    const customMetadata = {
-      traceId: "trace-v2-js-67890",
-      taskType: "advanced-research",
-      subscriberEmail: "researcher@example.com",
-      subscriberId: "user-v2-js-123",
-      organizationId: "org-v2-js-456",
-      agent: "perplexity-v2-js-enhanced",
-      responseQualityScore: 0.95,
-      operationType: "chat-completion",
-    };
-
-    const result = await controller.createChat(
-      [
-        "Provide a comprehensive analysis of the impact of artificial intelligence on modern healthcare systems",
-      ],
-      "sonar-pro",
-      customMetadata
-    );
-
-    console.log("📝 V2 Enhanced Response:");
-    console.log(result.choices[0].message.content);
-
-    console.log("\n📊 V2 Enhanced Usage Statistics:");
-    console.log(`Prompt tokens: ${result.usage.prompt_tokens}`);
-    console.log(`Completion tokens: ${result.usage.completion_tokens}`);
-    console.log(`Total tokens: ${result.usage.total_tokens}`);
-
-    console.log("\n🔧 V2 Enhanced Response Structure:");
-    console.log(`ID: ${result.id}`);
-    console.log(`Object: ${result.object}`);
-    console.log(`Created: ${new Date(result.created * 1000).toISOString()}`);
-    console.log(`Model: ${result.model}`);
-    console.log(`Choice Index: ${result.choices[0].index}`);
-    console.log(`Message Role: ${result.choices[0].message.role}`);
-    console.log(`Finish Reason: ${result.choices[0].finish_reason}`);
-
-    console.log("\n🏷️ V2 Enhanced Metadata:");
-    console.log(`Transaction ID: ${result.metadata.transactionId}`);
-    console.log(`Processing Time: ${result.metadata.processingTime}ms`);
-    console.log(`Version: ${result.metadata.version}`);
-
-    console.log("\n📋 Custom Metadata Sent:");
-    console.log(`Trace ID: ${customMetadata.traceId}`);
-    console.log(`Task Type: ${customMetadata.taskType}`);
-    console.log(`Subscriber: ${customMetadata.subscriberEmail}`);
-    console.log(`Organization: ${customMetadata.organizationId}`);
-    console.log(`Agent: ${customMetadata.agent}`);
-    console.log(`Quality Score: ${customMetadata.responseQualityScore}`);
-    console.log(`Operation Type: ${customMetadata.operationType}`);
-
-    // V2 Enhanced Analytics
-    console.log("\n📈 V2 Enhanced Analytics:");
-    const performance = controller.getModelPerformance("sonar-pro");
-    console.log(`Context Window: ${performance.contextWindow} tokens`);
-    console.log(`Online Capabilities: ${performance.online}`);
-    console.log(`Estimated Latency: ${performance.estimatedLatency}`);
-    console.log(`Cost Tier: ${performance.costTier}`);
-  } catch (error) {
-    console.error("❌ Error:", error);
-  }
-};
-
-metadataV2Example();

package/playground/v2/streaming.js

@@ -1,67 +0,0 @@
-import { PerplexityV2Controller } from "@revenium/perplexity";
-
-const streamingV2Example = async () => {
-  console.log("=".repeat(50));
-  console.log(
-    "🌊 Perplexity V2 Streaming Example (JavaScript - Enhanced Response Format)"
-  );
-  console.log("=".repeat(50));
-
-  try {
-    const controller = new PerplexityV2Controller();
-
-    // Streaming chat completion with V2 enhanced response
-    const result = await controller.createStreaming(
-      [
-        "Write a detailed explanation of how machine learning algorithms work, including examples.",
-      ],
-      "sonar-pro"
-    );
-
-    console.log("📝 V2 Streaming Response:");
-    console.log("-".repeat(30));
-
-    let fullResponse = "";
-    let chunkCount = 0;
-    let lastUsage = null;
-
-    for await (const chunk of result.stream) {
-      chunkCount++;
-      const content = chunk.choices?.[0]?.delta?.content || "";
-
-      if (content) {
-        process.stdout.write(content);
-        fullResponse += content;
-      }
-
-      // Capture usage data from the last chunk
-      if (chunk.usage) {
-        lastUsage = chunk.usage;
-      }
-    }
-
-    console.log("\n" + "-".repeat(30));
-    console.log(`\n📊 V2 Enhanced Streaming Stats:`);
-    console.log(`Total chunks received: ${chunkCount}`);
-    console.log(`Response length: ${fullResponse.length} characters`);
-
-    if (lastUsage) {
-      console.log(`Prompt tokens: ${lastUsage.prompt_tokens}`);
-      console.log(`Completion tokens: ${lastUsage.completion_tokens}`);
-      console.log(`Total tokens: ${lastUsage.total_tokens}`);
-    }
-
-    console.log(`\n🔧 V2 Metadata:`);
-    console.log(`Stream ID: ${result.id}`);
-    console.log(`Object: ${result.object}`);
-    console.log(`Transaction ID: ${result.metadata.transactionId}`);
-    console.log(
-      `Start Time: ${new Date(result.metadata.startTime).toISOString()}`
-    );
-    console.log(`Version: ${result.metadata.version}`);
-  } catch (error) {
-    console.error("❌ Error:", error);
-  }
-};
-
-streamingV2Example();

package/src/index.ts

@@ -1,17 +0,0 @@
-import { config } from "dotenv";
-config();
-
-// V1 Controllers (compatible with current API)
-export * from "./v1/perplexityV1.controller";
-
-// V2 Controllers (enhanced response format following OpenAI Responses API)
-export * from "./v2/perplexityV2.controller";
-
-// Interfaces
-export * from "./interfaces/perplexityResponse";
-export * from "./interfaces/perplexityStreaming";
-export * from "./interfaces/usageMetadata";
-export * from "./interfaces/chatCompletionRequest";
-
-// Constants
-export * from "./utils/constants/perplexityModels";

package/src/interfaces/chatCompletionRequest.ts

@@ -1,15 +0,0 @@
-import { IUsageMetadata } from "./usageMetadata";
-
-// Flexible message interface for Perplexity
-export interface IPerplexityMessage {
-  role: "system" | "user" | "assistant";
-  content: string;
-}
-
-export interface IChatCompletionRequest {
-  model?: string;
-  messages: IPerplexityMessage[];
-  stream?: boolean;
-  usageMetadata?: IUsageMetadata;
-  [key: string]: any;
-}

package/src/interfaces/credential.ts

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

package/src/interfaces/meteringRequest.ts

@@ -1,14 +0,0 @@
-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/interfaces/meteringResponse.ts

@@ -1,29 +0,0 @@
-import { ISubscriber } from "./subscriber";
-
-export interface IMeteringResponse {
-  stopReason: string;
-  costType: string;
-  isStreamed: boolean;
-  taskType: string;
-  agent: string;
-  operationType: string;
-  inputTokenCount: number;
-  outputTokenCount: number;
-  reasoningTokenCount: number;
-  cacheCreationTokenCount: number;
-  cacheReadTokenCount: number;
-  totalTokenCount: number;
-  organizationId: string;
-  productId: string;
-  subscriber: ISubscriber;
-  model: string;
-  transactionId: string;
-  responseTime: string;
-  requestDuration: number;
-  provider: string;
-  requestTime: string;
-  completionStartTime: string;
-  timeToFirstToken: number;
-  middleware_source: string;
-  traceId?: string;
-}

package/src/interfaces/operation.ts

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

package/src/interfaces/perplexityResponse.ts

@@ -1,63 +0,0 @@
-import { IUsageMetadata } from "./usageMetadata";
-
-// Perplexity Chat Response Interface (V1 - Compatible with current middleware)
-export interface IPerplexityResponseChat {
-  responses: IPerplexityResponseMessage[];
-  usageMetadata: IUsageMetadata;
-  modelVersion: string;
-  transactionId: string;
-}
-
-export interface IPerplexityResponseMessage {
-  text: string;
-  role: "assistant" | "user" | "system";
-  finishReason?: string;
-}
-
-// Raw OpenAI-compatible response from Perplexity API
-export interface IPerplexityRawResponse {
-  id: string;
-  object: string;
-  created: number;
-  model: string;
-  choices: Array<{
-    index: number;
-    message: {
-      role: string;
-      content: string;
-    };
-    finish_reason: string;
-  }>;
-  usage: {
-    prompt_tokens: number;
-    completion_tokens: number;
-    total_tokens: number;
-  };
-}
-
-// V2 Enhanced Response Structure (Following OpenAI Responses API)
-export interface IPerplexityV2Response {
-  id: string;
-  object: "chat.completion";
-  created: number;
-  model: string;
-  choices: Array<{
-    index: number;
-    message: {
-      role: string;
-      content: string;
-    };
-    finish_reason: string;
-  }>;
-  usage: {
-    prompt_tokens: number;
-    completion_tokens: number;
-    total_tokens: number;
-  };
-  // Enhanced metadata for V2
-  metadata: {
-    transactionId: string;
-    processingTime: number;
-    version: "v2";
-  };
-}

package/src/interfaces/perplexityStreaming.ts

@@ -1,56 +0,0 @@
-import { IUsageMetadata } from "./usageMetadata";
-
-// Perplexity Streaming Response Interface (V1 - Compatible with current middleware)
-export interface IPerplexityStreamingResponse {
-  stream: AsyncIterable<IPerplexityStreamChunk>;
-  usageMetadata: IUsageMetadata;
-  modelVersion: string;
-  transactionId: string;
-}
-
-export interface IPerplexityStreamChunk {
-  id: string;
-  object: string;
-  created: number;
-  model: string;
-  choices: Array<{
-    index: number;
-    delta: {
-      role?: string;
-      content?: string;
-    };
-    finish_reason?: string;
-  }>;
-}
-
-// V2 Enhanced Streaming Response (Following OpenAI Responses API)
-export interface IPerplexityV2StreamingResponse {
-  id: string;
-  object: "chat.completion.chunk";
-  stream: AsyncIterable<IPerplexityV2StreamChunk>;
-  metadata: {
-    transactionId: string;
-    startTime: number;
-    version: "v2";
-  };
-}
-
-export interface IPerplexityV2StreamChunk {
-  id: string;
-  object: "chat.completion.chunk";
-  created: number;
-  model: string;
-  choices: Array<{
-    index: number;
-    delta: {
-      role?: string;
-      content?: string;
-    };
-    finish_reason?: string;
-  }>;
-  usage?: {
-    prompt_tokens: number;
-    completion_tokens: number;
-    total_tokens: number;
-  };
-}

package/src/interfaces/subscriber.ts

@@ -1,8 +0,0 @@
-export interface ISubscriber {
-  id: string;
-  email: string;
-  credential: {
-    name: string;
-    value: string;
-  };
-}

package/src/interfaces/tokenCounts.ts

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

package/src/interfaces/usageMetadata.ts

@@ -1,27 +0,0 @@
-export interface IUsageMetadata {
-  traceId?: string;
-  taskType?: string;
-  subscriberEmail?: string;
-  subscriberId?: string;
-  subscriberCredentialName?: string;
-  subscriberCredential?: string;
-  organizationId?: string;
-  subscriptionId?: string;
-  productId?: string;
-  agent?: string;
-  responseQualityScore?: number;
-  transactionId?: string;
-  timeToFirstToken?: number;
-  requestTime?: Date;
-  completionStartTime?: Date;
-  operationType?: string;
-  inputTokenCount?: number;
-  outputTokenCount?: number;
-  reasoningTokenCount?: number;
-  cacheCreationTokenCount?: number;
-  cacheReadTokenCount?: number;
-  totalTokenCount?: number;
-  responseTime?: Date;
-  requestDuration?: number;
-  stopReason?: string;
-}