Merge branch 'staging' into develop

Author: gregrickaby

api/frontend/wp/comments/mutationAddComment.js

@@ -0,0 +1,28 @@
+import {gql} from '@apollo/client'
+import {wpDataEndpoints} from '@/api/wordpress/connector'
+import commentsFields from '@/api/wordpress/_partials/commentsFields'
+
+// Mutation: Add a comment to the given post
+const mutationAddComment = gql`
+  mutation ADD_COMMENT(
+    $author: String
+    $authorEmail: String
+    $authorUrl: String
+    $postId: Int!
+    $content: String!
+  ) {
+    postComment (
+      author: $author,
+      authorEmail: $authorEmail,
+      authorUrl: $authorUrl,
+      postId: $postId,
+      content: $content
+    ) @rest(type: "Comments", path: "${wpDataEndpoints.postComment}?{args}") {
+      comment {
+        ${commentsFields}
+      }
+    }
+  }
+`
+
+export default mutationAddComment

api/frontend/wp/comments/postComment.js

@@ -0,0 +1,59 @@
+import mutationAddComment from './mutationAddComment'
+import {initializeFeApollo} from '../../connector'
+
+/**
+ * Post a comment to the given post. Follows established WordPress
+ * behavior for posting comments:
+ *
+ * If this is an authenticated request (i.e. "logged in"), the `author`
+ * fields will be ignored in favor of the logged-in user's information.
+ *
+ * If comment moderation is turned on, the `data.createComment.comment`
+ * object may be `null`. This does not necessarily indicate an error;
+ * the comment may be held for moderation.
+ *
+ * If the comment does not need manual approval, it will be returned
+ * with this query.
+ *
+ * @author WebDevStudios
+ * @param {string} author      Name of the comment author.
+ * @param {string} authorEmail Email for the comment author.
+ * @param {string} authorUrl   URL/website for the comment author.
+ * @param {number} postId      Database ID for the post being commented on.
+ * @param {string} content     Content of the comment.
+ * @return {object}            Comment data or error object.
+ */
+export default async function postComment(
+  author,
+  authorEmail,
+  authorUrl,
+  postId,
+  content
+) {
+  const apolloClient = initializeFeApollo()
+
+  return apolloClient
+    .mutate({
+      mutation: mutationAddComment,
+      variables: {
+        author,
+        authorEmail,
+        authorUrl,
+        postId,
+        content
+      }
+    })
+    .then(
+      (response) =>
+        response?.data?.postComment ?? {
+          error: true,
+          errorMessage: `An error occurred while trying to post the comment.`
+        }
+    )
+    .catch((error) => {
+      return {
+        error: true,
+        errorMessage: error.message
+      }
+    })
+}

api/wordpress/_global/getPostTypeArchive.js

@@ -52,7 +52,7 @@ export const archiveSeo = {
  * @param {string}  cursor   Start/end cursor for pagination.
  * @param {boolean} getNext  Whether to retrieve next set of posts (true) or previous set (false).
  * @param {number}  perPage  Number of posts per page.
- * @return {object}          Object containing Apollo client instance and post archive data or error object.
+ * @return {object} Object containing Apollo client instance and post archive data or error object.
  */
 export default async function getPostTypeArchive(
   postType,

api/wordpress/_global/getPostTypeById.js

@@ -20,7 +20,7 @@ import getMenus from '../menus/getMenus'
  * @param {number | string} id       Post identifier.
  * @param {string}          idType   Type of ID.
  * @param {string}          preview  Whether query is for a regular post view (null), a preview check (basic), or full post preview (full).
- * @return {object}                  Object containing Apollo client instance and post data or error object.
+ * @return {object} Object containing Apollo client instance and post data or error object.
  */
 export default async function getPostTypeById(
   postType,

api/wordpress/_global/getPostTypeStaticPaths.js

@@ -7,7 +7,7 @@ import {initializeWpApollo} from '../connector'
  *
  * @author WebDevStudios
  * @param {string} postType WP post type.
- * @return {object}         Post type paths.
+ * @return {object} Post type paths.
  */
 export default async function getPostTypeStaticPaths(postType) {
   if (!postType || !isValidPostType(postType)) {

api/wordpress/_global/getPostTypeStaticProps.js

@@ -12,7 +12,7 @@ import getFrontendPage, {frontendPageSeo} from './getFrontendPage'
  * @param {string}  postType    Post Type.
  * @param {boolean} preview     Whether requesting preview of post.
  * @param {object}  previewData Post preview data.
- * @return {object}             Object containing post props and revalidate setting.
+ * @return {object} Object containing post props and revalidate setting.
  */
 export default async function getPostTypeStaticProps(
   params,

api/wordpress/_global/postCommentToPost.js

@@ -0,0 +1,72 @@
+import {initializeWpApollo} from '../connector'
+import mutationCommentToPost from '../comments/mutationCommentToPost'
+
+/**
+ * Post a comment to the given post. Follows established WordPress
+ * behavior for posting comments:
+ *
+ * If this is an authenticated request (i.e. "logged in"), the `author`
+ * fields will be ignored in favor of the logged-in user's information.
+ *
+ * If comment moderation is turned on, the `data.createComment.comment`
+ * object may be `null`. This does not necessarily indicate an error;
+ * the comment may be held for moderation.
+ *
+ * If the comment does not need manual approval, it will be returned
+ * with this query.
+ *
+ * @author WebDevStudios
+ * @param {string} author      Name of the comment author.
+ * @param {string} authorEmail Email for the comment author.
+ * @param {string} authorUrl   URL/website for the comment author.
+ * @param {number} postId      Database ID for the post being commented on.
+ * @param {string} content     Content of the comment.
+ * @return {object}            Comment data or error object.
+ */
+export default async function postCommentToPost(
+  author,
+  authorEmail,
+  authorUrl,
+  postId,
+  content
+) {
+  // Get/create Apollo instance.
+  const apolloClient = initializeWpApollo()
+
+  // Set up return object.
+  const response = {
+    apolloClient,
+    comment: null
+  }
+
+  // Determine query variables.
+  const variables = {
+    author,
+    authorEmail,
+    authorUrl,
+    postId: parseInt(postId),
+    content
+  }
+
+  // Execute query.
+  await apolloClient
+    .mutate({mutation: mutationCommentToPost, variables})
+    .then((comment) => {
+      const {data} = comment
+      // Set error props if data not found.
+      if (!data?.createComment) {
+        response.error = true
+        response.errorMessage = `An error occurred while trying to post the comment.`
+
+        return null
+      }
+
+      response.comment = data.createComment.comment
+    })
+    .catch((error) => {
+      response.error = true
+      response.errorMessage = error.message
+    })
+
+  return response
+}

api/wordpress/_global/postTypes.js

@@ -50,7 +50,7 @@ export const hierarchicalPostTypes = ['page']
  *
  * @author WebDevStudios
  * @param {string} postType WP post type.
- * @return {boolean}        Whether provided post type is valid.
+ * @return {boolean} Whether provided post type is valid.
  */
 export function isValidPostType(postType) {
   return Object.keys(postTypes).includes(postType)
@@ -61,7 +61,7 @@ export function isValidPostType(postType) {
  *
  * @author WebDevStudios
  * @param {string} postType WP post type.
- * @return {boolean}        Whether provided post type is hierarchical.
+ * @return {boolean} Whether provided post type is hierarchical.
  */
 export function isHierarchicalPostType(postType) {
   return hierarchicalPostTypes.includes(postType)

api/wordpress/_partials/commentsFields.js

@@ -1,16 +1,18 @@
 // Query partial: retrieve comment fields.
 const commentsFields = `
-edges {
-  node {
-    databaseId
-    content(format: RENDERED)
-    parentDatabaseId
-    approved
-    id
-    date
-    parentId
-    type
+  databaseId
+  content(format: RENDERED)
+  parentDatabaseId
+  approved
+  id
+  date
+  parentId
+  type
+  author {
+    node {
+      name
+      url
+    }
   }
-}
 `
 export default commentsFields

api/wordpress/_partials/commentsPostFields.js

@@ -3,7 +3,11 @@ import commentsFields from './commentsFields'
 // Query partial: retrieve comment post fields.
 const commentsPostFields = `
   comments(first: 10) {
-    ${commentsFields}
+    edges {
+      node {
+        ${commentsFields}
+      }
+    }
   }
 `
 export default commentsPostFields