@doist/comms-sdk 0.0.1 → 0.2.0

package/dist/esm/clients/channels-client.js

@@ -0,0 +1,196 @@
+import { z } from 'zod';
+import { ENDPOINT_CHANNELS } from '../consts/endpoints.js';
+import { request } from '../transport/http-client.js';
+import { ChannelSchema, StatusOkSchema } from '../types/entities.js';
+import { resolveCreateId } from '../utils/uuidv7.js';
+import { BaseClient } from './base-client.js';
+export const ChannelListSchema = z.array(ChannelSchema);
+/**
+ * Client for `/api/v1/channels/`. The SDK auto-generates an `id` on
+ * `createChannel` when the caller doesn't supply one — pass your own `id`
+ * to keep an optimistic-UI ID stable through the round-trip.
+ */
+export class ChannelsClient extends BaseClient {
+    /**
+     * Gets all channels for a given workspace.
+     *
+     * @param args - The arguments for getting channels.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.archived - Optional flag to include archived channels.
+     * @returns An array of channel objects.
+     *
+     * @example
+     * ```typescript
+     * const channels = await api.channels.getChannels({ workspaceId: 123 })
+     * channels.forEach(ch => console.log(ch.name))
+     * ```
+     */
+    getChannels(args) {
+        return request({
+            httpMethod: 'GET',
+            baseUri: this.getBaseUri(),
+            relativePath: `${ENDPOINT_CHANNELS}/get`,
+            apiToken: this.apiToken,
+            payload: args,
+            customFetch: this.customFetch,
+        }).then((response) => ChannelListSchema.parse(response.data));
+    }
+    /**
+     * Gets a single channel object by id.
+     *
+     * @param id - The channel ID.
+     * @returns The channel object.
+     */
+    getChannel(id) {
+        return this.simple('GET', 'getone', { id }, ChannelSchema);
+    }
+    /**
+     * Creates a new channel. `id` is auto-generated if not supplied — pass your
+     * own `id` to keep an optimistic-UI ID stable through the round-trip.
+     *
+     * @param args - The arguments for creating a channel.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.name - The channel name.
+     * @param args.description - Optional channel description.
+     * @param args.color - Optional channel color.
+     * @param args.userIds - Optional array of user IDs to add to the channel.
+     * @param args.public - Optional flag to make the channel public.
+     * @returns The created channel object.
+     *
+     * @example
+     * ```typescript
+     * const channel = await api.channels.createChannel({
+     *   workspaceId: 123,
+     *   name: 'Engineering',
+     *   description: 'Engineering team channel',
+     * })
+     * ```
+     */
+    createChannel(args) {
+        return this.simple('POST', 'add', { ...args, id: resolveCreateId(args.id) }, ChannelSchema);
+    }
+    /**
+     * Partial update of an existing channel.
+     *
+     * @param args - The arguments for updating a channel.
+     * @param args.id - The channel ID.
+     * @param args.name - Optional new channel name.
+     * @param args.description - Optional new channel description.
+     * @param args.color - Optional new channel color.
+     * @param args.public - Optional flag to change channel visibility.
+     * @returns The updated channel object.
+     */
+    updateChannel(args) {
+        return this.simple('POST', 'update', { ...args }, ChannelSchema);
+    }
+    /**
+     * Updates the channel's view filter (`only_open` / `all` / `only_closed`).
+     *
+     * @param args - The arguments for updating the channel filter.
+     * @param args.id - The channel ID.
+     * @param args.filterClosed - The new filter value.
+     */
+    updateFilters(args) {
+        return this.simple('POST', 'update_filters', { ...args }, StatusOkSchema);
+    }
+    /**
+     * Permanently deletes a channel.
+     *
+     * @param id - The channel ID.
+     */
+    deleteChannel(id) {
+        return this.simple('POST', 'remove', { id }, StatusOkSchema);
+    }
+    /**
+     * Archives a channel.
+     *
+     * @param id - The channel ID.
+     */
+    archiveChannel(id) {
+        return this.simple('POST', 'archive', { id }, StatusOkSchema);
+    }
+    /**
+     * Unarchives a channel.
+     *
+     * @param id - The channel ID.
+     */
+    unarchiveChannel(id) {
+        return this.simple('POST', 'unarchive', { id }, StatusOkSchema);
+    }
+    /**
+     * Favorites a channel.
+     *
+     * @param id - The channel ID.
+     */
+    favoriteChannel(id) {
+        return this.simple('POST', 'favorite', { id }, StatusOkSchema);
+    }
+    /**
+     * Unfavorites a channel.
+     *
+     * @param id - The channel ID.
+     */
+    unfavoriteChannel(id) {
+        return this.simple('POST', 'unfavorite', { id }, StatusOkSchema);
+    }
+    /**
+     * Adds a user to a channel.
+     *
+     * @param args - The arguments for adding a user.
+     * @param args.id - The channel ID.
+     * @param args.userId - The user ID to add.
+     *
+     * @example
+     * ```typescript
+     * await api.channels.addUser({ id: '7YpL3oZ4kZ9vP7Q1tR2sX44', userId: 101 })
+     * ```
+     */
+    addUser(args) {
+        return this.simple('POST', 'add_user', { ...args }, ChannelSchema);
+    }
+    /**
+     * Adds multiple users to a channel.
+     *
+     * @param args - The arguments for adding users.
+     * @param args.id - The channel ID.
+     * @param args.userIds - Array of user IDs to add.
+     *
+     * @example
+     * ```typescript
+     * await api.channels.addUsers({ id: '7YpL3oZ4kZ9vP7Q1tR2sX44', userIds: [101, 202] })
+     * ```
+     */
+    addUsers(args) {
+        return this.simple('POST', 'add_users', { ...args }, ChannelSchema);
+    }
+    /**
+     * Removes a user from a channel.
+     *
+     * @param args - The arguments for removing a user.
+     * @param args.id - The channel ID.
+     * @param args.userId - The user ID to remove.
+     */
+    removeUser(args) {
+        return this.simple('POST', 'remove_user', { ...args }, ChannelSchema);
+    }
+    /**
+     * Removes multiple users from a channel.
+     *
+     * @param args - The arguments for removing users.
+     * @param args.id - The channel ID.
+     * @param args.userIds - Array of user IDs to remove.
+     */
+    removeUsers(args) {
+        return this.simple('POST', 'remove_users', { ...args }, ChannelSchema);
+    }
+    simple(httpMethod, suffix, params, schema) {
+        return request({
+            httpMethod,
+            baseUri: this.getBaseUri(),
+            relativePath: `${ENDPOINT_CHANNELS}/${suffix}`,
+            apiToken: this.apiToken,
+            payload: params,
+            customFetch: this.customFetch,
+        }).then((response) => schema.parse(response.data));
+    }
+}

package/dist/esm/clients/comments-client.js

@@ -0,0 +1,155 @@
+import { z } from 'zod';
+import { ENDPOINT_COMMENTS } from '../consts/endpoints.js';
+import { request } from '../transport/http-client.js';
+import { CommentSchema, StatusOkSchema } from '../types/entities.js';
+import { addCommentRequest } from './add-comment-helper.js';
+import { BaseClient } from './base-client.js';
+export const CommentListSchema = z.array(CommentSchema);
+/**
+ * Client for `/api/v1/comments/`. The SDK auto-generates the comment `id`
+ * on `createComment` when the caller doesn't supply one.
+ */
+export class CommentsClient extends BaseClient {
+    /**
+     * Gets all comments for a thread. `newerThan` / `olderThan` (`Date`) are
+     * converted to `newer_than_ts` / `older_than_ts` epoch seconds on the
+     * wire.
+     *
+     * @param args - The arguments for getting comments.
+     * @param args.threadId - The thread ID.
+     * @param args.newerThan - Optional date to get comments newer than.
+     * @param args.olderThan - Optional date to get comments older than.
+     * @param args.limit - Optional limit on number of comments returned.
+     * @returns An array of comment objects.
+     *
+     * @example
+     * ```typescript
+     * const comments = await api.comments.getComments({
+     *   threadId: '7YpL3oZ4kZ9vP7Q1tR2sX3z',
+     *   newerThan: new Date('2024-01-01'),
+     * })
+     * comments.forEach(c => console.log(c.content))
+     * ```
+     */
+    getComments(args) {
+        const params = { threadId: args.threadId };
+        if (args.newerThan)
+            params.newerThanTs = Math.floor(args.newerThan.getTime() / 1000);
+        if (args.olderThan)
+            params.olderThanTs = Math.floor(args.olderThan.getTime() / 1000);
+        if (args.limit)
+            params.limit = args.limit;
+        return request({
+            httpMethod: 'GET',
+            baseUri: this.getBaseUri(),
+            relativePath: `${ENDPOINT_COMMENTS}/get`,
+            apiToken: this.apiToken,
+            payload: params,
+            customFetch: this.customFetch,
+        }).then((response) => CommentListSchema.parse(response.data));
+    }
+    /**
+     * Gets a single comment object by id. The API wraps it in `{comment: ...}`.
+     *
+     * @param id - The comment ID.
+     * @returns The comment object.
+     */
+    getComment(id) {
+        const wrappedSchema = z.object({ comment: CommentSchema }).transform((data) => data.comment);
+        return request({
+            httpMethod: 'GET',
+            baseUri: this.getBaseUri(),
+            relativePath: `${ENDPOINT_COMMENTS}/getone`,
+            apiToken: this.apiToken,
+            payload: { id },
+            customFetch: this.customFetch,
+        }).then((response) => wrappedSchema.parse(response.data));
+    }
+    /**
+     * Creates a new comment on a thread. `id` is auto-generated if not supplied.
+     *
+     * @param args - The arguments for creating a comment.
+     * @param args.threadId - The thread ID.
+     * @param args.content - The comment content.
+     * @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.
+     * @param args.attachments - Optional array of {@link Attachment} objects.
+     * @returns The created comment object.
+     *
+     * @example
+     * ```typescript
+     * // Notify everyone who has interacted with the thread, plus two extra users.
+     * const comment = await api.comments.createComment({
+     *   threadId: '7YpL3oZ4kZ9vP7Q1tR2sX3z',
+     *   content: 'Great idea! Let\'s proceed.',
+     *   notifyAudience: 'thread',
+     *   recipients: [101, 202],
+     * })
+     * ```
+     */
+    createComment(args) {
+        return addCommentRequest({ baseUri: this.getBaseUri(), apiToken: this.apiToken, customFetch: this.customFetch }, args);
+    }
+    /**
+     * Updates a comment's properties.
+     *
+     * @param args - The arguments for updating a comment.
+     * @param args.id - The comment ID.
+     * @param args.content - The new comment content.
+     * @returns The updated comment object.
+     */
+    updateComment(args) {
+        return request({
+            httpMethod: 'POST',
+            baseUri: this.getBaseUri(),
+            relativePath: `${ENDPOINT_COMMENTS}/update`,
+            apiToken: this.apiToken,
+            payload: { ...args },
+            customFetch: this.customFetch,
+        }).then((response) => CommentSchema.parse(response.data));
+    }
+    /**
+     * Permanently deletes a comment.
+     *
+     * @param id - The comment ID.
+     */
+    deleteComment(id) {
+        return request({
+            httpMethod: 'POST',
+            baseUri: this.getBaseUri(),
+            relativePath: `${ENDPOINT_COMMENTS}/remove`,
+            apiToken: this.apiToken,
+            payload: { id },
+            customFetch: this.customFetch,
+        }).then((response) => StatusOkSchema.parse(response.data));
+    }
+    /**
+     * Marks the user's read position in a thread. Used to track where the user has read up to,
+     * so clients can scroll to this position and show a visual indicator (blue line).
+     * Comment IDs are strings.
+     *
+     * @param args - The arguments for marking read position.
+     * @param args.threadId - The thread ID.
+     * @param args.commentId - The comment ID to mark as the last read position.
+     *
+     * @example
+     * ```typescript
+     * await api.comments.markPosition({ threadId: '7YpL3oZ4kZ9vP7Q1tR2sX3z', commentId: '7YpL3oZ4kZ9vP7Q1tR2sX41' })
+     * ```
+     */
+    markPosition(args) {
+        return request({
+            httpMethod: 'POST',
+            baseUri: this.getBaseUri(),
+            relativePath: `${ENDPOINT_COMMENTS}/mark_position`,
+            apiToken: this.apiToken,
+            payload: { threadId: args.threadId, commentId: args.commentId },
+            customFetch: this.customFetch,
+        }).then((response) => StatusOkSchema.parse(response.data));
+    }
+}

package/dist/esm/clients/conversation-messages-client.js

@@ -0,0 +1,154 @@
+import { z } from 'zod';
+import { ENDPOINT_CONVERSATION_MESSAGES } from '../consts/endpoints.js';
+import { request } from '../transport/http-client.js';
+import { ConversationMessageSchema, StatusOkSchema, } from '../types/entities.js';
+import { resolveCreateId } from '../utils/uuidv7.js';
+import { BaseClient } from './base-client.js';
+export const ConversationMessageListSchema = z.array(ConversationMessageSchema);
+/**
+ * Client for `/api/v1/conversation_messages/`. The SDK auto-generates the
+ * message `id` on `createMessage` when the caller doesn't supply one.
+ */
+export class ConversationMessagesClient extends BaseClient {
+    /**
+     * Gets all messages in a conversation.
+     *
+     * @param args - The arguments for getting messages.
+     * @param args.conversationId - The conversation ID.
+     * @param args.newerThan - Optional date to get messages newer than.
+     * @param args.olderThan - Optional date to get messages older than.
+     * @param args.limit - Optional limit on number of messages returned.
+     * @param args.cursor - Optional cursor for pagination.
+     * @returns An array of message objects.
+     *
+     * @example
+     * ```typescript
+     * const messages = await api.conversationMessages.getMessages({
+     *   conversationId: '7YpL3oZ4kZ9vP7Q1tR2sX42',
+     *   newerThan: new Date('2024-01-01'),
+     * })
+     * ```
+     */
+    getMessages(args) {
+        const params = { conversationId: args.conversationId };
+        if (args.newerThan)
+            params.newerThanTs = Math.floor(args.newerThan.getTime() / 1000);
+        if (args.olderThan)
+            params.olderThanTs = Math.floor(args.olderThan.getTime() / 1000);
+        if (args.limit)
+            params.limit = args.limit;
+        if (args.cursor)
+            params.cursor = args.cursor;
+        return request({
+            httpMethod: 'GET',
+            baseUri: this.getBaseUri(),
+            relativePath: `${ENDPOINT_CONVERSATION_MESSAGES}/get`,
+            apiToken: this.apiToken,
+            payload: params,
+            customFetch: this.customFetch,
+        }).then((response) => ConversationMessageListSchema.parse(response.data));
+    }
+    /**
+     * Gets a single conversation message by id.
+     *
+     * @param id - The message ID.
+     * @returns The conversation message object.
+     *
+     * @example
+     * ```typescript
+     * const message = await api.conversationMessages.getMessage('7YpL3oZ4kZ9vP7Q1tR2sX43')
+     * ```
+     */
+    getMessage(id) {
+        return this.simple('GET', 'getone', { id }, ConversationMessageSchema);
+    }
+    /**
+     * Creates a new message in a conversation. `id` is auto-generated if not
+     * supplied.
+     *
+     * @param args - The arguments for creating a message.
+     * @param args.conversationId - The conversation ID.
+     * @param args.content - The message content.
+     * @param args.attachments - Optional array of {@link Attachment} objects.
+     * @param args.actions - Optional array of action objects.
+     * @returns The created message object.
+     *
+     * @example
+     * ```typescript
+     * const message = await api.conversationMessages.createMessage({
+     *   conversationId: '7YpL3oZ4kZ9vP7Q1tR2sX42',
+     *   content: 'Thanks for the update!',
+     * })
+     * ```
+     */
+    createMessage(args) {
+        const params = {
+            conversationId: args.conversationId,
+            content: args.content,
+            id: resolveCreateId(args.id),
+        };
+        if (args.attachments)
+            params.attachments = args.attachments;
+        if (args.actions)
+            params.actions = args.actions;
+        if (args.directMentions)
+            params.directMentions = args.directMentions;
+        if (args.directGroupMentions)
+            params.directGroupMentions = args.directGroupMentions;
+        if (args.notify !== undefined)
+            params.notify = args.notify;
+        return this.simple('POST', 'add', params, ConversationMessageSchema);
+    }
+    /**
+     * Updates a conversation message.
+     *
+     * @param args - The arguments for updating a message.
+     * @param args.id - The message ID.
+     * @param args.content - The new message content.
+     * @param args.attachments - Optional array of {@link Attachment} objects.
+     * @returns The updated message object.
+     *
+     * @example
+     * ```typescript
+     * const message = await api.conversationMessages.updateMessage({
+     *   id: '7YpL3oZ4kZ9vP7Q1tR2sX43',
+     *   content: 'Updated message content',
+     * })
+     * ```
+     */
+    updateMessage(args) {
+        const params = { id: args.id, content: args.content };
+        if (args.attachments)
+            params.attachments = args.attachments;
+        if (args.actions)
+            params.actions = args.actions;
+        if (args.directMentions)
+            params.directMentions = args.directMentions;
+        if (args.directGroupMentions)
+            params.directGroupMentions = args.directGroupMentions;
+        return this.simple('POST', 'update', params, ConversationMessageSchema);
+    }
+    /**
+     * Permanently deletes a conversation message.
+     *
+     * @param id - The message ID.
+     *
+     * @example
+     * ```typescript
+     * await api.conversationMessages.deleteMessage('7YpL3oZ4kZ9vP7Q1tR2sX43')
+     * ```
+     */
+    deleteMessage(id) {
+        return this.simple('POST', 'remove', { id }, StatusOkSchema);
+    }
+    simple(httpMethod, suffix, params, schema) {
+        return request({
+            httpMethod,
+            baseUri: this.getBaseUri(),
+            relativePath: `${ENDPOINT_CONVERSATION_MESSAGES}/${suffix}`,
+            apiToken: this.apiToken,
+            payload: params,
+            customFetch: this.customFetch,
+        }).then((response) => schema.parse(response.data));
+    }
+}