@hey-api/openapi-ts 0.56.3 → 0.57.1

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'
@@ -3833,12 +3833,29 @@ interface Config$a extends PluginName<'@hey-api/schemas'> {
 
 type IRMediaType = 'form-data' | 'json' | 'url-search-params';
 
+interface IRPathsObject {
+  [path: `/${string}`]: IRPathItemObject;
+}
+
+interface IRPathItemObject {
+  delete?: IROperationObject;
+  get?: IROperationObject;
+  head?: IROperationObject;
+  options?: IROperationObject;
+  patch?: IROperationObject;
+  post?: IROperationObject;
+  put?: IROperationObject;
+  trace?: IROperationObject;
+}
+
 interface IROperationObject {
   body?: IRBodyObject;
   deprecated?: boolean;
   description?: string;
   id: string;
+  method: keyof IRPathItemObject;
   parameters?: IRParametersObject;
+  path: keyof IRPathsObject;
   responses?: IRResponsesObject;
   // TODO: parser - add more properties
   // security?: ReadonlyArray<SecurityRequirementObject>;
@@ -3866,7 +3883,8 @@ interface IRParametersObject {
   query?: Record<string, IRParameterObject>;
 }
 
-interface IRParameterObject {
+interface IRParameterObject
+  extends Pick<JsonSchemaDraft2020_12, 'deprecated' | 'description'> {
   /**
    * 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.
    */
@@ -3984,24 +4002,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.
    *
@@ -4011,7 +4029,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;
   /**
@@ -4026,7 +4044,7 @@ interface Config$9 extends PluginName<'@hey-api/services'> {
   operationId?: boolean;
   /**
    * Name of the generated file.
-   * @default 'services'
+   * @default 'sdk'
    */
   output?: string;
   /**
@@ -4039,7 +4057,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;
@@ -4058,12 +4076,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.
    *

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'
@@ -3833,12 +3833,29 @@ interface Config$a extends PluginName<'@hey-api/schemas'> {
 
 type IRMediaType = 'form-data' | 'json' | 'url-search-params';
 
+interface IRPathsObject {
+  [path: `/${string}`]: IRPathItemObject;
+}
+
+interface IRPathItemObject {
+  delete?: IROperationObject;
+  get?: IROperationObject;
+  head?: IROperationObject;
+  options?: IROperationObject;
+  patch?: IROperationObject;
+  post?: IROperationObject;
+  put?: IROperationObject;
+  trace?: IROperationObject;
+}
+
 interface IROperationObject {
   body?: IRBodyObject;
   deprecated?: boolean;
   description?: string;
   id: string;
+  method: keyof IRPathItemObject;
   parameters?: IRParametersObject;
+  path: keyof IRPathsObject;
   responses?: IRResponsesObject;
   // TODO: parser - add more properties
   // security?: ReadonlyArray<SecurityRequirementObject>;
@@ -3866,7 +3883,8 @@ interface IRParametersObject {
   query?: Record<string, IRParameterObject>;
 }
 
-interface IRParameterObject {
+interface IRParameterObject
+  extends Pick<JsonSchemaDraft2020_12, 'deprecated' | 'description'> {
   /**
    * 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.
    */
@@ -3984,24 +4002,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.
    *
@@ -4011,7 +4029,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;
   /**
@@ -4026,7 +4044,7 @@ interface Config$9 extends PluginName<'@hey-api/services'> {
   operationId?: boolean;
   /**
    * Name of the generated file.
-   * @default 'services'
+   * @default 'sdk'
    */
   output?: string;
   /**
@@ -4039,7 +4057,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;
@@ -4058,12 +4076,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.
    *