@dxos/plugin-thread 0.8.4-main.f5c0578 → 0.8.4-main.fcc0d83b33

package/src/operations/definitions.ts

@@ -0,0 +1,177 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Capability } from '@dxos/app-framework';
+import { Operation } from '@dxos/compute';
+import { Database, Key, Obj, Ref } from '@dxos/echo';
+import { Collection } from '@dxos/echo';
+import { Markdown } from '@dxos/plugin-markdown/types';
+import { SpaceSchema } from '@dxos/react-client/echo';
+import { Actor, AnchoredTo, Message, Thread } from '@dxos/types';
+
+import { meta } from '#meta';
+
+import { Channel } from '../types';
+
+const THREAD_OPERATION = `${meta.id}.operation`;
+
+export const OnCreateSpace = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.on-create-space`, name: 'On Create Space' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    space: SpaceSchema,
+    rootCollection: Collection.Collection,
+    isDefault: Schema.Boolean.pipe(Schema.optional),
+  }),
+  output: Schema.Void,
+});
+
+export const CreateChannel = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.create-channel`, name: 'Create Channel' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    spaceId: Key.SpaceId,
+    name: Schema.optional(Schema.String),
+  }),
+  output: Schema.Struct({
+    object: Channel.Channel,
+  }),
+});
+
+export const CreateChannelThread = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.create-channel-thread`, name: 'Create Channel Thread' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    channel: Channel.Channel,
+  }),
+  output: Schema.Struct({
+    object: Thread.Thread,
+  }),
+});
+
+export const Create = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.create`, name: 'Create Thread' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    name: Schema.optional(Schema.String),
+    anchor: Schema.optional(Schema.String),
+    subject: Obj.Unknown,
+  }),
+  output: Schema.Void,
+});
+
+export const DeleteOutput = Schema.Struct({
+  thread: Thread.Thread.annotations({ description: 'The deleted thread.' }),
+  anchor: AnchoredTo.AnchoredTo.annotations({ description: 'The deleted anchor.' }),
+}).pipe(Schema.partial);
+
+export type DeleteOutput = Schema.Schema.Type<typeof DeleteOutput>;
+
+export const Delete = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.delete`, name: 'Delete Thread' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    anchor: AnchoredTo.AnchoredTo,
+    subject: Obj.Unknown,
+    thread: Schema.optional(Thread.Thread),
+  }),
+  output: DeleteOutput,
+});
+
+export const Select = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.select`, name: 'Select Thread' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    current: Schema.String,
+  }),
+  output: Schema.Void,
+});
+
+export const ToggleResolved = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.toggle-resolved`, name: 'Toggle Resolved' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    thread: Thread.Thread,
+  }),
+  output: Schema.Void,
+});
+
+export const AddMessage = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.add-message`, name: 'Add Message' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    subject: Obj.Unknown,
+    anchor: AnchoredTo.AnchoredTo,
+    sender: Actor.Actor,
+    text: Schema.String,
+  }),
+  output: Schema.Void,
+});
+
+export const DeleteMessageOutput = Schema.partial(
+  Schema.Struct({
+    message: Message.Message.annotations({ description: 'The deleted message.' }),
+    messageIndex: Schema.Number.annotations({ description: 'The index the message was at.' }),
+  }),
+);
+
+export type DeleteMessageOutput = Schema.Schema.Type<typeof DeleteMessageOutput>;
+
+export const DeleteMessage = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.delete-message`, name: 'Delete Message' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    anchor: AnchoredTo.AnchoredTo,
+    subject: Obj.Unknown,
+    messageId: Schema.String,
+  }),
+  output: DeleteMessageOutput,
+});
+
+/**
+ * Restore a deleted thread (inverse of Delete).
+ */
+export const Restore = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.restore`, name: 'Restore Thread' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    thread: Thread.Thread.annotations({ description: 'The thread to restore.' }),
+    anchor: AnchoredTo.AnchoredTo.annotations({ description: 'The anchor relation to restore.' }),
+  }),
+  output: Schema.Void,
+});
+
+/**
+ * Restore a deleted message (inverse of DeleteMessage).
+ */
+export const RestoreMessage = Operation.make({
+  meta: { key: `${THREAD_OPERATION}.restore-message`, name: 'Restore Message' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    anchor: AnchoredTo.AnchoredTo.annotations({ description: 'The anchor of the thread.' }),
+    message: Message.Message.annotations({ description: 'The message to restore.' }),
+    messageIndex: Schema.Number.annotations({ description: 'The index to restore the message at.' }),
+  }),
+  output: Schema.Void,
+});
+
+export const CreateProposals = Operation.make({
+  meta: {
+    key: 'org.dxos.function.thread.create-proposals',
+    name: 'Create Proposals',
+    description: 'Proposes a set of changes to a document.',
+  },
+  input: Schema.Struct({
+    doc: Ref.Ref(Markdown.Document).annotations({
+      description: 'The ID of the document.',
+    }),
+    diffs: Schema.Array(Schema.String).annotations({
+      description: 'The diffs to propose for the document.',
+    }),
+  }),
+  output: Schema.Void,
+  services: [Database.Service],
+});

package/src/operations/delete-message.ts

@@ -0,0 +1,53 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Operation } from '@dxos/compute';
+import { Obj, Relation } from '@dxos/echo';
+import { invariant } from '@dxos/invariant';
+import { ObservabilityOperation } from '@dxos/plugin-observability/operations';
+import { Thread } from '@dxos/types';
+
+import { Delete, DeleteMessage } from './definitions';
+
+const handler: Operation.WithHandler<typeof DeleteMessage> = DeleteMessage.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* ({ subject, anchor, messageId }) {
+      const thread = Relation.getSource(anchor) as Thread.Thread;
+      const db = Obj.getDatabase(subject);
+      invariant(db, 'Database not found');
+
+      const msgIndex = thread.messages.findIndex((ref) => ref.target?.id === messageId);
+      const msg = thread.messages[msgIndex]?.target;
+      if (!msg) {
+        return { messageIndex: -1 };
+      }
+
+      if (msgIndex === 0 && thread.messages.length === 1) {
+        // TODO(wittjosiah): This doesn't support restoring the thread.
+        yield* Operation.invoke(Delete, { subject, anchor });
+        return { messageIndex: -1 };
+      }
+
+      Obj.update(thread, (thread) => {
+        thread.messages.splice(msgIndex, 1);
+      });
+
+      yield* Operation.schedule(ObservabilityOperation.SendEvent, {
+        name: 'threads.message.delete',
+        properties: {
+          spaceId: db.spaceId,
+          threadId: thread.id,
+          threadLength: thread.messages.length,
+          messageId,
+        },
+      });
+
+      return { message: msg, messageIndex: msgIndex };
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/delete.ts

@@ -0,0 +1,63 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { sleep } from '@dxos/async';
+import { Operation } from '@dxos/compute';
+import { Obj, Relation } from '@dxos/echo';
+import { ObservabilityOperation } from '@dxos/plugin-observability/operations';
+import { Thread } from '@dxos/types';
+
+import { ThreadCapabilities } from '../types';
+import { Delete } from './definitions';
+
+const handler: Operation.WithHandler<typeof Delete> = Delete.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* ({ subject, anchor, thread: _thread }) {
+      const registry = yield* Capability.get(Capabilities.AtomRegistry);
+      const stateAtom = yield* Capability.get(ThreadCapabilities.State);
+      const thread = _thread ?? (Relation.getSource(anchor) as Thread.Thread);
+      const subjectId = Obj.getDXN(subject).toString();
+      const state = registry.get(stateAtom);
+      const draft = state.drafts[subjectId];
+      if (draft) {
+        const index = draft.findIndex((a: { id: string }) => a.id === anchor.id);
+        if (index !== -1) {
+          registry.set(stateAtom, {
+            ...state,
+            drafts: {
+              ...state.drafts,
+              [subjectId]: state.drafts[subjectId]?.filter((_, i) => i !== index),
+            },
+          });
+          return {};
+        }
+      }
+
+      const db = Obj.getDatabase(thread);
+      if (!db) {
+        return {};
+      }
+
+      // TODO(wittjosiah): Without sleep, rendering crashes at `Relation.setSource(anchor)`.
+      db.remove(anchor);
+      yield* Effect.promise(() => sleep(100));
+      db.remove(thread);
+
+      yield* Operation.schedule(ObservabilityOperation.SendEvent, {
+        name: 'threads.delete',
+        properties: {
+          spaceId: db.spaceId,
+          threadId: thread.id,
+        },
+      });
+
+      return { thread, anchor };
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/index.ts

@@ -0,0 +1,22 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { OperationHandlerSet } from '@dxos/compute';
+
+export * as ThreadOperation from './definitions';
+
+export const ThreadOperationHandlerSet = OperationHandlerSet.lazy(
+  () => import('./add-message'),
+  () => import('./create'),
+  () => import('./create-channel'),
+  () => import('./create-channel-thread'),
+  () => import('./create-proposals'),
+  () => import('./delete'),
+  () => import('./delete-message'),
+  () => import('./on-create-space'),
+  () => import('./restore'),
+  () => import('./restore-message'),
+  () => import('./select'),
+  () => import('./toggle-resolved'),
+);

package/src/operations/on-create-space.ts

@@ -0,0 +1,27 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Operation } from '@dxos/compute';
+
+import { CreateChannel, OnCreateSpace } from './definitions';
+
+const handler: Operation.WithHandler<typeof OnCreateSpace> = OnCreateSpace.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* ({ space, isDefault }) {
+      if (isDefault) {
+        return;
+      }
+
+      const { object: channel } = yield* Operation.invoke(CreateChannel, {
+        name: 'General',
+        spaceId: space.id,
+      });
+      space.db.add(channel);
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/restore-message.ts

@@ -0,0 +1,38 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Operation } from '@dxos/compute';
+import { Obj, Ref, Relation } from '@dxos/echo';
+import { invariant } from '@dxos/invariant';
+import { ObservabilityOperation } from '@dxos/plugin-observability/operations';
+import { Thread } from '@dxos/types';
+
+import { RestoreMessage } from './definitions';
+
+const handler: Operation.WithHandler<typeof RestoreMessage> = RestoreMessage.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* ({ anchor, message, messageIndex }) {
+      const thread = Relation.getSource(anchor) as Thread.Thread;
+      const db = Obj.getDatabase(thread);
+      invariant(db, 'Database not found');
+
+      Obj.update(thread, (thread) => {
+        thread.messages.splice(messageIndex, 0, Ref.make(message));
+      });
+
+      yield* Operation.schedule(ObservabilityOperation.SendEvent, {
+        name: 'threads.message.undo-delete',
+        properties: {
+          spaceId: db.spaceId,
+          threadId: thread.id,
+          messageId: message.id,
+        },
+      });
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/restore.ts

@@ -0,0 +1,38 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { sleep } from '@dxos/async';
+import { Operation } from '@dxos/compute';
+import { Obj } from '@dxos/echo';
+import { ObservabilityOperation } from '@dxos/plugin-observability/operations';
+
+import { Restore } from './definitions';
+
+const handler: Operation.WithHandler<typeof Restore> = Restore.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* ({ thread, anchor }) {
+      const db = Obj.getDatabase(thread);
+      if (!db) {
+        return;
+      }
+
+      // TODO(wittjosiah): Without sleep, rendering crashes at `Relation.setSource(anchor)`.
+      db.add(thread);
+      yield* Effect.promise(() => sleep(100));
+      db.add(anchor);
+
+      yield* Operation.schedule(ObservabilityOperation.SendEvent, {
+        name: 'threads.undo-delete',
+        properties: {
+          spaceId: db.spaceId,
+          threadId: thread.id,
+        },
+      });
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/select.ts

@@ -0,0 +1,24 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { Operation } from '@dxos/compute';
+
+import { ThreadCapabilities } from '../types';
+import { Select } from './definitions';
+
+const handler: Operation.WithHandler<typeof Select> = Select.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* (input) {
+      const registry = yield* Capability.get(Capabilities.AtomRegistry);
+      const stateAtom = yield* Capability.get(ThreadCapabilities.State);
+      const current = registry.get(stateAtom);
+      registry.set(stateAtom, { ...current, current: input.current });
+    }),
+  ),
+);
+
+export default handler;

package/src/operations/toggle-resolved.ts

@@ -0,0 +1,41 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Operation } from '@dxos/compute';
+import { Obj } from '@dxos/echo';
+import { invariant } from '@dxos/invariant';
+import { ObservabilityOperation } from '@dxos/plugin-observability/operations';
+
+import { ToggleResolved } from './definitions';
+
+const handler: Operation.WithHandler<typeof ToggleResolved> = ToggleResolved.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* (input) {
+      const thread = input.thread;
+
+      Obj.update(thread, (thread) => {
+        if (thread.status === 'active' || thread.status === undefined) {
+          thread.status = 'resolved';
+        } else if (thread.status === 'resolved') {
+          thread.status = 'active';
+        }
+      });
+
+      const db = Obj.getDatabase(thread);
+      invariant(db, 'Database not found');
+
+      yield* Operation.schedule(ObservabilityOperation.SendEvent, {
+        name: 'threads.toggle-resolved',
+        properties: {
+          spaceId: db.spaceId,
+          threadId: thread.id,
+        },
+      });
+    }),
+  ),
+);
+
+export default handler;

package/src/testing/data.ts

@@ -0,0 +1,49 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { Obj, Ref } from '@dxos/echo';
+import { IdentityDid } from '@dxos/keys';
+import { random } from '@dxos/random';
+import { type Identity } from '@dxos/react-client/halo';
+import { Message, Thread } from '@dxos/types';
+
+export const createCommentThread = (identity: Identity): Thread.Thread => {
+  return Thread.make({
+    name: 'Comment',
+    messages: random.helpers.multiple(
+      () =>
+        Ref.make(
+          Obj.make(Message.Message, {
+            created: new Date().toISOString(),
+            sender: {
+              identityDid: random.datatype.boolean() ? identity.did : IdentityDid.random(),
+            },
+            blocks: [{ _tag: 'text', text: random.lorem.sentences(3) }],
+          }),
+        ),
+      { count: { min: 2, max: 3 } },
+    ),
+    status: 'active',
+  });
+};
+
+export const createProposalThread = (identity: Identity): Thread.Thread => {
+  return Thread.make({
+    name: 'Proposal',
+    messages: random.helpers.multiple(
+      () =>
+        Ref.make(
+          Obj.make(Message.Message, {
+            created: new Date().toISOString(),
+            sender: {
+              identityDid: random.datatype.boolean() ? identity.did : IdentityDid.random(),
+            },
+            blocks: [{ _tag: 'proposal', text: random.lorem.sentences(3) }],
+          }),
+        ),
+      { count: { min: 1, max: 1 } },
+    ),
+    status: 'active',
+  });
+};

package/src/testing/index.ts

@@ -2,4 +2,4 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './stories';
+export * from './data';