@atlaskit/editor-wikimarkup-transformer 11.1.5 → 11.1.7

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-wikimarkup-transformer
 
+## 11.1.7
+
+### Patch Changes
+
+- [`12399f5aaa1`](https://bitbucket.org/atlassian/atlassian-frontend/commits/12399f5aaa1) - Adding custom regex for escaping of media, link and mention.
+
+## 11.1.6
+
+### Patch Changes
+
+- [`ea34f8260e3`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ea34f8260e3) - Wiki to adf: Tables headings to be strong by default
+
 ## 11.1.5
 
 ### Patch Changes

package/dist/cjs/encoder/nodes/text.js

@@ -33,6 +33,17 @@ var _underline = require("../marks/underline");
  * we want to process other marks before it.
  */
 var markEncoderMapping = new Map([['em', _em.em], ['strike', _strike.strike], ['strong', _strong.strong], ['subsup', _subsup.subsup], ['underline', _underline.underline], ['textColor', _color.textColor], ['link', _link.link], ['code', _code.code]]);
+/**
+ * ADFEXP-131: Improved logic for escaping metacharacters "[" and "!"
+ * Before this change, any instance of "[" and "!" was being escaped
+ * "[" is used for mentions
+ * "!" is used for media
+ */
+
+var MENTION_ESCAPE_PATTERN = '(\\[~)'; // Matches pattern like [~
+
+var MEDIA_ESCAPE_PATTERN = '(![^ !]+)(!)'; // Matches non space content between two consecutive "!" e.g. !filename.txt!
+
 /**
  * Checks if the node's content needs to be escaped before continuing processing.
  * Currently, the `code` mark and `codeBlock` nodes handle their own escaping, and
@@ -50,14 +61,15 @@ var isEscapeNeeded = function isEscapeNeeded(node, parent) {
 };
 /**
  * ESS-2569: Removing the backsalshes from the regex
+ * ADFEXP-131: Improved logic for escaping metacharacters "[" and "!"
  */
 
 
 function escapingWikiFormatter(text) {
-  var pattern = ['([![])'].concat((0, _toConsumableArray2.default)(_keyword.macroKeywordTokenMap.map(function (macro) {
+  var pattern = [MENTION_ESCAPE_PATTERN].concat((0, _toConsumableArray2.default)(_keyword.macroKeywordTokenMap.map(function (macro) {
     return "(".concat(macro.regex.source.replace('^', ''), ")");
   }))).join('|');
-  return text.replace(new RegExp(pattern, 'g'), '\\$&');
+  return text.replace(new RegExp(pattern, 'g'), '\\$&').replace(new RegExp(MEDIA_ESCAPE_PATTERN, 'g'), '\\$1\\$2'); // Extra step required for media as currently both ends need to be escaped e.q. !filename.txt!
 }
 
 var text = function text(node) {

package/dist/cjs/parser/tokenize/table.js

@@ -1,10 +1,16 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.table = void 0;
 
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+
+var _prosemirrorModel = require("prosemirror-model");
+
 var _tableBuilder = require("../builder/table-builder");
 
 var _text = require("../text");
@@ -23,6 +29,8 @@ var _whitespace = require("./whitespace");
 
 var _keyword = require("./keyword");
 
+var _text2 = require("../utils/text");
+
 /*
   The following are currently NOT supported
   1. Macros
@@ -345,9 +353,55 @@ function bufferToCells(style, buffer, cellsBuffer, schema, ignoreTokenTypes, con
       ignoreTokenTypes: ignoreTokenTypes,
       input: buffer
     });
+
+    if (style === '||') {
+      contentNode = contentNode.map(function (e) {
+        return createTableHeader(e, schema);
+      });
+    }
+
     cellsBuffer.push({
       style: style,
       content: (0, _normalize.normalizePMNodes)(contentNode, schema)
     });
   }
+}
+
+function createTableHeader(pmNode, schema) {
+  var mark = schema.marks.strong.create();
+
+  if (pmNode.type.name === 'text' && !(0, _text2.hasAnyOfMarks)(pmNode, ['strong', 'code'])) {
+    return pmNode.mark([].concat((0, _toConsumableArray2.default)(pmNode.marks), [mark]));
+  } else if (pmNode.childCount > 0 && pmNode.firstChild && pmNode.child(0)) {
+    var jsonNode = traverseJsonNodeAndAddMarks(pmNode.toJSON(), 'strong', schema);
+    pmNode = _prosemirrorModel.Node.fromJSON(schema, jsonNode);
+    return pmNode;
+  }
+
+  return pmNode;
+}
+
+function traverseJsonNodeAndAddMarks(node, mark, schema) {
+  if (node.type === 'text') {
+    if (node.marks && node.marks.find(function (_ref2) {
+      var type = _ref2.type;
+      return type === 'strong' || type === 'code';
+    })) {
+      return node;
+    }
+
+    node.marks = node.marks ? [].concat((0, _toConsumableArray2.default)(node.marks), [{
+      type: mark
+    }]) : [{
+      type: mark
+    }];
+  }
+
+  if (node.content && Array.isArray(node.content)) {
+    node.content.map(function (e) {
+      return traverseJsonNodeAndAddMarks(e, mark, schema);
+    });
+  }
+
+  return node;
 }

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-wikimarkup-transformer",
-	"version": "11.1.5",
+	"version": "11.1.7",
 	"sideEffects": false
 }

package/dist/es2019/encoder/nodes/text.js

@@ -14,6 +14,17 @@ import { underline } from '../marks/underline';
  */
 
 const markEncoderMapping = new Map([['em', em], ['strike', strike], ['strong', strong], ['subsup', subsup], ['underline', underline], ['textColor', textColor], ['link', link], ['code', code]]);
+/**
+ * ADFEXP-131: Improved logic for escaping metacharacters "[" and "!"
+ * Before this change, any instance of "[" and "!" was being escaped
+ * "[" is used for mentions
+ * "!" is used for media
+ */
+
+const MENTION_ESCAPE_PATTERN = '(\\[~)'; // Matches pattern like [~
+
+const MEDIA_ESCAPE_PATTERN = '(![^ !]+)(!)'; // Matches non space content between two consecutive "!" e.g. !filename.txt!
+
 /**
  * Checks if the node's content needs to be escaped before continuing processing.
  * Currently, the `code` mark and `codeBlock` nodes handle their own escaping, and
@@ -29,12 +40,13 @@ const isEscapeNeeded = (node, parent) => {
 };
 /**
  * ESS-2569: Removing the backsalshes from the regex
+ * ADFEXP-131: Improved logic for escaping metacharacters "[" and "!"
  */
 
 
 function escapingWikiFormatter(text) {
-  const pattern = ['([![])', ...macroKeywordTokenMap.map(macro => `(${macro.regex.source.replace('^', '')})`)].join('|');
-  return text.replace(new RegExp(pattern, 'g'), '\\$&');
+  const pattern = [MENTION_ESCAPE_PATTERN, ...macroKeywordTokenMap.map(macro => `(${macro.regex.source.replace('^', '')})`)].join('|');
+  return text.replace(new RegExp(pattern, 'g'), '\\$&').replace(new RegExp(MEDIA_ESCAPE_PATTERN, 'g'), '\\$1\\$2'); // Extra step required for media as currently both ends need to be escaped e.q. !filename.txt!
 }
 
 export const text = (node, {

package/dist/es2019/parser/tokenize/table.js

@@ -1,3 +1,4 @@
+import { Node as PMNode } from 'prosemirror-model';
 import { TableBuilder } from '../builder/table-builder';
 import { parseString } from '../text';
 import { normalizePMNodes } from '../utils/normalize';
@@ -8,6 +9,7 @@ import { TokenType } from './';
 import { parseNewlineOnly } from './whitespace';
 import { parseMacroKeyword } from './keyword';
 import { parseToken } from './';
+import { hasAnyOfMarks } from '../utils/text';
 /*
   The following are currently NOT supported
   1. Macros
@@ -319,15 +321,58 @@ export const table = ({
 
 function bufferToCells(style, buffer, cellsBuffer, schema, ignoreTokenTypes, context) {
   if (buffer.length) {
-    const contentNode = parseString({
+    let contentNode = parseString({
       schema,
       context,
       ignoreTokenTypes: ignoreTokenTypes,
       input: buffer
     });
+
+    if (style === '||') {
+      contentNode = contentNode.map(e => {
+        return createTableHeader(e, schema);
+      });
+    }
+
     cellsBuffer.push({
       style,
       content: normalizePMNodes(contentNode, schema)
     });
   }
+}
+
+function createTableHeader(pmNode, schema) {
+  const mark = schema.marks.strong.create();
+
+  if (pmNode.type.name === 'text' && !hasAnyOfMarks(pmNode, ['strong', 'code'])) {
+    return pmNode.mark([...pmNode.marks, mark]);
+  } else if (pmNode.childCount > 0 && pmNode.firstChild && pmNode.child(0)) {
+    const jsonNode = traverseJsonNodeAndAddMarks(pmNode.toJSON(), 'strong', schema);
+    pmNode = PMNode.fromJSON(schema, jsonNode);
+    return pmNode;
+  }
+
+  return pmNode;
+}
+
+function traverseJsonNodeAndAddMarks(node, mark, schema) {
+  if (node.type === 'text') {
+    if (node.marks && node.marks.find(({
+      type
+    }) => type === 'strong' || type === 'code')) {
+      return node;
+    }
+
+    node.marks = node.marks ? [...node.marks, {
+      type: mark
+    }] : [{
+      type: mark
+    }];
+  }
+
+  if (node.content && Array.isArray(node.content)) {
+    node.content.map(e => traverseJsonNodeAndAddMarks(e, mark, schema));
+  }
+
+  return node;
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-wikimarkup-transformer",
-	"version": "11.1.5",
+	"version": "11.1.7",
 	"sideEffects": false
 }

package/dist/esm/encoder/nodes/text.js

@@ -15,6 +15,17 @@ import { underline } from '../marks/underline';
  */
 
 var markEncoderMapping = new Map([['em', em], ['strike', strike], ['strong', strong], ['subsup', subsup], ['underline', underline], ['textColor', textColor], ['link', link], ['code', code]]);
+/**
+ * ADFEXP-131: Improved logic for escaping metacharacters "[" and "!"
+ * Before this change, any instance of "[" and "!" was being escaped
+ * "[" is used for mentions
+ * "!" is used for media
+ */
+
+var MENTION_ESCAPE_PATTERN = '(\\[~)'; // Matches pattern like [~
+
+var MEDIA_ESCAPE_PATTERN = '(![^ !]+)(!)'; // Matches non space content between two consecutive "!" e.g. !filename.txt!
+
 /**
  * Checks if the node's content needs to be escaped before continuing processing.
  * Currently, the `code` mark and `codeBlock` nodes handle their own escaping, and
@@ -32,14 +43,15 @@ var isEscapeNeeded = function isEscapeNeeded(node, parent) {
 };
 /**
  * ESS-2569: Removing the backsalshes from the regex
+ * ADFEXP-131: Improved logic for escaping metacharacters "[" and "!"
  */
 
 
 function escapingWikiFormatter(text) {
-  var pattern = ['([![])'].concat(_toConsumableArray(macroKeywordTokenMap.map(function (macro) {
+  var pattern = [MENTION_ESCAPE_PATTERN].concat(_toConsumableArray(macroKeywordTokenMap.map(function (macro) {
     return "(".concat(macro.regex.source.replace('^', ''), ")");
   }))).join('|');
-  return text.replace(new RegExp(pattern, 'g'), '\\$&');
+  return text.replace(new RegExp(pattern, 'g'), '\\$&').replace(new RegExp(MEDIA_ESCAPE_PATTERN, 'g'), '\\$1\\$2'); // Extra step required for media as currently both ends need to be escaped e.q. !filename.txt!
 }
 
 export var text = function text(node) {

package/dist/esm/parser/tokenize/table.js

@@ -1,3 +1,5 @@
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+import { Node as PMNode } from 'prosemirror-model';
 import { TableBuilder } from '../builder/table-builder';
 import { parseString } from '../text';
 import { normalizePMNodes } from '../utils/normalize';
@@ -8,6 +10,7 @@ import { TokenType } from './';
 import { parseNewlineOnly } from './whitespace';
 import { parseMacroKeyword } from './keyword';
 import { parseToken } from './';
+import { hasAnyOfMarks } from '../utils/text';
 /*
   The following are currently NOT supported
   1. Macros
@@ -328,9 +331,55 @@ function bufferToCells(style, buffer, cellsBuffer, schema, ignoreTokenTypes, con
       ignoreTokenTypes: ignoreTokenTypes,
       input: buffer
     });
+
+    if (style === '||') {
+      contentNode = contentNode.map(function (e) {
+        return createTableHeader(e, schema);
+      });
+    }
+
     cellsBuffer.push({
       style: style,
       content: normalizePMNodes(contentNode, schema)
     });
   }
+}
+
+function createTableHeader(pmNode, schema) {
+  var mark = schema.marks.strong.create();
+
+  if (pmNode.type.name === 'text' && !hasAnyOfMarks(pmNode, ['strong', 'code'])) {
+    return pmNode.mark([].concat(_toConsumableArray(pmNode.marks), [mark]));
+  } else if (pmNode.childCount > 0 && pmNode.firstChild && pmNode.child(0)) {
+    var jsonNode = traverseJsonNodeAndAddMarks(pmNode.toJSON(), 'strong', schema);
+    pmNode = PMNode.fromJSON(schema, jsonNode);
+    return pmNode;
+  }
+
+  return pmNode;
+}
+
+function traverseJsonNodeAndAddMarks(node, mark, schema) {
+  if (node.type === 'text') {
+    if (node.marks && node.marks.find(function (_ref2) {
+      var type = _ref2.type;
+      return type === 'strong' || type === 'code';
+    })) {
+      return node;
+    }
+
+    node.marks = node.marks ? [].concat(_toConsumableArray(node.marks), [{
+      type: mark
+    }]) : [{
+      type: mark
+    }];
+  }
+
+  if (node.content && Array.isArray(node.content)) {
+    node.content.map(function (e) {
+      return traverseJsonNodeAndAddMarks(e, mark, schema);
+    });
+  }
+
+  return node;
 }

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-wikimarkup-transformer",
-	"version": "11.1.5",
+	"version": "11.1.7",
 	"sideEffects": false
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-wikimarkup-transformer",
-  "version": "11.1.5",
+  "version": "11.1.7",
   "description": "Wiki markup transformer for JIRA and Confluence",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -40,12 +40,12 @@
   "devDependencies": {
     "@atlaskit/activity": "^1.0.1",
     "@atlaskit/docs": "*",
-    "@atlaskit/editor-common": "^69.3.0",
-    "@atlaskit/editor-core": "^172.2.0",
+    "@atlaskit/editor-common": "^70.1.0",
+    "@atlaskit/editor-core": "^173.0.0",
     "@atlaskit/editor-test-helpers": "^17.2.0",
     "@atlaskit/mention": "^21.0.0",
     "@atlaskit/profilecard": "^17.2.0",
-    "@atlaskit/renderer": "^101.1.0",
+    "@atlaskit/renderer": "^102.0.0",
     "@atlaskit/util-data-test": "^17.5.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@emotion/react": "^11.7.1",

package/report.api.md

@@ -1,12 +1,17 @@
+<!-- API Report Version: 2.2 -->
+
 ## API Report File for "@atlaskit/editor-wikimarkup-transformer"
 
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
 
-<!--
-	Generated API Report version: 2.0
--->
+- [Main Entry Types](#main-entry-types)
 
-[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
 
 ```ts
 import { Node as Node_2 } from 'prosemirror-model';
@@ -23,8 +28,8 @@ interface Context {
   // (undocumented)
   readonly defaults?: {
     readonly media?: {
-      width: number | null;
-      height: number | null;
+      width: null | number;
+      height: null | number;
     };
   };
   // (undocumented)
@@ -78,3 +83,5 @@ export default WikiMarkupTransformer;
 
 // (No @packageDocumentation comment for this package)
 ```
+
+<!--SECTION END: Main Entry Types-->

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,76 @@
+## API Report File for "@atlaskit/editor-wikimarkup-transformer"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { Node as Node_2 } from 'prosemirror-model';
+import { Schema } from 'prosemirror-model';
+
+// @public (undocumented)
+interface Context {
+    // (undocumented)
+    readonly conversion?: {
+        readonly inlineCardConversion?: ConversionMap;
+        readonly mediaConversion?: MediaConversionMap;
+        mentionConversion?: ConversionMap;
+    };
+    // (undocumented)
+    readonly defaults?: {
+        readonly media?: {
+            width: null | number;
+            height: null | number;
+        };
+    };
+    // (undocumented)
+    readonly hydration?: {
+        readonly media?: {
+            targetCollectionId?: string;
+        };
+    };
+    // (undocumented)
+    readonly issueKeyRegex?: RegExp | undefined;
+    // (undocumented)
+    readonly tokenErrCallback?: TokenErrCallback;
+}
+
+// @public (undocumented)
+interface ConversionMap {
+    // (undocumented)
+    [key: string]: string;
+}
+
+// @public (undocumented)
+interface MediaConversionMap {
+    // (undocumented)
+    [key: string]: {
+        transform?: string;
+        embed?: boolean;
+    };
+}
+
+// @public (undocumented)
+type TokenErrCallback = (err: Error, tokenType: string) => void;
+
+// @public (undocumented)
+interface Transformer_2<T> {
+    // (undocumented)
+    encode(node: Node_2): T;
+    // (undocumented)
+    parse(content: T): Node_2;
+}
+
+// @public (undocumented)
+class WikiMarkupTransformer implements Transformer_2<string> {
+    constructor(schema?: Schema);
+    // (undocumented)
+    encode(node: Node_2, context?: Context): string;
+    // (undocumented)
+    parse(wikiMarkup: string, context?: Context): Node_2;
+}
+export { WikiMarkupTransformer }
+export default WikiMarkupTransformer;
+
+// (No @packageDocumentation comment for this package)
+
+```