feat: support trigger events option

[Juiced66]

This PR is intended to support triggerEvents request parameter for embeded sdk.

It is unit tested and will be functionnal tested when released on kuzzle side.

A lot of doc as been realigned with code

JIRA: KZLPRD-579

[afondard]

Lgtm

[Kuruyia]

Why didn't you put this (duplicated) piece of code in the query method directly?

if (options.triggerEvents !== undefined) {
  request.triggerEvents = options.triggerEvents;
}

I see that stuff like this is already done in this method:

sdk-javascript/src/Kuzzle.ts

Lines 901 to 906 in 83e434b

	if (
	request.retryOnConflict === undefined &&
	options.retryOnConflict !== undefined
	) {
	request.retryOnConflict = options.retryOnConflict;
	}

[rolljee]

Everything look good and updated.

There is just something odd about the :any you added to the request.
Since you have the type for the KuzzleRequest isn't that possible to put the type instead of any ?

Or like Alex said, it could be possible to avoid duplication at the Kuzzle.ts file level

[Juiced66]

Why didn't you put this (duplicated) piece of code in the query method directly?

if (options.triggerEvents !== undefined) {
  request.triggerEvents = options.triggerEvents;
}

I see that stuff like this is already done in this method:

sdk-javascript/src/Kuzzle.ts

Lines 901 to 906 in 83e434b

	if (
	request.retryOnConflict === undefined &&
	options.retryOnConflict !== undefined
	) {
	request.retryOnConflict = options.retryOnConflict;
	}

I've thought about that, it was an option but not all methods got options and it could lead to useless code for those. I thought it was less readable to apply it were needed but more optimized. If we decide to apply it directly on query it is doable for sure

[Juiced66]

Everything look good and updated.

There is just something odd about the :any you added to the request. Since you have the type for the KuzzleRequest isn't that possible to put the type instead of any ?

Or like Alex said, it could be possible to avoid duplication at the Kuzzle.ts file level

There's no KuzzleRequest type in js SDK
I could use Omit<RequestPayload, "controller"> wiches weird too but maybe more acceptable. Controller is abstracted and taken from controller name and it leads to ts errors without omitting

[Juiced66]

For maintainability purpose and after doing pro and cons, I'll stick to maintainability purpose where the query solution is better than little optim nit picking.

I will refactor it

[rolljee]

LIttle UP as this need to be merged 💪🏼

[Juiced66]

will close this to open a Doc only PR