@dxos/plugin-space 0.8.3 → 0.8.4-main.1c7ec43d41

package/src/containers/JoinDialog/JoinDialog.stories.tsx

@@ -0,0 +1,43 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React from 'react';
+
+import { withPluginManager } from '@dxos/app-framework/testing';
+import { ClientPlugin } from '@dxos/plugin-client';
+import { corePlugins } from '@dxos/plugin-testing';
+import { Dialog } from '@dxos/react-ui';
+
+import { translations } from '#translations';
+
+import { JoinDialog } from './JoinDialog';
+
+const DefaultStory = () => (
+  <Dialog.Root defaultOpen>
+    <Dialog.Overlay>
+      <JoinDialog />
+    </Dialog.Overlay>
+  </Dialog.Root>
+);
+
+const meta = {
+  title: 'plugins/plugin-space/containers/JoinDialog',
+  component: JoinDialog,
+  render: DefaultStory,
+  decorators: [
+    withPluginManager({
+      plugins: [...corePlugins(), ClientPlugin({})],
+    }),
+  ],
+  parameters: {
+    translations,
+  },
+} satisfies Meta<typeof JoinDialog>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};

package/src/{components → containers/JoinDialog}/JoinDialog.tsx

@@ -4,28 +4,32 @@
 
 import React, { useCallback } from 'react';
 
-import { createIntent, LayoutAction, useAppGraph, useIntentDispatcher } from '@dxos/app-framework';
+import { useOperationInvoker } from '@dxos/app-framework/ui';
+import { LayoutOperation, getSpacePath } from '@dxos/app-toolkit';
+import { useAppGraph } from '@dxos/app-toolkit/ui';
 import { Trigger } from '@dxos/async';
-import { ObservabilityAction } from '@dxos/plugin-observability/types';
+import { Graph } from '@dxos/plugin-graph';
+import { ObservabilityOperation } from '@dxos/plugin-observability/operations';
 import { useClient } from '@dxos/react-client';
 import { type Space } from '@dxos/react-client/echo';
 import { type InvitationResult } from '@dxos/react-client/invitations';
 import { Dialog, useTranslation } from '@dxos/react-ui';
 import { JoinPanel, type JoinPanelProps } from '@dxos/shell/react';
+import { osTranslations } from '@dxos/ui-theme';
 
-import { SPACE_PLUGIN } from '../meta';
+import { meta } from '#meta';
 
-export const JOIN_DIALOG = `${SPACE_PLUGIN}/JoinDialog`;
+export const JOIN_DIALOG = `${meta.id}.JoinDialog`;
 
 export type JoinDialogProps = JoinPanelProps & {
   navigableCollections?: boolean;
 };
 
 export const JoinDialog = ({ navigableCollections, onDone, ...props }: JoinDialogProps) => {
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
+  const { invokePromise } = useOperationInvoker();
   const client = useClient();
   const { graph } = useAppGraph();
-  const { t } = useTranslation(SPACE_PLUGIN);
+  const { t } = useTranslation(meta.id);
 
   const handleDone = useCallback(
     async (result: InvitationResult | null) => {
@@ -35,25 +39,13 @@ export const JoinDialog = ({ navigableCollections, onDone, ...props }: JoinDialo
       }
 
       await Promise.all([
-        dispatch(
-          createIntent(LayoutAction.AddToast, {
-            part: 'toast',
-            subject: {
-              id: `${SPACE_PLUGIN}/join-success`,
-              duration: 5_000,
-              title: ['join success label', { ns: SPACE_PLUGIN }],
-              closeLabel: ['dismiss label', { ns: SPACE_PLUGIN }],
-            },
-          }),
-        ),
-        dispatch(
-          createIntent(LayoutAction.UpdateDialog, {
-            part: 'dialog',
-            options: {
-              state: false,
-            },
-          }),
-        ),
+        invokePromise(LayoutOperation.AddToast, {
+          id: `${meta.id}.join-success`,
+          duration: 5_000,
+          title: ['join-success.label', { ns: meta.id }],
+          closeLabel: ['dismiss.label', { ns: meta.id }],
+        }),
+        invokePromise(LayoutOperation.UpdateDialog, { state: false }),
       ]);
 
       let space = client.spaces.get(spaceKey);
@@ -69,7 +61,7 @@ export const JoinDialog = ({ navigableCollections, onDone, ...props }: JoinDialo
         space = await trigger.wait();
       }
 
-      await dispatch(createIntent(LayoutAction.SwitchWorkspace, { part: 'workspace', subject: space.id }));
+      await invokePromise(LayoutOperation.SwitchWorkspace, { subject: getSpacePath(space.id) });
 
       // TODO(wittjosiah): If navigableCollections is false and there's no target,
       //   should try to navigate to the first object of the space replicates.
@@ -78,38 +70,39 @@ export const JoinDialog = ({ navigableCollections, onDone, ...props }: JoinDialo
       if (target) {
         // Wait before navigating to the target node.
         // If the target has not yet replicated, this will trigger a loading toast.
-        await graph.waitForPath({ target }).catch(() => {});
+        await Graph.waitForPath(graph, { target }).catch(() => {});
         await Promise.all([
-          dispatch(createIntent(LayoutAction.Open, { part: 'main', subject: [target] })),
-          dispatch(createIntent(LayoutAction.Expose, { part: 'navigation', subject: target })),
+          invokePromise(LayoutOperation.Open, { subject: [target] }),
+          invokePromise(LayoutOperation.Expose, { subject: target }),
         ]);
       }
 
-      await onDone?.(result);
+      onDone?.(result);
 
       if (space) {
-        await dispatch(
-          createIntent(ObservabilityAction.SendEvent, {
-            name: 'space.join',
-            properties: {
-              spaceId: space.id,
-            },
-          }),
-        );
+        await invokePromise(ObservabilityOperation.SendEvent, {
+          name: 'space.join',
+          properties: {
+            spaceId: space.id,
+          },
+        });
       }
     },
-    [dispatch, client, graph],
+    [invokePromise, client, graph, navigableCollections, onDone],
   );
 
+  // TODO(burdon): Move JoinHeading into Dialog.Heading.
   return (
     <Dialog.Content>
-      <Dialog.Title classNames='sr-only'>{t('join space label', { ns: 'os' })}</Dialog.Title>
-      <JoinPanel
-        {...props}
-        exitActionParent={<Dialog.Close asChild />}
-        doneActionParent={<Dialog.Close asChild />}
-        onDone={handleDone}
-      />
+      <Dialog.Title classNames='sr-only'>{t('join-space.label', { ns: osTranslations })}</Dialog.Title>
+      <Dialog.Body>
+        <JoinPanel
+          {...props}
+          exitActionParent={<Dialog.Close asChild />}
+          doneActionParent={<Dialog.Close asChild />}
+          onDone={handleDone}
+        />
+      </Dialog.Body>
     </Dialog.Content>
   );
 };

package/src/containers/JoinDialog/index.ts

@@ -0,0 +1,6 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export { JoinDialog, type JoinDialogProps } from './JoinDialog';
+export { JoinDialog as default } from './JoinDialog';

package/src/containers/MembersContainer/MembersContainer.tsx

@@ -0,0 +1,262 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { type Dispatch, type SetStateAction, useMemo, useState } from 'react';
+import { QR } from 'react-qr-rounded';
+
+import { useOperationInvoker } from '@dxos/app-framework/ui';
+import { AppSurface } from '@dxos/app-toolkit/ui';
+import { Collection, Obj } from '@dxos/echo';
+import { log } from '@dxos/log';
+import { useConfig } from '@dxos/react-client';
+import { useSpaceInvitations } from '@dxos/react-client/echo';
+import { type CancellableInvitationObservable, Invitation, InvitationEncoder } from '@dxos/react-client/invitations';
+import { Button, Clipboard, Icon, useId, useTranslation } from '@dxos/react-ui';
+import { Settings } from '@dxos/react-ui-form';
+import {
+  type ActionMenuItem,
+  AuthCode,
+  BifurcatedAction,
+  Centered,
+  Emoji,
+  InvitationList,
+  SpaceMemberList,
+  Viewport,
+  translationKey as shellTranslationKey,
+} from '@dxos/shell/react';
+import { hexToEmoji } from '@dxos/util';
+
+import { meta } from '#meta';
+import { SpaceOperation } from '#operations';
+
+// TODO(wittjosiah): Copied from Shell.
+const activeActionKey = 'dxos:react-shell/space-manager/active-action';
+
+const handleInvitationEvent = (invitation: Invitation, subscription: ZenObservable.Subscription) => {
+  const invitationCode = InvitationEncoder.encode(invitation);
+  if (invitation.state === Invitation.State.CONNECTING) {
+    log.info(JSON.stringify({ invitationCode, authCode: invitation.authCode }));
+    subscription.unsubscribe();
+  }
+};
+
+export type MembersContainerProps = AppSurface.SpaceArticleProps<{
+  createInvitationUrl: (invitationCode: string) => string;
+}>;
+
+export const MembersContainer = ({ space, createInvitationUrl }: MembersContainerProps) => {
+  const { t } = useTranslation(meta.id);
+  const config = useConfig();
+  const { invokePromise } = useOperationInvoker();
+  const invitations = useSpaceInvitations(space.key);
+  const visibleInvitations = invitations?.filter(
+    (invitation) => ![Invitation.State.CANCELLED].includes(invitation.get().state),
+  );
+
+  const [activeAction, setInternalActiveAction] = useState(localStorage.getItem(activeActionKey) ?? 'inviteMany');
+
+  const setActiveAction = (nextAction: string) => {
+    setInternalActiveAction(nextAction);
+    localStorage.setItem(activeActionKey, nextAction);
+  };
+
+  // TODO(wittjosiah): Track which was the most recently viewed object.
+  const target = space.properties[Collection.Collection.typename]?.target?.objects[0]?.target;
+
+  const inviteActions = useMemo(
+    (): Record<string, ActionMenuItem> => ({
+      inviteOne: {
+        label: t('invite-one.label', { ns: shellTranslationKey }),
+        description: t('invite-one.description', { ns: shellTranslationKey }),
+        icon: 'ph--user-plus--regular',
+        testId: 'membersContainer.inviteOne',
+        onClick: async () => {
+          const { data: invitation } = await invokePromise(SpaceOperation.Share, {
+            space,
+            type: Invitation.Type.INTERACTIVE,
+            authMethod: Invitation.AuthMethod.SHARED_SECRET,
+            multiUse: false,
+            target: target && Obj.getDXN(target).toString(),
+          });
+          if (invitation && config.values.runtime?.app?.env?.DX_ENVIRONMENT !== 'production') {
+            const subscription: ZenObservable.Subscription = (invitation as CancellableInvitationObservable).subscribe(
+              (invitation: Invitation) => handleInvitationEvent(invitation, subscription),
+            );
+          }
+        },
+      },
+      inviteMany: {
+        label: t('invite-many.label', { ns: shellTranslationKey }),
+        description: t('invite-many.description', { ns: shellTranslationKey }),
+        icon: 'ph--users-three--regular',
+        testId: 'membersContainer.inviteMany',
+        onClick: async () => {
+          const { data: invitation } = await invokePromise(SpaceOperation.Share, {
+            space,
+            type: Invitation.Type.DELEGATED,
+            authMethod: Invitation.AuthMethod.KNOWN_PUBLIC_KEY,
+            multiUse: true,
+            target: target && Obj.getDXN(target).toString(),
+          });
+          if (invitation && config.values.runtime?.app?.env?.DX_ENVIRONMENT !== 'production') {
+            const subscription: ZenObservable.Subscription = (invitation as CancellableInvitationObservable).subscribe(
+              (invitation: Invitation) => handleInvitationEvent(invitation, subscription),
+            );
+          }
+        },
+      },
+    }),
+    [t, space, target, invokePromise],
+  );
+
+  const [selectedInvitation, setSelectedInvitation] = useState<CancellableInvitationObservable | null>(null);
+  const handleSend = (event: { type: 'selectInvitation'; invitation: CancellableInvitationObservable }) => {
+    setSelectedInvitation(event.invitation);
+  };
+  const handleBack = () => {
+    setSelectedInvitation(null);
+  };
+
+  return (
+    <Clipboard.Provider>
+      <Settings.Viewport>
+        <Settings.Section title={t('members-verbose.label')} description={t('members.description')}>
+          <Settings.Panel>
+            <div role='group' className='min-w-0'>
+              <h3 className='text-lg mb-2'>{t('members.label')}</h3>
+              <SpaceMemberList spaceKey={space.key} includeSelf />
+            </div>
+            <div role='group' className='min-w-0'>
+              <h3 className='text-lg mb-2'>{t('invitations.label')}</h3>
+              {selectedInvitation && <InvitationSection {...selectedInvitation} onBack={handleBack} />}
+              {!selectedInvitation && (
+                <>
+                  <p className='text-description mb-2'>{t('space-invitation.description')}</p>
+                  <InvitationList
+                    className='mb-2'
+                    send={handleSend}
+                    invitations={visibleInvitations ?? []}
+                    onClickRemove={(invitation) => invitation.cancel()}
+                    createInvitationUrl={createInvitationUrl}
+                  />
+                  <BifurcatedAction
+                    actions={inviteActions}
+                    activeAction={activeAction}
+                    onChangeActiveAction={setActiveAction as Dispatch<SetStateAction<string>>}
+                    data-testid='membersContainer.createInvitation'
+                  />
+                </>
+              )}
+            </div>
+          </Settings.Panel>
+        </Settings.Section>
+      </Settings.Viewport>
+    </Clipboard.Provider>
+  );
+};
+
+// TODO(wittjosiah): Reconcile the below components with DevicesContainer in @dxos/plugin-client.
+
+type InvitationComponentProps = Partial<
+  Pick<Invitation, 'authCode' | 'invitationId'> & {
+    state: Invitation.State;
+    url: string;
+    onBack: () => void;
+  }
+>;
+
+const InvitationSection = ({
+  state = Invitation.State.INIT,
+  authCode,
+  invitationId = 'never',
+  url = 'never',
+  onBack,
+}: InvitationComponentProps) => {
+  const activeView =
+    state < 0
+      ? 'init'
+      : state >= Invitation.State.CANCELLED
+        ? 'complete'
+        : state >= Invitation.State.READY_FOR_AUTHENTICATION && authCode
+          ? 'auth-code'
+          : 'qr-code';
+  return (
+    <Viewport.Root activeView={activeView}>
+      <Viewport.Views>
+        <Viewport.View id='init'>
+          {/* This view intentionally left blank while conditionally rendering the viewport. */}
+        </Viewport.View>
+        <Viewport.View id='complete'>
+          <InvitationComplete statusValue={state} />
+        </Viewport.View>
+        <Viewport.View id='auth-code'>
+          <InvitationAuthCode id={invitationId} code={authCode ?? 'never'} onCancel={onBack} />
+        </Viewport.View>
+        <Viewport.View id='qr-code'>
+          <InvitationQR id={invitationId} url={url} onCancel={onBack} />
+        </Viewport.View>
+      </Viewport.Views>
+    </Viewport.Root>
+  );
+};
+
+const InvitationQR = ({ id, url, onCancel }: { id: string; url: string; onCancel?: () => void }) => {
+  const { t } = useTranslation(shellTranslationKey);
+  const qrLabel = useId('members-container__qr-code');
+  const emoji = hexToEmoji(id);
+  return (
+    <>
+      <p className='text-description'>{t('qr-code.description', { ns: meta.id })}</p>
+      <div role='group' className='grid grid-cols-[1fr_min-content] my-2 gap-2'>
+        <div role='none' className='w-full aspect-square relative text-description'>
+          <QR
+            rounding={100}
+            backgroundColor='transparent'
+            color='currentColor'
+            aria-labelledby={qrLabel}
+            errorCorrectionLevel='Q'
+            cutout={true}
+          >
+            {url ?? 'never'}
+          </QR>
+          <Centered>
+            <Emoji text={emoji} />
+          </Centered>
+        </div>
+        <span id={qrLabel} className='sr-only'>
+          {t('qr.label')}
+        </span>
+        <Clipboard.Button value={url ?? 'never'} />
+      </div>
+      <Button variant='ghost' onClick={onCancel}>
+        {t('cancel.label')}
+      </Button>
+    </>
+  );
+};
+
+const InvitationAuthCode = ({ id, code, onCancel }: { id: string; code: string; onCancel?: () => void }) => {
+  const { t } = useTranslation(shellTranslationKey);
+  const emoji = hexToEmoji(id);
+
+  return (
+    <>
+      <p className='text-description'>{t('auth-other-device-emoji.message')}</p>
+      {emoji && <Emoji text={emoji} className='mx-auto my-2 text-center' />}
+      <p className='text-description'>{t('auth-code.message')}</p>
+      <AuthCode code={code} large classNames='mx-auto my-2 text-center grow' />
+      <Button variant='ghost' onClick={onCancel}>
+        {t('cancel.label')}
+      </Button>
+    </>
+  );
+};
+
+const InvitationComplete = ({ statusValue }: { statusValue: number }) => {
+  return statusValue > 0 ? (
+    <Icon icon='ph--check--regular' size={6} classNames='m-1.5' />
+  ) : (
+    <Icon icon='ph--x--regular' size={6} classNames='m-1.5' />
+  );
+};

package/src/containers/MembersContainer/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export { MembersContainer as default } from './MembersContainer';

package/src/containers/MenuFooter/MenuFooter.tsx

@@ -0,0 +1,33 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React from 'react';
+
+import { isPersonalSpace } from '@dxos/app-toolkit';
+import { getSpace } from '@dxos/client/echo';
+import { type Obj } from '@dxos/echo';
+import { DropdownMenu, Icon, toLocalizedString, useTranslation } from '@dxos/react-ui';
+
+import { meta } from '#meta';
+
+import { getSpaceDisplayName } from '../../util';
+
+export const MenuFooter = ({ object }: { object: Obj.Unknown }) => {
+  const { t } = useTranslation(meta.id);
+  const space = getSpace(object);
+  const spaceName = space ? getSpaceDisplayName(space, { personal: isPersonalSpace(space) }) : '';
+  return space ? (
+    <>
+      <DropdownMenu.Separator />
+      <DropdownMenu.GroupLabel>{t('menu-footer.label')}</DropdownMenu.GroupLabel>
+      <dl className='ps-2 mb-2 text-xs grid grid-cols-[max-content_1fr] gap-2'>
+        <dt className='uppercase text-[.75em] tracking-wide font-medium mt-px self-start'>{t('location.label')}</dt>
+        <dd className='line-clamp-3'>
+          <Icon icon='ph--planet--regular' classNames='inline-block me-1' />
+          {toLocalizedString(spaceName, t)}
+        </dd>
+      </dl>
+    </>
+  ) : null;
+};

package/src/containers/MenuFooter/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export { MenuFooter as default } from './MenuFooter';

package/src/containers/ObjectCardStack/ObjectCardStack.tsx

@@ -0,0 +1,82 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { forwardRef, useState } from 'react';
+
+import { Obj } from '@dxos/echo';
+import { type View } from '@dxos/echo';
+import { Filter, useQuery, useSchema } from '@dxos/react-client/echo';
+import { Card, Message, Panel, ScrollArea, Toolbar, useTranslation } from '@dxos/react-ui';
+import { useSelected } from '@dxos/react-ui-attention';
+import { ObjectForm } from '@dxos/react-ui-form';
+import { Mosaic } from '@dxos/react-ui-mosaic';
+import { getTypenameFromQuery } from '@dxos/schema';
+import { isNonNullable } from '@dxos/util';
+
+import { meta } from '#meta';
+
+export type ObjectCardStackProps = {
+  view: View.View;
+  objectId: string;
+};
+
+/**
+ * @deprecated Use Mosaic Board components.
+ */
+export const ObjectCardStack = forwardRef<HTMLDivElement, ObjectCardStackProps>(({ objectId, view }, forwardedRef) => {
+  const { t } = useTranslation(meta.id);
+  const db = Obj.getDatabase(view);
+  const typename = view.query ? getTypenameFromQuery(view.query.ast) : undefined;
+  const schema = useSchema(db, typename);
+
+  const queriedObjects = useQuery(db, schema ? Filter.type(schema) : Filter.nothing());
+  const selectedRows = useSelected(objectId, 'multi');
+  const selectedObjects = selectedRows.map((id) => queriedObjects.find((obj) => obj.id === id)).filter(isNonNullable);
+
+  const [viewport, setViewport] = useState<HTMLElement | null>(null);
+
+  if (!schema) {
+    return null;
+  }
+
+  return (
+    <Panel.Root className='dx-document' ref={forwardedRef}>
+      <Panel.Toolbar asChild>
+        <Toolbar.Root />
+      </Panel.Toolbar>
+      <Panel.Content>
+        {selectedObjects.length === 0 ? (
+          <Message.Root>
+            <Message.Title>{t('row-details-no-selection.label')}</Message.Title>
+          </Message.Root>
+        ) : (
+          <Mosaic.Root>
+            <Mosaic.Container
+              asChild
+              orientation='vertical'
+              autoScroll={viewport}
+              eventHandler={{ id: objectId, canDrop: () => true }}
+            >
+              <ScrollArea.Root orientation='vertical'>
+                <ScrollArea.Viewport ref={setViewport}>
+                  <Mosaic.Stack
+                    items={selectedObjects}
+                    getId={(obj) => obj.id}
+                    Tile={({ ...props }) => (
+                      <Mosaic.Tile {...props}>
+                        <Card.Root>
+                          <ObjectForm object={props.data} schema={schema} />
+                        </Card.Root>
+                      </Mosaic.Tile>
+                    )}
+                  />
+                </ScrollArea.Viewport>
+              </ScrollArea.Root>
+            </Mosaic.Container>
+          </Mosaic.Root>
+        )}
+      </Panel.Content>
+    </Panel.Root>
+  );
+});

package/src/containers/ObjectCardStack/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export { ObjectCardStack as default } from './ObjectCardStack';

package/src/containers/ObjectProperties/ObjectProperties.tsx

@@ -0,0 +1,32 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { forwardRef, useMemo } from 'react';
+
+import { Surface } from '@dxos/app-framework/ui';
+import { AppSurface } from '@dxos/app-toolkit/ui';
+import { type Obj } from '@dxos/echo';
+import { Panel, Toolbar } from '@dxos/react-ui';
+import { ObjectProperties as NaturalObjectProperties } from '@dxos/react-ui-form';
+
+export type ObjectPropertiesProps = AppSurface.ObjectPropertiesProps<Obj.Unknown>;
+
+export const ObjectProperties = forwardRef<HTMLDivElement, ObjectPropertiesProps>(
+  ({ role, subject: object }, forwardedRef) => {
+    const data = useMemo<AppSurface.ObjectPropertiesData>(() => ({ subject: object }), [object]);
+
+    return (
+      <Panel.Root role={role} className='dx-document' ref={forwardedRef}>
+        <Panel.Toolbar asChild>
+          <Toolbar.Root />
+        </Panel.Toolbar>
+        <Panel.Content asChild>
+          <NaturalObjectProperties object={object}>
+            <Surface.Surface type={AppSurface.ObjectProperties} data={data} />
+          </NaturalObjectProperties>
+        </Panel.Content>
+      </Panel.Root>
+    );
+  },
+);

package/src/containers/ObjectProperties/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export { ObjectProperties as default } from './ObjectProperties';