@dxos/plugin-space 0.8.4-main.ae835ea → 0.8.4-main.bc674ce

package/src/helpers/index.ts

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

package/src/helpers/query.test.ts

@@ -0,0 +1,24 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, expect, it } from 'vitest';
+
+import { evalQuery } from './query';
+
+describe('evalQuery', () => {
+  it('should evaluate a query string', () => {
+    const query = evalQuery('Query.select(Filter.type(Person.Person))');
+    expect(query.ast).toMatchInlineSnapshot(`
+      {
+        "filter": {
+          "id": undefined,
+          "props": {},
+          "type": "object",
+          "typename": "dxn:type:dxos.org/type/Person:0.1.0",
+        },
+        "type": "select",
+      }
+    `);
+  });
+});

package/src/helpers/query.ts

@@ -0,0 +1,153 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Array from 'effect/Array';
+import * as Effect from 'effect/Effect';
+import * as EffectFunction from 'effect/Function';
+import * as Match from 'effect/Match';
+import * as Option from 'effect/Option';
+import type * as Schema from 'effect/Schema';
+import * as SchemaAST from 'effect/SchemaAST';
+
+import { DXN, Filter, Query, type QueryAST, type SchemaRegistry } from '@dxos/echo';
+import {
+  ReferenceAnnotationId,
+  type ReferenceAnnotationValue,
+  getTypeAnnotation,
+  unwrapOptional,
+} from '@dxos/echo/internal';
+import { runAndForwardErrors } from '@dxos/effect';
+import { log } from '@dxos/log';
+import { type Space } from '@dxos/react-client/echo';
+import { Person } from '@dxos/types';
+
+// TODO(wittjosiah): Factor out and add tests.
+// TODO(wittjosiah): Support arbitrary type imports.
+export const evalQuery = (queryString: string): Query.Any => {
+  const globals = { Query, Filter, Person };
+  try {
+    // eslint-disable-next-line @typescript-eslint/no-implied-eval
+    return new Function(...Object.keys(globals), `return ${queryString}`)(...Object.values(globals));
+  } catch (err) {
+    log.catch(err);
+    return Query.select(Filter.nothing());
+  }
+};
+
+export const resolveSchemaWithRegistry = (registry: SchemaRegistry.SchemaRegistry, query: QueryAST.Query) => {
+  const resolve = Effect.fn(function* (dxn: string) {
+    const typename = DXN.parse(dxn).asTypeDXN()?.type;
+    if (!typename) {
+      return Option.none();
+    }
+
+    const query = registry.query({ typename, location: ['database', 'runtime'] });
+    const schemas = yield* Effect.promise(() => query.run());
+    return Array.head(schemas);
+  });
+
+  return resolveSchema(query, resolve).pipe(
+    Effect.map((schema) => Option.getOrUndefined(schema)),
+    runAndForwardErrors,
+  );
+};
+
+const resolveSchema = (
+  query: QueryAST.Query,
+  resolve: (dxn: string) => Effect.Effect<Option.Option<Schema.Schema.AnyNoContext>>,
+): Effect.Effect<Option.Option<Schema.Schema.AnyNoContext>> => {
+  return Match.value(query).pipe(
+    Match.withReturnType<Effect.Effect<Option.Option<Schema.Schema.AnyNoContext>>>(),
+    // TODO(wittjosiah): Reconcile with filter match?
+    Match.when({ type: 'select' }, ({ filter }) =>
+      typenameFromFilter(filter).pipe(
+        Option.map((typename) => resolve(typename)),
+        Option.getOrElse(() => Effect.succeed(Option.none<Schema.Schema.AnyNoContext>())),
+      ),
+    ),
+    Match.when({ type: 'filter' }, ({ filter }) =>
+      typenameFromFilter(filter).pipe(
+        Option.map((typename) => resolve(typename)),
+        Option.getOrElse(() => Effect.succeed(Option.none<Schema.Schema.AnyNoContext>())),
+      ),
+    ),
+    Match.when({ type: 'reference-traversal' }, ({ anchor, property }) =>
+      resolveSchema(anchor, resolve).pipe(
+        Effect.map((base) =>
+          base.pipe(
+            Option.map((schema) => SchemaAST.getPropertySignatures(schema.ast)),
+            Option.flatMap((properties) => Array.findFirst(properties, (p) => p.name === property)),
+            Option.flatMap((property) =>
+              SchemaAST.getAnnotation<ReferenceAnnotationValue>(ReferenceAnnotationId)(unwrapOptional(property)),
+            ),
+            Option.map((annotation) => annotation.typename),
+          ),
+        ),
+        Effect.flatMap(
+          Option.match({
+            onNone: () => Effect.succeed(Option.none()),
+            onSome: (typename) => resolve(DXN.fromTypename(typename).toString()),
+          }),
+        ),
+      ),
+    ),
+    Match.when({ type: 'relation', filter: Match.defined }, ({ filter }) =>
+      typenameFromFilter(filter).pipe(
+        Option.map((typename) => resolve(typename)),
+        Option.getOrElse(() => Effect.succeed(Option.none<Schema.Schema.AnyNoContext>())),
+      ),
+    ),
+    Match.when({ type: 'relation-traversal' }, ({ anchor, direction }) =>
+      resolveSchema(anchor, resolve).pipe(
+        Effect.map((base) =>
+          base.pipe(
+            Option.map((schema) => getTypeAnnotation(schema)),
+            Option.flatMap((annotation) =>
+              Option.fromNullable(direction === 'source' ? annotation?.sourceSchema : annotation?.targetSchema),
+            ),
+          ),
+        ),
+        Effect.flatMap(
+          Option.match({
+            onNone: () => Effect.succeed(Option.none()),
+            onSome: (typename) => resolve(typename),
+          }),
+        ),
+      ),
+    ),
+    Match.when({ type: 'options' }, ({ query }) => resolveSchema(query, resolve)),
+    Match.orElse((_q) => {
+      // TODO(wittjosiah): Implement other cases.
+      return Effect.succeed(Option.none());
+    }),
+  );
+};
+
+const typenameFromFilter = (filter: QueryAST.Filter): Option.Option<string> =>
+  Match.value(filter).pipe(
+    Match.withReturnType<Option.Option<string>>(),
+    Match.when({ type: 'object' }, ({ typename }) => Option.fromNullable(typename)),
+    Match.when({ type: 'and' }, ({ filters }) =>
+      EffectFunction.pipe(filters, Array.map(typenameFromFilter), Array.findFirst(Option.isSome), Option.flatten),
+    ),
+    Match.when({ type: 'or' }, ({ filters }) =>
+      EffectFunction.pipe(filters, Array.map(typenameFromFilter), Array.findFirst(Option.isSome), Option.flatten),
+    ),
+    Match.orElse(() => Option.none()),
+  );
+
+// TODO(wittjosiah): Currently assumes options is at the top-level of the ast.
+export const getQueryTarget = (query: QueryAST.Query, space?: Space) => {
+  return Match.value(query).pipe(
+    Match.when({ type: 'options' }, ({ options }) => {
+      return Option.fromNullable(options.queues).pipe(
+        Option.flatMap((queues) => Array.head(queues)),
+        Option.flatMap((queueDxn) => Option.fromNullable(DXN.tryParse(queueDxn))),
+        Option.flatMap((queueDxn) => Option.fromNullable(space?.queues.get(queueDxn))),
+        Option.getOrElse(() => space?.db),
+      );
+    }),
+    Match.orElse(() => space?.db),
+  );
+};

package/src/hooks/useActiveSpace.ts

@@ -2,13 +2,16 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Capabilities, type PluginContext, useLayout } from '@dxos/app-framework';
+import { type CapabilityManager, Common } from '@dxos/app-framework';
+import { useLayout } from '@dxos/app-framework/react';
 import { ClientCapabilities } from '@dxos/plugin-client';
 import { parseId, useSpace } from '@dxos/react-client/echo';
 
-export const getActiveSpace = (context: PluginContext) => {
-  const client = context.getCapability(ClientCapabilities.Client);
-  const layout = context.getCapability(Capabilities.Layout);
+export const getActiveSpace = (capabilities: CapabilityManager.CapabilityManager) => {
+  const client = capabilities.get(ClientCapabilities.Client);
+  const registry = capabilities.get(Common.Capability.AtomRegistry);
+  const layoutAtom = capabilities.get(Common.Capability.Layout);
+  const layout = registry.get(layoutAtom);
   const { spaceId } = parseId(layout.workspace);
   return spaceId ? client.spaces.get(spaceId) : undefined;
 };

package/src/hooks/useInputSurfaceLookup.tsx

@@ -2,29 +2,25 @@
 // Copyright 2025 DXOS.org
 //
 
-import type * as Schema from 'effect/Schema';
 import React, { useCallback } from 'react';
 
-import { Surface, isSurfaceAvailable, usePluginManager } from '@dxos/app-framework';
-import { type InputProps } from '@dxos/react-ui-form';
+import { Surface, isSurfaceAvailable, usePluginManager } from '@dxos/app-framework/react';
+import { type FormFieldProvider } from '@dxos/react-ui-form';
 
-// TODO(ZaymonFC): Move this if you find yourself needing it elsewhere.
 /**
  * Creates a surface input component based on plugin context.
  * @param baseData Additional data that will be merged with form data and passed to the surface.
  * This allows providing more context to the surface than what's available from the form itself.
  */
-export const useInputSurfaceLookup = (baseData?: Record<string, any>) => {
+// TODO(burdon): Factor out?
+export const useInputSurfaceLookup = (baseData?: Record<string, any>): FormFieldProvider => {
   const pluginManager = usePluginManager();
-
-  return useCallback(
-    ({ prop, schema, inputProps }: { prop: string; schema: Schema.Schema<any>; inputProps: InputProps }) => {
-      const composedData = { prop, schema, ...baseData };
-      if (!isSurfaceAvailable(pluginManager.context, { role: 'form-input', data: composedData })) {
-        return undefined;
+  return useCallback<FormFieldProvider>(
+    ({ schema, prop, fieldProps }) => {
+      const data = { prop, schema, ...baseData };
+      if (isSurfaceAvailable(pluginManager.capabilities, { role: 'form-input', data })) {
+        return <Surface role='form-input' data={data} {...fieldProps} />;
       }
-
-      return <Surface role='form-input' data={composedData} {...inputProps} />;
     },
     [pluginManager, baseData],
   );

package/src/hooks/usePath.ts

@@ -5,7 +5,7 @@
 import * as Option from 'effect/Option';
 import { useEffect, useState } from 'react';
 
-import { type ReadableGraph } from '@dxos/plugin-graph';
+import { Graph } from '@dxos/plugin-graph';
 
 /**
  * React hook to get a path from the graph.
@@ -16,9 +16,9 @@ import { type ReadableGraph } from '@dxos/plugin-graph';
  * @returns Path if found, undefined otherwise.
  */
 // TODO(wittjosiah): Factor out.
-export const usePath = (graph: ReadableGraph, id?: string, timeout?: number): Option.Option<string[]> => {
+export const usePath = (graph: Graph.ReadableGraph, id?: string, timeout?: number): Option.Option<string[]> => {
   const [pathState, setPathState] = useState<Option.Option<string[]>>(
-    id ? graph.getPath({ target: id }) : Option.none(),
+    id ? Graph.getPath(graph, { target: id }) : Option.none(),
   );
 
   useEffect(() => {
@@ -33,7 +33,7 @@ export const usePath = (graph: ReadableGraph, id?: string, timeout?: number): Op
     // Set timeout did not seem to effectively not block the UI thread.
     const frame = requestAnimationFrame(async () => {
       try {
-        const path = await graph.waitForPath({ target: id }, { timeout });
+        const path = await Graph.waitForPath(graph, { target: id }, { timeout });
         if (path) {
           setPathState(Option.some(path));
         }

package/src/hooks/useTypeOptions.ts

@@ -4,48 +4,14 @@
 
 import { useMemo } from 'react';
 
-import { useCapabilities } from '@dxos/app-framework';
-import { Type } from '@dxos/echo';
-import { ClientCapabilities } from '@dxos/plugin-client';
-import { useClient } from '@dxos/react-client';
 import { type Space } from '@dxos/react-client/echo';
 import { useTranslation } from '@dxos/react-ui';
-import { DataType, type TypenameAnnotation, getTypenames } from '@dxos/schema';
 
-import { SpaceCapabilities } from '../capabilities';
+import { type TypeInputOptions, getTypenames } from '../types';
 
-const OMIT = [DataType.Collection.typename, Type.getTypename(DataType.QueryCollection)];
-
-export const useTypeOptions = ({ space, annotation }: { space?: Space; annotation: TypenameAnnotation[] }) => {
+export const useTypeOptions = ({ space, annotation }: { space?: Space; annotation: TypeInputOptions }) => {
   const { t } = useTranslation();
-  const client = useClient();
-
-  const schemaWhitelists = useCapabilities(ClientCapabilities.SchemaWhiteList);
-  const whitelistedTypenames = useMemo(
-    () => new Set(schemaWhitelists.flatMap((typeArray) => typeArray.map((type) => Type.getTypename(type)))),
-    [schemaWhitelists],
-  );
-
-  const objectForms = useCapabilities(SpaceCapabilities.ObjectForm);
-  const objectFormTypenames = useMemo(
-    () =>
-      new Set(
-        objectForms
-          .map((form) => Type.getTypename(form.objectSchema))
-          // TODO(wittjosiah): Remove.
-          .filter((typename) => !OMIT.includes(typename) && !typename.endsWith('View')),
-      ),
-    [objectForms],
-  );
-
-  const typenames = getTypenames({
-    annotation,
-    whitelistedTypenames,
-    objectFormTypenames,
-    space,
-    client,
-  });
-
+  const typenames = getTypenames({ annotation, space });
   return useMemo(
     () =>
       typenames

package/src/index.ts

@@ -2,10 +2,10 @@
 // Copyright 2023 DXOS.org
 //
 
-export { SpaceCapabilities } from './capabilities';
-export { SpaceEvents } from './events';
+export { SpaceCapabilities, SpaceEvents } from './types';
 
 export * from './components';
+export * from './helpers';
 export * from './hooks';
 export * from './meta';
 export * from './SpacePlugin';

package/src/meta.ts

@@ -2,10 +2,10 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type PluginMeta } from '@dxos/app-framework';
+import { type Plugin } from '@dxos/app-framework';
 import { trim } from '@dxos/util';
 
-export const meta: PluginMeta = {
+export const meta: Plugin.Meta = {
   id: 'dxos.org/plugin/space',
   name: 'Spaces',
   description: trim`

package/src/translations.ts

@@ -3,9 +3,9 @@
 //
 
 import { Type } from '@dxos/echo';
-import { StoredSchema } from '@dxos/echo/internal';
 import { type Resource } from '@dxos/react-ui';
-import { DataType } from '@dxos/schema';
+import { Collection } from '@dxos/schema';
+import { Event, Message, Organization, Person, Project, Task } from '@dxos/types';
 
 import { meta } from './meta';
 
@@ -13,7 +13,7 @@ import { meta } from './meta';
 export const translations = [
   {
     'en-US': {
-      [DataType.Collection.typename]: {
+      [Collection.Collection.typename]: {
         'typename label': 'Collection',
         'typename label_zero': 'Collections',
         'typename label_one': 'Collection',
@@ -21,63 +21,54 @@ export const translations = [
         'object name placeholder': 'New collection',
         'rename object label': 'Rename collection',
         'delete object label': 'Delete collection',
+        'object deleted label': 'Collection deleted',
       },
-      [Type.getTypename(DataType.QueryCollection)]: {
-        'typename label': 'Smart Collection',
-        'typename label_zero': 'Smart Collections',
-        'typename label_one': 'Smart Collection',
-        'typename label_other': 'Smart Collections',
-        'object name placeholder': 'New smart collection',
-        'rename object label': 'Rename smart collection',
-        'delete object label': 'Delete smart collection',
+      [Type.getTypename(Type.PersistentType)]: {
+        'typename label': 'Type',
+        'typename label_zero': 'Types',
+        'typename label_one': 'Type',
+        'typename label_other': 'Types',
+        'object name placeholder': 'New type',
+        'rename object label': 'Rename type',
+        'delete object label': 'Delete type',
+        'object deleted label': 'Type deleted',
       },
-      [StoredSchema.typename]: {
-        'typename label': 'Record',
-        'typename label_zero': 'Records',
-        'typename label_one': 'Record',
-        'typename label_other': 'Records',
-        'object name placeholder': 'New record type',
-        'rename object label': 'Rename record type',
-        'delete object label': 'Delete record type',
-      },
-      [Type.getTypename(DataType.View)]: {
-        'typename label': 'View',
-        'typename label_zero': 'Views',
-        'typename label_one': 'View',
-        'typename label_other': 'Views',
-        'object name placeholder': 'New view',
-        'rename object label': 'Rename view',
-        'delete object label': 'Delete view',
-      },
-      [DataType.Event.typename]: {
+      [Event.Event.typename]: {
         'typename label': 'Event',
         'typename label_zero': 'Events',
         'typename label_one': 'Event',
         'typename label_other': 'Events',
         'object name placeholder': 'New event',
       },
-      [DataType.Organization.typename]: {
+      [Message.Message.typename]: {
+        'typename label': 'Message',
+        'typename label_zero': 'Messages',
+        'typename label_one': 'Message',
+        'typename label_other': 'Messages',
+        'object name placeholder': 'New message',
+      },
+      [Organization.Organization.typename]: {
         'typename label': 'Organization',
         'typename label_zero': 'Organizations',
         'typename label_one': 'Organization',
         'typename label_other': 'Organizations',
         'object name placeholder': 'New organization',
       },
-      [DataType.Person.typename]: {
+      [Person.Person.typename]: {
         'typename label': 'Person',
         'typename label_zero': 'People',
         'typename label_one': 'Person',
         'typename label_other': 'People',
         'object name placeholder': 'New person',
       },
-      [Type.getTypename(DataType.Project)]: {
+      [Project.Project.typename]: {
         'typename label': 'Project',
         'typename label_zero': 'Projects',
         'typename label_one': 'Project',
         'typename label_other': 'Projects',
         'object name placeholder': 'New project',
       },
-      [DataType.Task.typename]: {
+      [Task.Task.typename]: {
         'typename label': 'Task',
         'typename label_zero': 'Tasks',
         'typename label_one': 'Task',
@@ -99,7 +90,7 @@ export const translations = [
         'rename space label': 'Rename space',
         'active space label': 'Active space:',
         'space name label': 'Space name',
-        'object name label': 'Item name',
+        'object name label': 'Object name',
         'close space label': 'Close space',
         'open space label': 'Open space',
         'export data label': 'Export data',
@@ -117,32 +108,31 @@ export const translations = [
         'spaces label': 'Spaces',
         'space settings label': 'Spaces',
         'space settings description':
-          'Each space has its own settings you can configure, where you can adjust its properties, membership, integrations, and other items specific to that space.',
+          'Each space has its own settings you can configure, where you can adjust its properties, membership, integrations, and other objects specific to that space.',
         'show hidden spaces label': 'Show archived spaces',
         'save files to directory label': 'Save files to disk',
         'select path label': 'Select path',
+        'snapshot by schema label': 'Snapshot of objects',
         'rename collection label': 'Rename collection',
-        'rename object label': 'Rename item',
-        'duplicate object label': 'Duplicate item',
-        'delete collection label': 'Delete collection',
-        'delete object label': 'Delete item',
-        'collection deleted label': 'Collection deleted',
-        'object deleted label': 'Item deleted',
-        'objects deleted label': 'Items deleted',
-        'go to object label': 'Open item',
+        'rename object label': 'Rename object',
+        'duplicate object label': 'Duplicate object',
+        'object deleted label': 'Object deleted',
+        'objects deleted label': 'Objects deleted',
+        'go to object label': 'Open object',
         'found object label': 'Ready.',
-        'found object description': 'The requested item is now available.',
+        'found object description': 'The requested object is now available.',
         'waiting for object label': 'Loading…',
-        'waiting for object description': 'The requested item is still being synchronized.',
+        'waiting for object description': 'The requested object is still being synchronized.',
         'object not found label': 'Nothing found.',
         'object not found description':
-          'The requested item has not been found yet. Ensure there are enough peers online in the space with an updated copy.',
-        'missing object message': 'Item not available.',
+          'The requested object has not been found yet. Ensure there are enough peers online in the space with an updated copy.',
+        'missing object message': 'Object not available.',
         'missing object description':
-          'The requested item has not been found yet. Ensure there are enough peers online in the space with an updated copy.',
+          'The requested object has not been found yet. Ensure there are enough peers online in the space with an updated copy.',
         'create object in space label': 'Add to space',
         'create object in collection label': 'Add to collection',
-        'create object in smart collection label': 'Add to smart collection',
+        'create object in system collection label': 'Add to system collection',
+        'add view to schema label': 'Add view to type',
         'space members label': 'Space members',
         'active space members heading': 'Online ({{count}})',
         'inactive space members heading': 'Offline ({{count}})',
@@ -160,10 +150,10 @@ export const translations = [
         'location label': 'Located in',
         'space limit label': 'Space Limit Reached',
         'space limit description':
-          'This space has reached the maximum number of items for the beta. This limit includes deleted items currently, but those can be permanently removed with the cleanup action.',
+          'This space has reached the maximum number of objects for the beta. This limit includes deleted objects currently, but those can be permanently removed with the cleanup action.',
         'space limit close label': 'Close',
         'remove deleted objects label': 'Cleanup',
-        'remove deleted objects alt': 'Permanently remove deleted items to free up space.',
+        'remove deleted objects alt': 'Permanently remove deleted objects to free up space.',
         'copy link label': 'Copy link',
         'default on space create label': 'On space create',
         'sync status title': 'Sync status',
@@ -180,11 +170,11 @@ export const translations = [
         'remote synced label': 'Synced with peers',
         'syncing label': 'Space syncing',
         'show all label': 'Show all',
-        'no sync status label': 'No space with missing items.',
+        'no sync status label': 'No space with missing objects.',
         'create space dialog title': 'Create Space',
         'create object dialog title': 'Create {{object}}',
         'space input placeholder': 'Select space',
-        'schema input placeholder': 'Select item type',
+        'schema input placeholder': 'Select type',
         'creating object type label': 'Type',
         'creating in space label': 'Location',
         'creating in collection label': 'In Collection',
@@ -195,7 +185,7 @@ export const translations = [
         'foreign keys': 'Foreign Keys',
         'add key': 'Add Key',
         'open space settings label': 'Open settings',
-        'related objects label': 'Related',
+        'related objects label': 'Related Objects',
 
         'row details no selection label': 'No objects selected',
         'companion selected objects label': 'Selected',
@@ -217,10 +207,10 @@ export const translations = [
         'space settings properties label': 'General settings',
         'space properties settings verbose label': 'Manage space properties',
         'space properties settings description': 'You can configure how this space is displayed in the app here.',
-        'space settings schema label': 'Record types',
-        'schema verbose label': 'Manage record types',
-        'schema description': 'You can manage all of the record types stored within this space here.',
-        'no schemas found message': 'No record types found',
+        'space settings schema label': 'Types',
+        'schema verbose label': 'Manage types',
+        'schema description': 'You can manage all of the types stored within this space here.',
+        'no schemas found message': 'No types found',
         'display name input placeholder': 'Space name',
         'display name description': 'Name of the space as it appears in the app.',
         'icon description': 'Icon used to represent the space in the app.',
@@ -232,12 +222,24 @@ export const translations = [
         'archive space label': 'Archive',
         'unarchive space label': 'Unarchive',
 
+        'space controls title': 'Space Controls',
+        'space controls description': 'Advanced controls for this space.',
+        'backup space title': 'Backup Space',
+        'backup space description':
+          'Download a backup of the space. Contains all data in the space in an unencrypted format.',
+        'download backup label': 'Download backup',
+        'repair space title': 'Repair Space',
+        'repair space description': 'Run repair operations on the space.',
+        'repair space label': 'Run repairs',
+
         'sync edge connected label': 'Edge connected',
         'sync edge disconnected label': 'Edge disconnected',
         'sync no connection label': 'No connection to edge service',
         'sync latency label': 'Latency',
         'sync upload label': 'Upload',
         'sync download label': 'Download',
+
+        'search placeholder': 'Search…',
       },
     },
   },