outline/server/presenters/comment.ts

import {
  ProsemirrorHelper,
  type CommentMark,
} from "@shared/utils/ProsemirrorHelper";
import type { Comment } from "@server/models";
import { DocumentHelper } from "@server/models/helpers/DocumentHelper";
import presentUser from "./user";

type Options = {
  /** Whether to include anchor text, if it exists */
  includeAnchorText?: boolean;
  /** Precomputed comment marks to avoid reparsing the document. */
  commentMarks?: CommentMark[];
};

export default function present(
  comment: Comment,
  { includeAnchorText, commentMarks }: Options = {}
) {
  let anchorText: string | undefined;

  if (includeAnchorText && comment.document) {
    const marks =
      commentMarks ??
      ProsemirrorHelper.getComments(
        DocumentHelper.toProsemirror(comment.document)
      );
    anchorText = ProsemirrorHelper.getAnchorTextForComment(marks, comment.id);
  }

  return {
    id: comment.id,
    data: comment.data,
    documentId: comment.documentId,
    parentCommentId: comment.parentCommentId,
    createdBy: presentUser(comment.createdBy),
    createdById: comment.createdById,
    resolvedAt: comment.resolvedAt,
    resolvedBy: comment.resolvedBy ? presentUser(comment.resolvedBy) : null,
    resolvedById: comment.resolvedById,
    createdAt: comment.createdAt,
    updatedAt: comment.updatedAt,
    reactions: comment.reactions ?? [],
    anchorText,
  };
}