@fastify/secure-session/types/index.test-d.ts

Create a secure stateless cookie session for Fastify

import SecureSessionPlugin, { Session, SessionData } from '..'
import fastify, {
  FastifyRequest,
  FastifyInstance,
  FastifyReply,
} from 'fastify'
import { expectType } from 'tsd'

const app: FastifyInstance = fastify()
app.register(SecureSessionPlugin, { key: 'foobar' })
app.register(SecureSessionPlugin, { key: Buffer.from('foo') })
app.register(SecureSessionPlugin, { key: ['foo', 'bar'] })
app.register(SecureSessionPlugin, { secret: 'foo', salt: 'bar' })
app.register(SecureSessionPlugin, { sessionName: 'foo', key: 'bar' })
app.register(SecureSessionPlugin, { expiry: 24 * 60 * 60, key: 'bar' })
app.register(SecureSessionPlugin, [{ sessionName: 'foo', key: 'bar' }, { sessionName: 'bar', key: 'bar' }])

declare module '..' {
  interface SessionData {
    foo: string;
  }
}

interface FooSessionData {
  foo: string;
}

declare module 'fastify' {
  interface FastifyRequest {
    foo: Session<FooSessionData>;
  }
}

app.get('/not-websockets', async (request, reply) => {
  expectType<FastifyRequest>(request)
  expectType<FastifyReply>(reply)
  expectType<Session>(request.session)
  request.session.set('foo', 'bar')
  expectType<string | undefined>(request.session.get('foo'))
  expectType<any>(request.session.get('baz'))
  expectType<string | undefined>(request.session.foo)
  expectType<SessionData | undefined>(request.session.data())
  request.session.delete()
  request.session.options({ maxAge: 42 })
  request.session.touch()

  request.foo.set('foo', 'bar')
  expectType<string | undefined>(request.foo.get('foo'))
  expectType<any>(request.foo.get('baz'))
  request.foo.delete()
  request.foo.options({ maxAge: 42 })
  request.foo.touch()

  // @ts-expect-error: set undefined key
  request.session.set('baz', 'bar')
  // @ts-expect-error: invoke undefined key
  expectType<any>(request.session.baz)
  // @ts-expect-error: invoke undefined key
  request.baz.touch()
})

expectType<Session | null>(app.decodeSecureSession('some cookie'))
let session = app.createSecureSession({ foo: 'bar' })
expectType<Session>(session)
session = app.createSecureSession()
expectType<Session>(session)
expectType<string>(app.encodeSecureSession(session))