@kubb/adapter-oas 5.8.0 → 5.8.2

package/OVERVIEW.md

@@ -0,0 +1,29 @@
+# OpenAPI adapter
+
+The OpenAPI adapter reads an OpenAPI 2.0, 3.0, or 3.1 document and converts every schema and operation into Kubb's AST. Every plugin in the build generates from that AST, so one adapter feeds them all.
+
+Kubb uses `adapterOas()` by default. Set it on `defineConfig.adapter` only to change its options. The options apply to every plugin in the build.
+
+```ts
+import { defineConfig } from 'kubb/config'
+import { adapterOas } from '@kubb/adapter-oas'
+import { pluginTs } from '@kubb/plugin-ts'
+
+export default defineConfig({
+  input: './petStore.yaml',
+  output: { path: './src/gen' },
+  adapter: adapterOas({ dateType: 'date', integerType: 'number' }),
+  plugins: [pluginTs()],
+})
+```
+
+## Options worth knowing
+
+- `validate` checks the spec before parsing and reports each problem as a warning. Turn it off to speed up a large spec. Run `kubb validate` to list every error.
+- `dateType` sets how `date-time`, `date`, and `time` schemas are represented: ISO strings (the default), strings with or without a timezone offset, or JavaScript `Date` objects. Pass an object to set each format on its own.
+- `integerType` defaults to `'bigint'`, which is exact for 64-bit IDs but does not survive `JSON.stringify`. Choose `'number'` for most JSON APIs.
+- `unknownType` and `emptySchemaType` set the type for schemas Kubb cannot infer and for empty schemas (`{}`).
+- `discriminator: 'propagate'` writes the discriminator's literal value into each child schema, so each branch is typed precisely.
+- `enums: 'root'` lifts inline enums to reusable top-level schemas, named with `enumSuffix` (`PetStatusEnum`).
+- `server` picks the entry in the spec's `servers` array that becomes the base URL and fills in its variables. It does not change where a generated client sends requests. Use the client plugin's own `baseURL` for that.
+- `contentType` picks the media type when an operation defines several. Without it, Kubb uses the first JSON media type.

package/dist/index.cjs

@@ -5,6 +5,15 @@ let node_fs_promises = require("node:fs/promises");
 let yaml = require("yaml");
 let _scalar_openapi_upgrader = require("@scalar/openapi-upgrader");
 let api_ref_bundler = require("api-ref-bundler");
+//#region kubb-extension.json
+var compatibility = {
+	"kubb": ">=5.8.0",
+	"node": ">=22"
+};
+//#endregion
+//#region package.json
+var version = "5.8.2";
+//#endregion
 //#region src/constants.ts
 /**
 * Default parser options applied when no explicit options are provided.
@@ -2346,131 +2355,133 @@ const adapterOasName = "oas";
 * })
 * ```
 */
-const adapterOas = (0, _kubb_kit.createAdapter)((options) => {
-	const { validate = true, contentType, server, discriminator = "preserve", enums = "inline", dateType = DEFAULT_PARSER_OPTIONS.dateType, integerType = DEFAULT_PARSER_OPTIONS.integerType, unknownType = DEFAULT_PARSER_OPTIONS.unknownType, enumSuffix = DEFAULT_PARSER_OPTIONS.enumSuffix, emptySchemaType = unknownType || DEFAULT_PARSER_OPTIONS.emptySchemaType } = options;
-	const parserOptions = {
-		dateType,
-		integerType,
-		unknownType,
-		emptySchemaType,
-		enumSuffix
-	};
-	const resolvedOptions = {
+const adapterOas = (0, _kubb_kit.defineExtension)({
+	kind: "adapter",
+	meta: {
+		name: "oas",
+		version,
+		compatibility
+	},
+	setup: ({ validate = true, contentType, server, discriminator = "preserve", enums = "inline", dateType = DEFAULT_PARSER_OPTIONS.dateType, integerType = DEFAULT_PARSER_OPTIONS.integerType, unknownType = DEFAULT_PARSER_OPTIONS.unknownType, enumSuffix = DEFAULT_PARSER_OPTIONS.enumSuffix, emptySchemaType = unknownType || DEFAULT_PARSER_OPTIONS.emptySchemaType }) => ({
 		validate,
 		contentType,
 		server,
 		discriminator,
 		enums,
-		...parserOptions
-	};
-	let parsedDocument = null;
-	const inputCache = /* @__PURE__ */ new WeakMap();
-	function parseInput({ document, refs, schemas, parser }) {
-		const { parseSchema } = parser;
-		const parsedByName = /* @__PURE__ */ new Map();
-		const refAliasMap = /* @__PURE__ */ new Map();
-		const enumNames = [];
-		const discriminatorParentNodes = [];
-		const refGraph = /* @__PURE__ */ new Map();
-		for (const [name, schema] of Object.entries(schemas)) {
-			const node = parseSchema({
-				schema,
-				name
-			});
-			parsedByName.set(name, node);
-			const refs = scanSchema({
-				node,
-				name
+		dateType,
+		integerType,
+		unknownType,
+		emptySchemaType,
+		enumSuffix
+	}),
+	build({ validate, contentType, server, discriminator, enums, ...parserOptions }) {
+		let parsedDocument = null;
+		const inputCache = /* @__PURE__ */ new WeakMap();
+		function parseInput({ document, refs, schemas, parser }) {
+			const { parseSchema } = parser;
+			const parsedByName = /* @__PURE__ */ new Map();
+			const refAliasMap = /* @__PURE__ */ new Map();
+			const enumNames = [];
+			const discriminatorParentNodes = [];
+			const refGraph = /* @__PURE__ */ new Map();
+			for (const [name, schema] of Object.entries(schemas)) {
+				const node = parseSchema({
+					schema,
+					name
+				});
+				parsedByName.set(name, node);
+				const refs = scanSchema({
+					node,
+					name
+				});
+				if (node.name) refGraph.set(node.name, refs);
+				if (node.type === "ref" && node.name && node.name !== name) refAliasMap.set(name, node);
+				if (_kubb_kit.ast.narrowSchema(node, "enum") && node.name) enumNames.push(node.name);
+				if (discriminator === "propagate" && (schema.oneOf ?? schema.anyOf) && schema.discriminator?.propertyName) discriminatorParentNodes.push(node);
+			}
+			const circularNames = [..._kubb_kit.ast.findCircularSchemasFromGraph(refGraph)];
+			const discriminatorChildMap = discriminatorParentNodes.length > 0 ? buildDiscriminatorChildMap(discriminatorParentNodes) : null;
+			const operationNodes = getOperations(document, refs).map((operation) => parseOperation({
+				operation,
+				refs,
+				contentType,
+				options: parserOptions,
+				parseSchema
+			}));
+			const promotedEnums = enums === "root" ? collectInlineEnums([...parsedByName.values(), ...operationNodes], new Set(Object.keys(schemas))) : null;
+			if (promotedEnums) for (const name of promotedEnums.keys()) enumNames.push(name);
+			const schemaNodes = promotedEnums ? [...promotedEnums.values()] : [];
+			for (const name of Object.keys(schemas)) {
+				const aliasTarget = refAliasMap.get(name)?.name;
+				const aliased = aliasTarget ? parsedByName.get(aliasTarget) : void 0;
+				const parsed = parsedByName.get(name);
+				const child = discriminatorChildMap?.get(name);
+				const base = child ? patchDiscriminatorNode(parsed, child) : parsed;
+				const node = aliased ? {
+					...aliased,
+					name
+				} : base;
+				schemaNodes.push(promotedEnums ? refPromotedEnums(node, promotedEnums) : node);
+			}
+			const operations = promotedEnums ? operationNodes.map((node) => refPromotedEnums(node, promotedEnums)) : operationNodes;
+			return _kubb_kit.ast.factory.createInput({
+				schemas: schemaNodes,
+				operations,
+				meta: {
+					title: document.info?.title,
+					description: document.info?.description,
+					version: document.info?.version,
+					baseURL: resolveBaseUrl({
+						document,
+						server
+					}),
+					circularNames,
+					enumNames
+				}
 			});
-			if (node.name) refGraph.set(node.name, refs);
-			if (node.type === "ref" && node.name && node.name !== name) refAliasMap.set(name, node);
-			if (_kubb_kit.ast.narrowSchema(node, "enum") && node.name) enumNames.push(node.name);
-			if (discriminator === "propagate" && (schema.oneOf ?? schema.anyOf) && schema.discriminator?.propertyName) discriminatorParentNodes.push(node);
-		}
-		const circularNames = [..._kubb_kit.ast.findCircularSchemasFromGraph(refGraph)];
-		const discriminatorChildMap = discriminatorParentNodes.length > 0 ? buildDiscriminatorChildMap(discriminatorParentNodes) : null;
-		const operationNodes = getOperations(document, refs).map((operation) => parseOperation({
-			operation,
-			refs,
-			contentType,
-			options: parserOptions,
-			parseSchema
-		}));
-		const promotedEnums = enums === "root" ? collectInlineEnums([...parsedByName.values(), ...operationNodes], new Set(Object.keys(schemas))) : null;
-		if (promotedEnums) for (const name of promotedEnums.keys()) enumNames.push(name);
-		const schemaNodes = promotedEnums ? [...promotedEnums.values()] : [];
-		for (const name of Object.keys(schemas)) {
-			const aliasTarget = refAliasMap.get(name)?.name;
-			const aliased = aliasTarget ? parsedByName.get(aliasTarget) : void 0;
-			const parsed = parsedByName.get(name);
-			const child = discriminatorChildMap?.get(name);
-			const base = child ? patchDiscriminatorNode(parsed, child) : parsed;
-			const node = aliased ? {
-				...aliased,
-				name
-			} : base;
-			schemaNodes.push(promotedEnums ? refPromotedEnums(node, promotedEnums) : node);
 		}
-		const operations = promotedEnums ? operationNodes.map((node) => refPromotedEnums(node, promotedEnums)) : operationNodes;
-		return _kubb_kit.ast.factory.createInput({
-			schemas: schemaNodes,
-			operations,
-			meta: {
-				title: document.info?.title,
-				description: document.info?.description,
-				version: document.info?.version,
-				baseURL: resolveBaseUrl({
-					document,
-					server
-				}),
-				circularNames,
-				enumNames
-			}
-		});
-	}
-	return {
-		name: "oas",
-		options: resolvedOptions,
-		get document() {
-			return parsedDocument;
-		},
-		async validate(input, options) {
-			await assertInputExists(input);
-			const document = await parseDocument(input);
-			assertDocument(document);
-			await validateDocument(document, options);
-		},
-		async parse(source, { signal } = {}) {
-			signal?.throwIfAborted();
-			const cached = inputCache.get(source);
-			if (cached) return cached;
-			const promise = (async () => {
-				const document = await parseFromConfig(source);
-				signal?.throwIfAborted();
+		return {
+			get document() {
+				return parsedDocument;
+			},
+			async validate(input, options) {
+				await assertInputExists(input);
+				const document = await parseDocument(input);
 				assertDocument(document);
-				if (validate) await validateDocument(document);
-				parsedDocument = document;
-				const refs = createRefs(document);
-				const { schemas, renames } = getSchemas(document, { contentType }, refs);
-				return parseInput({
-					document,
-					refs,
-					schemas,
-					parser: createSchemaParser({
+				await validateDocument(document, options);
+			},
+			async parse(source, { signal } = {}) {
+				signal?.throwIfAborted();
+				const cached = inputCache.get(source);
+				if (cached) return cached;
+				const promise = (async () => {
+					const document = await parseFromConfig(source);
+					signal?.throwIfAborted();
+					assertDocument(document);
+					if (validate) await validateDocument(document);
+					parsedDocument = document;
+					const refs = createRefs(document);
+					const { schemas, renames } = getSchemas(document, { contentType }, refs);
+					return parseInput({
 						document,
 						refs,
-						renames,
-						options: parserOptions
-					})
+						schemas,
+						parser: createSchemaParser({
+							document,
+							refs,
+							renames,
+							options: parserOptions
+						})
+					});
+				})();
+				inputCache.set(source, promise);
+				return promise.catch((error) => {
+					if (signal?.aborted) inputCache.delete(source);
+					throw error;
 				});
-			})();
-			inputCache.set(source, promise);
-			return promise.catch((error) => {
-				if (signal?.aborted) inputCache.delete(source);
-				throw error;
-			});
-		}
-	};
+			}
+		};
+	}
 });
 //#endregion
 exports.adapterOas = adapterOas;