INTER-1488: Migrate SDK to APIv4

.changeset/config.json

@@ -3,7 +3,7 @@
   "changelog": [
     "@fingerprintjs/changesets-changelog-format",
     {
-      "repo": "fingerprintjs/fingerprintjs-pro-server-api-node-sdk"
+      "repo": "fingerprintjs/node-sdk"
     }
   ],
   "commit": false,
@@ -12,5 +12,5 @@
   "access": "public",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",
-  "ignore": ["fingerprintjs-pro-server-api-node-sdk-example"]
+  "ignore": ["fingerprint-server-sdk-example", "fingerprint-server-sdk-smoke-tests"]
 }

.changeset/early-seas-look.md

@@ -0,0 +1,22 @@
+---
+'@fingerprint/fingerprint-server-sdk': major
+---
+
+**Server APIv3 -> Server APIv4 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.
+
+**BREAKING CHANGES**
+- 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.

.changeset/loud-waves-drive.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/fingerprint-server-sdk': major
+---
+
+change package name to `@fingerprint/fingerprint-server-sdk`

.changeset/pre.json

@@ -0,0 +1,10 @@
+{
+  "mode": "pre",
+  "tag": "test",
+  "initialVersions": {
+    "@fingerprint/fingerprint-server-sdk": "6.10.0",
+    "fingerprint-server-sdk-example": "1.0.0",
+    "fingerprint-server-sdk-smoke-tests": "2.0.0"
+  },
+  "changesets": []
+}

.changeset/witty-lobsters-film.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/fingerprint-server-sdk': minor
+---
+
+add `options` parameter to the `getEvent` operation

.schema-version

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

example/.env.example

@@ -1,8 +1,9 @@
 API_KEY=<API_KEY>
 VISITOR_ID=<VISITOR_ID>
-REQUEST_ID=<REQUEST_ID>
+EVENT_ID=<EVENT_ID>
+RULESET_ID=<RULESET_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 { FingerprintServerApiClient, Region, RequestError } from '@fingerprint/fingerprint-server-sdk'
 import { config } from 'dotenv'
 config()
 
@@ -23,7 +23,7 @@ if (envRegion === 'eu') {
   region = Region.AP
 }
 
-const client = new FingerprintJsServerApiClient({ region, apiKey })
+const client = new FingerprintServerApiClient({ region, apiKey })
 
 try {
   await client.deleteVisitorData(visitorId)

example/getEvent.mjs

@@ -1,13 +1,14 @@
-import { FingerprintJsServerApiClient, Region, RequestError } from '@fingerprintjs/fingerprintjs-pro-server-api'
+import { FingerprintServerApiClient, 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 rulesetId = process.env.RULESET_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)
 }
 
@@ -23,11 +24,20 @@ if (envRegion === 'eu') {
   region = Region.AP
 }
 
-const client = new FingerprintJsServerApiClient({ region, apiKey })
+const client = new FingerprintServerApiClient({ region, apiKey })
 
 try {
-  const event = await client.getEvent(requestId)
+  const event = await client.getEvent(eventId, { ruleset_id: rulesetId })
   console.log(JSON.stringify(event, null, 2))
+
+  if (rulesetId && event.rule_action) {
+    const { type, ruleset_id, rule_id, rule_expression } = event.rule_action
+    console.log(`Rule action: ${type} (ruleset: ${ruleset_id}, rule: ${rule_id}, expression: ${rule_expression})`)
+
+    if (type === 'block') {
+      console.log(`Block response: ${event.rule_action.status_code} ${event.rule_action.body}`)
+    }
+  }
 } catch (error) {
   if (error instanceof RequestError) {
     console.log(`error ${error.statusCode}: `, error.message)

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 { FingerprintServerApiClient, Region, RequestError } from '@fingerprint/fingerprint-server-sdk'
 import { config } from 'dotenv'
 config()
 
@@ -17,15 +17,15 @@ if (envRegion === 'eu') {
   region = Region.AP
 }
 
-const client = new FingerprintJsServerApiClient({ region, apiKey })
+const client = new FingerprintServerApiClient({ region, apiKey })
 
 const filter = {
   limit: 10,
   // pagination_key: '<pagination_key>',
   // bot: 'all',
   // visitor_id: 'TaDnMBz9XCpZNuSzFUqP',
   // ip_address: '192.168.0.1/32',
-  // linked_id: '<linked_id>,
+  // linked_id: '<linked_id>',
   //start: 1620000000000,
   //end: 1630000000000,
   //reverse: true,

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 { FingerprintServerApiClient, 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)
 }
 
@@ -24,18 +24,18 @@ if (envRegion === 'eu') {
   region = Region.AP
 }
 
-const client = new FingerprintJsServerApiClient({ region, apiKey })
+const client = new FingerprintServerApiClient({ 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",
+  "name": "@fingerprint/fingerprint-server-sdk",
   "version": "6.10.0",
-  "description": "Node.js wrapper for FingerprintJS Sever API",
+  "description": "Node.js wrapper for Fingerprint Server API",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -15,7 +15,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/fingerprintjs/fingerprintjs-pro-server-api-node-sdk"
+    "url": "https://github.com/fingerprintjs/node-sdk"
   },
   "engines": {
     "node": ">=18.17.0"