@codewithagents/openapi-react-query 3.3.1 → 3.4.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [3.4.0](https://github.com/codewithagents/glue/compare/openapi-react-query-v3.3.1...openapi-react-query-v3.4.0) (2026-05-29)
+
+
+### Features
+
+* **smoke:** expand to 9 real API requests, run on every push to main ([#144](https://github.com/codewithagents/glue/issues/144)) ([ba0c7c3](https://github.com/codewithagents/glue/commit/ba0c7c39c97f4f0a152fed67676346c035de90fd))
+
 ## [3.3.1](https://github.com/codewithagents/glue/compare/openapi-react-query-v3.3.0...openapi-react-query-v3.3.1) (2026-05-29)
 
 

package/README.md

@@ -3,7 +3,7 @@
 [![npm](https://img.shields.io/npm/v/@codewithagents/openapi-react-query.svg)](https://npmjs.com/package/@codewithagents/openapi-react-query)
 [![codecov](https://codecov.io/gh/codewithagents/glue/graph/badge.svg?flag=openapi-react-query)](https://codecov.io/gh/codewithagents/glue)
 
-Generate typed [React Query v5](https://tanstack.com/query/v5) hooks from an OpenAPI 3.1 spec. Run once, get a fully typed `useQuery` hook per GET endpoint and a `useMutation` hook per write operation — no hand-written boilerplate.
+Generate typed [React Query v5](https://tanstack.com/query/v5) hooks from an OpenAPI 3.x spec. Run once, get a fully typed `useQuery` hook per GET endpoint and a `useMutation` hook per write operation — no hand-written boilerplate.
 
 Works alongside [`@codewithagents/openapi-gen`](https://www.npmjs.com/package/@codewithagents/openapi-gen) which generates the underlying typed fetch client. All generated files are **Prettier-clean** out of the box — commit them without running a formatter.
 
@@ -33,7 +33,7 @@ Create `openapi-react-query.config.json` in your project root:
 
 | Field | Required | Default | Description |
 |---|---|---|---|
-| `input_openapi` | ✅ | — | Path to OpenAPI 3.1 spec (JSON or YAML) |
+| `input_openapi` | ✅ | — | OpenAPI 3.x spec (JSON or YAML) |
 | `output` | ✅ | — | Directory to write generated files (same as openapi-gen output) |
 | `stale_time` | — | `0` | `staleTime` in ms applied to all `useQuery` hooks |
 | `gc_time` | — | `300000` | `gcTime` in ms applied to all `useQuery` hooks |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codewithagents/openapi-react-query",
-  "version": "3.3.1",
+  "version": "3.4.0",
   "description": "Generate typed React Query v5 hooks from OpenAPI 3.1 specs",
   "type": "module",
   "bin": {
@@ -13,7 +13,7 @@
   "dependencies": {
     "openapi-types": "^12.1.3",
     "prettier": "^3.5.3",
-    "@codewithagents/openapi-gen": "4.1.0"
+    "@codewithagents/openapi-gen": "4.2.0"
   },
   "peerDependencies": {
     "@tanstack/react-query": "^5.0.0"

package/src/__tests__/compat-matrix.test.ts

@@ -1,3 +1,4 @@
+// fallow-ignore-file code-duplication
 import { describe, it } from 'vitest'
 import { readdirSync, readFileSync } from 'node:fs'
 import { resolve } from 'node:path'
@@ -7,7 +8,7 @@ import { generateHooks } from '../plugins/hooks.js'
 const configsDir = resolve(import.meta.dirname, '../../../../examples/configs')
 
 const cases = readdirSync(configsDir)
-  .filter((f) => f.endsWith('.json') && !f.startsWith('_tmp'))
+  .filter((f) => f.endsWith('.json') && !f.startsWith('_'))
   .map((f) => {
     const config = JSON.parse(readFileSync(resolve(configsDir, f), 'utf-8')) as { input_openapi: string }
     const specPath = resolve(configsDir, config.input_openapi)

package/src/__tests__/hooks.test.ts

@@ -514,6 +514,130 @@ describe('generateHooks — Feature #60: suspense query variants', () => {
     const { content } = generateHooks(suspenseSpec, { staleTime: 0, gcTime: 0, suspense: false })
     expect(content).not.toContain('useSuspenseQuery')
   })
+
+  it('suspense hook with 1 path param + optional query param generates params? signature', () => {
+    // Covers the `pathParams.length === 1 && hasQueryParams` branch (hooks.ts line 309-310)
+    // and the `paramsRequired === false` (false) branch at line 296 → paramsToken = 'params?'
+    const spec: OpenAPIV3_1.Document = {
+      openapi: '3.1.0',
+      info: { title: 'Test', version: '1.0.0' },
+      paths: {
+        '/repos/{repoId}/commits': {
+          get: {
+            operationId: 'listRepoCommits',
+            parameters: [
+              { name: 'repoId', in: 'path', required: true, schema: { type: 'string' } },
+              { name: 'branch', in: 'query', required: false, schema: { type: 'string' } },
+            ],
+            responses: { '200': { description: 'ok' } },
+          },
+        },
+      },
+    }
+    const { content } = generateHooks(spec, { staleTime: 0, gcTime: 0, suspense: true })
+    expect(content).toContain('export function useSuspenseListRepoCommits')
+    expect(content).toContain('repoId: string')
+    expect(content).toContain('params?:')
+  })
+
+  it('suspense hook with 1 path param + required query param generates params (non-optional) signature', () => {
+    // Covers the `paramsRequired === true` (true) branch at line 296 → paramsToken = 'params'
+    const spec: OpenAPIV3_1.Document = {
+      openapi: '3.1.0',
+      info: { title: 'Test', version: '1.0.0' },
+      paths: {
+        '/search/{category}': {
+          get: {
+            operationId: 'searchCategory',
+            parameters: [
+              { name: 'category', in: 'path', required: true, schema: { type: 'string' } },
+              { name: 'q', in: 'query', required: true, schema: { type: 'string' } },
+            ],
+            responses: { '200': { description: 'ok' } },
+          },
+        },
+      },
+    }
+    const { content } = generateHooks(spec, { staleTime: 0, gcTime: 0, suspense: true })
+    expect(content).toContain('export function useSuspenseSearchCategory')
+    expect(content).toContain('category: string')
+    // Required query param → non-optional params token (no ?)
+    expect(content).toContain('params: Parameters')
+  })
+
+  it('suspense hook with 2 path params builds multi-param queryKey call', () => {
+    // Covers the multi-path-param (pathParams.length > 1) queryKey branch in suspense generation
+    const spec: OpenAPIV3_1.Document = {
+      openapi: '3.1.0',
+      info: { title: 'Test', version: '1.0.0' },
+      paths: {
+        '/orgs/{orgId}/repos/{repoId}': {
+          get: {
+            operationId: 'getOrgRepo',
+            parameters: [
+              { name: 'orgId', in: 'path', required: true, schema: { type: 'string' } },
+              { name: 'repoId', in: 'path', required: true, schema: { type: 'string' } },
+            ],
+            responses: { '200': { description: 'ok' } },
+          },
+        },
+      },
+    }
+    const { content } = generateHooks(spec, { staleTime: 0, gcTime: 0, suspense: true })
+    expect(content).toContain('export function useSuspenseGetOrgRepo')
+    // Both path params appear in the function signature
+    expect(content).toContain('orgId: string')
+    expect(content).toContain('repoId: string')
+  })
+
+  it('suspense hook with 2 path params + query params builds correct queryKey', () => {
+    // Covers the else branch: pathParams.length > 1 && hasQueryParams
+    const spec: OpenAPIV3_1.Document = {
+      openapi: '3.1.0',
+      info: { title: 'Test', version: '1.0.0' },
+      paths: {
+        '/orgs/{orgId}/repos/{repoId}/commits': {
+          get: {
+            operationId: 'listOrgRepoCommits',
+            parameters: [
+              { name: 'orgId', in: 'path', required: true, schema: { type: 'string' } },
+              { name: 'repoId', in: 'path', required: true, schema: { type: 'string' } },
+              { name: 'branch', in: 'query', required: false, schema: { type: 'string' } },
+            ],
+            responses: { '200': { description: 'ok' } },
+          },
+        },
+      },
+    }
+    const { content } = generateHooks(spec, { staleTime: 0, gcTime: 0, suspense: true })
+    expect(content).toContain('export function useSuspenseListOrgRepoCommits')
+    expect(content).toContain('orgId: string')
+    expect(content).toContain('repoId: string')
+    expect(content).toContain('params?:')
+  })
+
+  it('deprecated GET with suspense: true emits @deprecated JSDoc on the suspense hook', () => {
+    // Covers the `if (op.deprecated)` branch in suspense hook generation
+    const spec: OpenAPIV3_1.Document = {
+      openapi: '3.1.0',
+      info: { title: 'Test', version: '1.0.0' },
+      paths: {
+        '/legacy': {
+          get: {
+            operationId: 'listLegacy',
+            deprecated: true,
+            responses: { '200': { description: 'ok' } },
+          },
+        },
+      },
+    }
+    const { content } = generateHooks(spec, { staleTime: 0, gcTime: 0, suspense: true })
+    const suspenseIdx = content.indexOf('export function useSuspenseListLegacy')
+    expect(suspenseIdx).toBeGreaterThan(-1)
+    // @deprecated comment appears immediately before the function declaration
+    const before = content.slice(0, suspenseIdx)
+    expect(before.slice(before.lastIndexOf('/**'))).toContain('@deprecated')
+  })
 })
 
 // ── Feature #59: Per-resource staleTime and gcTime overrides ───────────────────
@@ -1498,3 +1622,40 @@ describe('Bug #106: ...options spread must not overwrite auto-invalidation onSuc
     expect(hookContent).not.toContain('onSuccess:')
   })
 })
+
+describe('coverage: spec without paths property — generates empty output', () => {
+  it('spec with paths=undefined produces a valid but empty hooks file', () => {
+    // Covers the `if (paths !== undefined)` false branch in generateHooks (line 542)
+    const spec = {
+      openapi: '3.1.0',
+      info: { title: 'Empty', version: '1.0.0' },
+      // no paths property
+    } as OpenAPIV3_1.Document
+    const { content } = generateHooks(spec, { staleTime: 0, gcTime: 0 })
+    expect(content).toBeDefined()
+    // No hooks generated — just the header boilerplate
+    expect(content).not.toContain('export function use')
+  })
+})
+
+describe('coverage: requestBody with no content — hasBody but no bodyTypeName', () => {
+  it('POST with requestBody missing content property produces mutation without typed body', () => {
+    // Covers `if (content === undefined) return { hasBody: true, bodyTypeName: undefined }` (line 112)
+    const spec: OpenAPIV3_1.Document = {
+      openapi: '3.1.0',
+      info: { title: 'Test', version: '1.0.0' },
+      paths: {
+        '/items': {
+          post: {
+            operationId: 'createItem',
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            requestBody: { required: true } as any, // no content property
+            responses: { '201': { description: 'created' } },
+          },
+        },
+      },
+    }
+    const { content } = generateHooks(spec, { staleTime: 0, gcTime: 0 })
+    expect(content).toContain('export function useCreateItem')
+  })
+})