Standardize generateMetadata on entities

bigcommerce · Jul 28, 2024 · 3d79c28 · 3d79c28
1 parent 20f9381
commit 3d79c28
Show file tree

Hide file tree

Showing 10 changed files with 54 additions and 19 deletions.
diff --git a/core/app/[locale]/(default)/(faceted)/brand/[slug]/page-data.ts b/core/app/[locale]/(default)/(faceted)/brand/[slug]/page-data.ts
@@ -9,6 +9,11 @@ const BrandQuery = graphql(`
     site {
       brand(entityId: $entityId) {
         name
+        seo {
+          pageTitle
+          metaDescription
+          metaKeywords
+        }
       }
     }
   }

diff --git a/core/app/[locale]/(default)/(faceted)/brand/[slug]/page.tsx b/core/app/[locale]/(default)/(faceted)/brand/[slug]/page.tsx
@@ -27,10 +27,16 @@ export async function generateMetadata({ params }: Props): Promise<Metadata> {
 
   const brand = await getBrand({ entityId: brandId });
 
-  const title = brand?.name;
+  if (!brand) {
+    return {};
+  }
+
+  const { pageTitle, metaDescription, metaKeywords } = brand.seo;
 
   return {
-    title,
+    title: pageTitle || brand.name,
+    description: metaDescription,
+    keywords: metaKeywords ? metaKeywords.split(',') : null,
   };
 }
 

diff --git a/core/app/[locale]/(default)/(faceted)/category/[slug]/page-data.ts b/core/app/[locale]/(default)/(faceted)/category/[slug]/page-data.ts
@@ -15,6 +15,11 @@ const CategoryPageQuery = graphql(
         category(entityId: $categoryId) {
           name
           ...BreadcrumbsFragment
+          seo {
+            pageTitle
+            metaDescription
+            metaKeywords
+          }
         }
         ...CategoryTreeFragment
       }

diff --git a/core/app/[locale]/(default)/(faceted)/category/[slug]/page.tsx b/core/app/[locale]/(default)/(faceted)/category/[slug]/page.tsx
@@ -31,10 +31,18 @@ export async function generateMetadata({ params }: Props): Promise<Metadata> {
     categoryId,
   });
 
-  const title = data.category?.name;
+  const category = data.category;
+
+  if (!category) {
+    return {};
+  }
+
+  const { pageTitle, metaDescription, metaKeywords } = category.seo;
 
   return {
-    title,
+    title: pageTitle || category.name,
+    description: metaDescription,
+    keywords: metaKeywords ? metaKeywords.split(',') : null,
   };
 }
 

diff --git a/core/app/[locale]/(default)/blog/[blogId]/page-data.ts b/core/app/[locale]/(default)/blog/[blogId]/page-data.ts
@@ -26,6 +26,8 @@ const BlogPageQuery = graphql(
               }
               seo {
                 pageTitle
+                metaDescription
+                metaKeywords
               }
             }
           }

diff --git a/core/app/[locale]/(default)/blog/[blogId]/page.tsx b/core/app/[locale]/(default)/blog/[blogId]/page.tsx
@@ -28,10 +28,16 @@ export async function generateMetadata({ params: { blogId } }: Props): Promise<M
   const data = await getBlogPageData({ entityId: Number(blogId) });
   const blogPost = data?.content.blog?.post;
 
-  const title = blogPost?.seo.pageTitle ?? 'Blog';
+  if (!blogPost) {
+    return {};
+  }
+
+  const { pageTitle, metaDescription, metaKeywords } = blogPost.seo;
 
   return {
-    title,
+    title: pageTitle || blogPost.name,
+    description: metaDescription,
+    keywords: metaKeywords ? metaKeywords.split(',') : null,
   };
 }
 

diff --git a/core/app/[locale]/(default)/blog/page-data.ts b/core/app/[locale]/(default)/blog/page-data.ts
@@ -29,6 +29,7 @@ const BlogPostsPageQuery = graphql(
         content {
           blog {
             name
+            description
             posts(first: $first, after: $after, last: $last, before: $before, filters: $filters) {
               edges {
                 node {

diff --git a/core/app/[locale]/(default)/blog/page.tsx b/core/app/[locale]/(default)/blog/page.tsx
@@ -17,10 +17,12 @@ interface Props {
 export async function generateMetadata({ searchParams }: Props): Promise<Metadata> {
   const blogPosts = await getBlogPosts(searchParams);
 
-  const title = blogPosts?.name ?? 'Blog';
-
   return {
-    title,
+    title: blogPosts?.name ?? 'Blog',
+    description:
+      blogPosts?.description && blogPosts.description.length > 150
+        ? `${blogPosts.description.substring(0, 150)}...`
+        : blogPosts?.description,
   };
 }
 

diff --git a/core/app/[locale]/(default)/webpages/contact/[id]/page.tsx b/core/app/[locale]/(default)/webpages/contact/[id]/page.tsx
@@ -51,15 +51,15 @@ export async function generateMetadata({ params }: Props): Promise<Metadata> {
   const webpage = data.node?.__typename === 'ContactPage' ? data.node : null;
 
   if (!webpage) {
-    notFound();
+    return {};
   }
 
-  const { seo } = webpage;
+  const { pageTitle, metaDescription, metaKeywords } = webpage.seo;
 
   return {
-    title: seo.pageTitle,
-    description: seo.metaDescription,
-    keywords: seo.metaKeywords,
+    title: pageTitle,
+    description: metaDescription,
+    keywords: metaKeywords,
   };
 }
 

diff --git a/core/app/[locale]/(default)/webpages/normal/[id]/page.tsx b/core/app/[locale]/(default)/webpages/normal/[id]/page.tsx
@@ -46,15 +46,15 @@ export async function generateMetadata({ params: { id } }: Props): Promise<Metad
   const webpage = await getWebpageData({ id });
 
   if (!webpage) {
-    notFound();
+    return {};
   }
 
-  const { seo } = webpage;
+  const { pageTitle, metaDescription, metaKeywords } = webpage.seo;
 
   return {
-    title: seo.pageTitle,
-    description: seo.metaDescription,
-    keywords: seo.metaKeywords,
+    title: pageTitle || webpage.name,
+    description: metaDescription,
+    keywords: metaKeywords ? metaKeywords.split(',') : null,
   };
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -26,6 +26,8 @@ const BlogPageQuery = graphql( @@
                   }
                   seo {
                     pageTitle
+                    metaDescription
+                    metaKeywords
                   }
                 }
               }
@@ Expand Down @@