samaid v0.0.2

samaid

🪄 Magically transform AWS SAM templates to Mermaid diagrams 🪄

Ever wanted to quickly and painlessly just magically get Mermaid templates from your AWS SAM templates? That's what samaid does for you.

samaid supports both being run as a Node module and as a CLI tool.

Name

Why the name?! SAM + Mermaid = samaid.

Usage

First, install the module with npm install samaid.

Node module example

// ES5 format
const { Samaid } = require('samaid');
// ES6 format
import { Samaid } from 'samaid';

// By default, samaid returns the Mermaid data
const mermaidDiagram = new Samaid(filePath).generate();

// Write the file to disk by passing an optional output path
new Samaid(filePath).generate(outputPath);

// Update your README with the diagram data (see more below)
new Samaid(filePath).generate(outputPath, true);

CLI tool examples

npx samaid

# Update README
npx samaid --readme

# Output to a file
npx samaid --output my_diagram.mmd
npx samaid -o my_diagram.mmd

# Output to a file
npx samaid --template my_template.yml
npx samaid -t my_template.yml

All commands can be combined.

If you do not provide a template name, then template.yml will be used.

An output file name must use the .mmd ending.

Infrastructure support

The infra support is still limited and is first and foremost adapted for common needs in my own contexts. It currently supports DynamoDB (AWS::DynamoDB::Table), Lambda functions (AWS::Serverless::Function), HTTP APIs (AWS::Serverless::HttpApi), and S3 (AWS::S3::Bucket).

Defaults and assumptions

If you want to have your README.md file updated with the diagram, the area between the start and end markers <!-- START DIAGRAM --> and <!-- END DIAGRAM --> will be used.

Example

samaid uses a bit of test data for a simple service which converts to this Mermaid diagram:

graph TD
  subgraph API
    HttpApi
  end
  subgraph DynamoDB
    example-api
  end
  subgraph Functions
    Demo --> |PutItem| example-api
    Demo --> |Query| example-api
    HttpApi --> |GET| Demo
    Demo2 --> |PutItem| example-api
    Demo2 --> |Query| example-api
    Demo2
  end
  subgraph EventBridge
    bloop --> |Triggers| Demo2
  end

Much more complex stacks are supported too, as long as the infrastructure is supported (see above).

License

MIT. See LICENSE file.