@revenium/perplexity 2.0.2 → 2.0.4

package/dist/esm/index.js

@@ -36,7 +36,10 @@ export { initializePerplexityFromEnv, initializePerplexity, getPerplexityConfig,
 // ============================================================================
 export { createChatCompletion, createStreamingChatCompletion, } from "./core/wrapper/perplexity-client";
 export { generateTransactionId, buildMeteringData, sendMeteringData, } from "./core/tracking/metering";
-export { PERPLEXITY_MODELS, DEFAULT_MODEL } from "./types";
+// ============================================================================
+// Constants
+// ============================================================================
+export { PERPLEXITY_PATTERNS, DEFAULT_CONFIG, API_ENDPOINTS, MIDDLEWARE_INFO, } from "./constants";
 // ============================================================================
 // Utilities
 // ============================================================================

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,MAAM,EAAE,CAAC;AAET,+EAA+E;AAC/E,gBAAgB;AAChB,+EAA+E;AAE/E,OAAO,EACL,yBAAyB,EACzB,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,cAAc,GAEf,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EACL,2BAA2B,EAC3B,oBAAoB,EACpB,mBAAmB,GAEpB,MAAM,iCAAiC,CAAC;AAEzC,+EAA+E;AAC/E,WAAW;AACX,+EAA+E;AAE/E,OAAO,EACL,oBAAoB,EACpB,6BAA6B,GAC9B,MAAM,kCAAkC,CAAC;AAE1C,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,0BAA0B,CAAC;AAoBlC,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE3D,+EAA+E;AAC/E,YAAY;AACZ,+EAA+E;AAE/E,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,MAAM,EAAE,CAAC;AAET,+EAA+E;AAC/E,gBAAgB;AAChB,+EAA+E;AAE/E,OAAO,EACL,yBAAyB,EACzB,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,cAAc,GAEf,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EACL,2BAA2B,EAC3B,oBAAoB,EACpB,mBAAmB,GAEpB,MAAM,iCAAiC,CAAC;AAEzC,+EAA+E;AAC/E,WAAW;AACX,+EAA+E;AAE/E,OAAO,EACL,oBAAoB,EACpB,6BAA6B,GAC9B,MAAM,kCAAkC,CAAC;AAE1C,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,0BAA0B,CAAC;AAmBlC,+EAA+E;AAC/E,YAAY;AACZ,+EAA+E;AAE/E,OAAO,EACL,mBAAmB,EACnB,cAAc,EACd,aAAa,EACb,eAAe,GAChB,MAAM,aAAa,CAAC;AAErB,+EAA+E;AAC/E,YAAY;AACZ,+EAA+E;AAE/E,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/esm/types/index.js

@@ -1,18 +1,5 @@
 /**
  * TypeScript Type Definitions for Perplexity Middleware
  */
-// ============================================================================
-// Constants
-// ============================================================================
-export const PERPLEXITY_MODELS = {
-    // Sonar Models (Online)
-    SONAR: "sonar",
-    SONAR_PRO: "sonar-pro",
-    SONAR_REASONING: "sonar-reasoning",
-    // Chat Models (Offline)
-    LLAMA_3_1_SONAR_SMALL_128K_CHAT: "llama-3.1-sonar-small-128k-chat",
-    LLAMA_3_1_SONAR_LARGE_128K_CHAT: "llama-3.1-sonar-large-128k-chat",
-    LLAMA_3_1_SONAR_HUGE_128K_CHAT: "llama-3.1-sonar-huge-128k-chat",
-};
-export const DEFAULT_MODEL = PERPLEXITY_MODELS.SONAR_PRO;
+export {};
 //# sourceMappingURL=index.js.map

package/dist/esm/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AA4LH,+EAA+E;AAC/E,YAAY;AACZ,+EAA+E;AAE/E,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,wBAAwB;IACxB,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,WAAW;IACtB,eAAe,EAAE,iBAAiB;IAElC,wBAAwB;IACxB,+BAA+B,EAAE,iCAAiC;IAClE,+BAA+B,EAAE,iCAAiC;IAClE,8BAA8B,EAAE,gCAAgC;CACxD,CAAC;AAKX,MAAM,CAAC,MAAM,aAAa,GAAoB,iBAAiB,CAAC,SAAS,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/dist/types/constants.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Configuration constants for Revenium Perplexity middleware
+ * Centralizes all magic numbers and default values
+ */
+/**
+ * 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')."
+ */
+export declare const MIDDLEWARE_INFO: {
+    /** Package name */
+    readonly NAME: "@revenium/perplexity";
+    /** Package version */
+    readonly VERSION: "2.0.4";
+    /** Full middleware source identifier for API tracking */
+    readonly 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.
+ */
+export declare const PERPLEXITY_PATTERNS: {
+    /** Known Perplexity/OpenAI finish reasons */
+    readonly FINISH_REASONS: {
+        readonly STOP: "stop";
+        readonly LENGTH: "length";
+        readonly TOOL_CALLS: "tool_calls";
+        readonly CONTENT_FILTER: "content_filter";
+        readonly FUNCTION_CALL: "function_call";
+    };
+    /** Revenium stop reason mappings from Perplexity finish_reason to Revenium enum */
+    readonly REVENIUM_STOP_REASON_MAP: {
+        readonly stop: "END";
+        readonly length: "TOKEN_LIMIT";
+        readonly tool_calls: "END";
+        readonly content_filter: "END";
+        readonly function_call: "END";
+    };
+};
+/**
+ * Default configuration values
+ */
+export declare const DEFAULT_CONFIG: {
+    /** Default Revenium API base URL */
+    readonly REVENIUM_BASE_URL: "https://api.revenium.ai";
+    /** Default Perplexity API base URL */
+    readonly PERPLEXITY_BASE_URL: "https://api.perplexity.ai";
+};
+/**
+ * API endpoints
+ */
+export declare const API_ENDPOINTS: {
+    /** Revenium AI completions endpoint */
+    readonly AI_COMPLETIONS: "/meter/v2/ai/completions";
+};
+//# sourceMappingURL=constants.d.ts.map

package/dist/types/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe;IAC1B,mBAAmB;;IAEnB,sBAAsB;;IAEtB,yDAAyD;;CAEjD,CAAC;AAEX;;;;;;;;;;GAUG;AACH,eAAO,MAAM,mBAAmB;IAC9B,6CAA6C;;;;;;;;IAS7C,mFAAmF;;;;;;;;CAQ3E,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,cAAc;IACzB,oCAAoC;;IAGpC,sCAAsC;;CAE9B,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,aAAa;IACxB,uCAAuC;;CAE/B,CAAC"}

package/dist/types/core/tracking/metering.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"metering.d.ts","sourceRoot":"","sources":["../../../../src/core/tracking/metering.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE/D;;GAEG;AACH,wBAAgB,qBAAqB,IAAI,MAAM,CAE9C;AAgBD;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,IAAI,CAAC;IAChB,OAAO,EAAE,IAAI,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,GAAG,YAAY,CAuFf;AAED;;GAEG;AACH,wBAAsB,gBAAgB,CACpC,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,IAAI,CAAC,CA0Cf"}
+{"version":3,"file":"metering.d.ts","sourceRoot":"","sources":["../../../../src/core/tracking/metering.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG/D;;GAEG;AACH,wBAAgB,qBAAqB,IAAI,MAAM,CAE9C;AAsGD;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,IAAI,CAAC;IAChB,OAAO,EAAE,IAAI,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,GAAG,YAAY,CA+Ff;AAED;;GAEG;AACH,wBAAsB,gBAAgB,CACpC,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,IAAI,CAAC,CA0Cf"}

package/dist/types/index.d.ts

@@ -28,7 +28,7 @@ export { initializeReveniumFromEnv, initializeRevenium, getReveniumConfig, isRev
 export { initializePerplexityFromEnv, initializePerplexity, getPerplexityConfig, type PerplexityConfig, } from "./core/config/perplexity-config";
 export { createChatCompletion, createStreamingChatCompletion, } from "./core/wrapper/perplexity-client";
 export { generateTransactionId, buildMeteringData, sendMeteringData, } from "./core/tracking/metering";
-export type { PerplexityMessage, PerplexityChatRequest, PerplexityUsage, PerplexityChoice, PerplexityResponse, PerplexityStreamChunk, UsageMetadata, MeteringData, ChatCompletionResult, StreamingResult, PerplexityModel, } from "./types";
-export { PERPLEXITY_MODELS, DEFAULT_MODEL } from "./types";
+export type { PerplexityMessage, PerplexityChatRequest, PerplexityUsage, PerplexityChoice, PerplexityResponse, PerplexityStreamChunk, UsageMetadata, MeteringData, ChatCompletionResult, StreamingResult, } from "./types";
+export { PERPLEXITY_PATTERNS, DEFAULT_CONFIG, API_ENDPOINTS, MIDDLEWARE_INFO, } from "./constants";
 export { logger } from "./utils/logger";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AASH,OAAO,EACL,yBAAyB,EACzB,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,KAAK,cAAc,GACpB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EACL,2BAA2B,EAC3B,oBAAoB,EACpB,mBAAmB,EACnB,KAAK,gBAAgB,GACtB,MAAM,iCAAiC,CAAC;AAMzC,OAAO,EACL,oBAAoB,EACpB,6BAA6B,GAC9B,MAAM,kCAAkC,CAAC;AAE1C,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,0BAA0B,CAAC;AAMlC,YAAY,EACV,iBAAiB,EACjB,qBAAqB,EACrB,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,qBAAqB,EACrB,aAAa,EACb,YAAY,EACZ,oBAAoB,EACpB,eAAe,EACf,eAAe,GAChB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAM3D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AASH,OAAO,EACL,yBAAyB,EACzB,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,KAAK,cAAc,GACpB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EACL,2BAA2B,EAC3B,oBAAoB,EACpB,mBAAmB,EACnB,KAAK,gBAAgB,GACtB,MAAM,iCAAiC,CAAC;AAMzC,OAAO,EACL,oBAAoB,EACpB,6BAA6B,GAC9B,MAAM,kCAAkC,CAAC;AAE1C,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,0BAA0B,CAAC;AAMlC,YAAY,EACV,iBAAiB,EACjB,qBAAqB,EACrB,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,qBAAqB,EACrB,aAAa,EACb,YAAY,EACZ,oBAAoB,EACpB,eAAe,GAChB,MAAM,SAAS,CAAC;AAMjB,OAAO,EACL,mBAAmB,EACnB,cAAc,EACd,aAAa,EACb,eAAe,GAChB,MAAM,aAAa,CAAC;AAMrB,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/types/types/index.d.ts

@@ -57,6 +57,7 @@ export interface UsageMetadata {
         };
     };
     organizationId?: string;
+    subscriptionId?: string;
     productId?: string;
     transactionId?: string;
     traceId?: string;
@@ -75,6 +76,7 @@ export interface UsageMetadata {
     agent?: string;
     stopReason?: string;
     costType?: string;
+    responseQualityScore?: number;
     subscriberId?: string;
     subscriberEmail?: string;
     subscriberCredentialName?: string;
@@ -115,7 +117,7 @@ export interface MeteringData {
     requestTime: string;
     completionStartTime: string;
     timeToFirstToken: number;
-    middleware_source: string;
+    middlewareSource: string;
     traceId?: string;
 }
 export interface ChatCompletionResult {
@@ -146,14 +148,4 @@ export interface PerplexityConfig {
     apiKey: string;
     baseUrl: string;
 }
-export declare const PERPLEXITY_MODELS: {
-    readonly SONAR: "sonar";
-    readonly SONAR_PRO: "sonar-pro";
-    readonly SONAR_REASONING: "sonar-reasoning";
-    readonly LLAMA_3_1_SONAR_SMALL_128K_CHAT: "llama-3.1-sonar-small-128k-chat";
-    readonly LLAMA_3_1_SONAR_LARGE_128K_CHAT: "llama-3.1-sonar-large-128k-chat";
-    readonly LLAMA_3_1_SONAR_HUGE_128K_CHAT: "llama-3.1-sonar-huge-128k-chat";
-};
-export type PerplexityModel = (typeof PERPLEXITY_MODELS)[keyof typeof PERPLEXITY_MODELS];
-export declare const DEFAULT_MODEL: PerplexityModel;
 //# sourceMappingURL=index.d.ts.map

package/dist/types/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAC;IACtC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,eAAe;IAC9B,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE;QACR,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,KAAK,CAAC,EAAE;QACN,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,gBAAgB,EAAE,CAAC;CAC7B;AAMD,MAAM,WAAW,aAAa;IAE5B,UAAU,CAAC,EAAE;QACX,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,UAAU,CAAC,EAAE;YACX,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;IAGF,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IAGnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IAGjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAG7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAG1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAGlB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,uBAAuB,EAAE,MAAM,CAAC;IAChC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE;QACV,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,UAAU,EAAE;YACV,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;IACF,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAMD,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,KAAK,EAAE;QACL,YAAY,EAAE,MAAM,CAAC;QACrB,gBAAgB,EAAE,MAAM,CAAC;QACzB,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,kBAAkB,CAAC;CACjC;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,cAAc,CAAC,qBAAqB,CAAC,CAAC;IAC9C,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;CACf;AAMD,MAAM,WAAW,cAAc;IAC7B,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAMD,eAAO,MAAM,iBAAiB;;;;;;;CAUpB,CAAC;AAEX,MAAM,MAAM,eAAe,GACzB,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAC;AAE7D,eAAO,MAAM,aAAa,EAAE,eAA6C,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAC;IACtC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,eAAe;IAC9B,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE;QACR,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,KAAK,CAAC,EAAE;QACN,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,gBAAgB,EAAE,CAAC;CAC7B;AAMD,MAAM,WAAW,aAAa;IAE5B,UAAU,CAAC,EAAE;QACX,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,UAAU,CAAC,EAAE;YACX,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;IAGF,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IAGnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IAGjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAG7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAG1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAG9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,uBAAuB,EAAE,MAAM,CAAC;IAChC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE;QACV,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,UAAU,EAAE;YACV,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;IACF,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,gBAAgB,EAAE,MAAM,CAAC;IACzB,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAMD,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,KAAK,EAAE;QACL,YAAY,EAAE,MAAM,CAAC;QACrB,gBAAgB,EAAE,MAAM,CAAC;QACzB,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,kBAAkB,CAAC;CACjC;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,cAAc,CAAC,qBAAqB,CAAC,CAAC;IAC9C,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;CACf;AAMD,MAAM,WAAW,cAAc;IAC7B,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/examples/README.md

@@ -0,0 +1,322 @@
+# Running Examples - Revenium Middleware for Perplexity (Node.js)
+
+This guide shows you how to run the Node.js/TypeScript examples in this repository.
+
+## Prerequisites
+
+- Node.js 20+ installed
+- Perplexity API key
+- Revenium API key
+
+## Setup
+
+### 1. Clone the Repository
+
+```bash
+git clone https://github.com/revenium/revenium-middleware-perplexity-node.git
+cd revenium-middleware-perplexity-node
+```
+
+### 2. Install Dependencies
+
+```bash
+npm install
+```
+
+### 3. Configure Environment Variables
+
+Create a `.env` file in the root directory:
+
+```bash
+# Create .env file
+cp .env.example .env
+```
+
+See [`.env.example`](https://github.com/revenium/revenium-middleware-perplexity-node/blob/HEAD/.env.example) for the complete list of environment variables and where to get your API keys.
+
+**Replace the placeholder values with your actual keys!**
+
+## Running Examples
+
+### Available Examples
+
+```bash
+npm run example:basic            # Basic chat completion
+npm run example:streaming        # Streaming response
+npm run example:chat             # Multi-turn conversation
+npm run example:metadata         # With custom metadata
+npm run example:advanced         # Advanced features
+npm run example:getting-started  # Quick start example
+npm test                         # Run all examples
+```
+
+## Example Structure
+
+```
+examples/
+├── basic.ts                 # Basic chat completion
+├── streaming.ts             # Streaming response
+├── chat.ts                  # Multi-turn conversation
+├── metadata.ts              # With custom metadata
+├── advanced-features.ts     # Advanced features
+├── getting_started.ts       # Quick start example
+└── README.md                # This file
+```
+
+## Examples Included
+
+### 1. Basic Usage
+
+**Location**: `examples/basic.ts`
+
+**What it demonstrates:**
+
+- Simple chat completion
+- Automatic metering
+- Basic error handling
+
+**Run it:**
+
+```bash
+npm run example:basic
+```
+
+**Expected output:**
+
+```
+✓ Chat Completion Successful
+Response: [AI response here]
+Model: sonar-pro
+Tokens Used: 50 (prompt: 10, completion: 40)
+```
+
+---
+
+### 2. Streaming
+
+**Location**: `examples/streaming.ts`
+
+**What it demonstrates:**
+
+- Real-time streaming responses
+- Token tracking for streamed content
+- Automatic usage tracking when stream completes
+
+**Run it:**
+
+```bash
+npm run example:streaming
+```
+
+**Expected output:**
+
+```
+Model: sonar-pro
+Streaming response:
+
+[Streaming text appears here in real-time]
+
+✓ Streaming completed
+```
+
+---
+
+### 3. Multi-turn Chat
+
+**Location**: `examples/chat.ts`
+
+**What it demonstrates:**
+
+- Conversation history management
+- Context-aware responses
+- Multi-message interactions
+
+**Run it:**
+
+```bash
+npm run example:chat
+```
+
+**Expected output:**
+
+```
+--- Turn 1 ---
+User: What is the capital of France?
+Assistant: [Response]
+
+--- Turn 2 ---
+User: What is its population?
+Assistant: [Response]
+
+✓ Chat completed - Total tokens used: 120
+```
+
+---
+
+### 4. Custom Metadata
+
+**Location**: `examples/metadata.ts`
+
+**What it demonstrates:**
+
+- Custom metadata tracking
+- Business context in metering
+- Subscriber and organization tracking
+
+**Run it:**
+
+```bash
+npm run example:metadata
+```
+
+**Expected output:**
+
+```
+✓ Chat Completion Successful
+Response: [AI response]
+Model: sonar-pro
+Tokens Used: 50 (prompt: 10, completion: 40)
+Metadata tracked: subscriber, organization, product, agent, trace
+```
+
+**Note:** Custom metadata (subscriber, organizationId, productId, agent, traceId) is automatically sent to Revenium in the background.
+
+---
+
+// Manual configuration
+initializeRevenium({
+meteringApiKey: process.env.REVENIUM_METERING_API_KEY!,
+meteringBaseUrl:
+process.env.REVENIUM_METERING_BASE_URL || "https://api.revenium.ai",
+});
+
+**Location**: `examples/advanced-features.ts`
+
+**What it demonstrates:**
+
+- Streaming with metadata
+- Multiple model comparisons
+- Advanced configuration
+
+**Run it:**
+
+```bash
+npm run example:advanced
+```
+
+**Expected output:**
+
+```
+=== Advanced Features Example ===
+
+--- Streaming Responses ---
+Model: sonar-pro
+Response:
+[Streaming text appears here in real-time]
+✓ Streaming completed
+
+--- Comprehensive Metadata Tracking ---
+Response: [First 100 characters]...
+✓ Metadata tracked successfully
+
+--- Multiple Model Types ---
+Using sonar (lightweight search)...
+Response: [First 80 characters]...
+
+Using sonar-reasoning (real-time reasoning)...
+Response: [First 80 characters]...
+
+✓ Multiple models demonstrated
+
+=== All Advanced Features Demonstrated ===
+```
+
+---
+
+### 6. Getting Started
+
+**Location**: `examples/getting_started.ts`
+
+**What it demonstrates:**
+
+- Quick start example
+- Minimal configuration
+- Basic usage pattern
+
+**Run it:**
+
+```bash
+npm run example:getting-started
+```
+
+---
+
+## Troubleshooting
+
+### "Missing API Key" Error
+
+Make sure you've created a `.env` file with your API keys:
+
+```bash
+# Check if .env exists
+ls .env
+
+# Verify it has the required keys
+cat .env
+```
+
+### "Module not found" Error
+
+Install dependencies first:
+
+```bash
+npm install
+```
+
+### "Requests not being tracked"
+
+1. Check your `.env` file has correct values:
+
+   - `PERPLEXITY_API_KEY` is set
+   - `REVENIUM_METERING_API_KEY` is set
+   - `REVENIUM_METERING_BASE_URL` is set to `https://api.revenium.ai`
+
+2. Enable debug logging:
+
+```bash
+DEBUG=true npm run example:basic
+```
+
+### TypeScript Errors
+
+Ensure you have TypeScript and tsx installed:
+
+```bash
+npm install -D typescript tsx @types/node
+```
+
+---
+
+## Getting Your API Keys
+
+### Perplexity API Key
+
+1. Go to [Perplexity AI Settings](https://www.perplexity.ai/settings/api)
+2. Create a new API key
+3. Add to `.env` as `PERPLEXITY_API_KEY`
+
+### Revenium API Key
+
+1. Sign up at [Revenium](https://ai.revenium.io)
+2. Create a new API key in your dashboard
+3. Add to `.env` as `REVENIUM_METERING_API_KEY`
+
+---
+
+## Support
+
+For issues or questions:
+
+- [GitHub Issues](https://github.com/revenium/revenium-middleware-perplexity-node/issues)
+- [Documentation](https://docs.revenium.io)
+- Contact: Reach out to the Revenium team for additional support

package/examples/advanced-features.ts

@@ -0,0 +1,148 @@
+/**
+ * Advanced Features Example
+ *
+ * This example demonstrates advanced middleware features:
+ * - Streaming responses with real-time content
+ * - Comprehensive metadata for analytics
+ * - Multiple model types (search, reasoning, research)
+ * - Session and quality tracking
+ *
+ * For complete documentation, see:
+ * https://revenium.readme.io/reference/meter_ai_completion
+ */
+
+import {
+  initializeReveniumFromEnv,
+  initializePerplexityFromEnv,
+  createChatCompletion,
+  createStreamingChatCompletion,
+  UsageMetadata,
+} from "../src";
+
+async function demonstrateStreaming() {
+  console.log("\n--- Streaming Responses ---");
+  const usageMetadata: UsageMetadata = {
+    subscriber: { id: "user-streaming-demo" },
+    traceId: "streaming-session-" + Date.now(),
+    taskType: "list-generation",
+  };
+
+  const result = await createStreamingChatCompletion({
+    messages: [
+      {
+        role: "user",
+        content: "List the first 3 planets in our solar system.",
+      },
+    ],
+    model: "sonar-pro",
+    maxTokens: 400,
+    usageMetadata,
+  });
+
+  console.log(`Model: ${result.model}`);
+  console.log("Response: ");
+
+  let fullContent = "";
+  for await (const chunk of result.stream) {
+    const content = chunk.choices[0]?.delta?.content || "";
+    if (content) {
+      process.stdout.write(content);
+      fullContent += content;
+    }
+  }
+
+  console.log("\n✓ Streaming completed\n");
+}
+
+async function demonstrateComprehensiveMetadata() {
+  console.log("\n--- Comprehensive Metadata Tracking ---");
+
+  const usageMetadata: UsageMetadata = {
+    traceId: "session-advanced-demo-" + Date.now(),
+    taskType: "educational-query",
+    subscriber: {
+      id: "user-456",
+      email: "advanced-user@example.com",
+      credential: {
+        name: "premium-api-key",
+        value: "key-premium-abc123",
+      },
+    },
+    organizationId: "org-enterprise-789",
+    subscriptionId: "sub-enterprise-2024",
+    productId: "learning-platform",
+    agent: "educational-assistant-v2",
+    responseQualityScore: 0.92,
+  };
+
+  const result = await createChatCompletion({
+    messages: [
+      {
+        role: "user",
+        content: "What is machine learning?",
+      },
+    ],
+    model: "sonar-pro",
+    maxTokens: 400,
+    usageMetadata,
+  });
+
+  console.log(`Response: ${result.content.substring(0, 100)}...`);
+  console.log(`✓ Metadata tracked successfully\n`);
+}
+
+async function demonstrateMultipleModels() {
+  console.log("\n--- Multiple Model Types ---");
+
+  const usageMetadata: UsageMetadata = {
+    subscriber: { id: "model-comparison-user" },
+    taskType: "weather-search",
+  };
+
+  // Search model
+  console.log("Using sonar (lightweight search)...");
+  const searchResult = await createChatCompletion({
+    messages: [{ role: "user", content: "Current weather in Tokyo" }],
+    model: "sonar-pro",
+    maxTokens: 400,
+    usageMetadata,
+  });
+  console.log(`Response: ${searchResult.content.substring(0, 80)}...`);
+
+  // Reasoning model
+  console.log("\nUsing sonar-reasoning (real-time reasoning)...");
+  const reasoningResult = await createChatCompletion({
+    messages: [
+      { role: "user", content: "Why is the sky blue? Explain briefly." },
+    ],
+    model: "sonar-reasoning",
+    maxTokens: 400,
+    usageMetadata: {
+      ...usageMetadata,
+      taskType: "reasoning-query",
+    },
+  });
+  console.log(`Response: ${reasoningResult.content.substring(0, 80)}...`);
+
+  console.log("\n✓ Multiple models demonstrated\n");
+}
+
+async function main() {
+  console.log("\n=== Advanced Features Example ===");
+
+  // Initialize configurations
+  initializeReveniumFromEnv();
+  initializePerplexityFromEnv();
+
+  // Demonstrate features
+  await demonstrateStreaming();
+  await demonstrateComprehensiveMetadata();
+  await demonstrateMultipleModels();
+
+  console.log("=== All Advanced Features Demonstrated ===\n");
+}
+
+main().catch((error) => {
+  console.error("\nError:", error.message);
+  process.exit(1);
+});