adminjs-koa/src/buildAuthenticatedRouter.ts

/* eslint-disable global-require */
import AdminJS from 'adminjs'
import Router from '@koa/router'
import formidableMiddleware from 'koa2-formidable'
import Application from 'koa'
import session from 'koa-session'
import { addAdminJsAuthRoutes, addAdminJsRoutes } from './utils'
import { DEFAULT_ROOT_PATH } from './constants'
import { KoaAuthOptions } from './types'

/**
 * Builds authenticated koa router.
 * @memberof module:@adminjs/koa
 *
 * @param {AdminJS}         admin      AdminJS instance
 * @param {Application}     app        koa application created by `new Koa()`
 * @param {KoaAuthOptions}  auth       authentication options
 * @param {Router}          [predefinedRouter] if you have any predefined router
 *    pass it here
 * @param {FormidableOptions} formidableOptions options passed to formidable
 *    module {@link https://github.com/node-formidable/formidable#options}
 * @return  {Router}  @koa/router
 */
const buildAuthenticatedRouter = (
  admin: AdminJS,
  app: Application,
  auth: KoaAuthOptions,
  predefinedRouter?: Router,
  formidableOptions?: Record<string, any>,
): Router => {
  const router = predefinedRouter || new Router({
    prefix: admin.options.rootPath || DEFAULT_ROOT_PATH,
  })

  router.use(formidableMiddleware(formidableOptions))

  app.use(auth.sessionOptions ? session(auth.sessionOptions, app) : session(app))

  addAdminJsAuthRoutes(admin, router, auth)
  addAdminJsRoutes(admin, router, app)

  return router
}

export default buildAuthenticatedRouter