@atlaskit/editor-slack-transformer 3.7.3 → 3.7.4

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-slack-transformer
 
+## 3.7.4
+
+### Patch Changes
+
+- [#147003](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/147003)
+  [`f4f413727e260`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/f4f413727e260) -
+  [EDF-1041] Remove platform typings prosemirror-markdown from project
+
 ## 3.7.3
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -12,6 +12,7 @@ var _serializer = require("./serializer");
 var SlackTransformer = exports.SlackTransformer = /*#__PURE__*/function () {
   function SlackTransformer() {
     (0, _classCallCheck2.default)(this, SlackTransformer);
+    // @ts-expect-error - Our node definitions are not compatible with prosemirror-markdown types
     (0, _defineProperty2.default)(this, "serializer", new _serializer.MarkdownSerializer(_serializer.nodes, _serializer.marks));
   }
   (0, _createClass2.default)(SlackTransformer, [{

package/dist/cjs/serializer.js

@@ -5,12 +5,13 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.nodes = exports.marks = exports.MarkdownSerializerState = exports.MarkdownSerializer = void 0;
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime/helpers/assertThisInitialized"));
 var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
 var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
 var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _markdown = require("@atlaskit/editor-prosemirror/markdown");
 var _util = require("./util");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
@@ -20,23 +21,71 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
 var MarkdownSerializerState = exports.MarkdownSerializerState = /*#__PURE__*/function (_PMMarkdownSerializer) {
   (0, _inherits2.default)(MarkdownSerializerState, _PMMarkdownSerializer);
   var _super = _createSuper(MarkdownSerializerState);
-  function MarkdownSerializerState() {
+  function MarkdownSerializerState(nodes, marks) {
+    var _this;
     (0, _classCallCheck2.default)(this, MarkdownSerializerState);
-    return _super.apply(this, arguments);
+    // @ts-ignore-next-line
+    _this = _super.call(this, nodes, marks, {});
+    /**
+     * Defines the internal variables used in the markdown serializer
+     * @see https://github.com/ProseMirror/prosemirror-markdown/blob/master/src/to_markdown.ts#L172
+     */
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "delim", '');
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "out", '');
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "closed", null);
+    _this.nodes = nodes;
+    _this.marks = marks;
+    return _this;
   }
   (0, _createClass2.default)(MarkdownSerializerState, [{
+    key: "atBlank",
+    value:
+    /**
+     * Defines the internal atBlank method used in the markdown serializer
+     * @see https://github.com/ProseMirror/prosemirror-markdown/blob/master/src/to_markdown.ts#L241
+     */
+    function atBlank() {
+      return /(^|\n)$/.test(this.out);
+    }
+
+    /**
+     * Defines the internal flushClose method used in the markdown serializer
+     * @see https://github.com/ProseMirror/prosemirror-markdown/blob/master/src/to_markdown.ts#L202
+     */
+  }, {
+    key: "flushClose",
+    value: function flushClose() {
+      var size = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 2;
+      if (this.closed) {
+        if (!this.atBlank()) {
+          this.out += '\n';
+        }
+        if (size > 1) {
+          var delimMin = this.delim;
+          var trim = /\s+$/.exec(delimMin);
+          if (trim) {
+            delimMin = delimMin.slice(0, delimMin.length - trim[0].length);
+          }
+          for (var i = 1; i < size; i++) {
+            this.out += delimMin + '\n';
+          }
+        }
+        this.closed = null;
+      }
+    }
+  }, {
     key: "renderContent",
     value: function renderContent(parent) {
-      var _this = this;
+      var _this2 = this;
       parent.forEach(function (child, _offset, index) {
         if (
         // If child is an empty Textblock we need to insert a zwnj-character in order to preserve that line in markdown
         child.isTextblock && !child.textContent &&
         // If child is a Codeblock we need to handle this separately as we want to preserve empty code blocks
         !(child.type.name === 'codeBlock') && !(child.content && child.content.size > 0)) {
-          return nodes.empty_line(_this, child);
+          return nodes.empty_line(_this2, child);
         }
-        return _this.render(child, parent, index);
+        return _this2.render(child, parent, index);
       });
     }
   }]);
@@ -51,8 +100,8 @@ var MarkdownSerializer = exports.MarkdownSerializer = /*#__PURE__*/function (_PM
   }
   (0, _createClass2.default)(MarkdownSerializer, [{
     key: "serialize",
-    value: function serialize(content, options) {
-      var state = new MarkdownSerializerState(this.nodes, this.marks, options || {});
+    value: function serialize(content) {
+      var state = new MarkdownSerializerState(this.nodes, this.marks);
       state.renderContent(content);
       return state.out === "\u200C" ? '' : state.out; // Return empty string if editor only contains a zero-non-width character
     }
@@ -125,7 +174,7 @@ var unsupportedNodes = {
 };
 var nodes = exports.nodes = _objectSpread({
   blockquote: function blockquote(state, node) {
-    state.wrapBlock('> ', undefined, node, function () {
+    state.wrapBlock('> ', null, node, function () {
       return state.renderContent(node);
     });
   },
@@ -168,7 +217,7 @@ var nodes = exports.nodes = _objectSpread({
           return state.render(child, parent, i);
         });
       } else {
-        state.wrapBlock('    ', undefined, node, function () {
+        state.wrapBlock('    ', null, node, function () {
           return state.render(child, parent, i);
         });
       }

package/dist/es2019/index.js

@@ -2,6 +2,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { MarkdownSerializer, marks, nodes } from './serializer';
 export class SlackTransformer {
   constructor() {
+    // @ts-expect-error - Our node definitions are not compatible with prosemirror-markdown types
     _defineProperty(this, "serializer", new MarkdownSerializer(nodes, marks));
   }
   encode(node) {

package/dist/es2019/serializer.js

@@ -1,6 +1,50 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { MarkdownSerializer as PMMarkdownSerializer, MarkdownSerializerState as PMMarkdownSerializerState } from '@atlaskit/editor-prosemirror/markdown';
 import { escapeMarkdown } from './util';
 export class MarkdownSerializerState extends PMMarkdownSerializerState {
+  /**
+   * Defines the internal atBlank method used in the markdown serializer
+   * @see https://github.com/ProseMirror/prosemirror-markdown/blob/master/src/to_markdown.ts#L241
+   */
+  atBlank() {
+    return /(^|\n)$/.test(this.out);
+  }
+
+  /**
+   * Defines the internal flushClose method used in the markdown serializer
+   * @see https://github.com/ProseMirror/prosemirror-markdown/blob/master/src/to_markdown.ts#L202
+   */
+  flushClose(size = 2) {
+    if (this.closed) {
+      if (!this.atBlank()) {
+        this.out += '\n';
+      }
+      if (size > 1) {
+        let delimMin = this.delim;
+        let trim = /\s+$/.exec(delimMin);
+        if (trim) {
+          delimMin = delimMin.slice(0, delimMin.length - trim[0].length);
+        }
+        for (let i = 1; i < size; i++) {
+          this.out += delimMin + '\n';
+        }
+      }
+      this.closed = null;
+    }
+  }
+  constructor(nodes, marks) {
+    // @ts-ignore-next-line
+    super(nodes, marks, {});
+    /**
+     * Defines the internal variables used in the markdown serializer
+     * @see https://github.com/ProseMirror/prosemirror-markdown/blob/master/src/to_markdown.ts#L172
+     */
+    _defineProperty(this, "delim", '');
+    _defineProperty(this, "out", '');
+    _defineProperty(this, "closed", null);
+    this.nodes = nodes;
+    this.marks = marks;
+  }
   renderContent(parent) {
     parent.forEach((child, _offset, index) => {
       if (
@@ -15,8 +59,8 @@ export class MarkdownSerializerState extends PMMarkdownSerializerState {
   }
 }
 export class MarkdownSerializer extends PMMarkdownSerializer {
-  serialize(content, options) {
-    const state = new MarkdownSerializerState(this.nodes, this.marks, options || {});
+  serialize(content) {
+    const state = new MarkdownSerializerState(this.nodes, this.marks);
     state.renderContent(content);
     return state.out === '\u200c' ? '' : state.out; // Return empty string if editor only contains a zero-non-width character
   }
@@ -88,7 +132,7 @@ const unsupportedNodes = {
 };
 export const nodes = {
   blockquote(state, node) {
-    state.wrapBlock('> ', undefined, node, () => state.renderContent(node));
+    state.wrapBlock('> ', null, node, () => state.renderContent(node));
   },
   codeBlock(state, node) {
     state.write('```');
@@ -127,7 +171,7 @@ export const nodes = {
       if (i === 0) {
         state.wrapBlock('  ', delimiter, node, () => state.render(child, parent, i));
       } else {
-        state.wrapBlock('    ', undefined, node, () => state.render(child, parent, i));
+        state.wrapBlock('    ', null, node, () => state.render(child, parent, i));
       }
       if (child.type.name === 'paragraph' && i > 0) {
         state.write('\n');

package/dist/esm/index.js

@@ -5,6 +5,7 @@ import { MarkdownSerializer, marks, nodes } from './serializer';
 export var SlackTransformer = /*#__PURE__*/function () {
   function SlackTransformer() {
     _classCallCheck(this, SlackTransformer);
+    // @ts-expect-error - Our node definitions are not compatible with prosemirror-markdown types
     _defineProperty(this, "serializer", new MarkdownSerializer(nodes, marks));
   }
   _createClass(SlackTransformer, [{

package/dist/esm/serializer.js

@@ -1,9 +1,10 @@
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
+import _assertThisInitialized from "@babel/runtime/helpers/assertThisInitialized";
 import _inherits from "@babel/runtime/helpers/inherits";
 import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
 import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _createSuper(t) { var r = _isNativeReflectConstruct(); return function () { var e, o = _getPrototypeOf(t); if (r) { var s = _getPrototypeOf(this).constructor; e = Reflect.construct(o, arguments, s); } else e = o.apply(this, arguments); return _possibleConstructorReturn(this, e); }; }
@@ -13,23 +14,71 @@ import { escapeMarkdown } from './util';
 export var MarkdownSerializerState = /*#__PURE__*/function (_PMMarkdownSerializer) {
   _inherits(MarkdownSerializerState, _PMMarkdownSerializer);
   var _super = _createSuper(MarkdownSerializerState);
-  function MarkdownSerializerState() {
+  function MarkdownSerializerState(nodes, marks) {
+    var _this;
     _classCallCheck(this, MarkdownSerializerState);
-    return _super.apply(this, arguments);
+    // @ts-ignore-next-line
+    _this = _super.call(this, nodes, marks, {});
+    /**
+     * Defines the internal variables used in the markdown serializer
+     * @see https://github.com/ProseMirror/prosemirror-markdown/blob/master/src/to_markdown.ts#L172
+     */
+    _defineProperty(_assertThisInitialized(_this), "delim", '');
+    _defineProperty(_assertThisInitialized(_this), "out", '');
+    _defineProperty(_assertThisInitialized(_this), "closed", null);
+    _this.nodes = nodes;
+    _this.marks = marks;
+    return _this;
   }
   _createClass(MarkdownSerializerState, [{
+    key: "atBlank",
+    value:
+    /**
+     * Defines the internal atBlank method used in the markdown serializer
+     * @see https://github.com/ProseMirror/prosemirror-markdown/blob/master/src/to_markdown.ts#L241
+     */
+    function atBlank() {
+      return /(^|\n)$/.test(this.out);
+    }
+
+    /**
+     * Defines the internal flushClose method used in the markdown serializer
+     * @see https://github.com/ProseMirror/prosemirror-markdown/blob/master/src/to_markdown.ts#L202
+     */
+  }, {
+    key: "flushClose",
+    value: function flushClose() {
+      var size = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 2;
+      if (this.closed) {
+        if (!this.atBlank()) {
+          this.out += '\n';
+        }
+        if (size > 1) {
+          var delimMin = this.delim;
+          var trim = /\s+$/.exec(delimMin);
+          if (trim) {
+            delimMin = delimMin.slice(0, delimMin.length - trim[0].length);
+          }
+          for (var i = 1; i < size; i++) {
+            this.out += delimMin + '\n';
+          }
+        }
+        this.closed = null;
+      }
+    }
+  }, {
     key: "renderContent",
     value: function renderContent(parent) {
-      var _this = this;
+      var _this2 = this;
       parent.forEach(function (child, _offset, index) {
         if (
         // If child is an empty Textblock we need to insert a zwnj-character in order to preserve that line in markdown
         child.isTextblock && !child.textContent &&
         // If child is a Codeblock we need to handle this separately as we want to preserve empty code blocks
         !(child.type.name === 'codeBlock') && !(child.content && child.content.size > 0)) {
-          return nodes.empty_line(_this, child);
+          return nodes.empty_line(_this2, child);
         }
-        return _this.render(child, parent, index);
+        return _this2.render(child, parent, index);
       });
     }
   }]);
@@ -44,8 +93,8 @@ export var MarkdownSerializer = /*#__PURE__*/function (_PMMarkdownSerializer2) {
   }
   _createClass(MarkdownSerializer, [{
     key: "serialize",
-    value: function serialize(content, options) {
-      var state = new MarkdownSerializerState(this.nodes, this.marks, options || {});
+    value: function serialize(content) {
+      var state = new MarkdownSerializerState(this.nodes, this.marks);
       state.renderContent(content);
       return state.out === "\u200C" ? '' : state.out; // Return empty string if editor only contains a zero-non-width character
     }
@@ -119,7 +168,7 @@ var unsupportedNodes = {
 };
 export var nodes = _objectSpread({
   blockquote: function blockquote(state, node) {
-    state.wrapBlock('> ', undefined, node, function () {
+    state.wrapBlock('> ', null, node, function () {
       return state.renderContent(node);
     });
   },
@@ -162,7 +211,7 @@ export var nodes = _objectSpread({
           return state.render(child, parent, i);
         });
       } else {
-        state.wrapBlock('    ', undefined, node, function () {
+        state.wrapBlock('    ', null, node, function () {
           return state.render(child, parent, i);
         });
       }

package/dist/types/serializer.d.ts

@@ -1,12 +1,34 @@
-import { MarkdownSerializer as PMMarkdownSerializer, MarkdownSerializerState as PMMarkdownSerializerState } from '@atlaskit/editor-prosemirror/markdown';
+import { MarkdownSerializer as PMMarkdownSerializer, MarkdownSerializerState as PMMarkdownSerializerState, type NodeSerializerSpec, type MarkSerializerSpec } from '@atlaskit/editor-prosemirror/markdown';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 export declare class MarkdownSerializerState extends PMMarkdownSerializerState {
+    nodes: NodeSerializerSpec;
+    marks: {
+        [mark: string]: MarkSerializerSpec;
+    };
+    /**
+     * Defines the internal variables used in the markdown serializer
+     * @see https://github.com/ProseMirror/prosemirror-markdown/blob/master/src/to_markdown.ts#L172
+     */
+    delim: string;
+    out: string;
+    closed: Node | null;
+    /**
+     * Defines the internal atBlank method used in the markdown serializer
+     * @see https://github.com/ProseMirror/prosemirror-markdown/blob/master/src/to_markdown.ts#L241
+     */
+    atBlank(): boolean;
+    /**
+     * Defines the internal flushClose method used in the markdown serializer
+     * @see https://github.com/ProseMirror/prosemirror-markdown/blob/master/src/to_markdown.ts#L202
+     */
+    flushClose(size?: number): void;
+    constructor(nodes: NodeSerializerSpec, marks: {
+        [mark: string]: MarkSerializerSpec;
+    });
     renderContent(parent: PMNode): void;
 }
 export declare class MarkdownSerializer extends PMMarkdownSerializer {
-    serialize(content: PMNode, options?: {
-        [key: string]: any;
-    }): string;
+    serialize(content: PMNode): string;
 }
 export declare const nodes: {
     table(state: MarkdownSerializerState, node: PMNode): void;

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

@@ -1,12 +1,34 @@
-import { MarkdownSerializer as PMMarkdownSerializer, MarkdownSerializerState as PMMarkdownSerializerState } from '@atlaskit/editor-prosemirror/markdown';
+import { MarkdownSerializer as PMMarkdownSerializer, MarkdownSerializerState as PMMarkdownSerializerState, type NodeSerializerSpec, type MarkSerializerSpec } from '@atlaskit/editor-prosemirror/markdown';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 export declare class MarkdownSerializerState extends PMMarkdownSerializerState {
+    nodes: NodeSerializerSpec;
+    marks: {
+        [mark: string]: MarkSerializerSpec;
+    };
+    /**
+     * Defines the internal variables used in the markdown serializer
+     * @see https://github.com/ProseMirror/prosemirror-markdown/blob/master/src/to_markdown.ts#L172
+     */
+    delim: string;
+    out: string;
+    closed: Node | null;
+    /**
+     * Defines the internal atBlank method used in the markdown serializer
+     * @see https://github.com/ProseMirror/prosemirror-markdown/blob/master/src/to_markdown.ts#L241
+     */
+    atBlank(): boolean;
+    /**
+     * Defines the internal flushClose method used in the markdown serializer
+     * @see https://github.com/ProseMirror/prosemirror-markdown/blob/master/src/to_markdown.ts#L202
+     */
+    flushClose(size?: number): void;
+    constructor(nodes: NodeSerializerSpec, marks: {
+        [mark: string]: MarkSerializerSpec;
+    });
     renderContent(parent: PMNode): void;
 }
 export declare class MarkdownSerializer extends PMMarkdownSerializer {
-    serialize(content: PMNode, options?: {
-        [key: string]: any;
-    }): string;
+    serialize(content: PMNode): string;
 }
 export declare const nodes: {
     table(state: MarkdownSerializerState, node: PMNode): void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-slack-transformer",
-	"version": "3.7.3",
+	"version": "3.7.4",
 	"description": "Editor Slack transformer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -38,7 +38,7 @@
 	},
 	"devDependencies": {
 		"@atlaskit/activity": "^1.0.1",
-		"@atlaskit/editor-core": "^198.0.0",
+		"@atlaskit/editor-core": "^198.2.0",
 		"@atlaskit/editor-test-helpers": "^19.0.0",
 		"@atlaskit/emoji": "^67.8.0",
 		"@atlaskit/mention": "^23.3.0",