Initial commit

Author: misscoded

.env.sample

@@ -0,0 +1,5 @@
+SLACK_APP_TOKEN=YOUR_SLACK_APP_TOKEN
+SLACK_BOT_TOKEN=YOUR_SLACK_BOT_TOKEN
+# SLACK_API_URL=YOUR_SLACK_API_URL
+# This template uses OpenAI, but you can use any other provider!
+OPENAI_API_KEY=YOUR_OPENAI_API_KEY

.github/CODEOWNERS

@@ -0,0 +1,6 @@
+# Code owners are the default owners for everything in
+# this repository. The owners listed below will be requested for
+# review when a pull request is opened.
+# To add code owner(s), uncomment the line below and
+# replace the @global-owner users with their GitHub username(s).
+# *       @global-owner1 @global-owner2

.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    labels:
+      - "npm"
+      - "dependencies"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

.github/workflows/lint.yml

@@ -0,0 +1,31 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version:
+          - 18.x
+          - 20.x
+          - 22.x
+    steps:
+      - uses: actions/checkout@v5
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v5
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install packages
+        run: npm install
+      - name: Run the lint
+        run: npm run lint
+      - name: Run the typechecker
+        run: npm run check

.gitignore

@@ -0,0 +1,4 @@
+/node_modules
+.DS_Store
+.env*
+!.env.sample

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Slack Technologies, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,78 @@
+# AI Agent App Template (Bolt for JavaScript)
+
+This Bolt for JavaScript template demonstrates how to build [AI Apps](https://docs.slack.dev/ai/) in Slack.
+
+Models from [OpenAI](https://openai.com) are used and can be customized for prompts of all kinds.
+
+## Setup
+
+Before getting started, make sure you have a development workspace where you have permissions to install apps. If you don’t have one setup, go ahead and [create one](https://slack.com/create).
+
+### Developer Program
+
+Join the [Slack Developer Program](https://api.slack.com/developer-program) for exclusive access to sandbox environments for building and testing your apps, tooling, and resources created to help you build and grow.
+
+## Installation
+
+### Create a Slack App
+
+1. Open [https://api.slack.com/apps/new](https://api.slack.com/apps/new) and
+   choose "From an app manifest"
+2. Choose the workspace you want to install the application to
+3. Copy the contents of [manifest.json](./manifest.json) into the text box that
+   says `*Paste your manifest code here*` (within the JSON tab) and click _Next_
+4. Review the configuration and click _Create_
+5. You'll then be redirected to App Settings. Visit the **Install App** page and install your app.
+
+### Environment Variables
+
+Before you can run the app, you'll need to store some environment variables.
+
+
+1. Rename `.env.sample` to `.env`.
+2. Open your apps setting page from [this list](https://api.slack.com/apps), click _OAuth & Permissions_ in the left hand menu, then copy the _Bot User OAuth Token_ into your `.env` file under `SLACK_BOT_TOKEN`.
+```zsh
+SLACK_BOT_TOKEN=YOUR_SLACK_BOT_TOKEN
+```
+3. Click _Basic Information_ from the left hand menu and follow the steps in the _App-Level Tokens_ section to create an app-level token with the `connections:write` scope. Copy that token into your `.env` as `SLACK_APP_TOKEN`.
+```zsh
+SLACK_APP_TOKEN=YOUR_SLACK_APP_TOKEN
+```
+4. Save your OpenAI key into `.env` under `OPENAI_API_KEY`.
+```zsh
+OPENAI_API_KEY=YOUR_OPEN_API_KEY
+```
+
+
+### Local Project
+
+```zsh
+# Clone this project onto your machine
+git clone https://github.com/slack-samples/bolt-js-assistant-template.git
+
+# Change into this project directory
+cd bolt-js-assistant-template
+
+# Install dependencies
+npm install
+
+# Run Bolt server
+npm start
+```
+
+### Linting
+
+```zsh
+# Run lint for code formatting and linting
+npm run lint
+```
+
+## Project Structure
+
+### `manifest.json`
+
+`manifest.json` is a configuration for Slack apps. With a manifest, you can create an app with a pre-defined configuration, or adjust the configuration of an existing app.
+
+### `app.js`
+
+`app.js` is the entry point for the application and is the file you'll run to start the server. This project aims to keep this file as thin as possible, primarily using it as a way to route inbound requests.

ai/index.js

@@ -0,0 +1,13 @@
+import { OpenAI } from 'openai';
+
+// LLM system prompt
+export const DEFAULT_SYSTEM_CONTENT = `You're an assistant in a Slack workspace.
+Users in the workspace will ask you to help them write something or to think better about a specific topic.
+You'll respond to those questions in a professional way.
+When you include markdown text, convert them to Slack compatible ones.
+When a prompt has Slack's special syntax like <@USER_ID> or <#CHANNEL_ID>, you must keep them as-is in your response.`;
+
+// OpenAI LLM client
+export const openai = new OpenAI({
+  apiKey: process.env.OPENAI_API_KEY,
+});

app.js

@@ -0,0 +1,27 @@
+import 'dotenv/config';
+import { App, LogLevel } from '@slack/bolt';
+import { registerListeners } from './listeners/index.js';
+
+// Initialize the Bolt app
+const app = new App({
+  token: process.env.SLACK_BOT_TOKEN,
+  appToken: process.env.SLACK_APP_TOKEN,
+  socketMode: true,
+  logLevel: LogLevel.DEBUG,
+  clientOptions: {
+    slackApiUrl: process.env.SLACK_API_URL || 'https://slack.com/api',
+  },
+});
+
+// Register the action and event listeners
+registerListeners(app);
+
+// Start the Bolt app
+(async () => {
+  try {
+    await app.start();
+    app.logger.info('⚡️ Bolt app is running!');
+  } catch (error) {
+    app.logger.error('Failed to start the app', error);
+  }
+})();

biome.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "formatter": {
+    "enabled": true,
+    "formatWithErrors": false,
+    "includes": ["**"],
+    "attributePosition": "auto",
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 120,
+    "lineEnding": "lf"
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single"
+    }
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true
+    }
+  },
+  "assist": {
+    "actions": {
+      "source": {
+        "organizeImports": "on"
+      }
+    }
+  },
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  }
+}