@jpmorganchase/mosaic-plugins 0.1.0-beta.3 → 0.1.0-beta.31

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,55 @@
+import path from 'path';
+import { escapeRegExp } from 'lodash-es';
+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) {
+            if (!isNonHiddenPage(page.fullPath)) {
+                continue;
+            }
+            if (page.aliases) {
+                config.setAliases(page.fullPath, page.aliases);
+            }
+            delete page.aliases;
+        }
+        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) {
+            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?`);
+                }
+            }
+        }
+    }
+};
+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;AAGzC,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,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;gBACnC,SAAS;aACV;YACD,IAAI,IAAI,CAAC,OAAO,EAAE;gBAChB,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;aAChD;YACD,OAAO,IAAI,CAAC,OAAO,CAAC;SACrB;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,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;gBACjD,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;gBAClF,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;gBACzC,IAAI,CAAC,CAAC,MAAM,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE;oBACxD,MAAM,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE;wBAC/C,SAAS,EAAE,IAAI;qBAChB,CAAC,CAAC;iBACJ;gBACD,IAAI,CAAC,CAAC,MAAM,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE;oBACzD,MAAM,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;iBAC/D;qBAAM;oBACL,OAAO,CAAC,IAAI,CACV,UAAU,SAAS,2GAA2G,CAC/H,CAAC;iBACH;aACF;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,24 @@
+import { escapeRegExp } from 'lodash-es';
+import path from 'path';
+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) {
+            if (!isNonHiddenPage(page.fullPath)) {
+                continue;
+            }
+            if (page.frameOverrides) {
+                page.sharedConfig = page.frameOverrides;
+                page.frameOverrides = { $ref: '#/sharedConfig' };
+            }
+        }
+        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;AAExB,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,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;gBACnC,SAAS;aACV;YACD,IAAI,IAAI,CAAC,cAAc,EAAE;gBACvB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC;gBACxC,IAAI,CAAC,cAAc,GAAG,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;aAClD;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,119 @@
+import path from 'path';
+import { reduce, omit, merge, escapeRegExp } from 'lodash-es';
+import $RefParser from '@apidevtools/json-schema-ref-parser';
+import normaliseRefs from './utils/normaliseRefs.js';
+function createRefResolver(normalisedRefs, serialiser, mutableFilesystem) {
+    return {
+        file: {
+            canRead: true,
+            order: 1,
+            async read(file, callback) {
+                try {
+                    const refedPage = normalisedRefs[file.url] ||
+                        (await serialiser.deserialise(file.url, await mutableFilesystem.promises.readFile(file.url)));
+                    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 normalisedRef = merge(await serialiser.deserialise(pagePath, fileData), await normaliseRefs(String(pagePath), globalConfig.data.globalRefs[pagePath], globalFilesystem, pageExtensions, ignorePages));
+                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, merge(normalisedRef, resolved));
+                    return serialisedPage;
+                }
+                catch (e) {
+                    console.warn(`Error resolving ref(s) for page '${pagePath}'. ${e.message.replace(/\.$/, '')} in '${e.source}'`);
+                    throw e;
+                }
+            }
+            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));
+                normalisedRefs[fullPath] = merge(page, await normaliseRefs(String(fullPath), config.data.refs[fullPath], mutableFilesystem, pageExtensions, ignorePages));
+            }
+            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 e;
+                }
+            }
+            // 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,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAC9D,OAAO,UAAU,MAAM,qCAAqC,CAAC;AAG7D,OAAO,aAAa,MAAM,0BAA0B,CAAC;AAErD,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,SAAS,GACb,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC;wBACxB,CAAC,MAAM,UAAU,CAAC,WAAW,CAC3B,IAAI,CAAC,GAAG,EACR,MAAM,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,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,aAAa,GAAG,KAAK,CACzB,MAAM,UAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAChD,MAAM,aAAa,CACjB,MAAM,CAAC,QAAQ,CAAC,EAChB,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EACtC,gBAAgB,EAChB,cAAc,EACd,WAAW,CACZ,CACF,CAAC;gBACF,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,CAC/C,QAAQ,EACR,KAAK,CAAC,aAAa,EAAE,QAAQ,CAAC,CAC/B,CAAC;oBACF,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,CAAC,CAAC;iBACT;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;gBACF,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAC9B,IAAI,EACJ,MAAM,aAAa,CACjB,MAAM,CAAC,QAAQ,CAAC,EAChB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAC1B,iBAAiB,EACjB,cAAc,EACd,WAAW,CACZ,CACF,CAAC;aACH;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,CAAC,CAAC;iBACT;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,65 @@
+import path from 'path';
+import { escapeRegExp, reduce } from 'lodash-es';
+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) {
+            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.join('/.tags', tag, '**')}#${fragment}`);
+                });
+                config.setData({ subscribedTags: Array.from(tags) });
+            }
+        }
+        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;AAGjD,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,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;gBACnC,SAAS;aACV;YACD,MAAM,IAAI,GAAG,IAAI,CAAC;YAClB,8CAA8C;YAC9C,IAAI,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE;gBACrB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBACzC,OAAO,IAAI,CAAC,IAAI,CAAC;aAClB;YAED,8BAA8B;YAC9B,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACzC,IAAI,SAAS,CAAC,MAAM,EAAE;gBACpB,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;gBAE/B,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;oBACtB,MAAM,CAAC,GAAG,EAAE,QAAQ,GAAG,EAAE,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBAEpD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBAEd,MAAM,CAAC,YAAY,CACjB,IAAI,CAAC,QAAQ,EACb,GAAG,CAAC,MAAM,EACV,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,QAAQ,EAAE,CAChD,CAAC;gBACJ,CAAC,CAAC,CAAC;gBACH,MAAM,CAAC,OAAO,CAAC,EAAE,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aACtD;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/BreadcrumbsPlugin.d.ts

@@ -0,0 +1,18 @@
+import type { Page, Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+export declare type Breadcrumb = {
+    label: string;
+    path: string;
+    id: string;
+};
+export interface BreadcrumbsPluginPage extends Page {
+    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,38 @@
+import path from 'path';
+import { breadcrumbsLayoutSchema } from '@jpmorganchase/mosaic-schemas';
+/**
+ * Calculates breadcrumbs for pages then embeds a `breadcrumbs` property to the metadata
+ */
+const BreadcrumbsPlugin = {
+    async $afterSource(pages, _, options) {
+        for (const page of pages) {
+            if (breadcrumbsLayoutSchema.safeParse(page?.layout).success) {
+                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.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()];
+                }
+            }
+        }
+        return pages;
+    }
+};
+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,MAAM,CAAC;AAExB,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AAaxE;;GAEG;AACH,MAAM,iBAAiB,GAAgE;IACrF,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO;QAClC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,IAAI,uBAAuB,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,OAAO,EAAE;gBAC3D,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,KAAK;wBACxB,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;SACF;QAED,OAAO,KAAK,CAAC;IACf,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/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;

package/dist/LazyPagePlugin.js

@@ -0,0 +1,63 @@
+import fs from 'fs';
+import fsExtra from 'fs-extra';
+import { merge, escapeRegExp } from 'lodash-es';
+import path from 'path';
+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('.');
+}
+function createFileGlob(url, pageExtensions) {
+    if (pageExtensions.length === 1) {
+        return `${url}${pageExtensions[0]}`;
+    }
+    return `${url}{${pageExtensions.join(',')}}`;
+}
+const LazyPagePlugin = {
+    async afterUpdate(mutableFilesystem, { ignorePages, config, pageExtensions, serialiser }) {
+        const isNonHiddenPage = createPageTest(ignorePages, pageExtensions);
+        // This adds a hook that triggers everytime a non-cached page is read from the filesystem.
+        mutableFilesystem.__internal_do_not_use_addReadFileHook(async (pagePath, fileData) => {
+            // If this is a 'page' - read the original file from disk and try to inject anything that's missing.
+            if (isNonHiddenPage(pagePath)) {
+                const currentPage = await serialiser.deserialise(pagePath, fileData);
+                if (config.data.hddPaths?.[pagePath]) {
+                    const page = await serialiser.deserialise(pagePath, await fs.promises.readFile(config.data.hddPaths[pagePath]));
+                    const completePage = await serialiser.serialise(pagePath, merge(page, currentPage, { content: page.content }));
+                    return completePage;
+                }
+            }
+            return fileData;
+        });
+    },
+    async $beforeSend(mutableFilesystem, { config, serialiser, ignorePages, pageExtensions }, options) {
+        const hddPaths = {};
+        let originalDiskSize = 0;
+        let newDiskSize = 0;
+        const allPages = await mutableFilesystem.promises.glob(createFileGlob('**', pageExtensions), {
+            ignore: ignorePages.map(ignore => `**/${ignore}`),
+            cwd: '/',
+            onlyFiles: true
+        });
+        const baseDir = path.join(process.cwd(), options.cacheDir || '.mosaic-lazy-page-plugin-cache');
+        await fsExtra.ensureDir(baseDir);
+        for (const filePath of allPages) {
+            const rawPage = await mutableFilesystem.promises.readFile(String(filePath));
+            const page = await serialiser.deserialise(String(filePath), rawPage);
+            originalDiskSize += rawPage.length;
+            await fs.promises.mkdir(path.dirname(path.join(baseDir, String(filePath))), {
+                recursive: true
+            });
+            await fs.promises.writeFile(path.join(baseDir, String(filePath)), await serialiser.serialise(String(filePath), page));
+            const { content, ...pageRest } = page;
+            hddPaths[String(filePath)] = path.join(baseDir, String(filePath));
+            const redactedPage = await serialiser.serialise(String(filePath), pageRest);
+            newDiskSize += redactedPage.length;
+        }
+        config.setData({ hddPaths });
+        const reduction = originalDiskSize - newDiskSize;
+        console.info(`[Mosaic] LazyPagePlugin moved ${((reduction / originalDiskSize) * 100).toFixed(2)}% of virtual filesystem content to the hard disk. This reduced the virtual filesystem size from ${(originalDiskSize / 1000000).toFixed(2)}mb to ${(newDiskSize / 1000000).toFixed(2)}mb (yay!)`);
+    }
+};
+export default LazyPagePlugin;
+//# sourceMappingURL=LazyPagePlugin.js.map

package/dist/LazyPagePlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LazyPagePlugin.js","sourceRoot":"","sources":["../src/LazyPagePlugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,OAAO,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,IAAI,MAAM,MAAM,CAAC;AAGxB,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,SAAS,cAAc,CAAC,GAAG,EAAE,cAAc;IACzC,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE;QAC/B,OAAO,GAAG,GAAG,GAAG,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;KACrC;IACD,OAAO,GAAG,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;AAC/C,CAAC;AAUD,MAAM,cAAc,GAA0D;IAC5E,KAAK,CAAC,WAAW,CAAC,iBAAiB,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE;QACtF,MAAM,eAAe,GAAG,cAAc,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;QAEpE,0FAA0F;QAC1F,iBAAiB,CAAC,qCAAqC,CACrD,KAAK,EAAE,QAAgB,EAAE,QAAkB,EAAE,EAAE;YAC7C,oGAAoG;YACpG,IAAI,eAAe,CAAC,QAAQ,CAAC,EAAE;gBAC7B,MAAM,WAAW,GAAG,MAAM,UAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;gBACrE,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE;oBACpC,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,WAAW,CACvC,QAAQ,EACR,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAC3D,CAAC;oBACF,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,SAAS,CAC7C,QAAQ,EACR,KAAK,CAAC,IAAI,EAAE,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CACpD,CAAC;oBACF,OAAO,YAAY,CAAC;iBACrB;aACF;YACD,OAAO,QAAQ,CAAC;QAClB,CAAC,CACF,CAAC;IACJ,CAAC;IACD,KAAK,CAAC,WAAW,CACf,iBAAiB,EACjB,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,cAAc,EAAE,EACnD,OAAO;QAEP,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,IAAI,gBAAgB,GAAG,CAAC,CAAC;QACzB,IAAI,WAAW,GAAG,CAAC,CAAC;QACpB,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE;YAC3F,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,MAAM,EAAE,CAAC;YACjD,GAAG,EAAE,GAAG;YACR,SAAS,EAAE,IAAI;SAChB,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC,QAAQ,IAAI,gCAAgC,CAAC,CAAC;QAC/F,MAAM,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACjC,KAAK,MAAM,QAAQ,IAAI,QAAQ,EAAE;YAC/B,MAAM,OAAO,GAAG,MAAM,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC5E,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC;YACrE,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;YACnC,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;gBAC1E,SAAS,EAAE,IAAI;aAChB,CAAC,CAAC;YACH,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CACzB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,EACpC,MAAM,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,CACnD,CAAC;YACF,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;YACtC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;YAClE,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;YAC5E,WAAW,IAAI,YAAY,CAAC,MAAM,CAAC;SACpC;QAED,MAAM,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QAE7B,MAAM,SAAS,GAAG,gBAAgB,GAAG,WAAW,CAAC;QACjD,OAAO,CAAC,IAAI,CACV,iCAAiC,CAAC,CAAC,SAAS,GAAG,gBAAgB,CAAC,GAAG,GAAG,CAAC,CAAC,OAAO,CAC7E,CAAC,CACF,mGAAmG,CAClG,gBAAgB,GAAG,OAAO,CAC3B,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,WAAW,GAAG,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CACnE,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,eAAe,cAAc,CAAC"}

package/dist/LocalFolderSavePlugin.d.ts

@@ -0,0 +1,6 @@
+import type { Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+export interface LocalFolderSavePluginData {
+    markdown: string;
+}
+declare const LocalFolderSavePlugin: PluginType;
+export default LocalFolderSavePlugin;