@shopware/api-gen 1.1.4 → 1.2.0

package/README.md

@@ -107,7 +107,18 @@ Example:
 
 ```json
 {
-  "patches": "./api-types/storeApiTypes.overrides.json"
+  "patches": ["./api-types/storeApiTypes.overrides.json"]
+}
+```
+
+or you could use multiple patches and add your own overrides on top:
+
+```json
+{
+  "patches": [
+    "https://raw.githubusercontent.com/shopware/frontends/refs/heads/main/packages/api-client/api-types/storeApiSchema.overrides.json",
+    "./api-types/myOwnPatches.overrides.json"
+  ]
 }
 ```
 
@@ -175,6 +186,11 @@ pnpx @shopware/api-gen generate --apiType=store
 pnpx @shopware/api-gen generate --apiType=admin
 ```
 
+flags:
+
+- `--debug` - display debug logs and additional information which can be helpful in case of issues
+- `--logPatches` - display patched logs, useful when you want to fix schema in original file
+
 ### `loadSchema`
 
 Load OpenAPI specification from Shopware instance and save it to JSON file.
@@ -191,6 +207,11 @@ pnpx @shopware/api-gen loadSchema --apiType=store
 pnpx @shopware/api-gen loadSchema --apiType=admin
 ```
 
+flags:
+
+- `--debug` - display debug logs and additional information which can be helpful in case of issues
+- `--logPatches` - display patched logs, useful when you want to fix schema in original file
+
 Remember to add `.env` file in order to authenticate with Shopware instance.
 
 ```bash
@@ -243,11 +264,8 @@ Prepare your config file named **api-gen.config.json**:
 
 Full changelog for stable version is available [here](https://github.com/shopware/frontends/blob/main/packages/api-gen/CHANGELOG.md)
 
-### Latest changes: 1.1.4
-
-### Patch Changes
+### Latest changes: 1.2.0
 
-- [#1447](https://github.com/shopware/frontends/pull/1447) [`11ea41f`](https://github.com/shopware/frontends/commit/11ea41fc00493d4997ddfcb23e2f5bf89dd2a828) Thanks [@patzick](https://github.com/patzick)! - Improved error messages and merging override patches.
+### Minor Changes
 
-- Updated dependencies [[`a87bbcf`](https://github.com/shopware/frontends/commit/a87bbcfa3f5aa440265b1e8f0fc72a204863befc)]:
-  - @shopware/api-client@1.2.0
+- [#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.

package/dist/cli.mjs

@@ -24,7 +24,7 @@ const __filename = __cjs_url__.fileURLToPath(import.meta.url);
 const __dirname = __cjs_path__.dirname(__filename);
 const require = __cjs_mod__.createRequire(import.meta.url);
 const name$1 = "@shopware/api-gen";
-const version$2 = "1.1.4";
+const version$2 = "1.2.0";
 const description$1 = "Shopware CLI for API client generation.";
 const author = "Shopware";
 const type$1 = "module";
@@ -199781,114 +199781,6 @@ picocolors.exports.createColors = createColors;
 var picocolorsExports = picocolors.exports;
 const c = /*@__PURE__*/getDefaultExportFromCjs$1(picocolorsExports);
 
-const API_GEN_CONFIG_FILENAME = "api-gen.config.json";
-async function loadApiGenConfig(params = {}) {
-  try {
-    const config = await readFileSync(API_GEN_CONFIG_FILENAME, {
-      // TODO: use c12 library for that
-      // name: "api-gen", // file should be "api-gen.config.json"
-      encoding: "utf-8"
-    });
-    return lib.parse(config);
-  } catch (error) {
-    if (!params.silent) {
-      console.error(
-        c.red(
-          `Error while parsing config file ${API_GEN_CONFIG_FILENAME}. Check whether the file is correct JSON file.
-`
-        ),
-        error
-      );
-    }
-    return null;
-  }
-}
-function isURL(str) {
-  return str.startsWith("http");
-}
-async function loadJsonOverrides({
-  path,
-  apiType
-}) {
-  const localPath = `./api-types/${apiType}ApiSchema.overrides.json`;
-  const fallbackPath = existsSync(localPath) ? localPath : `https://raw.githubusercontent.com/shopware/frontends/main/packages/api-client/api-types/${apiType}ApiSchema.overrides.json`;
-  const pathToResolve = path || fallbackPath;
-  console.log("Loading overrides from:", pathToResolve);
-  try {
-    if (isURL(pathToResolve)) {
-      const response = await ofetch(pathToResolve, {
-        responseType: "json",
-        parseResponse: lib.parse
-      });
-      return response;
-    }
-    const jsonOverridesFile = await readFileSync(pathToResolve, {
-      encoding: "utf-8"
-    });
-    const content = lib.parse(jsonOverridesFile);
-    return content;
-  } catch (error) {
-    console.warn(
-      c.yellow(
-        `Problem with resolving overrides "patches" at address ${pathToResolve}. Check whether you configuret it properly in your ${API_GEN_CONFIG_FILENAME}
-`
-      ),
-      error
-    );
-  }
-}
-function displayPatchingSummary({
-  todosToFix,
-  outdatedPatches,
-  alreadyApliedPatches,
-  errors
-}) {
-  if (!errors?.length && todosToFix.length) {
-    console.log(c.yellow("Warnings to fix in the schema:"));
-    for (const todo of todosToFix) {
-      console.log(`${c.yellow("WARNING")}: ${todo[0]}`);
-      console.log("Diff:\n", todo[1], "\n\n");
-    }
-  }
-  if (errors?.length) {
-    console.log(c.red("Errors found:"));
-    for (const error of errors) {
-      console.log(`
-<==== ${c.red("ERROR")}:
-${error}
-====>
-
-`);
-    }
-  }
-  if (outdatedPatches.length) {
-    console.log(c.yellow("Info: Outdated patches:"));
-    console.log(
-      c.gray(
-        "No action needed. Patches are already applied. You can remove them from the overrides file to clean it up."
-      )
-    );
-    for (const todo of outdatedPatches) {
-      console.log(`${todo[0]}`);
-      console.log("Patch to remove:\n", todo[1], "\n\n");
-    }
-  }
-  console.log("\n\n===== Summary =====");
-  if (alreadyApliedPatches) {
-    console.log(
-      c.gray(
-        ` \u2714\uFE0F Already fixed patches: ${c.bold(alreadyApliedPatches)} They can be removed now from the overrides file.`
-      )
-    );
-  }
-  const formatColor = todosToFix.length ? c.yellow : c.green;
-  console.log(
-    formatColor(
-      `We've found ${c.bold(todosToFix.length)} warning(s) in the schema.${todosToFix.length ? " Apply patches to fix them in the original schema." : ""}`
-    )
-  );
-}
-
 // src/index.ts
 var f$1 = {
   reset: [0, 0],
@@ -206979,6 +206871,138 @@ ${c.cyan(
   };
 }
 
+const API_GEN_CONFIG_FILENAME = "api-gen.config.json";
+async function loadApiGenConfig(params = {}) {
+  try {
+    const config = await readFileSync(API_GEN_CONFIG_FILENAME, {
+      // TODO: use c12 library for that
+      // name: "api-gen", // file should be "api-gen.config.json"
+      encoding: "utf-8"
+    });
+    return lib.parse(config);
+  } catch (error) {
+    if (!params.silent) {
+      console.error(
+        c.red(
+          `Error while parsing config file ${API_GEN_CONFIG_FILENAME}. Check whether the file is correct JSON file.
+`
+        ),
+        error
+      );
+    }
+    return null;
+  }
+}
+function isURL(str) {
+  return str.startsWith("http");
+}
+async function resolveSinglePath(pathToResolve) {
+  try {
+    if (isURL(pathToResolve)) {
+      const response = await ofetch(pathToResolve, {
+        responseType: "json",
+        parseResponse: lib.parse
+      });
+      return response;
+    }
+    const jsonOverridesFile = await readFileSync(pathToResolve, {
+      encoding: "utf-8"
+    });
+    return lib.parse(jsonOverridesFile);
+  } catch (error) {
+    console.warn(
+      c.yellow(
+        `Problem with resolving overrides "patches" at address ${pathToResolve}. Check whether you configured it properly in your ${API_GEN_CONFIG_FILENAME}
+`
+      ),
+      error
+    );
+    return {};
+  }
+}
+async function loadJsonOverrides({
+  paths,
+  apiType
+}) {
+  const localPath = `./api-types/${apiType}ApiSchema.overrides.json`;
+  const fallbackPath = existsSync(localPath) ? localPath : `https://raw.githubusercontent.com/shopware/frontends/main/packages/api-client/api-types/${apiType}ApiSchema.overrides.json`;
+  const patchesToResolve = Array.isArray(paths) ? paths : paths ? [paths] : [];
+  if (!patchesToResolve?.length) {
+    patchesToResolve.push(fallbackPath);
+  }
+  console.log("Loading overrides from:", patchesToResolve);
+  try {
+    const results = await Promise.allSettled(
+      patchesToResolve.map(resolveSinglePath)
+    );
+    return extendedDefu(
+      {},
+      ...results.filter((result) => result.status === "fulfilled").map((result) => result.value)
+    );
+  } catch (error) {
+    console.warn(
+      c.yellow(
+        `Problem with resolving overrides "patches". Check whether you configured it properly in your ${API_GEN_CONFIG_FILENAME}
+`
+      ),
+      error
+    );
+    return {};
+  }
+}
+function displayPatchingSummary({
+  todosToFix,
+  outdatedPatches,
+  alreadyApliedPatches,
+  errors,
+  displayPatchedLogs
+}) {
+  if (displayPatchedLogs && !errors?.length && todosToFix.length) {
+    console.log(c.yellow("Warnings to fix in the schema:"));
+    for (const todo of todosToFix) {
+      console.log(`${c.yellow("WARNING")}: ${todo[0]}`);
+      console.log("Diff:\n", todo[1], "\n\n");
+    }
+  }
+  if (errors?.length) {
+    console.log(c.red("Errors found:"));
+    for (const error of errors) {
+      console.log(`
+<==== ${c.red("ERROR")}:
+${error}
+====>
+
+`);
+    }
+  }
+  if (outdatedPatches.length) {
+    console.log(c.yellow("Info: Outdated patches:"));
+    console.log(
+      c.gray(
+        "No action needed. Patches are already applied. You can remove them from the overrides file to clean it up."
+      )
+    );
+    for (const todo of outdatedPatches) {
+      console.log(`${todo[0]}`);
+      console.log("Patch to remove:\n", todo[1], "\n\n");
+    }
+  }
+  console.log("\n\n===== Summary =====");
+  if (alreadyApliedPatches) {
+    console.log(
+      c.gray(
+        ` \u2714\uFE0F Already fixed patches: ${c.bold(alreadyApliedPatches)} They can be removed now from the overrides file.`
+      )
+    );
+  }
+  const formatColor = todosToFix.length ? c.yellow : c.green;
+  console.log(
+    formatColor(
+      `We've found ${c.bold(todosToFix.length)} warning(s) in the schema.${todosToFix.length ? " Apply patches to fix them in the original schema." : ""}`
+    )
+  );
+}
+
 async function generateFile(filepath, operationsMap, existingTypes, schemasMap, options) {
   const project = await prepareFileContent({
     filepath,
@@ -207615,9 +207639,23 @@ async function generate(args) {
         // we allow to not have the config file in this command
       });
       const jsonOverrides = await loadJsonOverrides({
-        path: configJSON?.patches,
+        paths: configJSON?.patches,
         apiType: args.apiType
       });
+      if (args.debug) {
+        const overridesFilePath = join(
+          args.cwd,
+          "api-types",
+          `${args.apiType}ApiTypes.overrides-result.json`
+        );
+        writeFileSync(
+          overridesFilePath,
+          lib.stringify(jsonOverrides, null, 2)
+        );
+        console.log(
+          `[DEBUG] Check the overrides result in: ${c.bold(overridesFilePath)} file.`
+        );
+      }
       const {
         patchedSchema,
         todosToFix,
@@ -207632,7 +207670,8 @@ async function generate(args) {
       displayPatchingSummary({
         todosToFix,
         outdatedPatches,
-        alreadyApliedPatches
+        alreadyApliedPatches,
+        displayPatchedLogs: args.logPatches
       });
       if (args.debug) {
         const patchedSchemaFilename = inputFilename.replace(
@@ -207647,6 +207686,9 @@ async function generate(args) {
         writeFileSync(patchedSchemaPath, lib.stringify(patchedSchema), {
           encoding: "utf-8"
         });
+        console.log(
+          `[DEBUG] Check the patched schema in: ${c.bold(patchedSchemaPath)} file.`
+        );
       }
       const astSchema = await openapiTS(patchedSchema, {
         version: +(process.env.OPENAPI_VERSION || 3),
@@ -207727,6 +207769,7 @@ async function generate(args) {
         writeFileSync(fullOutputFilePath, schema, {
           encoding: "utf-8"
         });
+        console.log(`[DEBUG]: Debug Schema saved to ${fullOutputFilePath}`);
         schema = await format$1(schema, {
           // semi: false,
           parser: "typescript"
@@ -207761,6 +207804,9 @@ async function generate(args) {
         writeFileSync(fullOutputFilePath, schema, {
           encoding: "utf-8"
         });
+        console.log(
+          `[DEBUG] Check the generated schema in: ${c.bold(fullOutputFilePath)} file.`
+        );
       }
       const overridesFilepath = join(
         args.cwd,
@@ -208093,9 +208139,20 @@ async function validateJson(args) {
   }
   const errors = [];
   const jsonOverrides = await loadJsonOverrides({
-    path: configJSON.patches,
+    paths: configJSON.patches,
     apiType: args.apiType
   });
+  if (args.debug) {
+    const overridesFilePath = join(
+      args.cwd,
+      "api-types",
+      `${args.apiType}ApiTypes.overrides-result.json`
+    );
+    writeFileSync(overridesFilePath, lib.stringify(jsonOverrides, null, 2));
+    console.log(
+      `[DEBUG] Check the overrides result in: ${c.bold(overridesFilePath)} file.`
+    );
+  }
   for (const [schemaName, schema] of Object.entries(
     fileContentAsJson.components?.schemas || {}
   )) {
@@ -208175,7 +208232,8 @@ async function validateJson(args) {
     todosToFix,
     errors,
     outdatedPatches,
-    alreadyApliedPatches
+    alreadyApliedPatches,
+    displayPatchedLogs: args.logPatches
   });
   console.log(
     endpointsMissingInSchema > 0 ? c.red("\u274C") : c.green("\u2714\uFE0F"),
@@ -208225,6 +208283,10 @@ yargs(hideBin(process.argv)).scriptName("@shopware/api-gen").usage("$0 [args]").
       type: "boolean",
       default: false,
       describe: "show debug information and generate intermediate files"
+    }).option("logPatches", {
+      type: "boolean",
+      default: false,
+      describe: "show patched logs"
     }).help();
   },
   async (args) => generate(args)
@@ -208253,6 +208315,14 @@ yargs(hideBin(process.argv)).scriptName("@shopware/api-gen").usage("$0 [args]").
     }).positional("filename", {
       type: "string",
       describe: "name of the schema json file. The default (based on apiType parameter) is 'storeApiSchema.json' or 'adminApiSchema.json'"
+    }).option("logPatches", {
+      type: "boolean",
+      default: false,
+      describe: "show patched logs"
+    }).positional("debug", {
+      type: "boolean",
+      default: false,
+      describe: "show debug information and generate intermediate files"
     }).help();
   },
   async (args) => validateJson(args)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopware/api-gen",
-  "version": "1.1.4",
+  "version": "1.2.0",
   "description": "Shopware CLI for API client generation.",
   "author": "Shopware",
   "type": "module",