@formicoidea/labre-framework-bpmn 0.36.0 → 0.37.0

package/dist/index.d.ts

@@ -12,3 +12,4 @@ export { BPMN_PROFILES } from './profiles.js';
 export { BPMN_ROLE, BPMN_ROLE_OF_KIND, BPMN_ROLES, type BpmnRole, type BpmnRoleId, } from './roles.js';
 export { BPMN_RULES, BPMN_SEQUENCE_MATRIX } from './rules.js';
 export { bpmnTranslationEntries } from './translations.js';
+export { BPMN_ANNOTATION_READING, BPMN_DATA_READING, BPMN_GROUP_READING, BPMN_READING, BPMN_READINGS, } from './reading.js';

package/dist/index.js

@@ -47,3 +47,4 @@ export { BPMN_PROFILES } from './profiles.js';
 export { BPMN_ROLE, BPMN_ROLE_OF_KIND, BPMN_ROLES, } from './roles.js';
 export { BPMN_RULES, BPMN_SEQUENCE_MATRIX } from './rules.js';
 export { bpmnTranslationEntries } from './translations.js';
+export { BPMN_ANNOTATION_READING, BPMN_DATA_READING, BPMN_GROUP_READING, BPMN_READING, BPMN_READINGS, } from './reading.js';

package/dist/reading.d.ts

@@ -0,0 +1,16 @@
+import type { ReadingProfile } from '@formicoidea/labre-core/blocks/surface';
+/** Events, activities and gateways — the three families that ARE the process. */
+export declare const BPMN_READING: ReadingProfile;
+/**
+ * The paperwork: a data object and a data store.
+ *
+ * No relation — a data object is tied to the work by an ASSOCIATION, which
+ * declares no verb and no direction, so there is no sentence to read off it.
+ */
+export declare const BPMN_DATA_READING: ReadingProfile;
+/** A note on the picture. Readable, so a reader can link it to a record. */
+export declare const BPMN_ANNOTATION_READING: ReadingProfile;
+/** A lasso round part of the picture. Parent-less by spec, hence its own row. */
+export declare const BPMN_GROUP_READING: ReadingProfile;
+/** Every BPMN profile, in the order the view extension registers them. */
+export declare const BPMN_READINGS: readonly ReadingProfile[];

package/dist/reading.js

@@ -0,0 +1,102 @@
+import { BPMN_ROLE, BPMN_ROLES } from './roles.js';
+/**
+ * What BPMN lets the tool read of an artefact (MF3, the reversed reading).
+ *
+ * DATA, like the rules and the profiles beside it: the engine
+ * (`@labre/affine-block-surface`) knows how to read a role and a typed edge — it
+ * knows nothing about BPMN. Everything below is already stated in `roles.ts` and
+ * is merely POINTED AT here.
+ *
+ * Registered from the FLAG-GATED view extension: reading a process is tooling,
+ * so a pool whose BPMN flag is off keeps every element it has and simply stops
+ * being read (ADR 0009).
+ *
+ * ## FOUR profiles, because BPMN has four parent-less node families
+ *
+ * The vocabulary is deliberately a forest and not a tree — `roles.ts` spells out
+ * why, family by family: the paperwork is not the work, commentary is never
+ * evidence, and BPMN 2.0.2 §10.4 exempts the group from every containment
+ * constraint there is. A single `appliesTo` would therefore have needed a
+ * `bpmn:artefact` root that the notation does not have, and inventing a role is
+ * the one thing ADR 0007 forbids: an id is forever, and a vocabulary is not a
+ * place to put a convenience.
+ *
+ * So each family declares its own profile, with an id of its own (the DI keys on
+ * it and throws on a duplicate). Only the pool is left out, and only because it
+ * is the FRAME: a reading is about an artefact, never about the lane it is drawn
+ * in.
+ *
+ * ## The sequence flow is the only relation read
+ *
+ * Of the three connecting objects, only `bpmn:sequence-flow` orders anything. A
+ * message flow says who told whom and a plain association says "this note is
+ * about that", both of which read identically from either end — and the
+ * association declares no `direction` for exactly that reason. Reading them
+ * under the sequence flow's two words would put a sentence in the panel that
+ * the notation never said.
+ *
+ * ## No nature, no phase
+ *
+ * BPMN ships no type-3 tag pack: its kinds ARE the roles, and the panel says
+ * them on the type line, chain included ("Message start event › Start event ›
+ * Event › Flow object"). And a pool's lanes are participants, not zones on a
+ * plotted axis, so there is nothing a position could be read against yet.
+ */
+/**
+ * The two words a sequence flow is read with, from the subject's end.
+ *
+ * ADR 0010 tier 2 on this role: the verb is "is followed by", so the SOURCE is
+ * what happens first. An edge leaving the subject therefore names what comes
+ * next, and one arriving names what came before.
+ */
+const SEQUENCE_SIDES = {
+    consumer: {
+        labelKey: 'com.labre.bpmn.reading.relations.consumer',
+        labelFallback: 'Preceded by',
+    },
+    supplier: {
+        labelKey: 'com.labre.bpmn.reading.relations.supplier',
+        labelFallback: 'Followed by',
+    },
+};
+/** Events, activities and gateways — the three families that ARE the process. */
+export const BPMN_READING = {
+    id: 'bpmn',
+    framework: 'bpmn',
+    roles: BPMN_ROLES,
+    appliesTo: BPMN_ROLE.flowObject,
+    relation: { edgeRole: BPMN_ROLE.sequenceFlow, sides: SEQUENCE_SIDES },
+};
+/**
+ * The paperwork: a data object and a data store.
+ *
+ * No relation — a data object is tied to the work by an ASSOCIATION, which
+ * declares no verb and no direction, so there is no sentence to read off it.
+ */
+export const BPMN_DATA_READING = {
+    id: 'bpmn-data',
+    framework: 'bpmn',
+    roles: BPMN_ROLES,
+    appliesTo: BPMN_ROLE.data,
+};
+/** A note on the picture. Readable, so a reader can link it to a record. */
+export const BPMN_ANNOTATION_READING = {
+    id: 'bpmn-annotation',
+    framework: 'bpmn',
+    roles: BPMN_ROLES,
+    appliesTo: BPMN_ROLE.textAnnotation,
+};
+/** A lasso round part of the picture. Parent-less by spec, hence its own row. */
+export const BPMN_GROUP_READING = {
+    id: 'bpmn-group',
+    framework: 'bpmn',
+    roles: BPMN_ROLES,
+    appliesTo: BPMN_ROLE.group,
+};
+/** Every BPMN profile, in the order the view extension registers them. */
+export const BPMN_READINGS = [
+    BPMN_READING,
+    BPMN_DATA_READING,
+    BPMN_ANNOTATION_READING,
+    BPMN_GROUP_READING,
+];

package/dist/translations.js

@@ -3,6 +3,7 @@ import { bpmnCommands } from './commands.js';
 import { NODE_LABEL, nodeLabelKey } from './consts.js';
 import { BPMN_IMPORT_REMARKS } 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';
 /**
@@ -47,4 +48,9 @@ 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(), importRemarkEntries(), 
+// 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
+// occurrence, which is what makes each key report the source it comes from.
+collectTranslationKeys('reading', BPMN_READINGS));

package/dist/view.js

@@ -1,4 +1,4 @@
-import { FrameworkBackgroundInteractionExtension, InterchangeExtension, morphToolbarConfig, ValidationProfileExtension, ValidationRuleExtension, validationToolbarConfig, } from '@formicoidea/labre-core/blocks/surface';
+import { FrameworkBackgroundInteractionExtension, InterchangeExtension, morphToolbarConfig, ReadingProfileExtension, ValidationProfileExtension, ValidationRuleExtension, validationToolbarConfig, } from '@formicoidea/labre-core/blocks/surface';
 import { ViewExtensionProvider, } from '@formicoidea/labre-core/ext-loader';
 import { extendTemplateCategory } from '@formicoidea/labre-core/gfx/template';
 import { ToolbarModuleExtension } from '@formicoidea/labre-core/shared/services';
@@ -10,6 +10,7 @@ import { effects } from './effects.js';
 import { BPMN_INTERCHANGE } from './interchange.js';
 import { BPMN_MORPH_SPEC } from './morph.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 { bpmnTemplateCategory } from './templates/index.js';
@@ -114,6 +115,15 @@ export class BpmnViewExtension extends ViewExtensionProvider {
                 id: BlockFlavourIdentifier('affine:surface:bpmnNode'),
                 config: morphToolbarConfig(BPMN_MORPH_SPEC),
             }));
+            // The reversed reading (MF3): what the process says about an artefact, on
+            // demand. Four profiles because BPMN has four parent-less node families
+            // (`reading.ts` says why the notation refuses a common root). The CLICK
+            // that triggers it is registered once by the surface and gated by the
+            // presence of a profile, so it goes with the flag without either side
+            // naming the other.
+            for (const reading of BPMN_READINGS) {
+                context.register(ReadingProfileExtension(reading));
+            }
             context.register(bpmnSeniorTool);
             context.register(CommandExtension(bpmnCommands, bpmnCommandIcons));
         }

package/package.json

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