Renamed user configuration to vault

Author: DenuxPlays

backend/src/main/kotlin/app/cliq/backend/userconfig/UserConfigurationRepository.kt

@@ -1,10 +1,10 @@
-package app.cliq.backend.userconfig
+package app.cliq.backend.vault
 
 import app.cliq.backend.annotations.Authenticated
 import app.cliq.backend.session.Session
-import app.cliq.backend.userconfig.factory.UserConfigurationFactory
-import app.cliq.backend.userconfig.params.ConfigurationParams
-import app.cliq.backend.userconfig.view.ConfigurationView
+import app.cliq.backend.vault.factory.VaultFactory
+import app.cliq.backend.vault.params.VaultParams
+import app.cliq.backend.vault.view.VaultView
 import io.swagger.v3.oas.annotations.Operation
 import io.swagger.v3.oas.annotations.media.Content
 import io.swagger.v3.oas.annotations.media.Schema
@@ -22,39 +22,39 @@ import org.springframework.web.bind.annotation.RestController
 import java.time.OffsetDateTime
 
 @RestController
-@RequestMapping("/api/user/configuration")
-@Tag(name = "User Configuration", description = "User configuration management")
-class UserConfigurationController(
-    private val userConfigurationFactory: UserConfigurationFactory,
-    private val repository: UserConfigurationRepository,
+@RequestMapping("/api/vault")
+@Tag(name = "Vault", description = "Vault management")
+class VaultController(
+    private val vaultFactory: VaultFactory,
+    private val repository: VaultRepository,
 ) {
     @Authenticated
     @PutMapping
-    @Operation(summary = "Insert or update user configuration")
+    @Operation(summary = "Insert or update vault")
     @ApiResponses(
         value = [
             ApiResponse(
                 responseCode = "200",
-                description = "Successfully updated user configuration",
+                description = "Successfully updated vault",
             ),
         ],
     )
     fun put(
         @AuthenticationPrincipal session: Session,
-        @RequestBody configurationParams: ConfigurationParams,
+        @RequestBody vaultParams: VaultParams,
     ): ResponseEntity<Void> {
         val user = session.user
         val existingConfig = repository.getByUser(user)
 
         if (existingConfig == null) {
-            val config = userConfigurationFactory.createFromParams(configurationParams, user)
+            val config = vaultFactory.createFromParams(vaultParams, user)
 
             repository.save(config)
         } else {
             val config =
-                userConfigurationFactory.updateFromParams(
+                vaultFactory.updateFromParams(
                     existingConfig,
-                    configurationParams,
+                    vaultParams,
                     user,
                 )
 
@@ -66,35 +66,35 @@ class UserConfigurationController(
 
     @Authenticated
     @GetMapping
-    @Operation(summary = "Get's you the current configuration.")
+    @Operation(summary = "Get's you the current vault.")
     @ApiResponses(
         value = [
             ApiResponse(
                 responseCode = "200",
-                description = "Successfully retrieved user configuration",
+                description = "Successfully retrieved the vault.",
                 content = [
                     Content(
                         mediaType = MediaType.APPLICATION_JSON_VALUE,
-                        schema = Schema(implementation = ConfigurationView::class),
+                        schema = Schema(implementation = VaultView::class),
                     ),
                 ],
             ),
         ],
     )
     fun get(
         @AuthenticationPrincipal session: Session,
-    ): ResponseEntity<ConfigurationView> {
+    ): ResponseEntity<VaultView> {
         val user = session.user
-        val config = repository.getByUser(user) ?: return ResponseEntity.notFound().build()
+        val vault = repository.getByUser(user) ?: return ResponseEntity.notFound().build()
 
-        val view = ConfigurationView(config.encryptedConfig, config.updatedAt, config.updatedAt)
+        val view = VaultView(vault.encryptedConfig, vault.version, vault.updatedAt, vault.updatedAt)
 
         return ResponseEntity.ok(view)
     }
 
     @Authenticated
     @GetMapping("/last-updated")
-    @Operation(summary = "Get's you when the config was last updated")
+    @Operation(summary = "Get's you when the vault was last updated")
     @ApiResponses(
         value = [
             ApiResponse(

…serconfig/UserConfigurationController.kt …pp/cliq/backend/vault/VaultController.ktbackend/src/main/kotlin/app/cliq/backend/userconfig/UserConfigurationController.kt renamed to backend/src/main/kotlin/app/cliq/backend/vault/VaultController.kt backend/src/main/kotlin/app/cliq/backend/userconfig/UserConfigurationController.kt renamed to backend/src/main/kotlin/app/cliq/backend/vault/VaultController.kt

@@ -1,4 +1,4 @@
-package app.cliq.backend.userconfig
+package app.cliq.backend.vault
 
 import app.cliq.backend.user.User
 import jakarta.persistence.Column
@@ -15,14 +15,15 @@ import java.time.OffsetDateTime
 
 @Entity
 @Table(
-    name = "user_configurations",
+    name = "vaults",
     uniqueConstraints = [UniqueConstraint(columnNames = ["user_id"])],
 )
-class UserConfiguration(
+class VaultData(
     @OneToOne(fetch = FetchType.LAZY)
     @JoinColumn(nullable = false)
     var user: User,
     @Column var encryptedConfig: String,
+    @Column(nullable = false) var version: String,
     @Column(nullable = false) var createdAt: OffsetDateTime,
     @Column(nullable = false) var updatedAt: OffsetDateTime,
     @Id

…/backend/userconfig/UserConfiguration.kt …tlin/app/cliq/backend/vault/VaultData.ktbackend/src/main/kotlin/app/cliq/backend/userconfig/UserConfiguration.kt renamed to backend/src/main/kotlin/app/cliq/backend/vault/VaultData.kt backend/src/main/kotlin/app/cliq/backend/userconfig/UserConfiguration.kt renamed to backend/src/main/kotlin/app/cliq/backend/vault/VaultData.kt

@@ -0,0 +1,13 @@
+package app.cliq.backend.vault
+
+import app.cliq.backend.user.User
+import org.springframework.data.jpa.repository.JpaRepository
+import org.springframework.data.jpa.repository.Query
+import java.time.OffsetDateTime
+
+interface VaultRepository : JpaRepository<VaultData, Long> {
+    fun getByUser(user: User): VaultData?
+
+    @Query("SELECT uc.updatedAt FROM VaultData uc WHERE uc.user = :user")
+    fun getUpdatedAtByUser(user: User): OffsetDateTime?
+}

backend/src/main/kotlin/app/cliq/backend/vault/VaultRepository.kt

@@ -1,42 +1,45 @@
-package app.cliq.backend.userconfig.factory
+package app.cliq.backend.vault.factory
 
 import app.cliq.backend.user.User
-import app.cliq.backend.userconfig.UserConfiguration
-import app.cliq.backend.userconfig.params.ConfigurationParams
+import app.cliq.backend.vault.VaultData
+import app.cliq.backend.vault.params.VaultParams
 import org.springframework.stereotype.Service
 import java.time.Clock
 import java.time.OffsetDateTime
 
 @Service
 class
-UserConfigurationFactory(
+VaultFactory(
     private val clock: Clock,
 ) {
     fun createFromParams(
-        configurationParams: ConfigurationParams,
+        vaultParams: VaultParams,
         user: User,
-    ): UserConfiguration = create(configurationParams.configuration, user)
+    ): VaultData = create(vaultParams.configuration, vaultParams.version, user)
 
     fun updateFromParams(
-        existingConfig: UserConfiguration,
-        configurationParams: ConfigurationParams,
+        existingConfig: VaultData,
+        vaultParams: VaultParams,
         user: User,
-    ): UserConfiguration =
-        UserConfiguration(
+    ): VaultData =
+        VaultData(
             user,
-            configurationParams.configuration,
+            vaultParams.configuration,
+            vaultParams.version,
             existingConfig.createdAt,
             OffsetDateTime.now(clock),
             id = existingConfig.id,
         )
 
     fun create(
         encryptedConfig: String,
+        version: String,
         user: User,
-    ): UserConfiguration =
-        UserConfiguration(
+    ): VaultData =
+        VaultData(
             user = user,
             encryptedConfig = encryptedConfig,
+            version = version,
             createdAt = OffsetDateTime.now(clock),
             updatedAt = OffsetDateTime.now(clock),
         )

…nfig/factory/UserConfigurationFactory.kt …iq/backend/vault/factory/VaultFactory.ktbackend/src/main/kotlin/app/cliq/backend/userconfig/factory/UserConfigurationFactory.kt renamed to backend/src/main/kotlin/app/cliq/backend/vault/factory/VaultFactory.kt backend/src/main/kotlin/app/cliq/backend/userconfig/factory/UserConfigurationFactory.kt renamed to backend/src/main/kotlin/app/cliq/backend/vault/factory/VaultFactory.kt

@@ -1,9 +1,10 @@
-package app.cliq.backend.userconfig.params
+package app.cliq.backend.vault.params
 
 import io.swagger.v3.oas.annotations.media.Schema
 
 @Schema
-data class ConfigurationParams(
+data class VaultParams(
     @Schema(description = "The encrypted user configuration")
     val configuration: String,
+    val version: String,
 )

…userconfig/params/ConfigurationParams.kt …cliq/backend/vault/params/VaultParams.ktbackend/src/main/kotlin/app/cliq/backend/userconfig/params/ConfigurationParams.kt renamed to backend/src/main/kotlin/app/cliq/backend/vault/params/VaultParams.kt backend/src/main/kotlin/app/cliq/backend/userconfig/params/ConfigurationParams.kt renamed to backend/src/main/kotlin/app/cliq/backend/vault/params/VaultParams.kt

@@ -1,11 +1,12 @@
-package app.cliq.backend.userconfig.view
+package app.cliq.backend.vault.view
 
 import io.swagger.v3.oas.annotations.media.Schema
 import java.time.OffsetDateTime
 
 @Schema
-data class ConfigurationView(
+data class VaultView(
     val configuration: String,
+    val version: String,
     val updatedAt: OffsetDateTime,
     val createdAt: OffsetDateTime,
 )

…end/userconfig/view/ConfigurationView.kt …app/cliq/backend/vault/view/VaultView.ktbackend/src/main/kotlin/app/cliq/backend/userconfig/view/ConfigurationView.kt renamed to backend/src/main/kotlin/app/cliq/backend/vault/view/VaultView.kt backend/src/main/kotlin/app/cliq/backend/userconfig/view/ConfigurationView.kt renamed to backend/src/main/kotlin/app/cliq/backend/vault/view/VaultView.kt

@@ -45,11 +45,12 @@ CREATE INDEX idx_sessions_refresh_token ON sessions (refresh_token);
 -- #                                                          #
 -- ############################################################
 
-CREATE TABLE user_configurations
+CREATE TABLE vaults
 (
     "id"               BIGINT PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
     "user_id"          BIGINT REFERENCES "users" (id) ON DELETE CASCADE UNIQUE NOT NULL,
     "encrypted_config" TEXT                                                    NOT NULL,
+    "version"          TEXT                                                    NOT NULL,
     "created_at"       timestamp with time zone                                NOT NULL,
     "updated_at"       timestamp with time zone                                NOT NULL
 );