feat(cat-voices): Add collaborators section to proposal builder

[bstolinski]

Description

This Pull Request implements the Collaborators feature in the Proposal Builder, allowing users to invite and manage co-proposers.

Related Issue(s)

Closes #3683
Part of #3677

Description of Changes

• Added the ability to add and manage collaborators within the proposal builder flow.
• This requires adding a new section collaborators to the schema:

"setup": {
    "$ref": "#/definitions/segment",
    "title": "Proposal setup",
    "description": "Proposal title",
    "x-icon": "view-grid",
    "properties": {
      "title": {...},
      "proposer": {...},
      "collaborators": {
        "$ref": "#/definitions/section",
        "title": "Co-Proposers",
        "x-guidance": "Co-Proposers will be notified via email upon proposal publishing. If they accept the invitation to join your proposal they will be shown as named co-proposer(s) on the published proposal. Co-proposers will not be able to edit any part of the proposal.\n\nIt's like a multi sig for your proposal, but not everyone needs to sign right away. You'll publish your new version right away, and your collaborators will be added to the proposal once they accept.\n\nBe sure to give your collaborators time to sign any final drafts before the proposal submission deadline!"
      }
    },
    "required": [
      "title",
      "proposer"
    ],
    "x-order": [
      "title",
      "proposer"
    ]
  }

Demo

Adding the same CatalystId with a changed username is not allowed, and there is a task for that.

collaborators_builder.mov

Please confirm the following checks

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream module

[github-actions]

📚 Docs Preview

The docs for this PR can be previewed at the following URL:

https://docs.dev.projectcatalyst.io/voices/feat/proposal-builder-collaborators

[dt-iohk]

In general we don't want to look inside other class to extract data that somebody else wrote, you should only read what you yourself wrote. Instead we should get the data we are interested in directly and explicitly in the callback. Here you're overriding the onChanged which only works with document changes so you cannot pass the data you're really interested in.

I do not have yet any ready solution thought through but I'd see if it's possible to avoid above and just communicate with callbacks

[bstolinski]

The source of this problem is how _CollaboratorsDetailsSelector is built and that it is wrapped in DocumentBuilderSectionTile->EditableTile->DocumentPropertyBuilder, which gives us certain benefits but also the onChanged methods are not adapted to custom behaviors.

I tried to disable the save button for EditableTile and create my own inside _CollaboratorsDetailsSelector, but then there was a problem with refreshing the state of widgets outside (DocumentBuilderSectionTile and EditableTile).

[dt-iohk]

What if next to onChanged we had onCollaboratorsChanged and to propagate this callback through all these layers? I'm afraid that with current solution it's too easy to change what we write in one place but forget to update the code that reads these values in somewhere else.

[bstolinski]

Done, I think it looks much better now. Pulling out and editing collaborators data is more centralized.

[damian-molinski]

LGTM