@atlaskit/editor-json-transformer 9.0.1 → 9.1.0

package/dist/cjs/main.js

@@ -0,0 +1,34 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isJSONDocNode = isJSONDocNode;
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+/**
+ * Quick type guard to check if a value is a valid JSONDocNode
+ * This is only a basic structural check, does not validate the entire object nor the schema.
+ * @param value - The value to check
+ * @returns true if the value is a valid JSONDocNode structure
+ */
+function isJSONDocNode(value) {
+  if (!value || (0, _typeof2.default)(value) !== 'object') {
+    return false;
+  }
+  var doc = value;
+
+  // Check required properties
+  if (doc.type !== 'doc') {
+    return false;
+  }
+  if (!Array.isArray(doc.content)) {
+    return false;
+  }
+
+  // Version is optional but if present should be a number
+  if (doc.version !== undefined && typeof doc.version !== 'number') {
+    return false;
+  }
+  return true;
+}

package/dist/es2019/entry-points/main.js

@@ -0,0 +1,2 @@
+// eslint-disable-next-line @atlaskit/editor/no-re-export
+export { isJSONDocNode } from '../main';

package/dist/es2019/index.js

@@ -1,269 +1,5 @@
 // Disable no-re-export rule for entry point files
 /* eslint-disable @atlaskit/editor/no-re-export */
 
-import isEqual from 'lodash/isEqual';
-import { codeBlockToJSON, dataConsumerToJSON, expandToJSON, fragmentToJSON, linkToJSON, mediaSingleToJSON, mediaToJSON, mentionToJSON, tableToJSON, toJSONTableCell, toJSONTableHeader } from '@atlaskit/adf-schema';
-import { defaultSchema, getSchemaBasedOnStage } from '@atlaskit/adf-schema/schema-default';
-import { markOverrideRuleFor } from './markOverrideRules';
-import { sanitizeNode } from './sanitize/sanitize-node';
-export let SchemaStage = /*#__PURE__*/function (SchemaStage) {
-  SchemaStage["FINAL"] = "final";
-  SchemaStage["STAGE_0"] = "stage0";
-  return SchemaStage;
-}({});
-const isType = type => node => node.type.name === type;
-
-// Create a Set of node types that should have empty attrs removed
-const NODES_WITH_EMPTY_ATTRS_REMOVAL = new Set(['paragraph', 'layoutSection', 'blockquote', 'nestedExpand', 'bulletList', 'listItem', 'orderedList', 'rule', 'caption', 'tableRow', 'media', 'mediaSingle', 'mediaInline']);
-const isCodeBlock = isType('codeBlock');
-const isMediaNode = isType('media');
-const isMediaInline = isType('mediaInline');
-const isMediaSingleNode = isType('mediaSingle');
-const isMentionNode = isType('mention');
-const isParagraph = isType('paragraph');
-const isHeading = isType('heading');
-const isTable = isType('table');
-const isTableCell = isType('tableCell');
-const isTableHeader = isType('tableHeader');
-const isLinkMark = isType('link');
-const isUnsupportedMark = isType('unsupportedMark');
-const isUnsupportedNodeAttributeMark = isType('unsupportedNodeAttribute');
-const isExpand = isType('expand');
-const isNestedExpand = isType('nestedExpand');
-const isUnsupportedNode = node => isType('unsupportedBlock')(node) || isType('unsupportedInline')(node);
-const isDataConsumer = isType('dataConsumer');
-const isFragmentMark = isType('fragment');
-const isHardBreak = isType('hardBreak');
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-const filterNull = subject => {
-  let output = {
-    ...subject
-  };
-  // eslint-disable-next-line guard-for-in
-  for (const key in output) {
-    const current = output[key];
-    if (current === null) {
-      const {
-        [key]: unusedKey,
-        ...filteredObj
-      } = output;
-      output = filteredObj;
-    } else if (typeof current === 'object' && !Array.isArray(current)) {
-      output[key] = filterNull(current);
-    }
-  }
-  return output;
-};
-const createDocFromContent = content => {
-  return {
-    version: 1,
-    type: 'doc',
-    content: content || []
-  };
-};
-const emptyDoc = createDocFromContent([{
-  type: 'paragraph',
-  content: []
-}]);
-
-/**
- * Transforms a Prosemirror node into a JSON representation. Compared with
- * native Prosemirror JSON, this representation ensures we have valid ADF attrs.
- *
- * @param node The Prosemirror node to transform.
- * @param mentionMap A map of mention IDs to their display names.
- * @returns The JSON representation of the node.
- */
-const toJSON = (node, mentionMap) => {
-  const obj = {
-    type: node.type.name
-  };
-  if (isUnsupportedNode(node)) {
-    return node.attrs.originalValue;
-  } else if (isMediaNode(node)) {
-    obj.attrs = mediaToJSON(node).attrs;
-  } else if (isMediaSingleNode(node)) {
-    obj.attrs = mediaSingleToJSON(node).attrs;
-  } else if (isMediaInline(node)) {
-    obj.attrs = mediaToJSON(node).attrs;
-  } else if (isMentionNode(node)) {
-    obj.attrs = mentionToJSON(node).attrs;
-  } else if (isCodeBlock(node)) {
-    obj.attrs = codeBlockToJSON(node).attrs;
-  } else if (isTable(node)) {
-    obj.attrs = tableToJSON(node).attrs;
-  } else if (isTableCell(node)) {
-    obj.attrs = toJSONTableCell(node).attrs;
-  } else if (isTableHeader(node)) {
-    obj.attrs = toJSONTableHeader(node).attrs;
-  } else if (isExpand(node) || isNestedExpand(node)) {
-    obj.attrs = expandToJSON(node).attrs;
-  } else if (node.attrs && Object.keys(node.attrs).length) {
-    obj.attrs = node.attrs;
-  }
-  if (obj.attrs) {
-    obj.attrs = filterNull(obj.attrs);
-  }
-  if (isMentionNode(node) && mentionMap) {
-    var _text, _obj$attrs;
-    // If the mentionMap exists and has a name defined then we should use it and prepend @ to the begining of it.
-    const name = !!(mentionMap !== null && mentionMap !== void 0 && mentionMap[node.attrs.id]) ? `@${mentionMap[node.attrs.id]}` : '';
-    // Ignored via go/ees005
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const text = (_text = (_obj$attrs = obj.attrs) === null || _obj$attrs === void 0 ? void 0 : _obj$attrs.text) !== null && _text !== void 0 ? _text : '';
-    obj.attrs = {
-      ...obj.attrs,
-      // If an explicit text value is set on the mention then that should take priority over the mentionMap value.
-      text: !!text ? text : name
-    };
-  }
-  if (NODES_WITH_EMPTY_ATTRS_REMOVAL.has(node.type.name) && obj.attrs && !Object.keys(obj.attrs).length || isHardBreak(node)) {
-    delete obj.attrs;
-  }
-  if (node.isText) {
-    obj.text = node.textContent;
-  } else {
-    node.content.forEach(child => {
-      obj.content = obj.content || [];
-      obj.content.push(toJSON(child, mentionMap));
-    });
-  }
-  if (isParagraph(node) || isHeading(node)) {
-    obj.content = obj.content || [];
-  }
-  if (node.marks.length) {
-    // Run any custom mark serialisers
-    const parsedMarks = node.marks.map(mark => {
-      if (isUnsupportedMark(mark)) {
-        return canOverrideMark(mark, node.marks) ? null : mark.attrs.originalValue;
-      } else if (isUnsupportedNodeAttributeMark(mark)) {
-        return null;
-      } else if (isLinkMark(mark)) {
-        return linkToJSON(mark);
-      } else if (isDataConsumer(mark)) {
-        var _serialised$attrs$sou;
-        const serialised = dataConsumerToJSON(mark);
-        return !serialised.attrs.sources || ((_serialised$attrs$sou = serialised.attrs.sources) === null || _serialised$attrs$sou === void 0 ? void 0 : _serialised$attrs$sou.length) === 0 ? null : serialised;
-      } else if (isFragmentMark(mark)) {
-        const fragmentMark = fragmentToJSON(mark);
-        if (!fragmentMark.attrs.localId) {
-          return null;
-        }
-        return fragmentMark;
-      } else {
-        return mark.toJSON();
-      }
-    }).filter(maybeMark => maybeMark !== null);
-
-    // Only set if we have a non-empty array, otherwise explicitly undefine it (as we only run this path if `node.marks.length`)
-    obj.marks = (parsedMarks === null || parsedMarks === void 0 ? void 0 : parsedMarks.length) > 0 ? parsedMarks : undefined;
-    const nodeAttributeMark = node.marks.find(isUnsupportedNodeAttributeMark);
-    if (nodeAttributeMark && nodeAttributeMark.attrs.type.nodeType === obj.type) {
-      obj.attrs = {
-        ...getUnwrappedNodeAttributes(node, nodeAttributeMark, obj)
-      };
-    }
-  }
-  return obj;
-};
-export { toJSON as nodeToJSON };
-const canOverrideMark = (mark, existingMarks) => {
-  if (existingMarks.some(e => mark.attrs.originalValue.type === e.type.name)) {
-    return markOverrideRuleFor(mark.attrs.originalValue.type).canOverrideUnsupportedMark();
-  }
-  return false;
-};
-const getUnwrappedNodeAttributes = (node, mark, obj) => {
-  const nodeAttributes = node.type.spec.attrs;
-  const attributes = {
-    ...mark.attrs.unsupported,
-    ...obj.attrs
-  };
-  // Ignored via go/ees005
-  // eslint-disable-next-line no-var
-  for (var key in obj.attrs) {
-    if (obj.attrs.hasOwnProperty(key)) {
-      const attribute = nodeAttributes ? nodeAttributes[key] : null;
-      if (attribute) {
-        if (attribute.default === node.attrs[key] && mark.attrs.unsupported[key]) {
-          return {
-            ...attributes,
-            [key]: mark.attrs.unsupported[key]
-          };
-        }
-      }
-    }
-  }
-  return attributes;
-};
-export class JSONTransformer {
-  /**
-   * @param schema The current editor schema
-   * @param mentionMap An optional mapping of user IDs to mention names. This is used by the encoder to substitute empty
-   * mention node.attr.text values with mapped names.
-   */
-  constructor(schema = defaultSchema, mentionMap) {
-    this.schema = schema;
-    this.mentionMap = mentionMap;
-  }
-  encode(node, options = {}) {
-    const content = [];
-    node.content.forEach(child => {
-      content.push(sanitizeNode(toJSON(child, this.mentionMap), options));
-    });
-    if (!content || isEqual(content, emptyDoc.content)) {
-      return createDocFromContent([]);
-    }
-    return createDocFromContent(content);
-  }
-  internalParse(content, schema) {
-    const doc = schema.nodeFromJSON(content);
-    doc.check();
-    return doc;
-  }
-  parse(content, stage) {
-    if (content.type !== 'doc') {
-      throw new Error('Expected content format to be ADF');
-    }
-    const schema = !!stage ? getSchemaBasedOnStage(stage) : this.schema;
-    if (!content.content || content.content.length === 0) {
-      return this.internalParse(emptyDoc, schema);
-    }
-    return this.internalParse(content, schema);
-  }
-
-  /**
-   * This method is used to encode a single node
-   */
-  encodeNode(node) {
-    return sanitizeNode(toJSON(node, this.mentionMap));
-  }
-}
-
-/**
- * Quick type guard to check if a value is a valid JSONDocNode
- * This is only a basic structural check, does not validate the entire object nor the schema.
- * @param value - The value to check
- * @returns true if the value is a valid JSONDocNode structure
- */
-export function isJSONDocNode(value) {
-  if (!value || typeof value !== 'object') {
-    return false;
-  }
-  const doc = value;
-
-  // Check required properties
-  if (doc.type !== 'doc') {
-    return false;
-  }
-  if (!Array.isArray(doc.content)) {
-    return false;
-  }
-
-  // Version is optional but if present should be a number
-  if (doc.version !== undefined && typeof doc.version !== 'number') {
-    return false;
-  }
-  return true;
-}
+export { JSONTransformer, SchemaStage, toJSON as nodeToJSON } from './jsonTransformer';
+export { isJSONDocNode } from './entry-points/main';

package/dist/es2019/jsonTransformer.js

@@ -0,0 +1,239 @@
+import isEqual from 'lodash/isEqual';
+import { codeBlockToJSON, dataConsumerToJSON, expandToJSON, fragmentToJSON, linkToJSON, mediaSingleToJSON, mediaToJSON, mentionToJSON, tableToJSON, toJSONTableCell, toJSONTableHeader } from '@atlaskit/adf-schema';
+import { defaultSchema, getSchemaBasedOnStage } from '@atlaskit/adf-schema/schema-default';
+import { markOverrideRuleFor } from './markOverrideRules';
+import { sanitizeNode } from './sanitize/sanitize-node';
+export let SchemaStage = /*#__PURE__*/function (SchemaStage) {
+  SchemaStage["FINAL"] = "final";
+  SchemaStage["STAGE_0"] = "stage0";
+  return SchemaStage;
+}({});
+const isType = type => node => node.type.name === type;
+
+// Create a Set of node types that should have empty attrs removed
+const NODES_WITH_EMPTY_ATTRS_REMOVAL = new Set(['paragraph', 'layoutSection', 'blockquote', 'nestedExpand', 'bulletList', 'listItem', 'orderedList', 'rule', 'caption', 'tableRow', 'media', 'mediaSingle', 'mediaInline']);
+const isCodeBlock = isType('codeBlock');
+const isMediaNode = isType('media');
+const isMediaInline = isType('mediaInline');
+const isMediaSingleNode = isType('mediaSingle');
+const isMentionNode = isType('mention');
+const isParagraph = isType('paragraph');
+const isHeading = isType('heading');
+const isTable = isType('table');
+const isTableCell = isType('tableCell');
+const isTableHeader = isType('tableHeader');
+const isLinkMark = isType('link');
+const isUnsupportedMark = isType('unsupportedMark');
+const isUnsupportedNodeAttributeMark = isType('unsupportedNodeAttribute');
+const isExpand = isType('expand');
+const isNestedExpand = isType('nestedExpand');
+const isUnsupportedNode = node => isType('unsupportedBlock')(node) || isType('unsupportedInline')(node);
+const isDataConsumer = isType('dataConsumer');
+const isFragmentMark = isType('fragment');
+const isHardBreak = isType('hardBreak');
+const createDocFromContent = content => {
+  return {
+    version: 1,
+    type: 'doc',
+    content: content || []
+  };
+};
+const emptyDoc = createDocFromContent([{
+  type: 'paragraph',
+  content: []
+}]);
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const filterNull = subject => {
+  let output = {
+    ...subject
+  };
+  // eslint-disable-next-line guard-for-in
+  for (const key in output) {
+    const current = output[key];
+    if (current === null) {
+      const {
+        [key]: unusedKey,
+        ...filteredObj
+      } = output;
+      output = filteredObj;
+    } else if (typeof current === 'object' && !Array.isArray(current)) {
+      output[key] = filterNull(current);
+    }
+  }
+  return output;
+};
+const canOverrideMark = (mark, existingMarks) => {
+  if (existingMarks.some(e => mark.attrs.originalValue.type === e.type.name)) {
+    return markOverrideRuleFor(mark.attrs.originalValue.type).canOverrideUnsupportedMark();
+  }
+  return false;
+};
+const getUnwrappedNodeAttributes = (node, mark, obj) => {
+  const nodeAttributes = node.type.spec.attrs;
+  const attributes = {
+    ...mark.attrs.unsupported,
+    ...obj.attrs
+  };
+  // Ignored via go/ees005
+  // eslint-disable-next-line no-var
+  for (var key in obj.attrs) {
+    if (obj.attrs.hasOwnProperty(key)) {
+      const attribute = nodeAttributes ? nodeAttributes[key] : null;
+      if (attribute) {
+        if (attribute.default === node.attrs[key] && mark.attrs.unsupported[key]) {
+          return {
+            ...attributes,
+            [key]: mark.attrs.unsupported[key]
+          };
+        }
+      }
+    }
+  }
+  return attributes;
+};
+
+/**
+ * Transforms a Prosemirror node into a JSON representation. Compared with
+ * native Prosemirror JSON, this representation ensures we have valid ADF attrs.
+ *
+ * @param node The Prosemirror node to transform.
+ * @param mentionMap A map of mention IDs to their display names.
+ * @returns The JSON representation of the node.
+ */
+export const toJSON = (node, mentionMap) => {
+  const obj = {
+    type: node.type.name
+  };
+  if (isUnsupportedNode(node)) {
+    return node.attrs.originalValue;
+  } else if (isMediaNode(node)) {
+    obj.attrs = mediaToJSON(node).attrs;
+  } else if (isMediaSingleNode(node)) {
+    obj.attrs = mediaSingleToJSON(node).attrs;
+  } else if (isMediaInline(node)) {
+    obj.attrs = mediaToJSON(node).attrs;
+  } else if (isMentionNode(node)) {
+    obj.attrs = mentionToJSON(node).attrs;
+  } else if (isCodeBlock(node)) {
+    obj.attrs = codeBlockToJSON(node).attrs;
+  } else if (isTable(node)) {
+    obj.attrs = tableToJSON(node).attrs;
+  } else if (isTableCell(node)) {
+    obj.attrs = toJSONTableCell(node).attrs;
+  } else if (isTableHeader(node)) {
+    obj.attrs = toJSONTableHeader(node).attrs;
+  } else if (isExpand(node) || isNestedExpand(node)) {
+    obj.attrs = expandToJSON(node).attrs;
+  } else if (node.attrs && Object.keys(node.attrs).length) {
+    obj.attrs = node.attrs;
+  }
+  if (obj.attrs) {
+    obj.attrs = filterNull(obj.attrs);
+  }
+  if (isMentionNode(node) && mentionMap) {
+    var _text, _obj$attrs;
+    // If the mentionMap exists and has a name defined then we should use it and prepend @ to the begining of it.
+    const name = !!(mentionMap !== null && mentionMap !== void 0 && mentionMap[node.attrs.id]) ? `@${mentionMap[node.attrs.id]}` : '';
+    // Ignored via go/ees005
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const text = (_text = (_obj$attrs = obj.attrs) === null || _obj$attrs === void 0 ? void 0 : _obj$attrs.text) !== null && _text !== void 0 ? _text : '';
+    obj.attrs = {
+      ...obj.attrs,
+      // If an explicit text value is set on the mention then that should take priority over the mentionMap value.
+      text: !!text ? text : name
+    };
+  }
+  if (NODES_WITH_EMPTY_ATTRS_REMOVAL.has(node.type.name) && obj.attrs && !Object.keys(obj.attrs).length || isHardBreak(node)) {
+    delete obj.attrs;
+  }
+  if (node.isText) {
+    obj.text = node.textContent;
+  } else {
+    node.content.forEach(child => {
+      obj.content = obj.content || [];
+      obj.content.push(toJSON(child, mentionMap));
+    });
+  }
+  if (isParagraph(node) || isHeading(node)) {
+    obj.content = obj.content || [];
+  }
+  if (node.marks.length) {
+    // Run any custom mark serialisers
+    const parsedMarks = node.marks.map(mark => {
+      if (isUnsupportedMark(mark)) {
+        return canOverrideMark(mark, node.marks) ? null : mark.attrs.originalValue;
+      } else if (isUnsupportedNodeAttributeMark(mark)) {
+        return null;
+      } else if (isLinkMark(mark)) {
+        return linkToJSON(mark);
+      } else if (isDataConsumer(mark)) {
+        var _serialised$attrs$sou;
+        const serialised = dataConsumerToJSON(mark);
+        return !serialised.attrs.sources || ((_serialised$attrs$sou = serialised.attrs.sources) === null || _serialised$attrs$sou === void 0 ? void 0 : _serialised$attrs$sou.length) === 0 ? null : serialised;
+      } else if (isFragmentMark(mark)) {
+        const fragmentMark = fragmentToJSON(mark);
+        if (!fragmentMark.attrs.localId) {
+          return null;
+        }
+        return fragmentMark;
+      } else {
+        return mark.toJSON();
+      }
+    }).filter(maybeMark => maybeMark !== null);
+
+    // Only set if we have a non-empty array, otherwise explicitly undefine it (as we only run this path if `node.marks.length`)
+    obj.marks = (parsedMarks === null || parsedMarks === void 0 ? void 0 : parsedMarks.length) > 0 ? parsedMarks : undefined;
+    const nodeAttributeMark = node.marks.find(isUnsupportedNodeAttributeMark);
+    if (nodeAttributeMark && nodeAttributeMark.attrs.type.nodeType === obj.type) {
+      obj.attrs = {
+        ...getUnwrappedNodeAttributes(node, nodeAttributeMark, obj)
+      };
+    }
+  }
+  return obj;
+};
+export class JSONTransformer {
+  /**
+   * Creates a new JSONTransformer instance.
+   * @param schema The current editor schema
+   * @param mentionMap An optional mapping of user IDs to mention names. This is used by the encoder to substitute empty
+   * mention node.attr.text values with mapped names.
+   */
+  constructor(schema = defaultSchema, mentionMap) {
+    this.schema = schema;
+    this.mentionMap = mentionMap;
+  }
+  encode(node, options = {}) {
+    const content = [];
+    node.content.forEach(child => {
+      content.push(sanitizeNode(toJSON(child, this.mentionMap), options));
+    });
+    if (!content || isEqual(content, emptyDoc.content)) {
+      return createDocFromContent([]);
+    }
+    return createDocFromContent(content);
+  }
+  internalParse(content, schema) {
+    const doc = schema.nodeFromJSON(content);
+    doc.check();
+    return doc;
+  }
+  parse(content, stage) {
+    if (content.type !== 'doc') {
+      throw new Error('Expected content format to be ADF');
+    }
+    const schema = !!stage ? getSchemaBasedOnStage(stage) : this.schema;
+    if (!content.content || content.content.length === 0) {
+      return this.internalParse(emptyDoc, schema);
+    }
+    return this.internalParse(content, schema);
+  }
+
+  /**
+   * This method is used to encode a single node
+   */
+  encodeNode(node) {
+    return sanitizeNode(toJSON(node, this.mentionMap));
+  }
+}

package/dist/es2019/main.js

@@ -0,0 +1,26 @@
+/**
+ * Quick type guard to check if a value is a valid JSONDocNode
+ * This is only a basic structural check, does not validate the entire object nor the schema.
+ * @param value - The value to check
+ * @returns true if the value is a valid JSONDocNode structure
+ */
+export function isJSONDocNode(value) {
+  if (!value || typeof value !== 'object') {
+    return false;
+  }
+  const doc = value;
+
+  // Check required properties
+  if (doc.type !== 'doc') {
+    return false;
+  }
+  if (!Array.isArray(doc.content)) {
+    return false;
+  }
+
+  // Version is optional but if present should be a number
+  if (doc.version !== undefined && typeof doc.version !== 'number') {
+    return false;
+  }
+  return true;
+}

package/dist/esm/entry-points/main.js

@@ -0,0 +1,2 @@
+// eslint-disable-next-line @atlaskit/editor/no-re-export
+export { isJSONDocNode } from '../main';