@posthog/ai 4.2.1 → 4.3.0

package/lib/index.d.ts

@@ -23,7 +23,7 @@ interface MonitoringParams {
     posthogModelOverride?: string;
     posthogProviderOverride?: string;
     posthogCostOverride?: CostOverride;
-    fullDebug?: boolean;
+    posthogCaptureImmediate?: boolean;
 }
 interface CostOverride {
     inputCost: number;
@@ -95,7 +95,7 @@ interface ClientOptions {
     posthogModelOverride?: string;
     posthogProviderOverride?: string;
     posthogCostOverride?: CostOverride;
-    fullDebug?: boolean;
+    posthogCaptureImmediate?: boolean;
 }
 declare const wrapVercelLanguageModel: (model: LanguageModelV1, phClient: PostHog, options: ClientOptions) => LanguageModelV1;
 

package/lib/index.esm.js

@@ -90,7 +90,7 @@ function sanitizeValues(obj) {
   }
   return jsonSafe;
 }
-const sendEventToPosthog = ({
+const sendEventToPosthog = async ({
   client,
   distinctId,
   traceId,
@@ -106,82 +106,75 @@ const sendEventToPosthog = ({
   isError = false,
   error,
   tools,
-  fullDebug = false
+  captureImmediate = false
 }) => {
-  if (client.capture) {
-    // sanitize input and output for UTF-8 validity
-    const safeInput = sanitizeValues(input);
-    const safeOutput = sanitizeValues(output);
-    const safeError = sanitizeValues(error);
-    let errorData = {};
-    if (isError) {
-      errorData = {
-        $ai_is_error: true,
-        $ai_error: safeError
-      };
-    }
-    let costOverrideData = {};
-    if (params.posthogCostOverride) {
-      const inputCostUSD = (params.posthogCostOverride.inputCost ?? 0) * (usage.inputTokens ?? 0);
-      const outputCostUSD = (params.posthogCostOverride.outputCost ?? 0) * (usage.outputTokens ?? 0);
-      costOverrideData = {
-        $ai_input_cost_usd: inputCostUSD,
-        $ai_output_cost_usd: outputCostUSD,
-        $ai_total_cost_usd: inputCostUSD + outputCostUSD
-      };
-    }
-    const additionalTokenValues = {
-      ...(usage.reasoningTokens ? {
-        $ai_reasoning_tokens: usage.reasoningTokens
-      } : {}),
-      ...(usage.cacheReadInputTokens ? {
-        $ai_cache_read_input_tokens: usage.cacheReadInputTokens
-      } : {}),
-      ...(usage.cacheCreationInputTokens ? {
-        $ai_cache_creation_input_tokens: usage.cacheCreationInputTokens
-      } : {})
+  if (!client.capture) return Promise.resolve();
+  // sanitize input and output for UTF-8 validity
+  const safeInput = sanitizeValues(input);
+  const safeOutput = sanitizeValues(output);
+  const safeError = sanitizeValues(error);
+  let errorData = {};
+  if (isError) {
+    errorData = {
+      $ai_is_error: true,
+      $ai_error: safeError
     };
-    const properties = {
-      $ai_provider: params.posthogProviderOverride ?? provider,
-      $ai_model: params.posthogModelOverride ?? model,
-      $ai_model_parameters: getModelParams(params),
-      $ai_input: withPrivacyMode(client, params.posthogPrivacyMode ?? false, safeInput),
-      $ai_output_choices: withPrivacyMode(client, params.posthogPrivacyMode ?? false, safeOutput),
-      $ai_http_status: httpStatus,
-      $ai_input_tokens: usage.inputTokens ?? 0,
-      $ai_output_tokens: usage.outputTokens ?? 0,
-      ...additionalTokenValues,
-      $ai_latency: latency,
-      $ai_trace_id: traceId,
-      $ai_base_url: baseURL,
-      ...params.posthogProperties,
-      ...(distinctId ? {} : {
-        $process_person_profile: false
-      }),
-      ...(tools ? {
-        $ai_tools: tools
-      } : {}),
-      ...errorData,
-      ...costOverrideData
+  }
+  let costOverrideData = {};
+  if (params.posthogCostOverride) {
+    const inputCostUSD = (params.posthogCostOverride.inputCost ?? 0) * (usage.inputTokens ?? 0);
+    const outputCostUSD = (params.posthogCostOverride.outputCost ?? 0) * (usage.outputTokens ?? 0);
+    costOverrideData = {
+      $ai_input_cost_usd: inputCostUSD,
+      $ai_output_cost_usd: outputCostUSD,
+      $ai_total_cost_usd: inputCostUSD + outputCostUSD
     };
-    if (fullDebug) {
-      // @ts-ignore
-      console.log('Sending event to PostHog', JSON.stringify(properties));
-      try {
-        // @ts-ignore
-        console.log('Size of properties (kb)', Math.round(Buffer.byteLength(JSON.stringify(properties), STRING_FORMAT) / 1024 * 10000) / 10000);
-        // @ts-ignore
-        console.log('Size of properties (mb)', Math.round(Buffer.byteLength(JSON.stringify(properties), STRING_FORMAT) / 1024 / 1024 * 10000) / 10000);
-      } catch (error) {
-        console.error('Error printing size of properties', error);
-      }
-    }
-    client.capture({
-      distinctId: distinctId ?? traceId,
-      event: '$ai_generation',
-      properties,
-      groups: params.posthogGroups
-    });
+  }
+  const additionalTokenValues = {
+    ...(usage.reasoningTokens ? {
+      $ai_reasoning_tokens: usage.reasoningTokens
+    } : {}),
+    ...(usage.cacheReadInputTokens ? {
+      $ai_cache_read_input_tokens: usage.cacheReadInputTokens
+    } : {}),
+    ...(usage.cacheCreationInputTokens ? {
+      $ai_cache_creation_input_tokens: usage.cacheCreationInputTokens
+    } : {})
+  };
+  const properties = {
+    $ai_provider: params.posthogProviderOverride ?? provider,
+    $ai_model: params.posthogModelOverride ?? model,
+    $ai_model_parameters: getModelParams(params),
+    $ai_input: withPrivacyMode(client, params.posthogPrivacyMode ?? false, safeInput),
+    $ai_output_choices: withPrivacyMode(client, params.posthogPrivacyMode ?? false, safeOutput),
+    $ai_http_status: httpStatus,
+    $ai_input_tokens: usage.inputTokens ?? 0,
+    $ai_output_tokens: usage.outputTokens ?? 0,
+    ...additionalTokenValues,
+    $ai_latency: latency,
+    $ai_trace_id: traceId,
+    $ai_base_url: baseURL,
+    ...params.posthogProperties,
+    ...(distinctId ? {} : {
+      $process_person_profile: false
+    }),
+    ...(tools ? {
+      $ai_tools: tools
+    } : {}),
+    ...errorData,
+    ...costOverrideData
+  };
+  const event = {
+    distinctId: distinctId ?? traceId,
+    event: '$ai_generation',
+    properties,
+    groups: params.posthogGroups
+  };
+  if (captureImmediate) {
+    // await capture promise to send single event in serverless environments
+    await client.captureImmediate(event);
+  } else {
+    client.capture(event);
   }
 };
 
@@ -216,6 +209,7 @@ class WrappedCompletions$1 extends OpenAIOrignal.Chat.Completions {
       // eslint-disable-next-line @typescript-eslint/no-unused-vars
       posthogPrivacyMode = false,
       posthogGroups,
+      posthogCaptureImmediate,
       ...openAIParams
     } = body;
     const traceId = posthogTraceId ?? v4();
@@ -245,7 +239,7 @@ class WrappedCompletions$1 extends OpenAIOrignal.Chat.Completions {
                 }
               }
               const latency = (Date.now() - startTime) / 1000;
-              sendEventToPosthog({
+              await sendEventToPosthog({
                 client: this.phClient,
                 distinctId: posthogDistinctId ?? traceId,
                 traceId,
@@ -260,10 +254,11 @@ class WrappedCompletions$1 extends OpenAIOrignal.Chat.Completions {
                 baseURL: this.baseURL ?? '',
                 params: body,
                 httpStatus: 200,
-                usage
+                usage,
+                captureImmediate: posthogCaptureImmediate
               });
             } catch (error) {
-              sendEventToPosthog({
+              await sendEventToPosthog({
                 client: this.phClient,
                 distinctId: posthogDistinctId ?? traceId,
                 traceId,
@@ -280,7 +275,8 @@ class WrappedCompletions$1 extends OpenAIOrignal.Chat.Completions {
                   outputTokens: 0
                 },
                 isError: true,
-                error: JSON.stringify(error)
+                error: JSON.stringify(error),
+                captureImmediate: posthogCaptureImmediate
               });
             }
           })();
@@ -290,10 +286,10 @@ class WrappedCompletions$1 extends OpenAIOrignal.Chat.Completions {
         return value;
       });
     } else {
-      const wrappedPromise = parentPromise.then(result => {
+      const wrappedPromise = parentPromise.then(async result => {
         if ('choices' in result) {
           const latency = (Date.now() - startTime) / 1000;
-          sendEventToPosthog({
+          await sendEventToPosthog({
             client: this.phClient,
             distinctId: posthogDistinctId ?? traceId,
             traceId,
@@ -310,12 +306,13 @@ class WrappedCompletions$1 extends OpenAIOrignal.Chat.Completions {
               outputTokens: result.usage?.completion_tokens ?? 0,
               reasoningTokens: result.usage?.completion_tokens_details?.reasoning_tokens ?? 0,
               cacheReadInputTokens: result.usage?.prompt_tokens_details?.cached_tokens ?? 0
-            }
+            },
+            captureImmediate: posthogCaptureImmediate
           });
         }
         return result;
-      }, error => {
-        sendEventToPosthog({
+      }, async error => {
+        await sendEventToPosthog({
           client: this.phClient,
           distinctId: posthogDistinctId ?? traceId,
           traceId,
@@ -332,7 +329,8 @@ class WrappedCompletions$1 extends OpenAIOrignal.Chat.Completions {
             outputTokens: 0
           },
           isError: true,
-          error: JSON.stringify(error)
+          error: JSON.stringify(error),
+          captureImmediate: posthogCaptureImmediate
         });
         throw error;
       });
@@ -372,6 +370,7 @@ class WrappedCompletions extends AzureOpenAI.Chat.Completions {
       // eslint-disable-next-line @typescript-eslint/no-unused-vars
       posthogPrivacyMode = false,
       posthogGroups,
+      posthogCaptureImmediate,
       ...openAIParams
     } = body;
     const traceId = posthogTraceId ?? v4();
@@ -405,7 +404,7 @@ class WrappedCompletions extends AzureOpenAI.Chat.Completions {
                 }
               }
               const latency = (Date.now() - startTime) / 1000;
-              sendEventToPosthog({
+              await sendEventToPosthog({
                 client: this.phClient,
                 distinctId: posthogDistinctId ?? traceId,
                 traceId,
@@ -420,11 +419,12 @@ class WrappedCompletions extends AzureOpenAI.Chat.Completions {
                 baseURL: this.baseURL ?? '',
                 params: body,
                 httpStatus: 200,
-                usage
+                usage,
+                captureImmediate: posthogCaptureImmediate
               });
             } catch (error) {
               // error handling
-              sendEventToPosthog({
+              await sendEventToPosthog({
                 client: this.phClient,
                 distinctId: posthogDistinctId ?? traceId,
                 traceId,
@@ -441,7 +441,8 @@ class WrappedCompletions extends AzureOpenAI.Chat.Completions {
                   outputTokens: 0
                 },
                 isError: true,
-                error: JSON.stringify(error)
+                error: JSON.stringify(error),
+                captureImmediate: posthogCaptureImmediate
               });
             }
           })();
@@ -451,14 +452,14 @@ class WrappedCompletions extends AzureOpenAI.Chat.Completions {
         return value;
       });
     } else {
-      const wrappedPromise = parentPromise.then(result => {
+      const wrappedPromise = parentPromise.then(async result => {
         if ('choices' in result) {
           const latency = (Date.now() - startTime) / 1000;
           let model = openAIParams.model;
           if (result.model != model) {
             model = result.model;
           }
-          sendEventToPosthog({
+          await sendEventToPosthog({
             client: this.phClient,
             distinctId: posthogDistinctId ?? traceId,
             traceId,
@@ -475,12 +476,13 @@ class WrappedCompletions extends AzureOpenAI.Chat.Completions {
               outputTokens: result.usage?.completion_tokens ?? 0,
               reasoningTokens: result.usage?.completion_tokens_details?.reasoning_tokens ?? 0,
               cacheReadInputTokens: result.usage?.prompt_tokens_details?.cached_tokens ?? 0
-            }
+            },
+            captureImmediate: posthogCaptureImmediate
           });
         }
         return result;
-      }, error => {
-        sendEventToPosthog({
+      }, async error => {
+        await sendEventToPosthog({
           client: this.phClient,
           distinctId: posthogDistinctId ?? traceId,
           traceId,
@@ -497,7 +499,8 @@ class WrappedCompletions extends AzureOpenAI.Chat.Completions {
             outputTokens: 0
           },
           isError: true,
-          error: JSON.stringify(error)
+          error: JSON.stringify(error),
+          captureImmediate: posthogCaptureImmediate
         });
         throw error;
       });
@@ -596,7 +599,9 @@ const mapVercelPrompt = prompt => {
     // Trim the inputs array until its JSON size fits within MAX_OUTPUT_SIZE
     let serialized = JSON.stringify(inputs);
     let removedCount = 0;
-    while (Buffer.byteLength(serialized, 'utf8') > MAX_OUTPUT_SIZE && inputs.length > 0) {
+    // We need to keep track of the initial size of the inputs array because we're going to be mutating it
+    let initialSize = inputs.length;
+    for (let i = 0; i < initialSize && Buffer.byteLength(serialized, 'utf8') > MAX_OUTPUT_SIZE; i++) {
       inputs.shift();
       removedCount++;
       serialized = JSON.stringify(inputs);
@@ -604,7 +609,7 @@ const mapVercelPrompt = prompt => {
     if (removedCount > 0) {
       // Add one placeholder to indicate how many were removed
       inputs.unshift({
-        role: 'assistant',
+        role: 'posthog',
         content: `[${removedCount} message${removedCount === 1 ? '' : 's'} removed due to size limit]`
       });
     }
@@ -710,7 +715,7 @@ const createInstrumentationMiddleware = (phClient, model, options) => {
             cacheCreationInputTokens: providerMetadata.anthropic.cacheCreationInputTokens
           } : {})
         };
-        sendEventToPosthog({
+        await sendEventToPosthog({
           client: phClient,
           distinctId: options.posthogDistinctId,
           traceId: options.posthogTraceId,
@@ -730,12 +735,12 @@ const createInstrumentationMiddleware = (phClient, model, options) => {
             outputTokens: result.usage.completionTokens,
             ...additionalTokenValues
           },
-          fullDebug: options.fullDebug
+          captureImmediate: options.posthogCaptureImmediate
         });
         return result;
       } catch (error) {
         const modelId = model.modelId;
-        sendEventToPosthog({
+        await sendEventToPosthog({
           client: phClient,
           distinctId: options.posthogDistinctId,
           traceId: options.posthogTraceId,
@@ -753,7 +758,7 @@ const createInstrumentationMiddleware = (phClient, model, options) => {
           },
           isError: true,
           error: truncate(JSON.stringify(error)),
-          fullDebug: options.fullDebug
+          captureImmediate: options.posthogCaptureImmediate
         });
         throw error;
       }
@@ -802,9 +807,9 @@ const createInstrumentationMiddleware = (phClient, model, options) => {
             }
             controller.enqueue(chunk);
           },
-          flush() {
+          flush: async () => {
             const latency = (Date.now() - startTime) / 1000;
-            sendEventToPosthog({
+            await sendEventToPosthog({
               client: phClient,
               distinctId: options.posthogDistinctId,
               traceId: options.posthogTraceId,
@@ -820,7 +825,7 @@ const createInstrumentationMiddleware = (phClient, model, options) => {
               params: mergedParams,
               httpStatus: 200,
               usage,
-              fullDebug: options.fullDebug
+              captureImmediate: options.posthogCaptureImmediate
             });
           }
         });
@@ -829,7 +834,7 @@ const createInstrumentationMiddleware = (phClient, model, options) => {
           ...rest
         };
       } catch (error) {
-        sendEventToPosthog({
+        await sendEventToPosthog({
           client: phClient,
           distinctId: options.posthogDistinctId,
           traceId: options.posthogTraceId,
@@ -847,7 +852,7 @@ const createInstrumentationMiddleware = (phClient, model, options) => {
           },
           isError: true,
           error: truncate(JSON.stringify(error)),
-          fullDebug: options.fullDebug
+          captureImmediate: options.posthogCaptureImmediate
         });
         throw error;
       }
@@ -893,6 +898,7 @@ class WrappedMessages extends AnthropicOriginal.Messages {
       // eslint-disable-next-line @typescript-eslint/no-unused-vars
       posthogPrivacyMode = false,
       posthogGroups,
+      posthogCaptureImmediate,
       ...anthropicParams
     } = body;
     const traceId = posthogTraceId ?? v4();
@@ -928,7 +934,7 @@ class WrappedMessages extends AnthropicOriginal.Messages {
                 }
               }
               const latency = (Date.now() - startTime) / 1000;
-              sendEventToPosthog({
+              await sendEventToPosthog({
                 client: this.phClient,
                 distinctId: posthogDistinctId ?? traceId,
                 traceId,
@@ -943,11 +949,12 @@ class WrappedMessages extends AnthropicOriginal.Messages {
                 baseURL: this.baseURL ?? '',
                 params: body,
                 httpStatus: 200,
-                usage
+                usage,
+                captureImmediate: posthogCaptureImmediate
               });
             } catch (error) {
               // error handling
-              sendEventToPosthog({
+              await sendEventToPosthog({
                 client: this.phClient,
                 distinctId: posthogDistinctId ?? traceId,
                 traceId,
@@ -964,7 +971,8 @@ class WrappedMessages extends AnthropicOriginal.Messages {
                   outputTokens: 0
                 },
                 isError: true,
-                error: JSON.stringify(error)
+                error: JSON.stringify(error),
+                captureImmediate: posthogCaptureImmediate
               });
             }
           })();
@@ -974,10 +982,10 @@ class WrappedMessages extends AnthropicOriginal.Messages {
         return value;
       });
     } else {
-      const wrappedPromise = parentPromise.then(result => {
+      const wrappedPromise = parentPromise.then(async result => {
         if ('content' in result) {
           const latency = (Date.now() - startTime) / 1000;
-          sendEventToPosthog({
+          await sendEventToPosthog({
             client: this.phClient,
             distinctId: posthogDistinctId ?? traceId,
             traceId,
@@ -994,12 +1002,13 @@ class WrappedMessages extends AnthropicOriginal.Messages {
               outputTokens: result.usage.output_tokens ?? 0,
               cacheCreationInputTokens: result.usage.cache_creation_input_tokens ?? 0,
               cacheReadInputTokens: result.usage.cache_read_input_tokens ?? 0
-            }
+            },
+            captureImmediate: posthogCaptureImmediate
           });
         }
         return result;
-      }, error => {
-        sendEventToPosthog({
+      }, async error => {
+        await sendEventToPosthog({
           client: this.phClient,
           distinctId: posthogDistinctId ?? traceId,
           traceId,
@@ -1016,7 +1025,8 @@ class WrappedMessages extends AnthropicOriginal.Messages {
             outputTokens: 0
           },
           isError: true,
-          error: JSON.stringify(error)
+          error: JSON.stringify(error),
+          captureImmediate: posthogCaptureImmediate
         });
         throw error;
       });