kopia lustrzana https://github.com/transitive-bullshit/chatgpt-api
feat: refactor slack a bit
Travis Fischer
rodzic
4d85f2211d
commit
583a2fc2a7
|
|
@ -1 +1,2 @@
|
|||
export * from './slack'
|
||||
export * from './slack-client'
|
||||
|
|
|
|||
|
|
@ -9,263 +9,10 @@ import {
|
|||
import defaultKy, { type KyInstance } from 'ky'
|
||||
import { z } from 'zod'
|
||||
|
||||
import { slack } from './slack'
|
||||
|
||||
// TODO: need to expose more aiFunctions
|
||||
|
||||
export namespace slack {
|
||||
export const API_BASE_URL = 'https://slack.com/api'
|
||||
|
||||
export const DEFAULT_TIMEOUT_MS = 120_000
|
||||
export const DEFAULT_INTERVAL_MS = 5000
|
||||
|
||||
export interface BotProfile {
|
||||
id: string
|
||||
app_id: string
|
||||
name: string
|
||||
icons: Record<string, unknown>
|
||||
deleted: boolean
|
||||
updated: number
|
||||
team_id: string
|
||||
}
|
||||
|
||||
export interface Replies {
|
||||
messages: Message[]
|
||||
has_more: boolean
|
||||
ok: boolean
|
||||
response_metadata: ResponseMetadata
|
||||
}
|
||||
|
||||
export interface Message {
|
||||
bot_id?: string
|
||||
client_msg_id?: string
|
||||
type: string
|
||||
text: string
|
||||
user: string
|
||||
ts: string
|
||||
app_id?: string
|
||||
blocks?: Record<string, unknown>[]
|
||||
reply_count?: number
|
||||
subscribed?: boolean
|
||||
last_read?: string
|
||||
unread_count?: number
|
||||
team?: string
|
||||
thread_ts: string
|
||||
parent_user_id?: string
|
||||
bot_profile?: BotProfile
|
||||
}
|
||||
|
||||
export interface ResponseMetadata {
|
||||
next_cursor: string
|
||||
}
|
||||
|
||||
export type Attachment = {
|
||||
[key: string]: any
|
||||
}
|
||||
|
||||
export type Block = {
|
||||
[key: string]: any
|
||||
}
|
||||
|
||||
/**
|
||||
* Parameters for the Slack API's `chat.postMessage` method.
|
||||
*
|
||||
* @see {@link https://api.slack.com/methods/chat.postMessage}
|
||||
*/
|
||||
export type PostMessageParams = {
|
||||
/**
|
||||
* The formatted text of the message to be published.
|
||||
*/
|
||||
text: string
|
||||
|
||||
/**
|
||||
* Channel, private group, or IM channel to send the message to. Can be an encoded ID, or a name.
|
||||
*/
|
||||
channel?: string
|
||||
|
||||
/**
|
||||
* Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
|
||||
*/
|
||||
thread_ts?: string
|
||||
|
||||
/**
|
||||
* A JSON-based array of structured attachments, presented as a URL-encoded string.
|
||||
*/
|
||||
attachments?: Attachment[]
|
||||
|
||||
/**
|
||||
* A JSON-based array of structured blocks, presented as a URL-encoded string.
|
||||
*/
|
||||
blocks?: Block[]
|
||||
|
||||
/**
|
||||
* Emoji to use as the icon for this message. Overrides icon_url.
|
||||
*/
|
||||
icon_emoji?: string
|
||||
|
||||
/**
|
||||
* URL to an image to use as the icon for this message.
|
||||
*/
|
||||
icon_url?: string
|
||||
|
||||
/**
|
||||
* If set to true, user group handles (to name just one example) will be linked in the message text.
|
||||
*/
|
||||
link_names?: boolean
|
||||
|
||||
/**
|
||||
* Change how messages are treated (default: 'none').
|
||||
*/
|
||||
parse?: 'full' | 'none'
|
||||
|
||||
/**
|
||||
* Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation.
|
||||
*/
|
||||
reply_broadcast?: boolean
|
||||
|
||||
/**
|
||||
* Pass true to enable unfurling of primarily text-based content.
|
||||
*/
|
||||
unfurl_links?: boolean
|
||||
|
||||
/**
|
||||
* Pass false to disable unfurling of media content.
|
||||
*/
|
||||
unfurl_media?: boolean
|
||||
|
||||
/**
|
||||
* Set your bot's user name.
|
||||
*/
|
||||
username?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Parameters for the Slack API's `conversations.history` method.
|
||||
*
|
||||
* @see {@link https://api.slack.com/methods/conversations.history}
|
||||
*/
|
||||
export type ConversationHistoryParams = {
|
||||
/**
|
||||
* The conversation ID to fetch history for.
|
||||
*/
|
||||
channel: string
|
||||
|
||||
/**
|
||||
* Only messages after this Unix timestamp will be included in results (default: `0`).
|
||||
*/
|
||||
oldest?: string
|
||||
|
||||
/**
|
||||
* The cursor value used for pagination of results (default: first page).
|
||||
*/
|
||||
cursor?: string
|
||||
|
||||
/**
|
||||
* Only messages before this Unix timestamp will be included in results (default: now).
|
||||
*/
|
||||
latest?: string
|
||||
|
||||
/**
|
||||
* The maximum number of items to return (default: `100`).
|
||||
*/
|
||||
limit?: number
|
||||
|
||||
/**
|
||||
* Include messages with the oldest or latest timestamps in results. Ignored unless either timestamp is specified (default: `false`).
|
||||
*/
|
||||
inclusive?: boolean
|
||||
|
||||
/**
|
||||
* Return all metadata associated with the messages (default: `false`).
|
||||
*/
|
||||
include_all_metadata?: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Parameters for the Slack API's `conversations.replies` method.
|
||||
*
|
||||
* @see {@link https://api.slack.com/methods/conversations.replies}
|
||||
*/
|
||||
export type ConversationRepliesParams = {
|
||||
/**
|
||||
* The conversation ID to fetch the thread from.
|
||||
*/
|
||||
channel: string
|
||||
|
||||
/**
|
||||
* Unique identifier of either a thread’s parent message or a message in the thread.
|
||||
*
|
||||
* ### Notes
|
||||
*
|
||||
* - ts must be the timestamp of an existing message with 0 or more replies.
|
||||
* - If there are no replies then just the single message referenced by ts will return - it is just an ordinary, unthreaded message.
|
||||
*/
|
||||
ts: string
|
||||
|
||||
/**
|
||||
* The cursor value used for pagination of results.
|
||||
* Set this to the `next_cursor` attribute returned by a previous request's response_metadata.
|
||||
*/
|
||||
cursor?: string
|
||||
|
||||
/**
|
||||
* Only messages before this Unix timestamp will be included in results.
|
||||
*/
|
||||
latest?: string
|
||||
|
||||
/**
|
||||
* Only messages after this Unix timestamp will be included in results.
|
||||
*/
|
||||
oddest?: string
|
||||
|
||||
/**
|
||||
* The maximum number of items to return.
|
||||
* Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
|
||||
*/
|
||||
limit?: number
|
||||
|
||||
/**
|
||||
* Include messages with the oldest or latest timestamps in results. Ignored unless either timestamp is specified.
|
||||
*/
|
||||
inclusive?: boolean
|
||||
|
||||
/**
|
||||
* Return all metadata associated with this message.
|
||||
*/
|
||||
include_thread_metadata?: boolean
|
||||
}
|
||||
|
||||
export type SendAndWaitOptions = {
|
||||
/**
|
||||
* The text of the message to send.
|
||||
*/
|
||||
text: string
|
||||
|
||||
/**
|
||||
* The ID of the channel to send the message to.
|
||||
*/
|
||||
channel?: string
|
||||
|
||||
/**
|
||||
* The timeout in milliseconds to wait for a reply before throwing an error.
|
||||
*/
|
||||
timeoutMs?: number
|
||||
|
||||
/**
|
||||
* The interval in milliseconds to poll for replies.
|
||||
*/
|
||||
intervalMs?: number
|
||||
|
||||
/**
|
||||
* A function to validate the reply message. If the function returns `true`, the reply is considered valid and the function will return the message. If the function returns `false`, the reply is considered invalid and the function will continue to wait for a reply until the timeout is reached.
|
||||
*/
|
||||
validate?: (message: Message) => boolean
|
||||
|
||||
/**
|
||||
* A stop signal from an [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController), which can be used to abort retrying. More specifically, when `AbortController.abort(reason)` is called, the function will throw an error with the `reason` argument as the error message.
|
||||
*/
|
||||
stopSignal?: AbortSignal
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Minimal Slack API client for sending and receiving Slack messages.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -0,0 +1,295 @@
|
|||
export namespace slack {
|
||||
export const API_BASE_URL = 'https://slack.com/api'
|
||||
|
||||
export const DEFAULT_TIMEOUT_MS = 120_000
|
||||
export const DEFAULT_INTERVAL_MS = 5000
|
||||
|
||||
export interface BotProfile {
|
||||
id: string
|
||||
app_id: string
|
||||
name: string
|
||||
icons: Record<string, unknown>
|
||||
deleted: boolean
|
||||
updated: number
|
||||
team_id: string
|
||||
}
|
||||
|
||||
export interface Replies {
|
||||
messages: Message[]
|
||||
has_more: boolean
|
||||
ok: boolean
|
||||
response_metadata: ResponseMetadata
|
||||
}
|
||||
|
||||
export interface Message {
|
||||
bot_id?: string
|
||||
client_msg_id?: string
|
||||
type: string
|
||||
text: string
|
||||
user: string
|
||||
ts: string
|
||||
app_id?: string
|
||||
blocks?: Record<string, unknown>[]
|
||||
reply_count?: number
|
||||
subscribed?: boolean
|
||||
last_read?: string
|
||||
unread_count?: number
|
||||
team?: string
|
||||
thread_ts: string
|
||||
parent_user_id?: string
|
||||
bot_profile?: BotProfile
|
||||
}
|
||||
|
||||
export interface ResponseMetadata {
|
||||
next_cursor: string
|
||||
}
|
||||
|
||||
export type Attachment = {
|
||||
[key: string]: any
|
||||
}
|
||||
|
||||
export type Block = {
|
||||
[key: string]: any
|
||||
}
|
||||
|
||||
/**
|
||||
* Parameters for the Slack API's `chat.postMessage` method.
|
||||
*
|
||||
* @see {@link https://api.slack.com/methods/chat.postMessage}
|
||||
*/
|
||||
export type PostMessageParams = {
|
||||
/**
|
||||
* The formatted text of the message to be published.
|
||||
*/
|
||||
text: string
|
||||
|
||||
/**
|
||||
* Channel, private group, or IM channel to send the message to. Can be an encoded ID, or a name.
|
||||
*/
|
||||
channel?: string
|
||||
|
||||
/**
|
||||
* Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
|
||||
*/
|
||||
thread_ts?: string
|
||||
|
||||
/**
|
||||
* A JSON-based array of structured attachments, presented as a URL-encoded string.
|
||||
*/
|
||||
attachments?: Attachment[]
|
||||
|
||||
/**
|
||||
* A JSON-based array of structured blocks, presented as a URL-encoded string.
|
||||
*/
|
||||
blocks?: Block[]
|
||||
|
||||
/**
|
||||
* Emoji to use as the icon for this message. Overrides icon_url.
|
||||
*/
|
||||
icon_emoji?: string
|
||||
|
||||
/**
|
||||
* URL to an image to use as the icon for this message.
|
||||
*/
|
||||
icon_url?: string
|
||||
|
||||
/**
|
||||
* If set to true, user group handles (to name just one example) will be linked in the message text.
|
||||
*/
|
||||
link_names?: boolean
|
||||
|
||||
/**
|
||||
* Change how messages are treated (default: 'none').
|
||||
*/
|
||||
parse?: 'full' | 'none'
|
||||
|
||||
/**
|
||||
* Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation.
|
||||
*/
|
||||
reply_broadcast?: boolean
|
||||
|
||||
/**
|
||||
* Pass true to enable unfurling of primarily text-based content.
|
||||
*/
|
||||
unfurl_links?: boolean
|
||||
|
||||
/**
|
||||
* Pass false to disable unfurling of media content.
|
||||
*/
|
||||
unfurl_media?: boolean
|
||||
|
||||
/**
|
||||
* Set your bot's user name.
|
||||
*/
|
||||
username?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Parameters for the Slack API's `conversations.history` method.
|
||||
*
|
||||
* @see {@link https://api.slack.com/methods/conversations.history}
|
||||
*/
|
||||
export type ConversationHistoryParams = {
|
||||
/**
|
||||
* The conversation ID to fetch history for.
|
||||
*/
|
||||
channel: string
|
||||
|
||||
/**
|
||||
* Only messages after this Unix timestamp will be included in results (default: `0`).
|
||||
*/
|
||||
oldest?: string
|
||||
|
||||
/**
|
||||
* The cursor value used for pagination of results (default: first page).
|
||||
*/
|
||||
cursor?: string
|
||||
|
||||
/**
|
||||
* Only messages before this Unix timestamp will be included in results (default: now).
|
||||
*/
|
||||
latest?: string
|
||||
|
||||
/**
|
||||
* The maximum number of items to return (default: `100`).
|
||||
*/
|
||||
limit?: number
|
||||
|
||||
/**
|
||||
* Include messages with the oldest or latest timestamps in results. Ignored unless either timestamp is specified (default: `false`).
|
||||
*/
|
||||
inclusive?: boolean
|
||||
|
||||
/**
|
||||
* Return all metadata associated with the messages (default: `false`).
|
||||
*/
|
||||
include_all_metadata?: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Parameters for the Slack API's `conversations.replies` method.
|
||||
*
|
||||
* @see {@link https://api.slack.com/methods/conversations.replies}
|
||||
*/
|
||||
export type ConversationRepliesParams = {
|
||||
/**
|
||||
* The conversation ID to fetch the thread from.
|
||||
*/
|
||||
channel: string
|
||||
|
||||
/**
|
||||
* Unique identifier of either a thread’s parent message or a message in the thread.
|
||||
*
|
||||
* ### Notes
|
||||
*
|
||||
* - ts must be the timestamp of an existing message with 0 or more replies.
|
||||
* - If there are no replies then just the single message referenced by ts will return - it is just an ordinary, unthreaded message.
|
||||
*/
|
||||
ts: string
|
||||
|
||||
/**
|
||||
* The cursor value used for pagination of results.
|
||||
* Set this to the `next_cursor` attribute returned by a previous request's response_metadata.
|
||||
*/
|
||||
cursor?: string
|
||||
|
||||
/**
|
||||
* Only messages before this Unix timestamp will be included in results.
|
||||
*/
|
||||
latest?: string
|
||||
|
||||
/**
|
||||
* Only messages after this Unix timestamp will be included in results.
|
||||
*/
|
||||
oddest?: string
|
||||
|
||||
/**
|
||||
* The maximum number of items to return.
|
||||
* Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
|
||||
*/
|
||||
limit?: number
|
||||
|
||||
/**
|
||||
* Include messages with the oldest or latest timestamps in results. Ignored unless either timestamp is specified.
|
||||
*/
|
||||
inclusive?: boolean
|
||||
|
||||
/**
|
||||
* Return all metadata associated with this message.
|
||||
*/
|
||||
include_thread_metadata?: boolean
|
||||
}
|
||||
|
||||
export type SendAndWaitOptions = {
|
||||
/**
|
||||
* The text of the message to send.
|
||||
*/
|
||||
text: string
|
||||
|
||||
/**
|
||||
* The ID of the channel to send the message to.
|
||||
*/
|
||||
channel?: string
|
||||
|
||||
/**
|
||||
* The timeout in milliseconds to wait for a reply before throwing an error.
|
||||
*/
|
||||
timeoutMs?: number
|
||||
|
||||
/**
|
||||
* The interval in milliseconds to poll for replies.
|
||||
*/
|
||||
intervalMs?: number
|
||||
|
||||
/**
|
||||
* A function to validate the reply message. If the function returns `true`, the reply is considered valid and the function will return the message. If the function returns `false`, the reply is considered invalid and the function will continue to wait for a reply until the timeout is reached.
|
||||
*/
|
||||
validate?: (message: Message) => boolean
|
||||
|
||||
/**
|
||||
* A stop signal from an [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController), which can be used to abort retrying. More specifically, when `AbortController.abort(reason)` is called, the function will throw an error with the `reason` argument as the error message.
|
||||
*/
|
||||
stopSignal?: AbortSignal
|
||||
}
|
||||
|
||||
export interface ListChannelsArgs {
|
||||
limit?: number
|
||||
cursor?: string
|
||||
}
|
||||
|
||||
export interface PostMessageArgs {
|
||||
channel_id: string
|
||||
text: string
|
||||
}
|
||||
|
||||
export interface ReplyToThreadArgs {
|
||||
channel_id: string
|
||||
thread_ts: string
|
||||
text: string
|
||||
}
|
||||
|
||||
export interface AddReactionArgs {
|
||||
channel_id: string
|
||||
timestamp: string
|
||||
reaction: string
|
||||
}
|
||||
|
||||
export interface GetChannelHistoryArgs {
|
||||
channel_id: string
|
||||
limit?: number
|
||||
}
|
||||
|
||||
export interface GetThreadRepliesArgs {
|
||||
channel_id: string
|
||||
thread_ts: string
|
||||
}
|
||||
|
||||
export interface GetUsersArgs {
|
||||
cursor?: string
|
||||
limit?: number
|
||||
}
|
||||
|
||||
export interface GetUserProfileArgs {
|
||||
user_id: string
|
||||
}
|
||||
}
|
||||
Ładowanie…
Reference in New Issue