umlimator 0.19.0 → 0.21.0

package/lib/umlimator.schema.json

@@ -23,14 +23,6 @@
    "type": "string",
    "description": "The view shown first (default: the view with no parent)."
   },
-  "shapes": {
-   "enum": [
-    "box",
-    "c4",
-    "uml"
-   ],
-   "description": "The notation every view's cards are (a view's own wins) is drawn in (0.15.0): box (every card a rounded box, the default), c4 (people, browser apps, phones, databases, queues and files as the C4 model's tools draw them) or uml (UML 2.5's actor, node, artifact, package and data store, and the component icon on a box)."
-  },
   "nodes": {
    "type": "array",
    "items": {
@@ -311,7 +303,7 @@
       "folder",
       "node"
      ],
-     "description": "The card's own shape, in every notation (0.15.0): box, person, browser, mobile, cylinder, pipe, document, hexagon, robot, terminal, window, folder or node. Without it the notation draws the card by its kind."
+     "description": "The card's own shape (0.15.0): box, person, browser, mobile, cylinder, pipe, document, hexagon, robot, terminal, window, folder or node. Without it a map draws the card by its kind (a rounded box where no shape says more)."
     },
     "noSub": {
      "type": "boolean",
@@ -319,7 +311,7 @@
     },
     "opensView": {
      "type": "string",
-     "description": "The view the card opens. It may name a view the host loads only when it is opened."
+     "description": "The view the card opens. It may name a view the host loads only when it is opened. Schema version 2: the view a call behaviour action (an activity view), an interaction use or an inline interaction (a uml.sequence view) opens (0.21.0)."
     },
     "opensCount": {
      "type": "integer",
@@ -419,7 +411,7 @@
      }
     },
     "type": {
-     "description": "Schema version 2: the element's type, <notation>.<Name> (uml.Class). validate() checks typed fields only in a model with schemaVersion 2. The class diagram (uml.class, 0.18.0): uml.Class, uml.Interface, uml.Enumeration, uml.DataType, uml.PrimitiveType, uml.Package and uml.Comment; their members uml.Property, uml.Operation and uml.EnumerationLiteral. The object diagram (uml.object, 0.19.0): uml.InstanceSpecification and uml.Comment; an instance's members uml.Slot. The package diagram (uml.package, 0.19.0): uml.Package and the class diagram's classifiers, and uml.Comment.",
+     "description": "Schema version 2: the element's type, <notation>.<Name> (uml.Class). validate() checks typed fields only in a model with schemaVersion 2. The class diagram (uml.class, 0.18.0): uml.Class, uml.Interface, uml.Enumeration, uml.DataType, uml.PrimitiveType, uml.Package and uml.Comment; their members uml.Property, uml.Operation and uml.EnumerationLiteral. The object diagram (uml.object, 0.19.0): uml.InstanceSpecification and uml.Comment; an instance's members uml.Slot. The package diagram (uml.package, 0.19.0): uml.Package and the class diagram's classifiers, and uml.Comment. The sequence and communication diagrams (uml.sequence, uml.communication, 0.20.0): uml.Lifeline. The use case diagram (uml.use-case, 0.21.0): uml.Actor, uml.UseCase, uml.Subject and uml.Comment; a use case's members uml.ExtensionPoint. The activity diagram (uml.activity, 0.21.0): uml.InitialNode, uml.ActivityFinalNode, uml.FlowFinalNode, uml.Action, uml.CallBehaviorAction, uml.SendSignalAction, uml.AcceptEventAction, uml.DecisionNode, uml.MergeNode, uml.ForkNode, uml.JoinNode, uml.ObjectNode, uml.DataStoreNode, uml.ActivityPartition and uml.Comment. The state machine diagram (uml.state-machine, 0.21.0): uml.State, uml.Pseudostate, uml.FinalState and uml.Comment; a state's members uml.Region and uml.InternalTransition. The interaction overview diagram (uml.interaction-overview, 0.21.0): the activity's control nodes, uml.InteractionUse, uml.Interaction (an inline interaction) and uml.Comment.",
      "examples": [
       "uml.Class",
       "uml.Interface",
@@ -428,14 +420,26 @@
       "uml.PrimitiveType",
       "uml.Package",
       "uml.Comment",
-      "uml.InstanceSpecification"
+      "uml.InstanceSpecification",
+      "uml.Lifeline",
+      "uml.Actor",
+      "uml.UseCase",
+      "uml.Subject",
+      "uml.Action",
+      "uml.DecisionNode",
+      "uml.ActivityPartition",
+      "uml.State",
+      "uml.Pseudostate",
+      "uml.FinalState",
+      "uml.InteractionUse",
+      "uml.Interaction"
      ]
     },
     "parent": {
-     "description": "Schema version 2: the element that owns it (a package, a composite state, a lane). From 0.19.0 a class, object or package view draws a shown package that owns something it shows as a box holding it."
+     "description": "Schema version 2: the element that owns it (a package, a composite state, a lane). From 0.19.0 a class, object or package view draws a shown package that owns something it shows as a box holding it. A use case's: a subject or a package. An activity node's: its partition (lane); a partition's: the partition it is nested in. A substate's or pseudostate's: a state, or a region (a member) of one."
     },
     "props": {
-     "description": "Schema version 2: the type's own properties. The class diagram (uml.class, 0.18.0): isAbstract and stereotypes on a classifier; on a member, the fields of its UML text (docs/conformance/uml-class.md). The object diagram (uml.object, 0.19.0): an instance's classifier and stereotypes; a slot's value (docs/conformance/uml-object.md).",
+     "description": "Schema version 2: the type's own properties. The class diagram (uml.class, 0.18.0): isAbstract and stereotypes on a classifier; on a member, the fields of its UML text (docs/conformance/uml-class.md). The object diagram (uml.object, 0.19.0): an instance's classifier and stereotypes; a slot's value (docs/conformance/uml-object.md). The sequence and communication diagrams (uml.sequence, uml.communication, 0.20.0): a lifeline's represents, and stereotypes (actor draws «actor» over its name). The state machine diagram (uml.state-machine, 0.21.0): a state's entry, do and exit, a pseudostate's kind (docs/conformance/uml-state-machine.md).",
      "anyOf": [
       {
        "type": "object",
@@ -448,6 +452,31 @@
         },
         "classifier": {
          "description": "uml.InstanceSpecification: the name (or qualified name, sales::Order) of the classifier it is an instance of, as text; drawn name : Classifier, underlined."
+        },
+        "represents": {
+         "description": "uml.Lifeline: what it is an instance of, by name, as text; drawn name : Type (docs/diagrams/risks.md M8)."
+        },
+        "entry": {
+         "description": "uml.State: its entry activity, as text; drawn as the row entry / text."
+        },
+        "do": {
+         "description": "uml.State: its do activity, as text; drawn as the row do / text."
+        },
+        "exit": {
+         "description": "uml.State: its exit activity, as text; drawn as the row exit / text."
+        },
+        "kind": {
+         "description": "uml.Pseudostate: which pseudostate it is; any other is drawn as a junction, with a warning.",
+         "examples": [
+          "initial",
+          "choice",
+          "junction",
+          "fork",
+          "join",
+          "shallowHistory",
+          "deepHistory",
+          "terminate"
+         ]
         }
        }
       },
@@ -455,7 +484,7 @@
      ]
     },
     "members": {
-     "description": "Schema version 2: owned parts, in display order (attributes, ports, regions, lanes), each a typed element. The class diagram (uml.class, 0.18.0): a classifier's attributes (uml.Property) and operations (uml.Operation), an enumeration's literals (uml.EnumerationLiteral). The object diagram (uml.object, 0.19.0): an instance's slots (uml.Slot), each a feature = value row.",
+     "description": "Schema version 2: owned parts, in display order (attributes, ports, regions, lanes), each a typed element. The class diagram (uml.class, 0.18.0): a classifier's attributes (uml.Property) and operations (uml.Operation), an enumeration's literals (uml.EnumerationLiteral). The object diagram (uml.object, 0.19.0): an instance's slots (uml.Slot), each a feature = value row. The use case diagram (uml.use-case, 0.21.0): a use case's extension points (uml.ExtensionPoint, by name). The state machine diagram (uml.state-machine, 0.21.0): a state's regions (uml.Region, by name) and internal transitions (uml.InternalTransition, trigger [guard] / effect).",
      "anyOf": [
       {
        "type": "array",
@@ -469,7 +498,7 @@
             "description": "Unique among every node, edge and member of the model."
            },
            "type": {
-            "description": "uml.Property, uml.Operation or uml.EnumerationLiteral in a class diagram; uml.Slot in an object diagram."
+            "description": "uml.Property, uml.Operation or uml.EnumerationLiteral in a class diagram; uml.Slot in an object diagram. uml.ExtensionPoint in a use case diagram; uml.Region or uml.InternalTransition in a state machine diagram."
            },
            "label": {
             "description": "The member's name (a slot's: the feature it gives a value); the rest of its UML text is in props."
@@ -512,6 +541,15 @@
                },
                "value": {
                 "description": "uml.Slot: its value, as text (34.00 EUR); left out, the slot is drawn by its feature's name."
+               },
+               "trigger": {
+                "description": "uml.InternalTransition: what triggers it, as text (a trigger list, after 30 days)."
+               },
+               "guard": {
+                "description": "uml.InternalTransition: its guard, as text, drawn [in brackets]."
+               },
+               "effect": {
+                "description": "uml.InternalTransition: its effect, as text, drawn after /."
                }
               }
              },
@@ -556,7 +594,7 @@
       "folder",
       "node"
      ],
-     "description": "The card's own shape, in every notation (0.15.0): box, person, browser, mobile, cylinder, pipe, document, hexagon, robot, terminal, window, folder or node. Without it the notation draws the card by its kind."
+     "description": "The card's own shape (0.15.0): box, person, browser, mobile, cylinder, pipe, document, hexagon, robot, terminal, window, folder or node. Without it a map draws the card by its kind (a rounded box where no shape says more)."
     },
     "sublabel": {
      "type": "string",
@@ -814,7 +852,7 @@
      "description": "When the line is used."
     },
     "type": {
-     "description": "Schema version 2: the element's type, <notation>.<Name> (uml.Class). The class diagram (uml.class, 0.18.0): uml.Association, uml.Generalization (from the specific to the general), uml.InterfaceRealization (to the interface), uml.Dependency (from the client) and uml.CommentLink (from the comment). The object diagram (uml.object, 0.19.0): uml.Link and uml.CommentLink. The package diagram (uml.package, 0.19.0): uml.PackageImport and uml.PackageMerge (from the importing or merging package), uml.Dependency and uml.CommentLink.",
+     "description": "Schema version 2: the element's type, <notation>.<Name> (uml.Class). The class diagram (uml.class, 0.18.0): uml.Association, uml.Generalization (from the specific to the general), uml.InterfaceRealization (to the interface), uml.Dependency (from the client) and uml.CommentLink (from the comment). The object diagram (uml.object, 0.19.0): uml.Link and uml.CommentLink. The package diagram (uml.package, 0.19.0): uml.PackageImport and uml.PackageMerge (from the importing or merging package), uml.Dependency and uml.CommentLink. The sequence diagram (uml.sequence, 0.20.0): uml.Message, inline in its view's edges, in time order. The communication diagram (uml.communication, 0.20.0): uml.Connector and uml.Message, model lines its view lists, connectors first; only the messages' order means anything. The use case diagram (uml.use-case, 0.21.0): uml.Association (an actor and a use case), uml.Include and uml.Extend (from the including or extending use case), uml.Generalization (from the specific to the general) and uml.CommentLink. The activity diagram (uml.activity, 0.21.0): uml.ControlFlow, uml.ObjectFlow and uml.CommentLink. The state machine diagram (uml.state-machine, 0.21.0): uml.Transition and uml.CommentLink. The interaction overview diagram (uml.interaction-overview, 0.21.0): uml.ControlFlow and uml.CommentLink.",
      "examples": [
       "uml.Association",
       "uml.Generalization",
@@ -823,14 +861,21 @@
       "uml.CommentLink",
       "uml.Link",
       "uml.PackageImport",
-      "uml.PackageMerge"
+      "uml.PackageMerge",
+      "uml.Message",
+      "uml.Connector",
+      "uml.Include",
+      "uml.Extend",
+      "uml.ControlFlow",
+      "uml.ObjectFlow",
+      "uml.Transition"
      ]
     },
     "parent": {
-     "description": "Schema version 2: the element that owns it (a package, a composite state, a lane)."
+     "description": "Schema version 2: the element that owns it (a package, a composite state, a lane). In a sequence view: the operand (uml.InteractionOperand) of one of its fragments that holds the message; none at the top level."
     },
     "props": {
-     "description": "Schema version 2: the type's own properties. The class diagram (uml.class, 0.18.0): an association's ends, and stereotypes on any line («use» on a dependency). The object diagram (uml.object, 0.19.0): a link's association and the roles at its ends. The package diagram (uml.package, 0.19.0): a package import's visibility.",
+     "description": "Schema version 2: the type's own properties. The class diagram (uml.class, 0.18.0): an association's ends, and stereotypes on any line («use» on a dependency). The object diagram (uml.object, 0.19.0): a link's association and the roles at its ends. The package diagram (uml.package, 0.19.0): a package import's visibility. The sequence and communication diagrams (0.20.0): a message's sort and replyTo. The use case diagram (0.21.0): an extend's extensionPoints and condition. The activity and interaction overview diagrams (0.21.0): a flow's guard (its label is its name). The state machine diagram (0.21.0): a transition's trigger, guard and effect, drawn trigger [guard] / effect.",
      "anyOf": [
       {
        "type": "object",
@@ -900,6 +945,34 @@
         },
         "visibility": {
          "description": "uml.PackageImport: public (the default, drawn «import») or private (drawn «access»)."
+        },
+        "sort": {
+         "description": "uml.Message: call (the default), async, reply, create or delete; any other is drawn as a call, with a warning.",
+         "examples": [
+          "call",
+          "async",
+          "reply",
+          "create",
+          "delete"
+         ]
+        },
+        "replyTo": {
+         "description": "uml.Message, a reply: the id of the earlier call it answers, which it goes back along."
+        },
+        "extensionPoints": {
+         "description": "uml.Extend: the ids of the extension points (uml.ExtensionPoint members) of the use case it extends, at least one; drawn by name."
+        },
+        "condition": {
+         "description": "uml.Extend: when it extends, as text; drawn [in brackets] after its points."
+        },
+        "guard": {
+         "description": "uml.ControlFlow, uml.ObjectFlow, uml.Transition: its guard, as text, drawn [in brackets]; else is drawn [else]."
+        },
+        "trigger": {
+         "description": "uml.Transition: what triggers it, as text (M8: no event is parsed)."
+        },
+        "effect": {
+         "description": "uml.Transition: its effect, as text, drawn after /."
         }
        }
       },
@@ -985,7 +1058,7 @@
     },
     "edges": {
      "type": "array",
-     "description": "The lines this view draws: model line ids or lines of its own. Default: every model line between its cards; [] draws none.",
+     "description": "The lines this view draws: model line ids or lines of its own. Default: every model line between its cards; [] draws none. In a sequence view (uml.sequence, 0.20.0): its occurrences in time order, each message and interaction use inline, a fragment's operand by operand.",
      "items": {
       "anyOf": [
        {
@@ -993,6 +1066,49 @@
        },
        {
         "$ref": "#/$defs/edge"
+       },
+       {
+        "type": "object",
+        "required": [
+         "id",
+         "type"
+        ],
+        "properties": {
+         "type": {
+          "const": "uml.InteractionUse"
+         },
+         "label": {
+          "description": "The interaction it refers to, by name."
+         },
+         "parent": {
+          "description": "The operand (uml.InteractionOperand) that holds it; none at the top level."
+         },
+         "props": {
+          "properties": {
+           "covers": {
+            "description": "The ids of the lifelines it spans, next to each other in the view's nodeIds."
+           },
+           "refersTo": {
+            "description": "The id of the view it refers to."
+           }
+          }
+         }
+        },
+        "not": {
+         "anyOf": [
+          {
+           "required": [
+            "from"
+           ]
+          },
+          {
+           "required": [
+            "to"
+           ]
+          }
+         ]
+        },
+        "description": "Schema version 2: an occurrence of a sequence view that is not a line: an interaction use (uml.InteractionUse), its label the interaction it refers to, props.covers the lifelines it spans (next to each other in nodeIds), props.refersTo a view's id, parent its operand."
        }
       ]
      }
@@ -1133,31 +1249,29 @@
      "type": "boolean",
      "description": "Cards 80 px tall that show their sub-line, then their chips."
     },
-    "shapes": {
-     "enum": [
-      "box",
-      "c4",
-      "uml"
-     ],
-     "description": "The notation this view's cards are is drawn in (0.15.0): box (every card a rounded box, the default), c4 (people, browser apps, phones, databases, queues and files as the C4 model's tools draw them) or uml (UML 2.5's actor, node, artifact, package and data store, and the component icon on a box)."
-    },
     "kindsFromLabels": {
      "type": "boolean",
      "description": "Guess a line's kind from its label's words when its edges name none (render() and layout(); the standalone page always does)."
     },
     "diagram": {
-     "description": "Schema version 2: the view's diagram type; without it the view is a map. uml.class draws a class diagram (0.18.0, lib/umlimator-all.js), uml.object an object diagram and uml.package a package diagram (0.19.0); a type this release does not draw is drawn as plain cards, with a warning.",
+     "description": "Schema version 2: the view's diagram type; without it the view is a map. uml.class draws a class diagram (0.18.0, lib/umlimator-all.js), uml.object an object diagram and uml.package a package diagram (0.19.0), uml.sequence a sequence diagram and uml.communication a communication diagram (0.20.0), uml.use-case a use case diagram, uml.activity an activity diagram, uml.state-machine a state machine diagram and uml.interaction-overview an interaction overview diagram (0.21.0); a type this release does not draw is drawn as plain cards, with a warning.",
      "examples": [
       "uml.class",
       "uml.object",
-      "uml.package"
+      "uml.package",
+      "uml.sequence",
+      "uml.communication",
+      "uml.use-case",
+      "uml.activity",
+      "uml.state-machine",
+      "uml.interaction-overview"
      ]
     },
     "subject": {
      "description": "Schema version 2: the element this diagram is the inside of. In a class, object or package view, the package names are qualified from (sales::Order without sales:: in a view of sales); not drawn unless the view lists it."
     },
     "direction": {
-     "description": "Schema version 2: a typed view's layout direction (default right). A map stays left to right."
+     "description": "Schema version 2: a typed view's layout direction (default right). A map stays left to right. A sequence view is always down; another direction is a warning."
     },
     "notation": {
      "description": "Schema version 2: a skin of the diagram type (crowsfoot for er)."
@@ -1174,7 +1288,7 @@
           "type": "object",
           "properties": {
            "collapsed": {
-            "description": "Compartments not drawn, divider and all: ['attributes', 'operations'] (an enumeration's: 'literals')."
+            "description": "Compartments not drawn, divider and all: ['attributes', 'operations'] (an enumeration's: 'literals'); a state's: 'activities' (its entry, do and exit and internal transitions, 0.21.0)."
            },
            "rows": {
             "description": "At most this many rows in each compartment, then \"+k more\"."
@@ -1189,7 +1303,48 @@
      ]
     },
     "fragments": {
-     "description": "Schema version 2: a sequence view's combined fragments and interaction uses."
+     "description": "Schema version 2: a sequence view's combined fragments (uml.CombinedFragment, props.operator alt, opt, loop, par or break), outermost first; each one's members are its operands (uml.InteractionOperand, label the guard) in order, and its parent is the operand that holds it (uml.sequence, 0.20.0).",
+     "items": {
+      "properties": {
+       "type": {
+        "examples": [
+         "uml.CombinedFragment"
+        ]
+       },
+       "parent": {
+        "description": "The operand (uml.InteractionOperand) that holds it; none at the top level."
+       },
+       "props": {
+        "properties": {
+         "operator": {
+          "description": "The fragment's operator; any other is a warning.",
+          "examples": [
+           "alt",
+           "opt",
+           "loop",
+           "par",
+           "break"
+          ]
+         }
+        }
+       },
+       "members": {
+        "description": "Its operands, in order.",
+        "items": {
+         "properties": {
+          "type": {
+           "examples": [
+            "uml.InteractionOperand"
+           ]
+          },
+          "label": {
+           "description": "The operand's guard."
+          }
+         }
+        }
+       }
+      }
+     }
     },
     "timeline": {
      "description": "Schema version 2: a timing view's unit, changes and constraints."

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umlimator",
-  "version": "0.19.0",
+  "version": "0.21.0",
   "description": "Embeddable, layered architecture maps: layout, orthogonal routing and an interactive canvas in one ES module.",
   "keywords": ["architecture", "diagram", "c4", "map", "svg", "layout", "orthogonal-routing", "drill-down"],
   "homepage": "https://zintaen.github.io/umlimator/",
@@ -12,6 +12,6 @@
     "./all": { "types": "./lib/umlimator.d.ts", "default": "./lib/umlimator-all.js" },
     "./element": "./lib/umlimator-element.js", "./markdown-it": "./lib/umlimator-markdown-it.js", "./remark": "./lib/umlimator-remark.js" },
   "files": ["lib/", "LICENSE", "THIRD_PARTY_NOTICES.md"],
-  "scripts": { "test": "node --test", "build": "node tools/build.mjs" },
+  "scripts": { "test": "node --test --test-skip-pattern=\"\\(timed\\)\" && node --test --test-concurrency=1 --test-name-pattern=\"\\(timed\\)\"", "build": "node tools/build.mjs" },
   "engines": { "node": ">=18" }
 }