@doist/comms-sdk 2.0.1 → 3.0.0

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

@@ -1,184 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InboxClient = exports.InboxThreadListSchema = 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 base_client_1 = require("./base-client");
-exports.InboxThreadListSchema = zod_1.z.array(entities_1.InboxThreadSchema);
-/** Client for `/api/v1/inbox/`. */
-class InboxClient extends base_client_1.BaseClient {
-    constructor() {
-        super(...arguments);
-        this.linkBaseUrl = this.getLinkBaseUrl();
-        // Reuse the shared singletons when no custom base is configured.
-        this.inboxThreadSchema = this.linkBaseUrl
-            ? (0, entities_1.createInboxThreadSchema)(this.linkBaseUrl)
-            : entities_1.InboxThreadSchema;
-        this.inboxThreadListSchema = this.linkBaseUrl
-            ? zod_1.z.array(this.inboxThreadSchema)
-            : exports.InboxThreadListSchema;
-    }
-    /**
-     * Gets inbox items (threads).
-     *
-     * @param args - The arguments for getting inbox.
-     * @param args.workspaceId - The workspace ID.
-     * @param args.newerThan - Optional date to get items newer than.
-     * @param args.olderThan - Optional date to get items older than.
-     * @param args.limit - Optional limit on number of items returned.
-     * @param args.cursor - Optional cursor for pagination.
-     * @param args.archiveFilter - Optional filter: 'active' (default), 'archived', or 'all'.
-     * @returns Inbox threads.
-     *
-     * @example
-     * ```typescript
-     * const inbox = await api.inbox.getInbox({
-     *   workspaceId: 123,
-     *   newerThan: new Date('2024-01-01'),
-     * })
-     *
-     * // Include archived (done) items alongside active ones
-     * const allInbox = await api.inbox.getInbox({
-     *   workspaceId: 123,
-     *   archiveFilter: 'all',
-     * })
-     * ```
-     */
-    getInbox(args) {
-        const params = { workspace_id: args.workspaceId };
-        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);
-        if (args.limit)
-            params.limit = args.limit;
-        if (args.cursor)
-            params.cursor = args.cursor;
-        if (args.archiveFilter)
-            params.archive_filter = args.archiveFilter;
-        return (0, http_client_1.request)({
-            httpMethod: 'GET',
-            baseUri: this.getBaseUri(),
-            relativePath: `${endpoints_1.ENDPOINT_INBOX}/get`,
-            apiToken: this.apiToken,
-            payload: params,
-            customFetch: this.customFetch,
-        }).then((response) => this.inboxThreadListSchema.parse(response.data));
-    }
-    /**
-     * Gets unread count for inbox.
-     *
-     * @param workspaceId - The workspace ID.
-     * @returns The unread count.
-     *
-     * @example
-     * ```typescript
-     * const count = await api.inbox.getCount(123)
-     * console.log(`Unread items: ${count}`)
-     * ```
-     */
-    getCount(workspaceId) {
-        return (0, http_client_1.request)({
-            httpMethod: 'GET',
-            baseUri: this.getBaseUri(),
-            relativePath: `${endpoints_1.ENDPOINT_INBOX}/get_count`,
-            apiToken: this.apiToken,
-            payload: { workspace_id: workspaceId },
-            customFetch: this.customFetch,
-        }).then((response) => response.data.data);
-    }
-    /**
-     * Archives a thread in the inbox.
-     *
-     * @param id - The thread ID.
-     *
-     * @example
-     * ```typescript
-     * await api.inbox.archiveThread('7YpL3oZ4kZ9vP7Q1tR2sX3z')
-     * ```
-     */
-    archiveThread(id) {
-        return (0, http_client_1.request)({
-            httpMethod: 'POST',
-            baseUri: this.getBaseUri(),
-            relativePath: `${endpoints_1.ENDPOINT_INBOX}/archive`,
-            apiToken: this.apiToken,
-            payload: { id },
-            customFetch: this.customFetch,
-        }).then(() => undefined);
-    }
-    /**
-     * Unarchives a thread in the inbox.
-     *
-     * @param id - The thread ID.
-     *
-     * @example
-     * ```typescript
-     * await api.inbox.unarchiveThread('7YpL3oZ4kZ9vP7Q1tR2sX3z')
-     * ```
-     */
-    unarchiveThread(id) {
-        return (0, http_client_1.request)({
-            httpMethod: 'POST',
-            baseUri: this.getBaseUri(),
-            relativePath: `${endpoints_1.ENDPOINT_INBOX}/unarchive`,
-            apiToken: this.apiToken,
-            payload: { id },
-            customFetch: this.customFetch,
-        }).then(() => undefined);
-    }
-    /**
-     * Marks all inbox items as read in a workspace.
-     *
-     * @param workspaceId - The workspace ID.
-     *
-     * @example
-     * ```typescript
-     * await api.inbox.markAllRead(123)
-     * ```
-     */
-    markAllRead(workspaceId) {
-        return (0, http_client_1.request)({
-            httpMethod: 'POST',
-            baseUri: this.getBaseUri(),
-            relativePath: `${endpoints_1.ENDPOINT_INBOX}/mark_all_read`,
-            apiToken: this.apiToken,
-            payload: { workspace_id: workspaceId },
-            customFetch: this.customFetch,
-        }).then(() => undefined);
-    }
-    /**
-     * Archives all inbox items in a workspace.
-     *
-     * @param args - The arguments for archiving all.
-     * @param args.workspaceId - The workspace ID.
-     * @param args.channelIds - Optional array of channel IDs to filter by.
-     * @param args.olderThan - Optional date to filter items older than.
-     *
-     * @example
-     * ```typescript
-     * await api.inbox.archiveAll({
-     *   workspaceId: 123,
-     *   olderThan: new Date('2024-01-01'),
-     * })
-     * ```
-     */
-    archiveAll(args) {
-        const params = { workspace_id: args.workspaceId };
-        if (args.channelIds)
-            params.channel_ids = args.channelIds;
-        if (args.olderThan)
-            params.older_than_ts = Math.floor(args.olderThan.getTime() / 1000);
-        return (0, http_client_1.request)({
-            httpMethod: 'POST',
-            baseUri: this.getBaseUri(),
-            relativePath: `${endpoints_1.ENDPOINT_INBOX}/archive_all`,
-            apiToken: this.apiToken,
-            payload: params,
-            customFetch: this.customFetch,
-        }).then(() => undefined);
-    }
-}
-exports.InboxClient = InboxClient;

package/dist/cjs/clients/notify-audience.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyNotifyAudience = applyNotifyAudience;
-const enums_1 = require("../types/enums");
-const SENTINEL_GROUP_IDS = new Set(Object.values(enums_1.NOTIFY_AUDIENCE_GROUP_IDS));
-function isNotifyAudience(value) {
-    return typeof value === 'string' && enums_1.NOTIFY_AUDIENCES.includes(value);
-}
-function collectMarkerOffenses(field, values) {
-    if (!values)
-        return null;
-    const offending = values.filter((id) => SENTINEL_GROUP_IDS.has(id));
-    return offending.length > 0 ? { field, offending } : null;
-}
-/**
- * Normalizes a `notifyAudience` flag into a sentinel `groups` entry
- * (`EVERYONE` / `EVERYONE_IN_THREAD`) and rejects callers who put those
- * reserved markers directly into `groups` / `directGroupMentions`.
- *
- * When `notifyAudience` is set it is stripped and its sentinel is appended to
- * `groups`; the backend only understands the marker in `groups`. When it is
- * unset the params are returned unchanged, preserving any explicit
- * `groups` / `directGroupMentions` (including a `null`) on the wire.
- */
-function applyNotifyAudience(params) {
-    const offenses = [
-        collectMarkerOffenses('groups', params.groups ?? undefined),
-        collectMarkerOffenses('directGroupMentions', params.directGroupMentions ?? undefined),
-    ].filter((o) => o !== null);
-    if (offenses.length > 0) {
-        const details = offenses
-            .map(({ field, offending }) => `\`${field}\` contains ${offending.join(', ')}`)
-            .join('; ');
-        throw new Error(`Reserved broadcast marker IDs found: ${details}. Pass these via \`notifyAudience\` (e.g. \`notifyAudience: 'channel'\` for EVERYONE) instead of populating \`groups\` / \`directGroupMentions\` directly.`);
-    }
-    if (params.notifyAudience == null) {
-        return params;
-    }
-    if (!isNotifyAudience(params.notifyAudience)) {
-        throw new Error(`Invalid \`notifyAudience\` value "${String(params.notifyAudience)}". Expected one of: ${enums_1.NOTIFY_AUDIENCES.join(', ')}.`);
-    }
-    const sentinel = enums_1.NOTIFY_AUDIENCE_GROUP_IDS[params.notifyAudience];
-    const { notifyAudience: _stripped, groups, ...rest } = params;
-    return { ...rest, groups: [...(groups ?? []), sentinel] };
-}

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

@@ -1,97 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReactionsClient = void 0;
-const endpoints_1 = require("../consts/endpoints");
-const http_client_1 = require("../transport/http-client");
-const base_client_1 = require("./base-client");
-function reactionTarget(args) {
-    if (args.threadId)
-        return { threadId: args.threadId };
-    if (args.commentId)
-        return { commentId: args.commentId };
-    if (args.messageId)
-        return { messageId: args.messageId };
-    throw new Error('Must provide one of: threadId, commentId, or messageId');
-}
-/**
- * Client for interacting with Comms reaction endpoints.
- */
-class ReactionsClient extends base_client_1.BaseClient {
-    /**
-     * Adds an emoji reaction to a thread, comment, or conversation message.
-     *
-     * @param args - The arguments for adding a reaction.
-     * @param args.threadId - Optional thread ID.
-     * @param args.commentId - Optional comment ID.
-     * @param args.messageId - Optional message ID (for conversation messages).
-     * @param args.reaction - The reaction emoji to add.
-     *
-     * @example
-     * ```typescript
-     * await api.reactions.add({ threadId: '7YpL3oZ4kZ9vP7Q1tR2sX3z', reaction: '👍' })
-     * ```
-     */
-    add(args) {
-        return (0, http_client_1.request)({
-            httpMethod: 'POST',
-            baseUri: this.getBaseUri(),
-            relativePath: `${endpoints_1.ENDPOINT_REACTIONS}/add`,
-            apiToken: this.apiToken,
-            payload: { ...reactionTarget(args), reaction: args.reaction },
-            customFetch: this.customFetch,
-        }).then(() => undefined);
-    }
-    /**
-     * Gets reactions for a thread, comment, or conversation message.
-     *
-     * Returns an object with emoji reactions as keys and arrays of user IDs as
-     * values, or null if no reactions.
-     *
-     * @param args - The arguments for getting reactions.
-     * @param args.threadId - Optional thread ID.
-     * @param args.commentId - Optional comment ID.
-     * @param args.messageId - Optional message ID (for conversation messages).
-     * @returns A reaction object with emoji reactions as keys and arrays of user IDs as values, or null if no reactions.
-     *
-     * @example
-     * ```typescript
-     * const reactions = await api.reactions.get({ threadId: '7YpL3oZ4kZ9vP7Q1tR2sX3z' })
-     * // Returns: { "👍": [101, 202, 303], "❤️": [101, 202] }
-     * ```
-     */
-    get(args) {
-        return (0, http_client_1.request)({
-            httpMethod: 'GET',
-            baseUri: this.getBaseUri(),
-            relativePath: `${endpoints_1.ENDPOINT_REACTIONS}/get`,
-            apiToken: this.apiToken,
-            payload: reactionTarget(args),
-            customFetch: this.customFetch,
-        }).then((response) => response.data);
-    }
-    /**
-     * Removes an emoji reaction from a thread, comment, or conversation message.
-     *
-     * @param args - The arguments for removing a reaction.
-     * @param args.threadId - Optional thread ID.
-     * @param args.commentId - Optional comment ID.
-     * @param args.messageId - Optional message ID (for conversation messages).
-     * @param args.reaction - The reaction emoji to remove.
-     *
-     * @example
-     * ```typescript
-     * await api.reactions.remove({ threadId: '7YpL3oZ4kZ9vP7Q1tR2sX3z', reaction: '👍' })
-     * ```
-     */
-    remove(args) {
-        return (0, http_client_1.request)({
-            httpMethod: 'POST',
-            baseUri: this.getBaseUri(),
-            relativePath: `${endpoints_1.ENDPOINT_REACTIONS}/remove`,
-            apiToken: this.apiToken,
-            payload: { ...reactionTarget(args), reaction: args.reaction },
-            customFetch: this.customFetch,
-        }).then(() => undefined);
-    }
-}
-exports.ReactionsClient = ReactionsClient;

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

@@ -1,138 +0,0 @@
-"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;