nocodb/packages/nc-gui/composables/useRoles/index.ts

import { extractRolesObj } from 'nocodb-sdk'
import { computed, createSharedComposable, useApi, useGlobal } from '#imports'
import type { ProjectRole, Role, Roles } from '#imports'

/**
 * Provides the roles a user currently has
 *
 * * `userRoles` - the roles a user has outside of projects
 * * `projectRoles` - the roles a user has in the current project (if one was loaded)
 * * `allRoles` - all roles a user has (userRoles + projectRoles)
 * * `hasRole` - a function to check if a user has a specific role
 * * `loadRoles` - a function to load reload user roles for scope
 */
export const useRoles = createSharedComposable(() => {
  const { user, previewAs } = useGlobal()

  const { api } = useApi()

  const allRoles = computed<Roles | null>(() => {
    let orgRoles = user.value?.roles ?? {}

    orgRoles = extractRolesObj(orgRoles)

    let projectRoles = user.value?.project_roles ?? {}

    projectRoles = extractRolesObj(projectRoles)

    return {
      ...orgRoles,
      ...projectRoles,
    }
  })

  const orgRoles = computed<Roles | null>(() => {
    let orgRoles = user.value?.roles ?? {}

    orgRoles = extractRolesObj(orgRoles)

    return orgRoles
  })

  const projectRoles = computed<Roles | null>(() => {
    let projectRoles = user.value?.project_roles ?? {}

    if (Object.keys(projectRoles).length === 0) {
      projectRoles = user.value?.roles ?? {}
    }

    projectRoles = extractRolesObj(projectRoles)

    return projectRoles
  })

  const workspaceRoles = computed<Roles | null>(() => {
    return null
  })

  async function loadRoles(
    projectId?: string,
    options: { isSharedBase?: boolean; sharedBaseId?: string; isSharedErd?: boolean; sharedErdId?: string } = {},
  ) {
    if (options?.isSharedBase) {
      const res = await api.auth.me(
        {
          project_id: projectId,
        },
        {
          headers: {
            'xc-shared-base-id': options?.sharedBaseId,
          },
        },
      )

      user.value = {
        ...user.value,
        roles: res.roles,
        project_roles: res.project_roles,
      }
    } else if (options?.isSharedErd) {
      const res = await api.auth.me(
        {
          project_id: projectId,
        },
        {
          headers: {
            'xc-shared-erd-id': options?.sharedErdId,
          },
        },
      )

      user.value = {
        ...user.value,
        roles: res.roles,
        project_roles: res.project_roles,
      }
    } else if (projectId) {
      const res = await api.auth.me({ project_id: projectId })

      user.value = {
        ...user.value,
        roles: res.roles,
        project_roles: res.project_roles,
      }
    }
  }

  function hasRole(role: Role | ProjectRole | string, includePreviewRoles = false) {
    if (previewAs.value && includePreviewRoles) {
      return previewAs.value === role
    }

    return allRoles.value[role]
  }

  return { allRoles, orgRoles, workspaceRoles, projectRoles, loadRoles, hasRole }
})