Expose case studies and product updates in RSS feed

Author: hasparus

packages/web/docs/src/app/blog/(posts)/graphql-request-cancellation/page.mdx

@@ -176,7 +176,7 @@ flowchart
   id31["Load total post likes (Post.likeCount)"]
   id32["Load comments for each post (Post.comments)"]
   id4["Load author for each comments (Comment.author)"]
-  id5["Load author avataer for each comment author (User.avatar)"]
+  id5["Load author avatar for each comment author (User.avatar)"]
 
   id1 --> id21
   id1 --> id22
@@ -199,7 +199,7 @@ flowchart
   id31["Load total post likes (Post.likeCount)"]
   id32["Load comments for each post (Post.comments)"]
   id4["Load author for each comments (Comment.author)"]
-  id5["Load author avataer for each comment author (User.avatar)"]
+  id5["Load author avatar for each comment author (User.avatar)"]
 
   id1 --> id21
   id1 --> id22

packages/web/docs/src/app/blog/feed.xml/route.ts

@@ -2,35 +2,49 @@
 import RSS from 'rss';
 import { getPageMap } from '@theguild/components/server';
 import { AuthorId, authors } from '../../../authors';
-import { isBlogPost } from '../blog-types';
+import { pagesDepthFirst } from '../../../mdx-types';
+import { coerceCaseStudyToBlog } from '../../case-studies/coerce-case-studies-to-blogs';
+import { isCaseStudy } from '../../case-studies/isCaseStudyFile';
+import { BlogFrontmatter, BlogPostFile, isBlogPost } from '../blog-types';
 
-function getAuthor(name: string) {
-  const author = authors[name as AuthorId]?.name;
-  return author ?? name;
+function getAuthor(frontmatterAuthors: BlogFrontmatter['authors']): string {
+  const first = Array.isArray(frontmatterAuthors) ? frontmatterAuthors[0] : frontmatterAuthors;
+
+  if (typeof first === 'string') {
+    const author = authors[first as AuthorId];
+    return author ? author.name : 'Unknown Author';
+  }
+
+  return first.name;
 }
 
+export const dynamic = 'force-static';
+export const config = { runtime: 'edge' };
+
 export async function GET() {
-  const [_meta, _indexPage, ...pageMap] = await getPageMap('/blog');
-  const allPosts = pageMap
-    .filter(isBlogPost)
-    .map(
-      item =>
-        ({
-          title: item.frontMatter.title,
-          date: new Date(item.frontMatter.date),
-          url: `https://the-guild.dev/graphql/hive${item.route}`,
-          description: (item.frontMatter as any).description ?? '',
-          author: getAuthor(
-            typeof item.frontMatter.authors === 'string'
-              ? item.frontMatter.authors
-              : item.frontMatter.authors.at(0)!,
-          ),
-          categories: Array.isArray(item.frontMatter.tags)
-            ? item.frontMatter.tags
-            : [item.frontMatter.tags],
-        }) satisfies RSS.ItemOptions,
-    )
-    .sort((a, b) => b.date.getTime() - a.date.getTime());
+  let allPosts: RSS.ItemOptions[] = [];
+
+  const [_meta, _indexPage, ...pages] = await getPageMap('/');
+  for (const page of pagesDepthFirst(pages)) {
+    const route = (page && 'route' in page && page.route) || '';
+    const [dir, name] = route.split('/').filter(Boolean);
+    if (!name) continue;
+    switch (dir) {
+      case 'blog':
+      case 'product-updates':
+        if (isBlogPost(page)) allPosts.push(toRssItem(page));
+        break;
+      case 'case-studies':
+        if (isCaseStudy(page)) allPosts.push(toRssItem(coerceCaseStudyToBlog(page)));
+        break;
+    }
+  }
+
+  if (allPosts.length === 0) {
+    throw new Error('No blog posts found for RSS feed');
+  }
+
+  allPosts = allPosts.sort((a, b) => new Date(b.date).getTime() - new Date(a.date).getTime());
 
   const feed = new RSS({
     title: 'Hive Blog',
@@ -49,5 +63,15 @@ export async function GET() {
   });
 }
 
-export const dynamic = 'force-static';
-export const config = { runtime: 'edge' };
+function toRssItem(blogPost: BlogPostFile): RSS.ItemOptions {
+  return {
+    title: blogPost.frontMatter.title,
+    date: new Date(blogPost.frontMatter.date),
+    url: `https://the-guild.dev/graphql/hive${blogPost.route}`,
+    description: blogPost.frontMatter.description ?? '',
+    author: getAuthor(blogPost.frontMatter.authors),
+    categories: Array.isArray(blogPost.frontMatter.tags)
+      ? blogPost.frontMatter.tags
+      : [blogPost.frontMatter.tags],
+  };
+}

packages/web/docs/src/mdx-types.ts

@@ -13,3 +13,19 @@ export type MdxFile<FrontMatterType> = {
  * TODO: This should be exported from `nextra` and `@theguild/components`
  */
 export type PageMapItem = Awaited<ReturnType<typeof getPageMap>>[number];
+
+export type FolderItem = Extract<PageMapItem, { children: PageMapItem[] }>;
+
+export function isFolder(item: PageMapItem): item is FolderItem {
+  return !!item && typeof item === 'object' && 'children' in item;
+}
+
+export function* pagesDepthFirst(items: PageMapItem[]): Generator<PageMapItem> {
+  for (const item of items) {
+    if (isFolder(item)) {
+      yield* pagesDepthFirst(item.children);
+    } else {
+      yield item;
+    }
+  }
+}