adding subscriptions to web5-js

[andorsk]

initial subscriptions PR. Do NOT merge, but used for transparency to show some of the API's and interfaces design for users when using the subscriptions interface. Open for feedback and discussion. Will have some updates in the near future.

See the documentation here: https://github.com/getZION/web5-js/tree/ask/subscription/packages/api#web5dwnsubscriptioncreaterequest for intended use.

[codesandbox]

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

[andorsk]

fixing history here. Give me a sec.

[andorsk]

@finn-tbd trying to test this locally, and running into some issues due to all the updates to authorization in dwn-sdk-js at the latest. Do we have an idea of when the rest of web5-js will be up to date with the latest dwn-sdk-js? It's hard to test this PR until things have gotten more up to date with the latest.

One of many errors thrown just for additional context:

tests/record.spec.ts:466:100 - error TS2322: Type '{ recordId: string; }' is not assignable to type 'Omit<RecordsReadOptions, "authorizationSignatureInput">'.
  Object literal may only specify known properties, and 'recordId' does not exist in type 'Omit<RecordsReadOptions, "authorizationSignatureInput">'.

466       const { record: readRecord, status: readRecordStatus } = await dwn.records.read({ message: { recordId: record!.id }});
                                                                                                       ~~~~~~~~```
                                                                                                       
                                                                                                       
```sh
Found 32 errors in 4 files.

Seems like the signer updates is more or less straightforward. There are some other broken pieces though a lot more involved.

[finn-tbd]

Looks like @thehenrytsai made these changes to dwn-sdk-js. Maybe he knows the answer?

[frankhinek]

Still in Draft state. @andorsk any update on timing for this?

[andorsk]

@frankhinek haven't tested this in a while, but this was blocked by two things:

1. My notes adding subscriptions to web5-js #228 (comment). Guessing they moved since then, but I haven't checked.
2. subscription interface and event streaming for low latency push events dwn-sdk-js#508, which was kinda on hold for a bit for a number of reasons. 1) deprioritized on my end, but still want to get it done 2) it was relying on a lot of the permissions/authorization work, which was moving around a lot. Assuming that's stabilized a little more now. On a call with Liran today to discuss how to move this forward quicker. Otherwise, I can just get to this on the weekends.

[frankhinek]

@LiranCohen requested keeping open for now as a reminder to circle back and continue work

[LiranCohen]

Closing in favor of: #433