Add support for didResolutionMetadata and didDocumentMetadata

[oed]

According to did-core a resolver function should have the following abstract form:

resolve(did, resolutionOptions) →
   « didResolutionMetadata, didDocument, didDocumentMetadata »

Currently the function signature for this library looks like this:

resolve(did: string): Promise<DIDDocument>

We should introduce a breaking change that adds support for returning didResolutionMetadata and didDocumentMetadata.
It should be possible to implement this in a way in which all resolvers won't break with the new version of this package, but won't provide additional metadata until they implement the new interface.

The new function signature would look something like this:

interface ResolutionResult {
  didDocument: DIDDocument
  didResolutionMetadata: DIDResolutionMetadata
  didDocumentMetadata: DIDDocumentMetadata
}

resolve(did: string, resolutionOptions: ResolutionOptions): Promise<ResolutionResult>

[mirceanis]

Yes, thank you for flagging this!
Do you plan to contribute a PR to fix this?

[oed]

I'm planning to do that yes! :)

[oed]

To reduce complexity, ensure spec compliance and code readability, I will likely make this a breaking change without backwards compatibility. This means that all method specific resolvers would need to be changed in order to support the new version.

[mirceanis]

A breaking change is unfortunate, but if it is indeed necessary it should not be a show-stopper.
I look forward to your PR :)

Do you have an example of the change required?

[uport-automation-bot]

🎉 This issue has been resolved in version 3.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀