@dxos/echo-query 0.8.4-main.69d29f4 → 0.8.4-main.6fa680abb7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/echo-query",
-  "version": "0.8.4-main.69d29f4",
+  "version": "0.8.4-main.6fa680abb7",
   "description": "ECHO queries.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -19,8 +19,7 @@
     ".": {
       "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
-      "browser": "./dist/lib/browser/index.mjs",
-      "node": "./dist/lib/node-esm/index.mjs"
+      "default": "./dist/lib/neutral/index.mjs"
     },
     "./api.d.ts": "./dist/query-lite/index.d.ts"
   },
@@ -36,22 +35,22 @@
     "@lezer/common": "^1.2.2",
     "@lezer/lezer": "^1.1.2",
     "@lezer/lr": "^1.4.2",
-    "@dxos/context": "0.8.4-main.69d29f4",
-    "@dxos/debug": "0.8.4-main.69d29f4",
-    "@dxos/echo": "0.8.4-main.69d29f4",
-    "@dxos/invariant": "0.8.4-main.69d29f4",
-    "@dxos/errors": "0.8.4-main.69d29f4",
-    "@dxos/echo-protocol": "0.8.4-main.69d29f4",
-    "@dxos/node-std": "0.8.4-main.69d29f4",
-    "@dxos/util": "0.8.4-main.69d29f4",
-    "@dxos/vendor-quickjs": "0.8.4-main.69d29f4"
+    "@dxos/debug": "0.8.4-main.6fa680abb7",
+    "@dxos/errors": "0.8.4-main.6fa680abb7",
+    "@dxos/echo": "0.8.4-main.6fa680abb7",
+    "@dxos/context": "0.8.4-main.6fa680abb7",
+    "@dxos/echo-protocol": "0.8.4-main.6fa680abb7",
+    "@dxos/invariant": "0.8.4-main.6fa680abb7",
+    "@dxos/util": "0.8.4-main.6fa680abb7",
+    "@dxos/vendor-quickjs": "0.8.4-main.6fa680abb7",
+    "@dxos/node-std": "0.8.4-main.6fa680abb7"
   },
   "devDependencies": {
     "@lezer/generator": "^1.7.1",
     "tsdown": "^0.16.7",
     "typescript": "^5.9.3",
-    "@dxos/random": "0.8.4-main.69d29f4",
-    "@dxos/echo-generator": "0.8.4-main.69d29f4"
+    "@dxos/echo-generator": "0.8.4-main.6fa680abb7",
+    "@dxos/random": "0.8.4-main.6fa680abb7"
   },
   "publishConfig": {
     "access": "public"

package/src/parser/query.test.ts

@@ -51,10 +51,10 @@ describe('query', () => {
       },
       // Type
       {
-        input: 'type:dxos.org/type/Person',
+        input: 'type:org.dxos.type.person',
         expected: [
           'Query',
-          // type:dxos.org/type/Person
+          // type:org.dxos.type.person
           'Filter',
           'TypeFilter',
           'TypeKeyword',
@@ -111,10 +111,10 @@ describe('query', () => {
         ],
       },
       {
-        input: 'type:dxos.org/type/Person OR type:dxos.org/type/Organization',
+        input: 'type:org.dxos.type.person OR type:org.dxos.type.organization',
         expected: [
           'Query',
-          // type:dxos.org/type/Person
+          // type:org.dxos.type.person
           'Filter',
           'TypeFilter',
           'TypeKeyword',
@@ -122,7 +122,7 @@ describe('query', () => {
           'Identifier',
           // OR
           'Or',
-          // type:dxos.org/type/Organization
+          // type:org.dxos.type.organization
           'Filter',
           'TypeFilter',
           'TypeKeyword',
@@ -131,11 +131,11 @@ describe('query', () => {
         ],
       },
       {
-        input: '(type:dxos.org/type/Person OR type:dxos.org/type/Organization) AND { name: "DXOS" }',
+        input: '(type:org.dxos.type.person OR type:org.dxos.type.organization) AND { name: "DXOS" }',
         expected: [
           'Query',
           '(',
-          // type:dxos.org/type/Person
+          // type:org.dxos.type.person
           'Filter',
           'TypeFilter',
           'TypeKeyword',
@@ -143,7 +143,7 @@ describe('query', () => {
           'Identifier',
           // OR
           'Or',
-          // type:dxos.org/type/Organization
+          // type:org.dxos.type.organization
           'Filter',
           'TypeFilter',
           'TypeKeyword',
@@ -164,10 +164,10 @@ describe('query', () => {
         ],
       },
       {
-        input: 'type:dxos.org/type/Person -> type:dxos.org/type/Organization',
+        input: 'type:org.dxos.type.person -> type:org.dxos.type.organization',
         expected: [
           'Query',
-          // type:dxos.org/type/Person
+          // type:org.dxos.type.person
           'Filter',
           'TypeFilter',
           'TypeKeyword',
@@ -175,7 +175,7 @@ describe('query', () => {
           'Identifier',
           'Relation',
           'ArrowRight',
-          // type:dxos.org/type/Organization
+          // type:org.dxos.type.organization
           'Filter',
           'TypeFilter',
           'TypeKeyword',
@@ -184,10 +184,10 @@ describe('query', () => {
         ],
       },
       {
-        input: 'type:dxos.org/type/Organization <- type:dxos.org/type/Person',
+        input: 'type:org.dxos.type.organization <- type:org.dxos.type.person',
         expected: [
           'Query',
-          // type:dxos.org/type/Organization
+          // type:org.dxos.type.organization
           'Filter',
           'TypeFilter',
           'TypeKeyword',
@@ -195,7 +195,7 @@ describe('query', () => {
           'Identifier',
           'Relation',
           'ArrowLeft',
-          // type:dxos.org/type/Person
+          // type:org.dxos.type.person
           'Filter',
           'TypeFilter',
           'TypeKeyword',
@@ -206,7 +206,7 @@ describe('query', () => {
       {
         // Persons for Organizations with name "DXOS"
         // TODO(burdon): Filter relations.
-        input: '((type:dxos.org/type/Organization AND { name: "DXOS" }) -> type:dxos.org/type/Person)',
+        input: '((type:org.dxos.type.organization AND { name: "DXOS" }) -> type:org.dxos.type.person)',
         expected: [
           'Query',
           '(',
@@ -238,7 +238,7 @@ describe('query', () => {
         ],
       },
       {
-        input: 'type:dxos.org/type/Person and { name: "DXOS" }',
+        input: 'type:org.dxos.type.person and { name: "DXOS" }',
         expected: [
           'Query',
           'Filter',
@@ -259,7 +259,7 @@ describe('query', () => {
         ],
       },
       {
-        input: 'x = ( type: dxos.org/type/Person )',
+        input: 'x = ( type: org.dxos.type.person )',
         expected: [
           'Query',
           'Assignment',
@@ -305,9 +305,9 @@ describe('query', () => {
     const tests: Test[] = [
       // Types
       {
-        input: 'type:dxos.org/type/Person',
+        input: 'type:org.dxos.type.person',
         expected: {
-          filter: Filter.typename('dxos.org/type/Person'),
+          filter: Filter.typename('org.dxos.type.person'),
         },
       },
       // Tags
@@ -357,32 +357,32 @@ describe('query', () => {
         },
       },
       {
-        input: 'type:dxos.org/type/Person OR type:dxos.org/type/Organization',
+        input: 'type:org.dxos.type.person OR type:org.dxos.type.organization',
         expected: {
-          filter: Filter.or(Filter.typename('dxos.org/type/Person'), Filter.typename('dxos.org/type/Organization')),
+          filter: Filter.or(Filter.typename('org.dxos.type.person'), Filter.typename('org.dxos.type.organization')),
         },
       },
       {
-        input: '(type:dxos.org/type/Person OR type:dxos.org/type/Organization) AND { name: "DXOS" }',
+        input: '(type:org.dxos.type.person OR type:org.dxos.type.organization) AND { name: "DXOS" }',
         expected: {
           filter: Filter.and(
-            Filter.or(Filter.typename('dxos.org/type/Person'), Filter.typename('dxos.org/type/Organization')),
+            Filter.or(Filter.typename('org.dxos.type.person'), Filter.typename('org.dxos.type.organization')),
             Filter.props({ name: 'DXOS' }),
           ),
         },
       },
       {
-        input: 'type:dxos.org/type/Person and { name: "DXOS" }',
+        input: 'type:org.dxos.type.person and { name: "DXOS" }',
         expected: {
-          filter: Filter.and(Filter.typename('dxos.org/type/Person'), Filter.props({ name: 'DXOS' })),
+          filter: Filter.and(Filter.typename('org.dxos.type.person'), Filter.props({ name: 'DXOS' })),
         },
       },
       // Assignment
       {
-        input: 'x = ( type:dxos.org/type/Person )',
+        input: 'x = ( type:org.dxos.type.person )',
         expected: {
           name: 'x',
-          filter: Filter.typename('dxos.org/type/Person'),
+          filter: Filter.typename('org.dxos.type.person'),
         },
       },
       {
@@ -401,9 +401,9 @@ describe('query', () => {
       //
       // {
       //   input: '',
-      //   expected: Query.select(Filter.typename('dxos.org/type/Person', { jobTitle: 'investor' }))
+      //   expected: Query.select(Filter.typename('org.dxos.type.person', { jobTitle: 'investor' }))
       //     .reference('organization')
-      //     .targetOf(Relation.of('dxos.org/relation/HasSubject')) // TODO(burdon): Invert?
+      //     .targetOf(Relation.of('org.dxos.relation.has-subject')) // TODO(burdon): Invert?
       //     .source(),
       // },
     ];

package/src/query-lite/query-lite.ts

@@ -16,7 +16,7 @@ import type { DXN, ObjectId } from '@dxos/keys';
 // TODO(wittjosiah): The `export * as ...` syntax causes tsdown to genereate multiple files which breaks the sandbox.
 
 class OrderClass implements Order$.Any {
-  private static variance: Order$.Any['~Order'] = {} as Order$.Any['~Order'];
+  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;
@@ -46,7 +46,7 @@ const Order2: typeof Order$ = Order1;
 export { Order2 as Order };
 
 class FilterClass implements Filter$.Any {
-  private static variance: Filter$.Any['~Filter'] = {} as Filter$.Any['~Filter'];
+  private static 'variance': Filter$.Any['~Filter'] = {} as Filter$.Any['~Filter'];
 
   static is(value: unknown): value is Filter$.Any {
     return typeof value === 'object' && value !== null && '~Filter' in value;
@@ -328,7 +328,7 @@ const processPredicate = (predicate: any): QueryAST.Filter => {
 };
 
 class QueryClass implements Query$.Any {
-  private static variance: Query$.Any['~Query'] = {} as Query$.Any['~Query'];
+  private static 'variance': Query$.Any['~Query'] = {} as Query$.Any['~Query'];
 
   static is(value: unknown): value is Query$.Any {
     return typeof value === 'object' && value !== null && '~Query' in value;
@@ -372,6 +372,15 @@ class QueryClass implements Query$.Any {
     });
   }
 
+  static from(source: any, options?: { includeFeeds?: boolean }): Query$.Any {
+    const baseQuery: QueryAST.Query = {
+      type: 'select',
+      filter: FilterClass.everything().ast,
+    };
+    const wrapper = new QueryClass(baseQuery);
+    return wrapper.from(source, options);
+  }
+
   constructor(public readonly ast: QueryAST.Query) {}
 
   '~Query' = QueryClass.variance;
@@ -415,21 +424,21 @@ class QueryClass implements Query$.Any {
     });
   }
 
-  sourceOf(relation: Schema.Schema.All | string, predicates?: Filter$.Props<unknown> | undefined): Query$.Any {
+  sourceOf(relation?: Schema.Schema.All | string, predicates?: Filter$.Props<unknown> | undefined): Query$.Any {
     return new QueryClass({
       type: 'relation',
       anchor: this.ast,
       direction: 'outgoing',
-      filter: FilterClass.type(relation, predicates).ast,
+      filter: relation !== undefined ? FilterClass.type(relation, predicates).ast : undefined,
     });
   }
 
-  targetOf(relation: Schema.Schema.All | string, predicates?: Filter$.Props<unknown> | undefined): Query$.Any {
+  targetOf(relation?: Schema.Schema.All | string, predicates?: Filter$.Props<unknown> | undefined): Query$.Any {
     return new QueryClass({
       type: 'relation',
       anchor: this.ast,
       direction: 'incoming',
-      filter: FilterClass.type(relation, predicates).ast,
+      filter: relation !== undefined ? FilterClass.type(relation, predicates).ast : undefined,
     });
   }
 
@@ -449,6 +458,22 @@ class QueryClass implements Query$.Any {
     });
   }
 
+  parent(): Query$.Any {
+    return new QueryClass({
+      type: 'hierarchy-traversal',
+      anchor: this.ast,
+      direction: 'to-parent',
+    });
+  }
+
+  children(): Query$.Any {
+    return new QueryClass({
+      type: 'hierarchy-traversal',
+      anchor: this.ast,
+      direction: 'to-children',
+    });
+  }
+
   orderBy(...order: Order$.Any[]): Query$.Any {
     return new QueryClass({
       type: 'order',
@@ -465,6 +490,31 @@ class QueryClass implements Query$.Any {
     });
   }
 
+  from(arg: any, options?: { includeFeeds?: boolean }): Query$.Any {
+    if (arg === 'all-accessible-spaces') {
+      return new QueryClass({
+        type: 'from',
+        query: this.ast,
+        from: {
+          _tag: 'scope',
+          scope: {
+            ...(options?.includeFeeds ? { allQueuesFromSpaces: true } : {}),
+          },
+        },
+      });
+    }
+
+    if (_isScopeLike(arg)) {
+      return new QueryClass({
+        type: 'from',
+        query: this.ast,
+        from: { _tag: 'scope', scope: arg },
+      });
+    }
+
+    throw new TypeError('Database and Feed objects are not supported in query-lite sandbox');
+  }
+
   options(options: QueryAST.QueryOptions): Query$.Any {
     return new QueryClass({
       type: 'options',
@@ -487,3 +537,12 @@ const makeTypeDxn = (typename: string) => {
   assertArgument(!typename.startsWith('dxn:'), 'typename');
   return `dxn:type:${typename}`;
 };
+
+const SCOPE_KEYS = new Set(['spaceIds', 'queues', 'allQueuesFromSpaces']);
+
+const _isScopeLike = (value: unknown): value is QueryAST.Scope => {
+  if (typeof value !== 'object' || value === null || Array.isArray(value)) {
+    return false;
+  }
+  return Object.keys(value).every((key) => SCOPE_KEYS.has(key));
+};

package/src/sandbox/query-sandbox.test.ts

@@ -16,37 +16,37 @@ describe('QuerySandbox', () => {
 
   test('works', { timeout: 10_000 }, async () => {
     const ast = sandbox.eval(trim`
-      Query.select(Filter.typename('dxos.org/type/Person'))
+      Query.select(Filter.typename('org.dxos.type.person'))
     `);
-    expect(ast).toEqual(Query.select(Filter.typename('dxos.org/type/Person')).ast);
+    expect(ast).toEqual(Query.select(Filter.typename('org.dxos.type.person')).ast);
   });
 
   test('works with just Filter passed in', () => {
     const ast = sandbox.eval(trim`
-      Filter.typename('dxos.org/type/Person')
+      Filter.typename('org.dxos.type.person')
     `);
-    expect(ast).toEqual(Query.select(Filter.typename('dxos.org/type/Person')).ast);
+    expect(ast).toEqual(Query.select(Filter.typename('org.dxos.type.person')).ast);
   });
 
   test('Order', () => {
     const ast = sandbox.eval(trim`
-      Query.type('dxos.org/type/Person').orderBy(Order.property('name', 'desc'))
+      Query.type('org.dxos.type.person').orderBy(Order.property('name', 'desc'))
     `);
-    expect(ast).toEqual(Query.type('dxos.org/type/Person').orderBy(Order.property('name', 'desc')).ast);
+    expect(ast).toEqual(Query.type('org.dxos.type.person').orderBy(Order.property('name', 'desc')).ast);
   });
 
   test('traversal', () => {
     const ast = sandbox.eval(trim`
-      Query.select(Filter.type('dxos.org/type/Person', { jobTitle: 'investor' }))
+      Query.select(Filter.type('org.dxos.type.person', { jobTitle: 'investor' }))
         .reference('organization')
-        .targetOf('dxos.org/relation/HasSubject')
+        .targetOf('org.dxos.relation.has-subject')
         .source()
     `);
 
     expect(ast).toEqual(
-      Query.select(Filter.type('dxos.org/type/Person', { jobTitle: 'investor' }))
+      Query.select(Filter.type('org.dxos.type.person', { jobTitle: 'investor' }))
         .reference('organization')
-        .targetOf('dxos.org/relation/HasSubject')
+        .targetOf('org.dxos.relation.has-subject')
         .source().ast,
     );
   });

package/src/sandbox/query-sandbox.ts

@@ -49,7 +49,7 @@ export class QuerySandbox extends Resource {
 
   /**
    * Evaluates the query code.
-   * @param queryCode Example: `Query.select(Filter.typename('dxos.org/type/Person'))`
+   * @param queryCode Example: `Query.select(Filter.typename('org.dxos.type.person'))`
    */
   eval(queryCode: string): QueryAST.Query {
     using context = this.#runtime.newContext();