@doist/comms-sdk 0.0.1 → 0.2.0

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

@@ -0,0 +1,55 @@
+/**
+ * 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.
+ */
+export declare const EVERYONE: "EVERYONE";
+export declare const EVERYONE_IN_THREAD: "EVERYONE_IN_THREAD";
+/** Union of the two broadcast group markers. */
+export declare const GROUP_ID_MARKERS: readonly ["EVERYONE", "EVERYONE_IN_THREAD"];
+export type GroupIdMarker = (typeof GROUP_ID_MARKERS)[number];
+/**
+ * A group identifier on the wire — either an opaque group ID or one of
+ * the {@link GROUP_ID_MARKERS} for a broadcast audience.
+ */
+export type GroupId = string;
+export declare const USER_TYPES: readonly ["USER", "GUEST", "ADMIN"];
+/**
+ * The type of user in a workspace.
+ *
+ * @remarks
+ * Possible values:
+ * - `'USER'` - Regular user
+ * - `'GUEST'` - Guest user
+ * - `'ADMIN'` - Administrator
+ */
+export type UserType = (typeof USER_TYPES)[number];
+export declare const WORKSPACE_PLANS: readonly ["free", "unlimited", "business"];
+/**
+ * The plan type for a workspace. Any string accepted; the listed values
+ * are the ones the backend exposes today.
+ */
+export type WorkspacePlan = (typeof WORKSPACE_PLANS)[number] | (string & {});
+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 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.
+ */
+export declare const NOTIFY_AUDIENCE_GROUP_IDS: Readonly<Record<NotifyAudience, GroupId>>;

package/dist/types/types/errors.d.ts

@@ -0,0 +1,6 @@
+import { CustomError } from 'ts-custom-error';
+export declare class CommsRequestError extends CustomError {
+    httpStatusCode?: number;
+    responseData?: unknown;
+    constructor(message: string, httpStatusCode?: number, responseData?: unknown);
+}

package/dist/types/types/http.d.ts

@@ -0,0 +1,54 @@
+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;
+    headers: Record<string, string>;
+};
+export type RequestConfig = {
+    baseURL?: string;
+    headers?: Record<string, string>;
+    timeout?: number;
+};
+/**
+ * Custom fetch response interface for cross-platform HTTP clients.
+ * This minimal interface allows custom HTTP implementations (e.g., Obsidian's requestUrl,
+ * Electron's net module, React Native's networking) to work with the SDK.
+ */
+export type CustomFetchResponse = {
+    ok: boolean;
+    status: number;
+    statusText: string;
+    headers: Record<string, string>;
+    text(): Promise<string>;
+    json(): Promise<unknown>;
+};
+/**
+ * Custom fetch function type for providing alternative HTTP implementations.
+ * This enables the SDK to work in restrictive environments like Obsidian plugins,
+ * browser extensions, Electron apps, React Native, and enterprise environments
+ * with specific networking requirements.
+ *
+ * @param url - The URL to fetch
+ * @param options - Standard RequestInit options plus optional timeout
+ * @returns A promise that resolves to a CustomFetchResponse
+ *
+ * @example
+ * ```typescript
+ * // Obsidian plugin example
+ * const obsidianFetch: CustomFetch = async (url, options) => {
+ *   const response = await requestUrl({ url, method: options?.method, body: options?.body })
+ *   return {
+ *     ok: response.status >= 200 && response.status < 300,
+ *     status: response.status,
+ *     statusText: '',
+ *     headers: response.headers,
+ *     text: async () => response.text,
+ *     json: async () => response.json,
+ *   }
+ * }
+ * ```
+ */
+export type CustomFetch = (url: string, options?: RequestInit & {
+    timeout?: number;
+}) => Promise<CustomFetchResponse>;

package/dist/types/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from './api-version.js';
+export * from './entities.js';
+export * from './enums.js';
+export * from './errors.js';
+export * from './http.js';
+export * from './requests.js';

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

@@ -0,0 +1,366 @@
+import { z } from 'zod';
+import { type Attachment } from './entities.js';
+/**
+ * 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.js').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.
+ */
+export declare const CreateChannelArgsSchema: z.ZodObject<{
+    workspaceId: z.ZodNumber;
+    name: z.ZodString;
+    id: z.ZodOptional<z.ZodString>;
+    userIds: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    color: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    public: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    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>>;
+}, z.core.$strip>;
+export type CreateChannelArgs = z.infer<typeof CreateChannelArgsSchema>;
+export declare const UpdateChannelArgsSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    color: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    public: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    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>>;
+}, z.core.$strip>;
+export type UpdateChannelArgs = z.infer<typeof UpdateChannelArgsSchema>;
+export declare const CreateThreadArgsSchema: z.ZodObject<{
+    channelId: z.ZodString;
+    content: z.ZodString;
+    title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    id: z.ZodOptional<z.ZodString>;
+    recipients: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    groups: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+}, z.core.$strip>;
+export type CreateThreadArgs = z.infer<typeof CreateThreadArgsSchema>;
+export declare const UpdateThreadArgsSchema: z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    content: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type UpdateThreadArgs = z.infer<typeof UpdateThreadArgsSchema>;
+export declare const CreateCommentArgsSchema: z.ZodObject<{
+    threadId: z.ZodString;
+    content: z.ZodString;
+    id: z.ZodOptional<z.ZodString>;
+    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>>>>;
+    actions: z.ZodOptional<z.ZodNullable<z.ZodUnknown>>;
+    recipients: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    groups: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    directMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    directGroupMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    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<{
+    id: z.ZodString;
+    content: z.ZodString;
+}, z.core.$strip>;
+export type UpdateCommentArgs = z.infer<typeof UpdateCommentArgsSchema>;
+export declare const CreateConversationArgsSchema: z.ZodObject<{
+    workspaceId: z.ZodNumber;
+    recipients: z.ZodArray<z.ZodNumber>;
+    id: z.ZodOptional<z.ZodString>;
+    title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type CreateConversationArgs = z.infer<typeof CreateConversationArgsSchema>;
+export declare const CreateMessageArgsSchema: z.ZodObject<{
+    conversationId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    threadId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    content: z.ZodString;
+    id: z.ZodOptional<z.ZodString>;
+    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>>>>;
+}, z.core.$strip>;
+export type CreateMessageArgs = z.infer<typeof CreateMessageArgsSchema>;
+export declare const GetChannelsArgsSchema: z.ZodObject<{
+    workspaceId: z.ZodNumber;
+    archived: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+}, z.core.$strip>;
+export type GetChannelsArgs = z.infer<typeof GetChannelsArgsSchema>;
+export declare const GetThreadsArgsSchema: z.ZodObject<{
+    workspaceId: z.ZodNumber;
+    channelId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    archived: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    newerThan: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+    olderThan: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+    limit: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, z.core.$strip>;
+export type GetThreadsArgs = z.infer<typeof GetThreadsArgsSchema>;
+export declare const GetCommentsArgsSchema: z.ZodObject<{
+    threadId: z.ZodString;
+    newerThan: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+    olderThan: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+    limit: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, z.core.$strip>;
+export type GetCommentsArgs = z.infer<typeof GetCommentsArgsSchema>;
+export declare const GetConversationsArgsSchema: z.ZodObject<{
+    workspaceId: z.ZodNumber;
+    archived: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+}, z.core.$strip>;
+export type GetConversationsArgs = z.infer<typeof GetConversationsArgsSchema>;
+export declare const GetOrCreateConversationArgsSchema: z.ZodObject<{
+    workspaceId: z.ZodNumber;
+    userIds: z.ZodArray<z.ZodNumber>;
+    id: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type GetOrCreateConversationArgs = z.infer<typeof GetOrCreateConversationArgsSchema>;
+export type UpdateUserArgs = {
+    name?: string;
+    password?: string;
+    timezone?: string;
+    lang?: string;
+    dateFormat?: string;
+    timeFormat?: string;
+    /** Theme ID (0-12). String aliases like `'dark'` are also accepted. */
+    theme?: number | string;
+};
+type SearchArgsCommon = {
+    workspaceId: number;
+    channelIds?: string[];
+    authorIds?: number[];
+    dateFrom?: string;
+    dateTo?: string;
+    limit?: number;
+    cursor?: string;
+};
+export type SearchArgs = (SearchArgsCommon & {
+    query: string;
+    mentionSelf?: boolean;
+}) | (SearchArgsCommon & {
+    query?: string;
+    mentionSelf: true;
+});
+export type SearchThreadArgs = {
+    query: string;
+    threadId: string;
+    limit?: number;
+    cursor?: string;
+};
+export type SearchConversationArgs = {
+    query: string;
+    conversationId: string;
+    limit?: number;
+    cursor?: string;
+};
+export type GetConversationMessagesArgs = {
+    conversationId: string;
+    newerThan?: Date;
+    olderThan?: Date;
+    limit?: number;
+    cursor?: string;
+};
+export type CreateConversationMessageArgs = {
+    conversationId: string;
+    content: string;
+    /** Caller-supplied ID. Auto-generated if omitted. */
+    id?: string;
+    attachments?: Attachment[];
+    actions?: unknown[];
+    directMentions?: number[];
+    directGroupMentions?: string[];
+    notify?: boolean;
+};
+export type UpdateConversationMessageArgs = {
+    id: string;
+    content: string;
+    attachments?: Attachment[];
+    actions?: unknown[];
+    directMentions?: number[];
+    directGroupMentions?: string[];
+};
+export declare const ARCHIVE_FILTER_VALUES: readonly ["active", "archived", "all"];
+export type ArchiveFilter = (typeof ARCHIVE_FILTER_VALUES)[number];
+export type GetInboxArgs = {
+    workspaceId: number;
+    newerThan?: Date;
+    olderThan?: Date;
+    limit?: number;
+    cursor?: string;
+    archiveFilter?: ArchiveFilter;
+};
+export type ArchiveAllArgs = {
+    workspaceId: number;
+    channelIds?: string[];
+    olderThan?: Date;
+};
+export type AddReactionArgs = {
+    threadId?: string;
+    commentId?: string;
+    messageId?: string;
+    reaction: string;
+};
+export type RemoveReactionArgs = {
+    threadId?: string;
+    commentId?: string;
+    messageId?: string;
+    reaction: string;
+};
+export type GetReactionsArgs = {
+    threadId?: string;
+    commentId?: string;
+    messageId?: string;
+};
+export type AddChannelUserArgs = {
+    id: string;
+    userId: number;
+};
+export type AddChannelUsersArgs = {
+    id: string;
+    userIds: number[];
+};
+export type RemoveChannelUserArgs = {
+    id: string;
+    userId: number;
+};
+export type RemoveChannelUsersArgs = {
+    id: string;
+    userIds: number[];
+};
+export declare const THREAD_ACTIONS: readonly ["close", "reopen"];
+export type ThreadAction = (typeof THREAD_ACTIONS)[number];
+/**
+ * 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: string;
+};
+export type CloseThreadArgs = ThreadActionCommentArgs;
+export type ReopenThreadArgs = ThreadActionCommentArgs;
+export type MoveThreadToChannelArgs = {
+    id: string;
+    toChannel: string;
+};
+export type MarkThreadReadArgs = {
+    id: string;
+    objIndex: number;
+};
+export type MarkThreadUnreadArgs = {
+    id: string;
+    objIndex: number;
+};
+export type MarkThreadUnreadForOthersArgs = {
+    id: string;
+    objIndex: number;
+};
+export type MuteThreadArgs = {
+    id: string;
+    minutes: number;
+};
+export type MarkCommentPositionArgs = {
+    threadId: string;
+    commentId: string;
+};
+export type UpdateConversationArgs = {
+    id: string;
+    title: string;
+    archived?: boolean;
+};
+export type AddConversationUserArgs = {
+    id: string;
+    userId: number;
+};
+export type AddConversationUsersArgs = {
+    id: string;
+    userIds: number[];
+};
+export type RemoveConversationUserArgs = {
+    id: string;
+    userId: number;
+};
+export type RemoveConversationUsersArgs = {
+    id: string;
+    userIds: number[];
+};
+export type MuteConversationArgs = {
+    id: string;
+    minutes: number;
+};
+export type AddGroupUserArgs = {
+    id: string;
+    workspaceId: number;
+    userId: number;
+};
+export type AddGroupUsersArgs = {
+    id: string;
+    workspaceId: number;
+    userIds: number[];
+};
+export type RemoveGroupUserArgs = {
+    id: string;
+    workspaceId: number;
+    userId: number;
+};
+export type RemoveGroupUsersArgs = {
+    id: string;
+    workspaceId: number;
+    userIds: number[];
+};
+export type GetWorkspaceUsersArgs = {
+    workspaceId: number;
+    archived?: boolean;
+};
+export type GetUserByIdArgs = {
+    workspaceId: number;
+    userId: number;
+};
+export type GetUserByEmailArgs = {
+    workspaceId: number;
+    email: string;
+};
+export type GetUserInfoArgs = {
+    workspaceId: number;
+    userId: number;
+};
+export type GetUserLocalTimeArgs = {
+    workspaceId: number;
+    userId: number;
+};
+export {};

package/dist/types/utils/case-conversion.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @internal
+ */
+export declare function camelCaseKeys(obj: unknown): unknown;
+/**
+ * @internal
+ */
+export declare function snakeCaseKeys(obj: unknown): unknown;

package/dist/types/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from './case-conversion.js';
+export * from './url-helpers.js';
+export * from './uuidv7.js';

package/dist/types/utils/timestamp-conversion.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Converts a Unix timestamp (in seconds) to a Date object.
+ * @param timestamp - Unix timestamp in seconds
+ * @returns Date object
+ */
+export declare function timestampToDate(timestamp: number): Date;
+/**
+ * Recursively transforms all timestamp fields (ending in 'Ts') in an object to Date objects.
+ * Also renames the fields by removing the 'Ts' suffix.
+ * @param obj - The object to transform
+ * @returns The transformed object with Date fields
+ */
+export declare function transformTimestamps<T>(obj: T): T;

package/dist/types/utils/url-helpers.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Helper functions for creating Comms permalinks (`https://comms.todoist.com/a/...`).
+ */
+export type CommsURLParams = {
+    workspaceId: number;
+    channelId?: string;
+    conversationId?: string;
+    threadId?: string;
+    commentId?: string;
+    messageId?: string;
+    userId?: number;
+};
+/**
+ * Builds a relative Comms URL based on the provided parameters
+ * @param params - URL parameters including workspace, channel, conversation, thread, etc.
+ * @returns A relative URL path
+ * @example
+ * getCommsURL({ workspaceId: 1, channelId: '7Yp...', threadId: '7Yq...' })
+ * // returns '/a/1/ch/7Yp.../t/7Yq.../'
+ */
+export declare function getCommsURL(params: CommsURLParams): string;
+/**
+ * Builds a full Comms URL (with protocol and hostname) based on the provided parameters
+ * @param params - URL parameters including workspace, channel, conversation, thread, etc.
+ * @param baseUrl - Optional base URL (defaults to 'https://comms.todoist.com')
+ */
+export declare function getFullCommsURL(params: CommsURLParams, baseUrl?: string): string;
+/** Returns the URL for a thread in a channel. */
+export declare function getThreadURL(params: {
+    workspaceId: number;
+    channelId: string;
+    threadId: string;
+}): string;
+/** Returns the URL for a channel. */
+export declare function getChannelURL(params: {
+    workspaceId: number;
+    channelId: string;
+}): string;
+/** Returns the URL for a conversation. */
+export declare function getConversationURL(params: {
+    workspaceId: number;
+    conversationId: string;
+}): string;
+/** Returns the URL for a specific message in a conversation. */
+export declare function getMessageURL(params: {
+    workspaceId: number;
+    conversationId: string;
+    messageId: string;
+}): string;
+/** Returns the URL for a comment in a thread. */
+export declare function getCommentURL(params: {
+    workspaceId: number;
+    channelId: string;
+    threadId: string;
+    commentId: string;
+}): string;
+/** Returns the URL for the threads root (channels view). */
+export declare function getThreadsRootURL(workspaceId: number): string;
+/** Returns the URL for the inbox. */
+export declare function getInboxURL(workspaceId: number, tab?: 'done' | 'mentions'): string;
+/** Returns the URL for the messages/conversations root. */
+export declare function getMessagesRootURL(workspaceId: number): string;
+/** Returns the URL for a user profile. */
+export declare function getUserProfileURL(params: {
+    workspaceId: number;
+    userId: number;
+}): string;
+/** Returns the URL for the saved threads view. */
+export declare function getSavedThreadsRootURL(workspaceId: number): string;
+/** Returns the URL for a saved thread. */
+export declare function getSavedThreadURL(params: {
+    workspaceId: number;
+    threadId: string;
+}): string;
+/** Returns the URL for the search root. */
+export declare function getSearchRootURL(workspaceId: number): string;
+/** Returns the URL for a search with a query. */
+export declare function getSearchQueryURL(params: {
+    workspaceId: number;
+    query: string;
+}): string;
+/** Returns the URL for settings. */
+export declare function getSettingsURL(params: {
+    workspaceId: number;
+    initialLocation?: string;
+}): string;
+/** Returns the URL for the team members root. */
+export declare function getTeamMembersRootURL(workspaceId: number): string;

package/dist/types/utils/uuidv7.d.ts

@@ -0,0 +1,40 @@
+export declare class UuidV7Error extends Error {
+    constructor(message: string);
+}
+/** Encode a 16-byte UUID as a base58 string. */
+export declare function encodeUuidToBase58(bytes: Uint8Array): string;
+/**
+ * Decode a base58 string back into 16 UUID bytes. Throws {@link UuidV7Error}
+ * if the input is malformed or doesn't decode to exactly 16 bytes.
+ */
+export declare function decodeBase58ToUuidBytes(value: string): Uint8Array;
+/**
+ * Mint a fresh ID. Callers should generate one of these locally when
+ * creating a new channel / thread / comment / conversation / message /
+ * group — the backend requires the client to supply the ID on create.
+ */
+export declare function generateId(): string;
+/**
+ * Resolve the `id` for a create-style API call: validate the caller-supplied
+ * value (throwing {@link UuidV7Error} before the request leaves the SDK) or
+ * mint a fresh one via {@link generateId}.
+ */
+export declare function resolveCreateId(id: string | undefined): string;
+/**
+ * Validate that a value matches the expected ID format (the decoded bytes
+ * have the v7 version nibble + RFC 4122/9562 variant bits). Does NOT
+ * validate the embedded timestamp — the backend may still reject a value
+ * that is too far in the future or past.
+ */
+export declare function isValidUuidV7Base58(value: unknown): value is string;
+/**
+ * Encode a canonical UUID string (hyphenated or not, any case) as a
+ * wire-format ID. Useful when interoperating with systems that hand you
+ * UUIDs in canonical form.
+ */
+export declare function base58FromUuidString(uuid: string): string;
+/**
+ * Inverse of {@link base58FromUuidString}: takes a wire-format ID and
+ * returns the canonical hyphenated UUID string.
+ */
+export declare function uuidStringFromBase58(value: string): string;