@shopware/api-gen 1.0.1 → 1.0.3

package/README.md

@@ -233,9 +233,12 @@ 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.1
+### Latest changes: 1.0.3
 
 ### Patch Changes
 
-- Updated dependencies [[`19f2800`](https://github.com/shopware/frontends/commit/19f28003cf937bcb630257cb7cfd2bd131b7cf9d)]:
-  - @shopware/api-client@1.0.1
+- [#1113](https://github.com/shopware/frontends/pull/1113) [`65212d1`](https://github.com/shopware/frontends/commit/65212d11bb8d0af10f97454a46e7671ff16ebc7a) Thanks [@patzick](https://github.com/patzick)! - Parse Json5 responses when using default overrides
+
+- [#1112](https://github.com/shopware/frontends/pull/1112) [`2065d00`](https://github.com/shopware/frontends/commit/2065d00998cd84fb6e2f51d7f793eb178e0865e4) Thanks [@patzick](https://github.com/patzick)! - Fixed adding missing components in overrides. Used when component name is overriden and no component definition is provided for it.
+
+- [#1103](https://github.com/shopware/frontends/pull/1103) [`c9a4965`](https://github.com/shopware/frontends/commit/c9a49659e77842a4b098d5b9cc6606f4158893fd) Thanks [@trimethylpentan](https://github.com/trimethylpentan)! - Re-enabled generation for `GenericRecord`s for openAPI objects

package/dist/cli.mjs

@@ -7050,7 +7050,7 @@ and limitations under the License.
 
 	// src/compiler/corePublic.ts
 	var versionMajorMinor = "5.5";
-	var version = "5.5.2";
+	var version = "5.5.3";
 	var Comparison = /* @__PURE__ */ ((Comparison3) => {
 	  Comparison3[Comparison3["LessThan"] = -1] = "LessThan";
 	  Comparison3[Comparison3["EqualTo"] = 0] = "EqualTo";
@@ -57484,7 +57484,7 @@ ${lanes.join("\n")}
 	        }
 	        if (moduleResolutionKind === 3 /* Node16 */ || moduleResolutionKind === 99 /* NodeNext */) {
 	          const isSyncImport = currentSourceFile.impliedNodeFormat === 1 /* CommonJS */ && !findAncestor(location, isImportCall) || !!findAncestor(location, isImportEqualsDeclaration);
-	          const overrideHost = findAncestor(location, (l) => isImportTypeNode(l) || isExportDeclaration(l) || isImportDeclaration(l));
+	          const overrideHost = findAncestor(location, (l) => isImportTypeNode(l) || isExportDeclaration(l) || isImportDeclaration(l) || isJSDocImportTag(l));
 	          if (isSyncImport && sourceFile.impliedNodeFormat === 99 /* ESNext */ && !hasResolutionModeOverride(overrideHost)) {
 	            if (findAncestor(location, isImportEqualsDeclaration)) {
 	              error2(errorNode, Diagnostics.Module_0_cannot_be_imported_using_this_construct_The_specifier_only_resolves_to_an_ES_module_which_cannot_be_imported_with_require_Use_an_ECMAScript_import_instead, moduleReference);
@@ -128207,7 +128207,7 @@ ${lanes.join("\n")}
 	}
 	function getModeForUsageLocationWorker(file, usage, compilerOptions) {
 	  var _a;
-	  if (isImportDeclaration(usage.parent) || isExportDeclaration(usage.parent)) {
+	  if (isImportDeclaration(usage.parent) || isExportDeclaration(usage.parent) || isJSDocImportTag(usage.parent)) {
 	    const isTypeOnly = isExclusivelyTypeOnlyImportOrExport(usage.parent);
 	    if (isTypeOnly) {
 	      const override = getResolutionModeOverride(usage.parent.attributes);
@@ -213974,6 +213974,15 @@ ${c$1.cyan(
       });
     }
   });
+  Object.entries(jsonOverrides?.components || {}).forEach((schema) => {
+    if (!openApiSchema.components?.schemas?.[schema[0]]) {
+      const patches = Array.isArray(schema[1]) ? schema[1] : [schema[1]];
+      patches.forEach((patch) => {
+        patchedSchema.components.schemas[schema[0]] = patch;
+        appliedPatches++;
+      });
+    }
+  });
   Object.entries(openApiSchema?.paths || {}).forEach((pathObject) => {
     const pathName = pathObject[0];
     Object.entries(pathObject[1]).forEach((singlePath) => {
@@ -214059,12 +214068,21 @@ 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",
+        parseResponse: lib.parse
+      });
+      return response;
     } else {
       const jsonOverridesFile = await readFileSync(pathToResolve, {
         encoding: "utf-8"
@@ -214167,7 +214185,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,
@@ -214193,11 +214214,11 @@ async function generate(args) {
         alphabetize: true,
         supportArrayLength: true,
         commentHeader: `/**
- * This file is auto-generated. Do not make direct changes to the file. 
+ * This file is auto-generated. Do not make direct changes to the file.
  * Instead override it in your shopware.d.ts file.
- * 
+ *
  * Shopware API version: ${version}
- * 
+ *
  */
 `,
         /**
@@ -214245,6 +214266,13 @@ async function generate(args) {
           if (schemaObject.format === "binary") {
             return "Blob";
           }
+          if (
+            // for object types
+            schemaObject.type === "object" && // without properties, items, anyOf, allOf
+            !schemaObject.properties && !schemaObject.items && !schemaObject.anyOf && !schemaObject.allOf && !schemaObject.additionalProperties
+          ) {
+            return "GenericRecord";
+          }
         }
       });
       schema += `
@@ -214342,7 +214370,7 @@ async function generate(args) {
 }
 
 const name = "@shopware/api-gen";
-const version = "1.0.1";
+const version = "1.0.3";
 const description = "Shopware CLI for API client generation.";
 const author = "Shopware";
 const type = "module";
@@ -214568,6 +214596,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 +214618,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 +214633,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 +214679,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.1",
+  "version": "1.0.3",
   "description": "Shopware CLI for API client generation.",
   "author": "Shopware",
   "type": "module",