Merge branch 'staging' into develop

Author: ravewebdev

api/wordpress/_global/getPostTypeArchive.js

@@ -0,0 +1,87 @@
+import {initializeApollo} from '../connector'
+import queryPostsArchive from '../posts/queryPostsArchive'
+import {postTypes} from './postTypes'
+
+/**
+ * Retrieve post archive.
+ *
+ * @author WebDevStudios
+ * @param  {string} postType WP post type.
+ * @param  {string} orderBy  Order by: field.
+ * @param  {string} order    Order by: direction.
+ * @param  {string} cursor   Start/end cursor for pagination.
+ * @param  {bool}   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.
+ */
+export default async function getPostTypeArchive(
+  postType,
+  orderBy = 'DATE',
+  order = 'DESC',
+  cursor = null,
+  getNext = true,
+  perPage = 10
+) {
+  // Define single post query based on post type.
+  const postTypeQuery = {
+    post: queryPostsArchive
+  }
+
+  // Retrieve post type query.
+  const query = postTypeQuery?.[postType] ?? null
+
+  // Get/create Apollo instance.
+  const apolloClient = initializeApollo()
+
+  // Set up return object.
+  const response = {
+    apolloClient,
+    error: false,
+    errorMessage: null
+  }
+
+  // If no query is set for given post type, return error message.
+  if (!query) {
+    return {
+      apolloClient,
+      error: true,
+      errorMessage: `Post type \`${postType}\` archives are not supported.`
+    }
+  }
+
+  // Determine query variables.
+  const variables = {
+    first: getNext ? perPage : null, // Only used for retrieving next set.
+    last: getNext ? null : perPage, // Only used for retrieving previous set.
+    after: getNext ? cursor : null, // Only used for retrieving next set.
+    before: getNext ? null : cursor, // Only used for retrieving previous set.
+    orderBy,
+    order
+  }
+
+  // Execute query.
+  response.posts = await apolloClient
+    .query({query, variables})
+    .then((posts) => {
+      const pluralType = postTypes[postType] ?? postType
+
+      // Set error props if data not found.
+      if (!posts?.data?.[pluralType]?.edges) {
+        response.error = true
+        response.errorMessage = `An error occurred while trying to retrieve data for ${pluralType} archive.`
+
+        return null
+      }
+
+      // Flatten posts array to include inner node post data.
+      return posts.data[pluralType].edges.map((post) => post.node)
+    })
+    .catch((error) => {
+      response.error = true
+      response.errorMessage = error.message
+
+      return null
+    })
+
+  return response
+}

api/wordpress/_global/getPostTypeById.js

@@ -2,6 +2,7 @@ import queryPostById from '../posts/queryPostById'
 import {initializeApollo} from '../connector'
 import queryPageById from '../pages/queryPageById'
 import {isHierarchicalPostType} from './postTypes'
+import formatBlockData from '@/functions/formatBlockData'
 
 /**
  * Retrieve single post by specified identifier.
@@ -10,7 +11,7 @@ import {isHierarchicalPostType} from './postTypes'
  * @param  {string}        postType WP post type.
  * @param  {Number|string} id       Post identifier.
  * @param  {string}        idType   Type of ID.
- * @return {Object}                 Post data or error object.
+ * @return {Object}                 Object containing Apollo client instance and post data or error object.
  */
 export default async function getPostTypeById(postType, id, idType = 'SLUG') {
   // Define single post query based on post type.
@@ -28,34 +29,59 @@ export default async function getPostTypeById(postType, id, idType = 'SLUG') {
   // Retrieve post type query.
   const query = postTypeQuery?.[postType] ?? null
 
+  // Get/create Apollo instance.
+  const apolloClient = initializeApollo()
+
+  // Set up return object.
+  const response = {
+    apolloClient,
+    error: false,
+    errorMessage: null
+  }
+
   // If no query is set for given post type, return error message.
   if (!query) {
     return {
-      isError: true,
-      message: `Post type \`${postType}\` is not supported.`
+      apolloClient,
+      error: true,
+      errorMessage: `Post type \`${postType}\` is not supported.`
     }
   }
 
-  // Get/create Apollo instance.
-  const apolloClient = initializeApollo()
-
   // Execute query.
-  const post = await apolloClient
+  response.post = await apolloClient
     .query({query, variables: {id, idType}})
-    .then((post) => post?.data?.[postType] ?? null)
-    .catch((error) => {
-      return {
-        isError: true,
-        message: error.message
+    .then((post) => {
+      // Set error props if data not found.
+      if (!post?.data?.[postType]) {
+        response.error = true
+        response.errorMessage = `An error occurred while trying to retrieve data for ${postType} "${id}."`
+
+        return null
       }
+
+      return post.data[postType]
     })
+    .then(async (post) => {
+      // Handle blocks.
+      if (!post || !post?.blocksJSON) {
+        return post
+      }
 
-  if (!post) {
-    return {
-      isError: true,
-      message: `An error occurred while trying to retrieve data for ${postType} "${id}."`
-    }
-  }
+      const newPost = {...post}
+
+      newPost.blocks = await formatBlockData(
+        JSON.parse(newPost.blocksJSON) ?? []
+      )
+
+      return newPost
+    })
+    .catch((error) => {
+      response.error = true
+      response.errorMessage = error.message
+
+      return null
+    })
 
-  return post
+  return response
 }

api/wordpress/_global/getPostTypeStaticPaths.js

@@ -27,8 +27,10 @@ export default async function getPostTypeStaticPaths(postType) {
   const query = gql`
     query GET_SLUGS {
       ${pluralName}(first: 10000) {
-        nodes {
-          ${pathField}
+        edges {
+          node {
+            ${pathField}
+          }
         }
       }
     }
@@ -41,14 +43,11 @@ export default async function getPostTypeStaticPaths(postType) {
   const posts = await apolloClient.query({query})
 
   // Process paths.
-  const paths = !posts?.data?.[pluralName]?.nodes
+  const paths = !posts?.data?.[pluralName]?.edges
     ? []
-    : posts.data[pluralName].nodes.map((post) => {
-        // Use path field as-is for non-hierarchical post types.
-        // Trim leading and trailing slashes then split into array on inner slashes for hierarchical post types.
-        const slug = !isHierarchical
-          ? post[pathField]
-          : post[pathField].replace(/^\/|\/$/g, '').split('/')
+    : posts.data[pluralName].edges.map((post) => {
+        // Trim leading and trailing slashes then split into array on inner slashes.
+        const slug = post.node[pathField].replace(/^\/|\/$/g, '').split('/')
 
         return {
           params: {
@@ -59,6 +58,6 @@ export default async function getPostTypeStaticPaths(postType) {
 
   return {
     paths,
-    fallback: false
+    fallback: 'blocking'
   }
 }

api/wordpress/_global/getPostTypeStaticProps.js

@@ -0,0 +1,56 @@
+import getPostTypeById from './getPostTypeById'
+import {addApolloState} from '../connector'
+import getPostTypeArchive from './getPostTypeArchive'
+
+/**
+ * Retrieve static props by post type.
+ *
+ * @param  {string}  params      Post params (e.g., slug).
+ * @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.
+ */
+export default async function getPostTypeStaticProps(
+  params,
+  postType
+  // preview = false, // TODO - add preview handling.
+  // previewData = null
+) {
+  // Check for dynamic archive display.
+  if (!Object.keys(params).length) {
+    const {apolloClient, posts, error, errorMessage} = await getPostTypeArchive(
+      postType
+    )
+
+    // Merge in query results as Apollo state.
+    return addApolloState(apolloClient, {
+      props: {
+        posts,
+        error,
+        errorMessage,
+        archive: true
+      },
+      revalidate: 60 * 5
+    })
+  }
+
+  // Handle catch-all routes.
+  const slug = Array.isArray(params.slug) ? params.slug.join('/') : params.slug
+
+  // Retrieve post data.
+  const {apolloClient, post, error, errorMessage} = await getPostTypeById(
+    postType,
+    slug
+  )
+
+  // Merge in query results as Apollo state.
+  return addApolloState(apolloClient, {
+    props: {
+      post,
+      error,
+      errorMessage
+    },
+    revalidate: 60 * 5
+  })
+}

api/wordpress/_partials/authorPostFields.js

@@ -0,0 +1,10 @@
+// Query partial: retrieve author post fields.
+const authorPostFields = `
+  author {
+    node {
+      slug
+      nickname
+    }
+  }
+`
+export default authorPostFields

api/wordpress/_partials/categoriesPostFields.js

@@ -0,0 +1,12 @@
+// Query partial: retrieve categories post fields.
+const categoriesPostFields = `
+  categories {
+    edges {
+      node {
+        slug
+        name
+      }
+    }
+  }
+`
+export default categoriesPostFields

api/wordpress/_partials/featuredImagePostFields.js

@@ -0,0 +1,11 @@
+// Query partial: retrieve featured image post fields.
+const featuredImagePostFields = `
+  featuredImage {
+    node {
+      altText
+      sourceUrl(size: $imageSize)
+    }
+  }
+`
+
+export default featuredImagePostFields

api/wordpress/_partials/globalPostFields.js

@@ -0,0 +1,9 @@
+// Query partial: retrieve global post fields.
+const globalPostFields = `
+  databaseId
+  date
+  slug
+  uri
+  title
+`
+export default globalPostFields

api/wordpress/_partials/seoPostFields.js

@@ -0,0 +1,15 @@
+// Query partial: retrieve SEO post fields.
+const seoPostFields = `
+  seo {
+    canonical
+    title
+    metaDesc
+    metaRobotsNofollow
+    metaRobotsNoindex
+    opengraphImage {
+      sourceUrl
+    }
+  }
+`
+
+export default seoPostFields

api/wordpress/_partials/tagsPostFields.js

@@ -0,0 +1,12 @@
+// Query partial: retrieve tags post fields.
+const tagsPostFields = `
+  tags {
+    edges {
+      node {
+        name
+        slug
+      }
+    }
+  }
+`
+export default tagsPostFields