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

Comparing version 2.3.3 to 2.4.0

dist/index.d.ts

 /**
- * FingerprintJS Server API Node.js SDK v2.3.3 - Copyright (c) FingerprintJS, Inc, 2023 (https://fingerprint.com)
+ * FingerprintJS Server API Node.js SDK v2.4.0 - Copyright (c) FingerprintJS, Inc, 2023 (https://fingerprint.com)
  * Licensed under the MIT (http://www.opensource.org/licenses/mit-license.php) license.
@@ -274,2 +274,4 @@ */
             rawDeviceAttributes?: components['schemas']['RawDeviceAttributesResult'];
+            highActivity?: components['schemas']['HighActivityResult'];
+            locationSpoofing?: components['schemas']['LocationSpoofingResult'];
             /**
@@ -433,3 +435,6 @@ * @description Unique identifier of the user's identification request.
         IPLocation: {
-            /** @example 1000 */
+            /**
+             * @description The IP address is likely to be within this radius (in km) of the specified location.
+             * @example 1000
+             */
             accuracyRadius?: number;
@@ -531,8 +536,4 @@ /**
                      *
-                     * **Pro Plus:**
-                     * If a bot is detected (`products.botd.bot.result != "notDetected"`), the `visitorId` value contains a placeholder string `BotDetected000000000`.
-                     *
                      * @example [
-                     *   "Ibk1527CUFmcnjLwIs4A",
-                     *   "BotDetected000000000"
+                     *   "Ibk1527CUFmcnjLwIs4A"
                      * ]
@@ -709,2 +710,12 @@ */
             };
+            /** SignalResponseHighActivity */
+            highActivity?: {
+                data?: components['schemas']['HighActivityResult'];
+                error?: components['schemas']['ProductError'];
+            };
+            /** SignalResponseLocationSpoofing */
+            locationSpoofing?: {
+                data?: components['schemas']['LocationSpoofingResult'];
+                error?: components['schemas']['ProductError'];
+            };
             /** SignalResponseRawDeviceAttributes */
@@ -823,2 +834,7 @@ rawDeviceAttributes?: {
             result?: boolean;
+            /**
+             * @description Local timezone which is used in timezoneMismatch method.
+             * @example Europe/Berlin
+             */
+            originTimezone?: string;
             methods?: {
@@ -854,2 +870,21 @@ /**
         };
+        HighActivityResult: {
+            /**
+             * @description Flag indicating whether the request came from a high activity visitor.
+             * @example false
+             */
+            result?: boolean;
+            /**
+             * @description Number of requests from the same visitor in the previous day.
+             * @example 10
+             */
+            dailyRequests?: number;
+        };
+        LocationSpoofingResult: {
+            /**
+             * @description Flag indicating whether the request came from a device with location spoofing enabled.
+             * @example false
+             */
+            result?: boolean;
+        };
         /**
@@ -1340,2 +1375,3 @@ * @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.
                     result?: boolean | undefined;
+                    originTimezone?: string | undefined;
                     methods?: {
@@ -1371,2 +1407,21 @@ timezoneMismatch?: boolean | undefined;
             } | undefined;
+            highActivity?: {
+                data?: {
+                    result?: boolean | undefined;
+                    dailyRequests?: number | undefined;
+                } | undefined;
+                error?: {
+                    code: "Failed" | "TooManyRequests";
+                    message: string;
+                } | undefined;
+            } | undefined;
+            locationSpoofing?: {
+                data?: {
+                    result?: boolean | undefined;
+                } | undefined;
+                error?: {
+                    code: "Failed" | "TooManyRequests";
+                    message: string;
+                } | undefined;
+            } | undefined;
             rawDeviceAttributes?: {
@@ -1373,0 +1428,0 @@ data?: {

package.json

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

readme.md

 <p align="center">
   <a href="https://fingerprint.com">
     <picture>
-      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/HEAD/resources/logo_light.svg" />
-      <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/HEAD/resources/logo_dark.svg" />
-      <img src="https://raw.githubusercontent.com/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/HEAD/resources/logo_dark.svg" alt="Fingerprint logo" width="312px" />
+      <source media="(prefers-color-scheme: dark)" srcset="https://fingerprintjs.github.io/home/resources/logo_light.svg" />
+      <source media="(prefers-color-scheme: light)" srcset="https://fingerprintjs.github.io/home/resources/logo_dark.svg" />
+      <img src="https://fingerprintjs.github.io/home/resources/logo_dark.svg" alt="Fingerprint logo" width="312px" />
     </picture>
@@ -8,0 +8,0 @@ </a>

src/generatedApiTypes.ts

@@ -267,2 +267,4 @@ /**
       rawDeviceAttributes?: components['schemas']['RawDeviceAttributesResult'];
+      highActivity?: components['schemas']['HighActivityResult'];
+      locationSpoofing?: components['schemas']['LocationSpoofingResult'];
       /**
@@ -422,3 +424,6 @@ * @description Unique identifier of the user's identification request.
     IPLocation: {
-      /** @example 1000 */
+      /**
+       * @description The IP address is likely to be within this radius (in km) of the specified location.
+       * @example 1000
+       */
       accuracyRadius?: number;
@@ -518,8 +523,4 @@ /**
            *
-           * **Pro Plus:**
-           * If a bot is detected (`products.botd.bot.result != "notDetected"`), the `visitorId` value contains a placeholder string `BotDetected000000000`.
-           *
            * @example [
-           *   "Ibk1527CUFmcnjLwIs4A",
-           *   "BotDetected000000000"
+           *   "Ibk1527CUFmcnjLwIs4A"
            * ]
@@ -696,2 +697,12 @@ */
       };
+      /** SignalResponseHighActivity */
+      highActivity?: {
+        data?: components['schemas']['HighActivityResult'];
+        error?: components['schemas']['ProductError'];
+      };
+      /** SignalResponseLocationSpoofing */
+      locationSpoofing?: {
+        data?: components['schemas']['LocationSpoofingResult'];
+        error?: components['schemas']['ProductError'];
+      };
       /** SignalResponseRawDeviceAttributes */
@@ -810,2 +821,7 @@ rawDeviceAttributes?: {
       result?: boolean;
+      /**
+       * @description Local timezone which is used in timezoneMismatch method.
+       * @example Europe/Berlin
+       */
+      originTimezone?: string;
       methods?: {
@@ -841,2 +857,21 @@ /**
     };
+    HighActivityResult: {
+      /**
+       * @description Flag indicating whether the request came from a high activity visitor.
+       * @example false
+       */
+      result?: boolean;
+      /**
+       * @description Number of requests from the same visitor in the previous day.
+       * @example 10
+       */
+      dailyRequests?: number;
+    };
+    LocationSpoofingResult: {
+      /**
+       * @description Flag indicating whether the request came from a device with location spoofing enabled.
+       * @example false
+       */
+      result?: boolean;
+    };
     /**
@@ -843,0 +878,0 @@ * @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.

No alert changes

Improved metrics

Total package byte prevSize

141596

increased by2.2%

Lines of code

3139

increased by2.95%

No dependency changes