@formicoidea/labre-framework-cynefin 0.31.0 → 0.32.0

package/dist/actions.d.ts

@@ -0,0 +1,4 @@
+import type { BlockStdScope } from '@formicoidea/labre-core/std';
+export declare function createCynefin(std: BlockStdScope): void;
+export declare function createEstuarineMap(std: BlockStdScope): void;
+export declare function createConstraintHexagon(std: BlockStdScope): void;

package/dist/actions.js

@@ -0,0 +1,65 @@
+import { DefaultTool } from '@formicoidea/labre-core/blocks/surface';
+import { ShapeStyle, TextFitMode } from '@formicoidea/labre-core/model';
+import { Bound } from '@formicoidea/labre-core/global/gfx';
+import { GfxControllerIdentifier } from '@formicoidea/labre-core/std/gfx';
+import { REF_H as CYN_H, REF_W as CYN_W } from './cynefin/consts.js';
+import { HEX_FILL, HEX_SIZE, HEX_STROKE, HEX_VERTICES, REF_H as EST_H, REF_W as EST_W, } from './estuarine/consts.js';
+/**
+ * Creation actions for the Cynefin / Estuarine toolbox — lifted out of
+ * `toolbar/menu.ts` by PF3. This is also the framework that emitted NO
+ * telemetry at all before the switchover: routing every surface through
+ * `runCommand` fixes that for free (`docs/adr/0008`).
+ */
+/** Estuarine map default size (REF aspect, scaled up so it reads on canvas). */
+const MAP_SCALE = 1.2;
+const gfxOf = (std) => std.get(GfxControllerIdentifier);
+function finish(gfx, id) {
+    gfx.doc.captureSync();
+    gfx.tool.setTool(DefaultTool);
+    gfx.selection.set({ elements: [id], editing: false });
+}
+export function createCynefin(std) {
+    const gfx = gfxOf(std);
+    if (!gfx.surface)
+        return;
+    const { centerX, centerY } = gfx.viewport;
+    const id = gfx.surface.addElement({
+        type: 'cynefin',
+        xywh: new Bound(centerX - CYN_W / 2, centerY - CYN_H / 2, CYN_W, CYN_H).serialize(),
+    });
+    finish(gfx, id);
+}
+export function createEstuarineMap(std) {
+    const gfx = gfxOf(std);
+    if (!gfx.surface)
+        return;
+    const width = EST_W * MAP_SCALE;
+    const height = EST_H * MAP_SCALE;
+    const { centerX, centerY } = gfx.viewport;
+    const id = gfx.surface.addElement({
+        type: 'estuarine',
+        xywh: new Bound(centerX - width / 2, centerY - height / 2, width, height).serialize(),
+    });
+    finish(gfx, id);
+}
+export function createConstraintHexagon(std) {
+    const gfx = gfxOf(std);
+    if (!gfx.surface)
+        return;
+    const { centerX: cx, centerY: cy } = gfx.viewport;
+    const id = gfx.surface.addElement({
+        type: 'shape',
+        shapeType: 'polygon',
+        vertices: HEX_VERTICES,
+        filled: true,
+        fillColor: HEX_FILL,
+        strokeColor: HEX_STROKE,
+        strokeWidth: 2,
+        shapeStyle: ShapeStyle.General,
+        roughness: 0,
+        // hexi constraints behave like post-its: fixed hex, text shrinks
+        textFitMode: TextFitMode.Contained,
+        xywh: new Bound(cx - HEX_SIZE / 2, cy - HEX_SIZE / 2, HEX_SIZE, HEX_SIZE).serialize(),
+    });
+    finish(gfx, id);
+}

package/dist/commands.d.ts

@@ -0,0 +1,4 @@
+import type { CommandDescriptor } from '@formicoidea/labre-core/std';
+import type { TemplateResult } from 'lit';
+export declare const cynefinEstuarineCommands: CommandDescriptor[];
+export declare const cynefinEstuarineCommandIcons: Record<string, TemplateResult>;

package/dist/commands.js

@@ -0,0 +1,46 @@
+import { createConstraintHexagon, createCynefin, createEstuarineMap, } from './actions.js';
+import { cynefinMenuIcon, estuarineMenuIcon, hexagonMenuIcon, } from './toolbar/icons.js';
+const SPECS = [
+    {
+        id: 'addCynefin',
+        label: 'Cynefin framework',
+        iconKey: 'cynefin.frame',
+        element: 'cynefin',
+        run: createCynefin,
+    },
+    {
+        id: 'addEstuarineMap',
+        label: 'Estuarine map',
+        iconKey: 'estuarine.map',
+        element: 'estuarine',
+        run: createEstuarineMap,
+    },
+    {
+        id: 'addConstraintHexagon',
+        label: 'Hexagon node',
+        iconKey: 'estuarine.hexagon',
+        element: 'node:hexagon',
+        run: createConstraintHexagon,
+    },
+];
+export const cynefinEstuarineCommands = SPECS.map((spec, order) => ({
+    id: `cynefin-estuarine.${spec.id}`,
+    owner: 'cynefin-estuarine',
+    kind: 'artefact',
+    labelKey: `com.labre.commands.cynefin-estuarine.${spec.id}`,
+    labelFallback: spec.label,
+    category: 'frames',
+    iconKey: spec.iconKey,
+    surfaces: ['senior-menu', 'catalogue', 'palette', 'agent'],
+    order,
+    scope: 'edgeless',
+    defaultKeys: { mac: [], other: [] },
+    availability: 'always',
+    run: spec.run,
+    telemetry: { framework: 'cynefin-estuarine', element: spec.element },
+}));
+export const cynefinEstuarineCommandIcons = {
+    'cynefin.frame': cynefinMenuIcon,
+    'estuarine.map': estuarineMenuIcon,
+    'estuarine.hexagon': hexagonMenuIcon,
+};

package/dist/descriptor.d.ts

@@ -1,7 +1,12 @@
-import { CynefinEstuarineViewExtension } from './view.js';
-/** Host wiring for the cynefin framework. */
+import { CynefinEstuarineRenderViewExtension, CynefinEstuarineViewExtension } from './view.js';
+/** Host wiring for the cynefin-estuarine framework. */
 export declare const cynefinFramework: {
     readonly flag: "cynefin-estuarine";
-    readonly telemetry: "cynefin";
-    readonly viewExtension: typeof CynefinEstuarineViewExtension;
+    readonly telemetryKey: "cynefin";
+    readonly extensions: readonly [{
+        readonly viewExtension: typeof CynefinEstuarineRenderViewExtension;
+    }, {
+        readonly flag: "cynefin-estuarine";
+        readonly viewExtension: typeof CynefinEstuarineViewExtension;
+    }];
 };

package/dist/descriptor.js

@@ -1,7 +1,10 @@
-import { CynefinEstuarineViewExtension } from './view.js';
-/** Host wiring for the cynefin framework. */
+import { CynefinEstuarineRenderViewExtension, CynefinEstuarineViewExtension } from './view.js';
+/** Host wiring for the cynefin-estuarine framework. */
 export const cynefinFramework = {
     flag: 'cynefin-estuarine',
-    telemetry: 'cynefin',
-    viewExtension: CynefinEstuarineViewExtension,
+    telemetryKey: 'cynefin',
+    extensions: [
+        { viewExtension: CynefinEstuarineRenderViewExtension },
+        { flag: 'cynefin-estuarine', viewExtension: CynefinEstuarineViewExtension },
+    ],
 };

package/dist/index.d.ts

@@ -1 +1,2 @@
-export {};
+export { cynefinEstuarineCommandIcons, cynefinEstuarineCommands, } from './commands.js';
+export { cynefinEstuarineTranslationEntries } from './translations.js';

package/dist/index.js

@@ -1 +1,2 @@
-export {};
+export { cynefinEstuarineCommandIcons, cynefinEstuarineCommands, } from './commands.js';
+export { cynefinEstuarineTranslationEntries } from './translations.js';

package/dist/toolbar/menu.d.ts

@@ -1,17 +1,11 @@
 import { EmptyTool } from '@formicoidea/labre-core/gfx/pointer';
-import { LitElement } from 'lit';
-declare const EdgelessCynefinEstuarineMenu_base: typeof LitElement & import("@formicoidea/labre-core/_pkgs/global/utils").Constructor<import("@formicoidea/labre-core/_pkgs/affine-widget-edgeless-toolbar").EdgelessToolbarToolClass>;
+import { EdgelessCommandMenu } from '@formicoidea/labre-core/widgets/edgeless-toolbar';
 /**
- * The popover above the toolbar hosting both frameworks: create the Cynefin
- * diagram, the Estuarine map, or a hexagon constraint node.
+ * The popover above the toolbar hosting both frameworks. Since PF3 it declares
+ * nothing: {@link EdgelessCommandMenu} renders `cynefinEstuarineCommands` for
+ * the `senior-menu` surface (`docs/adr/0008`).
  */
-export declare class EdgelessCynefinEstuarineMenu extends EdgelessCynefinEstuarineMenu_base {
-    static styles: import("lit").CSSResult;
+export declare class EdgelessCynefinEstuarineMenu extends EdgelessCommandMenu {
+    protected owner: "cynefin-estuarine";
     type: typeof EmptyTool;
-    private _finish;
-    private _createCynefin;
-    private _createMap;
-    private _createHexagon;
-    render(): import("lit-html").TemplateResult<1>;
 }
-export {};

package/dist/toolbar/menu.js

@@ -1,122 +1,14 @@
-import { DefaultTool } from '@formicoidea/labre-core/blocks/surface';
 import { EmptyTool } from '@formicoidea/labre-core/gfx/pointer';
-import { ShapeStyle, TextFitMode } from '@formicoidea/labre-core/model';
-import { EdgelessToolbarToolMixin } from '@formicoidea/labre-core/widgets/edgeless-toolbar';
-import { Bound } from '@formicoidea/labre-core/global/gfx';
-import { css, html, LitElement } from 'lit';
-import { REF_H as CYN_H, REF_W as CYN_W } from '../cynefin/consts.js';
-import { HEX_FILL, HEX_SIZE, HEX_STROKE, HEX_VERTICES, REF_H as EST_H, REF_W as EST_W, } from '../estuarine/consts.js';
-import { cynefinMenuIcon, estuarineMenuIcon, hexagonMenuIcon, } from './icons.js';
-/** Estuarine map default size (REF aspect, scaled up so it reads on canvas). */
-const MAP_SCALE = 1.2;
+import { EdgelessCommandMenu } from '@formicoidea/labre-core/widgets/edgeless-toolbar';
 /**
- * The popover above the toolbar hosting both frameworks: create the Cynefin
- * diagram, the Estuarine map, or a hexagon constraint node.
+ * The popover above the toolbar hosting both frameworks. Since PF3 it declares
+ * nothing: {@link EdgelessCommandMenu} renders `cynefinEstuarineCommands` for
+ * the `senior-menu` surface (`docs/adr/0008`).
  */
-export class EdgelessCynefinEstuarineMenu extends EdgelessToolbarToolMixin(LitElement) {
+export class EdgelessCynefinEstuarineMenu extends EdgelessCommandMenu {
     constructor() {
         super(...arguments);
+        this.owner = 'cynefin-estuarine';
         this.type = EmptyTool;
     }
-    static { this.styles = css `
-    :host {
-      display: flex;
-      z-index: -1;
-      justify-content: center;
-    }
-    .menu-content {
-      display: flex;
-      align-items: center;
-      justify-content: center;
-    }
-    .button-group-container {
-      display: flex;
-      align-items: center;
-      gap: 14px;
-      fill: var(--affine-icon-color);
-    }
-    .button-group-container svg {
-      width: 24px;
-      height: 24px;
-    }
-  `; }
-    _finish(id) {
-        const { gfx } = this;
-        gfx.doc.captureSync();
-        gfx.tool.setTool(DefaultTool);
-        gfx.selection.set({ elements: [id], editing: false });
-    }
-    _createCynefin() {
-        const { gfx } = this;
-        if (!gfx.surface)
-            return;
-        const { centerX, centerY } = gfx.viewport;
-        const id = gfx.surface.addElement({
-            type: 'cynefin',
-            xywh: new Bound(centerX - CYN_W / 2, centerY - CYN_H / 2, CYN_W, CYN_H).serialize(),
-        });
-        this._finish(id);
-    }
-    _createMap() {
-        const { gfx } = this;
-        if (!gfx.surface)
-            return;
-        const width = EST_W * MAP_SCALE;
-        const height = EST_H * MAP_SCALE;
-        const { centerX, centerY } = gfx.viewport;
-        const id = gfx.surface.addElement({
-            type: 'estuarine',
-            xywh: new Bound(centerX - width / 2, centerY - height / 2, width, height).serialize(),
-        });
-        this._finish(id);
-    }
-    _createHexagon() {
-        const { gfx } = this;
-        if (!gfx.surface)
-            return;
-        const { centerX: cx, centerY: cy } = gfx.viewport;
-        const id = gfx.surface.addElement({
-            type: 'shape',
-            shapeType: 'polygon',
-            vertices: HEX_VERTICES,
-            filled: true,
-            fillColor: HEX_FILL,
-            strokeColor: HEX_STROKE,
-            strokeWidth: 2,
-            shapeStyle: ShapeStyle.General,
-            roughness: 0,
-            // hexi constraints behave like post-its: fixed hex, text shrinks
-            textFitMode: TextFitMode.Contained,
-            xywh: new Bound(cx - HEX_SIZE / 2, cy - HEX_SIZE / 2, HEX_SIZE, HEX_SIZE).serialize(),
-        });
-        this._finish(id);
-    }
-    render() {
-        return html `
-      <edgeless-slide-menu>
-        <div class="menu-content">
-          <div class="button-group-container">
-            <edgeless-tool-icon-button
-              .tooltip=${'Cynefin framework'}
-              @click=${this._createCynefin}
-            >
-              ${cynefinMenuIcon}
-            </edgeless-tool-icon-button>
-            <edgeless-tool-icon-button
-              .tooltip=${'Estuarine map'}
-              @click=${this._createMap}
-            >
-              ${estuarineMenuIcon}
-            </edgeless-tool-icon-button>
-            <edgeless-tool-icon-button
-              .tooltip=${'Hexagon node'}
-              @click=${this._createHexagon}
-            >
-              ${hexagonMenuIcon}
-            </edgeless-tool-icon-button>
-          </div>
-        </div>
-      </edgeless-slide-menu>
-    `;
-    }
 }

package/dist/translations.d.ts

@@ -0,0 +1,14 @@
+import { type TranslationKeyManifestEntry } from '@formicoidea/labre-core/std';
+/**
+ * THIS framework's contribution to the translation-key manifest.
+ *
+ * Its command labels and descriptions are built from a TEMPLATE, so the
+ * concrete keys exist nowhere but in the declarations themselves and the
+ * core manifest could not restate them even if it wanted to. The
+ * contribution therefore ships WITH the framework: in the bundled
+ * distribution `@formicoidea/labre-framework-cynefin` carries it, and a host
+ * composes it into its catalogue exactly as it already composes
+ * `cynefinEstuarineCommands` into the command registry. See
+ * `packages/affine/all/src/translations.ts`.
+ */
+export declare const cynefinEstuarineTranslationEntries: TranslationKeyManifestEntry[];

package/dist/translations.js

@@ -0,0 +1,15 @@
+import { commandTranslationEntries, } from '@formicoidea/labre-core/std';
+import { cynefinEstuarineCommands } from './commands.js';
+/**
+ * THIS framework's contribution to the translation-key manifest.
+ *
+ * Its command labels and descriptions are built from a TEMPLATE, so the
+ * concrete keys exist nowhere but in the declarations themselves and the
+ * core manifest could not restate them even if it wanted to. The
+ * contribution therefore ships WITH the framework: in the bundled
+ * distribution `@formicoidea/labre-framework-cynefin` carries it, and a host
+ * composes it into its catalogue exactly as it already composes
+ * `cynefinEstuarineCommands` into the command registry. See
+ * `packages/affine/all/src/translations.ts`.
+ */
+export const cynefinEstuarineTranslationEntries = commandTranslationEntries(cynefinEstuarineCommands);

package/dist/view.d.ts

@@ -1,4 +1,19 @@
 import { type ViewExtensionContext, ViewExtensionProvider } from '@formicoidea/labre-core/ext-loader';
+/**
+ * Cynefin / Estuarine rendering — ALWAYS registered, independent of any flag.
+ * Disabling `cynefin-estuarine` hides only the creation tooling (see
+ * {@link CynefinEstuarineViewExtension}); frames already drawn must still
+ * paint, stay selectable, stay editable and keep their contextual toolbar. See
+ * `docs/adr/0009`.
+ */
+export declare class CynefinEstuarineRenderViewExtension extends ViewExtensionProvider {
+    name: string;
+    setup(context: ViewExtensionContext): void;
+}
+/**
+ * Cynefin / Estuarine creation tooling — flag-gated (`cynefin-estuarine`): the
+ * senior toolbar button and both templates categories.
+ */
 export declare class CynefinEstuarineViewExtension extends ViewExtensionProvider {
     name: string;
     effect(): void;

package/dist/view.js

@@ -1,5 +1,7 @@
 import { ViewExtensionProvider, } from '@formicoidea/labre-core/ext-loader';
 import { extendTemplateCategory } from '@formicoidea/labre-core/gfx/template';
+import { CommandExtension } from '@formicoidea/labre-core/std';
+import { cynefinEstuarineCommandIcons, cynefinEstuarineCommands, } from './commands.js';
 import { CynefinRendererExtension } from './cynefin/element-renderer.js';
 import { CynefinInteraction, CynefinView } from './cynefin/element-view.js';
 import { cynefinToolbarExtension } from './cynefin/toolbar/config.js';
@@ -9,6 +11,36 @@ import { EstuarineInteraction, EstuarineView } from './estuarine/element-view.js
 import { estuarineToolbarExtension } from './estuarine/toolbar/config.js';
 import { cynefinTemplateCategory, estuarineTemplateCategory, } from './templates/index.js';
 import { cynefinEstuarineSeniorTool } from './toolbar/senior-tool.js';
+/**
+ * Cynefin / Estuarine rendering — ALWAYS registered, independent of any flag.
+ * Disabling `cynefin-estuarine` hides only the creation tooling (see
+ * {@link CynefinEstuarineViewExtension}); frames already drawn must still
+ * paint, stay selectable, stay editable and keep their contextual toolbar. See
+ * `docs/adr/0009`.
+ */
+export class CynefinEstuarineRenderViewExtension extends ViewExtensionProvider {
+    constructor() {
+        super(...arguments);
+        this.name = 'affine-cynefin-estuarine-render-gfx';
+    }
+    setup(context) {
+        super.setup(context);
+        context.register(CynefinView);
+        context.register(CynefinRendererExtension);
+        context.register(EstuarineView);
+        context.register(EstuarineRendererExtension);
+        if (this.isEdgeless(context.scope)) {
+            context.register(CynefinInteraction);
+            context.register(EstuarineInteraction);
+            context.register(cynefinToolbarExtension);
+            context.register(estuarineToolbarExtension);
+        }
+    }
+}
+/**
+ * Cynefin / Estuarine creation tooling — flag-gated (`cynefin-estuarine`): the
+ * senior toolbar button and both templates categories.
+ */
 export class CynefinEstuarineViewExtension extends ViewExtensionProvider {
     constructor() {
         super(...arguments);
@@ -16,22 +48,16 @@ export class CynefinEstuarineViewExtension extends ViewExtensionProvider {
     }
     effect() {
         super.effect();
+        // Defines the senior button and its menu — tooling-only custom elements.
         effects();
         extendTemplateCategory(cynefinTemplateCategory);
         extendTemplateCategory(estuarineTemplateCategory);
     }
     setup(context) {
         super.setup(context);
-        context.register(CynefinView);
-        context.register(CynefinRendererExtension);
-        context.register(EstuarineView);
-        context.register(EstuarineRendererExtension);
         if (this.isEdgeless(context.scope)) {
-            context.register(CynefinInteraction);
-            context.register(EstuarineInteraction);
             context.register(cynefinEstuarineSeniorTool);
-            context.register(cynefinToolbarExtension);
-            context.register(estuarineToolbarExtension);
+            context.register(CommandExtension(cynefinEstuarineCommands, cynefinEstuarineCommandIcons));
         }
     }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@formicoidea/labre-framework-cynefin",
-  "description": "Labre cynefin framework for @formicoidea/labre-core.",
-  "version": "0.31.0",
+  "description": "Labre cynefin-estuarine framework for @formicoidea/labre-core.",
+  "version": "0.32.0",
   "type": "module",
   "sideEffects": false,
   "author": "lajola",
@@ -27,7 +27,7 @@
     "dist"
   ],
   "dependencies": {
-    "@formicoidea/labre-core": "0.31.0",
+    "@formicoidea/labre-core": "0.32.0",
     "lit": "^3.2.0"
   }
 }