title: 'useRoleAuthorization' description: 'A role authorization hook' group: 'Hooks' badge: 'Auth'

Exobase hook to check if a request is authorized given the roles that are attached to it.

Install

1yarn add @exobase/use-role-authorization
2# or
3yarn add @exobase/hooks

Import

1import { useRoleAuthorization } from '@exobase/use-role-authorization'
2// or
3import { useRoleAuthorization } from '@exobase/hooks'

Usage

1import { compose } from 'radash'
2import type { Props } from '@exobase/core'
3import { useNext } from '@exobase/use-next'
4import { useRoleAuthorization, useTokenAuth } from '@exobase/hooks'
5import type { TokenAuth } from '@exobase/hooks'
6
7type Args = {
8  id: string
9  price: number
10}
11
12type Services = {
13  db: Database
14}
15
16export const updateListing = async ({
17  args,
18  services
19}: Props<Args, Services, TokenAuth>) => {
20  const { id, price } = args
21  const { db } = services
22  await db.listings.update(id, { price })
23}
24
25export default compose(
26  useNext(),
27  useJsonBody(z => ({
28    id: z.string(),
29    price: z.number()
30  })),
31  useTokenAuth(config.auth.tokens.secret),
32  useRoleAuthorization<Props<Args, {}, TokenAuth>>({
33    roles: ({ auth }) => auth.token.roles,
34    require: 'admin'
35  }),
36  useServices<Services>({
37    db: () => new Database()
38  })
39  updateListing
40)