@shopware/api-gen 0.0.3 → 0.0.5

package/README.md

@@ -12,8 +12,14 @@ Documentation specific for this package: [api-gen](https://frontends.shopware.co
 
 Full changelog for stable version is available [here](https://github.com/shopware/frontends/blob/main/packages/api-gen/CHANGELOG.md)
 
-### Latest changes: 0.0.3
+### Latest changes: 0.0.5
 
 ### Patch Changes
 
-- [#292](https://github.com/shopware/frontends/pull/292) [`b68ca7f`](https://github.com/shopware/frontends/commit/b68ca7fbd51d22f4be84a228ca107972e07bfa32) Thanks [@patzick](https://github.com/patzick)! - fixed cli building, prettier is not inlined into bundle
+- [#303](https://github.com/shopware/frontends/pull/303) [`aeb639a`](https://github.com/shopware/frontends/commit/aeb639a3244f812c275145345618e5bc0045be0d) Thanks [@patzick](https://github.com/patzick)! - Improved linting in packages. Types should be more reliable
+
+- [#313](https://github.com/shopware/frontends/pull/313) [`0e82ab3`](https://github.com/shopware/frontends/commit/0e82ab395cc88e992d2d64853d27603548c36bb9) Thanks [@patzick](https://github.com/patzick)! - Dependency changes:
+
+  - Changed dependency _openapi-typescript_ from **^6.2.8** to **^6.3.4**
+  - Changed dependency _prettier_ from **^2.8.8** to **^3.0.0**
+  - Changed dependency _semver_ from **^7.5.3** to **^7.5.4**

package/dist/cli.mjs

@@ -528,8 +528,11 @@ const patches = {
      */
     name: "ContextTokenResponse",
     patch: (schema) => {
-      var _a;
-      (_a = schema.components.schemas)["ContextTokenResponse"] ?? (_a["ContextTokenResponse"] = {
+      var _a, _b, _c, _d, _e, _f, _g, _h;
+      schema.components ?? (schema.components = {});
+      (_a = schema.components).schemas ?? (_a.schemas = {});
+      schema.paths ?? (schema.paths = {});
+      (_b = schema.components.schemas)["ContextTokenResponse"] ?? (_b["ContextTokenResponse"] = {
         type: "object",
         properties: {
           contextToken: {
@@ -538,36 +541,48 @@ const patches = {
           }
         }
       });
-      schema.paths["/context"].patch.responses["200"] = {
-        description: "Returns the context token. Use that as your `sw-context-token` header for subsequent requests. Redirect if getRedirectUrl is set.",
-        content: {
-          "application/json": {
-            schema: {
-              $ref: "#/components/schemas/ContextTokenResponse"
+      (_c = schema.paths["/context"]).patch ?? (_c.patch = {});
+      if ("responses" in schema.paths["/context"].patch) {
+        (_d = schema.paths["/context"].patch).responses ?? (_d.responses = {});
+        schema.paths["/context"].patch.responses["200"] = {
+          description: "Returns the context token. Use that as your `sw-context-token` header for subsequent requests. Redirect if getRedirectUrl is set.",
+          content: {
+            "application/json": {
+              schema: {
+                $ref: "#/components/schemas/ContextTokenResponse"
+              }
             }
           }
-        }
-      };
-      schema.paths["/account/login"].post.responses["200"] = {
-        description: "A successful login returns a context token which is associated with the logged in user. Use that as your `sw-context-token` header for subsequent requests.",
-        content: {
-          "application/json": {
-            schema: {
-              $ref: "#/components/schemas/ContextTokenResponse"
+        };
+      }
+      (_e = schema.paths["/account/login"]).post ?? (_e.post = {});
+      if ("responses" in schema.paths["/account/login"].post) {
+        (_f = schema.paths["/account/login"].post).responses ?? (_f.responses = {});
+        schema.paths["/account/login"].post.responses["200"] = {
+          description: "A successful login returns a context token which is associated with the logged in user. Use that as your `sw-context-token` header for subsequent requests.",
+          content: {
+            "application/json": {
+              schema: {
+                $ref: "#/components/schemas/ContextTokenResponse"
+              }
             }
           }
-        }
-      };
-      schema.paths["/account/logout"].post.responses["200"] = {
-        description: "A successful logout returns a context token for the anonymous user. Use that as your `sw-context-token` header for subsequent requests.",
-        content: {
-          "application/json": {
-            schema: {
-              $ref: "#/components/schemas/ContextTokenResponse"
+        };
+      }
+      (_g = schema.paths["/account/logout"]).post ?? (_g.post = {});
+      if ("responses" in schema.paths["/account/logout"].post) {
+        (_h = schema.paths["/account/logout"].post).responses ?? (_h.responses = {});
+        schema.paths["/account/logout"].post.responses["200"] = {
+          description: "A successful logout returns a context token for the anonymous user. Use that as your `sw-context-token` header for subsequent requests.",
+          content: {
+            "application/json": {
+              schema: {
+                $ref: "#/components/schemas/ContextTokenResponse"
+              }
             }
           }
-        }
-      };
+        };
+      }
       return schema;
     }
   }
@@ -609,10 +624,11 @@ async function generate() {
           Authorization: config.OPENAPI_ACCESS_KEY
         }
       }).then((res) => res.json());
-      const content2 = format(JSON.stringify(apiJSON), {
+      const formatted2 = await format(JSON.stringify(apiJSON), {
         semi: false,
         parser: "json"
-      }).trim();
+      });
+      const content2 = formatted2.trim();
       version = apiJSON?.info?.version;
       writeFileSync(SCHEMA_FILENAME(version), content2, {
         encoding: "utf-8"
@@ -631,10 +647,11 @@ async function generate() {
       schemaForPatching = patches[patchName].patch(schemaForPatching);
     });
     patchesToApply.length && console.log("Applied", patchesToApply.length, "patches");
-    const content = format(JSON.stringify(schemaForPatching), {
+    const formatted = await format(JSON.stringify(schemaForPatching), {
       semi: false,
       parser: "json"
-    }).trim();
+    });
+    const content = formatted.trim();
     writeFileSync(SCHEMA_FILENAME(version), content, {
       encoding: "utf-8"
     });
@@ -679,12 +696,15 @@ async function generate() {
             );
             schemaObject.properties.translated = {
               type: "object",
-              properties: stringFields.reduce((acc, key) => {
-                acc[key] = {
-                  type: "string"
-                };
-                return acc;
-              }, {})
+              properties: stringFields.reduce(
+                (acc, key) => {
+                  acc[key] = {
+                    type: "string"
+                  };
+                  return acc;
+                },
+                {}
+              )
             };
           }
           if (
@@ -697,38 +717,42 @@ async function generate() {
         }
       }
     );
-    const operationsMap = Object.keys(paths).reduce((acc, path) => {
-      const pathObject = paths[path];
-      const methods = Object.keys(pathObject);
-      methods.forEach((method) => {
-        const methodObject = pathObject[method];
-        const { operationId } = methodObject;
-        const queryParamNames = methodObject.parameters?.filter((param) => param.in === "query").map((param) => param.name) || [];
-        const headerParamNames = methodObject.parameters?.filter((param) => param.in === "header").map((param) => param.name) || [];
-        let finalPath = `${operationId} ${method.toLocaleLowerCase()} ${path}`;
-        if (queryParamNames.length) {
-          finalPath += `?${queryParamNames.join(",")}`;
-        }
-        if (headerParamNames.length) {
-          finalPath += ` ${headerParamNames.join(",")}`;
-        }
-        acc[operationId] = {
-          path,
-          method,
-          queryParamNames,
-          finalPath
-        };
-      });
-      return acc;
-    }, {});
+    const operationsMap = Object.keys(paths).reduce(
+      (acc, path) => {
+        const pathObject = paths[path];
+        const methods = Object.keys(pathObject);
+        methods.forEach((method) => {
+          const methodObject = pathObject[method];
+          const { operationId } = methodObject;
+          const queryParamNames = methodObject.parameters?.filter((param) => param.in === "query").map((param) => param.name) || [];
+          const headerParamNames = methodObject.parameters?.filter((param) => param.in === "header").map((param) => param.name) || [];
+          let finalPath = `${operationId} ${method.toLocaleLowerCase()} ${path}`;
+          if (queryParamNames.length) {
+            finalPath += `?${queryParamNames.join(",")}`;
+          }
+          if (headerParamNames.length) {
+            finalPath += ` ${headerParamNames.join(",")}`;
+          }
+          acc[operationId] = {
+            path,
+            method,
+            queryParamNames,
+            finalPath
+          };
+        });
+        return acc;
+      },
+      {}
+    );
     schema += `
  export type operationPaths = ${Object.values(operationsMap).map((el) => `"${el.finalPath}"`).join(" | ")};`;
     schema = schema.replace(/@description /g, "");
-    schema = format(schema, {
+    schema = await format(schema, {
       // semi: false,
       parser: "typescript"
       // plugins: [tsParser],
-    }).trim();
+    });
+    schema = schema.trim();
     if (typeof schema === "string") {
       writeFileSync(TYPES_FILENAME(originalSchema.info.version), schema, {
         encoding: "utf-8"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopware/api-gen",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Shopware CLI for API client generation.",
   "author": "Shopware",
   "repository": {
@@ -25,26 +25,26 @@
     "api-gen": "bin/api-gen.mjs"
   },
   "devDependencies": {
-    "@types/prettier": "^2.7.2",
+    "@types/prettier": "^2.7.3",
     "@types/yargs": "^17.0.24",
-    "@vitest/coverage-c8": "^0.32.2",
+    "@vitest/coverage-c8": "^0.33.0",
     "picocolors": "^1.0.0",
-    "vitest": "^0.32.2",
-    "eslint-config-shopware": "0.0.2",
+    "vitest": "^0.33.0",
+    "eslint-config-shopware": "0.0.4",
     "tsconfig": "0.0.0"
   },
   "dependencies": {
-    "ofetch": "^1.0.1",
-    "openapi-typescript": "^6.2.8",
-    "prettier": "^2.8.8",
-    "semver": "^7.3.8",
+    "ofetch": "^1.1.1",
+    "openapi-typescript": "^6.3.4",
+    "prettier": "^3.0.0",
+    "semver": "^7.5.4",
     "yargs": "^17.7.2"
   },
   "scripts": {
     "build": "unbuild",
     "cli": "esno ./src/cli.ts",
     "dev": "export NODE_ENV=development && unbuild --stub",
-    "lint": "eslint src/**/*.ts* --fix --max-warnings=0",
+    "lint": "eslint src/**/*.ts* --fix --max-warnings=0 && pnpm run typecheck",
     "typecheck": "tsc --noEmit",
     "test": "vitest run",
     "test:bench": "vitest bench",