Refactor: clojure-SDK Converting to the new ADR and some improvements

- moved clj-kondo config to allows other lib to use the
  starfederation.datastar.clojure ns for their clj-kondo configs.
- refactored the base SDK unit tests

Author: JeremS

examples/clojure/hello-world/src/main/example/core.clj

@@ -46,7 +46,7 @@
        (fn [sse]
          (d*/with-open-sse sse
            (dotimes [i msg-count]
-             (d*/merge-fragment! sse (->frag i))
+             (d*/patch-elements! sse (->frag i))
              (Thread/sleep d))))})))
 
 

sdk/clojure/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Release notes for the Clojure SDK
 
+## 2025-06-22
+
+### Changed
+
+- The public API has seen it's main functions renamed following the new SDK ADR.
+  Several functions have been renamed or removed:
+
+  | Old                 | new                   |
+  | ------------------- | --------------------- |
+  | `merge-fragment!`   | `patch-elements!`     |
+  | `merge-fragments!`  | `patch-elements-seq!` |
+  | `remove-fragments!` | `remove-element!`     |
+  | `merge-signals!`    | `patch-signals!`      |
+  | `remove-signals`    | removed               |
+
+- All the examples and snippets have been updated following the ADR changes.
+
+### Fixed
+
+- The clj-kondo config file for the SDK has been moved in a
+  `clj-kondo.exports/starfederation.datastar.clojure/sdk` directory. This change
+  allows for other projects to use
+  `starfederation.datastar.clojure/XXXX/config.edn` for their clj-kondo config.
+
 ## 2025-04-07
 
 ### Added

sdk/clojure/README.md

@@ -93,7 +93,7 @@ Using the adapter you create ring responses in your handlers:
   (hk-gen/->sse-response request
     {hk-gen/on-open
      (fn [sse-gen]
-       (d*/merge-fragment! sse-gen "<div>test</div>")
+       (d*/patch-elements! sse-gen "<div>test</div>")
        (d*/close-sse! sse-gen))}))
 
 ```
@@ -118,9 +118,9 @@ it somewhere and use it later:
        (swap! !connections disj sse-gen))}))
 
 
-(defn broadcast-fragment! [fragment]
+(defn broadcast-elements! [elements]
   (doseq [c @!connections]
-    (d*/merge-fragment! c fragment)))
+    (d*/patch-elements! c elements)))
 
 ```
 

sdk/clojure/deps.edn

@@ -1,6 +1,7 @@
 {:paths []
 
  :deps {sdk/sdk                             {:local/root "./sdk"}
+        io.github.tonsky/clojure-plus       {:mvn/version "1.6.1"}
         io.github.paintparty/fireworks      {:mvn/version "0.10.4"}
         com.taoensso/telemere               {:mvn/version "1.0.0-RC3"}
         com.aayushatharva.brotli4j/brotli4j {:mvn/version "1.18.0"}}

sdk/clojure/doc/Write-profiles.md

@@ -47,7 +47,7 @@ When using the `->sse-response` function we can do:
      on-open
      (fn [sse]
        (d*/with-open-sse sse
-         (d*/merge-fragment! sse "some big fragment")))}))
+         (d*/patch-elements! sse "some big element")))}))
 ```
 
 This response will have the right `Content-Encoding` header and will compress

sdk/clojure/doc/maintainers-guide.md

@@ -5,6 +5,9 @@
 In the whole Datastar project:
 
 - `examples/clojure`
+- `site/static/code_snippets/*.clojuresnippet`
+- `site/static/going_deeper/*.clojuresnippet`
+- `site/static/how_tos/*.clojuresnippet`
 
 In the SDK code proper `sdk/clojure`:
 
@@ -50,9 +53,9 @@ In the SDK code proper `sdk/clojure`:
 - The Clojars account is managed by Ben Croker, the DNS verification is managed by Delaney.
 - The Clojars deploy token is also managed by Ben and added to this repo as a GH Actions Secret
   - Secret name: `CLOJARS_USERNAME`
-    Value: *the clojars account username*
+    Value: _the clojars account username_
   - Secret name: `CLOJARS_PASSWORD`
-    Value: *the clojars deploy token*
+    Value: _the clojars deploy token_
 - The libraries' versions are bumped in lockstep so that there is no confusion over which version of the common lib should be used with an adapter lib.
 
 The Github Actions [CI workflow for clojure](../../.github/workflows/clojure-sdk.yml) will always run the tests and produce jar artifacts.

sdk/clojure/malli-schemas/src/main/starfederation/datastar/clojure/api/common_schemas.clj

@@ -12,11 +12,8 @@
 
 (def event-type-schema
   [:enum
-   consts/event-type-merge-fragments
-   consts/event-type-remove-fragments
-   consts/event-type-merge-signals
-   consts/event-type-remove-signals
-   consts/event-type-execute-script])
+   consts/event-type-patch-elements
+   consts/event-type-patch-signals])
 
 (def data-lines-schema [:seqable :string])
 
@@ -32,50 +29,45 @@
   (m/validate sse-options-schema {common/id 1}))
 
 ;; -----------------------------------------------------------------------------
-(def fragment-schema :string)
-(def fragments-schema [:seqable :string])
+(def elements-schema :string)
+(def elements-seq-schema [:seqable :string])
 
 
-(def merge-modes-schema
+(def patch-modes-schema
   [:enum
-   consts/fragment-merge-mode-morph
-   consts/fragment-merge-mode-inner
-   consts/fragment-merge-mode-outer
-   consts/fragment-merge-mode-prepend
-   consts/fragment-merge-mode-append
-   consts/fragment-merge-mode-before
-   consts/fragment-merge-mode-after
-   consts/fragment-merge-mode-upsert-attributes])
+   consts/element-patch-mode-outer
+   consts/element-patch-mode-inner
+   consts/element-patch-mode-replace
+   consts/element-patch-mode-prepend
+   consts/element-patch-mode-append
+   consts/element-patch-mode-before
+   consts/element-patch-mode-after
+   consts/element-patch-mode-remove])
 
 (comment
-  (m/validate merge-modes-schema consts/fragment-merge-mode-after)
-  (m/validate merge-modes-schema "toto"))
+  (m/validate patch-modes-schema consts/element-patch-mode-after)
+  (m/validate patch-modes-schema "toto"))
 
 
-(def merge-fragment-options-schemas
+(def patch-element-options-schemas
   (mu/merge
     sse-options-schema
     (mu/optional-keys
       [:map
        [common/selector :string]
-       [common/merge-mode merge-modes-schema]
+       [common/patch-mode patch-modes-schema]
        [common/use-view-transition :boolean]])))
 
 ;; -----------------------------------------------------------------------------
 (def selector-schema :string)
 
-(def remove-fragments-options-schemas
-  (mu/merge
-    sse-options-schema
-    (mu/optional-keys
-      [:map
-       [common/use-view-transition :boolean]])))
+(def remove-element-options-schemas patch-element-options-schemas)
 
 
 ;; -----------------------------------------------------------------------------
 (def signals-schema :string)
 
-(def merge-signals-options-schemas
+(def patch-signals-options-schemas
   (mu/merge
     sse-options-schema
     (mu/optional-keys
@@ -86,8 +78,6 @@
 ;; -----------------------------------------------------------------------------
 (def signal-paths-schema [:seqable :string])
 
-(def remove-signals-options-schemas sse-options-schema)
-
 ;; -----------------------------------------------------------------------------
 (def script-content-schema :string)
 

sdk/clojure/malli-schemas/src/main/starfederation/datastar/clojure/api/elements_schemas.clj

@@ -0,0 +1,14 @@
+(ns starfederation.datastar.clojure.api.elements-schemas
+  (:require
+    [malli.core :as m]
+    [starfederation.datastar.clojure.api.common-schemas :as cs]
+    [starfederation.datastar.clojure.api.elements]))
+
+
+(m/=> starfederation.datastar.clojure.api.elements/->patch-elements
+      [:-> cs/elements-schema cs/patch-element-options-schemas cs/data-lines-schema])
+
+
+(m/=> starfederation.datastar.clojure.api.elements/->patch-elements-seq
+      [:-> cs/elements-seq-schema cs/patch-element-options-schemas cs/data-lines-schema])
+

sdk/clojure/malli-schemas/src/main/starfederation/datastar/clojure/api/fragments_schemas.clj

@@ -4,6 +4,6 @@
     [starfederation.datastar.clojure.api.common-schemas :as cs]
     [starfederation.datastar.clojure.api.scripts]))
 
-(m/=> starfederation.datastar.clojure.api.scripts/->script
-      [:-> cs/script-content-schema cs/execute-script-options-schemas cs/data-lines-schema])
+(m/=> starfederation.datastar.clojure.api.scripts/->script-tag
+      [:-> cs/script-content-schema cs/execute-script-options-schemas :string])