Release [changeset]

[fingerprint-dx-team-actions-runner]

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or setup this action to publish automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.

Releases

@fingerprint/node-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:

  - const client = new FingerprintJsServerApiClient(config)
  + const client = new FingerprintServerApiClient(config)

  authenticationMode option removed from constructor:

  const client = new FingerprintServerApiClient({
  - authenticationMode: AuthenticationMode.AuthHeader
    // ...
  })

  Use searchEvents function instead of getVisits():

  - client.getVisits('VISITOR_ID', { limit: 1 })
  + client.searchEvents({ visitor_id: 'VISITOR_ID', limit: 1 })

  Related visitors API (getRelatedVisitors()) is removed:

  - client.getRelatedVisitors({ visitor_id: 'VISITOR_ID' })

  Use tags instead of tag for updating an event:

  - const body: EventsUpdateRequest = {
  + const body: EventUpdate = {
  -   tag: {
  +   tags: {
        key: 'value',
      }
    }

  updateEvent parameter order changed to (eventId, body):

  - client.updateEvent(body, 'EVENT_ID')
  + client.updateEvent('EVENT_ID', body)

  Use simplified and snake_case fields for the response:

    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)

• Package renamed from @fingerprintjs/fingerprintjs-pro-server-api to @fingerprint/node-sdk. (385b01b)

Minor Changes

• Added options parameter to the getEvent operation. (3ebae43)

Patch Changes

• Performance: Avoid the overhead of cloning and double-buffering large payloads in the success case. (bc3fd33)

[github-actions]

Coverage report

St.❔	Category	Percentage	Covered / Total
🟢	Statements	100%	183/183
🟢	Branches	100%	63/63
🟢	Functions	100%	35/35
🟢	Lines	100%	181/181

Test suite run success

74 tests passing in 9 suites.

Report generated by 🧪jest coverage report action from f9ebd2b

Show full coverage report

St	File	% Stmts	% Branch	% Funcs	% Lines	Uncovered Line #s
🟢	All files	100	100	100	100
🟢	src	100	100	100	100
🟢	index.ts	100	100	100	100
🟢	sealedResults.ts	100	100	100	100
🟢	serverApiClient.ts	100	100	100	100
🟢	types.ts	100	100	100	100
🟢	urlUtils.ts	100	100	100	100
🟢	webhook.ts	100	100	100	100
🟢	src/errors	100	100	100	100
🟢	apiErrors.ts	100	100	100	100
🟢	handleErrorResponse.ts	100	100	100	100
🟢	toError.ts	100	100	100	100
🟢	unsealError.ts	100	100	100	100

[github-actions]

⚠️ This PR doesn't contain any changesets. If there are user-facing changes, don't forget to run:

pnpm exec changeset

to create a changeset.