@docusaurus/plugin-content-blog 0.0.0-5833 → 0.0.0-5835

package/lib/client/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { BlogMetadata } from '@docusaurus/plugin-content-blog';
+export declare function useBlogMetadata(): BlogMetadata;

package/lib/client/index.js

@@ -0,0 +1,15 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import useRouteContext from '@docusaurus/useRouteContext';
+export function useBlogMetadata() {
+    const routeContext = useRouteContext();
+    const blogMetadata = routeContext?.data?.blogMetadata;
+    if (!blogMetadata) {
+        throw new Error("useBlogMetadata() can't be called on the current route because the blog metadata could not be found in route context");
+    }
+    return blogMetadata;
+}

package/lib/index.js

@@ -104,7 +104,7 @@ async function pluginContentBlog(context, options) {
             };
         },
         async contentLoaded({ content: blogContents, actions }) {
-            const { blogListComponent, blogPostComponent, blogTagsListComponent, blogTagsPostsComponent, blogArchiveComponent, routeBasePath, archiveBasePath, } = options;
+            const { blogListComponent, blogPostComponent, blogTagsListComponent, blogTagsPostsComponent, blogArchiveComponent, routeBasePath, archiveBasePath, blogTitle, } = options;
             const { addRoute, createData } = actions;
             const { blogSidebarTitle, blogPosts, blogListPaginated, blogTags, blogTagsListPath, } = blogContents;
             const listedBlogPosts = blogPosts.filter(blogUtils_1.shouldBeListed);
@@ -155,6 +155,11 @@ async function pluginContentBlog(context, options) {
                     unlisted: blogPost.metadata.unlisted,
                 })),
             }, null, 2));
+            const blogMetadata = {
+                blogBasePath: (0, utils_1.normalizeUrl)([baseUrl, routeBasePath]),
+                blogTitle,
+            };
+            const blogMetadataPath = await createData(`blogMetadata-${pluginId}.json`, JSON.stringify(blogMetadata, null, 2));
             // Create routes for blog entries.
             await Promise.all(blogPosts.map(async (blogPost) => {
                 const { id, metadata } = blogPost;
@@ -170,6 +175,9 @@ async function pluginContentBlog(context, options) {
                         sidebar: aliasedSource(sidebarProp),
                         content: metadata.source,
                     },
+                    context: {
+                        blogMetadata: aliasedSource(blogMetadataPath),
+                    },
                 });
                 blogItemsToMetadata[id] = metadata;
             }));

package/package.json

@@ -1,12 +1,24 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-5833",
+  "version": "0.0.0-5835",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
+  "exports": {
+    "./lib/*": "./lib/*",
+    "./src/*": "./src/*",
+    "./client": {
+      "type": "./lib/client/index.d.ts",
+      "default": "./lib/client/index.js"
+    },
+    ".": {
+      "types": "./src/plugin-content-blog.d.ts",
+      "default": "./lib/index.js"
+    }
+  },
   "scripts": {
-    "build": "tsc",
-    "watch": "tsc --watch",
+    "build": "tsc --build",
+    "watch": "tsc --build --watch",
     "test:generate-build-snap": "yarn docusaurus build src/__tests__/__fixtures__/website --out-dir build-snap && yarn rimraf src/__tests__/__fixtures__/website/.docusaurus && yarn rimraf src/__tests__/__fixtures__/website/build-snap/assets && git add src/__tests__/__fixtures__/website/build-snap"
   },
   "repository": {
@@ -19,13 +31,13 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5833",
-    "@docusaurus/logger": "0.0.0-5833",
-    "@docusaurus/mdx-loader": "0.0.0-5833",
-    "@docusaurus/types": "0.0.0-5833",
-    "@docusaurus/utils": "0.0.0-5833",
-    "@docusaurus/utils-common": "0.0.0-5833",
-    "@docusaurus/utils-validation": "0.0.0-5833",
+    "@docusaurus/core": "0.0.0-5835",
+    "@docusaurus/logger": "0.0.0-5835",
+    "@docusaurus/mdx-loader": "0.0.0-5835",
+    "@docusaurus/types": "0.0.0-5835",
+    "@docusaurus/utils": "0.0.0-5835",
+    "@docusaurus/utils-common": "0.0.0-5835",
+    "@docusaurus/utils-validation": "0.0.0-5835",
     "cheerio": "^1.0.0-rc.12",
     "feed": "^4.2.2",
     "fs-extra": "^11.1.1",
@@ -44,5 +56,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "e2881302a2bbc9d1b3277dc5729c5adba3d5684f"
+  "gitHead": "63065664a850451b45d9b9fcaaf110388d1e39d4"
 }

package/src/client/index.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import useRouteContext from '@docusaurus/useRouteContext';
+import type {BlogMetadata} from '@docusaurus/plugin-content-blog';
+
+export function useBlogMetadata(): BlogMetadata {
+  const routeContext = useRouteContext();
+  const blogMetadata = routeContext?.data?.blogMetadata;
+  if (!blogMetadata) {
+    throw new Error(
+      "useBlogMetadata() can't be called on the current route because the blog metadata could not be found in route context",
+    );
+  }
+  return blogMetadata as BlogMetadata;
+}

package/src/index.ts

@@ -42,6 +42,7 @@ import type {
   BlogTags,
   BlogContent,
   BlogPaginated,
+  BlogMetadata,
 } from '@docusaurus/plugin-content-blog';
 
 export default async function pluginContentBlog(
@@ -182,6 +183,7 @@ export default async function pluginContentBlog(
         blogArchiveComponent,
         routeBasePath,
         archiveBasePath,
+        blogTitle,
       } = options;
 
       const {addRoute, createData} = actions;
@@ -257,6 +259,15 @@ export default async function pluginContentBlog(
         ),
       );
 
+      const blogMetadata: BlogMetadata = {
+        blogBasePath: normalizeUrl([baseUrl, routeBasePath]),
+        blogTitle,
+      };
+      const blogMetadataPath = await createData(
+        `blogMetadata-${pluginId}.json`,
+        JSON.stringify(blogMetadata, null, 2),
+      );
+
       // Create routes for blog entries.
       await Promise.all(
         blogPosts.map(async (blogPost) => {
@@ -276,6 +287,9 @@ export default async function pluginContentBlog(
               sidebar: aliasedSource(sidebarProp),
               content: metadata.source,
             },
+            context: {
+              blogMetadata: aliasedSource(blogMetadataPath),
+            },
           });
 
           blogItemsToMetadata[id] = metadata;

package/src/plugin-content-blog.d.ts

@@ -5,6 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+/// <reference types="@docusaurus/module-type-aliases" />
+
 declare module '@docusaurus/plugin-content-blog' {
   import type {LoadedMDXContent} from '@docusaurus/mdx-loader';
   import type {MDXOptions} from '@docusaurus/mdx-loader';
@@ -466,6 +468,13 @@ yarn workspace v1.22.19image` is a collocated image path, this entry will be the
     blogTagsListPath: string;
   };
 
+  export type BlogMetadata = {
+    /** the path to the base of the blog */
+    blogBasePath: string;
+    /** title of the overall blog */
+    blogTitle: string;
+  };
+
   export type BlogTags = {
     [permalink: string]: BlogTag;
   };
@@ -537,6 +546,7 @@ declare module '@theme/BlogPostPage' {
     BlogPostFrontMatter,
     BlogSidebar,
     PropBlogPostContent,
+    BlogMetadata,
   } from '@docusaurus/plugin-content-blog';
 
   export type FrontMatter = BlogPostFrontMatter;
@@ -548,6 +558,8 @@ declare module '@theme/BlogPostPage' {
     readonly sidebar: BlogSidebar;
     /** Content of this post as an MDX component, with useful metadata. */
     readonly content: Content;
+    /** Metadata about the blog. */
+    readonly blogMetadata: BlogMetadata;
   }
 
   export default function BlogPostPage(props: Props): JSX.Element;
@@ -557,6 +569,10 @@ declare module '@theme/BlogPostPage/Metadata' {
   export default function BlogPostPageMetadata(): JSX.Element;
 }
 
+declare module '@theme/BlogPostPage/StructuredData' {
+  export default function BlogPostStructuredData(): JSX.Element;
+}
+
 declare module '@theme/BlogListPage' {
   import type {Content} from '@theme/BlogPostPage';
   import type {
@@ -579,6 +595,28 @@ declare module '@theme/BlogListPage' {
   export default function BlogListPage(props: Props): JSX.Element;
 }
 
+declare module '@theme/BlogListPage/StructuredData' {
+  import type {Content} from '@theme/BlogPostPage';
+  import type {
+    BlogSidebar,
+    BlogPaginatedMetadata,
+  } from '@docusaurus/plugin-content-blog';
+
+  export interface Props {
+    /** Blog sidebar. */
+    readonly sidebar: BlogSidebar;
+    /** Metadata of the current listing page. */
+    readonly metadata: BlogPaginatedMetadata;
+    /**
+     * Array of blog posts included on this page. Every post's metadata is also
+     * available.
+     */
+    readonly items: readonly {readonly content: Content}[];
+  }
+
+  export default function BlogListPageStructuredData(props: Props): JSX.Element;
+}
+
 declare module '@theme/BlogTagsListPage' {
   import type {BlogSidebar} from '@docusaurus/plugin-content-blog';
   import type {TagsListItem} from '@docusaurus/utils';