feat: Glossaries

backend/api/src/main/kotlin/io/tolgee/api/v2/controllers/V2UserController.kt

@@ -42,6 +42,7 @@ import org.springframework.security.crypto.password.PasswordEncoder
 import org.springframework.web.bind.annotation.*
 import org.springframework.web.multipart.MultipartFile
 
+@Suppress("SpringJavaInjectionPointsAutowiringInspection")
 @RestController
 @RequestMapping("/v2/user")
 @Tag(name = "User", description = "Manipulates currently authenticated user")

backend/api/src/main/kotlin/io/tolgee/api/v2/controllers/notification/NotificationController.kt

@@ -33,6 +33,7 @@ import org.springframework.web.bind.annotation.GetMapping
 import org.springframework.web.bind.annotation.RequestMapping
 import org.springframework.web.bind.annotation.RestController
 
+@Suppress("SpringJavaInjectionPointsAutowiringInspection")
 @RestController
 @CrossOrigin(origins = ["*"])
 @RequestMapping(

backend/api/src/main/kotlin/io/tolgee/api/v2/controllers/organization/OrganizationProjectController.kt

@@ -6,17 +6,22 @@ package io.tolgee.api.v2.controllers.organization
 
 import io.swagger.v3.oas.annotations.Operation
 import io.swagger.v3.oas.annotations.tags.Tag
+import io.tolgee.dtos.cacheable.OrganizationLanguageDto
 import io.tolgee.exceptions.NotFoundException
 import io.tolgee.facade.ProjectWithStatsFacade
+import io.tolgee.hateoas.language.OrganizationLanguageModel
+import io.tolgee.hateoas.language.OrganizationLanguageModelAssembler
 import io.tolgee.hateoas.project.ProjectModel
 import io.tolgee.hateoas.project.ProjectModelAssembler
 import io.tolgee.hateoas.project.ProjectWithStatsModel
 import io.tolgee.model.views.ProjectWithLanguagesView
 import io.tolgee.security.authorization.UseDefaultPermissions
+import io.tolgee.service.language.LanguageService
 import io.tolgee.service.organization.OrganizationService
 import io.tolgee.service.project.ProjectService
 import org.springdoc.core.annotations.ParameterObject
 import org.springframework.data.domain.Pageable
+import org.springframework.data.domain.Sort
 import org.springframework.data.web.PagedResourcesAssembler
 import org.springframework.data.web.SortDefault
 import org.springframework.hateoas.PagedModel
@@ -38,6 +43,9 @@ class OrganizationProjectController(
   private val projectService: ProjectService,
   private val projectModelAssembler: ProjectModelAssembler,
   private val projectWithStatsFacade: ProjectWithStatsFacade,
+  private val languageService: LanguageService,
+  private val organizationLanguageModelAssembler: OrganizationLanguageModelAssembler,
+  private val pagedOrganizationLanguageAssembler: PagedResourcesAssembler<OrganizationLanguageDto>,
 ) {
   @GetMapping("/{id:[0-9]+}/projects")
   @Operation(
@@ -110,4 +118,22 @@ class OrganizationProjectController(
       return getAllWithStatistics(pageable, search, organization.id)
     } ?: throw NotFoundException()
   }
+
+  @Operation(
+    summary = "Get all languages in use by projects owned by specified organization",
+    description = "Returns all languages in use by projects owned by specified organization",
+  )
+  @GetMapping("/{organizationId:[0-9]+}/languages")
+  @UseDefaultPermissions
+  fun getAllLanguagesInUse(
+    @ParameterObject
+    @SortDefault("base", direction = Sort.Direction.DESC)
+    @SortDefault("tag", direction = Sort.Direction.ASC)
+    pageable: Pageable,
+    @RequestParam("search") search: String?,
+    @PathVariable organizationId: Long,
+  ): PagedModel<OrganizationLanguageModel> {
+    val languages = languageService.getPagedByOrganization(organizationId, pageable, search)
+    return pagedOrganizationLanguageAssembler.toModel(languages, organizationLanguageModelAssembler)
+  }
 }

backend/api/src/main/kotlin/io/tolgee/api/v2/controllers/project/ProjectsController.kt

@@ -53,7 +53,7 @@ import org.springframework.http.MediaType
 import org.springframework.web.bind.annotation.*
 import org.springframework.web.multipart.MultipartFile
 
-@Suppress(names = ["MVCPathVariableInspection", "SpringJavaInjectionPointsAutowiringInspection"])
+@Suppress("MVCPathVariableInspection", "SpringJavaInjectionPointsAutowiringInspection")
 @RestController
 @CrossOrigin(origins = ["*"])
 @RequestMapping(value = ["/v2/projects"])

backend/api/src/main/kotlin/io/tolgee/component/PreferredOrganizationFacade.kt

@@ -8,6 +8,7 @@ import io.tolgee.service.organization.OrganizationService
 import io.tolgee.service.security.UserPreferencesService
 import org.springframework.stereotype.Component
 
+@Suppress("SpringJavaInjectionPointsAutowiringInspection")
 @Component
 class PreferredOrganizationFacade(
   private val authenticationFacade: AuthenticationFacade,

backend/api/src/main/kotlin/io/tolgee/hateoas/ee/webhooks/WebhookConfigModel.kt

@@ -21,4 +21,4 @@ class WebhookConfigModel(
     description = """Date of the last webhook request.""",
   )
   var lastExecuted: Long?,
-) : RepresentationModel<io.tolgee.hateoas.ee.webhooks.WebhookConfigModel>(), Serializable
+) : RepresentationModel<WebhookConfigModel>(), Serializable

backend/api/src/main/kotlin/io/tolgee/hateoas/language/OrganizationLanguageModel.kt

@@ -0,0 +1,20 @@
+package io.tolgee.hateoas.language
+
+import io.swagger.v3.oas.annotations.media.Schema
+import org.springframework.hateoas.RepresentationModel
+import org.springframework.hateoas.server.core.Relation
+
+@Suppress("unused")
+@Relation(collectionRelation = "languages", itemRelation = "language")
+open class OrganizationLanguageModel(
+  @Schema(example = "Czech", description = "Language name in english")
+  val name: String,
+  @Schema(example = "cs-CZ", description = "Language tag according to BCP 47 definition")
+  var tag: String,
+  @Schema(example = "čeština", description = "Language name in this language")
+  var originalName: String? = null,
+  @Schema(example = "\uD83C\uDDE8\uD83C\uDDFF", description = "Language flag emoji as UTF-8 emoji")
+  var flagEmoji: String? = null,
+  @Schema(example = "false", description = "Whether is base language of any project")
+  var base: Boolean,
+) : RepresentationModel<OrganizationLanguageModel>()

backend/api/src/main/kotlin/io/tolgee/hateoas/language/OrganizationLanguageModelAssembler.kt

@@ -0,0 +1,23 @@
+package io.tolgee.hateoas.language
+
+import io.tolgee.api.v2.controllers.organization.OrganizationProjectController
+import io.tolgee.dtos.cacheable.OrganizationLanguageDto
+import org.springframework.hateoas.server.mvc.RepresentationModelAssemblerSupport
+import org.springframework.stereotype.Component
+
+@Component
+class OrganizationLanguageModelAssembler :
+  RepresentationModelAssemblerSupport<OrganizationLanguageDto, OrganizationLanguageModel>(
+    OrganizationProjectController::class.java,
+    OrganizationLanguageModel::class.java,
+  ) {
+  override fun toModel(languageDto: OrganizationLanguageDto): OrganizationLanguageModel {
+    return OrganizationLanguageModel(
+      name = languageDto.name,
+      originalName = languageDto.originalName,
+      tag = languageDto.tag,
+      flagEmoji = languageDto.flagEmoji,
+      base = languageDto.base,
+    )
+  }
+}

backend/app/src/main/kotlin/io/tolgee/configuration/openApi/OpenApiGroupBuilder.kt

@@ -7,6 +7,7 @@ import io.tolgee.openApiDocs.OpenApiCloudExtension
 import io.tolgee.openApiDocs.OpenApiEeExtension
 import io.tolgee.openApiDocs.OpenApiOrderExtension
 import io.tolgee.openApiDocs.OpenApiSelfHostedExtension
+import io.tolgee.openApiDocs.OpenApiUnstableOperationExtension
 import io.tolgee.security.authentication.AllowApiAccess
 import org.springdoc.core.models.GroupedOpenApi
 import org.springframework.web.method.HandlerMethod
@@ -74,9 +75,10 @@ class OpenApiGroupBuilder(
   private fun addMethodExtensions() {
     customizeOperations { operation, handlerMethod, _ ->
       addOperationOrder(handlerMethod, operation)
-      addOperationEeExtension(handlerMethod, operation)
-      addSelfHostedOperationEeExtension(handlerMethod, operation)
-      addCloudOperationEeExtension(handlerMethod, operation)
+      addExtensionFor(handlerMethod, operation, OpenApiEeExtension::class.java, "x-ee")
+      addExtensionFor(handlerMethod, operation, OpenApiCloudExtension::class.java, "x-cloud")
+      addExtensionFor(handlerMethod, operation, OpenApiSelfHostedExtension::class.java, "x-self-hosted")
+      addExtensionFor(handlerMethod, operation, OpenApiUnstableOperationExtension::class.java, "x-unstable")
       operation
     }
   }
@@ -91,40 +93,21 @@ class OpenApiGroupBuilder(
     }
   }
 
-  private fun addOperationEeExtension(
+  private fun <T : Annotation> addExtensionFor(
     handlerMethod: HandlerMethod,
     operation: Operation,
+    annotationClass: Class<T>,
+    extensionName: String,
+    value: ((T) -> Any?)? = null,
   ) {
-    val eeExtensionAnnotation =
-      handlerMethod.getMethodAnnotation(OpenApiEeExtension::class.java)
-        ?: handlerMethod.method.declaringClass.getAnnotation(OpenApiEeExtension::class.java) ?: null
-    if (eeExtensionAnnotation != null) {
-      operation.addExtension("x-ee", true)
+    val annotation =
+      handlerMethod.getMethodAnnotation(annotationClass)
+        ?: handlerMethod.method.declaringClass.getAnnotation(annotationClass) ?: null
+    if (annotation == null) {
+      return
     }
-  }
 
-  private fun addCloudOperationEeExtension(
-    handlerMethod: HandlerMethod,
-    operation: Operation,
-  ) {
-    val eeExtensionAnnotation =
-      handlerMethod.getMethodAnnotation(OpenApiCloudExtension::class.java)
-        ?: handlerMethod.method.declaringClass.getAnnotation(OpenApiCloudExtension::class.java) ?: null
-    if (eeExtensionAnnotation != null) {
-      operation.addExtension("x-cloud", true)
-    }
-  }
-
-  private fun addSelfHostedOperationEeExtension(
-    handlerMethod: HandlerMethod,
-    operation: Operation,
-  ) {
-    val eeExtensionAnnotation =
-      handlerMethod.getMethodAnnotation(OpenApiSelfHostedExtension::class.java)
-        ?: handlerMethod.method.declaringClass.getAnnotation(OpenApiSelfHostedExtension::class.java) ?: null
-    if (eeExtensionAnnotation != null) {
-      operation.addExtension("x-self-hosted", true)
-    }
+    operation.addExtension(extensionName, value?.invoke(annotation) ?: true)
   }
 
   private fun addTagOrders() {

backend/data/src/main/kotlin/io/tolgee/component/machineTranslation/metadata/Metadata.kt

@@ -3,6 +3,7 @@ package io.tolgee.component.machineTranslation.metadata
 data class Metadata(
   val examples: List<ExampleItem> = emptyList(),
   val closeItems: List<ExampleItem> = emptyList(),
+  val glossaryTerms: List<TranslationGlossaryItem> = emptyList(),
   val keyDescription: String?,
   val projectDescription: String?,
   val languageDescription: String?,

backend/data/src/main/kotlin/io/tolgee/component/machineTranslation/metadata/TranslationGlossaryItem.kt

@@ -0,0 +1,11 @@
+package io.tolgee.component.machineTranslation.metadata
+
+data class TranslationGlossaryItem(
+  val source: String,
+  val target: String? = null,
+  val description: String? = null,
+  val isNonTranslatable: Boolean? = null,
+  val isCaseSensitive: Boolean? = null,
+  val isAbbreviation: Boolean? = null,
+  val isForbiddenTerm: Boolean? = null,
+)

backend/data/src/main/kotlin/io/tolgee/constants/Feature.kt

@@ -21,7 +21,7 @@ enum class Feature {
   TASKS,
   SSO,
   ORDER_TRANSLATION,
-
+  GLOSSARY,
   ;
 
   companion object {

backend/data/src/main/kotlin/io/tolgee/constants/Message.kt

@@ -281,6 +281,10 @@ enum class Message {
   PLAN_SEAT_LIMIT_EXCEEDED,
   INSTANCE_NOT_USING_LICENSE_KEY,
   INVALID_PATH,
+  GLOSSARY_NOT_FOUND,
+  GLOSSARY_TERM_NOT_FOUND,
+  GLOSSARY_TERM_TRANSLATION_NOT_FOUND,
+  GLOSSARY_NON_TRANSLATABLE_TERM_CANNOT_BE_TRANSLATED,
   ;
 
   val code: String

backend/data/src/main/kotlin/io/tolgee/dtos/cacheable/OrganizationLanguageDto.kt

@@ -0,0 +1,9 @@
+package io.tolgee.dtos.cacheable
+
+interface OrganizationLanguageDto {
+  val name: String
+  val tag: String
+  val originalName: String?
+  val flagEmoji: String?
+  val base: Boolean
+}

backend/data/src/main/kotlin/io/tolgee/dtos/request/language/LanguageFilters.kt

@@ -12,4 +12,9 @@ open class LanguageFilters {
     description = """Filter languages without id""",
   )
   var filterNotId: List<Long>? = null
+
+  @field:Parameter(
+    description = """Filter languages by name or tag""",
+  )
+  var search: String? = null
 }

backend/data/src/main/kotlin/io/tolgee/model/Project.kt

@@ -6,6 +6,7 @@ import io.tolgee.api.ISimpleProject
 import io.tolgee.model.automations.Automation
 import io.tolgee.model.contentDelivery.ContentDeliveryConfig
 import io.tolgee.model.contentDelivery.ContentStorage
+import io.tolgee.model.glossary.Glossary
 import io.tolgee.model.key.Key
 import io.tolgee.model.key.Namespace
 import io.tolgee.model.mtServiceConfig.MtServiceConfig
@@ -93,6 +94,9 @@ class Project(
   @ActivityLoggedProp
   var defaultNamespace: Namespace? = null
 
+  @ManyToMany(fetch = FetchType.LAZY, mappedBy = "assignedProjects")
+  var glossaries: MutableSet<Glossary> = mutableSetOf()
+
   @ActivityLoggedProp
   override var avatarHash: String? = null
 

backend/data/src/main/kotlin/io/tolgee/model/activity/ActivityRevision.kt

@@ -72,6 +72,11 @@ class ActivityRevision : java.io.Serializable {
    */
   var projectId: Long? = null
 
+//  /**
+//   * Glossary of the change
+//   */
+//  var glossaryId: Long? = null // TODO
+
   @OneToMany(mappedBy = "activityRevision")
   var describingRelations: MutableList<ActivityDescribingEntity> = mutableListOf()
 

backend/data/src/main/kotlin/io/tolgee/model/glossary/Glossary.kt

@@ -0,0 +1,58 @@
+package io.tolgee.model.glossary
+
+import io.tolgee.activity.annotation.ActivityLoggedEntity
+import io.tolgee.activity.annotation.ActivityLoggedProp
+import io.tolgee.model.Organization
+import io.tolgee.model.Project
+import io.tolgee.model.SoftDeletable
+import io.tolgee.model.StandardAuditModel
+import jakarta.persistence.CascadeType
+import jakarta.persistence.Column
+import jakarta.persistence.Entity
+import jakarta.persistence.FetchType
+import jakarta.persistence.JoinColumn
+import jakarta.persistence.JoinTable
+import jakarta.persistence.ManyToMany
+import jakarta.persistence.ManyToOne
+import jakarta.persistence.OneToMany
+import jakarta.persistence.Table
+import jakarta.persistence.Temporal
+import jakarta.persistence.TemporalType
+import jakarta.persistence.UniqueConstraint
+import jakarta.validation.constraints.Size
+import java.util.Date
+
+@Entity
+@ActivityLoggedEntity
+@Table(
+  uniqueConstraints = [
+    UniqueConstraint(
+      columnNames = ["organization_owner_id", "name"],
+    ),
+  ],
+)
+class Glossary(
+  @field:Size(min = 3, max = 50)
+  @ActivityLoggedProp
+  var name: String = "",
+  @ActivityLoggedProp
+  @Column(nullable = false)
+  var baseLanguageTag: String? = null,
+) : StandardAuditModel(), SoftDeletable {
+  @OneToMany(fetch = FetchType.LAZY, mappedBy = "glossary")
+  var terms: MutableList<GlossaryTerm> = mutableListOf()
+
+  @ManyToOne(optional = true, fetch = FetchType.LAZY)
+  lateinit var organizationOwner: Organization
+
+  @ManyToMany(fetch = FetchType.LAZY, cascade = [CascadeType.PERSIST])
+  @JoinTable(
+    name = "glossary_project",
+    joinColumns = [JoinColumn(name = "project_id")],
+    inverseJoinColumns = [JoinColumn(name = "glossary_id")],
+  )
+  var assignedProjects: MutableSet<Project> = mutableSetOf()
+
+  @Temporal(TemporalType.TIMESTAMP)
+  override var deletedAt: Date? = null
+}

backend/data/src/main/kotlin/io/tolgee/model/glossary/GlossaryTerm.kt

@@ -0,0 +1,32 @@
+package io.tolgee.model.glossary
+
+import io.tolgee.activity.annotation.ActivityLoggedEntity
+import io.tolgee.activity.annotation.ActivityLoggedProp
+import io.tolgee.model.StandardAuditModel
+import jakarta.persistence.*
+
+@Entity
+@ActivityLoggedEntity
+class GlossaryTerm(
+  @Column(columnDefinition = "text")
+  @ActivityLoggedProp
+  var description: String? = null,
+) : StandardAuditModel() {
+  @ManyToOne
+  lateinit var glossary: Glossary
+
+  @OneToMany(fetch = FetchType.LAZY, cascade = [CascadeType.REMOVE], mappedBy = "term")
+  var translations: MutableList<GlossaryTermTranslation> = mutableListOf()
+
+  @ActivityLoggedProp
+  var flagNonTranslatable: Boolean = false
+
+  @ActivityLoggedProp
+  var flagCaseSensitive: Boolean = false
+
+  @ActivityLoggedProp
+  var flagAbbreviation: Boolean = false
+
+  @ActivityLoggedProp
+  var flagForbiddenTerm: Boolean = false
+}