@riavzon/bot-detector-create 1.0.10 → 1.0.12

package/README.md

@@ -12,16 +12,17 @@ Run this in the root of your Express project:
 npx @riavzon/bot-detector-create
 ```
 
-The command does the following in order:
+The command does the following:
 
 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.
+2. Triggers the data source installer and downloads and compiles all threat
+   intelligence feeds.
 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
+4. Writes a `mainBotDetector.ts` file at your project root, a ready-to-run
+   Express entry point that imports the config and mounts the middleware.
+5. Runs `load-schema` to create the `visitors` and `banned` tables in a local
    `bot_detector.sqlite` file.
 
 ## What you get
@@ -43,8 +44,7 @@ await defineConfiguration({
 });
 ```
 
-The defaults use SQLite and in-process memory cache — no external services
-required. When you're ready for production, swap the adapters:
+The defaults use SQLite and in-process memory cache, When you're ready for production, swap the adapters:
 
 ```ts
 // MySQL
@@ -57,28 +57,39 @@ storage: { driver: 'redis', url: process.env.REDIS_URL }
 storage: { driver: 'upstash', url: process.env.UPSTASH_URL, token: process.env.UPSTASH_TOKEN }
 ```
 
-## Mount the middleware
+## What you get
 
-Import `botDetectorConfig.ts` at the top of your app entry point, before any
-routes, then mount the middleware:
+`mainBotDetector.ts` is a ready-to-run Express entry point. It imports the
+config, mounts the middleware, and starts the server:
 
 ```ts
 import './botDetectorConfig.js';
-import { detectBots } from '@riavzon/bot-detector';
-import cookieParser from 'cookie-parser';
 import express from 'express';
+import cookieParser from 'cookie-parser';
+import { detectBots } from '@riavzon/bot-detector';
 
 const app = express();
 app.use(cookieParser());
 app.use(detectBots());
 
 app.get('/', (req, res) => {
-    res.send('Hello, human.');
+    res.json({ banned: req.botDetection?.banned });
 });
 
 app.listen(3000);
 ```
 
+## Mount the middleware
+
+`botDetectorConfig.ts` must be imported before any routes. If you prefer to
+wire it into your own entry point instead of using `mainBotDetector.ts`:
+
+```ts
+import './botDetectorConfig.js';
+import { detectBots } from '@riavzon/bot-detector';
+// ... rest of your app
+```
+
 ## Keep data sources fresh
 
 Threat intelligence feeds update continuously. Run a refresh at least once

package/dist/create.js

@@ -9,6 +9,21 @@ const defaultStore = { main: {
 	driver: "sqlite",
 	name: "./bot_detector.sqlite"
 } };
+const mainContent = `import './botDetectorConfig.js';
+import express from 'express';
+import cookieParser from 'cookie-parser';
+import { detectBots } from '@riavzon/bot-detector';
+
+const app = express();
+app.use(cookieParser());
+app.use(detectBots());
+
+app.get('/', (req, res) => {
+    res.json({ banned: req.botDetection?.banned });
+});
+
+app.listen(3000);
+`;
 const content = `import { defineConfiguration } from '@riavzon/bot-detector';
 
 /**
@@ -43,7 +58,7 @@ await defineConfiguration({
     setNewComputedScore: false,
 
     // ─── Whitelist (IPv4, IPv6, or CIDR) ───────────────────────────────────────
-    whiteList: [],
+    whiteList: ['127.0.0.1', '::1'],
 
     // ─── Re-check interval for returning visitors ──────────────────────────────
     checksTimeRateControl: {
@@ -300,6 +315,7 @@ const start = defineCommand({
 		await run("npx", ["@riavzon/bot-detector", "init"]);
 		consola.start("Writing botDetectorConfig.ts...");
 		await fs.writeFile(output, content, "utf-8");
+		await fs.writeFile(path.resolve(process.cwd(), "mainBotDetector.ts"), mainContent, "utf-8");
 		consola.success("botDetectorConfig.ts created");
 		consola.start("Creating database tables...");
 		const { defineConfiguration, createTables, getDb } = await import(path.resolve(process.cwd(), "node_modules/@riavzon/bot-detector/dist/main.mjs"));
@@ -309,6 +325,7 @@ const start = defineCommand({
 		consola.log("");
 		consola.log("Keep data sources fresh (run daily or via cron):");
 		consola.log("  npx @riavzon/bot-detector refresh");
+		process.exit(0);
 	}
 });
 await runMain(start);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@riavzon/bot-detector-create",
-    "version": "1.0.10",
+    "version": "1.0.12",
     "type": "module",
     "author": "Sergio contact@riavzon.com",
     "license": "Apache-2.0",
@@ -13,6 +13,9 @@
     "bugs": {
         "url": "https://github.com/Sergo706/botDetector/issues"
     },
+    "files": [
+        "dist"
+    ],
     "keywords": [
         "bot-detection",
         "express-middleware",

package/eslint.config.mjs

@@ -1,6 +0,0 @@
-import { defineStrictTSConfig } from '@riavzon/utils/eslint/strict';
-
-export default defineStrictTSConfig({
-    rootDir: import.meta.dirname,
-    extraIgnores: ['tsdown.config.ts'],
-});

package/src/create.ts

@@ -1,57 +0,0 @@
-#!/usr/bin/env node
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-
-import consola from 'consola';
-import { defineCommand, runMain } from 'citty';
-import fs from 'node:fs/promises';
-import path from 'node:path';
-import { spawn } from 'node:child_process';
-import { content, defaultStore } from './default.js';
-
-function run(cmd: string, args: string[]): Promise<void> {
-    return new Promise((resolve, reject) => {
-        const child = spawn(cmd, args, { stdio: 'inherit', shell: true });
-        child.on('close', code => {
-            if (code === 0) { resolve(); } else { reject(new Error(`${cmd} exited with code ${String(code)}`)); }
-        });
-    });
-}
-
-export const start = defineCommand({
-    meta: {
-        name: 'Create Bot Detector',
-        description: 'Quick starter for @riavzon/bot-detector'
-    },
-
-    async run() {
-        const output = path.resolve(process.cwd(), 'botDetectorConfig.ts');
-
-        consola.start('Installing dependencies...');
-        await run('npm', ['install', 'express', 'cookie-parser', 'better-sqlite3']);
-
-        consola.start('Installing @riavzon/bot-detector...');
-        await run('npm', ['install', '@riavzon/bot-detector']);
-
-        consola.start('Fetching data sources...');
-        await run('npx', ['@riavzon/bot-detector', 'init']);
-        
-        consola.start('Writing botDetectorConfig.ts...');
-        await fs.writeFile(output, content, 'utf-8');
-        consola.success('botDetectorConfig.ts created');
-
-        consola.start('Creating database tables...');
-        const pkgMain = path.resolve(process.cwd(), 'node_modules/@riavzon/bot-detector/dist/main.mjs');
-        const { defineConfiguration, createTables, getDb } = await import(pkgMain);
-        
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-call
-        await defineConfiguration({ store: defaultStore });
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-call
-        await createTables(getDb());
-
-        consola.success('Setup complete. Import botDetectorConfig.ts at the top of your app entry point and mount the middleware.');
-        consola.log('');
-        consola.log('Keep data sources fresh (run daily or via cron):');
-        consola.log('  npx @riavzon/bot-detector refresh');
-    }
-});
-await runMain(start);

package/src/default.ts

@@ -1,260 +0,0 @@
-export const defaultStore = { main: { driver: 'sqlite' as const, name: './bot_detector.sqlite' } };
-
-export const content = `import { defineConfiguration } from '@riavzon/bot-detector';
-
-/**
- * Bot Detector configuration — all values shown are the defaults.
- * Tune penalties, enable/disable checkers, and swap adapters as needed.
- *
- * Next steps:
- *   Import this file before mounting the middleware in your app entry point
- *
- * Keep data sources fresh:
- *   npx @riavzon/bot-detector refresh
- */
-await defineConfiguration({
-
-    // ─── Database (SQLite default — swap for mysql-pool / postgresql in production)
-    store: {
-        main: {
-            driver: 'sqlite',
-            name: './bot_detector.sqlite',
-        },
-    },
-
-    // ─── Cache (default: in-process memory — uncomment to use a different one)
-    // storage: { driver: 'lru', max: 500, ttl: 1000 * 60 * 60 * 2 },
-    // storage: { driver: 'redis', url: process.env.REDIS_URL ?? 'redis://localhost:6379' },
-    // storage: { driver: 'upstash', url: process.env.UPSTASH_URL, token: process.env.UPSTASH_TOKEN },
-
-    // ─── Core scoring ──────────────────────────────────────────────────────────
-    banScore: 100,
-    maxScore: 100,
-    restoredReputationPoints: 10,
-    setNewComputedScore: false,
-
-    // ─── Whitelist (IPv4, IPv6, or CIDR) ───────────────────────────────────────
-    whiteList: [],
-
-    // ─── Re-check interval for returning visitors ──────────────────────────────
-    checksTimeRateControl: {
-        checkEveryRequest: true,
-        checkEvery: 1000 * 60 * 5,
-    },
-
-    // ─── Async batch write queue ───────────────────────────────────────────────
-    batchQueue: {
-        flushIntervalMs: 5000,
-        maxBufferSize: 100,
-        maxRetries: 3,
-    },
-
-    // ─── Logging ───────────────────────────────────────────────────────────────
-    logLevel: 'info',
-
-    // ─── Firewall ban (requires sudo ufw) ──────────────────────────────────────
-    punishmentType: {
-        enableFireWallBan: false,
-    },
-
-    // ─── Custom MMDB generation from visitor history ───────────────────────────
-    generator: {
-        scoreThreshold: 70,
-        generateTypes: false,
-        deleteAfterBuild: false,
-        mmdbctlPath: 'mmdbctl',
-    },
-
-    // ─── HTTP header anomaly penalties ─────────────────────────────────────────
-    headerOptions: {
-        weightPerMustHeader: 20,
-        missingBrowserEngine: 30,
-        postManOrInsomiaHeaders: 50,
-        AJAXHeaderExists: 30,
-        connectionHeaderIsClose: 20,
-        originHeaderIsNULL: 10,
-        originHeaderMismatch: 30,
-        omittedAcceptHeader: 30,
-        clientHintsMissingForBlink: 30,
-        teHeaderUnexpectedForBlink: 10,
-        clientHintsUnexpectedForGecko: 30,
-        teHeaderMissingForGecko: 20,
-        aggressiveCacheControlOnGet: 15,
-        crossSiteRequestMissingReferer: 10,
-        inconsistentSecFetchMode: 20,
-        hostMismatchWeight: 40,
-    },
-
-    // ─── Path traversal detection ──────────────────────────────────────────────
-    pathTraveler: {
-        maxIterations: 3,
-        maxPathLength: 1500,
-        pathLengthToLong: 100,
-        longDecoding: 100,
-        traversalDetected: 60,
-    },
-
-    // ─── Checkers (set enable: false to disable any individual checker) ─────────
-    checkers: {
-
-        localeMapsCheck: {
-            enable: true,
-            penalties: {
-                ipAndHeaderMismatch: 20,
-                missingHeader: 20,
-                missingGeoData: 20,
-                malformedHeader: 30,
-            },
-        },
-
-        knownBadUserAgents: {
-            enable: true,
-            penalties: {
-                criticalSeverity: 100,
-                highSeverity: 80,
-                mediumSeverity: 30,
-                lowSeverity: 10,
-            },
-        },
-
-        enableIpChecks: {
-            enable: true,
-            penalties: 10,
-        },
-
-        enableGoodBotsChecks: {
-            enable: true,
-            banUnlistedBots: true,
-            penalties: 100,
-        },
-
-        enableBehaviorRateCheck: {
-            enable: true,
-            behavioral_window: 60_000,
-            behavioral_threshold: 30,
-            penalties: 60,
-        },
-
-        enableProxyIspCookiesChecks: {
-            enable: true,
-            penalties: {
-                cookieMissing: 80,
-                proxyDetected: 40,
-                multiSourceBonus2to3: 10,
-                multiSourceBonus4plus: 20,
-                hostingDetected: 50,
-                ispUnknown: 10,
-                orgUnknown: 10,
-            },
-        },
-
-        enableUaAndHeaderChecks: {
-            enable: true,
-            penalties: {
-                headlessBrowser: 100,
-                shortUserAgent: 80,
-                tlsCheckFailed: 60,
-                badUaChecker: true,
-            },
-        },
-
-        enableBrowserAndDeviceChecks: {
-            enable: true,
-            penalties: {
-                cliOrLibrary: 100,
-                internetExplorer: 100,
-                linuxOs: 10,
-                impossibleBrowserCombinations: 30,
-                browserTypeUnknown: 10,
-                browserNameUnknown: 10,
-                desktopWithoutOS: 10,
-                deviceVendorUnknown: 10,
-                browserVersionUnknown: 10,
-                deviceModelUnknown: 5,
-            },
-        },
-
-        enableGeoChecks: {
-            enable: true,
-            bannedCountries: [],
-            penalties: {
-                countryUnknown: 10,
-                regionUnknown: 10,
-                latLonUnknown: 10,
-                districtUnknown: 10,
-                cityUnknown: 10,
-                timezoneUnknown: 10,
-                subregionUnknown: 10,
-                phoneUnknown: 10,
-                continentUnknown: 10,
-            },
-        },
-
-        enableKnownThreatsDetections: {
-            enable: true,
-            penalties: {
-                anonymiseNetwork: 20,
-                threatLevels: {
-                    criticalLevel1: 40,
-                    currentAttacksLevel2: 30,
-                    threatLevel3: 20,
-                    threatLevel4: 10,
-                },
-            },
-        },
-
-        enableAsnClassification: {
-            enable: true,
-            penalties: {
-                contentClassification: 20,
-                unknownClassification: 10,
-                lowVisibilityPenalty: 10,
-                lowVisibilityThreshold: 15,
-                comboHostingLowVisibility: 20,
-            },
-        },
-
-        enableTorAnalysis: {
-            enable: true,
-            penalties: {
-                runningNode: 15,
-                exitNode: 20,
-                webExitCapable: 15,
-                guardNode: 10,
-                badExit: 40,
-                obsoleteVersion: 10,
-            },
-        },
-
-        enableTimezoneConsistency: {
-            enable: true,
-            penalties: 20,
-        },
-
-        honeypot: {
-            enable: true,
-            paths: ['/.env', '/wp-admin', '/wp-login.php', '/.git/config', '/phpinfo.php'],
-        },
-
-        enableSessionCoherence: {
-            enable: true,
-            penalties: {
-                pathMismatch: 10,
-                missingReferer: 20,
-                domainMismatch: 30,
-            },
-        },
-
-        enableVelocityFingerprint: {
-            enable: true,
-            cvThreshold: 0.1,
-            penalties: 40,
-        },
-
-        enableKnownBadIpsCheck: {
-            enable: true,
-            highRiskPenalty: 30,
-        },
-    },
-});
-`;

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-    "extends": "../tsconfig.json",
-    "compilerOptions": {
-        "outDir": "./dist",
-        "baseUrl": ".",
-        "paths": {}
-    },
-    "include": ["src/**/*"],
-    "exclude": ["node_modules"]
-}

package/tsdown.config.ts

@@ -1,10 +0,0 @@
-import { defineConfig } from 'tsdown';
-
-export default defineConfig({
-    entry: ['./src/create.ts'],
-    format: ['esm'],
-    target: 'node18',
-    dts: false,
-    clean: true,
-    sourcemap: false,
-});