From ae3a03c345520726d70018ed9b8f96c1c597ce96 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eray=20Ayd=C4=B1n?= Date: Tue, 3 Mar 2026 16:05:43 +0300 Subject: [PATCH 1/7] chore: reorganize changeset files --- .changeset/cyan-lobsters-look.md | 2 +- .changeset/early-seas-look.md | 20 +++++++++++--------- .changeset/loud-waves-drive.md | 2 +- .changeset/ten-chicken-cough.md | 2 +- .changeset/witty-lobsters-film.md | 2 +- 5 files changed, 15 insertions(+), 13 deletions(-) diff --git a/.changeset/cyan-lobsters-look.md b/.changeset/cyan-lobsters-look.md index 6860fdea..0e717928 100644 --- a/.changeset/cyan-lobsters-look.md +++ b/.changeset/cyan-lobsters-look.md @@ -2,4 +2,4 @@ '@fingerprint/node-sdk': patch --- -**perf**: Avoid the overhead of cloning and double-buffering large payloads on success case. +**Performance**: Avoid the overhead of cloning and double-buffering large payloads on success case. diff --git a/.changeset/early-seas-look.md b/.changeset/early-seas-look.md index 4d502753..0778c4a7 100644 --- a/.changeset/early-seas-look.md +++ b/.changeset/early-seas-look.md @@ -2,16 +2,18 @@ '@fingerprint/node-sdk': major --- -**Server APIv3 -> Server APIv4 migration** +**Server API v3 -> Server API v4 migration** -- Switch all endpoints to `/v4/*`. -- Remove `authenticationMode` option when initializing `FingerprintServerApiClient`. -- Rename `request_id` to `event_id`. -- Use snake_case fields when updating an event. -- Use `PATCH` method when updating an event. -- Examples, tests, and docs updated. +- All endpoints now use `/v4/*`. +- `authenticationMode` option removed from `FingerprintServerApiClient`. +- `request_id` renamed to `event_id`. +- Event updates now use _snake\_case_ fields and `PATCH` method. +- Response models are now use _snake\_case_ fields. +- **Removed APIs**: `getVisits()`, `getRelatedVisitors()`, and related types (`VisitorHistoryFilter`, +`ErrorPlainResponse`, `VisitorsResponse`, `RelatedVisitorsResponse`, `RelatedVisitorsFilter`, `Webhook`, +`EventsUpdateRequest`). -**BREAKING CHANGES** +**Migration Notes:** - Use new client when initializing: `FingerprintServerApiClient`. - `authenticationMode` option removed. - Removed `getVisits()` function. @@ -19,4 +21,4 @@ - Removed `VisitorHistoryFilter`, `ErrorPlainResponse`, `VisitorsResponse`, `RelatedVisitorsResponse`, `RelatedVisitorsFilter`, `Webhook`, `EventsUpdateRequest` types. - Use `tags` instead of `tag` for updating an event. -- Response models changed. +- Response models changed. Use _snake\_case_ fields. diff --git a/.changeset/loud-waves-drive.md b/.changeset/loud-waves-drive.md index bc432bff..fd1c6e99 100644 --- a/.changeset/loud-waves-drive.md +++ b/.changeset/loud-waves-drive.md @@ -2,4 +2,4 @@ '@fingerprint/node-sdk': major --- -change package name to `@fingerprint/node-sdk` +**Package renamed** from `@fingerprintjs/fingerprintjs-pro-server-api` to `@fingerprint/node-sdk`. diff --git a/.changeset/ten-chicken-cough.md b/.changeset/ten-chicken-cough.md index dbc11b2e..ebf69e26 100644 --- a/.changeset/ten-chicken-cough.md +++ b/.changeset/ten-chicken-cough.md @@ -2,4 +2,4 @@ '@fingerprint/node-sdk': major --- -**BREAKING**: `updateEvent` now takes `eventId` as the first parameter and `body` as the second. +**`updateEvent` signature changed**: now takes `(eventId, body)` instead of `(body, eventId)`. diff --git a/.changeset/witty-lobsters-film.md b/.changeset/witty-lobsters-film.md index 8d5dca72..ef559ed1 100644 --- a/.changeset/witty-lobsters-film.md +++ b/.changeset/witty-lobsters-film.md @@ -2,4 +2,4 @@ '@fingerprint/node-sdk': minor --- -add `options` parameter to the `getEvent` operation +Added `options` parameter to the `getEvent` operation. From b4c0ee541d88e59a2468061d48103a30266ff12c Mon Sep 17 00:00:00 2001 From: Eray AYDIN Date: Tue, 3 Mar 2026 16:55:54 +0300 Subject: [PATCH 2/7] docs: improve changeset file Co-authored-by: Juraj Uhlar --- .changeset/early-seas-look.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/early-seas-look.md b/.changeset/early-seas-look.md index 0778c4a7..1931dcdf 100644 --- a/.changeset/early-seas-look.md +++ b/.changeset/early-seas-look.md @@ -8,7 +8,7 @@ - `authenticationMode` option removed from `FingerprintServerApiClient`. - `request_id` renamed to `event_id`. - Event updates now use _snake\_case_ fields and `PATCH` method. -- Response models are now use _snake\_case_ fields. +- Response models now use _snake\_case_ fields. - **Removed APIs**: `getVisits()`, `getRelatedVisitors()`, and related types (`VisitorHistoryFilter`, `ErrorPlainResponse`, `VisitorsResponse`, `RelatedVisitorsResponse`, `RelatedVisitorsFilter`, `Webhook`, `EventsUpdateRequest`). From d2c53678f09a3315f947e08202645807474a4cb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eray=20Ayd=C4=B1n?= Date: Tue, 3 Mar 2026 17:19:24 +0300 Subject: [PATCH 3/7] chore: improve migration notes section --- .changeset/early-seas-look.md | 64 +++++++++++++++++++++++++++++------ 1 file changed, 54 insertions(+), 10 deletions(-) diff --git a/.changeset/early-seas-look.md b/.changeset/early-seas-look.md index 1931dcdf..d73630a2 100644 --- a/.changeset/early-seas-look.md +++ b/.changeset/early-seas-look.md @@ -10,15 +10,59 @@ - Event updates now use _snake\_case_ fields and `PATCH` method. - Response models now use _snake\_case_ fields. - **Removed APIs**: `getVisits()`, `getRelatedVisitors()`, and related types (`VisitorHistoryFilter`, -`ErrorPlainResponse`, `VisitorsResponse`, `RelatedVisitorsResponse`, `RelatedVisitorsFilter`, `Webhook`, -`EventsUpdateRequest`). + `ErrorPlainResponse`, `VisitorsResponse`, `RelatedVisitorsResponse`, `RelatedVisitorsFilter`, `Webhook`, + `EventsUpdateRequest`). **Migration Notes:** -- Use new client when initializing: `FingerprintServerApiClient`. -- `authenticationMode` option removed. -- Removed `getVisits()` function. -- Removed `getRelatedVisitors()` function. -- Removed `VisitorHistoryFilter`, `ErrorPlainResponse`, `VisitorsResponse`, `RelatedVisitorsResponse`, -`RelatedVisitorsFilter`, `Webhook`, `EventsUpdateRequest` types. -- Use `tags` instead of `tag` for updating an event. -- Response models changed. Use _snake\_case_ fields. + +Use new client when initializing: `FingerprintServerApiClient`: + +```diff +- const client = new FingerprintJsServerApiClient(config) ++ const client = new FingerprintServerApiClient(config) +``` + +`authenticationMode` option removed from constructor: + +```diff + const client = new FingerprintServerApplication({ +- authenticationMode: AuthenticationMode.AuthHeader + // ... + }) +``` + +Use `searchEvents` function instead of `getVisits()`: + +```diff +- client.getVisits('VISITOR_ID', { limit: 1 }) ++ client.searchEvents({ visitor_id: 'VISITOR_ID', limit: 1 }) +``` + +Related visitors API (`getRelatedVisitors()`) is removed: + +```diff +- client.getRelatedVisitors({ visitor_id: 'VISITOR_ID' }) +``` + +Use `tags` instead of `tag` for updating an event: + +```diff +- const body: EventsUpdateRequest = { ++ const body: EventUpdate = { +- tag: { ++ tags: { + key: 'value', + } + } +``` + +Use simplified and _snake\_case_ fields for the response: + +``` + const event = await client.getEvent(eventId) +- console.log(event.products.identification.data.visitorId) ++ console.log(event.identification.visitor_id) +``` + +Delete any usage from removed types (`VisitorHistoryFilter`, `ErrorPlainResponse`, `VisitorsResponse`, `RelatedVisitorsResponse`, +`RelatedVisitorsFilter`, `Webhook`, `EventsUpdateRequest`). From d83800cef44fe0aea88ff9ae434a823eaf387921 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eray=20Ayd=C4=B1n?= Date: Tue, 3 Mar 2026 17:22:32 +0300 Subject: [PATCH 4/7] chore: fix typo in migration notes section --- .changeset/early-seas-look.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.changeset/early-seas-look.md b/.changeset/early-seas-look.md index d73630a2..d2cec66f 100644 --- a/.changeset/early-seas-look.md +++ b/.changeset/early-seas-look.md @@ -25,10 +25,10 @@ Use new client when initializing: `FingerprintServerApiClient`: `authenticationMode` option removed from constructor: ```diff - const client = new FingerprintServerApplication({ -- authenticationMode: AuthenticationMode.AuthHeader - // ... - }) +const client = new FingerprintServerApiClient({ +- authenticationMode: AuthenticationMode.AuthHeader + // ... +}) ``` Use `searchEvents` function instead of `getVisits()`: From a02f02f190aa3ca4cf77d6fef9d889838597661a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eray=20Ayd=C4=B1n?= Date: Tue, 3 Mar 2026 17:25:10 +0300 Subject: [PATCH 5/7] chore: add missing diff to codeblock --- .changeset/early-seas-look.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/early-seas-look.md b/.changeset/early-seas-look.md index d2cec66f..14b8ebb5 100644 --- a/.changeset/early-seas-look.md +++ b/.changeset/early-seas-look.md @@ -58,7 +58,7 @@ Use `tags` instead of `tag` for updating an event: Use simplified and _snake\_case_ fields for the response: -``` +```diff const event = await client.getEvent(eventId) - console.log(event.products.identification.data.visitorId) + console.log(event.identification.visitor_id) From 00f7c6beae18086f90ed103cf45b393ec359e833 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eray=20Ayd=C4=B1n?= Date: Tue, 3 Mar 2026 18:27:44 +0300 Subject: [PATCH 6/7] chore: use consistent past tense in changeset --- .changeset/cyan-lobsters-look.md | 2 +- .changeset/early-seas-look.md | 8 ++++---- .changeset/ten-chicken-cough.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.changeset/cyan-lobsters-look.md b/.changeset/cyan-lobsters-look.md index 0e717928..23e7b45a 100644 --- a/.changeset/cyan-lobsters-look.md +++ b/.changeset/cyan-lobsters-look.md @@ -2,4 +2,4 @@ '@fingerprint/node-sdk': patch --- -**Performance**: Avoid the overhead of cloning and double-buffering large payloads on success case. +**Performance**: Avoid the overhead of cloning and double-buffering large payloads in the success case. diff --git a/.changeset/early-seas-look.md b/.changeset/early-seas-look.md index 14b8ebb5..58c0f413 100644 --- a/.changeset/early-seas-look.md +++ b/.changeset/early-seas-look.md @@ -4,11 +4,11 @@ **Server API v3 -> Server API v4 migration** -- All endpoints now use `/v4/*`. +- All endpoints switched to `/v4/*`. - `authenticationMode` option removed from `FingerprintServerApiClient`. - `request_id` renamed to `event_id`. -- Event updates now use _snake\_case_ fields and `PATCH` method. -- Response models now use _snake\_case_ fields. +- Event updates switched to _snake\_case_ fields and `PATCH` method. +- Response models switched to _snake\_case_ fields. - **Removed APIs**: `getVisits()`, `getRelatedVisitors()`, and related types (`VisitorHistoryFilter`, `ErrorPlainResponse`, `VisitorsResponse`, `RelatedVisitorsResponse`, `RelatedVisitorsFilter`, `Webhook`, `EventsUpdateRequest`). @@ -64,5 +64,5 @@ Use simplified and _snake\_case_ fields for the response: + console.log(event.identification.visitor_id) ``` -Delete any usage from removed types (`VisitorHistoryFilter`, `ErrorPlainResponse`, `VisitorsResponse`, `RelatedVisitorsResponse`, +Remove any usage of the removed types (`VisitorHistoryFilter`, `ErrorPlainResponse`, `VisitorsResponse`, `RelatedVisitorsResponse`, `RelatedVisitorsFilter`, `Webhook`, `EventsUpdateRequest`). diff --git a/.changeset/ten-chicken-cough.md b/.changeset/ten-chicken-cough.md index ebf69e26..76eced0b 100644 --- a/.changeset/ten-chicken-cough.md +++ b/.changeset/ten-chicken-cough.md @@ -2,4 +2,4 @@ '@fingerprint/node-sdk': major --- -**`updateEvent` signature changed**: now takes `(eventId, body)` instead of `(body, eventId)`. +**`updateEvent` signature changed**: `(eventId, body)` instead of `(body, eventId)`. From e451fd6b0c0b27cd1605d04a4f63143671d50ba9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eray=20Ayd=C4=B1n?= Date: Tue, 3 Mar 2026 18:35:36 +0300 Subject: [PATCH 7/7] chore: merge updateEvent changeset into main --- .changeset/early-seas-look.md | 8 ++++++++ .changeset/pre.json | 1 - .changeset/ten-chicken-cough.md | 5 ----- 3 files changed, 8 insertions(+), 6 deletions(-) delete mode 100644 .changeset/ten-chicken-cough.md diff --git a/.changeset/early-seas-look.md b/.changeset/early-seas-look.md index 58c0f413..e411a2d9 100644 --- a/.changeset/early-seas-look.md +++ b/.changeset/early-seas-look.md @@ -12,6 +12,7 @@ - **Removed APIs**: `getVisits()`, `getRelatedVisitors()`, and related types (`VisitorHistoryFilter`, `ErrorPlainResponse`, `VisitorsResponse`, `RelatedVisitorsResponse`, `RelatedVisitorsFilter`, `Webhook`, `EventsUpdateRequest`). +- **`updateEvent` signature changed**: `(eventId, body)` instead of `(body, eventId)`. **Migration Notes:** @@ -56,6 +57,13 @@ Use `tags` instead of `tag` for updating an event: } ``` +`updateEvent` parameter order changed to `(eventId, body)`: + +```diff +- client.updateEvent(body, 'EVENT_ID') ++ client.updateEvent('EVENT_ID', body) +``` + Use simplified and _snake\_case_ fields for the response: ```diff diff --git a/.changeset/pre.json b/.changeset/pre.json index 357e937f..e20de97e 100644 --- a/.changeset/pre.json +++ b/.changeset/pre.json @@ -10,7 +10,6 @@ "cyan-lobsters-look", "early-seas-look", "loud-waves-drive", - "ten-chicken-cough", "witty-lobsters-film" ] } diff --git a/.changeset/ten-chicken-cough.md b/.changeset/ten-chicken-cough.md deleted file mode 100644 index 76eced0b..00000000 --- a/.changeset/ten-chicken-cough.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@fingerprint/node-sdk': major ---- - -**`updateEvent` signature changed**: `(eventId, body)` instead of `(body, eventId)`.