@jpmorganchase/mosaic-plugins 0.1.0-beta.6 → 0.1.0-beta.60

package/dist/$TagPlugin.js

@@ -1,20 +1,21 @@
-"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"));
+import path from 'path';
+import { escapeRegExp, reduce } from 'lodash-es';
+import PluginError from './utils/PluginError.js';
+function createPageTest(ignorePages, pageExtensions) {
+    const extTest = new RegExp(`${pageExtensions.map(escapeRegExp).join('|')}$`);
+    const ignoreTest = new RegExp(`${ignorePages.map(escapeRegExp).join('|')}$`);
+    return file => !ignoreTest.test(file) && extTest.test(file) && !path.basename(file).startsWith('.');
+}
+const findKeys = (obj, targetProp, pathParts = []) => reduce(obj, (found, value, key) => {
+    if (key === targetProp) {
+        return found.concat({ $$path: pathParts.concat(String(key)), $$value: value });
+    }
+    if (typeof value === 'object') {
+        const foundParents = findKeys(value, targetProp, pathParts.concat(String(key)));
+        return found.concat(...foundParents);
+    }
+    return found;
+}, []);
 /**
  * Plugin that scrapes `$tag` from page metadata and also applies all aliases stored in `config.data.tags`.
  * Tags ultimately resolve down into refs, but are different from normal refs, in that they are applied to the
@@ -25,29 +26,25 @@ const reduce_1 = __importDefault(require("lodash/reduce"));
 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;
                 }
@@ -58,33 +55,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;
-        });
-    }
-};
-exports.default = $TagPlugin;
-const findKeys = (obj, targetProp, pathParts = []) => {
-    return (0, reduce_1.default)(obj, (found, value, key) => {
-        if (key === targetProp) {
-            return found.concat({ $$path: pathParts.concat(String(key)), $$value: value });
-        }
-        if (typeof value === 'object') {
-            const foundParents = findKeys(value, targetProp, pathParts.concat(String(key)));
-            return found.concat(...foundParents);
+            catch (e) {
+                throw new PluginError(e.message, page.fullPath);
+            }
         }
-        return found;
-    }, []);
+        return pages;
+    }
 };
-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 => {
-        return !ignoreTest.test(file) && extTest.test(file) && !path_1.default.basename(file).startsWith('.');
-    };
-}
+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;AAExB,uEAA+C;AAC/C,2DAAmC;AAInC;;;;;;GAMG;AACH,MAAM,UAAU,GAIX;IACH,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,KAAkC,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE;;;YAC5F,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,IAAiC,CAAC;gBAC/C,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;AAE1B,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,YAAsB,EAAE,EAAE,EAAE;IAC7D,OAAO,IAAA,gBAAM,EACX,GAAG,EACH,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QACpB,IAAI,GAAG,KAAK,UAAU,EAAE;YACtB,OAAO,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;SAChF;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAChF,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC;SACtC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,EACD,EAAE,CACH,CAAC;AACJ,CAAC,CAAC;AAEF,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;QACZ,OAAO,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;IAC9F,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"$TagPlugin.js","sourceRoot":"","sources":["../src/$TagPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEjD,OAAO,WAAW,MAAM,wBAAwB,CAAC;AAEjD,SAAS,cAAc,CAAC,WAAW,EAAE,cAAc;IACjD,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7E,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,YAAY,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,IAAI,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,MAAM,CACJ,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;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;YACA,OAAO,KAAK,CAAC;SACd;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;YACxB,IAAI;gBACF,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;oBACnC,SAAS;iBACV;gBACD,MAAM,IAAI,GAAG,IAAI,CAAC;gBAClB,8CAA8C;gBAC9C,IAAI,IAAI,CAAC,IAAI,EAAE,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,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,QAAQ,EAAE,CACtD,CAAC;oBACJ,CAAC,CAAC,CAAC;oBACH,MAAM,CAAC,OAAO,CAAC,EAAE,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;iBACtD;aACF;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,IAAI,WAAW,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;aACjD;SACF;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 declare 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,48 +1,100 @@
-"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());
-    });
+import path from 'node:path';
+import { escapeRegExp } from 'lodash-es';
+import PluginError from './utils/PluginError.js';
+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('.');
 };
-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"));
 /**
  * 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) {
+    async $afterSource(pages, { ignorePages, pageExtensions }, options) {
+        const isNonHiddenPage = createPageTest(ignorePages, pageExtensions);
+        for (const page of pages) {
+            if (!isNonHiddenPage(page.fullPath)) {
+                continue;
+            }
+            try {
                 const breadcrumbs = [];
                 let currentPage = page;
-                let parentDir = path_1.default.posix.dirname(currentPage.fullPath);
-                while (currentPage !== undefined) {
-                    if (breadcrumbs.findIndex(breadcrumb => breadcrumb.id === currentPage.fullPath) === -1) {
-                        breadcrumbs.unshift({
-                            label: currentPage.title,
-                            path: currentPage.route,
-                            id: currentPage.fullPath
-                        });
-                    }
-                    currentPage = pages.find(page => page.fullPath === path_1.default.posix.join(parentDir, options.indexPageName));
+                let parentDir = path.posix.normalize(path.posix.dirname(currentPage.fullPath));
+                const maxBreadcrumbCount = page.fullPath.split('/').length;
+                while (currentPage !== undefined && breadcrumbs.length < maxBreadcrumbCount) {
+                    breadcrumbs.unshift({
+                        label: currentPage.sidebar?.label || currentPage.title,
+                        path: currentPage.route,
+                        id: currentPage.fullPath
+                    });
+                    currentPage = pages.find(
+                    // eslint-disable-next-line @typescript-eslint/no-loop-func
+                    item => item.fullPath === path.posix.join(parentDir, options.indexPageName));
                     if (currentPage) {
-                        parentDir = path_1.default.posix.dirname(path_1.default.posix.join(String(currentPage.fullPath), '..'));
+                        parentDir = path.posix.dirname(path.posix.join(String(currentPage.fullPath), '..'));
                     }
                 }
                 if (!page.breadcrumbs) {
-                    page.breadcrumbs = breadcrumbs;
+                    // filter out any duplicate breadcrumbs
+                    const map = new Map(breadcrumbs.map(crumb => [crumb.id, crumb]));
+                    page.breadcrumbs = [...map.values()];
+                }
+            }
+            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));
+                    }
                 }
             }
-            return pages;
-        });
+        }
+    },
+    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;AAKxB;;GAEG;AACH,MAAM,iBAAiB,GAA8C;IAC7D,YAAY,CAAC,KAAa,EAAE,EAAE,EAAE,OAAO;;YAC3C,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,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;gBAEzD,OAAO,WAAW,KAAK,SAAS,EAAE;oBAChC,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,CACtB,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;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,WAAW,MAAM,wBAAwB,CAAC;AAGjD,MAAM,cAAc,GAAG,CAAC,WAAW,EAAE,cAAc,EAAE,EAAE;IACrD,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;IAC/F,OAAO,IAAI,CAAC,EAAE,CACZ,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;AAaF;;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;YACxB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;gBACnC,SAAS;aACV;YACD,IAAI;gBACF,MAAM,WAAW,GAAsB,EAAE,CAAC;gBAC1C,IAAI,WAAW,GAAG,IAAI,CAAC;gBACvB,IAAI,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAC/E,MAAM,kBAAkB,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;gBAE3D,OAAO,WAAW,KAAK,SAAS,IAAI,WAAW,CAAC,MAAM,GAAG,kBAAkB,EAAE;oBAC3E,WAAW,CAAC,OAAO,CAAC;wBAClB,KAAK,EAAE,WAAW,CAAC,OAAO,EAAE,KAAK,IAAI,WAAW,CAAC,KAAK;wBACtD,IAAI,EAAE,WAAW,CAAC,KAAK;wBACvB,EAAE,EAAE,WAAW,CAAC,QAAQ;qBACzB,CAAC,CAAC;oBAEH,WAAW,GAAG,KAAK,CAAC,IAAI;oBACtB,2DAA2D;oBAC3D,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,aAAa,CAAC,CAC5E,CAAC;oBACF,IAAI,WAAW,EAAE;wBACf,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,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,uCAAuC;oBACvC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;oBACjE,IAAI,CAAC,WAAW,GAAG,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;iBACtC;aACF;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,IAAI,WAAW,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;aACjD;SACF;QAED,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;YACpB,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;gBAClB,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;oBACxB,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;wBAC1D,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;qBACP;oBACD,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,KAAK,CAAC,CAAC;iBACxE;gBAED,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE;oBACjC,KAAK,MAAM,QAAQ,IAAI,KAAK,EAAE;wBAC5B,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;qBACH;iBACF;aACF;SACF;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;YACrC,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;gBACtB,uCAAuC;gBACvC,OAAO;aACR;SACF;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;YACA,OAAO;SACR;QAED,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,EAAE;YAC/B,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC;SACjC;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;YAC3D,OAAO;SACR;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;YACxB,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,UAAU,EAAE,IAAI,CAAC,CAAC;SAC9C;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/FragmentPlugin.d.ts

@@ -0,0 +1,7 @@
+import type { Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+interface FragmentPluginPage {
+    fullPath: string;
+    content: string;
+}
+declare const FragmentPlugin: PluginType<FragmentPluginPage, unknown, unknown>;
+export default FragmentPlugin;

package/dist/FragmentPlugin.js

@@ -0,0 +1,92 @@
+import path from 'path';
+import { escapeRegExp } from 'lodash-es';
+import { remark } from 'remark';
+import remarkMdx from 'remark-mdx';
+import remarkDirective from 'remark-directive';
+import { visitParents } from 'unist-util-visit-parents';
+import PluginError from './utils/PluginError.js';
+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 getFullPath(fullPath, relativePath) {
+    const pathSegments = fullPath.split('/');
+    const relativeSegments = relativePath.split('/');
+    pathSegments.pop();
+    for (const segment of relativeSegments) {
+        if (segment === '..') {
+            pathSegments.pop();
+        }
+        else if (segment !== '.') {
+            pathSegments.push(segment);
+        }
+    }
+    return pathSegments.join('/');
+}
+async function processTree(tree, serialiser, mutableFilesystem, fullPath, isNonHiddenPage) {
+    const nodesToProcess = [];
+    visitParents(tree, (node, ancestors) => {
+        if (node.type === 'code') {
+            return;
+        }
+        const match = node.name === 'fragment' && node.attributes.src;
+        if (match) {
+            const parent = ancestors[ancestors.length - 1];
+            const index = parent.children.indexOf(node);
+            nodesToProcess.push({ node, parent, index });
+        }
+    });
+    for (const { node, parent, index } of nodesToProcess) {
+        const fragmentFullPath = getFullPath(fullPath, node.attributes.src);
+        if (!isNonHiddenPage(fragmentFullPath)) {
+            console.warn(`Invalid file reference: '${node.attributes.src}'. Skipping.`);
+        }
+        else {
+            const fragmentPage = await serialiser.deserialise(fragmentFullPath, await mutableFilesystem.promises.readFile(fragmentFullPath));
+            // 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);
+        }
+    }
+    return tree;
+}
+const FragmentPlugin = {
+    async $beforeSend(mutableFilesystem, { serialiser, ignorePages, pageExtensions }) {
+        const pages = await Promise.all((await mutableFilesystem.promises.glob('**', {
+            onlyFiles: true,
+            ignore: ignorePages.map(ignore => `**/${ignore}`),
+            cwd: '/'
+        })).map(async (pagePath) => {
+            const deserialisedPage = await serialiser.deserialise(pagePath, await mutableFilesystem.promises.readFile(pagePath));
+            return deserialisedPage;
+        }));
+        const isNonHiddenPage = createPageTest(ignorePages, pageExtensions);
+        for (const page of pages) {
+            try {
+                const { fullPath } = page;
+                if (!isNonHiddenPage(fullPath)) {
+                    continue;
+                }
+                const tree = remark().use(remarkMdx).use(remarkDirective).parse(page.content);
+                const processedTree = await processTree(tree, serialiser, mutableFilesystem, fullPath, isNonHiddenPage);
+                page.content = remark()
+                    .data('settings', { fences: true })
+                    .use(remarkMdx)
+                    .use(remarkDirective)
+                    .stringify(processedTree);
+                const updatedFileData = await serialiser.serialise(fullPath, page);
+                await mutableFilesystem.promises.writeFile(fullPath, updatedFileData);
+            }
+            catch (e) {
+                throw new PluginError(e.message, page.fullPath);
+            }
+        }
+    }
+};
+export default FragmentPlugin;
+//# sourceMappingURL=FragmentPlugin.js.map

package/dist/FragmentPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FragmentPlugin.js","sourceRoot":"","sources":["../src/FragmentPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,eAAe,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,WAAW,MAAM,wBAAwB,CAAC;AAOjD,MAAM,cAAc,GAAG,CAAC,WAAW,EAAE,cAAc,EAAE,EAAE;IACrD,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;IAC/F,OAAO,IAAI,CAAC,EAAE,CACZ,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,WAAW,CAAC,QAAgB,EAAE,YAAoB;IACzD,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACzC,MAAM,gBAAgB,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEjD,YAAY,CAAC,GAAG,EAAE,CAAC;IAEnB,KAAK,MAAM,OAAO,IAAI,gBAAgB,EAAE;QACtC,IAAI,OAAO,KAAK,IAAI,EAAE;YACpB,YAAY,CAAC,GAAG,EAAE,CAAC;SACpB;aAAM,IAAI,OAAO,KAAK,GAAG,EAAE;YAC1B,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC5B;KACF;IACD,OAAO,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAChC,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,IAAI,EAAE,UAAU,EAAE,iBAAiB,EAAE,QAAQ,EAAE,eAAe;IACvF,MAAM,cAAc,GAAG,EAAE,CAAC;IAE1B,YAAY,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE;QACrC,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE;YACxB,OAAO;SACR;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;QAC9D,IAAI,KAAK,EAAE;YACT,MAAM,MAAM,GAAG,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAC/C,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC5C,cAAc,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;SAC9C;IACH,CAAC,CAAC,CAAC;IAEH,KAAK,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,cAAc,EAAE;QACpD,MAAM,gBAAgB,GAAG,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACpE,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,EAAE;YACtC,OAAO,CAAC,IAAI,CAAC,4BAA4B,IAAI,CAAC,UAAU,CAAC,GAAG,cAAc,CAAC,CAAC;SAC7E;aAAM;YACL,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,WAAW,CAC/C,gBAAgB,EAChB,MAAM,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAC5D,CAAC;YAEF,+DAA+D;YAC/D,MAAM,OAAO,GAAG;gBACd,IAAI,EAAE,MAAM;gBACZ,KAAK,EAAE,YAAY,CAAC,OAAO;aAC5B,CAAC;YAEF,yDAAyD;YACzD,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;SAC3C;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,cAAc,GAAqD;IACvE,KAAK,CAAC,WAAW,CAAC,iBAAiB,EAAE,EAAE,UAAU,EAAE,WAAW,EAAE,cAAc,EAAE;QAC9E,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAE3B,CAAC,MAAM,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE;YAC3C,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,MAAM,EAAE,CAAC;YACjD,GAAG,EAAE,GAAG;SACT,CAAC,CACH,CAAC,GAAG,CAAC,KAAK,EAAC,QAAQ,EAAC,EAAE;YACrB,MAAM,gBAAgB,GAAG,MAAM,UAAU,CAAC,WAAW,CACnD,QAAQ,EACR,MAAM,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CACpD,CAAC;YACF,OAAO,gBAAgB,CAAC;QAC1B,CAAC,CAAC,CACH,CAAC;QAEF,MAAM,eAAe,GAAG,cAAc,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;QAEpE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,IAAI;gBACF,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;gBAC1B,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE;oBAC9B,SAAS;iBACV;gBAED,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC9E,MAAM,aAAa,GAAG,MAAM,WAAW,CACrC,IAAI,EACJ,UAAU,EACV,iBAAiB,EACjB,QAAQ,EACR,eAAe,CAChB,CAAC;gBAEF,IAAI,CAAC,OAAO,GAAG,MAAM,EAAE;qBACpB,IAAI,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;qBAClC,GAAG,CAAC,SAAS,CAAC;qBACd,GAAG,CAAC,eAAe,CAAC;qBACpB,SAAS,CAAC,aAAa,CAAC,CAAC;gBAE5B,MAAM,eAAe,GAAG,MAAM,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;gBACnE,MAAM,iBAAiB,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;aACvE;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,IAAI,WAAW,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;aACjD;SACF;IACH,CAAC;CACF,CAAC;AAEF,eAAe,cAAc,CAAC"}

package/dist/LazyPagePlugin.d.ts

@@ -0,0 +1,14 @@
+import type { Page, Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+interface LazyPagePluginPage extends Page {
+    aliases: {
+        [key: string]: Set<string>;
+    };
+    hddPaths: {
+        [key: string]: string;
+    };
+}
+interface LazyPagePluginOptions {
+    cacheDir?: string;
+}
+declare const LazyPagePlugin: PluginType<LazyPagePluginPage, LazyPagePluginOptions>;
+export default LazyPagePlugin;