@doist/twist-sdk 2.1.2 → 2.1.4

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

@@ -0,0 +1,103 @@
+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 };
+    }
+};
+import { snakeCaseKeys } from '../utils/case-conversion.js';
+import { fetchWithRetry } from './fetch-with-retry.js';
+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 };
+}
+export function request(args) {
+    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));
+            }
+            return [2 /*return*/, fetchWithRetry(url, options, 3, customFetch)];
+        });
+    });
+}
+export function isSuccess(response) {
+    return response.status >= 200 && response.status < 300;
+}

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/api-version.js

@@ -1 +1,5 @@
-export {};
+/**
+ * Supported Twist API versions
+ */
+export var API_VERSIONS = ['v3', 'v4'];
+export var DEFAULT_API_VERSION = 'v3';

package/dist/esm/types/entities.js

@@ -15,7 +15,7 @@ import { USER_TYPES, WORKSPACE_PLANS } from './enums.js';
 // Reusable schema for system messages that can be either a string or an object
 export var SystemMessageSchema = z.union([z.string(), z.unknown()]).nullable().optional();
 // Base user schema with common fields shared between User and WorkspaceUser
-var BaseUserSchema = z.object({
+export var BaseUserSchema = z.object({
     id: z.number(),
     name: z.string(),
     shortName: z.string(),

package/dist/esm/types/http.js

@@ -1 +1 @@
-export {};
+export var HTTP_METHODS = ['POST', 'GET', 'PUT', 'PATCH', 'DELETE'];

package/dist/esm/types/index.js

@@ -1,3 +1,4 @@
+export * from './api-version.js';
 export * from './batch.js';
 export * from './entities.js';
 export * from './enums.js';

package/dist/types/authentication.d.ts

@@ -60,7 +60,11 @@ export type AuthOptions = {
  * - `notifications:read` - Read user's notifications settings
  * - `notifications:write` - Read and update user's notifications settings
  */
-export type TwistScope = '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 declare const TWIST_SCOPES: readonly ["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"];
+/**
+ * Scopes determine what access a token has to the Twist API.
+ */
+export type TwistScope = (typeof TWIST_SCOPES)[number];
 export type AuthTokenRequestArgs = {
     clientId: string;
     clientSecret: string;

package/dist/types/consts/endpoints.d.ts

@@ -1,9 +1,9 @@
 import type { ApiVersion } from '../types/api-version.js';
-export declare const API_VERSION = "v3";
+export declare const API_VERSION: "v3" | "v4";
 /**
  * @deprecated Use getTwistBaseUri() instead. This constant is kept for backward compatibility.
  */
-export declare const API_BASE_URI = "/api/v3/";
+export declare const API_BASE_URI: string;
 /**
  * Gets the base URI for Twist API requests.
  *

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/api-version.d.ts

@@ -1,4 +1,6 @@
 /**
  * Supported Twist API versions
  */
-export type ApiVersion = 'v3' | 'v4';
+export declare const API_VERSIONS: readonly ["v3", "v4"];
+export type ApiVersion = (typeof API_VERSIONS)[number];
+export declare const DEFAULT_API_VERSION: ApiVersion;

package/dist/types/types/entities.d.ts

@@ -1,5 +1,30 @@
 import { z } from 'zod';
 export declare const SystemMessageSchema: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodUnknown]>>>;
+export declare const BaseUserSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    name: z.ZodString;
+    shortName: z.ZodString;
+    firstName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    contactInfo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    bot: z.ZodBoolean;
+    profession: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    timezone: z.ZodString;
+    removed: z.ZodBoolean;
+    avatarId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    avatarUrls: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        s35: z.ZodString;
+        s60: z.ZodString;
+        s195: z.ZodString;
+        s640: z.ZodString;
+    }, z.core.$strip>>>;
+    awayMode: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        dateFrom: z.ZodString;
+        type: z.ZodString;
+        dateTo: z.ZodString;
+    }, z.core.$strip>>>;
+    restricted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    setupPending: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber]>>>;
+}, z.core.$strip>;
 export declare const UserSchema: z.ZodObject<{
     id: z.ZodNumber;
     name: z.ZodString;

package/dist/types/types/http.d.ts

@@ -1,4 +1,5 @@
-export type HttpMethod = 'POST' | 'GET' | 'PUT' | 'PATCH' | 'DELETE';
+export declare const HTTP_METHODS: readonly ["POST", "GET", "PUT", "PATCH", "DELETE"];
+export type HttpMethod = (typeof HTTP_METHODS)[number];
 export type HttpResponse<T = unknown> = {
     data: T;
     status: number;

package/dist/types/types/index.d.ts

@@ -1,3 +1,4 @@
+export * from './api-version.js';
 export * from './batch.js';
 export * from './entities.js';
 export * from './enums.js';

package/package.json

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