@shopware/api-gen 1.5.0 → 1.5.2

package/README.md

@@ -20,20 +20,20 @@ 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 -->
 
 ## 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
 
@@ -156,7 +156,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 +281,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**:
 
@@ -338,9 +338,9 @@ 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",
+  filename: "storeApiSchema.json",
   apiType: "store",
   debug: true,
   logPatches: true,
@@ -354,7 +354,7 @@ import { loadSchema } from "@shopware/api-gen";
 
 await loadSchema({
   cwd: process.cwd(),
-  filename: "storeApiTypes.json",
+  filename: "storeApiSchema.json",
   apiType: "store",
 });
 ```
@@ -366,7 +366,7 @@ import { validateJson } from "@shopware/api-gen";
 
 await validateJson({
   cwd: process.cwd(),
-  filename: "storeApiTypes.json",
+  filename: "storeApiSchema.json",
   apiType: "store",
   logPatches: true,
   debug: true,
@@ -391,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)
 
@@ -401,13 +401,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.0
-
-### Minor Changes
-
-- [#2262](https://github.com/shopware/frontends/pull/2262) [`7a20ea0`](https://github.com/shopware/frontends/commit/7a20ea0454ee237c772e532a03408477e968a958) Thanks [@mkucmus](https://github.com/mkucmus)! - Added support for `client_credentials` grant type authentication when loading Admin API schema. Set `SHOPWARE_ADMIN_CLIENT_SECRET` and `SHOPWARE_ADMIN_CLIENT_ID`environment variables to use integration credentials instead of username/password.
+### Latest changes: 1.5.2
 
 ### Patch Changes
 
-- Updated dependencies [[`9604f22`](https://github.com/shopware/frontends/commit/9604f22678150d04c3c3156fd8ee2ce440c8c8bf), [`b5f7e2a`](https://github.com/shopware/frontends/commit/b5f7e2a20c9dfdde1690e9006252d847f732bc0a), [`9604f22`](https://github.com/shopware/frontends/commit/9604f22678150d04c3c3156fd8ee2ce440c8c8bf)]:
-  - @shopware/api-client@1.5.0
+- Updated dependencies [[`183c183`](https://github.com/shopware/frontends/commit/183c183f905486c27fa770fd0f4cd9993e86c20e), [`458494e`](https://github.com/shopware/frontends/commit/458494e8bd2be88d4fbf161636a109c8f4efc443)]:
+  - @shopware/api-client@1.6.0