@docusaurus/plugin-content-blog 0.0.0-4817 → 0.0.0-4818

package/lib/index.js

@@ -46,7 +46,7 @@ async function pluginContentBlog(context, options) {
             const contentMarkdownGlobs = (0, utils_1.getContentPathList)(contentPaths).flatMap((contentPath) => include.map((pattern) => `${contentPath}/${pattern}`));
             return [authorsMapFilePath, ...contentMarkdownGlobs].filter(Boolean);
         },
-        async getTranslationFiles() {
+        getTranslationFiles() {
             return (0, translations_1.getTranslationFiles)(options);
         },
         // Fetches blog contents and returns metadata for the necessary routes.

package/lib/types.d.ts

@@ -8,31 +8,33 @@ import type { BrokenMarkdownLink, ContentPaths } from '@docusaurus/utils';
 import type { BlogPostMetadata } from '@docusaurus/plugin-content-blog';
 import type { Metadata as BlogPaginatedMetadata } from '@theme/BlogListPage';
 export declare type BlogContentPaths = ContentPaths;
-export interface BlogContent {
+export declare type BlogContent = {
     blogSidebarTitle: string;
     blogPosts: BlogPost[];
     blogListPaginated: BlogPaginated[];
     blogTags: BlogTags;
     blogTagsListPath: string | null;
-}
-export interface BlogTags {
+};
+export declare type BlogTags = {
     [tagKey: string]: BlogTag;
-}
-export interface BlogTag {
+};
+export declare type BlogTag = {
     name: string;
+    /** Blog post permalinks. */
     items: string[];
     permalink: string;
     pages: BlogPaginated[];
-}
-export interface BlogPost {
+};
+export declare type BlogPost = {
     id: string;
     metadata: BlogPostMetadata;
     content: string;
-}
-export interface BlogPaginated {
+};
+export declare type BlogPaginated = {
     metadata: BlogPaginatedMetadata;
+    /** Blog post permalinks. */
     items: string[];
-}
+};
 export declare type BlogBrokenMarkdownLink = BrokenMarkdownLink<BlogContentPaths>;
 export declare type BlogMarkdownLoaderOptions = {
     siteDir: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-4817",
+  "version": "0.0.0-4818",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -18,12 +18,12 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4817",
-    "@docusaurus/logger": "0.0.0-4817",
-    "@docusaurus/mdx-loader": "0.0.0-4817",
-    "@docusaurus/utils": "0.0.0-4817",
-    "@docusaurus/utils-common": "0.0.0-4817",
-    "@docusaurus/utils-validation": "0.0.0-4817",
+    "@docusaurus/core": "0.0.0-4818",
+    "@docusaurus/logger": "0.0.0-4818",
+    "@docusaurus/mdx-loader": "0.0.0-4818",
+    "@docusaurus/utils": "0.0.0-4818",
+    "@docusaurus/utils-common": "0.0.0-4818",
+    "@docusaurus/utils-validation": "0.0.0-4818",
     "cheerio": "^1.0.0-rc.10",
     "feed": "^4.2.2",
     "fs-extra": "^10.0.1",
@@ -35,7 +35,7 @@
     "webpack": "^5.70.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "0.0.0-4817",
+    "@docusaurus/types": "0.0.0-4818",
     "escape-string-regexp": "^4.0.0"
   },
   "peerDependencies": {
@@ -45,5 +45,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "d2181da8a609f19e54eebc8d1c0cf2909a70cfa9"
+  "gitHead": "0ea48452c51db14e48c6395071903307663e2281"
 }

package/src/index.ts

@@ -102,7 +102,7 @@ export default async function pluginContentBlog(
       ) as string[];
     },
 
-    async getTranslationFiles() {
+    getTranslationFiles() {
       return getTranslationFiles(options);
     },
 

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

@@ -10,7 +10,7 @@ declare module '@docusaurus/plugin-content-blog' {
   import type {FrontMatterTag, Tag} from '@docusaurus/utils';
   import type {Overwrite} from 'utility-types';
 
-  export interface Assets {
+  export type Assets = {
     /**
      * If `metadata.image` is a collocated image path, this entry will be the
      * bundler-generated image path. Otherwise, it's empty, and the image URL
@@ -25,13 +25,9 @@ declare module '@docusaurus/plugin-content-blog' {
      * should be accessed through `authors.imageURL`.
      */
     authorsImageUrls: (string | undefined)[];
-  }
+  };
 
-  /**
-   * Unknown keys are allowed, so that we can pass custom fields to authors,
-   * e.g., `twitter`.
-   */
-  export interface Author extends Record<string, unknown> {
+  export type Author = {
     /**
      * If `name` doesn't exist, an `imageURL` is expected.
      */
@@ -55,7 +51,12 @@ declare module '@docusaurus/plugin-content-blog' {
      * to generate a fallback `mailto:` URL.
      */
     email?: string;
-  }
+    /**
+     * Unknown keys are allowed, so that we can pass custom fields to authors,
+     * e.g., `twitter`.
+     */
+    [key: string]: unknown;
+  };
 
   /**
    * Everything is partial/unnormalized, because front matter is always
@@ -443,8 +444,6 @@ declare module '@theme/BlogPostPage' {
   >;
 
   export type Content = {
-    // TODO remove this. `metadata.frontMatter` is preferred because it can be
-    // accessed in enhanced plugins
     /** Same as `metadata.frontMatter` */
     readonly frontMatter: FrontMatter;
     /**

package/src/types.ts

@@ -11,39 +11,41 @@ import type {Metadata as BlogPaginatedMetadata} from '@theme/BlogListPage';
 
 export type BlogContentPaths = ContentPaths;
 
-export interface BlogContent {
+export type BlogContent = {
   blogSidebarTitle: string;
   blogPosts: BlogPost[];
   blogListPaginated: BlogPaginated[];
   blogTags: BlogTags;
   blogTagsListPath: string | null;
-}
+};
 
-export interface BlogTags {
+export type BlogTags = {
   // TODO, the key is the tag slug/permalink
   // This is due to legacy frontmatter: tags:
   // [{label: "xyz", permalink: "/1"}, {label: "xyz", permalink: "/2"}]
   // Soon we should forbid declaring permalink through frontmatter
   [tagKey: string]: BlogTag;
-}
+};
 
-export interface BlogTag {
+export type BlogTag = {
   name: string;
-  items: string[]; // blog post permalinks
+  /** Blog post permalinks. */
+  items: string[];
   permalink: string;
   pages: BlogPaginated[];
-}
+};
 
-export interface BlogPost {
+export type BlogPost = {
   id: string;
   metadata: BlogPostMetadata;
   content: string;
-}
+};
 
-export interface BlogPaginated {
+export type BlogPaginated = {
   metadata: BlogPaginatedMetadata;
-  items: string[]; // blog post permalinks
-}
+  /** Blog post permalinks. */
+  items: string[];
+};
 
 export type BlogBrokenMarkdownLink = BrokenMarkdownLink<BlogContentPaths>;
 export type BlogMarkdownLoaderOptions = {