Skip to content

tests: add a test case to replicate issue with Maybe's in tuples #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kallevmercury wants to merge 5 commits into from
Closed

tests: add a test case to replicate issue with Maybe's in tuples #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8411186
tests: add a test case to replicate issue with Maybe's in tuples
kallevmercury Jul 30, 2025
4bf5fb5
chore: simplify test
kallevmercury Jul 30, 2025
674ffb5
fix: possible fix for the Maybe tuple -> nullable TS list issue
kallevmercury Jul 30, 2025
a8fcfa5
chore: reset extra change
kallevmercury Jul 30, 2025
8cba73c
Apply suggestions from code review
kallevmercury Jul 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions src/Data/Aeson/TypeScript/Instances.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,14 @@ instance TypeScript Word32 where
instance TypeScript Word64 where
getTypeScriptType _ = "number"

-- | Get TypeScript type with null handling for optional types
getTypeScriptTypeWithNull :: forall a. TypeScript a => Proxy a -> String
getTypeScriptTypeWithNull p =
let baseType = getTypeScriptType p
in if getTypeScriptOptional p
then baseType <> " | null"
else baseType

instance {-# OVERLAPPABLE #-} (TypeScript a) => TypeScript [a] where
getTypeScriptType _ = (getTypeScriptType (Proxy :: Proxy a)) ++ "[]"
getParentTypes _ = [TSType (Proxy :: Proxy a)]
Expand All @@ -122,20 +130,20 @@ instance (TypeScript a, TypeScript b) => TypeScript (Either a b) where
]

instance (TypeScript a, TypeScript b) => TypeScript (a, b) where
getTypeScriptType _ = [i|[#{getTypeScriptType (Proxy :: Proxy a)}, #{getTypeScriptType (Proxy :: Proxy b)}]|]
getTypeScriptType _ = [i|[#{getTypeScriptTypeWithNull (Proxy :: Proxy a)}, #{getTypeScriptTypeWithNull (Proxy :: Proxy b)}]|]
getParentTypes _ = L.nub [ (TSType (Proxy :: Proxy a))
, (TSType (Proxy :: Proxy b))
]

instance (TypeScript a, TypeScript b, TypeScript c) => TypeScript (a, b, c) where
getTypeScriptType _ = [i|[#{getTypeScriptType (Proxy :: Proxy a)}, #{getTypeScriptType (Proxy :: Proxy b)}, #{getTypeScriptType (Proxy :: Proxy c)}]|]
getTypeScriptType _ = [i|[#{getTypeScriptTypeWithNull (Proxy :: Proxy a)}, #{getTypeScriptTypeWithNull (Proxy :: Proxy b)}, #{getTypeScriptTypeWithNull (Proxy :: Proxy c)}]|]
getParentTypes _ = L.nub [ (TSType (Proxy :: Proxy a))
, (TSType (Proxy :: Proxy b))
, (TSType (Proxy :: Proxy c))
]

instance (TypeScript a, TypeScript b, TypeScript c, TypeScript d) => TypeScript (a, b, c, d) where
getTypeScriptType _ = [i|[#{getTypeScriptType (Proxy :: Proxy a)}, #{getTypeScriptType (Proxy :: Proxy b)}, #{getTypeScriptType (Proxy :: Proxy c)}, #{getTypeScriptType (Proxy :: Proxy d)}]|]
getTypeScriptType _ = [i|[#{getTypeScriptTypeWithNull (Proxy :: Proxy a)}, #{getTypeScriptTypeWithNull (Proxy :: Proxy b)}, #{getTypeScriptTypeWithNull (Proxy :: Proxy c)}, #{getTypeScriptTypeWithNull (Proxy :: Proxy d)}]|]
getParentTypes _ = L.nub [ (TSType (Proxy :: Proxy a))
, (TSType (Proxy :: Proxy b))
, (TSType (Proxy :: Proxy c))
Expand Down
14 changes: 14 additions & 0 deletions test/Generic.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ $(deriveTypeScript defaultOptions ''Complex3)
data Complex4 k = Product4 { record4 :: Map Text k }
$(deriveTypeScript defaultOptions ''Complex4)

-- Test for Maybe inside tuple
data TestMaybeTuple
= ConWithMaybe Text [Int] (Maybe [String])
| SimpleConstructor Text
deriving (Show, Eq)
$(deriveTypeScript defaultOptions ''TestMaybeTuple)

tests :: SpecWith ()
tests = describe "Generic instances" $ do
it [i|Complex makes the declaration and types correctly|] $ do
Expand Down Expand Up @@ -57,5 +64,12 @@ tests = describe "Generic instances" $ do
,TSTypeAlternatives "Complex4" ["T"] ["IProduct4<T>"] Nothing
]

it [i|TestMaybeTuple should handle Maybe in tuples correctly|] $ do
(getTypeScriptDeclarationsRecursively (Proxy :: Proxy TestMaybeTuple)) `shouldBe` [
TSInterfaceDeclaration "IConWithMaybe" [] [TSField False "tag" "\"ConWithMaybe\"" Nothing, TSField False "contents" "[string, number[], string[] | null]" Nothing] Nothing
,TSInterfaceDeclaration "ISimpleConstructor" [] [TSField False "tag" "\"SimpleConstructor\"" Nothing, TSField False "contents" "string" Nothing] Nothing
,TSTypeAlternatives "TestMaybeTuple" [] ["IConWithMaybe","ISimpleConstructor"] Nothing
]

main :: IO ()
main = hspec tests