@kubb/ast 5.0.0-beta.22 → 5.0.0-beta.24

package/dist/index.cjs

@@ -610,11 +610,14 @@ function* getChildren(node, recurse) {
 	}
 }
 /**
-* Depth-first traversal for side effects. Visitor return values are ignored.
-* Sibling nodes at each level are visited concurrently up to `options.concurrency`
-* (default: `WALK_CONCURRENCY`).
+* Async depth-first traversal for side effects. Visitor return values are
+* ignored. Use `transform` when you want to rewrite nodes.
 *
-* @example
+* Sibling nodes at each depth run concurrently up to `options.concurrency`
+* (defaults to `WALK_CONCURRENCY`). Higher values overlap I/O-bound visitor
+* work; lower values reduce memory pressure.
+*
+* @example Log every operation
 * ```ts
 * await walk(root, {
 *   operation(node) {
@@ -623,10 +626,9 @@ function* getChildren(node, recurse) {
 * })
 * ```
 *
-* @example
+* @example Only visit the root node
 * ```ts
-* // Visit only the current node
-* await walk(root, { depth: 'shallow', root: () => {} })
+* await walk(root, { depth: 'shallow', input: () => {} })
 * ```
 */
 async function walk(node, options) {
@@ -748,23 +750,19 @@ function transform(node, options) {
 	return node;
 }
 /**
-* Runs a depth-first synchronous collection pass.
+* Lazy depth-first collection pass. Yields every non-null value returned by
+* the visitor callbacks. Use `collect` for the eager array form.
 *
-* Non-`null` values returned by visitor callbacks are appended to the result.
-*
-* @example
+* @example Collect every operationId
 * ```ts
-* const ids = collect(root, {
+* const ids: string[] = []
+* for (const id of collectLazy<string>(root, {
 *   operation(node) {
 *     return node.operationId
 *   },
-* })
-* ```
-*
-* @example
-* ```ts
-* // Collect from only the current node
-* const values = collect(root, { depth: 'shallow', root: () => 'root' })
+* })) {
+*   ids.push(id)
+* }
 * ```
 */
 function* collectLazy(node, options) {
@@ -800,6 +798,19 @@ function* collectLazy(node, options) {
 		parent: node
 	});
 }
+/**
+* Eager depth-first collection pass. Returns an array of every non-null value
+* the visitor callbacks return.
+*
+* @example Collect every operationId
+* ```ts
+* const ids = collect<string>(root, {
+*   operation(node) {
+*     return node.operationId
+*   },
+* })
+* ```
+*/
 function collect(node, options) {
 	return Array.from(collectLazy(node, options));
 }
@@ -1425,10 +1436,13 @@ function containsCircularRef(node, { circularSchemas, excludeName }) {
 //#endregion
 //#region src/factory.ts
 /**
-* Syncs property/parameter schema optionality flags from `required` and `schema.nullable`.
+* Updates a schema's `optional` and `nullish` flags from a parent's `required`
+* value and the schema's own `nullable`. Mirrors how OpenAPI parameters and
+* object properties combine "required" and "nullable" into a single AST.
 *
-* - `optional` is set for non-required, non-nullable schemas.
-* - `nullish` is set for non-required, nullable schemas.
+* - Non-required + non-nullable → `optional: true`.
+* - Non-required + nullable → `nullish: true`.
+* - Required → both flags cleared.
 */
 function syncOptionality(schema, required) {
 	const nullable = schema.nullable ?? false;
@@ -2068,22 +2082,27 @@ function createJsx(value) {
 //#endregion
 //#region src/printer.ts
 /**
-* Creates a schema printer factory.
-*
-* This function wraps a builder and makes options optional at call sites.
+* Defines a schema printer: a function that takes a `SchemaNode` and emits
+* code in your target language. Each plugin that produces code from schemas
+* (TypeScript types, Zod schemas, Faker factories) ships a printer built
+* with this helper.
 *
 * The builder receives resolved options and returns:
-* - `name` — a unique identifier for the printer
-* - `options` — options stored on the returned printer instance
-* - `nodes` — a map of `SchemaType` → handler functions that convert a `SchemaNode` to `TOutput`
-* - `print` _(optional)_ — top-level override exposed as `printer.print`
-*   - Inside this function, use `this.transform(node)` to dispatch to the `nodes` map
-*   - This keeps recursion safe and avoids self-calls
 *
-* When no `print` override is provided, `printer.print` falls back to `printer.transform` (the node-level dispatcher).
+* - `name` — unique identifier for the printer.
+* - `options` — stored on the returned printer instance.
+* - `nodes` — map of `SchemaType` → handler. Handlers return the rendered
+*   output (a string, a TypeScript AST node, ...) for that schema type.
+* - `print` (optional) — top-level override exposed as `printer.print`.
+*   Use `this.transform(node)` inside it to dispatch to `nodes` recursively.
 *
-* @example Basic usage — Zod schema printer
+* Without a `print` override, `printer.print` falls back to `printer.transform`
+* (the node-level dispatcher).
+*
+* @example Tiny Zod printer
 * ```ts
+* import { definePrinter, type PrinterFactoryOptions } from '@kubb/ast'
+*
 * type PrinterZod = PrinterFactoryOptions<'zod', { strict?: boolean }, string>
 *
 * export const zodPrinter = definePrinter<PrinterZod>((options) => ({
@@ -2092,7 +2111,9 @@ function createJsx(value) {
 *   nodes: {
 *     string: () => 'z.string()',
 *     object(node) {
-*       const props = node.properties.map(p => `${p.name}: ${this.transform(p.schema)}`).join(', ')
+*       const props = node.properties
+*         .map((p) => `${p.name}: ${this.transform(p.schema)}`)
+*         .join(', ')
 *       return `z.object({ ${props} })`
 *     },
 *   },