@doist/twist-sdk 2.7.0 → 2.8.1

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

@@ -38,7 +38,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 import { z } from 'zod';
 import { ENDPOINT_THREADS } from '../consts/endpoints.js';
 import { request } from '../transport/http-client.js';
-import { ThreadSchema, UnreadThreadSchema, } from '../types/entities.js';
+import { createCommentSchema, createThreadSchema, UnreadThreadSchema, } from '../types/entities.js';
 import { addCommentRequest } from './add-comment-helper.js';
 import { BaseClient } from './base-client.js';
 /**
@@ -47,9 +47,13 @@ import { BaseClient } from './base-client.js';
 var ThreadsClient = /** @class */ (function (_super) {
     __extends(ThreadsClient, _super);
     function ThreadsClient() {
-        return _super !== null && _super.apply(this, arguments) || this;
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.threadSchema = createThreadSchema(_this.getLinkBaseUrl());
+        _this.commentSchema = createCommentSchema(_this.getLinkBaseUrl());
+        return _this;
     }
     ThreadsClient.prototype.getThreads = function (args, options) {
+        var _this = this;
         var method = 'GET';
         var url = "".concat(ENDPOINT_THREADS, "/get");
         var newerThan = args.newerThan, olderThan = args.olderThan, newer_than_ts = args.newer_than_ts, older_than_ts = args.older_than_ts, rest = __rest(args, ["newerThan", "olderThan", "newer_than_ts", "older_than_ts"]);
@@ -57,7 +61,7 @@ var ThreadsClient = /** @class */ (function (_super) {
         var resolvedOlderThan = olderThan ? Math.floor(olderThan.getTime() / 1000) : older_than_ts;
         var params = __assign(__assign(__assign({}, rest), (resolvedNewerThan != null ? { newer_than_ts: resolvedNewerThan } : {})), (resolvedOlderThan != null ? { older_than_ts: resolvedOlderThan } : {}));
         if (options === null || options === void 0 ? void 0 : options.batch) {
-            return { method: method, url: url, params: params, schema: z.array(ThreadSchema) };
+            return { method: method, url: url, params: params, schema: z.array(this.threadSchema) };
         }
         return request({
             httpMethod: method,
@@ -66,13 +70,13 @@ var ThreadsClient = /** @class */ (function (_super) {
             apiToken: this.apiToken,
             payload: params,
             customFetch: this.customFetch,
-        }).then(function (response) { return response.data.map(function (thread) { return ThreadSchema.parse(thread); }); });
+        }).then(function (response) { return response.data.map(function (thread) { return _this.threadSchema.parse(thread); }); });
     };
     ThreadsClient.prototype.getThread = function (id, options) {
         var method = 'GET';
         var url = "".concat(ENDPOINT_THREADS, "/getone");
         var params = { id: id };
-        var schema = ThreadSchema;
+        var schema = this.threadSchema;
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params, schema: schema };
         }
@@ -89,7 +93,7 @@ var ThreadsClient = /** @class */ (function (_super) {
         var method = 'POST';
         var url = "".concat(ENDPOINT_THREADS, "/add");
         var params = args;
-        var schema = ThreadSchema;
+        var schema = this.threadSchema;
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params, schema: schema };
         }
@@ -106,7 +110,7 @@ var ThreadsClient = /** @class */ (function (_super) {
         var method = 'POST';
         var url = "".concat(ENDPOINT_THREADS, "/update");
         var params = args;
-        var schema = ThreadSchema;
+        var schema = this.threadSchema;
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params, schema: schema };
         }
@@ -354,7 +358,7 @@ var ThreadsClient = /** @class */ (function (_super) {
         var method = 'POST';
         var url = "".concat(ENDPOINT_THREADS, "/mute");
         var params = { id: args.id, minutes: args.minutes };
-        var schema = ThreadSchema;
+        var schema = this.threadSchema;
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params, schema: schema };
         }
@@ -371,7 +375,7 @@ var ThreadsClient = /** @class */ (function (_super) {
         var method = 'POST';
         var url = "".concat(ENDPOINT_THREADS, "/unmute");
         var params = { id: id };
-        var schema = ThreadSchema;
+        var schema = this.threadSchema;
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params, schema: schema };
         }
@@ -392,7 +396,12 @@ var ThreadsClient = /** @class */ (function (_super) {
     };
     ThreadsClient.prototype.addCommentWithAction = function (args, threadAction, options) {
         var id = args.id, rest = __rest(args, ["id"]);
-        return addCommentRequest({ baseUri: this.getBaseUri(), apiToken: this.apiToken, customFetch: this.customFetch }, __assign({ threadId: id }, rest), __assign(__assign({}, options), { threadAction: threadAction }));
+        return addCommentRequest({
+            baseUri: this.getBaseUri(),
+            apiToken: this.apiToken,
+            customFetch: this.customFetch,
+            schema: this.commentSchema,
+        }, __assign({ threadId: id }, rest), __assign(__assign({}, options), { threadAction: threadAction }));
     };
     return ThreadsClient;
 }(BaseClient));

package/dist/esm/clients/workspace-users-client.js

@@ -13,6 +13,7 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
+import { z } from 'zod';
 import { request } from '../transport/http-client.js';
 import { WorkspaceUserSchema } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
@@ -25,11 +26,17 @@ var WorkspaceUsersClient = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     WorkspaceUsersClient.prototype.getWorkspaceUsers = function (args, options) {
+        var _a;
         var method = 'GET';
         var url = 'workspace_users/get';
         var params = { id: args.workspaceId, archived: args.archived };
+        var includeRemoved = (_a = args.includeRemoved) !== null && _a !== void 0 ? _a : false;
+        function filterRemoved(users) {
+            return includeRemoved ? users : users.filter(function (user) { return !user.removed; });
+        }
+        var responseSchema = z.array(WorkspaceUserSchema).transform(filterRemoved);
         if (options === null || options === void 0 ? void 0 : options.batch) {
-            return { method: method, url: url, params: params };
+            return { method: method, url: url, params: params, schema: responseSchema };
         }
         return request({
             httpMethod: method,
@@ -38,7 +45,7 @@ var WorkspaceUsersClient = /** @class */ (function (_super) {
             apiToken: this.apiToken,
             payload: params,
             customFetch: this.customFetch,
-        }).then(function (response) { return response.data.map(function (user) { return WorkspaceUserSchema.parse(user); }); });
+        }).then(function (response) { return responseSchema.parse(response.data); });
     };
     WorkspaceUsersClient.prototype.getWorkspaceUserIds = function (workspaceId, options) {
         var method = 'GET';

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

@@ -13,9 +13,10 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
+import { z } from 'zod';
 import { ENDPOINT_WORKSPACES } from '../consts/endpoints.js';
 import { request } from '../transport/http-client.js';
-import { ChannelSchema, WorkspaceSchema } from '../types/entities.js';
+import { createChannelSchema, WorkspaceSchema } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 /**
  * Client for interacting with Twist workspace endpoints.
@@ -23,7 +24,9 @@ import { BaseClient } from './base-client.js';
 var WorkspacesClient = /** @class */ (function (_super) {
     __extends(WorkspacesClient, _super);
     function WorkspacesClient() {
-        return _super !== null && _super.apply(this, arguments) || this;
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.channelSchema = createChannelSchema(_this.getLinkBaseUrl());
+        return _this;
     }
     WorkspacesClient.prototype.getWorkspaces = function (options) {
         var method = 'GET';
@@ -126,11 +129,12 @@ var WorkspacesClient = /** @class */ (function (_super) {
         }).then(function () { return undefined; });
     };
     WorkspacesClient.prototype.getPublicChannels = function (id, options) {
+        var _this = this;
         var method = 'GET';
         var url = "".concat(ENDPOINT_WORKSPACES, "/get_public_channels");
         var params = { id: id };
         if (options === null || options === void 0 ? void 0 : options.batch) {
-            return { method: method, url: url, params: params };
+            return { method: method, url: url, params: params, schema: z.array(this.channelSchema) };
         }
         return request({
             httpMethod: method,
@@ -139,7 +143,7 @@ var WorkspacesClient = /** @class */ (function (_super) {
             apiToken: this.apiToken,
             payload: params,
             customFetch: this.customFetch,
-        }).then(function (response) { return response.data.map(function (channel) { return ChannelSchema.parse(channel); }); });
+        }).then(function (response) { return response.data.map(function (channel) { return _this.channelSchema.parse(channel); }); });
     };
     return WorkspacesClient;
 }(BaseClient));

package/dist/esm/types/entities.js

@@ -109,8 +109,7 @@ export var WorkspaceSchema = z.object({
     plan: z.enum(WORKSPACE_PLANS).nullable().optional(),
 });
 // Channel entity from API
-export var ChannelSchema = z
-    .object({
+export var ChannelObjectSchema = z.object({
     id: z.number(),
     name: z.string(),
     description: z.string().nullable().optional(),
@@ -128,11 +127,13 @@ export var ChannelSchema = z
     icon: z.number().nullable().optional(),
     version: z.number(),
     filters: z.record(z.string(), z.string()).nullable().optional(),
-})
-    .transform(function (data) { return (__assign(__assign({}, data), { url: getFullTwistURL({ workspaceId: data.workspaceId, channelId: data.id }) })); });
+});
+export function createChannelSchema(linkBaseUrl) {
+    return ChannelObjectSchema.transform(function (data) { return (__assign(__assign({}, data), { url: getFullTwistURL({ workspaceId: data.workspaceId, channelId: data.id }, linkBaseUrl) })); });
+}
+export var ChannelSchema = createChannelSchema();
 // Thread entity from API
-export var ThreadSchema = z
-    .object({
+export var ThreadObjectSchema = z.object({
     id: z.number(),
     title: z.string(),
     content: z.string(),
@@ -195,12 +196,15 @@ export var ThreadSchema = z
     })
         .nullable()
         .optional(),
-})
-    .transform(function (data) { return (__assign(__assign({}, data), { url: getFullTwistURL({
-        workspaceId: data.workspaceId,
-        channelId: data.channelId,
-        threadId: data.id,
-    }) })); });
+});
+export function createThreadSchema(linkBaseUrl) {
+    return ThreadObjectSchema.transform(function (data) { return (__assign(__assign({}, data), { url: getFullTwistURL({
+            workspaceId: data.workspaceId,
+            channelId: data.channelId,
+            threadId: data.id,
+        }, linkBaseUrl) })); });
+}
+export var ThreadSchema = createThreadSchema();
 // Group entity from API
 export var GroupSchema = z.object({
     id: z.number(),
@@ -211,8 +215,7 @@ export var GroupSchema = z.object({
     version: z.number(),
 });
 // Conversation entity from API
-export var ConversationSchema = z
-    .object({
+export var ConversationObjectSchema = z.object({
     id: z.number(),
     workspaceId: z.number(),
     userIds: z.array(z.number()),
@@ -248,11 +251,13 @@ export var ConversationSchema = z
     })
         .nullable()
         .optional(),
-})
-    .transform(function (data) { return (__assign(__assign({}, data), { url: getFullTwistURL({ workspaceId: data.workspaceId, conversationId: data.id }) })); });
+});
+export function createConversationSchema(linkBaseUrl) {
+    return ConversationObjectSchema.transform(function (data) { return (__assign(__assign({}, data), { url: getFullTwistURL({ workspaceId: data.workspaceId, conversationId: data.id }, linkBaseUrl) })); });
+}
+export var ConversationSchema = createConversationSchema();
 // Comment entity from API
-export var CommentSchema = z
-    .object({
+export var CommentObjectSchema = z.object({
     id: z.number(),
     content: z.string(),
     creator: z.number(),
@@ -277,13 +282,16 @@ export var CommentSchema = z
     deletedBy: z.number().nullable().optional(),
     version: z.number().nullable().optional(),
     actions: z.array(z.unknown()).nullable().optional(),
-})
-    .transform(function (data) { return (__assign(__assign({}, data), { url: getFullTwistURL({
-        workspaceId: data.workspaceId,
-        channelId: data.channelId,
-        threadId: data.threadId,
-        commentId: data.id,
-    }) })); });
+});
+export function createCommentSchema(linkBaseUrl) {
+    return CommentObjectSchema.transform(function (data) { return (__assign(__assign({}, data), { url: getFullTwistURL({
+            workspaceId: data.workspaceId,
+            channelId: data.channelId,
+            threadId: data.threadId,
+            commentId: data.id,
+        }, linkBaseUrl) })); });
+}
+export var CommentSchema = createCommentSchema();
 // WorkspaceUser entity from v4 API
 export var WorkspaceUserSchema = BaseUserSchema.extend({
     email: z.string().nullable().optional(),
@@ -295,8 +303,7 @@ export var WorkspaceUserSchema = BaseUserSchema.extend({
     version: z.number(),
 });
 // ConversationMessage entity from API
-export var ConversationMessageSchema = z
-    .object({
+export var ConversationMessageObjectSchema = z.object({
     id: z.number(),
     content: z.string(),
     creator: z.number(),
@@ -313,58 +320,65 @@ export var ConversationMessageSchema = z
     directMentions: z.array(z.number()).nullable().optional(),
     version: z.number().nullable().optional(),
     workspaceId: z.number(),
-})
-    .transform(function (data) { return (__assign(__assign({}, data), { url: getFullTwistURL({
-        workspaceId: data.workspaceId,
-        conversationId: data.conversationId,
-        messageId: data.id,
-    }) })); });
+});
+export function createConversationMessageSchema(linkBaseUrl) {
+    return ConversationMessageObjectSchema.transform(function (data) { return (__assign(__assign({}, data), { url: getFullTwistURL({
+            workspaceId: data.workspaceId,
+            conversationId: data.conversationId,
+            messageId: data.id,
+        }, linkBaseUrl) })); });
+}
+export var ConversationMessageSchema = createConversationMessageSchema();
 // InboxThread entity from API - returns full Thread objects with additional inbox metadata
-export var InboxThreadSchema = z
-    .object({
-    id: z.number(),
-    title: z.string(),
-    content: z.string(),
-    creator: z.number(),
-    creatorName: z.string().nullable().optional(),
-    channelId: z.number(),
-    workspaceId: z.number(),
-    actions: z.array(z.unknown()).nullable().optional(),
-    attachments: z.array(AttachmentSchema).nullable().optional(),
-    commentCount: z.number(),
-    directGroupMentions: z.array(z.number()).nullable().optional(),
-    directMentions: z.array(z.number()).nullable().optional(),
-    groups: z.array(z.number()).nullable().optional(),
-    lastEdited: z.date().nullable().optional(),
-    lastObjIndex: z.number().nullable().optional(),
-    lastUpdated: z.date(),
-    mutedUntil: z.date().nullable().optional(),
-    participants: z.array(z.number()).nullable().optional(),
-    pinned: z.boolean(),
-    pinnedDate: z.date().nullable().optional(),
-    posted: z.date(),
-    reactions: z.record(z.string(), z.array(z.number())).nullable().optional(),
-    recipients: z.array(z.number()).nullable().optional(),
-    snippet: z.string(),
-    snippetCreator: z.number(),
-    snippetMaskAvatarUrl: z.string().nullable().optional(),
-    snippetMaskPoster: z.string().nullable().optional(),
-    starred: z.boolean(),
-    systemMessage: SystemMessageSchema,
-    isArchived: z.boolean(),
-    inInbox: z.boolean(),
-    isSaved: z.boolean().nullable().optional(),
-    closed: z.boolean(),
-    responders: z.array(z.number()).nullable().optional(),
-    lastComment: CommentSchema.nullable().optional(),
-    toEmails: z.array(z.string()).nullable().optional(),
-    version: z.number().nullable().optional(),
-})
-    .transform(function (data) { return (__assign(__assign({}, data), { url: getFullTwistURL({
-        workspaceId: data.workspaceId,
-        channelId: data.channelId,
-        threadId: data.id,
-    }) })); });
+function createInboxThreadObjectSchema(linkBaseUrl) {
+    return z.object({
+        id: z.number(),
+        title: z.string(),
+        content: z.string(),
+        creator: z.number(),
+        creatorName: z.string().nullable().optional(),
+        channelId: z.number(),
+        workspaceId: z.number(),
+        actions: z.array(z.unknown()).nullable().optional(),
+        attachments: z.array(AttachmentSchema).nullable().optional(),
+        commentCount: z.number(),
+        directGroupMentions: z.array(z.number()).nullable().optional(),
+        directMentions: z.array(z.number()).nullable().optional(),
+        groups: z.array(z.number()).nullable().optional(),
+        lastEdited: z.date().nullable().optional(),
+        lastObjIndex: z.number().nullable().optional(),
+        lastUpdated: z.date(),
+        mutedUntil: z.date().nullable().optional(),
+        participants: z.array(z.number()).nullable().optional(),
+        pinned: z.boolean(),
+        pinnedDate: z.date().nullable().optional(),
+        posted: z.date(),
+        reactions: z.record(z.string(), z.array(z.number())).nullable().optional(),
+        recipients: z.array(z.number()).nullable().optional(),
+        snippet: z.string(),
+        snippetCreator: z.number(),
+        snippetMaskAvatarUrl: z.string().nullable().optional(),
+        snippetMaskPoster: z.string().nullable().optional(),
+        starred: z.boolean(),
+        systemMessage: SystemMessageSchema,
+        isArchived: z.boolean(),
+        inInbox: z.boolean(),
+        isSaved: z.boolean().nullable().optional(),
+        closed: z.boolean(),
+        responders: z.array(z.number()).nullable().optional(),
+        lastComment: createCommentSchema(linkBaseUrl).nullable().optional(),
+        toEmails: z.array(z.string()).nullable().optional(),
+        version: z.number().nullable().optional(),
+    });
+}
+export function createInboxThreadSchema(linkBaseUrl) {
+    return createInboxThreadObjectSchema(linkBaseUrl).transform(function (data) { return (__assign(__assign({}, data), { url: getFullTwistURL({
+            workspaceId: data.workspaceId,
+            channelId: data.channelId,
+            threadId: data.id,
+        }, linkBaseUrl) })); });
+}
+export var InboxThreadSchema = createInboxThreadSchema();
 // UnreadThread entity from API - simplified thread reference for unread threads
 export var UnreadThreadSchema = z.object({
     threadId: z.number(),

package/dist/types/clients/add-comment-helper.d.ts

@@ -1,11 +1,13 @@
 import type { BatchRequestDescriptor } from '../types/batch.js';
-import { type Comment } from '../types/entities.js';
+import { type Comment, type createCommentSchema } from '../types/entities.js';
 import type { CustomFetch } from '../types/http.js';
 import type { CreateCommentArgs, ThreadAction } from '../types/requests.js';
 type ClientContext = {
     baseUri: string;
     apiToken: string;
     customFetch?: CustomFetch;
+    /** Per-client Comment schema, base-bound for the returned comment's web `url`. */
+    schema: ReturnType<typeof createCommentSchema>;
 };
 export declare function addCommentRequest(context: ClientContext, params: CreateCommentArgs, options?: {
     batch?: boolean;

package/dist/types/clients/base-client.d.ts

@@ -28,4 +28,8 @@ export declare class BaseClient {
      * @returns Base URI with guaranteed trailing slash for proper URL resolution
      */
     protected getBaseUri(version?: ApiVersion): string;
+    /**
+     * Base URL for entity web links, or `undefined` to use getFullTwistURL's default web app.
+     */
+    protected getLinkBaseUrl(): string | undefined;
 }

package/dist/types/clients/channels-client.d.ts

@@ -6,6 +6,7 @@ import { BaseClient } from './base-client.js';
  * Client for interacting with Twist channel endpoints.
  */
 export declare class ChannelsClient extends BaseClient {
+    private readonly channelSchema;
     /**
      * Gets all channels for a given workspace.
      *

package/dist/types/clients/comments-client.d.ts

@@ -6,6 +6,7 @@ import { BaseClient } from './base-client.js';
  * Client for interacting with Twist comment endpoints.
  */
 export declare class CommentsClient extends BaseClient {
+    private readonly commentSchema;
     /**
      * Gets all comments for a thread.
      *

package/dist/types/clients/conversation-messages-client.d.ts

@@ -6,6 +6,7 @@ import { BaseClient } from './base-client.js';
  * Client for interacting with Twist conversation message endpoints.
  */
 export declare class ConversationMessagesClient extends BaseClient {
+    private readonly messageSchema;
     /**
      * Gets all messages in a conversation.
      *

package/dist/types/clients/conversations-client.d.ts

@@ -6,6 +6,7 @@ import { BaseClient } from './base-client.js';
  * Client for interacting with Twist conversation endpoints.
  */
 export declare class ConversationsClient extends BaseClient {
+    private readonly conversationSchema;
     /**
      * Gets all conversations for a workspace.
      *

package/dist/types/clients/inbox-client.d.ts

@@ -6,6 +6,7 @@ import { BaseClient } from './base-client.js';
  * Client for interacting with Twist inbox endpoints.
  */
 export declare class InboxClient extends BaseClient {
+    private readonly inboxThreadSchema;
     /**
      * Gets inbox items (threads).
      *

package/dist/types/clients/threads-client.d.ts

@@ -6,6 +6,8 @@ import { BaseClient } from './base-client.js';
  * Client for interacting with Twist thread endpoints.
  */
 export declare class ThreadsClient extends BaseClient {
+    private readonly threadSchema;
+    private readonly commentSchema;
     /**
      * Gets all threads in a channel.
      *

package/dist/types/clients/workspace-users-client.d.ts

@@ -10,9 +10,14 @@ export declare class WorkspaceUsersClient extends BaseClient {
     /**
      * Returns a list of workspace user objects for the given workspace id.
      *
+     * Removed users are excluded by default; set `args.includeRemoved` to `true` to include them.
+     * The Twist API always returns removed users, so the filtering happens client-side (in both the
+     * awaited and batch modes).
+     *
      * @param args - The arguments for getting workspace users.
      * @param args.workspaceId - The workspace ID.
      * @param args.archived - Optional flag to filter archived users.
+     * @param args.includeRemoved - Include users removed from the workspace. Defaults to `false`.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns An array of workspace user objects.
      *

package/dist/types/clients/workspaces-client.d.ts

@@ -5,6 +5,7 @@ import { BaseClient } from './base-client.js';
  * Client for interacting with Twist workspace endpoints.
  */
 export declare class WorkspacesClient extends BaseClient {
+    private readonly channelSchema;
     /**
      * Gets all the user's workspaces.
      *