@docusaurus/plugin-content-blog 2.0.0-beta.8e9b829d9 → 2.0.0-beta.9

package/src/types.ts

@@ -6,27 +6,40 @@
  */
 
 import type {RemarkAndRehypePluginOptions} from '@docusaurus/mdx-loader';
-import {
+import type {Tag} from '@docusaurus/utils';
+import type {
   BrokenMarkdownLink,
   ContentPaths,
 } from '@docusaurus/utils/lib/markdownLinks';
+import {Overwrite} from 'utility-types';
+import {BlogPostFrontMatter} from './blogFrontMatter';
 
 export type BlogContentPaths = ContentPaths;
 
 export interface BlogContent {
+  blogSidebarTitle: string;
   blogPosts: BlogPost[];
   blogListPaginated: BlogPaginated[];
   blogTags: BlogTags;
   blogTagsListPath: string | null;
 }
 
-export interface DateLink {
-  date: Date;
-  link: string;
-}
-
 export type FeedType = 'rss' | 'atom';
 
+export type FeedOptions = {
+  type?: FeedType[] | null;
+  title?: string;
+  description?: string;
+  copyright: string;
+  language?: string;
+};
+
+// Feed options, as provided by user config
+export type UserFeedOptions = Overwrite<
+  Partial<FeedOptions>,
+  {type?: FeedOptions['type'] | 'all'} // Handle the type: "all" shortcut
+>;
+
 export type EditUrlFunction = (editUrlParams: {
   blogDirPath: string;
   blogPath: string;
@@ -34,13 +47,33 @@ export type EditUrlFunction = (editUrlParams: {
   locale: string;
 }) => string | undefined;
 
-export interface PluginOptions extends RemarkAndRehypePluginOptions {
+// Duplicate from ngryman/reading-time to keep stability of API
+type ReadingTimeOptions = {
+  wordsPerMinute?: number;
+  wordBound?: (char: string) => boolean;
+};
+
+export type ReadingTimeFunction = (params: {
+  content: string;
+  frontMatter?: BlogPostFrontMatter & Record<string, unknown>;
+  options?: ReadingTimeOptions;
+}) => number;
+
+export type ReadingTimeFunctionOption = (
+  params: Required<Omit<Parameters<ReadingTimeFunction>[0], 'options'>> & {
+    defaultReadingTime: ReadingTimeFunction;
+  },
+) => number | undefined;
+
+export type PluginOptions = RemarkAndRehypePluginOptions & {
   id?: string;
   path: string;
   routeBasePath: string;
+  tagsBasePath: string;
+  archiveBasePath: string;
   include: string[];
   exclude: string[];
-  postsPerPage: number;
+  postsPerPage: number | 'ALL';
   blogListComponent: string;
   blogPostComponent: string;
   blogTagsListComponent: string;
@@ -52,7 +85,7 @@ export interface PluginOptions extends RemarkAndRehypePluginOptions {
   truncateMarker: RegExp;
   showReadingTime: boolean;
   feedOptions: {
-    type?: [FeedType] | null;
+    type?: FeedType[] | null;
     title?: string;
     description?: string;
     copyright: string;
@@ -61,7 +94,15 @@ export interface PluginOptions extends RemarkAndRehypePluginOptions {
   editUrl?: string | EditUrlFunction;
   editLocalizedFiles?: boolean;
   admonitions: Record<string, unknown>;
-}
+  authorsMapPath: string;
+  readingTime: ReadingTimeFunctionOption;
+};
+
+// Options, as provided in the user config (before normalization)
+export type UserPluginOptions = Overwrite<
+  Partial<PluginOptions>,
+  {feedOptions?: UserFeedOptions}
+>;
 
 export interface BlogTags {
   [key: string]: BlogTag;
@@ -76,6 +117,7 @@ export interface BlogTag {
 export interface BlogPost {
   id: string;
   metadata: MetaData;
+  content: string;
 }
 
 export interface BlogPaginatedMetadata {
@@ -95,28 +137,37 @@ export interface BlogPaginated {
   items: string[];
 }
 
+// We allow passing custom fields to authors, e.g., twitter
+export interface Author extends Record<string, unknown> {
+  name?: string;
+  imageURL?: string;
+  url?: string;
+  title?: string;
+}
+
 export interface MetaData {
   permalink: string;
   source: string;
   description: string;
   date: Date;
   formattedDate: string;
-  tags: (Tag | string)[];
+  tags: Tag[];
   title: string;
   readingTime?: number;
   prevItem?: Paginator;
   nextItem?: Paginator;
   truncated: boolean;
   editUrl?: string;
+  authors: Author[];
 }
 
-export interface Paginator {
-  title: string;
-  permalink: string;
+export interface Assets {
+  image?: string;
+  authorsImageUrls: (string | undefined)[]; // Array of same size as the original MetaData.authors array
 }
 
-export interface Tag {
-  label: string;
+export interface Paginator {
+  title: string;
   permalink: string;
 }