@doist/comms-sdk 0.0.1 → 0.2.0

package/dist/cjs/clients/search-client.js

@@ -0,0 +1,138 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchClient = void 0;
+const endpoints_1 = require("../consts/endpoints");
+const http_client_1 = require("../transport/http-client");
+const entities_1 = require("../types/entities");
+const base_client_1 = require("./base-client");
+/**
+ * Client for interacting with Comms search endpoints.
+ */
+class SearchClient extends base_client_1.BaseClient {
+    /**
+     * Searches across all threads and conversations in a workspace.
+     *
+     * @param args - The arguments for searching.
+     * @param args.query - The search query string. Optional when `mentionSelf: true` is set; required otherwise.
+     * @param args.workspaceId - The workspace ID to search in.
+     * @param args.channelIds - Optional array of channel IDs to filter by.
+     * @param args.authorIds - Optional array of author user IDs to filter by.
+     * @param args.mentionSelf - Optional flag to filter by mentions of the current user. When true, `query` may be omitted.
+     * @param args.dateFrom - Optional start date for filtering (YYYY-MM-DD).
+     * @param args.dateTo - Optional end date for filtering (YYYY-MM-DD).
+     * @param args.limit - Optional limit on number of results returned.
+     * @param args.cursor - Optional cursor for pagination.
+     * @returns Search results with pagination.
+     *
+     * @example
+     * ```typescript
+     * const results = await api.search.search({
+     *   query: 'important meeting',
+     *   workspaceId: 123,
+     * })
+     * ```
+     */
+    search(args) {
+        const params = { workspace_id: args.workspaceId };
+        if (args.query !== undefined)
+            params.query = args.query;
+        if (args.channelIds)
+            params.channel_ids = args.channelIds;
+        if (args.authorIds)
+            params.author_ids = args.authorIds;
+        if (args.mentionSelf !== undefined)
+            params.mention_self = args.mentionSelf;
+        if (args.dateFrom)
+            params.date_from = args.dateFrom;
+        if (args.dateTo)
+            params.date_to = args.dateTo;
+        if (args.limit)
+            params.limit = args.limit;
+        if (args.cursor)
+            params.cursor = args.cursor;
+        return (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.getBaseUri(),
+            relativePath: endpoints_1.ENDPOINT_SEARCH,
+            apiToken: this.apiToken,
+            payload: params,
+            customFetch: this.customFetch,
+        }).then((response) => ({
+            ...response.data,
+            items: response.data.items.map((result) => entities_1.SearchResultSchema.parse(result)),
+        }));
+    }
+    /**
+     * Searches within comments of a specific thread.
+     *
+     * @param args - The arguments for searching within a thread.
+     * @param args.query - The search query string.
+     * @param args.threadId - The thread ID to search in.
+     * @param args.limit - Optional limit on number of results returned.
+     * @param args.cursor - Optional cursor for pagination.
+     * @returns Comment IDs that match the search query.
+     *
+     * @example
+     * ```typescript
+     * const results = await api.search.searchThread({
+     *   query: 'deadline',
+     *   threadId: '7YpL3oZ4kZ9vP7Q1tR2sX3z',
+     * })
+     * ```
+     */
+    searchThread(args) {
+        const params = {
+            query: args.query,
+            thread_id: args.threadId,
+        };
+        if (args.limit)
+            params.limit = args.limit;
+        if (args.cursor)
+            params.cursor = args.cursor;
+        return (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.getBaseUri(),
+            relativePath: `${endpoints_1.ENDPOINT_SEARCH}/thread`,
+            apiToken: this.apiToken,
+            payload: params,
+            customFetch: this.customFetch,
+        }).then((response) => response.data);
+    }
+    /**
+     * Searches within messages of a specific conversation.
+     *
+     * @param args - The arguments for searching within a conversation.
+     * @param args.query - The search query string.
+     * @param args.conversationId - The conversation ID to search in.
+     * @param args.limit - Optional limit on number of results returned.
+     * @param args.cursor - Optional cursor for pagination.
+     * @returns Message IDs that match the search query.
+     *
+     * @example
+     * ```typescript
+     * const results = await api.search.searchConversation({
+     *   query: 'budget',
+     *   conversationId: '7YpL3oZ4kZ9vP7Q1tR2sX42',
+     * })
+     * ```
+     */
+    searchConversation(args) {
+        const params = {
+            query: args.query,
+            conversation_id: args.conversationId,
+        };
+        if (args.limit)
+            params.limit = args.limit;
+        if (args.cursor)
+            params.cursor = args.cursor;
+        return (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.getBaseUri(),
+            relativePath: `${endpoints_1.ENDPOINT_SEARCH}/conversation`,
+            apiToken: this.apiToken,
+            payload: params,
+            customFetch: this.customFetch,
+        }).then((response) => response.data);
+    }
+}
+exports.SearchClient = SearchClient;

package/dist/cjs/clients/threads-client.js

@@ -0,0 +1,330 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ThreadsClient = exports.ThreadListSchema = void 0;
+const zod_1 = require("zod");
+const endpoints_1 = require("../consts/endpoints");
+const http_client_1 = require("../transport/http-client");
+const entities_1 = require("../types/entities");
+const uuidv7_1 = require("../utils/uuidv7");
+const add_comment_helper_1 = require("./add-comment-helper");
+const base_client_1 = require("./base-client");
+exports.ThreadListSchema = zod_1.z.array(entities_1.ThreadSchema);
+const GetUnreadResponseSchema = zod_1.z.object({
+    data: zod_1.z.array(entities_1.UnreadThreadSchema),
+    version: zod_1.z.number().int(),
+    inboxUnread: zod_1.z.number().int().nullable().optional(),
+});
+/**
+ * Client for `/api/v1/threads/`. The SDK auto-generates the thread `id` on
+ * `createThread` when the caller doesn't supply one.
+ */
+class ThreadsClient extends base_client_1.BaseClient {
+    /**
+     * Gets threads. At least one of `channelId` / `workspaceId` is required.
+     * `newerThan` / `olderThan` (`Date`) are converted to the
+     * `newer_than_ts` / `older_than_ts` epoch-second params on the wire.
+     *
+     * @param args - The arguments for getting threads.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.channelId - Optional channel ID to narrow to a single channel.
+     * @param args.archived - Optional flag to include archived threads.
+     * @param args.newerThan - Optional date to get threads newer than.
+     * @param args.olderThan - Optional date to get threads older than.
+     * @param args.limit - Optional limit on number of threads returned.
+     * @returns An array of thread objects.
+     *
+     * @example
+     * ```typescript
+     * const threads = await api.threads.getThreads({
+     *   workspaceId: 123,
+     *   channelId: '7YpL3oZ4kZ9vP7Q1tR2sX44',
+     * })
+     * threads.forEach(t => console.log(t.title))
+     * ```
+     */
+    getThreads(args) {
+        const params = { workspaceId: args.workspaceId };
+        if (args.channelId != null)
+            params.channelId = args.channelId;
+        if (args.archived != null)
+            params.archived = args.archived;
+        if (args.limit != null)
+            params.limit = args.limit;
+        if (args.newerThan)
+            params.newer_than_ts = Math.floor(args.newerThan.getTime() / 1000);
+        if (args.olderThan)
+            params.older_than_ts = Math.floor(args.olderThan.getTime() / 1000);
+        return (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.getBaseUri(),
+            relativePath: `${endpoints_1.ENDPOINT_THREADS}/get`,
+            apiToken: this.apiToken,
+            payload: params,
+            customFetch: this.customFetch,
+        }).then((response) => exports.ThreadListSchema.parse(response.data));
+    }
+    /**
+     * Gets a single thread object by id.
+     *
+     * @param id - The thread ID.
+     * @returns The thread object.
+     */
+    getThread(id) {
+        return this.simple('GET', 'getone', { id }, entities_1.ThreadSchema);
+    }
+    /**
+     * Creates a new thread in a channel. `id` is auto-generated if not supplied.
+     *
+     * @param args - The arguments for creating a thread.
+     * @param args.channelId - The channel ID.
+     * @param args.title - Optional thread title.
+     * @param args.content - The thread content.
+     * @param args.recipients - Optional array of user IDs to notify.
+     * @param args.groups - Optional array of custom group IDs to notify.
+     * @returns The created thread object.
+     *
+     * @example
+     * ```typescript
+     * const thread = await api.threads.createThread({
+     *   channelId: '7YpL3oZ4kZ9vP7Q1tR2sX44',
+     *   title: 'New Feature Discussion',
+     *   content: 'Let\'s discuss the new feature...',
+     * })
+     * ```
+     */
+    createThread(args) {
+        return this.simple('POST', 'add', { ...args, id: (0, uuidv7_1.resolveCreateId)(args.id) }, entities_1.ThreadSchema);
+    }
+    /**
+     * Partial update of an existing thread.
+     *
+     * @param args - The arguments for updating a thread.
+     * @param args.id - The thread ID.
+     * @param args.title - Optional new thread title.
+     * @param args.content - Optional new thread content.
+     * @returns The updated thread object.
+     */
+    updateThread(args) {
+        return this.simple('POST', 'update', { ...args }, entities_1.ThreadSchema);
+    }
+    /**
+     * Permanently deletes a thread.
+     *
+     * @param id - The thread ID.
+     */
+    deleteThread(id) {
+        return this.simple('POST', 'remove', { id }, entities_1.StatusOkSchema);
+    }
+    /**
+     * Saves a thread (formerly "star").
+     *
+     * @param id - The thread ID.
+     */
+    saveThread(id) {
+        return this.simple('GET', 'save', { id }, entities_1.StatusOkSchema);
+    }
+    /**
+     * Unsaves a thread (formerly "unstar").
+     *
+     * @param id - The thread ID.
+     */
+    unsaveThread(id) {
+        return this.simple('GET', 'unsave', { id }, entities_1.StatusOkSchema);
+    }
+    /**
+     * Pins a thread.
+     *
+     * @param id - The thread ID.
+     */
+    pinThread(id) {
+        return this.simple('GET', 'pin', { id }, entities_1.StatusOkSchema);
+    }
+    /**
+     * Unpins a thread.
+     *
+     * @param id - The thread ID.
+     */
+    unpinThread(id) {
+        return this.simple('GET', 'unpin', { id }, entities_1.StatusOkSchema);
+    }
+    /**
+     * Moves a thread to another channel.
+     *
+     * @param args - The arguments for moving a thread.
+     * @param args.id - The thread ID.
+     * @param args.toChannel - The target channel ID.
+     * @returns The updated thread object.
+     */
+    moveToChannel(args) {
+        return this.simple('GET', 'move_to_channel', { ...args }, entities_1.ThreadSchema);
+    }
+    /**
+     * Marks a thread as read.
+     *
+     * @param args - The arguments for marking a thread as read.
+     * @param args.id - The thread ID.
+     * @param args.objIndex - The index of the last known read message.
+     */
+    markRead(args) {
+        return this.simple('POST', 'mark_read', { ...args }, entities_1.StatusOkSchema);
+    }
+    /**
+     * Marks a thread as unread.
+     *
+     * @param args - The arguments for marking a thread as unread.
+     * @param args.id - The thread ID.
+     * @param args.objIndex - The index of the last unread message. Use -1 to mark the whole thread as unread.
+     */
+    markUnread(args) {
+        return this.simple('POST', 'mark_unread', { ...args }, entities_1.StatusOkSchema);
+    }
+    /**
+     * Marks a thread as unread for others. Useful to notify others about thread changes.
+     *
+     * @param args - The arguments for marking a thread as unread for others.
+     * @param args.id - The thread ID.
+     * @param args.objIndex - The index of the last unread message. Use -1 to mark the whole thread as unread.
+     */
+    markUnreadForOthers(args) {
+        return this.simple('POST', 'mark_unread_for_others', { ...args }, entities_1.StatusOkSchema);
+    }
+    /**
+     * Marks every thread in a workspace or channel as read. Exactly one of
+     * `workspaceId` / `channelId` should be set.
+     *
+     * @param args - Either workspaceId or channelId (one is required).
+     * @param args.workspaceId - The workspace ID.
+     * @param args.channelId - The channel ID.
+     *
+     * @example
+     * ```typescript
+     * // Mark all in workspace
+     * await api.threads.markAllRead({ workspaceId: 123 })
+     *
+     * // Mark all in channel
+     * await api.threads.markAllRead({ channelId: '7YpL3oZ4kZ9vP7Q1tR2sX44' })
+     * ```
+     */
+    markAllRead(args) {
+        if (!args.workspaceId && !args.channelId) {
+            throw new Error('Either workspaceId or channelId is required');
+        }
+        return this.simple('POST', 'mark_all_read', { ...args }, entities_1.StatusOkSchema);
+    }
+    /**
+     * Clears unread threads in a workspace.
+     *
+     * @param workspaceId - The workspace ID.
+     */
+    clearUnread(workspaceId) {
+        return this.simple('GET', 'clear_unread', { workspaceId }, entities_1.StatusOkSchema);
+    }
+    /**
+     * Returns unread threads for a workspace, paired with the unread version
+     * counter and (optionally) the inbox unread count.
+     *
+     * @param workspaceId - The workspace ID.
+     * @returns Object containing the array of unread thread references, a version counter, and optionally the inbox unread count.
+     */
+    getUnread(workspaceId) {
+        return this.simple('GET', 'get_unread', { workspaceId }, GetUnreadResponseSchema);
+    }
+    /**
+     * Mutes a thread for a specified number of minutes.
+     * When muted, you will not get notified in your inbox about new comments.
+     *
+     * @param args - The arguments for muting a thread.
+     * @param args.id - The thread ID.
+     * @param args.minutes - Number of minutes to mute the thread.
+     * @returns The updated thread object.
+     *
+     * @example
+     * ```typescript
+     * const thread = await api.threads.muteThread({ id: '7YpL3oZ4kZ9vP7Q1tR2sX3z', minutes: 30 })
+     * ```
+     */
+    muteThread(args) {
+        return this.simple('GET', 'mute', { ...args }, entities_1.ThreadSchema);
+    }
+    /**
+     * Unmutes a thread.
+     * You will start to see notifications in your inbox again when new comments are added.
+     *
+     * @param id - The thread ID.
+     * @returns The updated thread object.
+     */
+    unmuteThread(id) {
+        return this.simple('GET', 'unmute', { id }, entities_1.ThreadSchema);
+    }
+    /**
+     * Closes a thread by adding a comment with a close action.
+     *
+     * @param args - The arguments for closing a thread.
+     * @param args.id - The thread ID.
+     * @param args.content - The comment content.
+     * @param args.attachments - Optional array of {@link Attachment} objects.
+     * @param args.actions - Optional array of action objects.
+     * @param args.recipients - Optional array of user IDs to notify directly.
+     * @param args.groups - Optional array of custom group IDs to notify.
+     * @param args.directMentions - Optional array of user IDs that were @-mentioned in
+     *   `content`.
+     * @param args.notifyAudience - Optional broader audience to notify in addition to
+     *   `recipients` and `groups`. `'channel'` notifies everyone in the channel;
+     *   `'thread'` notifies everyone who has interacted with the thread.
+     * @returns The created comment object.
+     *
+     * @example
+     * ```typescript
+     * const comment = await api.threads.closeThread({
+     *   id: '7YpL3oZ4kZ9vP7Q1tR2sX3z',
+     *   content: 'Closing this thread — resolved.',
+     * })
+     * ```
+     */
+    closeThread(args) {
+        return this.addCommentWithAction(args, 'close');
+    }
+    /**
+     * Reopens a thread by adding a comment with a reopen action.
+     *
+     * @param args - The arguments for reopening a thread.
+     * @param args.id - The thread ID.
+     * @param args.content - The comment content.
+     * @param args.attachments - Optional array of {@link Attachment} objects.
+     * @param args.actions - Optional array of action objects.
+     * @param args.recipients - Optional array of user IDs to notify directly.
+     * @param args.groups - Optional array of custom group IDs to notify.
+     * @param args.directMentions - Optional array of user IDs that were @-mentioned in
+     *   `content`.
+     * @param args.notifyAudience - Optional broader audience to notify in addition to
+     *   `recipients` and `groups`. `'channel'` notifies everyone in the channel;
+     *   `'thread'` notifies everyone who has interacted with the thread.
+     * @returns The created comment object.
+     *
+     * @example
+     * ```typescript
+     * const comment = await api.threads.reopenThread({
+     *   id: '7YpL3oZ4kZ9vP7Q1tR2sX3z',
+     *   content: 'Reopening — need further discussion.',
+     * })
+     * ```
+     */
+    reopenThread(args) {
+        return this.addCommentWithAction(args, 'reopen');
+    }
+    addCommentWithAction(args, threadAction) {
+        const { id, ...rest } = args;
+        return (0, add_comment_helper_1.addCommentRequest)({ baseUri: this.getBaseUri(), apiToken: this.apiToken, customFetch: this.customFetch }, { threadId: id, ...rest }, { threadAction });
+    }
+    simple(httpMethod, suffix, params, schema) {
+        return (0, http_client_1.request)({
+            httpMethod,
+            baseUri: this.getBaseUri(),
+            relativePath: `${endpoints_1.ENDPOINT_THREADS}/${suffix}`,
+            apiToken: this.apiToken,
+            payload: params,
+            customFetch: this.customFetch,
+        }).then((response) => schema.parse(response.data));
+    }
+}
+exports.ThreadsClient = ThreadsClient;