@dxos/plugin-preview 0.8.4-main.72ec0f3 → 0.8.4-main.8360d9e660

package/src/index.ts

@@ -3,6 +3,5 @@
 //
 
 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/stories/Card.stories.tsx

@@ -4,59 +4,73 @@
 
 import { type Meta, type StoryObj } from '@storybook/react-vite';
 
-import { IntentPlugin } from '@dxos/app-framework';
 import { withPluginManager } from '@dxos/app-framework/testing';
+import { corePlugins } from '@dxos/plugin-testing';
 import { faker } from '@dxos/random';
-import { withTheme } from '@dxos/react-ui/testing';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { type Organization, type Person, type Pipeline, type Task } from '@dxos/types';
 
+import { FormCard, OrganizationCard, PersonCard, ProjectCard, TaskCard } from '../cards';
 import { translations } from '../translations';
 
-import { Defaultstory, createCards } from './testing';
+import { DefaultStory, createOrganization, createPerson, createProject, createTask } from './testing';
 
 faker.seed(999);
 
 const meta = {
-  title: 'plugins/plugin-preview/Card',
-  render: Defaultstory,
+  title: 'plugins/plugin-preview/cards/Card',
+  render: DefaultStory,
   decorators: [
-    withTheme,
+    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,
   },
 };

package/src/stories/testing.tsx

@@ -2,113 +2,90 @@
 // Copyright 2025 DXOS.org
 //
 
-import React, { type FC } from 'react';
+import React, { type FC, useMemo } from 'react';
 
+import { type SurfaceComponentProps } from '@dxos/app-toolkit/ui';
 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 { Card } from '@dxos/react-ui';
+import { CardContainer, type CardContainerProps } from '@dxos/react-ui-mosaic/testing';
+import { Organization, Person, Pipeline, Task } 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;
+export type DefaultStoryProps<T extends Obj.Any> = {
+  Component: FC<SurfaceComponentProps<T>>;
+  createObject: () => T;
   image?: boolean;
 };
 
-export type DefaultstoryProps = {
-  role: 'card--popover' | 'card--intrinsic' | 'card--extrinsic' | 'card--transclusion';
-  cards: CardProps<any>[];
-};
+export const DefaultStory = <T extends Obj.Any>({ Component, createObject, image }: DefaultStoryProps<T>) => {
+  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='w-full h-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.Toolbar>
+                  <Card.DragHandle />
+                  <Card.Title>{Obj.getLabel(object)}</Card.Title>
+                  <Card.Menu />
+                </Card.Toolbar>
+                <Component role={role} subject={image ? object : omitImage(object)} />
+              </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(Organization.Organization, {
+/**
+ * Factory functions for creating test objects at render time.
+ */
+export const createOrganization = (): Organization.Organization => {
+  return 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, {
+export const createPerson = (): Person.Person => {
+  const organization = createOrganization();
+  return 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(),
-      },
+      { label: 'Work', value: faker.internet.email() },
+      { label: 'Work', value: faker.internet.email() },
+      { label: 'Work', value: faker.internet.email() },
     ],
   });
+};
 
-  const project = Project.make({
+export const createProject = (): Pipeline.Pipeline => {
+  return Obj.make(Pipeline.Pipeline, {
     name: faker.person.fullName(),
     image: 'https://dxos.network/dxos-logotype-blue.png',
     description: faker.lorem.paragraph(),
+    columns: [],
   });
+};
 
-  const task = Obj.make(Task.Task, {
+export const createTask = (): Task.Task => {
+  return Obj.make(Task.Task, {
     title: faker.lorem.sentence(),
-    status: faker.helpers.arrayElement(['todo', 'in-progress', 'done']),
+    status: faker.helpers.arrayElement(['todo', 'in-progress', 'done'] as const),
   });
-
-  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/dist/lib/browser/chunk-CEWM5LJG.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';\nimport { trim } from '@dxos/util';\n\nexport const meta: PluginMeta = {\n  id: 'dxos.org/plugin/preview',\n  name: 'Preview',\n  description: trim`\n    Rich preview panel for viewing object content without opening full editors.\n    Quick peek at documents, images, and data with inline rendering.\n  `,\n  icon: 'ph--eye--regular',\n  source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-preview',\n};\n"],
-  "mappings": ";AAKA,SAASA,YAAY;AAEd,IAAMC,OAAmB;EAC9BC,IAAI;EACJC,MAAM;EACNC,aAAaC;;;;EAIbC,MAAM;EACNC,QAAQ;AACV;",
-  "names": ["trim", "meta", "id", "name", "description", "trim", "icon", "source"]
-}

package/dist/lib/browser/preview-popover-IAPAEKZL.mjs

@@ -1,65 +0,0 @@
-// src/capabilities/preview-popover.ts
-import { Capabilities, LayoutAction, contributes, createIntent } from "@dxos/app-framework";
-import { addEventListener } from "@dxos/async";
-import { parseId } from "@dxos/client/echo";
-import { DXN } from "@dxos/keys";
-import { log } from "@dxos/log";
-import { ClientCapabilities } from "@dxos/plugin-client";
-import { DX_ANCHOR_ACTIVATE } from "@dxos/react-ui";
-var __dxlog_file = "/__w/dxos/dxos/packages/plugins/plugin-preview/src/capabilities/preview-popover.ts";
-var customEventOptions = {
-  capture: true,
-  passive: false
-};
-var handlePreviewLookup = async (client, defaultSpace, { ref, label }) => {
-  try {
-    const object = await defaultSpace.db.ref(DXN.parse(ref)).load();
-    return {
-      label,
-      object
-    };
-  } catch {
-    return null;
-  }
-};
-var preview_popover_default = ((context) => {
-  const handleAnchorActivate = async ({ refId, label, trigger }) => {
-    const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-    const client = context.getCapability(ClientCapabilities.Client);
-    const [layout] = context.getCapabilities(Capabilities.Layout);
-    const { spaceId } = parseId(layout.workspace);
-    const space = (spaceId && client.spaces.get(spaceId)) ?? client.spaces.default;
-    const result = await handlePreviewLookup(client, space, {
-      ref: refId,
-      label
-    });
-    if (!result) {
-      return;
-    }
-    await dispatch(createIntent(LayoutAction.UpdatePopover, {
-      part: "popover",
-      subject: result.object,
-      options: {
-        state: true,
-        variant: "virtual",
-        anchor: trigger
-      }
-    }));
-  };
-  let cleanup;
-  if (document.defaultView) {
-    cleanup = addEventListener(document.defaultView, DX_ANCHOR_ACTIVATE, handleAnchorActivate, customEventOptions);
-  } else {
-    log.warn("No default view found", void 0, {
-      F: __dxlog_file,
-      L: 65,
-      S: void 0,
-      C: (f, a) => f(...a)
-    });
-  }
-  return contributes(Capabilities.Null, null, () => cleanup());
-});
-export {
-  preview_popover_default as default
-};
-//# sourceMappingURL=preview-popover-IAPAEKZL.mjs.map

package/dist/lib/browser/preview-popover-IAPAEKZL.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, type PluginContext, contributes, createIntent } from '@dxos/app-framework';\nimport { addEventListener } from '@dxos/async';\nimport { type Client } from '@dxos/client';\nimport { type Space, parseId } from '@dxos/client/echo';\nimport { DXN } from '@dxos/keys';\nimport { log } from '@dxos/log';\nimport { ClientCapabilities } from '@dxos/plugin-client';\nimport { DX_ANCHOR_ACTIVATE, type DxAnchorActivate } from '@dxos/react-ui';\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 object = await defaultSpace.db.ref(DXN.parse(ref)).load();\n    return { label, object };\n  } catch {\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 handleAnchorActivate = async ({ refId, label, trigger }: DxAnchorActivate) => {\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_ANCHOR_ACTIVATE as any,\n      handleAnchorActivate,\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,cAAkCC,aAAaC,oBAAoB;AAC1F,SAASC,wBAAwB;AAEjC,SAAqBC,eAAe;AACpC,SAASC,WAAW;AACpB,SAASC,WAAW;AACpB,SAASC,0BAA0B;AACnC,SAASC,0BAAiD;;AAG1D,IAAMC,qBAAqB;EAAEC,SAAS;EAAMC,SAAS;AAAM;AAE3D,IAAMC,sBAAsB,OAC1BC,QACAC,cACA,EAAEC,KAAKC,MAAK,MAAkB;AAE9B,MAAI;AACF,UAAMC,SAAS,MAAMH,aAAaI,GAAGH,IAAIV,IAAIc,MAAMJ,GAAAA,CAAAA,EAAMK,KAAI;AAC7D,WAAO;MAAEJ;MAAOC;IAAO;EACzB,QAAQ;AACN,WAAO;EACT;AACF;AAEA,IAAA,2BAAe,CAACI,YAAAA;AAEd,QAAMC,uBAAuB,OAAO,EAAEC,OAAOP,OAAOQ,QAAO,MAAoB;AAC7E,UAAM,EAAEC,iBAAiBC,SAAQ,IAAKL,QAAQM,cAAc5B,aAAa6B,gBAAgB;AACzF,UAAMf,SAASQ,QAAQM,cAAcpB,mBAAmBsB,MAAM;AAC9D,UAAM,CAACC,MAAAA,IAAUT,QAAQU,gBAAgBhC,aAAaiC,MAAM;AAC5D,UAAM,EAAEC,QAAO,IAAK7B,QAAQ0B,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,OAAOtB;MAChB0B,SAAS;QACPC,OAAO;QACPC,SAAS;QACTC,QAAQtB;MACV;IACF,CAAA,CAAA;EAEJ;AAEA,MAAIuB;AACJ,MAAIC,SAASC,aAAa;AACxBF,cAAU5C,iBACR6C,SAASC,aACTzC,oBACAc,sBACAb,kBAAAA;EAEJ,OAAO;AACLH,QAAI4C,KAAK,yBAAA,QAAA;;;;;;EACX;AAEA,SAAOjD,YAAYF,aAAaoD,MAAM,MAAM,MAAMJ,QAAAA,CAAAA;AACpD;",
-  "names": ["Capabilities", "LayoutAction", "contributes", "createIntent", "addEventListener", "parseId", "DXN", "log", "ClientCapabilities", "DX_ANCHOR_ACTIVATE", "customEventOptions", "capture", "passive", "handlePreviewLookup", "client", "defaultSpace", "ref", "label", "object", "db", "parse", "load", "context", "handleAnchorActivate", "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"]
-}