@doist/comms-sdk 0.1.0-alpha.1

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

@@ -0,0 +1,344 @@
+import { z } from 'zod';
+import { type Comment, type StatusOk, type Thread, type UnreadThread } from '../types/entities.js';
+import type { CloseThreadArgs, CreateThreadArgs, GetThreadsArgs, MarkThreadReadArgs, MarkThreadUnreadArgs, MarkThreadUnreadForOthersArgs, MoveThreadToChannelArgs, MuteThreadArgs, ReopenThreadArgs, UpdateThreadArgs } from '../types/requests.js';
+import { BaseClient } from './base-client.js';
+export declare const ThreadListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodString;
+    content: z.ZodString;
+    creator: z.ZodNumber;
+    creatorName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    channelId: z.ZodString;
+    workspaceId: z.ZodNumber;
+    actions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnknown>>>;
+    attachments: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+        attachmentId: z.ZodString;
+        urlType: z.ZodString;
+        title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileSize: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        underlyingType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        image: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        imageWidth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        imageHeight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        duration: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        uploadState: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        video: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        videoType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        videoAutoPlay: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    }, z.core.$loose>>>>;
+    commentCount: z.ZodNumber;
+    closed: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    directGroupMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    directMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    groups: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    lastEdited: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+    lastObjIndex: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    lastUpdated: z.ZodDate;
+    mutedUntil: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+    participants: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    pinned: z.ZodOptional<z.ZodBoolean>;
+    pinnedTs: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    posted: z.ZodDate;
+    reactions: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    recipients: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    responders: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    snippet: z.ZodString;
+    snippetCreator: z.ZodNumber;
+    snippetMaskAvatarUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    snippetMaskPoster: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    systemMessage: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodUnknown]>>>;
+    toEmails: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    isArchived: z.ZodBoolean;
+    isSaved: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    inInbox: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    lastComment: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        content: z.ZodString;
+        creator: z.ZodNumber;
+        creatorName: z.ZodString;
+        threadId: z.ZodString;
+        channelId: z.ZodString;
+        posted: z.ZodDate;
+        systemMessage: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodUnknown]>>>;
+        attachments: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+            attachmentId: z.ZodString;
+            urlType: z.ZodString;
+            title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            fileName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            fileSize: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            underlyingType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            image: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            imageWidth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            imageHeight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            duration: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            uploadState: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            video: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            videoType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            videoAutoPlay: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+        }, z.core.$loose>>>>;
+        reactions: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodNumber>>>>;
+        actions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnknown>>>;
+        objIndex: z.ZodNumber;
+        lastEdited: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+        deleted: z.ZodBoolean;
+        deletedBy: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        directGroupMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        directMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+        groups: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        recipients: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+        toEmails: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        version: z.ZodNumber;
+        workspaceId: z.ZodNumber;
+    }, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodTransform<{
+    url: string;
+    id: string;
+    title: string;
+    content: string;
+    creator: number;
+    channelId: string;
+    workspaceId: number;
+    commentCount: number;
+    lastUpdated: Date;
+    posted: Date;
+    snippet: string;
+    snippetCreator: number;
+    isArchived: boolean;
+    creatorName?: string | null | undefined;
+    actions?: unknown[] | null | undefined;
+    attachments?: {
+        [x: string]: unknown;
+        attachmentId: string;
+        urlType: string;
+        title?: string | null | undefined;
+        url?: string | null | undefined;
+        fileName?: string | null | undefined;
+        fileSize?: number | null | undefined;
+        underlyingType?: string | null | undefined;
+        description?: string | null | undefined;
+        image?: string | null | undefined;
+        imageWidth?: number | null | undefined;
+        imageHeight?: number | null | undefined;
+        duration?: string | null | undefined;
+        uploadState?: string | null | undefined;
+        video?: string | null | undefined;
+        videoType?: string | null | undefined;
+        videoAutoPlay?: boolean | null | undefined;
+    }[] | null | undefined;
+    closed?: boolean | null | undefined;
+    directGroupMentions?: string[] | null | undefined;
+    directMentions?: number[] | null | undefined;
+    groups?: string[] | null | undefined;
+    lastEdited?: Date | null | undefined;
+    lastObjIndex?: number | null | undefined;
+    mutedUntil?: Date | null | undefined;
+    participants?: number[] | null | undefined;
+    pinned?: boolean | undefined;
+    pinnedTs?: number | null | undefined;
+    reactions?: Record<string, unknown> | null | undefined;
+    recipients?: number[] | null | undefined;
+    responders?: number[] | null | undefined;
+    snippetMaskAvatarUrl?: string | null | undefined;
+    snippetMaskPoster?: string | null | undefined;
+    systemMessage?: unknown;
+    toEmails?: string[] | null | undefined;
+    isSaved?: boolean | null | undefined;
+    inInbox?: boolean | null | undefined;
+    lastComment?: {
+        id: string;
+        content: string;
+        creator: number;
+        creatorName: string;
+        threadId: string;
+        channelId: string;
+        posted: Date;
+        objIndex: number;
+        deleted: boolean;
+        version: number;
+        workspaceId: number;
+        systemMessage?: unknown;
+        attachments?: {
+            [x: string]: unknown;
+            attachmentId: string;
+            urlType: string;
+            title?: string | null | undefined;
+            url?: string | null | undefined;
+            fileName?: string | null | undefined;
+            fileSize?: number | null | undefined;
+            underlyingType?: string | null | undefined;
+            description?: string | null | undefined;
+            image?: string | null | undefined;
+            imageWidth?: number | null | undefined;
+            imageHeight?: number | null | undefined;
+            duration?: string | null | undefined;
+            uploadState?: string | null | undefined;
+            video?: string | null | undefined;
+            videoType?: string | null | undefined;
+            videoAutoPlay?: boolean | null | undefined;
+        }[] | null | undefined;
+        reactions?: Record<string, number[]> | null | undefined;
+        actions?: unknown[] | null | undefined;
+        lastEdited?: Date | null | undefined;
+        deletedBy?: number | null | undefined;
+        directGroupMentions?: string[] | null | undefined;
+        directMentions?: number[] | null | undefined;
+        groups?: string[] | null | undefined;
+        recipients?: number[] | null | undefined;
+        toEmails?: string[] | null | undefined;
+    } | null | undefined;
+}, {
+    id: string;
+    title: string;
+    content: string;
+    creator: number;
+    channelId: string;
+    workspaceId: number;
+    commentCount: number;
+    lastUpdated: Date;
+    posted: Date;
+    snippet: string;
+    snippetCreator: number;
+    isArchived: boolean;
+    creatorName?: string | null | undefined;
+    actions?: unknown[] | null | undefined;
+    attachments?: {
+        [x: string]: unknown;
+        attachmentId: string;
+        urlType: string;
+        title?: string | null | undefined;
+        url?: string | null | undefined;
+        fileName?: string | null | undefined;
+        fileSize?: number | null | undefined;
+        underlyingType?: string | null | undefined;
+        description?: string | null | undefined;
+        image?: string | null | undefined;
+        imageWidth?: number | null | undefined;
+        imageHeight?: number | null | undefined;
+        duration?: string | null | undefined;
+        uploadState?: string | null | undefined;
+        video?: string | null | undefined;
+        videoType?: string | null | undefined;
+        videoAutoPlay?: boolean | null | undefined;
+    }[] | null | undefined;
+    closed?: boolean | null | undefined;
+    directGroupMentions?: string[] | null | undefined;
+    directMentions?: number[] | null | undefined;
+    groups?: string[] | null | undefined;
+    lastEdited?: Date | null | undefined;
+    lastObjIndex?: number | null | undefined;
+    mutedUntil?: Date | null | undefined;
+    participants?: number[] | null | undefined;
+    pinned?: boolean | undefined;
+    pinnedTs?: number | null | undefined;
+    reactions?: Record<string, unknown> | null | undefined;
+    recipients?: number[] | null | undefined;
+    responders?: number[] | null | undefined;
+    snippetMaskAvatarUrl?: string | null | undefined;
+    snippetMaskPoster?: string | null | undefined;
+    systemMessage?: unknown;
+    toEmails?: string[] | null | undefined;
+    isSaved?: boolean | null | undefined;
+    inInbox?: boolean | null | undefined;
+    lastComment?: {
+        id: string;
+        content: string;
+        creator: number;
+        creatorName: string;
+        threadId: string;
+        channelId: string;
+        posted: Date;
+        objIndex: number;
+        deleted: boolean;
+        version: number;
+        workspaceId: number;
+        systemMessage?: unknown;
+        attachments?: {
+            [x: string]: unknown;
+            attachmentId: string;
+            urlType: string;
+            title?: string | null | undefined;
+            url?: string | null | undefined;
+            fileName?: string | null | undefined;
+            fileSize?: number | null | undefined;
+            underlyingType?: string | null | undefined;
+            description?: string | null | undefined;
+            image?: string | null | undefined;
+            imageWidth?: number | null | undefined;
+            imageHeight?: number | null | undefined;
+            duration?: string | null | undefined;
+            uploadState?: string | null | undefined;
+            video?: string | null | undefined;
+            videoType?: string | null | undefined;
+            videoAutoPlay?: boolean | null | undefined;
+        }[] | null | undefined;
+        reactions?: Record<string, number[]> | null | undefined;
+        actions?: unknown[] | null | undefined;
+        lastEdited?: Date | null | undefined;
+        deletedBy?: number | null | undefined;
+        directGroupMentions?: string[] | null | undefined;
+        directMentions?: number[] | null | undefined;
+        groups?: string[] | null | undefined;
+        recipients?: number[] | null | undefined;
+        toEmails?: string[] | null | undefined;
+    } | null | undefined;
+}>>>;
+/**
+ * Client for `/api/v1/threads/`. The SDK auto-generates the thread `id` on
+ * `createThread` when the caller doesn't supply one.
+ */
+export declare class ThreadsClient extends BaseClient {
+    /**
+     * Lists threads. At least one of `channelId` / `workspaceId` is required.
+     * `newerThan` / `olderThan` (`Date`) are converted to the
+     * `newer_than_ts` / `older_than_ts` epoch-second params on the wire.
+     */
+    getThreads(args: GetThreadsArgs): Promise<Thread[]>;
+    /** Fetches a single thread by ID. */
+    getThread(id: string): Promise<Thread>;
+    /** Creates a new thread. `id` is auto-generated if not supplied. */
+    createThread(args: CreateThreadArgs): Promise<Thread>;
+    /** Partial update of an existing thread. */
+    updateThread(args: UpdateThreadArgs): Promise<Thread>;
+    /** Permanently deletes a thread. */
+    deleteThread(id: string): Promise<StatusOk>;
+    /** Saves a thread (formerly "star"). */
+    saveThread(id: string): Promise<StatusOk>;
+    /** Unsaves a thread (formerly "unstar"). */
+    unsaveThread(id: string): Promise<StatusOk>;
+    pinThread(id: string): Promise<StatusOk>;
+    unpinThread(id: string): Promise<StatusOk>;
+    /** Moves a thread to another channel. */
+    moveToChannel(args: MoveThreadToChannelArgs): Promise<Thread>;
+    markRead(args: MarkThreadReadArgs): Promise<StatusOk>;
+    markUnread(args: MarkThreadUnreadArgs): Promise<StatusOk>;
+    markUnreadForOthers(args: MarkThreadUnreadForOthersArgs): Promise<StatusOk>;
+    /**
+     * Marks every thread in a workspace or channel as read. Exactly one of
+     * `workspaceId` / `channelId` should be set.
+     */
+    markAllRead(args: {
+        workspaceId?: number;
+        channelId?: string;
+    }): Promise<StatusOk>;
+    clearUnread(workspaceId: number): Promise<StatusOk>;
+    /**
+     * Returns unread threads for a workspace, paired with the unread version
+     * counter and (optionally) the inbox unread count.
+     */
+    getUnread(workspaceId: number): Promise<{
+        data: UnreadThread[];
+        version: number;
+        inboxUnread?: number | null;
+    }>;
+    muteThread(args: MuteThreadArgs): Promise<Thread>;
+    unmuteThread(id: string): Promise<Thread>;
+    closeThread(args: CloseThreadArgs): Promise<Comment>;
+    reopenThread(args: ReopenThreadArgs): Promise<Comment>;
+    private addCommentWithAction;
+    private simple;
+}

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

@@ -0,0 +1,123 @@
+import { type User } from '../types/entities.js';
+import type { UpdateUserArgs } from '../types/requests.js';
+import { BaseClient } from './base-client.js';
+type EmailExistsResponse = {
+    exists: boolean;
+    verified: boolean;
+};
+type MfaChallengeResponse = {
+    mfaToken: string;
+};
+type LoginWithGoogleArgs = {
+    idToken: string;
+    nonce: string;
+    timezone?: string;
+    lang?: string;
+    mfaToken?: string;
+};
+type RegisterArgs = {
+    name: string;
+    email: string;
+    password: string;
+    lang?: string;
+    acceptTerms?: boolean;
+};
+type LoginArgs = {
+    email: string;
+    password: string;
+    setSessionCookie?: boolean;
+};
+type MfaChallengeArgs = {
+    challengeId: string;
+    factor: string;
+    methodType: string;
+};
+/**
+ * Client for the `/api/v1/users/` endpoints. Authentication flows through
+ * Todoist-ID; `register` / `login` / `loginWithGoogle` / `loginWithToken` /
+ * `loginWithTodoist` are the available entry points.
+ */
+export declare class UsersClient extends BaseClient {
+    /** Registers a new user via the Todoist-ID bridge. */
+    register(args: RegisterArgs): Promise<User>;
+    /** Logs in an existing user. */
+    login(args: LoginArgs): Promise<User>;
+    /**
+     * Logs in using a valid token (sent via Authorization header). The SDK
+     * client is already configured with the token, so no args are needed.
+     */
+    loginWithToken(): Promise<User>;
+    /**
+     * Exchanges the browser's Todoist web-session cookie for a Comms session.
+     * Only useful when running in a browser context on the shared Todoist
+     * registrable domain — the cookie is sent automatically by the browser.
+     */
+    loginWithTodoist(): Promise<User>;
+    /** Logs in (and auto-signs-up) via a Google ID token. */
+    loginWithGoogle(args: LoginWithGoogleArgs): Promise<User>;
+    /**
+     * Completes an MFA challenge issued by `loginWithGoogle` (returns an MFA
+     * token to pass back to `loginWithGoogle.mfaToken`).
+     */
+    mfaChallenge(args: MfaChallengeArgs): Promise<MfaChallengeResponse>;
+    /** Logs out the current user and clears the session cookie. */
+    logout(): Promise<void>;
+    /** Returns the user associated with the current access token. */
+    getSessionUser(): Promise<User>;
+    /**
+     * Fetches a single user. Defaults to the session user when no `id` is
+     * passed. Cross-workspace lookups require that the caller and the target
+     * share a workspace.
+     */
+    getUser(args?: {
+        id?: number;
+        workspaceId?: number;
+        asList?: boolean;
+    }): Promise<User>;
+    /** Looks up a user by their email address. */
+    getUserByEmail(email: string): Promise<User>;
+    /**
+     * Updates the logged-in user's profile. Most fields are proxied to
+     * Todoist (full name, password, language, timezone, etc.).
+     */
+    update(args: UpdateUserArgs): Promise<User>;
+    /** Updates the user's password. Requires `currentPassword`. */
+    updatePassword(args: {
+        newPassword: string;
+        currentPassword?: string;
+    }): Promise<User>;
+    /** Removes the user's avatar. */
+    removeAvatar(): Promise<User>;
+    /**
+     * Invalidates the current API token and returns the user with a fresh
+     * token.
+     */
+    invalidateToken(): Promise<User>;
+    /**
+     * Validates that an arbitrary token is still active. Note this is sent
+     * as a GET — the token is read from the query string, not the
+     * Authorization header.
+     */
+    validateToken(token: string): Promise<void>;
+    /** Marks the user as active on a workspace (presence beacon). */
+    heartbeat(args: {
+        workspaceId: number;
+        platform: string;
+    }): Promise<void>;
+    /** Resets the user's presence for a workspace. */
+    resetPresence(workspaceId: number): Promise<void>;
+    /** Checks whether an email address is registered (and verified). */
+    checkEmail(email: string): Promise<EmailExistsResponse>;
+    /**
+     * Returns the current per-channel mail unsubscribe settings for the
+     * caller's primary email.
+     */
+    getUnsubscribeSettings(): Promise<Record<string, boolean>>;
+    /** Toggles per-email-type opt-out settings. */
+    updateUnsubscribeSettings(settings: Record<string, boolean>): Promise<{
+        status: string;
+    }>;
+    private get;
+    private post;
+}
+export {};

package/dist/types/clients/workspace-users-client.d.ts

@@ -0,0 +1,47 @@
+import { type WorkspaceUser } from '../types/entities.js';
+import { UserType } from '../types/enums.js';
+import type { GetUserByEmailArgs, GetUserByIdArgs, GetUserInfoArgs, GetUserLocalTimeArgs, GetWorkspaceUsersArgs } from '../types/requests.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Client for `/api/v1/workspace_users/`. The backend's `add` endpoint
+ * rejects non-empty `name` and `channelIds` — set neither.
+ */
+export declare class WorkspaceUsersClient extends BaseClient {
+    /** Returns workspace user objects for the given workspace id. */
+    getWorkspaceUsers(args: GetWorkspaceUsersArgs): Promise<WorkspaceUser[]>;
+    /** Returns workspace user IDs for the given workspace id. */
+    getWorkspaceUserIds(workspaceId: number): Promise<number[]>;
+    /** Gets a user by id. */
+    getUserById(args: GetUserByIdArgs): Promise<WorkspaceUser>;
+    /** Gets a user by email. */
+    getUserByEmail(args: GetUserByEmailArgs): Promise<WorkspaceUser>;
+    /** Gets the user's info in the context of the workspace. */
+    getUserInfo(args: GetUserInfoArgs): Promise<Record<string, unknown>>;
+    /** Gets the user's local time (e.g., "2017-05-10 07:55:40"). */
+    getUserLocalTime(args: GetUserLocalTimeArgs): Promise<string>;
+    /** Adds a person to a workspace. */
+    addUser(args: {
+        workspaceId: number;
+        email: string;
+        userType?: UserType;
+    }): Promise<WorkspaceUser>;
+    /** Updates a person in a workspace. */
+    updateUser(args: {
+        workspaceId: number;
+        userType: UserType;
+        email?: string;
+        userId?: number;
+    }): Promise<WorkspaceUser>;
+    /** Removes a person from a workspace. */
+    removeUser(args: {
+        workspaceId: number;
+        email?: string;
+        userId?: number;
+    }): Promise<void>;
+    /** Sends a new workspace invitation to the selected user. */
+    resendInvite(args: {
+        workspaceId: number;
+        email: string;
+        userId?: number;
+    }): Promise<void>;
+}

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

@@ -0,0 +1,79 @@
+import { z } from 'zod';
+import { Channel, Workspace } from '../types/entities.js';
+import { BaseClient } from './base-client.js';
+export declare const ChannelListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    creator: z.ZodNumber;
+    userIds: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    color: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    public: z.ZodBoolean;
+    workspaceId: z.ZodNumber;
+    archived: z.ZodBoolean;
+    created: z.ZodDate;
+    useDefaultRecipients: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    defaultGroups: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    defaultRecipients: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    isFavorited: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    icon: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    version: z.ZodNumber;
+    filters: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
+}, z.core.$strip>, z.ZodTransform<{
+    url: string;
+    id: string;
+    name: string;
+    creator: number;
+    public: boolean;
+    workspaceId: number;
+    archived: boolean;
+    created: Date;
+    version: number;
+    description?: string | null | undefined;
+    userIds?: number[] | null | undefined;
+    color?: number | null | undefined;
+    useDefaultRecipients?: boolean | null | undefined;
+    defaultGroups?: string[] | null | undefined;
+    defaultRecipients?: number[] | null | undefined;
+    isFavorited?: boolean | null | undefined;
+    icon?: number | null | undefined;
+    filters?: Record<string, string> | null | undefined;
+}, {
+    id: string;
+    name: string;
+    creator: number;
+    public: boolean;
+    workspaceId: number;
+    archived: boolean;
+    created: Date;
+    version: number;
+    description?: string | null | undefined;
+    userIds?: number[] | null | undefined;
+    color?: number | null | undefined;
+    useDefaultRecipients?: boolean | null | undefined;
+    defaultGroups?: string[] | null | undefined;
+    defaultRecipients?: number[] | null | undefined;
+    isFavorited?: boolean | null | undefined;
+    icon?: number | null | undefined;
+    filters?: Record<string, string> | null | undefined;
+}>>>;
+/**
+ * Client for `/api/v1/workspaces/`. Workspace IDs are integers. The backend
+ * currently rejects any `color` other than `1` on add/update.
+ */
+export declare class WorkspacesClient extends BaseClient {
+    /** Gets all the user's workspaces. */
+    getWorkspaces(): Promise<Workspace[]>;
+    /** Gets a single workspace object by id. */
+    getWorkspace(id: number): Promise<Workspace>;
+    /** Gets the user's default workspace. */
+    getDefaultWorkspace(): Promise<Workspace>;
+    /** Creates a new workspace. */
+    createWorkspace(name: string): Promise<Workspace>;
+    /** Updates an existing workspace. */
+    updateWorkspace(id: number, name: string): Promise<Workspace>;
+    /** Removes a workspace and all its data (not recoverable). */
+    removeWorkspace(id: number): Promise<void>;
+    /** Gets the public channels of a workspace. */
+    getPublicChannels(id: number): Promise<Channel[]>;
+}

package/dist/types/comms-api.d.ts

@@ -0,0 +1,59 @@
+import { ChannelsClient } from './clients/channels-client.js';
+import { CommentsClient } from './clients/comments-client.js';
+import { ConversationMessagesClient } from './clients/conversation-messages-client.js';
+import { ConversationsClient } from './clients/conversations-client.js';
+import { GroupsClient } from './clients/groups-client.js';
+import { InboxClient } from './clients/inbox-client.js';
+import { ReactionsClient } from './clients/reactions-client.js';
+import { SearchClient } from './clients/search-client.js';
+import { ThreadsClient } from './clients/threads-client.js';
+import { UsersClient } from './clients/users-client.js';
+import { WorkspaceUsersClient } from './clients/workspace-users-client.js';
+import { WorkspacesClient } from './clients/workspaces-client.js';
+import type { CustomFetch } from './types/http.js';
+export type CommsApiOptions = {
+    /** Optional custom API base URL. If not provided, defaults to Comms' standard API endpoint. */
+    baseUrl?: string;
+    /** Optional custom fetch implementation for cross-platform compatibility (e.g., Obsidian, React Native, Electron). */
+    customFetch?: CustomFetch;
+};
+/**
+ * The main API client for interacting with the Comms REST API.
+ *
+ * @example
+ * ```typescript
+ * import { CommsApi } from '@doist/comms-sdk'
+ *
+ * const api = new CommsApi('your-api-token')
+ * const user = await api.users.getSessionUser()
+ * ```
+ */
+export declare class CommsApi {
+    users: UsersClient;
+    workspaces: WorkspacesClient;
+    workspaceUsers: WorkspaceUsersClient;
+    channels: ChannelsClient;
+    threads: ThreadsClient;
+    groups: GroupsClient;
+    conversations: ConversationsClient;
+    comments: CommentsClient;
+    conversationMessages: ConversationMessagesClient;
+    inbox: InboxClient;
+    reactions: ReactionsClient;
+    search: SearchClient;
+    /**
+     * Creates a new Comms API client.
+     *
+     * @param authToken - Your Comms API token.
+     * @param options - Optional configuration options.
+     */
+    constructor(authToken: string, options?: CommsApiOptions);
+    /**
+     * Drains the SDK's process-global connection pool. CLIs and scripts
+     * should `await api.close()` before exit so Node's event loop empties
+     * immediately instead of waiting ~4s on keep-alive. Affects every
+     * `CommsApi` and OAuth helper in the same process — it's a
+     * process-shutdown gesture, not an instance teardown. Browser-safe.
+     */
+    close(): Promise<void>;
+}

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

@@ -0,0 +1,19 @@
+/**
+ * Gets the base URI for Comms API requests.
+ *
+ * @param domainBase - Custom domain base URL. Defaults to Comms' API domain.
+ * @returns Complete base URI with trailing slash (e.g., 'https://comms.todoist.com/api/v1/')
+ */
+export declare function getCommsBaseUri(domainBase?: string): string;
+export declare const ENDPOINT_USERS = "users";
+export declare const ENDPOINT_WORKSPACES = "workspaces";
+export declare const ENDPOINT_CHANNELS = "channels";
+export declare const ENDPOINT_THREADS = "threads";
+export declare const ENDPOINT_GROUPS = "groups";
+export declare const ENDPOINT_CONVERSATIONS = "conversations";
+export declare const ENDPOINT_COMMENTS = "comments";
+export declare const ENDPOINT_NOTIFICATIONS = "notifications";
+export declare const ENDPOINT_INBOX = "inbox";
+export declare const ENDPOINT_REACTIONS = "reactions";
+export declare const ENDPOINT_SEARCH = "search";
+export declare const ENDPOINT_CONVERSATION_MESSAGES = "conversation_messages";