@diagrammo/dgmo 0.10.1 → 0.10.2

package/docs/guide/chart-sequence.md

@@ -1,354 +0,0 @@
-# Sequence Diagram
-
-```dgmo
-sequence Treasure Hunt App
-
-User -Search nearby loot-> WebApp
-WebApp -GET /treasures?nearby-> TreasureAPI | c: Search
-note
-  - check location
-  - use compass
-  - http://example.com
-TreasureAPI -Find within 5nm-> MapDB | c: Search
-MapDB -3 results-> TreasureAPI
-TreasureAPI -locations-> WebApp
-WebApp -Show treasure map-> User
-```
-
-Notice that `User` renders as a stick figure, `OrderDB` as a cylinder, `WebApp` as a monitor, and `PaymentGateway` as a hexagon — all inferred automatically from the names. No declarations needed.
-
-## Overview
-
-The sequence diagram uses an **inference-driven** syntax. Just write messages between participants and Diagrammo automatically:
-
-- **Creates participants** from their first mention — no declarations needed
-- **Infers participant shapes** from naming conventions — `User` gets a stick figure, `OrderDB` gets a cylinder, `API` gets a rounded box
-- **Tracks activation bars** from call stacks
-
-No `end` keywords are needed — blocks are scoped by indentation.
-
-## Syntax
-
-```
-sequence Diagram Title
-no-activations
-
-== Section Label ==
-
-A -message-> B
-A ~async message~> B
-
-if condition
-  A -message-> B
-else
-  A -alternative-> C
-
-loop description
-  A -retry-> B
-```
-
-## Settings
-
-| Key              | Description                             | Default  |
-| ---------------- | --------------------------------------- | -------- |
-| `chart`          | `sequence` (inferred from `->` content) | Optional |
-| `title`          | Diagram title                           | None     |
-| `no-activations` | Hide activation bars (on by default)    | off      |
-| `active-tag`     | Tag group to activate on load           | None     |
-| `collapse-notes` | Collapse notes by default               | off      |
-
-## Participants
-
-### Automatic Type Inference
-
-Participants are created automatically when first mentioned in a message. Their shape is inferred from the name — just use descriptive names and Diagrammo does the rest:
-
-```
-User -createOrder-> OrderService
-OrderService -save-> OrderDB
-OrderService -cache result-> Redis
-OrderService ~publish event~> EventBus
-```
-
-This creates five participants, each with a different shape — no declarations needed.
-
-The inference rules are checked in priority order (first match wins):
-
-| Type         | Shape               | Naming Patterns                                                                                      |
-| ------------ | ------------------- | ---------------------------------------------------------------------------------------------------- |
-| `actor`      | Stick figure        | `User`, `Customer`, `Client`, `Admin`, `Guest`, `Visitor`, `Operator`                                |
-| `database`   | Cylinder            | Names ending in `DB`; `Database`, `Store`, `Storage`, `Repo`, `Postgres`, `MySQL`, `Mongo`, `Dynamo` |
-| `cache`      | Dashed cylinder     | `Cache`, `Redis`, `Memcache`                                                                         |
-| `queue`      | Horizontal cylinder | `Queue`, `Kafka`, `RabbitMQ`, `EventBus`, `SQS`, `SNS`, `PubSub`, `Topic`, `Stream`                  |
-| `networking` | Hexagon             | `Gateway`, `Proxy`, `CDN`, `LoadBalancer`, `Firewall`, `DNS`, `Ingress`                              |
-| `frontend`   | Monitor             | `WebApp`, `Dashboard`, `MobileApp`, `Browser`, `CLI`, `Terminal`                                     |
-| `service`    | Rounded rectangle   | `Service`, `API`, `Lambda`, `Handler`, `Controller`, `Processor`, `Worker`                           |
-| `external`   | Dashed rectangle    | `External`, `ThirdParty`, `Vendor`                                                                   |
-| `default`    | Rectangle           | Anything unrecognized                                                                                |
-
-Names like `Router`, `Scheduler`, `Controller`, `Handler`, `Worker`, etc. are treated as services (not actors), even though they end in `-er`.
-
-### Explicit Declarations (Optional)
-
-You only need explicit declarations when you want to **override** the inferred type, set a **display alias**, or control **position**:
-
-```
-// Override type when the name doesn't match conventions
-Stripe is an external
-
-// Set a display alias for a cleaner label
-PaymentGW is a networking aka "Payment Gateway"
-
-// Control left-to-right ordering
-OrderDB position -1
-```
-
-## Participant Ordering
-
-Participants are laid out left-to-right based on **first appearance in messages** — the first participant mentioned gets the leftmost column.
-
-**Position values:**
-- `0` = leftmost, `1` = second from left, etc.
-- `-1` = rightmost, `-2` = second from right
-- If two participants target the same slot, the later one shifts to the nearest free position
-
-**Groups affect ordering:** members of the same group always stay adjacent (see [Groups](#groups) below). The group is placed where its first member would naturally appear.
-
-**Priority (highest wins):**
-1. Explicit `position N`
-2. Group adjacency
-3. First appearance in messages
-
-```
-// Example: force the database to the far right
-sequence
-User -placeOrder-> OrderService
-OrderService -save-> OrderDB
-OrderDB position -1
-```
-
-## Messages
-
-### Call Arrows
-
-A solid arrow from one participant to another:
-
-```
-User -login-> API
-```
-
-### Return Arrows
-
-Return arrows are generated automatically from the call stack. When A calls B, a dashed return arrow from B back to A appears once B's work is done:
-
-```
-User -login-> API
-API -query-> UserDB
-// Auto-return: UserDB → API (dashed)
-// Auto-return: API → User (dashed)
-```
-
-### Async / Fire-and-Forget
-
-No return arrow, no activation on the target — use the `~` arrow:
-
-```
-API ~sendWelcomeEmail~> EmailService
-API ~logEvent~> LogService
-```
-
-### Self-Calls
-
-A participant calling itself renders as a loopback arrow:
-
-```
-OrderService -validate-> OrderService
-```
-
-## Blocks
-
-Blocks use **indentation** for scoping — no `end` keyword needed.
-
-### If / Else
-
-```
-if user authenticated
-  API -getOrders-> OrderService
-  OrderService -query-> OrderDB
-else
-  API -401 Unauthorized-> User
-```
-
-Renders as a dashed frame with an `if` label and an optional `else` divider.
-
-### Loop
-
-```
-loop retry up to 3 times
-  OrderService -request-> ExternalAPI
-```
-
-### Parallel
-
-```
-parallel send notifications
-  API ~email~> EmailService
-  API ~text~> SMSService
-```
-
-Blocks can nest inside each other. Unindent to end a block.
-
-## Notes
-
-Add context between messages with `note`:
-
-```
-User -POST /login-> API
-note Validates credentials against LDAP
-API -query-> UserDB
-```
-
-The note appears between the two surrounding messages.
-
-## Sections
-
-Full-width horizontal dividers to organize phases:
-
-```
-== Authentication ==
-
-User -login-> API
-
-== Data Fetch ==
-
-API -query-> OrderDB
-
-== Response ==
-
-API -results-> User
-```
-
-## Groups
-
-Organize participants into labeled boxes in the header:
-
-```
-[Backend]
-  OrderService
-  PaymentService
-  OrderDB
-
-[Frontend]
-  WebApp
-  MobileApp
-```
-
-- `[Name]` declares a named group
-- Indented names belong to the group
-- Grouped participants stay adjacent in the layout
-- Groups can carry tag metadata: `[Backend | team: Product]`
-
-## Activation Bars
-
-Thin vertical rectangles on lifelines show when a participant has an active call. They are computed automatically from the call stack:
-
-- Appear from call arrow to auto-generated return
-- Nested calls show overlapping bars
-- Self-calls show offset overlapping bars
-- Disabled with `no-activations`
-
-## Comments
-
-```
-// This is a comment
-// Use // for all comments
-```
-
-Lines starting with `//` are ignored by the parser.
-
-## Tags
-
-Tags add color-coded metadata dimensions to sequence diagrams. Define a tag group, list its values with colors, then attach values to participants, messages, and groups with pipe metadata.
-
-### Defining Tag Groups
-
-```
-tag Concern alias c
-  Caching(blue)
-  Auth(green)
-  BusinessLogic(purple) default
-```
-
-- `tag Name` declares a tag group; `alias x` adds a shorthand
-- Each entry: `Value(color)` — named color for that value
-- `default` on an entry applies it to untagged elements when the group is active
-
-### Attaching Tags
-
-Use `| key: value` after participant declarations, message lines, or group headers:
-
-```
-API is a service | concern: Caching, team: Platform
-User -login-> API | concern: Auth
-[Backend | concern: BusinessLogic]
-  OrderAPI
-  DB
-```
-
-- Multiple tags: `| key1: val1, key2: val2`
-- Aliases work: `| c: Caching` (if `alias c` was declared)
-
-### Tag Resolution
-
-When a tag group is active, colors are resolved in priority order:
-
-1. Explicit metadata on the element
-2. Group propagation (participant inherits from its group)
-3. Receiver inheritance (all incoming tagged messages agree on the same value)
-4. `default` entry value
-5. Neutral (no color)
-
-### Legend
-
-A legend is rendered automatically above participants when tag groups exist. The active group expands to show colored entry dots. In the desktop app, click a group pill to activate it — participants and messages recolor to show that dimension.
-
-Set `active-tag GroupName` in settings to activate a group on load.
-
-## Complete Example
-
-```dgmo
-sequence E-Commerce Checkout
-
-tag Layer alias l
-  Frontend(teal)
-  Backend(blue)
-  Storage(purple)
-
-[Backend]
-  OrderService
-  PaymentGateway
-  OrderDB
-
-== Browse & Select ==
-
-User -Add items to cart-> WebApp
-WebApp -validateCart-> OrderService
-
-== Payment ==
-
-User -Submit payment-> WebApp
-WebApp -createOrder-> OrderService
-OrderService -charge(amount)-> PaymentGateway
-
-if payment successful
-  OrderService -saveOrder-> OrderDB
-  OrderService ~sendReceipt~> EmailService
-  WebApp -Order confirmed-> User
-else
-  WebApp -Payment declined-> User
-
-== Cleanup ==
-
-loop expire stale carts
-  OrderService -purgeExpired-> OrderDB
-```

package/docs/guide/chart-sitemap.md

@@ -1,265 +0,0 @@
-# Sitemap
-
-```dgmo
-sitemap The Salty Compass
-
-tag Auth
-  Public(green)
-  Crew Only(blue)
-
-Home | Auth: Public, description: Landing page with interactive demos
-  -shop-> Shop
-  -voyages-> Upcoming Voyages
-  -join crew-> Sign Up
-  -sign in-> Login
-
-[Ship Store]
-  Shop | Auth: Public
-    -> Eye Patches
-    -> Flags & Banners
-  Eye Patches | Auth: Public
-    -add to chest-> Cart
-  Flags & Banners | Auth: Public
-    -add to chest-> Cart
-  Cart | Auth: Public
-    -checkout-> Checkout
-  Checkout | Auth: Crew Only
-    -done-> My Orders
-
-[Voyages]
-  Upcoming Voyages | Auth: Public
-    -details-> Voyage Detail
-  Voyage Detail | Auth: Public
-    -enlist-> Sign Up
-
-[Crew Quarters]
-  Login | Auth: Public
-    -welcome aboard-> Dashboard
-    -new pirate-> Sign Up
-  Sign Up | Auth: Public
-    -welcome aboard-> Dashboard
-  Dashboard | Auth: Crew Only
-    description Full overview of crew activity and orders
-    -> My Orders
-  My Orders | Auth: Crew Only
-    -reorder-> Shop
-```
-
-## Overview
-
-Sitemap diagrams visualize website structure as a hierarchy of pages. Indentation defines the parent-child relationship between pages. Pages can be grouped into containers, connected with arrows, and annotated with metadata and color-coded tag groups.
-
-## Syntax
-
-```
-sitemap Site Title
-
-Page Name
-  Child Page
-    Grandchild Page
-```
-
-## Settings
-
-| Key            | Description                                   | Default  |
-| -------------- | --------------------------------------------- | -------- |
-| `chart`        | Must be `sitemap`                             | —        |
-| `title`        | Diagram title                                 | None     |
-| `direction-tb` | Top-to-bottom layout (omit for left-to-right) | off (LR) |
-| `hide`         | Comma-separated metadata to hide              | None     |
-
-## Pages
-
-Each line of text creates a page node. Indentation creates child pages:
-
-```
-Home
-  About
-  Products
-    Enterprise
-    Starter
-  Contact
-```
-
-## Groups (Containers)
-
-Use `[Group Name]` to create a visual container that groups its children:
-
-```
-Home
-  [Product Section]
-    Products
-    Pricing
-    Demo
-
-  [Support Section]
-    Help Center
-    Documentation
-```
-
-Containers render as labeled boxes. They can have their own metadata.
-
-## Arrows
-
-Add arrows between pages using `->` syntax indented under a page:
-
-```
-Home
-  -> Products
-  -explore-> Blog
-Products
-  Pricing
-    -upgrade(green)-> Enterprise
-```
-
-- `-> Target` — plain arrow
-- `-label-> Target` — labeled arrow
-- `-label(color)-> Target` — labeled and colored arrow
-
-## Metadata
-
-Add key-value pairs indented under a page:
-
-```
-Home
-  status: Live
-  owner: Marketing
-
-Products
-  status: Draft
-  owner: Product Team
-```
-
-Metadata renders as secondary text on the page card.
-
-### Pipe Syntax
-
-For concise entries, use `|` to put metadata on a single line:
-
-```
-Home | status: Live | owner: Marketing
-Products | status: Draft | owner: Product Team
-```
-
-## Descriptions
-
-Add a description to any page using the `description` keyword (indented) or pipe metadata:
-
-```
-// Pipe metadata form
-Pricing | description: Compare plans and features
-
-// Indented keyword form (colon optional)
-Dashboard
-  description Full overview of crew activity and orders
-  My Orders
-```
-
-Descriptions render as secondary text on the page card. The indented form must come before child pages. Multiple `description` lines accumulate into a multi-line description.
-
-## Node Colors
-
-Add a color name in parentheses after a page or group name:
-
-```
-Home(blue)
-[Admin Section(red)]
-  Dashboard
-  Settings
-```
-
-## Tag Groups
-
-Define color-coded tags for metadata values. Tag groups must appear before page content:
-
-```
-sitemap Company Site
-
-tag Status
-  Live(green)
-  Draft(yellow)
-  Deprecated(red)
-
-tag Owner
-  Marketing(blue)
-  Engineering(purple)
-
-Home
-  status: Live
-  owner: Marketing
-```
-
-- `tag GroupName` starts a tag group
-- When a tag group is active, pages are colored by their matching tag value
-- Click a tag group pill to activate it; click the eye icon to toggle that metadata's visibility on cards
-
-## Direction
-
-The default layout is left-to-right. Add `direction-tb` to switch to top-to-bottom:
-
-```
-sitemap
-direction-tb
-```
-
-## Collapse / Expand
-
-In the app, click a page or group that has children to focus it. Click again to collapse its subtree — a "+N" label shows how many nodes are hidden. Click once more to expand.
-
-Keyboard: Tab to focus a node, Enter or Space to toggle.
-
-## Comments
-
-```
-// This line is ignored by the parser
-```
-
-## Complete Example
-
-```dgmo
-sitemap The Salty Compass
-
-tag Auth
-  Public(green)
-  Crew Only(blue)
-
-tag Status
-  Live(cyan)
-  Coming Soon(yellow)
-
-Home | Auth: Public | Status: Live
-  -shop-> Shop
-  -voyages-> Upcoming Voyages
-  -join crew-> Sign Up
-  -sign in-> Login
-
-[Ship Store]
-  Shop | Auth: Public | Status: Live
-    -> Eye Patches
-    -> Flags & Banners
-  Eye Patches | Auth: Public | Status: Live
-    -add to chest-> Cart
-  Flags & Banners | Auth: Public | Status: Coming Soon
-    -add to chest-> Cart
-  Cart | Auth: Public | Status: Live
-    -checkout-> Checkout
-  Checkout | Auth: Crew Only | Status: Live
-    -done-> My Orders
-
-[Voyages]
-  Upcoming Voyages | Auth: Public | Status: Live
-    -details-> Voyage Detail
-  Voyage Detail | Auth: Public | Status: Live
-    -enlist-> Sign Up
-
-[Crew Quarters]
-  Login | Auth: Public | Status: Live
-    -welcome aboard-> Dashboard
-    -new pirate-> Sign Up
-  Sign Up | Auth: Public | Status: Live
-    -welcome aboard-> Dashboard
-  Dashboard | Auth: Crew Only | Status: Live
-    -> My Orders
-  My Orders | Auth: Crew Only | Status: Live
-    -reorder-> Shop
-```

package/docs/guide/chart-slope.md

@@ -1,56 +0,0 @@
-# Slope Chart
-
-```dgmo
-slope Pirate Fleet Strength: 1715 vs 1725
-
-period 1715 1725
-
-Blackbeard 40 4
-Bartholomew Roberts 12 52
-Charles Vane 20 2
-Anne Bonny 8 15
-Calico Jack 18 6
-```
-
-## Syntax
-
-```
-slope Chart Title
-
-period Period1 Period2
-
-Label value1 value2
-```
-
-For multi-token period labels, use an indented block:
-
-```
-period
-  Before COVID
-  After COVID
-```
-
-## Data Format
-
-The `period` directive defines the period labels (minimum 2 required). Data rows are space-separated with no colons:
-
-```
-period 2020 2025
-
-Product A 40 80
-Product B 70 30
-```
-
-Lines slope upward for increases and downward for decreases.
-
-## Color Annotations
-
-Add `(color)` after the label to set a custom color:
-
-```
-Python (blue) 3 1 1
-```
-
-## Thousands Commas
-
-Values can contain thousands commas: `Revenue 1,000 2,500`