@formicoidea/labre-framework-bpmn 0.40.0 → 0.41.0

package/dist/templates/index.js

@@ -1,9 +1,81 @@
 import { makeTemplateSnapshot, surfaceText, templateFromCommand, } from '@formicoidea/labre-core/gfx/template';
 import { ConnectorMode, PointStyle, StrokeStyle, } from '@formicoidea/labre-core/model';
+import { translateKey, } from '@formicoidea/labre-core/shared/services';
 import { bpmnCommands } from '../commands.js';
 import { EVENT_END, EVENT_START, GROUP_STROKE, MESSAGE_STROKE, MESSAGE_WIDTH, NEUTRAL_STROKE, NODE_SIZE, POOL_BAND_FILL, POOL_FRAME_COLOR, SEQUENCE_STROKE, SEQUENCE_WIDTH, } from '../consts.js';
 import { bpmnNodeProps, bpmnPoolProps } from '../presets.js';
 import { BPMN_ROLE } from '../roles.js';
+/**
+ * The seeds the two worked scenes write — declared once so the scene builder
+ * and the manifest ({@link ../translations.ts}) read the very same fallback,
+ * never a restated literal. `com.labre.bpmn.example.<scene>.<slug>`, per
+ * `docs/adr/0016`.
+ */
+export const SIMPLE_PROCESS_SEED = {
+    poolName: {
+        key: 'com.labre.bpmn.example.simple-process.pool-name',
+        fallback: 'Process',
+    },
+    submitRequest: {
+        key: 'com.labre.bpmn.example.simple-process.submit-request',
+        fallback: 'Submit request',
+    },
+    fulfil: {
+        key: 'com.labre.bpmn.example.simple-process.fulfil',
+        fallback: 'Fulfil',
+    },
+    reject: {
+        key: 'com.labre.bpmn.example.simple-process.reject',
+        fallback: 'Reject',
+    },
+};
+/**
+ * The two worked scenes' and the free-standing "Sequence flow" swatch's own
+ * tile names — a `nameKey` per hand-composed card, since none of the three
+ * derives from a command (`Template.nameKey`; `resolveTemplateName` checks it
+ * BEFORE `commandId`). `com.labre.bpmn.template.<slug>`, distinct from the
+ * `com.labre.bpmn.example.<scene>.*` seeds the two scenes WRITE — a tile name
+ * is chrome (re-rendered every time the panel opens), a seed is content
+ * (translated once, at insertion).
+ */
+export const BPMN_TEMPLATE_NAME_SIMPLE_PROCESS = [
+    'com.labre.bpmn.template.simple-process',
+    'Simple process',
+];
+export const BPMN_TEMPLATE_NAME_MESSAGE_EXCHANGE = [
+    'com.labre.bpmn.template.message-exchange',
+    'Message exchange',
+];
+export const BPMN_TEMPLATE_NAME_SEQUENCE_FLOW = [
+    'com.labre.bpmn.template.sequence-flow',
+    'Sequence flow',
+];
+export const MESSAGE_EXCHANGE_SEED = {
+    customer: {
+        key: 'com.labre.bpmn.example.message-exchange.customer',
+        fallback: 'Customer',
+    },
+    supplier: {
+        key: 'com.labre.bpmn.example.message-exchange.supplier',
+        fallback: 'Supplier',
+    },
+    placeOrder: {
+        key: 'com.labre.bpmn.example.message-exchange.place-order',
+        fallback: 'Place order',
+    },
+    confirmOrder: {
+        key: 'com.labre.bpmn.example.message-exchange.confirm-order',
+        fallback: 'Confirm order',
+    },
+};
+/**
+ * One seed's resolved text — the host's catalogue when `std` is a real
+ * inserting editor, the English fallback when building the module's own
+ * `content` (no editor exists yet at that point).
+ */
+function seedText(std, def) {
+    return std ? translateKey(std, def.key, def.fallback) : def.fallback;
+}
 /**
  * The BPMN palette — DERIVED from the toolbox, one template per artefact
  * command.
@@ -172,28 +244,39 @@ const previews = {
     messageExchange: `<svg ${A} fill="none"><rect x="14" y="8" width="107" height="27" rx="3" stroke="${POOL_FRAME_COLOR}" stroke-width="1.6"/><rect x="14" y="8" width="11" height="27" fill="${POOL_BAND_FILL}"/><path d="M25 8 V35" stroke="${POOL_FRAME_COLOR}" stroke-width="1.4"/><rect x="14" y="45" width="107" height="27" rx="3" stroke="${POOL_FRAME_COLOR}" stroke-width="1.6"/><rect x="14" y="45" width="11" height="27" fill="${POOL_BAND_FILL}"/><path d="M25 45 V72" stroke="${POOL_FRAME_COLOR}" stroke-width="1.4"/><circle cx="33" cy="21.5" r="4.5" stroke="${EVENT_START}" stroke-width="1.6"/><rect x="46" y="14" width="26" height="15" rx="3" stroke="${NEUTRAL_STROKE}" stroke-width="1.6"/><circle cx="88" cy="21.5" r="4.5" stroke="${EVENT_END}" stroke-width="2.6"/><rect x="46" y="51" width="26" height="15" rx="3" stroke="${NEUTRAL_STROKE}" stroke-width="1.6"/><path d="M41 21.5 H46 M72 21.5 H83" stroke="${SEQUENCE_STROKE}" stroke-width="1.4"/><circle cx="59" cy="31.5" r="2.2" fill="${MESSAGE_STROKE}"/><path d="M59 34 V48" stroke="${MESSAGE_STROKE}" stroke-width="1.4" stroke-dasharray="3 2.4"/><path d="M56 46 L59 50 L62 46" stroke="${MESSAGE_STROKE}" stroke-width="1.4" stroke-linecap="round" stroke-linejoin="round"/></svg>`,
 };
 /* ── The two worked scenes ────────────────────────────────────────────────── */
-/** A hand-composed card — what is left once the artefacts are derived. */
-const scene = (name, preview, elements) => ({
+/**
+ * A hand-composed card — what is left once the artefacts are derived.
+ *
+ * `build` takes the OPTIONAL inserting editor: called with none, at module
+ * load, for the English `content`; called again with the real `std` as
+ * {@link Template.localize}, so the two builds read the very same layout and
+ * differ only in the words a seed resolves to (`docs/adr/0016`).
+ */
+const scene = (name, preview, build, nameKey) => ({
     name,
     type: 'template',
     preview,
-    content: makeTemplateSnapshot(elements, name),
+    nameKey,
+    content: makeTemplateSnapshot(build(), name),
+    localize: std => makeTemplateSnapshot(build(std), name),
 });
-const process = {
-    pool: pool(0, 0, 640, 200, 'Process'),
-    start: node('startEvent', 40, 72),
-    task1: node('task', 116, 64, 'Submit request'),
-    gw: node('gatewayExclusive', 272, 64),
-    task2: node('task', 376, 20, 'Fulfil'),
-    task3: node('task', 376, 124, 'Reject'),
-    end: node('endEvent', 556, 72),
-    c1: seq('start', 'task1'),
-    c2: seq('task1', 'gw'),
-    c3: seq('gw', 'task2'),
-    c4: seq('gw', 'task3'),
-    c5: seq('task2', 'end'),
-    c6: seq('task3', 'end'),
-};
+function process(std) {
+    return {
+        pool: pool(0, 0, 640, 200, seedText(std, SIMPLE_PROCESS_SEED.poolName)),
+        start: node('startEvent', 40, 72),
+        task1: node('task', 116, 64, seedText(std, SIMPLE_PROCESS_SEED.submitRequest)),
+        gw: node('gatewayExclusive', 272, 64),
+        task2: node('task', 376, 20, seedText(std, SIMPLE_PROCESS_SEED.fulfil)),
+        task3: node('task', 376, 124, seedText(std, SIMPLE_PROCESS_SEED.reject)),
+        end: node('endEvent', 556, 72),
+        c1: seq('start', 'task1'),
+        c2: seq('task1', 'gw'),
+        c3: seq('gw', 'task2'),
+        c4: seq('gw', 'task3'),
+        c5: seq('task2', 'end'),
+        c6: seq('task3', 'end'),
+    };
+}
 /**
  * Two participants, and the one arrow that is allowed to cross between them.
  *
@@ -216,30 +299,34 @@ const process = {
  * until this slice ran the rules over the shipped cards. The customer's process
  * now closes where it should: order placed, then done.
  */
-const messageExchange = {
-    customer: pool(0, 0, 640, 200, 'Customer'),
-    supplier: pool(0, 240, 640, 200, 'Supplier'),
-    start: node('startEvent', 40, 72),
-    ask: node('taskUser', 140, 64, 'Place order'),
-    done: node('endEvent', 320, 72),
-    answer: node('taskService', 140, 304, 'Confirm order'),
-    // Inside the first participant: what happens, and in what order.
-    inside: seq('start', 'ask'),
-    closes: seq('ask', 'done'),
-    // Across the two: who told whom.
-    across: msg('ask', 'answer'),
-};
+function messageExchange(std) {
+    return {
+        customer: pool(0, 0, 640, 200, seedText(std, MESSAGE_EXCHANGE_SEED.customer)),
+        supplier: pool(0, 240, 640, 200, seedText(std, MESSAGE_EXCHANGE_SEED.supplier)),
+        start: node('startEvent', 40, 72),
+        ask: node('taskUser', 140, 64, seedText(std, MESSAGE_EXCHANGE_SEED.placeOrder)),
+        done: node('endEvent', 320, 72),
+        answer: node('taskService', 140, 304, seedText(std, MESSAGE_EXCHANGE_SEED.confirmOrder)),
+        // Inside the first participant: what happens, and in what order.
+        inside: seq('start', 'ask'),
+        closes: seq('ask', 'done'),
+        // Across the two: who told whom.
+        across: msg('ask', 'answer'),
+    };
+}
 export const bpmnTemplateCategory = {
     name: 'BPMN',
+    // Reuses the senior button's own key — see `TemplateCategory.nameKey`.
+    nameKey: 'com.labre.framework.bpmn',
     templates: [
-        scene('Simple process', previews.process, process),
-        scene('Message exchange', previews.messageExchange, messageExchange),
+        scene('Simple process', previews.process, process, BPMN_TEMPLATE_NAME_SIMPLE_PROCESS[0]),
+        scene('Message exchange', previews.messageExchange, messageExchange, BPMN_TEMPLATE_NAME_MESSAGE_EXCHANGE[0]),
         /* ── The core: a drawable process, from the first click ─────────────── */
         templateFromCommand(byId('bpmn.addStartEvent'), previews.startEvent),
         templateFromCommand(byId('bpmn.addEndEvent'), previews.endEvent),
         templateFromCommand(byId('bpmn.addTask'), previews.task),
         templateFromCommand(byId('bpmn.addExclusiveGateway'), previews.gateway),
-        scene('Sequence flow', previews.sequence, { a: freeSeq() }),
+        scene('Sequence flow', previews.sequence, () => ({ a: freeSeq() }), BPMN_TEMPLATE_NAME_SEQUENCE_FLOW[0]),
         templateFromCommand(byId('bpmn.addPool'), previews.pool),
         /* ── Activities ─────────────────────────────────────────────────────── */
         templateFromCommand(byId('bpmn.addUserTask'), previews.taskUser),

package/dist/translations.js

@@ -1,11 +1,13 @@
 import { collectTranslationKeys, commandCategoryTranslationEntries, commandTranslationEntries, mergeTranslationEntries, } from '@formicoidea/labre-core/std';
 import { bpmnCommands } from './commands.js';
-import { NODE_LABEL, nodeLabelKey } from './consts.js';
-import { BPMN_IMPORT_REMARKS } from './import.js';
+import { LANE_NAME_FALLBACK, LANE_NAME_KEY, NODE_LABEL, nodeLabelKey, POOL_NAME_FALLBACK, POOL_NAME_KEY, } from './consts.js';
+import { BPMN_EXPORT_WARNING_KEYS } from './export.js';
+import { BPMN_IMPORT_ERRORS, BPMN_IMPORT_REMARKS, BPMN_QUARANTINE_REASON, BPMN_QUARANTINE_REASON_KEY, } from './import.js';
 import { BPMN_PROFILES } from './profiles.js';
 import { BPMN_READINGS } from './reading.js';
 import { BPMN_ROLES } from './roles.js';
 import { BPMN_RULES } from './rules.js';
+import { BPMN_TEMPLATE_NAME_MESSAGE_EXCHANGE, BPMN_TEMPLATE_NAME_SEQUENCE_FLOW, BPMN_TEMPLATE_NAME_SIMPLE_PROCESS, MESSAGE_EXCHANGE_SEED, SIMPLE_PROCESS_SEED, } from './templates/index.js';
 /**
  * The captions a placed artefact is seeded with, and the fixed-wording remarks
  * an import can produce — the two families of BPMN prose that live in tables
@@ -28,6 +30,66 @@ const importRemarkEntries = () => Object.values(BPMN_IMPORT_REMARKS).map(([key,
     fallback: english,
     source: 'chrome',
 }));
+/**
+ * The reader's own refusals ({@link BPMN_IMPORT_ERRORS}) — thrown via
+ * `InterchangeImportError`, chrome like the remarks above for the same
+ * reason: re-rendered by the catch site every time, never written into a
+ * document.
+ */
+const importErrorEntries = () => Object.values(BPMN_IMPORT_ERRORS).map(([key, english]) => ({
+    key,
+    fallback: english,
+    source: 'chrome',
+}));
+/**
+ * {@link BPMN_QUARANTINE_REASON}'s own four keys — a report note about
+ * material the import kept but will never write back (D5), fixed wording like
+ * the three remarks above and for the same reason: nothing in any of the four
+ * sentences names anything out of the file.
+ */
+const quarantineReasonEntries = () => Object.keys(BPMN_QUARANTINE_REASON).map(reason => ({
+    key: BPMN_QUARANTINE_REASON_KEY[reason],
+    fallback: BPMN_QUARANTINE_REASON[reason],
+    source: 'chrome',
+}));
+/**
+ * The nine export-warning keys ({@link BPMN_EXPORT_WARNING_KEYS}) — a report
+ * built from the board rather than written into it, so `chrome` like the
+ * import remarks above and not `seed`.
+ */
+const exportWarningEntries = () => BPMN_EXPORT_WARNING_KEYS.map(([key, fallback]) => ({
+    key,
+    fallback,
+    source: 'chrome',
+}));
+/**
+ * The pool's own default name and a fresh lane's, resolved at placement
+ * exactly like {@link seedEntries} — the fallback IS `POOL_NAME_FALLBACK` /
+ * `LANE_NAME_FALLBACK`, never restated.
+ */
+const furnitureSeedEntries = () => [
+    { key: POOL_NAME_KEY, fallback: POOL_NAME_FALLBACK, source: 'seed' },
+    { key: LANE_NAME_KEY, fallback: LANE_NAME_FALLBACK, source: 'seed' },
+];
+/**
+ * The seeds the two worked-example scenes write — derived from the very
+ * tables `templates/index.ts` reads at placement, so the words a host is
+ * offered are the words the card would insert.
+ */
+const exampleSeedEntries = () => [
+    ...Object.values(SIMPLE_PROCESS_SEED),
+    ...Object.values(MESSAGE_EXCHANGE_SEED),
+].map(({ key, fallback }) => ({ key, fallback, source: 'seed' }));
+/**
+ * The three hand-composed cards' own tile names — chrome, not seeds: a
+ * `Template.nameKey`, re-resolved every time the panel opens, never written
+ * into a document. See `templates/index.ts`.
+ */
+const templateNameEntries = () => [
+    BPMN_TEMPLATE_NAME_SIMPLE_PROCESS,
+    BPMN_TEMPLATE_NAME_MESSAGE_EXCHANGE,
+    BPMN_TEMPLATE_NAME_SEQUENCE_FLOW,
+].map(([key, fallback]) => ({ key, fallback, source: 'chrome' }));
 /**
  * THIS framework's contribution to the translation-key manifest — every
  * `com.labre.*` key BPMN can hand to `TranslationProvider.t`, derived from the
@@ -48,7 +110,7 @@ export const bpmnTranslationEntries = mergeTranslationEntries(commandTranslation
 // 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(bpmnCommands), collectTranslationKeys('role', BPMN_ROLES), collectTranslationKeys('rule', BPMN_RULES), collectTranslationKeys('profile', BPMN_PROFILES), seedEntries(), importRemarkEntries(), 
+commandCategoryTranslationEntries(bpmnCommands), collectTranslationKeys('role', BPMN_ROLES), collectTranslationKeys('rule', BPMN_RULES), collectTranslationKeys('profile', BPMN_PROFILES), seedEntries(), furnitureSeedEntries(), exampleSeedEntries(), templateNameEntries(), importRemarkEntries(), importErrorEntries(), quarantineReasonEntries(), exportWarningEntries(), 
 // LAST, and the order is load-bearing: a reading profile carries the
 // framework's own `roles`, so walking it reaches every role key the `role`
 // line above already named. `mergeTranslationEntries` keeps the FIRST

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@formicoidea/labre-framework-bpmn",
   "description": "Labre bpmn framework for @formicoidea/labre-core.",
-  "version": "0.40.0",
+  "version": "0.41.0",
   "type": "module",
   "sideEffects": false,
   "author": "lajola",
@@ -31,7 +31,7 @@
     "dist"
   ],
   "dependencies": {
-    "@formicoidea/labre-core": "0.40.0",
+    "@formicoidea/labre-core": "0.41.0",
     "lit": "^3.2.0"
   }
 }