@avocadostudio-ai/richtext 0.2.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a
+      fee for, acceptance of support, warranty, indemnity, or other
+      liability obligations and/or rights consistent with this License.
+      However, in accepting such obligations, You may act only on Your
+      own behalf and on Your sole responsibility, not on behalf of any
+      other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Avocado Studio Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,85 @@
+# @avocadostudio-ai/richtext
+
+The Avocado Studio rich-text grammar, and converters between it and the shapes
+three CMSes actually store.
+
+No runtime dependencies, and no knowledge of React, the orchestrator or any CMS
+client — the CMS types are structural, so a one-off migration script can convert
+a dataset without installing anything else.
+
+## Two layers
+
+**The grammar** (`parse.ts`) is the markdown subset an Avocado `richtext` string
+is written in — sized to exactly what the property panel's editor can produce,
+so anything a person can type comes back rendered rather than as punctuation. It
+is a parser only: it returns tokens, and what a heading or a link looks like on
+screen belongs to the calling surface.
+
+**The pivot** (`doc.ts`) is a ProseMirror document — the shape the property
+panel edits natively. Every format converts to and from it rather than to and
+from each other, so a fourth CMS costs one converter pair instead of three.
+
+```
+Contentful ─┐                        ┌─ Contentful
+Portable Text ├─→ RichTextDoc ─→ ─┤─ Portable Text
+Strapi Blocks ─┤    (the pivot)     ├─ Strapi Blocks
+markdown ──────┘                     └─ markdown
+```
+
+## Converters
+
+| CMS | in | out |
+| --- | --- | --- |
+| Avocado markdown | `fromMarkdown` | `toMarkdown` |
+| Sanity Portable Text | `fromPortableText` | `toPortableText` |
+| Contentful Rich Text | `fromContentful` | `toContentful` |
+| Strapi 5 Blocks | `fromStrapiBlocks` | `toStrapiBlocks` |
+
+```ts
+import { fromPortableText, toPortableText } from "@avocadostudio-ai/richtext"
+
+// read
+const doc = fromPortableText(sanityBlock.body)
+
+// write — `previous` is what makes this an update rather than a replacement
+const body = toPortableText(doc, { previous: storedBlock.body })
+```
+
+## What survives
+
+Node and mark `type` are open strings, not a union of the names we know. A
+Portable Text block with a custom `_type`, a Contentful embedded entry, a
+decorator some space enabled last week: none of them are in the vocabulary, and
+a closed type would force each converter to throw them away. They ride through
+the pivot as `avocadoUnknownBlock` carrying the source object under `attrs.data`
+and come back out unchanged.
+
+Passing `previous` to `toPortableText` goes further: an unchanged block is
+re-emitted as *the stored object itself*, so keys, annotations and fields no
+converter here understands are preserved byte-for-byte, and the CMS sees a diff
+of what actually changed rather than "every block replaced".
+
+`mergeRichTextDoc(next, previous)` is the same idea between two documents. It
+carries stored keys onto a rebuilt document and puts back the blocks the rebuild
+could not have contained — which is what makes it safe for the ops engine to
+parse a planner's plain-string rewrite into a document without deleting the
+embedded entry sitting in the middle of it.
+
+## What does not
+
+Every format is missing something another one has, and the gaps are documented
+at each conversion rather than papered over:
+
+- **markdown has no underline** and no way to name a CMS's own decorator. Those
+  marks drop off in `toMarkdown` and the text stays. A value that needs them
+  should be stored as a document, not flattened.
+- **markdown has no image** in this grammar — the editor has no image node and
+  deletes them — so an `![alt](src)` keeps its alt text. Images belong in an
+  `f.image` field.
+- **Contentful has no code block**; `code` is a mark on text, so a code block
+  becomes a code-marked paragraph.
+- **Portable Text and Strapi Blocks have no thematic break**, so a
+  `horizontalRule` is dropped rather than faked as a paragraph of dashes.
+- **Heading levels clamp to h2–h6 when flattening to markdown**, because a page
+  body never owns the page's `h1`. The document path does not clamp — that is
+  the integration's outline, not ours.

package/dist/contentful.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Contentful Rich Text <-> the pivot document.
+ *
+ * Contentful is the recursive one: a `document` node containing block nodes
+ * containing inline nodes containing text, every node carrying a `data` object
+ * and a `nodeType` from a closed vocabulary. Two consequences shape this file.
+ *
+ * A link is a *node*, not a mark. `hyperlink` wraps the text it decorates, so a
+ * run of pivot text nodes sharing one link mark has to be gathered back into a
+ * single wrapper on the way out, and unwrapped into per-text marks on the way
+ * in — otherwise a two-word link comes back as two adjacent links.
+ *
+ * Nothing in a Contentful document is addressable. There are no keys, no
+ * per-node identity, and the API takes the whole field value on every write —
+ * so unlike Portable Text there is nothing to merge against and no `previous`
+ * parameter here. Content the vocabulary does not cover (embedded entries and
+ * assets, tables) still rides through as `avocadoUnknownBlock` so that editing
+ * the prose around an embedded entry does not delete it.
+ */
+import { type RichTextDoc } from "./doc.ts";
+export type ContentfulMark = {
+    type: string;
+};
+export type ContentfulNode = {
+    nodeType: string;
+    data?: Record<string, unknown>;
+    content?: ContentfulNode[];
+    value?: string;
+    marks?: ContentfulMark[];
+};
+export type ContentfulDocument = {
+    nodeType: "document";
+    data: Record<string, unknown>;
+    content: ContentfulNode[];
+};
+/** Convert a Contentful Rich Text document into the pivot document. */
+export declare function fromContentful(document: unknown): RichTextDoc;
+/** Convert the pivot document back to a Contentful Rich Text document. */
+export declare function toContentful(doc: RichTextDoc): ContentfulDocument;

package/dist/contentful.js

@@ -0,0 +1,246 @@
+/**
+ * Contentful Rich Text <-> the pivot document.
+ *
+ * Contentful is the recursive one: a `document` node containing block nodes
+ * containing inline nodes containing text, every node carrying a `data` object
+ * and a `nodeType` from a closed vocabulary. Two consequences shape this file.
+ *
+ * A link is a *node*, not a mark. `hyperlink` wraps the text it decorates, so a
+ * run of pivot text nodes sharing one link mark has to be gathered back into a
+ * single wrapper on the way out, and unwrapped into per-text marks on the way
+ * in — otherwise a two-word link comes back as two adjacent links.
+ *
+ * Nothing in a Contentful document is addressable. There are no keys, no
+ * per-node identity, and the API takes the whole field value on every write —
+ * so unlike Portable Text there is nothing to merge against and no `previous`
+ * parameter here. Content the vocabulary does not cover (embedded entries and
+ * assets, tables) still rides through as `avocadoUnknownBlock` so that editing
+ * the prose around an embedded entry does not delete it.
+ */
+import { MARK, NODE } from "./doc.js";
+const HEADING_NODE = /^heading-([1-6])$/;
+/**
+ * Contentful's mark vocabulary, and the pivot marks they are.
+ *
+ * `strikethrough` is not in every space: it was added to the vocabulary later
+ * than the rest, and an environment whose field validation predates it rejects
+ * the mark. Reading one is always safe; writing one to an old space is not.
+ */
+const CONTENTFUL_TO_MARK = {
+    bold: MARK.bold,
+    italic: MARK.italic,
+    underline: MARK.underline,
+    code: MARK.code,
+    strikethrough: MARK.strike
+};
+const MARK_TO_CONTENTFUL = Object.fromEntries(Object.entries(CONTENTFUL_TO_MARK).map(([contentful, mark]) => [mark, contentful]));
+/** Link node types, and the pivot mark name each becomes. */
+const LINK_NODES = new Set(["hyperlink", "entry-hyperlink", "asset-hyperlink"]);
+function isObject(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+// ---------------------------------------------------------------------------
+// Contentful -> document
+// ---------------------------------------------------------------------------
+function marksToPivot(marks) {
+    const out = [];
+    for (const mark of marks ?? []) {
+        if (typeof mark?.type !== "string")
+            continue;
+        // An unmapped mark keeps its own name rather than being dropped: a space
+        // may declare `superscript`, and the pivot is open enough to hold it.
+        out.push({ type: CONTENTFUL_TO_MARK[mark.type] ?? mark.type });
+    }
+    return out;
+}
+function inlineToPivot(nodes) {
+    const out = [];
+    for (const node of nodes ?? []) {
+        if (node.nodeType === "text") {
+            const text = typeof node.value === "string" ? node.value : "";
+            if (text.length === 0)
+                continue;
+            const marks = marksToPivot(node.marks);
+            out.push({ type: NODE.text, text, ...(marks.length > 0 ? { marks } : {}) });
+            continue;
+        }
+        if (LINK_NODES.has(node.nodeType)) {
+            const attrs = node.nodeType === "hyperlink"
+                ? { href: typeof node.data?.uri === "string" ? node.data.uri : "" }
+                : { href: "", data: node.data ?? {} };
+            const linkMark = { type: node.nodeType === "hyperlink" ? MARK.link : node.nodeType, attrs };
+            for (const child of inlineToPivot(node.content)) {
+                out.push({ ...child, marks: [...(child.marks ?? []), linkMark] });
+            }
+            continue;
+        }
+        // An inline embed. No text to keep, so keep the node.
+        out.push({ type: NODE.unknown, attrs: { data: node } });
+    }
+    return out;
+}
+function blockToPivot(node) {
+    const heading = HEADING_NODE.exec(node.nodeType);
+    if (heading) {
+        const content = inlineToPivot(node.content);
+        const base = { type: NODE.heading, attrs: { level: Number(heading[1]) } };
+        return [content.length > 0 ? { ...base, content } : base];
+    }
+    switch (node.nodeType) {
+        case "paragraph": {
+            const content = inlineToPivot(node.content);
+            return [content.length > 0 ? { type: NODE.paragraph, content } : { type: NODE.paragraph }];
+        }
+        case "unordered-list":
+        case "ordered-list":
+            return [
+                {
+                    type: node.nodeType === "ordered-list" ? NODE.orderedList : NODE.bulletList,
+                    content: (node.content ?? [])
+                        .filter((child) => child.nodeType === "list-item")
+                        .map((child) => ({
+                        type: NODE.listItem,
+                        content: (child.content ?? []).flatMap(blockToPivot)
+                    }))
+                }
+            ];
+        case "blockquote":
+            return [{ type: NODE.blockquote, content: (node.content ?? []).flatMap(blockToPivot) }];
+        case "hr":
+            return [{ type: NODE.horizontalRule }];
+        default:
+            return [{ type: NODE.unknown, attrs: { data: node } }];
+    }
+}
+/** Convert a Contentful Rich Text document into the pivot document. */
+export function fromContentful(document) {
+    if (!isObject(document) || document.nodeType !== "document")
+        return { type: "doc", content: [] };
+    const content = Array.isArray(document.content) ? document.content : [];
+    return { type: "doc", content: content.filter(isObject).flatMap(blockToPivot) };
+}
+// ---------------------------------------------------------------------------
+// document -> Contentful
+// ---------------------------------------------------------------------------
+function linkMarkOf(node) {
+    const mark = node.marks?.find((m) => m.type === MARK.link || LINK_NODES.has(m.type));
+    if (!mark)
+        return undefined;
+    return { type: mark.type === MARK.link ? "hyperlink" : mark.type, attrs: mark.attrs ?? {} };
+}
+function textToContentful(node) {
+    const marks = [];
+    for (const mark of node.marks ?? []) {
+        if (mark.type === MARK.link || LINK_NODES.has(mark.type))
+            continue;
+        marks.push({ type: MARK_TO_CONTENTFUL[mark.type] ?? mark.type });
+    }
+    return { nodeType: "text", value: node.text ?? "", marks, data: {} };
+}
+function linkData(nodeType, attrs) {
+    if (nodeType === "hyperlink")
+        return { uri: typeof attrs.href === "string" ? attrs.href : "" };
+    return isObject(attrs.data) ? attrs.data : {};
+}
+/**
+ * Serialise inline nodes, gathering adjacent text that shares one link into a
+ * single wrapper node. Contentful models a link as a node around its text, so
+ * emitting one wrapper per text node would split every multi-span link in two.
+ */
+function inlineToContentful(nodes) {
+    const out = [];
+    let openLink;
+    const flush = () => {
+        openLink = undefined;
+    };
+    for (const node of nodes ?? []) {
+        if (node.type === NODE.unknown && isObject(node.attrs?.data)) {
+            flush();
+            out.push(node.attrs.data);
+            continue;
+        }
+        if (node.type === NODE.hardBreak) {
+            // Contentful has no break node — a newline inside the text value is how
+            // the reference renderers express a soft break.
+            const target = openLink ? openLink.node.content : out;
+            const last = target?.[target.length - 1];
+            if (last && typeof last.value === "string")
+                last.value += "\n";
+            continue;
+        }
+        if (typeof node.text !== "string" || node.text.length === 0)
+            continue;
+        const link = linkMarkOf(node);
+        if (!link) {
+            flush();
+            out.push(textToContentful(node));
+            continue;
+        }
+        const key = `${link.type}::${JSON.stringify(link.attrs)}`;
+        if (!openLink || openLink.key !== key) {
+            openLink = {
+                key,
+                node: { nodeType: link.type, data: linkData(link.type, link.attrs), content: [] }
+            };
+            out.push(openLink.node);
+        }
+        openLink.node.content.push(textToContentful(node));
+    }
+    return out;
+}
+function nodeToContentful(node) {
+    switch (node.type) {
+        case NODE.paragraph:
+            return [{ nodeType: "paragraph", data: {}, content: inlineToContentful(node.content) }];
+        case NODE.heading: {
+            const level = typeof node.attrs?.level === "number" ? Math.min(6, Math.max(1, node.attrs.level)) : 2;
+            return [{ nodeType: `heading-${level}`, data: {}, content: inlineToContentful(node.content) }];
+        }
+        case NODE.bulletList:
+        case NODE.orderedList:
+            return [
+                {
+                    nodeType: node.type === NODE.orderedList ? "ordered-list" : "unordered-list",
+                    data: {},
+                    content: (node.content ?? []).map((item) => ({
+                        nodeType: "list-item",
+                        data: {},
+                        content: (item.content ?? []).flatMap(nodeToContentful)
+                    }))
+                }
+            ];
+        case NODE.blockquote:
+            return [{ nodeType: "blockquote", data: {}, content: (node.content ?? []).flatMap(nodeToContentful) }];
+        case NODE.codeBlock: {
+            /*
+             * Contentful has no code *block* — `code` is a mark on text. The closest
+             * faithful rendering is a paragraph whose text carries that mark, which
+             * is what the reference renderers style as a code span. Round-tripping a
+             * code block through Contentful therefore returns a code-marked
+             * paragraph, not a code block.
+             */
+            const code = (node.content ?? []).map((c) => c.text ?? "").join("");
+            return [
+                {
+                    nodeType: "paragraph",
+                    data: {},
+                    content: [{ nodeType: "text", value: code, marks: [{ type: "code" }], data: {} }]
+                }
+            ];
+        }
+        case NODE.horizontalRule:
+            return [{ nodeType: "hr", data: {}, content: [] }];
+        case NODE.unknown:
+            return isObject(node.attrs?.data) ? [node.attrs.data] : [];
+        default:
+            return (node.content ?? []).flatMap(nodeToContentful);
+    }
+}
+/** Convert the pivot document back to a Contentful Rich Text document. */
+export function toContentful(doc) {
+    return {
+        nodeType: "document",
+        data: {},
+        content: (doc.content ?? []).flatMap(nodeToContentful)
+    };
+}

package/dist/doc.d.ts

@@ -0,0 +1,83 @@
+/**
+ * The pivot format: a ProseMirror document.
+ *
+ * Every CMS in this package models rich text differently — Contentful nests a
+ * recursive `document` tree, Sanity keeps a flat array of Portable Text blocks,
+ * Strapi a flat Slate-shaped array — and Avocado's own `richtext` fields hold a
+ * markdown string. Converting each pair directly would need six converters and
+ * would still lose whatever the two ends did not have in common. Instead every
+ * format converts to and from one shape, and that shape is the ProseMirror
+ * document the property panel already edits natively (`RichTextJsonField`).
+ *
+ * The types are deliberately open — `type` is a `string`, not a union of the
+ * names we know. A Portable Text block with a custom `_type`, a Contentful
+ * `embedded-entry-block`, a mark some space enabled last week: none of them are
+ * in our vocabulary, and a closed union would force each converter to throw the
+ * value away. They ride through the pivot as data instead, which is what makes
+ * a round trip through Avocado non-destructive for content Avocado cannot edit.
+ *
+ * Node and mark names are Tiptap's, because the editor is Tiptap: `paragraph`,
+ * `heading`, `bulletList`, `orderedList`, `listItem`, `blockquote`, `codeBlock`,
+ * `horizontalRule`, `hardBreak`, `text`; marks `bold`, `italic`, `strike`,
+ * `code`, `underline`, `link`.
+ */
+export type RichTextMark = {
+    type: string;
+    attrs?: Record<string, unknown> | null;
+};
+export type RichTextNode = {
+    type: string;
+    attrs?: Record<string, unknown> | null;
+    content?: RichTextNode[];
+    marks?: RichTextMark[];
+    text?: string;
+};
+export type RichTextDoc = {
+    type: "doc";
+    content: RichTextNode[];
+};
+/** Node names this package produces and understands. */
+export declare const NODE: {
+    readonly doc: "doc";
+    readonly paragraph: "paragraph";
+    readonly heading: "heading";
+    readonly bulletList: "bulletList";
+    readonly orderedList: "orderedList";
+    readonly listItem: "listItem";
+    readonly blockquote: "blockquote";
+    readonly codeBlock: "codeBlock";
+    readonly horizontalRule: "horizontalRule";
+    readonly hardBreak: "hardBreak";
+    readonly text: "text";
+    /**
+     * A block the pivot could not model — a Portable Text `_type` we do not know,
+     * a Contentful embedded entry, a Strapi image. It carries the source object
+     * untouched under `attrs.data` so the converter back out can re-emit it
+     * unchanged. The editor registers a matching read-only node, so it also
+     * survives a trip through the property panel in its original position.
+     */
+    readonly unknown: "avocadoUnknownBlock";
+};
+/** Mark names this package produces and understands. */
+export declare const MARK: {
+    readonly bold: "bold";
+    readonly italic: "italic";
+    readonly strike: "strike";
+    readonly code: "code";
+    readonly underline: "underline";
+    readonly link: "link";
+};
+/**
+ * A richtext value stored as a document rather than a markdown string.
+ *
+ * The same signature `block-manifest.ts` keys its `isProseMirrorDocSchema` off:
+ * an object whose `type` is the literal `"doc"`. Anything else — a markdown
+ * string included — is not a document and must not be handed to the converters.
+ */
+export declare function isRichTextDoc(value: unknown): value is RichTextDoc;
+export declare function emptyDoc(): RichTextDoc;
+/** Parse an Avocado markdown richtext value into the pivot document. */
+export declare function fromMarkdown(markdown: string): RichTextDoc;
+export declare function escapeMarkdownText(text: string): string;
+/** Serialise the pivot document to an Avocado markdown richtext value. */
+export declare function toMarkdown(input: RichTextDoc | RichTextNode[]): string;