@dxos/plugin-space 0.8.4-main.72ec0f3 → 0.8.4-main.74a063c4e0

package/src/SpacePlugin.ts

@@ -2,22 +2,20 @@
 // Copyright 2025 DXOS.org
 //
 
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
 import * as Schema from 'effect/Schema';
 
-import {
-  Capabilities,
-  Events,
-  allOf,
-  contributes,
-  createIntent,
-  defineModule,
-  definePlugin,
-  oneOf,
-} from '@dxos/app-framework';
-import { Ref, Tag, Type } from '@dxos/echo';
-import { AttentionEvents } from '@dxos/plugin-attention';
-import { ClientCapabilities, ClientEvents } from '@dxos/plugin-client';
-import { Collection, DataTypes, StoredSchema, getTypenameFromQuery } from '@dxos/schema';
+import { ActivationEvent, ActivationEvents, Capability, Plugin } from '@dxos/app-framework';
+import { AppActivationEvents, AppPlugin } from '@dxos/app-toolkit';
+import { Annotation, Ref, Tag, Type } from '@dxos/echo';
+import { Collection } from '@dxos/echo';
+import { Operation } from '@dxos/operation';
+import { AttentionEvents } from '@dxos/plugin-attention/types';
+import { ClientEvents } from '@dxos/plugin-client/types';
+import { translations as componentsTranslations } from '@dxos/react-ui-components';
+import { translations as formTranslations } from '@dxos/react-ui-form';
+import { DataTypes, createDefaultSchema } from '@dxos/schema';
 import { translations as shellTranslations } from '@dxos/shell/react';
 import {
   AnchoredTo,
@@ -28,260 +26,241 @@ import {
   HasSubject,
   Organization,
   Person,
-  Project,
+  Pipeline,
   Task,
 } from '@dxos/types';
 
 import {
-  AppGraphBuilder,
   AppGraphSerializer,
   IdentityCreated,
-  IntentResolver,
+  Migrations,
+  NavigationHandler,
+  NavigationResolver,
+  OperationHandler,
+  UndoMappings,
   ReactRoot,
   ReactSurface,
-  SchemaDefs,
-  SpaceCapabilities,
+  Repair,
   SpaceSettings,
   SpaceState,
   SpacesReady,
-} from './capabilities';
-import { SpaceEvents } from './events';
-import { meta } from './meta';
-import { translations } from './translations';
-import { CollectionAction, SpaceAction, defineObjectForm } from './types';
-
-export type SpacePluginOptions = {
-  /**
-   * Base URL for the invitation link.
-   */
-  invitationUrl?: string;
-
-  /**
-   * Query parameter for the invitation code.
-   */
-  invitationParam?: string;
+  AppGraphBuilder,
+} from '#capabilities';
+import { meta } from '#meta';
+import { SpaceOperation } from '#operations';
+import { SpaceEvents } from '#types';
+import { type CreateObject, type SpacePluginOptions } from '#types';
 
-  /**
-   * Whether to send observability events.
-   */
-  observability?: boolean;
-};
+import { translations } from './translations';
 
-export const SpacePlugin = definePlugin<SpacePluginOptions>(
-  meta,
-  ({ invitationUrl = window.location.origin, invitationParam = 'spaceInvitationCode', observability = false }) => {
-    const createInvitationUrl = (invitationCode: string) => {
-      const baseUrl = new URL(invitationUrl);
-      baseUrl.searchParams.set(invitationParam, invitationCode);
-      return baseUrl.toString();
-    };
+export const SpacePlugin = Plugin.define<SpacePluginOptions>(meta).pipe(
+  AppPlugin.addMetadataModule({
+    metadata: [
+      {
+        id: Collection.Collection.typename,
+        metadata: {
+          icon: Annotation.IconAnnotation.get(Collection.Collection).pipe(Option.getOrThrow).icon,
+          iconHue: Annotation.IconAnnotation.get(Collection.Collection).pipe(Option.getOrThrow).hue ?? 'white',
+          // TODO(wittjosiah): Move out of metadata.
+          loadReferences: async (collection: Collection.Collection) => await Ref.Array.loadAll(collection.objects),
+          inputSchema: Schema.Struct({ name: Schema.optional(Schema.String) }),
+          createObject: ((props, options) =>
+            Effect.gen(function* () {
+              const object = Collection.make(props);
+              return yield* Operation.invoke(SpaceOperation.AddObject, {
+                object,
+                target: options.target,
+                hidden: false,
+                targetNodeId: options.targetNodeId,
+              });
+            })) satisfies CreateObject,
+        },
+      },
+      {
+        id: Type.getTypename(Type.PersistentType),
+        metadata: {
+          icon: Annotation.IconAnnotation.get(Type.PersistentType).pipe(Option.getOrThrow).icon,
+          iconHue: Annotation.IconAnnotation.get(Type.PersistentType).pipe(Option.getOrThrow).hue ?? 'white',
+          inputSchema: SpaceOperation.StoredSchemaForm,
+          createObject: ((props, options) =>
+            Effect.gen(function* () {
+              const result = yield* Operation.invoke(SpaceOperation.AddSchema, {
+                db: options.db,
+                name: props.name,
+                schema: createDefaultSchema(),
+              });
+              return {
+                id: result.id,
+                subject: [],
+                object: result.object,
+              };
+            })) satisfies CreateObject,
+        },
+      },
+      {
+        id: Organization.Organization.typename,
+        metadata: {
+          icon: Annotation.IconAnnotation.get(Organization.Organization).pipe(Option.getOrThrow).icon,
+          iconHue: Annotation.IconAnnotation.get(Organization.Organization).pipe(Option.getOrThrow).hue ?? 'white',
+          createObject: ((props, options) =>
+            Effect.gen(function* () {
+              const object = Organization.make(props);
+              return yield* Operation.invoke(SpaceOperation.AddObject, {
+                object,
+                target: options.target,
+                hidden: true,
+                targetNodeId: options.targetNodeId,
+              });
+            })) satisfies CreateObject,
+        },
+      },
+      {
+        id: Person.Person.typename,
+        metadata: {
+          icon: Annotation.IconAnnotation.get(Person.Person).pipe(Option.getOrThrow).icon,
+          iconHue: Annotation.IconAnnotation.get(Person.Person).pipe(Option.getOrThrow).hue ?? 'white',
+          createObject: ((props, options) =>
+            Effect.gen(function* () {
+              const object = Person.make(props);
+              return yield* Operation.invoke(SpaceOperation.AddObject, {
+                object,
+                target: options.target,
+                hidden: true,
+                targetNodeId: options.targetNodeId,
+              });
+            })) satisfies CreateObject,
+        },
+      },
+      {
+        id: Task.Task.typename,
+        metadata: {
+          icon: Annotation.IconAnnotation.get(Task.Task).pipe(Option.getOrThrow).icon,
+          iconHue: Annotation.IconAnnotation.get(Task.Task).pipe(Option.getOrThrow).hue ?? 'white',
+          inputSchema: Task.Task,
+          createObject: ((props, options) =>
+            Effect.gen(function* () {
+              const object = Task.make(props);
+              return yield* Operation.invoke(SpaceOperation.AddObject, {
+                object,
+                target: options.target,
+                hidden: true,
+                targetNodeId: options.targetNodeId,
+              });
+            })) satisfies CreateObject,
+        },
+      },
+    ],
+  }),
+  AppPlugin.addNavigationHandlerModule(({ invitationProp }) => ({
+    activate: () => NavigationHandler({ invitationProp }),
+  })),
+  AppPlugin.addNavigationResolverModule({ activatesOn: ClientEvents.ClientReady, activate: NavigationResolver }),
+  AppPlugin.addOperationHandlerModule({ activate: OperationHandler }),
+  AppPlugin.addReactRootModule({ activate: ReactRoot }),
+  AppPlugin.addSchemaModule({
+    schema: [
+      ...DataTypes,
+      AnchoredTo.AnchoredTo,
+      Employer.Employer,
+      Event.Event,
+      HasConnection.HasConnection,
+      HasRelationship.HasRelationship,
+      HasSubject.HasSubject,
+      Organization.Organization,
+      Person.Person,
+      Pipeline.Pipeline,
+      Tag.Tag,
+      Task.Task,
+    ],
+  }),
+  AppPlugin.addSettingsModule({ activate: SpaceSettings }),
+  AppPlugin.addTranslationsModule({
+    translations: [...translations, ...componentsTranslations, ...formTranslations, ...shellTranslations],
+  }),
+  Plugin.addModule({
+    // TODO(wittjosiah): Does not integrate with settings store.
+    //   Should this be a different event?
+    //   Should settings store be renamed to be more generic?
+    activatesOn: ActivationEvent.oneOf(AppActivationEvents.SetupSettings, AppActivationEvents.SetupAppGraph),
+    activatesAfter: [SpaceEvents.StateReady],
+    activate: SpaceState,
+  }),
+  Plugin.addModule(
+    ({
+      shareableLinkOrigin = typeof window !== 'undefined' ? window.location.origin : 'http://localhost',
+      invitationPath = '/',
+      invitationProp = 'spaceInvitationCode',
+    }) => {
+      const createInvitationUrl = (invitationCode: string) => {
+        const baseUrl = new URL(invitationPath || '/', shareableLinkOrigin);
+        baseUrl.searchParams.set(invitationProp, invitationCode);
+        return baseUrl.toString();
+      };
 
-    return [
-      defineModule({
-        id: `${meta.id}/module/state`,
-        // TODO(wittjosiah): Does not integrate with settings store.
-        //   Should this be a different event?
-        //   Should settings store be renamed to be more generic?
-        activatesOn: oneOf(Events.SetupSettings, Events.SetupAppGraph),
-        activatesAfter: [SpaceEvents.StateReady],
-        activate: SpaceState,
-      }),
-      defineModule({
-        id: `${meta.id}/module/settings`,
-        activatesOn: Events.SetupSettings,
-        activate: SpaceSettings,
-      }),
-      defineModule({
-        id: `${meta.id}/module/translations`,
-        activatesOn: Events.SetupTranslations,
-        activate: () => contributes(Capabilities.Translations, [...translations, ...shellTranslations]),
-      }),
-      defineModule({
-        id: `${meta.id}/module/metadata`,
-        activatesOn: Events.SetupMetadata,
-        activate: () => [
-          contributes(Capabilities.Metadata, {
-            id: Collection.Collection.typename,
-            metadata: {
-              icon: 'ph--cards-three--regular',
-              iconHue: 'neutral',
-              // TODO(wittjosiah): Move out of metadata.
-              loadReferences: async (collection: Collection.Collection) => await Ref.Array.loadAll(collection.objects),
-            },
-          }),
-          contributes(Capabilities.Metadata, {
-            id: Type.getTypename(Collection.QueryCollection),
-            metadata: {
-              label: (object: Collection.QueryCollection) => [
-                'typename label',
-                {
-                  ns: getTypenameFromQuery(object.query),
-                  count: 2,
-                  defaultValue: 'New smart collection',
-                },
-              ],
-              icon: 'ph--funnel-simple--regular',
-            },
-          }),
-          contributes(Capabilities.Metadata, {
-            id: Type.getTypename(StoredSchema),
-            metadata: {
-              icon: 'ph--database--regular',
-              iconHue: 'green',
-            },
-          }),
-          contributes(Capabilities.Metadata, {
-            id: Event.Event.typename,
-            metadata: {
-              icon: 'ph--calendar-dot--regular',
-            },
-          }),
-          contributes(Capabilities.Metadata, {
-            id: Organization.Organization.typename,
-            metadata: {
-              icon: 'ph--building-office--regular',
-            },
-          }),
-          contributes(Capabilities.Metadata, {
-            id: Person.Person.typename,
-            metadata: {
-              icon: 'ph--user--regular',
-            },
-          }),
-          contributes(Capabilities.Metadata, {
-            id: Task.Task.typename,
-            metadata: {
-              icon: 'ph--check-circle--regular',
-            },
-          }),
-        ],
-      }),
-      defineModule({
-        id: `${meta.id}/module/object-form`,
-        activatesOn: ClientEvents.SetupSchema,
-        activate: () => [
-          contributes(
-            SpaceCapabilities.ObjectForm,
-            defineObjectForm({
-              objectSchema: Collection.Collection,
-              formSchema: Schema.Struct({ name: Schema.optional(Schema.String) }),
-              getIntent: (props) => createIntent(CollectionAction.Create, props),
-            }),
-          ),
-          contributes(
-            SpaceCapabilities.ObjectForm,
-            defineObjectForm({
-              // TODO(wittjosiah): Remove cast.
-              objectSchema: Collection.QueryCollection as any,
-              formSchema: CollectionAction.QueryCollectionForm,
-              getIntent: (props) => createIntent(CollectionAction.CreateQueryCollection, props),
-            }),
-          ),
-          contributes(
-            SpaceCapabilities.ObjectForm,
-            defineObjectForm({
-              objectSchema: StoredSchema,
-              formSchema: SpaceAction.StoredSchemaForm,
-              getIntent: (props, options) =>
-                props.typename
-                  ? createIntent(SpaceAction.UseStaticSchema, { space: options.space, typename: props.typename })
-                  : createIntent(SpaceAction.AddSchema, {
-                      space: options.space,
-                      name: props.name,
-                      // TODO(burdon): Import createDefaultSchema when it's exported from @dxos/schema
-                      schema: Schema.Struct({
-                        title: Schema.optional(Schema.String),
-                        status: Schema.optional(Schema.Literal('todo', 'in-progress', 'done')),
-                        description: Schema.optional(Schema.String),
-                      }),
-                    }),
-            }),
-          ),
-        ],
-      }),
-      defineModule({
-        id: `${meta.id}/module/schema-defs`,
-        activatesOn: ClientEvents.ClientReady,
-        activatesBefore: [ClientEvents.SetupSchema],
-        activate: SchemaDefs,
-      }),
-      defineModule({
-        id: `${meta.id}/module/schema`,
-        activatesOn: ClientEvents.SetupSchema,
-        activate: () =>
-          contributes(ClientCapabilities.Schema, [
-            Tag.Tag,
-            Event.Event,
-            Organization.Organization,
-            Person.Person,
-            Project.Project,
-            Task.Task,
-            AnchoredTo.AnchoredTo,
-            Employer.Employer,
-            HasConnection.HasConnection,
-            HasRelationship.HasRelationship,
-            HasSubject.HasSubject,
-            ...DataTypes,
-          ]),
-      }),
-      defineModule({
-        id: `${meta.id}/module/whitelist-schema`,
-        activatesOn: ClientEvents.SetupSchema,
-        activate: () =>
-          contributes(ClientCapabilities.SchemaWhiteList, [
-            Event.Event,
-            Organization.Organization,
-            Person.Person,
-            Project.Project,
-            Task.Task,
-          ]),
-      }),
-      defineModule({
-        id: `${meta.id}/module/react-root`,
-        activatesOn: Events.Startup,
-        activate: ReactRoot,
-      }),
-      defineModule({
-        id: `${meta.id}/module/react-surface`,
-        activatesOn: Events.SetupReactSurface,
+      return {
+        id: Capability.getModuleTag(ReactSurface),
+        activatesOn: ActivationEvents.SetupReactSurface,
         // TODO(wittjosiah): Should occur before the settings dialog is loaded when surfaces activation is more granular.
         activatesBefore: [SpaceEvents.SetupSettingsPanel],
         activate: () => ReactSurface({ createInvitationUrl }),
-      }),
-      defineModule({
-        id: `${meta.id}/module/intent-resolver`,
-        activatesOn: Events.SetupIntentResolver,
-        activate: (context) => IntentResolver({ context, createInvitationUrl, observability }),
-      }),
-      defineModule({
-        id: `${meta.id}/module/app-graph-builder`,
-        activatesOn: Events.SetupAppGraph,
-        activate: AppGraphBuilder,
-      }),
-      // TODO(wittjosiah): This could probably be deferred.
-      defineModule({
-        id: `${meta.id}/module/app-graph-serializer`,
-        activatesOn: Events.AppGraphReady,
-        activate: AppGraphSerializer,
-      }),
-      defineModule({
-        id: `${meta.id}/module/identity-created`,
-        activatesOn: ClientEvents.IdentityCreated,
-        activatesAfter: [SpaceEvents.DefaultSpaceReady],
-        activate: IdentityCreated,
-      }),
-      defineModule({
-        id: `${meta.id}/module/spaces-ready`,
-        activatesOn: allOf(
-          Events.DispatcherReady,
-          Events.LayoutReady,
-          Events.AppGraphReady,
-          AttentionEvents.AttentionReady,
-          SpaceEvents.StateReady,
-          ClientEvents.SpacesReady,
-        ),
-        activate: SpacesReady,
-      }),
-    ];
-  },
+      };
+    },
+  ),
+  Plugin.addModule(
+    ({ shareableLinkOrigin = typeof window !== 'undefined' ? window.location.origin : 'http://localhost' }) => ({
+      id: Capability.getModuleTag(AppGraphBuilder),
+      activatesOn: AppActivationEvents.SetupAppGraph,
+      activate: () => AppGraphBuilder({ shareableLinkOrigin }),
+    }),
+  ),
+  Plugin.addModule(
+    ({
+      shareableLinkOrigin = typeof window !== 'undefined' ? window.location.origin : 'http://localhost',
+      invitationPath = '/',
+      invitationProp = 'spaceInvitationCode',
+      observability = false,
+    }) => {
+      const createInvitationUrl = (invitationCode: string) => {
+        const baseUrl = new URL(invitationPath || '/', shareableLinkOrigin);
+        baseUrl.searchParams.set(invitationProp, invitationCode);
+        return baseUrl.toString();
+      };
+
+      return {
+        id: Capability.getModuleTag(UndoMappings),
+        activatesOn: ActivationEvents.SetupOperationHandler,
+        activate: () => UndoMappings({ createInvitationUrl, observability }),
+      };
+    },
+  ),
+  // TODO(wittjosiah): This could probably be deferred.
+  Plugin.addModule({
+    activatesOn: AppActivationEvents.AppGraphReady,
+    activate: AppGraphSerializer,
+  }),
+  Plugin.addModule({
+    activatesOn: ClientEvents.IdentityCreated,
+    activatesAfter: [SpaceEvents.PersonalSpaceReady],
+    activate: IdentityCreated,
+  }),
+  Plugin.addModule({
+    activatesOn: ActivationEvent.allOf(
+      ActivationEvents.OperationInvokerReady,
+      AppActivationEvents.LayoutReady,
+      AppActivationEvents.AppGraphReady,
+      AttentionEvents.AttentionReady,
+      SpaceEvents.StateReady,
+      ClientEvents.SpacesReady,
+    ),
+    activate: SpacesReady,
+  }),
+  Plugin.addModule({
+    activatesOn: ClientEvents.SetupMigration,
+    activate: Migrations,
+  }),
+  Plugin.addModule({
+    activatesOn: ClientEvents.SpacesReady,
+    activate: Repair,
+  }),
+  Plugin.make,
 );

package/src/capabilities/app-graph-builder/app-graph-builder.ts

@@ -0,0 +1,32 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability } from '@dxos/app-framework';
+import { AppCapabilities } from '@dxos/app-toolkit';
+
+import { type SpacePluginOptions } from '#types';
+
+import {
+  createCollectionExtensions,
+  createCompanionExtensions,
+  createSettingsExtensions,
+  createSpaceExtensions,
+  createTypeExtensions,
+} from './extensions';
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* ({ shareableLinkOrigin = window.location.origin }: SpacePluginOptions = {}) {
+    const extensions = yield* Effect.all([
+      createSpaceExtensions(),
+      createTypeExtensions(),
+      createCollectionExtensions({ shareableLinkOrigin }),
+      createCompanionExtensions(),
+      createSettingsExtensions(),
+    ]);
+
+    return Capability.contributes(AppCapabilities.AppGraphBuilder, extensions.flat());
+  }),
+);