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

package/dist/SearchIndexPlugin.js

@@ -0,0 +1,154 @@
+import { unified } from 'unified';
+import markdown from 'remark-parse';
+import remarkMdx from 'remark-mdx';
+import { visit } from 'unist-util-visit';
+const defaultRelevancyOptions = {
+    includeScore: true,
+    includeMatches: true,
+    maxPatternLength: 240,
+    ignoreLocation: true,
+    threshold: 0.3
+};
+/**
+ * We need these keys to *always* be included in the search index.
+ * Without the title, there would be no way to display the search results.
+ * Without the route, there would be no way to navigate to the page.
+ */
+const requiredKeys = ['title', 'route'];
+/**
+ * If there are no keys specified in the plugin options, we'll use these
+ */
+const fallbackKeys = [...requiredKeys, 'content'];
+/**
+ * There are three scenarios for the "keys":
+ *
+ * 1. No keys are specified in the plugin options. In this case, we'll use the fallback keys.
+ * 2. The keys are specified as an array of strings. In this case, we'll add the required keys to the array.
+ * 3. The keys are specified as an array of objects. In this case, we can assume "weighting" is being applied
+ *    so we'll only return the keys that have been specified in the options.
+ *
+ * @param optionKeys array of keys specified in the plugin options
+ * @returns array of keys to be used in the search index
+ */
+export function parseKeys(optionKeys = []) {
+    if (optionKeys.length < 1)
+        return fallbackKeys;
+    if (typeof optionKeys[0] === 'string')
+        return [...requiredKeys, ...optionKeys];
+    return optionKeys;
+}
+/**
+ * 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
+ */
+export const optimizeContentForSearch = async ({ content: rawContent, title, maxLineLength, maxLineCount }) => {
+    // Normalize line endings
+    const content = rawContent.replaceAll('\r', '');
+    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 = [];
+    const segmenter = new Intl.Segmenter('en', { granularity: 'sentence' });
+    visit(tree, (node) => node.type === 'text' || node.type === 'code', (node) => {
+        const segments = [...segmenter.segment(node.value)].map(segment => segment.segment);
+        segments.forEach(segment => {
+            if (maxLineLength) {
+                sentences.push(segment.slice(0, maxLineLength));
+            }
+            else {
+                sentences.push(segment);
+            }
+        });
+    });
+    if (maxLineCount) {
+        return sentences.slice(0, maxLineCount);
+    }
+    return sentences;
+};
+/**
+ * Creates a search-data.json file that contains all the information
+ * from each page that is required to generate a search index.
+ */
+const SearchIndexPlugin = {
+    /**
+     * For each source, parse the data we want to add to the search index and
+     * save it to the global config (to be saved to the filesystem later when
+     * all sources have been loaded).
+     */
+    async $beforeSend(mutableFilesystem, { config, serialiser, ignorePages }, { maxLineLength, maxLineCount, keys: optionKeys }) {
+        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 keys = parseKeys(optionKeys);
+            /**
+             * If the "content" key is specified, we want to include the result of
+             * the optimizeContentForSearch() function. Otherwise, we include the
+             * key value directly from the page data.
+             */
+            return keys.reduce((acc, key) => ({ ...acc, [key]: key === 'content' ? content : page[key] }), {});
+        }));
+        /**
+         * Convert the searchData into an object where each page has a unique key (the
+         * route) so that the "merge" in `config.setData()` will correctly combine all
+         * the results from multiple sources.
+         */
+        const searchDataKeyedByRoute = searchData.reduce((acc, curr) => ({
+            ...acc,
+            [curr.route]: curr
+        }), {});
+        config.setData({
+            searchIndices: searchDataKeyedByRoute
+        });
+    },
+    /**
+     * Once we have all the sources' search data added to `globalConfig`, convert it
+     * to JSON and save it to the filesystem.
+     */
+    async afterUpdate(_, { sharedFilesystem, globalConfig }, { keys: optionKeys, relevancy }) {
+        if (!globalConfig.data.searchIndices)
+            return;
+        const globalSearchIndices = globalConfig.data.searchIndices;
+        const searchData = Object.values(globalSearchIndices);
+        const condensedSearchData = searchData.map(page => ({ title: page.title, route: page.route }));
+        const keys = parseKeys(optionKeys);
+        const searchConfig = {
+            ...defaultRelevancyOptions,
+            ...relevancy,
+            keys
+        };
+        await sharedFilesystem.promises.writeFile('/search-config.json', JSON.stringify(searchConfig));
+        await sharedFilesystem.promises.writeFile('/search-data.json', JSON.stringify(searchData));
+        await sharedFilesystem.promises.writeFile('/search-data-condensed.json', JSON.stringify(condensedSearchData));
+    }
+};
+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;AAqCzC,MAAM,uBAAuB,GAAG;IAC9B,YAAY,EAAE,IAAI;IAClB,cAAc,EAAE,IAAI;IACpB,gBAAgB,EAAE,GAAG;IACrB,cAAc,EAAE,IAAI;IACpB,SAAS,EAAE,GAAG;CACf,CAAC;AAEF;;;;GAIG;AACH,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AAExC;;GAEG;AACH,MAAM,YAAY,GAAG,CAAC,GAAG,YAAY,EAAE,SAAS,CAAC,CAAC;AAElD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,SAAS,CAAC,UAAU,GAAG,EAAE;IACvC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,YAAY,CAAC;IAC/C,IAAI,OAAO,UAAU,CAAC,CAAC,CAAC,KAAK,QAAQ;QAAE,OAAO,CAAC,GAAG,YAAY,EAAE,GAAG,UAAU,CAAC,CAAC;IAC/E,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,KAAK,EAAE,EAC7C,OAAO,EAAE,UAAU,EACnB,KAAK,EACL,aAAa,EACb,YAAY,EACC,EAAE,EAAE;IACjB,yBAAyB;IACzB,MAAM,OAAO,GAAG,UAAU,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAChD,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,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC;IAExE,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,MAAM,QAAQ,GAAG,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACpF,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACzB,IAAI,aAAa,EAAE;gBACjB,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC;aACjD;iBAAM;gBACL,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aACzB;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CACF,CAAC;IAEF,IAAI,YAAY,EAAE;QAChB,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;;;;OAIG;IACH,KAAK,CAAC,WAAW,CACf,iBAAiB,EACjB,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,EACnC,EAAE,aAAa,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,EAAE;QAEjD,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;QACF,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,IAAI,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;YACnC;;;;eAIG;YACH,OAAO,IAAI,CAAC,MAAM,CAChB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAC1E,EAAE,CACH,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QACF;;;;WAIG;QACH,MAAM,sBAAsB,GAAG,UAAU,CAAC,MAAM,CAC9C,CAAC,GAAG,EAAE,IAAe,EAAE,EAAE,CAAC,CAAC;YACzB,GAAG,GAAG;YACN,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI;SACnB,CAAC,EACF,EAAE,CACH,CAAC;QACF,MAAM,CAAC,OAAO,CAAC;YACb,aAAa,EAAE,sBAAsB;SACtC,CAAC,CAAC;IACL,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,gBAAgB,EAAE,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE;QACtF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa;YAAE,OAAO;QAC7C,MAAM,mBAAmB,GAAG,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC;QAC5D,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;QACtD,MAAM,mBAAmB,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC/F,MAAM,IAAI,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;QACnC,MAAM,YAAY,GAAG;YACnB,GAAG,uBAAuB;YAC1B,GAAG,SAAS;YACZ,IAAI;SACL,CAAC;QACF,MAAM,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,qBAAqB,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;QAC/F,MAAM,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;QAC3F,MAAM,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CACvC,6BAA6B,EAC7B,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,CACpC,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/dist/SharedConfigPlugin.d.ts

@@ -0,0 +1,14 @@
+import type { Page, Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+export interface SharedConfigPluginPage extends Page {
+    sharedConfig?: string;
+    frameOverrides?: any;
+}
+export 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

@@ -1,50 +1,146 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const flatten_1 = __importDefault(require("lodash/flatten"));
-const path_1 = __importDefault(require("path"));
+import crypto from 'node:crypto';
+import path from 'node:path';
+import { flatten, escapeRegExp } from 'lodash-es';
+import deepmerge from 'deepmerge';
+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(',')}}`;
+}
+/**
+ * https://stackoverflow.com/a/50549047
+ * compute inner relative to outer
+ * If it's not contained, the first component of the resulting path will be .., so that's what we check for
+ */
+function isWithin(outer, inner) {
+    const outerParentDir = path.posix.resolve(path.posix.dirname(outer), '../');
+    const innerParentDir = path.posix.resolve(path.posix.dirname(inner), '../');
+    const rel = path.posix.relative(outerParentDir, innerParentDir);
+    return !rel.startsWith('../') && rel !== '..';
+}
 /**
  * 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 = {
-    $beforeSend(mutableFilesystem, { config, serialiser, ignorePages, pageExtensions }, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const pagePaths = yield mutableFilesystem.promises.glob(createFileGlob('**/index', pageExtensions), {
-                ignore: [options.filename, ...(0, flatten_1.default)(ignorePages.map(ignore => [ignore, `**/${ignore}`]))],
-                cwd: '/'
-            });
-            for (const pagePath of pagePaths) {
-                const sharedConfigFile = path_1.default.join(path_1.default.dirname(String(pagePath)), options.filename);
-                const page = yield serialiser.deserialise(String(pagePath), yield mutableFilesystem.promises.readFile(String(pagePath)));
-                if (page.sharedConfig) {
-                    config.setRef(sharedConfigFile, ['config', '$ref'], `${String(pagePath)}#/sharedConfig`);
-                    yield mutableFilesystem.promises.writeFile(sharedConfigFile, '{}');
+    async $afterSource(pages, { ignorePages, pageExtensions, config, namespace }) {
+        const isNonHiddenPage = createPageTest(ignorePages, pageExtensions);
+        let finalSharedConfig;
+        const indexPages = pages.filter(page => path.posix.basename(page.fullPath, path.posix.extname(page.fullPath)) === 'index' &&
+            isNonHiddenPage(page.fullPath));
+        const indexPagesWithSharedConfig = indexPages.filter(page => page.sharedConfig !== undefined);
+        if (indexPagesWithSharedConfig.length === 0 && indexPages.length > 0) {
+            const rootPath = indexPages[0].fullPath;
+            const applyNamespaceSharedConfig = {
+                [`${crypto.randomUUID()}`]: {
+                    paths: indexPages.map(indexPage => indexPage.fullPath),
+                    rootPath,
+                    namespace
                 }
-                else {
-                    const baseDir = path_1.default.resolve(path_1.default.dirname(String(pagePath)), '../');
-                    config.setAliases(path_1.default.join(baseDir, options.filename), [sharedConfigFile]);
+            };
+            config.setData({ applyNamespaceSharedConfig });
+            return pages;
+        }
+        for (const page of indexPagesWithSharedConfig) {
+            if (finalSharedConfig === undefined) {
+                // first shared config we have found so seed the finalSharedConfig
+                finalSharedConfig = page.sharedConfig;
+            }
+            else {
+                for (let i = 1; i < indexPagesWithSharedConfig.length; i++) {
+                    if (isWithin(indexPagesWithSharedConfig[i].fullPath, page.fullPath)) {
+                        // found another shared config so merge and apply to the page
+                        finalSharedConfig = deepmerge(finalSharedConfig, page.sharedConfig);
+                        page.sharedConfig = finalSharedConfig;
+                        page.frameOverrides = { $ref: '#/sharedConfig' };
+                    }
                 }
             }
+        }
+        return pages;
+    },
+    async $beforeSend(mutableFilesystem, { config, serialiser, ignorePages, pageExtensions }, options) {
+        const indexPagePaths = await mutableFilesystem.promises.glob(createFileGlob('**/index', pageExtensions), {
+            ignore: [options.filename, ...flatten(ignorePages.map(ignore => [ignore, `**/${ignore}`]))],
+            cwd: '/'
         });
+        const sharedConfigFiles = [];
+        const indexPagesWithoutConfig = [];
+        for (const indexPagePath of indexPagePaths) {
+            const sharedConfigFile = path.posix.join(path.posix.dirname(String(indexPagePath)), options.filename);
+            const page = await serialiser.deserialise(String(indexPagePath), await mutableFilesystem.promises.readFile(String(indexPagePath)));
+            if (page.sharedConfig) {
+                config.setRef(sharedConfigFile, ['config', '$ref'], `${String(indexPagePath)}#/sharedConfig`);
+                await mutableFilesystem.promises.writeFile(sharedConfigFile, '{}');
+                sharedConfigFiles.push(sharedConfigFile);
+            }
+            else {
+                indexPagesWithoutConfig.push(page.fullPath);
+            }
+        }
+        // apply closest shared config
+        if (sharedConfigFiles.length > 0) {
+            let closestSharedConfigIndex = 0;
+            for (const pagePath of indexPagesWithoutConfig) {
+                for (let i = 0; i < sharedConfigFiles.length; i++) {
+                    if (isWithin(sharedConfigFiles[i], pagePath)) {
+                        closestSharedConfigIndex = i;
+                    }
+                }
+                const sharedConfigFile = path.posix.join(path.posix.dirname(String(pagePath)), options.filename);
+                const closestSharedConfig = path.posix.resolve(path.dirname(String(pagePath)), sharedConfigFiles[closestSharedConfigIndex]);
+                config.setAliases(closestSharedConfig, [sharedConfigFile]);
+            }
+        }
+    },
+    async afterUpdate(mutableFilesystem, { sharedFilesystem, globalConfig, namespace }, options) {
+        const { applyNamespaceSharedConfig } = globalConfig.data;
+        if (applyNamespaceSharedConfig === undefined) {
+            // there is no source that exists that has told us it needs to share a namespace shared-config
+            return;
+        }
+        // find all the entries that match the namespace the plugin is running against
+        const namespaceSharedConfigs = Object.keys(applyNamespaceSharedConfig)
+            .filter(key => applyNamespaceSharedConfig[key].namespace === namespace)
+            .map(key => applyNamespaceSharedConfig?.[key] || []);
+        for (const namespaceSharedConfig of namespaceSharedConfigs) {
+            if (await mutableFilesystem.promises.exists(namespaceSharedConfig.rootPath)) {
+                // a source does need a namespace shared config but the source running this plugin is the source that needs it
+                // so we don't need to do anything here
+                continue;
+            }
+            for (const applyPath of namespaceSharedConfig.paths) {
+                if (!(await sharedFilesystem.promises.exists(applyPath))) {
+                    sharedFilesystem.promises.mkdir(path.posix.dirname(String(applyPath)), {
+                        recursive: true
+                    });
+                }
+                let parentDir = path.posix.join(path.posix.dirname(String(applyPath)), '../');
+                let closestSharedConfigPath = path.posix.join(parentDir, options.filename);
+                while (parentDir !== path.posix.sep) {
+                    // walk up the directories in the path to find the closest shared config file
+                    closestSharedConfigPath = path.posix.join(parentDir, options.filename);
+                    if (await mutableFilesystem.promises.exists(closestSharedConfigPath)) {
+                        break;
+                    }
+                    parentDir = path.posix.join(path.posix.dirname(String(closestSharedConfigPath)), '../');
+                }
+                const aliasSharedConfigPath = path.posix.join(path.posix.dirname(String(applyPath)), options.filename);
+                if ((await mutableFilesystem.promises.exists(closestSharedConfigPath)) &&
+                    !(await sharedFilesystem.promises.exists(aliasSharedConfigPath))) {
+                    console.log(`[Mosaic][Plugin] Source has no shared config. Root index page is: ${namespaceSharedConfig.rootPath}`);
+                    console.log('[Mosaic][Plugin] Copying shared config ', closestSharedConfigPath, '-->', aliasSharedConfigPath);
+                    await sharedFilesystem.promises.writeFile(aliasSharedConfigPath, await mutableFilesystem.promises.readFile(closestSharedConfigPath));
+                }
+            }
+        }
     }
 };
-exports.default = SharedConfigPlugin;
-function createFileGlob(url, pageExtensions) {
-    if (pageExtensions.length === 1) {
-        return `${url}${pageExtensions[0]}`;
-    }
-    return `${url}{${pageExtensions.join(',')}}`;
-}
+export default SharedConfigPlugin;
 //# sourceMappingURL=SharedConfigPlugin.js.map

package/dist/SharedConfigPlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"SharedConfigPlugin.js","sourceRoot":"","sources":["../src/SharedConfigPlugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AACA,6DAAqC;AACrC,gDAAwB;AAExB;;;GAGG;AACH,MAAM,kBAAkB,GAAyC;IACzD,WAAW,CACf,iBAAiB,EACjB,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,cAAc,EAAE,EACnD,OAAO;;YAEP,MAAM,SAAS,GAAG,MAAM,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CACrD,cAAc,CAAC,UAAU,EAAE,cAAc,CAAC,EAC1C;gBACE,MAAM,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,IAAA,iBAAO,EAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;gBAC3F,GAAG,EAAE,GAAG;aACT,CACF,CAAC;YAEF,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;gBAChC,MAAM,gBAAgB,GAAG,cAAI,CAAC,IAAI,CAAC,cAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAErF,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;gBACF,IAAI,IAAI,CAAC,YAAY,EAAE;oBACrB,MAAM,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;oBACzF,MAAM,iBAAiB,CAAC,QAAQ,CAAC,SAAS,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;iBACpE;qBAAM;oBACL,MAAM,OAAO,GAAG,cAAI,CAAC,OAAO,CAAC,cAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;oBAEpE,MAAM,CAAC,UAAU,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;iBAC7E;aACF;QACH,CAAC;KAAA;CACF,CAAC;AAEF,kBAAe,kBAAkB,CAAC;AAElC,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"}
+{"version":3,"file":"SharedConfigPlugin.js","sourceRoot":"","sources":["../src/SharedConfigPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAClD,OAAO,SAAS,MAAM,WAAW,CAAC;AAElC,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;AAED;;;;GAIG;AACH,SAAS,QAAQ,CAAC,KAAK,EAAE,KAAK;IAC5B,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;IAC5E,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;IAC5E,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IAChE,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,GAAG,KAAK,IAAI,CAAC;AAChD,CAAC;AAWD;;;GAGG;AACH,MAAM,kBAAkB,GAAkE;IACxF,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,EAAE;QAC1E,MAAM,eAAe,GAAG,cAAc,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;QACpE,IAAI,iBAAiB,CAAC;QAEtB,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAC7B,IAAI,CAAC,EAAE,CACL,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,OAAO;YACjF,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CACjC,CAAC;QAEF,MAAM,0BAA0B,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC;QAE9F,IAAI,0BAA0B,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;YACpE,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;YACxC,MAAM,0BAA0B,GAAG;gBACjC,CAAC,GAAG,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC,EAAE;oBAC1B,KAAK,EAAE,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC;oBACtD,QAAQ;oBACR,SAAS;iBACV;aACF,CAAC;YACF,MAAM,CAAC,OAAO,CAAC,EAAE,0BAA0B,EAAE,CAAC,CAAC;YAC/C,OAAO,KAAK,CAAC;SACd;QAED,KAAK,MAAM,IAAI,IAAI,0BAA0B,EAAE;YAC7C,IAAI,iBAAiB,KAAK,SAAS,EAAE;gBACnC,kEAAkE;gBAClE,iBAAiB,GAAG,IAAI,CAAC,YAAY,CAAC;aACvC;iBAAM;gBACL,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,0BAA0B,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;oBAC1D,IAAI,QAAQ,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE;wBACnE,6DAA6D;wBAC7D,iBAAiB,GAAG,SAAS,CAAC,iBAAiB,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;wBACpE,IAAI,CAAC,YAAY,GAAG,iBAAiB,CAAC;wBACtC,IAAI,CAAC,cAAc,GAAG,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;qBAClD;iBACF;aACF;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,CAAC,WAAW,CACf,iBAAiB,EACjB,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,cAAc,EAAE,EACnD,OAAO;QAEP,MAAM,cAAc,GAAG,MAAM,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAC1D,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,MAAM,iBAAiB,GAAa,EAAE,CAAC;QACvC,MAAM,uBAAuB,GAAa,EAAE,CAAC;QAE7C,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE;YAC1C,MAAM,gBAAgB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CACtC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,EACzC,OAAO,CAAC,QAAQ,CACjB,CAAC;YAEF,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,WAAW,CACvC,MAAM,CAAC,aAAa,CAAC,EACrB,MAAM,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CACjE,CAAC;YAEF,IAAI,IAAI,CAAC,YAAY,EAAE;gBACrB,MAAM,CAAC,MAAM,CACX,gBAAgB,EAChB,CAAC,QAAQ,EAAE,MAAM,CAAC,EAClB,GAAG,MAAM,CAAC,aAAa,CAAC,gBAAgB,CACzC,CAAC;gBACF,MAAM,iBAAiB,CAAC,QAAQ,CAAC,SAAS,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;gBACnE,iBAAiB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aAC1C;iBAAM;gBACL,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aAC7C;SACF;QAED,8BAA8B;QAC9B,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE;YAChC,IAAI,wBAAwB,GAAG,CAAC,CAAC;YACjC,KAAK,MAAM,QAAQ,IAAI,uBAAuB,EAAE;gBAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;oBACjD,IAAI,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE;wBAC5C,wBAAwB,GAAG,CAAC,CAAC;qBAC9B;iBACF;gBAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CACtC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EACpC,OAAO,CAAC,QAAQ,CACjB,CAAC;gBAEF,MAAM,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAC5C,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAC9B,iBAAiB,CAAC,wBAAwB,CAAC,CAC5C,CAAC;gBACF,MAAM,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;aAC5D;SACF;IACH,CAAC;IACD,KAAK,CAAC,WAAW,CAAC,iBAAiB,EAAE,EAAE,gBAAgB,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,OAAO;QACzF,MAAM,EAAE,0BAA0B,EAAE,GAAG,YAAY,CAAC,IAAI,CAAC;QAEzD,IAAI,0BAA0B,KAAK,SAAS,EAAE;YAC5C,8FAA8F;YAC9F,OAAO;SACR;QAED,8EAA8E;QAC9E,MAAM,sBAAsB,GAItB,MAAM,CAAC,IAAI,CAAC,0BAA0B,CAAC;aAC1C,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,SAAS,KAAK,SAAS,CAAC;aACtE,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,0BAA0B,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QAEvD,KAAK,MAAM,qBAAqB,IAAI,sBAAsB,EAAE;YAC1D,IAAI,MAAM,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,EAAE;gBAC3E,8GAA8G;gBAC9G,uCAAuC;gBACvC,SAAS;aACV;YAED,KAAK,MAAM,SAAS,IAAI,qBAAqB,CAAC,KAAK,EAAE;gBACnD,IAAI,CAAC,CAAC,MAAM,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE;oBACxD,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE;wBACrE,SAAS,EAAE,IAAI;qBAChB,CAAC,CAAC;iBACJ;gBACD,IAAI,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBAC9E,IAAI,uBAAuB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAE3E,OAAO,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE;oBACnC,6EAA6E;oBAC7E,uBAAuB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;oBACvE,IAAI,MAAM,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,uBAAuB,CAAC,EAAE;wBACpE,MAAM;qBACP;oBACD,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;iBACzF;gBAED,MAAM,qBAAqB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAC3C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EACrC,OAAO,CAAC,QAAQ,CACjB,CAAC;gBAEF,IACE,CAAC,MAAM,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC;oBAClE,CAAC,CAAC,MAAM,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC,EAChE;oBACA,OAAO,CAAC,GAAG,CACT,qEAAqE,qBAAqB,CAAC,QAAQ,EAAE,CACtG,CAAC;oBACF,OAAO,CAAC,GAAG,CACT,yCAAyC,EACzC,uBAAuB,EACvB,KAAK,EACL,qBAAqB,CACtB,CAAC;oBACF,MAAM,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CACvC,qBAAqB,EACrB,MAAM,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,uBAAuB,CAAC,CACnE,CAAC;iBACH;aACF;SACF;IACH,CAAC;CACF,CAAC;AAEF,eAAe,kBAAkB,CAAC"}

package/dist/SidebarPlugin.d.ts

@@ -0,0 +1,44 @@
+import type { Plugin as PluginType, Page } from '@jpmorganchase/mosaic-types';
+import { type SortConfig } from '@jpmorganchase/mosaic-schemas';
+interface SidebarPluginConfigData {
+    dirs: string[];
+    refs: {
+        [key: string]: {
+            $$path: (number | string)[];
+            $$value: string;
+        }[];
+    };
+}
+export interface SidebarPluginPage extends Page {
+    sidebar?: {
+        label?: string;
+    };
+    sharedConfig: {
+        sidebar: {
+            sort: SortConfig;
+        };
+    };
+}
+interface SidebarPluginOptions {
+    /**
+     * filename of the sidebar json, linked to each related page via ref
+     */
+    filename: string;
+    /**
+     * Glob pattern for matching directories which should be the root of the sidebar
+     * * creates a root level sidebar containing all pages underneath root
+     * *\/* creates a separate sidebar under each of the root directories
+     */
+    rootDirGlob: string;
+}
+/**
+ * Sorts the pages in a folder by priority and then exports a JSON file with the
+ * sidebar tree from that directory downwards and adds sidebar data into frontmatter for each page.
+ *
+ * Additionally, add to frontmatter
+ * navigation -> prev -> { title, route }
+ * navigation -> next -> { title, route }
+ * to define the previous/next page in the page sequence, as defined by sidebar label and priority
+ */
+declare const SidebarPlugin: PluginType<SidebarPluginPage, SidebarPluginOptions, SidebarPluginConfigData>;
+export default SidebarPlugin;