@docusaurus/plugin-content-blog 2.0.0-beta.ff31de0ff → 2.0.0-rc.1

package/src/types.ts

@@ -5,141 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import type {RemarkAndRehypePluginOptions} from '@docusaurus/mdx-loader';
-import {
-  BrokenMarkdownLink,
-  ContentPaths,
-} from '@docusaurus/utils/lib/markdownLinks';
+import type {BrokenMarkdownLink, ContentPaths} from '@docusaurus/utils';
 
 export type BlogContentPaths = ContentPaths;
 
-export interface BlogContent {
-  blogPosts: BlogPost[];
-  blogListPaginated: BlogPaginated[];
-  blogTags: BlogTags;
-  blogTagsListPath: string | null;
-}
-
-export interface DateLink {
-  date: Date;
-  link: string;
-}
-
-export type FeedType = 'rss' | 'atom';
-
-export type EditUrlFunction = (editUrlParams: {
-  blogDirPath: string;
-  blogPath: string;
-  permalink: string;
-  locale: string;
-}) => string | undefined;
-
-export interface PluginOptions extends RemarkAndRehypePluginOptions {
-  id?: string;
-  path: string;
-  routeBasePath: string;
-  include: string[];
-  postsPerPage: number;
-  blogListComponent: string;
-  blogPostComponent: string;
-  blogTagsListComponent: string;
-  blogTagsPostsComponent: string;
-  blogTitle: string;
-  blogDescription: string;
-  blogSidebarCount: number | 'ALL';
-  blogSidebarTitle: string;
-  truncateMarker: RegExp;
-  showReadingTime: boolean;
-  feedOptions: {
-    type?: [FeedType] | null;
-    title?: string;
-    description?: string;
-    copyright: string;
-    language?: string;
-  };
-  editUrl?: string | EditUrlFunction;
-  editLocalizedFiles?: boolean;
-  admonitions: Record<string, unknown>;
-}
-
-export interface BlogTags {
-  [key: string]: BlogTag;
-}
-
-export interface BlogTag {
-  name: string;
-  items: string[];
-  permalink: string;
-}
-
-export interface BlogPost {
-  id: string;
-  metadata: MetaData;
-}
-
-export interface BlogPaginatedMetadata {
-  permalink: string;
-  page: number;
-  postsPerPage: number;
-  totalPages: number;
-  totalCount: number;
-  previousPage: string | null;
-  nextPage: string | null;
-  blogTitle: string;
-  blogDescription: string;
-}
-
-export interface BlogPaginated {
-  metadata: BlogPaginatedMetadata;
-  items: string[];
-}
-
-export interface MetaData {
-  permalink: string;
-  source: string;
-  description: string;
-  date: Date;
-  formattedDate: string;
-  tags: (Tag | string)[];
-  title: string;
-  readingTime?: number;
-  prevItem?: Paginator;
-  nextItem?: Paginator;
-  truncated: boolean;
-  editUrl?: string;
-}
-
-export interface Paginator {
-  title: string;
-  permalink: string;
-}
-
-export interface Tag {
-  label: string;
-  permalink: string;
-}
-
-export interface BlogItemsToMetadata {
-  [key: string]: MetaData;
-}
-
-export interface TagsModule {
-  [key: string]: TagModule;
-}
-
-export interface TagModule {
-  allTagsPath: string;
-  slug: string;
-  name: string;
-  count: number;
-  permalink: string;
-}
-
 export type BlogBrokenMarkdownLink = BrokenMarkdownLink<BlogContentPaths>;
 export type BlogMarkdownLoaderOptions = {
   siteDir: string;
   contentPaths: BlogContentPaths;
   truncateMarker: RegExp;
-  sourceToPermalink: Record<string, string>;
+  sourceToPermalink: {[aliasedPath: string]: string};
   onBrokenMarkdownLink: (brokenMarkdownLink: BlogBrokenMarkdownLink) => void;
 };

package/index.d.ts

@@ -1,138 +0,0 @@
-/**
- * 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.
- */
-
-/* eslint-disable import/no-duplicates */
-/* eslint-disable camelcase */
-
-declare module '@theme/BlogSidebar' {
-  export type BlogSidebarItem = {title: string; permalink: string};
-  export type BlogSidebar = {
-    title: string;
-    items: BlogSidebarItem[];
-  };
-
-  export type Props = {
-    readonly sidebar: BlogSidebar;
-  };
-
-  const BlogSidebar: (props: Props) => JSX.Element;
-  export default BlogSidebar;
-}
-
-declare module '@theme/BlogPostPage' {
-  import type {TOCItem} from '@docusaurus/types';
-  import type {BlogSidebar} from '@theme/BlogSidebar';
-
-  export type FrontMatter = {
-    readonly title: string;
-    readonly author?: string;
-    readonly image?: string;
-    readonly tags?: readonly string[];
-    readonly keywords?: readonly string[];
-    readonly author_url?: string;
-    readonly authorURL?: string;
-    readonly author_title?: string;
-    readonly authorTitle?: string;
-    readonly author_image_url?: string;
-    readonly authorImageURL?: string;
-    readonly hide_table_of_contents?: boolean;
-  };
-
-  export type Metadata = {
-    readonly title: string;
-    readonly date: string;
-    readonly formattedDate: string;
-    readonly permalink: string;
-    readonly description?: string;
-    readonly editUrl?: string;
-    readonly readingTime?: number;
-    readonly truncated?: string;
-    readonly nextItem?: {readonly title: string; readonly permalink: string};
-    readonly prevItem?: {readonly title: string; readonly permalink: string};
-    readonly tags: readonly {
-      readonly label: string;
-      readonly permalink: string;
-    }[];
-  };
-
-  export type Content = {
-    readonly frontMatter: FrontMatter;
-    readonly metadata: Metadata;
-    readonly toc: readonly TOCItem[];
-    (): JSX.Element;
-  };
-
-  export type Props = {
-    readonly sidebar: BlogSidebar;
-    readonly content: Content;
-  };
-
-  const BlogPostPage: (props: Props) => JSX.Element;
-  export default BlogPostPage;
-}
-
-declare module '@theme/BlogListPage' {
-  import type {Content} from '@theme/BlogPostPage';
-  import type {BlogSidebar} from '@theme/BlogSidebar';
-
-  export type Item = {
-    readonly content: () => JSX.Element;
-  };
-
-  export type Metadata = {
-    readonly blogTitle: string;
-    readonly blogDescription: string;
-    readonly nextPage?: string;
-    readonly page: number;
-    readonly permalink: string;
-    readonly postsPerPage: number;
-    readonly previousPage?: string;
-    readonly totalCount: number;
-    readonly totalPages: number;
-  };
-
-  export type Props = {
-    readonly sidebar: BlogSidebar;
-    readonly metadata: Metadata;
-    readonly items: readonly {readonly content: Content}[];
-  };
-
-  const BlogListPage: (props: Props) => JSX.Element;
-  export default BlogListPage;
-}
-
-declare module '@theme/BlogTagsListPage' {
-  import type {BlogSidebar} from '@theme/BlogSidebar';
-
-  export type Tag = {
-    permalink: string;
-    name: string;
-    count: number;
-    allTagsPath: string;
-    slug: string;
-  };
-
-  export type Props = {
-    readonly sidebar: BlogSidebar;
-    readonly tags: Readonly<Record<string, Tag>>;
-  };
-
-  const BlogTagsListPage: (props: Props) => JSX.Element;
-  export default BlogTagsListPage;
-}
-
-declare module '@theme/BlogTagsPostsPage' {
-  import type {BlogSidebar} from '@theme/BlogSidebar';
-  import type {Tag} from '@theme/BlogTagsListPage';
-  import type {Content} from '@theme/BlogPostPage';
-
-  export type Props = {
-    readonly sidebar: BlogSidebar;
-    readonly metadata: Tag;
-    readonly items: readonly {readonly content: Content}[];
-  };
-}