@kubb/ast 5.15.4 → 5.16.0

package/dist/index.d.cts

@@ -788,7 +788,10 @@ type CreateSchemaOutput<T extends CreateSchemaInput> = SchemaNodeByType[T['type'
  */
 declare function createSchema<T extends CreateSchemaInput>(props: T): CreateSchemaOutput<T>;
 declare function createSchema(props: CreateSchemaInput): SchemaNode;
-type ParameterLocation = 'path' | 'query' | 'header' | 'cookie';
+/**
+ * Where a parameter is sent. `querystring` carries the whole query string as one value, serialized per `contentType`.
+ */
+type ParameterLocation = 'path' | 'query' | 'header' | 'cookie' | 'querystring';
 /**
  * Parameter serialization style, controlling how a parameter value is rendered into the request.
  */
@@ -814,7 +817,7 @@ type ParameterNode = BaseNode & {
    */
   name: string;
   /**
-   * Parameter location (`path`, `query`, `header`, or `cookie`).
+   * Parameter location (`path`, `query`, `header`, `cookie`, or `querystring`).
    */
   in: ParameterLocation;
   /**
@@ -908,9 +911,24 @@ type ContentNode = BaseNode & {
    */
   contentType: string;
   /**
-   * Body schema for this content type.
+   * Body schema for this content type. For a stream it is the same node as `stream.schema`.
    */
   schema?: SchemaNode;
+  /**
+   * Set when the content is a stream of items (an event stream, JSON Lines, a channel of messages) instead of one body.
+   */
+  stream?: {
+    /**
+     * Schema of one item, such as one event of `text/event-stream` or one line of JSON Lines.
+     */
+    schema?: SchemaNode;
+    /**
+     * What `schema` describes for an event stream.
+     * - `'event'` the parsed event with its `event`, `data`, `id` and `retry` fields
+     * - `'data'` only the `data` payload, which the client wraps in its own event type
+     */
+    shape?: 'event' | 'data';
+  };
   /**
    * Property keys to exclude from the generated type via `Omit<Type, Keys>`.
    * Set when a referenced schema has `readOnly`/`writeOnly` fields that should be omitted.
@@ -1045,9 +1063,10 @@ type ResponseInput = Pick<ResponseNode, 'statusCode'> & Partial<Omit<ResponseNod
 declare function createResponse(props: ResponseInput): ResponseNode;
 /**
  * HTTP method an operation responds to. `QUERY` is the safe, idempotent method with a request body
- * from RFC 10008, declared with the `query` field of an OpenAPI 3.2 path item.
+ * from RFC 10008, declared with the `query` field of an OpenAPI 3.2 path item. Any other name is a
+ * method the source declares outside this fixed set, in the capitalization it is sent with.
  */
-type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'TRACE' | 'QUERY';
+type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'TRACE' | 'QUERY' | (string & {});
 /**
  * Fields shared by every operation, regardless of transport.
  */
@@ -2129,7 +2148,7 @@ export declare function compareEnforce(a?: Enforce, b?: Enforce): number;
  */
 type Macro = Visitor & {
   /**
-   * Macro identifier used to tell macros apart, for example `'simplify-union'`.
+   * Macro identifier used to tell macros apart, for example `'dedupe-union'`.
    */
   name: string;
   /**

package/dist/index.d.ts

@@ -788,7 +788,10 @@ type CreateSchemaOutput<T extends CreateSchemaInput> = SchemaNodeByType[T['type'
  */
 declare function createSchema<T extends CreateSchemaInput>(props: T): CreateSchemaOutput<T>;
 declare function createSchema(props: CreateSchemaInput): SchemaNode;
-type ParameterLocation = 'path' | 'query' | 'header' | 'cookie';
+/**
+ * Where a parameter is sent. `querystring` carries the whole query string as one value, serialized per `contentType`.
+ */
+type ParameterLocation = 'path' | 'query' | 'header' | 'cookie' | 'querystring';
 /**
  * Parameter serialization style, controlling how a parameter value is rendered into the request.
  */
@@ -814,7 +817,7 @@ type ParameterNode = BaseNode & {
    */
   name: string;
   /**
-   * Parameter location (`path`, `query`, `header`, or `cookie`).
+   * Parameter location (`path`, `query`, `header`, `cookie`, or `querystring`).
    */
   in: ParameterLocation;
   /**
@@ -908,9 +911,24 @@ type ContentNode = BaseNode & {
    */
   contentType: string;
   /**
-   * Body schema for this content type.
+   * Body schema for this content type. For a stream it is the same node as `stream.schema`.
    */
   schema?: SchemaNode;
+  /**
+   * Set when the content is a stream of items (an event stream, JSON Lines, a channel of messages) instead of one body.
+   */
+  stream?: {
+    /**
+     * Schema of one item, such as one event of `text/event-stream` or one line of JSON Lines.
+     */
+    schema?: SchemaNode;
+    /**
+     * What `schema` describes for an event stream.
+     * - `'event'` the parsed event with its `event`, `data`, `id` and `retry` fields
+     * - `'data'` only the `data` payload, which the client wraps in its own event type
+     */
+    shape?: 'event' | 'data';
+  };
   /**
    * Property keys to exclude from the generated type via `Omit<Type, Keys>`.
    * Set when a referenced schema has `readOnly`/`writeOnly` fields that should be omitted.
@@ -1045,9 +1063,10 @@ type ResponseInput = Pick<ResponseNode, 'statusCode'> & Partial<Omit<ResponseNod
 declare function createResponse(props: ResponseInput): ResponseNode;
 /**
  * HTTP method an operation responds to. `QUERY` is the safe, idempotent method with a request body
- * from RFC 10008, declared with the `query` field of an OpenAPI 3.2 path item.
+ * from RFC 10008, declared with the `query` field of an OpenAPI 3.2 path item. Any other name is a
+ * method the source declares outside this fixed set, in the capitalization it is sent with.
  */
-type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'TRACE' | 'QUERY';
+type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'TRACE' | 'QUERY' | (string & {});
 /**
  * Fields shared by every operation, regardless of transport.
  */
@@ -2129,7 +2148,7 @@ export declare function compareEnforce(a?: Enforce, b?: Enforce): number;
  */
 type Macro = Visitor & {
   /**
-   * Macro identifier used to tell macros apart, for example `'simplify-union'`.
+   * Macro identifier used to tell macros apart, for example `'dedupe-union'`.
    */
   name: string;
   /**

package/dist/index.js

@@ -187,7 +187,7 @@ const VISITOR_KEYS = {
 		"responses"
 	],
 	RequestBody: ["content"],
-	Content: ["schema"],
+	Content: ["schema", "stream"],
 	Response: ["content"],
 	Schema: [
 		"properties",
@@ -251,24 +251,27 @@ function getChildren(node, recurse) {
 	});
 	return children;
 }
+/** Calls `visit` for each direct child node and stops at the first call that returns `true`. */
 function visitChildNodes(node, visit) {
 	const keys = VISITOR_KEYS[node.kind];
 	if (!keys) return false;
 	const record = node;
+	const seen = /* @__PURE__ */ new Set();
+	const visitOnce = (child) => !seen.has(child) && (seen.add(child), visit(child));
 	for (const key of keys) {
 		const value = record[key];
 		if (Array.isArray(value)) {
-			for (const item of value) if (isNode(item) && visit(item)) return true;
+			for (const item of value) if (isNode(item) && visitOnce(item)) return true;
 			continue;
 		}
 		if (isNode(value)) {
-			if (visit(value)) return true;
+			if (visitOnce(value)) return true;
 			continue;
 		}
 		if (isNodeRecord(value)) for (const name in value) {
 			if (!Object.hasOwn(value, name)) continue;
 			const item = value[name];
-			if (isNode(item) && visit(item)) return true;
+			if (isNode(item) && visitOnce(item)) return true;
 		}
 	}
 	return false;
@@ -366,13 +369,19 @@ function transformChildren(node, visitor, recurse) {
 	if (!keys) return node;
 	const record = node;
 	let updates;
+	const done = /* @__PURE__ */ new Map();
+	const transformOnce = (child) => {
+		const next = done.get(child) ?? transformNode(child, visitor, recurse, node);
+		done.set(child, next);
+		return next;
+	};
 	for (const key of keys) {
 		if (!(key in record)) continue;
 		const value = record[key];
 		if (Array.isArray(value)) {
 			let mapped;
 			for (const [i, item] of value.entries()) {
-				const next = isNode(item) ? transformNode(item, visitor, recurse, node) : item;
+				const next = isNode(item) ? transformOnce(item) : item;
 				if (mapped) {
 					mapped.push(next);
 					continue;
@@ -383,14 +392,14 @@ function transformChildren(node, visitor, recurse) {
 			continue;
 		}
 		if (isNode(value)) {
-			const next = transformNode(value, visitor, recurse, node);
+			const next = transformOnce(value);
 			if (next !== value) (updates ??= {})[key] = next;
 			continue;
 		}
 		if (isNodeRecord(value)) {
 			let mapped;
 			for (const [name, item] of Object.entries(value)) {
-				const next = isNode(item) ? transformNode(item, visitor, recurse, node) : item;
+				const next = isNode(item) ? transformOnce(item) : item;
 				if (next !== item) (mapped ??= { ...value })[name] = next;
 			}
 			if (mapped) (updates ??= {})[key] = mapped;