@uniformdev/richtext 20.75.0 → 20.75.1-alpha.15.sha-b6ff05804e

package/dist/index.d.mts

@@ -6,10 +6,17 @@ 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;
 
+/**
+ * Serialized Lexical node as stored on Uniform rich text parameters.
+ *
+ * Stored payloads may omit default-valued properties. Custom renderers must
+ * treat a missing `version` as `1`.
+ */
 interface RichTextNode extends Record<string, unknown> {
     type: string;
     children?: RichTextNode[];
-    version: number;
+    /** Lexical node version. Missing values are interpreted as `1`. */
+    version?: number;
 }
 type RichTextNodeWithChildren = RichTextNode & {
     children: RichTextNode[];
@@ -122,14 +129,24 @@ declare function linkParamValueToHref(link: LinkParamValue): string | undefined;
 
 interface ListNode extends RichTextNode {
     tag: 'ul' | 'ol';
-    start: number;
+    /** Ordered-list start index. Missing values are interpreted as `1`. */
+    start?: number;
 }
 declare const listHtmlRenderer: NodeStringRenderer;
+/**
+ * Normalizes an optional serialized list start while preserving invalid explicit values.
+ */
+declare function getRichTextListStart(start?: number): number;
 
 interface ListItemNode extends RichTextNode {
-    value: number;
+    /** List item ordinal. Missing values are interpreted as `1`. */
+    value?: number;
 }
 declare const listitemHtmlRenderer: NodeStringRenderer;
+/**
+ * Normalizes an optional serialized list item ordinal while preserving invalid explicit values.
+ */
+declare function getRichTextListItemValue(value?: number): number;
 
 interface ParagraphNode extends RichTextNode {
     format?: 'center' | 'end' | 'justify' | 'left' | 'match-parent' | 'right' | 'start';
@@ -149,14 +166,17 @@ interface TableCellNode extends RichTextNode {
      *  1: row header
      *  2: column header
      *  3: row and column header
+     *
+     * Missing values are interpreted as `0` (no header).
      */
-    headerState: number;
+    headerState?: number;
 }
 declare const tablecellHtmlRenderer: NodeStringRenderer;
 /**
- * Convert headerState into relevant tag
+ * Convert headerState into relevant tag.
+ * Missing or 0 means a body cell (`td`); any non-zero flag is a header (`th`).
  */
-declare function getRichTextTagFromTableCellHeaderState(headerState: number): "td" | "th";
+declare function getRichTextTagFromTableCellHeaderState(headerState?: number): "td" | "th";
 
 type TableRowNode = RichTextNode;
 declare const tablerowHtmlRenderer: NodeStringRenderer;
@@ -172,16 +192,18 @@ interface TextNode extends RichTextNode {
      *  position 5: code
      *  position 6: subscript
      *  position 7: superscript
+     *
+     * Missing values are interpreted as `0` (no formatting).
      */
-    format: number;
+    format?: number;
     text: string;
 }
 declare const textHtmlRenderer: NodeStringRenderer;
 /**
- * Convert format bitflag for holding text formats
- * into relevant tags
+ * Convert format bitflag for holding text formats into relevant tags.
+ * Missing format is treated as `0` (no formatting), matching the serialized default.
  */
-declare function getRichTextTagsFromTextFormat(format: number): string[];
+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;
@@ -199,6 +221,18 @@ declare function hasChildren<TRichTextNode extends RichTextNode>(node: TRichText
     children: RichTextNode[];
 };
 
+/**
+ * Returns a clone with SDK-compatible Lexical default-valued properties removed.
+ * The input is not mutated, so stored or immer-frozen values are safe to pass directly.
+ */
+declare function omitDefaultRichTextProperties<T extends ParameterRichTextValue>(value: T): T;
+
+/**
+ * Returns a clone of the rich text value with omitted Lexical defaults restored.
+ * The input is not mutated, so stored or immer-frozen values are safe to pass directly.
+ */
+declare function rehydrateDefaultRichTextProperties<T extends ParameterRichTextValue>(value: T): T;
+
 /**
  * When a custom renderer has not been provided we
  * check to see if there is a renderer for the type
@@ -207,7 +241,7 @@ declare function hasChildren<TRichTextNode extends RichTextNode>(node: TRichText
  *
  * Some node types like quote just map directly to a
  * HTML tag (ie blockquote). For those there is a simple
- * type -> tag Map.
+ * `type -> tag` Map.
  */
 declare const resolveDefaultRenderer$1: ResolveStringRenderer;
 /**
@@ -270,4 +304,4 @@ declare const emptyRichTextValue: {
 };
 declare const defaultParameterConfiguration: RichTextParamConfiguration;
 
-export { type AssetNode, type HeadingNode, type LinkAttrConfig, type LinkAttributesConfiguration, type LinkNode, type ListItemNode, type ListNode, type NodeStringRenderer, type NodeStringRendererProps, type ParagraphNode, type ParameterRichTextValue, type ResolveStringRenderer, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextNode, type RichTextNodeWithChildren, type RichTextParamConfiguration, type StringRenderContext, type TableCellNode, type TableNode, type TableRowNode, type TextNode, assetHtmlRenderer, defaultParameterConfiguration, emptyRichTextValue, getLabelForElement, getLabelForFormat, getRichTextTagFromTableCellHeaderState, getRichTextTagsFromTextFormat, hasChildren, headingHtmlRenderer, isArrayWithLength, isDangerousLinkAttributeKey, isPureDirection, isPureTextAlign, isRichTextNode, isRichTextNodeType, isRichTextValue, isRichTextValueConsideredEmpty, linkHtmlRenderer, linkParamValueToAnchorProps, linkParamValueToHref, linkParamValueToHtmlAttributes, listHtmlRenderer, listitemHtmlRenderer, paragraphHtmlRenderer, purifyText, renderChildrenToHtml, renderChildrenToText, renderHtmlElement, renderToHtml, renderToText, resolveDefaultRenderer$1 as resolveDefaultHtmlRenderer, resolveDefaultRenderer as resolveDefaultTextRenderer, resolveLinkAttrConfig, richTextBuiltInElements, richTextBuiltInFormats, rootHtmlRenderer, tableHtmlRenderer, tablecellHtmlRenderer, tablerowHtmlRenderer, textHtmlRenderer, walkRichTextTree };
+export { type AssetNode, type HeadingNode, type LinkAttrConfig, type LinkAttributesConfiguration, type LinkNode, type ListItemNode, type ListNode, type NodeStringRenderer, type NodeStringRendererProps, type ParagraphNode, type ParameterRichTextValue, type ResolveStringRenderer, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextNode, type RichTextNodeWithChildren, type RichTextParamConfiguration, type StringRenderContext, type TableCellNode, type TableNode, type TableRowNode, type TextNode, assetHtmlRenderer, defaultParameterConfiguration, emptyRichTextValue, getLabelForElement, getLabelForFormat, getRichTextListItemValue, getRichTextListStart, getRichTextTagFromTableCellHeaderState, getRichTextTagsFromTextFormat, hasChildren, headingHtmlRenderer, isArrayWithLength, isDangerousLinkAttributeKey, isPureDirection, isPureTextAlign, isRichTextNode, isRichTextNodeType, isRichTextValue, isRichTextValueConsideredEmpty, linkHtmlRenderer, linkParamValueToAnchorProps, linkParamValueToHref, linkParamValueToHtmlAttributes, listHtmlRenderer, listitemHtmlRenderer, omitDefaultRichTextProperties, paragraphHtmlRenderer, purifyText, rehydrateDefaultRichTextProperties, renderChildrenToHtml, renderChildrenToText, renderHtmlElement, renderToHtml, renderToText, resolveDefaultRenderer$1 as resolveDefaultHtmlRenderer, resolveDefaultRenderer as resolveDefaultTextRenderer, resolveLinkAttrConfig, richTextBuiltInElements, richTextBuiltInFormats, rootHtmlRenderer, tableHtmlRenderer, tablecellHtmlRenderer, tablerowHtmlRenderer, textHtmlRenderer, walkRichTextTree };

package/dist/index.d.ts

@@ -6,10 +6,17 @@ 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;
 
+/**
+ * Serialized Lexical node as stored on Uniform rich text parameters.
+ *
+ * Stored payloads may omit default-valued properties. Custom renderers must
+ * treat a missing `version` as `1`.
+ */
 interface RichTextNode extends Record<string, unknown> {
     type: string;
     children?: RichTextNode[];
-    version: number;
+    /** Lexical node version. Missing values are interpreted as `1`. */
+    version?: number;
 }
 type RichTextNodeWithChildren = RichTextNode & {
     children: RichTextNode[];
@@ -122,14 +129,24 @@ declare function linkParamValueToHref(link: LinkParamValue): string | undefined;
 
 interface ListNode extends RichTextNode {
     tag: 'ul' | 'ol';
-    start: number;
+    /** Ordered-list start index. Missing values are interpreted as `1`. */
+    start?: number;
 }
 declare const listHtmlRenderer: NodeStringRenderer;
+/**
+ * Normalizes an optional serialized list start while preserving invalid explicit values.
+ */
+declare function getRichTextListStart(start?: number): number;
 
 interface ListItemNode extends RichTextNode {
-    value: number;
+    /** List item ordinal. Missing values are interpreted as `1`. */
+    value?: number;
 }
 declare const listitemHtmlRenderer: NodeStringRenderer;
+/**
+ * Normalizes an optional serialized list item ordinal while preserving invalid explicit values.
+ */
+declare function getRichTextListItemValue(value?: number): number;
 
 interface ParagraphNode extends RichTextNode {
     format?: 'center' | 'end' | 'justify' | 'left' | 'match-parent' | 'right' | 'start';
@@ -149,14 +166,17 @@ interface TableCellNode extends RichTextNode {
      *  1: row header
      *  2: column header
      *  3: row and column header
+     *
+     * Missing values are interpreted as `0` (no header).
      */
-    headerState: number;
+    headerState?: number;
 }
 declare const tablecellHtmlRenderer: NodeStringRenderer;
 /**
- * Convert headerState into relevant tag
+ * Convert headerState into relevant tag.
+ * Missing or 0 means a body cell (`td`); any non-zero flag is a header (`th`).
  */
-declare function getRichTextTagFromTableCellHeaderState(headerState: number): "td" | "th";
+declare function getRichTextTagFromTableCellHeaderState(headerState?: number): "td" | "th";
 
 type TableRowNode = RichTextNode;
 declare const tablerowHtmlRenderer: NodeStringRenderer;
@@ -172,16 +192,18 @@ interface TextNode extends RichTextNode {
      *  position 5: code
      *  position 6: subscript
      *  position 7: superscript
+     *
+     * Missing values are interpreted as `0` (no formatting).
      */
-    format: number;
+    format?: number;
     text: string;
 }
 declare const textHtmlRenderer: NodeStringRenderer;
 /**
- * Convert format bitflag for holding text formats
- * into relevant tags
+ * Convert format bitflag for holding text formats into relevant tags.
+ * Missing format is treated as `0` (no formatting), matching the serialized default.
  */
-declare function getRichTextTagsFromTextFormat(format: number): string[];
+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;
@@ -199,6 +221,18 @@ declare function hasChildren<TRichTextNode extends RichTextNode>(node: TRichText
     children: RichTextNode[];
 };
 
+/**
+ * Returns a clone with SDK-compatible Lexical default-valued properties removed.
+ * The input is not mutated, so stored or immer-frozen values are safe to pass directly.
+ */
+declare function omitDefaultRichTextProperties<T extends ParameterRichTextValue>(value: T): T;
+
+/**
+ * Returns a clone of the rich text value with omitted Lexical defaults restored.
+ * The input is not mutated, so stored or immer-frozen values are safe to pass directly.
+ */
+declare function rehydrateDefaultRichTextProperties<T extends ParameterRichTextValue>(value: T): T;
+
 /**
  * When a custom renderer has not been provided we
  * check to see if there is a renderer for the type
@@ -207,7 +241,7 @@ declare function hasChildren<TRichTextNode extends RichTextNode>(node: TRichText
  *
  * Some node types like quote just map directly to a
  * HTML tag (ie blockquote). For those there is a simple
- * type -> tag Map.
+ * `type -> tag` Map.
  */
 declare const resolveDefaultRenderer$1: ResolveStringRenderer;
 /**
@@ -270,4 +304,4 @@ declare const emptyRichTextValue: {
 };
 declare const defaultParameterConfiguration: RichTextParamConfiguration;
 
-export { type AssetNode, type HeadingNode, type LinkAttrConfig, type LinkAttributesConfiguration, type LinkNode, type ListItemNode, type ListNode, type NodeStringRenderer, type NodeStringRendererProps, type ParagraphNode, type ParameterRichTextValue, type ResolveStringRenderer, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextNode, type RichTextNodeWithChildren, type RichTextParamConfiguration, type StringRenderContext, type TableCellNode, type TableNode, type TableRowNode, type TextNode, assetHtmlRenderer, defaultParameterConfiguration, emptyRichTextValue, getLabelForElement, getLabelForFormat, getRichTextTagFromTableCellHeaderState, getRichTextTagsFromTextFormat, hasChildren, headingHtmlRenderer, isArrayWithLength, isDangerousLinkAttributeKey, isPureDirection, isPureTextAlign, isRichTextNode, isRichTextNodeType, isRichTextValue, isRichTextValueConsideredEmpty, linkHtmlRenderer, linkParamValueToAnchorProps, linkParamValueToHref, linkParamValueToHtmlAttributes, listHtmlRenderer, listitemHtmlRenderer, paragraphHtmlRenderer, purifyText, renderChildrenToHtml, renderChildrenToText, renderHtmlElement, renderToHtml, renderToText, resolveDefaultRenderer$1 as resolveDefaultHtmlRenderer, resolveDefaultRenderer as resolveDefaultTextRenderer, resolveLinkAttrConfig, richTextBuiltInElements, richTextBuiltInFormats, rootHtmlRenderer, tableHtmlRenderer, tablecellHtmlRenderer, tablerowHtmlRenderer, textHtmlRenderer, walkRichTextTree };
+export { type AssetNode, type HeadingNode, type LinkAttrConfig, type LinkAttributesConfiguration, type LinkNode, type ListItemNode, type ListNode, type NodeStringRenderer, type NodeStringRendererProps, type ParagraphNode, type ParameterRichTextValue, type ResolveStringRenderer, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextNode, type RichTextNodeWithChildren, type RichTextParamConfiguration, type StringRenderContext, type TableCellNode, type TableNode, type TableRowNode, type TextNode, assetHtmlRenderer, defaultParameterConfiguration, emptyRichTextValue, getLabelForElement, getLabelForFormat, getRichTextListItemValue, getRichTextListStart, getRichTextTagFromTableCellHeaderState, getRichTextTagsFromTextFormat, hasChildren, headingHtmlRenderer, isArrayWithLength, isDangerousLinkAttributeKey, isPureDirection, isPureTextAlign, isRichTextNode, isRichTextNodeType, isRichTextValue, isRichTextValueConsideredEmpty, linkHtmlRenderer, linkParamValueToAnchorProps, linkParamValueToHref, linkParamValueToHtmlAttributes, listHtmlRenderer, listitemHtmlRenderer, omitDefaultRichTextProperties, paragraphHtmlRenderer, purifyText, rehydrateDefaultRichTextProperties, renderChildrenToHtml, renderChildrenToText, renderHtmlElement, renderToHtml, renderToText, resolveDefaultRenderer$1 as resolveDefaultHtmlRenderer, resolveDefaultRenderer as resolveDefaultTextRenderer, resolveLinkAttrConfig, richTextBuiltInElements, richTextBuiltInFormats, rootHtmlRenderer, tableHtmlRenderer, tablecellHtmlRenderer, tablerowHtmlRenderer, textHtmlRenderer, walkRichTextTree };