@doist/typist 4.0.4 → 5.0.0

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [5.0.0](https://github.com/Doist/typist/compare/v4.0.5...v5.0.0) (2024-03-20)
+
+### ⚠ BREAKING CHANGES
+
+-   This option was unused and was not intended for
+    consumer use. However, its removal technically constitutes a breaking
+    change, so we have marked it accordingly.
+
+### Miscellaneous Chores
+
+-   Remove unused `onImageNodeDelete` option ([#702](https://github.com/Doist/typist/issues/702)) ([ebd0678](https://github.com/Doist/typist/commit/ebd06784c14d00b748af7ad38bb030afcba41c35))
+
+## [4.0.5](https://github.com/Doist/typist/compare/v4.0.4...v4.0.5) (2024-03-06)
+
+### Bug Fixes
+
+-   Prevent extra blank lines on list items ([#685](https://github.com/Doist/typist/issues/685)) ([b538ebe](https://github.com/Doist/typist/commit/b538ebef9a43d6b1af2f68efcdad445ec9e0cc17))
+
 ## [4.0.4](https://github.com/Doist/typist/compare/v4.0.3...v4.0.4) (2024-03-06)
 
 ### Bug Fixes

package/dist/extensions/rich-text/rich-text-image.d.ts

@@ -48,7 +48,7 @@ type RichTextImageOptions = {
      */
     acceptedImageMimeTypes: string[];
     /**
-     * Renders the image node inline (e.g., <p><img src="spacer.gif"></p>). By default images are on
+     * Renders the image node inline (e.g., <p><img src="doist.jpg"></p>). By default images are on
      * the same level as paragraphs.
      */
     inline: boolean;
@@ -64,10 +64,6 @@ type RichTextImageOptions = {
      * The event handler that is fired when an image file is pasted.
      */
     onImageFilePaste?: (file: File) => void;
-    /**
-     * The event handler that should be fired when an image node is deleted.
-     */
-    onImageNodeDelete?: (attachmentId: string) => void;
 };
 /**
  * Custom extension that extends the built-in `Image` extension to add support for image pasting,

package/dist/extensions/rich-text/rich-text-image.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rich-text-image.d.ts","sourceRoot":"","sources":["../../../src/extensions/rich-text/rich-text-image.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAElD;;GAEG;AACH,KAAK,uBAAuB,GAAG;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE;QACP;;WAEG;QACH,YAAY,EAAE,MAAM,CAAA;QAEpB;;WAEG;QACH,cAAc,EAAE,OAAO,CAAA;QAEvB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAA;KACzB,CAAA;CACJ,GAAG,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,GAC7B,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,CAAA;AAEpD;;;GAGG;AACH,OAAO,QAAQ,cAAc,CAAC;IAC1B,UAAU,QAAQ,CAAC,UAAU;QACzB,aAAa,EAAE;YACX;;eAEG;YACH,WAAW,EAAE,CAAC,UAAU,EAAE,uBAAuB,KAAK,UAAU,CAAA;YAEhE;;eAEG;YACH,WAAW,EAAE,CACT,UAAU,EAAE,OAAO,CAAC,uBAAuB,CAAC,GACxC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,UAAU,CAAC,CAAC,KACtD,UAAU,CAAA;SAClB,CAAA;KACJ;CACJ;AAED;;GAEG;AACH,KAAK,oBAAoB,GAAG;IACxB;;OAEG;IACH,sBAAsB,EAAE,MAAM,EAAE,CAAA;IAEhC;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAA;IAEf;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAEtC;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,aAAa,CAAC,CAAA;IAEtD;;OAEG;IACH,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAA;IAEvC;;OAEG;IACH,iBAAiB,CAAC,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,CAAA;CACrD,CAAA;AAED;;;GAGG;AACH,QAAA,MAAM,aAAa,yDAoHjB,CAAA;AAEF,OAAO,EAAE,aAAa,EAAE,CAAA;AAExB,YAAY,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,CAAA"}
+{"version":3,"file":"rich-text-image.d.ts","sourceRoot":"","sources":["../../../src/extensions/rich-text/rich-text-image.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAElD;;GAEG;AACH,KAAK,uBAAuB,GAAG;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE;QACP;;WAEG;QACH,YAAY,EAAE,MAAM,CAAA;QAEpB;;WAEG;QACH,cAAc,EAAE,OAAO,CAAA;QAEvB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAA;KACzB,CAAA;CACJ,GAAG,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,GAC7B,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,CAAA;AAEpD;;;GAGG;AACH,OAAO,QAAQ,cAAc,CAAC;IAC1B,UAAU,QAAQ,CAAC,UAAU;QACzB,aAAa,EAAE;YACX;;eAEG;YACH,WAAW,EAAE,CAAC,UAAU,EAAE,uBAAuB,KAAK,UAAU,CAAA;YAEhE;;eAEG;YACH,WAAW,EAAE,CACT,UAAU,EAAE,OAAO,CAAC,uBAAuB,CAAC,GACxC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,UAAU,CAAC,CAAC,KACtD,UAAU,CAAA;SAClB,CAAA;KACJ;CACJ;AAED;;GAEG;AACH,KAAK,oBAAoB,GAAG;IACxB;;OAEG;IACH,sBAAsB,EAAE,MAAM,EAAE,CAAA;IAEhC;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAA;IAEf;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAEtC;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,aAAa,CAAC,CAAA;IAEtD;;OAEG;IACH,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAA;CAC1C,CAAA;AAED;;;GAGG;AACH,QAAA,MAAM,aAAa,yDAoHjB,CAAA;AAEF,OAAO,EAAE,aAAa,EAAE,CAAA;AAExB,YAAY,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,CAAA"}

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

@@ -2,7 +2,8 @@ import type { NodeType } from '@tiptap/pm/model';
 import type Turndown from 'turndown';
 /**
  * A Turndown plugin which adds a custom rule for paragraphs. This custom rule is required to avoid
- * adding unnecessary blank lines between paragraphs to plain-text documents.
+ * adding unnecessary blank lines between paragraphs to plain-text documents, and to list items in
+ * rich-text documents.
  *
  * @param nodeType The node object that matches this rule.
  * @param isPlainText Specifies if the schema represents a plain-text document.

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

@@ -1 +1 @@
-{"version":3,"file":"paragraph.d.ts","sourceRoot":"","sources":["../../../../src/serializers/markdown/plugins/paragraph.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAChD,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAA;AAEpC;;;;;;GAMG;AACH,iBAAS,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,GAAG,QAAQ,CAAC,MAAM,CAS5E;AAED,OAAO,EAAE,SAAS,EAAE,CAAA"}
+{"version":3,"file":"paragraph.d.ts","sourceRoot":"","sources":["../../../../src/serializers/markdown/plugins/paragraph.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAChD,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAA;AAEpC;;;;;;;GAOG;AACH,iBAAS,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,GAAG,QAAQ,CAAC,MAAM,CAe5E;AAED,OAAO,EAAE,SAAS,EAAE,CAAA"}

package/dist/serializers/markdown/plugins/paragraph.js

@@ -1,6 +1,7 @@
 /**
  * A Turndown plugin which adds a custom rule for paragraphs. This custom rule is required to avoid
- * adding unnecessary blank lines between paragraphs to plain-text documents.
+ * adding unnecessary blank lines between paragraphs to plain-text documents, and to list items in
+ * rich-text documents.
  *
  * @param nodeType The node object that matches this rule.
  * @param isPlainText Specifies if the schema represents a plain-text document.
@@ -9,8 +10,12 @@ function paragraph(nodeType, isPlainText) {
     return (turndown) => {
         turndown.addRule(nodeType.name, {
             filter: 'p',
-            replacement(content) {
-                return isPlainText ? `\n${content}\n` : `\n\n${content}\n\n`;
+            replacement(content, node) {
+                const useSingleLineSpacing = isPlainText ||
+                    // Paragraphs within list items should be wrapped with a single line feed to
+                    // maintain proper list formatting in rich-text documents.
+                    (!isPlainText && node.parentNode?.nodeName === 'LI');
+                return useSingleLineSpacing ? `\n${content}\n` : `\n\n${content}\n\n`;
             },
         });
     };

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": "4.0.4",
+    "version": "5.0.0",
     "license": "MIT",
     "homepage": "https://typist.doist.dev/",
     "repository": "https://github.com/Doist/typist",
@@ -83,24 +83,24 @@
         "@doist/prettier-config": "4.0.0",
         "@doist/reactist": "23.2.0",
         "@mdx-js/react": "3.0.1",
-        "@rollup/rollup-linux-x64-gnu": "4.12.0",
         "@semantic-release/changelog": "6.0.3",
         "@semantic-release/exec": "6.0.3",
         "@semantic-release/git": "10.0.1",
-        "@storybook/addon-a11y": "7.6.17",
-        "@storybook/addon-essentials": "7.6.17",
-        "@storybook/addons": "7.6.17",
+        "@storybook/addon-a11y": "8.0.0",
+        "@storybook/addon-essentials": "8.0.0",
+        "@storybook/blocks": "8.0.0",
         "@storybook/csf": "0.1.2",
+        "@storybook/manager-api": "8.0.0",
         "@storybook/mdx2-csf": "1.1.0",
-        "@storybook/react": "7.6.17",
-        "@storybook/react-vite": "7.6.17",
+        "@storybook/react": "8.0.0",
+        "@storybook/react-vite": "8.0.0",
         "@testing-library/dom": "9.3.4",
         "@testing-library/jest-dom": "6.4.2",
         "@testing-library/react": "14.2.1",
         "@types/hast": "3.0.4",
         "@types/lodash-es": "4.17.12",
-        "@types/react": "18.2.61",
-        "@types/react-dom": "18.2.19",
+        "@types/react": "18.2.66",
+        "@types/react-dom": "18.2.22",
         "@types/react-syntax-highlighter": "15.5.11",
         "@types/turndown": "5.0.4",
         "@types/unist": "3.0.2",
@@ -115,8 +115,8 @@
         "eslint-plugin-simple-import-sort": "12.0.0",
         "eslint-plugin-storybook": "0.8.0",
         "eslint-plugin-unicorn": "51.0.1",
-        "eslint-plugin-vitest": "0.3.22",
-        "eslint-plugin-vitest-globals": "1.4.0",
+        "eslint-plugin-vitest": "0.3.26",
+        "eslint-plugin-vitest-globals": "1.5.0",
         "github-markdown-css": "5.5.1",
         "husky": "9.0.11",
         "ignore-sync": "7.0.1",
@@ -126,6 +126,7 @@
         "npm-run-all2": "6.1.2",
         "prettier": "3.2.5",
         "react": "18.2.0",
+        "react-docgen-typescript": "2.2.2",
         "react-dom": "18.2.0",
         "react-icons": "5.0.1",
         "react-markdown": "9.0.1",
@@ -133,14 +134,14 @@
         "rehype-raw": "7.0.0",
         "remark-gfm": "4.0.0",
         "rimraf": "5.0.5",
-        "semantic-release": "23.0.2",
-        "tippy.js": "6.3.7",
-        "storybook": "7.6.17",
+        "semantic-release": "23.0.3",
+        "storybook": "8.0.0",
         "storybook-css-modules": "1.0.8",
-        "type-fest": "4.10.3",
-        "typescript": "5.3.3",
+        "tippy.js": "6.3.7",
+        "type-fest": "4.12.0",
+        "typescript": "5.4.2",
         "typescript-plugin-css-modules": "5.1.0",
-        "vitest": "1.3.1"
+        "vitest": "1.4.0"
     },
     "peerDependencies": {
         "@react-hookz/web": "^14.2.3 || >=15.x",