feat: ToSchema instance for CustomJSON

Author: brprice

primer-service/primer-service.cabal

@@ -34,6 +34,7 @@ library
   build-depends:
     , aeson              >=2.0     && <=2.1
     , base               >=4.12    && <=4.17
+    , deriving-aeson     >=0.2     && <=0.3
     , exceptions         >=0.10.4  && <=0.11
     , http-media         >=0.8     && <=0.9
     , mtl                >=2.2.2   && <=2.3

primer-service/src/Primer/OpenAPI.hs

@@ -1,16 +1,19 @@
+{-# LANGUAGE UndecidableInstances #-}
 {-# OPTIONS_GHC -fno-warn-orphans #-}
 
 module Primer.OpenAPI (
   -- * Orphan instances
   -- $orphanInstances
 ) where
 
-import Data.OpenApi (ToSchema)
-import Data.Text (Text)
-import Data.Typeable (Typeable)
+import Data.OpenApi (fromAesonOptions)
+import Data.OpenApi.Internal.Schema
+import Deriving.Aeson (AesonOptions (aesonOptions))
+import Foreword
 import Primer.API (Def, Module, NodeBody, NodeFlavor, Prog, Tree)
 import Primer.Core (GlobalName, ID (..), LVarName, ModuleName)
 import Primer.Database (Session, SessionName)
+import Primer.JSON (CustomJSON)
 import Primer.Name (Name)
 
 -- $orphanInstances
@@ -20,6 +23,13 @@ import Primer.Name (Name)
 -- build primer with ghcjs, because openapi3 transitively depends on network,
 -- which ghcjs currently cannot build.
 
+-- Suitable for deriving via, when the ToJSON instance is via PrimerJSON
+instance
+  (Typeable a, Generic a, GToSchema (Rep a), Typeable os, Typeable ks, AesonOptions os) =>
+  ToSchema (CustomJSON (os :: ks) a)
+  where
+  declareNamedSchema _ = genericDeclareNamedSchema (fromAesonOptions (aesonOptions @os)) (Proxy @a)
+
 instance ToSchema SessionName
 instance ToSchema Session
 

primer/primer.cabal

@@ -29,6 +29,7 @@ library
     Primer.Eval
     Primer.EvalFull
     Primer.Examples
+    Primer.JSON
     Primer.Module
     Primer.Name
     Primer.Name.Fresh
@@ -43,10 +44,7 @@ library
     Primer.ZipperCxt
 
   hs-source-dirs:     src
-  other-modules:
-    Control.Monad.NestedError
-    Primer.JSON
-
+  other-modules:      Control.Monad.NestedError
   default-language:   GHC2021
   default-extensions:
     NoImplicitPrelude