@doist/comms-sdk 2.0.2 → 3.0.0

package/dist/esm/utils/url-helpers.js

@@ -1,7 +1,34 @@
 /**
  * Helper functions for creating Comms permalinks (`https://comms.todoist.com/...`).
+ *
+ * Paths come from `@doist/sdk-kmp`, the shared implementation of Comms link
+ * routes, so they stay in step with the other Comms clients. The path builders
+ * are used rather than the URL builders so that `getFullCommsURL` can keep
+ * serving an arbitrary base URL.
  */
+import { commsChannelPath, commsConversationPath, commsInboxThreadCommentPath, commsInboxThreadPath, commsMessagePath, commsSavedThreadCommentPath, commsSavedThreadPath, commsThreadCommentPath, commsThreadPath, parseCommsLink, } from '@doist/sdk-kmp/comms';
 const COMMS_BASE_URL = 'https://comms.todoist.com';
+/**
+ * Builds a path, falling back to a locally built path when the link builder
+ * rejects one of the given ids. These helpers run while parsing API responses,
+ * so building a path must never fail the parse.
+ *
+ * Every error is caught, not just id rejection. The link builders expose no
+ * error type to narrow on, and a path is never important enough to fail a
+ * parse over, so any failure degrades to the locally built path.
+ *
+ * @param build Builds the path.
+ * @param fallback Builds the path without the shared link builder.
+ * @returns The built path, or the locally built path if an id was rejected.
+ */
+function buildPath(build, fallback) {
+    try {
+        return build();
+    }
+    catch {
+        return fallback();
+    }
+}
 /**
  * Builds a relative Comms URL based on the provided parameters
  * @param params - URL parameters including workspace, channel, conversation, thread, etc.
@@ -12,32 +39,33 @@ const COMMS_BASE_URL = 'https://comms.todoist.com';
  */
 export function getCommsURL(params) {
     const { workspaceId, channelId, conversationId, threadId, commentId, messageId, userId } = params;
-    let url = `/${workspaceId}/`;
+    const workspace = String(workspaceId);
     if (channelId) {
-        url += `ch/${channelId}/`;
+        if (threadId && commentId) {
+            return buildPath(() => commsThreadCommentPath(workspace, channelId, threadId, commentId), () => `/${workspace}/ch/${channelId}/t/${threadId}/c/${commentId}`);
+        }
         if (threadId) {
-            url += `t/${threadId}/`;
-            if (commentId) {
-                url += `c/${commentId}`;
-            }
+            return buildPath(() => commsThreadPath(workspace, channelId, threadId), () => `/${workspace}/ch/${channelId}/t/${threadId}/`);
         }
+        return buildPath(() => commsChannelPath(workspace, channelId), () => `/${workspace}/ch/${channelId}/`);
     }
-    else if (threadId) {
-        url += `inbox/t/${threadId}/`;
+    if (threadId) {
         if (commentId) {
-            url += `c/${commentId}`;
+            return buildPath(() => commsInboxThreadCommentPath(workspace, threadId, commentId), () => `/${workspace}/inbox/t/${threadId}/c/${commentId}`);
         }
+        return buildPath(() => commsInboxThreadPath(workspace, threadId), () => `/${workspace}/inbox/t/${threadId}/`);
     }
-    else if (conversationId) {
-        url += `msg/${conversationId}/`;
+    if (conversationId) {
         if (messageId) {
-            url += `m/${messageId}`;
+            return buildPath(() => commsMessagePath(workspace, conversationId, messageId), () => `/${workspace}/msg/${conversationId}/m/${messageId}`);
         }
+        return buildPath(() => commsConversationPath(workspace, conversationId), () => `/${workspace}/msg/${conversationId}/`);
     }
-    else if (userId) {
-        url += `people/u/${userId}`;
+    // The people view and the bare workspace root have no shared route.
+    if (userId) {
+        return `/${workspace}/people/u/${userId}`;
     }
-    return url;
+    return `/${workspace}/`;
 }
 /**
  * Builds a full Comms URL (with protocol and hostname) based on the provided parameters
@@ -92,7 +120,13 @@ export function getSavedThreadsRootURL(workspaceId) {
 }
 /** Returns the URL for a saved thread. */
 export function getSavedThreadURL(params) {
-    return `/${params.workspaceId}/saved/t/${params.threadId}`;
+    const workspace = String(params.workspaceId);
+    return buildPath(() => commsSavedThreadPath(workspace, params.threadId), () => `/${workspace}/saved/t/${params.threadId}`);
+}
+/** Returns the URL for a comment on a saved thread. */
+export function getSavedThreadCommentURL(params) {
+    const workspace = String(params.workspaceId);
+    return buildPath(() => commsSavedThreadCommentPath(workspace, params.threadId, params.commentId), () => `/${workspace}/saved/t/${params.threadId}/c/${params.commentId}`);
 }
 /** Returns the URL for the search root. */
 export function getSearchRootURL(workspaceId) {
@@ -112,3 +146,57 @@ export function getSettingsURL(params) {
 export function getTeamMembersRootURL(workspaceId) {
     return `/${workspaceId}/people/u`;
 }
+/** The kinds of Comms entity a URL can point at. */
+export const COMMS_LINK_TYPES = [
+    'channel',
+    'thread',
+    'thread_comment',
+    'inbox_thread',
+    'inbox_thread_comment',
+    'saved_thread',
+    'saved_thread_comment',
+    'conversation',
+    'message',
+];
+/**
+ * Maps the link parser's type names onto the types this SDK exposes. A name
+ * that is missing here is one this SDK does not know about, and is treated as
+ * an unrecognised URL rather than surfaced as a value outside the union.
+ */
+const LINK_TYPE_BY_PARSED_NAME = {
+    Channel: 'channel',
+    Thread: 'thread',
+    ThreadComment: 'thread_comment',
+    InboxThread: 'inbox_thread',
+    InboxThreadComment: 'inbox_thread_comment',
+    SavedThread: 'saved_thread',
+    SavedThreadComment: 'saved_thread_comment',
+    Conversation: 'conversation',
+    Message: 'message',
+};
+/**
+ * Parse a Comms URL into the entity it points at.
+ *
+ * @param url The URL to parse.
+ * @returns The entity the URL points at, or `null` if it is not a Comms URL.
+ */
+export function parseCommsURL(url) {
+    const link = parseCommsLink(url);
+    if (!link) {
+        return null;
+    }
+    const type = LINK_TYPE_BY_PARSED_NAME[link.type.name];
+    if (!type) {
+        return null;
+    }
+    return {
+        type,
+        workspaceId: link.workspaceId,
+        channelId: link.channelId ?? null,
+        threadId: link.threadId ?? null,
+        commentId: link.commentId ?? null,
+        conversationId: link.conversationId ?? null,
+        messageId: link.messageId ?? null,
+        isQuoteReference: link.isQuoteReference,
+    };
+}

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

@@ -1,5 +1,10 @@
 /**
  * Helper functions for creating Comms permalinks (`https://comms.todoist.com/...`).
+ *
+ * Paths come from `@doist/sdk-kmp`, the shared implementation of Comms link
+ * routes, so they stay in step with the other Comms clients. The path builders
+ * are used rather than the URL builders so that `getFullCommsURL` can keep
+ * serving an arbitrary base URL.
  */
 export type CommsURLParams = {
     workspaceId: number;
@@ -72,6 +77,12 @@ export declare function getSavedThreadURL(params: {
     workspaceId: number;
     threadId: string;
 }): string;
+/** Returns the URL for a comment on a saved thread. */
+export declare function getSavedThreadCommentURL(params: {
+    workspaceId: number;
+    threadId: string;
+    commentId: 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. */
@@ -86,3 +97,33 @@ export declare function getSettingsURL(params: {
 }): string;
 /** Returns the URL for the team members root. */
 export declare function getTeamMembersRootURL(workspaceId: number): string;
+/** The kinds of Comms entity a URL can point at. */
+export declare const COMMS_LINK_TYPES: readonly ["channel", "thread", "thread_comment", "inbox_thread", "inbox_thread_comment", "saved_thread", "saved_thread_comment", "conversation", "message"];
+/** The kind of Comms entity a URL points at. */
+export type CommsLinkType = (typeof COMMS_LINK_TYPES)[number];
+/** The entity a Comms URL points at. */
+export type CommsURLInfo = {
+    /** The kind of entity the URL points at. */
+    type: CommsLinkType;
+    /** The ID of the workspace the entity belongs to. */
+    workspaceId: string;
+    /** The ID of the channel, when the URL names one. */
+    channelId: string | null;
+    /** The ID of the thread, when the URL names one. */
+    threadId: string | null;
+    /** The ID of the comment, when the URL names one. */
+    commentId: string | null;
+    /** The ID of the conversation, when the URL names one. */
+    conversationId: string | null;
+    /** The ID of the message, when the URL names one. */
+    messageId: string | null;
+    /** Whether the URL points at a quoted reference rather than the entity itself. */
+    isQuoteReference: boolean;
+};
+/**
+ * Parse a Comms URL into the entity it points at.
+ *
+ * @param url The URL to parse.
+ * @returns The entity the URL points at, or `null` if it is not a Comms URL.
+ */
+export declare function parseCommsURL(url: string): CommsURLInfo | null;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/comms-sdk",
-    "version": "2.0.2",
+    "version": "3.0.0",
     "description": "A TypeScript wrapper for the Comms REST API.",
     "author": "Doist developers",
     "homepage": "https://doist.github.io/comms-sdk-typescript/",
@@ -15,14 +15,11 @@
         "node": ">=24",
         "npm": ">=11"
     },
-    "main": "dist/cjs/index.js",
-    "module": "dist/esm/index.js",
     "types": "dist/types/index.d.ts",
     "exports": {
         ".": {
             "types": "./dist/types/index.d.ts",
-            "import": "./dist/esm/index.js",
-            "require": "./dist/cjs/index.js"
+            "default": "./dist/esm/index.js"
         }
     },
     "sideEffects": false,
@@ -31,22 +28,21 @@
         "test": "vitest run",
         "test:watch": "vitest",
         "test:coverage": "vitest run --coverage",
-        "build:cjs": "npx tsc -p tsconfig.cjs.json",
         "build:esm": "npx tsc -p tsconfig.esm.json",
         "build:fix-esm": "node scripts/fix-esm-imports.cjs",
         "build:fix-dts": "node scripts/fix-dts-imports.cjs",
-        "build:post": "echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
-        "build": "npm-run-all clean build:cjs build:esm build:fix-esm build:fix-dts build:post",
+        "build": "npm-run-all clean build:esm build:fix-esm build:fix-dts",
         "type-check": "npx tsc --noEmit",
         "check": "oxlint src && oxfmt --check",
         "check:fix": "oxlint src --fix && oxfmt",
-        "attw": "attw --pack --ignore-rules fallback-condition false-esm",
+        "attw": "attw --pack --ignore-rules cjs-resolves-to-esm",
         "audit": "npm audit --audit-level=moderate",
         "integrity-checks": "npm-run-all clean check test build attw",
         "prepublishOnly": "npm run integrity-checks",
         "prepare": "npm run build"
     },
     "dependencies": {
+        "@doist/sdk-kmp": "0.2.3",
         "camelcase": "9.0.0",
         "ts-custom-error": "3.3.1",
         "undici": "7.29.0",
@@ -81,7 +77,6 @@
         "*.{ts,tsx,json,md,yml,yaml}": "oxfmt --no-error-on-unmatched-pattern"
     },
     "files": [
-        "dist/cjs/**/*",
         "dist/esm/**/*",
         "dist/types/**/*",
         "!dist/**/*.test.js",

package/dist/cjs/authentication.js

@@ -1,256 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TOKEN_ENDPOINT_AUTH_METHODS = exports.COMMS_SCOPES = void 0;
-exports.getAuthStateParameter = getAuthStateParameter;
-exports.getAuthorizationUrl = getAuthorizationUrl;
-exports.getAuthToken = getAuthToken;
-exports.refreshAuthToken = refreshAuthToken;
-exports.revokeAuthToken = revokeAuthToken;
-exports.registerClient = registerClient;
-const uuid_1 = require("uuid");
-const http_client_1 = require("./transport/http-client");
-const errors_1 = require("./types/errors");
-/**
- * Default origin of the Comms authorization server.
- *
- * The authorization server for Comms is Todoist (`todoist.com`), not the
- * resource server (`comms.todoist.com`). Tokens are issued by Todoist and
- * accepted by the Comms API. Paths match Todoist's published
- * `/.well-known/oauth-authorization-server` metadata.
- */
-const DEFAULT_AUTH_BASE_URL = 'https://todoist.com';
-function getAuthBaseUrl(baseUrl) {
-    const base = baseUrl ?? DEFAULT_AUTH_BASE_URL;
-    return base.endsWith('/') ? base.slice(0, -1) : base;
-}
-/**
- * OAuth scopes for the Comms API.
- *
- * @remarks
- * Request only the scopes your application needs:
- *
- * **User Scopes:**
- * - `user:read` - Access user's personal settings
- * - `user:write` - Access and update user's personal settings
- *
- * **Workspace Scopes:**
- * - `workspaces:read` - Access teams the user is part of
- * - `workspaces:write` - Access and update teams the user is part of
- *
- * **Channel Scopes:**
- * - `channels:read` - Access channels
- * - `channels:write` - Access and update channels
- * - `channels:remove` - Access, update, and delete channels
- *
- * **Thread Scopes:**
- * - `threads:read` - Access threads
- * - `threads:write` - Access and update threads
- * - `threads:remove` - Access, update, and delete threads
- *
- * **Comment Scopes:**
- * - `comments:read` - Access comments
- * - `comments:write` - Access and update comments
- * - `comments:remove` - Access, update, and delete comments
- *
- * **Group Scopes:**
- * - `groups:read` - Access groups
- * - `groups:write` - Access and update groups
- * - `groups:remove` - Access, update, and delete groups
- *
- * **Message Scopes:**
- * - `messages:read` - Access messages
- * - `messages:write` - Access and update messages
- * - `messages:remove` - Access, update, and delete messages
- *
- * **Reaction Scopes:**
- * - `reactions:read` - Access reactions
- * - `reactions:write` - Access and update reactions
- * - `reactions:remove` - Access, update, and delete reactions
- *
- * **Search Scopes:**
- * - `search:read` - Search
- *
- * **Attachment Scopes:**
- * - `attachments:read` - Access attachments
- * - `attachments:write` - Access and update attachments
- *
- * **Notification Scopes:**
- * - `notifications:read` - Read user's notifications settings
- * - `notifications:write` - Read and update user's notifications settings
- */
-exports.COMMS_SCOPES = [
-    'user:read',
-    'user:write',
-    'workspaces:read',
-    'workspaces:write',
-    'channels:read',
-    'channels:write',
-    'channels:remove',
-    'threads:read',
-    'threads:write',
-    'threads:remove',
-    'comments:read',
-    'comments:write',
-    'comments:remove',
-    'groups:read',
-    'groups:write',
-    'groups:remove',
-    'messages:read',
-    'messages:write',
-    'messages:remove',
-    'reactions:read',
-    'reactions:write',
-    'reactions:remove',
-    'search:read',
-    'attachments:read',
-    'attachments:write',
-    'notifications:read',
-    'notifications:write',
-];
-/** Supported token endpoint authentication methods for dynamic client registration. */
-exports.TOKEN_ENDPOINT_AUTH_METHODS = [
-    'client_secret_post',
-    'client_secret_basic',
-    'none',
-];
-function getAuthStateParameter() {
-    return (0, uuid_1.v4)();
-}
-/**
- * Generates the authorization URL for the OAuth2 flow.
- *
- * The `clientId` can be either a traditional client ID string (e.g. from
- * {@link registerClient}) or an HTTPS URL pointing to a client metadata document,
- * as defined in {@link https://drafts.ietf.org/doc/draft-ietf-oauth-client-id-metadata-document/ RFC draft-ietf-oauth-client-id-metadata-document}.
- */
-function getAuthorizationUrl(clientId, scopes, state, redirectUri, baseUrl) {
-    if (!scopes?.length) {
-        throw new Error('At least one scope value is required.');
-    }
-    const authBaseUrl = `${getAuthBaseUrl(baseUrl)}/oauth`;
-    const scope = scopes.join(' ');
-    const params = new URLSearchParams({
-        client_id: clientId,
-        response_type: 'code',
-        scope,
-        state,
-    });
-    if (redirectUri) {
-        params.append('redirect_uri', redirectUri);
-    }
-    return `${authBaseUrl}/authorize?${params.toString()}`;
-}
-async function getAuthToken(args, options) {
-    const tokenUrl = `${getAuthBaseUrl(options?.baseUrl)}/oauth/access_token`;
-    const payload = {
-        clientId: args.clientId,
-        clientSecret: args.clientSecret,
-        code: args.code,
-        grantType: 'authorization_code',
-        ...(args.redirectUri && { redirectUri: args.redirectUri }),
-    };
-    const response = await (0, http_client_1.request)({
-        httpMethod: 'POST',
-        baseUri: tokenUrl,
-        relativePath: '',
-        payload,
-        customFetch: options?.customFetch,
-    });
-    if (!(0, http_client_1.isSuccess)(response) || !response.data?.accessToken) {
-        throw new errors_1.CommsRequestError('Authentication token exchange failed.', response.status, response.data);
-    }
-    return response.data;
-}
-/**
- * Exchanges a refresh token for a new access token using the OAuth2
- * `refresh_token` grant.
- *
- * @example
- * ```typescript
- * const { accessToken, refreshToken } = await refreshAuthToken({
- *   clientId: 'client-id',
- *   clientSecret: 'client-secret',
- *   refreshToken: storedRefreshToken,
- * })
- * ```
- *
- * @returns The refreshed token. The response may include a new `refreshToken`
- * (rotated by the server); persist it in place of the previous one when present.
- * @throws {@link CommsRequestError} If the refresh fails
- */
-async function refreshAuthToken(args, options) {
-    const tokenUrl = `${getAuthBaseUrl(options?.baseUrl)}/oauth/access_token`;
-    const payload = {
-        clientId: args.clientId,
-        clientSecret: args.clientSecret,
-        refreshToken: args.refreshToken,
-        grantType: 'refresh_token',
-    };
-    const response = await (0, http_client_1.request)({
-        httpMethod: 'POST',
-        baseUri: tokenUrl,
-        relativePath: '',
-        payload,
-        customFetch: options?.customFetch,
-    });
-    if (!(0, http_client_1.isSuccess)(response) || !response.data?.accessToken) {
-        throw new errors_1.CommsRequestError('Authentication token refresh failed.', response.status, response.data);
-    }
-    return response.data;
-}
-async function revokeAuthToken(args, options) {
-    const revokeUrl = `${getAuthBaseUrl(options?.baseUrl)}/api/v1/revoke`;
-    const response = await (0, http_client_1.request)({
-        httpMethod: 'POST',
-        baseUri: revokeUrl,
-        relativePath: '',
-        payload: {
-            clientId: args.clientId,
-            clientSecret: args.clientSecret,
-            token: args.accessToken,
-        },
-        customFetch: options?.customFetch,
-    });
-    return (0, http_client_1.isSuccess)(response);
-}
-/**
- * Registers a new OAuth client via Dynamic Client Registration (RFC 7591).
- *
- * @example
- * ```typescript
- * const client = await registerClient({
- *   redirectUris: ['https://example.com/callback'],
- *   clientName: 'My App',
- *   scope: ['user:read', 'channels:read'],
- * })
- * // Use client.clientId and client.clientSecret for OAuth flows
- * ```
- *
- * @returns The registered client details
- * @throws {@link CommsRequestError} If the registration fails
- * @see {@link https://datatracker.ietf.org/doc/html/rfc7591 RFC 7591}
- */
-async function registerClient(args, options) {
-    const registerUrl = `${getAuthBaseUrl(options?.baseUrl)}/oauth/register`;
-    const response = await (0, http_client_1.request)({
-        httpMethod: 'POST',
-        baseUri: registerUrl,
-        relativePath: '',
-        payload: { ...args, scope: args.scope?.join(' ') },
-        customFetch: options?.customFetch,
-    });
-    if (!(0, http_client_1.isSuccess)(response) || !response.data?.clientId) {
-        throw new errors_1.CommsRequestError('Dynamic client registration failed.', response.status, response.data);
-    }
-    const { clientIdIssuedAt, clientSecretExpiresAt, scope, ...rest } = response.data;
-    return {
-        ...rest,
-        scope: scope ? scope.split(' ') : undefined,
-        clientIdIssuedAt: clientIdIssuedAt !== undefined ? new Date(clientIdIssuedAt * 1000) : undefined,
-        clientSecretExpiresAt: clientSecretExpiresAt === undefined
-            ? undefined
-            : clientSecretExpiresAt === 0
-                ? null
-                : new Date(clientSecretExpiresAt * 1000),
-    };
-}

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

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addCommentRequest = addCommentRequest;
-const endpoints_1 = require("../consts/endpoints");
-const http_client_1 = require("../transport/http-client");
-const uuidv7_1 = require("../utils/uuidv7");
-const notify_audience_1 = require("./notify-audience");
-/**
- * Internal helper that powers `comments.createComment`,
- * `threads.closeThread`, and `threads.reopenThread`.
- *
- * Normalizes the `notifyAudience` flag into a sentinel `groups` entry,
- * rejects sentinel IDs passed via `groups` / `directGroupMentions`, mints a
- * UUIDv7 `id` when the caller omits one, and posts to `/comments/add`. When
- * `threadAction` is set (`'close'` / `'reopen'`), it is forwarded on the
- * wire so the same request both adds the comment and transitions the
- * parent thread.
- *
- * @param context - Per-call client context (base URI, API token, optional `customFetch`).
- * @param params - The comment payload (`{@link CreateCommentArgs}`).
- * @param options - Optional configuration.
- * @param options.threadAction - When set, also transitions the parent thread (`'close'` or `'reopen'`).
- * @returns The parsed {@link Comment} returned by the API.
- */
-function addCommentRequest(context, params, options) {
-    const normalized = (0, notify_audience_1.applyNotifyAudience)(params);
-    const withId = {
-        ...normalized,
-        id: (0, uuidv7_1.resolveCreateId)(normalized.id),
-        threadId: (0, uuidv7_1.resolveReferenceId)(normalized.threadId, 'threadId'),
-    };
-    const payload = options?.threadAction
-        ? { ...withId, threadAction: options.threadAction }
-        : withId;
-    return (0, http_client_1.request)({
-        httpMethod: 'POST',
-        baseUri: context.baseUri,
-        relativePath: `${endpoints_1.ENDPOINT_COMMENTS}/add`,
-        apiToken: context.apiToken,
-        payload,
-        customFetch: context.customFetch,
-    }).then((response) => context.schema.parse(response.data));
-}

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

@@ -1,71 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AttachmentsClient = void 0;
-const endpoints_1 = require("../consts/endpoints");
-const entities_1 = require("../types/entities");
-const multipart_upload_1 = require("../utils/multipart-upload");
-const uuidv7_1 = require("../utils/uuidv7");
-const base_client_1 = require("./base-client");
-/**
- * Resolve the `attachment_id`: validate a caller-supplied value (throwing an
- * {@link UuidV7Error} that names `attachmentId` rather than the generic `id`) or
- * mint a fresh one. Wraps {@link resolveCreateId} so the error contract matches the
- * client's actual parameter.
- */
-function resolveAttachmentId(attachmentId) {
-    if (attachmentId !== undefined && !(0, uuidv7_1.isValidUuidV7Base58)(attachmentId)) {
-        throw new uuidv7_1.UuidV7Error(`invalid attachmentId ${JSON.stringify(attachmentId)} — use generateId() or omit \`attachmentId\` and let the SDK mint one.`);
-    }
-    return (0, uuidv7_1.resolveCreateId)(attachmentId);
-}
-/**
- * Client for uploading file attachments to Comms.
- *
- * Attachments are uploaded independently, then referenced by passing the returned
- * {@link Attachment} into the `attachments` array of `comments.createComment`,
- * `conversationMessages.createMessage`, and similar calls.
- */
-class AttachmentsClient extends base_client_1.BaseClient {
-    /**
-     * Uploads a file and returns the created {@link Attachment}.
-     *
-     * Mirrors the canonical multipart upload: `POST /attachments/upload` with the `file`
-     * binary plus `file_name`, `file_size`, `attachment_id`, and `underlying_type` form
-     * fields.
-     *
-     * @param args - The file to upload and optional metadata.
-     * @returns The created attachment, ready to attach to a comment or message.
-     *
-     * @example
-     * ```typescript
-     * import { readFile } from 'node:fs/promises'
-     *
-     * const attachment = await api.attachments.upload({
-     *   file: await readFile('./diagram.png'),
-     *   fileName: 'diagram.png',
-     * })
-     *
-     * await api.comments.createComment({
-     *   threadId: '7YpL3oZ4kZ9vP7Q1tR2sX3z',
-     *   content: 'See attached',
-     *   attachments: [attachment],
-     * })
-     * ```
-     */
-    async upload(args) {
-        const data = await (0, multipart_upload_1.uploadMultipartFile)({
-            baseUrl: this.getBaseUri(),
-            authToken: this.apiToken,
-            endpoint: `${endpoints_1.ENDPOINT_ATTACHMENTS}/upload`,
-            file: args.file,
-            fileName: args.fileName,
-            contentType: args.contentType,
-            additionalFields: {
-                attachment_id: resolveAttachmentId(args.attachmentId),
-            },
-            customFetch: this.customFetch,
-        });
-        return entities_1.AttachmentSchema.parse(data);
-    }
-}
-exports.AttachmentsClient = AttachmentsClient;

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

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseClient = void 0;
-const endpoints_1 = require("../consts/endpoints");
-const api_version_1 = require("../types/api-version");
-/**
- * Base class for every Comms API client. Centralizes URL handling and
- * config so individual clients stay focused on their endpoints.
- */
-class BaseClient {
-    constructor(config) {
-        this.apiToken = config.apiToken;
-        this.baseUrl = config.baseUrl;
-        this.defaultVersion = config.version || api_version_1.DEFAULT_API_VERSION;
-        this.customFetch = config.customFetch;
-    }
-    /**
-     * Returns the base URI for an API request, with a guaranteed trailing
-     * slash so relative paths resolve cleanly through `URL`.
-     */
-    getBaseUri() {
-        return (0, endpoints_1.getCommsBaseUri)(this.defaultVersion, this.baseUrl);
-    }
-    /**
-     * Base URL for entity web links, or `undefined` to use getFullCommsURL's
-     * default web app. Trailing-slash normalization happens in
-     * `getFullCommsURL`, so the configured value is returned verbatim.
-     */
-    getLinkBaseUrl() {
-        return this.baseUrl;
-    }
-}
-exports.BaseClient = BaseClient;