@brightcove/hono-sessions

Hono Sessions

A session manager for Hono. Uses cookies and DynamoDB as the session storage backend

Install

npm install @brightcove/hono-sessions --save

Usage

A middleware is provided that allows configuration of the session options and adds the object sessions to the Hono context.

import { Hono } from 'hono';
import { DynamoDBDocument } from '@aws-sdk/lib-dynamodb';
import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
import { sessions, DynamoDBAdapter } from '@brightcove/hono-sessions';

const client = new DynamoDBClient({
    endpoint: 'http://localhost:4566',
    region: 'us-east-1'
});
const document = DynamoDBDocument.from(client);

const app = new Hono();

app.use(sessions({
    adapter: new DynamoDBAdapter({
        tableName: 'my-table',
        primaryKey: 'pk',
        sortKey: 'sk',
        expiresAttr: 'expires',
        document
    })
    name: 'session_storage',
    cookie: {
        maxAge: 60000,
        secure: true
    }
}));

app.get('/my_route', async (c, next) => {
    const session = c.get('session');
});

It supports custom database adapters that must conform to the exporting Adapter interface, but comes with a DynamoDBAdapter by default

interface Adapter {
    get: (key: Record<string, string>) => Promise<SessionItem | undefined>;
    set: (key: Record<string, string>, data: any, cookie: any, withExpires?: boolean) => Promise<void>;
    delete: (key: Record<string, string>) => Promise<void>;
    defaultKeyFn: () => (sessionId: string) => Record<string, string>;
}

Options

DynamoDBAdapter Options

Param	Type	Description	Required	Default
tableName	string	DynamoDB table name	yes
primaryKey	string	DynamoDB primary key	no	pk
sortKey	string	DynamoDB sort key	no	sk
expiresAttr	string	DynamoDB TTL attribute name. This will be used for setting session expiration and auto expiration behavior	no	expires
document	DynamoDBDocument	https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-lib-dynamodb/Class/DynamoDBDocument	yes

Middleware Options

Param	Type	Description	Required	Default
adapter	Adapter	A valid Adapter instance	yes
cookie	object	Accepts all the Hono cookie options	yes
name	string	The session cookie name	no	sid.bgs
secret	string	The secret used for signing cookies	yes, if cookie.secure, otherwise no
logger	Logger	What will be used for logging errors (ie. logger.error()). console is used by default if not specified	no	console
allowOverwrite	boolean	Determines whether a new session can be started when the current one hasn't been ended	no	true

Starting a session

This creates the session item in the database, initialized with a serialized version of any data passed into the function (must be serializable or this will fail) and sets the session cookie on the response.

import { startSession } from '@brightcove/hono-sessions';

app.get('/my_route', async (c, next) => {
    await startSession(c, {
        user_id: 1234,
        name: 'user'
    });
    ...
});

Updating a session

The sessions object exposes both the session and cookie, which can freely be edited.

app.get('/my_route', async (c, next) => {
    const session = c.get('session');
    const cookie = c.get('sessionCookie');

    session.newField = 'new value';
    ...
});

If any of the updated cookie options are invalid, this will fail.

When the request is finalizing, if either has been updated the changes will automatically be synced back to the database.

If any of the cookie options were updated an updated cookie will be set in the response.

Ending a session

This deletes the session from the database and the session cookie in the response.

import { endSession } from '@brightcove/hono-sessions';

app.get('/my_route', async (c, next) => {
    await endSession(c);
    ...
});