@xrow/docusaurus-changelog 4.159.2 → 4.161.0

package/README.md

@@ -6,6 +6,13 @@ Render a GitLab releases Atom feed in Docusaurus MDX.
 <Changelog url="https://gitlab.com/group/project/-/releases.atom">Changelog</Changelog>
 ```
 
+Use the GitLab releases API when the page is served from another domain, because
+GitLab enables browser CORS headers for API responses.
+
+```mdx
+<Changelog url="https://gitlab.com/api/v4/projects/group%2Fproject/releases?per_page=10">Changelog</Changelog>
+```
+
 The CI Tools Docusaurus build image registers the component in Docusaurus
 `MDXComponents` automatically when the site does not provide a custom
 `src/theme/MDXComponents/index.js`.

package/index.d.ts

@@ -15,4 +15,6 @@ export interface ChangelogProps {
 
 export function releasesFromAtomDocument(document: Document): ReleaseEntry[];
 
+export function releasesFromGitLabApiResponse(releases: unknown[]): ReleaseEntry[];
+
 export default function Changelog(props: ChangelogProps): ReactNode;

package/index.js

@@ -24,6 +24,30 @@ export function releasesFromAtomDocument(document) {
   }));
 }
 
+function plainSummary(value) {
+  return (value ?? '')
+    .split('\n')
+    .map((line) => line.trim())
+    .find(Boolean)
+    ?.replace(/!\[[^\]]*]\([^)]+\)/g, '')
+    .replace(/\[([^\]]+)]\([^)]+\)/g, '$1')
+    .replace(/^[#>*\-\s]+/, '')
+    .trim() ?? '';
+}
+
+export function releasesFromGitLabApiResponse(releases) {
+  if (!Array.isArray(releases)) {
+    throw new Error('GitLab releases API response must be an array.');
+  }
+
+  return releases.map((release) => ({
+    title: release.name || release.tag_name || 'Untitled release',
+    href: release?._links?.self || release?.assets?.links?.[0]?.url || '',
+    updated: release.released_at || release.created_at || '',
+    summary: plainSummary(release.description),
+  }));
+}
+
 function parseAtomFeed(text) {
   if (typeof DOMParser === 'undefined') {
     throw new Error('DOMParser is not available in this environment.');
@@ -80,12 +104,16 @@ export default function Changelog({url, children, limit = 10}) {
         if (!response.ok) {
           throw new Error(`Release feed returned HTTP ${response.status}.`);
         }
-        return response.text();
+        const contentType = response.headers.get('content-type') || '';
+        if (contentType.includes('application/json')) {
+          return response.json().then(releasesFromGitLabApiResponse);
+        }
+        return response.text().then(parseAtomFeed);
       })
-      .then((text) => {
+      .then((releases) => {
         setState({
           status: 'ready',
-          releases: parseAtomFeed(text).slice(0, limit),
+          releases: releases.slice(0, limit),
           error: '',
         });
       })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xrow/docusaurus-changelog",
-  "version": "4.159.2",
+  "version": "4.161.0",
   "description": "Docusaurus MDX changelog component for GitLab release Atom feeds.",
   "type": "module",
   "main": "index.js",