@dxos/plugin-preview 0.8.4-main.67995b8 → 0.8.4-main.69d29f4

package/dist/types/src/testing/util.d.ts

@@ -1,80 +0,0 @@
-import type { Meta } from '@storybook/react-vite';
-import { type FC } from 'react';
-import type { PreviewProps } from '../types';
-export type StoryProps = {
-    Component: FC<PreviewProps<any>>;
-    icon?: string;
-    withImage?: boolean;
-    subject: 'project' | 'contact' | 'organization';
-    role: 'card--popover' | 'card--intrinsic' | 'card--extrinsic' | 'card--transclusion';
-};
-export declare const render: Meta<StoryProps>['render'];
-export declare const omitImage: ({ image, ...rest }: any) => any;
-export declare const data: {
-    organization: import("@dxos/live-object").Live<import("@dxos/echo/Type").OfKind<import("@dxos/echo-schema").EntityKind.Object> & {
-        image?: string | undefined;
-        id: string;
-        status?: "active" | "prospect" | "qualified" | "commit" | "reject" | undefined;
-        name?: string | undefined;
-        description?: string | undefined;
-        website?: string | undefined;
-    }>;
-    contact: import("@dxos/live-object").Live<import("@dxos/echo/Type").OfKind<import("@dxos/echo-schema").EntityKind.Object> & {
-        fields?: {
-            readonly label: string;
-            readonly category?: string | undefined;
-            readonly value: string;
-        }[] | undefined;
-        fullName?: string | undefined;
-        preferredName?: string | undefined;
-        nickname?: string | undefined;
-        image?: string | undefined;
-        organization?: import("@dxos/echo-schema").Ref<import("@dxos/echo/Type").OfKind<import("@dxos/echo-schema").EntityKind.Object> & {
-            id: string;
-            name?: string | undefined;
-            description?: string | undefined;
-            status?: "prospect" | "qualified" | "active" | "commit" | "reject" | undefined;
-            image?: string | undefined;
-            website?: string | undefined;
-        }> | undefined;
-        jobTitle?: string | undefined;
-        department?: string | undefined;
-        notes?: string | undefined;
-        emails?: {
-            readonly label?: string | undefined;
-            readonly value: string;
-        }[] | undefined;
-        identities?: {
-            readonly label?: string | undefined;
-            readonly value: string;
-        }[] | undefined;
-        phoneNumbers?: {
-            readonly label?: string | undefined;
-            readonly value: string;
-        }[] | undefined;
-        addresses?: {
-            readonly label?: string | undefined;
-            readonly value: {
-                readonly street?: string | undefined;
-                readonly extended?: string | undefined;
-                readonly locality?: string | undefined;
-                readonly region?: string | undefined;
-                readonly postalCode?: string | undefined;
-                readonly postOfficeBoxNumber?: string | undefined;
-                readonly country?: string | undefined;
-            };
-        }[] | undefined;
-        urls?: {
-            readonly label?: string | undefined;
-            readonly value: string;
-        }[] | undefined;
-        birthday?: string | undefined;
-    }>;
-    project: import("@dxos/live-object").Live<import("@dxos/echo/Type").OfKind<import("@dxos/echo-schema").EntityKind.Object> & {
-        image?: string | undefined;
-        id: string;
-        name: string;
-        description?: string | undefined;
-    }>;
-};
-//# sourceMappingURL=util.d.ts.map

package/dist/types/src/testing/util.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../../src/testing/util.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAc,EAAE,KAAK,EAAE,EAAE,MAAM,OAAO,CAAC;AAOvC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAI7C,MAAM,MAAM,UAAU,GAAG;IACvB,SAAS,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,EAAE,SAAS,GAAG,SAAS,GAAG,cAAc,CAAC;IAChD,IAAI,EAAE,eAAe,GAAG,iBAAiB,GAAG,iBAAiB,GAAG,oBAAoB,CAAC;CACtF,CAAC;AAEF,eAAO,MAAM,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,CAa7C,CAAC;AAEF,eAAO,MAAM,SAAS,GAAI,oBAAoB,GAAG,QAAS,CAAC;AAE3D,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqCb,CAAC"}

package/dist/types/src/types.d.ts

@@ -1,6 +0,0 @@
-import { type PropsWithChildren } from 'react';
-export type PreviewProps<T extends object> = PropsWithChildren<{
-    subject: T;
-    role?: string;
-}>;
-//# sourceMappingURL=types.d.ts.map

package/dist/types/src/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAG/C,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,IAAI,iBAAiB,CAAC;IAC7D,OAAO,EAAE,CAAC,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC,CAAC"}

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,163 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Effect } from 'effect';
-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 { Filter, Obj } from '@dxos/echo';
-import { type JsonPath, setValue } from '@dxos/echo-schema';
-import { AttentionAction } from '@dxos/plugin-attention/types';
-import { ATTENDABLE_PATH_SEPARATOR, DeckAction } from '@dxos/plugin-deck/types';
-import { useQuery, useSpace } from '@dxos/react-client/echo';
-import { useTranslation } from '@dxos/react-ui';
-import { Form } from '@dxos/react-ui-form';
-import { Card } from '@dxos/react-ui-stack';
-import { TableView } from '@dxos/react-ui-table/types';
-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: ['card--popover', 'card--intrinsic', 'card--transclusion', 'card--extrinsic', 'card'],
-      filter: (data): data is { subject: DataType.Person } => Obj.instanceOf(DataType.Person, data.subject),
-      component: ({ data, role }) => {
-        const { dispatch } = useIntentDispatcher();
-        const space = getSpace(data.subject);
-        const defaultSpace = useSpace();
-
-        const currentSpaceOrgs = useQuery(space, Filter.type(DataType.Organization));
-        const currentSpaceViews = useQuery(space, Filter.type(DataType.View));
-        const defaultSpaceViews = useQuery(defaultSpace, Filter.type(DataType.View));
-        const currentSpaceOrgTable = currentSpaceViews.find(
-          (view) =>
-            view.query.typename === DataType.Organization.typename &&
-            Obj.instanceOf(TableView, view.presentation.target),
-        );
-        const defaultSpaceOrgTable = defaultSpaceViews.find(
-          (view) =>
-            view.query.typename === DataType.Organization.typename &&
-            Obj.instanceOf(TableView, view.presentation.target),
-        );
-
-        // TODO(wittjosiah): Generalized way of handling related objects navigation.
-        const handleOrgClick = useCallback(
-          (org: DataType.Organization) =>
-            Effect.gen(function* () {
-              const view = currentSpaceOrgs.includes(org) ? currentSpaceOrgTable : defaultSpaceOrgTable;
-              yield* dispatch(
-                createIntent(LayoutAction.UpdatePopover, {
-                  part: 'popover',
-                  options: {
-                    state: false,
-                    anchorId: '',
-                  },
-                }),
-              );
-              if (view) {
-                const id = fullyQualifiedId(view);
-                yield* dispatch(
-                  createIntent(LayoutAction.Open, {
-                    part: 'main',
-                    subject: [id],
-                    options: { workspace: space?.id },
-                  }),
-                );
-                yield* dispatch(
-                  createIntent(DeckAction.ChangeCompanion, {
-                    primary: id,
-                    companion: [id, 'selected-objects'].join(ATTENDABLE_PATH_SEPARATOR),
-                  }),
-                );
-                yield* dispatch(
-                  createIntent(AttentionAction.Select, {
-                    contextId: id,
-                    selection: { mode: 'multi', ids: [org.id] },
-                  }),
-                );
-              }
-            }).pipe(Effect.runPromise),
-          [dispatch, currentSpaceOrgs, currentSpaceOrgTable, defaultSpaceOrgTable],
-        );
-
-        return (
-          <ContactCard role={role} subject={data.subject} onOrgClick={handleOrgClick}>
-            {role === 'card--popover' && <Surface role='related' data={data} />}
-          </ContactCard>
-        );
-      },
-    }),
-    createSurface({
-      id: `${PREVIEW_PLUGIN}/schema-popover--organization`,
-      role: ['card--popover', 'card--intrinsic', 'card--transclusion', 'card--extrinsic', 'card'],
-      filter: (data): data is { subject: DataType.Organization } => Obj.instanceOf(DataType.Organization, data.subject),
-      component: ({ data, role }) => (
-        <OrganizationCard role={role} subject={data.subject}>
-          {role === 'card--popover' && <Surface role='related' data={data} />}
-        </OrganizationCard>
-      ),
-    }),
-    createSurface({
-      id: `${PREVIEW_PLUGIN}/schema-popover--project`,
-      role: ['card--popover', 'card--intrinsic', 'card--transclusion', 'card--extrinsic', '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: ['card--popover', 'card--intrinsic', 'card--transclusion', 'card--extrinsic', '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.SurfaceRoot role={role}>
-            <Form
-              schema={schema}
-              values={data.subject}
-              readonly={role === 'card--popover'}
-              onSave={handleSave}
-              autoSave
-              {...(role === 'card--intrinsic' && { outerSpacing: 'blockStart-0' })}
-            />
-          </Card.SurfaceRoot>
-        );
-      },
-    }),
-  ]);

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.SurfaceRoot 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.SurfaceRoot>
-  );
-};

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.SurfaceRoot 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.SurfaceRoot>
-  );
-};

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.SurfaceRoot 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.SurfaceRoot>
-  );
-};

package/src/testing/ExtrinsicPreviews.stories.tsx

@@ -1,55 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import '@dxos-theme';
-
-import { type Meta } from '@storybook/react-vite';
-
-import { withTheme, withLayout } from '@dxos/storybook-utils';
-
-import { type StoryProps, render } from './util';
-import { ContactCard, OrganizationCard, ProjectCard } from '../components';
-import { translations } from '../translations';
-
-const meta: Meta<StoryProps> = {
-  title: 'Cards/plugin-preview/Extrinsic',
-  render,
-  decorators: [withTheme, withLayout()],
-  parameters: {
-    layout: 'centered',
-    translations,
-  },
-};
-
-export default meta;
-
-export const Contact = {
-  args: {
-    Component: ContactCard,
-    icon: 'ph--user--regular',
-    subject: 'contact',
-    withImage: true,
-    role: 'card--extrinsic',
-  },
-};
-
-export const Organization = {
-  args: {
-    Component: OrganizationCard,
-    icon: 'ph--building-office--regular',
-    subject: 'organization',
-    withImage: true,
-    role: 'card--extrinsic',
-  },
-};
-
-export const Project = {
-  args: {
-    Component: ProjectCard,
-    icon: 'ph--building--regular',
-    subject: 'project',
-    withImage: true,
-    role: 'card--extrinsic',
-  },
-};

package/src/testing/IntrinsicPreviews.stories.tsx

@@ -1,55 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import '@dxos-theme';
-
-import { type Meta } from '@storybook/react-vite';
-
-import { withTheme, withLayout } from '@dxos/storybook-utils';
-
-import { type StoryProps, render } from './util';
-import { ContactCard, OrganizationCard, ProjectCard } from '../components';
-import { translations } from '../translations';
-
-const meta: Meta<StoryProps> = {
-  title: 'Cards/plugin-preview/Intrinsic',
-  render,
-  decorators: [withTheme, withLayout()],
-  parameters: {
-    layout: 'centered',
-    translations,
-  },
-};
-
-export default meta;
-
-export const Contact = {
-  args: {
-    Component: ContactCard,
-    icon: 'ph--user--regular',
-    subject: 'contact',
-    withImage: true,
-    role: 'card--intrinsic',
-  },
-};
-
-export const Organization = {
-  args: {
-    Component: OrganizationCard,
-    icon: 'ph--building-office--regular',
-    subject: 'organization',
-    withImage: true,
-    role: 'card--intrinsic',
-  },
-};
-
-export const Project = {
-  args: {
-    Component: ProjectCard,
-    icon: 'ph--building--regular',
-    subject: 'project',
-    withImage: true,
-    role: 'card--intrinsic',
-  },
-};

package/src/testing/PopoverPreviews.stories.tsx

@@ -1,55 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import '@dxos-theme';
-
-import { type Meta } from '@storybook/react-vite';
-
-import { withTheme, withLayout } from '@dxos/storybook-utils';
-
-import { type StoryProps, render } from './util';
-import { ContactCard, OrganizationCard, ProjectCard } from '../components';
-import { translations } from '../translations';
-
-const meta: Meta<StoryProps> = {
-  title: 'Cards/plugin-preview/Popover',
-  render,
-  decorators: [withTheme, withLayout()],
-  parameters: {
-    layout: 'centered',
-    translations,
-  },
-};
-
-export default meta;
-
-export const Contact = {
-  args: {
-    Component: ContactCard,
-    icon: 'ph--user--regular',
-    subject: 'contact',
-    withImage: true,
-    role: 'card--popover',
-  },
-};
-
-export const Organization = {
-  args: {
-    Component: OrganizationCard,
-    icon: 'ph--building-office--regular',
-    subject: 'organization',
-    withImage: true,
-    role: 'card--popover',
-  },
-};
-
-export const Project = {
-  args: {
-    Component: ProjectCard,
-    icon: 'ph--building--regular',
-    subject: 'project',
-    withImage: true,
-    role: 'card--popover',
-  },
-};