feat(qwik-city): AWS adapter middleware (#5732)

Co-authored-by: Miško Hevery <[email protected]>

Author: leifermendez

packages/docs/src/routes/api/qwik-city-middleware-aws-lambda/api.json

@@ -0,0 +1,48 @@
+{
+  "id": "qwik-city-middleware-aws-lambda",
+  "package": "@builder.io/qwik-city/middleware/aws-lambda",
+  "members": [
+    {
+      "name": "createQwikCity",
+      "id": "createqwikcity",
+      "hierarchy": [
+        {
+          "name": "createQwikCity",
+          "id": "createqwikcity"
+        }
+      ],
+      "kind": "Function",
+      "content": "```typescript\nexport declare function createQwikCity(opts: AwsOpt): {\n    fixPath: (pathT: string) => string;\n    router: (req: import(\"http\").IncomingMessage | import(\"http2\").Http2ServerRequest, res: import(\"http\").ServerResponse<import(\"http\").IncomingMessage>, next: import(\"@builder.io/qwik-city/middleware/node\").NodeRequestNextFunction) => Promise<void>;\n    staticFile: (req: import(\"http\").IncomingMessage | import(\"http2\").Http2ServerRequest, res: import(\"http\").ServerResponse<import(\"http\").IncomingMessage>, next: (e?: any) => void) => Promise<void>;\n    notFound: (req: import(\"http\").IncomingMessage | import(\"http2\").Http2ServerRequest, res: import(\"http\").ServerResponse<import(\"http\").IncomingMessage>, next: (e: any) => void) => Promise<void>;\n    handle: (req: any, res: any) => void;\n};\n```\n\n\n|  Parameter | Type | Description |\n|  --- | --- | --- |\n|  opts | AwsOpt |  |\n\n**Returns:**\n\n{ fixPath: (pathT: string) =&gt; string; router: (req: import(\"http\").IncomingMessage \\| import(\"http2\").Http2ServerRequest, res: import(\"http\").ServerResponse&lt;import(\"http\").IncomingMessage&gt;, next: import(\"@builder.io/qwik-city/middleware/node\").NodeRequestNextFunction) =&gt; Promise&lt;void&gt;; staticFile: (req: import(\"http\").IncomingMessage \\| import(\"http2\").Http2ServerRequest, res: import(\"http\").ServerResponse&lt;import(\"http\").IncomingMessage&gt;, next: (e?: any) =&gt; void) =&gt; Promise&lt;void&gt;; notFound: (req: import(\"http\").IncomingMessage \\| import(\"http2\").Http2ServerRequest, res: import(\"http\").ServerResponse&lt;import(\"http\").IncomingMessage&gt;, next: (e: any) =&gt; void) =&gt; Promise&lt;void&gt;; handle: (req: any, res: any) =&gt; void; }",
+      "editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/aws-lambda/index.ts",
+      "mdFile": "qwik-city.createqwikcity.md"
+    },
+    {
+      "name": "PlatformAwsLambda",
+      "id": "platformawslambda",
+      "hierarchy": [
+        {
+          "name": "PlatformAwsLambda",
+          "id": "platformawslambda"
+        }
+      ],
+      "kind": "Interface",
+      "content": "```typescript\nexport interface PlatformAwsLambda extends Object \n```\n**Extends:** Object",
+      "editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/aws-lambda/index.ts",
+      "mdFile": "qwik-city.platformawslambda.md"
+    },
+    {
+      "name": "QwikCityAwsLambdaOptions",
+      "id": "qwikcityawslambdaoptions",
+      "hierarchy": [
+        {
+          "name": "QwikCityAwsLambdaOptions",
+          "id": "qwikcityawslambdaoptions"
+        }
+      ],
+      "kind": "Interface",
+      "content": "```typescript\nexport interface QwikCityAwsLambdaOptions extends ServerRenderOptions \n```\n**Extends:** ServerRenderOptions",
+      "editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/aws-lambda/index.ts",
+      "mdFile": "qwik-city.qwikcityawslambdaoptions.md"
+    }
+  ]
+}

packages/docs/src/routes/api/qwik-city-middleware-aws-lambda/index.md

@@ -0,0 +1,59 @@
+---
+title: \@builder.io/qwik-city/middleware/aws-lambda API Reference
+---
+
+# [API](/api) › @builder.io/qwik-city/middleware/aws-lambda
+
+## createQwikCity
+
+```typescript
+export declare function createQwikCity(opts: AwsOpt): {
+  fixPath: (pathT: string) => string;
+  router: (
+    req: import("http").IncomingMessage | import("http2").Http2ServerRequest,
+    res: import("http").ServerResponse<import("http").IncomingMessage>,
+    next: import("@builder.io/qwik-city/middleware/node").NodeRequestNextFunction,
+  ) => Promise<void>;
+  staticFile: (
+    req: import("http").IncomingMessage | import("http2").Http2ServerRequest,
+    res: import("http").ServerResponse<import("http").IncomingMessage>,
+    next: (e?: any) => void,
+  ) => Promise<void>;
+  notFound: (
+    req: import("http").IncomingMessage | import("http2").Http2ServerRequest,
+    res: import("http").ServerResponse<import("http").IncomingMessage>,
+    next: (e: any) => void,
+  ) => Promise<void>;
+  handle: (req: any, res: any) => void;
+};
+```
+
+| Parameter | Type   | Description |
+| --------- | ------ | ----------- |
+| opts      | AwsOpt |             |
+
+**Returns:**
+
+{ fixPath: (pathT: string) =&gt; string; router: (req: import("http").IncomingMessage \| import("http2").Http2ServerRequest, res: import("http").ServerResponse&lt;import("http").IncomingMessage&gt;, next: import("@builder.io/qwik-city/middleware/node").NodeRequestNextFunction) =&gt; Promise&lt;void&gt;; staticFile: (req: import("http").IncomingMessage \| import("http2").Http2ServerRequest, res: import("http").ServerResponse&lt;import("http").IncomingMessage&gt;, next: (e?: any) =&gt; void) =&gt; Promise&lt;void&gt;; notFound: (req: import("http").IncomingMessage \| import("http2").Http2ServerRequest, res: import("http").ServerResponse&lt;import("http").IncomingMessage&gt;, next: (e: any) =&gt; void) =&gt; Promise&lt;void&gt;; handle: (req: any, res: any) =&gt; void; }
+
+[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/aws-lambda/index.ts)
+
+## PlatformAwsLambda
+
+```typescript
+export interface PlatformAwsLambda extends Object
+```
+
+**Extends:** Object
+
+[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/aws-lambda/index.ts)
+
+## QwikCityAwsLambdaOptions
+
+```typescript
+export interface QwikCityAwsLambdaOptions extends ServerRenderOptions
+```
+
+**Extends:** ServerRenderOptions
+
+[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/aws-lambda/index.ts)

packages/qwik-city/middleware/aws-lambda/api-extractor.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "extends": "../../api-extractor.json",
+  "mainEntryPointFilePath": "<projectFolder>/dist-dev/dts-out/packages/qwik-city/middleware/aws-lambda/index.d.ts",
+  "apiReport": {
+    "enabled": true,
+    "reportFileName": "api.md",
+    "reportFolder": "<projectFolder>/packages/qwik-city/middleware/aws-lambda/",
+    "reportTempFolder": "<projectFolder>/dist-dev/api-extractor/qwik-city/middleware/aws-lambda"
+  },
+  "dtsRollup": {
+    "enabled": true,
+    "untrimmedFilePath": "<projectFolder>/packages/qwik-city/lib/middleware/aws-lambda/index.d.ts"
+  },
+  "docModel": {
+    "enabled": true,
+    "apiJsonFilePath": "<projectFolder>/dist-dev/api/qwik-city/middleware/aws-lambda/docs.api.json"
+  }
+}

packages/qwik-city/middleware/aws-lambda/api.md

@@ -0,0 +1,45 @@
+## API Report File for "@builder.io/qwik-city"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+/// <reference types="node" />
+
+import type { EnvGetter } from '@builder.io/qwik-city/middleware/request-handler';
+import { Http2ServerRequest } from 'http2';
+import { IncomingMessage } from 'http';
+import { NodeRequestNextFunction } from '@builder.io/qwik-city/middleware/node';
+import type { QwikIntrinsicElements } from '@builder.io/qwik';
+import type { QwikManifest } from '@builder.io/qwik/optimizer';
+import type { RequestHandler } from '@builder.io/qwik-city/middleware/request-handler';
+import type { ResolvedManifest } from '@builder.io/qwik/optimizer';
+import type { ResolveSyncValue } from '@builder.io/qwik-city/middleware/request-handler';
+import type { ServerRenderOptions } from '@builder.io/qwik-city/middleware/request-handler';
+import { ServerResponse } from 'http';
+import type { SnapshotResult } from '@builder.io/qwik';
+import type { StreamWriter } from '@builder.io/qwik';
+import type { SymbolMapperFn } from '@builder.io/qwik/optimizer';
+
+// Warning: (ae-forgotten-export) The symbol "AwsOpt" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export function createQwikCity(opts: AwsOpt): {
+    fixPath: (pathT: string) => string;
+    router: (req: IncomingMessage | Http2ServerRequest, res: ServerResponse<IncomingMessage>, next: NodeRequestNextFunction) => Promise<void>;
+    staticFile: (req: IncomingMessage | Http2ServerRequest, res: ServerResponse<IncomingMessage>, next: (e?: any) => void) => Promise<void>;
+    notFound: (req: IncomingMessage | Http2ServerRequest, res: ServerResponse<IncomingMessage>, next: (e: any) => void) => Promise<void>;
+    handle: (req: any, res: any) => void;
+};
+
+// @public (undocumented)
+export interface PlatformAwsLambda extends Object {
+}
+
+// @public (undocumented)
+export interface QwikCityAwsLambdaOptions extends ServerRenderOptions {
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

packages/qwik-city/middleware/aws-lambda/index.ts

@@ -0,0 +1,62 @@
+import { createQwikCity as createQwikCityNode } from '@builder.io/qwik-city/middleware/node';
+import type { ServerRenderOptions } from '@builder.io/qwik-city/middleware/request-handler';
+import type { QwikCityPlan } from 'packages/qwik-city/runtime/src/types';
+import type { QwikManifest, Render } from 'packages/qwik/src/server/types';
+
+interface AwsOpt {
+  render: Render;
+  manifest: QwikManifest;
+  qwikCityPlan: QwikCityPlan;
+}
+
+/** @public */
+export function createQwikCity(opts: AwsOpt) {
+  try {
+    const { router, staticFile, notFound } = createQwikCityNode({
+      render: opts.render,
+      qwikCityPlan: opts.qwikCityPlan,
+      manifest: opts.manifest,
+      static: {
+        cacheControl: 'public, max-age=31557600',
+      },
+      getOrigin(req) {
+        if (process.env.IS_OFFLINE) {
+          return `http://${req.headers.host}`;
+        }
+        return null;
+      },
+    });
+
+    const fixPath = (pathT: string) => {
+      if (opts.qwikCityPlan.trailingSlash) {
+        const url = new URL(pathT, 'http://aws-qwik.local');
+        if (url.pathname.includes('.', url.pathname.lastIndexOf('/'))) {
+          return pathT;
+        }
+        if (!url.pathname.endsWith('/')) {
+          return url.pathname + '/' + url.search;
+        }
+      }
+      return pathT;
+    };
+
+    const handle = (req: any, res: any) => {
+      req.url = fixPath(req.url);
+      staticFile(req, res, () => {
+        router(req, res, () => {
+          notFound(req, res, () => {});
+        });
+      });
+    };
+
+    return { fixPath, router, staticFile, notFound, handle };
+  } catch (err: any) {
+    throw new Error(err.message);
+  }
+}
+
+/** @public */
+export interface QwikCityAwsLambdaOptions extends ServerRenderOptions {}
+
+/** @public */
+export interface PlatformAwsLambda extends Object {}

packages/qwik-city/package.json

@@ -95,6 +95,9 @@
     "./middleware/azure-swa": {
       "import": "./lib/middleware/azure-swa/index.mjs"
     },
+    "./middleware/aws-lambda": {
+      "import": "./lib/middleware/aws-lambda/index.mjs"
+    },
     "./middleware/cloudflare-pages": {
       "import": "./lib/middleware/cloudflare-pages/index.mjs"
     },