@react-router/cloudflare 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 Cloudflare
+
+Cloudflare platform abstractions for [React Router.](https://reactrouter.com)
+
+```bash
+npm install @react-router/cloudflare @cloudflare/workers-types
+```

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { createWorkersKVSessionStorage } from "./sessions/workersKVStorage";
+export type { createPagesFunctionHandlerParams, GetLoadContextFunction, RequestHandler, } from "./worker";
+export { createPagesFunctionHandler, createRequestHandler } from "./worker";

package/dist/index.js

@@ -0,0 +1,22 @@
+/**
+ * @react-router/cloudflare 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 workersKVStorage = require('./sessions/workersKVStorage.js');
+var worker = require('./worker.js');
+
+
+
+exports.createWorkersKVSessionStorage = workersKVStorage.createWorkersKVSessionStorage;
+exports.createPagesFunctionHandler = worker.createPagesFunctionHandler;
+exports.createRequestHandler = worker.createRequestHandler;

package/dist/sessions/workersKVStorage.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="@cloudflare/workers-types" />
+import type { SessionStorage, SessionIdStorageStrategy, SessionData } from "react-router";
+interface WorkersKVSessionStorageOptions {
+    /**
+     * The Cookie used to store the session id on the client, or options used
+     * to automatically create one.
+     */
+    cookie?: SessionIdStorageStrategy["cookie"];
+    /**
+     * The KVNamespace used to store the sessions.
+     */
+    kv: KVNamespace;
+}
+/**
+ * Creates a SessionStorage that stores session data in the Clouldflare KV Store.
+ *
+ * The advantage of using this instead of cookie session storage is that
+ * KV Store may contain much more data than cookies.
+ */
+export declare function createWorkersKVSessionStorage<Data = SessionData, FlashData = Data>({ cookie, kv, }: WorkersKVSessionStorageOptions): SessionStorage<Data, FlashData>;
+export {};

package/dist/sessions/workersKVStorage.js

@@ -0,0 +1,64 @@
+/**
+ * @react-router/cloudflare 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');
+
+/**
+ * Creates a SessionStorage that stores session data in the Clouldflare KV Store.
+ *
+ * The advantage of using this instead of cookie session storage is that
+ * KV Store may contain much more data than cookies.
+ */
+function createWorkersKVSessionStorage({
+  cookie,
+  kv
+}) {
+  return reactRouter.createSessionStorage({
+    cookie,
+    async createData(data, expires) {
+      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 kv.get(id, "json")) {
+          continue;
+        }
+        await kv.put(id, JSON.stringify(data), {
+          expiration: expires ? Math.round(expires.getTime() / 1000) : undefined
+        });
+        return id;
+      }
+    },
+    async readData(id) {
+      let session = await kv.get(id);
+      if (!session) {
+        return null;
+      }
+      return JSON.parse(session);
+    },
+    async updateData(id, data, expires) {
+      await kv.put(id, JSON.stringify(data), {
+        expiration: expires ? Math.round(expires.getTime() / 1000) : undefined
+      });
+    },
+    async deleteData(id) {
+      await kv.delete(id);
+    }
+  });
+}
+
+exports.createWorkersKVSessionStorage = createWorkersKVSessionStorage;

package/dist/worker.d.ts

@@ -0,0 +1,30 @@
+import type { AppLoadContext, ServerBuild } from "react-router";
+import { type CacheStorage } from "@cloudflare/workers-types";
+/**
+ * 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<Env = unknown, Params extends string = any, Data extends Record<string, unknown> = Record<string, unknown>> = (args: {
+    request: Request;
+    context: {
+        cloudflare: EventContext<Env, Params, Data> & {
+            cf: EventContext<Env, Params, Data>["request"]["cf"];
+            ctx: {
+                waitUntil: EventContext<Env, Params, Data>["waitUntil"];
+                passThroughOnException: EventContext<Env, Params, Data>["passThroughOnException"];
+            };
+            caches: CacheStorage;
+        };
+    };
+}) => AppLoadContext | Promise<AppLoadContext>;
+export type RequestHandler<Env = any> = PagesFunction<Env>;
+export interface createPagesFunctionHandlerParams<Env = any> {
+    build: ServerBuild | (() => ServerBuild | Promise<ServerBuild>);
+    getLoadContext?: GetLoadContextFunction<Env>;
+    mode?: string;
+}
+export declare function createRequestHandler<Env = any>({ build, mode, getLoadContext, }: createPagesFunctionHandlerParams<Env>): RequestHandler<Env>;
+export declare function createPagesFunctionHandler<Env = any>({ build, getLoadContext, mode, }: createPagesFunctionHandlerParams<Env>): (context: EventContext<Env, any, any>) => Promise<Response>;

package/dist/worker.js

@@ -0,0 +1,90 @@
+/**
+ * @react-router/cloudflare 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');
+
+function createRequestHandler({
+  build,
+  mode,
+  getLoadContext = ({
+    context
+  }) => ({
+    ...context,
+    cloudflare: {
+      ...context.cloudflare,
+      cf: context.cloudflare.request.cf
+    }
+  })
+}) {
+  let handleRequest = reactRouter.createRequestHandler(build, mode);
+  return async cloudflare => {
+    let loadContext = await getLoadContext({
+      request: cloudflare.request,
+      context: {
+        cloudflare: {
+          ...cloudflare,
+          cf: cloudflare.request.cf,
+          ctx: {
+            waitUntil: cloudflare.waitUntil.bind(cloudflare),
+            passThroughOnException: cloudflare.passThroughOnException.bind(cloudflare)
+          },
+          caches
+        }
+      }
+    });
+    return handleRequest(cloudflare.request, loadContext);
+  };
+}
+function createPagesFunctionHandler({
+  build,
+  getLoadContext,
+  mode
+}) {
+  let handleRequest = createRequestHandler({
+    build,
+    getLoadContext,
+    mode
+  });
+  let handleFetch = async context => {
+    let response;
+    // https://github.com/cloudflare/wrangler2/issues/117
+    context.request.headers.delete("if-none-match");
+    try {
+      response = await context.env.ASSETS.fetch(context.request.url, context.request.clone());
+      response = response && response.status >= 200 && response.status < 400 ? new Response(response.body, response) : undefined;
+    } catch {}
+    if (!response) {
+      response = await handleRequest(context);
+    }
+    return response;
+  };
+  return async context => {
+    try {
+      return await handleFetch(context);
+    } catch (error) {
+      if (process.env.NODE_ENV === "development" && error instanceof Error) {
+        console.error(error);
+        return new Response(error.message || error.toString(), {
+          status: 500
+        });
+      }
+      return new Response("Internal Error", {
+        status: 500
+      });
+    }
+  };
+}
+
+exports.createPagesFunctionHandler = createPagesFunctionHandler;
+exports.createRequestHandler = createRequestHandler;

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@react-router/cloudflare",
+  "version": "0.0.0-nightly-a5f191b5e-20240820",
+  "description": "Cloudflare platform abstractions 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-cloudflare"
+  },
+  "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"
+  },
+  "devDependencies": {
+    "@cloudflare/workers-types": "^4.20230518.0",
+    "typescript": "^5.1.0",
+    "react-router": "0.0.0-nightly-a5f191b5e-20240820"
+  },
+  "peerDependencies": {
+    "@cloudflare/workers-types": "^4.0.0",
+    "typescript": "^5.1.0",
+    "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": {
+    "build": "rollup -c",
+    "tsc": "tsc"
+  }
+}