Move capabilities into own package PLZ

[Gozala]

Hey @hugomrdias I would really like to decouple iterations on protocol from iterations on access SDK etc.. can we please just move all the capability definitions into own package e.g. @web3-storage/protocol or @web3-storage/capabilities and pull those in from wherever we need.

[hugomrdias]

we can for sure, do we need to do it now though ? i would like to avoid having everyone using capabilities directly we should have an abstraction like the Agent or something else so we can make changes in the caps and backend without bringing the world

[Gozala]

I think it makes sense to have a package with basically protocols, that is capabilities and some markdowns explaining the interaction.

Those could be the pulled in by the agent / client library that our tools and libraries can depend upon. Those also could be pulled in by various service implementations.

Current setup makes iteration on the protocol somewhat coupled with iteration on the implementation and I would like to be able to decouple them a bit more

[gobengo]

I'll do this next week. Accidentally created a duplicate. Copying this description from that:

Acceptance Criteria:

• w3protocol monorepo has a new package containing just the capability objects used in the protocols
• clients like access-client import the capabilities from the capabilities package

Ideas

• Should we also split up the capabilities by service: e.g. accounts, storage, upload ?

[Gozala]

Should we also split up the capabilities by service: e.g. accounts, storage, upload ?

definitely split into separate modules, not sure separate packages are worth it, probably just going to only increase overhead right now

[gobengo]

@hugomrdias I'm assuming it's a good idea to release this to npm. I think that means I should add to this conditional to also run the release job for packages/capabilities? https://github.com/web3-storage/w3protocol/blob/191e2427529e113d67d5a6ec8ab7e7b4368b1c58/.github/workflows/release.yml#L40

[gobengo]

After merge

• ensure CI releases to npm

After release:

• ensure docs for @web3-storage/capabilities appear here https://web3-storage.github.io/w3protocol/modules.html
• ensure api docs link from packages/capabilities/readme.md works

[gobengo]

bengo@bengo ~/tmp/test-caps ⚡  node
Welcome to Node.js v18.10.0.
Type ".help" for more information.
> (await import('@web3-storage/capabilities')).Voucher.claim.invoke({ with: 'did:key:foo', nb: { product: 'did:key:foo', identity: 'mailto:[email protected]' } })
IssuedInvocation {
  issuer: undefined,
  audience: undefined,
  proofs: [],
  capabilities: [ { can: 'voucher/claim', with: 'did:key:foo', nb: [Object] } ],
  expiration: undefined,
  lifetimeInSeconds: undefined,
  notBefore: undefined,
  nonce: undefined,
  facts: []
}

[gobengo]

https://web3-storage.github.io/w3protocol/modules/_web3_storage_capabilities.html

The docs can be updated via the 'manual' github action on this repo for package=docs. (example)

For some reason the 'release' pipeline seems to skip docs job, even when it doesn't skip npm job which has the same if.

• I debugged this briefly, but noticed the same thing happened in last release of access, so I think this isn't a new issue, and we'll fix separately