feat: expose detectors and separate detect and collect functions

[Le0Developer]

See #143 for motivation.

Not sure if getSources() and getDetectors() should be kept, because they are no longer used.

[xnerhu]

LGTM, but it exposes detectors publicly, so we would be obligated to keep up with backward compatibility. @r-valitov @Finesse wdyt

[Finesse]

sending the components to the server and then running detect() there

@Le0Developer Did you really try to run detect on server? As I can see, many detectors use browser APIs, which aren't available in Node.js environment. What you want to achieve requires a deeper refactoring, to make sure the detectors are pure functions (i.e. use no data other that the input arguments, and use no browser API).

Also, could you please clarify why you export detectors? It would make sense if the exported detect function accepted detectors as an argument. Such way you could detectors as a base for your custom list of detectors.

but it exposes detectors publicly, so we would be obligated to keep up with backward compatibility

@xnerhu Not necessarily. You may state in the docs that the detector list type is Record<string, (components: ComponentDict) => DetectorResponse>, and the actual list of functions is outside of version control.

[Le0Developer]

As I can see, many detectors use browser APIs, which aren't available in Node.js environment.

IIRC those mostly comprise of functions related to getting the browser kind etc, which shouldn't be hard to move.

What you want to achieve requires a deeper refactoring

Yes, which I planned to do in a later PR, so it's easier to review.

Such way you could detectors as a base for your custom list of detectors

This would require turning the components and detectors dicts into AbtractComponentDict and AbstractDetectorDict respectively, which might break typing? Will need to check. Looks it won't.

[Le0Developer]

but it exposes detectors publicly, so we would be obligated to keep up with backward compatibility

@xnerhu That whole export block is already documented as being out of semantic versioning:

BotD/src/index.ts

Lines 49 to 50 in a153850

	// The exports below are for private usage. They may change unexpectedly. Use them at your own risk.
	/** Not documented, out of Semantic Versioning, usage is at your own risk */

[Finesse]

What you want to achieve requires a deeper refactoring

Yes, which I planned to do in a later PR, so it's easier to review.

This may contradict an architectural decision made by @r-valitov and @xnerhu. The idea is to separate information sources from simple utility functions. I personally think the code state in the PR is good.

[Finesse]

LGTM. I can say it's a high-quality PR, thank you.

The project maintainers will make the final decision about the architecture changes in this PR.

[xnerhu]

Please, remove .value from enums.

[xnerhu]

Also @Le0Developer please, merge new changes from main

[xnerhu]

@Le0Developer LGTM, thank you.