@hey-api/openapi-ts 0.69.1 → 0.69.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.
@@ -1,6 +1,6 @@
1
1
  import { JSONSchema } from '@hey-api/json-schema-ref-parser';
2
- import { c as Config, I as IR, W as WatchValues } from './types.d-DewPnfre.cjs';
3
- export { i as initConfigs } from './types.d-DewPnfre.cjs';
2
+ import { c as Config, I as IR, W as WatchValues } from './types.d-CuSvND4p.cjs';
3
+ export { i as initConfigs } from './types.d-CuSvND4p.cjs';
4
4
  import 'node:fs';
5
5
  import 'typescript';
6
6
 
@@ -1,6 +1,6 @@
1
1
  import { JSONSchema } from '@hey-api/json-schema-ref-parser';
2
- import { c as Config, I as IR, W as WatchValues } from './types.d-DewPnfre.js';
3
- export { i as initConfigs } from './types.d-DewPnfre.js';
2
+ import { c as Config, I as IR, W as WatchValues } from './types.d-CuSvND4p.js';
3
+ export { i as initConfigs } from './types.d-CuSvND4p.js';
4
4
  import 'node:fs';
5
5
  import 'typescript';
6
6
 
package/dist/internal.js CHANGED
@@ -1,2 +1,2 @@
1
- import {createRequire}from'module';export{o as getSpec,x as initConfigs,r as parseOpenApiSpec}from'./chunk-QYTRELTS.js';createRequire(import.meta.url);//# sourceMappingURL=internal.js.map
1
+ import {createRequire}from'module';export{o as getSpec,x as initConfigs,r as parseOpenApiSpec}from'./chunk-7JYB3OMB.js';createRequire(import.meta.url);//# sourceMappingURL=internal.js.map
2
2
  //# sourceMappingURL=internal.js.map
@@ -6491,9 +6491,9 @@ declare namespace Plugin {
6491
6491
  Pick<Required<BaseConfig>, 'exportFromIndex' | 'output'>;
6492
6492
 
6493
6493
  /**
6494
- * @deprecated
6495
- *
6496
6494
  * Plugin implementation for legacy parser.
6495
+ *
6496
+ * @deprecated
6497
6497
  */
6498
6498
  export type LegacyHandler<Config extends BaseConfig> = (args: {
6499
6499
  client: Client$1;
@@ -6799,8 +6799,6 @@ interface Config$b extends Plugin.Name<'@hey-api/sdk'> {
6799
6799
  // DEPRECATED OPTIONS BELOW
6800
6800
 
6801
6801
  /**
6802
- * @deprecated
6803
- *
6804
6802
  * **This feature works only with the legacy parser**
6805
6803
  *
6806
6804
  * Filter endpoints to be included in the generated SDK. The provided
@@ -6808,14 +6806,15 @@ interface Config$b extends Plugin.Name<'@hey-api/sdk'> {
6808
6806
  * included in the output. The input pattern this string will be tested
6809
6807
  * against is `{method} {path}`. For example, you can match
6810
6808
  * `POST /api/v1/foo` with `^POST /api/v1/foo$`.
6809
+ *
6810
+ * @deprecated
6811
6811
  */
6812
6812
  // eslint-disable-next-line typescript-sort-keys/interface
6813
6813
  filter?: string;
6814
6814
  /**
6815
- * @deprecated
6816
- *
6817
6815
  * Define shape of returned value from service calls
6818
6816
  *
6817
+ * @deprecated
6819
6818
  * @default 'body'
6820
6819
  */
6821
6820
  response?: 'body' | 'response';
@@ -6928,32 +6927,30 @@ interface Config$9 extends Plugin.Name<'@hey-api/typescript'> {
6928
6927
  // DEPRECATED OPTIONS BELOW
6929
6928
 
6930
6929
  /**
6931
- * @deprecated
6932
- *
6933
6930
  * **This feature works only with the legacy parser**
6934
6931
  *
6935
6932
  * Include only types matching regular expression.
6933
+ *
6934
+ * @deprecated
6936
6935
  */
6937
6936
  // eslint-disable-next-line typescript-sort-keys/interface
6938
6937
  include?: string;
6939
6938
  /**
6940
- * @deprecated
6941
- *
6942
6939
  * **This feature works only with the legacy parser**
6943
6940
  *
6944
6941
  * Use your preferred naming pattern
6945
6942
  *
6943
+ * @deprecated
6946
6944
  * @default 'preserve'
6947
6945
  */
6948
6946
  style?: 'PascalCase' | 'preserve';
6949
6947
  /**
6950
- * @deprecated
6951
- *
6952
6948
  * **This feature works only with the legacy parser**
6953
6949
  *
6954
6950
  * Generate a tree of types containing all operations? It will be named
6955
6951
  * $OpenApiTs.
6956
6952
  *
6953
+ * @deprecated
6957
6954
  * @default false
6958
6955
  */
6959
6956
  tree?: boolean;
@@ -7230,6 +7227,27 @@ type StringCase =
7230
7227
  | 'snake_case'
7231
7228
  | 'SCREAMING_SNAKE_CASE';
7232
7229
 
7230
+ interface Watch {
7231
+ /**
7232
+ * Regenerate the client when the input file changes?
7233
+ *
7234
+ * @default false
7235
+ */
7236
+ enabled?: boolean;
7237
+ /**
7238
+ * How often should we attempt to detect the input file change? (in ms)
7239
+ *
7240
+ * @default 1000
7241
+ */
7242
+ interval?: number;
7243
+ /**
7244
+ * How long will we wait before the request times out?
7245
+ *
7246
+ * @default 60_000
7247
+ */
7248
+ timeout?: number;
7249
+ }
7250
+
7233
7251
  interface Input {
7234
7252
  /**
7235
7253
  * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
@@ -7436,7 +7454,15 @@ interface Input {
7436
7454
  * the first match will be returned.
7437
7455
  */
7438
7456
  tags?: ReadonlyArray<string>;
7439
-
7457
+ /**
7458
+ * **This is an experimental feature.**
7459
+ *
7460
+ * Validate the input before generating output? This is an experimental,
7461
+ * lightweight feature and support will be added on an ad hoc basis.
7462
+ *
7463
+ * @default false
7464
+ */
7465
+ validate_EXPERIMENTAL?: boolean;
7440
7466
  /**
7441
7467
  * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
7442
7468
  *
@@ -7445,6 +7471,13 @@ interface Input {
7445
7471
  * the value.
7446
7472
  */
7447
7473
  version?: string;
7474
+ /**
7475
+ * Regenerate the client when the input file changes? You can alternatively
7476
+ * pass a numeric value for the interval in ms.
7477
+ *
7478
+ * @default false
7479
+ */
7480
+ watch?: boolean | number | Watch;
7448
7481
  }
7449
7482
 
7450
7483
  interface UserConfig {
@@ -7580,90 +7613,59 @@ interface UserConfig {
7580
7613
  * @default ['@hey-api/typescript', '@hey-api/sdk']
7581
7614
  */
7582
7615
  plugins?: ReadonlyArray<UserPlugins['name'] | UserPlugins>;
7583
- /**
7584
- * Regenerate the client when the input file changes? You can alternatively
7585
- * pass a numeric value for the interval in ms.
7586
- *
7587
- * @default false
7588
- */
7589
- watch?:
7590
- | boolean
7591
- | number
7592
- | {
7593
- /**
7594
- * Regenerate the client when the input file changes?
7595
- *
7596
- * @default false
7597
- */
7598
- enabled?: boolean;
7599
- /**
7600
- * How often should we attempt to detect the input file change? (in ms)
7601
- *
7602
- * @default 1000
7603
- */
7604
- interval?: number;
7605
- /**
7606
- * How long will we wait before the request times out?
7607
- *
7608
- * @default 60_000
7609
- */
7610
- timeout?: number;
7611
- };
7612
7616
 
7613
7617
  // DEPRECATED OPTIONS BELOW
7614
7618
 
7615
7619
  /**
7616
- * @deprecated
7617
- *
7618
7620
  * Manually set base in OpenAPI config instead of inferring from server value
7621
+ *
7622
+ * @deprecated
7619
7623
  */
7620
7624
  // eslint-disable-next-line typescript-sort-keys/interface
7621
7625
  base?: string;
7622
7626
  /**
7623
- * @deprecated
7624
- *
7625
7627
  * Opt in to the experimental parser?
7626
7628
  *
7629
+ * @deprecated
7627
7630
  * @default true
7628
7631
  */
7629
7632
  experimentalParser?: boolean;
7630
7633
  /**
7631
- * @deprecated
7632
- *
7633
7634
  * Generate core client classes?
7634
7635
  *
7636
+ * @deprecated
7635
7637
  * @default true
7636
7638
  */
7637
7639
  exportCore?: boolean;
7638
7640
  /**
7639
- * @deprecated
7640
- *
7641
7641
  * Custom client class name. Please note this option is deprecated and
7642
7642
  * will be removed in favor of clients.
7643
7643
  *
7644
+ * @deprecated
7644
7645
  * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-name
7645
7646
  */
7646
7647
  name?: string;
7647
7648
  /**
7648
- * @deprecated
7649
- *
7650
7649
  * Path to custom request file. Please note this option is deprecated and
7651
7650
  * will be removed in favor of clients.
7652
7651
  *
7652
+ * @deprecated
7653
7653
  * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-request
7654
7654
  */
7655
7655
  request?: string;
7656
7656
  /**
7657
- * @deprecated
7658
- *
7659
7657
  * Use options or arguments functions. Please note this option is deprecated and
7660
7658
  * will be removed in favor of clients.
7661
7659
  *
7662
- * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-useoptions
7663
- *
7660
+ * @deprecated
7664
7661
  * @default true
7662
+ * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-useoptions
7665
7663
  */
7666
7664
  useOptions?: boolean;
7665
+ /**
7666
+ * @deprecated use `input.watch` instead
7667
+ */
7668
+ watch?: boolean | number | Watch;
7667
7669
  }
7668
7670
 
7669
7671
  type Config = Omit<
@@ -7678,7 +7680,10 @@ type Config = Omit<
7678
7680
  | 'watch'
7679
7681
  > &
7680
7682
  Pick<UserConfig, 'base' | 'name' | 'request'> & {
7681
- input: Omit<Input, 'path'> & Pick<Required<Input>, 'path'>;
7683
+ input: Omit<Input, 'path' | 'validate_EXPERIMENTAL' | 'watch'> &
7684
+ Pick<Required<Input>, 'path' | 'validate_EXPERIMENTAL'> & {
7685
+ watch: Extract<Required<Required<Input>['watch']>, object>;
7686
+ };
7682
7687
  logs: Extract<Required<UserConfig['logs']>, object>;
7683
7688
  output: Extract<UserConfig['output'], object>;
7684
7689
  pluginOrder: ReadonlyArray<ClientPlugins['name']>;
@@ -7686,7 +7691,6 @@ type Config = Omit<
7686
7691
  ExtractArrayOfObjects<ReadonlyArray<ClientPlugins>, { name: string }>,
7687
7692
  'name'
7688
7693
  >;
7689
- watch: Extract<Required<UserConfig['watch']>, object>;
7690
7694
  };
7691
7695
 
7692
7696
  interface Identifier {
@@ -6491,9 +6491,9 @@ declare namespace Plugin {
6491
6491
  Pick<Required<BaseConfig>, 'exportFromIndex' | 'output'>;
6492
6492
 
6493
6493
  /**
6494
- * @deprecated
6495
- *
6496
6494
  * Plugin implementation for legacy parser.
6495
+ *
6496
+ * @deprecated
6497
6497
  */
6498
6498
  export type LegacyHandler<Config extends BaseConfig> = (args: {
6499
6499
  client: Client$1;
@@ -6799,8 +6799,6 @@ interface Config$b extends Plugin.Name<'@hey-api/sdk'> {
6799
6799
  // DEPRECATED OPTIONS BELOW
6800
6800
 
6801
6801
  /**
6802
- * @deprecated
6803
- *
6804
6802
  * **This feature works only with the legacy parser**
6805
6803
  *
6806
6804
  * Filter endpoints to be included in the generated SDK. The provided
@@ -6808,14 +6806,15 @@ interface Config$b extends Plugin.Name<'@hey-api/sdk'> {
6808
6806
  * included in the output. The input pattern this string will be tested
6809
6807
  * against is `{method} {path}`. For example, you can match
6810
6808
  * `POST /api/v1/foo` with `^POST /api/v1/foo$`.
6809
+ *
6810
+ * @deprecated
6811
6811
  */
6812
6812
  // eslint-disable-next-line typescript-sort-keys/interface
6813
6813
  filter?: string;
6814
6814
  /**
6815
- * @deprecated
6816
- *
6817
6815
  * Define shape of returned value from service calls
6818
6816
  *
6817
+ * @deprecated
6819
6818
  * @default 'body'
6820
6819
  */
6821
6820
  response?: 'body' | 'response';
@@ -6928,32 +6927,30 @@ interface Config$9 extends Plugin.Name<'@hey-api/typescript'> {
6928
6927
  // DEPRECATED OPTIONS BELOW
6929
6928
 
6930
6929
  /**
6931
- * @deprecated
6932
- *
6933
6930
  * **This feature works only with the legacy parser**
6934
6931
  *
6935
6932
  * Include only types matching regular expression.
6933
+ *
6934
+ * @deprecated
6936
6935
  */
6937
6936
  // eslint-disable-next-line typescript-sort-keys/interface
6938
6937
  include?: string;
6939
6938
  /**
6940
- * @deprecated
6941
- *
6942
6939
  * **This feature works only with the legacy parser**
6943
6940
  *
6944
6941
  * Use your preferred naming pattern
6945
6942
  *
6943
+ * @deprecated
6946
6944
  * @default 'preserve'
6947
6945
  */
6948
6946
  style?: 'PascalCase' | 'preserve';
6949
6947
  /**
6950
- * @deprecated
6951
- *
6952
6948
  * **This feature works only with the legacy parser**
6953
6949
  *
6954
6950
  * Generate a tree of types containing all operations? It will be named
6955
6951
  * $OpenApiTs.
6956
6952
  *
6953
+ * @deprecated
6957
6954
  * @default false
6958
6955
  */
6959
6956
  tree?: boolean;
@@ -7230,6 +7227,27 @@ type StringCase =
7230
7227
  | 'snake_case'
7231
7228
  | 'SCREAMING_SNAKE_CASE';
7232
7229
 
7230
+ interface Watch {
7231
+ /**
7232
+ * Regenerate the client when the input file changes?
7233
+ *
7234
+ * @default false
7235
+ */
7236
+ enabled?: boolean;
7237
+ /**
7238
+ * How often should we attempt to detect the input file change? (in ms)
7239
+ *
7240
+ * @default 1000
7241
+ */
7242
+ interval?: number;
7243
+ /**
7244
+ * How long will we wait before the request times out?
7245
+ *
7246
+ * @default 60_000
7247
+ */
7248
+ timeout?: number;
7249
+ }
7250
+
7233
7251
  interface Input {
7234
7252
  /**
7235
7253
  * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
@@ -7436,7 +7454,15 @@ interface Input {
7436
7454
  * the first match will be returned.
7437
7455
  */
7438
7456
  tags?: ReadonlyArray<string>;
7439
-
7457
+ /**
7458
+ * **This is an experimental feature.**
7459
+ *
7460
+ * Validate the input before generating output? This is an experimental,
7461
+ * lightweight feature and support will be added on an ad hoc basis.
7462
+ *
7463
+ * @default false
7464
+ */
7465
+ validate_EXPERIMENTAL?: boolean;
7440
7466
  /**
7441
7467
  * **Requires `path` to start with `https://get.heyapi.dev` or be undefined**
7442
7468
  *
@@ -7445,6 +7471,13 @@ interface Input {
7445
7471
  * the value.
7446
7472
  */
7447
7473
  version?: string;
7474
+ /**
7475
+ * Regenerate the client when the input file changes? You can alternatively
7476
+ * pass a numeric value for the interval in ms.
7477
+ *
7478
+ * @default false
7479
+ */
7480
+ watch?: boolean | number | Watch;
7448
7481
  }
7449
7482
 
7450
7483
  interface UserConfig {
@@ -7580,90 +7613,59 @@ interface UserConfig {
7580
7613
  * @default ['@hey-api/typescript', '@hey-api/sdk']
7581
7614
  */
7582
7615
  plugins?: ReadonlyArray<UserPlugins['name'] | UserPlugins>;
7583
- /**
7584
- * Regenerate the client when the input file changes? You can alternatively
7585
- * pass a numeric value for the interval in ms.
7586
- *
7587
- * @default false
7588
- */
7589
- watch?:
7590
- | boolean
7591
- | number
7592
- | {
7593
- /**
7594
- * Regenerate the client when the input file changes?
7595
- *
7596
- * @default false
7597
- */
7598
- enabled?: boolean;
7599
- /**
7600
- * How often should we attempt to detect the input file change? (in ms)
7601
- *
7602
- * @default 1000
7603
- */
7604
- interval?: number;
7605
- /**
7606
- * How long will we wait before the request times out?
7607
- *
7608
- * @default 60_000
7609
- */
7610
- timeout?: number;
7611
- };
7612
7616
 
7613
7617
  // DEPRECATED OPTIONS BELOW
7614
7618
 
7615
7619
  /**
7616
- * @deprecated
7617
- *
7618
7620
  * Manually set base in OpenAPI config instead of inferring from server value
7621
+ *
7622
+ * @deprecated
7619
7623
  */
7620
7624
  // eslint-disable-next-line typescript-sort-keys/interface
7621
7625
  base?: string;
7622
7626
  /**
7623
- * @deprecated
7624
- *
7625
7627
  * Opt in to the experimental parser?
7626
7628
  *
7629
+ * @deprecated
7627
7630
  * @default true
7628
7631
  */
7629
7632
  experimentalParser?: boolean;
7630
7633
  /**
7631
- * @deprecated
7632
- *
7633
7634
  * Generate core client classes?
7634
7635
  *
7636
+ * @deprecated
7635
7637
  * @default true
7636
7638
  */
7637
7639
  exportCore?: boolean;
7638
7640
  /**
7639
- * @deprecated
7640
- *
7641
7641
  * Custom client class name. Please note this option is deprecated and
7642
7642
  * will be removed in favor of clients.
7643
7643
  *
7644
+ * @deprecated
7644
7645
  * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-name
7645
7646
  */
7646
7647
  name?: string;
7647
7648
  /**
7648
- * @deprecated
7649
- *
7650
7649
  * Path to custom request file. Please note this option is deprecated and
7651
7650
  * will be removed in favor of clients.
7652
7651
  *
7652
+ * @deprecated
7653
7653
  * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-request
7654
7654
  */
7655
7655
  request?: string;
7656
7656
  /**
7657
- * @deprecated
7658
- *
7659
7657
  * Use options or arguments functions. Please note this option is deprecated and
7660
7658
  * will be removed in favor of clients.
7661
7659
  *
7662
- * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-useoptions
7663
- *
7660
+ * @deprecated
7664
7661
  * @default true
7662
+ * @link https://heyapi.dev/openapi-ts/migrating.html#deprecated-useoptions
7665
7663
  */
7666
7664
  useOptions?: boolean;
7665
+ /**
7666
+ * @deprecated use `input.watch` instead
7667
+ */
7668
+ watch?: boolean | number | Watch;
7667
7669
  }
7668
7670
 
7669
7671
  type Config = Omit<
@@ -7678,7 +7680,10 @@ type Config = Omit<
7678
7680
  | 'watch'
7679
7681
  > &
7680
7682
  Pick<UserConfig, 'base' | 'name' | 'request'> & {
7681
- input: Omit<Input, 'path'> & Pick<Required<Input>, 'path'>;
7683
+ input: Omit<Input, 'path' | 'validate_EXPERIMENTAL' | 'watch'> &
7684
+ Pick<Required<Input>, 'path' | 'validate_EXPERIMENTAL'> & {
7685
+ watch: Extract<Required<Required<Input>['watch']>, object>;
7686
+ };
7682
7687
  logs: Extract<Required<UserConfig['logs']>, object>;
7683
7688
  output: Extract<UserConfig['output'], object>;
7684
7689
  pluginOrder: ReadonlyArray<ClientPlugins['name']>;
@@ -7686,7 +7691,6 @@ type Config = Omit<
7686
7691
  ExtractArrayOfObjects<ReadonlyArray<ClientPlugins>, { name: string }>,
7687
7692
  'name'
7688
7693
  >;
7689
- watch: Extract<Required<UserConfig['watch']>, object>;
7690
7694
  };
7691
7695
 
7692
7696
  interface Identifier {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hey-api/openapi-ts",
3
- "version": "0.69.1",
3
+ "version": "0.69.2",
4
4
  "description": "🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.",
5
5
  "homepage": "https://heyapi.dev/",
6
6
  "repository": {
@@ -77,7 +77,9 @@
77
77
  },
78
78
  "dependencies": {
79
79
  "@hey-api/json-schema-ref-parser": "1.0.6",
80
+ "ansi-colors": "4.1.3",
80
81
  "c12": "2.0.1",
82
+ "color-support": "1.1.3",
81
83
  "commander": "13.0.0",
82
84
  "handlebars": "4.7.8"
83
85
  },
@@ -97,6 +99,7 @@
97
99
  "ts-node": "10.9.2",
98
100
  "tslib": "2.8.1",
99
101
  "typescript": "5.8.3",
102
+ "yaml": "2.8.0",
100
103
  "@config/vite-base": "0.0.1",
101
104
  "@hey-api/client-core": "0.1.4"
102
105
  },