@kubb/ast 5.5.5 → 5.6.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { n as __name, t as __exportAll } from "./rolldown-runtime-CNktS9qV.js";
-import { $ as importDef, $t as textDef, A as ResponseNode, At as InferSchemaNode, B as createParameter, Bt as TypeNode, C as inputDef, Ct as schemaDef, D as OperationNode, Dt as DateOnlyTypeValue, E as HttpOperationNode, Et as propertyDef, F as createRequestBody, Ft as ConstNode, G as SourceNode, Gt as createBreak, H as ExportNode, Ht as breakDef, I as requestBodyDef, It as FunctionNode, J as createFile, Jt as createJsx, K as UserFileNode, Kt as createConst, L as ParameterLocation, Lt as JSDocNode, M as createResponse, Mt as ArrowFunctionNode, N as responseDef, Nt as BreakNode, O as createOperation, Ot as DateTimeTypeValue, P as RequestBodyNode, Pt as CodeNode, Q as fileDef, Qt as jsxDef, R as ParameterNode, Rt as JsxNode, S as createInput, St as createSchema, T as HttpMethod, Tt as createProperty, U as FileNode, Ut as constDef, V as parameterDef, Vt as arrowFunctionDef, W as ImportNode, Wt as createArrowFunction, X as createSource, Xt as createType, Y as createImport, Yt as createText, Z as exportDef, Zt as functionDef, _ as OutputNode, _t as SchemaType, a as Enforce, an as NodeKind, at as DateSchemaNode, b as InputMeta, bt as UnionSchemaNode, c as composeMacros, ct as IntersectionSchemaNode, d as Visitor, dt as PrimitiveSchemaType, en as typeDef, et as sourceDef, f as VisitorContext, ft as RefSchemaNode, g as Node, gt as SchemaNodeByType, h as transform, ht as SchemaNode, i as createPrinter, in as BaseNode, it as ArraySchemaNode, j as StatusCode, jt as ParserOptions, k as operationDef, kt as DateTypeOptions, l as defineMacro, lt as NumberSchemaNode, m as collectSync, mt as ScalarSchemaType, n as PrinterFactoryOptions, nn as NodeDef, nt as contentDef, o as Macro, on as schemaTypes, ot as DatetimeSchemaNode, p as collect, pt as ScalarSchemaNode, q as createExport, qt as createFunction, r as PrinterPartial, rn as defineNode, rt as createContent, s as applyMacros, st as EnumSchemaNode, t as Printer, tn as DistributiveOmit, tt as ContentNode, u as ParentOf, ut as ObjectSchemaNode, v as createOutput, vt as StringSchemaNode, w as GenericOperationNode, wt as PropertyNode, x as InputNode, xt as UrlSchemaNode, y as outputDef, yt as TimeSchemaNode, z as ParameterStyle, zt as TextNode } from "./types-D10wBFnV.js";
+import { $ as createJsx, $t as InferSchemaNode, A as createFile, At as EnumSchemaNode, B as ConstNode, Bt as SchemaType, C as inputDef, Ct as ParameterNode, D as SourceNode, Dt as ArraySchemaNode, E as ImportNode, Et as parameterDef, F as importDef, Ft as RefSchemaNode, G as TypeNode, Gt as createSchema, H as JSDocNode, Ht as TimeSchemaNode, I as sourceDef, It as ScalarSchemaNode, J as constDef, Jt as createProperty, K as arrowFunctionDef, Kt as schemaDef, L as ArrowFunctionNode, Lt as ScalarSchemaType, M as createSource, Mt as NumberSchemaNode, N as exportDef, Nt as ObjectSchemaNode, O as UserFileNode, Ot as DateSchemaNode, P as fileDef, Pt as PrimitiveSchemaType, Q as createFunction, Qt as DateTypeOptions, R as BreakNode, Rt as SchemaNode, S as createInput, St as ParameterLocation, T as FileNode, Tt as createParameter, U as JsxNode, Ut as UnionSchemaNode, V as FunctionNode, Vt as StringSchemaNode, W as TextNode, Wt as UrlSchemaNode, X as createBreak, Xt as DateOnlyTypeValue, Y as createArrowFunction, Yt as propertyDef, Z as createConst, Zt as DateTimeTypeValue, _ as OutputNode, _t as createRequestBody, a as Enforce, an as NodeKind, at as typeDef, b as InputMeta, bt as contentDef, c as composeMacros, ct as HttpOperationNode, d as Visitor, dt as operationDef, en as ParserOptions, et as createText, f as VisitorContext, ft as ResponseNode, g as Node, gt as RequestBodyNode, h as transform, ht as responseDef, i as createPrinter, in as BaseNode, it as textDef, j as createImport, jt as IntersectionSchemaNode, k as createExport, kt as DatetimeSchemaNode, l as defineMacro, lt as OperationNode, m as collectSync, mt as createResponse, n as PrinterFactoryOptions, nn as NodeDef, nt as functionDef, o as Macro, on as schemaTypes, ot as GenericOperationNode, p as collect, pt as StatusCode, q as breakDef, qt as PropertyNode, r as PrinterPartial, rn as defineNode, rt as jsxDef, s as applyMacros, st as HttpMethod, t as Printer, tn as DistributiveOmit, tt as createType, u as ParentOf, ut as createOperation, v as createOutput, vt as requestBodyDef, w as ExportNode, wt as ParameterStyle, x as InputNode, xt as createContent, y as outputDef, yt as ContentNode, z as CodeNode, zt as SchemaNodeByType } from "./types-NNGUervC.js";
 //#region src/guards.d.ts
 /**
  * Narrows a `SchemaNode` to the variant that matches `type`.
@@ -54,6 +54,21 @@ export declare function extractStringsFromNodes(nodes: Array<CodeNode> | undefin
  * `resolveRefName({ kind: 'Schema', type: 'ref', ref: '#/components/schemas/Order', targetName: 'OrderSchema' }) // 'OrderSchema'`
  */
 export declare function resolveRefName(node: SchemaNode | null | undefined): string | null;
+/**
+ * Merges a ref node with its resolved schema, giving the fields set at the usage site precedence.
+ *
+ * Every field on the ref except `kind`, `type`, `name`, `ref`, and `schema` overrides the same field
+ * of the resolved `schema` (for example `description`, `nullable`, `readOnly`, `deprecated`). Fields
+ * left `undefined` on the ref do not shadow the resolved schema. A ref without a resolved `schema`
+ * is returned as is.
+ *
+ * @example
+ * ```ts
+ * const ref = createSchema({ type: 'ref', ref: '#/components/schemas/Pet', description: 'A pet', schema: petSchema })
+ * mergeRefWithSchema(ref) // petSchema's fields with description 'A pet'
+ * ```
+ */
+export declare function mergeRefWithSchema(node: RefSchemaNode): SchemaNode;
 /**
  * Returns `true` when a schema is a bare ref without modifiers, metadata, or omit keys.
  *
@@ -63,6 +78,19 @@ export declare function resolveRefName(node: SchemaNode | null | undefined): str
 export declare function isBareRef(node: SchemaNode | null | undefined, keysToOmit?: Array<string> | null): boolean;
 //#endregion
 //#region src/utils/schemaGraph.d.ts
+/**
+ * Collects the names of every schema a node's subtree references, resolved with `resolveRefName`.
+ * Each ref contributes its name only, so the schema it points to is never traversed. The walk is
+ * memoized by node identity, which lets `findCircularSchemas` and `containsCircularRef` share one
+ * scan per schema.
+ *
+ * @example
+ * ```ts
+ * collectSchemaRefs(petSchema)
+ * // Set { 'Category', 'Tag' }
+ * ```
+ */
+export declare const collectSchemaRefs: (key: SchemaNode) => ReadonlySet<string>;
 /**
  * Collects the de-duplicated target names of every pointer-carrying ref in a node's subtree, in
  * first-occurrence order. The walk is memoized by node identity, so the subtree is scanned once and
@@ -71,8 +99,7 @@ export declare function isBareRef(node: SchemaNode | null | undefined, keysToOmi
  *
  * Only refs that carry a `$ref` pointer count, so a synthesized ref pointing at a sibling in the
  * same file (a union member created by name) is left out. That leaves exactly the set
- * `resolver.imports` emits. This is the ordered, import-facing counterpart to
- * {@link collectReferencedSchemaNames}, which returns an unordered set for graph analysis.
+ * `resolver.imports` emits.
  *
  * @example
  * ```ts
@@ -278,7 +305,7 @@ export declare const nodeDefs: (NodeDef<InputNode, Partial<Omit<InputNode, "kind
   type: "ipv6";
 }) | ScalarSchemaNode, "kind">> | NodeDef<PropertyNode, Pick<PropertyNode, "schema" | "name"> & Partial<Omit<PropertyNode, "schema" | "kind" | "name">>> | NodeDef<ParameterNode, Pick<ParameterNode, "schema" | "name" | "in"> & Partial<Omit<ParameterNode, "schema" | "kind" | "name" | "in">>> | NodeDef<ConstNode, Omit<ConstNode, "kind">> | NodeDef<TypeNode, Omit<TypeNode, "kind">> | NodeDef<FunctionNode, Omit<FunctionNode, "kind">> | NodeDef<ArrowFunctionNode, Omit<ArrowFunctionNode, "kind">> | NodeDef<TextNode, string> | NodeDef<BreakNode, void> | NodeDef<JsxNode, string> | NodeDef<ImportNode, Omit<ImportNode, "kind">> | NodeDef<ExportNode, Omit<ExportNode, "kind">> | NodeDef<SourceNode, Omit<SourceNode, "kind">> | NodeDef<FileNode<object>, Omit<FileNode<object>, "kind">>)[];
 declare namespace exports_d_exports {
-  export { ArraySchemaNode, ArrowFunctionNode, BreakNode, CodeNode, ConstNode, ContentNode, DateOnlyTypeValue, DateSchemaNode, DateTimeTypeValue, DateTypeOptions, DatetimeSchemaNode, DistributiveOmit, Enforce, EnumSchemaNode, ExportNode, FileNode, FunctionNode, GenericOperationNode, HttpMethod, HttpOperationNode, ImportNode, InferSchemaNode, InputMeta, InputNode, IntersectionSchemaNode, JSDocNode, JsxNode, Macro, Node, NodeDef, NodeKind, NumberSchemaNode, ObjectSchemaNode, OperationNode, OutputNode, ParameterLocation, ParameterNode, ParameterStyle, ParentOf, ParserOptions, PrimitiveSchemaType, Printer, PrinterFactoryOptions, PrinterPartial, PropertyNode, RefSchemaNode, RequestBodyNode, ResponseNode, ScalarSchemaNode, ScalarSchemaType, SchemaNode, SchemaNodeByType, SchemaType, SourceNode, StatusCode, StringSchemaNode, TextNode, TimeSchemaNode, TypeNode, UnionSchemaNode, UrlSchemaNode, UserFileNode, Visitor, VisitorContext, applyMacros, arrowFunctionDef, breakDef, collect, collectImportedRefNames, collectSync, collectUsedSchemaNames, composeMacros, constDef, contentDef, createPrinter, defineMacro, defineNode, exportDef, extractStringsFromNodes, factory_d_exports as factory, fileDef, findCircularSchemas, findCircularSchemasFromGraph, functionDef, getSchemaLiteralValues, importDef, inferDiscriminatorPropertyName, inputDef, isBareRef, isHttpOperationNode, jsxDef, narrowSchema, nodeDefs, operationDef, optionality, outputDef, parameterDef, propertyDef, requestBodyDef, resolveRefName, resolveSchemaProperties, responseDef, schemaDef, schemaTypes, sourceDef, textDef, transform, typeDef };
+  export { ArraySchemaNode, ArrowFunctionNode, BreakNode, CodeNode, ConstNode, ContentNode, DateOnlyTypeValue, DateSchemaNode, DateTimeTypeValue, DateTypeOptions, DatetimeSchemaNode, DistributiveOmit, Enforce, EnumSchemaNode, ExportNode, FileNode, FunctionNode, GenericOperationNode, HttpMethod, HttpOperationNode, ImportNode, InferSchemaNode, InputMeta, InputNode, IntersectionSchemaNode, JSDocNode, JsxNode, Macro, Node, NodeDef, NodeKind, NumberSchemaNode, ObjectSchemaNode, OperationNode, OutputNode, ParameterLocation, ParameterNode, ParameterStyle, ParentOf, ParserOptions, PrimitiveSchemaType, Printer, PrinterFactoryOptions, PrinterPartial, PropertyNode, RefSchemaNode, RequestBodyNode, ResponseNode, ScalarSchemaNode, ScalarSchemaType, SchemaNode, SchemaNodeByType, SchemaType, SourceNode, StatusCode, StringSchemaNode, TextNode, TimeSchemaNode, TypeNode, UnionSchemaNode, UrlSchemaNode, UserFileNode, Visitor, VisitorContext, applyMacros, arrowFunctionDef, breakDef, collect, collectImportedRefNames, collectSchemaRefs, collectSync, collectUsedSchemaNames, composeMacros, constDef, contentDef, createPrinter, defineMacro, defineNode, exportDef, extractStringsFromNodes, factory_d_exports as factory, fileDef, findCircularSchemas, findCircularSchemasFromGraph, functionDef, getSchemaLiteralValues, importDef, inferDiscriminatorPropertyName, inputDef, isBareRef, isHttpOperationNode, jsxDef, mergeRefWithSchema, narrowSchema, nodeDefs, operationDef, optionality, outputDef, parameterDef, propertyDef, requestBodyDef, resolveRefName, resolveSchemaProperties, responseDef, schemaDef, schemaTypes, sourceDef, textDef, transform, typeDef };
 }
 //#endregion
 export { type ArraySchemaNode, type ArrowFunctionNode, type BreakNode, type CodeNode, type ConstNode, type ContentNode, type DateOnlyTypeValue, type DateSchemaNode, type DateTimeTypeValue, type DateTypeOptions, type DatetimeSchemaNode, type DistributiveOmit, type Enforce, type EnumSchemaNode, type ExportNode, type FileNode, type FunctionNode, type GenericOperationNode, type HttpMethod, type HttpOperationNode, type ImportNode, type InferSchemaNode, type InputMeta, type InputNode, type IntersectionSchemaNode, type JSDocNode, type JsxNode, type Macro, type Node, type NodeDef, type NodeKind, type NumberSchemaNode, type ObjectSchemaNode, type OperationNode, type OutputNode, type ParameterLocation, type ParameterNode, type ParameterStyle, type ParentOf, type ParserOptions, type PrimitiveSchemaType, type Printer, type PrinterFactoryOptions, type PrinterPartial, type PropertyNode, type RefSchemaNode, type RequestBodyNode, type ResponseNode, type ScalarSchemaNode, type ScalarSchemaType, type SchemaNode, type SchemaNodeByType, type SchemaType, type SourceNode, type StatusCode, type StringSchemaNode, type TextNode, type TimeSchemaNode, type TypeNode, type UnionSchemaNode, type UrlSchemaNode, type UserFileNode, type Visitor, type VisitorContext, applyMacros, arrowFunctionDef, exports_d_exports as ast, breakDef, collect, collectSync, composeMacros, constDef, contentDef, createPrinter, defineMacro, defineNode, exportDef, factory_d_exports as factory, fileDef, functionDef, importDef, inputDef, jsxDef, operationDef, outputDef, parameterDef, propertyDef, requestBodyDef, responseDef, schemaDef, schemaTypes, sourceDef, textDef, transform, typeDef };