@doist/comms-sdk 0.1.0-alpha.1 → 0.2.1

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

@@ -62,18 +62,93 @@ export declare const ChannelListSchema: z.ZodArray<z.ZodPipe<z.ZodObject<{
  * currently rejects any `color` other than `1` on add/update.
  */
 export declare class WorkspacesClient extends BaseClient {
-    /** Gets all the user's workspaces. */
+    private readonly linkBaseUrl;
+    private readonly channelListSchema;
+    /**
+     * Gets all the user's workspaces.
+     *
+     * @returns An array of all workspaces the user belongs to.
+     *
+     * @example
+     * ```typescript
+     * const workspaces = await api.workspaces.getWorkspaces()
+     * workspaces.forEach(ws => console.log(ws.name))
+     * ```
+     */
     getWorkspaces(): Promise<Workspace[]>;
-    /** Gets a single workspace object by id. */
+    /**
+     * Gets a single workspace object by id.
+     *
+     * @param id - The workspace ID.
+     * @returns The workspace object.
+     *
+     * @example
+     * ```typescript
+     * const workspace = await api.workspaces.getWorkspace(123)
+     * console.log(workspace.name)
+     * ```
+     */
     getWorkspace(id: number): Promise<Workspace>;
-    /** Gets the user's default workspace. */
+    /**
+     * Gets the user's default workspace.
+     *
+     * @returns The default workspace object.
+     *
+     * @example
+     * ```typescript
+     * const workspace = await api.workspaces.getDefaultWorkspace()
+     * console.log(workspace.name)
+     * ```
+     */
     getDefaultWorkspace(): Promise<Workspace>;
-    /** Creates a new workspace. */
+    /**
+     * Creates a new workspace.
+     *
+     * @param name - The name of the new workspace.
+     * @returns The created workspace object.
+     *
+     * @example
+     * ```typescript
+     * const workspace = await api.workspaces.createWorkspace('My Team')
+     * console.log('Created:', workspace.name)
+     * ```
+     */
     createWorkspace(name: string): Promise<Workspace>;
-    /** Updates an existing workspace. */
+    /**
+     * Updates an existing workspace.
+     *
+     * @param id - The workspace ID.
+     * @param name - The new name for the workspace.
+     * @returns The updated workspace object.
+     *
+     * @example
+     * ```typescript
+     * const workspace = await api.workspaces.updateWorkspace(123, 'New Team Name')
+     * ```
+     */
     updateWorkspace(id: number, name: string): Promise<Workspace>;
-    /** Removes a workspace and all its data (not recoverable). */
+    /**
+     * Removes a workspace and all its data (not recoverable).
+     *
+     * @param id - The workspace ID.
+     *
+     * @example
+     * ```typescript
+     * await api.workspaces.removeWorkspace(123)
+     * ```
+     */
     removeWorkspace(id: number): Promise<void>;
-    /** Gets the public channels of a workspace. */
+    /**
+     * Gets the public channels of a workspace.
+     *
+     * @param id - The workspace ID.
+     * @returns An array of public channel objects.
+     *
+     * @example
+     * ```typescript
+     * const channels = await api.workspaces.getPublicChannels(123)
+     * channels.forEach(ch => console.log(ch.name))
+     * ```
+     */
     getPublicChannels(id: number): Promise<Channel[]>;
 }

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

@@ -10,10 +10,13 @@ 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 { ApiVersion } from './types/api-version.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 API version. Defaults to 'v1'. */
+    version?: ApiVersion;
     /** Optional custom fetch implementation for cross-platform compatibility (e.g., Obsidian, React Native, Electron). */
     customFetch?: CustomFetch;
 };

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

@@ -1,10 +1,15 @@
+import type { ApiVersion } from '../types/api-version.js';
 /**
  * Gets the base URI for Comms API requests.
  *
+ * Preserves any path component on `domainBase` so callers can route through
+ * a proxy (e.g. `https://proxy.example.com/comms` → `.../comms/api/v1/`).
+ *
+ * @param version - API version. Defaults to 'v1'.
  * @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 function getCommsBaseUri(version?: ApiVersion, domainBase?: string): string;
 export declare const ENDPOINT_USERS = "users";
 export declare const ENDPOINT_WORKSPACES = "workspaces";
 export declare const ENDPOINT_CHANNELS = "channels";

package/dist/types/testUtils/test-defaults.d.ts

@@ -1,5 +1,6 @@
 import type { Channel, Comment, Conversation, Group, Thread, User, Workspace, WorkspaceUser } from '../types/entities.js';
 export declare const TEST_API_TOKEN = "test-api-token";
+export declare const TEST_API_BASE_URL: string;
 export declare const TEST_CHANNEL_ID = "7YpL3oZ4kZ9vP7Q1tR2sX3y";
 export declare const TEST_THREAD_ID = "7YpL3oZ4kZ9vP7Q1tR2sX3z";
 export declare const TEST_COMMENT_ID = "7YpL3oZ4kZ9vP7Q1tR2sX41";

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

@@ -0,0 +1,6 @@
+/**
+ * Supported Comms API versions
+ */
+export declare const API_VERSIONS: readonly ["v1"];
+export type ApiVersion = (typeof API_VERSIONS)[number];
+export declare const DEFAULT_API_VERSION: ApiVersion;