@formicoidea/labre-ddd-shared 0.34.2 → 0.35.0

package/dist/shared/prefabs.d.ts

@@ -1,3 +1,4 @@
+import { TextFitMode } from '@formicoidea/labre-core/model';
 import type { BlockStdScope } from '@formicoidea/labre-core/std';
 import { type GfxController } from '@formicoidea/labre-core/std/gfx';
 /**
@@ -17,6 +18,47 @@ type Surface = NonNullable<GfxController['surface']>;
 export declare function placeDddElement(std: BlockStdScope, build: (surface: Surface, cx: number, cy: number) => string): void;
 /** Group several element ids; returns the group id (or the first id on failure). */
 export declare function groupIds(std: BlockStdScope, ids: string[]): string;
+export interface ShapeOpts {
+    shapeType?: 'rect' | 'ellipse' | 'diamond';
+    fill: string;
+    /**
+     * Semantic role (`<framework>:<role>`) stamped on the shape, so a validation
+     * rule can recognise it. `undefined` writes NOTHING — no `role` key is
+     * persisted and the artefact stays a neutral drawing, which is what every
+     * caller that does not pass one keeps getting and what every DDD artefact
+     * created before this parameter existed already is.
+     */
+    role?: string;
+    stroke?: string;
+    strokeWidth?: number;
+    radius?: number;
+    /**
+     * Shape-owned centred label. The text belongs to the shape itself (edited
+     * by double-click, moves/resizes with it) with the given text-fit mode —
+     * `contained` mimics a physical post-it.
+     */
+    label?: {
+        text: string;
+        color: string;
+        fontFamily: string;
+        fontSize: number;
+        fit: TextFitMode;
+    };
+}
+/**
+ * The props a DDD shape is CREATED with, as a record — the write of
+ * {@link addShape}, minus the write.
+ *
+ * Split out for the Core Domain morph, and for the reason C4's `presets.ts`
+ * gives: a kind's appearance is written by the preset of the kind it was created
+ * as and nothing else ever rewrites it, so a morph that restated the table would
+ * agree with the palette the day it was written and drift on the first restyle.
+ * Derived, they cannot — a morphed dot and one freshly placed are the same
+ * element.
+ */
+export declare function dddShapeProps(x: number, y: number, w: number, h: number, opts: ShapeOpts): Record<string, unknown> & {
+    type: string;
+};
 /**
  * A post-it: faux-shadow rect + coloured face whose label is the face's OWN
  * shape text in `contained` fit mode — like a real post-it, the box size is
@@ -43,6 +85,14 @@ export declare function addSticky(surface: Surface, std: BlockStdScope, cx: numb
  * long context name may spill out rather than deform the map).
  */
 export declare function addBubble(surface: Surface, cx: number, cy: number, label: string, role?: string): string;
+/**
+ * What a Core Domain DOT is, as shape options — read by the creation site below
+ * and by the morph, so the two can never disagree about what a platform
+ * sub-domain looks like. See {@link dddShapeProps}.
+ */
+export declare function dotShapeOpts(fill: string, role?: string): ShapeOpts;
+/** What a Team Topologies MARKER square is, the same way. */
+export declare function markerShapeOpts(fill: string, role?: string): ShapeOpts;
 /** A Core Domain dot (sub-domain / bounded context); optional label to its right. */
 export declare function addDot(surface: Surface, std: BlockStdScope, cx: number, cy: number, fill: string, label?: string, 
 /** Stamped on the ELLIPSE, never on the group: the dot is the artefact. */

package/dist/shared/prefabs.js

@@ -29,9 +29,20 @@ export function groupIds(std, ids) {
     const [, result] = std.command.exec(createGroupCommand, { elements: ids });
     return result.groupId || ids[0];
 }
-function addShape(surface, x, y, w, h, opts) {
+/**
+ * The props a DDD shape is CREATED with, as a record — the write of
+ * {@link addShape}, minus the write.
+ *
+ * Split out for the Core Domain morph, and for the reason C4's `presets.ts`
+ * gives: a kind's appearance is written by the preset of the kind it was created
+ * as and nothing else ever rewrites it, so a morph that restated the table would
+ * agree with the palette the day it was written and drift on the first restyle.
+ * Derived, they cannot — a morphed dot and one freshly placed are the same
+ * element.
+ */
+export function dddShapeProps(x, y, w, h, opts) {
     const { shapeType = 'rect', fill, stroke = NO_STROKE, strokeWidth = 0, radius = 0, label, role, } = opts;
-    return surface.addElement({
+    return {
         type: 'shape',
         // `undefined` writes nothing: a neutral artefact keeps no `role` key.
         role,
@@ -54,7 +65,10 @@ function addShape(surface, x, y, w, h, opts) {
                 textFitMode: label.fit,
             }
             : {}),
-    });
+    };
+}
+function addShape(surface, x, y, w, h, opts) {
+    return surface.addElement(dddShapeProps(x, y, w, h, opts));
 }
 function addText(surface, x, y, w, text, color, fontFamily, fontSize, textAlign = 'center', bold = false) {
     return surface.addElement({
@@ -121,18 +135,38 @@ export function addBubble(surface, cx, cy, label, role) {
         },
     });
 }
+/** The ink every Core Domain artefact is outlined with. */
+const ARTEFACT_STROKE = '#1f2328';
+/**
+ * What a Core Domain DOT is, as shape options — read by the creation site below
+ * and by the morph, so the two can never disagree about what a platform
+ * sub-domain looks like. See {@link dddShapeProps}.
+ */
+export function dotShapeOpts(fill, role) {
+    return {
+        shapeType: 'ellipse',
+        fill,
+        stroke: ARTEFACT_STROKE,
+        strokeWidth: 1.5,
+        role,
+    };
+}
+/** What a Team Topologies MARKER square is, the same way. */
+export function markerShapeOpts(fill, role) {
+    return {
+        fill,
+        stroke: ARTEFACT_STROKE,
+        strokeWidth: 1.5,
+        radius: 4,
+        role,
+    };
+}
 /** A Core Domain dot (sub-domain / bounded context); optional label to its right. */
 export function addDot(surface, std, cx, cy, fill, label, 
 /** Stamped on the ELLIPSE, never on the group: the dot is the artefact. */
 role) {
     const d = DOT_SIZE;
-    const dot = addShape(surface, cx - d / 2, cy - d / 2, d, d, {
-        shapeType: 'ellipse',
-        fill,
-        stroke: '#1f2328',
-        strokeWidth: 1.5,
-        role,
-    });
+    const dot = addShape(surface, cx - d / 2, cy - d / 2, d, d, dotShapeOpts(fill, role));
     if (!label)
         return dot;
     const lbl = addText(surface, cx + d / 2 + 6, cy - LABEL_FONT_SIZE / 2, 170, label, LABEL_COLOR, LABEL_FONT, LABEL_FONT_SIZE, 'left');
@@ -169,13 +203,7 @@ export function addConnector(surface, x1, y1, x2, y2, opts = {}) {
 export function addMarker(surface, std, cx, cy, opts) {
     const { fill, letter, label, role } = opts;
     const s = MARKER_SIZE;
-    const box = addShape(surface, cx - s / 2, cy - s / 2, s, s, {
-        fill,
-        stroke: '#1f2328',
-        strokeWidth: 1.5,
-        radius: 4,
-        role,
-    });
+    const box = addShape(surface, cx - s / 2, cy - s / 2, s, s, markerShapeOpts(fill, role));
     const glyph = addText(surface, cx - s / 2, cy - 9, s, letter, '#1f2328', LABEL_FONT, 15);
     const ids = [box, glyph];
     if (label) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@formicoidea/labre-ddd-shared",
   "description": "Labre ddd-shared — shared building blocks for @formicoidea/labre-core frameworks.",
-  "version": "0.34.2",
+  "version": "0.35.0",
   "type": "module",
   "sideEffects": false,
   "author": "lajola",
@@ -19,7 +19,7 @@
     "dist"
   ],
   "dependencies": {
-    "@formicoidea/labre-core": "0.34.2",
+    "@formicoidea/labre-core": "0.35.0",
     "lit": "^3.2.0"
   }
 }