# @neon/config-runtime

> Imperative runtime for @neon/config: inspect/plan/apply a neon.ts policy against the Neon API and bundle + deploy Neon Functions. Pulls in esbuild; import this from CLIs and CI, not from neon.ts.

Latest version **1.10.1** (published 2026-10-15) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @neon/config-runtime
pnpm add @neon/config-runtime
yarn add @neon/config-runtime
bun add @neon/config-runtime
```

## Health

**Score 55/100 (C)** — status: active.

Positive: no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 1.10.1 |
| Published | 2026-10-15 |
| First published | 2026-06-25 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 54 |
| Author | Neon |
| Maintainers | andrelandgraf, neonteam, shridharneon |
| Keywords | neon, database, postgres, iac, config-as-code, platform, deploy |

## Links

- npm: https://www.npmjs.com/package/@neon/config-runtime
- Repository: https://github.com/neondatabase/neon-pkgs
- Homepage: https://github.com/neondatabase/neon-pkgs#readme
- Issues: https://github.com/neondatabase/neon-pkgs/issues
- npm.io page: https://npm.io/package/@neon/config-runtime

## Alternatives

- [@libsql/sqlite3](https://npm.io/package/@libsql/sqlite3.md) — 39.8K weekly downloads
- [@fortemi/core](https://npm.io/package/@fortemi/core.md) — 461 weekly downloads
- [cdb-converter](https://npm.io/package/cdb-converter.md) — 341 weekly downloads
- [@uplo/adapter-prisma](https://npm.io/package/@uplo/adapter-prisma.md) — 75 weekly downloads
- [typeorm-aios](https://npm.io/package/typeorm-aios.md) — 30 weekly downloads

## Recent versions

- 1.10.1 (latest) — 2026-10-15
- 1.10.0 — 2026-10-15
- 1.9.1 — 2026-10-12
- 1.8.1 — 2026-10-12
- 1.8.0 — 2026-10-08
- 1.7.7 — 2026-10-08
- 1.7.6 — 2026-10-05
- 1.7.5 — 2026-10-04
- 1.7.4 — 2026-10-04
- 1.7.3 — 2026-09-29
- 1.7.2 — 2026-09-26
- 1.7.1 — 2026-09-25
- 1.7.0 — 2026-09-25
- 1.6.3 — 2026-09-23
- 1.6.2 — 2026-09-18
- … 40 more at https://npm.io/package/@neon/config-runtime/versions

## README

# @neon/config-runtime

Imperative runtime for [`@neon/config`](../config): run a `neon.ts` policy against the Neon API — `inspect`, `plan`, `apply` (push/pull) — and bundle + deploy Neon Functions.

> This package pulls in `esbuild`, so import it from your CLI or CI — **not** from a `neon.ts` policy. Keep policies side-effect-free; that's what `@neon/config` is for. New code should import from `@neon/config-runtime/v1` to pin a major.

## Install

```bash
npm install @neon/config-runtime
```

> **Requirements:** Node.js >= 20.19.

## API

- `inspect` / `plan` / `apply` — read the current branch state, diff a policy against it, and apply the changes. `PushResult.customDomains` lists declared hostnames with `slug` and, after apply, `cnameTarget`. Static `customDomains` apply only on the default branch; see [`@neon/config`](../config/README.md#default-branch-only-fields).
- `pullConfig` / `pushConfig` — lower-level pull/push primitives.
- `createBranch` — create a branch to target.
- `buildFunctionBundle` — ZIP a function for deploy, honoring `bundler`. Omit / `"esbuild"`: a file `source` is the entry; a directory is searched for `index.ts`, then `index.js`, then `index.mjs`. `"none"`: zip `source` as-is. An inline function: zip the file map it returns. On the esbuild path, `externalPackages` are passed to esbuild's `external`, and unless an entry sets `includeFiles: false` the package's real files are staged into the archive. Reports a bundled-in native dependency that was never declared, as a warning.
- `bundleAsIs` — read a prebuilt directory or `index.mjs` / `index.js` file into a file map without loading esbuild. The packaged CLI uses this for `bundler: "none"` / `--no-bundle` so it never pulls esbuild into its snapshot. `buildFunctionBundle` calls it for `"none"`; call it directly when you need the file map (for example to write files for `neon dev`) rather than a ZIP.
- `resolveEsbuildEntry` — resolve a file or directory `source` to the esbuild entry path.
- `traceNativePackages` — install the packages a function stages for the runtime target (`RUNTIME_TARGET`: linux-arm64, glibc) into a throwaway directory, trace the files they reach, and return them keyed by archive path with the `node_modules` layout preserved. Called by `buildFunctionBundle`; exported for a CLI that supplies its own bundler.
- `findUndeclaredNativePackages` / `describeNativeFinding` — advisory detection of a native package that was bundled in without being declared, and the report text for it. Evidence only: it cannot prove the code path is reached, so it must never fail a deploy.
- `assertZipWithinLimits` — check a finished archive against the build service's size limits (`DEFAULT_ARCHIVE_LIMITS`), with an error naming the largest files.

```ts
import { inspect, plan, apply } from "@neon/config-runtime/v1";
```

See [`@neon/config`](../config) for authoring the `neon.ts` policy these operate on.
`apply` / `pushConfig` treat explicit `dataApi: false` as a Data API delete (override).
Omitting `dataApi` leaves an existing integration alone.

---
_Source: https://npm.io/package/@neon/config-runtime · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._