@revenium/perplexity 1.0.25 → 2.0.2

package/src/models/Logger.ts

@@ -1,38 +0,0 @@
-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 || "");
-    }
-  }
-
-  static info(message: string, data?: any): void {
-    if (this.shouldLog(LOG_LEVELS[1])) {
-      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 || "");
-    }
-  }
-
-  static error(message: string, data?: any): void {
-    if (this.shouldLog(LOG_LEVELS[3])) {
-      console.error(`[${LOG_LEVELS[3]}] ${message}`, data || "");
-    }
-  }
-
-  private static shouldLog(level: string): boolean {
-    const levels = LOG_LEVELS;
-    const currentLevel = levels.indexOf(this.logLevel.toUpperCase());
-    const messageLevel = levels.indexOf(level);
-    return messageLevel >= currentLevel;
-  }
-}
-
-export const logger = Logger;

package/src/models/Metering.ts

@@ -1,121 +0,0 @@
-import { IMeteringRequest } from "../interfaces/meteringRequest";
-import { IMeteringResponse } from "../interfaces/meteringResponse";
-import {
-  COST_TYPE,
-  CURRENT_CREDENTIAL,
-  MIDDLEWARE_SOURCE,
-  PRODUCT_ID_FREE,
-  REVENIUM_METERING_API_KEY,
-  REVENIUM_METERING_BASE_URL,
-} from "../utils";
-import { calculateDurationMs } from "../utils/calculateDurationMs";
-import { formatTimestamp } from "../utils/formatTimestamp";
-import { generateTransactionId } from "../utils/generateTransactionId";
-import { logger } from "./Logger";
-
-export class Metering {
-  private endpoint: string = "";
-  private apiKey: string = "";
-  constructor(clientApiKey: string, clientEndpoint: string) {
-    this.apiKey = clientApiKey;
-    this.endpoint = clientEndpoint;
-  }
-
-  public createMetering(
-    metering: IMeteringRequest,
-    isStreamed: boolean
-  ): IMeteringResponse {
-    const usageMetadata = metering.usageMetadata;
-    const agent: string = "perplexity";
-    return {
-      stopReason: usageMetadata?.stopReason ?? metering.stopReason,
-      costType: COST_TYPE,
-      isStreamed,
-      taskType: usageMetadata?.taskType ?? COST_TYPE,
-      agent: usageMetadata?.agent ?? agent,
-      operationType:
-        usageMetadata?.operationType ?? metering.operationType.toString(),
-      inputTokenCount:
-        usageMetadata?.inputTokenCount ?? metering.tokenCounts.inputTokens,
-      outputTokenCount:
-        usageMetadata?.outputTokenCount ?? metering.tokenCounts.outputTokens,
-      reasoningTokenCount:
-        usageMetadata?.reasoningTokenCount ??
-        metering.tokenCounts.reasoningTokens ??
-        0,
-      cacheCreationTokenCount:
-        usageMetadata?.cacheCreationTokenCount ??
-        metering.tokenCounts.cachedTokens ??
-        0,
-      cacheReadTokenCount: usageMetadata?.cacheReadTokenCount ?? 0,
-      totalTokenCount:
-        usageMetadata?.totalTokenCount ?? metering.tokenCounts.totalTokens,
-      organizationId:
-        usageMetadata?.organizationId ??
-        `my-customer-name-${generateTransactionId()}`,
-      productId: usageMetadata?.productId ?? PRODUCT_ID_FREE,
-      subscriber: {
-        id: usageMetadata?.subscriberId ?? `user-${generateTransactionId()}`,
-        email:
-          usageMetadata?.subscriberEmail ?? `user-@${agent.toLowerCase()}.ai`,
-        credential:
-          usageMetadata?.subscriberCredentialName &&
-          usageMetadata?.subscriberCredential
-            ? {
-                name: usageMetadata.subscriberCredentialName,
-                value: usageMetadata.subscriberCredential,
-              }
-            : CURRENT_CREDENTIAL,
-      },
-      model: metering.modelName,
-      transactionId: usageMetadata?.transactionId ?? generateTransactionId(),
-      responseTime: formatTimestamp(metering.endTime),
-      requestDuration: calculateDurationMs(
-        metering.startTime,
-        metering.endTime
-      ),
-      provider: agent,
-      requestTime:
-        usageMetadata?.requestTime?.toString() ??
-        formatTimestamp(metering.startTime),
-      completionStartTime:
-        usageMetadata?.completionStartTime?.toString() ??
-        formatTimestamp(metering.endTime),
-      timeToFirstToken: usageMetadata?.timeToFirstToken ?? 0,
-      middleware_source: MIDDLEWARE_SOURCE,
-      traceId: usageMetadata?.traceId,
-    };
-  }
-
-  public sendMeteringData = async (
-    metering: IMeteringResponse
-  ): Promise<void> => {
-    try {
-      // Log the metering data being sent for debugging
-      logger.info(
-        "Sending metering data to Revenium:",
-        JSON.stringify(metering, null, 2)
-      );
-
-      const response = await fetch(`${this.endpoint}/v2/ai/completions`, {
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-          "x-api-key": this.apiKey,
-          accept: "application/json",
-        },
-        body: JSON.stringify(metering),
-      });
-      if (!response.ok) {
-        const errorData = await response?.text();
-        logger.error(
-          `Metering API request failed with status ${response.status} - ${errorData}`
-        );
-        return;
-      }
-      logger.info(`Metering data sent successfully to Revenium`);
-    } catch (error: any) {
-      logger.error(`Error to sent metering data ${error}`);
-    }
-  };
-}

package/src/utils/calculateDurationMs.ts

@@ -1,3 +0,0 @@
-export function calculateDurationMs(startTime: Date, endTime: Date): number {
-  return Math.round(endTime.getTime() - startTime.getTime());
-}

package/src/utils/constants/constants.ts

@@ -1,10 +0,0 @@
-import { ICredential } from "../../interfaces/credential";
-
-export const PERPLEXITY_API_BASE_URL: string = "https://api.perplexity.ai";
-export const COST_TYPE: string = "AI";
-export const MIDDLEWARE_SOURCE: string = "node";
-export const PRODUCT_ID_FREE: string = "free-trial";
-export const CURRENT_CREDENTIAL: ICredential = {
-  name: "apiKey",
-  value: "keyValue",
-};

package/src/utils/constants/logLevels.ts

@@ -1 +0,0 @@
-export const LOG_LEVELS: string[] = ["DEBUG", "INFO", "WARNING", "ERROR"];

package/src/utils/constants/messages.ts

@@ -1,11 +0,0 @@
-export const PERPLEXITY_REQUIRED_API_KEY_MESSAGE: string =
-  "PERPLEXITY_API_KEY is required. Set it in environment variables or pass it to the constructor.";
-
-export const PERPLEXITY_API_KEY_INVALID_MESSAGE: string =
-  "PERPLEXITY_API_KEY is invalid. Please check your API key.";
-export const PERPLEXITY_METERING_API_KEY_IS_NOT_SET_MESSAGE: string =
-  "REVENIUM_METERING_API_KEY is not set. Metering will not work.";
-export const PERPLEXITY_METERING_BASE_URL_IS_NOT_SET_MESSAGE: string =
-  "REVENIUM_METERING_BASE_URL is not set. Metering will not work.";
-export const PERPLEXITY_CLIENT_INITIALIZED_MESSAGE =
-  "Perplexity AI client initialized with middleware";

package/src/utils/constants/models.ts

@@ -1,20 +0,0 @@
-export const models: string[] = [
-  // Perplexity Sonar Models (2025) - Chat Completions
-  "sonar", // Lightweight, cost-effective search model
-  "sonar-pro", // Advanced search with deeper content understanding
-  "sonar-reasoning", // Quick problem-solving with step-by-step logic and search
-  "sonar-reasoning-pro", // Enhanced multi-step reasoning with web search
-  "sonar-deep-research", // Exhaustive research and detailed report generation
-
-  // Legacy models (deprecated - will be removed)
-  "sonar-small",
-  "sonar-small-online",
-  "sonar-medium-online",
-  "sonar-small-chat",
-  "sonar-medium-chat",
-
-  // OpenAI Embedding Models (use with OpenAI client directly)
-  "text-embedding-3-small", // Most capable small embedding model
-  "text-embedding-3-large", // Most capable large embedding model
-  "text-embedding-ada-002", // Legacy embedding model
-];

package/src/utils/constants/perplexityModels.ts

@@ -1,71 +0,0 @@
-// Perplexity AI Models (based on current models in utils)
-export const PERPLEXITY_MODELS = {
-  // Sonar Models (Chat Completions with online search)
-  SONAR_SMALL: "sonar-small",
-  SONAR_MEDIUM: "sonar-medium",
-  SONAR_PRO: "sonar-pro",
-
-  // Legacy Models (for V1 compatibility)
-  LLAMA_3_1_SONAR_SMALL: "llama-3.1-sonar-small-128k-online",
-  LLAMA_3_1_SONAR_LARGE: "llama-3.1-sonar-large-128k-online",
-  LLAMA_3_1_SONAR_HUGE: "llama-3.1-sonar-huge-128k-online",
-
-  // Chat Models (without online search)
-  LLAMA_3_1_8B: "llama-3.1-8b-instruct",
-  LLAMA_3_1_70B: "llama-3.1-70b-instruct",
-  LLAMA_3_1_405B: "llama-3.1-405b-instruct",
-} as const;
-
-export type PerplexityModel =
-  (typeof PERPLEXITY_MODELS)[keyof typeof PERPLEXITY_MODELS];
-
-// Default models for different operations
-export const DEFAULT_CHAT_MODEL = PERPLEXITY_MODELS.SONAR_PRO;
-
-// Model capabilities
-export const MODEL_CAPABILITIES: Record<
-  string,
-  {
-    chat: boolean;
-    streaming: boolean;
-    online: boolean;
-    contextWindow: number;
-  }
-> = {
-  [PERPLEXITY_MODELS.SONAR_SMALL]: {
-    chat: true,
-    streaming: true,
-    online: true,
-    contextWindow: 127072,
-  },
-  [PERPLEXITY_MODELS.SONAR_MEDIUM]: {
-    chat: true,
-    streaming: true,
-    online: true,
-    contextWindow: 127072,
-  },
-  [PERPLEXITY_MODELS.SONAR_PRO]: {
-    chat: true,
-    streaming: true,
-    online: true,
-    contextWindow: 127072,
-  },
-  [PERPLEXITY_MODELS.LLAMA_3_1_8B]: {
-    chat: true,
-    streaming: true,
-    online: false,
-    contextWindow: 131072,
-  },
-  [PERPLEXITY_MODELS.LLAMA_3_1_70B]: {
-    chat: true,
-    streaming: true,
-    online: false,
-    contextWindow: 131072,
-  },
-  [PERPLEXITY_MODELS.LLAMA_3_1_405B]: {
-    chat: true,
-    streaming: true,
-    online: false,
-    contextWindow: 131072,
-  },
-} as const;

package/src/utils/extractTokenCount.ts

@@ -1,26 +0,0 @@
-import { ITokenCounts } from "../interfaces/tokenCounts";
-import { logger } from "../models/Logger";
-import { safeExtract } from "./safeExtract";
-
-export function extractGoogleAITokenCounts(response: any): ITokenCounts {
-  console.log;
-  try {
-    const usageMetadata = response.usage || (response as any).response?.usage;
-    if (!usageMetadata)
-      return { inputTokens: 0, outputTokens: 0, totalTokens: 0 };
-
-    const inputTokens = safeExtract.number(usageMetadata, "prompt_tokens");
-    const outputTokens = safeExtract.number(usageMetadata, "completion_tokens");
-    const totalTokens = safeExtract.number(usageMetadata, "total_tokens");
-    return {
-      inputTokens,
-      outputTokens,
-      totalTokens,
-      cachedTokens: 0,
-      reasoningTokens: 0,
-    };
-  } catch (error) {
-    logger.warning("Failed to extract Google AI token counts:", error);
-    return { inputTokens: 0, outputTokens: 0, totalTokens: 0 };
-  }
-}

package/src/utils/formatTimestamp.ts

@@ -1,3 +0,0 @@
-export function formatTimestamp(date: Date): string {
-  return date.toISOString();
-}

package/src/utils/generateTransactionId.ts

@@ -1,5 +0,0 @@
-import { v4 as uuidv4 } from "uuid";
-
-export function generateTransactionId(): string {
-  return uuidv4();
-}

package/src/utils/index.ts

@@ -1,39 +0,0 @@
-import {
-  PERPLEXITY_API_KEY,
-  REVENIUM_METERING_API_KEY,
-  REVENIUM_METERING_BASE_URL,
-} from "./loadEnv";
-import {
-  PERPLEXITY_REQUIRED_API_KEY_MESSAGE,
-  PERPLEXITY_API_KEY_INVALID_MESSAGE,
-  PERPLEXITY_METERING_API_KEY_IS_NOT_SET_MESSAGE,
-  PERPLEXITY_METERING_BASE_URL_IS_NOT_SET_MESSAGE,
-  PERPLEXITY_CLIENT_INITIALIZED_MESSAGE,
-} from "./constants/messages";
-import { LOG_LEVELS } from "./constants/logLevels";
-import { models } from "./constants/models";
-import {
-  PERPLEXITY_API_BASE_URL,
-  COST_TYPE,
-  MIDDLEWARE_SOURCE,
-  PRODUCT_ID_FREE,
-  CURRENT_CREDENTIAL,
-} from "./constants/constants";
-
-export {
-  PERPLEXITY_API_KEY,
-  REVENIUM_METERING_API_KEY,
-  REVENIUM_METERING_BASE_URL,
-  PERPLEXITY_REQUIRED_API_KEY_MESSAGE,
-  PERPLEXITY_API_KEY_INVALID_MESSAGE,
-  LOG_LEVELS,
-  PERPLEXITY_METERING_API_KEY_IS_NOT_SET_MESSAGE,
-  PERPLEXITY_METERING_BASE_URL_IS_NOT_SET_MESSAGE,
-  PERPLEXITY_CLIENT_INITIALIZED_MESSAGE,
-  models,
-  PERPLEXITY_API_BASE_URL,
-  COST_TYPE,
-  MIDDLEWARE_SOURCE,
-  PRODUCT_ID_FREE,
-  CURRENT_CREDENTIAL,
-};

package/src/utils/loadEnv.ts

@@ -1,8 +0,0 @@
-import { config } from "dotenv";
-config();
-
-export const {
-  PERPLEXITY_API_KEY,
-  REVENIUM_METERING_API_KEY,
-  REVENIUM_METERING_BASE_URL,
-} = process.env;

package/src/utils/safeExtract.ts

@@ -1,67 +0,0 @@
-/**
- * Safe extraction utility functions.
- */
-export namespace safeExtract {
-  /**
-   * Safely extract a value from an object, returning undefined if the path doesn't exist.
-   */
-  export function get<T>(
-    obj: any,
-    path: string,
-    defaultValue?: T
-  ): T | undefined {
-    try {
-      const keys: string[] = path.split(".");
-      let result = obj;
-
-      for (const key of keys) {
-        if (result == null || typeof result !== "object") {
-          return defaultValue;
-        }
-        result = result[key];
-      }
-
-      return result ?? defaultValue;
-    } catch {
-      return defaultValue;
-    }
-  }
-
-  /**
-   * Safely extract a string value, returning empty string if not found.
-   */
-  export function string(obj: any, path: string): string {
-    return get(obj, path, "") || "";
-  }
-
-  /**
-   * Safely extract a number value, returning 0 if not found.
-   */
-  export function number(obj: any, path: string): number {
-    const value = get(obj, path, 0);
-    return typeof value === "number" ? value : 0;
-  }
-
-  /**
-   * Safely extract a boolean value, returning false if not found.
-   */
-  export function boolean(obj: any, path: string): boolean {
-    return get(obj, path, false) || false;
-  }
-
-  /**
-   * Safely extract an object value, returning empty object if not found.
-   */
-  export function object(obj: any, path: string): Record<string, any> {
-    const value = get(obj, path, {});
-    return typeof value === "object" && value !== null ? value : {};
-  }
-
-  /**
-   * Safely extract an array value, returning empty array if not found.
-   */
-  export function array(obj: any, path: string): any[] {
-    const value = get(obj, path, []);
-    return Array.isArray(value) ? value : [];
-  }
-}

package/src/v1/perplexityV1.controller.ts

@@ -1,164 +0,0 @@
-import { logger } from "../models/Logger";
-import { IUsageMetadata } from "../interfaces/usageMetadata";
-import {
-  IChatCompletionRequest,
-  IPerplexityMessage,
-} from "../interfaces/chatCompletionRequest";
-import { IPerplexityResponseChat } from "../interfaces/perplexityResponse";
-import { IPerplexityStreamingResponse } from "../interfaces/perplexityStreaming";
-import {
-  DEFAULT_CHAT_MODEL,
-  PERPLEXITY_MODELS,
-  MODEL_CAPABILITIES,
-} from "../utils/constants/perplexityModels";
-import { PerplexityV1Service } from "./perplexityV1.service";
-import { models } from "../utils";
-
-export class PerplexityV1Controller {
-  private service: PerplexityV1Service;
-
-  constructor() {
-    this.service = new PerplexityV1Service();
-    logger.info("Perplexity V1 Controller initialized");
-  }
-
-  /**
-   * Create a chat completion using Perplexity V1 API (Compatible with current middleware)
-   * @param messages Array of message strings or OpenAI message objects
-   * @param model Optional model name (defaults to sonar-pro)
-   * @param customMetadata Optional custom metadata for tracking
-   * @returns Promise<IPerplexityResponseChat>
-   */
-  async createChat(
-    messages: string[] | Array<{ role: string; content: string }>,
-    model: string = DEFAULT_CHAT_MODEL,
-    customMetadata?: IUsageMetadata
-  ): Promise<IPerplexityResponseChat> {
-    try {
-      // Normalize messages to OpenAI format
-      const normalizedMessages = this.normalizeMessages(messages);
-
-      // Validate model
-      this.validateModel(model);
-
-      // Create chat completion request
-      const request: IChatCompletionRequest = {
-        messages: normalizedMessages,
-        usageMetadata: customMetadata,
-      };
-
-      logger.info(
-        `Creating Perplexity V1 chat completion with model: ${model}`
-      );
-
-      return await this.service.createChatCompletion(request, model);
-    } catch (error) {
-      logger.error("Error in Perplexity V1 createChat:", error);
-      throw error;
-    }
-  }
-
-  /**
-   * Create a streaming chat completion using Perplexity V1 API (Compatible with current middleware)
-   * @param messages Array of message strings or OpenAI message objects
-   * @param model Optional model name (defaults to sonar-pro)
-   * @param customMetadata Optional custom metadata for tracking
-   * @returns Promise<IPerplexityStreamingResponse>
-   */
-  async createStreaming(
-    messages: string[] | Array<{ role: string; content: string }>,
-    model: string = DEFAULT_CHAT_MODEL,
-    customMetadata?: IUsageMetadata
-  ): Promise<IPerplexityStreamingResponse> {
-    try {
-      // Normalize messages to OpenAI format
-      const normalizedMessages = this.normalizeMessages(messages);
-
-      // Validate model
-      this.validateModel(model);
-
-      // Create streaming request
-      const request: IChatCompletionRequest = {
-        messages: normalizedMessages,
-        usageMetadata: customMetadata,
-      };
-
-      logger.info(
-        `Creating Perplexity V1 streaming completion with model: ${model}`
-      );
-
-      return await this.service.createStreamingCompletion(request, model);
-    } catch (error) {
-      logger.error("Error in Perplexity V1 createStreaming:", error);
-      throw error;
-    }
-  }
-
-  /**
-   * Get available models for Perplexity V1
-   * @returns Array of available model names
-   */
-  getAvailableModels(): string[] {
-    return models; // Use the existing models from utils
-  }
-
-  /**
-   * Check if a model supports a specific capability
-   * @param model Model name
-   * @param capability Capability to check (chat, streaming, online)
-   * @returns boolean
-   */
-  supportsCapability(
-    model: string,
-    capability: "chat" | "streaming" | "online"
-  ): boolean {
-    return MODEL_CAPABILITIES[model]?.[capability] || false;
-  }
-
-  /**
-   * Get model information including capabilities and context window
-   * @param model Model name
-   * @returns Model information object
-   */
-  getModelInfo(model: string) {
-    const capabilities = MODEL_CAPABILITIES[model];
-    if (!capabilities) {
-      throw new Error(`Model "${model}" is not supported`);
-    }
-
-    return {
-      model,
-      capabilities: {
-        chat: capabilities.chat,
-        streaming: capabilities.streaming,
-        online: capabilities.online,
-      },
-      contextWindow: capabilities.contextWindow,
-      version: "v1",
-    };
-  }
-
-  private normalizeMessages(
-    messages: string[] | Array<{ role: string; content: string }>
-  ): IPerplexityMessage[] {
-    if (Array.isArray(messages) && typeof messages[0] === "string") {
-      // Convert string array to message objects
-      return (messages as string[]).map((content, index) => ({
-        role: index === 0 ? "user" : "assistant",
-        content,
-      })) as IPerplexityMessage[];
-    }
-
-    return messages as IPerplexityMessage[];
-  }
-
-  private validateModel(model: string): void {
-    if (!models.includes(model)) {
-      throw new Error(
-        `Model "${model}" is not supported. Available models: ${models.join(
-          ", "
-        )}`
-      );
-    }
-  }
-}