is-antibot 0.0.4 → 1.0.0

package/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright © 2025 Kiko Beats <josefrancisco.verdu@gmail.com> (kikobeats.com)
+Copyright © 2025 Microlink <hello@microlink.io> (https://microlink.io)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,18 +1,21 @@
-# is-antibot
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/microlinkhq/cdn/raw/master/dist/logo/banner-dark.png">
+  <img alt="microlink cdn" src="https://github.com/microlinkhq/cdn/raw/master/dist/logo/banner.png" align="center">
+</picture>
 
-<p align="center">
-  <br>
-  <img src="https://i.imgur.com/Mh13XWB.gif" alt="is-antibot">
-  <br>
-</p>
-
-![Last version](https://img.shields.io/github/tag/kikobeats/is-antibot.svg?style=flat-square)
-[![Coverage Status](https://img.shields.io/coveralls/kikobeats/is-antibot.svg?style=flat-square)](https://coveralls.io/github/kikobeats/is-antibot)
+![Last version](https://img.shields.io/github/tag/microlinkhq/is-antibot.svg?style=flat-square)
+[![Coverage Status](https://img.shields.io/coveralls/microlinkhq/is-antibot.svg?style=flat-square)](https://coveralls.io/github/microlinkhq/is-antibot)
 [![NPM Status](https://img.shields.io/npm/dm/is-antibot.svg?style=flat-square)](https://www.npmjs.org/package/is-antibot)
 
-**NOTE:** more badges availables in [shields.io](https://shields.io/)
+> Identify if a response is an antibot challenge from CloudFlare, Akamai, DataDome, Vercel, and more.
+
+## Why
+
+Websites receiving massive quantities of traffic throughout the day, like LinkedIn, Instagram, or YouTube, have sophisticated antibot systems to prevent automated access.
+
+When you try to fetch the HTML of these sites without the right tools, you often hit a 403 Forbidden, 429 Too Many Requests, or a "Please prove you're human" challenge, leaving you with a response that contains no useful data.
 
-> Detect Captcha responses
+**is-antibot** is a lightweight, vendor-agnostic JavaScript library that identifies when a response is actually an antibot challenge, helping you understand when and why your request was blocked.
 
 ## Install
 
@@ -22,36 +25,24 @@ $ npm install is-antibot --save
 
 ## Usage
 
-```js
-const isCaptcha = require('is-antibot')
-
-isCaptcha('do something')
-// => return something
-```
-
-## API
-
-### isCaptcha(input, [options])
-
-#### input
-
-*Required*<br>
-Type: `string`
+The library is designed for evaluating a HTTP response:
 
-Lorem ipsum.
-
-#### options
+```js
+const isAntibot = require('is-antibot')
 
-##### foo
+const response = await fetch('https://example.com')
+const { detected, provider } = isAntibot(response)
 
-Type: `boolean`<br>
-Default: `false`
+if (detected) {
+  console.log(`Antibot detected: ${provider}`)
+}
+```
 
-Lorem ipsum.
+The library expects a [Fetch Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) object, a [Node.js Response](https://nodejs.org/api/http.html#class-httpincomingmessage) object, or an object representing HTTP response headers as input.
 
 ## License
 
-**is-antibot** © [Kiko Beats](https://kikobeats.com), released under the [MIT](https://github.com/kikobeats/is-antibot/blob/master/LICENSE.md) License.<br>
-Authored and maintained by [Kiko Beats](https://kikobeats.com) with help from [contributors](https://github.com/kikobeats/is-antibot/contributors).
+**is-antibot** © [microlink.io](https://microlink.io), released under the [MIT](https://github.com/microlinkhq/is-antibot/blob/master/LICENSE.md) License.<br>
+Authored and maintained by [microlink.io](https://microlink.io) with help from [contributors](https://github.com/microlinkhq/is-antibot/contributors).
 
-> [kikobeats.com](https://kikobeats.com) · GitHub [Kiko Beats](https://github.com/kikobeats) · Twitter [@kikobeats](https://twitter.com/kikobeats)
+> [microlink.io](https://microlink.io) · GitHub [microlink.io](https://github.com/microlinkhq) · X [@microlinkhq](https://x.com/microlinkhq)

package/package.json

@@ -1,44 +1,54 @@
 {
   "name": "is-antibot",
-  "description": "Detect Captcha responses",
-  "homepage": "https://github.com/kikobeats/is-antibot",
-  "version": "0.0.4",
+  "description": "Identify if a response is an antibot challenge from CloudFlare, Akamai, DataDome, Vercel, and more.",
+  "homepage": "https://github.com/microlinkhq/is-antibot",
+  "version": "1.0.0",
+  "exports": {
+    ".": "./src/index.js"
+  },
   "author": {
-    "name": "Kiko Beats",
-    "email": "josefrancisco.verdu@gmail.com",
-    "url": "https://kikobeats.com"
+    "email": "hello@microlink.io",
+    "name": "Microlink",
+    "url": "https://microlink.io"
   },
+  "contributors": [
+    {
+      "name": "Kiko Beats",
+      "email": "josefrancisco.verdu@gmail.com"
+    }
+  ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/kikobeats/is-antibot.git"
+    "url": "git+https://github.com/microlinkhq/is-antibot.git"
   },
   "bugs": {
-    "url": "https://github.com/kikobeats/is-antibot/issues"
+    "url": "https://github.com/microlinkhq/is-antibot/issues"
   },
   "keywords": [
+    "akamai",
+    "antibot",
+    "bot",
     "captcha",
     "challenge",
-    "cloudflare"
+    "cloudflare",
+    "datadome",
+    "detection",
+    "scraper",
+    "scraping",
+    "vercel",
+    "waf"
   ],
   "dependencies": {
-    "@metascraper/helpers": "~5.49.15",
     "debug-logfmt": "~1.4.7"
   },
-  "files": [
-    "src"
-  ],
-  "ava": {
-    "files": [
-      "test/**/*.js",
-      "!test/util.js"
-    ]
-  },
   "devDependencies": {
     "@commitlint/cli": "latest",
     "@commitlint/config-conventional": "latest",
     "@ksmithut/prettier-standard": "latest",
     "ava": "latest",
     "c8": "latest",
+    "ci-publish": "latest",
+    "conventional-changelog-cli": "latest",
     "finepack": "latest",
     "git-authors-cli": "latest",
     "github-generate-release": "latest",
@@ -50,7 +60,16 @@
   "engines": {
     "node": ">= 20"
   },
+  "files": [
+    "src"
+  ],
   "license": "MIT",
+  "ava": {
+    "files": [
+      "test/**/*.js",
+      "!test/util.js"
+    ]
+  },
   "commitlint": {
     "extends": [
       "@commitlint/config-conventional"
@@ -61,9 +80,6 @@
       ]
     }
   },
-  "exports": {
-    ".": "./src/index.js"
-  },
   "nano-staged": {
     "*.js": [
       "prettier-standard",
@@ -82,11 +98,15 @@
     "contributors": "(npx git-authors-cli && npx finepack && git add package.json && git commit -m 'build: contributors' --no-verify) || true",
     "coverage": "c8 report --reporter=text-lcov > coverage/lcov.info",
     "lint": "standard",
-    "postrelease": "npm run release:tags && npm run release:github && npm publish",
+    "postrelease": "npm run release:tags && npm run release:github && (ci-publish || npm publish --access=public)",
     "pretest": "npm run lint",
-    "release": "standard-version -a",
+    "release": "pnpm run release:version && pnpm run release:changelog && pnpm run release:commit && pnpm run release:tag",
+    "release:changelog": "conventional-changelog -p conventionalcommits -i CHANGELOG.md -s",
+    "release:commit": "git add package.json CHANGELOG.md && git commit -m \"chore(release): $(node -p \"require('./package.json').version\")\"",
     "release:github": "github-generate-release",
-    "release:tags": "git push --follow-tags origin HEAD:master",
+    "release:tag": "git tag -a v$(node -p \"require('./package.json').version\") -m \"v$(node -p \"require('./package.json').version\")\"",
+    "release:tags": "git push origin HEAD:master --follow-tags",
+    "release:version": "standard-version --skip.changelog --skip.commit --skip.tag",
     "test": "c8 ava"
   }
 }

package/src/index.js

@@ -1,38 +1,42 @@
 'use strict'
 
-const { parseUrl } = require('@metascraper/helpers')
 const debug = require('debug-logfmt')('is-antibot')
 
-module.exports = ({ url, htmlDom, headers = {} } = {}) => {
+const getHeader = (headers, name) =>
+  typeof headers.get === 'function' ? headers.get(name) : headers[name]
+
+module.exports = ({ headers = {} } = {}) => {
+  let detected = false
+  let provider = null
+
   // https://developers.cloudflare.com/cloudflare-challenges/challenge-types/challenge-pages/detect-response/
-  if (headers['cf-mitigated'] === 'challenge') {
-    debug({ provider: 'cloudflare' })
-    return true
+  if (getHeader(headers, 'cf-mitigated') === 'challenge') {
+    detected = true
+    provider = 'cloudflare'
   }
 
   // https://github.com/glizzykingdreko/Vercel-Attack-Mode-Solver
-  if (headers['x-vercel-mitigated'] === 'challenge') {
-    debug({ provider: 'vercel' })
-    return true
+  if (getHeader(headers, 'x-vercel-mitigated') === 'challenge') {
+    detected = true
+    provider = 'vercel'
   }
 
   // https://techdocs.akamai.com/property-mgr/docs/return-cache-status
-  if (headers['akamai-cache-status']?.startsWith('Error')) {
-    debug({ provider: 'akamai' })
-    return true
+  if (getHeader(headers, 'akamai-cache-status')?.startsWith('Error')) {
+    detected = true
+    provider = 'akamai'
   }
 
-  const parsedUrl = parseUrl(url)
-
-  if (parsedUrl.domainWithoutSuffix === 'reddit') {
-    const condition = htmlDom.text().includes('Prove your humanity')
-    if (condition) {
-      debug({ provider: 'reddit' })
-      return true
-    }
+  // https://docs.datadome.co/reference/validate-request
+  // 1: Soft challenge / JS redirect / interstitial
+  // 2: Hard challenge / HTML redirect / CAPTCHA
+  if (['1', '2'].includes(getHeader(headers, 'x-dd-b'))) {
+    detected = true
+    provider = 'datadome'
   }
 
-  return false
+  debug({ detected, provider })
+  return { detected, provider }
 }
 
 module.exports.debug = debug