@riavzon/bot-detector-create 1.0.0 → 1.0.3

package/README.md

@@ -0,0 +1,100 @@
+# @riavzon/bot-detector-create
+
+Zero-config setup for [@riavzon/bot-detector](https://github.com/Sergo706/botDetector).
+Run one command and get a fully configured bot detection middleware with all
+data sources downloaded, compiled, and a SQLite database ready to go.
+
+## Usage
+
+Run this in the root of your Express project:
+
+```bash
+npx @riavzon/bot-detector-create
+```
+
+The command does the following in order:
+
+1. Installs `@riavzon/bot-detector`, `express`, `cookie-parser`, and
+   `better-sqlite3` into your project.
+2. Triggers the data source installer — downloads and compiles all threat
+   intelligence feeds (FireHOL, Tor, ASN, GeoIP, JA4, user-agent lists) into
+   fast local MMDB/LMDB files.
+3. Writes a `botDetectorConfig.ts` file at your project root with all 17
+   checkers pre-configured at their default values.
+4. Runs `load-schema` to create the `visitors` and `banned` tables in a local
+   `bot_detector.sqlite` file.
+
+## What you get
+
+`botDetectorConfig.ts` is a fully annotated configuration file. Every option
+is shown explicitly so you know exactly what's active and what you can tune.
+
+```ts
+import { defineConfiguration } from '@riavzon/bot-detector';
+
+await defineConfiguration({
+    store: {
+        main: {
+            driver: 'sqlite',
+            name: './bot_detector.sqlite',
+        },
+    },
+    // ... all 17 checkers with default penalties
+});
+```
+
+The defaults use SQLite and in-process memory cache — no external services
+required. When you're ready for production, swap the adapters:
+
+```ts
+// MySQL
+store: { main: { driver: 'mysql-pool', host: '...', user: '...', ... } }
+
+// Redis cache
+storage: { driver: 'redis', url: process.env.REDIS_URL }
+
+// Upstash (serverless)
+storage: { driver: 'upstash', url: process.env.UPSTASH_URL, token: process.env.UPSTASH_TOKEN }
+```
+
+## Mount the middleware
+
+Import `botDetectorConfig.ts` at the top of your app entry point, before any
+routes, then mount the middleware:
+
+```ts
+import './botDetectorConfig.js';
+import { detectBots } from '@riavzon/bot-detector';
+import cookieParser from 'cookie-parser';
+import express from 'express';
+
+const app = express();
+app.use(cookieParser());
+app.use(detectBots());
+
+app.get('/', (req, res) => {
+    res.send('Hello, human.');
+});
+
+app.listen(3000);
+```
+
+## Keep data sources fresh
+
+Threat intelligence feeds update continuously. Run a refresh at least once
+every 24 hours:
+
+```bash
+npx @riavzon/bot-detector refresh
+```
+
+Add it to a cron job or a scheduled CI step to keep detection accurate.
+
+## Requirements
+
+- Node.js 18 or later
+- npm
+
+## License
+
+Apache-2.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@riavzon/bot-detector-create",
-    "version": "1.0.0",
+    "version": "1.0.3",
     "type": "module",
     "author": "Sergio contact@riavzon.com",
     "license": "Apache-2.0",
@@ -25,7 +25,7 @@
         "detect bots"
     ],
     "bin": {
-        "create-bot-detector": "./dist/create.mjs"
+        "create-bot-detector": "./dist/create.cjs"
     },
     "scripts": {
         "build": "tsdown",
@@ -39,4 +39,4 @@
         "tsdown": "latest",
         "typescript": "latest"
     }
-}
+}