@dxos/plugin-space 0.8.4-main.4a85c3132b → 0.8.4-main.51f1e5ca51

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

@@ -2,123 +2,55 @@
 // Copyright 2023 DXOS.org
 //
 
-import React, { useMemo } from 'react';
+import * as Function from 'effect/Function';
+import * as Option from 'effect/Option';
+import React from 'react';
 
 import { Surface } from '@dxos/app-framework/ui';
-import { type SurfaceComponentProps } from '@dxos/app-toolkit/ui';
-import { type Database, Entity, Filter, Obj, Ref, Relation } from '@dxos/echo';
-import { useQuery } from '@dxos/react-client/echo';
-import { Panel, ScrollArea, useTranslation } from '@dxos/react-ui';
-import { Card as MosaicCard } from '@dxos/react-ui';
-import { Masonry } from '@dxos/react-ui-masonry';
-import { mx } from '@dxos/ui-theme';
-import { isNonNullable } from '@dxos/util';
+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';
+import { meta } from '#meta';
 
-export const RecordArticle = ({ role, subject }: SurfaceComponentProps) => {
+export const RecordArticle = ({ role, subject }: AppSurface.ObjectArticleProps) => {
   const { t } = useTranslation(meta.id);
-  const db = Obj.getDatabase(subject);
-  const data = useMemo(() => ({ subject }), [subject]);
-  const related = useRelatedObjects(db, subject, {
-    references: true,
-    relations: true,
-  });
-  const singleColumn = related.length === 1;
+  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} className='dx-article'>
+    <Panel.Root role={role}>
+      <Panel.Toolbar asChild>
+        <Toolbar.Root />
+      </Panel.Toolbar>
       <Panel.Content asChild>
         <ScrollArea.Root orientation='vertical'>
-          <ScrollArea.Viewport classNames='p-4 gap-4'>
-            <div role='none' className='flex w-full dx-card-max-width'>
-              <Surface.Surface role='section' data={data} limit={1} />
+          <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>
-
-            {related.length > 0 && (
-              <div role='none' className={mx('flex flex-col gap-1', singleColumn ? 'dx-card-max-width' : 'w-full')}>
-                <label className='mt-2 text-sm text-description'>{t('related objects label')}</label>
-                <Masonry.Root<Entity.Unknown>
-                  items={related}
-                  render={Card}
-                  columnCount={singleColumn ? 1 : undefined}
-                  intrinsicHeight
-                />
-              </div>
-            )}
           </ScrollArea.Viewport>
         </ScrollArea.Root>
       </Panel.Content>
     </Panel.Root>
   );
 };
-
-const Card = ({ data: subject }: { data: Entity.Unknown }) => {
-  const data = useMemo(() => ({ subject }), [subject]);
-  return (
-    <MosaicCard.Root>
-      <MosaicCard.Toolbar>
-        <span />
-        <MosaicCard.Title>{Entity.getLabel(subject)}</MosaicCard.Title>
-      </MosaicCard.Toolbar>
-      <Surface.Surface role='card--content' data={data} limit={1} />
-    </MosaicCard.Root>
-  );
-};
-
-// TODO(wittjosiah): This is a hack. ECHO needs to have a back reference index to easily query for related objects.
-const useRelatedObjects = (
-  db?: Database.Database,
-  record?: Obj.Unknown,
-  options: { references?: boolean; relations?: boolean } = {},
-) => {
-  const objects = useQuery(db, Filter.everything());
-  return useMemo(() => {
-    if (!record) {
-      return [];
-    }
-
-    const related: Entity.Unknown[] = [];
-
-    // TODO(burdon): Change Person => Organization to relations.
-    if (options.references) {
-      const getReferences = (obj: Entity.Unknown): Ref.Unknown[] => {
-        return Object.getOwnPropertyNames(obj)
-          .map((name) => obj[name as keyof Obj.Unknown])
-          .filter((value) => Ref.isRef(value)) as Ref.Unknown[];
-      };
-
-      const references = getReferences(record);
-      const referenceTargets = references.map((ref) => ref.target).filter(isNonNullable);
-      const referenceSources = objects.filter((obj) => {
-        const refs = getReferences(obj);
-        return refs.some((ref) => ref.target === record);
-      });
-
-      related.push(...referenceTargets, ...referenceSources);
-    }
-
-    if (options.relations) {
-      // TODO(dmaretskyi): Workaround until https://github.com/dxos/dxos/pull/10100 lands.
-      const isValidRelation = (obj: Relation.Unknown) => {
-        try {
-          return Relation.isRelation(obj) && Relation.getSource(obj) && Relation.getTarget(obj);
-        } catch {
-          return false;
-        }
-      };
-
-      const relations = objects.filter(Relation.isRelation).filter((obj) => isValidRelation(obj));
-      const targetObjects = relations
-        .filter((relation) => Relation.getTarget(relation) === record)
-        .map((relation) => Relation.getSource(relation));
-      const sourceObjects = relations
-        .filter((relation) => Relation.getSource(relation) === record)
-        .map((relation) => Relation.getTarget(relation));
-
-      related.push(...targetObjects, ...sourceObjects);
-    }
-
-    return related;
-  }, [record, objects]);
-};

package/src/containers/RecordArticle/index.ts

@@ -2,6 +2,4 @@
 // Copyright 2023 DXOS.org
 //
 
-import { RecordArticle } from './RecordArticle';
-
-export default RecordArticle;
+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

@@ -4,23 +4,22 @@
 
 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';
+import { meta } from '#meta';
 
-type SchemaPanelProps = { space: Space };
-
-export const SchemaContainer = ({ space }: SchemaPanelProps) => {
+export const SchemaContainer = ({ space }: AppSurface.SpaceArticleProps) => {
   const { t } = useTranslation(meta.id);
   const schemas = useQuerySpaceSchemas(space);
 
   return (
-    <Settings.Root>
-      <Settings.Section title={t('schema verbose label')} description={t('schema description')}>
+    <Settings.Viewport>
+      <Settings.Section title={t('schema-verbose.label')} description={t('schema.description')}>
         <div
           role='none'
           className={mx([
@@ -29,7 +28,7 @@ export const SchemaContainer = ({ space }: SchemaPanelProps) => {
             'border border-separator rounded-md',
           ])}
         >
-          {schemas.length === 0 && <div className='text-center py-4'>{t('no schemas found message')}</div>}
+          {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}
@@ -37,7 +36,7 @@ export const SchemaContainer = ({ space }: SchemaPanelProps) => {
           ))}
         </div>
       </Settings.Section>
-    </Settings.Root>
+    </Settings.Viewport>
   );
 };
 

package/src/containers/SchemaContainer/index.ts

@@ -2,6 +2,4 @@
 // Copyright 2025 DXOS.org
 //
 
-import { SchemaContainer } from './SchemaContainer';
-
-export default SchemaContainer;
+export { SchemaContainer as default } from './SchemaContainer';

package/src/containers/SmallPresenceLive/index.ts

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

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

@@ -9,7 +9,7 @@ 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 { translations } from '#translations';
 
 import { FullPresence, type Member, type MemberPresenceProps, SmallPresence } from './SpacePresence';
 

package/src/containers/SpacePresence/SpacePresence.tsx

@@ -2,11 +2,9 @@
 // Copyright 2023 DXOS.org
 //
 
-import * as Option from 'effect/Option';
 import React, { forwardRef, useCallback, useEffect, useState } from 'react';
 
 import { useAtomCapability } from '@dxos/app-framework/ui';
-import { useAppGraph } from '@dxos/app-toolkit/ui';
 import { generateName } from '@dxos/display-name';
 import { type Key, Obj } from '@dxos/echo';
 import { PublicKey } from '@dxos/react-client';
@@ -25,12 +23,11 @@ import {
   useDefaultValue,
   useTranslation,
 } from '@dxos/react-ui';
-import { AttentionGlyph, type AttentionGlyphProps, useAttended, useAttention } from '@dxos/react-ui-attention';
+import { AttentionGlyph, type AttentionGlyphProps, useAttention } from '@dxos/react-ui-attention';
 import { ComplexMap, keyToFallback } from '@dxos/util';
 
-import { usePath } from '../../hooks';
-import { meta } from '../../meta';
-import { type ObjectViewerProps, SpaceCapabilities } from '../../types';
+import { meta } from '#meta';
+import { type ObjectViewerProps, SpaceCapabilities } from '#types';
 
 // TODO(thure): Get/derive these values from protocol
 const REFRESH_INTERVAL = 5000;
@@ -220,17 +217,8 @@ export type SmallPresenceLiveProps = {
 
 export const SmallPresenceLive = ({ id, open, viewers }: SmallPresenceLiveProps) => {
   const { hasAttention, isAncestor, isRelated } = useAttention(id);
-  const isAttended = hasAttention || isAncestor || isRelated;
-
-  // TODO(wittjosiah): If the attended node is deep in the graph and the graph is not fully loaded
-  //   this will result in an empty path until the graph is connected.
-  // TODO(wittjosiah): Consider using this indicator for all open nodes instead of just attended.
-  const { graph } = useAppGraph();
-  const attended = useAttended();
-  const startOfAttention = attended.at(-1);
-  const path = usePath(graph, startOfAttention);
-  const containsAttended = !open && !isAttended && id && Option.isSome(path) ? path.value.includes(id) : false;
-
+  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(
@@ -250,7 +238,7 @@ export const SmallPresenceLive = ({ id, open, viewers }: SmallPresenceLiveProps)
     }
   }, [viewers]);
 
-  return <SmallPresence count={activeViewers.length} attended={isAttended} containsAttended={containsAttended} />;
+  return <SmallPresence count={activeViewers.length} attended={attended} containsAttended={containsAttended} />;
 };
 
 export type SmallPresenceProps = {
@@ -261,7 +249,7 @@ export const SmallPresence = ({ count = 0, attended, containsAttended }: SmallPr
   const { t } = useTranslation(meta.id);
 
   return (
-    <Tooltip.Trigger asChild content={t('presence label', { count })} side='bottom'>
+    <Tooltip.Trigger asChild content={t('presence.label', { count })} side='bottom'>
       <AttentionGlyph
         attended={attended}
         containsAttended={containsAttended}

package/src/containers/SpacePresence/index.ts

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

package/src/containers/SpaceRenamePopover/SpaceRenamePopover.tsx

@@ -11,9 +11,9 @@ import { Obj } from '@dxos/echo';
 import { Button, Input, Popover, useTranslation } from '@dxos/react-ui';
 import { osTranslations } from '@dxos/ui-theme';
 
-import { meta } from '../../meta';
+import { meta } from '#meta';
 
-export const SPACE_RENAME_POPOVER = `${meta.id}/SpaceRenamePopover`;
+export const SPACE_RENAME_POPOVER = `${meta.id}.SpaceRenamePopover`;
 
 export const SpaceRenamePopover = ({ space }: { space: Space }) => {
   const { t } = useTranslation(meta.id);
@@ -22,8 +22,8 @@ export const SpaceRenamePopover = ({ space }: { space: Space }) => {
   const { invokePromise } = useOperationInvoker();
 
   const handleDone = useCallback(() => {
-    Obj.change(space.properties, (p) => {
-      p.name = name;
+    Obj.update(space.properties, (obj) => {
+      obj.name = name;
     });
     void invokePromise(LayoutOperation.UpdatePopover, { anchorId: '', state: false });
   }, [space, name, invokePromise]);
@@ -33,10 +33,10 @@ export const SpaceRenamePopover = ({ space }: { space: Space }) => {
     <div role='none' className='p-2 flex gap-2'>
       <div role='none' className='flex-1'>
         <Input.Root>
-          <Input.Label srOnly>{t('space name label')}</Input.Label>
+          <Input.Label srOnly>{t('space-name.label')}</Input.Label>
           <Input.TextInput
             defaultValue={space.properties.name ?? ''}
-            placeholder={t('unnamed space label')}
+            placeholder={t('unnamed-space.label')}
             onChange={({ target: { value } }) => setName(value)}
             // TODO(wittjosiah): Ideally this should access the popover context to close the popover.
             //   Currently this is not possible because Radix does not expose the popover context.
@@ -46,7 +46,7 @@ export const SpaceRenamePopover = ({ space }: { space: Space }) => {
       </div>
       <Popover.Close asChild>
         <Button ref={doneButton} classNames='self-stretch' onClick={handleDone}>
-          {t('done label', { ns: osTranslations })}
+          {t('done.label', { ns: osTranslations })}
         </Button>
       </Popover.Close>
     </div>

package/src/containers/SpaceRenamePopover/index.ts

@@ -2,6 +2,4 @@
 // Copyright 2023 DXOS.org
 //
 
-import { SpaceRenamePopover } from './SpaceRenamePopover';
-
-export default SpaceRenamePopover;
+export { SpaceRenamePopover as default } from './SpaceRenamePopover';

package/src/containers/SpaceSettingsContainer/SpaceSettingsContainer.stories.tsx

@@ -5,22 +5,23 @@
 import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React from 'react';
 
-import { OperationPlugin } from '@dxos/app-framework';
+import { OperationPlugin, RuntimePlugin } from '@dxos/app-framework';
 import { withPluginManager } from '@dxos/app-framework/testing';
+import { AppSurface } from '@dxos/app-toolkit/ui';
 import { useClientStory, withClientProvider } from '@dxos/react-client/testing';
-import { withTheme } from '@dxos/react-ui/testing';
+import { Loading, withLayout, withTheme } from '@dxos/react-ui/testing';
 
-import { translations } from '../../translations';
+import { translations } from '#translations';
 
-import { SpaceSettingsContainer, type SpaceSettingsContainerProps } from './SpaceSettingsContainer';
+import { SpaceSettingsContainer } from './SpaceSettingsContainer';
 
-const Story = (props: Partial<SpaceSettingsContainerProps>) => {
+const Story = (props: Partial<AppSurface.SpaceArticleProps>) => {
   const { space } = useClientStory();
-  return (
-    <div role='none' className='p-2 border border-primary-500 rounded-sm'>
-      <SpaceSettingsContainer {...props} space={space!} />
-    </div>
-  );
+  if (!space) {
+    return <Loading />;
+  }
+
+  return <SpaceSettingsContainer role='article' attendableId={space.id} {...props} space={space} />;
 };
 
 const meta = {
@@ -29,13 +30,14 @@ const meta = {
   render: Story,
   decorators: [
     withTheme(),
+    withLayout({ layout: 'fullscreen' }),
     withClientProvider({ createIdentity: true, createSpace: true }),
     // TODO(wittjosiah): Try to write story which does not depend on plugin manager.
-    withPluginManager({ plugins: [OperationPlugin()] }),
+    withPluginManager({ plugins: [OperationPlugin(), RuntimePlugin()] }),
   ],
   parameters: {
     translations,
-    layout: 'centered',
+    layout: 'fullscreen',
   },
 } satisfies Meta<typeof SpaceSettingsContainer>;