@burdenoff/planmagnet-fe-sdk 2026.703.3 → 2026.704.2

package/dist/index.d.ts

@@ -233,6 +233,37 @@ interface WorkItemLinkList {
     pageInfo: TaskPageInfo;
     totalCount: number;
 }
+/** Milestone status (MilestoneStatus). */
+type MilestoneStatus = "PENDING" | "IN_PROGRESS" | "COMPLETED" | "MISSED" | "CANCELLED";
+/**
+ * A project milestone (e.g. a harvest window). Rendered as a flag on the
+ * Timeline. `sortOrder`/`tagsV2` are intentionally omitted (see LIST_MILESTONES).
+ */
+interface Milestone {
+    id: string;
+    projectId: string;
+    name: string;
+    description?: string | null;
+    status: MilestoneStatus;
+    dueDate?: string | null;
+    completedAt?: string | null;
+    ownerId?: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Filter for `planmagnetMilestones` (PlanmagnetMilestoneFilter). */
+interface ListMilestonesInput {
+    ownerId?: string;
+    projectId?: string;
+    search?: string;
+    status?: MilestoneStatus;
+}
+/** Shape returned by LIST_MILESTONES (PlanmagnetMilestoneList). */
+interface MilestoneList {
+    items: Milestone[];
+    pageInfo: TaskPageInfo;
+    totalCount: number;
+}
 /** Board column definition. */
 interface BoardColumn {
     status: TaskStatus;
@@ -364,6 +395,11 @@ declare function Drawer(props: DrawerProps): react.JSX.Element;
 type ResolveAssignee = (assigneeId: string) => {
     name?: string | null;
 } | null | undefined;
+/** A selectable assignee for the create/edit picker (host-provided directory). */
+interface AssigneeOption {
+    id: string;
+    name: string;
+}
 interface TaskCardProps {
     task: Task;
     /** Field names to hide (key/type/priority/labels/storyPoints/assignee/dueDate). */
@@ -509,6 +545,8 @@ interface CreateTaskCoreProps {
      * until a project id is present.
      */
     projectId?: string;
+    /** Optional host-provided member directory → renders an assignee picker. */
+    assigneeOptions?: AssigneeOption[];
     /** Field names to hide on the form. */
     hiddenFields?: CreateTaskField[];
     /** Default values applied on first render. */
@@ -536,7 +574,7 @@ interface CreateTaskCoreProps {
  * Mirrors the TaskBoardCore contract: `workspaceId` from a prop or the
  * PlanMagnetProvider context, `hiddenFields` for host-driven field suppression.
  */
-declare function CreateTaskCore({ projectId: projectIdProp, hiddenFields, defaultValues, hideHeader, submitLabel, onCreated, onError, onCancel, className, workspaceId: workspaceIdProp, }: CreateTaskCoreProps): react.JSX.Element;
+declare function CreateTaskCore({ projectId: projectIdProp, assigneeOptions, hiddenFields, defaultValues, hideHeader, submitLabel, onCreated, onError, onCancel, className, workspaceId: workspaceIdProp, }: CreateTaskCoreProps): react.JSX.Element;
 
 interface CreateTaskProps extends CreateTaskCoreProps {
     /** Workspace API gateway URL (URL mode). */
@@ -693,6 +731,8 @@ interface TaskTimelineCoreProps {
     onSelect?: (id: string) => void;
     /** Optional host hook to resolve an assignee id → display name. */
     resolveAssignee?: ResolveAssignee;
+    /** Fetch + flag project milestones on the timeline (default true). */
+    showMilestones?: boolean;
     className?: string;
     workspaceId?: string;
 }
@@ -705,7 +745,7 @@ interface TaskTimelineCoreProps {
  * honest to the data. Overdue and undated work is surfaced explicitly so nothing
  * hides. BYO-Apollo, semantic-token only, farm-free.
  */
-declare function TaskTimelineCore({ projectId, priority, type, search, assigneeId, defaultMode, onSelect, resolveAssignee, className, workspaceId: workspaceIdProp, }: TaskTimelineCoreProps): react.JSX.Element;
+declare function TaskTimelineCore({ projectId, priority, type, search, assigneeId, defaultMode, onSelect, resolveAssignee, showMilestones, className, workspaceId: workspaceIdProp, }: TaskTimelineCoreProps): react.JSX.Element;
 
 /** The three task views the toolbar can switch between. */
 type TaskView = "board" | "list" | "timeline";
@@ -722,6 +762,9 @@ interface TaskToolbarProps {
     onTypeChange: (type: TaskType | "ALL") => void;
     onNewTask?: () => void;
     canCreate?: boolean;
+    /** "My tasks" toggle — only rendered when `onMineChange` is provided. */
+    mine?: boolean;
+    onMineChange?: (mine: boolean) => void;
     className?: string;
 }
 /**
@@ -729,7 +772,7 @@ interface TaskToolbarProps {
  * view tabs (Board / List / Timeline) + search + priority/type filters + a
  * "New task" action. Fully controlled; semantic-token only.
  */
-declare function TaskToolbar({ view, onViewChange, views, search, onSearchChange, priority, onPriorityChange, type, onTypeChange, onNewTask, canCreate, className, }: TaskToolbarProps): react.JSX.Element;
+declare function TaskToolbar({ view, onViewChange, views, search, onSearchChange, priority, onPriorityChange, type, onTypeChange, onNewTask, canCreate, mine, onMineChange, className, }: TaskToolbarProps): react.JSX.Element;
 
 /** Fields that can be hidden / suppressed on the detail view + edit form. */
 type TaskDetailField = "description" | "type" | "status" | "priority" | "assignee" | "dueDate" | "labels" | "storyPoints";
@@ -744,8 +787,14 @@ interface TaskDetailCoreProps {
     hideHeader?: boolean;
     /** Called with the updated work item after a successful save. */
     onUpdated?: (workItem: WorkItemDetail) => void;
-    /** Called when the update mutation errors. */
+    /** Called after a successful delete (with the deleted id). Enables the Delete button. */
+    onDeleted?: (id: string) => void;
+    /** Called when a mutation errors. */
     onError?: (error: Error) => void;
+    /** Optional host hook to resolve an assignee id → display name. */
+    resolveAssignee?: ResolveAssignee;
+    /** Optional host-provided member directory → renders a picker instead of a raw id field. */
+    assigneeOptions?: AssigneeOption[];
     /** Extra classes on the root container. */
     className?: string;
 }
@@ -754,7 +803,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, onError, className, }: TaskDetailCoreProps): react.JSX.Element;
+declare function TaskDetailCore({ id, readonly, hiddenFields, hideHeader, onUpdated, onDeleted, onError, resolveAssignee, assigneeOptions, className, }: TaskDetailCoreProps): react.JSX.Element;
 
 interface TaskDetailProps extends TaskDetailCoreProps {
     /** Workspace API gateway URL (URL mode). */
@@ -795,6 +844,96 @@ interface TaskDetailProps extends TaskDetailCoreProps {
  */
 declare function TaskDetail({ apiGatewayUrl, authToken, workspaceToken, workspaceId, tenantId, organizationId, trustedOrigins, onAuthError, workspaceClient, ...coreProps }: TaskDetailProps): 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
+ * defaults are used when no `labels` are provided, so the SDK works standalone.
+ * The SDK stays farm-free + string-agnostic; the host owns translation.
+ */
+interface TaskLabels {
+    board: string;
+    list: string;
+    timeline: string;
+    searchPlaceholder: string;
+    allPriorities: string;
+    allTypes: string;
+    newTask: string;
+    myTasks: string;
+    noTasks: string;
+    noTasksFound: string;
+    dropHere: string;
+    unassigned: string;
+    assigned: string;
+    overdue: string;
+    noDueDate: string;
+    milestones: string;
+    today: string;
+    week: string;
+    month: string;
+    tasksSingular: string;
+    tasksPlural: string;
+    colTask: string;
+    colStatus: string;
+    colPriority: string;
+    colAssignee: string;
+    colDueDate: string;
+    colPoints: string;
+    colLinkedRecord: string;
+    colType: string;
+    colKey: string;
+    colLabels: string;
+    newTaskHeading: string;
+    newTaskSubtitle: string;
+    title: string;
+    titlePlaceholder: string;
+    description: string;
+    descriptionPlaceholder: string;
+    typeLabel: string;
+    statusLabel: string;
+    priorityLabel: string;
+    assigneeLabel: string;
+    assigneePlaceholder: string;
+    dueDateLabel: string;
+    storyPointsLabel: string;
+    labelsLabel: string;
+    labelsPlaceholder: string;
+    create: string;
+    creating: string;
+    cancel: string;
+    edit: string;
+    del: string;
+    deletePrompt: string;
+    yes: string;
+    no: string;
+    save: string;
+    saving: string;
+    taskNotFound: string;
+    projectRequired: string;
+    errorLoading: string;
+    moveFailed: string;
+    failedToCreate: string;
+    failedToSave: string;
+    failedToDelete: string;
+    overdueLabel: string;
+    more: string;
+    status: Record<TaskStatus, string>;
+    priority: Record<TaskPriority, string>;
+    type: Record<TaskType, string>;
+}
+/** English defaults — the SDK renders these when no `labels` prop is provided. */
+declare const DEFAULT_TASK_LABELS: TaskLabels;
+declare const TaskLabelsProvider: react.Provider<TaskLabels>;
+/** Read the active task labels (English defaults if no host override). */
+declare function useTaskLabels(): TaskLabels;
+/** A host may override any subset; missing keys fall back to English. */
+type PartialTaskLabels = Partial<Omit<TaskLabels, "status" | "priority" | "type">> & {
+    status?: Partial<TaskLabels["status"]>;
+    priority?: Partial<TaskLabels["priority"]>;
+    type?: Partial<TaskLabels["type"]>;
+};
+/** Merge a host's partial overrides onto the English defaults. */
+declare function mergeTaskLabels(overrides?: PartialTaskLabels): TaskLabels;
+
 /**
  * Which SDK fields the composed page should suppress. The union of the create
  * form fields and the detail fields — the page fans a single `hiddenFields`
@@ -844,6 +983,21 @@ interface TasksPageCoreProps {
     linkSourceProduct?: string;
     /** Optional host hook to render an icon per linked-entity type. */
     renderLinkIcon?: RenderLinkIcon;
+    /** Optional host-provided member directory → renders assignee pickers in create/edit. */
+    assigneeOptions?: AssigneeOption[];
+    /**
+     * The current user's actor id. When provided, the toolbar shows a "My tasks"
+     * toggle that filters every view to items assigned to this actor.
+     */
+    currentActorId?: string;
+    /** Host-provided translations for every UI string (English defaults otherwise). */
+    labels?: PartialTaskLabels;
+    /**
+     * Open a specific work item's detail on mount / when this changes — e.g. a
+     * deep-link from the calendar (`/tasks?item=<id>`). Cleared internally when
+     * the user closes the drawer; pass a new value to re-open.
+     */
+    openItemId?: string;
     /**
      * Header/title slot rendered ABOVE the toolbar. Pass a string for the default
      * heading, or any node to fully own the title area. Omit for no title (e.g.
@@ -868,7 +1022,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, resolveAssignee, linkSourceProduct, renderLinkIcon, header, onTaskSaved, createSurface, detailSurface, className, }: TasksPageCoreProps): react.JSX.Element;
+declare function TasksPageCore({ workspaceId: workspaceIdProp, projectId, boardProjectId, columns, readonly, hiddenFields, views, defaultView, resolveAssignee, linkSourceProduct, renderLinkIcon, assigneeOptions, currentActorId, labels, openItemId, header, onTaskSaved, createSurface, detailSurface, className, }: TasksPageCoreProps): react.JSX.Element;
 
 interface TasksPageProps extends TasksPageCoreProps {
     /** Workspace API gateway URL (URL mode). */
@@ -986,6 +1140,24 @@ interface UseWorkItemLinksResult {
  */
 declare function useWorkItemLinks(workspaceId: string | undefined, sourceProduct: string | undefined, limit?: number): UseWorkItemLinksResult;
 
+interface UseMilestonesResult {
+    milestones: Milestone[];
+    /** Milestones grouped by their due day (yyyy-MM-dd), for timeline flags. */
+    byDay: Map<string, Milestone[]>;
+    loading: boolean;
+}
+/**
+ * useMilestones — fetch a project's milestones (e.g. a harvest window) for the
+ * Timeline to flag. Skips when no workspaceId. Errors are swallowed by Apollo's
+ * error return so a milestone RBAC/serialization hiccup never breaks the board;
+ * `milestones` is simply empty. Farm-free; opt-in via `enabled`.
+ */
+declare function useMilestones(workspaceId: string | undefined, opts?: {
+    projectId?: string;
+    enabled?: boolean;
+    limit?: number;
+}): UseMilestonesResult;
+
 interface PlanMagnetClientConfig {
     /** Workspace API gateway base URL (e.g. https://graphqlworkspaces.burdenoff.com). */
     apiGatewayUrl: string;
@@ -1063,6 +1235,9 @@ declare const WORK_ITEM_LINK_FIELDS: graphql.DocumentNode;
 declare const LIST_WORK_ITEM_LINKS: graphql.DocumentNode;
 declare const CREATE_WORK_ITEM_LINK: graphql.DocumentNode;
 declare const DELETE_WORK_ITEM_LINK: graphql.DocumentNode;
+declare const MILESTONE_FIELDS: graphql.DocumentNode;
+declare const LIST_MILESTONES: graphql.DocumentNode;
+declare const DELETE_WORK_ITEM: graphql.DocumentNode;
 
 /**
  * Configuration module for the PlanMagnet SDK.
@@ -1132,4 +1307,4 @@ declare function getGraphQLEndpoint(baseUrl?: string): string;
 
 declare function cn(...inputs: ClassValue[]): string;
 
-export { 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, DELETE_WORK_ITEM_LINK, Drawer, type DrawerProps, GET_PROJECTS, GET_WORK_ITEM, LIST_WORK_ITEMS, LIST_WORK_ITEM_LINKS, LinkChip, type LinkChipProps, type ListTasksInput, type ListWorkItemLinksInput, MOVE_WORK_ITEM, Modal, type ModalProps, PRIORITY_META, PROJECT_SUMMARY_FIELDS, 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, 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 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, resetPlanMagnetClient, resetPlanMagnetConfig, setPlanMagnetClient, setPlanMagnetConfig, usePlanMagnetContext, usePlanMagnetContextSafe, 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, 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 };