@jpmorganchase/mosaic-plugins 0.0.0-snapshot-20240604074928

package/dist/$AliasPlugin.d.ts

@@ -0,0 +1,10 @@
+import type { Page, Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+interface AliasPluginPage extends Page {
+    aliases?: string[];
+}
+/**
+ * Plugin that scrapes `aliases` from page metadata and also applies all aliases stored in `config.data.aliases`
+ * Other plugins can use `setAliases` to apply new aliases, as long as they call it before this plugin has reaches `$beforeSend`
+ */
+declare const $AliasPlugin: PluginType<AliasPluginPage>;
+export default $AliasPlugin;

package/dist/$AliasPlugin.js

@@ -0,0 +1,66 @@
+import path from 'path';
+import { escapeRegExp } 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('.');
+}
+/**
+ * Plugin that scrapes `aliases` from page metadata and also applies all aliases stored in `config.data.aliases`
+ * Other plugins can use `setAliases` to apply new aliases, as long as they call it before this plugin has reaches `$beforeSend`
+ */
+const $AliasPlugin = {
+    async $afterSource(pages, { config, ignorePages, pageExtensions }) {
+        const isNonHiddenPage = createPageTest(ignorePages, pageExtensions);
+        // Group together all aliases defined in the frontmatter and store them in the alias config object
+        for (const page of pages) {
+            try {
+                if (!isNonHiddenPage(page.fullPath)) {
+                    continue;
+                }
+                if (page.aliases) {
+                    config.setAliases(page.fullPath, page.aliases);
+                }
+                delete page.aliases;
+            }
+            catch (e) {
+                throw new PluginError(e.message, page.fullPath);
+            }
+        }
+        return pages;
+    },
+    async $beforeSend(mutableFilesystem, { config }) {
+        // Prevent any more aliases being set after this lifecycle has been called - as they won't take effect
+        config.setAliases = () => {
+            throw new Error('Cannot set aliases after `$AliasPlugin` has reached `$beforeSend` lifecycle phase.');
+        };
+        if (!config.data.aliases) {
+            return;
+        }
+        for (const fullPath in config.data.aliases) {
+            try {
+                for (const alias of config.data.aliases[fullPath]) {
+                    const aliasPath = path.posix.resolve(path.dirname(fullPath), alias).toLowerCase();
+                    const aliasDir = path.dirname(aliasPath);
+                    if (!(await mutableFilesystem.promises.exists(aliasDir))) {
+                        await mutableFilesystem.promises.mkdir(aliasDir, {
+                            recursive: true
+                        });
+                    }
+                    if (!(await mutableFilesystem.promises.exists(aliasPath))) {
+                        await mutableFilesystem.promises.symlink(fullPath, aliasPath);
+                    }
+                    else {
+                        console.warn(`Alias '${aliasPath}' already exists. Is there a duplicate alias, or a page with the same name but different file extensions?`);
+                    }
+                }
+            }
+            catch (e) {
+                throw new PluginError(e.message, fullPath);
+            }
+        }
+    }
+};
+export default $AliasPlugin;
+//# sourceMappingURL=$AliasPlugin.js.map

package/dist/$AliasPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"$AliasPlugin.js","sourceRoot":"","sources":["../src/$AliasPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC,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;AAMD;;;GAGG;AACH,MAAM,YAAY,GAAgC;IAChD,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,kGAAkG;QAClG,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,IAAI;gBACF,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;oBACnC,SAAS;iBACV;gBACD,IAAI,IAAI,CAAC,OAAO,EAAE;oBAChB,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;iBAChD;gBACD,OAAO,IAAI,CAAC,OAAO,CAAC;aACrB;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;IAED,KAAK,CAAC,WAAW,CAAC,iBAAiB,EAAE,EAAE,MAAM,EAAE;QAC7C,sGAAsG;QACtG,MAAM,CAAC,UAAU,GAAG,GAAG,EAAE;YACvB,MAAM,IAAI,KAAK,CACb,oFAAoF,CACrF,CAAC;QACJ,CAAC,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE;YACxB,OAAO;SACR;QACD,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE;YAC1C,IAAI;gBACF,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;oBACjD,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;oBAClF,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;oBACzC,IAAI,CAAC,CAAC,MAAM,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE;wBACxD,MAAM,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE;4BAC/C,SAAS,EAAE,IAAI;yBAChB,CAAC,CAAC;qBACJ;oBACD,IAAI,CAAC,CAAC,MAAM,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE;wBACzD,MAAM,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;qBAC/D;yBAAM;wBACL,OAAO,CAAC,IAAI,CACV,UAAU,SAAS,2GAA2G,CAC/H,CAAC;qBACH;iBACF;aACF;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,IAAI,WAAW,CAAC,CAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;aAC5C;SACF;IACH,CAAC;CACF,CAAC;AAEF,eAAe,YAAY,CAAC"}

package/dist/$CodeModPlugin.d.ts

@@ -0,0 +1,7 @@
+import type { Page, Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+interface CodeModPluginPage extends Page {
+    frameOverrides?: Record<string, unknown>;
+    sharedConfig?: Record<string, unknown>;
+}
+declare const $CodeModPlugin: PluginType<CodeModPluginPage>;
+export default $CodeModPlugin;

package/dist/$CodeModPlugin.js

@@ -0,0 +1,30 @@
+import { escapeRegExp } from 'lodash-es';
+import path from 'path';
+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 $CodeModPlugin = {
+    async $afterSource(pages, { ignorePages, pageExtensions }) {
+        const isNonHiddenPage = createPageTest(ignorePages, pageExtensions);
+        for (const page of pages) {
+            try {
+                if (!isNonHiddenPage(page.fullPath)) {
+                    continue;
+                }
+                if (page.frameOverrides) {
+                    page.sharedConfig = page.frameOverrides;
+                    page.frameOverrides = { $ref: '#/sharedConfig' };
+                }
+            }
+            catch (e) {
+                throw new PluginError(e.message, page.fullPath);
+            }
+        }
+        return pages;
+    }
+};
+export default $CodeModPlugin;
+//# sourceMappingURL=$CodeModPlugin.js.map

package/dist/$CodeModPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"$CodeModPlugin.js","sourceRoot":"","sources":["../src/$CodeModPlugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,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;AAOD,MAAM,cAAc,GAAkC;IACpD,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE;QACvD,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,IAAI,IAAI,CAAC,cAAc,EAAE;oBACvB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC;oBACxC,IAAI,CAAC,cAAc,GAAG,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;iBAClD;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,cAAc,CAAC"}

package/dist/$RefPlugin.d.ts

@@ -0,0 +1,31 @@
+import type { Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+interface RefsPluginConfigData {
+    refs: {
+        [key: string]: {
+            $$path: string[];
+            $$value: string;
+        }[];
+    };
+    globalRefs: {
+        [key: string]: {
+            $$path: string[];
+            $$value: string;
+        }[];
+    };
+    subscribedTags: string[];
+}
+interface RefsPluginPage {
+    fullPath: string;
+    refs: {
+        [key: string]: {
+            $$path: string[];
+            $$value: string;
+        }[];
+    };
+}
+/**
+ * Plugin that scrapes `$ref` properties from page metadata and also applies all refs stored in `config.data.refs`.
+ * Other plugins can use `setRef` to apply new refs, as long as they call it before this plugin has reaches `$beforeSend`
+ */
+declare const $RefPlugin: PluginType<RefsPluginPage, unknown, RefsPluginConfigData>;
+export default $RefPlugin;

package/dist/$RefPlugin.js

@@ -0,0 +1,150 @@
+import path from 'node:path';
+import os from 'node:os';
+import { reduce, omit, escapeRegExp } from 'lodash-es';
+import { $RefParser } from '@apidevtools/json-schema-ref-parser';
+import deepmerge from 'deepmerge';
+import normaliseRefs from './utils/normaliseRefs.js';
+import PluginError from './utils/PluginError.js';
+import { mergePageContent } from './utils/mergePageConent.js';
+const isWindows = /^win/.test(os.platform());
+const windowsDrivePattern = /^([a-z]):/i;
+/**
+ * The JSON Schema Ref parser turns refs into URLs.
+ * When running on Windows it adds in the drive letter to the beginning of the resolved ref filepath
+ *
+ * WE DON"T WANT THIS
+ *
+ * Regardless of platform, Mosaic uses an in-memory fs so we don't need drive letters.
+ * We need the path as it is in the mosaic fs.
+ */
+function normaliseWindowsPath(url) {
+    const drivePart = windowsDrivePattern.exec(url)?.[0];
+    return drivePart ? url.slice(drivePart.length) : url;
+}
+function createRefResolver(normalisedRefs, serialiser, mutableFilesystem) {
+    return {
+        file: {
+            canRead: true,
+            order: 1,
+            async read(file, callback) {
+                try {
+                    const filePath = isWindows ? normaliseWindowsPath(file.url) : file.url;
+                    const refedPage = normalisedRefs[filePath] ||
+                        (await serialiser.deserialise(filePath, await mutableFilesystem.promises.readFile(filePath)));
+                    return callback(null, omit(refedPage, 'content'));
+                }
+                catch (e) {
+                    return callback(e, null);
+                }
+            }
+        }
+    };
+}
+const findKeys = (obj, targetProp, pathParts = []) => reduce(obj, (found, value, key) => {
+    if (key === targetProp) {
+        return found.concat([[pathParts.concat(String(key)), value]]);
+    }
+    if (typeof value === 'object') {
+        const foundParents = findKeys(value, targetProp, pathParts.concat(String(key)));
+        return found.concat(foundParents);
+    }
+    return found;
+}, []);
+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('.');
+}
+/**
+ * Plugin that scrapes `$ref` properties from page metadata and also applies all refs stored in `config.data.refs`.
+ * Other plugins can use `setRef` to apply new refs, as long as they call it before this plugin has reaches `$beforeSend`
+ */
+const $RefPlugin = {
+    async afterUpdate(mutableFilesystem, { ignorePages, globalFilesystem, serialiser, pageExtensions, globalConfig }) {
+        mutableFilesystem.__internal_do_not_use_addReadFileHook(async (pagePath, fileData) => {
+            if (globalConfig.data.globalRefs[pagePath]) {
+                const expandedRefs = await normaliseRefs(String(pagePath), globalConfig.data.globalRefs[pagePath], globalFilesystem, pageExtensions, ignorePages);
+                const page = await serialiser.deserialise(pagePath, fileData);
+                const normalisedRef = mergePageContent(page, expandedRefs);
+                const resolve = createRefResolver({
+                    [pagePath]: normalisedRef
+                }, serialiser, globalFilesystem);
+                const refParser = new $RefParser();
+                try {
+                    const resolved = await refParser.dereference(String(pagePath), normalisedRef, {
+                        resolve,
+                        dereference: { circular: false }
+                    });
+                    const serialisedPage = await serialiser.serialise(pagePath, {
+                        ...normalisedRef,
+                        ...resolved
+                    });
+                    return serialisedPage;
+                }
+                catch (e) {
+                    console.warn(`Error resolving ref(s) for page '${pagePath}'. ${e.message.replace(/\.$/, '')} in '${e.source}'`);
+                    throw new PluginError(e.message, page.fullPath);
+                }
+            }
+            return fileData;
+        });
+    },
+    async $beforeSend(mutableFilesystem, { config, serialiser, pageExtensions, ignorePages }) {
+        // Prevent any more refs being set after this lifecycle has been called - as they won't take effect
+        config.setRef = () => {
+            throw new Error('Cannot set refs after `RefPlugin` has reached `$beforeSend` lifecycle phase.');
+        };
+        const normalisedRefs = {};
+        if (config.data.refs) {
+            // First pass of refs, normalises any $ref entries to expand wildcards
+            for (const fullPath in config.data.refs) {
+                const page = await serialiser.deserialise(fullPath, await mutableFilesystem.promises.readFile(fullPath));
+                try {
+                    const expandedRefs = await normaliseRefs(String(fullPath), config.data.refs[fullPath], mutableFilesystem, pageExtensions, ignorePages);
+                    normalisedRefs[fullPath] = deepmerge(page, expandedRefs);
+                }
+                catch (e) {
+                    throw new PluginError(e.message, page.fullPath);
+                }
+            }
+            const resolve = createRefResolver(normalisedRefs, serialiser, mutableFilesystem);
+            const refParser = new $RefParser();
+            // Second pass of refs, resolves the refs
+            for (const fullPath in normalisedRefs) {
+                const page = normalisedRefs[fullPath];
+                try {
+                    const resolved = await refParser.dereference(String(fullPath), page, {
+                        resolve,
+                        dereference: { circular: false }
+                    });
+                    normalisedRefs[fullPath] = { ...page, ...resolved };
+                }
+                catch (e) {
+                    console.warn(`Error resolving ref(s) for page '${fullPath}'. ${e.message.replace(/\.$/, '')} in '${e.source}'`);
+                    throw new PluginError(e.message, page.fullPath);
+                }
+            }
+            // Third pass, write out the files
+            for (const fullPath in normalisedRefs) {
+                await mutableFilesystem.promises.writeFile(fullPath, await serialiser.serialise(fullPath, normalisedRefs[fullPath]));
+            }
+        }
+    },
+    async $afterSource(pages, { config, ignorePages, pageExtensions }) {
+        const isNonHiddenPage = createPageTest(ignorePages, pageExtensions);
+        for (const page of pages) {
+            if (!isNonHiddenPage(page.fullPath)) {
+                continue;
+            }
+            const refs = findKeys(page, '$ref');
+            if (refs.length) {
+                for (const ref of refs) {
+                    config.setRef(page.fullPath, ...ref);
+                }
+            }
+        }
+        return pages;
+    }
+};
+export default $RefPlugin;
+//# sourceMappingURL=$RefPlugin.js.map

package/dist/$RefPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"$RefPlugin.js","sourceRoot":"","sources":["../src/$RefPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AAEjE,OAAO,SAAS,MAAM,WAAW,CAAC;AAElC,OAAO,aAAa,MAAM,0BAA0B,CAAC;AACrD,OAAO,WAAW,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAE9D,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;AAC7C,MAAM,mBAAmB,GAAG,YAAY,CAAC;AAEzC;;;;;;;;GAQG;AACH,SAAS,oBAAoB,CAAC,GAAW;IACvC,MAAM,SAAS,GAAG,mBAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACrD,OAAO,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;AACvD,CAAC;AAED,SAAS,iBAAiB,CAAC,cAAc,EAAE,UAAU,EAAE,iBAAiB;IACtE,OAAO;QACL,IAAI,EAAE;YACJ,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,CAAC;YACR,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ;gBACvB,IAAI;oBACF,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;oBACvE,MAAM,SAAS,GACb,cAAc,CAAC,QAAQ,CAAC;wBACxB,CAAC,MAAM,UAAU,CAAC,WAAW,CAC3B,QAAQ,EACR,MAAM,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CACpD,CAAC,CAAC;oBACL,OAAO,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;iBACnD;gBAAC,OAAO,CAAC,EAAE;oBACV,OAAO,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;iBAC1B;YACH,CAAC;SACF;KACF,CAAC;AACJ,CAAC;AAED,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,YAAsB,EAAE,EAAwB,EAAE,CACnF,MAAM,CACJ,GAAG,EACH,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;IACpB,IAAI,GAAG,KAAK,UAAU,EAAE;QACtB,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;KAC/D;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,YAAY,CAAC,CAAC;KACnC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,EACD,EAAE,CACH,CAAC;AAEJ,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;AAaD;;;GAGG;AACH,MAAM,UAAU,GAA8D;IAC5E,KAAK,CAAC,WAAW,CACf,iBAAiB,EACjB,EAAE,WAAW,EAAE,gBAAgB,EAAE,UAAU,EAAE,cAAc,EAAE,YAAY,EAAE;QAE3E,iBAAiB,CAAC,qCAAqC,CAAC,KAAK,EAAE,QAAgB,EAAE,QAAQ,EAAE,EAAE;YAC3F,IAAI,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;gBAC1C,MAAM,YAAY,GAAG,MAAM,aAAa,CACtC,MAAM,CAAC,QAAQ,CAAC,EAChB,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EACtC,gBAAgB,EAChB,cAAc,EACd,WAAW,CACZ,CAAC;gBAEF,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;gBAC9D,MAAM,aAAa,GAAG,gBAAgB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;gBAE3D,MAAM,OAAO,GAAG,iBAAiB,CAC/B;oBACE,CAAC,QAAQ,CAAC,EAAE,aAAa;iBAC1B,EACD,UAAU,EACV,gBAAgB,CACjB,CAAC;gBACF,MAAM,SAAS,GAAG,IAAI,UAAU,EAAE,CAAC;gBAEnC,IAAI;oBACF,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,aAAa,EAAE;wBAC5E,OAAO;wBACP,WAAW,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE;qBACjC,CAAC,CAAC;oBACH,MAAM,cAAc,GAAG,MAAM,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE;wBAC1D,GAAG,aAAa;wBAChB,GAAG,QAAQ;qBACZ,CAAC,CAAC;oBACH,OAAO,cAAc,CAAC;iBACvB;gBAAC,OAAO,CAAC,EAAE;oBACV,OAAO,CAAC,IAAI,CACV,oCAAoC,QAAQ,MAAM,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,QAC5E,CAAC,CAAC,MACJ,GAAG,CACJ,CAAC;oBACF,MAAM,IAAI,WAAW,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;iBACjD;aACF;YAED,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC,CAAC;IACL,CAAC;IACD,KAAK,CAAC,WAAW,CAAC,iBAAiB,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,cAAc,EAAE,WAAW,EAAE;QACtF,mGAAmG;QACnG,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE;YACnB,MAAM,IAAI,KAAK,CACb,8EAA8E,CAC/E,CAAC;QACJ,CAAC,CAAC;QACF,MAAM,cAAc,GAAG,EAAE,CAAC;QAE1B,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE;YACpB,sEAAsE;YACtE,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE;gBACvC,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,WAAW,CACvC,QAAQ,EACR,MAAM,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CACpD,CAAC;gBAEF,IAAI;oBACF,MAAM,YAAY,GAAG,MAAM,aAAa,CACtC,MAAM,CAAC,QAAQ,CAAC,EAChB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAC1B,iBAAiB,EACjB,cAAc,EACd,WAAW,CACZ,CAAC;oBACF,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;iBAC1D;gBAAC,OAAO,CAAC,EAAE;oBACV,MAAM,IAAI,WAAW,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;iBACjD;aACF;YAED,MAAM,OAAO,GAAG,iBAAiB,CAAC,cAAc,EAAE,UAAU,EAAE,iBAAiB,CAAC,CAAC;YACjF,MAAM,SAAS,GAAG,IAAI,UAAU,EAAE,CAAC;YAEnC,yCAAyC;YACzC,KAAK,MAAM,QAAQ,IAAI,cAAc,EAAE;gBACrC,MAAM,IAAI,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;gBACtC,IAAI;oBACF,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE;wBACnE,OAAO;wBACP,WAAW,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE;qBACjC,CAAC,CAAC;oBACH,cAAc,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,EAAE,CAAC;iBACrD;gBAAC,OAAO,CAAC,EAAE;oBACV,OAAO,CAAC,IAAI,CACV,oCAAoC,QAAQ,MAAM,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,QAC5E,CAAC,CAAC,MACJ,GAAG,CACJ,CAAC;oBACF,MAAM,IAAI,WAAW,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;iBACjD;aACF;YACD,kCAAkC;YAClC,KAAK,MAAM,QAAQ,IAAI,cAAc,EAAE;gBACrC,MAAM,iBAAiB,CAAC,QAAQ,CAAC,SAAS,CACxC,QAAQ,EACR,MAAM,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC,CAC/D,CAAC;aACH;SACF;IACH,CAAC;IACD,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,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;gBACnC,SAAS;aACV;YACD,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAEpC,IAAI,IAAI,CAAC,MAAM,EAAE;gBACf,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;oBACtB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,GAAG,CAAC,CAAC;iBACtC;aACF;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/$TagPlugin.d.ts

@@ -0,0 +1,28 @@
+import type { Page, Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+interface TagPluginPage extends Page {
+    tags?: string[];
+}
+interface TagPluginConfigData {
+    tagRefs: {
+        [key: string]: {
+            $$path: string[];
+            $$value: string[];
+        }[];
+    };
+    globalRefs: {
+        [key: string]: {
+            $$path: string[];
+            $$value: string[];
+        }[];
+    };
+    subscribedTags: string[];
+}
+/**
+ * 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
+ * union filesystem (all merged filesystems), not to the individual source filesystem that they were defined on.
+ * Other plugins can use `setData()` and modify the `tags` property, to apply new global refs, as long as
+ * they do so before this plugin has reaches `$beforeSend`
+ */
+declare const $TagPlugin: PluginType<TagPluginPage, unknown, TagPluginConfigData>;
+export default $TagPlugin;

package/dist/$TagPlugin.js

@@ -0,0 +1,71 @@
+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
+ * union filesystem (all merged filesystems), not to the individual source filesystem that they were defined on.
+ * Other plugins can use `setData()` and modify the `tags` property, to apply new global refs, as long as
+ * they do so before this plugin has reaches `$beforeSend`
+ */
+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
+    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
+    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 (meta.tags?.length) {
+                    config.setTags(page.fullPath, meta.tags);
+                    delete meta.tags;
+                }
+                // Find any references to $tag
+                const foundTags = findKeys(page, '$tag');
+                if (foundTags.length) {
+                    const tags = new Set();
+                    foundTags.forEach(ref => {
+                        const [tag, fragment = ''] = ref.$$value.split('#');
+                        tags.add(tag);
+                        config.setGlobalRef(page.fullPath, ref.$$path, `${path.posix.join('/.tags', tag, '**')}#${fragment}`);
+                    });
+                    config.setData({ subscribedTags: Array.from(tags) });
+                }
+            }
+            catch (e) {
+                throw new PluginError(e.message, page.fullPath);
+            }
+        }
+        return pages;
+    }
+};
+export default $TagPlugin;
+//# sourceMappingURL=$TagPlugin.js.map

package/dist/$TagPlugin.js.map

@@ -0,0 +1 @@
+{"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 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

@@ -0,0 +1,100 @@
+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('.');
+};
+/**
+ * Calculates breadcrumbs for pages then embeds a `breadcrumbs` property to the metadata
+ */
+const BreadcrumbsPlugin = {
+    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.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.posix.dirname(path.posix.join(String(currentPage.fullPath), '..'));
+                    }
+                }
+                if (!page.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));
+                    }
+                }
+            }
+        }
+    },
+    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;
+    }
+};
+export default BreadcrumbsPlugin;
+//# sourceMappingURL=BreadcrumbsPlugin.js.map

package/dist/BreadcrumbsPlugin.js.map

@@ -0,0 +1 @@
+{"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;