@uniformdev/richtext 19.35.2 → 19.36.0

package/dist/index.d.mts

@@ -0,0 +1,158 @@
+import { LinkParamValue, RichTextParamValue, RichTextBuiltInElement, RichTextBuiltInFormat } from '@uniformdev/canvas';
+
+declare function purifyText(text: string): string;
+declare function isPureTextAlign(format?: string): format is string;
+declare function isPureDirection(direction?: string | null): direction is string;
+declare function renderHtmlElement(tag: string, attributes: Map<string, string> | null, children?: string): string;
+
+interface RichTextNode extends Record<string, unknown> {
+    type: string;
+    children?: RichTextNode[];
+    version: number;
+}
+type RichTextNodeWithChildren = RichTextNode & {
+    children: RichTextNode[];
+};
+type ResolveStringRenderer = (context: StringRenderContext) => NodeStringRenderer | null | undefined;
+interface StringRenderContext {
+    currentNode: RichTextNode;
+    ancestorNodes: RichTextNode[];
+    resolveRenderer?: ResolveStringRenderer;
+}
+interface NodeStringRendererProps {
+    context: StringRenderContext;
+    renderChildren(children?: RichTextNode[] | unknown): string;
+}
+type NodeStringRenderer = (props: NodeStringRendererProps) => string;
+type ParameterRichTextValue = {
+    root: RichTextNode;
+} | undefined;
+
+interface HeadingNode extends RichTextNode {
+    tag: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+}
+declare const headingHtmlRenderer: NodeStringRenderer;
+
+interface LinkNode extends RichTextNode {
+    link: NonNullable<LinkParamValue>;
+}
+declare const linkHtmlRenderer: NodeStringRenderer;
+declare function linkParamValueToHref(link: LinkParamValue): string | undefined;
+
+interface ListNode extends RichTextNode {
+    tag: 'ul' | 'ol';
+    start: number;
+}
+declare const listHtmlRenderer: NodeStringRenderer;
+
+interface ListItemNode extends RichTextNode {
+    value: number;
+}
+declare const listitemHtmlRenderer: NodeStringRenderer;
+
+interface ParagraphNode extends RichTextNode {
+    format?: 'center' | 'end' | 'justify' | 'left' | 'match-parent' | 'right' | 'start';
+    direction?: 'ltr' | 'rtl' | null;
+}
+declare const paragraphHtmlRenderer: NodeStringRenderer;
+
+declare const rootHtmlRenderer: NodeStringRenderer;
+
+interface TextNode extends RichTextNode {
+    /**
+     * The format is a bitflag value
+     * flags:
+     *  position 1: bold
+     *  position 2: italic
+     *  position 3: strikethrough
+     *  position 4: underline
+     *  position 5: code
+     *  position 6: subscript
+     *  position 7: superscript
+     */
+    format: number;
+    text: string;
+}
+declare const textHtmlRenderer: NodeStringRenderer;
+/**
+ * Convert format bitflag for holding text formats
+ * into relevant tags
+ */
+declare function getRichTextTagsFromTextFormat(format: number): string[];
+
+declare function isArrayWithLength<T>(arr: T[] | unknown | undefined): arr is T[];
+declare function isRichTextNode(node: unknown): node is RichTextNode;
+declare function isRichTextValue(value: unknown): value is NonNullable<RichTextParamValue>;
+declare function isRichTextNodeType(node: unknown, type: 'heading'): node is HeadingNode;
+declare function isRichTextNodeType(node: unknown, type: 'paragraph'): node is ParagraphNode;
+declare function isRichTextNodeType(node: unknown, type: 'text'): node is TextNode;
+declare function isRichTextNodeType(node: unknown, type: 'list'): node is ListNode;
+declare function isRichTextNodeType(node: unknown, type: 'listitem'): node is ListItemNode;
+declare function isRichTextNodeType(node: unknown, type: 'link'): node is LinkNode;
+declare function isRichTextNodeType(node: unknown, type: string): node is RichTextNode;
+declare function isRichTextValueConsideredEmpty(value: RichTextParamValue): boolean;
+declare function hasChildren<TRichTextNode extends RichTextNode>(node: TRichTextNode): node is TRichTextNode & {
+    children: RichTextNode[];
+};
+
+/**
+ * When a custom renderer has not been provided we
+ * check to see if there is a renderer for the type
+ * within the map above. These are for any node types
+ * which include extra logic.
+ *
+ * Some node types like quote just map directly to a
+ * HTML tag (ie blockquote). For those there is a simple
+ * type -> tag Map.
+ */
+declare const resolveDefaultRenderer$1: ResolveStringRenderer;
+/**
+ * Render a node and its children to HTML
+ *
+ * This could be the root node or a nested node
+ */
+declare function renderToHtml(node: RichTextNode | null | undefined, parentContext?: Partial<StringRenderContext>): string;
+/**
+ * Render an array of RichTextNodes to a string based
+ * on a particular context.
+ *
+ * This will often be called from within a NodeRenderer
+ * using the `renderChildren` prop.
+ */
+declare function renderChildrenToHtml(children: RichTextNode[] | undefined, context: StringRenderContext): string;
+
+/**
+ * When a custom renderer has not been provided we
+ * check to see if there is a renderer for the type
+ * within the map above. These are for any node types
+ * which include extra logic.
+ */
+declare const resolveDefaultRenderer: ResolveStringRenderer;
+/**
+ * Render a node and its children to text
+ *
+ * This could be the root node or a nested node
+ */
+declare function renderToText(node: RichTextNode | null | undefined, parentContext?: Partial<StringRenderContext>): string;
+/**
+ * Render an array of RichTextNodes to a string based
+ * on a particular context.
+ *
+ * This will often be called from within a NodeRenderer
+ * using the `renderChildren` prop.
+ */
+declare function renderChildrenToText(children: RichTextNode[] | undefined, context: StringRenderContext): string;
+
+declare const walkRichTextTree: (node: RichTextNode, callback: (node: RichTextNode, parent: RichTextNode | undefined) => void, parent?: RichTextNode) => void;
+declare const richTextBuiltInElements: {
+    label: string;
+    type: RichTextBuiltInElement;
+}[];
+declare const richTextBuiltInFormats: {
+    label: string;
+    type: RichTextBuiltInFormat;
+}[];
+declare const getLabelForElement: (type: string) => string;
+declare const getLabelForFormat: (type: string) => string;
+
+export { HeadingNode, LinkNode, ListItemNode, ListNode, NodeStringRenderer, NodeStringRendererProps, ParagraphNode, ParameterRichTextValue, ResolveStringRenderer, RichTextNode, RichTextNodeWithChildren, StringRenderContext, TextNode, getLabelForElement, getLabelForFormat, getRichTextTagsFromTextFormat, hasChildren, headingHtmlRenderer, isArrayWithLength, isPureDirection, isPureTextAlign, isRichTextNode, isRichTextNodeType, isRichTextValue, isRichTextValueConsideredEmpty, linkHtmlRenderer, linkParamValueToHref, listHtmlRenderer, listitemHtmlRenderer, paragraphHtmlRenderer, purifyText, renderChildrenToHtml, renderChildrenToText, renderHtmlElement, renderToHtml, renderToText, resolveDefaultRenderer$1 as resolveDefaultHtmlRenderer, resolveDefaultRenderer as resolveDefaultTextRenderer, richTextBuiltInElements, richTextBuiltInFormats, rootHtmlRenderer, textHtmlRenderer, walkRichTextTree };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/richtext",
-  "version": "19.35.2",
+  "version": "19.36.0",
   "description": "Common functionality and types for Uniform Rich Text parameters",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -45,7 +45,7 @@
     "@lexical/link": "^0.11.1",
     "@lexical/list": "^0.11.1",
     "@lexical/rich-text": "^0.11.1",
-    "@uniformdev/canvas": "^19.35.2",
+    "@uniformdev/canvas": "^19.36.0",
     "lexical": "^0.11.1"
   },
   "files": [
@@ -54,5 +54,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "64d3270175087c87cfaa29a283aa4a7b0a98fd2c"
+  "gitHead": "3ae246a7f0f39adeaf04ecba4c7e48c478c019ad"
 }