@hey-api/openapi-ts 0.55.0 → 0.55.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -15,7 +15,8 @@ interface PluginName<Name extends PluginNames> {
15
15
  }
16
16
 
17
17
  interface CommonConfig {
18
- name: PluginNames;
18
+ // eslint-disable-next-line @typescript-eslint/ban-types
19
+ name: PluginNames | (string & {});
19
20
  output?: string;
20
21
  }
21
22
 
@@ -3865,6 +3866,14 @@ interface IRParametersObject {
3865
3866
  }
3866
3867
 
3867
3868
  interface IRParameterObject {
3869
+ /**
3870
+ * 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.
3871
+ */
3872
+ allowReserved?: boolean;
3873
+ /**
3874
+ * 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.
3875
+ */
3876
+ explode: boolean;
3868
3877
  /**
3869
3878
  * Endpoint parameters must specify their location.
3870
3879
  */
@@ -3877,6 +3886,17 @@ interface IRParameterObject {
3877
3886
  pagination?: boolean | string;
3878
3887
  required?: boolean;
3879
3888
  schema: IRSchemaObject;
3889
+ /**
3890
+ * 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`.
3891
+ */
3892
+ style:
3893
+ | 'deepObject'
3894
+ | 'form'
3895
+ | 'label'
3896
+ | 'matrix'
3897
+ | 'pipeDelimited'
3898
+ | 'simple'
3899
+ | 'spaceDelimited';
3880
3900
  }
3881
3901
 
3882
3902
  interface IRResponsesObject {
@@ -3943,6 +3963,7 @@ interface IRSchemaObject
3943
3963
  | 'object'
3944
3964
  | 'string'
3945
3965
  | 'tuple'
3966
+ | 'undefined'
3946
3967
  | 'unknown'
3947
3968
  | 'void';
3948
3969
  }
package/dist/index.d.ts CHANGED
@@ -15,7 +15,8 @@ interface PluginName<Name extends PluginNames> {
15
15
  }
16
16
 
17
17
  interface CommonConfig {
18
- name: PluginNames;
18
+ // eslint-disable-next-line @typescript-eslint/ban-types
19
+ name: PluginNames | (string & {});
19
20
  output?: string;
20
21
  }
21
22
 
@@ -3865,6 +3866,14 @@ interface IRParametersObject {
3865
3866
  }
3866
3867
 
3867
3868
  interface IRParameterObject {
3869
+ /**
3870
+ * 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.
3871
+ */
3872
+ allowReserved?: boolean;
3873
+ /**
3874
+ * 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.
3875
+ */
3876
+ explode: boolean;
3868
3877
  /**
3869
3878
  * Endpoint parameters must specify their location.
3870
3879
  */
@@ -3877,6 +3886,17 @@ interface IRParameterObject {
3877
3886
  pagination?: boolean | string;
3878
3887
  required?: boolean;
3879
3888
  schema: IRSchemaObject;
3889
+ /**
3890
+ * 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`.
3891
+ */
3892
+ style:
3893
+ | 'deepObject'
3894
+ | 'form'
3895
+ | 'label'
3896
+ | 'matrix'
3897
+ | 'pipeDelimited'
3898
+ | 'simple'
3899
+ | 'spaceDelimited';
3880
3900
  }
3881
3901
 
3882
3902
  interface IRResponsesObject {
@@ -3943,6 +3963,7 @@ interface IRSchemaObject
3943
3963
  | 'object'
3944
3964
  | 'string'
3945
3965
  | 'tuple'
3966
+ | 'undefined'
3946
3967
  | 'unknown'
3947
3968
  | 'void';
3948
3969
  }