@graphai/slack_agent 0.0.1 → 0.0.2

package/README.md

@@ -0,0 +1,42 @@
+
+# @graphai/slack_agent for GraphAI
+
+Slack message agents for GraphAI.
+
+### Install
+
+```sh
+yarn add @graphai/slack_agent
+```
+
+## setup
+
+### Acquiring a Slack Token for Posting Messages
+
+1. **Obtain a Slack Token:**
+   - Go to the [Slack API Developer Portal](https://api.slack.com/apps) and select or create your app.
+   - Follow the steps in the **Permissions** or **Authentication** section to generate the necessary token for your use case (e.g., user token, bot token).
+
+2. **Set the Token as an Environment Variable:**
+   - Export the token as an environment variable by running the following command in your terminal:
+     ```bash
+     export SLACK_TOKEN=your-slack-token-here
+     ```
+
+3. **Using a Bot Token:**
+   - If you are using a bot token, ensure that the bot is added to the channel where you intend to post messages. This can be done from the Slack app by inviting the bot to the relevant channel.
+
+### Usage
+
+```typescript
+import { GraphAI } from "graphai";
+import { slackAgent } from "@graphai/slack_agent";
+
+const agents = { slackAgent };
+
+const graph = new GraphAI(graph_data, agents);
+const result = await graph.run();
+```
+
+
+

package/lib/slack_agent.js

@@ -5,6 +5,12 @@ const web_api_1 = require("@slack/web-api");
 const slackAgent = async ({ params, namedInputs }) => {
     const token = process.env.SLACK_TOKEN ?? namedInputs.slack_token;
     const channel = params.post_channel;
+    if (!token) {
+        throw new Error("SLACK_TOKEN is not set in environment variables.");
+    }
+    if (!channel) {
+        throw new Error("Slacl post_channel is not set in params.");
+    }
     const message = namedInputs.message ?? params.message;
     const text = Array.isArray(message) ? message.join("\n") : message;
     const web = new web_api_1.WebClient(token);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphai/slack_agent",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Slack message agents for GraphAI.",
   "main": "lib/index.js",
   "files": [
@@ -10,7 +10,9 @@
     "build": "tsc",
     "eslint": "eslint src --fix",
     "format": "prettier --write '{src,tests}/**/*.ts'",
+    "doc": "npx agentdoc",
     "test_run": "node --test --require ts-node/register ./tests/run_*.ts",
+    "test_graph": "node --test --require ts-node/register ./tests/run_graph.ts",
     "test": "node --test --require ts-node/register ./tests/test_*.ts",
     "ci": "yarn run format && yarn run eslint && yarn run test && yarn run build"
   },