@neon/sdk 0.1.0 → 0.2.0

package/README.md

@@ -15,7 +15,7 @@ Two layers, one package:
 npm install @neon/sdk
 ```
 
-Requires Node.js ≥ 22 (or any runtime with a global `fetch` — Bun, Deno, edge, browser).
+Requires Node.js ≥ 20.19 (or any runtime with a global `fetch` — Bun, Deno, edge, browser).
 
 ## Quick start
 

package/dist/_virtual/_rolldown/runtime.js

@@ -1,5 +1,6 @@
 //#region \0rolldown/runtime.js
 var __defProp = Object.defineProperty;
+var __commonJSMin = (cb, mod) => () => (mod || (cb((mod = { exports: {} }).exports, mod), cb = null), mod.exports);
 var __exportAll = (all, no_symbols) => {
 	let target = {};
 	for (var name in all) __defProp(target, name, {
@@ -10,4 +11,4 @@ var __exportAll = (all, no_symbols) => {
 	return target;
 };
 //#endregion
-export { __exportAll };
+export { __commonJSMin, __exportAll };

package/dist/neon/client.test-d.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/neon/client.test-d.js

@@ -0,0 +1,76 @@
+import { createNeonClient } from "./client.js";
+import { it } from "../node_modules/.pnpm/@vitest_runner@3.0.9/node_modules/@vitest/runner/dist/index.js";
+import { import_dist } from "../node_modules/.pnpm/vitest@3.0.9_@types_debug@4.1.13_@types_node@20.19.17_jiti@2.7.0_jsdom@26.1.0_lightning_fb7ae83398b95c49208c9194029bba02/node_modules/vitest/dist/index.js";
+//#region src/neon/client.test-d.ts
+it("default client returns the { data, error } envelope", () => {
+	const neon = createNeonClient({ apiKey: "x" });
+	(0, import_dist.expectTypeOf)(neon.projects.get("p")).resolves.toEqualTypeOf();
+	(0, import_dist.expectTypeOf)(neon.projects.create()).resolves.toEqualTypeOf();
+});
+it("throwOnError on the client narrows methods to the bare resource", () => {
+	(0, import_dist.expectTypeOf)(createNeonClient({
+		apiKey: "x",
+		throwOnError: true
+	}).projects.get("p")).resolves.toEqualTypeOf();
+});
+it("per-call throwOnError overrides the client default and narrows", () => {
+	(0, import_dist.expectTypeOf)(createNeonClient({ apiKey: "x" }).projects.get("p", { throwOnError: true })).resolves.toEqualTypeOf();
+	(0, import_dist.expectTypeOf)(createNeonClient({
+		apiKey: "x",
+		throwOnError: true
+	}).projects.get("p", { throwOnError: false })).resolves.toEqualTypeOf();
+});
+it("branches + workflows carry the envelope and narrow under throwOnError", () => {
+	const neon = createNeonClient({ apiKey: "x" });
+	(0, import_dist.expectTypeOf)(neon.branches.list("p")).toEqualTypeOf();
+	(0, import_dist.expectTypeOf)(neon.branches.get("p", "br")).resolves.toEqualTypeOf();
+	(0, import_dist.expectTypeOf)(neon.branches.createWithCompute("p", { name: "x" })).resolves.toEqualTypeOf();
+	(0, import_dist.expectTypeOf)(neon.projects.createAndConnect({ name: "x" })).resolves.toEqualTypeOf();
+	const throwing = createNeonClient({
+		apiKey: "x",
+		throwOnError: true
+	});
+	(0, import_dist.expectTypeOf)(throwing.branches.createWithCompute("p", { name: "x" })).resolves.toEqualTypeOf();
+	(0, import_dist.expectTypeOf)(throwing.branches.delete("p", "br")).resolves.toEqualTypeOf();
+});
+it("postgres namespace + tier-2/3 resources are reachable and typed", () => {
+	const neon = createNeonClient({ apiKey: "x" });
+	(0, import_dist.expectTypeOf)(neon.postgres.endpoints.list("p")).resolves.toEqualTypeOf();
+	(0, import_dist.expectTypeOf)(neon.postgres.roles.password("p", "br", "neondb_owner")).resolves.toEqualTypeOf();
+	(0, import_dist.expectTypeOf)(neon.postgres.connectionString({ projectId: "p" })).resolves.toEqualTypeOf();
+	(0, import_dist.expectTypeOf)(neon.snapshots.list("p")).resolves.toEqualTypeOf();
+	const throwing = createNeonClient({
+		apiKey: "x",
+		throwOnError: true
+	});
+	(0, import_dist.expectTypeOf)(throwing.postgres.connectionString({ projectId: "p" })).resolves.toEqualTypeOf();
+	(0, import_dist.expectTypeOf)(throwing.postgres.dataApi.delete("p", "br", "neondb")).resolves.toEqualTypeOf();
+});
+it("agent-platform helpers (default org, default branch, transfer, finalize) are typed", () => {
+	const neon = createNeonClient({
+		apiKey: "x",
+		orgId: "org-123"
+	});
+	(0, import_dist.expectTypeOf)(neon.branches.getDefault("p")).resolves.toEqualTypeOf();
+	(0, import_dist.expectTypeOf)(neon.branches.setDefault("p", "br")).resolves.toEqualTypeOf();
+	(0, import_dist.expectTypeOf)(neon.branches.finalizeRestore("p", "br")).resolves.toEqualTypeOf();
+	(0, import_dist.expectTypeOf)(neon.projects.transfer({
+		toOrgId: "org-paid",
+		projectIds: ["p"]
+	})).resolves.toEqualTypeOf();
+	(0, import_dist.expectTypeOf)(neon.snapshots.create("p", "br", {
+		name: "baseline",
+		timestamp: "2026-01-01T00:00:00Z"
+	})).resolves.toEqualTypeOf();
+	(0, import_dist.expectTypeOf)(neon.snapshots.restore("p", "snap", {
+		targetBranchId: "br",
+		preview: (restored) => {
+			(0, import_dist.expectTypeOf)(restored).toEqualTypeOf();
+			return true;
+		}
+	})).resolves.toEqualTypeOf();
+});
+//#endregion
+export {};
+
+//# sourceMappingURL=client.test-d.js.map

package/dist/neon/client.test-d.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.test-d.js","names":[],"sources":["../../src/neon/client.test-d.ts"],"sourcesContent":["import { expectTypeOf, it } from \"vitest\";\nimport type {\n\tBranch,\n\tEndpoint,\n\tProject,\n\tSnapshot,\n} from \"../client/types.gen.js\";\nimport { createNeonClient } from \"./client.js\";\nimport type { Paginated } from \"./paginate.js\";\nimport type { BranchWithCompute } from \"./resources/branches.js\";\nimport type { ProjectConnection } from \"./resources/projects.js\";\nimport type { NeonResult } from \"./result.js\";\n\nit(\"default client returns the { data, error } envelope\", () => {\n\tconst neon = createNeonClient({ apiKey: \"x\" });\n\texpectTypeOf(neon.projects.get(\"p\")).resolves.toEqualTypeOf<\n\t\tNeonResult<Project>\n\t>();\n\texpectTypeOf(neon.projects.create()).resolves.toEqualTypeOf<\n\t\tNeonResult<Project>\n\t>();\n});\n\nit(\"throwOnError on the client narrows methods to the bare resource\", () => {\n\tconst neon = createNeonClient({ apiKey: \"x\", throwOnError: true });\n\texpectTypeOf(neon.projects.get(\"p\")).resolves.toEqualTypeOf<Project>();\n});\n\nit(\"per-call throwOnError overrides the client default and narrows\", () => {\n\tconst neon = createNeonClient({ apiKey: \"x\" });\n\texpectTypeOf(\n\t\tneon.projects.get(\"p\", { throwOnError: true }),\n\t).resolves.toEqualTypeOf<Project>();\n\n\tconst throwing = createNeonClient({ apiKey: \"x\", throwOnError: true });\n\texpectTypeOf(\n\t\tthrowing.projects.get(\"p\", { throwOnError: false }),\n\t).resolves.toEqualTypeOf<NeonResult<Project>>();\n});\n\nit(\"branches + workflows carry the envelope and narrow under throwOnError\", () => {\n\tconst neon = createNeonClient({ apiKey: \"x\" });\n\texpectTypeOf(neon.branches.list(\"p\")).toEqualTypeOf<Paginated<Branch>>();\n\texpectTypeOf(neon.branches.get(\"p\", \"br\")).resolves.toEqualTypeOf<\n\t\tNeonResult<Branch>\n\t>();\n\texpectTypeOf(\n\t\tneon.branches.createWithCompute(\"p\", { name: \"x\" }),\n\t).resolves.toEqualTypeOf<NeonResult<BranchWithCompute>>();\n\texpectTypeOf(\n\t\tneon.projects.createAndConnect({ name: \"x\" }),\n\t).resolves.toEqualTypeOf<NeonResult<ProjectConnection>>();\n\n\tconst throwing = createNeonClient({ apiKey: \"x\", throwOnError: true });\n\texpectTypeOf(\n\t\tthrowing.branches.createWithCompute(\"p\", { name: \"x\" }),\n\t).resolves.toEqualTypeOf<BranchWithCompute>();\n\texpectTypeOf(\n\t\tthrowing.branches.delete(\"p\", \"br\"),\n\t).resolves.toEqualTypeOf<void>();\n});\n\nit(\"postgres namespace + tier-2/3 resources are reachable and typed\", () => {\n\tconst neon = createNeonClient({ apiKey: \"x\" });\n\texpectTypeOf(neon.postgres.endpoints.list(\"p\")).resolves.toEqualTypeOf<\n\t\tNeonResult<Endpoint[]>\n\t>();\n\texpectTypeOf(\n\t\tneon.postgres.roles.password(\"p\", \"br\", \"neondb_owner\"),\n\t).resolves.toEqualTypeOf<NeonResult<string>>();\n\texpectTypeOf(\n\t\tneon.postgres.connectionString({ projectId: \"p\" }),\n\t).resolves.toEqualTypeOf<NeonResult<string>>();\n\texpectTypeOf(neon.snapshots.list(\"p\")).resolves.toEqualTypeOf<\n\t\tNeonResult<Snapshot[]>\n\t>();\n\n\tconst throwing = createNeonClient({ apiKey: \"x\", throwOnError: true });\n\texpectTypeOf(\n\t\tthrowing.postgres.connectionString({ projectId: \"p\" }),\n\t).resolves.toEqualTypeOf<string>();\n\texpectTypeOf(\n\t\tthrowing.postgres.dataApi.delete(\"p\", \"br\", \"neondb\"),\n\t).resolves.toEqualTypeOf<void>();\n});\n\nit(\"agent-platform helpers (default org, default branch, transfer, finalize) are typed\", () => {\n\tconst neon = createNeonClient({ apiKey: \"x\", orgId: \"org-123\" });\n\texpectTypeOf(neon.branches.getDefault(\"p\")).resolves.toEqualTypeOf<\n\t\tNeonResult<Branch>\n\t>();\n\texpectTypeOf(neon.branches.setDefault(\"p\", \"br\")).resolves.toEqualTypeOf<\n\t\tNeonResult<Branch>\n\t>();\n\texpectTypeOf(\n\t\tneon.branches.finalizeRestore(\"p\", \"br\"),\n\t).resolves.toEqualTypeOf<NeonResult<void>>();\n\texpectTypeOf(\n\t\tneon.projects.transfer({ toOrgId: \"org-paid\", projectIds: [\"p\"] }),\n\t).resolves.toEqualTypeOf<NeonResult<void>>();\n\texpectTypeOf(\n\t\tneon.snapshots.create(\"p\", \"br\", {\n\t\t\tname: \"baseline\",\n\t\t\ttimestamp: \"2026-01-01T00:00:00Z\",\n\t\t}),\n\t).resolves.toEqualTypeOf<NeonResult<Snapshot>>();\n\texpectTypeOf(\n\t\tneon.snapshots.restore(\"p\", \"snap\", {\n\t\t\ttargetBranchId: \"br\",\n\t\t\tpreview: (restored) => {\n\t\t\t\texpectTypeOf(restored).toEqualTypeOf<Branch>();\n\t\t\t\treturn true;\n\t\t\t},\n\t\t}),\n\t).resolves.toEqualTypeOf<NeonResult<Branch>>();\n});\n"],"mappings":";;;;AAaA,GAAG,6DAA6D;CAC/D,MAAM,OAAO,iBAAiB,EAAE,QAAQ,IAAI,CAAC;CAC7C,CAAA,GAAA,YAAA,aAAA,CAAa,KAAK,SAAS,IAAI,GAAG,CAAC,CAAC,CAAC,SAAS,cAE5C;CACF,CAAA,GAAA,YAAA,aAAA,CAAa,KAAK,SAAS,OAAO,CAAC,CAAC,CAAC,SAAS,cAE5C;AACH,CAAC;AAED,GAAG,yEAAyE;CAE3E,CAAA,GAAA,YAAA,aAAA,CADa,iBAAiB;EAAE,QAAQ;EAAK,cAAc;CAAK,CAChD,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,CAAC,CAAC,SAAS,cAAuB;AACtE,CAAC;AAED,GAAG,wEAAwE;CAE1E,CAAA,GAAA,YAAA,aAAA,CADa,iBAAiB,EAAE,QAAQ,IAAI,CAExC,CAAC,CAAC,SAAS,IAAI,KAAK,EAAE,cAAc,KAAK,CAAC,CAC9C,CAAC,CAAC,SAAS,cAAuB;CAGlC,CAAA,GAAA,YAAA,aAAA,CADiB,iBAAiB;EAAE,QAAQ;EAAK,cAAc;CAAK,CAE5D,CAAC,CAAC,SAAS,IAAI,KAAK,EAAE,cAAc,MAAM,CAAC,CACnD,CAAC,CAAC,SAAS,cAAmC;AAC/C,CAAC;AAED,GAAG,+EAA+E;CACjF,MAAM,OAAO,iBAAiB,EAAE,QAAQ,IAAI,CAAC;CAC7C,CAAA,GAAA,YAAA,aAAA,CAAa,KAAK,SAAS,KAAK,GAAG,CAAC,CAAC,CAAC,cAAiC;CACvE,CAAA,GAAA,YAAA,aAAA,CAAa,KAAK,SAAS,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,cAElD;CACF,CAAA,GAAA,YAAA,aAAA,CACC,KAAK,SAAS,kBAAkB,KAAK,EAAE,MAAM,IAAI,CAAC,CACnD,CAAC,CAAC,SAAS,cAA6C;CACxD,CAAA,GAAA,YAAA,aAAA,CACC,KAAK,SAAS,iBAAiB,EAAE,MAAM,IAAI,CAAC,CAC7C,CAAC,CAAC,SAAS,cAA6C;CAExD,MAAM,WAAW,iBAAiB;EAAE,QAAQ;EAAK,cAAc;CAAK,CAAC;CACrE,CAAA,GAAA,YAAA,aAAA,CACC,SAAS,SAAS,kBAAkB,KAAK,EAAE,MAAM,IAAI,CAAC,CACvD,CAAC,CAAC,SAAS,cAAiC;CAC5C,CAAA,GAAA,YAAA,aAAA,CACC,SAAS,SAAS,OAAO,KAAK,IAAI,CACnC,CAAC,CAAC,SAAS,cAAoB;AAChC,CAAC;AAED,GAAG,yEAAyE;CAC3E,MAAM,OAAO,iBAAiB,EAAE,QAAQ,IAAI,CAAC;CAC7C,CAAA,GAAA,YAAA,aAAA,CAAa,KAAK,SAAS,UAAU,KAAK,GAAG,CAAC,CAAC,CAAC,SAAS,cAEvD;CACF,CAAA,GAAA,YAAA,aAAA,CACC,KAAK,SAAS,MAAM,SAAS,KAAK,MAAM,cAAc,CACvD,CAAC,CAAC,SAAS,cAAkC;CAC7C,CAAA,GAAA,YAAA,aAAA,CACC,KAAK,SAAS,iBAAiB,EAAE,WAAW,IAAI,CAAC,CAClD,CAAC,CAAC,SAAS,cAAkC;CAC7C,CAAA,GAAA,YAAA,aAAA,CAAa,KAAK,UAAU,KAAK,GAAG,CAAC,CAAC,CAAC,SAAS,cAE9C;CAEF,MAAM,WAAW,iBAAiB;EAAE,QAAQ;EAAK,cAAc;CAAK,CAAC;CACrE,CAAA,GAAA,YAAA,aAAA,CACC,SAAS,SAAS,iBAAiB,EAAE,WAAW,IAAI,CAAC,CACtD,CAAC,CAAC,SAAS,cAAsB;CACjC,CAAA,GAAA,YAAA,aAAA,CACC,SAAS,SAAS,QAAQ,OAAO,KAAK,MAAM,QAAQ,CACrD,CAAC,CAAC,SAAS,cAAoB;AAChC,CAAC;AAED,GAAG,4FAA4F;CAC9F,MAAM,OAAO,iBAAiB;EAAE,QAAQ;EAAK,OAAO;CAAU,CAAC;CAC/D,CAAA,GAAA,YAAA,aAAA,CAAa,KAAK,SAAS,WAAW,GAAG,CAAC,CAAC,CAAC,SAAS,cAEnD;CACF,CAAA,GAAA,YAAA,aAAA,CAAa,KAAK,SAAS,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,cAEzD;CACF,CAAA,GAAA,YAAA,aAAA,CACC,KAAK,SAAS,gBAAgB,KAAK,IAAI,CACxC,CAAC,CAAC,SAAS,cAAgC;CAC3C,CAAA,GAAA,YAAA,aAAA,CACC,KAAK,SAAS,SAAS;EAAE,SAAS;EAAY,YAAY,CAAC,GAAG;CAAE,CAAC,CAClE,CAAC,CAAC,SAAS,cAAgC;CAC3C,CAAA,GAAA,YAAA,aAAA,CACC,KAAK,UAAU,OAAO,KAAK,MAAM;EAChC,MAAM;EACN,WAAW;CACZ,CAAC,CACF,CAAC,CAAC,SAAS,cAAoC;CAC/C,CAAA,GAAA,YAAA,aAAA,CACC,KAAK,UAAU,QAAQ,KAAK,QAAQ;EACnC,gBAAgB;EAChB,UAAU,aAAa;GACtB,CAAA,GAAA,YAAA,aAAA,CAAa,QAAQ,CAAC,CAAC,cAAsB;GAC7C,OAAO;EACR;CACD,CAAC,CACF,CAAC,CAAC,SAAS,cAAkC;AAC9C,CAAC"}

package/dist/neon/resources/postgres.d.ts

@@ -34,7 +34,7 @@ declare class Postgres<DThrow extends boolean> {
   constructor(ctx: RequestContext);
   /**
    * Resolve a Postgres connection string. Auto-selects the default branch and the sole
-   * role/database when not specified (mirrors `@neondatabase/config`'s `fetchEnv`); returns
+   * role/database when not specified (mirrors `@neon/config`'s `fetchEnv`); returns
    * a `client`-kind {@link NeonError} when the selection is ambiguous.
    */
   connectionString(params: ConnectionStringParams): Promise<Outcome<string, DThrow>>;

package/dist/neon/resources/postgres.js.map

@@ -1 +1 @@
-{"version":3,"file":"postgres.js","names":["#ctx","#resolve"],"sources":["../../../src/neon/resources/postgres.ts"],"sourcesContent":["import {\n\tgetConnectionUri,\n\tlistProjectBranchDatabases,\n\tlistProjectBranches,\n\tlistProjectBranchRoles,\n} from \"../../client/sdk.gen.js\";\nimport type { CallOptions, RequestContext } from \"../context.js\";\nimport { NeonError, toNeonError } from \"../errors.js\";\nimport { err, finalize, type NeonResult, type Outcome, ok } from \"../result.js\";\nimport { DataApi } from \"./dataapi.js\";\nimport { Databases } from \"./databases.js\";\nimport { Endpoints } from \"./endpoints.js\";\nimport { Roles } from \"./roles.js\";\n\n/** Parameters for {@link Postgres.connectionString}. */\nexport interface ConnectionStringParams {\n\tprojectId: string;\n\t/** Defaults to the project's default branch. */\n\tbranchId?: string;\n\t/** Defaults to the branch's read-write endpoint. */\n\tendpointId?: string;\n\t/** Auto-selected when the branch has exactly one database. */\n\tdatabaseName?: string;\n\t/** Auto-selected when the branch has exactly one role. */\n\troleName?: string;\n\t/** Pooled connection string (default `true`). */\n\tpooled?: boolean;\n}\n\n/**\n * The Postgres data plane of a branch: compute endpoints, roles, databases, the Data API,\n * and a connection-string helper. (Grouped under `neon.postgres.*` so future top-level\n * namespaces like `functions` / `storage` stay unambiguous.)\n */\nexport class Postgres<DThrow extends boolean> {\n\treadonly endpoints: Endpoints<DThrow>;\n\treadonly roles: Roles<DThrow>;\n\treadonly databases: Databases<DThrow>;\n\treadonly dataApi: DataApi<DThrow>;\n\treadonly #ctx: RequestContext;\n\n\tconstructor(ctx: RequestContext) {\n\t\tthis.#ctx = ctx;\n\t\tthis.endpoints = new Endpoints<DThrow>(ctx);\n\t\tthis.roles = new Roles<DThrow>(ctx);\n\t\tthis.databases = new Databases<DThrow>(ctx);\n\t\tthis.dataApi = new DataApi<DThrow>(ctx);\n\t}\n\n\t/**\n\t * Resolve a Postgres connection string. Auto-selects the default branch and the sole\n\t * role/database when not specified (mirrors `@neondatabase/config`'s `fetchEnv`); returns\n\t * a `client`-kind {@link NeonError} when the selection is ambiguous.\n\t */\n\tconnectionString(\n\t\tparams: ConnectionStringParams,\n\t): Promise<Outcome<string, DThrow>>;\n\tconnectionString<Throw extends boolean = DThrow>(\n\t\tparams: ConnectionStringParams,\n\t\topts: CallOptions<Throw>,\n\t): Promise<Outcome<string, Throw>>;\n\tasync connectionString(\n\t\tparams: ConnectionStringParams,\n\t\topts?: CallOptions,\n\t): Promise<string | NeonResult<string>> {\n\t\tconst shouldThrow =\n\t\t\topts?.throwOnError ?? this.#ctx.defaults.throwOnError;\n\t\treturn finalize(await this.#resolve(params, opts?.signal), shouldThrow);\n\t}\n\n\tasync #resolve(\n\t\tparams: ConnectionStringParams,\n\t\tsignal?: AbortSignal,\n\t): Promise<NeonResult<string>> {\n\t\tconst client = this.#ctx.client;\n\t\tconst projectId = params.projectId;\n\t\tlet branchId = params.branchId;\n\t\tlet roleName = params.roleName;\n\t\tlet databaseName = params.databaseName;\n\n\t\tif ((!roleName || !databaseName) && !branchId) {\n\t\t\tconst branches = await listProjectBranches({\n\t\t\t\tclient,\n\t\t\t\tpath: { project_id: projectId },\n\t\t\t\tthrowOnError: false,\n\t\t\t\tsignal,\n\t\t\t});\n\t\t\tif (branches.error || !branches.data) {\n\t\t\t\treturn err(toNeonError(branches.error, branches.response));\n\t\t\t}\n\t\t\tbranchId = branches.data.branches.find(\n\t\t\t\t(branch) => branch.default,\n\t\t\t)?.id;\n\t\t\tif (!branchId) {\n\t\t\t\treturn err(\n\t\t\t\t\tnew NeonError(\n\t\t\t\t\t\t\"Could not determine the default branch; pass branchId.\",\n\t\t\t\t\t\t\"client\",\n\t\t\t\t\t),\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\n\t\tif (!roleName) {\n\t\t\tif (!branchId) return err(branchRequired(\"roleName\"));\n\t\t\tconst roles = await listProjectBranchRoles({\n\t\t\t\tclient,\n\t\t\t\tpath: { project_id: projectId, branch_id: branchId },\n\t\t\t\tthrowOnError: false,\n\t\t\t\tsignal,\n\t\t\t});\n\t\t\tif (roles.error || !roles.data)\n\t\t\t\treturn err(toNeonError(roles.error, roles.response));\n\t\t\tif (roles.data.roles.length !== 1) {\n\t\t\t\treturn err(\n\t\t\t\t\tambiguous(\"role\", roles.data.roles.length, \"roleName\"),\n\t\t\t\t);\n\t\t\t}\n\t\t\troleName = roles.data.roles[0].name;\n\t\t}\n\n\t\tif (!databaseName) {\n\t\t\tif (!branchId) return err(branchRequired(\"databaseName\"));\n\t\t\tconst databases = await listProjectBranchDatabases({\n\t\t\t\tclient,\n\t\t\t\tpath: { project_id: projectId, branch_id: branchId },\n\t\t\t\tthrowOnError: false,\n\t\t\t\tsignal,\n\t\t\t});\n\t\t\tif (databases.error || !databases.data) {\n\t\t\t\treturn err(toNeonError(databases.error, databases.response));\n\t\t\t}\n\t\t\tif (databases.data.databases.length !== 1) {\n\t\t\t\treturn err(\n\t\t\t\t\tambiguous(\n\t\t\t\t\t\t\"database\",\n\t\t\t\t\t\tdatabases.data.databases.length,\n\t\t\t\t\t\t\"databaseName\",\n\t\t\t\t\t),\n\t\t\t\t);\n\t\t\t}\n\t\t\tdatabaseName = databases.data.databases[0].name;\n\t\t}\n\n\t\tconst conn = await getConnectionUri({\n\t\t\tclient,\n\t\t\tpath: { project_id: projectId },\n\t\t\tquery: {\n\t\t\t\tbranch_id: branchId,\n\t\t\t\tendpoint_id: params.endpointId,\n\t\t\t\tdatabase_name: databaseName,\n\t\t\t\trole_name: roleName,\n\t\t\t\tpooled: params.pooled ?? true,\n\t\t\t},\n\t\t\tthrowOnError: false,\n\t\t\tsignal,\n\t\t});\n\t\tif (conn.error || !conn.data)\n\t\t\treturn err(toNeonError(conn.error, conn.response));\n\t\treturn ok(conn.data.uri);\n\t}\n}\n\nfunction branchRequired(param: string): NeonError {\n\treturn new NeonError(\n\t\t`Pass branchId or ${param} to resolve a connection string.`,\n\t\t\"client\",\n\t);\n}\n\nfunction ambiguous(kind: string, count: number, param: string): NeonError {\n\treturn new NeonError(\n\t\t`Expected exactly one ${kind} to auto-select for the connection string; found ${count}. Pass ${param}.`,\n\t\t\"client\",\n\t);\n}\n"],"mappings":";;;;;;;;;;;;;AAkCA,IAAa,WAAb,MAA8C;CAC7C;CACA;CACA;CACA;CACA;CAEA,YAAY,KAAqB;EAChC,KAAKA,OAAO;EACZ,KAAK,YAAY,IAAI,UAAkB,GAAG;EAC1C,KAAK,QAAQ,IAAI,MAAc,GAAG;EAClC,KAAK,YAAY,IAAI,UAAkB,GAAG;EAC1C,KAAK,UAAU,IAAI,QAAgB,GAAG;CACvC;CAcA,MAAM,iBACL,QACA,MACuC;EACvC,MAAM,cACL,MAAM,gBAAgB,KAAKA,KAAK,SAAS;EAC1C,OAAO,SAAS,MAAM,KAAKC,SAAS,QAAQ,MAAM,MAAM,GAAG,WAAW;CACvE;CAEA,MAAMA,SACL,QACA,QAC8B;EAC9B,MAAM,SAAS,KAAKD,KAAK;EACzB,MAAM,YAAY,OAAO;EACzB,IAAI,WAAW,OAAO;EACtB,IAAI,WAAW,OAAO;EACtB,IAAI,eAAe,OAAO;EAE1B,KAAK,CAAC,YAAY,CAAC,iBAAiB,CAAC,UAAU;GAC9C,MAAM,WAAW,MAAM,oBAAoB;IAC1C;IACA,MAAM,EAAE,YAAY,UAAU;IAC9B,cAAc;IACd;GACD,CAAC;GACD,IAAI,SAAS,SAAS,CAAC,SAAS,MAC/B,OAAO,IAAI,YAAY,SAAS,OAAO,SAAS,QAAQ,CAAC;GAE1D,WAAW,SAAS,KAAK,SAAS,MAChC,WAAW,OAAO,OACpB,CAAC,EAAE;GACH,IAAI,CAAC,UACJ,OAAO,IACN,IAAI,UACH,0DACA,QACD,CACD;EAEF;EAEA,IAAI,CAAC,UAAU;GACd,IAAI,CAAC,UAAU,OAAO,IAAI,eAAe,UAAU,CAAC;GACpD,MAAM,QAAQ,MAAM,uBAAuB;IAC1C;IACA,MAAM;KAAE,YAAY;KAAW,WAAW;IAAS;IACnD,cAAc;IACd;GACD,CAAC;GACD,IAAI,MAAM,SAAS,CAAC,MAAM,MACzB,OAAO,IAAI,YAAY,MAAM,OAAO,MAAM,QAAQ,CAAC;GACpD,IAAI,MAAM,KAAK,MAAM,WAAW,GAC/B,OAAO,IACN,UAAU,QAAQ,MAAM,KAAK,MAAM,QAAQ,UAAU,CACtD;GAED,WAAW,MAAM,KAAK,MAAM,EAAE,CAAC;EAChC;EAEA,IAAI,CAAC,cAAc;GAClB,IAAI,CAAC,UAAU,OAAO,IAAI,eAAe,cAAc,CAAC;GACxD,MAAM,YAAY,MAAM,2BAA2B;IAClD;IACA,MAAM;KAAE,YAAY;KAAW,WAAW;IAAS;IACnD,cAAc;IACd;GACD,CAAC;GACD,IAAI,UAAU,SAAS,CAAC,UAAU,MACjC,OAAO,IAAI,YAAY,UAAU,OAAO,UAAU,QAAQ,CAAC;GAE5D,IAAI,UAAU,KAAK,UAAU,WAAW,GACvC,OAAO,IACN,UACC,YACA,UAAU,KAAK,UAAU,QACzB,cACD,CACD;GAED,eAAe,UAAU,KAAK,UAAU,EAAE,CAAC;EAC5C;EAEA,MAAM,OAAO,MAAM,iBAAiB;GACnC;GACA,MAAM,EAAE,YAAY,UAAU;GAC9B,OAAO;IACN,WAAW;IACX,aAAa,OAAO;IACpB,eAAe;IACf,WAAW;IACX,QAAQ,OAAO,UAAU;GAC1B;GACA,cAAc;GACd;EACD,CAAC;EACD,IAAI,KAAK,SAAS,CAAC,KAAK,MACvB,OAAO,IAAI,YAAY,KAAK,OAAO,KAAK,QAAQ,CAAC;EAClD,OAAO,GAAG,KAAK,KAAK,GAAG;CACxB;AACD;AAEA,SAAS,eAAe,OAA0B;CACjD,OAAO,IAAI,UACV,oBAAoB,MAAM,mCAC1B,QACD;AACD;AAEA,SAAS,UAAU,MAAc,OAAe,OAA0B;CACzE,OAAO,IAAI,UACV,wBAAwB,KAAK,mDAAmD,MAAM,SAAS,MAAM,IACrG,QACD;AACD"}
+{"version":3,"file":"postgres.js","names":["#ctx","#resolve"],"sources":["../../../src/neon/resources/postgres.ts"],"sourcesContent":["import {\n\tgetConnectionUri,\n\tlistProjectBranchDatabases,\n\tlistProjectBranches,\n\tlistProjectBranchRoles,\n} from \"../../client/sdk.gen.js\";\nimport type { CallOptions, RequestContext } from \"../context.js\";\nimport { NeonError, toNeonError } from \"../errors.js\";\nimport { err, finalize, type NeonResult, type Outcome, ok } from \"../result.js\";\nimport { DataApi } from \"./dataapi.js\";\nimport { Databases } from \"./databases.js\";\nimport { Endpoints } from \"./endpoints.js\";\nimport { Roles } from \"./roles.js\";\n\n/** Parameters for {@link Postgres.connectionString}. */\nexport interface ConnectionStringParams {\n\tprojectId: string;\n\t/** Defaults to the project's default branch. */\n\tbranchId?: string;\n\t/** Defaults to the branch's read-write endpoint. */\n\tendpointId?: string;\n\t/** Auto-selected when the branch has exactly one database. */\n\tdatabaseName?: string;\n\t/** Auto-selected when the branch has exactly one role. */\n\troleName?: string;\n\t/** Pooled connection string (default `true`). */\n\tpooled?: boolean;\n}\n\n/**\n * The Postgres data plane of a branch: compute endpoints, roles, databases, the Data API,\n * and a connection-string helper. (Grouped under `neon.postgres.*` so future top-level\n * namespaces like `functions` / `storage` stay unambiguous.)\n */\nexport class Postgres<DThrow extends boolean> {\n\treadonly endpoints: Endpoints<DThrow>;\n\treadonly roles: Roles<DThrow>;\n\treadonly databases: Databases<DThrow>;\n\treadonly dataApi: DataApi<DThrow>;\n\treadonly #ctx: RequestContext;\n\n\tconstructor(ctx: RequestContext) {\n\t\tthis.#ctx = ctx;\n\t\tthis.endpoints = new Endpoints<DThrow>(ctx);\n\t\tthis.roles = new Roles<DThrow>(ctx);\n\t\tthis.databases = new Databases<DThrow>(ctx);\n\t\tthis.dataApi = new DataApi<DThrow>(ctx);\n\t}\n\n\t/**\n\t * Resolve a Postgres connection string. Auto-selects the default branch and the sole\n\t * role/database when not specified (mirrors `@neon/config`'s `fetchEnv`); returns\n\t * a `client`-kind {@link NeonError} when the selection is ambiguous.\n\t */\n\tconnectionString(\n\t\tparams: ConnectionStringParams,\n\t): Promise<Outcome<string, DThrow>>;\n\tconnectionString<Throw extends boolean = DThrow>(\n\t\tparams: ConnectionStringParams,\n\t\topts: CallOptions<Throw>,\n\t): Promise<Outcome<string, Throw>>;\n\tasync connectionString(\n\t\tparams: ConnectionStringParams,\n\t\topts?: CallOptions,\n\t): Promise<string | NeonResult<string>> {\n\t\tconst shouldThrow =\n\t\t\topts?.throwOnError ?? this.#ctx.defaults.throwOnError;\n\t\treturn finalize(await this.#resolve(params, opts?.signal), shouldThrow);\n\t}\n\n\tasync #resolve(\n\t\tparams: ConnectionStringParams,\n\t\tsignal?: AbortSignal,\n\t): Promise<NeonResult<string>> {\n\t\tconst client = this.#ctx.client;\n\t\tconst projectId = params.projectId;\n\t\tlet branchId = params.branchId;\n\t\tlet roleName = params.roleName;\n\t\tlet databaseName = params.databaseName;\n\n\t\tif ((!roleName || !databaseName) && !branchId) {\n\t\t\tconst branches = await listProjectBranches({\n\t\t\t\tclient,\n\t\t\t\tpath: { project_id: projectId },\n\t\t\t\tthrowOnError: false,\n\t\t\t\tsignal,\n\t\t\t});\n\t\t\tif (branches.error || !branches.data) {\n\t\t\t\treturn err(toNeonError(branches.error, branches.response));\n\t\t\t}\n\t\t\tbranchId = branches.data.branches.find(\n\t\t\t\t(branch) => branch.default,\n\t\t\t)?.id;\n\t\t\tif (!branchId) {\n\t\t\t\treturn err(\n\t\t\t\t\tnew NeonError(\n\t\t\t\t\t\t\"Could not determine the default branch; pass branchId.\",\n\t\t\t\t\t\t\"client\",\n\t\t\t\t\t),\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\n\t\tif (!roleName) {\n\t\t\tif (!branchId) return err(branchRequired(\"roleName\"));\n\t\t\tconst roles = await listProjectBranchRoles({\n\t\t\t\tclient,\n\t\t\t\tpath: { project_id: projectId, branch_id: branchId },\n\t\t\t\tthrowOnError: false,\n\t\t\t\tsignal,\n\t\t\t});\n\t\t\tif (roles.error || !roles.data)\n\t\t\t\treturn err(toNeonError(roles.error, roles.response));\n\t\t\tif (roles.data.roles.length !== 1) {\n\t\t\t\treturn err(\n\t\t\t\t\tambiguous(\"role\", roles.data.roles.length, \"roleName\"),\n\t\t\t\t);\n\t\t\t}\n\t\t\troleName = roles.data.roles[0].name;\n\t\t}\n\n\t\tif (!databaseName) {\n\t\t\tif (!branchId) return err(branchRequired(\"databaseName\"));\n\t\t\tconst databases = await listProjectBranchDatabases({\n\t\t\t\tclient,\n\t\t\t\tpath: { project_id: projectId, branch_id: branchId },\n\t\t\t\tthrowOnError: false,\n\t\t\t\tsignal,\n\t\t\t});\n\t\t\tif (databases.error || !databases.data) {\n\t\t\t\treturn err(toNeonError(databases.error, databases.response));\n\t\t\t}\n\t\t\tif (databases.data.databases.length !== 1) {\n\t\t\t\treturn err(\n\t\t\t\t\tambiguous(\n\t\t\t\t\t\t\"database\",\n\t\t\t\t\t\tdatabases.data.databases.length,\n\t\t\t\t\t\t\"databaseName\",\n\t\t\t\t\t),\n\t\t\t\t);\n\t\t\t}\n\t\t\tdatabaseName = databases.data.databases[0].name;\n\t\t}\n\n\t\tconst conn = await getConnectionUri({\n\t\t\tclient,\n\t\t\tpath: { project_id: projectId },\n\t\t\tquery: {\n\t\t\t\tbranch_id: branchId,\n\t\t\t\tendpoint_id: params.endpointId,\n\t\t\t\tdatabase_name: databaseName,\n\t\t\t\trole_name: roleName,\n\t\t\t\tpooled: params.pooled ?? true,\n\t\t\t},\n\t\t\tthrowOnError: false,\n\t\t\tsignal,\n\t\t});\n\t\tif (conn.error || !conn.data)\n\t\t\treturn err(toNeonError(conn.error, conn.response));\n\t\treturn ok(conn.data.uri);\n\t}\n}\n\nfunction branchRequired(param: string): NeonError {\n\treturn new NeonError(\n\t\t`Pass branchId or ${param} to resolve a connection string.`,\n\t\t\"client\",\n\t);\n}\n\nfunction ambiguous(kind: string, count: number, param: string): NeonError {\n\treturn new NeonError(\n\t\t`Expected exactly one ${kind} to auto-select for the connection string; found ${count}. Pass ${param}.`,\n\t\t\"client\",\n\t);\n}\n"],"mappings":";;;;;;;;;;;;;AAkCA,IAAa,WAAb,MAA8C;CAC7C;CACA;CACA;CACA;CACA;CAEA,YAAY,KAAqB;EAChC,KAAKA,OAAO;EACZ,KAAK,YAAY,IAAI,UAAkB,GAAG;EAC1C,KAAK,QAAQ,IAAI,MAAc,GAAG;EAClC,KAAK,YAAY,IAAI,UAAkB,GAAG;EAC1C,KAAK,UAAU,IAAI,QAAgB,GAAG;CACvC;CAcA,MAAM,iBACL,QACA,MACuC;EACvC,MAAM,cACL,MAAM,gBAAgB,KAAKA,KAAK,SAAS;EAC1C,OAAO,SAAS,MAAM,KAAKC,SAAS,QAAQ,MAAM,MAAM,GAAG,WAAW;CACvE;CAEA,MAAMA,SACL,QACA,QAC8B;EAC9B,MAAM,SAAS,KAAKD,KAAK;EACzB,MAAM,YAAY,OAAO;EACzB,IAAI,WAAW,OAAO;EACtB,IAAI,WAAW,OAAO;EACtB,IAAI,eAAe,OAAO;EAE1B,KAAK,CAAC,YAAY,CAAC,iBAAiB,CAAC,UAAU;GAC9C,MAAM,WAAW,MAAM,oBAAoB;IAC1C;IACA,MAAM,EAAE,YAAY,UAAU;IAC9B,cAAc;IACd;GACD,CAAC;GACD,IAAI,SAAS,SAAS,CAAC,SAAS,MAC/B,OAAO,IAAI,YAAY,SAAS,OAAO,SAAS,QAAQ,CAAC;GAE1D,WAAW,SAAS,KAAK,SAAS,MAChC,WAAW,OAAO,OACpB,CAAC,EAAE;GACH,IAAI,CAAC,UACJ,OAAO,IACN,IAAI,UACH,0DACA,QACD,CACD;EAEF;EAEA,IAAI,CAAC,UAAU;GACd,IAAI,CAAC,UAAU,OAAO,IAAI,eAAe,UAAU,CAAC;GACpD,MAAM,QAAQ,MAAM,uBAAuB;IAC1C;IACA,MAAM;KAAE,YAAY;KAAW,WAAW;IAAS;IACnD,cAAc;IACd;GACD,CAAC;GACD,IAAI,MAAM,SAAS,CAAC,MAAM,MACzB,OAAO,IAAI,YAAY,MAAM,OAAO,MAAM,QAAQ,CAAC;GACpD,IAAI,MAAM,KAAK,MAAM,WAAW,GAC/B,OAAO,IACN,UAAU,QAAQ,MAAM,KAAK,MAAM,QAAQ,UAAU,CACtD;GAED,WAAW,MAAM,KAAK,MAAM,EAAE,CAAC;EAChC;EAEA,IAAI,CAAC,cAAc;GAClB,IAAI,CAAC,UAAU,OAAO,IAAI,eAAe,cAAc,CAAC;GACxD,MAAM,YAAY,MAAM,2BAA2B;IAClD;IACA,MAAM;KAAE,YAAY;KAAW,WAAW;IAAS;IACnD,cAAc;IACd;GACD,CAAC;GACD,IAAI,UAAU,SAAS,CAAC,UAAU,MACjC,OAAO,IAAI,YAAY,UAAU,OAAO,UAAU,QAAQ,CAAC;GAE5D,IAAI,UAAU,KAAK,UAAU,WAAW,GACvC,OAAO,IACN,UACC,YACA,UAAU,KAAK,UAAU,QACzB,cACD,CACD;GAED,eAAe,UAAU,KAAK,UAAU,EAAE,CAAC;EAC5C;EAEA,MAAM,OAAO,MAAM,iBAAiB;GACnC;GACA,MAAM,EAAE,YAAY,UAAU;GAC9B,OAAO;IACN,WAAW;IACX,aAAa,OAAO;IACpB,eAAe;IACf,WAAW;IACX,QAAQ,OAAO,UAAU;GAC1B;GACA,cAAc;GACd;EACD,CAAC;EACD,IAAI,KAAK,SAAS,CAAC,KAAK,MACvB,OAAO,IAAI,YAAY,KAAK,OAAO,KAAK,QAAQ,CAAC;EAClD,OAAO,GAAG,KAAK,KAAK,GAAG;CACxB;AACD;AAEA,SAAS,eAAe,OAA0B;CACjD,OAAO,IAAI,UACV,oBAAoB,MAAM,mCAC1B,QACD;AACD;AAEA,SAAS,UAAU,MAAc,OAAe,OAA0B;CACzE,OAAO,IAAI,UACV,wBAAwB,KAAK,mDAAmD,MAAM,SAAS,MAAM,IACrG,QACD;AACD"}