@estiva-app/ui 0.39.0 → 0.40.0

package/dist/RichText.d.ts

@@ -0,0 +1,78 @@
+import type { ReactNode } from 'react';
+/**
+ * Formatted text, drawn: headings, paragraphs, lists, a quote, code, a divider,
+ * a table and links.
+ *
+ * Both apps drew the same thing twice, from the same source — the text tree the
+ * protocol package builds (`toRenderTree` → `RenderBlock`, `RenderInline`) —
+ * and the two had drifted: headings, list markers, quotes and code differed,
+ * one app had tables and the other dropped them, one had links and the other
+ * printed the brackets (UIG-30). The look here is Katerina's picks of
+ * 28 September, one per difference, most of them Peek's.
+ *
+ * **It takes the tree, not the text.** The caller parses (the format comes from
+ * the item's tag, never from the body) and hands the blocks in. So this package
+ * does not depend on the protocol, and a caller can leave out a block it draws
+ * elsewhere before passing the rest. The types below are the tree's shape; the
+ * protocol's own types fit them.
+ *
+ * **Safe by construction.** The tree has nothing left to parse, and every
+ * string here reaches the page as a React child, so it is text. Nothing is set
+ * as HTML.
+ *
+ * **What a word points at stays the app's.** A person, an item from another
+ * app, a name the app recognises in plain text: `renderReference`,
+ * `renderText` and `renderBlock` are where each app draws its own.
+ */
+/** A run of text and the marks on it — the protocol's `RenderInline`. */
+export interface RichTextRun {
+    text: string;
+    marks: readonly string[];
+    /** A `nostr:` address this run stands for. `text` is the address itself. */
+    reference?: string;
+}
+/** A block of the tree — the protocol's `RenderBlock`. */
+export interface RichTextBlock {
+    type: string;
+    /** What the document called a block the tree does not know. */
+    typeName?: string;
+    /** The block's address, when it has one. Drawn as `data-block-id`. */
+    id?: string;
+    level?: 1 | 2 | 3;
+    language?: string;
+    /** A numbered list's first number. */
+    start?: number;
+    attrs?: Record<string, unknown>;
+    inline?: readonly RichTextRun[];
+    children?: readonly RichTextBlock[];
+}
+export type RichTextSize = 'default' | 'small';
+export interface RichTextProps {
+    /** The tree, already parsed. */
+    blocks: readonly RichTextBlock[];
+    /**
+     * Default `default`, the size of text you read. `small` is the same text one
+     * step down, with every heading, list, quote and table kept: an item shown
+     * inside a card.
+     */
+    size?: RichTextSize;
+    /**
+     * Draws plain text: what is left of a run once its links are drawn. Where an
+     * app turns words it recognises into chips. By default the text as it is.
+     */
+    renderText?: (text: string) => ReactNode;
+    /** Draws a run that stands for an address. By default its text. */
+    renderReference?: (reference: string, run: RichTextRun) => ReactNode;
+    /**
+     * Draws a block this part has no design for (an attachment, a widget). Return
+     * `undefined` to leave it to the part, which draws its words.
+     */
+    renderBlock?: (block: RichTextBlock) => ReactNode | undefined;
+}
+/**
+ * RichText's look, for a box you draw yourself: an editor's, so that what is
+ * being written looks the same as what is read. Put it on the editor's root.
+ */
+export declare function richTextClassName(size?: RichTextSize, className?: string): string;
+export declare function RichText({ blocks, size, renderText, renderReference, renderBlock, }: RichTextProps): import("react").JSX.Element | null;
+//# sourceMappingURL=RichText.d.ts.map

package/dist/RichText.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RichText.d.ts","sourceRoot":"","sources":["../src/RichText.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAc,SAAS,EAAE,MAAM,OAAO,CAAA;AAIlD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,yEAAyE;AACzE,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,SAAS,MAAM,EAAE,CAAA;IACxB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,0DAA0D;AAC1D,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,sEAAsE;IACtE,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC/B,MAAM,CAAC,EAAE,SAAS,WAAW,EAAE,CAAA;IAC/B,QAAQ,CAAC,EAAE,SAAS,aAAa,EAAE,CAAA;CACpC;AAED,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,OAAO,CAAA;AAE9C,MAAM,WAAW,aAAa;IAC5B,gCAAgC;IAChC,MAAM,EAAE,SAAS,aAAa,EAAE,CAAA;IAChC;;;;OAIG;IACH,IAAI,CAAC,EAAE,YAAY,CAAA;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,SAAS,CAAA;IACxC,mEAAmE;IACnE,eAAe,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,KAAK,SAAS,CAAA;IACpE;;;OAGG;IACH,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,SAAS,GAAG,SAAS,CAAA;CAC9D;AA0BD;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,GAAE,YAAwB,EAAE,SAAS,CAAC,EAAE,MAAM,UAGnF;AAyKD,wBAAgB,QAAQ,CAAC,EACvB,MAAM,EACN,IAAgB,EAChB,UAA2B,EAC3B,eAA+C,EAC/C,WAAW,GACZ,EAAE,aAAa,sCAQf"}

package/dist/eslint/index.js

@@ -242,6 +242,7 @@ var PART_LOOK_PROPS = {
   RailItem: ["active"],
   Reaction: ["pressed"],
   ReactionPicker: ["surface"],
+  RichText: ["size"],
   SectionHeader: ["hover"],
   SectionLabel: ["tone", "truncate"],
   Select: ["size"],