@doist/twist-sdk 2.5.1 → 2.6.0

package/dist/cjs/clients/add-comment-helper.js

@@ -10,16 +10,58 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addCommentRequest = addCommentRequest;
 var endpoints_1 = require("../consts/endpoints");
 var http_client_1 = require("../transport/http-client");
 var entities_1 = require("../types/entities");
+var enums_1 = require("../types/enums");
+var SENTINEL_GROUP_IDS = new Set(Object.values(enums_1.NOTIFY_AUDIENCE_GROUP_IDS));
+function isNotifyAudience(value) {
+    return typeof value === 'string' && enums_1.NOTIFY_AUDIENCES.includes(value);
+}
+function applyNotifyAudience(params) {
+    if (params.groups) {
+        var offending = params.groups.filter(function (id) { return SENTINEL_GROUP_IDS.has(id); });
+        if (offending.length > 0) {
+            throw new Error("`groups` must not contain reserved sentinel IDs (".concat(offending.join(', '), "). Use `notifyAudience` instead."));
+        }
+    }
+    if (params.notifyAudience == null)
+        return params;
+    if (!isNotifyAudience(params.notifyAudience)) {
+        throw new Error("Invalid `notifyAudience` value \"".concat(String(params.notifyAudience), "\". Expected one of: ").concat(enums_1.NOTIFY_AUDIENCES.join(', '), "."));
+    }
+    var sentinel = enums_1.NOTIFY_AUDIENCE_GROUP_IDS[params.notifyAudience];
+    var _stripped = params.notifyAudience, groups = params.groups, rest = __rest(params, ["notifyAudience", "groups"]);
+    return __assign(__assign({}, rest), { groups: __spreadArray(__spreadArray([], (groups !== null && groups !== void 0 ? groups : []), true), [sentinel], false) });
+}
 function addCommentRequest(context, params, options) {
     var method = 'POST';
     var url = "".concat(endpoints_1.ENDPOINT_COMMENTS, "/add");
+    var normalized = applyNotifyAudience(params);
     var payload = (options === null || options === void 0 ? void 0 : options.threadAction)
-        ? __assign(__assign({}, params), { threadAction: options.threadAction }) : params;
+        ? __assign(__assign({}, normalized), { threadAction: options.threadAction }) : normalized;
     var schema = entities_1.CommentSchema;
     if (options === null || options === void 0 ? void 0 : options.batch) {
         return { method: method, url: url, params: payload, schema: schema };

package/dist/cjs/types/enums.js

@@ -1,7 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WORKSPACE_PLANS = exports.USER_TYPES = void 0;
+exports.NOTIFY_AUDIENCE_GROUP_IDS = exports.NOTIFY_AUDIENCES = exports.WORKSPACE_PLANS = exports.USER_TYPES = void 0;
 // User types for workspace users
 exports.USER_TYPES = ['USER', 'GUEST', 'ADMIN'];
 // Workspace plans
 exports.WORKSPACE_PLANS = ['free', 'unlimited'];
+// Audiences that comment-creating endpoints can target alongside (or instead
+// of) individual `recipients` / custom `groups`.
+exports.NOTIFY_AUDIENCES = ['channel', 'thread'];
+/**
+ * Internal mapping from {@link NotifyAudience} to the magic group IDs that
+ * Twist's `comments/add` endpoint uses on the wire. Exposed here so the
+ * audience constants and their encoding stay in a single source of truth;
+ * SDK consumers should use {@link NotifyAudience} via `notifyAudience` on the
+ * request args rather than passing these IDs directly.
+ */
+exports.NOTIFY_AUDIENCE_GROUP_IDS = {
+    channel: 1,
+    thread: 2,
+};

package/dist/cjs/types/requests.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.THREAD_ACTIONS = exports.ARCHIVE_FILTER_VALUES = exports.AWAY_MODE_TYPES = exports.GetOrCreateConversationArgsSchema = exports.GetConversationsArgsSchema = exports.GetCommentsArgsSchema = exports.GetThreadsArgsSchema = exports.GetChannelsArgsSchema = exports.CreateMessageArgsSchema = exports.CreateConversationArgsSchema = exports.UpdateCommentArgsSchema = exports.CreateCommentArgsSchema = exports.UpdateThreadArgsSchema = exports.CreateThreadArgsSchema = exports.UpdateChannelArgsSchema = exports.CreateChannelArgsSchema = void 0;
 var zod_1 = require("zod");
+var enums_1 = require("./enums");
 exports.CreateChannelArgsSchema = zod_1.z.object({
     workspaceId: zod_1.z.number(),
     name: zod_1.z.string(),
@@ -46,6 +47,9 @@ exports.CreateCommentArgsSchema = zod_1.z.object({
     attachments: zod_1.z.unknown().nullable().optional(),
     actions: zod_1.z.unknown().nullable().optional(),
     recipients: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    groups: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    directMentions: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    notifyAudience: zod_1.z.enum(enums_1.NOTIFY_AUDIENCES).nullable().optional(),
 });
 exports.UpdateCommentArgsSchema = zod_1.z.object({
     id: zod_1.z.number(),

package/dist/esm/clients/add-comment-helper.js

@@ -9,14 +9,56 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 import { ENDPOINT_COMMENTS } from '../consts/endpoints.js';
 import { request } from '../transport/http-client.js';
 import { CommentSchema } from '../types/entities.js';
+import { NOTIFY_AUDIENCE_GROUP_IDS, NOTIFY_AUDIENCES } from '../types/enums.js';
+var SENTINEL_GROUP_IDS = new Set(Object.values(NOTIFY_AUDIENCE_GROUP_IDS));
+function isNotifyAudience(value) {
+    return typeof value === 'string' && NOTIFY_AUDIENCES.includes(value);
+}
+function applyNotifyAudience(params) {
+    if (params.groups) {
+        var offending = params.groups.filter(function (id) { return SENTINEL_GROUP_IDS.has(id); });
+        if (offending.length > 0) {
+            throw new Error("`groups` must not contain reserved sentinel IDs (".concat(offending.join(', '), "). Use `notifyAudience` instead."));
+        }
+    }
+    if (params.notifyAudience == null)
+        return params;
+    if (!isNotifyAudience(params.notifyAudience)) {
+        throw new Error("Invalid `notifyAudience` value \"".concat(String(params.notifyAudience), "\". Expected one of: ").concat(NOTIFY_AUDIENCES.join(', '), "."));
+    }
+    var sentinel = NOTIFY_AUDIENCE_GROUP_IDS[params.notifyAudience];
+    var _stripped = params.notifyAudience, groups = params.groups, rest = __rest(params, ["notifyAudience", "groups"]);
+    return __assign(__assign({}, rest), { groups: __spreadArray(__spreadArray([], (groups !== null && groups !== void 0 ? groups : []), true), [sentinel], false) });
+}
 export function addCommentRequest(context, params, options) {
     var method = 'POST';
     var url = "".concat(ENDPOINT_COMMENTS, "/add");
+    var normalized = applyNotifyAudience(params);
     var payload = (options === null || options === void 0 ? void 0 : options.threadAction)
-        ? __assign(__assign({}, params), { threadAction: options.threadAction }) : params;
+        ? __assign(__assign({}, normalized), { threadAction: options.threadAction }) : normalized;
     var schema = CommentSchema;
     if (options === null || options === void 0 ? void 0 : options.batch) {
         return { method: method, url: url, params: payload, schema: schema };

package/dist/esm/types/enums.js

@@ -2,3 +2,17 @@
 export var USER_TYPES = ['USER', 'GUEST', 'ADMIN'];
 // Workspace plans
 export var WORKSPACE_PLANS = ['free', 'unlimited'];
+// Audiences that comment-creating endpoints can target alongside (or instead
+// of) individual `recipients` / custom `groups`.
+export var NOTIFY_AUDIENCES = ['channel', 'thread'];
+/**
+ * Internal mapping from {@link NotifyAudience} to the magic group IDs that
+ * Twist's `comments/add` endpoint uses on the wire. Exposed here so the
+ * audience constants and their encoding stay in a single source of truth;
+ * SDK consumers should use {@link NotifyAudience} via `notifyAudience` on the
+ * request args rather than passing these IDs directly.
+ */
+export var NOTIFY_AUDIENCE_GROUP_IDS = {
+    channel: 1,
+    thread: 2,
+};

package/dist/esm/types/requests.js

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { NOTIFY_AUDIENCES } from './enums.js';
 export var CreateChannelArgsSchema = z.object({
     workspaceId: z.number(),
     name: z.string(),
@@ -43,6 +44,9 @@ export var CreateCommentArgsSchema = z.object({
     attachments: z.unknown().nullable().optional(),
     actions: z.unknown().nullable().optional(),
     recipients: z.array(z.number()).nullable().optional(),
+    groups: z.array(z.number()).nullable().optional(),
+    directMentions: z.array(z.number()).nullable().optional(),
+    notifyAudience: z.enum(NOTIFY_AUDIENCES).nullable().optional(),
 });
 export var UpdateCommentArgsSchema = z.object({
     id: z.number(),

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

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

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

@@ -52,7 +52,13 @@ export declare class CommentsClient extends BaseClient {
      * @param args - The arguments for creating a comment.
      * @param args.threadId - The thread ID.
      * @param args.content - The comment content.
-     * @param args.recipients - Optional array of user IDs to notify.
+     * @param args.recipients - Optional array of user IDs to notify directly.
+     * @param args.groups - Optional array of custom group IDs to notify.
+     * @param args.directMentions - Optional array of user IDs that were @-mentioned in
+     *   `content`.
+     * @param args.notifyAudience - Optional broader audience to notify in addition to
+     *   `recipients` and `groups`. `'channel'` notifies everyone in the channel;
+     *   `'thread'` notifies everyone who has interacted with the thread.
      * @param args.attachments - Optional array of attachment objects.
      * @param args.sendAsIntegration - Optional flag to send as integration.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
@@ -60,9 +66,12 @@ export declare class CommentsClient extends BaseClient {
      *
      * @example
      * ```typescript
+     * // Notify everyone who has interacted with the thread, plus two extra users.
      * const comment = await api.comments.createComment({
      *   threadId: 789,
-     *   content: 'Great idea! Let\'s proceed with this approach.'
+     *   content: 'Great idea! Let\'s proceed.',
+     *   notifyAudience: 'thread',
+     *   recipients: [12345, 67890],
      * })
      * ```
      */

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

@@ -330,7 +330,13 @@ export declare class ThreadsClient extends BaseClient {
      * @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 args.recipients - Optional array of user IDs to notify directly.
+     * @param args.groups - Optional array of custom group IDs to notify.
+     * @param args.directMentions - Optional array of user IDs that were @-mentioned in
+     *   `content`.
+     * @param args.notifyAudience - Optional broader audience to notify in addition to
+     *   `recipients` and `groups`. `'channel'` notifies everyone in the channel;
+     *   `'thread'` notifies everyone who has interacted with the thread.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns The created comment object.
      *
@@ -357,7 +363,13 @@ export declare class ThreadsClient extends BaseClient {
      * @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 args.recipients - Optional array of user IDs to notify directly.
+     * @param args.groups - Optional array of custom group IDs to notify.
+     * @param args.directMentions - Optional array of user IDs that were @-mentioned in
+     *   `content`.
+     * @param args.notifyAudience - Optional broader audience to notify in addition to
+     *   `recipients` and `groups`. `'channel'` notifies everyone in the channel;
+     *   `'thread'` notifies everyone who has interacted with the thread.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns The created comment object.
      *

package/dist/types/types/enums.d.ts

@@ -19,3 +19,22 @@ export declare const WORKSPACE_PLANS: readonly ["free", "unlimited"];
  * - `'unlimited'` - Unlimited plan
  */
 export type WorkspacePlan = (typeof WORKSPACE_PLANS)[number];
+export declare const NOTIFY_AUDIENCES: readonly ["channel", "thread"];
+/**
+ * The audience to notify when posting a comment, in addition to any
+ * individual `recipients` or custom `groups`.
+ *
+ * @remarks
+ * Possible values:
+ * - `'channel'` - Notify everyone in the channel.
+ * - `'thread'` - Notify everyone who has interacted with the thread.
+ */
+export type NotifyAudience = (typeof NOTIFY_AUDIENCES)[number];
+/**
+ * Internal mapping from {@link NotifyAudience} to the magic group IDs that
+ * Twist's `comments/add` endpoint uses on the wire. Exposed here so the
+ * audience constants and their encoding stay in a single source of truth;
+ * SDK consumers should use {@link NotifyAudience} via `notifyAudience` on the
+ * request args rather than passing these IDs directly.
+ */
+export declare const NOTIFY_AUDIENCE_GROUP_IDS: Readonly<Record<NotifyAudience, number>>;

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

@@ -47,6 +47,12 @@ export declare const CreateCommentArgsSchema: z.ZodObject<{
     attachments: z.ZodOptional<z.ZodNullable<z.ZodUnknown>>;
     actions: z.ZodOptional<z.ZodNullable<z.ZodUnknown>>;
     recipients: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    groups: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    directMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    notifyAudience: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        channel: "channel";
+        thread: "thread";
+    }>>>;
 }, z.core.$strip>;
 export type CreateCommentArgs = z.infer<typeof CreateCommentArgsSchema>;
 export declare const UpdateCommentArgsSchema: z.ZodObject<{
@@ -234,22 +240,16 @@ export type RemoveChannelUsersArgs = {
 };
 export declare const THREAD_ACTIONS: readonly ["close", "reopen"];
 export type ThreadAction = (typeof THREAD_ACTIONS)[number];
-export type CloseThreadArgs = {
+/**
+ * Shared shape for endpoints that post a comment as part of a thread action
+ * (close, reopen). Identical to {@link CreateCommentArgs} except the target
+ * is identified by `id` (the thread ID) instead of `threadId`.
+ */
+type ThreadActionCommentArgs = Omit<CreateCommentArgs, 'threadId'> & {
     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 CloseThreadArgs = ThreadActionCommentArgs;
+export type ReopenThreadArgs = ThreadActionCommentArgs;
 export type MoveThreadToChannelArgs = {
     id: number;
     toChannel: number;

package/package.json

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