@azerion/bunosaurus-plugin-content-blog 0.0.0-stage → 4.0.0

package/README.md

@@ -1,3 +1,7 @@
-# Temporary Holding Version
+# `@docusaurus/plugin-content-blog`
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Blog plugin for Docusaurus.
+
+## Usage
+
+See [plugin-content-blog documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).

package/assets/atom.css

@@ -0,0 +1,81 @@
+/**
+ * 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.
+ */
+
+main {
+  flex: 1 0 auto;
+  width: 100%;
+  margin: 2rem auto;
+  max-width: 800px;
+  /* stylelint-disable-next-line font-family-name-quotes */
+  font-family:
+    system-ui,
+    -apple-system,
+    'Segoe UI',
+    Roboto,
+    Ubuntu,
+    Cantarell;
+}
+
+.info {
+  display: block;
+  margin: 2rem 0;
+  padding: 1.6rem 2.4rem;
+  border: 1px solid dodgerblue;
+  border-left-width: 0.5rem;
+  border-radius: 0.4rem;
+  background-color: #edf5ff;
+}
+
+a {
+  color: #005aff;
+  text-decoration: none;
+}
+
+h1 {
+  text-wrap: balance;
+  font-size: 3.4rem;
+  font-weight: 800;
+  margin-bottom: 2rem;
+  display: flex;
+  align-items: center;
+}
+
+h1 .rss-icon {
+  height: 3.2rem;
+  width: 3.2rem;
+  margin-right: 1rem;
+}
+
+h2 {
+  font-size: 2.2rem;
+  font-weight: 700;
+  margin-bottom: 0.2rem;
+}
+
+h3 {
+  font-size: 1.8rem;
+  font-weight: 700;
+  margin-bottom: 0.1rem;
+}
+
+.blog-description {
+  font-size: 1.4rem;
+  margin-bottom: 0.6rem;
+}
+
+.blog-post-date {
+  font-size: 1rem;
+  line-height: 1.4rem;
+  font-style: italic;
+  color: #797b7e;
+}
+
+.blog-post-description {
+  font-size: 1rem;
+  line-height: 1.4rem;
+  color: #434349;
+}

package/assets/atom.xsl

@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="UTF-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.
+-->
+<xsl:stylesheet
+  version="3.0"
+  xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+  xmlns:atom="http://www.w3.org/2005/Atom">
+  <xsl:output method="html" version="1.0" encoding="UTF-8" indent="yes" />
+
+  <xsl:template match="/">
+    <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+      <head>
+        <title>Atom Feed | <xsl:value-of
+            select="atom:feed/atom:title"
+          /></title>
+        <link rel="stylesheet" href="atom.css" />
+      </head>
+      <body>
+        <main>
+          <div class="description">
+            <div class="info">
+              <strong>This is an Atom feed</strong>. Subscribe by copying the URL
+              from the address bar into your newsreader. Visit
+              <a href="https://aboutfeeds.com/">About Feeds</a> to learn more
+              and get started. It’s free.
+            </div>
+            <h1>
+              <div class="rss-icon">
+                <svg
+                  version="1.1"
+                  id="Capa_1"
+                  xmlns="http://www.w3.org/2000/svg"
+                  xmlns:xlink="http://www.w3.org/1999/xlink"
+                  viewBox="0 0 455.731 455.731"
+                  xml:space="preserve">
+                  <g>
+                    <rect
+                      x="0"
+                      y="0"
+                      style="fill: #f78422"
+                      width="455.731"
+                      height="455.731"
+                    />
+                    <g>
+                      <path
+                        style="fill: #ffffff"
+                        d="M296.208,159.16C234.445,97.397,152.266,63.382,64.81,63.382v64.348
+                c70.268,0,136.288,27.321,185.898,76.931c49.609,49.61,76.931,115.63,76.931,185.898h64.348
+                C391.986,303.103,357.971,220.923,296.208,159.16z"
+                      />
+                      <path
+                        style="fill: #ffffff"
+                        d="M64.143,172.273v64.348c84.881,0,153.938,69.056,153.938,153.939h64.348
+                C282.429,270.196,184.507,172.273,64.143,172.273z"
+                      />
+                      <circle
+                        style="fill: #ffffff"
+                        cx="109.833"
+                        cy="346.26"
+                        r="46.088"
+                      />
+                    </g>
+                  </g>
+                </svg>
+              </div>
+              <xsl:value-of select="atom:feed/atom:title" />
+            </h1>
+            <p class="blog-description">
+              <xsl:value-of select="atom:feed/atom:subtitle" />
+            </p>
+          </div>
+          <h2>Recent Posts</h2>
+          <div class="blog-posts">
+            <xsl:for-each select="atom:feed/atom:entry">
+              <div class="blog-post">
+                <h3><a href="{atom:link/@href}"><xsl:value-of
+                      select="atom:title"
+                    /></a></h3>
+                <div class="blog-post-date">
+                  Published on <xsl:value-of
+                    select="substring(atom:updated,0,11)"
+                  />
+                </div>
+                <div class="blog-post-description">
+                  <xsl:value-of select="atom:summary" />
+                </div>
+              </div>
+            </xsl:for-each>
+          </div>
+        </main>
+      </body>
+    </html>
+  </xsl:template>
+</xsl:stylesheet>

package/assets/rss.css

@@ -0,0 +1,81 @@
+/**
+ * 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.
+ */
+
+main {
+  flex: 1 0 auto;
+  width: 100%;
+  margin: 2rem auto;
+  max-width: 800px;
+  /* stylelint-disable-next-line font-family-name-quotes */
+  font-family:
+    system-ui,
+    -apple-system,
+    'Segoe UI',
+    Roboto,
+    Ubuntu,
+    Cantarell;
+}
+
+.info {
+  display: block;
+  margin: 2rem 0;
+  padding: 1.6rem 2.4rem;
+  border: 1px solid dodgerblue;
+  border-left-width: 0.5rem;
+  border-radius: 0.4rem;
+  background-color: #edf5ff;
+}
+
+a {
+  color: #005aff;
+  text-decoration: none;
+}
+
+h1 {
+  text-wrap: balance;
+  font-size: 3.4rem;
+  font-weight: 800;
+  margin-bottom: 2rem;
+  display: flex;
+  align-items: center;
+}
+
+h1 .rss-icon {
+  height: 3.2rem;
+  width: 3.2rem;
+  margin-right: 1rem;
+}
+
+h2 {
+  font-size: 2.2rem;
+  font-weight: 700;
+  margin-bottom: 0.2rem;
+}
+
+h3 {
+  font-size: 1.8rem;
+  font-weight: 700;
+  margin-bottom: 0.1rem;
+}
+
+.blog-description {
+  font-size: 1.4rem;
+  margin-bottom: 0.6rem;
+}
+
+.blog-post-date {
+  font-size: 1rem;
+  line-height: 1.4rem;
+  font-style: italic;
+  color: #797b7e;
+}
+
+.blog-post-description {
+  font-size: 1rem;
+  line-height: 1.4rem;
+  color: #434349;
+}

package/assets/rss.xsl

@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="UTF-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.
+-->
+<xsl:stylesheet
+  version="3.0"
+  xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+  xmlns:atom="http://www.w3.org/2005/Atom">
+  <xsl:output method="html" version="1.0" encoding="UTF-8" indent="yes" />
+
+  <xsl:template match="/">
+    <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+      <head>
+        <title>RSS Feed | <xsl:value-of select="rss/channel/title" /></title>
+        <link rel="stylesheet" href="rss.css" />
+      </head>
+      <body>
+        <main>
+          <div class="description">
+            <div class="info">
+              <strong>This is an RSS feed</strong>. Subscribe by copying the URL
+              from the address bar into your newsreader. Visit
+              <a href="https://aboutfeeds.com/">About Feeds</a> to learn more
+              and get started. It’s free.
+            </div>
+            <h1>
+              <div class="rss-icon">
+                <svg
+                  version="1.1"
+                  id="Capa_1"
+                  xmlns="http://www.w3.org/2000/svg"
+                  xmlns:xlink="http://www.w3.org/1999/xlink"
+                  viewBox="0 0 455.731 455.731"
+                  xml:space="preserve">
+                  <g>
+                    <rect
+                      x="0"
+                      y="0"
+                      style="fill: #f78422"
+                      width="455.731"
+                      height="455.731"
+                    />
+                    <g>
+                      <path
+                        style="fill: #ffffff"
+                        d="M296.208,159.16C234.445,97.397,152.266,63.382,64.81,63.382v64.348
+                c70.268,0,136.288,27.321,185.898,76.931c49.609,49.61,76.931,115.63,76.931,185.898h64.348
+                C391.986,303.103,357.971,220.923,296.208,159.16z"
+                      />
+                      <path
+                        style="fill: #ffffff"
+                        d="M64.143,172.273v64.348c84.881,0,153.938,69.056,153.938,153.939h64.348
+                C282.429,270.196,184.507,172.273,64.143,172.273z"
+                      />
+                      <circle
+                        style="fill: #ffffff"
+                        cx="109.833"
+                        cy="346.26"
+                        r="46.088"
+                      />
+                    </g>
+                  </g>
+                </svg>
+              </div>
+              <xsl:value-of select="rss/channel/title" />
+            </h1>
+            <p class="blog-description">
+              <xsl:value-of select="rss/channel/description" />
+            </p>
+          </div>
+          <h2>Recent Posts</h2>
+          <div class="blog-posts">
+            <xsl:for-each select="rss/channel/item">
+              <div class="blog-post">
+                <h3><a href="{link}"><xsl:value-of select="title" /></a></h3>
+                <div class="blog-post-date">
+                  Published on <xsl:value-of select="substring(pubDate,0,17)" />
+                </div>
+                <div class="blog-post-description">
+                  <xsl:value-of select="description" />
+                </div>
+              </div>
+            </xsl:for-each>
+          </div>
+        </main>
+      </body>
+    </html>
+  </xsl:template>
+</xsl:stylesheet>

package/lib/authors.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 { Author, AuthorsMap, BlogPost, BlogPostFrontMatter } from '@docusaurus/plugin-content-blog';
+type AuthorsParam = {
+    frontMatter: BlogPostFrontMatter;
+    authorsMap: AuthorsMap | undefined;
+    baseUrl: string;
+};
+export declare function normalizeImageUrl({ imageURL, baseUrl, }: {
+    imageURL: string | undefined;
+    baseUrl: string;
+}): string | undefined;
+export declare function getBlogPostAuthors(params: AuthorsParam): Author[];
+/**
+ * Group blog posts by author key
+ * Blog posts with only inline authors are ignored
+ */
+export declare function groupBlogPostsByAuthorKey({ blogPosts, authorsMap, }: {
+    blogPosts: BlogPost[];
+    authorsMap: AuthorsMap | undefined;
+}): Record<string, BlogPost[]>;
+export {};

package/lib/authors.js

@@ -0,0 +1,132 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeImageUrl = normalizeImageUrl;
+exports.getBlogPostAuthors = getBlogPostAuthors;
+exports.groupBlogPostsByAuthorKey = groupBlogPostsByAuthorKey;
+const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const utils_1 = require("@docusaurus/utils");
+const authorsSocials_1 = require("./authorsSocials");
+function normalizeImageUrl({ imageURL, baseUrl, }) {
+    return imageURL?.startsWith('/')
+        ? (0, utils_1.normalizeUrl)([baseUrl, imageURL])
+        : imageURL;
+}
+function normalizeAuthorUrl({ author, baseUrl, }) {
+    if (author.key) {
+        // Ensures invariant: global authors should have already been normalized
+        if (author.imageURL?.startsWith('/') &&
+            !author.imageURL.startsWith(baseUrl)) {
+            throw new Error(`Docusaurus internal bug: global authors image ${author.imageURL} should start with the expected baseUrl=${baseUrl}`);
+        }
+        return author.imageURL;
+    }
+    return normalizeImageUrl({ imageURL: author.imageURL, baseUrl });
+}
+// Legacy v1/early-v2 front matter fields
+// We may want to deprecate those in favor of using only frontMatter.authors
+// TODO Docusaurus v4: remove this legacy front matter
+function getFrontMatterAuthorLegacy({ baseUrl, frontMatter, }) {
+    const name = frontMatter.author;
+    const title = frontMatter.author_title ?? frontMatter.authorTitle;
+    const url = frontMatter.author_url ?? frontMatter.authorURL;
+    const imageURL = normalizeImageUrl({
+        imageURL: frontMatter.author_image_url ?? frontMatter.authorImageURL,
+        baseUrl,
+    });
+    if (name || title || url || imageURL) {
+        return {
+            name,
+            title,
+            url,
+            imageURL,
+            // legacy front matter authors do not have an author key/page
+            key: null,
+            page: null,
+        };
+    }
+    return undefined;
+}
+function getFrontMatterAuthors(params) {
+    const { authorsMap, frontMatter, baseUrl } = params;
+    return normalizeFrontMatterAuthors().map(toAuthor);
+    function normalizeFrontMatterAuthors() {
+        if (frontMatter.authors === undefined) {
+            return [];
+        }
+        function normalizeAuthor(authorInput) {
+            if (typeof authorInput === 'string') {
+                // We could allow users to provide an author's name here, but we only
+                // support keys, otherwise, a typo in a key would fall back to
+                // becoming a name and may end up unnoticed
+                return { key: authorInput };
+            }
+            return {
+                ...authorInput,
+                socials: (0, authorsSocials_1.normalizeSocials)(authorInput.socials ?? {}),
+            };
+        }
+        return Array.isArray(frontMatter.authors)
+            ? frontMatter.authors.map(normalizeAuthor)
+            : [normalizeAuthor(frontMatter.authors)];
+    }
+    function getAuthorsMapAuthor(key) {
+        if (key) {
+            if (!authorsMap || Object.keys(authorsMap).length === 0) {
+                throw new Error(`Can't reference blog post authors by a key (such as '${key}') because no authors map file could be loaded.
+Please double-check your blog plugin config (in particular 'authorsMapPath'), ensure the file exists at the configured path, is not empty, and is valid!`);
+            }
+            const author = authorsMap[key];
+            if (!author) {
+                throw Error(`Blog author with key "${key}" not found in the authors map file.
+Valid author keys are:
+${Object.keys(authorsMap)
+                    .map((validKey) => `- ${validKey}`)
+                    .join('\n')}`);
+            }
+            return author;
+        }
+        return undefined;
+    }
+    function toAuthor(frontMatterAuthor) {
+        const author = {
+            // Author def from authorsMap can be locally overridden by front matter
+            ...getAuthorsMapAuthor(frontMatterAuthor.key),
+            ...frontMatterAuthor,
+        };
+        return {
+            ...author,
+            key: author.key ?? null,
+            page: author.page ?? null,
+            // global author images have already been normalized
+            imageURL: normalizeAuthorUrl({ author, baseUrl }),
+        };
+    }
+}
+function getBlogPostAuthors(params) {
+    const authorLegacy = getFrontMatterAuthorLegacy(params);
+    const authors = getFrontMatterAuthors(params);
+    if (authorLegacy) {
+        // Technically, we could allow mixing legacy/authors front matter, but do we
+        // really want to?
+        if (authors.length > 0) {
+            throw new Error(`To declare blog post authors, use the 'authors' front matter in priority.
+Don't mix 'authors' with other existing 'author_*' front matter. Choose one or the other, not both at the same time.`);
+        }
+        return [authorLegacy];
+    }
+    return authors;
+}
+/**
+ * Group blog posts by author key
+ * Blog posts with only inline authors are ignored
+ */
+function groupBlogPostsByAuthorKey({ blogPosts, authorsMap, }) {
+    return lodash_1.default.mapValues(authorsMap, (author, key) => blogPosts.filter((p) => p.metadata.authors.some((a) => a.key === key)));
+}

package/lib/authorsMap.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 { BlogContentPaths } from './types';
+import type { AuthorAttributes, AuthorPage, AuthorsMap } from '@docusaurus/plugin-content-blog';
+type AuthorInput = AuthorAttributes & {
+    page?: boolean | AuthorPage;
+};
+export type AuthorsMapInput = {
+    [authorKey: string]: AuthorInput;
+};
+export declare function checkAuthorsMapPermalinkCollisions(authorsMap: AuthorsMap | undefined): void;
+export declare function validateAuthorsMapInput(content: unknown): AuthorsMapInput;
+export declare function getAuthorsMap(params: {
+    authorsMapPath: string;
+    authorsBaseRoutePath: string;
+    contentPaths: BlogContentPaths;
+    baseUrl: string;
+}): Promise<AuthorsMap | undefined>;
+export declare function validateAuthorsMap(content: unknown): AuthorsMapInput;
+export {};

package/lib/authorsMap.js

@@ -0,0 +1,118 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkAuthorsMapPermalinkCollisions = checkAuthorsMapPermalinkCollisions;
+exports.validateAuthorsMapInput = validateAuthorsMapInput;
+exports.getAuthorsMap = getAuthorsMap;
+exports.validateAuthorsMap = validateAuthorsMap;
+const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const utils_1 = require("@docusaurus/utils");
+const utils_validation_1 = require("@docusaurus/utils-validation");
+const authorsSocials_1 = require("./authorsSocials");
+const authors_1 = require("./authors");
+const AuthorPageSchema = utils_validation_1.Joi.object({
+    permalink: utils_validation_1.Joi.string().required(),
+});
+const AuthorsMapInputSchema = utils_validation_1.Joi.object()
+    .pattern(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
+    name: utils_validation_1.Joi.string(),
+    url: utils_validation_1.URISchema,
+    imageURL: utils_validation_1.URISchema,
+    title: utils_validation_1.Joi.string(),
+    email: utils_validation_1.Joi.string(),
+    page: utils_validation_1.Joi.alternatives(utils_validation_1.Joi.bool(), AuthorPageSchema),
+    socials: authorsSocials_1.AuthorSocialsSchema,
+    description: utils_validation_1.Joi.string(),
+})
+    .rename('image_url', 'imageURL')
+    .or('name', 'imageURL')
+    .unknown()
+    .required()
+    .messages({
+    'object.base': '{#label} should be an author object containing properties like name, title, and imageURL.',
+    'any.required': '{#label} cannot be undefined. It should be an author object containing properties like name, title, and imageURL.',
+}))
+    .messages({
+    'object.base': "The authors map file should contain an object where each entry contains an author key and the corresponding author's data.",
+});
+function checkAuthorsMapPermalinkCollisions(authorsMap) {
+    if (!authorsMap) {
+        return;
+    }
+    const permalinkCounts = (0, lodash_1.default)(authorsMap)
+        // Filter to keep only authors with a page
+        .pickBy((author) => !!author.page)
+        // Group authors by their permalink
+        .groupBy((author) => author.page?.permalink)
+        // Filter to keep only permalinks with more than one author
+        .pickBy((authors) => authors.length > 1)
+        // Transform the object into an array of [permalink, authors] pairs
+        .toPairs()
+        .value();
+    if (permalinkCounts.length > 0) {
+        const errorMessage = permalinkCounts
+            .map(([permalink, authors]) => `Permalink: ${permalink}\nAuthors: ${authors
+            .map((author) => author.name || 'Unknown')
+            .join(', ')}`)
+            .join('\n');
+        throw new Error(`The following permalinks are duplicated:\n${errorMessage}`);
+    }
+}
+function normalizeAuthor({ authorsBaseRoutePath, authorKey, baseUrl, author, }) {
+    function getAuthorPage() {
+        if (!author.page) {
+            return null;
+        }
+        const slug = author.page === true ? lodash_1.default.kebabCase(authorKey) : author.page.permalink;
+        return {
+            permalink: (0, utils_1.normalizeUrl)([authorsBaseRoutePath, slug]),
+        };
+    }
+    return {
+        ...author,
+        key: authorKey,
+        page: getAuthorPage(),
+        imageURL: (0, authors_1.normalizeImageUrl)({ imageURL: author.imageURL, baseUrl }),
+        socials: author.socials ? (0, authorsSocials_1.normalizeSocials)(author.socials) : undefined,
+    };
+}
+function normalizeAuthorsMap({ authorsBaseRoutePath, authorsMapInput, baseUrl, }) {
+    return lodash_1.default.mapValues(authorsMapInput, (author, authorKey) => {
+        return normalizeAuthor({ authorsBaseRoutePath, authorKey, author, baseUrl });
+    });
+}
+function validateAuthorsMapInput(content) {
+    const { error, value } = AuthorsMapInputSchema.validate(content);
+    if (error) {
+        throw error;
+    }
+    return value;
+}
+async function getAuthorsMapInput(params) {
+    const content = await (0, utils_1.readDataFile)({
+        filePath: params.authorsMapPath,
+        contentPaths: params.contentPaths,
+    });
+    return content ? validateAuthorsMapInput(content) : undefined;
+}
+async function getAuthorsMap(params) {
+    const authorsMapInput = await getAuthorsMapInput(params);
+    if (!authorsMapInput) {
+        return undefined;
+    }
+    const authorsMap = normalizeAuthorsMap({ authorsMapInput, ...params });
+    return authorsMap;
+}
+function validateAuthorsMap(content) {
+    const { error, value } = AuthorsMapInputSchema.validate(content);
+    if (error) {
+        throw error;
+    }
+    return value;
+}

package/lib/authorsProblems.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 { Author, PluginOptions } from '@docusaurus/plugin-content-blog';
+export declare function reportAuthorsProblems(params: {
+    authors: Author[];
+    blogSourceRelative: string;
+    options: Pick<PluginOptions, 'onInlineAuthors' | 'authorsMapPath'>;
+}): void;
+export declare function reportInlineAuthors({ authors, blogSourceRelative, options: { onInlineAuthors, authorsMapPath }, }: {
+    authors: Author[];
+    blogSourceRelative: string;
+    options: Pick<PluginOptions, 'onInlineAuthors' | 'authorsMapPath'>;
+}): void;
+export declare function reportDuplicateAuthors({ authors, blogSourceRelative, }: {
+    authors: Author[];
+    blogSourceRelative: string;
+}): void;