diff --git a/.changeset/cyan-lobsters-look.md b/.changeset/cyan-lobsters-look.md deleted file mode 100644 index 23e7b45a..00000000 --- a/.changeset/cyan-lobsters-look.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@fingerprint/node-sdk': patch ---- - -**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 deleted file mode 100644 index e411a2d9..00000000 --- a/.changeset/early-seas-look.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -'@fingerprint/node-sdk': major ---- - -**Server API v3 -> Server API v4 migration** - -- All endpoints switched to `/v4/*`. -- `authenticationMode` option removed from `FingerprintServerApiClient`. -- `request_id` renamed to `event_id`. -- 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`). -- **`updateEvent` signature changed**: `(eventId, body)` instead of `(body, eventId)`. - -**Migration Notes:** - -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 FingerprintServerApiClient({ -- 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', - } - } -``` - -`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 - const event = await client.getEvent(eventId) -- console.log(event.products.identification.data.visitorId) -+ console.log(event.identification.visitor_id) -``` - -Remove any usage of the removed types (`VisitorHistoryFilter`, `ErrorPlainResponse`, `VisitorsResponse`, `RelatedVisitorsResponse`, -`RelatedVisitorsFilter`, `Webhook`, `EventsUpdateRequest`). diff --git a/.changeset/loud-waves-drive.md b/.changeset/loud-waves-drive.md deleted file mode 100644 index fd1c6e99..00000000 --- a/.changeset/loud-waves-drive.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@fingerprint/node-sdk': major ---- - -**Package renamed** from `@fingerprintjs/fingerprintjs-pro-server-api` to `@fingerprint/node-sdk`. diff --git a/.changeset/pre.json b/.changeset/pre.json deleted file mode 100644 index e20de97e..00000000 --- a/.changeset/pre.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "mode": "exit", - "tag": "test", - "initialVersions": { - "@fingerprint/node-sdk": "6.10.0", - "node-sdk-example": "1.0.0", - "node-sdk-smoke-tests": "2.0.0" - }, - "changesets": [ - "cyan-lobsters-look", - "early-seas-look", - "loud-waves-drive", - "witty-lobsters-film" - ] -} diff --git a/.changeset/witty-lobsters-film.md b/.changeset/witty-lobsters-film.md deleted file mode 100644 index ef559ed1..00000000 --- a/.changeset/witty-lobsters-film.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@fingerprint/node-sdk': minor ---- - -Added `options` parameter to the `getEvent` operation. diff --git a/CHANGELOG.md b/CHANGELOG.md index bcc60ff0..c76d0c62 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,92 @@ # Fingerprint Server API Node.js SDK +## 7.0.0 + +### Major Changes + +- **Server API v3 -> Server API v4 migration** + + - All endpoints switched to `/v4/*`. + - `authenticationMode` option removed from `FingerprintServerApiClient`. + - `request_id` renamed to `event_id`. + - 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`). + - **`updateEvent` signature changed**: `(eventId, body)` instead of `(body, eventId)`. + + **Migration Notes:** + + 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 FingerprintServerApiClient({ + - 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', + } + } + ``` + + `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 + const event = await client.getEvent(eventId) + - console.log(event.products.identification.data.visitorId) + + console.log(event.identification.visitor_id) + ``` + + Remove any usage of the removed types (`VisitorHistoryFilter`, `ErrorPlainResponse`, `VisitorsResponse`, `RelatedVisitorsResponse`, + `RelatedVisitorsFilter`, `Webhook`, `EventsUpdateRequest`). ([ce2854d](https://github.com/fingerprintjs/node-sdk/commit/ce2854dc064037cd7b2583cb076e671db58d0866)) + +- **Package renamed** from `@fingerprintjs/fingerprintjs-pro-server-api` to `@fingerprint/node-sdk`. ([385b01b](https://github.com/fingerprintjs/node-sdk/commit/385b01b7f9e49422bc3b5e4a4423b73c241a9766)) + +### Minor Changes + +- Added `options` parameter to the `getEvent` operation. ([3ebae43](https://github.com/fingerprintjs/node-sdk/commit/3ebae43482985bf1100ce9cc499fa5da1caeb45f)) + +### Patch Changes + +- **Performance**: Avoid the overhead of cloning and double-buffering large payloads in the success case. ([bc3fd33](https://github.com/fingerprintjs/node-sdk/commit/bc3fd3385903f17f04015140945e721be39ed438)) + ## 7.0.0-test.1 ### Major Changes diff --git a/package.json b/package.json index 8af8d233..e8eee61e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@fingerprint/node-sdk", - "version": "7.0.0-test.1", + "version": "7.0.0", "description": "Node.js wrapper for Fingerprint Server API", "main": "dist/index.cjs", "module": "dist/index.mjs",