@dxos/plugin-space 0.8.4-main.e8ec1fe → 0.8.4-main.effb148878

package/src/components/ObjectSettings/AdvancedObjectSettings.tsx

@@ -1,81 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React, { useCallback, useState } from 'react';
-
-import { Obj } from '@dxos/echo';
-import { ForeignKey } from '@dxos/echo/internal';
-import { IconButton, useTranslation } from '@dxos/react-ui';
-import { Form } from '@dxos/react-ui-form';
-
-import { meta } from '../../meta';
-
-import { ForeignKeys } from './ForeignKeys';
-
-const initialValues = {
-  source: '',
-  id: '',
-};
-
-export type AdvancedObjectSettingsProps = {
-  object: Obj.Any;
-};
-
-export const AdvancedObjectSettings = ({ object }: AdvancedObjectSettingsProps) => {
-  const { t } = useTranslation(meta.id);
-  const [adding, setAdding] = useState(false);
-  const { keys } = Obj.getMeta(object);
-
-  const handleNew = useCallback(() => setAdding(true), []);
-  const handleCancel = useCallback(() => setAdding(false), []);
-  const handleSave = useCallback(
-    (key: ForeignKey) => {
-      const index = keys.findIndex(({ source, id }) => source === key.source && id === key.id);
-      if (index === -1) {
-        keys.push(key);
-      }
-      setAdding(false);
-    },
-    [keys],
-  );
-  const handleDelete = useCallback(
-    (key: ForeignKey) => {
-      const index = keys.findIndex(({ source, id }) => source === key.source && id === key.id);
-      if (index !== -1) {
-        keys.splice(index, 1);
-      }
-    },
-    [keys],
-  );
-
-  // TODO(wittjosiah): This should be wrapped in an "Advanced" accordion.
-  return (
-    <>
-      <div className='p-2 flex flex-col gap-4'>
-        <h2>{t('advanced settings label')}</h2>
-        <div className='flex items-center'>
-          <h3 className='text-sm font-semibold'>{t('foreign keys')}</h3>
-          <div className='grow' />
-          <IconButton
-            classNames={adding && 'invisible'}
-            icon='ph--plus--regular'
-            label={t('add key')}
-            onClick={handleNew}
-          />
-        </div>
-        {!adding && <ForeignKeys keys={keys} onDelete={handleDelete} />}
-      </div>
-
-      {adding && (
-        <Form
-          outerSpacing={false}
-          schema={ForeignKey}
-          values={initialValues}
-          onSave={handleSave}
-          onCancel={handleCancel}
-        />
-      )}
-    </>
-  );
-};

package/src/components/ObjectSettings/BaseObjectSettings.stories.tsx

@@ -1,63 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React, { useEffect, useState } from 'react';
-
-import { type Obj, Tag } from '@dxos/echo';
-import { useClientProvider, withClientProvider } from '@dxos/react-client/testing';
-import { withTheme } from '@dxos/react-ui/testing';
-import { render } from '@dxos/storybook-utils';
-import { Project } from '@dxos/types';
-
-import { translations } from '../../translations';
-
-import { BaseObjectSettings } from './BaseObjectSettings';
-
-const DefaultStory = () => {
-  const { space } = useClientProvider();
-  const [object, setObject] = useState<Obj.Any>();
-
-  useEffect(() => {
-    if (space && !object) {
-      const object = space.db.add(Project.make());
-      setObject(object as Obj.Any);
-    }
-  }, [space, object]);
-
-  if (!object) {
-    return null;
-  }
-
-  return <BaseObjectSettings object={object} classNames='is-[20rem]' />;
-};
-
-const meta = {
-  title: 'plugins/plugin-space/BaseObjectSettings',
-  component: BaseObjectSettings as any,
-  render: render(DefaultStory),
-  decorators: [
-    withTheme,
-    withClientProvider({
-      createIdentity: true,
-      createSpace: true,
-      types: [Project.Project, Tag.Tag],
-      onCreateSpace: async ({ space }) => {
-        space.db.add(Tag.make({ label: 'Tag 1' }));
-        space.db.add(Tag.make({ label: 'Tag 2' }));
-        space.db.add(Tag.make({ label: 'Tag 3' }));
-      },
-    }),
-  ],
-  parameters: {
-    layout: 'centered',
-    translations,
-  },
-} satisfies Meta<typeof DefaultStory>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Default: Story = {};

package/src/components/ObjectSettings/BaseObjectSettings.tsx

@@ -1,111 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { batch } from '@preact/signals-core';
-import * as Function from 'effect/Function';
-import * as Option from 'effect/Option';
-import * as Schema from 'effect/Schema';
-import React, { type PropsWithChildren, useCallback, useMemo } from 'react';
-
-import { DXN, Obj, type Ref, Tag, Type } from '@dxos/echo';
-import { type JsonPath, setValue } from '@dxos/echo/internal';
-import { invariant } from '@dxos/invariant';
-import { getSpace } from '@dxos/react-client/echo';
-import { type ThemedClassName } from '@dxos/react-ui';
-import { Form, useRefQueryLookupHandler } from '@dxos/react-ui-form';
-import { isNonNullable } from '@dxos/util';
-
-import { meta as pluginMeta } from '../../meta';
-
-// TODO(wittjosiah): Would be nice to control order when extending so this isn't always first/last.
-const BaseSchema = Schema.Struct({
-  tags: Schema.Array(Type.Ref(Tag.Tag)).pipe(Schema.optional),
-});
-
-// TODO(wittjosiah): Better way to support validation of object schemas?
-const TagSchema = Tag.Tag.pipe(Schema.omit('id'));
-
-export type BaseObjectSettingsProps = ThemedClassName<
-  PropsWithChildren<{
-    object: Obj.Any;
-  }>
->;
-
-// TODO(wittjosiah): Reconcile w/ ObjectDetailsPanel.
-export const BaseObjectSettings = ({ classNames, children, object }: BaseObjectSettingsProps) => {
-  const space = getSpace(object);
-  const handleRefQueryLookup = useRefQueryLookupHandler({ space });
-
-  const formSchema = useMemo(() => {
-    return Function.pipe(
-      Obj.getSchema(object),
-      Option.fromNullable,
-      Option.map((schema) => BaseSchema.pipe(Schema.extend(schema))),
-      Option.getOrUndefined,
-    );
-  }, [object]);
-
-  const meta = Obj.getMeta(object);
-  const tags = (meta.tags ?? []).map((tag) => space?.db.ref(DXN.parse(tag))).filter(isNonNullable);
-  const values = useMemo(
-    () => ({
-      tags,
-      ...object,
-    }),
-    [object, tags],
-  );
-
-  const handleCreateTag = useCallback((values: Schema.Schema.Type<typeof TagSchema>) => {
-    invariant(space);
-    const tag = space.db.add(Tag.make(values));
-    const meta = Obj.getMeta(object);
-    meta.tags = [...(meta.tags ?? []), Obj.getDXN(tag).toString()];
-  }, []);
-
-  const handleSave = useCallback(
-    (
-      { tags, ...values }: Schema.Schema.Type<typeof formSchema>,
-      { changed }: { changed: Record<JsonPath, boolean> },
-    ) => {
-      const changedPaths = Object.keys(changed).filter((path) => changed[path as JsonPath]) as JsonPath[];
-      batch(() => {
-        for (const path of changedPaths) {
-          if (path === 'tags') {
-            const meta = Obj.getMeta(object);
-            meta.tags = tags?.map((tag: Ref.Ref<Tag.Tag>) => tag.dxn.toString()) ?? [];
-            continue;
-          }
-
-          const value = values[path];
-          setValue(object, path, value);
-        }
-      });
-    },
-    [object],
-  );
-
-  if (!formSchema) {
-    return null;
-  }
-
-  return (
-    <>
-      <Form
-        classNames={classNames}
-        outerSpacing={false}
-        autoSave
-        schema={formSchema}
-        values={values}
-        createSchema={TagSchema}
-        createOptionIcon='ph--plus--regular'
-        createOptionLabel={['add tag label', { ns: pluginMeta.id }]}
-        createInitialValuePath='label'
-        onCreate={handleCreateTag}
-        onSave={handleSave}
-        onQueryRefOptions={handleRefQueryLookup}
-      />
-      {children}
-    </>
-  );
-};

package/src/components/ObjectSettings/ObjectSettingsContainer.tsx

@@ -1,37 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useMemo } from 'react';
-
-import { Surface } from '@dxos/app-framework/react';
-import { type Obj } from '@dxos/echo';
-import { Clipboard, Toolbar } from '@dxos/react-ui';
-import { StackItem } from '@dxos/react-ui-stack';
-
-import { BaseObjectSettings } from './BaseObjectSettings';
-
-export type ObjectSettingsContainerProps = {
-  object: Obj.Any;
-  role: string;
-};
-
-export const ObjectSettingsContainer = ({ object, role }: ObjectSettingsContainerProps) => {
-  const data = useMemo(() => ({ subject: object }), [object]);
-
-  return (
-    <Clipboard.Provider>
-      <StackItem.Content toolbar>
-        <Toolbar.Root></Toolbar.Root>
-        <div role='none' className='overflow-y-auto pli-cardSpacingInline plb-cardSpacingBlock'>
-          <BaseObjectSettings object={object}>
-            <Surface role='base-object-settings' data={data} />
-          </BaseObjectSettings>
-          <Surface role='object-settings' data={data} />
-          {/* TODO(wittjosiah): Remove? */}
-          {/* <AdvancedObjectSettings object={object} /> */}
-        </div>
-      </StackItem.Content>
-    </Clipboard.Provider>
-  );
-};

package/src/components/ObjectSettings/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { ObjectSettingsContainer } from './ObjectSettingsContainer';
-
-export default ObjectSettingsContainer;

package/src/components/RecordArticle.stories.tsx

@@ -1,115 +0,0 @@
-//
-// 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

@@ -1,114 +0,0 @@
-//
-// 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 { 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<Obj.Any>
-              items={related}
-              render={Card}
-              columnCount={singleColumn ? 1 : undefined}
-              intrinsicHeight
-            />
-          </div>
-        )}
-      </div>
-    </StackItem.Content>
-  );
-};
-
-const Card = ({ data: subject }: { data: Obj.Any }) => {
-  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: Obj.Any[] = [];
-
-    // TODO(burdon): Change Person => Organization to relations.
-    if (options.references) {
-      const getReferences = (obj: Obj.Any): 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: Obj.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

@@ -1,56 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useEffect, useState } from 'react';
-
-import { type Type } from '@dxos/echo';
-import { type Space } from '@dxos/react-client/echo';
-import { useTranslation } from '@dxos/react-ui';
-import { ControlPage, ControlSection, controlItemClasses } from '@dxos/react-ui-form';
-import { StackItem } from '@dxos/react-ui-stack';
-
-import { meta } from '../meta';
-
-type SchemaPanelProps = { space: Space };
-
-export const SchemaContainer = ({ space }: SchemaPanelProps) => {
-  const { t } = useTranslation(meta.id);
-  const schemas = useQuerySpaceSchemas(space);
-
-  // TODO(ZaymonFC): Support deleting Schema (DangerZone section).
-  return (
-    <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 role='none' key={schema.id}>
-                {schema.typename}
-              </div>
-            ))}
-          </div>
-        </ControlSection>
-      </ControlPage>
-    </StackItem.Content>
-  );
-};
-
-/**
- * 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;
-};

package/src/components/SpacePluginSettings.tsx

@@ -1,58 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React from 'react';
-
-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 { meta } from '../meta';
-import { SpaceAction, type SpaceSettingsProps } from '../types';
-import { getSpaceDisplayName } from '../util';
-
-export const SpacePluginSettings = ({ settings }: { settings: SpaceSettingsProps }) => {
-  const { t } = useTranslation(meta.id);
-  const client = useClient();
-  const spaces = useSpaces({ all: settings.showHidden });
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-
-  return (
-    <ControlPage>
-      <ControlSection title={t('space settings label')} description={t('space settings description')}>
-        <ControlGroup>
-          <ControlItemInput title={t('show hidden spaces label')}>
-            <Input.Switch
-              checked={settings.showHidden}
-              onCheckedChange={(checked) => (settings.showHidden = !!checked)}
-            />
-          </ControlItemInput>
-        </ControlGroup>
-        <List classNames={[controlItemClasses, 'flex flex-col gap-trimSm']}>
-          {spaces.map((space) => (
-            <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,
-                )}
-              </ListItem.Heading>
-              <IconButton
-                icon='ph--faders--regular'
-                onClick={() => dispatch(createIntent(SpaceAction.OpenSettings, { space }))}
-                label={t('open space settings label')}
-              />
-            </ListItem.Root>
-          ))}
-        </List>
-      </ControlSection>
-    </ControlPage>
-  );
-};

package/src/components/SpaceRenamePopover/index.ts

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