├── .VERSION_PREFIX ├── .circleci └── config.yml ├── .dir-locals.el ├── .gitignore ├── CHANGELOG.md ├── LICENSE.txt ├── README.md ├── bb.edn ├── bin ├── kaocha ├── proj └── test_server.sh ├── deps.edn ├── dev └── user.clj ├── pom.xml ├── resources └── public │ └── index.html ├── shadow-cljs.edn ├── src └── lambdaisland │ ├── fetch.cljs │ └── fetch │ └── edn.cljs ├── test └── lambdaisland │ └── fetch_test.cljs ├── test_server ├── deps.edn └── fetch_test_server.clj └── tests.edn /.VERSION_PREFIX: -------------------------------------------------------------------------------- 1 | 1.5 -------------------------------------------------------------------------------- /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | version: 2.1 2 | 3 | orbs: 4 | kaocha: lambdaisland/kaocha@0.0.3 5 | clojure: lambdaisland/clojure@0.0.7 6 | 7 | commands: 8 | checkout_and_run: 9 | parameters: 10 | clojure_version: 11 | type: string 12 | steps: 13 | - checkout 14 | - clojure/with_cache: 15 | cache_version: << parameters.clojure_version >> 16 | steps: 17 | - run: apt-get update 18 | - run: 19 | command: ./bin/test_server.sh 20 | background: true 21 | - run: npm install ws node-fetch@2.6.1 22 | - run: sleep 60 23 | - run: curl http://localhost:9999/hello 24 | - kaocha/execute: 25 | args: "node --reporter documentation" 26 | clojure_version: << parameters.clojure_version >> 27 | 28 | jobs: 29 | java-11-clojure-1_10: 30 | executor: clojure/openjdk17 31 | steps: [{checkout_and_run: {clojure_version: "1.11.1"}}] 32 | 33 | workflows: 34 | kaocha_test: 35 | jobs: 36 | - java-11-clojure-1_10 37 | -------------------------------------------------------------------------------- /.dir-locals.el: -------------------------------------------------------------------------------- 1 | ;;; For more information see (info "(emacs) Directory Variables") 2 | ((nil . ((cider-preferred-build-tool . clojure-cli) 3 | (cider-default-cljs-repl . custom) 4 | (cider-custom-cljs-repl-init-form . "(user/cljs-repl)") 5 | (cider-clojure-cli-global-options . "-A:dev:test") 6 | (cider-shadow-default-options . ":dev") 7 | (cider-auto-track-ns-form-changes . nil) 8 | (cider-redirect-server-output-to-repl . t) 9 | (cider-repl-display-help-banner . nil) 10 | (cider-save-file-on-load . nil) 11 | (clojure-toplevel-inside-comment-form . t) 12 | (eval . (progn 13 | (make-variable-buffer-local 'cider-jack-in-nrepl-middlewares) 14 | (add-to-list 'cider-jack-in-nrepl-middlewares "shadow.cljs.devtools.server.nrepl/middleware"))))) 15 | 16 | (clojure . ((eval . (define-clojure-indent 17 | (assoc 0) 18 | (ex-info 0)))))) 19 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .cpcache 2 | .nrepl-port 3 | target 4 | repl 5 | scratch.clj 6 | resources/public/dev 7 | .shadow-cljs 8 | .store 9 | node_modules 10 | out 11 | package-lock.json 12 | package.json 13 | .cljs_node_repl 14 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Unreleased 2 | 3 | ## Added 4 | 5 | ## Fixed 6 | 7 | ## Changed 8 | 9 | # 1.5.83 (2023-09-13 / 2629e5d) 10 | 11 | ## Added 12 | 13 | - Specify edn tag reader functions with `:edn/readers` 14 | 15 | # 1.4.80 (2023-08-30 / d352b27) 16 | 17 | ## Added 18 | 19 | - `:as` flag to force response content-type parsing 20 | 21 | ## Changed 22 | 23 | - Dependency version bumps 24 | 25 | # 1.3.74 (2023-03-27 / ce3b211) 26 | 27 | ## Added 28 | 29 | - Add documentation for :query-params. (thanks [@opqdonut](https://github.com/opqdonut)) 30 | 31 | ## Fixed 32 | 33 | - Bump uri library to address security issue. 34 | 35 | # 1.2.69 (2022-11-14 / 6e9a82f) 36 | 37 | ## Added 38 | 39 | - Support for a `:signal` key, to hook up an `AbortController` 40 | 41 | ## Changed 42 | 43 | # 1.1.60 (2022-09-19 / 8d42e83) 44 | 45 | ## Changed 46 | 47 | - Passed in query-params now get merged into query parameters on the URL, rather 48 | than replacing them. 49 | 50 | # 1.0.41 (2021-09-07 / 6696b7a) 51 | 52 | ## Added 53 | 54 | - Added support for all options that `js/fetch` understands. Option values can 55 | be supplied as keyword or string. `:headers` is expected to be a Clojure map 56 | from string to string: `:headers`, `:redirect`, `:mode`, `:cache`, 57 | `:credentials`, `:referrer-policy` 58 | - There is now encoding implemented for `:content-type :form-encoded` 59 | 60 | ## Changed 61 | 62 | - Supplying a body as a string will not encode it, but use the string unchanged 63 | as the body 64 | 65 | # 1.0.33 (2021-06-02 / cfb45a8) 66 | 67 | ## Added 68 | 69 | - Added optional EDN support. Require the `lambdaisland.fetch.edn` namespace, this will register the necessary multimethods. 70 | 71 | # 0.0.23 (2021-01-04 / b8a521a) 72 | 73 | ## Fixed 74 | 75 | - Fix query-params encoding issue and path/query-params normalization (@den1k) 76 | 77 | ## Changed 78 | 79 | - Dependency version bumps: lambdaisland/uri, js-interop, transit-cljs 80 | - Remove direct dependency on Clojure/ClojureScript, people will generally bring them themselves 81 | 82 | # 0.0.16 (2020-12-01 / d5f92bd) 83 | 84 | ## Changed 85 | 86 | * Replaced `kitchen-async` dependency with `mhuebert/kitchen-async`, which is the same lib with a fixed version on Clojars -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # lambdaisland/fetch 2 | 3 | 4 | [![cljdoc badge](https://cljdoc.org/badge/lambdaisland/fetch)](https://cljdoc.org/d/lambdaisland/fetch) [![Clojars Project](https://img.shields.io/clojars/v/lambdaisland/fetch.svg)](https://clojars.org/lambdaisland/fetch) 5 | 6 | 7 | ClojureScript wrapper around the JavaScript fetch API. 8 | 9 | ``` clojure 10 | (require '[lambdaisland.fetch :as fetch]) 11 | 12 | (fetch/get "/foo.json") 13 | # 17 | 18 | (fetch/post "/foo.transit" {:query-params {:foo "123"} 19 | :body {:hello "world"}}) 20 | # 24 | ``` 25 | 26 | A more typical ClojureScript example 27 | ```clojure 28 | (ns fetch.demo.core 29 | (:require [kitchen-async.promise :as p] 30 | [lambdaisland.fetch :as fetch])) 31 | 32 | (p/try 33 | (p/let [resp (fetch/get 34 | "https://api.github.com/users/seisvelas/gists" 35 | {:accept :json 36 | :content-type :json})] 37 | (prn (:body resp))) 38 | (p/catch :default e 39 | ;; log your exception here 40 | (prn :error e))) 41 | ``` 42 | 43 | An example of using fetch at the REPL 44 | ```clojure 45 | 46 | (p/let [res (fetch ...)] 47 | (def res res)) 48 | ``` 49 | After that you have your response map in `res` and you can inspect it to see what is in there. 50 | 51 | - Simply uses promises (add [kitchen-async](https://github.com/athos/kitchen-async) if you like it sweeter) 52 | - Returns a promise which delivers something akin to a ring response map 53 | - Does basic content negotiation and encoding/decoding of request/response body 54 | - Defaults to Transit 55 | - Will encode/decode transit-json, json, or EDN 56 | 57 | EDN support is opt-in, since it can increase your build size, and is not 58 | typically needed or wanted for a production setup. Require 59 | `lambdaisland.fetch.edn` to enable it. 60 | 61 | ## Options 62 | 63 | `*` = default 64 | 65 | - `:content-type`: determines the encoding of the request body and the content type header on the request. `:transit-json`, `:json`, `:edn`, `:form-encoded`, `:text`, `:html` 66 | - `:accept`: determines the requested encoded that the server should return. 67 | Decoding is based on the content-type header in the response. Same values as 68 | `:content-type` 69 | - `:as`: forces the body to be decoded as a certain content type, takes a keyword, see `:content-type` 70 | - `:body`: request body to be encoded. If supplied with a string it will be used as-is, otherwise it gets encoded based on `:content-type` 71 | - `:query-params`: map of query parameters 72 | - `:mode`: `:no-cors`, *`:cors`, `same-origin` 73 | - `:cache`: *`:default`, `:no-cache`, `:reload`, `:force-cache`, `:only-if-cached` 74 | - `:credentials` : `:include`, *`:same-origin`, `:omit` 75 | - `:redirect` : `:manual`, *`:follow`, `:error` 76 | - `:referrer-policy` : `:no-referrer`, *`:client` 77 | - `:headers`: map from string to string, note that the server must supply 78 | `Access-Control-Allow-Headers` in a preflight response 79 | - `:transit-json-writer`: a custom transit writer `(t/writer :json your-opts)` if you want to add additional handlers or options 80 | - `:transit-json-reader`: a custom transit reader `(t/reader :json your-opts)` 81 | - `:signal`: an `AbortController`'s [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal), allowing you to abort the operation 82 | 83 | ## Examples 84 | 85 | A simple JSON get request. 86 | 87 | ``` clojure 88 | (require '[lambdaisland.fetch :as fetch]) 89 | (require '[goog.object :as gobj]) 90 | 91 | (-> (fetch/get "https://reqres.in/api/users/2") 92 | (.then (fn [resp] 93 | (-> resp 94 | :body 95 | ;; the actual response is a js object, not a clojure map 96 | (gobj/get "data")))) 97 | (.then (fn [data] 98 | (js/console.log (gobj/get data "id"))))) 99 | ``` 100 | 101 | Same example as above but using `kitchen-async`: 102 | 103 | ``` clojure 104 | (require '[lambdaisland.fetch :as fetch]) 105 | (require '[kitchen-async.promise :as p]) 106 | (require '[goog.object :as gobj]) 107 | 108 | (p/let [resp (fetch/get "https://reqres.in/api/users/2") 109 | data (-> resp 110 | :body 111 | (gobj/get "data"))] 112 | (js/console.log (gobj/get data "id"))) 113 | ``` 114 | 115 | 116 | ## Lambda Island Open Source 117 | 118 | 119 | 120 |   121 | 122 | fetch is part of a growing collection of quality Clojure libraries created and maintained 123 | by the fine folks at [Gaiwan](https://gaiwan.co). 124 | 125 | Pay it forward by [becoming a backer on our Open Collective](http://opencollective.com/lambda-island), 126 | so that we may continue to enjoy a thriving Clojure ecosystem. 127 | 128 | You can find an overview of our projects at [lambdaisland/open-source](https://github.com/lambdaisland/open-source). 129 | 130 |   131 | 132 |   133 | 134 | 135 | 136 | ## Contributing 137 | 138 | Everyone has a right to submit patches to fetch, and thus become a contributor. 139 | 140 | Contributors MUST 141 | 142 | - adhere to the [LambdaIsland Clojure Style Guide](https://nextjournal.com/lambdaisland/clojure-style-guide) 143 | - write patches that solve a problem. Start by stating the problem, then supply a minimal solution. `*` 144 | - agree to license their contributions as MPL 2.0. 145 | - not break the contract with downstream consumers. `**` 146 | - not break the tests. 147 | 148 | Contributors SHOULD 149 | 150 | - update the CHANGELOG and README. 151 | - add tests for new functionality. 152 | 153 | If you submit a pull request that adheres to these rules, then it will almost 154 | certainly be merged immediately. However some things may require more 155 | consideration. If you add new dependencies, or significantly increase the API 156 | surface, then we need to decide if these changes are in line with the project's 157 | goals. In this case you can start by [writing a pitch](https://nextjournal.com/lambdaisland/pitch-template), 158 | and collecting feedback on it. 159 | 160 | `*` This goes for features too, a feature needs to solve a problem. State the problem it solves, then supply a minimal solution. 161 | 162 | `**` As long as this project has not seen a public release (i.e. is not on Clojars) 163 | we may still consider making breaking changes, if there is consensus that the 164 | changes are justified. 165 | 166 | 167 | 168 | ## License 169 | 170 | Copyright © 2020-2021 Arne Brasseur and Contributors 171 | 172 | Licensed under the term of the Mozilla Public License 2.0, see LICENSE. 173 | 174 | -------------------------------------------------------------------------------- /bb.edn: -------------------------------------------------------------------------------- 1 | {:deps 2 | {lambdaisland/open-source {:git/url "https://github.com/lambdaisland/open-source" 3 | :sha "2dc2a8ef9978a3fc45e8f524b0e46253caa40fe2" 4 | #_#_:local/root "../open-source"}}} 5 | -------------------------------------------------------------------------------- /bin/kaocha: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | { 4 | pushd test_server 5 | clojure -X:run & 6 | popd 7 | } 8 | 9 | ([ -d node_modules/ws ] && [ -d node_modules/node_fetch ]) || npm install ws node-fetch@2.6.1 10 | 11 | while ! nc -z localhost 9999 ; do sleep 1 ; echo -n '.' ; done 12 | echo 13 | 14 | clojure -A:test -M -m kaocha.runner "$@" 15 | 16 | EXIT=$? 17 | 18 | curl http://localhost:9999/exit 19 | 20 | exit $EXIT 21 | -------------------------------------------------------------------------------- /bin/proj: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bb 2 | 3 | (ns proj (:require [lioss.main :as lioss])) 4 | 5 | (lioss/main 6 | {:license :mpl 7 | :group-id "lambdaisland" 8 | :inception-year 2020 9 | :description "ClojureScript wrapper around the JavaScript fetch API."}) 10 | 11 | 12 | ;; Local Variables: 13 | ;; mode:clojure 14 | ;; End: 15 | -------------------------------------------------------------------------------- /bin/test_server.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | pushd test_server 4 | exec clojure -X:run 5 | -------------------------------------------------------------------------------- /deps.edn: -------------------------------------------------------------------------------- 1 | {:paths ["src" "test" "resources"] 2 | :deps {mhuebert/kitchen-async {:mvn/version "0.1.0"} 3 | lambdaisland/uri {:mvn/version "1.15.125"} 4 | com.cognitect/transit-cljs {:mvn/version "0.8.280"} 5 | applied-science/js-interop {:mvn/version "0.4.2"}} 6 | 7 | :aliases 8 | {:dev 9 | {:extra-paths ["dev"] 10 | :extra-deps {thheller/shadow-cljs {:mvn/version "2.25.3"}}} 11 | 12 | :test 13 | {:extra-deps {lambdaisland/kaocha {:mvn/version "RELEASE"} 14 | com.lambdaisland/kaocha-cljs {:mvn/version "1.5.154"}}}}} 15 | -------------------------------------------------------------------------------- /dev/user.clj: -------------------------------------------------------------------------------- 1 | (ns user) 2 | 3 | (defmacro jit [sym] 4 | `(requiring-resolve '~sym)) 5 | 6 | (defn cljs-repl 7 | ([] 8 | (cljs-repl :dev)) 9 | ([build-id] 10 | ((jit shadow.cljs.devtools.server/start!)) 11 | ((jit shadow.cljs.devtools.api/watch) build-id) 12 | (loop [] 13 | (when (nil? @@(jit shadow.cljs.devtools.server.runtime/instance-ref)) 14 | (Thread/sleep 250) 15 | (recur))) 16 | ((jit shadow.cljs.devtools.api/nrepl-select) build-id))) 17 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | lambdaisland 5 | fetch 6 | 1.5.83 7 | fetch 8 | ClojureScript wrapper around the JavaScript fetch API. 9 | https://github.com/lambdaisland/fetch 10 | 2020 11 | 12 | Lambda Island 13 | https://lambdaisland.com 14 | 15 | 16 | UTF-8 17 | 18 | 19 | 20 | MPL-2.0 21 | https://www.mozilla.org/media/MPL/2.0/index.txt 22 | 23 | 24 | 25 | https://github.com/lambdaisland/fetch 26 | scm:git:git://github.com/lambdaisland/fetch.git 27 | scm:git:ssh://git@github.com/lambdaisland/fetch.git 28 | 737e2977527b02d3221de6103474ffd547b7c9fe 29 | 30 | 31 | 32 | mhuebert 33 | kitchen-async 34 | 0.1.0 35 | 36 | 37 | lambdaisland 38 | uri 39 | 1.15.125 40 | 41 | 42 | com.cognitect 43 | transit-cljs 44 | 0.8.280 45 | 46 | 47 | applied-science 48 | js-interop 49 | 0.4.2 50 | 51 | 52 | 53 | src 54 | 55 | 56 | src 57 | 58 | 59 | test 60 | 61 | 62 | resources 63 | 64 | 65 | 66 | 67 | org.apache.maven.plugins 68 | maven-compiler-plugin 69 | 3.8.1 70 | 71 | 1.8 72 | 1.8 73 | 74 | 75 | 76 | org.apache.maven.plugins 77 | maven-jar-plugin 78 | 3.2.0 79 | 80 | 81 | 82 | 737e2977527b02d3221de6103474ffd547b7c9fe 83 | 84 | 85 | 86 | 87 | 88 | org.apache.maven.plugins 89 | maven-gpg-plugin 90 | 1.6 91 | 92 | 93 | sign-artifacts 94 | verify 95 | 96 | sign 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | clojars 106 | https://repo.clojars.org/ 107 | 108 | 109 | 110 | 111 | clojars 112 | Clojars repository 113 | https://clojars.org/repo 114 | 115 | 116 | -------------------------------------------------------------------------------- /resources/public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 |
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /shadow-cljs.edn: -------------------------------------------------------------------------------- 1 | {:deps {:aliases [:dev]} 2 | :dev-http {8007 "classpath:public"} 3 | :builds {:dev {:target :browser 4 | :modules {:main {:entries [lambdaisland.fetch]}} 5 | :output-dir "resources/public/dev" 6 | :asset-path "dev" 7 | :devtools {:repl-pprint true}}}} 8 | -------------------------------------------------------------------------------- /src/lambdaisland/fetch.cljs: -------------------------------------------------------------------------------- 1 | (ns lambdaisland.fetch 2 | (:refer-clojure :exclude [get]) 3 | (:require [applied-science.js-interop :as j] 4 | [clojure.core :as c] 5 | [clojure.set :as set] 6 | [clojure.string :as str] 7 | [cognitect.transit :as transit] 8 | [kitchen-async.promise :as p] 9 | [lambdaisland.uri :as uri] 10 | [lambdaisland.uri.normalize :as uri-normalize])) 11 | 12 | ;; fetch(url, { 13 | ;; method: 'POST', // *GET, POST, PUT, DELETE, etc. 14 | ;; mode: 'cors', // no-cors, *cors, same-origin 15 | ;; cache: 'no-cache', // *default, no-cache, reload, force-cache, only-if-cached 16 | ;; credentials: 'same-origin', // include, *same-origin, omit 17 | ;; headers: { 18 | ;; 'Content-Type': 'application/json' 19 | ;; // 'Content-Type': 'application/x-www-form-urlencoded', 20 | ;; }, 21 | ;; redirect: 'follow', // manual, *follow, error 22 | ;; referrerPolicy: 'no-referrer', // no-referrer, *client 23 | ;; body: JSON.stringify(data) // body data type must match "Content-Type" header 24 | ;; }); 25 | 26 | (def content-types 27 | {:transit-json "application/transit+json" 28 | :json "application/json" 29 | :form-encoded "application/x-www-form-urlencoded" 30 | :text "text/plain" 31 | :html "text/html" 32 | :edn "application/edn"}) 33 | 34 | (def transit-json-writer 35 | (delay (transit/writer :json))) 36 | 37 | (def transit-json-reader 38 | (delay (transit/reader :json))) 39 | 40 | (defmulti encode-body (fn [content-type body opts] content-type)) 41 | 42 | (defmethod encode-body :default [_ body opts] 43 | body) 44 | 45 | (defmethod encode-body :transit-json [_ body opts] 46 | (transit/write (:transit-json-writer opts @transit-json-writer) body)) 47 | 48 | (defmethod encode-body :form-encoded [_ body opts] 49 | (uri/map->query-string body)) 50 | 51 | (defmethod encode-body :json [_ body opts] 52 | (js/JSON.stringify (clj->js body))) 53 | 54 | (defmulti decode-body (fn [content-type bodyp opts] content-type)) 55 | 56 | (defmethod decode-body :default [_ response opts] 57 | (j/call response :text)) 58 | 59 | (defmethod decode-body :transit-json [_ response opts] 60 | (p/let [text (j/call response :text)] 61 | (let [decoded (transit/read (:transit-json-reader opts @transit-json-reader) text)] 62 | (if (satisfies? IWithMeta decoded) 63 | (vary-meta decoded assoc ::raw text) 64 | decoded)))) 65 | 66 | (defmethod decode-body :json [_ response opts] 67 | (j/call response :json)) 68 | 69 | (defn fetch-opts [{:keys [method accept content-type 70 | headers redirect mode cache signal 71 | credentials referrer-policy] 72 | :or {method :get 73 | accept :transit-json 74 | content-type :transit-json 75 | redirect :follow 76 | mode :cors 77 | cache :default 78 | credentials :same-origin 79 | referrer-policy :client}}] 80 | (let [fetch-headers #js {"Accept" (c/get content-types accept) 81 | "Content-Type" (c/get content-types content-type)}] 82 | (doseq [[k v] headers] 83 | (j/assoc! fetch-headers k v)) 84 | #js {:method (str/upper-case (name method)) 85 | :headers fetch-headers 86 | :redirect (name redirect) 87 | :mode (name mode) 88 | :cache (name cache) 89 | :signal signal 90 | :credentials (name credentials) 91 | :referrer-policy (name referrer-policy)})) 92 | 93 | (defn request [url & [{:keys [method accept content-type query-params body as] 94 | :as opts 95 | :or {accept :transit-json 96 | content-type :transit-json}}]] 97 | (let [url (-> (uri/uri url) 98 | (uri/assoc-query* query-params) 99 | str) 100 | request (cond-> (fetch-opts opts) 101 | body 102 | (j/assoc! :body (if (string? body) 103 | body 104 | (encode-body content-type body opts))))] 105 | (p/let [response (js/fetch url request)] 106 | (p/try 107 | (let [headers (j/get response :headers) 108 | header-map (into {} (map vec) (es6-iterator-seq (j/call headers :entries))) 109 | content-type-header (j/call headers :get "Content-Type") 110 | content-type (if as 111 | as 112 | (when content-type-header 113 | (c/get (set/map-invert content-types) 114 | (str/replace content-type-header #";.*" ""))))] 115 | (p/let [body (decode-body content-type response opts)] 116 | ^{::request (j/assoc! request :url url) 117 | ::response response} 118 | {:status (j/get response :status) 119 | :headers header-map 120 | :body body})) 121 | (p/catch :default e 122 | ^{::request (j/assoc! request :url url) 123 | ::response response} 124 | {:error e}))))) 125 | 126 | (def get request) 127 | 128 | (defn post [url & [opts]] 129 | (request url (assoc opts :method :post))) 130 | 131 | (defn put [url & [opts]] 132 | (request url (assoc opts :method :put))) 133 | 134 | (defn delete [url & [opts]] 135 | (request url (assoc opts :method :delete))) 136 | 137 | (defn head [url & [opts]] 138 | (request url (assoc opts :method :head))) 139 | -------------------------------------------------------------------------------- /src/lambdaisland/fetch/edn.cljs: -------------------------------------------------------------------------------- 1 | (ns lambdaisland.fetch.edn 2 | "EDN read/write support 3 | 4 | Split out so as not to blow up the build if EDN support isn't needed." 5 | (:require [applied-science.js-interop :as j] 6 | [clojure.edn :as edn] 7 | [kitchen-async.promise :as p] 8 | [lambdaisland.fetch :as fetch])) 9 | 10 | (defmethod fetch/encode-body :edn [_ body opts] 11 | (pr-str body)) 12 | 13 | (defmethod fetch/decode-body :edn [_ bodyp opts] 14 | (p/let [text (j/call bodyp :text)] 15 | (edn/read-string (cond-> {} 16 | (:edn/readers opts) 17 | (assoc :readers (:edn/readers opts))) 18 | text))) 19 | -------------------------------------------------------------------------------- /test/lambdaisland/fetch_test.cljs: -------------------------------------------------------------------------------- 1 | (ns lambdaisland.fetch-test 2 | (:require 3 | [applied-science.js-interop :as j] 4 | [clojure.pprint :as pprint] 5 | [clojure.test :refer [deftest testing is are use-fixtures run-tests join-fixtures async]] 6 | [kitchen-async.promise :as p] 7 | [lambdaisland.fetch :as fetch])) 8 | 9 | ;; cd test_server 10 | ;; clj -X:run 11 | 12 | (when-not (exists? js/fetch) 13 | (set! js/fetch (js/require "node-fetch"))) 14 | 15 | (deftest transit-default 16 | (async 17 | done 18 | (p/let [res (fetch/get "http://localhost:9999/hello")] 19 | (is (= "application/transit+json; charset=utf-8" (get-in res [:headers "content-type"]))) 20 | (is (= {:hello "world"} (:body res))) 21 | (done)))) 22 | 23 | (deftest json-support 24 | (async 25 | done 26 | (p/let [res (fetch/post "http://localhost:9999/echo" 27 | {:accept :json 28 | :content-type :json 29 | :body {:msg "Here it goes"}})] 30 | (is (= "application/json;charset=utf-8" 31 | (get-in res [:headers "content-type"]))) 32 | (is (= "Here it goes" 33 | (j/get-in (:body res) [:body-params :msg]))) 34 | (is (= "application/json" 35 | (j/get-in (get-in res [:body]) [:headers :content-type]))) 36 | (is (= "application/json" 37 | (j/get-in (get-in res [:body]) [:headers :accept]))) 38 | (done)))) 39 | 40 | (deftest custom-header 41 | (async 42 | done 43 | (p/let [res (fetch/post "http://localhost:9999/echo" 44 | {:headers 45 | {"X-Extra-Header" "Mango chutney"}})] 46 | (is (= "Mango chutney" 47 | (get-in res [:body :headers "x-extra-header"]))) 48 | (done)))) 49 | 50 | (deftest form-encoded 51 | (async 52 | done 53 | (p/let [res (fetch/post "http://localhost:9999/echo" 54 | {:content-type :form-encoded 55 | :body {:foo [1 2 3]}})] 56 | (is (= {"foo" ["1" "2" "3"]} 57 | (get-in res [:body :form-params]))) 58 | (is (= "application/x-www-form-urlencoded" 59 | (get-in res [:body :headers "content-type"]))) 60 | (done)))) 61 | 62 | (deftest add-query-params 63 | (async 64 | done 65 | (p/then 66 | (p/all 67 | [(p/let [res (fetch/get "http://localhost:9999/echo?hello=world&b=2" 68 | {:query-params {:foo "bar"}})] 69 | (is (= {"hello" "world", "b" "2", "foo" "bar"} 70 | (get-in res [:body :params])))) 71 | 72 | (p/let [res (fetch/get "http://localhost:9999/echo?hello=world" 73 | {:query-params {:hello "mars" :b 3}})] 74 | (is (= {"hello" "mars", "b" "3"} 75 | (get-in res [:body :params])))) 76 | 77 | (p/let [res (fetch/get "http://localhost:9999/echo" 78 | {:query-params {:foo "bar"}})] 79 | (is (= {"foo" "bar"} (get-in res [:body :params])))) 80 | 81 | (p/let [res (fetch/get "http://localhost:9999/echo?x=y")] 82 | (is (= {"x" "y"} (get-in res [:body :params]))))]) 83 | done))) 84 | 85 | (deftest explicit-response-type 86 | (async 87 | done 88 | (p/let [res (fetch/get "http://localhost:9999/hello" {:accept :json :as :text})] 89 | (is (= "{\"hello\":\"world\"}" (:body res))) 90 | (done)))) 91 | -------------------------------------------------------------------------------- /test_server/deps.edn: -------------------------------------------------------------------------------- 1 | {:paths ["."] 2 | :deps {com.lambdaisland/webstuff {:git/url "https://github.com/lambdaisland/webstuff" 3 | :git/sha "b58c3b032a3c21f41569233c34b748e0ab18d2a6"}} 4 | :aliases 5 | {:run {:exec-fn fetch-test-server/run-test-server}}} 6 | -------------------------------------------------------------------------------- /test_server/fetch_test_server.clj: -------------------------------------------------------------------------------- 1 | (ns fetch-test-server 2 | (:require [lambdaisland.webstuff.http :as http] 3 | [clojure.pprint :as pprint])) 4 | 5 | (defn response [r] 6 | (merge 7 | {:status 200 8 | :headers {"Access-Control-Allow-Origin" "*" 9 | "Access-Control-Allow-Headers" "Content-Type, Accept, X-Extra-Header"} 10 | :view (fn [body] 11 | [:pre (with-out-str (pprint/pprint body))])} 12 | r)) 13 | 14 | (defn run-test-server [_] 15 | (println "Starting test server...") 16 | (http/start-jetty! 17 | {:port 9999 18 | :build-handler 19 | #(http/ring-handler 20 | {:routes 21 | [["/hello" 22 | {:name :hello 23 | :handler 24 | (fn [req] 25 | (response 26 | {:body {:hello "world"} 27 | :view (fn [body] 28 | [:p "Hello, " (:hello body) "!"])}))}] 29 | ["/echo" 30 | {:name :echo 31 | :handler 32 | (fn [req] 33 | (response 34 | {:body (select-keys req [:params 35 | :form-params 36 | :query-params 37 | :body-params 38 | :headers])}))}] 39 | ["/exit" 40 | {:name :exit 41 | :handler 42 | (fn [_] 43 | (println "Exiting...") 44 | (System/exit 0) 45 | {:status 200 46 | :body "OK"})}]]})})) 47 | -------------------------------------------------------------------------------- /tests.edn: -------------------------------------------------------------------------------- 1 | #kaocha/v1 2 | {:plugins [:notifier :print-invocations :profiling] 3 | :tests [{:id :browser 4 | :type :kaocha.type/cljs 5 | :cljs/repl-env cljs.repl.browser/repl-env} 6 | {:id :node 7 | :type :kaocha.type/cljs}]} 8 | --------------------------------------------------------------------------------