Description

We want to extend the resolve query API to allow filtering, sorting and paginating CoList elements:

const Ranking = co.list(co.map({
  name: z.string(),
  score: z.number(),
  date: z.date(),
}));

Ranking.load(ranking.id, {
  resolve: {
    $where: {
      'name': 'Darts',
    },
    $orderBy: { 'score': 'desc' },
    $limit: 20,
    $offset: 40,
});

This will provide a simpler way to perform these operations and pave the way for implementing indexes. For now, we're loading all the CoList elements and performing the filter/sort/pagination operations in memory, but longer term the goal is to use indexes to avoid fetching the CoList elements.

There are some pending things to do before merging this PR:

• add support for filtering, sorting & pagination in Svelte & Vue
• migrate one or more examples to use the new APIs
• write docs

But this PR can already be reviewed.

Key design decisions

• Extended resolve query API with new options:
  • $where for filtering CoLists elements
    • Comparison operators: $eq, $ne, $gt, $gte, $lt, $lte
    • Logical operators: $and, $or, $not
  • $orderBy for sorting
  • $limit & offset for pagination
• CoLists now have an optional query view. The query view gives us a way to decouple the elements from a jazz-tools CoList from the elements in the underlying RawCoList. This means users will see only the elements returned by their resolve query, but will still be able to perform operations on the CoList that will be mapped to the underlying RawCoList.
  • The logic for creating and invalidating the query view is pretty naive, but has worked well enough on my tests. We can go with this simple implementation for now and optimize it later if needed (which may not be necessary if we end up using indexes most of the time).
• In order for pagination to work, I modified useCoState to re-create the subscription scope if the resolve query is updated

Tests

• Tests have been added and/or updated

Checklist

• I've updated the part of the docs that are affected the PR changes
• I've generated a changeset, if a version bump is required
• I've updated the jsDoc comments to the public APIs I've modified, or added them when missing