@fastify/basic-auth/types/index.test-d.ts

Fastify Basic auth plugin

import { expectType, expectAssignable } from 'tsd'
import fastify, {
  FastifyRequest,
  FastifyReply,
  onRequestHookHandler,
  preValidationHookHandler,
  preHandlerHookHandler,
  FastifyInstance
} from 'fastify'
import fastifyBasicAuth from '..'

const app = fastify()

// validation ok
app.register(fastifyBasicAuth, {
  validate: async function validatePromise (username, password, req, reply) {
    expectType<string>(username)
    expectType<string>(password)
    expectType<FastifyRequest>(req)
    expectType<FastifyReply>(reply)
    expectType<FastifyInstance>(this)
  },
  header: 'x-forwarded-authorization'
})

// validation failure
app.register(fastifyBasicAuth, {
  validate: async function validatePromise (username, password, req, reply) {
    expectType<string>(username)
    expectType<string>(password)
    expectType<FastifyRequest>(req)
    expectType<FastifyReply>(reply)
    expectType<FastifyInstance>(this)
    return new Error('unauthorized')
  },
  header: 'x-forwarded-authorization'
})

app.register(fastifyBasicAuth, {
  validate: function validateCallback (username, password, req, reply, done) {
    expectType<string>(username)
    expectType<string>(password)
    expectType<FastifyRequest>(req)
    expectType<FastifyReply>(reply)
    expectAssignable<(err?: Error) => void>(done)
    expectType<FastifyInstance>(this)
  }
})

// authenticate boolean
app.register(fastifyBasicAuth, {
  validate: () => {},
  authenticate: true
})

// authenticate with realm
app.register(fastifyBasicAuth, {
  validate: () => {},
  authenticate: { realm: 'example' }
})

// authenticate with realm (function)
app.register(fastifyBasicAuth, {
  validate: () => {},
  authenticate: {
    realm: function realm (req) {
      return req.url
    }
  }
})

// authenticate with custom header
app.register(fastifyBasicAuth, {
  validate: () => {},
  authenticate: { header: 'x-custom-authenticate' }
})

// authenticate in proxy mode
app.register(fastifyBasicAuth, {
  validate: () => {},
  proxyMode: true,
  authenticate: true,
})

app.register(fastifyBasicAuth, {
  validate: () => {},
  strictCredentials: true
})

app.register(fastifyBasicAuth, {
  validate: () => {},
  utf8: true
})

app.register(fastifyBasicAuth, {
  validate: () => {},
  strictCredentials: undefined,
  utf8: undefined
})

expectAssignable<onRequestHookHandler>(app.basicAuth)
expectAssignable<preValidationHookHandler>(app.basicAuth)
expectAssignable<preHandlerHookHandler>(app.basicAuth)