feat: Comments (#4911)

* Comment model * Framework, model, policy, presenter, api endpoint etc * Iteration, first pass of UI * fixes, refactors * Comment commands * comment socket support * typing indicators * comment component, styling * wip * right sidebar resize * fix: CMD+Enter submit * Add usePersistedState fix: Main page scrolling on comment highlight * drafts * Typing indicator * refactor * policies * Click thread to highlight Improve comment timestamps * padding * Comment menu v1 * Change comments to use editor * Basic comment editing * fix: Hide commenting button when disabled at team level * Enable opening sidebar without mark * Move selected comment to location state * Add comment delete confirmation * Add comment count to document meta * fix: Comment sidebar togglable Add copy link to comment * stash * Restore History changes * Refactor right sidebar to allow for comment animation * Update to new router best practices * stash * Various improvements * stash * Handle click outside * Fix incorrect placeholder in input fix: Input box appearing on other sessions erroneously * stash * fix: Don't leave orphaned child comments * styling * stash * Enable comment toggling again * Edit styling, merge conflicts * fix: Cannot navigate from insights to comments * Remove draft comment mark on click outside * Fix: Empty comment sidebar, tsc * Remove public toggle * fix: All comments are recessed fix: Comments should not be printed * fix: Associated mark should be removed on comment delete * Revert unused changes * Empty state, basic RTL support * Create dont toggle comment mark * Make it feel more snappy * Highlight active comment in text * fix animation * RTL support * Add reply CTA * Translations
2023-02-25 15:03:05 -05:00
parent 59e25a0ef0
commit fc8c20149f
89 changed files with 2909 additions and 315 deletions
--- a/server/commands/commentCreator.ts
+++ b/server/commands/commentCreator.ts
@@ -0,0 +1,62 @@
+import { Transaction } from "sequelize";
+import { Comment, User, Event } from "@server/models";
+
+type Props = {
+  id?: string;
+  /** The user creating the comment */
+  user: User;
+  /** The comment as data in Prosemirror schema format */
+  data: Record<string, any>;
+  /** The document to comment within */
+  documentId: string;
+  /** The parent comment we're replying to, if any */
+  parentCommentId?: string;
+  /** The IP address of the user creating the comment */
+  ip: string;
+  transaction?: Transaction;
+};
+
+/**
+ * This command creates a comment inside a document.
+ *
+ * @param Props The properties of the comment to create
+ * @returns Comment The comment that was created
+ */
+export default async function commentCreator({
+  id,
+  user,
+  data,
+  documentId,
+  parentCommentId,
+  ip,
+  transaction,
+}: Props): Promise<Comment> {
+  // TODO: Parse data to validate
+
+  const comment = await Comment.create(
+    {
+      id,
+      createdById: user.id,
+      documentId,
+      parentCommentId,
+      data,
+    },
+    { transaction }
+  );
+
+  comment.createdBy = user;
+
+  await Event.create(
+    {
+      name: "comments.create",
+      modelId: comment.id,
+      teamId: user.teamId,
+      actorId: user.id,
+      documentId,
+      ip,
+    },
+    { transaction }
+  );
+
+  return comment;
+}