@uniformdev/richtext 20.75.1-alpha.0 → 20.76.1-alpha.3

package/dist/index.js

@@ -25,6 +25,8 @@ __export(index_exports, {
   emptyRichTextValue: () => emptyRichTextValue,
   getLabelForElement: () => getLabelForElement,
   getLabelForFormat: () => getLabelForFormat,
+  getRichTextListItemValue: () => getRichTextListItemValue,
+  getRichTextListStart: () => getRichTextListStart,
   getRichTextTagFromTableCellHeaderState: () => getRichTextTagFromTableCellHeaderState,
   getRichTextTagsFromTextFormat: () => getRichTextTagsFromTextFormat,
   hasChildren: () => hasChildren,
@@ -43,8 +45,10 @@ __export(index_exports, {
   linkParamValueToHtmlAttributes: () => linkParamValueToHtmlAttributes,
   listHtmlRenderer: () => listHtmlRenderer,
   listitemHtmlRenderer: () => listitemHtmlRenderer,
+  omitDefaultRichTextProperties: () => omitDefaultRichTextProperties,
   paragraphHtmlRenderer: () => paragraphHtmlRenderer,
   purifyText: () => purifyText,
+  rehydrateDefaultRichTextProperties: () => rehydrateDefaultRichTextProperties,
   renderChildrenToHtml: () => renderChildrenToHtml,
   renderChildrenToText: () => renderChildrenToText,
   renderHtmlElement: () => renderHtmlElement,
@@ -248,18 +252,23 @@ var listHtmlRenderer = ({ context, renderChildren }) => {
   var _a;
   const node = context.currentNode;
   const attributes = /* @__PURE__ */ new Map();
-  if (node.start > 1) {
-    attributes.set("start", node.start.toString());
+  const start = getRichTextListStart(node.start);
+  if (typeof start === "number" && start > 1) {
+    attributes.set("start", start.toString());
   }
   return renderHtmlElement((_a = node.tag) != null ? _a : "ul", attributes, renderChildren(context.currentNode.children));
 };
+function getRichTextListStart(start) {
+  return start === void 0 ? 1 : start;
+}
 
 // src/nodes/listitem.ts
 var listitemHtmlRenderer = ({ context, renderChildren }) => {
   const node = context.currentNode;
   const attributes = /* @__PURE__ */ new Map();
-  if (Number.isFinite(node.value) && node.value > 0) {
-    attributes.set("value", node.value.toString());
+  const value = getRichTextListItemValue(node.value);
+  if (typeof value === "number" && value > 0) {
+    attributes.set("value", value.toString());
   }
   return renderHtmlElement("li", attributes, renderChildren(context.currentNode.children));
 };
@@ -273,6 +282,9 @@ var listitemTextRenderer = ({ context, renderChildren }) => {
   }
   return `${childrenRendered} `;
 };
+function getRichTextListItemValue(value) {
+  return value === void 0 ? 1 : value;
+}
 
 // src/nodes/paragraph.ts
 var paragraphHtmlRenderer = ({ context, renderChildren }) => {
@@ -319,7 +331,7 @@ var tablecellTextRenderer = ({ context, renderChildren }) => {
   return hasChildren(context.currentNode) ? `${renderChildren(context.currentNode.children)} ` : "";
 };
 function getRichTextTagFromTableCellHeaderState(headerState) {
-  if (headerState === 0) {
+  if (!headerState) {
     return "td";
   }
   return "th";
@@ -348,6 +360,9 @@ var textTextRenderer = ({ context }) => {
 };
 function getRichTextTagsFromTextFormat(format) {
   const tags = [];
+  if (!format) {
+    return tags;
+  }
   if (format & 1 << 0) {
     tags.push("strong");
   }
@@ -372,154 +387,133 @@ function getRichTextTagsFromTextFormat(format) {
   return tags;
 }
 
-// src/nodes/tab.ts
-var tabHtmlRenderer = () => {
-  return "	";
-};
-var tabTextRenderer = () => {
-  return "	";
-};
-
-// src/renderToHtml.ts
-var rendererTypeMap = /* @__PURE__ */ new Map([
-  ["heading", headingHtmlRenderer],
-  ["link", linkHtmlRenderer],
-  ["list", listHtmlRenderer],
-  ["listitem", listitemHtmlRenderer],
-  ["paragraph", paragraphHtmlRenderer],
-  ["root", rootHtmlRenderer],
-  ["text", textHtmlRenderer],
-  ["tab", tabHtmlRenderer],
-  ["table", tableHtmlRenderer],
-  ["tablecell", tablecellHtmlRenderer],
-  ["tablerow", tablerowHtmlRenderer],
-  ["asset", assetHtmlRenderer]
+// src/defaultRichTextNodeProperties.ts
+var OMITTED_RICH_TEXT_NODE_VERSION = 1;
+var NO_DEFAULTS = Object.freeze({});
+var ELEMENT_BASELINE_V1 = Object.freeze({
+  format: "",
+  indent: 0,
+  direction: null,
+  version: 1
+});
+var TEXT_BASELINE_V1 = Object.freeze({
+  format: 0,
+  style: "",
+  mode: "normal",
+  detail: 0,
+  version: 1
+});
+var VERSION_ONLY_V1 = Object.freeze({
+  version: 1
+});
+var ELEMENT_PROPERTIES_SAFE_TO_OMIT = Object.freeze([
+  "format",
+  "indent",
+  "direction"
+  // 'version', // Retain until SDKs that treat missing `version` as `1` are widely adopted.
 ]);
-var resolveDefaultRenderer = (context) => {
-  const renderer = rendererTypeMap.get(context.currentNode.type);
-  if (renderer) {
-    return renderer;
-  }
-  const tags = rendererTypeTagMap.get(context.currentNode.type);
-  if (tags) {
-    return ({ renderChildren }) => {
-      var _a;
-      return (_a = tags.reduceRight(
-        (children, tag) => {
-          return renderHtmlElement(tag, null, children);
-        },
-        hasChildren(context.currentNode) ? renderChildren(context.currentNode.children) : void 0
-      )) != null ? _a : "";
-    };
-  }
-  return () => `<!-- WARNING: No renderer for type ${context.currentNode.type} -->`;
-};
-function initializeRenderContext(node, parentContext) {
-  let ancestorNodes = [];
-  if (parentContext == null ? void 0 : parentContext.ancestorNodes) {
-    ancestorNodes = ancestorNodes.concat(parentContext.ancestorNodes);
-  }
-  if (parentContext == null ? void 0 : parentContext.currentNode) {
-    ancestorNodes.unshift(parentContext.currentNode);
-  }
-  return {
-    ...parentContext != null ? parentContext : {},
-    currentNode: node,
-    ancestorNodes
-  };
+var TEXT_PROPERTIES_SAFE_TO_OMIT = Object.freeze([
+  // 'format', // Retain until SDKs that treat missing text/tab `format` as `0` are widely adopted.
+  "style",
+  "mode",
+  "detail"
+  // 'version', // Retain until SDKs that treat missing `version` as `1` are widely adopted.
+]);
+var NO_PROPERTIES_SAFE_TO_OMIT = Object.freeze([
+  // 'version', // Retain until SDKs that treat missing `version` as `1` are widely adopted.
+]);
+var DEFAULT_RICH_TEXT_NODE_PROPERTIES = Object.freeze({
+  root: Object.freeze({ 1: ELEMENT_BASELINE_V1 }),
+  heading: Object.freeze({ 1: ELEMENT_BASELINE_V1 }),
+  quote: Object.freeze({ 1: ELEMENT_BASELINE_V1 }),
+  code: Object.freeze({ 1: ELEMENT_BASELINE_V1 }),
+  table: Object.freeze({ 1: ELEMENT_BASELINE_V1 }),
+  tablerow: Object.freeze({ 1: ELEMENT_BASELINE_V1 }),
+  link: Object.freeze({ 1: ELEMENT_BASELINE_V1 }),
+  paragraph: Object.freeze({
+    1: Object.freeze({ ...ELEMENT_BASELINE_V1, textFormat: 0, textStyle: "" })
+  }),
+  list: Object.freeze({ 1: Object.freeze({ ...ELEMENT_BASELINE_V1, start: 1 }) }),
+  listitem: Object.freeze({ 1: Object.freeze({ ...ELEMENT_BASELINE_V1, value: 1 }) }),
+  tablecell: Object.freeze({
+    1: Object.freeze({
+      ...ELEMENT_BASELINE_V1,
+      colSpan: 1,
+      rowSpan: 1,
+      backgroundColor: null,
+      headerState: 0
+    })
+  }),
+  text: Object.freeze({ 1: TEXT_BASELINE_V1 }),
+  tab: Object.freeze({ 1: TEXT_BASELINE_V1 }),
+  linebreak: Object.freeze({ 1: VERSION_ONLY_V1 }),
+  asset: Object.freeze({ 1: VERSION_ONLY_V1 }),
+  // Rich text variable binding still requires an explicit version, so variable nodes stay verbose.
+  variable: Object.freeze({ 1: NO_DEFAULTS })
+});
+var RICH_TEXT_NODE_PROPERTIES_SAFE_TO_OMIT = Object.freeze({
+  root: ELEMENT_PROPERTIES_SAFE_TO_OMIT,
+  heading: ELEMENT_PROPERTIES_SAFE_TO_OMIT,
+  quote: ELEMENT_PROPERTIES_SAFE_TO_OMIT,
+  code: ELEMENT_PROPERTIES_SAFE_TO_OMIT,
+  table: ELEMENT_PROPERTIES_SAFE_TO_OMIT,
+  tablerow: ELEMENT_PROPERTIES_SAFE_TO_OMIT,
+  link: ELEMENT_PROPERTIES_SAFE_TO_OMIT,
+  paragraph: Object.freeze([...ELEMENT_PROPERTIES_SAFE_TO_OMIT, "textFormat", "textStyle"]),
+  list: Object.freeze([
+    ...ELEMENT_PROPERTIES_SAFE_TO_OMIT
+    // 'start', // Retain until SDKs that treat missing list `start` as `1` are widely adopted.
+  ]),
+  listitem: Object.freeze([
+    ...ELEMENT_PROPERTIES_SAFE_TO_OMIT
+    // 'value', // Retain until SDKs that treat missing list-item `value` as `1` are widely adopted.
+  ]),
+  tablecell: Object.freeze([
+    ...ELEMENT_PROPERTIES_SAFE_TO_OMIT,
+    "colSpan",
+    "rowSpan",
+    "backgroundColor"
+    // 'headerState', // Retain until SDKs that treat missing `headerState` as `0` are widely adopted.
+  ]),
+  text: TEXT_PROPERTIES_SAFE_TO_OMIT,
+  tab: TEXT_PROPERTIES_SAFE_TO_OMIT,
+  linebreak: NO_PROPERTIES_SAFE_TO_OMIT,
+  asset: NO_PROPERTIES_SAFE_TO_OMIT,
+  variable: NO_PROPERTIES_SAFE_TO_OMIT
+});
+function getStoredRichTextNodeVersion(node) {
+  return typeof node.version === "number" ? node.version : OMITTED_RICH_TEXT_NODE_VERSION;
 }
-function renderToHtml(node, parentContext) {
-  var _a;
-  if (!isRichTextNode(node)) return "";
-  const context = initializeRenderContext(node, parentContext);
-  let renderer = (_a = context.resolveRenderer) == null ? void 0 : _a.call(context, context);
-  if (typeof renderer === "undefined") {
-    renderer = resolveDefaultRenderer(context);
-  } else if (renderer === null) {
-    return "";
+function isOmittableRichTextDefault(key, nodeValue, defaultValue) {
+  if (!Object.is(nodeValue, defaultValue)) {
+    return false;
   }
-  const renderChildren = (children) => renderChildrenToHtml(children, context);
-  if (renderer) {
-    return renderer({ context, renderChildren });
-  } else {
-    throw new Error(`There is no renderer for node type: ${context.currentNode.type}`);
+  if (key === "version") {
+    return Object.is(nodeValue, OMITTED_RICH_TEXT_NODE_VERSION);
   }
+  return true;
 }
-function renderChildrenToHtml(children, context) {
-  return Array.isArray(children) ? children.map((node) => renderToHtml(node, context)).join("") : "";
-}
-
-// src/nodes/linebreak.ts
-var linebreakTextRenderer = () => {
-  return " ";
-};
-
-// src/renderToText.ts
-var rendererTypeMap2 = /* @__PURE__ */ new Map([
-  ["text", textTextRenderer],
-  ["tab", tabTextRenderer],
-  ["linebreak", linebreakTextRenderer],
-  ["paragraph", paragraphTextRenderer],
-  ["listitem", listitemTextRenderer],
-  ["heading", headingTextRenderer],
-  ["table", tableTextRenderer],
-  ["tablecell", tablecellTextRenderer],
-  ["tablerow", tablerowTextRenderer]
-]);
-var resolveDefaultRenderer2 = (context) => {
-  const renderer = rendererTypeMap2.get(context.currentNode.type);
-  if (renderer) {
-    return renderer;
-  }
-  return ({ context: context2, renderChildren }) => {
-    return hasChildren(context2.currentNode) ? renderChildren(context2.currentNode.children) : "";
-  };
-};
-function initializeRenderContext2(node, parentContext) {
-  let ancestorNodes = [];
-  if (parentContext == null ? void 0 : parentContext.ancestorNodes) {
-    ancestorNodes = ancestorNodes.concat(parentContext.ancestorNodes);
+function getDefaultRichTextPropertiesForNode(node) {
+  var _a;
+  const version = getStoredRichTextNodeVersion(node);
+  const defaultsForType = DEFAULT_RICH_TEXT_NODE_PROPERTIES[node.type];
+  if (defaultsForType) {
+    return (_a = defaultsForType[version]) != null ? _a : NO_DEFAULTS;
   }
-  if (parentContext == null ? void 0 : parentContext.currentNode) {
-    ancestorNodes.unshift(parentContext.currentNode);
+  if (version !== OMITTED_RICH_TEXT_NODE_VERSION) {
+    return NO_DEFAULTS;
   }
-  return {
-    ...parentContext != null ? parentContext : {},
-    currentNode: node,
-    ancestorNodes
-  };
-}
-function renderToText(node, parentContext) {
-  var _a;
-  if (!isRichTextNode(node)) return "";
-  const context = initializeRenderContext2(node, parentContext);
-  let renderer = (_a = context.resolveRenderer) == null ? void 0 : _a.call(context, context);
-  if (typeof renderer === "undefined") {
-    renderer = resolveDefaultRenderer2(context);
-  } else if (renderer === null) {
-    return "";
+  if ("text" in node) {
+    return TEXT_BASELINE_V1;
   }
-  const renderChildren = (children) => renderChildrenToText(children, context);
-  if (renderer) {
-    const rendered = renderer({ context, renderChildren });
-    return context.ancestorNodes.length > 0 ? rendered : rendered.trim();
-  } else {
-    throw new Error(`There is no renderer for node type: ${context.currentNode.type}`);
+  if ("children" in node) {
+    return ELEMENT_BASELINE_V1;
   }
+  return VERSION_ONLY_V1;
 }
-function renderChildrenToText(children, context) {
-  return Array.isArray(children) ? children.map((node) => renderToText(node, context)).join("") : "";
-}
-
-// src/types.ts
-function resolveLinkAttrConfig(entry) {
+function getRichTextPropertiesSafeToOmit(node) {
   var _a;
-  return {
-    key: entry.key,
-    options: entry.options,
-    label: (_a = entry.label) != null ? _a : entry.key,
-    helpText: entry.helpText
-  };
+  return (_a = RICH_TEXT_NODE_PROPERTIES_SAFE_TO_OMIT[node.type]) != null ? _a : NO_PROPERTIES_SAFE_TO_OMIT;
 }
 
 // src/utils.ts
@@ -672,6 +666,200 @@ var defaultParameterConfiguration = {
     }
   }
 };
+
+// src/omitDefaultRichTextProperties.ts
+function omitDefaultPropertiesFromNode(node) {
+  const defaults = getDefaultRichTextPropertiesForNode(node);
+  for (const key of getRichTextPropertiesSafeToOmit(node)) {
+    if (!(key in node)) {
+      continue;
+    }
+    const defaultValue = defaults[key];
+    if (isOmittableRichTextDefault(key, node[key], defaultValue)) {
+      delete node[key];
+    }
+  }
+}
+function omitDefaultRichTextProperties(value) {
+  if (!isRichTextValue(value)) {
+    return value;
+  }
+  const cloned = structuredClone(value);
+  walkRichTextTree(cloned.root, (node) => {
+    omitDefaultPropertiesFromNode(node);
+  });
+  return cloned;
+}
+
+// src/rehydrateDefaultRichTextProperties.ts
+function rehydrateDefaultPropertiesOnNode(node) {
+  const defaults = getDefaultRichTextPropertiesForNode(node);
+  for (const [key, defaultValue] of Object.entries(defaults)) {
+    if (!(key in node)) {
+      node[key] = defaultValue;
+    }
+  }
+}
+function rehydrateDefaultRichTextProperties(value) {
+  if (!isRichTextValue(value)) {
+    return value;
+  }
+  const cloned = structuredClone(value);
+  walkRichTextTree(cloned.root, (node) => {
+    rehydrateDefaultPropertiesOnNode(node);
+  });
+  return cloned;
+}
+
+// src/nodes/tab.ts
+var tabHtmlRenderer = () => {
+  return "	";
+};
+var tabTextRenderer = () => {
+  return "	";
+};
+
+// src/renderToHtml.ts
+var rendererTypeMap = /* @__PURE__ */ new Map([
+  ["heading", headingHtmlRenderer],
+  ["link", linkHtmlRenderer],
+  ["list", listHtmlRenderer],
+  ["listitem", listitemHtmlRenderer],
+  ["paragraph", paragraphHtmlRenderer],
+  ["root", rootHtmlRenderer],
+  ["text", textHtmlRenderer],
+  ["tab", tabHtmlRenderer],
+  ["table", tableHtmlRenderer],
+  ["tablecell", tablecellHtmlRenderer],
+  ["tablerow", tablerowHtmlRenderer],
+  ["asset", assetHtmlRenderer]
+]);
+var resolveDefaultRenderer = (context) => {
+  const renderer = rendererTypeMap.get(context.currentNode.type);
+  if (renderer) {
+    return renderer;
+  }
+  const tags = rendererTypeTagMap.get(context.currentNode.type);
+  if (tags) {
+    return ({ renderChildren }) => {
+      var _a;
+      return (_a = tags.reduceRight(
+        (children, tag) => {
+          return renderHtmlElement(tag, null, children);
+        },
+        hasChildren(context.currentNode) ? renderChildren(context.currentNode.children) : void 0
+      )) != null ? _a : "";
+    };
+  }
+  return () => `<!-- WARNING: No renderer for type ${context.currentNode.type} -->`;
+};
+function initializeRenderContext(node, parentContext) {
+  let ancestorNodes = [];
+  if (parentContext == null ? void 0 : parentContext.ancestorNodes) {
+    ancestorNodes = ancestorNodes.concat(parentContext.ancestorNodes);
+  }
+  if (parentContext == null ? void 0 : parentContext.currentNode) {
+    ancestorNodes.unshift(parentContext.currentNode);
+  }
+  return {
+    ...parentContext != null ? parentContext : {},
+    currentNode: node,
+    ancestorNodes
+  };
+}
+function renderToHtml(node, parentContext) {
+  var _a;
+  if (!isRichTextNode(node)) return "";
+  const context = initializeRenderContext(node, parentContext);
+  let renderer = (_a = context.resolveRenderer) == null ? void 0 : _a.call(context, context);
+  if (typeof renderer === "undefined") {
+    renderer = resolveDefaultRenderer(context);
+  } else if (renderer === null) {
+    return "";
+  }
+  const renderChildren = (children) => renderChildrenToHtml(children, context);
+  if (renderer) {
+    return renderer({ context, renderChildren });
+  } else {
+    throw new Error(`There is no renderer for node type: ${context.currentNode.type}`);
+  }
+}
+function renderChildrenToHtml(children, context) {
+  return Array.isArray(children) ? children.map((node) => renderToHtml(node, context)).join("") : "";
+}
+
+// src/nodes/linebreak.ts
+var linebreakTextRenderer = () => {
+  return " ";
+};
+
+// src/renderToText.ts
+var rendererTypeMap2 = /* @__PURE__ */ new Map([
+  ["text", textTextRenderer],
+  ["tab", tabTextRenderer],
+  ["linebreak", linebreakTextRenderer],
+  ["paragraph", paragraphTextRenderer],
+  ["listitem", listitemTextRenderer],
+  ["heading", headingTextRenderer],
+  ["table", tableTextRenderer],
+  ["tablecell", tablecellTextRenderer],
+  ["tablerow", tablerowTextRenderer]
+]);
+var resolveDefaultRenderer2 = (context) => {
+  const renderer = rendererTypeMap2.get(context.currentNode.type);
+  if (renderer) {
+    return renderer;
+  }
+  return ({ context: context2, renderChildren }) => {
+    return hasChildren(context2.currentNode) ? renderChildren(context2.currentNode.children) : "";
+  };
+};
+function initializeRenderContext2(node, parentContext) {
+  let ancestorNodes = [];
+  if (parentContext == null ? void 0 : parentContext.ancestorNodes) {
+    ancestorNodes = ancestorNodes.concat(parentContext.ancestorNodes);
+  }
+  if (parentContext == null ? void 0 : parentContext.currentNode) {
+    ancestorNodes.unshift(parentContext.currentNode);
+  }
+  return {
+    ...parentContext != null ? parentContext : {},
+    currentNode: node,
+    ancestorNodes
+  };
+}
+function renderToText(node, parentContext) {
+  var _a;
+  if (!isRichTextNode(node)) return "";
+  const context = initializeRenderContext2(node, parentContext);
+  let renderer = (_a = context.resolveRenderer) == null ? void 0 : _a.call(context, context);
+  if (typeof renderer === "undefined") {
+    renderer = resolveDefaultRenderer2(context);
+  } else if (renderer === null) {
+    return "";
+  }
+  const renderChildren = (children) => renderChildrenToText(children, context);
+  if (renderer) {
+    const rendered = renderer({ context, renderChildren });
+    return context.ancestorNodes.length > 0 ? rendered : rendered.trim();
+  } else {
+    throw new Error(`There is no renderer for node type: ${context.currentNode.type}`);
+  }
+}
+function renderChildrenToText(children, context) {
+  return Array.isArray(children) ? children.map((node) => renderToText(node, context)).join("") : "";
+}
+
+// src/types.ts
+function resolveLinkAttrConfig(entry) {
+  var _a;
+  return {
+    key: entry.key,
+    options: entry.options,
+    label: (_a = entry.label) != null ? _a : entry.key,
+    helpText: entry.helpText
+  };
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   assetHtmlRenderer,
@@ -679,6 +867,8 @@ var defaultParameterConfiguration = {
   emptyRichTextValue,
   getLabelForElement,
   getLabelForFormat,
+  getRichTextListItemValue,
+  getRichTextListStart,
   getRichTextTagFromTableCellHeaderState,
   getRichTextTagsFromTextFormat,
   hasChildren,
@@ -697,8 +887,10 @@ var defaultParameterConfiguration = {
   linkParamValueToHtmlAttributes,
   listHtmlRenderer,
   listitemHtmlRenderer,
+  omitDefaultRichTextProperties,
   paragraphHtmlRenderer,
   purifyText,
+  rehydrateDefaultRichTextProperties,
   renderChildrenToHtml,
   renderChildrenToText,
   renderHtmlElement,