@dxos/plugin-preview 0.8.4-main.ead640a → 0.8.4-main.effb148878

package/src/cards/TaskCard.tsx

@@ -5,42 +5,41 @@
 import * as SchemaAST from 'effect/SchemaAST';
 import React from 'react';
 
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { Type } from '@dxos/echo';
 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 { DataType } from '@dxos/schema';
+import { Card } from '@dxos/react-ui';
+import { Task } from '@dxos/types';
 
-import { CardSubjectMenu } from '../components';
-import { type PreviewProps } from '../types';
+export const TaskCard = ({ subject }: AppSurface.ObjectCardProps<Task.Task>) => {
+  const { title, status } = subject;
+  const statusOption = getActiveStatusOption(status);
+
+  return (
+    <Card.Body>
+      <Card.Row>
+        {statusOption && (
+          <div>
+            <span className='dx-tag' data-hue={statusOption.color}>
+              {statusOption.title}
+            </span>
+          </div>
+        )}
+      </Card.Row>
+    </Card.Body>
+  );
+};
 
 // 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(DataType.Task.ast);
+  const properties = SchemaAST.getPropertySignatures(Type.getSchema(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 }: PreviewProps<DataType.Task>) => {
-  const { title, status } = subject;
-  const statusOption = getActiveStatusOption(status);
-
-  return (
-    <Card.SurfaceRoot 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,10 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './ContactCard';
+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,11 +2,18 @@
 // 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',
+  author: 'DXOS',
+  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',
+  tags: ['system'],
 };

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,175 @@
 //
 
 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,
+  createPersonEmpty,
+  createProject,
+  createTableEmpty,
+  createTask,
+  createUnknown,
+} 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, // TODO(wittjosiah): Try to write story which does not depend on plugin manager.
-    withPluginManager({ plugins: [IntentPlugin()] }),
+    // `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: 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 _FormEditable: StoryObj<typeof DefaultStory<Person.Person>> = {
+  args: {
+    Component: FormCard,
+    createObject: createPerson,
+    image: true,
+    componentProps: { readonly: false, layout: 'full' },
+  },
+};
 
-export const Popover: Story = {
+/**
+ * Empty-state variant: the subject has no resolvable schema so `FormCard` renders
+ * `<Card.Body><Card.Row><Card.Text variant='description'>No preview</Card.Text></Card.Row></Card.Body>`.
+ * Use this story to verify the empty message lands in the card's center column.
+ */
+export const _FormEmpty: StoryObj<typeof DefaultStory> = {
   args: {
-    role: 'card--popover',
-    cards: createCards(),
+    Component: FormCard,
+    createObject: createUnknown,
   },
 };
 
-export const Intrinsic: Story = {
+/**
+ * No-values variant: the subject has a valid schema (Person) but no populated
+ * fields, so `FormCard` falls through to the same empty state instead of
+ * rendering an empty scrollarea.
+ */
+export const _FormNoValues: StoryObj<typeof DefaultStory<Person.Person>> = {
   args: {
-    role: 'card--intrinsic',
-    cards: createCards(),
+    Component: FormCard,
+    createObject: createPersonEmpty,
   },
 };
 
-export const Extrinsic: Story = {
+/**
+ * Table-like variant: the subject has values only in form-hidden fields
+ * (`view`, `sizes` annotated `FormInputAnnotation.set(false)`). `FormCard`
+ * must consult the schema's form-input annotations — not just `Object.keys` —
+ * to recognize this case and fall through to the empty state.
+ */
+export const _FormTableEmpty: StoryObj<typeof DefaultStory<any>> = {
   args: {
-    role: 'card--extrinsic',
-    cards: createCards(),
+    Component: FormCard,
+    createObject: createTableEmpty,
   },
 };
 
-export const ExtrinsicNoImage: Story = {
+export const _Person: StoryObj<typeof DefaultStory<Person.Person>> = {
   args: {
-    role: 'card--extrinsic',
-    cards: createCards(false),
+    Component: PersonCard,
+    createObject: createPerson,
+    image: true,
+  },
+};
+
+export const _Organization: StoryObj<typeof DefaultStory<Organization.Organization>> = {
+  args: {
+    Component: OrganizationCard,
+    createObject: createOrganization,
+    image: true,
+  },
+};
+
+export const _Project: StoryObj<typeof DefaultStory<Pipeline.Pipeline>> = {
+  args: {
+    Component: ProjectCard,
+    createObject: createProject,
+    image: true,
+  },
+};
+
+export const _Task: StoryObj<typeof DefaultStory<Task.Task>> = {
+  args: {
+    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.Header>
+              <Card.IconBlock />
+              <Card.Title>JSON</Card.Title>
+            </Card.Header>
+            <JsonCard data={data} />
+          </Card.Root>
+        </div>
+      </div>
+    );
   },
 };

package/src/stories/testing.tsx

@@ -2,112 +2,152 @@
 // Copyright 2025 DXOS.org
 //
 
-import React, { type FC } from 'react';
+import * as Schema from 'effect/Schema';
+import React, { type FC, useMemo } from 'react';
 
-import { Obj, Ref } from '@dxos/echo';
-import { faker } from '@dxos/random';
-import { CardContainer } from '@dxos/react-ui-stack/testing';
-import { DataType } from '@dxos/schema';
+import { type AppSurface } from '@dxos/app-toolkit/ui';
+import { DXN, Obj, Ref, Type } from '@dxos/echo';
+import { Annotation } from '@dxos/echo';
+import { random } from '@dxos/random';
+import { Card } from '@dxos/react-ui';
+import { CardContainer, type CardContainerProps } from '@dxos/react-ui-mosaic/testing';
+import { Expando } from '@dxos/schema';
+import { Organization, Person, Pipeline, Task } from '@dxos/types';
 
-import { ContactCard, OrganizationCard, ProjectCard, TaskCard } from '../cards';
-import { type PreviewProps } from '../types';
-
-type CardProps<T extends Obj.Any> = {
-  Component: FC<PreviewProps<T>>;
-  subject: T;
-  icon?: string;
+export type DefaultStoryProps<T extends Obj.Any, P extends {} = {}> = {
+  Component: FC<AppSurface.ObjectCardProps<T> & P>;
+  createObject: () => T;
   image?: boolean;
+  componentProps?: P;
 };
 
-export type DefaultstoryProps = {
-  role: 'card--popover' | 'card--intrinsic' | 'card--extrinsic' | 'card--transclusion';
-  cards: CardProps<any>[];
-};
+export const DefaultStory = <T extends Obj.Any, P extends {} = {}>({
+  Component,
+  createObject,
+  image,
+  componentProps,
+}: DefaultStoryProps<T, P>) => {
+  const object = useMemo(() => createObject(), [createObject]);
+  const roles: CardContainerProps['role'][] = ['intrinsic', 'popover'];
 
-export const Defaultstory = ({ role, cards }: DefaultstoryProps) => {
   return (
-    <div className='flex bs-full'>
-      <div className='flex shrink-0 gap-8 overflow-x-auto pbe-4'>
-        {cards.map(({ Component, icon, image, subject }, i) => (
-          <div key={i} className='flex is-[24rem] justify-center'>
-            <CardContainer icon={icon} role={role}>
-              <Component role={role} subject={image ? subject : omitImage(subject)} />
+    <div className='h-full w-full grid grid-cols-2 py-16 gap-8'>
+      {roles.map((role, i) => (
+        <div key={i} className='flex h-full justify-center overflow-hidden'>
+          <div className='flex flex-col gap-4 w-full items-center'>
+            <span className='text-sm text-description'>{role}</span>
+            <CardContainer role={role}>
+              <Card.Root border={false}>
+                <Card.Header>
+                  <Card.DragHandle />
+                  <Card.Title>{Obj.getLabel(object)}</Card.Title>
+                  <Card.Menu />
+                </Card.Header>
+                <Component
+                  role={role ?? 'card--content'}
+                  subject={image ? object : omitImage(object)}
+                  {...(componentProps ?? ({} as P))}
+                />
+              </Card.Root>
             </CardContainer>
           </div>
-        ))}
-      </div>
+        </div>
+      ))}
     </div>
   );
 };
 
 export const omitImage = ({ image: _, ...rest }: any) => rest;
 
-// TODO(burdon): Test data should exercise the standard data generators.
-export const createCards = (image = true): CardProps<any>[] => {
-  const organization = Obj.make(DataType.Organization, {
-    name: faker.company.name(),
+/**
+ * Factory functions for creating test objects at render time.
+ */
+export const createOrganization = (): Organization.Organization => {
+  return Obj.make(Organization.Organization, {
+    name: random.company.name(),
     image:
       'https://plus.unsplash.com/premium_photo-1672116452571-896980a801c8?q=80&w=2671&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D',
-    website: faker.internet.url(),
-    description: faker.lorem.paragraph(),
+    website: random.internet.url(),
+    description: random.lorem.paragraph(),
   });
+};
 
-  const contact = Obj.make(DataType.Person, {
-    fullName: faker.person.fullName(),
+export const createPerson = (): Person.Person => {
+  const organization = createOrganization();
+  return Obj.make(Person.Person, {
+    fullName: random.person.fullName(),
     image:
       'https://plus.unsplash.com/premium_photo-1664536392779-049ba8fde933?q=80&w=2574&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D',
     organization: Ref.make(organization),
     emails: [
-      {
-        label: 'Work',
-        value: faker.internet.email(),
-      },
-      {
-        label: 'Work',
-        value: faker.internet.email(),
-      },
-      {
-        label: 'Work',
-        value: faker.internet.email(),
-      },
+      { label: 'Work', value: random.internet.email() },
+      { label: 'Work', value: random.internet.email() },
+      { label: 'Work', value: random.internet.email() },
     ],
   });
+};
 
-  const project = DataType.makeProject({
-    name: faker.person.fullName(),
+export const createProject = (): Pipeline.Pipeline => {
+  return Obj.make(Pipeline.Pipeline, {
+    name: random.person.fullName(),
     image: 'https://dxos.network/dxos-logotype-blue.png',
-    description: faker.lorem.paragraph(),
+    description: random.lorem.paragraph(),
+    columns: [],
   });
+};
 
-  const task = Obj.make(DataType.Task, {
-    title: faker.lorem.sentence(),
-    status: faker.helpers.arrayElement(['todo', 'in-progress', 'done']),
+export const createTask = (): Task.Task => {
+  return Obj.make(Task.Task, {
+    title: random.lorem.sentence(),
+    status: random.helpers.arrayElement(['todo', 'in-progress', 'done'] as const),
   });
+};
 
-  return [
-    {
-      Component: OrganizationCard,
-      subject: organization,
-      icon: 'ph--building-office--regular',
-      image,
-    },
-    {
-      Component: ContactCard,
-      subject: contact,
-      icon: 'ph--user--regular',
-      image,
-    },
-    {
-      Component: ProjectCard,
-      subject: project,
-      icon: 'ph--building--regular',
-      image,
-    },
-    {
-      Component: TaskCard,
-      subject: task,
-      icon: 'ph--list-checks--regular',
-      image,
-    },
-  ];
+/**
+ * Plain object cast as `Obj.Any` — has no schema, typename, or database, so cards
+ * like `FormCard` fall through to their empty/unsupported state. Use to story-pin
+ * fallback rendering.
+ */
+export const createUnknown = (): Obj.Any => ({}) as unknown as Obj.Any;
+
+/**
+ * Typed object with no user-facing values (only `id`). All Person fields are
+ * optional, so `Obj.make(Person, {})` is valid and triggers the FormCard
+ * "no values" branch in readonly mode.
+ */
+export const createPersonEmpty = (): Person.Person => Obj.make(Person.Person, {});
+
+/**
+ * Mock of the `Table` schema (org.dxos.type.table): an optional `name` plus
+ * `view` and `sizes` fields annotated with `FormInputAnnotation.set(false)`.
+ * When constructed without a `name`, no form-renderable field has a value so
+ * FormCard should fall through to its empty state — even though
+ * `Object.keys(subject)` includes `view`/`sizes`.
+ */
+const TableLike = Schema.Struct({
+  name: Schema.String.pipe(Schema.optional),
+  view: Schema.String.pipe(Annotation.FormInputAnnotation.set(false)),
+  sizes: Schema.Record({ key: Schema.String, value: Schema.Number }).pipe(
+    Schema.mutable,
+    Annotation.FormInputAnnotation.set(false),
+  ),
+}).pipe(Type.makeObject(DXN.make('org.dxos.test.table-like', '0.1.0')));
+type TableLike = Type.InstanceType<typeof TableLike>;
+
+/**
+ * Table-like object with values only in form-hidden fields (`view`, `sizes`).
+ * `Object.keys` includes them, but a naive `hasValues` check would
+ * misclassify this as having data. FormCard must consult the schema's
+ * form-input annotations to correctly fall through to the empty state.
+ */
+export const createTableEmpty = (): TableLike =>
+  Obj.make(TableLike, { view: 'view-dxn:placeholder', sizes: {} } as Obj.MakeProps<typeof TableLike>);
+
+export const createExpando = (): Expando.Expando => {
+  return Expando.make({
+    name: random.person.fullName(),
+    email: random.internet.email(),
+    age: random.number.int({ min: 18, max: 80 }),
+    active: random.datatype.boolean(),
+  });
 };

package/src/testing.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// Eager re-export of `PreviewPlugin`. See `@dxos/plugin-testing/src/core.ts`
+// for the rationale.
+export * from './PreviewPlugin';

package/src/translations.ts

@@ -4,19 +4,19 @@
 
 import { type Resource } from '@dxos/react-ui';
 
-import { meta } from './meta';
+import { meta } from '#meta';
 
 export const translations = [
   {
     'en-US': {
       [meta.id]: {
-        'unable to create preview message': 'No preview',
-        'todo label': 'To do',
-        'in-progress label': 'In progress',
-        'done label': 'Done',
-        'open object label': 'Open',
-        'add object to space label': 'Add to space',
-        'more options label': 'More options',
+        'unable-to-create-preview.message': 'No preview',
+        'todo.label': 'To do',
+        'in-progress.label': 'In progress',
+        'done.label': 'Done',
+        'open-object.label': 'Open',
+        'add-object-to-space.label': 'Add to space',
+        'more-options.label': 'More options',
       },
     },
   },

package/dist/lib/browser/chunk-XKCIQK3C.mjs

@@ -1,12 +0,0 @@
-// src/meta.ts
-var meta = {
-  id: "dxos.org/plugin/preview",
-  name: "Preview",
-  icon: "ph--eye--regular",
-  source: "https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-preview"
-};
-
-export {
-  meta
-};
-//# sourceMappingURL=chunk-XKCIQK3C.mjs.map

package/dist/lib/browser/chunk-XKCIQK3C.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/meta.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type PluginMeta } from '@dxos/app-framework';\n\nexport const meta: PluginMeta = {\n  id: 'dxos.org/plugin/preview',\n  name: 'Preview',\n  icon: 'ph--eye--regular',\n  source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-preview',\n};\n"],
-  "mappings": ";AAMO,IAAMA,OAAmB;EAC9BC,IAAI;EACJC,MAAM;EACNC,MAAM;EACNC,QAAQ;AACV;",
-  "names": ["meta", "id", "name", "icon", "source"]
-}