Async listener and private channel events

kriswest commented 3 months ago

resolves #1294 resolves #1300

Makes Listener.unsubscribe() async (the return type is changed from void to Promise<void>) for consistency with the rest of the API.
Adds an async addEventListener function to the PrivateChannel API to replace the deprecated, synchronous onAddContextListener, onUnsubscribe and onDisconnect functions and to keep consistency with the DesktopAgent API.
Deprecates PrivateChannel's synchronous onAddContextListener, onUnsubscribe and onDisconnect functions in favour of an async addEventListener function consistent with the one added to DesktopAgent in #1207
Adds missing Changle log entry for #1207

See previews at:

netlify[bot] commented 3 months ago

Deploy Preview for fdc3 ready!

Name	Link
Latest commit	2ed30e60bbcee8250e2b996044e71c2f29dd34c1
Latest deploy log	https://app.netlify.com/sites/fdc3/deploys/66d9b813dbd4f100088f0f01
Deploy Preview	https://deploy-preview-1305--fdc3.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

kriswest commented 3 months ago

@Roaders @robmoffat This PR addresses the async API call issues you both raised. Let me know what you think.

robmoffat commented 3 months ago

I like what you did here to unify the event listener stuff. I guess we're committing to this for 2.2 then? We haven't actually discussed the listener changes in any meetings yet though

kriswest commented 3 months ago

no we haven't. that would need to happen at the next meeting, having the pr and docs preview in hand makes it a lot easier to show the change however!

k

Roaders commented 3 months ago

This looks good to me. I don't think that there is any easy way to test this in my local code other than building the .tgz myself and manually installing it in my project right?

kriswest commented 3 months ago

Correct. Its easy enough todo however, checkout the relevant branch, run npm run pack which will build the project and then pack the tarball for you. Then simply npm install <path to tarball> in the project where you want to use it.

kriswest commented 3 months ago

P.S. @Roaders if you try to do that with the FDC3 for Web PR, note that I haven't got around to adding BrowserTypes.to the exports in index.ts yet. It'll probably conflict with existing API exports so we'll probably need to export it as 'BrowserTypes' the same we do with BridgingTypes.

kriswest commented 3 months ago

@Roaders @bingenito @hughtroeger I'll put this on the SWG agenda to look at this week. Would love to get some reviews on it.

kriswest commented 3 months ago

Working on an update that remove the enums as then you can have a workable inheritance structure

kriswest commented 3 months ago

Updated to keep event type names style consistent (camelCase) as agreed at SWG meeting 22/08/24. Also, consent was received to make these changes once they are passed through the review of maintainers/editors.

bingenito commented 2 months ago

This did not merge well with with the .NET PR, particularly in the PrivateChannel.md file - where some work is needed from @bingenito to fill in .NET examples.

THere is also a syntax error somewhere in PrivateChannel.md that I can't find, that is preventing the site from compiling...

This was never implemented. The pending work is under #1318 to done once this is merged.

bingenito commented 2 months ago

This did not merge well with with the .NET PR, particularly in the PrivateChannel.md file - where some work is needed from @bingenito to fill in .NET examples.

THere is also a syntax error somewhere in PrivateChannel.md that I can't find, that is preventing the site from compiling...

It seems as though it is trying to transpile the markdown rather than build docs.

kriswest commented 2 months ago

This did not merge well with with the .NET PR, particularly in the PrivateChannel.md file - where some work is needed from @bingenito to fill in .NET examples. THere is also a syntax error somewhere in PrivateChannel.md that I can't find, that is preventing the site from compiling...

It seems as though it is trying to transpile the markdown rather than build docs.

Looks like it - but I think theres a syntax error somewhere that is making it think that the code block is markup it needs to process. Its fine with other code blocks on that page so it's likely a stray or missing character I'm just not seeing...

kriswest commented 2 months ago

This did not merge well with with the .NET PR, particularly in the PrivateChannel.md file - where some work is needed from @bingenito to fill in .NET examples. THere is also a syntax error somewhere in PrivateChannel.md that I can't find, that is preventing the site from compiling...

This was never implemented. The pending work is under #1318 to done once this is merged.

SHall I just go and add the tab but put Not implemented yet in it?

bingenito commented 2 months ago

Unless you think it is causing this issue I wouldn't bother as I'll do it with a PR after this merge. I think there is a different issue here perhaps with mismatched tags that I'm looking at. The syntax of that example is the same in the merged PR.

bingenito commented 2 months ago

That force push was for a git commit amend of my last commit message

kriswest commented 2 months ago

@hughtroeger no worries - thanks for getting to another one!

I spotted a syntax error (another stray space char):

Fixed, could you re-approve @hughtroeger ?

finos / FDC3