@jpmorganchase/mosaic-plugins 0.1.0-beta.4 → 0.1.0-beta.40

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,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

@@ -1,50 +1,34 @@
-"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 { 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 = {
-    $beforeSend(mutableFilesystem, { config, serialiser, ignorePages, pageExtensions }, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const pagePaths = yield mutableFilesystem.promises.glob(createFileGlob('**/index,/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, '{}');
-                }
-                else {
-                    const baseDir = path_1.default.resolve(path_1.default.dirname(String(pagePath)), '../');
-                    config.setAliases(path_1.default.join(baseDir, options.filename), [sharedConfigFile]);
-                }
-            }
+    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.posix.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.posix.resolve(path.dirname(String(pagePath)), '../');
+                config.setAliases(path.join(baseDir, options.filename), [sharedConfigFile]);
+            }
+        }
     }
 };
-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,iBAAiB,EAAE,cAAc,CAAC,EACjD;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":"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,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;YAE3F,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,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBAE1E,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,38 @@
+import type { Plugin as PluginType, 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 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;

package/dist/SidebarPlugin.js

@@ -1,109 +1,205 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
+import path from 'path';
+import { cloneDeep } from 'lodash-es';
+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 getPageLevel(page) {
+    return page.route.split('/').length - 2;
+}
+function sortByPathLevel(pathA, pathB) {
+    const pathALevel = pathA.split('/').length;
+    const pathBLevel = pathB.split('/').length;
+    return pathBLevel - pathALevel;
+}
 /**
- * Sorts the pages in a folder by priority and then exports a JSON file (name: `options.filename`) with the
+ * 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
  */
 const SidebarPlugin = {
-    $beforeSend(mutableFilesystem, { config, serialiser, ignorePages, pageExtensions }, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const dirs = yield mutableFilesystem.promises.glob('**', {
-                onlyDirectories: true,
-                cwd: '/'
-            });
-            for (const dirName of dirs) {
-                const sidebarFilePath = path_1.default.posix.join(String(dirName), options.filename);
-                const pages = (yield Promise.all((yield mutableFilesystem.promises.glob(createFileGlob(['*', '*/index'], pageExtensions), {
-                    onlyFiles: true,
-                    cwd: String(dirName),
-                    ignore: ignorePages.map(ignore => `**/${ignore}`)
-                })).map((pagePath) => __awaiter(this, void 0, void 0, function* () {
-                    return yield serialiser.deserialise(pagePath, yield mutableFilesystem.promises.readFile(pagePath));
-                }))))
-                    .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);
+    async $beforeSend(mutableFilesystem, { config, serialiser, ignorePages, pageExtensions }, { filename = 'sidebar.json', rootDirGlob = '*' }) {
+        /**
+         * Create a list of pages that should be used to build a sidebar.json
+         * @param dirName - root path of sidebar
+         */
+        async function createPageList(rootDir) {
+            const isChildOfRootDir = pagePath => {
+                const pageDir = path.dirname(pagePath);
+                return pageDir.indexOf(rootDir) === 0;
+            };
+            const pagePaths = (await mutableFilesystem.promises.glob(createFileGlob(['**'], pageExtensions), {
+                cwd: String(rootDir),
+                ignore: ignorePages.map(ignore => `**/${ignore}`)
+            }));
+            const filteredPagePaths = pagePaths.filter(isChildOfRootDir);
+            const pageList = await Promise.all(filteredPagePaths.map(async (pagePath) => {
+                return mutableFilesystem.promises.readFile(pagePath).then(serializedContent => {
+                    return serialiser.deserialise(pagePath, serializedContent);
+                });
+            }));
+            return pageList;
+        }
+        /**
+         * Group the pages into parent/child hierachy
+         * @param pages - sidebar pages
+         */
+        function createGroupMap(pages) {
+            return pages.reduce((result, page) => {
+                const name = page.sidebar?.label || page.title;
+                const priority = page.sidebar?.priority;
+                const id = page.route;
+                const isGroup = /\/index$/.test(page.route);
+                const groupPath = path.posix.dirname(page.fullPath);
+                const level = getPageLevel(page);
+                const newChildNode = {
+                    id,
+                    fullPath: page.fullPath,
+                    name,
+                    priority,
+                    data: { level, link: page.route },
+                    childNodes: []
+                };
+                if (isGroup) {
+                    result[groupPath] = {
+                        ...newChildNode,
+                        ...result[groupPath]
+                    };
                 }
-                yield mutableFilesystem.promises.writeFile(sidebarFilePath, '[]');
+                else {
+                    const childNodes = Object.prototype.hasOwnProperty.call(result, groupPath)
+                        ? result[groupPath].childNodes
+                        : [];
+                    result[groupPath] = {
+                        ...result[groupPath],
+                        childNodes: [...childNodes, newChildNode]
+                    };
+                }
+                return result;
+            }, {});
+        }
+        /**
+         * Link the group map to their parents
+         * @param groupMap - unlinked groups of pages
+         * @param dirName - root path of sidebar
+         */
+        function linkGroupMap(groupMap, dirName) {
+            const linkedGroupMap = cloneDeep(groupMap);
+            const sortedGroupMapKeys = Object.keys(linkedGroupMap).sort(sortByPathLevel);
+            sortedGroupMapKeys.forEach(groupPath => {
+                let parentGroupPath = path.posix.dirname(groupPath);
+                if (linkedGroupMap[parentGroupPath] === undefined) {
+                    return;
+                }
+                linkedGroupMap[parentGroupPath].childNodes = [
+                    ...linkedGroupMap[parentGroupPath].childNodes,
+                    linkedGroupMap[groupPath]
+                ];
+            });
+            return [linkedGroupMap[dirName]];
+        }
+        /**
+         * Link each page to a sidebar.json file via ref
+         * @param pages - sidebar pages
+         * @param dirName - root path of sidebar
+         */
+        function addSidebarDataToFrontmatter(pages, dirName) {
+            pages.forEach(page => {
+                config.setRef(String(page.fullPath), ['sidebarData', '$ref'], path.posix.join(dirName, filename, '#', 'pages'));
+            });
+        }
+        const createNavigationRefs = (currPage, prevPage, nextPage) => {
+            if (prevPage) {
+                config.setRef(currPage, ['navigation', 'prev', 'title', '$ref'], `${prevPage}#/title`);
+                config.setRef(currPage, ['navigation', 'prev', 'route', '$ref'], `${prevPage}#/route`);
             }
-            function setPageRefs(sidebarFilePath, page, i) {
-                config.setRef(sidebarFilePath, ['pages', `${i}`, 'id', '$ref'], `${page.fullPath}#/route`);
-                page.sidebar && page.sidebar.label
-                    ? config.setRef(sidebarFilePath, ['pages', `${i}`, 'name', '$ref'], `${page.fullPath}#/sidebar/label`)
-                    : config.setRef(sidebarFilePath, ['pages', `${i}`, 'name', '$ref'], `${page.fullPath}#/title`);
-                config.setRef(sidebarFilePath, ['pages', `${i}`, 'data', 'link', '$ref'], `${page.fullPath}#/route`);
+            if (nextPage) {
+                config.setRef(currPage, ['navigation', 'next', 'title', '$ref'], `${nextPage}#/title`);
+                config.setRef(currPage, ['navigation', 'next', 'route', '$ref'], `${nextPage}#/route`);
             }
-            function setChildPageRefs(page, dirName, i, sidebarFilePath) {
-                return __awaiter(this, void 0, void 0, function* () {
-                    if (isSubfolderIndex(page, dirName)) {
-                        const childDirName = path_1.default.posix.dirname(page.fullPath);
-                        const childNodeSidebarPath = path_1.default.posix.join(childDirName, options.filename);
-                        const childPages = (yield Promise.all((yield mutableFilesystem.promises.glob(createFileGlob(['*', '*/index'], pageExtensions), {
-                            onlyFiles: true,
-                            cwd: String(childDirName),
-                            ignore: ignorePages.map(ignore => `**/${ignore}`)
-                        })).map((pagePath) => __awaiter(this, void 0, void 0, function* () {
-                            return yield serialiser.deserialise(pagePath, yield mutableFilesystem.promises.readFile(pagePath));
-                        })))).filter(page => filterFn(page));
-                        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 addNavigationToFrontmatter(pages) {
+            let prevParentPage, nextParentPage;
+            const getLastPage = pages => {
+                if (pages[pages.length - 1].childNodes?.length) {
+                    return getLastPage(pages[pages.length - 1].childNodes);
+                }
+                return pages[pages.length - 1];
+            };
+            const lastPage = getLastPage(pages);
+            const isFirstPage = page => page === pages[0];
+            const isLastPage = page => page === lastPage;
+            function recursiveAddNavigation(pages) {
+                pages.forEach((page, pageIndex) => {
+                    const { fullPath: currPage } = page;
+                    let prevPage, nextPage;
+                    prevPage = prevParentPage;
+                    prevParentPage = isFirstPage(page) ? undefined : pages[pageIndex].fullPath;
+                    if (page.childNodes?.length) {
+                        nextPage = page.childNodes[0].fullPath;
+                        nextParentPage =
+                            pageIndex < pages.length - 1 ? pages[pageIndex + 1].fullPath : nextParentPage;
                     }
+                    else if (pageIndex < pages.length - 1) {
+                        nextPage = pages[pageIndex + 1].fullPath;
+                    }
+                    else {
+                        nextPage = isLastPage(page) ? undefined : nextParentPage;
+                    }
+                    if (currPage !== undefined) {
+                        createNavigationRefs(currPage, prevPage, nextPage);
+                    }
+                    recursiveAddNavigation(page.childNodes);
                 });
             }
-            function addSidebarDataToFrontmatter(page, dirName) {
-                const dirNameLevels = String(dirName)
-                    .split('/')
-                    .filter(level => level);
-                const sidebarRootDir = `/` + dirNameLevels.slice(0, dirNameLevels.length < 3 ? dirNameLevels.length : 3).join(`/`);
-                config.setRef(String(page.fullPath), ['sidebarData', '$ref'], path_1.default.posix.join(String(sidebarRootDir), options.filename, '#', 'pages'));
-            }
+            recursiveAddNavigation(pages);
+        }
+        const rootUserJourneys = await mutableFilesystem.promises.glob(rootDirGlob, {
+            onlyDirectories: true,
+            extglob: true,
+            cwd: '/'
         });
+        const removeExcludedPages = page => !(page.sidebar && page.sidebar.exclude);
+        function sortPagesByPriority(sidebarData) {
+            const pagesByPriority = sidebarData.map(page => {
+                if (page.childNodes?.length > 1) {
+                    const pagesByPriority = page.childNodes.sort((pageA, pageB) => (pageB.priority ? pageB.priority : -1) - (pageA.priority ? pageA.priority : -1));
+                    sortPagesByPriority(page.childNodes);
+                    return { ...page, childNodes: pagesByPriority };
+                }
+                return page;
+            });
+            return pagesByPriority;
+        }
+        function moveRootPageDown(pagesByPriority) {
+            const rootPage = pagesByPriority[0];
+            const pagesWithRootMovedDown = rootPage.childNodes;
+            pagesWithRootMovedDown.unshift(rootPage);
+            rootPage.childNodes = [];
+            return pagesWithRootMovedDown;
+        }
+        await Promise.all(rootUserJourneys.map(async (rootDir) => {
+            const sidebarFilePath = path.posix.join(String(rootDir), filename);
+            let pages = await createPageList(rootDir);
+            pages = pages.filter(page => removeExcludedPages(page));
+            const groupMap = createGroupMap(pages);
+            const sidebarData = linkGroupMap(groupMap, rootDir);
+            const pagesByPriority = sortPagesByPriority(sidebarData);
+            addNavigationToFrontmatter(pagesByPriority);
+            const pagesWithRootMovedDown = moveRootPageDown(pagesByPriority);
+            await mutableFilesystem.promises.writeFile(sidebarFilePath, JSON.stringify({ pages: pagesWithRootMovedDown }));
+            addSidebarDataToFrontmatter(pages, rootDir);
+        }));
     }
 };
-exports.default = SidebarPlugin;
-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
-    if (pageA.route === dirName + '/index') {
-        return -1;
-    }
-    if (pageB.route === dirName + '/index') {
-        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);
-}
+export default SidebarPlugin;
 //# sourceMappingURL=SidebarPlugin.js.map