@jpmorganchase/mosaic-site-middleware 0.1.0-beta.10

package/dist/withSession.js

@@ -0,0 +1,67 @@
+import { getSessionFromToken, getToken, getIsCypressSession } from './session.js';
+import MiddlewareError from './MiddlewareError.js';
+if (typeof window !== 'undefined') {
+    throw new Error('This file should not be loaded on the client.');
+}
+const getRedirectOptions = (context) => {
+    const url = new URL(`${process.env.HOSTNAME?.replace(/\/$/, '')}/${context.resolvedUrl.replace(/^\//, '')}`);
+    if (url.search.includes('code=')) {
+        throw new Error('Authorisation loop detected. `code` should never appear in the client query string.');
+    }
+    url.searchParams.delete('namespace');
+    url.searchParams.delete('slug');
+    return {
+        redirect: {
+            destination: `/api/auth/login?referrer=${encodeURIComponent(`${url.pathname}${url.search}`)}`,
+            permanent: false
+        }
+    };
+};
+async function resolveSession(accessToken) {
+    return (accessToken &&
+        process.env.DISABLE_IDA_SERVICE_AUTH_TOKEN_VERIFICATION === 'true' &&
+        getSessionFromToken(accessToken));
+}
+/**
+ * Adds the [[`Session`]] object to the page props
+ * @param context
+ * @param options
+ */
+export const withSession = async (context, options) => {
+    if (process.env.ENABLE_LOGIN !== 'true') {
+        return {};
+    }
+    if (!process.env.COOKIE_SECRET) {
+        const errorMessage = '`process.env.COOKIE_SECRET` must be set in environment variables.';
+        throw new MiddlewareError(500, context.resolvedUrl, [errorMessage], {
+            show500: true
+        });
+    }
+    const accessToken = getToken(context.req);
+    const isCypressSession = getIsCypressSession(context.req);
+    const session = await resolveSession(accessToken);
+    // Do the middleware options have `loginRequired` true?
+    const isRedirectEnabled = options?.loginRequired;
+    const isLoggedIn = !!(accessToken &&
+        session &&
+        // If session remaining time is <15m we'll request a re-login
+        isSessionRemainingMoreThan(session, 900000 /* 15 mins */));
+    if (isRedirectEnabled && !isLoggedIn) {
+        return getRedirectOptions(context);
+    }
+    return {
+        props: {
+            session: {
+                ...session,
+                isLoggedIn,
+                accessToken,
+                isCypressSession
+            }
+        }
+    };
+};
+function isSessionRemainingMoreThan(session, minRemainingTime = 1800000 /* 30 mins */) {
+    const { expires = 0 } = session;
+    return expires >= Date.now() + minRemainingTime;
+}
+//# sourceMappingURL=withSession.js.map

package/dist/withSession.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withSession.js","sourceRoot":"","sources":["../src/withSession.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,QAAQ,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAElF,OAAO,eAAe,MAAM,sBAAsB,CAAC;AAEnD,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;IACjC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;CAClE;AAiBD,MAAM,kBAAkB,GAAG,CAAC,OAAkC,EAAE,EAAE;IAChE,MAAM,GAAG,GAAG,IAAI,GAAG,CACjB,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,CACxF,CAAC;IAEF,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QAChC,MAAM,IAAI,KAAK,CACb,qFAAqF,CACtF,CAAC;KACH;IACD,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACrC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAChC,OAAO;QACL,QAAQ,EAAE;YACR,WAAW,EAAE,4BAA4B,kBAAkB,CAAC,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE;YAC7F,SAAS,EAAE,KAAK;SACjB;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,KAAK,UAAU,cAAc,CAAC,WAAW;IACvC,OAAO,CACL,WAAW;QACX,OAAO,CAAC,GAAG,CAAC,2CAA2C,KAAK,MAAM;QACjE,mBAAmB,CAAC,WAAW,CAAa,CAC9C,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAmD,KAAK,EAC9E,OAAO,EACP,OAAO,EACP,EAAE;IACF,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,KAAK,MAAM,EAAE;QACvC,OAAO,EAAE,CAAC;KACX;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE;QAC9B,MAAM,YAAY,GAAG,mEAAmE,CAAC;QACzF,MAAM,IAAI,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,YAAY,CAAC,EAAE;YAClE,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;KACJ;IACD,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC1C,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC1D,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC,CAAC;IAClD,uDAAuD;IACvD,MAAM,iBAAiB,GAAG,OAAO,EAAE,aAAa,CAAC;IACjD,MAAM,UAAU,GAAG,CAAC,CAAC,CACnB,WAAW;QACX,OAAO;QACP,6DAA6D;QAC7D,0BAA0B,CAAC,OAAO,EAAE,MAAM,CAAC,aAAa,CAAC,CAC1D,CAAC;IACF,IAAI,iBAAiB,IAAI,CAAC,UAAU,EAAE;QACpC,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC;KACpC;IAED,OAAO;QACL,KAAK,EAAE;YACL,OAAO,EAAE;gBACP,GAAG,OAAO;gBACV,UAAU;gBACV,WAAW;gBACX,gBAAgB;aACjB;SACF;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,SAAS,0BAA0B,CAAC,OAAgB,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa;IAC5F,MAAM,EAAE,OAAO,GAAG,CAAC,EAAE,GAAG,OAAO,CAAC;IAChC,OAAO,OAAO,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,gBAAgB,CAAC;AAClD,CAAC"}

package/dist/withSharedConfig.d.ts

@@ -0,0 +1,9 @@
+import type { SharedConfig, SharedConfigSlice } from '@jpmorganchase/mosaic-store';
+import { MosaicMiddleware } from './createMiddlewareRunner.js';
+export { SharedConfig };
+/**
+ * Adds the [[`SharedConfig`]] props to the page props
+ * @param _context
+ * @param _params
+ */
+export declare const withSharedConfig: MosaicMiddleware<SharedConfigSlice>;

package/dist/withSharedConfig.js

@@ -0,0 +1,83 @@
+import path from 'path';
+import fs from 'fs';
+import MiddlewareError from './MiddlewareError.js';
+if (typeof window !== 'undefined') {
+    throw new Error('This file should not be loaded on the client.');
+}
+/**
+ * Fetch from mosaic the shared-config.json.
+ *
+ * @param url the shared config file URL
+ * @returns shared config JSON
+ */
+async function fetchSharedConfig(url) {
+    const response = await fetch(url, {
+        headers: {
+            'Content-Type': 'application/json'
+        }
+    });
+    return response;
+}
+/**
+ * Read from the file system the shared config
+ *
+ * @param url the shared config file URL
+ * @returns shared config JSON
+ */
+async function readSharedConfig(url) {
+    const mosaicSnapshotDir = process.env.MOSAIC_SNAPSHOT_DIR || '';
+    const filePath = path.posix.join(process.cwd(), mosaicSnapshotDir, url);
+    try {
+        const realPath = await fs.promises.realpath(filePath);
+        const data = await fs.promises.readFile(realPath, 'utf-8');
+        return new Response(data.toString(), { status: 200 });
+    }
+    catch (e) {
+        // it doesn't matter if no shared config file was found
+        return new Response('', { status: 204 });
+    }
+}
+/**
+ * Adds the [[`SharedConfig`]] props to the page props
+ * @param _context
+ * @param _params
+ */
+export const withSharedConfig = async (context) => {
+    const { resolvedUrl, res } = context;
+    const isStatic = res.getHeader('X-Mosaic-Mode') === 'static';
+    const matches = resolvedUrl.match(/(.*)[!/]/);
+    const urlPath = matches?.length ? matches[1] : '';
+    const mosaicUrl = isStatic ? '' : res.getHeader('X-Mosaic-Content-Url');
+    const sharedConfigUrl = `${mosaicUrl}${urlPath}/shared-config.json`;
+    let response;
+    try {
+        response = isStatic
+            ? await readSharedConfig(sharedConfigUrl)
+            : await fetchSharedConfig(sharedConfigUrl);
+        if (response.ok && response.status !== 204) {
+            const { config } = (await response.json());
+            return { props: { sharedConfig: config } };
+        }
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            console.error(error.message);
+            throw new MiddlewareError(500, sharedConfigUrl, [error.message], { show500: true });
+        }
+        else {
+            console.error('unexpected error');
+            throw new MiddlewareError(500, sharedConfigUrl, ['unexpected error'], { show500: true });
+        }
+    }
+    const show500 = response.status !== 404 && response.status !== 204;
+    const show404 = response.status === 404;
+    let errorMessage = `Could not find any shared config defined for ${sharedConfigUrl}`;
+    if (show500) {
+        errorMessage = `An un-expected error occurred reading ${sharedConfigUrl}`;
+    }
+    throw new MiddlewareError(response.status, sharedConfigUrl, [errorMessage], {
+        show404,
+        show500
+    });
+};
+//# sourceMappingURL=withSharedConfig.js.map

package/dist/withSharedConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withSharedConfig.js","sourceRoot":"","sources":["../src/withSharedConfig.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,IAAI,CAAC;AAIpB,OAAO,eAAe,MAAM,sBAAsB,CAAC;AAEnD,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;IACjC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;CAClE;AAID;;;;;GAKG;AACH,KAAK,UAAU,iBAAiB,CAAC,GAAW;IAC1C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;QAChC,OAAO,EAAE;YACP,cAAc,EAAE,kBAAkB;SACnC;KACF,CAAC,CAAC;IACH,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,gBAAgB,CAAC,GAAW;IACzC,MAAM,iBAAiB,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,EAAE,CAAC;IAChE,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,iBAAiB,EAAE,GAAG,CAAC,CAAC;IACxE,IAAI;QACF,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACtD,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC3D,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;KACvD;IAAC,OAAO,CAAC,EAAE;QACV,uDAAuD;QACvD,OAAO,IAAI,QAAQ,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;KAC1C;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAwC,KAAK,EACxE,OAAkC,EAClC,EAAE;IACF,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IACrC,MAAM,QAAQ,GAAG,GAAG,CAAC,SAAS,CAAC,eAAe,CAAC,KAAK,QAAQ,CAAC;IAC7D,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC9C,MAAM,OAAO,GAAG,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAClD,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;IACxE,MAAM,eAAe,GAAG,GAAG,SAAS,GAAG,OAAO,qBAAqB,CAAC;IACpE,IAAI,QAAQ,CAAC;IACb,IAAI;QACF,QAAQ,GAAG,QAAQ;YACjB,CAAC,CAAC,MAAM,gBAAgB,CAAC,eAAe,CAAC;YACzC,CAAC,CAAC,MAAM,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAE7C,IAAI,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YAC1C,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA6B,CAAC;YAEvE,OAAO,EAAE,KAAK,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,CAAC;SAC5C;KACF;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,KAAK,YAAY,KAAK,EAAE;YAC1B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC7B,MAAM,IAAI,eAAe,CAAC,GAAG,EAAE,eAAe,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;SACrF;aAAM;YACL,OAAO,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;YAClC,MAAM,IAAI,eAAe,CAAC,GAAG,EAAE,eAAe,EAAE,CAAC,kBAAkB,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;SAC1F;KACF;IACD,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC;IACnE,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC;IACxC,IAAI,YAAY,GAAG,gDAAgD,eAAe,EAAE,CAAC;IACrF,IAAI,OAAO,EAAE;QACX,YAAY,GAAG,yCAAyC,eAAe,EAAE,CAAC;KAC3E;IACD,MAAM,IAAI,eAAe,CAAC,QAAQ,CAAC,MAAM,EAAE,eAAe,EAAE,CAAC,YAAY,CAAC,EAAE;QAC1E,OAAO;QACP,OAAO;KACR,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/withStaticContent.d.ts

@@ -0,0 +1,7 @@
+import { MosaicMiddleware } from './createMiddlewareRunner.js';
+import { ContentProps } from './withContent.js';
+/**
+ * Adds the [[`ContentProps`]] object to the page props
+ * @param context
+ */
+export declare const withStaticContent: MosaicMiddleware<ContentProps>;

package/dist/withStaticContent.js

@@ -0,0 +1,42 @@
+import path from 'path';
+import fs from 'fs';
+import { compileMDX } from './compileMdx.js';
+import MiddlewareError from './MiddlewareError.js';
+/**
+ * Adds the [[`ContentProps`]] object to the page props
+ * @param context
+ */
+export const withStaticContent = async (context) => {
+    const { resolvedUrl, res } = context;
+    const isStatic = res.getHeader('X-Mosaic-Mode') === 'static';
+    if (!isStatic) {
+        return {};
+    }
+    const mosaicSnapshotDir = process.env.MOSAIC_SNAPSHOT_DIR || '';
+    // Find the absolute path for  the file/dir requested
+    const filePath = path.posix.join(process.cwd(), mosaicSnapshotDir, resolvedUrl);
+    try {
+        const realPath = await fs.promises.realpath(filePath);
+        const extname = path.extname(realPath);
+        if (extname === '.mdx') {
+            const data = await fs.promises.readFile(filePath, 'utf-8');
+            const text = data.toString();
+            const mdxSource = await compileMDX(text);
+            return { props: { type: 'mdx', source: mdxSource, raw: text } };
+        }
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            console.error(error.message);
+            throw new MiddlewareError(500, resolvedUrl, [error.message], { show500: true });
+        }
+        else {
+            console.error('unexpected error');
+            throw new MiddlewareError(500, resolvedUrl, ['unexpected error'], { show500: true });
+        }
+    }
+    throw new MiddlewareError(404, resolvedUrl, [`Could not find any content for ${resolvedUrl}`], {
+        show404: true
+    });
+};
+//# sourceMappingURL=withStaticContent.js.map

package/dist/withStaticContent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withStaticContent.js","sourceRoot":"","sources":["../src/withStaticContent.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,IAAI,CAAC;AAEpB,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,eAAe,MAAM,sBAAsB,CAAC;AAGnD;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAmC,KAAK,EAAC,OAAO,EAAC,EAAE;IAC/E,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IACrC,MAAM,QAAQ,GAAG,GAAG,CAAC,SAAS,CAAC,eAAe,CAAC,KAAK,QAAQ,CAAC;IAE7D,IAAI,CAAC,QAAQ,EAAE;QACb,OAAO,EAAE,CAAC;KACX;IACD,MAAM,iBAAiB,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,EAAE,CAAC;IAChE,qDAAqD;IACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,iBAAiB,EAAE,WAAW,CAAC,CAAC;IAEhF,IAAI;QACF,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACtD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,OAAO,KAAK,MAAM,EAAE;YACtB,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAC3D,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC7B,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC;YACzC,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC;SACjE;KACF;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,KAAK,YAAY,KAAK,EAAE;YAC1B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC7B,MAAM,IAAI,eAAe,CAAC,GAAG,EAAE,WAAW,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;SACjF;aAAM;YACL,OAAO,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;YAClC,MAAM,IAAI,eAAe,CAAC,GAAG,EAAE,WAAW,EAAE,CAAC,kBAAkB,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;SACtF;KACF;IACD,MAAM,IAAI,eAAe,CAAC,GAAG,EAAE,WAAW,EAAE,CAAC,kCAAkC,WAAW,EAAE,CAAC,EAAE;QAC7F,OAAO,EAAE,IAAI;KACd,CAAC,CAAC;AACL,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@jpmorganchase/mosaic-site-middleware",
+  "version": "0.1.0-beta.10",
+  "license": "Apache-2.0",
+  "description": "Mosaic - Site middleware",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -fr dist",
+    "lint": "eslint --ignore-pattern \"**/__tests__/**\""
+  },
+  "devDependencies": {
+    "typescript": "^4.8.3"
+  },
+  "dependencies": {
+    "@jpmorganchase/mosaic-types": "^0.1.0-beta.10",
+    "@jpmorganchase/mosaic-store": "^0.1.0-beta.10",
+    "@types/mdast": "^3.0.0",
+    "acorn": "^8.0.0",
+    "acorn-jsx": "^5.0.0",
+    "deepmerge": "^4.2.2",
+    "jwt-decode": "^3.1.2",
+    "lodash": "^4.17.21",
+    "next": "^12.1.0",
+    "next-mdx-remote": "^4.0.0",
+    "node-cookie": "^2.1.2",
+    "react-error-boundary": "^3.1.4",
+    "react-pro-sidebar": "1.0.0-alpha.7",
+    "rehype-slug": "^5.0.1",
+    "unified": "^10.0.0",
+    "unist-util-visit": "^2.0.0",
+    "warning": "^3.0.0"
+  }
+}

package/src/MiddlewareError.ts

@@ -0,0 +1,26 @@
+export default class MiddlewareError extends Error {
+  /** Response code */
+  public status: number;
+
+  /** Related route location */
+  public location: string | undefined;
+
+  /** Array of errors */
+  public errors: string[];
+
+  /** Props to pass back */
+  public props: { show404?: boolean; show500?: boolean };
+
+  constructor(
+    status: MiddlewareError['status'],
+    location: MiddlewareError['location'],
+    errors: MiddlewareError['errors'] = [],
+    props: MiddlewareError['props'] = {}
+  ) {
+    super(`${status} error`);
+    this.status = status;
+    this.location = location;
+    this.errors = errors;
+    this.props = props;
+  }
+}

package/src/__tests__/createMDXScope.test.ts

@@ -0,0 +1,79 @@
+import { createMDXScope } from '../utils/createMDXScope';
+
+describe('GIVEN createMDXScope', () => {
+  test("should add meta to it's scope", () => {
+    const scope = createMDXScope({ test: 'TEST META' });
+    expect(scope.meta).toEqual({ test: 'TEST META' });
+  });
+  test('should provide a filter helper which filters by callback', () => {
+    const scope = createMDXScope();
+    const filter = scope.helpers.filter({ filter: item => item.product === 'PRODUCT_C' });
+    const filteredView = filter([
+      { product: 'PRODUCT_A' },
+      { product: 'PRODUCT_B' },
+      { product: 'PRODUCT_C' }
+    ]);
+    expect(filteredView).toEqual([{ product: 'PRODUCT_C' }]);
+  });
+  test('should provide a limit helper which limits the displayed results', () => {
+    const scope = createMDXScope();
+    const limit = scope.helpers.limit({ max: 2 });
+    const filteredView = limit([
+      { product: 'PRODUCT_A' },
+      { product: 'PRODUCT_B' },
+      { product: 'PRODUCT_C' }
+    ]);
+    expect(filteredView).toEqual([{ product: 'PRODUCT_A' }, { product: 'PRODUCT_B' }]);
+  });
+  test('should provide a sort helper which can sort the results by date key', () => {
+    const scope = createMDXScope();
+    const sort = scope.helpers.sortViewByDate({ dateKey: 'releaseDate' });
+    const filteredView = sort([
+      { product: 'PRODUCT_A', releaseDate: '2020/01/01' },
+      { product: 'PRODUCT_B', releaseDate: '2020/01/02' },
+      { product: 'PRODUCT_C', releaseDate: '2020/01/03' }
+    ]);
+    expect(filteredView[0].product).toEqual('PRODUCT_C');
+    expect(filteredView[1].product).toEqual('PRODUCT_B');
+    expect(filteredView[2].product).toEqual('PRODUCT_A');
+  });
+  test('should provide a sort helper which can sort the results by date function', () => {
+    const scope = createMDXScope();
+    const sort = scope.helpers.sortViewByDate({ dateKey: item => item.releaseDate });
+    const filteredView = sort([
+      { product: 'PRODUCT_A', releaseDate: '2020/01/01' },
+      { product: 'PRODUCT_B', releaseDate: '2020/01/02' },
+      { product: 'PRODUCT_C', releaseDate: '2020/01/03' }
+    ]);
+    expect(filteredView[0].product).toEqual('PRODUCT_C');
+    expect(filteredView[1].product).toEqual('PRODUCT_B');
+    expect(filteredView[2].product).toEqual('PRODUCT_A');
+  });
+  test('should provide a flow function which enables you to compose helpers', () => {
+    const scope = createMDXScope();
+    const sort = scope.helpers.flow([
+      scope.helpers.sortViewByDate({ dateKey: item => item.releaseDate }),
+      scope.helpers.filter({ filter: item => item.product === 'PRODUCT_A' }),
+      scope.helpers.limit({ max: 3 })
+    ]);
+    const filteredView = sort([
+      { product: 'PRODUCT_C', releaseDate: '2022/01/01' },
+      { product: 'PRODUCT_A', releaseDate: '2020/01/02' },
+      { product: 'PRODUCT_A', releaseDate: '2020/01/04' },
+      { product: 'PRODUCT_A', releaseDate: '2020/01/05' },
+      { product: 'PRODUCT_A', releaseDate: '2020/01/04' }
+    ]);
+    expect(filteredView.length).toEqual(3);
+    expect(filteredView[0]).toEqual({ product: 'PRODUCT_A', releaseDate: '2020/01/05' });
+    expect(filteredView[1]).toEqual({ product: 'PRODUCT_A', releaseDate: '2020/01/04' });
+    expect(filteredView[2]).toEqual({ product: 'PRODUCT_A', releaseDate: '2020/01/04' });
+  });
+  test('should provide a collection of hooks', () => {
+    const scope = createMDXScope();
+    expect(scope.hooks).toBeDefined();
+  });
+  test('should provide a collection of recipes', () => {
+    const scope = createMDXScope();
+    expect(scope.recipes).toBeDefined();
+  });
+});

package/src/compileMdx.ts

@@ -0,0 +1,19 @@
+import { serialize } from 'next-mdx-remote/serialize';
+import rehypeSlug from 'rehype-slug';
+import { codeBlocks } from './plugins/codeBlocks.js';
+
+export async function compileMDX(
+  content,
+  parseFrontmatter = true,
+  rehypePlugins = [],
+  remarkPlugins = []
+) {
+  const mdxSource = await serialize(content, {
+    mdxOptions: {
+      rehypePlugins: [rehypeSlug, ...remarkPlugins],
+      remarkPlugins: [codeBlocks, ...rehypePlugins]
+    },
+    parseFrontmatter
+  });
+  return mdxSource;
+}

package/src/createMiddlewareRunner.ts

@@ -0,0 +1,108 @@
+import type { GetServerSidePropsContext } from 'next';
+import deepmerge from 'deepmerge';
+
+import type { MosaicAppProps } from './middlewarePresets.js';
+import MiddlewareError from './MiddlewareError.js';
+
+const overwriteMerge = (_, sourceArray) => sourceArray;
+
+/** Props returned after running Middleware */
+export type MiddlewareResult<TProps> = Awaited<MosaicAppProps<TProps>>;
+
+/** Options to be passed to Middleware */
+export type MosaicMiddlewareOptions = Record<string, unknown>;
+
+/** Middleware callbacks return props to be added to the page */
+export type MosaicMiddleware<TProps = unknown, TOptions = MosaicMiddlewareOptions> = (
+  /** Context provides information on the current page */
+  context: GetServerSidePropsContext,
+  /** Middleware specific options */
+  options: TOptions,
+  /** Previous result created by plugins */
+  lastState: Record<string, unknown>
+) => Promise<MiddlewareResult<TProps>>;
+
+/** Middleware with a configuration object specifying options */
+export type MosaicMiddlewareWithConfig<TProps, TConfig> = [
+  MosaicMiddleware<TProps, TConfig>,
+  TConfig
+];
+
+/** Function to run all provided middleware */
+export type MosaicMiddlewareRunner<TProps> = (
+  context: GetServerSidePropsContext,
+  options: MosaicMiddlewareOptions
+) => Promise<MiddlewareResult<TProps>>;
+
+/**
+ * Creates a middleware runner from the collection of provided middleware
+ * @param initialState initial state
+ * @param middleware a collection of middleware to be executed in order to get the page props
+ * @returns a middleware runner
+ */
+export function createMiddlewareRunner<TProps>(
+  initialState: Record<string, unknown>,
+  middleware: Array<MosaicMiddleware<any> | MosaicMiddlewareWithConfig<any, any>>
+): MosaicMiddlewareRunner<TProps> {
+  return async function middlewareRunner(context, options) {
+    let result: MiddlewareResult<TProps> = initialState;
+    const errors: Error[] = [];
+    // eslint-disable-next-line no-restricted-syntax
+    for (const fnOrConfig of middleware) {
+      let fn: MosaicMiddleware<TProps, any>;
+      let finalOptions = options;
+      try {
+        if (typeof fnOrConfig === 'function') {
+          fn = fnOrConfig;
+        } else {
+          fn = fnOrConfig[0];
+          finalOptions = { ...options, ...fnOrConfig[1] };
+        }
+        // eslint-disable-next-line no-await-in-loop
+        const nextState = await fn(context, finalOptions, result);
+        result = deepmerge<MiddlewareResult<TProps>>(result, nextState, {
+          arrayMerge: overwriteMerge
+        });
+      } catch (error) {
+        if (error instanceof Error) {
+          errors.push(error);
+        } else {
+          const unexpectedError = new MiddlewareError(500, undefined, [String(error)], {
+            show500: true
+          });
+          errors.push(unexpectedError);
+        }
+      }
+    }
+    if (result.redirect) {
+      return { redirect: result.redirect };
+    }
+    const show404 = errors.some(error => {
+      if (error instanceof MiddlewareError) {
+        return error.props?.show404;
+      }
+      return false;
+    });
+    const show500 =
+      !show404 &&
+      errors.some(error => {
+        if (error instanceof MiddlewareError) {
+          return error.props?.show500;
+        }
+        return true;
+      });
+
+    if (show500) {
+      console.error('An un-expected error(s) was thrown which caused the 500 page to appear');
+      errors.forEach(error => {
+        console.error(error.message);
+      });
+    }
+
+    if (show404 || show500) {
+      context.res.setHeader(`X-Mosaic-${show404 ? '404' : '500'}`, 'true');
+    }
+    const props: TProps = { ...result.props, show404, show500 } as TProps;
+    return { props };
+  };
+}

package/src/index.ts

@@ -0,0 +1,9 @@
+export * from './compileMdx.js';
+export * from './createMiddlewareRunner.js';
+export * from './MiddlewareError.js';
+export * from './middlewarePresets.js';
+export * from './withContent.js';
+export * from './withMosaicMode.js';
+export * from './withSession.js';
+export * from './withSharedConfig.js';
+export * from './withStaticContent.js';

package/src/middlewarePresets.ts

@@ -0,0 +1,52 @@
+import type { Redirect } from 'next';
+import { SharedConfigSlice } from '@jpmorganchase/mosaic-store';
+
+import { withSession, type SessionProps, type SessionOptions } from './withSession.js';
+import { withSharedConfig } from './withSharedConfig.js';
+import { withContent, type ContentProps } from './withContent.js';
+import { MosaicMiddleware, MosaicMiddlewareWithConfig } from './createMiddlewareRunner.js';
+import { withMosaicMode, type MosaicModeProps } from './withMosaicMode.js';
+
+export type BaseMosaicAppProps = {
+  /** Flag to show custom 404 page, whilst maintaining current state/layout */
+  show404?: boolean;
+  /** Flag to show custom 500 page, whilst maintaining current state/layout */
+  show500?: boolean;
+};
+
+/** Abstract Mosaic App Props */
+export type MosaicAppProps<T> = {
+  /** Page props created by [[`Middleware`]] */
+  props?: T;
+  /** Error description */
+  errors?: {
+    /** Stacktrace * */
+    location?: string;
+    /** Error message * */
+    statusText?: string;
+    /** Error code */
+    status?: number;
+  } & BaseMosaicAppProps;
+  /** Next JS Redirect */
+  redirect?: Redirect;
+};
+
+/** Mosaic getServerSideProps result which supports error handling */
+export type GetMosaicServerSidePropsResult<T> = MosaicAppProps<T>;
+
+/** MiddlewarePresets props */
+export type MiddlewarePresetsProps = MosaicModeProps &
+  ContentProps &
+  SessionProps &
+  SharedConfigSlice;
+
+/** A collection of preset [[`Middleware`]] plugins that will compose together the page props */
+export const middlewarePresets: Array<
+  | MosaicMiddleware<MiddlewarePresetsProps>
+  | MosaicMiddlewareWithConfig<MiddlewarePresetsProps, SessionOptions>
+> = [
+  [withSession, { loginRequired: process.env.DISABLE_GLOBAL_AUTH !== 'true' }],
+  withMosaicMode,
+  withSharedConfig,
+  withContent
+];

package/src/plugins/codeBlocks.ts

@@ -0,0 +1,52 @@
+import { Parser } from 'acorn';
+import jsx from 'acorn-jsx';
+import type { Code, Literal } from 'mdast';
+import { Plugin, Transformer } from 'unified';
+import visit from 'unist-util-visit';
+
+const parser = Parser.extend(jsx());
+
+/**
+ * Modified from: https://github.com/remcohaszing/remark-mdx-code-meta
+ *
+ * Custom meta parser for codefences that have extra params. e.g.
+ * ```jsx filename="hello.jsx"
+ * <div>Test!</div>
+ * ```
+ *
+ * Custom meta parser for codefences that have eval or eval="true".
+ * This allows vars to be resolved and their values used as the code block body.
+ * ```jsx eval
+ * meta.data.someStringOnlyAvailableAtRuntime
+ * ```
+ */
+export const transformer: Transformer = ast => {
+  visit<Code>(ast, 'code', (node, index, parent) => {
+    if (!node.meta) {
+      return;
+    }
+    // Limit eval to just basic strings that start with "meta."
+    const isEval =
+      /(^| )eval(="true"| |$)/.test(node.meta) && /^meta\.[a-z0-9_[\].$"']+$/i.test(node.value);
+
+    let code;
+    if (!isEval) {
+      code = JSON.stringify(`${node.value}\n`);
+    } else {
+      code = node.value;
+    }
+
+    const codeProps = node.lang ? `className="language-${node.lang}"` : '';
+    const value = `<pre ${node.meta}><code ${codeProps}>{${code}}</code></pre>`;
+    const estree = parser.parse(value, { ecmaVersion: 'latest' });
+    // eslint-disable-next-line no-param-reassign
+    parent!.children[index] = { type: 'mdxFlowExpression', value, data: { estree } } as Literal;
+  });
+};
+
+/**
+ * A markdown plugin for transforming code metadata.
+ *
+ * @returns A unified transformer.
+ */
+export const codeBlocks: Plugin<[]> = () => transformer;