@kubb/oas 4.33.4 → 4.34.0

package/src/types.ts

@@ -19,20 +19,25 @@ export type { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'
 export type contentType = 'application/json' | (string & {})
 
 export type SchemaObject = OASSchemaObject & {
+  /**
+   * OAS 3.1 extension: allows marking a schema as nullable even when `type` does not include `'null'`.
+   */
   'x-nullable'?: boolean
+  /**
+   * OAS 3.1: constrains the schema to a single fixed value.
+   * Semantically equivalent to a one-item `enum`.
+   */
+  const?: string | number | boolean | null
+  /**
+   * OAS 3.1: specifies the media type of the schema content.
+   * When set to `'application/octet-stream'` on a `string` schema, the schema is treated as binary (`blob`).
+   */
+  contentMediaType?: string
   $ref?: string
 }
 
-export const HttpMethods = {
-  GET: 'get',
-  POST: 'post',
-  PUT: 'put',
-  PATCH: 'patch',
-  DELETE: 'delete',
-  HEAD: 'head',
-  OPTIONS: 'options',
-  TRACE: 'trace',
-} satisfies Record<Uppercase<OASHttpMethods>, OASHttpMethods>
+/** Re-exported from `constants.ts` for backwards compatibility. */
+export { httpMethods as HttpMethods } from './constants.ts'
 
 export type HttpMethod = OASHttpMethods
 

package/src/utils.ts

@@ -3,34 +3,49 @@ import { pascalCase, URLPath } from '@internals/utils'
 import type { Config } from '@kubb/core'
 import { bundle, loadConfig } from '@redocly/openapi-core'
 import yaml from '@stoplight/yaml'
-import type { ParameterObject, SchemaObject } from 'oas/types'
+import type { ParameterObject } from 'oas/types'
 import { isRef, isSchema } from 'oas/types'
 import OASNormalize from 'oas-normalize'
 import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'
 import { isPlainObject, mergeDeep } from 'remeda'
 import swagger2openapi from 'swagger2openapi'
+import { STRUCTURAL_KEYS } from './constants.ts'
 import { Oas } from './Oas.ts'
-import type { contentType, Document } from './types.ts'
+import type { contentType, Document, SchemaObject } from './types.ts'
 
-export const STRUCTURAL_KEYS = new Set(['properties', 'items', 'additionalProperties', 'oneOf', 'anyOf', 'allOf', 'not'])
-
-export function isOpenApiV2Document(doc: any): doc is OpenAPIV2.Document {
-  return doc && isPlainObject(doc) && !('openapi' in doc)
+/**
+ * Returns `true` when `doc` looks like a Swagger 2.0 document (no `openapi` key).
+ */
+export function isOpenApiV2Document(doc: unknown): doc is OpenAPIV2.Document {
+  return !!doc && isPlainObject(doc) && !('openapi' in doc)
 }
-export function isOpenApiV3Document(doc: any): doc is OpenAPIV3.Document {
-  return doc && isPlainObject(doc) && 'openapi' in doc
+
+/**
+ * Returns `true` when `doc` looks like an OpenAPI 3.x document (has `openapi` key).
+ */
+export function isOpenApiV3Document(doc: unknown): doc is OpenAPIV3.Document {
+  return !!doc && isPlainObject(doc) && 'openapi' in doc
 }
 
-export function isOpenApiV3_1Document(doc: any): doc is OpenAPIV3_1.Document {
-  return doc && isPlainObject<OpenAPIV3_1.Document>(doc) && 'openapi' in doc && doc.openapi.startsWith('3.1')
+/**
+ * Returns `true` when `doc` is an OpenAPI 3.1 document.
+ */
+export function isOpenApiV3_1Document(doc: unknown): doc is OpenAPIV3_1.Document {
+  return !!doc && isPlainObject(doc) && 'openapi' in (doc as object) && (doc as { openapi: string }).openapi.startsWith('3.1')
 }
 
+/**
+ * Returns `true` when `obj` is a JSON Schema object recognized by the `oas` library.
+ */
 export function isJSONSchema(obj?: unknown): obj is SchemaObject {
   return !!obj && isSchema(obj)
 }
 
+/**
+ * Returns `true` when `obj` is a parameter object (has an `in` field distinguishing it from a schema).
+ */
 export function isParameterObject(obj: ParameterObject | SchemaObject): obj is ParameterObject {
-  return obj && 'in' in obj
+  return !!obj && 'in' in obj
 }
 
 /**
@@ -56,17 +71,19 @@ export function isNullable(schema?: SchemaObject & { 'x-nullable'?: boolean }):
 }
 
 /**
- * Determines if the given object is an OpenAPI ReferenceObject.
+ * Returns `true` when `obj` is an OpenAPI `$ref` pointer object.
  */
-export function isReference(obj?: any): obj is OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject {
-  return !!obj && isRef(obj)
+export function isReference(obj?: unknown): obj is OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject {
+  return !!obj && isRef(obj as object)
 }
 
 /**
- * Determines if the given object is a SchemaObject with a discriminator property of type DiscriminatorObject.
+ * Returns `true` when `obj` is a schema that carries a structured `discriminator` object
+ * (as opposed to a plain string discriminator used in some older specs).
  */
-export function isDiscriminator(obj?: any): obj is SchemaObject & { discriminator: OpenAPIV3.DiscriminatorObject } {
-  return !!obj && obj?.['discriminator'] && typeof obj.discriminator !== 'string'
+export function isDiscriminator(obj?: unknown): obj is SchemaObject & { discriminator: OpenAPIV3.DiscriminatorObject } {
+  const record = obj as Record<string, unknown>
+  return !!obj && !!record['discriminator'] && typeof record['discriminator'] !== 'string'
 }
 
 /**

package/dist/chunk-OuPHjz6n.js

@@ -1,41 +0,0 @@
-import { createRequire } from "node:module";
-//#region \0rolldown/runtime.js
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", {
-	value,
-	configurable: true
-});
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __esmMin = (fn, res) => () => (fn && (res = fn(fn = 0)), res);
-var __commonJSMin = (cb, mod) => () => (mod || cb((mod = { exports: {} }).exports, mod), mod.exports);
-var __exportAll = (all, no_symbols) => {
-	let target = {};
-	for (var name in all) __defProp(target, name, {
-		get: all[name],
-		enumerable: true
-	});
-	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
-	return target;
-};
-var __copyProps = (to, from, except, desc) => {
-	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
-		key = keys[i];
-		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
-			get: ((k) => from[k]).bind(null, key),
-			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
-		});
-	}
-	return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
-	value: mod,
-	enumerable: true
-}) : target, mod));
-var __toCommonJS = (mod) => __hasOwnProp.call(mod, "module.exports") ? mod["module.exports"] : __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var __require = /* @__PURE__ */ createRequire(import.meta.url);
-//#endregion
-export { __require as a, __name as i, __esmMin as n, __toCommonJS as o, __exportAll as r, __toESM as s, __commonJSMin as t };