NestJS Express
NestJS Express
Install
1
npm i botbye-nest-express
or
1
yarn add botbye-nest-express
Configuration
1. Create options for BotByeModule init that satisfies TBotByeModuleOptions.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
import { TBotByeModuleOptions } from "botbye-nest-express"
const botbyeModuleOptions: TBotByeModuleOptions = {
/* Use your server-key */
serverKey: "00000000-0000-0000-0000-000000000000",
/*
* Function that extracts token from express Request object.
* For example, from "x-botbye-token" header
*/
tokenExtractor: (request) => request.headers["x-botbye-token"],
/*
* Optional function that extracts customFields
* from express Request object
*/
customFieldsExtractor: (request) => ({
example: request.headers['example'],
}),
};
2. Register BotByeModule in Root module imports using botbyeModuleOptions.
1
2
3
4
5
6
7
8
9
10
import { BotByeModule } from "botbye-nest-express"
...
@Module({
imports: [BotByeModule.register(botbyeModuleOptions)],
controllers: [AppController],
providers: [AppService],
})
class AppModule {}
Usage
1. Add BotByeMiddleware.
1
2
3
4
5
6
7
8
9
10
11
12
import { BotByeMiddleware } from "botbye-nest-express"
...
class AppModule {
configure(consumer: MiddlewareConsumer) {
consumer
.apply(BotByeMiddleware)
/* Select routes that should be protected */
.forRoutes('*');
}
}
2. Use @BotByeResponse() decorator in controllers to process request.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
import { BotByeResponse, type TBotByeResponse } from 'botbye-nest-express';
@Controller('some-route')
class SomeController {
@Get()
someGet(@BotByeResponse() botbyeResponse: TBotByeResponse) {
const isAllowed = botbyeResponse.result?.isAllowed ?? true;
if (!isAllowed) {
/*
* When BotBye! not allow request
* throw ForbiddenException, for example
*/
throw new ForbiddenException();
};
/* In other case process request as usual */
return "Some Response"
}
}
Examples of BotBye API responses
Bot detected:
1
2
3
4
5
6
7
{
"reqId": "f77b2abd-c5d7-44f0-be4f-174b04876583",
"result": {
"isAllowed": false
},
"error": "Automation tool used"
}
Bot not detected:
1
2
3
4
5
6
7
{
"reqId": "f77b2abd-c5d7-44f0-be4f-174b04876583",
"result": {
"isAllowed": true
},
"error": null
}
Request banned by custom rule:
1
2
3
4
5
6
7
8
9
{
"reqId": "f77b2abd-c5d7-44f0-be4f-174b04876583",
"result": {
"isAllowed": false
},
"error": {
"message": "Banned by rule: MY_CUSTOM_RULE"
}
}
Invalid server-key:
1
2
3
4
5
6
7
{
"reqId": "f77b2abd-c5d7-44f0-be4f-174b04876583",
"result": null,
"error": {
"message": "[BotBye] Bad Request: Invalid Server Key"
}
}