@agiledigital/mule-preview
Advanced tools
This is the core module of the Mule Preview project.
It is a self contained bundle that can be included in other projects to render Mule XML files in a browser context using React.
See the Mule Preview Browser Extension for example usage.
The module exposes four components that can be imported and used in a React project:
<MulePreviewDiffUrl contentUrls={["https://a.xml", "https://b.xml"] contentRoot="."} /><MulePreviewDiffContent contentStrings={["<mule></mule>", "<mule></mule>"] contentRoot="."} /><MulePreviewUrl contentUrl="https://a.xml" contentRoot="."} /><MulePreviewContent contentString="<mule></mule>" contentRoot="."} />where:
contentUrls is a tuple of two URLs to be diffed
contentStrings is a tuple of two strings with XML content to be diffed
contentUrl is a URL to be rendered as a preview
contentString is a string with XML to be rendered as a preview
contentRoot is the a prefix to prepend to any requests for the Mule component image files.
import React from "react";
import ReactDOM from "react-dom";
import {
MulePreviewDiffUrl,
} from "mule-preview";
ReactDOM.render(
<MulePreviewDiffUrl
contentUrls={["https://example.com/muleA.xml", "https://example.com/muleB.xml"]}
contentRoot="."
/>,
document.getElementById('root-node')
);
On a fresh checkout of the codebase you will need to extract the mappings and icon assets from Anypoint Studio using mule-metadata-extractor.
Download the latest release of mule-metadata-extractor and run the following commands:
export ANYPOINT_STUDIO_INSTALLATION=/opt/AnypointStudio
java -jar mule-metadata-extractor-1.0.14-standalone.jar -d "${ANYPOINT_STUDIO_INSTALLATION}" -o public/ generate-mappings
java -jar mule-metadata-extractor-1.0.14-standalone.jar -d "${ANYPOINT_STUDIO_INSTALLATION}" -o public/img/icons extract-images
java -jar mule-metadata-extractor-1.0.14-standalone.jar-d "${ANYPOINT_STUDIO_INSTALLATION}" -o public/img/icons apply-light-theme
At some point we may provide pre-extracted bundles that can be used with Mule Preview. We are still unsure about the licencing conditions around bundling and redistributing Mulesoft assets. We are waiting for a response from Mulesoft. In the meantime feel free to extract the files yourself for personal use.
To work on this module, the following command will mount Mule Preview in a test environment with hot reloading.
$ npm start
Simply navigate to http://localhost:8080 in a browser to view the test environment
Simply run these command to produce a production build
$ npm run build
The release files will be placed in the "dist" folder
Math icons made by Freepik from www.flaticon.com
FAQs
Renders Mule XML files as HTML.
The npm package @agiledigital/mule-preview receives a total of 35 weekly downloads. As such, @agiledigital/mule-preview popularity was classified as not popular.
We found that @agiledigital/mule-preview demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 8 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Snyk's use of malicious npm packages for research raises ethical concerns, highlighting risks in public deployment, data exfiltration, and unauthorized testing.
Research
Security News
Socket researchers found several malicious npm packages typosquatting Chalk and Chokidar, targeting Node.js developers with kill switches and data theft.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.