@relyio/sdk 0.12.0 → 0.13.0

package/dist/rich-text/index.cjs

@@ -1,29 +1,49 @@
 'use strict';
 
-var chunkFI5VIF4M_cjs = require('../chunk-FI5VIF4M.cjs');
+var chunkZ6GLWSSD_cjs = require('../chunk-Z6GLWSSD.cjs');
 require('../chunk-MWMSFIWN.cjs');
 
 
 
 Object.defineProperty(exports, "RICH_TEXT_VOID_TAGS", {
   enumerable: true,
-  get: function () { return chunkFI5VIF4M_cjs.RICH_TEXT_VOID_TAGS; }
+  get: function () { return chunkZ6GLWSSD_cjs.RICH_TEXT_VOID_TAGS; }
+});
+Object.defineProperty(exports, "entryHeadingAnchors", {
+  enumerable: true,
+  get: function () { return chunkZ6GLWSSD_cjs.entryHeadingAnchors; }
+});
+Object.defineProperty(exports, "escapeHtml", {
+  enumerable: true,
+  get: function () { return chunkZ6GLWSSD_cjs.escapeHtml; }
+});
+Object.defineProperty(exports, "isDeclaredRichTextNode", {
+  enumerable: true,
+  get: function () { return chunkZ6GLWSSD_cjs.isDeclaredRichTextNode; }
 });
 Object.defineProperty(exports, "renderRichText", {
   enumerable: true,
-  get: function () { return chunkFI5VIF4M_cjs.renderRichText; }
+  get: function () { return chunkZ6GLWSSD_cjs.renderRichText; }
+});
+Object.defineProperty(exports, "richTextHeadingAnchors", {
+  enumerable: true,
+  get: function () { return chunkZ6GLWSSD_cjs.richTextHeadingAnchors; }
+});
+Object.defineProperty(exports, "richTextHeadingSlug", {
+  enumerable: true,
+  get: function () { return chunkZ6GLWSSD_cjs.richTextHeadingSlug; }
 });
 Object.defineProperty(exports, "richTextToHtml", {
   enumerable: true,
-  get: function () { return chunkFI5VIF4M_cjs.richTextToHtml; }
+  get: function () { return chunkZ6GLWSSD_cjs.richTextToHtml; }
 });
 Object.defineProperty(exports, "richTextToMarkdown", {
   enumerable: true,
-  get: function () { return chunkFI5VIF4M_cjs.richTextToMarkdown; }
+  get: function () { return chunkZ6GLWSSD_cjs.richTextToMarkdown; }
 });
 Object.defineProperty(exports, "safeRichTextHref", {
   enumerable: true,
-  get: function () { return chunkFI5VIF4M_cjs.safeRichTextHref; }
+  get: function () { return chunkZ6GLWSSD_cjs.safeRichTextHref; }
 });
 //# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map

package/dist/rich-text/index.d.cts

@@ -1,148 +1,3 @@
-import { w as RichTextValue, t as RichTextTable, c as RichTextCodeGroup, o as RichTextNode, r as RichTextSpan, m as RichTextMark } from '../rich-text.d-rKmpgdGd.cjs';
-
-/**
- * The one walk of a rich-text tree into elements, for every output (REL-1804).
- *
- * Rich text is a versioned tree (ADR 0013, `RichTextValue`). What each built-in looks like by
- * default — which element a node or a mark becomes, with which attributes, holding what — is
- * written here once, generic over the output: {@link richTextToHtml} hands it a target that builds
- * strings, `@relyio/react`'s `<RichText>` one that builds React elements. So the HTML a server
- * writes and the markup `<RichText>` renders are one rendering by construction, not two kept equal
- * by hand; a test over the corpus holds them byte for byte.
- *
- * Three rules every output inherits from this walk:
- *
- * - **Every tag is a literal here, never data.** A heading's level picks from a fixed table, and a
- *   level the table lacks renders as a paragraph. An attribute's name is a literal too; its value is
- *   the target's to escape.
- * - **A link to an unsafe scheme is not a link.** An `href` is drawn only when it is relative or
- *   `http:`, `https:`, `mailto:` or `tel:` ({@link safeRichTextHref}); any other scheme —
- *   `javascript:`, `data:`, `vbscript:`, … — renders the link's text with no anchor, and a site's
- *   own `link` renderer is never handed one.
- * - **Version 1 grows by addition** (`rich-text-format.md`). The switches below cover every node
- *   and mark of the vocabulary this build knows, with no fallback: a type added to it fails to
- *   compile here until it is drawn. At run time a newer server can still send a `_type` this build
- *   does not know; such a node renders nothing, and such a mark renders its text unformatted. Never
- *   an error.
- */
-
-/** Every element the default rendering of rich text uses. A tag is always one of these literals. */
-type RichTextTag = 'p' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'blockquote' | 'ul' | 'ol' | 'li' | 'input' | 'pre' | 'code' | 'figure' | 'figcaption' | 'div' | 'table' | 'thead' | 'tbody' | 'tr' | 'th' | 'td' | 'hr' | 'br' | 'a' | 'strong' | 'em' | 'u' | 's' | 'mark' | 'sub' | 'sup';
-/** The elements that hold nothing and have no closing tag. */
-declare const RICH_TEXT_VOID_TAGS: ReadonlySet<RichTextTag>;
-/**
- * An element's attributes, in the order they are written. A value is a string or a number, or
- * `true` for a boolean attribute that is present. `style` is a CSS declaration list (`text-align:center`).
- */
-type RichTextAttributes = Readonly<Record<string, string | number | true>>;
-/** Every node a site may draw itself: all of them but a run of text, whose marks are drawn instead. */
-type RichTextReplaceableNode = Exclude<RichTextNode, RichTextSpan>;
-/** Where a node stands, for a renderer that draws it differently there. */
-interface RichTextNodeContext {
-    /** Whether a table row or cell is in the table's header row; `false` for every other node. */
-    readonly header: boolean;
-}
-/**
- * What a walk of the tree builds with. {@link renderRichText} decides what each built-in becomes and
- * calls `element` and `text` for it; `node` and `mark` are where an output may draw a node or a mark
- * its own way, handed the default drawing to fall back on.
- */
-interface RichTextTarget<Out> {
-    /** An element of the default rendering. `key` is the node's `_key` when the element is a node's own. */
-    element(tag: RichTextTag, attributes: RichTextAttributes | undefined, children: readonly Out[], key: string | undefined): Out;
-    /** Text, exactly as the tree holds it: the target escapes it. */
-    text(text: string): Out;
-    /**
-     * A node, given what it holds already drawn (`contents`) and the default drawing of it (`draw`).
-     * Return `draw(contents)` to draw it the default way.
-     */
-    node(node: RichTextReplaceableNode, contents: readonly Out[], draw: (contents: readonly Out[]) => Out, context: RichTextNodeContext): Out;
-    /**
-     * A mark around `contents`, the runs it covers already drawn. A link reaches it only with a safe
-     * `href`. Return `draw(contents)` to draw it the default way.
-     */
-    mark(mark: RichTextMark, contents: readonly Out[], draw: (contents: readonly Out[]) => Out): Out;
-}
-/**
- * What the walk renders: a `richText` field's tree, or a `table` or `code` field's value — exactly
- * one of the tree's built-ins (REL-1806), drawn as the same block is inside a tree, so a table field
- * on a page and a table in a doc render the same markup.
- */
-type RichTextRenderable = RichTextValue | RichTextTable | RichTextCodeGroup;
-/**
- * Walk `value` into `target`'s output: one entry per block the tree holds, in order — or, for a
- * `table` or `code` field's value, the one block it is. A block of a `_type` this build does not
- * know adds nothing.
- */
-declare function renderRichText<Out>(value: RichTextRenderable, target: RichTextTarget<Out>): Out[];
-/**
- * `href` as a link may carry it, or `undefined` when it must not be one: not a string, empty, or
- * naming a scheme outside `http:`, `https:`, `mailto:` and `tel:`. The scheme is read the way a
- * browser reads it — leading and trailing controls and spaces stripped, tabs and newlines removed
- * anywhere — so `" java\tscript:"` is the `javascript:` it runs as. The `href` returned is the one
- * given; escaping it is the output's.
- */
-declare function safeRichTextHref(href: unknown): string | undefined;
-
-/**
- * Rich text as HTML (REL-1804): the default rendering ({@link renderRichText}) written as a string.
- * No DOM and no dependency, so it runs the same in a browser, Node and a Worker.
- */
-
-/**
- * A rich-text value as HTML: every built-in drawn the way `<RichText>` from `@relyio/react` draws it
- * with no components given, text and attributes escaped. `''` for an absent value. A `table` or
- * `code` field's value — one of the tree's built-ins — is drawn as the same block inside a tree.
- *
- * - A link keeps its `href` only when it is relative or `http:`, `https:`, `mailto:` or `tel:`;
- *   one to any other scheme (`javascript:`, `data:`, …) renders its text with no anchor.
- * - A node of a `_type` this version of the SDK does not know — content a newer server sends —
- *   renders nothing, and a mark it does not know leaves its text unformatted.
- *
- * @example
- * ```ts
- * import { richTextToHtml } from '@relyio/sdk'
- *
- * const post = await relyio.content('post').findById('hello').execute()
- * const html = richTextToHtml(post?.body) // '<h2>Getting started</h2><p>Install the <code>SDK</code>…</p>'
- * ```
- */
-declare function richTextToHtml(value: RichTextRenderable | undefined): string;
-
-/**
- * Rich text as plain Markdown (REL-1804): GitHub Flavored Markdown — CommonMark with tables, task
- * lists and strikethrough — which drops what it cannot hold. RelyIO Markdown, the form that
- * round-trips through directives for what plain Markdown lacks, is a separate serializer (REL-1809).
- *
- * What plain Markdown cannot hold, and what becomes of it:
- *
- * - The marks `underline`, `highlight`, `subscript` and `superscript`: their text, unformatted.
- * - A code block's `filename`, `label` and line range: dropped; a code group's tabs follow one
- *   another as fenced blocks.
- * - A table's per-cell alignment: a column takes its first row's; a table with no header row gets
- *   an empty one, since a Markdown table has to have one; a cell's paragraphs and line breaks join
- *   with spaces.
- * - A line break in a heading: a space. An empty paragraph or heading: nothing.
- * - A link to a scheme other than `http:`, `https:`, `mailto:` and `tel:`: its text, as in HTML.
- * - A node of a `_type` this version of the SDK does not know: nothing. A mark it does not know:
- *   its text, unformatted.
- *
- * Text is escaped so it reads back as the same text: `*`, `_`, a bracket or a backtick in a
- * sentence is a character, not syntax.
- */
-
-/**
- * A rich-text value as plain Markdown, ending in a newline; `''` for an absent or empty value. What
- * Markdown cannot hold is dropped, its text kept (see the module's notes). A `table` or `code`
- * field's value — one of the tree's built-ins — is written as the same block inside a tree.
- *
- * @example
- * ```ts
- * import { richTextToMarkdown } from '@relyio/sdk'
- *
- * richTextToMarkdown(post.body) // '## Getting started\n\nInstall the `SDK`, then read the [**guide**](/docs/guide).\n'
- * ```
- */
-declare function richTextToMarkdown(value: RichTextRenderable | undefined): string;
-
-export { RICH_TEXT_VOID_TAGS, type RichTextAttributes, type RichTextNodeContext, type RichTextRenderable, type RichTextReplaceableNode, type RichTextTag, type RichTextTarget, renderRichText, richTextToHtml, richTextToMarkdown, safeRichTextHref };
+export { n as RICH_TEXT_VOID_TAGS, q as RichTextAnchorsOption, t as RichTextAttributes, u as RichTextBlocksOf, v as RichTextDeclaredOf, w as RichTextDeclaredWriters, x as RichTextEntryLinkOf, y as RichTextEntryLinkOption, j as RichTextHtmlDeclaredWriters, k as RichTextHtmlFieldOption, l as RichTextHtmlOptions, z as RichTextInlineOf, m as RichTextMarkdownOptions, A as RichTextNodeContext, B as RichTextRenderable, C as RichTextRenderableOf, D as RichTextReplaceableNode, E as RichTextTag, F as RichTextTarget, e as entryHeadingAnchors, g as escapeHtml, o as isDeclaredRichTextNode, p as renderRichText, d as richTextHeadingAnchors, f as richTextHeadingSlug, h as richTextToHtml, i as richTextToMarkdown, s as safeRichTextHref } from '../index--_u1nPHv.cjs';
+import '../rich-text.d-BWc-5gX1.cjs';
+import '../include-paths-Bs5FhNw2.cjs';

package/dist/rich-text/index.d.ts

@@ -1,148 +1,3 @@
-import { w as RichTextValue, t as RichTextTable, c as RichTextCodeGroup, o as RichTextNode, r as RichTextSpan, m as RichTextMark } from '../rich-text.d-rKmpgdGd.js';
-
-/**
- * The one walk of a rich-text tree into elements, for every output (REL-1804).
- *
- * Rich text is a versioned tree (ADR 0013, `RichTextValue`). What each built-in looks like by
- * default — which element a node or a mark becomes, with which attributes, holding what — is
- * written here once, generic over the output: {@link richTextToHtml} hands it a target that builds
- * strings, `@relyio/react`'s `<RichText>` one that builds React elements. So the HTML a server
- * writes and the markup `<RichText>` renders are one rendering by construction, not two kept equal
- * by hand; a test over the corpus holds them byte for byte.
- *
- * Three rules every output inherits from this walk:
- *
- * - **Every tag is a literal here, never data.** A heading's level picks from a fixed table, and a
- *   level the table lacks renders as a paragraph. An attribute's name is a literal too; its value is
- *   the target's to escape.
- * - **A link to an unsafe scheme is not a link.** An `href` is drawn only when it is relative or
- *   `http:`, `https:`, `mailto:` or `tel:` ({@link safeRichTextHref}); any other scheme —
- *   `javascript:`, `data:`, `vbscript:`, … — renders the link's text with no anchor, and a site's
- *   own `link` renderer is never handed one.
- * - **Version 1 grows by addition** (`rich-text-format.md`). The switches below cover every node
- *   and mark of the vocabulary this build knows, with no fallback: a type added to it fails to
- *   compile here until it is drawn. At run time a newer server can still send a `_type` this build
- *   does not know; such a node renders nothing, and such a mark renders its text unformatted. Never
- *   an error.
- */
-
-/** Every element the default rendering of rich text uses. A tag is always one of these literals. */
-type RichTextTag = 'p' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'blockquote' | 'ul' | 'ol' | 'li' | 'input' | 'pre' | 'code' | 'figure' | 'figcaption' | 'div' | 'table' | 'thead' | 'tbody' | 'tr' | 'th' | 'td' | 'hr' | 'br' | 'a' | 'strong' | 'em' | 'u' | 's' | 'mark' | 'sub' | 'sup';
-/** The elements that hold nothing and have no closing tag. */
-declare const RICH_TEXT_VOID_TAGS: ReadonlySet<RichTextTag>;
-/**
- * An element's attributes, in the order they are written. A value is a string or a number, or
- * `true` for a boolean attribute that is present. `style` is a CSS declaration list (`text-align:center`).
- */
-type RichTextAttributes = Readonly<Record<string, string | number | true>>;
-/** Every node a site may draw itself: all of them but a run of text, whose marks are drawn instead. */
-type RichTextReplaceableNode = Exclude<RichTextNode, RichTextSpan>;
-/** Where a node stands, for a renderer that draws it differently there. */
-interface RichTextNodeContext {
-    /** Whether a table row or cell is in the table's header row; `false` for every other node. */
-    readonly header: boolean;
-}
-/**
- * What a walk of the tree builds with. {@link renderRichText} decides what each built-in becomes and
- * calls `element` and `text` for it; `node` and `mark` are where an output may draw a node or a mark
- * its own way, handed the default drawing to fall back on.
- */
-interface RichTextTarget<Out> {
-    /** An element of the default rendering. `key` is the node's `_key` when the element is a node's own. */
-    element(tag: RichTextTag, attributes: RichTextAttributes | undefined, children: readonly Out[], key: string | undefined): Out;
-    /** Text, exactly as the tree holds it: the target escapes it. */
-    text(text: string): Out;
-    /**
-     * A node, given what it holds already drawn (`contents`) and the default drawing of it (`draw`).
-     * Return `draw(contents)` to draw it the default way.
-     */
-    node(node: RichTextReplaceableNode, contents: readonly Out[], draw: (contents: readonly Out[]) => Out, context: RichTextNodeContext): Out;
-    /**
-     * A mark around `contents`, the runs it covers already drawn. A link reaches it only with a safe
-     * `href`. Return `draw(contents)` to draw it the default way.
-     */
-    mark(mark: RichTextMark, contents: readonly Out[], draw: (contents: readonly Out[]) => Out): Out;
-}
-/**
- * What the walk renders: a `richText` field's tree, or a `table` or `code` field's value — exactly
- * one of the tree's built-ins (REL-1806), drawn as the same block is inside a tree, so a table field
- * on a page and a table in a doc render the same markup.
- */
-type RichTextRenderable = RichTextValue | RichTextTable | RichTextCodeGroup;
-/**
- * Walk `value` into `target`'s output: one entry per block the tree holds, in order — or, for a
- * `table` or `code` field's value, the one block it is. A block of a `_type` this build does not
- * know adds nothing.
- */
-declare function renderRichText<Out>(value: RichTextRenderable, target: RichTextTarget<Out>): Out[];
-/**
- * `href` as a link may carry it, or `undefined` when it must not be one: not a string, empty, or
- * naming a scheme outside `http:`, `https:`, `mailto:` and `tel:`. The scheme is read the way a
- * browser reads it — leading and trailing controls and spaces stripped, tabs and newlines removed
- * anywhere — so `" java\tscript:"` is the `javascript:` it runs as. The `href` returned is the one
- * given; escaping it is the output's.
- */
-declare function safeRichTextHref(href: unknown): string | undefined;
-
-/**
- * Rich text as HTML (REL-1804): the default rendering ({@link renderRichText}) written as a string.
- * No DOM and no dependency, so it runs the same in a browser, Node and a Worker.
- */
-
-/**
- * A rich-text value as HTML: every built-in drawn the way `<RichText>` from `@relyio/react` draws it
- * with no components given, text and attributes escaped. `''` for an absent value. A `table` or
- * `code` field's value — one of the tree's built-ins — is drawn as the same block inside a tree.
- *
- * - A link keeps its `href` only when it is relative or `http:`, `https:`, `mailto:` or `tel:`;
- *   one to any other scheme (`javascript:`, `data:`, …) renders its text with no anchor.
- * - A node of a `_type` this version of the SDK does not know — content a newer server sends —
- *   renders nothing, and a mark it does not know leaves its text unformatted.
- *
- * @example
- * ```ts
- * import { richTextToHtml } from '@relyio/sdk'
- *
- * const post = await relyio.content('post').findById('hello').execute()
- * const html = richTextToHtml(post?.body) // '<h2>Getting started</h2><p>Install the <code>SDK</code>…</p>'
- * ```
- */
-declare function richTextToHtml(value: RichTextRenderable | undefined): string;
-
-/**
- * Rich text as plain Markdown (REL-1804): GitHub Flavored Markdown — CommonMark with tables, task
- * lists and strikethrough — which drops what it cannot hold. RelyIO Markdown, the form that
- * round-trips through directives for what plain Markdown lacks, is a separate serializer (REL-1809).
- *
- * What plain Markdown cannot hold, and what becomes of it:
- *
- * - The marks `underline`, `highlight`, `subscript` and `superscript`: their text, unformatted.
- * - A code block's `filename`, `label` and line range: dropped; a code group's tabs follow one
- *   another as fenced blocks.
- * - A table's per-cell alignment: a column takes its first row's; a table with no header row gets
- *   an empty one, since a Markdown table has to have one; a cell's paragraphs and line breaks join
- *   with spaces.
- * - A line break in a heading: a space. An empty paragraph or heading: nothing.
- * - A link to a scheme other than `http:`, `https:`, `mailto:` and `tel:`: its text, as in HTML.
- * - A node of a `_type` this version of the SDK does not know: nothing. A mark it does not know:
- *   its text, unformatted.
- *
- * Text is escaped so it reads back as the same text: `*`, `_`, a bracket or a backtick in a
- * sentence is a character, not syntax.
- */
-
-/**
- * A rich-text value as plain Markdown, ending in a newline; `''` for an absent or empty value. What
- * Markdown cannot hold is dropped, its text kept (see the module's notes). A `table` or `code`
- * field's value — one of the tree's built-ins — is written as the same block inside a tree.
- *
- * @example
- * ```ts
- * import { richTextToMarkdown } from '@relyio/sdk'
- *
- * richTextToMarkdown(post.body) // '## Getting started\n\nInstall the `SDK`, then read the [**guide**](/docs/guide).\n'
- * ```
- */
-declare function richTextToMarkdown(value: RichTextRenderable | undefined): string;
-
-export { RICH_TEXT_VOID_TAGS, type RichTextAttributes, type RichTextNodeContext, type RichTextRenderable, type RichTextReplaceableNode, type RichTextTag, type RichTextTarget, renderRichText, richTextToHtml, richTextToMarkdown, safeRichTextHref };
+export { n as RICH_TEXT_VOID_TAGS, q as RichTextAnchorsOption, t as RichTextAttributes, u as RichTextBlocksOf, v as RichTextDeclaredOf, w as RichTextDeclaredWriters, x as RichTextEntryLinkOf, y as RichTextEntryLinkOption, j as RichTextHtmlDeclaredWriters, k as RichTextHtmlFieldOption, l as RichTextHtmlOptions, z as RichTextInlineOf, m as RichTextMarkdownOptions, A as RichTextNodeContext, B as RichTextRenderable, C as RichTextRenderableOf, D as RichTextReplaceableNode, E as RichTextTag, F as RichTextTarget, e as entryHeadingAnchors, g as escapeHtml, o as isDeclaredRichTextNode, p as renderRichText, d as richTextHeadingAnchors, f as richTextHeadingSlug, h as richTextToHtml, i as richTextToMarkdown, s as safeRichTextHref } from '../index-8DozAWsA.js';
+import '../rich-text.d-BWc-5gX1.js';
+import '../include-paths-Cb7iPCW2.js';

package/dist/rich-text/index.js

@@ -1,4 +1,4 @@
-export { RICH_TEXT_VOID_TAGS, renderRichText, richTextToHtml, richTextToMarkdown, safeRichTextHref } from '../chunk-3DRDHXLY.js';
+export { RICH_TEXT_VOID_TAGS, entryHeadingAnchors, escapeHtml, isDeclaredRichTextNode, renderRichText, richTextHeadingAnchors, richTextHeadingSlug, richTextToHtml, richTextToMarkdown, safeRichTextHref } from '../chunk-3NPPMGB6.js';
 import '../chunk-XQ4QHWZE.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map