@react-router/architect 0.0.0-nightly-a5f191b5e-20240820

package/LICENSE.md

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) React Training LLC 2015-2019
+Copyright (c) Remix Software Inc. 2020-2021
+Copyright (c) Shopify Inc. 2022-2023
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,7 @@
+# React Router Architect
+
+Architect server request handler for React Router.
+
+```bash
+npm install @react-router/architect
+```

package/dist/__tests__/binaryTypes-test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/server-test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/setup.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/binaryTypes.d.ts

@@ -0,0 +1 @@
+export declare function isBinaryType(contentType: string | null | undefined): boolean;

package/dist/binaryTypes.js

@@ -0,0 +1,38 @@
+/**
+ * @react-router/architect v0.0.0-nightly-a5f191b5e-20240820
+ *
+ * Copyright (c) Remix Software Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE.md file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * Common binary MIME types
+ * @see https://github.com/architect/functions/blob/45254fc1936a1794c185aac07e9889b241a2e5c6/src/http/helpers/binary-types.js
+ */
+const binaryTypes = ["application/octet-stream",
+// Docs
+"application/epub+zip", "application/msword", "application/pdf", "application/rtf", "application/vnd.amazon.ebook", "application/vnd.ms-excel", "application/vnd.ms-powerpoint", "application/vnd.openxmlformats-officedocument.presentationml.presentation", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+// Fonts
+"font/otf", "font/woff", "font/woff2",
+// Images
+"image/avif", "image/bmp", "image/gif", "image/jpeg", "image/png", "image/tiff", "image/vnd.microsoft.icon", "image/webp",
+// Audio
+"audio/3gpp", "audio/aac", "audio/basic", "audio/mpeg", "audio/ogg", "audio/wav", "audio/webm", "audio/x-aiff", "audio/x-midi", "audio/x-wav",
+// Video
+"video/3gpp", "video/mp2t", "video/mpeg", "video/ogg", "video/quicktime", "video/webm", "video/x-msvideo",
+// Archives
+"application/java-archive", "application/vnd.apple.installer+xml", "application/x-7z-compressed", "application/x-apple-diskimage", "application/x-bzip", "application/x-bzip2", "application/x-gzip", "application/x-java-archive", "application/x-rar-compressed", "application/x-tar", "application/x-zip", "application/zip"];
+function isBinaryType(contentType) {
+  if (!contentType) return false;
+  let [test] = contentType.split(";");
+  return binaryTypes.includes(test);
+}
+
+exports.isBinaryType = isBinaryType;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { createArcTableSessionStorage } from "./sessions/arcTableSessionStorage";
+export type { GetLoadContextFunction, RequestHandler } from "./server";
+export { createRequestHandler } from "./server";

package/dist/index.js

@@ -0,0 +1,21 @@
+/**
+ * @react-router/architect v0.0.0-nightly-a5f191b5e-20240820
+ *
+ * Copyright (c) Remix Software Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE.md file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var arcTableSessionStorage = require('./sessions/arcTableSessionStorage.js');
+var server = require('./server.js');
+
+
+
+exports.createArcTableSessionStorage = arcTableSessionStorage.createArcTableSessionStorage;
+exports.createRequestHandler = server.createRequestHandler;

package/dist/server.d.ts

@@ -0,0 +1,23 @@
+import type { AppLoadContext, ServerBuild } from "react-router";
+import type { APIGatewayProxyEventHeaders, APIGatewayProxyEventV2, APIGatewayProxyHandlerV2, APIGatewayProxyStructuredResultV2 } from "aws-lambda";
+/**
+ * A function that returns the value to use as `context` in route `loader` and
+ * `action` functions.
+ *
+ * You can think of this as an escape hatch that allows you to pass
+ * environment/platform-specific values through to your loader/action.
+ */
+export type GetLoadContextFunction = (event: APIGatewayProxyEventV2) => Promise<AppLoadContext> | AppLoadContext;
+export type RequestHandler = APIGatewayProxyHandlerV2;
+/**
+ * Returns a request handler for Architect that serves the response using
+ * React Router.
+ */
+export declare function createRequestHandler({ build, getLoadContext, mode, }: {
+    build: ServerBuild;
+    getLoadContext?: GetLoadContextFunction;
+    mode?: string;
+}): RequestHandler;
+export declare function createReactRouterRequest(event: APIGatewayProxyEventV2): Request;
+export declare function createReactRouterHeaders(requestHeaders: APIGatewayProxyEventHeaders, requestCookies?: string[]): Headers;
+export declare function sendReactRouterResponse(nodeResponse: Response): Promise<APIGatewayProxyStructuredResultV2>;

package/dist/server.js

@@ -0,0 +1,97 @@
+/**
+ * @react-router/architect v0.0.0-nightly-a5f191b5e-20240820
+ *
+ * Copyright (c) Remix Software Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE.md file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var reactRouter = require('react-router');
+var node = require('@react-router/node');
+var binaryTypes = require('./binaryTypes.js');
+
+/**
+ * Returns a request handler for Architect that serves the response using
+ * React Router.
+ */
+function createRequestHandler({
+  build,
+  getLoadContext,
+  mode = process.env.NODE_ENV
+}) {
+  let handleRequest = reactRouter.createRequestHandler(build, mode);
+  return async event => {
+    let request = createReactRouterRequest(event);
+    let loadContext = await getLoadContext?.(event);
+    let response = await handleRequest(request, loadContext);
+    return sendReactRouterResponse(response);
+  };
+}
+function createReactRouterRequest(event) {
+  let host = event.headers["x-forwarded-host"] || event.headers.host;
+  let search = event.rawQueryString.length ? `?${event.rawQueryString}` : "";
+  let scheme = process.env.ARC_SANDBOX ? "http" : "https";
+  let url = new URL(`${scheme}://${host}${event.rawPath}${search}`);
+  let isFormData = event.headers["content-type"]?.includes("multipart/form-data");
+  // Note: No current way to abort these for Architect, but our router expects
+  // requests to contain a signal, so it can detect aborted requests
+  let controller = new AbortController();
+  return new Request(url.href, {
+    method: event.requestContext.http.method,
+    headers: createReactRouterHeaders(event.headers, event.cookies),
+    signal: controller.signal,
+    body: event.body && event.isBase64Encoded ? isFormData ? Buffer.from(event.body, "base64") : Buffer.from(event.body, "base64").toString() : event.body
+  });
+}
+function createReactRouterHeaders(requestHeaders, requestCookies) {
+  let headers = new Headers();
+  for (let [header, value] of Object.entries(requestHeaders)) {
+    if (value) {
+      headers.append(header, value);
+    }
+  }
+  if (requestCookies) {
+    headers.append("Cookie", requestCookies.join("; "));
+  }
+  return headers;
+}
+async function sendReactRouterResponse(nodeResponse) {
+  let cookies = [];
+  // Arc/AWS API Gateway will send back set-cookies outside of response headers.
+  for (let [key, value] of nodeResponse.headers.entries()) {
+    if (key.toLowerCase() === "set-cookie") {
+      cookies.push(value);
+    }
+  }
+  if (cookies.length) {
+    nodeResponse.headers.delete("Set-Cookie");
+  }
+  let contentType = nodeResponse.headers.get("Content-Type");
+  let isBase64Encoded = binaryTypes.isBinaryType(contentType);
+  let body;
+  if (nodeResponse.body) {
+    if (isBase64Encoded) {
+      body = await node.readableStreamToString(nodeResponse.body, "base64");
+    } else {
+      body = await nodeResponse.text();
+    }
+  }
+  return {
+    statusCode: nodeResponse.status,
+    headers: Object.fromEntries(nodeResponse.headers.entries()),
+    cookies,
+    body,
+    isBase64Encoded
+  };
+}
+
+exports.createReactRouterHeaders = createReactRouterHeaders;
+exports.createReactRouterRequest = createReactRouterRequest;
+exports.createRequestHandler = createRequestHandler;
+exports.sendReactRouterResponse = sendReactRouterResponse;

package/dist/sessions/arcTableSessionStorage.d.ts

@@ -0,0 +1,36 @@
+import type { SessionData, SessionStorage, SessionIdStorageStrategy } from "react-router";
+import type { ArcTable } from "@architect/functions/types/tables";
+interface ArcTableSessionStorageOptions {
+    /**
+     * The Cookie used to store the session id on the client, or options used
+     * to automatically create one.
+     */
+    cookie?: SessionIdStorageStrategy["cookie"];
+    /**
+     * The table used to store sessions, or its name as it appears in your
+     * project's app.arc file.
+     */
+    table: ArcTable<SessionData> | string;
+    /**
+     * The name of the DynamoDB attribute used to store the session ID.
+     * This should be the table's partition key.
+     */
+    idx: string;
+    /**
+     * The name of the DynamoDB attribute used to store the expiration time.
+     * If absent, then no TTL will be stored and session records will not expire.
+     */
+    ttl?: string;
+}
+/**
+ * Session storage using a DynamoDB table managed by Architect.
+ *
+ * Add the following lines to your project's `app.arc` file:
+ *
+ *   @tables
+ *   arc-sessions
+ *     _idx *String
+ *     _ttl TTL
+ */
+export declare function createArcTableSessionStorage<Data = SessionData, FlashData = Data>({ cookie, ...props }: ArcTableSessionStorageOptions): SessionStorage<Data, FlashData>;
+export {};

package/dist/sessions/arcTableSessionStorage.js

@@ -0,0 +1,102 @@
+/**
+ * @react-router/architect v0.0.0-nightly-a5f191b5e-20240820
+ *
+ * Copyright (c) Remix Software Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE.md file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var reactRouter = require('react-router');
+var arc = require('@architect/functions');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var arc__default = /*#__PURE__*/_interopDefaultLegacy(arc);
+
+/**
+ * Session storage using a DynamoDB table managed by Architect.
+ *
+ * Add the following lines to your project's `app.arc` file:
+ *
+ *   @tables
+ *   arc-sessions
+ *     _idx *String
+ *     _ttl TTL
+ */
+function createArcTableSessionStorage({
+  cookie,
+  ...props
+}) {
+  async function getTable() {
+    if (typeof props.table === "string") {
+      let tables = await arc__default["default"].tables();
+      return tables[props.table];
+    } else {
+      return props.table;
+    }
+  }
+  return reactRouter.createSessionStorage({
+    cookie,
+    async createData(data, expires) {
+      let table = await getTable();
+      while (true) {
+        let randomBytes = crypto.getRandomValues(new Uint8Array(8));
+        // This storage manages an id space of 2^64 ids, which is far greater
+        // than the maximum number of files allowed on an NTFS or ext4 volume
+        // (2^32). However, the larger id space should help to avoid collisions
+        // with existing ids when creating new sessions, which speeds things up.
+        let id = [...randomBytes].map(x => x.toString(16).padStart(2, "0")).join("");
+        if (await table.get({
+          [props.idx]: id
+        })) {
+          continue;
+        }
+        let params = {
+          [props.idx]: id,
+          ...data
+        };
+        if (props.ttl) {
+          params[props.ttl] = expires ? Math.round(expires.getTime() / 1000) : undefined;
+        }
+        await table.put(params);
+        return id;
+      }
+    },
+    async readData(id) {
+      let table = await getTable();
+      let data = await table.get({
+        [props.idx]: id
+      });
+      if (data) {
+        delete data[props.idx];
+        if (props.ttl) delete data[props.ttl];
+      }
+      return data;
+    },
+    async updateData(id, data, expires) {
+      let table = await getTable();
+      let params = {
+        [props.idx]: id,
+        ...data
+      };
+      if (props.ttl) {
+        params[props.ttl] = expires ? Math.round(expires.getTime() / 1000) : undefined;
+      }
+      await table.put(params);
+    },
+    async deleteData(id) {
+      let table = await getTable();
+      await table.delete({
+        [props.idx]: id
+      });
+    }
+  });
+}
+
+exports.createArcTableSessionStorage = createArcTableSessionStorage;

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@react-router/architect",
+  "version": "0.0.0-nightly-a5f191b5e-20240820",
+  "description": "Architect server request handler for React Router",
+  "bugs": {
+    "url": "https://github.com/remix-run/react-router/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/remix-run/react-router",
+    "directory": "packages/react-router-architect"
+  },
+  "license": "MIT",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@architect/functions": "^5.2.0",
+    "@types/aws-lambda": "^8.10.82"
+  },
+  "devDependencies": {
+    "@types/lambda-tester": "^3.6.1",
+    "@types/node": "^18.17.1",
+    "lambda-tester": "^4.0.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "typescript": "^5.1.0",
+    "@react-router/node": "0.0.0-nightly-a5f191b5e-20240820",
+    "react-router": "0.0.0-nightly-a5f191b5e-20240820"
+  },
+  "peerDependencies": {
+    "typescript": "^5.1.0",
+    "@react-router/node": "^0.0.0-nightly-a5f191b5e-20240820",
+    "react-router": "^0.0.0-nightly-a5f191b5e-20240820"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "dist/",
+    "CHANGELOG.md",
+    "LICENSE.md",
+    "README.md"
+  ],
+  "scripts": {
+    "tsc": "tsc"
+  }
+}