@portabletext/block-tools 1.0.1 → 1.1.0

package/lib/index.js

@@ -1,10 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: !0 });
-var flatten = require("lodash/flatten.js"), types = require("@sanity/types"), isEqual = require("lodash/isEqual.js"), uniq = require("lodash/uniq.js"), getRandomValues = require("get-random-values-esm");
-function _interopDefaultCompat(e) {
-  return e && typeof e == "object" && "default" in e ? e : { default: e };
-}
-var flatten__default = /* @__PURE__ */ _interopDefaultCompat(flatten), isEqual__default = /* @__PURE__ */ _interopDefaultCompat(isEqual), uniq__default = /* @__PURE__ */ _interopDefaultCompat(uniq), getRandomValues__default = /* @__PURE__ */ _interopDefaultCompat(getRandomValues);
+import flatten from "lodash/flatten.js";
+import { isBlockSchemaType, isBlockChildrenObjectField, isObjectSchemaType, isBlockStyleObjectField, isBlockListObjectField, isTitledListValue, isPortableTextTextBlock, isPortableTextSpan } from "@sanity/types";
+import isEqual from "lodash/isEqual.js";
+import uniq from "lodash/uniq.js";
+import getRandomValues from "get-random-values-esm";
 function findBlockType(type) {
   return type.type ? findBlockType(type.type) : type.name === "block";
 }
@@ -92,19 +90,19 @@ const PRESERVE_WHITESPACE_TAGS = ["pre", "textarea", "code"], BLOCK_DEFAULT_STYL
   ...HTML_HEADER_TAGS,
   ...HTML_MISC_TAGS
 };
-uniq__default.default(
+uniq(
   Object.values(ELEMENT_MAP).filter((tag) => "style" in tag).map((tag) => tag.style)
 );
-uniq__default.default(
+uniq(
   Object.values(HTML_DECORATOR_TAGS)
 );
 function blockContentFeatures(blockContentType) {
   if (!blockContentType)
     throw new Error("Parameter 'blockContentType' required");
   const blockType = blockContentType.of.find(findBlockType);
-  if (!types.isBlockSchemaType(blockType))
+  if (!isBlockSchemaType(blockType))
     throw new Error("'block' type is not defined in this schema (required).");
-  const ofType = blockType.fields.find(types.isBlockChildrenObjectField)?.type?.of;
+  const ofType = blockType.fields.find(isBlockChildrenObjectField)?.type?.of;
   if (!ofType)
     throw new Error("No `of` declaration found for blocks `children` field");
   const spanType = ofType.find(
@@ -115,9 +113,9 @@ function blockContentFeatures(blockContentType) {
       "No `span` type found in `block` schema type `children` definition"
     );
   const inlineObjectTypes = ofType.filter(
-    (inlineType) => inlineType.name !== "span" && types.isObjectSchemaType(inlineType)
+    (inlineType) => inlineType.name !== "span" && isObjectSchemaType(inlineType)
   ), blockObjectTypes = blockContentType.of.filter(
-    (memberType) => memberType.name !== blockType.name && types.isObjectSchemaType(memberType)
+    (memberType) => memberType.name !== blockType.name && isObjectSchemaType(memberType)
   );
   return {
     styles: resolveEnabledStyles(blockType),
@@ -133,7 +131,7 @@ function blockContentFeatures(blockContentType) {
   };
 }
 function resolveEnabledStyles(blockType) {
-  const styleField = blockType.fields.find(types.isBlockStyleObjectField);
+  const styleField = blockType.fields.find(isBlockStyleObjectField);
   if (!styleField)
     throw new Error(
       "A field with name 'style' is not defined in the block type (required)."
@@ -159,7 +157,7 @@ function resolveEnabledDecorators(spanType) {
   return spanType.decorators;
 }
 function resolveEnabledListItems(blockType) {
-  const listField = blockType.fields.find(types.isBlockListObjectField);
+  const listField = blockType.fields.find(isBlockListObjectField);
   if (!listField)
     throw new Error(
       "A field with name 'list' is not defined in the block type (required)."
@@ -174,7 +172,7 @@ function resolveEnabledListItems(blockType) {
 function getTitledListValuesFromEnumListOptions(options) {
   const list = options ? options.list : void 0;
   return Array.isArray(list) ? list.map(
-    (item) => types.isTitledListValue(item) ? item : { title: item, value: item }
+    (item) => isTitledListValue(item) ? item : { title: item, value: item }
   ) : [];
 }
 const _XPathResult = {
@@ -397,7 +395,7 @@ function flattenNestedBlocks(blocks2) {
   const flattened = [], traverse = (nodes) => {
     const toRemove = [];
     nodes.forEach((node) => {
-      depth === 0 && flattened.push(node), types.isPortableTextTextBlock(node) && (depth > 0 && (toRemove.push(node), flattened.push(node)), depth++, traverse(node.children)), node._type === "__block" && (toRemove.push(node), flattened.push(node.block));
+      depth === 0 && flattened.push(node), isPortableTextTextBlock(node) && (depth > 0 && (toRemove.push(node), flattened.push(node)), depth++, traverse(node.children)), node._type === "__block" && (toRemove.push(node), flattened.push(node.block));
     }), toRemove.forEach((node) => {
       nodes.splice(nodes.indexOf(node), 1);
     }), depth--;
@@ -417,11 +415,11 @@ function isWhiteSpaceChar(text) {
 }
 function trimWhitespace(blocks2) {
   return blocks2.forEach((block) => {
-    types.isPortableTextTextBlock(block) && block.children.forEach((child, index) => {
+    isPortableTextTextBlock(block) && block.children.forEach((child, index) => {
       if (!isMinimalSpan(child))
         return;
       const nextChild = nextSpan(block, index), prevChild = prevSpan(block, index);
-      index === 0 && (child.text = child.text.replace(/^[^\S\n]+/g, "")), index === block.children.length - 1 && (child.text = child.text.replace(/[^\S\n]+$/g, "")), /\s/.test(child.text.slice(Math.max(0, child.text.length - 1))) && nextChild && isMinimalSpan(nextChild) && /\s/.test(nextChild.text.slice(0, 1)) && (child.text = child.text.replace(/[^\S\n]+$/g, "")), /\s/.test(child.text.slice(0, 1)) && prevChild && isMinimalSpan(prevChild) && /\s/.test(prevChild.text.slice(Math.max(0, prevChild.text.length - 1))) && (child.text = child.text.replace(/^[^\S\n]+/g, "")), child.text || block.children.splice(index, 1), prevChild && isEqual__default.default(prevChild.marks, child.marks) && isWhiteSpaceChar(child.text) ? (prevChild.text += " ", block.children.splice(index, 1)) : nextChild && isEqual__default.default(nextChild.marks, child.marks) && isWhiteSpaceChar(child.text) && (nextChild.text = ` ${nextChild.text}`, block.children.splice(index, 1));
+      index === 0 && (child.text = child.text.replace(/^[^\S\n]+/g, "")), index === block.children.length - 1 && (child.text = child.text.replace(/[^\S\n]+$/g, "")), /\s/.test(child.text.slice(Math.max(0, child.text.length - 1))) && nextChild && isMinimalSpan(nextChild) && /\s/.test(nextChild.text.slice(0, 1)) && (child.text = child.text.replace(/[^\S\n]+$/g, "")), /\s/.test(child.text.slice(0, 1)) && prevChild && isMinimalSpan(prevChild) && /\s/.test(prevChild.text.slice(Math.max(0, prevChild.text.length - 1))) && (child.text = child.text.replace(/^[^\S\n]+/g, "")), child.text || block.children.splice(index, 1), prevChild && isEqual(prevChild.marks, child.marks) && isWhiteSpaceChar(child.text) ? (prevChild.text += " ", block.children.splice(index, 1)) : nextChild && isEqual(nextChild.marks, child.marks) && isWhiteSpaceChar(child.text) && (nextChild.text = ` ${nextChild.text}`, block.children.splice(index, 1));
     });
   }), blocks2;
 }
@@ -432,7 +430,7 @@ function ensureRootIsBlocks(blocks2) {
     if (node._type === "__block")
       return memo.push(node.block), memo;
     const lastBlock = memo[memo.length - 1];
-    if (i > 0 && !types.isPortableTextTextBlock(original[i - 1]) && types.isPortableTextTextBlock(lastBlock))
+    if (i > 0 && !isPortableTextTextBlock(original[i - 1]) && isPortableTextTextBlock(lastBlock))
       return lastBlock.children.push(node), memo;
     const block = {
       ...DEFAULT_BLOCK,
@@ -591,9 +589,12 @@ function createGDocsRules(_blockContentType, options) {
     }
   ];
 }
+function keyGenerator() {
+  return randomKey(12);
+}
 function whatwgRNG(length = 16) {
   const rnds8 = new Uint8Array(length);
-  return getRandomValues__default.default(rnds8), rnds8;
+  return getRandomValues(rnds8), rnds8;
 }
 const byteToHex = [];
 for (let i = 0; i < 256; ++i)
@@ -762,7 +763,7 @@ function createHTMLRules(_blockContentType, options) {
           return next(el.childNodes);
         let markDef;
         return linkEnabled ? (markDef = {
-          _key: randomKey(12),
+          _key: options.keyGenerator ? options.keyGenerator() : keyGenerator(),
           _type: "link",
           href
         }, {
@@ -862,10 +863,10 @@ class HtmlDeserializer {
     const { rules = [], unstable_whitespaceOnPasteMode = "preserve" } = options;
     if (!blockContentType)
       throw new Error("Parameter 'blockContentType' is required");
-    const standardRules = createRules(
-      blockContentType,
-      createRuleOptions(blockContentType)
-    );
+    const standardRules = createRules(blockContentType, {
+      ...createRuleOptions(blockContentType),
+      keyGenerator: options.keyGenerator
+    });
     this.rules = [...rules, ...standardRules];
     const parseHtml = options.parseHtml || defaultParseHtml();
     this.blockContentType = blockContentType, this.parseHtml = (html) => preprocess(html, parseHtml, { unstable_whitespaceOnPasteMode }).body;
@@ -887,7 +888,7 @@ class HtmlDeserializer {
       (block) => block._type === "block"
     ).forEach((block) => {
       block.markDefs = block.markDefs || [], block.markDefs = block.markDefs.concat(
-        this._markDefs.filter((def) => flatten__default.default(
+        this._markDefs.filter((def) => flatten(
           block.children.map((child) => child.marks || [])
         ).includes(def._key))
       );
@@ -1009,9 +1010,12 @@ class HtmlDeserializer {
 }
 function normalizeBlock(node, options = {}) {
   if (node._type !== (options.blockTypeName || "block"))
-    return "_key" in node ? node : { ...node, _key: randomKey(12) };
+    return "_key" in node ? node : {
+      ...node,
+      _key: options.keyGenerator ? options.keyGenerator() : keyGenerator()
+    };
   const block = {
-    _key: randomKey(12),
+    _key: options.keyGenerator ? options.keyGenerator() : keyGenerator(),
     children: [],
     markDefs: [],
     ...node
@@ -1020,7 +1024,7 @@ function normalizeBlock(node, options = {}) {
     return block.children = [
       {
         _type: "span",
-        _key: `${block._key}0`,
+        _key: options.keyGenerator ? options.keyGenerator() : keyGenerator(),
         text: "",
         marks: []
       }
@@ -1029,13 +1033,13 @@ function normalizeBlock(node, options = {}) {
   return block.children = block.children.reduce(
     (acc, child) => {
       const previousChild = acc[acc.length - 1];
-      return previousChild && types.isPortableTextSpan(child) && types.isPortableTextSpan(previousChild) && isEqual__default.default(previousChild.marks, child.marks) ? (lastChild && lastChild === child && child.text === "" && block.children.length > 1 || (previousChild.text += child.text), acc) : (acc.push(child), acc);
+      return previousChild && isPortableTextSpan(child) && isPortableTextSpan(previousChild) && isEqual(previousChild.marks, child.marks) ? (lastChild && lastChild === child && child.text === "" && block.children.length > 1 || (previousChild.text += child.text), acc) : (acc.push(child), acc);
     },
     []
-  ).map((child, index) => {
+  ).map((child) => {
     if (!child)
       throw new Error("missing child");
-    return child._key = `${block._key}${index}`, types.isPortableTextSpan(child) && (child.marks ? allowedDecorators && (child.marks = child.marks.filter((mark) => {
+    return child._key = options.keyGenerator ? options.keyGenerator() : keyGenerator(), isPortableTextSpan(child) && (child.marks ? allowedDecorators && (child.marks = child.marks.filter((mark) => {
       const isAllowed = allowedDecorators.includes(mark), isUsed = block.markDefs?.some((def) => def._key === mark);
       return isAllowed || isUsed;
     })) : child.marks = [], usedMarkDefs.push(...child.marks)), child;
@@ -1044,13 +1048,15 @@ function normalizeBlock(node, options = {}) {
   ), block;
 }
 function htmlToBlocks(html, blockContentType, options = {}) {
-  return new HtmlDeserializer(blockContentType, options).deserialize(html).map((block) => normalizeBlock(block));
+  return new HtmlDeserializer(blockContentType, options).deserialize(html).map((block) => normalizeBlock(block, { keyGenerator: options.keyGenerator }));
 }
 function getBlockContentFeatures(blockContentType) {
   return blockContentFeatures(blockContentType);
 }
-exports.getBlockContentFeatures = getBlockContentFeatures;
-exports.htmlToBlocks = htmlToBlocks;
-exports.normalizeBlock = normalizeBlock;
-exports.randomKey = randomKey;
+export {
+  getBlockContentFeatures,
+  htmlToBlocks,
+  normalizeBlock,
+  randomKey
+};
 //# sourceMappingURL=index.js.map