@dxos/echo 0.8.2-main.2f9c567 → 0.8.2-main.30e4dbb

package/src/query/query.test.ts

@@ -0,0 +1,146 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Schema } from 'effect';
+import { describe, test } from 'vitest';
+
+import { create } from '@dxos/echo-schema';
+import { log } from '@dxos/log';
+
+import { Filter, Query } from './api';
+import * as QueryAST from './ast';
+import { Type, Relation } from '..';
+
+//
+// Example schema
+//
+
+const Person = Schema.Struct({
+  name: Schema.String,
+  email: Schema.optional(Schema.String),
+  age: Schema.optional(Schema.Number),
+}).pipe(Type.def({ typename: 'dxos.org/type/Person', version: '0.1.0' }));
+interface Person extends Schema.Schema.Type<typeof Person> {}
+
+const Org = Schema.Struct({
+  name: Schema.String,
+}).pipe(Type.def({ typename: 'dxos.org/type/Org', version: '0.1.0' }));
+interface Org extends Schema.Schema.Type<typeof Org> {}
+
+const WorksFor = Schema.Struct({
+  since: Schema.String,
+}).pipe(Relation.def({ typename: 'dxos.org/type/WorksFor', version: '0.1.0', source: Person, target: Org }));
+interface WorksFor extends Schema.Schema.Type<typeof WorksFor> {}
+
+const Task = Schema.Struct({
+  title: Schema.String,
+  createdAt: Schema.String,
+  assignee: Type.Ref(Person),
+}).pipe(Type.def({ typename: 'dxos.org/type/Task', version: '0.1.0' }));
+interface Task extends Schema.Schema.Type<typeof Task> {}
+
+//
+// Example queries
+//
+
+describe('query api', () => {
+  test('get all people', () => {
+    // Query<Person>
+    const getAllPeople = Query.type(Person);
+
+    log.info('query', { ast: getAllPeople.ast });
+    Schema.validateSync(QueryAST.Query)(getAllPeople.ast);
+  });
+
+  test('get all people named Fred', () => {
+    // Query<Person>
+    const getAllPeopleNamedFred = Query.select(Filter.type(Person, { name: 'Fred' }));
+
+    log.info('query', { ast: getAllPeopleNamedFred.ast });
+    Schema.validateSync(QueryAST.Query)(getAllPeopleNamedFred.ast);
+  });
+
+  test('get all orgs Fred worked for since 2020', () => {
+    // Query<Org>
+    const fred = create(Person, { name: 'Fred' });
+    const getAllOrgsFredWorkedForSince2020 = Query.select(Filter.type(Person, { id: fred.id }))
+      .sourceOf(WorksFor, { since: Filter.gt('2020') })
+      .target();
+
+    log.info('query', { ast: getAllOrgsFredWorkedForSince2020.ast });
+    Schema.validateSync(QueryAST.Query)(getAllOrgsFredWorkedForSince2020.ast);
+  });
+
+  test('get all tasks for Fred', () => {
+    // Query<Task>
+    const fred = create(Person, { name: 'Fred' });
+    const getAllTasksForFred = Query.select(Filter.type(Person, { id: fred.id })).referencedBy(Task, 'assignee');
+
+    log.info('query', { ast: getAllTasksForFred.ast });
+    Schema.validateSync(QueryAST.Query)(getAllTasksForFred.ast);
+  });
+
+  test('get all tasks for employees of Cyberdyne', () => {
+    // Query<Task>
+    const allTasksForEmployeesOfCyberdyne = Query.select(Filter.type(Org, { name: 'Cyberdyne' }))
+      .targetOf(WorksFor)
+      .source()
+      .referencedBy(Task, 'assignee');
+
+    log.info('query', { ast: allTasksForEmployeesOfCyberdyne.ast });
+    Schema.validateSync(QueryAST.Query)(allTasksForEmployeesOfCyberdyne.ast);
+  });
+
+  test('get all people or orgs', () => {
+    // Query<Person | Org>
+    const allPeopleOrOrgs = Query.all(Query.select(Filter.type(Person)), Query.select(Filter.type(Org)));
+
+    log.info('query', { ast: allPeopleOrOrgs.ast });
+    Schema.validateSync(QueryAST.Query)(allPeopleOrOrgs.ast);
+  });
+
+  test('get assignees of all tasks created after 2020', () => {
+    // Query<Person>
+    const assigneesOfAllTasksCreatedAfter2020 = Query.select(
+      Filter.type(Task, { createdAt: Filter.gt('2020') }),
+    ).reference('assignee');
+
+    log.info('query', { ast: assigneesOfAllTasksCreatedAfter2020.ast });
+    Schema.validateSync(QueryAST.Query)(assigneesOfAllTasksCreatedAfter2020.ast);
+  });
+
+  test('contact full-text search', () => {
+    // Query<Person>
+    const contactFullTextSearch = Query.select(Filter.text(Person, 'Bill'));
+
+    log.info('query', { ast: contactFullTextSearch.ast });
+    Schema.validateSync(QueryAST.Query)(contactFullTextSearch.ast);
+  });
+
+  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(Person));
+
+    const fOr = Filter.or(Filter.type(Person, { id: Filter.in('1', '2', '3') }), Filter.type(Org));
+
+    const fAnd = Filter.and(
+      Filter.type(Person, { id: Filter.in('1', '2', '3') }),
+      Filter.type(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(Person))
+      .select(Filter.type(Person, { name: 'Fred' }))
+      .select({ age: Filter.between(20, 40) })
+      .select(Filter.and(Filter.type(Person), Filter.type(Person, { name: Filter.in('bob', 'bill') })));
+
+    log.info('stuff', { fOr, fAnd, q, y });
+  });
+});

package/src/type/Relation.ts

@@ -0,0 +1,17 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { EchoRelation, type RelationSourceTargetRefs } from '@dxos/echo-schema';
+
+export const def = EchoRelation;
+
+/**
+ * Get relation target type.
+ */
+export type Target<A> = A extends RelationSourceTargetRefs<infer T, infer _S> ? T : never;
+
+/**
+ * Get relation source type.
+ */
+export type Source<A> = A extends RelationSourceTargetRefs<infer _T, infer S> ? S : never;

package/src/{api.test.ts → type/Type.test.ts}

@@ -8,7 +8,7 @@ import { describe, test } from 'vitest';
 import { raise } from '@dxos/debug';
 import { FormatEnum, FormatAnnotation } from '@dxos/echo-schema';
 
-import { Type } from './api';
+import { Type } from './Type';
 
 namespace Testing {
   export const Organization = Schema.Struct({
@@ -37,14 +37,25 @@ namespace Testing {
 
   export interface Person extends Schema.Schema.Type<typeof Person> {}
 
-  export const Message = Schema.Struct({
-    // TODO(burdon): Support S.Date; Custom Timestamp (with defaults).
-    // TODO(burdon): Support defaults (update create and create).
-    timestamp: Schema.String.pipe(
-      Schema.propertySignature,
-      Schema.withConstructorDefault(() => new Date().toISOString()),
-    ),
-  });
+  // export const WorksFor = S.Struct({
+  //   id: Type.ObjectId,
+  //   since: S.String,
+  //   jobTitle: S.String,
+  //   ...Range({ from, to }),
+  //   ...Provenance({ source: 'duckduckgo.com', confidence: 0.9 }), // keys
+  //   ...Relation.make({ source: Contact, target: Organization }),
+  // }).pipe(
+  //   Relation.def({
+  //     typename: 'example.com/relation/WorksFor',
+  //     version: '0.1.0',
+  //   }),
+  // );
+
+  // {
+  //   const contact = db.add(create(Contact, { name: 'Test' }));
+  //   const organization = db.add(create(Organization, { name: 'DXOS' }));
+  //   db.add(create(WorksFor, { source: contact, target: organization }));
+  // }
 
   export const WorksFor = Schema.Struct({
     // id: Type.ObjectId,
@@ -61,13 +72,23 @@ namespace Testing {
 
   export interface WorksFor extends Schema.Schema.Type<typeof WorksFor> {}
 
-  // TODO(burdon): Fix (Type.def currently removes TypeLiteral that implements the `make` function)..
-  // }).pipe(
-  //   Type.def({
-  //     typename: 'example.com/type/Message',
-  //     version: '0.1.0',
-  //   }),
-  // );
+  // TODO(burdon): Fix (Type.def currently removes TypeLiteral that implements the `make` function).
+  //  Property 'make' does not exist on type 'EchoObjectSchema<Struct<{ timestamp: PropertySignature<":", string, never, ":", string, true, never>; }>>'.ts(2339)
+  export const MessageStruct = Schema.Struct({
+    // TODO(burdon): Support S.Date; Custom Timestamp (with defaults).
+    // TODO(burdon): Support defaults (update create and create).
+    timestamp: Schema.String.pipe(
+      Schema.propertySignature,
+      Schema.withConstructorDefault(() => new Date().toISOString()),
+    ),
+  });
+
+  export const Message = MessageStruct.pipe(
+    Type.def({
+      typename: 'example.com/type/Message',
+      version: '0.1.0',
+    }),
+  );
 
   export interface Message extends Schema.Schema.Type<typeof Message> {}
 }
@@ -98,9 +119,7 @@ describe('Experimental API review', () => {
   });
 
   test('default props', ({ expect }) => {
-    // TODO(burdon): Doesn't work after pipe(Type.def).
-    // Property 'make' does not exist on type 'EchoObjectSchema<Struct<{ timestamp: PropertySignature<":", string, never, ":", string, true, never>; }>>'.ts(2339)
-    const message = Type.create(Testing.Message, Testing.Message.make({}));
+    const message = Type.create(Testing.Message, Testing.MessageStruct.make({}));
     expect(message.timestamp).to.exist;
   });
 });

package/src/{api/type.ts → type/Type.ts}

@@ -32,7 +32,7 @@ import { invariant } from '@dxos/invariant';
 import { SpaceId as SpaceId$ } from '@dxos/keys';
 import { live as live$ } from '@dxos/live-object';
 
-// TODO(burdon): Type vs. Relation vs. Object.
+// TODO(burdon): Type vs. Ref vs. Relation vs. Object.
 
 /**
  * Type System API.

package/src/type/index.ts

@@ -0,0 +1,6 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export { Type } from './Type';
+export * as Relation from './Relation';

package/dist/types/src/api/database.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"database.d.ts","sourceRoot":"","sources":["../../../../src/api/database.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,yBAAiB,QAAQ,CAAC,GAAE"}

package/dist/types/src/api/index.d.ts

@@ -1,4 +0,0 @@
-export { Format } from '@dxos/echo-schema';
-export { DXN } from '@dxos/keys';
-export { Type } from './type';
-//# sourceMappingURL=index.d.ts.map

package/dist/types/src/api/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAMjC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC"}

package/dist/types/src/api/queue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"queue.d.ts","sourceRoot":"","sources":["../../../../src/api/queue.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,yBAAiB,KAAK,CAAC,GAAE"}

package/dist/types/src/api/space.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"space.d.ts","sourceRoot":"","sources":["../../../../src/api/space.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC,GAAE"}

package/dist/types/src/api/type.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../../../src/api/type.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErC,OAAO,EAAE,KAAK,aAAa,IAAI,cAAc,EAAE,MAAM,eAAe,CAAC;AACrE,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,UAAU,EAEf,UAAU,EACV,OAAO,IAAI,QAAQ,EACnB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,QAAQ,IAAI,SAAS,EACrB,GAAG,IAAI,IAAI,EAEX,KAAK,YAAY,EACjB,KAAK,QAAQ,EAQd,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AAKjD;;;;;GAKG;AACH,yBAAiB,IAAI,CAAC;IAKb,MAAM,aAAa,wCAAiB,CAAC;IACrC,MAAM,OAAO;;;;;;MAAW,CAAC;IAChC,KAAY,OAAO,GAAG,QAAQ,CAAC;IAExB,MAAM,QAAQ,2CAAY,CAAC;IAClC,KAAY,QAAQ,GAAG,SAAS,CAAC;IAM1B,MAAM,IAAI,mBAAa,CAAC;IAC/B,KAAY,SAAS,GAAG,cAAc,CAAC;IACvC,KAAY,aAAa,CAAC,CAAC,SAAS,UAAU,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC;IAMpE,KAAY,UAAU,GAAG,cAAc,CAAC;IAExC;;OAEG;IACI,MAAM,OAAO,0CAAW,CAAC;IAChC,KAAY,OAAO,GAAG,QAAQ,CAAC;IAG/B,KAAY,QAAQ,CAAC,CAAC,GAAG,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IAC9C,KAAY,aAAa,CAAC,CAAC,IAAI,eAAe,CAAC,CAAC,CAAC,CAAC;IAClD,KAAY,WAAW,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IAC3C,KAAY,UAAU,GAAG,YAAY,CAAC;IAE/B,MAAM,MAAM;;uCA7DX,OAAS,MAAK;KA6DK,CAAC;IAE5B;;;;;;;;;;;;;OAaG;IACI,MAAM,GAAG,SAAU,QAAQ,mBAqBuD,OAAQ,MAAM,CAEvG,GAAD,iEAvBwD,CAAC;IAMxD;;;;;;;;;;;;;;OAcG;IACI,MAAM,GAAG,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,QAAQ,CAAC,4DAAsC,CAAC;IAEjG,MAAM,GAAG,sEAAY,CAAC;IAMtB,MAAM,OAAO,WApCD,OAClB,MAAI,CAAC,GAAG,2DAmC+B,CAAC;IAClC,MAAM,SAAS,gCA/GV,OAAQ,MAClB,CAAC,YAAY,YA8GoB,CAAC;IAC7B,MAAM,UAAU,kBAfL,OAAQ,MAAM,CAAC,YAChC,4CAGA,OACC,MAAM,CAAC,IAAI,QAUyB,CAAC;IAOhC,MAAM,MAAM,WA9Gb,OACN,MAAI,CAAC,GAAG,yCA6G0B,CAAC;IAC5B,MAAM,WAAW,WAAY,MAAM,CAAC,MAAM,CAAC,YAAY,KAAG,MAIhE,CAAC;IACK,MAAM,UAAU,WA5BtB,OAAI,MAAM,CAAC,GAAG,uBA4B2B,CAAC;IACpC,MAAM,YAAY,WAlHvB,OAAQ,MACV,CAAC,GAAG,mBAiHqC,CAAC;CAC3C"}

package/dist/types/src/api.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=api.test.d.ts.map

package/dist/types/src/api.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"api.test.d.ts","sourceRoot":"","sources":["../../../src/api.test.ts"],"names":[],"mappings":""}