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

Reviewed-on: #12

.github/workflows/ci.yml

@@ -2,9 +2,10 @@ name: CI
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ "main", "htmx-version-2" ]
   pull_request:
     branches: [ "main" ]
+  workflow_dispatch:
 
 jobs:
   build-and-test:
@@ -16,9 +17,9 @@ jobs:
         dotnet-version: [ "6.0", "7.0", "8.0" ]
     
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Setup .NET ${{ matrix.dotnet-version }}.x
-      uses: actions/setup-dotnet@v3
+      uses: actions/setup-dotnet@v4
       with:
         dotnet-version: ${{ matrix.dotnet-version }}.x
     - name: Restore dependencies
@@ -31,11 +32,11 @@ jobs:
     runs-on: ubuntu-latest
     needs: build-and-test
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Setup .NET
-      uses: actions/setup-dotnet@v3
+      uses: actions/setup-dotnet@v4
       with:
-        dotnet-version: "7.0"
+        dotnet-version: "8.0"
     - name: Package Common library
       run: dotnet pack src/Common/Giraffe.Htmx.Common.fsproj -c Release
     - name: Move Common package
@@ -49,7 +50,7 @@ jobs:
     - name: Move View Engine package
       run: cp src/ViewEngine.Htmx/bin/Release/Giraffe.ViewEngine.Htmx.*.nupkg .
     - name: Save Packages
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: packages
         path: |

README.md

@@ -21,22 +21,23 @@ In addition to the regular HTTP request payloads, htmx sets [one or more headers
 A server may want to respond to a request that originated from htmx differently than a regular request. One way htmx can provide the same feel as a Single Page Application (SPA) is by swapping out the `body` content (or an element within it) instead of reloading the entire page. In this case, the developer can provide a partial layout to be used for these responses, while returning the full page for regular requests. The `IsHtmx` property makes this easy...
 
 ```fsharp
-  // "partial" and "full" are handlers that return the contents;
+// "partial" and "full" are handlers that return the contents;
-  // "view" can be whatever your view engine needs for the body of the page
+// "view" can be whatever your view engine needs for the body of the page
-  let result view : HttpHandler =
+let result view : HttpHandler =
     fun next ctx ->
-      match ctx.Request.IsHtmx && not ctx.Request.IsHtmxRefresh with
+        if ctx.Request.IsHtmx && not ctx.Request.IsHtmxRefresh then
-      | true -> partial view
+            partial view
-      | false -> full 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.
 
 ```fsharp
-  let theHandler : HttpHandler =
+let theHandler : HttpHandler =
     fun next ctx ->
-      // some interesting stuff
+        // some interesting stuff
-      withHxRedirect "/the-new-url" >=> Successful.OK
+        withHxRedirect "/the-new-url" >=> Successful.OK
 ```
 
 Of note is that the `HX-Trigger` headers can take either one or more events. For a single event with no parameters, use `withHxTrigger`; for a single event with parameters, or multiple events, use `withHxTriggerMany`. Both these have `AfterSettle` and `AfterSwap` versions as well.
@@ -48,8 +49,10 @@ As htmx uses [attributes](https://htmx.org/docs/#attributes) to extend HTML, the
 As an example, creating a `div` that loads data once the HTML is rendered:
 
 ```fsharp
-  let autoload =
+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.)_
@@ -57,10 +60,10 @@ _(As `hx-boost="true"` is the usual desire for boosting, `_hxBoost` implies true
 Some attributes have known values, such as `hx-trigger` and `hx-swap`; for these, there are modules with those values. For example, `HxTrigger.Load` could be used in the example above, to ensure that the known values are spelled correctly. `hx-trigger` can also take modifiers, such as an action that only responds to `Ctrl`+click. The `HxTrigger` module has a `Filter` submodule to assist with defining these actions.
 
 ```fsharp
-  let shiftClick =
+let shiftClick =
     p [ _hxGet = "/something"; _hxTrigger (HxTrigger.Filter.Shift HxTrigger.Click) ] [
-      str "hold down Shift and click me"
+        str "hold down Shift and click me"
-      ]
+    ]
 ```
 
 If you want to load htmx from unpkg, `Htmx.Script.minified` or `Htmx.Script.unminified` can be used to load the script in your HTML trees.

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.10**
+**htmx version: 2.0.0-beta4**

src/Directory.Build.props

@@ -2,16 +2,17 @@
 <Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
     <PropertyGroup>
         <TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
-        <VersionPrefix>1.9.10</VersionPrefix>
+        <VersionPrefix>2.0.0</VersionPrefix>
-        <PackageReleaseNotes>Update script tags to pull htmx 1.9.10; add support for hx-on:* attributes; require lowest FSharp.Core version; fix _hxDisabledElt spelling</PackageReleaseNotes>
+        <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://github.com/bit-badger/Giraffe.Htmx</PackageProjectUrl>
+        <PackageProjectUrl>https://git.bitbadger.solutions/bit-badger/Giraffe.Htmx</PackageProjectUrl>
         <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
-        <RepositoryUrl>https://github.com/bit-badger/Giraffe.Htmx</RepositoryUrl>
+        <RepositoryUrl>https://git.bitbadger.solutions/bit-badger/Giraffe.Htmx</RepositoryUrl>
         <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.10**
+**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
@@ -14,20 +16,20 @@ This package enables server-side support for [htmx](https://htmx.org) within [Gi
 To obtain a request header, using the `IHeaderDictionary` extension properties:
 
 ```fsharp
-  let myHandler : HttpHander =
+let myHandler : HttpHander =
     fun next ctx ->
-      match ctx.HxPrompt with
+        match ctx.HxPrompt with
-      | Some prompt -> ... // do something with the text the user provided
+        | Some prompt -> ... // do something with the text the user provided
-      | None -> ... // no text provided
+        | None -> ... // no text provided
 ```
 
 To set a response header:
 
 ```fsharp
-  let myHandler : HttpHander =
+let myHandler : HttpHander =
     fun next ctx ->
-      // some meaningful work
+        // some meaningful work
-      withHxPushUrl "/some/new/url" >=> [other handlers]
+        withHxPushUrl "/some/new/url" >=> [other handlers]
 ```
 
 The `HxSwap` module has constants to use for the `HX-Reswap` header. These may be extended with settle, show, and other qualifiers; see the htmx documentation for the `hx-swap` attribute for more information.

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.10" integrity="sha384-D1Kt99CQMDuVetoL1lrYwg5t+9QdHe7NLX/SoJYkXDFfX37iInKRy5xLSi8nO7UC" 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.10/dist/htmx.js" integrity="sha384-j1TtLExqttdT7C3Z/rJy8UZcCGiuqwwN9++coZ6up+5O/l2FHdp3IGfuJOvst6d1" 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.10"
+        script [ _src         "https://unpkg.com/htmx.org@2.0.0-beta4"
-                 _integrity   "sha384-D1Kt99CQMDuVetoL1lrYwg5t+9QdHe7NLX/SoJYkXDFfX37iInKRy5xLSi8nO7UC"
+                 _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.10/dist/htmx.js"
+        script [ _src         "https://unpkg.com/htmx.org@2.0.0-beta4/dist/htmx.js"
-                 _integrity   "sha384-j1TtLExqttdT7C3Z/rJy8UZcCGiuqwwN9++coZ6up+5O/l2FHdp3IGfuJOvst6d1"
+                 _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.10**
+**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
@@ -14,7 +16,7 @@ This package enables [htmx](https://htmx.org) support within the [Giraffe](https
 Following Giraffe View Engine's lead, there are a set of attribute functions for htmx; for many of the attributes, there are also helper modules to assist with typing the values. The example below utilizes both:
 
 ```fsharp
-  let autoload =
+let autoload =
     div [ _hxGet "/this/data"; _hxTrigger HxTrigger.Load ] [ str "Loading..." ]
 ```
 
@@ -43,19 +45,19 @@ The support modules contain named properties for known values (as illustrated wi
 - `HxRequest` has a `Configure` function, which takes a list of strings; the other functions in the module allow for configuring the request.
 
 ```fsharp
-  HxRequest.Configure [ HxRequest.Timeout 500 ] |> _hxRequest 
+HxRequest.Configure [ HxRequest.Timeout 500 ] |> _hxRequest 
 ```
 - `HxTrigger` is _(by far)_ the most complex of these modules. Most uses won't need that complexity; however, complex triggers can be defined by piping into or composing with other functions. For example, to define an event that responds to a shift-click anywhere on the document, with a delay of 3 seconds before firing:
 
 ```fsharp
-  HxTrigger.Click
+HxTrigger.Click
-  |> HxTrigger.Filter.Shift
+|> HxTrigger.Filter.Shift
-  |> HxTrigger.FromDocument
+|> HxTrigger.FromDocument
-  |> HxTrigger.Delay "3s"
+|> HxTrigger.Delay "3s"
-  |> _hxTrigger
+|> _hxTrigger
-  
+
-  // or
+// or
-  
+
-  (HxTrigger.Filter.Shift >> HxTrigger.FromDocument >> HxTrigger.Delay "3s") HxTrigger.Click
+(HxTrigger.Filter.Shift >> HxTrigger.FromDocument >> HxTrigger.Delay "3s") HxTrigger.Click
-  |> _hxTrigger
+|> _hxTrigger
 ```