commonMain.com.saveourtool.save.info.UserInfo.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of save-cloud-common Show documentation

save-cloud-common

The newest version!

package com.saveourtool.save.info

import com.saveourtool.save.domain.Role
import com.saveourtool.save.validation.Validatable
import com.saveourtool.save.validation.isValidName

import kotlin.js.JsExport
import kotlinx.serialization.Serializable

/**
 * Represents all data related to the User
 *
 * @property name name/login of the user
 * @property source where the user identity is coming from, e.g. "github"
 * @property projects [String] of project name to [Role] of the user
 * @property email
 * @property avatar avatar of user
 * @property company
 * @property location
 * @property linkedin
 * @property gitHub
 * @property twitter
 * @property organizations
 * @property globalRole
 * @property id
 * @property isActive
 * @property oldName is always null except for the process of renaming the user.
 * @property originalLogins
 * @property rating
 */
@Serializable
@JsExport
data class UserInfo(
    val name: String,
    val id: Long? = null,
    val oldName: String? = null,
    val originalLogins: List = emptyList(),
    val source: String? = null,
    val projects: Map = emptyMap(),
    val organizations: Map = emptyMap(),
    val email: String? = null,
    val avatar: String? = null,
    val company: String? = null,
    val location: String? = null,
    val linkedin: String? = null,
    val gitHub: String? = null,
    val twitter: String? = null,
    val globalRole: Role? = null,
    val isActive: Boolean = false,
    val rating: Long = 0,
) : Validatable {
    /**
     * Validation of organization name
     *
     * @return true if name is valid, false otherwise
     */
    @Suppress("FUNCTION_BOOLEAN_PREFIX")
    fun validateName(): Boolean = name.isValidName()

    /**
     * Validation of an organization
     *
     * @return true if organization is valid, false otherwise
     */
    @Suppress("FUNCTION_BOOLEAN_PREFIX")
    override fun validate(): Boolean = validateName()
}