DOC-2578: The commentAuthor property is now included in reply events for the event log. (#3543)

* DOC-2578: The commentAuthor property is now included in reply events of the event log.

* Update modules/ROOT/partials/plugin-apis/comments-apis.adoc

* Update modules/ROOT/partials/plugin-apis/comments-apis.adoc

* Update modules/ROOT/partials/plugin-apis/comments-apis.adoc

* Update modules/ROOT/partials/plugin-apis/comments-apis.adoc

* Update modules/ROOT/partials/plugin-apis/comments-apis.adoc

* DOC-2578: Update callback demo to include commentAuthor.

* Update modules/ROOT/partials/configuration/tinycomments_reply.adoc

Co-authored-by: tiny-ben-tran <[email protected]>

---------

Co-authored-by: tiny-ben-tran <[email protected]>

Author: kemister85

modules/ROOT/examples/live-demos/comments-callback/example.js

@@ -48,7 +48,11 @@ const tinycomments_reply = (req, done, fail) => {
     })
     .then((req2) => {
       const commentUid = req2.commentUid;
-      done({ commentUid });
+      done({
+        commentUid: replyUid,
+        author: currentUser.id,
+        authorName: currentUser.fullName
+      });
     })
     .catch((e) => {
       fail(e);

modules/ROOT/pages/7.6.0-release-notes.adoc

@@ -102,6 +102,15 @@ The {productname} {release-version} release includes an accompanying release of
 
 **Comments** includes the following fixes and improvements.
 
+==== The `commentAuthor` property is now included in reply events of the event log.
+// #TINY-11489
+
+In previous versions of the tinycomments plugin, the `commentAuthor` property was missing from 'reply' events within the event log, which led to incomplete tracking of user interactions when retrieving data through the `+getEventLog()+` API.
+
+{productname} {release-version} addresses this issue. Now, the `commentAuthor` property is included in 'reply' events in the event log.
+
+For more information on the `getEventLog`, see xref:comments-commands-events-apis.adoc#getEventLog[getEventLog].
+
 ==== Allow mentions in comments dropdown to flow freely outside of the editor container
 // #TINY-11504
 

modules/ROOT/partials/configuration/tinycomments_reply.adoc

@@ -16,7 +16,9 @@ The `+done+` callback should accept the following object:
 [source,js]
 ----
 {
-  commentUid: string // the value of the new comment uid
+  commentUid: string, // the value of the new comment uid
+  author: string, // the id of the current author
+  authorName: string // the name of the current author
 }
 ----
 
@@ -42,7 +44,11 @@ const reply_comment = (ref, done, fail) => {
     })
     .then((ref2) => {
       let commentUid = ref2.commentUid;
-      done({ commentUid: commentUid });
+      done({
+        commentUid: replyUid,
+        author: currentUser.id,
+        authorName: currentUser.fullName
+      });
     })
     .catch((e) => {
       fail(e);

modules/ROOT/partials/plugin-apis/comments-apis.adoc

@@ -63,6 +63,10 @@ The `getEventLog` returns a log that contains information and timestamps of all
   "conversationContent": "new comment (Edit comment)",
   "conversationCreatedAt": "2024-10-01T03:07:53.771Z",
   "commentContent": "reply to existing comment",
+  "commentAuthor": {
+      "author": "DEMO USER",
+      "authorName": "DEMO USER"
+  },
   "conversationAuthor": {
       "author": "DEMO USER",
       "authorName": "DEMO USER"