[INTER-708] Response transparency and webhook validation

.github/workflows/coverage-report.yml

@@ -1,4 +1,4 @@
-name: Coverage report
+name: Generate docs and coverage report
 
 on:
   push:
@@ -10,6 +10,6 @@ jobs:
     name: Coverage report
     uses: fingerprintjs/dx-team-toolkit/.github/workflows/docs-and-coverage.yml@v1
     with:
-      skip-docs-step: true
       prepare-gh-pages-commands: |
-        mv coverage/lcov-report/* ./gh-pages
+        mv docs/* ./gh-pages
+        mv coverage/lcov-report ./gh-pages/coverage

.github/workflows/functional_tests.yml

@@ -1,7 +1,7 @@
 name: Functional tests
 on:
   workflow_dispatch:
-  pull_request_target:
+  pull_request:
   schedule:
     - cron: '0 5 * * *'
 jobs:
@@ -12,7 +12,6 @@ jobs:
       artifactName: node-sdk-artifact
       artifactPath: ./dist
 
-
   functional_tests:
     name: 'Smoke test on node ${{ matrix.node-version }}'
     needs: build
@@ -22,7 +21,7 @@ jobs:
       max-parallel: 3
       fail-fast: false
       matrix:
-        node-version: [ 18, 19, 20, 21 ]
+        node-version: [18, 19, 20, 21]
 
     steps:
       - if: ${{ github.event_name == 'pull_request_target' }}
@@ -36,7 +35,7 @@ jobs:
       - name: 'Install pnpm'
         uses: pnpm/action-setup@129abb77bf5884e578fcaf1f37628e41622cc371
         with:
-          version: 8
+          version: 9
 
       - uses: actions/setup-node@v4
         with:
@@ -47,7 +46,7 @@ jobs:
           name: node-sdk-artifact
           path: ./dist
       - name: Install Dependencies for SDK
-        run: pnpm install --frozen-lockfile
+        run: pnpm install
         env:
           CI: true
       - name: Install Dependencies for example
@@ -56,7 +55,9 @@ jobs:
         env:
           CI: true
       - name: Run test
-        run: node index.js
+        run: |
+          node getEvent.mjs
+          node getVisitorHistory.mjs
         working-directory: ./example
         env:
           API_KEY: '${{ secrets.PRIVATE_KEY }}'

.gitignore

@@ -124,4 +124,6 @@ dist
 .yarn/unplugged
 .yarn/build-state.yml
 .yarn/install-state.gz
-.pnp.*
+.pnp.*
+
+docs

contributing.md

@@ -2,7 +2,7 @@
 
 ## Working with code
 
-We prefer using [yarn](https://yarnpkg.com/) for installing dependencies and running scripts.
+We prefer using [pnpm](https://pnpmpkg.com/) for installing dependencies and running scripts.
 
 The main branch is locked for the push action. For proposing changes, use the standard [pull request approach](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). It's recommended to discuss fixes or new functionality in the Issues, first.
 
@@ -11,7 +11,7 @@ The main branch is locked for the push action. For proposing changes, use the st
 Run the following command that will regenerate types:
 
 ```shell
-yarn generateTypes
+pnpm generateTypes
 ```
 
 It uses schema stored in [res/schema.json](resources/fingerprint-server-api.yaml). To fetch the latest schema run:
@@ -25,21 +25,29 @@ It uses schema stored in [res/schema.json](resources/fingerprint-server-api.yaml
 Just run:
 
 ```shell
-yarn build
+pnpm build
+```
+
+### How to build API reference documentation
+
+Run:
+
+```shell
+pnpm run docs
 ```
 
 ### Code style
 
 The code style is controlled by [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/). Run to check that the code style is ok:
 
 ```shell
-yarn lint
+pnpm lint
 ```
 
 You aren't required to run the check manually, the CI will do it. Run the following command to fix style issues (not all issues can be fixed automatically):
 
 ```shell
-yarn lint:fix
+pnpm lint:fix
 ```
 
 ### Running tests
@@ -49,7 +57,7 @@ Tests are located in `tests` folder and run by [jest](https://jestjs.io/) in nod
 To run tests you can use IDE instruments or just run:
 
 ```shell
-yarn test
+pnpm test
 ```
 
 ### Testing the local source code of the SDK
@@ -60,19 +68,20 @@ Use the `example` folder to make API requests using the local version of the SDK
 2. Install dependencies and build the SDK (inside the root folder):
 
    ```shell
-   yarn install
-   yarn build
+   pnpm install
+   pnpm build
    ```
 
-3. Install dependencies and run the example (inside the `example` folder)):
+3. Install dependencies and run the examples (inside the `example` folder)):
 
    ```shell
    cd example
-   yarn install
-   node index.js
+   pnpm install
+   node getEvent.mjs
+   node getVisitorHistory.mjs
    ```
 
-Every time you change the SDK code, you need to rebuild it in the root folder using `yarn build` and then run the example again.
+Every time you change the SDK code, you need to rebuild it in the root folder using `pnpm build` and then run the example again.
 
 ### How to publish
 

example/.env.example

@@ -2,4 +2,7 @@ API_KEY=<API_KEY>
 VISITOR_ID=<VISITOR_ID>
 REQUEST_ID=<REQUEST_ID>
 # "eu" or "ap", "us" is the default
-REGION=<REGION>
+REGION=<REGION>
+WEBHOOK_SIGNATURE_SECRET=<WEBHOOK_SIGNATURE_SECRET>
+BASE64_KEY=<BASE64_KEY>
+BASE64_SEALED_RESULT=<BASE64_SEALED_RESULT>

example/deleteVisitor.mjs

@@ -0,0 +1,38 @@
+import { FingerprintJsServerApiClient, Region, isDeleteVisitorError } from '@fingerprintjs/fingerprintjs-pro-server-api'
+import { config } from 'dotenv'
+config()
+
+const apiKey = process.env.API_KEY
+const visitorId = process.env.VISITOR_ID
+const envRegion = process.env.REGION
+
+if (!visitorId) {
+  console.error('Visitor ID not defined')
+  process.exit(1)
+}
+
+if (!apiKey) {
+  console.error('API key not defined')
+  process.exit(1)
+}
+
+let region = Region.Global
+if (envRegion === 'eu') {
+  region = Region.EU
+} else if (envRegion === 'ap') {
+  region = Region.AP
+}
+
+const client = new FingerprintJsServerApiClient({ region, apiKey })
+
+try {
+  await client.deleteVisitorData(visitorId)
+  console.log(`All data associated with visitor ${visitorId} is scheduled to be deleted.`)
+} catch (error) {
+  if (isDeleteVisitorError(error)) {
+    console.log(error.status, error.error)
+  } else {
+    console.error('unknown error: ', error)
+  }
+  process.exit(1)
+}

example/getEvent.mjs

@@ -0,0 +1,40 @@
+import { FingerprintJsServerApiClient, Region, isEventError } from '@fingerprintjs/fingerprintjs-pro-server-api'
+import { config } from 'dotenv'
+config()
+
+const apiKey = process.env.API_KEY
+const requestId = process.env.REQUEST_ID
+const envRegion = process.env.REGION
+
+if (!requestId) {
+  console.error('Request ID not defined')
+  process.exit(1)
+}
+
+if (!apiKey) {
+  console.error('API key not defined')
+  process.exit(1)
+}
+
+let region = Region.Global
+if (envRegion === 'eu') {
+  region = Region.EU
+} else if (envRegion === 'ap') {
+  region = Region.AP
+}
+
+const client = new FingerprintJsServerApiClient({ region, apiKey })
+
+try {
+  const event = await client.getEvent(requestId)
+  console.log(JSON.stringify(event, null, 2))
+} catch (error) {
+  if (isEventError(error)) {
+    console.log(`error ${error.status}: `, error.error?.message)
+    // You can also access the raw response
+    console.log(error.response.statusText)
+  } else {
+    console.log('unknown error: ', error)
+  }
+  process.exit(1)
+}

example/getVisitorHistory.mjs

@@ -0,0 +1,48 @@
+import { FingerprintJsServerApiClient, Region, isVisitorsError } from '@fingerprintjs/fingerprintjs-pro-server-api'
+import { config } from 'dotenv'
+config()
+
+const apiKey = process.env.API_KEY
+const visitorId = process.env.VISITOR_ID
+const envRegion = process.env.REGION
+
+if (!visitorId) {
+  console.error('Visitor ID not defined')
+  process.exit(1)
+}
+
+if (!apiKey) {
+  console.error('API key not defined')
+  process.exit(1)
+}
+
+let region = Region.Global
+if (envRegion === 'eu') {
+  region = Region.EU
+} else if (envRegion === 'ap') {
+  region = Region.AP
+}
+
+const client = new FingerprintJsServerApiClient({ region, apiKey })
+
+try {
+  const visitorHistory = await client.getVisitorHistory(visitorId, { limit: 10 })
+  console.log(JSON.stringify(visitorHistory, null, 2))
+} catch (error) {
+  if (isVisitorsError(error)) {
+    console.log(error.status, error.error)
+    if (error.status === 429) {
+      retryLater(error.retryAfter) // Needs to be implemented on your side
+    }
+  } else {
+    console.error('unknown error: ', error)
+  }
+  process.exit(1)
+}
+
+/**
+ * @param {number} delay - How many seconds to wait before retrying
+ */
+function retryLater(delay) {
+  console.log(`Implement your own retry logic here and retry after ${delay} seconds`)
+}

example/package.json

@@ -2,7 +2,7 @@
   "name": "fingerprintjs-pro-server-api-node-sdk-example",
   "version": "1.0.0",
   "description": "",
-  "main": "index.js",
+  "main": "index.mjs",
   "private": true,
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"