@dxos/plugin-space 0.8.4-main.7ace549 → 0.8.4-main.8360d9e660

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,7 +4,6 @@
 
 import { useMemo } from 'react';
 
-import { useClient } from '@dxos/react-client';
 import { type Space } from '@dxos/react-client/echo';
 import { useTranslation } from '@dxos/react-ui';
 
@@ -12,8 +11,7 @@ import { type TypeInputOptions, getTypenames } from '../types';
 
 export const useTypeOptions = ({ space, annotation }: { space?: Space; annotation: TypeInputOptions }) => {
   const { t } = useTranslation();
-  const client = useClient();
-  const typenames = getTypenames({ annotation, space, client });
+  const typenames = getTypenames({ annotation, space });
   return useMemo(
     () =>
       typenames

package/src/index.ts

@@ -2,12 +2,12 @@
 // 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';
 export * from './util';
+
+export * from './SpacePlugin';

package/src/meta.ts

@@ -2,11 +2,11 @@
 // 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 = {
-  id: 'dxos.org/plugin/space',
+export const meta: Plugin.Meta = {
+  id: 'org.dxos.plugin.space',
   name: 'Spaces',
   description: trim`
     Core workspace container system for organizing and sharing collaborative environments.

package/src/translations.ts

@@ -3,9 +3,9 @@
 //
 
 import { Type } from '@dxos/echo';
+import { Collection } from '@dxos/echo';
 import { type Resource } from '@dxos/react-ui';
-import { Collection } from '@dxos/schema';
-import { Event, Message, Organization, Person, Project, Task } from '@dxos/types';
+import { Event, Message, Organization, Person, Pipeline, Task } from '@dxos/types';
 
 import { meta } from './meta';
 
@@ -19,6 +19,7 @@ export const translations = [
         'typename label_one': 'Collection',
         'typename label_other': 'Collections',
         'object name placeholder': 'New collection',
+        'add object label': 'Add collection',
         'rename object label': 'Rename collection',
         'delete object label': 'Delete collection',
         'object deleted label': 'Collection deleted',
@@ -29,6 +30,7 @@ export const translations = [
         'typename label_one': 'Type',
         'typename label_other': 'Types',
         'object name placeholder': 'New type',
+        'add object label': 'Add type',
         'rename object label': 'Rename type',
         'delete object label': 'Delete type',
         'object deleted label': 'Type deleted',
@@ -39,6 +41,9 @@ export const translations = [
         'typename label_one': 'Event',
         'typename label_other': 'Events',
         'object name placeholder': 'New event',
+        'add object label': 'Add event',
+        'rename object label': 'Rename event',
+        'delete object label': 'Delete event',
       },
       [Message.Message.typename]: {
         'typename label': 'Message',
@@ -46,6 +51,9 @@ export const translations = [
         'typename label_one': 'Message',
         'typename label_other': 'Messages',
         'object name placeholder': 'New message',
+        'add object label': 'Add message',
+        'rename object label': 'Rename message',
+        'delete object label': 'Delete message',
       },
       [Organization.Organization.typename]: {
         'typename label': 'Organization',
@@ -53,6 +61,9 @@ export const translations = [
         'typename label_one': 'Organization',
         'typename label_other': 'Organizations',
         'object name placeholder': 'New organization',
+        'add object label': 'Add organization',
+        'rename object label': 'Rename organization',
+        'delete object label': 'Delete organization',
       },
       [Person.Person.typename]: {
         'typename label': 'Person',
@@ -60,13 +71,19 @@ export const translations = [
         'typename label_one': 'Person',
         'typename label_other': 'People',
         'object name placeholder': 'New person',
+        'add object label': 'Add person',
+        'rename object label': 'Rename person',
+        'delete object label': 'Delete person',
       },
-      [Project.Project.typename]: {
+      [Pipeline.Pipeline.typename]: {
         'typename label': 'Project',
         'typename label_zero': 'Projects',
         'typename label_one': 'Project',
         'typename label_other': 'Projects',
         'object name placeholder': 'New project',
+        'add object label': 'Add project',
+        'rename object label': 'Rename project',
+        'delete object label': 'Delete project',
       },
       [Task.Task.typename]: {
         'typename label': 'Task',
@@ -74,6 +91,9 @@ export const translations = [
         'typename label_one': 'Task',
         'typename label_other': 'Tasks',
         'object name placeholder': 'New task',
+        'add object label': 'Add task',
+        'rename object label': 'Rename task',
+        'delete object label': 'Delete task',
       },
       [meta.id]: {
         'plugin name': 'Spaces',
@@ -131,8 +151,10 @@ export const translations = [
           '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',
+        'remove from collection label': 'Remove from collection',
         'create object in system collection label': 'Add to system collection',
-        'add view to schema label': 'Add view to type',
+        'new type label': 'New type',
+        'add view to schema label': 'Add view for type',
         'space members label': 'Space members',
         'active space members heading': 'Online ({{count}})',
         'inactive space members heading': 'Offline ({{count}})',
@@ -238,6 +260,12 @@ export const translations = [
         'sync latency label': 'Latency',
         'sync upload label': 'Upload',
         'sync download label': 'Download',
+
+        'types section label': 'Types',
+        'collections section label': 'Collections',
+        'type collection all label': 'All',
+
+        'search placeholder': 'Search…',
       },
     },
   },

package/src/types/capabilities.ts

@@ -0,0 +1,73 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Atom } from '@effect-atom/atom-react';
+import type * as Effect from 'effect/Effect';
+import * as Schema from 'effect/Schema';
+
+import { Capability } from '@dxos/app-framework';
+import { type Space } from '@dxos/client/echo';
+import { type Database } from '@dxos/echo';
+import { type Collection } from '@dxos/echo';
+import { type PublicKey } from '@dxos/keys';
+import { type Operation } from '@dxos/operation';
+import { type Label } from '@dxos/ui-types';
+import { type ComplexMap, type Position } from '@dxos/util';
+
+import { meta } from '../meta';
+
+import { type ObjectViewerProps, type SpaceSettingsProps } from './types';
+
+export namespace SpaceCapabilities {
+  export const Settings = Capability.make<Atom.Writable<SpaceSettingsProps>>(`${meta.id}.capability.settings`);
+
+  /** Schema for persisted space plugin state. */
+  export const StateSchema = Schema.mutable(
+    Schema.Struct({
+      spaceNames: Schema.Record({ key: Schema.String, value: Schema.String }),
+      enabledEdgeReplication: Schema.Boolean,
+    }),
+  );
+
+  export type SpaceState = Schema.Schema.Type<typeof StateSchema>;
+
+  /** Persisted state (stored in KVS/localStorage). */
+  export const State = Capability.make<Atom.Writable<SpaceState>>(`${meta.id}.capability.state`);
+
+  /** Ephemeral space plugin state (not persisted). */
+  export type SpaceEphemeralState = {
+    awaiting: string | undefined;
+    sdkMigrationRunning: Record<string, boolean>;
+    navigableCollections: boolean;
+    viewersByObject: Record<string, ComplexMap<PublicKey, ObjectViewerProps>>;
+    viewersByIdentity: ComplexMap<PublicKey, Set<string>>;
+  };
+
+  /** Transient/ephemeral state (not persisted). */
+  export const EphemeralState = Capability.make<Atom.Writable<SpaceEphemeralState>>(
+    `${meta.id}.capability.ephemeral-state`,
+  );
+
+  export type SettingsSection = { id: string; label: Label; position?: Position };
+  export const SettingsSection = Capability.make<SettingsSection>(`${meta.id}.capability.settings-section`);
+
+  export type OnCreateSpace = (params: {
+    space: Space;
+    isDefault: boolean;
+    rootCollection: Collection.Collection;
+  }) => Effect.Effect<void, Error, Operation.Service>;
+  export const OnCreateSpace = Capability.make<OnCreateSpace>(`${meta.id}.capability.on-space-created`);
+
+  export type OnSchemaAdded = (params: {
+    db: Database.Database;
+    schema: Schema.Schema.AnyNoContext;
+    // TODO(wittjosiah): This is leaky.
+    show?: boolean;
+  }) => Effect.Effect<void, Error, Operation.Service>;
+  export const OnSchemaAdded = Capability.make<OnSchemaAdded>(`${meta.id}.capability.on-schema-added`);
+
+  // TODO(wittjosiah): Replace with migrations, this is not a sustainable solution.
+  export type HandleRepair = (params: { space: Space; isDefault: boolean }) => Promise<void>;
+  export const Repair = Capability.make<HandleRepair>(`${meta.id}.capability.repair`);
+}

package/src/types/events.ts

@@ -0,0 +1,16 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { ActivationEvent } from '@dxos/app-framework';
+import { AppActivationEvents } from '@dxos/app-toolkit';
+
+import { meta } from '../meta';
+
+export namespace SpaceEvents {
+  export const StateReady = AppActivationEvents.createStateEvent(`${meta.id}.event.state-ready`);
+  export const SetupSettingsPanel = ActivationEvent.make(`${meta.id}.event.setup-settings-panel`);
+  export const DefaultSpaceReady = ActivationEvent.make(`${meta.id}.event.default-space-ready`);
+  export const SpaceCreated = ActivationEvent.make(`${meta.id}.event.space-created`);
+  export const SchemaAdded = ActivationEvent.make(`${meta.id}.event.schema-added`);
+}

package/src/types/form.ts

@@ -5,7 +5,6 @@
 import * as Option from 'effect/Option';
 import * as Schema from 'effect/Schema';
 
-import { type Client } from '@dxos/client';
 import { type Space } from '@dxos/client/echo';
 import { Type } from '@dxos/echo';
 import { EntityKind, SystemTypeAnnotation, createAnnotationHelper, getTypeAnnotation } from '@dxos/echo/internal';
@@ -13,7 +12,6 @@ import { EntityKind, SystemTypeAnnotation, createAnnotationHelper, getTypeAnnota
 export const TypeInputOptions = Schema.Struct({
   location: Schema.Array(Schema.Literal('database', 'runtime')),
   kind: Schema.Array(Schema.Literal('system', 'user')),
-  registered: Schema.Array(Schema.Literal('registered', 'unregistered')),
 });
 
 export type TypeInputOptions = Schema.Schema.Type<typeof TypeInputOptions>;
@@ -24,51 +22,40 @@ export type TypeInputOptions = Schema.Schema.Type<typeof TypeInputOptions>;
 export const TypeInputOptionsAnnotationId = Symbol.for('@dxos/schema/annotation/TypeInputOptions');
 export const TypeInputOptionsAnnotation = createAnnotationHelper<TypeInputOptions>(TypeInputOptionsAnnotationId);
 
-// TODO(wittjosiah): This is way to complicated and needs to be simplified.
-export const getTypenames = ({
-  annotation,
-  space,
-  client,
-}: {
-  annotation: TypeInputOptions;
-  space?: Space;
-  client: Client;
-}) => {
+// TODO(wittjosiah): This is too complicated and needs to be simplified.
+export const getTypenames = ({ annotation, space }: { annotation: TypeInputOptions; space?: Space }) => {
   const includeRuntime = annotation.location.includes('runtime');
   const includeDatabase = annotation.location.includes('database');
   const includeSystemType = annotation.kind.includes('system');
   const includeUserType = annotation.kind.includes('user');
-  const includeRegistered = annotation.registered.includes('registered');
-  const includeUnregistered = annotation.registered.includes('unregistered');
 
-  const runtimeTypenames = includeRuntime
-    ? client.graph.schemaRegistry.schemas
-        .filter((schema) => {
-          const relation = getTypeAnnotation(schema)?.kind === EntityKind.Relation;
-          if (relation) {
-            return includeSystemType;
-          }
-
-          const system = SystemTypeAnnotation.get(schema).pipe(Option.getOrElse(() => false));
-          if (system) {
-            return includeSystemType;
-          }
-
-          return includeUserType;
-        })
-        .filter((schema) => {
-          const registered = space?.properties.staticRecords?.includes(Type.getTypename(schema));
-          return registered ? includeRegistered : includeUnregistered;
-        })
-        .map((schema) => Type.getTypename(schema))
-    : [];
+  const runtimeTypenames =
+    includeRuntime && space
+      ? space.db.schemaRegistry
+          .query({ location: ['runtime'] })
+          .runSync()
+          .filter((schema) => {
+            const relation = getTypeAnnotation(schema)?.kind === EntityKind.Relation;
+            if (relation) {
+              return includeSystemType;
+            }
+
+            const system = SystemTypeAnnotation.get(schema).pipe(Option.getOrElse(() => false));
+            if (system) {
+              return includeSystemType;
+            }
+
+            return includeUserType;
+          })
+          .map((schema) => Type.getTypename(schema))
+      : [];
 
   const databaseTypenames =
-    includeDatabase && includeRegistered && space
+    includeDatabase && space
       ? space.db.schemaRegistry
-          .query()
+          .query({ location: ['database'] })
           .runSync()
-          .map((schema) => schema.typename)
+          .map((schema) => Type.getTypename(schema))
       : [];
 
   return Array.from(new Set<string>([...runtimeTypenames, ...databaseTypenames])).sort();

package/src/types/index.ts

@@ -2,5 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
+export * from './capabilities';
+export * from './events';
 export * from './form';
 export * from './types';