@kubb/ast 5.13.1 → 5.14.1

package/dist/index.d.cts

@@ -1,5 +1,29 @@
 //#endregion
 //#region src/constants.d.ts
+/**
+ * Node kind discriminators used by every AST node (for example `node.kind === nodeKinds.text`).
+ */
+export declare const nodeKinds: {
+  readonly input: 'Input';
+  readonly operation: 'Operation';
+  readonly schema: 'Schema';
+  readonly property: 'Property';
+  readonly parameter: 'Parameter';
+  readonly response: 'Response';
+  readonly requestBody: 'RequestBody';
+  readonly content: 'Content';
+  readonly type: 'Type';
+  readonly file: 'File';
+  readonly import: 'Import';
+  readonly export: 'Export';
+  readonly source: 'Source';
+  readonly const: 'Const';
+  readonly function: 'Function';
+  readonly arrowFunction: 'ArrowFunction';
+  readonly text: 'Text';
+  readonly break: 'Break';
+  readonly jsx: 'Jsx';
+};
 /**
  * Traversal depth for AST visitor utilities.
  *
@@ -903,6 +927,27 @@ type UserParameterNode = Pick<ParameterNode, 'name' | 'in' | 'schema'> & Partial
 declare function createParameter(input: UserParameterNode): ParameterNode;
 //#endregion
 //#region src/nodes/content.d.ts
+/**
+ * How one body property is serialized, from the `encoding` entry of its media type.
+ */
+type EncodingNode = {
+  /**
+   * Content type of the part, for example `'application/json'` for a multipart property.
+   */
+  contentType?: string;
+  /**
+   * Serialization style of the property.
+   */
+  style?: ParameterStyle;
+  /**
+   * Whether array and object values expand into separate values.
+   */
+  explode?: boolean;
+  /**
+   * Whether reserved characters are sent as-is instead of percent-encoded.
+   */
+  allowReserved?: boolean;
+};
 /**
  * AST node representing one content-type entry of a request body or response.
  *
@@ -936,6 +981,10 @@ type ContentNode = BaseNode & {
    * Set when a referenced schema has `readOnly`/`writeOnly` fields that should be omitted.
    */
   keysToOmit?: Array<string> | null;
+  /**
+   * Serialization settings per body property that sets at least one field in the spec's `encoding`.
+   */
+  encoding?: Record<string, EncodingNode>;
 };
 /**
  * Creates a `ContentNode` for a single request-body or response content type.
@@ -1659,6 +1708,13 @@ type SourceNode = BaseNode & {
    * Include this source in barrel/index file generation.
    */
   isIndexable?: boolean | null;
+  /**
+   * Marks the source as a definition that importing files absorb instead of import. `expression` is
+   * the declaration's right-hand side, such as `{ body: Pet }`.
+   */
+  inline?: {
+    expression: string;
+  } | null;
   /**
    * Child nodes that make up this source fragment, in DOM order.
    * Use a {@link TextNode} for raw string content.
@@ -1974,7 +2030,7 @@ declare namespace index_d_exports$1 {
  * ```ts
  * function getKind(node: Node): string {
  *   switch (node.kind) {
- *     case 'Input':
+ *     case nodeKinds.input:
  *       return 'input'
  *     default:
  *       return 'other'
@@ -2499,8 +2555,59 @@ export declare function createPrinter<T extends PrinterFactoryOptions = PrinterF
  */
 export declare function extractStringsFromNodes(nodes: Array<CodeNode> | undefined): string;
 //#endregion
+//#region src/utils/inline.d.ts
+/**
+ * Whether every source of `file` is inline. Other files absorb such a file, so it is never written.
+ */
+export declare function isVirtualFile(file: FileNode): boolean;
+type InlineFilesResult = {
+  /**
+   * Files that imported an inline name, rewritten to hold its definition.
+   */
+  files: Array<FileNode>;
+  /**
+   * Paths of the virtual files, which are not written.
+   */
+  virtualPaths: Array<string>;
+  /**
+   * One message per name that could not be inlined.
+   */
+  problems: Array<{
+    path: string;
+    message: string;
+  }>;
+};
+/**
+ * The language-specific half of {@link inlineFiles}, supplied by the parser that prints the file.
+ */
+type InlineLanguage = {
+  /**
+   * Swaps in what `replace` returns for every identifier in `text` that references a name, skipping strings and comments.
+   */
+  replaceIdentifiers(text: string, replace: (name: string) => string | undefined): string;
+  /**
+   * Makes `expression` safe to put where a name was, such as `(A | B)` in TypeScript.
+   */
+  wrap(expression: string): string;
+};
+type InlineFilesOptions = {
+  /**
+   * The inline support for a file's language, or `undefined` when it has none.
+   */
+  language: (file: FileNode) => InlineLanguage | undefined;
+};
+/**
+ * Replaces every name a file imports from a virtual file (see {@link isVirtualFile}) with that name's
+ * `inline.expression`, until no inline names are left. The definitions' own imports move to the importing file.
+ */
+export declare function inlineFiles(files: ReadonlyArray<FileNode>, { language }: InlineFilesOptions): InlineFilesResult;
+//#endregion
 //#region src/utils/refs.d.ts
-/** Returns the last segment of a `$ref` pointer, for example `'Pet'` for `#/components/schemas/Pet`. */
+/**
+ * Returns the last segment of a `$ref` pointer, for example `'Pet'` for `#/components/schemas/Pet`.
+ * The segment is decoded like the pointer resolver does: percent-escapes first, then `~1` and `~0`
+ * (RFC 6901), so `a~1b~0c` names the component `a/b~c`.
+ */
 export declare function refName(ref: string): string;
 /**
  * Resolves the emitted name of the schema a ref node points at. Prefers `targetName` (set when
@@ -2750,8 +2857,8 @@ type ParserOptions = {
   enumSuffix: 'enum' | (string & {});
 };
 declare namespace index_d_exports {
-  export { ArraySchemaNode, ArrowFunctionNode, BreakNode, CodeNode, ConstNode, ContentNode, DateOnlyTypeValue, DateSchemaNode, DateTimeTypeValue, DateTypeOptions, DatetimeSchemaNode, DistributiveOmit, Enforce, EnumSchemaNode, ExportNode, FileNode, FunctionNode, GenericOperationNode, HttpMethod, HttpOperationNode, ImportNode, InputMeta, InputNode, InputSecurityScheme, InputServer, IntersectionSchemaNode, JSDocNode, JsxNode, Macro, Node, NodeKind, NotSchemaNode, NumberSchemaNode, ObjectSchemaNode, OperationNode, 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, index_d_exports as ast, collect, collectImportedRefNames, collectSchemaRefs, collectSync, collectUsedSchemaNames, composeMacros, createPrinter, defineMacro, extractStringsFromNodes, index_d_exports$1 as factory, findCircularSchemas, findCircularSchemasFromGraph, findSchema, forEachChild, forEachSchema, getSchemaLiteralValues, inferDiscriminatorPropertyName, isBareRef, isHttpOperationNode, mergeRefWithSchema, narrowSchema, optionality, refName, resolveRef, resolveRefName, resolveSchemaProperties, schemaTypes, transform };
+  export { ArraySchemaNode, ArrowFunctionNode, BreakNode, CodeNode, ConstNode, ContentNode, DateOnlyTypeValue, DateSchemaNode, DateTimeTypeValue, DateTypeOptions, DatetimeSchemaNode, DistributiveOmit, EncodingNode, Enforce, EnumSchemaNode, ExportNode, FileNode, FunctionNode, GenericOperationNode, HttpMethod, HttpOperationNode, ImportNode, InlineLanguage, InputMeta, InputNode, InputSecurityScheme, InputServer, IntersectionSchemaNode, JSDocNode, JsxNode, Macro, Node, NodeKind, NotSchemaNode, NumberSchemaNode, ObjectSchemaNode, OperationNode, 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, index_d_exports as ast, collect, collectImportedRefNames, collectSchemaRefs, collectSync, collectUsedSchemaNames, composeMacros, createPrinter, defineMacro, extractStringsFromNodes, index_d_exports$1 as factory, findCircularSchemas, findCircularSchemasFromGraph, findSchema, forEachChild, forEachSchema, getSchemaLiteralValues, inferDiscriminatorPropertyName, inlineFiles, isBareRef, isHttpOperationNode, isVirtualFile, mergeRefWithSchema, narrowSchema, nodeKinds, optionality, refName, resolveRef, resolveRefName, resolveSchemaProperties, schemaTypes, transform };
 }
 //#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 InputMeta, type InputNode, type InputSecurityScheme, type InputServer, type IntersectionSchemaNode, type JSDocNode, type JsxNode, type Macro, type Node, type NodeKind, type NotSchemaNode, type NumberSchemaNode, type ObjectSchemaNode, type OperationNode, 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, index_d_exports as ast, index_d_exports$1 as factory };
+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 EncodingNode, type Enforce, type EnumSchemaNode, type ExportNode, type FileNode, type FunctionNode, type GenericOperationNode, type HttpMethod, type HttpOperationNode, type ImportNode, type InlineLanguage, type InputMeta, type InputNode, type InputSecurityScheme, type InputServer, type IntersectionSchemaNode, type JSDocNode, type JsxNode, type Macro, type Node, type NodeKind, type NotSchemaNode, type NumberSchemaNode, type ObjectSchemaNode, type OperationNode, 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, index_d_exports as ast, index_d_exports$1 as factory };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -1,5 +1,29 @@
 //#endregion
 //#region src/constants.d.ts
+/**
+ * Node kind discriminators used by every AST node (for example `node.kind === nodeKinds.text`).
+ */
+export declare const nodeKinds: {
+  readonly input: 'Input';
+  readonly operation: 'Operation';
+  readonly schema: 'Schema';
+  readonly property: 'Property';
+  readonly parameter: 'Parameter';
+  readonly response: 'Response';
+  readonly requestBody: 'RequestBody';
+  readonly content: 'Content';
+  readonly type: 'Type';
+  readonly file: 'File';
+  readonly import: 'Import';
+  readonly export: 'Export';
+  readonly source: 'Source';
+  readonly const: 'Const';
+  readonly function: 'Function';
+  readonly arrowFunction: 'ArrowFunction';
+  readonly text: 'Text';
+  readonly break: 'Break';
+  readonly jsx: 'Jsx';
+};
 /**
  * Traversal depth for AST visitor utilities.
  *
@@ -903,6 +927,27 @@ type UserParameterNode = Pick<ParameterNode, 'name' | 'in' | 'schema'> & Partial
 declare function createParameter(input: UserParameterNode): ParameterNode;
 //#endregion
 //#region src/nodes/content.d.ts
+/**
+ * How one body property is serialized, from the `encoding` entry of its media type.
+ */
+type EncodingNode = {
+  /**
+   * Content type of the part, for example `'application/json'` for a multipart property.
+   */
+  contentType?: string;
+  /**
+   * Serialization style of the property.
+   */
+  style?: ParameterStyle;
+  /**
+   * Whether array and object values expand into separate values.
+   */
+  explode?: boolean;
+  /**
+   * Whether reserved characters are sent as-is instead of percent-encoded.
+   */
+  allowReserved?: boolean;
+};
 /**
  * AST node representing one content-type entry of a request body or response.
  *
@@ -936,6 +981,10 @@ type ContentNode = BaseNode & {
    * Set when a referenced schema has `readOnly`/`writeOnly` fields that should be omitted.
    */
   keysToOmit?: Array<string> | null;
+  /**
+   * Serialization settings per body property that sets at least one field in the spec's `encoding`.
+   */
+  encoding?: Record<string, EncodingNode>;
 };
 /**
  * Creates a `ContentNode` for a single request-body or response content type.
@@ -1659,6 +1708,13 @@ type SourceNode = BaseNode & {
    * Include this source in barrel/index file generation.
    */
   isIndexable?: boolean | null;
+  /**
+   * Marks the source as a definition that importing files absorb instead of import. `expression` is
+   * the declaration's right-hand side, such as `{ body: Pet }`.
+   */
+  inline?: {
+    expression: string;
+  } | null;
   /**
    * Child nodes that make up this source fragment, in DOM order.
    * Use a {@link TextNode} for raw string content.
@@ -1974,7 +2030,7 @@ declare namespace index_d_exports$1 {
  * ```ts
  * function getKind(node: Node): string {
  *   switch (node.kind) {
- *     case 'Input':
+ *     case nodeKinds.input:
  *       return 'input'
  *     default:
  *       return 'other'
@@ -2499,8 +2555,59 @@ export declare function createPrinter<T extends PrinterFactoryOptions = PrinterF
  */
 export declare function extractStringsFromNodes(nodes: Array<CodeNode> | undefined): string;
 //#endregion
+//#region src/utils/inline.d.ts
+/**
+ * Whether every source of `file` is inline. Other files absorb such a file, so it is never written.
+ */
+export declare function isVirtualFile(file: FileNode): boolean;
+type InlineFilesResult = {
+  /**
+   * Files that imported an inline name, rewritten to hold its definition.
+   */
+  files: Array<FileNode>;
+  /**
+   * Paths of the virtual files, which are not written.
+   */
+  virtualPaths: Array<string>;
+  /**
+   * One message per name that could not be inlined.
+   */
+  problems: Array<{
+    path: string;
+    message: string;
+  }>;
+};
+/**
+ * The language-specific half of {@link inlineFiles}, supplied by the parser that prints the file.
+ */
+type InlineLanguage = {
+  /**
+   * Swaps in what `replace` returns for every identifier in `text` that references a name, skipping strings and comments.
+   */
+  replaceIdentifiers(text: string, replace: (name: string) => string | undefined): string;
+  /**
+   * Makes `expression` safe to put where a name was, such as `(A | B)` in TypeScript.
+   */
+  wrap(expression: string): string;
+};
+type InlineFilesOptions = {
+  /**
+   * The inline support for a file's language, or `undefined` when it has none.
+   */
+  language: (file: FileNode) => InlineLanguage | undefined;
+};
+/**
+ * Replaces every name a file imports from a virtual file (see {@link isVirtualFile}) with that name's
+ * `inline.expression`, until no inline names are left. The definitions' own imports move to the importing file.
+ */
+export declare function inlineFiles(files: ReadonlyArray<FileNode>, { language }: InlineFilesOptions): InlineFilesResult;
+//#endregion
 //#region src/utils/refs.d.ts
-/** Returns the last segment of a `$ref` pointer, for example `'Pet'` for `#/components/schemas/Pet`. */
+/**
+ * Returns the last segment of a `$ref` pointer, for example `'Pet'` for `#/components/schemas/Pet`.
+ * The segment is decoded like the pointer resolver does: percent-escapes first, then `~1` and `~0`
+ * (RFC 6901), so `a~1b~0c` names the component `a/b~c`.
+ */
 export declare function refName(ref: string): string;
 /**
  * Resolves the emitted name of the schema a ref node points at. Prefers `targetName` (set when
@@ -2750,8 +2857,8 @@ type ParserOptions = {
   enumSuffix: 'enum' | (string & {});
 };
 declare namespace index_d_exports {
-  export { ArraySchemaNode, ArrowFunctionNode, BreakNode, CodeNode, ConstNode, ContentNode, DateOnlyTypeValue, DateSchemaNode, DateTimeTypeValue, DateTypeOptions, DatetimeSchemaNode, DistributiveOmit, Enforce, EnumSchemaNode, ExportNode, FileNode, FunctionNode, GenericOperationNode, HttpMethod, HttpOperationNode, ImportNode, InputMeta, InputNode, InputSecurityScheme, InputServer, IntersectionSchemaNode, JSDocNode, JsxNode, Macro, Node, NodeKind, NotSchemaNode, NumberSchemaNode, ObjectSchemaNode, OperationNode, 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, index_d_exports as ast, collect, collectImportedRefNames, collectSchemaRefs, collectSync, collectUsedSchemaNames, composeMacros, createPrinter, defineMacro, extractStringsFromNodes, index_d_exports$1 as factory, findCircularSchemas, findCircularSchemasFromGraph, findSchema, forEachChild, forEachSchema, getSchemaLiteralValues, inferDiscriminatorPropertyName, isBareRef, isHttpOperationNode, mergeRefWithSchema, narrowSchema, optionality, refName, resolveRef, resolveRefName, resolveSchemaProperties, schemaTypes, transform };
+  export { ArraySchemaNode, ArrowFunctionNode, BreakNode, CodeNode, ConstNode, ContentNode, DateOnlyTypeValue, DateSchemaNode, DateTimeTypeValue, DateTypeOptions, DatetimeSchemaNode, DistributiveOmit, EncodingNode, Enforce, EnumSchemaNode, ExportNode, FileNode, FunctionNode, GenericOperationNode, HttpMethod, HttpOperationNode, ImportNode, InlineLanguage, InputMeta, InputNode, InputSecurityScheme, InputServer, IntersectionSchemaNode, JSDocNode, JsxNode, Macro, Node, NodeKind, NotSchemaNode, NumberSchemaNode, ObjectSchemaNode, OperationNode, 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, index_d_exports as ast, collect, collectImportedRefNames, collectSchemaRefs, collectSync, collectUsedSchemaNames, composeMacros, createPrinter, defineMacro, extractStringsFromNodes, index_d_exports$1 as factory, findCircularSchemas, findCircularSchemasFromGraph, findSchema, forEachChild, forEachSchema, getSchemaLiteralValues, inferDiscriminatorPropertyName, inlineFiles, isBareRef, isHttpOperationNode, isVirtualFile, mergeRefWithSchema, narrowSchema, nodeKinds, optionality, refName, resolveRef, resolveRefName, resolveSchemaProperties, schemaTypes, transform };
 }
 //#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 InputMeta, type InputNode, type InputSecurityScheme, type InputServer, type IntersectionSchemaNode, type JSDocNode, type JsxNode, type Macro, type Node, type NodeKind, type NotSchemaNode, type NumberSchemaNode, type ObjectSchemaNode, type OperationNode, 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, index_d_exports as ast, index_d_exports$1 as factory };
+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 EncodingNode, type Enforce, type EnumSchemaNode, type ExportNode, type FileNode, type FunctionNode, type GenericOperationNode, type HttpMethod, type HttpOperationNode, type ImportNode, type InlineLanguage, type InputMeta, type InputNode, type InputSecurityScheme, type InputServer, type IntersectionSchemaNode, type JSDocNode, type JsxNode, type Macro, type Node, type NodeKind, type NotSchemaNode, type NumberSchemaNode, type ObjectSchemaNode, type OperationNode, 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, index_d_exports as ast, index_d_exports$1 as factory };
 //# sourceMappingURL=index.d.ts.map