@kubb/adapter-oas 4.33.4 → 4.35.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/adapter-oas",
-  "version": "4.33.4",
+  "version": "4.35.0",
   "description": "OpenAPI / Swagger adapter for Kubb — converts OAS input into a @kubb/ast RootNode.",
   "keywords": [
     "openapi",
@@ -46,8 +46,8 @@
     "openapi-types": "^12.1.3",
     "remeda": "^2.33.6",
     "swagger2openapi": "^7.0.8",
-    "@kubb/ast": "4.34.0",
-    "@kubb/core": "4.34.0"
+    "@kubb/ast": "4.35.0",
+    "@kubb/core": "4.35.0"
   },
   "devDependencies": {
     "@types/swagger2openapi": "^7.0.4",

package/src/adapter.ts

@@ -2,7 +2,6 @@ import path from 'node:path'
 import { createRoot } from '@kubb/ast'
 import type { AdapterSource } from '@kubb/core'
 import { defineAdapter } from '@kubb/core'
-import { logAst } from './devtools.ts'
 import { resolveServerUrl } from './oas/resolveServerUrl.ts'
 import { parseFromConfig } from './oas/utils.ts'
 import { createOasParser } from './parser.ts'
@@ -41,7 +40,6 @@ export const adapterOas = defineAdapter<OasAdapter>((options) => {
     integerType = 'number',
     unknownType = 'any',
     emptySchemaType = unknownType,
-    devtools,
   } = options
 
   return {
@@ -58,7 +56,6 @@ export const adapterOas = defineAdapter<OasAdapter>((options) => {
       integerType,
       unknownType,
       emptySchemaType,
-      devtools,
     },
     async parse(source) {
       const fakeConfig = sourceToFakeConfig(source)
@@ -78,9 +75,9 @@ export const adapterOas = defineAdapter<OasAdapter>((options) => {
       const baseURL = server?.url ? resolveServerUrl(server, serverVariables) : undefined
 
       const parser = createOasParser(oas, { contentType, collisionDetection })
-      const root = parser.buildAst({ dateType, integerType, unknownType, emptySchemaType })
+      const root = parser.parse({ dateType, integerType, unknownType, emptySchemaType })
 
-      const rootNode = createRoot({
+      return createRoot({
         ...root,
         meta: {
           title: oas.api.info?.title,
@@ -88,12 +85,6 @@ export const adapterOas = defineAdapter<OasAdapter>((options) => {
           baseURL,
         },
       })
-
-      if (devtools) {
-        logAst(rootNode, devtools === true ? {} : devtools)
-      }
-
-      return rootNode
     },
   }
 })

package/src/index.ts

@@ -1,2 +1 @@
 export { adapterOas, adapterOasName } from './adapter.ts'
-export { logAst } from './devtools.ts'

package/src/parser.ts

@@ -231,7 +231,7 @@ export type OasParser = {
    * Converts an OpenAPI/Swagger spec (wrapped in a Kubb `Oas` instance) into
    * a `RootNode` — the top-level node of the `@kubb/ast` tree.
    */
-  buildAst: <TOptions extends Partial<Options> = object>(options?: TOptions) => RootNode
+  parse: <TOptions extends Partial<Options> = object>(options?: TOptions) => RootNode
   convertSchema: <TFormat extends string, TSchema extends SchemaObject & { format?: TFormat }, TOptions extends Partial<Options> = object>(
     params: { schema: TSchema; name?: string },
     options?: TOptions,
@@ -290,7 +290,7 @@ function applyDiscriminatorEnum(schema: SchemaObject): SchemaObject {
  * Creates an OAS parser that converts an OpenAPI/Swagger spec into
  * the `@kubb/ast` tree.
  *
- * Options are passed per-call to `buildAst` or `convertSchema` rather than
+ * Options are passed per-call to `parse` or `convertSchema` rather than
  * at construction time, keeping the factory lightweight.
  *
  * This is the **kubb-parser** stage of the compilation lifecycle:
@@ -302,7 +302,7 @@ function applyDiscriminatorEnum(schema: SchemaObject): SchemaObject {
  * @example
  * ```ts
  * const parser = createOasParser(oas)
- * const root = parser.buildAst({ emptySchemaType: 'unknown' })
+ * const root = parser.parse({ emptySchemaType: 'unknown' })
  * ```
  */
 export function createOasParser(oas: Oas, { contentType, collisionDetection }: OasParserOptions = {}): OasParser {
@@ -1052,7 +1052,7 @@ export function createOasParser(oas: Oas, { contentType, collisionDetection }: O
    * Converts an OpenAPI/Swagger spec (wrapped in a Kubb `Oas` instance) into
    * a `RootNode` — the top-level node of the `@kubb/ast` tree.
    */
-  function buildAst<TOptions extends Partial<Options> = object>(options?: TOptions): RootNode {
+  function parse<TOptions extends Partial<Options> = object>(options?: TOptions): RootNode {
     const mergedOptions: Options = { ...DEFAULT_OPTIONS, ...options }
 
     const schemas: Array<SchemaNode> = Object.entries(schemaObjects).map(([name, schemaObject]) =>
@@ -1128,7 +1128,7 @@ export function createOasParser(oas: Oas, { contentType, collisionDetection }: O
   }
 
   return {
-    buildAst,
+    parse: parse,
     convertSchema,
     resolveRefs,
     getImports,

package/src/types.ts

@@ -1,5 +1,4 @@
 import type { AdapterFactoryOptions } from '@kubb/core'
-import type { DevtoolsOptions } from './devtools.ts'
 import type { Oas as OasClass } from './oas/Oas.ts'
 import type { contentType } from './oas/types.ts'
 
@@ -69,15 +68,6 @@ export type OasAdapterOptions = {
    * @default `unknownType`
    */
   emptySchemaType?: 'any' | 'unknown' | 'void'
-  /**
-   * Enable visual AST inspection via Kubb Studio.
-   *
-   * - `true` — opens `https://studio.kubb.dev/ast?root=<encoded>` after every `parse()`.
-   * - `{ studioUrl }` — same, with a custom Studio URL (e.g. your self-hosted instance).
-   *
-   * Logs the URL to the console so you can click/open it during development or CI.
-   */
-  devtools?: boolean | DevtoolsOptions
 }
 
 export type OasAdapterResolvedOptions = {
@@ -92,7 +82,6 @@ export type OasAdapterResolvedOptions = {
   integerType: NonNullable<OasAdapterOptions['integerType']>
   unknownType: NonNullable<OasAdapterOptions['unknownType']>
   emptySchemaType: NonNullable<OasAdapterOptions['emptySchemaType']>
-  devtools: OasAdapterOptions['devtools']
 }
 
 export type OasAdapter = AdapterFactoryOptions<'oas', OasAdapterOptions, OasAdapterResolvedOptions>

package/src/devtools.ts

@@ -1,60 +0,0 @@
-import type { RootNode } from '@kubb/ast/types'
-import { deflateSync, inflateSync } from 'fflate'
-
-/**
- * Default Kubb Studio base URL used when no `studioUrl` override is provided.
- */
-export const DEFAULT_STUDIO_URL = 'https://studio.kubb.dev'
-
-export type DevtoolsOptions = {
-  /**
-   * Override the Kubb Studio base URL.
-   * @default 'https://studio.kubb.dev'
-   */
-  studioUrl?: string
-}
-
-/**
- * Encodes a `RootNode` as a compressed, URL-safe string.
- *
- * The JSON representation is deflate-compressed with {@link deflateSync} before
- * base64url encoding, which typically reduces payload size by 70–80 % and
- * keeps URLs well within browser and server path-length limits.
- *
- * Use {@link decodeAst} to reverse.
- */
-export function encodeAst(root: RootNode): string {
-  const compressed = deflateSync(new TextEncoder().encode(JSON.stringify(root)))
-  return Buffer.from(compressed).toString('base64url')
-}
-
-/**
- * Decodes a `RootNode` from a string produced by {@link encodeAst}.
- *
- * Works in both Node.js and the browser — no streaming APIs required.
- */
-export function decodeAst(encoded: string): RootNode {
-  const bytes = Buffer.from(encoded, 'base64url')
-  return JSON.parse(new TextDecoder().decode(inflateSync(bytes))) as RootNode
-}
-
-/**
- * Constructs the Kubb Studio URL for visual AST inspection.
- * The `root` is encoded and attached as the `?root=` query parameter so Studio
- * can decode and render it without a round-trip to any server.
- */
-export function getAstUrl(root: RootNode, options: DevtoolsOptions = {}): string {
-  const baseUrl = (options.studioUrl ?? DEFAULT_STUDIO_URL).replace(/\/$/, '')
-  return `${baseUrl}/ast?root=${encodeAst(root)}`
-}
-
-/**
- * Prints the Kubb Studio URL for the given `RootNode` — inspired by
- * [testing-playground](https://testing-playground.com/).
- *
- * Drop this call next to an assertion during development or in a failing test
- * to get an instantly-clickable link for visual debugging.
- */
-export function logAst(root: RootNode, options: DevtoolsOptions = {}): void {
-  console.log(`\n  ${getAstUrl(root, options)}\n`)
-}