feat(api-gen): added apiType option to loadSchema command (#564)

.changeset/quiet-ghosts-itch.md

@@ -0,0 +1,15 @@
+---
+"@shopware/api-gen": minor
+---
+
+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
+```

packages/api-client-next/package.json

@@ -42,7 +42,6 @@
     "build": "export NODE_ENV=production && unbuild && pnpm build:types",
     "build:types": "tsc ./src/*.ts --declaration --allowJs --emitDeclarationOnly --outDir ./temp --skipLibCheck",
     "dev": "export NODE_ENV=development && unbuild --stub",
-    "generate": "esno ../api-gen/src/cli.ts generate",
     "lint": "eslint src/**/*.ts* --fix --max-warnings=0 && pnpm run typecheck",
     "typecheck": "tsc --noEmit",
     "test": "vitest run --typecheck",
@@ -51,7 +50,6 @@
   },
   "devDependencies": {
     "@codspeed/vitest-plugin": "^2.3.1",
-    "@shopware/api-gen": "workspace:*",
     "@types/prettier": "^3.0.0",
     "@vitest/coverage-v8": "^1.2.2",
     "eslint-config-shopware": "workspace:*",

packages/api-gen/README.md

@@ -19,12 +19,18 @@ npx i @shopware/api-gen [command]
 
 ### `generate`
 
-Transform OpenAPI specification from JSON file to Typescript schemas.
+Transform OpenAPI specification from JSON file to Typescript schemas. Use `loadSchema` command first.
 
 options:
 
 ```bash
 pnpx @shopware/api-gen generate --help
+
+# generate schemas from store API
+pnpx @shopware/api-gen generate --filename=storeApiSchema.json
+
+# generate schemas from admin API
+pnpx @shopware/api-gen generate --filename=adminApiSchema.json
 ```
 
 ### `loadSchema`
@@ -35,6 +41,21 @@ options:
 
 ```bash
 pnpx @shopware/api-gen loadSchema --help
+
+# 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
+```
+
+Remember to add `.env` file in order to authenticate with Shopware instance.
+
+```bash
+OPENAPI_JSON_URL="https://your-shop-instance.shopware.store"
+OPENAPI_ACCESS_KEY="YOUR_STORE_API_ACCESS_KEY"
+SHOPWARE_ADMIN_USERNAME="my@username.com"
+SHOPWARE_ADMIN_PASSWORD="my-password"
 ```
 
 <!-- AUTO GENERATED CHANGELOG -->

packages/api-gen/package.json

@@ -47,6 +47,7 @@
     "vitest": "^1.2.2"
   },
   "dependencies": {
+    "@shopware/api-client": "workspace:*",
     "ofetch": "^1.3.3",
     "openapi-typescript": "^6.7.4",
     "prettier": "^3.2.4",

packages/api-gen/src/cli.ts

@@ -21,7 +21,7 @@ function commonOptions(args: Argv<unknown>): Argv<CommonOptions> {
 
 // eslint-disable-next-line no-unused-expressions
 yargs(hideBin(process.argv))
-  .scriptName("client")
+  .scriptName("@shopware/api-gen")
   .usage("$0 [args]")
   .command(
     "generate",
@@ -42,6 +42,12 @@ yargs(hideBin(process.argv))
     "Load JSON schema from your API instance. You need to have proper .env file",
     (args) => {
       return commonOptions(args)
+        .option("apiType", {
+          describe:
+            "Type of the API schema to load. It can be 'store' or 'admin'",
+          default: "store",
+          choices: ["store", "admin"],
+        })
         .positional("filename", {
           type: "string",
           default: "apiSchema.json",

packages/api-gen/src/commands/loadSchema.ts

@@ -2,28 +2,98 @@ import { writeFileSync } from "node:fs";
 import * as dotenv from "dotenv";
 import c from "picocolors";
 import { format } from "prettier";
+import { createAdminAPIClient, createAPIClient } from "@shopware/api-client";
+import type {
+  operations as adminOperations,
+  operationPaths as adminOperationPaths,
+} from "@shopware/api-client/admin-api-types";
+// TODO: change adminOperations to storeOperations after fixing NEXT-33506
+// import type {
+//   operations,
+//   operationPaths,
+// } from "@shopware/api-client/api-types";
 
 const config = dotenv.config().parsed || {};
 
-export async function loadSchema(args: { cwd: string; filename: string }) {
+const SCHEMA_ENDPOINT = "_info/openapi3.json";
+const STORE_API_ENDPOINT = `/store-api/${SCHEMA_ENDPOINT}`;
+const ADMIN_API_ENDPOINT = `/api/${SCHEMA_ENDPOINT}`;
+
+export async function loadSchema(args: {
+  cwd: string;
+  filename: string;
+  apiType: string;
+}) {
+  if (!["store", "admin"].includes(args.apiType)) {
+    console.error(
+      c.red(`Invalid "apiType" argument. It should be "store" or "admin"`),
+    );
+    process.exit(1);
+  }
+  const isAdminApi = args.apiType === "admin";
+
+  const requiredEnvVars = ["OPENAPI_JSON_URL"];
+  if (isAdminApi) {
+    requiredEnvVars.push("SHOPWARE_ADMIN_USERNAME");
+    requiredEnvVars.push("SHOPWARE_ADMIN_PASSWORD");
+  } else {
+    requiredEnvVars.push("OPENAPI_ACCESS_KEY");
+  }
+
+  const missingEnvVars = requiredEnvVars.filter((envVar) => !config[envVar]);
   try {
-    if (!config.OPENAPI_JSON_URL || !config.OPENAPI_ACCESS_KEY) {
+    if (missingEnvVars.length) {
       console.error(
         c.red(
-          `Missing ${c.bold("OPENAPI_JSON_URL")} or ${c.bold(
-            "OPENAPI_ACCESS_KEY",
-          )} env variables.\n\nCheck whether the .env file is created.\n`,
+          `Missing ${c.bold(missingEnvVars.join(","))} env variables.\n\nCheck whether the .env file is created.\n`,
         ),
       );
       process.exit(1);
     }
 
-    const apiJSON = await fetch(config.OPENAPI_JSON_URL, {
-      headers: {
-        "sw-access-key": config.OPENAPI_ACCESS_KEY,
-        Authorization: config.OPENAPI_ACCESS_KEY,
-      },
-    }).then((res) => res.json());
+    const configUrl = config.OPENAPI_JSON_URL.replace(
+      "/api/_info/openapi3.json",
+      "",
+    ).replace("/atore-api/_info/openapi3.json", "");
+
+    const downloadUrl =
+      configUrl + (isAdminApi ? ADMIN_API_ENDPOINT : STORE_API_ENDPOINT);
+
+    let apiJSON;
+
+    if (isAdminApi) {
+      const adminClient = createAdminAPIClient<
+        adminOperations,
+        adminOperationPaths
+      >({
+        baseURL: `${configUrl}/api`,
+        credentials: {
+          grant_type: "password",
+          client_id: "administration",
+          scopes: "write",
+          username: config.SHOPWARE_ADMIN_USERNAME,
+          password: config.SHOPWARE_ADMIN_PASSWORD,
+        },
+      });
+      apiJSON = await adminClient.invoke(
+        "api-info get /_info/openapi3.json?type",
+        {
+          type: "json",
+        },
+      );
+    } else {
+      // TODO: change adminOperations to storeOperations after fixing NEXT-33506
+      const apiClient = createAPIClient<adminOperations, adminOperationPaths>({
+        baseURL: `${configUrl}/store-api`,
+        accessToken: config.OPENAPI_ACCESS_KEY,
+      });
+      apiJSON = await apiClient.invoke(
+        "api-info get /_info/openapi3.json?type",
+        {
+          type: "json",
+        },
+      );
+    }
 
     const formatted = await format(JSON.stringify(apiJSON), {
       semi: false,
@@ -40,7 +110,7 @@ export async function loadSchema(args: { cwd: string; filename: string }) {
     console.log(
       c.green(
         `Schema file loaded from ${c.bold(
-          config.OPENAPI_JSON_URL,
+          downloadUrl,
         )} and saved to ${c.bold(args.filename)}`,
       ),
     );