@doist/twist-sdk 2.1.1 → 2.1.3

package/dist/cjs/authentication.js

@@ -47,6 +47,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.TWIST_SCOPES = void 0;
 exports.getAuthStateParameter = getAuthStateParameter;
 exports.getAuthorizationUrl = getAuthorizationUrl;
 exports.getAuthToken = getAuthToken;
@@ -54,6 +55,90 @@ exports.revokeAuthToken = revokeAuthToken;
 var uuid_1 = require("uuid");
 var rest_client_1 = require("./rest-client");
 var errors_1 = require("./types/errors");
+/**
+ * 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
+ */
+exports.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',
+];
 function getAuthStateParameter() {
     return (0, uuid_1.v4)();
 }

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseClient = void 0;
 var endpoints_1 = require("../consts/endpoints");
+var api_version_1 = require("../types/api-version");
 /**
  * Base client class that provides centralized URL management and configuration
  * for all Twist API clients. Fixes the trailing slash bug and eliminates code duplication.
@@ -10,7 +11,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 || api_version_1.DEFAULT_API_VERSION;
         this.customFetch = config.customFetch;
     }
     /**

package/dist/cjs/consts/endpoints.js

@@ -2,8 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ENDPOINT_CONVERSATION_MESSAGES = exports.ENDPOINT_SEARCH = exports.ENDPOINT_REACTIONS = exports.ENDPOINT_INBOX = exports.ENDPOINT_NOTIFICATIONS = exports.ENDPOINT_COMMENTS = exports.ENDPOINT_CONVERSATIONS = exports.ENDPOINT_GROUPS = exports.ENDPOINT_THREADS = exports.ENDPOINT_CHANNELS = exports.ENDPOINT_WORKSPACES = exports.ENDPOINT_USERS = exports.API_BASE_URI = exports.API_VERSION = void 0;
 exports.getTwistBaseUri = getTwistBaseUri;
+var api_version_1 = require("../types/api-version");
 var BASE_URI = 'https://api.twist.com';
-exports.API_VERSION = 'v3';
+exports.API_VERSION = api_version_1.DEFAULT_API_VERSION;
 /**
  * @deprecated Use getTwistBaseUri() instead. This constant is kept for backward compatibility.
  */
@@ -16,7 +17,7 @@ exports.API_BASE_URI = "/api/".concat(exports.API_VERSION, "/");
  * @returns Complete base URI with trailing slash (e.g., 'https://api.twist.com/api/v3/')
  */
 function getTwistBaseUri(version, domainBase) {
-    if (version === void 0) { version = 'v3'; }
+    if (version === void 0) { version = api_version_1.DEFAULT_API_VERSION; }
     if (domainBase === void 0) { domainBase = BASE_URI; }
     return new URL("/api/".concat(version, "/"), domainBase).toString();
 }

package/dist/cjs/types/api-version.js

@@ -1,2 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_API_VERSION = exports.API_VERSIONS = void 0;
+/**
+ * Supported Twist API versions
+ */
+exports.API_VERSIONS = ['v3', 'v4'];
+exports.DEFAULT_API_VERSION = 'v3';

package/dist/cjs/types/entities.js

@@ -11,14 +11,14 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchResultSchema = 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.SystemMessageSchema = void 0;
+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.SystemMessageSchema = void 0;
 var zod_1 = require("zod");
 var url_helpers_1 = require("../utils/url-helpers");
 var enums_1 = require("./enums");
 // Reusable schema for system messages that can be either a string or an object
 exports.SystemMessageSchema = zod_1.z.union([zod_1.z.string(), zod_1.z.unknown()]).nullable().optional();
 // Base user schema with common fields shared between User and WorkspaceUser
-var BaseUserSchema = zod_1.z.object({
+exports.BaseUserSchema = zod_1.z.object({
     id: zod_1.z.number(),
     name: zod_1.z.string(),
     shortName: zod_1.z.string(),
@@ -50,7 +50,7 @@ var BaseUserSchema = zod_1.z.object({
     setupPending: zod_1.z.union([zod_1.z.boolean(), zod_1.z.number()]).nullable().optional(),
 });
 // User entity from API
-exports.UserSchema = BaseUserSchema.extend({
+exports.UserSchema = exports.BaseUserSchema.extend({
     email: zod_1.z.email(),
     snoozeDndStart: zod_1.z.string().nullable().optional(),
     clientId: zod_1.z.string().nullable().optional(),
@@ -262,7 +262,7 @@ exports.CommentSchema = zod_1.z
         commentId: data.id,
     }) })); });
 // WorkspaceUser entity from v4 API
-exports.WorkspaceUserSchema = BaseUserSchema.extend({
+exports.WorkspaceUserSchema = exports.BaseUserSchema.extend({
     email: zod_1.z.string().nullable().optional(),
     userType: zod_1.z.enum(enums_1.USER_TYPES),
     dateFormat: zod_1.z.string().nullable().optional(),
@@ -356,9 +356,10 @@ exports.UnreadConversationSchema = zod_1.z.object({
     directMention: zod_1.z.boolean(),
 });
 // SearchResult entity from API
+exports.SEARCH_RESULT_TYPES = ['thread', 'comment', 'message', 'conversation'];
 exports.SearchResultSchema = zod_1.z.object({
     id: zod_1.z.string(),
-    type: zod_1.z.enum(['thread', 'comment', 'message']),
+    type: zod_1.z.enum(exports.SEARCH_RESULT_TYPES),
     snippet: zod_1.z.string(),
     snippetCreatorId: zod_1.z.number(),
     snippetLastUpdated: zod_1.z.date(),

package/dist/cjs/types/http.js

@@ -1,2 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.HTTP_METHODS = void 0;
+exports.HTTP_METHODS = ['POST', 'GET', 'PUT', 'PATCH', 'DELETE'];

package/dist/cjs/types/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api-version"), exports);
 __exportStar(require("./batch"), exports);
 __exportStar(require("./entities"), exports);
 __exportStar(require("./enums"), exports);

package/dist/esm/authentication.js

@@ -48,6 +48,90 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 import { v4 as uuid } from 'uuid';
 import { isSuccess, request } from './rest-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/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/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/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(),
@@ -353,9 +353,10 @@ export var UnreadConversationSchema = z.object({
     directMention: z.boolean(),
 });
 // SearchResult entity from API
+export var SEARCH_RESULT_TYPES = ['thread', 'comment', 'message', 'conversation'];
 export var SearchResultSchema = z.object({
     id: z.string(),
-    type: z.enum(['thread', 'comment', 'message']),
+    type: z.enum(SEARCH_RESULT_TYPES),
     snippet: z.string(),
     snippetCreatorId: z.number(),
     snippetLastUpdated: z.date(),

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/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;
@@ -829,12 +854,15 @@ export declare const UnreadConversationSchema: z.ZodObject<{
     directMention: z.ZodBoolean;
 }, z.core.$strip>;
 export type UnreadConversation = z.infer<typeof UnreadConversationSchema>;
+export declare const SEARCH_RESULT_TYPES: readonly ["thread", "comment", "message", "conversation"];
+export type SearchResultType = (typeof SEARCH_RESULT_TYPES)[number];
 export declare const SearchResultSchema: z.ZodObject<{
     id: z.ZodString;
     type: z.ZodEnum<{
         thread: "thread";
         comment: "comment";
         message: "message";
+        conversation: "conversation";
     }>;
     snippet: z.ZodString;
     snippetCreatorId: z.ZodNumber;

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.1",
+    "version": "2.1.3",
     "description": "A TypeScript wrapper for the Twist REST API.",
     "author": "Doist developers",
     "homepage": "https://doist.github.io/twist-sdk-typescript/",