@shopware/api-gen 1.0.0 → 1.0.2

package/README.md

@@ -233,49 +233,10 @@ 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.0.0
-
-### Major Changes
-
-- [#871](https://github.com/shopware/frontends/pull/871) [`1566f7a`](https://github.com/shopware/frontends/commit/1566f7a3962c511b5c72e12a4a5db40c4aa5d198) Thanks [@patzick](https://github.com/patzick)! - Read more about new major release: https://github.com/shopware/frontends/discussions/965
-
-### Minor Changes
-
-- [#534](https://github.com/shopware/frontends/pull/534) [`6170dca`](https://github.com/shopware/frontends/commit/6170dca220f4b33c4dcb6fd1c3172ad931a47c75) Thanks [@patzick](https://github.com/patzick)! - `loadSchema` command added by splitting `generate` command
-
-- [#534](https://github.com/shopware/frontends/pull/534) [`6170dca`](https://github.com/shopware/frontends/commit/6170dca220f4b33c4dcb6fd1c3172ad931a47c75) Thanks [@patzick](https://github.com/patzick)! - Sorting `paths` in the same order by api patchs
-
-- [#1017](https://github.com/shopware/frontends/pull/1017) [`12c8153`](https://github.com/shopware/frontends/commit/12c8153e2279d48716ba6d67e28a1876318eb094) Thanks [@patzick](https://github.com/patzick)! - New command `validateJson` to check correctness of your OpenAPI json file.
-
-- [#534](https://github.com/shopware/frontends/pull/534) [`6170dca`](https://github.com/shopware/frontends/commit/6170dca220f4b33c4dcb6fd1c3172ad931a47c75) Thanks [@patzick](https://github.com/patzick)! - Command `generate` has been splitted and doing only transformation from json to d.ts file
-
-- [#564](https://github.com/shopware/frontends/pull/564) [`93a6048`](https://github.com/shopware/frontends/commit/93a6048ee28c1975750ef6911f303ea095cb9941) Thanks [@patzick](https://github.com/patzick)! - Added `apiType` option in `loadSchema` command. With `SHOPWARE_ADMIN_USERNAME` and `SHOPWARE_ADMIN_PASSWORD` env variables we can now authorize Admin API schema.
-
-  example:
-
-  ```bash
-  # load schema from store API
-  pnpx @shopware/api-gen loadSchema --apiType=store --filename=storeApiSchema.json
-
-  # load schema from admin API
-  pnpx @shopware/api-gen loadSchema --apiType=admin --filename=adminApiSchema.json
-  ```
-
-- [#1032](https://github.com/shopware/frontends/pull/1032) [`0b6133e`](https://github.com/shopware/frontends/commit/0b6133e8a9e929e004094800341a0c8e7de103eb) Thanks [@patzick](https://github.com/patzick)! - Possibility to add partial patches to the JSON schema.
-
-- [#903](https://github.com/shopware/frontends/pull/903) [`18d8528`](https://github.com/shopware/frontends/commit/18d8528886cfdee5bb14b0f4adb10f9b874eddf2) Thanks [@mdanilowicz](https://github.com/mdanilowicz)! - Add Blob type support
-
-- [#534](https://github.com/shopware/frontends/pull/534) [`6170dca`](https://github.com/shopware/frontends/commit/6170dca220f4b33c4dcb6fd1c3172ad931a47c75) Thanks [@patzick](https://github.com/patzick)! - Schema `operations` is now a generic type to help with overriding types
-
-- [#1032](https://github.com/shopware/frontends/pull/1032) [`0b6133e`](https://github.com/shopware/frontends/commit/0b6133e8a9e929e004094800341a0c8e7de103eb) Thanks [@patzick](https://github.com/patzick)! - Added support for JSON5 config files. Now you can use comments in your config files and JSON schema.
+### Latest changes: 1.0.2
 
 ### Patch Changes
 
-- [#534](https://github.com/shopware/frontends/pull/534) [`6170dca`](https://github.com/shopware/frontends/commit/6170dca220f4b33c4dcb6fd1c3172ad931a47c75) Thanks [@patzick](https://github.com/patzick)! - Generated `GenericRecord` is more open to avoid type problems
-
-- [#1032](https://github.com/shopware/frontends/pull/1032) [`0b6133e`](https://github.com/shopware/frontends/commit/0b6133e8a9e929e004094800341a0c8e7de103eb) Thanks [@patzick](https://github.com/patzick)! - Fixed optional body parameters, now it's processed correctly. The body is required by default (if defined).
-
-- [#928](https://github.com/shopware/frontends/pull/928) [`bada1cd`](https://github.com/shopware/frontends/commit/bada1cd816f5fa73389d401366545d08b0dd5c8b) Thanks [@mdanilowicz](https://github.com/mdanilowicz)! - Skip GenericRecord for the object with additionalProperties
+- [#1082](https://github.com/shopware/frontends/pull/1082) [`db42df4`](https://github.com/shopware/frontends/commit/db42df4aef6fcb5113d058fa5821274b58077407) Thanks [@patzick](https://github.com/patzick)! - `COMPONENTS_API_ALIAS` rule - additional message suggesting that the schema component name might be incorrect
 
-- Updated dependencies [[`2343012`](https://github.com/shopware/frontends/commit/2343012ad552b06557e6715055b3abc534fa2fae), [`1566f7a`](https://github.com/shopware/frontends/commit/1566f7a3962c511b5c72e12a4a5db40c4aa5d198), [`782ef4d`](https://github.com/shopware/frontends/commit/782ef4d417dce6e6d60992bd54f876aa4bc5f45d), [`9643e56`](https://github.com/shopware/frontends/commit/9643e56dafba9282b75c12c96b2afb3a4738f86e), [`1583a7a`](https://github.com/shopware/frontends/commit/1583a7ae0d68b72fb362b625e1634e03bad68110), [`97d2859`](https://github.com/shopware/frontends/commit/97d2859e4dcbdc563200f2f64d1a20880b675d87), [`d60d062`](https://github.com/shopware/frontends/commit/d60d0620c7114a2f26bb2faf24241e2cbabc8798), [`c729e70`](https://github.com/shopware/frontends/commit/c729e7014c70d7f71edf5297104065d18e482e04), [`89a97a4`](https://github.com/shopware/frontends/commit/89a97a45ae4a58616e41f63e9884a2a67f0a6ce8), [`864616f`](https://github.com/shopware/frontends/commit/864616f0c9e1cbe11e434b9a04a35ff9520bcb3c)]:
-  - @shopware/api-client@1.0.0
+- [#1082](https://github.com/shopware/frontends/pull/1082) [`db42df4`](https://github.com/shopware/frontends/commit/db42df4aef6fcb5113d058fa5821274b58077407) Thanks [@patzick](https://github.com/patzick)! - Correct api overrides load, depending on the apiType

package/dist/cli.mjs

@@ -214059,12 +214059,20 @@ async function loadApiGenConfig(params = {}) {
 function isURL(str) {
   return str.startsWith("http");
 }
-async function loadJsonOverrides(path) {
-  const pathToResolve = path || "https://raw.githubusercontent.com/shopware/frontends/main/packages/api-client/api-types/storeApiSchema.overrides.json";
+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);
-      return response.data;
+      const response = await ofetch(pathToResolve, {
+        responseType: "json"
+      });
+      return response;
     } else {
       const jsonOverridesFile = await readFileSync(pathToResolve, {
         encoding: "utf-8"
@@ -214167,7 +214175,10 @@ async function generate(args) {
         silent: true
         // we allow to not have the config file in this command
       });
-      const jsonOverrides = await loadJsonOverrides(configJSON?.patches);
+      const jsonOverrides = await loadJsonOverrides({
+        path: configJSON?.patches,
+        apiType: args.apiType
+      });
       const {
         patchedSchema,
         todosToFix,
@@ -214342,7 +214353,7 @@ async function generate(args) {
 }
 
 const name = "@shopware/api-gen";
-const version = "1.0.0";
+const version = "1.0.2";
 const description = "Shopware CLI for API client generation.";
 const author = "Shopware";
 const type = "module";
@@ -214568,6 +214579,12 @@ function splitByCase(str, separators) {
   parts.push(buff);
   return parts;
 }
+function upperFirst(str) {
+  return str ? str[0].toUpperCase() + str.slice(1) : "";
+}
+function pascalCase(str, opts) {
+  return str ? (Array.isArray(str) ? str : splitByCase(str)).map((p) => upperFirst(opts?.normalize ? p.toLowerCase() : p)).join("") : "";
+}
 function kebabCase(str, joiner) {
   return str ? (Array.isArray(str) ? str : splitByCase(str)).map((p) => p.toLowerCase()).join(joiner ?? "-") : "";
 }
@@ -214584,11 +214601,13 @@ const componentsApiAliasRule = (componentName, body) => {
   if (!bodyValue) {
     return null;
   }
-  if (body.required && !body.required.includes("apiAlias")) {
-    return `Component ${c$1.bold(componentName)} has invalid ${c$1.bold("apiAlias")} definition. This field should be required.`;
-  }
   const result = equals(properAliasDefinition, bodyValue);
   if (!result) {
+    let additionalMessage = "";
+    const bodyEnumValue = bodyValue?.enum?.[0];
+    if (bodyEnumValue && properAliasDefinition.enum[0] !== bodyEnumValue) {
+      additionalMessage = `It's also possible, that the schema component name is not correct and apiApias is proper. In that case schema component name should be ${c$1.bold(pascalCase(bodyEnumValue))}. Confirm proper solution with the source code.`;
+    }
     return `Component ${c$1.bold(componentName)} has invalid ${c$1.bold("apiAlias")} definition. Diff:
  ${diff(
       properAliasDefinition,
@@ -214597,7 +214616,11 @@ const componentsApiAliasRule = (componentName, body) => {
         aColor: c$1.green,
         bColor: c$1.red
       }
-    )}`;
+    )}${additionalMessage.length ? `
+${additionalMessage}` : ""}`;
+  }
+  if (!body.required?.includes("apiAlias")) {
+    return `Component ${c$1.bold(componentName)} has invalid ${c$1.bold("apiAlias")} definition. This field should be required.`;
   }
   return null;
 };
@@ -214639,7 +214662,10 @@ async function validateJson(args) {
     process.exit(1);
   }
   const errors = [];
-  const jsonOverrides = await loadJsonOverrides(configJSON.patches);
+  const jsonOverrides = await loadJsonOverrides({
+    path: configJSON.patches,
+    apiType: args.apiType
+  });
   Object.entries(fileContentAsJson.components?.schemas || {}).forEach(
     (schema) => {
       rulesToProcess.forEach((ruleName) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopware/api-gen",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Shopware CLI for API client generation.",
   "author": "Shopware",
   "type": "module",
@@ -35,8 +35,8 @@
     "picocolors": "1.0.1",
     "unbuild": "2.0.0",
     "vitest": "1.6.0",
-    "eslint-config-shopware": "0.0.9",
-    "tsconfig": "0.0.0"
+    "tsconfig": "0.0.0",
+    "eslint-config-shopware": "0.0.9"
   },
   "dependencies": {
     "ofetch": "1.3.4",
@@ -44,7 +44,7 @@
     "prettier": "3.3.2",
     "ts-morph": "22.0.0",
     "yargs": "17.7.2",
-    "@shopware/api-client": "1.0.0"
+    "@shopware/api-client": "1.0.1"
   },
   "scripts": {
     "build": "unbuild",