@dxos/plugin-preview 0.8.3-staging.0fa589b → 0.8.4-main.1068cf700f

package/src/Preview.stories.tsx

@@ -1,147 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import '@dxos-theme';
-
-import { type Meta } from '@storybook/react';
-import React, { type FC } from 'react';
-
-import { Obj, Ref } from '@dxos/echo';
-import { faker } from '@dxos/random';
-import { Icon, Popover } from '@dxos/react-ui';
-import { DataType } from '@dxos/schema';
-import { withTheme, withLayout } from '@dxos/storybook-utils';
-
-import { ContactCard, OrganizationCard, ProjectCard } from './components';
-import translations from './translations';
-import { type PreviewProps } from './types';
-
-faker.seed(1234);
-
-type StoryProps = {
-  Component: FC<PreviewProps<any>>;
-  icon: string;
-  subject: any;
-};
-
-const meta: Meta<StoryProps> = {
-  title: 'plugins/plugin-preview/Preview',
-  render: ({ Component, icon, ...args }) => {
-    return (
-      <Popover.Root open>
-        <Popover.Content>
-          <Popover.Viewport>
-            <Component {...args} role='popover' />
-          </Popover.Viewport>
-          <Popover.Arrow />
-        </Popover.Content>
-        <Popover.Trigger>
-          <Icon icon={icon} size={5} />
-        </Popover.Trigger>
-      </Popover.Root>
-    );
-  },
-  decorators: [withTheme, withLayout()],
-  parameters: {
-    layout: 'centered',
-    translations,
-  },
-};
-
-export default meta;
-
-const omitImage = ({ image, ...rest }: any) => rest;
-
-const data = (() => {
-  const organization = Obj.make(DataType.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(DataType.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 = Obj.make(DataType.Project, {
-    name: faker.person.fullName(),
-    image: 'https://dxos.network/dxos-logotype-blue.png',
-    description: faker.lorem.paragraph(),
-  });
-
-  return { organization, contact, project };
-})();
-
-export const ContactWithImage = {
-  args: {
-    Component: ContactCard,
-    icon: 'ph--user--regular',
-    subject: data.contact,
-    role: 'popover',
-  },
-};
-
-export const ContactNoImage = {
-  args: {
-    Component: ContactCard,
-    icon: 'ph--user--regular',
-    subject: omitImage(data.contact),
-    role: 'popover',
-  },
-};
-
-export const OrganizationWithImage = {
-  args: {
-    Component: OrganizationCard,
-    icon: 'ph--building-office--regular',
-    subject: data.organization,
-    role: 'popover',
-  },
-};
-
-export const OrganizationNoImage = {
-  args: {
-    Component: OrganizationCard,
-    icon: 'ph--building-office--regular',
-    subject: omitImage(data.organization),
-    role: 'popover',
-  },
-};
-
-export const ProjectWithImage = {
-  args: {
-    Component: ProjectCard,
-    icon: 'ph--building--regular',
-    subject: data.project,
-    role: 'popover',
-  },
-};
-
-export const ProjectNoImage = {
-  args: {
-    Component: ProjectCard,
-    icon: 'ph--building--regular',
-    subject: omitImage(data.project),
-    role: 'popover',
-  },
-};

package/src/capabilities/preview-popover.ts

@@ -1,74 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities, LayoutAction, contributes, createIntent, type PluginContext } from '@dxos/app-framework';
-import { addEventListener } from '@dxos/async';
-import { type Client, resolveRef } from '@dxos/client';
-import { parseId, type Space } from '@dxos/client/echo';
-import { DXN } from '@dxos/keys';
-import { type DxRefTagActivate } from '@dxos/lit-ui';
-import { log } from '@dxos/log';
-import { ClientCapabilities } from '@dxos/plugin-client';
-import { type PreviewLinkRef, type PreviewLinkTarget } from '@dxos/react-ui-editor';
-
-const customEventOptions = { capture: true, passive: false };
-
-const handlePreviewLookup = async (
-  client: Client,
-  defaultSpace: Space,
-  { ref, label }: PreviewLinkRef,
-): Promise<PreviewLinkTarget | null> => {
-  try {
-    const dxn = DXN.parse(ref);
-    if (!dxn) {
-      return null;
-    }
-
-    const object = await resolveRef(client, dxn, defaultSpace);
-    return { label, object };
-  } catch (err) {
-    return null;
-  }
-};
-
-export default (context: PluginContext) => {
-  // TODO(wittjosiah): Factor out lookup handlers to other plugins to make not ECHO-specific.
-  const handleDxRefTagActivate = async ({ refId, label, trigger }: DxRefTagActivate) => {
-    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: () => void;
-  if (document.defaultView) {
-    cleanup = addEventListener(
-      document.defaultView,
-      'dx-ref-tag-activate' as any,
-      handleDxRefTagActivate,
-      customEventOptions,
-    );
-  } else {
-    log.warn('No default view found');
-  }
-
-  return contributes(Capabilities.Null, null, () => cleanup());
-};

package/src/capabilities/react-surface.tsx

@@ -1,130 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useCallback } from 'react';
-
-import {
-  Capabilities,
-  LayoutAction,
-  Surface,
-  contributes,
-  createIntent,
-  createSurface,
-  useIntentDispatcher,
-} from '@dxos/app-framework';
-import { fullyQualifiedId, getSchema, getSpace } from '@dxos/client/echo';
-import { Obj, Filter } from '@dxos/echo';
-import { type JsonPath, setValue } from '@dxos/echo-schema';
-import { useTranslation } from '@dxos/react-ui';
-import { Form } from '@dxos/react-ui-form';
-import { Card } from '@dxos/react-ui-stack';
-import { TableType } from '@dxos/react-ui-table';
-import { descriptionMessage, mx } from '@dxos/react-ui-theme';
-import { DataType } from '@dxos/schema';
-
-import { ContactCard, OrganizationCard, ProjectCard } from '../components';
-import { PREVIEW_PLUGIN } from '../meta';
-
-export default () =>
-  contributes(Capabilities.ReactSurface, [
-    //
-    // Specific schema types.
-    //
-    createSurface({
-      id: `${PREVIEW_PLUGIN}/schema-popover--contact`,
-      role: ['popover', 'card--kanban', 'card--document', 'card'],
-      filter: (data): data is { subject: DataType.Person } => Obj.instanceOf(DataType.Person, data.subject),
-      component: ({ data, role }) => {
-        const { dispatchPromise: dispatch } = useIntentDispatcher();
-        const handleOrgClick = useCallback(
-          async (org: DataType.Organization) => {
-            const space = getSpace(org);
-            const tablesQuery = await space?.db.query(Filter.type(TableType)).run();
-            const currentSpaceOrgTable = tablesQuery?.objects.find((table) => {
-              return table.view?.target?.query?.typename === DataType.Organization.typename;
-            });
-            await dispatch(
-              createIntent(LayoutAction.UpdatePopover, {
-                part: 'popover',
-                options: {
-                  state: false,
-                  anchorId: '',
-                },
-              }),
-            );
-            if (currentSpaceOrgTable) {
-              return dispatch(
-                createIntent(LayoutAction.Open, {
-                  part: 'main',
-                  subject: [fullyQualifiedId(currentSpaceOrgTable)],
-                  options: { workspace: space?.id },
-                }),
-              );
-            }
-          },
-          [dispatch],
-        );
-        return (
-          <ContactCard role={role} subject={data.subject} onOrgClick={handleOrgClick}>
-            {role === 'popover' && <Surface role='related' data={data} />}
-          </ContactCard>
-        );
-      },
-    }),
-    createSurface({
-      id: `${PREVIEW_PLUGIN}/schema-popover--organization`,
-      role: ['popover', 'card--kanban', 'card--document', 'card'],
-      filter: (data): data is { subject: DataType.Organization } => Obj.instanceOf(DataType.Organization, data.subject),
-      component: ({ data, role }) => (
-        <OrganizationCard role={role} subject={data.subject}>
-          {role === 'popover' && <Surface role='related' data={data} />}
-        </OrganizationCard>
-      ),
-    }),
-    createSurface({
-      id: `${PREVIEW_PLUGIN}/schema-popover--project`,
-      role: ['popover', 'card--kanban', 'card--document', 'card'],
-      filter: (data): data is { subject: DataType.Project } => Obj.instanceOf(DataType.Project, data.subject),
-      component: ({ data, role }) => <ProjectCard subject={data.subject} role={role} />,
-    }),
-
-    //
-    // Fallback for any object.
-    //
-    createSurface({
-      id: `${PREVIEW_PLUGIN}/fallback-popover`,
-      role: ['popover', 'card--kanban', 'card--document', 'card'],
-      position: 'fallback',
-      filter: (data): data is { subject: Obj.Any } => 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>;
-        }
-
-        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.Container role={role}>
-            <Form
-              schema={schema}
-              values={data.subject}
-              readonly={role === 'popover'}
-              onSave={handleSave}
-              autoSave
-              {...(role === 'card--kanban' && { outerSpacing: 'blockStart-0' })}
-            />
-          </Card.Container>
-        );
-      },
-    }),
-  ]);

package/src/components/ContactCard.tsx

@@ -1,70 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { Fragment } from 'react';
-
-import { Icon, Avatar, Button } from '@dxos/react-ui';
-import { Card, cardHeading, cardText } from '@dxos/react-ui-stack';
-import { mx } from '@dxos/react-ui-theme';
-import { type DataType } from '@dxos/schema';
-
-import { type PreviewProps } from '../types';
-
-export const ContactCard = ({
-  children,
-  subject: { fullName, image, organization, emails },
-  onOrgClick,
-  role,
-}: PreviewProps<DataType.Person> & { onOrgClick?: (org: DataType.Organization) => void }) => {
-  const organizationName = organization && typeof organization === 'object' ? organization.target?.name : organization;
-  return (
-    <Card.Container role={role}>
-      <Avatar.Root>
-        <Card.Text role='group' classNames='grid gap-3 grid-cols-[min-content_1fr]'>
-          <Avatar.Content imgSrc={image} icon='ph--user--regular' size={16} hue='neutral' />
-          <div role='none' className='bs-min self-center'>
-            <Avatar.Label asChild>
-              <h2 className={cardHeading}>{fullName}</h2>
-            </Avatar.Label>
-          </div>
-        </Card.Text>
-      </Avatar.Root>
-      {organizationName && (
-        <Card.Chrome>
-          {typeof organization === 'object' && onOrgClick ? (
-            <Button variant='ghost' classNames='gap-2 text-start' onClick={() => onOrgClick(organization.target!)}>
-              <Icon icon='ph--buildings--regular' size={5} classNames='text-subdued' />
-              <span className='min-is-0 flex-1 truncate'>{organizationName}</span>
-              <Icon icon='ph--arrow-right--regular' />
-            </Button>
-          ) : (
-            <p className='dx-button gap-2' data-variant='ghost'>
-              <Icon icon='ph--buildings--regular' size={5} classNames='text-subdued' />
-              <span className='min-is-0 flex-1 truncate'>{organizationName}</span>
-            </p>
-          )}
-        </Card.Chrome>
-      )}
-      <dl
-        className={mx(
-          cardText,
-          'grid gap-2 grid-cols-[min-content_1fr] [&_dt]:text-subdued [&_dt]:pbs-0.5 [&_dd]:min-is-0',
-        )}
-      >
-        {emails?.length &&
-          emails.map(({ label, value }) => (
-            <Fragment key={value}>
-              <dt>
-                <Icon icon='ph--at--regular' size={5} />
-              </dt>
-              <dd key={value} className='break-words'>
-                {value}
-              </dd>
-            </Fragment>
-          ))}
-      </dl>
-      {children}
-    </Card.Container>
-  );
-};

package/src/components/OrganizationCard.tsx

@@ -1,41 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-import { Icon } from '@dxos/react-ui';
-import { Card } from '@dxos/react-ui-stack';
-import { type DataType } from '@dxos/schema';
-
-import { type PreviewProps } from '../types';
-
-export const OrganizationCard = ({
-  children,
-  subject: { name, image, description, website },
-  role,
-}: PreviewProps<DataType.Organization>) => {
-  return (
-    <Card.Container role={role}>
-      <Card.Poster alt={name!} {...(image ? { image } : { icon: 'ph--building-office--regular' })} />
-      <Card.Heading>{name}</Card.Heading>
-      {description && <Card.Text classNames='line-clamp-2'>{description}</Card.Text>}
-      {website && (
-        <Card.Chrome>
-          <a
-            className='dx-button dx-focus-ring gap-2'
-            data-variant='ghost'
-            href={website}
-            target='_blank'
-            rel='noreferrer'
-          >
-            <Icon icon='ph--link--regular' size={5} classNames='text-subdued' />
-            <span className='grow'>{website}</span>
-            <Icon icon='ph--arrow-square-out--regular' />
-          </a>
-        </Card.Chrome>
-      )}
-      {children}
-    </Card.Container>
-  );
-};

package/src/components/ProjectCard.tsx

@@ -1,20 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-import { Card } from '@dxos/react-ui-stack';
-import { type DataType } from '@dxos/schema';
-
-import { type PreviewProps } from '../types';
-
-export const ProjectCard = ({ subject: { name, image, description }, role }: PreviewProps<DataType.Project>) => {
-  return (
-    <Card.Container role={role}>
-      {image && <Card.Poster image={image} alt={name} aspect='auto' />}
-      <Card.Heading>{name}</Card.Heading>
-      {description && <Card.Text classNames='line-clamp-2'>{description}</Card.Text>}
-    </Card.Container>
-  );
-};

package/src/types.ts

@@ -1,11 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type PropsWithChildren } from 'react';
-
-// TODO(burdon): Better place for these defs?
-export type PreviewProps<T extends object> = PropsWithChildren<{
-  subject: T;
-  role?: string;
-}>;