@mashroom/mashroom-utils

Mashroom Utils

Part of Mashroom Server, a Microfrontend Integration Platform.

This package contains some shared utilities for Mashroom Server plugins.

Changelog

2.0.0-alpha.1 (January 21, 2022)

• Portal: Prevent misusing resource requests for Remote Apps to access proxy targets (if a proxy target is a sub-path of the resource base URL)
• Portal: Added config property addDemoPages to start with an empty Portal if set to false
• Theme refurbishment: Switched to a new cool logo and a slightly more blueish primary color
• Portal: Added CDN support for Theme and all Portal App resources. All you need to do is to add mashroom-cdn to your dependencies and configure it like shown below.
• Added a CDN Service that can be used to obtain a CDN host to fetch resources. Basically, it just returns a host from a configurable list (round-robin):

    {
      "Mashroom CDN Services": {
        "cdnHosts": [
          "//cdn1.my-portal.com",
          "//cdn2.my-portal.com"
        ]
      }
    }
  

• Added a middleware to deliver a robots.txt
• Portal: Added to possibility to define custom App Config editors per Portal App. This is useful for Apps that have an editable content (e.g. from a Headless CMS). A custom editor is basically just another Portal App (SPA) that receives a special object within the appConfig with the config of the target App and a function to update it:

   const bootstrap: MashroomPortalAppPluginBootstrapFunction = (portalAppHostElement, portalAppSetup, clientServices) => {
     const {appConfig: {editorTarget /* MashroomPortalConfigEditorTarget */}} = portalAppSetup;
  
     const currentAppConfig = editorTarget.appConfig;
     // Open Editor with current config
  
     // Update with new Config
     editorTarget.updateAppConfig(newAppConfig);
   };
  

  In the App that wants to use the editor just update the plugin definition like this:

       "defaultConfig": {
         "editor": {
           "editorPortalApp": "My Editor App",
           "position": "in-place"
         }
      }
  

  Since the target App remains active it is also possible to use the message bus to exchange information between the editor and the actual App.
• Portal: Support for Hybrid Apps with server side rendering added. When a page is rendered the Portal tries to get the initial HTML for all Apps on in and integrated it into the template. The server side HTML will also be cached (if configured). If the server side rendering takes too long (default more than 2000 ms) the Portal automatically switches to client side rendering, but puts the result into the cache anyways for subsequent page requests. The additional configuration in the mashroom-portal plugin looks like this:

    {
      "ssrConfig": {
        "ssrEnabled": true,
        "renderTimoutMs": 2000,
        "cacheTTLSec": 300,
        "inlineStyles": true
      }
    }
  

• Portal: New plugin definition for Portal Apps with type portal-app2 added to be able to integrate new features such as SSR and config editor. Changes are compared to portal-app are:
  • Moved title, tags and category to defaultConfig, so it can be overwritten per server instance
  • bootstrap has been renamed to clientBootstrap
  • The resourcesRoot can now be defined for local deployment and remote access separately
  • restProxies has been renamed to proxies because the proxy supports all kinds of HTTP and WebSocket connections
  • Caching config added
  • Custom editor config added Existing portal-app definitions are still valid, but if you want to upgrade, change the following:

    {
      "name": "My Single Page App",
      "title": "My Single Page App",
      "category": "Demo",
      "tags": ["what", "ever"],
      "type": "portal-app",
      "bootstrap": "startMyApp",
      "defaultConfig": {
        "resourcesRoot": "./dist",
        "restProxies": {
           "spaceXApi": {
               "targetUri": "https://api.spacexdata.com/v3",
               "sendPermissionsHeader": false,
               "restrictToRoles": ["Role1"]
           }
        }
      }
    }
  

  to:

    {
      "name": "My Single Page App",
      "type": "portal-app2",
      "clientBootstrap": "startMyApp",
      "local": {
        "resourcesRoot": "./dist",
        "ssrBootstrap": "optional-ssr-bootstrap-file"
      },
      "remote": {
        "resourcesRoot": "/if-remote-access-supported",
        "ssrInitialHtmlPath": "optional-ssr-route"
      },
      "defaultConfig": {
        "title": "My Single Page App",
        "category": "Demo",
        "tags": ["what", "ever"],
        "caching": {
          "ssrHtml": "same-config-and-user"
        },
        "editor": {
          "editorPortalApp": "My Optional App Config Editor",
          "position": "in-place",
          "appConfig": {
          }
        },
        "proxies": {
           "spaceXApi": {
               "targetUri": "https://api.spacexdata.com/v3",
               "sendPermissionsHeader": false,
               "restrictToRoles": ["Role1"]
           }
        }
      }
    }
  

• Storage: The Storage API (MashroomStorage) supports now a subset of Mongo's filter operations ($gt, $regex, ...), sorting and proper paging (skip + limit). So you can do something like:

       await storage.find({ $and: [{ b: { $gt: 1 }}, { x: { $exists: false }}]}, 10, 0, { b: 'asc' })