@jpmorganchase/mosaic-plugins 0.1.0-beta.10

package/dist/PagesWithoutFileExtPlugin.d.ts

@@ -0,0 +1,9 @@
+import type { Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+/**
+ * Plugin that creates aliases without the file extension for every page emitted by the source.
+ * This allows pages to be retrieved from the filesystem without specifying `.mdx` (or whatever file extension is specified in `options.stripExt`).
+ * The plugin also modifies the `route` to point to the shorter alias. Friendly fullPaths are the shortest possible paths that
+ * will point to the page (see `Page` docs)
+ */
+declare const PagesWithoutFileExtPlugin: PluginType;
+export default PagesWithoutFileExtPlugin;

package/dist/PagesWithoutFileExtPlugin.js

@@ -0,0 +1,29 @@
+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('.');
+}
+/**
+ * Plugin that creates aliases without the file extension for every page emitted by the source.
+ * This allows pages to be retrieved from the filesystem without specifying `.mdx` (or whatever file extension is specified in `options.stripExt`).
+ * The plugin also modifies the `route` to point to the shorter alias. Friendly fullPaths are the shortest possible paths that
+ * will point to the page (see `Page` docs)
+ */
+const PagesWithoutFileExtPlugin = {
+    async $afterSource(pages, { config, ignorePages, pageExtensions }) {
+        const isNonHiddenPage = createPageTest(ignorePages, pageExtensions);
+        const pageTest = new RegExp(`${pageExtensions.map(escapeRegExp).join('|')}$`);
+        for (const page of pages) {
+            if (!isNonHiddenPage(page.fullPath)) {
+                continue;
+            }
+            page.route = page.route.replace(pageTest, '');
+            config.setAliases(page.fullPath, [page.route]);
+        }
+        return pages;
+    }
+};
+export default PagesWithoutFileExtPlugin;
+//# sourceMappingURL=PagesWithoutFileExtPlugin.js.map

package/dist/PagesWithoutFileExtPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PagesWithoutFileExtPlugin.js","sourceRoot":"","sources":["../src/PagesWithoutFileExtPlugin.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;AAED;;;;;GAKG;AACH,MAAM,yBAAyB,GAAe;IAC5C,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;QACpE,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAE9E,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;gBACnC,SAAS;aACV;YACD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAC9C,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;SAChD;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF,CAAC;AAEF,eAAe,yBAAyB,CAAC"}

package/dist/ReadingTimePlugin.d.ts

@@ -0,0 +1,10 @@
+import type { Page, Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+import getReadingTime from 'reading-time';
+interface ReadingTimePluginPage extends Page {
+    readingTime?: ReturnType<typeof getReadingTime>;
+}
+/**
+ * Calculates reading time for pages and adds to frontmatter
+ */
+declare const ReadingTimePlugin: PluginType<ReadingTimePluginPage>;
+export default ReadingTimePlugin;

package/dist/ReadingTimePlugin.js

@@ -0,0 +1,23 @@
+import getReadingTime from 'reading-time';
+import markdown from 'remark-parse';
+import { unified } from 'unified';
+import { visit } from 'unist-util-visit';
+/**
+ * Calculates reading time for pages and adds to frontmatter
+ */
+const ReadingTimePlugin = {
+    async $afterSource(pages) {
+        const processor = unified().use(markdown);
+        for (const page of pages) {
+            const tree = await processor.parse(page.content);
+            let textContent = '';
+            visit(tree, node => node.type === 'text' || node.type === 'code', (node) => {
+                textContent += node.value;
+            });
+            page.readingTime = getReadingTime(textContent);
+        }
+        return pages;
+    }
+};
+export default ReadingTimePlugin;
+//# sourceMappingURL=ReadingTimePlugin.js.map

package/dist/ReadingTimePlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadingTimePlugin.js","sourceRoot":"","sources":["../src/ReadingTimePlugin.ts"],"names":[],"mappings":"AACA,OAAO,cAAc,MAAM,cAAc,CAAC;AAC1C,OAAO,QAAQ,MAAM,cAAc,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAWzC;;GAEG;AACH,MAAM,iBAAiB,GAAsC;IAC3D,KAAK,CAAC,YAAY,CAAC,KAAK;QACtB,MAAM,SAAS,GAAG,OAAO,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC1C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACjD,IAAI,WAAW,GAAG,EAAE,CAAC;YAErB,KAAK,CACH,IAAI,EACJ,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EACpD,CAAC,IAAc,EAAE,EAAE;gBACjB,WAAW,IAAI,IAAI,CAAC,KAAK,CAAC;YAC5B,CAAC,CACF,CAAC;YACF,IAAI,CAAC,WAAW,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;SAChD;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CACF,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/dist/SearchIndexPlugin.d.ts

@@ -0,0 +1,12 @@
+import type { Page, Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+interface SearchIndexPluginOptions {
+    maxLineLength?: number;
+    maxLineCount?: number;
+    keys?: string[];
+}
+/**
+ * Creates a search-data.json file that contains all the information from a page that is required
+ * to generate a search index
+ */
+declare const SearchIndexPlugin: PluginType<Page, SearchIndexPluginOptions>;
+export default SearchIndexPlugin;

package/dist/SearchIndexPlugin.js

@@ -0,0 +1,80 @@
+import { unified } from 'unified';
+import markdown from 'remark-parse';
+import remarkMdx from 'remark-mdx';
+import { visit } from 'unist-util-visit';
+/**
+ * Converts raw content string into an array of sentences suitable for inclusion
+ * in the search index
+ *
+ * @param options.content the raw content string
+ * @param options.title the title of the page  (used for adding context to parse errors)
+ * @param options.maxLineLength the maximum length of a sentence (set this to match the
+ * "location" option in your Fuse.js configuration). Sentences longer than this value will be
+ * truncated.
+ * @param options.maxLineCount the maximum number of lines to include in the search index for
+ * each page. Pages with more lines than this value will be truncated.
+ * @returns array of sentence strings
+ */
+const optimizeContentForSearch = async ({ content, title, maxLineLength, maxLineCount }) => {
+    if (!content || content.length < 1)
+        return [content];
+    const processor = unified().use(markdown).use(remarkMdx);
+    let tree;
+    try {
+        tree = await processor.parse(content);
+    }
+    catch (err) {
+        console.error(`Search Index Plugin failed to parse content for ${title}`, err.reason);
+        return [];
+    }
+    const sentences = [];
+    visit(tree, (node) => node.type === 'text' || node.type === 'code', (node) => {
+        if (maxLineLength) {
+            sentences.push(node.value.slice(0, maxLineLength));
+        }
+        else {
+            sentences.push(node.value);
+        }
+    });
+    if (maxLineLength) {
+        return sentences.slice(0, maxLineCount);
+    }
+    return sentences;
+};
+/**
+ * Creates a search-data.json file that contains all the information from a page that is required
+ * to generate a search index
+ */
+const SearchIndexPlugin = {
+    async afterUpdate(mutableFilesystem, { sharedFilesystem, serialiser, ignorePages }, { maxLineLength, maxLineCount, keys }) {
+        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 searchData = await Promise.all(pages.map(async (page) => {
+            const content = await optimizeContentForSearch({
+                content: page.content || '',
+                title: page.title || '',
+                maxLineLength,
+                maxLineCount
+            });
+            const defaultResults = {
+                title: page.title,
+                content,
+                route: page.route
+            };
+            if (keys && keys.length > 0) {
+                const extendedResults = keys.reduce((acc, key) => ({ ...acc, [key]: page[key] }), {});
+                return { ...defaultResults, ...extendedResults };
+            }
+            return defaultResults;
+        }));
+        await sharedFilesystem.promises.writeFile('/search-data.json', JSON.stringify(searchData));
+    }
+};
+export default SearchIndexPlugin;
+//# sourceMappingURL=SearchIndexPlugin.js.map

package/dist/SearchIndexPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SearchIndexPlugin.js","sourceRoot":"","sources":["../src/SearchIndexPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,QAAQ,MAAM,cAAc,CAAC;AACpC,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAqBzC;;;;;;;;;;;;GAYG;AACH,MAAM,wBAAwB,GAAG,KAAK,EAAE,EACtC,OAAO,EACP,KAAK,EACL,aAAa,EACb,YAAY,EACC,EAAE,EAAE;IACjB,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACrD,MAAM,SAAS,GAAG,OAAO,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACzD,IAAI,IAAI,CAAC;IAET,IAAI;QACF,IAAI,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;KACvC;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,CAAC,KAAK,CAAC,mDAAmD,KAAK,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QACtF,OAAO,EAAE,CAAC;KACX;IAED,MAAM,SAAS,GAAa,EAAE,CAAC;IAE/B,KAAK,CACH,IAAI,EACJ,CAAC,IAAU,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAC5D,CAAC,IAAc,EAAE,EAAE;QACjB,IAAI,aAAa,EAAE;YACjB,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC;SACpD;aAAM;YACL,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SAC5B;IACH,CAAC,CACF,CAAC;IAEF,IAAI,aAAa,EAAE;QACjB,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;KACzC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,iBAAiB,GAA+C;IACpE,KAAK,CAAC,WAAW,CACf,iBAAiB,EACjB,EAAE,gBAAgB,EAAE,UAAU,EAAE,WAAW,EAAE,EAC7C,EAAE,aAAa,EAAE,YAAY,EAAE,IAAI,EAAE;QAErC,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,UAAU,GAAG,MAAM,OAAO,CAAC,GAAG,CAClC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAC,IAAI,EAAC,EAAE;YACrB,MAAM,OAAO,GAAG,MAAM,wBAAwB,CAAC;gBAC7C,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE;gBAC3B,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE;gBACvB,aAAa;gBACb,YAAY;aACb,CAAC,CAAC;YACH,MAAM,cAAc,GAAG;gBACrB,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,OAAO;gBACP,KAAK,EAAE,IAAI,CAAC,KAAK;aAClB,CAAC;YAEF,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC3B,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;gBACtF,OAAO,EAAE,GAAG,cAAc,EAAE,GAAG,eAAe,EAAE,CAAC;aAClD;YAED,OAAO,cAAc,CAAC;QACxB,CAAC,CAAC,CACH,CAAC;QAEF,MAAM,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;IAC7F,CAAC;CACF,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/dist/SharedConfigPlugin.d.ts

@@ -0,0 +1,13 @@
+import type { Page, Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+interface SharedConfigPluginPage extends Page {
+    sharedConfig?: string;
+}
+interface SharedConfigPluginOptions {
+    filename: string;
+}
+/**
+ * Plugin that crawls the page hierarchy to find the closest `sharedConfig` from any parent index's page metadata.
+ * It then exports a JSON file (name: `options.filename`) into each directory with the merged config for that level
+ */
+declare const SharedConfigPlugin: PluginType<SharedConfigPluginPage, SharedConfigPluginOptions>;
+export default SharedConfigPlugin;

package/dist/SharedConfigPlugin.js

@@ -0,0 +1,34 @@
+import { flatten } from 'lodash-es';
+import path from 'path';
+function createFileGlob(url, pageExtensions) {
+    if (pageExtensions.length === 1) {
+        return `${url}${pageExtensions[0]}`;
+    }
+    return `${url}{${pageExtensions.join(',')}}`;
+}
+/**
+ * Plugin that crawls the page hierarchy to find the closest `sharedConfig` from any parent index's page metadata.
+ * It then exports a JSON file (name: `options.filename`) into each directory with the merged config for that level
+ */
+const SharedConfigPlugin = {
+    async $beforeSend(mutableFilesystem, { config, serialiser, ignorePages, pageExtensions }, options) {
+        const pagePaths = await mutableFilesystem.promises.glob(createFileGlob('**/index', pageExtensions), {
+            ignore: [options.filename, ...flatten(ignorePages.map(ignore => [ignore, `**/${ignore}`]))],
+            cwd: '/'
+        });
+        for (const pagePath of pagePaths) {
+            const sharedConfigFile = path.join(path.dirname(String(pagePath)), options.filename);
+            const page = await serialiser.deserialise(String(pagePath), await mutableFilesystem.promises.readFile(String(pagePath)));
+            if (page.sharedConfig) {
+                config.setRef(sharedConfigFile, ['config', '$ref'], `${String(pagePath)}#/sharedConfig`);
+                await mutableFilesystem.promises.writeFile(sharedConfigFile, '{}');
+            }
+            else {
+                const baseDir = path.resolve(path.dirname(String(pagePath)), '../');
+                config.setAliases(path.join(baseDir, options.filename), [sharedConfigFile]);
+            }
+        }
+    }
+};
+export default SharedConfigPlugin;
+//# sourceMappingURL=SharedConfigPlugin.js.map

package/dist/SharedConfigPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SharedConfigPlugin.js","sourceRoot":"","sources":["../src/SharedConfigPlugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,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;;;GAGG;AACH,MAAM,kBAAkB,GAAkE;IACxF,KAAK,CAAC,WAAW,CACf,iBAAiB,EACjB,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,cAAc,EAAE,EACnD,OAAO;QAEP,MAAM,SAAS,GAAG,MAAM,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CACrD,cAAc,CAAC,UAAU,EAAE,cAAc,CAAC,EAC1C;YACE,MAAM,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;YAC3F,GAAG,EAAE,GAAG;SACT,CACF,CAAC;QAEF,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;YAChC,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;YAErF,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,WAAW,CACvC,MAAM,CAAC,QAAQ,CAAC,EAChB,MAAM,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAC5D,CAAC;YACF,IAAI,IAAI,CAAC,YAAY,EAAE;gBACrB,MAAM,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;gBACzF,MAAM,iBAAiB,CAAC,QAAQ,CAAC,SAAS,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;aACpE;iBAAM;gBACL,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBAEpE,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;aAC7E;SACF;IACH,CAAC;CACF,CAAC;AAEF,eAAe,kBAAkB,CAAC"}

package/dist/SidebarPlugin.d.ts

@@ -0,0 +1,25 @@
+import type { Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+import { Page } from '@jpmorganchase/mosaic-types';
+interface SidebarPluginConfigData {
+    dirs: string[];
+    refs: {
+        [key: string]: {
+            $$path: (number | string)[];
+            $$value: string;
+        }[];
+    };
+}
+interface SidebarPluginPage extends Page {
+    sidebar?: {
+        label?: string;
+    };
+}
+interface SidebarPluginOptions {
+    filename: string;
+}
+/**
+ * Sorts the pages in a folder by priority and then exports a JSON file (name: `options.filename`) with the
+ * sidebar tree from that directory downwards and adds sidebar data into frontmatter for each page.
+ */
+declare const SidebarPlugin: PluginType<SidebarPluginPage, SidebarPluginOptions, SidebarPluginConfigData>;
+export default SidebarPlugin;

package/dist/SidebarPlugin.js

@@ -0,0 +1,95 @@
+import path from 'path';
+function createFileGlob(patterns, pageExtensions) {
+    if (Array.isArray(patterns)) {
+        return patterns.map(pattern => createFileGlob(pattern, pageExtensions));
+    }
+    if (pageExtensions.length === 1) {
+        return `${patterns}${pageExtensions[0]}`;
+    }
+    return `${patterns}{${pageExtensions.join(',')}}`;
+}
+function isSubfolderIndex(page, dirName) {
+    return page.fullPath.split('/').length === String(dirName).split('/').length + 2;
+}
+function sortFn(pageA, pageB, dirName) {
+    // Always pin /index to the front
+    const route = `${dirName}/index`;
+    if (pageA.route === route) {
+        return -1;
+    }
+    if (pageB.route === route) {
+        return 1;
+    }
+    return ((pageB.sidebar && pageB.sidebar.priority ? pageB.sidebar.priority : -1) -
+        (pageA.sidebar && pageA.sidebar.priority ? pageA.sidebar.priority : -1));
+}
+function filterFn(page) {
+    return !(page.sidebar && page.sidebar.exclude);
+}
+/**
+ * Sorts the pages in a folder by priority and then exports a JSON file (name: `options.filename`) with the
+ * sidebar tree from that directory downwards and adds sidebar data into frontmatter for each page.
+ */
+const SidebarPlugin = {
+    async $beforeSend(mutableFilesystem, { config, serialiser, ignorePages, pageExtensions }, options) {
+        function setPageRefs(sidebarFilePath, page, i) {
+            config.setRef(sidebarFilePath, ['pages', `${i}`, 'id', '$ref'], `${page.fullPath}#/route`);
+            const label = page.sidebar && page.sidebar.label
+                ? `${page.fullPath}#/sidebar/label`
+                : `${page.fullPath}#/title`;
+            config.setRef(sidebarFilePath, ['pages', `${i}`, 'name', '$ref'], label);
+            config.setRef(sidebarFilePath, ['pages', `${i}`, 'data', 'link', '$ref'], `${page.fullPath}#/route`);
+        }
+        async function setChildPageRefs(page, dirName, i, sidebarFilePath) {
+            if (isSubfolderIndex(page, dirName)) {
+                const childDirName = path.posix.dirname(page.fullPath);
+                const childNodeSidebarPath = path.posix.join(childDirName, options.filename);
+                const childPages = (await Promise.all((await mutableFilesystem.promises.glob(createFileGlob(['*', '*/index'], pageExtensions), {
+                    onlyFiles: true,
+                    cwd: String(childDirName),
+                    ignore: ignorePages.map(ignore => `**/${ignore}`)
+                })).map(async (pagePath) => {
+                    const deserialisedPage = await serialiser.deserialise(pagePath, await mutableFilesystem.promises.readFile(pagePath));
+                    return deserialisedPage;
+                }))).filter(filterPage => filterFn(filterPage));
+                if (childPages.length > 1) {
+                    for (let j = 1; j < childPages.length; j++) {
+                        config.setRef(sidebarFilePath, ['pages', `${i}`, 'childNodes', `${j - 1}`, '$ref'], `${childNodeSidebarPath}#/pages/${j}`);
+                    }
+                }
+            }
+        }
+        function addSidebarDataToFrontmatter(page, dirName) {
+            const dirNameLevels = String(dirName)
+                .split('/')
+                .filter(level => level);
+            const sidebarRootDir = path.posix.join('/', ...dirNameLevels.slice(0, dirNameLevels.length < 3 ? dirNameLevels.length : 3), '/');
+            config.setRef(String(page.fullPath), ['sidebarData', '$ref'], path.posix.join(String(sidebarRootDir), options.filename, '#', 'pages'));
+        }
+        const dirs = await mutableFilesystem.promises.glob('**', {
+            onlyDirectories: true,
+            cwd: '/'
+        });
+        for (const dirName of dirs) {
+            const sidebarFilePath = path.posix.join(String(dirName), options.filename);
+            const pages = (await Promise.all((await mutableFilesystem.promises.glob(createFileGlob(['*', '*/index'], pageExtensions), {
+                onlyFiles: true,
+                cwd: String(dirName),
+                ignore: ignorePages.map(ignore => `**/${ignore}`)
+            })).map(async (pagePath) => {
+                const deserialisedPage = await serialiser.deserialise(pagePath, await mutableFilesystem.promises.readFile(pagePath));
+                return deserialisedPage;
+            })))
+                .filter(page => filterFn(page))
+                .sort((pageA, pageB) => sortFn(pageA, pageB, dirName));
+            for (let i = 0; i < pages.length; i++) {
+                setPageRefs(sidebarFilePath, pages[i], i);
+                setChildPageRefs(pages[i], dirName, i, sidebarFilePath);
+                addSidebarDataToFrontmatter(pages[i], dirName);
+            }
+            await mutableFilesystem.promises.writeFile(sidebarFilePath, '[]');
+        }
+    }
+};
+export default SidebarPlugin;
+//# sourceMappingURL=SidebarPlugin.js.map

package/dist/SidebarPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SidebarPlugin.js","sourceRoot":"","sources":["../src/SidebarPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAIxB,SAAS,cAAc,CAAC,QAAQ,EAAE,cAAc;IAC9C,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QAC3B,OAAO,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC;KACzE;IACD,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE;QAC/B,OAAO,GAAG,QAAQ,GAAG,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;KAC1C;IACD,OAAO,GAAG,QAAQ,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;AACpD,CAAC;AACD,SAAS,gBAAgB,CAAC,IAAI,EAAE,OAAO;IACrC,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;AACnF,CAAC;AAED,SAAS,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO;IACnC,iCAAiC;IAEjC,MAAM,KAAK,GAAG,GAAG,OAAO,QAAQ,CAAC;IACjC,IAAI,KAAK,CAAC,KAAK,KAAK,KAAK,EAAE;QACzB,OAAO,CAAC,CAAC,CAAC;KACX;IACD,IAAI,KAAK,CAAC,KAAK,KAAK,KAAK,EAAE;QACzB,OAAO,CAAC,CAAC;KACV;IACD,OAAO,CACL,CAAC,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACvE,CAAC,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACxE,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,IAAI;IACpB,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACjD,CAAC;AAiBD;;;GAGG;AACH,MAAM,aAAa,GACjB;IACE,KAAK,CAAC,WAAW,CACf,iBAAiB,EACjB,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,cAAc,EAAE,EACnD,OAAO;QAEP,SAAS,WAAW,CAAC,eAAuB,EAAE,IAAuB,EAAE,CAAS;YAC9E,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,SAAS,CAAC,CAAC;YAE3F,MAAM,KAAK,GACT,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK;gBAChC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,iBAAiB;gBACnC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,SAAS,CAAC;YAEhC,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC;YAEzE,MAAM,CAAC,MAAM,CACX,eAAe,EACf,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EACzC,GAAG,IAAI,CAAC,QAAQ,SAAS,CAC1B,CAAC;QACJ,CAAC;QAED,KAAK,UAAU,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,eAAe;YAC/D,IAAI,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE;gBACnC,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACvD,MAAM,oBAAoB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAC7E,MAAM,UAAU,GAAG,CACjB,MAAM,OAAO,CAAC,GAAG,CAEb,CAAC,MAAM,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CACpC,cAAc,CAAC,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE,cAAc,CAAC,EAChD;oBACE,SAAS,EAAE,IAAI;oBACf,GAAG,EAAE,MAAM,CAAC,YAAY,CAAC;oBACzB,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,MAAM,EAAE,CAAC;iBAClD,CACF,CACF,CAAC,GAAG,CAAC,KAAK,EAAC,QAAQ,EAAC,EAAE;oBACrB,MAAM,gBAAgB,GAAG,MAAM,UAAU,CAAC,WAAW,CACnD,QAAQ,EACR,MAAM,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CACpD,CAAC;oBACF,OAAO,gBAAgB,CAAC;gBAC1B,CAAC,CAAC,CACH,CACF,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;gBAC7C,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;oBACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;wBAC1C,MAAM,CAAC,MAAM,CACX,eAAe,EACf,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,EAAE,YAAY,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,EACnD,GAAG,oBAAoB,WAAW,CAAC,EAAE,CACtC,CAAC;qBACH;iBACF;aACF;QACH,CAAC;QAED,SAAS,2BAA2B,CAAC,IAAI,EAAE,OAAO;YAChD,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC;iBAClC,KAAK,CAAC,GAAG,CAAC;iBACV,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;YAC1B,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CACpC,GAAG,EACH,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAC9E,GAAG,CACJ,CAAC;YAEF,MAAM,CAAC,MAAM,CACX,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EACrB,CAAC,aAAa,EAAE,MAAM,CAAC,EACvB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,CAAC,CACxE,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE;YACvD,eAAe,EAAE,IAAI;YACrB,GAAG,EAAE,GAAG;SACT,CAAC,CAAC;QACH,KAAK,MAAM,OAAO,IAAI,IAAI,EAAE;YAC1B,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC3E,MAAM,KAAK,GAAG,CACZ,MAAM,OAAO,CAAC,GAAG,CAEb,CAAC,MAAM,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CACpC,cAAc,CAAC,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE,cAAc,CAAC,EAChD;gBACE,SAAS,EAAE,IAAI;gBACf,GAAG,EAAE,MAAM,CAAC,OAAO,CAAC;gBACpB,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,MAAM,EAAE,CAAC;aAClD,CACF,CACF,CAAC,GAAG,CAAC,KAAK,EAAC,QAAQ,EAAC,EAAE;gBACrB,MAAM,gBAAgB,GAAG,MAAM,UAAU,CAAC,WAAW,CACnD,QAAQ,EACR,MAAM,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CACpD,CAAC;gBACF,OAAO,gBAAgB,CAAC;YAC1B,CAAC,CAAC,CACH,CACF;iBACE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;iBAC9B,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;YAEzD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBACrC,WAAW,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC1C,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,eAAe,CAAC,CAAC;gBACxD,2BAA2B,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;aAChD;YACD,MAAM,iBAAiB,CAAC,QAAQ,CAAC,SAAS,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;SACnE;IACH,CAAC;CACF,CAAC;AACJ,eAAe,aAAa,CAAC"}

package/dist/SiteMapPlugin.d.ts

@@ -0,0 +1,6 @@
+import type { Page, Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+interface SiteMapPluginConfigData {
+    sitemaps: Array<string[]>;
+}
+declare const SiteMapPlugin: PluginType<Page, unknown, SiteMapPluginConfigData, SiteMapPluginConfigData>;
+export default SiteMapPlugin;

package/dist/SiteMapPlugin.js

@@ -0,0 +1,27 @@
+const SiteMapPlugin = {
+    // Merge together all of the individual sitemaps from each source
+    async afterUpdate(_, { sharedFilesystem, globalConfig }) {
+        if (!Array.isArray(globalConfig.data.sitemaps)) {
+            return;
+        }
+        const urls = globalConfig.data.sitemaps.map(items => items
+            .map(item => `\t<url>\n\t\t<loc>${String(item)}</loc>\n\t\t<changefreq>weekly</changefreq>\n\t\t<priority>0.5</priority>\n\t</url>`)
+            .join('\n'));
+        const urlSet = `<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">\n ${urls}\n\n</urlset>`;
+        await sharedFilesystem.promises.writeFile('/sitemap.xml', urlSet);
+    },
+    // Store a sitemap for just this source
+    async $beforeSend(mutableFilesystem, { config, ignorePages }) {
+        config.setData({
+            sitemaps: [
+                (await mutableFilesystem.promises.glob('**', {
+                    onlyFiles: true,
+                    ignore: ignorePages.map(ignore => `**/${ignore}`),
+                    cwd: '/'
+                }))
+            ]
+        });
+    }
+};
+export default SiteMapPlugin;
+//# sourceMappingURL=SiteMapPlugin.js.map

package/dist/SiteMapPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SiteMapPlugin.js","sourceRoot":"","sources":["../src/SiteMapPlugin.ts"],"names":[],"mappings":"AAMA,MAAM,aAAa,GAAgF;IACjG,iEAAiE;IACjE,KAAK,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,gBAAgB,EAAE,YAAY,EAAE;QACrD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YAC9C,OAAO;SACR;QAED,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAClD,KAAK;aACF,GAAG,CACF,IAAI,CAAC,EAAE,CACL,qBAAqB,MAAM,CACzB,IAAI,CACL,qFAAqF,CACzF;aACA,IAAI,CAAC,IAAI,CAAC,CACd,CAAC;QAEF,MAAM,MAAM,GAAG,kEAAkE,IAAI,eAAe,CAAC;QACrG,MAAM,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IACD,uCAAuC;IACvC,KAAK,CAAC,WAAW,CAAC,iBAAiB,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE;QAC1D,MAAM,CAAC,OAAO,CAAC;YACb,QAAQ,EAAE;gBACR,CAAC,MAAM,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE;oBAC3C,SAAS,EAAE,IAAI;oBACf,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,MAAM,EAAE,CAAC;oBACjD,GAAG,EAAE,GAAG;iBACT,CAAC,CAAkB;aACrB;SACF,CAAC,CAAC;IACL,CAAC;CACF,CAAC;AAEF,eAAe,aAAa,CAAC"}

package/dist/TableOfContentsPlugin.d.ts

@@ -0,0 +1,20 @@
+import type { Page, Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+import type { Heading as MarkdownHeading } from 'mdast';
+declare type TOCItem = {
+    level: number;
+    id: string;
+    text: string;
+};
+interface TableOfContentsPluginPage extends Page {
+    tableOfContents?: TOCItem[];
+}
+declare type Rank = MarkdownHeading['depth'];
+interface TableOfContentsPluginOptions {
+    minRank: Rank;
+    maxRank: Rank;
+}
+/**
+ * Calculates table of contents from page headings
+ */
+declare const TableOfContentsPlugin: PluginType<TableOfContentsPluginPage, TableOfContentsPluginOptions>;
+export default TableOfContentsPlugin;

package/dist/TableOfContentsPlugin.js

@@ -0,0 +1,34 @@
+import Slugger from 'github-slugger';
+import remarkParse from 'remark-parse';
+import { unified } from 'unified';
+import remarkStringify from 'remark-stringify';
+import remarkHeadings from '@vcarl/remark-headings';
+/**
+ * Calculates table of contents from page headings
+ */
+const TableOfContentsPlugin = {
+    async $afterSource(pages, _, { minRank, maxRank }) {
+        const processor = unified().use(remarkParse).use(remarkStringify).use(remarkHeadings);
+        for (const page of pages) {
+            const slugger = new Slugger();
+            if (page.content) {
+                const vfile = await processor.process(page.content);
+                const headings = vfile.data.headings;
+                const items = headings
+                    .filter(heading => heading.depth >= minRank && heading.depth <= maxRank)
+                    .map(validHeading => {
+                    const text = validHeading.value.trim();
+                    return {
+                        level: validHeading.depth,
+                        id: slugger.slug(text),
+                        text
+                    };
+                });
+                page.tableOfContents = items;
+            }
+        }
+        return pages;
+    }
+};
+export default TableOfContentsPlugin;
+//# sourceMappingURL=TableOfContentsPlugin.js.map

package/dist/TableOfContentsPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TableOfContentsPlugin.js","sourceRoot":"","sources":["../src/TableOfContentsPlugin.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,gBAAgB,CAAC;AACrC,OAAO,WAAW,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,eAAe,MAAM,kBAAkB,CAAC;AAC/C,OAAO,cAAc,MAAM,wBAAwB,CAAC;AAcpD;;GAEG;AACH,MAAM,qBAAqB,GAAwE;IACjG,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE;QAC/C,MAAM,SAAS,GAAG,OAAO,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACtF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;YAC9B,IAAI,IAAI,CAAC,OAAO,EAAE;gBAChB,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACpD,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,QAA8C,CAAC;gBAC3E,MAAM,KAAK,GAAc,QAAQ;qBAC9B,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,IAAI,OAAO,IAAI,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC;qBACvE,GAAG,CAAC,YAAY,CAAC,EAAE;oBAClB,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;oBACvC,OAAO;wBACL,KAAK,EAAE,YAAY,CAAC,KAAK;wBACzB,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;wBACtB,IAAI;qBACL,CAAC;gBACJ,CAAC,CAAC,CAAC;gBACL,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;aAC9B;SACF;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CACF,CAAC;AAEF,eAAe,qBAAqB,CAAC"}

package/dist/utils/normaliseRefs.d.ts

@@ -0,0 +1 @@
+export default function normaliseRefs(filepath: any, refs: any, filesystem: any, pageExtensions: any, ignorePages: any): Promise<{}>;

package/dist/utils/normaliseRefs.js

@@ -0,0 +1,66 @@
+import path from 'path';
+import glob from 'fast-glob';
+import { set } from 'lodash-es';
+function createFileGlob(url, pageExtensions) {
+    if (pageExtensions.length === 1) {
+        return `${url}${pageExtensions[0]}`;
+    }
+    return `${url}{${pageExtensions.join(',')}}`;
+}
+export default async function normaliseRefs(filepath, refs, filesystem, pageExtensions, ignorePages) {
+    const configWithoutGlobs = {};
+    for (let i = 0; i < refs.length; i++) {
+        const ref = refs[i];
+        const [url, fragment = ''] = ref.$$value.split('#');
+        if (!url) {
+            continue;
+        }
+        const fullUrl = path.resolve(path.dirname(filepath), url);
+        if (!glob.isDynamicPattern(url)) {
+            if (!(await filesystem.promises.exists(fullUrl))) {
+                throw new Error(`A \`$ref\` for '${filepath}' pointed to page '${fullUrl}' - which could not be found.`);
+            }
+            const refRealPath = await filesystem.promises.realpath(fullUrl
+            //path.resolve(path.dirname(filepath), url)
+            );
+            const stat = await filesystem.promises.stat(refRealPath);
+            // Turn directory refs into full index paths
+            // TODO: But DO we want to do this?
+            if (stat.isDirectory()) {
+                // && !/\/index(\.\w{1,4})?$/.test(url)) {
+                set(configWithoutGlobs, ref.$$path.slice(0, -1), {
+                    $ref: `${await filesystem.promises.realpath(path.join(refRealPath, 'index'))}#${fragment}`
+                });
+            }
+            else {
+                set(configWithoutGlobs, ref.$$path.slice(0, -1), {
+                    $ref: `${refRealPath}#${fragment}`
+                });
+            }
+            continue;
+        }
+        try {
+            let globResolvedRefs = 
+            // If the pattern doesn't have an explicit file extension - then we'll make it just return pages
+            await filesystem.promises.glob(!/\/[^/]+\.\w{2,4}$/.test(url) ? createFileGlob(url, pageExtensions) : url, {
+                ignore: [filepath, ...ignorePages.map(ignore => `**/${ignore}`)],
+                cwd: path.dirname(filepath),
+                absolute: true
+            });
+            // Use a set so we de-dupe any symlinks that point to the same page
+            const resolvedRefs = new Set();
+            for (const value of globResolvedRefs) {
+                const refRealPath = await filesystem.promises.realpath(path.resolve(filepath, value));
+                if (refRealPath !== (await filesystem.promises.realpath(filepath))) {
+                    resolvedRefs.add(`${refRealPath}#${fragment}`);
+                }
+            }
+            set(configWithoutGlobs, ref.$$path.slice(0, -1), Array.from(resolvedRefs).map($ref => ({ $ref })));
+        }
+        catch (e) {
+            throw e;
+        }
+    }
+    return configWithoutGlobs;
+}
+//# sourceMappingURL=normaliseRefs.js.map

package/dist/utils/normaliseRefs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"normaliseRefs.js","sourceRoot":"","sources":["../../src/utils/normaliseRefs.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAEhC,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;AAED,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,aAAa,CACzC,QAAQ,EACR,IAAI,EACJ,UAAU,EACV,cAAc,EACd,WAAW;IAEX,MAAM,kBAAkB,GAAG,EAAE,CAAC;IAE9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACpC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,MAAM,CAAC,GAAG,EAAE,QAAQ,GAAG,EAAE,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEpD,IAAI,CAAC,GAAG,EAAE;YACR,SAAS;SACV;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,GAAG,CAAC,CAAC;QAE1D,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE;YAC/B,IAAI,CAAC,CAAC,MAAM,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE;gBAChD,MAAM,IAAI,KAAK,CACb,mBAAmB,QAAQ,sBAAsB,OAAO,+BAA+B,CACxF,CAAC;aACH;YACD,MAAM,WAAW,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,QAAQ,CACpD,OAAO;YACP,2CAA2C;aAC5C,CAAC;YACF,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACzD,4CAA4C;YAC5C,mCAAmC;YACnC,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;gBACtB,0CAA0C;gBAC1C,GAAG,CAAC,kBAAkB,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;oBAC/C,IAAI,EAAE,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,IAAI,QAAQ,EAAE;iBAC3F,CAAC,CAAC;aACJ;iBAAM;gBACL,GAAG,CAAC,kBAAkB,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;oBAC/C,IAAI,EAAE,GAAG,WAAW,IAAI,QAAQ,EAAE;iBACnC,CAAC,CAAC;aACJ;YACD,SAAS;SACV;QAED,IAAI;YACF,IAAI,gBAAgB;YAClB,gGAAgG;YAChG,MAAM,UAAU,CAAC,QAAQ,CAAC,IAAI,CAC5B,CAAC,mBAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,GAAG,EAC1E;gBACE,MAAM,EAAE,CAAC,QAAQ,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC;gBAChE,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;gBAC3B,QAAQ,EAAE,IAAI;aACf,CACF,CAAC;YAEJ,mEAAmE;YACnE,MAAM,YAAY,GAAG,IAAI,GAAG,EAAE,CAAC;YAE/B,KAAK,MAAM,KAAK,IAAI,gBAAgB,EAAE;gBACpC,MAAM,WAAW,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;gBACtF,IAAI,WAAW,KAAK,CAAC,MAAM,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE;oBAClE,YAAY,CAAC,GAAG,CAAC,GAAG,WAAW,IAAI,QAAQ,EAAE,CAAC,CAAC;iBAChD;aACF;YAED,GAAG,CACD,kBAAkB,EAClB,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EACvB,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CACjD,CAAC;SACH;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,CAAC,CAAC;SACT;KACF;IAED,OAAO,kBAAkB,CAAC;AAC5B,CAAC"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@jpmorganchase/mosaic-plugins",
+  "version": "0.1.0-beta.10",
+  "author": "",
+  "description": "Mosaic plugins for core file system",
+  "license": "Apache-2.0",
+  "type": "module",
+  "exports": {
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "import": "./dist/*.js",
+      "node": "./dist/*.js"
+    }
+  },
+  "engines": {
+    "node": ">= 16.0.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -fr dist",
+    "lint": "eslint --ignore-pattern \"**/__tests__/**\""
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:jpmorganchase/mosaic.git"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^9.0.13"
+  },
+  "dependencies": {
+    "@apidevtools/json-schema-ref-parser": "^9.0.9",
+    "@jpmorganchase/mosaic-serialisers": "^0.1.0-beta.10",
+    "@jpmorganchase/mosaic-source-git-repo": "^0.1.0-beta.10",
+    "@jpmorganchase/mosaic-source-local-folder": "^0.1.0-beta.10",
+    "@jpmorganchase/mosaic-types": "^0.1.0-beta.10",
+    "@types/github-slugger": "^1.3.0",
+    "@vcarl/remark-headings": "^0.1.0",
+    "fs-extra": "^10.1.0",
+    "github-slugger": "^1.4.0",
+    "lodash-es": "^4.17.21",
+    "memfs": "^3.4.12",
+    "reading-time": "^1.5.0",
+    "remark-mdx": "^2.1.5",
+    "remark-parse": "^10.0.1",
+    "remark-stringify": "^10.0.2",
+    "rxjs": "^7.5.5",
+    "unified": "^10.1.2",
+    "unist-util-visit": "^4.1.1",
+    "uuid": "^7.0.3"
+  }
+}