@remix-run/cloudflare 1.3.3-pre.0

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2021 Remix Software 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/crypto.js

@@ -0,0 +1,53 @@
+/**
+ * @remix-run/cloudflare v1.3.3-pre.0
+ *
+ * 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 });
+
+const encoder = new TextEncoder();
+const sign = async (value, secret) => {
+  let key = await createKey(secret, ["sign"]);
+  let data = encoder.encode(value);
+  let signature = await crypto.subtle.sign("HMAC", key, data);
+  let hash = btoa(String.fromCharCode(...new Uint8Array(signature))).replace(/=+$/, "");
+  return value + "." + hash;
+};
+const unsign = async (signed, secret) => {
+  let index = signed.lastIndexOf(".");
+  let value = signed.slice(0, index);
+  let hash = signed.slice(index + 1);
+  let key = await createKey(secret, ["verify"]);
+  let data = encoder.encode(value);
+  let signature = byteStringToUint8Array(atob(hash));
+  let valid = await crypto.subtle.verify("HMAC", key, signature, data);
+  return valid ? value : false;
+};
+
+async function createKey(secret, usages) {
+  let key = await crypto.subtle.importKey("raw", encoder.encode(secret), {
+    name: "HMAC",
+    hash: "SHA-256"
+  }, false, usages);
+  return key;
+}
+
+function byteStringToUint8Array(byteString) {
+  let array = new Uint8Array(byteString.length);
+
+  for (let i = 0; i < byteString.length; i++) {
+    array[i] = byteString.charCodeAt(i);
+  }
+
+  return array;
+}
+
+exports.sign = sign;
+exports.unsign = unsign;

package/implementations.js

@@ -0,0 +1,29 @@
+/**
+ * @remix-run/cloudflare v1.3.3-pre.0
+ *
+ * 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 serverRuntime = require('@remix-run/server-runtime');
+var crypto = require('./crypto.js');
+
+const createCookie = serverRuntime.createCookieFactory({
+  sign: crypto.sign,
+  unsign: crypto.unsign
+});
+const createCookieSessionStorage = serverRuntime.createCookieSessionStorageFactory(createCookie);
+const createSessionStorage = serverRuntime.createSessionStorageFactory(createCookie);
+const createMemorySessionStorage = serverRuntime.createMemorySessionStorageFactory(createSessionStorage);
+
+exports.createCookie = createCookie;
+exports.createCookieSessionStorage = createCookieSessionStorage;
+exports.createMemorySessionStorage = createMemorySessionStorage;
+exports.createSessionStorage = createSessionStorage;

package/index.js

@@ -0,0 +1,49 @@
+/**
+ * @remix-run/cloudflare v1.3.3-pre.0
+ *
+ * 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 cloudflareKVSessionStorage = require('./sessions/cloudflareKVSessionStorage.js');
+var implementations = require('./implementations.js');
+var serverRuntime = require('@remix-run/server-runtime');
+
+
+
+exports.createCloudflareKVSessionStorage = cloudflareKVSessionStorage.createCloudflareKVSessionStorage;
+exports.createCookie = implementations.createCookie;
+exports.createCookieSessionStorage = implementations.createCookieSessionStorage;
+exports.createMemorySessionStorage = implementations.createMemorySessionStorage;
+exports.createSessionStorage = implementations.createSessionStorage;
+Object.defineProperty(exports, 'createRequestHandler', {
+  enumerable: true,
+  get: function () { return serverRuntime.createRequestHandler; }
+});
+Object.defineProperty(exports, 'createSession', {
+  enumerable: true,
+  get: function () { return serverRuntime.createSession; }
+});
+Object.defineProperty(exports, 'isCookie', {
+  enumerable: true,
+  get: function () { return serverRuntime.isCookie; }
+});
+Object.defineProperty(exports, 'isSession', {
+  enumerable: true,
+  get: function () { return serverRuntime.isSession; }
+});
+Object.defineProperty(exports, 'json', {
+  enumerable: true,
+  get: function () { return serverRuntime.json; }
+});
+Object.defineProperty(exports, 'redirect', {
+  enumerable: true,
+  get: function () { return serverRuntime.redirect; }
+});

package/magicExports/esm/remix.js

@@ -0,0 +1,11 @@
+/**
+ * @remix-run/cloudflare v1.3.3-pre.0
+ *
+ * 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
+ */
+export { createCloudflareKVSessionStorage, createCookie, createCookieSessionStorage, createMemorySessionStorage, createSessionStorage } from '@remix-run/cloudflare';

package/magicExports/remix.js

@@ -0,0 +1,38 @@
+/**
+ * @remix-run/cloudflare v1.3.3-pre.0
+ *
+ * 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 cloudflare = require('@remix-run/cloudflare');
+
+
+
+Object.defineProperty(exports, 'createCloudflareKVSessionStorage', {
+  enumerable: true,
+  get: function () { return cloudflare.createCloudflareKVSessionStorage; }
+});
+Object.defineProperty(exports, 'createCookie', {
+  enumerable: true,
+  get: function () { return cloudflare.createCookie; }
+});
+Object.defineProperty(exports, 'createCookieSessionStorage', {
+  enumerable: true,
+  get: function () { return cloudflare.createCookieSessionStorage; }
+});
+Object.defineProperty(exports, 'createMemorySessionStorage', {
+  enumerable: true,
+  get: function () { return cloudflare.createMemorySessionStorage; }
+});
+Object.defineProperty(exports, 'createSessionStorage', {
+  enumerable: true,
+  get: function () { return cloudflare.createSessionStorage; }
+});

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@remix-run/cloudflare",
+  "description": "Cloudflare platform abstractions for Remix",
+  "version": "1.3.3-pre.0",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/remix-run/remix",
+    "directory": "packages/remix-cloudflare"
+  },
+  "bugs": {
+    "url": "https://github.com/remix-run/remix/issues"
+  },
+  "dependencies": {
+    "@cloudflare/kv-asset-handler": "^0.1.3",
+    "@remix-run/server-runtime": "1.3.3-pre.0"
+  },
+  "peerDependencies": {
+    "@cloudflare/workers-types": "^2.2.2"
+  },
+  "devDependencies": {
+    "@cloudflare/workers-types": "^2.2.2"
+  }
+}

package/sessions/cloudflareKVSessionStorage.js

@@ -0,0 +1,74 @@
+/**
+ * @remix-run/cloudflare v1.3.3-pre.0
+ *
+ * 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 implementations = require('../implementations.js');
+
+/**
+ * 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 createCloudflareKVSessionStorage({
+  cookie,
+  kv
+}) {
+  return implementations.createSessionStorage({
+    cookie,
+
+    async createData(data, expires) {
+      while (true) {
+        let randomBytes = new Uint8Array(8);
+        crypto.getRandomValues(randomBytes); // 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.createCloudflareKVSessionStorage = createCloudflareKVSessionStorage;