@chatbot-kit/nestjs-chat-integration

NestJS library for integrating applications with Atendimento using standard chat routes.

Installation

npm install @chatbot-kit/nestjs-chat-integration hbs dotenv --save

Publishing

The package is published as a public scoped package on npm.

Prerequisites

• npm account with publish permission for the @chatbot-kit scope
• authenticated npm CLI session

Release flow

1. Update the package version:

npm version patch

Use minor or major instead of patch when appropriate.

2. Confirm the package contents:

npm pack --dry-run

3. Publish to npm:

npm publish --access public

Authentication

npm login
npm whoami

Notes

• prepublishOnly runs npm run build automatically before npm publish
• only compiled files from dist/ are included in the published package
• for the first publish of a scoped public package, --access public is required

Usage

import { Module } from '@nestjs/common'
import {
  ChatIntegrationModule,
  IIntegrationService,
} from '@chatbot-kit/nestjs-chat-integration'

class AppService implements IIntegrationService {
  async execute(methodName: string, env: string, params: any) {
    return { ok: true, data: { methodName, env, params } }
  }

  async renderPage(page: string, env: string, params: any) {
    return { ok: true, page, response: { env, params } }
  }
}

@Module({
  imports: [
    ChatIntegrationModule.forRoot({
      integrationService: AppService,
      appVersion: '1.0.0',
      routePrefix: 'integracao-atendimento',
      jwtSecret: process.env.JWT_SECRET || '',
    }),
  ],
  providers: [AppService],
})
export class AppModule {}

Options

ChatIntegrationModule.forRoot(...) accepts:

• integrationService: service class implementing IIntegrationService
• appVersion: application version returned by the version endpoint
• routePrefix: route prefix used by the generated controller. It must be non-empty and must not contain spaces or repeated slashes.
• jwtSecret: JWT secret used to validate page tokens. It is required and the module throws during bootstrap if it is empty.

Public API

The package exports:

• ChatIntegrationModule
• IIntegrationService
• ChatIntegrationModuleOptions
• ExecuteReqDto
• ExecuteResDto
• PageResDto
• IntegrationHttpService
• HttpCallResult

Generated routes

If routePrefix is integracao-atendimento, the module exposes:

• GET /integracao-atendimento/version
• POST /integracao-atendimento/execute
• GET /integracao-atendimento/:page/:env/:token

Validation

The module validates configuration during bootstrap and throws when:

• jwtSecret is empty
• routePrefix is empty
• routePrefix contains spaces
• routePrefix contains repeated slashes