@meltemi/diagrams-edit 1.9.0 → 1.10.0

package/dist/attachments.d.ts

@@ -0,0 +1,30 @@
+import type { Arg, TextEdit } from "@meltemi/diagrams-language";
+import type { Element } from "@meltemi/diagrams-model";
+import { type EditContext, type TextContext } from "./context.js";
+import type { OperationOf } from "./plan.js";
+import type { Dependent } from "./types.js";
+/** The words after the text of a note's declaration: `on` and the target that follows it. */
+export interface AttachmentArgs {
+    /** The argument before `on`: the note's text (or its id when it has none). */
+    readonly before: Arg;
+    readonly word: Arg;
+    readonly target: Arg;
+}
+/** The `on <target>` clause of a note's statement, or undefined when it has none. */
+export declare function attachmentArgs(note: Element): AttachmentArgs | undefined;
+/** The edit that takes ` on <target>` out of a note's statement, keeping its block and comments. */
+export declare function stripAttachment(note: Element): TextEdit | undefined;
+/**
+ * A note attached to something about to go, as a dependent of the removal and the edit that
+ * leaves the note without its clause: a note's text is the person's words, so it stays.
+ */
+export declare function attachmentDependent(ctx: TextContext, note: Element): {
+    dependent: Dependent;
+    edit: TextEdit;
+} | undefined;
+/**
+ * Writes, replaces or removes the `on <element>` clause of a note, in the same declaration and
+ * with the smallest edit: the clause follows the note's text and the block stays where it is.
+ */
+export declare function attachNote(ctx: EditContext, op: OperationOf<"attachNote">): TextEdit[];
+//# sourceMappingURL=attachments.d.ts.map

package/dist/attachments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attachments.d.ts","sourceRoot":"","sources":["../src/attachments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAoB,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAClF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAA0B,KAAK,WAAW,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAG1F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C,6FAA6F;AAC7F,MAAM,WAAW,cAAc;IAC7B,8EAA8E;IAC9E,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC;IACnB,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC;CACtB;AAID,qFAAqF;AACrF,wBAAgB,cAAc,CAAC,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,SAAS,CAOxE;AAED,oGAAoG;AACpG,wBAAgB,eAAe,CAAC,IAAI,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,CAGnE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE,OAAO,GACZ;IAAE,SAAS,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,QAAQ,CAAA;CAAE,GAAG,SAAS,CAatD;AAUD;;;GAGG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,WAAW,CAAC,YAAY,CAAC,GAAG,QAAQ,EAAE,CA+BtF"}

package/dist/attachments.js

@@ -0,0 +1,85 @@
+import { reject, requireElement } from "./context.js";
+import { verifyNoNewErrors } from "./insert.js";
+import { messages, reasons } from "./messages/index.js";
+const isOn = (arg) => arg?.kind === "QualifiedRef" && arg.text === "on";
+/** The `on <target>` clause of a note's statement, or undefined when it has none. */
+export function attachmentArgs(note) {
+    const node = note.node;
+    if (note.kind !== "note" || node?.kind !== "KeywordStatement")
+        return undefined;
+    const args = node.args;
+    const at = args.findIndex((arg, i) => i >= 2 && isOn(arg));
+    const target = args[at + 1];
+    return at < 0 || !target ? undefined : { before: args[at - 1], word: args[at], target };
+}
+/** The edit that takes ` on <target>` out of a note's statement, keeping its block and comments. */
+export function stripAttachment(note) {
+    const clause = attachmentArgs(note);
+    return clause && { start: clause.before.end, end: clause.target.end, newText: "" };
+}
+/**
+ * A note attached to something about to go, as a dependent of the removal and the edit that
+ * leaves the note without its clause: a note's text is the person's words, so it stays.
+ */
+export function attachmentDependent(ctx, note) {
+    const edit = stripAttachment(note);
+    if (!edit || !note.node)
+        return undefined;
+    const lines = ctx.compilation.parse.lines;
+    return {
+        edit,
+        dependent: {
+            kind: "attachment",
+            name: note.id,
+            description: messages().dependents.attachment(note.id, lines.location(note.node.start).line),
+            range: lines.range(note.node),
+        },
+    };
+}
+/** Whether `path` is an element a note of the diagram may be attached to. */
+function attachable(ctx, note, path) {
+    if (path === note.id)
+        return false;
+    const element = ctx.diagram.elementsById.get(path);
+    // A view draws entities, and notes attach to what it draws.
+    return ctx.diagram.type === "c4" ? element?.entity != null : element !== undefined;
+}
+/**
+ * Writes, replaces or removes the `on <element>` clause of a note, in the same declaration and
+ * with the smallest edit: the clause follows the note's text and the block stays where it is.
+ */
+export function attachNote(ctx, op) {
+    const note = requireElement(ctx, op.note);
+    const r = reasons().attach;
+    if (note.kind !== "note" || note.node?.kind !== "KeywordStatement") {
+        reject("edit.invalid-value", r.onlyNotes(note.id, note.kind));
+    }
+    const clause = attachmentArgs(note);
+    const node = note.node;
+    if (op.element === null) {
+        const edit = stripAttachment(note);
+        return edit ? [edit] : [];
+    }
+    if (op.element === note.id)
+        reject("edit.invalid-value", r.self(note.id));
+    if (!attachable(ctx, note, op.element)) {
+        if (ctx.diagram.type === "c4") {
+            reject("edit.unsafe-target", r.notDrawn(op.element, ctx.diagram.id));
+        }
+        requireElement(ctx, op.element);
+    }
+    if (clause?.target.kind === "QualifiedRef" && clause.target.text === op.element)
+        return [];
+    const edits = clause
+        ? [{ start: clause.target.start, end: clause.target.end, newText: op.element }]
+        : [
+            {
+                start: (node.args[1] ?? node.args[0]).end,
+                end: (node.args[1] ?? node.args[0]).end,
+                newText: ` on ${op.element}`,
+            },
+        ];
+    verifyNoNewErrors(ctx, edits);
+    return edits;
+}
+//# sourceMappingURL=attachments.js.map

package/dist/attachments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attachments.js","sourceRoot":"","sources":["../src/attachments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,cAAc,EAAsC,MAAM,cAAc,CAAC;AAC1F,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAYxD,MAAM,IAAI,GAAG,CAAC,GAAoB,EAAW,EAAE,CAAC,GAAG,EAAE,IAAI,KAAK,cAAc,IAAI,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC;AAElG,qFAAqF;AACrF,MAAM,UAAU,cAAc,CAAC,IAAa;IAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IACvB,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,EAAE,IAAI,KAAK,kBAAkB;QAAE,OAAO,SAAS,CAAC;IAChF,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IACvB,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3D,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC5B,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,CAAC,CAAE,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;AAC3F,CAAC;AAED,oGAAoG;AACpG,MAAM,UAAU,eAAe,CAAC,IAAa;IAC3C,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACpC,OAAO,MAAM,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;AACrF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CACjC,GAAgB,EAChB,IAAa;IAEb,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC1C,MAAM,KAAK,GAAG,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC;IAC1C,OAAO;QACL,IAAI;QACJ,SAAS,EAAE;YACT,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE,IAAI,CAAC,EAAE;YACb,WAAW,EAAE,QAAQ,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;YAC5F,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;SAC9B;KACF,CAAC;AACJ,CAAC;AAED,6EAA6E;AAC7E,SAAS,UAAU,CAAC,GAAgB,EAAE,IAAa,EAAE,IAAY;IAC/D,IAAI,IAAI,KAAK,IAAI,CAAC,EAAE;QAAE,OAAO,KAAK,CAAC;IACnC,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACnD,4DAA4D;IAC5D,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,OAAO,KAAK,SAAS,CAAC;AACrF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,GAAgB,EAAE,EAA6B;IACxE,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,CAAC,GAAG,OAAO,EAAE,CAAC,MAAM,CAAC;IAC3B,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,KAAK,kBAAkB,EAAE,CAAC;QACnE,MAAM,CAAC,oBAAoB,EAAE,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAChE,CAAC;IACD,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACpC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAwB,CAAC;IAC3C,IAAI,EAAE,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;QACxB,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5B,CAAC;IACD,IAAI,EAAE,CAAC,OAAO,KAAK,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,oBAAoB,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1E,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;QACvC,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YAC9B,MAAM,CAAC,oBAAoB,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QACvE,CAAC;QACD,cAAc,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IACD,IAAI,MAAM,EAAE,MAAM,CAAC,IAAI,KAAK,cAAc,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC,OAAO;QAAE,OAAO,EAAE,CAAC;IAC3F,MAAM,KAAK,GAAe,MAAM;QAC9B,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC;QAC/E,CAAC,CAAC;YACE;gBACE,KAAK,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAE,CAAC,CAAC,GAAG;gBAC1C,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAE,CAAC,CAAC,GAAG;gBACxC,OAAO,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE;aAC7B;SACF,CAAC;IACN,iBAAiB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC9B,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/c4.d.ts

@@ -2,10 +2,22 @@ import { type Statement, type TextEdit } from "@meltemi/diagrams-language";
 import { type Compilation, type EntityReference, type FlowDiagram, type ModelDefinition } from "@meltemi/diagrams-model";
 import { type EditContext, type TextContext } from "./context.js";
 import { type OperationOf } from "./plan.js";
+/** The operation fields that name the element it acts on. */
+interface ElementTarget {
+    readonly kind: string;
+    readonly element?: string | null;
+    readonly target?: string;
+    readonly targetKind?: string;
+}
 /** Refuses an operation that does not apply to a C4 view, naming the ones that do. */
-export declare function refuseInView(ctx: EditContext, kind: string): void;
+export declare function refuseInView(ctx: EditContext, operation: ElementTarget): void;
 /** Relations of the view that are combinations written in it, not model relations. */
 export declare function isCombination(diagram: FlowDiagram, key: string): boolean;
+/**
+ * Declares a note in a view: after its last note, else after the lists and labels and before the
+ * blocks, where the language keeps what a view says about what it draws.
+ */
+export declare function insertViewNote(ctx: EditContext, text: string): TextEdit;
 export declare function includeEntity(ctx: EditContext, op: OperationOf<"includeEntity">): TextEdit[];
 export declare function excludeEntity(ctx: EditContext, op: OperationOf<"excludeEntity">): TextEdit[];
 export declare function setLocalLabel(ctx: EditContext, op: OperationOf<"setLocalLabel">): TextEdit[];
@@ -24,7 +36,20 @@ export declare function removeEntity(ctx: ModelContext, op: OperationOf<"removeE
 export declare function setEntityProperty(ctx: ModelContext, op: OperationOf<"setEntityProperty">): TextEdit[];
 export declare function createEntity(ctx: ModelContext, op: OperationOf<"createEntity">): TextEdit[];
 export declare function createModelRelation(ctx: ModelContext, op: OperationOf<"createModelRelation">): TextEdit[];
+/** Moves one end of a model relation to another entity; the label, id and block stay. */
+export declare function reconnectModelRelation(ctx: ModelContext, op: OperationOf<"reconnectModelRelation">): TextEdit[];
+/**
+ * The routes of a relation in a view of a file other than the model's, once the model moved one of
+ * its ends (the compilation already resolves the moved model): they follow the end the view
+ * draws now, as `reconnectModelRelation` makes them follow in the model's own file.
+ */
+export declare function rewriteRouteEnd(ctx: EditContext, op: OperationOf<"rewriteRouteEnd">): TextEdit[];
 export declare function removeModelRelation(ctx: ModelContext, op: OperationOf<"removeModelRelation">): TextEdit[];
+/**
+ * Takes a model relation out of a view whose model is in another file: the statements that name
+ * it go (with `cascade`), or are listed as dependents, with the view as drawing it.
+ */
+export declare function forgetModelRelation(ctx: EditContext, op: OperationOf<"forgetModelRelation">): TextEdit[];
 export declare function setModelRelationProperty(ctx: ModelContext, op: OperationOf<"setModelRelationProperty">): TextEdit[];
 export type { Statement };
 //# sourceMappingURL=c4.d.ts.map

package/dist/c4.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"c4.d.ts","sourceRoot":"","sources":["../src/c4.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,KAAK,SAAS,EACd,KAAK,QAAQ,EAEd,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAIL,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,eAAe,EAGrB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAA2B,KAAK,WAAW,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAI3F,OAAO,EAAmB,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AA0B9D,sFAAsF;AACtF,wBAAgB,YAAY,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAGjE;AAQD,sFAAsF;AACtF,wBAAgB,aAAa,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAExE;AAqCD,wBAAgB,aAAa,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,WAAW,CAAC,eAAe,CAAC,GAAG,QAAQ,EAAE,CAuB5F;AAyED,wBAAgB,aAAa,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,WAAW,CAAC,eAAe,CAAC,GAAG,QAAQ,EAAE,CA+B5F;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,WAAW,CAAC,eAAe,CAAC,GAAG,QAAQ,EAAE,CAgC5F;AAID,mEAAmE;AACnE,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAC;CACjC;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,GAAG,YAAY,CAK7E;AAoBD;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,WAAW,EACxB,KAAK,EAAE,eAAe,GACrB,eAAe,EAAE,CAmBnB;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,EAAE,WAAW,CAAC,cAAc,CAAC,GAAG,QAAQ,EAAE,CAqB3F;AAOD,wBAAgB,YAAY,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,EAAE,WAAW,CAAC,cAAc,CAAC,GAAG,QAAQ,EAAE,CAkH3F;AA0CD,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,YAAY,EACjB,EAAE,EAAE,WAAW,CAAC,mBAAmB,CAAC,GACnC,QAAQ,EAAE,CAoDZ;AAUD,wBAAgB,YAAY,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,EAAE,WAAW,CAAC,cAAc,CAAC,GAAG,QAAQ,EAAE,CAyC3F;AAOD,wBAAgB,mBAAmB,CACjC,GAAG,EAAE,YAAY,EACjB,EAAE,EAAE,WAAW,CAAC,qBAAqB,CAAC,GACrC,QAAQ,EAAE,CAuBZ;AAED,wBAAgB,mBAAmB,CACjC,GAAG,EAAE,YAAY,EACjB,EAAE,EAAE,WAAW,CAAC,qBAAqB,CAAC,GACrC,QAAQ,EAAE,CAwBZ;AAED,wBAAgB,wBAAwB,CACtC,GAAG,EAAE,YAAY,EACjB,EAAE,EAAE,WAAW,CAAC,0BAA0B,CAAC,GAC1C,QAAQ,EAAE,CAiEZ;AAED,YAAY,EAAE,SAAS,EAAE,CAAC"}
+{"version":3,"file":"c4.d.ts","sourceRoot":"","sources":["../src/c4.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,KAAK,SAAS,EACd,KAAK,QAAQ,EAEd,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAKL,KAAK,WAAW,EAChB,KAAK,eAAe,EAGpB,KAAK,WAAW,EAChB,KAAK,eAAe,EAIrB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAA2B,KAAK,WAAW,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAK3F,OAAO,EAAmB,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AA6C9D,6DAA6D;AAC7D,UAAU,aAAa;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,sFAAsF;AACtF,wBAAgB,YAAY,CAAC,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,aAAa,GAAG,IAAI,CAS7E;AAQD,sFAAsF;AACtF,wBAAgB,aAAa,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAExE;AA6BD;;;GAGG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,CAEvE;AAUD,wBAAgB,aAAa,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,WAAW,CAAC,eAAe,CAAC,GAAG,QAAQ,EAAE,CAuB5F;AAiFD,wBAAgB,aAAa,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,WAAW,CAAC,eAAe,CAAC,GAAG,QAAQ,EAAE,CA+B5F;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,WAAW,CAAC,eAAe,CAAC,GAAG,QAAQ,EAAE,CAgC5F;AAID,mEAAmE;AACnE,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAC;CACjC;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,GAAG,YAAY,CAK7E;AAoBD;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,WAAW,EACxB,KAAK,EAAE,eAAe,GACrB,eAAe,EAAE,CAmBnB;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,EAAE,WAAW,CAAC,cAAc,CAAC,GAAG,QAAQ,EAAE,CAqB3F;AAOD,wBAAgB,YAAY,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,EAAE,WAAW,CAAC,cAAc,CAAC,GAAG,QAAQ,EAAE,CA0H3F;AA0CD,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,YAAY,EACjB,EAAE,EAAE,WAAW,CAAC,mBAAmB,CAAC,GACnC,QAAQ,EAAE,CAoDZ;AAUD,wBAAgB,YAAY,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,EAAE,WAAW,CAAC,cAAc,CAAC,GAAG,QAAQ,EAAE,CAyC3F;AAOD,wBAAgB,mBAAmB,CACjC,GAAG,EAAE,YAAY,EACjB,EAAE,EAAE,WAAW,CAAC,qBAAqB,CAAC,GACrC,QAAQ,EAAE,CAuBZ;AAED,yFAAyF;AACzF,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,YAAY,EACjB,EAAE,EAAE,WAAW,CAAC,wBAAwB,CAAC,GACxC,QAAQ,EAAE,CAqCZ;AA2ED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,WAAW,CAAC,iBAAiB,CAAC,GAAG,QAAQ,EAAE,CAchG;AAyHD,wBAAgB,mBAAmB,CACjC,GAAG,EAAE,YAAY,EACjB,EAAE,EAAE,WAAW,CAAC,qBAAqB,CAAC,GACrC,QAAQ,EAAE,CAuBZ;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,GAAG,EAAE,WAAW,EAChB,EAAE,EAAE,WAAW,CAAC,qBAAqB,CAAC,GACrC,QAAQ,EAAE,CAkBZ;AAED,wBAAgB,wBAAwB,CACtC,GAAG,EAAE,YAAY,EACjB,EAAE,EAAE,WAAW,CAAC,0BAA0B,CAAC,GAC1C,QAAQ,EAAE,CAiEZ;AAED,YAAY,EAAE,SAAS,EAAE,CAAC"}

package/dist/c4.js

@@ -1,15 +1,20 @@
-import { isIdentifierText, isToken, } from "@meltemi/diagrams-language";
-import { ENTITY_CHILDREN, ENTITY_KINDS, isSafeUrl, } from "@meltemi/diagrams-model";
+import { applyTextEdits, isIdentifierText, isToken, } from "@meltemi/diagrams-language";
+import { ENTITY_CHILDREN, ENTITY_KINDS, defaultEntities, isSafeUrl, compile, singleIdent, } from "@meltemi/diagrams-model";
 import { insertStatement, reject } from "./context.js";
 import { deleteStatements } from "./delete.js";
+import { attachmentDependent } from "./attachments.js";
 import { insertAfter, insertBefore, verifyNoNewErrors } from "./insert.js";
 import { messages, reasons } from "./messages/index.js";
 import { removeListItems } from "./plan.js";
+import { endpointText, requireEndPosition, routeParts } from "./routes.js";
 import { storyDependents } from "./stories.js";
 import { quoteString } from "./text.js";
 // ---------------------------------------------------------------------- views
 /** Operations a C4 view accepts; the others write declarations the view does not have. */
 const VIEW_OPERATIONS = new Set([
+    // A view declares notes: `createElement` refuses every other kind there.
+    "createElement",
+    "attachNote",
     "setPosition",
     "setSize",
     "setRoute",
@@ -25,11 +30,32 @@ const VIEW_OPERATIONS = new Set([
     "includeEntity",
     "excludeEntity",
     "setLocalLabel",
+    "forgetModelRelation",
+    "rewriteRouteEnd",
+    "materializeRelationId",
+]);
+/**
+ * Operations a note of a view takes as any element does, since the note is a declaration of the
+ * view: its text, id, classes and url, and its removal with the placement and styles it has.
+ */
+const NOTE_OPERATIONS = new Set([
+    "renameElement",
+    "removeElement",
+    "setElementLabel",
+    "setClasses",
+    "setElementProperty",
 ]);
 /** Refuses an operation that does not apply to a C4 view, naming the ones that do. */
-export function refuseInView(ctx, kind) {
+export function refuseInView(ctx, operation) {
+    const { kind } = operation;
     if (ctx.diagram.type !== "c4" || VIEW_OPERATIONS.has(kind))
         return;
+    if (NOTE_OPERATIONS.has(kind) && operation.targetKind !== "relation") {
+        const id = operation.element ?? operation.target;
+        const element = id === undefined ? undefined : ctx.diagram.elementsById.get(id);
+        if (element?.kind === "note" && element.entity === null)
+            return;
+    }
     reject("edit.invalid-value", reasons().c4.notInView(kind, ctx.diagram.c4?.model ?? ""));
 }
 function requireView(ctx) {
@@ -69,6 +95,13 @@ function insertViewStatement(ctx, text, after) {
         ? insertBefore(ctx, first, () => text)
         : insertStatement(ctx, body, ctx.diagram.node.start, () => text);
 }
+/**
+ * Declares a note in a view: after its last note, else after the lists and labels and before the
+ * blocks, where the language keeps what a view says about what it draws.
+ */
+export function insertViewNote(ctx, text) {
+    return insertViewStatement(ctx, text, ["level", "scope", "include", "exclude", "label", "note"]);
+}
 function requireEntity(ctx, path) {
     const model = requireView(ctx).resolved?.definition;
     if (!model)
@@ -106,8 +139,7 @@ export function includeEntity(ctx, op) {
     return edits;
 }
 /** The view statements that only target an element, and edits that drop it from shared ones. */
-function viewDependents(ctx, id) {
-    const diagram = ctx.diagram;
+function viewDependents(ctx, diagram, id) {
     const lines = ctx.compilation.parse.lines;
     const statements = [];
     const edits = [];
@@ -122,6 +154,16 @@ function viewDependents(ctx, id) {
         });
     };
     const gone = new Set(diagram.relations.filter((r) => r.from === id || r.to === id).map((r) => r.key));
+    // A note of the view attached to the entity stays, without its `on` clause.
+    for (const note of diagram.elements) {
+        if (note.attachedTo !== id)
+            continue;
+        const attached = attachmentDependent(ctx, note);
+        if (!attached)
+            continue;
+        dependents.push(attached.dependent);
+        edits.push(attached.edit);
+    }
     for (const entry of diagram.placement) {
         if (entry.target === id || gone.has(entry.target))
             depend(entry.statement, entry.target, entry.node);
@@ -176,7 +218,7 @@ export function excludeEntity(ctx, op) {
     if (element.kind === "group") {
         reject("edit.unsafe-target", reasons().c4.isScope(op.entity));
     }
-    const dependents = viewDependents(ctx, op.entity);
+    const dependents = viewDependents(ctx, ctx.diagram, op.entity);
     if (!op.cascade && dependents.dependents.length > 0) {
         reject("edit.has-dependents", reasons().c4.removingFromView(op.entity, dependents.dependents.length), dependents.dependents);
     }
@@ -222,7 +264,7 @@ export function setLocalLabel(ctx, op) {
     else {
         const relation = ctx.diagram.relationsByKey.get(op.target);
         if (relation && relation.id === null) {
-            reject("edit.anonymous-relation", reasons().c4.nameRelation);
+            reject("edit.anonymous-relation", reasons().relations.unnamed(op.target));
         }
         edits = [
             insertViewStatement(ctx, `label ${op.target} ${quoteString(op.label)}`, [
@@ -378,6 +420,16 @@ export function removeEntity(ctx, op) {
             if (removed.has(label.target) || relationKeys.has(label.target))
                 depend("label", label.target, label.node);
         }
+        // The notes of the view attached to a removed entity stay, without their clause.
+        for (const note of diagram.elements) {
+            if (note.attachedTo === null || !removed.has(note.attachedTo))
+                continue;
+            const attached = attachmentDependent(ctx, note);
+            if (!attached)
+                continue;
+            dependents.push(attached.dependent);
+            edits.push(attached.edit);
+        }
         for (const entry of diagram.placement) {
             const target = entry.target;
             const relation = diagram.relationsByKey.get(target);
@@ -578,34 +630,276 @@ export function createModelRelation(ctx, op) {
     verifyNoNewErrors(ctx, edits);
     return edits;
 }
+/** Moves one end of a model relation to another entity; the label, id and block stay. */
+export function reconnectModelRelation(ctx, op) {
+    const relation = requireModelRelation(ctx, op.relation);
+    const entity = requireModelEntity(ctx, op.entity);
+    const current = op.end === "from" ? relation.from : relation.to;
+    if (current === entity.path)
+        return [];
+    const ref = op.end === "from" ? relation.node.source : relation.node.target;
+    if (ref.kind !== "QualifiedRef") {
+        reject("edit.unsafe-target", reasons().c4.endUnreadable(relation.key));
+    }
+    if (op.position !== undefined)
+        requireEndPosition(op.port, op.position);
+    // The path from the root resolves wherever the statement sits: the lookup from the enclosing
+    // entity outwards ends at the root.
+    const moved = { start: ref.start, end: ref.end, newText: entity.path };
+    const edits = [moved];
+    // The routes of the file's views follow the end the views now draw.
+    if (relation.id !== null) {
+        const after = compile(applyTextEdits(ctx.text, [moved]), ctx.compilation.options);
+        const removed = [];
+        for (const diagram of ctx.compilation.document.diagrams) {
+            const c4 = diagram.c4;
+            if (!c4 || c4.resolved?.file !== null || c4.resolved.definition.id !== ctx.model.id)
+                continue;
+            const routes = routeStatements(diagram, relation.id);
+            if (routes.length === 0)
+                continue;
+            const now = after.document.diagrams.find((d) => d.id === diagram.id);
+            const drawn = now?.relations.find((r) => r.id === relation.id);
+            const pinned = diagram.id === op.view && op.port !== undefined
+                ? { port: op.port, ...(op.position !== undefined ? { position: op.position } : {}) }
+                : undefined;
+            const followed = followRoutes(ctx.text, ctx.model, routes, drawn, op.end, pinned);
+            edits.push(...followed.edits);
+            removed.push(...followed.removed);
+        }
+        edits.push(...deleteStatements(ctx.text, ctx.compilation.parse.root, removed));
+    }
+    verifyNoNewErrors(ctx, edits);
+    return edits;
+}
+/** The `route <id>` statements of a view, whether the analyser took them or not. */
+function routeStatements(diagram, id) {
+    const found = [];
+    for (const owner of diagram.placementBlocks) {
+        for (const stmt of owner.block?.statements ?? []) {
+            if (stmt.kind !== "KeywordStatement" || stmt.keyword.text !== "route")
+                continue;
+            if (singleIdent(stmt.args[0])?.text === id)
+                found.push(stmt);
+        }
+    }
+    return found;
+}
+/** The compass sides and `auto`: the ports every entity has, which carry over to another. */
+const COMPASS = new Set(["north", "south", "east", "west", "auto"]);
+/** A route end as written: the entity it names, and the port after it when it has one. */
+function writtenEnd(model, text) {
+    if (model.entitiesByPath.has(text))
+        return { element: text, port: null };
+    const dot = text.lastIndexOf(".");
+    if (dot > 0 && model.entitiesByPath.has(text.slice(0, dot))) {
+        return { element: text.slice(0, dot), port: text.slice(dot + 1) };
+    }
+    return { element: text, port: null };
+}
+/**
+ * The edits that make a view's routes of a relation end where the view now draws its moved end:
+ * the end rewritten with the drawn entity, a compass port carried over, a named port and a point
+ * dropped (or `pinned`, the port and point of a drop on this view), the other end and the
+ * waypoints kept; a route the view no longer draws the relation for goes; a route whose end
+ * already meets the drawn one stays as it is.
+ */
+function followRoutes(text, model, routes, drawn, end, pinned) {
+    const edits = [];
+    const removed = [];
+    for (const route of routes) {
+        if (!drawn) {
+            removed.push(route);
+            continue;
+        }
+        const parts = routeParts(route);
+        const arg = end === "from" ? parts.fromRef : parts.toRef;
+        const at = end === "from" ? parts.fromAt : parts.toAt;
+        if (arg?.kind !== "QualifiedRef") {
+            reject("edit.unsafe-target", reasons().relations.routeUnreadable);
+        }
+        const target = end === "from" ? drawn.from : drawn.to;
+        const written = writtenEnd(model, text.slice(arg.start, arg.end));
+        let newText;
+        if (pinned)
+            newText = endpointText(target, pinned.port, pinned.position);
+        else if (written.element === target)
+            continue;
+        else {
+            const port = written.port !== null && COMPASS.has(written.port) ? written.port : null;
+            newText = endpointText(target, port);
+        }
+        const stop = (at ?? arg).end;
+        if (newText !== text.slice(arg.start, stop)) {
+            edits.push({ start: arg.start, end: stop, newText });
+        }
+    }
+    return { edits, removed };
+}
+/**
+ * The routes of a relation in a view of a file other than the model's, once the model moved one of
+ * its ends (the compilation already resolves the moved model): they follow the end the view
+ * draws now, as `reconnectModelRelation` makes them follow in the model's own file.
+ */
+export function rewriteRouteEnd(ctx, op) {
+    const c4 = requireView(ctx);
+    const model = c4.resolved?.definition;
+    if (!model)
+        reject("edit.unsafe-target", reasons().c4.unresolved);
+    const routes = routeStatements(ctx.diagram, op.relation);
+    if (routes.length === 0)
+        return [];
+    const drawn = ctx.diagram.relations.find((r) => r.id === op.relation);
+    const followed = followRoutes(ctx.text, model, routes, drawn, op.end, undefined);
+    const edits = [
+        ...followed.edits,
+        ...deleteStatements(ctx.text, ctx.compilation.parse.root, followed.removed),
+    ];
+    verifyNoNewErrors(ctx, edits);
+    return edits;
+}
+/**
+ * Removes a model relation with the statements of the file's views that name it. Without
+ * `cascade`, those statements and the views that draw the relation (other than `op.view`) are
+ * listed as dependents.
+ */
+/**
+ * What a view holds about a model relation: the statements that name it by its key, or by a
+ * combination standing for it alone, as statements to delete, edits that take it out of shared
+ * lists, and dependents; with the view itself as drawing it when `listDrawn`.
+ */
+function relationStatements(ctx, diagram, key, listDrawn) {
+    const c4 = diagram.c4;
+    const lines = ctx.compilation.parse.lines;
+    const statements = [];
+    const edits = [];
+    const dependents = [];
+    if (!c4)
+        return { statements, edits, dependents };
+    const depend = (kind, name, node) => {
+        statements.push(node);
+        dependents.push({
+            kind,
+            name,
+            description: messages().dependents.statement(kind, name, lines.location(node.start).line),
+            range: lines.range(node),
+        });
+    };
+    const keys = new Set([key]);
+    let drawn = false;
+    for (const shown of diagram.relations) {
+        if (!shown.sources.includes(key))
+            continue;
+        drawn = true;
+        if (isCombination(diagram, shown.key) && shown.sources.every((k) => k === key)) {
+            keys.add(shown.key);
+            depend("relation", shown.key, shown.node);
+        }
+    }
+    if (drawn && listDrawn) {
+        dependents.push({
+            kind: "relation",
+            name: diagram.id,
+            description: messages().dependents.drawnIn(key, diagram.id, lines.location(diagram.node.start).line),
+            range: lines.range(diagram.node),
+        });
+    }
+    for (const entry of diagram.placement) {
+        if (keys.has(entry.target))
+            depend(entry.statement, entry.target, entry.node);
+    }
+    for (const label of c4.labels) {
+        if (keys.has(label.target))
+            depend("label", label.target, label.node);
+    }
+    // A style or an animation of several targets loses this one; of this one alone, it goes.
+    const partial = new Map();
+    for (const entry of [...diagram.styles, ...diagram.animations]) {
+        if (!keys.has(entry.target))
+            continue;
+        const index = entry.node.args.findIndex((a) => a.start === entry.targetRange.start.offset);
+        const set = partial.get(entry.node) ?? new Set();
+        if (index >= 0)
+            set.add(index);
+        partial.set(entry.node, set);
+        const kind = "properties" in entry ? "style" : "animate";
+        dependents.push({
+            kind,
+            name: entry.target,
+            description: messages().dependents.statement(kind, entry.target, lines.location(entry.node.start).line),
+            range: lines.range(entry.node),
+        });
+    }
+    for (const [node, indices] of partial) {
+        if (indices.size >= node.args.length)
+            statements.push(node);
+        else
+            edits.push(...removeListItems(node.args, indices));
+    }
+    const stories = storyDependents(ctx.compilation, diagram.id, keys);
+    statements.push(...stories.statements);
+    edits.push(...stories.edits);
+    dependents.push(...stories.dependents);
+    // An entity the view drew only for this relation leaves its default set, with what names it.
+    const model = c4.resolved?.definition;
+    if (model && c4.includes === null) {
+        const without = {
+            ...model,
+            relations: model.relations.filter((r) => r.key !== key),
+        };
+        const after = defaultEntities(without, c4.level, c4.scope);
+        for (const path of defaultEntities(model, c4.level, c4.scope)) {
+            if (after.has(path) || !diagram.elementsById.has(path))
+                continue;
+            dependents.push({
+                kind: "element",
+                name: path,
+                description: messages().dependents.leavesView(path, diagram.id),
+                range: lines.range(diagram.node),
+            });
+            // What the entity's own removal would take, less what the relation's already takes.
+            const leaving = viewDependents(ctx, diagram, path);
+            const taken = new Set(statements.map((s) => s.start));
+            const listed = new Set(dependents.map((d) => `${d.range.start.offset}:${d.description}`));
+            statements.push(...leaving.statements.filter((s) => !taken.has(s.start)));
+            edits.push(...leaving.edits);
+            dependents.push(...leaving.dependents.filter((d) => !listed.has(`${d.range.start.offset}:${d.description}`)));
+        }
+    }
+    return { statements, edits, dependents };
+}
 export function removeModelRelation(ctx, op) {
     const relation = requireModelRelation(ctx, op.relation);
     const statements = [relation.node];
-    // View statements that name the relation by its key.
+    const edits = [];
+    const dependents = [];
     for (const diagram of ctx.compilation.document.diagrams) {
         const c4 = diagram.c4;
         if (!c4 || c4.resolved?.file !== null || c4.resolved.definition.id !== ctx.model.id)
             continue;
-        // Combinations that stand for this relation only go too, with what names them.
-        const keys = new Set([relation.key]);
-        for (const drawn of diagram.relations) {
-            if (isCombination(diagram, drawn.key) && drawn.sources.every((k) => k === relation.key)) {
-                keys.add(drawn.key);
-                statements.push(drawn.node);
-            }
-        }
-        for (const entry of diagram.placement)
-            if (keys.has(entry.target))
-                statements.push(entry.node);
-        for (const label of c4.labels)
-            if (keys.has(label.target))
-                statements.push(label.node);
-        for (const entry of [...diagram.styles, ...diagram.animations]) {
-            if (keys.has(entry.target))
-                statements.push(entry.node);
-        }
+        const found = relationStatements(ctx, diagram, relation.key, diagram.id !== op.view);
+        statements.push(...found.statements);
+        edits.push(...found.edits);
+        dependents.push(...found.dependents);
     }
-    const edits = deleteStatements(ctx.text, ctx.compilation.parse.root, statements);
+    if (!op.cascade && dependents.length > 0) {
+        reject("edit.has-dependents", reasons().c4.removingRelation(relation.key, dependents.length), dependents);
+    }
+    edits.push(...deleteStatements(ctx.text, ctx.compilation.parse.root, statements));
+    verifyNoNewErrors(ctx, edits);
+    return edits;
+}
+/**
+ * Takes a model relation out of a view whose model is in another file: the statements that name
+ * it go (with `cascade`), or are listed as dependents, with the view as drawing it.
+ */
+export function forgetModelRelation(ctx, op) {
+    requireView(ctx);
+    const { statements, edits, dependents } = relationStatements(ctx, ctx.diagram, op.relation, op.listDrawn ?? true);
+    if (!op.cascade && dependents.length > 0) {
+        reject("edit.has-dependents", reasons().c4.removingRelation(op.relation, dependents.length), dependents);
+    }
+    edits.push(...deleteStatements(ctx.text, ctx.compilation.parse.root, statements));
     verifyNoNewErrors(ctx, edits);
     return edits;
 }