@dxos/plugin-space 0.8.4-main.5ea62a8 → 0.8.4-main.66e292d

package/src/components/RecordArticle.stories.tsx

@@ -0,0 +1,115 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React from 'react';
+
+import { Capabilities, contributes, createSurface } from '@dxos/app-framework';
+import { withPluginManager } from '@dxos/app-framework/testing';
+import { Filter, Obj, Ref, Relation, type Type } from '@dxos/echo';
+import { faker } from '@dxos/random';
+import { useQuery } from '@dxos/react-client/echo';
+import { useClientProvider, withClientProvider } from '@dxos/react-client/testing';
+import { withTheme } from '@dxos/react-ui/testing';
+import { Card } from '@dxos/react-ui-stack';
+import { Json } from '@dxos/react-ui-syntax-highlighter';
+import { type ValueGenerator, createAsyncGenerator } from '@dxos/schema/testing';
+import { translations as shellTranslations } from '@dxos/shell/react';
+import { render } from '@dxos/storybook-utils';
+import { HasSubject, Organization, Person, Task } from '@dxos/types';
+
+import { translations } from '../translations';
+
+import { RecordArticle } from './RecordArticle';
+
+faker.seed(1);
+const generator: ValueGenerator = faker as any;
+
+const DefaultStory = () => {
+  const { space } = useClientProvider();
+  const [object] = useQuery(space, Filter.type(Organization.Organization));
+  if (!object) {
+    return null;
+  }
+
+  return <RecordArticle subject={object} />;
+};
+
+const meta = {
+  title: 'plugins/plugin-space/RecordArticle',
+  component: RecordArticle as any,
+  render: render(DefaultStory),
+  decorators: [
+    withTheme,
+    // TODO(wittjosiah): Try to write story which does not depend on plugin manager.
+    withPluginManager({
+      capabilities: [
+        contributes(Capabilities.ReactSurface, [
+          createSurface({
+            id: 'section',
+            role: 'section',
+            component: ({ data }) => (
+              <Card.SurfaceRoot>
+                <Json classNames='text-sm' data={data} />
+              </Card.SurfaceRoot>
+            ),
+          }),
+          createSurface({
+            id: 'card',
+            role: 'card',
+            component: ({ data }) => (
+              <Card.SurfaceRoot>
+                <Json classNames='text-sm' data={data} />
+              </Card.SurfaceRoot>
+            ),
+          }),
+        ]),
+      ],
+    }),
+    // TODO(burdon): Use plugin.
+    withClientProvider({
+      createIdentity: true,
+      createSpace: true,
+      types: [Organization.Organization, Person.Person, Task.Task, HasSubject.HasSubject],
+      onCreateSpace: async ({ space }) => {
+        const org = space.db.add(
+          Obj.make(Organization.Organization, {
+            name: 'DXOS',
+          }),
+        );
+        const task = space.db.add(
+          Obj.make(Task.Task, {
+            title: 'Task',
+          }),
+        );
+        space.db.add(
+          Relation.make(HasSubject.HasSubject, {
+            [Relation.Source]: task,
+            [Relation.Target]: org,
+            completedAt: new Date().toISOString(),
+          }),
+        );
+        const objectGenerator = createAsyncGenerator(generator, Person.Person as Type.Obj.Any, {
+          db: space?.db,
+          force: true,
+        });
+        await objectGenerator.createObjects(3).then((objects) => {
+          objects.forEach((object) => {
+            object.organization = Ref.make(org);
+          });
+        });
+      },
+    }),
+  ],
+  parameters: {
+    layout: 'fullscreen',
+    translations: [...translations, ...shellTranslations],
+  },
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};

package/src/components/RecordArticle.tsx

@@ -0,0 +1,114 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React, { useMemo } from 'react';
+
+import { Surface } from '@dxos/app-framework/react';
+import { type SurfaceComponentProps } from '@dxos/app-framework/react';
+import { type Entity, Filter, type Obj, Ref, Relation } from '@dxos/echo';
+import { type Space, getSpace, useQuery } from '@dxos/react-client/echo';
+import { useTranslation } from '@dxos/react-ui';
+import { Masonry } from '@dxos/react-ui-masonry';
+import { StackItem } from '@dxos/react-ui-stack';
+import { mx } from '@dxos/react-ui-theme';
+import { isNonNullable } from '@dxos/util';
+
+import { meta } from '../meta';
+
+export const RecordArticle = ({ subject }: SurfaceComponentProps) => {
+  const { t } = useTranslation(meta.id);
+  const space = getSpace(subject);
+  const data = useMemo(() => ({ subject }), [subject]);
+  const related = useRelatedObjects(space, subject, {
+    references: true,
+    relations: true,
+  });
+  const singleColumn = related.length === 1;
+
+  return (
+    <StackItem.Content>
+      <div role='none' className={mx('flex flex-col gap-4 p-4 is-full overflow-y-auto')}>
+        <div role='none' className={mx('flex is-full card-max-width')}>
+          <Surface role='section' data={data} limit={1} />
+        </div>
+
+        {related.length > 0 && (
+          <div role='none' className={mx('flex flex-col gap-1', singleColumn ? 'card-max-width' : 'is-full')}>
+            <label className='mbs-2 text-sm text-description'>{t('related objects label')}</label>
+            <Masonry.Root<Entity.Unknown>
+              items={related}
+              render={Card}
+              columnCount={singleColumn ? 1 : undefined}
+              intrinsicHeight
+            />
+          </div>
+        )}
+      </div>
+    </StackItem.Content>
+  );
+};
+
+const Card = ({ data: subject }: { data: Entity.Unknown }) => {
+  const data = useMemo(() => ({ subject }), [subject]);
+  return <Surface role='card' data={data} limit={1} />;
+};
+
+// TODO(wittjosiah): This is a hack. ECHO needs to have a back reference index to easily query for related objects.
+const useRelatedObjects = (
+  space?: Space,
+  record?: Obj.Any,
+  options: { references?: boolean; relations?: boolean } = {},
+) => {
+  const objects = useQuery(space, 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.Any[] => {
+        return Object.getOwnPropertyNames(obj)
+          .map((name) => obj[name as keyof Obj.Any])
+          .filter((value) => Ref.isRef(value)) as Ref.Any[];
+      };
+
+      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.Any) => {
+        try {
+          return Relation.isRelation(obj) && Relation.getSource(obj) && Relation.getTarget(obj);
+        } catch {
+          return false;
+        }
+      };
+
+      const relations = objects.filter((obj) => Relation.isRelation(obj)).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]);
+};
+
+export default RecordArticle;

package/src/components/SchemaContainer.tsx

@@ -10,45 +10,24 @@ import { useTranslation } from '@dxos/react-ui';
 import { ControlPage, ControlSection, controlItemClasses } from '@dxos/react-ui-form';
 import { StackItem } from '@dxos/react-ui-stack';
 
-import { SPACE_PLUGIN } from '../meta';
+import { meta } from '../meta';
 
 type SchemaPanelProps = { space: Space };
 
-// TODO(ZaymonFC):
-//   - Support deleting Schema. This should tie in to some sort of
-//     'DangerZone™️' / 'Are you really sure?' / 'this might have consequences' component.
-
-/**
- * Subscribe to and retrieve all schemas from a space's schema registry.
- */
-export const useQuerySpaceSchemas = (space: Space): Type.Schema[] => {
-  const [schemas, setSchemas] = useState<Type.Schema[]>([]);
-
-  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;
-};
-
 export const SchemaContainer = ({ space }: SchemaPanelProps) => {
-  const { t } = useTranslation(SPACE_PLUGIN);
+  const { t } = useTranslation(meta.id);
   const schemas = useQuerySpaceSchemas(space);
 
+  // TODO(ZaymonFC): Support deleting Schema (DangerZone section).
   return (
-    <StackItem.Content classNames='block overflow-y-auto'>
+    <StackItem.Content scrollable>
       <ControlPage>
         <ControlSection title={t('schema verbose label')} description={t('schema description')}>
           <div role='none' className={controlItemClasses}>
             {schemas.length === 0 && <div className='text-center plb-4'>{t('no schemas found message')}</div>}
             {schemas.map((schema) => (
-              <div key={schema.id}>
-                <div>{schema.typename}</div>
+              <div role='none' key={schema.id}>
+                {schema.typename}
               </div>
             ))}
           </div>
@@ -57,3 +36,21 @@ export const SchemaContainer = ({ space }: SchemaPanelProps) => {
     </StackItem.Content>
   );
 };
+
+/**
+ * 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/components/SpacePluginSettings.tsx

@@ -4,18 +4,19 @@
 
 import React from 'react';
 
-import { createIntent, useIntentDispatcher } from '@dxos/app-framework';
+import { createIntent } from '@dxos/app-framework';
+import { useIntentDispatcher } from '@dxos/app-framework/react';
 import { useClient } from '@dxos/react-client';
 import { useSpaces } from '@dxos/react-client/echo';
 import { IconButton, Input, List, ListItem, toLocalizedString, useTranslation } from '@dxos/react-ui';
 import { ControlGroup, ControlItemInput, ControlPage, ControlSection, controlItemClasses } from '@dxos/react-ui-form';
 
-import { SPACE_PLUGIN } from '../meta';
+import { meta } from '../meta';
 import { SpaceAction, type SpaceSettingsProps } from '../types';
 import { getSpaceDisplayName } from '../util';
 
 export const SpacePluginSettings = ({ settings }: { settings: SpaceSettingsProps }) => {
-  const { t } = useTranslation(SPACE_PLUGIN);
+  const { t } = useTranslation(meta.id);
   const client = useClient();
   const spaces = useSpaces({ all: settings.showHidden });
   const { dispatchPromise: dispatch } = useIntentDispatcher();
@@ -36,7 +37,12 @@ export const SpacePluginSettings = ({ settings }: { settings: SpaceSettingsProps
             <ListItem.Root key={space.id} classNames='is-full items-center'>
               {/* TODO(burdon): Should auto center and truncate; NOTE truncate doesn't work with flex grow. */}
               <ListItem.Heading classNames='grow truncate !min-bs-0'>
-                {toLocalizedString(getSpaceDisplayName(space, { personal: space === client.spaces.default }), t)}
+                {toLocalizedString(
+                  getSpaceDisplayName(space, {
+                    personal: space === client.spaces.default,
+                  }),
+                  t,
+                )}
               </ListItem.Heading>
               <IconButton
                 icon='ph--faders--regular'

package/src/components/{SpacePresence.stories.tsx → SpacePresence/SpacePresence.stories.tsx}

@@ -2,20 +2,18 @@
 // Copyright 2023 DXOS.org
 //
 
-import '@dxos-theme';
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
+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 { withLayout, withTheme } from '@dxos/storybook-utils';
+import { withTheme } from '@dxos/react-ui/testing';
 
-import { translations } from '../translations';
+import { translations } from '../../translations';
 
 import { FullPresence, type Member, type MemberPresenceProps, SmallPresence } from './SpacePresence';
 
-const nViewers = (n: number, currentlyAttended = true): Member[] =>
+const viewers = (n: number, currentlyAttended = true): Member[] =>
   Array.from({ length: n }, () => ({
     role: HaloSpaceMember.Role.ADMIN,
     identity: { did: IdentityDid.random(), identityKey: PublicKey.random() },
@@ -24,6 +22,16 @@ const nViewers = (n: number, currentlyAttended = true): Member[] =>
     currentlyAttended,
   }));
 
+const meta = {
+  title: 'plugins/plugin-space/SpacePresence',
+  decorators: [withTheme],
+  parameters: {
+    translations,
+  },
+} satisfies Meta<typeof IdentityDid>;
+
+export default meta;
+
 export const Full = (props: MemberPresenceProps) => {
   const p: MemberPresenceProps = {
     ...props,
@@ -32,31 +40,31 @@ export const Full = (props: MemberPresenceProps) => {
   return (
     <div className='p-4'>
       <div className='p-3'>
-        <FullPresence members={nViewers(1)} {...p} />
+        <FullPresence members={viewers(1)} {...p} />
       </div>
       <div className='p-3'>
-        <FullPresence members={nViewers(2)} {...p} />
+        <FullPresence members={viewers(2)} {...p} />
       </div>
       <div className='p-3'>
-        <FullPresence members={nViewers(3)} {...p} />
+        <FullPresence members={viewers(3)} {...p} />
       </div>
       <div className='p-3'>
-        <FullPresence members={nViewers(3, false)} {...p} />
+        <FullPresence members={viewers(3, false)} {...p} />
       </div>
       <div className='p-3'>
-        <FullPresence members={nViewers(4)} {...p} />
+        <FullPresence members={viewers(4)} {...p} />
       </div>
       <div className='p-3'>
-        <FullPresence members={nViewers(5)} {...p} />
+        <FullPresence members={viewers(5)} {...p} />
       </div>
       <div className='p-3'>
-        <FullPresence members={nViewers(5, false)} {...p} />
+        <FullPresence members={viewers(5, false)} {...p} />
       </div>
       <div className='p-3'>
-        <FullPresence members={nViewers(10)} {...p} />
+        <FullPresence members={viewers(10)} {...p} />
       </div>
       <div className='p-3'>
-        <FullPresence members={nViewers(100)} {...p} />
+        <FullPresence members={viewers(100)} {...p} />
       </div>
     </div>
   );
@@ -98,13 +106,3 @@ export const Small = () => {
     </div>
   );
 };
-
-const meta = {
-  title: 'plugins/plugin-space/SpacePresence',
-  decorators: [withTheme, withLayout()],
-  parameters: { translations },
-} satisfies Meta<typeof IdentityDid>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;

package/src/components/{SpacePresence.tsx → SpacePresence/SpacePresence.tsx}

@@ -2,14 +2,14 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Option } from 'effect';
+import * as Option from 'effect/Option';
 import React, { forwardRef, useCallback, useEffect, useState } from 'react';
 
-import { useAppGraph, useCapability } from '@dxos/app-framework';
+import { useAppGraph, useCapability } from '@dxos/app-framework/react';
 import { generateName } from '@dxos/display-name';
-import { type Type } from '@dxos/echo';
+import { Obj } from '@dxos/echo';
 import { PublicKey, useClient } from '@dxos/react-client';
-import { type SpaceMember, fullyQualifiedId, getSpace, useMembers } from '@dxos/react-client/echo';
+import { type SpaceMember, getSpace, useMembers } from '@dxos/react-client/echo';
 import { type Identity, useIdentity } from '@dxos/react-client/halo';
 import {
   Avatar,
@@ -27,10 +27,10 @@ import {
 import { AttentionGlyph, type AttentionGlyphProps, useAttended, useAttention } from '@dxos/react-ui-attention';
 import { ComplexMap, keyToFallback } from '@dxos/util';
 
-import { SpaceCapabilities } from '../capabilities';
-import { usePath } from '../hooks';
-import { SPACE_PLUGIN } from '../meta';
-import type { ObjectViewerProps } from '../types';
+import { SpaceCapabilities } from '../../capabilities';
+import { usePath } from '../../hooks';
+import { meta } from '../../meta';
+import { type ObjectViewerProps } from '../../types';
 
 // TODO(thure): Get/derive these values from protocol
 const REFRESH_INTERVAL = 5000;
@@ -42,7 +42,12 @@ const noViewers = new ComplexMap<PublicKey, ObjectViewerProps>(PublicKey.hash);
 // TODO(wittjosiah): Factor out?
 const getName = (identity: Identity) => identity.profile?.displayName ?? generateName(identity.identityKey.toHex());
 
-export const SpacePresence = ({ object, spaceKey }: { object: Type.Expando; spaceKey?: PublicKey }) => {
+export type SpacePresenceProps = {
+  object: Obj.Any;
+  spaceKey?: PublicKey;
+};
+
+export const SpacePresence = ({ object, spaceKey }: SpacePresenceProps) => {
   // TODO(wittjosiah): Doesn't need to be mutable but readonly type messes with ComplexMap.
   const spaceState = useCapability(SpaceCapabilities.MutableState);
   const client = useClient();
@@ -70,7 +75,7 @@ export const SpacePresence = ({ object, spaceKey }: { object: Type.Expando; spac
     return null;
   }
 
-  const currentObjectViewers = spaceState.viewersByObject[fullyQualifiedId(object)] ?? noViewers;
+  const currentObjectViewers = spaceState.viewersByObject[Obj.getDXN(object).toString()] ?? noViewers;
 
   const membersForObject = spaceMembers
     .filter((member) => memberOnline(member) && memberIsNotSelf(member))
@@ -254,7 +259,7 @@ export type SmallPresenceProps = {
 } & Pick<AttentionGlyphProps, 'attended' | 'containsAttended'>;
 
 export const SmallPresence = ({ count = 0, attended, containsAttended }: SmallPresenceProps) => {
-  const { t } = useTranslation(SPACE_PLUGIN);
+  const { t } = useTranslation(meta.id);
 
   return (
     <Tooltip.Trigger asChild content={t('presence label', { count })} side='bottom'>

package/src/components/SpacePresence/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './SpacePresence';

package/src/components/{PopoverRenameSpace.tsx → SpaceRenamePopover/SpaceRenamePopover.tsx}

@@ -4,16 +4,17 @@
 
 import React, { useCallback, useRef, useState } from 'react';
 
-import { LayoutAction, createIntent, useIntentDispatcher } from '@dxos/app-framework';
-import { type Space } from '@dxos/react-client/echo';
+import { LayoutAction, createIntent } from '@dxos/app-framework';
+import { useIntentDispatcher } from '@dxos/app-framework/react';
+import { type Space } from '@dxos/client/echo';
 import { Button, Input, Popover, useTranslation } from '@dxos/react-ui';
 
-import { SPACE_PLUGIN } from '../meta';
+import { meta } from '../../meta';
 
-export const POPOVER_RENAME_SPACE = `${SPACE_PLUGIN}/PopoverRenameSpace`;
+export const SPACE_RENAME_POPOVER = `${meta.id}/SpaceRenamePopover`;
 
-export const PopoverRenameSpace = ({ space }: { space: Space }) => {
-  const { t } = useTranslation(SPACE_PLUGIN);
+export const SpaceRenamePopover = ({ space }: { space: Space }) => {
+  const { t } = useTranslation(meta.id);
   const doneButton = useRef<HTMLButtonElement>(null);
   const [name, setName] = useState(space.properties.name ?? '');
   const { dispatchPromise: dispatch } = useIntentDispatcher();

package/src/components/SpaceRenamePopover/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './SpaceRenamePopover';

package/src/components/SpaceSettings/SpaceSettingsContainer.stories.tsx

@@ -2,13 +2,13 @@
 // Copyright 2024 DXOS.org
 //
 
-import '@dxos-theme';
-
 import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React from 'react';
 
+import { IntentPlugin } from '@dxos/app-framework';
+import { withPluginManager } from '@dxos/app-framework/testing';
 import { useClientProvider, withClientProvider } from '@dxos/react-client/testing';
-import { withTheme } from '@dxos/storybook-utils';
+import { withTheme } from '@dxos/react-ui/testing';
 
 import { translations } from '../../translations';
 
@@ -27,7 +27,12 @@ const meta = {
   title: 'plugins/plugin-space/SpaceSettingsContainer',
   component: SpaceSettingsContainer,
   render: Story,
-  decorators: [withClientProvider({ createIdentity: true, createSpace: true }), withTheme],
+  decorators: [
+    withTheme,
+    withClientProvider({ createIdentity: true, createSpace: true }),
+    // TODO(wittjosiah): Try to write story which does not depend on plugin manager.
+    withPluginManager({ plugins: [IntentPlugin()] }),
+  ],
   parameters: {
     translations,
     layout: 'centered',