salesforce-flow-visualiser

KO | EN

gitlite — search

#javascript #react #ai #typescript #llm #android #machine-learning #rust #deep-learning #windows #cli #kubernetes #awesome-list #pytorch

salesforce-flow-visualiser

(★ 21)

Parse Salesforce Flow meta.xml to text-based graphical formats (e.g. mermaid)

salesforce-flow-visualiser Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Salesforce Flow Visualiser

Utility for parsing Salesforce Flow meta.xml to text-based graphical formats such as [mermaid](https://Mermaid.js.org/) and [PlantUML](https://plantuml.com/).

## Installtion

```
npm i salesforce-flow-visualiser
```

## Usage

```
import { parseFlow } from 'salesforce-flow-visualiser';

# Pass in XML string and get back a markdown string that includes mermaid representation of the Salesforce Flow

const mermaidStr = await parseFlow(<YourXMLStr>, 'mermaid', {outputAsMarkdown :true});
```

## Render Language Support
* [Mermaid](https://mermaid.js.org/) 
* [PlantUML](https://plantuml.com/)

## Roadmap / To do
* Tests... yeah of course
* Move each language out to it's own file
* Options... things like conditional wrapping into .md output
* Lint warnings?
* Other render engines?

## Contributing / Development

### Testing

#### Unit tests
We're using jest.
```
npm run test
```

#### To test locally
* Build the package (as below)
* In the *salesforce-flow-visualiser* directory
```
npm link
```
* In the project dir of the project that is using **salesforce-flow-visualiser**
```
npm link salesforce-flow-visualiser
```

### Build
We're using tsup
```
npm run build
```

### Publishing
```
```

salesforce-flow-visualiser

salesforce-flow-visualiser Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

salesforce-flow-visualiser

salesforce-flow-visualiser Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README