Fix swagger build

Author: devksingh4

Makefile

@@ -56,10 +56,13 @@ clean:
 	rm -rf dist_devel/
 	rm -rf coverage/
 
+build_swagger:
+	cd src/api && npx tsx --experimental-loader=./mockLoader.mjs createSwagger.ts && cd ../..
+
 build: src/ cloudformation/
 	yarn -D
 	VITE_BUILD_HASH=$(GIT_HASH) yarn build
-	cd src/api && npx tsx --experimental-loader=./mockLoader.mjs createSwagger.ts
+	make build_swagger
 	cp -r src/api/resources/ dist/api/resources
 	rm -rf dist/lambda/sqs
 	sam build --template-file cloudformation/main.yml --use-container --parallel

src/api/createSwagger.ts

@@ -1,8 +1,10 @@
 import { fileURLToPath } from "url";
 import path from "node:path";
-import { writeFile, mkdir } from "fs/promises";
+import { writeFile, mkdir, rm } from "fs/promises";
 import init from "./index.js"; // Assuming this is your Fastify app initializer
-import { docsHtml } from "./docs.js";
+import { docsHtml, securitySchemes } from "./docs.js";
+import yaml from "yaml";
+
 /**
  * Generates and saves Swagger/OpenAPI specification files.
  */
@@ -14,9 +16,16 @@ async function createSwaggerFiles() {
     const __filename = fileURLToPath(import.meta.url);
     const __dirname = path.dirname(__filename);
     const outputDir = path.resolve(__dirname, "..", "..", "dist_ui", "docs");
+    await rm(outputDir, { recursive: true, force: true });
     await mkdir(outputDir, { recursive: true });
-    const jsonSpec = JSON.stringify(app.swagger(), null, 2);
-    const yamlSpec = app.swagger({ yaml: true });
+    const swaggerConfig = app.swagger();
+    const realSwaggerConfig = JSON.parse(JSON.stringify(swaggerConfig));
+    realSwaggerConfig.components = realSwaggerConfig.components || {};
+    realSwaggerConfig.components.securitySchemes = securitySchemes;
+    const jsonSpec = JSON.stringify(realSwaggerConfig, null, 2);
+    const doc = new yaml.Document();
+    doc.contents = realSwaggerConfig;
+    const yamlSpec = doc.toString();
     await writeFile(path.join(outputDir, "openapi.json"), jsonSpec);
     await writeFile(path.join(outputDir, "openapi.yaml"), yamlSpec);
     await writeFile(path.join(outputDir, "index.html"), docsHtml);

src/api/docs.ts

@@ -136,3 +136,18 @@ export const docsHtml = `
   </body>
 </html>
 `;
+
+export const securitySchemes = {
+  bearerAuth: {
+    type: "http",
+    scheme: "bearer",
+    bearerFormat: "JWT",
+    description:
+      "Authorization: Bearer {token}\n\nThis API uses JWT tokens issued by Entra ID (Azure AD) with the Core API audience. Tokens must be included in the Authorization header as a Bearer token for all protected endpoints.",
+  },
+  apiKeyAuth: {
+    type: "apiKey",
+    in: "header",
+    name: "X-Api-Key",
+  },
+};

src/api/index.ts

@@ -61,7 +61,7 @@ import protectedRoute from "./routes/protected.js";
 import eventsPlugin from "./routes/events.js";
 import mobileWalletV2Route from "./routes/v2/mobileWallet.js";
 import membershipV2Plugin from "./routes/v2/membership.js";
-import { docsHtml } from "./docs.js";
+import { docsHtml, securitySchemes } from "./docs.js";
 /** END ROUTES */
 
 export const instanceId = randomUUID();
@@ -217,20 +217,7 @@ Otherwise, email [[email protected]](mailto:[email protected]) for sup
 
           openapi: "3.1.0" satisfies ZodOpenApiVersion, // If this is not specified, it will default to 3.1.0
           components: {
-            securitySchemes: {
-              bearerAuth: {
-                type: "http",
-                scheme: "bearer",
-                bearerFormat: "JWT",
-                description:
-                  "Authorization: Bearer {token}\n\nThis API uses JWT tokens issued by Entra ID (Azure AD) with the Core API audience. Tokens must be included in the Authorization header as a Bearer token for all protected endpoints.",
-              },
-              apiKeyAuth: {
-                type: "apiKey",
-                in: "header",
-                name: "X-Api-Key",
-              },
-            },
+            securitySchemes: securitySchemes as any,
           },
         },
         transform: fastifyZodOpenApiTransform,

src/api/package.json

@@ -30,6 +30,7 @@
     "@fastify/caching": "^9.0.1",
     "@fastify/cors": "^11.0.1",
     "@fastify/static": "^8.1.1",
+    "@fastify/swagger": "^9.5.0",
     "@middy/core": "^6.1.6",
     "@middy/event-normalizer": "^6.1.6",
     "@middy/sqs-partial-batch-failure": "^6.1.6",
@@ -59,15 +60,15 @@
     "stripe": "^18.0.0",
     "uuid": "^11.1.0",
     "zod": "^3.25.73",
-    "zod-validation-error": "^3.3.1",
-    "@fastify/swagger": "^9.5.0"
+    "zod-validation-error": "^3.3.1"
   },
   "devDependencies": {
     "@tsconfig/node22": "^22.0.1",
     "@types/aws-lambda": "^8.10.149",
     "@types/qrcode": "^1.5.5",
     "esbuild-copy-static-files": "^0.1.0",
     "nodemon": "^3.1.10",
-    "pino-pretty": "^13.0.0"
+    "pino-pretty": "^13.0.0",
+    "yaml": "^2.8.0"
   }
-}
+}

yarn.lock

@@ -10422,7 +10422,7 @@ yallist@^4.0.0:
   resolved "https://registry.yarnpkg.com/yallist/-/yallist-4.0.0.tgz#9bb92790d9c0effec63be73519e11a35019a3a72"
   integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==
 
-yaml@^2.4.2:
+yaml@^2.4.2, yaml@^2.8.0:
   version "2.8.0"
   resolved "https://registry.yarnpkg.com/yaml/-/yaml-2.8.0.tgz#15f8c9866211bdc2d3781a0890e44d4fa1a5fff6"
   integrity sha512-4lLa/EcQCB0cJkyts+FpIRx5G/llPxfP6VQU5KByHEhLxY3IJCH0f0Hy1MHI8sClTvsIb8qwRJ6R/ZdlDJ/leQ==