@doist/typist 1.0.16 → 1.0.18

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [1.0.18](https://github.com/Doist/typist/compare/v1.0.17...v1.0.18) (2023-02-23)
+
+### Bug Fixes
+
+-   **deps:** Migrate ProseMirror dependencies to `@tiptap/pm` package ([#151](https://github.com/Doist/typist/issues/151)) ([d2a8eae](https://github.com/Doist/typist/commit/d2a8eaefa0dc57579aa97f170e37dae17c77590d))
+
+## [1.0.17](https://github.com/Doist/typist/compare/v1.0.16...v1.0.17) (2023-02-23)
+
+### Bug Fixes
+
+-   **markdown-serializer:** Override Turndown escaping behaviour with custom rules ([#102](https://github.com/Doist/typist/issues/102)) ([6950afb](https://github.com/Doist/typist/commit/6950afb61bd22a3b029e7f688f5e704402290e5a))
+
 ## [1.0.16](https://github.com/Doist/typist/compare/v1.0.15...v1.0.16) (2023-02-22)
 
 ### Bug Fixes

package/dist/constants/regular-expressions.d.ts

@@ -2,5 +2,11 @@
  * A common regex for all line termination conventions.
  */
 declare const REGEX_LINE_BREAKS: RegExp;
-export { REGEX_LINE_BREAKS };
+/**
+ * A regex for standard punctuation characters for US-ASCII plus unicode punctuation.
+ *
+ * @see https://stackoverflow.com/a/25575009
+ */
+declare const REGEX_PUNCTUATION: RegExp;
+export { REGEX_LINE_BREAKS, REGEX_PUNCTUATION };
 //# sourceMappingURL=regular-expressions.d.ts.map

package/dist/constants/regular-expressions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"regular-expressions.d.ts","sourceRoot":"","sources":["../../src/constants/regular-expressions.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,QAAA,MAAM,iBAAiB,QAAoB,CAAA;AAE3C,OAAO,EAAE,iBAAiB,EAAE,CAAA"}
+{"version":3,"file":"regular-expressions.d.ts","sourceRoot":"","sources":["../../src/constants/regular-expressions.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,QAAA,MAAM,iBAAiB,QAAoB,CAAA;AAE3C;;;;GAIG;AACH,QAAA,MAAM,iBAAiB,QAAoE,CAAA;AAE3F,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,CAAA"}

package/dist/constants/regular-expressions.js

@@ -2,4 +2,10 @@
  * A common regex for all line termination conventions.
  */
 const REGEX_LINE_BREAKS = /(?:\r\n|\r|\n)/g;
-export { REGEX_LINE_BREAKS };
+/**
+ * A regex for standard punctuation characters for US-ASCII plus unicode punctuation.
+ *
+ * @see https://stackoverflow.com/a/25575009
+ */
+const REGEX_PUNCTUATION = /[\u2000-\u206f\u2e00-\u2e7f'!"#$%&()*+,\-./:;<=>?@\\[\]^_`{|}~]/;
+export { REGEX_LINE_BREAKS, REGEX_PUNCTUATION };

package/dist/index.d.ts

@@ -15,12 +15,12 @@ export type { AnyConfig, Editor as CoreEditor, EditorEvents, MarkRange, Range }
 export { combineTransactionSteps, defaultBlockAt, findChildren, findChildrenInRange, findParentNode, findParentNodeClosestToPos, generateHTML, generateJSON, generateText, getAttributes, getChangedRanges, getDebugJSON, getExtensionField, getHTMLFromFragment, getMarkAttributes, getMarkRange, getMarksBetween, getMarkType, getNodeAttributes, getNodeType, getSchema, getText, getTextBetween, isActive, isList, isMarkActive, isNodeActive, isNodeEmpty, isNodeSelection, isTextSelection, mergeAttributes, posToDOMRect, } from '@tiptap/core';
 export { Extension, Mark } from '@tiptap/core';
 export * from '@tiptap/extension-character-count';
+export { DOMParser, Fragment, Node as ProseMirrorNode } from '@tiptap/pm/model';
+export type { Selection, Transaction } from '@tiptap/pm/state';
+export { EditorState, Plugin, PluginKey } from '@tiptap/pm/state';
+export type { EditorView } from '@tiptap/pm/view';
 export type { Editor, NodeViewProps, ReactRendererOptions } from '@tiptap/react';
 export { NodeViewWrapper, ReactRenderer } from '@tiptap/react';
 export type { SuggestionKeyDownProps, SuggestionOptions as TiptapSuggestionOptions, } from '@tiptap/suggestion';
 export { Suggestion } from '@tiptap/suggestion';
-export { DOMParser, Fragment, Node as ProseMirrorNode } from 'prosemirror-model';
-export type { Selection, Transaction } from 'prosemirror-state';
-export { EditorState, Plugin, PluginKey } from 'prosemirror-state';
-export type { EditorView } from 'prosemirror-view';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACR,iBAAiB,EACjB,SAAS,EACT,WAAW,EACX,YAAY,EACZ,UAAU,EACV,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,WAAW,GACd,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,EAAE,6BAA6B,EAAE,MAAM,kCAAkC,CAAA;AAChF,cAAc,oEAAoE,CAAA;AAClF,cAAc,0EAA0E,CAAA;AACxF,OAAO,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AACrE,YAAY,EACR,uBAAuB,EACvB,oBAAoB,GACvB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAA;AAClE,YAAY,EACR,yBAAyB,EACzB,iBAAiB,EACjB,uBAAuB,EACvB,qBAAqB,EACrB,iBAAiB,GACpB,MAAM,yCAAyC,CAAA;AAChD,OAAO,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAA;AACnF,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAA;AAC3E,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAA;AAC1E,YAAY,EAAE,SAAS,EAAE,MAAM,IAAI,UAAU,EAAE,YAAY,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,cAAc,CAAA;AACnG,OAAO,EACH,uBAAuB,EACvB,cAAc,EACd,YAAY,EACZ,mBAAmB,EACnB,cAAc,EACd,0BAA0B,EAC1B,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,YAAY,EACZ,eAAe,EACf,WAAW,EACX,iBAAiB,EACjB,WAAW,EACX,SAAS,EACT,OAAO,EACP,cAAc,EACd,QAAQ,EACR,MAAM,EACN,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,eAAe,EACf,eAAe,EACf,eAAe,EACf,YAAY,GACf,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAC9C,cAAc,mCAAmC,CAAA;AACjD,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAChF,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAC9D,YAAY,EACR,sBAAsB,EACtB,iBAAiB,IAAI,uBAAuB,GAC/C,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAC/C,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAChF,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAClE,YAAY,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACR,iBAAiB,EACjB,SAAS,EACT,WAAW,EACX,YAAY,EACZ,UAAU,EACV,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,WAAW,GACd,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,EAAE,6BAA6B,EAAE,MAAM,kCAAkC,CAAA;AAChF,cAAc,oEAAoE,CAAA;AAClF,cAAc,0EAA0E,CAAA;AACxF,OAAO,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AACrE,YAAY,EACR,uBAAuB,EACvB,oBAAoB,GACvB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAA;AAClE,YAAY,EACR,yBAAyB,EACzB,iBAAiB,EACjB,uBAAuB,EACvB,qBAAqB,EACrB,iBAAiB,GACpB,MAAM,yCAAyC,CAAA;AAChD,OAAO,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAA;AACnF,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAA;AAC3E,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAA;AAC1E,YAAY,EAAE,SAAS,EAAE,MAAM,IAAI,UAAU,EAAE,YAAY,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,cAAc,CAAA;AACnG,OAAO,EACH,uBAAuB,EACvB,cAAc,EACd,YAAY,EACZ,mBAAmB,EACnB,cAAc,EACd,0BAA0B,EAC1B,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,YAAY,EACZ,eAAe,EACf,WAAW,EACX,iBAAiB,EACjB,WAAW,EACX,SAAS,EACT,OAAO,EACP,cAAc,EACd,QAAQ,EACR,MAAM,EACN,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,eAAe,EACf,eAAe,EACf,eAAe,EACf,YAAY,GACf,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAC9C,cAAc,mCAAmC,CAAA;AACjD,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,IAAI,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAC/E,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjE,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAChF,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAC9D,YAAY,EACR,sBAAsB,EACtB,iBAAiB,IAAI,uBAAuB,GAC/C,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA"}

package/dist/index.js

@@ -11,7 +11,7 @@ export { createMarkdownSerializer } from './serializers/markdown/markdown';
 export { combineTransactionSteps, defaultBlockAt, findChildren, findChildrenInRange, findParentNode, findParentNodeClosestToPos, generateHTML, generateJSON, generateText, getAttributes, getChangedRanges, getDebugJSON, getExtensionField, getHTMLFromFragment, getMarkAttributes, getMarkRange, getMarksBetween, getMarkType, getNodeAttributes, getNodeType, getSchema, getText, getTextBetween, isActive, isList, isMarkActive, isNodeActive, isNodeEmpty, isNodeSelection, isTextSelection, mergeAttributes, posToDOMRect, } from '@tiptap/core';
 export { Extension, Mark } from '@tiptap/core';
 export * from '@tiptap/extension-character-count';
+export { DOMParser, Fragment, Node as ProseMirrorNode } from '@tiptap/pm/model';
+export { EditorState, Plugin, PluginKey } from '@tiptap/pm/state';
 export { NodeViewWrapper, ReactRenderer } from '@tiptap/react';
 export { Suggestion } from '@tiptap/suggestion';
-export { DOMParser, Fragment, Node as ProseMirrorNode } from 'prosemirror-model';
-export { EditorState, Plugin, PluginKey } from 'prosemirror-state';

package/dist/serializers/markdown/markdown.d.ts

@@ -1,13 +1,4 @@
 import type { Schema } from 'prosemirror-model';
-/**
- * The options that the `createMarkdownSerializer` function accepts.
- */
-type MarkdownSerializerOptions = {
-    /**
-     * Disables markdown escaping.
-     */
-    escape?: false;
-};
 /**
  * The return type for the `createMarkdownSerializer` function.
  */
@@ -38,7 +29,7 @@ declare const BULLET_LIST_MARKER = "-";
  *
  * @returns A normalized object for the Markdown serializer.
  */
-declare function createMarkdownSerializer(schema: Schema, options?: MarkdownSerializerOptions): MarkdownSerializerReturnType;
+declare function createMarkdownSerializer(schema: Schema): MarkdownSerializerReturnType;
 export { BULLET_LIST_MARKER, createMarkdownSerializer };
 export type { MarkdownSerializerReturnType };
 //# sourceMappingURL=markdown.d.ts.map

package/dist/serializers/markdown/markdown.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../../src/serializers/markdown/markdown.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAE/C;;GAEG;AACH,KAAK,yBAAyB,GAAG;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAA;CACjB,CAAA;AAED;;GAEG;AACH,KAAK,4BAA4B,GAAG;IAChC;;;;;;OAMG;IACH,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAA;CACtC,CAAA;AAED;;GAEG;AACH,QAAA,MAAM,kBAAkB,MAAM,CAAA;AA8C9B;;;;;;;;;;;;GAYG;AACH,iBAAS,wBAAwB,CAC7B,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,yBAAyB,GACpC,4BAA4B,CA4E9B;AAED,OAAO,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,CAAA;AAEvD,YAAY,EAAE,4BAA4B,EAAE,CAAA"}
+{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../../src/serializers/markdown/markdown.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAE/C;;GAEG;AACH,KAAK,4BAA4B,GAAG;IAChC;;;;;;OAMG;IACH,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAA;CACtC,CAAA;AAED;;GAEG;AACH,QAAA,MAAM,kBAAkB,MAAM,CAAA;AA8C9B;;;;;;;;;;;;GAYG;AACH,iBAAS,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,4BAA4B,CAiG9E;AAED,OAAO,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,CAAA;AAEvD,YAAY,EAAE,4BAA4B,EAAE,CAAA"}

package/dist/serializers/markdown/markdown.js

@@ -1,4 +1,5 @@
 import Turndown from 'turndown';
+import { REGEX_PUNCTUATION } from '../../constants/regular-expressions';
 import { isPlainTextDocument } from '../../helpers/schema';
 import { image } from './plugins/image';
 import { listItem } from './plugins/list-item';
@@ -61,19 +62,37 @@ const INITIAL_TURNDOWN_OPTIONS = {
  *
  * @returns A normalized object for the Markdown serializer.
  */
-function createMarkdownSerializer(schema, options) {
+function createMarkdownSerializer(schema) {
     // Initialize Turndown with custom options
     const turndown = new Turndown(INITIAL_TURNDOWN_OPTIONS);
-    // Turndown was built to convert HTML into Markdown, expecting the input to be standards
-    // compliant HTML. As such, it collapses all whitespace by default, and there's
-    // currently no way to opt-out of this behavior. However, for plain-text editors, we
-    // need to preserve Markdown whitespace (otherwise we lose syntax like nested lists) by
-    // replacing all instances of the space character (but only if it's preceded by another
-    // space character) by the non-breaking space character, and after processing the input
-    // with Turndown, we restore the original space character.
-    if (isPlainTextDocument(schema) || options?.escape === false) {
+    // Turndown ensures Markdown characters are escaped (i.e. `\`) by default, so they are not
+    // interpreted as Markdown when the output is compiled back to HTML. However, for plain-text
+    // editors, we need to override the `escape` function to return the input as-is (effectively
+    // disabling the escaping behaviour), so that all characters are interpreted as Markdown.
+    if (isPlainTextDocument(schema)) {
         turndown.escape = (str) => str;
     }
+    // As for rich-text editors, we need to override the built-in escaping behaviour with a custom
+    // implementation to suit our requirements. Please note that the `escape` function takes the
+    // text content of each HTML element, with the exception of code elements, so we can be sure
+    // that the escaping behaviour will only touch relevant Markdown characters.
+    else {
+        turndown.escape = (str) => {
+            return (str
+                // Escape all backslash characters that precedes any punctuation characters,
+                // otherwise the backslash character itself will be interpreted as escaping the
+                // character that comes after it (which is not the intent). It's important that
+                // this escape rule is executed before all other escape rules, otherwise we
+                // could be double escaping some backslash characters.
+                .replace(new RegExp(`(\\\\${REGEX_PUNCTUATION.source})`, 'g'), '\\$1')
+                // Although the CommonMark specification allows for bulleted or ordered lists
+                // inside other bulleted or ordered lists (i.e. `- 1. - 1. Item`), the markup
+                // generated by Markdown compilers is not supported by Tiptap, and we need to
+                // make sure that text context that matches the ordered list syntax is
+                // correctly escaped in order to be interpreted as text.
+                .replace(/^(\d+)\.(\s.+|$)/, '$1\\.$2'));
+        };
+    }
     // Overwrite some built-in rules for handling of special behaviours
     // (see documentation for each extension for more details)
     turndown.use(paragraph(schema.nodes.paragraph, isPlainTextDocument(schema)));

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@doist/typist",
     "description": "The mighty Tiptap-based rich-text editor React component that powers Doist products.",
-    "version": "1.0.16",
+    "version": "1.0.18",
     "license": "MIT",
     "homepage": "https://typist.doist.dev/",
     "repository": "https://github.com/Doist/typist",
@@ -72,27 +72,10 @@
         "@tiptap/extension-task-list": "2.0.0-beta.217",
         "@tiptap/extension-text": "2.0.0-beta.217",
         "@tiptap/extension-typography": "2.0.0-beta.217",
+        "@tiptap/pm": "2.0.0-beta.217",
         "@tiptap/react": "2.0.0-beta.217",
         "@tiptap/suggestion": "2.0.0-beta.217",
-        "prosemirror-codemark": "0.4.2",
-        "prosemirror-changeset": "2.2.0",
-        "prosemirror-collab": "1.3.0",
-        "prosemirror-commands": "1.5.0",
-        "prosemirror-dropcursor": "1.5.0",
-        "prosemirror-gapcursor": "1.3.1",
-        "prosemirror-history": "1.3.0",
-        "prosemirror-inputrules": "1.2.0",
-        "prosemirror-keymap": "1.2.0",
-        "prosemirror-markdown": "1.10.1",
-        "prosemirror-menu": "1.2.1",
-        "prosemirror-model": "1.18.3",
-        "prosemirror-schema-basic": "1.2.0",
-        "prosemirror-schema-list": "1.2.2",
-        "prosemirror-state": "1.4.2",
-        "prosemirror-tables": "1.3.0",
-        "prosemirror-trailing-node": "2.0.2",
-        "prosemirror-transform": "1.7.0",
-        "prosemirror-view": "1.29.1"
+        "prosemirror-codemark": "0.4.2"
     },
     "devDependencies": {
         "@doist/eslint-config": "8.1.3",