quoin-editor 1.6.0 → 1.8.0

package/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 Every release of `quoin-editor` is listed here, newest first, in the spirit of [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). From 1.0.0 the package follows [semantic versioning](https://semver.org/): a breaking change waits for the next major version. Until then, Quoin was 0.x and a minor version could contain breaking changes; those known at release were marked "Breaking". The 0.x sections are kept as they were released, "Docs" headings included. Moving from 0.4 to 1.0 is covered step by step in [MIGRATION.md](MIGRATION.md). Review finding ids such as F-17 are those of the 0.4.0 review in [#73](https://github.com/AmineSeboui/quoin-editor/issues/73).
 
+## 1.8.0 (2026-11-05)
+
+### Added
+- Seven locale packs, one entry each, carrying every string the editor shows or speaks in that language: `quoin-editor/locale-ar` (Arabic), `quoin-editor/locale-de` (German), `quoin-editor/locale-es` (Spanish), `quoin-editor/locale-fr` (French), `quoin-editor/locale-ja` (Japanese), `quoin-editor/locale-pt` (Portuguese) and `quoin-editor/locale-zh` (Simplified Chinese). A pack covers the canvas and all fourteen feature label sets, so `frLabels` goes to the canvas and `frTableLabels` to the table, and it is data alone: no React, no side effects, about 5.5 KB gzip each, downloaded only by a host that imports one. A label that carries a count, a date, a number or a file size is written as its language writes it, through `Intl`, so Arabic gets its six plural forms and Japanese its one. Nothing is detected: the host picks the language, and a key a pack leaves out still falls back to English.
+- `quoin-editor/headless` exports the types its own signatures already named, so a host can write them down rather than reach them through `Parameters` and `ReturnType`: `Announcer` with `Spoken`, `Engagement`, `FocusTarget`, `HostRegistry` with `HostEntry`, and `NodeReveal`, all reached through `ViewController`; `CaretPoint`, which `caretFromPoint` returns; and `BlockShellProps` and `SelectionSinkProps`, taken by the two components named after them. They reach `quoin-editor` too, which re-exports the headless entry. Nothing new runs and no type changes shape.
+
+### Changed
+- The exports a host meets first carry a documentation comment, so an editor explains them on hover: `BlockCanvas`, `EditorView`, `useQuoinEditor`, `createEditor`, `toMarkdown`, `toHTML`, `toPlainText`, `fromMarkdown`, `PALETTE` and `englishLabels`. Nothing about their behaviour changes.
+- `BlockShell`, `SelectionSink`, `defaultRenderers`, `VoidBlockFallback` and `isCrossSelection` are marked deprecated, in an editor and on the headless reference, and they go in 2.0.0. All five are internal to the view layer and a host has no use for them: `EditorView` draws the first two itself and a second copy of either takes the registration with the controller from the first, a renderer of your own draws a block's text with `EditableRegion` rather than reaching for `defaultRenderers`, a block shell already falls back to `VoidBlockFallback` when no renderer draws a block's type, and a host reads `anchor` and `head` of the public `Selection` to tell a selection that spans blocks or regions from one held inside a single region. `BlockRenderProps` and `BlockRenderer` stay public, so a renderer table still types. Every name is still exported and still does what it did.
+- The comparison table weighs Quoin against Lexical and Plate as well, rechecked against each project's own pages and dated 2026-11-05. Lexical keeps an editor state it writes as JSON, draws no interface of its own, and ships neither comments nor translations: none of its forty packages covers either, and the comment plugin a reader finds is playground code. Plate keeps Slate JSON, converts markdown both ways, collaborates over Yjs and marks comments on text, and is MIT with a paid set of components behind its Notion-like template. A localization row goes in beside them: BlockNote ships 24 locales, Editor.js takes a dictionary the host writes, and Tiptap, Lexical and Plate ship none, since their interface strings live in the code a host copies into its own project. The comparison page reads in a wider column than the guide, because seven columns in a line of prose left each one too narrow to read.
+
+## 1.7.0 (2026-11-04)
+
+### Added
+- `quoin-editor/diagram` draws a code block whose language names a diagram, such as `mermaid`, through a renderer you pass, which may answer at once or with a promise as the common engines do, with its source below the drawing where a writer already edits it. Quoin draws no diagrams itself and bundles no engine. The document is unchanged: a diagram is a fenced code block, and opens as one anywhere else. A renderer that throws or draws nothing leaves the source alone rather than losing the block.
+
 ## 1.6.0 (2026-11-04)
 
 ### Added

package/README.md

@@ -62,29 +62,32 @@ What `onChange` hands you, and what you store:
 | Entry | What it adds |
 | --- | --- |
 | `quoin-editor` | The canvas: text, lists, tasks, quotes, callouts, toggles, dividers, code, images and files, with every menu and toolbar |
-| `quoin-editor/table`, `/embed`, `/math`, `/toc`, `/mention`, `/emoji`, `/find`, `/stats` | Opt-in features, each its own entry; `quoin-editor/catalogue` adds them all |
+| `quoin-editor/table`, `/embed`, `/math`, `/diagram`, `/toc`, `/mention`, `/emoji`, `/find`, `/stats` | Opt-in features, each its own entry; `quoin-editor/catalogue` adds them all |
 | `quoin-editor/highlight` | Syntax colouring for code blocks, in every language the picker offers, fetched on demand |
+| `quoin-editor/source` | The document as the markdown it is stored as, read only, beside or below the canvas |
 | `quoin-editor/yjs`, `/presence` | Real-time co-editing through your own Yjs provider, and collaborators' carets |
 | `quoin-editor/comments` | Comment threads anchored to text, kept in your store |
 | `quoin-editor/ai` | Your model's answers streamed into the document; Quoin never calls a model |
 | `quoin-editor/view`, `/diff`, `/docx` | Server rendering with no hooks, a diff of two versions, a Word export |
+| `quoin-editor/locale-ar`, `/locale-de`, `/locale-es`, `/locale-fr`, `/locale-ja`, `/locale-pt`, `/locale-zh` | Every string the editor shows, in that language |
 | `quoin-editor/headless`, `/engine` | The editor without the canvas UI, and the engine alone with no React |
 
 ## Why Quoin
 
 Each competitor cell links to the page that shows it; the Tiptap UI cell also draws on the review in [#73](https://github.com/AmineSeboui/quoin-editor/issues/73) (2026-10-12).
 
-| Feature | Quoin 1.6 | Tiptap 3 | BlockNote | Editor.js |
-| --- | --- | --- | --- | --- |
-| Stored document | Block array, markdown per text block | [JSON, or HTML][tt-store] | [Block JSON][bn-formats] | [JSON][ej-repo] |
-| Markdown | The storage format | [`@tiptap/markdown`, an early release][tt-md] | [Export and import, documented as lossy][bn-formats] | [Community plugin][ej-awesome] |
-| Notion-style UI | Included, MIT | [MIT menus and drag handle][tt-review]; [Notion-like template on a paid plan][tt-notion] | [Included][bn-home] | [Toolbox and inline toolbar][ej-repo] |
-| Licence | MIT | [MIT core, paid Pro extensions][tt-repo] | [MPL-2.0, `xl-*` packages GPL-3.0 or commercial][bn-repo] | [Apache-2.0][ej-repo] |
-| Real-time collaboration | Yjs, opt-in entry | [Yjs][tt-collab] | [Yjs][bn-collab] | [On its roadmap, in progress][ej-repo] |
-| Comments | Opt-in, your store | [Paid plan][tt-comments] | [Built in, on Yjs or a thread store][bn-comments] | [Community plugin][ej-awesome] |
-| Framework | React | [React, Vue, Svelte, plain JavaScript and more][tt-install] | [React, or vanilla JS with your own UI][bn-vanilla] | [Plain JavaScript][ej-start] |
+| Feature | Quoin 1.8 | Tiptap 3 | BlockNote | Editor.js | Lexical | Plate |
+| --- | --- | --- | --- | --- | --- | --- |
+| Stored document | Block array, markdown per text block | [JSON, or HTML][tt-store] | [Block JSON][bn-formats] | [JSON][ej-repo] | [Editor state, as JSON][lx-intro] | [Slate JSON][pl-docs] |
+| Markdown | The storage format | [`@tiptap/markdown`, an early release][tt-md] | [Export and import, documented as lossy][bn-formats] | [Community plugin][ej-awesome] | [`@lexical/markdown`, in and out][lx-md] | [`@platejs/markdown`, in and out][pl-md] |
+| Notion-style UI | Included, MIT | [MIT menus and drag handle][tt-review]; [Notion-like template on a paid plan][tt-notion] | [Included][bn-home] | [Toolbox and inline toolbar][ej-repo] | [None; you draw it][lx-intro] | [MIT components][pl-repo]; [Notion-like set on a paid licence][pl-pro] |
+| Licence | MIT | [MIT core, paid Pro extensions][tt-repo] | [MPL-2.0, `xl-*` packages GPL-3.0 or commercial][bn-repo] | [Apache-2.0][ej-repo] | [MIT][lx-repo] | [MIT, with paid Plus components][pl-pro] |
+| Real-time collaboration | Yjs, opt-in entry | [Yjs][tt-collab] | [Yjs][bn-collab] | [On its roadmap, in progress][ej-repo] | [Yjs][lx-collab] | [Yjs][pl-yjs] |
+| Comments | Opt-in, your store | [Paid plan][tt-comments] | [Built in, on Yjs or a thread store][bn-comments] | [Community plugin][ej-awesome] | [None shipped; a playground example][lx-repo] | [`@platejs/comment`, as text marks][pl-comment] |
+| Localization | Seven packs, every string | [None shipped; the UI is yours][tt-ui] | [24 locales built in][bn-i18n] | [An i18n API; you bring the words][ej-i18n] | [None shipped; it draws no UI][lx-repo] | [None shipped; the UI is yours][pl-docs] |
+| Framework | React | [React, Vue, Svelte, plain JavaScript and more][tt-install] | [React, or vanilla JS with your own UI][bn-vanilla] | [Plain JavaScript][ej-start] | [Any, with React bindings][lx-repo] | [React][pl-repo] |
 
-Sources, checked on 2026-11-03: Tiptap [persistence][tt-store], [markdown][tt-md], [Notion-like template][tt-notion], [repository][tt-repo], [collaboration][tt-collab], [comments][tt-comments], [install][tt-install]; BlockNote [home][bn-home], [formats][bn-formats], [repository][bn-repo], [collaboration][bn-collab], [comments][bn-comments], [getting started][bn-start], [vanilla JS][bn-vanilla]; Editor.js [home][ej-home], [repository][ej-repo], [getting started][ej-start], [awesome-editorjs][ej-awesome].
+Sources, checked on 2026-11-05: Tiptap [persistence][tt-store], [markdown][tt-md], [Notion-like template][tt-notion], [repository][tt-repo], [collaboration][tt-collab], [comments][tt-comments], [install][tt-install], [UI components][tt-ui]; BlockNote [home][bn-home], [formats][bn-formats], [repository][bn-repo], [collaboration][bn-collab], [comments][bn-comments], [getting started][bn-start], [vanilla JS][bn-vanilla], [localization][bn-i18n]; Editor.js [home][ej-home], [repository][ej-repo], [getting started][ej-start], [awesome-editorjs][ej-awesome], [i18n][ej-i18n]; Lexical [docs][lx-intro], [repository][lx-repo], [markdown][lx-md], [collaboration][lx-collab]; Plate [docs][pl-docs], [repository][pl-repo], [markdown][pl-md], [collaboration][pl-yjs], [comments][pl-comment], [Plate Plus][pl-pro].
 
 [tt-store]: https://tiptap.dev/docs/editor/core-concepts/persistence
 [tt-md]: https://tiptap.dev/docs/editor/markdown
@@ -105,6 +108,19 @@ Sources, checked on 2026-11-03: Tiptap [persistence][tt-store], [markdown][tt-md
 [ej-repo]: https://github.com/codex-team/editor.js
 [ej-start]: https://editorjs.io/getting-started
 [ej-awesome]: https://github.com/editor-js/awesome-editorjs
+[tt-ui]: https://tiptap.dev/docs/ui-components/components/overview
+[bn-i18n]: https://www.blocknotejs.org/docs/features/localization
+[ej-i18n]: https://editorjs.io/i18n/
+[lx-intro]: https://lexical.dev/docs/intro
+[lx-repo]: https://github.com/facebook/lexical
+[lx-md]: https://lexical.dev/docs/packages/lexical-markdown
+[lx-collab]: https://lexical.dev/docs/collaboration/react
+[pl-docs]: https://platejs.org/docs
+[pl-repo]: https://github.com/udecode/plate
+[pl-md]: https://platejs.org/docs/markdown
+[pl-yjs]: https://platejs.org/docs/yjs
+[pl-comment]: https://platejs.org/docs/comment
+[pl-pro]: https://pro.platejs.org
 
 ## Learn more
 

package/dist/ai-labels-BXX32H9a.d.cts

@@ -0,0 +1,53 @@
+type AiAction = 'continue' | 'improve' | 'fix' | 'shorten' | 'lengthen' | 'simplify' | 'tone' | 'translate' | 'summarize' | 'explain' | 'custom';
+/** What the host is asked: `selection` and `context` are markdown, `language` the canvas's `lang` when it has one. */
+type AiRequest = {
+    action: AiAction;
+    prompt?: string;
+    selection: string;
+    context: string;
+    language?: string;
+};
+/** The host's model, answering a request as markdown in chunks, and stopping when `signal` aborts. */
+type AiStream = (request: AiRequest, signal: AbortSignal) => AsyncIterable<string>;
+
+/** Every string AI actions show or speak. */
+type AiLabels = {
+    /** The toolbar button, block menu item and slash command that open the AI menu. */
+    askAi: string;
+    /** What the slash command for the AI menu does. */
+    askAiDescription: string;
+    /** The name of each action in the AI menu; `custom` names the slash command group's own entry. */
+    actions: Record<AiAction, string>;
+    /** The name of the list of actions. */
+    menu: string;
+    /** The field the writer types a request in. */
+    prompt: string;
+    /** The field once Change tone is chosen. */
+    tonePrompt: string;
+    /** The field once Translate is chosen. */
+    translatePrompt: string;
+    /** The choice that sends what was typed as a request of its own. */
+    ask(prompt: string): string;
+    /** The name of the bar under the answer. */
+    response: string;
+    writing: string;
+    stopped: string;
+    stop: string;
+    accept: string;
+    discard: string;
+    retry: string;
+    /** The field for a further request about the answer. */
+    followUp: string;
+    /** Shown when the host's answer failed. */
+    failed: string;
+    /** Said once an answer is complete, given its text. */
+    written(text: string): string;
+    /** Said once an answer is stopped, given what it wrote. */
+    halted(text: string): string;
+    /** Shown when the text the answer was for was deleted meanwhile. */
+    targetGone: string;
+};
+declare const englishAiLabels: AiLabels;
+
+export { englishAiLabels as e };
+export type { AiStream as A, AiLabels as a, AiAction as b, AiRequest as c };

package/dist/ai-labels-BXX32H9a.d.ts

@@ -0,0 +1,53 @@
+type AiAction = 'continue' | 'improve' | 'fix' | 'shorten' | 'lengthen' | 'simplify' | 'tone' | 'translate' | 'summarize' | 'explain' | 'custom';
+/** What the host is asked: `selection` and `context` are markdown, `language` the canvas's `lang` when it has one. */
+type AiRequest = {
+    action: AiAction;
+    prompt?: string;
+    selection: string;
+    context: string;
+    language?: string;
+};
+/** The host's model, answering a request as markdown in chunks, and stopping when `signal` aborts. */
+type AiStream = (request: AiRequest, signal: AbortSignal) => AsyncIterable<string>;
+
+/** Every string AI actions show or speak. */
+type AiLabels = {
+    /** The toolbar button, block menu item and slash command that open the AI menu. */
+    askAi: string;
+    /** What the slash command for the AI menu does. */
+    askAiDescription: string;
+    /** The name of each action in the AI menu; `custom` names the slash command group's own entry. */
+    actions: Record<AiAction, string>;
+    /** The name of the list of actions. */
+    menu: string;
+    /** The field the writer types a request in. */
+    prompt: string;
+    /** The field once Change tone is chosen. */
+    tonePrompt: string;
+    /** The field once Translate is chosen. */
+    translatePrompt: string;
+    /** The choice that sends what was typed as a request of its own. */
+    ask(prompt: string): string;
+    /** The name of the bar under the answer. */
+    response: string;
+    writing: string;
+    stopped: string;
+    stop: string;
+    accept: string;
+    discard: string;
+    retry: string;
+    /** The field for a further request about the answer. */
+    followUp: string;
+    /** Shown when the host's answer failed. */
+    failed: string;
+    /** Said once an answer is complete, given its text. */
+    written(text: string): string;
+    /** Said once an answer is stopped, given what it wrote. */
+    halted(text: string): string;
+    /** Shown when the text the answer was for was deleted meanwhile. */
+    targetGone: string;
+};
+declare const englishAiLabels: AiLabels;
+
+export { englishAiLabels as e };
+export type { AiStream as A, AiLabels as a, AiAction as b, AiRequest as c };