feat: add credential info to access attributes

[TimoGlastra]

Fixes #190
Fixes #187

Example:

// credentialRecord.getCredentialInfo()
{
  claims: {
    name: 'Timo',
    date_of_birth: '1998-07-29',
    'country-of-residence': 'The Netherlands',
    'street name': 'Test street',
    age: '22',
  },
  metadata: {
    credentialDefinitionId: 'Th7MpTaRZVRYnPiabds81Y:3:CL:17:TAG',
    schemaId: 'TL1EaPFCZ8Si5aUrqScBDt:2:test-schema-1599055118161:1.0',
  },
}

// credentialInfo.getFormattedClaims()
{
  Age: '22',
  'Country Of Residence': 'The Netherlands',
  'Date Of Birth': '1998-07-29',
  'Street Name': 'Test street',
  Name: 'Timo',
}

const credentialInfo = credentialRecord.getCredentialInfo()
const claims = credentialInfo.claims
const formattedClaims = credentialInfo.getFormattedClaims()

[TimoGlastra]

This is dependant on #253, so once that's merged I'll rebase

[codecov-commenter]

Codecov Report

Merging #254 (b4aa1d0) into main (e07b90e) will increase coverage by 0.04%.
The diff coverage is 82.50%.

@@            Coverage Diff             @@
##             main     #254      +/-   ##
==========================================
+ Coverage   88.96%   89.01%   +0.04%     
==========================================
  Files         178      179       +1     
  Lines        3381     3422      +41     
  Branches      389      403      +14     
==========================================
+ Hits         3008     3046      +38     
- Misses        373      376       +3     

Impacted Files	Coverage Δ
src/modules/credentials/CredentialsModule.ts	85.91% <0.00%> (ø)
...c/modules/credentials/models/IndyCredentialInfo.ts	60.00% <60.00%> (ø)
.../modules/credentials/services/CredentialService.ts	85.09% <77.27%> (-0.48%)	⬇️
src/modules/credentials/CredentialUtils.ts	100.00% <100.00%> (ø)
src/modules/credentials/models/Credential.ts	75.00% <100.00%> (ø)
src/modules/credentials/models/CredentialInfo.ts	100.00% <100.00%> (+40.00%)	⬆️
src/modules/credentials/models/index.ts	100.00% <100.00%> (ø)
...modules/credentials/repository/CredentialRecord.ts	97.82% <100.00%> (+0.52%)	⬆️
src/modules/proofs/services/ProofService.ts	81.96% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e07b90e...b4aa1d0. Read the comment docs.

[jakubkoci]

I like the addition of credential preview and metadata but to be honest I don't think it's necessary to do the transformation from the array or the formatting operations. That should be the responsibility of the UI layer and not the framework. I realize that you put some effort into the implementation of these functions but maybe we could rather move them to Aries Bifold. What do you think?

From my experience from UI, you do the iteration through attributes over an array anyway:

Object.keys(attributes).map(key => <Item label={key} value={attributes[key]} />

Then it's more convenient to write:

attributes.map(attr => <Item label={attr.key} value={attr.value} />

[TimoGlastra]

I'm fine with removing the formatting stuff, not so making it an array.

An array works well for one level of nesting, not so for multiple levels (IMO). Besides the natural structure of a credential is dict like, not an array. Making it an array would tailor the structure to the UI (which is the responsibility of the UI layer as you said)

Are you okay with that?

[jakubkoci]

Yeah, of course, my point wasn't about making it array because of convenience for UI. But it makes sense to have the claims as a dict because it aligns more with the W3C spec 👍 (if I understand the spec correctly 🤷‍♂️ 😄 )

[JamesKEbert]

Thanks for your efforts here @TimoGlastra! I agree with you that keeping the existing dictionary structure allows for more flexibility with claim formats.
I also initially agree with @jakubkoci on not performing formatting at the framework layer.
Also, is there overlap we want to consider in terms of internationalization for future work here? Some relevant conversation in the Aries RFCs. Likely a separate issue, but I figure potentially worth mentioning.

[TimoGlastra]

OK. Thanks for the feedback both. Updated and ready to merge now

[jakubkoci]

Sorry I wanted to go through that yet again after rebase. Overall good, just one non-blocking note about the naming.

[jakubkoci]

It seems we could shorten credentialAttributesValues just to credentialAttributes. Does it contain a list of CredentialPreviewAttribute right? I thought that it contains just values from credential preview attributes but the call convertAttributesToValues(attributesValues) confused me a little bit. But maybe I'm missing something 🤷‍♂️

[TimoGlastra]

If we only store the values we lose the mime-types. These are not stored by indy. So you'd need to extract them from one of the exchanged messages.

I think it's a burden the mime-types are not encoded in the values itself like data:image/png;base64,xxxxxxxx, but until that's the case (which is the pattern I've seen for W3C credentials) we need to store the preview attributes.

[TimoGlastra]

But credentialAttributes sounds fine. Will update