umlimator 0.17.0 → 0.19.0

package/lib/umlimator.d.ts

@@ -48,11 +48,57 @@ export interface MapNode {
 /** A typed element in schema version 2's envelope (docs/diagrams/model.md §1): a node, a member, a typed edge, a
  *  fragment. Nodes, edges, members and fragments share one id space; an id never contains "->". A typed edge is an
  *  Element with `from` and `to`, which may name a member. A typed view is a MapView with `diagram` (uml.class), and may
- *  have `subject`, `direction` ('right' | 'down'), `notation`, `present`, `fragments` and `timeline`. None is drawn yet. */
+ *  have `subject`, `direction` ('right' | 'down'), `notation`, `present`, `fragments` and `timeline`. umlimator/all draws `uml.class` (0.18.0), `uml.object` and `uml.package` (0.19.0); other types draw as plain cards.
+ *  From 0.19.0 those three draw a shown package that owns something the view shows as a box holding it (`parent`), and
+ *  qualify names (`sales::Order`) from the nearest shown owner, the view's `subject`, or the top. */
 export interface Element {
   id: string; type: string; label?: string; parent?: string; props?: Record<string, unknown>; members?: Element[];
   [key: string]: unknown;
 }
+/** The class diagram's vocabulary (a view with `diagram: 'uml.class'`, drawn by umlimator/all from 0.18.0;
+ *  docs/conformance/uml-class.md). These describe what `type` and `props` hold; validate() reports what breaks the type's
+ *  rules, and a field written otherwise is kept as it is. */
+export type UmlClassElementType = 'uml.Class' | 'uml.Interface' | 'uml.Enumeration' | 'uml.DataType' | 'uml.PrimitiveType' | 'uml.Package' | 'uml.Comment';
+export type UmlClassMemberType = 'uml.Property' | 'uml.Operation' | 'uml.EnumerationLiteral';
+/** From the client to the supplier: a generalization from the specific to the general, a realization to the interface,
+ *  a comment link from the comment. */
+export type UmlClassLineType = 'uml.Association' | 'uml.Generalization' | 'uml.InterfaceRealization' | 'uml.Dependency' | 'uml.CommentLink';
+export type UmlVisibility = 'public' | 'private' | 'protected' | 'package';
+/** A classifier's or a package's props. Stereotypes are drawn «in guillemets»; any UML element or line may have them. */
+export interface UmlClassifierProps { isAbstract?: boolean; stereotypes?: string[]; [key: string]: unknown }
+/** An attribute's props: its UML text `+ {static} /total: Money [1] = 0` as fields. Types and defaults are text. */
+export interface UmlPropertyProps { visibility?: UmlVisibility; valueType?: string; multiplicity?: string; default?: string; isStatic?: boolean; isDerived?: boolean; stereotypes?: string[]; [key: string]: unknown }
+/** An operation's props: `+ {static} place(at: Date, in qty: Int): Order` as fields. */
+export interface UmlOperationProps {
+  visibility?: UmlVisibility; parameters?: { name: string; valueType?: string; direction?: 'in' | 'out' | 'inout' | 'return' }[];
+  returnType?: string; isStatic?: boolean; isAbstract?: boolean; stereotypes?: string[]; [key: string]: unknown;
+}
+/** One end of an association. A multiplicity is 1, *, n..m or n..*, kept as written; a composite end's is at most 1. */
+export interface UmlAssociationEnd { role?: string; multiplicity?: string; aggregation?: 'none' | 'shared' | 'composite'; navigable?: boolean }
+/** A line's props: an association's two ends, and stereotypes («use» on a dependency). */
+export interface UmlLineProps { ends?: { from?: UmlAssociationEnd; to?: UmlAssociationEnd }; stereotypes?: string[]; [key: string]: unknown }
+/** The object diagram's vocabulary (a view with `diagram: 'uml.object'`, umlimator/all from 0.19.0;
+ *  docs/conformance/uml-object.md). An instance with no `label` is anonymous (drawn `: Order`); a slot's `label` is the
+ *  feature it gives a value. A classifier node an object view shows is drawn as in a class view. */
+export type UmlObjectElementType = 'uml.InstanceSpecification' | 'uml.Package' | 'uml.Comment';
+export type UmlObjectMemberType = 'uml.Slot';
+export type UmlObjectLineType = 'uml.Link' | 'uml.CommentLink';
+/** An instance's props: its classifier by name or qualified name, as text (docs/diagrams/risks.md M8). */
+export interface UmlInstanceProps { classifier?: string; stereotypes?: string[]; [key: string]: unknown }
+/** A slot's props: its value as text; with none, the slot is drawn by its feature alone. */
+export interface UmlSlotProps { value?: string; [key: string]: unknown }
+/** A link's props: the association it is an instance of, by name, and the roles at its ends. */
+export interface UmlLinkProps { association?: string; ends?: { from?: { role?: string }; to?: { role?: string } }; stereotypes?: string[]; [key: string]: unknown }
+/** The package diagram's vocabulary (a view with `diagram: 'uml.package'`, umlimator/all from 0.19.0;
+ *  docs/conformance/uml-package.md): packages and the class diagram's classifiers, drawn by their names. An import or
+ *  a merge runs from the importing or merging package. */
+export type UmlPackageElementType = 'uml.Package' | 'uml.Class' | 'uml.Interface' | 'uml.Enumeration' | 'uml.DataType' | 'uml.PrimitiveType' | 'uml.Comment';
+export type UmlPackageLineType = 'uml.PackageImport' | 'uml.PackageMerge' | 'uml.Dependency' | 'uml.CommentLink';
+/** A package import's props: public (the default) is drawn «import», private «access». */
+export interface UmlPackageImportProps { visibility?: 'public' | 'private'; stereotypes?: string[]; [key: string]: unknown }
+/** What a typed view shows of one element, in its `present` by the element's id: compartments not drawn, divider and
+ *  all, and at most `rows` rows in each, then "+k more". */
+export interface UmlPresent { collapsed?: ('attributes' | 'operations' | 'literals')[]; rows?: number }
 /** What a line means, drawn as its colour: calls (the default), feeds (hands work on), triggers (suggests, offers, fires),
  *  state (reads or writes a file, board or config: a thinner line, a muted label, no flow) and guard (a hook steps in).
  *  Colours are --um-w-<kind>. An edge's `style` (emphasis, dashed, security) wins over its kind's colour. */
@@ -371,7 +417,9 @@ export function migrate<M extends MapModel>(model: M): M;
 export type Command =
   | { op: 'set'; id: string; path: string | string[]; value: unknown }
   | { op: 'set'; view: string; path: string | string[]; value: unknown }
-  | { op: 'add'; element: { id: string; [key: string]: unknown }; owner?: string; index?: number; view?: string }
+  | { op: 'add'; element: { id: string; [key: string]: unknown }; owner?: string; index?: number; view?: string; in?: 'model' }
+  /** 0.18.0: into the view's own list for its kind: a line or an item in `edges`, a node in `nodes`, else `fragments` */
+  | { op: 'add'; element: { id: string; [key: string]: unknown }; view: string; index?: number; in: 'view'; owner?: never }
   | { op: 'move'; id: string; index: number; owner?: string; view?: never }
   | { op: 'move'; id: string; view: string; index: number; owner?: never }
   | { op: 'hide'; id: string; view: string }
@@ -380,11 +428,13 @@ export type Command =
 /** The model after a transaction: one command, or a list run in order, on a copy (0.17.0). A command that cannot run
  *  throws, and none of the transaction is applied. `delete` takes with it the element's members, what it owns, the lines
  *  to them and every place that names them (references()); one already gone in the same transaction is passed over.
- *  `hide` takes it out of one view with all the view says of it. Undo is the model before: keep it with history(). */
+ *  `hide` takes it out of one view with all the view says of it. Undo is the model before: keep it with history().
+ *  From 0.18.0 `delete` gives what the element held and that stays its nearest owner left, and a diagram type's declared
+ *  references cascade (a reply with its call) or drop (an id out of a list). */
 export function apply<M extends MapModel>(model: M, commands: Command | Command[]): M;
 /** Where a model names an element, other than the element itself (0.17.0): the keys from the model down to the place
  *  (['views', 0, 'nodeIds', 2]) and what it is: 'end', 'parent', 'part', 'view', 'pin', 'present', 'override',
- *  'subject', 'story', 'lens' or 'rule'; later releases may add kinds. */
+ *  'subject', 'story', 'lens', 'rule' or (0.18.0) 'prop', a property a diagram type declares; later releases may add kinds. */
 export interface Reference { path: (string | number)[]; kind: string }
 export function references(model: MapModel, id: string): Reference[];
 /** One issue of the layout check: its message, as the page's check words it, and the cards, lines and boxes it is about