@dxos/plugin-space 0.8.3 → 0.8.4-main.1da679c

package/src/translations.ts

@@ -3,19 +3,24 @@
 //
 
 import { Type } from '@dxos/echo';
+import { StoredSchema } from '@dxos/echo-schema';
+import { type Resource } from '@dxos/react-ui';
 import { DataType } from '@dxos/schema';
 
-import { SPACE_PLUGIN } from './meta';
+import { meta } from './meta';
 
-export default [
+// TODO(burdon): Change to single Resource?
+export const translations = [
   {
     'en-US': {
-      [Type.getTypename(DataType.Collection)]: {
+      [DataType.Collection.typename]: {
         'typename label': 'Collection',
         'typename label_zero': 'Collections',
         'typename label_one': 'Collection',
         'typename label_other': 'Collections',
         'object name placeholder': 'New collection',
+        'rename object label': 'Rename collection',
+        'delete object label': 'Delete collection',
       },
       [Type.getTypename(DataType.QueryCollection)]: {
         'typename label': 'Smart Collection',
@@ -23,8 +28,63 @@ export default [
         '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',
       },
-      [SPACE_PLUGIN]: {
+      [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]: {
+        'typename label': 'Event',
+        'typename label_zero': 'Events',
+        'typename label_one': 'Event',
+        'typename label_other': 'Events',
+        'object name placeholder': 'New event',
+      },
+      [DataType.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]: {
+        'typename label': 'Person',
+        'typename label_zero': 'People',
+        'typename label_one': 'Person',
+        'typename label_other': 'People',
+        'object name placeholder': 'New person',
+      },
+      [Type.getTypename(DataType.Project)]: {
+        'typename label': 'Project',
+        'typename label_zero': 'Projects',
+        'typename label_one': 'Project',
+        'typename label_other': 'Projects',
+        'object name placeholder': 'New project',
+      },
+      [DataType.Task.typename]: {
+        'typename label': 'Task',
+        'typename label_zero': 'Tasks',
+        'typename label_one': 'Task',
+        'typename label_other': 'Tasks',
+        'object name placeholder': 'New task',
+      },
+      [meta.id]: {
         'plugin name': 'Spaces',
         'first run message': 'Nothing selected.',
         'create space label': 'Create space',
@@ -51,6 +111,7 @@ export default [
         'confirm restore title': 'Overwrite files in this space?',
         'confirm restore body': 'Restoring from a backup will overwrite the contents of any documents that match.',
         'upload file message': 'Drag file here or click to browse',
+        'object name placeholder': 'Object',
         'object placeholder': 'Type a title here…',
         'personal space label': 'Personal Space',
         'spaces label': 'Spaces',
@@ -134,6 +195,10 @@ export default [
         'add key': 'Add Key',
         'open space settings label': 'Open settings',
 
+        'row details no selection label': 'No objects selected',
+        'companion selected objects label': 'Selected',
+        'field deleted label': 'Field deleted',
+
         'members panel label': 'Members',
         'members verbose label': 'Manage space members',
         'members description': 'You can view the current status of space members here as well as invite new members.',
@@ -150,10 +215,10 @@ export default [
         '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': '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',
         '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.',
@@ -167,4 +232,4 @@ export default [
       },
     },
   },
-];
+] as const satisfies Resource[];

package/src/types/types.ts

@@ -5,13 +5,13 @@
 import { Schema } from 'effect';
 
 import { type AnyIntentChain } from '@dxos/app-framework';
-import { Type, type Obj } from '@dxos/echo';
-import { type BaseObject, type TypedObject } from '@dxos/echo-schema';
+import { type Obj, Type } from '@dxos/echo';
+import { type BaseObject, EchoSchema, StoredSchema, type TypedObject } from '@dxos/echo-schema';
 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, TypenameAnnotationId } from '@dxos/schema';
+import { DataType, FieldSchema, TypenameAnnotationId } from '@dxos/schema';
 import { type ComplexMap } from '@dxos/util';
 
 import { SPACE_PLUGIN } from '../meta';
@@ -217,11 +217,68 @@ export namespace SpaceAction {
     output: Schema.Boolean,
   }) {}
 
+  export const StoredSchemaForm = Schema.Struct({
+    name: Schema.optional(Schema.String),
+    typename: Schema.optional(
+      Schema.String.annotations({
+        [TypenameAnnotationId]: ['unused-static'],
+      }),
+    ),
+  });
+
+  export class UseStaticSchema extends Schema.TaggedClass<UseStaticSchema>()(`${SPACE_ACTION}/use-static-schema`, {
+    input: Schema.Struct({
+      space: SpaceSchema,
+      typename: Schema.String,
+    }),
+    output: Schema.Struct({}),
+  }) {}
+
+  export class AddSchema extends Schema.TaggedClass<AddSchema>()(`${SPACE_ACTION}/add-schema`, {
+    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,
+    }),
+    output: Schema.Struct({
+      // TODO(wittjosiah): ObjectId.
+      id: Schema.String,
+      object: StoredSchema,
+      schema: Schema.instanceOf(EchoSchema),
+    }),
+  }) {}
+
+  export class DeleteField extends Schema.TaggedClass<DeleteField>()(`${SPACE_ACTION}/delete-field`, {
+    input: Schema.Struct({
+      view: DataType.View,
+      fieldId: Schema.String,
+      // TODO(wittjosiah): Separate fields for undo data?
+      deletionData: Schema.optional(
+        Schema.Struct({
+          field: FieldSchema,
+          // TODO(wittjosiah): This creates a type error.
+          // props: PropertySchema,
+          props: Schema.Any,
+          index: Schema.Number,
+        }),
+      ),
+    }),
+    output: Schema.Void,
+  }) {}
+
   export class OpenCreateObject extends Schema.TaggedClass<OpenCreateObject>()(`${SPACE_ACTION}/open-create-object`, {
     input: Schema.Struct({
       target: Schema.Union(SpaceSchema, DataType.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),
     }),
     output: Schema.Void,
   }) {}
@@ -233,6 +290,7 @@ export namespace SpaceAction {
       hidden: Schema.optional(Schema.Boolean),
     }),
     output: Schema.Struct({
+      // TODO(wittjosiah): ObjectId.
       id: Schema.String,
       subject: Schema.Array(Schema.String),
       object: EchoObjectSchema,
@@ -309,11 +367,9 @@ export namespace CollectionAction {
 
   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>()(
@@ -321,7 +377,8 @@ export namespace CollectionAction {
     {
       input: QueryCollectionForm,
       output: Schema.Struct({
-        object: DataType.QueryCollection,
+        // TODO(wittjosiah): Remove cast.
+        object: EchoObjectSchema, // DataType.QueryCollection,
       }),
     },
   ) {}

package/src/util.tsx

@@ -5,28 +5,28 @@
 import { Rx } from '@effect-rx/rx-react';
 import { pipe } from 'effect';
 
-import { chain, createIntent, LayoutAction, type PromiseIntentDispatcher } from '@dxos/app-framework';
+import { LayoutAction, type PromiseIntentDispatcher, chain, createIntent } from '@dxos/app-framework';
 import { Obj, Ref, Type } from '@dxos/echo';
-import { EXPANDO_TYPENAME } from '@dxos/echo-schema';
+import { type AnyEchoObject, EXPANDO_TYPENAME } from '@dxos/echo-schema';
 import { invariant } from '@dxos/invariant';
 import { Migrations } from '@dxos/migrations';
 import {
   ACTION_GROUP_TYPE,
   ACTION_TYPE,
-  type ReadableGraph,
   type ActionData,
   type InvokeParams,
   type Node,
   type NodeArg,
+  type ReadableGraph,
   isGraphNode,
 } from '@dxos/plugin-graph';
-import { fullyQualifiedId, getSpace, type QueryResult, SpaceState, type Space, isSpace } from '@dxos/react-client/echo';
+import { type QueryResult, type Space, SpaceState, fullyQualifiedId, getSpace, isSpace } from '@dxos/react-client/echo';
 import { ATTENDABLE_PATH_SEPARATOR } from '@dxos/react-ui-attention';
 import { type TreeData } from '@dxos/react-ui-list';
-import { DataType } from '@dxos/schema';
+import { DataType, typenameFromQuery } from '@dxos/schema';
 
 import { SPACE_PLUGIN } from './meta';
-import { SpaceAction, SPACE_TYPE, type ObjectForm } from './types';
+import { type ObjectForm, SPACE_TYPE, SpaceAction } from './types';
 
 export const SPACES = `${SPACE_PLUGIN}-spaces`;
 export const COMPOSER_SPACE_LOCK = 'dxos.org/plugin/space/lock';
@@ -36,7 +36,7 @@ export const SHARED = 'shared-spaces';
 /**
  * Convert a query result to an Rx value of the objects.
  */
-export const rxFromQuery = <T extends Obj.Any>(query: QueryResult<T>): Rx.Rx<T[]> => {
+export const rxFromQuery = <T extends AnyEchoObject>(query: QueryResult<T>): Rx.Rx<T[]> => {
   return Rx.make((get) => {
     const unsubscribe = query.subscribe((result) => {
       get.setSelf(result.objects);
@@ -145,16 +145,15 @@ const getQueryCollectionNodePartials = ({
   space: Space;
   resolve: (typename: string) => Record<string, any>;
 }) => {
+  const typename = typenameFromQuery(collection.query);
   return {
-    icon: collection.query.typename && resolve(collection.query.typename)?.icon,
+    icon: typename && resolve(typename)?.icon,
     acceptPersistenceClass: new Set(['echo']),
     acceptPersistenceKey: new Set([space.id]),
     role: 'branch',
     canDrop: (source: TreeData) => {
       return (
-        isGraphNode(source.item) &&
-        Obj.isObject(source.item.data) &&
-        Obj.getTypename(source.item.data) === collection.query.typename
+        isGraphNode(source.item) && Obj.isObject(source.item.data) && Obj.getTypename(source.item.data) === typename
       );
     },
     onTransferStart: (child: Node<Obj.Any>, index?: number) => {
@@ -166,6 +165,31 @@ const getQueryCollectionNodePartials = ({
   };
 };
 
+const getSchemaGraphNodePartials = () => {
+  return {
+    role: 'branch',
+    canDrop: () => false,
+  };
+};
+
+const getViewGraphNodePartials = ({
+  view,
+  resolve,
+}: {
+  view: DataType.View;
+  resolve: (typename: string) => Record<string, any>;
+}) => {
+  const presentation = view.presentation.target;
+  const typename = presentation ? Obj.getTypename(presentation) : undefined;
+  const metadata = typename ? resolve(typename) : {};
+
+  return {
+    label: view.name || ['object name placeholder', { ns: typename, default: 'New view' }],
+    icon: metadata.icon,
+    canDrop: () => false,
+  };
+};
+
 const checkPendingMigration = (space: Space) => {
   return (
     space.state.get() === SpaceState.SPACE_REQUIRES_MIGRATION ||
@@ -190,7 +214,7 @@ export const constructSpaceNode = ({
 }) => {
   const hasPendingMigration = checkPendingMigration(space);
   const collection =
-    space.state.get() === SpaceState.SPACE_READY && space.properties[Type.getTypename(DataType.Collection)]?.target;
+    space.state.get() === SpaceState.SPACE_READY && space.properties[DataType.Collection.typename]?.target;
   const partials =
     space.state.get() === SpaceState.SPACE_READY && Obj.instanceOf(DataType.Collection, collection)
       ? getCollectionGraphNodePartials({ collection, space, resolve })
@@ -331,34 +355,129 @@ export const constructSpaceActions = ({
   return actions;
 };
 
+export const createStaticSchemaNode = ({ schema, space }: { schema: Type.Obj.Any; space: Space }) => {
+  return {
+    id: `${space.id}/${Type.getTypename(schema)}`,
+    type: `${SPACE_PLUGIN}/static-schema`,
+    data: schema,
+    properties: {
+      label: ['typename label', { ns: Type.getTypename(schema), default: Type.getTypename(schema) }],
+      icon: 'ph--database--regular',
+      role: 'branch',
+      canDrop: () => false,
+      space,
+    },
+  };
+};
+
+export const createStaticSchemaActions = ({
+  schema,
+  space,
+  dispatch,
+  deletable,
+}: {
+  schema: Type.Obj.Any;
+  space: Space;
+  dispatch: PromiseIntentDispatcher;
+  deletable: boolean;
+}) => {
+  const getId = (id: string) => `${space.id}/${Type.getTypename(schema)}/${id}`;
+
+  const actions: NodeArg<ActionData>[] = [
+    {
+      id: getId(SpaceAction.AddObject._tag),
+      type: ACTION_TYPE,
+      data: async () => {
+        await dispatch(
+          createIntent(SpaceAction.OpenCreateObject, {
+            target: space,
+            views: true,
+            initialFormValues: { typename: Type.getTypename(schema) },
+          }),
+        );
+      },
+      properties: {
+        label: ['add view to schema label', { ns: Type.getTypename(DataType.StoredSchema) }],
+        icon: 'ph--plus--regular',
+        disposition: 'list-item-primary',
+        testId: 'spacePlugin.addViewToSchema',
+      },
+    },
+    {
+      id: getId(SpaceAction.RenameObject._tag),
+      type: ACTION_TYPE,
+      data: async (params?: InvokeParams) => {
+        throw new Error('Not implemented');
+      },
+      properties: {
+        label: ['rename object label', { ns: Type.getTypename(DataType.StoredSchema) }],
+        icon: 'ph--pencil-simple-line--regular',
+        disabled: true,
+        disposition: 'list-item',
+        testId: 'spacePlugin.renameObject',
+      },
+    },
+    {
+      id: getId(SpaceAction.RemoveObjects._tag),
+      type: ACTION_TYPE,
+      data: async () => {
+        const index = space.properties.staticRecords.findIndex(
+          (typename: string) => typename === Type.getTypename(schema),
+        );
+        if (index > -1) {
+          space.properties.staticRecords.splice(index, 1);
+        }
+      },
+      properties: {
+        label: ['delete object label', { ns: Type.getTypename(DataType.StoredSchema) }],
+        icon: 'ph--trash--regular',
+        disposition: 'list-item',
+        disabled: !deletable,
+        testId: 'spacePlugin.deleteObject',
+      },
+    },
+  ];
+
+  return actions;
+};
+
 export const createObjectNode = ({
   space,
   object,
+  disposition,
   droppable = true,
   navigable = false,
   resolve,
 }: {
   space: Space;
   object: Obj.Any;
+  disposition?: string;
   droppable?: boolean;
   navigable?: boolean;
   resolve: (typename: string) => Record<string, any>;
 }) => {
   const type = Obj.getTypename(object);
   if (!type) {
-    return undefined;
+    return null;
   }
 
   const metadata = resolve(type);
-  if (Object.keys(metadata).length === 0) {
-    return undefined;
-  }
-
   const partials = Obj.instanceOf(DataType.Collection, object)
     ? getCollectionGraphNodePartials({ collection: object, space, resolve })
     : Obj.instanceOf(DataType.QueryCollection, object)
       ? getQueryCollectionNodePartials({ collection: object, space, resolve })
-      : metadata.graphProps;
+      : Obj.instanceOf(DataType.StoredSchema, object)
+        ? getSchemaGraphNodePartials()
+        : Obj.instanceOf(DataType.View, object)
+          ? getViewGraphNodePartials({ view: object, resolve })
+          : metadata.graphProps;
+
+  // TODO(wittjosiah): Obj.getLabel isn't triggering reactivity in some cases.
+  //   e.g., create new collection with no name and rename it.
+  const label = (object as any).name ||
+    Obj.getLabel(object) ||
+    // TODO(wittjosiah): Remove metadata labels.
+    metadata.label?.(object) || ['object name placeholder', { ns: type, default: 'New item' }];
 
   return {
     id: fullyQualifiedId(object),
@@ -366,10 +485,9 @@ export const createObjectNode = ({
     cacheable: ['label', 'icon', 'role'],
     data: object,
     properties: {
-      // TODO(burdon): Use annotation to get the name field.
-      label: metadata.label?.(object) ||
-        (object as any).name || ['object name placeholder', { ns: type, default: 'New object' }],
+      label,
       icon: metadata.icon ?? 'ph--placeholder--regular',
+      disposition,
       testId: 'spacePlugin.object',
       persistenceClass: 'echo',
       persistenceKey: space?.id,
@@ -386,21 +504,26 @@ export const constructObjectActions = ({
   graph,
   dispatch,
   objectForms,
+  deletable = true,
   navigable = false,
 }: {
   object: Obj.Any;
   graph: ReadableGraph;
   dispatch: PromiseIntentDispatcher;
   objectForms: ObjectForm<any>[];
+  deletable?: boolean;
   navigable?: boolean;
 }) => {
   const space = getSpace(object);
   invariant(space, 'Space not found');
+  const typename = Obj.getTypename(object);
+  invariant(typename, 'Object has no typename');
+
   const getId = (id: string) => `${id}/${fullyQualifiedId(object)}`;
 
   const queryCollection = Obj.instanceOf(DataType.QueryCollection, object) ? object : undefined;
   const matchingObjectForm = queryCollection
-    ? objectForms.find((form) => Type.getTypename(form.objectSchema) === queryCollection.query.typename)
+    ? objectForms.find((form) => Type.getTypename(form.objectSchema) === typenameFromQuery(queryCollection.query))
     : undefined;
 
   const actions: NodeArg<ActionData>[] = [
@@ -421,6 +544,29 @@ export const constructObjectActions = ({
           },
         ]
       : []),
+    ...(Obj.instanceOf(DataType.StoredSchema, object)
+      ? [
+          {
+            id: getId(SpaceAction.AddObject._tag),
+            type: ACTION_TYPE,
+            data: async () => {
+              await dispatch(
+                createIntent(SpaceAction.OpenCreateObject, {
+                  target: space,
+                  views: true,
+                  initialFormValues: { typename: object.typename },
+                }),
+              );
+            },
+            properties: {
+              label: ['add view to schema label', { ns: Type.getTypename(DataType.StoredSchema) }],
+              icon: 'ph--plus--regular',
+              disposition: 'list-item-primary',
+              testId: 'spacePlugin.addViewToSchema',
+            },
+          },
+        ]
+      : []),
     ...(matchingObjectForm
       ? [
           {
@@ -431,7 +577,7 @@ export const constructObjectActions = ({
                 await dispatch(
                   createIntent(SpaceAction.OpenCreateObject, {
                     target: space,
-                    typename: queryCollection?.query.typename,
+                    typename: queryCollection ? typenameFromQuery(queryCollection.query) : undefined,
                   }),
                 );
               } else {
@@ -460,10 +606,7 @@ export const constructObjectActions = ({
         await dispatch(createIntent(SpaceAction.RenameObject, { object, caller: params?.caller }));
       },
       properties: {
-        label: [
-          Obj.instanceOf(DataType.Collection, object) ? 'rename collection label' : 'rename object label',
-          { ns: SPACE_PLUGIN },
-        ],
+        label: ['rename object label', { ns: typename }],
         icon: 'ph--pencil-simple-line--regular',
         disposition: 'list-item',
         // TODO(wittjosiah): Not working.
@@ -483,18 +626,19 @@ export const constructObjectActions = ({
         await dispatch(createIntent(SpaceAction.RemoveObjects, { objects: [object], target: collection }));
       },
       properties: {
-        label: [
-          Obj.instanceOf(DataType.Collection, object) ? 'delete collection label' : 'delete object label',
-          { ns: SPACE_PLUGIN },
-        ],
+        label: ['delete object label', { ns: typename }],
         icon: 'ph--trash--regular',
         disposition: 'list-item',
+        disabled: !deletable,
         // TODO(wittjosiah): This is a browser shortcut.
         // keyBinding: object instanceof CollectionType ? undefined : 'shift+meta+Backspace',
         testId: 'spacePlugin.deleteObject',
       },
     },
-    ...(navigable || (!Obj.instanceOf(DataType.Collection, object) && !Obj.instanceOf(DataType.QueryCollection, object))
+    ...(navigable ||
+    (!Obj.instanceOf(DataType.Collection, object) &&
+      !Obj.instanceOf(DataType.QueryCollection, object) &&
+      !Obj.instanceOf(DataType.StoredSchema, object))
       ? [
           {
             id: getId('copy-link'),
@@ -564,7 +708,7 @@ export const cloneObject = async (
   newSpace: Space,
 ): Promise<Type.Expando> => {
   const schema = Obj.getSchema(object);
-  const typename = schema ? Type.getTypename(schema) ?? EXPANDO_TYPENAME : EXPANDO_TYPENAME;
+  const typename = schema ? (Type.getTypename(schema) ?? EXPANDO_TYPENAME) : EXPANDO_TYPENAME;
   const metadata = resolve(typename);
   const serializer = metadata.serializer;
   invariant(serializer, `No serializer for type: ${typename}`);