@atlaskit/editor-json-transformer 8.20.3 → 8.20.4

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-json-transformer
 
+## 8.20.4
+
+### Patch Changes
+
+- [`9a4a3df453d84`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/9a4a3df453d84) -
+  Updated the JSONTransformer to support using an mention mapping. During the encoding of mentions
+  the text names can be pulled from the mention map and encoded.
+- Updated dependencies
+
 ## 8.20.3
 
 ### Patch Changes

package/afm-jira/tsconfig.json

@@ -1,24 +1,24 @@
 {
-  "extends": "../../../../tsconfig.entry-points.jira.json",
-  "compilerOptions": {
-    "declaration": true,
-    "target": "es5",
-    "outDir": "../../../../../tsDist/@atlaskit__editor-json-transformer/app",
-    "composite": true,
-    "rootDir": "../"
-  },
-  "include": [
-    "../src/**/*.ts",
-    "../src/**/*.tsx"
-  ],
-  "exclude": [
-    "../src/**/__tests__/*",
-    "../src/**/*.test.*",
-    "../src/**/test.*"
-  ],
-  "references": [
-    {
-      "path": "../../adf-utils/afm-jira/tsconfig.json"
-    }
-  ]
-}
+	"extends": "../../../../tsconfig.entry-points.jira.json",
+	"compilerOptions": {
+		"declaration": true,
+		"target": "es5",
+		"outDir": "../../../../../tsDist/@atlaskit__editor-json-transformer/app",
+		"rootDir": "../",
+		"composite": true
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*"
+	],
+	"references": [
+		{
+			"path": "../../adf-utils/afm-jira/tsconfig.json"
+		}
+	]
+}

package/afm-post-office/tsconfig.json

@@ -1,24 +1,24 @@
 {
-  "extends": "../../../../tsconfig.entry-points.post-office.json",
-  "compilerOptions": {
-    "declaration": true,
-    "target": "es5",
-    "outDir": "../../../../../tsDist/@atlaskit__editor-json-transformer/app",
-    "composite": true,
-    "rootDir": "../"
-  },
-  "include": [
-    "../src/**/*.ts",
-    "../src/**/*.tsx"
-  ],
-  "exclude": [
-    "../src/**/__tests__/*",
-    "../src/**/*.test.*",
-    "../src/**/test.*"
-  ],
-  "references": [
-    {
-      "path": "../../adf-utils/afm-post-office/tsconfig.json"
-    }
-  ]
-}
+	"extends": "../../../../tsconfig.entry-points.post-office.json",
+	"compilerOptions": {
+		"declaration": true,
+		"target": "es5",
+		"outDir": "../../../../../tsDist/@atlaskit__editor-json-transformer/app",
+		"rootDir": "../",
+		"composite": true
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*"
+	],
+	"references": [
+		{
+			"path": "../../adf-utils/afm-post-office/tsconfig.json"
+		}
+	]
+}

package/dist/cjs/index.js

@@ -79,7 +79,7 @@ var emptyDoc = createDocFromContent([{
   type: 'paragraph',
   content: []
 }]);
-var toJSON = function toJSON(node) {
+var toJSON = function toJSON(node, mentionMap) {
   var obj = {
     type: node.type.name
   };
@@ -109,6 +109,16 @@ var toJSON = function toJSON(node) {
   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.
+    var name = !!(mentionMap !== null && mentionMap !== void 0 && mentionMap[node.attrs.id]) ? "@".concat(mentionMap[node.attrs.id]) : '';
+    var text = (_text = (_obj$attrs = obj.attrs) === null || _obj$attrs === void 0 ? void 0 : _obj$attrs.text) !== null && _text !== void 0 ? _text : '';
+    obj.attrs = _objectSpread(_objectSpread({}, 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
+    });
+  }
 
   // Remove the attrs property if it's empty, this is currently limited to paragraph nodes.
   if (isParagraph(node) && obj.attrs && !Object.keys(obj.attrs).length) {
@@ -125,7 +135,7 @@ var toJSON = function toJSON(node) {
   } else {
     node.content.forEach(function (child) {
       obj.content = obj.content || [];
-      obj.content.push(toJSON(child));
+      obj.content.push(toJSON(child, mentionMap));
     });
   }
   if (isParagraph(node) || isHeading(node)) {
@@ -190,17 +200,25 @@ var getUnwrappedNodeAttributes = function getUnwrappedNodeAttributes(node, mark,
   return attributes;
 };
 var JSONTransformer = exports.JSONTransformer = /*#__PURE__*/function () {
+  /**
+   * @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.
+   */
   function JSONTransformer() {
     var schema = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : _schemaDefault.defaultSchema;
+    var mentionMap = arguments.length > 1 ? arguments[1] : undefined;
     (0, _classCallCheck2.default)(this, JSONTransformer);
     this.schema = schema;
+    this.mentionMap = mentionMap;
   }
   (0, _createClass2.default)(JSONTransformer, [{
     key: "encode",
     value: function encode(node) {
+      var _this = this;
       var content = [];
       node.content.forEach(function (child) {
-        content.push((0, _sanitizeNode.sanitizeNode)(toJSON(child)));
+        content.push((0, _sanitizeNode.sanitizeNode)(toJSON(child, _this.mentionMap)));
       });
       if (!content || (0, _isEqual.default)(content, emptyDoc.content)) {
         return createDocFromContent([]);
@@ -233,7 +251,7 @@ var JSONTransformer = exports.JSONTransformer = /*#__PURE__*/function () {
   }, {
     key: "encodeNode",
     value: function encodeNode(node) {
-      return (0, _sanitizeNode.sanitizeNode)(toJSON(node));
+      return (0, _sanitizeNode.sanitizeNode)(toJSON(node, this.mentionMap));
     }
   }]);
   return JSONTransformer;

package/dist/es2019/index.js

@@ -59,7 +59,7 @@ const emptyDoc = createDocFromContent([{
   type: 'paragraph',
   content: []
 }]);
-const toJSON = node => {
+const toJSON = (node, mentionMap) => {
   const obj = {
     type: node.type.name
   };
@@ -89,6 +89,17 @@ const toJSON = node => {
   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]}` : '';
+    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
+    };
+  }
 
   // Remove the attrs property if it's empty, this is currently limited to paragraph nodes.
   if (isParagraph(node) && obj.attrs && !Object.keys(obj.attrs).length) {
@@ -105,7 +116,7 @@ const toJSON = node => {
   } else {
     node.content.forEach(child => {
       obj.content = obj.content || [];
-      obj.content.push(toJSON(child));
+      obj.content.push(toJSON(child, mentionMap));
     });
   }
   if (isParagraph(node) || isHeading(node)) {
@@ -174,13 +185,19 @@ const getUnwrappedNodeAttributes = (node, mark, obj) => {
   return attributes;
 };
 export class JSONTransformer {
-  constructor(schema = defaultSchema) {
+  /**
+   * @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) {
     const content = [];
     node.content.forEach(child => {
-      content.push(sanitizeNode(toJSON(child)));
+      content.push(sanitizeNode(toJSON(child, this.mentionMap)));
     });
     if (!content || isEqual(content, emptyDoc.content)) {
       return createDocFromContent([]);
@@ -207,6 +224,6 @@ export class JSONTransformer {
    * This method is used to encode a single node
    */
   encodeNode(node) {
-    return sanitizeNode(toJSON(node));
+    return sanitizeNode(toJSON(node, this.mentionMap));
   }
 }

package/dist/esm/index.js

@@ -71,7 +71,7 @@ var emptyDoc = createDocFromContent([{
   type: 'paragraph',
   content: []
 }]);
-var toJSON = function toJSON(node) {
+var toJSON = function toJSON(node, mentionMap) {
   var obj = {
     type: node.type.name
   };
@@ -101,6 +101,16 @@ var toJSON = function toJSON(node) {
   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.
+    var name = !!(mentionMap !== null && mentionMap !== void 0 && mentionMap[node.attrs.id]) ? "@".concat(mentionMap[node.attrs.id]) : '';
+    var text = (_text = (_obj$attrs = obj.attrs) === null || _obj$attrs === void 0 ? void 0 : _obj$attrs.text) !== null && _text !== void 0 ? _text : '';
+    obj.attrs = _objectSpread(_objectSpread({}, 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
+    });
+  }
 
   // Remove the attrs property if it's empty, this is currently limited to paragraph nodes.
   if (isParagraph(node) && obj.attrs && !Object.keys(obj.attrs).length) {
@@ -117,7 +127,7 @@ var toJSON = function toJSON(node) {
   } else {
     node.content.forEach(function (child) {
       obj.content = obj.content || [];
-      obj.content.push(toJSON(child));
+      obj.content.push(toJSON(child, mentionMap));
     });
   }
   if (isParagraph(node) || isHeading(node)) {
@@ -182,17 +192,25 @@ var getUnwrappedNodeAttributes = function getUnwrappedNodeAttributes(node, mark,
   return attributes;
 };
 export var JSONTransformer = /*#__PURE__*/function () {
+  /**
+   * @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.
+   */
   function JSONTransformer() {
     var schema = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : defaultSchema;
+    var mentionMap = arguments.length > 1 ? arguments[1] : undefined;
     _classCallCheck(this, JSONTransformer);
     this.schema = schema;
+    this.mentionMap = mentionMap;
   }
   _createClass(JSONTransformer, [{
     key: "encode",
     value: function encode(node) {
+      var _this = this;
       var content = [];
       node.content.forEach(function (child) {
-        content.push(sanitizeNode(toJSON(child)));
+        content.push(sanitizeNode(toJSON(child, _this.mentionMap)));
       });
       if (!content || isEqual(content, emptyDoc.content)) {
         return createDocFromContent([]);
@@ -225,7 +243,7 @@ export var JSONTransformer = /*#__PURE__*/function () {
   }, {
     key: "encodeNode",
     value: function encodeNode(node) {
-      return sanitizeNode(toJSON(node));
+      return sanitizeNode(toJSON(node, this.mentionMap));
     }
   }]);
   return JSONTransformer;

package/dist/types/index.d.ts

@@ -11,7 +11,13 @@ export declare enum SchemaStage {
 }
 export declare class JSONTransformer implements Transformer<JSONDocNode> {
     private schema;
-    constructor(schema?: Schema);
+    private mentionMap;
+    /**
+     * @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?: Schema, mentionMap?: Record<string, string | undefined>);
     encode(node: PMNode): JSONDocNode;
     private internalParse;
     parse(content: JSONDocNode, stage?: SchemaStage): PMNode;

package/dist/types-ts4.5/index.d.ts

@@ -11,7 +11,13 @@ export declare enum SchemaStage {
 }
 export declare class JSONTransformer implements Transformer<JSONDocNode> {
     private schema;
-    constructor(schema?: Schema);
+    private mentionMap;
+    /**
+     * @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?: Schema, mentionMap?: Record<string, string | undefined>);
     encode(node: PMNode): JSONDocNode;
     private internalParse;
     parse(content: JSONDocNode, stage?: SchemaStage): PMNode;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-json-transformer",
-	"version": "8.20.3",
+	"version": "8.20.4",
 	"description": "JSON transformer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -37,7 +37,7 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^44.2.0",
-		"@atlaskit/adf-utils": "^19.10.0",
+		"@atlaskit/adf-utils": "^19.11.0",
 		"@atlaskit/editor-prosemirror": "6.0.0",
 		"@babel/runtime": "^7.0.0",
 		"lodash": "^4.17.21"