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

package/dist/LocalFolderSavePlugin.js

@@ -0,0 +1,21 @@
+import path from 'path';
+import fs from 'fs';
+import mdx from '@jpmorganchase/mosaic-serialisers/mdx';
+const LocalFolderSavePlugin = {
+    async saveContent(filePath, data, sourceOptions, { namespace }) {
+        const { markdown } = data;
+        const { rootDir, prefixDir } = sourceOptions;
+        if (namespace !== 'local') {
+            // indicate to the Plugin Runner that no save happened
+            return false;
+        }
+        const pathOnDisk = path.posix.join(rootDir, filePath.replace(new RegExp(`${prefixDir}/`), ''));
+        const rawPage = await fs.promises.readFile(pathOnDisk);
+        const { content, ...metadata } = await mdx.deserialise(pathOnDisk, rawPage);
+        const updatedPage = { ...metadata, content: markdown };
+        await fs.promises.writeFile(pathOnDisk, await mdx.serialise(pathOnDisk, updatedPage));
+        return true;
+    }
+};
+export default LocalFolderSavePlugin;
+//# sourceMappingURL=LocalFolderSavePlugin.js.map

package/dist/LocalFolderSavePlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalFolderSavePlugin.js","sourceRoot":"","sources":["../src/LocalFolderSavePlugin.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,IAAI,CAAC;AAGpB,OAAO,GAAG,MAAM,uCAAuC,CAAC;AAMxD,MAAM,qBAAqB,GAAe;IACxC,KAAK,CAAC,WAAW,CACf,QAAQ,EACR,IAA+B,EAC/B,aAAuC,EACvC,EAAE,SAAS,EAAE;QAEb,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QAC1B,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,aAAa,CAAC;QAE7C,IAAI,SAAS,KAAK,OAAO,EAAE;YACzB,sDAAsD;YACtD,OAAO,KAAK,CAAC;SACd;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,GAAG,SAAS,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QAC/F,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QACvD,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,EAAE,GAAG,MAAM,GAAG,CAAC,WAAW,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAC5E,MAAM,WAAW,GAAG,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;QAEvD,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,CAAC,SAAS,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;QACtF,OAAO,IAAI,CAAC;IACd,CAAC;CACF,CAAC;AAEF,eAAe,qBAAqB,CAAC"}

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/PublicAssetsPlugin.d.ts

@@ -0,0 +1,18 @@
+import type { Page, Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+interface PublicAssetsPluginOptions {
+    /**
+     * The directory to copy the assets to
+     * @default './public'
+     */
+    outputDir?: string;
+    /**
+     * A collection of filenames to copy to the outputDir
+     */
+    assets?: string[];
+}
+/**
+ * Plugin that finds `assets` in the Mosaic filesytem and copies them to the specified outputDir.
+ * Typical use case is for assets like a sitemap
+ */
+declare const PublicAssetsPlugin: PluginType<Page, PublicAssetsPluginOptions>;
+export default PublicAssetsPlugin;

package/dist/PublicAssetsPlugin.js

@@ -0,0 +1,28 @@
+import path from 'node:path';
+import fs from 'node:fs';
+import fsExtra from 'fs-extra';
+/**
+ * Plugin that finds `assets` in the Mosaic filesytem and copies them to the specified outputDir.
+ * Typical use case is for assets like a sitemap
+ */
+const PublicAssetsPlugin = {
+    async afterUpdate(_, { sharedFilesystem }, { assets = [], outputDir = './public' }) {
+        if (assets.length > 0) {
+            await fsExtra.ensureDir(outputDir);
+            await Promise.all(assets.map(async (asset) => {
+                const allFiles = await sharedFilesystem.promises.glob(`**/${asset}`, {
+                    cwd: '/',
+                    onlyFiles: true
+                });
+                if (allFiles?.length > 0) {
+                    await Promise.all(allFiles.map(async (file) => {
+                        const data = await sharedFilesystem.promises.readFile(file);
+                        await fs.promises.writeFile(path.posix.join(path.posix.resolve(outputDir), file), data);
+                    }));
+                }
+            }));
+        }
+    }
+};
+export default PublicAssetsPlugin;
+//# sourceMappingURL=PublicAssetsPlugin.js.map

package/dist/PublicAssetsPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PublicAssetsPlugin.js","sourceRoot":"","sources":["../src/PublicAssetsPlugin.ts"],"names":[],"mappings":"AACA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,OAAO,MAAM,UAAU,CAAC;AAc/B;;;GAGG;AACH,MAAM,kBAAkB,GAAgD;IACtE,KAAK,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,gBAAgB,EAAE,EAAE,EAAE,MAAM,GAAG,EAAE,EAAE,SAAS,GAAG,UAAU,EAAE;QAChF,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACrB,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;YAEnC,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,GAAG,CAAC,KAAK,EAAC,KAAK,EAAC,EAAE;gBACvB,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,KAAK,EAAE,EAAE;oBACnE,GAAG,EAAE,GAAG;oBACR,SAAS,EAAE,IAAI;iBAChB,CAAC,CAAC;gBAEH,IAAI,QAAQ,EAAE,MAAM,GAAG,CAAC,EAAE;oBACxB,MAAM,OAAO,CAAC,GAAG,CACf,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAC,IAAI,EAAC,EAAE;wBACxB,MAAM,IAAI,GAAG,MAAM,gBAAgB,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;wBAC5D,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CACzB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,EACpD,IAAI,CACL,CAAC;oBACJ,CAAC,CAAC,CACH,CAAC;iBACH;YACH,CAAC,CAAC,CACH,CAAC;SACH;IACH,CAAC;CACF,CAAC;AAEF,eAAe,kBAAkB,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,56 @@
+import type { Page, Plugin as PluginType } from '@jpmorganchase/mosaic-types';
+interface SearchRelevancy {
+    includeScore?: boolean;
+    includeMatches?: boolean;
+    maxPatternLength?: number;
+    ignoreLocation?: boolean;
+    threshold?: number;
+    keys?: string[] | {
+        name: string;
+        weight: number;
+    }[];
+}
+interface SearchIndexPluginOptions {
+    maxLineLength?: number;
+    maxLineCount?: number;
+    keys?: string[];
+    relevancy?: SearchRelevancy;
+}
+interface Optimization {
+    content: string;
+    title: string;
+    maxLineCount?: number;
+    maxLineLength?: number;
+}
+/**
+ * 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 declare function parseKeys(optionKeys?: any[]): any[];
+/**
+ * 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 declare const optimizeContentForSearch: ({ content, title, maxLineLength, maxLineCount }: Optimization) => Promise<string[]>;
+/**
+ * Creates a search-data.json file that contains all the information
+ * from each 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,152 @@
+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, 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 = [];
+    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,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,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

@@ -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.posix.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,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;