@posthog/ai 8.9.3 → 8.10.1

package/dist/index.d.ts

@@ -1,6 +1,9 @@
-import { LanguageModelV2, LanguageModelV3 } from '@ai-sdk/provider';
-import { PostHog } from 'posthog-node';
-
+import { LanguageModelV2, LanguageModelV3 } from "@ai-sdk/provider";
+import { PostHog } from "posthog-node";
+import "openai";
+import "@anthropic-ai/sdk";
+import "openai/lib/ResponsesParser";
+//#region src/types.d.ts
 /**
  * Token usage reported by the provider.
  *
@@ -11,42 +14,42 @@ import { PostHog } from 'posthog-node';
  * exists.
  */
 interface TokenUsage {
-    inputTokens?: number;
-    outputTokens?: number;
-    reasoningTokens?: unknown;
-    cacheReadInputTokens?: unknown;
-    cacheCreationInputTokens?: unknown;
-    cacheReportingExclusive?: boolean;
-    webSearchCount?: number;
-    rawUsage?: unknown;
+  inputTokens?: number;
+  outputTokens?: number;
+  reasoningTokens?: unknown;
+  cacheReadInputTokens?: unknown;
+  cacheCreationInputTokens?: unknown;
+  cacheReportingExclusive?: boolean;
+  webSearchCount?: number;
+  rawUsage?: unknown;
 }
 /**
  * Options for fetching a prompt
  */
 interface GetPromptOptions {
-    cacheTtlSeconds?: number;
-    fallback?: string;
-    /** Specific prompt version to fetch. Mutually exclusive with label. */
-    version?: number;
-    /** Fetch the version this label currently points to, e.g. 'production'. Mutually exclusive with version. */
-    label?: string;
+  cacheTtlSeconds?: number;
+  fallback?: string;
+  /** Specific prompt version to fetch. Mutually exclusive with label. */
+  version?: number;
+  /** Fetch the version this label currently points to, e.g. 'production'. Mutually exclusive with version. */
+  label?: string;
 }
 /**
  * Result from the Prompts API or local cache — carries real metadata.
  */
 interface PromptRemoteResult {
-    source: 'api' | 'cache' | 'stale_cache';
-    prompt: string;
-    name: string;
-    version: number;
-    /** The label the prompt was fetched by, when fetching with the label option. */
-    label?: string;
-    /**
-     * JSON object of model parameters or agent configuration stored with the
-     * prompt version, or null when the version has none. Use defensive access,
-     * e.g. `result.config ?? {}` — fallback results carry no config.
-     */
-    config: Record<string, unknown> | null;
+  source: 'api' | 'cache' | 'stale_cache';
+  prompt: string;
+  name: string;
+  version: number;
+  /** The label the prompt was fetched by, when fetching with the label option. */
+  label?: string;
+  /**
+   * JSON object of model parameters or agent configuration stored with the
+   * prompt version, or null when the version has none. Use defensive access,
+   * e.g. `result.config ?? {}` — fallback results carry no config.
+   */
+  config: Record<string, unknown> | null;
 }
 /**
  * Result when the fetch failed and no cache was available — fell back to the
@@ -54,12 +57,12 @@ interface PromptRemoteResult {
  * accessible on the PromptResult union without a type guard.
  */
 interface PromptCodeFallbackResult {
-    source: 'code_fallback';
-    prompt: string;
-    name: undefined;
-    version: undefined;
-    label: undefined;
-    config: undefined;
+  source: 'code_fallback';
+  prompt: string;
+  name: undefined;
+  version: undefined;
+  label: undefined;
+  config: undefined;
 }
 /**
  * Discriminated union returned by `Prompts.get()`.
@@ -76,42 +79,45 @@ type PromptVariables = Record<string, string | number | boolean>;
  * Direct options for initializing Prompts without a PostHog client
  */
 interface PromptsDirectOptions {
-    personalApiKey: string;
-    projectApiKey: string;
-    host?: string;
-    defaultCacheTtlSeconds?: number;
+  personalApiKey: string;
+  projectApiKey: string;
+  host?: string;
+  defaultCacheTtlSeconds?: number;
 }
-
+//#endregion
+//#region src/utils.d.ts
 interface CostOverride {
-    inputCost: number;
-    outputCost: number;
+  inputCost: number;
+  outputCost: number;
 }
 declare enum AIEvent {
-    Generation = "$ai_generation",
-    Embedding = "$ai_embedding"
+  Generation = "$ai_generation",
+  Embedding = "$ai_embedding"
 }
-
+//#endregion
+//#region src/vercel/middleware.d.ts
 type LanguageModel = LanguageModelV2 | LanguageModelV3;
 interface ClientOptions {
-    posthogDistinctId?: string;
-    posthogTraceId?: string;
-    posthogProperties?: Record<string, any>;
-    posthogPrivacyMode?: boolean;
-    posthogGroups?: Record<string, any>;
-    posthogModelOverride?: string;
-    posthogProviderOverride?: string;
-    posthogCostOverride?: CostOverride;
-    posthogCaptureImmediate?: boolean;
+  posthogDistinctId?: string;
+  posthogTraceId?: string;
+  posthogProperties?: Record<string, any>;
+  posthogPrivacyMode?: boolean;
+  posthogGroups?: Record<string, any>;
+  posthogModelOverride?: string;
+  posthogProviderOverride?: string;
+  posthogCostOverride?: CostOverride;
+  posthogCaptureImmediate?: boolean;
 }
 /**
  * Wraps a Vercel AI SDK language model (V2 or V3) with PostHog tracing.
  * Automatically detects the model version and applies appropriate instrumentation.
  */
 declare const wrapVercelLanguageModel: <T extends LanguageModel>(model: T, phClient: PostHog, options: ClientOptions) => T;
-
+//#endregion
+//#region src/prompts.d.ts
 interface PromptsWithPostHogOptions {
-    posthog: PostHog;
-    defaultCacheTtlSeconds?: number;
+  posthog: PostHog;
+  defaultCacheTtlSeconds?: number;
 }
 type PromptsOptions = PromptsWithPostHogOptions | PromptsDirectOptions;
 /**
@@ -153,110 +159,117 @@ type PromptsOptions = PromptsWithPostHogOptions | PromptsDirectOptions;
  * ```
  */
 declare class Prompts {
-    private personalApiKey;
-    private projectApiKey;
-    private host;
-    private defaultCacheTtlSeconds;
-    private cache;
-    constructor(options: PromptsOptions);
-    private getPromptCache;
-    private getOrCreatePromptCache;
-    private getPromptReference;
-    /**
-     * Fetch a prompt by name from the PostHog API.
-     *
-     * Returns a `PromptResult` object carrying the prompt text alongside `source`,
-     * `name`, `version`, and `config` metadata. Read `result.prompt` for the
-     * template string and `result.config ?? {}` for model parameters or agent
-     * configuration stored with the version.
-     */
-    get(name: string, options?: GetPromptOptions): Promise<PromptResult>;
-    /**
-     * Internal method that handles cache + fetch logic, returning full metadata.
-     * Does NOT handle the string `fallback` option — callers handle that.
-     */
-    private getInternal;
-    /**
-     * Compile a prompt template with variable substitution
-     *
-     * Variables in the format `{{variableName}}` will be replaced with values from the variables object.
-     * Unmatched variables are left unchanged.
-     *
-     * @param prompt - The prompt template string
-     * @param variables - Object containing variable values
-     * @returns The compiled prompt string
-     */
-    compile(prompt: string, variables: PromptVariables): string;
-    /**
-     * Clear the cache for a specific prompt or all prompts
-     *
-     * @param name - Optional prompt name to clear. If provided, clears all cached versions for that prompt unless a version is also provided.
-     * @param version - Optional prompt version to clear. Requires a prompt name.
-     */
-    clearCache(name?: string, version?: number): void;
-    private fetchPromptFromApi;
+  private personalApiKey;
+  private projectApiKey;
+  private host;
+  private defaultCacheTtlSeconds;
+  private cache;
+  constructor(options: PromptsOptions);
+  private getPromptCache;
+  private getOrCreatePromptCache;
+  private getPromptReference;
+  /**
+   * Fetch a prompt by name from the PostHog API.
+   *
+   * Returns a `PromptResult` object carrying the prompt text alongside `source`,
+   * `name`, `version`, and `config` metadata. Read `result.prompt` for the
+   * template string and `result.config ?? {}` for model parameters or agent
+   * configuration stored with the version.
+   */
+  get(name: string, options?: GetPromptOptions): Promise<PromptResult>;
+  /**
+   * Internal method that handles cache + fetch logic, returning full metadata.
+   * Does NOT handle the string `fallback` option — callers handle that.
+   */
+  private getInternal;
+  /**
+   * Compile a prompt template with variable substitution
+   *
+   * Variables in the format `{{variableName}}` will be replaced with values from the variables object.
+   * Unmatched variables are left unchanged.
+   *
+   * @param prompt - The prompt template string
+   * @param variables - Object containing variable values
+   * @returns The compiled prompt string
+   */
+  compile(prompt: string, variables: PromptVariables): string;
+  /**
+   * Clear the cache for a specific prompt or all prompts
+   *
+   * @param name - Optional prompt name to clear. If provided, clears all cached versions for that prompt unless a version is also provided.
+   * @param version - Optional prompt version to clear. Requires a prompt name.
+   */
+  clearCache(name?: string, version?: number): void;
+  private fetchPromptFromApi;
 }
-
+//#endregion
+//#region src/captureAiGeneration.d.ts
 /**
  * Options for `captureAiGeneration`. Mirrors the `$ai_generation` event shape
  * directly so that any caller — first-party SDK wrappers and external code
  * alike — produces an identical event.
  */
 interface CaptureAiGenerationOptions {
-    distinctId?: string;
-    /** Auto-generated when omitted. */
-    traceId?: string;
-    /** Defaults to `$ai_generation`. */
-    eventType?: AIEvent;
-    /** Required for the event to be useful, but accepted as optional so SDK wrappers can pass through whatever they detect. */
-    model?: string;
-    provider: string;
-    input: unknown;
-    output: unknown;
-    /** Maps to `$ai_model_parameters` (temperature, max_tokens, top_p, …). */
-    modelParameters?: Record<string, unknown>;
-    baseURL?: string;
-    httpStatus?: number;
-    /** Wall-clock latency in seconds. */
-    latency?: number;
-    /** Time from request start to the first streamed token, in seconds. */
-    timeToFirstToken?: number;
-    usage?: TokenUsage;
-    /** Extra event properties merged into the captured event. */
-    properties?: Record<string, unknown>;
-    /** Mapping of group type to group id, matching `EventMessage.groups`. */
-    groups?: Record<string, string | number>;
-    privacyMode?: boolean;
-    /**
-     * For SDK wrappers: overrides the auto-detected model. External callers
-     * should pass `model` directly instead.
-     */
-    modelOverride?: string;
-    /**
-     * For SDK wrappers: overrides the auto-detected provider. External callers
-     * should pass `provider` directly instead.
-     */
-    providerOverride?: string;
-    costOverride?: CostOverride;
-    tools?: unknown[] | null;
-    stopReason?: string;
-    /**
-     * Provider-assigned ID for the generation (e.g. OpenAI's `chatcmpl-…` /
-     * `resp_…`). Maps to `$ai_completion_id`. Response IDs generalize across
-     * providers, so this lives in the shared schema rather than under
-     * `providerMetadata`.
-     */
-    completionId?: string;
-    /**
-     * Provider-specific response metadata that has no place in the shared,
-     * provider-agnostic `$ai_*` schema (e.g. OpenAI's `system_fingerprint` and
-     * `request_id`). Maps to `$ai_provider_metadata`; omitted when empty.
-     */
-    providerMetadata?: Record<string, unknown>;
-    /** When set, the event is captured as an error. */
-    error?: unknown;
-    /** Awaits delivery instead of batching. Useful in serverless environments. */
-    captureImmediate?: boolean;
+  distinctId?: string;
+  /** Auto-generated when omitted. */
+  traceId?: string;
+  /** Defaults to `$ai_generation`. */
+  eventType?: AIEvent;
+  /** Required for the event to be useful, but accepted as optional so SDK wrappers can pass through whatever they detect. */
+  model?: string;
+  provider: string;
+  input: unknown;
+  output: unknown;
+  /** Maps to `$ai_model_parameters` (temperature, max_tokens, top_p, …). */
+  modelParameters?: Record<string, unknown>;
+  /**
+   * `null` explicitly signals no base URL and omits `$ai_base_url` from the event.
+   * `undefined`/omitted keeps the existing `''` default for backward compatibility.
+   */
+  baseURL?: string | null;
+  httpStatus?: number;
+  /** Wall-clock latency in seconds. */
+  latency?: number;
+  /** Time from request start to the first streamed token, in seconds. */
+  timeToFirstToken?: number;
+  usage?: TokenUsage;
+  /** Extra event properties merged into the captured event. */
+  properties?: Record<string, unknown>;
+  /** Mapping of group type to group id, matching `EventMessage.groups`. */
+  groups?: Record<string, string | number>;
+  privacyMode?: boolean;
+  /**
+   * For SDK wrappers: overrides the auto-detected model. External callers
+   * should pass `model` directly instead.
+   */
+  modelOverride?: string;
+  /**
+   * For SDK wrappers: overrides the auto-detected provider. External callers
+   * should pass `provider` directly instead.
+   */
+  providerOverride?: string;
+  costOverride?: CostOverride;
+  tools?: unknown[] | null;
+  stopReason?: string;
+  /**
+   * Provider-assigned ID for the generation (e.g. OpenAI's `chatcmpl-…` /
+   * `resp_…`). Maps to `$ai_completion_id`. Response IDs generalize across
+   * providers, so this lives in the shared schema rather than under
+   * `providerMetadata`.
+   */
+  completionId?: string;
+  /**
+   * Provider-specific response metadata that has no place in the shared,
+   * provider-agnostic `$ai_*` schema (e.g. OpenAI's `system_fingerprint` and
+   * `request_id`). Maps to `$ai_provider_metadata`; omitted when empty.
+   */
+  providerMetadata?: Record<string, unknown>;
+  /** When set, the event is captured as an error. */
+  error?: unknown;
+  /** Awaits delivery instead of batching. Useful in serverless environments. */
+  captureImmediate?: boolean;
+  /** Invoked when generation telemetry cannot be captured. Errors thrown by this callback are ignored. */
+  onError?: (error: unknown) => void;
 }
 /**
  * Capture an `$ai_generation` (or `$ai_embedding`) event to PostHog.
@@ -272,6 +285,6 @@ interface CaptureAiGenerationOptions {
  * so callers can re-throw the original error reference safely.
  */
 declare const captureAiGeneration: (client: PostHog, options: CaptureAiGenerationOptions) => Promise<void>;
-
-export { AIEvent, Prompts, captureAiGeneration, wrapVercelLanguageModel as withTracing };
-export type { CaptureAiGenerationOptions, PromptCodeFallbackResult, PromptRemoteResult, PromptResult };
+//#endregion
+export { AIEvent, type CaptureAiGenerationOptions, type PromptCodeFallbackResult, type PromptRemoteResult, type PromptResult, Prompts, captureAiGeneration, wrapVercelLanguageModel as withTracing };
+//# sourceMappingURL=index.d.ts.map