@vc-shell/api-client-generator 2.0.0-alpha.8 → 2.0.0

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.
Files changed (4) hide show
  1. package/CHANGELOG.md +64 -205
  2. package/README.md +55 -50
  3. package/dist/api-client-generator.js +352 -291
  4. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,88 +1,81 @@
1
- # [2.0.0-alpha.8](https://github.com/VirtoCommerce/vc-shell/compare/v2.0.0-alpha.7...v2.0.0-alpha.8) (2026-03-12)
1
+ # Changelog
2
2
 
3
- **Note:** Version bump only for package @vc-shell/api-client-generator
4
-
5
- # [2.0.0-alpha.7](https://github.com/VirtoCommerce/vc-shell/compare/v2.0.0-alpha.6...v2.0.0-alpha.7) (2026-03-11)
6
-
7
- **Note:** Version bump only for package @vc-shell/api-client-generator
8
-
9
- # [2.0.0-alpha.6](https://github.com/VirtoCommerce/vc-shell/compare/v2.0.0-alpha.5...v2.0.0-alpha.6) (2026-03-10)
10
-
11
- **Note:** Version bump only for package @vc-shell/api-client-generator
12
-
13
- # [2.0.0-alpha.5](https://github.com/VirtoCommerce/vc-shell/compare/v2.0.0-alpha.4...v2.0.0-alpha.5) (2026-03-10)
14
-
15
- **Note:** Version bump only for package @vc-shell/api-client-generator
16
-
17
- # [2.0.0-alpha.4](https://github.com/VirtoCommerce/vc-shell/compare/v2.0.0-alpha.3...v2.0.0-alpha.4) (2026-03-10)
18
-
19
- **Note:** Version bump only for package @vc-shell/api-client-generator
20
-
21
- # [2.0.0-alpha.3](https://github.com/VirtoCommerce/vc-shell/compare/v2.0.0-alpha.2...v2.0.0-alpha.3) (2026-03-10)
22
-
23
- **Note:** Version bump only for package @vc-shell/api-client-generator
24
-
25
- # [2.0.0-alpha.2](https://github.com/VirtoCommerce/vc-shell/compare/v1.2.4-beta.8...v2.0.0-alpha.2) (2026-03-10)
26
-
27
- **Note:** Version bump only for package @vc-shell/api-client-generator
28
-
29
- # [2.0.0-alpha.1](https://github.com/VirtoCommerce/vc-shell/compare/v2.0.0-alpha.0...v2.0.0-alpha.1) (2026-03-10)
30
-
31
- **Note:** Version bump only for package @vc-shell/api-client-generator
32
-
33
- # [2.0.0-alpha.0](https://github.com/VirtoCommerce/vc-shell/compare/v1.2.4-beta.8...v2.0.0-alpha.0) (2026-03-10)
34
-
35
- **Note:** Version bump only for package @vc-shell/api-client-generator
36
-
37
- ## [1.2.4-beta.8](https://github.com/VirtoCommerce/vc-shell/compare/v1.2.4-beta.7...v1.2.4-beta.8) (2026-03-04)
38
-
39
- **Note:** Version bump only for package @vc-shell/api-client-generator
40
-
41
- ## [1.2.4-beta.7](https://github.com/VirtoCommerce/vc-shell/compare/v1.2.4-beta.6...v1.2.4-beta.7) (2026-03-04)
42
-
43
- **Note:** Version bump only for package @vc-shell/api-client-generator
44
-
45
- ## [1.2.4-beta.6](https://github.com/VirtoCommerce/vc-shell/compare/v1.2.4-beta.5...v1.2.4-beta.6) (2026-03-04)
46
-
47
- **Note:** Version bump only for package @vc-shell/api-client-generator
48
-
49
- ## [1.2.4-beta.5](https://github.com/VirtoCommerce/vc-shell/compare/v1.2.4-beta.4...v1.2.4-beta.5) (2026-03-04)
3
+ # [2.0.0](https://github.com/VirtoCommerce/vc-shell/compare/v1.2.3...v2.0.0) (2026-04-22)
50
4
 
51
5
  ### Features
52
6
 
7
+ - **api-client, migrate:** default to Interface for new API clients, add nswag class-to-interface migration ([569a1f7](https://github.com/VirtoCommerce/vc-shell/commit/569a1f79532d5ca2e1a9968e3b249b3d3ffeed71))
8
+ - **api-client:** add simple mode — generate only .ts files by default ([2f5a475](https://github.com/VirtoCommerce/vc-shell/commit/2f5a475ad9ec9928f7aae8e2ecf03e38b0a22bd1))
53
9
  - **api-client:** support .NET 9/10 runtimes, bump nswag to 14.6.3 ([7ef1a23](https://github.com/VirtoCommerce/vc-shell/commit/7ef1a234a935bc528d3501723070d3166bfbe2aa))
54
10
 
55
11
  ### Bug Fixes
56
12
 
57
13
  - **api-client:** ensure trailing slash on platform URL to prevent invalid URI error ([af09115](https://github.com/VirtoCommerce/vc-shell/commit/af09115ec7ea7420020042918ab2be1263bd8651))
58
14
 
59
- ## [1.2.4-beta.4](https://github.com/VirtoCommerce/vc-shell/compare/v1.2.4-beta.3...v1.2.4-beta.4) (2026-02-24)
60
-
61
- **Note:** Version bump only for package @vc-shell/api-client-generator
62
-
63
- ## [1.2.4-beta.3](https://github.com/VirtoCommerce/vc-shell/compare/v1.2.4-beta.2...v1.2.4-beta.3) (2026-02-20)
64
-
65
15
  ### Code Refactoring
66
16
 
17
+ - **cli,configs,packages:** apply ESLint flat config lint fixes ([394d5ca](https://github.com/VirtoCommerce/vc-shell/commit/394d5caa30f07ff8408dead09c998deabe0c163f))
67
18
  - configure path aliases and migrate imports ([bfffc3c](https://github.com/VirtoCommerce/vc-shell/commit/bfffc3cbe8029cf875e49941061b582825cad9a6))
68
19
 
69
- ## [1.2.4-beta.2](https://github.com/VirtoCommerce/vc-shell/compare/v1.2.4-beta.1...v1.2.4-beta.2) (2026-02-16)
70
-
71
- **Note:** Version bump only for package @vc-shell/api-client-generator
72
-
73
- ## [1.2.4-beta.1](https://github.com/VirtoCommerce/vc-shell/compare/v1.2.4-beta.0...v1.2.4-beta.1) (2026-02-16)
74
-
75
- **Note:** Version bump only for package @vc-shell/api-client-generator
76
-
77
- ## [1.2.4-beta.0](https://github.com/VirtoCommerce/vc-shell/compare/v1.2.3-beta.1...v1.2.4-beta.0) (2026-02-16)
78
-
79
- **Note:** Version bump only for package @vc-shell/api-client-generator
80
-
81
- ## [1.2.3-beta.1](https://github.com/VirtoCommerce/vc-shell/compare/v1.2.3...v1.2.3-beta.1) (2026-01-26)
82
-
83
- ### Features
84
-
85
- - integrate AI agent plugin into VC-Shell framework ([706f015](https://github.com/VirtoCommerce/vc-shell/commit/706f015f436ecc4ca19831e7159213b0759df6bc))
20
+ ### Styles
21
+
22
+ - **lint:** one-time cleanup of pre-existing violations and tech debt ([a7113c5](https://github.com/VirtoCommerce/vc-shell/commit/a7113c5d25b5b4dc9da20f6bc40c54b57fe46422))
23
+
24
+ ### Chores
25
+
26
+ - bump package versions to 1.2.4-beta.4 for api-client-generator, create-vc-app, ts-config, and release-config ([1b590c9](https://github.com/VirtoCommerce/vc-shell/commit/1b590c9e7733b1784b7ac3a992a745dfc666a236))
27
+ - **release:** v2.0.0-alpha.7 ([adf49e7](https://github.com/VirtoCommerce/vc-shell/commit/adf49e74bd3617d3aa51c9d4db94474294b3b925))
28
+ - update changelogs for multiple packages, including bug fixes and feature enhancements ([72e690f](https://github.com/VirtoCommerce/vc-shell/commit/72e690f5e21aaaf22ce34ff41ec60fb11ed1d018))
29
+
30
+ ### Other Changes
31
+
32
+ - Feat/research (#216) ([f028d9e](https://github.com/VirtoCommerce/vc-shell/commit/f028d9e1fe410a18fec4e127a65860cfb2309e36)), closes [#216](https://github.com/VirtoCommerce/vc-shell/issues/216)
33
+ - Feat/research (#217) ([174beee](https://github.com/VirtoCommerce/vc-shell/commit/174beeef16d0f9c7d6a5b96f0cc375bc50eb06d2)), closes [#217](https://github.com/VirtoCommerce/vc-shell/issues/217)
34
+ - Feat/vc table compositional (#215) ([2194f2f](https://github.com/VirtoCommerce/vc-shell/commit/2194f2fb82009e3dd5f2e17389b7fb03dd74b603)), closes [#215](https://github.com/VirtoCommerce/vc-shell/issues/215)
35
+ - Feat/virto oz (#214) ([21250c9](https://github.com/VirtoCommerce/vc-shell/commit/21250c93ebb2d096b7accdde6b02a73782fc6535)), closes [#214](https://github.com/VirtoCommerce/vc-shell/issues/214)
36
+
37
+ ### release
38
+
39
+ - v1.2.3 ([6270dab](https://github.com/VirtoCommerce/vc-shell/commit/6270dab6a5a8149c8380d17d55b77531bad13531))
40
+ - v1.2.4-beta.2 ([d4cf91e](https://github.com/VirtoCommerce/vc-shell/commit/d4cf91ea30b40f13cc7ca13e7d11c8da13459175))
41
+ - v1.2.4-beta.3 ([d42e7a8](https://github.com/VirtoCommerce/vc-shell/commit/d42e7a822a2b2c7a5f89bf83d97babc2e4b3fa07))
42
+ - v1.2.4-beta.5 ([4cc2527](https://github.com/VirtoCommerce/vc-shell/commit/4cc2527f06178114fd3db9f781b1d6fd868a7a61))
43
+ - v1.2.4-beta.6 ([86734c4](https://github.com/VirtoCommerce/vc-shell/commit/86734c47306da89feb6b16685287744bb2855cc8))
44
+ - v1.2.4-beta.7 ([cc6ef5c](https://github.com/VirtoCommerce/vc-shell/commit/cc6ef5c98d3f8b6489126a950e994335016ea35d))
45
+ - v1.2.4-beta.8 ([25aa324](https://github.com/VirtoCommerce/vc-shell/commit/25aa3246d45b375af4fffcc256a447d05dfda64c))
46
+ - v2.0.0-alpha.10 ([5a9c0af](https://github.com/VirtoCommerce/vc-shell/commit/5a9c0af632a17e2d01dcd0dc07a166aabe6fe903))
47
+ - v2.0.0-alpha.11 ([4e5d63e](https://github.com/VirtoCommerce/vc-shell/commit/4e5d63ee34bb825d8e363e40fbac27e711261f9e))
48
+ - v2.0.0-alpha.12 ([7143a74](https://github.com/VirtoCommerce/vc-shell/commit/7143a74ae0bdd3d70f0133b69d380b82c10526c1))
49
+ - v2.0.0-alpha.13 ([c422678](https://github.com/VirtoCommerce/vc-shell/commit/c42267854f9ed51215e8363165c9bfe077c313a3))
50
+ - v2.0.0-alpha.14 ([0c91031](https://github.com/VirtoCommerce/vc-shell/commit/0c91031706843ccbc2f5d32093c8655c6bbc718f))
51
+ - v2.0.0-alpha.15 ([fa8958e](https://github.com/VirtoCommerce/vc-shell/commit/fa8958e7241117ebff164a2d399f13f74d48b55f))
52
+ - v2.0.0-alpha.16 ([79ab2b1](https://github.com/VirtoCommerce/vc-shell/commit/79ab2b1022258332c327e742ab0adf1b8fde35ce))
53
+ - v2.0.0-alpha.17 ([408e4af](https://github.com/VirtoCommerce/vc-shell/commit/408e4af487f37b8aff790398d5a992820c8f05a2))
54
+ - v2.0.0-alpha.18 ([2466e35](https://github.com/VirtoCommerce/vc-shell/commit/2466e359313c9d78893d2473474ec5ce46ad49ca))
55
+ - v2.0.0-alpha.19 ([9d5a075](https://github.com/VirtoCommerce/vc-shell/commit/9d5a075e0a722c6c7371706f582b59bbf570ef37))
56
+ - v2.0.0-alpha.2 ([223c859](https://github.com/VirtoCommerce/vc-shell/commit/223c8596dbad42704072ffc0dd1c4b8361227af0))
57
+ - v2.0.0-alpha.20 ([98bd4a6](https://github.com/VirtoCommerce/vc-shell/commit/98bd4a62ffa933bbfdae16ef7e46777084f15190))
58
+ - v2.0.0-alpha.21 ([bbd0d70](https://github.com/VirtoCommerce/vc-shell/commit/bbd0d70464ff5c0dafbc67ed3bf8ea36f65b0a7a))
59
+ - v2.0.0-alpha.22 ([ec455eb](https://github.com/VirtoCommerce/vc-shell/commit/ec455eba6bb91ae5fdbea64817ce1650116b9d50))
60
+ - v2.0.0-alpha.23 ([65b2144](https://github.com/VirtoCommerce/vc-shell/commit/65b214434ef1630069aecd6f2eaf916531bf37ef))
61
+ - v2.0.0-alpha.24 ([05ff510](https://github.com/VirtoCommerce/vc-shell/commit/05ff5107b81e0280447872ea52771fc47cb3cd67))
62
+ - v2.0.0-alpha.25 ([19d09b9](https://github.com/VirtoCommerce/vc-shell/commit/19d09b998861836b288aba36a6d18d7b26cff0b7))
63
+ - v2.0.0-alpha.26 ([ee6818c](https://github.com/VirtoCommerce/vc-shell/commit/ee6818ceb60b24d26b7011f2584c8d23f6b4fd3e))
64
+ - v2.0.0-alpha.27 ([f43652d](https://github.com/VirtoCommerce/vc-shell/commit/f43652d1aae8af36d5d2f00312492ea9de57f2f1))
65
+ - v2.0.0-alpha.28 ([7954dfd](https://github.com/VirtoCommerce/vc-shell/commit/7954dfddf1126d00038b8f66a6fe3efc5c19cfe8))
66
+ - v2.0.0-alpha.29 ([ffa72cf](https://github.com/VirtoCommerce/vc-shell/commit/ffa72cf458eed77c78955c88d211a82ead152b0f))
67
+ - v2.0.0-alpha.3 ([23e82c2](https://github.com/VirtoCommerce/vc-shell/commit/23e82c2423efb5cddf8ea891ea5d5e84832a6acd))
68
+ - v2.0.0-alpha.30 ([2db7f17](https://github.com/VirtoCommerce/vc-shell/commit/2db7f17d74afe97e3c6dfef2de436a797f0c32f4))
69
+ - v2.0.0-alpha.31 ([8d92fba](https://github.com/VirtoCommerce/vc-shell/commit/8d92fbad5954c71164e7815193b3496e569a5703))
70
+ - v2.0.0-alpha.32 ([1ed5533](https://github.com/VirtoCommerce/vc-shell/commit/1ed5533a6a20081e655f2e628bf824de40472f5d))
71
+ - v2.0.0-alpha.33 ([49cad36](https://github.com/VirtoCommerce/vc-shell/commit/49cad36a454534136b52576e6a0d97dfe48ae895))
72
+ - v2.0.0-alpha.34 ([78bed5a](https://github.com/VirtoCommerce/vc-shell/commit/78bed5af3aeb7ace2eb9f58ddde3235fced47b37))
73
+ - v2.0.0-alpha.35 ([05d6f25](https://github.com/VirtoCommerce/vc-shell/commit/05d6f2562c939dd4a2e7e4e7a3d80948beccbef1))
74
+ - v2.0.0-alpha.4 ([a3098f9](https://github.com/VirtoCommerce/vc-shell/commit/a3098f9ccc128c4ad3b4d8b5cbcbf8ea7a0f6df5))
75
+ - v2.0.0-alpha.5 ([3cae61a](https://github.com/VirtoCommerce/vc-shell/commit/3cae61a852a8f88aac8e0c51affad4517c8c5eca))
76
+ - v2.0.0-alpha.6 ([9196b2c](https://github.com/VirtoCommerce/vc-shell/commit/9196b2c232094d8d7750963718777096c0cc9864))
77
+ - v2.0.0-alpha.8 ([8228f12](https://github.com/VirtoCommerce/vc-shell/commit/8228f12bffc014ae0f8f28b3ef3fa0ac02bc33e2))
78
+ - v2.0.0-alpha.9 ([ef631bd](https://github.com/VirtoCommerce/vc-shell/commit/ef631bdbccbf2be1afbc592418e680e79d2c1fbe))
86
79
 
87
80
  ## [1.2.3](https://github.com/VirtoCommerce/vc-shell/compare/v1.2.2...v1.2.3) (2026-01-12)
88
81
 
@@ -92,62 +85,6 @@
92
85
 
93
86
  **Note:** Version bump only for package @vc-shell/api-client-generator
94
87
 
95
- ## [1.2.3-beta.0](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.99-alpha.14...v1.2.3-beta.0) (2025-12-26)
96
-
97
- ### Features
98
-
99
- - integrate AI agent plugin into VC-Shell framework ([706f015](https://github.com/VirtoCommerce/vc-shell/commit/706f015f436ecc4ca19831e7159213b0759df6bc))
100
-
101
- ## [1.1.99-alpha.14](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.99-alpha.13...v1.1.99-alpha.14) (2025-11-27)
102
-
103
- **Note:** Version bump only for package @vc-shell/api-client-generator
104
-
105
- ## [1.1.99-alpha.13](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.99-alpha.12...v1.1.99-alpha.13) (2025-11-27)
106
-
107
- **Note:** Version bump only for package @vc-shell/api-client-generator
108
-
109
- ## [1.1.99-alpha.12](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.99-alpha.11...v1.1.99-alpha.12) (2025-11-27)
110
-
111
- **Note:** Version bump only for package @vc-shell/api-client-generator
112
-
113
- ## [1.1.99-alpha.11](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.99-alpha.10...v1.1.99-alpha.11) (2025-11-27)
114
-
115
- **Note:** Version bump only for package @vc-shell/api-client-generator
116
-
117
- ## [1.1.99-alpha.10](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.99-alpha.9...v1.1.99-alpha.10) (2025-11-27)
118
-
119
- **Note:** Version bump only for package @vc-shell/api-client-generator
120
-
121
- ## [1.1.99-alpha.9](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.99-alpha.8...v1.1.99-alpha.9) (2025-11-26)
122
-
123
- **Note:** Version bump only for package @vc-shell/api-client-generator
124
-
125
- ## [1.1.99-alpha.8](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.99-alpha.7...v1.1.99-alpha.8) (2025-11-25)
126
-
127
- **Note:** Version bump only for package @vc-shell/api-client-generator
128
-
129
- ## [1.1.99-alpha.7](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.99-alpha.6...v1.1.99-alpha.7) (2025-11-25)
130
-
131
- **Note:** Version bump only for package @vc-shell/api-client-generator
132
-
133
- ## [1.1.99-alpha.6](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.99-alpha.5...v1.1.99-alpha.6) (2025-11-25)
134
-
135
- **Note:** Version bump only for package @vc-shell/api-client-generator
136
-
137
- ## [1.1.99-alpha.5](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.99-alpha.4...v1.1.99-alpha.5) (2025-11-25)
138
-
139
- **Note:** Version bump only for package @vc-shell/api-client-generator
140
-
141
- ## [1.1.99-alpha.4](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.99-alpha.3...v1.1.99-alpha.4) (2025-11-25)
142
-
143
- **Note:** Version bump only for package @vc-shell/api-client-generator
144
-
145
- ## [1.1.99-alpha.3](https://github.com/VirtoCommerce/vc-shell/compare/v1.2.1...v1.1.99-alpha.3) (2025-11-25)
146
-
147
- ### Features
148
-
149
- - update auth providers and fix tsx path in pre-commit hook ([a92d957](https://github.com/VirtoCommerce/vc-shell/commit/a92d957e2b0a0be177519e7256af9279d3419713))
150
-
151
88
  ## [1.2.1](https://github.com/VirtoCommerce/vc-shell/compare/v1.2.0...v1.2.1) (2025-11-13)
152
89
 
153
90
  **Note:** Version bump only for package @vc-shell/api-client-generator
@@ -156,44 +93,6 @@
156
93
 
157
94
  **Note:** Version bump only for package @vc-shell/api-client-generator
158
95
 
159
- ## [1.1.99-alpha.2](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.99-alpha.1...v1.1.99-alpha.2) (2025-11-07)
160
-
161
- **Note:** Version bump only for package @vc-shell/api-client-generator
162
-
163
- ## [1.1.99-alpha.1](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.99-alpha.0...v1.1.99-alpha.1) (2025-11-07)
164
-
165
- **Note:** Version bump only for package @vc-shell/api-client-generator
166
-
167
- ## [1.1.99-alpha.0](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.98-rc.5...v1.1.99-alpha.0) (2025-11-07)
168
-
169
- **Note:** Version bump only for package @vc-shell/api-client-generator
170
-
171
- ## [1.1.98-rc.5](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.98-rc.4...v1.1.98-rc.5) (2025-11-07)
172
-
173
- ### Features
174
-
175
- - update auth providers and fix tsx path in pre-commit hook ([a92d957](https://github.com/VirtoCommerce/vc-shell/commit/a92d957e2b0a0be177519e7256af9279d3419713))
176
-
177
- ## [1.1.98-rc.4](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.98-rc.3...v1.1.98-rc.4) (2025-10-24)
178
-
179
- **Note:** Version bump only for package @vc-shell/api-client-generator
180
-
181
- ## [1.1.98-rc.3](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.98-rc.2...v1.1.98-rc.3) (2025-10-24)
182
-
183
- **Note:** Version bump only for package @vc-shell/api-client-generator
184
-
185
- ## [1.1.98-rc.2](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.98-rc.1...v1.1.98-rc.2) (2025-10-24)
186
-
187
- **Note:** Version bump only for package @vc-shell/api-client-generator
188
-
189
- ## [1.1.98-rc.1](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.98-rc.0...v1.1.98-rc.1) (2025-10-24)
190
-
191
- **Note:** Version bump only for package @vc-shell/api-client-generator
192
-
193
- ## [1.1.98-rc.0](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.97...v1.1.98-rc.0) (2025-10-24)
194
-
195
- **Note:** Version bump only for package @vc-shell/api-client-generator
196
-
197
96
  ## [1.1.97](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.96...v1.1.97) (2025-10-24)
198
97
 
199
98
  **Note:** Version bump only for package @vc-shell/api-client-generator
@@ -222,28 +121,6 @@
222
121
 
223
122
  **Note:** Version bump only for package @vc-shell/api-client-generator
224
123
 
225
- ## [1.1.91-alpha.5](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.91-alpha.4...v1.1.91-alpha.5) (2025-10-14)
226
-
227
- **Note:** Version bump only for package @vc-shell/api-client-generator
228
-
229
- ## [1.1.91-alpha.4](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.91-alpha.3...v1.1.91-alpha.4) (2025-10-14)
230
-
231
- **Note:** Version bump only for package @vc-shell/api-client-generator
232
-
233
- ## [1.1.91-alpha.3](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.91-alpha.2...v1.1.91-alpha.3) (2025-10-14)
234
-
235
- **Note:** Version bump only for package @vc-shell/api-client-generator
236
-
237
- ## [1.1.91-alpha.2](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.91-alpha.1...v1.1.91-alpha.2) (2025-10-14)
238
-
239
- **Note:** Version bump only for package @vc-shell/api-client-generator
240
-
241
- ## [1.1.91-alpha.1](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.90...v1.1.91-alpha.1) (2025-10-14)
242
-
243
- ### Features
244
-
245
- - update auth providers and fix tsx path in pre-commit hook ([a92d957](https://github.com/VirtoCommerce/vc-shell/commit/a92d957e2b0a0be177519e7256af9279d3419713))
246
-
247
124
  ## [1.1.90](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.89...v1.1.90) (2025-10-08)
248
125
 
249
126
  ### Features
@@ -286,18 +163,10 @@
286
163
 
287
164
  **Note:** Version bump only for package @vc-shell/api-client-generator
288
165
 
289
- ## [1.1.84-alpha.0](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.83...v1.1.84-alpha.0) (2025-09-30)
290
-
291
- **Note:** Version bump only for package @vc-shell/api-client-generator
292
-
293
166
  ## [1.1.83](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.83-alpha.0...v1.1.83) (2025-09-30)
294
167
 
295
168
  **Note:** Version bump only for package @vc-shell/api-client-generator
296
169
 
297
- ## [1.1.83-alpha.0](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.82...v1.1.83-alpha.0) (2025-09-24)
298
-
299
- **Note:** Version bump only for package @vc-shell/api-client-generator
300
-
301
170
  ## [1.1.82](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.81...v1.1.82) (2025-09-23)
302
171
 
303
172
  **Note:** Version bump only for package @vc-shell/api-client-generator
@@ -680,12 +549,6 @@
680
549
 
681
550
  **Note:** Version bump only for package @vc-shell/api-client-generator
682
551
 
683
- ## [1.1.0-alpha.2](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.340...v1.1.0-alpha.2) (2025-02-25)
684
-
685
- ### Features
686
-
687
- - partial redesign ([846e215](https://github.com/VirtoCommerce/vc-shell/commit/846e2152c6e48753622ca7cf3a71300323c99d51))
688
-
689
552
  ## [1.0.340](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.339...v1.0.340) (2025-02-06)
690
553
 
691
554
  **Note:** Version bump only for package @vc-shell/api-client-generator
@@ -740,10 +603,6 @@
740
603
 
741
604
  **Note:** Version bump only for package @vc-shell/api-client-generator
742
605
 
743
- ## [1.1.0-alpha.1](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.327...v1.1.0-alpha.1) (2024-11-13)
744
-
745
- **Note:** Version bump only for package @vc-shell/api-client-generator
746
-
747
606
  ## [1.0.327](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.326...v1.0.327) (2024-11-12)
748
607
 
749
608
  **Note:** Version bump only for package @vc-shell/api-client-generator
package/README.md CHANGED
@@ -5,11 +5,11 @@
5
5
  This guide describes the process of generating an API client to access the VC Platform API from your custom application.
6
6
 
7
7
  !!! note
8
- Platform Manager REST Client offers generated REST API methods that make it easy to interact with the existing VirtoCommerce Platform API.
8
+ Platform Manager REST Client offers generated REST API methods that make it easy to interact with the existing VirtoCommerce Platform API.
9
9
 
10
10
  ## Prerequisites
11
11
 
12
- * .NET Core 6.0, particularly if you are using MacOS or Linux.
12
+ - .NET Core 6.0, particularly if you are using MacOS or Linux.
13
13
 
14
14
  ## Generate TypeScript API clients
15
15
 
@@ -22,6 +22,7 @@ Using command
22
22
  ```bash
23
23
  yarn add @vc-shell/api-client-generator cross-env
24
24
  ```
25
+
25
26
  <br>
26
27
 
27
28
  `cross-env` runs scripts that set and use environment variables across platforms.
@@ -44,57 +45,57 @@ Add the dependencies to your project's **package.json**:
44
45
 
45
46
  2. Configure client generation in your project. Inside your project's **package.json** file, add a `"generate-api-client"` command to the list of scripts:
46
47
 
47
- ```title="vc-app-extend/package.json" linenums="1"
48
- {
49
- "scripts": {
50
- ...
51
- "generate-api-client": cross-env api-client-generator --APP_PLATFORM_MODULES='[Virtocommerce.MarketplaceVendor,Virtocommerce.Catalog,Virtocommerce.Orders]' --APP_API_CLIENT_DIRECTORY=./src/api_client/
52
- }
53
- }
54
- ```
55
-
56
- The options are listed in the table below:
57
-
58
- | Options | Description | Example |
59
- |----------------------------- |---------------------------------------------------------------- |------------------------------------------------------------ |
60
- | `--APP_PLATFORM_MODULES` | Platform modules to generate API client.<br>{==string[]==} <br> Supports spaces in module lists: `[Module1, Module2]` or `[Module1,Module2]`<br>Customize the `--APP_PLATFORM_MODULES` list<br>to match your project's requirements. | `--APP_PLATFORM_MODULES='[Virtocommerce.MarketplaceVendor, Virtocommerce.Orders, Virtocommerce.Catalog]'` |
61
- | `--APP_API_CLIENT_DIRECTORY` | Output directory for generated API clients. <br>{==string==} | `--APP_API_CLIENT_DIRECTORY=./src/api_client/` |
62
- | `--APP_PLATFORM_URL` | Platform URL to obtain client API configs. <br>{==string==} | `--APP_PLATFORM_URL=https://vcmp-dev.govirto.com/` |
63
- | `--APP_PACKAGE_NAME` | Package name for generated API clients. <br>{==string==} | `--APP_PACKAGE_NAME=@api-client` |
64
- | `--APP_PACKAGE_VERSION` | Package version for generated API clients. <br>{==string==} | `--APP_PACKAGE_VERSION=1.1.0` |
65
- | `--APP_OUT_DIR` | Output directory for generated API clients. <br>{==string==} | `--APP_OUT_DIR=./src/api_client/` |
66
- | `--APP_TYPE_STYLE` | Sets the type style for generated DTOs. Can be 'Class' or 'Interface'.<br>{==string==} | `--APP_TYPE_STYLE=Interface` |
67
- | `--APP_BUILD_DIR` | Directory where TypeScript files will be compiled. <br>{==string==} | `--APP_BUILD_DIR=lib` (default is "dist") |
68
- | `--SKIP_BUILD` | Skip build step. <br>{==boolean==} | `--SKIP_BUILD=true` |
69
- | `--VERBOSE` | Enable verbose logging. <br>{==boolean==} | `--VERBOSE=true` |
70
-
71
- !!! note
72
- For the `--APP_TYPE_STYLE` parameter, use **exactly** `"Class"` or `"Interface"` (case-sensitive). Any other value will cause an error.
73
-
74
- !!! tip
75
- Use `--APP_TYPE_STYLE=Interface` for better TypeScript integration and smaller bundle sizes. Use `--APP_TYPE_STYLE=Class` when you need runtime type checking or class-specific features.
48
+ ```title="vc-app-extend/package.json" linenums="1"
49
+ {
50
+ "scripts": {
51
+ ...
52
+ "generate-api-client": cross-env api-client-generator --APP_PLATFORM_MODULES='[Virtocommerce.MarketplaceVendor,Virtocommerce.Catalog,Virtocommerce.Orders]' --APP_API_CLIENT_DIRECTORY=./src/api_client/
53
+ }
54
+ }
55
+ ```
56
+
57
+ The options are listed in the table below:
58
+
59
+ | Options | Description | Example |
60
+ | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- |
61
+ | `--APP_PLATFORM_MODULES` | Platform modules to generate API client.<br>{==string[]==} <br> Supports spaces in module lists: `[Module1, Module2]` or `[Module1,Module2]`<br>Customize the `--APP_PLATFORM_MODULES` list<br>to match your project's requirements. | `--APP_PLATFORM_MODULES='[Virtocommerce.MarketplaceVendor, Virtocommerce.Orders, Virtocommerce.Catalog]'` |
62
+ | `--APP_API_CLIENT_DIRECTORY` | Output directory for generated API clients. <br>{==string==} | `--APP_API_CLIENT_DIRECTORY=./src/api_client/` |
63
+ | `--APP_PLATFORM_URL` | Platform URL to obtain client API configs. <br>{==string==} | `--APP_PLATFORM_URL=https://vcmp-dev.govirto.com/` |
64
+ | `--APP_PACKAGE_NAME` | Package name for generated API clients. <br>{==string==} | `--APP_PACKAGE_NAME=@api-client` |
65
+ | `--APP_PACKAGE_VERSION` | Package version for generated API clients. <br>{==string==} | `--APP_PACKAGE_VERSION=1.1.0` |
66
+ | `--APP_OUT_DIR` | Output directory for generated API clients. <br>{==string==} | `--APP_OUT_DIR=./src/api_client/` |
67
+ | `--APP_TYPE_STYLE` | Sets the type style for generated DTOs. Can be 'Class' or 'Interface'.<br>{==string==} | `--APP_TYPE_STYLE=Interface` |
68
+ | `--APP_BUILD_DIR` | Directory where TypeScript files will be compiled. <br>{==string==} | `--APP_BUILD_DIR=lib` (default is "dist") |
69
+ | `--SKIP_BUILD` | Skip build step. <br>{==boolean==} | `--SKIP_BUILD=true` |
70
+ | `--VERBOSE` | Enable verbose logging. <br>{==boolean==} | `--VERBOSE=true` |
71
+
72
+ !!! note
73
+ For the `--APP_TYPE_STYLE` parameter, use **exactly** `"Class"` or `"Interface"` (case-sensitive). Any other value will cause an error.
74
+
75
+ !!! tip
76
+ Use `--APP_TYPE_STYLE=Interface` for better TypeScript integration and smaller bundle sizes. Use `--APP_TYPE_STYLE=Class` when you need runtime type checking or class-specific features.
76
77
 
77
78
  3. Configure Platform URL and other settings in your project's **.env** file:
78
79
 
79
- ```title="vc-app-extend/.env"
80
- APP_PLATFORM_URL=https://vcmp-dev.govirto.com/
81
- APP_PLATFORM_MODULES=[Virtocommerce.MarketplaceVendor,Virtocommerce.Catalog,Virtocommerce.Orders]
82
- APP_API_CLIENT_DIRECTORY=./src/api_client/
83
- APP_PACKAGE_NAME=@my-app/api-client
84
- APP_PACKAGE_VERSION=1.0.0
85
- APP_BUILD_DIR=dist
86
- VERBOSE=true
87
- SKIP_BUILD=false
88
- ```
80
+ ```title="vc-app-extend/.env"
81
+ APP_PLATFORM_URL=https://vcmp-dev.govirto.com/
82
+ APP_PLATFORM_MODULES=[Virtocommerce.MarketplaceVendor,Virtocommerce.Catalog,Virtocommerce.Orders]
83
+ APP_API_CLIENT_DIRECTORY=./src/api_client/
84
+ APP_PACKAGE_NAME=@my-app/api-client
85
+ APP_PACKAGE_VERSION=1.0.0
86
+ APP_BUILD_DIR=dist
87
+ VERBOSE=true
88
+ SKIP_BUILD=false
89
+ ```
89
90
 
90
- !!! note
91
- All configuration options can be set via environment variables in `.env` file or passed as command line arguments. Environment variables take precedence over CLI arguments.
91
+ !!! note
92
+ All configuration options can be set via environment variables in `.env` file or passed as command line arguments. Environment variables take precedence over CLI arguments.
92
93
 
93
94
  4. Generate the API clients using the following command:
94
95
 
95
- ```
96
- yarn generate-api-client
97
- ```
96
+ ```
97
+ yarn generate-api-client
98
+ ```
98
99
 
99
100
  This command generates the required API clients for your custom application. Now you can effortlessly access the VC Platform API from your custom application using the generated API client.
100
101
 
@@ -125,7 +126,7 @@ API client now includes metadata to track the generation:
125
126
 
126
127
  The generator handles multiple API clients effectively:
127
128
 
128
- - Creates standardized exports with both short names (`./{moduleName}`) and full names (`./virtocommerce.{moduleName}`)
129
+ - Creates standardized exports with both short names (`./{moduleName}`) and full names (`./virtocommerce.{moduleName}`)
129
130
  - Prevents duplicate module exports by intelligently merging with existing ones
130
131
  - Automatically removes `module` and `types` fields that conflict with multiple exports
131
132
  - Works properly with incremental generation (can add new APIs without breaking existing ones)
@@ -142,11 +143,11 @@ This enables both simple usage for single-API packages and proper subpath export
142
143
 
143
144
  ```js
144
145
  // Single API package (using root export)
145
- import { MyClient } from '@myapp/api';
146
+ import { MyClient } from "@myapp/api";
146
147
 
147
148
  // Multi-API package (using subpath exports)
148
- import { ClientA } from '@myapp/api/moduleA';
149
- import { ClientB } from '@myapp/api/moduleB';
149
+ import { ClientA } from "@myapp/api/moduleA";
150
+ import { ClientB } from "@myapp/api/moduleB";
150
151
  ```
151
152
 
152
153
  ### Directory Creation
@@ -223,6 +224,7 @@ If you encounter issues during API client generation:
223
224
  #### APP_TYPE_STYLE Error
224
225
 
225
226
  If you see an error like:
227
+
226
228
  ```
227
229
  Error converting value "$(APP_TYPE_STYLE)" to type 'NJsonSchema.CodeGeneration.TypeScript.TypeScriptTypeStyle'
228
230
  ```
@@ -230,11 +232,13 @@ Error converting value "$(APP_TYPE_STYLE)" to type 'NJsonSchema.CodeGeneration.T
230
232
  This means the `APP_TYPE_STYLE` parameter was not properly validated or passed to NSwag:
231
233
 
232
234
  **Solution:**
235
+
233
236
  1. Ensure you're using exactly `"Class"` or `"Interface"` (case-sensitive)
234
237
  2. Check that you're passing the parameter correctly: `--APP_TYPE_STYLE=Interface`
235
238
  3. Enable verbose logging to see what value is being passed: `--VERBOSE=true`
236
239
 
237
240
  **Example of correct usage:**
241
+
238
242
  ```bash
239
243
  yarn generate-api-client --APP_TYPE_STYLE=Interface --VERBOSE=true
240
244
  ```
@@ -242,6 +246,7 @@ yarn generate-api-client --APP_TYPE_STYLE=Interface --VERBOSE=true
242
246
  #### NSwag Command Failed
243
247
 
244
248
  If NSwag fails with exit code, check:
249
+
245
250
  1. .NET Core 6.0 or later is installed
246
251
  2. The platform URL is accessible
247
252
  3. The specified modules exist on the platform