Merge branch 'main' into patch-1

Author: curquiza

.code-samples.meilisearch.yaml

@@ -993,7 +993,7 @@ primary_field_guide_add_document_primary_key: |-
 getting_started_add_documents_md: |-
   ```toml
     [dependencies]
-    meilisearch-sdk = "0.25.0"
+    meilisearch-sdk = "0.26.0"
     # futures: because we want to block on futures
     futures = "0.3"
     # serde: required if you are going to use documents
@@ -1611,7 +1611,7 @@ search_parameter_guide_facet_stats_1: |-
 get_proximity_precision_settings_1: |-
   let proximity_precision: String = client
     .index("books")
-    .get_typo_tolerance()
+    .get_proximity_precision()
     .await
     .unwrap();
 update_proximity_precision_settings_1: |-

.github/workflows/tests.yml

@@ -32,6 +32,11 @@ jobs:
         with:
           command: check
           args: --workspace --all-targets --all
+      - name: Cargo check no default features
+        uses: actions-rs/cargo@v1
+        with:
+          command: check
+          args: --workspace --all-targets --all --no-default-features
 
   linter:
     name: clippy-check

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "meilisearch-sdk"
-version = "0.25.0"
+version = "0.26.0"
 authors = ["Mubelotix <[email protected]>"]
 edition = "2018"
 description = "Rust wrapper for the Meilisearch API. Meilisearch is a powerful, fast, open-source, easy to use and deploy search engine."
@@ -18,28 +18,28 @@ log = "0.4"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 time = { version = "0.3.7", features = ["serde-well-known", "formatting", "parsing"] }
-jsonwebtoken = { version = "9", default-features = false }
 yaup = "0.2.0"
 either = { version = "1.8.0", features = ["serde"] }
 thiserror = "1.0.37"
-meilisearch-index-setting-macro = { path = "meilisearch-index-setting-macro", version = "0.25.0" }
+meilisearch-index-setting-macro = { path = "meilisearch-index-setting-macro", version = "0.26.0" }
+pin-project-lite = { version = "0.2.13", optional = true }
+reqwest = { version = "0.12.3", optional = true, default-features = false, features = ["rustls-tls", "http2", "stream"] }
+bytes = { version = "1.6", optional = true }
+uuid = { version = "1.1.2", features = ["v4"] }
+futures-io = "0.3.30"
+futures = "0.3"
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
-futures = "0.3"
-futures-io = "0.3.26"
-isahc = { version = "1.0", features = ["http2", "text-decoding"], default_features = false }
-uuid = { version = "1.1.2", features = ["v4"] }
+jsonwebtoken = { version = "9", default-features = false }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
-js-sys = "0.3.47"
-web-sys = { version = "0.3", features = ["RequestInit", "Headers", "Window", "Response", "console"] }
-wasm-bindgen = "0.2"
+uuid = { version = "1.8.0", default-features = false, features = ["v4", "js"] }
+web-sys = "0.3"
 wasm-bindgen-futures = "0.4"
 
 [features]
-default = ["isahc-static-curl"]
-isahc-static-curl = ["isahc/static-curl"]
-isahc-static-ssl = ["isahc/static-ssl"]
+default = ["reqwest"]
+reqwest = ["dep:reqwest", "pin-project-lite", "bytes"]
 
 [dev-dependencies]
 futures-await-test = "0.3"
@@ -56,3 +56,4 @@ lazy_static = "1.4"
 web-sys = "0.3"
 console_error_panic_hook = "0.1"
 big_s = "1.0.2"
+insta = "1.38.0"

README.md

@@ -58,7 +58,7 @@ To use `meilisearch-sdk`, add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-meilisearch-sdk = "0.25.0"
+meilisearch-sdk = "0.26.0"
 ```
 
 The following optional dependencies may also be useful:
@@ -108,9 +108,10 @@ struct Movie {
 }
 
 
-fn main() { block_on(async move {
+#[tokio::main(flavor = "current_thread")]
+async fn main() {
     // Create a client (without sending any request so that can't fail)
-    let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
+    let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY)).unwrap();
 
     // An index is where the documents are stored.
     let movies = client.index("movies");
@@ -124,7 +125,7 @@ fn main() { block_on(async move {
         Movie { id: 5, title: String::from("Moana"), genres: vec!["Fantasy".to_string(), "Action".to_string()] },
         Movie { id: 6, title: String::from("Philadelphia"), genres: vec!["Drama".to_string()] },
     ], Some("id")).await.unwrap();
-})}
+}
 ```
 
 With the `uid`, you can check the status (`enqueued`, `canceled`, `processing`, `succeeded` or `failed`) of your documents addition using the [task](https://www.meilisearch.com/docs/reference/api/tasks#get-task).
@@ -238,6 +239,12 @@ Json output:
 }
 ```
 
+#### Customize the `HttpClient` <!-- omit in TOC -->
+
+By default, the SDK uses [`reqwest`](https://docs.rs/reqwest/latest/reqwest/) to make http calls.
+The SDK lets you customize the http client by implementing the `HttpClient` trait yourself and
+initializing the `Client` with the `new_with_client` method.
+
 ## 🌐 Running in the Browser with WASM <!-- omit in TOC -->
 
 This crate fully supports WASM.

README.tpl

@@ -58,7 +58,7 @@ To use `meilisearch-sdk`, add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-meilisearch-sdk = "0.25.0"
+meilisearch-sdk = "0.26.0"
 ```
 
 The following optional dependencies may also be useful:

examples/cli-app-with-awc/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "cli-app-with-awc"
+version = "0.0.0"
+edition = "2021"
+publish = false
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+meilisearch-sdk = { path = "../..", default-features = false }
+futures = "0.3"
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
+lazy_static = "1.4.0"
+awc = "3.4"
+async-trait = "0.1.51"
+tokio = { version = "1.27.0", features = ["full"] }
+yaup = "0.2.0"
+tokio-util = { version = "0.7.10", features = ["full"] }
+actix-rt = "2.9.0"

examples/cli-app-with-awc/assets/clothes.json

@@ -0,0 +1,74 @@
+[
+    {
+    "id": 1,
+    "seaon": "winter",
+    "article": "sweater",
+    "cost": 63.40,
+    "size":"L",
+    "pattern":"striped"
+  },
+  {
+    "id": 2,
+    "seaon": "spring",
+    "article": "sweat pants",
+    "cost": 18.00,
+    "size":"XXXL",
+    "pattern":"floral"
+  },
+  {
+    "id": 3,
+    "seaon": "fall",
+    "article": "t-shirt",
+    "cost": 1634.90,
+    "size":"M",
+    "pattern":"solid black"
+  },
+  {
+    "id": 4,
+    "seaon": "summer",
+    "article": "tank top",
+    "cost": 3.40,
+    "size":"L",
+    "pattern":"diagonal"
+  },
+  {
+    "id": 5,
+    "seaon": "winter",
+    "article": "jeans",
+    "cost": 4.20,
+    "size":"XL",
+    "pattern":"striped"
+  },
+  {
+    "id": 6,
+    "seaon": "spring",
+    "article": "sun dress",
+    "cost": 12634.56,
+    "size":"L",
+    "pattern":"floral"
+  },
+  {
+    "id": 7,
+    "seaon": "fall",
+    "article": "sweatshirt",
+    "cost": 90.80,
+    "size":"M",
+    "pattern":"checker"
+  },
+  {
+    "id": 8,
+    "seaon": "summer",
+    "article": "shorts",
+    "cost": 16.34,
+    "size":"XS",
+    "pattern":"solid beige"
+  },
+  {
+    "id": 9,
+    "seaon": "winter",
+    "article": "jacket",
+    "cost": 634,
+    "size":"L",
+    "pattern":"camo"
+  }
+]