Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nexus.westyx.cloud/llms.txt

Use this file to discover all available pages before exploring further.

SDK matrix

SDKLanguageUse casePackage
GoGo 1.26+Backend servicesgitlab.com/westyx/nexus/sdk/go
Node.jsNode 18+Backend / SSR@westyx-nexus/sdk-nodejs
PythonPython 3.10+Backend serviceswestyx-nexus-sdk
.NET.NET 10Backend servicesWestyxNexus (NuGet)
Spring BootJava 17+Spring Boot servicesdev.westyx.nexus:nexus-spring-boot-starter
AngularAngular 17+Browser apps@westyx-nexus/sdk-angular
ReactReact 18+Browser apps@westyx-nexus/sdk-react
VueVue 3.3+Browser apps@westyx-nexus/sdk-vue
Rust and PHP SDKs are coming soon.

Choosing an SDK

Backend service

Use Go, Node.js, Python, .NET, or Spring Boot. Backend services use sk_live_ keys and have access to secrets, configs, and flags. Workload Identity Federation (WIF) is supported on all backend SDKs.

Frontend / browser

Use Angular, React, or Vue. Browser SDKs use pk_live_ keys and have access to configs and flags only. Secrets are never sent to the browser.

Shared behaviour across all SDKs

All 8 SDKs implement the same core contract:
  • TTL-based cache - initial sync populates the cache; background refresh keeps it current without blocking callers
  • ETag / 304 - unchanged data resets the TTL without re-downloading the full payload
  • SSE live updates - value changes propagate within milliseconds; falls back to TTL polling after 3 transport errors
  • 402 handling - when billing is blocked, background sync halts and the cached values are served until resolved
  • Service kind enforcement - GetSecret is blocked with an error on kind=frontend services regardless of key type

Versioning

All SDKs follow semantic versioning and are currently at v0.3.x. The package registries are public - no token required to install.
The npm packages (@westyx-nexus/*) are hosted on the GitLab Package Registry. Add the registry scoped to @westyx-nexus in your .npmrc before installing:
@westyx-nexus:registry=https://gitlab.com/api/v4/projects/<PROJECT_ID>/packages/npm/
The project ID is shown on each SDK’s GitLab project page.