Skip to content

SDK overview

UserVane ships widget SDKs for in-product surveys, agent-native integrations for chat hosts, and a server adapter for Langfuse score delivery.

PackageRuntimeRole
@uservane/browserBrowserHeadless core + classic widget (UserVane.init / identify / survey)
@uservane/reactReact clientThin provider + useUserVane over the browser SDK
@uservane/react-nativeReact NativeNative survey card over the same browser core
PackageRuntimeRole
@uservane/agent-coreAny JS runtimeHeadless AgentController, correlation, server mint helpers
@uservane/agent-reactReact clientShared UserVaneProvider, InlineFeedback, hooks
@uservane/vercel-aiReact clientVercel AI SDK host adapter (re-exports core + React UI)
@uservane/vercel-ai/serverServer onlymintFeedbackToken (secret key)
@uservane/openai-agentsReact + serverOpenAI Agents SDK: fire-once run wrapper, client UI, Langfuse bridge
@uservane/copilotkitReact clientCopilotKit turn-resolution capture + server mint
PackageRuntimeRole
@uservane/langfuse-pushServer onlypushPendingScores Langfuse adapter

Auto-generated TypeDoc for each entry lives under API reference (TypeDoc).

  • In-product survey widget → browser, React, or React Native.
  • Agent chat on Vercel AI SDK@uservane/vercel-ai (+ server mint for linked sessions).
  • OpenAI Agents SDK@uservane/openai-agents (+ /server fire-once + optional /langfuse bridge).
  • CopilotKit frontend@uservane/copilotkit (backend owns Langfuse traces; mint with sessionId = threadId).
  • Headless / custom host@uservane/agent-core (+ @uservane/agent-react when you render).
  • Push scores into Langfuse@uservane/langfuse-push on your cron.
  • Publishable key in clients; secret key only on servers (Keys).
  • Show-tokens are server-issued; clients never invent them.
  • Errors inside UserVane are guarded so they do not take down the host app.