ceramicnetwork / js-did

A simple interface to interact with DIDs that conform to the DID-provider interface.
Other
95 stars 28 forks source link

Shared codecs package #153

Closed PaulLeCam closed 1 year ago

PaulLeCam commented 1 year ago

In line with starting to use codecs in js-ceramic, I think it would be useful to have a codecs package for the DIDs structures, that could also be used in the js-ceramic codecs package considering the overlaps for some types.

~Opening as draft to start the discussion, but will need more tests and docs.~

~@ukstv it seems there is a conflict with using both type and namespace for the Cacao export, any idea how to address this please? If not, I think I'll rename the type to CacaoType to avoid the conflict, what do you think please?~

PaulLeCam commented 1 year ago

@zachferland if it looks OK to you do you mind if I publish the new package once the PR is merged please? I'd like to use it in the new @ceramicnetwork/codecs package to avoid duplicating the codecs, cc @ukstv

PaulLeCam commented 1 year ago

Good question about the return types, I'm not sure what the behavior will be so should be safer to use major versions increases.

zachferland commented 1 year ago

thanks for adding changesets! want to update the release section here? https://github.com/ceramicnetwork/js-did/blob/main/DEVELOPMENT.md

PaulLeCam commented 1 year ago

thanks for adding changesets! want to update the release section here? https://github.com/ceramicnetwork/js-did/blob/main/DEVELOPMENT.md

Yes good call, I will do it on Monday!

PaulLeCam commented 1 year ago

@zachferland I updated the instructions, can you have a look please?