feat: Add the interface for credential status manager

[italobb]

• Adding the ICredentialStatus interface which defines the methods (and respective parameter and results) use to manage credential statuses
• Small refactor in the credentialStatus field of VCs in order to reference it in the ICredentialStatus interface
• This is the implementation for the proposal describe in [proposal] Define a credential revocation API #937

[codecov]

Codecov Report

Merging #956 (c2f8eec) into next (64f01cb) will increase coverage by 1.01%.
The diff coverage is 74.24%.

❗ Current head c2f8eec differs from pull request most recent head 3de66d6. Consider uploading reports for the commit 3de66d6 to get more accurate results

@@            Coverage Diff             @@
##             next     #956      +/-   ##
==========================================
+ Coverage   79.23%   80.24%   +1.01%     
==========================================
  Files         106      118      +12     
  Lines        3621     4050     +429     
  Branches      780      878      +98     
==========================================
+ Hits         2869     3250     +381     
- Misses        748      797      +49     
+ Partials        4        3       -1     

[mirceanis]

Thank you for adding this!

I added some notes that I'd like you to consider:

• The exported data types should be marked as @beta instead of @public
• All exported types must have a @beta marker and a tsdoc description.
• The credentialStatusRead seems un-necessary to me
• The CredentialStatusType property could remain a string IMO

I also made some suggestions about imports, comments and return types. If you accept the suggestions, the plugin schemas need to be recreated.

[mirceanis]

Generally looks good.

There are a couple typos and the plugin schema needs to be regenerated.
Please run yarn build and recommit

[mirceanis]

We will probably make some adjustments to this interface as we start integrating status methods.
It's best to be consistent with all the interface members and mark this as @beta too

[mirceanis]

@italobb I was thinking about some of the data type names we're using here.
We have the CredentialStatus data type defined in vc-data-model.ts and we also use the CredentialStatus type from the credential-status library under the name CredentialStatusVerification. It's a bit confusing, IMO.

While this feature is fresh and there are not many backward compatibility issues, what do you think about renaming some of them for a bit more clarity?

I propose naming them like this:
CredentialStatus -> CredentialStatusCoordinates for the property that gets embedded in the VC
CredentialStatusVerification -> CredentialStatus for the current status of the credential

What do you think?
(It doesn't have to be part of this PR, but I commented here because it's related to the subject)

[italobb]

@mirceanis About the data type names. After fixing the past issues, the dependency with credential-status was removed and we are only referencing the CredentialStatus from vc-data-model.ts. But I agree this confusion can come back in the future and we should open another issue to fix that. I suggest CredentialStatusReference instead of ...Coordinates.

[mirceanis]

looks good.

There's still an issue with the plugin schema for the @veramo/credential-status package which seems to be caused by the CredentialStatusVerification renamed import.

It will probably be fixed along with #981