Add Alignments to Open Badges 3.0 Display

[alexfigtree]

Is your feature request related to a problem? Please describe.
Open Badges 3.0 may contain "alignments" to educational frameworks: https://www.imsglobal.org/spec/ob/v3p0#alignment

and we want to display them in the credential.

Describe the solution you'd like
The alignment object could be found in the achievement object. If found, we should display the header "Alignments" and below, list each alignment as:

targetName
<a href="targetUrl" >targetUrl</a>
targetDescription 

Notes:

• targetDescription is optional
• even though it is required, targetURL may not be present, in those cases, just display the url in regular body text.
• limit url to three lines, cutoff with an ellipsis "..." if longer than three lines.
• Other elements like: targetCode, targetFramework, and targetType can be ignored

Example of an Open Badge with Alignments:

Example of Open Badge code with alignments

{
  "@context": [
    "https://www.w3.org/ns/credentials/v2",
    "https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json"
  ],
  "id": "http://example.edu/credentials/3732",
  "type": ["VerifiableCredential", "OpenBadgeCredential"],
  "issuer": {
    "id": "https://example.edu/issuers/565049",
    "type": ["Profile"],
    "name": "Example University"
  },
  "validFrom": "2010-01-01T00:00:00Z",
  "name": "Example University Degree",
  "credentialSubject": {
    "id": "did:example:ebfeb1f712ebc6f1c276e12ec21",
    "type": ["AchievementSubject"],
    "achievement": {
      "id": "https://1edtech.edu/achievements/1",
      "type": ["Achievement"],
      "criteria": {
        "narrative": "Cite strong and thorough textual evidence to support analysis of what the text says explicitly as well as inferences drawn from the text, including determining where the text leaves matters uncertain"
      },
      "description": "Analyze a sample text",
      "name": "Text analysis",
      "alignment": [{
        "type": ["Alignment"],
        "targetCode": "ce-cf4dee18-7cea-443a-b920-158a0762c6bf",
        "targetFramework": "Edmonds College Course Catalog",
        "targetName": "Requirements Analysis",
        "targetUrl": "https://credentialfinder.org/credential/20229/Requirements_Analysis"
      },
      {
        "type": ["Alignment"],
        "targetName": "Requirements Analysis",
        "targetUrl": "https://credentialfinder.org/credential/20229/Requirements_Analysis",
        "targetDescription": "This is a description"
      }]
    }
  }
}

Related to: openwallet-foundation-labs/learner-credential-wallet#681

Acceptance Criteria

AC 1
GIVEN a credential contains an achievement.alignment array
WHEN the credential is displayed
THEN a header “Alignments” should be shown above the listed alignments.

AC 2
GIVEN an alignment includes both targetName and targetUrl
WHEN the alignment is displayed
THEN the targetName should be rendered as a clickable link pointing to targetUrl.

AC 3
GIVEN an alignment includes targetDescription
WHEN the alignment is displayed
THEN the description should appear below the targetName (or link if a targetUrl exists).

AC 4
GIVEN an alignment includes a targetName but no targetUrl
WHEN the alignment is supposed to be displayed
THEN there should be an alignment that only shows targetName

AC 5
GIVEN an alignment includes targetCode, targetFramework, or targetType
WHEN the credential is displayed
THEN these fields should be ignored (not rendered).

AC 6
GIVEN a credential has no achievement.alignment array
WHEN the credential is displayed
THEN the “Alignments” header should not appear.

AC 7
GIVEN an alignment includes a targetUrl
WHEN the alignment is displayed
THEN there should be NO clickable url if the targetUrl is not a valid URL (please use work from openwallet-foundation-labs/learner-credential-wallet#882). targetName should still be shown above targetUrl. Limit url to three lines, cutoff with an ellipsis "..." if longer than three lines.

[meghac538]

Created PR #240

I'm unable to update the issue status.

[alexfigtree]

@meghac538 That's ok, I've updated AC4 and AC7 of this ticket to reflect the latest changes on the corresponding LCW Alignment ticket (openwallet-foundation-labs/learner-credential-wallet#681)

[meghac538]

Thanks @alexfigtree noted on the updates to AC4 and AC7, I’ll review and make sure the changes align with the LCW ticket