@teleporthq/teleport-shared 0.43.71 → 0.43.75

package/dist/esm/utils/rich-text-content.d.ts

@@ -0,0 +1,150 @@
+/**
+ * The stored form of rich-text content (a blog post body, a product
+ * description) and its editor form.
+ *
+ * STORED: plain HTML — `<p>`, `<h1>`–`<h6>`, nested `<ul>`/`<ol>`, `<blockquote>`
+ * holding paragraphs, `<pre><code class="language-x">`, `<table>` with its
+ * `<thead>`/`<th>`, `<aside class="tq-callout" data-kind="note">`, the image and
+ * embed figures, and inline marks. What a published page renders and what an
+ * import writes.
+ *
+ * EDITOR: what a Quill editor can hold without rewriting it. Lists become one
+ * flat `<ol>` of `<li data-list>` lines with `ql-indent-N` for nesting, a
+ * blockquote becomes one `<blockquote>` line per paragraph, and everything Quill
+ * has no blot for — a table, a code block, a callout, a list whose items hold
+ * blocks, anything unknown — is wrapped in a PROTECTED block:
+ * `<div class="tq-protected" data-tq-protected="table" contenteditable="false">`
+ * holding the stored markup untouched. The editors register that wrapper as a
+ * block embed, so Quill treats it as one atomic unit and never looks inside.
+ *
+ * Both editors (the studio post form on the `quill` fork, the generated admin
+ * panel on react-quill-new) run `toEditorHtml` on the way in and
+ * `fromEditorHtml` on the way out. `normalizeLegacyRichTextHtml` additionally
+ * understands what the two editors wrote BEFORE this contract existed, so an
+ * older post is cleaned on its next save and renders right meanwhile — it is
+ * string-only, so the generated project can run it where there is no DOM.
+ *
+ * Emission rules (see `__tests__/_helpers/rich-text-content-runtime-emitter.ts`):
+ * the generated admin editor receives these very functions printed as a module,
+ * so an exported function may call only other exported functions and the
+ * constants below — never an import or a module-private helper.
+ */
+export declare const PROTECTED_BLOCK_CLASS = "tq-protected";
+export declare const PROTECTED_BLOCK_ATTR = "data-tq-protected";
+export declare const PROTECTED_BLOCK_BLOT_NAME = "tq-protected-block";
+export declare const PROTECTED_BLOCK_KINDS: string[];
+export type ProtectedBlockKind = 'table' | 'code' | 'callout' | 'list' | 'quote' | 'html';
+export interface ProtectedBlockValue {
+    kind: ProtectedBlockKind;
+    /** The stored markup of the block, exactly as it will be written back. */
+    html: string;
+}
+export declare const CALLOUT_CLASS = "tq-callout";
+export declare const CALLOUT_KIND_ATTR = "data-kind";
+export declare const CALLOUT_KINDS: string[];
+export type CalloutKind = 'note' | 'tip' | 'important' | 'warning' | 'caution';
+/** ⛔ PAIRED with `EMBED_CLASS_NAME` in `rich-text-embeds.ts` (a test keeps them equal). */
+export declare const RICH_TEXT_EMBED_CLASS = "tq-embed";
+/** ⛔ PAIRED with the image blot in teleport-gui `features/blog/components/content-image-blot.ts`. */
+export declare const RICH_TEXT_IMAGE_CLASS = "ql-content-image";
+export declare const QUILL_LIST_ITEM_ATTR = "data-list";
+export declare const QUILL_INDENT_CLASS_PREFIX = "ql-indent-";
+/** Marks that can sit inside a line; anything else is a block to Quill. */
+export declare const RICH_TEXT_INLINE_TAGS: string[];
+/** Elements that stand on their own line; white space between two of them carries nothing. */
+export declare const RICH_TEXT_BLOCK_TAGS: string[];
+/** Parses an HTML fragment into a detached body the way a browser would. */
+export declare function parseRichTextFragment(html: string): HTMLElement;
+export declare function escapeRichTextText(value: string): string;
+export declare function escapeRichTextAttribute(value: string): string;
+export declare function isProtectedBlockKind(value: string | null | undefined): value is ProtectedBlockKind;
+/** The editor-side wrapper for one stored block. */
+export declare function buildProtectedBlockHtml(kind: ProtectedBlockKind, html: string): string;
+export declare function readProtectedBlockValue(element: Element): ProtectedBlockValue;
+export declare function isCalloutKind(value: string | null | undefined): value is CalloutKind;
+/** The stored markup of a callout: a kind and the blocks it holds. */
+export declare function buildCalloutHtml(kind: CalloutKind, innerHtml: string): string;
+/** The stored markup of a code block; `code` is already HTML-escaped when `escaped` is set. */
+export declare function buildCodeBlockHtml(language: string, code: string, escaped?: boolean): string;
+export declare function hasClass(element: Element, className: string): boolean;
+export declare function isRichTextInlineNode(node: Node): boolean;
+export declare function isBlankTextNode(node: Node): boolean;
+export declare function isRichTextBlockElement(node: Node | null): boolean;
+/**
+ * Drops the white space that only separates blocks (the newlines a Markdown
+ * renderer puts between `<li>`s, after `</p>`) and collapses runs of it inside
+ * text to the one space they render as, so stored HTML has one spelling
+ * whatever wrote it. Everything inside `<pre>` stays.
+ */
+export declare function stripInterBlockWhitespace(root: Node): void;
+/** `<li><p>one paragraph</p></li>` means the same as `<li>one paragraph</li>`; stored HTML uses the short form. */
+export declare function unwrapSingleParagraphListItems(root: Element): void;
+/** A link to another web page: an absolute http(s) address. Everything else stays in the tab. */
+export declare function isExternalWebLink(href: string): boolean;
+/**
+ * Quill creates every link with `target="_blank"`. Stored HTML decides for
+ * itself: a link to another web page opens in a new tab, a link to a page of
+ * the same site (or a mail or phone link) opens in this one.
+ */
+export declare function normalizeLinkTargets(root: Element): void;
+/** A quote holds paragraphs; bare inline content inside one becomes its single paragraph. */
+export declare function wrapBareBlockquoteContent(root: Element): void;
+/** The markup of one node as it sits in its parent: text escaped, elements whole. */
+export declare function serializeRichTextNode(node: Node): string;
+/**
+ * The inline markup of a list item: text and marks, a single wrapping `<p>`
+ * unwrapped, nested lists left out.
+ */
+export declare function readInlineHtml(element: Element): string;
+/**
+ * A list Quill can hold as lines: every item is inline content (at most one
+ * `<p>` around it) followed, at most, by one nested list that is itself simple,
+ * and no `start` offset on a numbered list.
+ */
+export declare function isQuillSimpleList(list: Element): boolean;
+/** One flat `<ol>` of `<li data-list>` lines, the shape Quill keeps a list in. */
+export declare function flattenListForQuill(list: Element): string;
+/** A blockquote Quill can hold: paragraphs (or bare inline content) only. */
+export declare function isQuillSimpleBlockquote(quote: Element): boolean;
+/** One `<blockquote>` line per paragraph, the shape Quill keeps a quote in. */
+export declare function blockquoteLinesForQuill(quote: Element): string;
+/** Which protected kind a stored block that Quill cannot hold gets. */
+export declare function protectedKindForElement(element: Element): ProtectedBlockKind;
+/**
+ * Stored HTML → what the editor is given. Every block Quill holds natively is
+ * handed over in Quill's own shape; every other block is protected.
+ */
+export declare function toEditorHtml(storedHtml: string): string;
+/**
+ * What the editor holds → stored HTML. Protected blocks are unwrapped, Quill's
+ * flat lists and blockquote lines are rebuilt, and Quill's own helpers are
+ * stripped. Idempotent on stored HTML.
+ */
+export declare function fromEditorHtml(editorHtml: string): string;
+/** Stored HTML in its one canonical spelling, whatever dialect it arrived in. */
+export declare function toCanonicalRichTextHtml(html: string): string;
+/** Quill keeps an empty line as `<p><br></p>`; one at either end carries nothing. */
+export declare function trimEmptyEdgeParagraphs(html: string): string;
+/**
+ * What the editors wrote before this contract, turned into stored HTML. String
+ * only, so a generated page can run it in `getStaticProps`:
+ * - the studio's lists: one `<ol>` of `<li data-list="bullet|ordered">` with
+ *   `ql-indent-N` and an empty `<span class="ql-ui">` per line;
+ * - the studio's code blocks: `div.ql-code-block-container` of line divs;
+ * - the studio's quotes: one `<blockquote>` element per line;
+ * - the admin panel's text: every space a no-break space;
+ * - the admin panel's code blocks: `<pre data-language>` with no `<code>`.
+ * Leaves stored HTML as it is.
+ */
+export declare function normalizeLegacyRichTextHtml(html: string): string;
+/** The nested `<ul>`/`<ol>` that a flat run of Quill list lines means. */
+export declare function rebuildQuillListHtml(innerHtml: string): string;
+/** The `<pre><code>` that a run of the studio's code-block line divs means. */
+export declare function rebuildQuillCodeBlockHtml(innerHtml: string): string;
+/**
+ * One `<blockquote>` of paragraphs out of a run of single-line quotes (one line
+ * is a run too). A run whose lines already hold blocks is stored HTML and is
+ * left alone.
+ */
+export declare function mergeBlockquoteLines(run: string): string;
+//# sourceMappingURL=rich-text-content.d.ts.map

package/dist/esm/utils/rich-text-content.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rich-text-content.d.ts","sourceRoot":"","sources":["../../../src/utils/rich-text-content.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAEH,eAAO,MAAM,qBAAqB,iBAAiB,CAAA;AACnD,eAAO,MAAM,oBAAoB,sBAAsB,CAAA;AACvD,eAAO,MAAM,yBAAyB,uBAAuB,CAAA;AAE7D,eAAO,MAAM,qBAAqB,UAAwD,CAAA;AAC1F,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAA;AAEzF,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,kBAAkB,CAAA;IACxB,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAA;CACb;AAED,eAAO,MAAM,aAAa,eAAe,CAAA;AACzC,eAAO,MAAM,iBAAiB,cAAc,CAAA;AAC5C,eAAO,MAAM,aAAa,UAAqD,CAAA;AAC/E,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,KAAK,GAAG,WAAW,GAAG,SAAS,GAAG,SAAS,CAAA;AAE9E,2FAA2F;AAC3F,eAAO,MAAM,qBAAqB,aAAa,CAAA;AAC/C,qGAAqG;AACrG,eAAO,MAAM,qBAAqB,qBAAqB,CAAA;AAEvD,eAAO,MAAM,oBAAoB,cAAc,CAAA;AAC/C,eAAO,MAAM,yBAAyB,eAAe,CAAA;AAErD,2EAA2E;AAC3E,eAAO,MAAM,qBAAqB,UAqBjC,CAAA;AAED,8FAA8F;AAC9F,eAAO,MAAM,oBAAoB,UAqChC,CAAA;AAED,4EAA4E;AAC5E,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAG/D;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAExD;AAED,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE7D;AAED,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAC/B,KAAK,IAAI,kBAAkB,CAE7B;AAED,oDAAoD;AACpD,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAMtF;AAED,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,OAAO,GAAG,mBAAmB,CAM7E;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,KAAK,IAAI,WAAW,CAEpF;AAED,sEAAsE;AACtE,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAE7E;AAED,+FAA+F;AAC/F,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAK5F;AAED,wBAAgB,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAGrE;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAQxD;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAEnD;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,OAAO,CAIjE;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAgC1D;AAED,mHAAmH;AACnH,wBAAgB,8BAA8B,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,CAkBlE;AAED,iGAAiG;AACjG,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEvD;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,CAYxD;AAED,6FAA6F;AAC7F,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,CAW7D;AAED,qFAAqF;AACrF,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAQxD;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAgBvD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAwCxD;AAED,kFAAkF;AAClF,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAmBzD;AAED,6EAA6E;AAC7E,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAY/D;AAED,+EAA+E;AAC/E,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAmB9D;AAED,uEAAuE;AACvE,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,OAAO,GAAG,kBAAkB,CAkB5E;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CA6CvD;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAoBzD;AAED,iFAAiF;AACjF,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE5D;AAED,qFAAqF;AACrF,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAI5D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAqBhE;AAED,0EAA0E;AAC1E,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAuD9D;AAED,+EAA+E;AAC/E,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAcnE;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAYxD"}