feat: Initial clean release of CHM

packages/lib/models/utils/paginatedFeed.ts

@@ -0,0 +1,59 @@
+import JoplinDatabase from '../../JoplinDatabase';
+import paginationToSql from './paginationToSql';
+import { Pagination, PaginationOrder } from './types';
+
+export interface ModelFeedPage {
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Heterogeneous: callers receive entity types (Note/Folder/Resource) which lack index signatures
+	items: any[];
+	has_more: boolean;
+	total?: number;
+}
+
+export interface WhereQuery {
+	sql: string;
+	params?: (string | number | boolean)[];
+}
+
+// Note: this method might return more fields than was requested as it will
+// also return fields that are necessary for pagination.
+export default async function(db: JoplinDatabase, tableName: string, pagination: Pagination, whereQuery: WhereQuery = null, fields: string[] = null): Promise<ModelFeedPage> {
+	fields = fields ? fields.slice() : ['id'];
+
+	const where = whereQuery && whereQuery.sql ? [whereQuery.sql] : [];
+	const sqlParams = whereQuery && whereQuery.params ? whereQuery.params.slice() : [];
+
+	if (!pagination.order.length) throw new Error('Pagination order must be provided');
+	if (pagination.order.length > 1) throw new Error('Only one pagination order field can be provided');
+
+	const paginationOrder = pagination.order[0].dir;
+
+	if (!pagination.order.find((o: PaginationOrder) => o.by === 'id')) {
+		pagination = {
+			...pagination,
+			order: pagination.order.concat([{
+				by: 'id',
+				dir: paginationOrder,
+				caseInsensitive: false,
+			}]),
+		};
+	}
+
+	const orderBySql = paginationToSql(pagination);
+	const fieldsSql = fields.length ? db.escapeFields(fields) : '*';
+	const offset = (pagination.page - 1) * pagination.limit;
+
+	const sql = `
+		SELECT ${fieldsSql} FROM \`${tableName}\`
+		${where.length ? `WHERE ${where.join(' AND ')}` : ''}
+		ORDER BY ${orderBySql}
+		LIMIT ${pagination.limit}
+		OFFSET ${offset}
+	`;
+
+	const rows = await db.selectAll(sql, sqlParams);
+
+	return {
+		items: rows,
+		has_more: rows.length >= pagination.limit,
+	};
+}