@riavzon/bot-detector-create 1.0.9 → 1.0.11

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';
 
 /**
@@ -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.9",
+    "version": "1.0.11",
     "type": "module",
     "author": "Sergio contact@riavzon.com",
     "license": "Apache-2.0",

package/src/create.ts

@@ -6,7 +6,7 @@ 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';
+import { content, mainContent, defaultStore } from './default.js';
 
 function run(cmd: string, args: string[]): Promise<void> {
     return new Promise((resolve, reject) => {
@@ -37,6 +37,7 @@ export const start = defineCommand({
         
         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...');
@@ -52,6 +53,7 @@ export 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/src/default.ts

@@ -1,5 +1,21 @@
 export const defaultStore = { main: { driver: 'sqlite' as const, name: './bot_detector.sqlite' } };
 
+export 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);
+`;
+
 export const content = `import { defineConfiguration } from '@riavzon/bot-detector';
 
 /**