feat(#9193): add functionality of getting places as pages or async iterables in cht-datasource

[sugat009]

Description

Added functionality of getting places using pages or as AsyncGenerator using cht-datasource along with the addition of REST endpoint /api/v1/person which provides people as pages.

Issues: #9239 , #9240 , #9242

Usage:

1. Pagination API

Place.v1.getPageByType(Qualifier.byContactType(placeType), cursor, limit); // limit and cursor are optional with defaults as 100 and "0" respectively

2. Async Generator API

const getAllIterator = Place.v1.getByType(ctx)(Qualifier.byContactType('place'));

3. REST API endpoint

HTTP GET api/v1/place

Query Params:

• placeType - the contact_type of the place to fetch
• limit - default is 100
• cursor - default is 0

Code review checklist

• Readable: Concise, well named, follows the style guide, documented if necessary.
• Documented: Configuration and user documentation on cht-docs
• Tested: Unit and/or e2e where appropriate

Compose URLs

If Build CI hasn't passed, these may 404:

• Core
• CouchDB Single
• CouchDB Cluster

License

The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.

[jkuester]

Looking good! I made it though all the implementation code and unit tests (just need to finish looking at the integration tests). But here are some minor comments I have so far!

[jkuester]

Thanks to the wonders of generic types, we can do something like this:

Suggested change

	export const fetchAndFilter = (
	getFunction: (limit: number, skip: number) => Promise<Nullable<Doc>[]>,
	filterFunction: (settings: SettingsService, doc: Nullable<Doc>, uuid: string | undefined) => unknown,
	settings: SettingsService,
	limit: number,
	): typeof recursionInner => {
	const recursionInner = async (
	currentLimit: number,
	currentSkip: number,
	currentDocs: Nullable<Doc>[] = [],
	): Promise<Page<unknown>> => {
	export const fetchAndFilter = <T extends Doc> (
	getFunction: (limit: number, skip: number) => Promise<Nullable<Doc>[]>,
	filterFunction: (settings: SettingsService, doc: Nullable<Doc>, uuid: string | undefined) => doc is T,
	settings: SettingsService,
	limit: number,
	): typeof recursionInner => {
	const recursionInner = async (
	currentLimit: number,
	currentSkip: number,
	currentDocs: T[] = [],
	): Promise<Page<T>> => {

And then we do not have to have the as Page<Place.v1.Place> assertions in the person/place code! The only other required change is that we update the filter call below to be explicit about the assertion: const newDocs = docs.filter((doc): doc is T => filterFunction(settings, doc, doc?._id));

[sugat009]

Although this would eliminate the use of unknown in the function, I couldn't get this to work without the as Page<Place.v1.Place> assertions because <T extends Doc> would mean they have properties from Doc but Place and Person have additional properties for which errors are thrown in other parts of the code.

[jkuester]

Very nice! This should be good to go! 🚀