@dxos/plugin-preview 0.8.4-main.3c1ae3b → 0.8.4-main.3fbcb4aa9b

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

@@ -2,56 +2,47 @@
 // Copyright 2025 DXOS.org
 //
 
-import React from 'react';
-import { useCallback } from 'react';
+import React, { useCallback, useMemo } from 'react';
 
+import { type AppSurface } from '@dxos/app-toolkit/ui';
 import { Obj } from '@dxos/echo';
-import { type JsonPath, setValue } from '@dxos/echo/internal';
-import { useTranslation } from '@dxos/react-ui';
+import { type JsonPath, splitJsonPath } from '@dxos/effect';
+import { Card, useTranslation } from '@dxos/react-ui';
 import { Form, omitId } from '@dxos/react-ui-form';
-import { Card } from '@dxos/react-ui-stack';
-import { descriptionMessage, mx } from '@dxos/react-ui-theme';
 import { type ProjectionModel } from '@dxos/schema';
+import { descriptionMessage, mx } from '@dxos/ui-theme';
 
-import { meta } from '../meta';
-import { type CardPreviewProps } from '../types';
+import { meta } from '#meta';
 
-export const FormCard = ({
-  subject,
-  projection,
-  role,
-}: CardPreviewProps<Obj.Any> & { projection?: ProjectionModel }) => {
-  const schema = Obj.getSchema(subject);
+export const FormCard = ({ subject, projection }: AppSurface.ObjectCardProps & { projection?: ProjectionModel }) => {
   const { t } = useTranslation(meta.id);
-  if (!schema) {
-    // TODO(burdon): Use Alert.
-    return <p className={mx(descriptionMessage)}>{t('unable to create preview message')}</p>;
-  }
+  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]);
-    for (const path of paths) {
-      const value = values[path];
-      setValue(subject, path as JsonPath, value);
-    }
+    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.SurfaceRoot id={subject.id} role={role}>
-      <Form.Root
-        schema={omitId(schema)}
-        projection={projection}
-        values={subject}
-        layout={role === 'card--popover' ? 'static' : undefined}
-        autoSave
-        onSave={handleSave}
-      >
+    <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.SurfaceRoot>
+    </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

@@ -4,31 +4,26 @@
 
 import React from 'react';
 
-import { Card } from '@dxos/react-ui-stack';
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { Card } from '@dxos/react-ui';
 import { type Organization } from '@dxos/types';
 
-import { CardHeader, CardLink } from '../components';
-import { type CardPreviewProps } from '../types';
-
-export const OrganizationCard = ({
-  children,
-  subject,
-  role,
-  activeSpace,
-}: CardPreviewProps<Organization.Organization>) => {
+export const OrganizationCard = ({ subject }: AppSurface.ObjectCardProps<Organization.Organization>) => {
   const { name, image, description, website } = subject;
 
   return (
-    <Card.SurfaceRoot id={subject.id} role={role}>
+    <Card.Content>
       <Card.Poster
         alt={name ?? ''}
         {...(image ? { image } : { icon: 'ph--building-office--regular' })}
         classNames={!image && 'opacity-50'}
       />
-      <CardHeader label={name} subject={subject} activeSpace={activeSpace} />
-      {description && <Card.Text classNames='line-clamp-2'>{description}</Card.Text>}
-      {website && <CardLink label={website} href={website} />}
-      {children}
-    </Card.SurfaceRoot>
+      {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

@@ -2,62 +2,64 @@
 // Copyright 2025 DXOS.org
 //
 
-import React, { Fragment } from 'react';
+import * as Effect from 'effect/Effect';
+import React, { useCallback } from 'react';
 
-import { Avatar, Icon } from '@dxos/react-ui';
-import { Card, cardHeading, cardText } from '@dxos/react-ui-stack';
-import { mx } from '@dxos/react-ui-theme';
+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';
 
-import { CardRow, CardSubjectMenu, gridRow } from '../components';
-import { type CardPreviewProps } from '../types';
+export const PersonCard = ({ subject }: AppSurface.ObjectCardProps<Person.Person>) => {
+  const { invoke } = useOperationInvoker();
+  const { image, organization: { target: organization } = {}, emails = [] } = subject;
 
-export const PersonCard = ({ children, role, subject, activeSpace, onSelect }: CardPreviewProps<Person.Person>) => {
-  const { fullName, 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.SurfaceRoot id={subject.id} role={role}>
+    <Card.Content>
       <Avatar.Root>
-        <Card.Text role='group' classNames={mx('grid gap-2 grid-cols-[1fr_min-content]')}>
-          <div role='none' className={mx(gridRow, 'grid-rows-2')}>
-            {activeSpace ? <CardSubjectMenu subject={subject} activeSpace={activeSpace} /> : <div />}
-            <Avatar.Label asChild>
-              <h2 className={mx(cardHeading, 'grow truncate')}>{fullName}</h2>
-            </Avatar.Label>
-          </div>
-          <Avatar.Content
-            imgSrc={image}
-            icon='ph--user--regular'
-            size={16}
-            classNames={['text-subdued', !image && 'opacity-50']}
-            hue='neutral'
-            variant='square'
-          />
-        </Card.Text>
+        {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>
-      {organization?.name && (
-        <CardRow
-          icon='ph--buildings--regular'
-          label={organization.name}
-          onClick={onSelect ? () => onSelect(organization) : undefined}
-        />
-      )}
-      {emails.length > 0 && (
-        <dl className={mx(cardText, gridRow, '[&_dt]:text-subdued [&_dt]:pbs-0.5 [&_dd]:min-is-0')}>
-          {emails.map(({ label, value }) => (
-            <Fragment key={value}>
-              <dt>
-                <span className='sr-only'>{label}</span>
-                <Icon icon='ph--at--regular' size={5} />
-              </dt>
-              <dd key={value} className='col-span-2 break-words'>
-                {value}
-              </dd>
-            </Fragment>
-          ))}
-        </dl>
-      )}
-      {children}
-    </Card.SurfaceRoot>
+    </Card.Content>
   );
 };

package/src/cards/ProjectCard.tsx

@@ -4,21 +4,19 @@
 
 import React from 'react';
 
+import { type AppSurface } from '@dxos/app-toolkit/ui';
 import { Obj } from '@dxos/echo';
-import { Card } from '@dxos/react-ui-stack';
-import { type Project } from '@dxos/types';
+import { Card } from '@dxos/react-ui';
+import { type Pipeline } from '@dxos/types';
 
-import { CardHeader } from '../components';
-import { type CardPreviewProps } from '../types';
-
-export const ProjectCard = ({ subject, role, activeSpace }: CardPreviewProps<Project.Project>) => {
-  const { name, image, description } = subject;
+export const ProjectCard = ({ subject }: AppSurface.ObjectCardProps<Pipeline.Pipeline>) => {
+  const { image, description } = subject;
 
   return (
-    <Card.SurfaceRoot id={subject.id} role={role}>
+    <Card.Content>
       {image && <Card.Poster image={image} alt={Obj.getLabel(subject) ?? ''} aspect='auto' />}
-      <CardHeader label={name} subject={subject} activeSpace={activeSpace} />
-      {description && <Card.Text classNames='line-clamp-2'>{description}</Card.Text>}
-    </Card.SurfaceRoot>
+      {/* <CardHeader label={name} subject={subject} db={db} /> */}
+      {description && <Card.Text variant='description'>{description}</Card.Text>}
+    </Card.Content>
   );
 };

package/src/cards/TaskCard.tsx

@@ -5,42 +5,40 @@
 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, cardNoSpacing, cardSpacing } from '@dxos/react-ui-stack';
-import { mx } from '@dxos/react-ui-theme';
+import { Card } from '@dxos/react-ui';
 import { Task } from '@dxos/types';
 
-import { CardSubjectMenu } from '../components';
-import { type CardPreviewProps } from '../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)(
-    // 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);
-};
 
-export const TaskCard = ({ subject, role, activeSpace }: CardPreviewProps<Task.Task>) => {
-  const { title, status } = subject;
-  const statusOption = getActiveStatusOption(status);
-
-  return (
-    <Card.SurfaceRoot id={subject.id} role={role}>
-      <div role='none' className={mx('flex items-center gap-2', cardSpacing)}>
-        <Card.Heading classNames={[cardNoSpacing, 'min-is-0 flex-1 truncate']}>{title}</Card.Heading>
-        {statusOption && (
-          <span className='dx-tag' data-hue={statusOption.color}>
-            {statusOption.title}
-          </span>
-        )}
-        <CardSubjectMenu subject={subject} activeSpace={activeSpace} />
-      </div>
-    </Card.SurfaceRoot>
-  );
+  // 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

@@ -2,7 +2,9 @@
 // Copyright 2025 DXOS.org
 //
 
+export * from './ExpandoCard';
 export * from './FormCard';
+export * from './JsonCard';
 export * from './OrganizationCard';
 export * from './PersonCard';
 export * from './ProjectCard';

package/src/index.ts

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

package/src/meta.ts

@@ -2,11 +2,11 @@
 // 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 meta: PluginMeta = {
-  id: 'dxos.org/plugin/preview',
+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.

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'));

package/src/stories/Card.stories.tsx

@@ -3,60 +3,119 @@
 //
 
 import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React from 'react';
 
-import { IntentPlugin } from '@dxos/app-framework';
 import { withPluginManager } from '@dxos/app-framework/testing';
-import { faker } from '@dxos/random';
-import { withTheme } from '@dxos/react-ui/testing';
+import { corePlugins } from '@dxos/plugin-testing';
+import { random } from '@dxos/random';
+import { Card } from '@dxos/react-ui';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { type Expando } from '@dxos/schema';
+import { type Organization, type Person, type Pipeline, type Task } from '@dxos/types';
 
-import { translations } from '../translations';
+import { translations } from '#translations';
 
-import { Defaultstory, createCards } from './testing';
+import { ExpandoCard, FormCard, JsonCard, OrganizationCard, PersonCard, ProjectCard, TaskCard } from '../cards';
+import { DefaultStory, createExpando, createOrganization, createPerson, createProject, createTask } from './testing';
 
-faker.seed(999);
+random.seed(999);
 
 const meta = {
-  title: 'plugins/plugin-preview/Card',
-  render: Defaultstory,
+  title: 'plugins/plugin-preview/cards/Card',
+  render: DefaultStory,
   decorators: [
-    withTheme,
+    // `Card` and its descendants in `@dxos/react-ui` consume `ThemeContext`
+    // for tx-token resolution; without this the stories trip the surface's
+    // `ErrorBoundary` with "Missing ThemeContext" and the storybook test
+    // assert-no-error fails.
+    withTheme(),
+    withLayout({ layout: 'fullscreen' }),
     // TODO(wittjosiah): Try to write story which does not depend on plugin manager.
-    withPluginManager({ plugins: [IntentPlugin()] }),
+    withPluginManager({ plugins: corePlugins() }),
   ],
   parameters: {
+    layout: 'fullscreen',
     translations,
   },
   tags: ['cards'],
-} satisfies Meta<typeof Defaultstory>;
+} satisfies Meta<typeof DefaultStory>;
 
 export default meta;
 
-type Story = StoryObj<typeof meta>;
+export const _Form: StoryObj<typeof DefaultStory<Person.Person>> = {
+  args: {
+    Component: FormCard,
+    createObject: createPerson,
+    image: true,
+  },
+};
 
-export const Popover: Story = {
+export const _Person: StoryObj<typeof DefaultStory<Person.Person>> = {
   args: {
-    role: 'card--popover',
-    cards: createCards(),
+    Component: PersonCard,
+    createObject: createPerson,
+    image: true,
   },
 };
 
-export const Intrinsic: Story = {
+export const _Organization: StoryObj<typeof DefaultStory<Organization.Organization>> = {
   args: {
-    role: 'card--intrinsic',
-    cards: createCards(),
+    Component: OrganizationCard,
+    createObject: createOrganization,
+    image: true,
   },
 };
 
-export const Extrinsic: Story = {
+export const _Project: StoryObj<typeof DefaultStory<Pipeline.Pipeline>> = {
   args: {
-    role: 'card--extrinsic',
-    cards: createCards(),
+    Component: ProjectCard,
+    createObject: createProject,
+    image: true,
   },
 };
 
-export const ExtrinsicNoImage: Story = {
+export const _Task: StoryObj<typeof DefaultStory<Task.Task>> = {
   args: {
-    role: 'card--extrinsic',
-    cards: createCards(false),
+    Component: TaskCard,
+    createObject: createTask,
+    image: true,
+  },
+};
+
+export const _Expando: StoryObj<typeof DefaultStory<Expando.Expando>> = {
+  args: {
+    Component: ExpandoCard,
+    createObject: createExpando,
+  },
+};
+
+export const _Json = {
+  render: () => {
+    const data = {
+      subject: {
+        id: random.string.uuid(),
+        name: random.person.fullName(),
+        email: random.internet.email(),
+        tags: [random.lorem.word(), random.lorem.word(), random.lorem.word()],
+        nested: {
+          count: random.number.int({ max: 100 }),
+          active: random.datatype.boolean(),
+        },
+      },
+    };
+
+    return (
+      <div className='flex justify-center p-16'>
+        <div className='dx-card-min-width dx-card-max-width'>
+          <Card.Root>
+            <Card.Toolbar>
+              <Card.IconBlock />
+              <Card.Title>JSON</Card.Title>
+            </Card.Toolbar>
+            <JsonCard data={data} />
+          </Card.Root>
+        </div>
+      </div>
+    );
   },
 };