@dxos/echo-query 0.8.4-main.dedc0f3 → 0.8.4-main.e00bdcdb52

package/src/sandbox/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './query-sandbox';

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

@@ -0,0 +1,53 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { afterAll, beforeAll, describe, expect, test } from 'vitest';
+
+import { Filter, Order, Query } from '@dxos/echo';
+import { trim } from '@dxos/util';
+
+import { QuerySandbox } from './query-sandbox';
+
+describe('QuerySandbox', () => {
+  const sandbox = new QuerySandbox();
+  beforeAll(() => sandbox.open());
+  afterAll(() => sandbox.close());
+
+  test('works', { timeout: 10_000 }, async () => {
+    const ast = sandbox.eval(trim`
+      Query.select(Filter.typename('org.dxos.type.person'))
+    `);
+    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('org.dxos.type.person')
+    `);
+    expect(ast).toEqual(Query.select(Filter.typename('org.dxos.type.person')).ast);
+  });
+
+  test('Order', () => {
+    const ast = sandbox.eval(trim`
+      Query.type('org.dxos.type.person').orderBy(Order.property('name', 'desc'))
+    `);
+    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('org.dxos.type.person', { jobTitle: 'investor' }))
+        .reference('organization')
+        .targetOf('org.dxos.relation.hasSubject')
+        .source()
+    `);
+
+    expect(ast).toEqual(
+      Query.select(Filter.type('org.dxos.type.person', { jobTitle: 'investor' }))
+        .reference('organization')
+        .targetOf('org.dxos.relation.hasSubject')
+        .source().ast,
+    );
+  });
+});

package/src/sandbox/query-sandbox.ts

@@ -0,0 +1,72 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Resource } from '@dxos/context';
+import { Query, type QueryAST } from '@dxos/echo';
+import { trim } from '@dxos/util';
+import { type QuickJSRuntime, type QuickJSWASMModule, createQuickJS } from '@dxos/vendor-quickjs';
+
+import envCode from '#query-lite?raw';
+
+import { unwrapResult } from './quickjs';
+
+/**
+ * Evaluates queries written in JavaScript using QuickJS.
+ * Queries are expected to use the echo Query API.
+ * `Query`, `Filter` and `Order` are provided as globals.
+ */
+export class QuerySandbox extends Resource {
+  // Caching the wasm module.
+  private static quickJS: Promise<QuickJSWASMModule> | null = null;
+  static getQuickJS() {
+    if (!QuerySandbox.quickJS) {
+      QuerySandbox.quickJS = createQuickJS();
+    }
+
+    return QuerySandbox.quickJS;
+  }
+
+  #runtime!: QuickJSRuntime;
+
+  protected override async _open() {
+    const quickJS = await QuerySandbox.getQuickJS();
+    this.#runtime = quickJS.newRuntime({
+      moduleLoader: (moduleName, _context) => {
+        switch (moduleName) {
+          case 'dxos:query-lite':
+            return envCode;
+          default:
+            throw new Error(`Module not found: ${moduleName}`);
+        }
+      },
+    });
+  }
+
+  protected override async _close() {
+    this.#runtime.dispose();
+  }
+
+  /**
+   * Evaluates the query code.
+   * @param queryCode Example: `Query.select(Filter.typename('org.dxos.type.person'))`
+   */
+  eval(queryCode: string): QueryAST.Query {
+    using context = this.#runtime.newContext();
+    const globals = trim`
+      import { Filter, Order, Query } from 'dxos:query-lite';
+      globalThis.Filter = Filter;
+      globalThis.Order = Order;
+      globalThis.Query = Query;
+    `;
+
+    unwrapResult(context, context.evalCode(globals)).dispose();
+    using query = unwrapResult(context, context.evalCode(queryCode));
+    const result = context.dump(query);
+    if ('~Filter' in result) {
+      return Query.select(result).ast;
+    } else {
+      return result.ast;
+    }
+  }
+}

package/src/sandbox/quickjs.test.ts

@@ -0,0 +1,67 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { expect, test } from 'vitest';
+
+import { createQuickJS } from '@dxos/vendor-quickjs';
+
+import { unwrapResult } from './quickjs';
+
+test('works', async () => {
+  const QuickJS = await createQuickJS();
+  using context = QuickJS.newContext();
+
+  using world = context.newString('world');
+  context.setProp(context.global, 'NAME', world);
+
+  using result = unwrapResult(context, context.evalCode(`"Hello " + NAME + "!"`));
+  expect(context.dump(result)).toBe('Hello world!');
+});
+
+test('errors get propagated', async () => {
+  const QuickJS = await createQuickJS();
+  using runtime = QuickJS.newRuntime();
+  using context = runtime.newContext();
+  expect(() => unwrapResult(context, context.evalCode(`throw new Error('test')`))).toThrow();
+});
+
+test('global variables are shared in a context', async () => {
+  const QuickJS = await createQuickJS();
+  const context = QuickJS.newContext();
+
+  unwrapResult(context, context.evalCode('globalThis.name = "world"')).dispose();
+  using result = unwrapResult(context, context.evalCode(`"Hello " + name + "!"`));
+  expect(context.dump(result)).toBe('Hello world!');
+});
+
+test('global variables are shared in a context created from runtime', async () => {
+  const QuickJS = await createQuickJS();
+  using runtime = QuickJS.newRuntime();
+  using context = runtime.newContext();
+
+  unwrapResult(context, context.evalCode('globalThis.name = "world"'));
+  using result = unwrapResult(context, context.evalCode(`"Hello " + name + "!"`));
+  expect(context.dump(result)).toBe('Hello world!');
+});
+
+test('load module', async () => {
+  const QuickJS = await createQuickJS();
+  using runtime = QuickJS.newRuntime({
+    moduleLoader: (name, _context) => {
+      switch (name) {
+        case 'test:name':
+          return `
+          export const name = 'world';
+        `;
+        default:
+          throw new Error('unknown module');
+      }
+    },
+  });
+  using context = runtime.newContext();
+
+  unwrapResult(context, context.evalCode('import { name } from "test:name"; globalThis.name = name;')).dispose();
+  using result = unwrapResult(context, context.evalCode(`"Hello " + name + "!"`));
+  expect(context.dump(result)).toBe('Hello world!');
+});

package/src/sandbox/quickjs.ts

@@ -0,0 +1,33 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type QuickJSContext, type QuickJSHandle, type SuccessOrFail } from '@dxos/vendor-quickjs';
+
+/**
+ * Unwraps a result and throws the underlying error.
+ *
+ * Replacement for `QuickJScontext.unwrapResult` because that seems to cause an OOM.
+ */
+// TODO(burdon): Factor out.
+export const unwrapResult = <T>(context: QuickJSContext, result: SuccessOrFail<T, QuickJSHandle>): T => {
+  if (result.error) {
+    const contextError = context.dump(result.error);
+    result.error.dispose();
+    if (
+      typeof contextError === 'object' &&
+      typeof contextError.name === 'string' &&
+      typeof contextError.message === 'string'
+    ) {
+      const error = new Error(contextError.message);
+      Object.defineProperty(error, 'name', { value: contextError.name });
+      const originalStack = error.stack;
+      error.stack = `${contextError.name}: ${contextError.message}\n${contextError.stack}${originalStack?.split('\n').slice(1).join('\n') ?? ''}`;
+      throw error;
+    } else {
+      throw new Error(String(contextError));
+    }
+  }
+
+  return result.value;
+};

package/dist/lib/browser/index.mjs

@@ -1,2 +0,0 @@
-import "@dxos/node-std/globals";
-//# sourceMappingURL=index.mjs.map

package/dist/lib/browser/index.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": [],
-  "sourcesContent": [],
-  "mappings": "",
-  "names": []
-}

package/dist/lib/browser/meta.json

@@ -1 +0,0 @@
-{"inputs":{"src/index.ts":{"bytes":368,"imports":[],"format":"esm"}},"outputs":{"dist/lib/browser/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":93},"dist/lib/browser/index.mjs":{"imports":[],"exports":[],"entryPoint":"src/index.ts","inputs":{"src/index.ts":{"bytesInOutput":0}},"bytes":68}}}

package/dist/lib/node-esm/index.mjs

@@ -1,2 +0,0 @@
-import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
-//# sourceMappingURL=index.mjs.map

package/dist/lib/node-esm/index.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": [],
-  "sourcesContent": [],
-  "mappings": "",
-  "names": []
-}

package/dist/lib/node-esm/meta.json

@@ -1 +0,0 @@
-{"inputs":{"src/index.ts":{"bytes":368,"imports":[],"format":"esm"}},"outputs":{"dist/lib/node-esm/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":93},"dist/lib/node-esm/index.mjs":{"imports":[],"exports":[],"entryPoint":"src/index.ts","inputs":{"src/index.ts":{"bytesInOutput":0}},"bytes":127}}}

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

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

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

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

package/src/search.test.ts

@@ -1,49 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { create, insert, search } from '@orama/orama';
-import { describe, expect, test } from 'vitest';
-
-import { createTestObjectGenerator } from '@dxos/echo-generator';
-import { faker } from '@dxos/random';
-import { range } from '@dxos/util';
-
-faker.seed(1);
-
-// TODO(burdon): Factor out functions.
-// TODO(burdon): Chat/search/suggest.
-// TODO(burdon): Integrate with schema.
-// TODO(burdon): Factor out agent/plugin-search.
-// TODO(burdon): Proto defs.
-// TODO(burdon): Client/server cascading calls?
-// TODO(burdon): SDK/API.
-
-describe('Orama', () => {
-  test('basic', async () => {
-    // TODO(burdon): Create Client/spaces.
-    const generator = createTestObjectGenerator();
-
-    // https://www.npmjs.com/package/@orama/orama
-    const db = await create({
-      schema: {
-        // TODO(burdon): Index TypedObject using schema; separate db for each schema?
-        title: 'string',
-        embedding: 'vector[1536]', // Vector size must be expressed during schema initialization.
-        meta: {
-          rating: 'number',
-        },
-      },
-    });
-
-    {
-      const objects = await Promise.all(range(10, () => generator.createObject()));
-      await Promise.all(objects.map((object) => insert<any>(db, object)));
-    }
-
-    {
-      const result = await search(db, { term: 'shoes' });
-      expect(result.hits).to.have.length;
-    }
-  });
-});