Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@seratch_/bolt-mongoose
Advanced tools
Bolt for JavaScript Installation Store Extension - Mongoose
This module provides an InstallationStore
implementation for Mongoose users.
You can create a simple Node app project using the following package.json
and tsconfig.json
. Of course, if you would like to use some build tool such as webpack, you can go with your own way and add the necessary dependencies.
{
"name": "bolt-mongoose-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.12.2",
"@seratch_/bolt-mongoose": "^1.0.0",
"mongoose": "^6.2.1"
},
"devDependencies": {
"mongodb-memory-server": "^8.3.0",
"ts-node": "^10.5.0",
"typescript": "^4.5.5"
}
}
{
"compilerOptions": {
"emitDecoratorMetadata": true,
"experimentalDecorators": true,
"allowJs": true,
"esModuleInterop": true,
"outDir": "dist",
},
"include": ["src/**/*"]
}
The next step is to create a new Slack app configuration. You can use the following App Manifest configuration data for it.
display_information:
name: mongoose-oauth-test-app
features:
bot_user:
display_name: mongoose-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
The last step is to add your code in the project and spin up your app. You can use the following code as-is.
import { App } from '@slack/bolt';
import { ConsoleLogger, LogLevel } from '@slack/logger';
import { Mongoose } from 'mongoose';
import { MongooseInstallationStore } from '@seratch_/bolt-mongoose';
import { MongoMemoryServer } from 'mongodb-memory-server';
const logger = new ConsoleLogger();
logger.setLevel(LogLevel.DEBUG);
const mongoose = new Mongoose({ debug: true });
const installationStore = new MongooseInstallationStore({
mongoose,
clientId: process.env.SLACK_CLIENT_ID,
logger,
});
const app = new App({
socketMode: true,
appToken: process.env.SLACK_APP_TOKEN,
signingSecret: process.env.SLACK_SIGNING_SECRET,
clientId: process.env.SLACK_CLIENT_ID,
clientSecret: process.env.SLACK_CLIENT_SECRET,
stateSecret: process.env.SLACK_STATE_SECRET,
scopes: ['commands', 'chat:write', 'app_mentions:read'],
installerOptions: {
directInstall: true,
},
installationStore,
logger,
});
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:`,
},
},
],
});
});
(async () => {
const mongod = await MongoMemoryServer.create();
await mongoose.connect(mongod.getUri());
await app.start();
logger.info('⚡️ Bolt app is running!');
})();
Finally, your app is now available for running! Set all the required env variables, hit npm start
, and then enable your public URL endpoint (you may want to use some proxy tool such as ngrok).
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
Now you can install the app into your Slack workspace from https://{your public domain}/slack/install
. Enjoy!
FAQs
Bolt for JavaScript Installation Store Extension - Mongoose
The npm package @seratch_/bolt-mongoose receives a total of 8 weekly downloads. As such, @seratch_/bolt-mongoose popularity was classified as not popular.
We found that @seratch_/bolt-mongoose demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.