@dxos/plugin-assistant 0.8.3-staging.0fa589b → 0.8.4-main.03d5cd7b56

package/src/capabilities/ai-service.ts

@@ -0,0 +1,30 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import * as Layer from 'effect/Layer';
+
+import { AiModelResolver } from '@dxos/ai';
+import { Capability } from '@dxos/app-framework';
+import { AppCapabilities } from '@dxos/app-toolkit';
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    const resolvers = yield* Capability.getAll(AppCapabilities.AiModelResolver);
+
+    // TODO(dmaretskyi): Extract function to reduce them.
+    const combinedLayer = resolvers.reduce(
+      (acc, resolver) => resolver.pipe(Layer.provide(acc)),
+      AiModelResolver.AiModelResolver.fromModelMap({ name: 'Fallback' }, Effect.succeed({})), // Empty resolver as fallback.
+    );
+
+    return [
+      // TODO(dmaretskyi): Read config from settings.
+      Capability.contributes(
+        AppCapabilities.AiServiceLayer,
+        AiModelResolver.AiModelResolver.buildAiService.pipe(Layer.provide(combinedLayer)),
+      ),
+    ];
+  }),
+);

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

@@ -2,247 +2,191 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Rx } from '@effect-rx/rx-react';
-import { Option, pipe } from 'effect';
-
-import {
-  Capabilities,
-  contributes,
-  createIntent,
-  LayoutAction,
-  type PromiseIntentDispatcher,
-  type PluginContext,
-} from '@dxos/app-framework';
-import { Blueprint } from '@dxos/assistant';
-import { Obj } from '@dxos/echo';
+import * as Effect from 'effect/Effect';
+import { pipe } from 'effect/Function';
+import * as Option from 'effect/Option';
+
+import { Capability } from '@dxos/app-framework';
+import { AppCapabilities, AppNode, getActiveSpace, getPersonalSpace } from '@dxos/app-toolkit';
+import { AgentPrompt, Chat } from '@dxos/assistant-toolkit';
+import { Blueprint, Routine, Operation } from '@dxos/compute';
+import { Sequence } from '@dxos/conductor';
+import { DXN, Database, Filter, Obj, type Ref } from '@dxos/echo';
+import { AtomObj } from '@dxos/echo-atom';
 import { invariant } from '@dxos/invariant';
+import { AutomationCapabilities } from '@dxos/plugin-automation';
 import { ClientCapabilities } from '@dxos/plugin-client';
-import { PLANK_COMPANION_TYPE, ATTENDABLE_PATH_SEPARATOR } from '@dxos/plugin-deck/types';
-import { createExtension, ROOT_ID } from '@dxos/plugin-graph';
-import { getActiveSpace, rxFromQuery } from '@dxos/plugin-space';
-import { SPACE_TYPE, SpaceAction } from '@dxos/plugin-space/types';
-import {
-  type Space,
-  Filter,
-  Query,
-  type QueryResult,
-  fullyQualifiedId,
-  getSpace,
-  isSpace,
-} from '@dxos/react-client/echo';
-
-import { ASSISTANT_DIALOG, ASSISTANT_PLUGIN } from '../meta';
-import { AIChatType, AssistantAction, CompanionTo, TemplateType } from '../types';
-
-export default (context: PluginContext) =>
-  contributes(Capabilities.AppGraphBuilder, [
-    createExtension({
-      id: `${ASSISTANT_PLUGIN}/assistant`,
-      actions: (node) =>
-        Rx.make((get) =>
-          pipe(
-            get(node),
-            Option.flatMap((node) => (node.id === ROOT_ID ? Option.some(node) : Option.none())),
-            Option.map(() => [
-              {
-                id: `${LayoutAction.UpdateDialog._tag}/assistant/open`,
-                data: async () => {
-                  const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-                  const client = context.getCapability(ClientCapabilities.Client);
-
-                  const space = getActiveSpace(context) ?? client.spaces.default;
-                  const chat = await getOrCreateChat(dispatch, space);
-                  if (!chat) {
-                    return;
+import { GraphBuilder, Node, NodeMatcher } from '@dxos/plugin-graph';
+import { linkedSegment } from '@dxos/react-ui-attention';
+
+import { ASSISTANT_COMPANION_VARIANT, meta } from '#meta';
+import { AssistantCapabilities, AssistantOperation } from '#types';
+
+/** Operation definitions to seed as `PersistentOperation` records for automation / triggers. */
+const computeOperationsToImport = [AgentPrompt] as const;
+
+/** Match ECHO objects that are NOT chats. */
+const whenNonChatObject = NodeMatcher.whenAll(
+  NodeMatcher.whenEchoObject,
+  NodeMatcher.whenNot(NodeMatcher.whenEchoTypeMatches(Chat.Chat)),
+);
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    const capabilities = yield* Capability.Service;
+
+    const extensions = yield* Effect.all([
+      GraphBuilder.createTypeExtension({
+        id: 'root',
+        type: Chat.Chat,
+        actions: (chat) => {
+          return Effect.succeed([
+            Node.makeAction({
+              id: AssistantOperation.UpdateChatName.meta.key,
+              data: () =>
+                Effect.gen(function* () {
+                  // TODO(dmaretskyi): This goes away when composer will have unified operation invocations.
+                  const computeRuntime = yield* Capability.get(AutomationCapabilities.ComputeRuntime);
+                  const db = Obj.getDatabase(chat);
+                  invariant(db);
+                  const runtime = yield* computeRuntime.getRuntime(db.spaceId).runtimeEffect;
+                  yield* Operation.invoke(AssistantOperation.UpdateChatName, { chat }).pipe(Effect.provide(runtime));
+                }),
+              properties: {
+                label: ['chat-update-name.label', { ns: meta.id }],
+                icon: 'ph--magic-wand--regular',
+                disposition: 'list-item',
+              },
+            }),
+          ]);
+        },
+      }),
+
+      GraphBuilder.createExtension({
+        id: 'assistant',
+        match: NodeMatcher.whenRoot,
+        actions: () =>
+          Effect.succeed([
+            Node.makeAction({
+              id: 'import-compute-operations',
+              data: Effect.fnUntraced(function* () {
+                const capabilities = yield* Capability.Service;
+                const client = yield* Capability.get(ClientCapabilities.Client);
+                const space = getActiveSpace(client, capabilities) ?? getPersonalSpace(client);
+                if (!space) {
+                  return;
+                }
+                for (const definition of computeOperationsToImport) {
+                  const key = definition.meta.key;
+                  if (!key) {
+                    continue;
                   }
-
-                  await dispatch(
-                    createIntent(LayoutAction.UpdateDialog, {
-                      part: 'dialog',
-                      subject: ASSISTANT_DIALOG,
-                      options: {
-                        state: true,
-                        blockAlign: 'end',
-                        props: {
-                          chat,
-                        },
-                      },
-                    }),
+                  const existing = yield* Effect.promise(
+                    (): Promise<Operation.PersistentOperation[]> =>
+                      space.db.query(Filter.type(Operation.PersistentOperation, { key })).run(),
                   );
-                },
-                properties: {
-                  label: ['open assistant label', { ns: ASSISTANT_PLUGIN }],
-                  icon: 'ph--sparkle--regular',
-                  disposition: 'pin-end',
-                  position: 'hoist',
-                  keyBinding: {
-                    macos: 'shift+meta+k',
-                    windows: 'shift+ctrl+k',
-                  },
-                },
+                  if (existing.length === 0) {
+                    space.db.add(Operation.serialize(definition));
+                  }
+                }
+                yield* Database.flush();
+              }),
+              properties: {
+                label: ['import-compute-operations.label', { ns: meta.id }],
+                icon: 'ph--download-simple--regular',
               },
-            ]),
-            Option.getOrElse(() => []),
-          ),
-        ),
-    }),
-
-    createExtension({
-      id: `${ASSISTANT_PLUGIN}/object-chat-companion`,
-      connector: (node) => {
-        let query: QueryResult<AIChatType> | undefined;
-        return Rx.make((get) => {
-          const nodeOption = get(node);
-          if (Option.isNone(nodeOption)) {
-            return [];
-          }
-
-          const object = nodeOption.value.data;
-          if (!Obj.isObject(object)) {
-            return [];
-          }
-
-          const space = getSpace(object);
-          if (!space) {
-            return [];
-          }
-
-          if (!query) {
-            query = space.db.query(Query.select(Filter.ids(object.id)).targetOf(CompanionTo).source());
-          }
-
-          const chat = get(rxFromQuery(query))[0];
-          return [
-            {
-              id: [fullyQualifiedId(object), 'assistant-chat'].join(ATTENDABLE_PATH_SEPARATOR),
-              type: PLANK_COMPANION_TYPE,
-              data: chat ?? 'assistant-chat',
+            }),
+            Node.makeAction({
+              id: 'reset-blueprints',
+              data: Effect.fnUntraced(function* () {
+                const capabilities = yield* Capability.Service;
+                const client = yield* Capability.get(ClientCapabilities.Client);
+                const space = getActiveSpace(client, capabilities) ?? getPersonalSpace(client);
+                if (!space) {
+                  return;
+                }
+                const blueprints = yield* Effect.promise(
+                  (): Promise<Blueprint.Blueprint[]> => space.db.query(Filter.type(Blueprint.Blueprint)).run(),
+                );
+                for (const blueprint of blueprints) {
+                  space.db.remove(blueprint);
+                }
+                yield* Database.flush();
+              }),
               properties: {
-                label: ['assistant chat label', { ns: ASSISTANT_PLUGIN }],
+                label: ['reset-blueprints.label', { ns: meta.id }],
+                icon: 'ph--arrow-clockwise--regular',
+              },
+            }),
+          ]),
+      }),
+
+      // Don't show assistant companion when a chat is already the primary object.
+      GraphBuilder.createExtension({
+        id: 'companion-chat',
+        match: whenNonChatObject,
+        connector: (object, get) =>
+          Effect.gen(function* () {
+            const state = get(yield* Capability.get(AssistantCapabilities.State));
+            const cache = get(yield* Capability.get(AssistantCapabilities.CompanionChatCache));
+            const objectDxn = Obj.getDXN(object).toString();
+
+            // Resolve chat from persisted state or transient cache.
+            const chat = pipe(
+              Option.fromNullable(state.currentChat[objectDxn]),
+              Option.flatMap((dxnStr) => Option.fromNullable(DXN.tryParse(dxnStr))),
+              Option.flatMap((dxn) => Option.fromNullable(Obj.getDatabase(object)?.makeRef(dxn))),
+              Option.map((ref) => get(AtomObj.make(ref as Ref.Ref<Obj.Unknown>))),
+              Option.filter(Obj.isObject),
+              Option.orElse(() => pipe(Option.fromNullable(cache[objectDxn]), Option.filter(Obj.isObject))),
+              Option.getOrNull,
+            );
+
+            return [
+              AppNode.makeCompanion({
+                id: linkedSegment(ASSISTANT_COMPANION_VARIANT),
+                label: ['assistant-chat.label', { ns: meta.id }],
                 icon: 'ph--sparkle--regular',
+                data: chat,
                 position: 'hoist',
-                disposition: 'hidden',
-              },
-            },
-          ];
-        });
-      },
-    }),
-
-    createExtension({
-      id: `${ASSISTANT_PLUGIN}/blueprint-logs`,
-      connector: (node) =>
-        Rx.make((get) =>
-          pipe(
-            get(node),
-            Option.flatMap((node) => (Obj.instanceOf(Blueprint, node.data) ? Option.some(node) : Option.none())),
-            Option.map((node) => [
-              {
-                id: [node.id, 'logs'].join(ATTENDABLE_PATH_SEPARATOR),
-                type: PLANK_COMPANION_TYPE,
-                data: 'logs',
-                properties: {
-                  label: ['blueprint logs label', { ns: ASSISTANT_PLUGIN }],
-                  icon: 'ph--clock-countdown--regular',
-                  disposition: 'hidden',
-                },
-              },
-            ]),
-            Option.getOrElse(() => []),
-          ),
+              }),
+            ];
+          }),
+      }),
+
+      GraphBuilder.createExtension({
+        id: 'invocations',
+        match: NodeMatcher.whenAny(
+          NodeMatcher.whenEchoTypeMatches(Sequence),
+          NodeMatcher.whenEchoTypeMatches(Routine.Routine),
         ),
-    }),
-
-    createExtension({
-      id: `${ASSISTANT_PLUGIN}/root`,
-      connector: (node) => {
-        let query: QueryResult<TemplateType> | undefined;
-        return Rx.make((get) =>
-          pipe(
-            get(node),
-            Option.flatMap((node) =>
-              node.type === SPACE_TYPE && isSpace(node.data) ? Option.some(node.data) : Option.none(),
-            ),
-            Option.map((space) => {
-              if (!query) {
-                query = space.db.query(Query.type(TemplateType));
-              }
-
-              const templates = get(rxFromQuery(query));
-              return templates.length > 0
-                ? [
-                    {
-                      id: `${ASSISTANT_PLUGIN}/templates`,
-                      type: `${ASSISTANT_PLUGIN}/templates`,
-                      data: null,
-                      properties: {
-                        label: ['templates label', { ns: ASSISTANT_PLUGIN }],
-                        icon: 'ph--file-code--regular',
-                        space,
-                      },
-                    },
-                  ]
-                : [];
+        connector: () =>
+          Effect.succeed([
+            AppNode.makeCompanion({
+              id: 'invocations',
+              label: ['invocations.label', { ns: meta.id }],
+              icon: 'ph--clock-countdown--regular',
+              data: 'invocations',
             }),
-            Option.getOrElse(() => []),
-          ),
-        );
-      },
-    }),
-
-    createExtension({
-      id: `${ASSISTANT_PLUGIN}/templates`,
-      connector: (node) => {
-        let query: QueryResult<TemplateType> | undefined;
-        return Rx.make((get) =>
-          pipe(
-            get(node),
-            Option.flatMap((node) =>
-              node.id === `${ASSISTANT_PLUGIN}/templates` && isSpace(node.properties.space)
-                ? Option.some(node.properties.space)
-                : Option.none(),
-            ),
-            Option.map((space) => {
-              if (!query) {
-                query = space.db.query(Query.type(TemplateType));
-              }
-              return get(rxFromQuery(query))
-                .toSorted((a, b) => {
-                  const nameA = a.name ?? '';
-                  const nameB = b.name ?? '';
-                  return nameA.localeCompare(nameB);
-                })
-                .map((template) => ({
-                  id: fullyQualifiedId(template),
-                  type: `${ASSISTANT_PLUGIN}/template`,
-                  data: template,
-                  properties: {
-                    label: template.name ?? ['object placeholder', { ns: ASSISTANT_PLUGIN }],
-                    icon: 'ph--file-code--regular',
-                  },
-                }));
+          ]),
+      }),
+
+      GraphBuilder.createExtension({
+        id: 'trace',
+        match: NodeMatcher.whenRoot,
+        connector: () =>
+          Effect.succeed([
+            AppNode.makeDeckCompanion({
+              id: linkedSegment('trace'),
+              label: ['trace.label', { ns: meta.id }],
+              icon: 'ph--line-segments--regular',
+              data: 'trace' as const,
+              position: 'fallback',
             }),
-            Option.getOrElse(() => []),
-          ),
-        );
-      },
-    }),
-  ]);
-
-// TODO(burdon): Factor out.
-const getOrCreateChat = async (dispatch: PromiseIntentDispatcher, space: Space): Promise<AIChatType | undefined> => {
-  // TODO(wittjosiah): This should be possible with a single query.
-  const { objects: allChats } = await space.db.query(Query.type(AIChatType)).run();
-  const { objects: relatedChats } = await space.db.query(Query.type(AIChatType).sourceOf(CompanionTo).source()).run();
-  const chats = allChats.filter((chat) => !relatedChats.includes(chat));
-  // console.log('objects', JSON.stringify(objects, null, 2));
-  if (chats.length > 0) {
-    // TODO(burdon): Is this the most recent?
-    return chats[chats.length - 1];
-  }
+          ]),
+      }),
+    ]);
 
-  const { data } = await dispatch(createIntent(AssistantAction.CreateChat, { space }));
-  invariant(Obj.instanceOf(AIChatType, data?.object));
-  await dispatch(createIntent(SpaceAction.AddObject, { target: space, object: data.object }));
-  return data.object;
-};
+    return Capability.contributes(AppCapabilities.AppGraphBuilder, extensions);
+  }),
+);

package/src/capabilities/blueprint-definition.ts

@@ -0,0 +1,56 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { AppCapabilities } from '@dxos/app-toolkit';
+import {
+  AgentBlueprint,
+  AgentBlueprintHandlers,
+  AgentHandlers,
+  AgentWizardBlueprint,
+  AgentWizardHandlers,
+  BlueprintManagerBlueprint,
+  BlueprintManagerHandlers,
+  BrowserBlueprint,
+  DatabaseBlueprint,
+  DatabaseHandlers,
+  DiscordBlueprint,
+  LinearBlueprint,
+  PlanningBlueprint,
+  WebSearchBlueprint,
+  MemoryBlueprint,
+  AutomationBlueprint,
+} from '@dxos/assistant-toolkit';
+// eslint-disable-next-line unused-imports/no-unused-imports
+import type { Blueprint } from '@dxos/compute';
+
+import { AssistantBlueprint } from '#blueprints';
+
+// TODO(dmaretskyi): Force this type for all Capability.makeModule calls.
+const blueprintDefinition: () => Effect.Effect<Capability.Capability<unknown>[]> = Capability.makeModule(() =>
+  Effect.succeed([
+    Capability.contributes(AppCapabilities.BlueprintDefinition, AssistantBlueprint),
+    Capability.contributes(AppCapabilities.BlueprintDefinition, BrowserBlueprint),
+    Capability.contributes(AppCapabilities.BlueprintDefinition, DatabaseBlueprint),
+    Capability.contributes(AppCapabilities.BlueprintDefinition, WebSearchBlueprint),
+    Capability.contributes(AppCapabilities.BlueprintDefinition, DiscordBlueprint),
+    Capability.contributes(AppCapabilities.BlueprintDefinition, LinearBlueprint),
+    Capability.contributes(AppCapabilities.BlueprintDefinition, AgentBlueprint),
+    Capability.contributes(AppCapabilities.BlueprintDefinition, PlanningBlueprint),
+    Capability.contributes(AppCapabilities.BlueprintDefinition, MemoryBlueprint),
+    Capability.contributes(AppCapabilities.BlueprintDefinition, AutomationBlueprint),
+    Capability.contributes(AppCapabilities.BlueprintDefinition, BlueprintManagerBlueprint),
+    Capability.contributes(AppCapabilities.BlueprintDefinition, AgentWizardBlueprint),
+
+    Capability.contributes(Capabilities.OperationHandler, AgentHandlers),
+    Capability.contributes(Capabilities.OperationHandler, AgentBlueprintHandlers),
+    Capability.contributes(Capabilities.OperationHandler, BlueprintManagerHandlers),
+    Capability.contributes(Capabilities.OperationHandler, DatabaseHandlers),
+    Capability.contributes(Capabilities.OperationHandler, AgentWizardHandlers),
+  ]),
+);
+
+export default blueprintDefinition;

package/src/capabilities/companion-chat-provisioner.ts

@@ -0,0 +1,163 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Registry } from '@effect-atom/atom-react';
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { Graph, type Node } from '@dxos/app-graph';
+import { AppCapabilities } from '@dxos/app-toolkit';
+import { Chat } from '@dxos/assistant-toolkit';
+import { Obj } from '@dxos/echo';
+import { log } from '@dxos/log';
+import { DeckCapabilities, PLANK_COMPANION_TYPE, type StoredDeckState } from '@dxos/plugin-deck';
+import { getLinkedVariant } from '@dxos/react-ui-attention';
+import { byPosition } from '@dxos/util';
+
+import { ASSISTANT_COMPANION_VARIANT } from '#meta';
+import { AssistantCapabilities, AssistantOperation } from '#types';
+
+/**
+ * Non-React capability that watches deck companion state and provisions transient chats
+ * for active planks when the assistant companion is selected.
+ */
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    const operationInvoker = yield* Capability.get(Capabilities.OperationInvoker);
+    const { graph } = yield* Capability.get(AppCapabilities.AppGraph);
+    const registry: Registry.Registry = yield* Capability.get(Capabilities.AtomRegistry);
+    const deckStateAtom = yield* Capability.get(DeckCapabilities.State);
+    const cacheAtom = yield* Capability.get(AssistantCapabilities.CompanionChatCache);
+    const stateAtom = yield* Capability.get(AssistantCapabilities.State);
+
+    const plankSubs = new Map<string, () => void>();
+
+    /** Unsubscribe a single plank and remove it from the map. */
+    const unsubPlank = (plankId: string) => {
+      plankSubs.get(plankId)?.();
+      plankSubs.delete(plankId);
+    };
+
+    /** Unsubscribe all per-plank subscriptions. */
+    const unsubAllPlanks = () => {
+      for (const unsub of plankSubs.values()) {
+        unsub();
+      }
+      plankSubs.clear();
+    };
+
+    /**
+     * Attempt to provision for a single plank.
+     * Returns true when the plank is resolved (provisioned or already cached)
+     * so the caller can tear down the connection subscription.
+     */
+    const provisionForPlank = (plankId: string, companionVariant: string | undefined): boolean => {
+      const node: Node.Node | null = Graph.getNode(graph, plankId).pipe(Option.getOrNull);
+      if (!node || !Obj.isObject(node.data) || Obj.instanceOf(Chat.Chat, node.data)) {
+        return false;
+      }
+
+      if (resolveEffectiveVariant(graph, plankId, companionVariant) !== ASSISTANT_COMPANION_VARIANT) {
+        return false;
+      }
+
+      const object = node.data;
+      const companionDxn = Obj.getDXN(object).toString();
+      const cache = registry.get(cacheAtom);
+      if (cache[companionDxn]) {
+        return true;
+      }
+
+      const db = Obj.getDatabase(object);
+      if (!db) {
+        return false;
+      }
+
+      void operationInvoker
+        .invokePromise(AssistantOperation.EnsureCompanionChat, { db, companionTo: object })
+        .catch((error) => log.warn('Failed to provision companion chat', { plankId, error }));
+
+      return false;
+    };
+
+    const provision = () => {
+      const deckState: StoredDeckState = registry.get(deckStateAtom);
+      const deck = deckState.decks[deckState.activeDeck];
+      if (!deck?.companionOpen) {
+        unsubAllPlanks();
+        return;
+      }
+
+      const plankIds = new Set(deck.solo ? [deck.solo] : deck.active);
+
+      // Remove subscriptions for planks that are no longer active.
+      for (const trackedId of plankSubs.keys()) {
+        if (!plankIds.has(trackedId)) {
+          unsubPlank(trackedId);
+        }
+      }
+
+      for (const plankId of plankIds) {
+        const resolved = provisionForPlank(plankId, deck.companionVariant);
+
+        if (resolved) {
+          // Already provisioned — no need to watch connections.
+          unsubPlank(plankId);
+        } else if (!plankSubs.has(plankId)) {
+          // Not yet resolved — subscribe to child connections so we re-try
+          // when graph builder extensions add companion nodes (after expand).
+          plankSubs.set(
+            plankId,
+            registry.subscribe(graph.connections(plankId, 'child'), () => {
+              if (provisionForPlank(plankId, deck.companionVariant)) {
+                unsubPlank(plankId);
+              }
+            }),
+          );
+        }
+      }
+    };
+
+    provision();
+
+    const unsub1 = registry.subscribe(deckStateAtom, provision);
+    const unsub2 = registry.subscribe(stateAtom, provision);
+
+    return Capability.contributes(Capabilities.Null, null, () =>
+      Effect.sync(() => {
+        unsub1();
+        unsub2();
+        unsubAllPlanks();
+      }),
+    );
+  }),
+);
+
+/**
+ * Mirrors useSelectedCompanion fallback logic outside of React.
+ * Returns the variant that would actually be rendered for a given plank.
+ */
+const resolveEffectiveVariant = (
+  graph: Graph.BaseGraph,
+  plankId: string,
+  preferredVariant: string | undefined,
+): string | undefined => {
+  const companions = Graph.getConnections(graph, plankId, 'child')
+    .filter((node) => node.type === PLANK_COMPANION_TYPE)
+    .toSorted((a, b) => byPosition(a.properties, b.properties));
+
+  if (companions.length === 0) {
+    return undefined;
+  }
+
+  if (preferredVariant) {
+    const preferred = companions.find((companion) => getLinkedVariant(companion.id) === preferredVariant);
+    if (preferred) {
+      return getLinkedVariant(preferred.id);
+    }
+  }
+
+  return getLinkedVariant(companions[0].id);
+};