Add new session, kvSession and cookieSession middlewares

.eslintrc.js

@@ -25,6 +25,8 @@ module.exports = {
 
 		"prefer-let/prefer-let": 2,
 
+		"unicorn/prevent-abbreviations": "off",
+
 		"import/order": [
 			"error",
 			{

package.json

@@ -30,6 +30,18 @@
 			"types": "./build/cloudflare.d.ts",
 			"default": "./build/cloudflare.js"
 		},
+		"./cookie-session": {
+			"types": "./build/cookie-session.d.ts",
+			"default": "./build/cookie-session.js"
+		},
+		"./kv-session": {
+			"types": "./build/kv-session.d.ts",
+			"default": "./build/kv-session.js"
+		},
+		"./session": {
+			"types": "./build/session.d.ts",
+			"default": "./build/session.js"
+		},
 		"./package.json": "./package.json"
 	},
 	"scripts": {

src/cloudflare.ts

@@ -3,7 +3,7 @@ import type { Context, MiddlewareHandler, Env, Input } from "hono";
 
 import { createRequestHandler } from "@remix-run/cloudflare";
 
-export interface createPagesFunctionHandlerParameters<
+export interface RemixMiddlewareOptions<
 	E extends Env = Record<string, never>,
 	P extends string = "",
 	I extends Input = Record<string, never>,
@@ -23,7 +23,7 @@ export function remix<
 	mode,
 	build,
 	getLoadContext = (context) => context.env as unknown as AppLoadContext,
-}: createPagesFunctionHandlerParameters<E, P, I>): MiddlewareHandler {
+}: RemixMiddlewareOptions<E, P, I>): MiddlewareHandler {
 	return async function middleware(context) {
 		let requestHandler = createRequestHandler(build, mode);
 		let loadContext = getLoadContext(context);

src/middlewares/cookie-session.ts

@@ -0,0 +1,63 @@
+import {
+	CookieOptions,
+	SessionData,
+	createCookieSessionStorage,
+} from "@remix-run/cloudflare";
+import { Context, Hono, MiddlewareHandler } from "hono";
+
+import { session } from "./session";
+
+type GetSecretsFunction<Secret extends string> = (
+	context: Context<{ Bindings: BindingsObject<Secret> }>,
+) => string[];
+
+type BindingsObject<Secret extends string> = {
+	[K in Secret]: string;
+};
+
+export function kvSession<
+	SecretBinding extends string,
+	Data = SessionData,
+	FlashData = Data,
+>(options: {
+	autoCommit?: boolean;
+	cookie: Omit<CookieOptions, "secrets"> & {
+		name: string;
+		secrets: GetSecretsFunction<SecretBinding>;
+	};
+}): MiddlewareHandler {
+	return session<
+		{ Bindings: BindingsObject<SecretBinding> },
+		"",
+		Record<string, unknown>,
+		Data,
+		FlashData
+	>({
+		autoCommit: options.autoCommit,
+		createSessionStorage(context) {
+			let secrets = options.cookie.secrets(context);
+
+			if (secrets.length === 0) {
+				throw new ReferenceError("The secrets for the kvSession are not set.");
+			}
+
+			return createCookieSessionStorage<Data, FlashData>({
+				cookie: { ...options.cookie, secrets },
+			});
+		},
+	});
+}
+
+new Hono().use(
+	"*",
+	kvSession({
+		autoCommit: true,
+		cookie: {
+			name: "__session",
+			httpOnly: true,
+			secrets(context) {
+				return [context.env.SECRET];
+			},
+		},
+	}),
+);

src/middlewares/kv-session.ts

@@ -0,0 +1,70 @@
+import {
+	CookieOptions,
+	SessionData,
+	createWorkersKVSessionStorage,
+} from "@remix-run/cloudflare";
+import { Context, Hono, MiddlewareHandler } from "hono";
+
+import { session } from "./session";
+
+type GetSecretsFunction<KV extends string, Secret extends string> = (
+	context: Context<{ Bindings: BindingsObject<KV, Secret> }>,
+) => string[];
+
+type BindingsObject<KV extends string, Secret extends string> = {
+	[K in KV | Secret]: K extends KV ? KVNamespace : string;
+};
+
+export function kvSession<
+	KVBinding extends string,
+	SecretBinding extends string,
+	Data = SessionData,
+	FlashData = Data,
+>(options: {
+	autoCommit?: boolean;
+	cookie: Omit<CookieOptions, "secrets"> & {
+		name: string;
+		secrets: GetSecretsFunction<KVBinding, SecretBinding>;
+	};
+	binding: KVBinding;
+}): MiddlewareHandler {
+	return session<
+		{ Bindings: BindingsObject<KVBinding, SecretBinding> },
+		"",
+		Record<string, unknown>,
+		Data,
+		FlashData
+	>({
+		autoCommit: options.autoCommit,
+		createSessionStorage(context) {
+			if (!(options.binding in context.env)) {
+				throw new ReferenceError("The binding for the kvSession is not set.");
+			}
+
+			let secrets = options.cookie.secrets(context);
+
+			if (secrets.length === 0) {
+				throw new ReferenceError("The secrets for the kvSession are not set.");
+			}
+
+			return createWorkersKVSessionStorage<Data, FlashData>({
+				kv: context.env[options.binding] as KVNamespace,
+				cookie: { ...options.cookie, secrets },
+			});
+		},
+	});
+}
+
+new Hono().use(
+	"*",
+	kvSession({
+		autoCommit: true,
+		cookie: {
+			name: "session",
+			secrets(context) {
+				return [context.env.SECRET];
+			},
+		},
+		binding: "KV_BINDING",
+	}),
+);

src/middlewares/session.ts

@@ -0,0 +1,55 @@
+import { Session, SessionData, SessionStorage } from "@remix-run/cloudflare";
+import { Context, Env, Input, MiddlewareHandler } from "hono";
+
+const sessionStorageSymbol = Symbol();
+const sessionSymbol = Symbol();
+
+export function session<
+	E extends Env = Record<string, never>,
+	P extends string = "",
+	I extends Input = Record<string, never>,
+	Data = SessionData,
+	FlashData = Data,
+>(options: {
+	autoCommit?: boolean;
+	createSessionStorage(env: Context<E, P, I>): SessionStorage<Data, FlashData>;
+}): MiddlewareHandler {
+	return async function middleware(context, next) {
+		let sessionStorage = options.createSessionStorage(context.env);
+
+		context.set(sessionStorageSymbol, sessionStorage);
+
+		// If autoCommit is disabled, we just create the SessionStorage and make it
+		// available with context.get(sessionStorageSymbol), then call next() and
+		// return.
+		if (!options.autoCommit) return await next();
+
+		// If autoCommit is enabled, we get the Session from the request.
+		let session = await sessionStorage.getSession(
+			context.req.raw.headers.get("cookie"),
+		);
+
+		// And make it available with context.get(sessionSymbol).
+		context.set(sessionSymbol, session);
+
+		// Then we call next() to let the rest of the middlewares run.
+		await next();
+
+		// Finally, we commit the session before the response is sent.
+		context.header("set-cookie", await sessionStorage.commitSession(session), {
+			append: true,
+		});
+	};
+}
+
+export function getSessionStorage<Data = SessionData, FlashData = Data>(
+	context: Context,
+): SessionStorage<Data, FlashData> {
+	return context.get(sessionStorageSymbol);
+}
+
+export function getSession<Data = SessionData, FlashData = Data>(
+	context: Context,
+): Session<Data, FlashData> {
+	return context.get(sessionSymbol);
+}

tsconfig.json

@@ -6,7 +6,11 @@
 		"target": "ES2019",
 		"strict": true,
 		"skipLibCheck": true,
-		"declaration": true
+		"declaration": true,
+		"baseUrl": ".", // This must be specified if "paths" is specified
+		"paths": {
+			"remix-hono/cloudflare": ["./build/cloudflare"] // relative to "baseUrl"
+		}
 	},
 	"exclude": ["node_modules"],
 	"include": ["src/**/*.ts", "@cloudflare/workers-types"]