@formicoidea/labre-framework-c4 0.33.0 → 0.34.1

package/dist/actions.js

@@ -2,6 +2,7 @@ import { DefaultTool } from '@formicoidea/labre-core/blocks/surface';
 import { ConnectorTool } from '@formicoidea/labre-core/gfx/connector';
 import { createAutoLegend } from '@formicoidea/labre-ddd-shared';
 import { C4BoardElementModel, ConnectorMode, FontFamily, FontStyle, FontWeight, PointStyle, StrokeStyle, TextAlign, } from '@formicoidea/labre-core/model';
+import { translateKey } from '@formicoidea/labre-core/shared/services';
 import { downloadBlob } from '@formicoidea/labre-core/shared/utils';
 import { Bound } from '@formicoidea/labre-core/global/gfx';
 import { GfxControllerIdentifier, } from '@formicoidea/labre-core/std/gfx';
@@ -10,7 +11,7 @@ import { BOARD_REF_HEIGHT, BOARD_REF_WIDTH, BOUNDARY_LABEL, BOUNDARY_REF_HEIGHT,
 import { C4_MERMAID_EXPORT, c4BoardFrom, c4SafeFilename } from './interchange.js';
 import { C4_AUTO_LEGEND } from './legend.js';
 import { c4NodeProps } from './presets.js';
-import { C4_BOUNDARY_ROLE, C4_ROLE } from './roles.js';
+import { C4_BOUNDARY_ROLE, C4_ROLE, c4BoardRoleKey } from './roles.js';
 import { C4_TYPE_PLACEHOLDER } from './type-line.js';
 /**
  * Standalone creation/activation actions for the C4 toolbox — the same shape
@@ -164,6 +165,13 @@ export function createC4Board(std) {
         // The FRAME the elements are drawn on, and a role of its own: a rule written
         // on the artefacts must never fall on the sheet holding them.
         role: C4_ROLE.board,
+        // The sheet's own name, written HERE rather than left to the model's
+        // default so that a board drawn in a translated host starts in that
+        // language (#183). It is content from that moment on — the title is
+        // editable on a double-click — so it is asked for once and never
+        // re-resolved. The key is the BOARD ROLE's: the two are the same noun, and
+        // a second key would ask a host to word "C4 diagram" twice.
+        name: translateKey(std, c4BoardRoleKey, 'C4 diagram'),
         xywh: new Bound(cx - BOARD_REF_WIDTH / 2, cy - BOARD_REF_HEIGHT / 2, BOARD_REF_WIDTH, BOARD_REF_HEIGHT).serialize(),
     });
     finish(gfx, id);

package/dist/commands-manifest.d.ts

@@ -0,0 +1,18 @@
+import type { ShortcutManifestEntry } from '@formicoidea/labre-core/std';
+/**
+ * The C4 commands as SHORTCUT-MANIFEST rows — id, label, chord, scope,
+ * owner — and nothing else.
+ *
+ * DATA ONLY, and that is the whole point (`docs/adr/0008` § Packaging). A
+ * `CommandDescriptor` carries its `run`, so a host settings pane that imports
+ * the package entry to list names and chords drags the entire action graph —
+ * the import/export machinery, the surface and gfx deep paths — into its
+ * chunk. This module has type-only imports, so the published bundle exposes it
+ * as `./commands-manifest`: a few hundred bytes that reference nothing.
+ *
+ * GENERATED-SHAPED, hand-committed: `commands-manifest.unit.spec.ts` asserts
+ * row-for-row equality with `toShortcutManifestEntry` over {@link c4Commands},
+ * so this file cannot drift from the commands it projects. Add a command and
+ * the test says exactly what to add here.
+ */
+export declare const c4CommandsManifest: ShortcutManifestEntry[];

package/dist/commands-manifest.js

@@ -0,0 +1,130 @@
+/**
+ * The C4 commands as SHORTCUT-MANIFEST rows — id, label, chord, scope,
+ * owner — and nothing else.
+ *
+ * DATA ONLY, and that is the whole point (`docs/adr/0008` § Packaging). A
+ * `CommandDescriptor` carries its `run`, so a host settings pane that imports
+ * the package entry to list names and chords drags the entire action graph —
+ * the import/export machinery, the surface and gfx deep paths — into its
+ * chunk. This module has type-only imports, so the published bundle exposes it
+ * as `./commands-manifest`: a few hundred bytes that reference nothing.
+ *
+ * GENERATED-SHAPED, hand-committed: `commands-manifest.unit.spec.ts` asserts
+ * row-for-row equality with `toShortcutManifestEntry` over {@link c4Commands},
+ * so this file cannot drift from the commands it projects. Add a command and
+ * the test says exactly what to add here.
+ */
+export const c4CommandsManifest = [
+    {
+        id: 'c4.addBoard',
+        owner: 'c4',
+        labelKey: 'com.labre.commands.c4.addBoard',
+        labelFallback: 'C4 board',
+        scope: 'edgeless',
+        defaultKeys: { mac: [], other: [] },
+    },
+    {
+        id: 'c4.addPerson',
+        owner: 'c4',
+        labelKey: 'com.labre.commands.c4.addPerson',
+        labelFallback: 'Person',
+        scope: 'edgeless',
+        defaultKeys: { mac: [], other: [] },
+    },
+    {
+        id: 'c4.addPersonExt',
+        owner: 'c4',
+        labelKey: 'com.labre.commands.c4.addPersonExt',
+        labelFallback: 'Person (external)',
+        scope: 'edgeless',
+        defaultKeys: { mac: [], other: [] },
+    },
+    {
+        id: 'c4.addSystem',
+        owner: 'c4',
+        labelKey: 'com.labre.commands.c4.addSystem',
+        labelFallback: 'Software system',
+        scope: 'edgeless',
+        defaultKeys: { mac: [], other: [] },
+    },
+    {
+        id: 'c4.addSystemExt',
+        owner: 'c4',
+        labelKey: 'com.labre.commands.c4.addSystemExt',
+        labelFallback: 'Software system (external)',
+        scope: 'edgeless',
+        defaultKeys: { mac: [], other: [] },
+    },
+    {
+        id: 'c4.addContainer',
+        owner: 'c4',
+        labelKey: 'com.labre.commands.c4.addContainer',
+        labelFallback: 'Container',
+        scope: 'edgeless',
+        defaultKeys: { mac: [], other: [] },
+    },
+    {
+        id: 'c4.addComponent',
+        owner: 'c4',
+        labelKey: 'com.labre.commands.c4.addComponent',
+        labelFallback: 'Component',
+        scope: 'edgeless',
+        defaultKeys: { mac: [], other: [] },
+    },
+    {
+        id: 'c4.addDatabase',
+        owner: 'c4',
+        labelKey: 'com.labre.commands.c4.addDatabase',
+        labelFallback: 'Database',
+        scope: 'edgeless',
+        defaultKeys: { mac: [], other: [] },
+    },
+    {
+        id: 'c4.addMobile',
+        owner: 'c4',
+        labelKey: 'com.labre.commands.c4.addMobile',
+        labelFallback: 'Mobile app',
+        scope: 'edgeless',
+        defaultKeys: { mac: [], other: [] },
+    },
+    {
+        id: 'c4.addBrowser',
+        owner: 'c4',
+        labelKey: 'com.labre.commands.c4.addBrowser',
+        labelFallback: 'Web browser',
+        scope: 'edgeless',
+        defaultKeys: { mac: [], other: [] },
+    },
+    {
+        id: 'c4.relationshipTool',
+        owner: 'c4',
+        labelKey: 'com.labre.commands.c4.relationshipTool',
+        labelFallback: 'Relationship',
+        scope: 'edgeless',
+        defaultKeys: { mac: [], other: [] },
+    },
+    {
+        id: 'c4.addSystemBoundary',
+        owner: 'c4',
+        labelKey: 'com.labre.commands.c4.addSystemBoundary',
+        labelFallback: 'System boundary',
+        scope: 'edgeless',
+        defaultKeys: { mac: [], other: [] },
+    },
+    {
+        id: 'c4.addContainerBoundary',
+        owner: 'c4',
+        labelKey: 'com.labre.commands.c4.addContainerBoundary',
+        labelFallback: 'Container boundary',
+        scope: 'edgeless',
+        defaultKeys: { mac: [], other: [] },
+    },
+    {
+        id: 'c4.exportMermaid',
+        owner: 'c4',
+        labelKey: 'com.labre.commands.c4.exportMermaid',
+        labelFallback: 'Export as mermaid',
+        scope: 'edgeless',
+        defaultKeys: { mac: [], other: [] },
+    },
+];

package/dist/element-view.d.ts

@@ -1,5 +1,7 @@
 import type { FrameworkBackgroundDef } from '@formicoidea/labre-core/blocks/surface';
 import type { C4BoardElementModel, C4BoundaryElementModel } from '@formicoidea/labre-core/model';
+import type { EditorHost } from '@formicoidea/labre-core/std';
+import type { PointTestOptions } from '@formicoidea/labre-core/std/gfx';
 import { GfxElementModelView } from '@formicoidea/labre-core/std/gfx';
 /**
  * The one gesture the two C4 frames carry: a double-click on the name edits it
@@ -29,6 +31,19 @@ declare abstract class C4FrameView<T extends C4BoardElementModel | C4BoundaryEle
     private _editor;
     onCreated(): void;
     onDestroyed(): void;
+    /** The editable name label under a MODEL-space point, or null. */
+    private _labelAt;
+    /**
+     * A frame is SELECTED by its border (`FrameworkBackgroundElementModel`, issue
+     * #194) — but the name written on its card must still receive the
+     * double-click that renames it.
+     *
+     * Same seam Wardley and EDGY use: the pointer router asks the VIEW, picking
+     * asks the MODEL, and a framework declares its own gesture zones beside the
+     * code that draws them. Without this the name becomes unrenameable; without
+     * the model change the card swallows every click meant for the nodes on it.
+     */
+    includesPoint(x: number, y: number, options: PointTestOptions, host: EditorHost): boolean;
     private _onDblClick;
     /**
      * @param current the words currently DRAWN, which is what the user aimed at —

package/dist/element-view.js

@@ -38,10 +38,8 @@ class C4FrameView extends GfxElementModelView {
         this._closeEditor();
         super.onDestroyed();
     }
-    _onDblClick(e) {
-        if (this.gfx.std.store.readonly || this.model.isLocked())
-            return;
-        const [mx, my] = this.gfx.viewport.toModelCoord(e.x, e.y);
+    /** The editable name label under a MODEL-space point, or null. */
+    _labelAt(mx, my) {
         const [bx, by, w, h] = this.model.deserializedXYWH;
         // Element-local coordinates, undoing the element rotation about its centre.
         let lx = mx - bx;
@@ -54,7 +52,29 @@ class C4FrameView extends GfxElementModelView {
             ly = uy - by;
         }
         const hit = hitTestBackgroundLabel(backgroundLabelHits(this.def, this.model, w, h, this.gfx.std.getOptional(TranslationProvider)), lx, ly);
-        if (!hit || hit.prop !== 'name')
+        return hit && hit.prop === 'name' ? hit : null;
+    }
+    /**
+     * A frame is SELECTED by its border (`FrameworkBackgroundElementModel`, issue
+     * #194) — but the name written on its card must still receive the
+     * double-click that renames it.
+     *
+     * Same seam Wardley and EDGY use: the pointer router asks the VIEW, picking
+     * asks the MODEL, and a framework declares its own gesture zones beside the
+     * code that draws them. Without this the name becomes unrenameable; without
+     * the model change the card swallows every click meant for the nodes on it.
+     */
+    includesPoint(x, y, options, host) {
+        if (super.includesPoint(x, y, options, host))
+            return true;
+        return this._labelAt(x, y) !== null;
+    }
+    _onDblClick(e) {
+        if (this.gfx.std.store.readonly || this.model.isLocked())
+            return;
+        const [mx, my] = this.gfx.viewport.toModelCoord(e.x, e.y);
+        const hit = this._labelAt(mx, my);
+        if (!hit)
             return;
         this._openEditor(hit.text, e);
     }

package/dist/roles.d.ts

@@ -82,6 +82,13 @@ export declare const C4_ROLE: {
     readonly 'container-boundary': "c4:container-boundary";
     readonly relationship: "c4:relationship";
 };
+/**
+ * The board's own key, exported because `createC4Board` seeds the sheet's NAME
+ * from it (#183: a board drawn in a French host should not be called
+ * "C4 diagram"). One key for the role and for the seed, because they are the
+ * same noun and a host must not be asked to word it twice.
+ */
+export declare const c4BoardRoleKey: string;
 export declare const C4_ROLES: RoleDefs;
 /**
  * The `kind` discriminant → the role it means.

package/dist/roles.js

@@ -41,6 +41,13 @@ void _everyRoleIsMapped;
  */
 /** i18n key stem of a role id: `c4:person` → `com.labre.c4.role.person`. */
 const roleKey = (id) => `com.labre.c4.role.${id.slice('c4:'.length)}`;
+/**
+ * The board's own key, exported because `createC4Board` seeds the sheet's NAME
+ * from it (#183: a board drawn in a French host should not be called
+ * "C4 diagram"). One key for the role and for the seed, because they are the
+ * same noun and a host must not be asked to word it twice.
+ */
+export const c4BoardRoleKey = roleKey(C4_ROLE.board);
 /**
  * The four levels of the C4 model, flat — see the note at the top of this file
  * on why composition is not specialisation — plus the one specialisation C4

package/dist/toolbar/config.d.ts

@@ -65,7 +65,7 @@ import { type TemplateResult } from 'lit';
 export declare const c4BoardToolbarConfig: {
     readonly actions: [{
         readonly id: "a.toggle-resize";
-        readonly tooltip: "Enable / lock resizing";
+        readonly tooltipWording: import("@formicoidea/labre-core/shared/services").ChromeWording;
         readonly icon: TemplateResult<1>;
         readonly active: (ctx: ToolbarContext) => boolean;
         readonly run: (ctx: ToolbarContext) => void;
@@ -91,7 +91,7 @@ export declare const c4BoardToolbarExtension: import("@formicoidea/labre-core/st
 export declare const c4LegendToolbarConfig: {
     readonly actions: [{
         readonly id: "b.legend";
-        readonly tooltip: "Generate the legend (notation present)";
+        readonly tooltipWording: import("@formicoidea/labre-core/shared/services").ChromeWording;
         readonly icon: TemplateResult<1>;
         readonly run: (ctx: ToolbarContext) => void;
     }];

package/dist/toolbar/config.js

@@ -1,7 +1,7 @@
 import { EdgelessCRUDIdentifier, validationToolbarConfig, } from '@formicoidea/labre-core/blocks/surface';
 import { dddLegendIcon } from '@formicoidea/labre-ddd-shared';
 import { C4BoardElementModel } from '@formicoidea/labre-core/model';
-import { ActionPlacement, TelemetryProvider, ToolbarModuleExtension, translateKey, } from '@formicoidea/labre-core/shared/services';
+import { ActionPlacement, BOARD_LEGEND_NOTATION, BOARD_RESIZE_TOGGLE, TelemetryProvider, ToolbarModuleExtension, translateKey, } from '@formicoidea/labre-core/shared/services';
 import { BlockFlavourIdentifier, getRegisteredCommands, runCommand, } from '@formicoidea/labre-core/std';
 import { html, nothing } from 'lit';
 import { createC4Legend } from '../actions.js';
@@ -166,7 +166,7 @@ export const c4BoardToolbarConfig = {
     actions: [
         {
             id: 'a.toggle-resize',
-            tooltip: 'Enable / lock resizing',
+            tooltipWording: BOARD_RESIZE_TOGGLE,
             icon: ResizeIcon,
             active(ctx) {
                 const models = ctx.getSurfaceModelsByType(C4BoardElementModel);
@@ -346,7 +346,7 @@ export const c4LegendToolbarConfig = {
     actions: [
         {
             id: 'b.legend',
-            tooltip: 'Generate the legend (notation present)',
+            tooltipWording: BOARD_LEGEND_NOTATION,
             icon: dddLegendIcon,
             run(ctx) {
                 createC4Legend(ctx.std);

package/dist/translations.js

@@ -1,4 +1,4 @@
-import { collectTranslationKeys, commandTranslationEntries, mergeTranslationEntries, } from '@formicoidea/labre-core/std';
+import { collectTranslationKeys, commandCategoryTranslationEntries, commandTranslationEntries, mergeTranslationEntries, } from '@formicoidea/labre-core/std';
 import { C4_BOARD_BACKGROUND, C4_BOUNDARY_BACKGROUND } from './background.js';
 import { c4Commands } from './commands.js';
 import { C4_BOARD_LEVEL_MENU } from './levels.js';
@@ -21,7 +21,13 @@ import { C4_RULES } from './rules.js';
  * means the day one of them gains a declared label the manifest already names
  * it — which is the whole reason these lists are derived rather than written.
  */
-export const c4TranslationEntries = mergeTranslationEntries(commandTranslationEntries(c4Commands), collectTranslationKeys('role', C4_ROLES), collectTranslationKeys('background', [
+export const c4TranslationEntries = mergeTranslationEntries(commandTranslationEntries(c4Commands), 
+// The catalogue's own group headers, derived from the very categories
+// these commands declare. They ship WITH the framework because core's
+// registry names no framework category in the bundled distribution, so a
+// host that composed core's manifest alone drew translated entries under
+// English headers (#183).
+commandCategoryTranslationEntries(c4Commands), collectTranslationKeys('role', C4_ROLES), collectTranslationKeys('background', [
     C4_BOARD_BACKGROUND,
     C4_BOUNDARY_BACKGROUND,
     // The LEVEL a board declares, and the words the picker offers it under.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@formicoidea/labre-framework-c4",
   "description": "Labre c4 framework for @formicoidea/labre-core.",
-  "version": "0.33.0",
+  "version": "0.34.1",
   "type": "module",
   "sideEffects": false,
   "author": "lajola",
@@ -21,14 +21,18 @@
     "./descriptor": {
       "types": "./dist/descriptor.d.ts",
       "import": "./dist/descriptor.js"
+    },
+    "./commands-manifest": {
+      "types": "./dist/commands-manifest.d.ts",
+      "import": "./dist/commands-manifest.js"
     }
   },
   "files": [
     "dist"
   ],
   "dependencies": {
-    "@formicoidea/labre-core": "0.33.0",
-    "@formicoidea/labre-ddd-shared": "0.33.0",
+    "@formicoidea/labre-core": "0.34.1",
+    "@formicoidea/labre-ddd-shared": "0.34.1",
     "lit": "^3.2.0"
   }
 }