@doist/typist 2.2.0 → 2.3.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [2.3.0](https://github.com/Doist/typist/compare/v2.2.1...v2.3.0) (2024-01-17)
+
+### Features
+
+-   **commands:** Add `smartToggleBulletList` and `smartToggleOrderedList` ([#612](https://github.com/Doist/typist/issues/612)) ([e5dcc8b](https://github.com/Doist/typist/commit/e5dcc8b523d7596e168f919fd53d9119f7c40ac7))
+
+## [2.2.1](https://github.com/Doist/typist/compare/v2.2.0...v2.2.1) (2024-01-11)
+
+### Bug Fixes
+
+-   **deps:** update tiptap packages to v2.1.13 ([#554](https://github.com/Doist/typist/issues/554)) ([e89007b](https://github.com/Doist/typist/commit/e89007b7da928c3be46f2beaef9207586c3279a4))
+
 ## [2.2.0](https://github.com/Doist/typist/compare/v2.1.3...v2.2.0) (2023-11-21)
 
 ### Features

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022-2023 Doist Inc.
+Copyright (c) 2022-2024 Doist Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/extensions/rich-text/rich-text-bullet-list.d.ts

@@ -0,0 +1,27 @@
+import type { BulletListOptions } from '@tiptap/extension-bullet-list';
+/**
+ * Augment the official `@tiptap/core` module with extra commands, relevant for this extension, so
+ * that the compiler knows about them.
+ */
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        richTextBulletList: {
+            /**
+             * Smartly toggles the selection into a bullet list, converting any hard breaks into
+             * paragraphs before doing so.
+             *
+             * @see https://discuss.prosemirror.net/t/how-to-convert-a-selection-of-text-lines-into-paragraphs/6099
+             */
+            smartToggleBulletList: () => ReturnType;
+        };
+    }
+}
+/**
+ * Custom extension that extends the built-in `BulletList` extension to add a smart toggle command
+ * with support for hard breaks, which are automatically converted into paragraphs before toggling
+ * the selection into a bullet list.
+ */
+declare const RichTextBulletList: import("@tiptap/core").Node<BulletListOptions, any>;
+export { RichTextBulletList };
+export type { BulletListOptions as RichTextBulletListOptions };
+//# sourceMappingURL=rich-text-bullet-list.d.ts.map

package/dist/extensions/rich-text/rich-text-bullet-list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rich-text-bullet-list.d.ts","sourceRoot":"","sources":["../../../src/extensions/rich-text/rich-text-bullet-list.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAA;AAEtE;;;GAGG;AACH,OAAO,QAAQ,cAAc,CAAC;IAC1B,UAAU,QAAQ,CAAC,UAAU;QACzB,kBAAkB,EAAE;YAChB;;;;;eAKG;YACH,qBAAqB,EAAE,MAAM,UAAU,CAAA;SAC1C,CAAA;KACJ;CACJ;AAED;;;;GAIG;AACH,QAAA,MAAM,kBAAkB,qDAoDtB,CAAA;AAEF,OAAO,EAAE,kBAAkB,EAAE,CAAA;AAE7B,YAAY,EAAE,iBAAiB,IAAI,yBAAyB,EAAE,CAAA"}

package/dist/extensions/rich-text/rich-text-bullet-list.js

@@ -0,0 +1,50 @@
+import { BulletList } from '@tiptap/extension-bullet-list';
+import { ListItem } from '@tiptap/extension-list-item';
+import { TextStyle } from '@tiptap/extension-text-style';
+import { Fragment, Slice } from '@tiptap/pm/model';
+/**
+ * Custom extension that extends the built-in `BulletList` extension to add a smart toggle command
+ * with support for hard breaks, which are automatically converted into paragraphs before toggling
+ * the selection into a bullet list.
+ */
+const RichTextBulletList = BulletList.extend({
+    addCommands() {
+        const { editor, name, options } = this;
+        return {
+            smartToggleBulletList() {
+                return ({ commands, state, tr, chain }) => {
+                    const { schema } = state;
+                    const { selection } = tr;
+                    const { $from, $to } = selection;
+                    const hardBreakPositions = [];
+                    // Find and store the positions of all hard breaks in the selection
+                    tr.doc.nodesBetween($from.pos, $to.pos, (node, pos) => {
+                        if (node.type.name === 'hardBreak') {
+                            hardBreakPositions.push(pos);
+                        }
+                    });
+                    // Replace each hard break with a slice that closes and re-opens a paragraph,
+                    // effectively inserting a "paragraph break" in place of a "hard break"
+                    // (this is performed in reverse order to compensate for content shifting that
+                    // occurs with each replacement, ensuring accurate insertion points)
+                    hardBreakPositions.reverse().forEach((pos) => {
+                        tr.replace(pos, pos + 1, Slice.maxOpen(Fragment.fromArray([
+                            schema.nodes.paragraph.create(),
+                            schema.nodes.paragraph.create(),
+                        ])));
+                    });
+                    // Toggle the selection into a bullet list, optionally keeping attributes
+                    // (this is a verbatim copy of the built-in`toggleBulletList` command)
+                    if (options.keepAttributes) {
+                        return chain()
+                            .toggleList(name, options.itemTypeName, options.keepMarks)
+                            .updateAttributes(ListItem.name, editor.getAttributes(TextStyle.name))
+                            .run();
+                    }
+                    return commands.toggleList(name, options.itemTypeName, options.keepMarks);
+                };
+            },
+        };
+    },
+});
+export { RichTextBulletList };

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

@@ -1,8 +1,6 @@
 import { Extension } from '@tiptap/core';
-import { RichTextStrikethroughOptions } from './rich-text-strikethrough';
 import type { BlockquoteOptions } from '@tiptap/extension-blockquote';
 import type { BoldOptions } from '@tiptap/extension-bold';
-import type { BulletListOptions } from '@tiptap/extension-bullet-list';
 import type { CodeOptions } from '@tiptap/extension-code';
 import type { CodeBlockOptions } from '@tiptap/extension-code-block';
 import type { DropcursorOptions } from '@tiptap/extension-dropcursor';
@@ -13,11 +11,13 @@ import type { HorizontalRuleOptions } from '@tiptap/extension-horizontal-rule';
 import type { ItalicOptions } from '@tiptap/extension-italic';
 import type { ListItemOptions } from '@tiptap/extension-list-item';
 import type { ListKeymapOptions } from '@tiptap/extension-list-keymap';
-import type { OrderedListOptions } from '@tiptap/extension-ordered-list';
 import type { ParagraphOptions } from '@tiptap/extension-paragraph';
+import type { RichTextBulletListOptions } from './rich-text-bullet-list';
 import type { RichTextDocumentOptions } from './rich-text-document';
 import type { RichTextImageOptions } from './rich-text-image';
 import type { RichTextLinkOptions } from './rich-text-link';
+import type { RichTextOrderedListOptions } from './rich-text-ordered-list';
+import type { RichTextStrikethroughOptions } from './rich-text-strikethrough';
 /**
  * The options available to customize the `RichTextKit` extension.
  */
@@ -33,7 +33,7 @@ type RichTextKitOptions = {
     /**
      * Set options for the `BulletList` extension, or `false` to disable.
      */
-    bulletList: Partial<BulletListOptions> | false;
+    bulletList: Partial<RichTextBulletListOptions> | false;
     /**
      * Set options for the `Code` extension, or `false` to disable.
      */
@@ -93,7 +93,7 @@ type RichTextKitOptions = {
     /**
      * Set options for the `OrderedList` extension, or `false` to disable.
      */
-    orderedList: Partial<OrderedListOptions> | false;
+    orderedList: Partial<RichTextOrderedListOptions> | false;
     /**
      * Set options for the `Paragraph` extension, or `false` to disable.
      */

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

@@ -1 +1 @@
-{"version":3,"file":"rich-text-kit.d.ts","sourceRoot":"","sources":["../../../src/extensions/rich-text/rich-text-kit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAgCxC,OAAO,EAAyB,4BAA4B,EAAE,MAAM,2BAA2B,CAAA;AAG/F,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAA;AACtE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AACpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAC/D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAC/D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;AAC9E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAC7D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAA;AAClE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAA;AACtE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AACxE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AACnE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AACnE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AAC7D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAA;AAE3D;;GAEG;AACH,KAAK,kBAAkB,GAAG;IACtB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAA;IAE9C;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,KAAK,CAAA;IAElC;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAA;IAE9C;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,KAAK,CAAA;IAElC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAA;IAE5C;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,uBAAuB,CAAC,GAAG,KAAK,CAAA;IAElD;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAA;IAE9C;;OAEG;IACH,SAAS,EAAE,KAAK,CAAA;IAEhB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAA;IAE5C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,KAAK,CAAA;IAExC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,KAAK,CAAA;IAExC;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,KAAK,CAAA;IAEtD;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAA;IAE5C;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,KAAK,CAAA;IAEtC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,KAAK,CAAA;IAE1C;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,KAAK,CAAA;IAE1C;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAA;IAE9C;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAA;IAEhD;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAA;IAE5C;;OAEG;IACH,WAAW,EAAE,KAAK,CAAA;IAElB;;OAEG;IACH,aAAa,EAAE,KAAK,CAAA;IAEpB;;OAEG;IACH,mBAAmB,EAAE,KAAK,CAAA;IAE1B;;OAEG;IACH,sBAAsB,EAAE,KAAK,CAAA;IAE7B;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC,4BAA4B,CAAC,GAAG,KAAK,CAAA;IAErD;;OAEG;IACH,IAAI,EAAE,KAAK,CAAA;IAEX;;OAEG;IACH,UAAU,EAAE,KAAK,CAAA;CACpB,CAAA;AAED;;;;GAIG;AACH,QAAA,MAAM,WAAW,oCA2If,CAAA;AAEF,OAAO,EAAE,WAAW,EAAE,CAAA;AAEtB,YAAY,EAAE,kBAAkB,EAAE,CAAA"}
+{"version":3,"file":"rich-text-kit.d.ts","sourceRoot":"","sources":["../../../src/extensions/rich-text/rich-text-kit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAmCxC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AACpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAC/D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAC/D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;AAC9E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAC7D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAA;AAClE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAA;AACtE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AACnE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAA;AACxE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AACnE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AAC7D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAA;AAC3D,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAA;AAC1E,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,2BAA2B,CAAA;AAE7E;;GAEG;AACH,KAAK,kBAAkB,GAAG;IACtB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAA;IAE9C;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,KAAK,CAAA;IAElC;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC,yBAAyB,CAAC,GAAG,KAAK,CAAA;IAEtD;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,KAAK,CAAA;IAElC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAA;IAE5C;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,uBAAuB,CAAC,GAAG,KAAK,CAAA;IAElD;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAA;IAE9C;;OAEG;IACH,SAAS,EAAE,KAAK,CAAA;IAEhB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAA;IAE5C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,KAAK,CAAA;IAExC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,KAAK,CAAA;IAExC;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,KAAK,CAAA;IAEtD;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAA;IAE5C;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,KAAK,CAAA;IAEtC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,KAAK,CAAA;IAE1C;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,KAAK,CAAA;IAE1C;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAA;IAE9C;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC,0BAA0B,CAAC,GAAG,KAAK,CAAA;IAExD;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAA;IAE5C;;OAEG;IACH,WAAW,EAAE,KAAK,CAAA;IAElB;;OAEG;IACH,aAAa,EAAE,KAAK,CAAA;IAEpB;;OAEG;IACH,mBAAmB,EAAE,KAAK,CAAA;IAE1B;;OAEG;IACH,sBAAsB,EAAE,KAAK,CAAA;IAE7B;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC,4BAA4B,CAAC,GAAG,KAAK,CAAA;IAErD;;OAEG;IACH,IAAI,EAAE,KAAK,CAAA;IAEX;;OAEG;IACH,UAAU,EAAE,KAAK,CAAA;CACpB,CAAA;AAED;;;;GAIG;AACH,QAAA,MAAM,WAAW,oCA2If,CAAA;AAEF,OAAO,EAAE,WAAW,EAAE,CAAA;AAEtB,YAAY,EAAE,kBAAkB,EAAE,CAAA"}

package/dist/extensions/rich-text/rich-text-kit.js

@@ -1,7 +1,6 @@
 import { Extension } from '@tiptap/core';
 import { Blockquote } from '@tiptap/extension-blockquote';
 import { Bold } from '@tiptap/extension-bold';
-import { BulletList } from '@tiptap/extension-bullet-list';
 import { CodeBlock } from '@tiptap/extension-code-block';
 import { Dropcursor } from '@tiptap/extension-dropcursor';
 import { Gapcursor } from '@tiptap/extension-gapcursor';
@@ -12,7 +11,6 @@ import { HorizontalRule } from '@tiptap/extension-horizontal-rule';
 import { Italic } from '@tiptap/extension-italic';
 import { ListItem } from '@tiptap/extension-list-item';
 import { ListKeymap } from '@tiptap/extension-list-keymap';
-import { OrderedList } from '@tiptap/extension-ordered-list';
 import { Paragraph } from '@tiptap/extension-paragraph';
 import { Text } from '@tiptap/extension-text';
 import { Typography } from '@tiptap/extension-typography';
@@ -24,10 +22,12 @@ import { BoldAndItalics } from './bold-and-italics';
 import { CurvenoteCodemark } from './curvenote-codemark';
 import { PasteEmojis } from './paste-emojis';
 import { PasteMarkdown } from './paste-markdown';
+import { RichTextBulletList } from './rich-text-bullet-list';
 import { RichTextCode } from './rich-text-code';
 import { RichTextDocument } from './rich-text-document';
 import { RichTextImage } from './rich-text-image';
 import { RichTextLink } from './rich-text-link';
+import { RichTextOrderedList } from './rich-text-ordered-list';
 import { RichTextStrikethrough } from './rich-text-strikethrough';
 /**
  * The `RichTextKit` extension is a collection of the minimal required extensions to have a full
@@ -47,7 +47,7 @@ const RichTextKit = Extension.create({
             extensions.push(Bold.configure(this.options?.bold));
         }
         if (this.options.bulletList !== false) {
-            extensions.push(BulletList.configure(this.options?.bulletList));
+            extensions.push(RichTextBulletList.configure(this.options?.bulletList));
         }
         if (this.options.code !== false) {
             extensions.push(RichTextCode.configure(this.options?.code), 
@@ -119,7 +119,7 @@ const RichTextKit = Extension.create({
             extensions.push(ListKeymap.configure(this.options?.listKeymap));
         }
         if (this.options.orderedList !== false) {
-            extensions.push(OrderedList.configure(this.options?.orderedList));
+            extensions.push(RichTextOrderedList.configure(this.options?.orderedList));
         }
         if (this.options.paragraph !== false) {
             extensions.push(Paragraph.configure(this.options?.paragraph));

package/dist/extensions/rich-text/rich-text-ordered-list.d.ts

@@ -0,0 +1,27 @@
+import type { OrderedListOptions } from '@tiptap/extension-ordered-list';
+/**
+ * Augment the official `@tiptap/core` module with extra commands, relevant for this extension, so
+ * that the compiler knows about them.
+ */
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        richTextOrderedList: {
+            /**
+             * Smartly toggles the selection into an oredered list, converting any hard breaks into
+             * paragraphs before doing so.
+             *
+             * @see https://discuss.prosemirror.net/t/how-to-convert-a-selection-of-text-lines-into-paragraphs/6099
+             */
+            smartToggleOrderedList: () => ReturnType;
+        };
+    }
+}
+/**
+ * Custom extension that extends the built-in `OrderedList` extension to add a smart toggle command
+ * with support for hard breaks, which are automatically converted into paragraphs before toggling
+ * the selection into an ordered list.
+ */
+declare const RichTextOrderedList: import("@tiptap/core").Node<OrderedListOptions, any>;
+export { RichTextOrderedList };
+export type { OrderedListOptions as RichTextOrderedListOptions };
+//# sourceMappingURL=rich-text-ordered-list.d.ts.map

package/dist/extensions/rich-text/rich-text-ordered-list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rich-text-ordered-list.d.ts","sourceRoot":"","sources":["../../../src/extensions/rich-text/rich-text-ordered-list.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AAExE;;;GAGG;AACH,OAAO,QAAQ,cAAc,CAAC;IAC1B,UAAU,QAAQ,CAAC,UAAU;QACzB,mBAAmB,EAAE;YACjB;;;;;eAKG;YACH,sBAAsB,EAAE,MAAM,UAAU,CAAA;SAC3C,CAAA;KACJ;CACJ;AAED;;;;GAIG;AACH,QAAA,MAAM,mBAAmB,sDAoDvB,CAAA;AAEF,OAAO,EAAE,mBAAmB,EAAE,CAAA;AAE9B,YAAY,EAAE,kBAAkB,IAAI,0BAA0B,EAAE,CAAA"}

package/dist/extensions/rich-text/rich-text-ordered-list.js

@@ -0,0 +1,50 @@
+import { ListItem } from '@tiptap/extension-list-item';
+import { OrderedList } from '@tiptap/extension-ordered-list';
+import { TextStyle } from '@tiptap/extension-text-style';
+import { Fragment, Slice } from '@tiptap/pm/model';
+/**
+ * Custom extension that extends the built-in `OrderedList` extension to add a smart toggle command
+ * with support for hard breaks, which are automatically converted into paragraphs before toggling
+ * the selection into an ordered list.
+ */
+const RichTextOrderedList = OrderedList.extend({
+    addCommands() {
+        const { editor, name, options } = this;
+        return {
+            smartToggleOrderedList() {
+                return ({ commands, state, tr, chain }) => {
+                    const { schema } = state;
+                    const { selection } = tr;
+                    const { $from, $to } = selection;
+                    const hardBreakPositions = [];
+                    // Find and store the positions of all hard breaks in the selection
+                    tr.doc.nodesBetween($from.pos, $to.pos, (node, pos) => {
+                        if (node.type.name === 'hardBreak') {
+                            hardBreakPositions.push(pos);
+                        }
+                    });
+                    // Replace each hard break with a slice that closes and re-opens a paragraph,
+                    // effectively inserting a "paragraph break" in place of a "hard break"
+                    // (this is performed in reverse order to compensate for content shifting that
+                    // occurs with each replacement, ensuring accurate insertion points)
+                    hardBreakPositions.reverse().forEach((pos) => {
+                        tr.replace(pos, pos + 1, Slice.maxOpen(Fragment.fromArray([
+                            schema.nodes.paragraph.create(),
+                            schema.nodes.paragraph.create(),
+                        ])));
+                    });
+                    // Toggle the selection into a bullet list, optionally keeping attributes
+                    // (this is a verbatim copy of the built-in`toggleBulletList` command)
+                    if (options.keepAttributes) {
+                        return chain()
+                            .toggleList(name, options.itemTypeName, options.keepMarks)
+                            .updateAttributes(ListItem.name, editor.getAttributes(TextStyle.name))
+                            .run();
+                    }
+                    return commands.toggleList(name, options.itemTypeName, options.keepMarks);
+                };
+            },
+        };
+    },
+});
+export { RichTextOrderedList };

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": "2.2.0",
+    "version": "2.3.0",
     "license": "MIT",
     "homepage": "https://typist.doist.dev/",
     "repository": "https://github.com/Doist/typist",
@@ -46,100 +46,104 @@
         "validate:pre-push": "run-s test"
     },
     "dependencies": {
-        "@tiptap/core": "2.1.12",
-        "@tiptap/extension-blockquote": "2.1.12",
-        "@tiptap/extension-bold": "2.1.12",
-        "@tiptap/extension-bullet-list": "2.1.12",
-        "@tiptap/extension-character-count": "2.1.12",
-        "@tiptap/extension-code": "2.1.12",
-        "@tiptap/extension-code-block": "2.1.12",
-        "@tiptap/extension-document": "2.1.12",
-        "@tiptap/extension-dropcursor": "2.1.12",
-        "@tiptap/extension-gapcursor": "2.1.12",
-        "@tiptap/extension-hard-break": "2.1.12",
-        "@tiptap/extension-heading": "2.1.12",
-        "@tiptap/extension-history": "2.1.12",
-        "@tiptap/extension-horizontal-rule": "2.1.12",
-        "@tiptap/extension-image": "2.1.12",
-        "@tiptap/extension-italic": "2.1.12",
-        "@tiptap/extension-link": "2.1.12",
-        "@tiptap/extension-list-item": "2.1.12",
-        "@tiptap/extension-list-keymap": "2.1.12",
-        "@tiptap/extension-ordered-list": "2.1.12",
-        "@tiptap/extension-paragraph": "2.1.12",
-        "@tiptap/extension-placeholder": "2.1.12",
-        "@tiptap/extension-strike": "2.1.12",
-        "@tiptap/extension-task-item": "2.1.12",
-        "@tiptap/extension-task-list": "2.1.12",
-        "@tiptap/extension-text": "2.1.12",
-        "@tiptap/extension-typography": "2.1.12",
-        "@tiptap/pm": "2.1.12",
-        "@tiptap/react": "2.1.12",
-        "@tiptap/suggestion": "2.1.12",
+        "@tiptap/core": "2.1.13",
+        "@tiptap/extension-blockquote": "2.1.13",
+        "@tiptap/extension-bold": "2.1.13",
+        "@tiptap/extension-bullet-list": "2.1.13",
+        "@tiptap/extension-character-count": "2.1.13",
+        "@tiptap/extension-code": "2.1.13",
+        "@tiptap/extension-code-block": "2.1.13",
+        "@tiptap/extension-document": "2.1.13",
+        "@tiptap/extension-dropcursor": "2.1.13",
+        "@tiptap/extension-gapcursor": "2.1.13",
+        "@tiptap/extension-hard-break": "2.1.13",
+        "@tiptap/extension-heading": "2.1.13",
+        "@tiptap/extension-history": "2.1.13",
+        "@tiptap/extension-horizontal-rule": "2.1.13",
+        "@tiptap/extension-image": "2.1.13",
+        "@tiptap/extension-italic": "2.1.13",
+        "@tiptap/extension-link": "2.1.13",
+        "@tiptap/extension-list-item": "2.1.13",
+        "@tiptap/extension-list-keymap": "2.1.13",
+        "@tiptap/extension-ordered-list": "2.1.13",
+        "@tiptap/extension-paragraph": "2.1.13",
+        "@tiptap/extension-placeholder": "2.1.13",
+        "@tiptap/extension-strike": "2.1.13",
+        "@tiptap/extension-task-item": "2.1.13",
+        "@tiptap/extension-task-list": "2.1.13",
+        "@tiptap/extension-text": "2.1.13",
+        "@tiptap/extension-text-style": "2.1.13",
+        "@tiptap/extension-typography": "2.1.13",
+        "@tiptap/pm": "2.1.13",
+        "@tiptap/react": "2.1.13",
+        "@tiptap/suggestion": "2.1.13",
         "prosemirror-codemark": "0.4.2"
     },
     "devDependencies": {
         "@doist/eslint-config": "11.0.0",
         "@doist/prettier-config": "4.0.0",
-        "@doist/reactist": "22.3.0",
-        "@mdx-js/react": "2.3.0",
+        "@doist/reactist": "22.3.3",
+        "@mdx-js/react": "3.0.0",
+        "@rollup/rollup-linux-x64-gnu": "4.9.5",
         "@semantic-release/changelog": "6.0.3",
         "@semantic-release/exec": "6.0.3",
         "@semantic-release/git": "10.0.1",
-        "@storybook/addon-a11y": "7.5.3",
-        "@storybook/addon-essentials": "7.5.3",
-        "@storybook/addons": "7.5.3",
-        "@storybook/csf": "0.1.1",
+        "@storybook/addon-a11y": "7.6.8",
+        "@storybook/addon-essentials": "7.6.8",
+        "@storybook/addons": "7.6.8",
+        "@storybook/csf": "0.1.2",
         "@storybook/mdx2-csf": "1.1.0",
-        "@storybook/react": "7.5.3",
-        "@storybook/react-vite": "7.5.3",
-        "@testing-library/dom": "9.3.3",
-        "@testing-library/jest-dom": "6.1.4",
-        "@testing-library/react": "14.1.0",
-        "@types/lodash-es": "4.17.11",
-        "@types/react": "18.2.37",
-        "@types/react-dom": "18.2.15",
-        "@types/react-syntax-highlighter": "15.5.10",
+        "@storybook/react": "7.6.8",
+        "@storybook/react-vite": "7.6.8",
+        "@testing-library/dom": "9.3.4",
+        "@testing-library/jest-dom": "6.2.0",
+        "@testing-library/react": "14.1.2",
+        "@types/lodash-es": "4.17.12",
+        "@types/react": "18.2.47",
+        "@types/react-dom": "18.2.18",
+        "@types/react-syntax-highlighter": "15.5.11",
         "@types/turndown": "5.0.4",
-        "@vitejs/plugin-react": "4.1.1",
+        "@vitejs/plugin-react": "4.2.1",
         "boring-avatars": "1.10.1",
-        "classnames": "2.3.2",
+        "classnames": "2.5.1",
         "conventional-changelog-conventionalcommits": "7.0.2",
         "emoji-regex": "10.3.0",
-        "eslint": "8.53.0",
+        "eslint": "8.56.0",
         "eslint-formatter-codeframe": "7.32.1",
         "eslint-import-resolver-typescript": "3.6.1",
         "eslint-plugin-simple-import-sort": "10.0.0",
         "eslint-plugin-storybook": "0.6.15",
-        "eslint-plugin-unicorn": "48.0.1",
-        "eslint-plugin-vitest": "0.3.9",
+        "eslint-plugin-unicorn": "50.0.1",
+        "eslint-plugin-vitest": "0.3.20",
         "eslint-plugin-vitest-globals": "1.4.0",
-        "github-markdown-css": "5.4.0",
+        "github-markdown-css": "5.5.0",
         "husky": "8.0.3",
         "ignore-sync": "7.0.1",
         "is-ci": "3.0.1",
-        "jsdom": "22.1.0",
-        "lint-staged": "15.1.0",
+        "jsdom": "23.2.0",
+        "lint-staged": "15.2.0",
         "npm-run-all": "4.1.5",
-        "prettier": "3.1.0",
+        "prettier": "3.2.1",
         "react": "18.2.0",
         "react-dom": "18.2.0",
-        "react-icons": "4.12.0",
+        "react-icons": "5.0.1",
         "react-markdown": "8.0.7",
         "react-syntax-highlighter": "15.5.0",
         "rimraf": "5.0.5",
-        "semantic-release": "22.0.7",
-        "storybook": "7.5.3",
+        "semantic-release": "22.0.12",
+        "tippy.js": "6.3.7",
+        "storybook": "7.6.8",
         "storybook-css-modules": "1.0.8",
-        "type-fest": "4.7.1",
-        "typescript": "5.2.2",
+        "type-fest": "4.9.0",
+        "typescript": "5.3.3",
         "typescript-plugin-css-modules": "5.0.2",
-        "vitest": "0.34.6"
+        "vitest": "1.2.0"
     },
     "peerDependencies": {
         "@react-hookz/web": "^14.2.3 || >=15.x",
         "emoji-regex": "^10.2.1",
         "hast-util-is-element": "^2.1.0",
+        "linkifyjs": "^4.1.1",
         "lodash-es": "^4.17.21",
         "mdast-util-gfm-autolink-literal": "^1.0.0",
         "mdast-util-gfm-strikethrough": "^1.0.0",
@@ -151,7 +155,6 @@
         "rehype-minify-whitespace": "^5.0.0",
         "rehype-raw": "^6.1.0",
         "rehype-stringify": "^9.0.0",
-        "linkifyjs": "^4.1.1",
         "remark": "^14.0.0",
         "remark-breaks": "^3.0.0",
         "remark-gfm": "^3.0.0",