fix: add 400 and 429 status mappings for DELETE API

resources/fingerprint-server-api.yaml

@@ -213,16 +213,16 @@ paths:
           headers:
             Retry-After:
               description: >-
-                Indicates how long you should wait before attempting the next
-                request.
+                Indicates how many seconds you should wait before attempting the
+                next request.
               schema:
                 type: integer
                 format: int32
                 minimum: 0
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ManyRequestsResponse'
+                $ref: '#/components/schemas/TooManyRequestsResponse'
     delete:
       tags:
         - Fingerprint
@@ -258,6 +258,14 @@ paths:
       responses:
         '200':
           description: OK. The visitor ID is scheduled for deletion.
+        '400':
+          description: >-
+            Bad request. The visitor ID parameter is missing or in the wrong
+            format.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorVisitsDelete400Response'
         '403':
           description: Forbidden. Access to this API is denied.
           content:
@@ -272,6 +280,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorVisitsDelete404Response'
+        '429':
+          description: Too Many Requests. The request is throttled.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorCommon429Response'
   /webhook:
     trace:
       tags:
@@ -631,6 +645,27 @@ components:
           required:
             - code
             - message
+    ErrorCommon429Response:
+      type: object
+      additionalProperties: false
+      properties:
+        error:
+          type: object
+          additionalProperties: false
+          properties:
+            code:
+              type: string
+              description: |
+                Error code: * `TooManyRequests` - The request is throttled.
+              enum:
+                - TooManyRequests
+              example: TooManyRequests
+            message:
+              type: string
+              example: request throttled
+          required:
+            - code
+            - message
     ErrorEvent404Response:
       type: object
       additionalProperties: false
@@ -664,7 +699,7 @@ components:
           example: Forbidden (HTTP 403)
       required:
         - error
-    ManyRequestsResponse:
+    TooManyRequestsResponse:
       type: object
       additionalProperties: false
       properties:
@@ -697,6 +732,28 @@ components:
           required:
             - code
             - message
+    ErrorVisitsDelete400Response:
+      type: object
+      additionalProperties: false
+      properties:
+        error:
+          type: object
+          additionalProperties: false
+          properties:
+            code:
+              type: string
+              description: >
+                Error code: * `RequestCannotBeParsed` - The visitor ID parameter
+                is missing or in the wrong format.
+              enum:
+                - RequestCannotBeParsed
+              example: RequestCannotBeParsed
+            message:
+              type: string
+              example: invalid visitor id
+          required:
+            - code
+            - message
     WebhookVisit:
       type: object
       properties:

src/generatedApiTypes.ts

@@ -163,6 +163,19 @@ export interface components {
         message: string
       }
     }
+    ErrorCommon429Response: {
+      error?: {
+        /**
+         * @description Error code: * `TooManyRequests` - The request is throttled.
+         *
+         * @example TooManyRequests
+         * @enum {string}
+         */
+        code: 'TooManyRequests'
+        /** @example request throttled */
+        message: string
+      }
+    }
     ErrorEvent404Response: {
       /** ErrorEvent404ResponseError */
       error?: {
@@ -185,7 +198,7 @@ export interface components {
        */
       error: string
     }
-    ManyRequestsResponse: {
+    TooManyRequestsResponse: {
       /**
        * @description Error text.
        * @example request throttled
@@ -206,6 +219,19 @@ export interface components {
         message: string
       }
     }
+    ErrorVisitsDelete400Response: {
+      error?: {
+        /**
+         * @description Error code: * `RequestCannotBeParsed` - The visitor ID parameter is missing or in the wrong format.
+         *
+         * @example RequestCannotBeParsed
+         * @enum {string}
+         */
+        code: 'RequestCannotBeParsed'
+        /** @example invalid visitor id */
+        message: string
+      }
+    }
     WebhookVisit: {
       /** @example 3HNey93AkBW6CRbxV6xP */
       visitorId: string
@@ -1092,11 +1118,11 @@ export interface operations {
       /** @description Too Many Requests */
       429: {
         headers: {
-          /** @description Indicates how long you should wait before attempting the next request. */
+          /** @description Indicates how many seconds you should wait before attempting the next request. */
           'Retry-After'?: number
         }
         content: {
-          'application/json': components['schemas']['ManyRequestsResponse']
+          'application/json': components['schemas']['TooManyRequestsResponse']
         }
       }
     }
@@ -1123,6 +1149,12 @@ export interface operations {
       200: {
         content: never
       }
+      /** @description Bad request. The visitor ID parameter is missing or in the wrong format. */
+      400: {
+        content: {
+          'application/json': components['schemas']['ErrorVisitsDelete400Response']
+        }
+      }
       /** @description Forbidden. Access to this API is denied. */
       403: {
         content: {
@@ -1135,6 +1167,12 @@ export interface operations {
           'application/json': components['schemas']['ErrorVisitsDelete404Response']
         }
       }
+      /** @description Too Many Requests. The request is throttled. */
+      429: {
+        content: {
+          'application/json': components['schemas']['ErrorCommon429Response']
+        }
+      }
     }
   }
 }

src/serverApiClient.ts

@@ -1,6 +1,7 @@
 import { getDeleteVisitorDataUrl, getEventUrl, getVisitorsUrl } from './urlUtils'
 import {
   AuthenticationMode,
+  CommonError429,
   DeleteVisitorError,
   EventError,
   EventResponse,
@@ -24,6 +25,8 @@ export class FingerprintJsServerApiClient {
 
   protected readonly fetch: typeof fetch
 
+  protected static readonly DEFAULT_RETRY_AFTER = 1
+
   /**
    * FingerprintJS server API client used to fetch data from FingerprintJS
    * @constructor
@@ -145,6 +148,14 @@ export class FingerprintJsServerApiClient {
 
         const jsonResponse = await response.json()
 
+        if (response.status === 429) {
+          const retryAfter = this.getRetryAfter(response)
+
+          ;(jsonResponse as CommonError429).retryAfter = retryAfter
+            ? parseInt(retryAfter)
+            : FingerprintJsServerApiClient.DEFAULT_RETRY_AFTER
+        }
+
         throw { ...(jsonResponse as DeleteVisitorError), response, status: response.status } as DeleteVisitorError
       })
       .catch((err) => {
@@ -211,8 +222,10 @@ export class FingerprintJsServerApiClient {
           return jsonResponse as VisitorsResponse
         }
         if (response.status === 429) {
-          const retryAfter = response.headers.get('retry-after') || ''
-          ;(jsonResponse as VisitorsError429).retryAfter = retryAfter === '' ? 1 : parseInt(retryAfter)
+          const retryAfter = this.getRetryAfter(response)
+          ;(jsonResponse as VisitorsError429).retryAfter = retryAfter
+            ? parseInt(retryAfter)
+            : FingerprintJsServerApiClient.DEFAULT_RETRY_AFTER
         }
         throw { ...(jsonResponse as VisitorsError), response, status: response.status } as VisitorsError
       })
@@ -230,4 +243,8 @@ export class FingerprintJsServerApiClient {
   private getHeaders() {
     return this.authenticationMode === AuthenticationMode.AuthHeader ? { 'Auth-API-Key': this.apiKey } : undefined
   }
+
+  private getRetryAfter(response: Response) {
+    return response.headers.get('retry-after')
+  }
 }

src/types.ts

@@ -40,6 +40,14 @@ export interface Options {
  */
 export type VisitorHistoryFilter = paths['/visitors/{visitor_id}']['get']['parameters']['query']
 
+export type TooManyRequestsError = {
+  status: 429
+  /**
+   * How many seconds to wait before retrying
+   */
+  retryAfter: number
+}
+
 /**
  * More info: https://dev.fingerprintjs.com/docs/server-api#response
  */
@@ -49,13 +57,7 @@ export type VisitorsError403 =
     status: 403
   }
 export type VisitorsError429 =
-  paths['/visitors/{visitor_id}']['get']['responses']['429']['content']['application/json'] & {
-    status: 429
-    /**
-     * How many seconds to wait before retrying
-     */
-    retryAfter: number
-  }
+  paths['/visitors/{visitor_id}']['get']['responses']['429']['content']['application/json'] & TooManyRequestsError
 
 export type DeleteVisitError404 =
   paths['/visitors/{visitor_id}']['delete']['responses']['404']['content']['application/json'] & {
@@ -67,9 +69,18 @@ export type DeleteVisitError403 =
     status: 403
   }
 
+export type DeleteVisitError400 =
+  paths['/visitors/{visitor_id}']['delete']['responses']['400']['content']['application/json'] & {
+    status: 400
+  }
+
+export type CommonError429 = components['schemas']['ErrorCommon429Response'] & TooManyRequestsError
+
 export type VisitorsError = WithResponse<VisitorsError403 | VisitorsError429>
 
-export type DeleteVisitorError = WithResponse<DeleteVisitError404 | DeleteVisitError403>
+export type DeleteVisitorError = WithResponse<
+  DeleteVisitError404 | DeleteVisitError403 | DeleteVisitError400 | CommonError429
+>
 
 export function isVisitorsError(response: any): response is VisitorsError {
   return (
@@ -82,14 +93,15 @@ export function isVisitorsError(response: any): response is VisitorsError {
 }
 
 export function isDeleteVisitorError(response: any): response is DeleteVisitorError {
-  return (
-    (response?.hasOwnProperty('status') &&
-      (response.status === 403 || response.status === 404) &&
+  const statusCodes = [400, 403, 404, 429]
+
+  return Boolean(
+    response?.hasOwnProperty('status') &&
+      statusCodes.includes(response.status) &&
       response.error?.hasOwnProperty('message') &&
       typeof response.error.message === 'string' &&
       response.error?.hasOwnProperty('code') &&
-      typeof response.error.code === 'string') ||
-    false
+      typeof response.error.code === 'string'
   )
 }
 

sync.sh

@@ -14,8 +14,10 @@ examplesList=(
   'get_event_200_identification_failed_error.json'
   'get_event_200_identification_too_many_requests_error.json'
   'get_visits_429_too_many_requests_error.json'
+  'delete_visits_400_error.json'
   'delete_visits_404_error.json'
   'delete_visits_403_error.json'
+  'delete_visits_429_error.json'
 )
 
 for example in ${examplesList[*]}; do

tests/mocked-responses-tests/deleteVisitorDataTests.spec.ts

@@ -1,6 +1,8 @@
 import { FingerprintJsServerApiClient, Region } from '../../src'
 import Error404 from './mocked-responses-data/external/delete_visits_404_error.json'
 import Error403 from './mocked-responses-data/external/delete_visits_403_error.json'
+import Error400 from './mocked-responses-data/external/delete_visits_400_error.json'
+import Error429 from './mocked-responses-data/external/delete_visits_429_error.json'
 
 jest.spyOn(global, 'fetch')
 
@@ -49,6 +51,40 @@ describe('[Mocked response] Delete visitor data', () => {
     })
   })
 
+  test('400 error', async () => {
+    ;(fetch as unknown as jest.Mock).mockReturnValue(
+      Promise.resolve(
+        new Response(JSON.stringify(Error400), {
+          status: 400,
+        })
+      )
+    )
+
+    await expect(client.deleteVisitorData(existingVisitorId)).rejects.toMatchObject({
+      ...Error400,
+      status: 400,
+    })
+  })
+
+  test('429 error', async () => {
+    ;(fetch as unknown as jest.Mock).mockReturnValue(
+      Promise.resolve(
+        new Response(JSON.stringify(Error429), {
+          status: 429,
+          headers: {
+            'retry-after': '5',
+          },
+        })
+      )
+    )
+
+    await expect(client.deleteVisitorData(existingVisitorId)).rejects.toMatchObject({
+      ...Error429,
+      status: 429,
+      retryAfter: 5,
+    })
+  })
+
   test('Error with bad JSON', async () => {
     ;(fetch as unknown as jest.Mock).mockReturnValue(
       Promise.resolve(

tests/mocked-responses-tests/mocked-responses-data/external/delete_visits_400_error.json

@@ -0,0 +1,6 @@
+{
+  "error": {
+    "code": "RequestCannotBeParsed",
+    "message": "invalid visitor id"
+  }
+}