@squidcloud/slack-client 1.0.146-beta

package/dist/connectors/slack/common/src/slack-types.d.ts

@@ -0,0 +1,98 @@
+import { AiFileUrl } from '../../../../internal-common/src/public-types/ai-agent.public-types';
+import { IntegrationId } from '../../../../internal-common/src/public-types/communication.public-types';
+/** Slack conversation/channel ID */
+export type ConversationId = string;
+/** List of conversations types. */
+export declare const RECIPIENT_TYPES: readonly ["channel", "user", "group"];
+/** Types of conversations. */
+export type RecipientType = (typeof RECIPIENT_TYPES)[number];
+/**
+ * Fuzzy search result mapping the user query to matching user IDs.
+ */
+export interface FuzzyUserSearchResult {
+    /** Query for a particular user */
+    userQuery: string;
+    /** User IDs for users that match the given query. */
+    userId: string | undefined;
+}
+/**
+ * Slack file upload response.
+ */
+export interface FileUploadResponse {
+    ok: boolean;
+    error?: string;
+}
+/**
+ * User profile object.
+ */
+export interface SlackUser {
+    id: string;
+    name?: string;
+    profile?: {
+        display_name?: string;
+        email?: string;
+    };
+}
+/**
+ * Request to send a message in Slack.
+ */
+export interface SendSlackMessageRequest {
+    /**
+     * The recipient of the Slack message. Can be the channel name, username, email address, or
+     * comma-separated list of usernames/emails (if the recipient type is a group). Usernames will
+     * be fuzzy searched.
+     */
+    recipient: string;
+    /** The message to send. */
+    message: string;
+    /**
+     * Indicates the type of recipient.
+     *  - For public and private channels, use "channel".
+     *  - For direct messages, use "user".
+     *  - For chat groups, use "group".
+     */
+    recipientType: RecipientType;
+    /** Which Slack integration instance to send the message to. */
+    integrationId: string;
+    /**
+     * Slack replies operate on passing in the timestamp of the parent/root message of a thread.
+     * You may pass in the timestamp in 4 possible formats:
+     * - Permalink (non-thread): https://yourinstance.slack.com/archives/C000AB0ABCDE/p1759525914304959
+     * - Permalink (threaded): https://yourinstance.slack.com/archives/C000AB0ABCDE/p1759734921171239?thread_ts=1759525914.304959&cid=C000AB0ABCDE
+     * - Unix time (seconds with floating point): 1759525914.304959
+     * - Unix time (microseconds): 1759525914304959
+     */
+    replyParentTs?: string;
+    /** AiFileUrl objects referring to files you want to attach to the message. */
+    attachments?: AiFileUrl[];
+}
+/**
+ * Request to search for messages related to a given prompt.
+ */
+export interface SearchSlackMessagesRequest {
+    /** The search query */
+    prompt: string;
+    /** Which Slack integration instance to search. */
+    integrationId: IntegrationId;
+    /** Restrict the search to the given channels names, comma-separated. */
+    channelNames?: string;
+}
+/**
+ * Message search result chunk.
+ */
+export interface SearchSlackMessagesResultChunk {
+    /**
+     * Conversation messages.
+     * Contains an arbitrary subset of messages in sequential & chronological order, where the
+     * matching messages are contained within the subset.
+     */
+    messages: string;
+    /** Channel/conversation name the messages came from. */
+    conversationName?: string;
+    /** Conversation Type (typically channel). */
+    conversationType?: RecipientType;
+    /** Thread ID if these messages are part of a thread. */
+    threadId?: string;
+    /** The day date (in UTC) that the conversation took place. */
+    timestamp?: Date;
+}

package/dist/connectors/slack/slack-client/src/index.d.ts

@@ -0,0 +1 @@
+export * from './slack-client';

package/dist/connectors/slack/slack-client/src/slack-client.d.ts

@@ -0,0 +1,39 @@
+import { Squid } from '@squidcloud/client';
+import { SearchSlackMessagesRequest, SearchSlackMessagesResultChunk, SendSlackMessageRequest } from '../../common/src/slack-types';
+/**
+ * Client for interacting with the Slack connector.
+ */
+export declare class SquidSlackClient {
+    private readonly squid;
+    private readonly integrationId;
+    /**
+     * Creates a new Slack client instance.
+     *
+     * @param squid - Squid client instance. Provide an instance that includes the Squid API key.
+     * @param integrationId - The ID of the Slack integration in the Squid console
+     */
+    constructor(squid: Squid, integrationId: string);
+    /**
+     * Send a message to the given Slack integration.
+     *
+     * Supports sending files as well, and to channels, groups, or direct message (to a single user).
+     *
+     * The message can be a reply to a thread via the `replyParentTs` field in `SendSlackMessageRequest`
+     * by giving it a permalink to the message you want to reply to. See `SendSlackMessageRequest` for
+     * more details.
+     *
+     * The provided `squid` instance requires your Squid API key to use this function.
+     *
+     * @param request Request parameters for sending a message to Slack.
+     */
+    sendMessage(request: Omit<SendSlackMessageRequest, 'integrationId'>): Promise<void>;
+    /**
+     * Search for messages related to the given prompt query string.
+     *
+     * The provided `squid` instance requires your Squid API key to use this function.
+     *
+     * @param request Request parameters for searching within a Slack integration instance.
+     * @returns Array of chunks of messages that contain messages related to the query.
+     */
+    searchMessages(request: Omit<SearchSlackMessagesRequest, 'integrationId'>): Promise<SearchSlackMessagesResultChunk[]>;
+}

package/dist/index.js

@@ -0,0 +1 @@
+(()=>{"use strict";var e={d:(t,n)=>{for(var r in n)e.o(n,r)&&!e.o(t,r)&&Object.defineProperty(t,r,{enumerable:!0,get:n[r]})},o:(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r:e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},t={};e.r(t),e.d(t,{SquidSlackClient:()=>n});class n{constructor(e,t){this.squid=e,this.integrationId=t}async sendMessage(e){const t={...e,integrationId:this.integrationId};return this.squid.executeFunction("sendMessageToSlack",t)}async searchMessages(e){const t={...e,integrationId:this.integrationId};return this.squid.executeFunction("searchMessagesInSlack",t)}}var r=exports;for(var s in t)r[s]=t[s];t.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();