@hexabot-ai/api 3.0.0-alpha.3

package/README.md

@@ -0,0 +1,97 @@
+# Hexabot API
+
+[Hexabot](https://hexabot.ai/)'s API is a RESTful API built with NestJS, designed to handle requests from both the UI admin panel and various communication channels. The API powers core functionalities such as chatbot management, message flow, NLU (Natural Language Understanding), and plugin integrations.
+
+## Key Features
+
+- **RESTful Architecture:** Simple, standardized API architecture following REST principles.
+- **Multi-Channel Support:** Handles requests from different communication channels (e.g., web, mobile).
+- **Modular Design:** Organized into multiple modules for better scalability and maintainability.
+- **Real-Time Communication:** Integrates WebSocket support for real-time features.
+
+## API Modules
+
+The API is divided into several key modules, each responsible for specific functionalities:
+
+### Core Modules
+
+- **Analytics:** Tracks and serves analytics data such as the number of messages exchanged and end-user retention statistics.
+- **Attachment:** Manages file uploads and downloads, enabling attachment handling across the chatbot.
+- **Channel:** Manages different communication channels through which the chatbot operates (e.g., web, mobile apps, etc.).
+- **Chat:** The core module for handling incoming channel requests and managing the chat flow as defined by the visual editor in the UI.
+- **Knowledge Base:** Content management module for defining content types, managing content, and configuring menus for chatbot interactions.
+- **NLU:** Manages NLU (Natural Language Understanding) entities such as intents, languages, and values used to detect and process user inputs intelligently.
+- **Plugins:** Manages extensions and plugins that integrate additional features and functionalities into the chatbot.
+- **User:** Manages user authentication, roles, and permissions, ensuring secure access to different parts of the system.
+- **Extensions:** A container for all types of extensions (channels, plugins, helpers) that can be added to expand the chatbot's functionality.
+- **Settings:** A module for management all types of settings that can be adjusted to customize the chatbot.
+
+### Utility Modules
+
+- **WebSocket:** Adds support for Websicket with Socket.IO, enabling real-time communication for events like live chat and user interactions.
+- **Logger:** Provides logging functionality to track and debug API requests and events.
+
+## Installation
+
+```bash
+$ pnpm install
+```
+
+## Development Commands
+
+Run all commands from the repository root so PNPM can resolve workspace dependencies:
+
+```bash
+pnpm --filter @hexabot-ai/api run dev          # start the API with watch mode
+pnpm --filter @hexabot-ai/api run start:debug  # run with inspector attached
+pnpm --filter @hexabot-ai/api run start:prod   # run the compiled build
+```
+
+### Testing
+
+```bash
+pnpm --filter @hexabot-ai/api run test      # unit tests
+pnpm --filter @hexabot-ai/api run test:e2e  # end-to-end tests
+pnpm --filter @hexabot-ai/api run test:cov  # collect coverage
+```
+
+## Migrations
+
+Hexabot includes a migration module to help manage database schema and data changes over time. Migrations allows us to apply or revert changes to the database and keep it in sync with the version release.
+
+Check the Migration README file for more : [Migration Module](./src/migration/README.md)
+
+## Documentation
+
+Access the Swagger API documentation by visiting the API url `/docs` once run it in development mode.
+
+It's also possible to access the API reference documentation by running `pnpm --filter @hexabot-ai/api run doc`.
+
+For detailed information about the API routes and usage, refer to the API documentation or visit [https://docs.hexabot.ai](https://docs.hexabot.ai).
+
+## Contributing
+
+We welcome contributions from the community! Whether you want to report a bug, suggest new features, or submit a pull request, your input is valuable to us.
+
+Feel free to join us on [Discord](https://discord.gg/rNb9t2MFkG)
+
+
+## License
+
+Copyright (c) 2025 Hexastack.
+
+This project is licensed under the **Fair Core License, Version 1.0**, with **Apache License 2.0** as the future license (abbrev. **FCL-1.0-ALv2**).
+
+**Change date.** For each version of the software, the Fair Core License converts to Apache-2.0 on the **second anniversary** of the date that version is made available.
+
+**Commercial features & license keys.** Certain features of Hexabot are protected by license-key checks. You **must not** remove, modify, disable, or circumvent those checks, nor enable access to protected functionality without a valid license key.
+
+**Competing uses (non-compete).** Use that competes with Hexastack’s business—for example, offering Hexabot (or a substantially similar service) as a hosted or commercial product—is not permitted until the conversion to Apache-2.0 for the applicable version.
+
+**Redistribution.** If you distribute copies, modifications, or derivatives, you must include this license and not remove copyright or proprietary notices.
+
+**Patents.** A limited patent license is granted for permitted uses and terminates on patent aggression.
+
+**Trademarks.** “Hexabot” and “Hexastack” are trademarks. Except to identify Hexastack as the origin of the software, no trademark rights are granted.
+
+**Disclaimer.** The software is provided “AS IS,” without warranties or conditions of any kind, and Hexastack will not be liable for any damages arising from its use.

package/dist/analytics/analytics.module.d.ts

@@ -0,0 +1,2 @@
+export declare class AnalyticsModule {
+}

package/dist/analytics/analytics.module.js

@@ -0,0 +1,26 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnalyticsModule = void 0;
+const common_1 = require("@nestjs/common");
+const typeorm_1 = require("@nestjs/typeorm");
+const bot_stats_controller_1 = require("./controllers/bot-stats.controller");
+const bot_stats_entity_1 = require("./entities/bot-stats.entity");
+const bot_stats_repository_1 = require("./repositories/bot-stats.repository");
+const bot_stats_service_1 = require("./services/bot-stats.service");
+let AnalyticsModule = class AnalyticsModule {
+};
+exports.AnalyticsModule = AnalyticsModule;
+exports.AnalyticsModule = AnalyticsModule = __decorate([
+    (0, common_1.Module)({
+        imports: [typeorm_1.TypeOrmModule.forFeature([bot_stats_entity_1.BotStatsOrmEntity])],
+        controllers: [bot_stats_controller_1.BotStatsController],
+        providers: [bot_stats_service_1.BotStatsService, bot_stats_repository_1.BotStatsRepository],
+    })
+], AnalyticsModule);
+//# sourceMappingURL=analytics.module.js.map

package/dist/analytics/analytics.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.module.js","sourceRoot":"","sources":["../../src/analytics/analytics.module.ts"],"names":[],"mappings":";;;;;;;;;AAMA,2CAAwC;AACxC,6CAAgD;AAEhD,6EAAwE;AACxE,kEAAgE;AAChE,8EAAyE;AACzE,oEAA+D;AAOxD,IAAM,eAAe,GAArB,MAAM,eAAe;CAAG,CAAA;AAAlB,0CAAe;0BAAf,eAAe;IAL3B,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,uBAAa,CAAC,UAAU,CAAC,CAAC,oCAAiB,CAAC,CAAC,CAAC;QACxD,WAAW,EAAE,CAAC,yCAAkB,CAAC;QACjC,SAAS,EAAE,CAAC,mCAAe,EAAE,yCAAkB,CAAC;KACjD,CAAC;GACW,eAAe,CAAG"}

package/dist/analytics/controllers/bot-stats.controller.d.ts

@@ -0,0 +1,17 @@
+import { BaseOrmController } from '@/utils/generics/base-orm.controller';
+import { BotStatsActionDto, BotStatsFindDatumDto, BotStatsFindDto, BotStatsTransformerDto } from '../dto/bot-stats.dto';
+import { BotStatsOrmEntity, ToLinesType } from '../entities/bot-stats.entity';
+import { BotStatsService } from '../services/bot-stats.service';
+export declare class BotStatsController extends BaseOrmController<BotStatsOrmEntity, BotStatsTransformerDto, BotStatsActionDto> {
+    protected readonly botStatsService: BotStatsService;
+    constructor(botStatsService: BotStatsService);
+    findMessages(dto: BotStatsFindDto): Promise<ToLinesType[]>;
+    datum(dto: BotStatsFindDatumDto): Promise<ToLinesType[]>;
+    conversation(dto: BotStatsFindDto): Promise<ToLinesType[]>;
+    audiance(dto: BotStatsFindDto): Promise<ToLinesType[]>;
+    popularBlocks(dto: BotStatsFindDto): Promise<{
+        id: string;
+        name: string;
+        value: number;
+    }[]>;
+}

package/dist/analytics/controllers/bot-stats.controller.js

@@ -0,0 +1,107 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BotStatsController = void 0;
+const common_1 = require("@nestjs/common");
+const base_orm_controller_1 = require("../../utils/generics/base-orm.controller");
+const bot_stats_dto_1 = require("../dto/bot-stats.dto");
+const bot_stats_entity_1 = require("../entities/bot-stats.entity");
+const bot_stats_service_1 = require("../services/bot-stats.service");
+const utilities_1 = require("../utilities");
+let BotStatsController = class BotStatsController extends base_orm_controller_1.BaseOrmController {
+    constructor(botStatsService) {
+        super(botStatsService);
+        this.botStatsService = botStatsService;
+    }
+    async findMessages(dto) {
+        const { from = (0, utilities_1.aMonthAgo)(), to = new Date() } = dto;
+        const types = [
+            bot_stats_entity_1.BotStatsType.all_messages,
+            bot_stats_entity_1.BotStatsType.incoming,
+            bot_stats_entity_1.BotStatsType.outgoing,
+        ];
+        const result = await this.botStatsService.findMessages(from, to, types);
+        return bot_stats_entity_1.BotStatsOrmEntity.toLines(result, types);
+    }
+    async datum(dto) {
+        const { from = (0, utilities_1.aMonthAgo)(), to = new Date(), type } = dto;
+        const result = await this.botStatsService.findMessages(from, to, [type]);
+        return bot_stats_entity_1.BotStatsOrmEntity.toLines(result, [type]);
+    }
+    async conversation(dto) {
+        const { from = (0, utilities_1.aMonthAgo)(), to = new Date() } = dto;
+        const types = [
+            bot_stats_entity_1.BotStatsType.new_conversations,
+            bot_stats_entity_1.BotStatsType.existing_conversations,
+        ];
+        const result = await this.botStatsService.findMessages(from, to, types);
+        return bot_stats_entity_1.BotStatsOrmEntity.toLines(result, types);
+    }
+    async audiance(dto) {
+        const { from = (0, utilities_1.aMonthAgo)(), to = new Date() } = dto;
+        const types = [
+            bot_stats_entity_1.BotStatsType.new_users,
+            bot_stats_entity_1.BotStatsType.returning_users,
+            bot_stats_entity_1.BotStatsType.retention,
+        ];
+        const result = await this.botStatsService.findMessages(from, to, types);
+        return bot_stats_entity_1.BotStatsOrmEntity.toLines(result, types);
+    }
+    async popularBlocks(dto) {
+        const { from = (0, utilities_1.aMonthAgo)(), to = new Date() } = dto;
+        const results = await this.botStatsService.findPopularBlocks(from, to);
+        return bot_stats_entity_1.BotStatsOrmEntity.toBars(results);
+    }
+};
+exports.BotStatsController = BotStatsController;
+__decorate([
+    (0, common_1.Get)('messages'),
+    __param(0, (0, common_1.Query)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [bot_stats_dto_1.BotStatsFindDto]),
+    __metadata("design:returntype", Promise)
+], BotStatsController.prototype, "findMessages", null);
+__decorate([
+    (0, common_1.Get)('datum'),
+    __param(0, (0, common_1.Query)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [bot_stats_dto_1.BotStatsFindDatumDto]),
+    __metadata("design:returntype", Promise)
+], BotStatsController.prototype, "datum", null);
+__decorate([
+    (0, common_1.Get)('conversation'),
+    __param(0, (0, common_1.Query)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [bot_stats_dto_1.BotStatsFindDto]),
+    __metadata("design:returntype", Promise)
+], BotStatsController.prototype, "conversation", null);
+__decorate([
+    (0, common_1.Get)('audiance'),
+    __param(0, (0, common_1.Query)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [bot_stats_dto_1.BotStatsFindDto]),
+    __metadata("design:returntype", Promise)
+], BotStatsController.prototype, "audiance", null);
+__decorate([
+    (0, common_1.Get)('popularBlocks'),
+    __param(0, (0, common_1.Query)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [bot_stats_dto_1.BotStatsFindDto]),
+    __metadata("design:returntype", Promise)
+], BotStatsController.prototype, "popularBlocks", null);
+exports.BotStatsController = BotStatsController = __decorate([
+    (0, common_1.Controller)('botstats'),
+    __metadata("design:paramtypes", [bot_stats_service_1.BotStatsService])
+], BotStatsController);
+//# sourceMappingURL=bot-stats.controller.js.map

package/dist/analytics/controllers/bot-stats.controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bot-stats.controller.js","sourceRoot":"","sources":["../../../src/analytics/controllers/bot-stats.controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAMA,2CAAwD;AAExD,kFAAyE;AAEzE,wDAK8B;AAC9B,mEAIsC;AACtC,qEAAgE;AAChE,4CAAyC;AAGlC,IAAM,kBAAkB,GAAxB,MAAM,kBAAmB,SAAQ,uCAIvC;IACC,YAA+B,eAAgC;QAC7D,KAAK,CAAC,eAAe,CAAC,CAAC;QADM,oBAAe,GAAf,eAAe,CAAiB;IAE/D,CAAC;IASK,AAAN,KAAK,CAAC,YAAY,CAEhB,GAAoB;QAEpB,MAAM,EAAE,IAAI,GAAG,IAAA,qBAAS,GAAE,EAAE,EAAE,GAAG,IAAI,IAAI,EAAE,EAAE,GAAG,GAAG,CAAC;QACpD,MAAM,KAAK,GAAmB;YAC5B,+BAAY,CAAC,YAAY;YACzB,+BAAY,CAAC,QAAQ;YACrB,+BAAY,CAAC,QAAQ;SACtB,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;QAExE,OAAO,oCAAiB,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IASK,AAAN,KAAK,CAAC,KAAK,CAET,GAAyB;QAEzB,MAAM,EAAE,IAAI,GAAG,IAAA,qBAAS,GAAE,EAAE,EAAE,GAAG,IAAI,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC;QAC1D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAEzE,OAAO,oCAAiB,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IACnD,CAAC;IASK,AAAN,KAAK,CAAC,YAAY,CAEhB,GAAoB;QAEpB,MAAM,EAAE,IAAI,GAAG,IAAA,qBAAS,GAAE,EAAE,EAAE,GAAG,IAAI,IAAI,EAAE,EAAE,GAAG,GAAG,CAAC;QACpD,MAAM,KAAK,GAAmB;YAC5B,+BAAY,CAAC,iBAAiB;YAC9B,+BAAY,CAAC,sBAAsB;SACpC,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;QAExE,OAAO,oCAAiB,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IASK,AAAN,KAAK,CAAC,QAAQ,CAEZ,GAAoB;QAEpB,MAAM,EAAE,IAAI,GAAG,IAAA,qBAAS,GAAE,EAAE,EAAE,GAAG,IAAI,IAAI,EAAE,EAAE,GAAG,GAAG,CAAC;QACpD,MAAM,KAAK,GAAmB;YAC5B,+BAAY,CAAC,SAAS;YACtB,+BAAY,CAAC,eAAe;YAC5B,+BAAY,CAAC,SAAS;SACvB,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;QAExE,OAAO,oCAAiB,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IASK,AAAN,KAAK,CAAC,aAAa,CAEjB,GAAoB;QAEpB,MAAM,EAAE,IAAI,GAAG,IAAA,qBAAS,GAAE,EAAE,EAAE,GAAG,IAAI,IAAI,EAAE,EAAE,GAAG,GAAG,CAAC;QACpD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAEvE,OAAO,oCAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;CACF,CAAA;AA3GY,gDAAkB;AAgBvB;IADL,IAAA,YAAG,EAAC,UAAU,CAAC;IAEb,WAAA,IAAA,cAAK,GAAE,CAAA;;qCACH,+BAAe;;sDAWrB;AASK;IADL,IAAA,YAAG,EAAC,OAAO,CAAC;IAEV,WAAA,IAAA,cAAK,GAAE,CAAA;;qCACH,oCAAoB;;+CAM1B;AASK;IADL,IAAA,YAAG,EAAC,cAAc,CAAC;IAEjB,WAAA,IAAA,cAAK,GAAE,CAAA;;qCACH,+BAAe;;sDAUrB;AASK;IADL,IAAA,YAAG,EAAC,UAAU,CAAC;IAEb,WAAA,IAAA,cAAK,GAAE,CAAA;;qCACH,+BAAe;;kDAWrB;AASK;IADL,IAAA,YAAG,EAAC,eAAe,CAAC;IAElB,WAAA,IAAA,cAAK,GAAE,CAAA;;qCACH,+BAAe;;uDAMrB;6BA1GU,kBAAkB;IAD9B,IAAA,mBAAU,EAAC,UAAU,CAAC;qCAM2B,mCAAe;GALpD,kBAAkB,CA2G9B"}

package/dist/analytics/dto/bot-stats.dto.d.ts

@@ -0,0 +1,35 @@
+import { BaseStub, DtoActionConfig, DtoTransformerConfig } from '@/utils/types/dto.types';
+import { BotStatsType } from '../entities/bot-stats.entity';
+export declare class BotStatsStub extends BaseStub {
+    type: BotStatsType;
+    day: Date;
+    value: number;
+    name: string;
+}
+export declare class BotStats extends BotStatsStub {
+}
+export declare class BotStatsCreateDto {
+    type: BotStatsType;
+    day: Date;
+    value: number;
+    name: string;
+}
+declare const BotStatsUpdateDto_base: import("@nestjs/mapped-types").MappedType<Partial<BotStatsCreateDto>>;
+export declare class BotStatsUpdateDto extends BotStatsUpdateDto_base {
+}
+export type BotStatsTransformerDto = DtoTransformerConfig<{
+    PlainCls: typeof BotStats;
+    FullCls: typeof BotStats;
+}>;
+export type BotStatsActionDto = DtoActionConfig<{
+    create: BotStatsCreateDto;
+    update: BotStatsUpdateDto;
+}>;
+export declare class BotStatsFindDto {
+    from?: Date;
+    to?: Date;
+}
+export declare class BotStatsFindDatumDto extends BotStatsFindDto {
+    type: BotStatsType;
+}
+export {};

package/dist/analytics/dto/bot-stats.dto.js

@@ -0,0 +1,112 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BotStatsFindDatumDto = exports.BotStatsFindDto = exports.BotStatsUpdateDto = exports.BotStatsCreateDto = exports.BotStats = exports.BotStatsStub = void 0;
+const mapped_types_1 = require("@nestjs/mapped-types");
+const swagger_1 = require("@nestjs/swagger");
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+const dto_types_1 = require("../../utils/types/dto.types");
+const bot_stats_entity_1 = require("../entities/bot-stats.entity");
+const is_less_than_date_1 = require("../validation-rules/is-less-than-date");
+let BotStatsStub = class BotStatsStub extends dto_types_1.BaseStub {
+};
+exports.BotStatsStub = BotStatsStub;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], BotStatsStub.prototype, "type", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_transformer_1.Type)(() => Date),
+    __metadata("design:type", Date)
+], BotStatsStub.prototype, "day", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], BotStatsStub.prototype, "value", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], BotStatsStub.prototype, "name", void 0);
+exports.BotStatsStub = BotStatsStub = __decorate([
+    (0, class_transformer_1.Exclude)()
+], BotStatsStub);
+let BotStats = class BotStats extends BotStatsStub {
+};
+exports.BotStats = BotStats;
+exports.BotStats = BotStats = __decorate([
+    (0, class_transformer_1.Exclude)()
+], BotStats);
+class BotStatsCreateDto {
+}
+exports.BotStatsCreateDto = BotStatsCreateDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Bot statistic type', enum: bot_stats_entity_1.BotStatsType }),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], BotStatsCreateDto.prototype, "type", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Aggregation day of the statistic',
+        type: String,
+        format: 'date-time',
+    }),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", Date)
+], BotStatsCreateDto.prototype, "day", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Aggregated value of the statistic',
+        type: Number,
+    }),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.IsNumber)(),
+    __metadata("design:type", Number)
+], BotStatsCreateDto.prototype, "value", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Display name of the statistic', type: String }),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], BotStatsCreateDto.prototype, "name", void 0);
+class BotStatsUpdateDto extends (0, mapped_types_1.PartialType)(BotStatsCreateDto) {
+}
+exports.BotStatsUpdateDto = BotStatsUpdateDto;
+class BotStatsFindDto {
+}
+exports.BotStatsFindDto = BotStatsFindDto;
+__decorate([
+    (0, class_validator_1.IsDate)(),
+    (0, class_transformer_1.Type)(() => Date),
+    (0, class_validator_1.IsOptional)(),
+    (0, is_less_than_date_1.IsLessThanDate)('to', {
+        message: 'From date must be less than or equal to To date',
+    }),
+    __metadata("design:type", Date)
+], BotStatsFindDto.prototype, "from", void 0);
+__decorate([
+    (0, class_validator_1.IsDate)(),
+    (0, class_transformer_1.Type)(() => Date),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Date)
+], BotStatsFindDto.prototype, "to", void 0);
+class BotStatsFindDatumDto extends BotStatsFindDto {
+}
+exports.BotStatsFindDatumDto = BotStatsFindDatumDto;
+__decorate([
+    (0, class_validator_1.IsEnum)(bot_stats_entity_1.BotStatsType),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], BotStatsFindDatumDto.prototype, "type", void 0);
+//# sourceMappingURL=bot-stats.dto.js.map

package/dist/analytics/dto/bot-stats.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bot-stats.dto.js","sourceRoot":"","sources":["../../../src/analytics/dto/bot-stats.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAMA,uDAAmD;AACnD,6CAA8C;AAC9C,yDAA0D;AAC1D,qDAOyB;AAEzB,2DAIiC;AAEjC,mEAA4D;AAC5D,6EAAuE;AAGhE,IAAM,YAAY,GAAlB,MAAM,YAAa,SAAQ,oBAAQ;CAazC,CAAA;AAbY,oCAAY;AAEvB;IADC,IAAA,0BAAM,GAAE;;0CACW;AAIpB;IAFC,IAAA,0BAAM,GAAE;IACR,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC;8BACX,IAAI;yCAAC;AAGX;IADC,IAAA,0BAAM,GAAE;;2CACM;AAGf;IADC,IAAA,0BAAM,GAAE;;0CACK;uBAZH,YAAY;IADxB,IAAA,2BAAO,GAAE;GACG,YAAY,CAaxB;AAGM,IAAM,QAAQ,GAAd,MAAM,QAAS,SAAQ,YAAY;CAAG,CAAA;AAAhC,4BAAQ;mBAAR,QAAQ;IADpB,IAAA,2BAAO,GAAE;GACG,QAAQ,CAAwB;AAE7C,MAAa,iBAAiB;CA2B7B;AA3BD,8CA2BC;AAvBC;IAHC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,oBAAoB,EAAE,IAAI,EAAE,+BAAY,EAAE,CAAC;IACtE,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;;+CACQ;AASnB;IAPC,IAAA,qBAAW,EAAC;QACX,WAAW,EAAE,kCAAkC;QAC/C,IAAI,EAAE,MAAM;QACZ,MAAM,EAAE,WAAW;KACpB,CAAC;IACD,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;8BACR,IAAI;8CAAC;AAQV;IANC,IAAA,qBAAW,EAAC;QACX,WAAW,EAAE,mCAAmC;QAChD,IAAI,EAAE,MAAM;KACb,CAAC;IACD,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;;gDACG;AAKd;IAHC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,+BAA+B,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC3E,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;+CACA;AAGf,MAAa,iBAAkB,SAAQ,IAAA,0BAAW,EAAC,iBAAiB,CAAC;CAAG;AAAxE,8CAAwE;AAYxE,MAAa,eAAe;CAmB3B;AAnBD,0CAmBC;AATC;IANC,IAAA,wBAAM,GAAE;IACR,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC;IAChB,IAAA,4BAAU,GAAE;IACZ,IAAA,kCAAc,EAAC,IAAI,EAAE;QACpB,OAAO,EAAE,iDAAiD;KAC3D,CAAC;8BACK,IAAI;6CAAC;AAQZ;IAHC,IAAA,wBAAM,GAAE;IACR,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC;IAChB,IAAA,4BAAU,GAAE;8BACR,IAAI;2CAAC;AAGZ,MAAa,oBAAqB,SAAQ,eAAe;CAOxD;AAPD,oDAOC;AADC;IAFC,IAAA,wBAAM,EAAC,+BAAY,CAAC;IACpB,IAAA,4BAAU,GAAE;;kDACM"}

package/dist/analytics/entities/bot-stats.entity.d.ts

@@ -0,0 +1,33 @@
+import { BaseOrmEntity } from '@/database/entities/base.entity';
+export declare enum BotStatsType {
+    outgoing = "outgoing",
+    new_users = "new_users",
+    all_messages = "all_messages",
+    incoming = "incoming",
+    existing_conversations = "existing_conversations",
+    popular = "popular",
+    new_conversations = "new_conversations",
+    returning_users = "returning_users",
+    retention = "retention",
+    echo = "echo"
+}
+export type ToLinesType = {
+    id: number;
+    name: BotStatsType;
+    values: any[];
+};
+export declare class BotStatsOrmEntity extends BaseOrmEntity {
+    type: BotStatsType;
+    day: Date;
+    value: number;
+    name: string;
+    static toLines(stats: BotStatsOrmEntity[], types: BotStatsType[]): ToLinesType[];
+    static toBars(stats: {
+        id: string;
+        value: number;
+    }[]): {
+        id: string;
+        name: string;
+        value: number;
+    }[];
+}

package/dist/analytics/entities/bot-stats.entity.js

@@ -0,0 +1,80 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BotStatsOrmEntity = exports.BotStatsType = void 0;
+const typeorm_1 = require("typeorm");
+const datetime_column_decorator_1 = require("../../database/decorators/datetime-column.decorator");
+const enum_column_decorator_1 = require("../../database/decorators/enum-column.decorator");
+const base_entity_1 = require("../../database/entities/base.entity");
+var BotStatsType;
+(function (BotStatsType) {
+    BotStatsType["outgoing"] = "outgoing";
+    BotStatsType["new_users"] = "new_users";
+    BotStatsType["all_messages"] = "all_messages";
+    BotStatsType["incoming"] = "incoming";
+    BotStatsType["existing_conversations"] = "existing_conversations";
+    BotStatsType["popular"] = "popular";
+    BotStatsType["new_conversations"] = "new_conversations";
+    BotStatsType["returning_users"] = "returning_users";
+    BotStatsType["retention"] = "retention";
+    BotStatsType["echo"] = "echo";
+})(BotStatsType || (exports.BotStatsType = BotStatsType = {}));
+let BotStatsOrmEntity = class BotStatsOrmEntity extends base_entity_1.BaseOrmEntity {
+    static toLines(stats, types) {
+        const data = types.map((type, index) => {
+            return {
+                id: index + 1,
+                name: type,
+                values: [],
+            };
+        });
+        const index = data.reduce((acc, curr, i) => {
+            acc[curr.name] = i;
+            return acc;
+        }, {});
+        const result = stats.reduce((acc, stat) => {
+            stat.date = stat.day;
+            acc[index[stat.type]].values.push(stat);
+            return acc;
+        }, data);
+        return result;
+    }
+    static toBars(stats) {
+        return stats.map((stat) => {
+            return {
+                ...stat,
+                name: stat.id,
+            };
+        });
+    }
+};
+exports.BotStatsOrmEntity = BotStatsOrmEntity;
+__decorate([
+    (0, enum_column_decorator_1.EnumColumn)({ enum: BotStatsType }),
+    __metadata("design:type", String)
+], BotStatsOrmEntity.prototype, "type", void 0);
+__decorate([
+    (0, datetime_column_decorator_1.DatetimeColumn)(),
+    __metadata("design:type", Date)
+], BotStatsOrmEntity.prototype, "day", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ default: 0 }),
+    __metadata("design:type", Number)
+], BotStatsOrmEntity.prototype, "value", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], BotStatsOrmEntity.prototype, "name", void 0);
+exports.BotStatsOrmEntity = BotStatsOrmEntity = __decorate([
+    (0, typeorm_1.Entity)({ name: 'bot_stats' }),
+    (0, typeorm_1.Index)(['day', 'type', 'name'], { unique: true })
+], BotStatsOrmEntity);
+//# sourceMappingURL=bot-stats.entity.js.map

package/dist/analytics/entities/bot-stats.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bot-stats.entity.js","sourceRoot":"","sources":["../../../src/analytics/entities/bot-stats.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAMA,qCAAgD;AAEhD,mGAAiF;AACjF,2FAAyE;AACzE,qEAAgE;AAEhE,IAAY,YAWX;AAXD,WAAY,YAAY;IACtB,qCAAqB,CAAA;IACrB,uCAAuB,CAAA;IACvB,6CAA6B,CAAA;IAC7B,qCAAqB,CAAA;IACrB,iEAAiD,CAAA;IACjD,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,mDAAmC,CAAA;IACnC,uCAAuB,CAAA;IACvB,6BAAa,CAAA;AACf,CAAC,EAXW,YAAY,4BAAZ,YAAY,QAWvB;AAUM,IAAM,iBAAiB,GAAvB,MAAM,iBAAkB,SAAQ,2BAAa;IAgClD,MAAM,CAAC,OAAO,CACZ,KAA0B,EAC1B,KAAqB;QAErB,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YACrC,OAAO;gBACL,EAAE,EAAE,KAAK,GAAG,CAAC;gBACb,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,EAAE;aACI,CAAC;QACnB,CAAC,CAAC,CAAC;QACH,MAAM,KAAK,GAAmC,IAAI,CAAC,MAAM,CACvD,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE;YACf,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAEnB,OAAO,GAAG,CAAC;QACb,CAAC,EACD,EAAE,CACH,CAAC;QACF,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CACzB,CAAC,GAAG,EAAE,IAAwC,EAAE,EAAE;YAChD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC;YACrB,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAExC,OAAO,GAAG,CAAC;QACb,CAAC,EACD,IAAI,CACL,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;IAQD,MAAM,CAAC,MAAM,CACX,KAAsC;QAEtC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACxB,OAAO;gBACL,GAAG,IAAI;gBACP,IAAI,EAAE,IAAI,CAAC,EAAE;aACd,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAA;AAhFY,8CAAiB;AAK5B;IADC,IAAA,kCAAU,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;;+CACf;AAMpB;IADC,IAAA,0CAAc,GAAE;8BACX,IAAI;8CAAC;AAMX;IADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;;gDACR;AAMf;IADC,IAAA,gBAAM,GAAE;;+CACK;4BAvBH,iBAAiB;IAF7B,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;IAC7B,IAAA,eAAK,EAAC,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;GACpC,iBAAiB,CAgF7B"}

package/dist/analytics/index.d.ts

@@ -0,0 +1,8 @@
+export * from './analytics.module';
+export * from './controllers/bot-stats.controller';
+export * from './dto/bot-stats.dto';
+export * from './entities/bot-stats.entity';
+export * from './repositories/bot-stats.repository';
+export * from './services/bot-stats.service';
+export * from './utilities/index';
+export * from './validation-rules/is-less-than-date';

package/dist/analytics/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./analytics.module"), exports);
+__exportStar(require("./controllers/bot-stats.controller"), exports);
+__exportStar(require("./dto/bot-stats.dto"), exports);
+__exportStar(require("./entities/bot-stats.entity"), exports);
+__exportStar(require("./repositories/bot-stats.repository"), exports);
+__exportStar(require("./services/bot-stats.service"), exports);
+__exportStar(require("./utilities/index"), exports);
+__exportStar(require("./validation-rules/is-less-than-date"), exports);
+//# sourceMappingURL=index.js.map

package/dist/analytics/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/analytics/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAMA,qDAAmC;AAEnC,qEAAmD;AAEnD,sDAAoC;AAEpC,8DAA4C;AAE5C,sEAAoD;AAEpD,+DAA6C;AAE7C,oDAAkC;AAElC,uEAAqD"}

package/dist/analytics/repositories/bot-stats.repository.d.ts

@@ -0,0 +1,12 @@
+import { Repository } from 'typeorm';
+import { BaseOrmRepository } from '@/utils/generics/base-orm.repository';
+import { BotStatsActionDto, BotStatsTransformerDto } from '../dto/bot-stats.dto';
+import { BotStatsOrmEntity, BotStatsType } from '../entities/bot-stats.entity';
+export declare class BotStatsRepository extends BaseOrmRepository<BotStatsOrmEntity, BotStatsTransformerDto, BotStatsActionDto> {
+    constructor(repository: Repository<BotStatsOrmEntity>);
+    findMessages(from: Date, to: Date, types: BotStatsType[]): Promise<BotStatsOrmEntity[]>;
+    findPopularBlocks(from: Date, to: Date, limit?: number): Promise<{
+        id: string;
+        value: number;
+    }[]>;
+}