@formicoidea/labre-core 0.31.0 → 0.32.0

package/dist/schemas.js

@@ -2,45 +2,41 @@
 import { DataViewBlockSchema } from './_pkgs/affine-block-data-view/index.js';
 import { SurfaceBlockSchema } from './_pkgs/affine-block-surface/index.js';
 import { AttachmentBlockSchema, BookmarkBlockSchema, CalloutBlockSchema, CodeBlockSchema, DatabaseBlockSchema, DividerBlockSchema, EdgelessTextBlockSchema, EmbedFigmaBlockSchema, EmbedGithubBlockSchema, EmbedHtmlBlockSchema, EmbedLinkedDocBlockSchema, EmbedLoomBlockSchema, EmbedSyncedDocBlockSchema, EmbedYoutubeBlockSchema, FrameBlockSchema, ImageBlockSchema, LatexBlockSchema, ListBlockSchema, NoteBlockSchema, ParagraphBlockSchema, RootBlockSchema, SurfaceRefBlockSchema, TableBlockSchema, } from './_pkgs/affine-model/index.js';
-import { isBlockEnabled } from './flags.js';
 /**
- * First party block models built for affine, honoring block flags.
- * Omitted flags default to enabled; core blocks (root, surface, note,
- * paragraph) are always included. See {@link BlockFlags}.
+ * First party block models built for affine.
+ *
+ * Schemas are registered UNCONDITIONALLY: a flag gates tooling, never the
+ * ability to read a document (see {@link LabreFlags} and `docs/adr/0009`). The
+ * `flags` parameter is kept for source compatibility with callers written
+ * against the previous contract, and is deliberately ignored.
  */
-export function getAffineSchemas(flags) {
-    const on = (block) => isBlockEnabled(flags, block);
+export function getAffineSchemas(_flags) {
     return [
-        ...(on('code') ? [CodeBlockSchema] : []),
+        CodeBlockSchema,
         ParagraphBlockSchema,
         RootBlockSchema,
-        ...(on('list') ? [ListBlockSchema] : []),
+        ListBlockSchema,
         NoteBlockSchema,
-        ...(on('divider') ? [DividerBlockSchema] : []),
-        ...(on('image') ? [ImageBlockSchema] : []),
+        DividerBlockSchema,
+        ImageBlockSchema,
         SurfaceBlockSchema,
-        ...(on('bookmark') ? [BookmarkBlockSchema] : []),
-        ...(on('frame') ? [FrameBlockSchema] : []),
-        ...(on('database') ? [DatabaseBlockSchema] : []),
-        ...(on('surface-ref') ? [SurfaceRefBlockSchema] : []),
-        ...(on('data-view') ? [DataViewBlockSchema] : []),
-        ...(on('attachment') ? [AttachmentBlockSchema] : []),
-        ...(on('embed')
-            ? [
-                EmbedYoutubeBlockSchema,
-                EmbedFigmaBlockSchema,
-                EmbedGithubBlockSchema,
-                EmbedHtmlBlockSchema,
-            ]
-            : []),
-        ...(on('embed-doc')
-            ? [EmbedLinkedDocBlockSchema, EmbedSyncedDocBlockSchema]
-            : []),
-        ...(on('embed') ? [EmbedLoomBlockSchema] : []),
-        ...(on('edgeless-text') ? [EdgelessTextBlockSchema] : []),
-        ...(on('latex') ? [LatexBlockSchema] : []),
-        ...(on('table') ? [TableBlockSchema] : []),
-        ...(on('callout') ? [CalloutBlockSchema] : []),
+        BookmarkBlockSchema,
+        FrameBlockSchema,
+        DatabaseBlockSchema,
+        SurfaceRefBlockSchema,
+        DataViewBlockSchema,
+        AttachmentBlockSchema,
+        EmbedYoutubeBlockSchema,
+        EmbedFigmaBlockSchema,
+        EmbedGithubBlockSchema,
+        EmbedHtmlBlockSchema,
+        EmbedLinkedDocBlockSchema,
+        EmbedSyncedDocBlockSchema,
+        EmbedLoomBlockSchema,
+        EdgelessTextBlockSchema,
+        LatexBlockSchema,
+        TableBlockSchema,
+        CalloutBlockSchema,
     ];
 }
 /** Built-in first party block models built for affine */

package/dist/shortcuts.d.ts

@@ -1,24 +1,24 @@
 import type { ShortcutDescriptor } from './_pkgs/std/index.js';
-import { type BlockFlags, type OptionalBlock } from './flags.js';
+import type { LabreFlags } from './flags.js';
 /**
  * Manifest view of a shortcut: the metadata a host "Shortcuts" settings panel
  * needs, without the runtime `handler`.
+ *
+ * Since PF3 it is a projection of a projection: {@link CommandDescriptor} →
+ * {@link ShortcutDescriptor} → here. It KEEPS representing shortcuts and
+ * nothing else — no `iconKey`, no `category`; catalogue metadata travels on
+ * `CommandManifestEntry` (`docs/adr/0008` § Icons).
+ *
+ * Breaking shape change for hosts: `when?: string` is gone (no descriptor in
+ * the repo ever set it), `defaultKeys` is always present, and `owner` narrows
+ * from `string` to `CommandOwner`.
  */
 export type ShortcutManifestEntry = Omit<ShortcutDescriptor, 'handler'>;
-interface FrameworkShortcutGroup {
-    owner: OptionalBlock;
-    shortcuts: ShortcutDescriptor[];
-}
 /**
- * Pure aggregator (exported for testing): core shortcuts plus the shortcuts of
- * every framework group whose flag is enabled.
+ * The enumerable shortcut manifest for a given flag set. TOTAL over the command
+ * registry: every command yields a row, keyless ones included, so Settings ›
+ * Shortcuts can bind precisely the commands a user most wants to bind. The
+ * panel therefore grows from ~10 rows to the full command count — that is the
+ * intent, and `owner` grouping is what keeps it usable.
  */
-export declare function buildShortcutManifest(core: ShortcutDescriptor[], groups: FrameworkShortcutGroup[], flags?: BlockFlags): ShortcutManifestEntry[];
-/**
- * The enumerable shortcut manifest for a given flag set: core shortcuts plus
- * the shortcuts contributed by the currently-enabled frameworks. Enumerable
- * without an editor instance (for a settings panel). Mirrors the flag gating of
- * `getInternalViewExtensions`.
- */
-export declare function getShortcutManifest(flags?: BlockFlags): ShortcutManifestEntry[];
-export {};
+export declare function getShortcutManifest(flags?: LabreFlags): ShortcutManifestEntry[];

package/dist/shortcuts.js

@@ -1,47 +1,19 @@
-import { coreShortcuts } from './_pkgs/affine-block-root/index.js';
-import { shapeShortcuts } from './_pkgs/affine-gfx-shape/index.js';
-import { isBlockEnabled } from './flags.js';
-/**
- * Per-framework shortcut contributions. A framework that adds shortcuts lists
- * them here (manifest) AND registers `ShortcutExtension(...)` in its view
- * (runtime binding); both are gated by its flag.
- *
- * Bundled distribution note: these groups are STRIPPED from
- * `@formicoidea/labre-core` by `scripts/build-bundles.mjs` (`shortcuts: true`
- * on the framework's entry) — each framework bundle exports its own
- * descriptors (e.g. `wardleyShortcuts`) and the host appends them to
- * `getShortcutManifest()` for the frameworks it enables.
- */
-const FRAMEWORK_SHORTCUT_GROUPS = [];
+import { toShortcutDescriptor } from './_pkgs/std/index.js';
+import { getCommands } from './commands.js';
 const toEntry = (d) => ({
     id: d.id,
     labelKey: d.labelKey,
     defaultKeys: d.defaultKeys,
     scope: d.scope,
     owner: d.owner,
-    when: d.when,
 });
 /**
- * Pure aggregator (exported for testing): core shortcuts plus the shortcuts of
- * every framework group whose flag is enabled.
- */
-export function buildShortcutManifest(core, groups, flags) {
-    const entries = core.map(toEntry);
-    for (const { owner, shortcuts } of groups) {
-        if (isBlockEnabled(flags, owner)) {
-            entries.push(...shortcuts.map(toEntry));
-        }
-    }
-    return entries;
-}
-/**
- * The enumerable shortcut manifest for a given flag set: core shortcuts plus
- * the shortcuts contributed by the currently-enabled frameworks. Enumerable
- * without an editor instance (for a settings panel). Mirrors the flag gating of
- * `getInternalViewExtensions`.
+ * The enumerable shortcut manifest for a given flag set. TOTAL over the command
+ * registry: every command yields a row, keyless ones included, so Settings ›
+ * Shortcuts can bind precisely the commands a user most wants to bind. The
+ * panel therefore grows from ~10 rows to the full command count — that is the
+ * intent, and `owner` grouping is what keeps it usable.
  */
 export function getShortcutManifest(flags) {
-    return buildShortcutManifest(
-    // Shapes are core canvas: their shortcuts are always-on, like root's.
-    [...coreShortcuts, ...shapeShortcuts], FRAMEWORK_SHORTCUT_GROUPS, flags);
+    return getCommands(flags).map(toShortcutDescriptor).map(toEntry);
 }

package/dist/translations.d.ts

@@ -0,0 +1,56 @@
+import { type TranslationKeyManifestEntry } from './_pkgs/std/index.js';
+/**
+ * The translation-key manifest (the i18n sibling of `getShortcutManifest` /
+ * `getCommandManifest`): every i18n key the library can hand to
+ * `TranslationProvider.t`, with its English fallback, enumerable WITHOUT an
+ * editor instance. A host builds its catalogue from this list instead of
+ * chasing `translateKey` call sites — see
+ * `packages/affine/shared/src/services/translation-service/README.md`.
+ *
+ * ## Composed, not centralised
+ *
+ * The manifest is ASSEMBLED here out of parts declared where they belong — the
+ * same shape `commands.ts` already has, and for the same reason.
+ * `@formicoidea/labre-core` is the editor MINUS the frameworks: a manifest that
+ * imported each framework's data into this file would break `build:bundles`
+ * outright, and stripping the imports would leave `getTranslationKeyManifest()`
+ * quietly answering with core's share alone (68 keys of 175) under a signature
+ * promising the whole library.
+ *
+ * So each framework exports its own `…TranslationEntries`
+ * ({@link FRAMEWORK_TRANSLATION_GROUPS}), `scripts/build-bundles.mjs` strips
+ * the groups from core's copy exactly as it strips the command groups, and a
+ * bundled host composes core's manifest with the entries of the framework
+ * bundles it installed. The monorepo assembly below and the bundled one build
+ * the same list out of the same parts — which is also what makes a new
+ * framework (cynefin) arrive whole instead of arriving with a hole nothing
+ * would report.
+ *
+ * ## Two kinds of entry, and the split is what keeps the list honest
+ *
+ * - **Declared data** (commands, roles, rules, profiles, nudges, audit
+ *   criteria, reading conventions, background labels, and the chrome tables
+ *   below): walked from the same runtime declarations the editor registers, so
+ *   a key added to a rule or a command appears here BY CONSTRUCTION.
+ * - **Chrome literals** ({@link CHROME_KEYS}): the widget wordings — panel
+ *   titles, field names, action buttons — which live in lit templates and
+ *   cannot be walked. They are restated here, and `manifest.unit.spec.ts`
+ *   scans the source and fails when a key is used but missing from this
+ *   manifest, when an entry here is used by nobody, or when a restated
+ *   fallback drifts from the one the widget actually renders.
+ */
+export type { TranslationKeyManifestEntry, TranslationKeySource, } from './_pkgs/std/index.js';
+/**
+ * Every i18n key THIS package can ask the host for, with its English fallback
+ * where one ships.
+ *
+ * In the monorepo that is the whole library. In the bundled distribution it is
+ * core's share, and the host appends the `…TranslationEntries` export of each
+ * framework bundle it installed — see the composition note above and the
+ * translation-service README.
+ *
+ * Flag-independent on purpose: `getCommands()` with no flags enumerates every
+ * command, including the capability-gated ones, and the framework groups are
+ * not filtered either.
+ */
+export declare function getTranslationKeyManifest(): TranslationKeyManifestEntry[];

package/dist/translations.js

@@ -0,0 +1,112 @@
+import { EXEMPTION_FALLBACK, RELATION_SIDE_FALLBACK, SEVERITY_FALLBACK, } from './_pkgs/affine-block-surface/index.js';
+import { collectTranslationKeys, commandTranslationEntries, mergeTranslationEntries, } from './_pkgs/std/index.js';
+import { getCommands } from './commands.js';
+import { FRAMEWORK_DESCRIPTORS } from './frameworks.js';
+const FRAMEWORK_TRANSLATION_GROUPS = [];
+/**
+ * The chrome wordings that are TABLES: closed enumerations whose key is a
+ * template literal (`com.labre.validation.severity.${severity}`). They are
+ * walked from the widgets' own exported records rather than restated, which is
+ * what lets the drift check mean something for them — a source scan cannot
+ * pair a template key with a wording that arrives through a lookup.
+ */
+const CHROME_TABLES = [
+    ['com.labre.validation.severity.', SEVERITY_FALLBACK],
+    ['com.labre.validation.state.exempted.', EXEMPTION_FALLBACK],
+    ['com.labre.reading.relations.', RELATION_SIDE_FALLBACK],
+];
+const chromeTableEntries = () => CHROME_TABLES.flatMap(([prefix, table]) => Object.entries(table).map(([suffix, fallback]) => ({
+    key: `${prefix}${suffix}`,
+    fallback,
+    source: 'chrome',
+})));
+/**
+ * Chrome wordings: the `translateKey(std, key, fallback)` literals of the
+ * library's own panels and toolbars. Restated data, guarded against drift AND
+ * against going dead by the manifest unit test.
+ */
+const CHROME_KEYS = [
+    // Validation bubble, badge and toolbar
+    ['com.labre.validation.toolbar.label', 'Validation'],
+    ['com.labre.validation.bubble.label', 'Validation details'],
+    ['com.labre.validation.badge.label', 'Show validation details'],
+    ['com.labre.validation.profile.section', 'Profile'],
+    ['com.labre.validation.action.ignore', 'Ignore this validation rule'],
+    [
+        'com.labre.validation.action.ignore-map',
+        'Ignore this rule on the whole map',
+    ],
+    ['com.labre.validation.action.revoke', 'Revoke'],
+    ['com.labre.validation.action.revoke-exception', 'Revoke exception'],
+    // Map quality panel
+    ['com.labre.validation.map-quality.open', 'Map quality…'],
+    ['com.labre.validation.map-quality.section', 'Map quality'],
+    ['com.labre.validation.map-quality.checklist.yours', 'To be checked by you:'],
+    ['com.labre.validation.map-quality.close', 'Close'],
+    // Qualify (tags) toolbar
+    ['com.labre.tags.toolbar.label', 'Qualify'],
+    // Reading panel
+    ['com.labre.reading.toolbar.label', 'Read this component'],
+    ['com.labre.reading.panel.label', 'Proposed record'],
+    ['com.labre.reading.panel.title', 'What this map says about this component'],
+    ['com.labre.reading.field.type', 'Type of node'],
+    ['com.labre.reading.field.specialises', 'A kind of'],
+    ['com.labre.reading.field.nature', 'Nature'],
+    ['com.labre.reading.field.relations', 'Parent-child relations'],
+    ['com.labre.reading.field.value-flow', 'Value flow'],
+    ['com.labre.reading.field.phase', 'Evolution phase'],
+    ['com.labre.reading.field.naming', 'Naming convention'],
+    ['com.labre.reading.field.record', 'Record'],
+    ['com.labre.reading.field.drift', 'Drift'],
+    [
+        'com.labre.reading.nature.none',
+        'Not qualified — the reading proposes nothing of its own.',
+    ],
+    ['com.labre.reading.nature.unknown-record-value', 'The record says'],
+    [
+        'com.labre.reading.nature.unknown-record-value.suffix',
+        'a value this framework does not describe.',
+    ],
+    ['com.labre.reading.action.confirm-nature', 'Confirm'],
+    ['com.labre.reading.action.link', 'Link to a record'],
+    ['com.labre.reading.action.update-record', 'Update the record'],
+    ['com.labre.reading.relations.none', 'No typed link touches this component.'],
+    [
+        'com.labre.reading.relations.contradiction',
+        'A link states the opposite of what the positions show',
+    ],
+    ['com.labre.reading.value-flow', 'Value flows up from'],
+    ['com.labre.reading.value-flow.to', 'to'],
+    ['com.labre.reading.phase.band', 'In the zone of punctuated equilibrium'],
+    [
+        'com.labre.reading.phase.none',
+        'Not on a framework background — no phase to read.',
+    ],
+    [
+        'com.labre.reading.naming.conforms',
+        'The name follows the convention of its nature.',
+    ],
+    ['com.labre.reading.record.linked', 'Linked'],
+    ['com.labre.reading.record.none', 'Not linked to a record.'],
+    ['com.labre.reading.drift.message', 'The board and the record disagree'],
+];
+/**
+ * Every i18n key THIS package can ask the host for, with its English fallback
+ * where one ships.
+ *
+ * In the monorepo that is the whole library. In the bundled distribution it is
+ * core's share, and the host appends the `…TranslationEntries` export of each
+ * framework bundle it installed — see the composition note above and the
+ * translation-service README.
+ *
+ * Flag-independent on purpose: `getCommands()` with no flags enumerates every
+ * command, including the capability-gated ones, and the framework groups are
+ * not filtered either.
+ */
+export function getTranslationKeyManifest() {
+    return mergeTranslationEntries(commandTranslationEntries(getCommands()), collectTranslationKeys('framework', FRAMEWORK_DESCRIPTORS), ...FRAMEWORK_TRANSLATION_GROUPS.map(group => group.entries), chromeTableEntries(), CHROME_KEYS.map(([key, fallback]) => ({
+        key,
+        fallback,
+        source: 'chrome',
+    })));
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@formicoidea/labre-core",
   "description": "Labre editor — the full BlockSuite-derived editor as one package.",
-  "version": "0.31.0",
+  "version": "0.32.0",
   "type": "module",
   "sideEffects": false,
   "author": "lajola",
@@ -814,6 +814,18 @@
       "types": "./dist/shortcuts.d.ts",
       "import": "./dist/shortcuts.js"
     },
+    "./commands": {
+      "types": "./dist/commands.d.ts",
+      "import": "./dist/commands.js"
+    },
+    "./frameworks": {
+      "types": "./dist/frameworks.d.ts",
+      "import": "./dist/frameworks.js"
+    },
+    "./translations": {
+      "types": "./dist/translations.d.ts",
+      "import": "./dist/translations.js"
+    },
     "./model": {
       "types": "./dist/model/index.d.ts",
       "import": "./dist/model/index.js"
@@ -847,9 +859,9 @@
     "dist"
   ],
   "dependencies": {
-    "@atlaskit/pragmatic-drag-and-drop": "^1.4.0",
-    "@atlaskit/pragmatic-drag-and-drop-auto-scroll": "^2.1.0",
-    "@atlaskit/pragmatic-drag-and-drop-hitbox": "^1.0.3",
+    "@atlaskit/pragmatic-drag-and-drop": "^2.0.0",
+    "@atlaskit/pragmatic-drag-and-drop-auto-scroll": "^3.0.0",
+    "@atlaskit/pragmatic-drag-and-drop-hitbox": "^2.0.0",
     "@blocksuite/icons": "^2.2.12",
     "@emoji-mart/data": "^1.2.1",
     "@emotion/css": "^11.13.5",

package/dist/_pkgs/affine-block-root/keyboard/shortcuts.d.ts

@@ -1,8 +0,0 @@
-import type { ShortcutDescriptor } from '../../std/index.js';
-/**
- * Core (always-on) keyboard shortcuts, expressed as rebindable descriptors.
- * Migrated out of the imperative `PageKeyboardManager` bindings so the host can
- * enumerate and override them. Installed by `ShortcutKeymapExtension` (see
- * root `view.ts`).
- */
-export declare const coreShortcuts: ShortcutDescriptor[];

package/dist/_pkgs/affine-block-root/keyboard/shortcuts.js

@@ -1,48 +0,0 @@
-import { IS_WINDOWS } from '../../global/env/index.js';
-/**
- * Core (always-on) keyboard shortcuts, expressed as rebindable descriptors.
- * Migrated out of the imperative `PageKeyboardManager` bindings so the host can
- * enumerate and override them. Installed by `ShortcutKeymapExtension` (see
- * root `view.ts`).
- */
-export const coreShortcuts = [
-    {
-        id: 'undo',
-        labelKey: 'com.affine.keyboardShortcuts.undo',
-        defaultKeys: { mac: ['Mod-z'], other: ['Mod-z'] },
-        scope: 'global',
-        owner: 'core',
-        handler: std => ctx => {
-            ctx.get('defaultState').event.preventDefault();
-            if (std.store.canUndo)
-                std.store.undo();
-        },
-    },
-    {
-        id: 'redo',
-        labelKey: 'com.affine.keyboardShortcuts.redo',
-        defaultKeys: { mac: ['Shift-Mod-z'], other: ['Shift-Mod-z'] },
-        scope: 'global',
-        owner: 'core',
-        handler: std => ctx => {
-            ctx.get('defaultState').event.preventDefault();
-            if (std.store.canRedo)
-                std.store.redo();
-        },
-    },
-    {
-        // Windows-only redo alias (Ctrl+Y); not bound on mac (empty combo).
-        id: 'redo-windows',
-        labelKey: 'com.affine.keyboardShortcuts.redo',
-        defaultKeys: { mac: [], other: ['Control-y'] },
-        scope: 'global',
-        owner: 'core',
-        handler: std => ctx => {
-            if (!IS_WINDOWS)
-                return;
-            ctx.get('defaultState').event.preventDefault();
-            if (std.store.canRedo)
-                std.store.redo();
-        },
-    },
-];

package/dist/_pkgs/affine-gfx-shape/shortcuts.d.ts

@@ -1,6 +0,0 @@
-import type { ShortcutDescriptor } from '../std/index.js';
-/**
- * Shape shortcuts (edgeless scope, always-on — shapes are core canvas).
- * Host-rebindable via `ShortcutOverrides`.
- */
-export declare const shapeShortcuts: ShortcutDescriptor[];

package/dist/_pkgs/affine-gfx-shape/shortcuts.js

@@ -1,28 +0,0 @@
-import { ShapeElementModel, TextFitMode } from '../affine-model/index.js';
-import { GfxControllerIdentifier } from '../std/gfx/index.js';
-import { applyTextFitMode, nextTextFitMode } from './text-fit.js';
-/**
- * Shape shortcuts (edgeless scope, always-on — shapes are core canvas).
- * Host-rebindable via `ShortcutOverrides`.
- */
-export const shapeShortcuts = [
-    {
-        id: 'shape.cycleTextFit',
-        labelKey: 'com.labre.keyboardShortcuts.shape.cycleTextFit',
-        defaultKeys: { mac: ['Mod-Shift-f'], other: ['Mod-Shift-f'] },
-        scope: 'edgeless',
-        owner: 'core',
-        handler: std => ctx => {
-            const gfx = std.get(GfxControllerIdentifier);
-            if (gfx.selection.editing)
-                return false;
-            const models = gfx.selection.selectedElements.filter((el) => el instanceof ShapeElementModel && !!el.text);
-            if (!models.length)
-                return false;
-            ctx.get('defaultState').event.preventDefault();
-            const mode = models[0].textFitMode ?? TextFitMode.Grow;
-            applyTextFitMode(std, models, nextTextFitMode(mode));
-            return true;
-        },
-    },
-];

package/dist/_pkgs/data-view/core/utils/cache.d.ts

@@ -1,5 +0,0 @@
-import { type ReadonlySignal } from '@preact/signals-core';
-export declare const cacheComputed: <T>(ids: ReadonlySignal<string[]>, create: (id: string) => T) => {
-    getOrCreate: (id: string) => T;
-    list: ReadonlySignal<T[]>;
-};

package/dist/_pkgs/data-view/core/utils/cache.js

@@ -1,28 +0,0 @@
-import { computed } from '@preact/signals-core';
-export const cacheComputed = (ids, create) => {
-    const cache = new Map();
-    const getOrCreate = (id) => {
-        if (cache.has(id)) {
-            return cache.get(id);
-        }
-        const value = create(id);
-        if (value) {
-            cache.set(id, value);
-        }
-        return value;
-    };
-    return {
-        getOrCreate,
-        list: computed(() => {
-            const list = ids.value;
-            const keys = new Set(cache.keys());
-            for (const [cachedId] of cache) {
-                keys.delete(cachedId);
-            }
-            for (const id of keys) {
-                cache.delete(id);
-            }
-            return list.map(id => getOrCreate(id));
-        }),
-    };
-};