@shopware/api-gen 1.2.1 → 1.3.0

package/README.md

@@ -107,7 +107,8 @@ Example:
 
 ```json
 {
-  "patches": ["./api-types/storeApiTypes.overrides.json"]
+  "$schema": "https://raw.githubusercontent.com/shopware/frontends/main/packages/api-gen/api-gen.schema.json",
+  "patches": ["storeApiTypes.overrides.json"]
 }
 ```
 
@@ -115,6 +116,7 @@ or you could use multiple patches and add your own overrides on top:
 
 ```json
 {
+  "$schema": "https://raw.githubusercontent.com/shopware/frontends/main/packages/api-gen/api-gen.schema.json",
   "patches": [
     "https://raw.githubusercontent.com/shopware/frontends/refs/heads/main/packages/api-client/api-types/storeApiSchema.overrides.json",
     "./api-types/myOwnPatches.overrides.json"
@@ -246,7 +248,7 @@ Prepare your config file named **api-gen.config.json**:
   "rules": [
     "COMPONENTS_API_ALIAS" // you have description on autocompletion what specific rule does, this one for example ensures correctness of the apiAlias field
   ],
-  //"patches": "./api-types/storeApiTypes.overrides.json" // -> path to your overrides file, default is fetched from api-client repository
+  //"patches": "storeApiTypes.overrides.json" // -> path to your overrides file in api-types folder, default is fetched from api-client repository
 }
 ```
 
@@ -264,11 +266,9 @@ 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.2.1
-
-### Patch Changes
+### Latest changes: 1.3.0
 
-- [#1696](https://github.com/shopware/frontends/pull/1696) [`f953539`](https://github.com/shopware/frontends/commit/f953539726813aa3cba404df2a74fa2d18b96fb0) Thanks [@mdanilowicz](https://github.com/mdanilowicz)! - `loadSchema` command - create `api-types` folder if not exists
+### Minor Changes
 
-- Updated dependencies [[`7324620`](https://github.com/shopware/frontends/commit/7324620a3f39c1b62f7cc294192a3e8b8b336d09)]:
-  - @shopware/api-client@1.2.1
+- [#1706](https://github.com/shopware/frontends/pull/1706) [`d7bf6d7`](https://github.com/shopware/frontends/commit/d7bf6d715689f5d0cbef9f0bbbc78f19f54215d5) Thanks [@patzick](https://github.com/patzick)! - Simplify `api-gen.config.json` configuration. Now you can use names instead of paths in patches like `storeApiSchema.overrides.json` or `storeApiSchema.b2b.overrides.json`.
+  Thanks to this you can simple and more granularly apply patches for your project.

package/dist/cli.mjs

@@ -1,7 +1,7 @@
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
-import { readFileSync, existsSync, writeFileSync, mkdirSync } from 'node:fs';
-import { join, resolve, dirname } from 'node:path';
+import { existsSync, readFileSync, writeFileSync, mkdirSync } from 'node:fs';
+import { resolve, join, dirname } from 'node:path';
 import openapiTS, { transformSchemaObjectWithComposition, astToString } from 'openapi-typescript';
 import require$$1$1 from 'fs';
 import require$$1 from 'path';
@@ -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.2.1";
+const version$2 = "1.3.0";
 const description$1 = "Shopware CLI for API client generation.";
 const author = "Shopware";
 const type$1 = "module";
@@ -207241,8 +207241,7 @@ ${c.cyan(
     openApiSchema?.paths || {}
   )) {
     for (const httpMethod of Object.keys(pathObject)) {
-      if (!(httpMethod in pathObject))
-        continue;
+      if (!(httpMethod in pathObject)) continue;
       schemaPaths.push({
         path: pathName,
         method: httpMethod.toUpperCase()
@@ -207271,6 +207270,77 @@ ${c.cyan(
   };
 }
 
+function getTypePropertyNames(type) {
+  return type.getProperties().map((prop) => prop.name);
+}
+function getDeepProperty({
+  type,
+  names,
+  node,
+  typeChecker
+}) {
+  if (names.length === 0) {
+    return type;
+  }
+  const [currentName, ...restNames] = names;
+  const property = type.getProperty(currentName);
+  if (!property) {
+    return void 0;
+  }
+  const propertyType = typeChecker.getTypeOfSymbolAtLocation(property, node);
+  return getDeepProperty({
+    type: propertyType,
+    names: restNames,
+    node,
+    typeChecker
+  });
+}
+function getDeepPropertyCode({
+  type,
+  names,
+  node,
+  typeChecker
+}) {
+  const namesWithoutLast = names.slice(0, -1);
+  const currentName = names[names.length - 1];
+  const deepProperty = getDeepProperty({
+    type,
+    names: namesWithoutLast,
+    node,
+    typeChecker
+  });
+  if (deepProperty) {
+    const property = deepProperty.getProperty(currentName);
+    if (!property) {
+      return void 0;
+    }
+    return property.valueDeclaration?.getText().replace(/^[^:]+:/, "");
+  }
+}
+function isOptional(symbol) {
+  const declarations = symbol.getDeclarations();
+  if (!declarations) return false;
+  const declaration = declarations[0];
+  if (ts.isPropertySignature(declaration) && declaration.questionToken !== void 0) {
+    return true;
+  }
+  if (ts.isParameter(declaration) && declaration.questionToken !== void 0) {
+    return true;
+  }
+  return false;
+}
+function isNeverType(symbol) {
+  if (!symbol) return false;
+  return symbol.flags === ts.TypeFlags.Never;
+}
+async function loadLocalJSONFile(path) {
+  const localPath = resolve(path);
+  if (existsSync(localPath)) {
+    return lib.parse(readFileSync(localPath, "utf-8"));
+  }
+  return void 0;
+}
+
 const API_GEN_CONFIG_FILENAME = "api-gen.config.json";
 async function loadApiGenConfig(params = {}) {
   try {
@@ -207303,21 +207373,44 @@ async function resolveSinglePath(pathToResolve) {
         responseType: "json",
         parseResponse: lib.parse
       });
+      console.log("Resolved file from", pathToResolve);
       return response;
     }
-    const jsonOverridesFile = await readFileSync(pathToResolve, {
-      encoding: "utf-8"
-    });
-    return lib.parse(jsonOverridesFile);
+    const localFile = await loadLocalJSONFile(pathToResolve);
+    if (localFile) {
+      console.log("Resolved file from", pathToResolve);
+      return localFile;
+    }
+    const apiTypesFolder = join(process.cwd(), "api-types");
+    const apiTypesFile = join(apiTypesFolder, pathToResolve);
+    const localApiTypesFile = await loadLocalJSONFile(apiTypesFile);
+    if (localApiTypesFile) {
+      console.log("Resolved file from", apiTypesFile);
+      return localApiTypesFile;
+    }
+    const nodeModulesFolder = resolve(
+      `node_modules/@shopware/api-client/api-types/${pathToResolve}`
+    );
+    const localNodeModulesFile = await loadLocalJSONFile(nodeModulesFolder);
+    if (localNodeModulesFile) {
+      console.log("Resolved file from", nodeModulesFolder);
+      return localNodeModulesFile;
+    }
+    const githubFile = `https://raw.githubusercontent.com/shopware/frontends/main/packages/api-client/api-types/${pathToResolve}`;
+    const localGithubFile = await loadLocalJSONFile(githubFile);
+    if (localGithubFile) {
+      console.log("Resolved file from", githubFile);
+      return localGithubFile;
+    }
   } 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}
+        `Problem with resolving file at address ${pathToResolve}. Check whether you configured it properly in your ${API_GEN_CONFIG_FILENAME}
 `
       ),
       error
     );
-    return {};
+    return void 0;
   }
 }
 async function loadJsonOverrides({
@@ -207337,7 +207430,7 @@ async function loadJsonOverrides({
     );
     return extendedDefu(
       {},
-      ...results.filter((result) => result.status === "fulfilled").map((result) => result.value)
+      ...results.filter((result) => result.status === "fulfilled").map((result) => result.value || {})
     );
   } catch (error) {
     console.warn(
@@ -207554,72 +207647,6 @@ async function prepareFileContent({
   return project;
 }
 
-function getTypePropertyNames(type) {
-  return type.getProperties().map((prop) => prop.name);
-}
-function getDeepProperty({
-  type,
-  names,
-  node,
-  typeChecker
-}) {
-  if (names.length === 0) {
-    return type;
-  }
-  const [currentName, ...restNames] = names;
-  const property = type.getProperty(currentName);
-  if (!property) {
-    return void 0;
-  }
-  const propertyType = typeChecker.getTypeOfSymbolAtLocation(property, node);
-  return getDeepProperty({
-    type: propertyType,
-    names: restNames,
-    node,
-    typeChecker
-  });
-}
-function getDeepPropertyCode({
-  type,
-  names,
-  node,
-  typeChecker
-}) {
-  const namesWithoutLast = names.slice(0, -1);
-  const currentName = names[names.length - 1];
-  const deepProperty = getDeepProperty({
-    type,
-    names: namesWithoutLast,
-    node,
-    typeChecker
-  });
-  if (deepProperty) {
-    const property = deepProperty.getProperty(currentName);
-    if (!property) {
-      return void 0;
-    }
-    return property.valueDeclaration?.getText().replace(/^[^:]+:/, "");
-  }
-}
-function isOptional(symbol) {
-  const declarations = symbol.getDeclarations();
-  if (!declarations)
-    return false;
-  const declaration = declarations[0];
-  if (ts.isPropertySignature(declaration) && declaration.questionToken !== void 0) {
-    return true;
-  }
-  if (ts.isParameter(declaration) && declaration.questionToken !== void 0) {
-    return true;
-  }
-  return false;
-}
-function isNeverType(symbol) {
-  if (!symbol)
-    return false;
-  return symbol.flags === ts.TypeFlags.Never;
-}
-
 function createVirtualFiles(files) {
   const filesMap = /* @__PURE__ */ new Map();
   for (const fileDefinition of files) {
@@ -208012,8 +208039,8 @@ async function generate(args) {
     const outputFilename = inputFilename.replace(".json", ".d.ts");
     const fullInputFilePath = join(args.cwd, "api-types", inputFilename);
     const fullOutputFilePath = join(args.cwd, "api-types", outputFilename);
-    const fileExist = existsSync(fullInputFilePath);
-    if (!fileExist && !args.apiType) {
+    const resolvedSchema = await resolveSinglePath(inputFilename);
+    if (!resolvedSchema && !args.apiType) {
       console.log(
         c.yellow(
           `Schema file ${c.bold(
@@ -208028,11 +208055,8 @@ async function generate(args) {
     let schema = "";
     let processedSchemaAst;
     let apiVersion = "unknown";
-    if (fileExist) {
-      const schemaFile = readFileSync(fullInputFilePath, {
-        encoding: "utf-8"
-      });
-      const schemaForPatching = lib.parse(schemaFile);
+    if (resolvedSchema) {
+      const schemaForPatching = structuredClone(resolvedSchema);
       apiVersion = schemaForPatching?.info?.version;
       const configJSON = await loadApiGenConfig({
         silent: true
@@ -208065,7 +208089,7 @@ async function generate(args) {
         openApiSchema: schemaForPatching,
         jsonOverrides
       });
-      const originalSchema = lib.parse(schemaFile);
+      const originalSchema = structuredClone(resolvedSchema);
       console.log("schema", originalSchema.info);
       displayPatchingSummary({
         todosToFix,
@@ -208119,8 +208143,7 @@ async function generate(args) {
             ];
             const stringFields = Object.keys(schemaObject.properties).filter(
               (key) => {
-                if (notAllowedKeys.includes(key))
-                  return false;
+                if (notAllowedKeys.includes(key)) return false;
                 const property = schemaObject.properties?.[key];
                 return !!property && "type" in property && property.type === "string";
               }

package/package.json

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