@voithos-labs/aragonite 0.10.4 → 0.10.7

package/README.md

@@ -195,7 +195,7 @@ Also, shipping a kind forces the boring questions up front: the registration typ
 
 This is the bet. Aragonite cannot top Obsidian in plugin count (in the short term, at least), but what it can try to do is trade plugin count for plugin quality. Score it against my three criterias: reach is the whole own a kind story above, safety is the lossless promise doing double duty, and ergonomics is the part I haven't argued yet, so here it is: svelte and typescript end to end, the entire authoring surface on one import path (`@voithos-labs/aragonite/plugin`), and a public testing seam so your plugin's own test suite isn't an afterthought.
 
-Does the design actually work in practice? Well, the nine bundled first party plugins (admonitions, details, footnotes, emoji, math, diagrams, table of contents, occurrence highlighting, and a party parrot) are built on the exact surface third parties get, so I would describe it as "so far, so good".
+Does the design actually work in practice? Well, the ten bundled first party plugins (admonitions, details, footnotes, emoji, math, diagrams, table of contents, occurrence highlighting, slash commands, and a party parrot) are built on the exact surface third parties get, so I would describe it as "so far, so good".
 
 # Fast
 
@@ -340,7 +340,7 @@ Aragonite is free software, released under [AGPL-3.0-or-later](./LICENSE): use i
 
 [^8]: it might work in safari/firefox, but I did not test them yet
 
-[^9]: Parse then serialize returns the same text every time. Unfortunately, aragonite cannot promise that editing never normalizes. A container re-emits its own bytes from its children, so the first edit inside one canonicalizes that container's own syntax. For example, a table's cell padding and delimiter row take their canonical spelling (`|a|b|` becomes `| a | b |`, `|:--|` becomes `| :--- |`). docs/design/syntax-tree.md covers why the alternative is worse.
+[^9]: Parse then serialize returns the same text every time. Unfortunately, aragonite cannot promise that editing never normalizes. A container re-emits its own bytes from its children, so the first edit inside one canonicalizes that container's own syntax. For example, a table's cell padding and delimiter row take their canonical spelling (`|a|b|` becomes `| a | b |`, `|:--|` becomes `| :--- |`), and a list item's tab indentation can turn into spaces. docs/design/syntax-tree.md covers why the alternative is worse.
 
 [^10]: A flat model is rejected because of the constraints it places on the plugin system. Read the [Extensible](#extensible) section to understand why this is.
 

package/dist/a11y-strings.d.ts

@@ -1,13 +1,13 @@
 /**
  * Accessible names, tooltips, and live-region announcements in one table, so a future
- * locale pass has one seam. Internal — no barrel exports it.
+ * translation pass has one place to work. Internal: no barrel exports it.
  */
-import type { TableAlignment } from './core/nodes';
+import type { NodeView } from './core/node-views';
+import { type AnyBlockKind, type TableAlignment } from './core/nodes';
 export declare const EDITOR_LABEL = "Markdown editor";
 export declare const DRAG_HANDLE_TITLE = "Drag to reorder \u2014 or Alt+\u2191 / Alt+\u2193";
 export declare const FAILED_BLOCK_LABEL = "Block failed to render";
 export declare const GAP_CARET_LABEL = "Insertion point between blocks";
-export declare const WHOLE_BLOCK_INPUT_LABEL = "Focused block input";
 export declare const IMAGE_PROPERTIES_LABEL = "Image properties";
 export declare const IMAGE_ALT_FIELD = "Alt text";
 export declare const IMAGE_ALT_PLACEHOLDER = "Describe the image";
@@ -19,6 +19,7 @@ export declare const LINK_CARD_LABEL = "Link properties";
 export declare const LINK_CARD_URL = "Link URL";
 export declare const LINK_CARD_OPEN = "Open link";
 export declare const LINK_CARD_REMOVE = "Remove link";
+export declare const INLINE_MENU_LABEL = "Suggestions";
 export declare const CODE_LANGUAGE_FIELD = "Code block language";
 export declare const CODE_RUN_LABEL = "Run code block";
 export declare const CODE_COPY_LABEL = "Copy code";
@@ -27,8 +28,14 @@ export declare const CODE_MENU_LABEL = "Code block actions";
 export declare const CODE_RAIL_LABEL = "Code block controls";
 export declare const CODE_LANGUAGE_LIST = "Code block languages";
 export declare const SELECTION_TOOLBAR_LABEL = "Selection formatting";
-/** Chrome, not an announcement: the language chip's accessible name. */
+/** A control's name, not an announcement: the language chip's accessible name. */
 export declare function codeLanguageLabel(language: string): string;
+/** A kind's name: the built-in table, else the plugin descriptor's `label`, else the kind
+ *  itself in words (`mathBlock` reads "Math block"). */
+export declare function blockKindLabel(kind: AnyBlockKind): string;
+/** A block's accessible name: the name of the kind it shows as, plus a heading's level or a code
+ *  fence's language, which is what a reader moving block to block needs to tell them apart. */
+export declare function blockAccessibleName(node: NodeView): string;
 export declare const SEARCH_TOGGLE_REPLACE = "Toggle replace";
 export declare const SEARCH_FIND = "Find";
 export declare const SEARCH_REPLACE = "Replace";
@@ -46,7 +53,6 @@ export declare const COLUMN_ALIGNMENT = "Column alignment";
 export declare const ADD_ROW_BELOW = "Add row";
 export declare const ADD_COLUMN_RIGHT = "Add column";
 export declare const TAIL_ADD_ROW = "Add a line below";
-export declare const TAIL_ADD_BLOCK = "Add a block";
 export declare const BLOCK_MENU_LABEL = "Insert a block";
 export declare const BLOCK_ACTIONS_LABEL = "Block actions";
 export declare const ALIGN_LEFT = "Left";

package/dist/a11y-strings.js

@@ -1,13 +1,16 @@
 /**
  * Accessible names, tooltips, and live-region announcements in one table, so a future
- * locale pass has one seam. Internal — no barrel exports it.
+ * translation pass has one place to work. Internal: no barrel exports it.
  */
-// ── Editor chrome ────────────────────────────────────────────────────────────
+import { headingLevel, isBuiltinBlockKind, metadataOf } from './core/nodes';
+import { tryGetBlockKindDescriptor } from './schema/block-kind-descriptor';
+import { shownKind } from './core/parsers/heading';
+import { fenceLanguage } from './core/parsers/fence-syntax';
+// ── Editor controls ──────────────────────────────────────────────────────────
 export const EDITOR_LABEL = 'Markdown editor';
 export const DRAG_HANDLE_TITLE = 'Drag to reorder — or Alt+↑ / Alt+↓';
 export const FAILED_BLOCK_LABEL = 'Block failed to render';
 export const GAP_CARET_LABEL = 'Insertion point between blocks';
-export const WHOLE_BLOCK_INPUT_LABEL = 'Focused block input';
 export const IMAGE_PROPERTIES_LABEL = 'Image properties';
 export const IMAGE_ALT_FIELD = 'Alt text';
 export const IMAGE_ALT_PLACEHOLDER = 'Describe the image';
@@ -19,6 +22,7 @@ export const LINK_CARD_LABEL = 'Link properties';
 export const LINK_CARD_URL = 'Link URL';
 export const LINK_CARD_OPEN = 'Open link';
 export const LINK_CARD_REMOVE = 'Remove link';
+export const INLINE_MENU_LABEL = 'Suggestions';
 export const CODE_LANGUAGE_FIELD = 'Code block language';
 export const CODE_RUN_LABEL = 'Run code block';
 export const CODE_COPY_LABEL = 'Copy code';
@@ -27,10 +31,62 @@ export const CODE_MENU_LABEL = 'Code block actions';
 export const CODE_RAIL_LABEL = 'Code block controls';
 export const CODE_LANGUAGE_LIST = 'Code block languages';
 export const SELECTION_TOOLBAR_LABEL = 'Selection formatting';
-/** Chrome, not an announcement: the language chip's accessible name. */
+/** A control's name, not an announcement: the language chip's accessible name. */
 export function codeLanguageLabel(language) {
     return `Code language: ${language}`;
 }
+// ── Block names ──────────────────────────────────────────────────────────────
+/** What each built-in kind is called, to a screen reader and in the block menu's rows. */
+const BUILT_IN_BLOCK_LABELS = {
+    paragraph: 'Paragraph',
+    heading: 'Heading',
+    setextHeading: 'Heading',
+    fencedCode: 'Code block',
+    indentedCode: 'Code block',
+    htmlBlock: 'HTML block',
+    thematicBreak: 'Divider',
+    linkReferenceDefinition: 'Link definition',
+    table: 'Table',
+    tableRow: 'Table row',
+    tableCell: 'Table cell',
+    unrecognized: 'Raw block',
+    blockquote: 'Quote',
+    list: 'List',
+    listItem: 'List item'
+};
+/** A kind's name: the built-in table, else the plugin descriptor's `label`, else the kind
+ *  itself in words (`mathBlock` reads "Math block"). */
+export function blockKindLabel(kind) {
+    if (isBuiltinBlockKind(kind))
+        return BUILT_IN_BLOCK_LABELS[kind];
+    return tryGetBlockKindDescriptor(kind)?.label ?? humanizeKind(kind);
+}
+/** A block's accessible name: the name of the kind it shows as, plus a heading's level or a code
+ *  fence's language, which is what a reader moving block to block needs to tell them apart. */
+export function blockAccessibleName(node) {
+    const shown = shownKind(node);
+    if (shown !== node.kind)
+        return blockKindLabel(shown);
+    const label = blockKindLabel(node.kind);
+    const level = headingLevel(node);
+    if (level !== null)
+        return `${label} level ${level}`;
+    if (node.kind === 'fencedCode') {
+        const language = fenceLanguage(metadataOf(node, 'fencedCode').info);
+        if (language)
+            return `${label}, ${language}`;
+    }
+    return label;
+}
+function humanizeKind(kind) {
+    const words = kind
+        .replace(/([a-z0-9])([A-Z])/g, '$1 $2')
+        .split(/[\s_:-]+/)
+        .filter(Boolean)
+        .join(' ')
+        .toLowerCase();
+    return words.charAt(0).toUpperCase() + words.slice(1);
+}
 // ── Search bar ───────────────────────────────────────────────────────────────
 // A _TITLE/_LABEL pair is a tooltip that reads shorter than its accessible name.
 export const SEARCH_TOGGLE_REPLACE = 'Toggle replace';
@@ -51,7 +107,6 @@ export const COLUMN_ALIGNMENT = 'Column alignment';
 export const ADD_ROW_BELOW = 'Add row';
 export const ADD_COLUMN_RIGHT = 'Add column';
 export const TAIL_ADD_ROW = 'Add a line below';
-export const TAIL_ADD_BLOCK = 'Add a block';
 export const BLOCK_MENU_LABEL = 'Insert a block';
 export const BLOCK_ACTIONS_LABEL = 'Block actions';
 export const ALIGN_LEFT = 'Left';