@shopware/api-gen 1.2.0 → 1.3.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 (3) hide show
  1. package/README.md +7 -4
  2. package/dist/cli.mjs +671 -244
  3. package/package.json +6 -6
package/README.md CHANGED
@@ -107,7 +107,8 @@ Example:
107
107
 
108
108
  ```json
109
109
  {
110
- "patches": ["./api-types/storeApiTypes.overrides.json"]
110
+ "$schema": "https://raw.githubusercontent.com/shopware/frontends/main/packages/api-gen/api-gen.schema.json",
111
+ "patches": ["storeApiTypes.overrides.json"]
111
112
  }
112
113
  ```
113
114
 
@@ -115,6 +116,7 @@ or you could use multiple patches and add your own overrides on top:
115
116
 
116
117
  ```json
117
118
  {
119
+ "$schema": "https://raw.githubusercontent.com/shopware/frontends/main/packages/api-gen/api-gen.schema.json",
118
120
  "patches": [
119
121
  "https://raw.githubusercontent.com/shopware/frontends/refs/heads/main/packages/api-client/api-types/storeApiSchema.overrides.json",
120
122
  "./api-types/myOwnPatches.overrides.json"
@@ -246,7 +248,7 @@ Prepare your config file named **api-gen.config.json**:
246
248
  "rules": [
247
249
  "COMPONENTS_API_ALIAS" // you have description on autocompletion what specific rule does, this one for example ensures correctness of the apiAlias field
248
250
  ],
249
- //"patches": "./api-types/storeApiTypes.overrides.json" // -> path to your overrides file, default is fetched from api-client repository
251
+ //"patches": "storeApiTypes.overrides.json" // -> path to your overrides file in api-types folder, default is fetched from api-client repository
250
252
  }
251
253
  ```
252
254
 
@@ -264,8 +266,9 @@ Prepare your config file named **api-gen.config.json**:
264
266
 
265
267
  Full changelog for stable version is available [here](https://github.com/shopware/frontends/blob/main/packages/api-gen/CHANGELOG.md)
266
268
 
267
- ### Latest changes: 1.2.0
269
+ ### Latest changes: 1.3.0
268
270
 
269
271
  ### Minor Changes
270
272
 
271
- - [#1566](https://github.com/shopware/frontends/pull/1566) [`541cd6e`](https://github.com/shopware/frontends/commit/541cd6e5b5acaa20fb8aad699b2674e81b9330ce) Thanks [@patzick](https://github.com/patzick)! - Possibility to add multiple override json patches. Now you can use our default overrides and add your own on top of it.
273
+ - [#1706](https://github.com/shopware/frontends/pull/1706) [`d7bf6d7`](https://github.com/shopware/frontends/commit/d7bf6d715689f5d0cbef9f0bbbc78f19f54215d5) Thanks [@patzick](https://github.com/patzick)! - Simplify `api-gen.config.json` configuration. Now you can use names instead of paths in patches like `storeApiSchema.overrides.json` or `storeApiSchema.b2b.overrides.json`.
274
+ Thanks to this you can simple and more granularly apply patches for your project.