@fastly/remix-server-adapter 0.1.5

package/LICENSE

@@ -0,0 +1,27 @@
+@fastly/remix-server-adapter is licensed for use as follows:
+
+"""
+MIT License
+
+Copyright (c) 2022 Fastly, Inc.
+
+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,61 @@
+# Remix Adapter for Fastly Compute@Edge
+
+An adapter that allows the Compute@Edge JavaScript entry point program to start Remix.
+This adapter package we have created is designed to be used with Fastly Compute@Edge alongside
+[`@fastly/compute-js-static-publish`](https://github.com/fastly/compute-js-static-publish).
+
+(`@fastly/compute-js-static-publish` is set up automatically for you if you set up your Remix
+project using [`remix-template`](/packages/remix-template).)
+
+## Usage
+
+The simplest usage is the `createEventHandler` function, which simply needs to be passed the
+`staticAssets` object exported from `./statics`. This file is generated automatically by
+`@fastly/compute-js-static-publish`.
+
+```js
+/// <reference types="@fastly/js-compute" />  
+import { createEventHandler } from '@fastly/remix-server-adapter';  
+import { staticAssets } from './statics';  
+  
+addEventListener("fetch", createEventHandler({ staticAssets }));
+```
+
+If you need more granular control over the `ServerBuild` module to use with Remix, or whether to handle static assets,
+you may use the lower-level `createEventHandler` and `handleAsset` functions:
+
+```js
+/// <reference types="@fastly/js-compute" />  
+import { createRequestHandler, handleAsset } from '@fastly/remix-server-adapter';  
+import { staticAssets } from './statics';
+
+/** @type {import('@remix-run/server-runtime').ServerBuild} */  
+const build = staticAssets.getAsset('/build/index.js').module;  
+const requestHandler = createRequestHandler({build});  
+ 
+addEventListener("fetch", (event) => event.respondWith(handleRequest(event)));  
+async function handleRequest(event) {  
+  let response = await handleAsset(event, staticAssets);  
+ 
+  if (!response) {  
+    response = requestHandler(event);  
+  }  
+ 
+  return response;  
+}
+```
+
+## Issues
+
+If you encounter any non-security-related bug or unexpected behavior, please [file an issue][bug]
+using the bug report template.
+
+[bug]: https://github.com/fastly/remix-compute-js/issues/new?labels=bug
+
+### Security issues
+
+Please see our [SECURITY.md](./SECURITY.md) for guidance on reporting security-related issues.
+
+## License
+
+[MIT](./LICENSE).

package/SECURITY.md

@@ -0,0 +1,13 @@
+## Report a security issue
+
+The project team welcomes security reports and is committed to providing prompt attention to security issues. Security
+issues should be reported privately via [Fastly’s security issue reporting process](https://www.fastly.com/security/report-security-issue).
+
+## Security advisories
+
+Remediation of security vulnerabilities is prioritized by the project team. The project team endeavors to coordinate
+remediation with third-party stakeholders, and is committed to transparency in the disclosure process. The team announces
+security issues via [GitHub](https://github.com/fastly/remix-compute-js/releases) on a best-effort basis.
+
+Note that communications related to security issues in Fastly-maintained OSS as described here are distinct from
+[Fastly Security Advisories](https://www.fastly.com/security-advisories).

package/build/src/implementation.d.ts

@@ -0,0 +1,40 @@
+/// <reference types="@fastly/js-compute" />
+import type { StaticAssets } from "@fastly/compute-js-static-publish";
+import type { AppLoadContext, ServerBuild } from "@fastly/remix-server-runtime";
+/**
+ * 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: FetchEvent) => AppLoadContext;
+export type RequestHandler = ReturnType<typeof createRequestHandler>;
+/**
+ * Generates a Response that would serve a static asset corresponding to the URL requested
+ * by the passed-in FetchEvent.
+ * @param event { FetchEvent }
+ * @param staticAssets { StaticAssets }
+ */
+export declare function handleAsset(event: FetchEvent, staticAssets: StaticAssets): Promise<Response | null>;
+/**
+ * Returns a request handler for the Fastly Compute@Edge runtime that serves the
+ * Remix SSR response.
+ */
+export declare function createRequestHandler({ build, getLoadContext, mode, }: {
+    build: ServerBuild;
+    getLoadContext?: GetLoadContextFunction;
+    mode?: string;
+}): (event: FetchEvent) => Promise<Response>;
+/**
+ * Creates a simplified event handler that can be used on Fastly Compute@Edge.
+ * @param staticAssets { StaticAssets }
+ * @param getLoadContext { GetLoadContextFunction }
+ * @param mode
+ */
+export declare function createEventHandler({ staticAssets, getLoadContext, mode, }: {
+    staticAssets: StaticAssets;
+    getLoadContext?: GetLoadContextFunction;
+    mode?: string;
+}): (event: FetchEvent) => void;
+//# sourceMappingURL=implementation.d.ts.map

package/build/src/implementation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"implementation.d.ts","sourceRoot":"","sources":["../../src/implementation.ts"],"names":[],"mappings":";AAKA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAEtE,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAGhF;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK,cAAc,CAAC;AAE3E,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAErE;;;;;GAKG;AACH,wBAAsB,WAAW,CAAC,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAEzG;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,EAClC,KAAK,EACL,cAAc,EACd,IAAI,GACN,EAAE;IACD,KAAK,EAAE,WAAW,CAAC;IACnB,cAAc,CAAC,EAAE,sBAAsB,CAAC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,WAGgB,UAAU,uBAgB1B;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,EACjC,YAAY,EACZ,cAAc,EACd,IAAI,GACL,EAAE;IACD,YAAY,EAAE,YAAY,CAAC;IAC3B,cAAc,CAAC,EAAE,sBAAsB,CAAC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,WAmBgB,UAAU,UAgB1B"}

package/build/src/implementation.js

@@ -0,0 +1,77 @@
+"use strict";
+/*
+ * Copyright Fastly, Inc.
+ * Licensed under the MIT license. See LICENSE file for details.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createEventHandler = exports.createRequestHandler = exports.handleAsset = void 0;
+const remix_server_runtime_1 = require("@fastly/remix-server-runtime");
+/**
+ * Generates a Response that would serve a static asset corresponding to the URL requested
+ * by the passed-in FetchEvent.
+ * @param event { FetchEvent }
+ * @param staticAssets { StaticAssets }
+ */
+async function handleAsset(event, staticAssets) {
+    return staticAssets.serveAssetForEvent(event, '/public');
+}
+exports.handleAsset = handleAsset;
+/**
+ * Returns a request handler for the Fastly Compute@Edge runtime that serves the
+ * Remix SSR response.
+ */
+function createRequestHandler({ build, getLoadContext, mode, }) {
+    let handleRequest = (0, remix_server_runtime_1.createRequestHandler)(build, mode);
+    return (event) => {
+        let loadContext = getLoadContext?.(event);
+        // HACK: Until js-compute supports AbortSignal on Request
+        // we add a fake AbortSignal that doesn't actually abort
+        const request = event.request;
+        if (request.signal == null) {
+            request.signal = {
+                aborted: false,
+                addEventHandler: () => { },
+                removeEventHandler: () => { },
+            };
+        }
+        return handleRequest(request, loadContext);
+    };
+}
+exports.createRequestHandler = createRequestHandler;
+/**
+ * Creates a simplified event handler that can be used on Fastly Compute@Edge.
+ * @param staticAssets { StaticAssets }
+ * @param getLoadContext { GetLoadContextFunction }
+ * @param mode
+ */
+function createEventHandler({ staticAssets, getLoadContext, mode, }) {
+    const build = staticAssets.getAsset('/build/index.js').module;
+    let handleRequest = createRequestHandler({
+        build,
+        getLoadContext,
+        mode,
+    });
+    let handleEvent = async (event) => {
+        let response = await handleAsset(event, staticAssets);
+        if (!response) {
+            response = await handleRequest(event);
+        }
+        return response;
+    };
+    return (event) => {
+        try {
+            event.respondWith(handleEvent(event));
+        }
+        catch (e) {
+            if (process.env.NODE_ENV === "development") {
+                event.respondWith(new Response(e.message || e.toString(), {
+                    status: 500,
+                }));
+                return;
+            }
+            event.respondWith(new Response("Internal Error", { status: 500 }));
+        }
+    };
+}
+exports.createEventHandler = createEventHandler;
+//# sourceMappingURL=implementation.js.map

package/build/src/implementation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"implementation.js","sourceRoot":"","sources":["../../src/implementation.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH,uEAAiG;AAajG;;;;;GAKG;AACI,KAAK,UAAU,WAAW,CAAC,KAAiB,EAAE,YAA0B;IAC7E,OAAO,YAAY,CAAC,kBAAkB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AAC3D,CAAC;AAFD,kCAEC;AAED;;;GAGG;AACH,SAAgB,oBAAoB,CAAC,EAClC,KAAK,EACL,cAAc,EACd,IAAI,GAKN;IACC,IAAI,aAAa,GAAG,IAAA,2CAAyB,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAE3D,OAAO,CAAC,KAAiB,EAAE,EAAE;QAC3B,IAAI,WAAW,GAAG,cAAc,EAAE,CAAC,KAAK,CAAC,CAAC;QAE1C,yDAAyD;QACzD,wDAAwD;QACxD,MAAM,OAAO,GAAQ,KAAK,CAAC,OAAO,CAAC;QACnC,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE;YAC1B,OAAO,CAAC,MAAM,GAAG;gBACf,OAAO,EAAE,KAAK;gBACd,eAAe,EAAE,GAAG,EAAE,GAAE,CAAC;gBACzB,kBAAkB,EAAE,GAAG,EAAE,GAAE,CAAC;aAC7B,CAAC;SACH;QAED,OAAO,aAAa,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC7C,CAAC,CAAC;AACJ,CAAC;AA3BD,oDA2BC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,EACjC,YAAY,EACZ,cAAc,EACd,IAAI,GAKL;IACC,MAAM,KAAK,GAAG,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,MAAqB,CAAC;IAE7E,IAAI,aAAa,GAAG,oBAAoB,CAAC;QACvC,KAAK;QACL,cAAc;QACd,IAAI;KACL,CAAC,CAAC;IAEH,IAAI,WAAW,GAAG,KAAK,EAAE,KAAiB,EAAE,EAAE;QAC5C,IAAI,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QAEtD,IAAI,CAAC,QAAQ,EAAE;YACb,QAAQ,GAAG,MAAM,aAAa,CAAC,KAAK,CAAC,CAAC;SACvC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;IAEF,OAAO,CAAC,KAAiB,EAAE,EAAE;QAC3B,IAAI;YACF,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;SACvC;QAAC,OAAO,CAAM,EAAE;YACf,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,EAAE;gBAC1C,KAAK,CAAC,WAAW,CACf,IAAI,QAAQ,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;oBACtC,MAAM,EAAE,GAAG;iBACZ,CAAC,CACH,CAAC;gBACF,OAAO;aACR;YAED,KAAK,CAAC,WAAW,CAAC,IAAI,QAAQ,CAAC,gBAAgB,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;SACpE;IACH,CAAC,CAAC;AACJ,CAAC;AA3CD,gDA2CC","sourcesContent":["/*\n * Copyright Fastly, Inc.\n * Licensed under the MIT license. See LICENSE file for details.\n */\n\nimport type { StaticAssets } from \"@fastly/compute-js-static-publish\";\n\nimport type { AppLoadContext, ServerBuild } from \"@fastly/remix-server-runtime\";\nimport { createRequestHandler as createRemixRequestHandler } from \"@fastly/remix-server-runtime\";\n\n/**\n * A function that returns the value to use as `context` in route `loader` and\n * `action` functions.\n *\n * You can think of this as an escape hatch that allows you to pass\n * environment/platform-specific values through to your loader/action.\n */\nexport type GetLoadContextFunction = (event: FetchEvent) => AppLoadContext;\n\nexport type RequestHandler = ReturnType<typeof createRequestHandler>;\n\n/**\n * Generates a Response that would serve a static asset corresponding to the URL requested\n * by the passed-in FetchEvent.\n * @param event { FetchEvent }\n * @param staticAssets { StaticAssets }\n */\nexport async function handleAsset(event: FetchEvent, staticAssets: StaticAssets): Promise<Response | null> {\n  return staticAssets.serveAssetForEvent(event, '/public');\n}\n\n/**\n * Returns a request handler for the Fastly Compute@Edge runtime that serves the\n * Remix SSR response.\n */\nexport function createRequestHandler({\n   build,\n   getLoadContext,\n   mode,\n}: {\n  build: ServerBuild;\n  getLoadContext?: GetLoadContextFunction;\n  mode?: string;\n}) {\n  let handleRequest = createRemixRequestHandler(build, mode);\n\n  return (event: FetchEvent) => {\n    let loadContext = getLoadContext?.(event);\n\n    // HACK: Until js-compute supports AbortSignal on Request\n    // we add a fake AbortSignal that doesn't actually abort\n    const request: any = event.request;\n    if (request.signal == null) {\n      request.signal = {\n        aborted: false,\n        addEventHandler: () => {},\n        removeEventHandler: () => {},\n      };\n    }\n\n    return handleRequest(request, loadContext);\n  };\n}\n\n/**\n * Creates a simplified event handler that can be used on Fastly Compute@Edge.\n * @param staticAssets { StaticAssets }\n * @param getLoadContext { GetLoadContextFunction }\n * @param mode\n */\nexport function createEventHandler({\n  staticAssets,\n  getLoadContext,\n  mode,\n}: {\n  staticAssets: StaticAssets;\n  getLoadContext?: GetLoadContextFunction;\n  mode?: string;\n}) {\n  const build = staticAssets.getAsset('/build/index.js').module as ServerBuild;\n\n  let handleRequest = createRequestHandler({\n    build,\n    getLoadContext,\n    mode,\n  });\n\n  let handleEvent = async (event: FetchEvent) => {\n    let response = await handleAsset(event, staticAssets);\n\n    if (!response) {\n      response = await handleRequest(event);\n    }\n\n    return response;\n  };\n\n  return (event: FetchEvent) => {\n    try {\n      event.respondWith(handleEvent(event));\n    } catch (e: any) {\n      if (process.env.NODE_ENV === \"development\") {\n        event.respondWith(\n          new Response(e.message || e.toString(), {\n            status: 500,\n          })\n        );\n        return;\n      }\n\n      event.respondWith(new Response(\"Internal Error\", { status: 500 }));\n    }\n  };\n}\n"]}

package/build/src/index.d.ts

@@ -0,0 +1,3 @@
+export type { GetLoadContextFunction, RequestHandler } from "./implementation";
+export { createEventHandler, createRequestHandler, handleAsset, } from "./implementation";
+//# sourceMappingURL=index.d.ts.map

package/build/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAOA,YAAY,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,WAAW,GACZ,MAAM,kBAAkB,CAAC"}

package/build/src/index.js

@@ -0,0 +1,12 @@
+"use strict";
+/*
+ * Copyright Fastly, Inc.
+ * Licensed under the MIT license. See LICENSE file for details.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleAsset = exports.createRequestHandler = exports.createEventHandler = void 0;
+var implementation_1 = require("./implementation");
+Object.defineProperty(exports, "createEventHandler", { enumerable: true, get: function () { return implementation_1.createEventHandler; } });
+Object.defineProperty(exports, "createRequestHandler", { enumerable: true, get: function () { return implementation_1.createRequestHandler; } });
+Object.defineProperty(exports, "handleAsset", { enumerable: true, get: function () { return implementation_1.handleAsset; } });
+//# sourceMappingURL=index.js.map

package/build/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH,mDAI0B;AAHxB,oHAAA,kBAAkB,OAAA;AAClB,sHAAA,oBAAoB,OAAA;AACpB,6GAAA,WAAW,OAAA","sourcesContent":["/*\n * Copyright Fastly, Inc.\n * Licensed under the MIT license. See LICENSE file for details.\n */\n\n/// <reference types='@fastly/js-compute' />\n\nexport type { GetLoadContextFunction, RequestHandler } from \"./implementation\";\nexport {\n  createEventHandler,\n  createRequestHandler,\n  handleAsset,\n} from \"./implementation\";\n"]}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@fastly/remix-server-adapter",
+  "version": "0.1.5",
+  "license": "MIT",
+  "description": "Remix Adapter for Fastly Compute@Edge",
+  "types": "./build/src/index.d.ts",
+  "main": "./build/src/index.js",
+  "exports": {
+    ".": "./build/src/index.js"
+  },
+  "dependencies": {
+    "@fastly/compute-js-static-publish": "^2.3.1",
+    "@fastly/js-compute": "^0.5.12",
+    "@fastly/remix-server-runtime": "^0.1.5"
+  },
+  "scripts": {
+    "prepack": "npm run clean && npm run compile",
+    "compile": "tsc --build tsconfig.json",
+    "clean": "rm -rf build"
+  },
+  "files": [
+    "build/src/**/*.js",
+    "build/src/**/*.js.map",
+    "build/src/**/*.d.ts",
+    "build/src/**/*.d.ts.map",
+    "resources/**/*",
+    "LICENSE",
+    "README.md",
+    "SECURITY.md"
+  ]
+}