@agentuity/core 1.0.29 → 1.0.30

package/src/services/task.ts

@@ -3,316 +3,1018 @@ import { buildUrl, toServiceException } from './_util.ts';
 import { StructuredError } from '../error.ts';
 import { safeStringify } from '../json.ts';
 
-// Task type enums
+/**
+ * Priority level for a task, from highest (`'high'`) to no priority (`'none'`).
+ */
 export type TaskPriority = 'high' | 'medium' | 'low' | 'none';
+
+/**
+ * The classification of a task.
+ *
+ * - `'epic'` — Large initiatives that span multiple features or tasks.
+ * - `'feature'` — New capabilities to be built.
+ * - `'enhancement'` — Improvements to existing features.
+ * - `'bug'` — Defects to be fixed.
+ * - `'task'` — General work items.
+ */
 export type TaskType = 'epic' | 'feature' | 'enhancement' | 'bug' | 'task';
+
+/**
+ * The lifecycle status of a task.
+ *
+ * - `'open'` — Created, not yet started.
+ * - `'in_progress'` — Actively being worked on.
+ * - `'done'` — Work completed.
+ * - `'closed'` — Resolved and closed.
+ * - `'cancelled'` — Abandoned.
+ */
 export type TaskStatus = 'open' | 'in_progress' | 'closed' | 'done' | 'cancelled';
 
-// Entity reference (user/project with id + name)
+/**
+ * A lightweight reference to a user or project entity, containing just the ID
+ * and display name. Used for creator, assignee, closer, and project associations.
+ */
 export interface EntityRef {
+	/** Unique identifier of the referenced entity. */
 	id: string;
+
+	/** Human-readable display name of the entity. */
 	name: string;
 }
 
-// Task object (returned from API)
+/**
+ * A work item in the task management system.
+ *
+ * Tasks can represent epics, features, bugs, enhancements, or generic tasks.
+ * They support hierarchical organization via {@link Task.parent_id | parent_id},
+ * assignment tracking, and lifecycle management through status transitions.
+ *
+ * @remarks
+ * Status transitions are tracked automatically — when a task moves to a new status,
+ * the corresponding date field (e.g., {@link Task.open_date | open_date},
+ * {@link Task.in_progress_date | in_progress_date}) is set by the server.
+ */
 export interface Task {
+	/** Unique identifier for the task. */
 	id: string;
+
+	/** ISO 8601 timestamp when the task was created. */
 	created_at: string;
+
+	/** ISO 8601 timestamp when the task was last modified. */
 	updated_at: string;
+
+	/**
+	 * The task title.
+	 *
+	 * @remarks Must be non-empty and at most 1024 characters.
+	 */
 	title: string;
+
+	/**
+	 * Detailed description of the task.
+	 *
+	 * @remarks Maximum 65,536 characters.
+	 */
 	description?: string;
+
+	/**
+	 * Arbitrary key-value metadata attached to the task.
+	 * Can be used for custom fields, integrations, or filtering.
+	 */
 	metadata?: Record<string, unknown>;
+
+	/** The priority level of the task. */
 	priority: TaskPriority;
+
+	/**
+	 * ID of the parent task, enabling hierarchical task organization
+	 * (e.g., an epic containing features).
+	 */
 	parent_id?: string;
+
+	/** The classification of this task. */
 	type: TaskType;
+
+	/** The current lifecycle status of the task. */
 	status: TaskStatus;
+
+	/** ISO 8601 timestamp when the task was moved to `'open'` status. */
 	open_date?: string;
+
+	/** ISO 8601 timestamp when the task was moved to `'in_progress'` status. */
 	in_progress_date?: string;
+
+	/** ISO 8601 timestamp when the task was closed. */
 	closed_date?: string;
+
+	/**
+	 * ID of the user who created the task.
+	 *
+	 * @remarks Legacy field; prefer {@link Task.creator | creator}.
+	 */
 	created_id: string;
+
+	/**
+	 * ID of the user the task is assigned to.
+	 *
+	 * @remarks Legacy field; prefer {@link Task.assignee | assignee}.
+	 */
 	assigned_id?: string;
+
+	/**
+	 * ID of the user who closed the task.
+	 *
+	 * @remarks Legacy field; prefer {@link Task.closer | closer}.
+	 */
 	closed_id?: string;
+
+	/** Reference to the user who created the task. */
 	creator?: EntityRef;
+
+	/** Reference to the user the task is assigned to. */
 	assignee?: EntityRef;
+
+	/** Reference to the user who closed the task. */
 	closer?: EntityRef;
+
+	/** Reference to the project this task belongs to. */
 	project?: EntityRef;
+
+	/** ISO 8601 timestamp when the task was cancelled. */
 	cancelled_date?: string;
-	deleted: boolean;
+
+	/** Array of tags associated with this task. */
 	tags?: Tag[];
+
+	/** Array of comments on this task. */
 	comments?: Comment[];
 }
 
-// Comment object (returned from API)
+/**
+ * A comment on a task, supporting threaded discussion.
+ */
 export interface Comment {
+	/** Unique identifier for the comment. */
 	id: string;
+
+	/** ISO 8601 timestamp when the comment was created. */
 	created_at: string;
+
+	/** ISO 8601 timestamp when the comment was last edited. */
 	updated_at: string;
+
+	/** ID of the task this comment belongs to. */
 	task_id: string;
+
+	/** ID of the user who authored the comment. */
 	user_id: string;
+
+	/** Reference to the comment author with display name. */
 	author?: EntityRef;
+
+	/**
+	 * The comment text content.
+	 *
+	 * @remarks Must be non-empty.
+	 */
 	body: string;
 }
 
-// Tag object (returned from API)
+/**
+ * A label that can be applied to tasks for categorization and filtering.
+ */
 export interface Tag {
+	/** Unique identifier for the tag. */
 	id: string;
+
+	/** ISO 8601 timestamp when the tag was created. */
 	created_at: string;
+
+	/** Display name of the tag. */
 	name: string;
+
+	/**
+	 * Optional hex color code for the tag.
+	 *
+	 * @example '#ff0000'
+	 */
 	color?: string;
 }
 
-// Changelog entry
+/**
+ * A record of a single field change on a task, providing an audit trail.
+ */
 export interface TaskChangelogEntry {
+	/** Unique identifier for the changelog entry. */
 	id: string;
+
+	/** ISO 8601 timestamp when the change occurred. */
 	created_at: string;
+
+	/** ID of the task that was changed. */
 	task_id: string;
+
+	/**
+	 * Name of the field that was changed.
+	 *
+	 * @example 'status'
+	 * @example 'priority'
+	 * @example 'assigned_id'
+	 */
 	field: string;
+
+	/** The previous value of the field (as a string), or `undefined` if the field was newly set. */
 	old_value?: string;
+
+	/** The new value of the field (as a string), or `undefined` if the field was cleared. */
 	new_value?: string;
 }
 
-// Request params
+/**
+ * Parameters for creating a new task.
+ */
 export interface CreateTaskParams {
+	/**
+	 * The task title (required).
+	 *
+	 * @remarks Must be non-empty and at most 1024 characters.
+	 */
 	title: string;
+
+	/**
+	 * Detailed description of the task.
+	 *
+	 * @remarks Maximum 65,536 characters.
+	 */
 	description?: string;
+
+	/** Arbitrary key-value metadata. */
 	metadata?: Record<string, unknown>;
+
+	/**
+	 * Priority level. Defaults to `'none'` if not provided.
+	 *
+	 * @default 'none'
+	 */
 	priority?: TaskPriority;
+
+	/** ID of the parent task for hierarchical organization. */
 	parent_id?: string;
+
+	/** The task classification (required). */
 	type: TaskType;
+
+	/**
+	 * Initial status. Defaults to `'open'` if not provided.
+	 *
+	 * @default 'open'
+	 */
 	status?: TaskStatus;
+
+	/**
+	 * ID of the creator.
+	 *
+	 * @remarks Legacy field; prefer {@link CreateTaskParams.creator | creator}.
+	 */
 	created_id: string;
+
+	/**
+	 * ID of the assigned user.
+	 *
+	 * @remarks Legacy field; prefer {@link CreateTaskParams.assignee | assignee}.
+	 */
 	assigned_id?: string;
+
+	/** Reference to the user creating the task (id and name). */
 	creator?: EntityRef;
+
+	/** Reference to the user being assigned the task. */
 	assignee?: EntityRef;
+
+	/** Reference to the project this task belongs to. */
 	project?: EntityRef;
+
+	/** Array of tag IDs to associate with the task at creation. */
 	tag_ids?: string[];
 }
 
+/**
+ * Parameters for partially updating an existing task.
+ *
+ * @remarks Only provided fields are modified; omitted fields remain unchanged.
+ */
 export interface UpdateTaskParams {
+	/**
+	 * Updated task title.
+	 *
+	 * @remarks Must be non-empty and at most 1024 characters if provided.
+	 */
 	title?: string;
+
+	/**
+	 * Updated description.
+	 *
+	 * @remarks Maximum 65,536 characters.
+	 */
 	description?: string;
+
+	/** Updated key-value metadata. */
 	metadata?: Record<string, unknown>;
+
+	/** Updated priority level. */
 	priority?: TaskPriority;
+
+	/** Updated parent task ID. */
 	parent_id?: string;
+
+	/** Updated task classification. */
 	type?: TaskType;
+
+	/** Updated lifecycle status. */
 	status?: TaskStatus;
+
+	/**
+	 * Updated assigned user ID.
+	 *
+	 * @remarks Legacy field; prefer {@link UpdateTaskParams.assignee | assignee}.
+	 */
 	assigned_id?: string;
+
+	/**
+	 * ID of the user closing the task.
+	 *
+	 * @remarks Legacy field; prefer {@link UpdateTaskParams.closer | closer}.
+	 */
 	closed_id?: string;
+
+	/** Reference to the user being assigned the task. */
 	assignee?: EntityRef;
+
+	/** Reference to the user closing the task. */
 	closer?: EntityRef;
+
+	/** Reference to the project this task belongs to. */
 	project?: EntityRef;
 }
 
+/**
+ * Parameters for filtering and paginating the task list.
+ */
 export interface ListTasksParams {
+	/** Filter by task status. */
 	status?: TaskStatus;
+
+	/** Filter by task type. */
 	type?: TaskType;
+
+	/** Filter by priority level. */
 	priority?: TaskPriority;
+
+	/** Filter by assigned user ID. */
 	assigned_id?: string;
+
+	/** Filter by parent task ID (get subtasks). */
 	parent_id?: string;
+
+	/** Filter by project ID. */
 	project_id?: string;
+
+	/** Filter by tag ID. */
 	tag_id?: string;
+
+	/**
+	 * Filter for soft-deleted tasks.
+	 *
+	 * @default false
+	 */
 	deleted?: boolean;
+
+	/**
+	 * Sort field. Prefix with `-` for descending order.
+	 *
+	 * @remarks Supported values: `'created_at'`, `'updated_at'`, `'priority'`.
+	 * Prefix with `-` for descending (e.g., `'-created_at'`).
+	 */
 	sort?: string;
+
+	/** Sort direction: `'asc'` or `'desc'`. */
 	order?: 'asc' | 'desc';
+
+	/** Maximum number of results to return. */
 	limit?: number;
+
+	/** Number of results to skip for pagination. */
 	offset?: number;
 }
 
+/**
+ * Paginated list of tasks with total count.
+ */
 export interface ListTasksResult {
+	/** Array of tasks matching the query. */
 	tasks: Task[];
+
+	/** Total number of tasks matching the filters (before pagination). */
 	total: number;
+
+	/** The limit that was applied. */
 	limit: number;
+
+	/** The offset that was applied. */
 	offset: number;
 }
 
+/**
+ * Paginated list of changelog entries for a task.
+ */
 export interface TaskChangelogResult {
+	/** Array of change records. */
 	changelog: TaskChangelogEntry[];
+
+	/** Total number of changelog entries. */
 	total: number;
+
+	/** Applied limit. */
 	limit: number;
+
+	/** Applied offset. */
 	offset: number;
 }
 
+/**
+ * Paginated list of comments on a task.
+ */
 export interface ListCommentsResult {
+	/** Array of comments. */
 	comments: Comment[];
+
+	/** Total number of comments. */
 	total: number;
+
+	/** Applied limit. */
 	limit: number;
+
+	/** Applied offset. */
 	offset: number;
 }
 
+/**
+ * List of all tags in the organization.
+ */
 export interface ListTagsResult {
+	/** Array of tags. */
 	tags: Tag[];
 }
 
-// Attachment types
+/**
+ * A file attachment on a task. Attachments are stored in S3 and accessed via presigned URLs.
+ */
 export interface Attachment {
+	/** Unique identifier for the attachment. */
 	id: string;
+
+	/** ISO 8601 timestamp when the attachment was uploaded. */
 	created_at: string;
+
+	/** ID of the task this attachment belongs to. */
 	task_id: string;
+
+	/** ID of the user who uploaded the attachment. */
 	user_id: string;
+
+	/** Reference to the uploader with display name. */
 	author?: EntityRef;
+
+	/** Original filename of the uploaded file. */
 	filename: string;
+
+	/**
+	 * MIME type of the file.
+	 *
+	 * @example 'application/pdf'
+	 */
 	content_type?: string;
+
+	/** File size in bytes. */
 	size?: number;
 }
 
+/**
+ * Parameters for initiating a file upload to a task.
+ */
 export interface CreateAttachmentParams {
+	/** The filename for the attachment (required). */
 	filename: string;
+
+	/** MIME type of the file. */
 	content_type?: string;
+
+	/** File size in bytes. */
 	size?: number;
 }
 
+/**
+ * Response from initiating an attachment upload. Contains a presigned S3 URL for direct upload.
+ */
 export interface PresignUploadResponse {
+	/** The created attachment record. */
 	attachment: Attachment;
+
+	/** A presigned S3 URL to upload the file content via HTTP PUT. */
 	presigned_url: string;
+
+	/** Number of seconds until the presigned URL expires. */
 	expiry_seconds: number;
 }
 
+/**
+ * Response containing a presigned S3 URL for downloading an attachment.
+ */
 export interface PresignDownloadResponse {
+	/** A presigned S3 URL to download the file via HTTP GET. */
 	presigned_url: string;
+
+	/** Number of seconds until the presigned URL expires. */
 	expiry_seconds: number;
 }
 
+/**
+ * List of attachments on a task.
+ */
 export interface ListAttachmentsResult {
+	/** Array of attachment records. */
 	attachments: Attachment[];
+
+	/** Total number of attachments. */
 	total: number;
 }
 
+/**
+ * List of all users who have been referenced in tasks (as creators, assignees, or closers).
+ */
 export interface ListUsersResult {
+	/** Array of user entity references. */
 	users: EntityRef[];
 }
 
+/**
+ * List of all projects that have been referenced in tasks.
+ */
 export interface ListProjectsResult {
+	/** Array of project entity references. */
 	projects: EntityRef[];
 }
 
+/**
+ * Parameters for querying task activity time-series data.
+ */
 export interface TaskActivityParams {
-	days?: number; // min 7, max 365, default 90
+	/**
+	 * Number of days of activity to retrieve.
+	 *
+	 * @remarks Minimum 7, maximum 365.
+	 * @default 90
+	 */
+	days?: number;
 }
 
+/**
+ * A single day's snapshot of task counts by status.
+ */
 export interface TaskActivityDataPoint {
-	date: string; // "2026-02-28"
+	/**
+	 * The date in `YYYY-MM-DD` format.
+	 *
+	 * @example '2026-02-28'
+	 */
+	date: string;
+
+	/** Number of tasks in `'open'` status on this date. */
 	open: number;
+
+	/** Number of tasks in `'in_progress'` status on this date. */
 	inProgress: number;
+
+	/** Number of tasks in `'done'` status on this date. */
 	done: number;
+
+	/** Number of tasks in `'closed'` status on this date. */
 	closed: number;
+
+	/** Number of tasks in `'cancelled'` status on this date. */
 	cancelled: number;
 }
 
+/**
+ * Task activity time-series data.
+ */
 export interface TaskActivityResult {
+	/** Array of daily activity snapshots, ordered chronologically. */
 	activity: TaskActivityDataPoint[];
+
+	/** The number of days of data returned. */
 	days: number;
 }
 
+/**
+ * Interface defining the contract for task storage operations.
+ *
+ * Implemented by {@link TaskStorageService}.
+ */
 export interface TaskStorage {
+	/**
+	 * Create a new task.
+	 *
+	 * @param params - The task creation parameters
+	 * @returns The newly created task
+	 */
 	create(params: CreateTaskParams): Promise<Task>;
+
+	/**
+	 * Get a task by its ID.
+	 *
+	 * @param id - The unique task identifier
+	 * @returns The task if found, or `null` if not found
+	 */
 	get(id: string): Promise<Task | null>;
+
+	/**
+	 * List tasks with optional filtering and pagination.
+	 *
+	 * @param params - Optional filter and pagination parameters
+	 * @returns Paginated list of matching tasks
+	 */
 	list(params?: ListTasksParams): Promise<ListTasksResult>;
+
+	/**
+	 * Partially update an existing task.
+	 *
+	 * @param id - The unique task identifier
+	 * @param params - Fields to update (only provided fields are changed)
+	 * @returns The updated task
+	 */
 	update(id: string, params: UpdateTaskParams): Promise<Task>;
+
+	/**
+	 * Close a task by setting its status to closed.
+	 *
+	 * @param id - The unique task identifier
+	 * @returns The closed task
+	 */
 	close(id: string): Promise<Task>;
+
+	/**
+	 * Soft-delete a task, marking it as deleted without permanent removal.
+	 *
+	 * @param id - The unique task identifier
+	 * @returns The soft-deleted task
+	 */
 	softDelete(id: string): Promise<Task>;
+
+	/**
+	 * Get the changelog (audit trail) for a task.
+	 *
+	 * @param id - The unique task identifier
+	 * @param params - Optional pagination parameters
+	 * @returns Paginated list of changelog entries
+	 */
 	changelog(
 		id: string,
 		params?: { limit?: number; offset?: number }
 	): Promise<TaskChangelogResult>;
+
+	/**
+	 * Create a comment on a task.
+	 *
+	 * @param taskId - The ID of the task to comment on
+	 * @param body - The comment text content
+	 * @param userId - The ID of the user authoring the comment
+	 * @param author - Optional entity reference with display name
+	 * @returns The newly created comment
+	 */
 	createComment(
 		taskId: string,
 		body: string,
 		userId: string,
 		author?: EntityRef
 	): Promise<Comment>;
+
+	/**
+	 * Get a comment by its ID.
+	 *
+	 * @param commentId - The unique comment identifier
+	 * @returns The comment
+	 */
 	getComment(commentId: string): Promise<Comment>;
+
+	/**
+	 * Update a comment's body text.
+	 *
+	 * @param commentId - The unique comment identifier
+	 * @param body - The new comment text
+	 * @returns The updated comment
+	 */
 	updateComment(commentId: string, body: string): Promise<Comment>;
+
+	/**
+	 * Delete a comment.
+	 *
+	 * @param commentId - The unique comment identifier
+	 */
 	deleteComment(commentId: string): Promise<void>;
+
+	/**
+	 * List comments on a task with optional pagination.
+	 *
+	 * @param taskId - The ID of the task
+	 * @param params - Optional pagination parameters
+	 * @returns Paginated list of comments
+	 */
 	listComments(
 		taskId: string,
 		params?: { limit?: number; offset?: number }
 	): Promise<ListCommentsResult>;
+
+	/**
+	 * Create a new tag.
+	 *
+	 * @param name - The tag display name
+	 * @param color - Optional hex color code (e.g., `'#ff0000'`)
+	 * @returns The newly created tag
+	 */
 	createTag(name: string, color?: string): Promise<Tag>;
+
+	/**
+	 * Get a tag by its ID.
+	 *
+	 * @param tagId - The unique tag identifier
+	 * @returns The tag
+	 */
 	getTag(tagId: string): Promise<Tag>;
+
+	/**
+	 * Update a tag's name and optionally its color.
+	 *
+	 * @param tagId - The unique tag identifier
+	 * @param name - The new tag name
+	 * @param color - Optional new hex color code
+	 * @returns The updated tag
+	 */
 	updateTag(tagId: string, name: string, color?: string): Promise<Tag>;
+
+	/**
+	 * Delete a tag.
+	 *
+	 * @param tagId - The unique tag identifier
+	 */
 	deleteTag(tagId: string): Promise<void>;
+
+	/**
+	 * List all tags in the organization.
+	 *
+	 * @returns List of all tags
+	 */
 	listTags(): Promise<ListTagsResult>;
+
+	/**
+	 * Associate a tag with a task.
+	 *
+	 * @param taskId - The ID of the task
+	 * @param tagId - The ID of the tag to add
+	 */
 	addTagToTask(taskId: string, tagId: string): Promise<void>;
+
+	/**
+	 * Remove a tag association from a task.
+	 *
+	 * @param taskId - The ID of the task
+	 * @param tagId - The ID of the tag to remove
+	 */
 	removeTagFromTask(taskId: string, tagId: string): Promise<void>;
+
+	/**
+	 * List all tags associated with a specific task.
+	 *
+	 * @param taskId - The ID of the task
+	 * @returns Array of tags on the task
+	 */
 	listTagsForTask(taskId: string): Promise<Tag[]>;
+
+	/**
+	 * Initiate a file upload to a task. Returns a presigned S3 URL for direct upload.
+	 *
+	 * @param taskId - The ID of the task to attach the file to
+	 * @param params - Attachment metadata (filename, content type, size)
+	 * @returns The attachment record and a presigned upload URL
+	 */
 	uploadAttachment(taskId: string, params: CreateAttachmentParams): Promise<PresignUploadResponse>;
+
+	/**
+	 * Confirm that a file upload has completed successfully.
+	 *
+	 * @param attachmentId - The unique attachment identifier
+	 * @returns The confirmed attachment record
+	 */
 	confirmAttachment(attachmentId: string): Promise<Attachment>;
+
+	/**
+	 * Get a presigned S3 URL for downloading an attachment.
+	 *
+	 * @param attachmentId - The unique attachment identifier
+	 * @returns A presigned download URL
+	 */
 	downloadAttachment(attachmentId: string): Promise<PresignDownloadResponse>;
+
+	/**
+	 * List all attachments on a task.
+	 *
+	 * @param taskId - The ID of the task
+	 * @returns List of attachments with total count
+	 */
 	listAttachments(taskId: string): Promise<ListAttachmentsResult>;
+
+	/**
+	 * Delete an attachment.
+	 *
+	 * @param attachmentId - The unique attachment identifier
+	 */
 	deleteAttachment(attachmentId: string): Promise<void>;
+
+	/**
+	 * List all users who have been referenced in tasks.
+	 *
+	 * @returns List of user entity references
+	 */
 	listUsers(): Promise<ListUsersResult>;
+
+	/**
+	 * List all projects that have been referenced in tasks.
+	 *
+	 * @returns List of project entity references
+	 */
 	listProjects(): Promise<ListProjectsResult>;
+
+	/**
+	 * Get task activity time-series data showing daily status counts.
+	 *
+	 * @param params - Optional parameters controlling the number of days to retrieve
+	 * @returns Time-series activity data
+	 */
 	getActivity(params?: TaskActivityParams): Promise<TaskActivityResult>;
 }
 
+/** API version string used for task CRUD, comment, tag, and attachment endpoints. */
 const TASK_API_VERSION = '2026-02-24';
+
+/** API version string used for the task activity analytics endpoint. */
 const TASK_ACTIVITY_API_VERSION = '2026-02-28';
 
+/** Thrown when a task ID parameter is empty or not a string. */
 const TaskIdRequiredError = StructuredError(
 	'TaskIdRequiredError',
 	'Task ID is required and must be a non-empty string'
 );
 
+/** Thrown when a task title is empty or not a string. */
 const TaskTitleRequiredError = StructuredError(
 	'TaskTitleRequiredError',
 	'Task title is required and must be a non-empty string'
 );
 
+/** Thrown when a comment ID parameter is empty or not a string. */
 const CommentIdRequiredError = StructuredError(
 	'CommentIdRequiredError',
 	'Comment ID is required and must be a non-empty string'
 );
 
+/** Thrown when a comment body is empty or not a string. */
 const CommentBodyRequiredError = StructuredError(
 	'CommentBodyRequiredError',
 	'Comment body is required and must be a non-empty string'
 );
 
+/** Thrown when a tag ID parameter is empty or not a string. */
 const TagIdRequiredError = StructuredError(
 	'TagIdRequiredError',
 	'Tag ID is required and must be a non-empty string'
 );
 
+/** Thrown when a tag name is empty or not a string. */
 const TagNameRequiredError = StructuredError(
 	'TagNameRequiredError',
 	'Tag name is required and must be a non-empty string'
 );
 
+/** Thrown when an attachment ID parameter is empty or not a string. */
 const AttachmentIdRequiredError = StructuredError(
 	'AttachmentIdRequiredError',
 	'Attachment ID is required and must be a non-empty string'
 );
 
+/** Thrown when a user ID parameter is empty or not a string. */
 const UserIdRequiredError = StructuredError(
 	'UserIdRequiredError',
 	'User ID is required and must be a non-empty string'
 );
 
+/**
+ * Thrown when the API returns a success HTTP status but the response body indicates failure.
+ */
 const TaskStorageResponseError = StructuredError('TaskStorageResponseError')<{
 	status: number;
 }>();
 
+/**
+ * Internal API success response envelope for task operations.
+ */
 interface TaskSuccessResponse<T> {
 	success: true;
 	data: T;
 }
 
+/**
+ * Internal API error response envelope for task operations.
+ */
 interface TaskErrorResponse {
 	success: false;
 	message: string;
 }
 
+/**
+ * Discriminated union of API success and error responses for task operations.
+ */
 type TaskResponse<T> = TaskSuccessResponse<T> | TaskErrorResponse;
 
+/**
+ * Client for the Agentuity Task management service.
+ *
+ * Provides a full-featured project management API including task CRUD, hierarchical
+ * organization (epics → features → tasks), comments, tags, file attachments via
+ * presigned S3 URLs, changelog tracking, and activity analytics.
+ *
+ * Tasks support lifecycle management through status transitions (`open` → `in_progress`
+ * → `done`/`closed`/`cancelled`) with automatic date tracking for each transition.
+ *
+ * All methods validate inputs client-side and throw structured errors for invalid
+ * parameters. API errors throw {@link ServiceException}.
+ *
+ * @example
+ * ```typescript
+ * const tasks = new TaskStorageService(baseUrl, adapter);
+ *
+ * // Create a task
+ * const task = await tasks.create({
+ *   title: 'Implement login flow',
+ *   type: 'feature',
+ *   created_id: 'user_123',
+ *   creator: { id: 'user_123', name: 'Alice' },
+ *   priority: 'high',
+ * });
+ *
+ * // Add a comment
+ * await tasks.createComment(task.id, 'Started working on this', 'user_123');
+ *
+ * // List open tasks
+ * const { tasks: openTasks } = await tasks.list({ status: 'open' });
+ * ```
+ */
 export class TaskStorageService implements TaskStorage {
 	#adapter: FetchAdapter;
 	#baseUrl: string;
 
+	/**
+	 * Creates a new TaskStorageService instance.
+	 *
+	 * @param baseUrl - The base URL of the task management API
+	 * @param adapter - The HTTP fetch adapter used for making API requests
+	 */
 	constructor(baseUrl: string, adapter: FetchAdapter) {
 		this.#adapter = adapter;
 		this.#baseUrl = baseUrl;
 	}
 
+	/**
+	 * Create a new task.
+	 *
+	 * @param params - The task creation parameters including title, type, and optional fields
+	 * @returns The newly created task
+	 * @throws {@link TaskTitleRequiredError} if the title is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const task = await tasks.create({
+	 *   title: 'Fix login bug',
+	 *   type: 'bug',
+	 *   created_id: 'user_123',
+	 *   priority: 'high',
+	 *   creator: { id: 'user_123', name: 'Alice' },
+	 *   project: { id: 'proj_456', name: 'Auth Service' },
+	 * });
+	 * console.log('Created:', task.id);
+	 * ```
+	 */
 	async create(params: CreateTaskParams): Promise<Task> {
 		if (!params?.title || typeof params.title !== 'string' || params.title.trim().length === 0) {
 			throw new TaskTitleRequiredError();
@@ -349,6 +1051,24 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('POST', url, res.response);
 	}
 
+	/**
+	 * Get a task by its ID.
+	 *
+	 * @param id - The unique task identifier
+	 * @returns The task if found, or `null` if the task does not exist
+	 * @throws {@link TaskIdRequiredError} if the ID is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const task = await tasks.get('task_abc123');
+	 * if (task) {
+	 *   console.log(task.title, task.status);
+	 * } else {
+	 *   console.log('Task not found');
+	 * }
+	 * ```
+	 */
 	async get(id: string): Promise<Task | null> {
 		if (!id || typeof id !== 'string' || id.trim().length === 0) {
 			throw new TaskIdRequiredError();
@@ -383,6 +1103,26 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('GET', url, res.response);
 	}
 
+	/**
+	 * List tasks with optional filtering and pagination.
+	 *
+	 * @param params - Optional filter and pagination parameters
+	 * @returns Paginated list of tasks matching the filters
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * // List all open high-priority bugs
+	 * const result = await tasks.list({
+	 *   status: 'open',
+	 *   type: 'bug',
+	 *   priority: 'high',
+	 *   sort: '-created_at',
+	 *   limit: 20,
+	 * });
+	 * console.log(`Found ${result.total} bugs, showing ${result.tasks.length}`);
+	 * ```
+	 */
 	async list(params?: ListTasksParams): Promise<ListTasksResult> {
 		const queryParams = new URLSearchParams();
 		if (params?.status) queryParams.set('status', params.status);
@@ -431,6 +1171,26 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('GET', url, res.response);
 	}
 
+	/**
+	 * Partially update an existing task.
+	 *
+	 * @param id - The unique task identifier
+	 * @param params - Fields to update; only provided fields are changed
+	 * @returns The updated task
+	 * @throws {@link TaskIdRequiredError} if the ID is empty or not a string
+	 * @throws {@link TaskTitleRequiredError} if a title is provided but is empty
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const updated = await tasks.update('task_abc123', {
+	 *   status: 'in_progress',
+	 *   priority: 'high',
+	 *   assignee: { id: 'user_456', name: 'Bob' },
+	 * });
+	 * console.log('Updated status:', updated.status);
+	 * ```
+	 */
 	async update(id: string, params: UpdateTaskParams): Promise<Task> {
 		if (!id || typeof id !== 'string' || id.trim().length === 0) {
 			throw new TaskIdRequiredError();
@@ -469,6 +1229,20 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('PATCH', url, res.response);
 	}
 
+	/**
+	 * Close a task by setting its status to closed.
+	 *
+	 * @param id - The unique task identifier
+	 * @returns The closed task with updated `closed_date`
+	 * @throws {@link TaskIdRequiredError} if the ID is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const closed = await tasks.close('task_abc123');
+	 * console.log('Closed at:', closed.closed_date);
+	 * ```
+	 */
 	async close(id: string): Promise<Task> {
 		if (!id || typeof id !== 'string' || id.trim().length === 0) {
 			throw new TaskIdRequiredError();
@@ -499,6 +1273,26 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('DELETE', url, res.response);
 	}
 
+	/**
+	 * Get the changelog (audit trail) for a task, showing all field changes over time.
+	 *
+	 * @param id - The unique task identifier
+	 * @param params - Optional pagination parameters
+	 * @returns Paginated list of changelog entries ordered by most recent first
+	 * @throws {@link TaskIdRequiredError} if the ID is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const { changelog, total } = await tasks.changelog('task_abc123', {
+	 *   limit: 10,
+	 *   offset: 0,
+	 * });
+	 * for (const entry of changelog) {
+	 *   console.log(`${entry.field}: ${entry.old_value} → ${entry.new_value}`);
+	 * }
+	 * ```
+	 */
 	async changelog(
 		id: string,
 		params?: { limit?: number; offset?: number }
@@ -542,6 +1336,20 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('GET', url, res.response);
 	}
 
+	/**
+	 * Soft-delete a task, marking it as deleted without permanent removal.
+	 *
+	 * @param id - The unique task identifier
+	 * @returns The soft-deleted task
+	 * @throws {@link TaskIdRequiredError} if the ID is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const deleted = await tasks.softDelete('task_abc123');
+	 * console.log('Soft-deleted task:', deleted.id);
+	 * ```
+	 */
 	async softDelete(id: string): Promise<Task> {
 		if (!id || typeof id !== 'string' || id.trim().length === 0) {
 			throw new TaskIdRequiredError();
@@ -575,6 +1383,30 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('POST', url, res.response);
 	}
 
+	/**
+	 * Create a comment on a task.
+	 *
+	 * @param taskId - The ID of the task to comment on
+	 * @param body - The comment text content (must be non-empty)
+	 * @param userId - The ID of the user authoring the comment
+	 * @param author - Optional entity reference with the author's display name
+	 * @returns The newly created comment
+	 * @throws {@link TaskIdRequiredError} if the task ID is empty or not a string
+	 * @throws {@link CommentBodyRequiredError} if the body is empty or not a string
+	 * @throws {@link UserIdRequiredError} if the user ID is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const comment = await tasks.createComment(
+	 *   'task_abc123',
+	 *   'This is ready for review.',
+	 *   'user_456',
+	 *   { id: 'user_456', name: 'Bob' },
+	 * );
+	 * console.log('Comment created:', comment.id);
+	 * ```
+	 */
 	async createComment(
 		taskId: string,
 		body: string,
@@ -624,6 +1456,20 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('POST', url, res.response);
 	}
 
+	/**
+	 * Get a comment by its ID.
+	 *
+	 * @param commentId - The unique comment identifier
+	 * @returns The comment
+	 * @throws {@link CommentIdRequiredError} if the comment ID is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const comment = await tasks.getComment('comment_xyz789');
+	 * console.log(`${comment.author?.name}: ${comment.body}`);
+	 * ```
+	 */
 	async getComment(commentId: string): Promise<Comment> {
 		if (!commentId || typeof commentId !== 'string' || commentId.trim().length === 0) {
 			throw new CommentIdRequiredError();
@@ -657,6 +1503,25 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('GET', url, res.response);
 	}
 
+	/**
+	 * Update a comment's body text.
+	 *
+	 * @param commentId - The unique comment identifier
+	 * @param body - The new comment text (must be non-empty)
+	 * @returns The updated comment
+	 * @throws {@link CommentIdRequiredError} if the comment ID is empty or not a string
+	 * @throws {@link CommentBodyRequiredError} if the body is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const updated = await tasks.updateComment(
+	 *   'comment_xyz789',
+	 *   'Updated: This is now ready for final review.',
+	 * );
+	 * console.log('Updated at:', updated.updated_at);
+	 * ```
+	 */
 	async updateComment(commentId: string, body: string): Promise<Comment> {
 		if (!commentId || typeof commentId !== 'string' || commentId.trim().length === 0) {
 			throw new CommentIdRequiredError();
@@ -695,6 +1560,19 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('PATCH', url, res.response);
 	}
 
+	/**
+	 * Delete a comment permanently.
+	 *
+	 * @param commentId - The unique comment identifier
+	 * @throws {@link CommentIdRequiredError} if the comment ID is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * await tasks.deleteComment('comment_xyz789');
+	 * console.log('Comment deleted');
+	 * ```
+	 */
 	async deleteComment(commentId: string): Promise<void> {
 		if (!commentId || typeof commentId !== 'string' || commentId.trim().length === 0) {
 			throw new CommentIdRequiredError();
@@ -728,6 +1606,26 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('DELETE', url, res.response);
 	}
 
+	/**
+	 * List comments on a task with optional pagination.
+	 *
+	 * @param taskId - The ID of the task whose comments to list
+	 * @param params - Optional pagination parameters
+	 * @returns Paginated list of comments
+	 * @throws {@link TaskIdRequiredError} if the task ID is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const { comments, total } = await tasks.listComments('task_abc123', {
+	 *   limit: 25,
+	 *   offset: 0,
+	 * });
+	 * for (const c of comments) {
+	 *   console.log(`${c.author?.name}: ${c.body}`);
+	 * }
+	 * ```
+	 */
 	async listComments(
 		taskId: string,
 		params?: { limit?: number; offset?: number }
@@ -771,6 +1669,21 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('GET', url, res.response);
 	}
 
+	/**
+	 * Create a new tag for categorizing tasks.
+	 *
+	 * @param name - The tag display name (must be non-empty)
+	 * @param color - Optional hex color code (e.g., `'#ff0000'`)
+	 * @returns The newly created tag
+	 * @throws {@link TagNameRequiredError} if the name is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const tag = await tasks.createTag('urgent', '#ff0000');
+	 * console.log('Created tag:', tag.id, tag.name);
+	 * ```
+	 */
 	async createTag(name: string, color?: string): Promise<Tag> {
 		if (!name || typeof name !== 'string' || name.trim().length === 0) {
 			throw new TagNameRequiredError();
@@ -806,6 +1719,20 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('POST', url, res.response);
 	}
 
+	/**
+	 * Get a tag by its ID.
+	 *
+	 * @param tagId - The unique tag identifier
+	 * @returns The tag
+	 * @throws {@link TagIdRequiredError} if the tag ID is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const tag = await tasks.getTag('tag_def456');
+	 * console.log(`${tag.name} (${tag.color})`);
+	 * ```
+	 */
 	async getTag(tagId: string): Promise<Tag> {
 		if (!tagId || typeof tagId !== 'string' || tagId.trim().length === 0) {
 			throw new TagIdRequiredError();
@@ -839,6 +1766,23 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('GET', url, res.response);
 	}
 
+	/**
+	 * Update a tag's name and optionally its color.
+	 *
+	 * @param tagId - The unique tag identifier
+	 * @param name - The new tag name (must be non-empty)
+	 * @param color - Optional new hex color code
+	 * @returns The updated tag
+	 * @throws {@link TagIdRequiredError} if the tag ID is empty or not a string
+	 * @throws {@link TagNameRequiredError} if the name is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const updated = await tasks.updateTag('tag_def456', 'critical', '#cc0000');
+	 * console.log('Updated:', updated.name);
+	 * ```
+	 */
 	async updateTag(tagId: string, name: string, color?: string): Promise<Tag> {
 		if (!tagId || typeof tagId !== 'string' || tagId.trim().length === 0) {
 			throw new TagIdRequiredError();
@@ -880,6 +1824,19 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('PATCH', url, res.response);
 	}
 
+	/**
+	 * Delete a tag permanently.
+	 *
+	 * @param tagId - The unique tag identifier
+	 * @throws {@link TagIdRequiredError} if the tag ID is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * await tasks.deleteTag('tag_def456');
+	 * console.log('Tag deleted');
+	 * ```
+	 */
 	async deleteTag(tagId: string): Promise<void> {
 		if (!tagId || typeof tagId !== 'string' || tagId.trim().length === 0) {
 			throw new TagIdRequiredError();
@@ -913,6 +1870,20 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('DELETE', url, res.response);
 	}
 
+	/**
+	 * List all tags in the organization.
+	 *
+	 * @returns List of all tags
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const { tags } = await tasks.listTags();
+	 * for (const tag of tags) {
+	 *   console.log(`${tag.name} (${tag.color ?? 'no color'})`);
+	 * }
+	 * ```
+	 */
 	async listTags(): Promise<ListTagsResult> {
 		const url = buildUrl(this.#baseUrl, `/task/tags/list/${TASK_API_VERSION}`);
 		const signal = AbortSignal.timeout(30_000);
@@ -939,6 +1910,21 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('GET', url, res.response);
 	}
 
+	/**
+	 * Associate a tag with a task.
+	 *
+	 * @param taskId - The ID of the task
+	 * @param tagId - The ID of the tag to add
+	 * @throws {@link TaskIdRequiredError} if the task ID is empty or not a string
+	 * @throws {@link TagIdRequiredError} if the tag ID is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * await tasks.addTagToTask('task_abc123', 'tag_def456');
+	 * console.log('Tag added to task');
+	 * ```
+	 */
 	async addTagToTask(taskId: string, tagId: string): Promise<void> {
 		if (!taskId || typeof taskId !== 'string' || taskId.trim().length === 0) {
 			throw new TaskIdRequiredError();
@@ -975,6 +1961,21 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('POST', url, res.response);
 	}
 
+	/**
+	 * Remove a tag association from a task.
+	 *
+	 * @param taskId - The ID of the task
+	 * @param tagId - The ID of the tag to remove
+	 * @throws {@link TaskIdRequiredError} if the task ID is empty or not a string
+	 * @throws {@link TagIdRequiredError} if the tag ID is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * await tasks.removeTagFromTask('task_abc123', 'tag_def456');
+	 * console.log('Tag removed from task');
+	 * ```
+	 */
 	async removeTagFromTask(taskId: string, tagId: string): Promise<void> {
 		if (!taskId || typeof taskId !== 'string' || taskId.trim().length === 0) {
 			throw new TaskIdRequiredError();
@@ -1011,6 +2012,20 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('DELETE', url, res.response);
 	}
 
+	/**
+	 * List all tags associated with a specific task.
+	 *
+	 * @param taskId - The ID of the task
+	 * @returns Array of tags on the task
+	 * @throws {@link TaskIdRequiredError} if the task ID is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const tags = await tasks.listTagsForTask('task_abc123');
+	 * console.log('Tags:', tags.map((t) => t.name).join(', '));
+	 * ```
+	 */
 	async listTagsForTask(taskId: string): Promise<Tag[]> {
 		if (!taskId || typeof taskId !== 'string' || taskId.trim().length === 0) {
 			throw new TaskIdRequiredError();
@@ -1044,8 +2059,33 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('GET', url, res.response);
 	}
 
-	// Attachment methods
-
+	/**
+	 * Initiate a file upload to a task. Returns a presigned S3 URL for direct upload.
+	 *
+	 * @remarks
+	 * After receiving the presigned URL, upload the file content via HTTP PUT to that URL.
+	 * Then call {@link TaskStorageService.confirmAttachment | confirmAttachment} to finalize.
+	 *
+	 * @param taskId - The ID of the task to attach the file to
+	 * @param params - Attachment metadata including filename, content type, and size
+	 * @returns The created attachment record and a presigned upload URL
+	 * @throws {@link TaskIdRequiredError} if the task ID is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const { attachment, presigned_url } = await tasks.uploadAttachment(
+	 *   'task_abc123',
+	 *   { filename: 'report.pdf', content_type: 'application/pdf', size: 102400 },
+	 * );
+	 *
+	 * // Upload the file to S3
+	 * await fetch(presigned_url, { method: 'PUT', body: fileContent });
+	 *
+	 * // Confirm the upload
+	 * await tasks.confirmAttachment(attachment.id);
+	 * ```
+	 */
 	async uploadAttachment(
 		taskId: string,
 		params: CreateAttachmentParams
@@ -1084,6 +2124,24 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('POST', url, res.response);
 	}
 
+	/**
+	 * Confirm that a file upload has completed successfully.
+	 *
+	 * @remarks
+	 * Call this after successfully uploading the file to the presigned URL
+	 * returned by {@link TaskStorageService.uploadAttachment | uploadAttachment}.
+	 *
+	 * @param attachmentId - The unique attachment identifier
+	 * @returns The confirmed attachment record
+	 * @throws {@link AttachmentIdRequiredError} if the attachment ID is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const confirmed = await tasks.confirmAttachment('att_ghi789');
+	 * console.log('Confirmed:', confirmed.filename);
+	 * ```
+	 */
 	async confirmAttachment(attachmentId: string): Promise<Attachment> {
 		if (!attachmentId || typeof attachmentId !== 'string' || attachmentId.trim().length === 0) {
 			throw new AttachmentIdRequiredError();
@@ -1117,6 +2175,20 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('POST', url, res.response);
 	}
 
+	/**
+	 * Get a presigned S3 URL for downloading an attachment.
+	 *
+	 * @param attachmentId - The unique attachment identifier
+	 * @returns A presigned download URL with expiry information
+	 * @throws {@link AttachmentIdRequiredError} if the attachment ID is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const { presigned_url, expiry_seconds } = await tasks.downloadAttachment('att_ghi789');
+	 * console.log(`Download URL (expires in ${expiry_seconds}s):`, presigned_url);
+	 * ```
+	 */
 	async downloadAttachment(attachmentId: string): Promise<PresignDownloadResponse> {
 		if (!attachmentId || typeof attachmentId !== 'string' || attachmentId.trim().length === 0) {
 			throw new AttachmentIdRequiredError();
@@ -1150,6 +2222,22 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('POST', url, res.response);
 	}
 
+	/**
+	 * List all attachments on a task.
+	 *
+	 * @param taskId - The ID of the task
+	 * @returns List of attachments with total count
+	 * @throws {@link TaskIdRequiredError} if the task ID is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const { attachments, total } = await tasks.listAttachments('task_abc123');
+	 * for (const att of attachments) {
+	 *   console.log(`${att.filename} (${att.content_type}, ${att.size} bytes)`);
+	 * }
+	 * ```
+	 */
 	async listAttachments(taskId: string): Promise<ListAttachmentsResult> {
 		if (!taskId || typeof taskId !== 'string' || taskId.trim().length === 0) {
 			throw new TaskIdRequiredError();
@@ -1183,6 +2271,19 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('GET', url, res.response);
 	}
 
+	/**
+	 * Delete an attachment permanently.
+	 *
+	 * @param attachmentId - The unique attachment identifier
+	 * @throws {@link AttachmentIdRequiredError} if the attachment ID is empty or not a string
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * await tasks.deleteAttachment('att_ghi789');
+	 * console.log('Attachment deleted');
+	 * ```
+	 */
 	async deleteAttachment(attachmentId: string): Promise<void> {
 		if (!attachmentId || typeof attachmentId !== 'string' || attachmentId.trim().length === 0) {
 			throw new AttachmentIdRequiredError();
@@ -1216,6 +2317,20 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('DELETE', url, res.response);
 	}
 
+	/**
+	 * List all users who have been referenced in tasks (as creators, assignees, or closers).
+	 *
+	 * @returns List of user entity references
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const { users } = await tasks.listUsers();
+	 * for (const user of users) {
+	 *   console.log(`${user.name} (${user.id})`);
+	 * }
+	 * ```
+	 */
 	async listUsers(): Promise<ListUsersResult> {
 		const url = buildUrl(this.#baseUrl, `/task/users/${TASK_API_VERSION}`);
 		const signal = AbortSignal.timeout(30_000);
@@ -1242,6 +2357,20 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('GET', url, res.response);
 	}
 
+	/**
+	 * List all projects that have been referenced in tasks.
+	 *
+	 * @returns List of project entity references
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const { projects } = await tasks.listProjects();
+	 * for (const project of projects) {
+	 *   console.log(`${project.name} (${project.id})`);
+	 * }
+	 * ```
+	 */
 	async listProjects(): Promise<ListProjectsResult> {
 		const url = buildUrl(this.#baseUrl, `/task/projects/${TASK_API_VERSION}`);
 		const signal = AbortSignal.timeout(30_000);
@@ -1268,6 +2397,22 @@ export class TaskStorageService implements TaskStorage {
 		throw await toServiceException('GET', url, res.response);
 	}
 
+	/**
+	 * Get task activity time-series data showing daily task counts by status.
+	 *
+	 * @param params - Optional parameters controlling the number of days to retrieve
+	 * @returns Time-series activity data with daily snapshots
+	 * @throws {@link ServiceException} if the API request fails
+	 *
+	 * @example
+	 * ```typescript
+	 * const { activity, days } = await tasks.getActivity({ days: 30 });
+	 * console.log(`Activity over ${days} days:`);
+	 * for (const point of activity) {
+	 *   console.log(`${point.date}: ${point.open} open, ${point.inProgress} in progress`);
+	 * }
+	 * ```
+	 */
 	async getActivity(params?: TaskActivityParams): Promise<TaskActivityResult> {
 		const queryParams = new URLSearchParams();
 		if (params?.days !== undefined) queryParams.set('days', String(params.days));