add jsdocs

Author: mathu97

packages/@apphosting/adapter-nextjs/e2e/app.spec.ts

@@ -125,7 +125,7 @@ describe("app", () => {
     );
   });
 
-  it("should have x-fah-adapter header on all routes", async () => {
+  it("should have x-fah-adapter header and no x-fah-middleware header on all routes", async () => {
     const routes = [
       "/",
       "/ssg",
@@ -143,6 +143,11 @@ describe("app", () => {
         `nextjs-${adapterVersion}`,
         `Route ${route} missing x-fah-adapter header`,
       );
+      assert.equal(
+        response.headers.get("x-fah-middleware"),
+        null,
+        `Route ${route} should not have x-fah-middleware header`,
+      );
     }
   });
 });

packages/@apphosting/adapter-nextjs/src/overrides.ts

@@ -1,6 +1,12 @@
 import { AdapterMetadata, MiddlewareManifest } from "./interfaces.js";
 import { loadRouteManifest, writeRouteManifest, loadMiddlewareManifest } from "./utils.js";
 
+/**
+ * Adds the route overrides to the route manifest.
+ * @param appPath The path to the app directory.
+ * @param distDir The path to the dist directory.
+ * @param adapterMetadata The adapter metadata.
+ */
 export async function addRouteOverrides(
   appPath: string,
   distDir: string,

packages/@apphosting/adapter-nextjs/src/utils.ts

@@ -35,12 +35,24 @@ export async function loadConfig(root: string, projectRoot: string): Promise<Nex
   return await loadConfig(PHASE_PRODUCTION_BUILD, root);
 }
 
+/**
+ * Loads the route manifest from the standalone directory.
+ * @param standalonePath The path to the standalone directory.
+ * @param distDir The path to the dist directory.
+ * @returns The route manifest.
+ */
 export function loadRouteManifest(standalonePath: string, distDir: string): RoutesManifest {
   const manifestPath = join(standalonePath, distDir, ROUTES_MANIFEST);
   const json = readFileSync(manifestPath, "utf-8");
   return JSON.parse(json) as RoutesManifest;
 }
 
+/**
+ * Loads the middleware manifest from the standalone directory.
+ * @param standalonePath The path to the standalone directory.
+ * @param distDir The path to the dist directory.
+ * @returns The middleware manifest.
+ */
 export function loadMiddlewareManifest(
   standalonePath: string,
   distDir: string,
@@ -50,6 +62,12 @@ export function loadMiddlewareManifest(
   return JSON.parse(json) as MiddlewareManifest;
 }
 
+/**
+ * Writes the route manifest to the standalone directory.
+ * @param standalonePath The path to the standalone directory.
+ * @param distDir The path to the dist directory.
+ * @param customManifest The route manifest to write.
+ */
 export async function writeRouteManifest(
   standalonePath: string,
   distDir: string,