feat(core): migrate to @hey-api/openapi-ts

.github/workflows/ci.yml

@@ -18,9 +18,7 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.CUSTOM_GITHUB_PERSONAL_TOKEN }}
 
     - name: setup pnpm
-      uses: pnpm/action-setup@v2
-      with:
-        version: 8
+      uses: pnpm/action-setup@v4
 
     - name: Set up Node.js
       uses: actions/setup-node@v4
@@ -32,16 +30,14 @@ jobs:
     - name: Install dependencies
       run: pnpm install
 
-    - name: Check lock file for untrusted packages
-      run: pnpm dlx lockfile-lint --path package-lock.json --allowed-hosts npm --validate-https
+    - name: Generate OpenAPI bindings
+      run: pnpm run generate
 
-    - name: Generate OpenAPI bindings and build package
-      run: |
-        pnpm run generate
-        pnpm run build
+    - name: Type-check and build package
+      run: pnpm run build
 
     - name: Check package for packaging errors
-      run: pnpm dlx publint run
+      run: pnpm dlx publint run --strict
 
     - name: Check for uncommitted changes
       # Ensure no changes, but ignore node_modules dir since dev/fresh ci deps installed.

.github/workflows/refresh-spec.yml

@@ -15,9 +15,7 @@ jobs:
         fetch-depth: 0
 
     - name: setup pnpm
-      uses: pnpm/action-setup@v2
-      with:
-        version: 8
+      uses: pnpm/action-setup@v4
 
     - name: Set up Node.js
       uses: actions/setup-node@v4

.github/workflows/release+publish.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - beta
     tags:
       - '!*'
 
@@ -22,9 +23,7 @@ jobs:
         token: ${{ secrets.CUSTOM_GITHUB_PERSONAL_TOKEN }}
 
     - name: setup pnpm
-      uses: pnpm/action-setup@v2
-      with:
-        version: 8
+      uses: pnpm/action-setup@v4
 
     - name: Set up Node.js
       uses: actions/setup-node@v4
@@ -36,9 +35,6 @@ jobs:
     - name: Install dependencies
       run: pnpm install
 
-    - name: Check lock file for untrusted packages
-      run: pnpm dlx lockfile-lint --path package-lock.json --allowed-hosts npm --validate-https
-
     - name: Build package
       run: pnpm run build
 

.npmrc

@@ -1,2 +1,3 @@
 save-exact=true
 fund=false
+package-manager-strict=false

.releaserc.json

@@ -1,6 +1,10 @@
 {
     "branches": [
-        "main"
+        "main",
+        {
+            "name": "beta",
+            "prerelease": true
+        }
     ],
     "plugins": [
         "@semantic-release/commit-analyzer",

README.md

@@ -5,12 +5,14 @@
 
 Fully-typed, zero-dependency Node.js and Deno SDK for managing your [Neon](https://neon.tech/) Serverless Postgres projects.
 
-> **Note**
-
+> [!NOTE]
 > Neon is a fully managed serverless PostgreSQL with a generous free tier. Neon separates storage and compute and offers modern developer features such as serverless, branching, bottomless storage, and more. Neon is open source and written in Rust.
 > 
 > [Learn more about Neon](https://neon.tech/docs/introduction/about)
 
+> [!IMPORTANT]
+> Note that you're reading the documentation for v2.x of this package. If you're still using the legacy v1.x version, see the [v1.x documentation](https://github.com/paambaati/neon-js-sdk/blob/v1.21.0/README.md#usage).
+
 ## Usage
 
 **Node.js (>= v18.x)**
@@ -68,6 +70,32 @@ node --experimental-fetch app.js
     deno run --allow-net=console.neon.tech neon.ts
     ```
 
+## Recipes
+
+All API responses are typed as a union of the specific API's successful response and `GeneralError`. To narrow this type down –
+
+```typescript
+import { NeonClient, type GeneralError } from 'neon-sdk';
+
+function isNeonError(neonResponse: unknown): neonResponse is GeneralError {
+    const allowedKeys = ['code', 'message'].sort();
+    const foundKeys = Object.getOwnPropertyNames(neonResponse || {}).sort();
+    return foundKeys.length === allowedKeys.length
+            && foundKeys.every((value, index) => value === allowedKeys[index])
+            && (neonResponse as GeneralError).code !== undefined
+            && (neonResponse as GeneralError).message !== undefined;
+}
+
+const neonClient = new NeonClient({
+    TOKEN: "<INSERT NEON API KEY HERE>",
+});
+const response = await neonClient.project.listProjects();
+
+if (!isNeonError(response)) {
+    // Correctly typed as `ProjectsResponse`
+    response
+}
+```
 ## Developer Notes
 
-This package is auto-generated from [Neon's OpenAPI reference](https://neon.tech/api-reference/v2/) using [`openapi-typescript-codegen`](https://www.npmjs.com/package/openapi-typescript-codegen).
+This package is auto-generated from [Neon's OpenAPI reference](https://neon.tech/api-reference/v2/) using [`@hey-api/openapi-ts`](https://github.com/hey-api/openapi-ts).

generated/NeonClient.ts

@@ -1,46 +1,56 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
 import type { BaseHttpRequest } from './core/BaseHttpRequest';
 import type { OpenAPIConfig } from './core/OpenAPI';
+import { Interceptors } from './core/OpenAPI';
 import { FetchHttpRequest } from './core/FetchHttpRequest';
-import { ApiKeyService } from './services/ApiKeyService';
-import { BranchService } from './services/BranchService';
-import { ConsumptionService } from './services/ConsumptionService';
-import { EndpointService } from './services/EndpointService';
-import { OperationService } from './services/OperationService';
-import { ProjectService } from './services/ProjectService';
-import { UsersService } from './services/UsersService';
+
+import { ApiKeyService } from './services.gen';
+import { BranchService } from './services.gen';
+import { ConsumptionService } from './services.gen';
+import { DefaultService } from './services.gen';
+import { EndpointService } from './services.gen';
+import { OperationService } from './services.gen';
+import { ProjectService } from './services.gen';
+import { UsersService } from './services.gen';
+
 type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest;
+
 export class NeonClient {
-    public readonly apiKey: ApiKeyService;
-    public readonly branch: BranchService;
-    public readonly consumption: ConsumptionService;
-    public readonly endpoint: EndpointService;
-    public readonly operation: OperationService;
-    public readonly project: ProjectService;
-    public readonly users: UsersService;
-    public readonly request: BaseHttpRequest;
-    constructor(config?: Partial<OpenAPIConfig>, HttpRequest: HttpRequestConstructor = FetchHttpRequest) {
-        this.request = new HttpRequest({
-            BASE: config?.BASE ?? 'https://console.neon.tech/api/v2',
-            VERSION: config?.VERSION ?? '2',
-            WITH_CREDENTIALS: config?.WITH_CREDENTIALS ?? false,
-            CREDENTIALS: config?.CREDENTIALS ?? 'include',
-            TOKEN: config?.TOKEN,
-            USERNAME: config?.USERNAME,
-            PASSWORD: config?.PASSWORD,
-            HEADERS: config?.HEADERS,
-            ENCODE_PATH: config?.ENCODE_PATH,
-        });
-        this.apiKey = new ApiKeyService(this.request);
-        this.branch = new BranchService(this.request);
-        this.consumption = new ConsumptionService(this.request);
-        this.endpoint = new EndpointService(this.request);
-        this.operation = new OperationService(this.request);
-        this.project = new ProjectService(this.request);
-        this.users = new UsersService(this.request);
-    }
-}
 
+	public readonly apiKey: ApiKeyService;
+	public readonly branch: BranchService;
+	public readonly consumption: ConsumptionService;
+	public readonly default: DefaultService;
+	public readonly endpoint: EndpointService;
+	public readonly operation: OperationService;
+	public readonly project: ProjectService;
+	public readonly users: UsersService;
+
+	public readonly request: BaseHttpRequest;
+
+	constructor(config?: Partial<OpenAPIConfig>, HttpRequest: HttpRequestConstructor = FetchHttpRequest) {
+		this.request = new HttpRequest({
+			BASE: config?.BASE ?? 'https://console.neon.tech/api/v2',
+			VERSION: config?.VERSION ?? '2',
+			WITH_CREDENTIALS: config?.WITH_CREDENTIALS ?? false,
+			CREDENTIALS: config?.CREDENTIALS ?? 'include',
+			TOKEN: config?.TOKEN,
+			USERNAME: config?.USERNAME,
+			PASSWORD: config?.PASSWORD,
+			HEADERS: config?.HEADERS,
+			ENCODE_PATH: config?.ENCODE_PATH,
+			interceptors: {
+				request: config?.interceptors?.request ?? new Interceptors(),
+				response: config?.interceptors?.response ?? new Interceptors(),
+      },
+		});
+
+		this.apiKey = new ApiKeyService(this.request);
+		this.branch = new BranchService(this.request);
+		this.consumption = new ConsumptionService(this.request);
+		this.default = new DefaultService(this.request);
+		this.endpoint = new EndpointService(this.request);
+		this.operation = new OperationService(this.request);
+		this.project = new ProjectService(this.request);
+		this.users = new UsersService(this.request);
+	}
+}

generated/core/ApiError.ts

@@ -1,25 +1,21 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
 import type { ApiRequestOptions } from './ApiRequestOptions';
 import type { ApiResult } from './ApiResult';
 
 export class ApiError extends Error {
-    public readonly url: string;
-    public readonly status: number;
-    public readonly statusText: string;
-    public readonly body: any;
-    public readonly request: ApiRequestOptions;
+	public readonly url: string;
+	public readonly status: number;
+	public readonly statusText: string;
+	public readonly body: unknown;
+	public readonly request: ApiRequestOptions;
 
-    constructor(request: ApiRequestOptions, response: ApiResult, message: string) {
-        super(message);
+	constructor(request: ApiRequestOptions, response: ApiResult, message: string) {
+		super(message);
 
-        this.name = 'ApiError';
-        this.url = response.url;
-        this.status = response.status;
-        this.statusText = response.statusText;
-        this.body = response.body;
-        this.request = request;
-    }
-}
+		this.name = 'ApiError';
+		this.url = response.url;
+		this.status = response.status;
+		this.statusText = response.statusText;
+		this.body = response.body;
+		this.request = request;
+	}
+}

generated/core/ApiRequestOptions.ts

@@ -1,17 +1,13 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
 export type ApiRequestOptions = {
-    readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH';
-    readonly url: string;
-    readonly path?: Record<string, any>;
-    readonly cookies?: Record<string, any>;
-    readonly headers?: Record<string, any>;
-    readonly query?: Record<string, any>;
-    readonly formData?: Record<string, any>;
-    readonly body?: any;
-    readonly mediaType?: string;
-    readonly responseHeader?: string;
-    readonly errors?: Record<number, string>;
-};
+	readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH';
+	readonly url: string;
+	readonly path?: Record<string, unknown>;
+	readonly cookies?: Record<string, unknown>;
+	readonly headers?: Record<string, unknown>;
+	readonly query?: Record<string, unknown>;
+	readonly formData?: Record<string, unknown>;
+	readonly body?: any;
+	readonly mediaType?: string;
+	readonly responseHeader?: string;
+	readonly errors?: Record<number | string, string>;
+};

generated/core/ApiResult.ts

@@ -1,11 +1,7 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type ApiResult = {
-    readonly url: string;
-    readonly ok: boolean;
-    readonly status: number;
-    readonly statusText: string;
-    readonly body: any;
-};
+export type ApiResult<TData = any> = {
+	readonly body: TData;
+	readonly ok: boolean;
+	readonly status: number;
+	readonly statusText: string;
+	readonly url: string;
+};

generated/core/BaseHttpRequest.ts

@@ -1,14 +1,10 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
 import type { ApiRequestOptions } from './ApiRequestOptions';
 import type { CancelablePromise } from './CancelablePromise';
 import type { OpenAPIConfig } from './OpenAPI';
 
 export abstract class BaseHttpRequest {
 
-    constructor(public readonly config: OpenAPIConfig) {}
+	constructor(public readonly config: OpenAPIConfig) {}
 
-    public abstract request<T>(options: ApiRequestOptions): CancelablePromise<T>;
-}
+	public abstract request<T>(options: ApiRequestOptions): CancelablePromise<T>;
+}