Fresh Session
🍋
Dead simple cookie-based session for Deno Fresh.
Get started
Fresh Session comes with a simple middleware to add at the root of your project, which will create or resolve a session from the request cookie.
Install / Import
You can import Fresh Session like so:
import {
cookieSession,
createCookieSessionStorage,
CookieSessionStorage
WithSession,
Session,
} from "https://deno.land/x/[email protected]/mod.ts";
Setup secret key
Fresh Session currently use JSON Web Token under the hood to create and manage session in the cookies.
JWT requires to have a secret key to encrypt new token. Fresh Session use the session from your environment variable APP_KEY.
If you don't know how to setup environment variable locally, I wrote an article about .env file in Deno Fresh.
Create a root middleware (./routes/_middleware.ts)
import { MiddlewareHandlerContext } from "$fresh/server.ts";
import {
cookieSession,
WithSession,
} from "https://deno.land/x/[email protected]/mod.ts";
export type State = WithSession;
export function handler(
req: Request,
ctx: MiddlewareHandlerContext<State>,
) {
return cookieSession(req, ctx);
}
Learn more about Fresh route middleware.
Interact with the session in your routes
Now that the middleware is setup, it's going to handle creating/resolving session based on the request cookie. So all that you need to worry about is interacting with your session.
// ./routes/dashboard.tsx
/** @jsx h */
import { h } from "preact";
import { Handlers, PageProps } from "$fresh/server.ts";
import { WithSession } from "https://deno.land/x/[email protected]/mod.ts";
export type Data = { session: Record<string, string> };
export const handler: Handlers<
Data,
WithSession // indicate with Typescript that the session is in the `ctx.state`
> = {
GET(_req, ctx) {
// The session is accessible via the `ctx.state`
const { session } = ctx.state;
// Access data stored in the session
session.get("email");
// Set new value in the session
session.set("email", "[email protected]");
// returns `true` if the session has a value with a specific key, else `false`
session.has("email");
// clear all the session data
session.clear();
// Access all session data value as an object
session.data;
// Add flash data which will disappear after accessing it
session.flash("success", "Successfully flashed a message!");
// Accessing the flashed data
// /!\ This flashed data will disappear after accessing it one time.
session.flash("success");
return ctx.render({
session: session.data, // You can pass the whole session data to the page
});
},
};
export default function Dashboard({ data }: PageProps<Data>) {
return <div>You are logged in as {data.session.email}</div>;
}
Credit
Inspiration taken from Oak Sessions & thanks to @jcs224 for all the insight!
9 Sep 12, 2022
4 Oct 17, 2022
34 Dec 19, 2022
21 Dec 16, 2022
3 May 18, 2022
4 May 3, 2022
14 Jan 3, 2023
2 Oct 12, 2022
12 Aug 2, 2022
35 Dec 11, 2022
35 Dec 5, 2022
267 Jan 9, 2023
17 Aug 24, 2022
6 Dec 16, 2022
20 Dec 26, 2022
15 Dec 3, 2022
3 Nov 29, 2022
97 Dec 28, 2022
23 Dec 18, 2022