Merge branch 'main' into main

Author: brunoocasali

.code-samples.meilisearch.yaml

@@ -452,25 +452,23 @@ typo_tolerance_guide_4: |-
           };
   typoTolerance.setMinWordSizeForTypos(minWordSizeTypos);
   client.index("movies").updateTypoToleranceSettings(typoTolerance);
-getting_started_add_documents_md: |-
-  **Maven**
-  Add the following code to the `<dependencies>` section of your project:
-  ```xml
-  <dependency>
-    <groupId>com.meilisearch.sdk</groupId>
-    <artifactId>meilisearch-java</artifactId>
-    <version>0.14.0</version>
-    <type>pom</type>
-  </dependency>
-  ```
-
-  **Gradle**
-  Add the following line to the `dependencies` section of your `build.gradle`:
-  ```groovy
-  implementation 'com.meilisearch.sdk:meilisearch-java:0.14.0'
-  ```
-
-  ```java
+getting_started_add_documents: |-
+  // For Maven:
+  // Add the following code to the `<dependencies>` section of your project:
+  //
+  // <dependency>
+  //   <groupId>com.meilisearch.sdk</groupId>
+  //   <artifactId>meilisearch-java</artifactId>
+  //   <version>0.14.7</version>
+  //   <type>pom</type>
+  // </dependency>
+
+  // For Gradle
+  // Add the following line to the `dependencies` section of your `build.gradle`:
+  //
+  // implementation 'com.meilisearch.sdk:meilisearch-java:0.14.7'
+
+  // In your .java file:
   import com.meilisearch.sdk;
   import java.nio.file.Files;
   import java.nio.file.Path;
@@ -480,17 +478,10 @@ getting_started_add_documents_md: |-
   Client client = new Client(new Config("http://localhost:7700", "aSampleMasterKey"));
   Index index = client.index("movies");
   index.addDocuments(moviesJson);
-  ```
-
-  [About this SDK](https://github.com/meilisearch/meilisearch-java)
 getting_started_check_task_status: |-
   client.getTask(0);
-getting_started_search_md: |-
-  ```java
+getting_started_search: |-
   client.index("movies").search("botman");
-  ```
-
-  [About this SDK](https://github.com/meilisearch/meilisearch-java)
 getting_started_add_meteorites: |-
   import com.meilisearch.sdk;
   import org.json.JSONArray;
@@ -827,3 +818,28 @@ get_similar_post_1:
     .setId("143")
     .setEmbedder("manual");
   client.index("movies").searchSimilarDocuments(query)
+search_parameter_reference_distinct_1: |-
+  SearchRequest searchRequest = SearchRequest.builder().q("QUERY TERMS").distinct("ATTRIBUTE_A").build();
+  client.index("INDEX_NAME").search(searchRequest);
+distinct_attribute_guide_filterable_1: |-
+  Settings settings = new Settings();
+  settings.setFilterableAttributes(new String[] {"product_id", "SKU", "url"});
+  client.index("products").updateSettings(settings);
+distinct_attribute_guide_distinct_parameter_1: |-
+  SearchRequest searchRequest = SearchRequest.builder().q("white shirt").distinct("sku").build();
+  client.index("products").search(searchRequest);
+search_parameter_reference_locales_1: |-
+  SearchRequest searchRequest = SearchRequest.builder().q("QUERY TEXT IN JAPANESE").locales(new String[]{"jpn"}).build();
+  client.index("INDEX_NAME").search(searchRequest);
+get_localized_attribute_settings_1: |-
+  client.index("INDEX_NAME").getLocalizedAttributesSettings();
+update_localized_attribute_settings_1: |-
+  LocalizedAttribute attribute = new LocalizedAttribute();
+  attribute.setAttributePatterns(new String[] {"jpn"});
+  attribute.setLocales(new String[] {"*_ja"});
+
+  client.index("INDEX_NAME").updateLocalizedAttributesSettings(
+    new LocalizedAttributes[] {attribute}
+  );
+reset_localized_attribute_settings_1: |-
+  client.index("INDEX_NAME").resetLocalizedAttributesSettings();

.github/dependabot.yml

@@ -8,6 +8,10 @@ updates:
       - 'skip-changelog'
       - 'dependencies'
     rebase-strategy: disabled
+    groups:
+      github-actions:
+        patterns:
+          - "*"
 
   - package-ecosystem: gradle
     directory: "/"
@@ -19,3 +23,11 @@ updates:
       - skip-changelog
       - dependencies
     rebase-strategy: disabled
+    groups:
+      gradle-plugins:
+        patterns:
+          - "io.github.gradle-nexus.publish-plugin*"
+          - "com.diffplug.spotless*"
+      gradle-dependencies:
+        patterns:
+          - "*"

.github/workflows/ossrh-publish.yml

@@ -0,0 +1,27 @@
+name: Publish to Maven Central
+
+on:
+  push:
+    tags: ["v*"]   # Trigger on version tag pushes (adjust as needed)
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+
+      - name: Publish to Sonatype Central
+        env:
+          # Pass Sonatype portal token credentials to Gradle
+          ORG_GRADLE_PROJECT_sonatypeUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
+          ORG_GRADLE_PROJECT_sonatypePassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
+          MAVEN_CENTRAL_SIGNING_KEY: ${{ secrets.MAVEN_CENTRAL_SIGNING_KEY }}
+          MAVEN_CENTRAL_SIGNING_PASSWORD: ${{ secrets.MAVEN_CENTRAL_SIGNING_PASSWORD }}
+        run: ./gradlew clean publishToSonatype closeAndReleaseSonatypeStagingRepository

.github/workflows/publish.yml

@@ -38,7 +38,7 @@ jobs:
           path: build/reports/tests/integrationTest
           if-no-files-found: ignore
       - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 

.github/workflows/tests.yml

@@ -199,29 +199,22 @@ gpg --gen-key --batch genkey
 gpg --keyserver hkp://keyserver.ubuntu.com --send-keys <last-8-digits-of-your-key-hash>
 ```
 
-5. Export the gpg key in a secring.gpg file
+5. Export the gpg key in a signing-key.asc armored file
 
 ```bash
-gpg --keyring secring.gpg --export-secret-keys > ~/.gnupg/secring.gpg
-```
-
-6. Encode the secring in base64 and store it (Used by the ossrh-publish workflow)
-
-```bash
-base64 ~/.gnupg/secring.gpg > secring.gpg.b64
+gpg --armor --export-secret-keys $KEY_ID > signing-key.asc
 ```
 
 #### Sign your files and upload to Maven Repository manually <!-- omit in TOC -->
 
 1. Set the environment variables listed below with the required credentials:
 
 ```bash
-export OSSRH_USERNAME=<maven-username>
-export OSSRH_PASSWORD=<maven-password>
+export MAVEN_CENTRAL_USERNAME=<maven-username>
+export MAVEN_CENTRAL_PASSWORD=<maven-password>
 
 export SIGNINT_KEY_ID=<id-associated-to-the-gpg-key>
 export SIGNING_PASSWORD=<passphrase-associated-to-the-gpg-key>
-export SIGNING_SECRET_KEY_RING_FILE=<path-to-gpg-key-encoded-in-base64>
 ```
 
 2. Decode the gpg key
@@ -235,13 +228,13 @@ base64 -d $SIGNING_SECRET_KEY_RING_FILE > secring.gpg
 ```bash
 # May need sudo privilege and JDK8
 ./gradlew build
-./gradlew publish -Psigning.keyId=$SIGNING_KEY_ID -Psigning.password=$SIGNING_PASSWORD -Psigning.secretKeyRingFile=$(echo secring.gpg)
+TODO
 ```
 
-4. Login to [Sonatype Nexus](https://oss.sonatype.org).
-5. Navigate to `Staging repositories`.
-6. Close your repository by clicking on the `Close` button. Checks will be made by nexus. It might take time. If any error occurs, it will be visible in the `Activity` tab.
-7. Once the check have succeeded, you should be able to click on the `Release` button. The release will be now processed and might take a long time to appear in [Maven Central](https://search.maven.org/artifact/com.meilisearch.sdk/meilisearch-java).
+4. Login to [Sonatype Nexus](https://central.sonatype.com/).
+5. Navigate to `Deployments`.
+6. Checks will be made by Sonatype. It might take time. If any error occurs, it will be visible in the `Deployments` tab (last one).
+7. Once the check have succeeded, the release will be now processed and it will appear in [Maven Central](https://central.sonatype.com/artifact/com.meilisearch.sdk/meilisearch-java/versions).
 
 <hr>
 

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2024 Meili SAS
+Copyright (c) 2020-2025 Meili SAS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -31,7 +31,6 @@
 ## Table of Contents <!-- omit in TOC -->
 
 - [📖 Documentation](#-documentation)
-- [⚡ Supercharge your Meilisearch experience](#-supercharge-your-meilisearch-experience)
 - [🔧 Installation](#-installation)
 - [🚀 Getting started](#-getting-started)
 - [🛠 Customization](#-customization)
@@ -47,10 +46,6 @@ For general information on how to use Meilisearch—such as our API reference, t
 
 
 
-## ⚡ Supercharge your Meilisearch experience
-
-Say goodbye to server deployment and manual updates with [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-java). Get started with a 14-day free trial! No credit card required.
-
 ## 🔧 Installation
 
 `meilisearch-java` is available from JCentral official repository. To be able to import this package, declare it as a dependency in your project:
@@ -63,7 +58,7 @@ Add the following code to the `<dependencies>` section of your project:
 <dependency>
   <groupId>com.meilisearch.sdk</groupId>
   <artifactId>meilisearch-java</artifactId>
-  <version>0.14.0</version>
+  <version>0.14.7</version>
   <type>pom</type>
 </dependency>
 ```
@@ -73,26 +68,16 @@ Add the following code to the `<dependencies>` section of your project:
 Add the following line to the `dependencies` section of your `build.gradle`:
 
 ```groovy
-implementation 'com.meilisearch.sdk:meilisearch-java:0.14.0'
+implementation 'com.meilisearch.sdk:meilisearch-java:0.14.7'
 ```
 
 :warning: `meilisearch-java` also requires `okhttp` as a peer dependency.
 
 ### Run Meilisearch <!-- omit in toc -->
 
-There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/learn/getting_started/installation).
-
-For example, using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):
-
-```bash
- # Install Meilisearch
- curl -L https://install.meilisearch.com | sh
-
- # Launch Meilisearch
- ./meilisearch --master-key=masterKey
- ```
+⚡️ **Launch, scale, and streamline in minutes with Meilisearch Cloud**—no maintenance, no commitment, cancel anytime. [Try it free now](https://cloud.meilisearch.com/login?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-java).
 
-NB: you can also download Meilisearch from **Homebrew** or **APT** or even run it using **Docker**.
+🪨  Prefer to self-host? [Download and deploy](https://www.meilisearch.com/docs/learn/self_hosted/getting_started_with_self_hosted_meilisearch?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-java) our fast, open-source search engine on your own infrastructure.
 
 ## 🚀 Getting started
 
@@ -162,10 +147,10 @@ import com.meilisearch.sdk.SearchRequest;
 
 // ...
 
-SearchResult results = index.search(
-  new SearchRequest("of")
-  .setShowMatchesPosition(true)
-  .setAttributesToHighlight(new String[]{"title"})
+SearchResult results = (SearchResult) index.search(
+    new SearchRequest("of")
+        .setShowMatchesPosition(true)
+        .setAttributesToHighlight(new String[]{"title"})
 );
 System.out.println(results.getHits());
 ```
@@ -231,6 +216,38 @@ index.search(
   "query": "wonder"
 }
 ```
+#### Custom Search With Pagination <!-- omit in toc -->
+
+```java
+import com.meilisearch.sdk.SearchResultPaginated;
+
+// ...
+
+SearchResultPaginated results = (SearchResultPaginated) index.search(
+    new SearchRequest("wonder")
+        .setPage(1)
+        .setHitsPerPage(20)
+);
+```
+
+```json
+{
+    "hits": [
+        {
+            "id": 2,
+            "title": "Wonder Woman",
+            "genres": ["Action","Adventure"]
+        }
+    ], 
+    "query": "wonder",
+    "processingTimeMs": 0,
+    "hitsPerPage": 20,
+    "page": 1,
+    "totalPages": 1,
+    "totalHits": 1
+}
+```
+
 ## 🛠 Customization
 
 ### JSON <!-- omit in toc -->
@@ -274,6 +291,12 @@ Client client = new Client(config);
 
 This package guarantees compatibility with [version v1.x of Meilisearch](https://github.com/meilisearch/meilisearch/releases/latest), but some features may not be present. Please check the [issues](https://github.com/meilisearch/meilisearch-java/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3Aenhancement) for more info.
 
+This SDK is compatible with the following JDK versions:
+
+| SDK Version | Supported Java Versions |
+|-------------|-------------------------|
+| v1.x        | JDK 8 and above         |
+
 ## 💡 Learn more
 
 The following sections in our main documentation website may interest you: