The official Neon SDK for building applications - integrates Neon Auth and Neon Data API.
| Package | Use Case | npm |
|---|---|---|
@neondatabase/neon-js |
Full SDK: Auth + Database + UI |  |
@neondatabase/auth |
Authentication + UI only |  |
@neondatabase/postgrest-js |
Database queries (no auth) |  |
Do you need authentication?
├── Yes → Do you also need database queries?
│ ├── Yes → @neondatabase/neon-js (full SDK)
│ └── No → @neondatabase/auth
└── No → @neondatabase/postgrest-js
Pre-built login forms and auth pages are included in both neon-js and auth packages.
This is a pnpm workspaces monorepo. See CLAUDE.md for detailed development setup.
Quick start:
pnpm install # Install dependencies
pnpm dev # Watch mode for all packages
pnpm run build # Build all packages
pnpm test # Run tests
pnpm typecheck # Type check all packagesReleases use a two-stage pipeline. No GitHub App is needed.
Stage 1 (prepare-release.yml in this repo, manual workflow_dispatch):
- Select the trigger package and bump type
- The workflow bumps versions via cascade, pushes a release branch, and opens a PR
- After manual squash merge,
post-release.ymltags the merge commit and posts Stage 2 dispatch instructions
Stage 2 (neon-js.yml in secure-public-registry-releases-eng, manual workflow_dispatch):
- Point it at the tag/ref from the post-release handoff
- It checks out the tagged commit, builds from source, scans, and publishes via npm OIDC
- If publish fails, a prominent warning is shown with remediation steps
Local releases are disabled. Running pnpm run release will show an error
directing you to the two-stage pipeline.
| Trigger package | Cascade |
|---|---|
postgrest-js |
postgrest-js, neon-js |
auth-ui |
auth-ui, auth, neon-js |
auth |
auth, neon-js |
neon-js |
neon-js only |
all |
postgrest-js, auth-ui, auth, neon-js |
all releases every public package together, while keeping independent package
versions. It bumps each package once from its own current version; it does not
force every package to share the same version number.
All release logic lives inside the two GitHub Actions workflows:
prepare-release.yml(this repo) -- bumps versions via cascade and opens the release PRpost-release.yml(this repo) -- tags the merged release commit and writes the Stage 2 handoffneon-js.yml(secure-public-registry-releases-eng) -- checks out the tagged commit, builds from source, scans, and publishes via npm OIDC
Apache-2.0