Ability to register icon packs (proposal for a PR)

[bonybrown]

Looking to register an icon pack on this plugin, following the instructions in:

https://mermaid.ai/open-source/config/icons.html

Rather than providing a configuration UI ( I've no idea where to begin with that approach ) I can see that there is a "lazy loading" option for registration.

So if this option is a lazy as it suggests, there shouldn't be any penalty in registering as many icon sets as anyone could want, and the only impact would be if that icon prefix is referenced.

Is this PR you would support?

[DanielHreben]

HI! The issue is that currently every icon (font character) is bundled during app build. Forge apps operate in a restricted (sandboxed) iframe, and can't load arbitrary urls. To make this work without significantly weakening the security posture by allowing app to access arbitrary URL to load resources we would need to store those icons somewhere in confluence, presumably as part of the page, so that app would have permissions to load them. We may be able to store them in the app database too (Special API provided to forge apps) - currently not used, but should not require perms escalation.

If you can figure out how to implement that - I'd be more than keen to help with app setup (including figuring out UI if needed) and code review.

[DanielHreben]

After finishing this comment I see that mermaid API is very customisable and agnostic - we can definitely make it load icons from page or forge API.

[bonybrown]

store those icons somewhere in confluence, presumably as part of the page, so that app would have permissions to load them

Do you mean storing the .json file as attachments on the page?

Could we use the https://developer.atlassian.com/platform/forge/storage-reference/object-store/ perhaps?

[bonybrown]

For reference, this set of icons is what I'm hoping to register https://github.com/awslabs/aws-icons-for-plantuml/blob/main/dist/aws-icons-mermaid.json

[DanielHreben]

Yes, we can use object store - this is what I refered to as "(Special API provided to forge apps)".