slack-bolt-fastify
v0.3.1
Published
Bolt for JavaScript Extension - Fastify
Downloads
2,406
Maintainers
Readme
Bolt for JavaScript Fastify Extension
Getting Started
Create a new project
package.json
{
"name": "bolt-fastify-app",
"version": "0.1.0",
"description": "",
"main": "index.js",
"scripts": {
"start": "rm -rf dist/ && tsc && npx ts-node src/index.ts"
},
"author": "Kazuhiro Sera",
"license": "MIT",
"dependencies": {
"@slack/bolt": "^3.11.0",
"fastify": "^3.27.4",
"slack-bolt-fastify": "^0.3.0"
},
"devDependencies": {
"ts-node": "^10.5.0",
"typescript": "^4.5.5"
}
}
tsconfig.json
{
"compilerOptions": {
"emitDecoratorMetadata": true,
"experimentalDecorators": true,
"allowJs": true,
"esModuleInterop": true,
"outDir": "dist",
},
"include": ["src/**/*"]
}
Create a new Slack app at api.slack.com/apps
You can use the following App Manifest configuration for setting up a new app!
display_information:
name: fastify-oauth-test-app
features:
bot_user:
display_name: fastify-oauth-test-app
oauth_config:
redirect_urls:
- https://xxx.ngrok.io/slack/oauth_redirect
scopes:
bot:
- commands
- chat:write
- app_mentions:read
settings:
event_subscriptions:
bot_events:
- app_mention
interactivity:
is_enabled: true
socket_mode_enabled: true
src/app.ts
import Fastify from 'fastify';
import { App, FileInstallationStore, LogLevel } from '@slack/bolt';
import { FileStateStore } from '@slack/oauth';
import { FastifyReceiver } from 'slack-bolt-fastify';
const fastify = Fastify({ logger: true });
fastify.get('/', async (_, res) => {
res.redirect('/slack/install');
});
const receiver = new FastifyReceiver({
signingSecret: process.env.SLACK_SIGNING_SECRET!,
clientId: process.env.SLACK_CLIENT_ID,
clientSecret: process.env.SLACK_CLIENT_SECRET,
scopes: ['commands', 'chat:write', 'app_mentions:read'],
installationStore: new FileInstallationStore(),
installerOptions: {
directInstall: true,
stateStore: new FileStateStore({}),
},
fastify,
});
const app = new App({
logLevel: LogLevel.DEBUG,
receiver,
});
app.event('app_mention', async ({ event, say }) => {
await say({
text: `<@${event.user}> Hi there :wave:`,
blocks: [
{
type: 'section',
text: {
type: 'mrkdwn',
text: `<@${event.user}> Hi there :wave:`,
},
},
],
});
});
app.command('/my-command', async ({ ack }) => {
await ack('Hi there!');
});
app.shortcut('my-global-shortcut', async ({ ack, body, client }) => {
await ack();
await client.views.open({
trigger_id: body.trigger_id,
view: {
type: 'modal',
callback_id: 'my-modal',
title: {
type: 'plain_text',
text: 'My App',
},
submit: {
type: 'plain_text',
text: 'Submit',
},
blocks: [
{
type: 'input',
block_id: 'b',
element: {
type: 'plain_text_input',
action_id: 'a',
},
label: {
type: 'plain_text',
text: 'Comment',
},
},
],
},
});
});
app.view('my-modal', async ({ view, ack, logger }) => {
logger.info(view.state.values);
await ack();
});
(async () => {
await app.start();
// eslint-disable-next-line no-console
console.log('⚡️ Bolt app is running!');
})();
Run the app
export SLACK_CLIENT_ID=
export SLACK_CLIENT_SECRET=
export SLACK_SIGNING_SECRET=
export SLACK_STATE_SECRET=secret
export SLACK_APP_TOKEN=
npm start
# Visit https://{your public domain}/slack/install