@apiverve/botdetector 1.1.13 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Bot Detector API
2
2
 
3
- Bot Detector is an API that analyzes user agent strings to identify bots, crawlers, and automated software. Useful for security, analytics, and access control.
3
+ Bot Detector analyzes user agent strings to identify bots, crawlers, and automated software. It matches against a database of known bots and adds heuristics that catch automated clients not in the database, returning the bot's category, reputation and a composite risk score. Useful for security, analytics, and access control.
4
4
 
5
5
  ![Build Status](https://img.shields.io/badge/build-passing-green)
6
6
  ![Code Climate](https://img.shields.io/badge/maintainability-B-purple)
@@ -127,8 +127,13 @@ async function makeRequest() {
127
127
  "bot": {
128
128
  "name": "Googlebot",
129
129
  "category": "search_engine",
130
- "url": "http://www.google.com/bot.html"
131
- }
130
+ "url": "http://www.google.com/bot.html",
131
+ "reputation": "trusted",
132
+ "shouldBlock": false
133
+ },
134
+ "isAutomated": true,
135
+ "riskScore": 0,
136
+ "riskLevel": "low"
132
137
  }
133
138
  }
134
139
  ```
package/index.d.ts CHANGED
@@ -4,24 +4,41 @@ declare module '@apiverve/botdetector' {
4
4
  secure?: boolean;
5
5
  }
6
6
 
7
+ /**
8
+ * Describes fields the current plan does not unlock. Locked fields arrive as null
9
+ * in `data`; `locked_fields` names them, using dot paths for nested fields.
10
+ * Absent when the plan unlocks everything.
11
+ */
12
+ export interface PremiumInfo {
13
+ message: string;
14
+ upgrade_url: string;
15
+ locked_fields: string[];
16
+ }
17
+
7
18
  export interface botdetectorResponse {
8
19
  status: string;
9
20
  error: string | null;
10
21
  data: BotDetectorData;
11
22
  code?: number;
23
+ premium?: PremiumInfo;
12
24
  }
13
25
 
14
26
 
15
27
  interface BotDetectorData {
16
- userAgent: string;
17
- isBot: boolean;
18
- bot: Bot;
28
+ userAgent: null | string;
29
+ isBot: boolean | null;
30
+ bot: Bot;
31
+ isAutomated: boolean | null;
32
+ riskScore: number | null;
33
+ riskLevel: null | string;
19
34
  }
20
35
 
21
36
  interface Bot {
22
- name: string;
23
- category: string;
24
- url: string;
37
+ name: null | string;
38
+ category: null | string;
39
+ url: null | string;
40
+ reputation: null | string;
41
+ shouldBlock: boolean | null;
25
42
  }
26
43
 
27
44
  export default class botdetectorWrapper {
package/index.js CHANGED
@@ -13,16 +13,10 @@ class botdetectorWrapper {
13
13
  throw new Error('API key must be provided as a non-empty string. Get your API key at: https://apiverve.com');
14
14
  }
15
15
 
16
- // Validate API key format (GUID or alphanumeric with hyphens)
17
- const apiKeyPattern = /^[a-zA-Z0-9-]+$/;
16
+ // Validate API key format (GUID, prefixed keys like apv_xxx, or alphanumeric)
17
+ const apiKeyPattern = /^[a-zA-Z0-9_-]+$/;
18
18
  if (!apiKeyPattern.test(api_key)) {
19
- throw new Error('Invalid API key format. API key must be alphanumeric and may contain hyphens. Get your API key at: https://apiverve.com');
20
- }
21
-
22
- // Check minimum length (GUIDs are typically 36 chars with hyphens, or 32 without)
23
- const trimmedKey = api_key.replace(/-/g, '');
24
- if (trimmedKey.length < 32) {
25
- throw new Error('Invalid API key. API key appears to be too short. Get your API key at: https://apiverve.com');
19
+ throw new Error('Invalid API key format. API key must be alphanumeric and may contain hyphens and underscores. Get your API key at: https://apiverve.com');
26
20
  }
27
21
 
28
22
  if (typeof secure !== 'boolean') {
@@ -36,7 +30,7 @@ class botdetectorWrapper {
36
30
  this.baseURL = 'https://api.apiverve.com/v1/botdetector';
37
31
 
38
32
  // Validation rules for parameters (generated from schema)
39
- this.validationRules = {"ua":{"type":"string","required":true,"format":"url"}};
33
+ this.validationRules = {"ua":{"type":"string","required":true}};
40
34
  }
41
35
 
42
36
  /**
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@apiverve/botdetector",
3
- "version": "1.1.13",
4
- "description": "Bot Detector is an API that analyzes user agent strings to identify bots, crawlers, and automated software. Useful for security, analytics, and access control.",
3
+ "version": "1.2.0",
4
+ "description": "Bot Detector analyzes user agent strings to identify bots, crawlers, and automated software. It matches against a database of known bots and adds heuristics that catch automated clients not in the database, returning the bot's category, reputation and a composite risk score. Useful for security, analytics, and access control.",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
7
7
  "sideEffects": false,
8
8
  "engines": {
9
- "node": ">=14.0.0"
9
+ "node": ">=18.0.0"
10
10
  },
11
11
  "files": [
12
12
  "index.js",
@@ -23,7 +23,7 @@
23
23
  "directory": "npm"
24
24
  },
25
25
  "keywords": [
26
- ""
26
+ "bot detector", "crawler detector", "user agent check", "bot detection", "web crawler"
27
27
  ],
28
28
  "author": {
29
29
  "name": "APIVerve",
@@ -41,8 +41,7 @@
41
41
  "dotenv": "^16.4.7"
42
42
  },
43
43
  "dependencies": {
44
- "node-fetch": "^3.3.2",
45
- "promise": "^8.3.0",
46
- "axios": "1.13.2"
44
+ "axios": "1.13.2",
45
+ "form-data": "^4.0.1"
47
46
  }
48
47
  }