Support push

[alagane]

Related to #33

[chibenwa]

Can I configure the JMAP types I want to receive push updates for? By passing a list of types when starting the push?

Registrating all type at once rather than one by one can be cool IMO.

Also an optional debounce at the transport level might be very handy (Eg Ensuring an initial 1 s delay before the first notification and no more than one notification every 2 seconds). Note that several StateChanges can very easily be collapsed into one.

[alagane]

If you

client.pushMailbox().subscribe();
client.pushEmailSubmission().subscribe();
client.pushEmail().subscribe();
client.pushStart();

Every types will be registered at once when pushStart is called.

[alagane]

Also an optional debounce at the transport level might be very handy (Eg Ensuring an initial 1 s delay before the first notification and no more than one notification every 2 seconds). Note that several StateChanges can very easily be collapsed into one.

If JMAP can offer a debounce parameter, why not use it yes. I don't think setting a debounce on the client is really useful though.

[chibenwa]

Every types will be registered at once when pushStart is called.

Nice, so it's doing the job.

IMO maybe the API can be refined to be friendlier but I let that to your jugement.

If JMAP can offer a debounce parameter, why not use it yes.

It does not.

I don't think setting a debounce on the client is really useful though.

I think it is useful to ensure a single client does not generate too much traffic. We then get an easy model to think about the amount of load generated by a single client.

[alagane]

Rebased on main

[qyb]

I think getApiUrl, getPushUrl, overriddenPushUrl may be useless.

[alagane]

I think getApiUrl, getPushUrl, overriddenPushUrl may be useless.

I will make another PR to remove completely the getPushUrl & getApiUrl and the overridden*Url params.

[chibenwa]

Subscribe and start are similar in semantic. I d expect only one.

Where is the callback?

Also it would imo be nice to support push notifications for arbitrary types...

[alagane]

Subscribe and start are similar in semantic. I d expect only one.

Calling pushStart then subscribe is not the same than calling subscribe then pushStart.
We can talk about a way you would like to call methods, a scenario, and what you expect to happen under the hood.

Where is the callback?

You can use a callback as parameter of the subscribe method, or you can do what you want with the mailboxObservable. See https://rxjs.dev/guide/overview

Also it would imo be nice to support push notifications for arbitrary types...

What would be the use case?

[chibenwa]

Im not sure this non standard auth sheme should ve hard coded as the default.

[alagane]

There is currently no alternative as far as I know.
I would be glad to add another way to open a websocket.

I also replaced the hard-coded url by the capability one.

[chibenwa]

Should allow passing an array

[alagane]

Since this method is private, you do not get to use it anyway.
If needed by the calling methods, the method will be modified later.

[chibenwa]

In vacation, reviewed from my phone...