@dxos/plugin-preview 0.8.4-main.fd6878d → 0.8.4-staging.60fe92afc8

package/package.json

@@ -1,63 +1,107 @@
 {
   "name": "@dxos/plugin-preview",
-  "version": "0.8.4-main.fd6878d",
+  "version": "0.8.4-staging.60fe92afc8",
   "description": "Preview plugin",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
-  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
+  "license": "FSL-1.1-Apache-2.0",
   "author": "DXOS.org",
   "sideEffects": true,
   "type": "module",
+  "imports": {
+    "#capabilities": {
+      "source": "./src/capabilities/index.ts",
+      "types": "./dist/types/src/capabilities/index.d.ts",
+      "default": "./dist/lib/neutral/capabilities/index.mjs"
+    },
+    "#meta": {
+      "source": "./src/meta.ts",
+      "types": "./dist/types/src/meta.d.ts",
+      "default": "./dist/lib/neutral/meta.mjs"
+    },
+    "#plugin": {
+      "source": {
+        "workerd": "./src/PreviewPlugin.workerd.ts",
+        "node": "./src/PreviewPlugin.node.ts",
+        "default": "./src/PreviewPlugin.tsx"
+      },
+      "types": "./dist/types/src/PreviewPlugin.d.ts",
+      "workerd": "./dist/lib/neutral/PreviewPlugin.workerd.mjs",
+      "node": "./dist/lib/neutral/PreviewPlugin.node.mjs",
+      "default": "./dist/lib/neutral/PreviewPlugin.mjs"
+    },
+    "#translations": {
+      "source": "./src/translations.ts",
+      "types": "./dist/types/src/translations.d.ts",
+      "default": "./dist/lib/neutral/translations.mjs"
+    }
+  },
   "exports": {
     ".": {
       "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
-      "browser": "./dist/lib/browser/index.mjs"
+      "default": "./dist/lib/neutral/index.mjs"
+    },
+    "./plugin": {
+      "source": "./src/plugin.ts",
+      "types": "./dist/types/src/plugin.d.ts",
+      "default": "./dist/lib/neutral/plugin.mjs"
+    },
+    "./testing": {
+      "source": "./src/testing.ts",
+      "types": "./dist/types/src/testing.d.ts",
+      "default": "./dist/lib/neutral/testing.mjs"
+    },
+    "./translations": {
+      "source": "./src/translations.ts",
+      "types": "./dist/types/src/translations.d.ts",
+      "default": "./dist/lib/neutral/translations.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
-  "typesVersions": {
-    "*": {}
-  },
   "files": [
     "dist",
     "src"
   ],
   "dependencies": {
-    "@preact-signals/safe-react": "^0.9.0",
-    "@dxos/app-framework": "0.8.4-main.fd6878d",
-    "@dxos/async": "0.8.4-main.fd6878d",
-    "@dxos/echo": "0.8.4-main.fd6878d",
-    "@dxos/client": "0.8.4-main.fd6878d",
-    "@dxos/keys": "0.8.4-main.fd6878d",
-    "@dxos/lit-ui": "0.8.4-main.fd6878d",
-    "@dxos/echo-schema": "0.8.4-main.fd6878d",
-    "@dxos/log": "0.8.4-main.fd6878d",
-    "@dxos/plugin-attention": "0.8.4-main.fd6878d",
-    "@dxos/plugin-client": "0.8.4-main.fd6878d",
-    "@dxos/plugin-deck": "0.8.4-main.fd6878d",
-    "@dxos/react-ui": "0.8.4-main.fd6878d",
-    "@dxos/react-client": "0.8.4-main.fd6878d",
-    "@dxos/react-ui-editor": "0.8.4-main.fd6878d",
-    "@dxos/react-ui-form": "0.8.4-main.fd6878d",
-    "@dxos/react-ui-stack": "0.8.4-main.fd6878d",
-    "@dxos/react-ui-table": "0.8.4-main.fd6878d",
-    "@dxos/react-ui-theme": "0.8.4-main.fd6878d",
-    "@dxos/schema": "0.8.4-main.fd6878d",
-    "@dxos/util": "0.8.4-main.fd6878d"
+    "@dxos/app-framework": "0.8.4-staging.60fe92afc8",
+    "@dxos/app-toolkit": "0.8.4-staging.60fe92afc8",
+    "@dxos/async": "0.8.4-staging.60fe92afc8",
+    "@dxos/client": "0.8.4-staging.60fe92afc8",
+    "@dxos/echo-react": "0.8.4-staging.60fe92afc8",
+    "@dxos/echo": "0.8.4-staging.60fe92afc8",
+    "@dxos/effect": "0.8.4-staging.60fe92afc8",
+    "@dxos/keys": "0.8.4-staging.60fe92afc8",
+    "@dxos/log": "0.8.4-staging.60fe92afc8",
+    "@dxos/react-ui": "0.8.4-staging.60fe92afc8",
+    "@dxos/plugin-client": "0.8.4-staging.60fe92afc8",
+    "@dxos/react-ui-form": "0.8.4-staging.60fe92afc8",
+    "@dxos/react-ui-mosaic": "0.8.4-staging.60fe92afc8",
+    "@dxos/schema": "0.8.4-staging.60fe92afc8",
+    "@dxos/react-ui-syntax-highlighter": "0.8.4-staging.60fe92afc8",
+    "@dxos/ui-editor": "0.8.4-staging.60fe92afc8",
+    "@dxos/types": "0.8.4-staging.60fe92afc8",
+    "@dxos/util": "0.8.4-staging.60fe92afc8"
   },
   "devDependencies": {
-    "effect": "3.17.7",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "vite": "5.4.7",
-    "@dxos/storybook-utils": "0.8.4-main.fd6878d",
-    "@dxos/random": "0.8.4-main.fd6878d"
+    "effect": "3.21.3",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "vite": "^8.0.16",
+    "@dxos/echo-react": "0.8.4-staging.60fe92afc8",
+    "@dxos/plugin-testing": "0.8.4-staging.60fe92afc8",
+    "@dxos/random": "0.8.4-staging.60fe92afc8",
+    "@dxos/storybook-utils": "0.8.4-staging.60fe92afc8",
+    "@dxos/react-ui-components": "0.8.4-staging.60fe92afc8"
   },
   "peerDependencies": {
-    "effect": "^3.13.3",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0"
+    "effect": "3.21.3",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3"
   },
   "publishConfig": {
     "access": "public"

package/src/PreviewPlugin.node.ts

@@ -0,0 +1,16 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { Plugin } from '@dxos/app-framework';
+import { AppPlugin } from '@dxos/app-toolkit';
+import { Organization, Person } from '@dxos/types';
+
+import { meta } from '#meta';
+
+export const PreviewPlugin = Plugin.define(meta).pipe(
+  AppPlugin.addSchemaModule({ schema: [Person.Person, Organization.Organization] }),
+  Plugin.make,
+);
+
+export default PreviewPlugin;

package/src/PreviewPlugin.test.ts

@@ -0,0 +1,25 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { describe, test } from 'vitest';
+
+import { ClientPlugin } from '@dxos/plugin-client/plugin';
+import { createComposerTestApp } from '@dxos/plugin-testing/harness';
+
+import { PreviewPlugin } from '#plugin';
+
+import { meta } from './meta';
+
+const moduleId = (name: string) => `${meta.id}.module.${name}`;
+
+describe('PreviewPlugin', () => {
+  test('modules activate on the expected events', { timeout: 10_000 }, async ({ expect }) => {
+    await using harness = await createComposerTestApp({
+      plugins: [ClientPlugin({}), PreviewPlugin()],
+    });
+
+    // After autoStart: schema auto-cascades from ClientPlugin.
+    expect(harness.manager.getActive()).toContain(moduleId('schema'));
+  });
+});

package/src/PreviewPlugin.tsx

@@ -2,34 +2,24 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Capabilities, Events, contributes, defineModule, definePlugin } from '@dxos/app-framework';
-import { ClientCapabilities, ClientEvents } from '@dxos/plugin-client';
-import { DataType } from '@dxos/schema';
+import { ActivationEvents, Plugin } from '@dxos/app-framework';
+import { AppPlugin } from '@dxos/app-toolkit';
+import { Organization, Person } from '@dxos/types';
 
-import { PreviewPopover, ReactSurface } from './capabilities';
-import { meta } from './meta';
-import { translations } from './translations';
+import { PreviewPopover, ReactSurface } from '#capabilities';
+import { meta } from '#meta';
+import { translations } from '#translations';
 
-export const PreviewPlugin = () =>
-  definePlugin(meta, [
-    defineModule({
-      id: `${meta.id}/module/translations`,
-      activatesOn: Events.SetupTranslations,
-      activate: () => contributes(Capabilities.Translations, translations),
-    }),
-    defineModule({
-      id: `${meta.id}/module/schema`,
-      activatesOn: ClientEvents.SetupSchema,
-      activate: () => [contributes(ClientCapabilities.Schema, [DataType.Person, DataType.Organization])],
-    }),
-    defineModule({
-      id: `${meta.id}/module/preview-popover`,
-      activatesOn: Events.Startup,
-      activate: PreviewPopover,
-    }),
-    defineModule({
-      id: `${meta.id}/module/react-surface`,
-      activatesOn: Events.SetupReactSurface,
-      activate: ReactSurface,
-    }),
-  ]);
+export const PreviewPlugin = Plugin.define(meta).pipe(
+  AppPlugin.addSchemaModule({ schema: [Person.Person, Organization.Organization] }),
+  AppPlugin.addSurfaceModule({ activate: ReactSurface }),
+  AppPlugin.addTranslationsModule({ translations }),
+  Plugin.addModule({
+    id: 'preview-popover',
+    activatesOn: ActivationEvents.Startup,
+    activate: PreviewPopover,
+  }),
+  Plugin.make,
+);
+
+export default PreviewPlugin;

package/src/PreviewPlugin.workerd.ts

@@ -0,0 +1,16 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { Plugin } from '@dxos/app-framework';
+import { AppPlugin } from '@dxos/app-toolkit';
+import { Organization, Person } from '@dxos/types';
+
+import { meta } from '#meta';
+
+export const PreviewPlugin = Plugin.define(meta).pipe(
+  AppPlugin.addSchemaModule({ schema: [Person.Person, Organization.Organization] }),
+  Plugin.make,
+);
+
+export default PreviewPlugin;

package/src/capabilities/index.ts

@@ -2,7 +2,7 @@
 // Copyright 2025 DXOS.org
 //
 
-import { lazy } from '@dxos/app-framework';
+import { Capability } from '@dxos/app-framework';
 
-export const PreviewPopover = lazy(() => import('./preview-popover'));
-export const ReactSurface = lazy(() => import('./react-surface'));
+export const PreviewPopover = Capability.lazy('PreviewPopover', () => import('./preview-popover'));
+export const ReactSurface = Capability.lazy('ReactSurface', () => import('./react-surface'));

package/src/capabilities/preview-popover.ts

@@ -2,73 +2,120 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Capabilities, LayoutAction, type PluginContext, contributes, createIntent } from '@dxos/app-framework';
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { AppCapabilities, LayoutOperation, getPersonalSpace, getSpaceIdFromPath } from '@dxos/app-toolkit';
 import { addEventListener } from '@dxos/async';
-import { type Client, resolveRef } from '@dxos/client';
-import { type Space, parseId } from '@dxos/client/echo';
-import { DXN } from '@dxos/keys';
-import { type DxRefTagActivate } from '@dxos/lit-ui';
+import { type Client } from '@dxos/client';
+import { type Space } from '@dxos/client/echo';
+import { Obj } from '@dxos/echo';
+import { EID } from '@dxos/keys';
 import { log } from '@dxos/log';
 import { ClientCapabilities } from '@dxos/plugin-client';
-import { type PreviewLinkRef, type PreviewLinkTarget } from '@dxos/react-ui-editor';
+import { DX_ANCHOR_ACTIVATE, type DxAnchorActivate } from '@dxos/react-ui';
+import { type PreviewLinkRef, type PreviewLinkTarget } from '@dxos/ui-editor';
 
 const customEventOptions = { capture: true, passive: false };
 
 const handlePreviewLookup = async (
   client: Client,
   defaultSpace: Space,
-  { ref, label }: PreviewLinkRef,
+  { dxn, label }: PreviewLinkRef,
 ): Promise<PreviewLinkTarget | null> => {
   try {
-    const dxn = DXN.parse(ref);
-    if (!dxn) {
-      return null;
-    }
-
-    const object = await resolveRef(client, dxn, defaultSpace);
+    const object = await defaultSpace.db.makeRef(EID.parse(dxn)).load();
     return { label, object };
-  } catch (err) {
+  } catch {
     return null;
   }
 };
 
-export default (context: PluginContext) => {
-  // TODO(wittjosiah): Factor out lookup handlers to other plugins to make not ECHO-specific.
-  const handleDxRefTagActivate = async ({ refId, label, trigger }: DxRefTagActivate) => {
-    const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-    const client = context.getCapability(ClientCapabilities.Client);
-    const [layout] = context.getCapabilities(Capabilities.Layout);
-    const { spaceId } = parseId(layout.workspace);
-    const space = (spaceId && client.spaces.get(spaceId)) ?? client.spaces.default;
-    const result = await handlePreviewLookup(client, space, { ref: refId, label });
-    if (!result) {
-      return;
-    }
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    // Get context for lazy capability access in callbacks.
+    const capabilities = yield* Capability.Service;
 
-    await dispatch(
-      createIntent(LayoutAction.UpdatePopover, {
-        part: 'popover',
-        subject: result.object,
-        options: {
-          state: true,
+    // TODO(wittjosiah): Factor out lookup handlers to other plugins to make not ECHO-specific.
+    // Monotonic activation token: each invocation captures its own sequence; only the
+    // most recent activation is allowed to commit popover state. Prevents a slow
+    // open (async lookup) from clobbering a later close that fires while it's in flight.
+    let activationSequence = 0;
+    const handleAnchorActivate = async ({
+      dxn,
+      label,
+      trigger,
+      kind = 'card',
+      title: titleProp,
+      side,
+      props,
+      state,
+    }: DxAnchorActivate) => {
+      const sequence = ++activationSequence;
+      const { invokePromise } = capabilities.get(Capabilities.OperationInvoker);
+
+      // Explicit close: callers pass `state: false` on pointer-leave to dismiss
+      // the popover. Operation schema requires anchor + kind, so use placeholders;
+      // they're overwritten in ephemeral state but only `state` is read by the UI.
+      if (state === false) {
+        await invokePromise(LayoutOperation.UpdatePopover, {
           variant: 'virtual',
           anchor: trigger,
-        },
-      }),
-    );
-  };
+          kind: 'base',
+          state: false,
+        });
+        return;
+      }
 
-  let cleanup: () => void;
-  if (document.defaultView) {
-    cleanup = addEventListener(
-      document.defaultView,
-      'dx-ref-tag-activate' as any,
-      handleDxRefTagActivate,
-      customEventOptions,
-    );
-  } else {
-    log.warn('No default view found');
-  }
+      const client = capabilities.get(ClientCapabilities.Client);
+      const registry = capabilities.get(Capabilities.AtomRegistry);
+      // Layout is optional: in standalone harnesses (Storybook, tests) no plugin contributes
+      // `AppCapabilities.Layout`, and `getAll` returns an empty array. Reading `registry.get(undefined)`
+      // would crash inside Atom's identity check (`'~atom/Serializable' in undefined`). When layout
+      // isn't available, fall through to the personal-space default.
+      const [layoutAtom] = capabilities.getAll(AppCapabilities.Layout);
+      const spaceId = layoutAtom && getSpaceIdFromPath(registry.get(layoutAtom).workspace);
+      const space = (spaceId && client.spaces.get(spaceId)) ?? getPersonalSpace(client);
+      if (!space) {
+        return;
+      }
+      const result = await handlePreviewLookup(client, space, { dxn, label });
+      if (!result) {
+        return;
+      }
+      // A newer activation (open or close) arrived while the lookup was in flight; bail
+      // out so we don't clobber the latest state.
+      if (sequence !== activationSequence) {
+        return;
+      }
 
-  return contributes(Capabilities.Null, null, () => cleanup());
-};
+      const title = titleProp ?? Obj.getLabel(result.object, { fallback: 'typename' });
+
+      await invokePromise(LayoutOperation.UpdatePopover, {
+        subjectRef: dxn,
+        subject: result.object,
+        state: true,
+        variant: 'virtual',
+        anchor: trigger,
+        ...(kind && { kind }),
+        ...(title && { title }),
+        ...(side && { side }),
+        ...(props && { props }),
+      });
+    };
+
+    let cleanup: () => void;
+    if (document.defaultView) {
+      cleanup = addEventListener(
+        document.defaultView,
+        DX_ANCHOR_ACTIVATE as any,
+        handleAnchorActivate,
+        customEventOptions,
+      );
+    } else {
+      log.warn('no default view found');
+    }
+
+    return Capability.contributes(Capabilities.Null, null, () => Effect.sync(() => cleanup?.()));
+  }),
+);