![\"Nestjs](\"logo.svg\")
\n\n \n
A Nestjs module to interact seamlessly with Slack API using the Bolt SDK.
\n\n[](https://github.com/prettier/prettier)\n[](#contributors-)\n\n---\n## Table of Contents\n- [Description](#description)\n- [Features](#features)\n- [Installation](#installation)\n- [Setting Up](#setting-up)\n- [Usage](#usage)\n- [Examples](#examples)\n - [Using annotations](#using-annotations)\n - [Handling a message event](#handling-a-message-event) \n - [Handling an action](#handling-an-action)\n - [Handling a command](#handling-a-command)\n - [Handling an event](#handling-an-event)\n - [Handling a shortcut event](#handling-a-shortcut-event)\n - [Using the SlackService](#using-the-slackservice)\n- [To-Do List](#to-do-list)\n- [Contribute & Disclaimer](#contribute--disclaimer)\n- [Contributors](#contributors-)\n\n--- \n\n## Description\n\nThis module gives a handy way to develop Slack applications using the Nestjs framework\n\n## Features\n\nThe Nestjs Slack Bolt module offers the following features to simplify the interaction between your application and Slack API:\n\n- Message Handling\n- Command Handling\n- Action Handling\n- Event Handling\n- Shortcut Handling\n\n---\n## Installation\n\nThe module can be installed using yarn or npm:\n\n```bash\n$ yarn add nestjs-slack-bolt\n```\n\nOR\n\n```bash\n$ npm i nestjs-slack-bolt\n```\n\n---\n\n## Setting Up\n\nAdd these variables to the `.env` file to set up the module:\n\n```bash\n# To define on API mode\nSLACK_SIGNING_SECRET=\"**\"\n\n# To define on Socket mode\nSLACK_APP_TOKEN=\"**\"\n\n# Required variables\nSLACK_BOT_TOKEN=\"**\"\nSLACK_SOCKET_MODE=true\n```\n\n---\n## Usage\n\nTo use the module, import the `SlackModule`:\n\n```typescript\nimport { Module } from '@nestjs/common';\nimport { SlackModule } from 'nestjs-slack-bolt';\nimport { AppController } from './app.controller';\nimport { AppService } from './app.service';\n\n@Module({\n imports: [SlackModule.forRoot()],\n controllers: [AppController],\n providers: [AppService],\n})\nexport class AppModule {}\n```\n\n---\n\n## Examples\n\nHere are a few examples to demonstrate how you can use the Nestjs Slack Bolt module in your application:\n\n### Using annotations\n#### Handling a message event\n```typescript\nimport { Controller } from '@nestjs/common';\nimport { Message } from 'nestjs-slack-bolt';\nimport { SlackEventMiddlewareArgs } from '@slack/bolt';\n\n@Controller()\nexport class AppController {\n @Message('hi')\n message({ say }: SlackEventMiddlewareArgs) {\n say('Hello, I received your message!');\n }\n // Other handlers...\n}\n```\n\n#### Handling an action\n```typescript\nimport { Controller } from '@nestjs/common';\nimport { Action } from 'nestjs-slack-bolt';\nimport { SlackActionMiddlewareArgs } from '@slack/bolt';\n\n@Controller()\nexport class AppController {\n @Action('click')\n action({ say }: SlackActionMiddlewareArgs) {\n say('Click event received, nice job!');\n }\n // Other handlers...\n}\n```\n#### Handling a command\n```typescript\nimport { Controller } from '@nestjs/common';\nimport { Command } from 'nestjs-slack-bolt';\nimport { SlackCommandMiddlewareArgs } from '@slack/bolt';\n\n@Controller()\nexport class AppController {\n @Command('/list')\n command({ say }: SlackCommandMiddlewareArgs) {\n say('The /list command has been received. Processing...');\n }\n // Other handlers...\n}\n```\n#### Handling an event\n```typescript\nimport { Controller } from '@nestjs/common';\nimport { Event } from 'nestjs-slack-bolt';\nimport { SlackEventMiddlewareArgs } from '@slack/bolt';\n\n@Controller()\nexport class AppController {\n @Event('app_home_opened')\n event({ say }: SlackEventMiddlewareArgs) {\n say('The app was just opened!');\n }\n // Other handlers...\n}\n```\n#### Handling a shortcut event\n```typescript\nimport { Controller } from '@nestjs/common';\nimport { Shortcut } from 'nestjs-slack-bolt';\n\n@Controller()\nexport class AppController {\n @Shortcut('test_shortcut')\n async shortcut({ shortcut, ack, client, logger }) {\n try {\n await ack(); //Acknowledge shortcut request\n\n const result = await client.views.open({\n trigger_id: shortcut.trigger_id,\n view: { /* Your view parameters */ }\n });\n\n logger.info(result); // Log the result\n } \n catch (error) {\n logger.error(error); // Log any error\n }\n }\n // Other handlers...\n}\n```\nThese examples demonstrate how to handle different types of interactions in your Slack application using the NestJS Slack Bolt module.\n\n### Using the SlackService\n\n```typescript\nimport { Controller } from '@nestjs/common';\nimport { ConfigService } from '@nestjs/config';\nimport { SlackService } from 'nestjs-slack-bolt/services/slack.service';\nimport { Cron, CronExpression } from '@nestjs/schedule';\nimport { from } from 'rxjs';\n\n@Controller()\nexport class AppController {\n constructor(\n private readonly slackService: SlackService,\n private readonly configService: ConfigService,\n ) {}\n\n @Cron(CronExpression.EVERY_10_SECONDS)\n cronJob() {\n this.searchUsers()\n .pipe()\n .subscribe((users) => {\n console.log(JSON.stringify(users));\n });\n }\n\n searchUsers(cursor?: string) {\n return from(\n this.slackService.client.users.list({\n token: this.configService.get('SLACK_BOT_TOKEN'),\n limit: 1,\n ...(cursor && { cursor }),\n }),\n );\n }\n}\n```\n\n---\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\n\n\n![\"madcam\"/](\"https://avatars.githubusercontent.com/u/7466570?v=4?s=100\") madcam ⚠️ 💻 📖 🐛 | \n ![\"Nadir](\"https://avatars.githubusercontent.com/u/38838675?v=4?s=100\") Nadir Abbas ⚠️ 📖 🐛 💻 | \n