@avocadostudio-ai/richtext 0.5.1 → 0.6.0

package/dist/index.d.ts

@@ -21,3 +21,4 @@ export { deepEqual, omitDeep, mergeByIdentity, mergeRichTextDoc } from "./merge.
 export { fromPortableText, toPortableText, type PortableTextBlock, type PortableTextSpan, type PortableTextMarkDef, type ToPortableTextOptions } from "./portable-text.ts";
 export { fromContentful, toContentful, type ContentfulDocument, type ContentfulNode, type ContentfulMark } from "./contentful.ts";
 export { fromStrapiBlocks, toStrapiBlocks, type StrapiNode, type StrapiText } from "./strapi.ts";
+export { fromStoryblok, toStoryblok, isStoryblokRichText, isEmptyRichText, type StoryblokRichText } from "./storyblok.ts";

package/dist/index.js

@@ -21,3 +21,4 @@ export { deepEqual, omitDeep, mergeByIdentity, mergeRichTextDoc } from "./merge.
 export { fromPortableText, toPortableText } from "./portable-text.js";
 export { fromContentful, toContentful } from "./contentful.js";
 export { fromStrapiBlocks, toStrapiBlocks } from "./strapi.js";
+export { fromStoryblok, toStoryblok, isStoryblokRichText, isEmptyRichText } from "./storyblok.js";

package/dist/storyblok.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Storyblok rich text <-> the pivot document.
+ *
+ * Both are ProseMirror documents, which is the whole reason this file is
+ * short — and the reason it is embarrassing that it was the missing one. This
+ * package calls the ProseMirror document "the pivot every CMS converts to and
+ * from", ships converters for Portable Text, Contentful and Strapi, all three
+ * of which are a different shape, and had nothing for the one CMS whose native
+ * rich text already *is* the pivot. An integrator arriving with Storyblok
+ * either rewrites these ninety lines or, much more likely, flattens the field
+ * to a string and loses every mark, link and list on the first publish.
+ *
+ * The differences are three, and all mechanical:
+ *
+ *   1. Node naming. Storyblok writes `bullet_list`, the pivot writes
+ *      `bulletList`; same for ordered_list / list_item / code_block /
+ *      horizontal_rule / hard_break. Everything else — `paragraph`,
+ *      `heading`, `blockquote`, `text`, and every mark the pivot models —
+ *      is spelled identically in both.
+ *   2. `blok`: a Storyblok node that embeds a whole component inside prose.
+ *      The pivot has a slot for exactly this, `avocadoUnknownBlock`, which
+ *      carries the source object under `attrs.data` and re-emits it unchanged.
+ *      Storyblok keeps the same payload under `attrs.body`, so the conversion
+ *      is a move, not a projection — nothing about the embedded component is
+ *      interpreted, which is what lets it survive a trip through the panel.
+ *   3. Marks Storyblok has and the pivot does not model — `styled`,
+ *      `highlight`, `textStyle`, `anchor`, `subscript`, `superscript`. They
+ *      are carried through untouched rather than dropped; a span keeps its
+ *      unknown marks unless the span itself is edited.
+ *
+ * Round-trip is the contract: for any value in the space,
+ * `toStoryblok(fromStoryblok(doc))` must equal `doc`. This implementation was
+ * verified that way over 559 documents in a production tri-lingual space
+ * before it was moved here.
+ */
+import { type RichTextDoc, type RichTextNode } from "./doc.ts";
+/** A Storyblok rich-text value, as the Delivery API returns it. */
+export type StoryblokRichText = {
+    type: string;
+    content?: unknown[];
+    [key: string]: unknown;
+};
+export declare function isStoryblokRichText(value: unknown): value is StoryblokRichText;
+/**
+ * True when the document holds no text and embeds nothing — Storyblok's
+ * "empty" rich text, which is a `doc` with an empty paragraph in it rather
+ * than an absent value. Worth asking before writing: publishing an empty
+ * document over a field the CMS considers unset is a change, and it will show
+ * up in the diff of every page nobody edited.
+ */
+export declare function isEmptyRichText(value: unknown): boolean;
+/** Storyblok rich text -> the ProseMirror document the property panel edits. */
+export declare function fromStoryblok(doc: unknown): RichTextDoc;
+/**
+ * The edited document -> Storyblok's rich text, ready to store.
+ *
+ * A plain string is accepted and wrapped in a paragraph. It should not happen
+ * — the manifest pins the prop's schema to `type: "doc"`, and the panel gives
+ * it a rich-text editor — but a planner adding a *new* list row writes the
+ * value it would write for any other text field, and a string arriving at a
+ * document field used to convert to an empty document. The row saved, the card
+ * drew its title, and the sentence underneath it was gone, with nothing
+ * logged.
+ */
+export declare function toStoryblok(doc: RichTextDoc | unknown): StoryblokRichText;
+export type { RichTextDoc, RichTextNode };

package/dist/storyblok.js

@@ -0,0 +1,135 @@
+/**
+ * Storyblok rich text <-> the pivot document.
+ *
+ * Both are ProseMirror documents, which is the whole reason this file is
+ * short — and the reason it is embarrassing that it was the missing one. This
+ * package calls the ProseMirror document "the pivot every CMS converts to and
+ * from", ships converters for Portable Text, Contentful and Strapi, all three
+ * of which are a different shape, and had nothing for the one CMS whose native
+ * rich text already *is* the pivot. An integrator arriving with Storyblok
+ * either rewrites these ninety lines or, much more likely, flattens the field
+ * to a string and loses every mark, link and list on the first publish.
+ *
+ * The differences are three, and all mechanical:
+ *
+ *   1. Node naming. Storyblok writes `bullet_list`, the pivot writes
+ *      `bulletList`; same for ordered_list / list_item / code_block /
+ *      horizontal_rule / hard_break. Everything else — `paragraph`,
+ *      `heading`, `blockquote`, `text`, and every mark the pivot models —
+ *      is spelled identically in both.
+ *   2. `blok`: a Storyblok node that embeds a whole component inside prose.
+ *      The pivot has a slot for exactly this, `avocadoUnknownBlock`, which
+ *      carries the source object under `attrs.data` and re-emits it unchanged.
+ *      Storyblok keeps the same payload under `attrs.body`, so the conversion
+ *      is a move, not a projection — nothing about the embedded component is
+ *      interpreted, which is what lets it survive a trip through the panel.
+ *   3. Marks Storyblok has and the pivot does not model — `styled`,
+ *      `highlight`, `textStyle`, `anchor`, `subscript`, `superscript`. They
+ *      are carried through untouched rather than dropped; a span keeps its
+ *      unknown marks unless the span itself is edited.
+ *
+ * Round-trip is the contract: for any value in the space,
+ * `toStoryblok(fromStoryblok(doc))` must equal `doc`. This implementation was
+ * verified that way over 559 documents in a production tri-lingual space
+ * before it was moved here.
+ */
+import { NODE } from "./doc.js";
+/** Storyblok's node name on the left, the pivot's on the right. */
+const NODE_IN = {
+    bullet_list: NODE.bulletList,
+    ordered_list: NODE.orderedList,
+    list_item: NODE.listItem,
+    code_block: NODE.codeBlock,
+    horizontal_rule: NODE.horizontalRule,
+    hard_break: NODE.hardBreak,
+    blok: NODE.unknown
+};
+const NODE_OUT = Object.fromEntries(Object.entries(NODE_IN).map(([storyblok, pivot]) => [pivot, storyblok]));
+export function isStoryblokRichText(value) {
+    return (!!value &&
+        typeof value === "object" &&
+        !Array.isArray(value) &&
+        value.type === "doc");
+}
+/**
+ * True when the document holds no text and embeds nothing — Storyblok's
+ * "empty" rich text, which is a `doc` with an empty paragraph in it rather
+ * than an absent value. Worth asking before writing: publishing an empty
+ * document over a field the CMS considers unset is a change, and it will show
+ * up in the diff of every page nobody edited.
+ */
+export function isEmptyRichText(value) {
+    if (!isStoryblokRichText(value))
+        return true;
+    return !hasContent(value.content);
+}
+function hasContent(nodes) {
+    if (!Array.isArray(nodes))
+        return false;
+    for (const node of nodes) {
+        if (!isObject(node))
+            continue;
+        if (node.type === "blok" || node.type === NODE.unknown)
+            return true;
+        if (typeof node.text === "string" && node.text !== "")
+            return true;
+        if (hasContent(node.content))
+            return true;
+    }
+    return false;
+}
+function isObject(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function convert(node, map, toStoryblokDirection) {
+    if (!isObject(node))
+        return node;
+    const sourceType = typeof node.type === "string" ? node.type : undefined;
+    const out = { ...node };
+    if (sourceType !== undefined)
+        out.type = map[sourceType] ?? sourceType;
+    /*
+     * `blok` carries its payload in `attrs.body`; the pivot's unknown-block slot
+     * carries it in `attrs.data`. Moving it is what makes the node survive the
+     * editor, which renders an unknown block read-only rather than deleting it.
+     */
+    if (!toStoryblokDirection && sourceType === "blok") {
+        out.attrs = { data: isObject(node.attrs) ? node.attrs : {} };
+    }
+    else if (toStoryblokDirection && sourceType === NODE.unknown) {
+        const attrs = isObject(node.attrs) ? node.attrs : {};
+        out.attrs = isObject(attrs.data) ? attrs.data : {};
+    }
+    if (Array.isArray(node.content)) {
+        out.content = node.content.map((child) => convert(child, map, toStoryblokDirection));
+    }
+    return out;
+}
+/** Storyblok rich text -> the ProseMirror document the property panel edits. */
+export function fromStoryblok(doc) {
+    if (!isStoryblokRichText(doc))
+        return { type: "doc", content: [] };
+    return convert(doc, NODE_IN, false);
+}
+/**
+ * The edited document -> Storyblok's rich text, ready to store.
+ *
+ * A plain string is accepted and wrapped in a paragraph. It should not happen
+ * — the manifest pins the prop's schema to `type: "doc"`, and the panel gives
+ * it a rich-text editor — but a planner adding a *new* list row writes the
+ * value it would write for any other text field, and a string arriving at a
+ * document field used to convert to an empty document. The row saved, the card
+ * drew its title, and the sentence underneath it was gone, with nothing
+ * logged.
+ */
+export function toStoryblok(doc) {
+    if (typeof doc === "string") {
+        const text = doc.trim();
+        if (text === "")
+            return { type: "doc", content: [] };
+        return { type: "doc", content: [{ type: "paragraph", content: [{ type: "text", text: doc }] }] };
+    }
+    if (!isObject(doc))
+        return { type: "doc", content: [] };
+    return convert(doc, NODE_OUT, true);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avocadostudio-ai/richtext",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -28,14 +28,15 @@
     "tsx": "^4.21.0",
     "typescript": "^5.7.3"
   },
-  "description": "The Avocado Studio rich-text grammar and converters for Contentful, Sanity Portable Text and Strapi Blocks",
+  "description": "The Avocado Studio rich-text grammar and converters for Contentful, Sanity Portable Text, Strapi Blocks and Storyblok",
   "keywords": [
     "richtext",
     "markdown",
     "prosemirror",
     "portable-text",
     "contentful",
-    "strapi"
+    "strapi",
+    "storyblok"
   ],
   "license": "Apache-2.0",
   "homepage": "https://docs.avocadostudio.dev",