[SPIKE option C] EventDevice | EventEdge union (INTER-2457)

.changeset/add-make-edge-event.md

@@ -0,0 +1,5 @@
+---
+"@fingerprint/node-sdk": minor
+---
+
+Add `makeEdgeEvent()` to collect Automation Intelligence via `POST /v4/edge`

example/getEvent.mjs

@@ -32,7 +32,7 @@ try {
   const event = await client.getEvent(eventId, { ruleset_id: rulesetId })
   console.log(JSON.stringify(event, null, 2))
 
-  if (rulesetId && event.rule_action) {
+  if (rulesetId && event.source === 'device' && 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})`)
 

example/makeEdgeEvent.mjs

@@ -0,0 +1,45 @@
+// @ts-check
+import { FingerprintServerApiClient, Region, RequestError } from '@fingerprint/node-sdk'
+import { config } from 'dotenv'
+config()
+
+const apiKey = process.env.API_KEY
+const envRegion = process.env.REGION
+
+if (!apiKey) {
+  console.error('API key not defined')
+  process.exit(1)
+}
+
+/** @type {Region} */
+let region = Region.Global
+if (envRegion === 'eu') {
+  region = Region.EU
+} else if (envRegion === 'ap') {
+  region = Region.AP
+}
+
+const client = new FingerprintServerApiClient({ region, apiKey })
+
+try {
+  const event = await client.makeEdgeEvent({
+    method: 'GET',
+    url: 'https://example.com/login',
+    ipv4_address: '34.162.244.71',
+    headers: [
+      { name: 'Host', value: 'example.com' },
+      { name: 'User-Agent', value: 'Mozilla/5.0' },
+      { name: 'Authorization', value: '' },
+    ],
+  })
+  console.log(JSON.stringify(event, null, 2))
+} catch (error) {
+  if (error instanceof RequestError) {
+    console.log(`error ${error.statusCode}: `, error.message)
+    // You can also access the raw response
+    console.log(error.response.statusText)
+  } else {
+    console.log('unknown error: ', error)
+  }
+  process.exit(1)
+}

readme.md

@@ -107,6 +107,21 @@ client
   .then((events) => {
     console.log(events)
   })
+
+// Collect Automation Intelligence for a request intercepted at the edge
+client
+  .makeEdgeEvent({
+    method: 'GET',
+    url: 'https://example.com/login',
+    ipv4_address: '34.162.244.71',
+    headers: [
+      { name: 'Host', value: 'example.com' },
+      { name: 'User-Agent', value: 'Mozilla/5.0' },
+    ],
+  })
+  .then((event) => {
+    console.log(event.event_id, event.bot_info)
+  })
 ```
 
 See the [Examples](https://github.com/fingerprintjs/node-sdk/tree/main/example) folder for more detailed examples.