@docusaurus/plugin-content-blog 0.0.0-4944 → 0.0.0-4947

package/lib/blogUtils.d.ts

@@ -4,9 +4,9 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { BlogPost, BlogContentPaths, BlogMarkdownLoaderOptions, BlogTags, BlogPaginated } from './types';
+import type { BlogContentPaths, BlogMarkdownLoaderOptions } from './types';
 import type { LoadContext } from '@docusaurus/types';
-import type { PluginOptions } from '@docusaurus/plugin-content-blog';
+import type { PluginOptions, BlogPost, BlogTags, BlogPaginated } from '@docusaurus/plugin-content-blog';
 export declare function truncate(fileString: string, truncateMarker: RegExp): string;
 export declare function getSourceToPermalink(blogPosts: BlogPost[]): {
     [aliasedPath: string]: string;

package/lib/feed.d.ts

@@ -4,9 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { BlogPost } from './types';
 import type { DocusaurusConfig } from '@docusaurus/types';
-import type { PluginOptions } from '@docusaurus/plugin-content-blog';
+import type { PluginOptions, BlogPost } from '@docusaurus/plugin-content-blog';
 export declare function createBlogFeedFiles({ blogPosts, options, siteConfig, outDir, locale, }: {
     blogPosts: BlogPost[];
     options: PluginOptions;

package/lib/index.d.ts

@@ -4,8 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { BlogContent } from './types';
 import type { LoadContext, Plugin } from '@docusaurus/types';
-import type { PluginOptions } from '@docusaurus/plugin-content-blog';
+import type { PluginOptions, BlogContent } from '@docusaurus/plugin-content-blog';
 export default function pluginContentBlog(context: LoadContext, options: PluginOptions): Promise<Plugin<BlogContent>>;
 export { validateOptions } from './options';

package/lib/translations.d.ts

@@ -4,8 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { BlogContent } from './types';
 import type { TranslationFile } from '@docusaurus/types';
-import type { PluginOptions } from '@docusaurus/plugin-content-blog';
+import type { PluginOptions, BlogContent } from '@docusaurus/plugin-content-blog';
 export declare function getTranslationFiles(options: PluginOptions): TranslationFile[];
 export declare function translateContent(content: BlogContent, translationFiles: TranslationFile[]): BlogContent;

package/lib/types.d.ts

@@ -5,35 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { BrokenMarkdownLink, ContentPaths } from '@docusaurus/utils';
-import type { Tag } from '@docusaurus/types';
-import type { BlogPostMetadata } from '@docusaurus/plugin-content-blog';
-import type { Metadata as BlogPaginatedMetadata } from '@theme/BlogListPage';
 export declare type BlogContentPaths = ContentPaths;
-export declare type BlogContent = {
-    blogSidebarTitle: string;
-    blogPosts: BlogPost[];
-    blogListPaginated: BlogPaginated[];
-    blogTags: BlogTags;
-    blogTagsListPath: string;
-};
-export declare type BlogTags = {
-    [permalink: string]: BlogTag;
-};
-export declare type BlogTag = Tag & {
-    /** Blog post permalinks. */
-    items: string[];
-    pages: BlogPaginated[];
-};
-export declare type BlogPost = {
-    id: string;
-    metadata: BlogPostMetadata;
-    content: string;
-};
-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-4944",
+  "version": "0.0.0-4947",
   "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-4944",
-    "@docusaurus/logger": "0.0.0-4944",
-    "@docusaurus/mdx-loader": "0.0.0-4944",
-    "@docusaurus/utils": "0.0.0-4944",
-    "@docusaurus/utils-common": "0.0.0-4944",
-    "@docusaurus/utils-validation": "0.0.0-4944",
+    "@docusaurus/core": "0.0.0-4947",
+    "@docusaurus/logger": "0.0.0-4947",
+    "@docusaurus/mdx-loader": "0.0.0-4947",
+    "@docusaurus/utils": "0.0.0-4947",
+    "@docusaurus/utils-common": "0.0.0-4947",
+    "@docusaurus/utils-validation": "0.0.0-4947",
     "cheerio": "^1.0.0-rc.10",
     "feed": "^4.2.2",
     "fs-extra": "^10.1.0",
@@ -36,7 +36,7 @@
     "webpack": "^5.72.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "0.0.0-4944",
+    "@docusaurus/types": "0.0.0-4947",
     "escape-string-regexp": "^4.0.0"
   },
   "peerDependencies": {
@@ -46,5 +46,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "040fca0321d0539c16b21edc191af3142642b8c0"
+  "gitHead": "29ca5e7b0c611abdb0a1833411adc26873aee174"
 }

package/src/blogUtils.ts

@@ -9,13 +9,7 @@ import fs from 'fs-extra';
 import path from 'path';
 import readingTime from 'reading-time';
 import _ from 'lodash';
-import type {
-  BlogPost,
-  BlogContentPaths,
-  BlogMarkdownLoaderOptions,
-  BlogTags,
-  BlogPaginated,
-} from './types';
+import type {BlogContentPaths, BlogMarkdownLoaderOptions} from './types';
 import {
   parseMarkdownString,
   normalizeUrl,
@@ -37,6 +31,9 @@ import logger from '@docusaurus/logger';
 import type {
   PluginOptions,
   ReadingTimeFunction,
+  BlogPost,
+  BlogTags,
+  BlogPaginated,
 } from '@docusaurus/plugin-content-blog';
 
 export function truncate(fileString: string, truncateMarker: RegExp): string {

package/src/feed.ts

@@ -6,7 +6,6 @@
  */
 
 import {Feed, type Author as FeedAuthor, type Item as FeedItem} from 'feed';
-import type {BlogPost} from './types';
 import {normalizeUrl, readOutputHTMLFile} from '@docusaurus/utils';
 import {load as cheerioLoad} from 'cheerio';
 import type {DocusaurusConfig} from '@docusaurus/types';
@@ -16,6 +15,7 @@ import type {
   FeedType,
   PluginOptions,
   Author,
+  BlogPost,
 } from '@docusaurus/plugin-content-blog';
 import {blogPostContainerID} from '@docusaurus/utils-common';
 

package/src/index.ts

@@ -20,24 +20,13 @@ import {
   getContentPathList,
   getDataFilePath,
   DEFAULT_PLUGIN_ID,
+  type TagsListItem,
+  type TagModule,
 } from '@docusaurus/utils';
 import {translateContent, getTranslationFiles} from './translations';
 
-import type {
-  BlogTag,
-  BlogTags,
-  BlogContent,
-  BlogPaginated,
-  BlogContentPaths,
-  BlogMarkdownLoaderOptions,
-} from './types';
-import type {
-  LoadContext,
-  Plugin,
-  HtmlTags,
-  TagsListItem,
-  TagModule,
-} from '@docusaurus/types';
+import type {BlogContentPaths, BlogMarkdownLoaderOptions} from './types';
+import type {LoadContext, Plugin, HtmlTags} from '@docusaurus/types';
 import {
   generateBlogPosts,
   getSourceToPermalink,
@@ -50,6 +39,10 @@ import type {
   BlogPostFrontMatter,
   BlogPostMetadata,
   Assets,
+  BlogTag,
+  BlogTags,
+  BlogContent,
+  BlogPaginated,
 } from '@docusaurus/plugin-content-blog';
 
 export default async function pluginContentBlog(

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

@@ -7,9 +7,9 @@
 
 declare module '@docusaurus/plugin-content-blog' {
   import type {MDXOptions} from '@docusaurus/mdx-loader';
-  import type {FrontMatterTag} from '@docusaurus/utils';
+  import type {FrontMatterTag, Tag} from '@docusaurus/utils';
+  import type {Plugin, LoadContext} from '@docusaurus/types';
   import type {Overwrite} from 'utility-types';
-  import type {Tag} from '@docusaurus/types';
 
   export type Assets = {
     /**
@@ -411,6 +411,62 @@ declare module '@docusaurus/plugin-content-blog' {
     title: string;
     items: {title: string; permalink: string}[];
   };
+
+  export type BlogContent = {
+    blogSidebarTitle: string;
+    blogPosts: BlogPost[];
+    blogListPaginated: BlogPaginated[];
+    blogTags: BlogTags;
+    blogTagsListPath: string;
+  };
+
+  export type BlogTags = {
+    [permalink: string]: BlogTag;
+  };
+
+  export type BlogTag = Tag & {
+    /** Blog post permalinks. */
+    items: string[];
+    pages: BlogPaginated[];
+  };
+
+  export type BlogPost = {
+    id: string;
+    metadata: BlogPostMetadata;
+    content: string;
+  };
+
+  export type BlogPaginatedMetadata = {
+    /** Title of the entire blog. */
+    readonly blogTitle: string;
+    /** Blog description. */
+    readonly blogDescription: string;
+    /** Permalink to the next list page. */
+    readonly nextPage?: string;
+    /** Permalink of the current page. */
+    readonly permalink: string;
+    /** Permalink to the previous list page. */
+    readonly previousPage?: string;
+    /** Index of the current page, 1-based. */
+    readonly page: number;
+    /** Posts displayed on each list page. */
+    readonly postsPerPage: number;
+    /** Total number of posts in the entire blog. */
+    readonly totalCount: number;
+    /** Total number of list pages. */
+    readonly totalPages: number;
+  };
+
+  export type BlogPaginated = {
+    metadata: BlogPaginatedMetadata;
+    /** Blog post permalinks. */
+    items: string[];
+  };
+
+  export default function pluginContentBlog(
+    context: LoadContext,
+    options: PluginOptions,
+  ): Promise<Plugin<BlogContent>>;
 }
 
 declare module '@theme/BlogPostPage' {
@@ -447,34 +503,16 @@ declare module '@theme/BlogPostPage' {
 
 declare module '@theme/BlogListPage' {
   import type {Content} from '@theme/BlogPostPage';
-  import type {BlogSidebar} from '@docusaurus/plugin-content-blog';
-
-  export type Metadata = {
-    /** Title of the entire blog. */
-    readonly blogTitle: string;
-    /** Blog description. */
-    readonly blogDescription: string;
-    /** Permalink to the next list page. */
-    readonly nextPage?: string;
-    /** Permalink of the current page. */
-    readonly permalink: string;
-    /** Permalink to the previous list page. */
-    readonly previousPage?: string;
-    /** Index of the current page, 1-based. */
-    readonly page: number;
-    /** Posts displayed on each list page. */
-    readonly postsPerPage: number;
-    /** Total number of posts in the entire blog. */
-    readonly totalCount: number;
-    /** Total number of list pages. */
-    readonly totalPages: number;
-  };
+  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: Metadata;
+    readonly metadata: BlogPaginatedMetadata;
     /**
      * Array of blog posts included on this page. Every post's metadata is also
      * available.
@@ -487,7 +525,7 @@ declare module '@theme/BlogListPage' {
 
 declare module '@theme/BlogTagsListPage' {
   import type {BlogSidebar} from '@docusaurus/plugin-content-blog';
-  import type {TagsListItem} from '@docusaurus/types';
+  import type {TagsListItem} from '@docusaurus/utils';
 
   export interface Props {
     /** Blog sidebar. */
@@ -500,10 +538,12 @@ declare module '@theme/BlogTagsListPage' {
 }
 
 declare module '@theme/BlogTagsPostsPage' {
-  import type {BlogSidebar} from '@docusaurus/plugin-content-blog';
+  import type {
+    BlogSidebar,
+    BlogPaginatedMetadata,
+  } from '@docusaurus/plugin-content-blog';
   import type {Content} from '@theme/BlogPostPage';
-  import type {Metadata} from '@theme/BlogListPage';
-  import type {TagModule} from '@docusaurus/types';
+  import type {TagModule} from '@docusaurus/utils';
 
   export interface Props {
     /** Blog sidebar. */
@@ -511,7 +551,7 @@ declare module '@theme/BlogTagsPostsPage' {
     /** Metadata of this tag. */
     readonly tag: TagModule;
     /** Looks exactly the same as the posts list page */
-    readonly listMetadata: Metadata;
+    readonly listMetadata: BlogPaginatedMetadata;
     /**
      * Array of blog posts included on this page. Every post's metadata is also
      * available.

package/src/translations.ts

@@ -5,9 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import type {BlogContent, BlogPaginated} from './types';
 import type {TranslationFileContent, TranslationFile} from '@docusaurus/types';
-import type {PluginOptions} from '@docusaurus/plugin-content-blog';
+import type {
+  PluginOptions,
+  BlogContent,
+  BlogPaginated,
+} from '@docusaurus/plugin-content-blog';
 
 function translateListPage(
   blogListPaginated: BlogPaginated[],

package/src/types.ts

@@ -6,42 +6,9 @@
  */
 
 import type {BrokenMarkdownLink, ContentPaths} from '@docusaurus/utils';
-import type {Tag} from '@docusaurus/types';
-import type {BlogPostMetadata} from '@docusaurus/plugin-content-blog';
-import type {Metadata as BlogPaginatedMetadata} from '@theme/BlogListPage';
 
 export type BlogContentPaths = ContentPaths;
 
-export type BlogContent = {
-  blogSidebarTitle: string;
-  blogPosts: BlogPost[];
-  blogListPaginated: BlogPaginated[];
-  blogTags: BlogTags;
-  blogTagsListPath: string;
-};
-
-export type BlogTags = {
-  [permalink: string]: BlogTag;
-};
-
-export type BlogTag = Tag & {
-  /** Blog post permalinks. */
-  items: string[];
-  pages: BlogPaginated[];
-};
-
-export type BlogPost = {
-  id: string;
-  metadata: BlogPostMetadata;
-  content: string;
-};
-
-export type BlogPaginated = {
-  metadata: BlogPaginatedMetadata;
-  /** Blog post permalinks. */
-  items: string[];
-};
-
 export type BlogBrokenMarkdownLink = BrokenMarkdownLink<BlogContentPaths>;
 export type BlogMarkdownLoaderOptions = {
   siteDir: string;