@doist/twist-sdk 0.1.0-alpha.2 → 0.1.0-alpha.4

package/dist/batch-builder.d.ts

@@ -1,3 +1,4 @@
+import { BaseClient } from './clients/base-client';
 import type { BatchRequestDescriptor, BatchResponseArray } from './types/batch';
 /**
  * Executes multiple API requests in a single HTTP call.
@@ -10,11 +11,7 @@ import type { BatchRequestDescriptor, BatchResponseArray } from './types/batch';
  * )
  * ```
  */
-export declare class BatchBuilder {
-    private apiToken;
-    private baseUrl?;
-    constructor(apiToken: string, baseUrl?: string | undefined);
-    private getBaseUri;
+export declare class BatchBuilder extends BaseClient {
     /**
      * Executes an array of batch request descriptors in a single API call.
      *

package/dist/batch-builder.js

@@ -1,4 +1,19 @@
 "use strict";
+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) {
@@ -37,6 +52,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BatchBuilder = void 0;
+var base_client_1 = require("./clients/base-client");
 var errors_1 = require("./types/errors");
 var case_conversion_1 = require("./utils/case-conversion");
 var timestamp_conversion_1 = require("./utils/timestamp-conversion");
@@ -51,14 +67,11 @@ var timestamp_conversion_1 = require("./utils/timestamp-conversion");
  * )
  * ```
  */
-var BatchBuilder = /** @class */ (function () {
-    function BatchBuilder(apiToken, baseUrl) {
-        this.apiToken = apiToken;
-        this.baseUrl = baseUrl;
+var BatchBuilder = /** @class */ (function (_super) {
+    __extends(BatchBuilder, _super);
+    function BatchBuilder() {
+        return _super !== null && _super.apply(this, arguments) || this;
     }
-    BatchBuilder.prototype.getBaseUri = function () {
-        return this.baseUrl ? "".concat(this.baseUrl, "/api/v3") : 'https://api.twist.com/api/v3/';
-    };
     /**
      * Executes an array of batch request descriptors in a single API call.
      *
@@ -187,5 +200,5 @@ var BatchBuilder = /** @class */ (function () {
         });
     };
     return BatchBuilder;
-}());
+}(base_client_1.BaseClient));
 exports.BatchBuilder = BatchBuilder;

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

@@ -0,0 +1,27 @@
+import type { ApiVersion } from '../types/api-version';
+export interface ClientConfig {
+    /** API token for authentication */
+    apiToken: string;
+    /** Optional custom base URL. If not provided, uses the default Twist API URL */
+    baseUrl?: string;
+    /** Optional API version. Defaults to 'v3' */
+    version?: ApiVersion;
+}
+/**
+ * Base client class that provides centralized URL management and configuration
+ * for all Twist API clients. Fixes the trailing slash bug and eliminates code duplication.
+ */
+export declare class BaseClient {
+    protected readonly apiToken: string;
+    protected readonly baseUrl?: string;
+    protected readonly defaultVersion: ApiVersion;
+    constructor(config: ClientConfig);
+    /**
+     * Gets the base URI for API requests with proper trailing slash handling.
+     * This method fixes the trailing slash bug that occurred when using custom baseUrl.
+     *
+     * @param version - Optional API version override. Defaults to the configured version or 'v3'
+     * @returns Base URI with guaranteed trailing slash for proper URL resolution
+     */
+    protected getBaseUri(version?: ApiVersion): string;
+}

package/dist/clients/base-client.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseClient = void 0;
+var endpoints_1 = require("../consts/endpoints");
+/**
+ * Base client class that provides centralized URL management and configuration
+ * for all Twist API clients. Fixes the trailing slash bug and eliminates code duplication.
+ */
+var BaseClient = /** @class */ (function () {
+    function BaseClient(config) {
+        this.apiToken = config.apiToken;
+        this.baseUrl = config.baseUrl;
+        this.defaultVersion = config.version || 'v3';
+    }
+    /**
+     * Gets the base URI for API requests with proper trailing slash handling.
+     * This method fixes the trailing slash bug that occurred when using custom baseUrl.
+     *
+     * @param version - Optional API version override. Defaults to the configured version or 'v3'
+     * @returns Base URI with guaranteed trailing slash for proper URL resolution
+     */
+    BaseClient.prototype.getBaseUri = function (version) {
+        var apiVersion = version || this.defaultVersion;
+        if (this.baseUrl) {
+            // Ensure trailing slash to fix URL resolution bug
+            var normalizedBaseUrl = this.baseUrl.endsWith('/') ? this.baseUrl : "".concat(this.baseUrl, "/");
+            return "".concat(normalizedBaseUrl, "api/").concat(apiVersion, "/");
+        }
+        // Use centralized helper function for default Twist API URL
+        return (0, endpoints_1.getTwistBaseUri)(apiVersion);
+    };
+    return BaseClient;
+}());
+exports.BaseClient = BaseClient;

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

@@ -1,14 +1,27 @@
 import type { BatchRequestDescriptor } from '../types/batch';
 import { Channel } from '../types/entities';
 import { CreateChannelArgs, GetChannelsArgs, UpdateChannelArgs } from '../types/requests';
+import { BaseClient } from './base-client';
+export type AddChannelUserArgs = {
+    id: number;
+    userId: number;
+};
+export type AddChannelUsersArgs = {
+    id: number;
+    userIds: number[];
+};
+export type RemoveChannelUserArgs = {
+    id: number;
+    userId: number;
+};
+export type RemoveChannelUsersArgs = {
+    id: number;
+    userIds: number[];
+};
 /**
  * Client for interacting with Twist channel endpoints.
  */
-export declare class ChannelsClient {
-    private apiToken;
-    private baseUrl?;
-    constructor(apiToken: string, baseUrl?: string | undefined);
-    private getBaseUri;
+export declare class ChannelsClient extends BaseClient {
     /**
      * Gets all channels for a given workspace.
      *
@@ -152,63 +165,67 @@ export declare class ChannelsClient {
     /**
      * Adds a user to a channel.
      *
-     * @param id - The channel ID.
-     * @param userId - The user ID to add.
+     * @param args - The arguments for adding a user.
+     * @param args.id - The channel ID.
+     * @param args.userId - The user ID to add.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      *
      * @example
      * ```typescript
-     * await api.channels.addUser(456, 789)
+     * await api.channels.addUser({ id: 456, userId: 789 })
      * ```
      */
-    addUser(id: number, userId: number, options: {
+    addUser(args: AddChannelUserArgs, options: {
         batch: true;
     }): BatchRequestDescriptor<void>;
-    addUser(id: number, userId: number, options?: {
+    addUser(args: AddChannelUserArgs, options?: {
         batch?: false;
     }): Promise<void>;
     /**
      * Adds multiple users to a channel.
      *
-     * @param id - The channel ID.
-     * @param userIds - Array of user IDs to add.
+     * @param args - The arguments for adding users.
+     * @param args.id - The channel ID.
+     * @param args.userIds - Array of user IDs to add.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      *
      * @example
      * ```typescript
-     * await api.channels.addUsers(456, [789, 790, 791])
+     * await api.channels.addUsers({ id: 456, userIds: [789, 790, 791] })
      * ```
      */
-    addUsers(id: number, userIds: number[], options: {
+    addUsers(args: AddChannelUsersArgs, options: {
         batch: true;
     }): BatchRequestDescriptor<void>;
-    addUsers(id: number, userIds: number[], options?: {
+    addUsers(args: AddChannelUsersArgs, options?: {
         batch?: false;
     }): Promise<void>;
     /**
      * Removes a user from a channel.
      *
-     * @param id - The channel ID.
-     * @param userId - The user ID to remove.
+     * @param args - The arguments for removing a user.
+     * @param args.id - The channel ID.
+     * @param args.userId - The user ID to remove.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      */
-    removeUser(id: number, userId: number, options: {
+    removeUser(args: RemoveChannelUserArgs, options: {
         batch: true;
     }): BatchRequestDescriptor<void>;
-    removeUser(id: number, userId: number, options?: {
+    removeUser(args: RemoveChannelUserArgs, options?: {
         batch?: false;
     }): Promise<void>;
     /**
      * Removes multiple users from a channel.
      *
-     * @param id - The channel ID.
-     * @param userIds - Array of user IDs to remove.
+     * @param args - The arguments for removing users.
+     * @param args.id - The channel ID.
+     * @param args.userIds - Array of user IDs to remove.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      */
-    removeUsers(id: number, userIds: number[], options: {
+    removeUsers(args: RemoveChannelUsersArgs, options: {
         batch: true;
     }): BatchRequestDescriptor<void>;
-    removeUsers(id: number, userIds: number[], options?: {
+    removeUsers(args: RemoveChannelUsersArgs, options?: {
         batch?: false;
     }): Promise<void>;
 }

package/dist/clients/channels-client.js

@@ -1,20 +1,33 @@
 "use strict";
+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 __());
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChannelsClient = void 0;
 var endpoints_1 = require("../consts/endpoints");
 var rest_client_1 = require("../rest-client");
 var entities_1 = require("../types/entities");
+var base_client_1 = require("./base-client");
 /**
  * Client for interacting with Twist channel endpoints.
  */
-var ChannelsClient = /** @class */ (function () {
-    function ChannelsClient(apiToken, baseUrl) {
-        this.apiToken = apiToken;
-        this.baseUrl = baseUrl;
+var ChannelsClient = /** @class */ (function (_super) {
+    __extends(ChannelsClient, _super);
+    function ChannelsClient() {
+        return _super !== null && _super.apply(this, arguments) || this;
     }
-    ChannelsClient.prototype.getBaseUri = function () {
-        return this.baseUrl ? "".concat(this.baseUrl, "/api/v3") : (0, endpoints_1.getTwistBaseUri)();
-    };
     ChannelsClient.prototype.getChannels = function (args, options) {
         var method = 'GET';
         var url = "".concat(endpoints_1.ENDPOINT_CHANNELS, "/get");
@@ -99,42 +112,42 @@ var ChannelsClient = /** @class */ (function () {
         }
         return (0, rest_client_1.request)(method, this.getBaseUri(), url, this.apiToken, params).then(function () { return undefined; });
     };
-    ChannelsClient.prototype.addUser = function (id, userId, options) {
+    ChannelsClient.prototype.addUser = function (args, options) {
         var method = 'POST';
         var url = "".concat(endpoints_1.ENDPOINT_CHANNELS, "/add_user");
-        var params = { id: id, userId: userId };
+        var params = { id: args.id, userId: args.userId };
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params };
         }
         return (0, rest_client_1.request)(method, this.getBaseUri(), url, this.apiToken, params).then(function () { return undefined; });
     };
-    ChannelsClient.prototype.addUsers = function (id, userIds, options) {
+    ChannelsClient.prototype.addUsers = function (args, options) {
         var method = 'POST';
         var url = "".concat(endpoints_1.ENDPOINT_CHANNELS, "/add_users");
-        var params = { id: id, userIds: userIds };
+        var params = { id: args.id, userIds: args.userIds };
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params };
         }
         return (0, rest_client_1.request)(method, this.getBaseUri(), url, this.apiToken, params).then(function () { return undefined; });
     };
-    ChannelsClient.prototype.removeUser = function (id, userId, options) {
+    ChannelsClient.prototype.removeUser = function (args, options) {
         var method = 'POST';
         var url = "".concat(endpoints_1.ENDPOINT_CHANNELS, "/remove_user");
-        var params = { id: id, userId: userId };
+        var params = { id: args.id, userId: args.userId };
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params };
         }
         return (0, rest_client_1.request)(method, this.getBaseUri(), url, this.apiToken, params).then(function () { return undefined; });
     };
-    ChannelsClient.prototype.removeUsers = function (id, userIds, options) {
+    ChannelsClient.prototype.removeUsers = function (args, options) {
         var method = 'POST';
         var url = "".concat(endpoints_1.ENDPOINT_CHANNELS, "/remove_users");
-        var params = { id: id, userIds: userIds };
+        var params = { id: args.id, userIds: args.userIds };
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params };
         }
         return (0, rest_client_1.request)(method, this.getBaseUri(), url, this.apiToken, params).then(function () { return undefined; });
     };
     return ChannelsClient;
-}());
+}(base_client_1.BaseClient));
 exports.ChannelsClient = ChannelsClient;

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

@@ -1,14 +1,15 @@
 import type { BatchRequestDescriptor } from '../types/batch';
 import { Comment } from '../types/entities';
 import { CreateCommentArgs, GetCommentsArgs, UpdateCommentArgs } from '../types/requests';
+import { BaseClient } from './base-client';
+export type MarkCommentPositionArgs = {
+    threadId: number;
+    commentId: number;
+};
 /**
  * Client for interacting with Twist comment endpoints.
  */
-export declare class CommentsClient {
-    private apiToken;
-    private baseUrl?;
-    constructor(apiToken: string, baseUrl?: string | undefined);
-    private getBaseUri;
+export declare class CommentsClient extends BaseClient {
     /**
      * Gets all comments for a thread.
      *
@@ -106,19 +107,20 @@ export declare class CommentsClient {
      * Marks the user's read position in a thread. Used to track where the user has read up to,
      * so clients can scroll to this position and show a visual indicator (blue line).
      *
-     * @param threadId - The thread ID.
-     * @param commentId - The comment ID to mark as the last read position.
+     * @param args - The arguments for marking read position.
+     * @param args.threadId - The thread ID.
+     * @param args.commentId - The comment ID to mark as the last read position.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      *
      * @example
      * ```typescript
-     * await api.comments.markPosition(789, 206113)
+     * await api.comments.markPosition({ threadId: 789, commentId: 206113 })
      * ```
      */
-    markPosition(threadId: number, commentId: number, options: {
+    markPosition(args: MarkCommentPositionArgs, options: {
         batch: true;
     }): BatchRequestDescriptor<void>;
-    markPosition(threadId: number, commentId: number, options?: {
+    markPosition(args: MarkCommentPositionArgs, options?: {
         batch?: false;
     }): Promise<void>;
 }

package/dist/clients/comments-client.js

@@ -1,20 +1,33 @@
 "use strict";
+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 __());
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommentsClient = void 0;
 var endpoints_1 = require("../consts/endpoints");
 var rest_client_1 = require("../rest-client");
 var entities_1 = require("../types/entities");
+var base_client_1 = require("./base-client");
 /**
  * Client for interacting with Twist comment endpoints.
  */
-var CommentsClient = /** @class */ (function () {
-    function CommentsClient(apiToken, baseUrl) {
-        this.apiToken = apiToken;
-        this.baseUrl = baseUrl;
+var CommentsClient = /** @class */ (function (_super) {
+    __extends(CommentsClient, _super);
+    function CommentsClient() {
+        return _super !== null && _super.apply(this, arguments) || this;
     }
-    CommentsClient.prototype.getBaseUri = function () {
-        return this.baseUrl ? "".concat(this.baseUrl, "/api/v3") : (0, endpoints_1.getTwistBaseUri)();
-    };
     CommentsClient.prototype.getComments = function (args, options) {
         var params = {
             thread_id: args.threadId,
@@ -69,12 +82,12 @@ var CommentsClient = /** @class */ (function () {
         }
         return (0, rest_client_1.request)(method, this.getBaseUri(), url, this.apiToken, params).then(function () { return undefined; });
     };
-    CommentsClient.prototype.markPosition = function (threadId, commentId, options) {
+    CommentsClient.prototype.markPosition = function (args, options) {
         var method = 'POST';
         var url = "".concat(endpoints_1.ENDPOINT_COMMENTS, "/mark_position");
         var params = {
-            thread_id: threadId,
-            comment_id: commentId,
+            thread_id: args.threadId,
+            comment_id: args.commentId,
         };
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params };
@@ -82,5 +95,5 @@ var CommentsClient = /** @class */ (function () {
         return (0, rest_client_1.request)(method, this.getBaseUri(), url, this.apiToken, params).then(function () { return undefined; });
     };
     return CommentsClient;
-}());
+}(base_client_1.BaseClient));
 exports.CommentsClient = CommentsClient;

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

@@ -1,5 +1,6 @@
 import type { BatchRequestDescriptor } from '../types/batch';
 import { ConversationMessage } from '../types/entities';
+import { BaseClient } from './base-client';
 type GetConversationMessagesArgs = {
     conversationId: number;
     newerThan?: Date;
@@ -21,11 +22,7 @@ type UpdateConversationMessageArgs = {
 /**
  * Client for interacting with Twist conversation message endpoints.
  */
-export declare class ConversationMessagesClient {
-    private apiToken;
-    private baseUrl?;
-    constructor(apiToken: string, baseUrl?: string | undefined);
-    private getBaseUri;
+export declare class ConversationMessagesClient extends BaseClient {
     /**
      * Gets all messages in a conversation.
      *

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

@@ -1,20 +1,33 @@
 "use strict";
+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 __());
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConversationMessagesClient = void 0;
 var endpoints_1 = require("../consts/endpoints");
 var rest_client_1 = require("../rest-client");
 var entities_1 = require("../types/entities");
+var base_client_1 = require("./base-client");
 /**
  * Client for interacting with Twist conversation message endpoints.
  */
-var ConversationMessagesClient = /** @class */ (function () {
-    function ConversationMessagesClient(apiToken, baseUrl) {
-        this.apiToken = apiToken;
-        this.baseUrl = baseUrl;
+var ConversationMessagesClient = /** @class */ (function (_super) {
+    __extends(ConversationMessagesClient, _super);
+    function ConversationMessagesClient() {
+        return _super !== null && _super.apply(this, arguments) || this;
     }
-    ConversationMessagesClient.prototype.getBaseUri = function () {
-        return this.baseUrl ? "".concat(this.baseUrl, "/api/v3") : (0, endpoints_1.getTwistBaseUri)();
-    };
     ConversationMessagesClient.prototype.getMessages = function (args, options) {
         var params = {
             conversation_id: args.conversationId,
@@ -88,5 +101,5 @@ var ConversationMessagesClient = /** @class */ (function () {
         return (0, rest_client_1.request)(method, this.getBaseUri(), url, this.apiToken, params).then(function () { return undefined; });
     };
     return ConversationMessagesClient;
-}());
+}(base_client_1.BaseClient));
 exports.ConversationMessagesClient = ConversationMessagesClient;