@shopware/api-gen 1.5.1 → 1.5.3

package/README.md

@@ -33,7 +33,7 @@ deno install --dev npm:@shopware/api-gen
 
 ## Features
 
-Generator will create a new directory `api-types` with TypeScript schemas inside. Depending on the `apiType` parameter it will create `storeApiTypes.ts` or `adminApiTypes.ts` file.
+Generator will create a new directory `api-types` with TypeScript schemas inside. Depending on the `apiType` parameter it will create `storeApiTypes.d.ts` or `adminApiTypes.d.ts` file.
 
 ### Overriding
 
@@ -99,6 +99,14 @@ export type operations = {
 > [!IMPORTANT]  
 > Overriding components or operations in the TS files requires you to have a full object definitions!
 
+Override-only projects (extra plugin endpoints, no local OpenAPI JSON) should
+import components from `@shopware/api-client/store-api-types` and merge the
+overlay in `shopware.d.ts` with `WithApiOverrides` from `@shopware/api-client`.
+That keeps StackBlitz working without committing a generated `storeApiTypes.d.ts`.
+See the [api-client TypeScript overrides](https://www.npmjs.com/package/@shopware/api-client) docs.
+When you do run `generate`, it still applies the same overlay onto whatever base
+schema it resolved (local JSON, or the types shipped with the api-client).
+
 ### Partial overrides
 
 There is a possiblity to add patches (partial overrides) to the schema. Partial overrides are applied directly to the JSON schema, so the syntax needs to be correct. It can then be used by the backend CI tool to validate and apply these patches directly to the schema to fix inconsistencies.
@@ -156,7 +164,7 @@ You could also use multiple patches and add your own overrides on top:
 }
 ```
 
-and then inside the `storeApiTypes.overrides.json` file you can add your patches:
+and then inside the `./api-types/myOwnPatches.overrides.json` file you can add your patches:
 
 ```json
 {
@@ -281,7 +289,7 @@ pnpx @shopware/api-gen validateJson --help
 pnpx @shopware/api-gen validateJson --apiType=store
 ```
 
-this searches for `api-types/storeApiTypes.json` file and validates it. Use [loadSchema](#loadSchema) command first to fetch your JSON file.
+this searches for `api-types/storeApiSchema.json` file and validates it. Use [loadSchema](#loadSchema) command first to fetch your JSON file.
 
 Prepare your config file named **api-gen.config.json**:
 
@@ -340,7 +348,7 @@ import { generate } from "@shopware/api-gen";
 
 await generate({
   cwd: process.cwd(),
-  filename: "storeApiTypes.ts",
+  filename: "storeApiSchema.json",
   apiType: "store",
   debug: true,
   logPatches: true,
@@ -354,7 +362,7 @@ import { loadSchema } from "@shopware/api-gen";
 
 await loadSchema({
   cwd: process.cwd(),
-  filename: "storeApiTypes.json",
+  filename: "storeApiSchema.json",
   apiType: "store",
 });
 ```
@@ -366,7 +374,7 @@ import { validateJson } from "@shopware/api-gen";
 
 await validateJson({
   cwd: process.cwd(),
-  filename: "storeApiTypes.json",
+  filename: "storeApiSchema.json",
   apiType: "store",
   logPatches: true,
   debug: true,
@@ -401,15 +409,9 @@ 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.5.1
+### Latest changes: 1.5.3
 
 ### Patch Changes
 
-- [#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.
-
-- [#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.
-
-- [#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 [[`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
+- Updated dependencies [[`44ece9d`](https://github.com/shopware/frontends/commit/44ece9dac2e4d0248c2270f7eff496c258632f5b), [`4b43e64`](https://github.com/shopware/frontends/commit/4b43e64a8d78be6eca1f8d9c24140e046193af41)]:
+  - @shopware/api-client@1.7.0