@kubb/plugin-ts 5.5.0-canary.20261111T115959 → 5.5.0

package/dist/index.d.cts

@@ -72,6 +72,14 @@ type PrinterTsOptions = {
    * JSDoc comment to attach to the generated type.
    */
   description?: string;
+  /**
+   * `@example` values for the generated type, such as a media type's `examples`. Replaces the schema's own.
+   */
+  examples?: Array<unknown>;
+  /**
+   * JSDoc lines put before the schema's own, such as a response's `@summary`.
+   */
+  comments?: Array<string>;
   /**
    * Properties to exclude using `Omit<Type, Keys>`.
    * Forces type alias syntax regardless of `syntaxType` setting.
@@ -174,9 +182,16 @@ type ResolverTs = Resolver & {
      * Encapsulates the `<operationId> Status <statusCode>` template with PascalCase applied to the result.
      *
      * @example Response status names
-     * `resolver.response.status(node, 200) // → 'ListPetsStatus200'`
+     * `resolver.response.status(node, '200') // → 'ListPetsStatus200'`
      */
     status(node: ast.OperationNode, statusCode: ast.StatusCode): string;
+    /**
+     * Resolves the name for the headers a response declares.
+     *
+     * @example Response headers names
+     * `resolver.response.headers(node, '200') // → 'ListPetsStatus200Headers'`
+     */
+    headers(node: ast.OperationNode, statusCode: ast.StatusCode): string;
     /**
      * Resolves the name for an operation's grouped request options type (`Options`), the
      * `{ body, path, query, headers, cookies }` bag passed to call an operation.
@@ -815,12 +830,16 @@ type EnumTypeNameProps = {
 export declare function enumTypeName({ resolver, name, enumOptions, isEnum }: EnumTypeNameProps): string;
 type BuildParamsSchemaOptions = {
   params: Array<ast.ParameterNode>;
+  /**
+   * Adds each serialized example to `examples` as a `<caption>Serialized</caption>` JSDoc line.
+   * Leave it off when `examples` must hold values, such as for mocks.
+   */
+  serializedExamples?: boolean;
 };
 /**
- * Builds the object schema for a group of parameters sharing one `in` location (path, query, or
- * header), embedding each param's own schema (and JSDoc) directly rather than referencing a
- * separate per-param type — the group itself is the only type these params get exported as.
+ * Builds the object schema for one parameter group or a response's headers. Each entry embeds its own schema and JSDoc,
+ * so the group is the only type these entries are exported as.
  */
-export declare function buildParams({ params }: BuildParamsSchemaOptions): ast.SchemaNode;
+export declare function buildParams({ params, serializedExamples }: BuildParamsSchemaOptions): ast.SchemaNode;
 export { type FunctionParameterNode, type FunctionParametersNode, type IndexedAccessTypeNode, type ObjectBindingPatternNode, type PluginTs, type PrinterTsFactory, type PrinterTsNodes, type PrinterTsOptions, type ResolverTs, type TypeExpression, type TypeLiteralNode, pluginTs as default };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -72,6 +72,14 @@ type PrinterTsOptions = {
    * JSDoc comment to attach to the generated type.
    */
   description?: string;
+  /**
+   * `@example` values for the generated type, such as a media type's `examples`. Replaces the schema's own.
+   */
+  examples?: Array<unknown>;
+  /**
+   * JSDoc lines put before the schema's own, such as a response's `@summary`.
+   */
+  comments?: Array<string>;
   /**
    * Properties to exclude using `Omit<Type, Keys>`.
    * Forces type alias syntax regardless of `syntaxType` setting.
@@ -174,9 +182,16 @@ type ResolverTs = Resolver & {
      * Encapsulates the `<operationId> Status <statusCode>` template with PascalCase applied to the result.
      *
      * @example Response status names
-     * `resolver.response.status(node, 200) // → 'ListPetsStatus200'`
+     * `resolver.response.status(node, '200') // → 'ListPetsStatus200'`
      */
     status(node: ast.OperationNode, statusCode: ast.StatusCode): string;
+    /**
+     * Resolves the name for the headers a response declares.
+     *
+     * @example Response headers names
+     * `resolver.response.headers(node, '200') // → 'ListPetsStatus200Headers'`
+     */
+    headers(node: ast.OperationNode, statusCode: ast.StatusCode): string;
     /**
      * Resolves the name for an operation's grouped request options type (`Options`), the
      * `{ body, path, query, headers, cookies }` bag passed to call an operation.
@@ -815,12 +830,16 @@ type EnumTypeNameProps = {
 export declare function enumTypeName({ resolver, name, enumOptions, isEnum }: EnumTypeNameProps): string;
 type BuildParamsSchemaOptions = {
   params: Array<ast.ParameterNode>;
+  /**
+   * Adds each serialized example to `examples` as a `<caption>Serialized</caption>` JSDoc line.
+   * Leave it off when `examples` must hold values, such as for mocks.
+   */
+  serializedExamples?: boolean;
 };
 /**
- * Builds the object schema for a group of parameters sharing one `in` location (path, query, or
- * header), embedding each param's own schema (and JSDoc) directly rather than referencing a
- * separate per-param type — the group itself is the only type these params get exported as.
+ * Builds the object schema for one parameter group or a response's headers. Each entry embeds its own schema and JSDoc,
+ * so the group is the only type these entries are exported as.
  */
-export declare function buildParams({ params }: BuildParamsSchemaOptions): ast.SchemaNode;
+export declare function buildParams({ params, serializedExamples }: BuildParamsSchemaOptions): ast.SchemaNode;
 export { type FunctionParameterNode, type FunctionParametersNode, type IndexedAccessTypeNode, type ObjectBindingPatternNode, type PluginTs, type PrinterTsFactory, type PrinterTsNodes, type PrinterTsOptions, type ResolverTs, type TypeExpression, type TypeLiteralNode, pluginTs as default };
 //# sourceMappingURL=index.d.ts.map