fix(factories): Allow alphanumeric IDs for suggestion nodes in createSuggestionExtension

[rfgamaral]

Overview

Fixes #64.

PR Checklist

• Changes introduced here have been manually tested by someone other than the PR author
• Pull request title follows the Conventional Commits Specification
• Added/updated unit test cases and/or end-to-end test cases
• Added/updated documentation to Storybook or README.md

Test plan

• Open the preview Storybook deployed to Netlify
• Open the Rich-text → Default story
• Add [John Doe](mention://@user123:matrix.org) in the content control (bottom)
  • Observe that the editor was initialized with a mention suggestion identified
  • Observe that the Markdown output shows [John Doe](mention://@user123:matrix.org)

[netlify]

✅ Deploy Preview for doist-typist ready!

Name	Link
🔨 Latest commit	8b68b38
🔍 Latest deploy log	https://app.netlify.com/sites/doist-typist/deploys/639caa2a4414e40008d8b028
😎 Deploy Preview	https://deploy-preview-66--doist-typist.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[frankieyan]

Works well 👍

I suppose this would be a minor rather than breaking change as this doesn't change the markdown serialization, and we can continue to use numeric ids as they would be converted to strings internally by the extension, correct?

[rfgamaral]

I suppose this would be a minor rather than breaking change as this doesn't change the markdown serialization, and we can continue to use numeric ids as they would be converted to strings internally by the extension, correct?

Yes, when storage.itemsById is populated, keys are converted to strings.

---

But I'm glad you asked this because it prompted me to review the attributesMapping constraints in createSuggestionExtension, and I've realized that I broke the mapping for number properties in this PR. To explain what I mean, imagine SuggestionItem is defined like this:

type SuggestionItem = {
    uid: number
    name: string
}

But, internally, the extension uses id, so we need to map one property to the other, like this:

createSuggestionExtension<SuggestionItem>(MENTION_SUGGESTION_TYPE, MENTION_SUGGESTION_ITEMS, {
    id: 'uid',
    label: 'name',
})

However, with the changes I made in this PR, this doesn't work:

Because we are trying to map a number (i.e. uid), to a string (i.e. both id and label only allow strings).

So, technically, this is a breaking change, but it wouldn't actually break anything for us because our apps use id by default, and we don't need to map this attribute in particular, and since the extension will take care of converting everything to strings, everything just keeps working.

However, there's no reason to introduce this breaking change, even if it doesn't affect us. It's a simple fix, and doesn't break anything for anyone. I've also updated the MentionSuggestion and HashtagSuggestion extensions to serve as examples for different implementations.

Just thought I'd leave this whole clarification here for posterity.

---

@frankieyan Can you please take a second look at this commit?

[rfgamaral]

@frankieyan Made another commit, shouldn't change anything, but please double-check 🙏

[frankieyan]

Thanks for the explanation 👍 both hashtags and mentions are still working in storybook 🚀

[doistbot]

🎉 This PR is included in version 1.0.8 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀