Merge pull request 'htmx v2-beta4' (#12) from v2-beta4 into main

Reviewed-on: #12

README.md

@@ -25,9 +25,10 @@ A server may want to respond to a request that originated from htmx differently
 // "view" can be whatever your view engine needs for the body of the page
 let result view : HttpHandler =
     fun next ctx ->
-      match ctx.Request.IsHtmx && not ctx.Request.IsHtmxRefresh with
-      | true -> partial view
-      | false -> full view
+        if ctx.Request.IsHtmx && not ctx.Request.IsHtmxRefresh then
+            partial view
+        else
+            full view
 ```
 
 htmx also utilizes [response headers](https://htmx.org/docs/#response_headers) to affect client-side behavior. For each of these, this library provides `HttpHandler`s that can be chained along with the response. As an example, if the server returns a redirect response (301, 302, 303, 307), the `XMLHttpRequest` handler on the client will follow the redirection before htmx can do anything with it. To redirect to a new page, you would return an OK (200) response with an `HX-Redirect` header set in the response.
@@ -49,7 +50,9 @@ As an example, creating a `div` that loads data once the HTML is rendered:
 
 ```fsharp
 let autoload =
-    div [ _hxGet "/lazy-load-data"; _hxTrigger "load" ] [ str "Loading..." ]
+    div [ _hxGet "/lazy-load-data"; _hxTrigger HxTrigger.Load ] [
+        str "Loading..."
+    ]
 ```
 
 _(As `hx-boost="true"` is the usual desire for boosting, `_hxBoost` implies true. To disable it for an element, use `_hxNoBoost` instead.)_

src/Common/README.md

@@ -2,4 +2,4 @@
 
 This package contains common code shared between [`Giraffe.Htmx`](https://www.nuget.org/packages/Giraffe.Htmx) and [`Giraffe.ViewEngine.Htmx`](https://www.nuget.org/packages/Giraffe.ViewEngine.Htmx), and will be automatically installed when you install either one.
 
-**htmx version: 1.9.12**
+**htmx version: 2.0.0-beta4**

src/Directory.Build.props

@@ -2,8 +2,9 @@
 <Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
     <PropertyGroup>
         <TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
-        <VersionPrefix>1.9.12</VersionPrefix>
-        <PackageReleaseNotes>Update script tags to pull htmx 1.9.12</PackageReleaseNotes>
+        <VersionPrefix>2.0.0</VersionPrefix>
+        <VersionSuffix>beta4</VersionSuffix>
+        <PackageReleaseNotes>Update script tags to pull htmx 2.0.0-beta4; add SSE attributes</PackageReleaseNotes>
         <Authors>danieljsummers</Authors>
         <Company>Bit Badger Solutions</Company>
         <PackageProjectUrl>https://git.bitbadger.solutions/bit-badger/Giraffe.Htmx</PackageProjectUrl>
@@ -12,6 +13,6 @@
         <RepositoryType>Git</RepositoryType>
         <Copyright>MIT License</Copyright>
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
-        <PackageTags>Giraffe htmx</PackageTags>
+        <PackageTags>Giraffe htmx beta</PackageTags>
     </PropertyGroup>
 </Project>

src/Htmx/README.md

@@ -2,11 +2,13 @@
 
 This package enables server-side support for [htmx](https://htmx.org) within [Giraffe](https://giraffe.wiki) and ASP.NET's `HttpContext`.
 
-**htmx version: 1.9.12**
+**htmx version: 2.0.0-beta4**
+
+_Note that htmx 2.0 is a BETA release. The [migration guide](https://v2-0v2-0.htmx.org/migration-guide-htmx-1/) does not currently specify any request or response header changes. This means that, as of this release, there are no required code changes in moving to this major version._
 
 ### Setup
 
-1. Install the package.
+1. Install the package (must use `--Prerelease` flag).
 2. Prior to using the request header extension properties or the header-setting `HttpHandler`s, `open Giraffe.Htmx`.
 
 ### Use

src/Tests/ViewEngine.fs

@@ -811,6 +811,12 @@ let attributes =
         test "_hxWs succeeds" {
             ul [ _hxWs "connect:/web-socket" ] [] |> shouldRender """<ul hx-ws="connect:/web-socket"></ul>"""
         }
+        test "_sseSwap succeeds" {
+            ul [ _sseSwap "sseMessageName" ] [] |> shouldRender """<ul sse-swap="sseMessageName"></ul>"""
+        }
+        test "_sseConnect succeeds" {
+            div [ _sseConnect "/gps/sse" ] [] |> shouldRender """<div sse-connect="/gps/sse"></div>"""
+        }
     ]
 
 /// Tests for the Script module
@@ -820,14 +826,14 @@ let script =
             let html = RenderView.AsString.htmlNode Script.minified
             Expect.equal
                 html
-                """<script src="https://unpkg.com/htmx.org@1.9.12" integrity="sha384-ujb1lZYygJmzgSwoxRggbCHcjc0rB2XoQrxeTUQyRjrOnlCoYta87iKBWq3EsdM2" crossorigin="anonymous"></script>"""
+                """<script src="https://unpkg.com/htmx.org@2.0.0-beta4" integrity="sha384-QprZjU1JKuXu/TnlURCTYppToUjigoOZCrzQtRXAjHttxoV9gkqiizVeAwjeGy1f" crossorigin="anonymous"></script>"""
                 "Minified script tag is incorrect"
         }
         test "unminified succeeds" {
             let html = RenderView.AsString.htmlNode Script.unminified
             Expect.equal
                 html
-                """<script src="https://unpkg.com/htmx.org@1.9.12/dist/htmx.js" integrity="sha384-qbtR4rS9RrUMECUWDWM2+YGgN3U4V4ZncZ0BvUcg9FGct0jqXz3PUdVpU1p0yrXS" crossorigin="anonymous"></script>"""
+                """<script src="https://unpkg.com/htmx.org@2.0.0-beta4/dist/htmx.js" integrity="sha384-n/53Us+nZur0snldc6yl7W3paw5/sbtpXhImQJk9JZf0KQjzCP6lbBWmAtFsCSb9" crossorigin="anonymous"></script>"""
                 "Unminified script tag is incorrect"
         }
     ]
@@ -979,18 +985,6 @@ let renderFragment =
         ]
     ]
 
-#nowarn "44"
-
-/// Tests for the HtmxAttrs module
-let deprecatedAttributes =
-    testList "Deprecated Attributes" [
-        test "_hxOn succeeds" {
-            let newLine = "\n"
-            strong [ _hxOn "submit: alert('oops')\nclick: alert('howdy!')" ] []
-            |> shouldRender $"""<strong hx-on="submit: alert(&#39;oops&#39;){newLine}click: alert(&#39;howdy!&#39;)"></strong>"""
-        }
-    ]
-
 /// All tests in this module
 let allTests =
     testList "ViewEngine.Htmx" [
@@ -1004,5 +998,4 @@ let allTests =
         attributes
         script
         renderFragment
-        deprecatedAttributes
     ]

src/ViewEngine.Htmx/Htmx.fs

@@ -317,7 +317,6 @@ module HxVals =
     /// Create values from a list of key/value pairs
     let From = toJson
 
-open System
 
 /// Attributes and flags for htmx
 [<AutoOpen>]
@@ -368,10 +367,6 @@ module HtmxAttrs =
     /// Overrides a previous `hx-boost`
     let _hxNoBoost    = attr "hx-boost" "false"
     
-    /// Attach an event handler for DOM or htmx events
-    [<Obsolete "This will be removed in htmx 2; use _hxOnEvent or _hxOnHxEvent instead">]
-    let _hxOn         = attr "hx-on"
-
     /// Attach an event handler for DOM events
     let _hxOnEvent evtName =
         attr $"hx-on:%s{evtName}"
@@ -444,20 +439,26 @@ module HtmxAttrs =
     /// Establishes a WebSocket or sends information to one
     let _hxWs         = attr "hx-ws"
 
+    /// The name of the message to swap into the DOM.
+    let _sseSwap      = attr "sse-swap"
+
+    /// The URL of the SSE server.
+    let _sseConnect   = attr "sse-connect"
+
 
 /// Script tags to pull htmx into an web page
 module Script =
   
     /// Script tag to load the minified version from unpkg.com
     let minified =
-        script [ _src         "https://unpkg.com/htmx.org@1.9.12"
-                 _integrity   "sha384-ujb1lZYygJmzgSwoxRggbCHcjc0rB2XoQrxeTUQyRjrOnlCoYta87iKBWq3EsdM2"
+        script [ _src         "https://unpkg.com/htmx.org@2.0.0-beta4"
+                 _integrity   "sha384-QprZjU1JKuXu/TnlURCTYppToUjigoOZCrzQtRXAjHttxoV9gkqiizVeAwjeGy1f"
                  _crossorigin "anonymous" ] []
 
     /// Script tag to load the unminified version from unpkg.com
     let unminified =
-        script [ _src         "https://unpkg.com/htmx.org@1.9.12/dist/htmx.js"
-                 _integrity   "sha384-qbtR4rS9RrUMECUWDWM2+YGgN3U4V4ZncZ0BvUcg9FGct0jqXz3PUdVpU1p0yrXS"
+        script [ _src         "https://unpkg.com/htmx.org@2.0.0-beta4/dist/htmx.js"
+                 _integrity   "sha384-n/53Us+nZur0snldc6yl7W3paw5/sbtpXhImQJk9JZf0KQjzCP6lbBWmAtFsCSb9"
                  _crossorigin "anonymous" ] []
 
 

src/ViewEngine.Htmx/README.md

@@ -2,11 +2,13 @@
 
 This package enables [htmx](https://htmx.org) support within the [Giraffe](https://giraffe.wiki) view engine.
 
-**htmx version: 1.9.12**
+**htmx version: 2.0.0-beta4**
+
+_Note that this is a BETA release of htmx 2.0; see [the migration guide](https://v2-0v2-0.htmx.org/migration-guide-htmx-1/) for changes_
 
 ### Setup
 
-1. Install the package.
+1. Install the package (must use `--Prerelease` flag).
 2. Prior to using the attribute or support modules, `open Giraffe.ViewEngine.Htmx`.
 
 ### Use