@dxos/plugin-preview 0.8.4-main.dedc0f3 → 0.8.4-main.dfabb4ec29

package/src/capabilities/react-surface.tsx

@@ -2,163 +2,117 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Effect } from 'effect';
-import React, { useCallback } from 'react';
+import * as Effect from 'effect/Effect';
+import React from 'react';
 
-import {
-  Capabilities,
-  LayoutAction,
-  Surface,
-  contributes,
-  createIntent,
-  createSurface,
-  useIntentDispatcher,
-} from '@dxos/app-framework';
-import { fullyQualifiedId, getSchema, getSpace } from '@dxos/client/echo';
-import { Filter, Obj } from '@dxos/echo';
-import { type JsonPath, setValue } from '@dxos/echo-schema';
-import { AttentionAction } from '@dxos/plugin-attention/types';
-import { ATTENDABLE_PATH_SEPARATOR, DeckAction } from '@dxos/plugin-deck/types';
-import { useQuery, useSpace } from '@dxos/react-client/echo';
-import { useTranslation } from '@dxos/react-ui';
-import { Form } from '@dxos/react-ui-form';
-import { Card } from '@dxos/react-ui-stack';
-import { Table } from '@dxos/react-ui-table/types';
-import { descriptionMessage, mx } from '@dxos/react-ui-theme';
-import { DataType, type ProjectionModel, typenameFromQuery } from '@dxos/schema';
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { Surface } from '@dxos/app-framework/ui';
+import { AppSurface } from '@dxos/app-toolkit/ui';
+import { Obj } from '@dxos/echo';
+import { Card } from '@dxos/react-ui';
+import { Expando, type ProjectionModel } from '@dxos/schema';
+import { Organization, Person, Pipeline, Task } from '@dxos/types';
 
-import { ContactCard, OrganizationCard, ProjectCard } from '../components';
-import { PREVIEW_PLUGIN } from '../meta';
+import { ExpandoCard, FormCard, JsonCard, OrganizationCard, PersonCard, ProjectCard, TaskCard } from '../cards';
 
-export default () =>
-  contributes(Capabilities.ReactSurface, [
-    //
-    // Specific schema types.
-    //
-    createSurface({
-      id: `${PREVIEW_PLUGIN}/schema-popover--contact`,
-      role: ['card--popover', 'card--intrinsic', 'card--transclusion', 'card--extrinsic', 'card'],
-      filter: (data): data is { subject: DataType.Person } => Obj.instanceOf(DataType.Person, data.subject),
-      component: ({ data, role }) => {
-        const { dispatch } = useIntentDispatcher();
-        const space = getSpace(data.subject);
-        const defaultSpace = useSpace();
+export default Capability.makeModule(() =>
+  Effect.succeed(
+    Capability.contributes(Capabilities.ReactSurface, [
+      //
+      // Specific schema types.
+      // TODO(burdon): Create helpers and factor out.
+      //
 
-        const currentSpaceOrgs = useQuery(space, Filter.type(DataType.Organization));
-        const currentSpaceViews = useQuery(space, Filter.type(DataType.View));
-        const defaultSpaceViews = useQuery(defaultSpace, Filter.type(DataType.View));
-        const currentSpaceOrgTable = currentSpaceViews.find(
-          (view) =>
-            typenameFromQuery(view.query) === DataType.Organization.typename &&
-            Obj.instanceOf(Table.Table, view.presentation.target),
-        );
-        const defaultSpaceOrgTable = defaultSpaceViews.find(
-          (view) =>
-            typenameFromQuery(view.query) === DataType.Organization.typename &&
-            Obj.instanceOf(Table.Table, view.presentation.target),
-        );
+      Surface.create<{ subject: Person.Person }>({
+        id: 'schema-popover--contact',
+        position: 'hoist',
+        filter: AppSurface.object(AppSurface.Card, Person.Person),
+        component: ({ data, role }) => {
+          return (
+            <>
+              <PersonCard role={role} subject={data.subject} />
+              <Surface.Surface type={AppSurface.Related} data={data} limit={1} />
+            </>
+          );
+        },
+      }),
+      Surface.create({
+        id: 'schema-popover--organization',
+        position: 'hoist',
+        filter: AppSurface.object(AppSurface.Card, Organization.Organization),
+        component: ({ data, role }) => {
+          return (
+            <>
+              <OrganizationCard role={role} subject={data.subject} />
+              <Surface.Surface type={AppSurface.Related} data={data} limit={1} />
+            </>
+          );
+        },
+      }),
+      Surface.create({
+        id: 'schema-popover--project',
+        position: 'hoist',
+        filter: AppSurface.object(AppSurface.Card, Pipeline.Pipeline),
+        component: ({ data, role }) => {
+          return <ProjectCard role={role} subject={data.subject} />;
+        },
+      }),
+      Surface.create({
+        id: 'schema-popover--task',
+        position: 'hoist',
+        filter: AppSurface.object(AppSurface.Card, Task.Task),
+        component: ({ data, role }) => {
+          return <TaskCard role={role} subject={data.subject} />;
+        },
+      }),
+      Surface.create<AppSurface.ObjectCardData<Expando.Expando>>({
+        id: 'schema-popover--expando',
+        filter: AppSurface.object(AppSurface.Card, Expando.Expando),
+        component: ({ data, role }) => {
+          return <ExpandoCard role={role} subject={data.subject} ignorePaths={data.ignorePaths} />;
+        },
+      }),
 
-        // TODO(wittjosiah): Generalized way of handling related objects navigation.
-        const handleOrgClick = useCallback(
-          (org: DataType.Organization) =>
-            Effect.gen(function* () {
-              const view = currentSpaceOrgs.includes(org) ? currentSpaceOrgTable : defaultSpaceOrgTable;
-              yield* dispatch(
-                createIntent(LayoutAction.UpdatePopover, {
-                  part: 'popover',
-                  options: {
-                    state: false,
-                    anchorId: '',
-                  },
-                }),
-              );
-              if (view) {
-                const id = fullyQualifiedId(view);
-                yield* dispatch(
-                  createIntent(LayoutAction.Open, {
-                    part: 'main',
-                    subject: [id],
-                    options: { workspace: space?.id },
-                  }),
-                );
-                yield* dispatch(
-                  createIntent(DeckAction.ChangeCompanion, {
-                    primary: id,
-                    companion: [id, 'selected-objects'].join(ATTENDABLE_PATH_SEPARATOR),
-                  }),
-                );
-                yield* dispatch(
-                  createIntent(AttentionAction.Select, {
-                    contextId: id,
-                    selection: { mode: 'multi', ids: [org.id] },
-                  }),
-                );
-              }
-            }).pipe(Effect.runPromise),
-          [dispatch, currentSpaceOrgs, currentSpaceOrgTable, defaultSpaceOrgTable],
-        );
+      //
+      // Fallback for any object.
+      //
 
-        return (
-          <ContactCard role={role} subject={data.subject} onOrgClick={handleOrgClick}>
-            {role === 'card--popover' && <Surface role='related' data={data} />}
-          </ContactCard>
-        );
-      },
-    }),
-    createSurface({
-      id: `${PREVIEW_PLUGIN}/schema-popover--organization`,
-      role: ['card--popover', 'card--intrinsic', 'card--transclusion', 'card--extrinsic', 'card'],
-      filter: (data): data is { subject: DataType.Organization } => Obj.instanceOf(DataType.Organization, data.subject),
-      component: ({ data, role }) => (
-        <OrganizationCard role={role} subject={data.subject}>
-          {role === 'card--popover' && <Surface role='related' data={data} />}
-        </OrganizationCard>
-      ),
-    }),
-    createSurface({
-      id: `${PREVIEW_PLUGIN}/schema-popover--project`,
-      role: ['card--popover', 'card--intrinsic', 'card--transclusion', 'card--extrinsic', 'card'],
-      filter: (data): data is { subject: DataType.Project } => Obj.instanceOf(DataType.Project, data.subject),
-      component: ({ data, role }) => <ProjectCard subject={data.subject} role={role} />,
-    }),
+      Surface.create({
+        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} />;
+        },
+      }),
 
-    //
-    // Fallback for any object.
-    //
-    createSurface({
-      id: `${PREVIEW_PLUGIN}/fallback-popover`,
-      role: ['card--popover', 'card--intrinsic', 'card--transclusion', 'card--extrinsic', 'card'],
-      position: 'fallback',
-      filter: (data): data is { subject: Obj.Any; projection?: ProjectionModel } => Obj.isObject(data.subject),
-      component: ({ data, role }) => {
-        const schema = getSchema(data.subject);
-        const { t } = useTranslation(PREVIEW_PLUGIN);
-        if (!schema) {
-          // TODO(burdon): Use Alert.
-          return <p className={mx(descriptionMessage)}>{t('unable to create preview message')}</p>;
-        }
+      Surface.create({
+        id: 'fallback-json',
+        role: 'card--content',
+        position: 'fallback',
+        filter: (data): data is Record<string, unknown> => true,
+        component: ({ data }) => {
+          return <JsonCard data={data} />;
+        },
+      }),
 
-        const handleSave = useCallback((values: any, { changed }: { changed: Record<string, boolean> }) => {
-          const changedPaths = Object.keys(changed).filter((path) => changed[path]);
-          for (const path of changedPaths) {
-            const value = values[path];
-            setValue(data.subject, path as JsonPath, value);
-          }
-        }, []);
-
-        return (
-          <Card.SurfaceRoot role={role}>
-            <Form
-              schema={schema}
-              projection={data.projection}
-              values={data.subject}
-              readonly={role === 'card--popover' ? 'static' : false}
-              onSave={handleSave}
-              autoSave
-              {...(role === 'card--intrinsic' && { outerSpacing: 'blockStart-0' })}
-            />
-          </Card.SurfaceRoot>
-        );
-      },
-    }),
-  ]);
+      Surface.create({
+        id: 'section',
+        position: 'fallback',
+        filter: AppSurface.subject(AppSurface.Section, Obj.isObject),
+        component: ({ data }) => {
+          return (
+            <div className='flex w-full justify-center'>
+              <div className='py-2 dx-card-min-width dx-card-max-width'>
+                <Card.Root>
+                  <Surface.Surface type={AppSurface.Card} data={data} limit={1} />
+                </Card.Root>
+              </div>
+            </div>
+          );
+        },
+      }),
+    ]),
+  ),
+);

package/src/cards/ExpandoCard.tsx

@@ -0,0 +1,76 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+import React, { useCallback, useMemo } from 'react';
+
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { Obj } from '@dxos/echo';
+import { type JsonPath, splitJsonPath } from '@dxos/effect';
+import { Card } from '@dxos/react-ui';
+import { Form } from '@dxos/react-ui-form';
+
+const schemaForValue = (value: unknown): Schema.Schema.AnyNoContext | undefined => {
+  switch (typeof value) {
+    case 'string':
+      return Schema.String;
+    case 'number':
+      return Schema.Number;
+    case 'boolean':
+      return Schema.Boolean;
+    default:
+      return undefined;
+  }
+};
+
+/**
+ * Reserved keys: `id`, plus any `~`-prefixed key (ECHO uses `~`-prefixed
+ * string keys to brand entity instances and schemas — KindId,
+ * SchemaKindId, SnapshotKindId, etc. — and the `~` namespace is reserved
+ * for that purpose). They show up in `Object.keys` but aren't user data.
+ */
+const isInternalKey = (key: string) => key === 'id' || key.startsWith('~');
+
+export const ExpandoCard = ({ subject, ignorePaths }: AppSurface.ObjectCardProps) => {
+  const schema = useMemo(() => {
+    const ignored = new Set(ignorePaths ?? []);
+    const fields: Record<string, Schema.Schema.AnyNoContext> = {};
+    for (const key of Object.keys(subject)) {
+      if (isInternalKey(key) || ignored.has(key)) {
+        continue;
+      }
+      const fieldSchema = schemaForValue((subject as any)[key]);
+      if (fieldSchema) {
+        fields[key] = fieldSchema;
+      }
+    }
+    return Schema.Struct(fields);
+  }, [subject, ignorePaths]);
+
+  const handleSave = useCallback(
+    (values: any, { changed }: { changed: Record<string, boolean> }) => {
+      const paths = Object.keys(changed).filter((path) => changed[path]);
+      Obj.update(subject, () => {
+        for (const path of paths) {
+          const value = values[path];
+          const parts = splitJsonPath(path as JsonPath);
+          Obj.setValue(subject, parts, value);
+        }
+      });
+    },
+    [subject],
+  );
+
+  return (
+    <Card.Content>
+      <Form.Root schema={schema} values={subject} autoSave onSave={handleSave}>
+        <Form.Viewport>
+          <Form.Content>
+            <Form.FieldSet />
+          </Form.Content>
+        </Form.Viewport>
+      </Form.Root>
+    </Card.Content>
+  );
+};

package/src/cards/FormCard.tsx

@@ -0,0 +1,48 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { useCallback, useMemo } from 'react';
+
+import { type AppSurface } 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 }: AppSurface.ObjectCardProps & { projection?: ProjectionModel }) => {
+  const { t } = useTranslation(meta.id);
+  const echoSchema = Obj.getSchema(subject);
+  const schema = useMemo(() => echoSchema && omitId(echoSchema), [echoSchema]);
+
+  const handleSave = useCallback((values: any, { changed }: { changed: Record<string, boolean> }) => {
+    const paths = Object.keys(changed).filter((path) => changed[path]);
+    Obj.update(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={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/JsonCard.tsx

@@ -0,0 +1,19 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React from 'react';
+
+import { Card } from '@dxos/react-ui';
+import { JsonHighlighter } from '@dxos/react-ui-syntax-highlighter';
+
+export const JsonCard = ({ data }: { data: unknown }) => {
+  return (
+    <Card.Content>
+      <span />
+      {/* TODO(wittjosiah): Span whole row. */}
+      <JsonHighlighter data={data} />
+      <span />
+    </Card.Content>
+  );
+};

package/src/cards/OrganizationCard.tsx

@@ -0,0 +1,29 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React from 'react';
+
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { Card } from '@dxos/react-ui';
+import { type Organization } from '@dxos/types';
+
+export const OrganizationCard = ({ subject }: AppSurface.ObjectCardProps<Organization.Organization>) => {
+  const { name, 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,65 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import React, { useCallback } from 'react';
+
+import { useOperationInvoker } from '@dxos/app-framework/ui';
+import { LayoutOperation, getObjectPathFromObject, getSpacePath } from '@dxos/app-toolkit';
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { Obj } from '@dxos/echo';
+import { runAndForwardErrors } from '@dxos/effect';
+import { Avatar } from '@dxos/react-ui';
+import { Card } from '@dxos/react-ui';
+import { type Person } from '@dxos/types';
+
+export const PersonCard = ({ subject }: AppSurface.ObjectCardProps<Person.Person>) => {
+  const { invoke } = useOperationInvoker();
+  const { image, organization: { target: organization } = {}, emails = [] } = subject;
+
+  const handleOrganizationClick = useCallback(() => {
+    if (!organization) {
+      return;
+    }
+
+    return Effect.gen(function* () {
+      const organizationPath = getObjectPathFromObject(organization);
+      const db = Obj.getDatabase(organization);
+      yield* invoke(LayoutOperation.UpdatePopover, { state: false, anchorId: '' });
+      yield* invoke(LayoutOperation.Open, {
+        subject: [organizationPath],
+        workspace: db ? getSpacePath(db.spaceId) : undefined,
+      });
+    }).pipe(runAndForwardErrors);
+  }, [invoke, organization]);
+
+  return (
+    <Card.Content>
+      <Avatar.Root>
+        {image && (
+          <Card.Row className='py-1'>
+            <Avatar.Content
+              imgSrc={image}
+              icon='ph--user--regular'
+              size={20}
+              classNames={!image && 'opacity-50'}
+              hue='neutral'
+              variant='square'
+            />
+          </Card.Row>
+        )}
+        {organization?.name && (
+          <Card.Action icon='ph--buildings--regular' label={organization.name} onClick={handleOrganizationClick} />
+        )}
+        {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 AppSurface } 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 }: AppSurface.ObjectCardProps<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,44 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as SchemaAST from 'effect/SchemaAST';
+import React from 'react';
+
+import { type AppSurface } 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 }: AppSurface.ObjectCardProps<Task.Task>) => {
+  const { title, status } = subject;
+  const statusOption = getActiveStatusOption(status);
+
+  return (
+    <Card.Content>
+      <Card.Row>
+        {statusOption && (
+          <div>
+            <span className='dx-tag' data-hue={statusOption.color}>
+              {statusOption.title}
+            </span>
+          </div>
+        )}
+      </Card.Row>
+    </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');
+  // TODO(thure): Typescript asserts `.type` doesn’t have `.types`, but in runtime it does.
+  const statusMeta = SchemaAST.getAnnotation<PropertyMetaAnnotation>(PropertyMetaAnnotationId)(
+    (statusProperty!.type as any).types[0],
+  );
+
+  // TODO(thure): Typescript asserts `statusMeta` doesn’t have `.value`, but in runtime it does.
+  const options = (statusMeta as any).value.singleSelect.options as { id: string; title: string; color: string }[];
+  return options.find(({ id }) => id === status);
+};

package/src/cards/index.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './ExpandoCard';
+export * from './FormCard';
+export * from './JsonCard';
+export * from './OrganizationCard';
+export * from './PersonCard';
+export * from './ProjectCard';
+export * from './TaskCard';

package/src/index.ts

@@ -3,6 +3,3 @@
 //
 
 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: 'org.dxos.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',
 };

package/src/plugin.ts

@@ -0,0 +1,9 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { Plugin } from '@dxos/app-framework';
+
+import { meta } from './meta';
+
+export const PreviewPlugin = Plugin.lazy(meta, () => import('#plugin'));