@squadbase/connectors 0.1.2-dev.4 → 0.1.2-dev.5

package/dist/index.js

@@ -6019,6 +6019,90 @@ const data = await res.json();
   tools: tools28
 });
 
+// src/connectors/slack/setup.ts
+var slackSetup = new ConnectorSetup({
+  ja: `## Slack \u30BB\u30C3\u30C8\u30A2\u30C3\u30D7\u624B\u9806
+
+\u4EE5\u4E0B\u306E\u624B\u9806\u3067Slack\u30B3\u30CD\u30AF\u30B7\u30E7\u30F3\u306E\u30BB\u30C3\u30C8\u30A2\u30C3\u30D7\u3092\u884C\u3063\u3066\u304F\u3060\u3055\u3044\u3002
+
+### \u624B\u9806
+
+#### \u30B9\u30C6\u30C3\u30D71: \u63A5\u7D9A\u78BA\u8A8D
+1. Slack API \`auth.test\` \u3092\u547C\u3073\u51FA\u3057\u3066 Bot Token \u306E\u6709\u52B9\u6027\u3092\u78BA\u8A8D\u3059\u308B:
+   - URL: \`https://slack.com/api/auth.test\`
+   - Header: \`Authorization: Bearer {botToken}\`
+2. \u30EC\u30B9\u30DD\u30F3\u30B9\u306E \`ok\` \u304C \`false\` \u306E\u5834\u5408:
+   - \`invalid_auth\`: Bot Token \u304C\u7121\u52B9\u3002\u30E6\u30FC\u30B6\u30FC\u306B\u30C8\u30FC\u30AF\u30F3\u306E\u518D\u78BA\u8A8D\u3092\u4F9D\u983C\u3059\u308B
+   - \`missing_scope\` \u3084\u6A29\u9650\u30A8\u30E9\u30FC: \u5FC5\u8981\u306A\u30B9\u30B3\u30FC\u30D7\u304C\u4E0D\u8DB3\u3057\u3066\u3044\u308B\u65E8\u3092\u6848\u5185\u3057\u3001\u30E6\u30FC\u30B6\u30FC\u306B\u4FEE\u6B63\u3092\u4F9D\u983C\u3059\u308B
+
+#### \u30B9\u30C6\u30C3\u30D72: \u30EF\u30FC\u30AF\u30B9\u30DA\u30FC\u30B9\u60C5\u5831\u306E\u53D6\u5F97
+3. \`team.info\` \u3092\u547C\u3073\u51FA\u3057\u3066\u30EF\u30FC\u30AF\u30B9\u30DA\u30FC\u30B9\u60C5\u5831\u3092\u53D6\u5F97\u3059\u308B:
+   - URL: \`https://slack.com/api/team.info\`
+4. \u30A8\u30E9\u30FC\u304C\u8FD4\u3055\u308C\u305F\u5834\u5408\uFF08\u7279\u306B \`missing_scope\`\uFF09:
+   - \u4E0D\u8DB3\u3057\u3066\u3044\u308B\u30B9\u30B3\u30FC\u30D7\u3092\u6848\u5185\u3057\u3001\u30E6\u30FC\u30B6\u30FC\u306B\u8FFD\u52A0\u3092\u4F9D\u983C\u3059\u308B
+   - \u30E6\u30FC\u30B6\u30FC\u304C\u4FEE\u6B63\u5F8C\u300C\u5B8C\u4E86\u3057\u305F\u300D\u3068\u8FD4\u7B54\u3057\u305F\u3089\u3001\u518D\u5EA6 \`team.info\` \u3092\u547C\u3073\u51FA\u3057\u3066\u78BA\u8A8D\u3059\u308B
+
+#### \u30B9\u30C6\u30C3\u30D73: \u30BB\u30C3\u30C8\u30A2\u30C3\u30D7\u5B8C\u4E86
+5. \`updateConnectionContext\` \u3092\u547C\u3073\u51FA\u3059:
+   - \`workspace\`: \u30EF\u30FC\u30AF\u30B9\u30DA\u30FC\u30B9\u540D\u30FBID
+   - \`note\`: \u30BB\u30C3\u30C8\u30A2\u30C3\u30D7\u5185\u5BB9\u306E\u7C21\u5358\u306A\u8AAC\u660E
+
+### \u63A8\u5968 Bot Token Scopes
+\u4EE5\u4E0B\u306E\u30B9\u30B3\u30FC\u30D7\u304C\u4E00\u822C\u7684\u306B\u5FC5\u8981\u3067\u3059\u3002\u4E0D\u8DB3\u3057\u3066\u3044\u308B\u5834\u5408\u306F\u30E6\u30FC\u30B6\u30FC\u306B\u6848\u5185\u3057\u3066\u304F\u3060\u3055\u3044:
+- \`channels:read\` \u2014 \u30D1\u30D6\u30EA\u30C3\u30AF\u30C1\u30E3\u30F3\u30CD\u30EB\u306E\u4E00\u89A7
+- \`groups:read\` \u2014 \u30D7\u30E9\u30A4\u30D9\u30FC\u30C8\u30C1\u30E3\u30F3\u30CD\u30EB\u306E\u4E00\u89A7
+- \`users:read\` \u2014 \u30E6\u30FC\u30B6\u30FC\u4E00\u89A7
+- \`team:read\` \u2014 \u30EF\u30FC\u30AF\u30B9\u30DA\u30FC\u30B9\u60C5\u5831
+- \`chat:write\` \u2014 \u30E1\u30C3\u30BB\u30FC\u30B8\u9001\u4FE1
+
+### \u91CD\u8981\u306A\u5236\u7D04
+- **\u30BB\u30C3\u30C8\u30A2\u30C3\u30D7\u4E2D\u306B\u30C1\u30E3\u30F3\u30CD\u30EB\u306E\u30E1\u30C3\u30BB\u30FC\u30B8\u5185\u5BB9\u3092\u8AAD\u307F\u53D6\u3089\u306A\u3044\u3053\u3068**\u3002\u5B9F\u884C\u3057\u3066\u3088\u3044\u306E\u306F\u4E0A\u8A18\u624B\u9806\u3067\u6307\u5B9A\u3055\u308C\u305F\u63A5\u7D9A\u78BA\u8A8D\u30FB\u30E1\u30BF\u30C7\u30FC\u30BF\u53D6\u5F97\u30EA\u30AF\u30A8\u30B9\u30C8\u306E\u307F
+
+### \u5B9F\u884C\u65B9\u91DD
+- \u30C4\u30FC\u30EB\u9593\u306F1\u6587\u3060\u3051\u66F8\u3044\u3066\u5373\u6B21\u306E\u30C4\u30FC\u30EB\u547C\u3073\u51FA\u3057
+- \u4E0D\u8981\u306A\u8AAC\u660E\u306F\u7701\u7565\u3057\u3001\u52B9\u7387\u7684\u306B\u9032\u3081\u308B`,
+  en: `## Slack Setup Instructions
+
+Follow these steps to set up the Slack connection.
+
+### Steps
+
+#### Step 1: Verify Connection
+1. Call Slack API \`auth.test\` to verify the Bot Token:
+   - URL: \`https://slack.com/api/auth.test\`
+   - Header: \`Authorization: Bearer {botToken}\`
+2. If the response \`ok\` is \`false\`:
+   - \`invalid_auth\`: Bot Token is invalid. Ask the user to re-check the token
+   - \`missing_scope\` or permission errors: Inform which scopes are missing and ask the user to fix
+
+#### Step 2: Fetch Workspace Info
+3. Call \`team.info\` to get workspace info:
+   - URL: \`https://slack.com/api/team.info\`
+4. If an error is returned (especially \`missing_scope\`):
+   - Inform the user which scopes are missing and ask them to add the scopes
+   - When the user confirms the fix, call \`team.info\` again to verify
+
+#### Step 3: Complete Setup
+5. Call \`updateConnectionContext\`:
+   - \`workspace\`: Workspace name and ID
+   - \`note\`: Brief description of the setup
+
+### Recommended Bot Token Scopes
+The following scopes are commonly required. Inform the user if any are missing:
+- \`channels:read\` \u2014 List public channels
+- \`groups:read\` \u2014 List private channels
+- \`users:read\` \u2014 List users
+- \`team:read\` \u2014 Get workspace info
+- \`chat:write\` \u2014 Send messages
+
+### Important Constraints
+- **Do NOT read channel message content during setup**. Only the connection verification and metadata requests specified in the steps above are allowed
+
+### Execution Policy
+- Write only 1 sentence between tool calls, then immediately call the next tool
+- Skip unnecessary explanations and proceed efficiently`
+});
+
 // src/connectors/slack/index.ts
 var tools29 = {};
 var slackConnector = new ConnectorPlugin({
@@ -6029,35 +6113,42 @@ var slackConnector = new ConnectorPlugin({
   iconUrl: "https://images.ctfassets.net/9ncizv60xc5y/7zTp67vMTvAV1wPftt6Z9R/f859e25c223d9fe4c3fd4f83895acbf6/slack.svg",
   parameters: parameters17,
   releaseFlag: { dev1: true, dev2: false, prod: false },
+  setup: slackSetup,
   systemPrompt: `## Slack SDK (TypeScript handler)
 Use the Slack connector via the SDK in TypeScript handlers:
 
 \`\`\`ts
 import { connection } from "@squadbase/vite-server/connectors/slack";
-import { WebClient } from "@slack/web-api";
 
 const { botToken } = connection("<connectionId>");
-const client = new WebClient(botToken);
 
-const result = await client.conversations.list({ limit: 100 });
+// Use the Slack Web API with fetch
+const res = await fetch("https://slack.com/api/conversations.list", {
+  headers: {
+    Authorization: "Bearer " + botToken,
+    "Content-Type": "application/json",
+  },
+});
+const data = await res.json();
 \`\`\`
 
-### Common Web API Methods (Base URL: https://slack.com/api)
-- \`conversations.list\` \u2014 List channels
-- \`conversations.history\` \u2014 Get channel messages
-- \`conversations.info\` \u2014 Get channel info
-- \`conversations.members\` \u2014 List channel members
-- \`users.list\` \u2014 List users
-- \`users.info\` \u2014 Get user info
-- \`chat.postMessage\` \u2014 Send a message
-- \`reactions.list\` \u2014 List reactions
-- \`search.messages\` \u2014 Search messages
-- \`team.info\` \u2014 Get team info
+### Common Endpoints (Base URL: https://slack.com/api)
+- GET \`/conversations.list\` \u2014 List channels
+- GET \`/conversations.history?channel={id}\` \u2014 Get channel messages
+- GET \`/conversations.info?channel={id}\` \u2014 Get channel info
+- GET \`/conversations.members?channel={id}\` \u2014 List channel members
+- GET \`/users.list\` \u2014 List users
+- GET \`/users.info?user={id}\` \u2014 Get user info
+- POST \`/chat.postMessage\` \u2014 Send a message (JSON body: channel, text)
+- GET \`/reactions.list\` \u2014 List reactions
+- GET \`/search.messages?query={query}\` \u2014 Search messages (requires user token)
+- GET \`/team.info\` \u2014 Get team info
 
 ### Tips
-- Use the \`@slack/web-api\` package for type-safe API calls
+- All endpoints accept GET with query params or POST with JSON body
 - Pagination: use \`cursor\` parameter with \`response_metadata.next_cursor\`
-- Rate limits: Tier 1-4, most methods are Tier 3 (50+ per minute)`,
+- Rate limits: Tier 1-4, most methods are Tier 3 (50+ per minute)
+- Check \`data.ok\` field \u2014 Slack returns HTTP 200 even on errors`,
   tools: tools29
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squadbase/connectors",
-  "version": "0.1.2-dev.4",
+  "version": "0.1.2-dev.5",
   "description": "Squadbase Connectors",
   "type": "module",
   "main": "dist/index.js",