@shopware/api-gen 1.4.0 → 1.5.1

package/README.md

@@ -20,13 +20,13 @@ npm install -D @shopware/api-gen
 yarn add -D @shopware/api-gen
 
 # pnpm
-pnpm install -D @shopware/api-gen
+pnpm add -D @shopware/api-gen
 
 # bun
 bun install -D @shopware/api-gen
 
 # deno
-deno install --dev @shopware/api-gen
+deno install --dev npm:@shopware/api-gen
 ```
 
 <!-- /automd -->
@@ -252,11 +252,22 @@ Remember to add `.env` file in order to authenticate with Shopware instance.
 OPENAPI_JSON_URL="https://your-shop-instance.shopware.store"
 ## This one needed to fetch store API schema
 OPENAPI_ACCESS_KEY="YOUR_STORE_API_ACCESS_KEY"
-## These two needed to fetch admin API schema
+
+## Admin API authentication (choose one method):
+
+## Option 1: Password grant (username/password)
 SHOPWARE_ADMIN_USERNAME="my@username.com"
 SHOPWARE_ADMIN_PASSWORD="my-password"
+
+## Option 2: Client credentials grant (integration)
+## Create an integration in Shopware Admin > Settings > System > Integrations
+# SHOPWARE_ADMIN_CLIENT_ID="your-integration-client-id"
+# SHOPWARE_ADMIN_CLIENT_SECRET="your-integration-secret"
 ```
 
+> [!NOTE]
+> When `SHOPWARE_ADMIN_CLIENT_SECRET` is set, the client credentials grant will be used automatically. Otherwise, the password grant with username/password is used.
+
 ### `validateJson`
 
 This command allow to validate the output JSON file of your instance. You can configure which rules should be applied, we provide you with the schema configuration file, so you can easily modify it.
@@ -327,7 +338,7 @@ Each command can also be used programmatically within your own scripts:
 ```ts
 import { generate } from "@shopware/api-gen";
 
-await generate({ 
+await generate({
   cwd: process.cwd(),
   filename: "storeApiTypes.ts",
   apiType: "store",
@@ -380,7 +391,7 @@ await split({
 
 ## Links
 
-- [📘 Documentation](https://frontends.shopware.com)
+- [📘 Documentation](https://developer.shopware.com/frontends)
 
 - [👥 Community Discord](https://discord.com/channels/1308047705309708348/1405501315160739951) (`#composable-frontend` channel)
 
@@ -390,35 +401,15 @@ await split({
 
 Full changelog for stable version is available [here](https://github.com/shopware/frontends/blob/main/packages/api-gen/CHANGELOG.md)
 
-### Latest changes: 1.4.0
-
-### Minor Changes
+### Latest changes: 1.5.1
 
-- [#2181](https://github.com/shopware/frontends/pull/2181) [`ed72205`](https://github.com/shopware/frontends/commit/ed72205853e9fc40db513f8a4d08acf2dd7b1fba) Thanks [@patzick](https://github.com/patzick)! - Add API-specific configuration support for `store-api` and `admin-api` in `api-gen.config.json`. This allows configuring `rules` and `patches` separately for each API type. Root-level `rules` and `patches` are now deprecated but still supported for backwards compatibility.
-
-  Example:
-
-  ```json
-  {
-    "$schema": "./node_modules/@shopware/api-gen/api-gen.schema.json",
-    "store-api": {
-      "patches": ["storeApiSchema.overrides.json"],
-      "rules": ["COMPONENTS_API_ALIAS"]
-    },
-    "admin-api": {
-      "patches": ["adminApiSchema.overrides.json"]
-    }
-  }
-  ```
+### Patch Changes
 
-- [#2126](https://github.com/shopware/frontends/pull/2126) [`e595bc1`](https://github.com/shopware/frontends/commit/e595bc1ea6afe01a0065300277a78ef8c1fe5667) Thanks [@mdanilowicz](https://github.com/mdanilowicz)! - Enhanced OpenAPI schema override merging to properly handle conflicts between `$ref` and composition keywords (`oneOf`, `anyOf`, `allOf`, `not`). When merging overrides:
-  - Composition keywords now automatically remove conflicting `$ref` properties
-  - `$ref` overrides can replace composition keywords entirely
-  - Different composition keywords can replace each other (e.g., `allOf` → `oneOf`)
+- [#2575](https://github.com/shopware/frontends/pull/2575) [`1e8a64c`](https://github.com/shopware/frontends/commit/1e8a64c71197484e2c8d2a2f148f3f29ab63bccd) Thanks [@patzick](https://github.com/patzick)! - Support OpenAPI `const` schema values during type generation.
 
-  This ensures correct schema merging when using composition keywords in override files, preventing invalid OpenAPI schemas with conflicting `$ref` and composition keyword properties.
+- [#2515](https://github.com/shopware/frontends/pull/2515) [`978b02c`](https://github.com/shopware/frontends/commit/978b02c969ca4b16f5fc1d7a953ec4cce3d98173) Thanks [@patzick](https://github.com/patzick)! - Generate `customFields` properties with a dedicated `CustomFields` type instead of the broader `GenericRecord` type.
 
-### Patch Changes
+- [#2516](https://github.com/shopware/frontends/pull/2516) [`13a3766`](https://github.com/shopware/frontends/commit/13a37660fbbf63054b9e7d02f39d161bb7f2b065) Thanks [@patzick](https://github.com/patzick)! - Use `oxfmt` instead of Prettier for generated API files.
 
-- Updated dependencies [[`70dcf95`](https://github.com/shopware/frontends/commit/70dcf95d4370c63964d877a5cab113a53f93ca19), [`c77daa6`](https://github.com/shopware/frontends/commit/c77daa6a11e96c7f3688b16f7da010b54c7f5e8b)]:
-  - @shopware/api-client@1.4.0
+- Updated dependencies [[`b767721`](https://github.com/shopware/frontends/commit/b767721847bf3391f9067eca7a045089fb22fce0), [`978b02c`](https://github.com/shopware/frontends/commit/978b02c969ca4b16f5fc1d7a953ec4cce3d98173), [`33facb1`](https://github.com/shopware/frontends/commit/33facb178792c8cb26b47ab984ac48c08ab4b72b), [`9137475`](https://github.com/shopware/frontends/commit/91374753cedb2034385f642e6af11314f2971caa), [`474d3fe`](https://github.com/shopware/frontends/commit/474d3fed346816135b0c7c797990b215a8b691c0)]:
+  - @shopware/api-client@1.5.1