⚠️ **Not actively maintained. Looking for a maintainer or to be incorporated into another project

NOT MAINTAINED: Looking for maintainer or to be incorporated

aeson-generic-ts

Convert Haskell to Typescript in a highly configurable way with Generics

Table of Contents

• Quick Start
• About
• Design Goals
• Full Example
• Flavors
  • Built In
    • Vanilla
    • Fp-Ts
• Roadmap

Quick Start

1. First Derive a generic Instance of a type:

{-# LANGUAGE DataKinds         #-}
{-# LANGUAGE DeriveGeneric     #-}

import           GHC.Generics
import           Data.Text          (Text)

data User =
  User 
    {name :: Text
    ,age  :: Int
    } deriving (Generic, TypescriptType)
  

2. Pick a flavor you'd like to generate the TS with, and run the print function

-- Note here we are using the flavor Vanilla

printUser :: IO ()
printUser =
    putStrLn $ mkTypescriptDeclaration (Proxy :: Proxy Vanilla) (Proxy :: Proxy User)

This prints the following:

interface User {
  name : string
  age  : number
}

Design Goals

Typescript has many ways of doing the same thing, and there are lots of opinions on how to do this. For example, product types can be represented by an interface or (immutable) classes. For this reason, configurability is considered a primary design goal. Here are all of them

1. Ability to customize how Haskell types are represented as TS types

2. Prebaked configurations for the most common ways people like to represent TS types

3. The use of well known libraries as configuration options (built-in flavors). Two examples I will provide default implementations for are fp-ts and unionize

4. A simple interface for providing your own custom translation

Flavors

A flavor is just another name for a type that represents how you want your Typescript customized to. There are currently two supported flavors: Vanilla and FpTS. You can also write your own flavors

Built In Flavors

We will use the following example type to see how it varies across flavors

newtype AnOption = AnOption (Maybe Text) deriving (Generic, TypescriptType)

Vanilla

printVanillaOption =
    putStrLn $ mkTypescriptDeclaration (Proxy :: Proxy Vanilla) (Proxy :: Proxy AnOption)
    
--  type AnOption = null | string

FpTs

printAnOption =
    putStrLn $ mkTypescriptDeclaration (Proxy :: Proxy FpTs) (Proxy :: Proxy AnOption)
    
-- type AnOption = Option<string>

Defining your own flavors

TODO.....

Full Example

The best place for up to date examples is probably just to look at test, but here's a basic one

Given these haskell types:

import Data.Text
import GHC.Generics

data ComplexRecord =
  ComplexRecord
    {anIntField    :: Int
    ,aTextField    :: Text
    ,aUnion        :: SampleUnion
    ,aMaybeType    :: Maybe Text
    ,aSimpleRecord :: SimpleRecord
    } deriving (Generic, TypescriptType)

data SimpleUnTagged = F Int deriving (Generic, TypescriptType)

data SampleUnion = FirstCon Int | SecondCon Text deriving (Generic, TypescriptType)

Specify a flavor to print to TS. Here's an example using the Vanilla Flavor

printComplexRecord :: IO ()
printComplexRecord =
    putStrLn $ mkTypescriptDeclaration (Proxy :: Proxy Vanilla) (Proxy :: Proxy ComplexRecord)

Generates the following typescript types

interface ComplexRecord {
  anIntField : number
  aTextField : string
  aUnion : SampleUnion
  aMaybeType : string | null
  aSimpleRecord : SimpleRecord
}

Roadmap

1. Smart file generators (declarations + imports)
2. More complete FP-TS functionality
3. Unionize library flavor
4. Figure out a cleaner ADT interface for customizing TS
5. I dunno, lots of stuff probably. Make it more production ready I guess