@shopware/api-gen 1.0.4 → 1.1.0

package/README.md

@@ -5,6 +5,8 @@ Generate TypeScript schemas from Shopware OpenAPI specification.
 
 After generating schemas, you can use them in fully typed [API Client](https://www.npmjs.com/package/@shopware/api-client).
 
+To take a deep dive into the topic visit the [🧑‍🎓 API Client Tutorial](https://api-client-tutorial-composable-frontends.pages.dev) first.
+
 ## Usage
 
 <!-- automd:pm-install name="@shopware/api-gen" dev -->
@@ -41,7 +43,7 @@ If your instance contains inacurate or outdated OpenAPI specification, you can o
 
 Example of overrides file:
 
-<!-- automd:file src="./tests/snapshots-override/simpleOverride.example.ts" code -->
+<!-- automd:file src="packages/api-gen/tests/snapshots-override/simpleOverride.example.ts" code -->
 
 ```ts [simpleOverride.example.ts]
 import { components as mainComponents } from "./storeApiTypes";
@@ -227,19 +229,51 @@ Prepare your config file named **api-gen.config.json**:
 }
 ```
 
+## Links
+
+- [🧑‍🎓 Tutorial](https://api-client-tutorial-composable-frontends.pages.dev)
+
+- [📘 Documentation](https://frontends.shopware.com)
+
+- [👥 Community Slack](https://shopwarecommunity.slack.com) (`#composable-frontends` channel)
+
 <!-- AUTO GENERATED CHANGELOG -->
 
 ## Changelog
 
 Full changelog for stable version is available [here](https://github.com/shopware/frontends/blob/main/packages/api-gen/CHANGELOG.md)
 
-### Latest changes: 1.0.4
+### Latest changes: 1.1.0
+
+### Minor Changes
+
+- [#1405](https://github.com/shopware/frontends/pull/1405) [`f9fb243`](https://github.com/shopware/frontends/commit/f9fb243d56d05a66ca4efd277c137e2ae8967f7b) Thanks [@patzick](https://github.com/patzick)! - Updated openapi-typescript to v7. Additional checks for better generation
+
+- [#1365](https://github.com/shopware/frontends/pull/1365) [`6abe9ab`](https://github.com/shopware/frontends/commit/6abe9abb64b9d2fe94d565393b1c08ec68b58162) Thanks [@patzick](https://github.com/patzick)! - `validateJson` command now checks endpoints exposed by the API to show if there are any endpoints missing in the schema or the schema contains some endpoints definitions, which are not exposed by the backend instance
+
+  tun it in the console like this:
+
+  ```bash
+  shopware-api-gen validateJson --apiType=store
+
+  shopware-api-gen validateJson --apiType=admin
+  ```
+
+  You need to have the same .env variables as needed for `loadSchema` command as the CLI is checking endpoints against the running instance.
 
 ### Patch Changes
 
-- [#1074](https://github.com/shopware/frontends/pull/1074) [`b688163`](https://github.com/shopware/frontends/commit/b68816391ee8ed1ac94a6462a2a016d708f259b4) Thanks [@mkucmus](https://github.com/mkucmus)! - Set `translated` property as required in provided schemas
+- [#1364](https://github.com/shopware/frontends/pull/1364) [`221af3c`](https://github.com/shopware/frontends/commit/221af3c5f56253239f9e7f2a45d71a0220c26cde) Thanks [@patzick](https://github.com/patzick)! - Fix patching schema when there is an oveerite with the `_DELETE` key, and the value was not present in the original schema. In that case there is nothing to delete and value should be omitted.
+
+- [#1304](https://github.com/shopware/frontends/pull/1304) [`183eee9`](https://github.com/shopware/frontends/commit/183eee90e855269251f32145711c9b284b0f2aa4) Thanks [@mkucmus](https://github.com/mkucmus)! - Fix import [pitfall](https://github.com/dotenv-org/examples/blob/master/usage/dotenv-es6-import-pitfall/invalid.mjs).
+
+- [#1330](https://github.com/shopware/frontends/pull/1330) [`2fdb986`](https://github.com/shopware/frontends/commit/2fdb9861a2ed2b89e28bec170c3a080d470d6210) Thanks [@mkucmus](https://github.com/mkucmus)! - Avoid schema loading when internal value `_DELETE_` is used for `$ref` key.
+
+  **parse** function of `json5` library tries to load a `$ref` by loading a file under the reference value, and that's why
+
+  > _ENOENT: no such file or directory, open '{cwd}/\_DELETE_'\_
 
-- [#1089](https://github.com/shopware/frontends/pull/1089) [`db7c93f`](https://github.com/shopware/frontends/commit/db7c93ff8cbb581221c11a492e77068af8faa8d6) Thanks [@mkucmus](https://github.com/mkucmus)! - Migrate eslint config to flat format
+  error was being thrown when there was no `_DELETE_` schema available locally (in the same json schema).
 
-- Updated dependencies [[`db7c93f`](https://github.com/shopware/frontends/commit/db7c93ff8cbb581221c11a492e77068af8faa8d6), [`b688163`](https://github.com/shopware/frontends/commit/b68816391ee8ed1ac94a6462a2a016d708f259b4)]:
-  - @shopware/api-client@1.0.2
+- Updated dependencies [[`6abe9ab`](https://github.com/shopware/frontends/commit/6abe9abb64b9d2fe94d565393b1c08ec68b58162), [`0643174`](https://github.com/shopware/frontends/commit/06431743162c088d46cf1e6305332bd51542eec4), [`266bb32`](https://github.com/shopware/frontends/commit/266bb32e119d7e1b3df7e082fb0fe4b0a475af44), [`f9fb243`](https://github.com/shopware/frontends/commit/f9fb243d56d05a66ca4efd277c137e2ae8967f7b), [`15bebee`](https://github.com/shopware/frontends/commit/15bebee0daefacc078ac99fea8725b95fdbc1cc7), [`ebb10eb`](https://github.com/shopware/frontends/commit/ebb10eba629b3ec2c5a4a50fa12ef0b134601d6f)]:
+  - @shopware/api-client@1.1.0