@hey-api/openapi-ts 0.65.0 → 0.66.1

package/dist/index.d.cts

@@ -6733,18 +6733,6 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * @default true
    */
   exportFromIndex?: boolean;
-  /**
-   * @deprecated
-   *
-   * **This feature works only with the legacy parser**
-   *
-   * 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$`.
-   */
-  filter?: string;
   /**
    * Include only service classes with names matching regular expression
    *
@@ -6768,14 +6756,6 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * @default 'sdk'
    */
   output?: string;
-  /**
-   * @deprecated
-   *
-   * Define shape of returned value from service calls
-   *
-   * @default 'body'
-   */
-  response?: 'body' | 'response';
   /**
    * Customize the generated service class names. The name variable is
    * obtained from your OpenAPI specification tags.
@@ -6811,6 +6791,30 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * @default false
    */
   validator?: PluginValidatorNames | boolean;
+
+  // DEPRECATED OPTIONS BELOW
+
+  /**
+   * @deprecated
+   *
+   * **This feature works only with the legacy parser**
+   *
+   * 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$`.
+   */
+  // eslint-disable-next-line typescript-sort-keys/interface
+  filter?: string;
+  /**
+   * @deprecated
+   *
+   * Define shape of returned value from service calls
+   *
+   * @default 'body'
+   */
+  response?: 'body' | 'response';
 }
 
 interface Config$9 extends Plugin.Name<'@hey-api/transformers'> {
@@ -6879,6 +6883,37 @@ interface Config$8 extends Plugin.Name<'@hey-api/typescript'> {
    * @default 'PascalCase'
    */
   identifierCase?: Exclude<StringCase, 'SCREAMING_SNAKE_CASE'>;
+  /**
+   * Name of the generated file.
+   *
+   * @default 'types'
+   */
+  output?: string;
+  /**
+   * Choose how to handle types containing read-only or write-only fields?
+   * This option exists for backward compatibility with outputs created before
+   * this feature existed.
+   *
+   * @default 'split'
+   */
+  readOnlyWriteOnlyBehavior?: 'off' | 'split';
+  /**
+   * Customize the name of types used in responses or containing read-only
+   * fields.
+   *
+   * @default '{{name}}Readable'
+   */
+  readableNameBuilder?: string;
+  /**
+   * Customize the name of types used in payloads or containing write-only
+   * fields.
+   *
+   * @default '{{name}}Writable'
+   */
+  writableNameBuilder?: string;
+
+  // DEPRECATED OPTIONS BELOW
+
   /**
    * @deprecated
    *
@@ -6886,13 +6921,8 @@ interface Config$8 extends Plugin.Name<'@hey-api/typescript'> {
    *
    * Include only types matching regular expression.
    */
+  // eslint-disable-next-line typescript-sort-keys/interface
   include?: string;
-  /**
-   * Name of the generated file.
-   *
-   * @default 'types'
-   */
-  output?: string;
   /**
    * @deprecated
    *
@@ -7168,31 +7198,34 @@ interface Input {
    */
   commit_sha?: string;
   /**
-   * Prevent parts matching the regular expression from being processed.
+   * Prevent parts matching the regular expression(s) from being processed.
    * You can select both operations and components by reference within
-   * the bundled input. In case of conflicts, `exclude` takes precedence
-   * over `include`.
+   * the bundled input.
+   *
+   * In case of conflicts, `exclude` takes precedence over `include`.
    *
    * @example
    * operation: '^#/paths/api/v1/foo/get$'
    * schema: '^#/components/schemas/Foo$'
+   * deprecated: '@deprecated'
    */
-  exclude?: string;
+  exclude?: ReadonlyArray<string> | string;
   /**
    * You pass any valid Fetch API options to the request for fetching your
    * specification. This is useful if your file is behind auth for example.
    */
   fetch?: RequestInit;
   /**
-   * Process only parts matching the regular expression. You can select both
-   * operations and components by reference within the bundled input. In
-   * case of conflicts, `exclude` takes precedence over `include`.
+   * Process only parts matching the regular expression(s). You can select both
+   * operations and components by reference within the bundled input.
+   *
+   * In case of conflicts, `exclude` takes precedence over `include`.
    *
    * @example
    * operation: '^#/paths/api/v1/foo/get$'
    * schema: '^#/components/schemas/Foo$'
    */
-  include?: string;
+  include?: ReadonlyArray<string> | string;
   /**
    * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
    *
@@ -7400,6 +7433,9 @@ interface UserConfig {
          */
         timeout?: number;
       };
+
+  // DEPRECATED OPTIONS BELOW
+
   /**
    * @deprecated
    *
@@ -7825,9 +7861,16 @@ interface IRSchemaObject
   > {
   /**
    * If the schema is intended to be used as an object property, it can be
-   * marked as read-only or write-only.
+   * marked as read-only or write-only. This value controls whether the schema
+   * receives the "readonly" TypeScript keyword.
    */
   accessScope?: 'read' | 'write';
+  /**
+   * Similar to `accessScope`, but tells us whether the schema as a whole
+   * contains any read-only or write-only fields. This value controls whether
+   * we split the schema into individual schemas for payloads and responses.
+   */
+  accessScopes?: ReadonlyArray<'read' | 'write'>;
   /**
    * If type is `object`, `additionalProperties` can be used to either define
    * a schema for properties not included in `properties` or disallow such

package/dist/index.d.ts

@@ -6733,18 +6733,6 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * @default true
    */
   exportFromIndex?: boolean;
-  /**
-   * @deprecated
-   *
-   * **This feature works only with the legacy parser**
-   *
-   * 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$`.
-   */
-  filter?: string;
   /**
    * Include only service classes with names matching regular expression
    *
@@ -6768,14 +6756,6 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * @default 'sdk'
    */
   output?: string;
-  /**
-   * @deprecated
-   *
-   * Define shape of returned value from service calls
-   *
-   * @default 'body'
-   */
-  response?: 'body' | 'response';
   /**
    * Customize the generated service class names. The name variable is
    * obtained from your OpenAPI specification tags.
@@ -6811,6 +6791,30 @@ interface Config$a extends Plugin.Name<'@hey-api/sdk'> {
    * @default false
    */
   validator?: PluginValidatorNames | boolean;
+
+  // DEPRECATED OPTIONS BELOW
+
+  /**
+   * @deprecated
+   *
+   * **This feature works only with the legacy parser**
+   *
+   * 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$`.
+   */
+  // eslint-disable-next-line typescript-sort-keys/interface
+  filter?: string;
+  /**
+   * @deprecated
+   *
+   * Define shape of returned value from service calls
+   *
+   * @default 'body'
+   */
+  response?: 'body' | 'response';
 }
 
 interface Config$9 extends Plugin.Name<'@hey-api/transformers'> {
@@ -6879,6 +6883,37 @@ interface Config$8 extends Plugin.Name<'@hey-api/typescript'> {
    * @default 'PascalCase'
    */
   identifierCase?: Exclude<StringCase, 'SCREAMING_SNAKE_CASE'>;
+  /**
+   * Name of the generated file.
+   *
+   * @default 'types'
+   */
+  output?: string;
+  /**
+   * Choose how to handle types containing read-only or write-only fields?
+   * This option exists for backward compatibility with outputs created before
+   * this feature existed.
+   *
+   * @default 'split'
+   */
+  readOnlyWriteOnlyBehavior?: 'off' | 'split';
+  /**
+   * Customize the name of types used in responses or containing read-only
+   * fields.
+   *
+   * @default '{{name}}Readable'
+   */
+  readableNameBuilder?: string;
+  /**
+   * Customize the name of types used in payloads or containing write-only
+   * fields.
+   *
+   * @default '{{name}}Writable'
+   */
+  writableNameBuilder?: string;
+
+  // DEPRECATED OPTIONS BELOW
+
   /**
    * @deprecated
    *
@@ -6886,13 +6921,8 @@ interface Config$8 extends Plugin.Name<'@hey-api/typescript'> {
    *
    * Include only types matching regular expression.
    */
+  // eslint-disable-next-line typescript-sort-keys/interface
   include?: string;
-  /**
-   * Name of the generated file.
-   *
-   * @default 'types'
-   */
-  output?: string;
   /**
    * @deprecated
    *
@@ -7168,31 +7198,34 @@ interface Input {
    */
   commit_sha?: string;
   /**
-   * Prevent parts matching the regular expression from being processed.
+   * Prevent parts matching the regular expression(s) from being processed.
    * You can select both operations and components by reference within
-   * the bundled input. In case of conflicts, `exclude` takes precedence
-   * over `include`.
+   * the bundled input.
+   *
+   * In case of conflicts, `exclude` takes precedence over `include`.
    *
    * @example
    * operation: '^#/paths/api/v1/foo/get$'
    * schema: '^#/components/schemas/Foo$'
+   * deprecated: '@deprecated'
    */
-  exclude?: string;
+  exclude?: ReadonlyArray<string> | string;
   /**
    * You pass any valid Fetch API options to the request for fetching your
    * specification. This is useful if your file is behind auth for example.
    */
   fetch?: RequestInit;
   /**
-   * Process only parts matching the regular expression. You can select both
-   * operations and components by reference within the bundled input. In
-   * case of conflicts, `exclude` takes precedence over `include`.
+   * Process only parts matching the regular expression(s). You can select both
+   * operations and components by reference within the bundled input.
+   *
+   * In case of conflicts, `exclude` takes precedence over `include`.
    *
    * @example
    * operation: '^#/paths/api/v1/foo/get$'
    * schema: '^#/components/schemas/Foo$'
    */
-  include?: string;
+  include?: ReadonlyArray<string> | string;
   /**
    * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
    *
@@ -7400,6 +7433,9 @@ interface UserConfig {
          */
         timeout?: number;
       };
+
+  // DEPRECATED OPTIONS BELOW
+
   /**
    * @deprecated
    *
@@ -7825,9 +7861,16 @@ interface IRSchemaObject
   > {
   /**
    * If the schema is intended to be used as an object property, it can be
-   * marked as read-only or write-only.
+   * marked as read-only or write-only. This value controls whether the schema
+   * receives the "readonly" TypeScript keyword.
    */
   accessScope?: 'read' | 'write';
+  /**
+   * Similar to `accessScope`, but tells us whether the schema as a whole
+   * contains any read-only or write-only fields. This value controls whether
+   * we split the schema into individual schemas for payloads and responses.
+   */
+  accessScopes?: ReadonlyArray<'read' | 'write'>;
   /**
    * If type is `object`, `additionalProperties` can be used to either define
    * a schema for properties not included in `properties` or disallow such