@kentcdodds/slack

Read Slack conversations and safely send messages as the authorizing user through the saved slack OAuth integration.

src/index.ts

31 lines · 898 B · TypeScript

/**
 * Return Slack package discovery metadata: user-token identity, exports, and safety notes.
 * Use when choosing among Slack helpers before reading history or sending a message.
 *
 * @returns Integration overview including export list and confirmation requirements
 *
 * @example
 * import slackOverview from 'kody:@kentcdodds/slack'
 * const info = await slackOverview()
 * // => { integration: 'slack', identity: 'user', exports: [...], safety: { ... } }
 */
export default async function slackOverview() {
  return {
    integration: 'slack',
    identity: 'user',
    apiBaseUrl: 'https://slack.com/api',
    exports: [
      'smoke-test',
      'list-conversations',
      'list-users',
      'get-history',
      'get-replies',
      'send-message',
    ],
    safety: {
      sendingRequiresConfirmation: true,
      dryRunAvailable: true,
      botTokensSupported: false,
    },
  }
}