feat: add scripts to filter and patch Shopware API schemas for compatibility

Author: nicosammito

actions/shopware-action/scripts/filterShopwareSpec.mjs

@@ -0,0 +1,77 @@
+// The full Shopware Admin API spec (adminapi.json, ~4MB, 409 schemas)
+// is so heavily cross-referenced and circular that openapi-zod-client
+// runs out of memory on it. Since only the Order entity schema is
+// needed for the webhook payloads, this script reduces the downloaded
+// spec before code generation:
+//   - keeps the Order entity family and the leaf entities that matter
+//     for order handling (addresses, states, currency) fully typed
+//   - replaces $refs to any other entity with a permissive untyped
+//     object, cutting the circular graph
+// This is acceptable for webhook payloads because Shopware business
+// events do not guarantee complete associations anyway (see
+// guides/plugins/apps/lifecycle/webhook.md in shopware/docs).
+// Runs as part of "generate:shopware-schemas" right after the download.
+import {readFileSync, writeFileSync} from "node:fs";
+
+const KEEP_SCHEMAS = new Set([
+    "Order",
+    "OrderAddress",
+    "OrderCustomer",
+    "OrderDelivery",
+    "OrderDeliveryPosition",
+    "OrderLineItem",
+    "OrderLineItemDownload",
+    "OrderTransaction",
+    "OrderTransactionCapture",
+    "OrderTransactionCaptureRefund",
+    "OrderTransactionCaptureRefundPosition",
+    "StateMachineState",
+    "Currency",
+    "Country",
+    "CountryState",
+    "Salutation",
+]);
+
+const input = new URL("../schemas/shopware-admin-openapi.json", import.meta.url);
+const output = new URL("../schemas/shopware-admin-openapi.filtered.json", import.meta.url);
+
+const spec = JSON.parse(readFileSync(input, "utf8"));
+const allSchemas = spec.components.schemas;
+
+for (const name of KEEP_SCHEMAS) {
+    if (!(name in allSchemas)) {
+        throw new Error(`Schema "${name}" not found in ${input}`);
+    }
+}
+
+// Replace $refs pointing outside KEEP_SCHEMAS with an untyped object.
+const stubForeignRefs = (node) => {
+    if (Array.isArray(node)) {
+        return node.map(stubForeignRefs);
+    }
+    if (node !== null && typeof node === "object") {
+        const ref = node.$ref;
+        if (typeof ref === "string") {
+            const match = ref.match(/^#\/components\/schemas\/(.+)$/);
+            if (match && !KEEP_SCHEMAS.has(match[1])) {
+                return {type: "object", additionalProperties: true};
+            }
+        }
+        return Object.fromEntries(Object.entries(node).map(([key, value]) => [key, stubForeignRefs(value)]));
+    }
+    return node;
+};
+
+const filtered = {
+    openapi: spec.openapi,
+    info: spec.info,
+    paths: {},
+    components: {
+        schemas: Object.fromEntries(
+            [...KEEP_SCHEMAS].sort().map((name) => [name, stubForeignRefs(allSchemas[name])]),
+        ),
+    },
+};
+
+writeFileSync(output, JSON.stringify(filtered, null, 2));
+console.log(`Kept ${KEEP_SCHEMAS.size} of ${Object.keys(allSchemas).length} schemas: ${[...KEEP_SCHEMAS].sort().join(", ")}`);

actions/shopware-action/scripts/patchGeneratedSchemas.mjs

@@ -0,0 +1,19 @@
+// openapi-zod-client emits zod v3 code, but this project uses zod v4,
+// where z.record() requires an explicit key schema. Rewrites the
+// generated single-argument form z.record(Value) to
+// z.record(z.string(), Value).
+// The Shopware order schemas are mutually recursive, so the generator
+// wraps them in z.lazy() without type annotations, which fails the
+// typecheck under noImplicitAny (TS7022). Adds an explicit
+// z.ZodTypeAny annotation to those consts.
+// Runs as part of "generate:shopware-schemas" right after code generation.
+import {readFileSync, writeFileSync} from "node:fs";
+
+const file = new URL("../src/generated/shopware-schemas.ts", import.meta.url);
+const source = readFileSync(file, "utf8");
+writeFileSync(
+    file,
+    source
+        .replaceAll("z.record(", "z.record(z.string(), ")
+        .replace(/^const (\w+) = z\.lazy\(/gm, "const $1: z.ZodTypeAny = z.lazy("),
+);