@kubb/oas 4.5.1 → 4.5.2

package/dist/infer.cjs

@@ -0,0 +1 @@
+const require_index = require('./index.cjs');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/oas",
-  "version": "4.5.1",
+  "version": "4.5.2",
   "description": "OpenAPI Specification (OAS) utilities and helpers for Kubb, providing parsing, normalization, and manipulation of OpenAPI/Swagger schemas.",
   "keywords": [
     "openapi",
@@ -56,7 +56,7 @@
     }
   ],
   "dependencies": {
-    "@redocly/openapi-core": "^2.10.0",
+    "@redocly/openapi-core": "^2.11.0",
     "hotscript": "^1.0.13",
     "json-schema-to-ts": "^3.1.1",
     "jsonpointer": "^5.0.1",

package/src/index.ts

@@ -2,4 +2,15 @@ export { findSchemaDefinition, matchesMimeType } from 'oas/utils'
 export type { Infer, Model, RequestParams, Response } from './infer/index.ts'
 export { Oas } from './Oas.ts'
 export * from './types.ts'
-export { isDiscriminator, isNullable, isOpenApiV3_1Document, isOptional, isParameterObject, isReference, isRequired, merge, parse } from './utils.ts'
+export {
+  isDiscriminator,
+  isNullable,
+  isOpenApiV3_1Document,
+  isOptional,
+  isParameterObject,
+  isReference,
+  isRequired,
+  merge,
+  parse,
+  parseFromConfig,
+} from './utils.ts'

package/src/utils.spec.ts

@@ -1,4 +1,7 @@
-import { merge, parse } from './utils.ts'
+import path from 'node:path'
+import type { Config } from '@kubb/core'
+import yaml from '@stoplight/yaml'
+import { merge, parse, parseFromConfig } from './utils.ts'
 
 describe('utils', () => {
   test('merge of 2 oas documents', async () => {
@@ -63,3 +66,117 @@ components:
     expect(oas.api?.info.title).toBe('Swagger Petstore')
   })
 })
+
+describe('parseFromConfig', () => {
+  const petStoreV3 = path.resolve(__dirname, '../mocks/petStore.yaml')
+  const petStoreV2 = path.resolve(__dirname, '../mocks/petStoreV2.json')
+
+  const yamlPetStoreString = `
+openapi: 3.0.0
+info:
+  title: Swagger Petstore
+  version: 1.0.0
+paths:
+  /users/{userId}:
+    get:
+      tags:
+        - Users
+      summary: Get public user details
+      operationId: getUser
+      parameters:
+        - $ref: "#/components/parameters/userId"
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    example: User details retrieved successfully
+                  user:
+                    type: object
+                    properties:
+                      userId:
+                        type: string
+                        example: 1234343434343
+components:
+  parameters:
+    userId:
+      name: userId
+      in: path
+      description: Executes the action in the context of the specified user.
+      required: true
+      schema:
+        type: string
+        example: 1234343434343
+  `
+
+  const petStoreObject = yaml.parse(yamlPetStoreString)
+
+  test('check if oas and title is defined based on a Swagger(v3) file', async () => {
+    const oas = await parse(petStoreV3)
+
+    expect(oas).toBeDefined()
+    expect(oas.api?.info.title).toBe('Swagger Petstore - OpenAPI 3.0')
+  })
+
+  test('check if oas and title is defined based on a Swagger(v2) file', async () => {
+    const oas = await parse(petStoreV2)
+
+    expect(oas).toBeDefined()
+    expect(oas.api?.info.title).toBe('Swagger Petstore')
+  })
+
+  test('check if oas and title is defined based on a Swagger(v3) JSON import', async () => {
+    const data = await import(petStoreV2)
+
+    const oas = await parseFromConfig({
+      root: process.cwd(),
+      input: {
+        data,
+      },
+    } as Config)
+
+    expect(oas).toBeDefined()
+    expect(oas.api?.info.title).toBe('Swagger Petstore')
+  })
+
+  test('check if oas and title is defined based on a Swagger(v3) JSON string', async () => {
+    const oas = await parseFromConfig({
+      root: process.cwd(),
+      input: {
+        data: JSON.stringify(petStoreObject),
+      },
+    } as Config)
+
+    expect(oas).toBeDefined()
+    expect(oas.api?.info.title).toBe('Swagger Petstore')
+  })
+
+  test('check if oas and title is defined based on a Swagger(v3) JSON object', async () => {
+    const oas = await parseFromConfig({
+      root: process.cwd(),
+      input: {
+        data: petStoreObject,
+      },
+    } as Config)
+
+    expect(oas).toBeDefined()
+    expect(oas.api?.info.title).toBe('Swagger Petstore')
+  })
+
+  test('check if oas and title is defined based on a Swagger(v3) YAML', async () => {
+    const oas = await parseFromConfig({
+      root: process.cwd(),
+      input: {
+        data: yamlPetStoreString,
+      },
+    } as Config)
+
+    expect(oas).toBeDefined()
+    expect(oas.api?.info.title).toBe('Swagger Petstore')
+  })
+})

package/src/utils.ts

@@ -1,3 +1,8 @@
+import path from 'node:path'
+import type { Config } from '@kubb/core'
+import { URLPath } from '@kubb/core/utils'
+import yaml from '@stoplight/yaml'
+import type * as OasTypes from 'oas/types'
 import type { OASDocument, ParameterObject, SchemaObject } from 'oas/types'
 import { isRef, isSchema } from 'oas/types'
 import OASNormalize from 'oas-normalize'
@@ -130,3 +135,34 @@ export async function merge(pathOrApi: Array<string | OASDocument>, { oasClass =
 
   return parse(merged, { oasClass })
 }
+
+export function parseFromConfig(config: Config, oasClass: typeof Oas = Oas): Promise<Oas> {
+  if ('data' in config.input) {
+    if (typeof config.input.data === 'object') {
+      const api: OasTypes.OASDocument = JSON.parse(JSON.stringify(config.input.data)) as OasTypes.OASDocument
+      return parse(api, { oasClass })
+    }
+
+    // data is a string - try YAML first, then fall back to passing to parse()
+    try {
+      const api: string = yaml.parse(config.input.data as string)
+      return parse(api, { oasClass })
+    } catch (_e) {
+      // YAML parse failed, let parse() handle it (supports JSON strings and more)
+      return parse(config.input.data as string, { oasClass })
+    }
+  }
+
+  if (Array.isArray(config.input)) {
+    return merge(
+      config.input.map((input) => path.resolve(config.root, input.path)),
+      { oasClass },
+    )
+  }
+
+  if (new URLPath(config.input.path).isURL) {
+    return parse(config.input.path, { oasClass })
+  }
+
+  return parse(path.resolve(config.root, config.input.path), { oasClass })
+}