Merge branch 'main' into provide-methods-to-send-raw-payloads

Author: irevoire

.code-samples.meilisearch.yaml

@@ -957,7 +957,7 @@ primary_field_guide_add_document_primary_key: |-
 getting_started_add_documents_md: |-
   ```toml
     [dependencies]
-    meilisearch-sdk = "0.21"
+    meilisearch-sdk = "0.22"
     # futures: because we want to block on futures
     futures = "0.3"
     # serde: required if you are going to use documents

.github/scripts/check-release.sh

@@ -2,24 +2,36 @@
 
 # Checking if current tag matches the package version
 current_tag=$(echo $GITHUB_REF | cut -d '/' -f 3 | sed -r 's/^v//')
-major=$(echo $current_tag | cut -d '.' -f1 )
-minor=$(echo $current_tag | cut -d '.' -f2 )
+major=$(echo $current_tag | cut -d '.' -f1)
+minor=$(echo $current_tag | cut -d '.' -f2)
 cropped_current_tag="$major.$minor"
 file1='Cargo.toml'
 file2='README.tpl'
 file3='.code-samples.meilisearch.yaml'
 file4='README.md'
+file5='./meilisearch-index-setting-macro/Cargo.toml'
 
 file_tag1=$(grep '^version = ' $file1 | cut -d '=' -f 2 | tr -d '"' | tr -d ' ')
+file_tag_1_1=$(grep '{ path = "meilisearch-index-setting-macro", version =' $file1 | grep -Eo '[0-9]+.[0-9]+.[0-9]+')
 file_tag2=$(grep 'meilisearch-sdk = ' $file2 | cut -d '=' -f 2 | tr -d '"' | tr -d ' ')
 file_tag3=$(grep 'meilisearch-sdk = ' $file3 | cut -d '=' -f 2 | tr -d '"' | tr -d ' ')
 file_tag4=$(grep 'meilisearch-sdk = ' $file4 | cut -d '=' -f 2 | tr -d '"' | tr -d ' ')
-if [ "$current_tag" != "$file_tag1" ] || [ "$current_tag" != "$file_tag2" ] || [ "$cropped_current_tag" != "$file_tag3" ] || [ "$current_tag" != "$file_tag4" ]; then
+file_tag5=$(grep '^version = ' $file5 | grep -Eo '[0-9]+.[0-9]+.[0-9]+')
+
+if [ "$current_tag" != "$file_tag1" ] ||
+  [ "$current_tag" != "$file_tag_1_1" ] ||
+  [ "$current_tag" != "$file_tag2" ] ||
+  [ "$cropped_current_tag" != "$file_tag3" ] ||
+  [ "$current_tag" != "$file_tag4" ] ||
+  [ "$current_tag" != "$file_tag5" ] \
+  ; then
   echo "Error: the current tag does not match the version in package file(s)."
   echo "$file1: found $file_tag1 - expected $current_tag"
+  echo "$file1: found $file_tag_1_1 - expected $current_tag"
   echo "$file2: found $file_tag2 - expected $current_tag"
   echo "$file3: found $file_tag3 - expected $cropped_current_tag"
   echo "$file4: found $file_tag4 - expected $current_tag"
+  echo "$file5: found $file_tag5 - expected $current_tag"
   exit 1
 fi
 

CONTRIBUTING.md

@@ -173,6 +173,12 @@ Make a PR modifying the file [`Cargo.toml`](/Cargo.toml):
 version = "X.X.X"
 ```
 
+After the changes on `Cargo.toml`, run the following command: 
+
+```
+sh scripts/update_macro_versions.sh
+```
+
 and the [`README.tpl`](/README.tpl):
 
 ```rust
@@ -181,13 +187,13 @@ and the [`README.tpl`](/README.tpl):
 
 with the right version.
 
-You should run the following command after the changes applied to `lib.rs`:
+After the changes on `lib.rs`, run the following command:
 
 ```bash
 sh scripts/update-readme.sh
 ```
 
-Also, you might need to change the [code-samples file](/.code-samples.meilisearch.yaml) if the minor has been upgraded:
+You might need to change the [code-samples file](/.code-samples.meilisearch.yaml) if the minor has been upgraded:
 
 ```yml
   meilisearch-sdk = "X.X"

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "meilisearch-sdk"
-version = "0.21.2"
+version = "0.22.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."
@@ -22,7 +22,7 @@ jsonwebtoken = { version = "8", 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.1.0" }
+meilisearch-index-setting-macro = { path = "meilisearch-index-setting-macro", version = "0.22.0" }
 
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]

README.md

@@ -52,7 +52,7 @@ To use `meilisearch-sdk`, add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-meilisearch-sdk = "0.21.2"
+meilisearch-sdk = "0.22.0"
 ```
 
 The following optional dependencies may also be useful:
@@ -244,7 +244,7 @@ WARNING: `meilisearch-sdk` will panic if no Window is available (ex: Web extensi
 
 ## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.30.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.30.0).
+This package only guarantees the compatibility with the [version v1.0.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v1.0.0).
 
 ## ⚙️ Contributing
 

README.tpl

@@ -52,7 +52,7 @@ To use `meilisearch-sdk`, add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-meilisearch-sdk = "0.21.2"
+meilisearch-sdk = "0.22.0"
 ```
 
 The following optional dependencies may also be useful:
@@ -99,7 +99,7 @@ WARNING: `meilisearch-sdk` will panic if no Window is available (ex: Web extensi
 
 ## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.30.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.30.0).
+This package only guarantees the compatibility with the [version v1.0.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v1.0.0).
 
 ## ⚙️ Contributing
 

examples/cli-app/Cargo.toml

@@ -1,7 +1,8 @@
 [package]
 name = "cli-app"
-version = "0.1.0"
+version = "0.0.0"
 edition = "2021"
+publish = false
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

examples/web_app/Cargo.toml

@@ -1,8 +1,9 @@
 [package]
 name = "web_app"
-version = "0.1.0"
+version = "0.0.0"
 authors = ["Mubelotix <[email protected]>"]
 edition = "2018"
+publish = false
 
 [lib]
 crate-type = ["cdylib", "rlib"]

meilisearch-index-setting-macro/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "meilisearch-index-setting-macro"
-version = "0.1.0"
+version = "0.22.0"
 description = "Helper tool to generate settings of an Meilisearch index"
 edition = "2021"
 license = "MIT"
@@ -16,6 +16,3 @@ quote = "1.0.21"
 proc-macro2 = "1.0.46"
 convert_case = "0.6.0"
 
-[dev-dependencies]
-meilisearch-sdk = "0.20.1"
-

meilisearch-index-setting-macro/src/lib.rs

@@ -176,10 +176,7 @@ fn extract_all_attr_values(
                                         return std::result::Result::Err(
                                             syn::Error::new(
                                                 ident.span(),
-                                                format!(
-                                                    "`{}` already exists for this field",
-                                                    ident
-                                                ),
+                                                format!("`{ident}` already exists for this field"),
                                             )
                                             .to_compile_error(),
                                         );
@@ -190,8 +187,7 @@ fn extract_all_attr_values(
                                                 syn::Error::new(
                                                     ident.span(),
                                                     format!(
-                                                        "Property `{}` does not exist for type `document`",
-                                                        ident
+                                                        "Property `{ident}` does not exist for type `document`"
                                                     ),
                                                 )
                                                     .to_compile_error(),
@@ -213,7 +209,6 @@ fn extract_all_attr_values(
                 }
             }
             std::result::Result::Err(e) => {
-                println!("{:#?}", attr);
                 for token_stream in attr.tokens.clone().into_iter() {
                     if let TokenTree::Group(group) = token_stream {
                         for token in group.stream() {

meilisearch-test-macro/Cargo.toml

@@ -1,7 +1,8 @@
 [package]
 name = "meilisearch-test-macro"
-version = "0.1.0"
+version = "0.0.0"
 edition = "2021"
+publish = false
 
 [lib]
 proc-macro = true

scripts/update_macro_versions.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+new_version=$(cat Cargo.toml | grep '^version = ')
+
+# Updates the versions in meilisearch-rust and meilisearch-index-setting-macro of the latter, with the latest meilisearch-rust version.
+
+old_index_macro_version=$(cat ./meilisearch-index-setting-macro/Cargo.toml | grep '^version = ')
+old_macro_in_sdk_version=$(cat ./Cargo.toml | grep '{ path = "meilisearch-index-setting-macro", version =')
+
+sed -i '' -e "s/^$old_index_macro_version/$new_version/g" './meilisearch-index-setting-macro/Cargo.toml'
+sed -i '' -e "s/$old_macro_in_sdk_version/meilisearch-index-setting-macro = { path = \"meilisearch-index-setting-macro\", $new_version }/g" './Cargo.toml'

src/client.rs

@@ -63,6 +63,38 @@ impl Client {
         Ok(indexes_results)
     }
 
+    /// Return the host associated with this index.
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// # use meilisearch_sdk::{client::*};
+    /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
+    /// // create the client
+    /// let client = Client::new("http://doggo.dog", MEILISEARCH_API_KEY);
+    ///
+    /// assert_eq!(client.get_host(), "http://doggo.dog");
+    /// ```
+    pub fn get_host(&self) -> &str {
+        &self.host
+    }
+
+    /// Return the api key associated with this index.
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// # use meilisearch_sdk::{client::*};
+    /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
+    /// // create the client
+    /// let client = Client::new(MEILISEARCH_URL, "doggo");
+    ///
+    /// assert_eq!(client.get_api_key(), "doggo");
+    /// ```
+    pub fn get_api_key(&self) -> &str {
+        &self.api_key
+    }
+
     /// List all [Index]es with query parameters and returns values as instances of [Index].
     ///
     /// # Example

src/errors.rs

@@ -122,19 +122,15 @@ pub enum ErrorCode {
     InvalidState,
     PrimaryKeyInferenceFailed,
     IndexPrimaryKeyAlreadyPresent,
-    InvalidRankingRule,
     InvalidStoreFile,
     MaxFieldsLimitExceeded,
     MissingDocumentId,
     InvalidDocumentId,
-    InvalidFilter,
-    InvalidSort,
     BadParameter,
     BadRequest,
     DatabaseSizeLimitReached,
     DocumentNotFound,
     InternalError,
-    InvalidGeoField,
     InvalidApiKey,
     MissingAuthorizationHeader,
     TaskNotFound,
@@ -151,18 +147,81 @@ pub enum ErrorCode {
     MalformedPayload,
     InvalidContentType,
     MissingPayload,
-    MissingParameter,
     InvalidApiKeyDescription,
     InvalidApiKeyActions,
     InvalidApiKeyIndexes,
     InvalidApiKeyExpiresAt,
     ApiKeyNotFound,
-    InvalidTaskTypesFilter,
-    InvalidTaskStatusesFilter,
-    InvalidTaskCanceledByFilter,
-    InvalidTaskUidsFilter,
-    InvalidTaskDateFilter,
     MissingTaskFilters,
+    MissingIndexUid,
+    InvalidIndexOffset,
+    InvalidIndexLimit,
+    InvalidIndexPrimaryKey,
+    InvalidDocumentFields,
+    InvalidDocumentLimit,
+    InvalidDocumentOffset,
+    InvalidDocumentGeoField,
+    InvalidSearchQ,
+    InvalidSearchOffset,
+    InvalidSearchLimit,
+    InvalidSearchPage,
+    InvalidSearchHitsPerPage,
+    InvalidSearchAttributesToRetrieve,
+    InvalidSearchAttributesToCrop,
+    InvalidSearchCropLength,
+    InvalidSearchAttributesToHighlight,
+    InvalidSearchShowMatchesPosition,
+    InvalidSearchFilter,
+    InvalidSearchSort,
+    InvalidSearchFacets,
+    InvalidSearchHighlightPreTag,
+    InvalidSearchHighlightPostTag,
+    InvalidSearchCropMarker,
+    InvalidSearchMatchingStrategy,
+    ImmutableApiKeyUid,
+    ImmutableApiKeyActions,
+    ImmutableApiKeyIndexes,
+    ImmutableExpiresAt,
+    ImmutableCreatedAt,
+    ImmutableUpdatedAt,
+    InvalidSwapDuplicateIndexFound,
+    InvalidSwapIndexes,
+    MissingSwapIndexes,
+    InvalidTaskTypes,
+    InvalidTaskUids,
+    InvalidTaskStatuses,
+    InvalidTaskLimit,
+    InvalidTaskFrom,
+    InvalidTaskCanceledBy,
+    InvalidTaskFilters,
+    TooManyOpenFiles,
+    IoError,
+    InvalidTaskIndexUids,
+    ImmutableIndexUid,
+    ImmutableIndexCreatedAt,
+    ImmutableIndexUpdatedAt,
+    InvalidSettingsDisplayedAttributes,
+    InvalidSettingsSearchableAttributes,
+    InvalidSettingsFilterableAttributes,
+    InvalidSettingsSortableAttributes,
+    InvalidSettingsRankingRules,
+    InvalidSettingsStopWords,
+    InvalidSettingsSynonyms,
+    InvalidSettingsDistinctAttributes,
+    InvalidSettingsTypoTolerance,
+    InvalidSettingsFaceting,
+    InvalidSettingsPagination,
+    InvalidTaskBeforeEnqueuedAt,
+    InvalidTaskAfterEnqueuedAt,
+    InvalidTaskBeforeStartedAt,
+    InvalidTaskAfterStartedAt,
+    InvalidTaskBeforeFinishedAt,
+    InvalidTaskAfterFinishedAt,
+    MissingApiKeyActions,
+    MissingApiKeyIndexes,
+    MissingApiKeyExpiresAt,
+    InvalidApiKeyLimit,
+    InvalidApiKeyOffset,
 
     /// That's unexpected. Please open a GitHub issue after ensuring you are
     /// using the supported version of the Meilisearch server.

src/request.rs

@@ -19,7 +19,7 @@ pub fn add_query_parameters<Query: Serialize>(url: &str, query: &Query) -> Resul
     if query.is_empty() {
         Ok(url.to_string())
     } else {
-        Ok(format!("{}?{}", url, query))
+        Ok(format!("{url}?{query}"))
     }
 }
 
@@ -37,7 +37,7 @@ pub(crate) async fn request<
     use isahc::http::header;
     use isahc::*;
 
-    let auth = format!("Bearer {}", apikey);
+    let auth = format!("Bearer {apikey}");
     let user_agent = qualified_version();
 
     let mut response = match &method {