Add KM package UUIDs for versions in detail

MarekSuchanek · vknaisl · commit 04ebab6c5557 · 2026-02-19T16:33:36.000+01:00
diff --git a/shared-common/src/Shared/Common/Api/Resource/Version/VersionDTO.hs b/shared-common/src/Shared/Common/Api/Resource/Version/VersionDTO.hs
@@ -0,0 +1,10 @@
+module Shared.Common.Api.Resource.Version.VersionDTO where
+
+import qualified Data.UUID as U
+import GHC.Generics
+
+data VersionDTO = VersionDTO
+  { uuid :: U.UUID
+  , version :: String
+  }
+  deriving (Show, Eq, Generic)
diff --git a/shared-common/src/Shared/Common/Api/Resource/Version/VersionJM.hs b/shared-common/src/Shared/Common/Api/Resource/Version/VersionJM.hs
@@ -0,0 +1,12 @@
+module Shared.Common.Api.Resource.Version.VersionJM where
+
+import Data.Aeson
+
+import Shared.Common.Api.Resource.Version.VersionDTO
+import Shared.Common.Util.Aeson
+
+instance FromJSON VersionDTO where
+  parseJSON = genericParseJSON jsonOptions
+
+instance ToJSON VersionDTO where
+  toJSON = genericToJSON jsonOptions
diff --git a/shared-common/src/Shared/Common/Api/Resource/Version/VersionSM.hs b/shared-common/src/Shared/Common/Api/Resource/Version/VersionSM.hs
@@ -0,0 +1,15 @@
+module Shared.Common.Api.Resource.Version.VersionSM where
+
+import Data.Swagger
+
+import Shared.Common.Api.Resource.Version.VersionDTO
+import Shared.Common.Api.Resource.Version.VersionJM ()
+import Shared.Common.Service.Version.VersionMapper
+import Shared.Common.Util.Swagger
+import Shared.Common.Util.Uuid
+
+instance ToSchema VersionDTO where
+  declareNamedSchema =
+    toSwagger
+      ( toVersionDTO (u' "ac3a6934-2069-4792-943c-e1170edee8c2", "1.0.0")
+      )
diff --git a/shared-common/src/Shared/Common/Service/Version/VersionMapper.hs b/shared-common/src/Shared/Common/Service/Version/VersionMapper.hs
@@ -0,0 +1,12 @@
+module Shared.Common.Service.Version.VersionMapper where
+
+import qualified Data.UUID as U
+
+import Shared.Common.Api.Resource.Version.VersionDTO
+
+toVersionDTO :: (U.UUID, String) -> VersionDTO
+toVersionDTO (uuid, version) =
+  VersionDTO
+    { uuid = uuid
+    , version = version
+    }
diff --git a/wizard-server/src/Wizard/Api/Resource/DocumentTemplate/DocumentTemplateDetailDTO.hs b/wizard-server/src/Wizard/Api/Resource/DocumentTemplate/DocumentTemplateDetailDTO.hs
@@ -4,6 +4,7 @@ import Data.Time
 import qualified Data.UUID as U
 import GHC.Generics
 
+import Shared.Common.Api.Resource.Version.VersionDTO
 import Shared.Common.Model.Common.SemVer2Tuple
 import Shared.DocumentTemplate.Model.DocumentTemplate.DocumentTemplate
 import Shared.KnowledgeModel.Model.KnowledgeModel.Package.KnowledgeModelPackagePattern
@@ -26,7 +27,7 @@ data DocumentTemplateDetailDTO = DocumentTemplateDetailDTO
   , formats :: [DocumentTemplateFormat]
   , nonEditable :: Bool
   , usableKnowledgeModels :: [KnowledgeModelPackageSimpleDTO]
-  , versions :: [String]
+  , versions :: [VersionDTO]
   , remoteLatestVersion :: Maybe String
   , organization :: Maybe RegistryOrganization
   , registryLink :: Maybe String
diff --git a/wizard-server/src/Wizard/Api/Resource/DocumentTemplate/DocumentTemplateDetailJM.hs b/wizard-server/src/Wizard/Api/Resource/DocumentTemplate/DocumentTemplateDetailJM.hs
@@ -2,6 +2,7 @@ module Wizard.Api.Resource.DocumentTemplate.DocumentTemplateDetailJM where
 
 import Data.Aeson
 
+import Shared.Common.Api.Resource.Version.VersionJM ()
 import Shared.Common.Util.Aeson
 import Shared.DocumentTemplate.Model.DocumentTemplate.DocumentTemplateJM ()
 import Wizard.Api.Resource.DocumentTemplate.DocumentTemplateDetailDTO
diff --git a/wizard-server/src/Wizard/Api/Resource/DocumentTemplate/DocumentTemplateDetailSM.hs b/wizard-server/src/Wizard/Api/Resource/DocumentTemplate/DocumentTemplateDetailSM.hs
@@ -2,6 +2,7 @@ module Wizard.Api.Resource.DocumentTemplate.DocumentTemplateDetailSM where
 
 import Data.Swagger
 
+import Shared.Common.Api.Resource.Version.VersionSM ()
 import Shared.Common.Util.Swagger
 import Shared.DocumentTemplate.Api.Resource.DocumentTemplate.DocumentTemplateSM ()
 import Wizard.Api.Resource.DocumentTemplate.DocumentTemplateDetailDTO
diff --git a/wizard-server/src/Wizard/Api/Resource/KnowledgeModel/Package/KnowledgeModelPackageDetailDTO.hs b/wizard-server/src/Wizard/Api/Resource/KnowledgeModel/Package/KnowledgeModelPackageDetailDTO.hs
@@ -4,6 +4,7 @@ import Data.Time
 import qualified Data.UUID as U
 import GHC.Generics
 
+import Shared.Common.Api.Resource.Version.VersionDTO
 import Shared.Coordinate.Model.Coordinate.Coordinate
 import Shared.KnowledgeModel.Model.KnowledgeModel.Package.KnowledgeModelPackage
 import Wizard.Model.Registry.RegistryOrganization
@@ -24,7 +25,7 @@ data KnowledgeModelPackageDetailDTO = KnowledgeModelPackageDetailDTO
   , mergeCheckpointPackageId :: Maybe Coordinate
   , nonEditable :: Bool
   , public :: Bool
-  , versions :: [String]
+  , versions :: [VersionDTO]
   , remoteLatestVersion :: Maybe String
   , organization :: Maybe RegistryOrganization
   , registryLink :: Maybe String
diff --git a/wizard-server/src/Wizard/Api/Resource/KnowledgeModel/Package/KnowledgeModelPackageDetailJM.hs b/wizard-server/src/Wizard/Api/Resource/KnowledgeModel/Package/KnowledgeModelPackageDetailJM.hs
@@ -2,6 +2,7 @@ module Wizard.Api.Resource.KnowledgeModel.Package.KnowledgeModelPackageDetailJM
 
 import Data.Aeson
 
+import Shared.Common.Api.Resource.Version.VersionJM ()
 import Shared.Common.Util.Aeson
 import Shared.Coordinate.Api.Resource.Coordinate.CoordinateJM ()
 import Shared.KnowledgeModel.Api.Resource.KnowledgeModel.Package.KnowledgeModelPackagePhaseJM ()
diff --git a/wizard-server/src/Wizard/Api/Resource/KnowledgeModel/Package/KnowledgeModelPackageDetailSM.hs b/wizard-server/src/Wizard/Api/Resource/KnowledgeModel/Package/KnowledgeModelPackageDetailSM.hs
@@ -2,7 +2,9 @@ module Wizard.Api.Resource.KnowledgeModel.Package.KnowledgeModelPackageDetailSM
 
 import Data.Swagger
 
+import Shared.Common.Api.Resource.Version.VersionSM ()
 import Shared.Common.Util.Swagger
+import Shared.Common.Util.Uuid
 import Shared.Coordinate.Api.Resource.Coordinate.CoordinateSM ()
 import Shared.KnowledgeModel.Api.Resource.KnowledgeModel.Package.KnowledgeModelPackagePhaseSM ()
 import Shared.KnowledgeModel.Database.Migration.Development.KnowledgeModel.Data.Package.KnowledgeModelPackages
@@ -21,6 +23,6 @@ instance ToSchema KnowledgeModelPackageDetailDTO where
           False
           [globalRegistryPackage]
           [globalRegistryOrganization]
-          ["1.0.0"]
+          [(u' "ac3a6934-2069-4792-943c-e1170edee8c2", "1.0.0")]
           (Just "https://registry.example.org")
       )
diff --git a/wizard-server/src/Wizard/Api/Resource/Locale/LocaleDetailDTO.hs b/wizard-server/src/Wizard/Api/Resource/Locale/LocaleDetailDTO.hs
@@ -4,6 +4,7 @@ import Data.Time
 import qualified Data.UUID as U
 import GHC.Generics
 
+import Shared.Common.Api.Resource.Version.VersionDTO
 import Wizard.Model.Registry.RegistryOrganization
 
 data LocaleDetailDTO = LocaleDetailDTO
@@ -19,7 +20,7 @@ data LocaleDetailDTO = LocaleDetailDTO
   , readme :: String
   , recommendedAppVersion :: String
   , enabled :: Bool
-  , versions :: [String]
+  , versions :: [VersionDTO]
   , remoteLatestVersion :: Maybe String
   , organization :: Maybe RegistryOrganization
   , registryLink :: Maybe String
diff --git a/wizard-server/src/Wizard/Api/Resource/Locale/LocaleDetailJM.hs b/wizard-server/src/Wizard/Api/Resource/Locale/LocaleDetailJM.hs
@@ -2,6 +2,7 @@ module Wizard.Api.Resource.Locale.LocaleDetailJM where
 
 import Data.Aeson
 
+import Shared.Common.Api.Resource.Version.VersionJM ()
 import Shared.Common.Util.Aeson
 import Wizard.Api.Resource.Locale.LocaleDetailDTO
 import Wizard.Api.Resource.Registry.RegistryOrganizationJM ()
diff --git a/wizard-server/src/Wizard/Api/Resource/Locale/LocaleDetailSM.hs b/wizard-server/src/Wizard/Api/Resource/Locale/LocaleDetailSM.hs
@@ -2,6 +2,7 @@ module Wizard.Api.Resource.Locale.LocaleDetailSM where
 
 import Data.Swagger
 
+import Shared.Common.Api.Resource.Version.VersionSM ()
 import Shared.Common.Util.Swagger
 import Wizard.Api.Resource.Locale.LocaleDetailDTO
 import Wizard.Api.Resource.Locale.LocaleDetailJM ()
diff --git a/wizard-server/src/Wizard/Database/Migration/Development/DocumentTemplate/Data/DocumentTemplates.hs b/wizard-server/src/Wizard/Database/Migration/Development/DocumentTemplate/Data/DocumentTemplates.hs
@@ -31,7 +31,7 @@ wizardDocumentTemplateDetailDTO =
     True
     [commonWizardRegistryTemplate]
     [globalRegistryOrganization]
-    ["1.0.0"]
+    [(wizardDocumentTemplate.uuid, wizardDocumentTemplate.version)]
     (Just "https://registry-test.ds-wizard.org/document-templates/global:project-report:1.0.0")
     [globalKmPackage, netherlandsKmPackageV2]
 
diff --git a/wizard-server/src/Wizard/Database/Migration/Development/KnowledgeModel/Data/Package/KnowledgeModelPackages.hs b/wizard-server/src/Wizard/Database/Migration/Development/KnowledgeModel/Data/Package/KnowledgeModelPackages.hs
@@ -47,7 +47,7 @@ globalKmPackageDetailDto =
     True
     [globalRegistryPackage]
     [globalRegistryOrganization, nlRegistryOrganization]
-    ["0.0.1", "1.0.0"]
+    [(globalKmPackageEmpty.uuid, globalKmPackageEmpty.version), (globalKmPackage.uuid, globalKmPackage.version)]
     (Just $ "https://registry-test.ds-wizard.org/knowledge-models/" ++ show (createCoordinate globalKmPackage))
 
 globalNetherlandsPackage :: KnowledgeModelPackageSimpleDTO
@@ -75,7 +75,7 @@ globalNetherlandsPackageDetailDto =
     True
     [nlRegistryPackage]
     [globalRegistryOrganization, nlRegistryOrganization]
-    ["1.0.0", "2.0.0"]
+    [(netherlandsKmPackage.uuid, netherlandsKmPackage.version), (netherlandsKmPackageV2.uuid, netherlandsKmPackageV2.version)]
     (Just $ "https://registry-test.ds-wizard.org/knowledge-models/" ++ show (createCoordinate netherlandsKmPackageV2))
 
 germanyPackageSuggestion :: KnowledgeModelPackageSuggestion
diff --git a/wizard-server/src/Wizard/Database/Migration/Development/Locale/Data/Locales.hs b/wizard-server/src/Wizard/Database/Migration/Development/Locale/Data/Locales.hs
@@ -23,7 +23,7 @@ localeNlDto :: LocaleDTO
 localeNlDto = (toDTO False localeListNl) {organization = Just orgGlobalSimple}
 
 localeNlDetailDto :: LocaleDetailDTO
-localeNlDetailDto = toDetailDTO localeNl True [] [globalRegistryOrganization] [localeNl.version] Nothing
+localeNlDetailDto = toDetailDTO localeNl True [] [globalRegistryOrganization] [(localeNl.uuid, localeNl.version)] Nothing
 
 localeNlChangeDto :: LocaleChangeDTO
 localeNlChangeDto =
diff --git a/wizard-server/src/Wizard/Service/DocumentTemplate/DocumentTemplateMapper.hs b/wizard-server/src/Wizard/Service/DocumentTemplate/DocumentTemplateMapper.hs
@@ -1,12 +1,15 @@
 module Wizard.Service.DocumentTemplate.DocumentTemplateMapper where
 
+import qualified Data.List as L
 import Data.Maybe (fromMaybe)
+import qualified Data.UUID as U
 
 import RegistryLib.Model.Organization.OrganizationSimple
 import Shared.Common.Database.DAO.Common
 import Shared.Common.Model.Common.Page
 import Shared.Common.Model.Common.PageMetadata
 import Shared.Common.Model.Common.Pageable
+import Shared.Common.Service.Version.VersionMapper
 import Shared.Coordinate.Util.Coordinate
 import Shared.DocumentTemplate.Api.Resource.DocumentTemplate.DocumentTemplateSuggestionDTO
 import Shared.DocumentTemplate.Model.DocumentTemplate.DocumentTemplate
@@ -102,7 +105,7 @@ toDetailDTO
   -> Bool
   -> [RegistryTemplate]
   -> [RegistryOrganization]
-  -> [String]
+  -> [(U.UUID, String)]
   -> Maybe String
   -> [KnowledgeModelPackage]
   -> DocumentTemplateDetailDTO
@@ -122,7 +125,7 @@ toDetailDTO tml formats registryEnabled tmlRs orgRs versionLs registryLink pkgs
     , formats = formats
     , nonEditable = tml.nonEditable
     , usableKnowledgeModels = fmap PM_Mapper.toSimpleDTO pkgs
-    , versions = versionLs
+    , versions = map toVersionDTO . L.sortBy (\(_, v1) (_, v2) -> compare v2 v1) $ versionLs
     , remoteLatestVersion =
         case (registryEnabled, selectDocumentTemplateByOrgIdAndTmlId tml tmlRs) of
           (True, Just tmlR) -> Just $ tmlR.remoteVersion
diff --git a/wizard-server/src/Wizard/Service/DocumentTemplate/DocumentTemplateService.hs b/wizard-server/src/Wizard/Service/DocumentTemplate/DocumentTemplateService.hs
@@ -136,7 +136,7 @@ deleteDocumentTemplate uuid =
 -- --------------------------------
 -- PRIVATE
 -- --------------------------------
-getDocumentTemplateVersions :: DocumentTemplate -> AppContextM [String]
+getDocumentTemplateVersions :: DocumentTemplate -> AppContextM [(U.UUID, String)]
 getDocumentTemplateVersions tml = do
   allTmls <- findDocumentTemplatesByOrganizationIdAndKmId tml.organizationId tml.templateId
-  return . fmap (.version) . filter (\t -> t.phase == ReleasedDocumentTemplatePhase || t.phase == DeprecatedDocumentTemplatePhase) $ allTmls
+  return . fmap (\t -> (t.uuid, t.version)) . filter (\t -> t.phase == ReleasedDocumentTemplatePhase || t.phase == DeprecatedDocumentTemplatePhase) $ allTmls
diff --git a/wizard-server/src/Wizard/Service/KnowledgeModel/Package/KnowledgeModelPackageMapper.hs b/wizard-server/src/Wizard/Service/KnowledgeModel/Package/KnowledgeModelPackageMapper.hs
@@ -1,7 +1,9 @@
 module Wizard.Service.KnowledgeModel.Package.KnowledgeModelPackageMapper where
 
 import qualified Data.List as L
+import qualified Data.UUID as U
 
+import Shared.Common.Service.Version.VersionMapper
 import Shared.Coordinate.Util.Coordinate
 import Shared.KnowledgeModel.Model.KnowledgeModel.Package.KnowledgeModelPackage
 import Wizard.Api.Resource.KnowledgeModel.Package.KnowledgeModelPackageChangeDTO
@@ -66,7 +68,7 @@ toSimpleDTO'' registryEnabled pkg =
     , createdAt = pkg.createdAt
     }
 
-toDetailDTO :: KnowledgeModelPackage -> Bool -> [RegistryPackage] -> [RegistryOrganization] -> [String] -> Maybe String -> KnowledgeModelPackageDetailDTO
+toDetailDTO :: KnowledgeModelPackage -> Bool -> [RegistryPackage] -> [RegistryOrganization] -> [(U.UUID, String)] -> Maybe String -> KnowledgeModelPackageDetailDTO
 toDetailDTO pkg registryEnabled pkgRs orgRs versionLs registryLink =
   KnowledgeModelPackageDetailDTO
     { uuid = pkg.uuid
@@ -84,7 +86,7 @@ toDetailDTO pkg registryEnabled pkgRs orgRs versionLs registryLink =
     , mergeCheckpointPackageId = pkg.mergeCheckpointPackageId
     , nonEditable = pkg.nonEditable
     , public = pkg.public
-    , versions = L.sort versionLs
+    , versions = map toVersionDTO . L.sortBy (\(_, v1) (_, v2) -> compare v2 v1) $ versionLs
     , remoteLatestVersion =
         case (registryEnabled, selectPackageByOrgIdAndKmId pkg pkgRs) of
           (True, Just pkgR) -> Just $ pkgR.remoteVersion
diff --git a/wizard-server/src/Wizard/Service/KnowledgeModel/Package/KnowledgeModelPackageService.hs b/wizard-server/src/Wizard/Service/KnowledgeModel/Package/KnowledgeModelPackageService.hs
@@ -99,10 +99,10 @@ deletePackage uuid mAllVersions =
 -- --------------------------------
 -- PRIVATE
 -- --------------------------------
-getPackageVersions :: KnowledgeModelPackage -> Bool -> AppContextM [String]
+getPackageVersions :: KnowledgeModelPackage -> Bool -> AppContextM [(U.UUID, String)]
 getPackageVersions pkg excludeDeprecatedVersions = do
   allPkgs <- findPackagesByOrganizationIdAndKmId pkg.organizationId pkg.kmId
-  return . fmap (.version) . filter (filterPkg excludeDeprecatedVersions) $ allPkgs
+  return . fmap (\p -> (p.uuid, p.version)) . filter (filterPkg excludeDeprecatedVersions) $ allPkgs
   where
     filterPkg :: Bool -> KnowledgeModelPackage -> Bool
     filterPkg True pkg = pkg.phase == ReleasedKnowledgeModelPackagePhase
diff --git a/wizard-server/src/Wizard/Service/Locale/LocaleMapper.hs b/wizard-server/src/Wizard/Service/Locale/LocaleMapper.hs
@@ -5,6 +5,7 @@ import Data.Time
 import qualified Data.UUID as U
 
 import RegistryLib.Model.Organization.OrganizationSimple
+import Shared.Common.Service.Version.VersionMapper
 import Shared.Coordinate.Util.Coordinate
 import Shared.Locale.Model.Locale.Locale
 import Wizard.Api.Resource.Locale.LocaleChangeDTO
@@ -46,7 +47,7 @@ toDTO registryEnabled locale =
     , updatedAt = locale.updatedAt
     }
 
-toDetailDTO :: Locale -> Bool -> [RegistryLocale] -> [RegistryOrganization] -> [String] -> Maybe String -> LocaleDetailDTO
+toDetailDTO :: Locale -> Bool -> [RegistryLocale] -> [RegistryOrganization] -> [(U.UUID, String)] -> Maybe String -> LocaleDetailDTO
 toDetailDTO locale registryEnabled localeRs orgRs versionLs registryLink =
   LocaleDetailDTO
     { uuid = locale.uuid
@@ -61,7 +62,7 @@ toDetailDTO locale registryEnabled localeRs orgRs versionLs registryLink =
     , readme = locale.readme
     , recommendedAppVersion = locale.recommendedAppVersion
     , enabled = locale.enabled
-    , versions = L.sort versionLs
+    , versions = map toVersionDTO . L.sortBy (\(_, v1) (_, v2) -> compare v2 v1) $ versionLs
     , remoteLatestVersion =
         case (registryEnabled, selectLocaleByOrgIdAndLocaleId locale localeRs) of
           (True, Just localeR) -> Just $ localeR.remoteVersion
diff --git a/wizard-server/src/Wizard/Service/Locale/LocaleService.hs b/wizard-server/src/Wizard/Service/Locale/LocaleService.hs
@@ -137,10 +137,10 @@ deleteLocale uuid =
 -- --------------------------------
 -- PRIVATE
 -- --------------------------------
-getLocaleVersions :: Locale -> AppContextM [String]
+getLocaleVersions :: Locale -> AppContextM [(U.UUID, String)]
 getLocaleVersions locale = do
   allLocales <- findLocalesByOrganizationIdAndLocaleId locale.organizationId locale.localeId
-  return . fmap (.version) $ allLocales
+  return . fmap (\l -> (l.uuid, l.version)) $ allLocales
 
 checkIfAdminIsDisabled =
   checkIfServerFeatureIsEnabled "Locale Endpoints" (\s -> not s.admin.enabled)
