@doist/twist-sdk 2.1.3 → 2.2.0

package/dist/esm/transport/http-dispatcher.js

@@ -0,0 +1,91 @@
+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 };
+    }
+};
+// Use effectively-disabled keep-alive so short-lived CLI processes do not stay
+// open waiting on idle sockets. Undici requires positive values, so we use 1ms.
+var keepAliveOptions = {
+    keepAliveTimeout: 1,
+    keepAliveMaxTimeout: 1,
+};
+var defaultDispatcher;
+var defaultDispatcherPromise;
+export function getDefaultDispatcher() {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            if (defaultDispatcher) {
+                return [2 /*return*/, defaultDispatcher];
+            }
+            if (!defaultDispatcherPromise) {
+                defaultDispatcherPromise = createDefaultDispatcher()
+                    .then(function (dispatcher) {
+                    defaultDispatcher = dispatcher;
+                    return dispatcher;
+                })
+                    .catch(function (error) {
+                    defaultDispatcher = undefined;
+                    defaultDispatcherPromise = undefined;
+                    throw error;
+                });
+            }
+            return [2 /*return*/, defaultDispatcherPromise];
+        });
+    });
+}
+export function resetDefaultDispatcherForTests() {
+    defaultDispatcher = undefined;
+    defaultDispatcherPromise = undefined;
+}
+function isNodeEnvironment() {
+    var _a;
+    return typeof process !== 'undefined' && typeof ((_a = process.versions) === null || _a === void 0 ? void 0 : _a.node) === 'string';
+}
+function createDefaultDispatcher() {
+    return __awaiter(this, void 0, void 0, function () {
+        var EnvHttpProxyAgent;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!isNodeEnvironment()) {
+                        return [2 /*return*/, undefined];
+                    }
+                    return [4 /*yield*/, import('undici')];
+                case 1:
+                    EnvHttpProxyAgent = (_a.sent()).EnvHttpProxyAgent;
+                    return [2 /*return*/, new EnvHttpProxyAgent(keepAliveOptions)];
+            }
+        });
+    });
+}

package/dist/esm/types/requests.js

@@ -88,3 +88,5 @@ export var GetOrCreateConversationArgsSchema = z.object({
     userIds: z.array(z.number()),
 });
 export var AWAY_MODE_TYPES = ['parental', 'vacation', 'sickleave', 'other'];
+// Threads
+export var THREAD_ACTIONS = ['close', 'reopen'];

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

@@ -0,0 +1,14 @@
+import type { BatchRequestDescriptor } from '../types/batch.js';
+import { type Comment } from '../types/entities.js';
+import type { CustomFetch } from '../types/http.js';
+import type { ThreadAction } from '../types/requests.js';
+type ClientContext = {
+    baseUri: string;
+    apiToken: string;
+    customFetch?: CustomFetch;
+};
+export declare function addCommentRequest(context: ClientContext, params: Record<string, unknown>, options?: {
+    batch?: boolean;
+    threadAction?: ThreadAction;
+}): Promise<Comment> | BatchRequestDescriptor<Comment>;
+export {};

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

@@ -1,6 +1,6 @@
 import type { BatchRequestDescriptor } from '../types/batch.js';
-import { type Thread, type UnreadThread } from '../types/entities.js';
-import { type CreateThreadArgs, type GetThreadsArgs, type MarkThreadReadArgs, type MarkThreadUnreadArgs, type MarkThreadUnreadForOthersArgs, type MoveThreadToChannelArgs, type MuteThreadArgs, type UpdateThreadArgs } from '../types/requests.js';
+import { type Comment, type Thread, type UnreadThread } from '../types/entities.js';
+import { type CloseThreadArgs, type CreateThreadArgs, type GetThreadsArgs, type MarkThreadReadArgs, type MarkThreadUnreadArgs, type MarkThreadUnreadForOthersArgs, type MoveThreadToChannelArgs, type MuteThreadArgs, type ReopenThreadArgs, type UpdateThreadArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
 /**
  * Client for interacting with Twist thread endpoints.
@@ -319,4 +319,59 @@ export declare class ThreadsClient extends BaseClient {
     unmuteThread(id: number, options?: {
         batch?: false;
     }): Promise<Thread>;
+    /**
+     * Closes a thread by adding a comment with a close action.
+     *
+     * @param args - The arguments for closing a thread.
+     * @param args.id - The thread ID.
+     * @param args.content - The comment content.
+     * @param args.tempId - Optional temporary identifier.
+     * @param args.attachments - Optional array of attachment objects.
+     * @param args.actions - Optional array of action objects.
+     * @param args.recipients - Optional array of user IDs to notify.
+     * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
+     * @returns The created comment object.
+     *
+     * @example
+     * ```typescript
+     * const comment = await api.threads.closeThread({
+     *   id: 789,
+     *   content: 'Closing this thread — resolved.'
+     * })
+     * ```
+     */
+    closeThread(args: CloseThreadArgs, options: {
+        batch: true;
+    }): BatchRequestDescriptor<Comment>;
+    closeThread(args: CloseThreadArgs, options?: {
+        batch?: false;
+    }): Promise<Comment>;
+    /**
+     * Reopens a thread by adding a comment with a reopen action.
+     *
+     * @param args - The arguments for reopening a thread.
+     * @param args.id - The thread ID.
+     * @param args.content - The comment content.
+     * @param args.tempId - Optional temporary identifier.
+     * @param args.attachments - Optional array of attachment objects.
+     * @param args.actions - Optional array of action objects.
+     * @param args.recipients - Optional array of user IDs to notify.
+     * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
+     * @returns The created comment object.
+     *
+     * @example
+     * ```typescript
+     * const comment = await api.threads.reopenThread({
+     *   id: 789,
+     *   content: 'Reopening — need further discussion.'
+     * })
+     * ```
+     */
+    reopenThread(args: ReopenThreadArgs, options: {
+        batch: true;
+    }): BatchRequestDescriptor<Comment>;
+    reopenThread(args: ReopenThreadArgs, options?: {
+        batch?: false;
+    }): Promise<Comment>;
+    private addCommentWithAction;
 }

package/dist/types/transport/fetch-with-retry.d.ts

@@ -0,0 +1,4 @@
+import type { CustomFetch, HttpResponse } from '../types/http.js';
+export declare function fetchWithRetry<T>(url: string, options: RequestInit & {
+    timeout?: number;
+}, maxRetries?: number, customFetch?: CustomFetch): Promise<HttpResponse<T>>;

package/dist/types/{rest-client.d.ts → transport/http-client.d.ts}

@@ -1,8 +1,5 @@
-import { CustomFetch, HttpMethod, HttpResponse } from './types/http.js';
+import type { CustomFetch, HttpMethod, HttpResponse } from '../types/http.js';
 export declare function paramsSerializer(params: Record<string, unknown>): string;
-export declare function fetchWithRetry<T>(url: string, options: RequestInit & {
-    timeout?: number;
-}, maxRetries?: number, customFetch?: CustomFetch): Promise<HttpResponse<T>>;
 export type RequestArgs = {
     httpMethod: HttpMethod;
     baseUri: string;

package/dist/types/transport/http-dispatcher.d.ts

@@ -0,0 +1,3 @@
+import type { Dispatcher } from 'undici';
+export declare function getDefaultDispatcher(): Promise<Dispatcher | undefined>;
+export declare function resetDefaultDispatcherForTests(): void;

package/dist/types/types/requests.d.ts

@@ -202,6 +202,24 @@ export type RemoveChannelUsersArgs = {
     id: number;
     userIds: number[];
 };
+export declare const THREAD_ACTIONS: readonly ["close", "reopen"];
+export type ThreadAction = (typeof THREAD_ACTIONS)[number];
+export type CloseThreadArgs = {
+    id: number;
+    content: string;
+    tempId?: number | null;
+    attachments?: unknown | null;
+    actions?: unknown | null;
+    recipients?: number[] | null;
+};
+export type ReopenThreadArgs = {
+    id: number;
+    content: string;
+    tempId?: number | null;
+    attachments?: unknown | null;
+    actions?: unknown | null;
+    recipients?: number[] | null;
+};
 export type MoveThreadToChannelArgs = {
     id: number;
     toChannel: number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/twist-sdk",
-    "version": "2.1.3",
+    "version": "2.2.0",
     "description": "A TypeScript wrapper for the Twist REST API.",
     "author": "Doist developers",
     "homepage": "https://doist.github.io/twist-sdk-typescript/",