@doist/comms-sdk 0.0.1 → 0.2.0

package/dist/cjs/types/entities.js

@@ -0,0 +1,411 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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.AttachmentSchema = exports.StatusOkSchema = exports.SystemMessageSchema = void 0;
+const zod_1 = require("zod");
+const url_helpers_1 = require("../utils/url-helpers");
+const enums_1 = require("./enums");
+// EVERYONE / EVERYONE_IN_THREAD / GROUP_ID_MARKERS / GroupId / GroupIdMarker
+// are defined in `./enums` (re-exported through `./index`) to keep this
+// module from depending back on `./enums` for them. They're available
+// from the same public surface (`@doist/comms-sdk`) either way.
+// Reusable schema for system messages that can be either a string or an
+// object. Nullable — the backend returns `null` when there is no system
+// message.
+exports.SystemMessageSchema = zod_1.z.union([zod_1.z.string(), zod_1.z.unknown()]).nullable().optional();
+/**
+ * Shared `{ status: "ok" }` response shape. Pinned to the literal `'ok'`
+ * so a regression on the backend (e.g. a status code change) surfaces as
+ * a parse error here instead of being silently typed away. Most write
+ * endpoints that don't return an entity use this — archive / unarchive /
+ * mark-read / mark-all-read / mute / clear-unread / etc.
+ */
+exports.StatusOkSchema = zod_1.z.object({ status: zod_1.z.literal('ok') });
+// Attachment entity from API. Mirrors the canonical backend shape produced
+// by `unify_attachments` / `validate_file_attachment_json`. Only
+// `attachmentId` and `urlType` are guaranteed; everything else depends on
+// the attachment kind (file vs image vs link preview vs unfurled GIF).
+// Loose: unknown keys from the backend pass through rather than being
+// stripped, so newly-added or off-spec fields stay accessible to callers.
+exports.AttachmentSchema = zod_1.z
+    .object({
+    attachmentId: zod_1.z.string(),
+    urlType: zod_1.z.string(),
+    title: zod_1.z.string().nullable().optional(),
+    url: zod_1.z.string().nullable().optional(),
+    fileName: zod_1.z.string().nullable().optional(),
+    fileSize: zod_1.z.number().int().nonnegative().nullable().optional(),
+    underlyingType: zod_1.z.string().nullable().optional(),
+    description: zod_1.z.string().nullable().optional(),
+    image: zod_1.z.string().nullable().optional(),
+    imageWidth: zod_1.z.number().int().nonnegative().nullable().optional(),
+    imageHeight: zod_1.z.number().int().nonnegative().nullable().optional(),
+    duration: zod_1.z.string().nullable().optional(),
+    uploadState: zod_1.z.string().nullable().optional(),
+    video: zod_1.z.string().nullable().optional(),
+    videoType: zod_1.z.string().nullable().optional(),
+    videoAutoPlay: zod_1.z.boolean().nullable().optional(),
+})
+    .loose();
+// Fields shared by `User` and `WorkspaceUser`. Profile fields
+// (`fullName`, `imageId`, avatar URLs) are sourced from Todoist-ID.
+exports.BaseUserSchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    fullName: zod_1.z.string(),
+    shortName: zod_1.z.string(),
+    firstName: zod_1.z.string().nullable().optional(),
+    timezone: zod_1.z.string(),
+    removed: zod_1.z.boolean(),
+    imageId: zod_1.z.string().nullable().optional(),
+    avatarUrls: zod_1.z
+        .object({
+        s35: zod_1.z.string(),
+        s60: zod_1.z.string(),
+        s195: zod_1.z.string(),
+        s640: zod_1.z.string(),
+    })
+        .nullable()
+        .optional(),
+    restricted: zod_1.z.boolean().nullable().optional(),
+    setupPending: zod_1.z.boolean().nullable().optional(),
+});
+// User entity from API.
+exports.UserSchema = exports.BaseUserSchema.extend({
+    email: zod_1.z.email(),
+    clientId: zod_1.z.string().nullable().optional(),
+    cometChannel: zod_1.z.string().nullable().optional(),
+    lang: zod_1.z.string(),
+    cometServer: zod_1.z.string().nullable().optional(),
+    token: zod_1.z.string().nullable().optional(),
+    scheduledBanners: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+});
+// Workspace entity from API. `default_conversation` is a base58 UUIDv7
+// string. `avatar_id` is kept (unlike the User rename to `image_id`,
+// which is a User-only change per Comms_API_changes.md PR #125).
+// `plan` is intentionally `z.string()` — see {@link WORKSPACE_PLANS}.
+exports.WorkspaceSchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    name: zod_1.z.string(),
+    defaultConversation: zod_1.z.string().nullable().optional(),
+    creator: zod_1.z.number(),
+    created: zod_1.z.date(),
+    avatarId: zod_1.z.string().nullable().optional(),
+    avatarUrls: zod_1.z
+        .object({
+        s35: zod_1.z.string(),
+        s60: zod_1.z.string(),
+        s195: zod_1.z.string(),
+        s640: zod_1.z.string(),
+    })
+        .nullable()
+        .optional(),
+    plan: zod_1.z.string().nullable().optional(),
+});
+exports.ChannelSchema = zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    name: zod_1.z.string(),
+    description: zod_1.z.string().nullable().optional(),
+    creator: zod_1.z.number(),
+    userIds: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    color: zod_1.z.number().nullable().optional(),
+    public: zod_1.z.boolean(),
+    workspaceId: zod_1.z.number(),
+    archived: zod_1.z.boolean(),
+    created: zod_1.z.date(),
+    useDefaultRecipients: zod_1.z.boolean().nullable().optional(),
+    defaultGroups: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+    defaultRecipients: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    isFavorited: zod_1.z.boolean().nullable().optional(),
+    icon: zod_1.z.number().nullable().optional(),
+    version: zod_1.z.number(),
+    filters: zod_1.z.record(zod_1.z.string(), zod_1.z.string()).nullable().optional(),
+})
+    .transform((data) => ({
+    ...data,
+    url: (0, url_helpers_1.getFullCommsURL)({ workspaceId: data.workspaceId, channelId: data.id }),
+}));
+// Thread entity from API. `pinned` (boolean) and `pinnedTs` (epoch ms or
+// null) are both surfaced — `pinned` is kept for Zapier/webhook clients.
+exports.ThreadSchema = zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    title: zod_1.z.string(),
+    content: zod_1.z.string(),
+    creator: zod_1.z.number(),
+    creatorName: zod_1.z.string().nullable().optional(),
+    channelId: zod_1.z.string(),
+    workspaceId: zod_1.z.number(),
+    actions: zod_1.z.array(zod_1.z.unknown()).nullable().optional(),
+    attachments: zod_1.z.array(exports.AttachmentSchema).nullable().optional(),
+    commentCount: zod_1.z.number(),
+    closed: zod_1.z.boolean().nullable().optional(),
+    directGroupMentions: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+    directMentions: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    groups: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+    lastEdited: zod_1.z.date().nullable().optional(),
+    lastObjIndex: zod_1.z.number().nullable().optional(),
+    lastUpdated: zod_1.z.date(),
+    mutedUntil: zod_1.z.date().nullable().optional(),
+    participants: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    // Backend wire shape only includes `pinned_ts` (epoch ms or null);
+    // derive `pinned` from `pinnedTs != null` if you need a bool.
+    pinned: zod_1.z.boolean().optional(),
+    pinnedTs: zod_1.z.number().int().nullable().optional(),
+    posted: zod_1.z.date(),
+    reactions: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).nullable().optional(),
+    recipients: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    responders: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    snippet: zod_1.z.string(),
+    snippetCreator: zod_1.z.number(),
+    snippetMaskAvatarUrl: zod_1.z.string().nullable().optional(),
+    snippetMaskPoster: zod_1.z.string().nullable().optional(),
+    systemMessage: exports.SystemMessageSchema,
+    toEmails: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+    isArchived: zod_1.z.boolean(),
+    isSaved: zod_1.z.boolean().nullable().optional(),
+    inInbox: zod_1.z.boolean().nullable().optional(),
+    lastComment: zod_1.z
+        .object({
+        id: zod_1.z.string(),
+        content: zod_1.z.string(),
+        creator: zod_1.z.number(),
+        creatorName: zod_1.z.string(),
+        threadId: zod_1.z.string(),
+        channelId: zod_1.z.string(),
+        posted: zod_1.z.date(),
+        systemMessage: exports.SystemMessageSchema,
+        attachments: zod_1.z.array(exports.AttachmentSchema).nullable().optional(),
+        reactions: zod_1.z.record(zod_1.z.string(), zod_1.z.array(zod_1.z.number())).nullable().optional(),
+        actions: zod_1.z.array(zod_1.z.unknown()).nullable().optional(),
+        objIndex: zod_1.z.number(),
+        lastEdited: zod_1.z.date().nullable().optional(),
+        deleted: zod_1.z.boolean(),
+        deletedBy: zod_1.z.number().nullable().optional(),
+        directGroupMentions: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+        directMentions: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+        groups: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+        recipients: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+        toEmails: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+        version: zod_1.z.number(),
+        workspaceId: zod_1.z.number(),
+    })
+        .nullable()
+        .optional(),
+})
+    .transform((data) => ({
+    ...data,
+    url: (0, url_helpers_1.getFullCommsURL)({
+        workspaceId: data.workspaceId,
+        channelId: data.channelId,
+        threadId: data.id,
+    }),
+}));
+// Group entity from API. The broadcast markers `EVERYONE` and
+// `EVERYONE_IN_THREAD` can appear in place of a real `id` in group-bearing
+// fields on threads/comments/channels.
+exports.GroupSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    name: zod_1.z.string(),
+    description: zod_1.z.string().nullable().optional(),
+    workspaceId: zod_1.z.number(),
+    userIds: zod_1.z.array(zod_1.z.number()),
+    version: zod_1.z.number(),
+});
+// Conversation entity from API.
+exports.ConversationSchema = zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    workspaceId: zod_1.z.number(),
+    userIds: zod_1.z.array(zod_1.z.number()),
+    messageCount: zod_1.z.number().nullable().optional(),
+    lastObjIndex: zod_1.z.number(),
+    snippet: zod_1.z.string(),
+    snippetCreators: zod_1.z.array(zod_1.z.number()),
+    lastActive: zod_1.z.date(),
+    mutedUntil: zod_1.z.date().nullable().optional(),
+    archived: zod_1.z.boolean(),
+    created: zod_1.z.date(),
+    creator: zod_1.z.number(),
+    title: zod_1.z.string().nullable().optional(),
+    private: zod_1.z.boolean().nullable().optional(),
+    lastMessage: zod_1.z
+        .object({
+        // `id` may be string or number depending on the endpoint; coerced.
+        id: zod_1.z.union([zod_1.z.string(), zod_1.z.number()]).transform(String),
+        content: zod_1.z.string(),
+        creator: zod_1.z.number(),
+        conversationId: zod_1.z.string(),
+        posted: zod_1.z.date(),
+        systemMessage: exports.SystemMessageSchema,
+        attachments: zod_1.z.array(exports.AttachmentSchema).nullable().optional(),
+        reactions: zod_1.z.record(zod_1.z.string(), zod_1.z.array(zod_1.z.number())).nullable().optional(),
+        actions: zod_1.z.array(zod_1.z.unknown()).nullable().optional(),
+        objIndex: zod_1.z.number().nullable().optional(),
+        lastEdited: zod_1.z.date().nullable().optional(),
+        deleted: zod_1.z.boolean().nullable().optional(),
+        directGroupMentions: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+        directMentions: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+        version: zod_1.z.number().nullable().optional(),
+        workspaceId: zod_1.z.number().nullable().optional(),
+    })
+        .nullable()
+        .optional(),
+})
+    .transform((data) => ({
+    ...data,
+    url: (0, url_helpers_1.getFullCommsURL)({ workspaceId: data.workspaceId, conversationId: data.id }),
+}));
+exports.CommentSchema = zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    content: zod_1.z.string(),
+    creator: zod_1.z.number(),
+    threadId: zod_1.z.string(),
+    workspaceId: zod_1.z.number(),
+    conversationId: zod_1.z.string().nullable().optional(),
+    posted: zod_1.z.date(),
+    lastEdited: zod_1.z.date().nullable().optional(),
+    directMentions: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    directGroupMentions: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+    systemMessage: exports.SystemMessageSchema,
+    attachments: zod_1.z.array(exports.AttachmentSchema).nullable().optional(),
+    reactions: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).nullable().optional(),
+    objIndex: zod_1.z.number().nullable().optional(),
+    creatorName: zod_1.z.string().nullable().optional(),
+    channelId: zod_1.z.string(),
+    recipients: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    groups: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+    toEmails: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+    deleted: zod_1.z.boolean().nullable().optional(),
+    deletedBy: zod_1.z.number().nullable().optional(),
+    version: zod_1.z.number().nullable().optional(),
+    actions: zod_1.z.array(zod_1.z.unknown()).nullable().optional(),
+})
+    .transform((data) => ({
+    ...data,
+    url: (0, url_helpers_1.getFullCommsURL)({
+        workspaceId: data.workspaceId,
+        channelId: data.channelId,
+        threadId: data.threadId,
+        commentId: data.id,
+    }),
+}));
+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(),
+    theme: zod_1.z.number().int().nullable().optional(),
+    timeFormat: zod_1.z.string().nullable().optional(),
+    version: zod_1.z.number(),
+});
+// ConversationMessage entity from API. `id` is widened to `string | number`
+// (coerced to a string post-parse) because the backend currently emits
+// either shape depending on the endpoint; the URL/reaction helpers accept
+// both.
+exports.ConversationMessageSchema = zod_1.z
+    .object({
+    id: zod_1.z.union([zod_1.z.string(), zod_1.z.number()]).transform(String),
+    content: zod_1.z.string(),
+    creator: zod_1.z.number(),
+    conversationId: zod_1.z.string(),
+    posted: zod_1.z.date(),
+    systemMessage: exports.SystemMessageSchema,
+    attachments: zod_1.z.array(exports.AttachmentSchema).nullable().optional(),
+    reactions: zod_1.z.record(zod_1.z.string(), zod_1.z.array(zod_1.z.number())).nullable().optional(),
+    actions: zod_1.z.array(zod_1.z.unknown()).nullable().optional(),
+    objIndex: zod_1.z.number().nullable().optional(),
+    lastEdited: zod_1.z.date().nullable().optional(),
+    isDeleted: zod_1.z.boolean().nullable().optional(),
+    directGroupMentions: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+    directMentions: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    version: zod_1.z.number().nullable().optional(),
+    workspaceId: zod_1.z.number(),
+})
+    .transform((data) => ({
+    ...data,
+    url: (0, url_helpers_1.getFullCommsURL)({
+        workspaceId: data.workspaceId,
+        conversationId: data.conversationId,
+        messageId: data.id,
+    }),
+}));
+// InboxThread entity from API - returns full Thread objects with additional inbox metadata.
+exports.InboxThreadSchema = zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    title: zod_1.z.string(),
+    content: zod_1.z.string(),
+    creator: zod_1.z.number(),
+    creatorName: zod_1.z.string().nullable().optional(),
+    channelId: zod_1.z.string(),
+    workspaceId: zod_1.z.number(),
+    actions: zod_1.z.array(zod_1.z.unknown()).nullable().optional(),
+    attachments: zod_1.z.array(exports.AttachmentSchema).nullable().optional(),
+    commentCount: zod_1.z.number(),
+    directGroupMentions: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+    directMentions: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    groups: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+    lastEdited: zod_1.z.date().nullable().optional(),
+    lastObjIndex: zod_1.z.number().nullable().optional(),
+    lastUpdated: zod_1.z.date(),
+    mutedUntil: zod_1.z.date().nullable().optional(),
+    participants: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    // Backend wire shape only includes `pinned_ts` (epoch ms or null);
+    // derive `pinned` from `pinnedTs != null` if you need a bool.
+    pinned: zod_1.z.boolean().optional(),
+    pinnedTs: zod_1.z.number().int().nullable().optional(),
+    posted: zod_1.z.date(),
+    reactions: zod_1.z.record(zod_1.z.string(), zod_1.z.array(zod_1.z.number())).nullable().optional(),
+    recipients: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    snippet: zod_1.z.string(),
+    snippetCreator: zod_1.z.number(),
+    snippetMaskAvatarUrl: zod_1.z.string().nullable().optional(),
+    snippetMaskPoster: zod_1.z.string().nullable().optional(),
+    systemMessage: exports.SystemMessageSchema,
+    isArchived: zod_1.z.boolean(),
+    inInbox: zod_1.z.boolean(),
+    isSaved: zod_1.z.boolean().nullable().optional(),
+    closed: zod_1.z.boolean(),
+    responders: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    lastComment: exports.CommentSchema.nullable().optional(),
+    toEmails: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+    version: zod_1.z.number().nullable().optional(),
+})
+    .transform((data) => ({
+    ...data,
+    url: (0, url_helpers_1.getFullCommsURL)({
+        workspaceId: data.workspaceId,
+        channelId: data.channelId,
+        threadId: data.id,
+    }),
+}));
+// UnreadThread entity from API - simplified thread reference.
+exports.UnreadThreadSchema = zod_1.z.object({
+    threadId: zod_1.z.string(),
+    channelId: zod_1.z.string(),
+    objIndex: zod_1.z.number(),
+    directMention: zod_1.z.boolean(),
+});
+// UnreadConversation entity from API - simplified conversation reference.
+exports.UnreadConversationSchema = zod_1.z.object({
+    conversationId: zod_1.z.string(),
+    objIndex: zod_1.z.number(),
+    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(exports.SEARCH_RESULT_TYPES),
+    snippet: zod_1.z.string(),
+    snippetCreatorId: zod_1.z.number(),
+    snippetLastUpdated: zod_1.z.date(),
+    threadId: zod_1.z.string().nullable().optional(),
+    conversationId: zod_1.z.string().nullable().optional(),
+    commentId: zod_1.z.string().nullable().optional(),
+    channelId: zod_1.z.string().nullable().optional(),
+    channelName: zod_1.z.string().nullable().optional(),
+    channelColor: zod_1.z.number().nullable().optional(),
+    title: zod_1.z.string().nullable().optional(),
+    closed: zod_1.z.boolean().nullable().optional(),
+});

package/dist/cjs/types/enums.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NOTIFY_AUDIENCE_GROUP_IDS = exports.NOTIFY_AUDIENCES = exports.WORKSPACE_PLANS = exports.USER_TYPES = exports.GROUP_ID_MARKERS = exports.EVERYONE_IN_THREAD = exports.EVERYONE = void 0;
+/**
+ * Marker constants for the two "broadcast" group recipients. These appear
+ * in group-bearing fields (`Thread.groups`, `Comment.groups`,
+ * `Channel.defaultGroups`, `directGroupMentions`, etc.) in place of a
+ * real group ID and tell the backend to notify "everyone in the channel"
+ * or "everyone in the thread" respectively. Input and output are
+ * symmetric. Defined here (and not in `./entities`) so that `enums`
+ * stays leaf-level — `entities` imports from `enums`, never the reverse.
+ */
+exports.EVERYONE = 'EVERYONE';
+exports.EVERYONE_IN_THREAD = 'EVERYONE_IN_THREAD';
+/** Union of the two broadcast group markers. */
+exports.GROUP_ID_MARKERS = [exports.EVERYONE, exports.EVERYONE_IN_THREAD];
+// User types for workspace users
+exports.USER_TYPES = ['USER', 'GUEST', 'ADMIN'];
+// Workspace plans. The known values today are `'free'`, `'unlimited'`,
+// and `'business'`, but the backend can introduce new plan names without
+// coordinating a SDK release — so the schema accepts any string and the
+// const array stays as a hint for autocomplete only.
+exports.WORKSPACE_PLANS = ['free', 'unlimited', 'business'];
+// 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 broadcast marker IDs
+ * (`EVERYONE` / `EVERYONE_IN_THREAD`) that comment- and thread-creation
+ * endpoints use on the wire. SDK consumers should use {@link NotifyAudience}
+ * via `notifyAudience` on the request args rather than passing these IDs
+ * directly.
+ */
+exports.NOTIFY_AUDIENCE_GROUP_IDS = {
+    channel: exports.EVERYONE,
+    thread: exports.EVERYONE_IN_THREAD,
+};

package/dist/cjs/types/errors.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommsRequestError = void 0;
+const ts_custom_error_1 = require("ts-custom-error");
+class CommsRequestError extends ts_custom_error_1.CustomError {
+    constructor(message, httpStatusCode, responseData) {
+        super(message);
+        this.httpStatusCode = httpStatusCode;
+        this.responseData = responseData;
+    }
+}
+exports.CommsRequestError = CommsRequestError;

package/dist/cjs/types/http.js

@@ -0,0 +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

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./entities"), exports);
+__exportStar(require("./enums"), exports);
+__exportStar(require("./errors"), exports);
+__exportStar(require("./http"), exports);
+__exportStar(require("./requests"), exports);

package/dist/cjs/types/requests.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.THREAD_ACTIONS = exports.ARCHIVE_FILTER_VALUES = 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;
+const zod_1 = require("zod");
+const entities_1 = require("./entities");
+const enums_1 = require("./enums");
+/**
+ * Create-side requests require an `id` on the wire. The SDK clients accept
+ * `id` as optional and auto-generate one via
+ * {@link import('../utils/uuidv7').generateId} when the caller doesn't pass
+ * one — callers can still mint their own ID locally (e.g. for optimistic
+ * UI) and have it stick.
+ */
+exports.CreateChannelArgsSchema = zod_1.z.object({
+    workspaceId: zod_1.z.number(),
+    name: zod_1.z.string(),
+    id: zod_1.z.string().optional(),
+    userIds: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    color: zod_1.z.number().nullable().optional(),
+    public: zod_1.z.boolean().nullable().optional(),
+    description: zod_1.z.string().nullable().optional(),
+    defaultGroups: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+    defaultRecipients: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    isFavorited: zod_1.z.boolean().nullable().optional(),
+    icon: zod_1.z.number().nullable().optional(),
+});
+exports.UpdateChannelArgsSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    name: zod_1.z.string(),
+    color: zod_1.z.number().nullable().optional(),
+    public: zod_1.z.boolean().nullable().optional(),
+    description: zod_1.z.string().nullable().optional(),
+    defaultGroups: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+    defaultRecipients: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    isFavorited: zod_1.z.boolean().nullable().optional(),
+    icon: zod_1.z.number().nullable().optional(),
+});
+exports.CreateThreadArgsSchema = zod_1.z.object({
+    channelId: zod_1.z.string(),
+    content: zod_1.z.string(),
+    title: zod_1.z.string().nullable().optional(),
+    id: zod_1.z.string().optional(),
+    recipients: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    groups: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+});
+exports.UpdateThreadArgsSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    title: zod_1.z.string().nullable().optional(),
+    content: zod_1.z.string().nullable().optional(),
+});
+exports.CreateCommentArgsSchema = zod_1.z.object({
+    threadId: zod_1.z.string(),
+    content: zod_1.z.string(),
+    id: zod_1.z.string().optional(),
+    attachments: zod_1.z.array(entities_1.AttachmentSchema).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.string()).nullable().optional(),
+    directMentions: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+    directGroupMentions: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+    notifyAudience: zod_1.z.enum(enums_1.NOTIFY_AUDIENCES).nullable().optional(),
+});
+exports.UpdateCommentArgsSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    content: zod_1.z.string(),
+});
+exports.CreateConversationArgsSchema = zod_1.z.object({
+    workspaceId: zod_1.z.number(),
+    recipients: zod_1.z.array(zod_1.z.number()),
+    id: zod_1.z.string().optional(),
+    title: zod_1.z.string().nullable().optional(),
+});
+exports.CreateMessageArgsSchema = zod_1.z
+    .object({
+    conversationId: zod_1.z.string().nullable().optional(),
+    threadId: zod_1.z.string().nullable().optional(),
+    content: zod_1.z.string(),
+    id: zod_1.z.string().optional(),
+    attachments: zod_1.z.array(entities_1.AttachmentSchema).nullable().optional(),
+})
+    .refine((data) => {
+    return ((data.conversationId && !data.threadId) || (!data.conversationId && data.threadId));
+}, {
+    message: 'Exactly one of conversationId or threadId must be provided',
+});
+exports.GetChannelsArgsSchema = zod_1.z.object({
+    workspaceId: zod_1.z.number(),
+    archived: zod_1.z.boolean().nullable().optional(),
+});
+exports.GetThreadsArgsSchema = zod_1.z.object({
+    workspaceId: zod_1.z.number(),
+    channelId: zod_1.z.string().nullable().optional(),
+    archived: zod_1.z.boolean().nullable().optional(),
+    newerThan: zod_1.z.date().nullable().optional(),
+    olderThan: zod_1.z.date().nullable().optional(),
+    limit: zod_1.z.number().nullable().optional(),
+});
+exports.GetCommentsArgsSchema = zod_1.z.object({
+    threadId: zod_1.z.string(),
+    newerThan: zod_1.z.date().nullable().optional(),
+    olderThan: zod_1.z.date().nullable().optional(),
+    limit: zod_1.z.number().nullable().optional(),
+});
+exports.GetConversationsArgsSchema = zod_1.z.object({
+    workspaceId: zod_1.z.number(),
+    archived: zod_1.z.boolean().nullable().optional(),
+});
+exports.GetOrCreateConversationArgsSchema = zod_1.z.object({
+    workspaceId: zod_1.z.number(),
+    userIds: zod_1.z.array(zod_1.z.number()),
+    id: zod_1.z.string().optional(),
+});
+// Inbox
+exports.ARCHIVE_FILTER_VALUES = ['active', 'archived', 'all'];
+// Threads
+exports.THREAD_ACTIONS = ['close', 'reopen'];

package/dist/cjs/utils/case-conversion.js

@@ -0,0 +1,54 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.camelCaseKeys = camelCaseKeys;
+exports.snakeCaseKeys = snakeCaseKeys;
+const camelcase_1 = __importDefault(require("camelcase"));
+function isObject(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+function isArray(value) {
+    return Array.isArray(value);
+}
+function toSnakeCase(str) {
+    return str
+        .replace(/([A-Z])/g, '_$1')
+        .toLowerCase()
+        .replace(/^_/, '');
+}
+/**
+ * @internal
+ */
+function camelCaseKeys(obj) {
+    if (isArray(obj)) {
+        return obj.map(camelCaseKeys);
+    }
+    if (isObject(obj)) {
+        const result = {};
+        for (const [key, value] of Object.entries(obj)) {
+            const camelKey = (0, camelcase_1.default)(key);
+            result[camelKey] = camelCaseKeys(value);
+        }
+        return result;
+    }
+    return obj;
+}
+/**
+ * @internal
+ */
+function snakeCaseKeys(obj) {
+    if (isArray(obj)) {
+        return obj.map(snakeCaseKeys);
+    }
+    if (isObject(obj)) {
+        const result = {};
+        for (const [key, value] of Object.entries(obj)) {
+            const snakeKey = toSnakeCase(key);
+            result[snakeKey] = snakeCaseKeys(value);
+        }
+        return result;
+    }
+    return obj;
+}

package/dist/cjs/utils/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./case-conversion"), exports);
+__exportStar(require("./url-helpers"), exports);
+__exportStar(require("./uuidv7"), exports);