@kubb/ast 5.16.1 → 5.17.1

package/dist/index.d.cts

@@ -788,6 +788,114 @@ type CreateSchemaOutput<T extends CreateSchemaInput> = SchemaNodeByType[T['type'
  */
 declare function createSchema<T extends CreateSchemaInput>(props: T): CreateSchemaOutput<T>;
 declare function createSchema(props: CreateSchemaInput): SchemaNode;
+/**
+ * A variable declared by a server URL template.
+ */
+type InputServerVariable = {
+  default?: string;
+  enum?: Array<string>;
+  description?: string;
+};
+/**
+ * A server from the source document, with `{variable}` placeholders filled from their defaults.
+ */
+type InputServer = {
+  url: string;
+  description?: string;
+  /**
+   * Variables of the source URL template, copied as-is. `url` already has their defaults filled in, so
+   * this tells a templated server apart from a literal one. Absent when the server declares none.
+   */
+  variables?: Record<string, InputServerVariable>;
+};
+/**
+ * An authentication scheme from the source document, keyed by `name`. `parameterName` is the header, query, or cookie name of an `apiKey`.
+ */
+type InputSecurityScheme = {
+  name: string;
+  type: string;
+  description?: string;
+  scheme?: string;
+  bearerFormat?: string;
+  in?: string;
+  parameterName?: string;
+};
+/**
+ * Metadata for an API document, populated by the adapter and available to every generator.
+ * Every field is a plain JSON value.
+ *
+ * @example
+ * ```ts
+ * const meta: InputMeta = { title: 'Pet Store', version: '1.0.0', baseURL: 'https://api.example.com/v2' }
+ * ```
+ */
+type InputMeta = {
+  /**
+   * API title from `info.title` in the source document.
+   */
+  title?: string;
+  /**
+   * API description from `info.description` in the source document.
+   */
+  description?: string;
+  /**
+   * API version string from `info.version` in the source document.
+   */
+  version?: string;
+  /**
+   * Resolved base URL from the first matching server entry in the source document.
+   */
+  baseURL?: string | null;
+  servers?: Array<InputServer>;
+  securitySchemes?: Array<InputSecurityScheme>;
+  /**
+   * Vendor extensions (`x-*` keys) from the document root, copied as-is. Absent when the root has none.
+   */
+  extensions?: Record<string, unknown>;
+};
+/**
+ * Input AST node that contains all schemas and operations for one API document.
+ * Produced by the adapter and consumed by all Kubb plugins.
+ *
+ * @example
+ * ```ts
+ * const input: InputNode = {
+ *   kind: 'Input',
+ *   schemas: [],
+ *   operations: [],
+ *   meta: {},
+ * }
+ * ```
+ */
+type InputNode = BaseNode & {
+  /**
+   * Node kind.
+   */
+  kind: 'Input';
+  /**
+   * All schema nodes in the document.
+   */
+  schemas: Array<SchemaNode>;
+  /**
+   * All operation nodes in the document.
+   */
+  operations: Array<OperationNode>;
+  /**
+   * Document metadata populated by the adapter.
+   */
+  meta: InputMeta;
+};
+/**
+ * Creates an `InputNode`, defaulting `schemas`/`operations` to empty arrays and `meta` to an empty
+ * object. Every call allocates fresh defaults so no two inputs share them.
+ *
+ * @example
+ * ```ts
+ * const input = createInput()
+ * // { kind: 'Input', schemas: [], operations: [] }
+ * ```
+ */
+declare function createInput(overrides?: Partial<Omit<InputNode, 'kind'>>): InputNode;
 /**
  * Where a parameter is sent. `querystring` carries the whole query string as one value, serialized per `contentType`.
  */
@@ -907,7 +1015,7 @@ type ContentNode = BaseNode & {
    */
   kind: 'Content';
   /**
-   * The content type for this entry (e.g. `'application/json'`).
+   * The content type for this entry (e.g. `'application/json'`), or `''` for a response without a body.
    */
   contentType: string;
   /**
@@ -1028,10 +1136,11 @@ type ResponseNode = BaseNode & {
   /**
    * All available content type entries for this response.
    *
-   * When the adapter `contentType` option is set, this array contains exactly one entry for that
-   * content type. Otherwise it contains one entry per content type declared in the spec, so that
-   * plugins can generate a union of response types (e.g. `application/json` and `application/xml`).
-   * Body-less responses keep a single entry whose `schema` is the empty/`void` placeholder.
+   * For a response that declares content, the array holds exactly one entry for the adapter
+   * `contentType` option when it is set. Otherwise it holds one entry per content type declared in
+   * the spec, so that plugins can generate a union of response types (e.g. `application/json` and
+   * `application/xml`). A body-less response always keeps a single entry whose `contentType` is `''`
+   * and whose `schema` is the empty/`void` placeholder, even when the option is set.
    *
    * @example
    * ```ts
@@ -1111,6 +1220,8 @@ type OperationNodeBase = BaseNode & {
    * Vendor extensions (`x-*` keys) from the source operation, copied as-is. Absent when the source has none.
    */
   extensions?: Record<string, unknown>;
+  /** The operation's own `servers`, else its path item's, such as an upload host. Absent when neither declares any. */
+  servers?: Array<InputServer>;
 };
 /**
  * Operation served over HTTP. `method` and `path` are guaranteed.
@@ -1819,114 +1930,6 @@ type UserFileNode<TMeta extends object = object> = Omit<FileNode<TMeta>, 'kind'
  * ```
  */
 declare function createFile<TMeta extends object = object>(input: UserFileNode<TMeta>): FileNode<TMeta>;
-/**
- * A variable declared by a server URL template.
- */
-type InputServerVariable = {
-  default?: string;
-  enum?: Array<string>;
-  description?: string;
-};
-/**
- * A server from the source document, with `{variable}` placeholders filled from their defaults.
- */
-type InputServer = {
-  url: string;
-  description?: string;
-  /**
-   * Variables of the source URL template, copied as-is. `url` already has their defaults filled in, so
-   * this tells a templated server apart from a literal one. Absent when the server declares none.
-   */
-  variables?: Record<string, InputServerVariable>;
-};
-/**
- * An authentication scheme from the source document, keyed by `name`. `parameterName` is the header, query, or cookie name of an `apiKey`.
- */
-type InputSecurityScheme = {
-  name: string;
-  type: string;
-  description?: string;
-  scheme?: string;
-  bearerFormat?: string;
-  in?: string;
-  parameterName?: string;
-};
-/**
- * Metadata for an API document, populated by the adapter and available to every generator.
- * Every field is a plain JSON value.
- *
- * @example
- * ```ts
- * const meta: InputMeta = { title: 'Pet Store', version: '1.0.0', baseURL: 'https://api.example.com/v2' }
- * ```
- */
-type InputMeta = {
-  /**
-   * API title from `info.title` in the source document.
-   */
-  title?: string;
-  /**
-   * API description from `info.description` in the source document.
-   */
-  description?: string;
-  /**
-   * API version string from `info.version` in the source document.
-   */
-  version?: string;
-  /**
-   * Resolved base URL from the first matching server entry in the source document.
-   */
-  baseURL?: string | null;
-  servers?: Array<InputServer>;
-  securitySchemes?: Array<InputSecurityScheme>;
-  /**
-   * Vendor extensions (`x-*` keys) from the document root, copied as-is. Absent when the root has none.
-   */
-  extensions?: Record<string, unknown>;
-};
-/**
- * Input AST node that contains all schemas and operations for one API document.
- * Produced by the adapter and consumed by all Kubb plugins.
- *
- * @example
- * ```ts
- * const input: InputNode = {
- *   kind: 'Input',
- *   schemas: [],
- *   operations: [],
- *   meta: {},
- * }
- * ```
- */
-type InputNode = BaseNode & {
-  /**
-   * Node kind.
-   */
-  kind: 'Input';
-  /**
-   * All schema nodes in the document.
-   */
-  schemas: Array<SchemaNode>;
-  /**
-   * All operation nodes in the document.
-   */
-  operations: Array<OperationNode>;
-  /**
-   * Document metadata populated by the adapter.
-   */
-  meta: InputMeta;
-};
-/**
- * Creates an `InputNode`, defaulting `schemas`/`operations` to empty arrays and `meta` to an empty
- * object. Every call allocates fresh defaults so no two inputs share them.
- *
- * @example
- * ```ts
- * const input = createInput()
- * // { kind: 'Input', schemas: [], operations: [] }
- * ```
- */
-declare function createInput(overrides?: Partial<Omit<InputNode, 'kind'>>): InputNode;
 declare namespace index_d_exports$1 {
   export { Node, UserFileNode, createArrowFunction, createBreak, createConst, createContent, createExport, createFile, createFunction, createImport, createInput, createJsx, createOperation, createParameter, createProperty, createRequestBody, createResponse, createSchema, createSource, createText, createType };
 }

package/dist/index.d.ts

@@ -788,6 +788,114 @@ type CreateSchemaOutput<T extends CreateSchemaInput> = SchemaNodeByType[T['type'
  */
 declare function createSchema<T extends CreateSchemaInput>(props: T): CreateSchemaOutput<T>;
 declare function createSchema(props: CreateSchemaInput): SchemaNode;
+/**
+ * A variable declared by a server URL template.
+ */
+type InputServerVariable = {
+  default?: string;
+  enum?: Array<string>;
+  description?: string;
+};
+/**
+ * A server from the source document, with `{variable}` placeholders filled from their defaults.
+ */
+type InputServer = {
+  url: string;
+  description?: string;
+  /**
+   * Variables of the source URL template, copied as-is. `url` already has their defaults filled in, so
+   * this tells a templated server apart from a literal one. Absent when the server declares none.
+   */
+  variables?: Record<string, InputServerVariable>;
+};
+/**
+ * An authentication scheme from the source document, keyed by `name`. `parameterName` is the header, query, or cookie name of an `apiKey`.
+ */
+type InputSecurityScheme = {
+  name: string;
+  type: string;
+  description?: string;
+  scheme?: string;
+  bearerFormat?: string;
+  in?: string;
+  parameterName?: string;
+};
+/**
+ * Metadata for an API document, populated by the adapter and available to every generator.
+ * Every field is a plain JSON value.
+ *
+ * @example
+ * ```ts
+ * const meta: InputMeta = { title: 'Pet Store', version: '1.0.0', baseURL: 'https://api.example.com/v2' }
+ * ```
+ */
+type InputMeta = {
+  /**
+   * API title from `info.title` in the source document.
+   */
+  title?: string;
+  /**
+   * API description from `info.description` in the source document.
+   */
+  description?: string;
+  /**
+   * API version string from `info.version` in the source document.
+   */
+  version?: string;
+  /**
+   * Resolved base URL from the first matching server entry in the source document.
+   */
+  baseURL?: string | null;
+  servers?: Array<InputServer>;
+  securitySchemes?: Array<InputSecurityScheme>;
+  /**
+   * Vendor extensions (`x-*` keys) from the document root, copied as-is. Absent when the root has none.
+   */
+  extensions?: Record<string, unknown>;
+};
+/**
+ * Input AST node that contains all schemas and operations for one API document.
+ * Produced by the adapter and consumed by all Kubb plugins.
+ *
+ * @example
+ * ```ts
+ * const input: InputNode = {
+ *   kind: 'Input',
+ *   schemas: [],
+ *   operations: [],
+ *   meta: {},
+ * }
+ * ```
+ */
+type InputNode = BaseNode & {
+  /**
+   * Node kind.
+   */
+  kind: 'Input';
+  /**
+   * All schema nodes in the document.
+   */
+  schemas: Array<SchemaNode>;
+  /**
+   * All operation nodes in the document.
+   */
+  operations: Array<OperationNode>;
+  /**
+   * Document metadata populated by the adapter.
+   */
+  meta: InputMeta;
+};
+/**
+ * Creates an `InputNode`, defaulting `schemas`/`operations` to empty arrays and `meta` to an empty
+ * object. Every call allocates fresh defaults so no two inputs share them.
+ *
+ * @example
+ * ```ts
+ * const input = createInput()
+ * // { kind: 'Input', schemas: [], operations: [] }
+ * ```
+ */
+declare function createInput(overrides?: Partial<Omit<InputNode, 'kind'>>): InputNode;
 /**
  * Where a parameter is sent. `querystring` carries the whole query string as one value, serialized per `contentType`.
  */
@@ -907,7 +1015,7 @@ type ContentNode = BaseNode & {
    */
   kind: 'Content';
   /**
-   * The content type for this entry (e.g. `'application/json'`).
+   * The content type for this entry (e.g. `'application/json'`), or `''` for a response without a body.
    */
   contentType: string;
   /**
@@ -1028,10 +1136,11 @@ type ResponseNode = BaseNode & {
   /**
    * All available content type entries for this response.
    *
-   * When the adapter `contentType` option is set, this array contains exactly one entry for that
-   * content type. Otherwise it contains one entry per content type declared in the spec, so that
-   * plugins can generate a union of response types (e.g. `application/json` and `application/xml`).
-   * Body-less responses keep a single entry whose `schema` is the empty/`void` placeholder.
+   * For a response that declares content, the array holds exactly one entry for the adapter
+   * `contentType` option when it is set. Otherwise it holds one entry per content type declared in
+   * the spec, so that plugins can generate a union of response types (e.g. `application/json` and
+   * `application/xml`). A body-less response always keeps a single entry whose `contentType` is `''`
+   * and whose `schema` is the empty/`void` placeholder, even when the option is set.
    *
    * @example
    * ```ts
@@ -1111,6 +1220,8 @@ type OperationNodeBase = BaseNode & {
    * Vendor extensions (`x-*` keys) from the source operation, copied as-is. Absent when the source has none.
    */
   extensions?: Record<string, unknown>;
+  /** The operation's own `servers`, else its path item's, such as an upload host. Absent when neither declares any. */
+  servers?: Array<InputServer>;
 };
 /**
  * Operation served over HTTP. `method` and `path` are guaranteed.
@@ -1819,114 +1930,6 @@ type UserFileNode<TMeta extends object = object> = Omit<FileNode<TMeta>, 'kind'
  * ```
  */
 declare function createFile<TMeta extends object = object>(input: UserFileNode<TMeta>): FileNode<TMeta>;
-/**
- * A variable declared by a server URL template.
- */
-type InputServerVariable = {
-  default?: string;
-  enum?: Array<string>;
-  description?: string;
-};
-/**
- * A server from the source document, with `{variable}` placeholders filled from their defaults.
- */
-type InputServer = {
-  url: string;
-  description?: string;
-  /**
-   * Variables of the source URL template, copied as-is. `url` already has their defaults filled in, so
-   * this tells a templated server apart from a literal one. Absent when the server declares none.
-   */
-  variables?: Record<string, InputServerVariable>;
-};
-/**
- * An authentication scheme from the source document, keyed by `name`. `parameterName` is the header, query, or cookie name of an `apiKey`.
- */
-type InputSecurityScheme = {
-  name: string;
-  type: string;
-  description?: string;
-  scheme?: string;
-  bearerFormat?: string;
-  in?: string;
-  parameterName?: string;
-};
-/**
- * Metadata for an API document, populated by the adapter and available to every generator.
- * Every field is a plain JSON value.
- *
- * @example
- * ```ts
- * const meta: InputMeta = { title: 'Pet Store', version: '1.0.0', baseURL: 'https://api.example.com/v2' }
- * ```
- */
-type InputMeta = {
-  /**
-   * API title from `info.title` in the source document.
-   */
-  title?: string;
-  /**
-   * API description from `info.description` in the source document.
-   */
-  description?: string;
-  /**
-   * API version string from `info.version` in the source document.
-   */
-  version?: string;
-  /**
-   * Resolved base URL from the first matching server entry in the source document.
-   */
-  baseURL?: string | null;
-  servers?: Array<InputServer>;
-  securitySchemes?: Array<InputSecurityScheme>;
-  /**
-   * Vendor extensions (`x-*` keys) from the document root, copied as-is. Absent when the root has none.
-   */
-  extensions?: Record<string, unknown>;
-};
-/**
- * Input AST node that contains all schemas and operations for one API document.
- * Produced by the adapter and consumed by all Kubb plugins.
- *
- * @example
- * ```ts
- * const input: InputNode = {
- *   kind: 'Input',
- *   schemas: [],
- *   operations: [],
- *   meta: {},
- * }
- * ```
- */
-type InputNode = BaseNode & {
-  /**
-   * Node kind.
-   */
-  kind: 'Input';
-  /**
-   * All schema nodes in the document.
-   */
-  schemas: Array<SchemaNode>;
-  /**
-   * All operation nodes in the document.
-   */
-  operations: Array<OperationNode>;
-  /**
-   * Document metadata populated by the adapter.
-   */
-  meta: InputMeta;
-};
-/**
- * Creates an `InputNode`, defaulting `schemas`/`operations` to empty arrays and `meta` to an empty
- * object. Every call allocates fresh defaults so no two inputs share them.
- *
- * @example
- * ```ts
- * const input = createInput()
- * // { kind: 'Input', schemas: [], operations: [] }
- * ```
- */
-declare function createInput(overrides?: Partial<Omit<InputNode, 'kind'>>): InputNode;
 declare namespace index_d_exports$1 {
   export { Node, UserFileNode, createArrowFunction, createBreak, createConst, createContent, createExport, createFile, createFunction, createImport, createInput, createJsx, createOperation, createParameter, createProperty, createRequestBody, createResponse, createSchema, createSource, createText, createType };
 }