@doist/comms-sdk 0.2.0 → 0.2.1

package/dist/cjs/clients/add-comment-helper.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.addCommentRequest = addCommentRequest;
 const endpoints_1 = require("../consts/endpoints");
 const http_client_1 = require("../transport/http-client");
-const entities_1 = require("../types/entities");
 const enums_1 = require("../types/enums");
 const uuidv7_1 = require("../utils/uuidv7");
 const SENTINEL_GROUP_IDS = new Set(Object.values(enums_1.NOTIFY_AUDIENCE_GROUP_IDS));
@@ -66,5 +65,5 @@ function addCommentRequest(context, params, options) {
         apiToken: context.apiToken,
         payload,
         customFetch: context.customFetch,
-    }).then((response) => entities_1.CommentSchema.parse(response.data));
+    }).then((response) => context.schema.parse(response.data));
 }

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

@@ -21,5 +21,13 @@ class BaseClient {
     getBaseUri() {
         return (0, endpoints_1.getCommsBaseUri)(this.defaultVersion, this.baseUrl);
     }
+    /**
+     * Base URL for entity web links, or `undefined` to use getFullCommsURL's
+     * default web app. Trailing-slash normalization happens in
+     * `getFullCommsURL`, so the configured value is returned verbatim.
+     */
+    getLinkBaseUrl() {
+        return this.baseUrl;
+    }
 }
 exports.BaseClient = BaseClient;

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

@@ -14,6 +14,17 @@ exports.ChannelListSchema = zod_1.z.array(entities_1.ChannelSchema);
  * to keep an optimistic-UI ID stable through the round-trip.
  */
 class ChannelsClient extends base_client_1.BaseClient {
+    constructor() {
+        super(...arguments);
+        this.linkBaseUrl = this.getLinkBaseUrl();
+        // Reuse the shared singletons when no custom base is configured.
+        this.channelSchema = this.linkBaseUrl
+            ? (0, entities_1.createChannelSchema)(this.linkBaseUrl)
+            : entities_1.ChannelSchema;
+        this.channelListSchema = this.linkBaseUrl
+            ? zod_1.z.array(this.channelSchema)
+            : exports.ChannelListSchema;
+    }
     /**
      * Gets all channels for a given workspace.
      *
@@ -36,7 +47,7 @@ class ChannelsClient extends base_client_1.BaseClient {
             apiToken: this.apiToken,
             payload: args,
             customFetch: this.customFetch,
-        }).then((response) => exports.ChannelListSchema.parse(response.data));
+        }).then((response) => this.channelListSchema.parse(response.data));
     }
     /**
      * Gets a single channel object by id.
@@ -45,7 +56,7 @@ class ChannelsClient extends base_client_1.BaseClient {
      * @returns The channel object.
      */
     getChannel(id) {
-        return this.simple('GET', 'getone', { id }, entities_1.ChannelSchema);
+        return this.simple('GET', 'getone', { id }, this.channelSchema);
     }
     /**
      * Creates a new channel. `id` is auto-generated if not supplied — pass your
@@ -70,7 +81,7 @@ class ChannelsClient extends base_client_1.BaseClient {
      * ```
      */
     createChannel(args) {
-        return this.simple('POST', 'add', { ...args, id: (0, uuidv7_1.resolveCreateId)(args.id) }, entities_1.ChannelSchema);
+        return this.simple('POST', 'add', { ...args, id: (0, uuidv7_1.resolveCreateId)(args.id) }, this.channelSchema);
     }
     /**
      * Partial update of an existing channel.
@@ -84,7 +95,7 @@ class ChannelsClient extends base_client_1.BaseClient {
      * @returns The updated channel object.
      */
     updateChannel(args) {
-        return this.simple('POST', 'update', { ...args }, entities_1.ChannelSchema);
+        return this.simple('POST', 'update', { ...args }, this.channelSchema);
     }
     /**
      * Updates the channel's view filter (`only_open` / `all` / `only_closed`).
@@ -149,7 +160,7 @@ class ChannelsClient extends base_client_1.BaseClient {
      * ```
      */
     addUser(args) {
-        return this.simple('POST', 'add_user', { ...args }, entities_1.ChannelSchema);
+        return this.simple('POST', 'add_user', { ...args }, this.channelSchema);
     }
     /**
      * Adds multiple users to a channel.
@@ -164,7 +175,7 @@ class ChannelsClient extends base_client_1.BaseClient {
      * ```
      */
     addUsers(args) {
-        return this.simple('POST', 'add_users', { ...args }, entities_1.ChannelSchema);
+        return this.simple('POST', 'add_users', { ...args }, this.channelSchema);
     }
     /**
      * Removes a user from a channel.
@@ -174,7 +185,7 @@ class ChannelsClient extends base_client_1.BaseClient {
      * @param args.userId - The user ID to remove.
      */
     removeUser(args) {
-        return this.simple('POST', 'remove_user', { ...args }, entities_1.ChannelSchema);
+        return this.simple('POST', 'remove_user', { ...args }, this.channelSchema);
     }
     /**
      * Removes multiple users from a channel.
@@ -184,7 +195,7 @@ class ChannelsClient extends base_client_1.BaseClient {
      * @param args.userIds - Array of user IDs to remove.
      */
     removeUsers(args) {
-        return this.simple('POST', 'remove_users', { ...args }, entities_1.ChannelSchema);
+        return this.simple('POST', 'remove_users', { ...args }, this.channelSchema);
     }
     simple(httpMethod, suffix, params, schema) {
         return (0, http_client_1.request)({

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

@@ -13,6 +13,21 @@ exports.CommentListSchema = zod_1.z.array(entities_1.CommentSchema);
  * on `createComment` when the caller doesn't supply one.
  */
 class CommentsClient extends base_client_1.BaseClient {
+    constructor() {
+        super(...arguments);
+        this.linkBaseUrl = this.getLinkBaseUrl();
+        // Reuse the shared singletons when no custom base is configured.
+        this.commentSchema = this.linkBaseUrl
+            ? (0, entities_1.createCommentSchema)(this.linkBaseUrl)
+            : entities_1.CommentSchema;
+        this.commentListSchema = this.linkBaseUrl
+            ? zod_1.z.array(this.commentSchema)
+            : exports.CommentListSchema;
+        // `getone` wraps the comment in `{ comment: ... }`; built once per client.
+        this.wrappedCommentSchema = zod_1.z
+            .object({ comment: this.commentSchema })
+            .transform((data) => data.comment);
+    }
     /**
      * Gets all comments for a thread. `newerThan` / `olderThan` (`Date`) are
      * converted to `newer_than_ts` / `older_than_ts` epoch seconds on the
@@ -49,7 +64,7 @@ class CommentsClient extends base_client_1.BaseClient {
             apiToken: this.apiToken,
             payload: params,
             customFetch: this.customFetch,
-        }).then((response) => exports.CommentListSchema.parse(response.data));
+        }).then((response) => this.commentListSchema.parse(response.data));
     }
     /**
      * Gets a single comment object by id. The API wraps it in `{comment: ...}`.
@@ -58,7 +73,6 @@ class CommentsClient extends base_client_1.BaseClient {
      * @returns The comment object.
      */
     getComment(id) {
-        const wrappedSchema = zod_1.z.object({ comment: entities_1.CommentSchema }).transform((data) => data.comment);
         return (0, http_client_1.request)({
             httpMethod: 'GET',
             baseUri: this.getBaseUri(),
@@ -66,7 +80,7 @@ class CommentsClient extends base_client_1.BaseClient {
             apiToken: this.apiToken,
             payload: { id },
             customFetch: this.customFetch,
-        }).then((response) => wrappedSchema.parse(response.data));
+        }).then((response) => this.wrappedCommentSchema.parse(response.data));
     }
     /**
      * Creates a new comment on a thread. `id` is auto-generated if not supplied.
@@ -96,7 +110,12 @@ class CommentsClient extends base_client_1.BaseClient {
      * ```
      */
     createComment(args) {
-        return (0, add_comment_helper_1.addCommentRequest)({ baseUri: this.getBaseUri(), apiToken: this.apiToken, customFetch: this.customFetch }, args);
+        return (0, add_comment_helper_1.addCommentRequest)({
+            baseUri: this.getBaseUri(),
+            apiToken: this.apiToken,
+            customFetch: this.customFetch,
+            schema: this.commentSchema,
+        }, args);
     }
     /**
      * Updates a comment's properties.
@@ -114,7 +133,7 @@ class CommentsClient extends base_client_1.BaseClient {
             apiToken: this.apiToken,
             payload: { ...args },
             customFetch: this.customFetch,
-        }).then((response) => entities_1.CommentSchema.parse(response.data));
+        }).then((response) => this.commentSchema.parse(response.data));
     }
     /**
      * Permanently deletes a comment.

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

@@ -13,6 +13,17 @@ exports.ConversationMessageListSchema = zod_1.z.array(entities_1.ConversationMes
  * message `id` on `createMessage` when the caller doesn't supply one.
  */
 class ConversationMessagesClient extends base_client_1.BaseClient {
+    constructor() {
+        super(...arguments);
+        this.linkBaseUrl = this.getLinkBaseUrl();
+        // Reuse the shared singletons when no custom base is configured.
+        this.messageSchema = this.linkBaseUrl
+            ? (0, entities_1.createConversationMessageSchema)(this.linkBaseUrl)
+            : entities_1.ConversationMessageSchema;
+        this.messageListSchema = this.linkBaseUrl
+            ? zod_1.z.array(this.messageSchema)
+            : exports.ConversationMessageListSchema;
+    }
     /**
      * Gets all messages in a conversation.
      *
@@ -49,7 +60,7 @@ class ConversationMessagesClient extends base_client_1.BaseClient {
             apiToken: this.apiToken,
             payload: params,
             customFetch: this.customFetch,
-        }).then((response) => exports.ConversationMessageListSchema.parse(response.data));
+        }).then((response) => this.messageListSchema.parse(response.data));
     }
     /**
      * Gets a single conversation message by id.
@@ -63,7 +74,7 @@ class ConversationMessagesClient extends base_client_1.BaseClient {
      * ```
      */
     getMessage(id) {
-        return this.simple('GET', 'getone', { id }, entities_1.ConversationMessageSchema);
+        return this.simple('GET', 'getone', { id }, this.messageSchema);
     }
     /**
      * Creates a new message in a conversation. `id` is auto-generated if not
@@ -100,7 +111,7 @@ class ConversationMessagesClient extends base_client_1.BaseClient {
             params.directGroupMentions = args.directGroupMentions;
         if (args.notify !== undefined)
             params.notify = args.notify;
-        return this.simple('POST', 'add', params, entities_1.ConversationMessageSchema);
+        return this.simple('POST', 'add', params, this.messageSchema);
     }
     /**
      * Updates a conversation message.
@@ -129,7 +140,7 @@ class ConversationMessagesClient extends base_client_1.BaseClient {
             params.directMentions = args.directMentions;
         if (args.directGroupMentions)
             params.directGroupMentions = args.directGroupMentions;
-        return this.simple('POST', 'update', params, entities_1.ConversationMessageSchema);
+        return this.simple('POST', 'update', params, this.messageSchema);
     }
     /**
      * Permanently deletes a conversation message.

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

@@ -19,6 +19,17 @@ const GetUnreadResponseSchema = zod_1.z.object({
  * already-assigned `id` and your generated one is silently dropped.
  */
 class ConversationsClient extends base_client_1.BaseClient {
+    constructor() {
+        super(...arguments);
+        this.linkBaseUrl = this.getLinkBaseUrl();
+        // Reuse the shared singletons when no custom base is configured.
+        this.conversationSchema = this.linkBaseUrl
+            ? (0, entities_1.createConversationSchema)(this.linkBaseUrl)
+            : entities_1.ConversationSchema;
+        this.conversationListSchema = this.linkBaseUrl
+            ? zod_1.z.array(this.conversationSchema)
+            : exports.ConversationListSchema;
+    }
     /**
      * Gets all conversations for a workspace.
      *
@@ -41,7 +52,7 @@ class ConversationsClient extends base_client_1.BaseClient {
             apiToken: this.apiToken,
             payload: args,
             customFetch: this.customFetch,
-        }).then((response) => exports.ConversationListSchema.parse(response.data));
+        }).then((response) => this.conversationListSchema.parse(response.data));
     }
     /**
      * Gets a single conversation object by id.
@@ -50,7 +61,7 @@ class ConversationsClient extends base_client_1.BaseClient {
      * @returns The conversation object.
      */
     getConversation(id) {
-        return this.simple('GET', 'getone', { id }, entities_1.ConversationSchema);
+        return this.simple('GET', 'getone', { id }, this.conversationSchema);
     }
     /**
      * Gets an existing 1:1 / group conversation with `userIds`, or creates a
@@ -71,7 +82,7 @@ class ConversationsClient extends base_client_1.BaseClient {
      * ```
      */
     getOrCreateConversation(args) {
-        return this.simple('GET', 'get_or_create', { ...args, id: (0, uuidv7_1.resolveCreateId)(args.id) }, entities_1.ConversationSchema);
+        return this.simple('GET', 'get_or_create', { ...args, id: (0, uuidv7_1.resolveCreateId)(args.id) }, this.conversationSchema);
     }
     /**
      * Updates a conversation's title.
@@ -94,7 +105,7 @@ class ConversationsClient extends base_client_1.BaseClient {
         const params = { id: args.id, title: args.title };
         if (args.archived !== undefined)
             params.archived = args.archived;
-        return this.simple('POST', 'update', params, entities_1.ConversationSchema);
+        return this.simple('POST', 'update', params, this.conversationSchema);
     }
     /**
      * Archives a conversation.
@@ -103,7 +114,7 @@ class ConversationsClient extends base_client_1.BaseClient {
      * @returns The updated conversation object.
      */
     archiveConversation(id) {
-        return this.simple('GET', 'archive', { id }, entities_1.ConversationSchema);
+        return this.simple('GET', 'archive', { id }, this.conversationSchema);
     }
     /**
      * Unarchives a conversation.
@@ -112,7 +123,7 @@ class ConversationsClient extends base_client_1.BaseClient {
      * @returns The updated conversation object.
      */
     unarchiveConversation(id) {
-        return this.simple('GET', 'unarchive', { id }, entities_1.ConversationSchema);
+        return this.simple('GET', 'unarchive', { id }, this.conversationSchema);
     }
     /**
      * Adds a user to a conversation.
@@ -123,7 +134,7 @@ class ConversationsClient extends base_client_1.BaseClient {
      * @returns The updated conversation object.
      */
     addUser(args) {
-        return this.simple('POST', 'add_user', { ...args }, entities_1.ConversationSchema);
+        return this.simple('POST', 'add_user', { ...args }, this.conversationSchema);
     }
     /**
      * Adds multiple users to a conversation.
@@ -139,7 +150,7 @@ class ConversationsClient extends base_client_1.BaseClient {
      * ```
      */
     addUsers(args) {
-        return this.simple('POST', 'add_users', { ...args }, entities_1.ConversationSchema);
+        return this.simple('POST', 'add_users', { ...args }, this.conversationSchema);
     }
     /**
      * Removes a user from a conversation.
@@ -150,7 +161,7 @@ class ConversationsClient extends base_client_1.BaseClient {
      * @returns The updated conversation object.
      */
     removeUser(args) {
-        return this.simple('POST', 'remove_user', { ...args }, entities_1.ConversationSchema);
+        return this.simple('POST', 'remove_user', { ...args }, this.conversationSchema);
     }
     /**
      * Removes multiple users from a conversation.
@@ -161,7 +172,7 @@ class ConversationsClient extends base_client_1.BaseClient {
      * @returns The updated conversation object.
      */
     removeUsers(args) {
-        return this.simple('POST', 'remove_users', { ...args }, entities_1.ConversationSchema);
+        return this.simple('POST', 'remove_users', { ...args }, this.conversationSchema);
     }
     /**
      * Marks a conversation as read.
@@ -218,7 +229,7 @@ class ConversationsClient extends base_client_1.BaseClient {
      * ```
      */
     muteConversation(args) {
-        return this.simple('GET', 'mute', { ...args }, entities_1.ConversationSchema);
+        return this.simple('GET', 'mute', { ...args }, this.conversationSchema);
     }
     /**
      * Unmutes a conversation.
@@ -227,7 +238,7 @@ class ConversationsClient extends base_client_1.BaseClient {
      * @returns The updated conversation object.
      */
     unmuteConversation(id) {
-        return this.simple('GET', 'unmute', { id }, entities_1.ConversationSchema);
+        return this.simple('GET', 'unmute', { id }, this.conversationSchema);
     }
     simple(httpMethod, suffix, params, schema) {
         return (0, http_client_1.request)({

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

@@ -1,12 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InboxClient = void 0;
+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).
      *
@@ -52,7 +65,7 @@ class InboxClient extends base_client_1.BaseClient {
             apiToken: this.apiToken,
             payload: params,
             customFetch: this.customFetch,
-        }).then((response) => response.data.map((thread) => entities_1.InboxThreadSchema.parse(thread)));
+        }).then((response) => this.inboxThreadListSchema.parse(response.data));
     }
     /**
      * Gets unread count for inbox.

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

@@ -19,6 +19,20 @@ const GetUnreadResponseSchema = zod_1.z.object({
  * `createThread` when the caller doesn't supply one.
  */
 class ThreadsClient extends base_client_1.BaseClient {
+    constructor() {
+        super(...arguments);
+        this.linkBaseUrl = this.getLinkBaseUrl();
+        // Reuse the shared singletons when no custom base is configured.
+        this.threadSchema = this.linkBaseUrl
+            ? (0, entities_1.createThreadSchema)(this.linkBaseUrl)
+            : entities_1.ThreadSchema;
+        this.threadListSchema = this.linkBaseUrl
+            ? zod_1.z.array(this.threadSchema)
+            : exports.ThreadListSchema;
+        this.commentSchema = this.linkBaseUrl
+            ? (0, entities_1.createCommentSchema)(this.linkBaseUrl)
+            : entities_1.CommentSchema;
+    }
     /**
      * Gets threads. At least one of `channelId` / `workspaceId` is required.
      * `newerThan` / `olderThan` (`Date`) are converted to the
@@ -61,7 +75,7 @@ class ThreadsClient extends base_client_1.BaseClient {
             apiToken: this.apiToken,
             payload: params,
             customFetch: this.customFetch,
-        }).then((response) => exports.ThreadListSchema.parse(response.data));
+        }).then((response) => this.threadListSchema.parse(response.data));
     }
     /**
      * Gets a single thread object by id.
@@ -70,7 +84,7 @@ class ThreadsClient extends base_client_1.BaseClient {
      * @returns The thread object.
      */
     getThread(id) {
-        return this.simple('GET', 'getone', { id }, entities_1.ThreadSchema);
+        return this.simple('GET', 'getone', { id }, this.threadSchema);
     }
     /**
      * Creates a new thread in a channel. `id` is auto-generated if not supplied.
@@ -93,7 +107,7 @@ class ThreadsClient extends base_client_1.BaseClient {
      * ```
      */
     createThread(args) {
-        return this.simple('POST', 'add', { ...args, id: (0, uuidv7_1.resolveCreateId)(args.id) }, entities_1.ThreadSchema);
+        return this.simple('POST', 'add', { ...args, id: (0, uuidv7_1.resolveCreateId)(args.id) }, this.threadSchema);
     }
     /**
      * Partial update of an existing thread.
@@ -105,7 +119,7 @@ class ThreadsClient extends base_client_1.BaseClient {
      * @returns The updated thread object.
      */
     updateThread(args) {
-        return this.simple('POST', 'update', { ...args }, entities_1.ThreadSchema);
+        return this.simple('POST', 'update', { ...args }, this.threadSchema);
     }
     /**
      * Permanently deletes a thread.
@@ -156,7 +170,7 @@ class ThreadsClient extends base_client_1.BaseClient {
      * @returns The updated thread object.
      */
     moveToChannel(args) {
-        return this.simple('GET', 'move_to_channel', { ...args }, entities_1.ThreadSchema);
+        return this.simple('GET', 'move_to_channel', { ...args }, this.threadSchema);
     }
     /**
      * Marks a thread as read.
@@ -244,7 +258,7 @@ class ThreadsClient extends base_client_1.BaseClient {
      * ```
      */
     muteThread(args) {
-        return this.simple('GET', 'mute', { ...args }, entities_1.ThreadSchema);
+        return this.simple('GET', 'mute', { ...args }, this.threadSchema);
     }
     /**
      * Unmutes a thread.
@@ -254,7 +268,7 @@ class ThreadsClient extends base_client_1.BaseClient {
      * @returns The updated thread object.
      */
     unmuteThread(id) {
-        return this.simple('GET', 'unmute', { id }, entities_1.ThreadSchema);
+        return this.simple('GET', 'unmute', { id }, this.threadSchema);
     }
     /**
      * Closes a thread by adding a comment with a close action.
@@ -314,7 +328,12 @@ class ThreadsClient extends base_client_1.BaseClient {
     }
     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 });
+        return (0, add_comment_helper_1.addCommentRequest)({
+            baseUri: this.getBaseUri(),
+            apiToken: this.apiToken,
+            customFetch: this.customFetch,
+            schema: this.commentSchema,
+        }, { threadId: id, ...rest }, { threadAction });
     }
     simple(httpMethod, suffix, params, schema) {
         return (0, http_client_1.request)({

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

@@ -12,6 +12,14 @@ exports.ChannelListSchema = zod_1.z.array(entities_1.ChannelSchema);
  * currently rejects any `color` other than `1` on add/update.
  */
 class WorkspacesClient extends base_client_1.BaseClient {
+    constructor() {
+        super(...arguments);
+        this.linkBaseUrl = this.getLinkBaseUrl();
+        // Reuse the shared singleton when no custom base is configured.
+        this.channelListSchema = this.linkBaseUrl
+            ? zod_1.z.array((0, entities_1.createChannelSchema)(this.linkBaseUrl))
+            : exports.ChannelListSchema;
+    }
     /**
      * Gets all the user's workspaces.
      *
@@ -160,7 +168,7 @@ class WorkspacesClient extends base_client_1.BaseClient {
             apiToken: this.apiToken,
             payload: { id },
             customFetch: this.customFetch,
-        }).then((response) => exports.ChannelListSchema.parse(response.data));
+        }).then((response) => this.channelListSchema.parse(response.data));
     }
 }
 exports.WorkspacesClient = WorkspacesClient;