@doist/twist-sdk 2.7.0 → 2.9.0

package/dist/cjs/twist-api.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TwistApi = void 0;
 var batch_builder_1 = require("./batch-builder");
+var attachments_client_1 = require("./clients/attachments-client");
 var channels_client_1 = require("./clients/channels-client");
 var comments_client_1 = require("./clients/comments-client");
 var conversation_messages_client_1 = require("./clients/conversation-messages-client");
@@ -73,6 +74,7 @@ var TwistApi = /** @class */ (function () {
         this.inbox = new inbox_client_1.InboxClient(clientConfig);
         this.reactions = new reactions_client_1.ReactionsClient(clientConfig);
         this.search = new search_client_1.SearchClient(clientConfig);
+        this.attachments = new attachments_client_1.AttachmentsClient(clientConfig);
     }
     /**
      * Executes multiple API requests in a single HTTP call using the batch endpoint.

package/dist/cjs/types/entities.js

@@ -11,7 +11,13 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchResultSchema = exports.SEARCH_RESULT_TYPES = exports.UnreadConversationSchema = exports.UnreadThreadSchema = exports.InboxThreadSchema = exports.ConversationMessageSchema = exports.WorkspaceUserSchema = exports.CommentSchema = exports.ConversationSchema = exports.GroupSchema = exports.ThreadSchema = exports.ChannelSchema = exports.WorkspaceSchema = exports.UserSchema = exports.BaseUserSchema = exports.AttachmentSchema = exports.SystemMessageSchema = void 0;
+exports.SearchResultSchema = exports.SEARCH_RESULT_TYPES = exports.UnreadConversationSchema = exports.UnreadThreadSchema = exports.InboxThreadSchema = exports.ConversationMessageSchema = exports.ConversationMessageObjectSchema = exports.WorkspaceUserSchema = exports.CommentSchema = exports.CommentObjectSchema = exports.ConversationSchema = exports.ConversationObjectSchema = exports.GroupSchema = exports.ThreadSchema = exports.ThreadObjectSchema = exports.ChannelSchema = exports.ChannelObjectSchema = exports.WorkspaceSchema = exports.UserSchema = exports.BaseUserSchema = exports.AttachmentSchema = exports.SystemMessageSchema = void 0;
+exports.createChannelSchema = createChannelSchema;
+exports.createThreadSchema = createThreadSchema;
+exports.createConversationSchema = createConversationSchema;
+exports.createCommentSchema = createCommentSchema;
+exports.createConversationMessageSchema = createConversationMessageSchema;
+exports.createInboxThreadSchema = createInboxThreadSchema;
 var zod_1 = require("zod");
 var url_helpers_1 = require("../utils/url-helpers");
 var enums_1 = require("./enums");
@@ -112,8 +118,7 @@ exports.WorkspaceSchema = zod_1.z.object({
     plan: zod_1.z.enum(enums_1.WORKSPACE_PLANS).nullable().optional(),
 });
 // Channel entity from API
-exports.ChannelSchema = zod_1.z
-    .object({
+exports.ChannelObjectSchema = zod_1.z.object({
     id: zod_1.z.number(),
     name: zod_1.z.string(),
     description: zod_1.z.string().nullable().optional(),
@@ -131,11 +136,13 @@ exports.ChannelSchema = zod_1.z
     icon: zod_1.z.number().nullable().optional(),
     version: zod_1.z.number(),
     filters: zod_1.z.record(zod_1.z.string(), zod_1.z.string()).nullable().optional(),
-})
-    .transform(function (data) { return (__assign(__assign({}, data), { url: (0, url_helpers_1.getFullTwistURL)({ workspaceId: data.workspaceId, channelId: data.id }) })); });
+});
+function createChannelSchema(linkBaseUrl) {
+    return exports.ChannelObjectSchema.transform(function (data) { return (__assign(__assign({}, data), { url: (0, url_helpers_1.getFullTwistURL)({ workspaceId: data.workspaceId, channelId: data.id }, linkBaseUrl) })); });
+}
+exports.ChannelSchema = createChannelSchema();
 // Thread entity from API
-exports.ThreadSchema = zod_1.z
-    .object({
+exports.ThreadObjectSchema = zod_1.z.object({
     id: zod_1.z.number(),
     title: zod_1.z.string(),
     content: zod_1.z.string(),
@@ -198,12 +205,15 @@ exports.ThreadSchema = zod_1.z
     })
         .nullable()
         .optional(),
-})
-    .transform(function (data) { return (__assign(__assign({}, data), { url: (0, url_helpers_1.getFullTwistURL)({
-        workspaceId: data.workspaceId,
-        channelId: data.channelId,
-        threadId: data.id,
-    }) })); });
+});
+function createThreadSchema(linkBaseUrl) {
+    return exports.ThreadObjectSchema.transform(function (data) { return (__assign(__assign({}, data), { url: (0, url_helpers_1.getFullTwistURL)({
+            workspaceId: data.workspaceId,
+            channelId: data.channelId,
+            threadId: data.id,
+        }, linkBaseUrl) })); });
+}
+exports.ThreadSchema = createThreadSchema();
 // Group entity from API
 exports.GroupSchema = zod_1.z.object({
     id: zod_1.z.number(),
@@ -214,8 +224,7 @@ exports.GroupSchema = zod_1.z.object({
     version: zod_1.z.number(),
 });
 // Conversation entity from API
-exports.ConversationSchema = zod_1.z
-    .object({
+exports.ConversationObjectSchema = zod_1.z.object({
     id: zod_1.z.number(),
     workspaceId: zod_1.z.number(),
     userIds: zod_1.z.array(zod_1.z.number()),
@@ -251,11 +260,13 @@ exports.ConversationSchema = zod_1.z
     })
         .nullable()
         .optional(),
-})
-    .transform(function (data) { return (__assign(__assign({}, data), { url: (0, url_helpers_1.getFullTwistURL)({ workspaceId: data.workspaceId, conversationId: data.id }) })); });
+});
+function createConversationSchema(linkBaseUrl) {
+    return exports.ConversationObjectSchema.transform(function (data) { return (__assign(__assign({}, data), { url: (0, url_helpers_1.getFullTwistURL)({ workspaceId: data.workspaceId, conversationId: data.id }, linkBaseUrl) })); });
+}
+exports.ConversationSchema = createConversationSchema();
 // Comment entity from API
-exports.CommentSchema = zod_1.z
-    .object({
+exports.CommentObjectSchema = zod_1.z.object({
     id: zod_1.z.number(),
     content: zod_1.z.string(),
     creator: zod_1.z.number(),
@@ -280,13 +291,16 @@ exports.CommentSchema = zod_1.z
     deletedBy: zod_1.z.number().nullable().optional(),
     version: zod_1.z.number().nullable().optional(),
     actions: zod_1.z.array(zod_1.z.unknown()).nullable().optional(),
-})
-    .transform(function (data) { return (__assign(__assign({}, data), { url: (0, url_helpers_1.getFullTwistURL)({
-        workspaceId: data.workspaceId,
-        channelId: data.channelId,
-        threadId: data.threadId,
-        commentId: data.id,
-    }) })); });
+});
+function createCommentSchema(linkBaseUrl) {
+    return exports.CommentObjectSchema.transform(function (data) { return (__assign(__assign({}, data), { url: (0, url_helpers_1.getFullTwistURL)({
+            workspaceId: data.workspaceId,
+            channelId: data.channelId,
+            threadId: data.threadId,
+            commentId: data.id,
+        }, linkBaseUrl) })); });
+}
+exports.CommentSchema = createCommentSchema();
 // WorkspaceUser entity from v4 API
 exports.WorkspaceUserSchema = exports.BaseUserSchema.extend({
     email: zod_1.z.string().nullable().optional(),
@@ -298,8 +312,7 @@ exports.WorkspaceUserSchema = exports.BaseUserSchema.extend({
     version: zod_1.z.number(),
 });
 // ConversationMessage entity from API
-exports.ConversationMessageSchema = zod_1.z
-    .object({
+exports.ConversationMessageObjectSchema = zod_1.z.object({
     id: zod_1.z.number(),
     content: zod_1.z.string(),
     creator: zod_1.z.number(),
@@ -316,58 +329,65 @@ exports.ConversationMessageSchema = zod_1.z
     directMentions: zod_1.z.array(zod_1.z.number()).nullable().optional(),
     version: zod_1.z.number().nullable().optional(),
     workspaceId: zod_1.z.number(),
-})
-    .transform(function (data) { return (__assign(__assign({}, data), { url: (0, url_helpers_1.getFullTwistURL)({
-        workspaceId: data.workspaceId,
-        conversationId: data.conversationId,
-        messageId: data.id,
-    }) })); });
+});
+function createConversationMessageSchema(linkBaseUrl) {
+    return exports.ConversationMessageObjectSchema.transform(function (data) { return (__assign(__assign({}, data), { url: (0, url_helpers_1.getFullTwistURL)({
+            workspaceId: data.workspaceId,
+            conversationId: data.conversationId,
+            messageId: data.id,
+        }, linkBaseUrl) })); });
+}
+exports.ConversationMessageSchema = createConversationMessageSchema();
 // InboxThread entity from API - returns full Thread objects with additional inbox metadata
-exports.InboxThreadSchema = zod_1.z
-    .object({
-    id: zod_1.z.number(),
-    title: zod_1.z.string(),
-    content: zod_1.z.string(),
-    creator: zod_1.z.number(),
-    creatorName: zod_1.z.string().nullable().optional(),
-    channelId: zod_1.z.number(),
-    workspaceId: zod_1.z.number(),
-    actions: zod_1.z.array(zod_1.z.unknown()).nullable().optional(),
-    attachments: zod_1.z.array(exports.AttachmentSchema).nullable().optional(),
-    commentCount: zod_1.z.number(),
-    directGroupMentions: zod_1.z.array(zod_1.z.number()).nullable().optional(),
-    directMentions: zod_1.z.array(zod_1.z.number()).nullable().optional(),
-    groups: zod_1.z.array(zod_1.z.number()).nullable().optional(),
-    lastEdited: zod_1.z.date().nullable().optional(),
-    lastObjIndex: zod_1.z.number().nullable().optional(),
-    lastUpdated: zod_1.z.date(),
-    mutedUntil: zod_1.z.date().nullable().optional(),
-    participants: zod_1.z.array(zod_1.z.number()).nullable().optional(),
-    pinned: zod_1.z.boolean(),
-    pinnedDate: zod_1.z.date().nullable().optional(),
-    posted: zod_1.z.date(),
-    reactions: zod_1.z.record(zod_1.z.string(), zod_1.z.array(zod_1.z.number())).nullable().optional(),
-    recipients: zod_1.z.array(zod_1.z.number()).nullable().optional(),
-    snippet: zod_1.z.string(),
-    snippetCreator: zod_1.z.number(),
-    snippetMaskAvatarUrl: zod_1.z.string().nullable().optional(),
-    snippetMaskPoster: zod_1.z.string().nullable().optional(),
-    starred: zod_1.z.boolean(),
-    systemMessage: exports.SystemMessageSchema,
-    isArchived: zod_1.z.boolean(),
-    inInbox: zod_1.z.boolean(),
-    isSaved: zod_1.z.boolean().nullable().optional(),
-    closed: zod_1.z.boolean(),
-    responders: zod_1.z.array(zod_1.z.number()).nullable().optional(),
-    lastComment: exports.CommentSchema.nullable().optional(),
-    toEmails: zod_1.z.array(zod_1.z.string()).nullable().optional(),
-    version: zod_1.z.number().nullable().optional(),
-})
-    .transform(function (data) { return (__assign(__assign({}, data), { url: (0, url_helpers_1.getFullTwistURL)({
-        workspaceId: data.workspaceId,
-        channelId: data.channelId,
-        threadId: data.id,
-    }) })); });
+function createInboxThreadObjectSchema(linkBaseUrl) {
+    return zod_1.z.object({
+        id: zod_1.z.number(),
+        title: zod_1.z.string(),
+        content: zod_1.z.string(),
+        creator: zod_1.z.number(),
+        creatorName: zod_1.z.string().nullable().optional(),
+        channelId: zod_1.z.number(),
+        workspaceId: zod_1.z.number(),
+        actions: zod_1.z.array(zod_1.z.unknown()).nullable().optional(),
+        attachments: zod_1.z.array(exports.AttachmentSchema).nullable().optional(),
+        commentCount: zod_1.z.number(),
+        directGroupMentions: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+        directMentions: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+        groups: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+        lastEdited: zod_1.z.date().nullable().optional(),
+        lastObjIndex: zod_1.z.number().nullable().optional(),
+        lastUpdated: zod_1.z.date(),
+        mutedUntil: zod_1.z.date().nullable().optional(),
+        participants: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+        pinned: zod_1.z.boolean(),
+        pinnedDate: zod_1.z.date().nullable().optional(),
+        posted: zod_1.z.date(),
+        reactions: zod_1.z.record(zod_1.z.string(), zod_1.z.array(zod_1.z.number())).nullable().optional(),
+        recipients: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+        snippet: zod_1.z.string(),
+        snippetCreator: zod_1.z.number(),
+        snippetMaskAvatarUrl: zod_1.z.string().nullable().optional(),
+        snippetMaskPoster: zod_1.z.string().nullable().optional(),
+        starred: zod_1.z.boolean(),
+        systemMessage: exports.SystemMessageSchema,
+        isArchived: zod_1.z.boolean(),
+        inInbox: zod_1.z.boolean(),
+        isSaved: zod_1.z.boolean().nullable().optional(),
+        closed: zod_1.z.boolean(),
+        responders: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+        lastComment: createCommentSchema(linkBaseUrl).nullable().optional(),
+        toEmails: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+        version: zod_1.z.number().nullable().optional(),
+    });
+}
+function createInboxThreadSchema(linkBaseUrl) {
+    return createInboxThreadObjectSchema(linkBaseUrl).transform(function (data) { return (__assign(__assign({}, data), { url: (0, url_helpers_1.getFullTwistURL)({
+            workspaceId: data.workspaceId,
+            channelId: data.channelId,
+            threadId: data.id,
+        }, linkBaseUrl) })); });
+}
+exports.InboxThreadSchema = createInboxThreadSchema();
 // UnreadThread entity from API - simplified thread reference for unread threads
 exports.UnreadThreadSchema = zod_1.z.object({
     threadId: zod_1.z.number(),

package/dist/cjs/utils/multipart-upload.js

@@ -0,0 +1,154 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getContentTypeFromFileName = getContentTypeFromFileName;
+exports.uploadMultipartFile = uploadMultipartFile;
+var fetch_with_retry_1 = require("../transport/fetch-with-retry");
+/**
+ * Determine a content-type from a filename extension. Falls back to
+ * `application/octet-stream` for unknown extensions.
+ */
+function getContentTypeFromFileName(fileName) {
+    var extension = fileName.toLowerCase().split('.').pop();
+    switch (extension) {
+        case 'png':
+            return 'image/png';
+        case 'jpg':
+        case 'jpeg':
+            return 'image/jpeg';
+        case 'gif':
+            return 'image/gif';
+        case 'webp':
+            return 'image/webp';
+        case 'svg':
+            return 'image/svg+xml';
+        case 'pdf':
+            return 'application/pdf';
+        default:
+            return 'application/octet-stream';
+    }
+}
+/**
+ * Normalise a supported {@link UploadFile} into a `Blob` plus a resolved file name and
+ * content type, so uploads use the cross-platform global `FormData`/`Blob` body that
+ * `undici` and browsers both accept natively.
+ */
+function toBlob(file, fileName, contentType) {
+    if (file instanceof Blob) {
+        // `File` is not a global in Node 18, so guard the check before using it.
+        var name_1 = fileName ||
+            (typeof File !== 'undefined' && file instanceof File ? file.name : undefined) ||
+            'upload';
+        var type = contentType || file.type || getContentTypeFromFileName(name_1);
+        // Re-wrap only when stamping a type the Blob doesn't already carry.
+        var blob = file.type === type ? file : new Blob([file], { type: type });
+        return { blob: blob, fileName: name_1, contentType: type };
+    }
+    if (file instanceof Uint8Array) {
+        if (!fileName) {
+            throw new Error('fileName is required when uploading raw bytes');
+        }
+        var type = contentType || getContentTypeFromFileName(fileName);
+        // `Blob` accepts any `ArrayBufferView`; the cast satisfies the stricter lib
+        // `BlobPart` type (which pins the backing buffer to `ArrayBuffer`).
+        return { blob: new Blob([file], { type: type }), fileName: fileName, contentType: type };
+    }
+    throw new Error('Unsupported file type for upload: expected a Blob or Uint8Array');
+}
+/**
+ * Upload a file using `multipart/form-data`.
+ *
+ * Builds the request body with the global `FormData`/`Blob` so it works unchanged in the
+ * browser and in Node.js (via `undici`). The `file` part is sent alongside `file_name`,
+ * `file_size`, and `underlying_type` fields (the canonical Twist upload shape); any
+ * `additionalFields` are merged in and override the derived values. Authentication uses
+ * `Authorization: Bearer`, matching every other Twist SDK client, and `Content-Type` is
+ * intentionally left unset so the runtime adds the correct multipart boundary.
+ *
+ * The response is JSON-parsed and camel-cased by {@link fetchWithRetry}; callers validate
+ * the returned shape with the appropriate schema.
+ */
+function uploadMultipartFile(args) {
+    return __awaiter(this, void 0, void 0, function () {
+        var baseUrl, authToken, endpoint, file, fileName, contentType, additionalFields, requestId, customFetch, _a, blob, resolvedFileName, resolvedType, fields, form, _i, _b, _c, key, value, headers, url, response;
+        return __generator(this, function (_d) {
+            switch (_d.label) {
+                case 0:
+                    baseUrl = args.baseUrl, authToken = args.authToken, endpoint = args.endpoint, file = args.file, fileName = args.fileName, contentType = args.contentType, additionalFields = args.additionalFields, requestId = args.requestId, customFetch = args.customFetch;
+                    _a = toBlob(file, fileName, contentType), blob = _a.blob, resolvedFileName = _a.fileName, resolvedType = _a.contentType;
+                    fields = __assign({ file_name: resolvedFileName, file_size: blob.size, underlying_type: resolvedType }, additionalFields);
+                    form = new FormData();
+                    form.append('file', blob, resolvedFileName);
+                    for (_i = 0, _b = Object.entries(fields); _i < _b.length; _i++) {
+                        _c = _b[_i], key = _c[0], value = _c[1];
+                        if (value !== undefined && value !== null) {
+                            form.append(key, String(value));
+                        }
+                    }
+                    headers = {
+                        Authorization: "Bearer ".concat(authToken),
+                    };
+                    if (requestId) {
+                        headers['X-Request-Id'] = requestId;
+                    }
+                    url = new URL(endpoint, baseUrl).toString();
+                    return [4 /*yield*/, (0, fetch_with_retry_1.fetchWithRetry)(url, {
+                            method: 'POST',
+                            headers: headers,
+                            body: form,
+                            // Don't set Content-Type — the runtime adds the multipart boundary.
+                            timeout: 30000,
+                        }, 3, customFetch)];
+                case 1:
+                    response = _d.sent();
+                    return [2 /*return*/, response.data];
+            }
+        });
+    });
+}

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

@@ -31,7 +31,6 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 };
 import { ENDPOINT_COMMENTS } from '../consts/endpoints.js';
 import { request } from '../transport/http-client.js';
-import { CommentSchema } from '../types/entities.js';
 import { NOTIFY_AUDIENCE_GROUP_IDS, NOTIFY_AUDIENCES } from '../types/enums.js';
 var SENTINEL_GROUP_IDS = new Set(Object.values(NOTIFY_AUDIENCE_GROUP_IDS));
 function isNotifyAudience(value) {
@@ -59,7 +58,7 @@ export function addCommentRequest(context, params, options) {
     var normalized = applyNotifyAudience(params);
     var payload = (options === null || options === void 0 ? void 0 : options.threadAction)
         ? __assign(__assign({}, normalized), { threadAction: options.threadAction }) : normalized;
-    var schema = CommentSchema;
+    var schema = context.schema;
     if (options === null || options === void 0 ? void 0 : options.batch) {
         return { method: method, url: url, params: payload, schema: schema };
     }

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

@@ -0,0 +1,121 @@
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import { v4 as uuid } from 'uuid';
+import { ENDPOINT_ATTACHMENTS } from '../consts/endpoints.js';
+import { AttachmentSchema } from '../types/entities.js';
+import { uploadMultipartFile } from '../utils/multipart-upload.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Client for uploading file attachments to Twist.
+ *
+ * Attachments are uploaded independently, then referenced by passing the returned
+ * {@link Attachment} into the `attachments` array of `comments.createComment`,
+ * `conversationMessages.createMessage`, and similar calls.
+ */
+var AttachmentsClient = /** @class */ (function (_super) {
+    __extends(AttachmentsClient, _super);
+    function AttachmentsClient() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * Uploads a file and returns the created {@link Attachment}.
+     *
+     * Mirrors the canonical multipart upload used by twist-web: `POST /attachments/upload`
+     * with the `file` binary plus `file_name`, `file_size`, `attachment_id`, and
+     * `underlying_type` form fields.
+     *
+     * @param args - The file to upload and optional metadata.
+     * @returns The created attachment, ready to attach to a comment or message.
+     *
+     * @example
+     * ```typescript
+     * import { readFile } from 'node:fs/promises'
+     *
+     * const attachment = await api.attachments.upload({
+     *   file: await readFile('./diagram.png'),
+     *   fileName: 'diagram.png',
+     * })
+     *
+     * await api.comments.createComment({
+     *   threadId: 789,
+     *   content: 'See attached',
+     *   attachments: [attachment],
+     * })
+     * ```
+     */
+    AttachmentsClient.prototype.upload = function (args) {
+        return __awaiter(this, void 0, void 0, function () {
+            var data;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, uploadMultipartFile({
+                            baseUrl: this.getBaseUri(),
+                            authToken: this.apiToken,
+                            endpoint: "".concat(ENDPOINT_ATTACHMENTS, "/upload"),
+                            file: args.file,
+                            fileName: args.fileName,
+                            contentType: args.contentType,
+                            additionalFields: {
+                                attachment_id: args.attachmentId || uuid(),
+                            },
+                            customFetch: this.customFetch,
+                        })];
+                    case 1:
+                        data = _a.sent();
+                        return [2 /*return*/, AttachmentSchema.parse(data)];
+                }
+            });
+        });
+    };
+    return AttachmentsClient;
+}(BaseClient));
+export { AttachmentsClient };

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

@@ -28,6 +28,16 @@ var BaseClient = /** @class */ (function () {
         // Use centralized helper function for default Twist API URL
         return getTwistBaseUri(apiVersion);
     };
+    /**
+     * Base URL for entity web links, or `undefined` to use getFullTwistURL's default web app.
+     */
+    BaseClient.prototype.getLinkBaseUrl = function () {
+        if (!this.baseUrl) {
+            return undefined;
+        }
+        // Strip a trailing slash so links don't double up, since entity paths start with '/'.
+        return this.baseUrl.endsWith('/') ? this.baseUrl.slice(0, -1) : this.baseUrl;
+    };
     return BaseClient;
 }());
 export { BaseClient };

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

@@ -16,7 +16,7 @@ var __extends = (this && this.__extends) || (function () {
 import { z } from 'zod';
 import { ENDPOINT_CHANNELS } from '../consts/endpoints.js';
 import { request } from '../transport/http-client.js';
-import { ChannelSchema } from '../types/entities.js';
+import { createChannelSchema } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 /**
  * Client for interacting with Twist channel endpoints.
@@ -24,14 +24,17 @@ import { BaseClient } from './base-client.js';
 var ChannelsClient = /** @class */ (function (_super) {
     __extends(ChannelsClient, _super);
     function ChannelsClient() {
-        return _super !== null && _super.apply(this, arguments) || this;
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.channelSchema = createChannelSchema(_this.getLinkBaseUrl());
+        return _this;
     }
     ChannelsClient.prototype.getChannels = function (args, options) {
+        var _this = this;
         var method = 'GET';
         var url = "".concat(ENDPOINT_CHANNELS, "/get");
         var params = args;
         if (options === null || options === void 0 ? void 0 : options.batch) {
-            return { method: method, url: url, params: params, schema: z.array(ChannelSchema) };
+            return { method: method, url: url, params: params, schema: z.array(this.channelSchema) };
         }
         return request({
             httpMethod: method,
@@ -40,13 +43,13 @@ var ChannelsClient = /** @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); }); });
     };
     ChannelsClient.prototype.getChannel = function (id, options) {
         var method = 'GET';
         var url = "".concat(ENDPOINT_CHANNELS, "/getone");
         var params = { id: id };
-        var schema = ChannelSchema;
+        var schema = this.channelSchema;
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params, schema: schema };
         }
@@ -63,7 +66,7 @@ var ChannelsClient = /** @class */ (function (_super) {
         var method = 'POST';
         var url = "".concat(ENDPOINT_CHANNELS, "/add");
         var params = args;
-        var schema = ChannelSchema;
+        var schema = this.channelSchema;
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params, schema: schema };
         }
@@ -80,7 +83,7 @@ var ChannelsClient = /** @class */ (function (_super) {
         var method = 'POST';
         var url = "".concat(ENDPOINT_CHANNELS, "/update");
         var params = args;
-        var schema = ChannelSchema;
+        var schema = this.channelSchema;
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params, schema: schema };
         }