@hey-api/openapi-ts 0.56.2 → 0.57.0

package/dist/index.d.cts

@@ -1,8 +1,8 @@
 type PluginNames =
   | '@hey-api/schemas'
-  | '@hey-api/services'
+  | '@hey-api/sdk'
   | '@hey-api/transformers'
-  | '@hey-api/types'
+  | '@hey-api/typescript'
   | '@tanstack/angular-query-experimental'
   | '@tanstack/react-query'
   | '@tanstack/solid-query'
@@ -3920,7 +3920,21 @@ interface IRResponseObject {
 interface IRSchemaObject
   extends Pick<
     JsonSchemaDraft2020_12,
-    '$ref' | 'const' | 'deprecated' | 'description' | 'required' | 'title'
+    | '$ref'
+    | 'const'
+    | 'default'
+    | 'deprecated'
+    | 'description'
+    | 'exclusiveMaximum'
+    | 'exclusiveMinimum'
+    | 'maximum'
+    | 'maxItems'
+    | 'maxLength'
+    | 'minimum'
+    | 'minItems'
+    | 'minLength'
+    | 'required'
+    | 'title'
   > {
   /**
    * If the schema is intended to be used as an object property, it can be
@@ -3970,24 +3984,24 @@ interface IRSchemaObject
     | 'void';
 }
 
-interface Config$9 extends PluginName<'@hey-api/services'> {
+interface Config$9 extends PluginName<'@hey-api/sdk'> {
   /**
-   * Group operation methods into service classes? When enabled, you can
-   * select which classes to export with `services.include` and/or
-   * transform their names with `services.name`.
+   * Group operation methods into classes? When enabled, you can
+   * select which classes to export with `sdk.include` and/or
+   * transform their names with `sdk.serviceNameBuilder`.
    *
-   * Note that by enabling this option, your services will **NOT**
+   * Note that by enabling this option, your SDKs will **NOT**
    * support {@link https://developer.mozilla.org/docs/Glossary/Tree_shaking tree-shaking}.
    * For this reason, it is disabled by default.
    * @default false
    */
   asClass?: boolean;
   /**
-   * Filter endpoints to be included in the generated services.
-   * The provided string should be a regular expression where matched
-   * results will be included in the output. The input pattern this
-   * string will be tested against is `{method} {path}`. For example,
-   * you can match `POST /api/v1/foo` with `^POST /api/v1/foo$`.
+   * Filter endpoints to be included in the generated SDK. The provided
+   * string should be a regular expression where matched results will be
+   * included in the output. The input pattern this string will be tested
+   * against is `{method} {path}`. For example, you can match
+   * `POST /api/v1/foo` with `^POST /api/v1/foo$`.
    *
    * This option does not work with the experimental parser.
    *
@@ -3997,7 +4011,7 @@ interface Config$9 extends PluginName<'@hey-api/services'> {
   /**
    * Include only service classes with names matching regular expression
    *
-   * This option has no effect if `services.asClass` is `false`.
+   * This option has no effect if `sdk.asClass` is `false`.
    */
   include?: string;
   /**
@@ -4012,7 +4026,7 @@ interface Config$9 extends PluginName<'@hey-api/services'> {
   operationId?: boolean;
   /**
    * Name of the generated file.
-   * @default 'services'
+   * @default 'sdk'
    */
   output?: string;
   /**
@@ -4025,7 +4039,7 @@ interface Config$9 extends PluginName<'@hey-api/services'> {
    * Customize the generated service class names. The name variable is
    * obtained from your OpenAPI specification tags.
    *
-   * This option has no effect if `services.asClass` is `false`.
+   * This option has no effect if `sdk.asClass` is `false`.
    * @default '{{name}}Service'
    */
   serviceNameBuilder?: string;
@@ -4044,12 +4058,25 @@ interface Config$8 extends PluginName<'@hey-api/transformers'> {
   output?: string;
 }
 
-interface Config$7 extends PluginName<'@hey-api/types'> {
+interface Config$7 extends PluginName<'@hey-api/typescript'> {
   /**
-   * Generate enum definitions?
+   * By default, enums are generated as TypeScript types. In addition to that,
+   * you can choose to generate them as JavaScript objects, TypeScript enums,
+   * or TypeScript enums contained within namespaces.
    * @default false
    */
   enums?: 'javascript' | 'typescript' | 'typescript+namespace' | false;
+  /**
+   * By default, inline enums (enums not defined as reusable components in
+   * the input file) are generated as inlined union types. You can set
+   * `exportInlineEnums` to `true` to treat inline enums as reusable components.
+   * When `true`, the exported enums will follow the style defined in `enums`.
+   *
+   * This option works only with the experimental parser.
+   *
+   * @default false
+   */
+  exportInlineEnums?: boolean;
   /**
    * Include only types matching regular expression.
    *
@@ -4207,7 +4234,15 @@ interface Config$1 extends PluginName<'fastify'> {
   output?: string;
 }
 
+// import type { IROperationObject, IRSchemaObject } from '../../ir/ir';
+
+
 interface Config extends PluginName<'zod'> {
+  /**
+   * Customise the Zod schema name. By default, `z{{name}}` is used,
+   * where `name` is a definition name or an operation name.
+   */
+  // nameBuilder?: (model: IROperationObject | IRSchemaObject) => string;
   /**
    * Name of the generated file.
    * @default 'zod'

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 type PluginNames =
   | '@hey-api/schemas'
-  | '@hey-api/services'
+  | '@hey-api/sdk'
   | '@hey-api/transformers'
-  | '@hey-api/types'
+  | '@hey-api/typescript'
   | '@tanstack/angular-query-experimental'
   | '@tanstack/react-query'
   | '@tanstack/solid-query'
@@ -3920,7 +3920,21 @@ interface IRResponseObject {
 interface IRSchemaObject
   extends Pick<
     JsonSchemaDraft2020_12,
-    '$ref' | 'const' | 'deprecated' | 'description' | 'required' | 'title'
+    | '$ref'
+    | 'const'
+    | 'default'
+    | 'deprecated'
+    | 'description'
+    | 'exclusiveMaximum'
+    | 'exclusiveMinimum'
+    | 'maximum'
+    | 'maxItems'
+    | 'maxLength'
+    | 'minimum'
+    | 'minItems'
+    | 'minLength'
+    | 'required'
+    | 'title'
   > {
   /**
    * If the schema is intended to be used as an object property, it can be
@@ -3970,24 +3984,24 @@ interface IRSchemaObject
     | 'void';
 }
 
-interface Config$9 extends PluginName<'@hey-api/services'> {
+interface Config$9 extends PluginName<'@hey-api/sdk'> {
   /**
-   * Group operation methods into service classes? When enabled, you can
-   * select which classes to export with `services.include` and/or
-   * transform their names with `services.name`.
+   * Group operation methods into classes? When enabled, you can
+   * select which classes to export with `sdk.include` and/or
+   * transform their names with `sdk.serviceNameBuilder`.
    *
-   * Note that by enabling this option, your services will **NOT**
+   * Note that by enabling this option, your SDKs will **NOT**
    * support {@link https://developer.mozilla.org/docs/Glossary/Tree_shaking tree-shaking}.
    * For this reason, it is disabled by default.
    * @default false
    */
   asClass?: boolean;
   /**
-   * Filter endpoints to be included in the generated services.
-   * The provided string should be a regular expression where matched
-   * results will be included in the output. The input pattern this
-   * string will be tested against is `{method} {path}`. For example,
-   * you can match `POST /api/v1/foo` with `^POST /api/v1/foo$`.
+   * Filter endpoints to be included in the generated SDK. The provided
+   * string should be a regular expression where matched results will be
+   * included in the output. The input pattern this string will be tested
+   * against is `{method} {path}`. For example, you can match
+   * `POST /api/v1/foo` with `^POST /api/v1/foo$`.
    *
    * This option does not work with the experimental parser.
    *
@@ -3997,7 +4011,7 @@ interface Config$9 extends PluginName<'@hey-api/services'> {
   /**
    * Include only service classes with names matching regular expression
    *
-   * This option has no effect if `services.asClass` is `false`.
+   * This option has no effect if `sdk.asClass` is `false`.
    */
   include?: string;
   /**
@@ -4012,7 +4026,7 @@ interface Config$9 extends PluginName<'@hey-api/services'> {
   operationId?: boolean;
   /**
    * Name of the generated file.
-   * @default 'services'
+   * @default 'sdk'
    */
   output?: string;
   /**
@@ -4025,7 +4039,7 @@ interface Config$9 extends PluginName<'@hey-api/services'> {
    * Customize the generated service class names. The name variable is
    * obtained from your OpenAPI specification tags.
    *
-   * This option has no effect if `services.asClass` is `false`.
+   * This option has no effect if `sdk.asClass` is `false`.
    * @default '{{name}}Service'
    */
   serviceNameBuilder?: string;
@@ -4044,12 +4058,25 @@ interface Config$8 extends PluginName<'@hey-api/transformers'> {
   output?: string;
 }
 
-interface Config$7 extends PluginName<'@hey-api/types'> {
+interface Config$7 extends PluginName<'@hey-api/typescript'> {
   /**
-   * Generate enum definitions?
+   * By default, enums are generated as TypeScript types. In addition to that,
+   * you can choose to generate them as JavaScript objects, TypeScript enums,
+   * or TypeScript enums contained within namespaces.
    * @default false
    */
   enums?: 'javascript' | 'typescript' | 'typescript+namespace' | false;
+  /**
+   * By default, inline enums (enums not defined as reusable components in
+   * the input file) are generated as inlined union types. You can set
+   * `exportInlineEnums` to `true` to treat inline enums as reusable components.
+   * When `true`, the exported enums will follow the style defined in `enums`.
+   *
+   * This option works only with the experimental parser.
+   *
+   * @default false
+   */
+  exportInlineEnums?: boolean;
   /**
    * Include only types matching regular expression.
    *
@@ -4207,7 +4234,15 @@ interface Config$1 extends PluginName<'fastify'> {
   output?: string;
 }
 
+// import type { IROperationObject, IRSchemaObject } from '../../ir/ir';
+
+
 interface Config extends PluginName<'zod'> {
+  /**
+   * Customise the Zod schema name. By default, `z{{name}}` is used,
+   * where `name` is a definition name or an operation name.
+   */
+  // nameBuilder?: (model: IROperationObject | IRSchemaObject) => string;
   /**
    * Name of the generated file.
    * @default 'zod'