@dxos/plugin-preview 0.8.4-main.1da679c → 0.8.4-main.21d9917

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

@@ -1,5 +0,0 @@
-import React from 'react';
-import { DataType } from '@dxos/schema';
-import { type PreviewProps } from '../types';
-export declare const TaskCard: ({ subject, role, activeSpace }: PreviewProps<DataType.Task>) => React.JSX.Element;
-//# sourceMappingURL=TaskCard.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"TaskCard.d.ts","sourceRoot":"","sources":["../../../../src/components/TaskCard.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,OAAO,CAAC;AAK1B,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,UAAU,CAAC;AAiB7C,eAAO,MAAM,QAAQ,GAAI,gCAAgC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,sBAgBnF,CAAC"}

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

@@ -1,4 +0,0 @@
-export * from './ContactCard';
-export * from './OrganizationCard';
-export * from './ProjectCard';
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/index.ts"],"names":[],"mappings":"AAIA,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC"}

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

@@ -1,9 +0,0 @@
-import { type Schema } from 'effect';
-import { type PropsWithChildren } from 'react';
-import { type Space } from '@dxos/react-client/echo';
-export type PreviewProps<T extends Schema.Schema.Type<any>> = PropsWithChildren<{
-    subject: T;
-    role?: string;
-    activeSpace?: Space;
-}>;
-//# 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,MAAM,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAE/C,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAErD,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,iBAAiB,CAAC;IAC9E,OAAO,EAAE,CAAC,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,KAAK,CAAC;CACrB,CAAC,CAAC"}

package/src/capabilities/preview-popover.ts

@@ -1,69 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities, LayoutAction, type PluginContext, contributes, createIntent } from '@dxos/app-framework';
-import { addEventListener } from '@dxos/async';
-import { type Client } from '@dxos/client';
-import { type Space, 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, type DxAnchorActivate } from '@dxos/react-ui';
-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 object = await defaultSpace.db.ref(DXN.parse(ref)).load();
-    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 handleDxAnchorActivate = async ({ refId, label, trigger }: DxAnchorActivate) => {
-    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_ANCHOR_ACTIVATE as any,
-      handleDxAnchorActivate,
-      customEventOptions,
-    );
-  } else {
-    log.warn('No default view found');
-  }
-
-  return contributes(Capabilities.Null, null, () => cleanup());
-};

package/src/capabilities/react-surface.tsx

@@ -1,181 +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 { useActiveSpace } from '@dxos/plugin-space';
-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 { Table } from '@dxos/react-ui-table/types';
-import { descriptionMessage, mx } from '@dxos/react-ui-theme';
-import { DataType, type ProjectionModel, typenameFromQuery } from '@dxos/schema';
-
-import { ContactCard, OrganizationCard, ProjectCard } from '../components';
-import { TaskCard } from '../components/TaskCard';
-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 activeSpace = useActiveSpace();
-
-        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) =>
-            typenameFromQuery(view.query) === DataType.Organization.typename &&
-            Obj.instanceOf(Table.Table, view.presentation.target),
-        );
-        const defaultSpaceOrgTable = defaultSpaceViews.find(
-          (view) =>
-            typenameFromQuery(view.query) === DataType.Organization.typename &&
-            Obj.instanceOf(Table.Table, 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} activeSpace={activeSpace} 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 }) => {
-        const activeSpace = useActiveSpace();
-
-        return (
-          <OrganizationCard role={role} subject={data.subject} activeSpace={activeSpace}>
-            {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 }) => {
-        const activeSpace = useActiveSpace();
-
-        return <ProjectCard subject={data.subject} role={role} activeSpace={activeSpace} />;
-      },
-    }),
-    createSurface({
-      id: `${PREVIEW_PLUGIN}/schema-popover--task`,
-      role: ['card--popover', 'card--intrinsic', 'card--transclusion', 'card--extrinsic', 'card'],
-      filter: (data): data is { subject: DataType.Task } => Obj.instanceOf(DataType.Task, data.subject),
-      component: ({ data, role }) => <TaskCard 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; projection?: ProjectionModel } => 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}
-              projection={data.projection}
-              values={data.subject}
-              readonly={role === 'card--popover' ? 'static' : false}
-              onSave={handleSave}
-              autoSave
-              {...(role === 'card--intrinsic' && { outerSpacing: 'blockStart-0' })}
-            />
-          </Card.SurfaceRoot>
-        );
-      },
-    }),
-  ]);

package/src/components/CardSubjectMenu.tsx

@@ -1,67 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Rx } from '@effect-rx/rx-react';
-import React from 'react';
-
-import { createIntent, useIntentDispatcher } from '@dxos/app-framework';
-import { ACTION_TYPE } from '@dxos/app-graph';
-import { Obj } from '@dxos/echo';
-import { SpaceAction } from '@dxos/plugin-space/types';
-import { type Space } from '@dxos/react-client/echo';
-import { IconButton, type IconButtonProps, useTranslation } from '@dxos/react-ui';
-import { type ActionGraphProps, DropdownMenu, MenuProvider, useMenuActions } from '@dxos/react-ui-menu';
-
-const useSubjectMenuGroupItems = (subject: Obj.Any, activeSpace?: Space) => {
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-  const result: ActionGraphProps = { edges: [], nodes: [] };
-  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: 'os' }],
-        icon: 'ph--file-plus--regular',
-      },
-    });
-  }
-  result.nodes.forEach(({ id: target }) => {
-    result.edges.push({ source: 'root', target });
-  });
-  return useMenuActions(Rx.make(result));
-};
-
-/**
- * This is a generic menu for objects that tries to infer common actions.
- */
-export const CardSubjectMenu = ({
-  subject,
-  activeSpace,
-  ...props
-}: Omit<IconButtonProps, 'icon' | 'label'> & { subject: Obj.Any; activeSpace?: Space }) => {
-  const { t } = useTranslation('os');
-  const menuProps = useSubjectMenuGroupItems(subject, activeSpace);
-
-  if (!activeSpace) {
-    return null;
-  }
-
-  return (
-    <MenuProvider {...menuProps}>
-      <DropdownMenu.Root>
-        <DropdownMenu.Trigger asChild>
-          <IconButton
-            iconOnly
-            variant='ghost'
-            icon='ph--dots-three-vertical--bold'
-            label={t('more options label')}
-            {...props}
-          />
-        </DropdownMenu.Trigger>
-      </DropdownMenu.Root>
-    </MenuProvider>
-  );
-};

package/src/components/ContactCard.tsx

@@ -1,78 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { Fragment } from 'react';
-
-import { Avatar, Button, Icon } 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';
-
-import { CardSubjectMenu } from './CardSubjectMenu';
-
-export const ContactCard = ({
-  children,
-  subject,
-  activeSpace,
-  onOrgClick,
-  role,
-}: PreviewProps<DataType.Person> & { onOrgClick?: (org: DataType.Organization) => void }) => {
-  const { fullName, image, organization, emails } = subject;
-  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 flex items-center'>
-            <Avatar.Label asChild>
-              <h2 className={mx(cardHeading, 'grow')}>{fullName}</h2>
-            </Avatar.Label>
-            <CardSubjectMenu subject={subject} activeSpace={activeSpace} />
-          </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>
-      )}
-      {emails?.length && (
-        <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>
-                  <span className='sr-only'>{label}</span>
-                  <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,44 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-import { Icon } from '@dxos/react-ui';
-import { Card, cardNoSpacing, cardSpacing } from '@dxos/react-ui-stack';
-import { mx } from '@dxos/react-ui-theme';
-import { type DataType } from '@dxos/schema';
-
-import { type PreviewProps } from '../types';
-
-import { CardSubjectMenu } from './CardSubjectMenu';
-
-export const OrganizationCard = ({ children, subject, role, activeSpace }: PreviewProps<DataType.Organization>) => {
-  const { name, image, description, website } = subject;
-  return (
-    <Card.SurfaceRoot role={role}>
-      <Card.Poster alt={name!} {...(image ? { image } : { icon: 'ph--building-office--regular' })} />
-      <div role='none' className={mx('flex items-center gap-2', cardSpacing)}>
-        <Card.Heading classNames={cardNoSpacing}>{name}</Card.Heading>
-        <CardSubjectMenu subject={subject} activeSpace={activeSpace} />
-      </div>
-      {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='min-is-0 flex-1 truncate'>{website}</span>
-            <Icon icon='ph--arrow-square-out--regular' />
-          </a>
-        </Card.Chrome>
-      )}
-      {children}
-    </Card.SurfaceRoot>
-  );
-};

package/src/components/ProjectCard.tsx

@@ -1,28 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-import { Obj } from '@dxos/echo';
-import { Card, cardNoSpacing, cardSpacing } from '@dxos/react-ui-stack';
-import { mx } from '@dxos/react-ui-theme';
-import { type DataType } from '@dxos/schema';
-
-import { type PreviewProps } from '../types';
-
-import { CardSubjectMenu } from './CardSubjectMenu';
-
-export const ProjectCard = ({ subject, role, activeSpace }: PreviewProps<DataType.Project>) => {
-  const { name, image, description } = subject;
-  return (
-    <Card.SurfaceRoot role={role}>
-      {image && <Card.Poster image={image} alt={Obj.getLabel(subject) ?? ''} aspect='auto' />}
-      <div role='none' className={mx('flex items-center gap-2', cardSpacing)}>
-        <Card.Heading classNames={cardNoSpacing}>{name}</Card.Heading>
-        <CardSubjectMenu subject={subject} activeSpace={activeSpace} />
-      </div>
-      {description && <Card.Text classNames='line-clamp-2'>{description}</Card.Text>}
-    </Card.SurfaceRoot>
-  );
-};

package/src/types.ts

@@ -1,14 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type Schema } from 'effect';
-import { type PropsWithChildren } from 'react';
-
-import { type Space } from '@dxos/react-client/echo';
-
-export type PreviewProps<T extends Schema.Schema.Type<any>> = PropsWithChildren<{
-  subject: T;
-  role?: string;
-  activeSpace?: Space;
-}>;