@dxos/plugin-preview 0.8.4-main.c1de068 → 0.8.4-main.c85a9c8dae

package/package.json

@@ -1,15 +1,20 @@
 {
   "name": "@dxos/plugin-preview",
-  "version": "0.8.4-main.c1de068",
+  "version": "0.8.4-main.c85a9c8dae",
   "description": "Preview plugin",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "license": "MIT",
   "author": "DXOS.org",
   "sideEffects": true,
   "type": "module",
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs"
     }
@@ -23,40 +28,50 @@
     "src"
   ],
   "dependencies": {
-    "@preact-signals/safe-react": "^0.9.0",
-    "@dxos/app-framework": "0.8.4-main.c1de068",
-    "@dxos/async": "0.8.4-main.c1de068",
-    "@dxos/client": "0.8.4-main.c1de068",
-    "@dxos/echo": "0.8.4-main.c1de068",
-    "@dxos/keys": "0.8.4-main.c1de068",
-    "@dxos/lit-ui": "0.8.4-main.c1de068",
-    "@dxos/log": "0.8.4-main.c1de068",
-    "@dxos/echo-schema": "0.8.4-main.c1de068",
-    "@dxos/plugin-attention": "0.8.4-main.c1de068",
-    "@dxos/plugin-client": "0.8.4-main.c1de068",
-    "@dxos/plugin-deck": "0.8.4-main.c1de068",
-    "@dxos/react-client": "0.8.4-main.c1de068",
-    "@dxos/react-ui": "0.8.4-main.c1de068",
-    "@dxos/react-ui-editor": "0.8.4-main.c1de068",
-    "@dxos/react-ui-form": "0.8.4-main.c1de068",
-    "@dxos/react-ui-stack": "0.8.4-main.c1de068",
-    "@dxos/react-ui-table": "0.8.4-main.c1de068",
-    "@dxos/react-ui-theme": "0.8.4-main.c1de068",
-    "@dxos/schema": "0.8.4-main.c1de068",
-    "@dxos/util": "0.8.4-main.c1de068"
+    "@effect-atom/atom-react": "^0.5.0",
+    "@dxos/app-framework": "0.8.4-main.c85a9c8dae",
+    "@dxos/async": "0.8.4-main.c85a9c8dae",
+    "@dxos/app-toolkit": "0.8.4-main.c85a9c8dae",
+    "@dxos/echo": "0.8.4-main.c85a9c8dae",
+    "@dxos/effect": "0.8.4-main.c85a9c8dae",
+    "@dxos/keys": "0.8.4-main.c85a9c8dae",
+    "@dxos/lit-ui": "0.8.4-main.c85a9c8dae",
+    "@dxos/log": "0.8.4-main.c85a9c8dae",
+    "@dxos/client": "0.8.4-main.c85a9c8dae",
+    "@dxos/operation": "0.8.4-main.c85a9c8dae",
+    "@dxos/plugin-attention": "0.8.4-main.c85a9c8dae",
+    "@dxos/plugin-client": "0.8.4-main.c85a9c8dae",
+    "@dxos/plugin-deck": "0.8.4-main.c85a9c8dae",
+    "@dxos/react-ui": "0.8.4-main.c85a9c8dae",
+    "@dxos/react-client": "0.8.4-main.c85a9c8dae",
+    "@dxos/plugin-space": "0.8.4-main.c85a9c8dae",
+    "@dxos/react-ui-editor": "0.8.4-main.c85a9c8dae",
+    "@dxos/react-ui-form": "0.8.4-main.c85a9c8dae",
+    "@dxos/react-ui-menu": "0.8.4-main.c85a9c8dae",
+    "@dxos/react-ui-mosaic": "0.8.4-main.c85a9c8dae",
+    "@dxos/react-ui-table": "0.8.4-main.c85a9c8dae",
+    "@dxos/schema": "0.8.4-main.c85a9c8dae",
+    "@dxos/ui-editor": "0.8.4-main.c85a9c8dae",
+    "@dxos/types": "0.8.4-main.c85a9c8dae",
+    "@dxos/ui-theme": "0.8.4-main.c85a9c8dae",
+    "@dxos/util": "0.8.4-main.c85a9c8dae",
+    "@dxos/app-graph": "0.8.4-main.c85a9c8dae"
   },
   "devDependencies": {
-    "effect": "3.17.0",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "vite": "5.4.7",
-    "@dxos/random": "0.8.4-main.c1de068",
-    "@dxos/storybook-utils": "0.8.4-main.c1de068"
+    "effect": "3.19.16",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "vite": "^7.1.11",
+    "@dxos/echo-db": "0.8.4-main.c85a9c8dae",
+    "@dxos/plugin-testing": "0.8.4-main.c85a9c8dae",
+    "@dxos/react-ui-components": "0.8.4-main.c85a9c8dae",
+    "@dxos/random": "0.8.4-main.c85a9c8dae",
+    "@dxos/storybook-utils": "0.8.4-main.c85a9c8dae"
   },
   "peerDependencies": {
-    "effect": "^3.13.3",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0"
+    "effect": "3.19.16",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3"
   },
   "publishConfig": {
     "access": "public"

package/src/PreviewPlugin.tsx

@@ -2,34 +2,22 @@
 // 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';
 
-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], id: 'schema' }),
+  AppPlugin.addSurfaceModule({ activate: ReactSurface }),
+  AppPlugin.addTranslationsModule({ translations }),
+  Plugin.addModule({
+    id: 'preview-popover',
+    activatesOn: ActivationEvents.Startup,
+    activate: PreviewPopover,
+  }),
+  Plugin.make,
+);

package/src/capabilities/index.ts

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

package/src/capabilities/preview-popover/index.ts

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

package/src/capabilities/preview-popover/preview-popover.ts

@@ -0,0 +1,90 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { AppCapabilities, LayoutOperation } from '@dxos/app-toolkit';
+import { addEventListener } from '@dxos/async';
+import { type Client } from '@dxos/client';
+import { type Space, parseId } from '@dxos/client/echo';
+import { Obj } from '@dxos/echo';
+import { DXN } from '@dxos/keys';
+import { log } from '@dxos/log';
+import { ClientCapabilities } from '@dxos/plugin-client';
+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,
+  { dxn, label }: PreviewLinkRef,
+): Promise<PreviewLinkTarget | null> => {
+  try {
+    const object = await defaultSpace.db.makeRef(DXN.parse(dxn)).load();
+    return { label, object };
+  } catch {
+    return null;
+  }
+};
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    // Get context for lazy capability access in callbacks.
+    const capabilities = yield* Capability.Service;
+
+    // TODO(wittjosiah): Factor out lookup handlers to other plugins to make not ECHO-specific.
+    const handleAnchorActivate = async ({
+      dxn,
+      label,
+      trigger,
+      kind = 'card',
+      title: titleProp,
+      side,
+      props,
+    }: DxAnchorActivate) => {
+      const { invokePromise } = capabilities.get(Capabilities.OperationInvoker);
+      const client = capabilities.get(ClientCapabilities.Client);
+      const registry = capabilities.get(Capabilities.AtomRegistry);
+      const [layoutAtom] = capabilities.getAll(AppCapabilities.Layout);
+      const layout = registry.get(layoutAtom);
+      const { spaceId } = parseId(layout.workspace);
+      const space = (spaceId && client.spaces.get(spaceId)) ?? client.spaces.default;
+      const result = await handlePreviewLookup(client, space, { dxn, label });
+      if (!result) {
+        return;
+      }
+
+      const title = titleProp ?? Obj.getLabel(result.object);
+
+      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?.()));
+  }),
+);

package/src/capabilities/react-surface/index.ts

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

package/src/capabilities/react-surface/react-surface.tsx

@@ -0,0 +1,97 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import React from 'react';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { Surface } from '@dxos/app-framework/ui';
+import { Obj } from '@dxos/echo';
+import { Card } from '@dxos/react-ui';
+import { type ProjectionModel } from '@dxos/schema';
+import { Organization, Person, Pipeline, Task } from '@dxos/types';
+
+import { FormCard, OrganizationCard, PersonCard, ProjectCard, TaskCard } from '../../cards';
+import { meta } from '../../meta';
+
+export default Capability.makeModule(() =>
+  Effect.succeed(
+    Capability.contributes(Capabilities.ReactSurface, [
+      //
+      // Specific schema types.
+      // TODO(burdon): Create helpers and factor out.
+      //
+
+      Surface.create<{ subject: Person.Person }>({
+        id: `${meta.id}/schema-popover--contact`,
+        role: 'card--content',
+        position: 'hoist',
+        filter: (data): data is { subject: Person.Person } => Obj.instanceOf(Person.Person, data.subject),
+        component: ({ data, role }) => {
+          return <PersonCard role={role} subject={data.subject} />;
+        },
+      }),
+      Surface.create({
+        id: `${meta.id}/schema-popover--organization`,
+        role: 'card--content',
+        position: 'hoist',
+        filter: (data): data is { subject: Organization.Organization } =>
+          Obj.instanceOf(Organization.Organization, data.subject),
+        component: ({ data, role }) => {
+          return <OrganizationCard role={role} subject={data.subject} />;
+        },
+      }),
+      Surface.create({
+        id: `${meta.id}/schema-popover--project`,
+        role: 'card--content',
+        position: 'hoist',
+        filter: (data): data is { subject: Pipeline.Pipeline } => Obj.instanceOf(Pipeline.Pipeline, data.subject),
+        component: ({ data, role }) => {
+          return <ProjectCard role={role} subject={data.subject} />;
+        },
+      }),
+      Surface.create({
+        id: `${meta.id}/schema-popover--task`,
+        role: 'card--content',
+        position: 'hoist',
+        filter: (data): data is { subject: Task.Task } => Obj.instanceOf(Task.Task, data.subject),
+        component: ({ data, role }) => {
+          return <TaskCard role={role} subject={data.subject} />;
+        },
+      }),
+
+      //
+      // Fallback for any object.
+      //
+
+      Surface.create({
+        id: `${meta.id}/fallback-popover`,
+        role: 'card--content',
+        position: 'fallback',
+        filter: (data): data is { subject: Obj.Unknown; projection?: ProjectionModel } => Obj.isObject(data.subject),
+        component: ({ data, role }) => {
+          return <FormCard role={role} subject={data.subject} projection={data.projection} />;
+        },
+      }),
+
+      Surface.create({
+        id: `${meta.id}/section`,
+        role: ['section'],
+        position: 'fallback',
+        filter: (data): data is { subject: Obj.Unknown } => Obj.isObject(data.subject),
+        component: ({ data }) => {
+          return (
+            <div role='none' className='flex w-full justify-center'>
+              <div role='none' className='pt-2 pb-2 dx-card-min-width dx-card-max-width'>
+                <Card.Root>
+                  <Surface.Surface role='card--content' data={data} limit={1} />
+                </Card.Root>
+              </div>
+            </div>
+          );
+        },
+      }),
+    ]),
+  ),
+);

package/src/cards/FormCard.tsx

@@ -0,0 +1,47 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { useCallback } from 'react';
+
+import { type SurfaceComponentProps } from '@dxos/app-toolkit/ui';
+import { Obj } from '@dxos/echo';
+import { type JsonPath, splitJsonPath } from '@dxos/effect';
+import { Card, useTranslation } from '@dxos/react-ui';
+import { Form, omitId } from '@dxos/react-ui-form';
+import { type ProjectionModel } from '@dxos/schema';
+import { descriptionMessage, mx } from '@dxos/ui-theme';
+
+import { meta } from '../meta';
+
+export const FormCard = ({ subject, projection }: SurfaceComponentProps & { projection?: ProjectionModel }) => {
+  const { t } = useTranslation(meta.id);
+  const schema = Obj.getSchema(subject);
+
+  const handleSave = useCallback((values: any, { changed }: { changed: Record<string, boolean> }) => {
+    const paths = Object.keys(changed).filter((path) => changed[path]);
+    Obj.change(subject, () => {
+      for (const path of paths) {
+        const value = values[path];
+        const parts = splitJsonPath(path as JsonPath);
+        Obj.setValue(subject, parts, value);
+      }
+    });
+  }, []);
+
+  if (!schema) {
+    return <p className={mx(descriptionMessage)}>{t('unable to create preview message')}</p>;
+  }
+
+  return (
+    <Card.Content>
+      <Form.Root schema={omitId(schema)} projection={projection} values={subject} autoSave onSave={handleSave}>
+        <Form.Viewport>
+          <Form.Content>
+            <Form.FieldSet />
+          </Form.Content>
+        </Form.Viewport>
+      </Form.Root>
+    </Card.Content>
+  );
+};

package/src/cards/OrganizationCard.tsx

@@ -0,0 +1,29 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React from 'react';
+
+import { type SurfaceComponentProps } from '@dxos/app-toolkit/ui';
+import { Card } from '@dxos/react-ui';
+import { type Organization } from '@dxos/types';
+
+export const OrganizationCard = ({ subject }: SurfaceComponentProps<Organization.Organization>) => {
+  const { image, description, website } = subject;
+
+  return (
+    <Card.Content>
+      <Card.Poster
+        alt={name ?? ''}
+        {...(image ? { image } : { icon: 'ph--building-office--regular' })}
+        classNames={!image && 'opacity-50'}
+      />
+      {description && (
+        <Card.Row>
+          <Card.Text variant='description'>{description}</Card.Text>
+        </Card.Row>
+      )}
+      {website && <Card.Link label={website} href={website} />}
+    </Card.Content>
+  );
+};

package/src/cards/PersonCard.tsx

@@ -0,0 +1,47 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React from 'react';
+
+import { type SurfaceComponentProps } from '@dxos/app-toolkit/ui';
+import { Avatar } from '@dxos/react-ui';
+import { Card } from '@dxos/react-ui';
+import { type Person } from '@dxos/types';
+
+export const PersonCard = ({ subject }: SurfaceComponentProps<Person.Person>) => {
+  const { image, organization: { target: organization } = {}, emails = [] } = subject;
+
+  return (
+    <Card.Content>
+      <Avatar.Root>
+        {image && (
+          <Card.Row className='py-1'>
+            <Avatar.Content
+              imgSrc={image}
+              icon='ph--user--regular'
+              size={16}
+              classNames={!image && 'opacity-50'}
+              hue='neutral'
+              variant='square'
+            />
+          </Card.Row>
+        )}
+        {organization?.name && (
+          <Card.Action
+            icon='ph--buildings--regular'
+            label={organization.name}
+            // onClick={onSelect ? () => onSelect(organization) : undefined}
+          />
+        )}
+        {emails.map(({ value }) => (
+          <Card.Row key={value} icon='ph--at--regular'>
+            <Card.Text truncate className='text-primary-text'>
+              {value}
+            </Card.Text>
+          </Card.Row>
+        ))}
+      </Avatar.Root>
+    </Card.Content>
+  );
+};

package/src/cards/ProjectCard.tsx

@@ -0,0 +1,22 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React from 'react';
+
+import { type SurfaceComponentProps } from '@dxos/app-toolkit/ui';
+import { Obj } from '@dxos/echo';
+import { Card } from '@dxos/react-ui';
+import { type Pipeline } from '@dxos/types';
+
+export const ProjectCard = ({ subject }: SurfaceComponentProps<Pipeline.Pipeline>) => {
+  const { image, description } = subject;
+
+  return (
+    <Card.Content>
+      {image && <Card.Poster image={image} alt={Obj.getLabel(subject) ?? ''} aspect='auto' />}
+      {/* <CardHeader label={name} subject={subject} db={db} /> */}
+      {description && <Card.Text variant='description'>{description}</Card.Text>}
+    </Card.Content>
+  );
+};

package/src/cards/TaskCard.tsx

@@ -0,0 +1,40 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as SchemaAST from 'effect/SchemaAST';
+import React from 'react';
+
+import { type SurfaceComponentProps } from '@dxos/app-toolkit/ui';
+import { type PropertyMetaAnnotation, PropertyMetaAnnotationId } from '@dxos/echo/internal';
+import { Card } from '@dxos/react-ui';
+import { Task } from '@dxos/types';
+
+export const TaskCard = ({ subject }: SurfaceComponentProps<Task.Task>) => {
+  const { title, status } = subject;
+  const statusOption = getActiveStatusOption(status);
+
+  return (
+    <Card.Content>
+      <Card.Heading classNames='min-w-0 flex-1 truncate'>{title}</Card.Heading>
+      {statusOption && (
+        <span className='dx-tag' data-hue={statusOption.color}>
+          {statusOption.title}
+        </span>
+      )}
+    </Card.Content>
+  );
+};
+
+// TODO(thure): Should this move upstream as a helper? Is there an easier way to get options?
+const getActiveStatusOption = (status?: string) => {
+  const properties = SchemaAST.getPropertySignatures(Task.Task.ast);
+  const statusProperty = properties.find((p) => p.name === 'status');
+  const statusMeta = SchemaAST.getAnnotation<PropertyMetaAnnotation>(PropertyMetaAnnotationId)(
+    // TODO(thure): Typescript asserts `.type` doesn’t have `.types`, but in runtime it does.
+    (statusProperty!.type as any).types[0],
+  );
+  const options = // TODO(thure): Typescript asserts `statusMeta` doesn’t have `.value`, but in runtime it does.
+    (statusMeta as any).value.singleSelect.options as { id: string; title: string; color: string }[];
+  return options.find(({ id }) => id === status);
+};

package/src/{components → cards}/index.ts

@@ -2,6 +2,8 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './ContactCard';
+export * from './FormCard';
 export * from './OrganizationCard';
+export * from './PersonCard';
 export * from './ProjectCard';
+export * from './TaskCard';

package/src/index.ts

@@ -3,6 +3,5 @@
 //
 
 export * from './meta';
-export type * from './types';
 
 export * from './PreviewPlugin';

package/src/meta.ts

@@ -2,13 +2,16 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type PluginMeta } from '@dxos/app-framework';
+import { type Plugin } from '@dxos/app-framework';
+import { trim } from '@dxos/util';
 
-export const PREVIEW_PLUGIN = 'dxos.org/plugin/preview';
-
-export const meta: PluginMeta = {
-  id: PREVIEW_PLUGIN,
+export const meta: Plugin.Meta = {
+  id: 'dxos.org/plugin/preview',
   name: 'Preview',
+  description: trim`
+    Rich preview panel for viewing object content without opening full editors.
+    Quick peek at documents, images, and data with inline rendering.
+  `,
   icon: 'ph--eye--regular',
   source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-preview',
 };