@dxos/plugin-space 0.8.4-main.fd6878d → 0.8.4-main.fffef41

package/src/hooks/useTypeOptions.ts

@@ -0,0 +1,59 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useMemo } from 'react';
+
+import { useCapabilities } from '@dxos/app-framework/react';
+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 { Collection, type TypenameAnnotation, getTypenames } from '@dxos/schema';
+
+import { SpaceCapabilities } from '../capabilities';
+
+const OMIT = [Collection.Collection.typename, Type.getTypename(Collection.QueryCollection)];
+
+export const useTypeOptions = ({ space, annotation }: { space?: Space; annotation: TypenameAnnotation[] }) => {
+  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,
+  });
+
+  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,11 @@
 // Copyright 2023 DXOS.org
 //
 
-import { StoredSchema } from '@dxos/echo-schema';
+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, View } from '@dxos/schema';
+import { Event, Organization, Person, Project, Task } from '@dxos/types';
 
 import { meta } from './meta';
 
@@ -12,7 +14,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,7 +23,7 @@ export const translations = [
         'rename object label': 'Rename collection',
         'delete object label': 'Delete collection',
       },
-      [DataType.QueryCollection.typename]: {
+      [Type.getTypename(Collection.QueryCollection)]: {
         'typename label': 'Smart Collection',
         'typename label_zero': 'Smart Collections',
         'typename label_one': 'Smart Collection',
@@ -39,7 +41,7 @@ export const translations = [
         'rename object label': 'Rename record type',
         'delete object label': 'Delete record type',
       },
-      [DataType.View.typename]: {
+      [Type.getTypename(View.View)]: {
         'typename label': 'View',
         'typename label_zero': 'Views',
         'typename label_one': 'View',
@@ -48,35 +50,35 @@ export const translations = [
         '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]: {
+      [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',
@@ -120,6 +122,7 @@ export const translations = [
         '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',
@@ -189,10 +192,12 @@ export const translations = [
         '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 Items',
 
         'row details no selection label': 'No objects selected',
         'companion selected objects label': 'Selected',
@@ -227,7 +232,18 @@ export const translations = [
         'archive space description':
           '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',
+        'backup space label': 'Backup',
+        'backup space description':
+          'Download a backup of the space. Contains all data in the space in an unencrypted format.',
+        'download backup': 'Download backup',
         'unarchive space label': 'Unarchive',
+
+        '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/types.ts

@@ -2,21 +2,22 @@
 // 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 { type BaseObject, EchoSchema, StoredSchema, type TypedObject } from '@dxos/echo-schema';
+import { type Obj, QueryAST, Type } from '@dxos/echo';
+import { type BaseObject, EchoSchema, StoredSchema } from '@dxos/echo/internal';
 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, TypenameAnnotationId, View } from '@dxos/schema';
 import { type ComplexMap } from '@dxos/util';
 
-import { SPACE_PLUGIN } from '../meta';
+import { meta } from '../meta';
+
+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 = {
@@ -105,8 +106,7 @@ export const SpaceForm = Schema.Struct({
 });
 
 export type ObjectForm<T extends BaseObject = BaseObject> = {
-  // TODO(dmaretskyi): Change to Schema.Schema.AnyNoContext
-  objectSchema: TypedObject;
+  objectSchema: Schema.Schema.AnyNoContext;
   formSchema?: Schema.Schema<T, any>;
   hidden?: boolean;
   getIntent: (props: T, options: { space: Space }) => AnyIntentChain;
@@ -114,7 +114,7 @@ export type ObjectForm<T extends BaseObject = BaseObject> = {
 
 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,6 +217,16 @@ 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(
@@ -230,6 +240,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,8 +250,13 @@ 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.
@@ -251,7 +268,7 @@ export namespace SpaceAction {
 
   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 +286,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 +300,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 +328,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 +338,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 +357,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,17 +376,15 @@ 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'],
-      }),
-    ),
+    typename: Schema.String.annotations({
+      [TypenameAnnotationId]: ['object-form'],
+    }),
   });
 
   export class CreateQueryCollection extends Schema.TaggedClass<CreateQueryCollection>()(
@@ -374,7 +392,8 @@ export namespace CollectionAction {
     {
       input: QueryCollectionForm,
       output: Schema.Struct({
-        object: DataType.QueryCollection,
+        // TODO(wittjosiah): Remove cast.
+        object: EchoObjectSchema, // Collection.QueryCollection,
       }),
     },
   ) {}