@revenium/perplexity 1.0.23 → 2.0.1

package/src/index.ts

@@ -1,4 +0,0 @@
-import { config } from "dotenv";
-config();
-
-export * from "./middleware";

package/src/interfaces/chatCompletionRequest.ts

@@ -1,10 +0,0 @@
-import { ChatCompletionMessageParam } from "openai/resources/index";
-import { IUsageMetadata } from "./usageMetadata";
-
-export interface IChatCompletionRequest {
-  model?: string;
-  messages: ChatCompletionMessageParam[];
-  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,28 +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;
-}

package/src/interfaces/operation.ts

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

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;
-}

package/src/middleware.ts

@@ -1,157 +0,0 @@
-import OpenAI 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,
-        },
-        true
-      );
-      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,
-        },
-        false
-      );
-      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,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,114 +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: 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,
-    };
-  }
-
-  public sendMeteringData = async (
-    metering: IMeteringResponse
-  ): Promise<void> => {
-    try {
-      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/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/tsconfig.json

@@ -1,15 +0,0 @@
-{
-  "compilerOptions": {
-    "composite": true,
-    "declaration": true,
-    "outDir": "dist",
-    "rootDir": "src",
-    "module": "CommonJS",
-    "target": "ES2019",
-    "esModuleInterop": true,
-    "strict": true,
-    "skipLibCheck": true
-  },
-  "include": ["src"],
-  "exclude": ["node_modules", "dist"]
-}