@meltemi/diagrams-editor 1.9.0 → 1.10.0

package/dist/session.d.ts

@@ -1,7 +1,8 @@
-import { type EditOperation, type EditPlan } from "@meltemi/diagrams-edit";
+import { type EditPlan } from "@meltemi/diagrams-edit";
 import { type Point } from "@meltemi/diagrams-model";
 import { type DocumentAnalysis } from "./analysis.js";
-import { type HostMessage } from "./canvas/protocol.js";
+import { type CanvasAction, type HostMessage } from "./canvas/protocol.js";
+import type { AssetSteps, ProjectStep } from "./projects.js";
 /** What the host does after the session handled a message. */
 export interface SessionResult {
     readonly messages: readonly HostMessage[];
@@ -25,16 +26,21 @@ export interface SessionResult {
     readonly story?: string;
     /**
      * Edits of other files of the project, which the host makes with `ProjectSessions`: a theme
-     * created for the project, or an operation on the file that holds the theme being edited.
+     * created for the project, or steps over files (`planSteps`), such as a token of the file that
+     * holds the theme being edited, or the model of a C4 view and the view's own statements, which
+     * the host applies together in one undo step.
      */
     readonly project?: {
         readonly kind: "createTheme";
         readonly theme: string;
         readonly extends: string;
     } | {
-        readonly kind: "themeFile";
-        readonly file: string;
-        readonly operation: EditOperation;
+        readonly kind: "files";
+        readonly steps: readonly ProjectStep[];
+        /** Files of the assets written first, such as added icons (`planAssetSteps`). */
+        readonly assets?: AssetSteps;
+        /** The action to send again with `cascade: true` when the steps are refused for dependents. */
+        readonly retry?: CanvasAction;
     };
     /**
      * Ask the user for the image file of a new image, then call `createObject` with it (`at` is in
@@ -58,9 +64,14 @@ export declare class CanvasSession {
     private readonly rendered;
     private pendingSelection;
     private pendingEdit;
+    /** A status line to show after the next render and the selection it brings. */
+    private pendingStatus;
     /** The diagram to show once it exists, after a conversion. */
     private pendingDiagram;
-    /** True while the canvas shows the diagram's effects running. */
+    /**
+     * True while the canvas shows the diagram's effects running: from the start, so a diagram with
+     * effects opens animated; the canvas pauses it from the choice it remembers per diagram.
+     */
     private playing;
     /** The scenario of a sequence diagram previewed read-only, with its diagram. */
     private scenario;
@@ -132,12 +143,23 @@ export declare class CanvasSession {
      * participants draw none, get nothing.
      */
     private searchIcons;
+    /**
+     * Adds icons to the project (`addIcons`): the files of the assets and the statements that give
+     * the first icon to the targets, as one request of steps over files the host applies in one
+     * undo step; outside a project every file is refused.
+     */
+    private addIcons;
     /** Highlights the element or relation of the statement at a text offset. */
     selectAt(offset: number): HostMessage[];
     /** Handles a message from the canvas. */
     receive(message: unknown): SessionResult;
     /** Pastes clipboard text at a point, or two grid steps off when no point is given. */
     paste(text: string, at?: Point): SessionResult;
+    /**
+     * Pastes entities copied from a C4 view into this one: copies declared in its model, included
+     * and placed; anything else on the clipboard says why it does not paste here.
+     */
+    private pasteEntities;
     /** The scenario the canvas previews, if any. */
     get previewed(): string | undefined;
     /** Creates an `image` once the host has its file, or an `icon` with its reference. */
@@ -156,13 +178,37 @@ export declare class CanvasSession {
      * One plan for the operations, after the arrangement of an `auto` diagram when needed; undefined
      * without operations. It changes nothing in the session: previews plan with it too.
      */
+    /**
+     * After an edit names the relation `key` as `id` first, the selection holds `id` where it held
+     * the key, so the canvas and the inspector stay on the relation; a refusal drops it.
+     */
+    private followNaming;
     private plan;
-    /** The plan of `plan` for the host to apply; a refusal drops what waited for the edit. */
+    /**
+     * The plan of `plan` for the host to apply; a refusal drops what waited for the edit. When the
+     * operations write the model of a C4 view that another file holds, they go to the host as
+     * steps over files instead, with `retry` for the dependents dialog.
+     */
     private planned;
+    /**
+     * The operations as steps over files when a C4 view's model is in another file of the project
+     * and they write it: the model's first, then the view's, which name what the model's wrote;
+     * the host plans and applies them together. Undefined when the plan is the document's alone.
+     */
+    private modelSteps;
+    /**
+     * Where a new note's centre goes: where the tool was dropped, or, dropped on an element it is
+     * attached to, at the element's east edge plus the theme's `groupPadding`, aligned to its top,
+     * as a note of the size the text "Note" gives it, snapped to the grid.
+     */
+    private notePlace;
+    /** A view whose model is not resolved cannot write it. */
+    private unresolved;
     /**
      * The actions of a C4 view that differ from flow diagrams: entities are added from the model
-     * and removed by excluding them; labels are local; ids rename the model's entities. Returns
-     * undefined for the actions the flow code handles.
+     * and removed by excluding them; relations are the model's; labels are local or the model's;
+     * ids rename the model's entities and relations. Returns undefined for the actions the flow
+     * code handles.
      */
     private c4Action;
     private act;

package/dist/session.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"session.d.ts","sourceRoot":"","sources":["../src/session.ts"],"names":[],"mappings":"AAMA,OAAO,EAKL,KAAK,aAAa,EAClB,KAAK,QAAQ,EAEd,MAAM,wBAAwB,CAAC;AAGhC,OAAO,EAQL,KAAK,KAAK,EACX,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAiC,KAAK,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAarF,OAAO,EAML,KAAK,WAAW,EAUjB,MAAM,sBAAsB,CAAC;AAe9B,8DAA8D;AAC9D,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,QAAQ,EAAE,SAAS,WAAW,EAAE,CAAC;IAC1C,0DAA0D;IAC1D,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC;IACzB,2CAA2C;IAC3C,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,gEAAgE;IAChE,QAAQ,CAAC,aAAa,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,CAAC,EAAE,KAAK,CAAA;KAAE,CAAC;IACjD,yEAAyE;IACzE,QAAQ,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;KAAE,CAAC;IAC5F,iCAAiC;IACjC,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,WAAW,GAAG,cAAc,CAAC;IAC3D,oEAAoE;IACpE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EACb;QAAE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClF;QAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;QAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAA;KAAE,CAAC;IAC7F;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;QAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1F;AAyBD;;;;GAIG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAA+B;IAC/C,OAAO,CAAC,OAAO,CAAqB;IACpC,OAAO,CAAC,SAAS,CAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAkC;IAC3D,OAAO,CAAC,gBAAgB,CAAuB;IAC/C,OAAO,CAAC,WAAW,CAAqB;IACxC,8DAA8D;IAC9D,OAAO,CAAC,cAAc,CAAqB;IAC3C,iEAAiE;IACjE,OAAO,CAAC,OAAO,CAAS;IACxB,gFAAgF;IAChF,OAAO,CAAC,QAAQ,CAAgE;IAChF,4DAA4D;IAC5D,OAAO,CAAC,KAAK,CAAqB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,yEAAyE;IACzE,OAAO,CAAC,YAAY,CAAS;IAC7B;;;OAGG;IACH,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA2B;IAClD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAgB;gBAGxC,OAAO,GAAE;QACP,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QACvB;;;WAGG;QACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC;QACpD,2FAA2F;QAC3F,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,OAAO,CAAC;KAC7B;IAQR,yEAAyE;IACzE,OAAO,KAAK,IAAI,GAEf;IAED,sFAAsF;IACtF,OAAO,CAAC,OAAO;IAQf,yFAAyF;IACzF,OAAO,CAAC,iBAAiB;IAQzB,oCAAoC;IACpC,IAAI,OAAO,IAAI,MAAM,GAAG,SAAS,CAEhC;IAED,IAAI,QAAQ,IAAI,SAAS,MAAM,EAAE,CAEhC;IAED,kFAAkF;IAClF,MAAM,CAAC,QAAQ,EAAE,gBAAgB,GAAG,WAAW,EAAE;IAcjD;;;OAGG;IACH,OAAO,CAAC,aAAa;IAUrB;;;OAGG;IACH,KAAK,IAAI,WAAW,EAAE;IAgEtB;;;;OAIG;IACH,OAAO,CAAC,QAAQ;IAiChB,0FAA0F;IAC1F,OAAO,CAAC,UAAU;IAwBlB,mEAAmE;IACnE,OAAO,CAAC,UAAU;IAUlB,OAAO,CAAC,MAAM;IAuHd,qFAAqF;IACrF,OAAO,CAAC,SAAS;IAOjB,OAAO,CAAC,WAAW;IAQnB,6EAA6E;IAC7E,OAAO,CAAC,SAAS;IAKjB,OAAO,CAAC,QAAQ;IAWhB,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,aAAa;IAQrB;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAOnB,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW,EAAE;IAOvC,yCAAyC;IACzC,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,aAAa;IAuIxC,sFAAsF;IACtF,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,KAAK,GAAG,aAAa;IAU9C,gDAAgD;IAChD,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAGlC;IAED,sFAAsF;IACtF,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,aAAa;IAU/F,OAAO,CAAC,IAAI;IAIZ;;;OAGG;IACH,OAAO,CAAC,OAAO;IAQf,OAAO,CAAC,OAAO;IAgBf,OAAO,CAAC,IAAI;IAOZ,+EAA+E;IAC/E,OAAO,CAAC,WAAW;IA+DnB;;;OAGG;IACH,OAAO,CAAC,IAAI;IAmBZ,0FAA0F;IAC1F,OAAO,CAAC,OAAO;IAoBf;;;;OAIG;IACH,OAAO,CAAC,QAAQ;IAwHhB,OAAO,CAAC,GAAG;IAmiBX,sFAAsF;IACtF,OAAO,CAAC,aAAa;IAmBrB;;;OAGG;IACH,OAAO,CAAC,cAAc;IA6FtB,uFAAuF;IACvF,OAAO,CAAC,gBAAgB;IA2CxB;;;;;;;OAOG;IACH,OAAO,CAAC,OAAO;CA0ChB"}
+{"version":3,"file":"session.d.ts","sourceRoot":"","sources":["../src/session.ts"],"names":[],"mappings":"AAMA,OAAO,EAML,KAAK,QAAQ,EAEd,MAAM,wBAAwB,CAAC;AAGhC,OAAO,EASL,KAAK,KAAK,EAEX,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAiC,KAAK,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAarF,OAAO,EAEL,KAAK,YAAY,EAKjB,KAAK,WAAW,EAUjB,MAAM,sBAAsB,CAAC;AAsB9B,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAI7D,8DAA8D;AAC9D,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,QAAQ,EAAE,SAAS,WAAW,EAAE,CAAC;IAC1C,0DAA0D;IAC1D,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC;IACzB,2CAA2C;IAC3C,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,gEAAgE;IAChE,QAAQ,CAAC,aAAa,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,CAAC,EAAE,KAAK,CAAA;KAAE,CAAC;IACjD,yEAAyE;IACzE,QAAQ,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;KAAE,CAAC;IAC5F,iCAAiC;IACjC,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,WAAW,GAAG,cAAc,CAAC;IAC3D,oEAAoE;IACpE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,CAAC,EACb;QAAE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClF;QACE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;QACvB,QAAQ,CAAC,KAAK,EAAE,SAAS,WAAW,EAAE,CAAC;QACvC,iFAAiF;QACjF,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;QAC7B,+FAA+F;QAC/F,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC;KAC/B,CAAC;IACN;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;QAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1F;AAiCD;;;;GAIG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAA+B;IAC/C,OAAO,CAAC,OAAO,CAAqB;IACpC,OAAO,CAAC,SAAS,CAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAkC;IAC3D,OAAO,CAAC,gBAAgB,CAAuB;IAC/C,OAAO,CAAC,WAAW,CAAqB;IACxC,+EAA+E;IAC/E,OAAO,CAAC,aAAa,CAAqB;IAC1C,8DAA8D;IAC9D,OAAO,CAAC,cAAc,CAAqB;IAC3C;;;OAGG;IACH,OAAO,CAAC,OAAO,CAAQ;IACvB,gFAAgF;IAChF,OAAO,CAAC,QAAQ,CAAgE;IAChF,4DAA4D;IAC5D,OAAO,CAAC,KAAK,CAAqB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,yEAAyE;IACzE,OAAO,CAAC,YAAY,CAAS;IAC7B;;;OAGG;IACH,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA2B;IAClD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAgB;gBAGxC,OAAO,GAAE;QACP,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QACvB;;;WAGG;QACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC;QACpD,2FAA2F;QAC3F,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,OAAO,CAAC;KAC7B;IAQR,yEAAyE;IACzE,OAAO,KAAK,IAAI,GAEf;IAED,sFAAsF;IACtF,OAAO,CAAC,OAAO;IAQf,yFAAyF;IACzF,OAAO,CAAC,iBAAiB;IAQzB,oCAAoC;IACpC,IAAI,OAAO,IAAI,MAAM,GAAG,SAAS,CAEhC;IAED,IAAI,QAAQ,IAAI,SAAS,MAAM,EAAE,CAEhC;IAED,kFAAkF;IAClF,MAAM,CAAC,QAAQ,EAAE,gBAAgB,GAAG,WAAW,EAAE;IAcjD;;;OAGG;IACH,OAAO,CAAC,aAAa;IAUrB;;;OAGG;IACH,KAAK,IAAI,WAAW,EAAE;IAqEtB;;;;OAIG;IACH,OAAO,CAAC,QAAQ;IAiChB,0FAA0F;IAC1F,OAAO,CAAC,UAAU;IA2BlB,mEAAmE;IACnE,OAAO,CAAC,UAAU;IAUlB,OAAO,CAAC,MAAM;IAyId,qFAAqF;IACrF,OAAO,CAAC,SAAS;IAOjB,OAAO,CAAC,WAAW;IAQnB,6EAA6E;IAC7E,OAAO,CAAC,SAAS;IAKjB,OAAO,CAAC,QAAQ;IAWhB,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,aAAa;IAQrB;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAOnB;;;;OAIG;IACH,OAAO,CAAC,QAAQ;IAiChB,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW,EAAE;IAOvC,yCAAyC;IACzC,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,aAAa;IAwJxC,sFAAsF;IACtF,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,KAAK,GAAG,aAAa;IAW9C;;;OAGG;IACH,OAAO,CAAC,aAAa;IAkBrB,gDAAgD;IAChD,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAGlC;IAED,sFAAsF;IACtF,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,aAAa;IAU/F,OAAO,CAAC,IAAI;IAIZ;;;OAGG;IACH,OAAO,CAAC,OAAO;IAQf,OAAO,CAAC,OAAO;IAgBf,OAAO,CAAC,IAAI;IAOZ,+EAA+E;IAC/E,OAAO,CAAC,WAAW;IA+DnB;;;OAGG;IACH;;;OAGG;IACH,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,IAAI;IAmBZ;;;;OAIG;IACH,OAAO,CAAC,OAAO;IAwBf;;;;OAIG;IACH,OAAO,CAAC,UAAU;IA0BlB;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAWjB,0DAA0D;IAC1D,OAAO,CAAC,UAAU;IAQlB;;;;;OAKG;IACH,OAAO,CAAC,QAAQ;IA8ahB,OAAO,CAAC,GAAG;IAooBX,sFAAsF;IACtF,OAAO,CAAC,aAAa;IAmBrB;;;OAGG;IACH,OAAO,CAAC,cAAc;IA+GtB,uFAAuF;IACvF,OAAO,CAAC,gBAAgB;IA2CxB;;;;;;;OAOG;IACH,OAAO,CAAC,OAAO;CAiDhB"}