INTER-1488: Migrate SDK to APIv4

.changeset/config.json

@@ -12,5 +12,5 @@
   "access": "public",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",
-  "ignore": ["fingerprintjs-pro-server-api-node-sdk-example"]
+  "ignore": ["fingerprint-server-sdk-example"]
 }

.changeset/early-seas-look.md

@@ -0,0 +1,24 @@
+---
+'@fingerprint/fingerprint-server-sdk': major
+---
+
+**Server APIv3 -> Server APIv4 migration**
+
+- Switch all endpoints to `/v4/*`.
+- Remove `authenticationMode` option when initializing `FingerprintJsServerApiClient`.
+- 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.
+
+**BREAKING CHANGES**
+- `authenticationMode` option removed.
+- Endpoints and method signatures changed.
+  - Use `eventId` instead of `requestId` when triggering `updateEvent()` function.
+  - Use `eventId` instead of `requestId` when triggering `getEvent()` function.
+- 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.

.schema-version

@@ -1 +1 @@
-v2.12.0
+v3.0.1

example/.env.example

@@ -1,8 +1,8 @@
 API_KEY=<API_KEY>
 VISITOR_ID=<VISITOR_ID>
-REQUEST_ID=<REQUEST_ID>
+EVENT_ID=<REQUEST_ID>
 # "eu" or "ap", "us" is the default
 REGION=<REGION>
 WEBHOOK_SIGNATURE_SECRET=<WEBHOOK_SIGNATURE_SECRET>
 BASE64_KEY=<BASE64_KEY>
-BASE64_SEALED_RESULT=<BASE64_SEALED_RESULT>
+BASE64_SEALED_RESULT=<BASE64_SEALED_RESULT>

example/deleteVisitor.mjs

@@ -1,4 +1,4 @@
-import { FingerprintJsServerApiClient, Region, RequestError } from '@fingerprintjs/fingerprintjs-pro-server-api'
+import { FingerprintJsServerApiClient, Region, RequestError } from '@fingerprint/fingerprint-server-sdk'
 import { config } from 'dotenv'
 config()
 

example/getEvent.mjs

@@ -1,13 +1,13 @@
-import { FingerprintJsServerApiClient, Region, RequestError } from '@fingerprintjs/fingerprintjs-pro-server-api'
+import { FingerprintJsServerApiClient, Region, RequestError } from '@fingerprint/fingerprint-server-sdk'
 import { config } from 'dotenv'
 config()
 
 const apiKey = process.env.API_KEY
-const requestId = process.env.REQUEST_ID
+const eventId = process.env.EVENT_ID
 const envRegion = process.env.REGION
 
-if (!requestId) {
-  console.error('Request ID not defined')
+if (!eventId) {
+  console.error('Event ID not defined')
   process.exit(1)
 }
 
@@ -26,7 +26,7 @@ if (envRegion === 'eu') {
 const client = new FingerprintJsServerApiClient({ region, apiKey })
 
 try {
-  const event = await client.getEvent(requestId)
+  const event = await client.getEvent(eventId)
   console.log(JSON.stringify(event, null, 2))
 } catch (error) {
   if (error instanceof RequestError) {

example/getVisitorHistory.mjs

@@ -3,7 +3,7 @@ import {
   Region,
   RequestError,
   TooManyRequestsError,
-} from '@fingerprintjs/fingerprintjs-pro-server-api'
+} from '@fingerprint/fingerprint-server-sdk'
 import { config } from 'dotenv'
 config()
 
@@ -31,7 +31,7 @@ if (envRegion === 'eu') {
 const client = new FingerprintJsServerApiClient({ region, apiKey })
 
 try {
-  const visitorHistory = await client.getVisits(visitorId, { limit: 10 })
+  const visitorHistory = await client.searchEvents({ visitor_id: visitorId, limit: 10 })
   console.log(JSON.stringify(visitorHistory, null, 2))
 } catch (error) {
   if (error instanceof RequestError) {

example/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "fingerprintjs-pro-server-api-node-sdk-example",
+  "name": "fingerprint-server-sdk-example",
   "version": "1.0.0",
   "description": "",
   "main": "index.mjs",
@@ -10,7 +10,7 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@fingerprintjs/fingerprintjs-pro-server-api": "workspace:*",
+    "@fingerprint/fingerprint-server-sdk": "workspace:*",
     "dotenv": "^16.4.5"
   }
 }

example/searchEvents.mjs

@@ -1,4 +1,4 @@
-import { FingerprintJsServerApiClient, Region, RequestError } from '@fingerprintjs/fingerprintjs-pro-server-api'
+import { FingerprintJsServerApiClient, Region, RequestError } from '@fingerprint/fingerprint-server-sdk'
 import { config } from 'dotenv'
 config()
 

example/unsealResult.mjs

@@ -1,4 +1,4 @@
-import { unsealEventsResponse, DecryptionAlgorithm } from '@fingerprintjs/fingerprintjs-pro-server-api'
+import { unsealEventsResponse, DecryptionAlgorithm } from '@fingerprint/fingerprint-server-sdk'
 import { config } from 'dotenv'
 config()
 

example/updateEvent.mjs

@@ -1,14 +1,14 @@
-import { FingerprintJsServerApiClient, RequestError, Region } from '@fingerprintjs/fingerprintjs-pro-server-api'
+import { FingerprintJsServerApiClient, RequestError, Region } from '@fingerprint/fingerprint-server-sdk'
 import { config } from 'dotenv'
 
 config()
 
 const apiKey = process.env.API_KEY
-const requestId = process.env.REQUEST_ID
+const eventId = process.env.EVENT_ID
 const envRegion = process.env.REGION
 
-if (!requestId) {
-  console.error('Request ID not defined')
+if (!eventId) {
+  console.error('Event ID not defined')
   process.exit(1)
 }
 
@@ -29,13 +29,13 @@ const client = new FingerprintJsServerApiClient({ region, apiKey })
 try {
   await client.updateEvent(
     {
-      tag: {
+      tags: {
         key: 'value',
       },
-      linkedId: 'new_linked_id',
+      linked_id: 'new_linked_id',
       suspect: false,
     },
-    requestId
+    eventId
   )
 
   console.log('Event updated')

example/validateWebhookSignature.mjs

@@ -1,4 +1,4 @@
-import { isValidWebhookSignature } from '@fingerprintjs/fingerprintjs-pro-server-api'
+import { isValidWebhookSignature } from '@fingerprint/fingerprint-server-sdk'
 
 /**
  * Webhook endpoint handler example

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "@fingerprintjs/fingerprintjs-pro-server-api",
-  "version": "6.10.0",
-  "description": "Node.js wrapper for FingerprintJS Sever API",
+  "name": "@fingerprint/fingerprint-server-sdk",
+  "version": "7.0.0",
+  "description": "Node.js wrapper for Fingerprint Server API",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",

readme.md

@@ -15,7 +15,7 @@
   <a href="https://discord.gg/39EpE2neBg"><img src="https://img.shields.io/discord/852099967190433792?style=logo&label=Discord&logo=Discord&logoColor=white" alt="Discord server"></a>
 </p>
 
-# Fingerprint Server API Node.js SDK
+# Fingerprint Server Node.js SDK
 
 [Fingerprint](https://fingerprint.com) is a device intelligence platform offering industry-leading accuracy.
 
@@ -55,16 +55,16 @@ Install the package using your favorite package manager:
 - NPM:
 
   ```sh
-  npm i @fingerprintjs/fingerprintjs-pro-server-api
+  npm i @fingerprint/fingerprintjs-server-sdk
   ```
 
 - Yarn:
   ```sh
-  yarn add @fingerprintjs/fingerprintjs-pro-server-api
+  yarn add @fingerprint/fingerprintjs-server-sdk
   ```
 - pnpm:
   ```sh
-  pnpm i @fingerprintjs/fingerprintjs-pro-server-api
+  pnpm i @fingerprint/fingerprintjs-server-sdk
   ```
 
 ## Getting started
@@ -75,20 +75,20 @@ Initialize the client instance and use it to make API requests. You need to spec
 import {
   FingerprintJsServerApiClient,
   Region,
-} from '@fingerprintjs/fingerprintjs-pro-server-api'
+} from '@fingerprint/fingerprint-server-sdk'
 
 const client = new FingerprintJsServerApiClient({
   apiKey: '<SECRET_API_KEY>',
   region: Region.Global,
 })
 
 // Get visit history of a specific visitor
-client.getVisits('<visitorId>').then((visitorHistory) => {
+client.searchEvents({ visitor_id: '<visitorId>' }).then((visitorHistory) => {
   console.log(visitorHistory)
 })
 
 // Get a specific identification event
-client.getEvent('<requestId>').then((event) => {
+client.getEvent('<eventId>').then((event) => {
   console.log(event)
 })
 
@@ -116,7 +116,7 @@ import {
   RequestError,
   FingerprintJsServerApiClient,
   TooManyRequestsError,
-} from '@fingerprintjs/fingerprintjs-pro-server-api'
+} from '@fingerprint/fingerprint-server-sdk'
 
 const client = new FingerprintJsServerApiClient({
   apiKey: '<SECRET_API_KEY>',
@@ -125,7 +125,7 @@ const client = new FingerprintJsServerApiClient({
 
 // Handling getEvent errors
 try {
-  const event = await client.getEvent(requestId)
+  const event = await client.getEvent(eventId)
   console.log(JSON.stringify(event, null, 2))
 } catch (error) {
   if (error instanceof RequestError) {
@@ -136,28 +136,6 @@ try {
     console.log('unknown error: ', error)
   }
 }
-
-// Handling getVisits errors
-try {
-  const visitorHistory = await client.getVisits(visitorId, {
-    limit: 10,
-  })
-  console.log(JSON.stringify(visitorHistory, null, 2))
-} catch (error) {
-  if (error instanceof RequestError) {
-    console.log(error.status, error.error)
-    if (error instanceof TooManyRequestsError) {
-      retryLater(error.retryAfter) // Needs to be implemented on your side
-    }
-  } else {
-    console.error('unknown error: ', error)
-  }
-
-  // You can also check for specific error instance
-  // if(error instanceof VisitorsError403) {
-  //    Handle 403 error...
-  // }
-}
 ```
 
 ### Webhooks
@@ -167,9 +145,9 @@ try {
 When handling [Webhooks](https://dev.fingerprint.com/docs/webhooks) coming from Fingerprint, you can cast the payload as the built-in `VisitWebhook` type:
 
 ```ts
-import { VisitWebhook } from '@fingerprintjs/fingerprintjs-pro-server-api'
+import { Event } from '@fingerprint/fingerprint-server-sdk'
 
-const visit = visitWebhookBody as unknown as VisitWebhook
+const visit = visitWebhookBody as unknown as Event
 ```
 
 #### Webhook signature validation