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

package/src/containers/RecordArticle/RecordArticle.stories.tsx

@@ -0,0 +1,81 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Effect from 'effect/Effect';
+import React from 'react';
+
+import { Capability } from '@dxos/app-framework';
+import { withPluginManager } from '@dxos/app-framework/testing';
+import { AppCapabilities } from '@dxos/app-toolkit';
+import { ClientPlugin } from '@dxos/plugin-client';
+import { PreviewPlugin } from '@dxos/plugin-preview';
+import { StorybookPlugin, corePlugins } from '@dxos/plugin-testing';
+import { random } from '@dxos/random';
+import { Filter, useQuery, useSpaces } from '@dxos/react-client/echo';
+import { Loading, withLayout } from '@dxos/react-ui/testing';
+import { createObjectFactory } from '@dxos/schema/testing';
+import { Organization, Person } from '@dxos/types';
+
+import { translations } from '#translations';
+
+import { RecordArticle } from './RecordArticle';
+
+random.seed(0);
+
+const PERSON_COUNT = 100;
+
+const DefaultStory = () => {
+  const spaces = useSpaces();
+  const space = spaces[spaces.length - 1];
+  const organizations = useQuery(space?.db, Filter.type(Organization.Organization));
+  const org = organizations[0];
+  if (!org) {
+    return <Loading />;
+  }
+
+  return <RecordArticle role='article' subject={org} attendableId='story' />;
+};
+
+const meta = {
+  title: 'plugins/plugin-space/containers/RecordArticle',
+  render: DefaultStory,
+  decorators: [
+    withLayout({ layout: 'fullscreen' }),
+    withPluginManager({
+      capabilities: [Capability.contributes(AppCapabilities.Translations, translations)],
+      plugins: [
+        ...corePlugins(),
+        StorybookPlugin({}),
+        PreviewPlugin(),
+        ClientPlugin({
+          types: [Organization.Organization, Person.Person],
+          onClientInitialized: ({ client }) =>
+            Effect.gen(function* () {
+              yield* Effect.promise(() => client.halo.createIdentity());
+              const space = yield* Effect.promise(() => client.spaces.create());
+              yield* Effect.promise(() => space.waitUntilReady());
+
+              const factory = createObjectFactory(space.db, random as any);
+              yield* Effect.promise(() =>
+                factory([
+                  { type: Organization.Organization, count: 1 },
+                  { type: Person.Person, count: PERSON_COUNT },
+                ]),
+              );
+            }),
+        }),
+      ],
+    }),
+  ],
+  parameters: {
+    layout: 'fullscreen',
+  },
+} satisfies Meta;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};

package/src/containers/RecordArticle/RecordArticle.tsx

@@ -0,0 +1,56 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import * as Function from 'effect/Function';
+import * as Option from 'effect/Option';
+import React from 'react';
+
+import { Surface } from '@dxos/app-framework/ui';
+import { AppSurface } from '@dxos/app-toolkit/ui';
+import { Annotation, Obj } from '@dxos/echo';
+import { Card, Input, Panel, ScrollArea, Toolbar, useTranslation } from '@dxos/react-ui';
+
+import { meta } from '#meta';
+
+export const RecordArticle = ({ role, subject }: AppSurface.ObjectArticleProps) => {
+  const { t } = useTranslation(meta.id);
+  const icon = Function.pipe(
+    Obj.getSchema(subject),
+    Option.fromNullable,
+    Option.flatMap(Annotation.IconAnnotation.get),
+    Option.map(({ icon }) => icon),
+    Option.getOrElse(() => 'ph--placeholder--regular'),
+  );
+
+  return (
+    <Panel.Root role={role}>
+      <Panel.Toolbar asChild>
+        <Toolbar.Root />
+      </Panel.Toolbar>
+      <Panel.Content asChild>
+        <ScrollArea.Root orientation='vertical'>
+          <ScrollArea.Viewport classNames='p-4 space-y-4'>
+            <Card.Root classNames='dx-card-max-width'>
+              <Card.Toolbar>
+                <Card.Icon icon={icon} />
+                <Card.Title>{Obj.getLabel(subject)}</Card.Title>
+              </Card.Toolbar>
+              <Card.Content>
+                <Surface.Surface type={AppSurface.Card} data={{ subject }} limit={1} />
+              </Card.Content>
+            </Card.Root>
+
+            {/* TODO(burdon): Only show label if surface exists? */}
+            <div role='none' className='flex flex-col gap-form-gap'>
+              <Input.Root>
+                <Input.Label>{t('related-actions.label')}</Input.Label>
+              </Input.Root>
+              <Surface.Surface role='prompts' data={{ subject }} limit={1} />
+            </div>
+          </ScrollArea.Viewport>
+        </ScrollArea.Root>
+      </Panel.Content>
+    </Panel.Root>
+  );
+};

package/src/containers/RecordArticle/index.ts

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

package/src/containers/RelatedArticle/RelatedArticle.tsx

@@ -0,0 +1,82 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Function from 'effect/Function';
+import * as Option from 'effect/Option';
+import React, { useMemo } from 'react';
+
+import { Surface } from '@dxos/app-framework/ui';
+import { AppSurface, useObjectMenuItems } from '@dxos/app-toolkit/ui';
+import { Annotation, Entity, Obj } from '@dxos/echo';
+import { Card, Panel, Toolbar, useTranslation } from '@dxos/react-ui';
+import { Masonry } from '@dxos/react-ui-masonry';
+import { Menu } from '@dxos/react-ui-menu';
+
+import { useRelatedObjects } from '#hooks';
+import { meta } from '#meta';
+
+// TODO(burdon): Companion type.
+export type RelatedArticleProps = Pick<
+  AppSurface.ObjectArticleProps<Obj.Unknown, {}, Obj.Unknown>,
+  'role' | 'companionTo'
+>;
+
+export const RelatedArticle = ({ role, companionTo }: RelatedArticleProps) => {
+  const db = Obj.getDatabase(companionTo);
+  const items = useRelatedObjects(db, companionTo, { references: true, relations: true });
+
+  return (
+    <Masonry.Root Tile={ObjectCard}>
+      <Panel.Root role={role}>
+        <Panel.Toolbar asChild>
+          <Toolbar.Root />
+        </Panel.Toolbar>
+        <Panel.Content asChild>
+          <Masonry.Content classNames='p-2' centered>
+            <Masonry.Viewport items={items} />
+          </Masonry.Content>
+        </Panel.Content>
+      </Panel.Root>
+    </Masonry.Root>
+  );
+};
+
+/** Masonry tile renderer for a related entity. */
+const ObjectCard = ({ data: subject, classNames }: { data: Entity.Unknown; classNames?: string }) => {
+  const { t } = useTranslation(meta.id);
+  const data = useMemo(() => ({ subject }), [subject]);
+  const icon = Function.pipe(
+    Entity.getSchema(subject),
+    Option.fromNullable,
+    Option.flatMap(Annotation.IconAnnotation.get),
+    Option.map(({ icon }) => icon),
+    Option.getOrElse(() => 'ph--placeholder--regular'),
+  );
+
+  // TODO(burdon): BUG: Includes item itself.
+  const menuItems = useObjectMenuItems(subject);
+
+  return (
+    <Menu.Root>
+      <Card.Root classNames={classNames}>
+        <Card.Toolbar>
+          <Card.Icon icon={icon} />
+          <Card.Title>{Entity.getLabel(subject)}</Card.Title>
+          <Menu.Trigger asChild disabled={!menuItems?.length}>
+            <Toolbar.IconButton
+              iconOnly
+              variant='ghost'
+              icon='ph--dots-three-vertical--regular'
+              label={t('more-actions.label')}
+            />
+          </Menu.Trigger>
+          <Menu.Content items={menuItems} />
+        </Card.Toolbar>
+        <Card.Content>
+          <Surface.Surface type={AppSurface.Card} data={data} limit={1} />
+        </Card.Content>
+      </Card.Root>
+    </Menu.Root>
+  );
+};

package/src/containers/RelatedArticle/index.ts

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

package/src/containers/SchemaContainer/SchemaContainer.tsx

@@ -0,0 +1,59 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { useEffect, useState } from 'react';
+
+import { AppSurface } from '@dxos/app-toolkit/ui';
+import { type Type } from '@dxos/echo';
+import { type Space } from '@dxos/react-client/echo';
+import { useTranslation } from '@dxos/react-ui';
+import { Settings } from '@dxos/react-ui-form';
+import { mx } from '@dxos/ui-theme';
+
+import { meta } from '#meta';
+
+export const SchemaContainer = ({ space }: AppSurface.SpaceArticleProps) => {
+  const { t } = useTranslation(meta.id);
+  const schemas = useQuerySpaceSchemas(space);
+
+  return (
+    <Settings.Viewport>
+      <Settings.Section title={t('schema-verbose.label')} description={t('schema.description')}>
+        <div
+          role='none'
+          className={mx([
+            'grid md:col-span-2 grid-cols-subgrid gap-trim-sm items-center',
+            '*:first:mt-0! *:last:mb-0! px-trim-md py-trim-md',
+            'border border-separator rounded-md',
+          ])}
+        >
+          {schemas.length === 0 && <div className='text-center py-4'>{t('no-schemas-found.message')}</div>}
+          {schemas.map((schema) => (
+            <div role='none' key={schema.id}>
+              {schema.typename}
+            </div>
+          ))}
+        </div>
+      </Settings.Section>
+    </Settings.Viewport>
+  );
+};
+
+/**
+ * Subscribe to and retrieve all schemas from a space's schema registry.
+ */
+export const useQuerySpaceSchemas = (space: Space): Type.RuntimeType[] => {
+  const [schemas, setSchemas] = useState<Type.RuntimeType[]>([]);
+
+  useEffect(() => {
+    const query = space.db.schemaRegistry.query();
+    const initialResults = query.runSync();
+    setSchemas(initialResults);
+
+    const unsubscribe = query.subscribe(() => setSchemas(query.results));
+    return () => unsubscribe();
+  }, [space]);
+
+  return schemas;
+};

package/src/containers/SchemaContainer/index.ts

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

package/src/containers/SmallPresenceLive/index.ts

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

package/src/containers/SpacePresence/SpacePresence.stories.tsx

@@ -0,0 +1,108 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Meta } from '@storybook/react-vite';
+import React from 'react';
+
+import { IdentityDid, PublicKey } from '@dxos/keys';
+import { HaloSpaceMember, SpaceMember } from '@dxos/react-client/echo';
+import { withTheme } from '@dxos/react-ui/testing';
+
+import { translations } from '#translations';
+
+import { FullPresence, type Member, type MemberPresenceProps, SmallPresence } from './SpacePresence';
+
+const viewers = (n: number, currentlyAttended = true): Member[] =>
+  Array.from({ length: n }, () => ({
+    role: HaloSpaceMember.Role.ADMIN,
+    identity: { did: IdentityDid.random(), identityKey: PublicKey.random() },
+    presence: SpaceMember.PresenceState.ONLINE,
+    lastSeen: Date.now(),
+    currentlyAttended,
+  }));
+
+const meta = {
+  title: 'plugins/plugin-space/containers/SpacePresence',
+  decorators: [withTheme()],
+  parameters: {
+    translations,
+  },
+} satisfies Meta<typeof IdentityDid>;
+
+export default meta;
+
+export const Full = (props: MemberPresenceProps) => {
+  const p: MemberPresenceProps = {
+    ...props,
+  };
+
+  return (
+    <div className='p-4'>
+      <div className='p-3'>
+        <FullPresence members={viewers(1)} {...p} />
+      </div>
+      <div className='p-3'>
+        <FullPresence members={viewers(2)} {...p} />
+      </div>
+      <div className='p-3'>
+        <FullPresence members={viewers(3)} {...p} />
+      </div>
+      <div className='p-3'>
+        <FullPresence members={viewers(3, false)} {...p} />
+      </div>
+      <div className='p-3'>
+        <FullPresence members={viewers(4)} {...p} />
+      </div>
+      <div className='p-3'>
+        <FullPresence members={viewers(5)} {...p} />
+      </div>
+      <div className='p-3'>
+        <FullPresence members={viewers(5, false)} {...p} />
+      </div>
+      <div className='p-3'>
+        <FullPresence members={viewers(10)} {...p} />
+      </div>
+      <div className='p-3'>
+        <FullPresence members={viewers(100)} {...p} />
+      </div>
+    </div>
+  );
+};
+
+export const Small = () => {
+  return (
+    <div className='p-4'>
+      <div className='flex gap-3 p-3'>
+        <SmallPresence count={0} />
+        <SmallPresence count={0} attended />
+        <SmallPresence count={0} containsAttended />
+      </div>
+      <div className='flex gap-3 p-3'>
+        <SmallPresence count={1} />
+        <SmallPresence count={1} attended />
+        <SmallPresence count={1} containsAttended />
+      </div>
+      <div className='flex gap-3 p-3'>
+        <SmallPresence count={2} />
+        <SmallPresence count={2} attended />
+        <SmallPresence count={2} containsAttended />
+      </div>
+      <div className='flex gap-3 p-3'>
+        <SmallPresence count={3} />
+        <SmallPresence count={3} attended />
+        <SmallPresence count={3} containsAttended />
+      </div>
+      <div className='flex gap-3 p-3'>
+        <SmallPresence count={4} />
+        <SmallPresence count={4} attended />
+        <SmallPresence count={4} containsAttended />
+      </div>
+      <div className='flex gap-3 p-3'>
+        <SmallPresence count={5} />
+        <SmallPresence count={5} attended />
+        <SmallPresence count={5} containsAttended />
+      </div>
+    </div>
+  );
+};

package/src/containers/SpacePresence/SpacePresence.tsx

@@ -0,0 +1,261 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React, { forwardRef, useCallback, useEffect, useState } from 'react';
+
+import { useAtomCapability } from '@dxos/app-framework/ui';
+import { generateName } from '@dxos/display-name';
+import { type Key, Obj } from '@dxos/echo';
+import { PublicKey } from '@dxos/react-client';
+import { type SpaceMember, useMembers, useSpace } from '@dxos/react-client/echo';
+import { type Identity, useIdentity } from '@dxos/react-client/halo';
+import {
+  Avatar,
+  type AvatarContentProps,
+  type DxAvatar,
+  List,
+  ListItem,
+  Popover,
+  type Size,
+  type ThemedClassName,
+  Tooltip,
+  useDefaultValue,
+  useTranslation,
+} from '@dxos/react-ui';
+import { AttentionGlyph, type AttentionGlyphProps, useAttention } from '@dxos/react-ui-attention';
+import { ComplexMap, keyToFallback } from '@dxos/util';
+
+import { meta } from '#meta';
+import { type ObjectViewerProps, SpaceCapabilities } from '#types';
+
+// TODO(thure): Get/derive these values from protocol
+const REFRESH_INTERVAL = 5000;
+const ACTIVITY_DURATION = 30_000;
+
+// TODO(thure): This is chiefly meant to satisfy TS & provide an empty map after `deepSignal` interactions.
+const noViewers = new ComplexMap<PublicKey, ObjectViewerProps>(PublicKey.hash);
+
+// TODO(wittjosiah): Factor out?
+const getName = (identity: Identity) => identity.profile?.displayName ?? generateName(identity.identityKey.toHex());
+
+export type SpacePresenceProps = {
+  object: Obj.Unknown;
+  spaceId?: Key.SpaceId;
+};
+
+export const SpacePresence = ({ object, spaceId }: SpacePresenceProps) => {
+  const ephemeral = useAtomCapability(SpaceCapabilities.EphemeralState);
+  const identity = useIdentity();
+  const db = Obj.getDatabase(object);
+  const space = useSpace(spaceId ?? db?.spaceId);
+  const spaceMembers = useMembers(spaceId ?? db?.spaceId);
+
+  const [_moment, setMoment] = useState(Date.now());
+
+  // NOTE(thure): This is necessary so Presence updates without any underlying data updating.
+  useEffect(() => {
+    const interval = setInterval(() => setMoment(Date.now()), REFRESH_INTERVAL);
+    return () => clearInterval(interval);
+  }, []);
+
+  const memberOnline = useCallback((member: SpaceMember) => member.presence === 1, []);
+  const memberIsNotSelf = useCallback(
+    (member: SpaceMember) => !identity?.identityKey.equals(member.identity.identityKey),
+    [identity?.identityKey],
+  );
+
+  // TODO(thure): Could it be a smell to return early when there are interactions with `deepSignal` later, since it
+  //  prevents reactivity?
+  if (!identity || !ephemeral || !space) {
+    return null;
+  }
+
+  const currentObjectViewers = ephemeral.viewersByObject[Obj.getDXN(object).toString()] ?? noViewers;
+
+  const membersForObject = spaceMembers
+    .filter((member) => memberOnline(member) && memberIsNotSelf(member))
+    .filter((member) => currentObjectViewers.has(member.identity.identityKey))
+    .map((member) => {
+      const objectView = currentObjectViewers.get(member.identity.identityKey);
+      const lastSeen = objectView?.lastSeen ?? -Infinity;
+      const currentlyAttended = objectView?.currentlyAttended ?? false;
+
+      return {
+        ...member,
+        currentlyAttended,
+        lastSeen,
+      };
+    })
+    .toSorted((a, b) => a.lastSeen - b.lastSeen);
+
+  return <FullPresence members={membersForObject} />;
+};
+
+export type Member = SpaceMember & {
+  /**
+   * Last time a member was seen on this object.
+   */
+  lastSeen: number;
+  currentlyAttended: boolean;
+};
+
+export type MemberPresenceProps = ThemedClassName<{
+  size?: Size;
+  members?: Member[];
+  showCount?: boolean;
+  onMemberClick?: (member: Member) => void;
+}>;
+
+export const FullPresence = (props: MemberPresenceProps) => {
+  const { size = 9, onMemberClick } = props;
+  const members = useDefaultValue(props.members, () => []);
+
+  if (members.length === 0) {
+    return null;
+  }
+
+  return (
+    <div className='dx-avatar-group' data-testid='spacePlugin.presence'>
+      {members.slice(0, 3).map((member, i) => (
+        <Tooltip.Trigger
+          key={member.identity.identityKey.toHex()}
+          side='bottom'
+          content={getName(member.identity)}
+          className='grid focus:outline-hidden'
+        >
+          <PresenceAvatar
+            identity={member.identity}
+            match={member.currentlyAttended} // TODO(Zan): Match always true now we're showing 'members viewing current object'.
+            index={members.length - i}
+            onClick={() => onMemberClick?.(member)}
+            size={size}
+          />
+        </Tooltip.Trigger>
+      ))}
+
+      {members.length > 3 && (
+        <Popover.Root>
+          <Popover.Trigger className='grid focus:outline-hidden'>
+            <Avatar.Root>
+              {/* TODO(wittjosiah): Make text fit. */}
+              <Avatar.Content
+                status='inactive'
+                style={{ zIndex: members.length - 4 }}
+                fallback={`+${members.length - 3}`}
+                size={size}
+              />
+            </Avatar.Root>
+          </Popover.Trigger>
+          <Popover.Portal>
+            <Popover.Content side='bottom'>
+              <Popover.Arrow />
+              <Popover.Viewport classNames='max-h-56'>
+                <List>
+                  {members.map((member) => (
+                    <ListItem.Root
+                      key={member.identity.identityKey.toHex()}
+                      classNames='flex gap-2 items-center cursor-pointer mb-2'
+                      onClick={() => onMemberClick?.(member)}
+                      data-testid='identity-list-item'
+                    >
+                      {/* TODO(Zan): Match always true now we're showing 'members viewing current object'. */}
+                      <PresenceAvatar
+                        identity={member.identity}
+                        size={size}
+                        showName
+                        match={member.currentlyAttended}
+                      />
+                    </ListItem.Root>
+                  ))}
+                </List>
+              </Popover.Viewport>
+            </Popover.Content>
+          </Popover.Portal>
+        </Popover.Root>
+      )}
+    </div>
+  );
+};
+
+type PresenceAvatarProps = Pick<AvatarContentProps, 'size'> & {
+  identity: Identity;
+  showName?: boolean;
+  match?: boolean;
+  index?: number;
+  onClick?: () => void;
+};
+
+const PresenceAvatar = forwardRef<DxAvatar, PresenceAvatarProps>(
+  ({ identity, showName, match, index, onClick, size }, forwardedRef) => {
+    const status = match ? 'current' : 'active';
+    const fallbackValue = keyToFallback(identity.identityKey);
+    return (
+      <Avatar.Root>
+        <Avatar.Content
+          status={status}
+          hue={identity.profile?.data?.hue || fallbackValue.hue}
+          data-testid='spacePlugin.presence.member'
+          data-status={status}
+          size={size}
+          {...(index ? { style: { zIndex: index } } : {})}
+          onClick={onClick}
+          fallback={identity.profile?.data?.emoji || fallbackValue.emoji}
+          ref={forwardedRef}
+        />
+        <Avatar.Label classNames={showName ? 'text-sm truncate px-2' : 'sr-only'}>{getName(identity)}</Avatar.Label>
+      </Avatar.Root>
+    );
+  },
+);
+
+export type SmallPresenceLiveProps = {
+  id?: string;
+  open?: boolean;
+  viewers?: ComplexMap<PublicKey, ObjectViewerProps>;
+};
+
+export const SmallPresenceLive = ({ id, open, viewers }: SmallPresenceLiveProps) => {
+  const { hasAttention, isAncestor, isRelated } = useAttention(id);
+  const attended = hasAttention || isRelated;
+  const containsAttended = isAncestor && !open;
+  const getActiveViewers = (viewers: ComplexMap<PublicKey, ObjectViewerProps>): ObjectViewerProps[] => {
+    const moment = Date.now();
+    return Array.from<ObjectViewerProps>(viewers.values()).filter(
+      (viewer) => moment - viewer.lastSeen < ACTIVITY_DURATION,
+    );
+  };
+
+  const [activeViewers, setActiveViewers] = useState(viewers ? getActiveViewers(viewers) : []);
+
+  useEffect(() => {
+    if (viewers) {
+      setActiveViewers(getActiveViewers(viewers));
+      const interval = setInterval(() => {
+        setActiveViewers(getActiveViewers(viewers));
+      }, REFRESH_INTERVAL);
+      return () => clearInterval(interval);
+    }
+  }, [viewers]);
+
+  return <SmallPresence count={activeViewers.length} attended={attended} containsAttended={containsAttended} />;
+};
+
+export type SmallPresenceProps = {
+  count?: number;
+} & Pick<AttentionGlyphProps, 'attended' | 'containsAttended'>;
+
+export const SmallPresence = ({ count = 0, attended, containsAttended }: SmallPresenceProps) => {
+  const { t } = useTranslation(meta.id);
+
+  return (
+    <Tooltip.Trigger asChild content={t('presence.label', { count })} side='bottom'>
+      <AttentionGlyph
+        attended={attended}
+        containsAttended={containsAttended}
+        presence={count > 1 ? 'many' : count === 1 ? 'one' : 'none'}
+        classNames='self-center mx-1'
+      />
+    </Tooltip.Trigger>
+  );
+};

package/src/containers/SpacePresence/index.ts

@@ -0,0 +1,6 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export { SpacePresence, SmallPresenceLive } from './SpacePresence';
+export { SpacePresence as default } from './SpacePresence';