Merge branch 'main' into bump-meilisearch-v0.29.0

Author: bidoubiwa

.code-samples.meilisearch.yaml

@@ -2,13 +2,26 @@
 
 First of all, thank you for contributing to Meilisearch! The goal of this document is to provide everything you need to know in order to contribute to Meilisearch and its different integrations.
 
+- [Hacktoberfest 2022](#hacktoberfest-2022)
 - [Assumptions](#assumptions)
 - [How to Contribute](#how-to-contribute)
 - [Development Workflow](#development-workflow)
 - [Git Guidelines](#git-guidelines)
 - [Release Process (for internal team only)](#release-process-for-internal-team-only)
 
 
+## Hacktoberfest 2022
+
+It's [Hacktoberfest month](https://hacktoberfest.com)! 🥳
+
+Thanks so much for participating with Meilisearch this year!
+
+1. We will follow the quality standards set by the organizers of Hacktoberfest (see detail on their [website](https://hacktoberfest.digitalocean.com/resources/qualitystandards)). Our reviewers will not consider any PR that doesn’t match that standard.
+2. PRs reviews will take place from Monday to Thursday, during usual working hours, CEST time. If you submit outside of these hours, there’s no need to panic; we will get around to your contribution.
+3. There will be no issue assignment as we don’t want people to ask to be assigned specific issues and never return, discouraging the volunteer contributors from opening a PR to fix this issue. We take the liberty to choose the PR that best fixes the issue, so we encourage you to get to it as soon as possible and do your best!
+
+You can check out the longer, more complete guideline documentation [here](https://github.com/meilisearch/.github/blob/main/Hacktoberfest_2022_contributors_guidelines.md).
+
 ## Assumptions
 
 1. **You're familiar with [GitHub](https://github.com) and the [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)(PR) workflow.**
@@ -59,7 +72,7 @@ Also, the WASM example compilation should be checked:
 
 ```bash
 rustup target add wasm32-unknown-unknown
-cargo check --example web_app --target wasm32-unknown-unknown --features=sync
+cargo check -p web_app --target wasm32-unknown-unknown
 ```
 
 Each PR should pass the tests to be accepted.

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 [package]
 name = "meilisearch-sdk"
-version = "0.18.0"
+version = "0.19.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."

Cargo.toml

@@ -33,13 +33,22 @@
 
 ## Table of Contents <!-- omit in TOC -->
 
+- [🎃 Hacktoberfest](#-hacktoberfest)
 - [📖 Documentation](#-documentation)
 - [🔧 Installation](#-installation)
 - [🚀 Getting Started](#-getting-started)
 - [🌐 Running in the Browser with WASM](#-running-in-the-browser-with-wasm)
 - [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
 - [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
 
+## 🎃 Hacktoberfest
+
+It’s Hacktoberfest 2022 @Meilisearch
+
+[Hacktoberfest](https://hacktoberfest.com/) is a celebration of the open-source community. This year, and for the third time in a row, Meilisearch is participating in this fantastic event.
+
+You’d like to contribute? Don’t hesitate to check out our [contributing guidelines](./CONTRIBUTING.md).
+
 ## 📖 Documentation
 
 See our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_started.html) or our [API References](https://docs.meilisearch.com/reference/api/).
@@ -50,7 +59,7 @@ To use `meilisearch-sdk`, add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-meilisearch-sdk = "0.18.0"
+meilisearch-sdk = "0.19.0"
 ```
 
 The following optional dependencies may also be useful:

README.md

@@ -33,13 +33,22 @@
 
 ## Table of Contents <!-- omit in TOC -->
 
+- [🎃 Hacktoberfest](#-hacktoberfest)
 - [📖 Documentation](#-documentation)
 - [🔧 Installation](#-installation)
 - [🚀 Getting Started](#-getting-started)
 - [🌐 Running in the Browser with WASM](#-running-in-the-browser-with-wasm)
 - [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
 - [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
 
+## 🎃 Hacktoberfest
+
+It’s Hacktoberfest 2022 @Meilisearch
+
+[Hacktoberfest](https://hacktoberfest.com/) is a celebration of the open-source community. This year, and for the third time in a row, Meilisearch is participating in this fantastic event.
+
+You’d like to contribute? Don’t hesitate to check out our [contributing guidelines](./CONTRIBUTING.md).
+
 ## 📖 Documentation
 
 See our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_started.html) or our [API References](https://docs.meilisearch.com/reference/api/).
@@ -50,7 +59,7 @@ To use `meilisearch-sdk`, add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-meilisearch-sdk = "0.18.0"
+meilisearch-sdk = "0.19.0"
 ```
 
 The following optional dependencies may also be useful:

README.tpl

@@ -11,7 +11,7 @@ The Rust source files are compiled into WebAssembly and so can be readable by th
 If you only want to check if this example compiles, you can run:
 
 ```console
-cargo build --example web_app
+cargo build
 ```
 
 ## Building
@@ -23,7 +23,7 @@ curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
 ```
 
 ```console
-wasm-pack build examples/web_app/ --target=web --no-typescript
+wasm-pack build . --target=web --no-typescript
 ```
 
 The compiled files will be stored in the `examples/web_app/pkg` folder.

examples/web_app/README.md

@@ -15,10 +15,7 @@ mod document;
 use crate::document::{display, Crate};
 
 lazy_static! {
-    static ref CLIENT: Client = Client::new(
-        "https://finding-demos.meilisearch.com",
-        "2b902cce4f868214987a9f3c7af51a69fa660d74a785bed258178b96e3480bb3",
-    );
+    static ref CLIENT: Client = Client::new("http://localhost:7700", "masterKey",);
 }
 
 struct Model {

examples/web_app/src/lib.rs

@@ -9,14 +9,14 @@ use crate::{
 };
 use serde::Deserialize;
 use serde_json::{json, Value};
-use std::{collections::HashMap, sync::Arc, time::Duration};
+use std::{collections::HashMap, time::Duration};
 use time::OffsetDateTime;
 
 /// The top-level struct of the SDK, representing a client containing [indexes](../indexes/struct.Index.html).
 #[derive(Debug, Clone)]
 pub struct Client {
-    pub(crate) host: Arc<String>,
-    pub(crate) api_key: Arc<String>,
+    pub(crate) host: String,
+    pub(crate) api_key: String,
 }
 
 impl Client {
@@ -36,8 +36,8 @@ impl Client {
     /// ```
     pub fn new(host: impl Into<String>, api_key: impl Into<String>) -> Client {
         Client {
-            host: Arc::new(host.into()),
-            api_key: Arc::new(api_key.into()),
+            host: host.into(),
+            api_key: api_key.into(),
         }
     }
 
@@ -985,7 +985,7 @@ mod tests {
         let key = client.create_key(key).await.unwrap();
         let master_key = client.api_key.clone();
         // this key has no right
-        client.api_key = Arc::new(key.key.clone());
+        client.api_key = key.key.clone();
         // with a wrong key
         let error = client.delete_key("invalid_key").await.unwrap_err();
         assert!(matches!(
@@ -1060,7 +1060,7 @@ mod tests {
 
         // backup the master key for cleanup at the end of the test
         let master_client = client.clone();
-        client.api_key = Arc::new(no_right_key.key.clone());
+        client.api_key = no_right_key.key.clone();
 
         let mut key = KeyBuilder::new();
         key.with_name(format!("{name}_2"));

src/client.rs

@@ -211,17 +211,17 @@ impl Index {
     /// // add some documents
     /// # movies.add_or_replace(&[Movie{name:String::from("Interstellar"), description:String::from("Interstellar chronicles the adventures of a group of explorers who make use of a newly discovered wormhole to surpass the limitations on human space travel and conquer the vast distances involved in an interstellar voyage.")},Movie{name:String::from("Unknown"), description:String::from("Unknown")}], Some("name")).await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
     ///
-    /// let query = Query::new(&movies).with_query("Interstellar").with_limit(5).build();
+    /// let query = SearchQuery::new(&movies).with_query("Interstellar").with_limit(5).build();
     /// let results = movies.execute_query::<Movie>(&query).await.unwrap();
     /// assert!(results.hits.len()>0);
     /// # movies.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
     /// # });
     /// ```
     pub async fn execute_query<T: 'static + DeserializeOwned>(
         &self,
-        query: &Query<'_>,
+        query: &SearchQuery<'_>,
     ) -> Result<SearchResults<T>, Error> {
-        request::<&Query, SearchResults<T>>(
+        request::<&SearchQuery, SearchResults<T>>(
             &format!("{}/indexes/{}/search", self.client.host, self.uid),
             &self.client.api_key,
             Method::Post(query),
@@ -267,8 +267,8 @@ impl Index {
     /// # movies.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
     /// # });
     /// ```
-    pub fn search(&self) -> Query {
-        Query::new(self)
+    pub fn search(&self) -> SearchQuery {
+        SearchQuery::new(self)
     }
 
     /// Get one [Document] using its unique id.

src/indexes.rs

@@ -248,3 +248,5 @@ pub mod tasks;
 mod tenant_tokens;
 /// Module containing utilies functions.
 mod utils;
+
+pub use client::*;