umlimator 0.18.0 → 0.20.0

package/lib/umlimator.schema.json

@@ -419,7 +419,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.",
+     "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.",
      "examples": [
       "uml.Class",
       "uml.Interface",
@@ -427,14 +427,16 @@
       "uml.DataType",
       "uml.PrimitiveType",
       "uml.Package",
-      "uml.Comment"
+      "uml.Comment",
+      "uml.InstanceSpecification",
+      "uml.Lifeline"
      ]
     },
     "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). From 0.19.0 a class, object or package view draws a shown package that owns something it shows as a box holding it."
     },
     "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).",
+     "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).",
      "anyOf": [
       {
        "type": "object",
@@ -444,6 +446,12 @@
         },
         "stereotypes": {
          "description": "Any UML element: names drawn «in guillemets», as text (['entity'])."
+        },
+        "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)."
         }
        }
       },
@@ -451,7 +459,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).",
+     "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.",
      "anyOf": [
       {
        "type": "array",
@@ -465,10 +473,10 @@
             "description": "Unique among every node, edge and member of the model."
            },
            "type": {
-            "description": "uml.Property, uml.Operation or uml.EnumerationLiteral in a class diagram."
+            "description": "uml.Property, uml.Operation or uml.EnumerationLiteral in a class diagram; uml.Slot in an object diagram."
            },
            "label": {
-            "description": "The member's name; the rest of its UML text is in props."
+            "description": "The member's name (a slot's: the feature it gives a value); the rest of its UML text is in props."
            },
            "props": {
             "description": "The member's UML text as fields: + {static} /total: Money [1] = 0.",
@@ -505,6 +513,9 @@
                },
                "returnType": {
                 "description": "uml.Operation: its return type, as text."
+               },
+               "value": {
+                "description": "uml.Slot: its value, as text (34.00 EUR); left out, the slot is drawn by its feature's name."
                }
               }
              },
@@ -807,26 +818,31 @@
      "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).",
+     "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.",
      "examples": [
       "uml.Association",
       "uml.Generalization",
       "uml.InterfaceRealization",
       "uml.Dependency",
-      "uml.CommentLink"
+      "uml.CommentLink",
+      "uml.Link",
+      "uml.PackageImport",
+      "uml.PackageMerge",
+      "uml.Message",
+      "uml.Connector"
      ]
     },
     "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).",
+     "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.",
      "anyOf": [
       {
        "type": "object",
        "properties": {
         "ends": {
-         "description": "uml.Association: { from, to }, each end's role, multiplicity, aggregation and navigability.",
+         "description": "uml.Association: { from, to }, each end's role, multiplicity, aggregation and navigability. uml.Link: each end's role.",
          "anyOf": [
           {
            "type": "object",
@@ -884,6 +900,25 @@
         },
         "stereotypes": {
          "description": "Any UML element: names drawn «in guillemets», as text (['entity'])."
+        },
+        "association": {
+         "description": "uml.Link: the name of the association it is an instance of, as text; drawn on the line when the link has no label."
+        },
+        "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."
         }
        }
       },
@@ -969,7 +1004,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": [
        {
@@ -977,6 +1012,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."
        }
       ]
      }
@@ -1130,16 +1208,20 @@
      "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); 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); a type this release does not draw is drawn as plain cards, with a warning.",
      "examples": [
-      "uml.class"
+      "uml.class",
+      "uml.object",
+      "uml.package",
+      "uml.sequence",
+      "uml.communication"
      ]
     },
     "subject": {
-     "description": "Schema version 2: the element this diagram is the inside of."
+     "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)."
@@ -1171,7 +1253,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.18.0",
+  "version": "0.20.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/",