@jpmorganchase/mosaic-plugins 0.1.0-beta.9 → 0.1.0-beta.91

package/dist/$TagPlugin.js

@@ -1,26 +1,8 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const escapeRegExp_1 = __importDefault(require("lodash/escapeRegExp"));
-const reduce_1 = __importDefault(require("lodash/reduce"));
-function createPageTest(ignorePages, pageExtensions) {
-    const extTest = new RegExp(`${pageExtensions.map(escapeRegExp_1.default).join('|')}$`);
-    const ignoreTest = new RegExp(`${ignorePages.map(escapeRegExp_1.default).join('|')}$`);
-    return file => !ignoreTest.test(file) && extTest.test(file) && !path_1.default.basename(file).startsWith('.');
-}
-const findKeys = (obj, targetProp, pathParts = []) => (0, reduce_1.default)(obj, (found, value, key) => {
+import path from 'path';
+import { reduce } from 'lodash-es';
+import PluginError from './utils/PluginError.js';
+import { createPageTest } from './utils/createPageTest.js';
+const findKeys = (obj, targetProp, pathParts = []) => reduce(obj, (found, value, key) => {
     if (key === targetProp) {
         return found.concat({ $$path: pathParts.concat(String(key)), $$value: value });
     }
@@ -40,31 +22,26 @@ const findKeys = (obj, targetProp, pathParts = []) => (0, reduce_1.default)(obj,
 const $TagPlugin = {
     // Check if the updated source has any /.tag aliases that we care about - if it does, we should re-run `afterUpdate` to
     // make sure we pull in the latest pages
-    shouldClearCache(updatedSourceFilesystem, { config }) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!((_a = config.data) === null || _a === void 0 ? void 0 : _a.subscribedTags) ||
-                !(yield updatedSourceFilesystem.promises.exists('/.tags'))) {
-                return false;
-            }
-            // Does the updated source have tags we are interested in?
-            return (yield updatedSourceFilesystem.promises.readdir('/.tags')).some(tag => config.data.subscribedTags.includes(tag));
-        });
+    async shouldClearCache(updatedSourceFilesystem, { config }) {
+        if (!config.data?.subscribedTags ||
+            !(await updatedSourceFilesystem.promises.exists('/.tags'))) {
+            return false;
+        }
+        // Does the updated source have tags we are interested in?
+        return (await updatedSourceFilesystem.promises.readdir('/.tags')).some(tag => config.data.subscribedTags.includes(tag));
     },
     // Every source with tags will create symlinks with the tagged pages, inside /.tags
-    $afterSource(pages, { config, ignorePages, pageExtensions }) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            const isNonHiddenPage = createPageTest(ignorePages, pageExtensions);
-            for (const page of pages) {
+    async $afterSource(pages, { config, ignorePages, pageExtensions }) {
+        const isNonHiddenPage = createPageTest(ignorePages, pageExtensions);
+        for (const page of pages) {
+            try {
                 if (!isNonHiddenPage(page.fullPath)) {
                     continue;
                 }
                 const meta = page;
                 // Symlink every `tag` item to '/.tags' folder
-                if ((_a = meta.tags) === null || _a === void 0 ? void 0 : _a.length) {
+                if (meta.tags?.length) {
                     config.setTags(page.fullPath, meta.tags);
-                    delete meta.tags;
                 }
                 // Find any references to $tag
                 const foundTags = findKeys(page, '$tag');
@@ -73,14 +50,17 @@ const $TagPlugin = {
                     foundTags.forEach(ref => {
                         const [tag, fragment = ''] = ref.$$value.split('#');
                         tags.add(tag);
-                        config.setGlobalRef(page.fullPath, ref.$$path, `${path_1.default.join('/.tags', tag, '**')}#${fragment}`);
+                        config.setGlobalRef(page.fullPath, ref.$$path, `${path.posix.join('/.tags', tag, '**', '*')}#${fragment}`);
                     });
                     config.setData({ subscribedTags: Array.from(tags) });
                 }
             }
-            return pages;
-        });
+            catch (e) {
+                throw new PluginError(e.message, page.fullPath);
+            }
+        }
+        return pages;
     }
 };
-exports.default = $TagPlugin;
+export default $TagPlugin;
 //# sourceMappingURL=$TagPlugin.js.map

package/dist/$TagPlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"$TagPlugin.js","sourceRoot":"","sources":["../src/$TagPlugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,gDAAwB;AACxB,uEAA+C;AAC/C,2DAAmC;AAGnC,SAAS,cAAc,CAAC,WAAW,EAAE,cAAc;IACjD,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,sBAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7E,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,sBAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7E,OAAO,IAAI,CAAC,EAAE,CACZ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,cAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;AACzF,CAAC;AAED,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,YAAsB,EAAE,EAAE,EAAE,CAC7D,IAAA,gBAAM,EACJ,GAAG,EACH,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;IACpB,IAAI,GAAG,KAAK,UAAU,EAAE;QACtB,OAAO,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;KAChF;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAChF,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC;KACtC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,EACD,EAAE,CACH,CAAC;AAWJ;;;;;;GAMG;AACH,MAAM,UAAU,GAA4D;IAC1E,uHAAuH;IACvH,wCAAwC;IAClC,gBAAgB,CAAC,uBAAuB,EAAE,EAAE,MAAM,EAAE;;;YACxD,IACE,CAAC,CAAA,MAAA,MAAM,CAAC,IAAI,0CAAE,cAAc,CAAA;gBAC5B,CAAC,CAAC,MAAM,uBAAuB,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAC1D;gBACA,OAAO,KAAK,CAAC;aACd;YACD,0DAA0D;YAC1D,OAAQ,CAAC,MAAM,uBAAuB,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAc,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CACzF,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CACzC,CAAC;;KACH;IACD,mFAAmF;IAC7E,YAAY,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE;;;YAC/D,MAAM,eAAe,GAAG,cAAc,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;YAEpE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;gBACxB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;oBACnC,SAAS;iBACV;gBACD,MAAM,IAAI,GAAG,IAAI,CAAC;gBAClB,8CAA8C;gBAC9C,IAAI,MAAA,IAAI,CAAC,IAAI,0CAAE,MAAM,EAAE;oBACrB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;oBACzC,OAAO,IAAI,CAAC,IAAI,CAAC;iBAClB;gBAED,8BAA8B;gBAC9B,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBACzC,IAAI,SAAS,CAAC,MAAM,EAAE;oBACpB,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;oBAE/B,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;wBACtB,MAAM,CAAC,GAAG,EAAE,QAAQ,GAAG,EAAE,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;wBAEpD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;wBAEd,MAAM,CAAC,YAAY,CACjB,IAAI,CAAC,QAAQ,EACb,GAAG,CAAC,MAAM,EACV,GAAG,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,QAAQ,EAAE,CAChD,CAAC;oBACJ,CAAC,CAAC,CAAC;oBACH,MAAM,CAAC,OAAO,CAAC,EAAE,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;iBACtD;aACF;YACD,OAAO,KAAK,CAAC;;KACd;CACF,CAAC;AAEF,kBAAe,UAAU,CAAC"}
+{"version":3,"file":"$TagPlugin.js","sourceRoot":"","sources":["../src/$TagPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,WAAW,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,YAAsB,EAAE,EAAE,EAAE,CAC7D,MAAM,CACJ,GAAG,EACH,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;IACpB,IAAI,GAAG,KAAK,UAAU,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IACjF,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAChF,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,EACD,EAAE,CACH,CAAC;AAWJ;;;;;;GAMG;AACH,MAAM,UAAU,GAA4D;IAC1E,uHAAuH;IACvH,wCAAwC;IACxC,KAAK,CAAC,gBAAgB,CAAC,uBAAuB,EAAE,EAAE,MAAM,EAAE;QACxD,IACE,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc;YAC5B,CAAC,CAAC,MAAM,uBAAuB,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAC1D,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,0DAA0D;QAC1D,OAAQ,CAAC,MAAM,uBAAuB,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAc,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CACzF,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CACzC,CAAC;IACJ,CAAC;IACD,mFAAmF;IACnF,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE;QAC/D,MAAM,eAAe,GAAG,cAAc,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;QAEpE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC;gBACH,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACpC,SAAS;gBACX,CAAC;gBACD,MAAM,IAAI,GAAG,IAAI,CAAC;gBAClB,8CAA8C;gBAC9C,IAAI,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC;oBACtB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3C,CAAC;gBAED,8BAA8B;gBAC9B,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBACzC,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;oBACrB,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;oBAE/B,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;wBACtB,MAAM,CAAC,GAAG,EAAE,QAAQ,GAAG,EAAE,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;wBAEpD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;wBAEd,MAAM,CAAC,YAAY,CACjB,IAAI,CAAC,QAAQ,EACb,GAAG,CAAC,MAAM,EACV,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,QAAQ,EAAE,CAC3D,CAAC;oBACJ,CAAC,CAAC,CAAC;oBACH,MAAM,CAAC,OAAO,CAAC,EAAE,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACvD,CAAC;YACH,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,IAAI,WAAW,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAClD,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/BreadcrumbsPlugin.d.ts

@@ -0,0 +1,19 @@
+import type { Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+import { SidebarPluginPage } from './SidebarPlugin.js';
+export type Breadcrumb = {
+    label: string;
+    path: string;
+    id: string;
+};
+export interface BreadcrumbsPluginPage extends SidebarPluginPage {
+    breadcrumbs?: Array<Breadcrumb>;
+    layout?: string;
+}
+interface BreadcrumbsPluginOptions {
+    indexPageName: string;
+}
+/**
+ * Calculates breadcrumbs for pages then embeds a `breadcrumbs` property to the metadata
+ */
+declare const BreadcrumbsPlugin: PluginType<BreadcrumbsPluginPage, BreadcrumbsPluginOptions>;
+export default BreadcrumbsPlugin;

package/dist/BreadcrumbsPlugin.js

@@ -1,51 +1,95 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
+import path from 'node:path';
+import PluginError from './utils/PluginError.js';
+import { createPageTest } from './utils/createPageTest.js';
 /**
  * Calculates breadcrumbs for pages then embeds a `breadcrumbs` property to the metadata
  */
 const BreadcrumbsPlugin = {
-    $afterSource(pages, _, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            for (const page of pages) {
-                const breadcrumbs = [];
-                let currentPage = page;
-                let parentDir = path_1.default.posix.normalize(path_1.default.posix.dirname(currentPage.fullPath));
-                while (currentPage !== undefined) {
+    async $afterSource(pages, { ignorePages, pageExtensions }, options) {
+        const isNonHiddenPage = createPageTest(ignorePages, pageExtensions);
+        for (const page of pages) {
+            if (!isNonHiddenPage(page.fullPath)) {
+                continue;
+            }
+            try {
+                const pathParts = page.fullPath.replace(/^[/]/, '').split('/');
+                const topAndTailedPath = pathParts.slice(1, -1);
+                const breadcrumbs = topAndTailedPath.reduce((result, _pathPart, partIndex) => {
+                    const breadcrumbRoot = `/${pathParts[0]}`;
+                    const breadcrumbPath = path.posix.join(breadcrumbRoot, ...topAndTailedPath.slice(0, topAndTailedPath.length - partIndex), options.indexPageName);
+                    const breadcrumbPage = pages.find(
                     // eslint-disable-next-line @typescript-eslint/no-loop-func
-                    if (breadcrumbs.findIndex(breadcrumb => breadcrumb.id === currentPage.fullPath) === -1) {
-                        breadcrumbs.unshift({
-                            label: currentPage.title,
-                            path: currentPage.route,
-                            id: currentPage.fullPath
+                    item => item.fullPath === breadcrumbPath);
+                    if (breadcrumbPage) {
+                        result.unshift({
+                            label: breadcrumbPage.sidebar?.groupLabel ||
+                                breadcrumbPage.sidebar?.label ||
+                                breadcrumbPage.title,
+                            path: breadcrumbPage.route,
+                            id: breadcrumbPage.fullPath
                         });
                     }
-                    currentPage = pages.find(
-                    // eslint-disable-next-line @typescript-eslint/no-loop-func
-                    item => item.fullPath === path_1.default.posix.join(parentDir, options.indexPageName));
-                    if (currentPage) {
-                        parentDir = path_1.default.posix.dirname(path_1.default.posix.join(String(currentPage.fullPath), '..'));
-                    }
-                }
+                    return result;
+                }, []);
                 if (!page.breadcrumbs) {
                     page.breadcrumbs = breadcrumbs;
                 }
             }
-            return pages;
-        });
+            catch (e) {
+                throw new PluginError(e.message, page.fullPath);
+            }
+        }
+        return pages;
+    },
+    async afterNamespaceSourceUpdate(mutableFilesystem, { serialiser, globalFilesystem, ignorePages }, options) {
+        const pages = (await mutableFilesystem.promises.glob('**', {
+            onlyFiles: true,
+            ignore: ignorePages.map(ignore => `**/${ignore}`),
+            cwd: '/'
+        }));
+        if (pages.length > 0) {
+            let updatedBreadcrumbs = [];
+            const { breadcrumbs } = await serialiser.deserialise(pages[0], await mutableFilesystem.promises.readFile(pages[0]));
+            // the root breadcrumb is the first breadcrumb for all pages in a source.  It is essentially the "first" page in a source
+            const rootBreadcrumb = breadcrumbs?.[0] || undefined;
+            if (rootBreadcrumb) {
+                let parentDir = path.posix.join(path.posix.dirname(rootBreadcrumb.id), '../');
+                while (parentDir !== '/') {
+                    const parentDirIndex = path.posix.join(parentDir, options.indexPageName);
+                    // check for this file in the global fs so we have a holistic view of all site pages
+                    if (await globalFilesystem.promises.exists(parentDirIndex)) {
+                        const { breadcrumbs: parentDirBreadcrumbs } = await serialiser.deserialise(rootBreadcrumb.id, await globalFilesystem.promises.readFile(parentDirIndex));
+                        updatedBreadcrumbs = parentDirBreadcrumbs;
+                        break;
+                    }
+                    parentDir = path.posix.join(path.posix.dirname(parentDirIndex), '../');
+                }
+                if (updatedBreadcrumbs.length > 0) {
+                    for (const pagePath of pages) {
+                        const page = await serialiser.deserialise(pagePath, await mutableFilesystem.promises.readFile(pagePath));
+                        // append the parent breadcrumbs **before** the current breadcrumbs
+                        page.breadcrumbs = [...updatedBreadcrumbs, ...page.breadcrumbs];
+                        await mutableFilesystem.promises.writeFile(pagePath, await serialiser.serialise(pagePath, page));
+                    }
+                }
+            }
+        }
+    },
+    async shouldUpdateNamespaceSources(updatedSourceFilesystem, { ignorePages, namespace }) {
+        /**
+         * Only trigger an update when the updated source happens to be the "root" namespace source
+         * This is determined this by checking if the filesystem has files inside the "namespace" directory
+         *
+         * "child" sources will have the namespace directory but they wont have files until further down the directory hierarchy
+         */
+        const namespaceDirFiles = (await updatedSourceFilesystem.promises.glob(`${namespace}/*`, {
+            onlyFiles: true,
+            ignore: ignorePages.map(ignore => `**/${ignore}`),
+            cwd: '/'
+        }));
+        // the root namespace has updated
+        return namespaceDirFiles.length > 0;
     }
 };
-exports.default = BreadcrumbsPlugin;
+export default BreadcrumbsPlugin;
 //# sourceMappingURL=BreadcrumbsPlugin.js.map

package/dist/BreadcrumbsPlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"BreadcrumbsPlugin.js","sourceRoot":"","sources":["../src/BreadcrumbsPlugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,gDAAwB;AAaxB;;GAEG;AACH,MAAM,iBAAiB,GAAgE;IAC/E,YAAY,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO;;YAClC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;gBACxB,MAAM,WAAW,GAAsB,EAAE,CAAC;gBAC1C,IAAI,WAAW,GAAG,IAAI,CAAC;gBACvB,IAAI,SAAS,GAAG,cAAI,CAAC,KAAK,CAAC,SAAS,CAAC,cAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAE/E,OAAO,WAAW,KAAK,SAAS,EAAE;oBAChC,2DAA2D;oBAC3D,IAAI,WAAW,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,KAAK,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE;wBACtF,WAAW,CAAC,OAAO,CAAC;4BAClB,KAAK,EAAE,WAAW,CAAC,KAAK;4BACxB,IAAI,EAAE,WAAW,CAAC,KAAK;4BACvB,EAAE,EAAE,WAAW,CAAC,QAAQ;yBACzB,CAAC,CAAC;qBACJ;oBAED,WAAW,GAAG,KAAK,CAAC,IAAI;oBACtB,2DAA2D;oBAC3D,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,aAAa,CAAC,CAC5E,CAAC;oBACF,IAAI,WAAW,EAAE;wBACf,SAAS,GAAG,cAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;qBACrF;iBACF;gBAED,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;oBACrB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;iBAChC;aACF;YAED,OAAO,KAAK,CAAC;QACf,CAAC;KAAA;CACF,CAAC;AAEF,kBAAe,iBAAiB,CAAC"}
+{"version":3,"file":"BreadcrumbsPlugin.js","sourceRoot":"","sources":["../src/BreadcrumbsPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,WAAW,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAc3D;;GAEG;AACH,MAAM,iBAAiB,GAAgE;IACrF,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,EAAE,OAAO;QAChE,MAAM,eAAe,GAAG,cAAc,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;QACpE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACpC,SAAS;YACX,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC/D,MAAM,gBAAgB,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBAChD,MAAM,WAAW,GAAG,gBAAgB,CAAC,MAAM,CACzC,CAAC,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE;oBAC/B,MAAM,cAAc,GAAG,IAAI,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC1C,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CACpC,cAAc,EACd,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC,EAAE,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,EACjE,OAAO,CAAC,aAAa,CACtB,CAAC;oBACF,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI;oBAC/B,2DAA2D;oBAC3D,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,cAAc,CACzC,CAAC;oBACF,IAAI,cAAc,EAAE,CAAC;wBACnB,MAAM,CAAC,OAAO,CAAC;4BACb,KAAK,EACH,cAAc,CAAC,OAAO,EAAE,UAAU;gCAClC,cAAc,CAAC,OAAO,EAAE,KAAK;gCAC7B,cAAc,CAAC,KAAK;4BACtB,IAAI,EAAE,cAAc,CAAC,KAAK;4BAC1B,EAAE,EAAE,cAAc,CAAC,QAAQ;yBAC5B,CAAC,CAAC;oBACL,CAAC;oBACD,OAAO,MAAM,CAAC;gBAChB,CAAC,EACD,EAAE,CACH,CAAC;gBACF,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;oBACtB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;gBACjC,CAAC;YACH,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,IAAI,WAAW,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAClD,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,KAAK,CAAC,0BAA0B,CAC9B,iBAAiB,EACjB,EAAE,UAAU,EAAE,gBAAgB,EAAE,WAAW,EAAE,EAC7C,OAAO;QAEP,MAAM,KAAK,GAAG,CAAC,MAAM,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE;YACzD,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,MAAM,EAAE,CAAC;YACjD,GAAG,EAAE,GAAG;SACT,CAAC,CAAa,CAAC;QAEhB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,IAAI,kBAAkB,GAAG,EAAE,CAAC;YAC5B,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,UAAU,CAAC,WAAW,CAClD,KAAK,CAAC,CAAC,CAAC,EACR,MAAM,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CACpD,CAAC;YAEF,yHAAyH;YACzH,MAAM,cAAc,GAAG,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC;YAErD,IAAI,cAAc,EAAE,CAAC;gBACnB,IAAI,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;gBAE9E,OAAO,SAAS,KAAK,GAAG,EAAE,CAAC;oBACzB,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;oBAEzE,oFAAoF;oBACpF,IAAI,MAAM,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC;wBAC3D,MAAM,EAAE,WAAW,EAAE,oBAAoB,EAAE,GAAG,MAAM,UAAU,CAAC,WAAW,CACxE,cAAc,CAAC,EAAE,EACjB,MAAM,gBAAgB,CAAC,QAAQ,CAAC,QAAQ,CAAC,cAAc,CAAC,CACzD,CAAC;wBACF,kBAAkB,GAAG,oBAAoB,CAAC;wBAC1C,MAAM;oBACR,CAAC;oBACD,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,KAAK,CAAC,CAAC;gBACzE,CAAC;gBAED,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAClC,KAAK,MAAM,QAAQ,IAAI,KAAK,EAAE,CAAC;wBAC7B,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,WAAW,CACvC,QAAQ,EACR,MAAM,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CACpD,CAAC;wBAEF,mEAAmE;wBACnE,IAAI,CAAC,WAAW,GAAG,CAAC,GAAG,kBAAkB,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;wBAChE,MAAM,iBAAiB,CAAC,QAAQ,CAAC,SAAS,CACxC,QAAQ,EACR,MAAM,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAC3C,CAAC;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IACD,KAAK,CAAC,4BAA4B,CAAC,uBAAuB,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE;QACpF;;;;;WAKG;QACH,MAAM,iBAAiB,GAAG,CAAC,MAAM,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,SAAS,IAAI,EAAE;YACvF,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,MAAM,EAAE,CAAC;YACjD,GAAG,EAAE,GAAG;SACT,CAAC,CAAa,CAAC;QAEhB,iCAAiC;QACjC,OAAO,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC;IACtC,CAAC;CACF,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/dist/BrokenLinksPlugin.d.ts

@@ -0,0 +1,10 @@
+import type { Page, Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+interface BrokenLinksPluginPage extends Page {
+}
+interface BrokenLinksPluginOptions {
+    baseUrl: string;
+    skipUrlPatterns?: Array<string | RegExp>;
+    proxyEndpoint?: string;
+}
+declare const BrokenLinksPlugin: PluginType<BrokenLinksPluginPage, BrokenLinksPluginOptions>;
+export default BrokenLinksPlugin;

package/dist/BrokenLinksPlugin.js

@@ -0,0 +1,80 @@
+import path from 'node:path';
+import { remark } from 'remark';
+import remarkMdx from 'remark-mdx';
+import checkLinks from 'check-links';
+import { visit } from 'unist-util-visit';
+import proxyAgentPkg from 'https-proxy-agent';
+const { HttpsProxyAgent } = proxyAgentPkg;
+async function checkPageLinks(ast, options, fullPath, headings) {
+    const urlToNodes = {};
+    const aggregate = node => {
+        const { url: urlFromNode } = node;
+        if (!urlFromNode)
+            return;
+        const isExternalUrl = /^(https?:\/\/)/.test(urlFromNode);
+        const url = isExternalUrl
+            ? // full urls including internal and external
+                new URL(urlFromNode)
+            : // handles relative links
+                new URL(`${path.posix.resolve(path.posix.dirname(fullPath), urlFromNode)}`, options.baseUrl);
+        if (!isExternalUrl && url.hash !== '') {
+            const isValidHeadingLink = headings.findIndex(heading => heading.replace(/\W+/g, '-').toLowerCase() === url.hash.substring(1).toLowerCase()) !== -1;
+            if (isValidHeadingLink) {
+                // link points to a heading on the page
+                return;
+            }
+        }
+        if (options.skipUrlPatterns &&
+            options.skipUrlPatterns.some(skipPattern => new RegExp(skipPattern).test(url.toString()))) {
+            return;
+        }
+        if (!urlToNodes[url.toString()]) {
+            urlToNodes[url.toString()] = [];
+        }
+        urlToNodes[url.toString()].push(node);
+    };
+    visit(ast, ['link', 'image', 'definition'], aggregate);
+    const links = Object.keys(urlToNodes);
+    const checkLinksOptions = options.proxyEndpoint
+        ? {
+            agent: {
+                https: new HttpsProxyAgent(options.proxyEndpoint)
+            }
+        }
+        : {};
+    const results = await checkLinks(links, checkLinksOptions);
+    links.forEach(link => {
+        const result = results[link];
+        if (result.status !== 'dead' && result.status !== 'invalid') {
+            return;
+        }
+        const nodes = urlToNodes[link];
+        if (!nodes)
+            return;
+        console.group(`[Mosaic] Broken links found in ${fullPath}`);
+        for (const node of nodes) {
+            console.log(`Link to ${link} is dead`, node);
+        }
+        console.groupEnd();
+    });
+}
+async function findPageHeadings(ast) {
+    const headings = [];
+    visit(ast, ['heading'], node => {
+        headings.push(node.children[0]?.value);
+    });
+    return headings;
+}
+const processor = remark().use(remarkMdx);
+const BrokenLinksPlugin = {
+    async $afterSource(pages, _, options) {
+        pages.forEach(async (page) => {
+            const ast = await processor.parse(page.content);
+            const headings = await findPageHeadings(ast);
+            await checkPageLinks(ast, options, page.fullPath, headings);
+        });
+        return pages;
+    }
+};
+export default BrokenLinksPlugin;
+//# sourceMappingURL=BrokenLinksPlugin.js.map

package/dist/BrokenLinksPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrokenLinksPlugin.js","sourceRoot":"","sources":["../src/BrokenLinksPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,aAAa,MAAM,mBAAmB,CAAC;AAE9C,MAAM,EAAE,eAAe,EAAE,GAAG,aAAa,CAAC;AAE1C,KAAK,UAAU,cAAc,CAC3B,GAAY,EACZ,OAAiC,EACjC,QAAgB,EAChB,QAAQ;IAER,MAAM,UAAU,GAAG,EAAE,CAAC;IAEtB,MAAM,SAAS,GAAG,IAAI,CAAC,EAAE;QACvB,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QAClC,IAAI,CAAC,WAAW;YAAE,OAAO;QAEzB,MAAM,aAAa,GAAG,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAEzD,MAAM,GAAG,GAAG,aAAa;YACvB,CAAC,CAAC,4CAA4C;gBAC5C,IAAI,GAAG,CAAC,WAAW,CAAC;YACtB,CAAC,CAAC,yBAAyB;gBACzB,IAAI,GAAG,CACL,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,WAAW,CAAC,EAAE,EAClE,OAAO,CAAC,OAAO,CAChB,CAAC;QAEN,IAAI,CAAC,aAAa,IAAI,GAAG,CAAC,IAAI,KAAK,EAAE,EAAE,CAAC;YACtC,MAAM,kBAAkB,GACtB,QAAQ,CAAC,SAAS,CAChB,OAAO,CAAC,EAAE,CACR,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CACrF,KAAK,CAAC,CAAC,CAAC;YAEX,IAAI,kBAAkB,EAAE,CAAC;gBACvB,uCAAuC;gBACvC,OAAO;YACT,CAAC;QACH,CAAC;QAED,IACE,OAAO,CAAC,eAAe;YACvB,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,EACzF,CAAC;YACD,OAAO;QACT,CAAC;QAED,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;YAChC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC;QAClC,CAAC;QAED,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC,CAAC;IAEF,KAAK,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,YAAY,CAAC,EAAE,SAAS,CAAC,CAAC;IACvD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtC,MAAM,iBAAiB,GAAG,OAAO,CAAC,aAAa;QAC7C,CAAC,CAAC;YACE,KAAK,EAAE;gBACL,KAAK,EAAE,IAAI,eAAe,CAAC,OAAO,CAAC,aAAa,CAAC;aAClD;SACF;QACH,CAAC,CAAC,EAAE,CAAC;IAEP,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;IAC3D,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACnB,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAE7B,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC5D,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK;YAAE,OAAO;QAEnB,OAAO,CAAC,KAAK,CAAC,kCAAkC,QAAQ,EAAE,CAAC,CAAC;QAC5D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,UAAU,EAAE,IAAI,CAAC,CAAC;QAC/C,CAAC;QACD,OAAO,CAAC,QAAQ,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,GAAG;IACjC,MAAM,QAAQ,GAAG,EAAE,CAAC;IACpB,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,EAAE;QAC7B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AAU1C,MAAM,iBAAiB,GAAgE;IACrF,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO;QAClC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAC,IAAI,EAAC,EAAE;YACzB,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAChD,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,GAAG,CAAC,CAAC;YAC7C,MAAM,cAAc,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC;IACf,CAAC;CACF,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/dist/DocumentAssetsPlugin.d.ts

@@ -0,0 +1,28 @@
+import type { Page, Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+interface DocumentAssetsPluginOptions {
+    /**
+     * An array of subdirectory globs that could contain assets
+     * @default: ['**\/images']
+     */
+    assetSubDirs?: string[];
+    /**
+     * The source path, where your docs reside, when the site runs
+     */
+    srcDir?: string;
+    /**
+     * The directory to copy matched assets to, typically the site's public directory
+     * @default './public'
+     */
+    outputDir?: string;
+    /**
+     * The prefix we add to all images in documents, so that it routes to the public directory
+     * @default '/images'
+     */
+    imagesPrefix?: string;
+}
+/**
+ * Plugin that finds assets within the Mosaic filesystem and copies them to the configured `outputDir`.
+ * Documents that create relative references to those images, will be re-written to pull the images from the `outputDir`.
+ */
+declare const DocumentAssetsPlugin: PluginType<Page, DocumentAssetsPluginOptions>;
+export default DocumentAssetsPlugin;

package/dist/DocumentAssetsPlugin.js

@@ -0,0 +1,144 @@
+import fs from 'fs';
+import glob from 'fast-glob';
+import path from 'path';
+import { escapeRegExp } from 'lodash-es';
+import { unified } from 'unified';
+import { visit } from 'unist-util-visit';
+import remarkParse from 'remark-parse';
+import remarkMdx from 'remark-mdx';
+import remarkStringify from 'remark-stringify';
+import PluginError from './utils/PluginError.js';
+function isUrl(assetPath) {
+    try {
+        new URL(assetPath);
+        return true;
+    }
+    catch (_err) { }
+    return false;
+}
+const createPageTest = (ignorePages, pageExtensions) => {
+    const extTest = new RegExp(`${pageExtensions.map(ext => escapeRegExp(ext)).join('|')}$`);
+    const ignoreTest = new RegExp(`${ignorePages.map(ignore => escapeRegExp(ignore)).join('|')}$`);
+    return (file) => !ignoreTest.test(file) && extTest.test(file) && !path.basename(file).startsWith('.');
+};
+function remarkRewriteImagePaths(newPrefix) {
+    return (tree) => {
+        visit(tree, 'image', (node) => {
+            if (node.url) {
+                if (isUrl(node.url) || /^\//.test(node.url)) {
+                    // Absolute URL or path, do nothing
+                    return;
+                }
+                else {
+                    const isRelativePath = !isUrl(node.url) && !path.posix.isAbsolute(node.url);
+                    const assetPath = isRelativePath ? node.url : `./${node.url}`;
+                    const resolvedPath = path.posix.resolve(path.posix.dirname(newPrefix), assetPath);
+                    node.url = resolvedPath;
+                }
+            }
+        });
+    };
+}
+/**
+ * Plugin that finds assets within the Mosaic filesystem and copies them to the configured `outputDir`.
+ * Documents that create relative references to those images, will be re-written to pull the images from the `outputDir`.
+ */
+const DocumentAssetsPlugin = {
+    async afterUpdate(_mutableFileSystem, _helpers, { assetSubDirs = [path.join('**', 'images')], srcDir = path.join(process.cwd(), 'docs'), outputDir = `${path.sep}public` }) {
+        const resolvedCwd = path.resolve(process.cwd());
+        const resolvedSrcDir = path.resolve(srcDir);
+        const resolvedOutputDir = path.resolve(outputDir);
+        if (!resolvedOutputDir.startsWith(resolvedCwd)) {
+            throw new PluginError('outputDir must be within the current working directory', resolvedOutputDir);
+        }
+        for (const assetSubDir of assetSubDirs) {
+            const resolvedAssetSubDir = path.resolve(resolvedSrcDir, assetSubDir);
+            if (!resolvedAssetSubDir.startsWith(resolvedSrcDir)) {
+                throw new PluginError('asset subdirectory must be within srcDir', resolvedAssetSubDir);
+            }
+            let globbedImageDirs;
+            try {
+                globbedImageDirs = await glob(assetSubDir, {
+                    cwd: resolvedSrcDir,
+                    onlyDirectories: true,
+                    fs
+                });
+                if (globbedImageDirs.length === 0) {
+                    console.warn(`Warning: No entries found for ${assetSubDir}. It may not exist.`);
+                    continue;
+                }
+            }
+            catch (err) {
+                console.error(`Error globbing ${assetSubDir} in ${srcDir}:`, err);
+                throw new PluginError(err.message, assetSubDir);
+            }
+            await fs.promises.mkdir(outputDir, { recursive: true });
+            for (const globbedImageDir of globbedImageDirs) {
+                let imageFiles;
+                let globbedPath;
+                let rootSrcDir = srcDir;
+                let rootOutputDir = outputDir;
+                try {
+                    if (!path.isAbsolute(rootSrcDir)) {
+                        rootSrcDir = path.resolve(path.join(process.cwd(), srcDir));
+                    }
+                    globbedPath = path.join(rootSrcDir, globbedImageDir);
+                    imageFiles = await fs.promises.readdir(globbedPath);
+                }
+                catch (err) {
+                    console.error(`Error reading directory ${globbedPath}:`, err);
+                    continue;
+                }
+                if (!path.isAbsolute(rootOutputDir)) {
+                    rootOutputDir = path.resolve(path.join(process.cwd(), outputDir));
+                }
+                for (const imageFile of imageFiles) {
+                    try {
+                        const imageSrcPath = path.join(globbedImageDir, imageFile);
+                        const fullImageSrcPath = path.join(rootSrcDir, imageSrcPath);
+                        const fullImageDestPath = path.join(rootOutputDir, imageSrcPath);
+                        await fs.promises.mkdir(path.dirname(fullImageDestPath), { recursive: true });
+                        const symlinkAlreadyExists = await fs.promises
+                            .access(fullImageDestPath)
+                            .then(() => true)
+                            .catch(() => false);
+                        if (!symlinkAlreadyExists) {
+                            await fs.promises.symlink(fullImageSrcPath, fullImageDestPath);
+                            console.log(`Symlink created: ${fullImageSrcPath} -> ${fullImageDestPath}`);
+                        }
+                    }
+                    catch (error) {
+                        console.error(`Error processing ${imageFile}:`, error);
+                    }
+                }
+            }
+        }
+    },
+    async $afterSource(pages, { ignorePages, pageExtensions }, { imagesPrefix = `/images` }) {
+        if (!pageExtensions.includes('.mdx')) {
+            return pages;
+        }
+        for (const page of pages) {
+            const isNonHiddenPage = createPageTest(ignorePages, ['.mdx']);
+            if (!isNonHiddenPage(page.fullPath)) {
+                continue;
+            }
+            const processor = unified()
+                .use(remarkParse)
+                .use(remarkMdx)
+                .use(remarkRewriteImagePaths, path.posix.join(imagesPrefix, page.route))
+                .use(remarkStringify);
+            await processor
+                .process(page.content)
+                .then((file) => {
+                page.content = String(file);
+            })
+                .catch((err) => {
+                console.error('Error processing Markdown:', err);
+            });
+        }
+        return pages;
+    }
+};
+export default DocumentAssetsPlugin;
+//# sourceMappingURL=DocumentAssetsPlugin.js.map

package/dist/DocumentAssetsPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocumentAssetsPlugin.js","sourceRoot":"","sources":["../src/DocumentAssetsPlugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,WAAW,MAAM,cAAc,CAAC;AACvC,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,eAAe,MAAM,kBAAkB,CAAC;AAE/C,OAAO,WAAW,MAAM,wBAAwB,CAAC;AAwBjD,SAAS,KAAK,CAAC,SAAiB;IAC9B,IAAI,CAAC;QACH,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,IAAI,EAAE,CAAC,CAAA,CAAC;IACjB,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,cAAc,GAAG,CAAC,WAAqB,EAAE,cAAwB,EAAE,EAAE;IACzE,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACzF,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAE/F,OAAO,CAAC,IAAY,EAAE,EAAE,CACtB,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;AACzF,CAAC,CAAC;AAEF,SAAS,uBAAuB,CAAC,SAAiB;IAChD,OAAO,CAAC,IAAS,EAAE,EAAE;QACnB,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,IAAS,EAAE,EAAE;YACjC,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;gBACb,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC5C,mCAAmC;oBACnC,OAAO;gBACT,CAAC;qBAAM,CAAC;oBACN,MAAM,cAAc,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBAC5E,MAAM,SAAS,GAAG,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC;oBAC9D,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,CAAC;oBAClF,IAAI,CAAC,GAAG,GAAG,YAAY,CAAC;gBAC1B,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,oBAAoB,GAAkD;IAC1E,KAAK,CAAC,WAAW,CACf,kBAAkB,EAClB,QAAQ,EACR,EACE,YAAY,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,EAC1C,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,EACzC,SAAS,GAAG,GAAG,IAAI,CAAC,GAAG,QAAQ,EAChC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;QAChD,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5C,MAAM,iBAAiB,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,WAAW,CACnB,wDAAwD,EACxD,iBAAiB,CAClB,CAAC;QACJ,CAAC;QAED,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;YACvC,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;YACtE,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;gBACpD,MAAM,IAAI,WAAW,CAAC,0CAA0C,EAAE,mBAAmB,CAAC,CAAC;YACzF,CAAC;YAED,IAAI,gBAAgB,CAAC;YACrB,IAAI,CAAC;gBACH,gBAAgB,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE;oBACzC,GAAG,EAAE,cAAc;oBACnB,eAAe,EAAE,IAAI;oBACrB,EAAE;iBACH,CAAC,CAAC;gBACH,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAClC,OAAO,CAAC,IAAI,CAAC,iCAAiC,WAAW,qBAAqB,CAAC,CAAC;oBAChF,SAAS;gBACX,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,CAAC,KAAK,CAAC,kBAAkB,WAAW,OAAO,MAAM,GAAG,EAAE,GAAG,CAAC,CAAC;gBAClE,MAAM,IAAI,WAAW,CAAC,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YAClD,CAAC;YAED,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACxD,KAAK,MAAM,eAAe,IAAI,gBAAgB,EAAE,CAAC;gBAC/C,IAAI,UAAU,CAAC;gBACf,IAAI,WAAW,CAAC;gBAChB,IAAI,UAAU,GAAG,MAAM,CAAC;gBACxB,IAAI,aAAa,GAAG,SAAS,CAAC;gBAC9B,IAAI,CAAC;oBACH,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;wBACjC,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;oBAC9D,CAAC;oBACD,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;oBACrD,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gBACtD,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,OAAO,CAAC,KAAK,CAAC,2BAA2B,WAAW,GAAG,EAAE,GAAG,CAAC,CAAC;oBAC9D,SAAS;gBACX,CAAC;gBACD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;oBACpC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;gBACpE,CAAC;gBAED,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;oBACnC,IAAI,CAAC;wBACH,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;wBAC3D,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;wBAC7D,MAAM,iBAAiB,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;wBAEjE,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;wBAC9E,MAAM,oBAAoB,GAAG,MAAM,EAAE,CAAC,QAAQ;6BAC3C,MAAM,CAAC,iBAAiB,CAAC;6BACzB,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;6BAChB,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;wBACtB,IAAI,CAAC,oBAAoB,EAAE,CAAC;4BAC1B,MAAM,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;4BAC/D,OAAO,CAAC,GAAG,CAAC,oBAAoB,gBAAgB,OAAO,iBAAiB,EAAE,CAAC,CAAC;wBAC9E,CAAC;oBACH,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,OAAO,CAAC,KAAK,CAAC,oBAAoB,SAAS,GAAG,EAAE,KAAK,CAAC,CAAC;oBACzD,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IACD,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,EAAE,EAAE,YAAY,GAAG,SAAS,EAAE;QACrF,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACrC,OAAO,KAAK,CAAC;QACf,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,eAAe,GAAG,cAAc,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;YAC9D,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACpC,SAAS;YACX,CAAC;YAED,MAAM,SAAS,GAAG,OAAO,EAAE;iBACxB,GAAG,CAAC,WAAW,CAAC;iBAChB,GAAG,CAAC,SAAS,CAAC;iBACd,GAAG,CAAC,uBAAuB,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;iBACvE,GAAG,CAAC,eAAe,CAAC,CAAC;YACxB,MAAM,SAAS;iBACZ,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;iBACrB,IAAI,CAAC,CAAC,IAAW,EAAE,EAAE;gBACpB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;YAC9B,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,GAAU,EAAE,EAAE;gBACpB,OAAO,CAAC,KAAK,CAAC,4BAA4B,EAAE,GAAG,CAAC,CAAC;YACnD,CAAC,CAAC,CAAC;QACP,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF,CAAC;AAEF,eAAe,oBAAoB,CAAC"}

package/dist/FragmentPlugin.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+declare const FragmentPlugin: PluginType;
+export default FragmentPlugin;

package/dist/FragmentPlugin.js

@@ -0,0 +1,64 @@
+import path from 'node:path';
+import { remark } from 'remark';
+import remarkMdx from 'remark-mdx';
+import remarkDirective from 'remark-directive';
+import { visit } from 'unist-util-visit';
+import PluginError from './utils/PluginError.js';
+import { createPageTest } from './utils/createPageTest.js';
+function isDirective(node) {
+    return (node.type === 'containerDirective' ||
+        node.type === 'leafDirective' ||
+        node.type === 'textDirective');
+}
+function processFragments(tree, pages, isNonHiddenPage, fullPath) {
+    visit(tree, (node, index, parent) => {
+        if (isDirective(node)) {
+            if (node.name !== 'fragment')
+                return;
+            const attributes = node.attributes ?? {};
+            const { src } = attributes;
+            if (!src) {
+                console.error("Fragment directive requires a 'src' attribute. Skipping.");
+                return;
+            }
+            const fragmentFullPath = path.posix.join(path.dirname(fullPath), src);
+            const isHidden = !isNonHiddenPage(fragmentFullPath);
+            const fragmentPage = pages.find(page => page.fullPath === fragmentFullPath);
+            if (isHidden || !fragmentPage) {
+                console.warn(`Invalid file reference: '${node.attributes.src}'. Skipping.`);
+            }
+            else {
+                // Create a new node with the content from fragmentPage.content
+                const newNode = {
+                    type: 'html',
+                    value: fragmentPage.content
+                };
+                // Replace the original node with the newNode in the tree
+                parent.children.splice(index, 1, newNode);
+            }
+        }
+    });
+}
+const processor = remark().use(remarkMdx).use(remarkDirective);
+const FragmentPlugin = {
+    async $afterSource(pages, { ignorePages, pageExtensions }) {
+        const isNonHiddenPage = createPageTest(ignorePages, pageExtensions);
+        for (const page of pages) {
+            try {
+                const { fullPath } = page;
+                if (!isNonHiddenPage(fullPath)) {
+                    continue;
+                }
+                const tree = processor.parse(page.content);
+                processFragments(tree, pages, isNonHiddenPage, page.fullPath);
+                page.content = processor.stringify(tree);
+            }
+            catch (e) {
+                throw new PluginError(e.message, page.fullPath);
+            }
+        }
+        return pages;
+    }
+};
+export default FragmentPlugin;
+//# sourceMappingURL=FragmentPlugin.js.map