Skip to main content

Registry

The package is served from this project’s GitLab package registry. It is public - no token is required to install. Point the scope at it in your .npmrc:
One package, one endpoint. The SDK carries everything it needs; nothing else has to be installed or configured to make it resolve.

Requirements

Migrating to v0.14.0

The peer range floor moves from Vue 3.3 to 3.4. Vue 3.4 changed computed to stop triggering effects when its value is unchanged; on 3.3 every background sync re-rendered every component bound to a flag - measured at four extra renders where 3.5 had none. Rather than describing two render behaviours, the SDK now requires the version where there is one. Vue 3.3 consumers stay on v0.13.0; upgrading Vue is the only change needed.

Your API key

Browser SDKs require a public key (wxp_...). Any other key is rejected when the client is created, with a NexusConfigError that names the option. A public key is safe to ship in a bundle: it cannot read secrets, and the backend’s Double-Gate check ties it to one service host. A secret key (wxs_...) in browser code would be readable by every visitor, which is why there is no configuration that makes one work here. Create one in the Nexus admin console under the service’s API keys, choosing the public key type.

Verifying the install

If npm reports 404 Not Found, the scope line is missing from .npmrc or the registry URL has the wrong project ID.