@uservane/browser

The browser package is the headless core shared by the React wrapper and agent packages. Public surface:

import { UserVane } from "@uservane/browser";

UserVane.init({ key: "uv_pk_...", apiBase?: string, debug?: boolean });
UserVane.identify({ userId: string, traits?: Record<string, unknown> });
UserVane.survey(slug: string);

Install

npm install @uservane/browser

UserVane methods

Method	Purpose
init(options)	Configure publishable key; queued, idempotent, SSR-safe
identify(options)	Set respondent userId + traits; triggers re-bootstrap
survey(slug)	Imperative show by survey slug; buffers until rules load

Types (selected)

From package exports (see TypeDoc for full list):

• InitOptions, IdentifyOptions
• SurveyDefinition, BootstrapResponse, SubmitPayload
• Presentation, SurveyType, ShowReason, WidgetState

Also exported for advanced / host reuse: fetchBootstrap, submitResponse, decideShow, scale helpers, copy constants.

Network

Call	Endpoint	Key
Bootstrap	POST /v1/sdk/bootstrap	Publishable
Submit	POST /v1/sdk/responses	Publishable

Default apiBase: https://api.uservane.com.

Notes

• Fail-closed on bootstrap failure: no broken widget, no wrong re-prompt.
• Widget presentations: corner | inline | banner.
• Survey types: nps | csat | ces | pmf.

TypeDoc reference · Classic widget guide