Change API

Author: m-bock

src/Data/Codec/Argonaut/Sum.purs

@@ -1,21 +1,25 @@
 module Data.Codec.Argonaut.Sum
   ( Encoding(..)
+  , FlatEncoding
   , class GCases
   , class GFields
+  , class GFlatCases
   , defaultEncoding
+  , defaultFlatEncoding
   , enumSum
   , gCasesDecode
   , gCasesEncode
   , gFieldsDecode
   , gFieldsEncode
+  , gFlatCasesDecode
+  , gFlatCasesEncode
   , sum
+  , sumFlat
+  , sumFlatWith
   , sumWith
   , taggedSum
-  , sumFlat
-  , class GFlatCases
-  , gFlatCasesEncode
-  , gFlatCasesDecode
-  ) where
+  )
+  where
 
 import Prelude
 
@@ -398,8 +402,18 @@ encodeSumCase encoding tag jsons =
         encode jobject $ Obj.fromFoldable $ catMaybes
           [ tagEntry, valEntry ]
 
-sumFlat ∷ ∀ @tag r rep a. GFlatCases tag r rep ⇒ Generic a rep ⇒ String → Record r → JsonCodec a
-sumFlat name r =
+type FlatEncoding (tag ∷ Symbol) =
+  { tag ∷ Proxy tag
+  }
+
+defaultFlatEncoding ∷ FlatEncoding "tag"
+defaultFlatEncoding = { tag: Proxy }
+
+sumFlat ∷ ∀ r rep a. GFlatCases "tag" r rep ⇒ Generic a rep ⇒ String → Record r → JsonCodec a
+sumFlat = sumFlatWith defaultFlatEncoding
+
+sumFlatWith ∷ ∀ @tag r rep a. GFlatCases tag r rep ⇒ Generic a rep ⇒ FlatEncoding tag -> String → Record r → JsonCodec a
+sumFlatWith _ name r =
   dimap from to $ codec' dec enc
   where
   dec = gFlatCasesDecode @tag r >>> (lmap $ Named name)

test/Test/Sum.purs

@@ -10,7 +10,7 @@ import Data.Codec (decode, encode)
 import Data.Codec.Argonaut (JsonCodec)
 import Data.Codec.Argonaut as C
 import Data.Codec.Argonaut.Record as CR
-import Data.Codec.Argonaut.Sum (Encoding(..), defaultEncoding, sumFlat, sumWith)
+import Data.Codec.Argonaut.Sum (Encoding(..), defaultEncoding, sumFlat, sumFlatWith, sumWith)
 import Data.Generic.Rep (class Generic)
 import Data.Show.Generic (genericShow)
 import Data.String as Str
@@ -21,6 +21,8 @@ import Effect.Exception (error, throw)
 import Test.QuickCheck (class Arbitrary, arbitrary, quickCheck)
 import Test.QuickCheck.Arbitrary (genericArbitrary)
 import Test.Util (propCodec)
+import Type.Prelude (Proxy(..))
+import Type.Proxy (Proxy)
 
 --------------------------------------------------------------------------------
 
@@ -66,7 +68,7 @@ instance Show SampleFlat where
   show = genericShow
 
 codecSampleFlat ∷ JsonCodec SampleFlat
-codecSampleFlat = sumFlat @"tag" "Sample"
+codecSampleFlat = sumFlatWith { tag: Proxy @"tag" } "Sample"
   { "FlatFoo": unit
   , "FlatBar": CR.record { errors: C.int }
   , "FlatBaz": CR.record