@dxos/plugin-thread 0.7.5-main.9d26e3a → 0.7.5-main.9d2a38b

package/src/ThreadPlugin.tsx

@@ -2,117 +2,78 @@
 // Copyright 2023 DXOS.org
 //
 
-import React from 'react';
-
 import {
+  allOf,
+  Capabilities,
+  contributes,
   createIntent,
-  createResolver,
-  createSurface,
-  type IntentPluginProvides,
-  isLayoutParts,
-  LayoutAction,
-  NavigationAction,
-  parseIntentPlugin,
-  parseMetadataResolverPlugin,
-  parseNavigationPlugin,
-  type Plugin,
-  type PluginDefinition,
-  resolvePlugin,
+  defineModule,
+  definePlugin,
+  Events,
+  oneOf,
+  type PluginsContext,
 } from '@dxos/app-framework';
-import { type UnsubscribeCallback } from '@dxos/async';
-import { Ref } from '@dxos/echo-schema';
-import { LocalStorageStore } from '@dxos/local-storage';
-import { log } from '@dxos/log';
-import { parseClientPlugin } from '@dxos/plugin-client/types';
-import { createExtension, toSignal } from '@dxos/plugin-graph';
-import { ObservabilityAction } from '@dxos/plugin-observability/types';
-import { memoizeQuery } from '@dxos/plugin-space';
+import { ClientCapabilities, ClientEvents } from '@dxos/plugin-client';
+import { DeckCapabilities } from '@dxos/plugin-deck';
 import { ChannelType, MessageType, ThreadType } from '@dxos/plugin-space/types';
-import {
-  create,
-  fullyQualifiedId,
-  getSpace,
-  getTypename,
-  makeRef,
-  parseId,
-  type ReactiveEchoObject,
-  RefArray,
-  SpaceState,
-} from '@dxos/react-client/echo';
+import { type ReactiveEchoObject, RefArray } from '@dxos/react-client/echo';
 import { translations as threadTranslations } from '@dxos/react-ui-thread';
 
-import { ThreadArticle, ThreadComplementary, ThreadSettings } from './components';
-import { threads } from './extensions';
-import meta, { THREAD_ITEM, THREAD_PLUGIN } from './meta';
+import { AppGraphBuilder, IntentResolver, Markdown, ReactSurface, ThreadSettings, ThreadState } from './capabilities';
+import { meta, THREAD_ITEM, THREAD_PLUGIN } from './meta';
 import translations from './translations';
-import { ThreadAction, type ThreadPluginProvides, type ThreadSettingsProps, type ThreadState } from './types';
-
-type SubjectId = string;
-
-const initialViewState = { showResolvedThreads: false };
-
-type ViewStore = Record<SubjectId, typeof initialViewState>;
+import { ThreadAction, type ThreadSettingsProps } from './types';
 
 // TODO(Zan): Every instance of `cursor` should be replaced with `anchor`.
 //  NOTE(burdon): Review/discuss CursorConverter semantics.
-export const ThreadPlugin = (): PluginDefinition<
-  Omit<ThreadPluginProvides, 'echo'>,
-  Pick<ThreadPluginProvides, 'echo'>
-> => {
-  const settings = new LocalStorageStore<ThreadSettingsProps>(THREAD_PLUGIN);
-  const state = create<ThreadState>({ drafts: {} });
-
-  const viewStore = create<ViewStore>({});
-  const getViewState = (subjectId: string) => {
-    if (!viewStore[subjectId]) {
-      viewStore[subjectId] = { ...initialViewState };
-    }
-    return viewStore[subjectId];
-  };
-
-  let intentPlugin: Plugin<IntentPluginProvides> | undefined;
-
-  const unsubscribeCallbacks = [] as UnsubscribeCallback[];
-
-  return {
-    meta,
-    initialize: async () => {
-      settings.prop({ key: 'standalone', type: LocalStorageStore.bool({ allowUndefined: true }) });
-
-      return {
-        echo: {
-          system: [ThreadType, MessageType],
-          // TODO(wittjosiah): Requires reload.
-          ...(settings.values.standalone ? { schema: [ChannelType] } : {}),
-        },
-      };
-    },
-    ready: async ({ plugins }) => {
-      intentPlugin = resolvePlugin(plugins, parseIntentPlugin)!;
-    },
-    unload: async () => {
-      unsubscribeCallbacks.forEach((unsubscribe) => unsubscribe());
-    },
-    provides: {
-      settings: settings.values,
-      metadata: {
-        records: {
-          [ChannelType.typename]: {
+export const ThreadPlugin = () =>
+  definePlugin(meta, [
+    defineModule({
+      id: `${meta.id}/module/settings`,
+      activatesOn: Events.SetupSettings,
+      activate: ThreadSettings,
+    }),
+    defineModule({
+      id: `${meta.id}/module/state`,
+      activatesOn: Events.Startup,
+      activate: ThreadState,
+    }),
+    defineModule({
+      id: `${meta.id}/module/translations`,
+      activatesOn: Events.SetupTranslations,
+      activate: () => contributes(Capabilities.Translations, [...translations, ...threadTranslations]),
+    }),
+    defineModule({
+      id: `${meta.id}/module/metadata`,
+      activatesOn: oneOf(Events.Startup, Events.SetupAppGraph),
+      activate: () => [
+        contributes(Capabilities.Metadata, {
+          id: ChannelType.typename,
+          metadata: {
             createObject: (props: { name?: string }) => createIntent(ThreadAction.Create, props),
             placeholder: ['channel name placeholder', { ns: THREAD_PLUGIN }],
             icon: 'ph--chat--regular',
             // TODO(wittjosiah): Move out of metadata.
             loadReferences: async (channel: ChannelType) => await RefArray.loadAll(channel.threads ?? []),
           },
-          [ThreadType.typename]: {
+        }),
+        contributes(Capabilities.Metadata, {
+          id: ThreadType.typename,
+          metadata: {
             // TODO(wittjosiah): Move out of metadata.
             loadReferences: async (thread: ThreadType) => await RefArray.loadAll(thread.messages ?? []),
           },
-          [MessageType.typename]: {
+        }),
+        contributes(Capabilities.Metadata, {
+          id: MessageType.typename,
+          metadata: {
             // TODO(wittjosiah): Move out of metadata.
             loadReferences: (message: MessageType) => [], // loadObjectReferences(message, (message) => [...message.parts, message.context]),
           },
-          [THREAD_ITEM]: {
+        }),
+        contributes(Capabilities.Metadata, {
+          id: THREAD_ITEM,
+          metadata: {
             parse: (item: ReactiveEchoObject<any>, type: string) => {
               switch (type) {
                 case 'node':
@@ -124,385 +85,59 @@ export const ThreadPlugin = (): PluginDefinition<
               }
             },
           },
-        },
-      },
-      translations: [...translations, ...threadTranslations],
-      complementary: {
-        panels: [
-          {
-            id: 'comments',
-            label: ['open comments panel label', { ns: THREAD_PLUGIN }],
-            icon: 'ph--chat-text--regular',
-          },
-        ],
-      },
-      graph: {
-        builder: (plugins) => {
-          const client = resolvePlugin(plugins, parseClientPlugin)?.provides.client;
-          const dispatch = resolvePlugin(plugins, parseIntentPlugin)?.provides.intent.dispatchPromise;
-          const metadataResolver = resolvePlugin(plugins, parseMetadataResolverPlugin)?.provides.metadata.resolver;
-          if (!client || !dispatch || !metadataResolver) {
-            return [];
-          }
-
-          const type = 'orphan-comments-for-subject';
-          const icon = 'ph--chat-text--regular';
-
-          return [
-            createExtension({
-              id: `${THREAD_PLUGIN}/comments-for-subject`,
-              resolver: ({ id }) => {
-                // TODO(Zan): Find util (or make one).
-                if (!id.endsWith('~comments')) {
-                  return;
-                }
-
-                const [subjectId] = id.split('~');
-                const { spaceId, objectId } = parseId(subjectId);
-                const spaces = toSignal(
-                  (onChange) => client.spaces.subscribe(() => onChange()).unsubscribe,
-                  () => client.spaces.get(),
-                );
-                const space = spaces?.find(
-                  (space) => space.id === spaceId && space.state.get() === SpaceState.SPACE_READY,
-                );
-                if (!objectId) {
-                  // TODO(wittjosiah): Support comments for arbitrary subjects.
-                  //   This is to ensure that the comments panel is not stuck on an old object.
-                  return {
-                    id,
-                    type,
-                    data: null,
-                    properties: {
-                      icon,
-                      label: ['unnamed object threads label', { ns: THREAD_PLUGIN }],
-                      showResolvedThreads: false,
-                      object: null,
-                      space,
-                    },
-                  };
-                }
-
-                const [object] = memoizeQuery(space, { id: objectId });
-                if (!object || !subjectId) {
-                  return;
-                }
-
-                const meta = metadataResolver(getTypename(object) ?? '');
-                const label = meta.label?.(object) ||
-                  object.name ||
-                  meta.placeholder || ['unnamed object threads label', { ns: THREAD_PLUGIN }];
-
-                const viewState = getViewState(subjectId);
-
-                return {
-                  id,
-                  type,
-                  data: null,
-                  properties: {
-                    icon,
-                    label,
-                    showResolvedThreads: viewState.showResolvedThreads,
-                    object,
-                  },
-                };
-              },
-              actions: ({ node }) => {
-                const dataId = node.id.split('~').at(0);
-                if (!node.id.endsWith('~comments') || !dataId) {
-                  return;
-                }
-
-                const [spaceId, objectId] = dataId.split(':');
-
-                const viewState = getViewState(dataId);
-                const toggle = async () => {
-                  const newToggleState = !viewState.showResolvedThreads;
-                  viewState.showResolvedThreads = newToggleState;
-                  await dispatch(
-                    createIntent(ObservabilityAction.SendEvent, {
-                      name: 'threads.toggle-show-resolved',
-                      properties: { spaceId, threadId: objectId, showResolved: newToggleState },
-                    }),
-                  );
-                };
-
-                return [
-                  {
-                    id: `${THREAD_PLUGIN}/toggle-show-resolved/${node.id}`,
-                    data: toggle,
-                    properties: {
-                      label: ['toggle show resolved', { ns: THREAD_PLUGIN }],
-                      menuItemType: 'toggle',
-                      isChecked: viewState.showResolvedThreads,
-                      testId: 'threadPlugin.toggleShowResolved',
-                      icon: viewState.showResolvedThreads ? 'ph--eye-slash--regular' : 'ph--eye--regular',
-                    },
-                  },
-                ];
-              },
-            }),
-          ];
-        },
-      },
-      surface: {
-        definitions: ({ plugins }) => {
-          const location = resolvePlugin(plugins, parseNavigationPlugin)?.provides.location;
-          return [
-            createSurface({
-              id: `${THREAD_PLUGIN}/channel`,
-              role: 'article',
-              filter: (data): data is { subject: ChannelType } =>
-                data.subject instanceof ChannelType && !!data.subject.threads[0],
-              component: ({ data }) => {
-                const channel = data.subject;
-                const thread = channel.threads[0].target!;
-                // TODO(zan): Maybe we should have utility for positional main object ids.
-                if (isLayoutParts(location?.active) && location.active.main) {
-                  const layoutEntries = location.active.main;
-                  const currentPosition = layoutEntries.findIndex((entry) => channel.id === entry.id);
-                  if (currentPosition > 0) {
-                    const objectToTheLeft = layoutEntries[currentPosition - 1];
-                    const context = getSpace(channel)?.db.getObjectById(objectToTheLeft.id);
-                    return <ThreadArticle thread={thread} context={context} />;
-                  }
-                }
-
-                return <ThreadArticle thread={thread} />;
-              },
-            }),
-            createSurface({
-              id: `${THREAD_PLUGIN}/thread`,
-              role: 'complementary--comments',
-              filter: (data): data is { subject: { threads: Ref<ThreadType>[] } } =>
-                !!data.subject &&
-                typeof data.subject === 'object' &&
-                'threads' in data.subject &&
-                Array.isArray(data.subject.threads) &&
-                !(data.subject instanceof ChannelType),
-              component: ({ data }) => {
-                const { showResolvedThreads } = getViewState(fullyQualifiedId(data.subject));
-                return (
-                  <ThreadComplementary
-                    subject={data.subject}
-                    drafts={state.drafts[fullyQualifiedId(data.subject)]}
-                    current={state.current}
-                    showResolvedThreads={showResolvedThreads}
-                  />
-                );
-              },
-            }),
-            createSurface({
-              id: `${THREAD_PLUGIN}/settings`,
-              role: 'settings',
-              filter: (data): data is any => data.plugin === THREAD_PLUGIN,
-              component: () => <ThreadSettings settings={settings.values} />,
-            }),
-          ];
-        },
-      },
-      intent: {
-        resolvers: () => [
-          createResolver(ThreadAction.Create, ({ name, cursor, subject }) => {
-            if (cursor && subject) {
-              // Seed the threads array if it does not exist.
-              if (subject?.threads === undefined) {
-                try {
-                  // Static schema will throw an error if subject does not support threads array property.
-                  subject.threads = [];
-                } catch (err) {
-                  log.error('Subject does not support threads array', subject?.typename);
-                  return;
-                }
-              }
-
-              const subjectId = fullyQualifiedId(subject);
-              const thread = create(ThreadType, { name, anchor: cursor, messages: [], status: 'staged' });
-              const draft = state.drafts[subjectId];
-              if (draft) {
-                draft.push(thread);
-              } else {
-                state.drafts[subjectId] = [thread];
-              }
-
-              return {
-                data: { object: thread },
-                intents: [
-                  createIntent(ThreadAction.Select, { current: fullyQualifiedId(thread) }),
-                  createIntent(NavigationAction.Open, { activeParts: { complementary: 'comments' } }),
-                  createIntent(LayoutAction.SetLayout, { element: 'complementary', state: true }),
-                ],
-              };
-            } else {
-              // NOTE: This is the standalone thread creation case.
-              return {
-                data: { object: create(ChannelType, { threads: [makeRef(create(ThreadType, { messages: [] }))] }) },
-              };
-            }
-          }),
-          createResolver(ThreadAction.Select, ({ current, skipOpen }) => {
-            state.current = current;
-
-            return {
-              intents: !skipOpen
-                ? [createIntent(NavigationAction.Open, { activeParts: { complementary: 'comments' } })]
-                : undefined,
-            };
-          }),
-          createResolver(ThreadAction.ToggleResolved, ({ thread }) => {
-            if (thread.status === 'active' || thread.status === undefined) {
-              thread.status = 'resolved';
-            } else if (thread.status === 'resolved') {
-              thread.status = 'active';
-            }
-
-            const space = getSpace(thread);
-            const spaceId = space?.id;
-
-            return {
-              intents: [
-                createIntent(ObservabilityAction.SendEvent, {
-                  name: 'threads.toggle-resolved',
-                  properties: { threadId: thread.id, spaceId },
-                }),
-              ],
-            };
-          }),
-          createResolver(ThreadAction.Delete, ({ subject, thread }, undo) => {
-            const subjectId = fullyQualifiedId(subject);
-            const draft = state.drafts[subjectId];
-            if (draft) {
-              // Check if we're deleting a draft; if so, remove it.
-              const index = draft.findIndex((t) => t.id === thread.id);
-              if (index !== -1) {
-                draft.splice(index, 1);
-                return;
-              }
-            }
-
-            const space = getSpace(thread);
-            if (!space || !subject.threads) {
-              return;
-            }
-
-            if (!undo) {
-              const index = subject.threads.findIndex((t: any) => t?.id === thread.id);
-              const cursor = subject.threads[index]?.anchor;
-              if (index !== -1) {
-                subject.threads?.splice(index, 1);
-              }
-
-              space.db.remove(thread);
-
-              return {
-                undoable: {
-                  message: ['thread deleted label', { ns: THREAD_PLUGIN }],
-                  data: { cursor },
-                },
-                intents: [
-                  createIntent(ObservabilityAction.SendEvent, {
-                    name: 'threads.delete',
-                    properties: { threadId: thread.id, spaceId: space.id },
-                  }),
-                ],
-              };
-            } else {
-              // TODO(wittjosiah): SDK should do this automatically.
-              const savedThread = space.db.add(thread);
-              subject.threads.push(savedThread);
-
-              return {
-                intents: [
-                  createIntent(ObservabilityAction.SendEvent, {
-                    name: 'threads.undo-delete',
-                    properties: { threadId: thread.id, spaceId: space.id },
-                  }),
-                ],
-              };
-            }
-          }),
-          createResolver(ThreadAction.OnMessageAdd, ({ thread, subject }) => {
-            const subjectId = fullyQualifiedId(subject);
-            const space = getSpace(subject);
-            const intents = [];
-            const analyticsProperties = { threadId: thread.id, spaceId: space?.id };
-
-            if (state.drafts[subjectId]?.find((t) => t === thread)) {
-              // Move draft to document.
-              thread.status = 'active';
-              subject.threads ? subject.threads.push(makeRef(thread)) : (subject.threads = [makeRef(thread)]);
-              state.drafts[subjectId] = state.drafts[subjectId]?.filter(({ id }) => id !== thread.id);
-              intents.push(
-                createIntent(ObservabilityAction.SendEvent, {
-                  name: 'threads.thread-created',
-                  properties: analyticsProperties,
-                }),
-              );
-            }
-
-            intents.push(
-              createIntent(ObservabilityAction.SendEvent, {
-                name: 'threads.message-added',
-                properties: { ...analyticsProperties, threadLength: thread.messages.length },
-              }),
-            );
-
-            return { intents };
-          }),
-          createResolver(ThreadAction.DeleteMessage, ({ subject, thread, messageId, message, messageIndex }, undo) => {
-            const space = getSpace(subject);
-
-            if (!undo) {
-              const messageIndex = thread.messages.findIndex(Ref.hasObjectId(messageId));
-              const message = thread.messages[messageIndex]?.target;
-              if (!message) {
-                return;
-              }
-
-              if (messageIndex === 0 && thread.messages.length === 1) {
-                // If the message is the only message in the thread, delete the thread.
-                return {
-                  intents: [createIntent(ThreadAction.Delete, { subject, thread })],
-                };
-              } else {
-                thread.messages.splice(messageIndex, 1);
-              }
-
-              return {
-                undoable: {
-                  message: ['message deleted label', { ns: THREAD_PLUGIN }],
-                  data: { message, messageIndex },
-                },
-                intents: [
-                  createIntent(ObservabilityAction.SendEvent, {
-                    name: 'threads.message.delete',
-                    properties: { threadId: thread.id, spaceId: space?.id },
-                  }),
-                ],
-              };
-            } else {
-              if (!messageIndex || !message) {
-                return;
-              }
-
-              thread.messages.splice(messageIndex, 0, makeRef(message));
-              return {
-                intents: [
-                  createIntent(ObservabilityAction.SendEvent, {
-                    name: 'threads.message.undo-delete',
-                    properties: { threadId: thread.id, spaceId: space?.id },
-                  }),
-                ],
-              };
-            }
-          }),
-        ],
-      },
-      markdown: {
-        extensions: ({ document: doc }) => {
-          return threads(state, doc, intentPlugin?.provides.intent.dispatchPromise);
-        },
+        }),
+      ],
+    }),
+    defineModule({
+      id: `${meta.id}/module/schema`,
+      activatesOn: ClientEvents.SetupClient,
+      activate: () => contributes(ClientCapabilities.SystemSchema, [ThreadType, MessageType]),
+    }),
+    defineModule({
+      id: `${meta.id}/module/channel-schema`,
+      activatesOn: allOf(Events.SettingsReady, ClientEvents.ClientReady),
+      activate: (context: PluginsContext) => {
+        const client = context.requestCapability(ClientCapabilities.Client);
+        const settings = context
+          .requestCapability(Capabilities.SettingsStore)
+          .getStore<ThreadSettingsProps>(THREAD_PLUGIN)!.value;
+        if (settings.standalone) {
+          // TODO(wittjosiah): Requires reload to disable.
+          client.addTypes([ChannelType]);
+          return contributes(ClientCapabilities.Schema, [ChannelType]);
+        }
+
+        return [];
       },
-    },
-  };
-};
+    }),
+    defineModule({
+      id: `${meta.id}/module/complementary-panel`,
+      activatesOn: Events.Startup,
+      activate: () =>
+        contributes(DeckCapabilities.ComplementaryPanel, {
+          id: 'comments',
+          label: ['comments panel label', { ns: THREAD_PLUGIN }],
+          icon: 'ph--chat-text--regular',
+        }),
+    }),
+    defineModule({
+      id: `${meta.id}/module/markdown`,
+      activatesOn: Events.Startup,
+      activate: Markdown,
+    }),
+    defineModule({
+      id: `${meta.id}/module/react-surface`,
+      activatesOn: Events.Startup,
+      activate: ReactSurface,
+    }),
+    defineModule({
+      id: `${meta.id}/module/intent-resolver`,
+      activatesOn: Events.SetupIntents,
+      activate: IntentResolver,
+    }),
+    defineModule({
+      id: `${meta.id}/module/app-graph-builder`,
+      activatesOn: Events.SetupAppGraph,
+      activate: AppGraphBuilder,
+    }),
+  ]);