@revenium/perplexity 2.0.9 → 2.1.1

package/dist/types/utils/prompt-extraction.d.ts

@@ -0,0 +1,29 @@
+import { UsageMetadata } from "../types/index.js";
+import { PerplexityChatRequest, PerplexityResponse } from "../types/function-parameters.js";
+export declare function getMaxPromptSize(): number;
+export interface PromptData {
+    systemPrompt?: string;
+    inputMessages?: string;
+    outputResponse?: string;
+    promptsTruncated: boolean;
+}
+/**
+ * Sanitizes common credential patterns from text.
+ *
+ * Redacts the following credential types:
+ * - OpenAI keys: sk-*, sk-proj-*, sk-ant-* (20+ chars)
+ * - Perplexity keys: pplx-* (20+ chars)
+ * - AWS access keys: AKIA* (20 chars)
+ * - GitHub tokens: ghp_*, ghs_* (36+ chars)
+ * - JWT tokens: eyJ*.eyJ*.*
+ * - Bearer tokens
+ * - Generic API keys, tokens, passwords, secrets (8-20+ chars)
+ *
+ * LIMITATIONS:
+ * - Shorter credentials may pass through unsanitized
+ * - Length constraints balance security with false positive prevention
+ */
+export declare function sanitizeCredentials(text: string): string;
+export declare function shouldCapturePrompts(metadata?: UsageMetadata): boolean;
+export declare function extractPrompts(params: PerplexityChatRequest, response: PerplexityResponse, metadata?: UsageMetadata): PromptData | null;
+//# sourceMappingURL=prompt-extraction.d.ts.map

package/dist/types/utils/prompt-extraction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt-extraction.d.ts","sourceRoot":"","sources":["../../../src/utils/prompt-extraction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EACL,qBAAqB,EACrB,kBAAkB,EACnB,MAAM,iCAAiC,CAAC;AAMzC,wBAAgB,gBAAgB,IAAI,MAAM,CAezC;AAED,MAAM,WAAW,UAAU;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,OAAO,CAAC;CAC3B;AAiBD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CA0DxD;AA0ED,wBAAgB,oBAAoB,CAAC,QAAQ,CAAC,EAAE,aAAa,GAAG,OAAO,CAgBtE;AAED,wBAAgB,cAAc,CAC5B,MAAM,EAAE,qBAAqB,EAC7B,QAAQ,EAAE,kBAAkB,EAC5B,QAAQ,CAAC,EAAE,aAAa,GACvB,UAAU,GAAG,IAAI,CAmCnB"}

package/examples/advanced.ts

@@ -15,8 +15,8 @@ async function main() {
 
   // Metadata for tracking
   const metadata: UsageMetadata = {
-    organizationId: "org-advanced-demo",
-    productId: "prod-perplexity-advanced",
+    organizationName: "org-advanced-demo",
+    productName: "prod-perplexity-advanced",
     taskType: "multi-turn-conversation",
     subscriber: {
       id: "user-advanced-001",
@@ -57,7 +57,7 @@ async function main() {
         max_tokens: 500,
         temperature: 0.7,
       },
-      metadata
+      metadata,
     );
 
   console.log(`Assistant: ${response1.choices[0].message.content}\n`);
@@ -85,7 +85,7 @@ async function main() {
       {
         ...metadata,
         taskType: "creative-generation",
-      }
+      },
     );
 
   console.log(`Assistant: ${response2.choices[0].message.content}\n`);
@@ -111,7 +111,7 @@ async function main() {
       {
         ...metadata,
         taskType: "reasoning",
-      }
+      },
     );
 
   console.log(`Assistant: ${response3.choices[0].message.content}\n`);

package/examples/basic.ts

@@ -12,8 +12,8 @@ async function main() {
   // Get client
   const client = GetClient();
   const metadata: UsageMetadata = {
-    organizationId: "org-basic-demo",
-    productId: "prod-perplexity-basic",
+    organizationName: "org-basic-demo",
+    productName: "prod-perplexity-basic",
   };
 
   // Create chat completion
@@ -32,7 +32,7 @@ async function main() {
         ],
         max_tokens: 1000,
       },
-      metadata
+      metadata,
     );
 
   // Display response

package/examples/getting_started.ts

@@ -12,8 +12,8 @@ async function main() {
   // Get client
   const client = GetClient();
   const metadata: UsageMetadata = {
-    organizationId: "org-getting-started",
-    productId: "prod-perplexity-getting-started",
+    organizationName: "org-getting-started",
+    productName: "prod-perplexity-getting-started",
   };
 
   // Create a simple chat completion
@@ -31,7 +31,7 @@ async function main() {
         ],
         max_tokens: 500,
       },
-      metadata
+      metadata,
     );
 
   console.log("Assistant:", response.choices[0]?.message?.content);

package/examples/metadata.ts

@@ -15,11 +15,11 @@ async function main() {
   // Optional metadata for advanced reporting, lineage tracking, and cost allocation
   const metadata: UsageMetadata = {
     // Organization & billing
-    organizationId: "org-metadata-demo",
+    organizationName: "org-metadata-demo",
     subscriptionId: "plan-premium-2025",
 
     // Product & task tracking
-    productId: "ai-assistant",
+    productName: "ai-assistant",
     taskType: "explanation-request",
     agent: "perplexity-metadata-chat-node",
 
@@ -55,7 +55,7 @@ async function main() {
         ],
         max_tokens: 1000,
       },
-      metadata
+      metadata,
     );
 
   // Display response

package/examples/prompt-capture.ts

@@ -0,0 +1,108 @@
+import { Configure, GetClient, UsageMetadata } from "../src/index.js";
+
+async function main() {
+  console.log("=== Perplexity Prompt Capture Example ===\n");
+
+  Configure({
+    reveniumApiKey: process.env.REVENIUM_METERING_API_KEY || "test-key",
+    reveniumBaseUrl: process.env.REVENIUM_METERING_BASE_URL,
+    perplexityApiKey: process.env.PERPLEXITY_API_KEY || "test-key",
+    capturePrompts: true,
+  });
+
+  const client = GetClient();
+
+  console.log("Example 1: Prompt capture enabled via config");
+  console.log("Making request with prompt capture enabled...\n");
+
+  try {
+    const metadata: UsageMetadata = {
+      organizationName: "org-prompt-capture-demo",
+      productName: "prod-perplexity-prompt-capture",
+    };
+
+    const response = await client
+      .chat()
+      .completions()
+      .create(
+        {
+          model: "sonar-pro",
+          messages: [
+            {
+              role: "system",
+              content:
+                "You are a helpful assistant that provides concise answers.",
+            },
+            {
+              role: "user",
+              content: "What is the capital of France?",
+            },
+          ],
+          max_tokens: 100,
+        },
+        metadata,
+      );
+
+    console.log("Response:", response.choices[0]?.message?.content);
+    console.log("\nPrompts captured and sent to Revenium API!");
+  } catch (error) {
+    console.error(
+      "Error:",
+      error instanceof Error ? error.message : String(error),
+    );
+  }
+
+  console.log("\n" + "=".repeat(50) + "\n");
+  console.log("Example 2: Prompt capture disabled via metadata override");
+  console.log("Making request with prompt capture disabled...\n");
+
+  try {
+    const metadata2: UsageMetadata = {
+      organizationName: "org-prompt-capture-demo",
+      productName: "prod-perplexity-prompt-capture",
+      capturePrompts: false,
+    };
+
+    const response2 = await client
+      .chat()
+      .completions()
+      .create(
+        {
+          model: "sonar-pro",
+          messages: [
+            {
+              role: "system",
+              content: "You are a helpful assistant.",
+            },
+            {
+              role: "user",
+              content: "What is 2+2?",
+            },
+          ],
+          max_tokens: 100,
+        },
+        metadata2,
+      );
+
+    console.log("Response:", response2.choices[0]?.message?.content);
+    console.log("\nPrompts NOT captured (overridden via metadata)!");
+  } catch (error) {
+    console.error(
+      "Error:",
+      error instanceof Error ? error.message : String(error),
+    );
+  }
+
+  console.log("\n" + "=".repeat(50) + "\n");
+  console.log("Example 3: Prompt capture with environment variable");
+  console.log("Set REVENIUM_CAPTURE_PROMPTS=true in your .env file\n");
+
+  console.log("✅ Prompt capture examples completed!");
+  console.log("\nConfiguration hierarchy:");
+  console.log("1. Per-call metadata (highest priority)");
+  console.log("2. Global config");
+  console.log("3. Environment variable REVENIUM_CAPTURE_PROMPTS");
+  console.log("4. Default: false (lowest priority)");
+}
+
+main().catch(console.error);

package/examples/stream.ts

@@ -32,13 +32,13 @@ async function main() {
       },
       {
         // Optional metadata
-        organizationId: "my-customers-name",
-        productId: "my-product",
+        organizationName: "my-customers-name",
+        productName: "my-product",
         subscriber: {
           id: "user-123",
           email: "user@example.com",
         },
-      }
+      },
     );
 
   // Process stream

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revenium/perplexity",
-  "version": "2.0.9",
+  "version": "2.1.1",
   "description": "NodeJS middleware for Perplexity AI API with Revenium metering",
   "homepage": "https://github.com/revenium/revenium-middleware-perplexity-node#readme",
   "bugs": {
@@ -46,6 +46,7 @@
     "example:metadata": "npx tsx examples/metadata.ts",
     "example:advanced": "npx tsx examples/advanced.ts",
     "example:stream": "npx tsx examples/stream.ts",
+    "example:prompt-capture": "npx tsx examples/prompt-capture.ts",
     "example": "npm run example:getting-started"
   },
   "keywords": [