@jpmorganchase/mosaic-plugins 0.1.0-beta.7 → 0.1.0-beta.71

package/dist/SharedConfigPlugin.js

@@ -1,50 +1,142 @@
-"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 } from 'lodash-es';
+import deepmerge from 'deepmerge';
+import { createPageTest } from './utils/createPageTest.js';
 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;
+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,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;IAClF,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"}
+{"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,MAAM,WAAW,CAAC;AACpC,OAAO,SAAS,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,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;

package/dist/SidebarPlugin.js

@@ -1,18 +1,7 @@
-"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 { sidebarSortConfigSchema } from '@jpmorganchase/mosaic-schemas';
+import { cloneDeep } from 'lodash-es';
+import { sortSidebarData } from './utils/sortSidebarData.js';
 function createFileGlob(patterns, pageExtensions) {
     if (Array.isArray(patterns)) {
         return patterns.map(pattern => createFileGlob(pattern, pageExtensions));
@@ -22,92 +11,250 @@ function createFileGlob(patterns, pageExtensions) {
     }
     return `${patterns}{${pageExtensions.join(',')}}`;
 }
-function isSubfolderIndex(page, dirName) {
-    return page.fullPath.split('/').length === String(dirName).split('/').length + 2;
+function getPageLevel(page) {
+    return page.route.split('/').length - 2;
 }
-function sortFn(pageA, pageB, dirName) {
-    // Always pin /index to the front
-    const route = `${dirName}/index`;
-    if (pageA.route === route) {
-        return -1;
-    }
-    if (pageB.route === route) {
-        return 1;
-    }
-    return ((pageB.sidebar && pageB.sidebar.priority ? pageB.sidebar.priority : -1) -
-        (pageA.sidebar && pageA.sidebar.priority ? pageA.sidebar.priority : -1));
+function sortByPathLevel(pathA, pathB) {
+    const pathALevel = pathA.split('/').length;
+    const pathBLevel = pathB.split('/').length;
+    return pathBLevel - pathALevel;
 }
-function filterFn(page) {
-    return !(page.sidebar && page.sidebar.exclude);
+/**
+ * Given the sharedSortConfig
+ * 1. find the field specified by 'field' in the sort config
+ * 2. transform the field value into the type specified by 'dataType'
+ * @param page
+ * @param sharedSortConfig
+ * @returns transformed field value
+ */
+function getSortFieldData(page, sharedSortConfig) {
+    let fieldData;
+    if (sharedSortConfig !== undefined) {
+        const { field, dataType = 'string' } = sharedSortConfig;
+        field
+            .replace(/^(?:\.\.\/|\.\/)+/, '')
+            .split('/')
+            .forEach(part => {
+            const source = fieldData === undefined ? page : fieldData;
+            if (Object.prototype.hasOwnProperty.call(source, part)) {
+                fieldData = source[part];
+            }
+        });
+        switch (dataType) {
+            case 'date':
+                fieldData = new Date(fieldData).getTime(); // call getTime to convert to a number
+                break;
+            case 'string':
+                fieldData = String(fieldData);
+                break;
+            case 'number':
+                fieldData = Number(fieldData);
+                break;
+            default:
+                fieldData = String(fieldData);
+        }
+    }
+    return fieldData;
 }
 /**
- * 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* () {
-            function setPageRefs(sidebarFilePath, page, i) {
-                config.setRef(sidebarFilePath, ['pages', `${i}`, 'id', '$ref'], `${page.fullPath}#/route`);
-                const label = page.sidebar && page.sidebar.label
-                    ? `${page.fullPath}#/sidebar/label`
-                    : `${page.fullPath}#/title`;
-                config.setRef(sidebarFilePath, ['pages', `${i}`, 'name', '$ref'], label);
-                config.setRef(sidebarFilePath, ['pages', `${i}`, 'data', 'link', '$ref'], `${page.fullPath}#/route`);
-            }
-            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* () {
-                            const deserialisedPage = yield serialiser.deserialise(pagePath, yield mutableFilesystem.promises.readFile(pagePath));
-                            return deserialisedPage;
-                        })))).filter(filterPage => filterFn(filterPage));
-                        if (childPages.length > 1) {
-                            for (let j = 1; j < childPages.length; j++) {
-                                config.setRef(sidebarFilePath, ['pages', `${i}`, 'childNodes', `${j - 1}`, '$ref'], `${childNodeSidebarPath}#/pages/${j}`);
-                            }
-                        }
-                    }
+    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 hierarchy
+         * @param pages - sidebar pages
+         */
+        function createGroupMap(pages) {
+            const sortConfigPages = {};
+            return pages.reduce((result, page) => {
+                const name = page.sidebar?.label || page.title;
+                const sharedSortConfig = page?.sharedConfig?.sidebar?.sort;
+                if (sharedSortConfig) {
+                    try {
+                        sidebarSortConfigSchema.parse(sharedSortConfig);
+                        sortConfigPages[`${path.posix.dirname(page.fullPath)}`] = sharedSortConfig;
+                    }
+                    catch (e) {
+                        /**
+                         * Don't throw a PluginError here as this will stop the sidebar being generated.
+                         * Plugins need a way to log errors/warnings without exceptions
+                         */
+                        console.error(`[Mosaic] SidebarPlugin - Invalid sidebar sort config found in ${page.fullPath}`);
+                    }
+                }
+                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 && sortConfigPages[`${path.posix.dirname(page.fullPath)}`] !== undefined) {
+                    const fieldData = getSortFieldData(page, sortConfigPages[`${path.posix.dirname(page.fullPath)}`]);
+                    newChildNode.sharedSortConfig = {
+                        ...sortConfigPages[`${path.posix.dirname(page.fullPath)}`],
+                        fieldData
+                    };
+                }
+                if (isGroup) {
+                    result[groupPath] = {
+                        ...newChildNode,
+                        ...result[groupPath]
+                    };
+                }
+                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 addSidebarDataToFrontmatter(page, dirName) {
-                const dirNameLevels = String(dirName)
-                    .split('/')
-                    .filter(level => level);
-                const sidebarRootDir = path_1.default.posix.join('/', ...dirNameLevels.slice(0, dirNameLevels.length < 3 ? dirNameLevels.length : 3), '/');
-                config.setRef(String(page.fullPath), ['sidebarData', '$ref'], path_1.default.posix.join(String(sidebarRootDir), options.filename, '#', 'pages'));
+            if (nextPage) {
+                config.setRef(currPage, ['navigation', 'next', 'title', '$ref'], `${nextPage}#/title`);
+                config.setRef(currPage, ['navigation', 'next', 'route', '$ref'], `${nextPage}#/route`);
             }
-            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* () {
-                    const deserialisedPage = yield serialiser.deserialise(pagePath, yield mutableFilesystem.promises.readFile(pagePath));
-                    return deserialisedPage;
-                }))))
-                    .filter(page => filterFn(page))
-                    .sort((pageA, pageB) => sortFn(pageA, pageB, dirName));
-                for (let i = 0; i < pages.length; i++) {
-                    setPageRefs(sidebarFilePath, pages[i], i);
-                    setChildPageRefs(pages[i], dirName, i, sidebarFilePath);
-                    addSidebarDataToFrontmatter(pages[i], dirName);
+        };
+        function addNavigationToFrontmatter(pages) {
+            let prevParentPage, nextParentPage;
+            const getLastPage = pages => {
+                if (pages[pages.length - 1].childNodes?.length) {
+                    return getLastPage(pages[pages.length - 1].childNodes);
                 }
-                yield mutableFilesystem.promises.writeFile(sidebarFilePath, '[]');
+                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);
+                });
             }
+            recursiveAddNavigation(pages);
+        }
+        const rootUserJourneys = await mutableFilesystem.promises.glob(rootDirGlob, {
+            onlyDirectories: true,
+            extglob: true,
+            cwd: '/'
         });
+        const removeExcludedPages = page => !(page.sidebar && page.sidebar.exclude);
+        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);
+            const pages = await createPageList(rootDir);
+            const includedPages = pages.filter(page => removeExcludedPages(page));
+            const groupMap = createGroupMap(includedPages);
+            const sidebarData = linkGroupMap(groupMap, rootDir);
+            if (sidebarData[0] === undefined) {
+                console.warn(`[Mosaic] SidebarPlugin - Unable to create a Sidebar grouping for ${rootDir}`);
+                console.log('[Mosaic] SidebarPlugin - likely you have a directory without an index file');
+                return;
+            }
+            const sortedSidebarData = sortSidebarData(sidebarData);
+            addNavigationToFrontmatter(sortedSidebarData);
+            const pagesWithRootMovedDown = moveRootPageDown(sortedSidebarData);
+            await mutableFilesystem.promises.writeFile(sidebarFilePath, JSON.stringify({ pages: pagesWithRootMovedDown }));
+            addSidebarDataToFrontmatter(pages, rootDir);
+        }));
     }
 };
-exports.default = SidebarPlugin;
+export default SidebarPlugin;
 //# sourceMappingURL=SidebarPlugin.js.map