@doist/typist 6.0.11 → 7.0.0

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+## [7.0.0](https://github.com/Doist/typist/compare/v6.0.11...v7.0.0) (2024-08-28)
+
+### ⚠ BREAKING CHANGES
+
+-   Fix TypeScript types for the Suggestion plugin
+    `command` function (allowing for generic override).
+
+Although this was not causing any issues for us due to the convoluted
+implementation, the same fix was recently applied to Tiptap, and this
+aligns our suggestion factory function implementation with the original
+one. Unfortunately, this comes as a breaking change (examples were also
+updated to reflect the required changes).
+
+Additionally, other smaller TypeScript types were refactored for
+consistency and clarity, but these are safe changes.
+
+### Code Refactoring
+
+-   General improvements for TypeScript types ([#883](https://github.com/Doist/typist/issues/883)) ([b235eaf](https://github.com/Doist/typist/commit/b235eaf9506c5bf8ed0a94e863f9262b9735ad7e))
+
 ## [6.0.11](https://github.com/Doist/typist/compare/v6.0.10...v6.0.11) (2024-08-23)
 
 ### Bug Fixes

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

@@ -1,3 +1,8 @@
+import type { CodeOptions } from '@tiptap/extension-code';
+/**
+ * The options available to customize the `RichTextCode` extension.
+ */
+type RichTextCodeOptions = CodeOptions;
 /**
  * Custom extension that extends the built-in `Code` extension to allow all marks (e.g., Bold,
  * Italic, and Strikethrough) to coexist with the `Code` mark (as opposed to disallowing all any
@@ -6,6 +11,7 @@
  * @see https://tiptap.dev/api/schema#excludes
  * @see https://prosemirror.net/docs/ref/#model.MarkSpec.excludes
  */
-declare const RichTextCode: import("@tiptap/core").Mark<import("@tiptap/extension-code").CodeOptions, any>;
+declare const RichTextCode: import("@tiptap/core").Mark<CodeOptions, any>;
 export { RichTextCode };
+export type { RichTextCodeOptions };
 //# sourceMappingURL=rich-text-code.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"rich-text-code.d.ts","sourceRoot":"","sources":["../../../src/extensions/rich-text/rich-text-code.ts"],"names":[],"mappings":"AAIA;;;;;;;GAOG;AACH,QAAA,MAAM,YAAY,gFAGhB,CAAA;AAEF,OAAO,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"rich-text-code.d.ts","sourceRoot":"","sources":["../../../src/extensions/rich-text/rich-text-code.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAEzD;;GAEG;AACH,KAAK,mBAAmB,GAAG,WAAW,CAAA;AAEtC;;;;;;;GAOG;AACH,QAAA,MAAM,YAAY,+CAGhB,CAAA;AAEF,OAAO,EAAE,YAAY,EAAE,CAAA;AAEvB,YAAY,EAAE,mBAAmB,EAAE,CAAA"}

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

@@ -1,4 +1,8 @@
 import type { LinkOptions } from '@tiptap/extension-link';
+/**
+ * The options available to customize the `RichTextLink` extension.
+ */
+type RichTextLinkOptions = LinkOptions;
 /**
  * Custom extension that extends the built-in `Link` extension to add additional input/paste rules
  * for converting the Markdown link syntax (i.e. `[Doist](https://doist.com)`) into links, and also
@@ -6,5 +10,5 @@ import type { LinkOptions } from '@tiptap/extension-link';
  */
 declare const RichTextLink: import("@tiptap/core").Mark<LinkOptions, any>;
 export { RichTextLink };
-export type { LinkOptions as RichTextLinkOptions };
+export type { RichTextLinkOptions };
 //# sourceMappingURL=rich-text-link.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"rich-text-link.d.ts","sourceRoot":"","sources":["../../../src/extensions/rich-text/rich-text-link.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAuDzD;;;;GAIG;AACH,QAAA,MAAM,YAAY,+CAoDhB,CAAA;AAEF,OAAO,EAAE,YAAY,EAAE,CAAA;AAEvB,YAAY,EAAE,WAAW,IAAI,mBAAmB,EAAE,CAAA"}
+{"version":3,"file":"rich-text-link.d.ts","sourceRoot":"","sources":["../../../src/extensions/rich-text/rich-text-link.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAuDzD;;GAEG;AACH,KAAK,mBAAmB,GAAG,WAAW,CAAA;AAEtC;;;;GAIG;AACH,QAAA,MAAM,YAAY,+CAoDhB,CAAA;AAEF,OAAO,EAAE,YAAY,EAAE,CAAA;AAEvB,YAAY,EAAE,mBAAmB,EAAE,CAAA"}

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

@@ -1,8 +1,12 @@
 import type { StrikeOptions } from '@tiptap/extension-strike';
+/**
+ * The options available to customize the `RichTextStrikethrough` extension.
+ */
+type RichTextStrikethroughOptions = StrikeOptions;
 /**
  * Custom extension that extends the built-in `Strike` extension to overwrite the default keyboard.
  */
 declare const RichTextStrikethrough: import("@tiptap/core").Mark<StrikeOptions, any>;
 export { RichTextStrikethrough };
-export type { StrikeOptions as RichTextStrikethroughOptions };
+export type { RichTextStrikethroughOptions };
 //# sourceMappingURL=rich-text-strikethrough.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"rich-text-strikethrough.d.ts","sourceRoot":"","sources":["../../../src/extensions/rich-text/rich-text-strikethrough.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAE7D;;GAEG;AACH,QAAA,MAAM,qBAAqB,iDAMzB,CAAA;AAEF,OAAO,EAAE,qBAAqB,EAAE,CAAA;AAEhC,YAAY,EAAE,aAAa,IAAI,4BAA4B,EAAE,CAAA"}
+{"version":3,"file":"rich-text-strikethrough.d.ts","sourceRoot":"","sources":["../../../src/extensions/rich-text/rich-text-strikethrough.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAE7D;;GAEG;AACH,KAAK,4BAA4B,GAAG,aAAa,CAAA;AAEjD;;GAEG;AACH,QAAA,MAAM,qBAAqB,iDAMzB,CAAA;AAEF,OAAO,EAAE,qBAAqB,EAAE,CAAA;AAEhC,YAAY,EAAE,4BAA4B,EAAE,CAAA"}

package/dist/factories/create-suggestion-extension.d.ts

@@ -1,10 +1,10 @@
 import { Node } from '@tiptap/core';
-import type { SuggestionKeyDownProps as CoreSuggestionKeyDownProps, SuggestionOptions as CoreSuggestionOptions } from '@tiptap/suggestion';
+import type { SuggestionKeyDownProps as CoreSuggestionKeyDownProps, SuggestionOptions as CoreSuggestionOptions, SuggestionProps as CoreSuggestionProps } from '@tiptap/suggestion';
 import type { ConditionalKeys, RequireAtLeastOne } from 'type-fest';
 /**
- * The properties that describe the suggestion node attributes.
+ * A type that describes the suggestion node attributes.
  */
-type SuggestionAttributes = {
+type SuggestionNodeAttributes = {
     /**
      * The suggestion node unique identifier to be rendered by the editor as a `data-id` attribute.
      */
@@ -16,21 +16,21 @@ type SuggestionAttributes = {
     label: string;
 };
 /**
- * The properties that describe the minimal props that an autocomplete dropdown must receive.
+ * A type that describes the minimal props that an autocomplete dropdown must receive.
  */
-type SuggestionRendererProps<SuggestionItemType> = {
+type SuggestionRendererProps<TSuggestionItem> = {
     /**
-     * The function that must be invoked when a suggestion item is selected.
+     * The list of suggestion items to be rendered by the autocomplete dropdown.
      */
-    command: (item: SuggestionItemType) => void;
+    items: CoreSuggestionProps<TSuggestionItem>['items'];
     /**
-     * The list of suggestion items to be rendered by the autocomplete dropdown.
+     * The function that must be invoked when a suggestion item is selected.
      */
-    items: SuggestionItemType[];
+    command: CoreSuggestionProps<TSuggestionItem, SuggestionNodeAttributes>['command'];
 };
 /**
  * A type that describes the forwarded ref that an autocomplete dropdown must implement with
- * `useImperativeHandle` to receive `keyDown` events from the render function.
+ * `useImperativeHandle` to handle `keydown` events in the dropdown render function.
  */
 type SuggestionRendererRef = {
     onKeyDown: (props: CoreSuggestionKeyDownProps) => boolean;
@@ -38,11 +38,11 @@ type SuggestionRendererRef = {
 /**
  * The options available to customize the extension created by the factory function.
  */
-type SuggestionOptions<SuggestionItemType> = {
+type SuggestionOptions<TSuggestionItem> = {
     /**
      * The character that triggers the autocomplete dropdown.
      */
-    triggerChar: '@' | '#' | '+';
+    triggerChar: string;
     /**
      * Allows or disallows spaces in suggested items.
      */
@@ -58,39 +58,39 @@ type SuggestionOptions<SuggestionItemType> = {
     /**
      * Define how the suggestion item `aria-label` attribute should be rendered.
      */
-    renderAriaLabel?: (attrs: SuggestionAttributes) => string;
+    renderAriaLabel?: (attrs: SuggestionNodeAttributes) => string;
     /**
      * A render function for the autocomplete dropdown.
      */
-    dropdownRenderFn?: CoreSuggestionOptions<SuggestionItemType>['render'];
+    dropdownRenderFn?: CoreSuggestionOptions<TSuggestionItem>['render'];
     /**
      * The event handler that is fired when the search string has changed.
      */
-    onSearchChange?: (query: string, storage: SuggestionStorage<SuggestionItemType>) => SuggestionItemType[] | Promise<SuggestionItemType[]>;
+    onSearchChange?: (query: string, storage: SuggestionStorage<TSuggestionItem>) => TSuggestionItem[] | Promise<TSuggestionItem[]>;
     /**
      * The event handler that is fired when a suggestion item is selected.
      */
-    onItemSelect?: (item: SuggestionItemType) => void;
+    onItemSelect?: (item: TSuggestionItem) => void;
 };
 /**
  * The storage holding the suggestion items original array, and a collection indexed by the item id.
  */
-type SuggestionStorage<SuggestionItemType> = Readonly<{
+type SuggestionStorage<TSuggestionItem> = Readonly<{
     /**
      * The original array of suggestion items.
      */
-    items: SuggestionItemType[];
+    items: TSuggestionItem[];
     /**
      * A collection of suggestion items indexed by the item id.
      */
     itemsById: {
-        readonly [id: SuggestionAttributes['id']]: SuggestionItemType | undefined;
+        readonly [id: SuggestionNodeAttributes['id']]: TSuggestionItem | undefined;
     };
 }>;
 /**
  * The return type for a suggestion extension created by the factory function.
  */
-type SuggestionExtensionResult<SuggestionItemType> = Node<SuggestionOptions<SuggestionItemType>>;
+type SuggestionExtensionResult<TSuggestionItem> = Node<SuggestionOptions<TSuggestionItem>>;
 /**
  * A factory function responsible for creating different types of suggestion extensions with
  * flexibility and customizability in mind.
@@ -102,20 +102,28 @@ type SuggestionExtensionResult<SuggestionItemType> = Node<SuggestionOptions<Sugg
  * specify the source item type, and use the optional `attributesMapping` option to map the
  * source properties to the internal `data-id` and `data-label` attributes.
  *
+ * This factory function also stores the suggestion items internally in the editor storage (as-is,
+ * and indexed by an identifier), as a way to make sure that if a previously referenced suggestion
+ * changes its label, the editor will always render the most up-to-date label for the suggestion by
+ * reading it from the storage. An example use case for this is when a user mention is added to the
+ * editor, and the user changed its name afterwards, the editor will always render the most
+ * up-to-date user name for the mention.
+ *
  * @param type A unique identifier for the suggestion extension type.
+ * @param items An array of suggestion items to be stored in the editor storage.
  * @param attributesMapping An object to map the `data-id` and `data-label` attributes with the
  * source item type properties.
  *
  * @returns A new suggestion extension tailored to a specific use case.
  */
-declare function createSuggestionExtension<SuggestionItemType extends {
-    [id: SuggestionAttributes['id']]: unknown;
-} = SuggestionAttributes>(type: string, items?: SuggestionItemType[], ...attributesMapping: SuggestionItemType extends SuggestionAttributes ? [] : [
+declare function createSuggestionExtension<TSuggestionItem extends {
+    [id: SuggestionNodeAttributes['id']]: unknown;
+} = SuggestionNodeAttributes>(type: string, items?: TSuggestionItem[], ...attributesMapping: TSuggestionItem extends SuggestionNodeAttributes ? [] : [
     RequireAtLeastOne<{
-        id: ConditionalKeys<SuggestionItemType, SuggestionAttributes['id']>;
-        label: ConditionalKeys<SuggestionItemType, SuggestionAttributes['label']>;
+        id: ConditionalKeys<TSuggestionItem, SuggestionNodeAttributes['id']>;
+        label: ConditionalKeys<TSuggestionItem, SuggestionNodeAttributes['label']>;
     }>
-]): SuggestionExtensionResult<SuggestionItemType>;
+]): SuggestionExtensionResult<TSuggestionItem>;
 export { createSuggestionExtension };
 export type { SuggestionExtensionResult, SuggestionOptions, SuggestionRendererProps, SuggestionRendererRef, SuggestionStorage, };
 //# sourceMappingURL=create-suggestion-extension.d.ts.map

package/dist/factories/create-suggestion-extension.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-suggestion-extension.d.ts","sourceRoot":"","sources":["../../src/factories/create-suggestion-extension.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,IAAI,EAAE,MAAM,cAAc,CAAA;AASpD,OAAO,KAAK,EACR,sBAAsB,IAAI,0BAA0B,EACpD,iBAAiB,IAAI,qBAAqB,EAC7C,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAEnE;;GAEG;AACH,KAAK,oBAAoB,GAAG;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IAEnB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,KAAK,uBAAuB,CAAC,kBAAkB,IAAI;IAC/C;;OAEG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,IAAI,CAAA;IAE3C;;OAEG;IACH,KAAK,EAAE,kBAAkB,EAAE,CAAA;CAC9B,CAAA;AAED;;;GAGG;AACH,KAAK,qBAAqB,GAAG;IACzB,SAAS,EAAE,CAAC,KAAK,EAAE,0BAA0B,KAAK,OAAO,CAAA;CAC5D,CAAA;AAED;;GAEG;AACH,KAAK,iBAAiB,CAAC,kBAAkB,IAAI;IACzC;;OAEG;IACH,WAAW,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,CAAA;IAE5B;;OAEG;IACH,WAAW,EAAE,qBAAqB,CAAC,aAAa,CAAC,CAAA;IAEjD;;OAEG;IACH,eAAe,EAAE,qBAAqB,CAAC,iBAAiB,CAAC,CAAA;IAEzD;;OAEG;IACH,WAAW,EAAE,qBAAqB,CAAC,aAAa,CAAC,CAAA;IAEjD;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,MAAM,CAAA;IAEzD;;OAEG;IACH,gBAAgB,CAAC,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,CAAA;IAEtE;;OAEG;IACH,cAAc,CAAC,EAAE,CACb,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,iBAAiB,CAAC,kBAAkB,CAAC,KAC7C,kBAAkB,EAAE,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAA;IAEzD;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,IAAI,CAAA;CACpD,CAAA;AAED;;GAEG;AACH,KAAK,iBAAiB,CAAC,kBAAkB,IAAI,QAAQ,CAAC;IAClD;;OAEG;IACH,KAAK,EAAE,kBAAkB,EAAE,CAAA;IAE3B;;OAEG;IACH,SAAS,EAAE;QAAE,QAAQ,EAAE,EAAE,EAAE,oBAAoB,CAAC,IAAI,CAAC,GAAG,kBAAkB,GAAG,SAAS,CAAA;KAAE,CAAA;CAC3F,CAAC,CAAA;AAEF;;GAEG;AACH,KAAK,yBAAyB,CAAC,kBAAkB,IAAI,IAAI,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC,CAAA;AAEhG;;;;;;;;;;;;;;;;GAgBG;AACH,iBAAS,yBAAyB,CAC9B,kBAAkB,SAAS;IAAE,CAAC,EAAE,EAAE,oBAAoB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAA;CAAE,GAAG,oBAAoB,EAE/F,IAAI,EAAE,MAAM,EACZ,KAAK,GAAE,kBAAkB,EAAO,EAKhC,GAAG,iBAAiB,EAAE,kBAAkB,SAAS,oBAAoB,GAC/D,EAAE,GACF;IACI,iBAAiB,CAAC;QACd,EAAE,EAAE,eAAe,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAA;QACnE,KAAK,EAAE,eAAe,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAA;KAC5E,CAAC;CACL,GACR,yBAAyB,CAAC,kBAAkB,CAAC,CAwJ/C;AAED,OAAO,EAAE,yBAAyB,EAAE,CAAA;AAEpC,YAAY,EACR,yBAAyB,EACzB,iBAAiB,EACjB,uBAAuB,EACvB,qBAAqB,EACrB,iBAAiB,GACpB,CAAA"}
+{"version":3,"file":"create-suggestion-extension.d.ts","sourceRoot":"","sources":["../../src/factories/create-suggestion-extension.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,IAAI,EAAE,MAAM,cAAc,CAAA;AASpD,OAAO,KAAK,EACR,sBAAsB,IAAI,0BAA0B,EACpD,iBAAiB,IAAI,qBAAqB,EAC1C,eAAe,IAAI,mBAAmB,EACzC,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAEnE;;GAEG;AACH,KAAK,wBAAwB,GAAG;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IAEnB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,KAAK,uBAAuB,CAAC,eAAe,IAAI;IAC5C;;OAEG;IACH,KAAK,EAAE,mBAAmB,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,CAAA;IAEpD;;OAEG;IACH,OAAO,EAAE,mBAAmB,CAAC,eAAe,EAAE,wBAAwB,CAAC,CAAC,SAAS,CAAC,CAAA;CACrF,CAAA;AAED;;;GAGG;AACH,KAAK,qBAAqB,GAAG;IACzB,SAAS,EAAE,CAAC,KAAK,EAAE,0BAA0B,KAAK,OAAO,CAAA;CAC5D,CAAA;AAED;;GAEG;AACH,KAAK,iBAAiB,CAAC,eAAe,IAAI;IACtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,WAAW,EAAE,qBAAqB,CAAC,aAAa,CAAC,CAAA;IAEjD;;OAEG;IACH,eAAe,EAAE,qBAAqB,CAAC,iBAAiB,CAAC,CAAA;IAEzD;;OAEG;IACH,WAAW,EAAE,qBAAqB,CAAC,aAAa,CAAC,CAAA;IAEjD;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,wBAAwB,KAAK,MAAM,CAAA;IAE7D;;OAEG;IACH,gBAAgB,CAAC,EAAE,qBAAqB,CAAC,eAAe,CAAC,CAAC,QAAQ,CAAC,CAAA;IAEnE;;OAEG;IACH,cAAc,CAAC,EAAE,CACb,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,iBAAiB,CAAC,eAAe,CAAC,KAC1C,eAAe,EAAE,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAEnD;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,CAAA;CACjD,CAAA;AAED;;GAEG;AACH,KAAK,iBAAiB,CAAC,eAAe,IAAI,QAAQ,CAAC;IAC/C;;OAEG;IACH,KAAK,EAAE,eAAe,EAAE,CAAA;IAExB;;OAEG;IACH,SAAS,EAAE;QAAE,QAAQ,EAAE,EAAE,EAAE,wBAAwB,CAAC,IAAI,CAAC,GAAG,eAAe,GAAG,SAAS,CAAA;KAAE,CAAA;CAC5F,CAAC,CAAA;AAEF;;GAEG;AACH,KAAK,yBAAyB,CAAC,eAAe,IAAI,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,CAAA;AAE1F;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,iBAAS,yBAAyB,CAC9B,eAAe,SAAS;IACpB,CAAC,EAAE,EAAE,wBAAwB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAA;CAChD,GAAG,wBAAwB,EAE5B,IAAI,EAAE,MAAM,EACZ,KAAK,GAAE,eAAe,EAAO,EAK7B,GAAG,iBAAiB,EAAE,eAAe,SAAS,wBAAwB,GAChE,EAAE,GACF;IACI,iBAAiB,CAAC;QACd,EAAE,EAAE,eAAe,CAAC,eAAe,EAAE,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAA;QACpE,KAAK,EAAE,eAAe,CAAC,eAAe,EAAE,wBAAwB,CAAC,OAAO,CAAC,CAAC,CAAA;KAC7E,CAAC;CACL,GACR,yBAAyB,CAAC,eAAe,CAAC,CA8J5C;AAED,OAAO,EAAE,yBAAyB,EAAE,CAAA;AAEpC,YAAY,EACR,yBAAyB,EACzB,iBAAiB,EACjB,uBAAuB,EACvB,qBAAqB,EACrB,iBAAiB,GACpB,CAAA"}

package/dist/factories/create-suggestion-extension.js

@@ -16,7 +16,15 @@ import { canInsertSuggestion } from '../utilities/can-insert-suggestion';
  * specify the source item type, and use the optional `attributesMapping` option to map the
  * source properties to the internal `data-id` and `data-label` attributes.
  *
+ * This factory function also stores the suggestion items internally in the editor storage (as-is,
+ * and indexed by an identifier), as a way to make sure that if a previously referenced suggestion
+ * changes its label, the editor will always render the most up-to-date label for the suggestion by
+ * reading it from the storage. An example use case for this is when a user mention is added to the
+ * editor, and the user changed its name afterwards, the editor will always render the most
+ * up-to-date user name for the mention.
+ *
  * @param type A unique identifier for the suggestion extension type.
+ * @param items An array of suggestion items to be stored in the editor storage.
  * @param attributesMapping An object to map the `data-id` and `data-label` attributes with the
  * source item type properties.
  *
@@ -61,24 +69,26 @@ function createSuggestionExtension(type, items = [],
         },
         addAttributes() {
             return {
-                [idAttribute]: {
+                id: {
                     default: null,
                     parseHTML: (element) => element.getAttribute('data-id'),
                     renderHTML: (attributes) => ({
-                        'data-id': String(attributes[idAttribute]),
+                        'data-id': String(attributes.id),
                     }),
                 },
-                [labelAttribute]: {
+                label: {
                     default: null,
                     parseHTML: (element) => {
                         const id = String(element.getAttribute('data-id'));
                         const item = this.storage.itemsById[id];
-                        // Read the latest item label from the storage, if available, otherwise
-                        // fallback to the item label in the `data-label` attribute
+                        // Attempt to read the item label from the storage first (as a way to make
+                        // sure that a previously referenced suggestion always renders the most
+                        // up-to-date label for the suggestion), and fallback to the `data-label`
+                        // attribute if the item is not found in the storage
                         return String(item?.[labelAttribute] ?? element.getAttribute('data-label'));
                     },
                     renderHTML: (attributes) => ({
-                        'data-label': String(attributes[labelAttribute]),
+                        'data-label': String(attributes.label),
                     }),
                 },
             };
@@ -92,18 +102,18 @@ function createSuggestionExtension(type, items = [],
                 mergeAttributes({
                     [`data-${attributeType}`]: '',
                     'aria-label': this.options.renderAriaLabel?.({
-                        id: String(node.attrs[idAttribute]),
-                        label: String(node.attrs[labelAttribute]),
+                        id: String(node.attrs.id),
+                        label: String(node.attrs.label),
                     }),
                 }, HTMLAttributes),
-                `${String(this.options.triggerChar)}${String(node.attrs[labelAttribute])}`,
+                `${String(this.options.triggerChar)}${String(node.attrs.label)}`,
             ];
         },
         renderText({ node }) {
-            return `${String(this.options.triggerChar)}${String(node.attrs[labelAttribute])}`;
+            return `${String(this.options.triggerChar)}${String(node.attrs.label)}`;
         },
         addProseMirrorPlugins() {
-            const { triggerChar, allowSpaces, allowedPrefixes, startOfLine, onSearchChange, onItemSelect, dropdownRenderFn, } = this.options;
+            const { options: { triggerChar, allowSpaces, allowedPrefixes, startOfLine, onSearchChange, onItemSelect, dropdownRenderFn, }, storage, } = this;
             return [
                 TiptapSuggestion({
                     pluginKey: new PluginKey(nodeType),
@@ -139,7 +149,10 @@ function createSuggestionExtension(type, items = [],
                             },
                         ])
                             .run();
-                        onItemSelect?.(props);
+                        const item = storage.itemsById[props.id];
+                        if (item) {
+                            onItemSelect?.(item);
+                        }
                     },
                     render: dropdownRenderFn,
                 }),

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": "6.0.11",
+    "version": "7.0.0",
     "license": "MIT",
     "homepage": "https://typist.doist.dev/",
     "repository": "https://github.com/Doist/typist",
@@ -130,6 +130,7 @@
         "react-icons": "5.3.0",
         "react-markdown": "9.0.1",
         "react-syntax-highlighter": "15.5.0",
+        "react-use-event-hook": "0.9.6",
         "rehype-raw": "7.0.0",
         "remark-gfm": "4.0.0",
         "rimraf": "6.0.1",