Fully type options

Author: Connor Prussin

bower.json

@@ -20,6 +20,7 @@
     "purescript-node-url": "^3.0.0",
     "purescript-options": "^3.0.0",
     "purescript-unsafe-coerce": "^3.0.0",
-    "purescript-node-buffer": "^3.0.1"
+    "purescript-node-buffer": "^3.0.1",
+    "purescript-arraybuffer-types": "^2.0.0"
   }
 }

src/Node/HTTP/HTTPS.purs

@@ -7,19 +7,27 @@ module Node.HTTP.HTTPS
   , handshakeTimeout
   , requestCert
   , rejectUnauthorized
+  , NPNProtocols(..)
   , npnProtocols
+  , ALPNProtocols(..)
   , alpnProtocols
   , sessionTimeout
   , ticketKeys
+  , PFX(..)
   , pfx
+  , Key(..)
   , key
   , passphrase
+  , Cert(..)
   , cert
+  , CA(..)
   , ca
+  , CRL(..)
   , crl
   , ciphers
   , honorCipherOrder
   , ecdhCurve
+  , DHParam(..)
   , dhparam
   , secureProtocol
   , secureOptions
@@ -29,8 +37,10 @@ module Node.HTTP.HTTPS
 import Prelude
 
 import Control.Monad.Eff (Eff)
+import Data.ArrayBuffer.Types (Uint8Array)
+import Data.Foreign (Foreign, toForeign)
+import Data.Functor.Contravariant (cmap)
 import Data.Options (Options, Option, options, opt)
-import Data.Foreign (Foreign)
 import Node.Buffer (Buffer)
 import Node.HTTP (Request, Response, Server, HTTP)
 
@@ -49,17 +59,47 @@ requestCert = opt "requestCert"
 rejectUnauthorized :: Option SSLOptions Boolean
 rejectUnauthorized = opt "rejectUnauthorized"
 
--- | The type variable t should be a string[], Buffer[], Uint8Array[], Buffer,
--- | or Uint8Array.
+-- | The npnProtocols option can be a String, a Buffer, a Uint8Array, or an
+-- | array of any of those types.
+data NPNProtocols
+  = NPNProtocolsString String
+  | NPNProtocolsBuffer Buffer
+  | NPNProtocolsUint8Array Uint8Array
+  | NPNProtocolsStringArray (Array String)
+  | NPNProtocolsBufferArray (Array Buffer)
+  | NPNProtocolsUint8ArrayArray (Array Uint8Array)
+
 -- | See the [node docs](https://nodejs.org/api/tls.html#tls_tls_createserver_options_secureconnectionlistener)
-npnProtocols :: forall t. Option SSLOptions t
-npnProtocols = opt "NPNProtocols"
+npnProtocols :: Option SSLOptions NPNProtocols
+npnProtocols = cmap extract $ opt "NPNProtocols"
+  where
+    extract (NPNProtocolsString s) = toForeign s
+    extract (NPNProtocolsBuffer b) = toForeign b
+    extract (NPNProtocolsUint8Array u) = toForeign u
+    extract (NPNProtocolsStringArray sa) = toForeign sa
+    extract (NPNProtocolsBufferArray ba) = toForeign ba
+    extract (NPNProtocolsUint8ArrayArray ua) = toForeign ua
+
+-- | The alpnProtocols option can be a String, a Buffer, a Uint8Array, or an
+-- | array of any of those types.
+data ALPNProtocols
+  = ALPNProtocolsString String
+  | ALPNProtocolsBuffer Buffer
+  | ALPNProtocolsUint8Array Uint8Array
+  | ALPNProtocolsStringArray (Array String)
+  | ALPNProtocolsBufferArray (Array Buffer)
+  | ALPNProtocolsUint8ArrayArray (Array Uint8Array)
 
--- | The type variable t should be a string[], Buffer[], Uint8Array[], Buffer,
--- | or Uint8Array.
 -- | See the [node docs](https://nodejs.org/api/tls.html#tls_tls_createserver_options_secureconnectionlistener)
-alpnProtocols :: forall t. Option SSLOptions t
-alpnProtocols = opt "ALPNProtocols"
+alpnProtocols :: Option SSLOptions ALPNProtocols
+alpnProtocols = cmap extract $ opt "ALPNProtocols"
+  where
+    extract (ALPNProtocolsString s) = toForeign s
+    extract (ALPNProtocolsBuffer b) = toForeign b
+    extract (ALPNProtocolsUint8Array u) = toForeign u
+    extract (ALPNProtocolsStringArray sa) = toForeign sa
+    extract (ALPNProtocolsBufferArray ba) = toForeign ba
+    extract (ALPNProtocolsUint8ArrayArray ua) = toForeign ua
 
 -- | See the [node docs](https://nodejs.org/api/tls.html#tls_tls_createserver_options_secureconnectionlistener)
 sessionTimeout :: Option SSLOptions Int
@@ -69,35 +109,87 @@ sessionTimeout = opt "sessionTimeout"
 ticketKeys :: Option SSLOptions Buffer
 ticketKeys = opt "ticketKeys"
 
--- | The type variable t should be a string or Buffer.
+-- | The PFX option can take either a String or a Buffer
+data PFX = PFXString String | PFXBuffer Buffer
+
 -- | See the [node docs](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options)
-pfx :: forall t. Option SSLOptions t
-pfx = opt "pfx"
+pfx :: Option SSLOptions PFX
+pfx = cmap extract $ opt "pfx"
+  where
+    extract (PFXString s) = toForeign s
+    extract (PFXBuffer b) = toForeign b
+
+-- | The key option can be a String, a Buffer, an array of strings, or an array
+-- | of buffers.
+data Key
+  = KeyString String
+  | KeyBuffer Buffer
+  | KeyStringArray (Array String)
+  | KeyBufferArray (Array Buffer)
 
--- | The type variable t should be a string, string[], Buffer, Buffer[], or
--- | Object[].
 -- | See the [node docs](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options)
-key :: forall t. Option SSLOptions t
-key = opt "key"
+key :: Option SSLOptions Key
+key = cmap extract $ opt "key"
+  where
+    extract (KeyString s) = toForeign s
+    extract (KeyBuffer b) = toForeign b
+    extract (KeyStringArray sa) = toForeign sa
+    extract (KeyBufferArray ba) = toForeign ba
 
 -- | See the [node docs](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options)
 passphrase :: Option SSLOptions String
 passphrase = opt "passphrase"
 
--- | The type variable t should be a string, string[], Buffer, or Buffer[].
+-- | The cert option can be a String, a Buffer, an array of strings, or an array
+-- | of buffers.
+data Cert
+  = CertString String
+  | CertBuffer Buffer
+  | CertStringArray (Array String)
+  | CertBufferArray (Array Buffer)
+
 -- | See the [node docs](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options)
-cert :: forall t. Option SSLOptions t
-cert = opt "cert"
+cert :: Option SSLOptions Cert
+cert = cmap extract $ opt "cert"
+  where
+    extract (CertString s) = toForeign s
+    extract (CertBuffer b) = toForeign b
+    extract (CertStringArray sa) = toForeign sa
+    extract (CertBufferArray ba) = toForeign ba
+
+-- | The CA option can be a String, a Buffer, an array of strings, or an array
+-- | of buffers.
+data CA
+  = CAString String
+  | CABuffer Buffer
+  | CAStringArray (Array String)
+  | CABufferArray (Array Buffer)
 
--- | The type variable t should be a string, string[], Buffer, or Buffer[].
 -- | See the [node docs](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options)
-ca :: forall t. Option SSLOptions t
-ca = opt "ca"
+ca :: Option SSLOptions CA
+ca = cmap extract $ opt "ca"
+  where
+    extract (CAString s) = toForeign s
+    extract (CABuffer b) = toForeign b
+    extract (CAStringArray sa) = toForeign sa
+    extract (CABufferArray ba) = toForeign ba
+
+-- | The CRL option can be a String, a Buffer, an array of strings, or an array
+-- | of buffers.
+data CRL
+  = CRLString String
+  | CRLBuffer Buffer
+  | CRLStringArray (Array String)
+  | CRLBufferArray (Array Buffer)
 
--- | The type variable t should be a string, string[], Buffer, or Buffer[].
 -- | See the [node docs](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options)
-crl :: forall t. Option SSLOptions t
-crl = opt "crl"
+crl :: Option SSLOptions CRL
+crl = cmap extract $ opt "crl"
+  where
+    extract (CRLString s) = toForeign s
+    extract (CRLBuffer b) = toForeign b
+    extract (CRLStringArray sa) = toForeign sa
+    extract (CRLBufferArray ba) = toForeign ba
 
 -- | See the [node docs](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options)
 ciphers :: Option SSLOptions String
@@ -111,10 +203,15 @@ honorCipherOrder = opt "honorCipherOrder"
 ecdhCurve :: Option SSLOptions String
 ecdhCurve = opt "ecdhCurve"
 
--- | The type variable t should be a string or Buffer.
+-- | The DHParam option can take either a String or a Buffer
+data DHParam = DHParamString String | DHParamBuffer Buffer
+
 -- | See the [node docs](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options)
-dhparam :: forall t. Option SSLOptions t
-dhparam = opt "dhparam"
+dhparam :: Option SSLOptions DHParam
+dhparam = cmap extract $ opt "dhparam"
+  where
+    extract (DHParamString s) = toForeign s
+    extract (DHParamBuffer b) = toForeign b
 
 -- | See the [node docs](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options)
 secureProtocol :: Option SSLOptions String
@@ -128,6 +225,8 @@ secureOptions = opt "secureOptions"
 sessionIdContext :: Option SSLOptions String
 sessionIdContext = opt "sessionIdContext"
 
+-- | Create an HTTPS server, given the SSL options and a function to be executed
+-- | when a request is received.
 foreign import createServerImpl ::
   forall eff.
   Foreign ->

test/Main.purs

@@ -110,7 +110,7 @@ TbGfXbnVfNmqgQh71+k02p6S
 
 testHttpsServer :: forall eff. Eff (console :: CONSOLE, http :: HTTP | eff) Unit
 testHttpsServer = do
-  server <- HTTPS.createServer (HTTPS.key := mockKey <> HTTPS.cert := mockCert) respond
+  server <- HTTPS.createServer sslOpts respond
   listen server { hostname: "localhost", port: 8081, backlog: Nothing } $ void do
     log "Listening on port 8081."
     complexReq $
@@ -120,6 +120,10 @@ testHttpsServer = do
       Client.port := 8081 <>
       Client.path := "/" <>
       Client.rejectUnauthorized := false
+  where
+    sslOpts =
+      HTTPS.key := HTTPS.KeyString mockKey <>
+      HTTPS.cert := HTTPS.CertString mockCert
 
 testHttps :: forall eff. Eff (console :: CONSOLE, http :: HTTP | eff) Unit
 testHttps =