feat: migrate to APIv4

.changeset/config.json

@@ -3,7 +3,7 @@
   "changelog": [
     "@fingerprintjs/changesets-changelog-format",
     {
-      "repo": "fingerprintjs/fingerprint-pro-server-api-java-sdk"
+      "repo": "fingerprintjs/java-sdk"
     }
   ],
   "commit": false,

.changeset/pre.json

@@ -0,0 +1,8 @@
+{
+  "mode": "pre",
+  "tag": "rc",
+  "initialVersions": {
+    "java-sdk": "7.10.0"
+  },
+  "changesets": []
+}

.changeset/weak-eagles-deliver.md

@@ -0,0 +1,14 @@
+---
+"java-sdk": major
+---
+
+Migrate to Server API v4
+
+**BREAKING CHANGES**: This release contains multiple breaking changes:
+
+- SDK version bumped to `8.0.0`
+- Server API version upgraded from v3 to v4
+- Removed `GetVisits` and `GetRelatedVisitors` operations.
+- Improved models used by the `GetEvent` and `SearchEvents` operations to use a more concise shape and clearer names.
+
+See [this page in the Fingerprint documentation](https://docs.fingerprint.com/reference/java-server-sdk#migration-guide-for-java-sdk-v8-0-0) for a migration guide.

.github/workflows/test.yml

@@ -19,4 +19,5 @@ jobs:
         with:
           distribution: 'zulu'
           java-version: '${{ matrix.java }}'
-      - run: ./gradlew test
+        # includes execution of unit tests
+      - run: ./gradlew build

.gitignore

@@ -16,3 +16,7 @@ build
 .DS_Store
 .openapi-generator
 **/node_modules
+
+# Covers the case where test resources are copied to the bin
+# directory by Java tools
+sdk/bin

.openapi-generator-ignore

@@ -3,7 +3,7 @@ build.sbt
 git_push.sh
 api/*
 src/test/java/com/fingerprint/model/*
+src/main/java/com/fingerprint/model/AbstractOpenApiSchema.java
 src/main/AndroidManifest.xml
 .github/workflows/maven.yml
 pom.xml
-src/main/AndroidManifest.xml

changeset-publish.sh

@@ -1,2 +1,2 @@
 #!/usr/bin/env bash
-bash ./scripts/generate.sh && pnpm exec changeset publish && bash ./gradlew publishToMavenLocal
+pnpm exec changeset publish

changeset-version.sh

@@ -1,2 +1,10 @@
 #!/usr/bin/env bash
-pnpm exec changeset version && bash ./scripts/generate.sh
+
+# Change the package.json version
+pnpm exec changeset version && \
+
+# Change the gradle version
+bash ./scripts/update-gradle-version.sh && \
+
+# Re-generate the code with the updated version
+bash ./scripts/generate.sh

contributing.md

@@ -2,38 +2,36 @@
 
 ## Structure
 
-Most files in the project are autogenerated by [openapi-generator](https://openapi-generator.tech/) for java.
+Most files in the project are autogenerated by [openapi-generator](https://openapi-generator.tech/) for Java.
 
-- [template](./template) - folder contains redefined templates of `openapi-generator`. For generating original templates, you can run this command:
-  `java -jar ./bin/generator.jar author template -g java --library jersey2`
+- [template](./template) - templates used by `openapi-generator`.
 - [docs](./docs) - generated documentation for models and [API Client](./docs/FingerprintApi.md).
-- [src](./src) - API Client code is generated automatically.
+- [sdk](./sdk) - automatically generated API client code.
 
-## Code generation
+## Code generation and building the SDK
 
-You need `openapi-generator` to run code generation. There are many ways described in the [readme](https://github.com/OpenAPITools/openapi-generator).
-In the project we use local jar file `bin/generator.jar`.
+Use the Gradle build to invoke `openapi-generator` and generate the code and documentation:
 
-You can just run `sh ./scripts/generate.sh` script and it will do all the work.
+```
+./gradlew build
+```
 
-To download fresh OpenAPI schema run `sh ./scripts/sync.sh`
+To download the latest OpenAPI schema from [fingerprintjs/fingerprint-pro-server-api-openapi](https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi), run `./scripts/sync.sh`
 
-### Testing the local source code of the SDK
+## Testing the local source code of the SDK
 
 Use the [./src/examples/java/com/fingerprint/example/FunctionalTests.java](./src/examples/java/com/fingerprint/example/FunctionalTests.java) file to make API requests using the local version of the SDK.
 
-1. Make sure you have [Java Development Kit v17](https://formulae.brew.sh/formula/openjdk@17) installed (v20 does not currently work).
-2. Create an `.env` file in the root folder according to [.env.example](.env.example) with your API key and test variables.
+1. Make sure you have Java Development Kit 11 or later installed.
+2. Create an `.env` file in the root of this repo, using [.env.example](.env.example) as the starting point.
 3. Finally, run `./gradlew runFunctionalTests`.
 
 ### Configuration
 
-Project configuration is described in `config.yaml` file. To read about available parameters run the command below:
-
-```shell
-java -jar ./bin/generator.jar config-help -l java
-```
+The Gradle configuration defines the options for `openapi-generator`, within the `openApiGenerate` block in [sdk.gradle.kts](./sdk/sdk.gradle.kts).
 
 ### How to publish
 
-We use [changesets](https://github.com/changesets/changesets) for handling release notes. If there are relevant changes, please add them to changeset via `pnpm exec changeset`. You need to run `pnpm install` before doing so.
+We use [changesets](https://github.com/changesets/changesets) for handling release notes. If there are relevant changes, please add them to changeset via `pnpm exec changeset`. You need to run `pnpm install` before doing so.
+
+When creating [prereleases](https://github.com/changesets/changesets/blob/main/docs/prereleases.md), the `rc` tag must be used. This ensures that version ranges in Maven/Gradle do not pick the prerelease as a new version. For more information, refer to the [Version Order Specification Maven Documentation](https://maven.apache.org/pom.html#version-order-specification).

docs/BotInfo.md

@@ -0,0 +1,40 @@
+
+
+# BotInfo
+
+Extended bot information.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**category** | **String** | The type and purpose of the bot. |  |
+|**provider** | **String** | The organization or company operating the bot. |  |
+|**providerUrl** | **String** | The URL of the bot provider's website. |  [optional] |
+|**name** | **String** | The specific name or identifier of the bot. |  |
+|**identity** | [**IdentityEnum**](#IdentityEnum) | The verification status of the bot's identity:  * `verified` - well-known bot with publicly verifiable identity, directed by the bot provider.  * `signed` - bot that signs its platform via Web Bot Auth, directed by the bot provider’s customers.  * `spoofed` - bot that claims a public identity but fails verification.  * `unknown` - bot that does not publish a verifiable identity.  |  |
+|**confidence** | [**ConfidenceEnum**](#ConfidenceEnum) | Confidence level of the bot identification. |  |
+
+
+
+## Enum: IdentityEnum
+
+| Name | Value |
+|---- | -----|
+| VERIFIED | "verified" |
+| SIGNED | "signed" |
+| SPOOFED | "spoofed" |
+| UNKNOWN | "unknown" |
+
+
+
+## Enum: ConfidenceEnum
+
+| Name | Value |
+|---- | -----|
+| LOW | "low" |
+| MEDIUM | "medium" |
+| HIGH | "high" |
+
+
+

docs/BotdBotResult.md → docs/BotResult.md

@@ -1,20 +1,20 @@
 
 
-# BotdBotResult
-    Bot detection result:
- * `notDetected` - the visitor is not a bot
- * `good` - good bot detected, such as Google bot, Baidu Spider, AlexaBot and so on
+# BotResult
+Bot detection result:
  * `bad` - bad bot detected, such as Selenium, Puppeteer, Playwright, headless browsers, and so on
+ * `good` - good bot detected, such as Google bot, Baidu Spider, AlexaBot and so on
+ * `not_detected` - the visitor is not a bot
 
 
 ## Enum
 
 
-* `NOT_DETECTED` (value: `"notDetected"`)
+* `BAD` (value: `"bad"`)
 
 * `GOOD` (value: `"good"`)
 
-* `BAD` (value: `"bad"`)
+* `NOT_DETECTED` (value: `"not_detected"`)
 
 
 

docs/BrowserDetails.md

@@ -13,7 +13,6 @@
 |**os** | **String** |  |  |
 |**osVersion** | **String** |  |  |
 |**device** | **String** |  |  |
-|**userAgent** | **String** |  |  |
 
 
 

docs/Canvas.md

@@ -0,0 +1,16 @@
+
+
+# Canvas
+
+Canvas fingerprint containing winding flag plus geometry/text hashes.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**winding** | **Boolean** |  |  [optional] |
+|**geometry** | **String** | Hash of geometry rendering output or `unsupported` markers. |  [optional] |
+|**text** | **String** | Hash of text rendering output or `unsupported` markers. |  [optional] |
+
+
+

docs/Emoji.md

@@ -0,0 +1,22 @@
+
+
+# Emoji
+
+Bounding box metrics describing how the emoji glyph renders.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**font** | **String** | Font family reported by the browser when drawing the emoji. |  [optional] |
+|**width** | **Double** |  |  [optional] |
+|**height** | **Double** |  |  [optional] |
+|**top** | **Double** |  |  [optional] |
+|**bottom** | **Double** |  |  [optional] |
+|**left** | **Double** |  |  [optional] |
+|**right** | **Double** |  |  [optional] |
+|**x** | **Double** |  |  [optional] |
+|**y** | **Double** |  |  [optional] |
+
+
+