@neon/sdk 0.0.0 → 0.1.0

package/dist/neon/context.js

@@ -0,0 +1,59 @@
+import { toNeonError } from "./errors.js";
+import { err, finalize, ok } from "./result.js";
+import { withRetries } from "./retry.js";
+import { hasOperations, waitForOperations } from "./wait.js";
+//#region src/neon/context.ts
+/**
+* Shared execution core: runs a raw client call with retries, maps its envelope to the
+* ergonomic resource shape, optionally waits for provisioning operations, and applies the
+* resolved `throwOnError` policy. Returns the bare value (throwing) or a {@link NeonResult}.
+*/
+var RequestContext = class {
+	#config;
+	constructor(config) {
+		this.#config = config;
+	}
+	get client() {
+		return this.#config.client;
+	}
+	get defaults() {
+		return this.#config;
+	}
+	/** Run a raw call and map its body; applies the resolved `throwOnError` policy. */
+	async run(opts, exec, map) {
+		const shouldThrow = opts?.throwOnError ?? this.#config.throwOnError;
+		return finalize(await this.execute(opts, exec, map), shouldThrow);
+	}
+	/** Like {@link run} but for endpoints that may return an empty (204) body. */
+	async runVoid(opts, exec) {
+		const shouldThrow = opts?.throwOnError ?? this.#config.throwOnError;
+		const raw = await withRetries(() => exec(this.#config.client), this.#config.retries, opts?.signal);
+		if (raw.error !== void 0) return finalize(err(toNeonError(raw.error, raw.response)), shouldThrow);
+		const readiness = await this.#maybeWait(opts, raw.data);
+		if (readiness?.error) return finalize(err(readiness.error), shouldThrow);
+		return finalize(ok(void 0), shouldThrow);
+	}
+	/**
+	* Run a raw call and map its body, returning the {@link NeonResult} envelope (no
+	* throw). Used by `run` and by workflows that post-process the result.
+	*/
+	async execute(opts, exec, map) {
+		const raw = await withRetries(() => exec(this.#config.client), this.#config.retries, opts?.signal);
+		if (raw.error || raw.data === void 0) return err(toNeonError(raw.error, raw.response));
+		const readiness = await this.#maybeWait(opts, raw.data);
+		if (readiness?.error) return err(readiness.error);
+		return ok(map(raw.data));
+	}
+	/** Poll provisioning operations when `waitForReadiness` is on and the body has any. */
+	async #maybeWait(opts, data) {
+		if (!(opts?.waitForReadiness ?? this.#config.waitForReadiness) || !hasOperations(data)) return void 0;
+		return waitForOperations(this.#config.client, data.operations, {
+			...this.#config.waitOptions,
+			signal: opts?.signal ?? this.#config.waitOptions.signal
+		});
+	}
+};
+//#endregion
+export { RequestContext };
+
+//# sourceMappingURL=context.js.map

package/dist/neon/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","names":["#config","#maybeWait"],"sources":["../../src/neon/context.ts"],"sourcesContent":["import type { Client } from \"../client/client/index.js\";\nimport { toNeonError } from \"./errors.js\";\nimport { err, finalize, type NeonResult, ok } from \"./result.js\";\nimport { withRetries } from \"./retry.js\";\nimport {\n\thasOperations,\n\ttype WaitForOptions,\n\twaitForOperations,\n} from \"./wait.js\";\n\n/** Fully-resolved runtime configuration shared by every resource namespace. */\nexport interface ResolvedConfig {\n\tclient: Client;\n\tthrowOnError: boolean;\n\tretries: number;\n\twaitForReadiness: boolean;\n\twaitOptions: WaitForOptions;\n\torgId?: string;\n}\n\n/** Per-call overrides accepted by every ergonomic method. */\nexport interface CallOptions<Throw extends boolean = boolean> {\n\t/** Override the client's `throwOnError` for this call. */\n\tthrowOnError?: Throw;\n\t/** Override the client's `waitForReadiness` for this call (mutations only). */\n\twaitForReadiness?: boolean;\n\tsignal?: AbortSignal;\n}\n\ninterface RawResult<D> {\n\tdata?: D | undefined;\n\terror?: unknown;\n\tresponse?: Response | undefined;\n}\n\n/**\n * Shared execution core: runs a raw client call with retries, maps its envelope to the\n * ergonomic resource shape, optionally waits for provisioning operations, and applies the\n * resolved `throwOnError` policy. Returns the bare value (throwing) or a {@link NeonResult}.\n */\nexport class RequestContext {\n\treadonly #config: ResolvedConfig;\n\n\tconstructor(config: ResolvedConfig) {\n\t\tthis.#config = config;\n\t}\n\n\tget client(): Client {\n\t\treturn this.#config.client;\n\t}\n\n\tget defaults(): ResolvedConfig {\n\t\treturn this.#config;\n\t}\n\n\t/** Run a raw call and map its body; applies the resolved `throwOnError` policy. */\n\tasync run<D, T>(\n\t\topts: CallOptions | undefined,\n\t\texec: (client: Client) => Promise<RawResult<D>>,\n\t\tmap: (data: D) => T,\n\t): Promise<T | NeonResult<T>> {\n\t\tconst shouldThrow = opts?.throwOnError ?? this.#config.throwOnError;\n\t\treturn finalize(await this.execute(opts, exec, map), shouldThrow);\n\t}\n\n\t/** Like {@link run} but for endpoints that may return an empty (204) body. */\n\tasync runVoid<D>(\n\t\topts: CallOptions | undefined,\n\t\texec: (client: Client) => Promise<RawResult<D>>,\n\t): Promise<void | NeonResult<void>> {\n\t\tconst shouldThrow = opts?.throwOnError ?? this.#config.throwOnError;\n\t\tconst raw = await withRetries(\n\t\t\t() => exec(this.#config.client),\n\t\t\tthis.#config.retries,\n\t\t\topts?.signal,\n\t\t);\n\t\tif (raw.error !== undefined) {\n\t\t\treturn finalize(\n\t\t\t\terr<void>(toNeonError(raw.error, raw.response)),\n\t\t\t\tshouldThrow,\n\t\t\t);\n\t\t}\n\t\tconst readiness = await this.#maybeWait(opts, raw.data);\n\t\tif (readiness?.error)\n\t\t\treturn finalize(err<void>(readiness.error), shouldThrow);\n\t\treturn finalize(ok(undefined), shouldThrow);\n\t}\n\n\t/**\n\t * Run a raw call and map its body, returning the {@link NeonResult} envelope (no\n\t * throw). Used by `run` and by workflows that post-process the result.\n\t */\n\tasync execute<D, T>(\n\t\topts: CallOptions | undefined,\n\t\texec: (client: Client) => Promise<RawResult<D>>,\n\t\tmap: (data: D) => T,\n\t): Promise<NeonResult<T>> {\n\t\tconst raw = await withRetries(\n\t\t\t() => exec(this.#config.client),\n\t\t\tthis.#config.retries,\n\t\t\topts?.signal,\n\t\t);\n\t\tif (raw.error || raw.data === undefined) {\n\t\t\treturn err(toNeonError(raw.error, raw.response));\n\t\t}\n\t\tconst readiness = await this.#maybeWait(opts, raw.data);\n\t\tif (readiness?.error) return err(readiness.error);\n\t\treturn ok(map(raw.data));\n\t}\n\n\t/** Poll provisioning operations when `waitForReadiness` is on and the body has any. */\n\tasync #maybeWait(\n\t\topts: CallOptions | undefined,\n\t\tdata: unknown,\n\t): Promise<NeonResult<void> | undefined> {\n\t\tconst wait = opts?.waitForReadiness ?? this.#config.waitForReadiness;\n\t\tif (!wait || !hasOperations(data)) return undefined;\n\t\treturn waitForOperations(this.#config.client, data.operations, {\n\t\t\t...this.#config.waitOptions,\n\t\t\tsignal: opts?.signal ?? this.#config.waitOptions.signal,\n\t\t});\n\t}\n}\n"],"mappings":";;;;;;;;;;AAwCA,IAAa,iBAAb,MAA4B;CAC3B;CAEA,YAAY,QAAwB;EACnC,KAAKA,UAAU;CAChB;CAEA,IAAI,SAAiB;EACpB,OAAO,KAAKA,QAAQ;CACrB;CAEA,IAAI,WAA2B;EAC9B,OAAO,KAAKA;CACb;;CAGA,MAAM,IACL,MACA,MACA,KAC6B;EAC7B,MAAM,cAAc,MAAM,gBAAgB,KAAKA,QAAQ;EACvD,OAAO,SAAS,MAAM,KAAK,QAAQ,MAAM,MAAM,GAAG,GAAG,WAAW;CACjE;;CAGA,MAAM,QACL,MACA,MACmC;EACnC,MAAM,cAAc,MAAM,gBAAgB,KAAKA,QAAQ;EACvD,MAAM,MAAM,MAAM,kBACX,KAAK,KAAKA,QAAQ,MAAM,GAC9B,KAAKA,QAAQ,SACb,MAAM,MACP;EACA,IAAI,IAAI,UAAU,KAAA,GACjB,OAAO,SACN,IAAU,YAAY,IAAI,OAAO,IAAI,QAAQ,CAAC,GAC9C,WACD;EAED,MAAM,YAAY,MAAM,KAAKC,WAAW,MAAM,IAAI,IAAI;EACtD,IAAI,WAAW,OACd,OAAO,SAAS,IAAU,UAAU,KAAK,GAAG,WAAW;EACxD,OAAO,SAAS,GAAG,KAAA,CAAS,GAAG,WAAW;CAC3C;;;;;CAMA,MAAM,QACL,MACA,MACA,KACyB;EACzB,MAAM,MAAM,MAAM,kBACX,KAAK,KAAKD,QAAQ,MAAM,GAC9B,KAAKA,QAAQ,SACb,MAAM,MACP;EACA,IAAI,IAAI,SAAS,IAAI,SAAS,KAAA,GAC7B,OAAO,IAAI,YAAY,IAAI,OAAO,IAAI,QAAQ,CAAC;EAEhD,MAAM,YAAY,MAAM,KAAKC,WAAW,MAAM,IAAI,IAAI;EACtD,IAAI,WAAW,OAAO,OAAO,IAAI,UAAU,KAAK;EAChD,OAAO,GAAG,IAAI,IAAI,IAAI,CAAC;CACxB;;CAGA,MAAMA,WACL,MACA,MACwC;EAExC,IAAI,EADS,MAAM,oBAAoB,KAAKD,QAAQ,qBACvC,CAAC,cAAc,IAAI,GAAG,OAAO,KAAA;EAC1C,OAAO,kBAAkB,KAAKA,QAAQ,QAAQ,KAAK,YAAY;GAC9D,GAAG,KAAKA,QAAQ;GAChB,QAAQ,MAAM,UAAU,KAAKA,QAAQ,YAAY;EAClD,CAAC;CACF;AACD"}

package/dist/neon/coverage.d.ts

@@ -0,0 +1,26 @@
+//#region src/neon/coverage.d.ts
+/**
+ * Drift guard for the ergonomic layer.
+ *
+ * The raw layer is regenerated from the OpenAPI spec, so it auto-tracks new endpoints.
+ * The ergonomic resource namespaces are hand-authored, so they can silently fall behind.
+ * `coverage.test.ts` compares the generated operation set against {@link EXPECTED_OPERATIONS}
+ * and fails CI when they differ — forcing a conscious decision on every spec change:
+ * either wrap the new operation in a resource (and add it to {@link WRAPPED}) or accept
+ * that it stays raw-only (and add it to the snapshot below).
+ *
+ * Workflow when the test fails after a `pnpm generate`:
+ *   1. Review the `added` / `removed` operations the test reports.
+ *   2. Wrap the ones worth ergonomic treatment (and list them in {@link WRAPPED}).
+ *   3. Update {@link EXPECTED_OPERATIONS} to match the new generated set.
+ */
+/** Operations surfaced by the ergonomic `createNeonClient` namespaces. */
+declare const WRAPPED: ReadonlySet<string>;
+/**
+ * Committed snapshot of every operation the generated client exposes. Update this
+ * deliberately whenever the spec (and thus the generated client) changes.
+ */
+declare const EXPECTED_OPERATIONS: ReadonlySet<string>;
+//#endregion
+export { EXPECTED_OPERATIONS, WRAPPED };
+//# sourceMappingURL=coverage.d.ts.map

package/dist/neon/coverage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"coverage.d.ts","names":[],"sources":["../../src/neon/coverage.ts"],"mappings":";;AAiBA;AA0EA;;;;;;;;;;;;;;cA1Ea,SAAS;;;;;cA0ET,qBAAqB"}

package/dist/neon/coverage.js

@@ -0,0 +1,229 @@
+//#region src/neon/coverage.ts
+/**
+* Drift guard for the ergonomic layer.
+*
+* The raw layer is regenerated from the OpenAPI spec, so it auto-tracks new endpoints.
+* The ergonomic resource namespaces are hand-authored, so they can silently fall behind.
+* `coverage.test.ts` compares the generated operation set against {@link EXPECTED_OPERATIONS}
+* and fails CI when they differ — forcing a conscious decision on every spec change:
+* either wrap the new operation in a resource (and add it to {@link WRAPPED}) or accept
+* that it stays raw-only (and add it to the snapshot below).
+*
+* Workflow when the test fails after a `pnpm generate`:
+*   1. Review the `added` / `removed` operations the test reports.
+*   2. Wrap the ones worth ergonomic treatment (and list them in {@link WRAPPED}).
+*   3. Update {@link EXPECTED_OPERATIONS} to match the new generated set.
+*/
+/** Operations surfaced by the ergonomic `createNeonClient` namespaces. */
+const WRAPPED = /* @__PURE__ */ new Set([
+	"listProjects",
+	"getProject",
+	"createProject",
+	"updateProject",
+	"deleteProject",
+	"transferProjectsFromOrgToOrg",
+	"transferProjectsFromUserToOrg",
+	"listProjectBranches",
+	"getProjectBranch",
+	"createProjectBranch",
+	"updateProjectBranch",
+	"deleteProjectBranch",
+	"setDefaultProjectBranch",
+	"finalizeRestoreBranch",
+	"getProjectOperation",
+	"listProjectOperations",
+	"listProjectEndpoints",
+	"getProjectEndpoint",
+	"createProjectEndpoint",
+	"updateProjectEndpoint",
+	"deleteProjectEndpoint",
+	"startProjectEndpoint",
+	"suspendProjectEndpoint",
+	"restartProjectEndpoint",
+	"listProjectBranchDatabases",
+	"getProjectBranchDatabase",
+	"createProjectBranchDatabase",
+	"updateProjectBranchDatabase",
+	"deleteProjectBranchDatabase",
+	"listProjectBranchRoles",
+	"getProjectBranchRole",
+	"createProjectBranchRole",
+	"deleteProjectBranchRole",
+	"getProjectBranchRolePassword",
+	"resetProjectBranchRolePassword",
+	"getConnectionUri",
+	"getProjectBranchDataApi",
+	"createProjectBranchDataApi",
+	"updateProjectBranchDataApi",
+	"deleteProjectBranchDataApi",
+	"listSnapshots",
+	"createSnapshot",
+	"updateSnapshot",
+	"deleteSnapshot",
+	"restoreSnapshot",
+	"getSnapshotSchedule",
+	"setSnapshotSchedule",
+	"getConsumptionHistoryPerProject",
+	"getConsumptionHistoryPerProjectV2",
+	"getConsumptionHistoryPerBranchV2",
+	"getCurrentUserInfo",
+	"getCurrentUserOrganizations",
+	"getActiveRegions",
+	"listApiKeys",
+	"createApiKey",
+	"revokeApiKey"
+]);
+/**
+* Committed snapshot of every operation the generated client exposes. Update this
+* deliberately whenever the spec (and thus the generated client) changes.
+*/
+const EXPECTED_OPERATIONS = /* @__PURE__ */ new Set([
+	"acceptProjectTransferRequest",
+	"addBranchNeonAuthOauthProvider",
+	"addBranchNeonAuthTrustedDomain",
+	"addNeonAuthDomainToRedirectUriWhitelist",
+	"addNeonAuthOauthProvider",
+	"addProjectJwks",
+	"assignOrganizationVpcEndpoint",
+	"assignProjectVpcEndpoint",
+	"countProjectBranches",
+	"createApiKey",
+	"createBranchNeonAuthNewUser",
+	"createNeonAuth",
+	"createNeonAuthIntegration",
+	"createNeonAuthNewUser",
+	"createNeonAuthProviderSdkKeys",
+	"createOrgApiKey",
+	"createOrganizationInvitations",
+	"createProject",
+	"createProjectBranch",
+	"createProjectBranchAnonymized",
+	"createProjectBranchDataApi",
+	"createProjectBranchDatabase",
+	"createProjectBranchRole",
+	"createProjectEndpoint",
+	"createProjectTransferRequest",
+	"createSnapshot",
+	"deleteBranchNeonAuthOauthProvider",
+	"deleteBranchNeonAuthTrustedDomain",
+	"deleteBranchNeonAuthUser",
+	"deleteNeonAuthDomainFromRedirectUriWhitelist",
+	"deleteNeonAuthIntegration",
+	"deleteNeonAuthOauthProvider",
+	"deleteNeonAuthUser",
+	"deleteOrganizationSpendingLimit",
+	"deleteOrganizationVpcEndpoint",
+	"deleteProject",
+	"deleteProjectBranch",
+	"deleteProjectBranchDataApi",
+	"deleteProjectBranchDatabase",
+	"deleteProjectBranchRole",
+	"deleteProjectEndpoint",
+	"deleteProjectJwks",
+	"deleteProjectVpcEndpoint",
+	"deleteSnapshot",
+	"disableNeonAuth",
+	"finalizeRestoreBranch",
+	"getActiveRegions",
+	"getAnonymizedBranchStatus",
+	"getAuthDetails",
+	"getAvailablePreloadLibraries",
+	"getConnectionUri",
+	"getConsumptionHistoryPerBranchV2",
+	"getConsumptionHistoryPerProject",
+	"getConsumptionHistoryPerProjectV2",
+	"getCurrentUserInfo",
+	"getCurrentUserOrganizations",
+	"getMaskingRules",
+	"getNeonAuth",
+	"getNeonAuthAllowLocalhost",
+	"getNeonAuthEmailAndPasswordConfig",
+	"getNeonAuthEmailProvider",
+	"getNeonAuthEmailServer",
+	"getNeonAuthPhoneNumberPlugin",
+	"getNeonAuthPluginConfigs",
+	"getNeonAuthWebhookConfig",
+	"getOrganization",
+	"getOrganizationInvitations",
+	"getOrganizationMember",
+	"getOrganizationMembers",
+	"getOrganizationSpendingLimit",
+	"getOrganizationVpcEndpointDetails",
+	"getProject",
+	"getProjectAdvisorSecurityIssues",
+	"getProjectBranch",
+	"getProjectBranchDataApi",
+	"getProjectBranchDatabase",
+	"getProjectBranchRole",
+	"getProjectBranchRolePassword",
+	"getProjectBranchSchema",
+	"getProjectBranchSchemaComparison",
+	"getProjectEndpoint",
+	"getProjectJwks",
+	"getProjectOperation",
+	"getSnapshotSchedule",
+	"grantPermissionToProject",
+	"listApiKeys",
+	"listBranchNeonAuthOauthProviders",
+	"listBranchNeonAuthTrustedDomains",
+	"listNeonAuthIntegrations",
+	"listNeonAuthOauthProviders",
+	"listNeonAuthRedirectUriWhitelistDomains",
+	"listOrgApiKeys",
+	"listOrganizationVpcEndpoints",
+	"listOrganizationVpcEndpointsAllRegions",
+	"listProjectBranchDatabases",
+	"listProjectBranchEndpoints",
+	"listProjectBranchRoles",
+	"listProjectBranches",
+	"listProjectEndpoints",
+	"listProjectOperations",
+	"listProjectPermissions",
+	"listProjectVpcEndpoints",
+	"listProjects",
+	"listSharedProjects",
+	"listSnapshots",
+	"recoverProject",
+	"removeOrganizationMember",
+	"resetProjectBranchRolePassword",
+	"restartProjectEndpoint",
+	"restoreProjectBranch",
+	"restoreSnapshot",
+	"revokeApiKey",
+	"revokeOrgApiKey",
+	"revokePermissionFromProject",
+	"sendNeonAuthTestEmail",
+	"setDefaultProjectBranch",
+	"setOrganizationSpendingLimit",
+	"setSnapshotSchedule",
+	"startAnonymization",
+	"startProjectEndpoint",
+	"suspendProjectEndpoint",
+	"transferNeonAuthProviderProject",
+	"transferProjectsFromOrgToOrg",
+	"transferProjectsFromUserToOrg",
+	"updateBranchNeonAuthOauthProvider",
+	"updateMaskingRules",
+	"updateNeonAuthAllowLocalhost",
+	"updateNeonAuthConfig",
+	"updateNeonAuthEmailAndPasswordConfig",
+	"updateNeonAuthEmailProvider",
+	"updateNeonAuthEmailServer",
+	"updateNeonAuthMagicLinkPlugin",
+	"updateNeonAuthOauthProvider",
+	"updateNeonAuthOrganizationPlugin",
+	"updateNeonAuthPhoneNumberPlugin",
+	"updateNeonAuthUserRole",
+	"updateNeonAuthWebhookConfig",
+	"updateOrganizationMember",
+	"updateProject",
+	"updateProjectBranch",
+	"updateProjectBranchDataApi",
+	"updateProjectBranchDatabase",
+	"updateProjectEndpoint",
+	"updateSnapshot"
+]);
+//#endregion
+export { EXPECTED_OPERATIONS, WRAPPED };
+
+//# sourceMappingURL=coverage.js.map

package/dist/neon/coverage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"coverage.js","names":[],"sources":["../../src/neon/coverage.ts"],"sourcesContent":["/**\n * Drift guard for the ergonomic layer.\n *\n * The raw layer is regenerated from the OpenAPI spec, so it auto-tracks new endpoints.\n * The ergonomic resource namespaces are hand-authored, so they can silently fall behind.\n * `coverage.test.ts` compares the generated operation set against {@link EXPECTED_OPERATIONS}\n * and fails CI when they differ — forcing a conscious decision on every spec change:\n * either wrap the new operation in a resource (and add it to {@link WRAPPED}) or accept\n * that it stays raw-only (and add it to the snapshot below).\n *\n * Workflow when the test fails after a `pnpm generate`:\n *   1. Review the `added` / `removed` operations the test reports.\n *   2. Wrap the ones worth ergonomic treatment (and list them in {@link WRAPPED}).\n *   3. Update {@link EXPECTED_OPERATIONS} to match the new generated set.\n */\n\n/** Operations surfaced by the ergonomic `createNeonClient` namespaces. */\nexport const WRAPPED: ReadonlySet<string> = new Set([\n\t// projects\n\t\"listProjects\",\n\t\"getProject\",\n\t\"createProject\",\n\t\"updateProject\",\n\t\"deleteProject\",\n\t// projects: transfer\n\t\"transferProjectsFromOrgToOrg\",\n\t\"transferProjectsFromUserToOrg\",\n\t// branches\n\t\"listProjectBranches\",\n\t\"getProjectBranch\",\n\t\"createProjectBranch\",\n\t\"updateProjectBranch\",\n\t\"deleteProjectBranch\",\n\t\"setDefaultProjectBranch\",\n\t\"finalizeRestoreBranch\",\n\t// operations\n\t\"getProjectOperation\",\n\t\"listProjectOperations\",\n\t// postgres: endpoints\n\t\"listProjectEndpoints\",\n\t\"getProjectEndpoint\",\n\t\"createProjectEndpoint\",\n\t\"updateProjectEndpoint\",\n\t\"deleteProjectEndpoint\",\n\t\"startProjectEndpoint\",\n\t\"suspendProjectEndpoint\",\n\t\"restartProjectEndpoint\",\n\t// postgres: databases\n\t\"listProjectBranchDatabases\",\n\t\"getProjectBranchDatabase\",\n\t\"createProjectBranchDatabase\",\n\t\"updateProjectBranchDatabase\",\n\t\"deleteProjectBranchDatabase\",\n\t// postgres: roles\n\t\"listProjectBranchRoles\",\n\t\"getProjectBranchRole\",\n\t\"createProjectBranchRole\",\n\t\"deleteProjectBranchRole\",\n\t\"getProjectBranchRolePassword\",\n\t\"resetProjectBranchRolePassword\",\n\t// postgres: connection string + data api\n\t\"getConnectionUri\",\n\t\"getProjectBranchDataApi\",\n\t\"createProjectBranchDataApi\",\n\t\"updateProjectBranchDataApi\",\n\t\"deleteProjectBranchDataApi\",\n\t// snapshots\n\t\"listSnapshots\",\n\t\"createSnapshot\",\n\t\"updateSnapshot\",\n\t\"deleteSnapshot\",\n\t\"restoreSnapshot\",\n\t\"getSnapshotSchedule\",\n\t\"setSnapshotSchedule\",\n\t// consumption\n\t\"getConsumptionHistoryPerProject\",\n\t\"getConsumptionHistoryPerProjectV2\",\n\t\"getConsumptionHistoryPerBranchV2\",\n\t// account\n\t\"getCurrentUserInfo\",\n\t\"getCurrentUserOrganizations\",\n\t\"getActiveRegions\",\n\t\"listApiKeys\",\n\t\"createApiKey\",\n\t\"revokeApiKey\",\n]);\n\n/**\n * Committed snapshot of every operation the generated client exposes. Update this\n * deliberately whenever the spec (and thus the generated client) changes.\n */\nexport const EXPECTED_OPERATIONS: ReadonlySet<string> = new Set([\n\t\"acceptProjectTransferRequest\",\n\t\"addBranchNeonAuthOauthProvider\",\n\t\"addBranchNeonAuthTrustedDomain\",\n\t\"addNeonAuthDomainToRedirectUriWhitelist\",\n\t\"addNeonAuthOauthProvider\",\n\t\"addProjectJwks\",\n\t\"assignOrganizationVpcEndpoint\",\n\t\"assignProjectVpcEndpoint\",\n\t\"countProjectBranches\",\n\t\"createApiKey\",\n\t\"createBranchNeonAuthNewUser\",\n\t\"createNeonAuth\",\n\t\"createNeonAuthIntegration\",\n\t\"createNeonAuthNewUser\",\n\t\"createNeonAuthProviderSdkKeys\",\n\t\"createOrgApiKey\",\n\t\"createOrganizationInvitations\",\n\t\"createProject\",\n\t\"createProjectBranch\",\n\t\"createProjectBranchAnonymized\",\n\t\"createProjectBranchDataApi\",\n\t\"createProjectBranchDatabase\",\n\t\"createProjectBranchRole\",\n\t\"createProjectEndpoint\",\n\t\"createProjectTransferRequest\",\n\t\"createSnapshot\",\n\t\"deleteBranchNeonAuthOauthProvider\",\n\t\"deleteBranchNeonAuthTrustedDomain\",\n\t\"deleteBranchNeonAuthUser\",\n\t\"deleteNeonAuthDomainFromRedirectUriWhitelist\",\n\t\"deleteNeonAuthIntegration\",\n\t\"deleteNeonAuthOauthProvider\",\n\t\"deleteNeonAuthUser\",\n\t\"deleteOrganizationSpendingLimit\",\n\t\"deleteOrganizationVpcEndpoint\",\n\t\"deleteProject\",\n\t\"deleteProjectBranch\",\n\t\"deleteProjectBranchDataApi\",\n\t\"deleteProjectBranchDatabase\",\n\t\"deleteProjectBranchRole\",\n\t\"deleteProjectEndpoint\",\n\t\"deleteProjectJwks\",\n\t\"deleteProjectVpcEndpoint\",\n\t\"deleteSnapshot\",\n\t\"disableNeonAuth\",\n\t\"finalizeRestoreBranch\",\n\t\"getActiveRegions\",\n\t\"getAnonymizedBranchStatus\",\n\t\"getAuthDetails\",\n\t\"getAvailablePreloadLibraries\",\n\t\"getConnectionUri\",\n\t\"getConsumptionHistoryPerBranchV2\",\n\t\"getConsumptionHistoryPerProject\",\n\t\"getConsumptionHistoryPerProjectV2\",\n\t\"getCurrentUserInfo\",\n\t\"getCurrentUserOrganizations\",\n\t\"getMaskingRules\",\n\t\"getNeonAuth\",\n\t\"getNeonAuthAllowLocalhost\",\n\t\"getNeonAuthEmailAndPasswordConfig\",\n\t\"getNeonAuthEmailProvider\",\n\t\"getNeonAuthEmailServer\",\n\t\"getNeonAuthPhoneNumberPlugin\",\n\t\"getNeonAuthPluginConfigs\",\n\t\"getNeonAuthWebhookConfig\",\n\t\"getOrganization\",\n\t\"getOrganizationInvitations\",\n\t\"getOrganizationMember\",\n\t\"getOrganizationMembers\",\n\t\"getOrganizationSpendingLimit\",\n\t\"getOrganizationVpcEndpointDetails\",\n\t\"getProject\",\n\t\"getProjectAdvisorSecurityIssues\",\n\t\"getProjectBranch\",\n\t\"getProjectBranchDataApi\",\n\t\"getProjectBranchDatabase\",\n\t\"getProjectBranchRole\",\n\t\"getProjectBranchRolePassword\",\n\t\"getProjectBranchSchema\",\n\t\"getProjectBranchSchemaComparison\",\n\t\"getProjectEndpoint\",\n\t\"getProjectJwks\",\n\t\"getProjectOperation\",\n\t\"getSnapshotSchedule\",\n\t\"grantPermissionToProject\",\n\t\"listApiKeys\",\n\t\"listBranchNeonAuthOauthProviders\",\n\t\"listBranchNeonAuthTrustedDomains\",\n\t\"listNeonAuthIntegrations\",\n\t\"listNeonAuthOauthProviders\",\n\t\"listNeonAuthRedirectUriWhitelistDomains\",\n\t\"listOrgApiKeys\",\n\t\"listOrganizationVpcEndpoints\",\n\t\"listOrganizationVpcEndpointsAllRegions\",\n\t\"listProjectBranchDatabases\",\n\t\"listProjectBranchEndpoints\",\n\t\"listProjectBranchRoles\",\n\t\"listProjectBranches\",\n\t\"listProjectEndpoints\",\n\t\"listProjectOperations\",\n\t\"listProjectPermissions\",\n\t\"listProjectVpcEndpoints\",\n\t\"listProjects\",\n\t\"listSharedProjects\",\n\t\"listSnapshots\",\n\t\"recoverProject\",\n\t\"removeOrganizationMember\",\n\t\"resetProjectBranchRolePassword\",\n\t\"restartProjectEndpoint\",\n\t\"restoreProjectBranch\",\n\t\"restoreSnapshot\",\n\t\"revokeApiKey\",\n\t\"revokeOrgApiKey\",\n\t\"revokePermissionFromProject\",\n\t\"sendNeonAuthTestEmail\",\n\t\"setDefaultProjectBranch\",\n\t\"setOrganizationSpendingLimit\",\n\t\"setSnapshotSchedule\",\n\t\"startAnonymization\",\n\t\"startProjectEndpoint\",\n\t\"suspendProjectEndpoint\",\n\t\"transferNeonAuthProviderProject\",\n\t\"transferProjectsFromOrgToOrg\",\n\t\"transferProjectsFromUserToOrg\",\n\t\"updateBranchNeonAuthOauthProvider\",\n\t\"updateMaskingRules\",\n\t\"updateNeonAuthAllowLocalhost\",\n\t\"updateNeonAuthConfig\",\n\t\"updateNeonAuthEmailAndPasswordConfig\",\n\t\"updateNeonAuthEmailProvider\",\n\t\"updateNeonAuthEmailServer\",\n\t\"updateNeonAuthMagicLinkPlugin\",\n\t\"updateNeonAuthOauthProvider\",\n\t\"updateNeonAuthOrganizationPlugin\",\n\t\"updateNeonAuthPhoneNumberPlugin\",\n\t\"updateNeonAuthUserRole\",\n\t\"updateNeonAuthWebhookConfig\",\n\t\"updateOrganizationMember\",\n\t\"updateProject\",\n\t\"updateProjectBranch\",\n\t\"updateProjectBranchDataApi\",\n\t\"updateProjectBranchDatabase\",\n\t\"updateProjectEndpoint\",\n\t\"updateSnapshot\",\n]);\n"],"mappings":";;;;;;;;;;;;;;;;;AAiBA,MAAa,0BAA+B,IAAI,IAAI;CAEnD;CACA;CACA;CACA;CACA;CAEA;CACA;CAEA;CACA;CACA;CACA;CACA;CACA;CACA;CAEA;CACA;CAEA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CAEA;CACA;CACA;CACA;CACA;CAEA;CACA;CACA;CACA;CACA;CACA;CAEA;CACA;CACA;CACA;CACA;CAEA;CACA;CACA;CACA;CACA;CACA;CACA;CAEA;CACA;CACA;CAEA;CACA;CACA;CACA;CACA;CACA;AACD,CAAC;;;;;AAMD,MAAa,sCAA2C,IAAI,IAAI;CAC/D;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD,CAAC"}

package/dist/neon/errors.d.ts

@@ -0,0 +1,78 @@
+//#region src/neon/errors.d.ts
+/**
+ * Typed error hierarchy surfaced on the `error` channel of every ergonomic call (and
+ * thrown when `throwOnError` is set). All are `Error` subclasses with a `kind`
+ * discriminant, so the same value works whether you read it from `{ error }` or `catch`
+ * it.
+ */
+type NeonErrorKind = "api" | "not_found" | "auth" | "rate_limit" | "operation" | "timeout" | "network" | "client";
+/** Base class for every error the ergonomic layer produces. */
+declare class NeonError extends Error {
+  readonly kind: NeonErrorKind;
+  constructor(message: string, kind: NeonErrorKind, options?: {
+    cause?: unknown;
+  });
+}
+/** A non-2xx HTTP response from the Neon API. */
+declare class NeonApiError extends NeonError {
+  /** HTTP status code. */
+  readonly status: number;
+  /** Machine-readable Neon error code (`GeneralError.code`), when present. */
+  readonly code?: string;
+  /** Neon request id (`X-Request-Id` / `GeneralError.request_id`), when present. */
+  readonly requestId?: string;
+  /** The raw response, when one was received. */
+  readonly response?: Response;
+  /** The parsed error body, as returned by the API. */
+  readonly body: unknown;
+  constructor(message: string, init: {
+    kind?: NeonErrorKind;
+    status: number;
+    code?: string;
+    requestId?: string;
+    response?: Response;
+    body?: unknown;
+  });
+}
+/** 404 — the resource does not exist. */
+declare class NeonNotFoundError extends NeonApiError {
+  constructor(message: string, init: ConstructorParameters<typeof NeonApiError>[1]);
+}
+/** 401/403 — the API key is missing, invalid, or lacks permission. */
+declare class NeonAuthError extends NeonApiError {
+  constructor(message: string, init: ConstructorParameters<typeof NeonApiError>[1]);
+}
+/** 429 — rate limited (after retries, if enabled, were exhausted). */
+declare class NeonRateLimitError extends NeonApiError {
+  constructor(message: string, init: ConstructorParameters<typeof NeonApiError>[1]);
+}
+/** An awaited Neon operation ended in a non-success terminal state. */
+declare class NeonOperationError extends NeonError {
+  /** The id of the operation that failed. */
+  readonly operationId: string;
+  /** The terminal status reported by the API (`failed` / `error` / `cancelled`). */
+  readonly status: string;
+  constructor(message: string, init: {
+    operationId: string;
+    status: string;
+  });
+}
+/** Waiting for operations to finish exceeded the configured timeout. */
+declare class NeonTimeoutError extends NeonError {
+  constructor(message: string);
+}
+/** A transport-level failure (DNS, connection, abort) — no HTTP response received. */
+declare class NeonNetworkError extends NeonError {
+  constructor(message: string, options?: {
+    cause?: unknown;
+  });
+}
+/**
+ * Build the right {@link NeonError} subclass from a raw client result. `error` is the
+ * decoded error body (Neon `GeneralError`); `response` is present unless the failure was
+ * transport-level.
+ */
+declare function toNeonError(error: unknown, response: Response | undefined): NeonError;
+//#endregion
+export { NeonApiError, NeonAuthError, NeonError, NeonErrorKind, NeonNetworkError, NeonNotFoundError, NeonOperationError, NeonRateLimitError, NeonTimeoutError, toNeonError };
+//# sourceMappingURL=errors.d.ts.map

package/dist/neon/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","names":[],"sources":["../../src/neon/errors.ts"],"mappings":";;AAOA;AAWA;;;;AAA+B,KAXnB,aAAA,GAWmB,KAAA,GAAA,WAAA,GAAA,MAAA,GAAA,YAAA,GAAA,WAAA,GAAA,SAAA,GAAA,SAAA,GAAA,QAAA;AAAK;AAevB,cAfA,SAAA,SAAkB,KAAA,CAeL;EAAA,SAAA,IAAA,EAdV,aAcU;aAQL,CAAA,OAAA,EAAA,MAAA,EAAA,IAAA,EAlBb,aAkBa,EAAA,QAAA,EAAA;IAOX,KAAA,CAAA,EAAA,OAAA;;;AAfiC;AAiC9B,cAjCA,YAAA,SAAqB,SAAA,CAiCH;EAAA;WAGM,MAAA,EAAA,MAAA;;WAHE,IAAA,CAAA,EAAA,MAAA;EAAY;EAUtC,SAAA,SAAc,CAAA,EAAA,MAAA;EAAA;WAGU,QAAA,CAAA,EAtChB,QAsCgB;;WAHF,IAAA,EAAA,OAAA;EAAY,WAAA,CAAA,OAAA,EAAA,MAAA,EAAA,IAAA,EAAA;IAUlC,IAAA,CAAA,EAtCH,aAsCsB;IAAA,MAAA,EAAA,MAAA;IAGK,IAAA,CAAA,EAAA,MAAA;IAA7B,SAAA,CAAA,EAAA,MAAA;IAHgC,QAAA,CAAA,EAlC1B,QAkC0B;IAAY,IAAA,CAAA,EAAA,OAAA;EAUvC,CAAA;AAiBb;AAOA;AA6BgB,cAnFH,iBAAA,SAA0B,YAAA,CAmFZ;EAAA,WAAA,CAAA,OAAA,EAAA,MAAA,EAAA,IAAA,EAhFnB,qBAgFmB,CAAA,OAhFU,YAgFV,CAAA,CAAA,CAAA,CAAA;;;AAGf,cA5EC,aAAA,SAAsB,YAAA,CA4EvB;qCAzEJ,6BAA6B;;;cAOxB,kBAAA,SAA2B,YAAA;qCAGhC,6BAA6B;;;cAOxB,kBAAA,SAA2B,SAAS;;;;;;;;;;;cAiBpC,gBAAA,SAAyB,SAAS;;;;cAOlC,gBAAA,SAAyB,SAAS;;;;;;;;;;iBA6B/B,WAAA,2BAEL,uBACR"}

package/dist/neon/errors.js

@@ -0,0 +1,116 @@
+//#region src/neon/errors.ts
+/** Base class for every error the ergonomic layer produces. */
+var NeonError = class extends Error {
+	kind;
+	constructor(message, kind, options) {
+		super(message, options);
+		this.name = new.target.name;
+		this.kind = kind;
+	}
+};
+/** A non-2xx HTTP response from the Neon API. */
+var NeonApiError = class extends NeonError {
+	/** HTTP status code. */
+	status;
+	/** Machine-readable Neon error code (`GeneralError.code`), when present. */
+	code;
+	/** Neon request id (`X-Request-Id` / `GeneralError.request_id`), when present. */
+	requestId;
+	/** The raw response, when one was received. */
+	response;
+	/** The parsed error body, as returned by the API. */
+	body;
+	constructor(message, init) {
+		super(message, init.kind ?? "api");
+		this.status = init.status;
+		this.code = init.code;
+		this.requestId = init.requestId;
+		this.response = init.response;
+		this.body = init.body;
+	}
+};
+/** 404 — the resource does not exist. */
+var NeonNotFoundError = class extends NeonApiError {
+	constructor(message, init) {
+		super(message, {
+			...init,
+			kind: "not_found"
+		});
+	}
+};
+/** 401/403 — the API key is missing, invalid, or lacks permission. */
+var NeonAuthError = class extends NeonApiError {
+	constructor(message, init) {
+		super(message, {
+			...init,
+			kind: "auth"
+		});
+	}
+};
+/** 429 — rate limited (after retries, if enabled, were exhausted). */
+var NeonRateLimitError = class extends NeonApiError {
+	constructor(message, init) {
+		super(message, {
+			...init,
+			kind: "rate_limit"
+		});
+	}
+};
+/** An awaited Neon operation ended in a non-success terminal state. */
+var NeonOperationError = class extends NeonError {
+	/** The id of the operation that failed. */
+	operationId;
+	/** The terminal status reported by the API (`failed` / `error` / `cancelled`). */
+	status;
+	constructor(message, init) {
+		super(message, "operation");
+		this.operationId = init.operationId;
+		this.status = init.status;
+	}
+};
+/** Waiting for operations to finish exceeded the configured timeout. */
+var NeonTimeoutError = class extends NeonError {
+	constructor(message) {
+		super(message, "timeout");
+	}
+};
+/** A transport-level failure (DNS, connection, abort) — no HTTP response received. */
+var NeonNetworkError = class extends NeonError {
+	constructor(message, options) {
+		super(message, "network", options);
+	}
+};
+function readApiErrorBody(body) {
+	if (typeof body !== "object" || body === null) return {};
+	const out = {};
+	if ("message" in body && typeof body.message === "string") out.message = body.message;
+	if ("code" in body && typeof body.code === "string") out.code = body.code;
+	if ("request_id" in body && typeof body.request_id === "string") out.request_id = body.request_id;
+	return out;
+}
+/**
+* Build the right {@link NeonError} subclass from a raw client result. `error` is the
+* decoded error body (Neon `GeneralError`); `response` is present unless the failure was
+* transport-level.
+*/
+function toNeonError(error, response) {
+	if (!response) return new NeonNetworkError("Network error: no response received from the Neon API.", { cause: error });
+	const parsed = readApiErrorBody(error);
+	const status = response.status;
+	const message = parsed.message ?? `Neon API request failed with status ${status}.`;
+	const init = {
+		status,
+		code: parsed.code,
+		requestId: parsed.request_id ?? response.headers.get("x-request-id") ?? void 0,
+		response,
+		body: error
+	};
+	if (status === 404) return new NeonNotFoundError(message, init);
+	if (status === 401 || status === 403) return new NeonAuthError(message, init);
+	if (status === 429) return new NeonRateLimitError(message, init);
+	return new NeonApiError(message, init);
+}
+//#endregion
+export { NeonApiError, NeonAuthError, NeonError, NeonNetworkError, NeonNotFoundError, NeonOperationError, NeonRateLimitError, NeonTimeoutError, toNeonError };
+
+//# sourceMappingURL=errors.js.map

package/dist/neon/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","names":[],"sources":["../../src/neon/errors.ts"],"sourcesContent":["/**\n * Typed error hierarchy surfaced on the `error` channel of every ergonomic call (and\n * thrown when `throwOnError` is set). All are `Error` subclasses with a `kind`\n * discriminant, so the same value works whether you read it from `{ error }` or `catch`\n * it.\n */\n\nexport type NeonErrorKind =\n\t| \"api\"\n\t| \"not_found\"\n\t| \"auth\"\n\t| \"rate_limit\"\n\t| \"operation\"\n\t| \"timeout\"\n\t| \"network\"\n\t| \"client\";\n\n/** Base class for every error the ergonomic layer produces. */\nexport class NeonError extends Error {\n\treadonly kind: NeonErrorKind;\n\n\tconstructor(\n\t\tmessage: string,\n\t\tkind: NeonErrorKind,\n\t\toptions?: { cause?: unknown },\n\t) {\n\t\tsuper(message, options);\n\t\tthis.name = new.target.name;\n\t\tthis.kind = kind;\n\t}\n}\n\n/** A non-2xx HTTP response from the Neon API. */\nexport class NeonApiError extends NeonError {\n\t/** HTTP status code. */\n\treadonly status: number;\n\t/** Machine-readable Neon error code (`GeneralError.code`), when present. */\n\treadonly code?: string;\n\t/** Neon request id (`X-Request-Id` / `GeneralError.request_id`), when present. */\n\treadonly requestId?: string;\n\t/** The raw response, when one was received. */\n\treadonly response?: Response;\n\t/** The parsed error body, as returned by the API. */\n\treadonly body: unknown;\n\n\tconstructor(\n\t\tmessage: string,\n\t\tinit: {\n\t\t\tkind?: NeonErrorKind;\n\t\t\tstatus: number;\n\t\t\tcode?: string;\n\t\t\trequestId?: string;\n\t\t\tresponse?: Response;\n\t\t\tbody?: unknown;\n\t\t},\n\t) {\n\t\tsuper(message, init.kind ?? \"api\");\n\t\tthis.status = init.status;\n\t\tthis.code = init.code;\n\t\tthis.requestId = init.requestId;\n\t\tthis.response = init.response;\n\t\tthis.body = init.body;\n\t}\n}\n\n/** 404 — the resource does not exist. */\nexport class NeonNotFoundError extends NeonApiError {\n\tconstructor(\n\t\tmessage: string,\n\t\tinit: ConstructorParameters<typeof NeonApiError>[1],\n\t) {\n\t\tsuper(message, { ...init, kind: \"not_found\" });\n\t}\n}\n\n/** 401/403 — the API key is missing, invalid, or lacks permission. */\nexport class NeonAuthError extends NeonApiError {\n\tconstructor(\n\t\tmessage: string,\n\t\tinit: ConstructorParameters<typeof NeonApiError>[1],\n\t) {\n\t\tsuper(message, { ...init, kind: \"auth\" });\n\t}\n}\n\n/** 429 — rate limited (after retries, if enabled, were exhausted). */\nexport class NeonRateLimitError extends NeonApiError {\n\tconstructor(\n\t\tmessage: string,\n\t\tinit: ConstructorParameters<typeof NeonApiError>[1],\n\t) {\n\t\tsuper(message, { ...init, kind: \"rate_limit\" });\n\t}\n}\n\n/** An awaited Neon operation ended in a non-success terminal state. */\nexport class NeonOperationError extends NeonError {\n\t/** The id of the operation that failed. */\n\treadonly operationId: string;\n\t/** The terminal status reported by the API (`failed` / `error` / `cancelled`). */\n\treadonly status: string;\n\n\tconstructor(\n\t\tmessage: string,\n\t\tinit: { operationId: string; status: string },\n\t) {\n\t\tsuper(message, \"operation\");\n\t\tthis.operationId = init.operationId;\n\t\tthis.status = init.status;\n\t}\n}\n\n/** Waiting for operations to finish exceeded the configured timeout. */\nexport class NeonTimeoutError extends NeonError {\n\tconstructor(message: string) {\n\t\tsuper(message, \"timeout\");\n\t}\n}\n\n/** A transport-level failure (DNS, connection, abort) — no HTTP response received. */\nexport class NeonNetworkError extends NeonError {\n\tconstructor(message: string, options?: { cause?: unknown }) {\n\t\tsuper(message, \"network\", options);\n\t}\n}\n\ninterface ApiErrorBody {\n\tmessage?: string;\n\tcode?: string;\n\trequest_id?: string;\n}\n\nfunction readApiErrorBody(body: unknown): ApiErrorBody {\n\tif (typeof body !== \"object\" || body === null) return {};\n\tconst out: ApiErrorBody = {};\n\tif (\"message\" in body && typeof body.message === \"string\")\n\t\tout.message = body.message;\n\tif (\"code\" in body && typeof body.code === \"string\") out.code = body.code;\n\tif (\"request_id\" in body && typeof body.request_id === \"string\") {\n\t\tout.request_id = body.request_id;\n\t}\n\treturn out;\n}\n\n/**\n * Build the right {@link NeonError} subclass from a raw client result. `error` is the\n * decoded error body (Neon `GeneralError`); `response` is present unless the failure was\n * transport-level.\n */\nexport function toNeonError(\n\terror: unknown,\n\tresponse: Response | undefined,\n): NeonError {\n\tif (!response) {\n\t\treturn new NeonNetworkError(\n\t\t\t\"Network error: no response received from the Neon API.\",\n\t\t\t{ cause: error },\n\t\t);\n\t}\n\n\tconst parsed = readApiErrorBody(error);\n\tconst status = response.status;\n\tconst message =\n\t\tparsed.message ?? `Neon API request failed with status ${status}.`;\n\tconst init = {\n\t\tstatus,\n\t\tcode: parsed.code,\n\t\trequestId:\n\t\t\tparsed.request_id ??\n\t\t\tresponse.headers.get(\"x-request-id\") ??\n\t\t\tundefined,\n\t\tresponse,\n\t\tbody: error,\n\t};\n\n\tif (status === 404) return new NeonNotFoundError(message, init);\n\tif (status === 401 || status === 403)\n\t\treturn new NeonAuthError(message, init);\n\tif (status === 429) return new NeonRateLimitError(message, init);\n\treturn new NeonApiError(message, init);\n}\n"],"mappings":";;AAkBA,IAAa,YAAb,cAA+B,MAAM;CACpC;CAEA,YACC,SACA,MACA,SACC;EACD,MAAM,SAAS,OAAO;EACtB,KAAK,OAAO,IAAI,OAAO;EACvB,KAAK,OAAO;CACb;AACD;;AAGA,IAAa,eAAb,cAAkC,UAAU;;CAE3C;;CAEA;;CAEA;;CAEA;;CAEA;CAEA,YACC,SACA,MAQC;EACD,MAAM,SAAS,KAAK,QAAQ,KAAK;EACjC,KAAK,SAAS,KAAK;EACnB,KAAK,OAAO,KAAK;EACjB,KAAK,YAAY,KAAK;EACtB,KAAK,WAAW,KAAK;EACrB,KAAK,OAAO,KAAK;CAClB;AACD;;AAGA,IAAa,oBAAb,cAAuC,aAAa;CACnD,YACC,SACA,MACC;EACD,MAAM,SAAS;GAAE,GAAG;GAAM,MAAM;EAAY,CAAC;CAC9C;AACD;;AAGA,IAAa,gBAAb,cAAmC,aAAa;CAC/C,YACC,SACA,MACC;EACD,MAAM,SAAS;GAAE,GAAG;GAAM,MAAM;EAAO,CAAC;CACzC;AACD;;AAGA,IAAa,qBAAb,cAAwC,aAAa;CACpD,YACC,SACA,MACC;EACD,MAAM,SAAS;GAAE,GAAG;GAAM,MAAM;EAAa,CAAC;CAC/C;AACD;;AAGA,IAAa,qBAAb,cAAwC,UAAU;;CAEjD;;CAEA;CAEA,YACC,SACA,MACC;EACD,MAAM,SAAS,WAAW;EAC1B,KAAK,cAAc,KAAK;EACxB,KAAK,SAAS,KAAK;CACpB;AACD;;AAGA,IAAa,mBAAb,cAAsC,UAAU;CAC/C,YAAY,SAAiB;EAC5B,MAAM,SAAS,SAAS;CACzB;AACD;;AAGA,IAAa,mBAAb,cAAsC,UAAU;CAC/C,YAAY,SAAiB,SAA+B;EAC3D,MAAM,SAAS,WAAW,OAAO;CAClC;AACD;AAQA,SAAS,iBAAiB,MAA6B;CACtD,IAAI,OAAO,SAAS,YAAY,SAAS,MAAM,OAAO,CAAC;CACvD,MAAM,MAAoB,CAAC;CAC3B,IAAI,aAAa,QAAQ,OAAO,KAAK,YAAY,UAChD,IAAI,UAAU,KAAK;CACpB,IAAI,UAAU,QAAQ,OAAO,KAAK,SAAS,UAAU,IAAI,OAAO,KAAK;CACrE,IAAI,gBAAgB,QAAQ,OAAO,KAAK,eAAe,UACtD,IAAI,aAAa,KAAK;CAEvB,OAAO;AACR;;;;;;AAOA,SAAgB,YACf,OACA,UACY;CACZ,IAAI,CAAC,UACJ,OAAO,IAAI,iBACV,0DACA,EAAE,OAAO,MAAM,CAChB;CAGD,MAAM,SAAS,iBAAiB,KAAK;CACrC,MAAM,SAAS,SAAS;CACxB,MAAM,UACL,OAAO,WAAW,uCAAuC,OAAO;CACjE,MAAM,OAAO;EACZ;EACA,MAAM,OAAO;EACb,WACC,OAAO,cACP,SAAS,QAAQ,IAAI,cAAc,KACnC,KAAA;EACD;EACA,MAAM;CACP;CAEA,IAAI,WAAW,KAAK,OAAO,IAAI,kBAAkB,SAAS,IAAI;CAC9D,IAAI,WAAW,OAAO,WAAW,KAChC,OAAO,IAAI,cAAc,SAAS,IAAI;CACvC,IAAI,WAAW,KAAK,OAAO,IAAI,mBAAmB,SAAS,IAAI;CAC/D,OAAO,IAAI,aAAa,SAAS,IAAI;AACtC"}

package/dist/neon/paginate.d.ts

@@ -0,0 +1,34 @@
+import { NeonResult } from "./result.js";
+
+//#region src/neon/paginate.d.ts
+interface Page<T> {
+  items: T[];
+  /** Cursor for the next page, when more results exist. */
+  cursor?: string;
+}
+interface RawResult<D> {
+  data?: D | undefined;
+  error?: unknown;
+  response?: Response | undefined;
+}
+/**
+ * A lazy, cursor-paginated list. `all()` / `page()` return the `{ data, error }` envelope;
+ * the async iterator streams items lazily and throws on a page-fetch error.
+ *
+ * Note: pagination helpers always use the result envelope (the iterator is the throwing
+ * form) regardless of the client's `throwOnError` setting.
+ */
+interface Paginated<T> extends AsyncIterable<T> {
+  /** Fetch a single page (optionally from a cursor). */
+  page(cursor?: string): Promise<NeonResult<Page<T>>>;
+  /** Fetch and concatenate every page. */
+  all(): Promise<NeonResult<T[]>>;
+}
+/**
+ * Build a {@link Paginated} list from a page fetcher and a page mapper. The response-body
+ * type `D` is inferred and erased from the public `Paginated<T>` return.
+ */
+declare function paginate<T, D>(fetchPage: (cursor: string | undefined, signal?: AbortSignal) => Promise<RawResult<D>>, mapPage: (data: D) => Page<T>, signal?: AbortSignal): Paginated<T>;
+//#endregion
+export { Page, Paginated, paginate };
+//# sourceMappingURL=paginate.d.ts.map

package/dist/neon/paginate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paginate.d.ts","names":[],"sources":["../../src/neon/paginate.ts"],"mappings":";;;UAGiB;SACT;EADS;EAMP,MAAA,CAAA,EAAA,MAAS;;UAAT,SACF,CAAA,CAAA,CAAA,CAAA;MAEI,CAAA,EAFJ,CAEI,GAAA,SAAA;EAAQ,KAAA,CAAA,EAAA,OAAA;EAUH,QAAA,CAAA,EAVL,QAUc,GAAA,SAAA;;;;;;;;;AAIlB,UAJS,SAIT,CAAA,CAAA,CAAA,SAJ8B,aAI9B,CAJ4C,CAI5C,CAAA,CAAA;;EAJ2C,IAAA,CAAA,MAAA,CAAA,EAAA,MAAA,CAAA,EAE3B,OAF2B,CAEnB,UAFmB,CAER,IAFQ,CAEH,CAFG,CAAA,CAAA,CAAA;EAiEnC;EAAQ,GAAA,EAAA,EA7DhB,OA6DgB,CA7DR,UA6DQ,CA7DG,CA6DH,EAAA,CAAA,CAAA;;;;;;AAKI,iBALZ,QAKY,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,SAAA,EAAA,CAAA,MAAA,EAAA,MAAA,GAAA,SAAA,EAAA,MAAA,CAAA,EAFjB,WAEiB,EAAA,GADtB,OACsB,CADd,SACc,CADJ,CACI,CAAA,CAAA,EAAA,OAAA,EAAA,CAAA,IAAA,EAAX,CAAW,EAAA,GAAL,IAAK,CAAA,CAAA,CAAA,EAAA,MAAA,CAAA,EAClB,WADkB,CAAA,EAEzB,SAFyB,CAEf,CAFe,CAAA"}

package/dist/neon/paginate.js

@@ -0,0 +1,51 @@
+import { toNeonError } from "./errors.js";
+import { err, ok } from "./result.js";
+//#region src/neon/paginate.ts
+var PaginatedList = class {
+	#fetchPage;
+	#mapPage;
+	#signal;
+	constructor(fetchPage, mapPage, signal) {
+		this.#fetchPage = fetchPage;
+		this.#mapPage = mapPage;
+		this.#signal = signal;
+	}
+	async page(cursor) {
+		const raw = await this.#fetchPage(cursor, this.#signal);
+		if (raw.error || raw.data === void 0) return err(toNeonError(raw.error, raw.response));
+		return ok(this.#mapPage(raw.data));
+	}
+	async all() {
+		const items = [];
+		let cursor;
+		while (true) {
+			const result = await this.page(cursor);
+			if (result.error) return err(result.error);
+			items.push(...result.data.items);
+			if (!result.data.cursor || result.data.items.length === 0) break;
+			cursor = result.data.cursor;
+		}
+		return ok(items);
+	}
+	async *[Symbol.asyncIterator]() {
+		let cursor;
+		while (true) {
+			const result = await this.page(cursor);
+			if (result.error) throw result.error;
+			yield* result.data.items;
+			if (!result.data.cursor || result.data.items.length === 0) break;
+			cursor = result.data.cursor;
+		}
+	}
+};
+/**
+* Build a {@link Paginated} list from a page fetcher and a page mapper. The response-body
+* type `D` is inferred and erased from the public `Paginated<T>` return.
+*/
+function paginate(fetchPage, mapPage, signal) {
+	return new PaginatedList(fetchPage, mapPage, signal);
+}
+//#endregion
+export { paginate };
+
+//# sourceMappingURL=paginate.js.map