@dxos/plugin-space 0.8.4-main.2e9d522 → 0.8.4-main.3c1ae3b

package/src/hooks/useTypeOptions.ts

@@ -0,0 +1,25 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useMemo } from 'react';
+
+import { type Space } from '@dxos/react-client/echo';
+import { useTranslation } from '@dxos/react-ui';
+
+import { type TypeInputOptions, getTypenames } from '../types';
+
+export const useTypeOptions = ({ space, annotation }: { space?: Space; annotation: TypeInputOptions }) => {
+  const { t } = useTranslation();
+  const typenames = getTypenames({ annotation, space });
+  return useMemo(
+    () =>
+      typenames
+        .map((typename) => ({
+          value: typename,
+          label: t('typename label', { ns: typename, defaultValue: typename }),
+        }))
+        .toSorted((a, b) => a.label.localeCompare(b.label)),
+    [t, typenames],
+  );
+};

package/src/index.ts

@@ -6,6 +6,7 @@ export { SpaceCapabilities } from './capabilities';
 export { SpaceEvents } from './events';
 
 export * from './components';
+export * from './helpers';
 export * from './hooks';
 export * from './meta';
 export * from './SpacePlugin';

package/src/meta.ts

@@ -3,11 +3,14 @@
 //
 
 import { type PluginMeta } from '@dxos/app-framework';
-
-export const SPACE_PLUGIN = 'dxos.org/plugin/space';
+import { trim } from '@dxos/util';
 
 export const meta: PluginMeta = {
-  id: SPACE_PLUGIN,
+  id: 'dxos.org/plugin/space',
   name: 'Spaces',
+  description: trim`
+    Core workspace container system for organizing and sharing collaborative environments.
+    Create, manage, and share spaces with granular access control and invitation management.
+  `,
   icon: 'ph--planet--regular',
 };

package/src/translations.ts

@@ -2,9 +2,10 @@
 // Copyright 2023 DXOS.org
 //
 
-import { StoredSchema } from '@dxos/echo-schema';
+import { Type } from '@dxos/echo';
 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';
 
@@ -12,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',
@@ -20,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',
       },
-      [DataType.QueryCollection.typename]: {
-        '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',
-      },
-      [DataType.View.typename]: {
-        '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',
       },
-      [DataType.Project.typename]: {
+      [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',
@@ -98,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',
@@ -116,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}})',
@@ -159,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',
@@ -179,20 +170,22 @@ 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',
         'clear input label': 'Clear',
         'expose object label': 'Expose in navtree',
+        'add tag label': 'Add tag',
         'advanced settings label': 'Advanced',
         'foreign keys': 'Foreign Keys',
         'add key': 'Add Key',
         'open space settings label': 'Open settings',
+        'related objects label': 'Related Objects',
 
         'row details no selection label': 'No objects selected',
         'companion selected objects label': 'Selected',
@@ -214,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': 'Schema',
-        'schema verbose label': 'Manage schema',
-        'schema description': 'You can manage all of the schema stored within this space here.',
-        'no schemas found message': 'No schemas 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.',
@@ -228,6 +221,23 @@ export const translations = [
           'Archiving a space will remove it from the sidebar and stop replicating updates, but will not delete the data. You can unarchive it by enabling archived spaces in the app settings.',
         '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',
       },
     },
   },

package/src/types/form.ts

@@ -0,0 +1,69 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Option from 'effect/Option';
+import * as Schema from 'effect/Schema';
+
+import { type Space } from '@dxos/client/echo';
+import { Type } from '@dxos/echo';
+import { EntityKind, SystemTypeAnnotation, createAnnotationHelper, getTypeAnnotation } from '@dxos/echo/internal';
+
+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>;
+
+/**
+ * Used in forms to identify the field representing an object's type and determine which types are shown as options.
+ */
+export const TypeInputOptionsAnnotationId = Symbol.for('@dxos/schema/annotation/TypeInputOptions');
+export const TypeInputOptionsAnnotation = createAnnotationHelper<TypeInputOptions>(TypeInputOptionsAnnotationId);
+
+// 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 && 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;
+          })
+          .filter((schema) => {
+            const registered = space?.properties.staticRecords?.includes(Type.getTypename(schema));
+            return registered ? includeRegistered : includeUnregistered;
+          })
+          .map((schema) => Type.getTypename(schema))
+      : [];
+
+  const databaseTypenames =
+    includeDatabase && includeRegistered && space
+      ? space.db.schemaRegistry
+          .query({ location: ['database'] })
+          .runSync()
+          .map((schema) => Type.getTypename(schema))
+      : [];
+
+  return Array.from(new Set<string>([...runtimeTypenames, ...databaseTypenames])).sort();
+};

package/src/types/index.ts

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

package/src/types/types.ts

@@ -2,21 +2,23 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 
 import { type AnyIntentChain } from '@dxos/app-framework';
-import { type Obj, Type } from '@dxos/echo';
-import { EchoSchema, StoredSchema, type TypedObject, type BaseObject } from '@dxos/echo-schema';
+import { type Obj, QueryAST, Type } from '@dxos/echo';
 import { type PublicKey } from '@dxos/react-client';
 // TODO(wittjosiah): This pulls in full client.
 import { EchoObjectSchema, ReactiveObjectSchema, type Space, SpaceSchema } from '@dxos/react-client/echo';
 import { CancellableInvitationObservable, Invitation } from '@dxos/react-client/invitations';
-import { DataType, FieldSchema, TypenameAnnotationId } from '@dxos/schema';
+import { Collection, FieldSchema, View } from '@dxos/schema';
 import { type ComplexMap } from '@dxos/util';
 
-import { SPACE_PLUGIN } from '../meta';
+import { meta } from '../meta';
+
+import { TypeInputOptionsAnnotation } from './form';
+
+export const SPACE_DIRECTORY_HANDLE = `${meta.id}/directory`;
 
-export const SPACE_DIRECTORY_HANDLE = 'dxos.org/plugin/space/directory';
 export const SPACE_TYPE = 'dxos.org/type/Space';
 
 export type ObjectViewerProps = {
@@ -81,7 +83,7 @@ export type SpaceSettingsProps = Schema.Schema.Type<typeof SpaceSettingsSchema>;
 
 export type SerializerMap = Record<string, TypedObjectSerializer>;
 
-export interface TypedObjectSerializer<T extends Obj.Any = Type.Expando> {
+export interface TypedObjectSerializer<T extends Obj.Any = Obj.Any> {
   serialize(params: { object: T }): Promise<string>;
 
   /**
@@ -92,29 +94,21 @@ export interface TypedObjectSerializer<T extends Obj.Any = Type.Expando> {
   deserialize(params: { content: string; space: Space; newId?: boolean }): Promise<T>;
 }
 
+export type CreateObjectIntent = (props: any, options: { space: Space }) => AnyIntentChain;
+
 // TODO(burdon): Move to FormatEnum or SDK.
 export const IconAnnotationId = Symbol.for('@dxos/plugin-space/annotation/Icon');
 export const HueAnnotationId = Symbol.for('@dxos/plugin-space/annotation/Hue');
 
+// TOOD(burdon): Use SpacePropertiesSchema.
 export const SpaceForm = Schema.Struct({
   name: Schema.optional(Schema.String.annotations({ title: 'Name' })),
   icon: Schema.optional(Schema.String.annotations({ title: 'Icon', [IconAnnotationId]: true })),
   hue: Schema.optional(Schema.String.annotations({ title: 'Color', [HueAnnotationId]: true })),
-  // TODO(wittjosiah): Make optional with default value.
-  edgeReplication: Schema.Boolean.annotations({ title: 'Enable EDGE Replication' }),
+  edgeReplication: Schema.optional(Schema.Boolean.annotations({ title: 'Enable EDGE Replication' })),
 });
 
-export type ObjectForm<T extends BaseObject = BaseObject> = {
-  // TODO(dmaretskyi): Change to Schema.Schema.AnyNoContext
-  objectSchema: TypedObject;
-  formSchema?: Schema.Schema<T, any>;
-  hidden?: boolean;
-  getIntent: (props: T, options: { space: Space }) => AnyIntentChain;
-};
-
-export const defineObjectForm = <T extends BaseObject>(form: ObjectForm<T>) => form;
-
-export const SPACE_ACTION = `${SPACE_PLUGIN}/action`;
+export const SPACE_ACTION = `${meta.id}/action`;
 
 export namespace SpaceAction {
   export class OpenCreateSpace extends Schema.TaggedClass<OpenCreateSpace>()(`${SPACE_ACTION}/open-create-space`, {
@@ -217,12 +211,26 @@ export namespace SpaceAction {
     output: Schema.Boolean,
   }) {}
 
+  export class Snapshot extends Schema.TaggedClass<Snapshot>()(`${SPACE_ACTION}/snapshot`, {
+    input: Schema.Struct({
+      space: SpaceSchema,
+      query: QueryAST.Query.pipe(Schema.optional),
+    }),
+    output: Schema.Struct({
+      snapshot: Schema.instanceOf(Blob),
+    }),
+  }) {}
+
   export const StoredSchemaForm = Schema.Struct({
     name: Schema.optional(Schema.String),
-    typename: Schema.optional(
-      Schema.String.annotations({
-        [TypenameAnnotationId]: ['unused-static'],
+    typename: Schema.String.pipe(
+      Schema.annotations({ title: 'Select type (leave blank to create a new type)' }),
+      TypeInputOptionsAnnotation.set({
+        location: ['runtime'],
+        kind: ['user'],
+        registered: ['unregistered'],
       }),
+      Schema.optional,
     ),
   });
 
@@ -230,6 +238,8 @@ export namespace SpaceAction {
     input: Schema.Struct({
       space: SpaceSchema,
       typename: Schema.String,
+      // TODO(wittjosiah): This is leaky.
+      show: Schema.optional(Schema.Boolean),
     }),
     output: Schema.Struct({}),
   }) {}
@@ -238,20 +248,25 @@ export namespace SpaceAction {
     input: Schema.Struct({
       space: SpaceSchema,
       name: Schema.optional(Schema.String),
+      typename: Schema.optional(Schema.String),
+      // TODO(wittjosiah): Semantic version format.
+      version: Schema.optional(Schema.String),
       // TODO(wittjosiah): Schema for schema?
       schema: Schema.Any,
+      // TODO(wittjosiah): This is leaky.
+      show: Schema.optional(Schema.Boolean),
     }),
     output: Schema.Struct({
       // TODO(wittjosiah): ObjectId.
       id: Schema.String,
-      object: StoredSchema,
-      schema: Schema.instanceOf(EchoSchema),
+      object: Type.PersistentType,
+      schema: Schema.instanceOf(Type.RuntimeType),
     }),
   }) {}
 
   export class DeleteField extends Schema.TaggedClass<DeleteField>()(`${SPACE_ACTION}/delete-field`, {
     input: Schema.Struct({
-      view: DataType.View,
+      view: View.View,
       fieldId: Schema.String,
       // TODO(wittjosiah): Separate fields for undo data?
       deletionData: Schema.optional(
@@ -269,8 +284,10 @@ export namespace SpaceAction {
 
   export class OpenCreateObject extends Schema.TaggedClass<OpenCreateObject>()(`${SPACE_ACTION}/open-create-object`, {
     input: Schema.Struct({
-      target: Schema.Union(SpaceSchema, DataType.Collection),
+      target: Schema.Union(SpaceSchema, Collection.Collection),
+      views: Schema.optional(Schema.Boolean),
       typename: Schema.optional(Schema.String),
+      initialFormValues: Schema.optional(Schema.Any),
       navigable: Schema.optional(Schema.Boolean),
       // TODO(wittjosiah): This is a function, is there a better way to handle this?
       onCreateObject: Schema.optional(Schema.Any),
@@ -281,7 +298,7 @@ export namespace SpaceAction {
   export class AddObject extends Schema.TaggedClass<AddObject>()(`${SPACE_ACTION}/add-object`, {
     input: Schema.Struct({
       object: ReactiveObjectSchema,
-      target: Schema.Union(SpaceSchema, DataType.Collection),
+      target: Schema.Union(SpaceSchema, Collection.Collection),
       hidden: Schema.optional(Schema.Boolean),
     }),
     output: Schema.Struct({
@@ -309,7 +326,7 @@ export namespace SpaceAction {
 
   export const DeletionData = Schema.Struct({
     objects: Schema.Array(EchoObjectSchema),
-    parentCollection: DataType.Collection,
+    parentCollection: Collection.Collection,
     indices: Schema.Array(Schema.Number),
     nestedObjectsList: Schema.Array(Schema.Array(EchoObjectSchema)),
     wasActive: Schema.Array(Schema.String),
@@ -319,8 +336,9 @@ export namespace SpaceAction {
 
   export class RemoveObjects extends Schema.TaggedClass<RemoveObjects>()(`${SPACE_ACTION}/remove-objects`, {
     input: Schema.Struct({
-      objects: Schema.Array(EchoObjectSchema),
-      target: Schema.optional(DataType.Collection),
+      // TODO(wittjosiah): Should be Schema.Union(Type.Obj, Type.Relation).
+      objects: Schema.Array(ReactiveObjectSchema),
+      target: Schema.optional(Collection.Collection),
       deletionData: Schema.optional(DeletionData),
     }),
     output: Schema.Void,
@@ -337,7 +355,7 @@ export namespace SpaceAction {
   export class DuplicateObject extends Schema.TaggedClass<DuplicateObject>()(`${SPACE_ACTION}/duplicate-object`, {
     input: Schema.Struct({
       object: EchoObjectSchema,
-      target: Schema.Union(SpaceSchema, DataType.Collection),
+      target: Schema.Union(SpaceSchema, Collection.Collection),
     }),
     output: Schema.Void,
   }) {}
@@ -356,26 +374,7 @@ export namespace CollectionAction {
       name: Schema.optional(Schema.String),
     }),
     output: Schema.Struct({
-      object: DataType.Collection,
+      object: Collection.Collection,
     }),
   }) {}
-
-  export const QueryCollectionForm = Schema.Struct({
-    name: Schema.optional(Schema.String),
-    typename: Schema.optional(
-      Schema.String.annotations({
-        [TypenameAnnotationId]: ['object-form'],
-      }),
-    ),
-  });
-
-  export class CreateQueryCollection extends Schema.TaggedClass<CreateQueryCollection>()(
-    'dxos.org/plugin/collection/action/create-query-collection',
-    {
-      input: QueryCollectionForm,
-      output: Schema.Struct({
-        object: DataType.QueryCollection,
-      }),
-    },
-  ) {}
 }