@burdenoff/planmagnet-fe-sdk 2026.705.1 → 2026.706.1

package/dist/index.d.ts

@@ -817,6 +817,14 @@ interface TaskDetailCoreProps {
         id: string;
         projectId: string;
     }) => void;
+    /**
+     * When set, renders a Comments thread backed by the shared
+     * wspace-conversations-svc `EntityComment`, namespaced under this entity type
+     * (e.g. "planmagnet_workitem"). Opt-in so the SDK stays generic.
+     */
+    commentsEntityType?: string;
+    /** The current actor — enables "My tasks", comment authorship + own-comment delete. */
+    currentActorId?: string;
     /** Extra classes on the root container. */
     className?: string;
 }
@@ -825,7 +833,7 @@ interface TaskDetailCoreProps {
  * edit. Fetches via `planmagnetWorkItem(id)`, saves via
  * `planmagnetUpdateWorkItem`. BYO-Apollo, semantic-token only, farm-free.
  */
-declare function TaskDetailCore({ id, readonly, hiddenFields, hideHeader, onUpdated, onDeleted, onError, resolveAssignee, assigneeOptions, linkSourceProduct, renderLinkIcon, onOpenItem, onAddSubtask, className, }: TaskDetailCoreProps): react.JSX.Element;
+declare function TaskDetailCore({ id, readonly, hiddenFields, hideHeader, onUpdated, onDeleted, onError, resolveAssignee, assigneeOptions, linkSourceProduct, renderLinkIcon, onOpenItem, onAddSubtask, commentsEntityType, currentActorId, className, }: TaskDetailCoreProps): react.JSX.Element;
 
 interface TaskDetailProps extends TaskDetailCoreProps {
     /** Workspace API gateway URL (URL mode). */
@@ -866,6 +874,33 @@ interface TaskDetailProps extends TaskDetailCoreProps {
  */
 declare function TaskDetail({ apiGatewayUrl, authToken, workspaceToken, workspaceId, tenantId, organizationId, trustedOrigins, onAuthError, workspaceClient, ...coreProps }: TaskDetailProps): react.JSX.Element;
 
+interface TaskCommentsCoreProps {
+    /** Comment namespace for this entity family (e.g. "planmagnet_workitem"). */
+    entityType: string;
+    /** The work item id these comments belong to. */
+    entityId: string;
+    /** The current actor — enables "You" + delete on own comments. */
+    currentActorId?: string;
+    /** Resolve an author/mention id → display name (reuse the member directory). */
+    resolveAssignee?: ResolveAssignee;
+    /** Member directory for @-mention autocomplete. Omit to disable mentions. */
+    members?: AssigneeOption[];
+    /** Hide the composer + delete affordances (pure read-only). */
+    readonly?: boolean;
+    /** Extra classes on the root container. */
+    className?: string;
+}
+/**
+ * TaskCommentsCore — a threaded comment thread on a work item, backed by the
+ * SHARED wspace-conversations-svc `EntityComment` (the platform's canonical
+ * comment owner) rather than a per-product comment table. Supports 1-level
+ * replies (grouped by thread root) and @-mentions. BYO-Apollo, semantic-token
+ * only, farm-free. RBAC is enforced server-side (create/read are editor-level,
+ * a workspace Member gets editor on `entity-comment`); the composer fails open
+ * and surfaces a graceful error if the server denies it.
+ */
+declare function TaskCommentsCore({ entityType, entityId, currentActorId, resolveAssignee, members, readonly, className, }: TaskCommentsCoreProps): react.JSX.Element;
+
 /**
  * TaskLabels — every user-facing string the SDK renders, so a host (e.g.
  * HealthyBowl, which ships 6 languages) can inject translations. English
@@ -928,6 +963,18 @@ interface TaskLabels {
     parentLabel: string;
     subtasksLabel: string;
     addSubtask: string;
+    commentsLabel: string;
+    commentPlaceholder: string;
+    postComment: string;
+    posting: string;
+    noComments: string;
+    you: string;
+    editedTag: string;
+    failedToComment: string;
+    failedToDeleteComment: string;
+    reply: string;
+    replyPlaceholder: string;
+    repliesCount: string;
     create: string;
     creating: string;
     cancel: string;
@@ -1026,6 +1073,12 @@ interface TasksPageCoreProps {
      * toggle that filters every view to items assigned to this actor.
      */
     currentActorId?: string;
+    /**
+     * When set, each task's detail shows a Comments thread backed by the shared
+     * wspace-conversations-svc `EntityComment`, namespaced under this entity type
+     * (e.g. "planmagnet_workitem"). Omit to hide comments.
+     */
+    commentsEntityType?: string;
     /** Host-provided translations for every UI string (English defaults otherwise). */
     labels?: PartialTaskLabels;
     /**
@@ -1058,7 +1111,7 @@ interface TasksPageCoreProps {
  * BYO-Apollo: reads the ambient `<ApolloProvider>` and takes `workspaceId` from
  * a prop or the PlanMagnetProvider context. Semantic tokens only, farm-free.
  */
-declare function TasksPageCore({ workspaceId: workspaceIdProp, projectId, boardProjectId, columns, readonly, hiddenFields, views, defaultView, confirmMove, resolveAssignee, linkSourceProduct, renderLinkIcon, assigneeOptions, currentActorId, labels, openItemId, header, onTaskSaved, createSurface, detailSurface, className, }: TasksPageCoreProps): react.JSX.Element;
+declare function TasksPageCore({ workspaceId: workspaceIdProp, projectId, boardProjectId, columns, readonly, hiddenFields, views, defaultView, confirmMove, resolveAssignee, linkSourceProduct, renderLinkIcon, assigneeOptions, currentActorId, commentsEntityType, labels, openItemId, header, onTaskSaved, createSurface, detailSurface, className, }: TasksPageCoreProps): react.JSX.Element;
 
 interface TasksPageProps extends TasksPageCoreProps {
     /** Workspace API gateway URL (URL mode). */
@@ -1343,4 +1396,4 @@ declare function getGraphQLEndpoint(baseUrl?: string): string;
 
 declare function cn(...inputs: ClassValue[]): string;
 
-export { type AssigneeOption, Avatar, type AvatarProps, Badge, type BadgeProps, type BoardColumn, CREATE_WORK_ITEM, CREATE_WORK_ITEM_LINK, CreateTask, CreateTaskCore, type CreateTaskCoreProps, type CreateTaskField, type CreateTaskInput, type CreateTaskProps, type CreateWorkItemLinkInput, DEFAULT_BOARD_COLUMNS, DEFAULT_TASK_LABELS, DELETE_WORK_ITEM, DELETE_WORK_ITEM_LINK, Drawer, type DrawerProps, GET_PROJECTS, GET_WORK_ITEM, LIST_MILESTONES, LIST_WORK_ITEMS, LIST_WORK_ITEM_LINKS, LinkChip, type LinkChipProps, type ListMilestonesInput, type ListTasksInput, type ListWorkItemLinksInput, MILESTONE_FIELDS, MOVE_WORK_ITEM, type Milestone, type MilestoneList, type MilestoneStatus, Modal, type ModalProps, PRIORITY_META, PROJECT_SUMMARY_FIELDS, type PartialTaskLabels, type PlanMagnetClientConfig, type PlanMagnetConfig, PlanMagnetProvider, type PlanMagnetProviderProps, PriorityIndicator, type PriorityIndicatorProps, type Project, type ProjectList, type RenderLinkIcon, type ResolveAssignee, STATUS_META, StatusIcon, type StatusIconProps, StatusPill, type StatusPillProps, TASK_PRIORITIES, TASK_STATUSES, TASK_TYPES, type Task, TaskBoard, TaskBoardCore, type TaskBoardCoreProps, type TaskBoardProps, TaskCard, type TaskCardProps, TaskDetail, TaskDetailCore, type TaskDetailCoreProps, type TaskDetailField, type TaskDetailProps, type TaskLabels, TaskLabelsProvider, TaskList, type TaskListColumn, TaskListCore, type TaskListCoreProps, type TaskListProps, type TaskListSort, type TaskPageInfo, type TaskPaginationInput, type TaskPriority, type TaskSavedResult, type TaskStatus, TaskTimelineCore, type TaskTimelineCoreProps, TaskToolbar, type TaskToolbarProps, type TaskType, type TaskView, TasksPage, TasksPageCore, type TasksPageCoreProps, type TasksPageField, type TasksPageProps, type TasksPageSaved, TypeBadge, type TypeBadgeProps, UPDATE_WORK_ITEM, type UpdateTaskInput, type UseMilestonesResult, type UseWorkItemLinksResult, WORK_ITEM_FIELDS, WORK_ITEM_LINK_FIELDS, WORK_ITEM_SUMMARY_FIELDS, type WorkItemDetail, type WorkItemLink, type WorkItemLinkList, type WorkItemLinkRelation, type WorkItemList, badgeVariants, cn, config, createPlanMagnetClient, enumLabel, getGraphQLEndpoint, getPlanMagnetClient, getPlanMagnetClientSafe, getPlanMagnetConfig, isPlanMagnetClientReady, mergeTaskLabels, resetPlanMagnetClient, resetPlanMagnetConfig, setPlanMagnetClient, setPlanMagnetConfig, useMilestones, usePlanMagnetContext, usePlanMagnetContextSafe, useTaskLabels, useWorkItemLinks, validateTrustedOrigin, waitForPlanMagnetClient };
+export { type AssigneeOption, Avatar, type AvatarProps, Badge, type BadgeProps, type BoardColumn, CREATE_WORK_ITEM, CREATE_WORK_ITEM_LINK, CreateTask, CreateTaskCore, type CreateTaskCoreProps, type CreateTaskField, type CreateTaskInput, type CreateTaskProps, type CreateWorkItemLinkInput, DEFAULT_BOARD_COLUMNS, DEFAULT_TASK_LABELS, DELETE_WORK_ITEM, DELETE_WORK_ITEM_LINK, Drawer, type DrawerProps, GET_PROJECTS, GET_WORK_ITEM, LIST_MILESTONES, LIST_WORK_ITEMS, LIST_WORK_ITEM_LINKS, LinkChip, type LinkChipProps, type ListMilestonesInput, type ListTasksInput, type ListWorkItemLinksInput, MILESTONE_FIELDS, MOVE_WORK_ITEM, type Milestone, type MilestoneList, type MilestoneStatus, Modal, type ModalProps, PRIORITY_META, PROJECT_SUMMARY_FIELDS, type PartialTaskLabels, type PlanMagnetClientConfig, type PlanMagnetConfig, PlanMagnetProvider, type PlanMagnetProviderProps, PriorityIndicator, type PriorityIndicatorProps, type Project, type ProjectList, type RenderLinkIcon, type ResolveAssignee, STATUS_META, StatusIcon, type StatusIconProps, StatusPill, type StatusPillProps, TASK_PRIORITIES, TASK_STATUSES, TASK_TYPES, type Task, TaskBoard, TaskBoardCore, type TaskBoardCoreProps, type TaskBoardProps, TaskCard, type TaskCardProps, TaskCommentsCore, type TaskCommentsCoreProps, TaskDetail, TaskDetailCore, type TaskDetailCoreProps, type TaskDetailField, type TaskDetailProps, type TaskLabels, TaskLabelsProvider, TaskList, type TaskListColumn, TaskListCore, type TaskListCoreProps, type TaskListProps, type TaskListSort, type TaskPageInfo, type TaskPaginationInput, type TaskPriority, type TaskSavedResult, type TaskStatus, TaskTimelineCore, type TaskTimelineCoreProps, TaskToolbar, type TaskToolbarProps, type TaskType, type TaskView, TasksPage, TasksPageCore, type TasksPageCoreProps, type TasksPageField, type TasksPageProps, type TasksPageSaved, TypeBadge, type TypeBadgeProps, UPDATE_WORK_ITEM, type UpdateTaskInput, type UseMilestonesResult, type UseWorkItemLinksResult, WORK_ITEM_FIELDS, WORK_ITEM_LINK_FIELDS, WORK_ITEM_SUMMARY_FIELDS, type WorkItemDetail, type WorkItemLink, type WorkItemLinkList, type WorkItemLinkRelation, type WorkItemList, badgeVariants, cn, config, createPlanMagnetClient, enumLabel, getGraphQLEndpoint, getPlanMagnetClient, getPlanMagnetClientSafe, getPlanMagnetConfig, isPlanMagnetClientReady, mergeTaskLabels, resetPlanMagnetClient, resetPlanMagnetConfig, setPlanMagnetClient, setPlanMagnetConfig, useMilestones, usePlanMagnetContext, usePlanMagnetContextSafe, useTaskLabels, useWorkItemLinks, validateTrustedOrigin, waitForPlanMagnetClient };