@fingerprintjs/fingerprintjs-pro-server-api - npm Package Compare versions

Comparing version 2.2.0 to 2.3.0

dist/index.d.ts

 /**
- * FingerprintJS Server API Node.js SDK v2.2.0 - Copyright (c) FingerprintJS, Inc, 2023 (https://fingerprint.com)
+ * FingerprintJS Server API Node.js SDK v2.3.0 - Copyright (c) FingerprintJS, Inc, 2023 (https://fingerprint.com)
  * Licensed under the MIT (http://www.opensource.org/licenses/mit-license.php) license.
@@ -15,4 +15,5 @@ */
         /**
-         * This endpoint allows you to retrieve an individual analysis event with all the information from each activated product (Identification, Bot Detection, and others).
-         * Products that are not activated for your application or not relevant to the event's detected platform (web, iOS, Android) are not included in the response.
+         * This endpoint allows you to get a detailed analysis of an individual request.
+         * **Only for Enterprise customers:** Please note that the response includes mobile signals (e.g. `rootApps`) even if the request orignated from a non-mobile platform.
+         * It is highly recommended that you **ignore** the mobile signals for such requests.
          *
@@ -175,4 +176,3 @@ * Use `requestId` as the URL path parameter. This API method is scoped to a request, i.e. all returned information is by `requestId`.
                 /**
-                 * @description Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected
-                 * Available only for events from Android client. The field will not be present for a browser or iOS event.
+                 * @description Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected or the client isn't Android.
                  *
@@ -186,4 +186,3 @@ * @example false
                 /**
-                 * @description Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected
-                 * Available only for events from Android client. The field will not be present for a browser or iOS event.
+                 * @description Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected or the client isn't Android.
                  *
@@ -194,2 +193,46 @@ * @example false
             };
+            /** WebhookSignalResponseClonedApp */
+            clonedApp?: {
+                /**
+                 * @description Android specific cloned application detection. There are 2 values: • `true` - Presence of app cloners work detected (e.g. fully cloned application found or launch of it inside of a not main working profile detected). • `false` - No signs of cloned application detected or the client is not Android.
+                 *
+                 * @example false
+                 */
+                result?: boolean;
+            };
+            /** WebhookSignalResponseFactoryReset */
+            factoryReset?: {
+                /**
+                 * Time
+                 * Format: date-time
+                 * @description Time in UTC for the Android client when recent factory reset was done.  If there is no sign of factory reset or the client isn't Android, the field will be epoch time.
+                 *
+                 * @example 2022-06-09T22:58:36Z
+                 */
+                time?: string;
+                /**
+                 * Format: int64
+                 * @description Same value as it's in the `time` field but represented in timestamp format.
+                 * @example 1654815517198
+                 */
+                timestamp?: number;
+            };
+            /** WebhookSignalResponseJailbroken */
+            jailbroken?: {
+                /**
+                 * @description iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak detected • `false` - No signs of jailbreak or the client is not iOS.
+                 *
+                 * @example false
+                 */
+                result?: boolean;
+            };
+            /** WebhookSignalResponseFrida */
+            frida?: {
+                /**
+                 * @description iOS specific [Frida](https://frida.re/docs/ios/) detection. There are 2 values: • `true` - Frida detected • `false` - No signs of Frida or the client is not iOS.
+                 *
+                 * @example false
+                 */
+                result?: boolean;
+            };
             ipBlocklist?: components['schemas']['IpBlockListResult'];
@@ -205,2 +248,20 @@ /** WebhookSignalResponseTor */
             };
+            /** WebhookSignalResponsePrivacySettings */
+            privacySettings?: {
+                /**
+                 * @description `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`.
+                 *
+                 * @example false
+                 */
+                result?: boolean;
+            };
+            /** WebhookSignalResponseVirtualMachine */
+            virtualMachine?: {
+                /**
+                 * @description `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise.
+                 *
+                 * @example false
+                 */
+                result?: boolean;
+            };
             vpn?: components['schemas']['VpnResult'];
@@ -217,2 +278,3 @@ /** WebhookSignalResponseProxy */
             tampering?: components['schemas']['TamperingResult'];
+            rawDeviceAttributes?: components['schemas']['RawDeviceAttributesResult'];
             /**
@@ -485,4 +547,3 @@ * @description Unique identifier of the user's identification request.
                     /**
-                     * @description Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected
-                     * Available only for events from Android client. The field will not be present for a browser or iOS event.
+                     * @description Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected or the client is not Android.
                      *
@@ -499,4 +560,3 @@ * @example false
                     /**
-                     * @description Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected
-                     * Available only for events from Android client. The field will not be present for a browser or iOS event.
+                     * @description Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected or the client is not Android.
                      *
@@ -509,2 +569,58 @@ * @example false
             };
+            /** SignalResponseClonedApp */
+            clonedApp?: {
+                data?: {
+                    /**
+                     * @description Android specific cloned application detection. There are 2 values: • `true` - Presence of app cloners work detected (e.g. fully cloned application found or launch of it inside of a not main working profile detected). • `false` - No signs of cloned application detected or the client is not Android.
+                     *
+                     * @example false
+                     */
+                    result?: boolean;
+                };
+                error?: components['schemas']['ProductError'];
+            };
+            /** SignalResponseFactoryReset */
+            factoryReset?: {
+                data?: {
+                    /**
+                     * Time
+                     * Format: date-time
+                     * @description Time in UTC for the Android client when recent factory reset was done.  If there is no sign of factory reset or the client isn't Android, the field will be epoch time.
+                     *
+                     * @example 2022-06-09T22:58:36Z
+                     */
+                    time?: string;
+                    /**
+                     * Format: int64
+                     * @description Same value as it's in the `time` field but represented in timestamp format.
+                     * @example 1654815517198
+                     */
+                    timestamp?: number;
+                };
+                error?: components['schemas']['ProductError'];
+            };
+            /** SignalResponseJailbroken */
+            jailbroken?: {
+                data?: {
+                    /**
+                     * @description iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak detected • `false` - No signs of jailbreak or the client is not iOS.
+                     *
+                     * @example false
+                     */
+                    result?: boolean;
+                };
+                error?: components['schemas']['ProductError'];
+            };
+            /** SignalResponseFrida */
+            frida?: {
+                data?: {
+                    /**
+                     * @description iOS specific [Frida](https://frida.re/docs/ios/) detection. There are 2 values: • `true` - Frida detected • `false` - No signs of Frida or the client is not iOS.
+                     *
+                     * @example false
+                     */
+                    result?: boolean;
+                };
+                error?: components['schemas']['ProductError'];
+            };
             /** SignalResponseIpBlocklist */
@@ -527,2 +643,26 @@ ipBlocklist?: {
             };
+            /** SignalResponsePrivacySettings */
+            privacySettings?: {
+                data?: {
+                    /**
+                     * @description `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`.
+                     *
+                     * @example false
+                     */
+                    result?: boolean;
+                };
+                error?: components['schemas']['ProductError'];
+            };
+            /** SignalResponseVirtualMachine */
+            virtualMachine?: {
+                data?: {
+                    /**
+                     * @description `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise.
+                     *
+                     * @example false
+                     */
+                    result?: boolean;
+                };
+                error?: components['schemas']['ProductError'];
+            };
             /** SignalResponseVpn */
@@ -550,2 +690,6 @@ vpn?: {
             };
+            /** SignalResponseRawDeviceAttributes */
+            rawDeviceAttributes?: {
+                data?: components['schemas']['RawDeviceAttributesResult'];
+            };
         };
@@ -681,2 +825,19 @@ /** @description Contains results from all activated products - Fingerprint Pro, Bot Detection, and others. */
         };
+        /**
+         * @description It includes 35+ raw browser identification attributes to provide Fingerprint users with even more information than our standard visitor ID provides. This enables Fingerprint users to not have to run our open-source product in conjunction with Fingerprint Pro Plus and Enterprise to get those additional attributes.
+         * Warning: The raw signals data can change at any moment as we improve the product. We cannot guarantee the internal shape of raw device attributes to be stable, so typical semantic versioning rules do not apply here. Use this data with caution without assuming a specific structure beyond the generic type provided here.
+         */
+        RawDeviceAttributesResult: {
+            [key: string]: {
+                /** error */
+                error?: {
+                    /** error.name */
+                    name: string;
+                    /** error.message */
+                    message: string;
+                };
+                /** value */
+                value?: unknown;
+            };
+        };
         ProductError: {
@@ -699,4 +860,5 @@ /**
     /**
-     * This endpoint allows you to retrieve an individual analysis event with all the information from each activated product (Identification, Bot Detection, and others).
-     * Products that are not activated for your application or not relevant to the event's detected platform (web, iOS, Android) are not included in the response.
+     * This endpoint allows you to get a detailed analysis of an individual request.
+     * **Only for Enterprise customers:** Please note that the response includes mobile signals (e.g. `rootApps`) even if the request orignated from a non-mobile platform.
+     * It is highly recommended that you **ignore** the mobile signals for such requests.
      *
@@ -1052,2 +1214,39 @@ * Use `requestId` as the URL path parameter. This API method is scoped to a request, i.e. all returned information is by `requestId`.
             } | undefined;
+            clonedApp?: {
+                data?: {
+                    result?: boolean | undefined;
+                } | undefined;
+                error?: {
+                    code: "Failed" | "TooManyRequests";
+                    message: string;
+                } | undefined;
+            } | undefined;
+            factoryReset?: {
+                data?: {
+                    time?: string | undefined;
+                    timestamp?: number | undefined;
+                } | undefined;
+                error?: {
+                    code: "Failed" | "TooManyRequests";
+                    message: string;
+                } | undefined;
+            } | undefined;
+            jailbroken?: {
+                data?: {
+                    result?: boolean | undefined;
+                } | undefined;
+                error?: {
+                    code: "Failed" | "TooManyRequests";
+                    message: string;
+                } | undefined;
+            } | undefined;
+            frida?: {
+                data?: {
+                    result?: boolean | undefined;
+                } | undefined;
+                error?: {
+                    code: "Failed" | "TooManyRequests";
+                    message: string;
+                } | undefined;
+            } | undefined;
             ipBlocklist?: {
@@ -1075,2 +1274,20 @@ data?: {
             } | undefined;
+            privacySettings?: {
+                data?: {
+                    result?: boolean | undefined;
+                } | undefined;
+                error?: {
+                    code: "Failed" | "TooManyRequests";
+                    message: string;
+                } | undefined;
+            } | undefined;
+            virtualMachine?: {
+                data?: {
+                    result?: boolean | undefined;
+                } | undefined;
+                error?: {
+                    code: "Failed" | "TooManyRequests";
+                    message: string;
+                } | undefined;
+            } | undefined;
             vpn?: {
@@ -1108,2 +1325,13 @@ data?: {
             } | undefined;
+            rawDeviceAttributes?: {
+                data?: {
+                    [key: string]: {
+                        error?: {
+                            name: string;
+                            message: string;
+                        } | undefined;
+                        value?: unknown;
+                    };
+                } | undefined;
+            } | undefined;
         } | undefined;
@@ -1110,0 +1338,0 @@ }>;

package.json

 {
   "name": "@fingerprintjs/fingerprintjs-pro-server-api",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Node.js wrapper for FingerprintJS Sever API",
@@ -5,0 +5,0 @@ "main": "dist/index.cjs",

readme.md

@@ -83,3 +83,3 @@ <p align="center">
 ##### Params
-- `region: Region` - a region of the server, possible value `Region.EU` or `Region.Global`
+- `region: Region` - a region of the server, possible values: `Region.EU`, `Region.AP`, or `Region.Global`
 - `apiKey: string` - secret API key from the [FingerprintJS dashboard](https://dashboard.fingerprint.com/)
@@ -86,0 +86,0 @@ - `fetch?: typeof fetch` - optional implementation of `fetch` function (defaults to `node-fetch`)

src/generatedApiTypes.ts

@@ -9,4 +9,5 @@ /**
     /**
-     * This endpoint allows you to retrieve an individual analysis event with all the information from each activated product (Identification, Bot Detection, and others).
-     * Products that are not activated for your application or not relevant to the event's detected platform (web, iOS, Android) are not included in the response.
+     * This endpoint allows you to get a detailed analysis of an individual request.
+     * **Only for Enterprise customers:** Please note that the response includes mobile signals (e.g. `rootApps`) even if the request orignated from a non-mobile platform.
+     * It is highly recommended that you **ignore** the mobile signals for such requests.
      *
@@ -168,4 +169,3 @@ * Use `requestId` as the URL path parameter. This API method is scoped to a request, i.e. all returned information is by `requestId`.
         /**
-         * @description Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected
-         * Available only for events from Android client. The field will not be present for a browser or iOS event.
+         * @description Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected or the client isn't Android.
          *
@@ -179,4 +179,3 @@ * @example false
         /**
-         * @description Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected
-         * Available only for events from Android client. The field will not be present for a browser or iOS event.
+         * @description Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected or the client isn't Android.
          *
@@ -187,2 +186,46 @@ * @example false
       };
+      /** WebhookSignalResponseClonedApp */
+      clonedApp?: {
+        /**
+         * @description Android specific cloned application detection. There are 2 values: • `true` - Presence of app cloners work detected (e.g. fully cloned application found or launch of it inside of a not main working profile detected). • `false` - No signs of cloned application detected or the client is not Android.
+         *
+         * @example false
+         */
+        result?: boolean;
+      };
+      /** WebhookSignalResponseFactoryReset */
+      factoryReset?: {
+        /**
+         * Time
+         * Format: date-time
+         * @description Time in UTC for the Android client when recent factory reset was done.  If there is no sign of factory reset or the client isn't Android, the field will be epoch time.
+         *
+         * @example 2022-06-09T22:58:36Z
+         */
+        time?: string;
+        /**
+         * Format: int64
+         * @description Same value as it's in the `time` field but represented in timestamp format.
+         * @example 1654815517198
+         */
+        timestamp?: number;
+      };
+      /** WebhookSignalResponseJailbroken */
+      jailbroken?: {
+        /**
+         * @description iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak detected • `false` - No signs of jailbreak or the client is not iOS.
+         *
+         * @example false
+         */
+        result?: boolean;
+      };
+      /** WebhookSignalResponseFrida */
+      frida?: {
+        /**
+         * @description iOS specific [Frida](https://frida.re/docs/ios/) detection. There are 2 values: • `true` - Frida detected • `false` - No signs of Frida or the client is not iOS.
+         *
+         * @example false
+         */
+        result?: boolean;
+      };
       ipBlocklist?: components['schemas']['IpBlockListResult'];
@@ -198,2 +241,20 @@ /** WebhookSignalResponseTor */
       };
+      /** WebhookSignalResponsePrivacySettings */
+      privacySettings?: {
+        /**
+         * @description `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`.
+         *
+         * @example false
+         */
+        result?: boolean;
+      };
+      /** WebhookSignalResponseVirtualMachine */
+      virtualMachine?: {
+        /**
+         * @description `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise.
+         *
+         * @example false
+         */
+        result?: boolean;
+      };
       vpn?: components['schemas']['VpnResult'];
@@ -210,2 +271,3 @@ /** WebhookSignalResponseProxy */
       tampering?: components['schemas']['TamperingResult'];
+      rawDeviceAttributes?: components['schemas']['RawDeviceAttributesResult'];
       /**
@@ -472,4 +534,3 @@ * @description Unique identifier of the user's identification request.
           /**
-           * @description Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected
-           * Available only for events from Android client. The field will not be present for a browser or iOS event.
+           * @description Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected or the client is not Android.
            *
@@ -486,4 +547,3 @@ * @example false
           /**
-           * @description Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected
-           * Available only for events from Android client. The field will not be present for a browser or iOS event.
+           * @description Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected or the client is not Android.
            *
@@ -496,2 +556,58 @@ * @example false
       };
+      /** SignalResponseClonedApp */
+      clonedApp?: {
+        data?: {
+          /**
+           * @description Android specific cloned application detection. There are 2 values: • `true` - Presence of app cloners work detected (e.g. fully cloned application found or launch of it inside of a not main working profile detected). • `false` - No signs of cloned application detected or the client is not Android.
+           *
+           * @example false
+           */
+          result?: boolean;
+        };
+        error?: components['schemas']['ProductError'];
+      };
+      /** SignalResponseFactoryReset */
+      factoryReset?: {
+        data?: {
+          /**
+           * Time
+           * Format: date-time
+           * @description Time in UTC for the Android client when recent factory reset was done.  If there is no sign of factory reset or the client isn't Android, the field will be epoch time.
+           *
+           * @example 2022-06-09T22:58:36Z
+           */
+          time?: string;
+          /**
+           * Format: int64
+           * @description Same value as it's in the `time` field but represented in timestamp format.
+           * @example 1654815517198
+           */
+          timestamp?: number;
+        };
+        error?: components['schemas']['ProductError'];
+      };
+      /** SignalResponseJailbroken */
+      jailbroken?: {
+        data?: {
+          /**
+           * @description iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak detected • `false` - No signs of jailbreak or the client is not iOS.
+           *
+           * @example false
+           */
+          result?: boolean;
+        };
+        error?: components['schemas']['ProductError'];
+      };
+      /** SignalResponseFrida */
+      frida?: {
+        data?: {
+          /**
+           * @description iOS specific [Frida](https://frida.re/docs/ios/) detection. There are 2 values: • `true` - Frida detected • `false` - No signs of Frida or the client is not iOS.
+           *
+           * @example false
+           */
+          result?: boolean;
+        };
+        error?: components['schemas']['ProductError'];
+      };
       /** SignalResponseIpBlocklist */
@@ -514,2 +630,26 @@ ipBlocklist?: {
       };
+      /** SignalResponsePrivacySettings */
+      privacySettings?: {
+        data?: {
+          /**
+           * @description `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`.
+           *
+           * @example false
+           */
+          result?: boolean;
+        };
+        error?: components['schemas']['ProductError'];
+      };
+      /** SignalResponseVirtualMachine */
+      virtualMachine?: {
+        data?: {
+          /**
+           * @description `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise.
+           *
+           * @example false
+           */
+          result?: boolean;
+        };
+        error?: components['schemas']['ProductError'];
+      };
       /** SignalResponseVpn */
@@ -537,2 +677,6 @@ vpn?: {
       };
+      /** SignalResponseRawDeviceAttributes */
+      rawDeviceAttributes?: {
+        data?: components['schemas']['RawDeviceAttributesResult'];
+      };
     };
@@ -668,2 +812,19 @@ /** @description Contains results from all activated products - Fingerprint Pro, Bot Detection, and others. */
     };
+    /**
+     * @description It includes 35+ raw browser identification attributes to provide Fingerprint users with even more information than our standard visitor ID provides. This enables Fingerprint users to not have to run our open-source product in conjunction with Fingerprint Pro Plus and Enterprise to get those additional attributes.
+     * Warning: The raw signals data can change at any moment as we improve the product. We cannot guarantee the internal shape of raw device attributes to be stable, so typical semantic versioning rules do not apply here. Use this data with caution without assuming a specific structure beyond the generic type provided here.
+     */
+    RawDeviceAttributesResult: {
+      [key: string]: {
+        /** error */
+        error?: {
+          /** error.name */
+          name: string;
+          /** error.message */
+          message: string;
+        };
+        /** value */
+        value?: unknown;
+      };
+    };
     ProductError: {
@@ -687,4 +848,5 @@ /**
   /**
-   * This endpoint allows you to retrieve an individual analysis event with all the information from each activated product (Identification, Bot Detection, and others).
-   * Products that are not activated for your application or not relevant to the event's detected platform (web, iOS, Android) are not included in the response.
+   * This endpoint allows you to get a detailed analysis of an individual request.
+   * **Only for Enterprise customers:** Please note that the response includes mobile signals (e.g. `rootApps`) even if the request orignated from a non-mobile platform.
+   * It is highly recommended that you **ignore** the mobile signals for such requests.
    *
@@ -691,0 +853,0 @@ * Use `requestId` as the URL path parameter. This API method is scoped to a request, i.e. all returned information is by `requestId`.

No alert changes

Improved metrics

Total package byte prevSize

133366

increased by13.73%

Lines of code

2960

increased by15.53%

No dependency changes