openapi-typesafe 1.0.0-rc.0 → 1.0.0-rc.2

package/dist/index.d.ts

@@ -1,10 +1,29 @@
 import { PathLike } from 'node:fs';
 import { Readable } from 'node:stream';
 import { Config } from '@redocly/openapi-core';
-import ts from 'typescript';
+import * as TypeScript from 'typescript';
 import colors from 'ansi-colors';
 
+/**
+ * Type IR: the closed set of immutable nodes that describes the TypeScript types and declarations
+ * the generator emits (ENGINEERING_PLAN §4.2, ADR-002). Nodes are plain readonly data with a `kind`
+ * discriminator; every consumer in this package dispatches with an exhaustive `switch`, so a new
+ * kind breaks the build wherever it must be handled. For users the set is open: a minor release
+ * may add a kind (ADR-034), so code outside the package must keep a node of an unknown kind as it
+ * is, and a `switch` over `kind` needs a `default` branch.
+ *
+ * Utility types (`Omit`, `Record`, `WithRequired`, `Extract`) are `reference` nodes with type
+ * arguments, built by named constructors: the printer has nothing special to do for them.
+ */
+/** Keyword types. `null` is a keyword here; TypeScript models it as a literal type. */
 type IrKeyword = "string" | "number" | "boolean" | "null" | "undefined" | "unknown" | "never";
+/**
+ * How a string literal is written.
+ * - `json`: `JSON.stringify` text, non-ASCII kept as is. The original writes literal types this way
+ *   to keep UTF-8 readable (TypeScript issue 36174).
+ * - `escaped`: TypeScript printer escaping, non-ASCII as `\uXXXX`. The original writes
+ *   indexed-access keys and quoted property names this way.
+ */
 type IrStringEncoding = "json" | "escaped";
 interface IrKeywordType {
     readonly kind: "keyword";
@@ -13,8 +32,10 @@ interface IrKeywordType {
 interface IrStringLiteralType {
     readonly kind: "stringLiteral";
     readonly value: string;
-    readonly encoding: IrStringEncoding;
+    /** How the printer writes the value; unset is `json`. A detail of the printer. */
+    readonly encoding?: IrStringEncoding;
 }
+/** Finite number; a negative value prints with a leading minus sign. */
 interface IrNumberLiteralType {
     readonly kind: "numberLiteral";
     readonly value: number;
@@ -23,6 +44,7 @@ interface IrBooleanLiteralType {
     readonly kind: "booleanLiteral";
     readonly value: boolean;
 }
+/** A named type, optionally with type arguments: `components`, `Record<string, never>`. */
 interface IrReferenceType {
     readonly kind: "reference";
     readonly name: string;
@@ -32,9 +54,11 @@ interface IrArrayType {
     readonly kind: "array";
     readonly element: IrType;
 }
+/** A tuple element; `isRest` prints `...T`, `isOptional` prints `T?` (never both). */
 interface IrTupleElement {
     readonly type: IrType;
     readonly isRest: boolean;
+    readonly isOptional: boolean;
 }
 interface IrTupleType {
     readonly kind: "tuple";
@@ -52,28 +76,48 @@ interface IrObjectType {
     readonly kind: "object";
     readonly members: readonly IrMember[];
 }
+/** `object[index]`, for example `components["schemas"]`. */
 interface IrIndexedAccessType {
     readonly kind: "indexedAccess";
     readonly object: IrType;
     readonly index: IrType;
 }
+/** `readonly T` (the only type operator the generator emits). */
 interface IrReadonlyType {
     readonly kind: "readonly";
     readonly type: IrType;
 }
+/**
+ * Text printed as is. Escape hatch for types that come from outside the IR, for example output of
+ * legacy `ts.Node` callbacks converted by the type-AST bridge (ENGINEERING_PLAN 6.3). The text is
+ * written as if it started at column 0: each line after the first gets the indentation of the
+ * position where the type is printed. Known limit: this also indents the continuation lines of a
+ * template literal that spans lines, which TypeScript keeps verbatim (ADR-004).
+ */
 interface IrRawType {
     readonly kind: "raw";
     readonly text: string;
+    /**
+     * @internal The TypeScript node the bridge printed the text from. The reverse bridge (the
+     * deprecated `ts.Node` callbacks, ADR-004) hands it back unchanged. Set by the generator only:
+     * read it as opaque, never set it, and expect it to go away in 2.0.
+     */
     readonly origin?: unknown;
 }
 type IrType = IrKeywordType | IrStringLiteralType | IrNumberLiteralType | IrBooleanLiteralType | IrReferenceType | IrArrayType | IrTupleType | IrUnionType | IrIntersectionType | IrObjectType | IrIndexedAccessType | IrReadonlyType | IrRawType;
-type IrComment = {
+/** A comment printed on its own line before a node; a node may have several, printed in order. */
+type IrComment = 
+/** `/*text*\/`: `text` is the comment body, for example `* @description Hello `. */
+{
     readonly kind: "block";
     readonly text: string;
-} | {
+}
+/** `//text`. */
+ | {
     readonly kind: "line";
     readonly text: string;
 };
+/** Property key: identifier, quoted string, or number, as decided by `toPropertyName`. */
 type IrPropertyName = {
     readonly kind: "identifier";
     readonly text: string;
@@ -92,6 +136,7 @@ interface IrPropertySignature {
     readonly isReadonly: boolean;
     readonly comments: readonly IrComment[];
 }
+/** `[parameterName: parameterType]: type`. */
 interface IrIndexSignature {
     readonly kind: "indexSignature";
     readonly parameterName: string;
@@ -115,6 +160,7 @@ interface IrTypeAliasDeclaration {
     readonly type: IrType;
     readonly comments: readonly IrComment[];
 }
+/** `name` is printed as given (already sanitized or quoted by the enum naming rules). */
 interface IrEnumMember {
     readonly name: string;
     readonly value: string | number;
@@ -127,6 +173,7 @@ interface IrEnumDeclaration {
     readonly members: readonly IrEnumMember[];
     readonly comments: readonly IrComment[];
 }
+/** `const name: type = [values];` (the `--enum-values` and `--make-paths-enum` arrays). */
 interface IrConstArrayDeclaration {
     readonly kind: "constArray";
     readonly name: string;
@@ -135,89 +182,233 @@ interface IrConstArrayDeclaration {
     readonly values: readonly (string | number)[];
     readonly comments: readonly IrComment[];
 }
+/** A declaration printed as is: footer helpers and injected code. */
 interface IrRawDeclaration {
     readonly kind: "rawDeclaration";
     readonly text: string;
+    /** The type name the text declares, when known (helper types), so the footer can find it. */
     readonly name?: string;
 }
 type IrDeclaration = IrInterfaceDeclaration | IrTypeAliasDeclaration | IrEnumDeclaration | IrConstArrayDeclaration | IrRawDeclaration;
 
-type FooterEntry = IrDeclaration | ts.Node;
-
-type DebugGroup = "redoc" | "lint" | "bundle" | "ts";
-interface Logger {
-    debug(message: string, group?: DebugGroup, durationMs?: number): void;
-    warn(message: string): void;
-    error(message: string): void;
+/**
+ * The TypeScript compiler's node types for code outside the bridge and for the public
+ * declarations (ADR-004, decision 4; ADR-032). Type-only: importing it never loads TypeScript.
+ *
+ * Each type is read from the compiler API of the `typescript` package the consumer has installed
+ * (`factory`, `createPrinter`), not named as `ts.Node`. TypeScript 5.x and 6.x have that API, so
+ * the types are the compiler's own. TypeScript 7's `typescript` package exports only `version`;
+ * `ts.Node` there is error TS2694 in a consumer that checks declarations (`skipLibCheck: false`).
+ */
+type Api = typeof TypeScript;
+type Factory = Api extends {
+    readonly factory: infer F;
+} ? F : undefined;
+/**
+ * A compiler type when the installed `typescript` has no compiler API (TypeScript 7). It is `any`
+ * because that is what these types already were for such a consumer with `skipLibCheck: true`
+ * (an unresolved type in a declaration file is `any`), so callbacks that build or read nodes of
+ * `@typescript/typescript6` keep compiling (ADR-032). The cost, as before: a union with a node
+ * type, such as the result of `transform`, accepts any value there.
+ */
+type WithoutCompilerApi = any;
+/** The node type that `factory[Name]` returns, or `WithoutCompilerApi`. */
+type Created<Name extends string> = Factory extends {
+    readonly [Key in Name]: (...args: never[]) => infer Result;
+} ? Result : WithoutCompilerApi;
+type ModifierList = Created<"createModifiersFromModifierFlags">;
+/** The compiler node types the package names; see the module comment. */
+declare namespace ts {
+    type Node = Api extends {
+        isTypeNode(node: infer N): boolean;
+    } ? N : WithoutCompilerApi;
+    type TypeNode = Factory extends {
+        createArrayTypeNode(elementType: infer T): unknown;
+    } ? T : WithoutCompilerApi;
+    type QuestionToken = Factory extends {
+        createPropertySignature(modifiers: never, name: never, token: infer Q, type: never): unknown;
+    } ? NonNullable<Q> : WithoutCompilerApi;
+    type Modifier = ModifierList extends readonly (infer M)[] | undefined ? M : WithoutCompilerApi;
+    type PrinterOptions = Api extends {
+        createPrinter(options?: infer O, ...rest: never[]): unknown;
+    } ? NonNullable<O> : WithoutCompilerApi;
+    type PropertySignature = Created<"createPropertySignature">;
+    type LiteralTypeNode = Created<"createLiteralTypeNode">;
+    type TypeLiteralNode = Created<"createTypeLiteralNode">;
+    type InterfaceDeclaration = Created<"createInterfaceDeclaration">;
+    type EnumDeclaration = Created<"createEnumDeclaration">;
+    type EnumMember = Created<"createEnumMember">;
+    type VariableStatement = Created<"createVariableStatement">;
+    type Identifier = Created<"createIdentifier">;
+    type NumericLiteral = Created<"createNumericLiteral">;
+    type StringLiteral = Created<"createStringLiteral">;
 }
 
+/** A footer entry: a declaration in IR, or a TypeScript node added by user code. */
+type FooterEntry = IrDeclaration | ts.Node;
+
+/**
+ * Opt-in fixes of the output of valid schemas (ADR-021). Each one changes only the cases it names;
+ * without any, the output is the same as openapi-typescript 7.13 gives. In 2.0 they become the
+ * default.
+ */
 declare const OutputFix: {
+    /** An `allOf` `$ref` to a discriminated union is the union, without `Omit` or a schema name. */
+    readonly ALLOF_DISCRIMINATED_UNION: "allof-discriminated-union";
+    /** An `allOf` member with only `required` makes those properties of the others required. */
     readonly ALLOF_REQUIRED: "allof-required";
+    /** The JSDoc of a schema lists the descriptions of its `anyOf` and `oneOf` members. */
+    readonly ANYOF_ONEOF_DESCRIPTIONS: "anyof-oneof-descriptions";
+    /** `anyOf` / `oneOf` variants with only `required` make those keys of the parent required. */
+    readonly ANYOF_ONEOF_REQUIRED: "anyof-oneof-required";
+    /** `anyOf` next to object keywords or `allOf` is intersected with them, not added to a union. */
     readonly ANYOF_PROPERTIES: "anyof-properties";
+    /** `--array-length` tuples have `min` to `max` items, nest right and follow `--immutable`. */
     readonly ARRAY_LENGTH_TUPLES: "array-length-tuples";
+    /** `--dedupe-enums` names a shared enum by all of its schemas, not by the first one. */
+    readonly DEDUPE_ENUM_NAMES: "dedupe-enum-names";
+    /** `required` next to an `allOf` `$ref` to a discriminator member still gives `WithRequired`. */
+    readonly DISCRIMINATOR_MEMBER_REQUIRED: "discriminator-member-required";
+    /**
+     * The value a discriminator member gets: one enum of every discriminator's values, a mapping
+     * before the schema name, a schema's own mapping before an inherited one, none where the member
+     * declares it, and with `--enum` a member of the owner's enum.
+     */
     readonly DISCRIMINATOR_VALUES: "discriminator-values";
+    /** An exploded object query parameter's properties are keys of `query`, as they are sent. */
+    readonly EXPLODED_QUERY_OBJECTS: "exploded-query-objects";
+    /** `--enum` declares an enum that lists `null` without it, and the type adds `| null`. */
+    readonly NULLABLE_ENUMS: "nullable-enums";
+    /** `--path-params-as-types` gives each `{name}` its placeholder, `{number}` included. */
+    readonly PATH_PARAM_TYPE_NAMES: "path-param-type-names";
+    /** A `prefixItems` tuple is open unless `items` or `unevaluatedItems` closes it (2020-12). */
+    readonly PREFIX_ITEMS: "prefix-items";
+    /** `readOnly` and `writeOnly` of the schema a `$ref` names, or of `allOf` members, count. */
+    readonly READ_WRITE_REFS: "read-write-refs";
+    /**
+     * A `$ref` into schema keywords (`content/<type>/schema`, `items`, `allOf/0`) gets the type it
+     * points at, also where the original type compiles through an index signature.
+     */
+    readonly REF_POINTERS: "ref-pointers";
+    /** Schemas of one root type name without the prefix each get an alias, the earlier numbered. */
     readonly ROOT_TYPE_NUMBERING: "root-type-numbering";
+    /** `unevaluatedProperties` types the keys no other keyword declares (an index signature). */
     readonly UNEVALUATED_PROPERTIES: "unevaluated-properties";
 };
 type OutputFix = (typeof OutputFix)[keyof typeof OutputFix];
+/** Every fix of this version, in the order the docs list them. */
 declare const OUTPUT_FIXES: readonly OutputFix[];
+/** The name that turns on every fix of the installed version. */
 declare const ALL_OUTPUT_FIXES = "all";
+/** A name the `fix` option accepts: one fix, or `all`. */
 type OutputFixName = OutputFix | typeof ALL_OUTPUT_FIXES;
 
-interface EnumMemberMetadata {
-    readonly name: string | undefined;
-    readonly description: string | undefined;
-}
-interface EnumDeclarationRequest {
-    readonly name: string;
-    readonly values: readonly (string | number)[];
-    readonly metadata: readonly EnumMemberMetadata[];
-}
-interface EnumValuesRequest {
-    readonly name: string;
-    readonly type: IrType;
-    readonly values: readonly (string | number)[];
-}
-interface FooterDeclarations {
-    addEnum(request: EnumDeclarationRequest): string;
-    addEnumValues(request: EnumValuesRequest): void;
-    requireWithRequired(): void;
-    requirePropertyValues(): void;
-}
-
-interface DocumentFooter extends FooterDeclarations {
-    addOperation(build: () => IrPropertySignature): void;
-}
-
 interface Extensable {
     [key: `x-${string}`]: any;
 }
+/**
+ * [4.8.5] Server Object
+ * An object representing a Server.
+ */
 interface ServerObject extends Extensable {
+    /**
+     * REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to
+     * indicate that the host location is relative to the location where the OpenAPI document is being
+     * served. Variable substitutions will be made when a variable is named in {brackets}.
+     */
     url: string;
+    /**
+     * An optional string describing the host designated by the URL. CommonMark syntax MAY be used for
+     * rich text representation.
+     */
     description: string;
+    /**
+     * A map between a variable name and its value. The value is used for substitution in the server’s
+     * URL template.
+     */
     variables: {
         [name: string]: ServerVariableObject;
     };
 }
+/**
+ * [4.8.6] Server Variable Object
+ * An object representing a Server Variable for server URL template substitution.
+ */
 interface ServerVariableObject extends Extensable {
+    /**
+     * An enumeration of string values to be used if the substitution options are from a limited set.
+     * The array MUST NOT be empty.
+     */
     enum?: string[];
+    /**
+     * REQUIRED. The default value to use for substitution, which SHALL be sent if an alternate value
+     * is not supplied. Note this behavior is different than the Schema Object’s treatment of default
+     * values, because in those cases parameter values are optional. If the enum is defined, the value
+     * MUST exist in the enum’s values.
+     */
     default: string;
+    /**
+     * An optional description for the server variable. CommonMark syntax MAY be used for rich text
+     * representation.
+     */
     description?: string;
 }
+/**
+ * [4.8.11] External Documentation Object
+ * Allows referencing an external resource for extended documentation.
+ */
 interface ExternalDocumentationObject extends Extensable {
+    /**
+     * A description of the target documentation. CommonMark syntax MAY be used for rich text
+     * representation.
+     */
     description?: string;
+    /** REQUIRED. The URL for the target documentation. This MUST be in the form of a URL. */
     url: string;
 }
+/**
+ * [4.8.23] Reference Object
+ * A simple object to allow referencing other components in the OpenAPI document, internally and
+ * externally. The $ref string value contains a URI [RFC3986], which identifies the location of the
+ * value being referenced. See the rules for resolving Relative References.
+ */
 interface ReferenceObject extends Extensable {
+    /** REQUIRED. The reference identifier. This MUST be in the form of a URI. */
     $ref: string;
+    /**
+     * A short summary which by default SHOULD override that of the referenced component. If the
+     * referenced object-type does not allow a summary field, then this field has no effect.
+     */
     summary?: string;
+    /**
+     * A description which by default SHOULD override that of the referenced component. CommonMark
+     * syntax MAY be used for rich text representation. If the referenced object-type does not allow a
+     * description field, then this field has no effect.
+     */
     description?: string;
 }
 
+/**
+ * [4.8.24] Schema Object
+ * The Schema Object allows the definition of input and output data types. These types can be
+ * objects, but also primitives and arrays. This object is a superset of the JSON Schema
+ * Specification Draft 2020-12.
+ */
 type SchemaObject = {
+    /**
+     * The Schema Object allows the definition of input and output data types. These types can be
+     * objects, but also primitives and arrays. This object is a superset of the JSON Schema
+     * Specification Draft 2020-12.
+     */
     discriminator?: DiscriminatorObject;
+    /**
+     * MAY be used only on properties schemas. It has no effect on root schemas. Adds additional
+     * metadata to describe the XML representation of this property.
+     */
     xml?: XMLObject;
+    /** Additional external documentation for this schema. */
     externalDocs?: ExternalDocumentationObject;
+    /** @deprecated */
     example?: any;
     title?: string;
     description?: string;
@@ -226,12 +417,19 @@ type SchemaObject = {
     readOnly?: boolean;
     writeOnly?: boolean;
     enum?: unknown[];
+    /**
+     * Use of this keyword is functionally equivalent to an "enum" (Section 6.1.2) with a single
+     * value.
+     */
     const?: unknown;
     default?: unknown;
     format?: string;
+    /** Media type of the string contents (OpenAPI 3.1, JSON Schema 2020-12), e.g. `image/png`. */
     contentMediaType?: string;
+    /** How the string's contents are encoded (OpenAPI 3.1, JSON Schema 2020-12), e.g. `base64`. */
     contentEncoding?: string;
     additionalProperties?: boolean | Record<string, never> | SchemaObject | ReferenceObject;
+    /** @deprecated in 3.1 (still valid for 3.0) */
     nullable?: boolean;
     oneOf?: (SchemaObject | ReferenceObject)[];
     allOf?: (SchemaObject | ReferenceObject)[];
@@ -288,298 +486,922 @@ interface ObjectSubtype {
     enum?: (SchemaObject | ReferenceObject)[];
     $defs?: $defs;
 }
+/**
+ * [4.8.25] Discriminator Object
+ * When request bodies or response payloads may be one of a number of different schemas, a
+ * discriminator object can be used to aid in serialization, deserialization, and validation. The
+ * discriminator is a specific object in a schema which is used to inform the consumer of the
+ * document of an alternative schema based on the value associated with it.
+ */
 interface DiscriminatorObject {
+    /**
+     * The name of the property in the payload that will hold the discriminator value. Required
+     * before OpenAPI 3.2; typed as required so existing readers keep a `string`.
+     */
     propertyName: string;
+    /** An object to hold mappings between payload values and schema names or references. */
     mapping?: Record<string, string>;
+    /** The schema for payloads without the property or with an unmapped value (OpenAPI 3.2). */
     defaultMapping?: string;
+    /** If this exists, then a discriminator type should be added to objects matching this path */
     oneOf?: string[];
 }
+/**
+ * [4.8.26] XML Object
+ * A metadata object that allows for more fine-tuned XML model definitions. When using arrays, XML
+ * element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used
+ * to add that information. See examples for expected behavior.
+ */
 interface XMLObject extends Extensable {
+    /**
+     * Replaces the name of the element/attribute used for the described schema property. When defined
+     * within `items`, it will affect the name of the individual XML elements within the list. When
+     * defined alongside `type` being `array` (outside the `items`), it will affect the wrapping
+     * element and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored.
+     */
     name?: string;
+    /** The URI of the namespace definition. This MUST be in the form of an absolute URI. */
     namespace?: string;
+    /** The prefix to be used for the name. */
     prefix?: string;
+    /**
+     * Declares whether the property definition translates to an attribute instead of an element.
+     * Default value is `false`.
+     */
     attribute?: boolean;
+    /**
+     * MAY be used only for an array definition. Signifies whether the array is wrapped (for example,
+     * `<books><book/><book/></books>`) or unwrapped (`<book/><book/>`). Default value is `false`. The
+     * definition takes effect only when defined alongside `type` being `array` (outside the `items`).
+     */
     wrapped?: boolean;
 }
+/** The `$defs` of a Schema Object: named subschemas. */
 type $defs = Record<string, SchemaObject>;
 
+/**
+ * [4.8.12] Parameter Object
+ * Describes a single operation parameter.
+ * A unique parameter is defined by a combination of a name and location.
+ */
 interface ParameterObject extends Extensable {
+    /**
+     * REQUIRED. The name of the parameter. Parameter names are case sensitive.
+     *
+     * - If `in` is `"path"`, the `name` field MUST correspond to a template expression occurring
+     * within the path field in the Paths Object. See Path Templating for further information.
+     * - If `in` is `"header"` and the `name` field is `"Accept"`, `"Content-Type"` or
+     * `"Authorization"`, the parameter definition SHALL be ignored.
+     * - For all other cases, the `name` corresponds to the parameter name used by the `in` property.
+     */
     name: string;
+    /**
+     * REQUIRED. The location of the parameter. Possible values are "query", "header", "path",
+     * "cookie", or "querystring" (OpenAPI 3.2: the whole query string, described by `content`).
+     */
     in: "query" | "header" | "path" | "cookie" | "querystring";
+    /**
+     * A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY
+     * be used for rich text representation.
+     */
     description?: string;
+    /**
+     * Determines whether this parameter is mandatory. If the parameter location is "path", this
+     * property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and
+     * its default value is false.
+     */
     required?: boolean;
+    /**
+     * Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value
+     * is false.
+     */
     deprecated?: boolean;
+    /**
+     * Sets the ability to pass empty-valued parameters. This is valid only for query parameters and
+     * allows sending a parameter with an empty value. Default value is false. If style is used, and
+     * if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use
+     * of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.
+     */
     allowEmptyValue?: boolean;
+    /**
+     * Describes how the parameter value will be serialized depending on the type of the parameter
+     * value. Default values (based on value of in): for query - form; for path - simple; for header -
+     * simple; for cookie - form.
+     */
     style?: string;
+    /**
+     * When this is true, parameter values of type `array` or `object` generate separate parameters
+     * for each value of the array or key-value pair of the map. For other types of parameters this
+     * property has no effect. When `style` is `form`, the default value is `true`. For all other
+     * styles, the default value is `false`.
+     */
     explode?: boolean;
+    /**
+     * Determines whether the parameter value SHOULD allow reserved characters, as defined by
+     * [RFC3986] `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only
+     * applies to parameters with an `in` value of `query`. The default value is `false`.
+     */
     allowReserved?: boolean;
+    /** The schema defining the type used for the parameter. */
     schema?: SchemaObject;
+    /** Example of the parameter’s potential value. */
     example?: any;
+    /** Examples of the parameter’s potential value. */
     examples?: {
         [name: string]: ExampleObject | ReferenceObject;
     };
+    /** A map containing the representations for the parameter. */
     content?: {
         [contentType: string]: MediaTypeObject | ReferenceObject;
     };
 }
+/**
+ * [4.8.13] Request Body Object
+ * Describes a single request body.
+ */
 interface RequestBodyObject extends Extensable {
+    /**
+     * A brief description of the request body. This could contain examples of use. CommonMark syntax
+     * MAY be used for rich text representation.
+     */
     description?: string;
+    /**
+     * REQUIRED. The content of the request body. The key is a media type or media type range and the
+     * value describes it. For requests that match multiple keys, only the most specific key is
+     * applicable. e.g. text/plain overrides text
+     */
     content: {
         [contentType: string]: MediaTypeObject | ReferenceObject;
     };
+    /** Determines if the request body is required in the request. Defaults to false. */
     required?: boolean;
 }
+/**
+ * [4.8.14] Media Type Object
+ */
 interface MediaTypeObject extends Extensable {
+    /** The schema defining the content of the request, response, or parameter. */
     schema?: SchemaObject | ReferenceObject;
+    /**
+     * The schema of each item of a sequential media type such as `application/jsonl` or
+     * `text/event-stream` (OpenAPI 3.2).
+     */
     itemSchema?: SchemaObject | ReferenceObject;
+    /**
+     * Example of the media type. The example object SHOULD be in the correct format as specified by
+     * the media type. The example field is mutually exclusive of the examples field. Furthermore, if
+     * referencing a schema which contains an example, the example value SHALL override the example
+     * provided by the schema.
+     */
     example?: any;
+    /**
+     * Examples of the media type. Each example object SHOULD match the media type and specified
+     * schema if present. The examples field is mutually exclusive of the example field. Furthermore,
+     * if referencing a schema which contains an example, the examples value SHALL override the
+     * example provided by the schema.
+     */
     examples?: {
         [name: string]: ExampleObject | ReferenceObject;
     };
+    /**
+     * A map between a property name and its encoding information. The key, being the property name,
+     * MUST exist in the schema as a property. The encoding object SHALL only apply to requestBody
+     * objects when the media type is multipart or application/x-www-form-urlencoded.
+     */
     encoding?: {
         [propertyName: string]: EncodingObject;
     };
 }
+/**
+ * [4.8.15] Encoding Object
+ * A single encoding definition applied to a single schema property.
+ */
 interface EncodingObject extends Extensable {
+    /**
+     * The Content-Type for encoding a specific property. Default value depends on the property type:
+     * for object - application/json; for array – the default is defined based on the inner type; for
+     * all other cases the default is application/octet-stream. The value can be a specific media type
+     * (e.g. application/json), a wildcard media type (e.g. image/*), or a comma-separated list of the
+     * two types.
+     */
     contentType?: string;
+    /**
+     * A map allowing additional information to be provided as headers, for example
+     * Content-Disposition. Content-Type is described separately and SHALL be ignored in this section.
+     * This property SHALL be ignored if the request body media type is not a multipart.
+     */
     headers?: {
         [name: string]: HeaderObject | ReferenceObject;
     };
+    /**
+     * Describes how a specific property value will be serialized depending on its type. See Parameter
+     * Object for details on the style property. The behavior follows the same values as query
+     * parameters, including default values. This property SHALL be ignored if the request body media
+     * type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly
+     * defined, then the value of contentType (implicit or explicit) SHALL be ignored.
+     */
     style?: string;
+    /**
+     * When this is true, property values of type array or object generate separate parameters for
+     * each value of the array, or key-value-pair of the map. For other types of properties this
+     * property has no effect. When style is form, the default value is true. For all other styles,
+     * the default value is false. This property SHALL be ignored if the request body media type is
+     * not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined,
+     * then the value of contentType (implicit or explicit) SHALL be ignored.
+     */
     explode?: string;
+    /**
+     * Determines whether the parameter value SHOULD allow reserved characters, as defined by
+     * [RFC3986] :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is
+     * false. This property SHALL be ignored if the request body media type is not
+     * application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined,
+     * then the value of contentType (implicit or explicit) SHALL be ignored.
+     */
     allowReserved?: string;
 }
+/**
+ * [4.8.19[ Example Object
+ */
 interface ExampleObject extends Extensable {
+    /** Short description for the example. */
     summary?: string;
+    /**
+     * Long description for the example. CommonMark syntax MAY be used for rich text representation.
+     */
     description?: string;
+    /**
+     * Embedded literal example. The value field and externalValue field are mutually exclusive. To
+     * represent examples of media types that cannot naturally represented in JSON or YAML, use a
+     * string value to contain the example, escaping where necessary.
+     */
     value?: any;
+    /**
+     * A URI that points to the literal example. This provides the capability to reference examples
+     * that cannot easily be included in JSON or YAML documents. The value field and externalValue
+     * field are mutually exclusive. See the rules for resolving Relative References.
+     */
     externalValue?: string;
 }
+/**
+ * [4.8.21] Header Object
+ * The Header Object follows the structure of the Parameter Object with the following changes:
+ *
+ * 1. `name` MUST NOT be specified, it is given in the corresponding `headers` map.
+ * 2. `in` MUST NOT be specified, it is implicitly in `header`.
+ * 3. All traits that are affected by the location MUST be applicable to a location of `heade`r (for
+ * example, `style`).
+ */
 type HeaderObject = Omit<ParameterObject, "name" | "in">;
 
+/**
+ * [4.8.16] Responses Object
+ * A container for the expected responses of an operation. The container maps a HTTP response code
+ * to the expected response.
+ */
 type ResponsesObject = {
     [responseCode: string]: ResponseObject | ReferenceObject;
 } & {
+    /**
+     * The documentation of responses other than the ones declared for specific HTTP response codes.
+     * Use this field to cover undeclared responses.
+     */
     default?: ResponseObject | ReferenceObject;
 };
+/**
+ * [4.8.17] Response Object
+ * Describes a single response from an API Operation, including design-time, static links to
+ * operations based on the response.
+ */
 interface ResponseObject extends Extensable {
+    /**
+     * REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text
+     * representation.
+     */
     description: string;
+    /**
+     * Maps a header name to its definition. [RFC7230] states header names are case insensitive. If a
+     * response header is defined with the name "Content-Type", it SHALL be ignored.
+     */
     headers?: {
         [name: string]: HeaderObject | ReferenceObject;
     };
+    /**
+     * A map containing descriptions of potential response payloads. The key is a media type or media
+     * type range and the value describes it. For responses that match multiple keys, only the most
+     * specific key is applicable. e.g. text/plain overrides text
+     */
     content?: {
         [contentType: string]: MediaTypeObject;
     };
+    /**
+     * A map of operations links that can be followed from the response. The key of the map is a short
+     * name for the link, following the naming constraints of the names for Component Objects.
+     */
     links?: {
         [name: string]: LinkObject | ReferenceObject;
     };
 }
+/**
+ * [4.8.20] Link Object
+ * The Link object represents a possible design-time link for a response. The presence of a link
+ * does not guarantee the caller’s ability to successfully invoke it, rather it provides a known
+ * relationship and traversal mechanism between responses and other operations.
+ */
 interface LinkObject extends Extensable {
+    /**
+     * A relative or absolute URI reference to an OAS operation. This field is mutually exclusive of
+     * the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY
+     * be used to locate an existing Operation Object in the OpenAPI definition. See the rules for
+     * resolving Relative References.
+     */
     operationRef?: string;
+    /**
+     * The name of an existing, resolvable OAS operation, as defined with a unique operationId. This
+     * field is mutually exclusive of the operationRef field.
+     */
     operationId?: string;
+    /**
+     * A map representing parameters to pass to an operation as specified with operationId or
+     * identified via operationRef. The key is the parameter name to be used, whereas the value can be
+     * a constant or an expression to be evaluated and passed to the linked operation. The parameter
+     * name can be qualified using the parameter location [{in}.]{name} for operations that use the
+     * same parameter name in different locations (e.g. path.id).
+     */
     parameters?: {
         [name: string]: `$${string}`;
     };
+    /** A literal value or {expression} to use as a request body when calling the target operation. */
     requestBody?: `$${string}`;
+    /** A description of the link. CommonMark syntax MAY be used for rich text representation. */
     description?: string;
+    /** A server object to be used by the target operation. */
     server?: ServerObject;
 }
 
+/**
+ * [4.8.27] Security Scheme Object
+ * Defines a security scheme that can be used by the operations.
+ */
 type SecuritySchemeObject = {
+    /**
+     * A description for security scheme. CommonMark syntax MAY be used for rich text representation.
+     */
     description?: string;
     [key: `x-${string}`]: any;
 } & ({
+    /** REQUIRED. The type of the security scheme. */
     type: "apiKey";
+    /** REQUIRED. The name of the header, query or cookie parameter to be used. */
     name: string;
+    /** REQUIRED. The location of the API key. */
     in: "query" | "header" | "cookie";
 } | {
+    /** REQUIRED. The type of the security scheme. */
     type: "http";
+    /**
+     * REQUIRED. The name of the HTTP Authorization scheme to be used in the Authorization header
+     * as defined in [RFC7235]. The values used SHOULD be registered in the IANA Authentication
+     * Scheme registry.
+     */
     scheme: string;
+    /**
+     * A hint to the client to identify how the bearer token is formatted. Bearer tokens are
+     * usually generated by an authorization server, so this information is primarily for
+     * documentation purposes.
+     */
     bearer?: string;
 } | {
+    /** REQUIRED. The type of the security scheme. */
     type: "mutualTLS";
 } | {
+    /** REQUIRED. Tye type of the security scheme. */
     type: "oauth2";
+    /** REQUIRED. An object containing configuration information for the flow types supported. */
     flows: OAuthFlowsObject;
 } | {
+    /** REQUIRED. Tye type of the security scheme. */
     type: "openIdConnect";
+    /**
+     * REQUIRED. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the
+     * form of a URL. The OpenID Connect standard requires the use of TLS.
+     */
     openIdConnectUrl: string;
 });
+/**
+ * [4.8.26] OAuth Flows Object
+ * Allows configuration of the supported OAuth Flows.
+ */
 interface OAuthFlowsObject extends Extensable {
+    /** Configuration for the OAuth Implicit flow */
     implicit?: OAuthFlowObject;
+    /** Configuration for the OAuth Resource Owner Password flow */
     password?: OAuthFlowObject;
+    /**
+     * Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI
+     * 2.0.
+     */
     clientCredentials?: OAuthFlowObject;
+    /**
+     * Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI
+     * 2.0.
+     */
     authorizationCode?: OAuthFlowObject;
 }
+/**
+ * [4.8.29] OAuth Flow Object
+ * Configuration details for a supported OAuth Flow
+ */
 interface OAuthFlowObject extends Extensable {
+    /**
+     * REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL.
+     * The OAuth2 standard requires the use of TLS.
+     */
     authorizationUrl: string;
+    /**
+     * REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2
+     * standard requires the use of TLS.
+     */
     tokenUrl: string;
+    /**
+     * The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2
+     * standard requires the use of TLS.
+     */
     refreshUrl: string;
+    /**
+     * REQUIRED. The available scopes for the OAuth2 security scheme. A map between the scope name and
+     * a short description for it. The map MAY be empty.
+     */
     scopes: {
         [name: string]: string;
     };
 }
+/**
+ * [4.8.30] Security Requirements Object
+ * Lists the required security schemes to execute this operation. The name used for each property
+ * MUST correspond to a security scheme declared in the Security Schemes under the Components
+ * Object.
+ */
 type SecurityRequirementObject = {
     [P in keyof ComponentsObject["securitySchemes"]]?: string[];
 };
 
+/**
+ * [4.8.9] Path Item Object
+ * Describes the operations available on a single path. A Path Item MAY be empty, due to ACL
+ * constraints. The path itself is still exposed to the documentation viewer but they will not know
+ * which operations and parameters are available.
+ */
 interface PathItemObject extends Extensable {
+    /** A definition of a GET operation on this path. */
     get?: OperationObject | ReferenceObject;
+    /** A definition of a PUT operation on this path. */
     put?: OperationObject | ReferenceObject;
+    /** A definition of a POST operation on this path. */
     post?: OperationObject | ReferenceObject;
+    /** A definition of a DELETE operation on this path. */
     delete?: OperationObject | ReferenceObject;
+    /** A definition of a OPTIONS operation on this path. */
     options?: OperationObject | ReferenceObject;
+    /** A definition of a HEAD operation on this path. */
     head?: OperationObject | ReferenceObject;
+    /** A definition of a PATCH operation on this path. */
     patch?: OperationObject | ReferenceObject;
+    /** A definition of a TRACE operation on this path. */
     trace?: OperationObject | ReferenceObject;
+    /** A definition of a QUERY operation on this path (OpenAPI 3.2). */
     query?: OperationObject | ReferenceObject;
+    /**
+     * Operations for other HTTP methods, keyed by the method name exactly as it is sent
+     * (OpenAPI 3.2). The fixed methods above must not appear here.
+     */
     additionalOperations?: Record<string, OperationObject | ReferenceObject>;
+    /** An alternative server array to service all operations in this path. */
     servers?: ServerObject[];
+    /**
+     * A list of parameters that are applicable for all the operations described under this path.
+     * These parameters can be overridden at the operation level, but cannot be removed there. The
+     * list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of
+     * a name and location. The list can use the Reference Object to link to parameters that are
+     * defined at the OpenAPI Object’s components/parameters.
+     */
     parameters?: (ParameterObject | ReferenceObject)[];
 }
+/**
+ * [4.8.10] Operation Object
+ * Describes a single API operation on a path.
+ */
 interface OperationObject extends Extensable {
+    /**
+     * A list of tags for API documentation control. Tags can be used for logical grouping of
+     * operations by resources or any other qualifier.
+     */
     tags?: string[];
+    /** A short summary of what the operation does. */
     summary?: string;
+    /**
+     * A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text
+     * representation.
+     */
     description?: string;
+    /** Additional external documentation for this operation. */
     externalDocs?: ExternalDocumentationObject;
+    /**
+     * Unique string used to identify the operation. The id MUST be unique among all operations
+     * described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the
+     * operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common
+     * programming naming conventions.
+     */
     operationId?: string;
+    /**
+     * A list of parameters that are applicable for this operation. If a parameter is already defined
+     * at the Path Item, the new definition will override it but can never remove it. The list MUST
+     * NOT include duplicated parameters. A unique parameter is defined by a combination of a name and
+     * location. The list can use the Reference Object to link to parameters that are defined at the
+     * OpenAPI Object’s components/parameters.
+     */
     parameters?: (ParameterObject | ReferenceObject)[];
+    /**
+     * The request body applicable for this operation. The requestBody is fully supported in HTTP
+     * methods where the HTTP 1.1 specification [RFC7231] has explicitly defined semantics for request
+     * bodies. In other cases where the HTTP spec is vague (such as GET, HEAD and DELETE), requestBody
+     * is permitted but does not have well-defined semantics and SHOULD be avoided if possible.
+     */
     requestBody?: RequestBodyObject | ReferenceObject;
+    /** The list of possible responses as they are returned from executing this operation. */
     responses?: ResponsesObject;
+    /**
+     * A map of possible out-of band callbacks related to the parent operation. The key is a unique
+     * identifier for the Callback Object. Each value in the map is a Callback Object that describes a
+     * request that may be initiated by the API provider and the expected responses.
+     */
     callbacks?: Record<string, CallbackObject | ReferenceObject>;
+    /**
+     * Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared
+     * operation. Default value is false.
+     */
     deprecated?: boolean;
+    /**
+     * A declaration of which security mechanisms can be used for this operation. The list of values
+     * includes alternative security requirement objects that can be used. Only one of the security
+     * requirement objects need to be satisfied to authorize a request. To make security optional, an
+     * empty security requirement ({}) can be included in the array. This definition overrides any
+     * declared top-level security. To remove a top-level security declaration, an empty array can be
+     * used.
+     */
     security?: SecurityRequirementObject[];
+    /**
+     * An alternative server array to service this operation. If an alternative server object is
+     * specified at the Path Item Object or Root level, it will be overridden by this value.
+     */
     servers?: ServerObject[];
 }
+/**
+ * [4.8.18] Callback Object
+ * A map of possible out-of band callbacks related to the parent operation. Each value in the map is
+ * a Path Item Object that describes a set of requests that may be initiated by the API provider and
+ * the expected responses. The key value used to identify the path item object is an expression,
+ * evaluated at runtime, that identifies a URL to use for the callback operation.
+ */
 type CallbackObject = Record<string, PathItemObject>;
 
+/**
+ * [4.8] Schema
+ * @see https://spec.openapis.org/oas/v3.1.0#schema
+ */
 interface OpenAPI3 extends Extensable {
+    /**
+     * REQUIRED. This string MUST be the version number of the OpenAPI Specification that the OpenAPI
+     * document uses. The openapi field SHOULD be used by tooling to interpret the OpenAPI document.
+     * This is not related to the API info.version string.
+     */
     openapi: string;
+    /** REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required. */
     info: InfoObject;
+    /**
+     * The default value for the $schema keyword within Schema Objects contained within this OAS
+     * document. This MUST be in the form of a URI.
+     */
     jsonSchemaDialect?: string;
+    /**
+     * An array of Server Objects, which provide connectivity information to a target server. If the
+     * servers property is not provided, or is an empty array, the default value would be a Server
+     * Object with a url value of /.
+     */
     servers?: ServerObject[];
+    /** The available paths and operations for the API. */
     paths?: PathsObject;
+    /**
+     * The incoming webhooks that MAY be received as part of this API and that the API consumer MAY
+     * choose to implement. Closely related to the callbacks feature, this section describes requests
+     * initiated other than by an API call, for example by an out of band registration. The key name
+     * is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object
+     * describes a request that may be initiated by the API provider and the expected responses. An
+     * example is available.
+     */
     webhooks?: {
         [id: string]: PathItemObject | ReferenceObject;
     };
+    /** An element to hold various schemas for the document. */
     components?: ComponentsObject;
+    /**
+     * A declaration of which security mechanisms can be used across the API. The list of values
+     * includes alternative security requirement objects that can be used. Only one of the security
+     * requirement objects need to be satisfied to authorize a request. Individual operations can
+     * override this definition. To make security optional, an empty security requirement ({}) can be
+     * included in the array.
+     */
     security?: SecurityRequirementObject[];
+    /**
+     * A list of tags used by the document with additional metadata. The order of the tags can be used
+     * to reflect on their order by the parsing tools. Not all tags that are used by the Operation
+     * Object must be declared. The tags that are not declared MAY be organized randomly or based on
+     * the tools’ logic. Each tag name in the list MUST be unique.
+     */
     tags?: TagObject[];
+    /** Additional external documentation. */
     externalDocs?: ExternalDocumentationObject;
     $defs?: $defs;
 }
+/**
+ * [4.8.2] Info Object
+ * The object provides metadata about the API.
+ */
 interface InfoObject extends Extensable {
+    /** REQUIRED. The title of the API. */
     title: string;
+    /** A short summary of the API. */
     summary?: string;
+    /** A description of the API. CommonMark syntax MAY be used for rich text representation. */
     description?: string;
+    /** A URL to the Terms of Service for the API. This MUST be in the form of a URL. */
     termsOfService?: string;
+    /** The contact information for the exposed API. */
     contact?: ContactObject;
+    /** The license information for the exposed API. */
     license?: LicenseObject;
+    /**
+     * REQUIRED. The version of the OpenAPI document (which is distinct from the OpenAPI Specification
+     * version or the API implementation version).
+     */
     version: string;
 }
+/**
+ * [4.8.3] Contact Object
+ * Contact information for the exposed API.
+ */
 interface ContactObject extends Extensable {
+    /** The identifying name of the contact person/organization. */
     name?: string;
+    /** The URL pointing to the contact information. This MUST be in the form of a URL. */
     url?: string;
+    /**
+     * The email address of the contact person/organization. This MUST be in the form of an email
+     * address.
+     */
     email?: string;
 }
+/**
+ * [4.8.4] License object
+ * License information for the exposed API.
+ */
 interface LicenseObject extends Extensable {
+    /** REQUIRED. The license name used for the API. */
     name: string;
+    /**
+     * An SPDX license expression for the API. The identifier field is mutually exclusive of the url
+     * field.
+     */
     identifier: string;
+    /**
+     * A URL to the license used for the API. This MUST be in the form of a URL. The url field is
+     * mutually exclusive of the identifier field.
+     */
     url: string;
 }
+/**
+ * [4.8.7] Components Object
+ * Holds a set of reusable objects for different aspects of the OAS.
+ */
 interface ComponentsObject extends Extensable {
+    /** An object to hold reusable Schema Objects.*/
     schemas?: Record<string, SchemaObject>;
+    /** An object to hold reusable Response Objects. */
     responses?: Record<string, ResponseObject | ReferenceObject>;
+    /** An object to hold reusable Parameter Objects. */
     parameters?: Record<string, ParameterObject | ReferenceObject>;
+    /** An object to hold reusable Example Objects. */
     examples?: Record<string, ExampleObject | ReferenceObject>;
+    /** An object to hold reusable Request Body Objects. */
     requestBodies?: Record<string, RequestBodyObject | ReferenceObject>;
+    /** An object to hold reusable Header Objects. */
     headers?: Record<string, HeaderObject | ReferenceObject>;
+    /** An object to hold reusable Security Scheme Objects. */
     securitySchemes?: Record<string, SecuritySchemeObject | ReferenceObject>;
+    /** An object to hold reusable Link Objects. */
     links?: Record<string, LinkObject | ReferenceObject>;
+    /** An object to hold reusable Callback Objects. */
     callbacks?: Record<string, CallbackObject | ReferenceObject>;
+    /** An object to hold reusable Path Item Objects. */
     pathItems?: Record<string, PathItemObject | ReferenceObject>;
+    /** An object to hold reusable Media Type Objects (OpenAPI 3.2). */
     mediaTypes?: Record<string, MediaTypeObject | ReferenceObject>;
 }
+/**
+ * [4.8.8] Paths Object
+ * Holds the relative paths to the individual endpoints and their operations. The path is appended
+ * to the URL from the Server Object in order to construct the full URL. The Paths MAY be empty, due
+ * to Access Control List (ACL) constraints.
+ */
 interface PathsObject {
     [pathname: string]: PathItemObject | ReferenceObject;
 }
+/**
+ * [x.x.x] Webhooks Object
+ * Holds the webhooks definitions, indexed by their names. A webhook is defined by a Path Item
+ * Object; the only difference is that the request is initiated by the API provider.
+ */
 interface WebhooksObject {
     [name: string]: PathItemObject;
 }
+/**
+ * [4.8.22] Tag Object
+ * Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a
+ * Tag Object per tag defined in the Operation Object instances.
+ */
 interface TagObject extends Extensable {
+    /** REQUIRED. The name of the tag. */
     name: string;
+    /** A description for the tag. CommonMark syntax MAY be used for rich text representation. */
     description?: string;
+    /** Additional external documentation for this tag. */
     externalDocs?: ExternalDocumentationObject;
 }
 
 interface TransformObject {
+    /** The type: an IR type (from the helpers), or a TypeScript node (read by the bridge). */
     schema: IrType | ts.TypeNode;
     questionToken: boolean;
 }
+/**
+ * Every source type `openapiTS` accepts: YAML or JSON text, a URL, a parsed document, bytes or a
+ * stream.
+ */
 type SchemaSource = string | URL | OpenAPI3 | Buffer | Readable;
+/** The generator options other than the schema callbacks. */
 interface OpenAPITSBaseOptions {
+    /** Treat all objects as if they have `additionalProperties: true` by default (default: false) */
     additionalProperties?: boolean;
+    /** Alphabetize all keys? (default: false) */
     alphabetize?: boolean;
+    /** (optional) Generate tuples using array minItems / maxItems */
     arrayLength?: boolean;
+    /**
+     * Type raw binary strings as `Blob` instead of `string` (default: false): `format: binary`
+     * (OpenAPI 3.0), or a `contentMediaType` that is not text and has no `contentEncoding` (3.1).
+     * `Blob` is a global type of the DOM lib and `@types/node`.
+     */
     binaryAsBlob?: boolean;
+    /**
+     * Allow schema objects with no specified properties to have additional properties if not
+     * expressly forbidden? (default: false)
+     */
     emptyObjectsUnknown?: boolean;
+    /** Provide current working directory (cwd) which helps resolve relative remote schemas */
     cwd?: PathLike;
+    /**
+     * Load local `$ref` files only from this directory and below it; a relative path resolves
+     * against `cwd`. Default: no limit. Threat model R1, ADR-017.
+     */
     localRefRoot?: string | URL;
+    /**
+     * Load remote `$ref` documents only from these hosts (`name` or `name:port`); `[]` loads none.
+     * Redirects are checked too. Default: any host. Threat model R2, ADR-017.
+     */
     remoteRefHosts?: readonly string[];
+    /** Should schema objects with a default value not be considered optional? */
     defaultNonNullable?: boolean;
+    /** Exclude deprecated fields from types? (default: false) */
     excludeDeprecated?: boolean;
+    /**
+     * Opt-in fixes of the output of valid schemas (default: none), ADR-021. `"all"` turns on every
+     * fix of the installed version, so a minor update can change the output; list the names to keep
+     * it stable. An unknown name fails with `OPTION_FIX_UNKNOWN`.
+     * @see https://github.com/openapi-typesafe/openapi-typesafe/blob/main/docs/cli.md#fix
+     */
     fix?: readonly OutputFixName[];
+    /** Add readonly properties and readonly arrays? (default: false) */
     immutable?: boolean;
+    /**
+     * Lint the document with the Redocly config before generating (default: true). Bundling errors
+     * still fail the run.
+     */
     lint?: boolean;
+    /** (optional) Should logging be suppressed? (necessary for STDOUT) */
     silent?: boolean;
+    /** Accepted for compatibility with openapi-typescript; not read. */
     version?: number;
+    /** (optional) Export type instead of interface */
     exportType?: boolean;
+    /** Export true TypeScript enums instead of unions */
     enum?: boolean;
+    /** Export union values as arrays */
     enumValues?: boolean;
+    /** Only generate TS Enums when `x-enum-*` metadata is available */
     conditionalEnums?: boolean;
+    /** Dedupe enum values */
     dedupeEnums?: boolean;
+    /** (optional) Substitute path parameter names with their respective types */
     pathParamsAsTypes?: boolean;
+    /**
+     * Treat all objects as if they have \`required\` set to all properties by default (default:
+     * false)
+     */
     propertiesRequiredByDefault?: boolean;
+    /** (optional) Generate schema types at root level */
     rootTypes?: boolean;
+    /** (optional) Do not add Schema prefix to types at root level */
     rootTypesNoSchemaPrefix?: boolean;
+    /** (optional) Keep casing of root types */
     rootTypesKeepCasing?: boolean;
+    /**
+     * Configure Redocly for validation, schema fetching, and bundling
+     * @see https://redocly.com/docs/cli/configuration/
+     */
     redocly?: Config;
+    /** Inject arbitrary TypeScript types into the start of the file */
     inject?: string;
+    /** Generate ApiPaths enum */
     makePathsEnum?: boolean;
+    /** Generate path params based on path even if they are not defined in the open api schema */
     generatePathParams?: boolean;
+    /** Generate $Read/$Write markers for readOnly/writeOnly properties (default: false) */
     readWriteMarkers?: boolean;
 }
+/**
+ * The schema callbacks of the original API: they receive TypeScript nodes (ADR-004, decisions 5
+ * and 6). Results may be IR (from the helpers) or TypeScript nodes, read by the bridge.
+ */
 interface LegacyCallbackOptions {
+    /** Unset or false: the callbacks below receive TypeScript nodes. */
     irCallbacks?: false;
+    /** Manually transform certain Schema Objects with a custom TypeScript type */
     transform?: (schemaObject: SchemaObject, options: TransformNodeOptions) => IrType | ts.TypeNode | TransformObject | undefined;
+    /**
+     * Modify TypeScript types built from Schema Objects (receives a TypeScript node)
+     * @deprecated Use `irCallbacks: true` (ADR-004, decision 6); the TypeScript form is removed in
+     * 2.0.
+     */
     postTransform?: (type: ts.TypeNode, options: TransformNodeOptions) => IrType | ts.TypeNode | undefined;
+    /**
+     * Modify property signatures for Schema Object properties (receives a TypeScript node)
+     * @deprecated Use `irCallbacks: true` (ADR-004, decision 6); the TypeScript form is removed in
+     * 2.0.
+     */
     transformProperty?: (property: ts.PropertySignature, schemaObject: SchemaObject, options: TransformNodeOptions) => IrPropertySignature | ts.PropertySignature | undefined;
 }
+/**
+ * The schema callbacks that have a deprecated TypeScript-node form (ADR-004, decisions 5 and 6).
+ */
 type LegacyCallbackName = "transform" | "postTransform" | "transformProperty";
+/** A type an IR callback returns: an IR type, or TypeScript type text printed as written. */
 type IrCallbackType = IrType | string;
+/** What an IR `transform` callback returns to make the property optional. */
 interface IrTransformObject {
     schema: IrCallbackType;
     questionToken: boolean;
 }
+/** Replace the generated type of a Schema Object; `undefined` keeps the generated type. */
 type IrTransform = (schemaObject: SchemaObject, options: TransformNodeOptions) => IrCallbackType | IrTransformObject | undefined;
+/** Modify the generated type of a Schema Object; `undefined` keeps it. */
 type IrPostTransform = (type: IrType, options: TransformNodeOptions) => IrCallbackType | undefined;
+/** Modify the generated property of a Schema Object property; `undefined` keeps it. */
 type IrTransformProperty = (property: IrPropertySignature, schemaObject: SchemaObject, options: TransformNodeOptions) => IrPropertySignature | undefined;
+/** The schema callbacks on IR (ENGINEERING_PLAN 6.3): they receive and return IR nodes. */
 interface IrCallbackOptions {
     irCallbacks: true;
     transform?: IrTransform;
     postTransform?: IrPostTransform;
     transformProperty?: IrTransformProperty;
 }
+/** The options of the original API: callbacks on TypeScript nodes. */
 interface OpenAPITSOptions extends OpenAPITSBaseOptions, LegacyCallbackOptions {
 }
+/** The options with `irCallbacks: true`: callbacks on IR nodes. */
 interface OpenAPITSIrOptions extends OpenAPITSBaseOptions, IrCallbackOptions {
 }
+/** Either form of the generator options. */
 type GeneratorOptions = OpenAPITSOptions | OpenAPITSIrOptions;
+/**
+ * Context passed to all submodules, and to the callbacks as `options.ctx`. To call an exported
+ * transformer outside a run, build one with the fields of openapi-typescript's context; the
+ * fields openapi-typesafe added are optional.
+ */
 interface GlobalContext {
     additionalProperties: boolean;
     alphabetize: boolean;
     arrayLength: boolean;
-    binaryAsBlob: boolean;
+    /** `format: binary` and `contentMediaType` strings become `Blob` (default: false). */
+    binaryAsBlob?: boolean;
     defaultNonNullable: boolean;
     discriminators: {
         objects: Record<string, DiscriminatorObject>;
@@ -592,14 +1414,20 @@ interface GlobalContext {
     dedupeEnums: boolean;
     excludeDeprecated: boolean;
     exportType: boolean;
+    /** The opt-in output fixes of this run, `all` expanded (ADR-021). Unset: none. */
     fix?: readonly OutputFix[];
     immutable: boolean;
+    /**
+     * Declarations written after the main types, in order. The generator adds IR declarations;
+     * callbacks may add IR declarations or TypeScript nodes.
+     */
     injectFooter: FooterEntry[];
-    runFooter?: DocumentFooter;
-    legacyCallbackWarnings?: Set<LegacyCallbackName>;
-    logger?: Logger;
     pathParamsAsTypes: boolean;
-    irCallbacks: boolean;
+    /**
+     * Whether the callbacks below take IR (`OpenAPITSIrOptions`) or TypeScript nodes
+     * (default: false, TypeScript nodes).
+     */
+    irCallbacks?: boolean;
     postTransform: GeneratorOptions["postTransform"];
     propertiesRequiredByDefault: boolean;
     rootTypes: boolean;
@@ -609,20 +1437,53 @@ interface GlobalContext {
     silent: boolean;
     transform: GeneratorOptions["transform"];
     transformProperty: GeneratorOptions["transformProperty"];
+    /** retrieve a node by $ref */
     resolve<T>($ref: string): T | undefined;
     inject?: string;
     makePathsEnum: boolean;
     generatePathParams: boolean;
     readWriteMarkers: boolean;
 }
+/** generic options for most internal transform* functions */
 interface TransformNodeOptions {
     path?: string;
     schema?: SchemaObject | ReferenceObject;
     ctx: GlobalContext;
 }
 
+/** The debug groups of the original `DEBUG=openapi-ts:<group>` output. */
+type DebugGroup = "redoc" | "lint" | "bundle" | "ts";
+/**
+ * Where the generator reports progress and problems (ENGINEERING_PLAN 4.5). Whether warnings are
+ * printed (`silent`) and debug output (`DEBUG`) is decided by the adapter, when it is created.
+ */
+interface Logger {
+    /**
+     * A debug line, with how long the step took when it was measured. A line without a group is
+     * written whenever debug output is on.
+     */
+    debug(message: string, group?: DebugGroup, durationMs?: number): void;
+    warn(message: string): void;
+    error(message: string): void;
+}
+
+/**
+ * Convert an OpenAPI schema to TypeScript declarations (IR nodes; print them with `astToString`)
+ * @param {string|URL|object|Readable} source OpenAPI schema source:
+ *   - YAML: string
+ *   - JSON: parsed object
+ *   - URL: URL to a YAML or JSON file (local or remote)
+ *   - Readable: Readable stream of YAML or JSON
+ */
 declare function openapiTS(source: SchemaSource, options?: GeneratorOptions): Promise<IrDeclaration[]>;
 
+/**
+ * Typed errors (ENGINEERING_PLAN 4.6, ADR-011). Every expected failure of the generator and the CLI
+ * is an `OpenAPITypesafeError` with a stable machine-readable `code` and structured `details`. The
+ * `message` is English text for people; programs and the CLI decide by `code`. A bug (a broken
+ * invariant) is a plain `Error`, not one of these.
+ */
+/** Every error code. The set is closed: a new code must be handled by the CLI exit-code table. */
 declare const ERROR_CODES: {
     readonly SCHEMA_SOURCE_EMPTY: "SCHEMA_SOURCE_EMPTY";
     readonly SCHEMA_SOURCE_INVALID: "SCHEMA_SOURCE_INVALID";
@@ -643,46 +1504,93 @@ declare const ERROR_CODES: {
     readonly CLI_FLAG_REMOVED: "CLI_FLAG_REMOVED";
     readonly CLI_GLOB_UNSUPPORTED: "CLI_GLOB_UNSUPPORTED";
     readonly CLI_CONFIG_NOT_FOUND: "CLI_CONFIG_NOT_FOUND";
+    readonly CLI_CONFIG_INVALID: "CLI_CONFIG_INVALID";
     readonly CLI_CONFIG_OUTPUT_MISSING: "CLI_CONFIG_OUTPUT_MISSING";
     readonly CLI_CHECK_OUTPUT_MISSING: "CLI_CHECK_OUTPUT_MISSING";
+    readonly CLI_INPUT_MISSING: "CLI_INPUT_MISSING";
     readonly OUTPUT_STALE: "OUTPUT_STALE";
     readonly OUTPUT_READ_FAILED: "OUTPUT_READ_FAILED";
     readonly OUTPUT_WRITE_FAILED: "OUTPUT_WRITE_FAILED";
 };
 type ErrorCode = (typeof ERROR_CODES)[keyof typeof ERROR_CODES];
+/** Structured, JSON-serializable facts about a failure, for programs and logs. */
 type ErrorDetails = Readonly<Record<string, unknown>>;
 interface OpenAPITypesafeErrorInit {
     readonly code: ErrorCode;
     readonly message: string;
     readonly details?: ErrorDetails;
+    /** The lower-level error this one reports, if any (kept as the standard `cause`). */
     readonly cause?: unknown;
 }
+/**
+ * The base of every expected failure; check `code`, not the class or the message. The message
+ * never shows the user info of a URL (`url-credentials.ts`).
+ */
 declare class OpenAPITypesafeError extends Error {
     readonly code: ErrorCode;
     readonly details: ErrorDetails;
     constructor(init: OpenAPITypesafeErrorInit);
 }
+/** Whether a thrown value is one of our typed errors (also across bundled copies of the class). */
 declare function isOpenAPITypesafeError(value: unknown): value is OpenAPITypesafeError;
 
+/** Options of `astToString` for the TypeScript printer, as in the original. */
 interface AstToStringOptions {
     fileName?: string;
     sourceText?: string;
+    /** The installed compiler's printer options (ADR-032: named without `ts.PrinterOptions`). */
     formatOptions?: ts.PrinterOptions;
 }
 
+/** Anything the IR printer can print at the top level of a file. */
 type IrPrintable = IrDeclaration | IrMember | IrType;
 
+/** What `astToString` prints: IR (from `openapiTS` and the transformers) or TypeScript nodes. */
 type AstToStringInput = IrPrintable | ts.Node | readonly (IrPrintable | ts.Node)[];
+/**
+ * Print declarations, members or types as a TypeScript file body. IR is printed by our printer;
+ * with TypeScript nodes in the input, or with TypeScript printer options, everything goes
+ * through the TypeScript printer as before (ADR-004, decision 1).
+ */
 declare function astToString(ast: AstToStringInput, options?: AstToStringOptions): string;
 
+/** The header of every generated file; the CLI writes it before the declarations. */
 declare const COMMENT_HEADER = "/**\n * This file was auto-generated by openapi-typesafe.\n * Do not make direct changes to the file.\n */\n\n";
 
+/**
+ * The `discriminator-values` fix (#1700). With `--enum`, the enum the scan adds to a member
+ * (`petType: "Cat"`) is declared as an enum of its own (`CatPetType`), which is not assignable to
+ * the parent's enum (`PetType`). The parent's enum is found here, so the member's property can be
+ * typed with its members (`PetType.Cat`).
+ */
+/** The parent's enum schema and the location it is typed at, which gives the enum its name. */
+interface EnumParent {
+    readonly schema: SchemaObject;
+    readonly path: string;
+}
+
+/** The discriminators of a bundled document, after patching the mapped schemas in place. */
 interface DiscriminatorScan {
     objects: Record<string, DiscriminatorObject>;
     refsHandled: string[];
-}
+    /** With `discriminator-values`: the owner's enum of each enum the scan added. */
+    enumParents: ReadonlyMap<object, EnumParent>;
+    /** With `discriminator-values`: the properties of the other discriminators a schema inherits. */
+    otherProperties: Readonly<Record<string, readonly string[]>>;
+}
+/**
+ * Return a key–value map of discriminator objects found in a schema. Warnings go to `logger`;
+ * without one, to the default terminal logger, as the original did.
+ * @deprecated Kept for 1.x; removed in 2.0 (ADR-004, decision 9).
+ */
 declare function scanDiscriminators(schema: OpenAPI3, options: GeneratorOptions, logger?: Logger): DiscriminatorScan;
 
+/**
+ * The public type helpers (ENGINEERING_PLAN 6.2, ADR-004 decision 2). Same names and call
+ * signatures as the original helpers; they return IR types. A `ts.TypeNode` argument (from user
+ * code built with `ts.factory`) is read into IR by the bridge.
+ */
+/** A helper argument: an IR type, or a TypeScript type node from user code. */
 type TypeInput = IrType | ts.TypeNode;
 declare const BOOLEAN: IrType;
 declare const FALSE: IrType;
@@ -692,24 +1600,54 @@ declare const NUMBER: IrType;
 declare const STRING: IrType;
 declare const TRUE: IrType;
 declare const UNDEFINED: IrType;
+/** The shared `unknown` type; the transformers compare with it by identity, as the original did. */
 declare const UNKNOWN: IrType;
+/** `A | B`: `never` for no types, the type itself for one; repeated primitives are removed. */
 declare function tsUnion(types: readonly TypeInput[]): IrType;
+/** `A & B`, with the same rules as `tsUnion`. */
 declare function tsIntersection(types: readonly TypeInput[]): IrType;
+/** `A | null`, without removing repeated types. */
 declare function tsNullable(types: readonly TypeInput[]): IrType;
+/** `Omit<T, "a" | "b">`. */
 declare function tsOmit(type: TypeInput, keys: readonly string[]): IrType;
+/** `Record<K, V>`. */
 declare function tsRecord(key: TypeInput, value: TypeInput): IrType;
+/**
+ * The literal type of a JSON value: strings, numbers, booleans and `null` as literals, arrays as
+ * tuples (an empty one as `never[]`), objects as object types; anything else is `unknown`.
+ */
 declare function tsLiteral(value: unknown): IrType;
+/**
+ * `WithRequired<T, "a" | "b">`, or the type itself for no keys. Adds the `WithRequired` helper
+ * type to the footer once.
+ */
 declare function tsWithRequired(type: TypeInput, keys: readonly string[], injectFooter: FooterEntry[]): IrType;
 interface OapiRefOptions {
+    /** Whether to wrap with FlattenedDeepRequired<> (default: false) */
     deep?: boolean;
+    /** Array of property names to wrap with Extract<> when accessing */
     extractProperties?: string[];
 }
+/**
+ * The generated type a JSON Pointer refers to, as an indexed access: `#/components/schemas/Foo`
+ * → `components["schemas"]["Foo"]`. Object `properties` are skipped, and a referenced parameter
+ * is indexed by its location (`resolved`).
+ */
 declare function oapiRef(path: string, resolved?: ParameterObject | ReferenceObject, options?: OapiRefOptions): IrType;
 
+/**
+ * The original's helpers that build TypeScript compiler nodes, kept for 1.x and deprecated
+ * (ADR-004, decision 9). They load TypeScript on first use through the bridge; the generator
+ * itself does not use them.
+ */
 declare const JS_PROPERTY_INDEX_RE: RegExp;
 declare const JS_ENUM_INVALID_CHARS_RE: RegExp;
 declare const JS_PROPERTY_INDEX_INVALID_CHARS_RE: RegExp;
 declare const SPECIAL_CHARACTER_MAP: Record<string, string>;
+/**
+ * The `?` token. Created on first use, so importing the package needs no TypeScript.
+ * @deprecated Kept for 1.x; removed in 2.0 (ADR-004, decision 9).
+ */
 declare const QUESTION_TOKEN: ts.QuestionToken;
 interface AnnotatedSchemaObject {
     const?: unknown;
@@ -725,9 +1663,23 @@ interface AnnotatedSchemaObject {
     title?: string;
     type?: string | string[];
 }
+/**
+ * Add the schema's JSDoc comment to a TypeScript property signature.
+ * @deprecated Kept for 1.x; removed in 2.0 (ADR-004, decision 9).
+ */
 declare function addJSDocComment(schemaObject: AnnotatedSchemaObject, node: ts.PropertySignature): void;
+/**
+ * Deduplicate simple primitive types from an array of nodes
+ * Note: won’t deduplicate complex types like objects
+ * @deprecated Kept for 1.x; removed in 2.0 (ADR-004, decision 9).
+ */
 declare function tsDedupe(types: TypeInput[]): ts.TypeNode[];
+/** @deprecated The generator keeps its own enum registry per run; kept for 1.x (ADR-004). */
 declare const enumCache: Map<string, ts.EnumDeclaration>;
+/**
+ * Create a TS enum (with sanitized name and members)
+ * @deprecated Kept for 1.x; removed in 2.0 (ADR-004, decision 9).
+ */
 declare function tsEnum(name: string, members: (string | number)[], metadata?: {
     name?: string;
     description?: string | null;
@@ -735,78 +1687,262 @@ declare function tsEnum(name: string, members: (string | number)[], metadata?: {
     export?: boolean;
     shouldCache?: boolean;
 }): ts.EnumDeclaration;
+/**
+ * Create an exported TS array literal expression
+ * @deprecated Kept for 1.x; removed in 2.0 (ADR-004, decision 9).
+ */
 declare function tsArrayLiteralExpression(name: string, elementType: TypeInput, values: (string | number)[], options?: {
     export?: boolean;
     readonly?: boolean;
     injectFooter?: FooterEntry[];
 }): ts.VariableStatement;
+/**
+ * Sanitize TS enum member expression
+ * @deprecated Kept for 1.x; removed in 2.0 (ADR-004, decision 9).
+ */
 declare function tsEnumMember(value: string | number, metadata?: {
     name?: string;
     description?: string | null;
 }): ts.EnumMember;
+/**
+ * Is this a primitive type (string, number, boolean, null, undefined)?
+ * @deprecated Kept for 1.x; removed in 2.0 (ADR-004, decision 9).
+ */
 declare function tsIsPrimitive(input: TypeInput): boolean;
+/**
+ * Modifiers (readonly)
+ * @deprecated Kept for 1.x; removed in 2.0 (ADR-004, decision 9).
+ */
 declare function tsModifiers(modifiers: {
     readonly?: boolean;
     export?: boolean;
 }): ts.Modifier[];
+/**
+ * Create a valid property index
+ * @deprecated Kept for 1.x; removed in 2.0 (ADR-004, decision 9).
+ */
 declare function tsPropertyIndex(index: string | number): ts.Identifier | ts.NumericLiteral | ts.StringLiteral;
+/**
+ * Enhanced ReadonlyArray.
+ * eg: type Foo = ReadonlyArray<T>; type Bar = ReadonlyArray<T[]>
+ * Foo and Bar are both of type `readonly T[]`
+ * @deprecated Kept for 1.x; removed in 2.0 (ADR-004, decision 9).
+ */
 declare function tsReadonlyArray(type: TypeInput, injectFooter?: FooterEntry[]): ts.TypeNode;
 
+/** `$ref` resolution and the document walk that the generator's pre-pass uses. */
 interface ResolveRefOptions {
     silent: boolean;
     visited?: string[];
+    /** @internal Where warnings go; the default terminal logger (respecting `silent`) if absent. */
     logger?: Logger;
 }
 
+/**
+ * The shared ansi-colors instance.
+ * @deprecated Kept for 1.x; removed in 2.0 (ADR-004, decision 9). Use a color library directly.
+ */
 declare const c: typeof colors;
+/**
+ * The discriminator property of a schema at `path`, typed as its discriminator value. Returns IR
+ * (task 6.2), like the exported transformers.
+ */
 declare function createDiscriminatorProperty(discriminator: DiscriminatorObject, { path, readonly }: {
     path: string;
     readonly?: boolean;
 }): IrPropertySignature;
+/** Create a $ref pointer (even from other $refs) */
 declare function createRef(parts: (number | string | undefined | null)[]): string;
+/**
+ * Print debug message (cribbed from the `debug` package, but without all the bells & whistles
+ * @deprecated Kept for 1.x; removed in 2.0 (ADR-004, decision 9).
+ */
 declare function debug(msg: string, group?: string, time?: number): void;
+/**
+ * Print error message
+ * @deprecated Kept for 1.x; removed in 2.0 (ADR-004, decision 9).
+ */
 declare function error(msg: string): void;
+/** Format a performance log in a friendly format */
 declare function formatTime(t: number): string;
+/** Call Object.entries() and optionally sort */
 declare function getEntries<T>(obj: ArrayLike<T> | Record<string, T>, options?: {
     alphabetize?: boolean;
     excludeDeprecated?: boolean;
 }): [string, T][];
 
-declare function resolveRef<T>(schema: any, $ref: string, options: ResolveRefOptions): T | undefined;
+/**
+ * resolve a $ref in a schema
+ * @deprecated Kept for 1.x; removed in 2.0 (ADR-004, decision 9).
+ */
+declare function resolveRef<T>(schema: unknown, $ref: string, options: ResolveRefOptions): T | undefined;
+/**
+ * Walk through any JSON-serializable (i.e. non-circular) object
+ * @deprecated Kept for 1.x; removed in 2.0 (ADR-004, decision 9).
+ */
 declare function walk(obj: unknown, cb: (value: Record<string, unknown>, path: (string | number)[]) => void, path?: (string | number)[]): void;
+/**
+ * Print warning message
+ * @deprecated Kept for 1.x; removed in 2.0 (ADR-004, decision 9).
+ */
 declare function warn(msg: string, silent?: boolean): void;
 
+/** Node's deprecation code for `stringToAST`, so users can filter or trace the warning. */
 declare const STRING_TO_AST_DEPRECATION_CODE = "OPENAPI_TYPESAFE_DEP_STRING_TO_AST";
+/**
+ * Convert an arbitrary string to TS (assuming it’s valid). Parses with the TypeScript bridge, so
+ * it needs TypeScript 6 or earlier (or `@typescript/typescript6`). Node's `util.deprecate` warns
+ * on the first call only.
+ * @deprecated Kept for 1.x; removed in 2.0 (ADR-004, decision 7). Use type text in IR callbacks.
+ */
 declare const stringToAST: (source: string) => unknown[];
 
+/**
+ * The whole document as IR declarations (ENGINEERING_PLAN 6.1–6.2); `openapiTS` returns the same
+ * for a loaded document.
+ */
 declare function transformSchema(schema: OpenAPI3, ctx: GlobalContext): IrDeclaration[];
 
+/**
+ * Typed warnings. A warning does not stop the run: the output is written and the CLI exits with 0.
+ * Each one ends with a stable machine-readable code in parentheses, as the CLI prints errors
+ * (`message (CODE)`), so a script or a person can search for it.
+ */
+/** Every warning code. */
+declare const WARNING_CODES: {
+    readonly CLI_INPUT_IGNORED: "CLI_INPUT_IGNORED";
+    readonly CONFIG_SETTING_UNKNOWN: "CONFIG_SETTING_UNKNOWN";
+    readonly DISCRIMINATOR_MAPPING_INVALID: "DISCRIMINATOR_MAPPING_INVALID";
+    readonly DISCRIMINATOR_VALUE_NOT_ALLOWED: "DISCRIMINATOR_VALUE_NOT_ALLOWED";
+    readonly ENUM_VALUES_EXCLUDED: "ENUM_VALUES_EXCLUDED";
+    readonly FIX_NEEDS_OPTION: "FIX_NEEDS_OPTION";
+    readonly LEGACY_CALLBACK_DEPRECATED: "LEGACY_CALLBACK_DEPRECATED";
+    readonly LINT_PROBLEM: "LINT_PROBLEM";
+    readonly PATH_TEMPLATES_IDENTICAL: "PATH_TEMPLATES_IDENTICAL";
+    readonly QUERYSTRING_NEXT_TO_QUERY: "QUERYSTRING_NEXT_TO_QUERY";
+    readonly REF_CIRCULAR: "REF_CIRCULAR";
+    readonly REF_NOT_FOUND: "REF_NOT_FOUND";
+};
+type WarningCode = (typeof WARNING_CODES)[keyof typeof WARNING_CODES];
+
+/**
+ * Transform the ComponentsObject (4.8.7)
+ * @see https://spec.openapis.org/oas/latest.html#components-object
+ *
+ * Ported to IR (ENGINEERING_PLAN Phase 5, step 6). Same name and parameters as the original;
+ * returns IR (task 6.2). For the public API: the `components` type, then the root type aliases.
+ */
 declare function transformComponentsObject(componentsObject: ComponentsObject, ctx: GlobalContext): (IrType | IrTypeAliasDeclaration)[];
 
+/**
+ * Transform HeaderObject nodes (4.8.21)
+ * @see https://spec.openapis.org/oas/v3.1.0#header-object
+ *
+ * Ported to IR (ENGINEERING_PLAN Phase 5, step 3). Same name and parameters as the original;
+ * returns IR (task 6.2). For the public API and for users who call it from callbacks.
+ */
 declare function transformHeaderObject(headerObject: HeaderObject, options: TransformNodeOptions): IrType;
 
+/**
+ * Transform MediaTypeObject nodes (4.8.14)
+ * @see https://spec.openapis.org/oas/v3.1.0#media-type-object
+ *
+ * Ported to IR (ENGINEERING_PLAN Phase 5, step 3). Same name and parameters as the original;
+ * returns IR (task 6.2). For the public API and for users who call it from callbacks.
+ */
 declare function transformMediaTypeObject(mediaTypeObject: MediaTypeObject, options: TransformNodeOptions): IrType;
 
+/**
+ * Transform OperationObject nodes (4.8.10)
+ * @see https://spec.openapis.org/oas/v3.1.0#operation-object
+ *
+ * Ported to IR (ENGINEERING_PLAN Phase 5, step 5). Same name and parameters as the original;
+ * returns IR (task 6.2). For the public API and for users who call it from callbacks.
+ */
 declare function transformOperationObject(operationObject: OperationObject, options: TransformNodeOptions): IrMember[];
+/** inject an operation at the top level */
 declare function injectOperationObject(operationId: string, operationObject: OperationObject, options: TransformNodeOptions): void;
 
+/**
+ * Transform ParameterObject nodes (4.8.12)
+ * @see https://spec.openapis.org/oas/v3.1.0#parameter-object
+ *
+ * Ported to IR (ENGINEERING_PLAN Phase 5, step 3). Same name and parameters as the original;
+ * returns IR (task 6.2). For the public API and for users who call it from callbacks.
+ */
 declare function transformParameterObject(parameterObject: ParameterObject, options: TransformNodeOptions): IrType;
 
+/** The methods every generated path item lists, with `?: never` when the document has none. */
 type HttpMethod = "get" | "put" | "post" | "delete" | "options" | "head" | "patch" | "trace";
+/**
+ * The OpenAPI 3.2 QUERY method. Its member is written only when the path item declares it, so
+ * documents without it keep their output (ADR-020).
+ */
+declare const QUERY_METHOD = "query";
+/** Every operation field of a path item. */
+type PathItemMethod = HttpMethod | typeof QUERY_METHOD;
 
-type Method = HttpMethod;
+/**
+ * The operation methods of a path item: openapi-typescript's eight, plus the OpenAPI 3.2 `query`
+ * (ADR-020), as `HttpMethod` of openapi-typesafe-helpers lists them.
+ */
+type Method = PathItemMethod;
+/**
+ * Transform PathItem nodes (4.8.9)
+ * @see https://spec.openapis.org/oas/v3.1.0#path-item-object
+ *
+ * Ported to IR (ENGINEERING_PLAN Phase 5, step 5). Same name and parameters as the original;
+ * returns IR (task 6.2). For the public API and for users who call it from callbacks.
+ */
 declare function transformPathItemObject(pathItem: PathItemObject, options: TransformNodeOptions): IrType;
 
+/**
+ * Transform the PathsObject node (4.8.8)
+ * @see https://spec.openapis.org/oas/v3.1.0#operation-object
+ *
+ * Ported to IR (ENGINEERING_PLAN Phase 5, step 5). Same name and parameters as the original;
+ * returns IR (task 6.2). For the public API and for users who call it from callbacks.
+ */
 declare function transformPathsObject(pathsObject: PathsObject, ctx: GlobalContext): IrType;
 
+/**
+ * Transform RequestBodyObject nodes (4.8.13)
+ * @see https://spec.openapis.org/oas/v3.1.0#request-body-object
+ *
+ * Ported to IR (ENGINEERING_PLAN Phase 5, step 4). Same name and parameters as the original;
+ * returns IR (task 6.2). For the public API and for users who call it from callbacks.
+ */
 declare function transformRequestBodyObject(requestBodyObject: RequestBodyObject, options: TransformNodeOptions): IrType;
 
+/**
+ * Transform ResponseObject nodes (4.8.17)
+ * @see https://spec.openapis.org/oas/v3.1.0#response-object
+ *
+ * Ported to IR (ENGINEERING_PLAN Phase 5, step 4). Same name and parameters as the original;
+ * returns IR (task 6.2). For the public API and for users who call it from callbacks.
+ */
 declare function transformResponseObject(responseObject: ResponseObject, options: TransformNodeOptions): IrType;
 
+/**
+ * Transform ResponsesObject nodes (4.8.16)
+ * @see https://spec.openapis.org/oas/v3.1.0#responses-object
+ *
+ * Ported to IR (ENGINEERING_PLAN Phase 5, step 4). Same name and parameters as the original;
+ * returns IR (task 6.2). For the public API and for users who call it from callbacks.
+ */
 declare function transformResponsesObject(responsesObject: ResponsesObject, options: TransformNodeOptions): IrType;
 
+/**
+ * Transform SchemaObject nodes (4.8.24)
+ * @see https://spec.openapis.org/oas/v3.1.0#schema-object
+ *
+ * Ported to IR (ENGINEERING_PLAN Phase 5, step 2): the work happens in
+ * `application/transform/schema`; this keeps the original name and parameters, returning IR
+ * (task 6.2), for the public API and for users who call it from callbacks.
+ */
 declare function transformSchemaObject(schemaObject: SchemaObject | ReferenceObject, options: TransformNodeOptions, fromAdditionalProperties?: boolean): IrType;
+/** Transform SchemaObjects without the `postTransform` callback at the top level. */
 declare function transformSchemaObjectWithComposition(schemaObject: SchemaObject | ReferenceObject, options: TransformNodeOptions, fromAdditionalProperties?: boolean): IrType;
 
-export { ALL_OUTPUT_FIXES, BOOLEAN, COMMENT_HEADER, ERROR_CODES, FALSE, JS_ENUM_INVALID_CHARS_RE, JS_PROPERTY_INDEX_INVALID_CHARS_RE, JS_PROPERTY_INDEX_RE, NEVER, NULL, NUMBER, OUTPUT_FIXES, OpenAPITypesafeError, OutputFix, QUESTION_TOKEN, SPECIAL_CHARACTER_MAP, STRING, STRING_TO_AST_DEPRECATION_CODE, TRUE, UNDEFINED, UNKNOWN, addJSDocComment, astToString, c, createDiscriminatorProperty, createRef, debug, openapiTS as default, enumCache, error, formatTime, getEntries, injectOperationObject, isOpenAPITypesafeError, oapiRef, resolveRef, scanDiscriminators, stringToAST, transformComponentsObject, transformHeaderObject, transformMediaTypeObject, transformOperationObject, transformParameterObject, transformPathItemObject, transformPathsObject, transformRequestBodyObject, transformResponseObject, transformResponsesObject, transformSchema, transformSchemaObject, transformSchemaObjectWithComposition, tsArrayLiteralExpression, tsDedupe, tsEnum, tsEnumMember, tsIntersection, tsIsPrimitive, tsLiteral, tsModifiers, tsNullable, tsOmit, tsPropertyIndex, tsReadonlyArray, tsRecord, tsUnion, tsWithRequired, walk, warn };
-export type { $defs, AnnotatedSchemaObject, ArraySubtype, AstToStringInput, AstToStringOptions, BooleanSubtype, CallbackObject, ComponentsObject, ContactObject, DiscriminatorObject, EncodingObject, ErrorCode, ErrorDetails, ExampleObject, Extensable, ExternalDocumentationObject, FooterEntry, GeneratorOptions, GlobalContext, HeaderObject, InfoObject, IntegerSubtype, IrArrayType, IrBooleanLiteralType, IrCallbackOptions, IrCallbackType, IrComment, IrConstArrayDeclaration, IrDeclaration, IrEnumDeclaration, IrEnumMember, IrIndexSignature, IrIndexedAccessType, IrInterfaceDeclaration, IrIntersectionType, IrKeyword, IrKeywordType, IrMember, IrNumberLiteralType, IrObjectType, IrPostTransform, IrPropertyName, IrPropertySignature, IrRawDeclaration, IrRawType, IrReadonlyType, IrReferenceType, IrStringEncoding, IrStringLiteralType, IrTransform, IrTransformObject, IrTransformProperty, IrTupleElement, IrTupleType, IrType, IrTypeAliasDeclaration, IrUnionType, LegacyCallbackName, LegacyCallbackOptions, LicenseObject, LinkObject, MediaTypeObject, Method, NullSubtype, NumberSubtype, OAuthFlowObject, OAuthFlowsObject, OapiRefOptions, ObjectSubtype, OpenAPI3, OpenAPITSBaseOptions, OpenAPITSIrOptions, OpenAPITSOptions, OperationObject, OutputFixName, ParameterObject, PathItemObject, PathsObject, ReferenceObject, RequestBodyObject, ResolveRefOptions, ResponseObject, ResponsesObject, SchemaObject, SchemaSource, SecurityRequirementObject, SecuritySchemeObject, ServerObject, ServerVariableObject, StringSubtype, TagObject, TransformNodeOptions, TransformObject, TypeInput, WebhooksObject, XMLObject };
+export { ALL_OUTPUT_FIXES, BOOLEAN, COMMENT_HEADER, ERROR_CODES, FALSE, JS_ENUM_INVALID_CHARS_RE, JS_PROPERTY_INDEX_INVALID_CHARS_RE, JS_PROPERTY_INDEX_RE, NEVER, NULL, NUMBER, OUTPUT_FIXES, OpenAPITypesafeError, OutputFix, QUESTION_TOKEN, SPECIAL_CHARACTER_MAP, STRING, STRING_TO_AST_DEPRECATION_CODE, TRUE, UNDEFINED, UNKNOWN, WARNING_CODES, addJSDocComment, astToString, c, createDiscriminatorProperty, createRef, debug, openapiTS as default, enumCache, error, formatTime, getEntries, injectOperationObject, isOpenAPITypesafeError, oapiRef, resolveRef, scanDiscriminators, stringToAST, transformComponentsObject, transformHeaderObject, transformMediaTypeObject, transformOperationObject, transformParameterObject, transformPathItemObject, transformPathsObject, transformRequestBodyObject, transformResponseObject, transformResponsesObject, transformSchema, transformSchemaObject, transformSchemaObjectWithComposition, tsArrayLiteralExpression, tsDedupe, tsEnum, tsEnumMember, tsIntersection, tsIsPrimitive, tsLiteral, tsModifiers, tsNullable, tsOmit, tsPropertyIndex, tsReadonlyArray, tsRecord, tsUnion, tsWithRequired, walk, warn };
+export type { $defs, AnnotatedSchemaObject, ArraySubtype, AstToStringInput, AstToStringOptions, BooleanSubtype, CallbackObject, ComponentsObject, ContactObject, DiscriminatorObject, EncodingObject, ErrorCode, ErrorDetails, ExampleObject, Extensable, ExternalDocumentationObject, FooterEntry, GeneratorOptions, GlobalContext, HeaderObject, InfoObject, IntegerSubtype, IrArrayType, IrBooleanLiteralType, IrCallbackOptions, IrCallbackType, IrComment, IrConstArrayDeclaration, IrDeclaration, IrEnumDeclaration, IrEnumMember, IrIndexSignature, IrIndexedAccessType, IrInterfaceDeclaration, IrIntersectionType, IrKeyword, IrKeywordType, IrMember, IrNumberLiteralType, IrObjectType, IrPostTransform, IrPropertyName, IrPropertySignature, IrRawDeclaration, IrRawType, IrReadonlyType, IrReferenceType, IrStringEncoding, IrStringLiteralType, IrTransform, IrTransformObject, IrTransformProperty, IrTupleElement, IrTupleType, IrType, IrTypeAliasDeclaration, IrUnionType, LegacyCallbackName, LegacyCallbackOptions, LicenseObject, LinkObject, MediaTypeObject, Method, NullSubtype, NumberSubtype, OAuthFlowObject, OAuthFlowsObject, OapiRefOptions, ObjectSubtype, OpenAPI3, OpenAPITSBaseOptions, OpenAPITSIrOptions, OpenAPITSOptions, OperationObject, OutputFixName, ParameterObject, PathItemObject, PathsObject, ReferenceObject, RequestBodyObject, ResolveRefOptions, ResponseObject, ResponsesObject, SchemaObject, SchemaSource, SecurityRequirementObject, SecuritySchemeObject, ServerObject, ServerVariableObject, StringSubtype, TagObject, TransformNodeOptions, TransformObject, TypeInput, WarningCode, WebhooksObject, XMLObject };