first commit

.gitignore

@@ -0,0 +1,2 @@
+.stack-work/
+*~

ChangeLog.md

@@ -0,0 +1,3 @@
+# Changelog for servant-htmx
+
+## Unreleased changes

LICENSE

@@ -0,0 +1,30 @@
+Copyright Author name here (c) 2022
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of Author name here nor the names of other
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1 @@
+# servant-htmx

Setup.hs

@@ -0,0 +1,2 @@
+import Distribution.Simple
+main = defaultMain

app/Main.hs

@@ -0,0 +1,6 @@
+module Main where
+
+import Lib
+
+main :: IO ()
+main = someFunc

package.yaml

@@ -0,0 +1,52 @@
+name:                servant-htmx
+version:             0.1.0.0
+github:              "githubuser/servant-htmx"
+license:             BSD3
+author:              "Author name here"
+maintainer:          "[email protected]"
+copyright:           "2022 Author name here"
+
+extra-source-files:
+- README.md
+- ChangeLog.md
+
+# Metadata used when publishing your package
+# synopsis:            Short description of your package
+# category:            Web
+
+# To avoid duplicated efforts in documentation and dealing with the
+# complications of embedding Haddock markup inside cabal files, it is
+# common to point users to the README.md file.
+description:         Please see the README on GitHub at <https://github.com/githubuser/servant-htmx#readme>
+
+dependencies:
+- base >= 4.7 && < 5
+- aeson
+- servant
+- servant-server
+- text
+
+library:
+  source-dirs: src
+
+executables:
+  servant-htmx-exe:
+    main:                Main.hs
+    source-dirs:         app
+    ghc-options:
+    - -threaded
+    - -rtsopts
+    - -with-rtsopts=-N
+    dependencies:
+    - servant-htmx
+
+tests:
+  servant-htmx-test:
+    main:                Spec.hs
+    source-dirs:         test
+    ghc-options:
+    - -threaded
+    - -rtsopts
+    - -with-rtsopts=-N
+    dependencies:
+    - servant-htmx

servant-htmx.cabal

@@ -0,0 +1,73 @@
+cabal-version: 1.12
+
+-- This file has been generated from package.yaml by hpack version 0.34.4.
+--
+-- see: https://github.com/sol/hpack
+
+name:           servant-htmx
+version:        0.1.0.0
+description:    Please see the README on GitHub at <https://github.com/githubuser/servant-htmx#readme>
+homepage:       https://github.com/githubuser/servant-htmx#readme
+bug-reports:    https://github.com/githubuser/servant-htmx/issues
+author:         Author name here
+maintainer:     [email protected]
+copyright:      2022 Author name here
+license:        BSD3
+license-file:   LICENSE
+build-type:     Simple
+extra-source-files:
+    README.md
+    ChangeLog.md
+
+source-repository head
+  type: git
+  location: https://github.com/githubuser/servant-htmx
+
+library
+  exposed-modules:
+      Lib
+      Servant.HTMX
+  other-modules:
+      Paths_servant_htmx
+  hs-source-dirs:
+      src
+  build-depends:
+      aeson
+    , base >=4.7 && <5
+    , servant
+    , servant-server
+    , text
+  default-language: Haskell2010
+
+executable servant-htmx-exe
+  main-is: Main.hs
+  other-modules:
+      Paths_servant_htmx
+  hs-source-dirs:
+      app
+  ghc-options: -threaded -rtsopts -with-rtsopts=-N
+  build-depends:
+      aeson
+    , base >=4.7 && <5
+    , servant
+    , servant-htmx
+    , servant-server
+    , text
+  default-language: Haskell2010
+
+test-suite servant-htmx-test
+  type: exitcode-stdio-1.0
+  main-is: Spec.hs
+  other-modules:
+      Paths_servant_htmx
+  hs-source-dirs:
+      test
+  ghc-options: -threaded -rtsopts -with-rtsopts=-N
+  build-depends:
+      aeson
+    , base >=4.7 && <5
+    , servant
+    , servant-htmx
+    , servant-server
+    , text
+  default-language: Haskell2010

src/Lib.hs

@@ -0,0 +1,6 @@
+module Lib
+    ( someFunc
+    ) where
+
+someFunc :: IO ()
+someFunc = putStrLn "someFunc"

src/Servant/HTMX.hs

@@ -0,0 +1,51 @@
+{-# LANGUAGE DataKinds #-}
+{-# LANGUAGE TypeOperators #-}
+{-# LANGUAGE OverloadedStrings #-}
+
+module Servant.HTMX where
+
+import Data.Text
+import Servant
+import Servant.API
+import Servant.Server
+
+-- | Request headers (sent by the client to the server)
+type HXRequest = Header "HX-Request" Text
+type HXTriggerId = Header "HX-Trigger" Text
+type HXTriggerName = Header "HX-Trigger-Name" Text
+type HXTarget = Header "HX-Target" Text
+type HXPrompt = Header "HX-Prompt" Text
+
+-- | Response headers (sent by the server to the client)
+type HXPush = Header "HX-Push" Text -- use safelinks
+type HXRedirect = Header "HX-Redirect" Text -- use safelinks
+type HXRefresh = Header "HX-Refresh" Text 
+type HXTrigger = Header "HX-Trigger" Text
+type HXTriggerAfterSwap = Header "HX-Trigger-After-Swap" Text
+type HXTriggerAfterSettle = Header "HX-Trigger-After-Settle" Text
+
+-- | Example usage of htmx header types
+type ExampleAPI = HXRequest :> Get '[JSON] Text
+                :<|> HXTriggerId :> Post '[JSON] Text
+                :<|> "somePath" :> Get '[JSON] (Headers '[HXPush, HXRedirect] Text)
+
+exampleServer :: Server ExampleAPI
+exampleServer = exampleGetHandler
+              :<|> examplePostHandler
+              :<|> exampleSomePathHandler
+  where
+    exampleGetHandler :: Maybe Text -> Handler Text
+    exampleGetHandler mb = case mb of
+      Just "true" -> pure "The request was sent to the server by htmx" 
+      _ -> pure "The request wasn't sent to the server by htmx" 
+
+    examplePostHandler :: Maybe Text -> Handler Text
+    examplePostHandler mb = case mb of
+      Just "adminPanel" -> pure "The request was triggered by the admin panel" 
+      _ -> pure "The request wasn't triggered by the admin panel" 
+
+    exampleSomePathHandler :: Handler (Headers '[HXPush, HXRedirect] Text)
+    exampleSomePathHandler = pure $ noHeader $ addHeader "someURLForRedirect" "This response has htmx headers" 
+
+exampleApp :: Application
+exampleApp = serve (Proxy :: Proxy ExampleAPI) exampleServer

stack.yaml

@@ -0,0 +1,67 @@
+# This file was automatically generated by 'stack init'
+#
+# Some commonly used options have been documented as comments in this file.
+# For advanced use and comprehensive documentation of the format, please see:
+# https://docs.haskellstack.org/en/stable/yaml_configuration/
+
+# Resolver to choose a 'specific' stackage snapshot or a compiler version.
+# A snapshot resolver dictates the compiler version and the set of packages
+# to be used for project dependencies. For example:
+#
+# resolver: lts-3.5
+# resolver: nightly-2015-09-21
+# resolver: ghc-7.10.2
+#
+# The location of a snapshot can be provided as a file or url. Stack assumes
+# a snapshot provided as a file might change, whereas a url resource does not.
+#
+# resolver: ./custom-snapshot.yaml
+# resolver: https://example.com/snapshots/2018-01-01.yaml
+resolver:
+  url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/18/23.yaml
+
+# User packages to be built.
+# Various formats can be used as shown in the example below.
+#
+# packages:
+# - some-directory
+# - https://example.com/foo/bar/baz-0.0.2.tar.gz
+#   subdirs:
+#   - auto-update
+#   - wai
+packages:
+- .
+# Dependency packages to be pulled from upstream that are not in the resolver.
+# These entries can reference officially published versions as well as
+# forks / in-progress versions pinned to a git hash. For example:
+#
+# extra-deps:
+# - acme-missiles-0.3
+# - git: https://github.com/commercialhaskell/stack.git
+#   commit: e7b331f14bcffb8367cd58fbfc8b40ec7642100a
+#
+# extra-deps: []
+
+# Override default flag values for local packages and extra-deps
+# flags: {}
+
+# Extra package databases containing global packages
+# extra-package-dbs: []
+
+# Control whether we use the GHC we find on the path
+# system-ghc: true
+#
+# Require a specific version of stack, using version ranges
+# require-stack-version: -any # Default
+# require-stack-version: ">=2.7"
+#
+# Override the architecture used by stack, especially useful on Windows
+# arch: i386
+# arch: x86_64
+#
+# Extra directories used by stack for building
+# extra-include-dirs: [/path/to/dir]
+# extra-lib-dirs: [/path/to/dir]
+#
+# Allow a newer minor version of GHC than the snapshot specifies
+# compiler-check: newer-minor

stack.yaml.lock

@@ -0,0 +1,13 @@
+# This file was autogenerated by Stack.
+# You should not edit this file by hand.
+# For more information, please see the documentation at:
+#   https://docs.haskellstack.org/en/stable/lock_files
+
+packages: []
+snapshots:
+- completed:
+    size: 587819
+    url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/18/23.yaml
+    sha256: 7f69bb29a57495586e7e3ed31ecc59c0d2c959cb23bd52b71ca676f254c9beb1
+  original:
+    url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/18/23.yaml

test/Spec.hs

@@ -0,0 +1,2 @@
+main :: IO ()
+main = putStrLn "Test suite not yet implemented"