@codewithagents/openapi-react-query 3.5.1 → 3.6.0

package/src/__tests__/prettier-output.test.ts

@@ -1,45 +0,0 @@
-import { mkdtemp, readFile, writeFile } from 'node:fs/promises'
-import { join } from 'node:path'
-import { tmpdir } from 'node:os'
-import { check } from 'prettier'
-import { describe, it, expect, afterEach } from 'vitest'
-import { generate } from '../generator.js'
-
-const taskHooksFixture = join(import.meta.dirname, '../../__fixtures__/specs/task-hooks.json')
-
-let tmpDir: string | undefined
-
-afterEach(async () => {
-  if (tmpDir) {
-    const { rm } = await import('node:fs/promises')
-    await rm(tmpDir, { recursive: true, force: true })
-    tmpDir = undefined
-  }
-})
-
-async function runGenerator(): Promise<string> {
-  tmpDir = await mkdtemp(join(tmpdir(), 'openapi-react-query-prettier-test-'))
-  const configPath = join(tmpDir, 'openapi-react-query.config.json')
-  const outDir = join(tmpDir, 'generated')
-  await writeFile(
-    configPath,
-    JSON.stringify({ input_openapi: taskHooksFixture, output: outDir }),
-    'utf-8'
-  )
-  await generate(tmpDir, configPath)
-  return outDir
-}
-
-describe('generated output is Prettier-clean (task-hooks)', () => {
-  it('hooks.ts is Prettier-clean', async () => {
-    const outDir = await runGenerator()
-    const content = await readFile(join(outDir, 'hooks.ts'), 'utf-8')
-    expect(await check(content, { parser: 'typescript' })).toBe(true)
-  })
-
-  it('test-utils.ts is Prettier-clean', async () => {
-    const outDir = await runGenerator()
-    const content = await readFile(join(outDir, 'test-utils.ts'), 'utf-8')
-    expect(await check(content, { parser: 'typescript' })).toBe(true)
-  })
-})

package/src/__tests__/test-utils.test.ts

@@ -1,69 +0,0 @@
-import { readFileSync } from 'node:fs'
-import { join } from 'node:path'
-import { describe, expect, it } from 'vitest'
-import type { OpenAPIV3_1 } from 'openapi-types'
-import { generateTestUtils } from '../plugins/test-utils.js'
-
-// Load fixture directly (no parseSpec — avoids needing openapi-gen dist built)
-const fixturePath = join(import.meta.dirname, '../../__fixtures__/specs/task-hooks.json')
-const spec = JSON.parse(readFileSync(fixturePath, 'utf-8')) as OpenAPIV3_1.Document
-
-const { filename, content } = generateTestUtils(spec)
-
-describe('generateTestUtils', () => {
-  it('filename is test-utils.ts', () => {
-    expect(filename).toBe('test-utils.ts')
-  })
-
-  it('contains auto-generated header comment', () => {
-    expect(content).toContain(
-      '// This file is auto-generated by @codewithagents/openapi-react-query — do not edit'
-    )
-  })
-
-  it('imports QueryClient from @tanstack/react-query (existing peer dep — no new deps)', () => {
-    expect(content).toContain("from '@tanstack/react-query'")
-    expect(content).toContain('QueryClient')
-  })
-
-  it('does NOT import from any testing framework (vitest, jest, testing-library)', () => {
-    expect(content).not.toContain("from 'vitest'")
-    expect(content).not.toContain("from '@vitest/")
-    expect(content).not.toContain("from 'jest'")
-    expect(content).not.toContain("from '@testing-library/")
-    expect(content).not.toContain("from 'msw'")
-  })
-
-  it('exports createTestQueryClient function', () => {
-    expect(content).toContain('export function createTestQueryClient(')
-  })
-
-  it('createTestQueryClient returns a QueryClient with retry disabled', () => {
-    expect(content).toContain('retry: false')
-  })
-
-  it('createTestQueryClient disables gcTime or sets it to a deterministic value', () => {
-    // Ensures queries don't linger between tests with stale data
-    expect(content).toContain('gcTime:')
-  })
-
-  it('exports createWrapper function', () => {
-    expect(content).toContain('export function createWrapper(')
-  })
-
-  it('createWrapper uses QueryClientProvider (from the same peer dep)', () => {
-    expect(content).toContain('QueryClientProvider')
-  })
-
-  it('createWrapper returns a component usable as wrapper in renderHook', () => {
-    // The wrapper component must accept { children } — ReactNode from react (also peer dep)
-    expect(content).toContain('children')
-  })
-
-  it('does not import from msw or any test-runner-specific module', () => {
-    // The file should be completely test-runner agnostic
-    expect(content).not.toContain('msw')
-    expect(content).not.toContain('vi.fn')
-    expect(content).not.toContain('jest.fn')
-  })
-})

package/src/cli.ts

@@ -1,27 +0,0 @@
-#!/usr/bin/env node
-import { resolve, dirname } from 'node:path'
-import { generate } from './generator.js'
-
-const args = process.argv.slice(2)
-const configIdx = args.indexOf('--config')
-
-let cwd = process.cwd()
-let configFile: string | undefined
-
-if (configIdx !== -1) {
-  const next = args[configIdx + 1]
-  if (next === undefined || next.startsWith('--')) {
-    console.error('Error: --config requires a file path argument')
-    console.error('Usage: openapi-react-query [--config <path-to-config.json>]')
-    process.exit(1)
-  }
-  configFile = resolve(cwd, next)
-  // Relative paths inside the config resolve from the config file's directory,
-  // not from the shell's CWD. This matches how most tooling works.
-  cwd = dirname(configFile)
-}
-
-generate(cwd, configFile).catch((err: Error) => {
-  console.error(`Error: ${err.message}`)
-  process.exit(1)
-})

package/src/config.ts

@@ -1,171 +0,0 @@
-import { readFile } from 'node:fs/promises'
-import { join, resolve } from 'node:path'
-
-export interface ReactQueryConfig {
-  /** Path to OpenAPI 3.1 spec file (JSON or YAML) */
-  input_openapi: string
-  /** Directory to write generated files */
-  output: string
-  /** staleTime in ms for all useQuery hooks (default: 0) */
-  stale_time?: number
-  /** gcTime in ms for all useQuery hooks (default: 300000) */
-  gc_time?: number
-  /** When true, generates useSuspense* variants alongside each useQuery hook (default: false) */
-  suspense?: boolean
-  /** Per-resource cache timing overrides. Key is the resource name (e.g. "tasks", "platforms"). */
-  overrides?: Record<string, { stale_time?: number; gc_time?: number }>
-  /** When true, mutation hooks auto-invalidate related resource queries on success (default: false) */
-  auto_invalidate?: boolean
-}
-
-const FORBIDDEN_OUTPUT_PREFIXES = [
-  '/etc',
-  '/usr',
-  '/bin',
-  '/sbin',
-  '/lib',
-  '/lib64',
-  '/sys',
-  '/proc',
-  '/dev',
-  '/boot',
-  '/run',
-  'C:\\Windows',
-  'C:\\Program Files',
-]
-
-const FORBIDDEN_INPUT_PREFIXES = [
-  '/etc',
-  '/usr',
-  '/bin',
-  '/sbin',
-  '/lib',
-  '/lib64',
-  '/sys',
-  '/proc',
-  '/dev',
-  'C:\\Windows',
-  'C:\\Program Files',
-]
-
-export function validateConfigPath(configPath: string): void {
-  // Must end in .json — prevents accidentally loading non-config files
-  if (!configPath.endsWith('.json')) {
-    throw new Error(`Config file must be a .json file, got: ${configPath}`)
-  }
-}
-
-export function validateOutputPath(resolvedOutput: string): void {
-  const normalized = resolvedOutput.replace(/\\/g, '/')
-  for (const forbidden of FORBIDDEN_OUTPUT_PREFIXES) {
-    const normalizedForbidden = forbidden.replace(/\\/g, '/')
-    if (normalized === normalizedForbidden || normalized.startsWith(normalizedForbidden + '/')) {
-      throw new Error(
-        `Output path resolves to a system directory: "${resolvedOutput}". ` +
-          `This looks like a misconfiguration — please check your config file.`
-      )
-    }
-  }
-}
-
-export function validateInputPath(resolvedInput: string): void {
-  const normalized = resolvedInput.replace(/\\/g, '/')
-  for (const forbidden of FORBIDDEN_INPUT_PREFIXES) {
-    const normalizedForbidden = forbidden.replace(/\\/g, '/')
-    if (normalized === normalizedForbidden || normalized.startsWith(normalizedForbidden + '/')) {
-      throw new Error(
-        `Input spec path resolves to a system directory: "${resolvedInput}". ` +
-          `This looks like a misconfiguration — please check your config file.`
-      )
-    }
-  }
-}
-
-export async function loadConfig(cwd: string, configPath?: string): Promise<ReactQueryConfig> {
-  const resolvedConfigPath = configPath ?? join(cwd, 'openapi-react-query.config.json')
-
-  // Security: validate config path extension when explicitly provided
-  if (configPath !== undefined) {
-    validateConfigPath(configPath)
-  }
-
-  let raw: string
-  try {
-    raw = await readFile(resolvedConfigPath, 'utf-8')
-  } catch {
-    throw new Error(`Config file not found: ${resolvedConfigPath}`)
-  }
-
-  let parsed: unknown
-  try {
-    parsed = JSON.parse(raw)
-  } catch {
-    throw new Error(`Config file is not valid JSON: ${resolvedConfigPath}`)
-  }
-
-  if (typeof parsed !== 'object' || parsed === null) {
-    throw new Error('Config must be a JSON object')
-  }
-
-  const config = parsed as Record<string, unknown>
-
-  if (typeof config['input_openapi'] !== 'string' || !config['input_openapi']) {
-    throw new Error('Config missing required field: "input_openapi" (path to OpenAPI 3.1 spec)')
-  }
-  if (typeof config['output'] !== 'string' || !config['output']) {
-    throw new Error('Config missing required field: "output" (output directory)')
-  }
-  if (config['stale_time'] !== undefined && typeof config['stale_time'] !== 'number') {
-    throw new Error('"stale_time" must be a number (milliseconds)')
-  }
-  if (config['gc_time'] !== undefined && typeof config['gc_time'] !== 'number') {
-    throw new Error('"gc_time" must be a number (milliseconds)')
-  }
-  if (config['suspense'] !== undefined && typeof config['suspense'] !== 'boolean') {
-    throw new Error('"suspense" must be a boolean')
-  }
-  if (config['auto_invalidate'] !== undefined && typeof config['auto_invalidate'] !== 'boolean') {
-    throw new Error('"auto_invalidate" must be a boolean')
-  }
-  if (config['overrides'] !== undefined) {
-    if (
-      typeof config['overrides'] !== 'object' ||
-      config['overrides'] === null ||
-      Array.isArray(config['overrides'])
-    ) {
-      throw new Error('"overrides" must be an object')
-    }
-    for (const [resource, timing] of Object.entries(
-      config['overrides'] as Record<string, unknown>
-    )) {
-      if (typeof timing !== 'object' || timing === null) {
-        throw new Error(`"overrides.${resource}" must be an object`)
-      }
-      const t = timing as Record<string, unknown>
-      if (t['stale_time'] !== undefined && typeof t['stale_time'] !== 'number') {
-        throw new Error(`"overrides.${resource}.stale_time" must be a number`)
-      }
-      if (t['gc_time'] !== undefined && typeof t['gc_time'] !== 'number') {
-        throw new Error(`"overrides.${resource}.gc_time" must be a number`)
-      }
-    }
-  }
-
-  // Security: validate resolved input and output paths
-  const resolvedInput = resolve(cwd, config['input_openapi'] as string)
-  const resolvedOutput = resolve(cwd, config['output'] as string)
-  validateInputPath(resolvedInput)
-  validateOutputPath(resolvedOutput)
-
-  return {
-    input_openapi: config['input_openapi'] as string,
-    output: config['output'] as string,
-    stale_time: config['stale_time'] as number | undefined,
-    gc_time: config['gc_time'] as number | undefined,
-    suspense: config['suspense'] as boolean | undefined,
-    overrides: config['overrides'] as
-      | Record<string, { stale_time?: number; gc_time?: number }>
-      | undefined,
-    auto_invalidate: config['auto_invalidate'] as boolean | undefined,
-  }
-}

package/src/generator.ts

@@ -1,50 +0,0 @@
-import { mkdir, writeFile } from 'node:fs/promises'
-import { join, resolve } from 'node:path'
-import { parseSpec } from '@codewithagents/openapi-gen'
-import { loadConfig } from './config.js'
-import { generateHooks } from './plugins/hooks.js'
-import { generateTestUtils } from './plugins/test-utils.js'
-
-async function formatTs(content: string, filePath: string): Promise<string> {
-  const { format, resolveConfig } = await import('prettier')
-  const config = await resolveConfig(filePath)
-  return format(content, { ...config, parser: 'typescript' })
-}
-
-export async function generate(cwd: string, configPath?: string): Promise<void> {
-  const config = await loadConfig(cwd, configPath)
-  const inputPath = resolve(cwd, config.input_openapi)
-  const outputDir = resolve(cwd, config.output)
-  const spec = await parseSpec(inputPath)
-  const globalStaleTime = config.stale_time ?? 0
-  const globalGcTime = config.gc_time ?? 300_000
-
-  // Convert snake_case config overrides to camelCase options
-  const overrides: Record<string, { staleTime: number; gcTime: number }> = {}
-  if (config.overrides) {
-    for (const [resource, timing] of Object.entries(config.overrides)) {
-      overrides[resource] = {
-        staleTime: timing.stale_time ?? globalStaleTime,
-        gcTime: timing.gc_time ?? globalGcTime,
-      }
-    }
-  }
-
-  const files = [
-    generateHooks(spec, {
-      staleTime: globalStaleTime,
-      gcTime: globalGcTime,
-      suspense: config.suspense,
-      overrides: Object.keys(overrides).length > 0 ? overrides : undefined,
-      autoInvalidate: config.auto_invalidate,
-    }),
-    generateTestUtils(spec),
-  ]
-
-  await mkdir(outputDir, { recursive: true })
-  for (const file of files) {
-    const filePath = join(outputDir, file.filename)
-    await writeFile(filePath, await formatTs(file.content, filePath), 'utf-8')
-    console.log(`✓ ${file.filename}`)
-  }
-}