@doist/twist-sdk 2.1.2 → 2.1.4

package/dist/esm/authentication.js

@@ -46,8 +46,92 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 import { v4 as uuid } from 'uuid';
-import { isSuccess, request } from './rest-client.js';
+import { isSuccess, request } from './transport/http-client.js';
 import { TwistRequestError } from './types/errors.js';
+/**
+ * OAuth scopes for the Twist API.
+ *
+ * @remarks
+ * Request only the scopes your application needs:
+ *
+ * **User Scopes:**
+ * - `user:read` - Access user's personal settings
+ * - `user:write` - Access and update user's personal settings
+ *
+ * **Workspace Scopes:**
+ * - `workspaces:read` - Access teams the user is part of
+ * - `workspaces:write` - Access and update teams the user is part of
+ *
+ * **Channel Scopes:**
+ * - `channels:read` - Access channels
+ * - `channels:write` - Access and update channels
+ * - `channels:remove` - Access, update, and delete channels
+ *
+ * **Thread Scopes:**
+ * - `threads:read` - Access threads
+ * - `threads:write` - Access and update threads
+ * - `threads:remove` - Access, update, and delete threads
+ *
+ * **Comment Scopes:**
+ * - `comments:read` - Access comments
+ * - `comments:write` - Access and update comments
+ * - `comments:remove` - Access, update, and delete comments
+ *
+ * **Group Scopes:**
+ * - `groups:read` - Access groups
+ * - `groups:write` - Access and update groups
+ * - `groups:remove` - Access, update, and delete groups
+ *
+ * **Message Scopes:**
+ * - `messages:read` - Access messages
+ * - `messages:write` - Access and update messages
+ * - `messages:remove` - Access, update, and delete messages
+ *
+ * **Reaction Scopes:**
+ * - `reactions:read` - Access reactions
+ * - `reactions:write` - Access and update reactions
+ * - `reactions:remove` - Access, update, and delete reactions
+ *
+ * **Search Scopes:**
+ * - `search:read` - Search
+ *
+ * **Attachment Scopes:**
+ * - `attachments:read` - Access attachments
+ * - `attachments:write` - Access and update attachments
+ *
+ * **Notification Scopes:**
+ * - `notifications:read` - Read user's notifications settings
+ * - `notifications:write` - Read and update user's notifications settings
+ */
+export var TWIST_SCOPES = [
+    'user:read',
+    'user:write',
+    'workspaces:read',
+    'workspaces:write',
+    'channels:read',
+    'channels:write',
+    'channels:remove',
+    'threads:read',
+    'threads:write',
+    'threads:remove',
+    'comments:read',
+    'comments:write',
+    'comments:remove',
+    'groups:read',
+    'groups:write',
+    'groups:remove',
+    'messages:read',
+    'messages:write',
+    'messages:remove',
+    'reactions:read',
+    'reactions:write',
+    'reactions:remove',
+    'search:read',
+    'attachments:read',
+    'attachments:write',
+    'notifications:read',
+    'notifications:write',
+];
 export function getAuthStateParameter() {
     return uuid();
 }

package/dist/esm/batch-builder.js

@@ -60,7 +60,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 };
 import { z } from 'zod';
 import { BaseClient } from './clients/base-client.js';
-import { fetchWithRetry } from './rest-client.js';
+import { fetchWithRetry } from './transport/fetch-with-retry.js';
 import { camelCaseKeys, snakeCaseKeys } from './utils/case-conversion.js';
 import { transformTimestamps } from './utils/timestamp-conversion.js';
 /**

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

@@ -1,4 +1,5 @@
 import { getTwistBaseUri } from '../consts/endpoints.js';
+import { DEFAULT_API_VERSION } from '../types/api-version.js';
 /**
  * Base client class that provides centralized URL management and configuration
  * for all Twist API clients. Fixes the trailing slash bug and eliminates code duplication.
@@ -7,7 +8,7 @@ var BaseClient = /** @class */ (function () {
     function BaseClient(config) {
         this.apiToken = config.apiToken;
         this.baseUrl = config.baseUrl;
-        this.defaultVersion = config.version || 'v3';
+        this.defaultVersion = config.version || DEFAULT_API_VERSION;
         this.customFetch = config.customFetch;
     }
     /**

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

@@ -15,7 +15,7 @@ var __extends = (this && this.__extends) || (function () {
 })();
 import { z } from 'zod';
 import { ENDPOINT_CHANNELS } from '../consts/endpoints.js';
-import { request } from '../rest-client.js';
+import { request } from '../transport/http-client.js';
 import { ChannelSchema } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 /**

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

@@ -15,7 +15,7 @@ var __extends = (this && this.__extends) || (function () {
 })();
 import { z } from 'zod';
 import { ENDPOINT_COMMENTS } from '../consts/endpoints.js';
-import { request } from '../rest-client.js';
+import { request } from '../transport/http-client.js';
 import { CommentSchema } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 /**

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

@@ -15,7 +15,7 @@ var __extends = (this && this.__extends) || (function () {
 })();
 import { z } from 'zod';
 import { ENDPOINT_CONVERSATION_MESSAGES } from '../consts/endpoints.js';
-import { request } from '../rest-client.js';
+import { request } from '../transport/http-client.js';
 import { ConversationMessageSchema } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 /**

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

@@ -15,7 +15,7 @@ var __extends = (this && this.__extends) || (function () {
 })();
 import { z } from 'zod';
 import { ENDPOINT_CONVERSATIONS } from '../consts/endpoints.js';
-import { request } from '../rest-client.js';
+import { request } from '../transport/http-client.js';
 import { ConversationSchema, UnreadConversationSchema, } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 /**

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

@@ -14,7 +14,7 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 import { ENDPOINT_GROUPS } from '../consts/endpoints.js';
-import { request } from '../rest-client.js';
+import { request } from '../transport/http-client.js';
 import { GroupSchema } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 /**

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

@@ -15,7 +15,7 @@ var __extends = (this && this.__extends) || (function () {
 })();
 import { z } from 'zod';
 import { ENDPOINT_INBOX } from '../consts/endpoints.js';
-import { request } from '../rest-client.js';
+import { request } from '../transport/http-client.js';
 import { InboxThreadSchema } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 /**

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

@@ -14,7 +14,7 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 import { ENDPOINT_REACTIONS } from '../consts/endpoints.js';
-import { request } from '../rest-client.js';
+import { request } from '../transport/http-client.js';
 import { BaseClient } from './base-client.js';
 /**
  * Client for interacting with Twist reaction endpoints.

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

@@ -25,7 +25,7 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 import { ENDPOINT_SEARCH } from '../consts/endpoints.js';
-import { request } from '../rest-client.js';
+import { request } from '../transport/http-client.js';
 import { SearchResultSchema, } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 /**

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

@@ -15,7 +15,7 @@ var __extends = (this && this.__extends) || (function () {
 })();
 import { z } from 'zod';
 import { ENDPOINT_THREADS } from '../consts/endpoints.js';
-import { request } from '../rest-client.js';
+import { request } from '../transport/http-client.js';
 import { ThreadSchema, UnreadThreadSchema } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 /**

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

@@ -14,7 +14,7 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 import { ENDPOINT_USERS } from '../consts/endpoints.js';
-import { request } from '../rest-client.js';
+import { request } from '../transport/http-client.js';
 import { UserSchema } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 /**

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

@@ -13,7 +13,7 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
-import { request } from '../rest-client.js';
+import { request } from '../transport/http-client.js';
 import { WorkspaceUserSchema } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 /**

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

@@ -14,7 +14,7 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 import { ENDPOINT_WORKSPACES } from '../consts/endpoints.js';
-import { request } from '../rest-client.js';
+import { request } from '../transport/http-client.js';
 import { ChannelSchema, WorkspaceSchema } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 /**

package/dist/esm/consts/endpoints.js

@@ -1,5 +1,6 @@
+import { DEFAULT_API_VERSION } from '../types/api-version.js';
 var BASE_URI = 'https://api.twist.com';
-export var API_VERSION = 'v3';
+export var API_VERSION = DEFAULT_API_VERSION;
 /**
  * @deprecated Use getTwistBaseUri() instead. This constant is kept for backward compatibility.
  */
@@ -12,7 +13,7 @@ export var API_BASE_URI = "/api/".concat(API_VERSION, "/");
  * @returns Complete base URI with trailing slash (e.g., 'https://api.twist.com/api/v3/')
  */
 export function getTwistBaseUri(version, domainBase) {
-    if (version === void 0) { version = 'v3'; }
+    if (version === void 0) { version = DEFAULT_API_VERSION; }
     if (domainBase === void 0) { domainBase = BASE_URI; }
     return new URL("/api/".concat(version, "/"), domainBase).toString();
 }

package/dist/esm/testUtils/msw-setup.js

@@ -4,7 +4,7 @@ import { afterAll, afterEach, beforeAll } from 'vitest';
 export var server = setupServer();
 // Start server before all tests
 beforeAll(function () {
-    // Only warn on unhandled requests instead of error, since rest-client.test.ts
+    // Only warn on unhandled requests instead of error, since transport/http-client.test.ts
     // uses direct fetch mocking which bypasses MSW
     server.listen({ onUnhandledRequest: 'warn' });
 });

package/dist/esm/{rest-client.js → transport/fetch-with-retry.js}

@@ -45,117 +45,26 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-import { Agent } from 'undici';
-import { TwistRequestError } from './types/errors.js';
-import { camelCaseKeys, snakeCaseKeys } from './utils/case-conversion.js';
-import { transformTimestamps } from './utils/timestamp-conversion.js';
-/**
- * HTTP agent with keepAlive disabled to prevent hanging connections
- * This ensures the process exits immediately after requests complete
- */
-var httpAgent = new Agent({
-    keepAliveTimeout: 1, // Close connections after 1ms of idle time
-    keepAliveMaxTimeout: 1, // Maximum time to keep connections alive
-});
-export function paramsSerializer(params) {
-    var qs = new URLSearchParams();
-    Object.keys(params).forEach(function (key) {
-        var value = params[key];
-        if (value != null) {
-            if (Array.isArray(value)) {
-                qs.append(key, value.join(','));
-            }
-            else {
-                qs.append(key, String(value));
-            }
-        }
-    });
-    return qs.toString();
-}
-var defaultHeaders = {
-    'Content-Type': 'application/json',
-};
-function getAuthHeader(apiToken) {
-    return "Bearer ".concat(apiToken);
-}
-function getRequestConfiguration(baseURL, apiToken, requestId) {
-    var authHeader = apiToken ? { Authorization: getAuthHeader(apiToken) } : undefined;
-    var requestIdHeader = requestId ? { 'X-Request-Id': requestId } : undefined;
-    var headers = __assign(__assign(__assign({}, defaultHeaders), authHeader), requestIdHeader);
-    return { baseURL: baseURL, headers: headers, timeout: 30000 };
-}
-function sleep(ms) {
-    return __awaiter(this, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            return [2 /*return*/, new Promise(function (resolve) { return setTimeout(resolve, ms); })];
-        });
-    });
-}
-function isNetworkError(error) {
-    return error.name === 'TypeError' || error.message.toLowerCase().includes('network');
-}
-function getRetryDelay(retryCount) {
-    return retryCount === 1 ? 0 : 500;
-}
-/**
- * Creates an AbortSignal that aborts after timeoutMs. Returns the signal and a
- * clear function to cancel the timeout early.
- */
-function createTimeoutSignal(timeoutMs, existingSignal) {
-    var controller = new AbortController();
-    var timeoutId = setTimeout(function () {
-        controller.abort(new Error("Request timeout after ".concat(timeoutMs, "ms")));
-    }, timeoutMs);
-    function clear() {
-        clearTimeout(timeoutId);
-    }
-    // Forward existing signal if provided
-    if (existingSignal) {
-        if (existingSignal.aborted) {
-            controller.abort(existingSignal.reason);
-        }
-        else {
-            existingSignal.addEventListener('abort', function () {
-                controller.abort(existingSignal.reason);
-                clear();
-            }, { once: true });
-        }
-    }
-    return { signal: controller.signal, clear: clear };
-}
-/**
- * Converts native fetch Response to CustomFetchResponse for consistent interface
- */
-function convertResponseToCustomFetch(response) {
-    var headers = {};
-    response.headers.forEach(function (value, key) {
-        headers[key] = value;
-    });
-    return {
-        ok: response.ok,
-        status: response.status,
-        statusText: response.statusText,
-        headers: headers,
-        text: function () { return response.clone().text(); },
-        json: function () { return response.json(); },
-    };
-}
+import { TwistRequestError } from '../types/errors.js';
+import { camelCaseKeys } from '../utils/case-conversion.js';
+import { transformTimestamps } from '../utils/timestamp-conversion.js';
+import { getDefaultDispatcher } from './http-dispatcher.js';
 export function fetchWithRetry(url_1, options_1) {
     return __awaiter(this, arguments, void 0, function (url, options, maxRetries, customFetch) {
-        var lastError, attempt, clearTimeoutFn, requestSignal, timeoutResult, response, _a, _b, responseText, responseData, camelCased, transformed, error_1, delay;
-        var _c;
+        var lastError, attempt, clearTimeoutFn, requestSignal, timeoutResult, response, _a, responseText, responseData, camelCased, transformed, error_1, delay;
+        var _b;
         if (maxRetries === void 0) { maxRetries = 3; }
-        return __generator(this, function (_d) {
-            switch (_d.label) {
+        return __generator(this, function (_c) {
+            switch (_c.label) {
                 case 0:
                     attempt = 0;
-                    _d.label = 1;
+                    _c.label = 1;
                 case 1:
                     if (!(attempt <= maxRetries)) return [3 /*break*/, 13];
                     clearTimeoutFn = void 0;
-                    _d.label = 2;
+                    _c.label = 2;
                 case 2:
-                    _d.trys.push([2, 8, , 12]);
+                    _c.trys.push([2, 8, , 12]);
                     requestSignal = options.signal || undefined;
                     if (options.timeout && options.timeout > 0) {
                         timeoutResult = createTimeoutSignal(options.timeout, requestSignal);
@@ -165,26 +74,22 @@ export function fetchWithRetry(url_1, options_1) {
                     if (!customFetch) return [3 /*break*/, 4];
                     return [4 /*yield*/, customFetch(url, options)];
                 case 3:
-                    _a = _d.sent();
+                    _a = _c.sent();
                     return [3 /*break*/, 6];
-                case 4:
-                    _b = convertResponseToCustomFetch;
-                    return [4 /*yield*/, fetch(url, __assign(__assign({}, options), { signal: requestSignal, 
-                            // @ts-expect-error - dispatcher is valid for Node.js fetch but not in TS types
-                            dispatcher: httpAgent }))];
+                case 4: return [4 /*yield*/, fetchWithDefaultTransport(url, options, requestSignal)];
                 case 5:
-                    _a = _b.apply(void 0, [_d.sent()]);
-                    _d.label = 6;
+                    _a = _c.sent();
+                    _c.label = 6;
                 case 6:
                     response = _a;
                     return [4 /*yield*/, response.text()];
                 case 7:
-                    responseText = _d.sent();
+                    responseText = _c.sent();
                     responseData = void 0;
                     try {
                         responseData = responseText ? JSON.parse(responseText) : undefined;
                     }
-                    catch (_e) {
+                    catch (_d) {
                         responseData = responseText;
                     }
                     if (!response.ok) {
@@ -192,7 +97,6 @@ export function fetchWithRetry(url_1, options_1) {
                     }
                     camelCased = camelCaseKeys(responseData);
                     transformed = transformTimestamps(camelCased);
-                    // Success – clear pending timeout (if any) so Node can exit promptly
                     if (clearTimeoutFn) {
                         clearTimeoutFn();
                     }
@@ -202,27 +106,20 @@ export function fetchWithRetry(url_1, options_1) {
                             headers: response.headers,
                         }];
                 case 8:
-                    error_1 = _d.sent();
+                    error_1 = _c.sent();
+                    if (clearTimeoutFn) {
+                        clearTimeoutFn();
+                    }
                     lastError = error_1 instanceof Error ? error_1 : new Error('Unknown error');
                     if (!(attempt < maxRetries && isNetworkError(lastError))) return [3 /*break*/, 11];
                     delay = getRetryDelay(attempt + 1);
                     if (!(delay > 0)) return [3 /*break*/, 10];
                     return [4 /*yield*/, sleep(delay)];
                 case 9:
-                    _d.sent();
-                    _d.label = 10;
-                case 10:
-                    // Retry path – ensure this attempt's timeout is cleared before looping
-                    if (clearTimeoutFn) {
-                        clearTimeoutFn();
-                    }
-                    return [3 /*break*/, 12];
-                case 11:
-                    // Final error – clear timeout before throwing
-                    if (clearTimeoutFn) {
-                        clearTimeoutFn();
-                    }
-                    return [3 /*break*/, 13];
+                    _c.sent();
+                    _c.label = 10;
+                case 10: return [3 /*break*/, 12];
+                case 11: return [3 /*break*/, 13];
                 case 12:
                     attempt++;
                     return [3 /*break*/, 1];
@@ -230,35 +127,96 @@ export function fetchWithRetry(url_1, options_1) {
                     if (lastError instanceof TwistRequestError) {
                         throw lastError;
                     }
-                    throw new TwistRequestError((_c = lastError === null || lastError === void 0 ? void 0 : lastError.message) !== null && _c !== void 0 ? _c : 'Request failed');
+                    throw new TwistRequestError((_b = lastError === null || lastError === void 0 ? void 0 : lastError.message) !== null && _b !== void 0 ? _b : 'Request failed');
             }
         });
     });
 }
-export function request(args) {
+function fetchWithDefaultTransport(url, options, signal) {
     return __awaiter(this, void 0, void 0, function () {
-        var httpMethod, baseUri, relativePath, apiToken, payload, requestId, customFetch, config, url, options, searchParams, urlWithParams;
-        return __generator(this, function (_a) {
-            httpMethod = args.httpMethod, baseUri = args.baseUri, relativePath = args.relativePath, apiToken = args.apiToken, payload = args.payload, requestId = args.requestId, customFetch = args.customFetch;
-            config = getRequestConfiguration(baseUri, apiToken, requestId);
-            url = new URL(relativePath, config.baseURL).toString();
-            options = {
-                method: httpMethod,
-                headers: config.headers,
-                timeout: config.timeout,
-            };
-            if (httpMethod === 'GET' && payload) {
-                searchParams = paramsSerializer(snakeCaseKeys(payload));
-                urlWithParams = searchParams ? "".concat(url, "?").concat(searchParams) : url;
-                return [2 /*return*/, fetchWithRetry(urlWithParams, options, 3, customFetch)];
-            }
-            if (payload && httpMethod !== 'GET') {
-                options.body = JSON.stringify(snakeCaseKeys(payload));
+        var dispatcher, response, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, getDefaultDispatcher()];
+                case 1:
+                    dispatcher = _b.sent();
+                    if (!dispatcher) return [3 /*break*/, 3];
+                    return [4 /*yield*/, fetch(url, __assign(__assign({}, options), { signal: signal, 
+                            // @ts-expect-error - dispatcher is valid for Node.js fetch but not in TS types
+                            dispatcher: dispatcher }))];
+                case 2:
+                    _a = _b.sent();
+                    return [3 /*break*/, 5];
+                case 3: return [4 /*yield*/, fetch(url, __assign(__assign({}, options), { signal: signal }))];
+                case 4:
+                    _a = _b.sent();
+                    _b.label = 5;
+                case 5:
+                    response = _a;
+                    return [2 /*return*/, convertResponseToCustomFetch(response)];
             }
-            return [2 /*return*/, fetchWithRetry(url, options, 3, customFetch)];
         });
     });
 }
-export function isSuccess(response) {
-    return response.status >= 200 && response.status < 300;
+function sleep(ms) {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            return [2 /*return*/, new Promise(function (resolve) { return setTimeout(resolve, ms); })];
+        });
+    });
+}
+var timeoutErrorName = 'TimeoutError';
+function createTimeoutError(timeoutMs) {
+    var error = new Error("Request timeout after ".concat(timeoutMs, "ms"));
+    error.name = timeoutErrorName;
+    return error;
+}
+function isNetworkError(error) {
+    return (error.name === 'TypeError' ||
+        error.name === timeoutErrorName ||
+        error.message.toLowerCase().includes('network'));
+}
+function getRetryDelay(retryCount) {
+    return retryCount === 1 ? 0 : 500;
+}
+function createTimeoutSignal(timeoutMs, existingSignal) {
+    var controller = new AbortController();
+    var timeoutId = setTimeout(function () {
+        controller.abort(createTimeoutError(timeoutMs));
+    }, timeoutMs);
+    var abortHandler;
+    function clear() {
+        clearTimeout(timeoutId);
+        if (existingSignal && abortHandler) {
+            existingSignal.removeEventListener('abort', abortHandler);
+        }
+    }
+    if (existingSignal) {
+        if (existingSignal.aborted) {
+            clearTimeout(timeoutId);
+            controller.abort(existingSignal.reason);
+        }
+        else {
+            abortHandler = function () {
+                clearTimeout(timeoutId);
+                controller.abort(existingSignal.reason);
+            };
+            existingSignal.addEventListener('abort', abortHandler, { once: true });
+        }
+    }
+    return { signal: controller.signal, clear: clear };
+}
+function convertResponseToCustomFetch(response) {
+    var headers = {};
+    response.headers.forEach(function (value, key) {
+        headers[key] = value;
+    });
+    return {
+        ok: response.ok,
+        status: response.status,
+        statusText: response.statusText,
+        headers: headers,
+        text: function () { return response.clone().text(); },
+        json: function () { return response.json(); },
+    };
 }