Configure FA permissions to send incomplete declarations

[anny320]

Problem statement

Add configuration setting to prevent field agents from submitting partially completed forms
(Describe the problem you're trying to solve by doing this work)

Tech design fundamentals

• User scopes need to be as granular as possible. User scope is the smallest unit of the system,
• User scopes need to be documented comprehensively so that all behaviours are known
• For wider permission sets (for instance functionality based) we define "permission sets"

Tech design

The full scopes definition can be found here.

For us to be able to introduce more scopes that are more granular than the earlier ones, we should always consider the existing, old scope as a "permission set". So as an example, we could consider the current day "declare" scope to be an alias for all of the following:

• Create Birth Declarations Any Jurisdiction
• Create Birth Declarations Only My Jurisdiction
• Create Death Declarations Any Jurisdiction
• Create Death Declarations Only My Jurisdiction
• Create Marriage Declarations Only My Jurisdiction
• Create Marriage Declarations Any Jurisdiction
• Update Declarations
• Submit Incomplete Declarations
• Submit Declarations For Approval

const PERMISSION_SETS = {
  "declare": [
    "create-birth-declarations-any-jurisdiction",
    "create-birth-declarations-only-my-jurisdiction",
    "create-death-declarations-any-jurisdiction",
    "create-death-declarations-only-my-jurisdiction",
    "create-marriage-declarations-only-my-jurisdiction",
    "create-marriage-declarations-any-jurisdiction",
    "update-declarations",
    "submit-incomplete-declarations",
    "submit-declarations-for-approval",    
  ]
}

We support this permission set at least for a few versions until our new scope definitions have stabilised a little.

const disableDeclareButtonWhenIncomplete = hasScope(user, 'submit-incomplete-declarations')

• Ensure Custom, scope-based user roles #7053 has been merged to develop
• In commons, implement a hasScope(userScopesOrPermissionSets: string[], scope: Scope): boolean function that knows how to expand permission sets. Hardcode the first permission set to this file: declare. Notice that you might need to create other sets as part of this task, like create-birth-declaration.
• Research where the declare scope is being checked and replace those code points with more granular scope requirements.
• Implement a new user scope submit-incomplete-declaration. Make this scope control if a declaration can be sent incomplete or not

[rikukissa]

Depends on #7053

[euanmillar]

@jpye-finch if this is covered in Custom Users & Scopes, can you check? If so, please close the issue and remove it from the project. I removed it from 1.7 backlog

[jpye-finch]

closing:

scope: record.declaration-submit-incomplete - added as part of #6455