@mintlify/prebuild 1.0.525 → 1.0.527

package/dist/index.d.ts

@@ -3,3 +3,4 @@ export * from './generate.js';
 export * from './utils.js';
 export * from './prebuild/index.js';
 export { getFaviconsConfig } from './prebuild/generateFavicons.js';
+export * from './prebuild/update/rss/index.js';

package/dist/index.js

@@ -3,3 +3,4 @@ export * from './generate.js';
 export * from './utils.js';
 export * from './prebuild/index.js';
 export { getFaviconsConfig } from './prebuild/generateFavicons.js';
+export * from './prebuild/update/rss/index.js';

package/dist/prebuild/update/index.js

@@ -1,4 +1,4 @@
-import { stringifyTree } from '@mintlify/common';
+import { stringifyTree, containsUpdates } from '@mintlify/common';
 import { upgradeToDocsConfig } from '@mintlify/validation';
 import { outputFile } from 'fs-extra';
 import { updateDocsConfigFile } from './docsConfig/index.js';
@@ -10,6 +10,7 @@ import { updateGeneratedDocsNav, updateGeneratedNav } from './updateGeneratedNav
 import { writeAsyncApiFiles } from './write/writeAsyncApiFiles.js';
 import { writeFiles } from './write/writeFiles.js';
 import { writeOpenApiFiles } from './write/writeOpenApiFiles.js';
+import { writeRssFiles } from './write/writeRssFiles.js';
 export const update = async ({ contentDirectoryPath, staticFilenames, openApiFiles, asyncApiFiles, contentFilenames, snippets, snippetV2Filenames, docsConfigPath, localSchema, }) => {
     const mintConfigResult = await updateMintConfigFile(contentDirectoryPath, openApiFiles, localSchema);
     // we used the original mint config without openapi pages injected
@@ -28,6 +29,7 @@ export const update = async ({ contentDirectoryPath, staticFilenames, openApiFil
         snippetV2Promises,
         pagePromises,
     ]);
+    const rssPages = mdxFilesWithNoImports.filter((page) => containsUpdates(page.tree));
     await Promise.all([
         resolveImportsAndWriteFiles({
             openApiFiles: newOpenApiFiles,
@@ -38,6 +40,7 @@ export const update = async ({ contentDirectoryPath, staticFilenames, openApiFil
         }),
         writeOpenApiFiles(newOpenApiFiles),
         writeAsyncApiFiles(newAsyncApiFiles),
+        writeRssFiles(newDocsConfig, rssPages),
         updateFavicons(newDocsConfig, contentDirectoryPath),
         ...writeMdxFilesWithNoImports(mdxFilesWithNoImports),
         ...writeFiles(contentDirectoryPath, 'public', [...staticFilenames, ...snippets]),

package/dist/prebuild/update/rss/docsConfigToRss.d.ts

@@ -0,0 +1,5 @@
+import { DocsConfig } from '@mintlify/validation';
+export declare const docsConfigToRss: (docsConfig: DocsConfig) => {
+    orgName: string;
+    orgDescription: string | undefined;
+};

package/dist/prebuild/update/rss/docsConfigToRss.js

@@ -0,0 +1,8 @@
+export const docsConfigToRss = (docsConfig) => {
+    const orgName = docsConfig.name;
+    const orgDescription = docsConfig.description;
+    return {
+        orgName,
+        orgDescription,
+    };
+};

package/dist/prebuild/update/rss/index.d.ts

@@ -0,0 +1,3 @@
+export * from './docsConfigToRss.js';
+export * from './mdxToRssUpdates.js';
+export * from './pageToRss.js';

package/dist/prebuild/update/rss/index.js

@@ -0,0 +1,3 @@
+export * from './docsConfigToRss.js';
+export * from './mdxToRssUpdates.js';
+export * from './pageToRss.js';

package/dist/prebuild/update/rss/mdxToRssUpdates.d.ts

@@ -0,0 +1,3 @@
+import { RSSItem } from '@mintlify/common';
+import { Root } from 'mdast';
+export declare const mdxToRssUpdates: (tree: Root) => RSSItem[];

package/dist/prebuild/update/rss/mdxToRssUpdates.js

@@ -0,0 +1,22 @@
+import { getTags, isUpdate } from '@mintlify/common';
+export const mdxToRssUpdates = (tree) => {
+    const updates = [];
+    const updateComponents = tree.children.filter((child) => isUpdate(child));
+    for (const updateComponent of updateComponents) {
+        const attributes = updateComponent.attributes;
+        const label = attributes.find((attribute) => attribute.type === 'mdxJsxAttribute' && attribute.name === 'label')?.value;
+        const description = attributes.find((attribute) => attribute.type === 'mdxJsxAttribute' && attribute.name === 'description')?.value;
+        const tags = getTags(updateComponent);
+        const validTitle = label?.toString() || undefined;
+        const validDescription = description?.toString() || '';
+        const validTags = tags.length > 0 ? tags : undefined;
+        if (validTitle) {
+            updates.push({
+                title: validTitle,
+                description: validDescription,
+                categories: validTags,
+            });
+        }
+    }
+    return updates;
+};

package/dist/prebuild/update/rss/pageToRss.d.ts

@@ -0,0 +1,5 @@
+import { Root } from 'mdast';
+export declare const pageToRss: (tree: Root) => {
+    title: string | undefined;
+    description: string | undefined;
+};

package/dist/prebuild/update/rss/pageToRss.js

@@ -0,0 +1,12 @@
+import { isFrontmatter } from '@mintlify/common';
+import yaml from 'js-yaml';
+export const pageToRss = (tree) => {
+    let title;
+    let description;
+    if (isFrontmatter(tree.children[0])) {
+        const frontmatterObject = yaml.load(tree.children[0].value);
+        title = frontmatterObject.title || undefined;
+        description = frontmatterObject.description || undefined;
+    }
+    return { title, description };
+};

package/dist/prebuild/update/write/writeRssFiles.d.ts

@@ -0,0 +1,6 @@
+import { DocsConfig } from '@mintlify/validation';
+import { Root } from 'mdast';
+export declare const writeRssFiles: (docsConfig: DocsConfig, rssPages: {
+    targetPath: string;
+    tree: Root;
+}[]) => Promise<void>;

package/dist/prebuild/update/write/writeRssFiles.js

@@ -0,0 +1,26 @@
+import fse from 'fs-extra';
+import { docsConfigToRss } from '../rss/docsConfigToRss.js';
+import { mdxToRssUpdates } from '../rss/mdxToRssUpdates.js';
+import { pageToRss } from '../rss/pageToRss.js';
+export const writeRssFiles = async (docsConfig, rssPages) => {
+    const { orgName, orgDescription } = docsConfigToRss(docsConfig);
+    const rssTargetPath = 'src/_props/rssFiles.json';
+    const rssItemsToSave = rssPages.map((page) => {
+        const { targetPath, tree } = page;
+        const { title, description } = pageToRss(tree);
+        const rssPath = targetPath.replace('.mdx', '/rss');
+        const updates = mdxToRssUpdates(tree);
+        return {
+            rssPath,
+            orgName,
+            orgDescription,
+            title,
+            description,
+            updates,
+        };
+    });
+    await fse.remove(rssTargetPath);
+    await fse.outputFile(rssTargetPath, JSON.stringify(rssItemsToSave), {
+        flag: 'w',
+    });
+};