@posthog/ai 6.3.1 → 6.3.3

package/dist/openai/index.mjs

@@ -1,8 +1,8 @@
 import { OpenAI } from 'openai';
-import { v4 } from 'uuid';
 import { Buffer } from 'buffer';
+import { v4 } from 'uuid';
 
-var version = "6.3.1";
+var version = "6.3.3";
 
 const STRING_FORMAT = 'utf8';
 const getModelParams = params => {
@@ -143,6 +143,41 @@ function sanitizeValues(obj) {
   }
   return jsonSafe;
 }
+const POSTHOG_PARAMS_MAP = {
+  posthogDistinctId: 'distinctId',
+  posthogTraceId: 'traceId',
+  posthogProperties: 'properties',
+  posthogPrivacyMode: 'privacyMode',
+  posthogGroups: 'groups',
+  posthogModelOverride: 'modelOverride',
+  posthogProviderOverride: 'providerOverride',
+  posthogCostOverride: 'costOverride',
+  posthogCaptureImmediate: 'captureImmediate'
+};
+function extractPosthogParams(body) {
+  const providerParams = {};
+  const posthogParams = {};
+  for (const [key, value] of Object.entries(body)) {
+    if (POSTHOG_PARAMS_MAP[key]) {
+      posthogParams[POSTHOG_PARAMS_MAP[key]] = value;
+    } else if (key.startsWith('posthog')) {
+      console.warn(`Unknown Posthog parameter ${key}`);
+    } else {
+      providerParams[key] = value;
+    }
+  }
+  return {
+    providerParams: providerParams,
+    posthogParams: addDefaults(posthogParams)
+  };
+}
+function addDefaults(params) {
+  return {
+    ...params,
+    privacyMode: params.privacyMode ?? false,
+    traceId: params.traceId ?? v4()
+  };
+}
 const sendEventToPosthog = async ({
   client,
   eventType = AIEvent.Generation,
@@ -400,12 +435,9 @@ class WrappedCompletions extends Completions {
   // --- Implementation Signature
   create(body, options) {
     const {
-      posthogDistinctId,
-      posthogTraceId,
-      posthogCaptureImmediate,
-      ...openAIParams
-    } = body;
-    const traceId = posthogTraceId ?? v4();
+      providerParams: openAIParams,
+      posthogParams
+    } = extractPosthogParams(body);
     const startTime = Date.now();
     const parentPromise = super.create(openAIParams, options);
     if (openAIParams.stream) {
@@ -511,8 +543,7 @@ class WrappedCompletions extends Completions {
               const availableTools = extractAvailableToolCalls('openai', openAIParams);
               await sendEventToPosthog({
                 client: this.phClient,
-                distinctId: posthogDistinctId,
-                traceId,
+                ...posthogParams,
                 model: openAIParams.model,
                 provider: 'openai',
                 input: sanitizeOpenAI(openAIParams.messages),
@@ -522,15 +553,13 @@ class WrappedCompletions extends Completions {
                 params: body,
                 httpStatus: 200,
                 usage,
-                tools: availableTools,
-                captureImmediate: posthogCaptureImmediate
+                tools: availableTools
               });
             } catch (error) {
               const httpStatus = error && typeof error === 'object' && 'status' in error ? error.status ?? 500 : 500;
               await sendEventToPosthog({
                 client: this.phClient,
-                distinctId: posthogDistinctId,
-                traceId,
+                ...posthogParams,
                 model: openAIParams.model,
                 provider: 'openai',
                 input: sanitizeOpenAI(openAIParams.messages),
@@ -544,8 +573,7 @@ class WrappedCompletions extends Completions {
                   outputTokens: 0
                 },
                 isError: true,
-                error: JSON.stringify(error),
-                captureImmediate: posthogCaptureImmediate
+                error: JSON.stringify(error)
               });
             }
           })();
@@ -562,8 +590,7 @@ class WrappedCompletions extends Completions {
           const availableTools = extractAvailableToolCalls('openai', openAIParams);
           await sendEventToPosthog({
             client: this.phClient,
-            distinctId: posthogDistinctId,
-            traceId,
+            ...posthogParams,
             model: openAIParams.model,
             provider: 'openai',
             input: sanitizeOpenAI(openAIParams.messages),
@@ -578,8 +605,7 @@ class WrappedCompletions extends Completions {
               reasoningTokens: result.usage?.completion_tokens_details?.reasoning_tokens ?? 0,
               cacheReadInputTokens: result.usage?.prompt_tokens_details?.cached_tokens ?? 0
             },
-            tools: availableTools,
-            captureImmediate: posthogCaptureImmediate
+            tools: availableTools
           });
         }
         return result;
@@ -587,8 +613,7 @@ class WrappedCompletions extends Completions {
         const httpStatus = error && typeof error === 'object' && 'status' in error ? error.status ?? 500 : 500;
         await sendEventToPosthog({
           client: this.phClient,
-          distinctId: posthogDistinctId,
-          traceId,
+          ...posthogParams,
           model: openAIParams.model,
           provider: 'openai',
           input: sanitizeOpenAI(openAIParams.messages),
@@ -602,8 +627,7 @@ class WrappedCompletions extends Completions {
             outputTokens: 0
           },
           isError: true,
-          error: JSON.stringify(error),
-          captureImmediate: posthogCaptureImmediate
+          error: JSON.stringify(error)
         });
         throw error;
       });
@@ -627,12 +651,9 @@ class WrappedResponses extends Responses {
   // --- Implementation Signature
   create(body, options) {
     const {
-      posthogDistinctId,
-      posthogTraceId,
-      posthogCaptureImmediate,
-      ...openAIParams
-    } = body;
-    const traceId = posthogTraceId ?? v4();
+      providerParams: openAIParams,
+      posthogParams
+    } = extractPosthogParams(body);
     const startTime = Date.now();
     const parentPromise = super.create(openAIParams, options);
     if (openAIParams.stream) {
@@ -663,8 +684,7 @@ class WrappedResponses extends Responses {
               const availableTools = extractAvailableToolCalls('openai', openAIParams);
               await sendEventToPosthog({
                 client: this.phClient,
-                distinctId: posthogDistinctId,
-                traceId,
+                ...posthogParams,
                 //@ts-expect-error
                 model: openAIParams.model,
                 provider: 'openai',
@@ -675,15 +695,13 @@ class WrappedResponses extends Responses {
                 params: body,
                 httpStatus: 200,
                 usage,
-                tools: availableTools,
-                captureImmediate: posthogCaptureImmediate
+                tools: availableTools
               });
             } catch (error) {
               const httpStatus = error && typeof error === 'object' && 'status' in error ? error.status ?? 500 : 500;
               await sendEventToPosthog({
                 client: this.phClient,
-                distinctId: posthogDistinctId,
-                traceId,
+                ...posthogParams,
                 //@ts-expect-error
                 model: openAIParams.model,
                 provider: 'openai',
@@ -698,8 +716,7 @@ class WrappedResponses extends Responses {
                   outputTokens: 0
                 },
                 isError: true,
-                error: JSON.stringify(error),
-                captureImmediate: posthogCaptureImmediate
+                error: JSON.stringify(error)
               });
             }
           })();
@@ -714,8 +731,7 @@ class WrappedResponses extends Responses {
           const availableTools = extractAvailableToolCalls('openai', openAIParams);
           await sendEventToPosthog({
             client: this.phClient,
-            distinctId: posthogDistinctId,
-            traceId,
+            ...posthogParams,
             //@ts-expect-error
             model: openAIParams.model,
             provider: 'openai',
@@ -733,8 +749,7 @@ class WrappedResponses extends Responses {
               reasoningTokens: result.usage?.output_tokens_details?.reasoning_tokens ?? 0,
               cacheReadInputTokens: result.usage?.input_tokens_details?.cached_tokens ?? 0
             },
-            tools: availableTools,
-            captureImmediate: posthogCaptureImmediate
+            tools: availableTools
           });
         }
         return result;
@@ -742,8 +757,7 @@ class WrappedResponses extends Responses {
         const httpStatus = error && typeof error === 'object' && 'status' in error ? error.status ?? 500 : 500;
         await sendEventToPosthog({
           client: this.phClient,
-          distinctId: posthogDistinctId,
-          traceId,
+          ...posthogParams,
           //@ts-expect-error
           model: openAIParams.model,
           provider: 'openai',
@@ -758,8 +772,7 @@ class WrappedResponses extends Responses {
             outputTokens: 0
           },
           isError: true,
-          error: JSON.stringify(error),
-          captureImmediate: posthogCaptureImmediate
+          error: JSON.stringify(error)
         });
         throw error;
       });
@@ -768,12 +781,9 @@ class WrappedResponses extends Responses {
   }
   parse(body, options) {
     const {
-      posthogDistinctId,
-      posthogTraceId,
-      posthogCaptureImmediate,
-      ...openAIParams
-    } = body;
-    const traceId = posthogTraceId ?? v4();
+      providerParams: openAIParams,
+      posthogParams
+    } = extractPosthogParams(body);
     const startTime = Date.now();
 
     // Create a temporary instance that bypasses our wrapped create method
@@ -787,8 +797,7 @@ class WrappedResponses extends Responses {
         const latency = (Date.now() - startTime) / 1000;
         await sendEventToPosthog({
           client: this.phClient,
-          distinctId: posthogDistinctId,
-          traceId,
+          ...posthogParams,
           //@ts-expect-error
           model: openAIParams.model,
           provider: 'openai',
@@ -803,16 +812,14 @@ class WrappedResponses extends Responses {
             outputTokens: result.usage?.output_tokens ?? 0,
             reasoningTokens: result.usage?.output_tokens_details?.reasoning_tokens ?? 0,
             cacheReadInputTokens: result.usage?.input_tokens_details?.cached_tokens ?? 0
-          },
-          captureImmediate: posthogCaptureImmediate
+          }
         });
         return result;
       }, async error => {
         const httpStatus = error && typeof error === 'object' && 'status' in error ? error.status ?? 500 : 500;
         await sendEventToPosthog({
           client: this.phClient,
-          distinctId: posthogDistinctId,
-          traceId,
+          ...posthogParams,
           //@ts-expect-error
           model: openAIParams.model,
           provider: 'openai',
@@ -827,8 +834,7 @@ class WrappedResponses extends Responses {
             outputTokens: 0
           },
           isError: true,
-          error: JSON.stringify(error),
-          captureImmediate: posthogCaptureImmediate
+          error: JSON.stringify(error)
         });
         throw error;
       });
@@ -847,25 +853,20 @@ class WrappedEmbeddings extends Embeddings {
   }
   create(body, options) {
     const {
-      posthogDistinctId,
-      posthogTraceId,
-      posthogPrivacyMode = false,
-      posthogCaptureImmediate,
-      ...openAIParams
-    } = body;
-    const traceId = posthogTraceId ?? v4();
+      providerParams: openAIParams,
+      posthogParams
+    } = extractPosthogParams(body);
     const startTime = Date.now();
     const parentPromise = super.create(openAIParams, options);
     const wrappedPromise = parentPromise.then(async result => {
       const latency = (Date.now() - startTime) / 1000;
       await sendEventToPosthog({
         client: this.phClient,
+        ...posthogParams,
         eventType: AIEvent.Embedding,
-        distinctId: posthogDistinctId,
-        traceId,
         model: openAIParams.model,
         provider: 'openai',
-        input: withPrivacyMode(this.phClient, posthogPrivacyMode, openAIParams.input),
+        input: withPrivacyMode(this.phClient, posthogParams.privacyMode, openAIParams.input),
         output: null,
         // Embeddings don't have output content
         latency,
@@ -874,8 +875,7 @@ class WrappedEmbeddings extends Embeddings {
         httpStatus: 200,
         usage: {
           inputTokens: result.usage?.prompt_tokens ?? 0
-        },
-        captureImmediate: posthogCaptureImmediate
+        }
       });
       return result;
     }, async error => {
@@ -883,11 +883,10 @@ class WrappedEmbeddings extends Embeddings {
       await sendEventToPosthog({
         client: this.phClient,
         eventType: AIEvent.Embedding,
-        distinctId: posthogDistinctId,
-        traceId,
+        ...posthogParams,
         model: openAIParams.model,
         provider: 'openai',
-        input: withPrivacyMode(this.phClient, posthogPrivacyMode, openAIParams.input),
+        input: withPrivacyMode(this.phClient, posthogParams.privacyMode, openAIParams.input),
         output: null,
         // Embeddings don't have output content
         latency: 0,
@@ -898,8 +897,7 @@ class WrappedEmbeddings extends Embeddings {
           inputTokens: 0
         },
         isError: true,
-        error: JSON.stringify(error),
-        captureImmediate: posthogCaptureImmediate
+        error: JSON.stringify(error)
       });
       throw error;
     });