@dxos/echo 0.8.4-main.406dc2a → 0.8.4-main.40e3dcdf1b

package/src/Order.ts

@@ -0,0 +1,46 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @import-as-namespace
+
+import { type QueryAST } from '@dxos/echo-protocol';
+
+export interface Order<T> {
+  // TODO(dmaretskyi): See new effect-schema approach to variance.
+  '~Order': { value: T };
+
+  ast: QueryAST.Order;
+}
+
+export type Any = Order<any>;
+
+class OrderClass implements Order<any> {
+  private static 'variance': Order<any>['~Order'] = {} as Order<any>['~Order'];
+
+  static is(value: unknown): value is Order<any> {
+    return typeof value === 'object' && value !== null && '~Order' in value;
+  }
+
+  constructor(public readonly ast: QueryAST.Order) {}
+
+  '~Order' = OrderClass.variance;
+}
+
+export const natural: Order<any> = new OrderClass({ kind: 'natural' });
+export const property = <T>(property: keyof T & string, direction: QueryAST.OrderDirection): Order<T> =>
+  new OrderClass({
+    kind: 'property',
+    property,
+    direction,
+  });
+
+/**
+ * Order by relevance rank (for FTS/vector search results).
+ * Higher rank = better match. Default direction is 'desc' (best matches first).
+ */
+export const rank = <T>(direction: QueryAST.OrderDirection = 'desc'): Order<T> =>
+  new OrderClass({
+    kind: 'rank',
+    direction,
+  });

package/src/Query.test.ts

@@ -0,0 +1,632 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+import { describe, expect, test } from 'vitest';
+
+import { QueryAST } from '@dxos/echo-protocol';
+import { DXN } from '@dxos/keys';
+import { log } from '@dxos/log';
+
+import * as Dataset from './Dataset';
+import * as Feed from './Feed';
+import * as Filter from './Filter';
+import * as Obj from './Obj';
+import * as Order from './Order';
+import * as Query from './Query';
+import * as Ref from './Ref';
+import { TestSchema } from './testing';
+
+describe('query api', () => {
+  describe('Query', () => {
+    test('get all people', () => {
+      const getAllPeople = Query.type(TestSchema.Person);
+
+      log('query', { ast: getAllPeople.ast });
+      Schema.validateSync(QueryAST.Query)(getAllPeople.ast);
+      log('getAllPeople', { ast: getAllPeople.ast });
+    });
+
+    test('get all people ordered by name', () => {
+      const getAllPeopleOrderedByName = Query.type(TestSchema.Person).orderBy(Order.property('name', 'asc'));
+
+      log('query', { ast: getAllPeopleOrderedByName.ast });
+      Schema.validateSync(QueryAST.Query)(getAllPeopleOrderedByName.ast);
+      log('getAllPeopleOrderedByName', { ast: getAllPeopleOrderedByName.ast });
+    });
+
+    test('get all people named Fred', () => {
+      const PeopleNamedFred = Query.select(Filter.type(TestSchema.Person, { name: 'Fred' }));
+
+      log('query', { ast: PeopleNamedFred.ast });
+      Schema.validateSync(QueryAST.Query)(PeopleNamedFred.ast);
+      log('PeopleNamedFred', { ast: PeopleNamedFred.ast });
+    });
+
+    test('get all people with field of "label" set to "Research"', () => {
+      const PeopleWithFieldLabelSetToResearch = Query.select(
+        Filter.type(TestSchema.Person, { fields: Filter.contains({ label: 'label', value: 'Research' }) }),
+      );
+
+      log('query', { ast: PeopleWithFieldLabelSetToResearch.ast });
+      Schema.validateSync(QueryAST.Query)(PeopleWithFieldLabelSetToResearch.ast);
+      log('PeopleWithFieldLabelSetToResearch', { ast: PeopleWithFieldLabelSetToResearch.ast });
+    });
+
+    test('get all orgs with property "label" set to "Research"', () => {
+      const OrgsWithPropertyLabelSetToResearch = Query.select(
+        Filter.type(TestSchema.Organization, { properties: { label: 'Research' } }),
+      );
+
+      log('query', { ast: OrgsWithPropertyLabelSetToResearch.ast });
+      Schema.validateSync(QueryAST.Query)(OrgsWithPropertyLabelSetToResearch.ast);
+      log('OrgsWithPropertyLabelSetToResearch', { ast: OrgsWithPropertyLabelSetToResearch.ast });
+    });
+
+    test('get all orgs Fred worked for since 2020', () => {
+      const fred = Obj.make(TestSchema.Person, { name: 'Fred' });
+      const OrganizationsFredWorkedForSince2020 = Query.select(Filter.type(TestSchema.Person, { id: fred.id }))
+        .sourceOf(TestSchema.EmployedBy, { since: Filter.gt('2020') })
+        .target();
+
+      log('query', { ast: OrganizationsFredWorkedForSince2020.ast });
+      Schema.validateSync(QueryAST.Query)(OrganizationsFredWorkedForSince2020.ast);
+      log('OrganizationsFredWorkedForSince2020', { ast: OrganizationsFredWorkedForSince2020.ast });
+    });
+
+    test('get all tasks for Fred', () => {
+      const fred = Obj.make(TestSchema.Person, { name: 'Fred' });
+      const TasksForFred = Query.select(Filter.type(TestSchema.Person, { id: fred.id })).referencedBy(
+        TestSchema.Task,
+        'assignee',
+      );
+
+      log('query', { ast: TasksForFred.ast });
+      Schema.validateSync(QueryAST.Query)(TasksForFred.ast);
+      log('TasksForFred', { ast: TasksForFred.ast });
+    });
+
+    test('get all objects referencing Fred (any type, specified property)', () => {
+      const fred = Obj.make(TestSchema.Person, { name: 'Fred' });
+      const ObjectsReferencingFred = Query.select(Filter.type(TestSchema.Person, { id: fred.id })).referencedBy(
+        TestSchema.Task,
+      );
+
+      log('query', { ast: ObjectsReferencingFred.ast });
+      Schema.validateSync(QueryAST.Query)(ObjectsReferencingFred.ast);
+      expect(ObjectsReferencingFred.ast).toMatchObject({
+        type: 'incoming-references',
+        property: null,
+        typename: 'dxn:type:com.example.type.task:0.1.0',
+      });
+    });
+
+    test('get all objects referencing Fred (any type, any property)', () => {
+      const fred = Obj.make(TestSchema.Person, { name: 'Fred' });
+      const AllBacklinks = Query.select(Filter.type(TestSchema.Person, { id: fred.id })).referencedBy();
+
+      log('query', { ast: AllBacklinks.ast });
+      Schema.validateSync(QueryAST.Query)(AllBacklinks.ast);
+      expect(AllBacklinks.ast).toMatchObject({
+        type: 'incoming-references',
+        property: null,
+        typename: null,
+      });
+    });
+
+    test('get all tasks for employees of Cyberdyne', () => {
+      const TasksForEmployeesOfCyberdyne = Query.select(Filter.type(TestSchema.Organization, { name: 'Cyberdyne' }))
+        .targetOf(TestSchema.EmployedBy)
+        .source()
+        .referencedBy(TestSchema.Task, 'assignee');
+
+      log('query', { ast: TasksForEmployeesOfCyberdyne.ast });
+      Schema.validateSync(QueryAST.Query)(TasksForEmployeesOfCyberdyne.ast);
+      log('TasksForEmployeesOfCyberdyne', { ast: TasksForEmployeesOfCyberdyne.ast });
+    });
+
+    test('get all people or orgs', () => {
+      const PeopleOrOrganizations = Query.all(
+        Query.select(Filter.type(TestSchema.Person)),
+        Query.select(Filter.type(TestSchema.Organization)),
+      );
+
+      log('query', { ast: PeopleOrOrganizations.ast });
+      Schema.validateSync(QueryAST.Query)(PeopleOrOrganizations.ast);
+      log('PeopleOrOrganizations', { ast: PeopleOrOrganizations.ast });
+    });
+
+    test('Filter.query(Dataset.Dataset) (union of schemas)', () => {
+      const AllDatasets = Query.select(Filter.type(Dataset.Dataset));
+
+      log('query', { ast: AllDatasets.ast });
+      Schema.validateSync(QueryAST.Query)(AllDatasets.ast);
+      log('AllDatasets', { ast: AllDatasets.ast });
+      expect(AllDatasets.ast).toMatchInlineSnapshot(`
+        {
+          "filter": {
+            "filters": [
+              {
+                "props": {},
+                "type": "object",
+                "typename": "dxn:type:org.dxos.type.feed:0.1.0",
+              },
+              {
+                "props": {},
+                "type": "object",
+                "typename": "dxn:type:org.dxos.type.collection:0.1.0",
+              },
+              {
+                "props": {},
+                "type": "object",
+                "typename": "dxn:type:org.dxos.type.view:0.1.0",
+              },
+            ],
+            "type": "or",
+          },
+          "type": "select",
+        }
+      `);
+    });
+
+    test('Query.type(Dataset.Dataset) (union of schemas)', () => {
+      const AllDatasets = Query.type(Dataset.Dataset);
+
+      log('query', { ast: AllDatasets.ast });
+      Schema.validateSync(QueryAST.Query)(AllDatasets.ast);
+      log('AllDatasets', { ast: AllDatasets.ast });
+      expect(AllDatasets.ast).toMatchInlineSnapshot(`
+        {
+          "filter": {
+            "filters": [
+              {
+                "props": {},
+                "type": "object",
+                "typename": "dxn:type:org.dxos.type.feed:0.1.0",
+              },
+              {
+                "props": {},
+                "type": "object",
+                "typename": "dxn:type:org.dxos.type.collection:0.1.0",
+              },
+              {
+                "props": {},
+                "type": "object",
+                "typename": "dxn:type:org.dxos.type.view:0.1.0",
+              },
+            ],
+            "type": "or",
+          },
+          "type": "select",
+        }
+      `);
+    });
+
+    test('get all people not in orgs', () => {
+      const PeopleNotInOrganizations = Query.without(
+        Query.select(Filter.type(TestSchema.Person)),
+        Query.select(Filter.type(TestSchema.Person)).sourceOf(TestSchema.EmployedBy).source(),
+      );
+
+      log('query', { ast: PeopleNotInOrganizations.ast });
+      Schema.validateSync(QueryAST.Query)(PeopleNotInOrganizations.ast);
+      log('PeopleNotInOrganizations', { ast: PeopleNotInOrganizations.ast });
+    });
+
+    test('get assignees of all tasks created after 2020', () => {
+      const AssigneesOfAllTasksCreatedAfter2020 = Query.select(
+        Filter.type(TestSchema.Task, { deadline: Filter.gt('2020') }),
+      ).reference('assignee');
+
+      log('query', { ast: AssigneesOfAllTasksCreatedAfter2020.ast });
+      Schema.validateSync(QueryAST.Query)(AssigneesOfAllTasksCreatedAfter2020.ast);
+      log('AssigneesOfAllTasksCreatedAfter2020', { ast: AssigneesOfAllTasksCreatedAfter2020.ast });
+    });
+
+    test('untyped full-text search', () => {
+      const contactFullTextSearch = Query.select(Filter.text('Bill'));
+
+      log('query', { ast: contactFullTextSearch.ast });
+      Schema.validateSync(QueryAST.Query)(contactFullTextSearch.ast);
+      expect(contactFullTextSearch.ast).toMatchInlineSnapshot(`
+      {
+        "filter": {
+          "searchKind": undefined,
+          "text": "Bill",
+          "type": "text-search",
+        },
+        "type": "select",
+      }
+    `);
+    });
+
+    test('typed full-text search', () => {
+      const contactFullTextSearch = Query.select(Filter.type(TestSchema.Person)).select(Filter.text('Bill'));
+
+      log('query', { ast: contactFullTextSearch.ast });
+      Schema.validateSync(QueryAST.Query)(contactFullTextSearch.ast);
+      expect(contactFullTextSearch.ast).toMatchInlineSnapshot(`
+      {
+        "filter": {
+          "searchKind": undefined,
+          "text": "Bill",
+          "type": "text-search",
+        },
+        "selection": {
+          "filter": {
+            "id": undefined,
+            "props": {},
+            "type": "object",
+            "typename": "dxn:type:com.example.type.person:0.1.0",
+          },
+          "type": "select",
+        },
+        "type": "filter",
+      }
+    `);
+    });
+
+    test('filter by ref', () => {
+      const fred = Obj.make(TestSchema.Person, { name: 'Fred' });
+      const tasksByFred = Filter.type(TestSchema.Task, { assignee: Ref.make(fred) });
+      expect(tasksByFred.ast).toEqual({
+        props: {
+          assignee: {
+            operator: 'eq',
+            type: 'compare',
+            value: {
+              '/': DXN.fromLocalObjectId(fred.id).toString(),
+            },
+          },
+        },
+        type: 'object',
+        typename: 'dxn:type:com.example.type.task:0.1.0',
+      });
+      log('tasksByFred', { ast: tasksByFred.ast });
+    });
+
+    test('select orgs and people', () => {
+      const orgsAndPeople = Query.select(
+        Filter.or(Filter.type(TestSchema.Organization), Filter.type(TestSchema.Person)),
+      );
+
+      Schema.validateSync(QueryAST.Query)(orgsAndPeople.ast);
+      expect(orgsAndPeople.ast).toMatchInlineSnapshot(`
+      {
+        "filter": {
+          "filters": [
+            {
+              "id": undefined,
+              "props": {},
+              "type": "object",
+              "typename": "dxn:type:com.example.type.organization:0.1.0",
+            },
+            {
+              "id": undefined,
+              "props": {},
+              "type": "object",
+              "typename": "dxn:type:com.example.type.person:0.1.0",
+            },
+          ],
+          "type": "or",
+        },
+        "type": "select",
+      }
+    `);
+    });
+
+    test('select everything but orgs and people', () => {
+      const everythingButOrgsAndPeople = Query.select(
+        Filter.not(Filter.or(Filter.type(TestSchema.Organization), Filter.type(TestSchema.Person))),
+      );
+
+      Schema.validateSync(QueryAST.Query)(everythingButOrgsAndPeople.ast);
+      expect(everythingButOrgsAndPeople.ast).toMatchInlineSnapshot(`
+      {
+        "filter": {
+          "filter": {
+            "filters": [
+              {
+                "id": undefined,
+                "props": {},
+                "type": "object",
+                "typename": "dxn:type:com.example.type.organization:0.1.0",
+              },
+              {
+                "id": undefined,
+                "props": {},
+                "type": "object",
+                "typename": "dxn:type:com.example.type.person:0.1.0",
+              },
+            ],
+            "type": "or",
+          },
+          "type": "not",
+        },
+        "type": "select",
+      }
+    `);
+    });
+
+    test('select deleted tasks', () => {
+      const deletedTasks = Query.select(Filter.type(TestSchema.Task)).options({
+        deleted: 'only',
+      });
+
+      Schema.validateSync(QueryAST.Query)(deletedTasks.ast);
+      expect(deletedTasks.ast).toMatchInlineSnapshot(`
+      {
+        "options": {
+          "deleted": "only",
+        },
+        "query": {
+          "filter": {
+            "id": undefined,
+            "props": {},
+            "type": "object",
+            "typename": "dxn:type:com.example.type.task:0.1.0",
+          },
+          "type": "select",
+        },
+        "type": "options",
+      }
+    `);
+    });
+
+    test('filter by tags', () => {
+      const query = Query.select(Filter.type(TestSchema.Task)).select(Filter.tag('important'));
+      Schema.validateSync(QueryAST.Query)(query.ast);
+      expect(query.ast).toMatchInlineSnapshot(`
+        {
+          "filter": {
+            "tag": "important",
+            "type": "tag",
+          },
+          "selection": {
+            "filter": {
+              "id": undefined,
+              "props": {},
+              "type": "object",
+              "typename": "dxn:type:com.example.type.task:0.1.0",
+            },
+            "type": "select",
+          },
+          "type": "filter",
+        }
+      `);
+    });
+
+    test('limit results', () => {
+      const query = Query.select(Filter.type(TestSchema.Task)).limit(10);
+      Schema.validateSync(QueryAST.Query)(query.ast);
+      expect(query.ast).toMatchInlineSnapshot(`
+        {
+          "limit": 10,
+          "query": {
+            "filter": {
+              "id": undefined,
+              "props": {},
+              "type": "object",
+              "typename": "dxn:type:com.example.type.task:0.1.0",
+            },
+            "type": "select",
+          },
+          "type": "limit",
+        }
+      `);
+    });
+
+    test('ordered and limited results', () => {
+      const query = Query.select(Filter.type(TestSchema.Task)).orderBy(Order.property('title', 'asc')).limit(10);
+      Schema.validateSync(QueryAST.Query)(query.ast);
+      expect(query.ast).toMatchInlineSnapshot(`
+        {
+          "limit": 10,
+          "query": {
+            "order": [
+              {
+                "direction": "asc",
+                "kind": "property",
+                "property": "title",
+              },
+            ],
+            "query": {
+              "filter": {
+                "id": undefined,
+                "props": {},
+                "type": "object",
+                "typename": "dxn:type:com.example.type.task:0.1.0",
+              },
+              "type": "select",
+            },
+            "type": "order",
+          },
+          "type": "limit",
+        }
+      `);
+    });
+
+    test('union of limited queries', () => {
+      const query = Query.all(
+        Query.select(Filter.type(TestSchema.Person)).limit(5),
+        Query.select(Filter.type(TestSchema.Organization)).limit(5),
+      );
+      Schema.validateSync(QueryAST.Query)(query.ast);
+      expect(query.ast).toMatchInlineSnapshot(`
+        {
+          "queries": [
+            {
+              "limit": 5,
+              "query": {
+                "filter": {
+                  "id": undefined,
+                  "props": {},
+                  "type": "object",
+                  "typename": "dxn:type:com.example.type.person:0.1.0",
+                },
+                "type": "select",
+              },
+              "type": "limit",
+            },
+            {
+              "limit": 5,
+              "query": {
+                "filter": {
+                  "id": undefined,
+                  "props": {},
+                  "type": "object",
+                  "typename": "dxn:type:com.example.type.organization:0.1.0",
+                },
+                "type": "select",
+              },
+              "type": "limit",
+            },
+          ],
+          "type": "union",
+        }
+      `);
+    });
+
+    test('from all accessible spaces', () => {
+      const query = Query.select(Filter.type(TestSchema.Person)).from('all-accessible-spaces');
+
+      Schema.validateSync(QueryAST.Query)(query.ast);
+      expect(query.ast).toMatchInlineSnapshot(`
+        {
+          "from": {
+            "_tag": "scope",
+            "scope": {},
+          },
+          "query": {
+            "filter": {
+              "id": undefined,
+              "props": {},
+              "type": "object",
+              "typename": "dxn:type:com.example.type.person:0.1.0",
+            },
+            "type": "select",
+          },
+          "type": "from",
+        }
+      `);
+    });
+
+    test('from all accessible spaces with feeds', () => {
+      const query = Query.select(Filter.type(TestSchema.Person)).from('all-accessible-spaces', {
+        includeFeeds: true,
+      });
+
+      Schema.validateSync(QueryAST.Query)(query.ast);
+      expect(query.ast).toMatchInlineSnapshot(`
+        {
+          "from": {
+            "_tag": "scope",
+            "scope": {
+              "allQueuesFromSpaces": true,
+            },
+          },
+          "query": {
+            "filter": {
+              "id": undefined,
+              "props": {},
+              "type": "object",
+              "typename": "dxn:type:com.example.type.person:0.1.0",
+            },
+            "type": "select",
+          },
+          "type": "from",
+        }
+      `);
+    });
+
+    test('from all accessible spaces with ordering and limit', () => {
+      const query = Query.select(Filter.type(TestSchema.Person))
+        .orderBy(Order.property('name', 'asc'))
+        .limit(10)
+        .from('all-accessible-spaces');
+
+      Schema.validateSync(QueryAST.Query)(query.ast);
+      expect(query.ast).toMatchObject({
+        type: 'from',
+        from: { _tag: 'scope', scope: {} },
+        query: {
+          type: 'limit',
+          limit: 10,
+          query: {
+            type: 'order',
+          },
+        },
+      });
+    });
+
+    test('Query.type(...).from(feed) sets queue scope', () => {
+      const feed = Feed.make({ name: 'test-feed' });
+      const queueDxn = DXN.parse('dxn:echo:test-space:test-queue');
+      Obj.change(feed, (mutable) => {
+        Obj.getMeta(mutable).keys.push({ source: Feed.DXN_KEY, id: queueDxn.toString() });
+      });
+
+      const query = Query.type(TestSchema.Person).from(feed);
+      Schema.validateSync(QueryAST.Query)(query.ast);
+      expect(query.ast).toMatchObject({
+        type: 'from',
+        from: {
+          _tag: 'scope',
+          scope: {
+            queues: [queueDxn.toString()],
+          },
+        },
+        query: {
+          type: 'select',
+          filter: {
+            type: 'object',
+            typename: 'dxn:type:com.example.type.person:0.1.0',
+          },
+        },
+      });
+    });
+
+    test.skip('chain', () => {
+      // NOTE: Can't support props without type since they can't be inferred.
+      // const f1: Filter<Person> = Filter.props({ name: 'Fred' });
+
+      // const x = Query.select(Filter.props({ id: '123' }));
+      const y = Query.select(Filter.type(TestSchema.Person));
+
+      const or = Filter.or(
+        Filter.type(TestSchema.Person, { id: Filter.in('1', '2', '3') }),
+        Filter.type(TestSchema.Organization),
+      );
+
+      const and = Filter.and(
+        Filter.type(TestSchema.Person, { id: Filter.in('1', '2', '3') }),
+        Filter.type(TestSchema.Person, { name: 'Fred' }),
+      );
+
+      const q = Query
+        //
+        // NOTE: Can't support functions since they can't be serialized (to server).
+        // .filter((object) => Math.random() > 0.5)
+        .select(Filter.type(TestSchema.Person))
+        .select(Filter.type(TestSchema.Person, { name: 'Fred' }))
+        .select({ age: Filter.between(20, 40) })
+        .select(
+          Filter.and(
+            Filter.type(TestSchema.Person),
+            Filter.type(TestSchema.Person, { name: Filter.in('bob', 'bill') }),
+          ),
+        );
+
+      log('stuff', { fOr: or, fAnd: and, q, y });
+    });
+  });
+
+  describe('Filter', () => {
+    test('Filter.or(Filter.typename(...))', () => {
+      const filter = Filter.or(Filter.typename('com.example.type.person'));
+      // TODO(dmaretskyi): Give vitest type-tests a try.
+      const _isAssignable: Obj.Unknown = null as any as Filter.Type<typeof filter>;
+    });
+  });
+});