@pikku/openapi-parser 0.12.20 → 0.12.22

package/src/parse-openapi.ts

@@ -1,467 +0,0 @@
-/**
- * Parses OpenAPI YAML/JSON specs, resolves $ref pointers, and produces a normalized IR.
- */
-import { createHash } from 'crypto'
-import { readFile } from 'fs/promises'
-import { parse as parseYAML } from 'yaml'
-
-import type { OpenAPISchema } from './zod-codegen.js'
-
-export interface ErrorResponse {
-  statusCode: number
-  description: string
-}
-
-export interface SecuritySchemeInfo {
-  type: 'oauth2' | 'http' | 'apiKey'
-  scheme?: string
-  bearerFormat?: string
-  name?: string
-  in?: string
-  flows?: {
-    authorizationUrl?: string
-    tokenUrl?: string
-    scopes?: Record<string, string>
-  }
-}
-
-export interface ParsedSpec {
-  info: { title: string; version: string; description?: string }
-  baseUrl: string
-  serverUrls: string[]
-  authType: 'bearer' | 'oauth2' | 'apiKey' | 'none'
-  operations: ParsedOperation[]
-  componentSchemas: Record<string, OpenAPISchema>
-  securitySchemes: Record<string, SecuritySchemeInfo>
-  tagDescriptions: Record<string, string>
-}
-
-export interface ParsedOperation {
-  operationId?: string
-  method: string
-  path: string
-  summary?: string
-  description?: string
-  tags: string[]
-  pathParams: ParsedParam[]
-  queryParams: ParsedParam[]
-  headerParams: ParsedParam[]
-  requestBody?: OpenAPISchema
-  requestBodyDescription?: string
-  requestBodyRequired?: boolean
-  responseSchema?: OpenAPISchema
-  responseDescription?: string
-  errorResponses: ErrorResponse[]
-  deprecated: boolean
-}
-
-export interface ParsedParam {
-  name: string
-  required: boolean
-  schema: OpenAPISchema
-  description?: string
-  example?: unknown
-}
-
-/**
- * Read and parse an OpenAPI spec from a file path.
- * Supports both YAML (.yaml, .yml) and JSON (.json) files.
- */
-export async function parseOpenAPISpec(filePath: string): Promise<ParsedSpec> {
-  const content = await readFile(filePath, 'utf-8')
-
-  let doc: any
-  if (filePath.endsWith('.json')) {
-    doc = JSON.parse(content)
-  } else {
-    doc = parseYAML(content)
-  }
-
-  // Validate spec version
-  const specVersion = doc.openapi ?? doc.swagger
-  if (!specVersion) {
-    throw new Error(
-      'Not a valid OpenAPI/Swagger spec: missing "openapi" or "swagger" version field.'
-    )
-  }
-  const major = String(specVersion).split('.')[0]
-  if (major !== '2' && major !== '3') {
-    throw new Error(
-      `Unsupported spec version "${specVersion}". Only OpenAPI 3.x and Swagger 2.x are supported.`
-    )
-  }
-
-  // Resolve all $ref pointers in-place
-  resolveRefs(doc, doc)
-
-  const info = {
-    title: doc.info?.title ?? 'Unknown API',
-    version: doc.info?.version ?? '1.0.0',
-    description: doc.info?.description,
-  }
-
-  const serverUrls = extractServerUrls(doc)
-  const baseUrl = serverUrls[0] ?? ''
-  const authType = detectAuthType(doc)
-  const securitySchemes = extractSecuritySchemes(doc)
-  const tagDescriptions = extractTagDescriptions(doc)
-
-  // Extract component schemas (OpenAPI 3.x: components.schemas, Swagger 2.x: definitions)
-  const componentSchemas: Record<string, OpenAPISchema> = {}
-  const rawSchemas = doc.components?.schemas ?? doc.definitions ?? {}
-  for (const [name, schema] of Object.entries(rawSchemas)) {
-    componentSchemas[name] = schema as OpenAPISchema
-  }
-
-  // Extract operations (skip deprecated)
-  const operations: ParsedOperation[] = []
-  if (doc.paths) {
-    for (const [path, pathItem] of Object.entries(
-      doc.paths as Record<string, any>
-    )) {
-      // Shared parameters at the path level
-      const sharedParams: any[] = pathItem.parameters ?? []
-
-      for (const method of ['get', 'post', 'put', 'patch', 'delete'] as const) {
-        const op = pathItem[method]
-        if (!op) continue
-
-        // Skip deprecated operations
-        if (op.deprecated === true) continue
-
-        const allParams: any[] = [...sharedParams, ...(op.parameters ?? [])]
-
-        // OpenAPI 3.x: op.requestBody, Swagger 2.x: parameters[].in === 'body'
-        const body3 = op.requestBody
-        const body2 = allParams.find((p: any) => p.in === 'body')
-
-        operations.push({
-          operationId: op.operationId,
-          method,
-          path,
-          summary: op.summary,
-          description: op.description,
-          tags: op.tags ?? [],
-          pathParams: extractParams(allParams, 'path'),
-          queryParams: extractParams(allParams, 'query'),
-          headerParams: extractParams(allParams, 'header'),
-          requestBody: extractRequestBody(op),
-          requestBodyDescription: body3?.description ?? body2?.description,
-          requestBodyRequired: body3?.required ?? body2?.required,
-          responseSchema: extractResponseSchema(op),
-          responseDescription: extractResponseDescription(op),
-          errorResponses: extractErrorResponses(op),
-          deprecated: false,
-        })
-      }
-    }
-  }
-
-  return {
-    info,
-    baseUrl,
-    serverUrls,
-    authType,
-    operations,
-    componentSchemas,
-    securitySchemes,
-    tagDescriptions,
-  }
-}
-
-/** Recursively resolve $ref pointers in-place, with cycle detection */
-function resolveRefs(node: any, root: any, visited?: Set<any>): any {
-  if (node === null || typeof node !== 'object') return node
-
-  const seen = visited ?? new Set<any>()
-  if (seen.has(node)) return node
-  seen.add(node)
-
-  if (Array.isArray(node)) {
-    for (let i = 0; i < node.length; i++) {
-      node[i] = resolveRefs(node[i], root, seen)
-    }
-    return node
-  }
-
-  if (typeof node.$ref === 'string') {
-    const resolved = resolveRefPath(node.$ref, root)
-    if (resolved && typeof resolved === 'object') {
-      // Merge any sibling properties (like description overrides)
-      const { $ref, ...siblings } = node
-      const result = { ...resolved, ...siblings }
-      // Don't recurse into the merged result — it shares structure with
-      // the original resolved object and may be circular
-      return result
-    }
-    return node
-  }
-
-  for (const key of Object.keys(node)) {
-    node[key] = resolveRefs(node[key], root, seen)
-  }
-
-  return node
-}
-
-function resolveRefPath(ref: string, root: any): any {
-  if (!ref.startsWith('#/')) return undefined
-  const parts = ref.slice(2).split('/')
-  let current = root
-  for (const part of parts) {
-    const decoded = part.replace(/~1/g, '/').replace(/~0/g, '~')
-    if (current == null || typeof current !== 'object') return undefined
-    current = current[decoded]
-  }
-  return current
-}
-
-function extractServerUrls(doc: any): string[] {
-  // OpenAPI 3.x
-  if (doc.servers && doc.servers.length > 0) {
-    return doc.servers.map((s: any) => s.url).filter((url: string) => !!url)
-  }
-  // Swagger 2.x
-  if (doc.host) {
-    const schemes = doc.schemes?.length ? doc.schemes : ['https']
-    const basePath = doc.basePath ?? ''
-    return schemes.map((scheme: string) => `${scheme}://${doc.host}${basePath}`)
-  }
-  return []
-}
-
-function detectAuthType(doc: any): 'bearer' | 'oauth2' | 'apiKey' | 'none' {
-  const securitySchemes =
-    doc.components?.securitySchemes ?? doc.securityDefinitions ?? {}
-
-  for (const scheme of Object.values(securitySchemes) as any[]) {
-    if (scheme.type === 'oauth2') return 'oauth2'
-    if (scheme.type === 'http' && scheme.scheme === 'bearer') return 'bearer'
-    if (scheme.type === 'apiKey') return 'apiKey'
-  }
-
-  return 'none'
-}
-
-/**
- * Build an OpenAPI schema object from v2-style parameter-level properties
- * (type, enum, items, format, default) that aren't nested under `schema`.
- */
-function paramToSchema(p: any): OpenAPISchema {
-  const schema: any = { type: p.type ?? 'string' }
-  if (p.enum) schema.enum = p.enum
-  if (p.items) schema.items = p.items
-  if (p.format) schema.format = p.format
-  if (p.default !== undefined) schema.default = p.default
-  return schema
-}
-
-function extractParams(
-  params: any[],
-  location: 'path' | 'query' | 'header'
-): ParsedParam[] {
-  return params
-    .filter((p) => p.in === location)
-    .map((p) => ({
-      name: p.name,
-      required: p.required ?? location === 'path',
-      schema: (p.schema ?? paramToSchema(p)) as OpenAPISchema,
-      description: p.description,
-      example: p.example,
-    }))
-}
-
-function extractRequestBody(op: any): OpenAPISchema | undefined {
-  // OpenAPI 3.x: op.requestBody.content['application/json'].schema
-  const body = op.requestBody
-  if (body) {
-    const content = body.content
-    if (content) {
-      const jsonContent = content['application/json']
-      if (jsonContent?.schema) return jsonContent.schema as OpenAPISchema
-
-      const firstKey = Object.keys(content)[0]
-      if (firstKey && content[firstKey]?.schema) {
-        return content[firstKey].schema as OpenAPISchema
-      }
-    }
-  }
-
-  // Swagger 2.x: parameters[].in === 'body' → schema
-  if (op.parameters) {
-    const bodyParam = op.parameters.find((p: any) => p.in === 'body')
-    if (bodyParam?.schema) return bodyParam.schema as OpenAPISchema
-  }
-
-  return undefined
-}
-
-function extractResponseDescription(op: any): string | undefined {
-  const responses = op.responses
-  if (!responses) return undefined
-  for (const code of ['200', '201', '202']) {
-    const resp = responses[code]
-    if (resp?.description) return resp.description
-  }
-  return undefined
-}
-
-function extractResponseSchema(op: any): OpenAPISchema | undefined {
-  const responses = op.responses
-  if (!responses) return undefined
-
-  // Look for 2xx responses in order of preference
-  for (const code of ['200', '201', '202', '204']) {
-    const resp = responses[code]
-    if (!resp) continue
-
-    // OpenAPI 3.x: resp.content['application/json'].schema
-    const content = resp.content
-    if (content) {
-      const jsonContent = content['application/json']
-      if (jsonContent?.schema) return jsonContent.schema as OpenAPISchema
-
-      const firstKey = Object.keys(content)[0]
-      if (firstKey && content[firstKey]?.schema) {
-        return content[firstKey].schema as OpenAPISchema
-      }
-    }
-
-    // Swagger 2.x: resp.schema directly
-    if (resp.schema) return resp.schema as OpenAPISchema
-  }
-
-  // Fallback: any 2xx
-  for (const [code, resp] of Object.entries(responses) as [string, any][]) {
-    if (!code.startsWith('2')) continue
-    if (resp.content) {
-      const jsonContent = resp.content['application/json']
-      if (jsonContent?.schema) return jsonContent.schema as OpenAPISchema
-    }
-    if (resp.schema) return resp.schema as OpenAPISchema
-  }
-
-  return undefined
-}
-
-function extractErrorResponses(op: any): ErrorResponse[] {
-  const responses = op.responses
-  if (!responses) return []
-
-  const errors: ErrorResponse[] = []
-  for (const [code, resp] of Object.entries(responses) as [string, any][]) {
-    const statusCode = parseInt(code, 10)
-    if (isNaN(statusCode)) continue
-    if (statusCode >= 400) {
-      errors.push({
-        statusCode,
-        description: resp.description ?? `Error ${statusCode}`,
-      })
-    }
-  }
-  return errors
-}
-
-function extractSecuritySchemes(doc: any): Record<string, SecuritySchemeInfo> {
-  const raw = doc.components?.securitySchemes ?? doc.securityDefinitions ?? {}
-  const result: Record<string, SecuritySchemeInfo> = {}
-
-  for (const [name, scheme] of Object.entries(raw) as [string, any][]) {
-    const info: SecuritySchemeInfo = {
-      type: scheme.type === 'http' ? 'http' : scheme.type,
-    }
-
-    if (scheme.type === 'http') {
-      info.scheme = scheme.scheme
-      info.bearerFormat = scheme.bearerFormat
-    }
-
-    if (scheme.type === 'apiKey') {
-      info.name = scheme.name
-      info.in = scheme.in
-    }
-
-    if (scheme.type === 'oauth2') {
-      // Extract flows — prefer authorizationCode, then implicit, then clientCredentials
-      const flows = scheme.flows ?? {}
-      const flow =
-        flows.authorizationCode ??
-        flows.implicit ??
-        flows.clientCredentials ??
-        flows.password
-
-      if (flow) {
-        info.flows = {
-          authorizationUrl: flow.authorizationUrl,
-          tokenUrl: flow.tokenUrl,
-          scopes: flow.scopes,
-        }
-      }
-    }
-
-    result[name] = info
-  }
-
-  return result
-}
-
-/**
- * Compute a SHA-256 hash of the contract-relevant parts of a parsed spec.
- * Excludes presentation fields (summary, description, tags, operationId)
- * so that only structural API changes produce a different hash.
- */
-export function computeContractHash(spec: ParsedSpec): string {
-  const contract = {
-    operations: spec.operations.map((op) => ({
-      method: op.method,
-      path: op.path,
-      pathParams: op.pathParams.map((p) => ({
-        name: p.name,
-        required: p.required,
-        schema: p.schema,
-      })),
-      queryParams: op.queryParams.map((p) => ({
-        name: p.name,
-        required: p.required,
-        schema: p.schema,
-      })),
-      headerParams: op.headerParams.map((p) => ({
-        name: p.name,
-        required: p.required,
-        schema: p.schema,
-      })),
-      requestBody: op.requestBody,
-      requestBodyRequired: op.requestBodyRequired,
-      responseSchema: op.responseSchema,
-      errorResponses: op.errorResponses,
-    })),
-    componentSchemas: spec.componentSchemas,
-    securitySchemes: spec.securitySchemes,
-    serverUrls: spec.serverUrls,
-  }
-
-  // Use a cycle-safe JSON serializer since resolved $ref schemas
-  // can contain circular object references
-  const seen = new WeakSet()
-  const json = JSON.stringify(contract, (_key, value) => {
-    if (typeof value === 'object' && value !== null) {
-      if (seen.has(value)) return '[Circular]'
-      seen.add(value)
-    }
-    return value
-  })
-
-  return createHash('sha256').update(json).digest('hex').slice(0, 16)
-}
-
-function extractTagDescriptions(doc: any): Record<string, string> {
-  const result: Record<string, string> = {}
-  if (Array.isArray(doc.tags)) {
-    for (const tag of doc.tags) {
-      if (tag.name && tag.description) {
-        result[tag.name] = tag.description
-      }
-    }
-  }
-  return result
-}

package/src/zod-codegen.ts

@@ -1,9 +0,0 @@
-export {
-  type OpenAPISchema,
-  type ZodCodegenContext,
-  createContext,
-  schemaToZod,
-  schemaVarName,
-  sanitizeTypeName,
-  snakeToCamel,
-} from './openapi-to-zod-schema.js'

package/tsconfig.json

@@ -1,12 +0,0 @@
-{
-  "extends": "../tsconfig.json",
-  "compilerOptions": {
-    "rootDir": "./src",
-    "module": "Node18",
-    "outDir": "dist",
-    "target": "esnext",
-    "declaration": true
-  },
-  "include": ["src/**/*.ts"],
-  "exclude": ["**/*.test.ts", "node_modules"]
-}

package/tsconfig.tsbuildinfo

@@ -1 +0,0 @@
-{"root":["./src/auth-config.ts","./src/codegen.ts","./src/index.ts","./src/naming.ts","./src/openapi-to-zod-schema.ts","./src/parse-openapi.ts","./src/zod-codegen.ts"],"version":"6.0.3"}