@dxos/plugin-preview 0.8.4-main.5acf9ea → 0.8.4-main.66e292d

package/src/components/CardComponents.tsx

@@ -0,0 +1,67 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React from 'react';
+
+import { Button, Icon } from '@dxos/react-ui';
+import { Card, cardNoSpacing, cardSpacing } from '@dxos/react-ui-stack';
+import { mx } from '@dxos/react-ui-theme';
+
+import { type CardPreviewProps } from '../types';
+
+import { CardSubjectMenu } from './CardSubjectMenu';
+
+export const gridRow = 'is-full grid grid-cols-[1.5rem_1fr_min-content] gap-2 items-center';
+
+// TODO(burdon): Standardize card grid for common rows.
+
+export const CardHeader = ({ label, subject, activeSpace }: { label?: string } & CardPreviewProps) => {
+  return (
+    <div role='none' className={mx('flex items-center gap-2', cardSpacing)}>
+      <Card.Heading classNames={cardNoSpacing}>{label}</Card.Heading>
+      <CardSubjectMenu subject={subject} activeSpace={activeSpace} />
+    </div>
+  );
+};
+
+export const CardRow = ({ icon, label, onClick }: { icon: string; label: string; onClick?: () => void }) => {
+  if (!onClick) {
+    return (
+      <Card.Chrome>
+        <p data-variant='ghost' className={mx(gridRow, 'dx-button')}>
+          <Icon icon={icon} size={5} classNames='text-subdued' />
+          <span className='min-is-0 flex-1 truncate col-span-2'>{label}</span>
+        </p>
+      </Card.Chrome>
+    );
+  }
+
+  return (
+    <Card.Chrome>
+      <Button variant='ghost' classNames={mx(gridRow, 'text-start')} onClick={onClick}>
+        <Icon icon={icon} size={5} classNames='text-subdued' />
+        <span className='min-is-0 flex-1 truncate'>{label}</span>
+        <Icon icon='ph--arrow-right--regular' />
+      </Button>
+    </Card.Chrome>
+  );
+};
+
+export const CardLink = ({ label, href }: { label: string; href: string }) => {
+  return (
+    <Card.Chrome>
+      <a
+        className={mx(gridRow, 'dx-button dx-focus-ring')}
+        data-variant='ghost'
+        href={href}
+        target='_blank'
+        rel='noreferrer'
+      >
+        <Icon icon='ph--link--regular' size={5} classNames='text-subdued' />
+        <span className='min-is-0 flex-1 truncate'>{label}</span>
+        <Icon icon='ph--arrow-square-out--regular' />
+      </a>
+    </Card.Chrome>
+  );
+};

package/src/components/CardSubjectMenu.tsx

@@ -0,0 +1,103 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Atom } from '@effect-atom/atom-react';
+import React from 'react';
+
+import { LayoutAction, createIntent } from '@dxos/app-framework';
+import { useIntentDispatcher } from '@dxos/app-framework/react';
+import { ACTION_TYPE } from '@dxos/app-graph';
+import { Obj } from '@dxos/echo';
+import { SpaceAction } from '@dxos/plugin-space/types';
+import { IconButton, type IconButtonProps, useTranslation } from '@dxos/react-ui';
+import {
+  type ActionGraphProps,
+  DropdownMenu,
+  type MenuActions,
+  MenuProvider,
+  useMenuActions,
+} from '@dxos/react-ui-menu';
+
+import { meta } from '../meta';
+import { type CardPreviewProps } from '../types';
+
+/**
+ * Generic menu for objects; builds menu with common actions.
+ */
+// TODO(burdon): Reconcile title and menu with main Card header.
+export const CardSubjectMenu = ({
+  subject,
+  activeSpace,
+  ...props
+}: CardPreviewProps & Omit<IconButtonProps, 'icon' | 'label'>) => {
+  const { t } = useTranslation(meta.id);
+  const menuProps = useSubjectMenuGroupItems({ subject, activeSpace });
+
+  if (!activeSpace) {
+    return null;
+  }
+
+  return (
+    <MenuProvider {...menuProps}>
+      <DropdownMenu.Root>
+        <DropdownMenu.Trigger asChild>
+          <IconButton
+            variant='ghost'
+            icon='ph--dots-three-vertical--bold'
+            iconOnly
+            label={t('more options label')}
+            {...props}
+          />
+        </DropdownMenu.Trigger>
+      </DropdownMenu.Root>
+    </MenuProvider>
+  );
+};
+
+const useSubjectMenuGroupItems = ({ subject, activeSpace }: CardPreviewProps): MenuActions => {
+  const { dispatchPromise: dispatch } = useIntentDispatcher();
+  const result: ActionGraphProps = { edges: [], nodes: [] };
+
+  result.nodes.push({
+    type: ACTION_TYPE,
+    id: `${subject.id}/open`,
+    data: () =>
+      dispatch(
+        createIntent(LayoutAction.Open, {
+          part: 'main',
+          subject: [Obj.getDXN(subject).toString()],
+        }),
+      ),
+    properties: {
+      label: ['open object label', { ns: meta.id }],
+      icon: 'ph--arrow-right--regular',
+    },
+  });
+
+  if (activeSpace && Obj.getDXN(subject).asQueueDXN()) {
+    result.nodes.push({
+      type: ACTION_TYPE,
+      id: `${subject.id}/add-to-space`,
+      // TODO(wittjosiah): Update reference to point to db object when adding?
+      data: () =>
+        dispatch(
+          createIntent(SpaceAction.AddObject, {
+            object: subject,
+            target: activeSpace,
+            hidden: true,
+          }),
+        ),
+      properties: {
+        label: ['add object to space label', { ns: meta.id }],
+        icon: 'ph--file-plus--regular',
+      },
+    });
+  }
+
+  result.nodes.forEach(({ id: target }) => {
+    result.edges.push({ source: 'root', target });
+  });
+
+  return useMenuActions(Atom.make(result));
+};

package/src/components/index.ts

@@ -2,6 +2,5 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './ContactCard';
-export * from './OrganizationCard';
-export * from './ProjectCard';
+export * from './CardComponents';
+export * from './CardSubjectMenu';

package/src/meta.ts

@@ -3,12 +3,15 @@
 //
 
 import { type PluginMeta } from '@dxos/app-framework';
-
-export const PREVIEW_PLUGIN = 'dxos.org/plugin/preview';
+import { trim } from '@dxos/util';
 
 export const meta: PluginMeta = {
-  id: PREVIEW_PLUGIN,
+  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',
 };

package/src/stories/Card.stories.tsx

@@ -0,0 +1,62 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+
+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 { translations } from '../translations';
+
+import { Defaultstory, createCards } from './testing';
+
+faker.seed(999);
+
+const meta = {
+  title: 'plugins/plugin-preview/Card',
+  render: Defaultstory,
+  decorators: [
+    withTheme,
+    // TODO(wittjosiah): Try to write story which does not depend on plugin manager.
+    withPluginManager({ plugins: [IntentPlugin()] }),
+  ],
+  parameters: {
+    translations,
+  },
+  tags: ['cards'],
+} satisfies Meta<typeof Defaultstory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Popover: Story = {
+  args: {
+    role: 'card--popover',
+    cards: createCards(),
+  },
+};
+
+export const Intrinsic: Story = {
+  args: {
+    role: 'card--intrinsic',
+    cards: createCards(),
+  },
+};
+
+export const Extrinsic: Story = {
+  args: {
+    role: 'card--extrinsic',
+    cards: createCards(),
+  },
+};
+
+export const ExtrinsicNoImage: Story = {
+  args: {
+    role: 'card--extrinsic',
+    cards: createCards(false),
+  },
+};

package/src/stories/testing.tsx

@@ -0,0 +1,114 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { type FC } from 'react';
+
+import { Obj, Ref } from '@dxos/echo';
+import { faker } from '@dxos/random';
+import { CardContainer } from '@dxos/react-ui-stack/testing';
+import { Organization, Person, Task } from '@dxos/types';
+import { Project } from '@dxos/types';
+
+import { OrganizationCard, PersonCard, ProjectCard, TaskCard } from '../cards';
+import { type CardPreviewProps } from '../types';
+
+type CardProps<T extends Obj.Any> = {
+  Component: FC<CardPreviewProps<T>>;
+  subject: T;
+  icon?: string;
+  image?: boolean;
+};
+
+export type DefaultstoryProps = {
+  role: 'card--popover' | 'card--intrinsic' | 'card--extrinsic' | 'card--transclusion';
+  cards: CardProps<any>[];
+};
+
+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)} />
+            </CardContainer>
+          </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(Organization.Organization, {
+    name: faker.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(),
+  });
+
+  const contact = Obj.make(Person.Person, {
+    fullName: faker.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(),
+      },
+    ],
+  });
+
+  const project = Project.make({
+    name: faker.person.fullName(),
+    image: 'https://dxos.network/dxos-logotype-blue.png',
+    description: faker.lorem.paragraph(),
+  });
+
+  const task = Obj.make(Task.Task, {
+    title: faker.lorem.sentence(),
+    status: faker.helpers.arrayElement(['todo', 'in-progress', 'done']),
+  });
+
+  return [
+    {
+      Component: OrganizationCard,
+      subject: organization,
+      icon: 'ph--building-office--regular',
+      image,
+    },
+    {
+      Component: PersonCard,
+      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,
+    },
+  ];
+};

package/src/translations.ts

@@ -11,6 +11,12 @@ 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',
       },
     },
   },

package/src/types.ts

@@ -4,8 +4,22 @@
 
 import { type PropsWithChildren } from 'react';
 
-// TODO(burdon): Better place for these defs?
-export type PreviewProps<T extends object> = PropsWithChildren<{
-  subject: T;
-  role?: string;
-}>;
+import { type SurfaceCardRole, type SurfaceComponentProps } from '@dxos/app-framework/react';
+import { type Obj } from '@dxos/echo';
+import { type Space } from '@dxos/react-client/echo';
+
+/**
+ * @deprecated Use {@link SurfaceComponentProps} instead.
+ */
+// TODO(burdon): Remove?
+export type CardPreviewProps<
+  Subject extends Obj.Any = Obj.Any,
+  Role extends SurfaceCardRole = SurfaceCardRole,
+> = PropsWithChildren<
+  SurfaceComponentProps<Subject, Role> & {
+    // TODO(burdon): Why is this required (why active?)
+    activeSpace?: Space;
+    // TODO(burdon): Remove in favor of intents?
+    onSelect?: (obj: Obj.Any) => void;
+  }
+>;

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

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

package/dist/lib/browser/chunk-Z73ENKLE.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 PREVIEW_PLUGIN = 'dxos.org/plugin/preview';\n\nexport const meta: PluginMeta = {\n  id: PREVIEW_PLUGIN,\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,iBAAiB;AAEvB,IAAMC,OAAmB;EAC9BC,IAAIF;EACJG,MAAM;EACNC,MAAM;EACNC,QAAQ;AACV;",
-  "names": ["PREVIEW_PLUGIN", "meta", "id", "name", "icon", "source"]
-}

package/dist/lib/browser/preview-popover-2UCEZUQW.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/capabilities/preview-popover.ts"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { Capabilities, LayoutAction, contributes, createIntent, type PluginContext } from '@dxos/app-framework';\nimport { addEventListener } from '@dxos/async';\nimport { type Client, resolveRef } from '@dxos/client';\nimport { parseId, type Space } from '@dxos/client/echo';\nimport { DXN } from '@dxos/keys';\nimport { type DxRefTagActivate } from '@dxos/lit-ui';\nimport { log } from '@dxos/log';\nimport { ClientCapabilities } from '@dxos/plugin-client';\nimport { type PreviewLinkRef, type PreviewLinkTarget } from '@dxos/react-ui-editor';\n\nconst customEventOptions = { capture: true, passive: false };\n\nconst handlePreviewLookup = async (\n  client: Client,\n  defaultSpace: Space,\n  { ref, label }: PreviewLinkRef,\n): Promise<PreviewLinkTarget | null> => {\n  try {\n    const dxn = DXN.parse(ref);\n    if (!dxn) {\n      return null;\n    }\n\n    const object = await resolveRef(client, dxn, defaultSpace);\n    return { label, object };\n  } catch (err) {\n    return null;\n  }\n};\n\nexport default (context: PluginContext) => {\n  // TODO(wittjosiah): Factor out lookup handlers to other plugins to make not ECHO-specific.\n  const handleDxRefTagActivate = async ({ refId, label, trigger }: DxRefTagActivate) => {\n    const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);\n    const client = context.getCapability(ClientCapabilities.Client);\n    const [layout] = context.getCapabilities(Capabilities.Layout);\n    const { spaceId } = parseId(layout.workspace);\n    const space = (spaceId && client.spaces.get(spaceId)) ?? client.spaces.default;\n    const result = await handlePreviewLookup(client, space, { ref: refId, label });\n    if (!result) {\n      return;\n    }\n\n    await dispatch(\n      createIntent(LayoutAction.UpdatePopover, {\n        part: 'popover',\n        subject: result.object,\n        options: {\n          state: true,\n          variant: 'virtual',\n          anchor: trigger,\n        },\n      }),\n    );\n  };\n\n  let cleanup: () => void;\n  if (document.defaultView) {\n    cleanup = addEventListener(\n      document.defaultView,\n      'dx-ref-tag-activate' as any,\n      handleDxRefTagActivate,\n      customEventOptions,\n    );\n  } else {\n    log.warn('No default view found');\n  }\n\n  return contributes(Capabilities.Null, null, () => cleanup());\n};\n"],
-  "mappings": ";AAIA,SAASA,cAAcC,cAAcC,aAAaC,oBAAwC;AAC1F,SAASC,wBAAwB;AACjC,SAAsBC,kBAAkB;AACxC,SAASC,eAA2B;AACpC,SAASC,WAAW;AAEpB,SAASC,WAAW;AACpB,SAASC,0BAA0B;;AAGnC,IAAMC,qBAAqB;EAAEC,SAAS;EAAMC,SAAS;AAAM;AAE3D,IAAMC,sBAAsB,OAC1BC,QACAC,cACA,EAAEC,KAAKC,MAAK,MAAkB;AAE9B,MAAI;AACF,UAAMC,MAAMX,IAAIY,MAAMH,GAAAA;AACtB,QAAI,CAACE,KAAK;AACR,aAAO;IACT;AAEA,UAAME,SAAS,MAAMf,WAAWS,QAAQI,KAAKH,YAAAA;AAC7C,WAAO;MAAEE;MAAOG;IAAO;EACzB,SAASC,KAAK;AACZ,WAAO;EACT;AACF;AAEA,IAAA,0BAAe,CAACC,YAAAA;AAEd,QAAMC,yBAAyB,OAAO,EAAEC,OAAOP,OAAOQ,QAAO,MAAoB;AAC/E,UAAM,EAAEC,iBAAiBC,SAAQ,IAAKL,QAAQM,cAAc5B,aAAa6B,gBAAgB;AACzF,UAAMf,SAASQ,QAAQM,cAAcnB,mBAAmBqB,MAAM;AAC9D,UAAM,CAACC,MAAAA,IAAUT,QAAQU,gBAAgBhC,aAAaiC,MAAM;AAC5D,UAAM,EAAEC,QAAO,IAAK5B,QAAQyB,OAAOI,SAAS;AAC5C,UAAMC,SAASF,WAAWpB,OAAOuB,OAAOC,IAAIJ,OAAAA,MAAapB,OAAOuB,OAAOE;AACvE,UAAMC,SAAS,MAAM3B,oBAAoBC,QAAQsB,OAAO;MAAEpB,KAAKQ;MAAOP;IAAM,CAAA;AAC5E,QAAI,CAACuB,QAAQ;AACX;IACF;AAEA,UAAMb,SACJxB,aAAaF,aAAawC,eAAe;MACvCC,MAAM;MACNC,SAASH,OAAOpB;MAChBwB,SAAS;QACPC,OAAO;QACPC,SAAS;QACTC,QAAQtB;MACV;IACF,CAAA,CAAA;EAEJ;AAEA,MAAIuB;AACJ,MAAIC,SAASC,aAAa;AACxBF,cAAU5C,iBACR6C,SAASC,aACT,uBACA3B,wBACAb,kBAAAA;EAEJ,OAAO;AACLF,QAAI2C,KAAK,yBAAA,QAAA;;;;;;EACX;AAEA,SAAOjD,YAAYF,aAAaoD,MAAM,MAAM,MAAMJ,QAAAA,CAAAA;AACpD;",
-  "names": ["Capabilities", "LayoutAction", "contributes", "createIntent", "addEventListener", "resolveRef", "parseId", "DXN", "log", "ClientCapabilities", "customEventOptions", "capture", "passive", "handlePreviewLookup", "client", "defaultSpace", "ref", "label", "dxn", "parse", "object", "err", "context", "handleDxRefTagActivate", "refId", "trigger", "dispatchPromise", "dispatch", "getCapability", "IntentDispatcher", "Client", "layout", "getCapabilities", "Layout", "spaceId", "workspace", "space", "spaces", "get", "default", "result", "UpdatePopover", "part", "subject", "options", "state", "variant", "anchor", "cleanup", "document", "defaultView", "warn", "Null"]
-}