speckle-server/packages/server/modules/serverinvites/services/projectInviteManagement.ts

import { GetStream } from '@/modules/core/domain/streams/operations'
import { TokenResourceIdentifier } from '@/modules/core/domain/tokens/types'
import { GetUser, GetUsers } from '@/modules/core/domain/users/operations'
import {
  MutationStreamInviteUseArgs,
  ProjectInviteCreateInput,
  ProjectInviteUseInput,
  StreamInviteCreateInput
} from '@/modules/core/graph/generated/graphql'
import { ContextResourceAccessRules } from '@/modules/core/helpers/token'
import { LimitedUserRecord } from '@/modules/core/helpers/types'
import { removePrivateFields } from '@/modules/core/helpers/userHelper'
import {
  ProjectInviteResourceType,
  ServerInviteResourceType
} from '@/modules/serverinvites/domain/constants'
import {
  CreateInviteParams,
  FindInvite,
  QueryAllResourceInvites,
  QueryAllUserResourceInvites
} from '@/modules/serverinvites/domain/operations'
import {
  PrimaryInviteResourceTarget,
  ProjectInviteResourceTarget,
  ServerInviteRecord
} from '@/modules/serverinvites/domain/types'
import {
  InviteCreateValidationError,
  InviteNotFoundError
} from '@/modules/serverinvites/errors'
import {
  buildUserTarget,
  isProjectResourceTarget,
  resolveInviteTargetTitle,
  resolveTarget,
  ResourceTargetTypeRoleTypeMap
} from '@/modules/serverinvites/helpers/core'
import { PendingStreamCollaboratorGraphQLReturn } from '@/modules/serverinvites/helpers/graphTypes'
import {
  CreateAndSendInvite,
  FinalizeInvite,
  GetInvitationTargetUsers,
  GetProjectInviteProject
} from '@/modules/serverinvites/services/operations'
import {
  MaybeNullOrUndefined,
  Nullable,
  Optional,
  Roles,
  ServerRoles,
  StreamRoles
} from '@speckle/shared'
import { has } from 'lodash'

type FullProjectInviteCreateInput = ProjectInviteCreateInput & { projectId: string }

const isStreamInviteCreateInput = (
  i: StreamInviteCreateInput | FullProjectInviteCreateInput
): i is StreamInviteCreateInput => has(i, 'streamId')

export const createProjectInviteFactory =
  (deps: { createAndSendInvite: CreateAndSendInvite; getStream: GetStream }) =>
  async (params: {
    input: StreamInviteCreateInput | FullProjectInviteCreateInput
    inviterId: string
    inviterResourceAccessRules: MaybeNullOrUndefined<TokenResourceIdentifier[]>
    /**
     * If invite also has secondary resource targets, you can specify the expected roles here
     */
    secondaryResourceRoles?: Partial<ResourceTargetTypeRoleTypeMap>
    allowWorkspacedProjects?: boolean
  }) => {
    const {
      input,
      inviterId,
      inviterResourceAccessRules,
      secondaryResourceRoles,
      allowWorkspacedProjects
    } = params
    const { email, userId, role } = input

    if (!email && !userId) {
      throw new InviteCreateValidationError('Either email or userId must be specified')
    }

    const serverRole = input.serverRole as Optional<ServerRoles>
    if (serverRole && !Object.values(Roles.Server).includes(serverRole)) {
      throw new InviteCreateValidationError('Invalid server role specified')
    }

    const resourceId = isStreamInviteCreateInput(input)
      ? input.streamId
      : input.projectId
    if (!resourceId?.length) {
      throw new InviteCreateValidationError('Invalid project ID specified')
    }

    // If workspace project, ensure secondaryResourceRoles are set (channeling users
    // to the correct gql resolver)
    const project = await deps.getStream({ streamId: resourceId })
    if (!allowWorkspacedProjects && project && project?.workspaceId) {
      throw new InviteCreateValidationError(
        'Target project belongs to a workspace, you should use a workspace invite instead'
      )
    }

    const target = (userId ? buildUserTarget(userId) : email)!

    const primaryResourceTarget: PrimaryInviteResourceTarget<ProjectInviteResourceTarget> =
      {
        resourceType: ProjectInviteResourceType,
        resourceId,
        role: (role as StreamRoles) || Roles.Stream.Contributor,
        primary: true,
        secondaryResourceRoles: {
          ...(secondaryResourceRoles || {}),
          ...(serverRole ? { [ServerInviteResourceType]: serverRole } : undefined)
        }
      }
    await deps.createAndSendInvite(
      {
        target,
        inviterId,
        message: isStreamInviteCreateInput(input)
          ? input.message || undefined
          : undefined,
        primaryResourceTarget
      },
      inviterResourceAccessRules
    )
  }

export const useProjectInviteAndNotifyFactory =
  (deps: { finalizeInvite: FinalizeInvite }) =>
  async (
    input: MutationStreamInviteUseArgs | ProjectInviteUseInput,
    userId: string,
    userResourceAccessRules: ContextResourceAccessRules
  ) => {
    const { accept, token } = input

    await deps.finalizeInvite({
      accept,
      token,
      finalizerUserId: userId,
      finalizerResourceAccessLimits: userResourceAccessRules
    })
  }

/**
 * Invite users to be contributors for the specified project
 */
export const inviteUsersToProjectFactory =
  (deps: { createAndSendInvite: CreateAndSendInvite; getUsers: GetUsers }) =>
  async (
    inviterId: string,
    streamId: string,
    userIds: string[],
    inviterResourceAccessLimits?: TokenResourceIdentifier[] | null
  ): Promise<boolean> => {
    const { createAndSendInvite, getUsers } = deps
    const users = await getUsers(userIds)
    if (!users.length) return false

    const inviteParamsArray = users.map((u): CreateInviteParams => {
      const primaryResourceTarget: PrimaryInviteResourceTarget<ProjectInviteResourceTarget> =
        {
          resourceType: ProjectInviteResourceType,
          resourceId: streamId,
          role: Roles.Stream.Contributor,
          primary: true
        }
      return {
        target: buildUserTarget(u.id)!,
        inviterId,
        primaryResourceTarget
      }
    })

    await Promise.all(
      inviteParamsArray.map((p) => createAndSendInvite(p, inviterResourceAccessLimits))
    )

    return true
  }

function buildPendingStreamCollaboratorId(invite: ServerInviteRecord) {
  return `invite:${invite.id}`
}

function buildPendingStreamCollaboratorModel(
  invite: ServerInviteRecord<ProjectInviteResourceTarget>,
  targetUser: Nullable<LimitedUserRecord>
): PendingStreamCollaboratorGraphQLReturn {
  return {
    id: buildPendingStreamCollaboratorId(invite),
    inviteId: invite.id,
    streamId: invite.resource.resourceId,
    title: resolveInviteTargetTitle(invite, targetUser),
    role: invite.resource.role || Roles.Stream.Contributor,
    invitedById: invite.inviterId,
    user: targetUser
  }
}

/**
 * Get all pending invitations to projects that this user has
 */
export const getUserPendingProjectInvitesFactory =
  (deps: { getUserResourceInvites: QueryAllUserResourceInvites; getUser: GetUser }) =>
  async (userId: string): Promise<PendingStreamCollaboratorGraphQLReturn[]> => {
    if (!userId) return []

    const targetUser = await deps.getUser(userId)
    if (!targetUser) {
      throw new InviteNotFoundError('Nonexistant user specified')
    }

    const invites = await deps.getUserResourceInvites<ProjectInviteResourceTarget>({
      userId,
      resourceType: ProjectInviteResourceType
    })
    return invites.map((i) => buildPendingStreamCollaboratorModel(i, targetUser))
  }

/**
 * Find a pending invitation to the specified project for the specified user
 * Either the user ID or invite ID must be set
 */
export const getUserPendingProjectInviteFactory =
  (deps: { findInvite: FindInvite; getUser: GetUser }) =>
  async (
    projectId: string,
    userId: MaybeNullOrUndefined<string>,
    token: MaybeNullOrUndefined<string>
  ): Promise<Nullable<PendingStreamCollaboratorGraphQLReturn>> => {
    if (!userId && !token) return null

    const invite = await deps.findInvite<ProjectInviteResourceTarget>({
      target: userId ? buildUserTarget(userId) : undefined,
      token: token || undefined,
      resourceFilter: {
        resourceType: ProjectInviteResourceType,
        resourceId: projectId
      }
    })
    if (!invite) return null

    const targetUserId = resolveTarget(invite.target).userId
    const targetUser = targetUserId ? await deps.getUser(targetUserId) : null

    return buildPendingStreamCollaboratorModel(invite, targetUser)
  }

/**
 * Get pending project/stream collaborators (invited, but not accepted)
 */
export const getPendingProjectCollaboratorsFactory =
  (deps: {
    queryAllResourceInvites: QueryAllResourceInvites
    getInvitationTargetUsers: GetInvitationTargetUsers
  }) =>
  async (streamId: string): Promise<PendingStreamCollaboratorGraphQLReturn[]> => {
    // Get all pending invites
    const invites = await deps.queryAllResourceInvites<ProjectInviteResourceTarget>({
      resourceId: streamId,
      resourceType: ProjectInviteResourceType
    })

    // Get all target users, if any
    const usersById = await deps.getInvitationTargetUsers({ invites })

    // Build results
    const results = []
    for (const invite of invites) {
      let user: LimitedUserRecord | null = null
      const { userId } = resolveTarget(invite.target)
      if (userId && usersById[userId]) {
        user = removePrivateFields(usersById[userId])
      }

      results.push(buildPendingStreamCollaboratorModel(invite, user))
    }

    return results
  }

export const getProjectInviteProjectFactory =
  (deps: { getStream: GetStream }): GetProjectInviteProject =>
  async (params) => {
    const { invite } = params
    const primaryResourceTarget = invite.resource

    if (!isProjectResourceTarget(primaryResourceTarget)) return undefined

    return await deps.getStream({ streamId: primaryResourceTarget.resourceId })
  }